Yihui Xiong / mbed-src-nrf51822

customized mbed library sources for nrf51822

Dependents:   Grove_Node Potentiometer BLE_Beacon I2C_Scanner

api/CallChain.h@0:700cadd8b708, 2014-11-04 (annotated)

Committer:
yihui
Date:
Tue Nov 04 07:38:53 2014 +0000
Revision:
0:700cadd8b708
customized mbed-src library for nrf51822

Who changed what in which revision?

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