Ermanno Brusadin / mbed

mbed library sources

Dependents:   FRDM-KL46Z_LCD_Test FRDM-KL46Z_LCD_Test FRDM-KL46Z_Plantilla FRDM-KL46Z_Plantilla ... more

api/CallChain.h@0:6bc4ac881c8e, 2016-07-28 (annotated)

Committer:
ebrus
Date:
Thu Jul 28 15:56:34 2016 +0000
Revision:
0:6bc4ac881c8e
1;

Who changed what in which revision?

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