src/WindowMaker.h

   1 /*
   2  *  Window Maker window manager
   3  *
   4  *  Copyright (c) 1997-2003 Alfredo K. Kojima
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License along
  17  *  with this program; if not, write to the Free Software Foundation, Inc.,
  18  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19  */
  20
  21 #ifndef WINDOWMAKER_H_
  22 #define WINDOWMAKER_H_
  23
  24 #include "wconfig.h"
  25 #include <assert.h>
  26 #include <limits.h>
  27 #include <WINGs/WINGs.h>
  28
  29
  30 /* class codes */
  31 typedef enum {
  32     WCLASS_UNKNOWN = 0,
  33     WCLASS_WINDOW = 1,          /* managed client windows */
  34     WCLASS_MENU = 2,            /* root menus */
  35     WCLASS_APPICON = 3,
  36     WCLASS_DUMMYWINDOW = 4,     /* window that holds window group leader */
  37     WCLASS_MINIWINDOW = 5,
  38     WCLASS_DOCK_ICON = 6,
  39     WCLASS_PAGER = 7,
  40     WCLASS_TEXT_INPUT = 8,
  41     WCLASS_FRAME = 9
  42 } WClassType;
  43
  44
  45 /*
  46  * generic window levels (a superset of the N*XTSTEP ones)
  47  * Applications should use levels between WMDesktopLevel and
  48  * WMScreensaverLevel anything boyond that range is allowed,
  49  * but discouraged.
  50  */
  51 enum {
  52     WMBackLevel = INT_MIN+1,    /* Very lowest level */
  53     WMDesktopLevel = -1000,             /* Lowest level of normal use */
  54     WMSunkenLevel = -1,
  55     WMNormalLevel = 0,
  56     WMFloatingLevel = 3,
  57     WMDockLevel = 5,
  58     WMSubmenuLevel = 15,
  59     WMMainMenuLevel = 20,
  60     WMStatusLevel = 21,
  61     WMFullscreenLevel = 50,
  62     WMModalLevel = 100,
  63     WMPopUpLevel = 101,
  64     WMScreensaverLevel = 1000,
  65     WMOuterSpaceLevel = INT_MAX
  66 };
  67
  68 /*
  69  * WObjDescriptor will be used by the event dispatcher to
  70  * send events to a particular object through the methods in the
  71  * method table. If all objects of the same class share the
  72  * same methods, the class method table should be used, otherwise
  73  * a new method table must be created for each object.
  74  * It is also assigned to find the parent structure of a given
  75  * window (like the WWindow or WMenu for a button)
  76  */
  77
  78 typedef struct WObjDescriptor {
  79     void *self;                        /* the object that will be called */
  80     /* event handlers */
  81     void (*handle_expose)(struct WObjDescriptor *sender, XEvent *event);
  82     void (*handle_mousedown)(struct WObjDescriptor *sender, XEvent *event);
  83     void (*handle_enternotify)(struct WObjDescriptor *sender, XEvent *event);
  84     void (*handle_leavenotify)(struct WObjDescriptor *sender, XEvent *event);
  85
  86     WClassType parent_type;            /* type code of the parent */
  87     void *parent;                      /* parent object (WWindow or WMenu) */
  88 } WObjDescriptor;
  89
  90
  91 /* shutdown modes */
  92 typedef enum {
  93     WSExitMode,
  94     WSLogoutMode,
  95     WSKillMode,
  96     WSRestartPreparationMode
  97 } WShutdownMode;
  98
  99
 100 /* internal buttons */
 101 #define WBUT_CLOSE              0
 102 #define WBUT_BROKENCLOSE        1
 103 #define WBUT_ICONIFY            2
 104 #define WBUT_KILL               3
 105 #ifdef XKB_BUTTON_HINT
 106 #define WBUT_XKBGROUP1          4
 107 #define WBUT_XKBGROUP2          5
 108 #define WBUT_XKBGROUP3          6
 109 #define WBUT_XKBGROUP4          7
 110 #define PRED_BPIXMAPS           8 /* reserved for 4 groups */
 111 #else
 112 #define PRED_BPIXMAPS           4 /* count of WBUT icons */
 113 #endif /* XKB_BUTTON_HINT */
 114
 115 /* cursors */
 116 #define WCUR_DEFAULT            0
 117 #define WCUR_NORMAL             0
 118 #define WCUR_MOVE               1
 119 #define WCUR_RESIZE             2
 120 #define WCUR_TOPLEFTRESIZE      3
 121 #define WCUR_TOPRIGHTRESIZE     4
 122 #define WCUR_BOTTOMLEFTRESIZE   5
 123 #define WCUR_BOTTOMRIGHTRESIZE  6
 124 #define WCUR_VERTICALRESIZE     7
 125 #define WCUR_HORIZONRESIZE      8
 126 #define WCUR_WAIT               9
 127 #define WCUR_ARROW              10
 128 #define WCUR_QUESTION           11
 129 #define WCUR_TEXT               12
 130 #define WCUR_SELECT             13
 131 #define WCUR_ROOT               14
 132 #define WCUR_EMPTY              15
 133 #define WCUR_LAST               16
 134
 135 /* geometry displays */
 136 #define WDIS_NEW                0       /* new style */
 137 #define WDIS_CENTER             1       /* center of screen */
 138 #define WDIS_TOPLEFT            2       /* top left corner of screen */
 139 #define WDIS_FRAME_CENTER       3       /* center of the frame */
 140 #define WDIS_NONE               4
 141
 142 /* keyboard input focus mode */
 143 #define WKF_CLICK       0
 144 #define WKF_SLOPPY      2
 145
 146 /* colormap change mode */
 147 #define WCM_CLICK       0
 148 #define WCM_POINTER     1
 149
 150 /* window placement mode */
 151 #define WPM_MANUAL      0
 152 #define WPM_CASCADE     1
 153 #define WPM_SMART       2
 154 #define WPM_RANDOM      3
 155 #define WPM_AUTO        4
 156
 157 /* text justification */
 158 #define WTJ_CENTER      0
 159 #define WTJ_LEFT        1
 160 #define WTJ_RIGHT       2
 161
 162 /* iconification styles */
 163 #define WIS_ZOOM        0
 164 #define WIS_TWIST       1
 165 #define WIS_FLIP        2
 166 #define WIS_NONE        3
 167 #define WIS_RANDOM      4 /* secret */
 168
 169 /* switchmenu actions */
 170 #define ACTION_ADD              0
 171 #define ACTION_REMOVE           1
 172 #define ACTION_CHANGE           2
 173 #define ACTION_CHANGE_WORKSPACE 3
 174 #define ACTION_CHANGE_STATE     4
 175
 176
 177 /* speeds */
 178 #define SPEED_ULTRAFAST 0
 179 #define SPEED_FAST      1
 180 #define SPEED_MEDIUM    2
 181 #define SPEED_SLOW      3
 182 #define SPEED_ULTRASLOW 4
 183
 184
 185 /* window states */
 186 #define WS_FOCUSED      0
 187 #define WS_UNFOCUSED    1
 188 #define WS_PFOCUSED     2
 189
 190 /* clip title colors */
 191 #define CLIP_NORMAL     0
 192 #define CLIP_COLLAPSED  1
 193
 194
 195 /* icon yard position */
 196 #define IY_VERT         1
 197 #define IY_HORIZ        0
 198 #define IY_TOP          2
 199 #define IY_BOTTOM       0
 200 #define IY_RIGHT        4
 201 #define IY_LEFT         0
 202
 203
 204 /* menu styles */
 205 #define MS_NORMAL               0
 206 #define MS_SINGLE_TEXTURE       1
 207 #define MS_FLAT                 2
 208
 209 /* workspace actions */
 210 #define WA_NONE                 0
 211 #define WA_SELECT_WINDOWS       1
 212 #define WA_OPEN_APPMENU         2
 213 #define WA_OPEN_WINLISTMENU     3
 214 #define WA_SWITCH_WORKSPACES    4
 215
 216 /* workspace display position */
 217 #define WD_NONE         0
 218 #define WD_CENTER       1
 219 #define WD_TOP          2
 220 #define WD_BOTTOM       3
 221 #define WD_TOPLEFT      4
 222 #define WD_TOPRIGHT     5
 223 #define WD_BOTTOMLEFT   6
 224 #define WD_BOTTOMRIGHT  7
 225
 226 /* titlebar style */
 227 #define TS_NEW          0
 228 #define TS_OLD          1
 229 #define TS_NEXT         2
 230
 231 /* workspace border position */
 232 #define WB_NONE         0
 233 #define WB_LEFTRIGHT    1
 234 #define WB_TOPBOTTOM    2
 235 #define WB_ALLDIRS      (WB_LEFTRIGHT|WB_TOPBOTTOM)
 236
 237
 238 /* program states */
 239 #define WSTATE_NORMAL           0
 240 #define WSTATE_NEED_EXIT        1
 241 #define WSTATE_NEED_RESTART     2
 242 #define WSTATE_EXITING          3
 243 #define WSTATE_RESTARTING       4
 244 #define WSTATE_MODAL            5
 245 #define WSTATE_NEED_REREAD      6
 246
 247
 248 #define WCHECK_STATE(state)     (state == WProgramState)
 249
 250
 251 #define WCHANGE_STATE(nstate) {\
 252     if (WProgramState == WSTATE_NORMAL\
 253         || nstate != WSTATE_MODAL)\
 254         WProgramState = (nstate); \
 255     if (WProgramSigState != 0)\
 256         WProgramState = WProgramSigState;\
 257 }
 258
 259
 260 /* only call inside signal handlers, with signals blocked */
 261 #define SIG_WCHANGE_STATE(nstate) {\
 262     WProgramSigState = (nstate);\
 263     WProgramState = (nstate);\
 264 }
 265
 266
 267 /* Flags for the Window Maker state when restarting/crash situations */
 268 #define WFLAGS_NONE       (0)
 269 #define WFLAGS_CRASHED    (1<<0)
 270
 271
 272 /* notifications */
 273
 274 #ifdef MAINFILE
 275 #define NOTIFICATION(n) char *WN##n = #n
 276 #else
 277 #define NOTIFICATION(n) extern char *WN##n
 278 #endif
 279
 280 NOTIFICATION(WindowAppearanceSettingsChanged);
 281
 282 NOTIFICATION(IconAppearanceSettingsChanged);
 283
 284 NOTIFICATION(IconTileSettingsChanged);
 285
 286 NOTIFICATION(MenuAppearanceSettingsChanged);
 287
 288 NOTIFICATION(MenuTitleAppearanceSettingsChanged);
 289
 290
 291 /* appearance settings clientdata flags */
 292 enum {
 293     WFontSettings = 1 << 0,
 294     WTextureSettings = 1 << 1,
 295     WColorSettings = 1 << 2
 296 };
 297
 298
 299
 300 typedef struct {
 301     int x1, y1;
 302     int x2, y2;
 303 } WArea;
 304
 305 typedef struct WCoord {
 306     int x, y;
 307 } WCoord;
 308
 309 typedef struct WPreferences {
 310     char *pixmap_path;                 /* : separated list of paths to find pixmaps */
 311     char *icon_path;                   /* : separated list of paths to find icons */
 312     WMArray *fallbackWMs;              /* fallback window manager list */
 313     char *logger_shell;                /* shell to log child stdi/o */
 314     RImage *button_images;             /* titlebar button images */
 315     char smooth_workspace_back;
 316     signed char size_display;          /* display type for resize geometry */
 317     signed char move_display;          /* display type for move geometry */
 318     signed char window_placement;      /* window placement mode */
 319     signed char colormap_mode;         /* colormap focus mode */
 320     signed char focus_mode;            /* window focusing mode */
 321
 322     char opaque_move;                  /* update window position during move */
 323     char opaque_resize;                /* update window position during resize */
 324     char opaque_move_resize_keyboard; /* update window position during move,resize with keyboard */
 325     char wrap_menus;                   /* wrap menus at edge of screen */
 326     char scrollable_menus;             /* let them be scrolled */
 327     char align_menus;                  /* align menu with their parents */
 328     char use_saveunders;               /* turn on SaveUnders for menus, icons etc. */
 329     char no_window_over_dock;
 330     char no_window_over_icons;
 331     WCoord window_place_origin;        /* Offset for windows placed on screen */
 332
 333     char constrain_window_size;        /* don't let windows get bigger than screen */
 334     char windows_cycling;              /* windoze cycling */
 335     char circ_raise;                   /* raise window after Alt-tabbing */
 336     char ignore_focus_click;
 337     char open_transients_with_parent;  /* open transient window in same workspace as parent */
 338     signed char title_justification;   /* titlebar text alignment */
 339     int window_title_clearance;
 340     int menu_title_clearance;
 341     int menu_text_clearance;
 342     char multi_byte_text;
 343 #ifdef KEEP_XKB_LOCK_STATUS
 344     char modelock;
 345 #endif
 346     char no_dithering;                 /* use dithering or not */
 347     char no_animations;                /* enable/disable animations */
 348     char no_autowrap;                  /* wrap workspace when window is moved
 349     * to the edge */
 350
 351     char auto_arrange_icons;           /* automagically arrange icons */
 352     char icon_box_position;            /* position to place icons */
 353     signed char iconification_style;          /* position to place icons */
 354     char disable_root_mouse;           /* disable button events in root window */
 355     char auto_focus;                   /* focus window when it's mapped */
 356     char *icon_back_file;              /* background image for icons */
 357
 358     WCoord *root_menu_pos;             /* initial position of the root menu*/
 359     WCoord *app_menu_pos;
 360     WCoord *win_menu_pos;
 361
 362     signed char icon_yard;             /* aka iconbox */
 363
 364     int raise_delay;                   /* delay for autoraise. 0 is disabled */
 365     int cmap_size;                     /* size of dithering colormap in colors per channel */
 366
 367     int icon_size;                     /* size of the icon */
 368     signed char menu_style;            /* menu decoration style */
 369     signed char workspace_name_display_position;
 370     unsigned int modifier_mask;        /* mask to use as kbd modifier */
 371     char *modifier_labels[7];          /* Names of the modifiers */
 372
 373
 374     char ws_advance;                   /* Create new workspace and advance */
 375     char ws_cycle;                     /* Cycle existing workspaces */
 376     char save_session_on_exit;         /* automatically save session on exit */
 377     char sticky_icons;                 /* If miniwindows will be onmipresent */
 378     char dont_confirm_kill;            /* do not confirm Kill application */
 379     char disable_miniwindows;
 380     char dont_blink;                   /* do not blink icon selection */
 381
 382     /* Appearance options */
 383     char new_style;                    /* Use newstyle buttons */
 384     char superfluous;                  /* Use superfluous things */
 385
 386     /* root window mouse bindings */
 387     signed char mouse_button1;         /* action for left mouse button */
 388     signed char mouse_button2;         /* action for middle mouse button */
 389     signed char mouse_button3;         /* action for right mouse button */
 390     signed char mouse_wheel;           /* action for mouse wheel */
 391
 392     /* balloon text */
 393     char window_balloon;
 394     char miniwin_balloon;
 395     char appicon_balloon;
 396     char help_balloon;
 397
 398     /* some constants */
 399     int dblclick_time;                 /* double click delay time in ms */
 400
 401     /* animate menus */
 402     signed char menu_scroll_speed;             /* how fast menus are scrolled */
 403
 404     /* animate icon sliding */
 405     signed char icon_slide_speed;              /* icon slide animation speed */
 406
 407     /* shading animation */
 408     signed char shade_speed;
 409
 410     /* bouncing animation */
 411     char bounce_appicons_when_urgent;
 412     char raise_appicons_when_bouncing;
 413
 414     int edge_resistance;
 415     int resize_increment;
 416     char attract;
 417
 418     unsigned int workspace_border_size; /* Size in pixels of the workspace border */
 419     char workspace_border_position;     /* Where to leave a workspace border */
 420     char single_click;                  /* single click to lauch applications */
 421     int history_lines;                  /* history of "Run..." dialog */
 422     char cycle_active_head_only;        /* Cycle only windows on the active head */
 423
 424     RImage *swtileImage;
 425     RImage *swbackImage[9];
 426
 427     int show_clip_title;
 428
 429     struct {
 430         unsigned int nodock:1;         /* don't display the dock */
 431         unsigned int noclip:1;         /* don't display the clip */
 432         unsigned int nocpp:1;          /* don't use cpp */
 433         unsigned int noupdates:1;      /* don't require ~/GNUstep (-static) */
 434         unsigned int noautolaunch:1;   /* don't autolaunch apps */
 435         unsigned int norestore:1;      /* don't restore session */
 436         unsigned int create_stdcmap:1; /* create std colormap */
 437 #ifndef HAVE_INOTIFY
 438         unsigned int nopolling:1;      /* don't poll the defaults database for changes */
 439 #endif
 440         unsigned int restarting:2;
 441     } flags;                           /* internal flags */
 442 } WPreferences;
 443
 444
 445
 446 /****** Global Variables  ******/
 447 extern Display  *dpy;
 448 extern char *ProgName;
 449 extern unsigned int ValidModMask;
 450 extern char WProgramState;
 451 extern char WProgramSigState;
 452
 453
 454 /****** Global Functions ******/
 455 extern void wAbort(Bool dumpCore);
 456
 457
 458 /****** Notifications ******/
 459 extern const char *WMNManaged;
 460 extern const char *WMNUnmanaged;
 461 extern const char *WMNChangedWorkspace;
 462 extern const char *WMNChangedState;
 463 extern const char *WMNChangedFocus;
 464 extern const char *WMNChangedStacking;
 465 extern const char *WMNChangedName;
 466
 467 extern const char *WMNWorkspaceCreated;
 468 extern const char *WMNWorkspaceDestroyed;
 469 extern const char *WMNWorkspaceChanged;
 470 extern const char *WMNWorkspaceNameChanged;
 471
 472 extern const char *WMNResetStacking;
 473 #endif
 474