1 /* xscreensaver, Copyright (c) 1993-2003 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__
25 extern char *progname;
26 extern char *progclass;
28 typedef struct saver_info saver_info;
29 typedef struct saver_screen_info saver_screen_info;
30 typedef struct passwd_dialog_data passwd_dialog_data;
31 typedef struct splash_dialog_data splash_dialog_data;
34 #define countof(x) (sizeof((x))/sizeof((*x)))
38 /* This structure holds all the data that applies to the program as a whole,
39 or to the non-screen-specific parts of the display connection.
41 The saver_preferences structure (prefs.h) holds all the user-specified
42 parameters, read from the command line, the resource database, or entered
47 saver_preferences prefs;
50 saver_screen_info *screens;
51 saver_screen_info *default_screen; /* ...on which dialogs will appear. */
54 /* =======================================================================
55 global connection info
56 ======================================================================= */
61 /* =======================================================================
63 ======================================================================= */
65 Bool using_xidle_extension; /* which extension is being used. */
66 Bool using_mit_saver_extension; /* Note that `p->use_*' is the *request*, */
67 Bool using_sgi_saver_extension; /* and `si->using_*' is the *reality*. */
68 Bool using_proc_interrupts;
70 # ifdef HAVE_MIT_SAVER_EXTENSION
71 int mit_saver_ext_event_number;
72 int mit_saver_ext_error_number;
74 # ifdef HAVE_SGI_SAVER_EXTENSION
75 int sgi_saver_ext_event_number;
76 int sgi_saver_ext_error_number;
80 /* =======================================================================
82 ======================================================================= */
84 Bool screen_blanked_p; /* Whether the saver is currently active. */
85 Window mouse_grab_window; /* Window holding our mouse grab */
86 Window keyboard_grab_window; /* Window holding our keyboard grab */
87 int mouse_grab_screen; /* The screen number the mouse grab is on */
88 int keyboard_grab_screen; /* The screen number the keyboard grab is on */
89 Bool fading_possible_p; /* Whether fading to/from black is possible. */
90 Bool throttled_p; /* Whether we should temporarily just blank
91 the screen, not run hacks. */
92 time_t blank_time; /* The time at which the screen was blanked
93 (if currently blanked) or unblanked (if
97 /* =======================================================================
98 locking and runtime privileges
99 ======================================================================= */
101 Bool locked_p; /* Whether the screen is currently locked. */
102 Bool dbox_up_p; /* Whether the demo-mode or passwd dialogs
103 are currently visible */
105 Bool locking_disabled_p; /* Sometimes locking is impossible. */
106 char *nolock_reason; /* This is why. */
108 char *orig_uid; /* What uid/gid we had at startup, before
109 discarding privileges. */
110 char *uid_message; /* Any diagnostics from our attempt to
111 discard privileges (printed only in
113 Bool dangerous_uid_p; /* Set to true if we're running as a user id
114 which is known to not be a normal, non-
117 Window passwd_dialog; /* The password dialog, if its up. */
118 passwd_dialog_data *pw_data; /* Other info necessary to draw it. */
120 int unlock_failures; /* Counts failed login attempts while the
123 char *unlock_typeahead; /* If the screen is locked, and the user types
124 a character, we assume that it is the first
125 character of the password. It's stored here
126 for the password dialog to use to populate
130 /* =======================================================================
132 ======================================================================= */
134 Bool demoing_p; /* Whether we are demoing a single hack
137 Window splash_dialog; /* The splash dialog, if its up. */
138 splash_dialog_data *sp_data; /* Other info necessary to draw it. */
141 /* =======================================================================
143 ======================================================================= */
145 XtIntervalId lock_id; /* Timer to implement `prefs.lock_timeout' */
146 XtIntervalId cycle_id; /* Timer to implement `prefs.cycle' */
147 XtIntervalId timer_id; /* Timer to implement `prefs.timeout' */
148 XtIntervalId watchdog_id; /* Timer to implement `prefs.watchdog */
149 XtIntervalId check_pointer_timer_id; /* `prefs.pointer_timeout' */
151 time_t last_activity_time; /* Used only when no server exts. */
152 time_t last_wall_clock_time; /* Used to detect laptop suspend. */
153 saver_screen_info *last_activity_screen;
155 Bool emergency_lock_p; /* Set when the wall clock has jumped
156 (presumably due to laptop suspend) and we
157 need to lock down right away instead of
158 waiting for the lock timer to go off. */
161 /* =======================================================================
163 ======================================================================= */
165 int selection_mode; /* Set to -1 if the NEXT ClientMessage has just
166 been received; set to -2 if PREV has just
167 been received; set to N if SELECT or DEMO N
168 has been received. (This is kind of nasty.)
171 /* =======================================================================
173 ======================================================================= */
175 XtIntervalId stderr_popup_timer;
180 /* This structure holds all the data that applies to the screen-specific parts
181 of the display connection; if the display has multiple screens, there will
182 be one of these for each screen.
184 struct saver_screen_info {
189 Widget toplevel_shell;
191 /* =======================================================================
193 ======================================================================= */
195 Window screensaver_window; /* The window that will impersonate the root,
196 when the screensaver activates. Note that
197 the window stored here may change, as we
198 destroy and recreate it on different
200 Colormap cmap; /* The colormap that goes with the window. */
201 Bool install_cmap_p; /* Whether this screen should have its own
202 colormap installed, for whichever of several
203 reasons. This is definitive (even a false
204 value here overrides prefs->install_cmap_p.)
206 Visual *current_visual; /* The visual of the window. */
207 int current_depth; /* How deep the visual (and the window) are. */
209 Visual *default_visual; /* visual to use when none other specified */
210 Visual *best_gl_visual; /* visual to use for GL hacks */
212 Window real_vroot; /* The original virtual-root window. */
213 Window real_vroot_value; /* What was in the __SWM_VROOT property. */
215 Cursor cursor; /* A blank cursor that goes with the
217 unsigned long black_pixel; /* Black, allocated from `cmap'. */
219 int blank_vp_x, blank_vp_y; /* Where the virtual-scrolling viewport was
220 when the screen went blank. We need to
221 prevent the X server from letting the mouse
222 bump the edges to scroll while the screen
223 is locked, so we reset to this when it has
224 moved, and the lock dialog is up... */
226 # ifdef HAVE_MIT_SAVER_EXTENSION
227 Window server_mit_saver_window;
231 /* =======================================================================
233 ======================================================================= */
235 Colormap demo_cmap; /* The colormap that goes with the dialogs:
236 this might be the same as `cmap' so care
237 must be taken not to free it while it's
240 /* =======================================================================
242 ======================================================================= */
244 int poll_mouse_last_root_x; /* Used only when no server exts. */
245 int poll_mouse_last_root_y;
246 Window poll_mouse_last_child;
247 unsigned int poll_mouse_last_mask;
250 /* =======================================================================
252 ======================================================================= */
254 int current_hack; /* Index into `prefs.screenhacks' */
259 int stderr_line_height;
260 XFontStruct *stderr_font;
262 Window stderr_overlay_window; /* Used if the server has overlay planes */
263 Colormap stderr_cmap;
269 /* =======================================================================
270 server extensions and virtual roots
271 ======================================================================= */
273 extern Bool restore_real_vroot (saver_info *si);
274 extern void disable_builtin_screensaver (saver_info *, Bool unblank_screen_p);
275 extern Bool ensure_no_screensaver_running (Display *, Screen *);
277 #ifdef HAVE_MIT_SAVER_EXTENSION
278 extern Bool query_mit_saver_extension (saver_info *);
280 #ifdef HAVE_SGI_SAVER_EXTENSION
281 extern Bool query_sgi_saver_extension (saver_info *);
283 #ifdef HAVE_XIDLE_EXTENSION
284 extern Bool query_xidle_extension (saver_info *);
286 #ifdef HAVE_PROC_INTERRUPTS
287 extern Bool query_proc_interrupts_available (saver_info *, const char **why);
290 /* Display Power Management System (DPMS) interface. */
291 extern Bool monitor_powered_on_p (saver_info *si);
292 extern void monitor_power_on (saver_info *si);
295 /* =======================================================================
297 ======================================================================= */
299 extern void initialize_screensaver_window (saver_info *si);
300 extern void raise_window (saver_info *si,
301 Bool inhibit_fade, Bool between_hacks_p,
303 extern Bool blank_screen (saver_info *si);
304 extern void unblank_screen (saver_info *si);
306 extern void get_screen_viewport (saver_screen_info *ssi,
307 int *x_ret, int *y_ret,
308 int *w_ret, int *h_ret,
309 int target_x, int target_y,
313 /* =======================================================================
315 ======================================================================= */
318 extern Bool unlock_p (saver_info *si);
319 extern Bool lock_priv_init (int argc, char **argv, Bool verbose_p);
320 extern Bool lock_init (int argc, char **argv, Bool verbose_p);
321 extern Bool passwd_valid_p (const char *typed_passwd, Bool verbose_p);
322 #endif /* NO_LOCKING */
324 extern void set_locked_p (saver_info *si, Bool locked_p);
325 extern int move_mouse_grab (saver_info *si, Window to, Cursor cursor,
327 extern int mouse_screen (saver_info *si);
330 /* =======================================================================
332 ======================================================================= */
334 extern void hack_uid (saver_info *si);
335 extern void describe_uids (saver_info *si, FILE *out);
337 /* =======================================================================
339 ======================================================================= */
341 extern void draw_shaded_rectangle (Display *dpy, Window window,
343 int width, int height,
345 unsigned long top_color,
346 unsigned long bottom_color);
347 extern int string_width (XFontStruct *font, char *s);
349 extern void make_splash_dialog (saver_info *si);
350 extern void handle_splash_event (saver_info *si, XEvent *e);
353 /* =======================================================================
355 ======================================================================= */
357 extern void start_notice_events_timer (saver_info *, Window, Bool verbose_p);
358 extern void cycle_timer (XtPointer si, XtIntervalId *id);
359 extern void activate_lock_timer (XtPointer si, XtIntervalId *id);
360 extern void reset_watchdog_timer (saver_info *si, Bool on_p);
361 extern void idle_timer (XtPointer si, XtIntervalId *id);
362 extern void sleep_until_idle (saver_info *si, Bool until_idle_p);
363 extern void reset_timers (saver_info *si);
365 /* =======================================================================
367 ======================================================================= */
369 extern Bool handle_clientmessage (saver_info *, XEvent *, Bool);
370 extern void maybe_reload_init_file (saver_info *);
372 /* =======================================================================
374 ======================================================================= */
376 extern void handle_signals (saver_info *si);
377 #ifdef HAVE_SIGACTION
378 extern sigset_t block_sigchld (void);
379 #else /* !HAVE_SIGACTION */
380 extern int block_sigchld (void);
381 #endif /* !HAVE_SIGACTION */
382 extern void unblock_sigchld (void);
383 extern void hack_environment (saver_info *si);
384 extern void hack_subproc_environment (saver_screen_info *ssi);
385 extern void init_sigchld (void);
386 extern void spawn_screenhack (saver_info *si, Bool first_time_p);
387 extern void kill_screenhack (saver_info *si);
388 extern void suspend_screenhack (saver_info *si, Bool suspend_p);
389 extern Bool screenhack_running_p (saver_info *si);
390 extern void emergency_kill_subproc (saver_info *si);
391 extern Bool select_visual (saver_screen_info *ssi, const char *visual_name);
392 extern void store_saver_status (saver_info *si);
393 extern const char *signal_name (int signal);
394 extern void exec_command (const char *shell, const char *command,
397 /* =======================================================================
399 ======================================================================= */
401 extern FILE *real_stderr;
402 extern FILE *real_stdout;
403 extern void initialize_stderr (saver_info *si);
404 extern void reset_stderr (saver_screen_info *ssi);
405 extern void clear_stderr (saver_screen_info *ssi);
406 extern void shutdown_stderr (saver_info *si);
409 /* =======================================================================
411 ======================================================================= */
413 extern const char *blurb (void);
414 extern void save_argv (int argc, char **argv);
415 extern void saver_exit (saver_info *si, int status, const char *core_reason);
416 extern void restart_process (saver_info *si);
418 extern int saver_ehandler (Display *dpy, XErrorEvent *error);
419 extern int BadWindow_ehandler (Display *dpy, XErrorEvent *error);
420 extern Bool window_exists_p (Display *dpy, Window window);
421 extern char *timestring (void);
422 extern Bool display_is_on_console_p (saver_info *si);
423 extern Visual *get_best_gl_visual (saver_screen_info *ssi);
424 extern void check_for_leaks (const char *where);
426 extern Atom XA_VROOT, XA_XSETROOT_ID, XA_ESETROOT_PMAP_ID, XA_XROOTPMAP_ID;
427 extern Atom XA_SCREENSAVER, XA_SCREENSAVER_VERSION, XA_SCREENSAVER_ID;
428 extern Atom XA_SCREENSAVER_STATUS, XA_LOCK, XA_BLANK;
429 extern Atom XA_DEMO, XA_PREFS;
431 #endif /* __XSCREENSAVER_H__ */