278 lines
8.9 KiB
C
278 lines
8.9 KiB
C
/*
|
|
* client.h - client management header
|
|
*
|
|
* Copyright © 2007-2009 Julien Danjou <julien@danjou.info>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*
|
|
*/
|
|
|
|
#ifndef AWESOME_CLIENT_H
|
|
#define AWESOME_CLIENT_H
|
|
|
|
#include "mouse.h"
|
|
#include "stack.h"
|
|
#include "strut.h"
|
|
#include "draw.h"
|
|
#include "banning.h"
|
|
#include "common/luaobject.h"
|
|
|
|
#define CLIENT_SELECT_INPUT_EVENT_MASK (XCB_EVENT_MASK_STRUCTURE_NOTIFY \
|
|
| XCB_EVENT_MASK_PROPERTY_CHANGE \
|
|
| XCB_EVENT_MASK_ENTER_WINDOW \
|
|
| XCB_EVENT_MASK_LEAVE_WINDOW \
|
|
| XCB_EVENT_MASK_FOCUS_CHANGE)
|
|
|
|
/** Windows type */
|
|
typedef enum
|
|
{
|
|
WINDOW_TYPE_NORMAL = 0,
|
|
WINDOW_TYPE_DESKTOP,
|
|
WINDOW_TYPE_DOCK,
|
|
WINDOW_TYPE_SPLASH,
|
|
WINDOW_TYPE_DIALOG,
|
|
/* The ones below may have TRANSIENT_FOR, but are not plain dialogs.
|
|
* They were purposefully placed below DIALOG.
|
|
*/
|
|
WINDOW_TYPE_MENU,
|
|
WINDOW_TYPE_TOOLBAR,
|
|
WINDOW_TYPE_UTILITY,
|
|
/* This ones are usually set on override-redirect windows. */
|
|
WINDOW_TYPE_DROPDOWN_MENU,
|
|
WINDOW_TYPE_POPUP_MENU,
|
|
WINDOW_TYPE_TOOLTIP,
|
|
WINDOW_TYPE_NOTIFICATION,
|
|
WINDOW_TYPE_COMBO,
|
|
WINDOW_TYPE_DND
|
|
} window_type_t;
|
|
|
|
/** client_t type */
|
|
struct client_t
|
|
{
|
|
LUA_OBJECT_HEADER
|
|
/** Valid, or not ? */
|
|
bool invalid;
|
|
/** Client name */
|
|
char *name, *alt_name, *icon_name, *alt_icon_name;
|
|
/** WM_CLASS stuff */
|
|
char *class, *instance;
|
|
/** Window geometry */
|
|
area_t geometry;
|
|
struct
|
|
{
|
|
/** Client geometry when (un)fullscreen */
|
|
area_t fullscreen;
|
|
/** Client geometry when (un)-max */
|
|
area_t max;
|
|
/** Internal geometry (matching X11 protocol) */
|
|
area_t internal;
|
|
} geometries;
|
|
/** Strut */
|
|
strut_t strut;
|
|
/** Border width and pre-fullscreen border width */
|
|
int border_width, border_width_fs;
|
|
xcolor_t border_color;
|
|
/** True if the client is sticky */
|
|
bool sticky;
|
|
/** Has urgency hint */
|
|
bool urgent;
|
|
/** True if the client is hidden */
|
|
bool hidden;
|
|
/** True if the client is minimized */
|
|
bool minimized;
|
|
/** True if the client is fullscreen */
|
|
bool fullscreen;
|
|
/** True if the client is maximized horizontally */
|
|
bool maximized_horizontal;
|
|
/** True if the client is maximized vertically */
|
|
bool maximized_vertical;
|
|
/** True if the client is above others */
|
|
bool above;
|
|
/** True if the client is below others */
|
|
bool below;
|
|
/** True if the client is modal */
|
|
bool modal;
|
|
/** True if the client is on top */
|
|
bool ontop;
|
|
/** True if a client is banned to a position outside the viewport.
|
|
* Note that the geometry remains unchanged and that the window is still mapped.
|
|
*/
|
|
bool isbanned;
|
|
/** true if the client must be skipped from task bar client list */
|
|
bool skip_taskbar;
|
|
/** True if the client cannot have focus */
|
|
bool nofocus;
|
|
/** The window type */
|
|
window_type_t type;
|
|
/** Window of the client */
|
|
xcb_window_t window;
|
|
/** Window of the group leader */
|
|
xcb_window_t group_window;
|
|
/** Window holding command needed to start it (session management related) */
|
|
xcb_window_t leader_window;
|
|
/** Client's WM_PROTOCOLS property */
|
|
xcb_get_wm_protocols_reply_t protocols;
|
|
/** Client logical screen */
|
|
screen_t *screen;
|
|
/** Client physical screen */
|
|
int phys_screen;
|
|
/** Titlebar */
|
|
wibox_t *titlebar;
|
|
/** Button bindings */
|
|
button_array_t buttons;
|
|
/** Key bindings */
|
|
key_array_t keys;
|
|
/** Icon */
|
|
image_t *icon;
|
|
/** Size hints */
|
|
xcb_size_hints_t size_hints;
|
|
bool size_hints_honor;
|
|
/** Machine the client is running on. */
|
|
char *machine;
|
|
/** Role of the client */
|
|
char *role;
|
|
/** Client pid */
|
|
uint32_t pid;
|
|
/** Window it is transient for */
|
|
client_t *transient_for;
|
|
/** Window opacity */
|
|
double opacity;
|
|
};
|
|
|
|
client_t * luaA_client_checkudata(lua_State *, int);
|
|
|
|
ARRAY_FUNCS(client_t *, client, DO_NOTHING)
|
|
|
|
/** Client class */
|
|
lua_class_t client_class;
|
|
|
|
LUA_OBJECT_FUNCS(client_class, client_t, client)
|
|
|
|
#define client_need_reban(c) \
|
|
do { \
|
|
if(client_isvisible(c, (c)->screen)) \
|
|
banning_refresh((c)->screen); \
|
|
} while(0)
|
|
|
|
bool client_maybevisible(client_t *, screen_t *);
|
|
client_t * client_getbywin(xcb_window_t);
|
|
void client_ban(client_t *);
|
|
void client_unban(client_t *);
|
|
void client_manage(xcb_window_t, xcb_get_geometry_reply_t *, int, bool);
|
|
area_t client_geometry_hints(client_t *, area_t);
|
|
bool client_resize(client_t *, area_t, bool);
|
|
void client_unmanage(client_t *);
|
|
void client_kill(client_t *);
|
|
void client_set_sticky(lua_State *, int, bool);
|
|
void client_set_above(lua_State *, int, bool);
|
|
void client_set_below(lua_State *, int, bool);
|
|
void client_set_modal(lua_State *, int, bool);
|
|
void client_set_ontop(lua_State *, int, bool);
|
|
void client_set_fullscreen(lua_State *, int, bool);
|
|
void client_set_maximized_horizontal(lua_State *, int, bool);
|
|
void client_set_maximized_vertical(lua_State *, int, bool);
|
|
void client_set_minimized(lua_State *, int, bool);
|
|
void client_set_border_width(lua_State *, int, int);
|
|
void client_set_urgent(lua_State *, int, bool);
|
|
void client_set_pid(lua_State *, int, uint32_t);
|
|
void client_set_role(lua_State *, int, char *);
|
|
void client_set_machine(lua_State *, int, char *);
|
|
void client_set_icon_name(lua_State *, int, char *);
|
|
void client_set_alt_icon_name(lua_State *, int, char *);
|
|
void client_set_class_instance(lua_State *, int, const char *, const char *);
|
|
void client_set_type(lua_State *L, int, window_type_t);
|
|
void client_set_transient_for(lua_State *L, int, client_t *);
|
|
void client_set_name(lua_State *L, int, char *);
|
|
void client_set_alt_name(lua_State *L, int, char *);
|
|
void client_set_group_window(lua_State *, int, xcb_window_t);
|
|
void client_set_icon(lua_State *, int, int);
|
|
void client_set_skip_taskbar(lua_State *, int, bool);
|
|
void client_set_opacity(lua_State *, int, double);
|
|
void client_focus(client_t *);
|
|
void client_focus_update(client_t *);
|
|
void client_unfocus(client_t *);
|
|
void client_unfocus_update(client_t *);
|
|
void client_stack_refresh(void);
|
|
bool client_hasproto(client_t *, xcb_atom_t);
|
|
void client_set_focus(client_t *, bool);
|
|
void client_ignore_enterleave_events(void);
|
|
void client_restore_enterleave_events(void);
|
|
void client_class_setup(lua_State *);
|
|
|
|
static inline void
|
|
client_stack(void)
|
|
{
|
|
globalconf.client_need_stack_refresh = true;
|
|
}
|
|
|
|
/** Put client on top of the stack.
|
|
* \param c The client to raise.
|
|
*/
|
|
static inline void
|
|
client_raise(client_t *c)
|
|
{
|
|
client_t *tc = c;
|
|
int counter = 0;
|
|
|
|
/* Find number of transient layers.
|
|
* We limit the counter to the stack length: if some case, a buggy
|
|
* application might set transient_for as a loop… */
|
|
for(counter = 0; tc->transient_for && counter <= globalconf.stack.len; counter++)
|
|
tc = tc->transient_for;
|
|
|
|
/* Push them in reverse order. */
|
|
for(; counter > 0; counter--)
|
|
{
|
|
tc = c;
|
|
for(int i = 0; i < counter; i++)
|
|
tc = tc->transient_for;
|
|
stack_client_append(tc);
|
|
}
|
|
|
|
/* Push c on top of the stack. */
|
|
stack_client_append(c);
|
|
client_stack();
|
|
}
|
|
|
|
/** Check if a client has fixed size.
|
|
* \param c A client.
|
|
* \return A boolean value, true if the client has a fixed size.
|
|
*/
|
|
static inline bool
|
|
client_isfixed(client_t *c)
|
|
{
|
|
return (c->size_hints.flags & XCB_SIZE_HINT_P_MAX_SIZE
|
|
&& c->size_hints.flags & XCB_SIZE_HINT_P_MIN_SIZE
|
|
&& c->size_hints.max_width == c->size_hints.min_width
|
|
&& c->size_hints.max_height == c->size_hints.min_height
|
|
&& c->size_hints.max_width
|
|
&& c->size_hints.max_height);
|
|
}
|
|
|
|
/** Returns true if a client is tagged with one of the tags of the
|
|
* specified screen and is not hidden. Note that "banned" clients are included.
|
|
* \param c The client to check.
|
|
* \param screen Virtual screen number.
|
|
* \return true if the client is visible, false otherwise.
|
|
*/
|
|
static inline bool
|
|
client_isvisible(client_t *c, screen_t *screen)
|
|
{
|
|
return (!c->hidden && !c->minimized && client_maybevisible(c, screen));
|
|
}
|
|
|
|
#endif
|
|
// vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80
|