Vladimir Vana / mbed

pro vyuku PSS v Jecne

CallChain.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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