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
  95     /* decorations */
  96     unsigned int no_resizebar:1;       /* draw the bottom handle? */
  97     unsigned int no_close_button:1;    /* draw a close button? */
  98     unsigned int no_miniaturize_button:1; /* draw an iconify button? */
  99
 100     unsigned int broken_close:1;       /* is the close button broken? */
 101
 102     /* ours */
 103     unsigned int kill_close:1;         /* can't send WM_DELETE_WINDOW */
 104
 105     unsigned int no_shadeable:1;
 106     unsigned int omnipresent:1;
 107     unsigned int skip_window_list:1;
 108     unsigned int floating:1;           /* put in WMFloatingLevel */
 109     unsigned int sunken:1;             /* put in WMSunkenLevel */
 110     unsigned int no_bind_keys:1;       /* intercept wm kbd binds
 111                                         * while window is focused */
 112     unsigned int no_bind_mouse:1;      /* intercept mouse events
 113                                         * on client area while window
 114                                         * is focused */
 115     unsigned int no_hide_others:1;     /* hide window when doing hideothers */
 116     unsigned int no_appicon:1;         /* make app icon */
 117
 118     unsigned int dont_move_off:1;
 119
 120     unsigned int no_focusable:1;
 121
 122     unsigned int always_user_icon:1;   /* ignore client IconPixmap or
 123                                         * IconWindow */
 124
 125     unsigned int start_miniaturized:1;
 126     unsigned int start_hidden:1;
 127     unsigned int start_maximized:1;
 128     unsigned int dont_save_session:1;  /* do not save app's state in session */
 129
 130     unsigned int full_maximize:1;
 131
 132     /*
 133      * emulate_app_icon must be automatically disabled for apps that can
 134      * generate their own appicons and for apps that have no_appicon=1
 135      */
 136     unsigned int emulate_appicon:1;
 137
 138     /* toolkit specific attribute flags. These are unchangeable and
 139      * unconfigurable and must not be saved as state. */
 140 #ifdef OLWM_HINTS
 141     unsigned int olwm_transient:1;
 142     unsigned int olwm_warp_to_pin:1;
 143 #endif
 144
 145 } WWindowAttributes;
 146
 147
 148
 149 /*
 150  * Window manager protocols that both the client as we understand.
 151  */
 152 typedef struct {
 153     unsigned int TAKE_FOCUS:1;
 154     unsigned int DELETE_WINDOW:1;
 155     unsigned int SAVE_YOURSELF:1;
 156     /* WindowMaker specific */
 157     unsigned int MINIATURIZE_WINDOW:1;
 158 #ifdef MONITOR_HEARTBEAT
 159     unsigned int HEARTBEAT:1;
 160 #endif
 161 } WProtocols;
 162
 163
 164 /*
 165  * Stores client window information. Each client window has it's
 166  * structure created when it's being first mapped.
 167  */
 168 typedef struct WWindow {
 169     struct WWindow *prev;              /* window focus list */
 170     struct WWindow *next;
 171
 172     WScreen *screen_ptr;               /* pointer to the screen structure */
 173     WWindowAttributes user_flags;      /* window attribute flags set by user */
 174     WWindowAttributes defined_user_flags;/* mask for user_flags */
 175     WWindowAttributes client_flags;    /* window attribute flags set by app
 176                                         * initialized with global defaults */
 177
 178     struct InspectorPanel *inspector;  /*  pointer to attribute editor panel */
 179
 180     struct WFrameWindow *frame;        /* the frame window */
 181     int frame_x, frame_y;              /* position of the frame in root*/
 182
 183     struct {
 184         int x, y;
 185         unsigned int width, height;    /* original geometry of the window */
 186     } old_geometry;                    /* (before things like maximize) */
 187
 188     /* client window info */
 189     short old_border_width;            /* original border width of client_win*/
 190     Window client_win;                 /* the window we're managing */
 191     WObjDescriptor client_descriptor; /* dummy descriptor for client */
 192     struct {
 193         int x, y;                      /* position of *client* relative
 194                                         * to root */
 195         unsigned int width, height;    /* size of the client window */
 196     } client;
 197
 198     XSizeHints *normal_hints;          /* WM_NORMAL_HINTS */
 199     XWMHints *wm_hints;                /* WM_HINTS (optional) */
 200     char *wm_instance;                 /* instance of WM_CLASS */
 201     char *wm_class;                    /* class of WM_CLASS */
 202     GNUstepWMAttributes *wm_gnustep_attr;/* GNUstep window attributes */
 203
 204     int state;                         /* state as in ICCCM */
 205
 206     Window transient_for;              /* WM_TRANSIENT_FOR */
 207     Window group_id;                   /* the leader window of the group */
 208     Window client_leader;              /* WM_CLIENT_LEADER if not
 209                                         internal_window */
 210
 211     Window main_window;                /* main window for the application */
 212
 213     int cmap_window_no;
 214     Window *cmap_windows;
 215
 216     /* protocols */
 217     WProtocols protocols;              /* accepted WM_PROTOCOLS */
 218
 219     FocusMode focus_mode;              /* type of keyboard input focus */
 220
 221 #ifdef OLWM_HINTS_unfinished
 222     struct WOLWindowState ol_window_state;
 223 #endif
 224
 225     long event_mask;                   /* the event mask thats selected */
 226
 227 #ifdef MONITOR_HEARTBEAT
 228     time_t last_beat;
 229 #endif
 230     struct {
 231         /* state flags */
 232         unsigned int mapped:1;
 233         unsigned int focused:1;
 234         unsigned int miniaturized:1;
 235         unsigned int hidden:1;
 236         unsigned int shaded:1;
 237         unsigned int maximized:2;
 238         unsigned int omnipresent:1;
 239
 240         unsigned int semi_focused:1;
 241         /* window type flags */
 242         unsigned int urgent:1;         /* if wm_hints says this is urgent */
 243 #ifdef SHAPE
 244         unsigned int shaped:1;
 245 #endif
 246
 247         /* info flags */
 248         unsigned int buttons_dont_fit:1;
 249         unsigned int rebuild_texture:1;/* the window was resized and
 250                                         * gradients should be re-rendered */
 251         unsigned int needs_full_repaint:1;/* does a full repaint of the
 252                                            * window next time it's painted */
 253         unsigned int icon_moved:1;     /* icon for this window was moved
 254                                         * by the user */
 255         unsigned int selected:1;       /* multiple window selection */
 256         unsigned int skip_next_animation:1;
 257         unsigned int internal_window:1;
 258         unsigned int changing_workspace:1;
 259
 260         unsigned int inspector_open:1; /* attrib inspector is already open */
 261
 262         unsigned int destroyed:1;      /* window was already destroyed */
 263
 264         unsigned int menu_open_for_me:1;   /* window commands menu */
 265
 266         unsigned int waiting_save_ack:1;   /* waiting for SAVE_YOURSELF ack */
 267
 268         unsigned int obscured:1;       /* window is obscured */
 269
 270         unsigned int dragged_while_fmaximized;
 271
 272         unsigned int user_changed_width:1;
 273         unsigned int user_changed_height:1;
 274         unsigned int wm_name_changed:1;
 275
 276 #ifdef KWM_HINTS
 277         unsigned int kwm_hidden_for_modules:1;
 278         unsigned int kwm_managed:1;
 279         unsigned int kwm_menubar:1;
 280 #endif
 281 #ifdef OLWM_HINTS
 282         unsigned int olwm_push_pin_out:1;/* emulate pushpin behaviour */
 283         unsigned int olwm_limit_menu:1;
 284 #endif
 285     } flags;            /* state of the window */
 286
 287     struct WIcon *icon;                /* icon info for the window */
 288     int icon_x, icon_y;                /* position of the icon */
 289 } WWindow;
 290
 291
 292 #define IS_OMNIPRESENT(w) ((w)->flags.omnipresent ^ WFLAGP(w, omnipresent))
 293
 294 #define WINDOW_LEVEL(w) ((w)->frame->core->stacking->window_level)
 295
 296
 297
 298 /*
 299  * Changes to this must update wWindowSaveState/getSavedState
 300  *
 301  */
 302 typedef struct WSavedState {
 303     int workspace;
 304     int miniaturized;
 305     int shaded;
 306     int hidden;
 307     int use_geometry;
 308     int x;
 309     int y;
 310     unsigned int w;
 311     unsigned int h;
 312     unsigned window_shortcuts; /* mask like 1<<shortcut_number */
 313 } WSavedState;
 314
 315
 316 typedef struct WWindowState {
 317     char *instance;
 318     char *class;
 319     char *command;
 320     pid_t pid;
 321     WSavedState *state;
 322     struct WWindowState *next;
 323 } WWindowState;
 324
 325
 326 typedef void* WMagicNumber;
 327
 328
 329
 330 void wWindowDestroy(WWindow *wwin);
 331 WWindow *wWindowCreate();
 332
 333 #ifdef SHAPE
 334 void wWindowSetShape(WWindow *wwin);
 335 void wWindowClearShape(WWindow *wwin);
 336 #endif
 337
 338 WWindow *wManageWindow(WScreen *scr, Window window);
 339
 340 void wUnmanageWindow(WWindow *wwin, Bool restore, Bool destroyed);
 341
 342 void wWindowFocus(WWindow *wwin, WWindow *owin);
 343 void wWindowUnfocus(WWindow *wwin);
 344 void wWindowConstrainSize(WWindow *wwin, int *nwidth, int *nheight);
 345 void wWindowConfigure(WWindow *wwin, int req_x, int req_y,
 346                       int req_width, int req_height);
 347
 348 void wWindowMove(WWindow *wwin, int req_x, int req_y);
 349
 350 void wWindowSynthConfigureNotify(WWindow *wwin);
 351
 352 WWindow *wWindowFor(Window window);
 353
 354
 355 void wWindowConfigureBorders(WWindow *wwin);
 356
 357 void wWindowUpdateButtonImages(WWindow *wwin);
 358
 359 void wWindowSaveState(WWindow *wwin);
 360
 361 void wWindowChangeWorkspace(WWindow *wwin, int workspace);
 362
 363 void wWindowSetKeyGrabs(WWindow *wwin);
 364
 365 void wWindowResetMouseGrabs(WWindow *wwin);
 366
 367 WWindow *wManageInternalWindow(WScreen *scr, Window window, Window owner,
 368                                char *title, int x, int y,
 369                                int width, int height);
 370
 371 void wWindowSetupInitialAttributes(WWindow *wwin, int *level, int *workspace);
 372
 373 void wWindowUpdateGNUstepAttr(WWindow *wwin, GNUstepWMAttributes *attr);
 374
 375 void wWindowMap(WWindow *wwin);
 376
 377 void wWindowUnmap(WWindow *wwin);
 378
 379 Bool wWindowCanReceiveFocus(WWindow *wwin);
 380
 381 void wWindowDeleteSavedStatesForPID(pid_t pid);
 382
 383 WMagicNumber wWindowAddSavedState(char *instance, char *class, char *command,
 384                                   pid_t pid, WSavedState *state);
 385
 386 WMagicNumber wWindowGetSavedState(Window win);
 387
 388 void wWindowDeleteSavedState(WMagicNumber id);
 389
 390 Bool wWindowObscuresWindow(WWindow *wwin, WWindow *obscured);
 391
 392 #endif