awesome/widgets/tasklist.c

/*
 * tasklist.c - task list widget
 *
 * Copyright © 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.
 *
 */

#include "widget.h"
#include "client.h"
#include "focus.h"
#include "ewmh.h"
#include "tag.h"
#include "common/markup.h"
#include "common/tokenize.h"

extern awesome_t globalconf;

typedef enum
{
    ShowFocus,
    ShowTags,
    ShowAll,
} showclient_t;

/** The tasklist private data structure. */
typedef struct
{
    showclient_t show;
    bool show_icons;
    char *text_normal, *text_urgent, *text_focus;
} tasklist_data_t;

struct tasklist_hook_data
{
    draw_context_t *ctx;
    area_t *area;
};

/** Check if a client is visible according to the showclient type paramater.
 * \param c The client.
 * \param screen The screen number.
 * \param show The show parameters.
 * \return True if the client is visible, false otherwise.
 */
static inline bool
tasklist_isvisible(client_t *c, int screen, showclient_t show)
{
    if(c->skip || c->skiptb)
        return false;

    switch(show)
    {
      case ShowAll:
        return (c->screen == screen);
      case ShowTags:
        return client_isvisible(c, screen);
      case ShowFocus:
        return (c == focus_get_current_client(screen));
    }
    return false;
}

/** Called when a markup element is found.
 * \param p The markup parser data.
 * \param elem The element name.
 * \param names The attributes names.
 * \param values The attributes values.
 */
static void
tasklist_markup_on_elem(markup_parser_data_t *p, const char *elem,
                        const char **names, const char **values)
{
    struct tasklist_hook_data *data = p->priv;
    draw_context_t *ctx = data->ctx;

    assert(!a_strcmp(elem, "bg"));
    for(; *names; names++, values++)
        if(!a_strcmp(*names, "color"))
        {
            xcolor_t bg_color;
            xcolor_new(ctx->connection, ctx->phys_screen, *values, &bg_color);
            draw_rectangle(ctx, *data->area, 1.0, true, bg_color);
            break;
        }
}

/** Draw a tasklist widget.
 * \param ctx The draw context.
 * \param screen The screen number.
 * \param w The widget node we are called from.
 * \param offset The offset to draw at.
 * \param used The already used width.
 * \param p A pointer to the object we're drawing onto.
 */
static int
tasklist_draw(draw_context_t *ctx, int screen,
              widget_node_t *w,
              int offset, int used, void *p __attribute__ ((unused)))
{
    client_t *c;
    tasklist_data_t *d = w->widget->data;
    area_t area;
    char *text;
    int n = 0, i = 0, box_width = 0, icon_width = 0, box_width_rest = 0;
    netwm_icon_t *icon;
    draw_image_t *image;

    if(used >= ctx->width)
        return (w->area.width = 0);

    for(c = globalconf.clients; c; c = c->next)
        if(tasklist_isvisible(c, screen, d->show))
            n++;

    if(!n)
        return (w->area.width = 0);

    box_width = (ctx->width - used) / n;
    /* compute how many pixel we left empty */
    box_width_rest = (ctx->width - used) % n;

    w->area.x = widget_calculate_offset(ctx->width,
                                        0, offset, w->widget->align);

    w->area.y = 0;

    for(c = globalconf.clients; c; c = c->next)
        if(tasklist_isvisible(c, screen, d->show))
        {
            icon_width = 0;

            if(globalconf.focus->client == c)
                text = d->text_focus;
            else if(c->isurgent)
                text = d->text_urgent;
            else
                text = d->text_normal;

            text = client_markup_parse(c, text, a_strlen(text));

            if(d->show_icons)
            {
                static char const * const elements[] = { "bg", NULL };
                struct tasklist_hook_data data = { .ctx = ctx, .area = &area };
                markup_parser_data_t pdata =
                {
                    .elements   = elements,
                    .on_element = &tasklist_markup_on_elem,
                    .priv       = &data,
                };

                /* draw a background for icons */
                area.x = w->area.x + box_width * i;
                area.y = w->area.y;
                area.height = ctx->height;
                area.width = box_width;

                /* Actually look for the proper background color, since
                 * otherwise the background statusbar color is used instead */
                markup_parser_data_init(&pdata);
                markup_parse(&pdata, text, a_strlen(text));
                markup_parser_data_wipe(&pdata);

                if((image = draw_image_new(c->icon_path)))
                {
                    icon_width = ((double) ctx->height / (double) image->height) * image->width;
                    draw_image(ctx, w->area.x + box_width * i,
                               w->area.y, ctx->height, image);
                    draw_image_delete(&image);
                }

                if(!icon_width && (icon = ewmh_get_window_icon(c->win)))
                {
                    icon_width = ((double) ctx->height / (double) icon->height)
                        * icon->width;
                    draw_image_from_argb_data(ctx,
                                              w->area.x + box_width * i,
                                              w->area.y,
                                              icon->width, icon->height,
                                              ctx->height, icon->image);
                    p_delete(&icon->image);
                    p_delete(&icon);
                }
            }

            area.x = w->area.x + icon_width + box_width * i;
            area.y = w->area.y;
            area.width = box_width - icon_width;
            area.height = ctx->height;

            /* if we're on last elem, it has the last pixels left */
            if(i == n - 1)
                area.width += box_width_rest;

            draw_text(ctx, globalconf.font, area, text, NULL);

            p_delete(&text);

            if(c->isfloating || c->ismax)
                draw_circle(ctx, w->area.x + icon_width + box_width * i,
                            w->area.y,
                            (globalconf.font->height + 2) / 4,
                            c->ismax, ctx->fg);
            i++;
        }

    w->area.width = ctx->width - used;
    w->area.height = ctx->height;

    return w->area.width;
}

/** Handle button click on tasklist.
 * \param w The widget node.
 * \param ev The button press event.
 * \param screen The screen where the click was.
 * \param object The object we're onto.
 * \param type The type object.
 */
static void
tasklist_button_press(widget_node_t *w,
                      xcb_button_press_event_t *ev,
                      int screen,
                      void *object,
                      awesome_type_t type)
{
    button_t *b;
    client_t *c;
    tasklist_data_t *d = w->widget->data;
    int n = 0, box_width = 0, i, ci = 0;

    for(c = globalconf.clients; c; c = c->next)
        if(tasklist_isvisible(c, screen, d->show))
            n++;

    if(!n)
        return;

    box_width = w->area.width / n;

    ci = (ev->event_x - w->area.x) / box_width;

    /* found first visible client */
    for(c = globalconf.clients;
        c && !tasklist_isvisible(c, screen, d->show);
        c = c->next);
    /* found ci-th visible client */
    for(i = 0; c ; c = c->next)
        if(tasklist_isvisible(c, screen, d->show))
            if(i++ >= ci)
                break;

    if(c)
        for(b = w->widget->buttons; b; b = b->next)
            if(ev->detail == b->button && CLEANMASK(ev->state) == b->mod && b->fct)
            {
                luaA_pushpointer(globalconf.L, object, type);
                luaA_client_userdata_new(globalconf.L, c);
                luaA_dofunction(globalconf.L, b->fct, 2);
            }
}

/** Set the tasklist show attribute.
 * \param L The Lua VM state.
 * \return The number of elements pushed on stack.
 * \luastack
 * \lvalue A widget.
 * \lparam A string: tags, focus or all.
 */
static int
luaA_tasklist_show_set(lua_State *L)
{
    size_t len;
    widget_t **widget = luaA_checkudata(L, 1, "widget");
    tasklist_data_t *d = (*widget)->data;
    const char *buf = luaL_checklstring(L, 2, &len);

    switch(a_tokenize(buf, len))
    {
      case A_TK_TAGS:
        d->show = ShowTags;
        break;
      case A_TK_FOCUS:
        d->show = ShowFocus;
        break;
      case A_TK_ALL:
        d->show = ShowAll;
        break;
      default:
        break;
    }

    widget_invalidate_bywidget(*widget);

    return 0;
}

/** Select if icons must be shown.
 * \param L The Lua VM state.
 * \return The number of elements pushed on stack.
 * \luastack
 * \lvalue A widget.
 * \lparam A boolean, true to see icons, false otherwise.
 */
static int
luaA_tasklist_showicons_set(lua_State *L)
{
    widget_t **widget = luaA_checkudata(L, 1, "widget");
    tasklist_data_t *d = (*widget)->data;

    d->show_icons = luaA_checkboolean(L, 2);

    return 0;
}

/** Set text format string in case of a client is either normal, focused or has
 * urgency hint.
 * \param L The Lua VM state.
 * \return The number of elements pushed on stack.
 * \luastack
 * \lvalue A widget.
 * \lparam A table with keys to change: `normal', `focus' and `urgent'.
 */
static int
luaA_tasklist_text_set(lua_State *L)
{
    widget_t **widget = luaA_checkudata(L, 1, "widget");
    tasklist_data_t *d = (*widget)->data;
    const char *buf;

    luaA_checktable(L, 2);

    if((buf = luaA_getopt_string(L, 2, "normal", NULL)))
    {
        p_delete(&d->text_normal);
        d->text_normal = a_strdup(buf);
    }

    if((buf = luaA_getopt_string(L, 2, "focus", NULL)))
    {
        p_delete(&d->text_focus);
        d->text_focus = a_strdup(buf);
    }

    if((buf = luaA_getopt_string(L, 2, "urgent",  NULL)))
    {
        p_delete(&d->text_urgent);
        d->text_urgent = a_strdup(buf);
    }

    widget_invalidate_bywidget(*widget);

    return 0;
}

/** Index function for tasklist widget.
 * \lparam L The Lua VM state.
 * \return The number of elements pushed on stack.
 */
static int
luaA_tasklist_index(lua_State *L)
{
    size_t len;
    const char *attr = luaL_checklstring(L, 2, &len);

    switch(a_tokenize(attr, len))
    {
      case A_TK_TEXT_SET:
        lua_pushcfunction(L, luaA_tasklist_text_set);
        return 1;
      case A_TK_SHOWICONS_SET:
        lua_pushcfunction(L, luaA_tasklist_showicons_set);
      case A_TK_SHOW_SET:
        lua_pushcfunction(L, luaA_tasklist_show_set);
      default:
        return 0;
    }
}

/** Destructor for the tasklist widget.
 * \param widget The widget to destroy.
 */
static void
tasklist_destructor(widget_t *widget)
{
    tasklist_data_t *d = widget->data;

    p_delete(&d->text_normal);
    p_delete(&d->text_focus);
    p_delete(&d->text_urgent);
    p_delete(&d);
}

/** Create a new widget tasklist.
 * \param align The widget alignment, which is flex anyway.
 * \return A brand new tasklist widget.
 */
widget_t *
tasklist_new(alignment_t align __attribute__ ((unused)))
{
    widget_t *w;
    tasklist_data_t *d;

    w = p_new(widget_t, 1);
    widget_common_new(w);
    w->draw = tasklist_draw;
    w->button_press = tasklist_button_press;
    w->align = AlignFlex;
    w->index = luaA_tasklist_index;
    w->data = d = p_new(tasklist_data_t, 1);
    w->destructor = tasklist_destructor;

    d->text_normal = a_strdup(" <title/> ");
    d->text_focus = a_strdup(" <title/> ");
    d->text_urgent = a_strdup(" <title/> ");
    d->show_icons = true;
    d->show = ShowTags;

    /* Set cache property */
    w->cache_flags = WIDGET_CACHE_CLIENTS;

    return w;
}

/* This is used for building documentation. */
static const struct luaL_reg awesome_tasklist_meta[] __attribute__ ((unused)) =
{
    { "text_set", luaA_tasklist_text_set },
    { "showicons_set", luaA_tasklist_showicons_set },
    { "show_set", luaA_tasklist_show_set }
};

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