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@27:7110ebee3484, 2011-11-29 (annotated)

Committer:
emilmont
Date:
Tue Nov 29 14:59:27 2011 +0000
Revision:
27:7110ebee3484
Parent:
11:1c1ebd0324fa
Child:
43:aff670d0d510
New Libraries 11.11

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