config.c

   1 /*
   2  * config.c - configuration 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 <X11/keysym.h>
  23
  24 #include "config.h"
  25 #include "statusbar.h"
  26 #include "tag.h"
  27 #include "rules.h"
  28 #include "screen.h"
  29 #include "widget.h"
  30 #include "ewmh.h"
  31 #include "defconfig.h"
  32 #include "layouts/tile.h"
  33 #include "common/configopts.h"
  34 #include "common/xutil.h"
  35
  36 /* Permit to use mouse with many more buttons */
  37 #ifndef Button6
  38 #define Button6 6
  39 #endif
  40 #ifndef Button7
  41 #define Button7 7
  42 #endif
  43
  44 extern AwesomeConf globalconf;
  45 extern cfg_opt_t awesome_opts[];
  46
  47 /** Link a name to a key symbol */
  48 typedef struct
  49 {
  50     const char *name;
  51     KeyCode keycode;
  52 } KeyMod;
  53
  54 /** Link a name to a mouse button symbol */
  55 typedef struct
  56 {
  57     const char *name;
  58     unsigned int button;
  59 } MouseButton;
  60
  61 extern const name_func_link_t UicbList[];
  62 extern const name_func_link_t WidgetList[];
  63 extern const name_func_link_t LayoutList[];
  64 extern const name_func_link_t FloatingPlacementList[];
  65
  66 /** Lookup for a key mask from its name
  67  * \param keyname Key name
  68  * \return Key mask or 0 if not found
  69  */
  70 static KeyCode
  71 key_mask_lookup(const char *keyname)
  72 {
  73     /** List of keyname and corresponding X11 mask codes */
  74     static const KeyMod KeyModList[] =
  75     {
  76         {"Shift", ShiftMask},
  77         {"Lock", LockMask},
  78         {"Control", ControlMask},
  79         {"Mod1", Mod1Mask},
  80         {"Mod2", Mod2Mask},
  81         {"Mod3", Mod3Mask},
  82         {"Mod4", Mod4Mask},
  83         {"Mod5", Mod5Mask},
  84         {NULL, NoSymbol}
  85     };
  86     int i;
  87
  88     if(keyname)
  89         for(i = 0; KeyModList[i].name; i++)
  90             if(!a_strcmp(keyname, KeyModList[i].name))
  91                 return KeyModList[i].keycode;
  92
  93     return 0;
  94 }
  95
  96 /** Lookup for a mouse button from its name
  97  * \param button Mouse button name
  98  * \return Mouse button or 0 if not found
  99  */
 100 static unsigned int
 101 mouse_button_lookup(const char *button)
 102 {
 103     /** List of button name and corresponding X11 mask codes */
 104     static const MouseButton MouseButtonList[] =
 105     {
 106         {"1", Button1},
 107         {"2", Button2},
 108         {"3", Button3},
 109         {"4", Button4},
 110         {"5", Button5},
 111         {"6", Button6},
 112         {"7", Button7},
 113         {NULL, 0}
 114     };
 115     int i;
 116
 117     if(button)
 118         for(i = 0; MouseButtonList[i].name; i++)
 119             if(!a_strcmp(button, MouseButtonList[i].name))
 120                 return MouseButtonList[i].button;
 121
 122     return 0;
 123 }
 124
 125 static Button *
 126 parse_mouse_bindings(cfg_t * cfg, const char *secname, Bool handle_arg)
 127 {
 128     int i, j;
 129     cfg_t *cfgsectmp;
 130     Button *b = NULL, *head = NULL;
 131
 132     /* Mouse: layout click bindings */
 133     for(i = cfg_size(cfg, secname) - 1; i >= 0; i--)
 134     {
 135         b = p_new(Button, 1);
 136
 137         cfgsectmp = cfg_getnsec(cfg, secname, i);
 138         for(j = cfg_size(cfgsectmp, "modkey") - 1; j >= 0; j--)
 139             b->mod |= key_mask_lookup(cfg_getnstr(cfgsectmp, "modkey", j));
 140         b->button = mouse_button_lookup(cfg_getstr(cfgsectmp, "button"));
 141         b->func = name_func_lookup(cfg_getstr(cfgsectmp, "command"), UicbList);
 142         if(!b->func)
 143             warn("unknown command %s\n", cfg_getstr(cfgsectmp, "command"));
 144         if(handle_arg)
 145             b->arg = a_strdup(cfg_getstr(cfgsectmp, "arg"));
 146         else
 147             b->arg = NULL;
 148
 149         button_list_push(&head, b);
 150     }
 151
 152     return head;
 153 }
 154
 155
 156 static void
 157 set_key_info(Key *key, cfg_t *cfg)
 158 {
 159     unsigned int j;
 160
 161     for(j = 0; j < cfg_size(cfg, "modkey"); j++)
 162         key->mod |= key_mask_lookup(cfg_getnstr(cfg, "modkey", j));
 163     key->func = name_func_lookup(cfg_getstr(cfg, "command"), UicbList);
 164     if(!key->func)
 165         warn("unknown command %s\n", cfg_getstr(cfg, "command"));
 166 }
 167
 168 static KeyCode
 169 key_to_keycode(char *str)
 170 {
 171     KeyCode kc;
 172     int ikc;
 173
 174     if(a_strncmp(str, "#", 1))
 175         return XKeysymToKeycode(globalconf.display, XStringToKeysym(str));
 176
 177     ikc = atoi(str + 1);
 178     memcpy(&kc, &ikc, sizeof(KeyCode));
 179     return kc;
 180 }
 181
 182 static Key *
 183 section_keys(cfg_t *cfg_keys)
 184 {
 185     Key *key = NULL, *head = NULL;
 186     int i, j, numkeys;
 187     cfg_t *cfgkeytmp;
 188
 189     for(i = cfg_size(cfg_keys, "key") - 1; i >= 0; i--)
 190     {
 191         key = p_new(Key, 1);
 192         cfgkeytmp = cfg_getnsec(cfg_keys, "key", i);
 193         set_key_info(key, cfgkeytmp);
 194         key->keycode = key_to_keycode(cfg_getstr(cfgkeytmp, "key"));
 195         key->arg = a_strdup(cfg_getstr(cfgkeytmp, "arg"));
 196         key_list_push(&head, key);
 197     }
 198
 199     for(i = cfg_size(cfg_keys, "keylist") - 1; i >= 0; i--)
 200     {
 201         cfgkeytmp = cfg_getnsec(cfg_keys, "keylist", i);
 202         numkeys = cfg_size(cfgkeytmp, "keylist");
 203         if(numkeys != (int) cfg_size(cfgkeytmp, "arglist"))
 204         {
 205             warn("number of keys != number of args in keylist");
 206             continue;
 207         }
 208
 209         for(j = 0; j < numkeys; j++)
 210         {
 211             key = p_new(Key, 1);
 212             set_key_info(key, cfgkeytmp);
 213             key->keycode = key_to_keycode(cfg_getnstr(cfgkeytmp, "keylist", j));
 214             key->arg = a_strdup(cfg_getnstr(cfgkeytmp, "arglist", j));
 215             key_list_push(&head, key);
 216         }
 217     }
 218
 219     return head;
 220 }
 221
 222
 223 static int
 224 cmp_widget_cfg(const void *a, const void *b)
 225 {
 226     if (((cfg_t*)a)->line < ((cfg_t*)b)->line)
 227         return -1;
 228
 229     if (((cfg_t*)a)->line > ((cfg_t*)b)->line)
 230         return 1;
 231
 232     return 0;
 233 }
 234
 235 static void
 236 create_widgets(cfg_t* cfg_statusbar, Statusbar *statusbar)
 237 {
 238     cfg_t* widgets, *wptr;
 239     Widget *widget = NULL;
 240     unsigned int i, j, numwidgets = 0;
 241     WidgetConstructor *widget_new;
 242
 243     for(i = 0; WidgetList[i].name; i++)
 244         numwidgets += cfg_size(cfg_statusbar, WidgetList[i].name);
 245
 246     widgets = p_new(cfg_t, numwidgets);
 247     wptr = widgets;
 248
 249     for(i = 0; WidgetList[i].name; i++)
 250         for (j = 0; j < cfg_size(cfg_statusbar, WidgetList[i].name); j++)
 251         {
 252             memcpy(wptr,
 253                    cfg_getnsec(cfg_statusbar, WidgetList[i].name, j),
 254                    sizeof(cfg_t));
 255             wptr++;
 256         }
 257
 258     qsort(widgets, numwidgets, sizeof(cfg_t), cmp_widget_cfg);
 259
 260     for(i = 0; i < numwidgets; i++)
 261     {
 262         wptr = widgets + i;
 263         widget_new = name_func_lookup(cfg_name(wptr), WidgetList);
 264         if(widget_new)
 265         {
 266             widget = widget_new(statusbar, wptr);
 267             widget_list_append(&statusbar->widgets, widget);
 268             widget->buttons = parse_mouse_bindings(wptr, "mouse", a_strcmp(cfg_name(wptr), "taglist"));
 269         }
 270         else
 271             warn("Ignoring unknown widget: %s.\n", cfg_name(widgets + i));
 272     }
 273 }
 274
 275 static void
 276 config_parse_screen(cfg_t *cfg, int screen)
 277 {
 278     char buf[2];
 279     const char *tmp;
 280     FloatingPlacement flpl;
 281     Layout *layout = NULL;
 282     Tag *tag = NULL;
 283     Statusbar *statusbar = NULL;
 284     cfg_t *cfg_general, *cfg_styles, *cfg_screen, *cfg_tags,
 285           *cfg_layouts, *cfg_padding, *cfgsectmp,
 286           *cfg_styles_normal, *cfg_styles_focus, *cfg_styles_urgent;
 287     VirtScreen *virtscreen = &globalconf.screens[screen];
 288     int i, phys_screen = get_phys_screen(screen);
 289
 290     snprintf(buf, sizeof(buf), "%d", screen);
 291     cfg_screen = cfg_gettsec(cfg, "screen", buf);
 292     if(!cfg_screen)
 293         cfg_screen = cfg_getsec(cfg, "screen");
 294
 295     if(!cfg_screen)
 296     {
 297         warn("parsing configuration file failed, no screen section found\n");
 298         cfg_parse_buf(cfg, AWESOME_DEFAULT_CONFIG);
 299         cfg_screen = cfg_getsec(cfg, "screen");
 300     }
 301
 302     /* get screen specific sections */
 303     cfg_tags = cfg_getsec(cfg_screen, "tags");
 304     cfg_styles = cfg_getsec(cfg_screen, "styles");
 305     cfg_general = cfg_getsec(cfg_screen, "general");
 306     cfg_layouts = cfg_getsec(cfg_screen, "layouts");
 307     cfg_padding = cfg_getsec(cfg_screen, "padding");
 308
 309
 310     /* General section */
 311     virtscreen->borderpx = cfg_getint(cfg_general, "border");
 312     virtscreen->snap = cfg_getint(cfg_general, "snap");
 313     virtscreen->resize_hints = cfg_getbool(cfg_general, "resize_hints");
 314     virtscreen->sloppy_focus = cfg_getbool(cfg_general, "sloppy_focus");
 315     virtscreen->sloppy_focus_raise = cfg_getbool(cfg_general, "sloppy_focus_raise");
 316     virtscreen->new_become_master = cfg_getbool(cfg_general, "new_become_master");
 317     virtscreen->new_get_focus = cfg_getbool(cfg_general, "new_get_focus");
 318     virtscreen->opacity_unfocused = cfg_getint(cfg_general, "opacity_unfocused");
 319     virtscreen->floating_placement =
 320         name_func_lookup(cfg_getstr(cfg_general, "floating_placement"),
 321                                     FloatingPlacementList);
 322     virtscreen->titlebar_default_position =
 323         position_get_from_str(cfg_getstr(cfg_general, "titlebar"));
 324
 325     virtscreen->mwfact_lower_limit = cfg_getfloat(cfg_general, "mwfact_lower_limit");
 326     virtscreen->mwfact_upper_limit = cfg_getfloat(cfg_general, "mwfact_upper_limit");
 327
 328     if(virtscreen->mwfact_lower_limit < 0 || virtscreen->mwfact_lower_limit > 1)
 329     {
 330         warn("incorrect value %f for mwfact_lower_limit, must be between 0 and 1\n",
 331              virtscreen->mwfact_lower_limit);
 332         virtscreen->mwfact_lower_limit = 0.1;
 333     }
 334
 335     if(virtscreen->mwfact_upper_limit < 0 || virtscreen->mwfact_upper_limit > 1)
 336     {
 337         warn("incorrect value %f for mwfact_upper_limit, must be between 0 and 1\n",
 338              virtscreen->mwfact_lower_limit);
 339         virtscreen->mwfact_upper_limit = 0.9;
 340     }
 341
 342     if(virtscreen->mwfact_upper_limit < virtscreen->mwfact_lower_limit)
 343     {
 344         warn("mwfact_upper_limit must be greater than mwfact_lower_limit\n");
 345         virtscreen->mwfact_upper_limit = 0.9;
 346         virtscreen->mwfact_lower_limit = 0.1;
 347     }
 348
 349     if(!virtscreen->floating_placement)
 350     {
 351         warn("unknown floating placement: %s\n", cfg_getstr(cfg_general, "floating_placement"));
 352         virtscreen->floating_placement = FloatingPlacementList[0].func;
 353     }
 354
 355     /* Colors */
 356     if(!cfg_styles)
 357         eprint("no colors section found");
 358
 359     if(!(cfg_styles_normal = cfg_getsec(cfg_styles, "normal")))
 360        eprint("no normal colors section found\n");
 361     if(!(cfg_styles_focus = cfg_getsec(cfg_styles, "focus")))
 362        eprint("no focus colors section found\n");
 363     if(!(cfg_styles_urgent = cfg_getsec(cfg_styles, "urgent")))
 364        eprint("no urgent colors section found\n");
 365
 366     draw_style_init(globalconf.display, phys_screen,
 367                     cfg_styles_normal, &virtscreen->styles.normal, NULL);
 368     draw_style_init(globalconf.display, phys_screen,
 369                     cfg_styles_focus, &virtscreen->styles.focus, &virtscreen->styles.normal);
 370     draw_style_init(globalconf.display, phys_screen,
 371                     cfg_styles_urgent, &virtscreen->styles.urgent, &virtscreen->styles.normal);
 372
 373     if(!virtscreen->styles.normal.font)
 374         eprint("no font available\n");
 375
 376     /* Statusbar */
 377     statusbar_list_init(&virtscreen->statusbar);
 378     for(i = cfg_size(cfg_screen, "statusbar") - 1; i >= 0; i--)
 379     {
 380         statusbar = p_new(Statusbar, 1);
 381         cfgsectmp = cfg_getnsec(cfg_screen, "statusbar", i);
 382         statusbar->position = statusbar->dposition =
 383             position_get_from_str(cfg_getstr(cfgsectmp, "position"));
 384         statusbar->height = cfg_getint(cfgsectmp, "height");
 385         statusbar->width = cfg_getint(cfgsectmp, "width");
 386         statusbar->name = a_strdup(cfg_title(cfgsectmp));
 387         statusbar->screen = screen;
 388         statusbar_preinit(statusbar);
 389         create_widgets(cfgsectmp, statusbar);
 390         statusbar_list_push(&virtscreen->statusbar, statusbar);
 391     }
 392
 393     /* Layouts */
 394     layout_list_init(&virtscreen->layouts);
 395     if((i = cfg_size(cfg_layouts, "layout")))
 396         for(--i; i >= 0; i--)
 397         {
 398             layout = p_new(Layout, 1);
 399             cfgsectmp = cfg_getnsec(cfg_layouts, "layout", i);
 400             layout->arrange = name_func_lookup(cfg_title(cfgsectmp), LayoutList);
 401             if(!layout->arrange)
 402             {
 403                 warn("unknown layout %s in configuration file\n", cfg_title(cfgsectmp));
 404                 layout->image = NULL;
 405                 continue;
 406             }
 407             layout->image = a_strdup(cfg_getstr(cfgsectmp, "image"));
 408
 409             layout_list_push(&virtscreen->layouts, layout);
 410         }
 411     else
 412     {
 413         warn("no default layout available\n");
 414         layout = p_new(Layout, 1);
 415         layout->arrange = layout_tile;
 416         layout_list_push(&virtscreen->layouts, layout);
 417     }
 418
 419     /* Tags */
 420     tag_list_init(&virtscreen->tags);
 421     if((i = cfg_size(cfg_tags, "tag")))
 422         for(--i; i >= 0; i--)
 423         {
 424             cfgsectmp = cfg_getnsec(cfg_tags, "tag", i);
 425
 426             tmp = cfg_getstr(cfgsectmp, "layout");
 427             for(layout = virtscreen->layouts;
 428                 layout && layout->arrange != name_func_lookup(tmp, LayoutList);
 429                 layout = layout->next);
 430             if(!layout)
 431                 layout = virtscreen->layouts;
 432
 433             tag = tag_new(cfg_title(cfgsectmp),
 434                           layout,
 435                           cfg_getfloat(cfgsectmp, "mwfact"),
 436                           cfg_getint(cfgsectmp, "nmaster"),
 437                           cfg_getint(cfgsectmp, "ncol"));
 438
 439             tag_push_to_screen(tag, screen);
 440         }
 441     else
 442     {
 443         warn("fatal: no tags found in configuration file\n");
 444         tag = tag_new("default", virtscreen->layouts, 0.5, 1, 1);
 445         tag_push_to_screen(tag, screen);
 446     }
 447
 448     ewmh_update_net_numbers_of_desktop(phys_screen);
 449     ewmh_update_net_current_desktop(phys_screen);
 450     ewmh_update_net_desktop_names(phys_screen);
 451
 452     /* select first tag by default */
 453     virtscreen->tags[0].selected = True;
 454     virtscreen->tags[0].was_selected = True;
 455
 456     /* padding */
 457     virtscreen->padding.top = cfg_getint(cfg_padding, "top");
 458     virtscreen->padding.bottom = cfg_getint(cfg_padding, "bottom");
 459     virtscreen->padding.left = cfg_getint(cfg_padding, "left");
 460     virtscreen->padding.right = cfg_getint(cfg_padding, "right");
 461 }
 462
 463 /** Parse configuration file and initialize some stuff
 464  * \param confpatharg Path to configuration file
 465  */
 466 void
 467 config_parse(const char *confpatharg)
 468 {
 469     cfg_t *cfg, *cfg_rules, *cfg_keys, *cfg_mouse, *cfgsectmp;
 470     int ret, screen, i;
 471     char *confpath;
 472     Rule *rule = NULL;
 473     FILE *defconfig = NULL;
 474
 475     if(confpatharg)
 476         confpath = a_strdup(confpatharg);
 477     else
 478         confpath = config_file();
 479
 480     globalconf.configpath = a_strdup(confpath);
 481
 482     cfg = cfg_init(awesome_opts, CFGF_NONE);
 483
 484     ret = cfg_parse(cfg, confpath);
 485
 486     switch(ret)
 487     {
 488       case CFG_FILE_ERROR:
 489         perror("awesome: parsing configuration file failed");
 490         if(!(defconfig = fopen(confpath, "w")))
 491            perror("awesome: unable to create default configuration file");
 492         break;
 493       case CFG_PARSE_ERROR:
 494         cfg_error(cfg, "awesome: parsing configuration file %s failed.\n", confpath);
 495         break;
 496     }
 497
 498     if(ret != CFG_SUCCESS)
 499     {
 500         warn("using default compile-time configuration\n");
 501         cfg_free(cfg);
 502         cfg = cfg_init(awesome_opts, CFGF_NONE);
 503         cfg_parse_buf(cfg, AWESOME_DEFAULT_CONFIG);
 504     }
 505
 506     /* get the right screen section */
 507     for(screen = 0; screen < globalconf.screens_info->nscreen; screen++)
 508         config_parse_screen(cfg, screen);
 509
 510     /* get general sections */
 511     cfg_rules = cfg_getsec(cfg, "rules");
 512     cfg_keys = cfg_getsec(cfg, "keys");
 513     cfg_mouse = cfg_getsec(cfg, "mouse");
 514
 515     /* Rules */
 516     rule_list_init(&globalconf.rules);
 517     for(i = cfg_size(cfg_rules, "rule") - 1; i >= 0; i--)
 518     {
 519         rule = p_new(Rule, 1);
 520         cfgsectmp = cfg_getnsec(cfg_rules, "rule", i);
 521         rule->prop_r = rules_compile_regex(cfg_getstr(cfgsectmp, "name"));
 522         rule->tags_r = rules_compile_regex(cfg_getstr(cfgsectmp, "tags"));
 523         rule->xprop = a_strdup(cfg_getstr(cfgsectmp, "xproperty_name"));
 524         rule->xpropval_r = rules_compile_regex(cfg_getstr(cfgsectmp, "xproperty_value"));
 525         rule->icon = a_strdup(cfg_getstr(cfgsectmp, "icon"));
 526         rule->isfloating = rules_get_fuzzy_from_str(cfg_getstr(cfgsectmp, "float"));
 527         rule->screen = cfg_getint(cfgsectmp, "screen");
 528         rule->ismaster = rules_get_fuzzy_from_str(cfg_getstr(cfgsectmp, "master"));
 529         rule->titlebar = position_get_from_str(cfg_getstr(cfgsectmp, "titlebar"));
 530         rule->opacity = cfg_getfloat(cfgsectmp, "opacity");
 531         if(rule->screen >= globalconf.screens_info->nscreen)
 532             rule->screen = 0;
 533
 534         rule_list_push(&globalconf.rules, rule);
 535     }
 536
 537     /* Mouse: root window click bindings */
 538     globalconf.buttons.root = parse_mouse_bindings(cfg_mouse, "root", True);
 539
 540     /* Mouse: client windows click bindings */
 541     globalconf.buttons.client = parse_mouse_bindings(cfg_mouse, "client", True);
 542
 543     /* Keys */
 544     globalconf.numlockmask = get_numlockmask(globalconf.display);
 545
 546     globalconf.keys = section_keys(cfg_keys);
 547
 548     if(defconfig)
 549     {
 550         fwrite(AWESOME_DEFAULT_CONFIG, a_strlen(AWESOME_DEFAULT_CONFIG), 1, defconfig);
 551         fclose(defconfig);
 552     }
 553
 554     /* Free! Like a river! */
 555     cfg_free(cfg);
 556     p_delete(&confpath);
 557 }
 558
 559 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80