Jhon Plantikow / mbed

.

Dependents:   RTC

CallChain.h@0:88e313c910d0, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:20:09 2015 +0000
Revision:
0:88e313c910d0
RTC Example

Who changed what in which revision?

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