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@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
170:e95d10626187
Child:
172:65be27845400
mbed library. Release version 164

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 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 165:d1b4690b3f8b 41 * @deprecated Do not use this class. This class is not part of the public API of mbed-os and is being removed in the future.
AnnaBridge 156:ff21514d8981 42 * @note Synchronization level: Not protected
AnnaBridge 156:ff21514d8981 43 *
AnnaBridge 156:ff21514d8981 44 * Example:
AnnaBridge 156:ff21514d8981 45 * @code
AnnaBridge 156:ff21514d8981 46 * #include "mbed.h"
AnnaBridge 156:ff21514d8981 47 *
AnnaBridge 156:ff21514d8981 48 * CallChain chain;
AnnaBridge 156:ff21514d8981 49 *
AnnaBridge 156:ff21514d8981 50 * void first(void) {
AnnaBridge 156:ff21514d8981 51 * printf("'first' function.\n");
AnnaBridge 156:ff21514d8981 52 * }
AnnaBridge 156:ff21514d8981 53 *
AnnaBridge 156:ff21514d8981 54 * void second(void) {
AnnaBridge 156:ff21514d8981 55 * printf("'second' function.\n");
AnnaBridge 156:ff21514d8981 56 * }
AnnaBridge 156:ff21514d8981 57 *
AnnaBridge 156:ff21514d8981 58 * class Test {
AnnaBridge 156:ff21514d8981 59 * public:
AnnaBridge 156:ff21514d8981 60 * void f(void) {
AnnaBridge 156:ff21514d8981 61 * printf("A::f (class member).\n");
AnnaBridge 156:ff21514d8981 62 * }
AnnaBridge 156:ff21514d8981 63 * };
AnnaBridge 156:ff21514d8981 64 *
AnnaBridge 156:ff21514d8981 65 * int main() {
AnnaBridge 156:ff21514d8981 66 * Test test;
AnnaBridge 156:ff21514d8981 67 *
AnnaBridge 156:ff21514d8981 68 * chain.add(second);
AnnaBridge 156:ff21514d8981 69 * chain.add_front(first);
AnnaBridge 156:ff21514d8981 70 * chain.add(&test, &Test::f);
AnnaBridge 156:ff21514d8981 71 * chain.call();
AnnaBridge 156:ff21514d8981 72 * }
AnnaBridge 156:ff21514d8981 73 * @endcode
AnnaBridge 156:ff21514d8981 74 */
AnnaBridge 156:ff21514d8981 75 class CallChain : private NonCopyable<CallChain> {
AnnaBridge 156:ff21514d8981 76 public:
AnnaBridge 156:ff21514d8981 77 /** Create an empty chain
AnnaBridge 170:e95d10626187 78 * @deprecated
AnnaBridge 165:d1b4690b3f8b 79 * Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
AnnaBridge 156:ff21514d8981 80 *
AnnaBridge 156:ff21514d8981 81 * @param size (optional) Initial size of the chain
AnnaBridge 156:ff21514d8981 82 */
Anna Bridge 160:5571c4ff569f 83 MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
AnnaBridge 170:e95d10626187 84 "public API of mbed-os and is being removed in the future.")
AnnaBridge 156:ff21514d8981 85 CallChain(int size = 4);
Anna Bridge 160:5571c4ff569f 86
AnnaBridge 165:d1b4690b3f8b 87 /** Create an empty chain
AnnaBridge 170:e95d10626187 88 * @deprecated
AnnaBridge 165:d1b4690b3f8b 89 * Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
AnnaBridge 165:d1b4690b3f8b 90 */
Anna Bridge 160:5571c4ff569f 91 MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
AnnaBridge 170:e95d10626187 92 "public API of mbed-os and is being removed in the future.")
AnnaBridge 156:ff21514d8981 93 virtual ~CallChain();
AnnaBridge 156:ff21514d8981 94
AnnaBridge 156:ff21514d8981 95 /** Add a function at the end of the chain
AnnaBridge 156:ff21514d8981 96 *
AnnaBridge 170:e95d10626187 97 * @deprecated
AnnaBridge 165:d1b4690b3f8b 98 * Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
AnnaBridge 165:d1b4690b3f8b 99 *
AnnaBridge 156:ff21514d8981 100 * @param func A pointer to a void function
AnnaBridge 156:ff21514d8981 101 *
AnnaBridge 156:ff21514d8981 102 * @returns
AnnaBridge 156:ff21514d8981 103 * The function object created for 'func'
AnnaBridge 156:ff21514d8981 104 */
Anna Bridge 160:5571c4ff569f 105 MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
AnnaBridge 170:e95d10626187 106 "public API of mbed-os and is being removed in the future.")
AnnaBridge 156:ff21514d8981 107 pFunctionPointer_t add(Callback<void()> func);
AnnaBridge 156:ff21514d8981 108
AnnaBridge 156:ff21514d8981 109 /** Add a function at the end of the chain
AnnaBridge 156:ff21514d8981 110 *
AnnaBridge 156:ff21514d8981 111 * @param obj pointer to the object to call the member function on
AnnaBridge 156:ff21514d8981 112 * @param method pointer to the member function to be called
AnnaBridge 156:ff21514d8981 113 *
AnnaBridge 156:ff21514d8981 114 * @returns
AnnaBridge 156:ff21514d8981 115 * The function object created for 'obj' and 'method'
AnnaBridge 156:ff21514d8981 116 *
AnnaBridge 156:ff21514d8981 117 * @deprecated
AnnaBridge 156:ff21514d8981 118 * The add function does not support cv-qualifiers. Replaced by
AnnaBridge 156:ff21514d8981 119 * add(callback(obj, method)).
AnnaBridge 156:ff21514d8981 120 */
AnnaBridge 156:ff21514d8981 121 template<typename T, typename M>
AnnaBridge 156:ff21514d8981 122 MBED_DEPRECATED_SINCE("mbed-os-5.1",
AnnaBridge 170:e95d10626187 123 "The add function does not support cv-qualifiers. Replaced by "
AnnaBridge 170:e95d10626187 124 "add(callback(obj, method)).")
AnnaBridge 170:e95d10626187 125 pFunctionPointer_t add(T *obj, M method)
AnnaBridge 170:e95d10626187 126 {
AnnaBridge 156:ff21514d8981 127 return add(callback(obj, method));
AnnaBridge 156:ff21514d8981 128 }
AnnaBridge 156:ff21514d8981 129
AnnaBridge 156:ff21514d8981 130 /** Add a function at the beginning of the chain
AnnaBridge 170:e95d10626187 131 * @deprecated
AnnaBridge 165:d1b4690b3f8b 132 * Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
AnnaBridge 165:d1b4690b3f8b 133 *
AnnaBridge 156:ff21514d8981 134 *
AnnaBridge 156:ff21514d8981 135 * @param func A pointer to a void function
AnnaBridge 156:ff21514d8981 136 *
AnnaBridge 156:ff21514d8981 137 * @returns
AnnaBridge 156:ff21514d8981 138 * The function object created for 'func'
AnnaBridge 156:ff21514d8981 139 */
Anna Bridge 160:5571c4ff569f 140 MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
AnnaBridge 170:e95d10626187 141 "public API of mbed-os and is being removed in the future.")
AnnaBridge 156:ff21514d8981 142 pFunctionPointer_t add_front(Callback<void()> func);
AnnaBridge 156:ff21514d8981 143
AnnaBridge 156:ff21514d8981 144 /** Add a function at the beginning of the chain
AnnaBridge 156:ff21514d8981 145 *
AnnaBridge 156:ff21514d8981 146 * @param obj pointer to the object to call the member function on
AnnaBridge 156:ff21514d8981 147 * @param method pointer to the member function to be called
AnnaBridge 156:ff21514d8981 148 *
AnnaBridge 156:ff21514d8981 149 * @returns
AnnaBridge 156:ff21514d8981 150 * The function object created for 'tptr' and 'mptr'
AnnaBridge 156:ff21514d8981 151 *
AnnaBridge 156:ff21514d8981 152 * @deprecated
AnnaBridge 156:ff21514d8981 153 * The add_front function does not support cv-qualifiers. Replaced by
AnnaBridge 156:ff21514d8981 154 * add_front(callback(obj, method)).
AnnaBridge 156:ff21514d8981 155 */
AnnaBridge 156:ff21514d8981 156 template<typename T, typename M>
AnnaBridge 156:ff21514d8981 157 MBED_DEPRECATED_SINCE("mbed-os-5.1",
AnnaBridge 170:e95d10626187 158 "The add_front function does not support cv-qualifiers. Replaced by "
AnnaBridge 170:e95d10626187 159 "add_front(callback(obj, method)).")
AnnaBridge 170:e95d10626187 160 pFunctionPointer_t add_front(T *obj, M method)
AnnaBridge 170:e95d10626187 161 {
AnnaBridge 156:ff21514d8981 162 return add_front(callback(obj, method));
AnnaBridge 156:ff21514d8981 163 }
AnnaBridge 156:ff21514d8981 164
AnnaBridge 156:ff21514d8981 165 /** Get the number of functions in the chain
AnnaBridge 170:e95d10626187 166 * @deprecated
AnnaBridge 165:d1b4690b3f8b 167 * Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
AnnaBridge 165:d1b4690b3f8b 168 *
AnnaBridge 156:ff21514d8981 169 */
Anna Bridge 160:5571c4ff569f 170 MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
AnnaBridge 170:e95d10626187 171 "public API of mbed-os and is being removed in the future.")
AnnaBridge 156:ff21514d8981 172 int size() const;
AnnaBridge 156:ff21514d8981 173
AnnaBridge 156:ff21514d8981 174 /** Get a function object from the chain
AnnaBridge 170:e95d10626187 175 * @deprecated
AnnaBridge 165:d1b4690b3f8b 176 * Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
AnnaBridge 156:ff21514d8981 177 *
AnnaBridge 156:ff21514d8981 178 * @param i function object index
AnnaBridge 156:ff21514d8981 179 *
AnnaBridge 156:ff21514d8981 180 * @returns
AnnaBridge 156:ff21514d8981 181 * The function object at position 'i' in the chain
AnnaBridge 156:ff21514d8981 182 */
Anna Bridge 160:5571c4ff569f 183 MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
AnnaBridge 170:e95d10626187 184 "public API of mbed-os and is being removed in the future.")
AnnaBridge 156:ff21514d8981 185 pFunctionPointer_t get(int i) const;
AnnaBridge 156:ff21514d8981 186
AnnaBridge 156:ff21514d8981 187 /** Look for a function object in the call chain
AnnaBridge 170:e95d10626187 188 * @deprecated
AnnaBridge 165:d1b4690b3f8b 189 * Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
AnnaBridge 156:ff21514d8981 190 *
AnnaBridge 156:ff21514d8981 191 * @param f the function object to search
AnnaBridge 156:ff21514d8981 192 *
AnnaBridge 156:ff21514d8981 193 * @returns
AnnaBridge 156:ff21514d8981 194 * The index of the function object if found, -1 otherwise.
AnnaBridge 156:ff21514d8981 195 */
Anna Bridge 160:5571c4ff569f 196 MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
AnnaBridge 170:e95d10626187 197 "public API of mbed-os and is being removed in the future.")
AnnaBridge 156:ff21514d8981 198 int find(pFunctionPointer_t f) const;
AnnaBridge 156:ff21514d8981 199
AnnaBridge 156:ff21514d8981 200 /** Clear the call chain (remove all functions in the chain).
AnnaBridge 165:d1b4690b3f8b 201 * @deprecated Do not use this function. This class is not part of the public API of mbed-os and is being removed in the future.
AnnaBridge 156:ff21514d8981 202 */
Anna Bridge 160:5571c4ff569f 203 MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
AnnaBridge 170:e95d10626187 204 "public API of mbed-os and is being removed in the future.")
AnnaBridge 156:ff21514d8981 205 void clear();
AnnaBridge 156:ff21514d8981 206
AnnaBridge 156:ff21514d8981 207 /** Remove a function object from the chain
AnnaBridge 170:e95d10626187 208 * @deprecated
AnnaBridge 165:d1b4690b3f8b 209 * Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
AnnaBridge 156:ff21514d8981 210 *
AnnaBridge 156:ff21514d8981 211 * @arg f the function object to remove
AnnaBridge 156:ff21514d8981 212 *
AnnaBridge 156:ff21514d8981 213 * @returns
AnnaBridge 156:ff21514d8981 214 * true if the function object was found and removed, false otherwise.
AnnaBridge 156:ff21514d8981 215 */
Anna Bridge 160:5571c4ff569f 216 MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
AnnaBridge 170:e95d10626187 217 "public API of mbed-os and is being removed in the future.")
AnnaBridge 156:ff21514d8981 218 bool remove(pFunctionPointer_t f);
AnnaBridge 156:ff21514d8981 219
AnnaBridge 156:ff21514d8981 220 /** Call all the functions in the chain in sequence
AnnaBridge 170:e95d10626187 221 * @deprecated
AnnaBridge 165:d1b4690b3f8b 222 * Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
AnnaBridge 165:d1b4690b3f8b 223 *
AnnaBridge 156:ff21514d8981 224 */
Anna Bridge 160:5571c4ff569f 225 MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
AnnaBridge 170:e95d10626187 226 "public API of mbed-os and is being removed in the future.")
AnnaBridge 156:ff21514d8981 227 void call();
AnnaBridge 156:ff21514d8981 228
AnnaBridge 170:e95d10626187 229 /**
AnnaBridge 170:e95d10626187 230 * @deprecated
AnnaBridge 165:d1b4690b3f8b 231 * Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
AnnaBridge 165:d1b4690b3f8b 232 *
AnnaBridge 165:d1b4690b3f8b 233 */
Anna Bridge 160:5571c4ff569f 234 MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
AnnaBridge 170:e95d10626187 235 "public API of mbed-os and is being removed in the future.")
AnnaBridge 170:e95d10626187 236 void operator()(void)
AnnaBridge 170:e95d10626187 237 {
AnnaBridge 156:ff21514d8981 238 call();
AnnaBridge 156:ff21514d8981 239 }
Anna Bridge 160:5571c4ff569f 240
AnnaBridge 170:e95d10626187 241 /**
AnnaBridge 170:e95d10626187 242 * @deprecated
AnnaBridge 165:d1b4690b3f8b 243 * Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
AnnaBridge 165:d1b4690b3f8b 244 *
AnnaBridge 165:d1b4690b3f8b 245 */
Anna Bridge 160:5571c4ff569f 246 MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
AnnaBridge 170:e95d10626187 247 "public API of mbed-os and is being removed in the future.")
AnnaBridge 170:e95d10626187 248 pFunctionPointer_t operator [](int i) const
AnnaBridge 170:e95d10626187 249 {
AnnaBridge 156:ff21514d8981 250 return get(i);
AnnaBridge 156:ff21514d8981 251 }
AnnaBridge 156:ff21514d8981 252
AnnaBridge 156:ff21514d8981 253 private:
AnnaBridge 156:ff21514d8981 254 CallChainLink *_chain;
AnnaBridge 156:ff21514d8981 255 };
AnnaBridge 156:ff21514d8981 256
AnnaBridge 158:1c57384330a6 257 /**@}*/
AnnaBridge 158:1c57384330a6 258
AnnaBridge 158:1c57384330a6 259 /**@}*/
AnnaBridge 158:1c57384330a6 260
AnnaBridge 156:ff21514d8981 261 } // namespace mbed
AnnaBridge 156:ff21514d8981 262
AnnaBridge 156:ff21514d8981 263 #endif
AnnaBridge 156:ff21514d8981 264