src/FbTk/Signal.hh (raw)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 |
// Signal.hh for FbTk, Fluxbox Toolkit // Copyright (c) 2008 Henrik Kinnunen (fluxgen at fluxbox dot org) // // Permission is hereby granted, free of charge, to any person obtaining a // copy of this software and associated documentation files (the "Software"), // to deal in the Software without restriction, including without limitation // the rights to use, copy, modify, merge, publish, distribute, sublicense, // and/or sell copies of the Software, and to permit persons to whom the // Software is furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in // all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER // DEALINGS IN THE SOFTWARE. #ifndef FBTK_SIGNAL_HH #define FBTK_SIGNAL_HH #include "Slot.hh" #include <list> #include <map> #include <vector> #include <set> namespace FbTk { /// \namespace Implementation details for signals, do not use anything in this namespace namespace SigImpl { /** * Parent class for all \c Signal[0...*] classes. * It handles the disconnect and holds all the slots. The connect must be * handled by the child class so it can do the type checking. */ class SignalHolder { public: /// Special tracker interface used by SignalTracker. class Tracker { public: virtual ~Tracker() { } /// Disconnect this holder. virtual void disconnect(SignalHolder& signal) = 0; }; /// Do not use this type outside this class typedef std::list<SlotHolder> SlotList; typedef SlotList::iterator Iterator; typedef Iterator SlotID; typedef SlotList::const_iterator ConstIterator; ~SignalHolder() { // Disconnect this holder from all trackers. for (Trackers::iterator it = m_trackers.begin(), it_end = m_trackers.end(); it != it_end; ++it ) { (*it)->disconnect(*this); } } /// Remove a specific slot \c id from this signal void disconnect(SlotID slotIt) { m_slots.erase( slotIt ); } /// Removes all slots connected to this void clear() { m_slots.clear(); } void connectTracker(SignalHolder::Tracker& tracker) { m_trackers.insert(&tracker); } void disconnectTracker(SignalHolder::Tracker& tracker) { m_trackers.erase(&tracker); } protected: ConstIterator begin() const { return m_slots.begin(); } ConstIterator end() const { return m_slots.end(); } Iterator begin() { return m_slots.begin(); } Iterator end() { return m_slots.end(); } /// Connect a slot to this signal. Must only be called by child classes. SlotID connect(const SlotHolder& slot) { return m_slots.insert(m_slots.end(), slot); } private: typedef std::set<Tracker*> Trackers; SlotList m_slots; ///< all slots connected to a signal Trackers m_trackers; ///< all instances that tracks this signal. }; /// Signal with no argument template <typename ReturnType> class Signal0: public SignalHolder { public: typedef Slot0<ReturnType> SlotType; ~Signal0() { } void emit() { for ( Iterator it = begin(); it != end(); ++it ) { static_cast<SlotType&>(*it)(); } } SlotID connect(const SlotType& slot) { return SignalHolder::connect(slot); } }; /// Signal with one argument template <typename ReturnType, typename Arg1> class Signal1: public SignalHolder { public: typedef Slot1<ReturnType, Arg1> SlotType; ~Signal1() { } void emit(Arg1 arg) { for ( Iterator it = begin(); it != end(); ++it ) { static_cast<SlotType&>(*it)(arg); } } SlotID connect(const SlotType& slot) { return SignalHolder::connect(slot); } }; /// Signal with two arguments template <typename ReturnType, typename Arg1, typename Arg2> class Signal2: public SignalHolder { public: typedef Slot2<ReturnType, Arg1, Arg2> SlotType; ~Signal2() { } void emit(Arg1 arg1, Arg2 arg2) { for ( Iterator it = begin(); it != end(); ++it ) { static_cast<SlotType&>(*it)(arg1, arg2); } } SlotID connect(const SlotType& slot) { return SignalHolder::connect(slot); } }; /// Signal with three arguments template <typename ReturnType, typename Arg1, typename Arg2, typename Arg3> class Signal3: public SignalHolder { public: typedef Slot3<ReturnType, Arg1, Arg2, Arg3> SlotType; ~Signal3() { } void emit(Arg1 arg1, Arg2 arg2, Arg3 arg3) { for ( Iterator it = begin(); it != end(); ++it ) { static_cast<SlotType&>(*it)(arg1, arg2, arg3); } } SlotID connect(const SlotType& slot) { return SignalHolder::connect(slot); } }; struct EmptyArg {}; } // namespace SigImpl /// Specialization for three arguments. template <typename ReturnType, typename Arg1 = SigImpl::EmptyArg, typename Arg2 = SigImpl::EmptyArg, typename Arg3 = SigImpl::EmptyArg > class Signal: public SigImpl::Signal3< ReturnType, Arg1, Arg2, Arg3 > { public: }; /// Specialization for two arguments. template <typename ReturnType, typename Arg1, typename Arg2> class Signal<ReturnType, Arg1, Arg2, SigImpl::EmptyArg>: public SigImpl::Signal2< ReturnType, Arg1, Arg2 > { public: }; /// Specialization for one argument. template <typename ReturnType, typename Arg1> class Signal<ReturnType, Arg1, SigImpl::EmptyArg, SigImpl::EmptyArg>: public SigImpl::Signal1< ReturnType, Arg1 > { public: }; /// Specialization for no argument. template <typename ReturnType> class Signal<ReturnType, SigImpl::EmptyArg, SigImpl::EmptyArg, SigImpl::EmptyArg>: public SigImpl::Signal0< ReturnType > { public: }; /** * Tracks a signal during it's life time. All signals connected using \c * SignalTracker::join will be erased when this instance dies. */ class SignalTracker: public SigImpl::SignalHolder::Tracker { public: /// Internal type, do not use. typedef std::map<SigImpl::SignalHolder*, SigImpl::SignalHolder::SlotID> Connections; typedef Connections::iterator TrackID; ///< \c ID type for join/leave. ~SignalTracker() { leaveAll(); } /// Starts tracking a signal. /// @return A tracking ID template <typename Signal, typename Functor> TrackID join(Signal& sig, const Functor& functor) { ValueType value = ValueType(&sig, sig.connect(functor)); std::pair<TrackID, bool> ret = m_connections.insert(value); if ( !ret.second ) { // failed to insert this functor sig.disconnect(value.second); } sig.connectTracker(*this); return ret.first; } /// Leave tracking for a signal /// @param id the \c id from the previous \c join void leave(TrackID id, bool withTracker = false) { // keep temporary, while disconnecting we can // in some strange cases get a call to this again ValueType tmp = *id; m_connections.erase(id); tmp.first->disconnect(tmp.second); if (withTracker) tmp.first->disconnectTracker(*this); } /// Leave tracking for a signal /// @param sig the signal to leave template <typename Signal> void leave(Signal &sig) { Iterator it = m_connections.find(&sig); if (it != m_connections.end()) { leave(it); } } void leaveAll() { // disconnect all connections for ( ; !m_connections.empty(); ) { leave(m_connections.begin(), true); } } protected: virtual void disconnect(SigImpl::SignalHolder& signal) { m_connections.erase(&signal); } private: typedef Connections::value_type ValueType; typedef Connections::iterator Iterator; /// holds all connections to different signals and slots. Connections m_connections; }; } // namespace FbTk #endif // FBTK_SIGNAL_HH |