Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/DirHandle.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ommpy 0:d383e2dee0f7 1 /* mbed Microcontroller Library
ommpy 0:d383e2dee0f7 2 * Copyright (c) 2006-2013 ARM Limited
ommpy 0:d383e2dee0f7 3 *
ommpy 0:d383e2dee0f7 4 * Licensed under the Apache License, Version 2.0 (the "License");
ommpy 0:d383e2dee0f7 5 * you may not use this file except in compliance with the License.
ommpy 0:d383e2dee0f7 6 * You may obtain a copy of the License at
ommpy 0:d383e2dee0f7 7 *
ommpy 0:d383e2dee0f7 8 * http://www.apache.org/licenses/LICENSE-2.0
ommpy 0:d383e2dee0f7 9 *
ommpy 0:d383e2dee0f7 10 * Unless required by applicable law or agreed to in writing, software
ommpy 0:d383e2dee0f7 11 * distributed under the License is distributed on an "AS IS" BASIS,
ommpy 0:d383e2dee0f7 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ommpy 0:d383e2dee0f7 13 * See the License for the specific language governing permissions and
ommpy 0:d383e2dee0f7 14 * limitations under the License.
ommpy 0:d383e2dee0f7 15 */
ommpy 0:d383e2dee0f7 16 #ifndef MBED_DIRHANDLE_H
ommpy 0:d383e2dee0f7 17 #define MBED_DIRHANDLE_H
ommpy 0:d383e2dee0f7 18
ommpy 0:d383e2dee0f7 19 #if defined(__ARMCC_VERSION) || defined(__ICCARM__)
ommpy 0:d383e2dee0f7 20 # define NAME_MAX 255
ommpy 0:d383e2dee0f7 21 typedef int mode_t;
ommpy 0:d383e2dee0f7 22
ommpy 0:d383e2dee0f7 23 #else
ommpy 0:d383e2dee0f7 24 # include <sys/syslimits.h>
ommpy 0:d383e2dee0f7 25 #endif
ommpy 0:d383e2dee0f7 26
ommpy 0:d383e2dee0f7 27 #include "FileHandle.h"
ommpy 0:d383e2dee0f7 28
ommpy 0:d383e2dee0f7 29 struct dirent {
ommpy 0:d383e2dee0f7 30 char d_name[NAME_MAX+1];
ommpy 0:d383e2dee0f7 31 };
ommpy 0:d383e2dee0f7 32
ommpy 0:d383e2dee0f7 33 namespace mbed {
ommpy 0:d383e2dee0f7 34
ommpy 0:d383e2dee0f7 35 /** Represents a directory stream. Objects of this type are returned
ommpy 0:d383e2dee0f7 36 * by a FileSystemLike's opendir method. Implementations must define
ommpy 0:d383e2dee0f7 37 * at least closedir, readdir and rewinddir.
ommpy 0:d383e2dee0f7 38 *
ommpy 0:d383e2dee0f7 39 * If a FileSystemLike class defines the opendir method, then the
ommpy 0:d383e2dee0f7 40 * directories of an object of that type can be accessed by
ommpy 0:d383e2dee0f7 41 * DIR *d = opendir("/example/directory") (or opendir("/example")
ommpy 0:d383e2dee0f7 42 * to open the root of the filesystem), and then using readdir(d) etc.
ommpy 0:d383e2dee0f7 43 *
ommpy 0:d383e2dee0f7 44 * The root directory is considered to contain all FileLike and
ommpy 0:d383e2dee0f7 45 * FileSystemLike objects, so the DIR* returned by opendir("/") will
ommpy 0:d383e2dee0f7 46 * reflect this.
ommpy 0:d383e2dee0f7 47 */
ommpy 0:d383e2dee0f7 48 class DirHandle {
ommpy 0:d383e2dee0f7 49
ommpy 0:d383e2dee0f7 50 public:
ommpy 0:d383e2dee0f7 51 /** Closes the directory.
ommpy 0:d383e2dee0f7 52 *
ommpy 0:d383e2dee0f7 53 * @returns
ommpy 0:d383e2dee0f7 54 * 0 on success,
ommpy 0:d383e2dee0f7 55 * -1 on error.
ommpy 0:d383e2dee0f7 56 */
ommpy 0:d383e2dee0f7 57 virtual int closedir()=0;
ommpy 0:d383e2dee0f7 58
ommpy 0:d383e2dee0f7 59 /** Return the directory entry at the current position, and
ommpy 0:d383e2dee0f7 60 * advances the position to the next entry.
ommpy 0:d383e2dee0f7 61 *
ommpy 0:d383e2dee0f7 62 * @returns
ommpy 0:d383e2dee0f7 63 * A pointer to a dirent structure representing the
ommpy 0:d383e2dee0f7 64 * directory entry at the current position, or NULL on reaching
ommpy 0:d383e2dee0f7 65 * end of directory or error.
ommpy 0:d383e2dee0f7 66 */
ommpy 0:d383e2dee0f7 67 virtual struct dirent *readdir()=0;
ommpy 0:d383e2dee0f7 68
ommpy 0:d383e2dee0f7 69 /** Resets the position to the beginning of the directory.
ommpy 0:d383e2dee0f7 70 */
ommpy 0:d383e2dee0f7 71 virtual void rewinddir()=0;
ommpy 0:d383e2dee0f7 72
ommpy 0:d383e2dee0f7 73 /** Returns the current position of the DirHandle.
ommpy 0:d383e2dee0f7 74 *
ommpy 0:d383e2dee0f7 75 * @returns
ommpy 0:d383e2dee0f7 76 * the current position,
ommpy 0:d383e2dee0f7 77 * -1 on error.
ommpy 0:d383e2dee0f7 78 */
ommpy 0:d383e2dee0f7 79 virtual off_t telldir() { return -1; }
ommpy 0:d383e2dee0f7 80
ommpy 0:d383e2dee0f7 81 /** Sets the position of the DirHandle.
ommpy 0:d383e2dee0f7 82 *
ommpy 0:d383e2dee0f7 83 * @param location The location to seek to. Must be a value returned by telldir.
ommpy 0:d383e2dee0f7 84 */
ommpy 0:d383e2dee0f7 85 virtual void seekdir(off_t location) { }
ommpy 0:d383e2dee0f7 86
ommpy 0:d383e2dee0f7 87 virtual ~DirHandle() {}
ommpy 0:d383e2dee0f7 88 };
ommpy 0:d383e2dee0f7 89
ommpy 0:d383e2dee0f7 90 } // namespace mbed
ommpy 0:d383e2dee0f7 91
ommpy 0:d383e2dee0f7 92 typedef mbed::DirHandle DIR;
ommpy 0:d383e2dee0f7 93
ommpy 0:d383e2dee0f7 94 extern "C" {
ommpy 0:d383e2dee0f7 95 DIR *opendir(const char*);
ommpy 0:d383e2dee0f7 96 struct dirent *readdir(DIR *);
ommpy 0:d383e2dee0f7 97 int closedir(DIR*);
ommpy 0:d383e2dee0f7 98 void rewinddir(DIR*);
ommpy 0:d383e2dee0f7 99 long telldir(DIR*);
ommpy 0:d383e2dee0f7 100 void seekdir(DIR*, long);
ommpy 0:d383e2dee0f7 101 int mkdir(const char *name, mode_t n);
ommpy 0:d383e2dee0f7 102 };
ommpy 0:d383e2dee0f7 103
ommpy 0:d383e2dee0f7 104 #endif /* MBED_DIRHANDLE_H */