Morpheus / mbed-hal

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.

Dependencies:   target-freescale

api/FunctionPointer.h@0:9c59db1fbc9e, 2016-03-23 (annotated)

Committer:
screamer
Date:
Wed Mar 23 21:36:09 2016 +0000
Revision:
0:9c59db1fbc9e
Child:
6:c2a3aa792960
Initial revision

Who changed what in which revision?

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