Amit Gandhi / mbed-dev

test

Fork of mbed-dev by mbed official

platform/CallChain.h@178:d650f5d4c87a, 2017-11-08 (annotated)

Committer:
AnnaBridge
Date:
Wed Nov 08 13:50:44 2017 +0000
Revision:
178:d650f5d4c87a
Parent:
169:9672193075cf 
This updates the lib to the mbed lib v 155

Who changed what in which revision?

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