client.h

   1 /*
   2  * client.h - client management header
   3  *
   4  * Copyright © 2007-2009 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 #include "strut.h"
  28 #include "common/luaobject.h"
  29
  30 #define CLIENT_SELECT_INPUT_EVENT_MASK (XCB_EVENT_MASK_STRUCTURE_NOTIFY \
  31                                         | XCB_EVENT_MASK_PROPERTY_CHANGE \
  32                                         | XCB_EVENT_MASK_ENTER_WINDOW \
  33                                         | XCB_EVENT_MASK_LEAVE_WINDOW \
  34                                         | XCB_EVENT_MASK_FOCUS_CHANGE)
  35
  36 /** Windows type */
  37 typedef enum
  38 {
  39     WINDOW_TYPE_NORMAL = 0,
  40     WINDOW_TYPE_DESKTOP,
  41     WINDOW_TYPE_DOCK,
  42     WINDOW_TYPE_SPLASH,
  43     WINDOW_TYPE_DIALOG,
  44     /* The ones below may have TRANSIENT_FOR, but are not plain dialogs.
  45      * They were purposefully placed below DIALOG.
  46      */
  47     WINDOW_TYPE_MENU,
  48     WINDOW_TYPE_TOOLBAR,
  49     WINDOW_TYPE_UTILITY,
  50     /* This ones are usually set on override-redirect windows. */
  51     WINDOW_TYPE_DROPDOWN_MENU,
  52     WINDOW_TYPE_POPUP_MENU,
  53     WINDOW_TYPE_TOOLTIP,
  54     WINDOW_TYPE_NOTIFICATION,
  55     WINDOW_TYPE_COMBO,
  56     WINDOW_TYPE_DND
  57 } window_type_t;
  58
  59 /** client_t type */
  60 struct client_t
  61 {
  62     LUA_OBJECT_HEADER
  63     /** Valid, or not ? */
  64     bool invalid;
  65     /** Client name */
  66     char *name, *icon_name;
  67     /** WM_CLASS stuff */
  68     char *class, *instance;
  69     /** Startup ID */
  70     char *startup_id;
  71     /** Window geometry */
  72     area_t geometry;
  73     struct
  74     {
  75         /** Client geometry when (un)fullscreen */
  76         area_t fullscreen;
  77         /** Client geometry when (un)-max */
  78         area_t max;
  79         /** Internal geometry (matching X11 protocol) */
  80         area_t internal;
  81     } geometries;
  82     /** Strut */
  83     strut_t strut;
  84     /** Border width and pre-fullscreen border width */
  85     int border_width, border_width_fs;
  86     xcolor_t border_color;
  87     /** True if the client is sticky */
  88     bool sticky;
  89     /** Has urgency hint */
  90     bool urgent;
  91     /** True if the client is hidden */
  92     bool hidden;
  93     /** True if the client is minimized */
  94     bool minimized;
  95     /** True if the client is fullscreen */
  96     bool fullscreen;
  97     /** True if the client is maximized horizontally */
  98     bool maximized_horizontal;
  99     /** True if the client is maximized vertically */
 100     bool maximized_vertical;
 101     /** True if the client is above others */
 102     bool above;
 103     /** True if the client is below others */
 104     bool below;
 105     /** True if the client is modal */
 106     bool modal;
 107     /** True if the client is on top */
 108     bool ontop;
 109     /** True if a client is banned to a position outside the viewport.
 110      * Note that the geometry remains unchanged and that the window is still mapped.
 111      */
 112     bool isbanned;
 113     /** true if the client must be skipped from task bar client list */
 114     bool skip_taskbar;
 115     /** True if the client cannot have focus */
 116     bool nofocus;
 117     /** The window type */
 118     window_type_t type;
 119     /** Window of the client */
 120     xcb_window_t window;
 121     /** Window of the group leader */
 122     xcb_window_t group_window;
 123     /** Window holding command needed to start it (session management related) */
 124     xcb_window_t leader_window;
 125     /** Client's WM_PROTOCOLS property */
 126     xcb_get_wm_protocols_reply_t protocols;
 127     /** Client logical screen */
 128     screen_t *screen;
 129     /** Client physical screen */
 130     int phys_screen;
 131     /** Titlebar */
 132     wibox_t *titlebar;
 133     /** Button bindings */
 134     button_array_t buttons;
 135     /** Key bindings */
 136     key_array_t keys;
 137     /** Icon */
 138     image_t *icon;
 139     /** Size hints */
 140     xcb_size_hints_t size_hints;
 141     bool size_hints_honor;
 142     /** Machine the client is running on. */
 143     char *machine;
 144     /** Role of the client */
 145     char *role;
 146     /** Client pid */
 147     uint32_t pid;
 148     /** Window it is transient for */
 149     client_t *transient_for;
 150     /** Window opacity */
 151     double opacity;
 152 };
 153
 154 client_t * luaA_client_checkudata(lua_State *, int);
 155
 156 ARRAY_FUNCS(client_t *, client, DO_NOTHING)
 157
 158 /** Client class */
 159 lua_class_t client_class;
 160
 161 LUA_OBJECT_FUNCS(client_class, client_t, client)
 162
 163 #define client_need_reban(c) \
 164     do { \
 165         if(!c->screen->need_reban \
 166            && client_isvisible(c, (c)->screen)) \
 167             c->screen->need_reban = true; \
 168     } while(0)
 169
 170 bool client_maybevisible(client_t *, screen_t *);
 171 client_t * client_getbywin(xcb_window_t);
 172 void client_ban(client_t *);
 173 void client_unban(client_t *);
 174 void client_manage(xcb_window_t, xcb_get_geometry_reply_t *, int, bool);
 175 area_t client_geometry_hints(client_t *, area_t);
 176 bool client_resize(client_t *, area_t, bool);
 177 void client_unmanage(client_t *);
 178 void client_kill(client_t *);
 179 void client_set_sticky(lua_State *, int, bool);
 180 void client_set_above(lua_State *, int, bool);
 181 void client_set_below(lua_State *, int, bool);
 182 void client_set_modal(lua_State *, int, bool);
 183 void client_set_ontop(lua_State *, int, bool);
 184 void client_set_fullscreen(lua_State *, int, bool);
 185 void client_set_maximized_horizontal(lua_State *, int, bool);
 186 void client_set_maximized_vertical(lua_State *, int, bool);
 187 void client_set_minimized(lua_State *, int, bool);
 188 void client_set_border_width(lua_State *, int, int);
 189 void client_set_urgent(lua_State *, int, bool);
 190 void client_set_pid(lua_State *, int, uint32_t);
 191 void client_set_role(lua_State *, int, const char *);
 192 void client_set_machine(lua_State *, int, const char *);
 193 void client_set_icon_name(lua_State *, int, const char *);
 194 void client_set_class_instance(lua_State *, int, const char *, const char *);
 195 void client_set_type(lua_State *L, int, window_type_t);
 196 void client_set_transient_for(lua_State *L, int, client_t *);
 197 void client_set_name(lua_State *L, int, const char *);
 198 void client_set_group_window(lua_State *, int, xcb_window_t);
 199 void client_set_icon(lua_State *, int, int);
 200 void client_set_skip_taskbar(lua_State *, int, bool);
 201 void client_set_opacity(lua_State *, int, double);
 202 void client_focus(client_t *);
 203 void client_focus_update(client_t *);
 204 void client_unfocus(client_t *);
 205 void client_unfocus_update(client_t *);
 206 void client_stack_refresh(void);
 207 bool client_hasproto(client_t *, xcb_atom_t);
 208 void client_set_focus(client_t *, bool);
 209 void client_ignore_enterleave_events(void);
 210 void client_restore_enterleave_events(void);
 211 void client_class_setup(lua_State *);
 212
 213 static inline void
 214 client_stack(void)
 215 {
 216     globalconf.client_need_stack_refresh = true;
 217 }
 218
 219 /** Put client on top of the stack.
 220  * \param c The client to raise.
 221  */
 222 static inline void
 223 client_raise(client_t *c)
 224 {
 225     client_t *tc = c;
 226     int counter = 0;
 227
 228     /* Find number of transient layers. */
 229     for(counter = 0; tc->transient_for; counter++)
 230         tc = tc->transient_for;
 231
 232     /* Push them in reverse order. */
 233     for(; counter > 0; counter--)
 234     {
 235         tc = c;
 236         for(int i = 0; i < counter; i++)
 237             tc = tc->transient_for;
 238         stack_client_append(tc);
 239     }
 240
 241     /* Push c on top of the stack. */
 242     stack_client_append(c);
 243     client_stack();
 244 }
 245
 246 /** Put client on the end of the stack.
 247  * \param c The client to lower.
 248  */
 249 static inline void
 250 client_lower(client_t *c)
 251 {
 252     stack_luaA_object_push(c);
 253
 254     /* Traverse all transient layers. */
 255     for(client_t *tc = c->transient_for; tc; tc = tc->transient_for)
 256         stack_luaA_object_push(tc);
 257
 258     client_stack();
 259 }
 260
 261 /** Check if a client has fixed size.
 262  * \param c A client.
 263  * \return A boolean value, true if the client has a fixed size.
 264  */
 265 static inline bool
 266 client_isfixed(client_t *c)
 267 {
 268     return (c->size_hints.flags & XCB_SIZE_HINT_P_MAX_SIZE
 269             && c->size_hints.flags & XCB_SIZE_HINT_P_MIN_SIZE
 270             && c->size_hints.max_width == c->size_hints.min_width
 271             && c->size_hints.max_height == c->size_hints.min_height
 272             && c->size_hints.max_width
 273             && c->size_hints.max_height);
 274 }
 275
 276 /** Returns true if a client is tagged with one of the tags of the
 277  * specified screen and is not hidden. Note that "banned" clients are included.
 278  * \param c The client to check.
 279  * \param screen Virtual screen number.
 280  * \return true if the client is visible, false otherwise.
 281  */
 282 static inline bool
 283 client_isvisible(client_t *c, screen_t *screen)
 284 {
 285     return (!c->hidden && !c->minimized && client_maybevisible(c, screen));
 286 }
 287
 288 /** Check if a client has strut information.
 289  * \param c A client.
 290  * \return A boolean value, true if the client has strut information.
 291  */
 292 static inline bool
 293 client_hasstrut(client_t *c)
 294 {
 295     return (c->strut.left
 296             || c->strut.right
 297             || c->strut.top
 298             || c->strut.bottom
 299             || c->strut.left_start_y
 300             || c->strut.left_end_y
 301             || c->strut.right_start_y
 302             || c->strut.right_end_y
 303             || c->strut.top_start_x
 304             || c->strut.top_end_x
 305             || c->strut.bottom_start_x
 306             || c->strut.bottom_end_x);
 307 }
 308
 309 #endif
 310 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80