1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
|
/* xscreensaver, Copyright (c) 1993-2005 Jamie Zawinski <jwz@jwz.org>
*
* Permission to use, copy, modify, distribute, and sell this software and its
* documentation for any purpose is hereby granted without fee, provided that
* the above copyright notice appear in all copies and that both that
* copyright notice and this permission notice appear in supporting
* documentation. No representations are made about the suitability of this
* software for any purpose. It is provided "as is" without express or
* implied warranty.
*/
#ifndef __XSCREENSAVER_H__
#define __XSCREENSAVER_H__
#include <stdlib.h>
#ifdef HAVE_UNISTD_H
# include <unistd.h>
#endif
#include <string.h>
#include <stdio.h>
#ifdef HAVE_SIGACTION
# include <signal.h> /* for sigset_t */
#endif
#include "prefs.h"
extern char *progname;
extern char *progclass;
typedef struct saver_info saver_info;
typedef struct saver_screen_info saver_screen_info;
typedef struct passwd_dialog_data passwd_dialog_data;
typedef struct splash_dialog_data splash_dialog_data;
#undef countof
#define countof(x) (sizeof((x))/sizeof((*x)))
/* This structure holds all the data that applies to the program as a whole,
or to the non-screen-specific parts of the display connection.
The saver_preferences structure (prefs.h) holds all the user-specified
parameters, read from the command line, the resource database, or entered
through a dialog box.
*/
struct saver_info {
char *version;
saver_preferences prefs;
int nscreens;
saver_screen_info *screens;
saver_screen_info *default_screen; /* ...on which dialogs will appear. */
/* =======================================================================
global connection info
======================================================================= */
XtAppContext app;
Display *dpy;
/* =======================================================================
server extension info
======================================================================= */
Bool xinerama_p; /* Whether Xinerama is in use. */
Bool using_xidle_extension; /* which extension is being used. */
Bool using_mit_saver_extension; /* Note that `p->use_*' is the *request*, */
Bool using_sgi_saver_extension; /* and `si->using_*' is the *reality*. */
Bool using_proc_interrupts;
# ifdef HAVE_MIT_SAVER_EXTENSION
int mit_saver_ext_event_number;
int mit_saver_ext_error_number;
# endif
# ifdef HAVE_SGI_SAVER_EXTENSION
int sgi_saver_ext_event_number;
int sgi_saver_ext_error_number;
# endif
# ifdef HAVE_RANDR
int randr_event_number;
int randr_error_number;
# endif
/* =======================================================================
blanking
======================================================================= */
Bool screen_blanked_p; /* Whether the saver is currently active. */
Window mouse_grab_window; /* Window holding our mouse grab */
Window keyboard_grab_window; /* Window holding our keyboard grab */
int mouse_grab_screen; /* The screen number the mouse grab is on */
int keyboard_grab_screen; /* The screen number the keyboard grab is on */
Bool fading_possible_p; /* Whether fading to/from black is possible. */
Bool throttled_p; /* Whether we should temporarily just blank
the screen, not run hacks. (Deprecated:
users should use "xset dpms force off"
instead.) */
time_t blank_time; /* The time at which the screen was blanked
(if currently blanked) or unblanked (if
not blanked.) */
/* =======================================================================
locking and runtime privileges
======================================================================= */
Bool locked_p; /* Whether the screen is currently locked. */
Bool dbox_up_p; /* Whether the demo-mode or passwd dialogs
are currently visible */
Bool locking_disabled_p; /* Sometimes locking is impossible. */
char *nolock_reason; /* This is why. */
char *orig_uid; /* What uid/gid we had at startup, before
discarding privileges. */
char *uid_message; /* Any diagnostics from our attempt to
discard privileges (printed only in
-verbose mode.) */
Bool dangerous_uid_p; /* Set to true if we're running as a user id
which is known to not be a normal, non-
privileged user. */
Window passwd_dialog; /* The password dialog, if its up. */
passwd_dialog_data *pw_data; /* Other info necessary to draw it. */
int unlock_failures; /* Counts failed login attempts while the
screen is locked. */
char *unlock_typeahead; /* If the screen is locked, and the user types
a character, we assume that it is the first
character of the password. It's stored here
for the password dialog to use to populate
itself. */
/* =======================================================================
demoing
======================================================================= */
Bool demoing_p; /* Whether we are demoing a single hack
(without UI.) */
Window splash_dialog; /* The splash dialog, if its up. */
splash_dialog_data *sp_data; /* Other info necessary to draw it. */
/* =======================================================================
timers
======================================================================= */
XtIntervalId lock_id; /* Timer to implement `prefs.lock_timeout' */
XtIntervalId cycle_id; /* Timer to implement `prefs.cycle' */
XtIntervalId timer_id; /* Timer to implement `prefs.timeout' */
XtIntervalId watchdog_id; /* Timer to implement `prefs.watchdog */
XtIntervalId check_pointer_timer_id; /* `prefs.pointer_timeout' */
XtIntervalId de_race_id; /* Timer to make sure screen un-blanks */
int de_race_ticks;
time_t last_activity_time; /* Used only when no server exts. */
time_t last_wall_clock_time; /* Used to detect laptop suspend. */
saver_screen_info *last_activity_screen;
Bool emergency_lock_p; /* Set when the wall clock has jumped
(presumably due to laptop suspend) and we
need to lock down right away instead of
waiting for the lock timer to go off. */
/* =======================================================================
remote control
======================================================================= */
int selection_mode; /* Set to -1 if the NEXT ClientMessage has just
been received; set to -2 if PREV has just
been received; set to N if SELECT or DEMO N
has been received. (This is kind of nasty.)
*/
/* =======================================================================
subprocs
======================================================================= */
XtIntervalId stderr_popup_timer;
};
/* This structure holds all the data that applies to the screen-specific parts
of the display connection; if the display has multiple screens, there will
be one of these for each screen.
*/
struct saver_screen_info {
saver_info *global;
int number; /* The internal ordinal of this screen,
counting Xinerama rectangles as separate
screens. */
int real_screen_number; /* The number of the underlying X screen on
which this rectangle lies. */
Screen *screen; /* The X screen in question. */
int x, y, width, height; /* The size and position of this rectangle
on its underlying X screen. */
Bool real_screen_p; /* This will be true of exactly one ssi per
X screen. */
Widget toplevel_shell;
/* =======================================================================
blanking
======================================================================= */
Window screensaver_window; /* The window that will impersonate the root,
when the screensaver activates. Note that
the window stored here may change, as we
destroy and recreate it on different
visuals. */
Colormap cmap; /* The colormap that goes with the window. */
Bool install_cmap_p; /* Whether this screen should have its own
colormap installed, for whichever of several
reasons. This is definitive (even a false
value here overrides prefs->install_cmap_p.)
*/
Visual *current_visual; /* The visual of the window. */
int current_depth; /* How deep the visual (and the window) are. */
Visual *default_visual; /* visual to use when none other specified */
Visual *best_gl_visual; /* visual to use for GL hacks */
Window real_vroot; /* The original virtual-root window. */
Window real_vroot_value; /* What was in the __SWM_VROOT property. */
Cursor cursor; /* A blank cursor that goes with the
real root window. */
unsigned long black_pixel; /* Black, allocated from `cmap'. */
int blank_vp_x, blank_vp_y; /* Where the virtual-scrolling viewport was
when the screen went blank. We need to
prevent the X server from letting the mouse
bump the edges to scroll while the screen
is locked, so we reset to this when it has
moved, and the lock dialog is up... */
# ifdef HAVE_MIT_SAVER_EXTENSION
Window server_mit_saver_window;
# endif
/* =======================================================================
demoing
======================================================================= */
Colormap demo_cmap; /* The colormap that goes with the dialogs:
this might be the same as `cmap' so care
must be taken not to free it while it's
still in use. */
/* =======================================================================
timers
======================================================================= */
int poll_mouse_last_root_x; /* Used only when no server exts. */
int poll_mouse_last_root_y;
Window poll_mouse_last_child;
unsigned int poll_mouse_last_mask;
time_t poll_mouse_last_time;
/* =======================================================================
subprocs
======================================================================= */
int current_hack; /* Index into `prefs.screenhacks' */
pid_t pid;
int stderr_text_x;
int stderr_text_y;
int stderr_line_height;
XFontStruct *stderr_font;
GC stderr_gc;
Window stderr_overlay_window; /* Used if the server has overlay planes */
Colormap stderr_cmap;
};
/* =======================================================================
server extensions and virtual roots
======================================================================= */
extern Bool restore_real_vroot (saver_info *si);
extern void disable_builtin_screensaver (saver_info *, Bool unblank_screen_p);
extern Bool ensure_no_screensaver_running (Display *, Screen *);
#ifdef HAVE_MIT_SAVER_EXTENSION
extern Bool query_mit_saver_extension (saver_info *);
#endif
#ifdef HAVE_SGI_SAVER_EXTENSION
extern Bool query_sgi_saver_extension (saver_info *);
#endif
#ifdef HAVE_XIDLE_EXTENSION
extern Bool query_xidle_extension (saver_info *);
#endif
#ifdef HAVE_RANDR
extern Bool query_randr_extension (saver_info *);
#endif
#ifdef HAVE_PROC_INTERRUPTS
extern Bool query_proc_interrupts_available (saver_info *, const char **why);
#endif
/* Display Power Management System (DPMS) interface. */
extern Bool monitor_powered_on_p (saver_info *si);
extern void monitor_power_on (saver_info *si);
/* =======================================================================
blanking
======================================================================= */
extern void initialize_screensaver_window (saver_info *si);
extern void raise_window (saver_info *si,
Bool inhibit_fade, Bool between_hacks_p,
Bool dont_clear);
extern Bool blank_screen (saver_info *si);
extern void unblank_screen (saver_info *si);
extern void resize_screensaver_window (saver_info *si);
extern void get_screen_viewport (saver_screen_info *ssi,
int *x_ret, int *y_ret,
int *w_ret, int *h_ret,
int target_x, int target_y,
Bool verbose_p);
/* =======================================================================
locking
======================================================================= */
#ifndef NO_LOCKING
extern Bool unlock_p (saver_info *si);
extern Bool lock_priv_init (int argc, char **argv, Bool verbose_p);
extern Bool lock_init (int argc, char **argv, Bool verbose_p);
extern Bool passwd_valid_p (const char *typed_passwd, Bool verbose_p);
#endif /* NO_LOCKING */
extern void set_locked_p (saver_info *si, Bool locked_p);
extern int move_mouse_grab (saver_info *si, Window to, Cursor cursor,
int to_screen_no);
extern int mouse_screen (saver_info *si);
/* =======================================================================
runtime privileges
======================================================================= */
extern void hack_uid (saver_info *si);
extern void describe_uids (saver_info *si, FILE *out);
/* =======================================================================
demoing
======================================================================= */
extern void draw_shaded_rectangle (Display *dpy, Window window,
int x, int y,
int width, int height,
int thickness,
unsigned long top_color,
unsigned long bottom_color);
extern int string_width (XFontStruct *font, char *s);
extern void make_splash_dialog (saver_info *si);
extern void handle_splash_event (saver_info *si, XEvent *e);
/* =======================================================================
timers
======================================================================= */
extern void start_notice_events_timer (saver_info *, Window, Bool verbose_p);
extern void cycle_timer (XtPointer si, XtIntervalId *id);
extern void activate_lock_timer (XtPointer si, XtIntervalId *id);
extern void reset_watchdog_timer (saver_info *si, Bool on_p);
extern void idle_timer (XtPointer si, XtIntervalId *id);
extern void de_race_timer (XtPointer si, XtIntervalId *id);
extern void sleep_until_idle (saver_info *si, Bool until_idle_p);
extern void reset_timers (saver_info *si);
extern void schedule_wakeup_event (saver_info *si, Time when, Bool verbose_p);
/* =======================================================================
remote control
======================================================================= */
extern Bool handle_clientmessage (saver_info *, XEvent *, Bool);
extern void maybe_reload_init_file (saver_info *);
/* =======================================================================
subprocs
======================================================================= */
extern void handle_signals (saver_info *si);
#ifdef HAVE_SIGACTION
extern sigset_t block_sigchld (void);
#else /* !HAVE_SIGACTION */
extern int block_sigchld (void);
#endif /* !HAVE_SIGACTION */
extern void unblock_sigchld (void);
extern void hack_environment (saver_info *si);
extern void hack_subproc_environment (saver_screen_info *ssi);
extern void init_sigchld (void);
extern void spawn_screenhack (saver_info *si, Bool first_time_p);
extern pid_t fork_and_exec (saver_screen_info *ssi, const char *command);
extern void kill_screenhack (saver_info *si);
extern void suspend_screenhack (saver_info *si, Bool suspend_p);
extern Bool screenhack_running_p (saver_info *si);
extern void emergency_kill_subproc (saver_info *si);
extern Bool select_visual (saver_screen_info *ssi, const char *visual_name);
extern void store_saver_status (saver_info *si);
extern const char *signal_name (int signal);
extern void exec_command (const char *shell, const char *command,
int nice_level);
/* =======================================================================
subprocs diagnostics
======================================================================= */
extern FILE *real_stderr;
extern FILE *real_stdout;
extern void initialize_stderr (saver_info *si);
extern void reset_stderr (saver_screen_info *ssi);
extern void clear_stderr (saver_screen_info *ssi);
extern void shutdown_stderr (saver_info *si);
/* =======================================================================
misc
======================================================================= */
extern const char *blurb (void);
extern void save_argv (int argc, char **argv);
extern void saver_exit (saver_info *si, int status, const char *core_reason);
extern void restart_process (saver_info *si);
extern int saver_ehandler (Display *dpy, XErrorEvent *error);
extern int BadWindow_ehandler (Display *dpy, XErrorEvent *error);
extern Bool window_exists_p (Display *dpy, Window window);
extern char *timestring (void);
extern Bool display_is_on_console_p (saver_info *si);
extern Visual *get_best_gl_visual (saver_screen_info *ssi);
extern void check_for_leaks (const char *where);
extern Atom XA_VROOT, XA_XSETROOT_ID, XA_ESETROOT_PMAP_ID, XA_XROOTPMAP_ID;
extern Atom XA_SCREENSAVER, XA_SCREENSAVER_VERSION, XA_SCREENSAVER_ID;
extern Atom XA_SCREENSAVER_STATUS, XA_LOCK, XA_BLANK;
extern Atom XA_DEMO, XA_PREFS;
#endif /* __XSCREENSAVER_H__ */
|