Mercurial > projects > dynamin
annotate dynamin/core/event.d @ 77:c9a4850926d9
Remove a couple not helpful comments (because moving memory does not save it) and add a helpful one.
author | Jordan Miner <jminer7@gmail.com> |
---|---|
date | Sat, 06 Feb 2010 15:11:57 -0600 |
parents | c2566ab82535 |
children | 651082a9b364 |
rev | line source |
---|---|
0 | 1 // Written in the D programming language |
2 // www.digitalmars.com/d/ | |
3 | |
4 /* | |
5 * The contents of this file are subject to the Mozilla Public License Version | |
6 * 1.1 (the "License"); you may not use this file except in compliance with | |
7 * the License. You may obtain a copy of the License at | |
8 * http://www.mozilla.org/MPL/ | |
9 * | |
10 * Software distributed under the License is distributed on an "AS IS" basis, | |
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License | |
12 * for the specific language governing rights and limitations under the | |
13 * License. | |
14 * | |
15 * The Original Code is the Dynamin library. | |
16 * | |
17 * The Initial Developer of the Original Code is Jordan Miner. | |
18 * Portions created by the Initial Developer are Copyright (C) 2006-2009 | |
19 * the Initial Developer. All Rights Reserved. | |
20 * | |
21 * Contributor(s): | |
22 * Jordan Miner <jminer7@gmail.com> | |
23 * | |
24 */ | |
25 | |
26 module dynamin.core.event; | |
27 | |
28 import tango.io.Stdout; | |
29 import dynamin.core.global; | |
30 import tango.core.Exception; | |
7
1311fae1ca9b
Change template mixin (still unused) to take a dispatcher
Jordan Miner <jminer7@gmail.com>
parents:
0
diff
changeset
|
31 public import tango.core.Traits; |
0 | 32 |
33 /** | |
10
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
34 * A struct used to notify handlers of an event. It is similar to .NET's events. |
0 | 35 * Here is an example of its usage: |
36 * ----- | |
37 * class Control { | |
38 * public { | |
39 * protected void whenPainting(PaintingEventArgs e) { | |
40 * /+ painting code goes here +/ | |
41 * } | |
10
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
42 * Event!(whenPainting) painting; |
0 | 43 * this() { |
10
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
44 * painting.mainHandler = &whenPainting; |
0 | 45 * } |
46 * } | |
47 * } | |
48 * ----- | |
49 * Then to add a handler to it: | |
50 * ----- | |
51 * Control control = new Control(); | |
52 * control.painting += (PaintingEventArgs e) { | |
53 * /+ painting code goes here +/ | |
54 * }; | |
55 * ----- | |
56 * And fire it in the Control like this: | |
57 * ----- | |
58 * painting(new PaintingEventArgs()); | |
59 * ----- | |
60 * Not as easy to use as I would like, but still much better than Java's | |
61 * event handling. | |
62 * When the event is fired, all the handlers are called first, followed | |
63 * by the delegate passed into the constructor. | |
64 */ | |
10
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
65 struct Event(alias mainHandler_) { |
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
66 alias ParameterTupleOf!(mainHandler_)[0] ArgsType; |
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
67 /// void delegate(ArgsType e) |
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
68 public alias void delegate(ArgsType e) Handler; |
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
69 /// void delegate(ArgsType e) |
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
70 public alias void delegate(ArgsType e) Dispatcher; |
0 | 71 |
10
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
72 Handler[] handlers; |
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
73 /// |
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
74 Handler mainHandler; |
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
75 /// |
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
76 Dispatcher dispatcher; |
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
77 void defaultDispatch(ArgsType e) { |
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
78 callHandlers(e); |
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
79 callMainHandler(e); |
0 | 80 } |
10
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
81 |
0 | 82 /** |
83 * Calls all the handlers added to this event, passing e to them. | |
84 */ | |
10
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
85 void opCall(ArgsType e) { |
0 | 86 if(e is null) |
87 Stdout("Warning: EventArgs null").newline; | |
10
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
88 if(!dispatcher.funcptr) |
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
89 defaultDispatch(e); |
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
90 else |
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
91 dispatcher(e); |
0 | 92 } |
93 /** | |
10
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
94 * Adds the specified handler to this event. The handler will be called |
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
95 * when the event is fired. |
0 | 96 */ |
10
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
97 void opAddAssign(Handler handler) { |
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
98 if(!handler.funcptr) throw new Exception("handler cannot be null"); |
0 | 99 handlers.length = handlers.length + 1; |
100 handlers[length-1] = handler; | |
101 // TODO: use a list? | |
7
1311fae1ca9b
Change template mixin (still unused) to take a dispatcher
Jordan Miner <jminer7@gmail.com>
parents:
0
diff
changeset
|
102 //handlers.add(handler); |
0 | 103 } |
104 /// ditto | |
105 void opAddAssign(void delegate() handler) { | |
106 struct Foo { | |
107 void delegate() handler; | |
10
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
108 void wrapper(ArgsType e) { handler(); } |
0 | 109 } |
110 Foo* f = new Foo; | |
111 f.handler = handler; | |
10
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
112 *this += &f.wrapper; |
0 | 113 // I really wish D could do this: |
10
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
114 //this += (ArgsType e) { handler(); }; |
0 | 115 } |
116 /// TODO: implement this method | |
10
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
117 void opSubAssign(Handler handler) { |
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
118 throw new Exception("removing handlers not yet implemented"); |
0 | 119 } |
120 /** | |
121 * Calls the handlers (not including the main handler) added to this event. | |
122 * Only use this method from a method that does custom dispatching. | |
123 */ | |
10
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
124 void callHandlers(ArgsType e) { |
0 | 125 foreach(handler; handlers) |
126 handler(e); | |
127 } | |
128 /** | |
129 * Calls the main handler unless the StopEventArgs.stopped has been | |
130 * set to true. | |
131 * Only use this method from a method that does custom dispatching. | |
132 */ | |
10
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
133 void callMainHandler(ArgsType e) { |
0 | 134 auto stopEventArgs = cast(StopEventArgs)e; |
10
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
135 // if e is an instance of StopEventArgs, then check if it is stopped |
0 | 136 if(stopEventArgs is null || !stopEventArgs.stopped) |
137 mainHandler(e); | |
138 } | |
139 } | |
140 | |
7
1311fae1ca9b
Change template mixin (still unused) to take a dispatcher
Jordan Miner <jminer7@gmail.com>
parents:
0
diff
changeset
|
141 // usage: mixin Event!(whenMoved) moved; |
1311fae1ca9b
Change template mixin (still unused) to take a dispatcher
Jordan Miner <jminer7@gmail.com>
parents:
0
diff
changeset
|
142 // mixin Event!(whenMoved, dispatchMoved) moved; |
1311fae1ca9b
Change template mixin (still unused) to take a dispatcher
Jordan Miner <jminer7@gmail.com>
parents:
0
diff
changeset
|
143 template Event2(alias mainHandler, alias dispatcher) { |
1311fae1ca9b
Change template mixin (still unused) to take a dispatcher
Jordan Miner <jminer7@gmail.com>
parents:
0
diff
changeset
|
144 private: |
0 | 145 alias ParameterTupleOf!(mainHandler)[0] ArgsType; |
146 /// void delegate(ArgsType e) | |
147 public alias void delegate(ArgsType e) Handler; | |
148 /// void delegate(ArgsType e) | |
149 public alias void delegate(ArgsType e) Dispatcher; | |
150 | |
151 // TODO: use a list-like struct? | |
152 Handler[] handlers; | |
153 public: | |
154 | |
155 /** | |
156 * Calls all the handlers added to this event, passing e to them. | |
157 */ | |
158 void opCall(ArgsType e) { | |
159 if(e is null) | |
160 Stdout("Warning: EventArgs null").newline; | |
7
1311fae1ca9b
Change template mixin (still unused) to take a dispatcher
Jordan Miner <jminer7@gmail.com>
parents:
0
diff
changeset
|
161 dispatcher(e); |
0 | 162 } |
163 /** | |
164 * Adds the specified handler to this event. The handler will be called | |
165 * when the event is fired. | |
166 */ | |
167 void opAddAssign(Handler handler) { | |
168 if(!handler.funcptr) throw new Exception("handler cannot be null"); | |
169 handlers.length = handlers.length + 1; | |
170 handlers[length-1] = handler; | |
171 // TODO: use a list? | |
7
1311fae1ca9b
Change template mixin (still unused) to take a dispatcher
Jordan Miner <jminer7@gmail.com>
parents:
0
diff
changeset
|
172 //handlers.add(handler); |
0 | 173 } |
174 /// ditto | |
175 void opAddAssign(void delegate() handler) { | |
176 struct Foo { | |
177 void delegate() handler; | |
178 void wrapper(ArgsType e) { handler(); } | |
179 } | |
180 Foo* f = new Foo; | |
181 f.handler = handler; | |
182 this += &f.wrapper; | |
183 // I really wish D could do this: | |
184 //this += (ArgsType e) { handler(); }; | |
185 } | |
186 /// TODO: implement this method | |
187 void opSubAssign(Handler handler) { | |
188 throw new Exception("removing handlers not yet implemented"); | |
189 } | |
190 /** | |
191 * Calls the handlers (not including the main handler) added to this event. | |
192 * Only use this method from a method that does custom dispatching. | |
193 */ | |
194 void callHandlers(ArgsType e) { | |
195 foreach(handler; handlers) | |
196 handler(e); | |
197 } | |
198 /** | |
7
1311fae1ca9b
Change template mixin (still unused) to take a dispatcher
Jordan Miner <jminer7@gmail.com>
parents:
0
diff
changeset
|
199 * Calls the main handler unless the StopEventArgs.stopped has been |
0 | 200 * set to true. |
201 * Only use this method from a method that does custom dispatching. | |
202 */ | |
203 void callMainHandler(ArgsType e) { | |
204 auto stopEventArgs = cast(StopEventArgs)e; | |
205 // if e is an instance of StopEventArgs, then check if it is stopped | |
206 if(stopEventArgs is null || !stopEventArgs.stopped) | |
207 mainHandler(e); | |
208 } | |
209 } | |
210 | |
7
1311fae1ca9b
Change template mixin (still unused) to take a dispatcher
Jordan Miner <jminer7@gmail.com>
parents:
0
diff
changeset
|
211 template Event2(alias mainHandler) { |
1311fae1ca9b
Change template mixin (still unused) to take a dispatcher
Jordan Miner <jminer7@gmail.com>
parents:
0
diff
changeset
|
212 alias ParameterTupleOf!(mainHandler)[0] ArgsType; |
1311fae1ca9b
Change template mixin (still unused) to take a dispatcher
Jordan Miner <jminer7@gmail.com>
parents:
0
diff
changeset
|
213 void defaultDispatch(ArgsType e) { |
1311fae1ca9b
Change template mixin (still unused) to take a dispatcher
Jordan Miner <jminer7@gmail.com>
parents:
0
diff
changeset
|
214 callHandlers(e); |
1311fae1ca9b
Change template mixin (still unused) to take a dispatcher
Jordan Miner <jminer7@gmail.com>
parents:
0
diff
changeset
|
215 callMainHandler(e); |
1311fae1ca9b
Change template mixin (still unused) to take a dispatcher
Jordan Miner <jminer7@gmail.com>
parents:
0
diff
changeset
|
216 } |
1311fae1ca9b
Change template mixin (still unused) to take a dispatcher
Jordan Miner <jminer7@gmail.com>
parents:
0
diff
changeset
|
217 mixin Event2!(mainHandler, defaultDispatch); |
1311fae1ca9b
Change template mixin (still unused) to take a dispatcher
Jordan Miner <jminer7@gmail.com>
parents:
0
diff
changeset
|
218 } |
1311fae1ca9b
Change template mixin (still unused) to take a dispatcher
Jordan Miner <jminer7@gmail.com>
parents:
0
diff
changeset
|
219 |
0 | 220 /// The base class for passing arguments to event handlers. |
221 // TODO: shorter name? | |
222 class EventArgs { | |
223 } | |
10
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
224 /// |
0 | 225 class StopEventArgs : EventArgs { |
226 /** | |
10
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
227 * If stopped is set to true, then the Control will not respond to |
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
228 * the event. For instance, if a key is typed while a text box is focused, |
ccc108b25a0a
Convert to using a struct for events. Fix some comments too.
Jordan Miner <jminer7@gmail.com>
parents:
7
diff
changeset
|
229 * but a handler sets stopped to true, the text box will not |
0 | 230 * respond to the key. |
231 */ | |
232 bool stopped = false; | |
233 } |