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@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

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