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_deco_rect;
  28 static bool parsing_window_rect;
  29 static bool parsing_geometry;
  30 static bool parsing_focus;
  31 struct Match *current_swallow;
  32
  33 /* This list is used for reordering the focus stack after parsing the 'focus'
  34  * array. */
  35 struct focus_mapping {
  36     int old_id;
  37     TAILQ_ENTRY(focus_mapping) focus_mappings;
  38 };
  39
  40 static TAILQ_HEAD(focus_mappings_head, focus_mapping) focus_mappings =
  41     TAILQ_HEAD_INITIALIZER(focus_mappings);
  42
  43 static int json_start_map(void *ctx) {
  44     LOG("start of map, last_key = %s\n", last_key);
  45     if (parsing_swallows) {
  46         LOG("creating new swallow\n");
  47         current_swallow = smalloc(sizeof(Match));
  48         match_init(current_swallow);
  49         TAILQ_INSERT_TAIL(&(json_node->swallow_head), current_swallow, matches);
  50     } else {
  51         if (!parsing_rect && !parsing_deco_rect && !parsing_window_rect && !parsing_geometry) {
  52             if (last_key && strcasecmp(last_key, "floating_nodes") == 0) {
  53                 DLOG("New floating_node\n");
  54                 Con *ws = con_get_workspace(json_node);
  55                 json_node = con_new_skeleton(NULL, NULL);
  56                 json_node->name = NULL;
  57                 json_node->parent = ws;
  58                 DLOG("Parent is workspace = %p\n", ws);
  59             } else {
  60                 Con *parent = json_node;
  61                 json_node = con_new_skeleton(NULL, NULL);
  62                 json_node->name = NULL;
  63                 json_node->parent = parent;
  64             }
  65         }
  66     }
  67     return 1;
  68 }
  69
  70 static int json_end_map(void *ctx) {
  71     LOG("end of map\n");
  72     if (!parsing_swallows && !parsing_rect && !parsing_deco_rect && !parsing_window_rect && !parsing_geometry) {
  73         /* Set a few default values to simplify manually crafted layout files. */
  74         if (json_node->layout == L_DEFAULT) {
  75             DLOG("Setting layout = L_SPLITH\n");
  76             json_node->layout = L_SPLITH;
  77         }
  78
  79         /* Sanity check: swallow criteria don’t make any sense on a split
  80          * container. */
  81         if (con_is_split(json_node) > 0 && !TAILQ_EMPTY(&(json_node->swallow_head))) {
  82             DLOG("sanity check: removing swallows specification from split container\n");
  83             while (!TAILQ_EMPTY(&(json_node->swallow_head))) {
  84                 Match *match = TAILQ_FIRST(&(json_node->swallow_head));
  85                 TAILQ_REMOVE(&(json_node->swallow_head), match, matches);
  86                 match_free(match);
  87             }
  88         }
  89
  90         if (json_node->type == CT_WORKSPACE) {
  91             /* Ensure the workspace has a name. */
  92             DLOG("Attaching workspace. name = %s\n", json_node->name);
  93             if (json_node->name == NULL || strcmp(json_node->name, "") == 0) {
  94                 json_node->name = sstrdup("unnamed");
  95             }
  96
  97             /* Prevent name clashes when appending a workspace, e.g. when the
  98              * user tries to restore a workspace called “1” but already has a
  99              * workspace called “1”. */
 100             Con *output;
 101             Con *workspace = NULL;
 102             TAILQ_FOREACH(output, &(croot->nodes_head), nodes)
 103             GREP_FIRST(workspace, output_get_content(output), !strcasecmp(child->name, json_node->name));
 104             char *base = sstrdup(json_node->name);
 105             int cnt = 1;
 106             while (workspace != NULL) {
 107                 FREE(json_node->name);
 108                 asprintf(&(json_node->name), "%s_%d", base, cnt++);
 109                 workspace = NULL;
 110                 TAILQ_FOREACH(output, &(croot->nodes_head), nodes)
 111                 GREP_FIRST(workspace, output_get_content(output), !strcasecmp(child->name, json_node->name));
 112             }
 113             free(base);
 114
 115             /* Set num accordingly so that i3bar will properly sort it. */
 116             json_node->num = ws_name_to_number(json_node->name);
 117         }
 118
 119         LOG("attaching\n");
 120         con_attach(json_node, json_node->parent, true);
 121         LOG("Creating window\n");
 122         x_con_init(json_node, json_node->depth);
 123         json_node = json_node->parent;
 124     }
 125
 126     parsing_rect = false;
 127     parsing_deco_rect = false;
 128     parsing_window_rect = false;
 129     parsing_geometry = false;
 130     return 1;
 131 }
 132
 133 static int json_end_array(void *ctx) {
 134     LOG("end of array\n");
 135     if (!parsing_swallows && !parsing_focus) {
 136         con_fix_percent(json_node);
 137     }
 138     if (parsing_swallows) {
 139         parsing_swallows = false;
 140     }
 141     if (parsing_focus) {
 142         /* Clear the list of focus mappings */
 143         struct focus_mapping *mapping;
 144         TAILQ_FOREACH_REVERSE(mapping, &focus_mappings, focus_mappings_head, focus_mappings) {
 145             LOG("focus (reverse) %d\n", mapping->old_id);
 146             Con *con;
 147             TAILQ_FOREACH(con, &(json_node->focus_head), focused) {
 148                 if (con->old_id != mapping->old_id)
 149                     continue;
 150                 LOG("got it! %p\n", con);
 151                 /* Move this entry to the top of the focus list. */
 152                 TAILQ_REMOVE(&(json_node->focus_head), con, focused);
 153                 TAILQ_INSERT_HEAD(&(json_node->focus_head), con, focused);
 154                 break;
 155             }
 156         }
 157         while (!TAILQ_EMPTY(&focus_mappings)) {
 158             mapping = TAILQ_FIRST(&focus_mappings);
 159             TAILQ_REMOVE(&focus_mappings, mapping, focus_mappings);
 160             free(mapping);
 161         }
 162         parsing_focus = false;
 163     }
 164     return 1;
 165 }
 166
 167 static int json_key(void *ctx, const unsigned char *val, size_t len) {
 168     LOG("key: %.*s\n", (int)len, val);
 169     FREE(last_key);
 170     last_key = scalloc((len + 1) * sizeof(char));
 171     memcpy(last_key, val, len);
 172     if (strcasecmp(last_key, "swallows") == 0)
 173         parsing_swallows = true;
 174
 175     if (strcasecmp(last_key, "rect") == 0)
 176         parsing_rect = true;
 177
 178     if (strcasecmp(last_key, "deco_rect") == 0)
 179         parsing_deco_rect = true;
 180
 181     if (strcasecmp(last_key, "window_rect") == 0)
 182         parsing_window_rect = true;
 183
 184     if (strcasecmp(last_key, "geometry") == 0)
 185         parsing_geometry = true;
 186
 187     if (strcasecmp(last_key, "focus") == 0)
 188         parsing_focus = true;
 189
 190     return 1;
 191 }
 192
 193 static int json_string(void *ctx, const unsigned char *val, size_t len) {
 194     LOG("string: %.*s for key %s\n", (int)len, val, last_key);
 195     if (parsing_swallows) {
 196         char *sval;
 197         sasprintf(&sval, "%.*s", len, val);
 198         if (strcasecmp(last_key, "class") == 0) {
 199             current_swallow->class = regex_new(sval);
 200         } else if (strcasecmp(last_key, "instance") == 0) {
 201             current_swallow->instance = regex_new(sval);
 202         } else if (strcasecmp(last_key, "window_role") == 0) {
 203             current_swallow->window_role = regex_new(sval);
 204         } else if (strcasecmp(last_key, "title") == 0) {
 205             current_swallow->title = regex_new(sval);
 206         } else {
 207             ELOG("swallow key %s unknown\n", last_key);
 208         }
 209         free(sval);
 210     } else {
 211         if (strcasecmp(last_key, "name") == 0) {
 212             json_node->name = scalloc((len + 1) * sizeof(char));
 213             memcpy(json_node->name, val, len);
 214         } else if (strcasecmp(last_key, "sticky_group") == 0) {
 215             json_node->sticky_group = scalloc((len + 1) * sizeof(char));
 216             memcpy(json_node->sticky_group, val, len);
 217             LOG("sticky_group of this container is %s\n", json_node->sticky_group);
 218         } else if (strcasecmp(last_key, "orientation") == 0) {
 219             /* Upgrade path from older versions of i3 (doing an inplace restart
 220              * to a newer version):
 221              * "orientation" is dumped before "layout". Therefore, we store
 222              * whether the orientation was horizontal or vertical in the
 223              * last_split_layout. When we then encounter layout == "default",
 224              * we will use the last_split_layout as layout instead. */
 225             char *buf = NULL;
 226             sasprintf(&buf, "%.*s", (int)len, val);
 227             if (strcasecmp(buf, "none") == 0 ||
 228                 strcasecmp(buf, "horizontal") == 0)
 229                 json_node->last_split_layout = L_SPLITH;
 230             else if (strcasecmp(buf, "vertical") == 0)
 231                 json_node->last_split_layout = L_SPLITV;
 232             else
 233                 LOG("Unhandled orientation: %s\n", buf);
 234             free(buf);
 235         } else if (strcasecmp(last_key, "border") == 0) {
 236             char *buf = NULL;
 237             sasprintf(&buf, "%.*s", (int)len, val);
 238             if (strcasecmp(buf, "none") == 0)
 239                 json_node->border_style = BS_NONE;
 240             else if (strcasecmp(buf, "1pixel") == 0) {
 241                 json_node->border_style = BS_PIXEL;
 242                 json_node->current_border_width = 1;
 243             } else if (strcasecmp(buf, "pixel") == 0)
 244                 json_node->border_style = BS_PIXEL;
 245             else if (strcasecmp(buf, "normal") == 0)
 246                 json_node->border_style = BS_NORMAL;
 247             else
 248                 LOG("Unhandled \"border\": %s\n", buf);
 249             free(buf);
 250         } else if (strcasecmp(last_key, "type") == 0) {
 251             char *buf = NULL;
 252             sasprintf(&buf, "%.*s", (int)len, val);
 253             if (strcasecmp(buf, "root") == 0)
 254                 json_node->type = CT_ROOT;
 255             else if (strcasecmp(buf, "output") == 0)
 256                 json_node->type = CT_OUTPUT;
 257             else if (strcasecmp(buf, "con") == 0)
 258                 json_node->type = CT_CON;
 259             else if (strcasecmp(buf, "floating_con") == 0)
 260                 json_node->type = CT_FLOATING_CON;
 261             else if (strcasecmp(buf, "workspace") == 0)
 262                 json_node->type = CT_WORKSPACE;
 263             else if (strcasecmp(buf, "dockarea") == 0)
 264                 json_node->type = CT_DOCKAREA;
 265             else
 266                 LOG("Unhandled \"type\": %s\n", buf);
 267             free(buf);
 268         } else if (strcasecmp(last_key, "layout") == 0) {
 269             char *buf = NULL;
 270             sasprintf(&buf, "%.*s", (int)len, val);
 271             if (strcasecmp(buf, "default") == 0)
 272                 /* This set above when we read "orientation". */
 273                 json_node->layout = json_node->last_split_layout;
 274             else if (strcasecmp(buf, "stacked") == 0)
 275                 json_node->layout = L_STACKED;
 276             else if (strcasecmp(buf, "tabbed") == 0)
 277                 json_node->layout = L_TABBED;
 278             else if (strcasecmp(buf, "dockarea") == 0)
 279                 json_node->layout = L_DOCKAREA;
 280             else if (strcasecmp(buf, "output") == 0)
 281                 json_node->layout = L_OUTPUT;
 282             else if (strcasecmp(buf, "splith") == 0)
 283                 json_node->layout = L_SPLITH;
 284             else if (strcasecmp(buf, "splitv") == 0)
 285                 json_node->layout = L_SPLITV;
 286             else
 287                 LOG("Unhandled \"layout\": %s\n", buf);
 288             free(buf);
 289         } else if (strcasecmp(last_key, "workspace_layout") == 0) {
 290             char *buf = NULL;
 291             sasprintf(&buf, "%.*s", (int)len, val);
 292             if (strcasecmp(buf, "default") == 0)
 293                 json_node->workspace_layout = L_DEFAULT;
 294             else if (strcasecmp(buf, "stacked") == 0)
 295                 json_node->workspace_layout = L_STACKED;
 296             else if (strcasecmp(buf, "tabbed") == 0)
 297                 json_node->workspace_layout = L_TABBED;
 298             else
 299                 LOG("Unhandled \"workspace_layout\": %s\n", buf);
 300             free(buf);
 301         } else if (strcasecmp(last_key, "last_split_layout") == 0) {
 302             char *buf = NULL;
 303             sasprintf(&buf, "%.*s", (int)len, val);
 304             if (strcasecmp(buf, "splith") == 0)
 305                 json_node->last_split_layout = L_SPLITH;
 306             else if (strcasecmp(buf, "splitv") == 0)
 307                 json_node->last_split_layout = L_SPLITV;
 308             else
 309                 LOG("Unhandled \"last_splitlayout\": %s\n", buf);
 310             free(buf);
 311         } else if (strcasecmp(last_key, "mark") == 0) {
 312             char *buf = NULL;
 313             sasprintf(&buf, "%.*s", (int)len, val);
 314             json_node->mark = buf;
 315         } else if (strcasecmp(last_key, "floating") == 0) {
 316             char *buf = NULL;
 317             sasprintf(&buf, "%.*s", (int)len, val);
 318             if (strcasecmp(buf, "auto_off") == 0)
 319                 json_node->floating = FLOATING_AUTO_OFF;
 320             else if (strcasecmp(buf, "auto_on") == 0)
 321                 json_node->floating = FLOATING_AUTO_ON;
 322             else if (strcasecmp(buf, "user_off") == 0)
 323                 json_node->floating = FLOATING_USER_OFF;
 324             else if (strcasecmp(buf, "user_on") == 0)
 325                 json_node->floating = FLOATING_USER_ON;
 326             free(buf);
 327         } else if (strcasecmp(last_key, "scratchpad_state") == 0) {
 328             char *buf = NULL;
 329             sasprintf(&buf, "%.*s", (int)len, val);
 330             if (strcasecmp(buf, "none") == 0)
 331                 json_node->scratchpad_state = SCRATCHPAD_NONE;
 332             else if (strcasecmp(buf, "fresh") == 0)
 333                 json_node->scratchpad_state = SCRATCHPAD_FRESH;
 334             else if (strcasecmp(buf, "changed") == 0)
 335                 json_node->scratchpad_state = SCRATCHPAD_CHANGED;
 336             free(buf);
 337         }
 338     }
 339     return 1;
 340 }
 341
 342 static int json_int(void *ctx, long long val) {
 343     LOG("int %lld for key %s\n", val, last_key);
 344     /* For backwards compatibility with i3 < 4.8 */
 345     if (strcasecmp(last_key, "type") == 0)
 346         json_node->type = val;
 347
 348     if (strcasecmp(last_key, "fullscreen_mode") == 0)
 349         json_node->fullscreen_mode = val;
 350
 351     if (strcasecmp(last_key, "num") == 0)
 352         json_node->num = val;
 353
 354     if (strcasecmp(last_key, "current_border_width") == 0)
 355         json_node->current_border_width = val;
 356
 357     if (strcasecmp(last_key, "depth") == 0)
 358         json_node->depth = val;
 359
 360     if (!parsing_swallows && strcasecmp(last_key, "id") == 0)
 361         json_node->old_id = val;
 362
 363     if (parsing_focus) {
 364         struct focus_mapping *focus_mapping = scalloc(sizeof(struct focus_mapping));
 365         focus_mapping->old_id = val;
 366         TAILQ_INSERT_TAIL(&focus_mappings, focus_mapping, focus_mappings);
 367     }
 368
 369     if (parsing_rect || parsing_window_rect || parsing_geometry) {
 370         Rect *r;
 371         if (parsing_rect)
 372             r = &(json_node->rect);
 373         else if (parsing_window_rect)
 374             r = &(json_node->window_rect);
 375         else
 376             r = &(json_node->geometry);
 377         if (strcasecmp(last_key, "x") == 0)
 378             r->x = val;
 379         else if (strcasecmp(last_key, "y") == 0)
 380             r->y = val;
 381         else if (strcasecmp(last_key, "width") == 0)
 382             r->width = val;
 383         else if (strcasecmp(last_key, "height") == 0)
 384             r->height = val;
 385         else
 386             ELOG("WARNING: unknown key %s in rect\n", last_key);
 387         DLOG("rect now: (%d, %d, %d, %d)\n",
 388              r->x, r->y, r->width, r->height);
 389     }
 390     if (parsing_swallows) {
 391         if (strcasecmp(last_key, "id") == 0) {
 392             current_swallow->id = val;
 393         }
 394         if (strcasecmp(last_key, "dock") == 0) {
 395             current_swallow->dock = val;
 396         }
 397         if (strcasecmp(last_key, "insert_where") == 0) {
 398             current_swallow->insert_where = val;
 399         }
 400     }
 401
 402     return 1;
 403 }
 404
 405 static int json_bool(void *ctx, int val) {
 406     LOG("bool %d for key %s\n", val, last_key);
 407     if (strcasecmp(last_key, "focused") == 0 && val) {
 408         to_focus = json_node;
 409     }
 410
 411     if (parsing_swallows) {
 412         if (strcasecmp(last_key, "restart_mode") == 0)
 413             current_swallow->restart_mode = val;
 414     }
 415
 416     return 1;
 417 }
 418
 419 static int json_double(void *ctx, double val) {
 420     LOG("double %f for key %s\n", val, last_key);
 421     if (strcasecmp(last_key, "percent") == 0) {
 422         json_node->percent = val;
 423     }
 424     return 1;
 425 }
 426
 427 static json_content_t content_result;
 428
 429 static int json_determine_content_string(void *ctx, const unsigned char *val, size_t len) {
 430     if (strcasecmp(last_key, "type") != 0)
 431         return 1;
 432
 433     DLOG("string = %.*s, last_key = %s\n", (int)len, val, last_key);
 434     if (strncasecmp((const char *)val, "workspace", len) == 0)
 435         content_result = JSON_CONTENT_WORKSPACE;
 436     return 0;
 437 }
 438
 439 /* Parses the given JSON file until it encounters the first “type” property to
 440  * determine whether the file contains workspaces or regular containers, which
 441  * is important to know when deciding where (and how) to append the contents.
 442  * */
 443 json_content_t json_determine_content(const char *filename) {
 444     FILE *f;
 445     if ((f = fopen(filename, "r")) == NULL) {
 446         ELOG("Cannot open file \"%s\"\n", filename);
 447         return JSON_CONTENT_UNKNOWN;
 448     }
 449     struct stat stbuf;
 450     if (fstat(fileno(f), &stbuf) != 0) {
 451         ELOG("Cannot fstat() \"%s\"\n", filename);
 452         fclose(f);
 453         return JSON_CONTENT_UNKNOWN;
 454     }
 455     char *buf = smalloc(stbuf.st_size);
 456     int n = fread(buf, 1, stbuf.st_size, f);
 457     if (n != stbuf.st_size) {
 458         ELOG("File \"%s\" could not be read entirely, not loading.\n", filename);
 459         fclose(f);
 460         return JSON_CONTENT_UNKNOWN;
 461     }
 462     DLOG("read %d bytes\n", n);
 463     // We default to JSON_CONTENT_CON because it is legal to not include
 464     // “"type": "con"” in the JSON files for better readability.
 465     content_result = JSON_CONTENT_CON;
 466     yajl_gen g;
 467     yajl_handle hand;
 468     static yajl_callbacks callbacks = {
 469         .yajl_string = json_determine_content_string,
 470         .yajl_map_key = json_key,
 471     };
 472     g = yajl_gen_alloc(NULL);
 473     hand = yajl_alloc(&callbacks, NULL, (void *)g);
 474     /* Allowing comments allows for more user-friendly layout files. */
 475     yajl_config(hand, yajl_allow_comments, true);
 476     /* Allow multiple values, i.e. multiple nodes to attach */
 477     yajl_config(hand, yajl_allow_multiple_values, true);
 478     yajl_status stat;
 479     setlocale(LC_NUMERIC, "C");
 480     stat = yajl_parse(hand, (const unsigned char *)buf, n);
 481     if (stat != yajl_status_ok && stat != yajl_status_client_canceled) {
 482         unsigned char *str = yajl_get_error(hand, 1, (const unsigned char *)buf, n);
 483         ELOG("JSON parsing error: %s\n", str);
 484         yajl_free_error(hand, str);
 485     }
 486
 487     setlocale(LC_NUMERIC, "");
 488     yajl_complete_parse(hand);
 489
 490     fclose(f);
 491
 492     return content_result;
 493 }
 494
 495 void tree_append_json(Con *con, const char *filename, char **errormsg) {
 496     FILE *f;
 497     if ((f = fopen(filename, "r")) == NULL) {
 498         ELOG("Cannot open file \"%s\"\n", filename);
 499         return;
 500     }
 501     struct stat stbuf;
 502     if (fstat(fileno(f), &stbuf) != 0) {
 503         ELOG("Cannot fstat() \"%s\"\n", filename);
 504         fclose(f);
 505         return;
 506     }
 507     char *buf = smalloc(stbuf.st_size);
 508     int n = fread(buf, 1, stbuf.st_size, f);
 509     if (n != stbuf.st_size) {
 510         ELOG("File \"%s\" could not be read entirely, not loading.\n", filename);
 511         fclose(f);
 512         return;
 513     }
 514     DLOG("read %d bytes\n", n);
 515     yajl_gen g;
 516     yajl_handle hand;
 517     static yajl_callbacks callbacks = {
 518         .yajl_boolean = json_bool,
 519         .yajl_integer = json_int,
 520         .yajl_double = json_double,
 521         .yajl_string = json_string,
 522         .yajl_start_map = json_start_map,
 523         .yajl_map_key = json_key,
 524         .yajl_end_map = json_end_map,
 525         .yajl_end_array = json_end_array,
 526     };
 527     g = yajl_gen_alloc(NULL);
 528     hand = yajl_alloc(&callbacks, NULL, (void *)g);
 529     /* Allowing comments allows for more user-friendly layout files. */
 530     yajl_config(hand, yajl_allow_comments, true);
 531     /* Allow multiple values, i.e. multiple nodes to attach */
 532     yajl_config(hand, yajl_allow_multiple_values, true);
 533     yajl_status stat;
 534     json_node = con;
 535     to_focus = NULL;
 536     parsing_swallows = false;
 537     parsing_rect = false;
 538     parsing_deco_rect = false;
 539     parsing_window_rect = false;
 540     parsing_geometry = false;
 541     parsing_focus = false;
 542     setlocale(LC_NUMERIC, "C");
 543     stat = yajl_parse(hand, (const unsigned char *)buf, n);
 544     if (stat != yajl_status_ok) {
 545         unsigned char *str = yajl_get_error(hand, 1, (const unsigned char *)buf, n);
 546         ELOG("JSON parsing error: %s\n", str);
 547         if (errormsg != NULL)
 548             *errormsg = sstrdup((const char *)str);
 549         yajl_free_error(hand, str);
 550     }
 551
 552     /* In case not all containers were restored, we need to fix the
 553      * percentages, otherwise i3 will crash immediately when rendering the
 554      * next time. */
 555     con_fix_percent(con);
 556
 557     setlocale(LC_NUMERIC, "");
 558     yajl_complete_parse(hand);
 559
 560     fclose(f);
 561     if (to_focus)
 562         con_focus(to_focus);
 563 }