Bob Seque / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

api/CallChain.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

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