8395f323f1f4ee51bd1c3d7a2265c60c11edb510
[xscreensaver] / driver / prefs.h
1 /* xscreensaver, Copyright (c) 1993-1998 Jamie Zawinski <jwz@jwz.org>
2  *
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 
9  * implied warranty.
10  */
11
12 #ifndef __XSCREENSAVER_PREFS_H__
13 #define __XSCREENSAVER_PREFS_H__
14
15 typedef struct screenhack screenhack;
16 struct screenhack {
17   Bool enabled_p;
18   char *visual;
19   char *name;
20   char *command;
21 };
22
23 typedef struct saver_preferences saver_preferences;
24
25
26 /* This structure holds all the user-specified parameters, read from the
27    command line, the resource database, or entered through a dialog box.
28  */
29 struct saver_preferences {
30
31   XrmDatabase db;               /* The resource database into which the
32                                    init file is merged, and out of which the
33                                    preferences are parsed. */
34
35   time_t init_file_date;        /* The date (from stat()) of the .xscreensaver
36                                    file the last time this process read or
37                                    wrote it. */
38
39   Bool verbose_p;               /* whether to print out lots of status info */
40   Bool timestamp_p;             /* whether to mark messages with a timestamp */
41   Bool debug_p;                 /* pay no mind to the man behind the curtain */
42   Bool xsync_p;                 /* whether XSynchronize has been called */
43
44   Bool lock_p;                  /* whether to lock as well as save */
45   Bool lock_vt_p;               /* whether to lock VTs too, if possible */
46
47   Bool fade_p;                  /* whether to fade to black, if possible */
48   Bool unfade_p;                /* whether to fade from black, if possible */
49   Time fade_seconds;            /* how long that should take */
50   int fade_ticks;               /* how many ticks should be used */
51
52   Bool install_cmap_p;          /* whether we should use our own colormap
53                                    when using the screen's default visual. */
54
55   screenhack **screenhacks;     /* the programs to run */
56   int screenhacks_count;
57
58   int nice_inferior;            /* nice value for subprocs */
59
60   Time initial_delay;           /* how long to sleep after launch */
61   Time splash_duration;         /* how long the splash screen stays up */
62   Time timeout;                 /* how much idle time before activation */
63   Time lock_timeout;            /* how long after activation locking starts */
64   Time cycle;                   /* how long each hack should run */
65   Time passwd_timeout;          /* how much time before pw dialog goes down */
66   Time pointer_timeout;         /* how often to check mouse position */
67   Time notice_events_timeout;   /* how long after window creation to select */
68   Time watchdog_timeout;        /* how often to re-raise and re-blank screen */
69
70   Bool use_xidle_extension;     /* which extension to use, if possible */
71   Bool use_mit_saver_extension;
72   Bool use_sgi_saver_extension;
73   Bool use_proc_interrupts;
74
75   char *shell;                  /* where to find /bin/sh */
76
77   char *demo_command;           /* How to enter demo mode. */
78   char *prefs_command;          /* How to edit preferences. */
79   char *help_url;               /* Where the help document resides. */
80   char *load_url_command;       /* How one loads URLs. */
81 };
82
83
84 extern void load_init_file (saver_preferences *p);
85 extern Bool init_file_changed_p (saver_preferences *p);
86 extern int write_init_file (saver_preferences *p, const char *version_string,
87                             Bool verbose_p);
88 const char *init_file_name (void);
89
90 extern screenhack *parse_screenhack (const char *line);
91 extern void free_screenhack (screenhack *hack);
92 extern char *format_hack (screenhack *hack, Bool wrap_p);
93
94 #endif /* __XSCREENSAVER_PREFS_H__ */