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)
  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 } WWindowAttributes;
 136
 137
 138
 139 /*
 140  * Window manager protocols that both the client as we understand.
 141  */
 142 typedef struct {
 143     unsigned int TAKE_FOCUS:1;
 144     unsigned int SAVE_YOURSELF:1;
 145     unsigned int DELETE_WINDOW:1;
 146
 147     /* WindowMaker specific */
 148     unsigned int MINIATURIZE_WINDOW:1;
 149 #ifdef MONITOR_HEARTBEAT
 150     unsigned int HEARTBEAT:1;
 151 #endif
 152 } WProtocols;
 153
 154
 155 /*
 156  * Stores client window information. Each client window has it's
 157  * structure created when it's being first mapped.
 158  */
 159 typedef struct WWindow {
 160     struct WWindow *prev;              /* window focus list */
 161     struct WWindow *next;
 162
 163     WScreen *screen_ptr;               /* pointer to the screen structure */
 164     WWindowAttributes user_flags;      /* window attribute flags set by user */
 165     WWindowAttributes defined_user_flags;/* mask for user_flags */
 166     WWindowAttributes client_flags;    /* window attribute flags set by app
 167                                         * initialized with global defaults */
 168
 169     struct InspectorPanel *inspector;  /*  pointer to attribute editor panel */
 170
 171     struct WFrameWindow *frame;        /* the frame window */
 172     int frame_x, frame_y;              /* position of the frame in root*/
 173
 174     struct {
 175         int x, y;
 176         unsigned int width, height;    /* original geometry of the window */
 177     } old_geometry;                    /* (before things like maximize) */
 178
 179     /* client window info */
 180     short old_border_width;            /* original border width of client_win*/
 181     Window client_win;                 /* the window we're managing */
 182     WObjDescriptor client_descriptor; /* dummy descriptor for client */
 183     struct {
 184         int x, y;                      /* position of *client* relative
 185                                         * to root */
 186         unsigned int width, height;    /* size of the client window */
 187     } client;
 188
 189     XSizeHints *normal_hints;          /* WM_NORMAL_HINTS */
 190     XWMHints *wm_hints;                /* WM_HINTS (optional) */
 191     char *wm_instance;                 /* instance of WM_CLASS */
 192     char *wm_class;                    /* class of WM_CLASS */
 193     GNUstepWMAttributes *wm_gnustep_attr;/* GNUstep window attributes */
 194
 195     int state;                         /* state as in ICCCM */
 196
 197     Window transient_for;              /* WM_TRANSIENT_FOR */
 198     Window group_id;                   /* the leader window of the group */
 199     Window client_leader;              /* WM_CLIENT_LEADER if not
 200                                         internal_window */
 201
 202     Window main_window;                /* main window for the application */
 203
 204     int cmap_window_no;
 205     Window *cmap_windows;
 206
 207     /* protocols */
 208     WProtocols protocols;              /* accepted WM_PROTOCOLS */
 209
 210     FocusMode focus_mode;              /* type of keyboard input focus */
 211
 212 #ifdef KEEP_XKB_LOCK_STATUS
 213     int languagemode;
 214 #endif /* KEEP_XKB_LOCK_STATUS */
 215
 216 #ifdef MONITOR_HEARTBEAT
 217     time_t last_beat;
 218 #endif
 219     struct {
 220         /* state flags */
 221         unsigned int mapped:1;
 222         unsigned int focused:1;
 223         unsigned int miniaturized:1;
 224         unsigned int hidden:1;
 225         unsigned int shaded:1;
 226         unsigned int maximized:2;
 227         unsigned int omnipresent:1;
 228
 229         unsigned int semi_focused:1;
 230         /* window type flags */
 231         unsigned int urgent:1;         /* if wm_hints says this is urgent */
 232 #ifdef SHAPE
 233         unsigned int shaped:1;
 234 #endif
 235
 236         /* info flags */
 237         unsigned int buttons_dont_fit:1;
 238         unsigned int rebuild_texture:1;/* the window was resized and
 239                                         * gradients should be re-rendered */
 240         unsigned int needs_full_repaint:1;/* does a full repaint of the
 241                                            * window next time it's painted */
 242         unsigned int icon_moved:1;     /* icon for this window was moved
 243                                         * by the user */
 244         unsigned int ignore_next_unmap:1;
 245         unsigned int selected:1;       /* multiple window selection */
 246         unsigned int skip_next_animation:1;
 247         unsigned int internal_window:1;
 248         unsigned int changing_workspace:1;
 249
 250         unsigned int inspector_open:1; /* attrib inspector is already open */
 251
 252         unsigned int destroyed:1;      /* window was already destroyed */
 253
 254         unsigned int menu_open_for_me:1;   /* window commands menu */
 255
 256 #ifdef KWM_HINTS
 257         unsigned int kwm_hidden_for_modules:1;
 258 #endif
 259 #ifdef OLWM_HINTS
 260         unsigned int olwm_push_pin:1;      /* emulate pushpin behaviour */
 261         unsigned int olwm_limit_menu:1;
 262 #endif
 263     } flags;            /* state of the window */
 264
 265     struct WIcon *icon;                /* icon info for the window */
 266     int icon_x, icon_y;                /* position of the icon */
 267 } WWindow;
 268
 269
 270 #define IS_OMNIPRESENT(w) ((w)->flags.omnipresent ^ WFLAGP(w, omnipresent))
 271
 272 #define WINDOW_LEVEL(w) ((w)->frame->core->stacking->window_level)
 273
 274
 275
 276 /*
 277  * Changes to this must update wWindowSaveState/getSavedState
 278  *
 279  */
 280 typedef struct WSavedState {
 281     int workspace;
 282     int miniaturized;
 283     int shaded;
 284     int hidden;
 285     int use_geometry;
 286     int x;
 287     int y;
 288     unsigned int w;
 289     unsigned int h;
 290 } WSavedState;
 291
 292
 293 typedef struct WWindowState {
 294     char *instance;
 295     char *class;
 296     char *command;
 297     pid_t pid;
 298     WSavedState *state;
 299     struct WWindowState *next;
 300 } WWindowState;
 301
 302
 303 typedef void* WMagicNumber;
 304
 305
 306
 307 void wWindowDestroy(WWindow *wwin);
 308 WWindow *wWindowCreate();
 309
 310 #ifdef SHAPE
 311 void wWindowSetShape(WWindow *wwin);
 312 void wWindowClearShape(WWindow *wwin);
 313 #endif
 314
 315 WWindow *wManageWindow(WScreen *scr, Window window);
 316
 317 void wUnmanageWindow(WWindow *wwin, int restore);
 318
 319 void wWindowFocus(WWindow *wwin);
 320 void wWindowUnfocus(WWindow *wwin);
 321 void wWindowConstrainSize(WWindow *wwin, int *nwidth, int *nheight);
 322 void wWindowConfigure(WWindow *wwin, int req_x, int req_y,
 323                       int req_width, int req_height);
 324
 325 void wWindowMove(WWindow *wwin, int req_x, int req_y);
 326
 327 void wWindowSynthConfigureNotify(WWindow *wwin);
 328
 329 WWindow *wWindowFor(Window window);
 330
 331
 332 void wWindowConfigureBorders(WWindow *wwin);
 333
 334 void wWindowUpdateButtonImages(WWindow *wwin);
 335
 336 void wWindowSaveState(WWindow *wwin);
 337
 338 void wWindowChangeWorkspace(WWindow *wwin, int workspace);
 339
 340 void wWindowSetKeyGrabs(WWindow *wwin);
 341
 342 void wWindowResetMouseGrabs(WWindow *wwin);
 343
 344 WWindow *wManageInternalWindow(WScreen *scr, Window window, Window owner,
 345                                char *title, int x, int y,
 346                                int width, int height);
 347
 348 void wWindowSetupInitialAttributes(WWindow *wwin, int *level, int *workspace);
 349
 350 void wWindowUpdateGNUstepAttr(WWindow *wwin, GNUstepWMAttributes *attr);
 351
 352 void wWindowMap(WWindow *wwin);
 353
 354 Bool wWindowCanReceiveFocus(WWindow *wwin);
 355
 356 void wWindowDeleteSavedStatesForPID(pid_t pid);
 357
 358 WMagicNumber wWindowAddSavedState(char *instance, char *class, char *command,
 359                                   pid_t pid, WSavedState *state);
 360
 361 WMagicNumber wWindowGetSavedState(Window win);
 362
 363 void wWindowDeleteSavedState(WMagicNumber id);
 364
 365 Bool wWindowObscuresWindow(WWindow *wwin, WWindow *obscured);
 366
 367 #endif