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@157:e7ca05fa8600, 2017-11-09 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 09 11:14:10 2017 +0000
Revision:
157:e7ca05fa8600
Parent:
156:ff21514d8981
Child:
158:1c57384330a6
Release 155 of the mbed library.

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 156:ff21514d8981 26
AnnaBridge 156:ff21514d8981 27
AnnaBridge 156:ff21514d8981 28 /** Represents a directory stream. Objects of this type are returned
AnnaBridge 156:ff21514d8981 29 * by an opendir function. The core functions are read and seek,
AnnaBridge 156:ff21514d8981 30 * but only a subset needs to be provided.
AnnaBridge 156:ff21514d8981 31 *
AnnaBridge 156:ff21514d8981 32 * If a FileSystemLike class defines the opendir method, then the
AnnaBridge 156:ff21514d8981 33 * directories of an object of that type can be accessed by
AnnaBridge 156:ff21514d8981 34 * DIR *d = opendir("/example/directory") (or opendir("/example")
AnnaBridge 156:ff21514d8981 35 * to open the root of the filesystem), and then using readdir(d) etc.
AnnaBridge 156:ff21514d8981 36 *
AnnaBridge 156:ff21514d8981 37 * The root directory is considered to contain all FileHandle and
AnnaBridge 156:ff21514d8981 38 * FileSystem objects, so the DIR* returned by opendir("/") will
AnnaBridge 156:ff21514d8981 39 * reflect this.
AnnaBridge 156:ff21514d8981 40 *
AnnaBridge 156:ff21514d8981 41 * @note to create a directory, @see Dir
AnnaBridge 156:ff21514d8981 42 * @note Synchronization level: Set by subclass
AnnaBridge 156:ff21514d8981 43 * @ingroup platform
AnnaBridge 156:ff21514d8981 44 */
AnnaBridge 156:ff21514d8981 45 class DirHandle : private NonCopyable<DirHandle> {
AnnaBridge 156:ff21514d8981 46 public:
AnnaBridge 156:ff21514d8981 47 virtual ~DirHandle() {}
AnnaBridge 156:ff21514d8981 48
AnnaBridge 156:ff21514d8981 49 /** Read the next directory entry
AnnaBridge 156:ff21514d8981 50 *
AnnaBridge 156:ff21514d8981 51 * @param ent The directory entry to fill out
AnnaBridge 156:ff21514d8981 52 * @return 1 on reading a filename, 0 at end of directory, negative error on failure
AnnaBridge 156:ff21514d8981 53 */
AnnaBridge 156:ff21514d8981 54 virtual ssize_t read(struct dirent *ent) = 0;
AnnaBridge 156:ff21514d8981 55
AnnaBridge 156:ff21514d8981 56 /** Close a directory
AnnaBridge 156:ff21514d8981 57 *
AnnaBridge 156:ff21514d8981 58 * @return 0 on success, negative error code on failure
AnnaBridge 156:ff21514d8981 59 */
AnnaBridge 156:ff21514d8981 60 virtual int close() = 0;
AnnaBridge 156:ff21514d8981 61
AnnaBridge 156:ff21514d8981 62 /** Set the current position of the directory
AnnaBridge 156:ff21514d8981 63 *
AnnaBridge 156:ff21514d8981 64 * @param offset Offset of the location to seek to,
AnnaBridge 156:ff21514d8981 65 * must be a value returned from tell
AnnaBridge 156:ff21514d8981 66 */
AnnaBridge 156:ff21514d8981 67 virtual void seek(off_t offset) = 0;
AnnaBridge 156:ff21514d8981 68
AnnaBridge 156:ff21514d8981 69 /** Get the current position of the directory
AnnaBridge 156:ff21514d8981 70 *
AnnaBridge 156:ff21514d8981 71 * @return Position of the directory that can be passed to rewind
AnnaBridge 156:ff21514d8981 72 */
AnnaBridge 156:ff21514d8981 73 virtual off_t tell() = 0;
AnnaBridge 156:ff21514d8981 74
AnnaBridge 156:ff21514d8981 75 /** Rewind the current position to the beginning of the directory
AnnaBridge 156:ff21514d8981 76 */
AnnaBridge 156:ff21514d8981 77 virtual void rewind() = 0;
AnnaBridge 156:ff21514d8981 78
AnnaBridge 156:ff21514d8981 79 /** Get the sizeof the directory
AnnaBridge 156:ff21514d8981 80 *
AnnaBridge 156:ff21514d8981 81 * @return Number of files in the directory
AnnaBridge 156:ff21514d8981 82 */
AnnaBridge 156:ff21514d8981 83 virtual size_t size()
AnnaBridge 156:ff21514d8981 84 {
AnnaBridge 156:ff21514d8981 85 off_t off = tell();
AnnaBridge 156:ff21514d8981 86 size_t size = 0;
AnnaBridge 156:ff21514d8981 87 struct dirent *ent = new struct dirent;
AnnaBridge 156:ff21514d8981 88
AnnaBridge 156:ff21514d8981 89 rewind();
AnnaBridge 156:ff21514d8981 90 while (read(ent) > 0) {
AnnaBridge 156:ff21514d8981 91 size += 1;
AnnaBridge 156:ff21514d8981 92 }
AnnaBridge 156:ff21514d8981 93 seek(off);
AnnaBridge 156:ff21514d8981 94
AnnaBridge 156:ff21514d8981 95 delete ent;
AnnaBridge 156:ff21514d8981 96 return size;
AnnaBridge 156:ff21514d8981 97 }
AnnaBridge 156:ff21514d8981 98
AnnaBridge 156:ff21514d8981 99 /** Closes the directory.
AnnaBridge 156:ff21514d8981 100 *
AnnaBridge 156:ff21514d8981 101 * @returns
AnnaBridge 156:ff21514d8981 102 * 0 on success,
AnnaBridge 156:ff21514d8981 103 * -1 on error.
AnnaBridge 156:ff21514d8981 104 */
AnnaBridge 156:ff21514d8981 105 MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::close")
AnnaBridge 156:ff21514d8981 106 virtual int closedir() { return close(); };
AnnaBridge 156:ff21514d8981 107
AnnaBridge 156:ff21514d8981 108 /** Return the directory entry at the current position, and
AnnaBridge 156:ff21514d8981 109 * advances the position to the next entry.
AnnaBridge 156:ff21514d8981 110 *
AnnaBridge 156:ff21514d8981 111 * @returns
AnnaBridge 156:ff21514d8981 112 * A pointer to a dirent structure representing the
AnnaBridge 156:ff21514d8981 113 * directory entry at the current position, or NULL on reaching
AnnaBridge 156:ff21514d8981 114 * end of directory or error.
AnnaBridge 156:ff21514d8981 115 */
AnnaBridge 156:ff21514d8981 116 MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::read")
AnnaBridge 156:ff21514d8981 117 virtual struct dirent *readdir()
AnnaBridge 156:ff21514d8981 118 {
AnnaBridge 156:ff21514d8981 119 static struct dirent ent;
AnnaBridge 156:ff21514d8981 120 return (read(&ent) > 0) ? &ent : NULL;
AnnaBridge 156:ff21514d8981 121 }
AnnaBridge 156:ff21514d8981 122
AnnaBridge 156:ff21514d8981 123 /** Resets the position to the beginning of the directory.
AnnaBridge 156:ff21514d8981 124 */
AnnaBridge 156:ff21514d8981 125 MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::rewind")
AnnaBridge 156:ff21514d8981 126 virtual void rewinddir() { rewind(); }
AnnaBridge 156:ff21514d8981 127
AnnaBridge 156:ff21514d8981 128 /** Returns the current position of the DirHandle.
AnnaBridge 156:ff21514d8981 129 *
AnnaBridge 156:ff21514d8981 130 * @returns
AnnaBridge 156:ff21514d8981 131 * the current position,
AnnaBridge 156:ff21514d8981 132 * -1 on error.
AnnaBridge 156:ff21514d8981 133 */
AnnaBridge 156:ff21514d8981 134 MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::tell")
AnnaBridge 156:ff21514d8981 135 virtual off_t telldir() { return tell(); }
AnnaBridge 156:ff21514d8981 136
AnnaBridge 156:ff21514d8981 137 /** Sets the position of the DirHandle.
AnnaBridge 156:ff21514d8981 138 *
AnnaBridge 156:ff21514d8981 139 * @param location The location to seek to. Must be a value returned by telldir.
AnnaBridge 156:ff21514d8981 140 */
AnnaBridge 156:ff21514d8981 141 MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::seek")
AnnaBridge 156:ff21514d8981 142 virtual void seekdir(off_t location) { seek(location); }
AnnaBridge 156:ff21514d8981 143 };
AnnaBridge 156:ff21514d8981 144
AnnaBridge 156:ff21514d8981 145
AnnaBridge 156:ff21514d8981 146 } // namespace mbed
AnnaBridge 156:ff21514d8981 147
AnnaBridge 156:ff21514d8981 148 #endif /* MBED_DIRHANDLE_H */