1 /* xscreensaver, Copyright (c) 1993-2004 Jamie Zawinski <jwz@jwz.org>
3 * Permission to use, copy, modify, distribute, and sell this software and its
4 * documentation for any purpose is hereby granted without fee, provided that
5 * the above copyright notice appear in all copies and that both that
6 * copyright notice and this permission notice appear in supporting
7 * documentation. No representations are made about the suitability of this
8 * software for any purpose. It is provided "as is" without express or
12 #ifndef __XSCREENSAVER_H__
13 #define __XSCREENSAVER_H__
24 # include <signal.h> /* for sigset_t */
29 extern char *progname;
30 extern char *progclass;
32 typedef struct saver_info saver_info;
33 typedef struct saver_screen_info saver_screen_info;
34 typedef struct passwd_dialog_data passwd_dialog_data;
35 typedef struct splash_dialog_data splash_dialog_data;
38 #define countof(x) (sizeof((x))/sizeof((*x)))
42 /* This structure holds all the data that applies to the program as a whole,
43 or to the non-screen-specific parts of the display connection.
45 The saver_preferences structure (prefs.h) holds all the user-specified
46 parameters, read from the command line, the resource database, or entered
51 saver_preferences prefs;
54 saver_screen_info *screens;
55 saver_screen_info *default_screen; /* ...on which dialogs will appear. */
58 /* =======================================================================
59 global connection info
60 ======================================================================= */
65 /* =======================================================================
67 ======================================================================= */
69 Bool xinerama_p; /* Whether Xinerama is in use. */
70 Bool using_xidle_extension; /* which extension is being used. */
71 Bool using_mit_saver_extension; /* Note that `p->use_*' is the *request*, */
72 Bool using_sgi_saver_extension; /* and `si->using_*' is the *reality*. */
73 Bool using_proc_interrupts;
75 # ifdef HAVE_MIT_SAVER_EXTENSION
76 int mit_saver_ext_event_number;
77 int mit_saver_ext_error_number;
79 # ifdef HAVE_SGI_SAVER_EXTENSION
80 int sgi_saver_ext_event_number;
81 int sgi_saver_ext_error_number;
84 int randr_event_number;
85 int randr_error_number;
89 /* =======================================================================
91 ======================================================================= */
93 Bool screen_blanked_p; /* Whether the saver is currently active. */
94 Window mouse_grab_window; /* Window holding our mouse grab */
95 Window keyboard_grab_window; /* Window holding our keyboard grab */
96 int mouse_grab_screen; /* The screen number the mouse grab is on */
97 int keyboard_grab_screen; /* The screen number the keyboard grab is on */
98 Bool fading_possible_p; /* Whether fading to/from black is possible. */
99 Bool throttled_p; /* Whether we should temporarily just blank
100 the screen, not run hacks. */
101 time_t blank_time; /* The time at which the screen was blanked
102 (if currently blanked) or unblanked (if
106 /* =======================================================================
107 locking and runtime privileges
108 ======================================================================= */
110 Bool locked_p; /* Whether the screen is currently locked. */
111 Bool dbox_up_p; /* Whether the demo-mode or passwd dialogs
112 are currently visible */
114 Bool locking_disabled_p; /* Sometimes locking is impossible. */
115 char *nolock_reason; /* This is why. */
117 char *orig_uid; /* What uid/gid we had at startup, before
118 discarding privileges. */
119 char *uid_message; /* Any diagnostics from our attempt to
120 discard privileges (printed only in
122 Bool dangerous_uid_p; /* Set to true if we're running as a user id
123 which is known to not be a normal, non-
126 Window passwd_dialog; /* The password dialog, if its up. */
127 passwd_dialog_data *pw_data; /* Other info necessary to draw it. */
129 int unlock_failures; /* Counts failed login attempts while the
132 char *unlock_typeahead; /* If the screen is locked, and the user types
133 a character, we assume that it is the first
134 character of the password. It's stored here
135 for the password dialog to use to populate
139 /* =======================================================================
141 ======================================================================= */
143 Bool demoing_p; /* Whether we are demoing a single hack
146 Window splash_dialog; /* The splash dialog, if its up. */
147 splash_dialog_data *sp_data; /* Other info necessary to draw it. */
150 /* =======================================================================
152 ======================================================================= */
154 XtIntervalId lock_id; /* Timer to implement `prefs.lock_timeout' */
155 XtIntervalId cycle_id; /* Timer to implement `prefs.cycle' */
156 XtIntervalId timer_id; /* Timer to implement `prefs.timeout' */
157 XtIntervalId watchdog_id; /* Timer to implement `prefs.watchdog */
158 XtIntervalId check_pointer_timer_id; /* `prefs.pointer_timeout' */
160 time_t last_activity_time; /* Used only when no server exts. */
161 time_t last_wall_clock_time; /* Used to detect laptop suspend. */
162 saver_screen_info *last_activity_screen;
164 Bool emergency_lock_p; /* Set when the wall clock has jumped
165 (presumably due to laptop suspend) and we
166 need to lock down right away instead of
167 waiting for the lock timer to go off. */
170 /* =======================================================================
172 ======================================================================= */
174 int selection_mode; /* Set to -1 if the NEXT ClientMessage has just
175 been received; set to -2 if PREV has just
176 been received; set to N if SELECT or DEMO N
177 has been received. (This is kind of nasty.)
180 /* =======================================================================
182 ======================================================================= */
184 XtIntervalId stderr_popup_timer;
189 /* This structure holds all the data that applies to the screen-specific parts
190 of the display connection; if the display has multiple screens, there will
191 be one of these for each screen.
193 struct saver_screen_info {
196 int number; /* The internal ordinal of this screen,
197 counting Xinerama rectangles as separate
199 int real_screen_number; /* The number of the underlying X screen on
200 which this rectangle lies. */
201 Screen *screen; /* The X screen in question. */
203 int x, y, width, height; /* The size and position of this rectangle
204 on its underlying X screen. */
206 Bool real_screen_p; /* This will be true of exactly one ssi per
209 Widget toplevel_shell;
211 /* =======================================================================
213 ======================================================================= */
215 Window screensaver_window; /* The window that will impersonate the root,
216 when the screensaver activates. Note that
217 the window stored here may change, as we
218 destroy and recreate it on different
220 Colormap cmap; /* The colormap that goes with the window. */
221 Bool install_cmap_p; /* Whether this screen should have its own
222 colormap installed, for whichever of several
223 reasons. This is definitive (even a false
224 value here overrides prefs->install_cmap_p.)
226 Visual *current_visual; /* The visual of the window. */
227 int current_depth; /* How deep the visual (and the window) are. */
229 Visual *default_visual; /* visual to use when none other specified */
230 Visual *best_gl_visual; /* visual to use for GL hacks */
232 Window real_vroot; /* The original virtual-root window. */
233 Window real_vroot_value; /* What was in the __SWM_VROOT property. */
235 Cursor cursor; /* A blank cursor that goes with the
237 unsigned long black_pixel; /* Black, allocated from `cmap'. */
239 int blank_vp_x, blank_vp_y; /* Where the virtual-scrolling viewport was
240 when the screen went blank. We need to
241 prevent the X server from letting the mouse
242 bump the edges to scroll while the screen
243 is locked, so we reset to this when it has
244 moved, and the lock dialog is up... */
246 # ifdef HAVE_MIT_SAVER_EXTENSION
247 Window server_mit_saver_window;
251 /* =======================================================================
253 ======================================================================= */
255 Colormap demo_cmap; /* The colormap that goes with the dialogs:
256 this might be the same as `cmap' so care
257 must be taken not to free it while it's
260 /* =======================================================================
262 ======================================================================= */
264 int poll_mouse_last_root_x; /* Used only when no server exts. */
265 int poll_mouse_last_root_y;
266 Window poll_mouse_last_child;
267 unsigned int poll_mouse_last_mask;
270 /* =======================================================================
272 ======================================================================= */
274 int current_hack; /* Index into `prefs.screenhacks' */
279 int stderr_line_height;
280 XFontStruct *stderr_font;
282 Window stderr_overlay_window; /* Used if the server has overlay planes */
283 Colormap stderr_cmap;
289 /* =======================================================================
290 server extensions and virtual roots
291 ======================================================================= */
293 extern Bool restore_real_vroot (saver_info *si);
294 extern void disable_builtin_screensaver (saver_info *, Bool unblank_screen_p);
295 extern Bool ensure_no_screensaver_running (Display *, Screen *);
297 #ifdef HAVE_MIT_SAVER_EXTENSION
298 extern Bool query_mit_saver_extension (saver_info *);
300 #ifdef HAVE_SGI_SAVER_EXTENSION
301 extern Bool query_sgi_saver_extension (saver_info *);
303 #ifdef HAVE_XIDLE_EXTENSION
304 extern Bool query_xidle_extension (saver_info *);
307 extern Bool query_randr_extension (saver_info *);
309 #ifdef HAVE_PROC_INTERRUPTS
310 extern Bool query_proc_interrupts_available (saver_info *, const char **why);
313 /* Display Power Management System (DPMS) interface. */
314 extern Bool monitor_powered_on_p (saver_info *si);
315 extern void monitor_power_on (saver_info *si);
318 /* =======================================================================
320 ======================================================================= */
322 extern void initialize_screensaver_window (saver_info *si);
323 extern void raise_window (saver_info *si,
324 Bool inhibit_fade, Bool between_hacks_p,
326 extern Bool blank_screen (saver_info *si);
327 extern void unblank_screen (saver_info *si);
328 extern void resize_screensaver_window (saver_info *si);
330 extern void get_screen_viewport (saver_screen_info *ssi,
331 int *x_ret, int *y_ret,
332 int *w_ret, int *h_ret,
333 int target_x, int target_y,
337 /* =======================================================================
339 ======================================================================= */
342 extern Bool unlock_p (saver_info *si);
343 extern Bool lock_priv_init (int argc, char **argv, Bool verbose_p);
344 extern Bool lock_init (int argc, char **argv, Bool verbose_p);
345 extern Bool passwd_valid_p (const char *typed_passwd, Bool verbose_p);
346 #endif /* NO_LOCKING */
348 extern void set_locked_p (saver_info *si, Bool locked_p);
349 extern int move_mouse_grab (saver_info *si, Window to, Cursor cursor,
351 extern int mouse_screen (saver_info *si);
354 /* =======================================================================
356 ======================================================================= */
358 extern void hack_uid (saver_info *si);
359 extern void describe_uids (saver_info *si, FILE *out);
361 /* =======================================================================
363 ======================================================================= */
365 extern void draw_shaded_rectangle (Display *dpy, Window window,
367 int width, int height,
369 unsigned long top_color,
370 unsigned long bottom_color);
371 extern int string_width (XFontStruct *font, char *s);
373 extern void make_splash_dialog (saver_info *si);
374 extern void handle_splash_event (saver_info *si, XEvent *e);
377 /* =======================================================================
379 ======================================================================= */
381 extern void start_notice_events_timer (saver_info *, Window, Bool verbose_p);
382 extern void cycle_timer (XtPointer si, XtIntervalId *id);
383 extern void activate_lock_timer (XtPointer si, XtIntervalId *id);
384 extern void reset_watchdog_timer (saver_info *si, Bool on_p);
385 extern void idle_timer (XtPointer si, XtIntervalId *id);
386 extern void sleep_until_idle (saver_info *si, Bool until_idle_p);
387 extern void reset_timers (saver_info *si);
389 /* =======================================================================
391 ======================================================================= */
393 extern Bool handle_clientmessage (saver_info *, XEvent *, Bool);
394 extern void maybe_reload_init_file (saver_info *);
396 /* =======================================================================
398 ======================================================================= */
400 extern void handle_signals (saver_info *si);
401 #ifdef HAVE_SIGACTION
402 extern sigset_t block_sigchld (void);
403 #else /* !HAVE_SIGACTION */
404 extern int block_sigchld (void);
405 #endif /* !HAVE_SIGACTION */
406 extern void unblock_sigchld (void);
407 extern void hack_environment (saver_info *si);
408 extern void hack_subproc_environment (saver_screen_info *ssi);
409 extern void init_sigchld (void);
410 extern void spawn_screenhack (saver_info *si, Bool first_time_p);
411 extern void kill_screenhack (saver_info *si);
412 extern void suspend_screenhack (saver_info *si, Bool suspend_p);
413 extern Bool screenhack_running_p (saver_info *si);
414 extern void emergency_kill_subproc (saver_info *si);
415 extern Bool select_visual (saver_screen_info *ssi, const char *visual_name);
416 extern void store_saver_status (saver_info *si);
417 extern const char *signal_name (int signal);
418 extern void exec_command (const char *shell, const char *command,
421 /* =======================================================================
423 ======================================================================= */
425 extern FILE *real_stderr;
426 extern FILE *real_stdout;
427 extern void initialize_stderr (saver_info *si);
428 extern void reset_stderr (saver_screen_info *ssi);
429 extern void clear_stderr (saver_screen_info *ssi);
430 extern void shutdown_stderr (saver_info *si);
433 /* =======================================================================
435 ======================================================================= */
437 extern const char *blurb (void);
438 extern void save_argv (int argc, char **argv);
439 extern void saver_exit (saver_info *si, int status, const char *core_reason);
440 extern void restart_process (saver_info *si);
442 extern int saver_ehandler (Display *dpy, XErrorEvent *error);
443 extern int BadWindow_ehandler (Display *dpy, XErrorEvent *error);
444 extern Bool window_exists_p (Display *dpy, Window window);
445 extern char *timestring (void);
446 extern Bool display_is_on_console_p (saver_info *si);
447 extern Visual *get_best_gl_visual (saver_screen_info *ssi);
448 extern void check_for_leaks (const char *where);
450 extern Atom XA_VROOT, XA_XSETROOT_ID, XA_ESETROOT_PMAP_ID, XA_XROOTPMAP_ID;
451 extern Atom XA_SCREENSAVER, XA_SCREENSAVER_VERSION, XA_SCREENSAVER_ID;
452 extern Atom XA_SCREENSAVER_STATUS, XA_LOCK, XA_BLANK;
453 extern Atom XA_DEMO, XA_PREFS;
455 #endif /* __XSCREENSAVER_H__ */