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     /*
 131      * emulate_app_icon must be automatically disabled for apps that can
 132      * generate their own appicons and for apps that have no_appicon=1
 133      */
 134     unsigned int emulate_appicon:1;
 135
 136     /* toolkit specific attribute flags. These are unchangeable and
 137      * unconfigurable and must not be saved as state. */
 138 #ifdef OLWM_HINTS
 139     unsigned int olwm_transient:1;
 140     unsigned int olwm_warp_to_pin:1;
 141 #endif
 142
 143 } WWindowAttributes;
 144
 145
 146
 147 /*
 148  * Window manager protocols that both the client as we understand.
 149  */
 150 typedef struct {
 151     unsigned int TAKE_FOCUS:1;
 152     unsigned int DELETE_WINDOW:1;
 153     unsigned int SAVE_YOURSELF:1;
 154     /* WindowMaker specific */
 155     unsigned int MINIATURIZE_WINDOW:1;
 156 #ifdef MONITOR_HEARTBEAT
 157     unsigned int HEARTBEAT:1;
 158 #endif
 159 } WProtocols;
 160
 161
 162 /*
 163  * Stores client window information. Each client window has it's
 164  * structure created when it's being first mapped.
 165  */
 166 typedef struct WWindow {
 167     struct WWindow *prev;              /* window focus list */
 168     struct WWindow *next;
 169
 170     WScreen *screen_ptr;               /* pointer to the screen structure */
 171     WWindowAttributes user_flags;      /* window attribute flags set by user */
 172     WWindowAttributes defined_user_flags;/* mask for user_flags */
 173     WWindowAttributes client_flags;    /* window attribute flags set by app
 174                                         * initialized with global defaults */
 175
 176     struct InspectorPanel *inspector;  /*  pointer to attribute editor panel */
 177
 178     struct WFrameWindow *frame;        /* the frame window */
 179     int frame_x, frame_y;              /* position of the frame in root*/
 180
 181     struct {
 182         int x, y;
 183         unsigned int width, height;    /* original geometry of the window */
 184     } old_geometry;                    /* (before things like maximize) */
 185
 186     /* client window info */
 187     short old_border_width;            /* original border width of client_win*/
 188     Window client_win;                 /* the window we're managing */
 189     WObjDescriptor client_descriptor; /* dummy descriptor for client */
 190     struct {
 191         int x, y;                      /* position of *client* relative
 192                                         * to root */
 193         unsigned int width, height;    /* size of the client window */
 194     } client;
 195
 196     XSizeHints *normal_hints;          /* WM_NORMAL_HINTS */
 197     XWMHints *wm_hints;                /* WM_HINTS (optional) */
 198     char *wm_instance;                 /* instance of WM_CLASS */
 199     char *wm_class;                    /* class of WM_CLASS */
 200     GNUstepWMAttributes *wm_gnustep_attr;/* GNUstep window attributes */
 201
 202     int state;                         /* state as in ICCCM */
 203
 204     Window transient_for;              /* WM_TRANSIENT_FOR */
 205     Window group_id;                   /* the leader window of the group */
 206     Window client_leader;              /* WM_CLIENT_LEADER if not
 207                                         internal_window */
 208
 209     Window main_window;                /* main window for the application */
 210
 211     int cmap_window_no;
 212     Window *cmap_windows;
 213
 214     /* protocols */
 215     WProtocols protocols;              /* accepted WM_PROTOCOLS */
 216
 217     FocusMode focus_mode;              /* type of keyboard input focus */
 218
 219 #ifdef KEEP_XKB_LOCK_STATUS
 220     int languagemode;
 221 #endif /* KEEP_XKB_LOCK_STATUS */
 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 #ifdef KWM_HINTS
 272         unsigned int kwm_hidden_for_modules:1;
 273 #endif
 274 #ifdef OLWM_HINTS
 275         unsigned int olwm_push_pin_out:1;/* emulate pushpin behaviour */
 276         unsigned int olwm_limit_menu:1;
 277 #endif
 278     } flags;            /* state of the window */
 279
 280     struct WIcon *icon;                /* icon info for the window */
 281     int icon_x, icon_y;                /* position of the icon */
 282 } WWindow;
 283
 284
 285 #define IS_OMNIPRESENT(w) ((w)->flags.omnipresent ^ WFLAGP(w, omnipresent))
 286
 287 #define WINDOW_LEVEL(w) ((w)->frame->core->stacking->window_level)
 288
 289
 290
 291 /*
 292  * Changes to this must update wWindowSaveState/getSavedState
 293  *
 294  */
 295 typedef struct WSavedState {
 296     int workspace;
 297     int miniaturized;
 298     int shaded;
 299     int hidden;
 300     int use_geometry;
 301     int x;
 302     int y;
 303     unsigned int w;
 304     unsigned int h;
 305 } WSavedState;
 306
 307
 308 typedef struct WWindowState {
 309     char *instance;
 310     char *class;
 311     char *command;
 312     pid_t pid;
 313     WSavedState *state;
 314     struct WWindowState *next;
 315 } WWindowState;
 316
 317
 318 typedef void* WMagicNumber;
 319
 320
 321
 322 void wWindowDestroy(WWindow *wwin);
 323 WWindow *wWindowCreate();
 324
 325 #ifdef SHAPE
 326 void wWindowSetShape(WWindow *wwin);
 327 void wWindowClearShape(WWindow *wwin);
 328 #endif
 329
 330 WWindow *wManageWindow(WScreen *scr, Window window);
 331
 332 void wUnmanageWindow(WWindow *wwin, Bool restore, Bool destroyed);
 333
 334 void wWindowFocus(WWindow *wwin, WWindow *owin);
 335 void wWindowUnfocus(WWindow *wwin);
 336 void wWindowConstrainSize(WWindow *wwin, int *nwidth, int *nheight);
 337 void wWindowConfigure(WWindow *wwin, int req_x, int req_y,
 338                       int req_width, int req_height);
 339
 340 void wWindowMove(WWindow *wwin, int req_x, int req_y);
 341
 342 void wWindowSynthConfigureNotify(WWindow *wwin);
 343
 344 WWindow *wWindowFor(Window window);
 345
 346
 347 void wWindowConfigureBorders(WWindow *wwin);
 348
 349 void wWindowUpdateButtonImages(WWindow *wwin);
 350
 351 void wWindowSaveState(WWindow *wwin);
 352
 353 void wWindowChangeWorkspace(WWindow *wwin, int workspace);
 354
 355 void wWindowSetKeyGrabs(WWindow *wwin);
 356
 357 void wWindowResetMouseGrabs(WWindow *wwin);
 358
 359 WWindow *wManageInternalWindow(WScreen *scr, Window window, Window owner,
 360                                char *title, int x, int y,
 361                                int width, int height);
 362
 363 void wWindowSetupInitialAttributes(WWindow *wwin, int *level, int *workspace);
 364
 365 void wWindowUpdateGNUstepAttr(WWindow *wwin, GNUstepWMAttributes *attr);
 366
 367 void wWindowMap(WWindow *wwin);
 368
 369 void wWindowUnmap(WWindow *wwin);
 370
 371 Bool wWindowCanReceiveFocus(WWindow *wwin);
 372
 373 void wWindowDeleteSavedStatesForPID(pid_t pid);
 374
 375 WMagicNumber wWindowAddSavedState(char *instance, char *class, char *command,
 376                                   pid_t pid, WSavedState *state);
 377
 378 WMagicNumber wWindowGetSavedState(Window win);
 379
 380 void wWindowDeleteSavedState(WMagicNumber id);
 381
 382 Bool wWindowObscuresWindow(WWindow *wwin, WWindow *obscured);
 383
 384 #endif