Alessandro Angelino / mbed-hal

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:   target-freescale

Fork of mbed-hal by Morpheus

api/CallChain.h@4:473d4af53300, 2016-04-04 (annotated)

Committer:
Alessandro Angelino
Date:
Mon Apr 04 14:24:07 2016 +0100
Revision:
4:473d4af53300
Parent:
0:9c59db1fbc9e 
Fix function to get sp when in unprivileged mode

Who changed what in which revision?

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