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. */
92 /* =======================================================================
93 locking and runtime privileges
94 ======================================================================= */
96 Bool locked_p; /* Whether the screen is currently locked. */
97 Bool dbox_up_p; /* Whether the demo-mode or passwd dialogs
98 are currently visible */
100 Bool locking_disabled_p; /* Sometimes locking is impossible. */
101 char *nolock_reason; /* This is why. */
103 char *orig_uid; /* What uid/gid we had at startup, before
104 discarding privileges. */
105 char *uid_message; /* Any diagnostics from our attempt to
106 discard privileges (printed only in
108 Bool dangerous_uid_p; /* Set to true if we're running as a user id
109 which is known to not be a normal, non-
112 Window passwd_dialog; /* The password dialog, if its up. */
113 passwd_dialog_data *pw_data; /* Other info necessary to draw it. */
115 int unlock_failures; /* Counts failed login attempts while the
118 char *unlock_typeahead; /* If the screen is locked, and the user types
119 a character, we assume that it is the first
120 character of the password. It's stored here
121 for the password dialog to use to populate
125 /* =======================================================================
127 ======================================================================= */
129 Bool demoing_p; /* Whether we are demoing a single hack
132 Window splash_dialog; /* The splash dialog, if its up. */
133 splash_dialog_data *sp_data; /* Other info necessary to draw it. */
136 /* =======================================================================
138 ======================================================================= */
140 XtIntervalId lock_id; /* Timer to implement `prefs.lock_timeout' */
141 XtIntervalId cycle_id; /* Timer to implement `prefs.cycle' */
142 XtIntervalId timer_id; /* Timer to implement `prefs.timeout' */
143 XtIntervalId watchdog_id; /* Timer to implement `prefs.watchdog */
144 XtIntervalId check_pointer_timer_id; /* `prefs.pointer_timeout' */
146 time_t last_activity_time; /* Used only when no server exts. */
147 time_t last_wall_clock_time; /* Used to detect laptop suspend. */
148 saver_screen_info *last_activity_screen;
150 Bool emergency_lock_p; /* Set when the wall clock has jumped
151 (presumably due to laptop suspend) and we
152 need to lock down right away instead of
153 waiting for the lock timer to go off. */
156 /* =======================================================================
158 ======================================================================= */
160 int selection_mode; /* Set to -1 if the NEXT ClientMessage has just
161 been received; set to -2 if PREV has just
162 been received; set to N if SELECT or DEMO N
163 has been received. (This is kind of nasty.)
166 /* =======================================================================
168 ======================================================================= */
170 XtIntervalId stderr_popup_timer;
175 /* This structure holds all the data that applies to the screen-specific parts
176 of the display connection; if the display has multiple screens, there will
177 be one of these for each screen.
179 struct saver_screen_info {
183 Widget toplevel_shell;
185 /* =======================================================================
187 ======================================================================= */
189 Window screensaver_window; /* The window that will impersonate the root,
190 when the screensaver activates. Note that
191 the window stored here may change, as we
192 destroy and recreate it on different
194 Colormap cmap; /* The colormap that goes with the window. */
195 Bool install_cmap_p; /* Whether this screen should have its own
196 colormap installed, for whichever of several
197 reasons. This is definitive (even a false
198 value here overrides prefs->install_cmap_p.)
200 Visual *current_visual; /* The visual of the window. */
201 Visual *default_visual; /* visual to use when none other specified */
202 int current_depth; /* How deep the visual (and the window) are. */
204 Window real_vroot; /* The original virtual-root window. */
205 Window real_vroot_value; /* What was in the __SWM_VROOT property. */
207 Cursor cursor; /* A blank cursor that goes with the
209 unsigned long black_pixel; /* Black, allocated from `cmap'. */
211 int blank_vp_x, blank_vp_y; /* Where the virtual-scrolling viewport was
212 when the screen went blank. We need to
213 prevent the X server from letting the mouse
214 bump the edges to scroll while the screen
215 is locked, so we reset to this when it has
216 moved, and the lock dialog is up... */
218 # ifdef HAVE_MIT_SAVER_EXTENSION
219 Window server_mit_saver_window;
223 /* =======================================================================
225 ======================================================================= */
227 Colormap demo_cmap; /* The colormap that goes with the dialogs:
228 this might be the same as `cmap' so care
229 must be taken not to free it while it's
232 /* =======================================================================
234 ======================================================================= */
236 int poll_mouse_last_root_x; /* Used only when no server exts. */
237 int poll_mouse_last_root_y;
238 Window poll_mouse_last_child;
239 unsigned int poll_mouse_last_mask;
242 /* =======================================================================
244 ======================================================================= */
246 int current_hack; /* Index into `prefs.screenhacks' */
251 int stderr_line_height;
252 XFontStruct *stderr_font;
254 Window stderr_overlay_window; /* Used if the server has overlay planes */
255 Colormap stderr_cmap;
261 /* =======================================================================
262 server extensions and virtual roots
263 ======================================================================= */
265 extern void restore_real_vroot (saver_info *si);
266 extern void disable_builtin_screensaver (saver_info *, Bool unblank_screen_p);
267 extern Bool ensure_no_screensaver_running (Display *, Screen *);
269 #ifdef HAVE_MIT_SAVER_EXTENSION
270 extern Bool query_mit_saver_extension (saver_info *);
272 #ifdef HAVE_SGI_SAVER_EXTENSION
273 extern Bool query_sgi_saver_extension (saver_info *);
275 #ifdef HAVE_XIDLE_EXTENSION
276 extern Bool query_xidle_extension (saver_info *);
278 #ifdef HAVE_PROC_INTERRUPTS
279 extern Bool query_proc_interrupts_available (saver_info *, const char **why);
282 /* Display Power Management System (DPMS) interface. */
283 extern Bool monitor_powered_on_p (saver_info *si);
284 extern void monitor_power_on (saver_info *si);
287 /* =======================================================================
289 ======================================================================= */
291 extern void initialize_screensaver_window (saver_info *si);
292 extern void raise_window (saver_info *si,
293 Bool inhibit_fade, Bool between_hacks_p,
295 extern Bool blank_screen (saver_info *si);
296 extern void unblank_screen (saver_info *si);
298 extern void get_screen_viewport (saver_screen_info *ssi,
299 int *x_ret, int *y_ret,
300 int *w_ret, int *h_ret,
304 /* =======================================================================
306 ======================================================================= */
309 extern Bool unlock_p (saver_info *si);
310 extern Bool lock_priv_init (int argc, char **argv, Bool verbose_p);
311 extern Bool lock_init (int argc, char **argv, Bool verbose_p);
312 extern Bool passwd_valid_p (const char *typed_passwd, Bool verbose_p);
313 #endif /* NO_LOCKING */
315 extern void set_locked_p (saver_info *si, Bool locked_p);
316 extern int move_mouse_grab (saver_info *si, Window to, Cursor cursor);
319 /* =======================================================================
321 ======================================================================= */
323 extern void hack_uid (saver_info *si);
324 extern void describe_uids (saver_info *si, FILE *out);
326 /* =======================================================================
328 ======================================================================= */
330 extern void draw_shaded_rectangle (Display *dpy, Window window,
332 int width, int height,
334 unsigned long top_color,
335 unsigned long bottom_color);
336 extern int string_width (XFontStruct *font, char *s);
338 extern void make_splash_dialog (saver_info *si);
339 extern void handle_splash_event (saver_info *si, XEvent *e);
340 extern void skull (Display *, Window, GC, GC, int, int, int, int);
343 /* =======================================================================
345 ======================================================================= */
347 extern void start_notice_events_timer (saver_info *, Window, Bool verbose_p);
348 extern void cycle_timer (XtPointer si, XtIntervalId *id);
349 extern void activate_lock_timer (XtPointer si, XtIntervalId *id);
350 extern void reset_watchdog_timer (saver_info *si, Bool on_p);
351 extern void idle_timer (XtPointer si, XtIntervalId *id);
352 extern void sleep_until_idle (saver_info *si, Bool until_idle_p);
354 /* =======================================================================
356 ======================================================================= */
358 extern Bool handle_clientmessage (saver_info *, XEvent *, Bool);
359 extern void maybe_reload_init_file (saver_info *);
361 /* =======================================================================
363 ======================================================================= */
365 extern void hack_environment (saver_info *si);
366 extern void hack_subproc_environment (saver_screen_info *ssi);
367 extern void init_sigchld (void);
368 extern void spawn_screenhack (saver_info *si, Bool first_time_p);
369 extern void kill_screenhack (saver_info *si);
370 extern void suspend_screenhack (saver_info *si, Bool suspend_p);
371 extern Bool screenhack_running_p (saver_info *si);
372 extern void emergency_kill_subproc (saver_info *si);
373 extern Bool select_visual (saver_screen_info *ssi, const char *visual_name);
374 extern const char *signal_name (int signal);
376 /* =======================================================================
378 ======================================================================= */
380 extern FILE *real_stderr;
381 extern FILE *real_stdout;
382 extern void initialize_stderr (saver_info *si);
383 extern void reset_stderr (saver_screen_info *ssi);
384 extern void clear_stderr (saver_screen_info *ssi);
387 /* =======================================================================
389 ======================================================================= */
391 extern const char *blurb (void);
392 extern void save_argv (int argc, char **argv);
393 extern void saver_exit (saver_info *si, int status, const char *core_reason);
394 extern void restart_process (saver_info *si);
396 extern int saver_ehandler (Display *dpy, XErrorEvent *error);
397 extern int BadWindow_ehandler (Display *dpy, XErrorEvent *error);
398 extern Bool window_exists_p (Display *dpy, Window window);
399 extern char *timestring (void);
400 extern Bool display_is_on_console_p (saver_info *si);
402 extern Atom XA_VROOT, XA_XSETROOT_ID;
403 extern Atom XA_SCREENSAVER, XA_SCREENSAVER_VERSION, XA_SCREENSAVER_ID;
404 extern Atom XA_SCREENSAVER_TIME;
405 extern Atom XA_DEMO, XA_PREFS;
407 #endif /* __XSCREENSAVER_H__ */