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 /* internal buttons */
  91 #define WBUT_CLOSE              0
  92 #define WBUT_BROKENCLOSE        1
  93 #define WBUT_ICONIFY            2
  94 #define WBUT_KILL               3
  95 #ifdef XKB_BUTTON_HINT
  96 #define WBUT_XKBGROUP1          4
  97 #define WBUT_XKBGROUP2          5
  98 #define WBUT_XKBGROUP3          6
  99 #define WBUT_XKBGROUP4          7
 100 #define PRED_BPIXMAPS           8 /* reserved for 4 groups */
 101 #else
 102 #define PRED_BPIXMAPS           4 /* count of WBUT icons */
 103 #endif /* XKB_BUTTON_HINT */
 104
 105 /* Mouse cursors */
 106 typedef enum {
 107         WCUR_NORMAL,
 108         WCUR_MOVE,
 109         WCUR_RESIZE,
 110         WCUR_TOPLEFTRESIZE,
 111         WCUR_TOPRIGHTRESIZE,
 112         WCUR_BOTTOMLEFTRESIZE,
 113         WCUR_BOTTOMRIGHTRESIZE,
 114         WCUR_VERTICALRESIZE,
 115         WCUR_HORIZONRESIZE,
 116         WCUR_WAIT,
 117         WCUR_ARROW,
 118         WCUR_QUESTION,
 119         WCUR_TEXT,
 120         WCUR_SELECT,
 121         WCUR_ROOT,
 122         WCUR_EMPTY,
 123
 124         /* Count of the number of cursors defined */
 125         WCUR_LAST
 126 } w_cursor;
 127
 128 /* geometry displays */
 129 #define WDIS_NEW                0       /* new style */
 130 #define WDIS_CENTER             1       /* center of screen */
 131 #define WDIS_TOPLEFT            2       /* top left corner of screen */
 132 #define WDIS_FRAME_CENTER       3       /* center of the frame */
 133 #define WDIS_NONE               4
 134
 135 /* keyboard input focus mode */
 136 #define WKF_CLICK       0
 137 #define WKF_SLOPPY      2
 138
 139 /* colormap change mode */
 140 #define WCM_CLICK       0
 141 #define WCM_POINTER     1
 142
 143 /* window placement mode */
 144 #define WPM_MANUAL      0
 145 #define WPM_CASCADE     1
 146 #define WPM_SMART       2
 147 #define WPM_RANDOM      3
 148 #define WPM_AUTO        4
 149 #define WPM_CENTER      5
 150
 151 /* text justification */
 152 #define WTJ_CENTER      0
 153 #define WTJ_LEFT        1
 154 #define WTJ_RIGHT       2
 155
 156 /* iconification styles */
 157 #define WIS_ZOOM        0
 158 #define WIS_TWIST       1
 159 #define WIS_FLIP        2
 160 #define WIS_NONE        3
 161 #define WIS_RANDOM      4 /* secret */
 162
 163 /* switchmenu actions */
 164 #define ACTION_ADD              0
 165 #define ACTION_REMOVE           1
 166 #define ACTION_CHANGE           2
 167 #define ACTION_CHANGE_WORKSPACE 3
 168 #define ACTION_CHANGE_STATE     4
 169
 170
 171 /* speeds */
 172 #define SPEED_ULTRAFAST 0
 173 #define SPEED_FAST      1
 174 #define SPEED_MEDIUM    2
 175 #define SPEED_SLOW      3
 176 #define SPEED_ULTRASLOW 4
 177
 178
 179 /* window states */
 180 #define WS_FOCUSED      0
 181 #define WS_UNFOCUSED    1
 182 #define WS_PFOCUSED     2
 183
 184 /* clip title colors */
 185 #define CLIP_NORMAL     0
 186 #define CLIP_COLLAPSED  1
 187
 188
 189 /* icon yard position */
 190 #define IY_VERT         1
 191 #define IY_HORIZ        0
 192 #define IY_TOP          2
 193 #define IY_BOTTOM       0
 194 #define IY_RIGHT        4
 195 #define IY_LEFT         0
 196
 197
 198 /* menu styles */
 199 #define MS_NORMAL               0
 200 #define MS_SINGLE_TEXTURE       1
 201 #define MS_FLAT                 2
 202
 203 /* workspace actions */
 204 #define WA_NONE                 0
 205 #define WA_SELECT_WINDOWS       1
 206 #define WA_OPEN_APPMENU         2
 207 #define WA_OPEN_WINLISTMENU     3
 208 #define WA_SWITCH_WORKSPACES    4
 209
 210 /* workspace display position */
 211 #define WD_NONE         0
 212 #define WD_CENTER       1
 213 #define WD_TOP          2
 214 #define WD_BOTTOM       3
 215 #define WD_TOPLEFT      4
 216 #define WD_TOPRIGHT     5
 217 #define WD_BOTTOMLEFT   6
 218 #define WD_BOTTOMRIGHT  7
 219
 220 /* titlebar style */
 221 #define TS_NEW          0
 222 #define TS_OLD          1
 223 #define TS_NEXT         2
 224
 225 /* workspace border position */
 226 #define WB_NONE         0
 227 #define WB_LEFTRIGHT    1
 228 #define WB_TOPBOTTOM    2
 229 #define WB_ALLDIRS      (WB_LEFTRIGHT|WB_TOPBOTTOM)
 230
 231
 232 /* program states */
 233 typedef enum {
 234         WSTATE_NORMAL           = 0,
 235         WSTATE_NEED_EXIT        = 1,
 236         WSTATE_NEED_RESTART     = 2,
 237         WSTATE_EXITING          = 3,
 238         WSTATE_RESTARTING       = 4,
 239         WSTATE_MODAL            = 5,
 240         WSTATE_NEED_REREAD      = 6
 241 } wprog_state;
 242
 243
 244 #define WCHECK_STATE(chk_state) (w_global.program.state == (chk_state))
 245
 246
 247 #define WCHANGE_STATE(nstate) {\
 248     if (w_global.program.state == WSTATE_NORMAL\
 249         || (nstate) != WSTATE_MODAL)                      \
 250         w_global.program.state = (nstate); \
 251     if (w_global.program.signal_state != 0)\
 252         w_global.program.state = w_global.program.signal_state;\
 253 }
 254
 255
 256 /* only call inside signal handlers, with signals blocked */
 257 #define SIG_WCHANGE_STATE(nstate) {\
 258     w_global.program.signal_state = (nstate);\
 259     w_global.program.state = (nstate);\
 260 }
 261
 262
 263 /* Flags for the Window Maker state when restarting/crash situations */
 264 #define WFLAGS_NONE       (0)
 265 #define WFLAGS_CRASHED    (1<<0)
 266
 267
 268 /* notifications */
 269
 270 #ifdef MAINFILE
 271 #define NOTIFICATION(n) const char WN##n [] = #n
 272 #else
 273 #define NOTIFICATION(n) extern const char WN##n []
 274 #endif
 275
 276 NOTIFICATION(WindowAppearanceSettingsChanged);
 277
 278 NOTIFICATION(IconAppearanceSettingsChanged);
 279
 280 NOTIFICATION(IconTileSettingsChanged);
 281
 282 NOTIFICATION(MenuAppearanceSettingsChanged);
 283
 284 NOTIFICATION(MenuTitleAppearanceSettingsChanged);
 285
 286
 287 /* appearance settings clientdata flags */
 288 enum {
 289     WFontSettings = 1 << 0,
 290     WTextureSettings = 1 << 1,
 291     WColorSettings = 1 << 2
 292 };
 293
 294
 295
 296 typedef struct {
 297     int x1, y1;
 298     int x2, y2;
 299 } WArea;
 300
 301 typedef struct WCoord {
 302     int x, y;
 303 } WCoord;
 304
 305 extern struct WPreferences {
 306     char *pixmap_path;                 /* : separated list of paths to find pixmaps */
 307     char *icon_path;                   /* : separated list of paths to find icons */
 308     WMArray *fallbackWMs;              /* fallback window manager list */
 309     char *logger_shell;                /* shell to log child stdi/o */
 310     RImage *button_images;             /* titlebar button images */
 311     char smooth_workspace_back;
 312     signed char size_display;          /* display type for resize geometry */
 313     signed char move_display;          /* display type for move geometry */
 314     signed char window_placement;      /* window placement mode */
 315     signed char colormap_mode;         /* colormap focus mode */
 316     signed char focus_mode;            /* window focusing mode */
 317
 318     char opaque_move;                  /* update window position during move */
 319     char opaque_resize;                /* update window position during resize */
 320     char opaque_move_resize_keyboard; /* update window position during move,resize with keyboard */
 321     char wrap_menus;                   /* wrap menus at edge of screen */
 322     char scrollable_menus;             /* let them be scrolled */
 323     char vi_key_menus;                 /* use h/j/k/l to select */
 324     char align_menus;                  /* align menu with their parents */
 325     char use_saveunders;               /* turn on SaveUnders for menus, icons etc. */
 326     char no_window_over_dock;
 327     char no_window_over_icons;
 328     WCoord window_place_origin;        /* Offset for windows placed on screen */
 329
 330     char constrain_window_size;        /* don't let windows get bigger than screen */
 331     char windows_cycling;              /* windoze cycling */
 332     char circ_raise;                   /* raise window after Alt-tabbing */
 333     char ignore_focus_click;
 334     char open_transients_with_parent;  /* open transient window in same workspace as parent */
 335     signed char title_justification;   /* titlebar text alignment */
 336     int window_title_clearance;
 337     int window_title_min_height;
 338     int window_title_max_height;
 339     int menu_title_clearance;
 340     int menu_title_min_height;
 341     int menu_title_max_height;
 342     int menu_text_clearance;
 343     char multi_byte_text;
 344 #ifdef KEEP_XKB_LOCK_STATUS
 345     char modelock;
 346 #endif
 347     char no_dithering;                 /* use dithering or not */
 348     char no_animations;                /* enable/disable animations */
 349     char no_autowrap;                  /* wrap workspace when window is moved to the edge */
 350
 351     char highlight_active_app;         /* show the focused app by highlighting its icon */
 352     char auto_arrange_icons;           /* automagically arrange icons */
 353     char icon_box_position;            /* position to place icons */
 354     signed char iconification_style;   /* position to place icons */
 355     char disable_root_mouse;           /* disable button events in root window */
 356     char auto_focus;                   /* focus window when it's mapped */
 357     char *icon_back_file;              /* background image for icons */
 358
 359     WCoord *root_menu_pos;             /* initial position of the root menu*/
 360     WCoord *app_menu_pos;
 361     WCoord *win_menu_pos;
 362
 363     signed char icon_yard;             /* aka iconbox */
 364
 365     int raise_delay;                   /* delay for autoraise. 0 is disabled */
 366     int cmap_size;                     /* size of dithering colormap in colors per channel */
 367
 368     int icon_size;                     /* size of the icon */
 369     signed char menu_style;            /* menu decoration style */
 370     signed char workspace_name_display_position;
 371     unsigned int modifier_mask;        /* mask to use as kbd modifier */
 372     char *modifier_labels[7];          /* Names of the modifiers */
 373
 374         unsigned int supports_tiff;     /* Use tiff files */
 375
 376     char ws_advance;                   /* Create new workspace and advance */
 377     char ws_cycle;                     /* Cycle existing workspaces */
 378     char save_session_on_exit;         /* automatically save session on exit */
 379     char sticky_icons;                 /* If miniwindows will be onmipresent */
 380     char dont_confirm_kill;            /* do not confirm Kill application */
 381     char disable_miniwindows;
 382     char dont_blink;                   /* do not blink icon selection */
 383
 384     /* Appearance options */
 385     char new_style;                    /* Use newstyle buttons */
 386     char superfluous;                  /* Use superfluous things */
 387
 388     /* root window mouse bindings */
 389     signed char mouse_button1;         /* action for left mouse button */
 390     signed char mouse_button2;         /* action for middle mouse button */
 391     signed char mouse_button3;         /* action for right mouse button */
 392     signed char mouse_wheel;           /* action for mouse wheel */
 393
 394     /* balloon text */
 395     char window_balloon;
 396     char miniwin_balloon;
 397     char appicon_balloon;
 398     char help_balloon;
 399
 400     /* some constants */
 401     int dblclick_time;                 /* double click delay time in ms */
 402
 403     /* animate menus */
 404     signed char menu_scroll_speed;             /* how fast menus are scrolled */
 405
 406     /* animate icon sliding */
 407     signed char icon_slide_speed;              /* icon slide animation speed */
 408
 409     /* shading animation */
 410     signed char shade_speed;
 411
 412     /* bouncing animation */
 413     char bounce_appicons_when_urgent;
 414     char raise_appicons_when_bouncing;
 415     char do_not_make_appicons_bounce;
 416
 417     int edge_resistance;
 418     int resize_increment;
 419     char attract;
 420
 421     unsigned int workspace_border_size; /* Size in pixels of the workspace border */
 422     char workspace_border_position;     /* Where to leave a workspace border */
 423     char single_click;                  /* single click to lauch applications */
 424     int history_lines;                  /* history of "Run..." dialog */
 425     char cycle_active_head_only;        /* Cycle only windows on the active head */
 426     char cycle_ignore_minimized;        /* Ignore minimized windows when cycling */
 427     char strict_windoze_cycle;          /* don't close switchpanel when shift is released */
 428     char panel_only_open;               /* Only open the switchpanel; don't switch */
 429
 430     /* All delays here are in ms. 0 means instant auto-action. */
 431     int clip_auto_raise_delay;         /* Delay after which the clip will be raised when entered */
 432     int clip_auto_lower_delay;         /* Delay after which the clip will be lowered when leaved */
 433     int clip_auto_expand_delay;        /* Delay after which the clip will expand when entered */
 434     int clip_auto_collapse_delay;      /* Delay after which the clip will collapse when leaved */
 435
 436     RImage *swtileImage;
 437     RImage *swbackImage[9];
 438
 439     int show_clip_title;
 440
 441     struct {
 442         unsigned int nodock:1;         /* don't display the dock */
 443         unsigned int noclip:1;         /* don't display the clip */
 444         unsigned int clip_merged_in_dock:1; /* disable clip, dock gets its workspace switching functionality */
 445         unsigned int nodrawer:1;       /* don't use drawers */
 446         unsigned int wrap_appicons_in_dock:1; /* Whether to wrap appicons when Dock is moved up and down */
 447         unsigned int noupdates:1;      /* don't require ~/GNUstep (-static) */
 448         unsigned int noautolaunch:1;   /* don't autolaunch apps */
 449         unsigned int norestore:1;      /* don't restore session */
 450 #ifndef HAVE_INOTIFY
 451         unsigned int nopolling:1;      /* don't poll the defaults database for changes */
 452 #endif
 453         unsigned int restarting:2;
 454     } flags;                           /* internal flags */
 455
 456         /* Map table between w_cursor and actual X id */
 457         Cursor cursor[WCUR_LAST];
 458
 459 } wPreferences;
 460
 461 /****** Global Variables  ******/
 462 extern Display  *dpy;
 463
 464 extern struct wmaker_global_variables {
 465         /* Tracking of the state of the program */
 466         struct {
 467                 wprog_state state;
 468                 wprog_state signal_state;
 469         } program;
 470
 471         /* locale to use. NULL==POSIX or C */
 472         const char *locale;
 473
 474         /* Tracking of X events timestamps */
 475         struct {
 476                 /* ts of the last event we received */
 477                 Time last_event;
 478
 479                 /* ts on the last time we did XSetInputFocus() */
 480                 Time focus_change;
 481
 482         } timestamp;
 483
 484         /* Workspace related */
 485         struct {
 486                 WMFont *font_for_name;  /* used during workspace switch */
 487         } workspace;
 488
 489         /* definition for X Atoms */
 490         struct {
 491
 492                 /* Window-Manager related */
 493                 struct {
 494                         Atom state;
 495                         Atom change_state;
 496                         Atom protocols;
 497                         Atom take_focus;
 498                         Atom delete_window;
 499                         Atom save_yourself;
 500                         Atom client_leader;
 501                         Atom colormap_windows;
 502                         Atom colormap_notify;
 503                         Atom ignore_focus_events;
 504                 } wm;
 505
 506                 /* GNUStep related */
 507                 struct {
 508                         Atom wm_attr;
 509                         Atom wm_miniaturize_window;
 510                         Atom wm_resizebar;
 511                         Atom titlebar_state;
 512                 } gnustep;
 513
 514                 /* WindowMaker specific */
 515                 struct {
 516                         Atom menu;
 517                         Atom wm_protocols;
 518                         Atom state;
 519
 520                         Atom wm_function;
 521                         Atom noticeboard;
 522                         Atom command;
 523
 524                         Atom icon_size;
 525                         Atom icon_tile;
 526                 } wmaker;
 527
 528         } atom;
 529
 530         /* X Contexts */
 531         struct {
 532                 XContext client_win;
 533                 XContext app_win;
 534                 XContext stack;
 535         } context;
 536
 537 } w_global;
 538
 539 extern unsigned int ValidModMask;
 540
 541 /****** Notifications ******/
 542 extern const char WMNManaged[];
 543 extern const char WMNUnmanaged[];
 544 extern const char WMNChangedWorkspace[];
 545 extern const char WMNChangedState[];
 546 extern const char WMNChangedFocus[];
 547 extern const char WMNChangedStacking[];
 548 extern const char WMNChangedName[];
 549
 550 extern const char WMNWorkspaceCreated[];
 551 extern const char WMNWorkspaceDestroyed[];
 552 extern const char WMNWorkspaceChanged[];
 553 extern const char WMNWorkspaceNameChanged[];
 554
 555 extern const char WMNResetStacking[];
 556
 557 #endif