tag.c

   1 /*
   2  * tag.c - tag management
   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 #include <stdio.h>
  23 #include <X11/Xutil.h>
  24
  25 #include "screen.h"
  26 #include "tag.h"
  27 #include "rules.h"
  28 #include "client.h"
  29 #include "ewmh.h"
  30 #include "widget.h"
  31
  32 extern AwesomeConf globalconf;
  33
  34 /** Create a new tag. Parameteres values are checked.
  35  * \param name tag name
  36  * \param layout layout to use
  37  * \param mwfact master width factor
  38  * \param nmaster number of master windows
  39  * \param ncol number of columns for slaves windows
  40  * \return a new tag with all these parameters
  41  */
  42 Tag *
  43 tag_new(const char *name, Layout *layout, double mwfact, int nmaster, int ncol)
  44 {
  45     Tag *tag;
  46
  47     tag = p_new(Tag, 1);
  48     tag->name = a_strdup(name);
  49     tag->layout = layout;
  50
  51     tag->mwfact = mwfact;
  52     if(tag->mwfact <= 0 || tag->mwfact >= 1)
  53         tag->mwfact = 0.5;
  54
  55     if((tag->nmaster = nmaster) < 0)
  56         tag->nmaster = 1;
  57
  58     if((tag->ncol = ncol) < 1)
  59         tag->ncol = 1;
  60
  61     return tag;
  62 }
  63
  64 /** Append a tag to a screen.
  65  * \param tag the tag to append
  66  * \param screen the screen id
  67  */
  68 void
  69 tag_append_to_screen(Tag *tag, int screen)
  70 {
  71     int phys_screen = screen_virttophys(screen);
  72
  73     tag->screen = screen;
  74     tag_list_append(&globalconf.screens[screen].tags, tag);
  75     ewmh_update_net_numbers_of_desktop(phys_screen);
  76     ewmh_update_net_desktop_names(phys_screen);
  77     widget_invalidate_cache(screen, WIDGET_CACHE_TAGS);
  78 }
  79
  80 /** Push a tag to a screen tag list.
  81  * \param tag the tag to push
  82  * \param screen the screen
  83  */
  84 void
  85 tag_push_to_screen(Tag *tag, int screen)
  86 {
  87     tag->screen = screen;
  88     tag_list_push(&globalconf.screens[screen].tags, tag);
  89     widget_invalidate_cache(screen, WIDGET_CACHE_TAGS);
  90 }
  91
  92 /** Tag a client with specified tag.
  93  * \param c the client to tag
  94  * \param t the tag to tag the client with
  95  */
  96 void
  97 tag_client(Client *c, Tag *t)
  98 {
  99     tag_client_node_t *tc;
 100
 101     /* don't tag twice */
 102     if(is_client_tagged(c, t))
 103         return;
 104
 105     tc = p_new(tag_client_node_t, 1);
 106     tc->client = c;
 107     tc->tag = t;
 108     tag_client_node_list_push(&globalconf.tclink, tc);
 109
 110     client_saveprops(c);
 111     widget_invalidate_cache(c->screen, WIDGET_CACHE_CLIENTS);
 112     globalconf.screens[c->screen].need_arrange = True;
 113 }
 114
 115 /** Untag a client with specified tag.
 116  * \param c the client to tag
 117  * \param t the tag to tag the client with
 118  */
 119 void
 120 untag_client(Client *c, Tag *t)
 121 {
 122     tag_client_node_t *tc;
 123
 124     for(tc = globalconf.tclink; tc; tc = tc->next)
 125         if(tc->client == c && tc->tag == t)
 126         {
 127             tag_client_node_list_detach(&globalconf.tclink, tc);
 128             p_delete(&tc);
 129             client_saveprops(c);
 130             widget_invalidate_cache(c->screen, WIDGET_CACHE_CLIENTS);
 131             globalconf.screens[c->screen].need_arrange = True;
 132             break;
 133         }
 134 }
 135
 136 /** Check if a client is tagged with the specified tag.
 137  * \param c the client
 138  * \param t the tag
 139  * \return true if the client is tagged with the tag, false otherwise.
 140  */
 141 Bool
 142 is_client_tagged(Client *c, Tag *t)
 143 {
 144     tag_client_node_t *tc;
 145
 146     if(!c)
 147         return False;
 148
 149     for(tc = globalconf.tclink; tc; tc = tc->next)
 150         if(tc->client == c && tc->tag == t)
 151             return True;
 152
 153     return False;
 154 }
 155
 156 /** Tag the client with the currently selected (visible) tags.
 157  * \param c the client
 158  */
 159 void
 160 tag_client_with_current_selected(Client *c)
 161 {
 162     Tag *tag;
 163     VirtScreen vscreen = globalconf.screens[c->screen];
 164
 165     for(tag = vscreen.tags; tag; tag = tag->next)
 166         if(tag->selected)
 167             tag_client(c, tag);
 168         else
 169             untag_client(c, tag);
 170 }
 171
 172 /** Tag the client according to a rule.
 173  * \param c the client
 174  * \param r the rule
 175  */
 176 void
 177 tag_client_with_rule(Client *c, Rule *r)
 178 {
 179     Tag *tag;
 180     Bool matched = False;
 181
 182     if(!r) return;
 183
 184     /* check if at least one tag match */
 185     for(tag = globalconf.screens[c->screen].tags; tag; tag = tag->next)
 186         if(tag_match_rule(tag, r))
 187         {
 188             matched = True;
 189             break;
 190         }
 191
 192     if(matched)
 193         for(tag = globalconf.screens[c->screen].tags; tag; tag = tag->next)
 194             if(tag_match_rule(tag, r))
 195                 tag_client(c, tag);
 196             else
 197                 untag_client(c, tag);
 198 }
 199
 200 /** Get the current tags for the specified screen.
 201  * Returned pointer must be p_delete'd after.
 202  * \param screen screen id
 203  * \return a double pointer of tag list finished with a NULL element
 204  */
 205 Tag **
 206 tags_get_current(int screen)
 207 {
 208     Tag *tag, **tags = NULL;
 209     int n = 1;
 210
 211     tags = p_new(Tag *, n);
 212     for(tag = globalconf.screens[screen].tags; tag; tag = tag->next)
 213         if(tag->selected)
 214         {
 215             p_realloc(&tags, ++n);
 216             tags[n - 2] = tag;
 217         }
 218
 219     /* finish with null */
 220     tags[n - 1] = NULL;
 221
 222     return tags;
 223 }
 224
 225 /** Tag focused client with tag.
 226  * \param screen Screen ID
 227  * \param arg Tag name
 228  * \ingroup ui_callback
 229  */
 230 void
 231 uicb_client_tag(int screen, char *arg)
 232 {
 233     int tag_id = -1;
 234     Tag *tag, *target_tag;
 235     Client *sel = globalconf.focus->client;
 236
 237     if(!sel)
 238         return;
 239
 240     if(arg)
 241     {
 242         tag_id = atoi(arg) - 1;
 243         if(tag_id != -1)
 244         {
 245             for(target_tag = globalconf.screens[screen].tags; target_tag && tag_id > 0;
 246                 target_tag = target_tag->next, tag_id--);
 247             if(target_tag)
 248             {
 249                 for(tag = globalconf.screens[screen].tags; tag; tag = tag->next)
 250                     untag_client(sel, tag);
 251                 tag_client(sel, target_tag);
 252             }
 253         }
 254     }
 255     else
 256         for(tag = globalconf.screens[screen].tags; tag; tag = tag->next)
 257             tag_client(sel, tag);
 258 }
 259
 260 /** Toggle a tag on focused client.
 261  * \param screen virtual screen id
 262  * \param arg tag number
 263  * \ingroup ui_callback
 264  */
 265 void
 266 uicb_client_toggletag(int screen, char *arg)
 267 {
 268     Client *sel = globalconf.focus->client;
 269     int i;
 270     Bool is_sticky = True;
 271     Tag *tag, *target_tag;
 272
 273     if(!sel)
 274         return;
 275
 276     if(arg)
 277     {
 278         i = atoi(arg) - 1;
 279         for(target_tag = globalconf.screens[screen].tags; target_tag && i > 0;
 280             target_tag = target_tag->next, i--);
 281         if(target_tag)
 282         {
 283             if(is_client_tagged(sel, target_tag))
 284                 untag_client(sel, target_tag);
 285             else
 286                 tag_client(sel, target_tag);
 287         }
 288
 289         /* check that there's at least one tag selected for this client*/
 290         for(tag = globalconf.screens[screen].tags; tag
 291             && !is_client_tagged(sel, tag); tag = tag->next);
 292
 293         if(!tag)
 294             tag_client(sel, target_tag);
 295     }
 296     else
 297     {
 298         for(tag = globalconf.screens[screen].tags; tag; tag = tag->next)
 299             if(!is_client_tagged(sel, tag))
 300             {
 301                 is_sticky = False;
 302                 tag_client(sel, tag);
 303             }
 304         if(is_sticky)
 305             tag_client_with_current_selected(sel);
 306     }
 307 }
 308
 309 /** Add a tag to the list of viewed tags.
 310  * \param screen Screen ID
 311  * \param arg Tag name
 312  * \ingroup ui_callback
 313  */
 314 void
 315 uicb_tag_toggleview(int screen, char *arg)
 316 {
 317     int i;
 318     Tag *tag, *target_tag,
 319         **backtag, **curtags = tags_get_current(screen);
 320
 321     if(arg)
 322     {
 323         i = atoi(arg) - 1;
 324         for(target_tag = globalconf.screens[screen].tags; target_tag && i > 0;
 325             target_tag = target_tag->next, i--);
 326
 327         if(target_tag)
 328             tag_view(target_tag, !target_tag->selected);
 329     }
 330     else
 331         for(tag = globalconf.screens[screen].tags; tag; tag = tag->next)
 332             tag_view(tag, !tag->selected);
 333
 334     /* check that there's at least one tag selected */
 335     for(tag = globalconf.screens[screen].tags; tag && !tag->selected; tag = tag->next);
 336     if(!tag)
 337         for(backtag = curtags; *backtag; backtag++)
 338             tag_view(*backtag, True);
 339
 340     p_delete(&curtags);
 341 }
 342
 343 /** Set a tag to be the only one viewed.
 344  * \param target the tag to see
 345  */
 346 static void
 347 tag_view_only(Tag *target)
 348 {
 349     Tag *tag;
 350
 351     if(!target) return;
 352
 353     for(tag = globalconf.screens[target->screen].tags; tag; tag = tag->next)
 354         tag_view(tag, tag == target);
 355 }
 356
 357 /** Use an index to set a tag viewable.
 358  * \param screen the screen id
 359  * \param dindex the index
 360  * \param view the view value
 361  */
 362 void
 363 tag_view_byindex(int screen, int dindex, Bool view)
 364 {
 365     Tag *tag;
 366
 367     if(dindex < 0)
 368         return;
 369
 370     for(tag = globalconf.screens[screen].tags; tag && dindex > 0;
 371         tag = tag->next, dindex--);
 372     tag_view(tag, view);
 373 }
 374
 375 /** View only a tag, selected by its index.
 376  * \param screen screen id
 377  * \param dindex the index
 378  */
 379 void
 380 tag_view_only_byindex(int screen, int dindex)
 381 {
 382     Tag *tag;
 383
 384     if(dindex < 0)
 385         return;
 386
 387     for(tag = globalconf.screens[screen].tags; tag && dindex > 0;
 388         tag = tag->next, dindex--);
 389     tag_view_only(tag);
 390 }
 391
 392 /** View or unview a tag.
 393  * \param tag the tag
 394  * \param view set visible or not
 395  */
 396 void
 397 tag_view(Tag *tag, Bool view)
 398 {
 399     tag->was_selected = tag->selected;
 400     tag->selected = view;
 401     ewmh_update_net_current_desktop(screen_virttophys(tag->screen));
 402     widget_invalidate_cache(tag->screen, WIDGET_CACHE_TAGS);
 403     globalconf.screens[tag->screen].need_arrange = True;
 404 }
 405
 406 /** View tag.
 407  * \param screen Screen ID
 408  * \param arg tag to view
 409  * \ingroup ui_callback
 410  */
 411 void
 412 uicb_tag_view(int screen, char *arg)
 413 {
 414     Tag *tag;
 415
 416     if(arg)
 417         tag_view_only_byindex(screen, atoi(arg) - 1);
 418     else
 419         for(tag = globalconf.screens[screen].tags; tag; tag = tag->next)
 420             tag_view(tag, True);
 421 }
 422
 423 /** View previously selected tags
 424  * \param screen Screen ID
 425  * \param arg unused
 426  * \ingroup ui_callback
 427  */
 428 void
 429 uicb_tag_prev_selected(int screen, char *arg __attribute__ ((unused)))
 430 {
 431     Tag *tag;
 432
 433     for(tag = globalconf.screens[screen].tags; tag; tag = tag->next)
 434         tag_view(tag, tag->was_selected);
 435 }
 436
 437 /** View next tag.
 438  * \param screen Screen ID
 439  * \param arg unused
 440  * \ingroup ui_callback
 441  */
 442 void
 443 uicb_tag_viewnext(int screen, char *arg __attribute__ ((unused)))
 444 {
 445     Tag *tag, **curtags = tags_get_current(screen);
 446
 447     tag = tag_list_next_cycle(&globalconf.screens[screen].tags, curtags[0]);
 448
 449     tag_view(curtags[0], False);
 450     tag_view(tag, True);
 451
 452     p_delete(&curtags);
 453 }
 454
 455 /** View previous tag.
 456  * \param screen Screen ID
 457  * \param arg unused
 458  * \ingroup ui_callback
 459  */
 460 void
 461 uicb_tag_viewprev(int screen, char *arg __attribute__ ((unused)))
 462 {
 463     Tag *tag, **curtags = tags_get_current(screen);
 464
 465     tag = tag_list_prev_cycle(&globalconf.screens[screen].tags, curtags[0]);
 466
 467     tag_view(curtags[0], False);
 468     tag_view(tag, True);
 469
 470     p_delete(&curtags);
 471 }
 472
 473 /** Create a new tag. Argument must be the tag name.
 474  * \param screen the screen id
 475  * \param arg the tag name
 476  */
 477 void
 478 uicb_tag_create(int screen, char *arg)
 479 {
 480     Tag *tag;
 481
 482     if(!a_strlen(arg))
 483         return;
 484
 485     tag = tag_new(arg, globalconf.screens[screen].layouts, 0.5, 1, 1);
 486     tag_append_to_screen(tag, screen);
 487 }
 488
 489 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80