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 #include "common/list.h"
  28
  29 static void
  30 client_delete(client_t **c)
  31 {
  32     button_array_wipe(&(*c)->buttons);
  33     p_delete(&(*c)->icon_path);
  34     p_delete(&(*c)->name);
  35     p_delete(c);
  36 }
  37
  38 ARRAY_FUNCS(client_t *, client, DO_NOTHING)
  39 DO_RCNT(client_t, client, client_delete)
  40
  41 #define client_need_arrange(c) \
  42     do { \
  43         if(!globalconf.screens[(c)->screen].need_arrange \
  44            && client_isvisible_exclude_banned(c, (c)->screen)) \
  45             globalconf.screens[(c)->screen].need_arrange = true; \
  46     } while(0)
  47
  48 bool client_maybevisible(client_t *, int);
  49 client_t * client_getbywin(xcb_window_t);
  50 void client_stack(void);
  51 void client_ban(client_t *);
  52 void client_unban(client_t *);
  53 void client_manage(xcb_window_t, xcb_get_geometry_reply_t *, int, int);
  54 area_t client_geometry_hints(client_t *, area_t);
  55 void client_resize(client_t *, area_t, bool);
  56 void client_unmanage(client_t *);
  57 void client_saveprops_tags(client_t *);
  58 void client_kill(client_t *);
  59 void client_setsticky(client_t *, bool);
  60 void client_setabove(client_t *, bool);
  61 void client_setbelow(client_t *, bool);
  62 void client_setmodal(client_t *, bool);
  63 void client_setontop(client_t *, bool);
  64 void client_setfullscreen(client_t *, bool);
  65 void client_setmaxhoriz(client_t *, bool);
  66 void client_setmaxvert(client_t *, bool);
  67 void client_setminimized(client_t *, bool);
  68 void client_setborder(client_t *, int);
  69 void client_focus(client_t *);
  70
  71 int luaA_client_newindex(lua_State *);
  72
  73 int luaA_client_userdata_new(lua_State *, client_t *);
  74
  75 DO_SLIST(client_t, client, client_unref)
  76
  77 /** Put client on top of the stack.
  78  * \param c The client to raise.
  79  */
  80 static inline void
  81 client_raise(client_t *c)
  82 {
  83     client_t *tc = c;
  84     int counter = 0;
  85
  86     /* Find number of transient layers. */
  87     for(counter = 0; tc->transient_for; counter++)
  88         tc = tc->transient_for;
  89
  90     /* Push them in reverse order. */
  91     for(; counter > 0; counter--)
  92     {
  93         tc = c;
  94         for(int i = 0; i < counter; i++)
  95             tc = tc->transient_for;
  96         stack_client_push(tc);
  97     }
  98
  99     /* Push c on top of the stack. */
 100     stack_client_push(c);
 101     client_stack();
 102 }
 103
 104 /** Put client on the end of the stack.
 105  * \param c The client to lower.
 106  */
 107 static inline void
 108 client_lower(client_t *c)
 109 {
 110     stack_client_append(c);
 111
 112     /* Traverse all transient layers. */
 113     for(client_t *tc = c->transient_for; tc; tc = tc->transient_for)
 114         stack_client_append(tc);
 115
 116     client_stack();
 117 }
 118
 119 /** Check if a client has fixed size.
 120  * \param c A client.
 121  * \return A boolean value, true if the client has a fixed size.
 122  */
 123 static inline bool
 124 client_isfixed(client_t *c)
 125 {
 126     return (c->size_hints.flags & XCB_SIZE_HINT_P_MAX_SIZE
 127             && c->size_hints.flags & XCB_SIZE_HINT_P_MIN_SIZE
 128             && c->size_hints.max_width == c->size_hints.min_width
 129             && c->size_hints.max_height == c->size_hints.min_height);
 130 }
 131
 132 /** Returns true if a client is tagged
 133  * with one of the tags of the specified screen and is not hidden.
 134  * \param c The client to check.
 135  * \param screen Virtual screen number.
 136  * \return true if the client is visible, false otherwise.
 137  */
 138 static inline bool
 139 client_isvisible_exclude_banned(client_t *c, int screen)
 140 {
 141     return (!c->ishidden && !c->isminimized && client_maybevisible(c, screen));
 142 }
 143
 144 /** Returns true if a client is tagged
 145  * with one of the tags of the specified screen and is not hidden or banned.
 146  * \param c The client to check.
 147  * \param screen Virtual screen number.
 148  * \return true if the client is visible, false otherwise.
 149  */
 150 static inline bool
 151 client_isvisible(client_t *c, int screen)
 152 {
 153     return (client_isvisible_exclude_banned(c, screen) && !c->isbanned);
 154 }
 155
 156 /** Check if a client has strut information.
 157  * \param c A client.
 158  * \return A boolean value, true if the client has strut information.
 159  */
 160 static inline bool
 161 client_hasstrut(client_t *c)
 162 {
 163     return (c->strut.left
 164             || c->strut.right
 165             || c->strut.top
 166             || c->strut.bottom
 167             || c->strut.left_start_y
 168             || c->strut.left_end_y
 169             || c->strut.right_start_y
 170             || c->strut.right_end_y
 171             || c->strut.top_start_x
 172             || c->strut.top_end_x
 173             || c->strut.bottom_start_x
 174             || c->strut.bottom_end_x);
 175 }
 176
 177 #endif
 178 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80