takashi kadono / Mbed OS Nucleo446_SSD1331

Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466

Dependencies:   ssd1331

mbed-os/platform/DirHandle.h@3:f3764f852aa8, 2018-10-11 (annotated)

Committer:
kadonotakashi
Date:
Thu Oct 11 02:27:46 2018 +0000
Revision:
3:f3764f852aa8
Parent:
0:8fdf9a60065b 
Nucreo 446 + SSD1331 test version;

Who changed what in which revision?

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