awesome/client.h

/*
 * client.h - client management header
 *
 * Copyright © 2007-2008 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"

static void
client_delete(client_t **c)
{
    button_array_wipe(&(*c)->buttons);
    p_delete(&(*c)->icon_path);
    p_delete(&(*c)->name);
    p_delete(c);
}

ARRAY_FUNCS(client_t *, client, DO_NOTHING)
DO_RCNT(client_t, client, client_delete)

#define client_need_arrange(c) \
    do { \
        if(!globalconf.screens[(c)->screen].need_arrange \
           && client_isvisible(c, (c)->screen)) \
            globalconf.screens[(c)->screen].need_arrange = true; \
    } while(0)

bool client_maybevisible(client_t *, int);
client_t * client_getbywin(xcb_window_t);
void client_stack(void);
void client_ban(client_t *);
void client_unban(client_t *);
void client_manage(xcb_window_t, xcb_get_geometry_reply_t *, int, int);
area_t client_geometry_hints(client_t *, area_t);
void client_resize(client_t *, area_t, bool);
void client_unmanage(client_t *);
void client_saveprops_tags(client_t *);
void client_kill(client_t *);
void client_setfloating(client_t *, bool);
void client_setsticky(client_t *, bool);
void client_setabove(client_t *, bool);
void client_setbelow(client_t *, bool);
void client_setmodal(client_t *, bool);
void client_setontop(client_t *, bool);
void client_setfullscreen(client_t *, bool);
void client_setminimized(client_t *, bool);
void client_setborder(client_t *, int);

int luaA_client_newindex(lua_State *);

int luaA_client_userdata_new(lua_State *, client_t *);

DO_SLIST(client_t, client, client_unref)

/** Put client on top of the stack.
 * \param c The client to raise.
 */
static inline void
client_raise(client_t *c)
{
    /* Push c on top of the stack. */
    if(c->transient_for)
        stack_client_push(c->transient_for);
    stack_client_push(c);
    client_stack();
}

/** Put client on the end of the stack.
 * \param c The client to lower.
 */
static inline void
client_lower(client_t *c)
{
    stack_client_append(c);
    if(c->transient_for)
        stack_client_append(c->transient_for);
    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->maxw && c->minw && c->maxh && c->minh
            && c->maxw == c->minw && c->maxh == c->minh);
}

/** Check if a client is floating.
 * \param c A client.
 * \return A boolean value, true if the client is floating.
 */
static inline bool
client_isfloating(client_t *c)
{
    return (c->type != WINDOW_TYPE_NORMAL
            || c->isfloating
            || c->isfullscreen
            || client_isfixed(c));
}

/** Returns true if a client is tagged
 * with one of the tags of the specified screen and is not hidden.
 * \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_exclude_banned(client_t *c, int screen)
{
    return (!c->ishidden && !c->isminimized && client_maybevisible(c, screen));
}

/** Returns true if a client is tagged
 * with one of the tags of the specified screen and is not hidden or banned.
 * \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, int screen)
{
    return (client_isvisible_exclude_banned(c, screen) && !c->isbanned);
}

/** Check if a client has strut information.
 * \param c A client.
 * \return A boolean value, true if the client has strut information.
 */
static inline bool
client_hasstrut(client_t *c)
{
    return (c->strut.left
            || c->strut.right
            || c->strut.top
            || c->strut.bottom
            || c->strut.left_start_y
            || c->strut.left_end_y
            || c->strut.right_start_y
            || c->strut.right_end_y
            || c->strut.top_start_x
            || c->strut.top_end_x
            || c->strut.bottom_start_x
            || c->strut.bottom_end_x);
}

#endif
// vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80