awesomewm-mirrors
/
awesome
mirror of https://github.com/awesomeWM/awesome.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
awesome/objects/tag.c

638 lines
17 KiB
C
Raw Blame History

/*
* tag.c - tag management
*
* 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.
*
*/
/** awesome tag API.
*
* What is a tag?
* ==============
*
* In AwesomeWM, a `tag` is a group of clients. It can either be used as labels
* or as more classical workspaces depending on how they are configured.
*
* ![Client geometry](../images/tag_props.svg)
*
* * A **tag** can be attached to **multiple clients**
* * A **client** can be attached to **multiple tags**
* * A **tag** can only be in 1 screen *any given time*, but can be moved
* * All **clients** attached to a tag **must be in the same screen as the tag**
*
* Creating tags
* =============
*
* The default config initializes tags like this:
*
* awful.tag(
* { "1", "2", "3", "4", "5", "6", "7", "8", "9" },
* s,
* awful.layout.layouts[1]
* )
*
* If you wish to have tags with different properties, then `awful.tag.add` is
* a better choice:
*
* awful.tag.add("First tag", {
* icon = "/path/to/icon1.png",
* layout = awful.layout.suit.tile,
* master_fill_policy = "master_width_factor",
* gap_single_client = true,
* gap = 15,
* screen = s,
* selected = true,
* })
*
* awful.tag.add("Second tag", {
* icon = "/path/to/icon2.png",
* layout = awful.layout.suit.max,
* screen = s,
* })
*
* Note: the example above sets "First tag" to be selected explicitly,
* because otherwise you will find yourself without any selected tag.
*
* Accessing tags
* ==============
*
* To access the "current tags", use
*
* local tags = awful.screen.focused().selected_tags
*
* See: `awful.screen.focused`
*
* See: `screen.selected_tags`
*
* To ignore the corner case where multiple tags are selected:
*
* local t = awful.screen.focused().selected_tag
*
* See: `screen.selected_tag`
*
* To get all tags for the focused screen:
*
* local tags = awful.screen.focused().tags
*
* See: `screen.tags`
*
* To get all tags:
*
* local tags = root.tags()
*
* To get the current tag of the focused client:
*
* local t = client.focus and client.focus.first_tag or nil
*
* See: `client.focus`
* See: `client.first_tag`
*
* To get a tag from its name:
*
* local t = awful.tag.find_by_name(awful.screen.focused(), "name")
*
* Common keybindings code
* =======================
*
* Here is a few useful shortcuts not part of the default `rc.lua`. Add these
* functions above `-- {{{ Key bindings`:
*
* Delete the current tag
*
* local function delete_tag()
* local t = awful.screen.focused().selected_tag
* if not t then return end
* t:delete()
* end
*
* Create a new tag at the end of the list
*
* local function add_tag()
* awful.tag.add("NewTag", {
* screen = awful.screen.focused(),
* layout = awful.layout.suit.floating }):view_only()
* end
*
* Rename the current tag
*
* local function rename_tag()
* awful.prompt.run {
* prompt = "New tag name: ",
* textbox = awful.screen.focused().mypromptbox.widget,
* exe_callback = function(new_name)
* if not new_name or #new_name == 0 then return end
*
* local t = awful.screen.focused().selected_tag
* if t then
* t.name = new_name
* end
* end
* }
* end
*
* Move the focused client to a new tag
*
* local function move_to_new_tag()
* local c = client.focus
* if not c then return end
*
* local t = awful.tag.add(c.class,{screen= c.screen })
* c:tags({t})
* t:view_only()
* end
*
* Copy the current tag at the end of the list
*
* local function copy_tag()
* local t = awful.screen.focused().selected_tag
* if not t then return end
*
* local clients = t:clients()
* local t2 = awful.tag.add(t.name, awful.tag.getdata(t))
* t2:clients(clients)
* t2:view_only()
* end
*
* And, in the `globalkeys` table:
*
* awful.key({ modkey, }, "a", add_tag,
* {description = "add a tag", group = "tag"}),
* awful.key({ modkey, "Shift" }, "a", delete_tag,
* {description = "delete the current tag", group = "tag"}),
* awful.key({ modkey, "Control" }, "a", move_to_new_tag,
* {description = "add a tag with the focused client", group = "tag"}),
* awful.key({ modkey, "Mod1" }, "a", copy_tag,
* {description = "create a copy of the current tag", group = "tag"}),
* awful.key({ modkey, "Shift" }, "r", rename_tag,
* {description = "rename the current tag", group = "tag"}),
*
* See the
* <a href="../documentation/05-awesomerc.md.html#global_keybindings">
* global keybindings
* </a> for more information about the keybindings.
*
* Some signal names are starting with a dot. These dots are artefacts from
* the documentation generation, you get the real signal name by
* removing the starting dot.
*
* @DOC_uml_nav_tables_tag_EXAMPLE@
*
* @author Julien Danjou &lt;julien@danjou.info&gt;
* @copyright 2008-2009 Julien Danjou
* @coreclassmod tag
*/
#include "tag.h"
#include "screen.h"
#include "banning.h"
#include "client.h"
#include "ewmh.h"
#include "luaa.h"
lua_class_t tag_class;
/** Emitted when a tag requests to be selected.
* @signal request::select
* @tparam string context The reason why it was called.
* @request tag select ewmh granted When the client request to be moved to a
* specific virtual desktop. AwesomeWM interprets virtual desktop as indexed
* tags.
*/
/**
* This signal is emitted to fill the list of default layouts.
*
* It is emitted on the global `tag` class rather than individual tag objects.
* The default handler is part of `rc.lua`. New modules can also use this signal
* to dynamically add new layouts to the list of default layouts.
*
* @signal request::default_layouts
* @tparam string context The context (currently always "startup").
* @classsignal
* @request tag default_layouts startup granted When AwesomeWM starts, it queries
* for default layout using this request.
* @see awful.layout.layouts
* @see awful.layout.append_default_layout
* @see awful.layout.remove_default_layout
*/
/** This signals is emitted when a tag needs layouts for the first time.
*
* If no handler implement it, it will fallback to the content added by
* `request::default_layouts`
*
* @signal request::layouts
* @tparam string context The context (currently always "awful").
* @tparam table hints A, currently empty, table with hints.
*/
/** Emitted when a client gets tagged with this tag.
* @signal tagged
* @tparam client c The tagged client.
*/
/** Emitted when a client gets untagged with this tag.
* @signal untagged
* @tparam client c The untagged client.
*/
/**
* Tag name.
*
* @DOC_sequences_tag_name_EXAMPLE@
*
* **Signal:**
*
* * *property::name*
*
* @property name
* @param string
*/
/**
* True if the tag is selected to be viewed.
*
* @DOC_sequences_tag_selected_EXAMPLE@
*
* **Signal:**
*
* * *property::selected*
*
* @property selected
* @param boolean
*/
/**
* True if the tag is active and can be used.
*
* **Signal:**
*
* * *property::activated*
*
* @property activated
* @param boolean
*/
/** Get the number of instances.
*
* @return The number of tag objects alive.
* @staticfct instances
*/
/* Set a __index metamethod for all tag instances.
* @tparam function cb The meta-method
* @staticfct set_index_miss_handler
*/
/* Set a __newindex metamethod for all tag instances.
* @tparam function cb The meta-method
* @staticfct set_newindex_miss_handler
*/
void
tag_unref_simplified(tag_t **tag)
{
lua_State *L = globalconf_get_lua_State();
luaA_object_unref(L, *tag);
}
static void
tag_wipe(tag_t *tag)
{
client_array_wipe(&tag->clients);
p_delete(&tag->name);
}
OBJECT_EXPORT_PROPERTY(tag, tag_t, selected)
OBJECT_EXPORT_PROPERTY(tag, tag_t, name)
/** View or unview a tag.
* \param L The Lua VM state.
* \param udx The index of the tag on the stack.
* \param view Set selected or not.
*/
static void
tag_view(lua_State *L, int udx, bool view)
{
tag_t *tag = luaA_checkudata(L, udx, &tag_class);
if(tag->selected != view)
{
tag->selected = view;
banning_need_update();
foreach(screen, globalconf.screens)
screen_update_workarea(*screen);
luaA_object_emit_signal(L, udx, "property::selected", 0);
}
}
static void
tag_client_emit_signal(tag_t *t, client_t *c, const char *signame)
{
lua_State *L = globalconf_get_lua_State();
luaA_object_push(L, c);
luaA_object_push(L, t);
/* emit signal on client, with new tag as argument */
luaA_object_emit_signal(L, -2, signame, 1);
/* re push tag */
luaA_object_push(L, t);
/* move tag before client */
lua_insert(L, -2);
luaA_object_emit_signal(L, -2, signame, 1);
/* Remove tag */
lua_pop(L, 1);
}
/** Tag a client with the tag on top of the stack.
* \param L The Lua VM state.
* \param c the client to tag
*/
void
tag_client(lua_State *L, client_t *c)
{
tag_t *t = luaA_object_ref_class(L, -1, &tag_class);
/* don't tag twice */
if(is_client_tagged(c, t))
{
luaA_object_unref(L, t);
return;
}
client_array_append(&t->clients, c);
ewmh_client_update_desktop(c);
banning_need_update();
screen_update_workarea(c->screen);
tag_client_emit_signal(t, c, "tagged");
}
/** Untag a client with specified tag.
* \param c the client to tag
* \param t the tag to tag the client with
*/
void
untag_client(client_t *c, tag_t *t)
{
for(int i = 0; i < t->clients.len; i++)
if(t->clients.tab[i] == c)
{
lua_State *L = globalconf_get_lua_State();
client_array_take(&t->clients, i);
banning_need_update();
ewmh_client_update_desktop(c);
screen_update_workarea(c->screen);
tag_client_emit_signal(t, c, "untagged");
luaA_object_unref(L, t);
return;
}
}
/** Check if a client is tagged with the specified tag.
* \param c the client
* \param t the tag
* \return true if the client is tagged with the tag, false otherwise.
*/
bool
is_client_tagged(client_t *c, tag_t *t)
{
for(int i = 0; i < t->clients.len; i++)
if(t->clients.tab[i] == c)
return true;
return false;
}
/** Get the index of the tag with focused client or first selected
* \return Its index
*/
int
tags_get_current_or_first_selected_index(void)
{
/* Consider "current desktop" a tag, that has focused window,
* basically a tag user actively interacts with.
* If no focused windows are present, fallback to first selected.
*/
if(globalconf.focus.client)
{
foreach(tag, globalconf.tags)
{
if((*tag)->selected && is_client_tagged(globalconf.focus.client, *tag))
return tag_array_indexof(&globalconf.tags, tag);
}
}
foreach(tag, globalconf.tags)
{
if((*tag)->selected)
return tag_array_indexof(&globalconf.tags, tag);
}
return 0;
}
/** Create a new tag.
* \param L The Lua VM state.
* \luastack
* \lparam A name.
* \lreturn A new tag object.
*/
static int
luaA_tag_new(lua_State *L)
{
return luaA_class_new(L, &tag_class);
}
/** Get or set the clients attached to this tag.
*
* @tparam[opt=nil] table clients_table None or a table of clients to set as being tagged with
* this tag.
* @return A table with the clients attached to this tags.
* @method clients
*/
static int
luaA_tag_clients(lua_State *L)
{
tag_t *tag = luaA_checkudata(L, 1, &tag_class);
client_array_t *clients = &tag->clients;
int i;
if(lua_gettop(L) == 2)
{
luaA_checktable(L, 2);
for(int j = 0; j < clients->len; j++)
{
client_t *c = clients->tab[j];
/* Only untag if we aren't going to add this tag again */
bool found = false;
lua_pushnil(L);
while(lua_next(L, 2))
{
client_t *tc = luaA_checkudata(L, -1, &client_class);
/* Pop the value from lua_next */
lua_pop(L, 1);
if (tc != c)
continue;
/* Pop the key from lua_next */
lua_pop(L, 1);
found = true;
break;
}
if(!found) {
untag_client(c, tag);
j--;
}
}
lua_pushnil(L);
while(lua_next(L, 2))
{
client_t *c = luaA_checkudata(L, -1, &client_class);
/* push tag on top of the stack */
lua_pushvalue(L, 1);
tag_client(L, c);
lua_pop(L, 1);
}
}
lua_createtable(L, clients->len, 0);
for(i = 0; i < clients->len; i++)
{
luaA_object_push(L, clients->tab[i]);
lua_rawseti(L, -2, i + 1);
}
return 1;
}
LUA_OBJECT_EXPORT_PROPERTY(tag, tag_t, name, lua_pushstring)
LUA_OBJECT_EXPORT_PROPERTY(tag, tag_t, selected, lua_pushboolean)
LUA_OBJECT_EXPORT_PROPERTY(tag, tag_t, activated, lua_pushboolean)
/** Set the tag name.
* \param L The Lua VM state.
* \param tag The tag to name.
* \return The number of elements pushed on stack.
*/
static int
luaA_tag_set_name(lua_State *L, tag_t *tag)
{
const char *buf = luaL_checkstring(L, -1);
p_delete(&tag->name);
tag->name = a_strdup(buf);
luaA_object_emit_signal(L, -3, "property::name", 0);
ewmh_update_net_desktop_names();
return 0;
}
/** Set the tag selection status.
* \param L The Lua VM state.
* \param tag The tag to set the selection status for.
* \return The number of elements pushed on stack.
*/
static int
luaA_tag_set_selected(lua_State *L, tag_t *tag)
{
tag_view(L, -3, luaA_checkboolean(L, -1));
return 0;
}
/** Set the tag activated status.
* \param L The Lua VM state.
* \param tag The tag to set the activated status for.
* \return The number of elements pushed on stack.
*/
static int
luaA_tag_set_activated(lua_State *L, tag_t *tag)
{
bool activated = luaA_checkboolean(L, -1);
if(activated == tag->activated)
return 0;
tag->activated = activated;
if(activated)
{
lua_pushvalue(L, -3);
tag_array_append(&globalconf.tags, luaA_object_ref_class(L, -1, &tag_class));
}
else
{
for (int i = 0; i < globalconf.tags.len; i++)
if(globalconf.tags.tab[i] == tag)
{
tag_array_take(&globalconf.tags, i);
break;
}
if (tag->selected)
{
tag->selected = false;
luaA_object_emit_signal(L, -3, "property::selected", 0);
banning_need_update();
}
luaA_object_unref(L, tag);
}
ewmh_update_net_numbers_of_desktop();
ewmh_update_net_desktop_names();
luaA_object_emit_signal(L, -3, "property::activated", 0);
return 0;
}
void
tag_class_setup(lua_State *L)
{
static const struct luaL_Reg tag_methods[] =
{
LUA_CLASS_METHODS(tag)
{ "__call", luaA_tag_new },
{ NULL, NULL }
};
static const struct luaL_Reg tag_meta[] =
{
LUA_OBJECT_META(tag)
LUA_CLASS_META
{ "clients", luaA_tag_clients },
{ NULL, NULL },
};
luaA_class_setup(L, &tag_class, "tag", NULL,
(lua_class_allocator_t) tag_new,
(lua_class_collector_t) tag_wipe,
NULL,
luaA_class_index_miss_property, luaA_class_newindex_miss_property,
tag_methods, tag_meta);
luaA_class_add_property(&tag_class, "name",
(lua_class_propfunc_t) luaA_tag_set_name,
(lua_class_propfunc_t) luaA_tag_get_name,
(lua_class_propfunc_t) luaA_tag_set_name);
luaA_class_add_property(&tag_class, "selected",
(lua_class_propfunc_t) luaA_tag_set_selected,
(lua_class_propfunc_t) luaA_tag_get_selected,
(lua_class_propfunc_t) luaA_tag_set_selected);
luaA_class_add_property(&tag_class, "activated",
(lua_class_propfunc_t) luaA_tag_set_activated,
(lua_class_propfunc_t) luaA_tag_get_activated,
(lua_class_propfunc_t) luaA_tag_set_activated);
}
/* @DOC_cobject_COMMON@ */
// vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80
Reference in New Issue View Git Blame Copy Permalink