Oscar Ariza / BLE_API

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of BLE_API by Bluetooth Low Energy

ble/FunctionPointerWithContext.h@1047:87a2ebe45470, 2016-01-11 (annotated)

Committer:
vcoubard
Date:
Mon Jan 11 08:51:27 2016 +0000
Revision:
1047:87a2ebe45470
Parent:
1046:b9d15970040f
Child:
1049:efb29faf12fc
Synchronized with git rev 483cf906

Author: Vincent Coubard

Improve FunctionPointerWithContext value semantic.

Fix operator== in DiscoveredCharacteristic.

add DiscoveredOperator::operator!=

add a function to set the last handle of a DiscoveredCharacteristic on the

fly

Who changed what in which revision?

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