mbed official / mbed

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@157:e7ca05fa8600, 2017-11-09 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 09 11:14:10 2017 +0000
Revision:
157:e7ca05fa8600
Parent:
156:ff21514d8981
Child:
158:1c57384330a6
Release 155 of the mbed library.

Who changed what in which revision?

UserRevisionLine numberNew 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 156:ff21514d8981 25 /** \addtogroup platform */
AnnaBridge 156:ff21514d8981 26
AnnaBridge 156:ff21514d8981 27 /** Group one or more functions in an instance of a CallChain, then call them in
AnnaBridge 156:ff21514d8981 28 * sequence using CallChain::call(). Used mostly by the interrupt chaining code,
AnnaBridge 156:ff21514d8981 29 * but can be used for other purposes.
AnnaBridge 156:ff21514d8981 30 *
AnnaBridge 156:ff21514d8981 31 * @note Synchronization level: Not protected
AnnaBridge 156:ff21514d8981 32 *
AnnaBridge 156:ff21514d8981 33 * Example:
AnnaBridge 156:ff21514d8981 34 * @code
AnnaBridge 156:ff21514d8981 35 * #include "mbed.h"
AnnaBridge 156:ff21514d8981 36 *
AnnaBridge 156:ff21514d8981 37 * CallChain chain;
AnnaBridge 156:ff21514d8981 38 *
AnnaBridge 156:ff21514d8981 39 * void first(void) {
AnnaBridge 156:ff21514d8981 40 * printf("'first' function.\n");
AnnaBridge 156:ff21514d8981 41 * }
AnnaBridge 156:ff21514d8981 42 *
AnnaBridge 156:ff21514d8981 43 * void second(void) {
AnnaBridge 156:ff21514d8981 44 * printf("'second' function.\n");
AnnaBridge 156:ff21514d8981 45 * }
AnnaBridge 156:ff21514d8981 46 *
AnnaBridge 156:ff21514d8981 47 * class Test {
AnnaBridge 156:ff21514d8981 48 * public:
AnnaBridge 156:ff21514d8981 49 * void f(void) {
AnnaBridge 156:ff21514d8981 50 * printf("A::f (class member).\n");
AnnaBridge 156:ff21514d8981 51 * }
AnnaBridge 156:ff21514d8981 52 * };
AnnaBridge 156:ff21514d8981 53 *
AnnaBridge 156:ff21514d8981 54 * int main() {
AnnaBridge 156:ff21514d8981 55 * Test test;
AnnaBridge 156:ff21514d8981 56 *
AnnaBridge 156:ff21514d8981 57 * chain.add(second);
AnnaBridge 156:ff21514d8981 58 * chain.add_front(first);
AnnaBridge 156:ff21514d8981 59 * chain.add(&test, &Test::f);
AnnaBridge 156:ff21514d8981 60 * chain.call();
AnnaBridge 156:ff21514d8981 61 * }
AnnaBridge 156:ff21514d8981 62 * @endcode
AnnaBridge 156:ff21514d8981 63 * @ingroup platform
AnnaBridge 156:ff21514d8981 64 */
AnnaBridge 156:ff21514d8981 65
AnnaBridge 156:ff21514d8981 66 typedef Callback<void()> *pFunctionPointer_t;
AnnaBridge 156:ff21514d8981 67 class CallChainLink;
AnnaBridge 156:ff21514d8981 68
AnnaBridge 156:ff21514d8981 69 class CallChain : private NonCopyable<CallChain> {
AnnaBridge 156:ff21514d8981 70 public:
AnnaBridge 156:ff21514d8981 71 /** Create an empty chain
AnnaBridge 156:ff21514d8981 72 *
AnnaBridge 156:ff21514d8981 73 * @param size (optional) Initial size of the chain
AnnaBridge 156:ff21514d8981 74 */
AnnaBridge 156:ff21514d8981 75 CallChain(int size = 4);
AnnaBridge 156:ff21514d8981 76 virtual ~CallChain();
AnnaBridge 156:ff21514d8981 77
AnnaBridge 156:ff21514d8981 78 /** Add a function at the end of the chain
AnnaBridge 156:ff21514d8981 79 *
AnnaBridge 156:ff21514d8981 80 * @param func A pointer to a void function
AnnaBridge 156:ff21514d8981 81 *
AnnaBridge 156:ff21514d8981 82 * @returns
AnnaBridge 156:ff21514d8981 83 * The function object created for 'func'
AnnaBridge 156:ff21514d8981 84 */
AnnaBridge 156:ff21514d8981 85 pFunctionPointer_t add(Callback<void()> func);
AnnaBridge 156:ff21514d8981 86
AnnaBridge 156:ff21514d8981 87 /** Add a function at the end of the chain
AnnaBridge 156:ff21514d8981 88 *
AnnaBridge 156:ff21514d8981 89 * @param obj pointer to the object to call the member function on
AnnaBridge 156:ff21514d8981 90 * @param method pointer to the member function to be called
AnnaBridge 156:ff21514d8981 91 *
AnnaBridge 156:ff21514d8981 92 * @returns
AnnaBridge 156:ff21514d8981 93 * The function object created for 'obj' and 'method'
AnnaBridge 156:ff21514d8981 94 *
AnnaBridge 156:ff21514d8981 95 * @deprecated
AnnaBridge 156:ff21514d8981 96 * The add function does not support cv-qualifiers. Replaced by
AnnaBridge 156:ff21514d8981 97 * add(callback(obj, method)).
AnnaBridge 156:ff21514d8981 98 */
AnnaBridge 156:ff21514d8981 99 template<typename T, typename M>
AnnaBridge 156:ff21514d8981 100 MBED_DEPRECATED_SINCE("mbed-os-5.1",
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 pFunctionPointer_t add(T *obj, M method) {
AnnaBridge 156:ff21514d8981 104 return add(callback(obj, method));
AnnaBridge 156:ff21514d8981 105 }
AnnaBridge 156:ff21514d8981 106
AnnaBridge 156:ff21514d8981 107 /** Add a function at the beginning of the chain
AnnaBridge 156:ff21514d8981 108 *
AnnaBridge 156:ff21514d8981 109 * @param func A pointer to a void function
AnnaBridge 156:ff21514d8981 110 *
AnnaBridge 156:ff21514d8981 111 * @returns
AnnaBridge 156:ff21514d8981 112 * The function object created for 'func'
AnnaBridge 156:ff21514d8981 113 */
AnnaBridge 156:ff21514d8981 114 pFunctionPointer_t add_front(Callback<void()> func);
AnnaBridge 156:ff21514d8981 115
AnnaBridge 156:ff21514d8981 116 /** Add a function at the beginning of the chain
AnnaBridge 156:ff21514d8981 117 *
AnnaBridge 156:ff21514d8981 118 * @param obj pointer to the object to call the member function on
AnnaBridge 156:ff21514d8981 119 * @param method pointer to the member function to be called
AnnaBridge 156:ff21514d8981 120 *
AnnaBridge 156:ff21514d8981 121 * @returns
AnnaBridge 156:ff21514d8981 122 * The function object created for 'tptr' and 'mptr'
AnnaBridge 156:ff21514d8981 123 *
AnnaBridge 156:ff21514d8981 124 * @deprecated
AnnaBridge 156:ff21514d8981 125 * The add_front function does not support cv-qualifiers. Replaced by
AnnaBridge 156:ff21514d8981 126 * add_front(callback(obj, method)).
AnnaBridge 156:ff21514d8981 127 */
AnnaBridge 156:ff21514d8981 128 template<typename T, typename M>
AnnaBridge 156:ff21514d8981 129 MBED_DEPRECATED_SINCE("mbed-os-5.1",
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 pFunctionPointer_t add_front(T *obj, M method) {
AnnaBridge 156:ff21514d8981 133 return add_front(callback(obj, method));
AnnaBridge 156:ff21514d8981 134 }
AnnaBridge 156:ff21514d8981 135
AnnaBridge 156:ff21514d8981 136 /** Get the number of functions in the chain
AnnaBridge 156:ff21514d8981 137 */
AnnaBridge 156:ff21514d8981 138 int size() const;
AnnaBridge 156:ff21514d8981 139
AnnaBridge 156:ff21514d8981 140 /** Get a function object from the chain
AnnaBridge 156:ff21514d8981 141 *
AnnaBridge 156:ff21514d8981 142 * @param i function object index
AnnaBridge 156:ff21514d8981 143 *
AnnaBridge 156:ff21514d8981 144 * @returns
AnnaBridge 156:ff21514d8981 145 * The function object at position 'i' in the chain
AnnaBridge 156:ff21514d8981 146 */
AnnaBridge 156:ff21514d8981 147 pFunctionPointer_t get(int i) const;
AnnaBridge 156:ff21514d8981 148
AnnaBridge 156:ff21514d8981 149 /** Look for a function object in the call chain
AnnaBridge 156:ff21514d8981 150 *
AnnaBridge 156:ff21514d8981 151 * @param f the function object to search
AnnaBridge 156:ff21514d8981 152 *
AnnaBridge 156:ff21514d8981 153 * @returns
AnnaBridge 156:ff21514d8981 154 * The index of the function object if found, -1 otherwise.
AnnaBridge 156:ff21514d8981 155 */
AnnaBridge 156:ff21514d8981 156 int find(pFunctionPointer_t f) const;
AnnaBridge 156:ff21514d8981 157
AnnaBridge 156:ff21514d8981 158 /** Clear the call chain (remove all functions in the chain).
AnnaBridge 156:ff21514d8981 159 */
AnnaBridge 156:ff21514d8981 160 void clear();
AnnaBridge 156:ff21514d8981 161
AnnaBridge 156:ff21514d8981 162 /** Remove a function object from the chain
AnnaBridge 156:ff21514d8981 163 *
AnnaBridge 156:ff21514d8981 164 * @arg f the function object to remove
AnnaBridge 156:ff21514d8981 165 *
AnnaBridge 156:ff21514d8981 166 * @returns
AnnaBridge 156:ff21514d8981 167 * true if the function object was found and removed, false otherwise.
AnnaBridge 156:ff21514d8981 168 */
AnnaBridge 156:ff21514d8981 169 bool remove(pFunctionPointer_t f);
AnnaBridge 156:ff21514d8981 170
AnnaBridge 156:ff21514d8981 171 /** Call all the functions in the chain in sequence
AnnaBridge 156:ff21514d8981 172 */
AnnaBridge 156:ff21514d8981 173 void call();
AnnaBridge 156:ff21514d8981 174
AnnaBridge 156:ff21514d8981 175 void operator ()(void) {
AnnaBridge 156:ff21514d8981 176 call();
AnnaBridge 156:ff21514d8981 177 }
AnnaBridge 156:ff21514d8981 178 pFunctionPointer_t operator [](int i) const {
AnnaBridge 156:ff21514d8981 179 return get(i);
AnnaBridge 156:ff21514d8981 180 }
AnnaBridge 156:ff21514d8981 181
AnnaBridge 156:ff21514d8981 182 private:
AnnaBridge 156:ff21514d8981 183 CallChainLink *_chain;
AnnaBridge 156:ff21514d8981 184 };
AnnaBridge 156:ff21514d8981 185
AnnaBridge 156:ff21514d8981 186 } // namespace mbed
AnnaBridge 156:ff21514d8981 187
AnnaBridge 156:ff21514d8981 188 #endif
AnnaBridge 156:ff21514d8981 189