Mihail Stoyanov / mbed

Fork of the official mbed C/C++ SDK provides the software platform and libraries to build your applications. The fork has the documentation converted to Doxygen format

Dependents:   NervousPuppySprintOne NervousPuppySprint2602 Robot WarehouseBot1 ... more

Fork of mbed by mbed official

Base.h@8:00a04e5cd407, 2009-02-03 (annotated)

Committer:
simon.ford@mbed.co.uk
Date:
Tue Feb 03 18:02:02 2009 +0000
Revision:
8:00a04e5cd407
Parent:
7:15d74db76485
Child:
11:1c1ebd0324fa
* Update to improve filesystem support

 * Add a generic FATFileSystem

Who changed what in which revision?

UserRevisionLine numberNew contents of line
simon.ford@mbed.co.uk 0:82220227f4fa 1 /* mbed Microcontroller Library - Base
simon.ford@mbed.co.uk 4:5d1359a283bc 2 * Copyright (c) 2006-2008 ARM Limited. All rights reserved.
simon.ford@mbed.co.uk 4:5d1359a283bc 3 * sford, jbrawn
simon.ford@mbed.co.uk 0:82220227f4fa 4 */
simon.ford@mbed.co.uk 4:5d1359a283bc 5
simon.ford@mbed.co.uk 0:82220227f4fa 6 #ifndef MBED_BASE_H
simon.ford@mbed.co.uk 0:82220227f4fa 7 #define MBED_BASE_H
simon.ford@mbed.co.uk 0:82220227f4fa 8
simon.ford@mbed.co.uk 4:5d1359a283bc 9 #include <cstdlib>
simon.ford@mbed.co.uk 8:00a04e5cd407 10 #include "DirHandle.h"
simon.ford@mbed.co.uk 0:82220227f4fa 11
simon.ford@mbed.co.uk 0:82220227f4fa 12 namespace mbed {
simon.ford@mbed.co.uk 0:82220227f4fa 13
simon.ford@mbed.co.uk 5:62573be585e9 14 struct rpc_function {
simon.ford@mbed.co.uk 5:62573be585e9 15 const char *name;
simon.ford@mbed.co.uk 5:62573be585e9 16 void (*caller)(const char*, char*);
simon.ford@mbed.co.uk 5:62573be585e9 17 };
simon.ford@mbed.co.uk 5:62573be585e9 18
simon.ford@mbed.co.uk 5:62573be585e9 19 struct rpc_class {
simon.ford@mbed.co.uk 5:62573be585e9 20 const char *name;
simon.ford@mbed.co.uk 5:62573be585e9 21 const rpc_function *static_functions;
simon.ford@mbed.co.uk 5:62573be585e9 22 struct rpc_class *next;
simon.ford@mbed.co.uk 5:62573be585e9 23 };
simon.ford@mbed.co.uk 5:62573be585e9 24
simon.ford@mbed.co.uk 4:5d1359a283bc 25 /* Class Base
simon.ford@mbed.co.uk 4:5d1359a283bc 26 * The base class for most things
simon.ford@mbed.co.uk 4:5d1359a283bc 27 */
simon.ford@mbed.co.uk 0:82220227f4fa 28 class Base {
simon.ford@mbed.co.uk 0:82220227f4fa 29
simon.ford@mbed.co.uk 0:82220227f4fa 30 public:
simon.ford@mbed.co.uk 4:5d1359a283bc 31
simon.ford@mbed.co.uk 4:5d1359a283bc 32 Base(const char *name = NULL);
simon.ford@mbed.co.uk 0:82220227f4fa 33
simon.ford@mbed.co.uk 4:5d1359a283bc 34 virtual ~Base();
simon.ford@mbed.co.uk 4:5d1359a283bc 35
simon.ford@mbed.co.uk 4:5d1359a283bc 36 /* Function register_object
simon.ford@mbed.co.uk 4:5d1359a283bc 37 * Registers this object with the given name, so that it can be
simon.ford@mbed.co.uk 4:5d1359a283bc 38 * looked up with lookup. If this object has already been
simon.ford@mbed.co.uk 4:5d1359a283bc 39 * registered, then this just changes the name.
simon.ford@mbed.co.uk 4:5d1359a283bc 40 *
simon.ford@mbed.co.uk 4:5d1359a283bc 41 * Variables
simon.ford@mbed.co.uk 4:5d1359a283bc 42 * name - The name to give the object. If NULL we do nothing.
simon.ford@mbed.co.uk 4:5d1359a283bc 43 */
simon.ford@mbed.co.uk 4:5d1359a283bc 44 void register_object(const char *name);
simon.ford@mbed.co.uk 4:5d1359a283bc 45
simon.ford@mbed.co.uk 4:5d1359a283bc 46 /* Function name
simon.ford@mbed.co.uk 4:5d1359a283bc 47 * Returns the name of the object, or NULL if it has no name.
simon.ford@mbed.co.uk 4:5d1359a283bc 48 */
simon.ford@mbed.co.uk 4:5d1359a283bc 49 const char *name();
simon.ford@mbed.co.uk 4:5d1359a283bc 50
simon.ford@mbed.co.uk 4:5d1359a283bc 51 /* Function rpc
simon.ford@mbed.co.uk 4:5d1359a283bc 52 * Call the given method with the given arguments, and write the
simon.ford@mbed.co.uk 4:5d1359a283bc 53 * result into the string pointed to by result. The default
simon.ford@mbed.co.uk 4:5d1359a283bc 54 * implementation calls rpc_methods to determine the supported
simon.ford@mbed.co.uk 4:5d1359a283bc 55 * methods.
simon.ford@mbed.co.uk 4:5d1359a283bc 56 *
simon.ford@mbed.co.uk 4:5d1359a283bc 57 * Variables
simon.ford@mbed.co.uk 4:5d1359a283bc 58 * method - The name of the method to call.
simon.ford@mbed.co.uk 4:5d1359a283bc 59 * arguments - A list of arguments separated by spaces.
simon.ford@mbed.co.uk 4:5d1359a283bc 60 * result - A pointer to a string to write the result into. May
simon.ford@mbed.co.uk 4:5d1359a283bc 61 * be NULL, in which case nothing is written.
simon.ford@mbed.co.uk 4:5d1359a283bc 62 * returns - true if method corresponds to a valid rpc method, or
simon.ford@mbed.co.uk 4:5d1359a283bc 63 * false otherwise.
simon.ford@mbed.co.uk 4:5d1359a283bc 64 */
simon.ford@mbed.co.uk 4:5d1359a283bc 65 virtual bool rpc(const char *method, const char *arguments, char *result);
simon.ford@mbed.co.uk 0:82220227f4fa 66
simon.ford@mbed.co.uk 5:62573be585e9 67 /* Function get_rpc_methods
simon.ford@mbed.co.uk 4:5d1359a283bc 68 * Returns a pointer to an array describing the rpc methods
simon.ford@mbed.co.uk 5:62573be585e9 69 * supported by this object, terminated by either
simon.ford@mbed.co.uk 5:62573be585e9 70 * RPC_METHOD_END or RPC_METHOD_SUPER(Superclass).
simon.ford@mbed.co.uk 4:5d1359a283bc 71 *
simon.ford@mbed.co.uk 4:5d1359a283bc 72 * Example
simon.ford@mbed.co.uk 4:5d1359a283bc 73 *
simon.ford@mbed.co.uk 4:5d1359a283bc 74 * > class Example : public Base {
simon.ford@mbed.co.uk 4:5d1359a283bc 75 * > int foo(int a, int b) { return a + b; }
simon.ford@mbed.co.uk 5:62573be585e9 76 * > virtual const struct rpc_method *get_rpc_methods() {
simon.ford@mbed.co.uk 4:5d1359a283bc 77 * > static const rpc_method rpc_methods[] = {
simon.ford@mbed.co.uk 4:5d1359a283bc 78 * > { "foo", generic_caller<int, Example, int, int, &Example::foo> },
simon.ford@mbed.co.uk 5:62573be585e9 79 * > RPC_METHOD_SUPER(Base)
simon.ford@mbed.co.uk 4:5d1359a283bc 80 * > };
simon.ford@mbed.co.uk 4:5d1359a283bc 81 * > return rpc_methods;
simon.ford@mbed.co.uk 4:5d1359a283bc 82 * > }
simon.ford@mbed.co.uk 4:5d1359a283bc 83 * > };
simon.ford@mbed.co.uk 4:5d1359a283bc 84 */
simon.ford@mbed.co.uk 5:62573be585e9 85 virtual const struct rpc_method *get_rpc_methods();
simon.ford@mbed.co.uk 5:62573be585e9 86
simon.ford@mbed.co.uk 4:5d1359a283bc 87 /* Function rpc
simon.ford@mbed.co.uk 4:5d1359a283bc 88 * Use the lookup function to lookup an object and, if
simon.ford@mbed.co.uk 4:5d1359a283bc 89 * successful, call its rpc method
simon.ford@mbed.co.uk 4:5d1359a283bc 90 *
simon.ford@mbed.co.uk 4:5d1359a283bc 91 * Variables
simon.ford@mbed.co.uk 4:5d1359a283bc 92 * returns - false if name does not correspond to an object,
simon.ford@mbed.co.uk 4:5d1359a283bc 93 * otherwise the return value of the call to the object's rpc
simon.ford@mbed.co.uk 4:5d1359a283bc 94 * method.
simon.ford@mbed.co.uk 4:5d1359a283bc 95 */
simon.ford@mbed.co.uk 4:5d1359a283bc 96 static bool rpc(const char *name, const char *method, const char *arguments, char *result);
simon.ford@mbed.co.uk 4:5d1359a283bc 97
simon.ford@mbed.co.uk 4:5d1359a283bc 98 /* Function lookup
simon.ford@mbed.co.uk 4:5d1359a283bc 99 * Lookup and return the object that has the given name.
simon.ford@mbed.co.uk 4:5d1359a283bc 100 *
simon.ford@mbed.co.uk 4:5d1359a283bc 101 * Variables
simon.ford@mbed.co.uk 4:5d1359a283bc 102 * name - the name to lookup.
simon.ford@mbed.co.uk 4:5d1359a283bc 103 * len - the length of name.
simon.ford@mbed.co.uk 4:5d1359a283bc 104 */
simon.ford@mbed.co.uk 4:5d1359a283bc 105 static Base *lookup(const char *name, unsigned int len);
simon.ford@mbed.co.uk 0:82220227f4fa 106
simon.ford@mbed.co.uk 8:00a04e5cd407 107 static DirHandle *opendir();
simon.ford@mbed.co.uk 8:00a04e5cd407 108 friend class BaseDirHandle;
simon.ford@mbed.co.uk 8:00a04e5cd407 109
simon.ford@mbed.co.uk 0:82220227f4fa 110 protected:
simon.ford@mbed.co.uk 0:82220227f4fa 111
simon.ford@mbed.co.uk 4:5d1359a283bc 112 static Base *_head;
simon.ford@mbed.co.uk 4:5d1359a283bc 113 Base *_next;
simon.ford@mbed.co.uk 4:5d1359a283bc 114 const char *_name;
simon.ford@mbed.co.uk 5:62573be585e9 115 bool _from_construct;
simon.ford@mbed.co.uk 5:62573be585e9 116
simon.ford@mbed.co.uk 5:62573be585e9 117 private:
simon.ford@mbed.co.uk 5:62573be585e9 118
simon.ford@mbed.co.uk 5:62573be585e9 119 static rpc_class *_classes;
simon.ford@mbed.co.uk 5:62573be585e9 120
simon.ford@mbed.co.uk 7:15d74db76485 121 static const rpc_function _base_funcs[];
simon.ford@mbed.co.uk 7:15d74db76485 122 static rpc_class _base_class;
simon.ford@mbed.co.uk 7:15d74db76485 123
simon.ford@mbed.co.uk 5:62573be585e9 124 void delete_self();
simon.ford@mbed.co.uk 5:62573be585e9 125 static void list_objs(const char *arguments, char *result);
simon.ford@mbed.co.uk 5:62573be585e9 126 static void clear(const char*,char*);
simon.ford@mbed.co.uk 5:62573be585e9 127
simon.ford@mbed.co.uk 5:62573be585e9 128 static char *new_name(Base *p);
simon.ford@mbed.co.uk 5:62573be585e9 129
simon.ford@mbed.co.uk 5:62573be585e9 130 public:
simon.ford@mbed.co.uk 5:62573be585e9 131
simon.ford@mbed.co.uk 5:62573be585e9 132 /* Function add_rpc_class
simon.ford@mbed.co.uk 5:62573be585e9 133 * Add the class to the list of classes which can have static
simon.ford@mbed.co.uk 5:62573be585e9 134 * methods called via rpc (the static methods which can be called
simon.ford@mbed.co.uk 5:62573be585e9 135 * are defined by that class' get_rpc_class() static method).
simon.ford@mbed.co.uk 5:62573be585e9 136 */
simon.ford@mbed.co.uk 5:62573be585e9 137 template<class C>
simon.ford@mbed.co.uk 5:62573be585e9 138 static void add_rpc_class() {
simon.ford@mbed.co.uk 5:62573be585e9 139 rpc_class *c = C::get_rpc_class();
simon.ford@mbed.co.uk 5:62573be585e9 140 c->next = _classes;
simon.ford@mbed.co.uk 5:62573be585e9 141 _classes = c;
simon.ford@mbed.co.uk 5:62573be585e9 142 }
simon.ford@mbed.co.uk 5:62573be585e9 143
simon.ford@mbed.co.uk 5:62573be585e9 144 template<class C>
simon.ford@mbed.co.uk 5:62573be585e9 145 static const char *construct() {
simon.ford@mbed.co.uk 5:62573be585e9 146 Base *p = new C();
simon.ford@mbed.co.uk 5:62573be585e9 147 p->_from_construct = true;
simon.ford@mbed.co.uk 5:62573be585e9 148 if(p->_name==NULL) {
simon.ford@mbed.co.uk 5:62573be585e9 149 p->register_object(new_name(p));
simon.ford@mbed.co.uk 5:62573be585e9 150 }
simon.ford@mbed.co.uk 5:62573be585e9 151 return p->_name;
simon.ford@mbed.co.uk 5:62573be585e9 152 }
simon.ford@mbed.co.uk 5:62573be585e9 153
simon.ford@mbed.co.uk 5:62573be585e9 154 template<class C, typename A1>
simon.ford@mbed.co.uk 5:62573be585e9 155 static const char *construct(A1 arg1) {
simon.ford@mbed.co.uk 5:62573be585e9 156 Base *p = new C(arg1);
simon.ford@mbed.co.uk 5:62573be585e9 157 p->_from_construct = true;
simon.ford@mbed.co.uk 5:62573be585e9 158 if(p->_name==NULL) {
simon.ford@mbed.co.uk 5:62573be585e9 159 p->register_object(new_name(p));
simon.ford@mbed.co.uk 5:62573be585e9 160 }
simon.ford@mbed.co.uk 5:62573be585e9 161 return p->_name;
simon.ford@mbed.co.uk 5:62573be585e9 162 }
simon.ford@mbed.co.uk 5:62573be585e9 163
simon.ford@mbed.co.uk 5:62573be585e9 164 template<class C, typename A1, typename A2>
simon.ford@mbed.co.uk 5:62573be585e9 165 static const char *construct(A1 arg1, A2 arg2) {
simon.ford@mbed.co.uk 5:62573be585e9 166 Base *p = new C(arg1,arg2);
simon.ford@mbed.co.uk 5:62573be585e9 167 p->_from_construct = true;
simon.ford@mbed.co.uk 5:62573be585e9 168 if(p->_name==NULL) {
simon.ford@mbed.co.uk 5:62573be585e9 169 p->register_object(new_name(p));
simon.ford@mbed.co.uk 5:62573be585e9 170 }
simon.ford@mbed.co.uk 5:62573be585e9 171 return p->_name;
simon.ford@mbed.co.uk 5:62573be585e9 172 }
simon.ford@mbed.co.uk 5:62573be585e9 173
simon.ford@mbed.co.uk 5:62573be585e9 174 template<class C, typename A1, typename A2, typename A3>
simon.ford@mbed.co.uk 5:62573be585e9 175 static const char *construct(A1 arg1, A2 arg2, A3 arg3) {
simon.ford@mbed.co.uk 5:62573be585e9 176 Base *p = new C(arg1,arg2,arg3);
simon.ford@mbed.co.uk 5:62573be585e9 177 p->_from_construct = true;
simon.ford@mbed.co.uk 5:62573be585e9 178 if(p->_name==NULL) {
simon.ford@mbed.co.uk 5:62573be585e9 179 p->register_object(new_name(p));
simon.ford@mbed.co.uk 5:62573be585e9 180 }
simon.ford@mbed.co.uk 5:62573be585e9 181 return p->_name;
simon.ford@mbed.co.uk 5:62573be585e9 182 }
simon.ford@mbed.co.uk 5:62573be585e9 183
simon.ford@mbed.co.uk 5:62573be585e9 184 template<class C, typename A1, typename A2, typename A3, typename A4>
simon.ford@mbed.co.uk 5:62573be585e9 185 static const char *construct(A1 arg1, A2 arg2, A3 arg3, A4 arg4) {
simon.ford@mbed.co.uk 5:62573be585e9 186 Base *p = new C(arg1,arg2,arg3,arg4);
simon.ford@mbed.co.uk 5:62573be585e9 187 p->_from_construct = true;
simon.ford@mbed.co.uk 5:62573be585e9 188 if(p->_name==NULL) {
simon.ford@mbed.co.uk 5:62573be585e9 189 p->register_object(new_name(p));
simon.ford@mbed.co.uk 5:62573be585e9 190 }
simon.ford@mbed.co.uk 5:62573be585e9 191 return p->_name;
simon.ford@mbed.co.uk 5:62573be585e9 192 }
simon.ford@mbed.co.uk 4:5d1359a283bc 193
simon.ford@mbed.co.uk 0:82220227f4fa 194 };
simon.ford@mbed.co.uk 0:82220227f4fa 195
simon.ford@mbed.co.uk 4:5d1359a283bc 196 /* Macro MBED_OBJECT_NAME_MAX
simon.ford@mbed.co.uk 4:5d1359a283bc 197 * The maximum size of object name (including terminating null byte)
simon.ford@mbed.co.uk 4:5d1359a283bc 198 * that will be recognised when using fopen to open a FileLike
simon.ford@mbed.co.uk 4:5d1359a283bc 199 * object, or when using the rpc function.
simon.ford@mbed.co.uk 4:5d1359a283bc 200 */
simon.ford@mbed.co.uk 4:5d1359a283bc 201 #define MBED_OBJECT_NAME_MAX 32
simon.ford@mbed.co.uk 4:5d1359a283bc 202
simon.ford@mbed.co.uk 4:5d1359a283bc 203 /* Macro MBED_METHOD_NAME_MAX
simon.ford@mbed.co.uk 4:5d1359a283bc 204 * The maximum size of rpc method name (including terminating null
simon.ford@mbed.co.uk 4:5d1359a283bc 205 * byte) that will be recognised by the rpc function (in rpc.h).
simon.ford@mbed.co.uk 4:5d1359a283bc 206 */
simon.ford@mbed.co.uk 4:5d1359a283bc 207 #define MBED_METHOD_NAME_MAX 32
simon.ford@mbed.co.uk 4:5d1359a283bc 208
simon.ford@mbed.co.uk 0:82220227f4fa 209 } // namespace mbed
simon.ford@mbed.co.uk 0:82220227f4fa 210
simon.ford@mbed.co.uk 1:6b7f447ca868 211 #endif
simon.ford@mbed.co.uk 1:6b7f447ca868 212