common/configopts.c

   1 /*
   2  * configopts.c - configuration options
   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 <errno.h>
  23 #include <string.h>
  24 #include <sys/types.h>
  25 #include <sys/stat.h>
  26 #include <unistd.h>
  27
  28 #include <confuse.h>
  29
  30 #include "rules.h"
  31 #include "common/configopts.h"
  32
  33 #define AWESOME_CONFIG_FILE ".awesomerc"
  34
  35 #define CFG_AWESOME_END() \
  36         CFG_FUNC((char *) "include", cfg_awesome_include), \
  37         CFG_END()
  38
  39 /** This is a better writing of cfg_include coming from libconfuse.
  40  * With this one, we do not treat errors as fatal.
  41  */
  42 static int
  43 cfg_awesome_include(cfg_t *cfg, cfg_opt_t *opt,
  44                     int argc, const char **argv)
  45 {
  46     char *filename;
  47     FILE *fp;
  48
  49     if(argc != 1 || !a_strlen(argv[0]))
  50     {
  51         cfg_error(cfg, "wrong number of arguments to cfg_awesome_include()");
  52         return 0;
  53     }
  54
  55     filename = cfg_tilde_expand(argv[0]);
  56
  57     if(!(fp = fopen(filename, "r")))
  58     {
  59         cfg_error(cfg, "cannot include configuration file %s: %s",
  60                   filename, strerror(errno));
  61         return 0;
  62     }
  63
  64     p_delete(&filename);
  65     fclose(fp);
  66
  67     return cfg_include(cfg, opt, argc, argv);
  68 }
  69
  70 cfg_opt_t general_opts[] =
  71 {
  72     CFG_INT((char *) "border", 1, CFGF_NONE),
  73     CFG_INT((char *) "snap", 8, CFGF_NONE),
  74     CFG_BOOL((char *) "resize_hints", cfg_true, CFGF_NONE),
  75     CFG_BOOL((char *) "sloppy_focus", cfg_true, CFGF_NONE),
  76     CFG_BOOL((char *) "sloppy_focus_raise", cfg_false, CFGF_NONE),
  77     CFG_BOOL((char *) "new_become_master", cfg_true, CFGF_NONE),
  78     CFG_BOOL((char *) "new_get_focus", cfg_true, CFGF_NONE),
  79     CFG_STR((char *) "font", (char *) "vera-10", CFGF_NONE),
  80     CFG_INT((char *) "opacity_unfocused", -1, CFGF_NONE),
  81     CFG_STR((char *) "floating_placement", (char *) "smart", CFGF_NONE),
  82     CFG_AWESOME_END()
  83 };
  84 cfg_opt_t colors_opts[] =
  85 {
  86     CFG_STR((char *) "normal_border", (char *) "#111111", CFGF_NONE),
  87     CFG_STR((char *) "normal_bg", (char *) "#111111", CFGF_NONE),
  88     CFG_STR((char *) "normal_fg", (char *) "#eeeeee", CFGF_NONE),
  89     CFG_STR((char *) "focus_border", (char *) "#6666ff", CFGF_NONE),
  90     CFG_STR((char *) "focus_bg", (char *) "#6666ff", CFGF_NONE),
  91     CFG_STR((char *) "focus_fg", (char *) "#ffffff", CFGF_NONE),
  92     CFG_STR((char *) "urgent_bg", (char *) "#ff0000", CFGF_NONE),
  93     CFG_STR((char *) "urgent_fg", (char *) "#ffffff", CFGF_NONE),
  94     CFG_AWESOME_END()
  95 };
  96 cfg_opt_t mouse_taglist_opts[] =
  97 {
  98     CFG_STR_LIST((char *) "modkey", (char *) "{}", CFGF_NONE),
  99     CFG_STR((char *) "button", (char *) "None", CFGF_NONE),
 100     CFG_STR((char *) "command", (char *) "", CFGF_NONE),
 101     CFG_AWESOME_END()
 102 };
 103 cfg_opt_t mouse_generic_opts[] =
 104 {
 105     CFG_STR_LIST((char *) "modkey", (char *) "{}", CFGF_NONE),
 106     CFG_STR((char *) "button", (char *) "None", CFGF_NONE),
 107     CFG_STR((char *) "command", (char *) "", CFGF_NONE),
 108     CFG_STR((char *) "arg", NULL, CFGF_NONE),
 109     CFG_AWESOME_END()
 110 };
 111 cfg_opt_t widget_opts[] =
 112 {
 113     CFG_INT((char *) "x", 0xffffffff, CFGF_NONE),
 114     CFG_INT((char *) "y", 0xffffffff, CFGF_NONE),
 115     CFG_STR((char *) "align", (char *) "auto", CFGF_NONE),
 116     CFG_SEC((char *) "mouse", mouse_generic_opts, CFGF_MULTI),
 117     CFG_AWESOME_END()
 118 };
 119 cfg_opt_t widget_taglist_opts[] =
 120 {
 121     CFG_INT((char *) "x", 0xffffffff, CFGF_NONE),
 122     CFG_INT((char *) "y", 0xffffffff, CFGF_NONE),
 123     CFG_STR((char *) "align", (char *) "auto", CFGF_NONE),
 124     CFG_SEC((char *) "mouse", mouse_taglist_opts, CFGF_MULTI),
 125     CFG_AWESOME_END()
 126 };
 127 cfg_opt_t widget_iconbox_opts[] =
 128 {
 129     CFG_INT((char *) "x", 0xffffffff, CFGF_NONE),
 130     CFG_INT((char *) "y", 0xffffffff, CFGF_NONE),
 131     CFG_STR((char *) "align", (char *) "auto", CFGF_NONE),
 132     CFG_SEC((char *) "mouse", mouse_generic_opts, CFGF_MULTI),
 133     CFG_STR((char *) "image", (char *) NULL, CFGF_NONE),
 134     CFG_BOOL((char *) "resize", cfg_true, CFGF_NONE),
 135     CFG_AWESOME_END()
 136 };
 137 cfg_opt_t widget_textbox_opts[] =
 138 {
 139     CFG_INT((char *) "x", 0xffffffff, CFGF_NONE),
 140     CFG_INT((char *) "y", 0xffffffff, CFGF_NONE),
 141     CFG_STR((char *) "align", (char *) "auto", CFGF_NONE),
 142     CFG_SEC((char *) "mouse", mouse_generic_opts, CFGF_MULTI),
 143     CFG_INT((char *) "width", 0, CFGF_NONE),
 144     CFG_STR((char *) "text", (char *) NULL, CFGF_NONE),
 145     CFG_STR((char *) "fg", (char *) NULL, CFGF_NONE),
 146     CFG_STR((char *) "bg", (char *) NULL, CFGF_NONE),
 147     CFG_STR((char *) "font", (char *) NULL, CFGF_NONE),
 148     CFG_STR((char *) "text_align", (char *) "center", CFGF_NONE),
 149     CFG_AWESOME_END()
 150 };
 151 cfg_opt_t widget_tasklist_opts[] =
 152 {
 153     CFG_INT((char *) "x", 0xffffffff, CFGF_NONE),
 154     CFG_INT((char *) "y", 0xffffffff, CFGF_NONE),
 155     CFG_SEC((char *) "mouse", mouse_generic_opts, CFGF_MULTI),
 156     CFG_STR((char *) "fg", (char *) NULL, CFGF_NONE),
 157     CFG_STR((char *) "bg", (char *) NULL, CFGF_NONE),
 158     CFG_STR((char *) "focus_fg", (char *) NULL, CFGF_NONE),
 159     CFG_STR((char *) "focus_bg", (char *) NULL, CFGF_NONE),
 160     CFG_STR((char *) "font", (char *) NULL, CFGF_NONE),
 161     CFG_STR((char *) "text_align", (char *) "left", CFGF_NONE),
 162     CFG_STR((char *) "show", (char *) "tags", CFGF_NONE),
 163     CFG_BOOL((char *) "show_icons", cfg_true, CFGF_NONE),
 164     CFG_AWESOME_END()
 165 };
 166 cfg_opt_t widget_graph_data_opts[] =
 167 {
 168     CFG_FLOAT((char *) "max", 100.0f, CFGF_NONE),
 169     CFG_BOOL((char *) "scale", cfg_false, CFGF_NONE),
 170     CFG_STR((char *) "fg", (char *) NULL, CFGF_NONE),
 171     CFG_STR((char *) "fg_center", (char *) NULL, CFGF_NONE),
 172     CFG_STR((char *) "fg_end", (char *) NULL, CFGF_NONE),
 173     CFG_STR((char *) "style", (char *) "bottom", CFGF_NONE),
 174     CFG_AWESOME_END()
 175 };
 176 cfg_opt_t widget_graph_opts[] =
 177 {
 178     CFG_INT((char *) "x", 0xffffffff, CFGF_NONE),
 179     CFG_INT((char *) "y", 0xffffffff, CFGF_NONE),
 180     CFG_STR((char *) "align", (char *) "auto", CFGF_NONE),
 181     CFG_SEC((char *) "mouse", mouse_generic_opts, CFGF_MULTI),
 182     CFG_SEC((char *) "data", widget_graph_data_opts, CFGF_MULTI),
 183     CFG_INT((char *) "width", 100, CFGF_NONE),
 184     CFG_INT((char *) "padding_left", 0, CFGF_NONE),
 185     CFG_FLOAT((char *) "height", 0.67, CFGF_NONE),
 186     CFG_STR((char *) "bg", (char *) NULL, CFGF_NONE),
 187     CFG_STR((char *) "bordercolor", (char *) NULL, CFGF_NONE),
 188     CFG_AWESOME_END()
 189 };
 190 cfg_opt_t widget_progressbar_bar_opts[] =
 191 {
 192     CFG_STR((char *) "fg", (char *) NULL, CFGF_NONE),
 193     CFG_STR((char *) "fg_center", (char *) NULL, CFGF_NONE),
 194     CFG_STR((char *) "fg_end", (char *) NULL, CFGF_NONE),
 195     CFG_STR((char *) "bg", (char *) NULL, CFGF_NONE),
 196     CFG_STR((char *) "bordercolor", (char *) NULL, CFGF_NONE),
 197     CFG_AWESOME_END()
 198 };
 199 cfg_opt_t widget_progressbar_opts[] =
 200 {
 201     CFG_INT((char *) "x", 0xffffffff, CFGF_NONE),
 202     CFG_INT((char *) "y", 0xffffffff, CFGF_NONE),
 203     CFG_STR((char *) "align", (char *) "auto", CFGF_NONE),
 204     CFG_SEC((char *) "mouse", mouse_generic_opts, CFGF_MULTI),
 205     CFG_SEC((char *) "bar", widget_progressbar_bar_opts, CFGF_MULTI),
 206     CFG_INT((char *) "width", 100, CFGF_NONE),
 207     CFG_INT((char *) "gap", 2, CFGF_NONE),
 208     CFG_INT((char *) "padding", 0, CFGF_NONE),
 209     CFG_FLOAT((char *) "height", 0.67, CFGF_NONE),
 210     CFG_AWESOME_END()
 211 };
 212 cfg_opt_t statusbar_opts[] =
 213 {
 214     CFG_STR((char *) "position", (char *) "top", CFGF_NONE),
 215     CFG_INT((char *) "height", 0, CFGF_NONE),
 216     CFG_INT((char *) "width", 0, CFGF_NONE),
 217     CFG_SEC((char *) "textbox", widget_textbox_opts, CFGF_TITLE | CFGF_MULTI | CFGF_NO_TITLE_DUPES),
 218     CFG_SEC((char *) "taglist", widget_taglist_opts, CFGF_TITLE | CFGF_MULTI | CFGF_NO_TITLE_DUPES),
 219     CFG_SEC((char *) "layoutinfo", widget_opts, CFGF_TITLE | CFGF_MULTI | CFGF_NO_TITLE_DUPES),
 220     CFG_SEC((char *) "iconbox", widget_iconbox_opts, CFGF_TITLE | CFGF_MULTI | CFGF_NO_TITLE_DUPES),
 221     CFG_SEC((char *) "focusicon", widget_opts, CFGF_TITLE | CFGF_MULTI | CFGF_NO_TITLE_DUPES),
 222     CFG_SEC((char *) "progressbar", widget_progressbar_opts, CFGF_TITLE | CFGF_MULTI | CFGF_NO_TITLE_DUPES),
 223     CFG_SEC((char *) "graph", widget_graph_opts, CFGF_TITLE | CFGF_MULTI | CFGF_NO_TITLE_DUPES),
 224     CFG_SEC((char *) "tasklist", widget_tasklist_opts, CFGF_TITLE | CFGF_MULTI | CFGF_NO_TITLE_DUPES),
 225     CFG_AWESOME_END()
 226 };
 227 cfg_opt_t tag_opts[] =
 228 {
 229     CFG_STR((char *) "layout", (char *) "tile", CFGF_NONE),
 230     CFG_FLOAT((char *) "mwfact", 0.5, CFGF_NONE),
 231     CFG_INT((char *) "nmaster", 1, CFGF_NONE),
 232     CFG_INT((char *) "ncol", 1, CFGF_NONE),
 233     CFG_AWESOME_END()
 234 };
 235 cfg_opt_t tags_opts[] =
 236 {
 237     CFG_SEC((char *) "tag", tag_opts, CFGF_TITLE | CFGF_MULTI | CFGF_NO_TITLE_DUPES),
 238     CFG_AWESOME_END()
 239 };
 240 cfg_opt_t layout_opts[] =
 241 {
 242     CFG_STR((char *) "image", NULL, CFGF_NONE),
 243     CFG_AWESOME_END()
 244 };
 245 cfg_opt_t layouts_opts[] =
 246 {
 247     CFG_SEC((char *) "layout", layout_opts, CFGF_TITLE | CFGF_MULTI),
 248     CFG_AWESOME_END()
 249 };
 250 cfg_opt_t padding_opts[] =
 251 {
 252     CFG_INT((char *) "top", 0, CFGF_NONE),
 253     CFG_INT((char *) "bottom", 0, CFGF_NONE),
 254     CFG_INT((char *) "right", 0, CFGF_NONE),
 255     CFG_INT((char *) "left", 0, CFGF_NONE),
 256     CFG_AWESOME_END()
 257 };
 258 cfg_opt_t screen_opts[] =
 259 {
 260     CFG_SEC((char *) "general", general_opts, CFGF_NONE),
 261     CFG_SEC((char *) "statusbar", statusbar_opts, CFGF_TITLE | CFGF_MULTI | CFGF_NO_TITLE_DUPES),
 262     CFG_SEC((char *) "tags", tags_opts, CFGF_NONE),
 263     CFG_SEC((char *) "colors", colors_opts, CFGF_NONE),
 264     CFG_SEC((char *) "layouts", layouts_opts, CFGF_NONE),
 265     CFG_SEC((char *) "padding", padding_opts, CFGF_NONE),
 266     CFG_AWESOME_END()
 267 };
 268 cfg_opt_t rule_opts[] =
 269 {
 270     CFG_STR((char *) "xproperty_name", NULL, CFGF_NONE),
 271     CFG_STR((char *) "xproperty_value", NULL, CFGF_NONE),
 272     CFG_STR((char *) "name", NULL, CFGF_NONE),
 273     CFG_STR((char *) "tags", NULL, CFGF_NONE),
 274     CFG_STR((char *) "icon", NULL, CFGF_NONE),
 275     CFG_STR((char *) "float", (char *) "auto", CFGF_NONE),
 276     CFG_STR((char *) "master", (char *) "auto", CFGF_NONE),
 277     CFG_INT((char *) "screen", RULE_NOSCREEN, CFGF_NONE),
 278     CFG_FLOAT((char *) "opacity", -1.0f, CFGF_NONE),
 279     CFG_AWESOME_END()
 280 };
 281 cfg_opt_t rules_opts[] =
 282 {
 283     CFG_SEC((char *) "rule", rule_opts, CFGF_MULTI),
 284     CFG_AWESOME_END()
 285 };
 286 cfg_opt_t key_opts[] =
 287 {
 288     CFG_STR_LIST((char *) "modkey", (char *) "", CFGF_NONE),
 289     CFG_STR((char *) "key", (char *) "None", CFGF_NONE),
 290     CFG_STR((char *) "command", (char *) "", CFGF_NONE),
 291     CFG_STR((char *) "arg", NULL, CFGF_NONE),
 292     CFG_AWESOME_END()
 293 };
 294 cfg_opt_t keylist_opts[] =
 295 {
 296     CFG_STR_LIST((char *) "modkey", (char *) "", CFGF_NONE),
 297     CFG_STR_LIST((char *) "keylist", (char *) NULL, CFGF_NONE),
 298     CFG_STR((char *) "command", (char *) "", CFGF_NONE),
 299     CFG_STR_LIST((char *) "arglist", NULL, CFGF_NONE),
 300     CFG_AWESOME_END()
 301 };
 302 cfg_opt_t keys_opts[] =
 303 {
 304     CFG_SEC((char *) "key", key_opts, CFGF_MULTI),
 305     CFG_SEC((char *) "keylist", keylist_opts, CFGF_MULTI),
 306     CFG_AWESOME_END()
 307 };
 308 cfg_opt_t mouse_opts[] =
 309 {
 310     CFG_SEC((char *) "root", mouse_generic_opts, CFGF_MULTI),
 311     CFG_SEC((char *) "client", mouse_generic_opts, CFGF_MULTI),
 312     CFG_AWESOME_END()
 313 };
 314 cfg_opt_t awesome_opts[] =
 315 {
 316     CFG_SEC((char *) "screen", screen_opts, CFGF_TITLE | CFGF_MULTI | CFGF_NO_TITLE_DUPES),
 317     CFG_SEC((char *) "rules", rules_opts, CFGF_NONE),
 318     CFG_SEC((char *) "keys", keys_opts, CFGF_NONE),
 319     CFG_SEC((char *) "mouse", mouse_opts, CFGF_NONE),
 320     CFG_AWESOME_END()
 321 };
 322
 323 /** Return default configuration file path
 324  * \return path to the default configuration file
 325  */
 326 char *
 327 config_file(void)
 328 {
 329     const char *homedir;
 330     char * confpath;
 331     ssize_t confpath_len;
 332
 333     homedir = getenv("HOME");
 334     confpath_len = a_strlen(homedir) + a_strlen(AWESOME_CONFIG_FILE) + 2;
 335     confpath = p_new(char, confpath_len);
 336     a_strcpy(confpath, confpath_len, homedir);
 337     a_strcat(confpath, confpath_len, "/");
 338     a_strcat(confpath, confpath_len, AWESOME_CONFIG_FILE);
 339
 340     return confpath;
 341 }
 342
 343 /** Check configuration file syntax in regard of libconfuse parsing
 344  * \param path to config file
 345  * \return status returned by cfg_parse()
 346  */
 347 int
 348 config_check(const char *confpatharg)
 349 {
 350     cfg_t *cfg;
 351     int ret;
 352     char *confpath;
 353
 354     cfg = cfg_init(awesome_opts, CFGF_NONE);
 355
 356     if(confpatharg)
 357         confpath = a_strdup(confpatharg);
 358     else
 359         confpath = config_file();
 360
 361     switch((ret = cfg_parse(cfg, confpath)))
 362     {
 363       case CFG_FILE_ERROR:
 364         perror("awesome: parsing configuration file failed");
 365         break;
 366       case CFG_PARSE_ERROR:
 367         cfg_error(cfg, "awesome: parsing configuration file %s failed.\n", confpath);
 368         break;
 369       case CFG_SUCCESS:
 370         printf("Configuration file OK.\n");
 371         break;
 372     }
 373
 374     p_delete(&confpath);
 375
 376     return ret;
 377 }
 378
 379 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80