Mercurial > projects > qtd
annotate qt/d1/qt/Signal.d @ 276:501128ac7a2c
signals cleaned up correctly on receiver destruction
| author | maxter |
|---|---|
| date | Tue, 29 Sep 2009 12:00:45 +0000 |
| parents | 073b9153ed8a |
| children | 5df570e79cfc |
| rev | line source |
|---|---|
| 1 | 1 /** |
| 2 * | |
| 3 * Copyright: Copyright QtD Team, 2008-2009 | |
| 4 * Authors: Max Samukha, Eldar Insafutdinov | |
| 5 * License: <a href="http://www.boost.org/LICENSE_1_0.txt>Boost License 1.0</a> | |
| 6 * | |
| 7 * Copyright QtD Team, 2008-2009 | |
| 8 * Distributed under the Boost Software License, Version 1.0. | |
| 9 * (See accompanying file boost-license-1.0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) | |
| 10 * | |
| 11 */ | |
| 16 | 12 module qt.Signal; |
| 1 | 13 |
| 14 public import qt.QGlobal; | |
| 15 import tango.core.Exception; | |
| 16 import tango.core.Traits; | |
| 17 import tango.core.Thread; | |
| 18 import tango.stdc.stdlib : crealloc = realloc, cfree = free; | |
| 19 import tango.stdc.string : memmove; | |
| 20 | |
| 21 private: // private by default | |
| 22 | |
| 23 alias void delegate(Object) DEvent; | |
| 24 | |
| 25 extern(C) void rt_attachDisposeEvent(Object o, DEvent e); | |
| 26 extern(C) void rt_detachDisposeEvent(Object o, DEvent e); | |
| 27 extern(C) Object _d_toObject(void* p); | |
| 28 | |
| 29 void realloc(T)(ref T[] a, size_t length) | |
| 30 { | |
| 31 a = (cast(T*)crealloc(a.ptr, length * T.sizeof))[0..length]; | |
| 32 if (!a.ptr) | |
| 33 new OutOfMemoryException(__FILE__, __LINE__); | |
| 34 } | |
| 35 | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
36 void append(T)(ref T[] a, T element) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
37 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
38 auto newLen = a.length + 1; |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
39 a = (cast(T*)crealloc(a.ptr, newLen * T.sizeof))[0..newLen]; |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
40 if (!a.ptr) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
41 new OutOfMemoryException(__FILE__, __LINE__); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
42 a[newLen - 1] = element; |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
43 } |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
44 |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
45 void move(T)(ref T[] a, size_t src, size_t dest, size_t length) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
46 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
47 if (a.length > 1) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
48 memmove(a.ptr + dest, a.ptr + src, length * T.sizeof); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
49 } |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
50 |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
51 // COMPILER BUG: Though this is private cannot name it 'remove' because of conflicts |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
52 // with Array.remove |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
53 void erase(T)(ref T[] a, size_t i) |
| 1 | 54 { |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
55 auto newLen = a.length - 1; |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
56 move(a, i + 1, i, newLen); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
57 realloc(a, newLen); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
58 } |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
59 |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
60 version (QtdUnittest) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
61 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
62 unittest |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
63 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
64 int[] a; |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
65 realloc(a, 16); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
66 assert(a.length == 16); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
67 foreach (i, ref e; a) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
68 e = i; |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
69 realloc(a, 4096); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
70 assert(a.length == 4096); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
71 foreach (i, e; a[0..16]) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
72 assert(e == i); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
73 cfree(a.ptr); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
74 } |
| 1 | 75 } |
| 76 | |
| 77 // TODO: This one should be replaced with an appropriate library function | |
| 78 char[] __toString(long v) | |
| 79 { | |
| 80 if (v == 0) | |
| 81 return "0"; | |
| 82 | |
| 83 char[] ret; | |
| 84 | |
| 85 bool neg; | |
| 86 if (v < 0) | |
| 87 { | |
| 88 neg = true; | |
| 89 v = -v; | |
| 90 } | |
| 91 | |
| 92 while (v != 0) | |
| 93 { | |
| 94 ret = cast(char)(v % 10 + '0') ~ ret; | |
| 95 v = cast(long)(v / 10); | |
| 96 } | |
| 97 | |
| 98 if (neg) | |
| 99 ret = "-" ~ ret; | |
| 100 | |
| 101 return ret; | |
| 102 } | |
| 103 | |
| 104 template ToString(long i) | |
| 105 { | |
| 106 const string ToString = __toString(i); | |
| 107 } | |
| 108 | |
| 109 //TODO: should be in the standard library | |
| 110 struct STuple(A...) | |
| 111 { | |
| 112 static string genSTuple() | |
| 113 { | |
| 114 string r = ""; | |
| 115 foreach (i, e; A) | |
| 116 r ~= A[i].stringof ~ " _" ~ ToString!(i) ~ ";"; | |
| 117 return r; | |
| 118 } | |
| 119 | |
| 120 mixin (genSTuple); | |
| 121 template at(size_t i) { mixin("alias _" ~ ToString!(i) ~ " at;"); }; | |
| 122 } | |
| 123 | |
| 253 | 124 enum SignalEventId |
| 125 { | |
| 126 firstSlotConnected, | |
| 127 lastSlotDisconnected | |
| 128 } | |
| 1 | 129 |
| 130 public class SignalException : Exception | |
| 131 { | |
| 132 this(char[] msg) | |
| 133 { | |
| 134 super(msg); | |
| 135 } | |
| 136 } | |
| 137 | |
| 138 struct Fn | |
| 139 { | |
| 140 void* funcptr; | |
| 141 | |
| 142 static typeof(*this) opCall(R, A...)(R function(A) fn) | |
| 143 { | |
| 144 typeof(*this) r; | |
| 145 r.funcptr = fn; | |
| 146 return r; | |
| 147 } | |
| 148 | |
| 149 template call(R) | |
| 150 { | |
| 151 R call(A...)(A args) | |
| 152 { | |
| 153 alias R function(A) Fn; | |
| 154 return (cast(Fn)funcptr)(args); | |
| 155 } | |
| 156 } | |
| 157 | |
| 158 S get(S)() | |
| 159 { | |
| 160 static assert (is(typeof(*S.init) == function)); | |
| 161 return cast(S)funcptr; | |
| 162 } | |
| 163 } | |
| 164 | |
| 165 struct Dg | |
| 166 { | |
| 167 void* context; | |
| 168 void* funcptr; | |
| 169 | |
| 170 static typeof(*this) opCall(R, A...)(R delegate(A) dg) | |
| 171 { | |
| 172 typeof(*this) r; | |
| 173 r.context = dg.ptr; | |
| 174 r.funcptr = dg.funcptr; | |
| 175 return r; | |
| 176 } | |
| 177 | |
| 178 template call(R) | |
| 179 { | |
| 180 R call(A...)(A args) | |
| 181 { | |
| 182 R delegate(A) dg; // BUG: parameter storage classes are ignored | |
| 183 dg.ptr = context; | |
| 184 dg.funcptr = cast(typeof(dg.funcptr))funcptr; | |
| 185 return dg(args); | |
| 186 } | |
| 187 } | |
| 188 | |
| 189 S get(S)() | |
| 190 { | |
| 191 static assert (is(S == delegate)); | |
| 192 S r; | |
| 193 r.ptr = context; | |
| 194 r.funcptr = cast(typeof(r.funcptr))funcptr; | |
| 195 return r; | |
| 196 } | |
| 197 } | |
| 198 | |
| 199 struct Slot(R) | |
| 200 { | |
| 201 alias R Receiver; | |
| 202 | |
| 203 Receiver receiver; | |
| 204 Dg invoker; | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
205 ConnectionFlags flags; |
| 1 | 206 |
| 207 static if (is(Receiver == Dg)) | |
| 208 { | |
| 209 static const isDelegate = true; | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
210 |
| 1 | 211 bool isDisposed() |
| 212 { | |
| 213 return !receiver.funcptr; | |
| 214 } | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
215 |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
216 void dispose() |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
217 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
218 receiver.funcptr = null; |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
219 receiver.context = null; |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
220 } |
| 1 | 221 |
| 222 Object getObject() | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
223 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
224 return flags & ConnectionFlags.NoObject || !receiver.context |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
225 ? null : _d_toObject(receiver.context); |
| 1 | 226 } |
| 227 } | |
| 228 else | |
| 229 static const isDelegate = false; | |
| 230 } | |
| 231 | |
| 232 enum SlotListId | |
| 233 { | |
| 234 Func, // function pointers | |
| 235 Weak, // object delegates stored in C heap | |
| 236 Strong // delegates stored in GC heap | |
| 237 } | |
| 238 | |
| 239 /** | |
| 240 Used to specify the type of a signal-to-slot connection. | |
| 241 | |
| 242 Examples: | |
| 243 ---- | |
| 244 class Sender | |
| 245 { | |
| 246 mixin Signal!("changed"); | |
| 247 void change() | |
| 248 { | |
| 249 changed.emit; | |
| 250 } | |
| 251 } | |
| 252 | |
| 253 | |
| 254 class Receiver | |
| 255 { | |
| 256 void alarm() {} | |
| 257 } | |
| 258 | |
| 259 void main() | |
| 260 { | |
| 261 auto s = new Sender; | |
| 262 auto r = new Receiver; | |
| 263 s.changed.connect(&r.alarm); // now s weakly references r | |
| 264 | |
| 265 r = null; | |
| 266 // collect garbage (assume there is no more reachable pointers | |
| 267 // to the receiver and it gets finalized) | |
| 268 ... | |
| 269 | |
| 270 s.change; | |
| 271 // weak reference to the receiving object | |
| 272 // has been removed from the sender's connection lists. | |
| 273 | |
| 274 r = new Receiver; | |
| 275 s.changed.connect(&r.alarm, ConnectionFlags.Strong); | |
| 276 | |
| 277 r = null; | |
| 278 // collect garbage | |
| 279 ... | |
| 280 // the receiving object has not been finalized because s strongly references it. | |
| 281 | |
| 282 s.change; // the receiver is called. | |
| 283 delete r; | |
| 284 s.change; // the receiver is disconnected from the sender. | |
| 285 | |
| 286 static void foo() | |
| 287 { | |
| 288 } | |
| 289 | |
| 290 s.changed.connect(&foo); | |
| 291 s.changed.emit; // foo is called. | |
| 292 s.changed.disconnect(&foo); // must be explicitly disconnected. | |
| 293 | |
| 294 void bar() | |
| 295 { | |
| 296 } | |
| 297 | |
| 298 // ConnectionFlags.NoObject must be specified for delegates | |
| 299 // to non-static local functions or struct member functions. | |
| 300 s.changed.connect(&bar, ConnectionFlags.NoObject); | |
| 301 s.changed.emit; // bar is called. | |
| 302 s.changed.disconnect(&bar); // must be explicitly disconnected. | |
| 303 } | |
| 304 ---- | |
| 305 */ | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
306 public enum ConnectionFlags : ubyte |
| 1 | 307 { |
| 308 /// | |
| 309 None, | |
| 310 /** | |
| 311 The receiver will be stored as weak reference (implied if ConnectionFlags.NoObject is not specified). | |
| 312 If the signal receiver is not a function pointer or a delegate referencing a D class instance. | |
| 313 the sender will not be notified when the receiving object is deleted and emitting the signal | |
| 314 connected to that receiving object will result in undefined behavior. | |
| 315 */ | |
| 316 Weak = 0x0001, | |
| 317 /** | |
| 318 The receiver is stored as strong reference (implied if ConnectionFlags.NoObject is specified). | |
| 319 */ | |
| 320 Strong = 0x0002, | |
| 321 /** | |
| 322 Must be specified if the receiver is not a function pointer or a delegate referencing a D class instance. | |
| 323 */ | |
| 324 NoObject = 0x0004 | |
| 325 | |
| 326 // Queued = 0x0004, | |
| 327 // BlockingQueued = 0x0008 | |
| 328 } | |
| 329 | |
| 330 | |
| 331 struct SlotList(SlotT, bool strong = false) | |
| 332 { | |
| 333 alias SlotT SlotType; | |
| 334 SlotType[] data; | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
335 |
| 1 | 336 void length(size_t length) |
| 337 { | |
| 338 static if (strong) | |
| 339 data.length = length; | |
| 340 else | |
| 341 realloc(data, length); | |
| 342 } | |
| 343 | |
| 344 SlotType* add(SlotType slot) | |
| 345 { | |
| 346 auto oldLen = data.length; | |
| 347 length = oldLen + 1; | |
| 348 auto p = &data[oldLen]; | |
| 349 *p = slot; | |
| 350 return p; | |
| 351 } | |
| 352 | |
| 353 SlotType* get(int slotId) | |
| 354 { | |
| 355 return &data[slotId]; | |
| 356 } | |
| 357 | |
| 358 void remove(int slotId) | |
| 359 { | |
| 360 move(data, slotId, slotId + 1, data.length - slotId - 1); | |
| 361 data = data[0..$ - 1]; | |
| 362 } | |
| 363 | |
| 364 size_t length() | |
| 365 { | |
| 366 return data.length; | |
| 367 } | |
| 368 | |
| 369 void free() | |
| 370 { | |
| 371 static if (!strong) | |
| 372 cfree(data.ptr); | |
| 373 } | |
| 374 } | |
| 375 | |
| 253 | 376 public alias void delegate(int signalId, SignalEventId event) SignalEvent; |
| 1 | 377 |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
378 struct Receivers |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
379 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
380 struct Data |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
381 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
382 Object object; |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
383 int refs; |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
384 } |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
385 |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
386 Data[] data; |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
387 void add(Object receiver, DEvent disposeEvent) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
388 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
389 foreach (ref d; data) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
390 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
391 if (d.object is receiver) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
392 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
393 d.refs++; |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
394 return; |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
395 } |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
396 } |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
397 |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
398 append(data, Data(receiver, 1)); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
399 rt_attachDisposeEvent(receiver, disposeEvent); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
400 } |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
401 |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
402 void remove(Object receiver, DEvent disposeEvent) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
403 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
404 foreach (i, ref d; data) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
405 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
406 if (d.object is receiver) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
407 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
408 assert (d.refs); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
409 d.refs--; |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
410 if (!d.refs) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
411 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
412 .erase(data, i); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
413 rt_detachDisposeEvent(receiver, disposeEvent); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
414 } |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
415 return; |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
416 } |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
417 } |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
418 |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
419 assert (false); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
420 } |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
421 |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
422 // remove all refarences for receiver, receiver has been disposed |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
423 void removeAll(Object receiver) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
424 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
425 foreach (i, ref d; data) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
426 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
427 if (d.object is receiver) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
428 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
429 .erase(data, i); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
430 return; |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
431 } |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
432 } |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
433 } |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
434 |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
435 // remove all references for all receivers, detaching dispose events |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
436 void free(DEvent disposeEvent) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
437 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
438 foreach (i, ref d; data) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
439 rt_detachDisposeEvent(d.object, disposeEvent); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
440 cfree(data.ptr); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
441 data = null; |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
442 } |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
443 } |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
444 |
| 1 | 445 struct SignalConnections |
| 446 { | |
| 447 bool isInUse; | |
| 448 | |
| 449 STuple!( | |
| 450 SlotList!(Slot!(Fn)), | |
| 451 SlotList!(Slot!(Dg)), | |
| 452 SlotList!(Slot!(Dg), true) | |
| 453 ) slotLists; | |
| 454 | |
| 455 STuple!( | |
| 456 Fn[], | |
| 457 Dg[] | |
| 458 ) delayedDisconnects; | |
| 459 | |
| 460 void addDelayedDisconnect(Fn r) | |
| 461 { | |
| 462 delayedDisconnects.at!(0) ~= r; | |
| 463 } | |
| 464 | |
| 465 void addDelayedDisconnect(Dg r) | |
| 466 { | |
| 467 delayedDisconnects.at!(1) ~= r; | |
| 468 } | |
| 469 | |
| 470 SlotListType!(slotListId)* getSlotList(int slotListId)() | |
| 471 { | |
| 472 return &slotLists.tupleof[slotListId]; | |
| 473 } | |
| 474 | |
| 475 bool hasSlots() | |
| 476 { | |
| 477 foreach(i, e; slotLists.tupleof) | |
| 478 { | |
| 479 if (slotLists.tupleof[i].length) | |
| 480 return true; | |
| 481 } | |
| 482 return false; | |
| 483 } | |
| 484 | |
| 485 int slotCount() | |
| 486 { | |
| 487 int count; | |
| 488 foreach(i, e; slotLists.tupleof) | |
| 489 count += slotLists.at!(i).length; | |
| 490 return count; | |
| 491 } | |
| 492 | |
| 493 void slotListLengths(int[] lengths) | |
| 494 { | |
| 495 foreach(i, e; slotLists.tupleof) | |
| 496 lengths[i] = slotLists.at!(i).length; | |
| 497 } | |
| 498 | |
| 499 SlotType!(slotListId)* addSlot(int slotListId)(SlotType!(slotListId) slot) | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
500 { |
| 1 | 501 return getSlotList!(slotListId).add(slot); |
| 502 } | |
| 503 | |
| 504 void removeSlot(int slotListId)(int slotId) | |
| 505 { | |
| 506 slotLists.at!(slotListId).remove(slotId); | |
| 507 } | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
508 |
| 1 | 509 void free() |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
510 { |
| 1 | 511 foreach(i, e; slotLists.tupleof) |
| 512 { | |
| 513 static if (is(typeof(slotLists.at!(i).free))) | |
| 514 slotLists.at!(i).free; | |
| 515 } | |
| 516 } | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
517 |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
518 void onReceiverDisposed(Object receiver) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
519 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
520 foreach (i, e; slotLists.tupleof) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
521 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
522 static if (slotLists.at!(i).SlotType.isDelegate) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
523 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
524 foreach (ref slot; slotLists.at!(i).data) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
525 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
526 if (slot.getObject is receiver) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
527 slot.dispose; |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
528 } |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
529 } |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
530 } |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
531 } |
| 1 | 532 |
| 533 template SlotListType(int slotListId) | |
| 534 { | |
| 535 alias typeof(slotLists.tupleof)[slotListId] SlotListType; | |
| 536 } | |
| 537 | |
| 538 template SlotType(int slotListId) | |
| 539 { | |
| 540 alias SlotListType!(slotListId).SlotType SlotType; | |
| 541 } | |
| 542 | |
| 543 template ReceiverType(int slotListId) | |
| 544 { | |
| 545 alias SlotType!(slotListId).Receiver ReceiverType; | |
| 546 } | |
| 547 | |
| 548 static const slotListCount = slotLists.tupleof.length; | |
| 549 } | |
| 550 | |
| 551 | |
| 552 private ThreadLocal!(Object) signalSender_; | |
| 553 static this() | |
| 554 { | |
| 555 signalSender_ = new ThreadLocal!(Object); | |
| 556 } | |
| 557 | |
| 558 /** | |
| 559 If called from a slot, returns the object | |
| 560 that is emitting the signal. Otherwise, returns null. | |
| 561 */ | |
| 562 public Object signalSender() { | |
| 563 return signalSender_.val; | |
| 564 } | |
| 565 | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
566 public final class SignalHandler |
| 1 | 567 { |
| 568 SignalConnections[] connections; | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
569 Receivers receivers; |
| 1 | 570 Object owner; |
| 571 int blocked; | |
| 253 | 572 |
| 573 SignalEvent signalEvent; | |
| 574 | |
| 1 | 575 alias SignalConnections.SlotType SlotType; |
| 576 alias SignalConnections.ReceiverType ReceiverType; | |
| 577 | |
| 578 public this(Object owner_) { | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
579 owner = owner_; |
| 1 | 580 } |
| 581 | |
| 582 private SignalConnections* getConnections(int signalId) | |
| 583 { | |
| 584 if (signalId < connections.length) | |
| 585 return &connections[signalId]; | |
| 586 return null; | |
| 587 } | |
| 588 | |
| 589 private SlotType!(slotListId)* addSlot(int slotListId)(int signalId, ReceiverType!(slotListId) receiver, | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
590 Dg invoker, ConnectionFlags flags) |
| 1 | 591 { |
| 592 if (signalId >= connections.length) | |
| 593 connections.length = signalId + 1; | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
594 auto slot = connections[signalId].addSlot!(slotListId)(SlotType!(slotListId)(receiver, invoker, flags)); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
595 |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
596 static if (slot.isDelegate) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
597 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
598 if (!(flags & ConnectionFlags.NoObject)) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
599 receivers.add(_d_toObject(receiver.context), &onReceiverDisposed); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
600 } |
| 1 | 601 |
| 253 | 602 if (signalEvent && connections[signalId].slotCount == 1) |
| 603 signalEvent(signalId, SignalEventId.firstSlotConnected); | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
604 |
| 1 | 605 return slot; |
| 606 } | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
607 |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
608 void onReceiverDisposed(Object receiver) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
609 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
610 synchronized(this) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
611 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
612 foreach(ref c; connections) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
613 c.onReceiverDisposed(receiver); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
614 receivers.removeAll(receiver); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
615 } |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
616 } |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
617 |
| 1 | 618 private void removeSlot(int slotListId)(int signalId, int slotId) |
| 619 { | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
620 auto slot = connections[signalId].getSlotList!(slotListId).get(slotId); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
621 static if (slot.isDelegate) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
622 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
623 if (auto obj = slot.getObject) |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
624 receivers.remove(obj, &onReceiverDisposed); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
625 } |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
626 |
| 1 | 627 connections[signalId].removeSlot!(slotListId)(slotId); |
| 628 | |
| 253 | 629 if (signalEvent && !connections[signalId].slotCount) |
| 630 signalEvent(signalId, SignalEventId.lastSlotDisconnected); | |
| 1 | 631 } |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
632 |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
633 |
| 1 | 634 size_t slotCount(int signalId) |
| 635 { | |
| 636 synchronized(this) | |
| 637 { | |
| 638 auto con = getConnections(signalId); | |
| 639 if (con) | |
| 640 return con.slotCount; | |
| 641 return 0; | |
| 642 } | |
| 643 } | |
| 644 | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
645 void connect(Receiver)(int signalId, Receiver receiver, |
| 1 | 646 Dg invoker, ConnectionFlags flags) |
| 647 { | |
| 648 synchronized(this) | |
| 649 { | |
| 650 static if (is(typeof(receiver.context))) | |
| 651 { | |
| 652 Object obj; | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
653 if ((flags & ConnectionFlags.NoObject)) |
| 1 | 654 { |
| 655 // strong by default | |
| 656 if (flags & ConnectionFlags.Weak) | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
657 addSlot!(SlotListId.Weak)(signalId, receiver, invoker, flags); |
| 1 | 658 else |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
659 addSlot!(SlotListId.Strong)(signalId, receiver, invoker, flags); |
| 1 | 660 } |
| 661 else | |
| 662 { | |
| 663 // weak by default | |
| 664 if (flags & ConnectionFlags.Strong) | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
665 addSlot!(SlotListId.Strong)(signalId, receiver, invoker, flags); |
| 1 | 666 else |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
667 addSlot!(SlotListId.Weak)(signalId, receiver, invoker, flags); |
| 1 | 668 } |
| 669 } | |
| 670 else | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
671 { |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
672 flags |= ConnectionFlags.NoObject; |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
673 addSlot!(SlotListId.Func)(signalId, receiver, invoker, flags); |
|
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
674 } |
| 1 | 675 } |
| 676 } | |
| 677 | |
| 678 void disconnect(Receiver)(int signalId, Receiver receiver) | |
| 679 { | |
| 680 synchronized(this) | |
| 681 { | |
| 682 auto cons = getConnections(signalId); | |
| 683 if (!cons) | |
| 684 return; | |
| 685 | |
| 686 // if called from a slot being executed by this signal, delay disconnection | |
| 687 // until all slots has been called. | |
| 688 if (cons.isInUse) | |
| 689 { | |
| 690 cons.addDelayedDisconnect(receiver); | |
| 691 return; | |
| 692 } | |
| 693 | |
| 694 TOP: | |
| 695 foreach (slotListId, e; cons.slotLists.tupleof) | |
| 696 { | |
| 697 /// COMPILER BUG: ReceiverType is evaluated to expression instead of type. | |
| 698 static if (is(typeof(cons.ReceiverType!(slotListId)) == Receiver)) | |
| 699 { | |
| 700 auto slotList = cons.getSlotList!(slotListId); | |
| 701 for (int slotId; slotId < slotList.length;) | |
| 702 { | |
| 703 auto slot = slotList.get(slotId); | |
| 704 static if (slot.isDelegate) | |
| 705 { | |
| 706 if (slot.isDisposed) | |
| 707 { | |
| 708 removeSlot!(slotListId)(signalId, slotId); | |
| 709 continue; | |
| 710 } | |
| 711 } | |
| 712 | |
| 713 if (slot.receiver == receiver) | |
| 714 { | |
| 715 removeSlot!(slotListId)(signalId, slotId); | |
| 716 break TOP; | |
| 717 } | |
| 718 | |
| 719 slotId++; | |
| 720 } | |
| 721 } | |
| 722 } | |
| 723 } | |
| 724 } | |
| 725 | |
| 726 void emit(A...)(size_t signalId, A args) | |
| 727 { | |
| 728 synchronized(this) | |
| 729 { | |
| 730 if (signalId >= connections.length || blocked) | |
| 731 return; | |
| 732 auto cons = &connections[signalId]; | |
| 733 | |
| 734 if (cons.hasSlots) | |
| 735 { | |
| 736 { | |
| 737 cons.isInUse = true; | |
| 738 signalSender_.val = owner; | |
| 739 scope(exit) | |
| 740 { | |
| 741 cons.isInUse = false; | |
| 742 signalSender_.val = null; | |
| 743 } | |
| 744 | |
| 745 // Store the lengths to avoid calling new slots | |
| 746 // connected in the slots being called. | |
| 747 // dmd bug: int[cons.slotListCount] fails | |
| 748 static const c = cons.slotListCount; | |
| 749 int[c] lengths = void; | |
| 750 cons.slotListLengths(lengths); | |
| 751 | |
| 752 foreach (slotListId, e; cons.slotLists.tupleof) | |
| 753 { | |
| 754 auto slotList = cons.getSlotList!(slotListId); | |
| 755 for (size_t slotId; slotId < lengths[slotListId];) | |
| 756 { | |
| 757 auto slot = slotList.get(slotId); | |
| 758 static if (slot.isDelegate) | |
| 759 { | |
| 760 if (slot.isDisposed) | |
| 761 { | |
| 762 removeSlot!(slotListId)(signalId, slotId); | |
| 763 lengths[slotListId]--; | |
| 764 continue; | |
| 765 } | |
| 766 } | |
| 767 | |
| 768 slot.invoker.call!(void)(slot.receiver, args); | |
| 769 ++slotId; | |
| 770 } | |
| 771 } | |
| 772 } | |
| 773 | |
| 774 | |
| 775 // process delayed disconnects if any | |
| 776 foreach(i, e; cons.delayedDisconnects.tupleof) | |
| 777 { | |
| 778 if (cons.delayedDisconnects.at!(i).length) | |
| 779 { | |
| 780 foreach (d; cons.delayedDisconnects.at!(i)) | |
| 781 disconnect(signalId, d); | |
| 782 cons.delayedDisconnects.at!(i).length = 0; | |
| 783 } | |
| 784 } | |
| 785 } | |
| 786 } | |
| 787 } | |
| 788 | |
| 789 // Adjusts signal arguments and calls the slot. S - slot signature, A - signal arguments | |
| 790 private void invokeSlot(S, Receiver, A...)(Receiver r, A args) | |
| 791 { | |
| 792 r.get!(S)()(args[0..ParameterTupleOf!(S).length]); | |
| 793 } | |
| 794 | |
| 795 void blockSignals() | |
| 796 { | |
| 797 synchronized(this) | |
| 798 blocked++; | |
| 799 } | |
| 800 | |
| 801 void unblockSignals() | |
| 802 { | |
| 803 synchronized(this) | |
| 804 { | |
| 805 if(!blocked) | |
| 806 throw new SignalException("Signals are not blocked"); | |
| 807 blocked--; | |
| 808 } | |
| 809 } | |
| 810 | |
| 811 ~this() | |
| 812 { | |
|
276
501128ac7a2c
signals cleaned up correctly on receiver destruction
maxter
parents:
253
diff
changeset
|
813 receivers.free(&onReceiverDisposed); |
| 1 | 814 foreach(ref c; connections) |
| 815 c.free; | |
| 816 } | |
| 817 } | |
| 818 | |
| 819 //TODO: this could be avoided if named mixins didn't suck. | |
| 820 public struct SignalOps(int sigId, A...) | |
| 821 { | |
| 822 private SignalHandler sh; | |
| 823 enum { signalId = sigId } | |
| 824 | |
| 825 void connect(R, B...)(R function(B) fn, ConnectionFlags flags = ConnectionFlags.None) | |
| 826 { | |
| 827 alias CheckSlot!(typeof(fn), A) check; | |
| 828 auto invoker = Dg(&sh.invokeSlot!(typeof(fn), Fn, A)); | |
| 829 sh.connect(signalId, Fn(fn), invoker, flags); | |
| 830 } | |
| 831 | |
| 832 void connect(R, B...)(R delegate(B) dg, ConnectionFlags flags = ConnectionFlags.None) | |
| 833 { | |
| 834 alias CheckSlot!(typeof(dg), A) check; | |
| 835 auto invoker = Dg(&sh.invokeSlot!(typeof(dg), Dg, A)); | |
| 836 sh.connect(signalId, Dg(dg), invoker, flags); | |
| 837 } | |
| 838 | |
| 839 void disconnect(R, B...)(R function(B) fn) | |
| 840 { | |
| 841 sh.disconnect(signalId, Fn(fn)); | |
| 842 } | |
| 843 | |
| 844 void disconnect(R, B...)(R delegate(B) dg) | |
| 845 { | |
| 846 sh.disconnect(signalId, Dg(dg)); | |
| 847 } | |
| 848 | |
| 849 void emit(A args) | |
| 850 { | |
| 851 sh.emit(signalId, args); | |
| 852 } | |
| 853 | |
| 854 debug size_t slotCount() | |
| 855 { | |
| 856 return sh.slotCount(signalId); | |
| 857 } | |
| 858 } | |
| 859 | |
| 860 template CheckSlot(Slot, A...) | |
| 861 { | |
| 862 static assert(ParameterTupleOf!(Slot).length <= A.length, "Slot " ~ ParameterTypeTuple!(Slot).stringof ~ | |
| 863 " has more prameters than signal " ~ A.stringof); | |
| 864 alias CheckSlotImpl!(Slot, 0, A) check; | |
| 865 } | |
| 866 | |
| 867 template CheckSlotImpl(Slot, int i, A...) | |
| 868 { | |
| 869 alias ParameterTupleOf!(Slot) SlotArgs; | |
| 870 static if (i < SlotArgs.length) | |
| 871 { | |
| 872 static assert (is(SlotArgs[i] : A[i]), "Argument " ~ __toString(i) ~ | |
| 873 ":" ~ A[i].stringof ~ " of signal " ~ A.stringof ~ " is not implicitly convertible to parameter " | |
| 874 ~ SlotArgs[i].stringof ~ " of slot " ~ SlotArgs.stringof); | |
| 875 alias CheckSlotImpl!(Slot, i + 1, A) next; | |
| 876 } | |
| 877 } | |
| 878 | |
| 879 public template SignalHandlerOps() | |
| 880 { | |
| 881 static assert (is(typeof(this.signalHandler)), | |
| 882 "SignalHandlerOps is already instantiated in " ~ typeof(this).stringof ~ " or one of its base classes"); | |
| 883 | |
| 884 protected: | |
| 885 SignalHandler signalHandler_; // manages signal-to-slot connections | |
| 886 | |
| 887 final SignalHandler signalHandler() | |
| 888 { | |
| 889 if (!signalHandler_) | |
| 890 { | |
| 891 signalHandler_ = new SignalHandler(this); | |
| 892 onSignalHandlerCreated(signalHandler_); | |
| 893 } | |
| 894 return signalHandler_; | |
| 895 } | |
| 896 | |
| 897 void onSignalHandlerCreated(ref SignalHandler sh) | |
| 898 { | |
| 899 } | |
| 900 | |
| 901 public: | |
| 902 final void blockSignals() | |
| 903 { | |
| 904 signalHandler.blockSignals(); | |
| 905 } | |
| 906 | |
| 907 final void unblockSignals() | |
| 908 { | |
| 909 signalHandler.unblockSignals(); | |
| 910 } | |
| 911 } | |
| 912 | |
| 913 /** | |
| 914 Examples: | |
| 915 ---- | |
| 916 struct Args | |
| 917 { | |
| 918 bool cancel; | |
| 919 } | |
| 920 | |
| 921 class C | |
| 922 { | |
| 923 private int _x; | |
| 924 // reference parameters are not supported yet, | |
| 925 // so we pass arguments by pointer. | |
| 926 mixin Signal!("xChanging", int, Args*); | |
| 927 mixin Signal!("xChanged"); | |
| 928 | |
| 929 void x(int v) | |
| 930 { | |
| 931 if (v != _x) | |
| 932 { | |
| 933 Args args; | |
| 934 xChanging.emit(v, &args); | |
| 935 if (!args.cancel) | |
| 936 { | |
| 937 _x = v; | |
| 938 xChanged.emit; | |
| 939 } | |
| 940 } | |
| 941 } | |
| 942 } | |
| 943 ---- | |
| 944 */ | |
| 945 template Signal(string name, A...) | |
| 946 { | |
| 947 mixin SignalImpl!(0, name, A); | |
| 948 } | |
| 949 | |
| 950 template SignalImpl(int index, string name, A...) | |
| 951 { | |
| 952 static if (is(typeof(mixin(typeof(this).stringof ~ ".__sig" ~ ToString!(index))))) | |
| 953 mixin SignalImpl!(index + 1, name, A); | |
| 954 else | |
| 955 { | |
| 956 // mixed-in once | |
| 957 static if (!is(typeof(this.signalHandler))) | |
| 958 { | |
| 959 mixin SignalHandlerOps; | |
| 960 } | |
| 961 mixin("private static const int __sig" ~ ToString!(index) ~ " = " ~ ToString!(index) ~ ";"); | |
| 962 mixin("SignalOps!(" ~ ToString!(index) ~ ", A) " ~ name ~ "(){ return SignalOps!(" | |
| 963 ~ ToString!(index) ~ ", A)(signalHandler); }"); | |
| 964 } | |
| 965 } | |
| 966 | |
| 967 extern(C) alias void function(void*) SlotConnector; | |
| 968 | |
| 969 debug (UnitTest) | |
| 970 { | |
| 971 class A | |
| 972 { | |
| 973 mixin Signal!("scorched", int); | |
| 974 | |
| 975 int signalId1 = -1; | |
| 976 int signalId2 = -1; | |
| 977 | |
| 978 void onFirstConnect(int sId) | |
| 979 { | |
| 980 signalId1 = sId; | |
| 981 } | |
| 982 | |
| 983 void onLastDisconnect(int sId) | |
| 984 { | |
| 985 signalId2 = sId; | |
| 986 } | |
| 987 | |
| 988 this() | |
| 989 { | |
| 990 signalHandler.firstSlotConnected = &onFirstConnect; | |
| 991 signalHandler.lastSlotDisconnected = &onLastDisconnect; | |
| 992 } | |
| 993 } | |
| 994 | |
| 995 class B : A | |
| 996 { | |
| 997 mixin Signal!("booed", int); | |
| 998 | |
| 999 int bazSum; | |
| 1000 void baz(int i) | |
| 1001 { | |
| 1002 bazSum += i; | |
| 1003 } | |
| 1004 } | |
| 1005 | |
| 1006 class C : A | |
| 1007 { | |
| 1008 mixin Signal!("cooked"); | |
| 1009 } | |
| 1010 } | |
| 1011 | |
| 1012 unittest | |
| 1013 { | |
| 1014 static int fooSum; | |
| 1015 static int barSum; | |
| 1016 | |
| 1017 static void foo(int i) | |
| 1018 { | |
| 1019 fooSum += i; | |
| 1020 } | |
| 1021 | |
| 1022 void bar(long i) | |
| 1023 { | |
| 1024 barSum += i; | |
| 1025 } | |
| 1026 | |
| 1027 auto a = new A; | |
| 1028 auto b = new B; | |
| 1029 auto c = new C; | |
| 1030 assert(b.scorched.signalId == 0); | |
| 1031 assert(b.booed.signalId == 1); | |
| 1032 assert(c.cooked.signalId == 1); | |
| 1033 | |
| 1034 auto sh = b.signalHandler; | |
| 1035 | |
| 1036 b.scorched.connect(&foo); | |
| 1037 assert(sh.connections.length == 1); | |
| 1038 assert(b.signalId1 == 0); | |
| 1039 auto scCons = &sh.connections[0]; | |
| 1040 | |
| 1041 assert(scCons.getSlotList!(SlotListId.Func).length == 1); | |
| 1042 b.scorched.emit(1); | |
| 1043 assert(fooSum == 1); | |
| 1044 | |
| 1045 b.scorched.connect(&bar, ConnectionFlags.NoObject); | |
| 1046 assert(sh.connections.length == 1); | |
| 1047 assert(scCons.getSlotList!(SlotListId.Strong).length == 1); | |
| 1048 b.scorched.emit(1); | |
| 1049 assert (fooSum == 2 && barSum == 1); | |
| 1050 | |
| 1051 b.scorched.connect(&b.baz); | |
| 1052 assert(scCons.getSlotList!(SlotListId.Weak).length == 1); | |
| 1053 b.scorched.emit(1); | |
| 1054 assert (fooSum == 3 && barSum == 2 && b.bazSum == 1); | |
| 1055 | |
| 1056 b.scorched.disconnect(&bar); | |
| 1057 assert(scCons.slotCount == 2); | |
| 1058 b.scorched.disconnect(&b.baz); | |
| 1059 assert(scCons.slotCount == 1); | |
| 1060 b.scorched.disconnect(&foo); | |
| 1061 assert(scCons.slotCount == 0); | |
| 1062 assert(b.signalId2 == 0); | |
| 1063 | |
| 1064 fooSum = 0; | |
| 1065 void connectFoo() | |
| 1066 { | |
| 1067 b.scorched.connect(&foo); | |
| 1068 b.scorched.disconnect(&connectFoo); | |
| 1069 } | |
| 1070 | |
| 1071 b.scorched.connect(&connectFoo, ConnectionFlags.NoObject); | |
| 1072 b.scorched.emit(1); | |
| 1073 assert(scCons.getSlotList!(SlotListId.Func).length == 1); | |
| 1074 assert(scCons.getSlotList!(SlotListId.Strong).length == 0); | |
| 1075 assert(!fooSum); | |
| 1076 | |
| 1077 auto r = new B(); | |
| 1078 b.scorched.connect(&r.baz); | |
| 1079 assert(scCons.getSlotList!(SlotListId.Weak).length == 1); | |
| 1080 b.scorched.emit(1); | |
| 1081 assert(r.bazSum == 1); | |
| 1082 assert(fooSum == 1); | |
| 1083 | |
| 1084 delete(r); | |
| 1085 assert(scCons.getSlotList!(SlotListId.Weak).length == 1); | |
| 1086 b.scorched.emit(1); | |
| 1087 assert(scCons.getSlotList!(SlotListId.Weak).length == 0); | |
| 1088 } |