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 #ifdef MWM_HINTS
  30 # include "motif.h"
  31 #endif
  32 #include "texture.h"
  33 #include "menu.h"
  34 #include "application.h"
  35
  36 /* not defined in my X11 headers */
  37 #ifndef UrgencyHint
  38 #define UrgencyHint (1L << 8)
  39 #endif
  40
  41
  42 #define BORDER_TOP      1
  43 #define BORDER_BOTTOM   2
  44 #define BORDER_LEFT     4
  45 #define BORDER_RIGHT    8
  46 #define BORDER_ALL      (1|2|4|8)
  47
  48
  49 #define CLIENT_EVENTS (StructureNotifyMask | PropertyChangeMask\
  50         | EnterWindowMask | LeaveWindowMask | ColormapChangeMask \
  51         | FocusChangeMask)
  52
  53 typedef enum {
  54     WFM_PASSIVE, WFM_NO_INPUT, WFM_LOCALLY_ACTIVE, WFM_GLOBALLY_ACTIVE
  55 } FocusMode;
  56
  57
  58 /*
  59  * window attribute flags.
  60  *
  61  * Note: attributes that should apply to the application as a
  62  * whole should only access the flags from the app->main_window_desc->window_flags
  63  * This is to make sure that the application doesn't have many different
  64  * values for the same option. For example, imagine xfoo, which has
  65  * foo.bar as leader and it a child window named foo.baz. If you set
  66  * StartHidden YES for foo.bar and NO for foo.baz we must *always* guarantee
  67  * that the value that will be used will be that of the leader foo.bar.
  68  * The attributes inspector must always save application wide options
  69  * in the name of the leader window, not the child.
  70  */
  71 /*
  72  * All flags must have their default values = 0
  73  */
  74 typedef struct {
  75     /* OpenStep */
  76     unsigned int no_titlebar:1;        /* draw titlebar? */
  77     unsigned int no_resizable:1;
  78     unsigned int no_closable:1;
  79     unsigned int no_miniaturizable:1;
  80
  81     /* decorations */
  82     unsigned int no_resizebar:1;       /* draw the bottom handle? */
  83     unsigned int no_close_button:1;    /* draw a close button? */
  84     unsigned int no_miniaturize_button:1; /* draw an iconify button? */
  85
  86     unsigned int broken_close:1;       /* is the close button broken? */
  87
  88     /* ours */
  89     unsigned int kill_close:1;         /* can't send WM_DELETE_WINDOW */
  90
  91     unsigned int no_shadeable:1;
  92     unsigned int omnipresent:1;
  93     unsigned int skip_window_list:1;
  94     unsigned int floating:1;           /* put in NSFloatingWindowLevel */
  95     unsigned int no_bind_keys:1;       /* intercept wm kbd binds
  96                                         * while window is focused */
  97     unsigned int no_bind_mouse:1;      /* intercept mouse events
  98                                         * on client area while window
  99                                         * is focused */
 100     unsigned int no_hide_others:1;     /* hide window when doing hideothers */
 101     unsigned int no_appicon:1;         /* make app icon */
 102
 103     unsigned int dont_move_off:1;
 104
 105     unsigned int no_focusable:1;
 106
 107     unsigned int always_user_icon:1;   /* ignore client IconPixmap or
 108                                         * IconWindow */
 109
 110     unsigned int start_miniaturized:1;
 111     unsigned int start_hidden:1;
 112     unsigned int dont_save_session:1;  /* do not save app's state in session */
 113
 114     /*
 115      * emulate_app_icon must be automatically disabled for apps that can
 116      * generate their own appicons and for apps that have no_appicon=1
 117      */
 118     unsigned int emulate_appicon:1;
 119 } WWindowAttributes;
 120
 121 /*
 122  * Window manager protocols that both the client as we understand.
 123  */
 124 typedef struct {
 125     unsigned int TAKE_FOCUS:1;
 126     unsigned int SAVE_YOURSELF:1;
 127     unsigned int DELETE_WINDOW:1;
 128
 129     /* WindowMaker specific */
 130     unsigned int MINIATURIZE_WINDOW:1;
 131 #ifdef MONITOR_HEARTBEAT
 132     unsigned int HEARTBEAT:1;
 133 #endif
 134 } WProtocols;
 135
 136
 137 /*
 138  * Stores client window information. Each client window has it's
 139  * structure created when it's being first mapped.
 140  */
 141 typedef struct WWindow {
 142     struct WWindow *prev;              /* window focus list */
 143     struct WWindow *next;
 144
 145     WScreen *screen_ptr;               /* pointer to the screen structure */
 146     WWindowAttributes window_flags;    /* window attribute flags */
 147     struct InspectorPanel *inspector;  /*  pointer to attribute editor panel */
 148
 149     struct WFrameWindow *frame;        /* the frame window */
 150     int frame_x, frame_y;              /* position of the frame in root*/
 151
 152     struct {
 153         int x, y;
 154         unsigned int width, height;    /* original geometry of the window */
 155     } old_geometry;                    /* (before things like maximize) */
 156
 157     /* client window info */
 158     short old_border_width;            /* original border width of client_win*/
 159     Window client_win;                 /* the window we're managing */
 160     WObjDescriptor client_descriptor; /* dummy descriptor for client */
 161     struct {
 162         int x, y;                      /* position of *client* relative
 163                                         * to root */
 164         unsigned int width, height;    /* size of the client window */
 165     } client;
 166
 167     XSizeHints *normal_hints;          /* WM_NORMAL_HINTS */
 168     XWMHints *wm_hints;                /* WM_HINTS (optional) */
 169     char *wm_instance;                 /* instance of WM_CLASS */
 170     char *wm_class;                    /* class of WM_CLASS */
 171     GNUstepWMAttributes *wm_gnustep_attr;/* GNUstep window attributes */
 172
 173     int state;                         /* state as in ICCCM */
 174
 175     Window transient_for;              /* WM_TRANSIENT_FOR */
 176     Window group_id;                   /* the leader window of the group */
 177     Window client_leader;              /* WM_CLIENT_LEADER if not
 178                                         internal_window */
 179
 180     Window main_window;                /* main window for the application */
 181
 182     int cmap_window_no;
 183     Window *cmap_windows;
 184
 185     /* protocols */
 186     WProtocols protocols;              /* accepted WM_PROTOCOLS */
 187
 188     FocusMode focus_mode;              /* type of keyboard input focus */
 189
 190 #ifdef KEEP_XKB_LOCK_STATUS
 191     int languagemode;
 192 #endif /* KEEP_XKB_LOCK_STATUS */
 193
 194 #ifdef MONITOR_HEARTBEAT
 195     time_t last_beat;
 196 #endif
 197     struct {
 198         /* state flags */
 199         unsigned int mapped:1;
 200         unsigned int focused:1;
 201         unsigned int miniaturized:1;
 202         unsigned int hidden:1;
 203         unsigned int shaded:1;
 204         unsigned int maximized:2;
 205
 206         unsigned int semi_focused:1;
 207         /* window type flags */
 208         unsigned int urgent:1;         /* if wm_hints says this is urgent */
 209 #ifdef SHAPE
 210         unsigned int shaped:1;
 211 #endif
 212
 213         /* info flags */
 214         unsigned int buttons_dont_fit:1;
 215         unsigned int rebuild_texture:1;/* the window was resized and
 216                                         * gradients should be re-rendered */
 217         unsigned int needs_full_repaint:1;/* does a full repaint of the
 218                                            * window next time it's painted */
 219         unsigned int icon_moved:1;     /* icon for this window was moved
 220                                         * by the user */
 221         unsigned int ignore_next_unmap:1;
 222         unsigned int selected:1;       /* multiple window selection */
 223         unsigned int skip_next_animation:1;
 224         unsigned int internal_window:1;
 225         unsigned int changing_workspace:1;
 226
 227         unsigned int inspector_open:1; /* attrib inspector is already open */
 228
 229         unsigned int destroyed:1;      /* window was already destroyed */
 230
 231         unsigned int menu_open_for_me:1;   /* window commands menu */
 232     } flags;            /* state of the window */
 233
 234     struct WIcon *icon;                /* icon info for the window */
 235     int icon_x, icon_y;                /* position of the icon */
 236 } WWindow;
 237
 238
 239 /*
 240  * Changes to this must update wWindowSaveState/getSavedState
 241  *
 242  */
 243 typedef struct WSavedState {
 244     int workspace;
 245     int miniaturized;
 246     int shaded;
 247     int hidden;
 248     int use_geometry;
 249     int x;
 250     int y;
 251     unsigned int w;
 252     unsigned int h;
 253 } WSavedState;
 254
 255
 256 typedef struct WWindowState {
 257     char *instance;
 258     char *class;
 259     char *command;
 260     pid_t pid;
 261     WSavedState *state;
 262     struct WWindowState *next;
 263 } WWindowState;
 264
 265
 266 typedef void* WMagicNumber;
 267
 268
 269
 270 void wWindowDestroy(WWindow *wwin);
 271 WWindow *wWindowCreate();
 272
 273 #ifdef SHAPE
 274 void wWindowSetShape(WWindow *wwin);
 275 void wWindowClearShape(WWindow *wwin);
 276 #endif
 277
 278 WWindow *wManageWindow(WScreen *scr, Window window);
 279
 280 void wUnmanageWindow(WWindow *wwin, int restore);
 281
 282 void wWindowFocus(WWindow *wwin);
 283 void wWindowUnfocus(WWindow *wwin);
 284 void wWindowConstrainSize(WWindow *wwin, int *nwidth, int *nheight);
 285 void wWindowConfigure(WWindow *wwin, int req_x, int req_y,
 286                       int req_width, int req_height);
 287
 288 void wWindowMove(WWindow *wwin, int req_x, int req_y);
 289
 290 void wWindowSynthConfigureNotify(WWindow *wwin);
 291
 292 WWindow *wWindowFor(Window window);
 293
 294
 295 void wWindowConfigureBorders(WWindow *wwin);
 296
 297 void wWindowUpdateButtonImages(WWindow *wwin);
 298
 299 void wWindowSaveState(WWindow *wwin);
 300
 301 void wWindowChangeWorkspace(WWindow *wwin, int workspace);
 302
 303 void wWindowSetKeyGrabs(WWindow *wwin);
 304
 305 void wWindowResetMouseGrabs(WWindow *wwin);
 306
 307 WWindow *wManageInternalWindow(WScreen *scr, Window window, Window owner,
 308                                char *title, int x, int y,
 309                                int width, int height);
 310
 311 void wWindowCheckAttributeSanity(WWindow *wwin, WWindowAttributes *flags);
 312
 313 void wWindowUpdateGNUstepAttr(WWindow *wwin, GNUstepWMAttributes *attr);
 314
 315 void wWindowMap(WWindow *wwin);
 316
 317 Bool wWindowCanReceiveFocus(WWindow *wwin);
 318
 319 void wWindowDeleteSavedStatesForPID(pid_t pid);
 320
 321 WMagicNumber wWindowAddSavedState(char *instance, char *class, char *command,
 322                                   pid_t pid, WSavedState *state);
 323
 324 WMagicNumber wWindowGetSavedState(Window win);
 325
 326 void wWindowDeleteSavedState(WMagicNumber id);
 327
 328
 329 #endif