dev01 Brautlecht / mbed-STM32F030F4

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.

Dependents:   STM32F031_Blink_Aug17

Fork of mbed-STM32F030F4 by Nothing Special

api/CallChain.h@0:38ccae254a29, 2014-10-18 (annotated)

Committer:
mega64
Date:
Sat Oct 18 02:40:17 2014 +0000
Revision:
0:38ccae254a29
only for STM32F030F4

Who changed what in which revision?

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