Jhon Plantikow / I2C_EEPROM

I2C_EEPROM

CallChain.h@0:ac8863619623, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:23:16 2015 +0000
Revision:
0:ac8863619623
I2C

Who changed what in which revision?

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