Matthew Lister / BLE_API

BLE_API

ble/FunctionPointerWithContext.h@919:c5b9fac295f5, 2015-11-26 (annotated)

Committer:
rgrover1
Date:
Thu Nov 26 12:52:04 2015 +0000
Revision:
919:c5b9fac295f5
Parent:
918:2b12b53101ea
Child:
920:d18cff0c4b09
Synchronized with git rev dfc03ce0

Author: Vincent Coubard

Convert Gap::timeout callback to a callback chain. Add 'boolean'

conversion and function operator syntax to

CallChainOfFunctionPointerWithContext

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 710:b2e1a2660ec2 1 /* mbed Microcontroller Library
rgrover1 710:b2e1a2660ec2 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 710:b2e1a2660ec2 3 *
rgrover1 710:b2e1a2660ec2 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 710:b2e1a2660ec2 5 * you may not use this file except in compliance with the License.
rgrover1 710:b2e1a2660ec2 6 * You may obtain a copy of the License at
rgrover1 710:b2e1a2660ec2 7 *
rgrover1 710:b2e1a2660ec2 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 710:b2e1a2660ec2 9 *
rgrover1 710:b2e1a2660ec2 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 710:b2e1a2660ec2 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 710:b2e1a2660ec2 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 710:b2e1a2660ec2 13 * See the License for the specific language governing permissions and
rgrover1 710:b2e1a2660ec2 14 * limitations under the License.
rgrover1 710:b2e1a2660ec2 15 */
rgrover1 710:b2e1a2660ec2 16
rgrover1 710:b2e1a2660ec2 17 #ifndef MBED_FUNCTIONPOINTER_WITH_CONTEXT_H
rgrover1 710:b2e1a2660ec2 18 #define MBED_FUNCTIONPOINTER_WITH_CONTEXT_H
rgrover1 710:b2e1a2660ec2 19
rgrover1 710:b2e1a2660ec2 20 #include <string.h>
rgrover1 710:b2e1a2660ec2 21
rgrover1 710:b2e1a2660ec2 22 /** A class for storing and calling a pointer to a static or member void function
rgrover1 913:690bea02c431 23 * that takes a context.
rgrover1 710:b2e1a2660ec2 24 */
rgrover1 710:b2e1a2660ec2 25 template <typename ContextType>
rgrover1 710:b2e1a2660ec2 26 class FunctionPointerWithContext {
rgrover1 710:b2e1a2660ec2 27 public:
rgrover1 710:b2e1a2660ec2 28 typedef FunctionPointerWithContext<ContextType> *pFunctionPointerWithContext_t;
rgrover1 918:2b12b53101ea 29 typedef const FunctionPointerWithContext<ContextType> *cpFunctionPointerWithContext_t;
rgrover1 710:b2e1a2660ec2 30 typedef void (*pvoidfcontext_t)(ContextType context);
rgrover1 710:b2e1a2660ec2 31
rgrover1 913:690bea02c431 32 /** Create a FunctionPointerWithContext, attaching a static function.
rgrover1 710:b2e1a2660ec2 33 *
rgrover1 913:690bea02c431 34 * @param function The void static function to attach (default is none).
rgrover1 710:b2e1a2660ec2 35 */
rgrover1 710:b2e1a2660ec2 36 FunctionPointerWithContext(void (*function)(ContextType context) = NULL) :
rgrover1 918:2b12b53101ea 37 _memberFunctionAndPointer(), _caller(NULL), _next(NULL) {
rgrover1 710:b2e1a2660ec2 38 attach(function);
rgrover1 710:b2e1a2660ec2 39 }
rgrover1 710:b2e1a2660ec2 40
rgrover1 913:690bea02c431 41 /** Create a FunctionPointerWithContext, attaching a member function.
rgrover1 710:b2e1a2660ec2 42 *
rgrover1 913:690bea02c431 43 * @param object The object pointer to invoke the member function on (the "this" pointer).
rgrover1 913:690bea02c431 44 * @param function The address of the void member function to attach.
rgrover1 710:b2e1a2660ec2 45 */
rgrover1 710:b2e1a2660ec2 46 template<typename T>
rgrover1 710:b2e1a2660ec2 47 FunctionPointerWithContext(T *object, void (T::*member)(ContextType context)) :
rgrover1 897:838e1375dbaa 48 _memberFunctionAndPointer(), _caller(NULL), _next(NULL) {
rgrover1 710:b2e1a2660ec2 49 attach(object, member);
rgrover1 710:b2e1a2660ec2 50 }
rgrover1 710:b2e1a2660ec2 51
rgrover1 918:2b12b53101ea 52 FunctionPointerWithContext(const FunctionPointerWithContext& that) :
rgrover1 918:2b12b53101ea 53 _memberFunctionAndPointer(that._memberFunctionAndPointer), _caller(that._caller), _next(NULL) {
rgrover1 918:2b12b53101ea 54 }
rgrover1 918:2b12b53101ea 55
rgrover1 918:2b12b53101ea 56 FunctionPointerWithContext& operator=(const FunctionPointerWithContext& that) {
rgrover1 918:2b12b53101ea 57 _memberFunctionAndPointer = that._memberFunctionAndPointer;
rgrover1 918:2b12b53101ea 58 _caller = that._caller;
rgrover1 918:2b12b53101ea 59 _next = NULL;
rgrover1 918:2b12b53101ea 60 return *this;
rgrover1 918:2b12b53101ea 61 }
rgrover1 918:2b12b53101ea 62
rgrover1 913:690bea02c431 63 /** Attach a static function.
rgrover1 710:b2e1a2660ec2 64 *
rgrover1 913:690bea02c431 65 * @param function The void static function to attach (default is none).
rgrover1 710:b2e1a2660ec2 66 */
rgrover1 710:b2e1a2660ec2 67 void attach(void (*function)(ContextType context) = NULL) {
rgrover1 710:b2e1a2660ec2 68 _function = function;
rgrover1 897:838e1375dbaa 69 _caller = functioncaller;
rgrover1 710:b2e1a2660ec2 70 }
rgrover1 710:b2e1a2660ec2 71
rgrover1 913:690bea02c431 72 /** Attach a member function.
rgrover1 710:b2e1a2660ec2 73 *
rgrover1 913:690bea02c431 74 * @param object The object pointer to invoke the member function on (the "this" pointer).
rgrover1 913:690bea02c431 75 * @param function The address of the void member function to attach.
rgrover1 710:b2e1a2660ec2 76 */
rgrover1 710:b2e1a2660ec2 77 template<typename T>
rgrover1 710:b2e1a2660ec2 78 void attach(T *object, void (T::*member)(ContextType context)) {
rgrover1 897:838e1375dbaa 79 _memberFunctionAndPointer._object = static_cast<void *>(object);
rgrover1 897:838e1375dbaa 80 memcpy(_memberFunctionAndPointer._memberFunction, (char*) &member, sizeof(member));
rgrover1 897:838e1375dbaa 81 _caller = &FunctionPointerWithContext::membercaller<T>;
rgrover1 710:b2e1a2660ec2 82 }
rgrover1 710:b2e1a2660ec2 83
rgrover1 913:690bea02c431 84 /** Call the attached static or member function; if there are chained
rgrover1 710:b2e1a2660ec2 85 * FunctionPointers their callbacks are invoked as well.
rgrover1 913:690bea02c431 86 * @Note: All chained callbacks stack up, so hopefully there won't be too
rgrover1 710:b2e1a2660ec2 87 * many FunctionPointers in a chain. */
rgrover1 918:2b12b53101ea 88 void call(ContextType context) const {
rgrover1 918:2b12b53101ea 89 _caller(this, context);
rgrover1 918:2b12b53101ea 90
rgrover1 918:2b12b53101ea 91 /* Propagate the call to next in the chain. */
rgrover1 918:2b12b53101ea 92 if (_next) {
rgrover1 918:2b12b53101ea 93 _next->call(context);
rgrover1 918:2b12b53101ea 94 }
rgrover1 918:2b12b53101ea 95 }
rgrover1 918:2b12b53101ea 96
rgrover1 919:c5b9fac295f5 97 /**
rgrover1 919:c5b9fac295f5 98 * @brief Same as above
rgrover1 919:c5b9fac295f5 99 */
rgrover1 919:c5b9fac295f5 100 void operator()(ContextType context) const {
rgrover1 919:c5b9fac295f5 101 call(context);
rgrover1 919:c5b9fac295f5 102 }
rgrover1 919:c5b9fac295f5 103
rgrover1 918:2b12b53101ea 104 /** Same as above, workaround for mbed os FunctionPointer implementation. */
rgrover1 710:b2e1a2660ec2 105 void call(ContextType context) {
rgrover1 897:838e1375dbaa 106 _caller(this, context);
rgrover1 710:b2e1a2660ec2 107
rgrover1 710:b2e1a2660ec2 108 /* Propagate the call to next in the chain. */
rgrover1 710:b2e1a2660ec2 109 if (_next) {
rgrover1 710:b2e1a2660ec2 110 _next->call(context);
rgrover1 710:b2e1a2660ec2 111 }
rgrover1 710:b2e1a2660ec2 112 }
rgrover1 710:b2e1a2660ec2 113
rgrover1 710:b2e1a2660ec2 114 /**
rgrover1 913:690bea02c431 115 * Set up an external FunctionPointer as a next in the chain of related
rgrover1 710:b2e1a2660ec2 116 * callbacks. Invoking call() on the head FunctionPointer will invoke all
rgrover1 710:b2e1a2660ec2 117 * chained callbacks.
rgrover1 710:b2e1a2660ec2 118 *
rgrover1 710:b2e1a2660ec2 119 * Refer to 'CallChain' as an alternative.
rgrover1 710:b2e1a2660ec2 120 */
rgrover1 710:b2e1a2660ec2 121 void chainAsNext(pFunctionPointerWithContext_t next) {
rgrover1 710:b2e1a2660ec2 122 _next = next;
rgrover1 710:b2e1a2660ec2 123 }
rgrover1 710:b2e1a2660ec2 124
rgrover1 710:b2e1a2660ec2 125 pFunctionPointerWithContext_t getNext(void) const {
rgrover1 710:b2e1a2660ec2 126 return _next;
rgrover1 710:b2e1a2660ec2 127 }
rgrover1 710:b2e1a2660ec2 128
rgrover1 710:b2e1a2660ec2 129 pvoidfcontext_t get_function() const {
rgrover1 710:b2e1a2660ec2 130 return (pvoidfcontext_t)_function;
rgrover1 710:b2e1a2660ec2 131 }
rgrover1 710:b2e1a2660ec2 132
rgrover1 918:2b12b53101ea 133 friend bool operator==(const FunctionPointerWithContext& lhs, const FunctionPointerWithContext& rhs) {
rgrover1 918:2b12b53101ea 134 return rhs._caller == lhs._caller &&
rgrover1 918:2b12b53101ea 135 memcmp(
rgrover1 918:2b12b53101ea 136 &rhs._memberFunctionAndPointer,
rgrover1 918:2b12b53101ea 137 &lhs._memberFunctionAndPointer,
rgrover1 918:2b12b53101ea 138 sizeof(rhs._memberFunctionAndPointer)
rgrover1 918:2b12b53101ea 139 ) == 0;
rgrover1 918:2b12b53101ea 140 }
rgrover1 918:2b12b53101ea 141
rgrover1 710:b2e1a2660ec2 142 private:
rgrover1 710:b2e1a2660ec2 143 template<typename T>
rgrover1 918:2b12b53101ea 144 static void membercaller(cpFunctionPointerWithContext_t self, ContextType context) {
rgrover1 897:838e1375dbaa 145 if (self->_memberFunctionAndPointer._object) {
rgrover1 897:838e1375dbaa 146 T *o = static_cast<T *>(self->_memberFunctionAndPointer._object);
rgrover1 897:838e1375dbaa 147 void (T::*m)(ContextType);
rgrover1 897:838e1375dbaa 148 memcpy((char*) &m, self->_memberFunctionAndPointer._memberFunction, sizeof(m));
rgrover1 897:838e1375dbaa 149 (o->*m)(context);
rgrover1 897:838e1375dbaa 150 }
rgrover1 897:838e1375dbaa 151 }
rgrover1 897:838e1375dbaa 152
rgrover1 918:2b12b53101ea 153 static void functioncaller(cpFunctionPointerWithContext_t self, ContextType context) {
rgrover1 897:838e1375dbaa 154 if (self->_function) {
rgrover1 897:838e1375dbaa 155 self->_function(context);
rgrover1 897:838e1375dbaa 156 }
rgrover1 710:b2e1a2660ec2 157 }
rgrover1 710:b2e1a2660ec2 158
rgrover1 897:838e1375dbaa 159 struct MemberFunctionAndPtr {
rgrover1 897:838e1375dbaa 160 /*
rgrover1 913:690bea02c431 161 * Forward declaration of a class and a member function to this class.
rgrover1 897:838e1375dbaa 162 * Because the compiler doesn't know anything about the forwarded member
rgrover1 897:838e1375dbaa 163 * function, it will always use the biggest size and the biggest alignment
rgrover1 897:838e1375dbaa 164 * that a member function can take for objects of type UndefinedMemberFunction.
rgrover1 897:838e1375dbaa 165 */
rgrover1 897:838e1375dbaa 166 class UndefinedClass;
rgrover1 897:838e1375dbaa 167 typedef void (UndefinedClass::*UndefinedMemberFunction)(ContextType);
rgrover1 897:838e1375dbaa 168
rgrover1 897:838e1375dbaa 169 void* _object;
rgrover1 897:838e1375dbaa 170 union {
rgrover1 897:838e1375dbaa 171 char _memberFunction[sizeof(UndefinedMemberFunction)];
rgrover1 897:838e1375dbaa 172 UndefinedMemberFunction _alignment;
rgrover1 897:838e1375dbaa 173 };
rgrover1 897:838e1375dbaa 174 };
rgrover1 897:838e1375dbaa 175
rgrover1 897:838e1375dbaa 176 union {
rgrover1 913:690bea02c431 177 pvoidfcontext_t _function; /**< Static function pointer - NULL if none attached */
rgrover1 897:838e1375dbaa 178 /**
rgrover1 897:838e1375dbaa 179 * object this pointer and pointer to member -
rgrover1 897:838e1375dbaa 180 * _memberFunctionAndPointer._object will be NULL if none attached
rgrover1 897:838e1375dbaa 181 */
rgrover1 918:2b12b53101ea 182 mutable MemberFunctionAndPtr _memberFunctionAndPointer;
rgrover1 897:838e1375dbaa 183 };
rgrover1 897:838e1375dbaa 184
rgrover1 918:2b12b53101ea 185 void (*_caller)(const FunctionPointerWithContext*, ContextType);
rgrover1 897:838e1375dbaa 186
rgrover1 913:690bea02c431 187 pFunctionPointerWithContext_t _next; /**< Optional link to make a chain out of functionPointers. This
rgrover1 710:b2e1a2660ec2 188 * allows chaining function pointers without requiring
rgrover1 913:690bea02c431 189 * external memory to manage the chain. Refer to
rgrover1 710:b2e1a2660ec2 190 * 'CallChain' as an alternative. */
rgrover1 710:b2e1a2660ec2 191 };
rgrover1 710:b2e1a2660ec2 192
rgrover1 918:2b12b53101ea 193 /**
rgrover1 918:2b12b53101ea 194 * @brief Create a new FunctionPointerWithContext which bind an instance and a
rgrover1 918:2b12b53101ea 195 * a member function together.
rgrover1 918:2b12b53101ea 196 * @details This little helper is a just here to eliminate the need to write the
rgrover1 918:2b12b53101ea 197 * FunctionPointerWithContext type each time you want to create one by kicking
rgrover1 918:2b12b53101ea 198 * automatic type deduction of function templates. With this function, it is easy
rgrover1 918:2b12b53101ea 199 * to write only one entry point for functions which expect a FunctionPointer
rgrover1 918:2b12b53101ea 200 * in parameters.
rgrover1 918:2b12b53101ea 201 *
rgrover1 918:2b12b53101ea 202 * @param object to bound with member function
rgrover1 918:2b12b53101ea 203 * @param member The member function called
rgrover1 918:2b12b53101ea 204 * @return a new FunctionPointerWithContext
rgrover1 918:2b12b53101ea 205 */
rgrover1 918:2b12b53101ea 206 template<typename T, typename ContextType>
rgrover1 918:2b12b53101ea 207 FunctionPointerWithContext<ContextType> makeFunctionPointer(T *object, void (T::*member)(ContextType context))
rgrover1 918:2b12b53101ea 208 {
rgrover1 918:2b12b53101ea 209 return FunctionPointerWithContext<ContextType>(object, member);
rgrover1 918:2b12b53101ea 210 }
rgrover1 918:2b12b53101ea 211
rgrover1 710:b2e1a2660ec2 212 #endif // ifndef MBED_FUNCTIONPOINTER_WITH_CONTEXT_H