Varun Bahl / BahlDecrypModified

Updated

Fork of BLE_API by Bluetooth Low Energy

public/CallChainOfFunctionPointersWithContext.h@144:c025c8839682, 2014-11-21 (annotated)

Committer:
rgrover1
Date:
Fri Nov 21 09:23:24 2014 +0000
Revision:
144:c025c8839682
Parent:
140:407d134c179d
Child:
145:a7ded9ad83c8
Synchronized with git rev 3d8441e2

Author: Rohit Grover

minor cleanup of public API classes.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Rohit Grover 118:620d28e7a1ba 1 /* mbed Microcontroller Library
Rohit Grover 118:620d28e7a1ba 2 * Copyright (c) 2006-2013 ARM Limited
Rohit Grover 118:620d28e7a1ba 3 *
Rohit Grover 118:620d28e7a1ba 4 * Licensed under the Apache License, Version 2.0 (the "License");
Rohit Grover 118:620d28e7a1ba 5 * you may not use this file except in compliance with the License.
Rohit Grover 118:620d28e7a1ba 6 * You may obtain a copy of the License at
Rohit Grover 118:620d28e7a1ba 7 *
Rohit Grover 118:620d28e7a1ba 8 * http://www.apache.org/licenses/LICENSE-2.0
Rohit Grover 118:620d28e7a1ba 9 *
Rohit Grover 118:620d28e7a1ba 10 * Unless required by applicable law or agreed to in writing, software
Rohit Grover 118:620d28e7a1ba 11 * distributed under the License is distributed on an "AS IS" BASIS,
Rohit Grover 118:620d28e7a1ba 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Rohit Grover 118:620d28e7a1ba 13 * See the License for the specific language governing permissions and
Rohit Grover 118:620d28e7a1ba 14 * limitations under the License.
Rohit Grover 118:620d28e7a1ba 15 */
Rohit Grover 118:620d28e7a1ba 16 #ifndef MBED_CALLCHAIN_OF_FUNCTION_POINTERS_WITH_CONTEXT_H
Rohit Grover 118:620d28e7a1ba 17 #define MBED_CALLCHAIN_OF_FUNCTION_POINTERS_WITH_CONTEXT_H
Rohit Grover 118:620d28e7a1ba 18
Rohit Grover 118:620d28e7a1ba 19 #include <string.h>
Rohit Grover 118:620d28e7a1ba 20 #include "FunctionPointerWithContext.h"
Rohit Grover 118:620d28e7a1ba 21
rgrover1 140:407d134c179d 22 namespace mbed {
Rohit Grover 118:620d28e7a1ba 23
Rohit Grover 118:620d28e7a1ba 24 /** Group one or more functions in an instance of a CallChainOfFunctionPointersWithContext, then call them in
Rohit Grover 118:620d28e7a1ba 25 * sequence using CallChainOfFunctionPointersWithContext::call(). Used mostly by the interrupt chaining code,
Rohit Grover 118:620d28e7a1ba 26 * but can be used for other purposes.
Rohit Grover 118:620d28e7a1ba 27 *
Rohit Grover 118:620d28e7a1ba 28 * Example:
Rohit Grover 118:620d28e7a1ba 29 * @code
rgrover1 140:407d134c179d 30 * #include "mbed.h"
Rohit Grover 118:620d28e7a1ba 31 *
Rohit Grover 118:620d28e7a1ba 32 * CallChainOfFunctionPointersWithContext<void *> chain;
Rohit Grover 118:620d28e7a1ba 33 *
Rohit Grover 118:620d28e7a1ba 34 * void first(void *context) {
Rohit Grover 118:620d28e7a1ba 35 * printf("'first' function.\n");
Rohit Grover 118:620d28e7a1ba 36 * }
Rohit Grover 118:620d28e7a1ba 37 *
Rohit Grover 118:620d28e7a1ba 38 * void second(void *context) {
Rohit Grover 118:620d28e7a1ba 39 * printf("'second' function.\n");
Rohit Grover 118:620d28e7a1ba 40 * }
Rohit Grover 118:620d28e7a1ba 41 *
Rohit Grover 118:620d28e7a1ba 42 * class Test {
Rohit Grover 118:620d28e7a1ba 43 * public:
Rohit Grover 118:620d28e7a1ba 44 * void f(void *context) {
Rohit Grover 118:620d28e7a1ba 45 * printf("A::f (class member).\n");
Rohit Grover 118:620d28e7a1ba 46 * }
Rohit Grover 118:620d28e7a1ba 47 * };
Rohit Grover 118:620d28e7a1ba 48 *
Rohit Grover 118:620d28e7a1ba 49 * int main() {
Rohit Grover 118:620d28e7a1ba 50 * Test test;
Rohit Grover 118:620d28e7a1ba 51 *
Rohit Grover 118:620d28e7a1ba 52 * chain.add(second);
Rohit Grover 118:620d28e7a1ba 53 * chain.add_front(first);
Rohit Grover 118:620d28e7a1ba 54 * chain.add(&test, &Test::f);
Rohit Grover 118:620d28e7a1ba 55 * chain.call();
Rohit Grover 118:620d28e7a1ba 56 * }
Rohit Grover 118:620d28e7a1ba 57 * @endcode
Rohit Grover 118:620d28e7a1ba 58 */
Rohit Grover 118:620d28e7a1ba 59
Rohit Grover 118:620d28e7a1ba 60 template <typename ContextType>
Rohit Grover 118:620d28e7a1ba 61 class CallChainOfFunctionPointersWithContext {
Rohit Grover 118:620d28e7a1ba 62 public:
rgrover1 144:c025c8839682 63 typedef FunctionPointerWithContext<ContextType> *pFunctionPointerWithContext_t;
Rohit Grover 118:620d28e7a1ba 64
Rohit Grover 118:620d28e7a1ba 65 public:
Rohit Grover 118:620d28e7a1ba 66 /** Create an empty chain
Rohit Grover 118:620d28e7a1ba 67 *
Rohit Grover 118:620d28e7a1ba 68 * @param size (optional) Initial size of the chain
Rohit Grover 118:620d28e7a1ba 69 */
Rohit Grover 118:620d28e7a1ba 70 CallChainOfFunctionPointersWithContext() : chainHead(NULL) {
Rohit Grover 118:620d28e7a1ba 71 /* empty */
Rohit Grover 118:620d28e7a1ba 72 }
Rohit Grover 118:620d28e7a1ba 73
Rohit Grover 118:620d28e7a1ba 74 virtual ~CallChainOfFunctionPointersWithContext() {
Rohit Grover 118:620d28e7a1ba 75 clear();
Rohit Grover 118:620d28e7a1ba 76 }
Rohit Grover 118:620d28e7a1ba 77
Rohit Grover 118:620d28e7a1ba 78 /** Add a function at the front of the chain
Rohit Grover 118:620d28e7a1ba 79 *
Rohit Grover 118:620d28e7a1ba 80 * @param function A pointer to a void function
Rohit Grover 118:620d28e7a1ba 81 *
Rohit Grover 118:620d28e7a1ba 82 * @returns
Rohit Grover 118:620d28e7a1ba 83 * The function object created for 'function'
Rohit Grover 118:620d28e7a1ba 84 */
Rohit Grover 118:620d28e7a1ba 85 pFunctionPointerWithContext_t add(void (*function)(ContextType context)) {
Rohit Grover 118:620d28e7a1ba 86 return common_add(new FunctionPointerWithContext<ContextType>(function));
Rohit Grover 118:620d28e7a1ba 87 }
Rohit Grover 118:620d28e7a1ba 88
Rohit Grover 118:620d28e7a1ba 89 /** Add a function at the front of the chain
Rohit Grover 118:620d28e7a1ba 90 *
Rohit Grover 118:620d28e7a1ba 91 * @param tptr pointer to the object to call the member function on
Rohit Grover 118:620d28e7a1ba 92 * @param mptr pointer to the member function to be called
Rohit Grover 118:620d28e7a1ba 93 *
Rohit Grover 118:620d28e7a1ba 94 * @returns
Rohit Grover 118:620d28e7a1ba 95 * The function object created for 'tptr' and 'mptr'
Rohit Grover 118:620d28e7a1ba 96 */
Rohit Grover 118:620d28e7a1ba 97 template<typename T>
Rohit Grover 118:620d28e7a1ba 98 pFunctionPointerWithContext_t add(T *tptr, void (T::*mptr)(ContextType context)) {
Rohit Grover 118:620d28e7a1ba 99 return common_add(new FunctionPointerWithContext<ContextType>(tptr, mptr));
Rohit Grover 118:620d28e7a1ba 100 }
Rohit Grover 118:620d28e7a1ba 101
Rohit Grover 118:620d28e7a1ba 102 /** Clear the call chain (remove all functions in the chain).
Rohit Grover 118:620d28e7a1ba 103 */
Rohit Grover 118:620d28e7a1ba 104 void clear(void) {
Rohit Grover 118:620d28e7a1ba 105 pFunctionPointerWithContext_t fptr = chainHead;
Rohit Grover 118:620d28e7a1ba 106 while (fptr) {
Rohit Grover 118:620d28e7a1ba 107 pFunctionPointerWithContext_t deadPtr = fptr;
Rohit Grover 118:620d28e7a1ba 108 fptr = deadPtr->getNext();
Rohit Grover 118:620d28e7a1ba 109 delete deadPtr;
Rohit Grover 118:620d28e7a1ba 110 }
Rohit Grover 118:620d28e7a1ba 111
Rohit Grover 118:620d28e7a1ba 112 chainHead = NULL;
Rohit Grover 118:620d28e7a1ba 113 }
Rohit Grover 118:620d28e7a1ba 114
Rohit Grover 118:620d28e7a1ba 115 bool hasCallbacksAttached(void) const {
Rohit Grover 118:620d28e7a1ba 116 return (chainHead != NULL);
Rohit Grover 118:620d28e7a1ba 117 }
Rohit Grover 118:620d28e7a1ba 118
Rohit Grover 118:620d28e7a1ba 119 /** Call all the functions in the chain in sequence
Rohit Grover 118:620d28e7a1ba 120 * @Note: the stack frames of all the callbacks within the chained
Rohit Grover 118:620d28e7a1ba 121 * FunctionPointers will stack up. Hopefully there won't be too many
Rohit Grover 118:620d28e7a1ba 122 * chained FunctionPointers.
Rohit Grover 118:620d28e7a1ba 123 */
Rohit Grover 118:620d28e7a1ba 124 void call(ContextType context) {
rgrover1 144:c025c8839682 125 if (chainHead) {
Rohit Grover 118:620d28e7a1ba 126 chainHead->call(context);
rgrover1 144:c025c8839682 127 }
Rohit Grover 118:620d28e7a1ba 128 }
Rohit Grover 118:620d28e7a1ba 129
Rohit Grover 118:620d28e7a1ba 130 private:
Rohit Grover 118:620d28e7a1ba 131 pFunctionPointerWithContext_t common_add(pFunctionPointerWithContext_t pf) {
Rohit Grover 118:620d28e7a1ba 132 if (chainHead == NULL) {
Rohit Grover 118:620d28e7a1ba 133 chainHead = pf;
Rohit Grover 118:620d28e7a1ba 134 } else {
Rohit Grover 118:620d28e7a1ba 135 pf->chainAsNext(chainHead);
Rohit Grover 118:620d28e7a1ba 136 chainHead = pf;
Rohit Grover 118:620d28e7a1ba 137 }
Rohit Grover 118:620d28e7a1ba 138
Rohit Grover 118:620d28e7a1ba 139 return chainHead;
Rohit Grover 118:620d28e7a1ba 140 }
Rohit Grover 118:620d28e7a1ba 141
Rohit Grover 118:620d28e7a1ba 142 private:
Rohit Grover 118:620d28e7a1ba 143 pFunctionPointerWithContext_t chainHead;
Rohit Grover 118:620d28e7a1ba 144
Rohit Grover 118:620d28e7a1ba 145 /* disallow copy constructor and assignment operators */
Rohit Grover 118:620d28e7a1ba 146 private:
Rohit Grover 118:620d28e7a1ba 147 CallChainOfFunctionPointersWithContext(const CallChainOfFunctionPointersWithContext &);
Rohit Grover 118:620d28e7a1ba 148 CallChainOfFunctionPointersWithContext & operator = (const CallChainOfFunctionPointersWithContext &);
Rohit Grover 118:620d28e7a1ba 149 };
Rohit Grover 118:620d28e7a1ba 150
rgrover1 140:407d134c179d 151 } // namespace mbed
rgrover1 140:407d134c179d 152
rgrover1 140:407d134c179d 153 #endif