mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

platform/DirHandle.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
188:bcfe06ba3d64 
mbed library release version 165

Who changed what in which revision?

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