mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

platform/DirHandle.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
170:e95d10626187
Child:
172:65be27845400
mbed library. Release version 164

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1 /* mbed Microcontroller Library
AnnaBridge 156:ff21514d8981 2 * Copyright (c) 2006-2013 ARM Limited
AnnaBridge 156:ff21514d8981 3 *
AnnaBridge 156:ff21514d8981 4 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 156:ff21514d8981 5 * you may not use this file except in compliance with the License.
AnnaBridge 156:ff21514d8981 6 * You may obtain a copy of the License at
AnnaBridge 156:ff21514d8981 7 *
AnnaBridge 156:ff21514d8981 8 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 156:ff21514d8981 9 *
AnnaBridge 156:ff21514d8981 10 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 156:ff21514d8981 11 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 156:ff21514d8981 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 156:ff21514d8981 13 * See the License for the specific language governing permissions and
AnnaBridge 156:ff21514d8981 14 * limitations under the License.
AnnaBridge 156:ff21514d8981 15 */
AnnaBridge 156:ff21514d8981 16 #ifndef MBED_DIRHANDLE_H
AnnaBridge 156:ff21514d8981 17 #define MBED_DIRHANDLE_H
AnnaBridge 156:ff21514d8981 18
AnnaBridge 156:ff21514d8981 19 #include <stdint.h>
AnnaBridge 156:ff21514d8981 20 #include "platform/platform.h"
AnnaBridge 156:ff21514d8981 21 #include "platform/FileHandle.h"
AnnaBridge 156:ff21514d8981 22 #include "platform/NonCopyable.h"
AnnaBridge 156:ff21514d8981 23
AnnaBridge 156:ff21514d8981 24 namespace mbed {
AnnaBridge 156:ff21514d8981 25 /** \addtogroup platform */
AnnaBridge 158:1c57384330a6 26 /** @{*/
AnnaBridge 158:1c57384330a6 27 /**
AnnaBridge 158:1c57384330a6 28 * \defgroup platform_DirHandle DirHandle functions
AnnaBridge 158:1c57384330a6 29 * @{
AnnaBridge 158:1c57384330a6 30 */
AnnaBridge 156:ff21514d8981 31
AnnaBridge 156:ff21514d8981 32
AnnaBridge 171:3a7713b1edbc 33 /** Represents a directory stream. An opendir function returns
AnnaBridge 171:3a7713b1edbc 34 * objects of this type. The core functions are read and seek,
AnnaBridge 156:ff21514d8981 35 * but only a subset needs to be provided.
AnnaBridge 156:ff21514d8981 36 *
AnnaBridge 171:3a7713b1edbc 37 * If a FileSystemLike class defines the opendir method, then you
AnnaBridge 171:3a7713b1edbc 38 * can access the directories of an object of that type by either:
AnnaBridge 171:3a7713b1edbc 39 * @code
AnnaBridge 171:3a7713b1edbc 40 * DIR *d = opendir("/example/directory");
AnnaBridge 171:3a7713b1edbc 41 * @endcode
AnnaBridge 171:3a7713b1edbc 42 * or
AnnaBridge 171:3a7713b1edbc 43 * @code
AnnaBridge 171:3a7713b1edbc 44 * DIR *d = opendir("/example");
AnnaBridge 171:3a7713b1edbc 45 * @endcode
AnnaBridge 171:3a7713b1edbc 46 * to open the root of the file system.
AnnaBridge 156:ff21514d8981 47 *
AnnaBridge 156:ff21514d8981 48 * The root directory is considered to contain all FileHandle and
AnnaBridge 171:3a7713b1edbc 49 * FileSystem objects, so the DIR pointer returned by opendir("/")
AnnaBridge 171:3a7713b1edbc 50 * reflects this.
AnnaBridge 156:ff21514d8981 51 *
AnnaBridge 156:ff21514d8981 52 * @note to create a directory, @see Dir
AnnaBridge 156:ff21514d8981 53 * @note Synchronization level: Set by subclass
AnnaBridge 156:ff21514d8981 54 */
AnnaBridge 156:ff21514d8981 55 class DirHandle : private NonCopyable<DirHandle> {
AnnaBridge 156:ff21514d8981 56 public:
AnnaBridge 156:ff21514d8981 57 virtual ~DirHandle() {}
AnnaBridge 156:ff21514d8981 58
AnnaBridge 156:ff21514d8981 59 /** Read the next directory entry
AnnaBridge 156:ff21514d8981 60 *
AnnaBridge 156:ff21514d8981 61 * @param ent The directory entry to fill out
AnnaBridge 156:ff21514d8981 62 * @return 1 on reading a filename, 0 at end of directory, negative error on failure
AnnaBridge 156:ff21514d8981 63 */
AnnaBridge 156:ff21514d8981 64 virtual ssize_t read(struct dirent *ent) = 0;
AnnaBridge 156:ff21514d8981 65
AnnaBridge 156:ff21514d8981 66 /** Close a directory
AnnaBridge 156:ff21514d8981 67 *
AnnaBridge 156:ff21514d8981 68 * @return 0 on success, negative error code on failure
AnnaBridge 156:ff21514d8981 69 */
AnnaBridge 156:ff21514d8981 70 virtual int close() = 0;
AnnaBridge 156:ff21514d8981 71
AnnaBridge 156:ff21514d8981 72 /** Set the current position of the directory
AnnaBridge 156:ff21514d8981 73 *
AnnaBridge 156:ff21514d8981 74 * @param offset Offset of the location to seek to,
AnnaBridge 156:ff21514d8981 75 * must be a value returned from tell
AnnaBridge 156:ff21514d8981 76 */
AnnaBridge 156:ff21514d8981 77 virtual void seek(off_t offset) = 0;
AnnaBridge 156:ff21514d8981 78
AnnaBridge 156:ff21514d8981 79 /** Get the current position of the directory
AnnaBridge 156:ff21514d8981 80 *
AnnaBridge 156:ff21514d8981 81 * @return Position of the directory that can be passed to rewind
AnnaBridge 156:ff21514d8981 82 */
AnnaBridge 156:ff21514d8981 83 virtual off_t tell() = 0;
AnnaBridge 156:ff21514d8981 84
AnnaBridge 156:ff21514d8981 85 /** Rewind the current position to the beginning of the directory
AnnaBridge 156:ff21514d8981 86 */
AnnaBridge 156:ff21514d8981 87 virtual void rewind() = 0;
AnnaBridge 156:ff21514d8981 88
AnnaBridge 170:e95d10626187 89 /** Get the sizeof the directory
AnnaBridge 156:ff21514d8981 90 *
AnnaBridge 156:ff21514d8981 91 * @return Number of files in the directory
AnnaBridge 156:ff21514d8981 92 */
AnnaBridge 156:ff21514d8981 93 virtual size_t size()
AnnaBridge 156:ff21514d8981 94 {
AnnaBridge 156:ff21514d8981 95 off_t off = tell();
AnnaBridge 156:ff21514d8981 96 size_t size = 0;
AnnaBridge 156:ff21514d8981 97 struct dirent *ent = new struct dirent;
AnnaBridge 156:ff21514d8981 98
AnnaBridge 156:ff21514d8981 99 rewind();
AnnaBridge 156:ff21514d8981 100 while (read(ent) > 0) {
AnnaBridge 156:ff21514d8981 101 size += 1;
AnnaBridge 156:ff21514d8981 102 }
AnnaBridge 156:ff21514d8981 103 seek(off);
AnnaBridge 156:ff21514d8981 104
AnnaBridge 156:ff21514d8981 105 delete ent;
AnnaBridge 156:ff21514d8981 106 return size;
AnnaBridge 156:ff21514d8981 107 }
AnnaBridge 156:ff21514d8981 108
AnnaBridge 156:ff21514d8981 109 /** Closes the directory.
AnnaBridge 156:ff21514d8981 110 *
AnnaBridge 156:ff21514d8981 111 * @returns
AnnaBridge 156:ff21514d8981 112 * 0 on success,
AnnaBridge 156:ff21514d8981 113 * -1 on error.
AnnaBridge 167:84c0a372a020 114 * @deprecated Replaced by `int DirHandle::close()'
AnnaBridge 156:ff21514d8981 115 */
AnnaBridge 156:ff21514d8981 116 MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::close")
AnnaBridge 170:e95d10626187 117 virtual int closedir()
AnnaBridge 170:e95d10626187 118 {
AnnaBridge 170:e95d10626187 119 return close();
AnnaBridge 170:e95d10626187 120 };
AnnaBridge 156:ff21514d8981 121
AnnaBridge 171:3a7713b1edbc 122 /** Returns the directory entry at the current position, and
AnnaBridge 156:ff21514d8981 123 * advances the position to the next entry.
AnnaBridge 156:ff21514d8981 124 *
AnnaBridge 156:ff21514d8981 125 * @returns
AnnaBridge 156:ff21514d8981 126 * A pointer to a dirent structure representing the
AnnaBridge 156:ff21514d8981 127 * directory entry at the current position, or NULL on reaching
AnnaBridge 156:ff21514d8981 128 * end of directory or error.
AnnaBridge 167:84c0a372a020 129 * @deprecated Replaced by `ssize_t DirHandle::read(struct dirent *ent)
AnnaBridge 156:ff21514d8981 130 */
AnnaBridge 156:ff21514d8981 131 MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::read")
AnnaBridge 156:ff21514d8981 132 virtual struct dirent *readdir()
AnnaBridge 156:ff21514d8981 133 {
AnnaBridge 156:ff21514d8981 134 static struct dirent ent;
AnnaBridge 156:ff21514d8981 135 return (read(&ent) > 0) ? &ent : NULL;
AnnaBridge 156:ff21514d8981 136 }
AnnaBridge 156:ff21514d8981 137
AnnaBridge 156:ff21514d8981 138 /** Resets the position to the beginning of the directory.
AnnaBridge 167:84c0a372a020 139 * @deprecated Replaced by `void DirHandle::rewind()'
AnnaBridge 156:ff21514d8981 140 */
AnnaBridge 156:ff21514d8981 141 MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::rewind")
AnnaBridge 170:e95d10626187 142 virtual void rewinddir()
AnnaBridge 170:e95d10626187 143 {
AnnaBridge 170:e95d10626187 144 rewind();
AnnaBridge 170:e95d10626187 145 }
AnnaBridge 156:ff21514d8981 146
AnnaBridge 156:ff21514d8981 147 /** Returns the current position of the DirHandle.
AnnaBridge 156:ff21514d8981 148 *
AnnaBridge 156:ff21514d8981 149 * @returns
AnnaBridge 156:ff21514d8981 150 * the current position,
AnnaBridge 156:ff21514d8981 151 * -1 on error.
AnnaBridge 167:84c0a372a020 152 * @deprecated Replaced by `off_t DirHandle::tell()'
AnnaBridge 156:ff21514d8981 153 */
AnnaBridge 156:ff21514d8981 154 MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::tell")
AnnaBridge 170:e95d10626187 155 virtual off_t telldir()
AnnaBridge 170:e95d10626187 156 {
AnnaBridge 170:e95d10626187 157 return tell();
AnnaBridge 170:e95d10626187 158 }
AnnaBridge 156:ff21514d8981 159
AnnaBridge 156:ff21514d8981 160 /** Sets the position of the DirHandle.
AnnaBridge 156:ff21514d8981 161 *
AnnaBridge 156:ff21514d8981 162 * @param location The location to seek to. Must be a value returned by telldir.
AnnaBridge 167:84c0a372a020 163 * @deprecated Replaced by `void DirHandle::seek(off_t offset)'
AnnaBridge 156:ff21514d8981 164 */
AnnaBridge 156:ff21514d8981 165 MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::seek")
AnnaBridge 170:e95d10626187 166 virtual void seekdir(off_t location)
AnnaBridge 170:e95d10626187 167 {
AnnaBridge 170:e95d10626187 168 seek(location);
AnnaBridge 170:e95d10626187 169 }
AnnaBridge 156:ff21514d8981 170 };
AnnaBridge 156:ff21514d8981 171
AnnaBridge 158:1c57384330a6 172 /**@}*/
AnnaBridge 156:ff21514d8981 173
AnnaBridge 158:1c57384330a6 174 /**@}*/
AnnaBridge 156:ff21514d8981 175 } // namespace mbed
AnnaBridge 156:ff21514d8981 176
AnnaBridge 156:ff21514d8981 177 #endif /* MBED_DIRHANDLE_H */