1 /* xscreensaver, Copyright (c) 1993-1998 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 Bool fading_possible_p; /* Whether fading to/from black is possible. */
88 Bool throttled_p; /* Whether we should temporarily just blank
89 the screen, not run hacks. */
90 time_t blank_time; /* The time at which the screen was blanked
91 (if currently blanked) or unblanked (if
95 /* =======================================================================
96 locking and runtime privileges
97 ======================================================================= */
99 Bool locked_p; /* Whether the screen is currently locked. */
100 Bool dbox_up_p; /* Whether the demo-mode or passwd dialogs
101 are currently visible */
103 Bool locking_disabled_p; /* Sometimes locking is impossible. */
104 char *nolock_reason; /* This is why. */
106 char *orig_uid; /* What uid/gid we had at startup, before
107 discarding privileges. */
108 char *uid_message; /* Any diagnostics from our attempt to
109 discard privileges (printed only in
111 Bool dangerous_uid_p; /* Set to true if we're running as a user id
112 which is known to not be a normal, non-
115 Window passwd_dialog; /* The password dialog, if its up. */
116 passwd_dialog_data *pw_data; /* Other info necessary to draw it. */
118 int unlock_failures; /* Counts failed login attempts while the
121 char *unlock_typeahead; /* If the screen is locked, and the user types
122 a character, we assume that it is the first
123 character of the password. It's stored here
124 for the password dialog to use to populate
128 /* =======================================================================
130 ======================================================================= */
132 Bool demoing_p; /* Whether we are demoing a single hack
135 Window splash_dialog; /* The splash dialog, if its up. */
136 splash_dialog_data *sp_data; /* Other info necessary to draw it. */
139 /* =======================================================================
141 ======================================================================= */
143 XtIntervalId lock_id; /* Timer to implement `prefs.lock_timeout' */
144 XtIntervalId cycle_id; /* Timer to implement `prefs.cycle' */
145 XtIntervalId timer_id; /* Timer to implement `prefs.timeout' */
146 XtIntervalId watchdog_id; /* Timer to implement `prefs.watchdog */
147 XtIntervalId check_pointer_timer_id; /* `prefs.pointer_timeout' */
149 time_t last_activity_time; /* Used only when no server exts. */
150 time_t last_wall_clock_time; /* Used to detect laptop suspend. */
151 saver_screen_info *last_activity_screen;
153 Bool emergency_lock_p; /* Set when the wall clock has jumped
154 (presumably due to laptop suspend) and we
155 need to lock down right away instead of
156 waiting for the lock timer to go off. */
159 /* =======================================================================
161 ======================================================================= */
163 int selection_mode; /* Set to -1 if the NEXT ClientMessage has just
164 been received; set to -2 if PREV has just
165 been received; set to N if SELECT or DEMO N
166 has been received. (This is kind of nasty.)
169 /* =======================================================================
171 ======================================================================= */
173 XtIntervalId stderr_popup_timer;
178 /* This structure holds all the data that applies to the screen-specific parts
179 of the display connection; if the display has multiple screens, there will
180 be one of these for each screen.
182 struct saver_screen_info {
186 Widget toplevel_shell;
188 /* =======================================================================
190 ======================================================================= */
192 Window screensaver_window; /* The window that will impersonate the root,
193 when the screensaver activates. Note that
194 the window stored here may change, as we
195 destroy and recreate it on different
197 Colormap cmap; /* The colormap that goes with the window. */
198 Bool install_cmap_p; /* Whether this screen should have its own
199 colormap installed, for whichever of several
200 reasons. This is definitive (even a false
201 value here overrides prefs->install_cmap_p.)
203 Visual *current_visual; /* The visual of the window. */
204 Visual *default_visual; /* visual to use when none other specified */
205 int current_depth; /* How deep the visual (and the window) are. */
207 Window real_vroot; /* The original virtual-root window. */
208 Window real_vroot_value; /* What was in the __SWM_VROOT property. */
210 Cursor cursor; /* A blank cursor that goes with the
212 unsigned long black_pixel; /* Black, allocated from `cmap'. */
214 int blank_vp_x, blank_vp_y; /* Where the virtual-scrolling viewport was
215 when the screen went blank. We need to
216 prevent the X server from letting the mouse
217 bump the edges to scroll while the screen
218 is locked, so we reset to this when it has
219 moved, and the lock dialog is up... */
221 # ifdef HAVE_MIT_SAVER_EXTENSION
222 Window server_mit_saver_window;
226 /* =======================================================================
228 ======================================================================= */
230 Colormap demo_cmap; /* The colormap that goes with the dialogs:
231 this might be the same as `cmap' so care
232 must be taken not to free it while it's
235 /* =======================================================================
237 ======================================================================= */
239 int poll_mouse_last_root_x; /* Used only when no server exts. */
240 int poll_mouse_last_root_y;
241 Window poll_mouse_last_child;
242 unsigned int poll_mouse_last_mask;
245 /* =======================================================================
247 ======================================================================= */
249 int current_hack; /* Index into `prefs.screenhacks' */
254 int stderr_line_height;
255 XFontStruct *stderr_font;
257 Window stderr_overlay_window; /* Used if the server has overlay planes */
258 Colormap stderr_cmap;
264 /* =======================================================================
265 server extensions and virtual roots
266 ======================================================================= */
268 extern void restore_real_vroot (saver_info *si);
269 extern void disable_builtin_screensaver (saver_info *, Bool unblank_screen_p);
270 extern Bool ensure_no_screensaver_running (Display *, Screen *);
272 #ifdef HAVE_MIT_SAVER_EXTENSION
273 extern Bool query_mit_saver_extension (saver_info *);
275 #ifdef HAVE_SGI_SAVER_EXTENSION
276 extern Bool query_sgi_saver_extension (saver_info *);
278 #ifdef HAVE_XIDLE_EXTENSION
279 extern Bool query_xidle_extension (saver_info *);
281 #ifdef HAVE_PROC_INTERRUPTS
282 extern Bool query_proc_interrupts_available (saver_info *, const char **why);
285 /* Display Power Management System (DPMS) interface. */
286 extern Bool monitor_powered_on_p (saver_info *si);
287 extern void monitor_power_on (saver_info *si);
290 /* =======================================================================
292 ======================================================================= */
294 extern void initialize_screensaver_window (saver_info *si);
295 extern void raise_window (saver_info *si,
296 Bool inhibit_fade, Bool between_hacks_p,
298 extern Bool blank_screen (saver_info *si);
299 extern void unblank_screen (saver_info *si);
301 extern void get_screen_viewport (saver_screen_info *ssi,
302 int *x_ret, int *y_ret,
303 int *w_ret, int *h_ret,
307 /* =======================================================================
309 ======================================================================= */
312 extern Bool unlock_p (saver_info *si);
313 extern Bool lock_priv_init (int argc, char **argv, Bool verbose_p);
314 extern Bool lock_init (int argc, char **argv, Bool verbose_p);
315 extern Bool passwd_valid_p (const char *typed_passwd, Bool verbose_p);
316 #endif /* NO_LOCKING */
318 extern void set_locked_p (saver_info *si, Bool locked_p);
319 extern int move_mouse_grab (saver_info *si, Window to, Cursor cursor);
322 /* =======================================================================
324 ======================================================================= */
326 extern void hack_uid (saver_info *si);
327 extern void describe_uids (saver_info *si, FILE *out);
329 /* =======================================================================
331 ======================================================================= */
333 extern void draw_shaded_rectangle (Display *dpy, Window window,
335 int width, int height,
337 unsigned long top_color,
338 unsigned long bottom_color);
339 extern int string_width (XFontStruct *font, char *s);
341 extern void make_splash_dialog (saver_info *si);
342 extern void handle_splash_event (saver_info *si, XEvent *e);
343 extern void skull (Display *, Window, GC, GC, int, int, int, int);
346 /* =======================================================================
348 ======================================================================= */
350 extern void start_notice_events_timer (saver_info *, Window, Bool verbose_p);
351 extern void cycle_timer (XtPointer si, XtIntervalId *id);
352 extern void activate_lock_timer (XtPointer si, XtIntervalId *id);
353 extern void reset_watchdog_timer (saver_info *si, Bool on_p);
354 extern void idle_timer (XtPointer si, XtIntervalId *id);
355 extern void sleep_until_idle (saver_info *si, Bool until_idle_p);
357 /* =======================================================================
359 ======================================================================= */
361 extern Bool handle_clientmessage (saver_info *, XEvent *, Bool);
362 extern void maybe_reload_init_file (saver_info *);
364 /* =======================================================================
366 ======================================================================= */
368 extern void hack_environment (saver_info *si);
369 extern void hack_subproc_environment (saver_screen_info *ssi);
370 extern void init_sigchld (void);
371 extern void spawn_screenhack (saver_info *si, Bool first_time_p);
372 extern void kill_screenhack (saver_info *si);
373 extern void suspend_screenhack (saver_info *si, Bool suspend_p);
374 extern Bool screenhack_running_p (saver_info *si);
375 extern void emergency_kill_subproc (saver_info *si);
376 extern Bool select_visual (saver_screen_info *ssi, const char *visual_name);
377 extern void store_saver_status (saver_info *si);
378 extern const char *signal_name (int signal);
380 /* =======================================================================
382 ======================================================================= */
384 extern FILE *real_stderr;
385 extern FILE *real_stdout;
386 extern void initialize_stderr (saver_info *si);
387 extern void reset_stderr (saver_screen_info *ssi);
388 extern void clear_stderr (saver_screen_info *ssi);
391 /* =======================================================================
393 ======================================================================= */
395 extern const char *blurb (void);
396 extern void save_argv (int argc, char **argv);
397 extern void saver_exit (saver_info *si, int status, const char *core_reason);
398 extern void restart_process (saver_info *si);
400 extern int saver_ehandler (Display *dpy, XErrorEvent *error);
401 extern int BadWindow_ehandler (Display *dpy, XErrorEvent *error);
402 extern Bool window_exists_p (Display *dpy, Window window);
403 extern char *timestring (void);
404 extern Bool display_is_on_console_p (saver_info *si);
406 extern Atom XA_VROOT, XA_XSETROOT_ID;
407 extern Atom XA_SCREENSAVER, XA_SCREENSAVER_VERSION, XA_SCREENSAVER_ID;
408 extern Atom XA_SCREENSAVER_STATUS, XA_LOCK, XA_BLANK;
409 extern Atom XA_DEMO, XA_PREFS;
411 #endif /* __XSCREENSAVER_H__ */