Sertel_Srinath Gopalan / USB_SERTEL_LOG

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed by mbed official

FileSystemLike.h@43:e2ed12d17f06, 2012-10-26 (annotated)

Committer:
emilmont
Date:
Fri Oct 26 17:40:46 2012 +0100
Revision:
43:e2ed12d17f06
Parent:
27:7110ebee3484
Child:
44:24d45a770a51
Update documentation

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rolf.meyer@arm.com 11:1c1ebd0324fa 1 /* mbed Microcontroller Library - FileSystemLike
rolf.meyer@arm.com 11:1c1ebd0324fa 2 * Copyright (c) 2008-2009 ARM Limited. All rights reserved.
rolf.meyer@arm.com 11:1c1ebd0324fa 3 */
rolf.meyer@arm.com 11:1c1ebd0324fa 4
simon.ford@mbed.co.uk 4:5d1359a283bc 5 #ifndef MBED_FILESYSTEMLIKE_H
simon.ford@mbed.co.uk 4:5d1359a283bc 6 #define MBED_FILESYSTEMLIKE_H
simon.ford@mbed.co.uk 4:5d1359a283bc 7
simon.ford@mbed.co.uk 4:5d1359a283bc 8 #ifdef __ARMCC_VERSION
simon.ford@mbed.co.uk 4:5d1359a283bc 9 # define O_RDONLY 0
simon.ford@mbed.co.uk 4:5d1359a283bc 10 # define O_WRONLY 1
simon.ford@mbed.co.uk 4:5d1359a283bc 11 # define O_RDWR 2
simon.ford@mbed.co.uk 4:5d1359a283bc 12 # define O_CREAT 0x0200
simon.ford@mbed.co.uk 5:62573be585e9 13 # define O_TRUNC 0x0400
simon.ford@mbed.co.uk 4:5d1359a283bc 14 # define O_APPEND 0x0008
simon.ford@mbed.co.uk 8:00a04e5cd407 15 typedef int mode_t;
simon.ford@mbed.co.uk 4:5d1359a283bc 16 #else
simon.ford@mbed.co.uk 4:5d1359a283bc 17 # include <sys/fcntl.h>
simon.ford@mbed.co.uk 4:5d1359a283bc 18 #endif
simon.ford@mbed.co.uk 8:00a04e5cd407 19 #include "Base.h"
simon.ford@mbed.co.uk 8:00a04e5cd407 20 #include "FileHandle.h"
simon.ford@mbed.co.uk 8:00a04e5cd407 21 #include "DirHandle.h"
simon.ford@mbed.co.uk 4:5d1359a283bc 22
simon.ford@mbed.co.uk 4:5d1359a283bc 23 namespace mbed {
simon.ford@mbed.co.uk 4:5d1359a283bc 24
emilmont 43:e2ed12d17f06 25 /** A filesystem-like object is one that can be used to open files
simon.ford@mbed.co.uk 4:5d1359a283bc 26 * though it by fopen("/name/filename", mode)
simon.ford@mbed.co.uk 4:5d1359a283bc 27 *
simon.ford@mbed.co.uk 4:5d1359a283bc 28 * Implementations must define at least open (the default definitions
simon.ford@mbed.co.uk 4:5d1359a283bc 29 * of the rest of the functions just return error values).
simon.ford@mbed.co.uk 4:5d1359a283bc 30 */
simon.ford@mbed.co.uk 4:5d1359a283bc 31 class FileSystemLike : public Base {
simon.ford@mbed.co.uk 4:5d1359a283bc 32
simon.ford@mbed.co.uk 4:5d1359a283bc 33 public:
simon.ford@mbed.co.uk 4:5d1359a283bc 34
emilmont 43:e2ed12d17f06 35 /** FileSystemLike constructor
simon.ford@mbed.co.uk 4:5d1359a283bc 36 *
emilmont 43:e2ed12d17f06 37 * @param name The name to use for the filesystem.
simon.ford@mbed.co.uk 4:5d1359a283bc 38 */
simon.ford@mbed.co.uk 4:5d1359a283bc 39 FileSystemLike(const char *name) : Base(name) {}
simon.ford@mbed.co.uk 4:5d1359a283bc 40
emilmont 43:e2ed12d17f06 41 /** Opens a file from the filesystem
simon.ford@mbed.co.uk 4:5d1359a283bc 42 *
emilmont 43:e2ed12d17f06 43 * @param filename The name of the file to open.
emilmont 43:e2ed12d17f06 44 * @param flags One of O_RDONLY, O_WRONLY, or O_RDWR, OR'd with
simon.ford@mbed.co.uk 5:62573be585e9 45 * zero or more of O_CREAT, O_TRUNC, or O_APPEND.
emilmont 43:e2ed12d17f06 46 *
emilmont 43:e2ed12d17f06 47 * @returns
emilmont 43:e2ed12d17f06 48 * A pointer to a FileHandle object representing the
emilmont 43:e2ed12d17f06 49 * file on success, or NULL on failure.
simon.ford@mbed.co.uk 4:5d1359a283bc 50 */
simon.ford@mbed.co.uk 4:5d1359a283bc 51 virtual FileHandle *open(const char *filename, int flags) = 0;
simon.ford@mbed.co.uk 4:5d1359a283bc 52
emilmont 43:e2ed12d17f06 53 /** Remove a file from the filesystem.
simon.ford@mbed.co.uk 4:5d1359a283bc 54 *
emilmont 43:e2ed12d17f06 55 * @param filename the name of the file to remove.
emilmont 43:e2ed12d17f06 56 * @param returns 0 on success, -1 on failure.
simon.ford@mbed.co.uk 4:5d1359a283bc 57 */
simon.ford@mbed.co.uk 4:5d1359a283bc 58 virtual int remove(const char *filename) { return -1; };
simon.ford@mbed.co.uk 4:5d1359a283bc 59
emilmont 43:e2ed12d17f06 60 /** Rename a file in the filesystem.
simon.ford@mbed.co.uk 4:5d1359a283bc 61 *
emilmont 43:e2ed12d17f06 62 * @param oldname the name of the file to rename.
emilmont 43:e2ed12d17f06 63 * @param newname the name to rename it to.
emilmont 43:e2ed12d17f06 64 *
emilmont 43:e2ed12d17f06 65 * @returns
emilmont 43:e2ed12d17f06 66 * 0 on success,
emilmont 43:e2ed12d17f06 67 * -1 on failure.
simon.ford@mbed.co.uk 4:5d1359a283bc 68 */
simon.ford@mbed.co.uk 4:5d1359a283bc 69 virtual int rename(const char *oldname, const char *newname) { return -1; };
simon.ford@mbed.co.uk 4:5d1359a283bc 70
emilmont 43:e2ed12d17f06 71 /** Opens a directory in the filesystem and returns a DirHandle
emilmont 43:e2ed12d17f06 72 * representing the directory stream.
simon.ford@mbed.co.uk 8:00a04e5cd407 73 *
emilmont 43:e2ed12d17f06 74 * @param name The name of the directory to open.
emilmont 43:e2ed12d17f06 75 *
emilmont 43:e2ed12d17f06 76 * @returns
emilmont 43:e2ed12d17f06 77 * A DirHandle representing the directory stream, or
emilmont 43:e2ed12d17f06 78 * NULL on failure.
simon.ford@mbed.co.uk 8:00a04e5cd407 79 */
simon.ford@mbed.co.uk 8:00a04e5cd407 80 virtual DirHandle *opendir(const char *name) { return NULL; };
simon.ford@mbed.co.uk 8:00a04e5cd407 81
emilmont 43:e2ed12d17f06 82 /** Creates a directory in the filesystem.
simon.ford@mbed.co.uk 8:00a04e5cd407 83 *
emilmont 43:e2ed12d17f06 84 * @param name The name of the directory to create.
emilmont 43:e2ed12d17f06 85 * @param mode The permissions to create the directory with.
emilmont 43:e2ed12d17f06 86 *
emilmont 43:e2ed12d17f06 87 * @returns
emilmont 43:e2ed12d17f06 88 * 0 on success,
emilmont 43:e2ed12d17f06 89 * -1 on failure.
simon.ford@mbed.co.uk 8:00a04e5cd407 90 */
simon.ford@mbed.co.uk 8:00a04e5cd407 91 virtual int mkdir(const char *name, mode_t mode) { return -1; }
simon.ford@mbed.co.uk 8:00a04e5cd407 92
simon.ford@mbed.co.uk 4:5d1359a283bc 93 // TODO other filesystem functions (mkdir, rm, rn, ls etc)
simon.ford@mbed.co.uk 4:5d1359a283bc 94
simon.ford@mbed.co.uk 4:5d1359a283bc 95 };
simon.ford@mbed.co.uk 4:5d1359a283bc 96
simon.ford@mbed.co.uk 4:5d1359a283bc 97 } // namespace mbed
simon.ford@mbed.co.uk 4:5d1359a283bc 98
simon.ford@mbed.co.uk 4:5d1359a283bc 99 #endif