Руслан Бредун / Mbed 2 deprecated STM32-MC_node

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed Watchdog stm32-sensor-base2

mbed/platform/CallChain.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

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