Jhon Plantikow / Dataloger

Dataloger

CallChain.h@0:666850d06c9f, 2015-08-20 (annotated)

Committer:
jhon309
Date:
Thu Aug 20 00:37:14 2015 +0000
Revision:
0:666850d06c9f
ok

Who changed what in which revision?

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