MacroRat / MouseCode

Mouse code for the MacroRat

Dependencies:   ITG3200 QEI

mbed-dev/platform/CallChain.h@46:b156ef445742, 2017-06-03 (annotated)

Committer:
sahilmgandhi
Date:
Sat Jun 03 00:22:44 2017 +0000
Revision:
46:b156ef445742
Parent:
18:6a4db94011d3 
Final code for internal battlebot competition.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sahilmgandhi 18:6a4db94011d3 1 /* mbed Microcontroller Library
sahilmgandhi 18:6a4db94011d3 2 * Copyright (c) 2006-2013 ARM Limited
sahilmgandhi 18:6a4db94011d3 3 *
sahilmgandhi 18:6a4db94011d3 4 * Licensed under the Apache License, Version 2.0 (the "License");
sahilmgandhi 18:6a4db94011d3 5 * you may not use this file except in compliance with the License.
sahilmgandhi 18:6a4db94011d3 6 * You may obtain a copy of the License at
sahilmgandhi 18:6a4db94011d3 7 *
sahilmgandhi 18:6a4db94011d3 8 * http://www.apache.org/licenses/LICENSE-2.0
sahilmgandhi 18:6a4db94011d3 9 *
sahilmgandhi 18:6a4db94011d3 10 * Unless required by applicable law or agreed to in writing, software
sahilmgandhi 18:6a4db94011d3 11 * distributed under the License is distributed on an "AS IS" BASIS,
sahilmgandhi 18:6a4db94011d3 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
sahilmgandhi 18:6a4db94011d3 13 * See the License for the specific language governing permissions and
sahilmgandhi 18:6a4db94011d3 14 * limitations under the License.
sahilmgandhi 18:6a4db94011d3 15 */
sahilmgandhi 18:6a4db94011d3 16 #ifndef MBED_CALLCHAIN_H
sahilmgandhi 18:6a4db94011d3 17 #define MBED_CALLCHAIN_H
sahilmgandhi 18:6a4db94011d3 18
sahilmgandhi 18:6a4db94011d3 19 #include "platform/Callback.h"
sahilmgandhi 18:6a4db94011d3 20 #include "platform/mbed_toolchain.h"
sahilmgandhi 18:6a4db94011d3 21 #include <string.h>
sahilmgandhi 18:6a4db94011d3 22
sahilmgandhi 18:6a4db94011d3 23 namespace mbed {
sahilmgandhi 18:6a4db94011d3 24 /** \addtogroup platform */
sahilmgandhi 18:6a4db94011d3 25 /** @{*/
sahilmgandhi 18:6a4db94011d3 26
sahilmgandhi 18:6a4db94011d3 27 /** Group one or more functions in an instance of a CallChain, then call them in
sahilmgandhi 18:6a4db94011d3 28 * sequence using CallChain::call(). Used mostly by the interrupt chaining code,
sahilmgandhi 18:6a4db94011d3 29 * but can be used for other purposes.
sahilmgandhi 18:6a4db94011d3 30 *
sahilmgandhi 18:6a4db94011d3 31 * @Note Synchronization level: Not protected
sahilmgandhi 18:6a4db94011d3 32 *
sahilmgandhi 18:6a4db94011d3 33 * Example:
sahilmgandhi 18:6a4db94011d3 34 * @code
sahilmgandhi 18:6a4db94011d3 35 * #include "mbed.h"
sahilmgandhi 18:6a4db94011d3 36 *
sahilmgandhi 18:6a4db94011d3 37 * CallChain chain;
sahilmgandhi 18:6a4db94011d3 38 *
sahilmgandhi 18:6a4db94011d3 39 * void first(void) {
sahilmgandhi 18:6a4db94011d3 40 * printf("'first' function.\n");
sahilmgandhi 18:6a4db94011d3 41 * }
sahilmgandhi 18:6a4db94011d3 42 *
sahilmgandhi 18:6a4db94011d3 43 * void second(void) {
sahilmgandhi 18:6a4db94011d3 44 * printf("'second' function.\n");
sahilmgandhi 18:6a4db94011d3 45 * }
sahilmgandhi 18:6a4db94011d3 46 *
sahilmgandhi 18:6a4db94011d3 47 * class Test {
sahilmgandhi 18:6a4db94011d3 48 * public:
sahilmgandhi 18:6a4db94011d3 49 * void f(void) {
sahilmgandhi 18:6a4db94011d3 50 * printf("A::f (class member).\n");
sahilmgandhi 18:6a4db94011d3 51 * }
sahilmgandhi 18:6a4db94011d3 52 * };
sahilmgandhi 18:6a4db94011d3 53 *
sahilmgandhi 18:6a4db94011d3 54 * int main() {
sahilmgandhi 18:6a4db94011d3 55 * Test test;
sahilmgandhi 18:6a4db94011d3 56 *
sahilmgandhi 18:6a4db94011d3 57 * chain.add(second);
sahilmgandhi 18:6a4db94011d3 58 * chain.add_front(first);
sahilmgandhi 18:6a4db94011d3 59 * chain.add(&test, &Test::f);
sahilmgandhi 18:6a4db94011d3 60 * chain.call();
sahilmgandhi 18:6a4db94011d3 61 * }
sahilmgandhi 18:6a4db94011d3 62 * @endcode
sahilmgandhi 18:6a4db94011d3 63 */
sahilmgandhi 18:6a4db94011d3 64
sahilmgandhi 18:6a4db94011d3 65 typedef Callback<void()> *pFunctionPointer_t;
sahilmgandhi 18:6a4db94011d3 66 class CallChainLink;
sahilmgandhi 18:6a4db94011d3 67
sahilmgandhi 18:6a4db94011d3 68 class CallChain {
sahilmgandhi 18:6a4db94011d3 69 public:
sahilmgandhi 18:6a4db94011d3 70 /** Create an empty chain
sahilmgandhi 18:6a4db94011d3 71 *
sahilmgandhi 18:6a4db94011d3 72 * @param size (optional) Initial size of the chain
sahilmgandhi 18:6a4db94011d3 73 */
sahilmgandhi 18:6a4db94011d3 74 CallChain(int size = 4);
sahilmgandhi 18:6a4db94011d3 75 virtual ~CallChain();
sahilmgandhi 18:6a4db94011d3 76
sahilmgandhi 18:6a4db94011d3 77 /** Add a function at the end of the chain
sahilmgandhi 18:6a4db94011d3 78 *
sahilmgandhi 18:6a4db94011d3 79 * @param func A pointer to a void function
sahilmgandhi 18:6a4db94011d3 80 *
sahilmgandhi 18:6a4db94011d3 81 * @returns
sahilmgandhi 18:6a4db94011d3 82 * The function object created for 'func'
sahilmgandhi 18:6a4db94011d3 83 */
sahilmgandhi 18:6a4db94011d3 84 pFunctionPointer_t add(Callback<void()> func);
sahilmgandhi 18:6a4db94011d3 85
sahilmgandhi 18:6a4db94011d3 86 /** Add a function at the end of the chain
sahilmgandhi 18:6a4db94011d3 87 *
sahilmgandhi 18:6a4db94011d3 88 * @param obj pointer to the object to call the member function on
sahilmgandhi 18:6a4db94011d3 89 * @param method pointer to the member function to be called
sahilmgandhi 18:6a4db94011d3 90 *
sahilmgandhi 18:6a4db94011d3 91 * @returns
sahilmgandhi 18:6a4db94011d3 92 * The function object created for 'obj' and 'method'
sahilmgandhi 18:6a4db94011d3 93 *
sahilmgandhi 18:6a4db94011d3 94 * @deprecated
sahilmgandhi 18:6a4db94011d3 95 * The add function does not support cv-qualifiers. Replaced by
sahilmgandhi 18:6a4db94011d3 96 * add(callback(obj, method)).
sahilmgandhi 18:6a4db94011d3 97 */
sahilmgandhi 18:6a4db94011d3 98 template<typename T, typename M>
sahilmgandhi 18:6a4db94011d3 99 MBED_DEPRECATED_SINCE("mbed-os-5.1",
sahilmgandhi 18:6a4db94011d3 100 "The add function does not support cv-qualifiers. Replaced by "
sahilmgandhi 18:6a4db94011d3 101 "add(callback(obj, method)).")
sahilmgandhi 18:6a4db94011d3 102 pFunctionPointer_t add(T *obj, M method) {
sahilmgandhi 18:6a4db94011d3 103 return add(callback(obj, method));
sahilmgandhi 18:6a4db94011d3 104 }
sahilmgandhi 18:6a4db94011d3 105
sahilmgandhi 18:6a4db94011d3 106 /** Add a function at the beginning of the chain
sahilmgandhi 18:6a4db94011d3 107 *
sahilmgandhi 18:6a4db94011d3 108 * @param func A pointer to a void function
sahilmgandhi 18:6a4db94011d3 109 *
sahilmgandhi 18:6a4db94011d3 110 * @returns
sahilmgandhi 18:6a4db94011d3 111 * The function object created for 'func'
sahilmgandhi 18:6a4db94011d3 112 */
sahilmgandhi 18:6a4db94011d3 113 pFunctionPointer_t add_front(Callback<void()> func);
sahilmgandhi 18:6a4db94011d3 114
sahilmgandhi 18:6a4db94011d3 115 /** Add a function at the beginning of the chain
sahilmgandhi 18:6a4db94011d3 116 *
sahilmgandhi 18:6a4db94011d3 117 * @param tptr pointer to the object to call the member function on
sahilmgandhi 18:6a4db94011d3 118 * @param mptr pointer to the member function to be called
sahilmgandhi 18:6a4db94011d3 119 *
sahilmgandhi 18:6a4db94011d3 120 * @returns
sahilmgandhi 18:6a4db94011d3 121 * The function object created for 'tptr' and 'mptr'
sahilmgandhi 18:6a4db94011d3 122 *
sahilmgandhi 18:6a4db94011d3 123 * @deprecated
sahilmgandhi 18:6a4db94011d3 124 * The add_front function does not support cv-qualifiers. Replaced by
sahilmgandhi 18:6a4db94011d3 125 * add_front(callback(obj, method)).
sahilmgandhi 18:6a4db94011d3 126 */
sahilmgandhi 18:6a4db94011d3 127 template<typename T, typename M>
sahilmgandhi 18:6a4db94011d3 128 MBED_DEPRECATED_SINCE("mbed-os-5.1",
sahilmgandhi 18:6a4db94011d3 129 "The add_front function does not support cv-qualifiers. Replaced by "
sahilmgandhi 18:6a4db94011d3 130 "add_front(callback(obj, method)).")
sahilmgandhi 18:6a4db94011d3 131 pFunctionPointer_t add_front(T *obj, M method) {
sahilmgandhi 18:6a4db94011d3 132 return add_front(callback(obj, method));
sahilmgandhi 18:6a4db94011d3 133 }
sahilmgandhi 18:6a4db94011d3 134
sahilmgandhi 18:6a4db94011d3 135 /** Get the number of functions in the chain
sahilmgandhi 18:6a4db94011d3 136 */
sahilmgandhi 18:6a4db94011d3 137 int size() const;
sahilmgandhi 18:6a4db94011d3 138
sahilmgandhi 18:6a4db94011d3 139 /** Get a function object from the chain
sahilmgandhi 18:6a4db94011d3 140 *
sahilmgandhi 18:6a4db94011d3 141 * @param i function object index
sahilmgandhi 18:6a4db94011d3 142 *
sahilmgandhi 18:6a4db94011d3 143 * @returns
sahilmgandhi 18:6a4db94011d3 144 * The function object at position 'i' in the chain
sahilmgandhi 18:6a4db94011d3 145 */
sahilmgandhi 18:6a4db94011d3 146 pFunctionPointer_t get(int i) const;
sahilmgandhi 18:6a4db94011d3 147
sahilmgandhi 18:6a4db94011d3 148 /** Look for a function object in the call chain
sahilmgandhi 18:6a4db94011d3 149 *
sahilmgandhi 18:6a4db94011d3 150 * @param f the function object to search
sahilmgandhi 18:6a4db94011d3 151 *
sahilmgandhi 18:6a4db94011d3 152 * @returns
sahilmgandhi 18:6a4db94011d3 153 * The index of the function object if found, -1 otherwise.
sahilmgandhi 18:6a4db94011d3 154 */
sahilmgandhi 18:6a4db94011d3 155 int find(pFunctionPointer_t f) const;
sahilmgandhi 18:6a4db94011d3 156
sahilmgandhi 18:6a4db94011d3 157 /** Clear the call chain (remove all functions in the chain).
sahilmgandhi 18:6a4db94011d3 158 */
sahilmgandhi 18:6a4db94011d3 159 void clear();
sahilmgandhi 18:6a4db94011d3 160
sahilmgandhi 18:6a4db94011d3 161 /** Remove a function object from the chain
sahilmgandhi 18:6a4db94011d3 162 *
sahilmgandhi 18:6a4db94011d3 163 * @arg f the function object to remove
sahilmgandhi 18:6a4db94011d3 164 *
sahilmgandhi 18:6a4db94011d3 165 * @returns
sahilmgandhi 18:6a4db94011d3 166 * true if the function object was found and removed, false otherwise.
sahilmgandhi 18:6a4db94011d3 167 */
sahilmgandhi 18:6a4db94011d3 168 bool remove(pFunctionPointer_t f);
sahilmgandhi 18:6a4db94011d3 169
sahilmgandhi 18:6a4db94011d3 170 /** Call all the functions in the chain in sequence
sahilmgandhi 18:6a4db94011d3 171 */
sahilmgandhi 18:6a4db94011d3 172 void call();
sahilmgandhi 18:6a4db94011d3 173
sahilmgandhi 18:6a4db94011d3 174 void operator ()(void) {
sahilmgandhi 18:6a4db94011d3 175 call();
sahilmgandhi 18:6a4db94011d3 176 }
sahilmgandhi 18:6a4db94011d3 177 pFunctionPointer_t operator [](int i) const {
sahilmgandhi 18:6a4db94011d3 178 return get(i);
sahilmgandhi 18:6a4db94011d3 179 }
sahilmgandhi 18:6a4db94011d3 180
sahilmgandhi 18:6a4db94011d3 181 /* disallow copy constructor and assignment operators */
sahilmgandhi 18:6a4db94011d3 182 private:
sahilmgandhi 18:6a4db94011d3 183 CallChain(const CallChain&);
sahilmgandhi 18:6a4db94011d3 184 CallChain & operator = (const CallChain&);
sahilmgandhi 18:6a4db94011d3 185 CallChainLink *_chain;
sahilmgandhi 18:6a4db94011d3 186 };
sahilmgandhi 18:6a4db94011d3 187
sahilmgandhi 18:6a4db94011d3 188 } // namespace mbed
sahilmgandhi 18:6a4db94011d3 189
sahilmgandhi 18:6a4db94011d3 190 #endif
sahilmgandhi 18:6a4db94011d3 191
sahilmgandhi 18:6a4db94011d3 192 /** @}*/