1 /* xscreensaver, Copyright (c) 1993-2014 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_TYPES_H__
13 #define __XSCREENSAVER_TYPES_H__
15 typedef struct saver_info saver_info;
18 ul_read, /* reading input or ready to do so */
19 ul_success, /* auth success, unlock */
20 ul_fail, /* auth fail */
21 ul_cancel, /* user cancelled auth (pw_cancel or pw_null) */
22 ul_time, /* timed out */
23 ul_finished /* user pressed enter */
26 typedef struct screenhack screenhack;
35 RANDOM_HACKS, ONE_HACK, BLANK_ONLY, DONT_BLANK, RANDOM_HACKS_SAME
39 TEXT_DATE, TEXT_LITERAL, TEXT_FILE, TEXT_PROGRAM, TEXT_URL
45 typedef int (*auth_conv_cb_t) (
47 const struct auth_message *msg,
48 struct auth_response **resp,
51 typedef struct saver_preferences saver_preferences;
52 typedef struct saver_screen_info saver_screen_info;
53 typedef struct passwd_dialog_data passwd_dialog_data;
54 typedef struct splash_dialog_data splash_dialog_data;
55 typedef struct _monitor monitor;
57 typedef struct poll_mouse_data poll_mouse_data;
58 struct poll_mouse_data {
67 /* XInputExtension device support */
68 #include <X11/extensions/XInput.h>
70 typedef struct xinput_dev_info xinput_dev_info;
71 struct xinput_dev_info {
73 XEventClass press, release, valuator;
74 poll_mouse_data last_poll_mouse;
78 /* This structure holds all the user-specified parameters, read from the
79 command line, the resource database, or entered through a dialog box.
81 struct saver_preferences {
83 XrmDatabase db; /* The resource database into which the
84 init file is merged, and out of which the
85 preferences are parsed. */
87 time_t init_file_date; /* The date (from stat()) of the .xscreensaver
88 file the last time this process read or
91 Bool verbose_p; /* whether to print out lots of status info */
92 Bool timestamp_p; /* whether to mark messages with a timestamp */
93 Bool capture_stderr_p; /* whether to redirect stdout/stderr */
94 Bool ignore_uninstalled_p; /* whether to avoid displaying or complaining
95 about hacks that are not on $PATH */
96 Bool debug_p; /* pay no mind to the man behind the curtain */
97 Bool xsync_p; /* whether XSynchronize has been called */
99 Bool lock_p; /* whether to lock as well as save */
101 Bool fade_p; /* whether to fade to black, if possible */
102 Bool unfade_p; /* whether to fade from black, if possible */
103 Time fade_seconds; /* how long that should take */
104 int fade_ticks; /* how many ticks should be used */
105 Bool splash_p; /* whether to do a splash screen at startup */
107 Bool install_cmap_p; /* whether we should use our own colormap
108 when using the screen's default visual. */
111 Bool quad_p; /* whether to run four savers per monitor */
114 screenhack **screenhacks; /* the programs to run */
115 int screenhacks_count;
117 saver_mode mode; /* hack-selection mode */
118 int selected_hack; /* in one_hack mode, this is the one */
120 int nice_inferior; /* nice value for subprocs */
121 int inferior_memory_limit; /* setrlimit(LIMIT_AS) value for subprocs */
123 Time initial_delay; /* how long to sleep after launch */
124 Time splash_duration; /* how long the splash screen stays up */
125 Time timeout; /* how much idle time before activation */
126 Time lock_timeout; /* how long after activation locking starts */
127 Time cycle; /* how long each hack should run */
128 Time passwd_timeout; /* how much time before pw dialog goes down */
129 Time pointer_timeout; /* how often to check mouse position */
130 Time notice_events_timeout; /* how long after window creation to select */
131 Time watchdog_timeout; /* how often to re-raise and re-blank screen */
132 int pointer_hysteresis; /* mouse motions less than N/sec are ignored */
134 Bool dpms_enabled_p; /* Whether to power down the monitor */
135 Bool dpms_quickoff_p; /* Whether to power down monitor immediately
136 in "Blank Only" mode */
137 Time dpms_standby; /* how long until monitor goes black */
138 Time dpms_suspend; /* how long until monitor power-saves */
139 Time dpms_off; /* how long until monitor powers down */
141 Bool grab_desktop_p; /* These are not used by "xscreensaver" */
142 Bool grab_video_p; /* itself: they are used by the external */
143 Bool random_image_p; /* "xscreensaver-getimage" program, and set */
144 char *image_directory; /* by the "xscreensaver-demo" configurator. */
146 text_mode tmode; /* How we generate text to display. */
147 char *text_literal; /* used when tmode is TEXT_LITERAL. */
148 char *text_file; /* used when tmode is TEXT_FILE. */
149 char *text_program; /* used when tmode is TEXT_PROGRAM. */
150 char *text_url; /* used when tmode is TEXT_URL. */
152 Bool use_xidle_extension; /* which extension to use, if possible */
153 Bool use_mit_saver_extension;
154 Bool use_sgi_saver_extension;
155 Bool use_proc_interrupts;
156 Bool use_xinput_extension;
158 Bool getviewport_full_of_lies_p; /* XFree86 bug #421 */
160 char *shell; /* where to find /bin/sh */
162 char *demo_command; /* How to enter demo mode. */
163 char *prefs_command; /* How to edit preferences. */
164 char *help_url; /* Where the help document resides. */
165 char *load_url_command; /* How one loads URLs. */
166 char *new_login_command; /* Command for the "New Login" button. */
168 int auth_warning_slack; /* Don't warn about login failures if they
169 all happen within this many seconds of
170 a successful login. */
173 /* This structure holds all the data that applies to the program as a whole,
174 or to the non-screen-specific parts of the display connection.
176 The saver_preferences structure (prefs.h) holds all the user-specified
177 parameters, read from the command line, the resource database, or entered
178 through a dialog box.
182 saver_preferences prefs;
186 saver_screen_info *screens;
187 saver_screen_info *default_screen; /* ...on which dialogs will appear. */
188 monitor **monitor_layout; /* private to screens.c */
189 Visual **best_gl_visuals; /* visuals for GL hacks on screen N */
191 /* =======================================================================
192 global connection info
193 ======================================================================= */
198 /* =======================================================================
199 server extension info
200 ======================================================================= */
202 Bool using_xidle_extension; /* which extension is being used. */
203 Bool using_mit_saver_extension; /* Note that `p->use_*' is the *request*, */
204 Bool using_sgi_saver_extension; /* and `si->using_*' is the *reality*. */
205 Bool using_proc_interrupts;
207 # ifdef HAVE_MIT_SAVER_EXTENSION
208 int mit_saver_ext_event_number;
209 int mit_saver_ext_error_number;
211 # ifdef HAVE_SGI_SAVER_EXTENSION
212 int sgi_saver_ext_event_number;
213 int sgi_saver_ext_error_number;
216 int randr_event_number;
217 int randr_error_number;
218 Bool using_randr_extension;
221 Bool using_xinput_extension; /* Note that `p->use_*' is the *request*, */
222 /* and `si->using_*' is the *reality*. */
224 int xinput_ext_event_number; /* may not be used */
225 int xinput_ext_error_number;
226 int xinput_DeviceButtonPress; /* Extension device event codes. */
227 int xinput_DeviceButtonRelease; /* Assigned by server at runtime */
228 int xinput_DeviceMotionNotify;
229 xinput_dev_info *xinput_devices;
230 int num_xinput_devices;
233 /* =======================================================================
235 ======================================================================= */
237 Bool screen_blanked_p; /* Whether the saver is currently active. */
238 Window mouse_grab_window; /* Window holding our mouse grab */
239 Window keyboard_grab_window; /* Window holding our keyboard grab */
240 int mouse_grab_screen; /* The screen number the mouse grab is on */
241 int keyboard_grab_screen; /* The screen number the keyboard grab is on */
242 Bool fading_possible_p; /* Whether fading to/from black is possible. */
243 Bool throttled_p; /* Whether we should temporarily just blank
244 the screen, not run hacks. (Deprecated:
245 users should use "xset dpms force off"
247 time_t blank_time; /* The time at which the screen was blanked
248 (if currently blanked) or unblanked (if
252 /* =======================================================================
253 locking and runtime privileges
254 ======================================================================= */
256 Bool locked_p; /* Whether the screen is currently locked. */
257 Bool dbox_up_p; /* Whether the demo-mode or passwd dialogs
258 are currently visible */
260 Bool locking_disabled_p; /* Sometimes locking is impossible. */
261 char *nolock_reason; /* This is why. */
263 char *orig_uid; /* What uid/gid we had at startup, before
264 discarding privileges. */
265 char *uid_message; /* Any diagnostics from our attempt to
266 discard privileges (printed only in
268 Bool dangerous_uid_p; /* Set to true if we're running as a user id
269 which is known to not be a normal, non-
272 Window passwd_dialog; /* The password dialog, if it's up. */
273 passwd_dialog_data *pw_data; /* Other info necessary to draw it. */
275 int unlock_failures; /* Counts failed login attempts while the
277 time_t unlock_failure_time; /* Time of first failed login attempt. */
279 char *unlock_typeahead; /* If the screen is locked, and the user types
280 a character, we assume that it is the first
281 character of the password. It's stored here
282 for the password dialog to use to populate
285 char *user; /* The user whose session is locked. */
286 char *cached_passwd; /* Cached password, used to avoid multiple
287 prompts for password-only auth mechanisms.*/
288 unlock_state unlock_state;
290 auth_conv_cb_t unlock_cb; /* The function used to prompt for creds. */
291 void (*auth_finished_cb) (saver_info *si);
292 /* Called when authentication has finished,
293 regardless of success or failure.
297 /* =======================================================================
299 ======================================================================= */
301 Bool demoing_p; /* Whether we are demoing a single hack
304 Window splash_dialog; /* The splash dialog, if its up. */
305 splash_dialog_data *sp_data; /* Other info necessary to draw it. */
308 /* =======================================================================
310 ======================================================================= */
312 XtIntervalId lock_id; /* Timer to implement `prefs.lock_timeout' */
313 XtIntervalId cycle_id; /* Timer to implement `prefs.cycle' */
314 XtIntervalId timer_id; /* Timer to implement `prefs.timeout' */
315 XtIntervalId watchdog_id; /* Timer to implement `prefs.watchdog */
316 XtIntervalId check_pointer_timer_id; /* `prefs.pointer_timeout' */
318 XtIntervalId de_race_id; /* Timer to make sure screen un-blanks */
321 time_t last_activity_time; /* Used only when no server exts. */
322 time_t last_wall_clock_time; /* Used to detect laptop suspend. */
323 saver_screen_info *last_activity_screen;
325 Bool emergency_lock_p; /* Set when the wall clock has jumped
326 (presumably due to laptop suspend) and we
327 need to lock down right away instead of
328 waiting for the lock timer to go off. */
331 /* =======================================================================
333 ======================================================================= */
335 int selection_mode; /* Set to -1 if the NEXT ClientMessage has just
336 been received; set to -2 if PREV has just
337 been received; set to N if SELECT or DEMO N
338 has been received. (This is kind of nasty.)
341 /* =======================================================================
343 ======================================================================= */
345 XtIntervalId stderr_popup_timer;
349 /* This structure holds all the data that applies to the screen-specific parts
350 of the display connection; if the display has multiple screens, there will
351 be one of these for each screen.
353 struct saver_screen_info {
356 int number; /* The internal ordinal of this screen,
357 counting Xinerama rectangles as separate
359 int real_screen_number; /* The number of the underlying X screen on
360 which this rectangle lies. */
361 Screen *screen; /* The X screen in question. */
363 int x, y, width, height; /* The size and position of this rectangle
364 on its underlying X screen. */
366 Bool real_screen_p; /* This will be true of exactly one ssi per
369 Widget toplevel_shell;
371 /* =======================================================================
373 ======================================================================= */
375 Window screensaver_window; /* The window that will impersonate the root,
376 when the screensaver activates. Note that
377 the window stored here may change, as we
378 destroy and recreate it on different
380 Colormap cmap; /* The colormap that goes with the window. */
381 Bool install_cmap_p; /* Whether this screen should have its own
382 colormap installed, for whichever of several
383 reasons. This is definitive (even a false
384 value here overrides prefs->install_cmap_p.)
386 Visual *current_visual; /* The visual of the window. */
387 int current_depth; /* How deep the visual (and the window) are. */
389 Visual *default_visual; /* visual to use when none other specified */
391 Window real_vroot; /* The original virtual-root window. */
392 Window real_vroot_value; /* What was in the __SWM_VROOT property. */
394 Cursor cursor; /* A blank cursor that goes with the
396 unsigned long black_pixel; /* Black, allocated from `cmap'. */
398 int blank_vp_x, blank_vp_y; /* Where the virtual-scrolling viewport was
399 when the screen went blank. We need to
400 prevent the X server from letting the mouse
401 bump the edges to scroll while the screen
402 is locked, so we reset to this when it has
403 moved, and the lock dialog is up... */
405 # ifdef HAVE_MIT_SAVER_EXTENSION
406 Window server_mit_saver_window;
410 /* =======================================================================
412 ======================================================================= */
414 Colormap demo_cmap; /* The colormap that goes with the dialogs:
415 this might be the same as `cmap' so care
416 must be taken not to free it while it's
419 /* =======================================================================
421 ======================================================================= */
423 poll_mouse_data last_poll_mouse; /* Used only when no server exts. */
425 /* =======================================================================
427 ======================================================================= */
429 int current_hack; /* Index into `prefs.screenhacks' */
434 int stderr_line_height;
435 XFontStruct *stderr_font;
437 Window stderr_overlay_window; /* Used if the server has overlay planes */
438 Colormap stderr_cmap;
442 #endif /* __XSCREENSAVER_TYPES_H__ */