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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
|
/*
* tclWinNotify.c --
*
* This file contains Windows-specific procedures for the notifier,
* which is the lowest-level part of the Tcl event loop. This file
* works together with ../generic/tclNotify.c.
*
* Copyright (c) 1995-1997 Sun Microsystems, Inc.
*
* See the file "license.terms" for information on usage and redistribution
* of this file, and for a DISCLAIMER OF ALL WARRANTIES.
*
* RCS: @(#) $Id: tclWinNotify.c,v 1.1.2.5 1999/03/11 01:50:34 stanton Exp $
*/
#include "tclWinInt.h"
#include <winsock.h>
/*
* The follwing static indicates whether this module has been initialized.
*/
static int initialized = 0;
#define INTERVAL_TIMER 1 /* Handle of interval timer. */
#define WM_WAKEUP WM_USER /* Message that is send by
* TclpAlertNotifier. */
/*
* The following static structure contains the state information for the
* Windows implementation of the Tcl notifier. One of these structures
* is created for each thread that is using the notifier.
*/
typedef struct ThreadSpecificData {
CRITICAL_SECTION crit; /* Monitor for this notifier. */
int pending; /* Alert message pending, this field is
* locked by the notifierMutex. */
HWND hwnd; /* Messaging window. */
int timeout; /* Current timeout value. */
int timerActive; /* 1 if interval timer is running. */
} ThreadSpecificData;
static Tcl_ThreadDataKey dataKey;
/*
* The following static indicates the number of threads that have
* initialized notifiers.
*
* You must hold the notifierMutex lock before accessing this variable.
*/
static int notifierCount = 0;
/*
* The notifierMutex locks access to all of the global notifier state,
* as well as the pending flag for any specific notifier.
*/
TCL_DECLARE_MUTEX(notifierMutex)
/*
* Static routines defined in this file.
*/
static LRESULT CALLBACK NotifierProc(HWND hwnd, UINT message,
WPARAM wParam, LPARAM lParam);
static void UpdateTimer(ThreadSpecificData *tsdPtr, int timeout);
/*
*----------------------------------------------------------------------
*
* Tcl_InitNotifier --
*
* Initializes the platform specific notifier state.
*
* Results:
* Returns a handle to the notifier state for this thread..
*
* Side effects:
* None.
*
*----------------------------------------------------------------------
*/
ClientData
Tcl_InitNotifier()
{
ThreadSpecificData *tsdPtr = TCL_TSD_INIT(&dataKey);
WNDCLASS class;
/*
* Register Notifier window class if this is the first thread to
* use this module.
*/
Tcl_MutexLock(¬ifierMutex);
if (notifierCount == 0) {
class.style = 0;
class.cbClsExtra = 0;
class.cbWndExtra = 0;
class.hInstance = TclWinGetTclInstance();
class.hbrBackground = NULL;
class.lpszMenuName = NULL;
class.lpszClassName = "TclNotifier";
class.lpfnWndProc = NotifierProc;
class.hIcon = NULL;
class.hCursor = NULL;
if (!RegisterClassA(&class)) {
panic("Unable to register TclNotifier window class");
}
}
notifierCount++;
tsdPtr->pending = 0;
tsdPtr->timerActive = 0;
/*
* Create a window for communication with the notifier.
*/
tsdPtr->hwnd = CreateWindowA("TclNotifier", "TclNotifier", WS_TILED,
0, 0, 0, 0, NULL, NULL, TclWinGetTclInstance(), NULL);
Tcl_MutexUnlock(¬ifierMutex);
return (ClientData) tsdPtr;
}
/*
*----------------------------------------------------------------------
*
* Tcl_FinalizeNotifier --
*
* This function is called to cleanup the notifier state before
* a thread is terminated.
*
* Results:
* None.
*
* Side effects:
* May dispose of the notifier window and class.
*
*----------------------------------------------------------------------
*/
void
Tcl_FinalizeNotifier(clientData)
ClientData clientData; /* Pointer to notifier data. */
{
ThreadSpecificData *tsdPtr = (ThreadSpecificData *) clientData;
Tcl_MutexLock(¬ifierMutex);
/*
* Clean up the timer and messaging window for this thread.
*/
KillTimer(tsdPtr->hwnd, INTERVAL_TIMER);
DestroyWindow(tsdPtr->hwnd);
/*
* If this is the last thread to use the notifier, unregister
* the notifier window class.
*/
notifierCount--;
if (notifierCount == 0) {
UnregisterClassA("TclNotifier", TclWinGetTclInstance());
}
Tcl_MutexUnlock(¬ifierMutex);
}
/*
*----------------------------------------------------------------------
*
* TclpAlertNotifier --
*
* Wake up the specified notifier from any thread. This routine
* is called by the platform independent notifier code whenever
* the Tcl_ThreadAlert routine is called. This routine is
* guaranteed not to be called on a given notifier after
* Tcl_FinalizeNotifier is called for that notifier.
*
* Results:
* None.
*
* Side effects:
* Sends a message to the messaging window for the notifier
* if there isn't already one pending.
*
*----------------------------------------------------------------------
*/
void
TclpAlertNotifier(clientData)
ClientData clientData; /* Pointer to thread data. */
{
ThreadSpecificData *tsdPtr = (ThreadSpecificData *) clientData;
Tcl_MutexLock(¬ifierMutex);
if (!tsdPtr->pending) {
PostMessage(tsdPtr->hwnd, WM_WAKEUP, 0, 0);
tsdPtr->pending = 1;
}
Tcl_MutexUnlock(¬ifierMutex);
}
/*
*----------------------------------------------------------------------
*
* UpdateTimer --
*
* This function starts or stops the notifier interval timer.
*
* Results:
* None.
*
* Side effects:
* None.
*
*----------------------------------------------------------------------
*/
void
UpdateTimer(
ThreadSpecificData *tsdPtr, /* Pointer to notifier state. */
int timeout) /* ms timeout, 0 means cancel timer */
{
tsdPtr->timeout = timeout;
if (timeout != 0) {
tsdPtr->timerActive = 1;
SetTimer(tsdPtr->hwnd, INTERVAL_TIMER,
(unsigned long) tsdPtr->timeout, NULL);
} else {
tsdPtr->timerActive = 0;
KillTimer(tsdPtr->hwnd, INTERVAL_TIMER);
}
}
/*
*----------------------------------------------------------------------
*
* Tcl_SetTimer --
*
* This procedure sets the current notifier timer value. The
* notifier will ensure that Tcl_ServiceAll() is called after
* the specified interval, even if no events have occurred.
*
* Results:
* None.
*
* Side effects:
* Replaces any previous timer.
*
*----------------------------------------------------------------------
*/
void
Tcl_SetTimer(
Tcl_Time *timePtr) /* Maximum block time, or NULL. */
{
ThreadSpecificData *tsdPtr = TCL_TSD_INIT(&dataKey);
UINT timeout;
if (!timePtr) {
timeout = 0;
} else {
/*
* Make sure we pass a non-zero value into the timeout argument.
* Windows seems to get confused by zero length timers.
*/
timeout = timePtr->sec * 1000 + timePtr->usec / 1000;
if (timeout == 0) {
timeout = 1;
}
}
UpdateTimer(tsdPtr, timeout);
}
/*
*----------------------------------------------------------------------
*
* NotifierProc --
*
* This procedure is invoked by Windows to process events on
* the notifier window. Messages will be sent to this window
* in response to external timer events or calls to
* TclpAlertTsdPtr->
*
* Results:
* A standard windows result.
*
* Side effects:
* Services any pending events.
*
*----------------------------------------------------------------------
*/
static LRESULT CALLBACK
NotifierProc(
HWND hwnd,
UINT message,
WPARAM wParam,
LPARAM lParam)
{
ThreadSpecificData *tsdPtr = TCL_TSD_INIT(&dataKey);
if (message == WM_USER) {
Tcl_MutexLock(¬ifierMutex);
tsdPtr->pending = 0;
Tcl_MutexUnlock(¬ifierMutex);
} else if (message != WM_TIMER) {
return DefWindowProc(hwnd, message, wParam, lParam);
}
/*
* Process all of the runnable events.
*/
Tcl_ServiceAll();
return 0;
}
/*
*----------------------------------------------------------------------
*
* Tcl_WaitForEvent --
*
* This function is called by Tcl_DoOneEvent to wait for new
* events on the message queue. If the block time is 0, then
* Tcl_WaitForEvent just polls the event queue without blocking.
*
* Results:
* Returns -1 if a WM_QUIT message is detected, returns 1 if
* a message was dispatched, otherwise returns 0.
*
* Side effects:
* Dispatches a message to a window procedure, which could do
* anything.
*
*----------------------------------------------------------------------
*/
int
Tcl_WaitForEvent(
Tcl_Time *timePtr) /* Maximum block time, or NULL. */
{
ThreadSpecificData *tsdPtr = TCL_TSD_INIT(&dataKey);
MSG msg;
int timeout;
/*
* Only use the interval timer for non-zero timeouts. This avoids
* generating useless messages when we really just want to poll.
*/
if (timePtr) {
timeout = timePtr->sec * 1000 + timePtr->usec / 1000;
} else {
timeout = 0;
}
UpdateTimer(tsdPtr, timeout);
if (!timePtr || (timeout != 0)
|| PeekMessage(&msg, NULL, 0, 0, PM_NOREMOVE)) {
if (!GetMessage(&msg, NULL, 0, 0)) {
/*
* The application is exiting, so repost the quit message
* and start unwinding.
*/
PostQuitMessage(msg.wParam);
return -1;
}
/*
* Handle timer expiration as a special case so we don't
* claim to be doing work when we aren't.
*/
if (msg.message == WM_TIMER && msg.hwnd == tsdPtr->hwnd) {
return 0;
}
TranslateMessage(&msg);
DispatchMessage(&msg);
return 1;
}
return 0;
}
/*
*----------------------------------------------------------------------
*
* Tcl_Sleep --
*
* Delay execution for the specified number of milliseconds.
*
* Results:
* None.
*
* Side effects:
* Time passes.
*
*----------------------------------------------------------------------
*/
void
Tcl_Sleep(ms)
int ms; /* Number of milliseconds to sleep. */
{
Sleep(ms);
}
|