Gan likun / mbed-dev

00

platform/CallChain.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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