http://ftp.x.org/contrib/applications/xscreensaver-2.34.tar.gz
[xscreensaver] / driver / xscreensaver.h
index 1082c46050fe0aa5769c78976ef122242595bb28..6fc68ba855b755580665ea5afed0e54f114abec0 100644 (file)
@@ -1,4 +1,4 @@
-/* xscreensaver, Copyright (c) 1993-1998 Jamie Zawinski <jwz@netscape.com>
+/* xscreensaver, Copyright (c) 1993-1998 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
@@ -26,7 +26,8 @@ extern char *progclass;
 typedef struct saver_preferences saver_preferences;
 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)))
@@ -37,12 +38,15 @@ typedef struct saver_screen_info saver_screen_info;
    command line, the resource database, or entered through a dialog box.
  */
 struct saver_preferences {
-  Bool verbose_p;
-  Bool lock_p;                 /* whether to lock as well as save */
+  Bool verbose_p;              /* whether to print out lots of status info */
+  Bool timestamp_p;            /* whether to mark messages with a timestamp */
+  Bool debug_p;                        /* pay no mind to the man behind the curtain */
+  Bool xsync_p;                        /* whether XSynchronize has been called */
 
-  Bool debug_p;
-  Bool fade_p;                 /* whether to fade to black */
-  Bool unfade_p;               /* whether to fade from black */
+  Bool lock_p;                 /* whether to lock as well as save */
+  Bool lock_vt_p;              /* whether to lock VTs too, if possible */
+  Bool fade_p;                 /* whether to fade to black, if possible */
+  Bool unfade_p;               /* whether to fade from black, if possible */
   int fade_seconds;            /* how long that should take */
   int fade_ticks;              /* how many ticks should be used */
 
@@ -54,13 +58,12 @@ struct saver_preferences {
 
   int nice_inferior;           /* nice value for subprocs */
 
-  int initial_delay;           /* how long to sleep after launch */
+  Time initial_delay;          /* how long to sleep after launch */
+  Time splash_duration;                /* how long the splash screen stays up */
   Time timeout;                        /* how much idle time before activation */
   Time lock_timeout;           /* how long after activation locking starts */
   Time cycle;                  /* how long each hack should run */
-#ifndef NO_LOCKING
   Time passwd_timeout;         /* how much time before pw dialog goes down */
-#endif
   Time pointer_timeout;                /* how often to check mouse position */
   Time notice_events_timeout;  /* how long after window creation to select */
   Time watchdog_timeout;       /* how often to re-raise and re-blank screen */
@@ -71,6 +74,8 @@ struct saver_preferences {
 
   char *shell;                 /* where to find /bin/sh */
 
+  char *help_url;              /* Where the help document resides. */
+  char *load_url_command;      /* How one loads URLs. */
 };
 
 
@@ -85,6 +90,10 @@ struct saver_info {
   saver_screen_info *screens;
   saver_screen_info *default_screen;   /* ...on which dialogs will appear. */
 
+  time_t init_file_date;       /* The date (from stat()) of the .xscreensaver
+                                  file the last time this process read or
+                                  wrote it. */
+
   /* =======================================================================
      global connection info
      ======================================================================= */
@@ -112,18 +121,34 @@ struct saver_info {
      ======================================================================= */
 
   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 */
+  Bool fading_possible_p;      /* Whether fading to/from black is possible. */
 
 
   /* =======================================================================
-     locking
+     locking and runtime privileges
      ======================================================================= */
 
-  Bool locking_disabled_p;     /* Sometimes locking is impossible. */
-  char *nolock_reason;         /* This is why. */
   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. */
+
 
   /* =======================================================================
      demoing
@@ -133,6 +158,9 @@ struct saver_info {
   char *demo_hack;             /* The hack that has been selected from the
                                   dialog box, which should be run next. */
 
+  Window splash_dialog;                /* The splash dialog, if its up. */
+  splash_dialog_data *sp_data; /* Other info necessary to draw it. */
+
 
   /* =======================================================================
      timers
@@ -152,9 +180,10 @@ struct saver_info {
      remote control
      ======================================================================= */
 
-  int next_mode_p;             /* Set to 1 if the NEXT ClientMessage has just
-                                  been received; set to 2 if PREV has just
-                                  been received.  (#### This is nasty.) */
+  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 has
+                                  been received.  (This is kind of nasty.) */
 
   /* =======================================================================
      subprocs
@@ -248,7 +277,7 @@ struct saver_screen_info {
 
 extern void restore_real_vroot (saver_info *si);
 extern void disable_builtin_screensaver (saver_info *si, Bool turn_off_p);
-extern void ensure_no_screensaver_running (Display *, Screen *);
+extern Bool ensure_no_screensaver_running (Display *, Screen *);
 
 #ifdef HAVE_MIT_SAVER_EXTENSION
 extern Bool query_mit_saver_extension (saver_info *);
@@ -257,6 +286,10 @@ extern Bool query_mit_saver_extension (saver_info *);
 extern Bool query_sgi_saver_extension (saver_info *);
 #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
@@ -277,20 +310,42 @@ extern void ungrab_keyboard_and_mouse (saver_info *si);
 
 #ifndef NO_LOCKING
 extern Bool unlock_p (saver_info *si);
-extern create_passwd_dialog (Widget, Visual *, Colormap);
 extern Bool lock_init (int argc, char **argv);
 extern Bool passwd_valid_p (const char *typed_passwd);
-#endif
+
+extern void make_passwd_window (saver_info *si);
+extern void draw_passwd_window (saver_info *si);
+extern void update_passwd_window (saver_info *si, const char *printed_passwd,
+                                 float ratio);
+extern void destroy_passwd_window (saver_info *si);
+
+#endif /* NO_LOCKING */
+
+/* =======================================================================
+   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);
+
+
 #ifndef NO_DEMO_MODE
 extern void demo_mode (saver_info *si);
 extern void demo_mode_restart_process (saver_info *si);
-extern create_demo_dialog (Widget, Visual *, Colormap);
-extern create_resources_dialog (Widget, Visual *, Colormap);
+extern void create_demo_dialog (Widget, Visual *, Colormap);
+extern void create_resources_dialog (Widget, Visual *, Colormap);
 #endif
 
 #if !defined(NO_LOCKING) || !defined(NO_DEMO_MODE)
@@ -299,9 +354,9 @@ extern void format_into_label (Widget label, const char *arg);
 extern void steal_focus_and_colormap (Widget dialog);
 #endif
 
-#ifdef HAVE_MOTIF
-extern void disable_motif_drag_and_drop(Widget w);
-#endif
+extern void make_splash_dialog (saver_info *si);
+extern void handle_splash_event (saver_info *si, XEvent *e);
+extern void skull (Display *, Window, GC, GC, int, int, int, int);
 
 
 /* =======================================================================
@@ -325,6 +380,7 @@ extern Bool handle_clientmessage (saver_info *, XEvent *, Bool);
    subprocs
    ======================================================================= */
 
+extern void hack_environment (saver_info *si);
 extern void init_sigchld (void);
 extern void spawn_screenhack (saver_info *si, Bool first_time_p);
 extern void kill_screenhack (saver_info *si);
@@ -334,18 +390,6 @@ extern void emergency_kill_subproc (saver_info *si);
 extern Bool select_visual (saver_screen_info *ssi, const char *visual_name);
 extern const char *signal_name (int signal);
 
-/* =======================================================================
-   subprocs security
-   ======================================================================= */
-
-#ifdef NO_SETUID
-# define hack_uid()
-# define hack_uid_warn()
-#else /* !NO_SETUID */
- extern void hack_uid (saver_info *si);
- extern void hack_uid_warn (saver_info *si);
-#endif /* NO_SETUID */
-
 /* =======================================================================
    subprocs diagnostics
    ======================================================================= */
@@ -356,12 +400,23 @@ extern void initialize_stderr (saver_info *si);
 extern void reset_stderr (saver_screen_info *ssi);
 extern void clear_stderr (saver_screen_info *ssi);
 
+/* =======================================================================
+   the .xscreensaver file
+   ======================================================================= */
+
+extern int read_init_file (saver_info *si);
+extern int write_init_file (saver_info *si);
+extern int maybe_reload_init_file (saver_info *si);
+extern void get_resources (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);
+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);
@@ -370,7 +425,8 @@ extern Bool window_exists_p (Display *dpy, Window window);
 extern char *timestring (void);
 
 extern Atom XA_VROOT, XA_XSETROOT_ID;
-extern Atom XA_SCREENSAVER_VERSION, XA_SCREENSAVER_ID;
+extern Atom XA_SCREENSAVER, XA_SCREENSAVER_VERSION, XA_SCREENSAVER_ID;
 extern Atom XA_SCREENSAVER_TIME;
+extern Atom XA_DEMO, XA_PREFS;
 
 #endif /* __XSCREENSAVER_H__ */