Jeremy Hammel / Mbed 2 deprecated ATT_Smart_Home

FRDM-K64F, Avnet M14A2A, Grove Shield, to create smart home system. In use with AT&Ts M2x & Flow.

Dependencies:   mbed FXOS8700CQ MODSERIAL

mbed/CallChain.h@84:fc8c9b39723a, 2019-03-06 (annotated)

Committer:
jwhammel
Date:
Wed Mar 06 21:11:49 2019 +0000
Revision:
84:fc8c9b39723a
Embedded Systems Midterm Project Spring 2019

Who changed what in which revision?

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