git.sur5r.net Git - i3/i3/blob - src/load_layout.c

   1 #undef I3__FILE__
   2 #define I3__FILE__ "load_layout.c"
   3 /*
   4  * vim:ts=4:sw=4:expandtab
   5  *
   6  * i3 - an improved dynamic tiling window manager
   7  * © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE)
   8  *
   9  * load_layout.c: Restore (parts of) the layout, for example after an inplace
  10  *                restart.
  11  *
  12  */
  13 #include "all.h"
  14
  15 #include <yajl/yajl_common.h>
  16 #include <yajl/yajl_gen.h>
  17 #include <yajl/yajl_parse.h>
  18 #include <yajl/yajl_version.h>
  19
  20 /* TODO: refactor the whole parsing thing */
  21
  22 static char *last_key;
  23 static Con *json_node;
  24 static Con *to_focus;
  25 static bool parsing_swallows;
  26 static bool parsing_rect;
  27 static bool parsing_window_rect;
  28 static bool parsing_geometry;
  29 static bool parsing_focus;
  30 struct Match *current_swallow;
  31
  32 /* This list is used for reordering the focus stack after parsing the 'focus'
  33  * array. */
  34 struct focus_mapping {
  35     int old_id;
  36     TAILQ_ENTRY(focus_mapping) focus_mappings;
  37 };
  38
  39 static TAILQ_HEAD(focus_mappings_head, focus_mapping) focus_mappings =
  40   TAILQ_HEAD_INITIALIZER(focus_mappings);
  41
  42 static int json_start_map(void *ctx) {
  43     LOG("start of map, last_key = %s\n", last_key);
  44     if (parsing_swallows) {
  45         LOG("creating new swallow\n");
  46         current_swallow = smalloc(sizeof(Match));
  47         match_init(current_swallow);
  48         TAILQ_INSERT_TAIL(&(json_node->swallow_head), current_swallow, matches);
  49     } else {
  50         if (!parsing_rect && !parsing_window_rect && !parsing_geometry) {
  51             if (last_key && strcasecmp(last_key, "floating_nodes") == 0) {
  52                 DLOG("New floating_node\n");
  53                 Con *ws = con_get_workspace(json_node);
  54                 json_node = con_new_skeleton(NULL, NULL);
  55                 json_node->parent = ws;
  56                 DLOG("Parent is workspace = %p\n", ws);
  57             } else {
  58                 Con *parent = json_node;
  59                 json_node = con_new_skeleton(NULL, NULL);
  60                 json_node->parent = parent;
  61             }
  62         }
  63     }
  64     return 1;
  65 }
  66
  67 static int json_end_map(void *ctx) {
  68     LOG("end of map\n");
  69     if (!parsing_swallows && !parsing_rect && !parsing_window_rect && !parsing_geometry) {
  70         /* Set a few default values to simplify manually crafted layout files. */
  71         if (json_node->layout == L_DEFAULT) {
  72             DLOG("Setting layout = L_SPLITH\n");
  73             json_node->layout = L_SPLITH;
  74         }
  75
  76         /* Sanity check: swallow criteria don’t make any sense on a split
  77          * container. */
  78         if (con_is_split(json_node) > 0 && !TAILQ_EMPTY(&(json_node->swallow_head))) {
  79             DLOG("sanity check: removing swallows specification from split container\n");
  80             while (!TAILQ_EMPTY(&(json_node->swallow_head))) {
  81                 Match *match = TAILQ_FIRST(&(json_node->swallow_head));
  82                 TAILQ_REMOVE(&(json_node->swallow_head), match, matches);
  83                 match_free(match);
  84             }
  85         }
  86
  87         LOG("attaching\n");
  88         con_attach(json_node, json_node->parent, true);
  89         LOG("Creating window\n");
  90         x_con_init(json_node, json_node->depth);
  91         json_node = json_node->parent;
  92     }
  93     if (parsing_rect)
  94         parsing_rect = false;
  95     if (parsing_window_rect)
  96         parsing_window_rect = false;
  97     if (parsing_geometry)
  98         parsing_geometry = false;
  99     return 1;
 100 }
 101
 102 static int json_end_array(void *ctx) {
 103     LOG("end of array\n");
 104     if (!parsing_swallows && !parsing_focus) {
 105         con_fix_percent(json_node);
 106     }
 107     if (parsing_swallows) {
 108         parsing_swallows = false;
 109     }
 110     if (parsing_focus) {
 111         /* Clear the list of focus mappings */
 112         struct focus_mapping *mapping;
 113         TAILQ_FOREACH_REVERSE(mapping, &focus_mappings, focus_mappings_head, focus_mappings) {
 114             LOG("focus (reverse) %d\n", mapping->old_id);
 115             Con *con;
 116             TAILQ_FOREACH(con, &(json_node->focus_head), focused) {
 117                 if (con->old_id != mapping->old_id)
 118                     continue;
 119                 LOG("got it! %p\n", con);
 120                 /* Move this entry to the top of the focus list. */
 121                 TAILQ_REMOVE(&(json_node->focus_head), con, focused);
 122                 TAILQ_INSERT_HEAD(&(json_node->focus_head), con, focused);
 123                 break;
 124             }
 125         }
 126         while (!TAILQ_EMPTY(&focus_mappings)) {
 127             mapping = TAILQ_FIRST(&focus_mappings);
 128             TAILQ_REMOVE(&focus_mappings, mapping, focus_mappings);
 129             free(mapping);
 130         }
 131         parsing_focus = false;
 132     }
 133     return 1;
 134 }
 135
 136 static int json_key(void *ctx, const unsigned char *val, size_t len) {
 137     LOG("key: %.*s\n", (int)len, val);
 138     FREE(last_key);
 139     last_key = scalloc((len+1) * sizeof(char));
 140     memcpy(last_key, val, len);
 141     if (strcasecmp(last_key, "swallows") == 0)
 142         parsing_swallows = true;
 143
 144     if (strcasecmp(last_key, "rect") == 0)
 145         parsing_rect = true;
 146
 147     if (strcasecmp(last_key, "window_rect") == 0)
 148         parsing_window_rect = true;
 149
 150     if (strcasecmp(last_key, "geometry") == 0)
 151         parsing_geometry = true;
 152
 153     if (strcasecmp(last_key, "focus") == 0)
 154         parsing_focus = true;
 155
 156     return 1;
 157 }
 158
 159 static int json_string(void *ctx, const unsigned char *val, size_t len) {
 160     LOG("string: %.*s for key %s\n", (int)len, val, last_key);
 161     if (parsing_swallows) {
 162         char *sval;
 163         sasprintf(&sval, "%.*s", len, val);
 164         if (strcasecmp(last_key, "class") == 0) {
 165             current_swallow->class = regex_new(sval);
 166         } else if (strcasecmp(last_key, "instance") == 0) {
 167             current_swallow->instance = regex_new(sval);
 168         } else if (strcasecmp(last_key, "window_role") == 0) {
 169             current_swallow->window_role = regex_new(sval);
 170         } else if (strcasecmp(last_key, "title") == 0) {
 171             current_swallow->title = regex_new(sval);
 172         } else {
 173             ELOG("swallow key %s unknown\n", last_key);
 174         }
 175         free(sval);
 176     } else {
 177         if (strcasecmp(last_key, "name") == 0) {
 178             json_node->name = scalloc((len+1) * sizeof(char));
 179             memcpy(json_node->name, val, len);
 180         } else if (strcasecmp(last_key, "sticky_group") == 0) {
 181             json_node->sticky_group = scalloc((len+1) * sizeof(char));
 182             memcpy(json_node->sticky_group, val, len);
 183             LOG("sticky_group of this container is %s\n", json_node->sticky_group);
 184         } else if (strcasecmp(last_key, "orientation") == 0) {
 185             /* Upgrade path from older versions of i3 (doing an inplace restart
 186              * to a newer version):
 187              * "orientation" is dumped before "layout". Therefore, we store
 188              * whether the orientation was horizontal or vertical in the
 189              * last_split_layout. When we then encounter layout == "default",
 190              * we will use the last_split_layout as layout instead. */
 191             char *buf = NULL;
 192             sasprintf(&buf, "%.*s", (int)len, val);
 193             if (strcasecmp(buf, "none") == 0 ||
 194                 strcasecmp(buf, "horizontal") == 0)
 195                 json_node->last_split_layout = L_SPLITH;
 196             else if (strcasecmp(buf, "vertical") == 0)
 197                 json_node->last_split_layout = L_SPLITV;
 198             else LOG("Unhandled orientation: %s\n", buf);
 199             free(buf);
 200         } else if (strcasecmp(last_key, "border") == 0) {
 201             char *buf = NULL;
 202             sasprintf(&buf, "%.*s", (int)len, val);
 203             if (strcasecmp(buf, "none") == 0)
 204                 json_node->border_style = BS_NONE;
 205             else if (strcasecmp(buf, "1pixel") == 0) {
 206                 json_node->border_style = BS_PIXEL;
 207                 json_node->current_border_width = 1;
 208             } else if (strcasecmp(buf, "pixel") == 0)
 209                 json_node->border_style = BS_PIXEL;
 210             else if (strcasecmp(buf, "normal") == 0)
 211                 json_node->border_style = BS_NORMAL;
 212             else LOG("Unhandled \"border\": %s\n", buf);
 213             free(buf);
 214         } else if (strcasecmp(last_key, "type") == 0) {
 215             char *buf = NULL;
 216             sasprintf(&buf, "%.*s", (int)len, val);
 217             if (strcasecmp(buf, "root") == 0)
 218                 json_node->type = CT_ROOT;
 219             else if (strcasecmp(buf, "output") == 0)
 220                 json_node->type = CT_OUTPUT;
 221             else if (strcasecmp(buf, "con") == 0)
 222                 json_node->type = CT_CON;
 223             else if (strcasecmp(buf, "floating_con") == 0)
 224                 json_node->type = CT_FLOATING_CON;
 225             else if (strcasecmp(buf, "workspace") == 0)
 226                 json_node->type = CT_WORKSPACE;
 227             else if (strcasecmp(buf, "dockarea") == 0)
 228                 json_node->type = CT_DOCKAREA;
 229             else LOG("Unhandled \"type\": %s\n", buf);
 230             free(buf);
 231         } else if (strcasecmp(last_key, "layout") == 0) {
 232             char *buf = NULL;
 233             sasprintf(&buf, "%.*s", (int)len, val);
 234             if (strcasecmp(buf, "default") == 0)
 235                 /* This set above when we read "orientation". */
 236                 json_node->layout = json_node->last_split_layout;
 237             else if (strcasecmp(buf, "stacked") == 0)
 238                 json_node->layout = L_STACKED;
 239             else if (strcasecmp(buf, "tabbed") == 0)
 240                 json_node->layout = L_TABBED;
 241             else if (strcasecmp(buf, "dockarea") == 0)
 242                 json_node->layout = L_DOCKAREA;
 243             else if (strcasecmp(buf, "output") == 0)
 244                 json_node->layout = L_OUTPUT;
 245             else if (strcasecmp(buf, "splith") == 0)
 246                 json_node->layout = L_SPLITH;
 247             else if (strcasecmp(buf, "splitv") == 0)
 248                 json_node->layout = L_SPLITV;
 249             else LOG("Unhandled \"layout\": %s\n", buf);
 250             free(buf);
 251         } else if (strcasecmp(last_key, "workspace_layout") == 0) {
 252             char *buf = NULL;
 253             sasprintf(&buf, "%.*s", (int)len, val);
 254             if (strcasecmp(buf, "default") == 0)
 255                 json_node->workspace_layout = L_DEFAULT;
 256             else if (strcasecmp(buf, "stacked") == 0)
 257                 json_node->workspace_layout = L_STACKED;
 258             else if (strcasecmp(buf, "tabbed") == 0)
 259                 json_node->workspace_layout = L_TABBED;
 260             else LOG("Unhandled \"workspace_layout\": %s\n", buf);
 261             free(buf);
 262         } else if (strcasecmp(last_key, "last_split_layout") == 0) {
 263             char *buf = NULL;
 264             sasprintf(&buf, "%.*s", (int)len, val);
 265             if (strcasecmp(buf, "splith") == 0)
 266                 json_node->last_split_layout = L_SPLITH;
 267             else if (strcasecmp(buf, "splitv") == 0)
 268                 json_node->last_split_layout = L_SPLITV;
 269             else LOG("Unhandled \"last_splitlayout\": %s\n", buf);
 270             free(buf);
 271         } else if (strcasecmp(last_key, "mark") == 0) {
 272             char *buf = NULL;
 273             sasprintf(&buf, "%.*s", (int)len, val);
 274             json_node->mark = buf;
 275         } else if (strcasecmp(last_key, "floating") == 0) {
 276             char *buf = NULL;
 277             sasprintf(&buf, "%.*s", (int)len, val);
 278             if (strcasecmp(buf, "auto_off") == 0)
 279                 json_node->floating = FLOATING_AUTO_OFF;
 280             else if (strcasecmp(buf, "auto_on") == 0)
 281                 json_node->floating = FLOATING_AUTO_ON;
 282             else if (strcasecmp(buf, "user_off") == 0)
 283                 json_node->floating = FLOATING_USER_OFF;
 284             else if (strcasecmp(buf, "user_on") == 0)
 285                 json_node->floating = FLOATING_USER_ON;
 286             free(buf);
 287         } else if (strcasecmp(last_key, "scratchpad_state") == 0) {
 288             char *buf = NULL;
 289             sasprintf(&buf, "%.*s", (int)len, val);
 290             if (strcasecmp(buf, "none") == 0)
 291                 json_node->scratchpad_state = SCRATCHPAD_NONE;
 292             else if (strcasecmp(buf, "fresh") == 0)
 293                 json_node->scratchpad_state = SCRATCHPAD_FRESH;
 294             else if (strcasecmp(buf, "changed") == 0)
 295                 json_node->scratchpad_state = SCRATCHPAD_CHANGED;
 296             free(buf);
 297         }
 298     }
 299     return 1;
 300 }
 301
 302 static int json_int(void *ctx, long long val) {
 303     LOG("int %lld for key %s\n", val, last_key);
 304     /* For backwards compatibility with i3 < 4.8 */
 305     if (strcasecmp(last_key, "type") == 0)
 306         json_node->type = val;
 307
 308     if (strcasecmp(last_key, "fullscreen_mode") == 0)
 309         json_node->fullscreen_mode = val;
 310
 311     if (strcasecmp(last_key, "num") == 0)
 312         json_node->num = val;
 313
 314     if (strcasecmp(last_key, "current_border_width") == 0)
 315         json_node->current_border_width = val;
 316
 317     if (strcasecmp(last_key, "depth") == 0)
 318         json_node->depth = val;
 319
 320     if (!parsing_swallows && strcasecmp(last_key, "id") == 0)
 321         json_node->old_id = val;
 322
 323     if (parsing_focus) {
 324         struct focus_mapping *focus_mapping = scalloc(sizeof(struct focus_mapping));
 325         focus_mapping->old_id = val;
 326         TAILQ_INSERT_TAIL(&focus_mappings, focus_mapping, focus_mappings);
 327     }
 328
 329     if (parsing_rect || parsing_window_rect || parsing_geometry) {
 330         Rect *r;
 331         if (parsing_rect)
 332             r = &(json_node->rect);
 333         else if (parsing_window_rect)
 334             r = &(json_node->window_rect);
 335         else r = &(json_node->geometry);
 336         if (strcasecmp(last_key, "x") == 0)
 337             r->x = val;
 338         else if (strcasecmp(last_key, "y") == 0)
 339             r->y = val;
 340         else if (strcasecmp(last_key, "width") == 0)
 341             r->width = val;
 342         else if (strcasecmp(last_key, "height") == 0)
 343             r->height = val;
 344         else ELOG("WARNING: unknown key %s in rect\n", last_key);
 345         DLOG("rect now: (%d, %d, %d, %d)\n",
 346                 r->x, r->y, r->width, r->height);
 347     }
 348     if (parsing_swallows) {
 349         if (strcasecmp(last_key, "id") == 0) {
 350             current_swallow->id = val;
 351         }
 352         if (strcasecmp(last_key, "dock") == 0) {
 353             current_swallow->dock = val;
 354         }
 355         if (strcasecmp(last_key, "insert_where") == 0) {
 356             current_swallow->insert_where = val;
 357         }
 358     }
 359
 360     return 1;
 361 }
 362
 363 static int json_bool(void *ctx, int val) {
 364     LOG("bool %d for key %s\n", val, last_key);
 365     if (strcasecmp(last_key, "focused") == 0 && val) {
 366         to_focus = json_node;
 367     }
 368
 369     if (parsing_swallows) {
 370         if (strcasecmp(last_key, "restart_mode") == 0)
 371             current_swallow->restart_mode = val;
 372     }
 373
 374     return 1;
 375 }
 376
 377 static int json_double(void *ctx, double val) {
 378     LOG("double %f for key %s\n", val, last_key);
 379     if (strcasecmp(last_key, "percent") == 0) {
 380         json_node->percent = val;
 381     }
 382     return 1;
 383 }
 384
 385 void tree_append_json(Con *con, const char *filename, char **errormsg) {
 386     FILE *f;
 387     if ((f = fopen(filename, "r")) == NULL) {
 388         LOG("Cannot open file \"%s\"\n", filename);
 389         return;
 390     }
 391     struct stat stbuf;
 392     if (fstat(fileno(f), &stbuf) != 0) {
 393         LOG("Cannot fstat() the file\n");
 394         fclose(f);
 395         return;
 396     }
 397     char *buf = smalloc(stbuf.st_size);
 398     int n = fread(buf, 1, stbuf.st_size, f);
 399     if (n != stbuf.st_size) {
 400         LOG("File \"%s\" could not be read entirely, not loading.\n", filename);
 401         fclose(f);
 402         return;
 403     }
 404     LOG("read %d bytes\n", n);
 405     yajl_gen g;
 406     yajl_handle hand;
 407     static yajl_callbacks callbacks = {
 408         .yajl_boolean = json_bool,
 409         .yajl_integer = json_int,
 410         .yajl_double = json_double,
 411         .yajl_string = json_string,
 412         .yajl_start_map = json_start_map,
 413         .yajl_map_key = json_key,
 414         .yajl_end_map = json_end_map,
 415         .yajl_end_array = json_end_array,
 416     };
 417     g = yajl_gen_alloc(NULL);
 418     hand = yajl_alloc(&callbacks, NULL, (void*)g);
 419     /* Allowing comments allows for more user-friendly layout files. */
 420     yajl_config(hand, yajl_allow_comments, true);
 421     /* Allow multiple values, i.e. multiple nodes to attach */
 422     yajl_config(hand, yajl_allow_multiple_values, true);
 423     yajl_status stat;
 424     json_node = con;
 425     to_focus = NULL;
 426     parsing_swallows = false;
 427     parsing_rect = false;
 428     parsing_window_rect = false;
 429     parsing_geometry = false;
 430     parsing_focus = false;
 431     setlocale(LC_NUMERIC, "C");
 432     stat = yajl_parse(hand, (const unsigned char*)buf, n);
 433     if (stat != yajl_status_ok)
 434     {
 435         unsigned char *str = yajl_get_error(hand, 1, (const unsigned char*)buf, n);
 436         ELOG("JSON parsing error: %s\n", str);
 437         if (errormsg != NULL)
 438             *errormsg = sstrdup((const char*)str);
 439         yajl_free_error(hand, str);
 440     }
 441
 442     /* In case not all containers were restored, we need to fix the
 443      * percentages, otherwise i3 will crash immediately when rendering the
 444      * next time. */
 445     con_fix_percent(con);
 446
 447     setlocale(LC_NUMERIC, "");
 448     yajl_complete_parse(hand);
 449
 450     fclose(f);
 451     if (to_focus)
 452         con_focus(to_focus);
 453 }