Knight KE / Mbed OS Game_Master

游戏王对战板，目前code还是空的

mbed-os/platform/DirHandle.h@0:9b3d4731edbb, 2018-06-21 (annotated)

Committer:
WFKnight
Date:
Thu Jun 21 13:51:43 2018 +0000
Revision:
0:9b3d4731edbb
UART, RTOS, LED

Who changed what in which revision?

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