This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_events.c
540 lines (480 loc) · 13.8 KB
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2006 Sam Lantinga
4
5
This library is free software; you can redistribute it and/or
6
modify it under the terms of the GNU Lesser General Public
7
License as published by the Free Software Foundation; either
8
version 2.1 of the License, or (at your option) any later version.
9
10
11
12
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
Lesser General Public License for more details.
14
15
16
17
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
19
Sam Lantinga
20
slouken@libsdl.org
21
*/
22
#include "SDL_config.h"
23
24
25
26
27
28
/* General event handling code for SDL */
#include "SDL.h"
#include "SDL_syswm.h"
#include "SDL_sysevents.h"
29
30
31
32
33
#include "SDL_events_c.h"
#include "../timer/SDL_timer_c.h"
#if !SDL_JOYSTICK_DISABLED
#include "../joystick/SDL_joystick_c.h"
#endif
34
35
36
/* Public data -- the event filter */
SDL_EventFilter SDL_EventOK = NULL;
37
void *SDL_EventOKParam;
38
39
40
41
42
Uint8 SDL_ProcessEvents[SDL_NUMEVENTS];
static Uint32 SDL_eventstate = 0;
/* Private data -- event queue */
#define MAXEVENTS 128
43
44
45
46
47
48
49
50
51
static struct
{
SDL_mutex *lock;
int active;
int head;
int tail;
SDL_Event event[MAXEVENTS];
int wmmsg_next;
struct SDL_SysWMmsg wmmsg[MAXEVENTS];
52
53
54
} SDL_EventQ;
/* Private data -- event locking structure */
55
56
57
58
static struct
{
SDL_mutex *lock;
int safe;
59
60
61
} SDL_EventLock;
/* Thread functions */
62
63
static SDL_Thread *SDL_EventThread = NULL; /* Thread handle */
static Uint32 event_thread; /* The event thread id */
64
65
66
void
SDL_Lock_EventThread(void)
67
{
68
69
70
71
72
73
74
if (SDL_EventThread && (SDL_ThreadID() != event_thread)) {
/* Grab lock and spin until we're sure event thread stopped */
SDL_mutexP(SDL_EventLock.lock);
while (!SDL_EventLock.safe) {
SDL_Delay(1);
}
}
75
}
76
77
void
SDL_Unlock_EventThread(void)
78
{
79
80
81
if (SDL_EventThread && (SDL_ThreadID() != event_thread)) {
SDL_mutexV(SDL_EventLock.lock);
}
82
83
}
84
85
86
87
88
89
90
91
92
93
94
#ifdef __OS2__
/*
* We'll increase the priority of GobbleEvents thread, so it will process
* events in time for sure! For this, we need the DosSetPriority() API
* from the os2.h include file.
*/
#define INCL_DOSPROCESS
#include <os2.h>
#include <time.h>
#endif
95
96
static int SDLCALL
SDL_GobbleEvents(void *unused)
97
{
98
event_thread = SDL_ThreadID();
99
100
101
#ifdef __OS2__
#ifdef USE_DOSSETPRIORITY
102
103
/* Increase thread priority, so it will process events in time for sure! */
DosSetPriority(PRTYS_THREAD, PRTYC_REGULAR, +16, 0);
104
105
106
#endif
#endif
107
108
while (SDL_EventQ.active) {
SDL_VideoDevice *_this = SDL_GetVideoDevice();
109
110
111
112
113
/* Get events from the video subsystem */
if (_this) {
_this->PumpEvents(_this);
}
114
#if !SDL_JOYSTICK_DISABLED
115
116
117
118
/* Check for joystick state change */
if (SDL_numjoysticks && (SDL_eventstate & SDL_JOYEVENTMASK)) {
SDL_JoystickUpdate();
}
119
120
#endif
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/* Give up the CPU for the rest of our timeslice */
SDL_EventLock.safe = 1;
if (SDL_timer_running) {
SDL_ThreadedTimerCheck();
}
SDL_Delay(1);
/* Check for event locking.
On the P of the lock mutex, if the lock is held, this thread
will wait until the lock is released before continuing. The
safe flag will be set, meaning that the other thread can go
about it's business. The safe flag is reset before the V,
so as soon as the mutex is free, other threads can see that
it's not safe to interfere with the event thread.
*/
SDL_mutexP(SDL_EventLock.lock);
SDL_EventLock.safe = 0;
SDL_mutexV(SDL_EventLock.lock);
}
SDL_SetTimerThreaded(0);
event_thread = 0;
return (0);
143
144
}
145
146
static int
SDL_StartEventThread(Uint32 flags)
147
{
148
149
150
/* Reset everything to zero */
SDL_EventThread = NULL;
SDL_memset(&SDL_EventLock, 0, sizeof(SDL_EventLock));
151
152
/* Create the lock and set ourselves active */
153
#if !SDL_THREADS_DISABLED
154
155
156
157
SDL_EventQ.lock = SDL_CreateMutex();
if (SDL_EventQ.lock == NULL) {
return (-1);
}
158
#endif /* !SDL_THREADS_DISABLED */
159
SDL_EventQ.active = 1;
160
161
162
163
164
165
166
if ((flags & SDL_INIT_EVENTTHREAD) == SDL_INIT_EVENTTHREAD) {
SDL_EventLock.lock = SDL_CreateMutex();
if (SDL_EventLock.lock == NULL) {
return (-1);
}
SDL_EventLock.safe = 0;
167
168
169
/* The event thread will handle timers too */
SDL_SetTimerThreaded(2);
170
#if (defined(__WIN32__) && !defined(_WIN32_WCE)) && !defined(HAVE_LIBC)
171
#undef SDL_CreateThread
172
173
SDL_EventThread =
SDL_CreateThread(SDL_GobbleEvents, NULL, NULL, NULL);
174
#else
175
SDL_EventThread = SDL_CreateThread(SDL_GobbleEvents, NULL);
176
#endif
177
178
179
180
181
182
183
if (SDL_EventThread == NULL) {
return (-1);
}
} else {
event_thread = 0;
}
return (0);
184
185
}
186
187
static void
SDL_StopEventThread(void)
188
{
189
190
191
192
193
194
SDL_EventQ.active = 0;
if (SDL_EventThread) {
SDL_WaitThread(SDL_EventThread, NULL);
SDL_EventThread = NULL;
SDL_DestroyMutex(SDL_EventLock.lock);
}
195
#ifndef IPOD
196
SDL_DestroyMutex(SDL_EventQ.lock);
197
#endif
198
199
}
200
201
Uint32
SDL_EventThreadID(void)
202
{
203
return (event_thread);
204
205
206
207
}
/* Public functions */
208
209
void
SDL_StopEventLoop(void)
210
{
211
212
213
214
215
216
217
218
219
220
221
222
/* Halt the event thread, if running */
SDL_StopEventThread();
/* Shutdown event handlers */
SDL_KeyboardQuit();
SDL_MouseQuit();
SDL_QuitQuit();
/* Clean out EventQ */
SDL_EventQ.head = 0;
SDL_EventQ.tail = 0;
SDL_EventQ.wmmsg_next = 0;
223
224
225
}
/* This function (and associated calls) may be called more than once */
226
227
int
SDL_StartEventLoop(Uint32 flags)
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
int retcode;
/* Clean out the event queue */
SDL_EventThread = NULL;
SDL_EventQ.lock = NULL;
SDL_StopEventLoop();
/* No filter to start with, process most event types */
SDL_EventOK = NULL;
SDL_memset(SDL_ProcessEvents, SDL_ENABLE, sizeof(SDL_ProcessEvents));
SDL_eventstate = ~0;
/* It's not save to call SDL_EventState() yet */
SDL_eventstate &= ~(0x00000001 << SDL_SYSWMEVENT);
SDL_ProcessEvents[SDL_SYSWMEVENT] = SDL_IGNORE;
/* Initialize event handlers */
retcode = 0;
retcode += SDL_KeyboardInit();
retcode += SDL_MouseInit();
retcode += SDL_QuitInit();
if (retcode < 0) {
/* We don't expect them to fail, but... */
return (-1);
}
/* Create the lock and event thread */
if (SDL_StartEventThread(flags) < 0) {
SDL_StopEventLoop();
return (-1);
}
return (0);
260
261
262
263
}
/* Add an event to the event queue -- called with the queue locked */
264
265
static int
SDL_AddEvent(SDL_Event * event)
266
{
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
int tail, added;
tail = (SDL_EventQ.tail + 1) % MAXEVENTS;
if (tail == SDL_EventQ.head) {
/* Overflow, drop event */
added = 0;
} else {
SDL_EventQ.event[SDL_EventQ.tail] = *event;
if (event->type == SDL_SYSWMEVENT) {
/* Note that it's possible to lose an event */
int next = SDL_EventQ.wmmsg_next;
SDL_EventQ.wmmsg[next] = *event->syswm.msg;
SDL_EventQ.event[SDL_EventQ.tail].syswm.msg =
&SDL_EventQ.wmmsg[next];
SDL_EventQ.wmmsg_next = (next + 1) % MAXEVENTS;
}
SDL_EventQ.tail = tail;
added = 1;
}
return (added);
287
288
289
290
}
/* Cut an event, and return the next valid spot, or the tail */
/* -- called with the queue locked */
291
292
static int
SDL_CutEvent(int spot)
293
{
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
if (spot == SDL_EventQ.head) {
SDL_EventQ.head = (SDL_EventQ.head + 1) % MAXEVENTS;
return (SDL_EventQ.head);
} else if ((spot + 1) % MAXEVENTS == SDL_EventQ.tail) {
SDL_EventQ.tail = spot;
return (SDL_EventQ.tail);
} else
/* We cut the middle -- shift everything over */
{
int here, next;
/* This can probably be optimized with SDL_memcpy() -- careful! */
if (--SDL_EventQ.tail < 0) {
SDL_EventQ.tail = MAXEVENTS - 1;
}
for (here = spot; here != SDL_EventQ.tail; here = next) {
next = (here + 1) % MAXEVENTS;
SDL_EventQ.event[here] = SDL_EventQ.event[next];
}
return (spot);
}
/* NOTREACHED */
316
317
318
}
/* Lock the event queue, take a peep at it, and unlock it */
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
int
SDL_PeepEvents(SDL_Event * events, int numevents, SDL_eventaction action,
Uint32 mask)
{
int i, used;
/* Don't look after we've quit */
if (!SDL_EventQ.active) {
return (-1);
}
/* Lock the event queue */
used = 0;
if (SDL_mutexP(SDL_EventQ.lock) == 0) {
if (action == SDL_ADDEVENT) {
for (i = 0; i < numevents; ++i) {
used += SDL_AddEvent(&events[i]);
}
} else {
SDL_Event tmpevent;
int spot;
/* If 'events' is NULL, just see if they exist */
if (events == NULL) {
action = SDL_PEEKEVENT;
numevents = 1;
events = &tmpevent;
}
spot = SDL_EventQ.head;
while ((used < numevents) && (spot != SDL_EventQ.tail)) {
if (mask & SDL_EVENTMASK(SDL_EventQ.event[spot].type)) {
events[used++] = SDL_EventQ.event[spot];
if (action == SDL_GETEVENT) {
spot = SDL_CutEvent(spot);
} else {
spot = (spot + 1) % MAXEVENTS;
}
} else {
spot = (spot + 1) % MAXEVENTS;
}
}
}
SDL_mutexV(SDL_EventQ.lock);
} else {
SDL_SetError("Couldn't lock event queue");
used = -1;
}
return (used);
}
SDL_bool
SDL_HasEvent(Uint32 mask)
370
{
371
return (SDL_PeepEvents(NULL, 0, SDL_PEEKEVENT, mask) > 0);
372
373
374
}
/* Run the system dependent event loops */
375
376
void
SDL_PumpEvents(void)
377
{
378
379
if (!SDL_EventThread) {
SDL_VideoDevice *_this = SDL_GetVideoDevice();
380
381
382
383
384
/* Get events from the video subsystem */
if (_this) {
_this->PumpEvents(_this);
}
385
#if !SDL_JOYSTICK_DISABLED
386
387
388
389
/* Check for joystick state change */
if (SDL_numjoysticks && (SDL_eventstate & SDL_JOYEVENTMASK)) {
SDL_JoystickUpdate();
}
390
#endif
391
}
392
393
394
395
}
/* Public functions */
396
397
int
SDL_PollEvent(SDL_Event * event)
398
{
399
SDL_PumpEvents();
400
401
402
403
404
/* We can't return -1, just return 0 (no event) on error */
if (SDL_PeepEvents(event, 1, SDL_GETEVENT, SDL_ALLEVENTS) <= 0)
return 0;
return 1;
405
406
}
407
408
int
SDL_WaitEvent(SDL_Event * event)
409
{
410
411
412
413
414
415
416
417
418
419
420
while (1) {
SDL_PumpEvents();
switch (SDL_PeepEvents(event, 1, SDL_GETEVENT, SDL_ALLEVENTS)) {
case -1:
return 0;
case 1:
return 1;
case 0:
SDL_Delay(10);
}
}
421
422
}
423
424
int
SDL_PushEvent(SDL_Event * event)
425
{
426
427
428
429
430
431
432
if (SDL_EventOK && !SDL_EventOK(SDL_EventOKParam, event)) {
return 0;
}
if (SDL_PeepEvents(event, 1, SDL_ADDEVENT, 0) <= 0) {
return -1;
}
return 1;
433
434
}
435
436
void
SDL_SetEventFilter(SDL_EventFilter filter, void *userdata)
437
{
438
SDL_Event bitbucket;
439
440
441
442
443
/* Set filter and discard pending events */
SDL_EventOK = filter;
SDL_EventOKParam = userdata;
while (SDL_PollEvent(&bitbucket) > 0);
444
445
}
446
447
SDL_bool
SDL_GetEventFilter(SDL_EventFilter * filter, void **userdata)
448
{
449
450
451
452
453
454
455
if (filter) {
*filter = SDL_EventOK;
}
if (userdata) {
*userdata = SDL_EventOKParam;
}
return SDL_EventOK ? SDL_TRUE : SDL_FALSE;
456
457
}
458
459
void
SDL_FilterEvents(SDL_EventFilter filter, void *userdata)
460
{
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
if (SDL_mutexP(SDL_EventQ.lock) == 0) {
int spot;
spot = SDL_EventQ.head;
while (spot != SDL_EventQ.tail) {
if (filter(userdata, &SDL_EventQ.event[spot])) {
spot = (spot + 1) % MAXEVENTS;
} else {
spot = SDL_CutEvent(spot);
}
}
}
SDL_mutexV(SDL_EventQ.lock);
}
Uint8
SDL_EventState(Uint8 type, int state)
{
SDL_Event bitbucket;
Uint8 current_state;
/* If SDL_ALLEVENTS was specified... */
if (type == 0xFF) {
current_state = SDL_IGNORE;
for (type = 0; type < SDL_NUMEVENTS; ++type) {
if (SDL_ProcessEvents[type] != SDL_IGNORE) {
current_state = SDL_ENABLE;
}
SDL_ProcessEvents[type] = state;
if (state == SDL_ENABLE) {
SDL_eventstate |= (0x00000001 << (type));
} else {
SDL_eventstate &= ~(0x00000001 << (type));
}
}
while (SDL_PollEvent(&bitbucket) > 0);
return (current_state);
}
/* Just set the state for one event type */
current_state = SDL_ProcessEvents[type];
switch (state) {
case SDL_IGNORE:
case SDL_ENABLE:
/* Set state and discard pending events */
SDL_ProcessEvents[type] = state;
if (state == SDL_ENABLE) {
SDL_eventstate |= (0x00000001 << (type));
} else {
SDL_eventstate &= ~(0x00000001 << (type));
}
while (SDL_PollEvent(&bitbucket) > 0);
break;
default:
/* Querying state? */
break;
}
return (current_state);
519
520
521
522
}
/* This is a generic event handler.
*/
523
524
int
SDL_SendSysWMEvent(SDL_SysWMmsg * message)
525
{
526
527
528
529
530
531
532
533
534
535
536
537
int posted;
posted = 0;
if (SDL_ProcessEvents[SDL_SYSWMEVENT] == SDL_ENABLE) {
SDL_Event event;
SDL_memset(&event, 0, sizeof(event));
event.type = SDL_SYSWMEVENT;
event.syswm.msg = message;
posted = (SDL_PushEvent(&event) > 0);
}
/* Update internal event state */
return (posted);
538
}
539
540
/* vi: set ts=4 sw=4 expandtab: */