Aravind Vadali / mbed-src-AV

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:   micromouse4_encoder_testing PID_Test Lab1_Test WorkingPID ... more

api/CallChain.h@1:ebce2ad32f95, 2015-11-02 (annotated)

Committer:
aravindsv
Date:
Mon Nov 02 03:07:12 2015 +0000
Revision:
1:ebce2ad32f95
Parent:
0:ba7650f404af 
Changed the RCC timeout value to 500 ms, so total code startup time before program starts running is ~1s. Hopefully no side-effects from lower startup timeouts

Who changed what in which revision?

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