雄介 太田 / mbed

mbed(SerialHalfDuplex入り)

Fork of mbed by mbed official

CallChain.h@65:5798e58a58b1, 2013-08-12 (annotated)

Committer:
bogdanm
Date:
Mon Aug 12 13:17:46 2013 +0300
Revision:
65:5798e58a58b1
Child:
66:9c8f0e3462fb
New target (LPC4088), new features (interrupt chaining), bug fixes (KL25Z I2C).

Who changed what in which revision?

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