PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

api/CallChain.h@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

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