Jhon Plantikow / DHT11

DHT11

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

Committer:
jhon309
Date:
Thu Aug 13 00:21:57 2015 +0000
Revision:
0:c52df770855b
DHT11

Who changed what in which revision?

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