2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
7 * load_layout.c: Restore (parts of) the layout, for example after an inplace
13 #include <yajl/yajl_common.h>
14 #include <yajl/yajl_gen.h>
15 #include <yajl/yajl_parse.h>
16 #include <yajl/yajl_version.h>
18 /* TODO: refactor the whole parsing thing */
20 static char *last_key;
21 static int incomplete;
22 static Con *json_node;
24 static bool parsing_swallows;
25 static bool parsing_rect;
26 static bool parsing_deco_rect;
27 static bool parsing_window_rect;
28 static bool parsing_geometry;
29 static bool parsing_focus;
30 static bool parsing_marks;
31 struct Match *current_swallow;
32 static bool swallow_is_empty;
36 /* This list is used for reordering the focus stack after parsing the 'focus'
38 struct focus_mapping {
41 TAILQ_ENTRY(focus_mapping)
45 static TAILQ_HEAD(focus_mappings_head, focus_mapping) focus_mappings =
46 TAILQ_HEAD_INITIALIZER(focus_mappings);
48 static int json_start_map(void *ctx) {
49 LOG("start of map, last_key = %s\n", last_key);
50 if (parsing_swallows) {
51 LOG("creating new swallow\n");
52 current_swallow = smalloc(sizeof(Match));
53 match_init(current_swallow);
54 current_swallow->dock = M_DONTCHECK;
55 TAILQ_INSERT_TAIL(&(json_node->swallow_head), current_swallow, matches);
56 swallow_is_empty = true;
58 if (!parsing_rect && !parsing_deco_rect && !parsing_window_rect && !parsing_geometry) {
59 if (last_key && strcasecmp(last_key, "floating_nodes") == 0) {
60 DLOG("New floating_node\n");
61 Con *ws = con_get_workspace(json_node);
62 json_node = con_new_skeleton(NULL, NULL);
63 json_node->name = NULL;
64 json_node->parent = ws;
65 DLOG("Parent is workspace = %p\n", ws);
67 Con *parent = json_node;
68 json_node = con_new_skeleton(NULL, NULL);
69 json_node->name = NULL;
70 json_node->parent = parent;
72 /* json_node is incomplete and should be removed if parsing fails */
74 DLOG("incomplete = %d\n", incomplete);
80 static int json_end_map(void *ctx) {
82 if (!parsing_swallows && !parsing_rect && !parsing_deco_rect && !parsing_window_rect && !parsing_geometry) {
83 /* Set a few default values to simplify manually crafted layout files. */
84 if (json_node->layout == L_DEFAULT) {
85 DLOG("Setting layout = L_SPLITH\n");
86 json_node->layout = L_SPLITH;
89 /* Sanity check: swallow criteria don’t make any sense on a split
91 if (con_is_split(json_node) > 0 && !TAILQ_EMPTY(&(json_node->swallow_head))) {
92 DLOG("sanity check: removing swallows specification from split container\n");
93 while (!TAILQ_EMPTY(&(json_node->swallow_head))) {
94 Match *match = TAILQ_FIRST(&(json_node->swallow_head));
95 TAILQ_REMOVE(&(json_node->swallow_head), match, matches);
101 if (json_node->type == CT_WORKSPACE) {
102 /* Ensure the workspace has a name. */
103 DLOG("Attaching workspace. name = %s\n", json_node->name);
104 if (json_node->name == NULL || strcmp(json_node->name, "") == 0) {
105 json_node->name = sstrdup("unnamed");
108 /* Prevent name clashes when appending a workspace, e.g. when the
109 * user tries to restore a workspace called “1” but already has a
110 * workspace called “1”. */
111 char *base = sstrdup(json_node->name);
113 while (get_existing_workspace_by_name(json_node->name) != NULL) {
114 FREE(json_node->name);
115 sasprintf(&(json_node->name), "%s_%d", base, cnt++);
119 /* Set num accordingly so that i3bar will properly sort it. */
120 json_node->num = ws_name_to_number(json_node->name);
123 // When appending JSON layout files that only contain the workspace
124 // _contents_, we might not have an upfront signal that the
125 // container we’re currently parsing is a floating container (like
126 // the “floating_nodes” key of the workspace container itself).
127 // That’s why we make sure the con is attached at the right place
128 // in the hierarchy in case it’s floating.
129 if (json_node->type == CT_FLOATING_CON) {
130 DLOG("fixing parent which currently is %p / %s\n", json_node->parent, json_node->parent->name);
131 json_node->parent = con_get_workspace(json_node->parent);
133 // Also set a size if none was supplied, otherwise the placeholder
134 // window cannot be created as X11 requests with width=0 or
135 // height=0 are invalid.
136 const Rect zero = {0, 0, 0, 0};
137 if (memcmp(&(json_node->rect), &zero, sizeof(Rect)) == 0) {
138 DLOG("Geometry not set, combining children\n");
140 TAILQ_FOREACH(child, &(json_node->nodes_head), nodes) {
141 DLOG("child geometry: %d x %d\n", child->geometry.width, child->geometry.height);
142 json_node->rect.width += child->geometry.width;
143 json_node->rect.height = max(json_node->rect.height, child->geometry.height);
147 floating_check_size(json_node);
151 for (int i = 0; i < num_marks; i++) {
152 con_mark(json_node, marks[i], MM_ADD);
162 con_attach(json_node, json_node->parent, true);
163 LOG("Creating window\n");
164 x_con_init(json_node);
165 json_node = json_node->parent;
167 DLOG("incomplete = %d\n", incomplete);
170 if (parsing_swallows && swallow_is_empty) {
171 /* We parsed an empty swallow definition. This is an invalid layout
172 * definition, hence we reject it. */
173 ELOG("Layout file is invalid: found an empty swallow definition.\n");
177 parsing_rect = false;
178 parsing_deco_rect = false;
179 parsing_window_rect = false;
180 parsing_geometry = false;
184 static int json_end_array(void *ctx) {
185 LOG("end of array\n");
186 if (!parsing_swallows && !parsing_focus && !parsing_marks) {
187 con_fix_percent(json_node);
189 if (parsing_swallows) {
190 parsing_swallows = false;
193 parsing_marks = false;
197 /* Clear the list of focus mappings */
198 struct focus_mapping *mapping;
199 TAILQ_FOREACH_REVERSE(mapping, &focus_mappings, focus_mappings_head, focus_mappings) {
200 LOG("focus (reverse) %d\n", mapping->old_id);
202 TAILQ_FOREACH(con, &(json_node->focus_head), focused) {
203 if (con->old_id != mapping->old_id)
205 LOG("got it! %p\n", con);
206 /* Move this entry to the top of the focus list. */
207 TAILQ_REMOVE(&(json_node->focus_head), con, focused);
208 TAILQ_INSERT_HEAD(&(json_node->focus_head), con, focused);
212 while (!TAILQ_EMPTY(&focus_mappings)) {
213 mapping = TAILQ_FIRST(&focus_mappings);
214 TAILQ_REMOVE(&focus_mappings, mapping, focus_mappings);
217 parsing_focus = false;
222 static int json_key(void *ctx, const unsigned char *val, size_t len) {
223 LOG("key: %.*s\n", (int)len, val);
225 last_key = scalloc(len + 1, 1);
226 memcpy(last_key, val, len);
227 if (strcasecmp(last_key, "swallows") == 0)
228 parsing_swallows = true;
230 if (strcasecmp(last_key, "rect") == 0)
233 if (strcasecmp(last_key, "deco_rect") == 0)
234 parsing_deco_rect = true;
236 if (strcasecmp(last_key, "window_rect") == 0)
237 parsing_window_rect = true;
239 if (strcasecmp(last_key, "geometry") == 0)
240 parsing_geometry = true;
242 if (strcasecmp(last_key, "focus") == 0)
243 parsing_focus = true;
245 if (strcasecmp(last_key, "marks") == 0) {
247 parsing_marks = true;
253 static int json_string(void *ctx, const unsigned char *val, size_t len) {
254 LOG("string: %.*s for key %s\n", (int)len, val, last_key);
255 if (parsing_swallows) {
257 sasprintf(&sval, "%.*s", len, val);
258 if (strcasecmp(last_key, "class") == 0) {
259 current_swallow->class = regex_new(sval);
260 swallow_is_empty = false;
261 } else if (strcasecmp(last_key, "instance") == 0) {
262 current_swallow->instance = regex_new(sval);
263 swallow_is_empty = false;
264 } else if (strcasecmp(last_key, "window_role") == 0) {
265 current_swallow->window_role = regex_new(sval);
266 swallow_is_empty = false;
267 } else if (strcasecmp(last_key, "title") == 0) {
268 current_swallow->title = regex_new(sval);
269 swallow_is_empty = false;
271 ELOG("swallow key %s unknown\n", last_key);
274 } else if (parsing_marks) {
276 sasprintf(&mark, "%.*s", (int)len, val);
278 marks = srealloc(marks, (++num_marks) * sizeof(char *));
279 marks[num_marks - 1] = sstrdup(mark);
281 if (strcasecmp(last_key, "name") == 0) {
282 json_node->name = scalloc(len + 1, 1);
283 memcpy(json_node->name, val, len);
284 } else if (strcasecmp(last_key, "title_format") == 0) {
285 json_node->title_format = scalloc(len + 1, 1);
286 memcpy(json_node->title_format, val, len);
287 } else if (strcasecmp(last_key, "sticky_group") == 0) {
288 json_node->sticky_group = scalloc(len + 1, 1);
289 memcpy(json_node->sticky_group, val, len);
290 LOG("sticky_group of this container is %s\n", json_node->sticky_group);
291 } else if (strcasecmp(last_key, "orientation") == 0) {
292 /* Upgrade path from older versions of i3 (doing an inplace restart
293 * to a newer version):
294 * "orientation" is dumped before "layout". Therefore, we store
295 * whether the orientation was horizontal or vertical in the
296 * last_split_layout. When we then encounter layout == "default",
297 * we will use the last_split_layout as layout instead. */
299 sasprintf(&buf, "%.*s", (int)len, val);
300 if (strcasecmp(buf, "none") == 0 ||
301 strcasecmp(buf, "horizontal") == 0)
302 json_node->last_split_layout = L_SPLITH;
303 else if (strcasecmp(buf, "vertical") == 0)
304 json_node->last_split_layout = L_SPLITV;
306 LOG("Unhandled orientation: %s\n", buf);
308 } else if (strcasecmp(last_key, "border") == 0) {
310 sasprintf(&buf, "%.*s", (int)len, val);
311 if (strcasecmp(buf, "none") == 0)
312 json_node->border_style = BS_NONE;
313 else if (strcasecmp(buf, "1pixel") == 0) {
314 json_node->border_style = BS_PIXEL;
315 json_node->current_border_width = 1;
316 } else if (strcasecmp(buf, "pixel") == 0)
317 json_node->border_style = BS_PIXEL;
318 else if (strcasecmp(buf, "normal") == 0)
319 json_node->border_style = BS_NORMAL;
321 LOG("Unhandled \"border\": %s\n", buf);
323 } else if (strcasecmp(last_key, "type") == 0) {
325 sasprintf(&buf, "%.*s", (int)len, val);
326 if (strcasecmp(buf, "root") == 0)
327 json_node->type = CT_ROOT;
328 else if (strcasecmp(buf, "output") == 0)
329 json_node->type = CT_OUTPUT;
330 else if (strcasecmp(buf, "con") == 0)
331 json_node->type = CT_CON;
332 else if (strcasecmp(buf, "floating_con") == 0)
333 json_node->type = CT_FLOATING_CON;
334 else if (strcasecmp(buf, "workspace") == 0)
335 json_node->type = CT_WORKSPACE;
336 else if (strcasecmp(buf, "dockarea") == 0)
337 json_node->type = CT_DOCKAREA;
339 LOG("Unhandled \"type\": %s\n", buf);
341 } else if (strcasecmp(last_key, "layout") == 0) {
343 sasprintf(&buf, "%.*s", (int)len, val);
344 if (strcasecmp(buf, "default") == 0)
345 /* This set above when we read "orientation". */
346 json_node->layout = json_node->last_split_layout;
347 else if (strcasecmp(buf, "stacked") == 0)
348 json_node->layout = L_STACKED;
349 else if (strcasecmp(buf, "tabbed") == 0)
350 json_node->layout = L_TABBED;
351 else if (strcasecmp(buf, "dockarea") == 0)
352 json_node->layout = L_DOCKAREA;
353 else if (strcasecmp(buf, "output") == 0)
354 json_node->layout = L_OUTPUT;
355 else if (strcasecmp(buf, "splith") == 0)
356 json_node->layout = L_SPLITH;
357 else if (strcasecmp(buf, "splitv") == 0)
358 json_node->layout = L_SPLITV;
360 LOG("Unhandled \"layout\": %s\n", buf);
362 } else if (strcasecmp(last_key, "workspace_layout") == 0) {
364 sasprintf(&buf, "%.*s", (int)len, val);
365 if (strcasecmp(buf, "default") == 0)
366 json_node->workspace_layout = L_DEFAULT;
367 else if (strcasecmp(buf, "stacked") == 0)
368 json_node->workspace_layout = L_STACKED;
369 else if (strcasecmp(buf, "tabbed") == 0)
370 json_node->workspace_layout = L_TABBED;
372 LOG("Unhandled \"workspace_layout\": %s\n", buf);
374 } else if (strcasecmp(last_key, "last_split_layout") == 0) {
376 sasprintf(&buf, "%.*s", (int)len, val);
377 if (strcasecmp(buf, "splith") == 0)
378 json_node->last_split_layout = L_SPLITH;
379 else if (strcasecmp(buf, "splitv") == 0)
380 json_node->last_split_layout = L_SPLITV;
382 LOG("Unhandled \"last_splitlayout\": %s\n", buf);
384 } else if (strcasecmp(last_key, "mark") == 0) {
385 DLOG("Found deprecated key \"mark\".\n");
388 sasprintf(&buf, "%.*s", (int)len, val);
390 con_mark(json_node, buf, MM_REPLACE);
391 } else if (strcasecmp(last_key, "floating") == 0) {
393 sasprintf(&buf, "%.*s", (int)len, val);
394 if (strcasecmp(buf, "auto_off") == 0)
395 json_node->floating = FLOATING_AUTO_OFF;
396 else if (strcasecmp(buf, "auto_on") == 0)
397 json_node->floating = FLOATING_AUTO_ON;
398 else if (strcasecmp(buf, "user_off") == 0)
399 json_node->floating = FLOATING_USER_OFF;
400 else if (strcasecmp(buf, "user_on") == 0)
401 json_node->floating = FLOATING_USER_ON;
403 } else if (strcasecmp(last_key, "scratchpad_state") == 0) {
405 sasprintf(&buf, "%.*s", (int)len, val);
406 if (strcasecmp(buf, "none") == 0)
407 json_node->scratchpad_state = SCRATCHPAD_NONE;
408 else if (strcasecmp(buf, "fresh") == 0)
409 json_node->scratchpad_state = SCRATCHPAD_FRESH;
410 else if (strcasecmp(buf, "changed") == 0)
411 json_node->scratchpad_state = SCRATCHPAD_CHANGED;
418 static int json_int(void *ctx, long long val) {
419 LOG("int %lld for key %s\n", val, last_key);
420 /* For backwards compatibility with i3 < 4.8 */
421 if (strcasecmp(last_key, "type") == 0)
422 json_node->type = val;
424 if (strcasecmp(last_key, "fullscreen_mode") == 0)
425 json_node->fullscreen_mode = val;
427 if (strcasecmp(last_key, "num") == 0)
428 json_node->num = val;
430 if (strcasecmp(last_key, "current_border_width") == 0)
431 json_node->current_border_width = val;
433 if (strcasecmp(last_key, "depth") == 0)
434 json_node->depth = val;
436 if (!parsing_swallows && strcasecmp(last_key, "id") == 0)
437 json_node->old_id = val;
440 struct focus_mapping *focus_mapping = scalloc(1, sizeof(struct focus_mapping));
441 focus_mapping->old_id = val;
442 TAILQ_INSERT_TAIL(&focus_mappings, focus_mapping, focus_mappings);
445 if (parsing_rect || parsing_window_rect || parsing_geometry) {
448 r = &(json_node->rect);
449 else if (parsing_window_rect)
450 r = &(json_node->window_rect);
452 r = &(json_node->geometry);
453 if (strcasecmp(last_key, "x") == 0)
455 else if (strcasecmp(last_key, "y") == 0)
457 else if (strcasecmp(last_key, "width") == 0)
459 else if (strcasecmp(last_key, "height") == 0)
462 ELOG("WARNING: unknown key %s in rect\n", last_key);
463 DLOG("rect now: (%d, %d, %d, %d)\n",
464 r->x, r->y, r->width, r->height);
466 if (parsing_swallows) {
467 if (strcasecmp(last_key, "id") == 0) {
468 current_swallow->id = val;
469 swallow_is_empty = false;
471 if (strcasecmp(last_key, "dock") == 0) {
472 current_swallow->dock = val;
473 swallow_is_empty = false;
475 if (strcasecmp(last_key, "insert_where") == 0) {
476 current_swallow->insert_where = val;
477 swallow_is_empty = false;
484 static int json_bool(void *ctx, int val) {
485 LOG("bool %d for key %s\n", val, last_key);
486 if (strcasecmp(last_key, "focused") == 0 && val) {
487 to_focus = json_node;
490 if (strcasecmp(last_key, "sticky") == 0)
491 json_node->sticky = val;
493 if (parsing_swallows) {
494 if (strcasecmp(last_key, "restart_mode") == 0) {
495 current_swallow->restart_mode = val;
496 swallow_is_empty = false;
503 static int json_double(void *ctx, double val) {
504 LOG("double %f for key %s\n", val, last_key);
505 if (strcasecmp(last_key, "percent") == 0) {
506 json_node->percent = val;
511 static json_content_t content_result;
512 static int content_level;
514 static int json_determine_content_deeper(void *ctx) {
519 static int json_determine_content_shallower(void *ctx) {
524 static int json_determine_content_string(void *ctx, const unsigned char *val, size_t len) {
525 if (strcasecmp(last_key, "type") != 0 || content_level > 1)
528 DLOG("string = %.*s, last_key = %s\n", (int)len, val, last_key);
529 if (strncasecmp((const char *)val, "workspace", len) == 0)
530 content_result = JSON_CONTENT_WORKSPACE;
535 * Returns true if the provided JSON could be parsed by yajl.
538 bool json_validate(const char *buf, const size_t len) {
540 yajl_handle hand = yajl_alloc(NULL, NULL, NULL);
541 /* Allowing comments allows for more user-friendly layout files. */
542 yajl_config(hand, yajl_allow_comments, true);
543 /* Allow multiple values, i.e. multiple nodes to attach */
544 yajl_config(hand, yajl_allow_multiple_values, true);
546 setlocale(LC_NUMERIC, "C");
547 if (yajl_parse(hand, (const unsigned char *)buf, len) != yajl_status_ok) {
548 unsigned char *str = yajl_get_error(hand, 1, (const unsigned char *)buf, len);
549 ELOG("JSON parsing error: %s\n", str);
550 yajl_free_error(hand, str);
553 setlocale(LC_NUMERIC, "");
555 yajl_complete_parse(hand);
561 /* Parses the given JSON file until it encounters the first “type” property to
562 * determine whether the file contains workspaces or regular containers, which
563 * is important to know when deciding where (and how) to append the contents.
565 json_content_t json_determine_content(const char *buf, const size_t len) {
566 // We default to JSON_CONTENT_CON because it is legal to not include
567 // “"type": "con"” in the JSON files for better readability.
568 content_result = JSON_CONTENT_CON;
570 static yajl_callbacks callbacks = {
571 .yajl_string = json_determine_content_string,
572 .yajl_map_key = json_key,
573 .yajl_start_array = json_determine_content_deeper,
574 .yajl_start_map = json_determine_content_deeper,
575 .yajl_end_map = json_determine_content_shallower,
576 .yajl_end_array = json_determine_content_shallower,
578 yajl_handle hand = yajl_alloc(&callbacks, NULL, NULL);
579 /* Allowing comments allows for more user-friendly layout files. */
580 yajl_config(hand, yajl_allow_comments, true);
581 /* Allow multiple values, i.e. multiple nodes to attach */
582 yajl_config(hand, yajl_allow_multiple_values, true);
583 setlocale(LC_NUMERIC, "C");
584 const yajl_status stat = yajl_parse(hand, (const unsigned char *)buf, len);
585 if (stat != yajl_status_ok && stat != yajl_status_client_canceled) {
586 unsigned char *str = yajl_get_error(hand, 1, (const unsigned char *)buf, len);
587 ELOG("JSON parsing error: %s\n", str);
588 yajl_free_error(hand, str);
591 setlocale(LC_NUMERIC, "");
592 yajl_complete_parse(hand);
595 return content_result;
598 void tree_append_json(Con *con, const char *buf, const size_t len, char **errormsg) {
599 static yajl_callbacks callbacks = {
600 .yajl_boolean = json_bool,
601 .yajl_integer = json_int,
602 .yajl_double = json_double,
603 .yajl_string = json_string,
604 .yajl_start_map = json_start_map,
605 .yajl_map_key = json_key,
606 .yajl_end_map = json_end_map,
607 .yajl_end_array = json_end_array,
609 yajl_handle hand = yajl_alloc(&callbacks, NULL, NULL);
610 /* Allowing comments allows for more user-friendly layout files. */
611 yajl_config(hand, yajl_allow_comments, true);
612 /* Allow multiple values, i.e. multiple nodes to attach */
613 yajl_config(hand, yajl_allow_multiple_values, true);
617 parsing_swallows = false;
618 parsing_rect = false;
619 parsing_deco_rect = false;
620 parsing_window_rect = false;
621 parsing_geometry = false;
622 parsing_focus = false;
623 parsing_marks = false;
624 setlocale(LC_NUMERIC, "C");
625 const yajl_status stat = yajl_parse(hand, (const unsigned char *)buf, len);
626 if (stat != yajl_status_ok) {
627 unsigned char *str = yajl_get_error(hand, 1, (const unsigned char *)buf, len);
628 ELOG("JSON parsing error: %s\n", str);
629 if (errormsg != NULL)
630 *errormsg = sstrdup((const char *)str);
631 yajl_free_error(hand, str);
632 while (incomplete-- > 0) {
633 Con *parent = json_node->parent;
634 DLOG("freeing incomplete container %p\n", json_node);
640 /* In case not all containers were restored, we need to fix the
641 * percentages, otherwise i3 will crash immediately when rendering the
643 con_fix_percent(con);
645 setlocale(LC_NUMERIC, "");
646 yajl_complete_parse(hand);
650 con_activate(to_focus);