jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

CallChain.h@71:7ec3cb6bbcc4, 2013-11-29 (annotated)

Committer:
jalp89
Date:
Fri Nov 29 09:39:46 2013 +0000
Revision:
71:7ec3cb6bbcc4
Parent:
66:9c8f0e3462fb 
...

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 66:9c8f0e3462fb 1 /* mbed Microcontroller Library
bogdanm 66:9c8f0e3462fb 2 * Copyright (c) 2006-2013 ARM Limited
bogdanm 66:9c8f0e3462fb 3 *
bogdanm 66:9c8f0e3462fb 4 * Licensed under the Apache License, Version 2.0 (the "License");
bogdanm 66:9c8f0e3462fb 5 * you may not use this file except in compliance with the License.
bogdanm 66:9c8f0e3462fb 6 * You may obtain a copy of the License at
bogdanm 66:9c8f0e3462fb 7 *
bogdanm 66:9c8f0e3462fb 8 * http://www.apache.org/licenses/LICENSE-2.0
bogdanm 66:9c8f0e3462fb 9 *
bogdanm 66:9c8f0e3462fb 10 * Unless required by applicable law or agreed to in writing, software
bogdanm 66:9c8f0e3462fb 11 * distributed under the License is distributed on an "AS IS" BASIS,
bogdanm 66:9c8f0e3462fb 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
bogdanm 66:9c8f0e3462fb 13 * See the License for the specific language governing permissions and
bogdanm 66:9c8f0e3462fb 14 * limitations under the License.
bogdanm 66:9c8f0e3462fb 15 */
bogdanm 66:9c8f0e3462fb 16 #ifndef MBED_CALLCHAIN_H
bogdanm 66:9c8f0e3462fb 17 #define MBED_CALLCHAIN_H
bogdanm 66:9c8f0e3462fb 18
bogdanm 66:9c8f0e3462fb 19 #include "FunctionPointer.h"
bogdanm 66:9c8f0e3462fb 20 #include <string.h>
bogdanm 66:9c8f0e3462fb 21
bogdanm 66:9c8f0e3462fb 22 namespace mbed {
bogdanm 66:9c8f0e3462fb 23
bogdanm 66:9c8f0e3462fb 24 /** Group one or more functions in an instance of a CallChain, then call them in
bogdanm 66:9c8f0e3462fb 25 * sequence using CallChain::call(). Used mostly by the interrupt chaining code,
bogdanm 66:9c8f0e3462fb 26 * but can be used for other purposes.
bogdanm 66:9c8f0e3462fb 27 *
bogdanm 66:9c8f0e3462fb 28 * Example:
bogdanm 66:9c8f0e3462fb 29 * @code
bogdanm 66:9c8f0e3462fb 30 * #include "mbed.h"
bogdanm 66:9c8f0e3462fb 31 *
bogdanm 66:9c8f0e3462fb 32 * CallChain chain;
bogdanm 66:9c8f0e3462fb 33 *
bogdanm 66:9c8f0e3462fb 34 * void first(void) {
bogdanm 66:9c8f0e3462fb 35 * printf("'first' function.\n");
bogdanm 66:9c8f0e3462fb 36 * }
bogdanm 66:9c8f0e3462fb 37 *
bogdanm 66:9c8f0e3462fb 38 * void second(void) {
bogdanm 66:9c8f0e3462fb 39 * printf("'second' function.\n");
bogdanm 66:9c8f0e3462fb 40 * }
bogdanm 66:9c8f0e3462fb 41 *
bogdanm 66:9c8f0e3462fb 42 * class Test {
bogdanm 66:9c8f0e3462fb 43 * public:
bogdanm 66:9c8f0e3462fb 44 * void f(void) {
bogdanm 66:9c8f0e3462fb 45 * printf("A::f (class member).\n");
bogdanm 66:9c8f0e3462fb 46 * }
bogdanm 66:9c8f0e3462fb 47 * };
bogdanm 66:9c8f0e3462fb 48 *
bogdanm 66:9c8f0e3462fb 49 * int main() {
bogdanm 66:9c8f0e3462fb 50 * Test test;
bogdanm 66:9c8f0e3462fb 51 *
bogdanm 66:9c8f0e3462fb 52 * chain.add(second);
bogdanm 66:9c8f0e3462fb 53 * chain.add_front(first);
bogdanm 66:9c8f0e3462fb 54 * chain.add(&test, &Test::f);
bogdanm 66:9c8f0e3462fb 55 * chain.call();
bogdanm 66:9c8f0e3462fb 56 * }
bogdanm 66:9c8f0e3462fb 57 * @endcode
bogdanm 66:9c8f0e3462fb 58 */
bogdanm 66:9c8f0e3462fb 59
bogdanm 66:9c8f0e3462fb 60 typedef FunctionPointer* pFunctionPointer_t;
bogdanm 66:9c8f0e3462fb 61
bogdanm 66:9c8f0e3462fb 62 class CallChain {
bogdanm 66:9c8f0e3462fb 63 public:
bogdanm 66:9c8f0e3462fb 64 /** Create an empty chain
bogdanm 66:9c8f0e3462fb 65 *
bogdanm 66:9c8f0e3462fb 66 * @param size (optional) Initial size of the chain
bogdanm 66:9c8f0e3462fb 67 */
bogdanm 66:9c8f0e3462fb 68 CallChain(int size = 4);
bogdanm 66:9c8f0e3462fb 69 virtual ~CallChain();
bogdanm 66:9c8f0e3462fb 70
bogdanm 66:9c8f0e3462fb 71 /** Add a function at the end of the chain
bogdanm 66:9c8f0e3462fb 72 *
bogdanm 66:9c8f0e3462fb 73 * @param function A pointer to a void function
bogdanm 66:9c8f0e3462fb 74 *
bogdanm 66:9c8f0e3462fb 75 * @returns
bogdanm 66:9c8f0e3462fb 76 * The function object created for 'function'
bogdanm 66:9c8f0e3462fb 77 */
bogdanm 66:9c8f0e3462fb 78 pFunctionPointer_t add(void (*function)(void));
bogdanm 66:9c8f0e3462fb 79
bogdanm 66:9c8f0e3462fb 80 /** Add a function at the end of the chain
bogdanm 66:9c8f0e3462fb 81 *
bogdanm 66:9c8f0e3462fb 82 * @param tptr pointer to the object to call the member function on
bogdanm 66:9c8f0e3462fb 83 * @param mptr pointer to the member function to be called
bogdanm 66:9c8f0e3462fb 84 *
bogdanm 66:9c8f0e3462fb 85 * @returns
bogdanm 66:9c8f0e3462fb 86 * The function object created for 'tptr' and 'mptr'
bogdanm 66:9c8f0e3462fb 87 */
bogdanm 66:9c8f0e3462fb 88 template<typename T>
bogdanm 66:9c8f0e3462fb 89 pFunctionPointer_t add(T *tptr, void (T::*mptr)(void)) {
bogdanm 66:9c8f0e3462fb 90 return common_add(new FunctionPointer(tptr, mptr));
bogdanm 66:9c8f0e3462fb 91 }
bogdanm 66:9c8f0e3462fb 92
bogdanm 66:9c8f0e3462fb 93 /** Add a function at the beginning of the chain
bogdanm 66:9c8f0e3462fb 94 *
bogdanm 66:9c8f0e3462fb 95 * @param function A pointer to a void function
bogdanm 66:9c8f0e3462fb 96 *
bogdanm 66:9c8f0e3462fb 97 * @returns
bogdanm 66:9c8f0e3462fb 98 * The function object created for 'function'
bogdanm 66:9c8f0e3462fb 99 */
bogdanm 66:9c8f0e3462fb 100 pFunctionPointer_t add_front(void (*function)(void));
bogdanm 66:9c8f0e3462fb 101
bogdanm 66:9c8f0e3462fb 102 /** Add a function at the beginning of the chain
bogdanm 66:9c8f0e3462fb 103 *
bogdanm 66:9c8f0e3462fb 104 * @param tptr pointer to the object to call the member function on
bogdanm 66:9c8f0e3462fb 105 * @param mptr pointer to the member function to be called
bogdanm 66:9c8f0e3462fb 106 *
bogdanm 66:9c8f0e3462fb 107 * @returns
bogdanm 66:9c8f0e3462fb 108 * The function object created for 'tptr' and 'mptr'
bogdanm 66:9c8f0e3462fb 109 */
bogdanm 66:9c8f0e3462fb 110 template<typename T>
bogdanm 66:9c8f0e3462fb 111 pFunctionPointer_t add_front(T *tptr, void (T::*mptr)(void)) {
bogdanm 66:9c8f0e3462fb 112 return common_add_front(new FunctionPointer(tptr, mptr));
bogdanm 66:9c8f0e3462fb 113 }
bogdanm 66:9c8f0e3462fb 114
bogdanm 66:9c8f0e3462fb 115 /** Get the number of functions in the chain
bogdanm 66:9c8f0e3462fb 116 */
bogdanm 66:9c8f0e3462fb 117 int size() const;
bogdanm 66:9c8f0e3462fb 118
bogdanm 66:9c8f0e3462fb 119 /** Get a function object from the chain
bogdanm 66:9c8f0e3462fb 120 *
bogdanm 66:9c8f0e3462fb 121 * @param i function object index
bogdanm 66:9c8f0e3462fb 122 *
bogdanm 66:9c8f0e3462fb 123 * @returns
bogdanm 66:9c8f0e3462fb 124 * The function object at position 'i' in the chain
bogdanm 66:9c8f0e3462fb 125 */
bogdanm 66:9c8f0e3462fb 126 pFunctionPointer_t get(int i) const;
bogdanm 66:9c8f0e3462fb 127
bogdanm 66:9c8f0e3462fb 128 /** Look for a function object in the call chain
bogdanm 66:9c8f0e3462fb 129 *
bogdanm 66:9c8f0e3462fb 130 * @param f the function object to search
bogdanm 66:9c8f0e3462fb 131 *
bogdanm 66:9c8f0e3462fb 132 * @returns
bogdanm 66:9c8f0e3462fb 133 * The index of the function object if found, -1 otherwise.
bogdanm 66:9c8f0e3462fb 134 */
bogdanm 66:9c8f0e3462fb 135 int find(pFunctionPointer_t f) const;
bogdanm 66:9c8f0e3462fb 136
bogdanm 66:9c8f0e3462fb 137 /** Clear the call chain (remove all functions in the chain).
bogdanm 66:9c8f0e3462fb 138 */
bogdanm 66:9c8f0e3462fb 139 void clear();
bogdanm 66:9c8f0e3462fb 140
bogdanm 66:9c8f0e3462fb 141 /** Remove a function object from the chain
bogdanm 66:9c8f0e3462fb 142 *
bogdanm 66:9c8f0e3462fb 143 * @arg f the function object to remove
bogdanm 66:9c8f0e3462fb 144 *
bogdanm 66:9c8f0e3462fb 145 * @returns
bogdanm 66:9c8f0e3462fb 146 * true if the function object was found and removed, false otherwise.
bogdanm 66:9c8f0e3462fb 147 */
bogdanm 66:9c8f0e3462fb 148 bool remove(pFunctionPointer_t f);
bogdanm 66:9c8f0e3462fb 149
bogdanm 66:9c8f0e3462fb 150 /** Call all the functions in the chain in sequence
bogdanm 66:9c8f0e3462fb 151 */
bogdanm 66:9c8f0e3462fb 152 void call();
bogdanm 66:9c8f0e3462fb 153
bogdanm 66:9c8f0e3462fb 154 #ifdef MBED_OPERATORS
bogdanm 66:9c8f0e3462fb 155 void operator ()(void) {
bogdanm 66:9c8f0e3462fb 156 call();
bogdanm 66:9c8f0e3462fb 157 }
bogdanm 66:9c8f0e3462fb 158 pFunctionPointer_t operator [](int i) const {
bogdanm 66:9c8f0e3462fb 159 return get(i);
bogdanm 66:9c8f0e3462fb 160 }
bogdanm 66:9c8f0e3462fb 161 #endif
bogdanm 66:9c8f0e3462fb 162
bogdanm 66:9c8f0e3462fb 163 private:
bogdanm 66:9c8f0e3462fb 164 void _check_size();
bogdanm 66:9c8f0e3462fb 165 pFunctionPointer_t common_add(pFunctionPointer_t pf);
bogdanm 66:9c8f0e3462fb 166 pFunctionPointer_t common_add_front(pFunctionPointer_t pf);
bogdanm 66:9c8f0e3462fb 167
bogdanm 66:9c8f0e3462fb 168 pFunctionPointer_t* _chain;
bogdanm 66:9c8f0e3462fb 169 int _size;
bogdanm 66:9c8f0e3462fb 170 int _elements;
bogdanm 66:9c8f0e3462fb 171 };
bogdanm 66:9c8f0e3462fb 172
bogdanm 66:9c8f0e3462fb 173 } // namespace mbed
bogdanm 66:9c8f0e3462fb 174
bogdanm 66:9c8f0e3462fb 175 #endif
bogdanm 66:9c8f0e3462fb 176