Vladimir Vana / mbed

pro vyuku PSS v Jecne

DirHandle.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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