spinal cord / PokittoLib_

PokittoLib is the library needed for programming the Pokitto DIY game console (www.pokitto.com)

mbed-pokitto/api/DirHandle.h@64:6e6c6c2b664e, 2018-11-18 (annotated)

Committer:
spinal
Date:
Sun Nov 18 15:47:54 2018 +0000
Revision:
64:6e6c6c2b664e
Parent:
5:ea7377f3d1af 
added fix for directrectangle()

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Pokitto 5:ea7377f3d1af 1 /* mbed Microcontroller Library
Pokitto 5:ea7377f3d1af 2 * Copyright (c) 2006-2013 ARM Limited
Pokitto 5:ea7377f3d1af 3 *
Pokitto 5:ea7377f3d1af 4 * Licensed under the Apache License, Version 2.0 (the "License");
Pokitto 5:ea7377f3d1af 5 * you may not use this file except in compliance with the License.
Pokitto 5:ea7377f3d1af 6 * You may obtain a copy of the License at
Pokitto 5:ea7377f3d1af 7 *
Pokitto 5:ea7377f3d1af 8 * http://www.apache.org/licenses/LICENSE-2.0
Pokitto 5:ea7377f3d1af 9 *
Pokitto 5:ea7377f3d1af 10 * Unless required by applicable law or agreed to in writing, software
Pokitto 5:ea7377f3d1af 11 * distributed under the License is distributed on an "AS IS" BASIS,
Pokitto 5:ea7377f3d1af 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Pokitto 5:ea7377f3d1af 13 * See the License for the specific language governing permissions and
Pokitto 5:ea7377f3d1af 14 * limitations under the License.
Pokitto 5:ea7377f3d1af 15 */
Pokitto 5:ea7377f3d1af 16 #ifndef MBED_DIRHANDLE_H
Pokitto 5:ea7377f3d1af 17 #define MBED_DIRHANDLE_H
Pokitto 5:ea7377f3d1af 18
Pokitto 5:ea7377f3d1af 19 #if defined(__ARMCC_VERSION) || defined(__ICCARM__)
Pokitto 5:ea7377f3d1af 20 # define NAME_MAX 255
Pokitto 5:ea7377f3d1af 21 typedef int mode_t;
Pokitto 5:ea7377f3d1af 22
Pokitto 5:ea7377f3d1af 23 #else
Pokitto 5:ea7377f3d1af 24 # include <sys/syslimits.h>
Pokitto 5:ea7377f3d1af 25 #endif
Pokitto 5:ea7377f3d1af 26
Pokitto 5:ea7377f3d1af 27 #include "FileHandle.h"
Pokitto 5:ea7377f3d1af 28
Pokitto 5:ea7377f3d1af 29 struct dirent {
Pokitto 5:ea7377f3d1af 30 char d_name[NAME_MAX+1];
Pokitto 5:ea7377f3d1af 31 };
Pokitto 5:ea7377f3d1af 32
Pokitto 5:ea7377f3d1af 33 namespace mbed {
Pokitto 5:ea7377f3d1af 34
Pokitto 5:ea7377f3d1af 35 /** Represents a directory stream. Objects of this type are returned
Pokitto 5:ea7377f3d1af 36 * by a FileSystemLike's opendir method. Implementations must define
Pokitto 5:ea7377f3d1af 37 * at least closedir, readdir and rewinddir.
Pokitto 5:ea7377f3d1af 38 *
Pokitto 5:ea7377f3d1af 39 * If a FileSystemLike class defines the opendir method, then the
Pokitto 5:ea7377f3d1af 40 * directories of an object of that type can be accessed by
Pokitto 5:ea7377f3d1af 41 * DIR *d = opendir("/example/directory") (or opendir("/example")
Pokitto 5:ea7377f3d1af 42 * to open the root of the filesystem), and then using readdir(d) etc.
Pokitto 5:ea7377f3d1af 43 *
Pokitto 5:ea7377f3d1af 44 * The root directory is considered to contain all FileLike and
Pokitto 5:ea7377f3d1af 45 * FileSystemLike objects, so the DIR* returned by opendir("/") will
Pokitto 5:ea7377f3d1af 46 * reflect this.
Pokitto 5:ea7377f3d1af 47 */
Pokitto 5:ea7377f3d1af 48 class DirHandle {
Pokitto 5:ea7377f3d1af 49
Pokitto 5:ea7377f3d1af 50 public:
Pokitto 5:ea7377f3d1af 51 /** Closes the directory.
Pokitto 5:ea7377f3d1af 52 *
Pokitto 5:ea7377f3d1af 53 * @returns
Pokitto 5:ea7377f3d1af 54 * 0 on success,
Pokitto 5:ea7377f3d1af 55 * -1 on error.
Pokitto 5:ea7377f3d1af 56 */
Pokitto 5:ea7377f3d1af 57 virtual int closedir()=0;
Pokitto 5:ea7377f3d1af 58
Pokitto 5:ea7377f3d1af 59 /** Return the directory entry at the current position, and
Pokitto 5:ea7377f3d1af 60 * advances the position to the next entry.
Pokitto 5:ea7377f3d1af 61 *
Pokitto 5:ea7377f3d1af 62 * @returns
Pokitto 5:ea7377f3d1af 63 * A pointer to a dirent structure representing the
Pokitto 5:ea7377f3d1af 64 * directory entry at the current position, or NULL on reaching
Pokitto 5:ea7377f3d1af 65 * end of directory or error.
Pokitto 5:ea7377f3d1af 66 */
Pokitto 5:ea7377f3d1af 67 virtual struct dirent *readdir()=0;
Pokitto 5:ea7377f3d1af 68
Pokitto 5:ea7377f3d1af 69 /** Resets the position to the beginning of the directory.
Pokitto 5:ea7377f3d1af 70 */
Pokitto 5:ea7377f3d1af 71 virtual void rewinddir()=0;
Pokitto 5:ea7377f3d1af 72
Pokitto 5:ea7377f3d1af 73 /** Returns the current position of the DirHandle.
Pokitto 5:ea7377f3d1af 74 *
Pokitto 5:ea7377f3d1af 75 * @returns
Pokitto 5:ea7377f3d1af 76 * the current position,
Pokitto 5:ea7377f3d1af 77 * -1 on error.
Pokitto 5:ea7377f3d1af 78 */
Pokitto 5:ea7377f3d1af 79 virtual off_t telldir() { return -1; }
Pokitto 5:ea7377f3d1af 80
Pokitto 5:ea7377f3d1af 81 /** Sets the position of the DirHandle.
Pokitto 5:ea7377f3d1af 82 *
Pokitto 5:ea7377f3d1af 83 * @param location The location to seek to. Must be a value returned by telldir.
Pokitto 5:ea7377f3d1af 84 */
Pokitto 5:ea7377f3d1af 85 virtual void seekdir(off_t location) { }
Pokitto 5:ea7377f3d1af 86
Pokitto 5:ea7377f3d1af 87 virtual ~DirHandle() {}
Pokitto 5:ea7377f3d1af 88 };
Pokitto 5:ea7377f3d1af 89
Pokitto 5:ea7377f3d1af 90 } // namespace mbed
Pokitto 5:ea7377f3d1af 91
Pokitto 5:ea7377f3d1af 92 typedef mbed::DirHandle DIR;
Pokitto 5:ea7377f3d1af 93
Pokitto 5:ea7377f3d1af 94 extern "C" {
Pokitto 5:ea7377f3d1af 95 DIR *opendir(const char*);
Pokitto 5:ea7377f3d1af 96 struct dirent *readdir(DIR *);
Pokitto 5:ea7377f3d1af 97 int closedir(DIR*);
Pokitto 5:ea7377f3d1af 98 void rewinddir(DIR*);
Pokitto 5:ea7377f3d1af 99 long telldir(DIR*);
Pokitto 5:ea7377f3d1af 100 void seekdir(DIR*, long);
Pokitto 5:ea7377f3d1af 101 int mkdir(const char *name, mode_t n);
Pokitto 5:ea7377f3d1af 102 };
Pokitto 5:ea7377f3d1af 103
Pokitto 5:ea7377f3d1af 104 #endif /* MBED_DIRHANDLE_H */