The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.
Dependents: hello SerialTestv11 SerialTestv12 Sierpinski ... more
mbed 2
This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.
platform/CallChain.h@158:1c57384330a6, 2017-11-23 (annotated)
- Committer:
- AnnaBridge
- Date:
- Thu Nov 23 11:44:04 2017 +0000
- Revision:
- 158:1c57384330a6
- Parent:
- 156:ff21514d8981
- Child:
- 160:5571c4ff569f
mbed library. Release version 156
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
AnnaBridge | 156:ff21514d8981 | 1 | /* mbed Microcontroller Library |
AnnaBridge | 156:ff21514d8981 | 2 | * Copyright (c) 2006-2013 ARM Limited |
AnnaBridge | 156:ff21514d8981 | 3 | * |
AnnaBridge | 156:ff21514d8981 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
AnnaBridge | 156:ff21514d8981 | 5 | * you may not use this file except in compliance with the License. |
AnnaBridge | 156:ff21514d8981 | 6 | * You may obtain a copy of the License at |
AnnaBridge | 156:ff21514d8981 | 7 | * |
AnnaBridge | 156:ff21514d8981 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
AnnaBridge | 156:ff21514d8981 | 9 | * |
AnnaBridge | 156:ff21514d8981 | 10 | * Unless required by applicable law or agreed to in writing, software |
AnnaBridge | 156:ff21514d8981 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
AnnaBridge | 156:ff21514d8981 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
AnnaBridge | 156:ff21514d8981 | 13 | * See the License for the specific language governing permissions and |
AnnaBridge | 156:ff21514d8981 | 14 | * limitations under the License. |
AnnaBridge | 156:ff21514d8981 | 15 | */ |
AnnaBridge | 156:ff21514d8981 | 16 | #ifndef MBED_CALLCHAIN_H |
AnnaBridge | 156:ff21514d8981 | 17 | #define MBED_CALLCHAIN_H |
AnnaBridge | 156:ff21514d8981 | 18 | |
AnnaBridge | 156:ff21514d8981 | 19 | #include "platform/Callback.h" |
AnnaBridge | 156:ff21514d8981 | 20 | #include "platform/mbed_toolchain.h" |
AnnaBridge | 156:ff21514d8981 | 21 | #include "platform/NonCopyable.h" |
AnnaBridge | 156:ff21514d8981 | 22 | #include <string.h> |
AnnaBridge | 156:ff21514d8981 | 23 | |
AnnaBridge | 156:ff21514d8981 | 24 | namespace mbed { |
AnnaBridge | 158:1c57384330a6 | 25 | |
AnnaBridge | 158:1c57384330a6 | 26 | |
AnnaBridge | 158:1c57384330a6 | 27 | typedef Callback<void()> *pFunctionPointer_t; |
AnnaBridge | 158:1c57384330a6 | 28 | class CallChainLink; |
AnnaBridge | 158:1c57384330a6 | 29 | |
AnnaBridge | 156:ff21514d8981 | 30 | /** \addtogroup platform */ |
AnnaBridge | 158:1c57384330a6 | 31 | /** @{*/ |
AnnaBridge | 158:1c57384330a6 | 32 | /** |
AnnaBridge | 158:1c57384330a6 | 33 | * \defgroup platform_CallChain CallChain class |
AnnaBridge | 158:1c57384330a6 | 34 | * @{ |
AnnaBridge | 158:1c57384330a6 | 35 | */ |
AnnaBridge | 156:ff21514d8981 | 36 | |
AnnaBridge | 156:ff21514d8981 | 37 | /** Group one or more functions in an instance of a CallChain, then call them in |
AnnaBridge | 156:ff21514d8981 | 38 | * sequence using CallChain::call(). Used mostly by the interrupt chaining code, |
AnnaBridge | 156:ff21514d8981 | 39 | * but can be used for other purposes. |
AnnaBridge | 156:ff21514d8981 | 40 | * |
AnnaBridge | 156:ff21514d8981 | 41 | * @note Synchronization level: Not protected |
AnnaBridge | 156:ff21514d8981 | 42 | * |
AnnaBridge | 156:ff21514d8981 | 43 | * Example: |
AnnaBridge | 156:ff21514d8981 | 44 | * @code |
AnnaBridge | 156:ff21514d8981 | 45 | * #include "mbed.h" |
AnnaBridge | 156:ff21514d8981 | 46 | * |
AnnaBridge | 156:ff21514d8981 | 47 | * CallChain chain; |
AnnaBridge | 156:ff21514d8981 | 48 | * |
AnnaBridge | 156:ff21514d8981 | 49 | * void first(void) { |
AnnaBridge | 156:ff21514d8981 | 50 | * printf("'first' function.\n"); |
AnnaBridge | 156:ff21514d8981 | 51 | * } |
AnnaBridge | 156:ff21514d8981 | 52 | * |
AnnaBridge | 156:ff21514d8981 | 53 | * void second(void) { |
AnnaBridge | 156:ff21514d8981 | 54 | * printf("'second' function.\n"); |
AnnaBridge | 156:ff21514d8981 | 55 | * } |
AnnaBridge | 156:ff21514d8981 | 56 | * |
AnnaBridge | 156:ff21514d8981 | 57 | * class Test { |
AnnaBridge | 156:ff21514d8981 | 58 | * public: |
AnnaBridge | 156:ff21514d8981 | 59 | * void f(void) { |
AnnaBridge | 156:ff21514d8981 | 60 | * printf("A::f (class member).\n"); |
AnnaBridge | 156:ff21514d8981 | 61 | * } |
AnnaBridge | 156:ff21514d8981 | 62 | * }; |
AnnaBridge | 156:ff21514d8981 | 63 | * |
AnnaBridge | 156:ff21514d8981 | 64 | * int main() { |
AnnaBridge | 156:ff21514d8981 | 65 | * Test test; |
AnnaBridge | 156:ff21514d8981 | 66 | * |
AnnaBridge | 156:ff21514d8981 | 67 | * chain.add(second); |
AnnaBridge | 156:ff21514d8981 | 68 | * chain.add_front(first); |
AnnaBridge | 156:ff21514d8981 | 69 | * chain.add(&test, &Test::f); |
AnnaBridge | 156:ff21514d8981 | 70 | * chain.call(); |
AnnaBridge | 156:ff21514d8981 | 71 | * } |
AnnaBridge | 156:ff21514d8981 | 72 | * @endcode |
AnnaBridge | 156:ff21514d8981 | 73 | */ |
AnnaBridge | 156:ff21514d8981 | 74 | class CallChain : private NonCopyable<CallChain> { |
AnnaBridge | 156:ff21514d8981 | 75 | public: |
AnnaBridge | 156:ff21514d8981 | 76 | /** Create an empty chain |
AnnaBridge | 156:ff21514d8981 | 77 | * |
AnnaBridge | 156:ff21514d8981 | 78 | * @param size (optional) Initial size of the chain |
AnnaBridge | 156:ff21514d8981 | 79 | */ |
AnnaBridge | 156:ff21514d8981 | 80 | CallChain(int size = 4); |
AnnaBridge | 156:ff21514d8981 | 81 | virtual ~CallChain(); |
AnnaBridge | 156:ff21514d8981 | 82 | |
AnnaBridge | 156:ff21514d8981 | 83 | /** Add a function at the end of the chain |
AnnaBridge | 156:ff21514d8981 | 84 | * |
AnnaBridge | 156:ff21514d8981 | 85 | * @param func A pointer to a void function |
AnnaBridge | 156:ff21514d8981 | 86 | * |
AnnaBridge | 156:ff21514d8981 | 87 | * @returns |
AnnaBridge | 156:ff21514d8981 | 88 | * The function object created for 'func' |
AnnaBridge | 156:ff21514d8981 | 89 | */ |
AnnaBridge | 156:ff21514d8981 | 90 | pFunctionPointer_t add(Callback<void()> func); |
AnnaBridge | 156:ff21514d8981 | 91 | |
AnnaBridge | 156:ff21514d8981 | 92 | /** Add a function at the end of the chain |
AnnaBridge | 156:ff21514d8981 | 93 | * |
AnnaBridge | 156:ff21514d8981 | 94 | * @param obj pointer to the object to call the member function on |
AnnaBridge | 156:ff21514d8981 | 95 | * @param method pointer to the member function to be called |
AnnaBridge | 156:ff21514d8981 | 96 | * |
AnnaBridge | 156:ff21514d8981 | 97 | * @returns |
AnnaBridge | 156:ff21514d8981 | 98 | * The function object created for 'obj' and 'method' |
AnnaBridge | 156:ff21514d8981 | 99 | * |
AnnaBridge | 156:ff21514d8981 | 100 | * @deprecated |
AnnaBridge | 156:ff21514d8981 | 101 | * The add function does not support cv-qualifiers. Replaced by |
AnnaBridge | 156:ff21514d8981 | 102 | * add(callback(obj, method)). |
AnnaBridge | 156:ff21514d8981 | 103 | */ |
AnnaBridge | 156:ff21514d8981 | 104 | template<typename T, typename M> |
AnnaBridge | 156:ff21514d8981 | 105 | MBED_DEPRECATED_SINCE("mbed-os-5.1", |
AnnaBridge | 156:ff21514d8981 | 106 | "The add function does not support cv-qualifiers. Replaced by " |
AnnaBridge | 156:ff21514d8981 | 107 | "add(callback(obj, method)).") |
AnnaBridge | 156:ff21514d8981 | 108 | pFunctionPointer_t add(T *obj, M method) { |
AnnaBridge | 156:ff21514d8981 | 109 | return add(callback(obj, method)); |
AnnaBridge | 156:ff21514d8981 | 110 | } |
AnnaBridge | 156:ff21514d8981 | 111 | |
AnnaBridge | 156:ff21514d8981 | 112 | /** Add a function at the beginning of the chain |
AnnaBridge | 156:ff21514d8981 | 113 | * |
AnnaBridge | 156:ff21514d8981 | 114 | * @param func A pointer to a void function |
AnnaBridge | 156:ff21514d8981 | 115 | * |
AnnaBridge | 156:ff21514d8981 | 116 | * @returns |
AnnaBridge | 156:ff21514d8981 | 117 | * The function object created for 'func' |
AnnaBridge | 156:ff21514d8981 | 118 | */ |
AnnaBridge | 156:ff21514d8981 | 119 | pFunctionPointer_t add_front(Callback<void()> func); |
AnnaBridge | 156:ff21514d8981 | 120 | |
AnnaBridge | 156:ff21514d8981 | 121 | /** Add a function at the beginning of the chain |
AnnaBridge | 156:ff21514d8981 | 122 | * |
AnnaBridge | 156:ff21514d8981 | 123 | * @param obj pointer to the object to call the member function on |
AnnaBridge | 156:ff21514d8981 | 124 | * @param method pointer to the member function to be called |
AnnaBridge | 156:ff21514d8981 | 125 | * |
AnnaBridge | 156:ff21514d8981 | 126 | * @returns |
AnnaBridge | 156:ff21514d8981 | 127 | * The function object created for 'tptr' and 'mptr' |
AnnaBridge | 156:ff21514d8981 | 128 | * |
AnnaBridge | 156:ff21514d8981 | 129 | * @deprecated |
AnnaBridge | 156:ff21514d8981 | 130 | * The add_front function does not support cv-qualifiers. Replaced by |
AnnaBridge | 156:ff21514d8981 | 131 | * add_front(callback(obj, method)). |
AnnaBridge | 156:ff21514d8981 | 132 | */ |
AnnaBridge | 156:ff21514d8981 | 133 | template<typename T, typename M> |
AnnaBridge | 156:ff21514d8981 | 134 | MBED_DEPRECATED_SINCE("mbed-os-5.1", |
AnnaBridge | 156:ff21514d8981 | 135 | "The add_front function does not support cv-qualifiers. Replaced by " |
AnnaBridge | 156:ff21514d8981 | 136 | "add_front(callback(obj, method)).") |
AnnaBridge | 156:ff21514d8981 | 137 | pFunctionPointer_t add_front(T *obj, M method) { |
AnnaBridge | 156:ff21514d8981 | 138 | return add_front(callback(obj, method)); |
AnnaBridge | 156:ff21514d8981 | 139 | } |
AnnaBridge | 156:ff21514d8981 | 140 | |
AnnaBridge | 156:ff21514d8981 | 141 | /** Get the number of functions in the chain |
AnnaBridge | 156:ff21514d8981 | 142 | */ |
AnnaBridge | 156:ff21514d8981 | 143 | int size() const; |
AnnaBridge | 156:ff21514d8981 | 144 | |
AnnaBridge | 156:ff21514d8981 | 145 | /** Get a function object from the chain |
AnnaBridge | 156:ff21514d8981 | 146 | * |
AnnaBridge | 156:ff21514d8981 | 147 | * @param i function object index |
AnnaBridge | 156:ff21514d8981 | 148 | * |
AnnaBridge | 156:ff21514d8981 | 149 | * @returns |
AnnaBridge | 156:ff21514d8981 | 150 | * The function object at position 'i' in the chain |
AnnaBridge | 156:ff21514d8981 | 151 | */ |
AnnaBridge | 156:ff21514d8981 | 152 | pFunctionPointer_t get(int i) const; |
AnnaBridge | 156:ff21514d8981 | 153 | |
AnnaBridge | 156:ff21514d8981 | 154 | /** Look for a function object in the call chain |
AnnaBridge | 156:ff21514d8981 | 155 | * |
AnnaBridge | 156:ff21514d8981 | 156 | * @param f the function object to search |
AnnaBridge | 156:ff21514d8981 | 157 | * |
AnnaBridge | 156:ff21514d8981 | 158 | * @returns |
AnnaBridge | 156:ff21514d8981 | 159 | * The index of the function object if found, -1 otherwise. |
AnnaBridge | 156:ff21514d8981 | 160 | */ |
AnnaBridge | 156:ff21514d8981 | 161 | int find(pFunctionPointer_t f) const; |
AnnaBridge | 156:ff21514d8981 | 162 | |
AnnaBridge | 156:ff21514d8981 | 163 | /** Clear the call chain (remove all functions in the chain). |
AnnaBridge | 156:ff21514d8981 | 164 | */ |
AnnaBridge | 156:ff21514d8981 | 165 | void clear(); |
AnnaBridge | 156:ff21514d8981 | 166 | |
AnnaBridge | 156:ff21514d8981 | 167 | /** Remove a function object from the chain |
AnnaBridge | 156:ff21514d8981 | 168 | * |
AnnaBridge | 156:ff21514d8981 | 169 | * @arg f the function object to remove |
AnnaBridge | 156:ff21514d8981 | 170 | * |
AnnaBridge | 156:ff21514d8981 | 171 | * @returns |
AnnaBridge | 156:ff21514d8981 | 172 | * true if the function object was found and removed, false otherwise. |
AnnaBridge | 156:ff21514d8981 | 173 | */ |
AnnaBridge | 156:ff21514d8981 | 174 | bool remove(pFunctionPointer_t f); |
AnnaBridge | 156:ff21514d8981 | 175 | |
AnnaBridge | 156:ff21514d8981 | 176 | /** Call all the functions in the chain in sequence |
AnnaBridge | 156:ff21514d8981 | 177 | */ |
AnnaBridge | 156:ff21514d8981 | 178 | void call(); |
AnnaBridge | 156:ff21514d8981 | 179 | |
AnnaBridge | 156:ff21514d8981 | 180 | void operator ()(void) { |
AnnaBridge | 156:ff21514d8981 | 181 | call(); |
AnnaBridge | 156:ff21514d8981 | 182 | } |
AnnaBridge | 156:ff21514d8981 | 183 | pFunctionPointer_t operator [](int i) const { |
AnnaBridge | 156:ff21514d8981 | 184 | return get(i); |
AnnaBridge | 156:ff21514d8981 | 185 | } |
AnnaBridge | 156:ff21514d8981 | 186 | |
AnnaBridge | 156:ff21514d8981 | 187 | private: |
AnnaBridge | 156:ff21514d8981 | 188 | CallChainLink *_chain; |
AnnaBridge | 156:ff21514d8981 | 189 | }; |
AnnaBridge | 156:ff21514d8981 | 190 | |
AnnaBridge | 158:1c57384330a6 | 191 | /**@}*/ |
AnnaBridge | 158:1c57384330a6 | 192 | |
AnnaBridge | 158:1c57384330a6 | 193 | /**@}*/ |
AnnaBridge | 158:1c57384330a6 | 194 | |
AnnaBridge | 156:ff21514d8981 | 195 | } // namespace mbed |
AnnaBridge | 156:ff21514d8981 | 196 | |
AnnaBridge | 156:ff21514d8981 | 197 | #endif |
AnnaBridge | 156:ff21514d8981 | 198 |