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