1 /* timers.c --- detecting when the user is idle, and other timer-related tasks.
2 * xscreensaver, Copyright (c) 1991-2011 Jamie Zawinski <jwz@jwz.org>
4 * Permission to use, copy, modify, distribute, and sell this software and its
5 * documentation for any purpose is hereby granted without fee, provided that
6 * the above copyright notice appear in all copies and that both that
7 * copyright notice and this permission notice appear in supporting
8 * documentation. No representations are made about the suitability of this
9 * software for any purpose. It is provided "as is" without express or
19 #include <X11/Intrinsic.h>
25 # include <X11/Xmu/Error.h>
27 # include <Xmu/Error.h>
29 # else /* !HAVE_XMU */
31 #endif /* !HAVE_XMU */
33 #ifdef HAVE_XIDLE_EXTENSION
34 #include <X11/extensions/xidle.h>
35 #endif /* HAVE_XIDLE_EXTENSION */
37 #ifdef HAVE_MIT_SAVER_EXTENSION
38 #include <X11/extensions/scrnsaver.h>
39 #endif /* HAVE_MIT_SAVER_EXTENSION */
41 #ifdef HAVE_SGI_SAVER_EXTENSION
42 #include <X11/extensions/XScreenSaver.h>
43 #endif /* HAVE_SGI_SAVER_EXTENSION */
46 #include <X11/extensions/Xrandr.h>
47 #endif /* HAVE_RANDR */
49 #include "xscreensaver.h"
52 #define ABS(x)((x)<0?-(x):(x))
55 #define MAX(x,y)((x)>(y)?(x):(y))
58 #ifdef HAVE_PROC_INTERRUPTS
59 static Bool proc_interrupts_activity_p (saver_info *si);
60 #endif /* HAVE_PROC_INTERRUPTS */
62 static void check_for_clock_skew (saver_info *si);
66 idle_timer (XtPointer closure, XtIntervalId *id)
68 saver_info *si = (saver_info *) closure;
70 /* What an amazingly shitty design. Not only does Xt execute timeout
71 events from XtAppNextEvent() instead of from XtDispatchEvent(), but
72 there is no way to tell Xt to block until there is an X event OR a
73 timeout happens. Once your timeout proc is called, XtAppNextEvent()
74 still won't return until a "real" X event comes in.
76 So this function pushes a stupid, gratuitous, unnecessary event back
77 on the event queue to force XtAppNextEvent to return Right Fucking Now.
78 When the code in sleep_until_idle() sees an event of type XAnyEvent,
79 which the server never generates, it knows that a timeout has occurred.
82 fake_event.type = 0; /* XAnyEvent type, ignored. */
83 fake_event.xany.display = si->dpy;
84 fake_event.xany.window = 0;
85 XPutBackEvent (si->dpy, &fake_event);
87 /* If we are the timer that just went off, clear the pointer to the id. */
90 if (si->timer_id && *id != si->timer_id)
91 abort(); /* oops, scheduled timer twice?? */
98 schedule_wakeup_event (saver_info *si, Time when, Bool verbose_p)
103 fprintf (stderr, "%s: idle_timer already running\n", blurb());
107 /* Wake up periodically to ask the server if we are idle. */
108 si->timer_id = XtAppAddTimeOut (si->app, when, idle_timer,
112 fprintf (stderr, "%s: starting idle_timer (%ld, %ld)\n",
113 blurb(), when, si->timer_id);
118 notice_events (saver_info *si, Window window, Bool top_p)
120 saver_preferences *p = &si->prefs;
121 XWindowAttributes attrs;
122 unsigned long events;
123 Window root, parent, *kids;
127 if (XtWindowToWidget (si->dpy, window))
128 /* If it's one of ours, don't mess up its event mask. */
131 if (!XQueryTree (si->dpy, window, &root, &parent, &kids, &nkids))
136 /* Figure out which screen this window is on, for the diagnostics. */
137 for (screen_no = 0; screen_no < si->nscreens; screen_no++)
138 if (root == RootWindowOfScreen (si->screens[screen_no].screen))
141 XGetWindowAttributes (si->dpy, window, &attrs);
142 events = ((attrs.all_event_masks | attrs.do_not_propagate_mask)
145 /* Select for SubstructureNotify on all windows.
146 Select for KeyPress on all windows that already have it selected.
148 Note that we can't select for ButtonPress, because of X braindamage:
149 only one client at a time may select for ButtonPress on a given
150 window, though any number can select for KeyPress. Someone explain
153 So, if the user spends a while clicking the mouse without ever moving
154 the mouse or touching the keyboard, we won't know that they've been
155 active, and the screensaver will come on. That sucks, but I don't
156 know how to get around it.
158 Since X presents mouse wheels as clicks, this applies to those, too:
159 scrolling through a document using only the mouse wheel doesn't
160 count as activity... Fortunately, /proc/interrupts helps, on
161 systems that have it. Oh, if it's a PS/2 mouse, not serial or USB.
164 XSelectInput (si->dpy, window, SubstructureNotifyMask | events);
166 if (top_p && p->debug_p && (events & KeyPressMask))
168 /* Only mention one window per tree (hack hack). */
169 fprintf (stderr, "%s: %d: selected KeyPress on 0x%lX\n",
170 blurb(), screen_no, (unsigned long) window);
177 notice_events (si, kids [--nkids], top_p);
178 XFree ((char *) kids);
184 BadWindow_ehandler (Display *dpy, XErrorEvent *error)
186 /* When we notice a window being created, we spawn a timer that waits
187 30 seconds or so, and then selects events on that window. This error
188 handler is used so that we can cope with the fact that the window
189 may have been destroyed <30 seconds after it was created.
191 if (error->error_code == BadWindow ||
192 error->error_code == BadMatch ||
193 error->error_code == BadDrawable)
196 return saver_ehandler (dpy, error);
200 struct notice_events_timer_arg {
206 notice_events_timer (XtPointer closure, XtIntervalId *id)
208 struct notice_events_timer_arg *arg =
209 (struct notice_events_timer_arg *) closure;
211 XErrorHandler old_handler = XSetErrorHandler (BadWindow_ehandler);
213 saver_info *si = arg->si;
214 Window window = arg->w;
217 notice_events (si, window, True);
218 XSync (si->dpy, False);
219 XSetErrorHandler (old_handler);
223 start_notice_events_timer (saver_info *si, Window w, Bool verbose_p)
225 saver_preferences *p = &si->prefs;
226 struct notice_events_timer_arg *arg =
227 (struct notice_events_timer_arg *) malloc(sizeof(*arg));
230 XtAppAddTimeOut (si->app, p->notice_events_timeout, notice_events_timer,
234 fprintf (stderr, "%s: starting notice_events_timer for 0x%X (%lu)\n",
235 blurb(), (unsigned int) w, p->notice_events_timeout);
239 /* When the screensaver is active, this timer will periodically change
243 cycle_timer (XtPointer closure, XtIntervalId *id)
245 saver_info *si = (saver_info *) closure;
246 saver_preferences *p = &si->prefs;
247 Time how_long = p->cycle;
249 if (si->selection_mode > 0 &&
250 screenhack_running_p (si))
251 /* If we're in "SELECT n" mode, the cycle timer going off will just
252 restart this same hack again. There's not much point in doing this
253 every 5 or 10 minutes, but on the other hand, leaving one hack running
254 for days is probably not a great idea, since they tend to leak and/or
255 crash. So, restart the thing once an hour. */
256 how_long = 1000 * 60 * 60;
261 fprintf (stderr, "%s: dialog box up; delaying hack change.\n",
263 how_long = 30000; /* 30 secs */
268 maybe_reload_init_file (si);
269 for (i = 0; i < si->nscreens; i++)
270 kill_screenhack (&si->screens[i]);
272 raise_window (si, True, True, False);
274 if (!si->throttled_p)
275 for (i = 0; i < si->nscreens; i++)
276 spawn_screenhack (&si->screens[i]);
280 fprintf (stderr, "%s: not launching new hack (throttled.)\n",
287 si->cycle_id = XtAppAddTimeOut (si->app, how_long, cycle_timer,
291 fprintf (stderr, "%s: starting cycle_timer (%ld, %ld)\n",
292 blurb(), how_long, si->cycle_id);
297 fprintf (stderr, "%s: not starting cycle_timer: how_long == %ld\n",
298 blurb(), (unsigned long) how_long);
304 activate_lock_timer (XtPointer closure, XtIntervalId *id)
306 saver_info *si = (saver_info *) closure;
307 saver_preferences *p = &si->prefs;
310 fprintf (stderr, "%s: timed out; activating lock.\n", blurb());
311 set_locked_p (si, True);
315 /* Call this when user activity (or "simulated" activity) has been noticed.
318 reset_timers (saver_info *si)
320 saver_preferences *p = &si->prefs;
321 if (si->using_mit_saver_extension || si->using_sgi_saver_extension)
327 fprintf (stderr, "%s: killing idle_timer (%ld, %ld)\n",
328 blurb(), p->timeout, si->timer_id);
329 XtRemoveTimeOut (si->timer_id);
333 schedule_wakeup_event (si, p->timeout, p->debug_p); /* sets si->timer_id */
335 if (si->cycle_id) abort (); /* no cycle timer when inactive */
337 si->last_activity_time = time ((time_t *) 0);
339 /* This will (hopefully, supposedly) tell the server to re-set its
340 DPMS timer. Without this, the -deactivate clientmessage would
341 prevent xscreensaver from blanking, but would not prevent the
342 monitor from powering down. */
344 /* #### With some servers, this causes the screen to flicker every
345 time a key is pressed! Ok, I surrender. I give up on ever
346 having DPMS work properly.
348 XForceScreenSaver (si->dpy, ScreenSaverReset);
350 /* And if the monitor is already powered off, turn it on.
351 You'd think the above would do that, but apparently not? */
352 monitor_power_on (si, True);
358 /* Returns true if the mouse has moved since the last time we checked.
359 Small motions (of less than "hysteresis" pixels/second) are ignored.
362 pointer_moved_p (saver_screen_info *ssi, Bool mods_p)
364 saver_info *si = ssi->global;
365 saver_preferences *p = &si->prefs;
368 int root_x, root_y, x, y;
370 time_t now = time ((time_t *) 0);
371 unsigned int distance, dps;
372 unsigned long seconds = 0;
373 Bool moved_p = False;
375 /* don't check xinerama pseudo-screens. */
376 if (!ssi->real_screen_p) return False;
378 if (!XQueryPointer (si->dpy, ssi->screensaver_window, &root, &child,
379 &root_x, &root_y, &x, &y, &mask))
381 /* If XQueryPointer() returns false, the mouse is not on this screen.
389 distance = MAX (ABS (ssi->poll_mouse_last_root_x - root_x),
390 ABS (ssi->poll_mouse_last_root_y - root_y));
391 seconds = (now - ssi->poll_mouse_last_time);
394 /* When the screen is blanked, we get MotionNotify events, but when not
395 blanked, we poll only every 5 seconds, and that's not enough resolution
396 to do hysteresis based on a 1 second interval. So, assume that any
397 motion we've seen during the 5 seconds when our eyes were closed happened
398 in the last 1 second instead.
400 if (seconds > 1) seconds = 1;
402 dps = (seconds <= 0 ? distance : (distance / seconds));
404 /* Motion only counts if the rate is more than N pixels per second.
406 if (dps >= p->pointer_hysteresis &&
410 /* If the mouse is not on this screen but used to be, that's motion.
411 If the mouse was not on this screen, but is now, that's motion.
414 Bool on_screen_p = (root_x != -1 && root_y != -1);
415 Bool was_on_screen_p = (ssi->poll_mouse_last_root_x != -1 &&
416 ssi->poll_mouse_last_root_y != -1);
418 if (on_screen_p != was_on_screen_p)
422 if (p->debug_p && (distance != 0 || moved_p))
424 fprintf (stderr, "%s: %d: pointer %s", blurb(), ssi->number,
425 (moved_p ? "moved: " : "ignored:"));
426 if (ssi->poll_mouse_last_root_x == -1)
427 fprintf (stderr, "off screen");
429 fprintf (stderr, "%d,%d",
430 ssi->poll_mouse_last_root_x,
431 ssi->poll_mouse_last_root_y);
432 fprintf (stderr, " -> ");
434 fprintf (stderr, "off screen");
436 fprintf (stderr, "%d,%d", root_x, root_y);
437 if (ssi->poll_mouse_last_root_x != -1 && root_x != -1)
438 fprintf (stderr, " (%d,%d; %d/%lu=%d)",
439 ABS(ssi->poll_mouse_last_root_x - root_x),
440 ABS(ssi->poll_mouse_last_root_y - root_y),
441 distance, seconds, dps);
443 fprintf (stderr, ".\n");
448 mask != ssi->poll_mouse_last_mask)
453 fprintf (stderr, "%s: %d: modifiers changed: 0x%04x -> 0x%04x.\n",
454 blurb(), ssi->number, ssi->poll_mouse_last_mask, mask);
457 si->last_activity_screen = ssi;
458 ssi->poll_mouse_last_child = child;
459 ssi->poll_mouse_last_mask = mask;
461 if (moved_p || seconds > 0)
463 ssi->poll_mouse_last_time = now;
464 ssi->poll_mouse_last_root_x = root_x;
465 ssi->poll_mouse_last_root_y = root_y;
472 /* When we aren't using a server extension, this timer is used to periodically
473 wake up and poll the mouse position, which is possibly more reliable than
474 selecting motion events on every window.
477 check_pointer_timer (XtPointer closure, XtIntervalId *id)
480 saver_info *si = (saver_info *) closure;
481 saver_preferences *p = &si->prefs;
482 Bool active_p = False;
484 if (!si->using_proc_interrupts &&
485 (si->using_xidle_extension ||
486 si->using_mit_saver_extension ||
487 si->using_sgi_saver_extension))
488 /* If an extension is in use, we should not be polling the mouse.
489 Unless we're also checking /proc/interrupts, in which case, we should.
493 if (id && *id == si->check_pointer_timer_id) /* this is us - it's expired */
494 si->check_pointer_timer_id = 0;
496 if (si->check_pointer_timer_id) /* only queue one at a time */
497 XtRemoveTimeOut (si->check_pointer_timer_id);
499 si->check_pointer_timer_id = /* now re-queue */
500 XtAppAddTimeOut (si->app, p->pointer_timeout, check_pointer_timer,
503 for (i = 0; i < si->nscreens; i++)
505 saver_screen_info *ssi = &si->screens[i];
506 if (pointer_moved_p (ssi, True))
510 #ifdef HAVE_PROC_INTERRUPTS
512 si->using_proc_interrupts &&
513 proc_interrupts_activity_p (si))
517 #endif /* HAVE_PROC_INTERRUPTS */
522 check_for_clock_skew (si);
526 /* An unfortunate situation is this: the saver is not active, because the
527 user has been typing. The machine is a laptop. The user closes the lid
528 and suspends it. The CPU halts. Some hours later, the user opens the
529 lid. At this point, Xt's timers will fire, and xscreensaver will blank
532 So far so good -- well, not really, but it's the best that we can do,
533 since the OS doesn't send us a signal *before* shutdown -- but if the
534 user had delayed locking (lockTimeout > 0) then we should start off
535 in the locked state, rather than only locking N minutes from when the
536 lid was opened. Also, eschewing fading is probably a good idea, to
537 clamp down as soon as possible.
539 We only do this when we'd be polling the mouse position anyway.
540 This amounts to an assumption that machines with APM support also
541 have /proc/interrupts.
544 check_for_clock_skew (saver_info *si)
546 saver_preferences *p = &si->prefs;
547 time_t now = time ((time_t *) 0);
548 long shift = now - si->last_wall_clock_time;
552 int i = (si->last_wall_clock_time == 0 ? 0 : shift);
554 "%s: checking wall clock for hibernation (%d:%02d:%02d).\n",
556 (i / (60 * 60)), ((i / 60) % 60), (i % 60));
559 if (si->last_wall_clock_time != 0 &&
560 shift > (p->timeout / 1000))
563 fprintf (stderr, "%s: wall clock has jumped by %ld:%02ld:%02ld!\n",
565 (shift / (60 * 60)), ((shift / 60) % 60), (shift % 60));
567 si->emergency_lock_p = True;
568 idle_timer ((XtPointer) si, 0);
571 si->last_wall_clock_time = now;
577 dispatch_event (saver_info *si, XEvent *event)
579 /* If this is for the splash dialog, pass it along.
580 Note that the password dialog is handled with its own event loop,
581 so events for that window will never come through here.
583 if (si->splash_dialog && event->xany.window == si->splash_dialog)
584 handle_splash_event (si, event);
586 XtDispatchEvent (event);
591 swallow_unlock_typeahead_events (saver_info *si, XEvent *e)
597 memset (buf, 0, sizeof(buf));
603 if (event.xany.type == KeyPress)
606 int size = XLookupString ((XKeyEvent *) &event, s, 1, 0, 0);
607 if (size != 1) continue;
610 case '\010': case '\177': /* Backspace */
613 case '\025': case '\030': /* Erase line */
614 case '\012': case '\015': /* Enter */
615 case '\033': /* ESC */
618 case '\040': /* Space */
620 break; /* ignore space at beginning of line */
621 /* else, fall through */
628 } while (i < sizeof(buf)-1 &&
629 XCheckMaskEvent (si->dpy, KeyPressMask, &event));
633 if (si->unlock_typeahead)
635 memset (si->unlock_typeahead, 0, strlen(si->unlock_typeahead));
636 free (si->unlock_typeahead);
640 si->unlock_typeahead = strdup (buf);
642 si->unlock_typeahead = 0;
644 memset (buf, 0, sizeof(buf));
648 /* methods of detecting idleness:
650 explicitly informed by SGI SCREEN_SAVER server event;
651 explicitly informed by MIT-SCREEN-SAVER server event;
652 poll server idle time with XIDLE extension;
653 select events on all windows, and note absence of recent events;
654 note that /proc/interrupts has not changed in a while;
655 activated by clientmessage.
657 methods of detecting non-idleness:
659 read events on the xscreensaver window;
660 explicitly informed by SGI SCREEN_SAVER server event;
661 explicitly informed by MIT-SCREEN-SAVER server event;
662 select events on all windows, and note events on any of them;
663 note that /proc/interrupts has changed;
664 deactivated by clientmessage.
666 I trust that explains why this function is a big hairy mess.
669 sleep_until_idle (saver_info *si, Bool until_idle_p)
671 saver_preferences *p = &si->prefs;
673 /* We have to go through this union bullshit because gcc-4.4.0 has
674 stricter struct-aliasing rules. Without this, the optimizer
680 XRRScreenChangeNotifyEvent xrr_event;
681 # endif /* HAVE_RANDR */
682 # ifdef HAVE_MIT_SAVER_EXTENSION
683 XScreenSaverNotifyEvent sevent;
684 # endif /* HAVE_MIT_SAVER_EXTENSION */
687 /* We need to select events on all windows if we're not using any extensions.
688 Otherwise, we don't need to. */
689 Bool scanning_all_windows = !(si->using_xidle_extension ||
690 si->using_mit_saver_extension ||
691 si->using_sgi_saver_extension);
693 /* We need to periodically wake up and check for idleness if we're not using
694 any extensions, or if we're using the XIDLE extension. The other two
695 extensions explicitly deliver events when we go idle/non-idle, so we
696 don't need to poll. */
697 Bool polling_for_idleness = !(si->using_mit_saver_extension ||
698 si->using_sgi_saver_extension);
700 /* Whether we need to periodically wake up and check to see if the mouse has
701 moved. We only need to do this when not using any extensions. The reason
702 this isn't the same as `polling_for_idleness' is that the "idleness" poll
703 can happen (for example) 5 minutes from now, whereas the mouse-position
704 poll should happen with low periodicity. We don't need to poll the mouse
705 position with the XIDLE extension, but we do need to periodically wake up
706 and query the server with that extension. For our purposes, polling
707 /proc/interrupts is just like polling the mouse position. It has to
708 happen on the same kind of schedule. */
709 Bool polling_mouse_position = (si->using_proc_interrupts ||
710 !(si->using_xidle_extension ||
711 si->using_mit_saver_extension ||
712 si->using_sgi_saver_extension) ||
713 si->using_xinput_extension);
715 const char *why = 0; /* What caused the idle-state to change? */
719 if (polling_for_idleness)
720 /* This causes a no-op event to be delivered to us in a while, so that
721 we come back around through the event loop again. */
722 schedule_wakeup_event (si, p->timeout, p->debug_p);
724 if (polling_mouse_position)
725 /* Check to see if the mouse has moved, and set up a repeating timer
726 to do so periodically (typically, every 5 seconds.) */
727 check_pointer_timer ((XtPointer) si, 0);
732 XtAppNextEvent (si->app, &event.x_event);
734 switch (event.x_event.xany.type) {
735 case 0: /* our synthetic "timeout" event has been signalled */
740 /* We may be idle; check one last time to see if the mouse has
741 moved, just in case the idle-timer went off within the 5 second
742 window between mouse polling. If the mouse has moved, then
743 check_pointer_timer() will reset last_activity_time.
745 if (polling_mouse_position)
746 check_pointer_timer ((XtPointer) si, 0);
748 #ifdef HAVE_XIDLE_EXTENSION
749 if (si->using_xidle_extension)
751 /* The XIDLE extension uses the synthetic event to prod us into
752 re-asking the server how long the user has been idle. */
753 if (! XGetIdleTime (si->dpy, &idle))
755 fprintf (stderr, "%s: XGetIdleTime() failed.\n", blurb());
756 saver_exit (si, 1, 0);
760 #endif /* HAVE_XIDLE_EXTENSION */
761 #ifdef HAVE_MIT_SAVER_EXTENSION
762 if (si->using_mit_saver_extension)
764 /* We don't need to do anything in this case - the synthetic
765 event isn't necessary, as we get sent specific events
766 to wake us up. In fact, this event generally shouldn't
767 be being delivered when the MIT extension is in use. */
771 #endif /* HAVE_MIT_SAVER_EXTENSION */
772 #ifdef HAVE_SGI_SAVER_EXTENSION
773 if (si->using_sgi_saver_extension)
775 /* We don't need to do anything in this case - the synthetic
776 event isn't necessary, as we get sent specific events
777 to wake us up. In fact, this event generally shouldn't
778 be being delivered when the SGI extension is in use. */
782 #endif /* HAVE_SGI_SAVER_EXTENSION */
784 /* Otherwise, no server extension is in use. The synthetic
785 event was to tell us to wake up and see if the user is now
786 idle. Compute the amount of idle time by comparing the
787 `last_activity_time' to the wall clock. The l_a_t was set
788 by calling `reset_timers()', which is called only in only
789 two situations: when polling the mouse position has revealed
790 the the mouse has moved (user activity) or when we have read
791 an event (again, user activity.)
793 idle = 1000 * (si->last_activity_time - time ((time_t *) 0));
796 if (idle >= p->timeout)
798 /* Look, we've been idle long enough. We're done. */
802 else if (si->emergency_lock_p)
804 /* Oops, the wall clock has jumped far into the future, so
805 we need to lock down in a hurry! */
806 why = "large wall clock change";
811 /* The event went off, but it turns out that the user has not
812 yet been idle for long enough. So re-signal the event.
813 Be economical: if we should blank after 5 minutes, and the
814 user has been idle for 2 minutes, then set this timer to
817 if (polling_for_idleness)
818 schedule_wakeup_event (si, p->timeout - idle, p->debug_p);
824 if (handle_clientmessage (si, &event.x_event, until_idle_p))
826 why = "ClientMessage";
832 /* A window has been created on the screen somewhere. If we're
833 supposed to scan all windows for events, prepare this window. */
834 if (scanning_all_windows)
836 Window w = event.x_event.xcreatewindow.window;
837 start_notice_events_timer (si, w, p->debug_p);
843 /* Ignore release events so that hitting ESC at the password dialog
844 doesn't result in the password dialog coming right back again when
845 the fucking release key is seen! */
846 /* case KeyRelease:*/
847 /* case ButtonRelease:*/
852 Window root=0, window=0;
854 const char *type = 0;
855 if (event.x_event.xany.type == MotionNotify)
857 /*type = "MotionNotify";*/
858 root = event.x_event.xmotion.root;
859 window = event.x_event.xmotion.window;
860 x = event.x_event.xmotion.x_root;
861 y = event.x_event.xmotion.y_root;
863 else if (event.x_event.xany.type == KeyPress)
866 root = event.x_event.xkey.root;
867 window = event.x_event.xkey.window;
870 else if (event.x_event.xany.type == ButtonPress)
872 type = "ButtonPress";
873 root = event.x_event.xkey.root;
874 window = event.x_event.xkey.window;
875 x = event.x_event.xmotion.x_root;
876 y = event.x_event.xmotion.y_root;
882 for (i = 0; i < si->nscreens; i++)
883 if (root == RootWindowOfScreen (si->screens[i].screen))
885 fprintf (stderr,"%s: %d: %s on 0x%lx",
886 blurb(), i, type, (unsigned long) window);
888 /* Be careful never to do this unless in -debug mode, as
889 this could expose characters from the unlock password. */
890 if (p->debug_p && event.x_event.xany.type == KeyPress)
894 XLookupString (&event.x_event.xkey, &c, 1, &keysym, 0);
895 fprintf (stderr, " (%s%s)",
896 (event.x_event.xkey.send_event ? "synthetic " : ""),
897 XKeysymToString (keysym));
901 fprintf (stderr, "\n");
903 fprintf (stderr, " at %d,%d.\n", x, y);
907 /* If any widgets want to handle this event, let them. */
908 dispatch_event (si, &event.x_event);
911 /* If we got a MotionNotify event, figure out what screen it
912 was on and poll the mouse there: if the mouse hasn't moved
913 far enough to count as "real" motion, then ignore this
916 if (event.x_event.xany.type == MotionNotify)
919 for (i = 0; i < si->nscreens; i++)
920 if (event.x_event.xmotion.root ==
921 RootWindowOfScreen (si->screens[i].screen))
923 if (i < si->nscreens)
925 if (!pointer_moved_p (&si->screens[i], False))
931 /* We got a user event.
932 If we're waiting for the user to become active, this is it.
933 If we're waiting until the user becomes idle, reset the timers
934 (since now we have longer to wait.)
939 (event.x_event.xany.type == MotionNotify ||
940 event.x_event.xany.type == KeyRelease))
941 /* When we're demoing a single hack, mouse motion doesn't
942 cause deactivation. Only clicks and keypresses do. */
946 /* If we're not demoing, then any activity causes deactivation.
948 why = (event.x_event.xany.type == MotionNotify ?"mouse motion":
949 event.x_event.xany.type == KeyPress?"keyboard activity":
950 event.x_event.xany.type == ButtonPress ? "mouse click" :
951 "unknown user activity");
962 #ifdef HAVE_MIT_SAVER_EXTENSION
963 if (event.x_event.type == si->mit_saver_ext_event_number)
965 /* This event's number is that of the MIT-SCREEN-SAVER server
966 extension. This extension has one event number, and the event
967 itself contains sub-codes that say what kind of event it was
968 (an "idle" or "not-idle" event.)
970 if (event.sevent.state == ScreenSaverOn)
974 fprintf (stderr, "%s: MIT ScreenSaverOn event received.\n",
977 /* Get the "real" server window(s) out of the way as soon
979 for (i = 0; i < si->nscreens; i++)
981 saver_screen_info *ssi = &si->screens[i];
982 if (ssi->server_mit_saver_window &&
983 window_exists_p (si->dpy,
984 ssi->server_mit_saver_window))
985 XUnmapWindow (si->dpy, ssi->server_mit_saver_window);
988 if (event.sevent.kind != ScreenSaverExternal)
991 "%s: ScreenSaverOn event wasn't of type External!\n",
997 why = "MIT ScreenSaverOn";
1001 else if (event.sevent.state == ScreenSaverOff)
1004 fprintf (stderr, "%s: MIT ScreenSaverOff event received.\n",
1008 why = "MIT ScreenSaverOff";
1014 "%s: unknown MIT-SCREEN-SAVER event %d received!\n",
1015 blurb(), event.sevent.state);
1019 #endif /* HAVE_MIT_SAVER_EXTENSION */
1022 #ifdef HAVE_SGI_SAVER_EXTENSION
1023 if (event.x_event.type == (si->sgi_saver_ext_event_number + ScreenSaverStart))
1025 /* The SGI SCREEN_SAVER server extension has two event numbers,
1026 and this event matches the "idle" event. */
1028 fprintf (stderr, "%s: SGI ScreenSaverStart event received.\n",
1033 why = "SGI ScreenSaverStart";
1037 else if (event.x_event.type == (si->sgi_saver_ext_event_number +
1040 /* The SGI SCREEN_SAVER server extension has two event numbers,
1041 and this event matches the "idle" event. */
1043 fprintf (stderr, "%s: SGI ScreenSaverEnd event received.\n",
1047 why = "SGI ScreenSaverEnd";
1052 #endif /* HAVE_SGI_SAVER_EXTENSION */
1055 if ((!until_idle_p) &&
1056 (si->num_xinput_devices > 0) &&
1057 (event.x_event.type == si->xinput_DeviceMotionNotify ||
1058 event.x_event.type == si->xinput_DeviceButtonPress))
1059 /* Ignore DeviceButtonRelease, see ButtonRelease comment above. */
1062 dispatch_event (si, &event.x_event);
1063 if (si->demoing_p &&
1064 event.x_event.type == si->xinput_DeviceMotionNotify)
1065 /* When we're demoing a single hack, mouse motion doesn't
1066 cause deactivation. Only clicks and keypresses do. */
1069 /* If we're not demoing, then any activity causes deactivation.
1072 why = (event.x_event.type == si->xinput_DeviceMotionNotify
1073 ? "XI mouse motion" :
1074 event.x_event.type == si->xinput_DeviceButtonPress
1075 ? "XI mouse click" : "unknown XINPUT event");
1080 #endif /* HAVE_XINPUT */
1083 if (si->using_randr_extension &&
1084 (event.x_event.type ==
1085 (si->randr_event_number + RRScreenChangeNotify)))
1087 /* The Resize and Rotate extension sends an event when the
1088 size, rotation, or refresh rate of any screen has changed.
1092 /* XRRRootToScreen is in Xrandr.h 1.4, 2001/06/07 */
1093 int screen = XRRRootToScreen (si->dpy, event.xrr_event.window);
1094 fprintf (stderr, "%s: %d: screen change event received\n",
1098 # ifdef RRScreenChangeNotifyMask
1099 /* Inform Xlib that it's ok to update its data structures. */
1100 XRRUpdateConfiguration (&event.x_event); /* Xrandr.h 1.9, 2002/09/29 */
1101 # endif /* RRScreenChangeNotifyMask */
1103 /* Resize the existing xscreensaver windows and cached ssi data. */
1104 if (update_screen_layout (si))
1108 fprintf (stderr, "%s: new layout:\n", blurb());
1109 describe_monitor_layout (si);
1111 resize_screensaver_window (si);
1115 #endif /* HAVE_RANDR */
1117 /* Just some random event. Let the Widgets handle it, if desired. */
1118 dispatch_event (si, &event.x_event);
1125 if (! why) why = "unknown reason";
1126 fprintf (stderr, "%s: %s (%s)\n", blurb(),
1127 (until_idle_p ? "user is idle" : "user is active"),
1131 /* If there's a user event on the queue, swallow it.
1132 If we're using a server extension, and the user becomes active, we
1133 get the extension event before the user event -- so the keypress or
1134 motion or whatever is still on the queue. This makes "unfade" not
1135 work, because it sees that event, and bugs out. (This problem
1136 doesn't exhibit itself without an extension, because in that case,
1137 there's only one event generated by user activity, not two.)
1139 if (!until_idle_p && si->locked_p)
1140 swallow_unlock_typeahead_events (si, &event.x_event);
1142 while (XCheckMaskEvent (si->dpy,
1143 (KeyPressMask|ButtonPressMask|PointerMotionMask),
1148 if (si->check_pointer_timer_id)
1150 XtRemoveTimeOut (si->check_pointer_timer_id);
1151 si->check_pointer_timer_id = 0;
1155 XtRemoveTimeOut (si->timer_id);
1159 if (until_idle_p && si->cycle_id) /* no cycle timer when inactive */
1165 /* Some crap for dealing with /proc/interrupts.
1167 On Linux systems, it's possible to see the hardware interrupt count
1168 associated with the keyboard. We can therefore use that as another method
1169 of detecting idleness.
1171 Why is it a good idea to do this? Because it lets us detect keyboard
1172 activity that is not associated with X events. For example, if the user
1173 has switched to another virtual console, it's good for xscreensaver to not
1174 be running graphics hacks on the (non-visible) X display. The common
1175 complaint that checking /proc/interrupts addresses is that the user is
1176 playing Quake on a non-X console, and the GL hacks are perceptibly slowing
1179 This is tricky for a number of reasons.
1181 * First, we must be sure to only do this when running on an X server that
1182 is on the local machine (because otherwise, we'd be reacting to the
1183 wrong keyboard.) The way we do this is by noting that the $DISPLAY is
1184 pointing to display 0 on the local machine. It *could* be that display
1185 1 is also on the local machine (e.g., two X servers, each on a different
1186 virtual-terminal) but it's also possible that screen 1 is an X terminal,
1187 using this machine as the host. So we can't take that chance.
1189 * Second, one can only access these interrupt numbers in a completely
1190 and utterly brain-damaged way. You would think that one would use an
1191 ioctl for this. But no. The ONLY way to get this information is to
1192 open the pseudo-file /proc/interrupts AS A FILE, and read the numbers
1193 out of it TEXTUALLY. Because this is Unix, and all the world's a file,
1194 and the only real data type is the short-line sequence of ASCII bytes.
1196 Now it's all well and good that the /proc/interrupts pseudo-file
1197 exists; that's a clever idea, and a useful API for things that are
1198 already textually oriented, like shell scripts, and users doing
1199 interactive debugging sessions. But to make a *C PROGRAM* open a file
1200 and parse the textual representation of integers out of it is just
1203 * Third, you can't just hold the file open, and fseek() back to the
1204 beginning to get updated data! If you do that, the data never changes.
1205 And I don't want to call open() every five seconds, because I don't want
1206 to risk going to disk for any inodes. It turns out that if you dup()
1207 it early, then each copy gets fresh data, so we can get around that in
1208 this way (but for how many releases, one might wonder?)
1210 * Fourth, the format of the output of the /proc/interrupts file is
1211 undocumented, and has changed several times already! In Linux 2.0.33,
1212 even on a multiprocessor machine, it looks like this:
1217 but in Linux 2.2 and 2.4 kernels with MP machines, it looks like this:
1220 0: 1671450 1672618 IO-APIC-edge timer
1221 1: 13037 13495 IO-APIC-edge keyboard
1223 and in Linux 2.6, it's gotten even goofier: now there are two lines
1224 labelled "i8042". One of them is the keyboard, and one of them is
1225 the PS/2 mouse -- and of course, you can't tell them apart, except
1226 by wiggling the mouse and noting which one changes:
1229 1: 32051 30864 IO-APIC-edge i8042
1230 12: 476577 479913 IO-APIC-edge i8042
1232 Joy! So how are we expected to parse that? Well, this code doesn't
1233 parse it: it saves the first line with the string "keyboard" (or
1234 "i8042") in it, and does a string-comparison to note when it has
1235 changed. If there are two "i8042" lines, we assume the first is
1236 the keyboard and the second is the mouse (doesn't matter which is
1237 which, really, as long as we don't compare them against each other.)
1239 Thanks to Nat Friedman <nat@nat.org> for figuring out most of this crap.
1241 Note that if you have a serial or USB mouse, or a USB keyboard, it won't
1242 detect it. That's because there's no way to tell the difference between a
1243 serial mouse and a general serial port, and all USB devices look the same
1244 from here. It would be somewhat unfortunate to have the screensaver turn
1245 off when the modem on COM1 burped, or when a USB disk was accessed.
1249 #ifdef HAVE_PROC_INTERRUPTS
1251 #define PROC_INTERRUPTS "/proc/interrupts"
1254 query_proc_interrupts_available (saver_info *si, const char **why)
1256 /* We can use /proc/interrupts if $DISPLAY points to :0, and if the
1257 "/proc/interrupts" file exists and is readable.
1262 if (!display_is_on_console_p (si))
1264 if (why) *why = "not on primary console";
1268 f = fopen (PROC_INTERRUPTS, "r");
1271 if (why) *why = "does not exist";
1281 proc_interrupts_activity_p (saver_info *si)
1283 static FILE *f0 = 0;
1286 static char last_kbd_line[255] = { 0, };
1287 static char last_ptr_line[255] = { 0, };
1288 char new_line[sizeof(last_kbd_line)];
1289 Bool checked_kbd = False, kbd_changed = False;
1290 Bool checked_ptr = False, ptr_changed = False;
1291 int i8042_count = 0;
1295 /* First time -- open the file. */
1296 f0 = fopen (PROC_INTERRUPTS, "r");
1300 sprintf(buf, "%s: error opening %s", blurb(), PROC_INTERRUPTS);
1306 if (f0 == (FILE *) -1) /* means we got an error initializing. */
1309 fd = dup (fileno (f0));
1313 sprintf(buf, "%s: could not dup() the %s fd", blurb(), PROC_INTERRUPTS);
1318 f1 = fdopen (fd, "r");
1322 sprintf(buf, "%s: could not fdopen() the %s fd", blurb(),
1328 /* Actually, I'm unclear on why this fseek() is necessary, given the timing
1329 of the dup() above, but it is. */
1330 if (fseek (f1, 0, SEEK_SET) != 0)
1333 sprintf(buf, "%s: error rewinding %s", blurb(), PROC_INTERRUPTS);
1338 /* Now read through the pseudo-file until we find the "keyboard",
1339 "PS/2 mouse", or "i8042" lines. */
1341 while (fgets (new_line, sizeof(new_line)-1, f1))
1343 Bool i8042_p = !!strstr (new_line, "i8042");
1344 if (i8042_p) i8042_count++;
1346 if (strchr (new_line, ','))
1348 /* Ignore any line that has a comma on it: this is because
1351 12: 930935 XT-PIC usb-uhci, PS/2 Mouse
1353 is really bad news. It *looks* like we can note mouse
1354 activity from that line, but really, that interrupt gets
1355 fired any time any USB device has activity! So we have
1356 to ignore any shared IRQs.
1359 else if (!checked_kbd &&
1360 (strstr (new_line, "keyboard") ||
1361 (i8042_p && i8042_count == 1)))
1363 /* Assume the keyboard interrupt is the line that says "keyboard",
1364 or the *first* line that says "i8042".
1366 kbd_changed = (*last_kbd_line && !!strcmp (new_line, last_kbd_line));
1367 strcpy (last_kbd_line, new_line);
1370 else if (!checked_ptr &&
1371 (strstr (new_line, "PS/2 Mouse") ||
1372 (i8042_p && i8042_count == 2)))
1374 /* Assume the mouse interrupt is the line that says "PS/2 mouse",
1375 or the *second* line that says "i8042".
1377 ptr_changed = (*last_ptr_line && !!strcmp (new_line, last_ptr_line));
1378 strcpy (last_ptr_line, new_line);
1382 if (checked_kbd && checked_ptr)
1386 if (checked_kbd || checked_ptr)
1390 if (si->prefs.debug_p && (kbd_changed || ptr_changed))
1391 fprintf (stderr, "%s: /proc/interrupts activity: %s\n",
1393 ((kbd_changed && ptr_changed) ? "mouse and kbd" :
1394 kbd_changed ? "kbd" :
1395 ptr_changed ? "mouse" : "ERR"));
1397 return (kbd_changed || ptr_changed);
1401 /* If we got here, we didn't find either a "keyboard" or a "PS/2 Mouse"
1402 line in the file at all. */
1403 fprintf (stderr, "%s: no keyboard or mouse data in %s?\n",
1404 blurb(), PROC_INTERRUPTS);
1410 if (f0 && f0 != (FILE *) -1)
1417 #endif /* HAVE_PROC_INTERRUPTS */
1420 /* This timer goes off every few minutes, whether the user is idle or not,
1421 to try and clean up anything that has gone wrong.
1423 It calls disable_builtin_screensaver() so that if xset has been used,
1424 or some other program (like xlock) has messed with the XSetScreenSaver()
1425 settings, they will be set back to sensible values (if a server extension
1426 is in use, messing with xlock can cause xscreensaver to never get a wakeup
1427 event, and could cause monitor power-saving to occur, and all manner of
1430 If the screen is currently blanked, it raises the window, in case some
1431 other window has been mapped on top of it.
1433 If the screen is currently blanked, and there is no hack running, it
1434 clears the window, in case there is an error message printed on it (we
1435 don't want the error message to burn in.)
1439 watchdog_timer (XtPointer closure, XtIntervalId *id)
1441 saver_info *si = (saver_info *) closure;
1442 saver_preferences *p = &si->prefs;
1444 disable_builtin_screensaver (si, False);
1446 /* If the DPMS settings on the server have changed, change them back to
1447 what ~/.xscreensaver says they should be. */
1448 sync_server_dpms_settings (si->dpy,
1449 (p->dpms_enabled_p &&
1450 p->mode != DONT_BLANK),
1451 p->dpms_standby / 1000,
1452 p->dpms_suspend / 1000,
1456 if (si->screen_blanked_p)
1458 Bool running_p = screenhack_running_p (si);
1462 if (si->prefs.debug_p)
1463 fprintf (stderr, "%s: dialog box is up: not raising screen.\n",
1468 if (si->prefs.debug_p)
1469 fprintf (stderr, "%s: watchdog timer raising %sscreen.\n",
1470 blurb(), (running_p ? "" : "and clearing "));
1472 raise_window (si, True, True, running_p);
1475 if (screenhack_running_p (si) &&
1476 !monitor_powered_on_p (si))
1479 if (si->prefs.verbose_p)
1481 "%s: X says monitor has powered down; "
1482 "killing running hacks.\n", blurb());
1483 for (i = 0; i < si->nscreens; i++)
1484 kill_screenhack (&si->screens[i]);
1487 /* Re-schedule this timer. The watchdog timer defaults to a bit less
1488 than the hack cycle period, but is never longer than one hour.
1490 si->watchdog_id = 0;
1491 reset_watchdog_timer (si, True);
1497 reset_watchdog_timer (saver_info *si, Bool on_p)
1499 saver_preferences *p = &si->prefs;
1501 if (si->watchdog_id)
1503 XtRemoveTimeOut (si->watchdog_id);
1504 si->watchdog_id = 0;
1507 if (on_p && p->watchdog_timeout)
1509 si->watchdog_id = XtAppAddTimeOut (si->app, p->watchdog_timeout,
1510 watchdog_timer, (XtPointer) si);
1513 fprintf (stderr, "%s: restarting watchdog_timer (%ld, %ld)\n",
1514 blurb(), p->watchdog_timeout, si->watchdog_id);
1519 /* It's possible that a race condition could have led to the saver
1520 window being unexpectedly still mapped. This can happen like so:
1524 - that hack tries to grab a screen image (it does this by
1525 first unmapping the saver window, then remapping it.)
1526 - hack unmaps window
1528 - user becomes active
1529 - hack re-maps window (*)
1530 - driver kills subprocess
1531 - driver unmaps window (**)
1533 The race is that (*) might have been sent to the server before
1534 the client process was killed, but, due to scheduling randomness,
1535 might not have been received by the server until after (**).
1536 In other words, (*) and (**) might happen out of order, meaning
1537 the driver will unmap the window, and then after that, the
1538 recently-dead client will re-map it. This leaves the user
1539 locked out (it looks like a desktop, but it's not!)
1541 To avoid this: after un-blanking the screen, we launch a timer
1542 that wakes up once a second for ten seconds, and makes damned
1543 sure that the window is still unmapped.
1547 de_race_timer (XtPointer closure, XtIntervalId *id)
1549 saver_info *si = (saver_info *) closure;
1550 saver_preferences *p = &si->prefs;
1553 if (id == 0) /* if id is 0, this is the initialization call. */
1555 si->de_race_ticks = 10;
1557 fprintf (stderr, "%s: starting de-race timer (%d seconds.)\n",
1558 blurb(), si->de_race_ticks);
1563 XSync (si->dpy, False);
1564 for (i = 0; i < si->nscreens; i++)
1566 saver_screen_info *ssi = &si->screens[i];
1567 Window w = ssi->screensaver_window;
1568 XWindowAttributes xgwa;
1569 XGetWindowAttributes (si->dpy, w, &xgwa);
1570 if (xgwa.map_state != IsUnmapped)
1574 "%s: %d: client race! emergency unmap 0x%lx.\n",
1575 blurb(), i, (unsigned long) w);
1576 XUnmapWindow (si->dpy, w);
1578 else if (p->debug_p)
1579 fprintf (stderr, "%s: %d: (de-race of 0x%lx is cool.)\n",
1580 blurb(), i, (unsigned long) w);
1582 XSync (si->dpy, False);
1584 si->de_race_ticks--;
1587 if (id && *id == si->de_race_id)
1590 if (si->de_race_id) abort();
1592 if (si->de_race_ticks <= 0)
1596 fprintf (stderr, "%s: de-race completed.\n", blurb());
1600 si->de_race_id = XtAppAddTimeOut (si->app, secs * 1000,
1601 de_race_timer, closure);