mbed official / mbed-dev

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.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

api/FunctionPointer.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Child:
144:ef7eb2e8f9f7
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 0:9b334a45a8ff 1 /* mbed Microcontroller Library
bogdanm 0:9b334a45a8ff 2 * Copyright (c) 2006-2015 ARM Limited
bogdanm 0:9b334a45a8ff 3 *
bogdanm 0:9b334a45a8ff 4 * Licensed under the Apache License, Version 2.0 (the "License");
bogdanm 0:9b334a45a8ff 5 * you may not use this file except in compliance with the License.
bogdanm 0:9b334a45a8ff 6 * You may obtain a copy of the License at
bogdanm 0:9b334a45a8ff 7 *
bogdanm 0:9b334a45a8ff 8 * http://www.apache.org/licenses/LICENSE-2.0
bogdanm 0:9b334a45a8ff 9 *
bogdanm 0:9b334a45a8ff 10 * Unless required by applicable law or agreed to in writing, software
bogdanm 0:9b334a45a8ff 11 * distributed under the License is distributed on an "AS IS" BASIS,
bogdanm 0:9b334a45a8ff 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
bogdanm 0:9b334a45a8ff 13 * See the License for the specific language governing permissions and
bogdanm 0:9b334a45a8ff 14 * limitations under the License.
bogdanm 0:9b334a45a8ff 15 */
bogdanm 0:9b334a45a8ff 16 #ifndef MBED_FUNCTIONPOINTER_H
bogdanm 0:9b334a45a8ff 17 #define MBED_FUNCTIONPOINTER_H
bogdanm 0:9b334a45a8ff 18
bogdanm 0:9b334a45a8ff 19 #include <string.h>
bogdanm 0:9b334a45a8ff 20 #include <stdint.h>
bogdanm 0:9b334a45a8ff 21
bogdanm 0:9b334a45a8ff 22 namespace mbed {
bogdanm 0:9b334a45a8ff 23
bogdanm 0:9b334a45a8ff 24 /* If we had variaditic templates, this wouldn't be a problem, but until C++11 is enabled, we are stuck with multiple classes... */
bogdanm 0:9b334a45a8ff 25
bogdanm 0:9b334a45a8ff 26 /** A class for storing and calling a pointer to a static or member function
bogdanm 0:9b334a45a8ff 27 */
bogdanm 0:9b334a45a8ff 28 template <typename R, typename A1>
bogdanm 0:9b334a45a8ff 29 class FunctionPointerArg1{
bogdanm 0:9b334a45a8ff 30 public:
bogdanm 0:9b334a45a8ff 31 /** Create a FunctionPointer, attaching a static function
bogdanm 0:9b334a45a8ff 32 *
bogdanm 0:9b334a45a8ff 33 * @param function The static function to attach (default is none)
bogdanm 0:9b334a45a8ff 34 */
bogdanm 0:9b334a45a8ff 35 FunctionPointerArg1(R (*function)(A1) = 0) {
bogdanm 0:9b334a45a8ff 36 attach(function);
bogdanm 0:9b334a45a8ff 37 }
bogdanm 0:9b334a45a8ff 38
bogdanm 0:9b334a45a8ff 39 /** Create a FunctionPointer, attaching a member function
bogdanm 0:9b334a45a8ff 40 *
bogdanm 0:9b334a45a8ff 41 * @param object The object pointer to invoke the member function on (i.e. the this pointer)
bogdanm 0:9b334a45a8ff 42 * @param function The address of the member function to attach
bogdanm 0:9b334a45a8ff 43 */
bogdanm 0:9b334a45a8ff 44 template<typename T>
bogdanm 0:9b334a45a8ff 45 FunctionPointerArg1(T *object, R (T::*member)(A1)) {
bogdanm 0:9b334a45a8ff 46 attach(object, member);
bogdanm 0:9b334a45a8ff 47 }
bogdanm 0:9b334a45a8ff 48
bogdanm 0:9b334a45a8ff 49 /** Attach a static function
bogdanm 0:9b334a45a8ff 50 *
bogdanm 0:9b334a45a8ff 51 * @param function The static function to attach (default is none)
bogdanm 0:9b334a45a8ff 52 */
bogdanm 0:9b334a45a8ff 53 void attach(R (*function)(A1)) {
bogdanm 0:9b334a45a8ff 54 _p.function = function;
bogdanm 0:9b334a45a8ff 55 _membercaller = 0;
bogdanm 0:9b334a45a8ff 56 }
bogdanm 0:9b334a45a8ff 57
bogdanm 0:9b334a45a8ff 58 /** Attach a member function
bogdanm 0:9b334a45a8ff 59 *
bogdanm 0:9b334a45a8ff 60 * @param object The object pointer to invoke the member function on (i.e. the this pointer)
bogdanm 0:9b334a45a8ff 61 * @param function The address of the member function to attach
bogdanm 0:9b334a45a8ff 62 */
bogdanm 0:9b334a45a8ff 63 template<typename T>
bogdanm 0:9b334a45a8ff 64 void attach(T *object, R (T::*member)(A1)) {
bogdanm 0:9b334a45a8ff 65 _p.object = static_cast<void*>(object);
bogdanm 0:9b334a45a8ff 66 *reinterpret_cast<R (T::**)(A1)>(_member) = member;
bogdanm 0:9b334a45a8ff 67 _membercaller = &FunctionPointerArg1::membercaller<T>;
bogdanm 0:9b334a45a8ff 68 }
bogdanm 0:9b334a45a8ff 69
bogdanm 0:9b334a45a8ff 70 /** Call the attached static or member function
bogdanm 0:9b334a45a8ff 71 */
bogdanm 0:9b334a45a8ff 72 R call(A1 a) {
bogdanm 0:9b334a45a8ff 73 if (_membercaller == 0 && _p.function) {
bogdanm 0:9b334a45a8ff 74 return _p.function(a);
bogdanm 0:9b334a45a8ff 75 } else if (_membercaller && _p.object) {
bogdanm 0:9b334a45a8ff 76 return _membercaller(_p.object, _member, a);
bogdanm 0:9b334a45a8ff 77 }
bogdanm 0:9b334a45a8ff 78 return (R)0;
bogdanm 0:9b334a45a8ff 79 }
bogdanm 0:9b334a45a8ff 80
bogdanm 0:9b334a45a8ff 81 /** Get registered static function
bogdanm 0:9b334a45a8ff 82 */
bogdanm 0:9b334a45a8ff 83 R(*get_function(A1))() {
bogdanm 0:9b334a45a8ff 84 return _membercaller ? (R(*)(A1))0 : (R(*)(A1))_p.function;
bogdanm 0:9b334a45a8ff 85 }
bogdanm 0:9b334a45a8ff 86
bogdanm 0:9b334a45a8ff 87 #ifdef MBED_OPERATORS
bogdanm 0:9b334a45a8ff 88 R operator ()(A1 a) {
bogdanm 0:9b334a45a8ff 89 return call(a);
bogdanm 0:9b334a45a8ff 90 }
bogdanm 0:9b334a45a8ff 91 operator bool(void) const {
bogdanm 0:9b334a45a8ff 92 return (_membercaller != NULL ? _p.object : (void*)_p.function) != NULL;
bogdanm 0:9b334a45a8ff 93 }
bogdanm 0:9b334a45a8ff 94 #endif
bogdanm 0:9b334a45a8ff 95 private:
bogdanm 0:9b334a45a8ff 96 template<typename T>
bogdanm 0:9b334a45a8ff 97 static R membercaller(void *object, uintptr_t *member, A1 a) {
bogdanm 0:9b334a45a8ff 98 T* o = static_cast<T*>(object);
bogdanm 0:9b334a45a8ff 99 R (T::**m)(A1) = reinterpret_cast<R (T::**)(A1)>(member);
bogdanm 0:9b334a45a8ff 100 return (o->**m)(a);
bogdanm 0:9b334a45a8ff 101 }
bogdanm 0:9b334a45a8ff 102
bogdanm 0:9b334a45a8ff 103 union {
bogdanm 0:9b334a45a8ff 104 R (*function)(A1); // static function pointer
bogdanm 0:9b334a45a8ff 105 void *object; // object this pointer
bogdanm 0:9b334a45a8ff 106 } _p;
bogdanm 0:9b334a45a8ff 107 uintptr_t _member[4]; // aligned raw member function pointer storage - converted back by registered _membercaller
bogdanm 0:9b334a45a8ff 108 R (*_membercaller)(void*, uintptr_t*, A1); // registered membercaller function to convert back and call _m.member on _object
bogdanm 0:9b334a45a8ff 109 };
bogdanm 0:9b334a45a8ff 110
bogdanm 0:9b334a45a8ff 111 /** A class for storing and calling a pointer to a static or member function (R ()(void))
bogdanm 0:9b334a45a8ff 112 */
bogdanm 0:9b334a45a8ff 113 template <typename R>
bogdanm 0:9b334a45a8ff 114 class FunctionPointerArg1<R, void>{
bogdanm 0:9b334a45a8ff 115 public:
bogdanm 0:9b334a45a8ff 116 /** Create a FunctionPointer, attaching a static function
bogdanm 0:9b334a45a8ff 117 *
bogdanm 0:9b334a45a8ff 118 * @param function The static function to attach (default is none)
bogdanm 0:9b334a45a8ff 119 */
bogdanm 0:9b334a45a8ff 120 FunctionPointerArg1(R (*function)(void) = 0) {
bogdanm 0:9b334a45a8ff 121 attach(function);
bogdanm 0:9b334a45a8ff 122 }
bogdanm 0:9b334a45a8ff 123
bogdanm 0:9b334a45a8ff 124 /** Create a FunctionPointer, attaching a member function
bogdanm 0:9b334a45a8ff 125 *
bogdanm 0:9b334a45a8ff 126 * @param object The object pointer to invoke the member function on (i.e. the this pointer)
bogdanm 0:9b334a45a8ff 127 * @param function The address of the void member function to attach
bogdanm 0:9b334a45a8ff 128 */
bogdanm 0:9b334a45a8ff 129 template<typename T>
bogdanm 0:9b334a45a8ff 130 FunctionPointerArg1(T *object, R (T::*member)(void)) {
bogdanm 0:9b334a45a8ff 131 attach(object, member);
bogdanm 0:9b334a45a8ff 132 }
bogdanm 0:9b334a45a8ff 133
bogdanm 0:9b334a45a8ff 134 /** Attach a static function
bogdanm 0:9b334a45a8ff 135 *
bogdanm 0:9b334a45a8ff 136 * @param function The void static function to attach (default is none)
bogdanm 0:9b334a45a8ff 137 */
bogdanm 0:9b334a45a8ff 138 void attach(R (*function)(void)) {
bogdanm 0:9b334a45a8ff 139 _p.function = function;
bogdanm 0:9b334a45a8ff 140 _membercaller = 0;
bogdanm 0:9b334a45a8ff 141 }
bogdanm 0:9b334a45a8ff 142
bogdanm 0:9b334a45a8ff 143 /** Attach a member function
bogdanm 0:9b334a45a8ff 144 *
bogdanm 0:9b334a45a8ff 145 * @param object The object pointer to invoke the member function on (i.e. the this pointer)
bogdanm 0:9b334a45a8ff 146 * @param function The address of the void member function to attach
bogdanm 0:9b334a45a8ff 147 */
bogdanm 0:9b334a45a8ff 148 template<typename T>
bogdanm 0:9b334a45a8ff 149 void attach(T *object, R (T::*member)(void)) {
bogdanm 0:9b334a45a8ff 150 _p.object = static_cast<void*>(object);
bogdanm 0:9b334a45a8ff 151 *reinterpret_cast<R (T::**)(void)>(_member) = member;
bogdanm 0:9b334a45a8ff 152 _membercaller = &FunctionPointerArg1::membercaller<T>;
bogdanm 0:9b334a45a8ff 153 }
bogdanm 0:9b334a45a8ff 154
bogdanm 0:9b334a45a8ff 155 /** Call the attached static or member function
bogdanm 0:9b334a45a8ff 156 */
bogdanm 0:9b334a45a8ff 157 R call(){
bogdanm 0:9b334a45a8ff 158 if (_membercaller == 0 && _p.function) {
bogdanm 0:9b334a45a8ff 159 return _p.function();
bogdanm 0:9b334a45a8ff 160 } else if (_membercaller && _p.object) {
bogdanm 0:9b334a45a8ff 161 return _membercaller(_p.object, _member);
bogdanm 0:9b334a45a8ff 162 }
bogdanm 0:9b334a45a8ff 163 return (R)0;
bogdanm 0:9b334a45a8ff 164 }
bogdanm 0:9b334a45a8ff 165
bogdanm 0:9b334a45a8ff 166 /** Get registered static function
bogdanm 0:9b334a45a8ff 167 */
bogdanm 0:9b334a45a8ff 168 R(*get_function())() {
bogdanm 0:9b334a45a8ff 169 return _membercaller ? (R(*)())0 : (R(*)())_p.function;
bogdanm 0:9b334a45a8ff 170 }
bogdanm 0:9b334a45a8ff 171
bogdanm 0:9b334a45a8ff 172 #ifdef MBED_OPERATORS
bogdanm 0:9b334a45a8ff 173 R operator ()(void) {
bogdanm 0:9b334a45a8ff 174 return call();
bogdanm 0:9b334a45a8ff 175 }
bogdanm 0:9b334a45a8ff 176 operator bool(void) const {
bogdanm 0:9b334a45a8ff 177 return (_membercaller != NULL ? _p.object : (void*)_p.function) != NULL;
bogdanm 0:9b334a45a8ff 178 }
bogdanm 0:9b334a45a8ff 179 #endif
bogdanm 0:9b334a45a8ff 180
bogdanm 0:9b334a45a8ff 181 private:
bogdanm 0:9b334a45a8ff 182 template<typename T>
bogdanm 0:9b334a45a8ff 183 static R membercaller(void *object, uintptr_t *member) {
bogdanm 0:9b334a45a8ff 184 T* o = static_cast<T*>(object);
bogdanm 0:9b334a45a8ff 185 R (T::**m)(void) = reinterpret_cast<R (T::**)(void)>(member);
bogdanm 0:9b334a45a8ff 186 return (o->**m)();
bogdanm 0:9b334a45a8ff 187 }
bogdanm 0:9b334a45a8ff 188
bogdanm 0:9b334a45a8ff 189 union {
bogdanm 0:9b334a45a8ff 190 R (*function)(void); // static function pointer
bogdanm 0:9b334a45a8ff 191 void *object; // object this pointer
bogdanm 0:9b334a45a8ff 192 } _p;
bogdanm 0:9b334a45a8ff 193 uintptr_t _member[4]; // aligned raw member function pointer storage - converted back by registered _membercaller
bogdanm 0:9b334a45a8ff 194 R (*_membercaller)(void*, uintptr_t*); // registered membercaller function to convert back and call _m.member on _object
bogdanm 0:9b334a45a8ff 195 };
bogdanm 0:9b334a45a8ff 196
bogdanm 0:9b334a45a8ff 197 typedef FunctionPointerArg1<void, void> FunctionPointer;
bogdanm 0:9b334a45a8ff 198 typedef FunctionPointerArg1<void, int> event_callback_t;
bogdanm 0:9b334a45a8ff 199
bogdanm 0:9b334a45a8ff 200 } // namespace mbed
bogdanm 0:9b334a45a8ff 201
bogdanm 0:9b334a45a8ff 202 #endif