src/window.h

   1 /*
   2  *  Window Maker window manager
   3  *
   4  *  Copyright (c) 1997, 1998 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
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  19  *  USA.
  20  */
  21
  22 #ifndef WMWINDOW_H_
  23 #define WMWINDOW_H_
  24
  25 #include <wraster.h>
  26
  27 #include "wconfig.h"
  28 #include "GNUstep.h"
  29 #include "texture.h"
  30 #include "menu.h"
  31 #include "application.h"
  32
  33 /* not defined in my X11 headers */
  34 #ifndef UrgencyHint
  35 #define UrgencyHint (1L << 8)
  36 #endif
  37
  38
  39 #define BORDER_TOP      1
  40 #define BORDER_BOTTOM   2
  41 #define BORDER_LEFT     4
  42 #define BORDER_RIGHT    8
  43 #define BORDER_ALL      (1|2|4|8)
  44
  45
  46 #define CLIENT_EVENTS (StructureNotifyMask | PropertyChangeMask\
  47         | EnterWindowMask | LeaveWindowMask | ColormapChangeMask \
  48         | FocusChangeMask | VisibilityChangeMask)
  49
  50 typedef enum {
  51     WFM_PASSIVE, WFM_NO_INPUT, WFM_LOCALLY_ACTIVE, WFM_GLOBALLY_ACTIVE
  52 } FocusMode;
  53
  54
  55 /*
  56  * window attribute flags.
  57  *
  58  * Note: attributes that should apply to the application as a
  59  * whole should only access the flags from the app->main_window_desc->window_flags
  60  * This is to make sure that the application doesn't have many different
  61  * values for the same option. For example, imagine xfoo, which has
  62  * foo.bar as leader and it a child window named foo.baz. If you set
  63  * StartHidden YES for foo.bar and NO for foo.baz we must *always* guarantee
  64  * that the value that will be used will be that of the leader foo.bar.
  65  * The attributes inspector must always save application wide options
  66  * in the name of the leader window, not the child.
  67  *
  68  */
  69 /*
  70  * All flags must have their default values = 0
  71  *
  72  * New flag scheme:
  73  *
  74  * user_flags, defined_flags
  75  * client_flags
  76  *
  77  * if defined window_flag then window_flag else client_flag
  78  *
  79  */
  80
  81 #define WFLAGP(wwin, FLAG)      ((wwin)->defined_user_flags.FLAG \
  82                                         ? (wwin)->user_flags.FLAG \
  83                                         : (wwin)->client_flags.FLAG)
  84
  85 #define WSETUFLAG(wwin, FLAG, VAL)      (wwin)->user_flags.FLAG = (VAL),\
  86                                         (wwin)->defined_user_flags.FLAG = 1
  87
  88 typedef struct {
  89     /* OpenStep */
  90     unsigned int no_titlebar:1;        /* draw titlebar? */
  91     unsigned int no_resizable:1;
  92     unsigned int no_closable:1;
  93     unsigned int no_miniaturizable:1;
  94 #ifdef XKB_BUTTON_HINT
  95     unsigned int no_language_button:1;
  96 #endif
  97
  98     /* decorations */
  99     unsigned int no_resizebar:1;       /* draw the bottom handle? */
 100     unsigned int no_close_button:1;    /* draw a close button? */
 101     unsigned int no_miniaturize_button:1; /* draw an iconify button? */
 102
 103     unsigned int broken_close:1;       /* is the close button broken? */
 104
 105     /* ours */
 106     unsigned int kill_close:1;         /* can't send WM_DELETE_WINDOW */
 107
 108     unsigned int no_shadeable:1;
 109     unsigned int omnipresent:1;
 110     unsigned int skip_window_list:1;
 111     unsigned int floating:1;           /* put in WMFloatingLevel */
 112     unsigned int sunken:1;             /* put in WMSunkenLevel */
 113     unsigned int no_bind_keys:1;       /* intercept wm kbd binds
 114                                         * while window is focused */
 115     unsigned int no_bind_mouse:1;      /* intercept mouse events
 116                                         * on client area while window
 117                                         * is focused */
 118     unsigned int no_hide_others:1;     /* hide window when doing hideothers */
 119     unsigned int no_appicon:1;         /* make app icon */
 120
 121     unsigned int dont_move_off:1;
 122
 123     unsigned int no_focusable:1;
 124
 125     unsigned int always_user_icon:1;   /* ignore client IconPixmap or
 126                                         * IconWindow */
 127
 128     unsigned int start_miniaturized:1;
 129     unsigned int start_hidden:1;
 130     unsigned int start_maximized:1;
 131     unsigned int dont_save_session:1;  /* do not save app's state in session */
 132
 133     unsigned int full_maximize:1;
 134
 135     /*
 136      * emulate_app_icon must be automatically disabled for apps that can
 137      * generate their own appicons and for apps that have no_appicon=1
 138      */
 139     unsigned int emulate_appicon:1;
 140
 141     /* toolkit specific attribute flags. These are unchangeable and
 142      * unconfigurable and must not be saved as state. */
 143 #ifdef OLWM_HINTS
 144     unsigned int olwm_transient:1;
 145     unsigned int olwm_warp_to_pin:1;
 146 #endif
 147 } WWindowAttributes;
 148
 149
 150
 151 /*
 152  * Window manager protocols that both the client as we understand.
 153  */
 154 typedef struct {
 155     unsigned int TAKE_FOCUS:1;
 156     unsigned int DELETE_WINDOW:1;
 157     unsigned int SAVE_YOURSELF:1;
 158     /* WindowMaker specific */
 159     unsigned int MINIATURIZE_WINDOW:1;
 160 #ifdef MONITOR_HEARTBEAT
 161     unsigned int HEARTBEAT:1;
 162 #endif
 163 } WProtocols;
 164
 165
 166 /*
 167  * Stores client window information. Each client window has it's
 168  * structure created when it's being first mapped.
 169  */
 170 typedef struct WWindow {
 171     struct WWindow *prev;              /* window focus list */
 172     struct WWindow *next;
 173
 174     WScreen *screen_ptr;               /* pointer to the screen structure */
 175     WWindowAttributes user_flags;      /* window attribute flags set by user */
 176     WWindowAttributes defined_user_flags;/* mask for user_flags */
 177     WWindowAttributes client_flags;    /* window attribute flags set by app
 178                                         * initialized with global defaults */
 179
 180     struct InspectorPanel *inspector;  /*  pointer to attribute editor panel */
 181
 182     struct WFrameWindow *frame;        /* the frame window */
 183     int frame_x, frame_y;              /* position of the frame in root*/
 184
 185     struct {
 186         int x, y;
 187         unsigned int width, height;    /* original geometry of the window */
 188     } old_geometry;                    /* (before things like maximize) */
 189
 190     /* client window info */
 191     short old_border_width;            /* original border width of client_win*/
 192     Window client_win;                 /* the window we're managing */
 193     WObjDescriptor client_descriptor; /* dummy descriptor for client */
 194     struct {
 195         int x, y;                      /* position of *client* relative
 196                                         * to root */
 197         unsigned int width, height;    /* size of the client window */
 198     } client;
 199
 200     XSizeHints *normal_hints;          /* WM_NORMAL_HINTS */
 201     XWMHints *wm_hints;                /* WM_HINTS (optional) */
 202     char *wm_instance;                 /* instance of WM_CLASS */
 203     char *wm_class;                    /* class of WM_CLASS */
 204     GNUstepWMAttributes *wm_gnustep_attr;/* GNUstep window attributes */
 205
 206     int state;                         /* state as in ICCCM */
 207
 208     Window transient_for;              /* WM_TRANSIENT_FOR */
 209     Window group_id;                   /* the leader window of the group */
 210     Window client_leader;              /* WM_CLIENT_LEADER if not
 211                                         internal_window */
 212
 213     Window main_window;                /* main window for the application */
 214
 215     int cmap_window_no;
 216     Window *cmap_windows;
 217
 218     /* protocols */
 219     WProtocols protocols;              /* accepted WM_PROTOCOLS */
 220
 221     FocusMode focus_mode;              /* type of keyboard input focus */
 222
 223 #ifdef OLWM_HINTS_unfinished
 224     struct WOLWindowState ol_window_state;
 225 #endif
 226
 227     long event_mask;                   /* the event mask thats selected */
 228
 229 #ifdef MONITOR_HEARTBEAT
 230     time_t last_beat;
 231 #endif
 232     struct {
 233         /* state flags */
 234         unsigned int mapped:1;
 235         unsigned int focused:1;
 236         unsigned int miniaturized:1;
 237         unsigned int hidden:1;
 238         unsigned int shaded:1;
 239         unsigned int maximized:2;
 240         unsigned int omnipresent:1;
 241
 242         unsigned int semi_focused:1;
 243         /* window type flags */
 244         unsigned int urgent:1;         /* if wm_hints says this is urgent */
 245 #ifdef SHAPE
 246         unsigned int shaped:1;
 247 #endif
 248
 249         /* info flags */
 250         unsigned int buttons_dont_fit:1;
 251         unsigned int rebuild_texture:1;/* the window was resized and
 252                                         * gradients should be re-rendered */
 253         unsigned int needs_full_repaint:1;/* does a full repaint of the
 254                                            * window next time it's painted */
 255         unsigned int icon_moved:1;     /* icon for this window was moved
 256                                         * by the user */
 257         unsigned int selected:1;       /* multiple window selection */
 258         unsigned int skip_next_animation:1;
 259         unsigned int internal_window:1;
 260         unsigned int changing_workspace:1;
 261
 262         unsigned int inspector_open:1; /* attrib inspector is already open */
 263
 264         unsigned int destroyed:1;      /* window was already destroyed */
 265
 266         unsigned int menu_open_for_me:1;   /* window commands menu */
 267
 268         unsigned int waiting_save_ack:1;   /* waiting for SAVE_YOURSELF ack */
 269
 270         unsigned int obscured:1;       /* window is obscured */
 271
 272         unsigned int dragged_while_fmaximized;
 273
 274         unsigned int user_changed_width:1;
 275         unsigned int user_changed_height:1;
 276         unsigned int wm_name_changed:1;
 277
 278 #ifdef KWM_HINTS
 279         unsigned int kwm_hidden_for_modules:1;
 280         unsigned int kwm_managed:1;
 281         unsigned int kwm_menubar:1;
 282 #endif
 283 #ifdef OLWM_HINTS
 284         unsigned int olwm_push_pin_out:1;/* emulate pushpin behaviour */
 285         unsigned int olwm_limit_menu:1;
 286 #endif
 287     } flags;            /* state of the window */
 288
 289     struct WIcon *icon;                /* icon info for the window */
 290     int icon_x, icon_y;                /* position of the icon */
 291 } WWindow;
 292
 293
 294 #define IS_OMNIPRESENT(w) ((w)->flags.omnipresent ^ WFLAGP(w, omnipresent))
 295
 296 #define WINDOW_LEVEL(w) ((w)->frame->core->stacking->window_level)
 297
 298
 299
 300 /*
 301  * Changes to this must update wWindowSaveState/getSavedState
 302  *
 303  */
 304 typedef struct WSavedState {
 305     int workspace;
 306     int miniaturized;
 307     int shaded;
 308     int hidden;
 309     int use_geometry;
 310     int x;
 311     int y;
 312     unsigned int w;
 313     unsigned int h;
 314     unsigned window_shortcuts; /* mask like 1<<shortcut_number */
 315 } WSavedState;
 316
 317
 318 typedef struct WWindowState {
 319     char *instance;
 320     char *class;
 321     char *command;
 322     pid_t pid;
 323     WSavedState *state;
 324     struct WWindowState *next;
 325 } WWindowState;
 326
 327
 328 typedef void* WMagicNumber;
 329
 330
 331
 332 void wWindowDestroy(WWindow *wwin);
 333 WWindow *wWindowCreate();
 334
 335 #ifdef SHAPE
 336 void wWindowSetShape(WWindow *wwin);
 337 void wWindowClearShape(WWindow *wwin);
 338 #endif
 339
 340 WWindow *wManageWindow(WScreen *scr, Window window);
 341
 342 void wUnmanageWindow(WWindow *wwin, Bool restore, Bool destroyed);
 343
 344 void wWindowFocus(WWindow *wwin, WWindow *owin);
 345 void wWindowUnfocus(WWindow *wwin);
 346 void wWindowConstrainSize(WWindow *wwin, int *nwidth, int *nheight);
 347 void wWindowConfigure(WWindow *wwin, int req_x, int req_y,
 348                       int req_width, int req_height);
 349
 350 void wWindowMove(WWindow *wwin, int req_x, int req_y);
 351
 352 void wWindowSynthConfigureNotify(WWindow *wwin);
 353
 354 WWindow *wWindowFor(Window window);
 355
 356
 357 void wWindowConfigureBorders(WWindow *wwin);
 358
 359 void wWindowUpdateButtonImages(WWindow *wwin);
 360
 361 void wWindowSaveState(WWindow *wwin);
 362
 363 void wWindowChangeWorkspace(WWindow *wwin, int workspace);
 364
 365 void wWindowSetKeyGrabs(WWindow *wwin);
 366
 367 void wWindowResetMouseGrabs(WWindow *wwin);
 368
 369 WWindow *wManageInternalWindow(WScreen *scr, Window window, Window owner,
 370                                char *title, int x, int y,
 371                                int width, int height);
 372
 373 void wWindowSetupInitialAttributes(WWindow *wwin, int *level, int *workspace);
 374
 375 void wWindowUpdateGNUstepAttr(WWindow *wwin, GNUstepWMAttributes *attr);
 376
 377 void wWindowMap(WWindow *wwin);
 378
 379 void wWindowUnmap(WWindow *wwin);
 380
 381 Bool wWindowCanReceiveFocus(WWindow *wwin);
 382
 383 void wWindowDeleteSavedStatesForPID(pid_t pid);
 384
 385 WMagicNumber wWindowAddSavedState(char *instance, char *class, char *command,
 386                                   pid_t pid, WSavedState *state);
 387
 388 WMagicNumber wWindowGetSavedState(Window win);
 389
 390 void wWindowDeleteSavedState(WMagicNumber id);
 391
 392 Bool wWindowObscuresWindow(WWindow *wwin, WWindow *obscured);
 393
 394 #endif