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

   1 /* xscreensaver, Copyright (c) 1993-2008 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_TYPES_H__
  13 #define __XSCREENSAVER_TYPES_H__
  14
  15 typedef struct saver_info saver_info;
  16
  17 typedef enum {
  18   ul_read,              /* reading input or ready to do so */
  19   ul_success,           /* auth success, unlock */
  20   ul_fail,              /* auth fail */
  21   ul_cancel,            /* user cancelled auth (pw_cancel or pw_null) */
  22   ul_time,              /* timed out */
  23   ul_finished           /* user pressed enter */
  24 } unlock_state;
  25
  26 typedef struct screenhack screenhack;
  27 struct screenhack {
  28   Bool enabled_p;
  29   char *visual;
  30   char *name;
  31   char *command;
  32 };
  33
  34 typedef enum {
  35   RANDOM_HACKS, ONE_HACK, BLANK_ONLY, DONT_BLANK, RANDOM_HACKS_SAME
  36 } saver_mode;
  37
  38 typedef enum {
  39   TEXT_DATE, TEXT_LITERAL, TEXT_FILE, TEXT_PROGRAM, TEXT_URL
  40 } text_mode;
  41
  42 struct auth_message;
  43 struct auth_response;
  44
  45 typedef int (*auth_conv_cb_t) (
  46   int num_msg,
  47   const struct auth_message *msg,
  48   struct auth_response **resp,
  49   saver_info *si);
  50
  51 typedef struct saver_preferences saver_preferences;
  52 typedef struct saver_screen_info saver_screen_info;
  53 typedef struct passwd_dialog_data passwd_dialog_data;
  54 typedef struct splash_dialog_data splash_dialog_data;
  55 typedef struct _monitor monitor;
  56
  57
  58 /* This structure holds all the user-specified parameters, read from the
  59    command line, the resource database, or entered through a dialog box.
  60  */
  61 struct saver_preferences {
  62
  63   XrmDatabase db;               /* The resource database into which the
  64                                    init file is merged, and out of which the
  65                                    preferences are parsed. */
  66
  67   time_t init_file_date;        /* The date (from stat()) of the .xscreensaver
  68                                    file the last time this process read or
  69                                    wrote it. */
  70
  71   Bool verbose_p;               /* whether to print out lots of status info */
  72   Bool timestamp_p;             /* whether to mark messages with a timestamp */
  73   Bool capture_stderr_p;        /* whether to redirect stdout/stderr  */
  74   Bool ignore_uninstalled_p;    /* whether to avoid displaying or complaining
  75                                    about hacks that are not on $PATH */
  76   Bool debug_p;                 /* pay no mind to the man behind the curtain */
  77   Bool xsync_p;                 /* whether XSynchronize has been called */
  78
  79   Bool lock_p;                  /* whether to lock as well as save */
  80
  81   Bool fade_p;                  /* whether to fade to black, if possible */
  82   Bool unfade_p;                /* whether to fade from black, if possible */
  83   Time fade_seconds;            /* how long that should take */
  84   int fade_ticks;               /* how many ticks should be used */
  85   Bool splash_p;                /* whether to do a splash screen at startup */
  86
  87   Bool install_cmap_p;          /* whether we should use our own colormap
  88                                    when using the screen's default visual. */
  89
  90 # ifdef QUAD_MODE
  91   Bool quad_p;                  /* whether to run four savers per monitor */
  92 # endif
  93
  94   screenhack **screenhacks;     /* the programs to run */
  95   int screenhacks_count;
  96
  97   saver_mode mode;              /* hack-selection mode */
  98   int selected_hack;            /* in one_hack mode, this is the one */
  99
 100   int nice_inferior;            /* nice value for subprocs */
 101   int inferior_memory_limit;    /* setrlimit(LIMIT_AS) value for subprocs */
 102
 103   Time initial_delay;           /* how long to sleep after launch */
 104   Time splash_duration;         /* how long the splash screen stays up */
 105   Time timeout;                 /* how much idle time before activation */
 106   Time lock_timeout;            /* how long after activation locking starts */
 107   Time cycle;                   /* how long each hack should run */
 108   Time passwd_timeout;          /* how much time before pw dialog goes down */
 109   Time pointer_timeout;         /* how often to check mouse position */
 110   Time notice_events_timeout;   /* how long after window creation to select */
 111   Time watchdog_timeout;        /* how often to re-raise and re-blank screen */
 112   int pointer_hysteresis;       /* mouse motions less than N/sec are ignored */
 113
 114   Bool dpms_enabled_p;          /* Whether to power down the monitor */
 115   Time dpms_standby;            /* how long until monitor goes black */
 116   Time dpms_suspend;            /* how long until monitor power-saves */
 117   Time dpms_off;                /* how long until monitor powers down */
 118
 119   Bool grab_desktop_p;          /* These are not used by "xscreensaver" */
 120   Bool grab_video_p;            /*  itself: they are used by the external */
 121   Bool random_image_p;          /*  "xscreensaver-getimage" program, and set */
 122   char *image_directory;        /*  by the "xscreensaver-demo" configurator. */
 123
 124   text_mode tmode;              /* How we generate text to display. */
 125   char *text_literal;           /* used when tmode is TEXT_LITERAL. */
 126   char *text_file;              /* used when tmode is TEXT_FILE.    */
 127   char *text_program;           /* used when tmode is TEXT_PROGRAM. */
 128   char *text_url;               /* used when tmode is TEXT_URL.     */
 129
 130   Bool use_xidle_extension;     /* which extension to use, if possible */
 131   Bool use_mit_saver_extension;
 132   Bool use_sgi_saver_extension;
 133   Bool use_proc_interrupts;
 134
 135   Bool getviewport_full_of_lies_p; /* XFree86 bug #421 */
 136
 137   char *shell;                  /* where to find /bin/sh */
 138
 139   char *demo_command;           /* How to enter demo mode. */
 140   char *prefs_command;          /* How to edit preferences. */
 141   char *help_url;               /* Where the help document resides. */
 142   char *load_url_command;       /* How one loads URLs. */
 143   char *new_login_command;      /* Command for the "New Login" button. */
 144 };
 145
 146 /* This structure holds all the data that applies to the program as a whole,
 147    or to the non-screen-specific parts of the display connection.
 148
 149    The saver_preferences structure (prefs.h) holds all the user-specified
 150    parameters, read from the command line, the resource database, or entered
 151    through a dialog box.
 152  */
 153 struct saver_info {
 154   char *version;
 155   saver_preferences prefs;
 156
 157   int nscreens;
 158   int ssi_count;
 159   saver_screen_info *screens;
 160   saver_screen_info *default_screen;    /* ...on which dialogs will appear. */
 161   monitor **monitor_layout;             /* private to screens.c */
 162   Visual **best_gl_visuals;             /* visuals for GL hacks on screen N */
 163
 164   /* =======================================================================
 165      global connection info
 166      ======================================================================= */
 167
 168   XtAppContext app;
 169   Display *dpy;
 170
 171   /* =======================================================================
 172      server extension info
 173      ======================================================================= */
 174
 175   Bool using_xidle_extension;      /* which extension is being used.         */
 176   Bool using_mit_saver_extension;  /* Note that `p->use_*' is the *request*, */
 177   Bool using_sgi_saver_extension;  /* and `si->using_*' is the *reality*.    */
 178   Bool using_proc_interrupts;
 179
 180 # ifdef HAVE_MIT_SAVER_EXTENSION
 181   int mit_saver_ext_event_number;
 182   int mit_saver_ext_error_number;
 183 # endif
 184 # ifdef HAVE_SGI_SAVER_EXTENSION
 185   int sgi_saver_ext_event_number;
 186   int sgi_saver_ext_error_number;
 187 # endif
 188 # ifdef HAVE_RANDR
 189   int randr_event_number;
 190   int randr_error_number;
 191 # endif
 192
 193
 194   /* =======================================================================
 195      blanking
 196      ======================================================================= */
 197
 198   Bool screen_blanked_p;        /* Whether the saver is currently active. */
 199   Window mouse_grab_window;     /* Window holding our mouse grab */
 200   Window keyboard_grab_window;  /* Window holding our keyboard grab */
 201   int mouse_grab_screen;        /* The screen number the mouse grab is on */
 202   int keyboard_grab_screen;     /* The screen number the keyboard grab is on */
 203   Bool fading_possible_p;       /* Whether fading to/from black is possible. */
 204   Bool throttled_p;             /* Whether we should temporarily just blank
 205                                    the screen, not run hacks. (Deprecated:
 206                                    users should use "xset dpms force off"
 207                                    instead.) */
 208   time_t blank_time;            /* The time at which the screen was blanked
 209                                    (if currently blanked) or unblanked (if
 210                                    not blanked.) */
 211
 212
 213   /* =======================================================================
 214      locking and runtime privileges
 215      ======================================================================= */
 216
 217   Bool locked_p;                /* Whether the screen is currently locked. */
 218   Bool dbox_up_p;               /* Whether the demo-mode or passwd dialogs
 219                                    are currently visible */
 220
 221   Bool locking_disabled_p;      /* Sometimes locking is impossible. */
 222   char *nolock_reason;          /* This is why. */
 223
 224   char *orig_uid;               /* What uid/gid we had at startup, before
 225                                    discarding privileges. */
 226   char *uid_message;            /* Any diagnostics from our attempt to
 227                                    discard privileges (printed only in
 228                                    -verbose mode.) */
 229   Bool dangerous_uid_p;         /* Set to true if we're running as a user id
 230                                    which is known to not be a normal, non-
 231                                    privileged user. */
 232
 233   Window passwd_dialog;         /* The password dialog, if it's up. */
 234   passwd_dialog_data *pw_data;  /* Other info necessary to draw it. */
 235
 236   int unlock_failures;          /* Counts failed login attempts while the
 237                                    screen is locked. */
 238
 239   char *unlock_typeahead;       /* If the screen is locked, and the user types
 240                                    a character, we assume that it is the first
 241                                    character of the password.  It's stored here
 242                                    for the password dialog to use to populate
 243                                    itself. */
 244
 245   char *user;                   /* The user whose session is locked. */
 246   char *cached_passwd;          /* Cached password, used to avoid multiple
 247                                    prompts for password-only auth mechanisms.*/
 248   unlock_state unlock_state;
 249
 250   auth_conv_cb_t unlock_cb;     /* The function used to prompt for creds. */
 251   void (*auth_finished_cb) (saver_info *si);
 252                                 /* Called when authentication has finished,
 253                                    regardless of success or failure.
 254                                    May be NULL. */
 255
 256
 257   /* =======================================================================
 258      demoing
 259      ======================================================================= */
 260
 261   Bool demoing_p;               /* Whether we are demoing a single hack
 262                                    (without UI.) */
 263
 264   Window splash_dialog;         /* The splash dialog, if its up. */
 265   splash_dialog_data *sp_data;  /* Other info necessary to draw it. */
 266
 267
 268   /* =======================================================================
 269      timers
 270      ======================================================================= */
 271
 272   XtIntervalId lock_id;         /* Timer to implement `prefs.lock_timeout' */
 273   XtIntervalId cycle_id;        /* Timer to implement `prefs.cycle' */
 274   XtIntervalId timer_id;        /* Timer to implement `prefs.timeout' */
 275   XtIntervalId watchdog_id;     /* Timer to implement `prefs.watchdog */
 276   XtIntervalId check_pointer_timer_id;  /* `prefs.pointer_timeout' */
 277
 278   XtIntervalId de_race_id;      /* Timer to make sure screen un-blanks */
 279   int de_race_ticks;
 280
 281   time_t last_activity_time;               /* Used only when no server exts. */
 282   time_t last_wall_clock_time;             /* Used to detect laptop suspend. */
 283   saver_screen_info *last_activity_screen;
 284
 285   Bool emergency_lock_p;        /* Set when the wall clock has jumped
 286                                    (presumably due to laptop suspend) and we
 287                                    need to lock down right away instead of
 288                                    waiting for the lock timer to go off. */
 289
 290
 291   /* =======================================================================
 292      remote control
 293      ======================================================================= */
 294
 295   int selection_mode;           /* Set to -1 if the NEXT ClientMessage has just
 296                                    been received; set to -2 if PREV has just
 297                                    been received; set to N if SELECT or DEMO N
 298                                    has been received.  (This is kind of nasty.)
 299                                  */
 300
 301   /* =======================================================================
 302      subprocs
 303      ======================================================================= */
 304
 305   XtIntervalId stderr_popup_timer;
 306
 307 };
 308
 309 /* This structure holds all the data that applies to the screen-specific parts
 310    of the display connection; if the display has multiple screens, there will
 311    be one of these for each screen.
 312  */
 313 struct saver_screen_info {
 314   saver_info *global;
 315
 316   int number;                   /* The internal ordinal of this screen,
 317                                    counting Xinerama rectangles as separate
 318                                    screens. */
 319   int real_screen_number;       /* The number of the underlying X screen on
 320                                    which this rectangle lies. */
 321   Screen *screen;               /* The X screen in question. */
 322
 323   int x, y, width, height;      /* The size and position of this rectangle
 324                                    on its underlying X screen. */
 325
 326   Bool real_screen_p;           /* This will be true of exactly one ssi per
 327                                    X screen. */
 328
 329   Widget toplevel_shell;
 330
 331   /* =======================================================================
 332      blanking
 333      ======================================================================= */
 334
 335   Window screensaver_window;    /* The window that will impersonate the root,
 336                                    when the screensaver activates.  Note that
 337                                    the window stored here may change, as we
 338                                    destroy and recreate it on different
 339                                    visuals. */
 340   Colormap cmap;                /* The colormap that goes with the window. */
 341   Bool install_cmap_p;          /* Whether this screen should have its own
 342                                    colormap installed, for whichever of several
 343                                    reasons.  This is definitive (even a false
 344                                    value here overrides prefs->install_cmap_p.)
 345                                  */
 346   Visual *current_visual;       /* The visual of the window. */
 347   int current_depth;            /* How deep the visual (and the window) are. */
 348
 349   Visual *default_visual;       /* visual to use when none other specified */
 350
 351   Window real_vroot;            /* The original virtual-root window. */
 352   Window real_vroot_value;      /* What was in the __SWM_VROOT property. */
 353
 354   Cursor cursor;                /* A blank cursor that goes with the
 355                                    real root window. */
 356   unsigned long black_pixel;    /* Black, allocated from `cmap'. */
 357
 358   int blank_vp_x, blank_vp_y;   /* Where the virtual-scrolling viewport was
 359                                    when the screen went blank.  We need to
 360                                    prevent the X server from letting the mouse
 361                                    bump the edges to scroll while the screen
 362                                    is locked, so we reset to this when it has
 363                                    moved, and the lock dialog is up... */
 364
 365 # ifdef HAVE_MIT_SAVER_EXTENSION
 366   Window server_mit_saver_window;
 367 # endif
 368
 369
 370   /* =======================================================================
 371      demoing
 372      ======================================================================= */
 373
 374   Colormap demo_cmap;           /* The colormap that goes with the dialogs:
 375                                    this might be the same as `cmap' so care
 376                                    must be taken not to free it while it's
 377                                    still in use. */
 378
 379   /* =======================================================================
 380      timers
 381      ======================================================================= */
 382
 383   int poll_mouse_last_root_x;           /* Used only when no server exts. */
 384   int poll_mouse_last_root_y;
 385   Window poll_mouse_last_child;
 386   unsigned int poll_mouse_last_mask;
 387   time_t poll_mouse_last_time;
 388
 389
 390   /* =======================================================================
 391      subprocs
 392      ======================================================================= */
 393
 394   int current_hack;             /* Index into `prefs.screenhacks' */
 395   pid_t pid;
 396
 397   int stderr_text_x;
 398   int stderr_text_y;
 399   int stderr_line_height;
 400   XFontStruct *stderr_font;
 401   GC stderr_gc;
 402   Window stderr_overlay_window;    /* Used if the server has overlay planes */
 403   Colormap stderr_cmap;
 404 };
 405
 406
 407 #endif /* __XSCREENSAVER_TYPES_H__ */