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