1 /* xscreensaver, Copyright (c) 1993-2001 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_PREFS_H__
13 #define __XSCREENSAVER_PREFS_H__
15 typedef struct screenhack screenhack;
23 typedef enum { RANDOM_HACKS, ONE_HACK, BLANK_ONLY, DONT_BLANK } saver_mode;
25 typedef struct saver_preferences saver_preferences;
28 /* This structure holds all the user-specified parameters, read from the
29 command line, the resource database, or entered through a dialog box.
31 struct saver_preferences {
33 XrmDatabase db; /* The resource database into which the
34 init file is merged, and out of which the
35 preferences are parsed. */
37 time_t init_file_date; /* The date (from stat()) of the .xscreensaver
38 file the last time this process read or
41 Bool verbose_p; /* whether to print out lots of status info */
42 Bool timestamp_p; /* whether to mark messages with a timestamp */
43 Bool capture_stderr_p; /* whether to redirect stdout/stderr */
44 Bool debug_p; /* pay no mind to the man behind the curtain */
45 Bool xsync_p; /* whether XSynchronize has been called */
47 Bool lock_p; /* whether to lock as well as save */
48 Bool lock_vt_p; /* whether to lock VTs too, if possible */
50 Bool fade_p; /* whether to fade to black, if possible */
51 Bool unfade_p; /* whether to fade from black, if possible */
52 Time fade_seconds; /* how long that should take */
53 int fade_ticks; /* how many ticks should be used */
54 Bool splash_p; /* whether to do a splash screen at startup */
56 Bool install_cmap_p; /* whether we should use our own colormap
57 when using the screen's default visual. */
59 screenhack **screenhacks; /* the programs to run */
60 int screenhacks_count;
62 saver_mode mode; /* hack-selection mode */
63 int selected_hack; /* in one_hack mode, this is the one */
65 int nice_inferior; /* nice value for subprocs */
66 int inferior_memory_limit; /* setrlimit(LIMIT_AS) value for subprocs */
68 Time initial_delay; /* how long to sleep after launch */
69 Time splash_duration; /* how long the splash screen stays up */
70 Time timeout; /* how much idle time before activation */
71 Time lock_timeout; /* how long after activation locking starts */
72 Time cycle; /* how long each hack should run */
73 Time passwd_timeout; /* how much time before pw dialog goes down */
74 Time pointer_timeout; /* how often to check mouse position */
75 Time notice_events_timeout; /* how long after window creation to select */
76 Time watchdog_timeout; /* how often to re-raise and re-blank screen */
78 Bool dpms_enabled_p; /* Whether to power down the monitor */
79 Time dpms_standby; /* how long until monitor goes black */
80 Time dpms_suspend; /* how long until monitor power-saves */
81 Time dpms_off; /* how long until monitor powers down */
83 Bool grab_desktop_p; /* These are not used by "xscreensaver" */
84 Bool grab_video_p; /* itself: they are used by the external */
85 Bool random_image_p; /* "xscreensaver-getimage" program, and set */
86 char *image_directory; /* by the "xscreensaver-demo" configurator. */
88 Bool use_xidle_extension; /* which extension to use, if possible */
89 Bool use_mit_saver_extension;
90 Bool use_sgi_saver_extension;
91 Bool use_proc_interrupts;
93 char *shell; /* where to find /bin/sh */
95 char *demo_command; /* How to enter demo mode. */
96 char *prefs_command; /* How to edit preferences. */
97 char *help_url; /* Where the help document resides. */
98 char *load_url_command; /* How one loads URLs. */
102 extern void load_init_file (saver_preferences *p);
103 extern Bool init_file_changed_p (saver_preferences *p);
104 extern int write_init_file (saver_preferences *p, const char *version_string,
106 const char *init_file_name (void);
108 extern screenhack *parse_screenhack (const char *line);
109 extern void free_screenhack (screenhack *hack);
110 extern char *format_hack (screenhack *hack, Bool wrap_p);
111 char *make_hack_name (const char *shell_command);
114 extern void sync_server_dpms_settings (Display *dpy, Bool enabled_p,
115 int standby_secs, int suspend_secs,
119 #endif /* __XSCREENSAVER_PREFS_H__ */