Emir Sokic / mbedPAI Featured

mbed.h verzija za koristenje na predmetu PAI

DirHandle.h@0:05aad811ea07, 2015-03-10 (annotated)

Committer:
esokic
Date:
Tue Mar 10 09:51:52 2015 +0000
Revision:
0:05aad811ea07
mbed.h verzija od marta 2014, za koristenje na predmetu PAI

Who changed what in which revision?

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