objects/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_OBJECTS_CLIENT_H
  23 #define AWESOME_OBJECTS_CLIENT_H
  24
  25 #include "mouse.h"
  26 #include "stack.h"
  27 #include "draw.h"
  28 #include "banning.h"
  29 #include "objects/window.h"
  30 #include "common/luaobject.h"
  31
  32 #define CLIENT_SELECT_INPUT_EVENT_MASK (XCB_EVENT_MASK_STRUCTURE_NOTIFY \
  33                                         | XCB_EVENT_MASK_PROPERTY_CHANGE \
  34                                         | XCB_EVENT_MASK_FOCUS_CHANGE)
  35
  36 #define FRAME_SELECT_INPUT_EVENT_MASK (XCB_EVENT_MASK_STRUCTURE_NOTIFY \
  37                                        | XCB_EVENT_MASK_ENTER_WINDOW \
  38                                        | XCB_EVENT_MASK_LEAVE_WINDOW \
  39                                        | XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT)
  40
  41 /** client_t type */
  42 struct client_t
  43 {
  44     WINDOW_OBJECT_HEADER
  45     /** Client logical screen */
  46     screen_t *screen;
  47     /** Client name */
  48     char *name, *alt_name, *icon_name, *alt_icon_name;
  49     /** WM_CLASS stuff */
  50     char *class, *instance;
  51     /** Window geometry */
  52     area_t geometry;
  53     /** True if the client is sticky */
  54     bool sticky;
  55     /** Has urgency hint */
  56     bool urgent;
  57     /** True if the client is hidden */
  58     bool hidden;
  59     /** True if the client is minimized */
  60     bool minimized;
  61     /** True if the client is fullscreen */
  62     bool fullscreen;
  63     /** True if the client is maximized horizontally */
  64     bool maximized_horizontal;
  65     /** True if the client is maximized vertically */
  66     bool maximized_vertical;
  67     /** True if the client is above others */
  68     bool above;
  69     /** True if the client is below others */
  70     bool below;
  71     /** True if the client is modal */
  72     bool modal;
  73     /** True if the client is on top */
  74     bool ontop;
  75     /** True if a client is banned to a position outside the viewport.
  76      * Note that the geometry remains unchanged and that the window is still mapped.
  77      */
  78     bool isbanned;
  79     /** true if the client must be skipped from task bar client list */
  80     bool skip_taskbar;
  81     /** True if the client cannot have focus */
  82     bool nofocus;
  83     /** Window of the group leader */
  84     xcb_window_t group_window;
  85     /** Window holding command needed to start it (session management related) */
  86     xcb_window_t leader_window;
  87     /** Client's WM_PROTOCOLS property */
  88     xcb_icccm_get_wm_protocols_reply_t protocols;
  89     /** Key bindings */
  90     key_array_t keys;
  91     /** Icon */
  92     cairo_surface_t *icon;
  93     /** Size hints */
  94     xcb_size_hints_t size_hints;
  95     bool size_hints_honor;
  96     /** Machine the client is running on. */
  97     char *machine;
  98     /** Role of the client */
  99     char *role;
 100     /** Client pid */
 101     uint32_t pid;
 102     /** Window it is transient for */
 103     client_t *transient_for;
 104 };
 105
 106 ARRAY_FUNCS(client_t *, client, DO_NOTHING)
 107
 108 /** Client class */
 109 lua_class_t client_class;
 110
 111 LUA_OBJECT_FUNCS(client_class, client_t, client)
 112
 113 bool client_maybevisible(client_t *);
 114 client_t * client_getbywin(xcb_window_t);
 115 client_t * client_getbyframewin(xcb_window_t);
 116
 117 void client_ban(client_t *);
 118 void client_ban_unfocus(client_t *);
 119 void client_unban(client_t *);
 120 void client_manage(xcb_window_t, xcb_get_geometry_reply_t *, bool);
 121 bool client_resize(client_t *, area_t);
 122 void client_unmanage(client_t *, bool);
 123 void client_kill(client_t *);
 124 void client_set_sticky(lua_State *, int, bool);
 125 void client_set_above(lua_State *, int, bool);
 126 void client_set_below(lua_State *, int, bool);
 127 void client_set_modal(lua_State *, int, bool);
 128 void client_set_ontop(lua_State *, int, bool);
 129 void client_set_fullscreen(lua_State *, int, bool);
 130 void client_set_maximized_horizontal(lua_State *, int, bool);
 131 void client_set_maximized_vertical(lua_State *, int, bool);
 132 void client_set_minimized(lua_State *, int, bool);
 133 void client_set_urgent(lua_State *, int, bool);
 134 void client_set_pid(lua_State *, int, uint32_t);
 135 void client_set_role(lua_State *, int, char *);
 136 void client_set_machine(lua_State *, int, char *);
 137 void client_set_icon_name(lua_State *, int, char *);
 138 void client_set_alt_icon_name(lua_State *, int, char *);
 139 void client_set_class_instance(lua_State *, int, const char *, const char *);
 140 void client_set_type(lua_State *L, int, window_type_t);
 141 void client_set_transient_for(lua_State *L, int, client_t *);
 142 void client_set_name(lua_State *L, int, char *);
 143 void client_set_alt_name(lua_State *L, int, char *);
 144 void client_set_group_window(lua_State *, int, xcb_window_t);
 145 void client_set_icon(client_t *c, cairo_surface_t *s);
 146 void client_set_skip_taskbar(lua_State *, int, bool);
 147 void client_focus(client_t *);
 148 void client_focus_update(client_t *);
 149 void client_focus_refresh(void);
 150 bool client_hasproto(client_t *, xcb_atom_t);
 151 void client_ignore_enterleave_events(void);
 152 void client_restore_enterleave_events(void);
 153 void client_class_setup(lua_State *);
 154
 155 /** Put client on top of the stack.
 156  * \param c The client to raise.
 157  */
 158 static inline void
 159 client_raise(client_t *c)
 160 {
 161     client_t *tc = c;
 162     int counter = 0;
 163
 164     /* Find number of transient layers.
 165      * We limit the counter to the stack length: if some case, a buggy
 166      * application might set transient_for as a loop… */
 167     for(counter = 0; tc->transient_for && counter <= globalconf.stack.len; counter++)
 168         tc = tc->transient_for;
 169
 170     /* Push them in reverse order. */
 171     for(; counter > 0; counter--)
 172     {
 173         tc = c;
 174         for(int i = 0; i < counter; i++)
 175             tc = tc->transient_for;
 176         stack_client_append(tc);
 177     }
 178
 179     /* Push c on top of the stack. */
 180     stack_client_append(c);
 181 }
 182
 183 /** Check if a client has fixed size.
 184  * \param c A client.
 185  * \return A boolean value, true if the client has a fixed size.
 186  */
 187 static inline bool
 188 client_isfixed(client_t *c)
 189 {
 190     return (c->size_hints.flags & XCB_ICCCM_SIZE_HINT_P_MAX_SIZE
 191             && c->size_hints.flags & XCB_ICCCM_SIZE_HINT_P_MIN_SIZE
 192             && c->size_hints.max_width == c->size_hints.min_width
 193             && c->size_hints.max_height == c->size_hints.min_height
 194             && c->size_hints.max_width
 195             && c->size_hints.max_height
 196             && c->size_hints_honor);
 197 }
 198
 199 /** Returns true if a client is tagged with one of the tags of the
 200  * specified screen and is not hidden. Note that "banned" clients are included.
 201  * \param c The client to check.
 202  * \param screen Virtual screen number.
 203  * \return true if the client is visible, false otherwise.
 204  */
 205 static inline bool
 206 client_isvisible(client_t *c)
 207 {
 208     return (!c->hidden && !c->minimized && client_maybevisible(c));
 209 }
 210
 211 #endif
 212 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80