client.h

   1 /*
   2  * client.h - client management header
   3  *
   4  * Copyright © 2007-2008 Julien Danjou <julien@danjou.info>
   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 along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19  *
  20  */
  21
  22 #ifndef AWESOME_CLIENT_H
  23 #define AWESOME_CLIENT_H
  24
  25 #include "mouse.h"
  26 #include "stack.h"
  27
  28 #define CLIENT_SELECT_INPUT_EVENT_MASK (XCB_EVENT_MASK_STRUCTURE_NOTIFY \
  29                                         | XCB_EVENT_MASK_PROPERTY_CHANGE \
  30                                         | XCB_EVENT_MASK_ENTER_WINDOW \
  31                                         | XCB_EVENT_MASK_LEAVE_WINDOW \
  32                                         | XCB_EVENT_MASK_FOCUS_CHANGE)
  33
  34 /** Windows type */
  35 typedef enum
  36 {
  37     WINDOW_TYPE_NORMAL = 0,
  38     WINDOW_TYPE_DESKTOP,
  39     WINDOW_TYPE_DOCK,
  40     WINDOW_TYPE_SPLASH,
  41     WINDOW_TYPE_DIALOG,
  42     /* The ones below may have TRANSIENT_FOR, but are not plain dialogs.
  43      * They were purposefully placed below DIALOG.
  44      */
  45     WINDOW_TYPE_MENU,
  46     WINDOW_TYPE_TOOLBAR,
  47     WINDOW_TYPE_UTILITY,
  48     /* This ones are usually set on override-redirect windows. */
  49     WINDOW_TYPE_DROPDOWN_MENU,
  50     WINDOW_TYPE_POPUP_MENU,
  51     WINDOW_TYPE_TOOLTIP,
  52     WINDOW_TYPE_NOTIFICATION,
  53     WINDOW_TYPE_COMBO,
  54     WINDOW_TYPE_DND
  55 } window_type_t;
  56
  57 /* Strut */
  58 typedef struct
  59 {
  60     uint16_t left, right, top, bottom;
  61     uint16_t left_start_y, left_end_y;
  62     uint16_t right_start_y, right_end_y;
  63     uint16_t top_start_x, top_end_x;
  64     uint16_t bottom_start_x, bottom_end_x;
  65 } strut_t;
  66
  67 /** client_t type */
  68 struct client_t
  69 {
  70     /** Lua reference counter */
  71     luaA_ref_array_t refs;
  72     /** Valid, or not ? */
  73     bool invalid;
  74     /** Client name */
  75     char *name, *icon_name;
  76     /** WM_CLASS stuff */
  77     char *class, *instance;
  78     /** Startup ID */
  79     char *startup_id;
  80     /** Window geometry */
  81     area_t geometry;
  82     struct
  83     {
  84         /** Client geometry when (un)fullscreen */
  85         area_t fullscreen;
  86         /** Client geometry when (un)-max */
  87         area_t max;
  88         /** Internal geometry (matching X11 protocol) */
  89         area_t internal;
  90     } geometries;
  91     /** Strut */
  92     strut_t strut;
  93     /** Border width and pre-fullscreen border width */
  94     int border, border_fs;
  95     xcolor_t border_color;
  96     /** True if the client is sticky */
  97     bool issticky;
  98     /** Has urgency hint */
  99     bool isurgent;
 100     /** True if the client is hidden */
 101     bool ishidden;
 102     /** True if the client is minimized */
 103     bool isminimized;
 104     /** True if the client is fullscreen */
 105     bool isfullscreen;
 106     /** True if the client is maximized horizontally */
 107     bool ismaxhoriz;
 108     /** True if the client is maximized vertically */
 109     bool ismaxvert;
 110     /** True if the client is above others */
 111     bool isabove;
 112     /** True if the client is below others */
 113     bool isbelow;
 114     /** True if the client is modal */
 115     bool ismodal;
 116     /** True if the client is on top */
 117     bool isontop;
 118     /** True if a client is banned to a position outside the viewport.
 119      * Note that the geometry remains unchanged and that the window is still mapped.
 120      */
 121     bool isbanned;
 122     /** true if the client must be skipped from task bar client list */
 123     bool skiptb;
 124     /** True if the client cannot have focus */
 125     bool nofocus;
 126     /** The window type */
 127     window_type_t type;
 128     /** Window of the client */
 129     xcb_window_t win;
 130     /** Window of the group leader */
 131     xcb_window_t group_win;
 132     /** Window holding command needed to start it (session management related) */
 133     xcb_window_t leader_win;
 134     /** Client logical screen */
 135     screen_t *screen;
 136     /** Client physical screen */
 137     int phys_screen;
 138     /** Titlebar */
 139     wibox_t *titlebar;
 140     /** Button bindings */
 141     button_array_t buttons;
 142     /** Key bindings */
 143     key_array_t keys;
 144     /** Icon */
 145     image_t *icon;
 146     /** Size hints */
 147     xcb_size_hints_t size_hints;
 148     bool size_hints_honor;
 149     /** Window it is transient for */
 150     client_t *transient_for;
 151 };
 152
 153 client_t * luaA_client_checkudata(lua_State *, int);
 154
 155 ARRAY_FUNCS(client_t *, client, DO_NOTHING)
 156 LUA_OBJECT_FUNCS(client_t, client, "client")
 157
 158 #define client_need_arrange(c) \
 159     do { \
 160         if(!c->screen->need_arrange \
 161            && client_isvisible(c, (c)->screen)) \
 162             c->screen->need_arrange = true; \
 163     } while(0)
 164
 165 bool client_maybevisible(client_t *, screen_t *);
 166 client_t * client_getbywin(xcb_window_t);
 167 void client_ban(client_t *);
 168 void client_unban(client_t *);
 169 void client_manage(xcb_window_t, xcb_get_geometry_reply_t *, int, bool);
 170 area_t client_geometry_hints(client_t *, area_t);
 171 bool client_resize(client_t *, area_t, bool);
 172 void client_unmanage(client_t *);
 173 void client_kill(client_t *);
 174 void client_setsticky(client_t *, bool);
 175 void client_setabove(client_t *, bool);
 176 void client_setbelow(client_t *, bool);
 177 void client_setmodal(client_t *, bool);
 178 void client_setontop(client_t *, bool);
 179 void client_setfullscreen(client_t *, bool);
 180 void client_setmaxhoriz(client_t *, bool);
 181 void client_setmaxvert(client_t *, bool);
 182 void client_setminimized(client_t *, bool);
 183 void client_setborder(client_t *, int);
 184 void client_seturgent(client_t *, bool);
 185 void client_focus(client_t *);
 186 void client_focus_update(client_t *);
 187 void client_unfocus(client_t *);
 188 void client_unfocus_update(client_t *);
 189 void client_stack_refresh(void);
 190
 191 static inline void
 192 client_stack(void)
 193 {
 194     globalconf.client_need_stack_refresh = true;
 195 }
 196
 197 /** Put client on top of the stack.
 198  * \param c The client to raise.
 199  */
 200 static inline void
 201 client_raise(client_t *c)
 202 {
 203     client_t *tc = c;
 204     int counter = 0;
 205
 206     /* Find number of transient layers. */
 207     for(counter = 0; tc->transient_for; counter++)
 208         tc = tc->transient_for;
 209
 210     /* Push them in reverse order. */
 211     for(; counter > 0; counter--)
 212     {
 213         tc = c;
 214         for(int i = 0; i < counter; i++)
 215             tc = tc->transient_for;
 216         stack_client_append(tc);
 217     }
 218
 219     /* Push c on top of the stack. */
 220     stack_client_append(c);
 221     client_stack();
 222 }
 223
 224 /** Put client on the end of the stack.
 225  * \param c The client to lower.
 226  */
 227 static inline void
 228 client_lower(client_t *c)
 229 {
 230     stack_client_push(c);
 231
 232     /* Traverse all transient layers. */
 233     for(client_t *tc = c->transient_for; tc; tc = tc->transient_for)
 234         stack_client_push(tc);
 235
 236     client_stack();
 237 }
 238
 239 /** Check if a client has fixed size.
 240  * \param c A client.
 241  * \return A boolean value, true if the client has a fixed size.
 242  */
 243 static inline bool
 244 client_isfixed(client_t *c)
 245 {
 246     return (c->size_hints.flags & XCB_SIZE_HINT_P_MAX_SIZE
 247             && c->size_hints.flags & XCB_SIZE_HINT_P_MIN_SIZE
 248             && c->size_hints.max_width == c->size_hints.min_width
 249             && c->size_hints.max_height == c->size_hints.min_height
 250             && c->size_hints.max_width
 251             && c->size_hints.max_height);
 252 }
 253
 254 /** Returns true if a client is tagged with one of the tags of the
 255  * specified screen and is not hidden. Note that "banned" clients are included.
 256  * \param c The client to check.
 257  * \param screen Virtual screen number.
 258  * \return true if the client is visible, false otherwise.
 259  */
 260 static inline bool
 261 client_isvisible(client_t *c, screen_t *screen)
 262 {
 263     return (!c->ishidden && !c->isminimized && client_maybevisible(c, screen));
 264 }
 265
 266 /** Check if a client has strut information.
 267  * \param c A client.
 268  * \return A boolean value, true if the client has strut information.
 269  */
 270 static inline bool
 271 client_hasstrut(client_t *c)
 272 {
 273     return (c->strut.left
 274             || c->strut.right
 275             || c->strut.top
 276             || c->strut.bottom
 277             || c->strut.left_start_y
 278             || c->strut.left_end_y
 279             || c->strut.right_start_y
 280             || c->strut.right_end_y
 281             || c->strut.top_start_x
 282             || c->strut.top_end_x
 283             || c->strut.bottom_start_x
 284             || c->strut.bottom_end_x);
 285 }
 286
 287 #endif
 288 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80