git.hungrycats.org Git - xscreensaver/blob - driver/prefs.h

   1 /* xscreensaver, Copyright (c) 1993-2001 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 capture_stderr_p;        /* whether to redirect stdout/stderr  */
  42   Bool debug_p;                 /* pay no mind to the man behind the curtain */
  43   Bool xsync_p;                 /* whether XSynchronize has been called */
  44
  45   Bool lock_p;                  /* whether to lock as well as save */
  46   Bool lock_vt_p;               /* whether to lock VTs too, if possible */
  47
  48   Bool fade_p;                  /* whether to fade to black, if possible */
  49   Bool unfade_p;                /* whether to fade from black, if possible */
  50   Time fade_seconds;            /* how long that should take */
  51   int fade_ticks;               /* how many ticks should be used */
  52   Bool splash_p;                /* whether to do a splash screen at startup */
  53
  54   Bool install_cmap_p;          /* whether we should use our own colormap
  55                                    when using the screen's default visual. */
  56
  57   screenhack **screenhacks;     /* the programs to run */
  58   int screenhacks_count;
  59
  60   int nice_inferior;            /* nice value for subprocs */
  61   int inferior_memory_limit;    /* setrlimit(LIMIT_AS) value for subprocs */
  62
  63   Time initial_delay;           /* how long to sleep after launch */
  64   Time splash_duration;         /* how long the splash screen stays up */
  65   Time timeout;                 /* how much idle time before activation */
  66   Time lock_timeout;            /* how long after activation locking starts */
  67   Time cycle;                   /* how long each hack should run */
  68   Time passwd_timeout;          /* how much time before pw dialog goes down */
  69   Time pointer_timeout;         /* how often to check mouse position */
  70   Time notice_events_timeout;   /* how long after window creation to select */
  71   Time watchdog_timeout;        /* how often to re-raise and re-blank screen */
  72
  73   Bool dpms_enabled_p;          /* Whether to power down the monitor */
  74   Time dpms_standby;            /* how long until monitor goes black */
  75   Time dpms_suspend;            /* how long until monitor power-saves */
  76   Time dpms_off;                /* how long until monitor powers down */
  77
  78   Bool grab_desktop_p;          /* These are not used by "xscreensaver" */
  79   Bool grab_video_p;            /*  itself: they are used by the external */
  80   Bool random_image_p;          /*  "xscreensaver-getimage" program, and set */
  81   char *image_directory;        /*  by the "xscreensaver-demo" configurator. */
  82
  83   Bool use_xidle_extension;     /* which extension to use, if possible */
  84   Bool use_mit_saver_extension;
  85   Bool use_sgi_saver_extension;
  86   Bool use_proc_interrupts;
  87
  88   char *shell;                  /* where to find /bin/sh */
  89
  90   char *demo_command;           /* How to enter demo mode. */
  91   char *prefs_command;          /* How to edit preferences. */
  92   char *help_url;               /* Where the help document resides. */
  93   char *load_url_command;       /* How one loads URLs. */
  94 };
  95
  96
  97 extern void load_init_file (saver_preferences *p);
  98 extern Bool init_file_changed_p (saver_preferences *p);
  99 extern int write_init_file (saver_preferences *p, const char *version_string,
 100                             Bool verbose_p);
 101 const char *init_file_name (void);
 102
 103 extern screenhack *parse_screenhack (const char *line);
 104 extern void free_screenhack (screenhack *hack);
 105 extern char *format_hack (screenhack *hack, Bool wrap_p);
 106 char *make_hack_name (const char *shell_command);
 107
 108 /* From dpms.c */
 109 extern void sync_server_dpms_settings (Display *dpy, Bool enabled_p,
 110                                        int standby_secs, int suspend_secs,
 111                                        int off_secs,
 112                                        Bool verbose_p);
 113
 114 #endif /* __XSCREENSAVER_PREFS_H__ */