SDL  2.0
SDL_events.c
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2018 Sam Lantinga <slouken@libsdl.org>
4 
5  This software is provided 'as-is', without any express or implied
6  warranty. In no event will the authors be held liable for any damages
7  arising from the use of this software.
8 
9  Permission is granted to anyone to use this software for any purpose,
10  including commercial applications, and to alter it and redistribute it
11  freely, subject to the following restrictions:
12 
13  1. The origin of this software must not be misrepresented; you must not
14  claim that you wrote the original software. If you use this software
15  in a product, an acknowledgment in the product documentation would be
16  appreciated but is not required.
17  2. Altered source versions must be plainly marked as such, and must not be
18  misrepresented as being the original software.
19  3. This notice may not be removed or altered from any source distribution.
20 */
21 #include "../SDL_internal.h"
22 
23 /* General event handling code for SDL */
24 
25 #include "SDL.h"
26 #include "SDL_events.h"
27 #include "SDL_thread.h"
28 #include "SDL_events_c.h"
29 #include "../timer/SDL_timer_c.h"
30 #if !SDL_JOYSTICK_DISABLED
31 #include "../joystick/SDL_joystick_c.h"
32 #endif
33 #include "../video/SDL_sysvideo.h"
34 #include "SDL_syswm.h"
35 
36 /*#define SDL_DEBUG_EVENTS 1*/
37 
38 /* An arbitrary limit so we don't have unbounded growth */
39 #define SDL_MAX_QUEUED_EVENTS 65535
40 
41 typedef struct SDL_EventWatcher {
43  void *userdata;
46 
50 static int SDL_event_watchers_count = 0;
53 
54 typedef struct {
57 
60 
61 /* Private data -- event queue */
62 typedef struct _SDL_EventEntry
63 {
66  struct _SDL_EventEntry *prev;
67  struct _SDL_EventEntry *next;
69 
70 typedef struct _SDL_SysWMEntry
71 {
73  struct _SDL_SysWMEntry *next;
75 
76 static struct
77 {
87 } SDL_EventQ = { NULL, { 1 }, { 0 }, 0, NULL, NULL, NULL, NULL, NULL };
88 
89 
90 #ifdef SDL_DEBUG_EVENTS
91 
92 /* this is to make printf() calls cleaner. */
93 #define uint unsigned int
94 
95 static void
96 SDL_DebugPrintEvent(const SDL_Event *event)
97 {
98  /* !!! FIXME: This code is kinda ugly, sorry. */
99  printf("SDL EVENT: ");
100 
101  if ((event->type >= SDL_USEREVENT) && (event->type <= SDL_LASTEVENT)) {
102  printf("SDL_USEREVENT");
103  if (event->type > SDL_USEREVENT) {
104  printf("+%u", ((uint) event->type) - SDL_USEREVENT);
105  }
106  printf(" (timestamp=%u windowid=%u code=%d data1=%p data2=%p)",
107  (uint) event->user.timestamp, (uint) event->user.windowID,
108  (int) event->user.code, event->user.data1, event->user.data2);
109  return;
110  }
111 
112  switch (event->type) {
113  #define SDL_EVENT_CASE(x) case x: printf("%s", #x);
114  SDL_EVENT_CASE(SDL_FIRSTEVENT) printf("(THIS IS PROBABLY A BUG!)"); break;
115  SDL_EVENT_CASE(SDL_QUIT) printf("(timestamp=%u)", (uint) event->quit.timestamp); break;
116  SDL_EVENT_CASE(SDL_APP_TERMINATING) break;
117  SDL_EVENT_CASE(SDL_APP_LOWMEMORY) break;
118  SDL_EVENT_CASE(SDL_APP_WILLENTERBACKGROUND) break;
119  SDL_EVENT_CASE(SDL_APP_DIDENTERBACKGROUND) break;
120  SDL_EVENT_CASE(SDL_APP_WILLENTERFOREGROUND) break;
121  SDL_EVENT_CASE(SDL_APP_DIDENTERFOREGROUND) break;
122  SDL_EVENT_CASE(SDL_KEYMAPCHANGED) break;
123  SDL_EVENT_CASE(SDL_CLIPBOARDUPDATE) break;
124  SDL_EVENT_CASE(SDL_RENDER_TARGETS_RESET) break;
125  SDL_EVENT_CASE(SDL_RENDER_DEVICE_RESET) break;
126  #undef SDL_EVENT_CASE
127 
128  #define SDL_EVENT_CASE(x) case x: printf("%s ", #x);
129 
130  SDL_EVENT_CASE(SDL_WINDOWEVENT)
131  printf("(timestamp=%u windowid=%u event=", (uint) event->window.timestamp, (uint) event->window.windowID);
132  switch(event->window.event) {
133  case SDL_WINDOWEVENT_NONE: printf("none(THIS IS PROBABLY A BUG!)"); break;
134  #define SDL_WINDOWEVENT_CASE(x) case x: printf("%s", #x); break
135  SDL_WINDOWEVENT_CASE(SDL_WINDOWEVENT_SHOWN);
136  SDL_WINDOWEVENT_CASE(SDL_WINDOWEVENT_HIDDEN);
137  SDL_WINDOWEVENT_CASE(SDL_WINDOWEVENT_EXPOSED);
138  SDL_WINDOWEVENT_CASE(SDL_WINDOWEVENT_MOVED);
139  SDL_WINDOWEVENT_CASE(SDL_WINDOWEVENT_RESIZED);
140  SDL_WINDOWEVENT_CASE(SDL_WINDOWEVENT_SIZE_CHANGED);
141  SDL_WINDOWEVENT_CASE(SDL_WINDOWEVENT_MINIMIZED);
142  SDL_WINDOWEVENT_CASE(SDL_WINDOWEVENT_MAXIMIZED);
143  SDL_WINDOWEVENT_CASE(SDL_WINDOWEVENT_RESTORED);
144  SDL_WINDOWEVENT_CASE(SDL_WINDOWEVENT_ENTER);
145  SDL_WINDOWEVENT_CASE(SDL_WINDOWEVENT_LEAVE);
146  SDL_WINDOWEVENT_CASE(SDL_WINDOWEVENT_FOCUS_GAINED);
147  SDL_WINDOWEVENT_CASE(SDL_WINDOWEVENT_FOCUS_LOST);
148  SDL_WINDOWEVENT_CASE(SDL_WINDOWEVENT_CLOSE);
149  SDL_WINDOWEVENT_CASE(SDL_WINDOWEVENT_TAKE_FOCUS);
150  SDL_WINDOWEVENT_CASE(SDL_WINDOWEVENT_HIT_TEST);
151  #undef SDL_WINDOWEVENT_CASE
152  default: printf("UNKNOWN(bug? fixme?)"); break;
153  }
154  printf(" data1=%d data2=%d)", (int) event->window.data1, (int) event->window.data2);
155  break;
156 
157  SDL_EVENT_CASE(SDL_SYSWMEVENT)
158  printf("(timestamp=%u)", (uint) event->syswm.timestamp);
159  /* !!! FIXME: we don't delve further at the moment. */
160  break;
161 
162  #define PRINT_KEY_EVENT(event) \
163  printf("(timestamp=%u windowid=%u state=%s repeat=%s scancode=%u keycode=%u mod=%u)", \
164  (uint) event->key.timestamp, (uint) event->key.windowID, \
165  event->key.state == SDL_PRESSED ? "pressed" : "released", \
166  event->key.repeat ? "true" : "false", \
167  (uint) event->key.keysym.scancode, \
168  (uint) event->key.keysym.sym, \
169  (uint) event->key.keysym.mod)
170  SDL_EVENT_CASE(SDL_KEYDOWN) PRINT_KEY_EVENT(event); break;
171  SDL_EVENT_CASE(SDL_KEYUP) PRINT_KEY_EVENT(event); break;
172  #undef PRINT_KEY_EVENT
173 
174  SDL_EVENT_CASE(SDL_TEXTEDITING)
175  printf("(timestamp=%u windowid=%u text='%s' start=%d length=%d)",
176  (uint) event->edit.timestamp, (uint) event->edit.windowID,
177  event->edit.text, (int) event->edit.start, (int) event->edit.length);
178  break;
179 
180  SDL_EVENT_CASE(SDL_TEXTINPUT)
181  printf("(timestamp=%u windowid=%u text='%s')", (uint) event->text.timestamp, (uint) event->text.windowID, event->text.text);
182  break;
183 
184 
185  SDL_EVENT_CASE(SDL_MOUSEMOTION)
186  printf("(timestamp=%u windowid=%u which=%u state=%u x=%d y=%d xrel=%d yrel=%d)",
187  (uint) event->motion.timestamp, (uint) event->motion.windowID,
188  (uint) event->motion.which, (uint) event->motion.state,
189  (int) event->motion.x, (int) event->motion.y,
190  (int) event->motion.xrel, (int) event->motion.yrel);
191  break;
192 
193  #define PRINT_MBUTTON_EVENT(event) \
194  printf("(timestamp=%u windowid=%u which=%u button=%u state=%s clicks=%u x=%d y=%d)", \
195  (uint) event->button.timestamp, (uint) event->button.windowID, \
196  (uint) event->button.which, (uint) event->button.button, \
197  event->button.state == SDL_PRESSED ? "pressed" : "released", \
198  (uint) event->button.clicks, (int) event->button.x, (int) event->button.y)
199  SDL_EVENT_CASE(SDL_MOUSEBUTTONDOWN) PRINT_MBUTTON_EVENT(event); break;
200  SDL_EVENT_CASE(SDL_MOUSEBUTTONUP) PRINT_MBUTTON_EVENT(event); break;
201  #undef PRINT_MBUTTON_EVENT
202 
203 
204  SDL_EVENT_CASE(SDL_MOUSEWHEEL)
205  printf("(timestamp=%u windowid=%u which=%u x=%d y=%d direction=%s)",
206  (uint) event->wheel.timestamp, (uint) event->wheel.windowID,
207  (uint) event->wheel.which, (int) event->wheel.x, (int) event->wheel.y,
208  event->wheel.direction == SDL_MOUSEWHEEL_NORMAL ? "normal" : "flipped");
209  break;
210 
211  SDL_EVENT_CASE(SDL_JOYAXISMOTION)
212  printf("(timestamp=%u which=%d axis=%u value=%d)",
213  (uint) event->jaxis.timestamp, (int) event->jaxis.which,
214  (uint) event->jaxis.axis, (int) event->jaxis.value);
215  break;
216 
217  SDL_EVENT_CASE(SDL_JOYBALLMOTION)
218  printf("(timestamp=%u which=%d ball=%u xrel=%d yrel=%d)",
219  (uint) event->jball.timestamp, (int) event->jball.which,
220  (uint) event->jball.ball, (int) event->jball.xrel, (int) event->jball.yrel);
221  break;
222 
223  SDL_EVENT_CASE(SDL_JOYHATMOTION)
224  printf("(timestamp=%u which=%d hat=%u value=%u)",
225  (uint) event->jhat.timestamp, (int) event->jhat.which,
226  (uint) event->jhat.hat, (uint) event->jhat.value);
227  break;
228 
229  #define PRINT_JBUTTON_EVENT(event) \
230  printf("(timestamp=%u which=%d button=%u state=%s)", \
231  (uint) event->jbutton.timestamp, (int) event->jbutton.which, \
232  (uint) event->jbutton.button, event->jbutton.state == SDL_PRESSED ? "pressed" : "released")
233  SDL_EVENT_CASE(SDL_JOYBUTTONDOWN) PRINT_JBUTTON_EVENT(event); break;
234  SDL_EVENT_CASE(SDL_JOYBUTTONUP) PRINT_JBUTTON_EVENT(event); break;
235  #undef PRINT_JBUTTON_EVENT
236 
237  #define PRINT_JOYDEV_EVENT(event) printf("(timestamp=%u which=%d)", (uint) event->jdevice.timestamp, (int) event->jdevice.which)
238  SDL_EVENT_CASE(SDL_JOYDEVICEADDED) PRINT_JOYDEV_EVENT(event); break;
239  SDL_EVENT_CASE(SDL_JOYDEVICEREMOVED) PRINT_JOYDEV_EVENT(event); break;
240  #undef PRINT_JOYDEV_EVENT
241 
242  SDL_EVENT_CASE(SDL_CONTROLLERAXISMOTION)
243  printf("(timestamp=%u which=%d axis=%u value=%d)",
244  (uint) event->caxis.timestamp, (int) event->caxis.which,
245  (uint) event->caxis.axis, (int) event->caxis.value);
246  break;
247 
248  #define PRINT_CBUTTON_EVENT(event) \
249  printf("(timestamp=%u which=%d button=%u state=%s)", \
250  (uint) event->cbutton.timestamp, (int) event->cbutton.which, \
251  (uint) event->cbutton.button, event->cbutton.state == SDL_PRESSED ? "pressed" : "released")
252  SDL_EVENT_CASE(SDL_CONTROLLERBUTTONDOWN) PRINT_CBUTTON_EVENT(event); break;
253  SDL_EVENT_CASE(SDL_CONTROLLERBUTTONUP) PRINT_CBUTTON_EVENT(event); break;
254  #undef PRINT_CBUTTON_EVENT
255 
256  #define PRINT_CONTROLLERDEV_EVENT(event) printf("(timestamp=%u which=%d)", (uint) event->cdevice.timestamp, (int) event->cdevice.which)
257  SDL_EVENT_CASE(SDL_CONTROLLERDEVICEADDED) PRINT_CONTROLLERDEV_EVENT(event); break;
258  SDL_EVENT_CASE(SDL_CONTROLLERDEVICEREMOVED) PRINT_CONTROLLERDEV_EVENT(event); break;
259  SDL_EVENT_CASE(SDL_CONTROLLERDEVICEREMAPPED) PRINT_CONTROLLERDEV_EVENT(event); break;
260  #undef PRINT_CONTROLLERDEV_EVENT
261 
262  #define PRINT_FINGER_EVENT(event) \
263  printf("(timestamp=%u touchid=%lld fingerid=%lld x=%f y=%f dx=%f dy=%f pressure=%f)", \
264  (uint) event->tfinger.timestamp, (long long) event->tfinger.touchId, \
265  (long long) event->tfinger.fingerId, event->tfinger.x, event->tfinger.y, \
266  event->tfinger.dx, event->tfinger.dy, event->tfinger.pressure)
267  SDL_EVENT_CASE(SDL_FINGERDOWN) PRINT_FINGER_EVENT(event); break;
268  SDL_EVENT_CASE(SDL_FINGERUP) PRINT_FINGER_EVENT(event); break;
269  SDL_EVENT_CASE(SDL_FINGERMOTION) PRINT_FINGER_EVENT(event); break;
270  #undef PRINT_FINGER_EVENT
271 
272  #define PRINT_DOLLAR_EVENT(event) \
273  printf("(timestamp=%u touchid=%lld gestureid=%lld numfingers=%u error=%f x=%f y=%f)", \
274  (uint) event->dgesture.timestamp, (long long) event->dgesture.touchId, \
275  (long long) event->dgesture.gestureId, (uint) event->dgesture.numFingers, \
276  event->dgesture.error, event->dgesture.x, event->dgesture.y);
277  SDL_EVENT_CASE(SDL_DOLLARGESTURE) PRINT_DOLLAR_EVENT(event); break;
278  SDL_EVENT_CASE(SDL_DOLLARRECORD) PRINT_DOLLAR_EVENT(event); break;
279  #undef PRINT_DOLLAR_EVENT
280 
281  SDL_EVENT_CASE(SDL_MULTIGESTURE)
282  printf("(timestamp=%u touchid=%lld dtheta=%f ddist=%f x=%f y=%f numfingers=%u)",
283  (uint) event->mgesture.timestamp, (long long) event->mgesture.touchId,
284  event->mgesture.dTheta, event->mgesture.dDist,
285  event->mgesture.x, event->mgesture.y, (uint) event->mgesture.numFingers);
286  break;
287 
288  #define PRINT_DROP_EVENT(event) printf("(file='%s' timestamp=%u windowid=%u)", event->drop.file, (uint) event->drop.timestamp, (uint) event->drop.windowID)
289  SDL_EVENT_CASE(SDL_DROPFILE) PRINT_DROP_EVENT(event); break;
290  SDL_EVENT_CASE(SDL_DROPTEXT) PRINT_DROP_EVENT(event); break;
291  SDL_EVENT_CASE(SDL_DROPBEGIN) PRINT_DROP_EVENT(event); break;
292  SDL_EVENT_CASE(SDL_DROPCOMPLETE) PRINT_DROP_EVENT(event); break;
293  #undef PRINT_DROP_EVENT
294 
295  #define PRINT_AUDIODEV_EVENT(event) printf("(timestamp=%u which=%u iscapture=%s)", (uint) event->adevice.timestamp, (uint) event->adevice.which, event->adevice.iscapture ? "true" : "false");
296  SDL_EVENT_CASE(SDL_AUDIODEVICEADDED) PRINT_AUDIODEV_EVENT(event); break;
297  SDL_EVENT_CASE(SDL_AUDIODEVICEREMOVED) PRINT_AUDIODEV_EVENT(event); break;
298  #undef PRINT_AUDIODEV_EVENT
299 
300  #undef SDL_EVENT_CASE
301 
302  default:
303  printf("UNKNOWN SDL EVENT #%u! (Bug? FIXME?)", (uint) event->type);
304  break;
305  }
306 
307  printf("\n");
308 }
309 #undef uint
310 #endif
311 
312 
313 
314 /* Public functions */
315 
316 void
318 {
319  const char *report = SDL_GetHint("SDL_EVENT_QUEUE_STATISTICS");
320  int i;
321  SDL_EventEntry *entry;
322  SDL_SysWMEntry *wmmsg;
323 
324  if (SDL_EventQ.lock) {
326  }
327 
328  SDL_AtomicSet(&SDL_EventQ.active, 0);
329 
330  if (report && SDL_atoi(report)) {
331  SDL_Log("SDL EVENT QUEUE: Maximum events in-flight: %d\n",
332  SDL_EventQ.max_events_seen);
333  }
334 
335  /* Clean out EventQ */
336  for (entry = SDL_EventQ.head; entry; ) {
337  SDL_EventEntry *next = entry->next;
338  SDL_free(entry);
339  entry = next;
340  }
341  for (entry = SDL_EventQ.free; entry; ) {
342  SDL_EventEntry *next = entry->next;
343  SDL_free(entry);
344  entry = next;
345  }
346  for (wmmsg = SDL_EventQ.wmmsg_used; wmmsg; ) {
347  SDL_SysWMEntry *next = wmmsg->next;
348  SDL_free(wmmsg);
349  wmmsg = next;
350  }
351  for (wmmsg = SDL_EventQ.wmmsg_free; wmmsg; ) {
352  SDL_SysWMEntry *next = wmmsg->next;
353  SDL_free(wmmsg);
354  wmmsg = next;
355  }
356 
357  SDL_AtomicSet(&SDL_EventQ.count, 0);
358  SDL_EventQ.max_events_seen = 0;
359  SDL_EventQ.head = NULL;
360  SDL_EventQ.tail = NULL;
361  SDL_EventQ.free = NULL;
362  SDL_EventQ.wmmsg_used = NULL;
363  SDL_EventQ.wmmsg_free = NULL;
364 
365  /* Clear disabled event state */
366  for (i = 0; i < SDL_arraysize(SDL_disabled_events); ++i) {
367  SDL_free(SDL_disabled_events[i]);
368  SDL_disabled_events[i] = NULL;
369  }
370 
371  if (SDL_event_watchers_lock) {
372  SDL_DestroyMutex(SDL_event_watchers_lock);
373  SDL_event_watchers_lock = NULL;
374  }
375  if (SDL_event_watchers) {
376  SDL_free(SDL_event_watchers);
377  SDL_event_watchers = NULL;
379  }
380  SDL_zero(SDL_EventOK);
381 
382  if (SDL_EventQ.lock) {
385  SDL_EventQ.lock = NULL;
386  }
387 }
388 
389 /* This function (and associated calls) may be called more than once */
390 int
392 {
393  /* We'll leave the event queue alone, since we might have gotten
394  some important events at launch (like SDL_DROPFILE)
395 
396  FIXME: Does this introduce any other bugs with events at startup?
397  */
398 
399  /* Create the lock and set ourselves active */
400 #if !SDL_THREADS_DISABLED
401  if (!SDL_EventQ.lock) {
402  SDL_EventQ.lock = SDL_CreateMutex();
403  if (SDL_EventQ.lock == NULL) {
404  return -1;
405  }
406  }
407 
408  if (!SDL_event_watchers_lock) {
409  SDL_event_watchers_lock = SDL_CreateMutex();
410  if (SDL_event_watchers_lock == NULL) {
411  return -1;
412  }
413  }
414 #endif /* !SDL_THREADS_DISABLED */
415 
416  /* Process most event types */
420 
421  SDL_AtomicSet(&SDL_EventQ.active, 1);
422 
423  return 0;
424 }
425 
426 
427 /* Add an event to the event queue -- called with the queue locked */
428 static int
430 {
431  SDL_EventEntry *entry;
432  const int initial_count = SDL_AtomicGet(&SDL_EventQ.count);
433  int final_count;
434 
435  if (initial_count >= SDL_MAX_QUEUED_EVENTS) {
436  SDL_SetError("Event queue is full (%d events)", initial_count);
437  return 0;
438  }
439 
440  if (SDL_EventQ.free == NULL) {
441  entry = (SDL_EventEntry *)SDL_malloc(sizeof(*entry));
442  if (!entry) {
443  return 0;
444  }
445  } else {
446  entry = SDL_EventQ.free;
447  SDL_EventQ.free = entry->next;
448  }
449 
450  #ifdef SDL_DEBUG_EVENTS
451  SDL_DebugPrintEvent(event);
452  #endif
453 
454  entry->event = *event;
455  if (event->type == SDL_SYSWMEVENT) {
456  entry->msg = *event->syswm.msg;
457  entry->event.syswm.msg = &entry->msg;
458  }
459 
460  if (SDL_EventQ.tail) {
461  SDL_EventQ.tail->next = entry;
462  entry->prev = SDL_EventQ.tail;
463  SDL_EventQ.tail = entry;
464  entry->next = NULL;
465  } else {
466  SDL_assert(!SDL_EventQ.head);
467  SDL_EventQ.head = entry;
468  SDL_EventQ.tail = entry;
469  entry->prev = NULL;
470  entry->next = NULL;
471  }
472 
473  final_count = SDL_AtomicAdd(&SDL_EventQ.count, 1) + 1;
474  if (final_count > SDL_EventQ.max_events_seen) {
475  SDL_EventQ.max_events_seen = final_count;
476  }
477 
478  return 1;
479 }
480 
481 /* Remove an event from the queue -- called with the queue locked */
482 static void
484 {
485  if (entry->prev) {
486  entry->prev->next = entry->next;
487  }
488  if (entry->next) {
489  entry->next->prev = entry->prev;
490  }
491 
492  if (entry == SDL_EventQ.head) {
493  SDL_assert(entry->prev == NULL);
494  SDL_EventQ.head = entry->next;
495  }
496  if (entry == SDL_EventQ.tail) {
497  SDL_assert(entry->next == NULL);
498  SDL_EventQ.tail = entry->prev;
499  }
500 
501  entry->next = SDL_EventQ.free;
502  SDL_EventQ.free = entry;
503  SDL_assert(SDL_AtomicGet(&SDL_EventQ.count) > 0);
504  SDL_AtomicAdd(&SDL_EventQ.count, -1);
505 }
506 
507 /* Lock the event queue, take a peep at it, and unlock it */
508 int
510  Uint32 minType, Uint32 maxType)
511 {
512  int i, used;
513 
514  /* Don't look after we've quit */
515  if (!SDL_AtomicGet(&SDL_EventQ.active)) {
516  /* We get a few spurious events at shutdown, so don't warn then */
517  if (action != SDL_ADDEVENT) {
518  SDL_SetError("The event system has been shut down");
519  }
520  return (-1);
521  }
522  /* Lock the event queue */
523  used = 0;
524  if (!SDL_EventQ.lock || SDL_LockMutex(SDL_EventQ.lock) == 0) {
525  if (action == SDL_ADDEVENT) {
526  for (i = 0; i < numevents; ++i) {
527  used += SDL_AddEvent(&events[i]);
528  }
529  } else {
530  SDL_EventEntry *entry, *next;
531  SDL_SysWMEntry *wmmsg, *wmmsg_next;
532  Uint32 type;
533 
534  if (action == SDL_GETEVENT) {
535  /* Clean out any used wmmsg data
536  FIXME: Do we want to retain the data for some period of time?
537  */
538  for (wmmsg = SDL_EventQ.wmmsg_used; wmmsg; wmmsg = wmmsg_next) {
539  wmmsg_next = wmmsg->next;
540  wmmsg->next = SDL_EventQ.wmmsg_free;
541  SDL_EventQ.wmmsg_free = wmmsg;
542  }
543  SDL_EventQ.wmmsg_used = NULL;
544  }
545 
546  for (entry = SDL_EventQ.head; entry && (!events || used < numevents); entry = next) {
547  next = entry->next;
548  type = entry->event.type;
549  if (minType <= type && type <= maxType) {
550  if (events) {
551  events[used] = entry->event;
552  if (entry->event.type == SDL_SYSWMEVENT) {
553  /* We need to copy the wmmsg somewhere safe.
554  For now we'll guarantee it's valid at least until
555  the next call to SDL_PeepEvents()
556  */
557  if (SDL_EventQ.wmmsg_free) {
558  wmmsg = SDL_EventQ.wmmsg_free;
559  SDL_EventQ.wmmsg_free = wmmsg->next;
560  } else {
561  wmmsg = (SDL_SysWMEntry *)SDL_malloc(sizeof(*wmmsg));
562  }
563  wmmsg->msg = *entry->event.syswm.msg;
564  wmmsg->next = SDL_EventQ.wmmsg_used;
565  SDL_EventQ.wmmsg_used = wmmsg;
566  events[used].syswm.msg = &wmmsg->msg;
567  }
568 
569  if (action == SDL_GETEVENT) {
570  SDL_CutEvent(entry);
571  }
572  }
573  ++used;
574  }
575  }
576  }
577  if (SDL_EventQ.lock) {
579  }
580  } else {
581  return SDL_SetError("Couldn't lock event queue");
582  }
583  return (used);
584 }
585 
586 SDL_bool
588 {
589  return (SDL_PeepEvents(NULL, 0, SDL_PEEKEVENT, type, type) > 0);
590 }
591 
592 SDL_bool
593 SDL_HasEvents(Uint32 minType, Uint32 maxType)
594 {
595  return (SDL_PeepEvents(NULL, 0, SDL_PEEKEVENT, minType, maxType) > 0);
596 }
597 
598 void
600 {
601  SDL_FlushEvents(type, type);
602 }
603 
604 void
605 SDL_FlushEvents(Uint32 minType, Uint32 maxType)
606 {
607  /* Don't look after we've quit */
608  if (!SDL_AtomicGet(&SDL_EventQ.active)) {
609  return;
610  }
611 
612  /* Make sure the events are current */
613 #if 0
614  /* Actually, we can't do this since we might be flushing while processing
615  a resize event, and calling this might trigger further resize events.
616  */
617  SDL_PumpEvents();
618 #endif
619 
620  /* Lock the event queue */
621  if (!SDL_EventQ.lock || SDL_LockMutex(SDL_EventQ.lock) == 0) {
622  SDL_EventEntry *entry, *next;
623  Uint32 type;
624  for (entry = SDL_EventQ.head; entry; entry = next) {
625  next = entry->next;
626  type = entry->event.type;
627  if (minType <= type && type <= maxType) {
628  SDL_CutEvent(entry);
629  }
630  }
631  if (SDL_EventQ.lock) {
633  }
634  }
635 }
636 
637 /* Run the system dependent event loops */
638 void
640 {
642 
643  /* Get events from the video subsystem */
644  if (_this) {
645  _this->PumpEvents(_this);
646  }
647 #if !SDL_JOYSTICK_DISABLED
648  /* Check for joystick state change */
649  if ((!SDL_disabled_events[SDL_JOYAXISMOTION >> 8] || SDL_JoystickEventState(SDL_QUERY))) {
651  }
652 #endif
653 
654  SDL_SendPendingQuit(); /* in case we had a signal handler fire, etc. */
655 }
656 
657 /* Public functions */
658 
659 int
661 {
662  return SDL_WaitEventTimeout(event, 0);
663 }
664 
665 int
667 {
668  return SDL_WaitEventTimeout(event, -1);
669 }
670 
671 int
673 {
674  Uint32 expiration = 0;
675 
676  if (timeout > 0)
677  expiration = SDL_GetTicks() + timeout;
678 
679  for (;;) {
680  SDL_PumpEvents();
682  case -1:
683  return 0;
684  case 0:
685  if (timeout == 0) {
686  /* Polling and no events, just return */
687  return 0;
688  }
689  if (timeout > 0 && SDL_TICKS_PASSED(SDL_GetTicks(), expiration)) {
690  /* Timeout expired and no events */
691  return 0;
692  }
693  SDL_Delay(10);
694  break;
695  default:
696  /* Has events */
697  return 1;
698  }
699  }
700 }
701 
702 int
704 {
705  event->common.timestamp = SDL_GetTicks();
706 
707  if (SDL_EventOK.callback || SDL_event_watchers_count > 0) {
708  if (!SDL_event_watchers_lock || SDL_LockMutex(SDL_event_watchers_lock) == 0) {
709  if (SDL_EventOK.callback && !SDL_EventOK.callback(SDL_EventOK.userdata, event)) {
710  if (SDL_event_watchers_lock) {
711  SDL_UnlockMutex(SDL_event_watchers_lock);
712  }
713  return 0;
714  }
715 
716  if (SDL_event_watchers_count > 0) {
717  /* Make sure we only dispatch the current watcher list */
718  int i, event_watchers_count = SDL_event_watchers_count;
719 
721  for (i = 0; i < event_watchers_count; ++i) {
722  if (!SDL_event_watchers[i].removed) {
723  SDL_event_watchers[i].callback(SDL_event_watchers[i].userdata, event);
724  }
725  }
727 
729  for (i = SDL_event_watchers_count; i--; ) {
730  if (SDL_event_watchers[i].removed) {
732  if (i < SDL_event_watchers_count) {
733  SDL_memmove(&SDL_event_watchers[i], &SDL_event_watchers[i+1], (SDL_event_watchers_count - i) * sizeof(SDL_event_watchers[i]));
734  }
735  }
736  }
738  }
739  }
740 
741  if (SDL_event_watchers_lock) {
742  SDL_UnlockMutex(SDL_event_watchers_lock);
743  }
744  }
745  }
746 
747  if (SDL_PeepEvents(event, 1, SDL_ADDEVENT, 0, 0) <= 0) {
748  return -1;
749  }
750 
752 
753  return 1;
754 }
755 
756 void
758 {
759  if (!SDL_event_watchers_lock || SDL_LockMutex(SDL_event_watchers_lock) == 0) {
760  /* Set filter and discard pending events */
761  SDL_EventOK.callback = filter;
762  SDL_EventOK.userdata = userdata;
764 
765  if (SDL_event_watchers_lock) {
766  SDL_UnlockMutex(SDL_event_watchers_lock);
767  }
768  }
769 }
770 
771 SDL_bool
773 {
774  SDL_EventWatcher event_ok;
775 
776  if (!SDL_event_watchers_lock || SDL_LockMutex(SDL_event_watchers_lock) == 0) {
777  event_ok = SDL_EventOK;
778 
779  if (SDL_event_watchers_lock) {
780  SDL_UnlockMutex(SDL_event_watchers_lock);
781  }
782  } else {
783  SDL_zero(event_ok);
784  }
785 
786  if (filter) {
787  *filter = event_ok.callback;
788  }
789  if (userdata) {
790  *userdata = event_ok.userdata;
791  }
792  return event_ok.callback ? SDL_TRUE : SDL_FALSE;
793 }
794 
795 void
797 {
798  if (!SDL_event_watchers_lock || SDL_LockMutex(SDL_event_watchers_lock) == 0) {
799  SDL_EventWatcher *event_watchers;
800 
801  event_watchers = SDL_realloc(SDL_event_watchers, (SDL_event_watchers_count + 1) * sizeof(*event_watchers));
802  if (event_watchers) {
803  SDL_EventWatcher *watcher;
804 
805  SDL_event_watchers = event_watchers;
806  watcher = &SDL_event_watchers[SDL_event_watchers_count];
807  watcher->callback = filter;
808  watcher->userdata = userdata;
809  watcher->removed = SDL_FALSE;
811  }
812 
813  if (SDL_event_watchers_lock) {
814  SDL_UnlockMutex(SDL_event_watchers_lock);
815  }
816  }
817 }
818 
819 void
821 {
822  if (!SDL_event_watchers_lock || SDL_LockMutex(SDL_event_watchers_lock) == 0) {
823  int i;
824 
825  for (i = 0; i < SDL_event_watchers_count; ++i) {
826  if (SDL_event_watchers[i].callback == filter && SDL_event_watchers[i].userdata == userdata) {
828  SDL_event_watchers[i].removed = SDL_TRUE;
830  } else {
832  if (i < SDL_event_watchers_count) {
833  SDL_memmove(&SDL_event_watchers[i], &SDL_event_watchers[i+1], (SDL_event_watchers_count - i) * sizeof(SDL_event_watchers[i]));
834  }
835  }
836  break;
837  }
838  }
839 
840  if (SDL_event_watchers_lock) {
841  SDL_UnlockMutex(SDL_event_watchers_lock);
842  }
843  }
844 }
845 
846 void
848 {
849  if (!SDL_EventQ.lock || SDL_LockMutex(SDL_EventQ.lock) == 0) {
850  SDL_EventEntry *entry, *next;
851  for (entry = SDL_EventQ.head; entry; entry = next) {
852  next = entry->next;
853  if (!filter(userdata, &entry->event)) {
854  SDL_CutEvent(entry);
855  }
856  }
857  if (SDL_EventQ.lock) {
859  }
860  }
861 }
862 
863 Uint8
865 {
866  Uint8 current_state;
867  Uint8 hi = ((type >> 8) & 0xff);
868  Uint8 lo = (type & 0xff);
869 
870  if (SDL_disabled_events[hi] &&
871  (SDL_disabled_events[hi]->bits[lo/32] & (1 << (lo&31)))) {
872  current_state = SDL_DISABLE;
873  } else {
874  current_state = SDL_ENABLE;
875  }
876 
877  if (state != current_state)
878  {
879  switch (state) {
880  case SDL_DISABLE:
881  /* Disable this event type and discard pending events */
882  if (!SDL_disabled_events[hi]) {
883  SDL_disabled_events[hi] = (SDL_DisabledEventBlock*) SDL_calloc(1, sizeof(SDL_DisabledEventBlock));
884  if (!SDL_disabled_events[hi]) {
885  /* Out of memory, nothing we can do... */
886  break;
887  }
888  }
889  SDL_disabled_events[hi]->bits[lo/32] |= (1 << (lo&31));
890  SDL_FlushEvent(type);
891  break;
892  case SDL_ENABLE:
893  SDL_disabled_events[hi]->bits[lo/32] &= ~(1 << (lo&31));
894  break;
895  default:
896  /* Querying state... */
897  break;
898  }
899  }
900 
901  return current_state;
902 }
903 
904 Uint32
905 SDL_RegisterEvents(int numevents)
906 {
907  Uint32 event_base;
908 
909  if ((numevents > 0) && (SDL_userevents+numevents <= SDL_LASTEVENT)) {
910  event_base = SDL_userevents;
911  SDL_userevents += numevents;
912  } else {
913  event_base = (Uint32)-1;
914  }
915  return event_base;
916 }
917 
918 int
920 {
921  int posted;
922 
923  posted = 0;
924  if (SDL_GetEventState(eventType) == SDL_ENABLE) {
926  event.type = eventType;
927  posted = (SDL_PushEvent(&event) > 0);
928  }
929  return (posted);
930 }
931 
932 int
934 {
935  int posted;
936 
937  posted = 0;
940  SDL_memset(&event, 0, sizeof(event));
941  event.type = SDL_SYSWMEVENT;
942  event.syswm.msg = message;
943  posted = (SDL_PushEvent(&event) > 0);
944  }
945  /* Update internal event state */
946  return (posted);
947 }
948 
949 int
951 {
953 }
954 
955 /* vi: set ts=4 sw=4 expandtab: */
SDL_SysWMEntry * wmmsg_used
Definition: SDL_events.c:85
void * data1
Definition: SDL_events.h:501
SDL_JoystickID which
Definition: SDL_events.h:360
SDL_eventaction
Definition: SDL_events.h:576
SDL_MouseMotionEvent motion
Definition: SDL_events.h:533
int SDL_PeepEvents(SDL_Event *events, int numevents, SDL_eventaction action, Uint32 minType, Uint32 maxType)
Definition: SDL_events.c:509
int SDL_WaitEventTimeout(SDL_Event *event, int timeout)
Waits until the specified timeout (in milliseconds) for the next available event. ...
Definition: SDL_events.c:672
#define SDL_LockMutex
SDL_ControllerAxisEvent caxis
Definition: SDL_events.h:541
SDL_bool SDL_GetEventFilter(SDL_EventFilter *filter, void **userdata)
Definition: SDL_events.c:772
struct _SDL_EventEntry * next
Definition: SDL_events.c:67
static SDL_EventWatcher * SDL_event_watchers
Definition: SDL_events.c:49
void SDL_PumpEvents(void)
Definition: SDL_events.c:639
SDL_SysWMmsg msg
Definition: SDL_events.c:72
SDL_bool removed
Definition: SDL_events.c:44
void * data2
Definition: SDL_events.h:502
GLuint GLsizei const GLchar * message
SDL_atomic_t active
Definition: SDL_events.c:79
SDL_EventFilter callback
Definition: SDL_events.c:42
SDL_bool SDL_HasEvent(Uint32 type)
Definition: SDL_events.c:587
A type representing an atomic integer value. It is a struct so people don&#39;t accidentally use numeric ...
Definition: SDL_atomic.h:198
static int SDL_AddEvent(SDL_Event *event)
Definition: SDL_events.c:429
SDL_SysWMmsg * msg
Definition: SDL_events.h:519
#define SDL_CreateMutex
struct xkb_state * state
static SDL_Event events[EVENT_BUF_SIZE]
Definition: testgesture.c:35
SDL_EventEntry * free
Definition: SDL_events.c:84
int SDL_StartEventLoop(void)
Definition: SDL_events.c:391
SDL_JoyBallEvent jball
Definition: SDL_events.h:537
#define SDL_MAX_QUEUED_EVENTS
Definition: SDL_events.c:39
SDL_JoystickID which
Definition: SDL_events.h:283
static int SDL_event_watchers_count
Definition: SDL_events.c:50
Uint32 timestamp
Definition: SDL_events.h:480
int(* SDL_EventFilter)(void *userdata, SDL_Event *event)
Definition: SDL_events.h:662
#define SDL_GetHint
SDL_Event event
Definition: SDL_events.c:64
#define SDL_ENABLE
Definition: SDL_events.h:722
int max_events_seen
Definition: SDL_events.c:81
Definition: SDL_events.c:70
GLenum GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const void * bits
SDL_QuitEvent quit
Definition: SDL_events.h:545
uint32_t Uint32
Definition: SDL_stdinc.h:181
#define SDL_realloc
Uint32 timestamp
Definition: SDL_events.h:498
static SDL_bool SDL_event_watchers_dispatching
Definition: SDL_events.c:51
union SDL_SysWMmsg::@16 msg
static struct @22 SDL_EventQ
SDL_MouseWheelEvent wheel
Definition: SDL_events.h:535
SDL_bool SDL_HasEvents(Uint32 minType, Uint32 maxType)
Definition: SDL_events.c:593
int SDL_SendSysWMEvent(SDL_SysWMmsg *message)
Definition: SDL_events.c:933
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
struct _SDL_SysWMEntry * next
Definition: SDL_events.c:73
SDL_WindowEvent window
Definition: SDL_events.h:529
Uint32 timestamp
Definition: SDL_events.h:518
void SDL_GestureProcessEvent(SDL_Event *event)
Definition: SDL_gesture.c:538
SDL_JoystickID which
Definition: SDL_events.h:299
#define SDL_Log
void SDL_FlushEvents(Uint32 minType, Uint32 maxType)
Definition: SDL_events.c:605
SDL_TextInputEvent text
Definition: SDL_events.h:532
char text[SDL_TEXTINPUTEVENT_TEXT_SIZE]
Definition: SDL_events.h:226
#define SDL_GetEventState(type)
Definition: SDL_events.h:735
static SDL_bool SDL_event_watchers_removed
Definition: SDL_events.c:52
Uint32 SDL_GetTicks(void)
Get the number of milliseconds since the SDL library initialization.
SDL_JoyAxisEvent jaxis
Definition: SDL_events.h:536
uint8_t Uint8
Definition: SDL_stdinc.h:157
#define SDL_free
SDL_MultiGestureEvent mgesture
Definition: SDL_events.h:549
struct _cl_event * event
SDL_EventType
The types of events that can be delivered.
Definition: SDL_events.h:55
void SDL_FlushEvent(Uint32 type)
Definition: SDL_events.c:599
char text[SDL_TEXTEDITINGEVENT_TEXT_SIZE]
Definition: SDL_events.h:211
int SDL_PushEvent(SDL_Event *event)
Add an event to the event queue.
Definition: SDL_events.c:703
#define SDL_zero(x)
Definition: SDL_stdinc.h:416
Uint32 windowID
Definition: SDL_events.h:499
void SDL_FilterEvents(SDL_EventFilter filter, void *userdata)
Definition: SDL_events.c:847
Definition: SDL_events.c:62
#define SDL_memmove
Uint32 timestamp
Definition: SDL_events.h:314
static void SDL_CutEvent(SDL_EventEntry *entry)
Definition: SDL_events.c:483
#define SDL_atoi
Uint8 SDL_EventState(Uint32 type, int state)
Definition: SDL_events.c:864
#define SDL_Delay
return Display return Display Bool Bool int int int return Display XEvent Bool(*) XPointer return Display return Display Drawable _Xconst char unsigned int unsigned int return Display Pixmap Pixmap XColor XColor unsigned int unsigned int return Display _Xconst char char int char return Display Visual unsigned int int int char unsigned int unsigned int in i)
Definition: SDL_x11sym.h:50
#define SDL_assert(condition)
Definition: SDL_assert.h:169
Uint32 timestamp
Definition: SDL_events.h:177
#define SDL_DISABLE
Definition: SDL_events.h:721
#define NULL
Definition: begin_code.h:164
#define SDL_AtomicAdd
SDL_bool
Definition: SDL_stdinc.h:139
SDL_EventEntry * tail
Definition: SDL_events.c:83
SDL_TextEditingEvent edit
Definition: SDL_events.h:531
#define SDL_JoystickUpdate
#define SDL_SetError
SDL_SysWMEvent syswm
Definition: SDL_events.h:547
#define SDL_DestroyMutex
int SDL_SendKeymapChangedEvent(void)
Definition: SDL_events.c:950
#define SDL_calloc
void SDL_DelEventWatch(SDL_EventFilter filter, void *userdata)
Definition: SDL_events.c:820
struct _SDL_EventEntry * prev
Definition: SDL_events.c:66
SDL_mutex * lock
Definition: SDL_events.c:78
SDL_atomic_t count
Definition: SDL_events.c:80
GLbitfield GLuint64 timeout
static Uint32 SDL_userevents
Definition: SDL_events.c:59
static SDL_DisabledEventBlock * SDL_disabled_events[256]
Definition: SDL_events.c:58
static SDL_mutex * SDL_event_watchers_lock
Definition: SDL_events.c:47
SDL_SysWMEntry * wmmsg_free
Definition: SDL_events.c:86
#define SDL_AtomicSet
#define SDL_AtomicGet
#define SDL_JoystickEventState
GLuint GLuint GLsizei GLenum type
Definition: SDL_opengl.h:1571
SDL_VideoDevice * SDL_GetVideoDevice(void)
Definition: SDL_video.c:586
static SDL_EventWatcher SDL_EventOK
Definition: SDL_events.c:48
#define SDL_UnlockMutex
void SDL_SendPendingQuit(void)
Definition: SDL_quit.c:144
#define SDL_arraysize(array)
Definition: SDL_stdinc.h:93
General event structure.
Definition: SDL_events.h:525
#define SDL_malloc
SDL_UserEvent user
Definition: SDL_events.h:546
int SDL_PollEvent(SDL_Event *event)
Polls for currently pending events.
Definition: SDL_events.c:660
int SDL_SendAppEvent(SDL_EventType eventType)
Definition: SDL_events.c:919
void SDL_AddEventWatch(SDL_EventFilter filter, void *userdata)
Definition: SDL_events.c:796
#define SDL_QUERY
Definition: SDL_events.h:719
SDL_JoyHatEvent jhat
Definition: SDL_events.h:538
int SDL_WaitEvent(SDL_Event *event)
Waits indefinitely for the next available event.
Definition: SDL_events.c:666
SDL_EventEntry * head
Definition: SDL_events.c:82
#define SDL_TICKS_PASSED(A, B)
Compare SDL ticks values, and return true if A has passed B.
Definition: SDL_timer.h:56
SDL_JoystickID which
Definition: SDL_events.h:315
void SDL_SetEventFilter(SDL_EventFilter filter, void *userdata)
Definition: SDL_events.c:757
#define SDL_memset
GLint GLint GLint GLint GLint GLint GLint GLbitfield GLenum filter
SDL_TouchID touchId
Definition: SDL_events.h:434
Uint32 type
Definition: SDL_events.h:527
void SDL_StopEventLoop(void)
Definition: SDL_events.c:317
void(* PumpEvents)(_THIS)
Definition: SDL_sysvideo.h:280
Uint32 SDL_RegisterEvents(int numevents)
Definition: SDL_events.c:905
SDL_SysWMmsg msg
Definition: SDL_events.c:65