gri3-wm/src/load_layout.c

679 lines
25 KiB
C
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/*
* vim:ts=4:sw=4:expandtab
*
* i3 - an improved dynamic tiling window manager
* © 2009 Michael Stapelberg and contributors (see also: LICENSE)
*
* load_layout.c: Restore (parts of) the layout, for example after an inplace
* restart.
*
*/
#include "all.h"
#include <yajl/yajl_common.h>
#include <yajl/yajl_gen.h>
#include <yajl/yajl_parse.h>
#include <yajl/yajl_version.h>
/* TODO: refactor the whole parsing thing */
static char *last_key;
static int incomplete;
static Con *json_node;
static Con *to_focus;
static bool parsing_swallows;
static bool parsing_rect;
static bool parsing_deco_rect;
static bool parsing_window_rect;
static bool parsing_geometry;
static bool parsing_focus;
static bool parsing_marks;
struct Match *current_swallow;
static bool swallow_is_empty;
static int num_marks;
/* We need to save each container that needs to be marked if we want to support
* marking non-leaf containers. In their case, the end_map for their children is
* called before their own end_map, so marking json_node would end up marking
* the latest child. We can't just mark containers immediately after we parse a
* mark because of #2511. */
struct pending_marks {
char *mark;
Con *con_to_be_marked;
} * marks;
/* This list is used for reordering the focus stack after parsing the 'focus'
* array. */
struct focus_mapping {
int old_id;
TAILQ_ENTRY(focus_mapping)
focus_mappings;
};
static TAILQ_HEAD(focus_mappings_head, focus_mapping) focus_mappings =
TAILQ_HEAD_INITIALIZER(focus_mappings);
static int json_start_map(void *ctx) {
LOG("start of map, last_key = %s\n", last_key);
if (parsing_swallows) {
LOG("creating new swallow\n");
current_swallow = smalloc(sizeof(Match));
match_init(current_swallow);
current_swallow->dock = M_DONTCHECK;
TAILQ_INSERT_TAIL(&(json_node->swallow_head), current_swallow, matches);
swallow_is_empty = true;
} else {
if (!parsing_rect && !parsing_deco_rect && !parsing_window_rect && !parsing_geometry) {
if (last_key && strcasecmp(last_key, "floating_nodes") == 0) {
DLOG("New floating_node\n");
Con *ws = con_get_workspace(json_node);
json_node = con_new_skeleton(NULL, NULL);
json_node->name = NULL;
json_node->parent = ws;
DLOG("Parent is workspace = %p\n", ws);
} else {
Con *parent = json_node;
json_node = con_new_skeleton(NULL, NULL);
json_node->name = NULL;
json_node->parent = parent;
}
/* json_node is incomplete and should be removed if parsing fails */
incomplete++;
DLOG("incomplete = %d\n", incomplete);
}
}
return 1;
}
static int json_end_map(void *ctx) {
LOG("end of map\n");
if (!parsing_swallows && !parsing_rect && !parsing_deco_rect && !parsing_window_rect && !parsing_geometry) {
/* Set a few default values to simplify manually crafted layout files. */
if (json_node->layout == L_DEFAULT) {
DLOG("Setting layout = L_SPLITH\n");
json_node->layout = L_SPLITH;
}
/* Sanity check: swallow criteria dont make any sense on a split
* container. */
if (con_is_split(json_node) > 0 && !TAILQ_EMPTY(&(json_node->swallow_head))) {
DLOG("sanity check: removing swallows specification from split container\n");
while (!TAILQ_EMPTY(&(json_node->swallow_head))) {
Match *match = TAILQ_FIRST(&(json_node->swallow_head));
TAILQ_REMOVE(&(json_node->swallow_head), match, matches);
match_free(match);
free(match);
}
}
if (json_node->type == CT_WORKSPACE) {
/* Ensure the workspace has a name. */
DLOG("Attaching workspace. name = %s\n", json_node->name);
if (json_node->name == NULL || strcmp(json_node->name, "") == 0) {
json_node->name = sstrdup("unnamed");
}
/* Prevent name clashes when appending a workspace, e.g. when the
* user tries to restore a workspace called “1” but already has a
* workspace called “1”. */
char *base = sstrdup(json_node->name);
int cnt = 1;
while (get_existing_workspace_by_name(json_node->name) != NULL) {
FREE(json_node->name);
sasprintf(&(json_node->name), "%s_%d", base, cnt++);
}
free(base);
/* Set num accordingly so that i3bar will properly sort it. */
json_node->num = ws_name_to_number(json_node->name);
}
// When appending JSON layout files that only contain the workspace
// _contents_, we might not have an upfront signal that the
// container were currently parsing is a floating container (like
// the “floating_nodes” key of the workspace container itself).
// Thats why we make sure the con is attached at the right place
// in the hierarchy in case its floating.
if (json_node->type == CT_FLOATING_CON) {
DLOG("fixing parent which currently is %p / %s\n", json_node->parent, json_node->parent->name);
json_node->parent = con_get_workspace(json_node->parent);
// Also set a size if none was supplied, otherwise the placeholder
// window cannot be created as X11 requests with width=0 or
// height=0 are invalid.
if (rect_equals(json_node->rect, (Rect){0, 0, 0, 0})) {
DLOG("Geometry not set, combining children\n");
Con *child;
TAILQ_FOREACH (child, &(json_node->nodes_head), nodes) {
DLOG("child geometry: %d x %d\n", child->geometry.width, child->geometry.height);
json_node->rect.width += child->geometry.width;
json_node->rect.height = max(json_node->rect.height, child->geometry.height);
}
}
floating_check_size(json_node, false);
}
if (num_marks > 0) {
for (int i = 0; i < num_marks; i++) {
Con *con = marks[i].con_to_be_marked;
char *mark = marks[i].mark;
con_mark(con, mark, MM_ADD);
free(mark);
}
FREE(marks);
num_marks = 0;
}
LOG("attaching\n");
con_attach(json_node, json_node->parent, true);
LOG("Creating window\n");
x_con_init(json_node);
json_node = json_node->parent;
incomplete--;
DLOG("incomplete = %d\n", incomplete);
}
if (parsing_swallows && swallow_is_empty) {
/* We parsed an empty swallow definition. This is an invalid layout
* definition, hence we reject it. */
ELOG("Layout file is invalid: found an empty swallow definition.\n");
return 0;
}
parsing_rect = false;
parsing_deco_rect = false;
parsing_window_rect = false;
parsing_geometry = false;
return 1;
}
static int json_end_array(void *ctx) {
LOG("end of array\n");
if (!parsing_swallows && !parsing_focus && !parsing_marks) {
con_fix_percent(json_node);
}
if (parsing_swallows) {
parsing_swallows = false;
}
if (parsing_marks) {
parsing_marks = false;
}
if (parsing_focus) {
/* Clear the list of focus mappings */
struct focus_mapping *mapping;
TAILQ_FOREACH_REVERSE (mapping, &focus_mappings, focus_mappings_head, focus_mappings) {
LOG("focus (reverse) %d\n", mapping->old_id);
Con *con;
TAILQ_FOREACH (con, &(json_node->focus_head), focused) {
if (con->old_id != mapping->old_id)
continue;
LOG("got it! %p\n", con);
/* Move this entry to the top of the focus list. */
TAILQ_REMOVE(&(json_node->focus_head), con, focused);
TAILQ_INSERT_HEAD(&(json_node->focus_head), con, focused);
break;
}
}
while (!TAILQ_EMPTY(&focus_mappings)) {
mapping = TAILQ_FIRST(&focus_mappings);
TAILQ_REMOVE(&focus_mappings, mapping, focus_mappings);
free(mapping);
}
parsing_focus = false;
}
return 1;
}
static int json_key(void *ctx, const unsigned char *val, size_t len) {
LOG("key: %.*s\n", (int)len, val);
FREE(last_key);
last_key = scalloc(len + 1, 1);
memcpy(last_key, val, len);
if (strcasecmp(last_key, "swallows") == 0)
parsing_swallows = true;
if (strcasecmp(last_key, "rect") == 0)
parsing_rect = true;
if (strcasecmp(last_key, "deco_rect") == 0)
parsing_deco_rect = true;
if (strcasecmp(last_key, "window_rect") == 0)
parsing_window_rect = true;
if (strcasecmp(last_key, "geometry") == 0)
parsing_geometry = true;
if (strcasecmp(last_key, "focus") == 0)
parsing_focus = true;
if (strcasecmp(last_key, "marks") == 0) {
num_marks = 0;
parsing_marks = true;
}
return 1;
}
static int json_string(void *ctx, const unsigned char *val, size_t len) {
LOG("string: %.*s for key %s\n", (int)len, val, last_key);
if (parsing_swallows) {
char *sval;
sasprintf(&sval, "%.*s", len, val);
if (strcasecmp(last_key, "class") == 0) {
current_swallow->class = regex_new(sval);
swallow_is_empty = false;
} else if (strcasecmp(last_key, "instance") == 0) {
current_swallow->instance = regex_new(sval);
swallow_is_empty = false;
} else if (strcasecmp(last_key, "window_role") == 0) {
current_swallow->window_role = regex_new(sval);
swallow_is_empty = false;
} else if (strcasecmp(last_key, "title") == 0) {
current_swallow->title = regex_new(sval);
swallow_is_empty = false;
} else {
ELOG("swallow key %s unknown\n", last_key);
}
free(sval);
} else if (parsing_marks) {
char *mark;
sasprintf(&mark, "%.*s", (int)len, val);
marks = srealloc(marks, (++num_marks) * sizeof(struct pending_marks));
marks[num_marks - 1].mark = sstrdup(mark);
marks[num_marks - 1].con_to_be_marked = json_node;
} else {
if (strcasecmp(last_key, "name") == 0) {
json_node->name = scalloc(len + 1, 1);
memcpy(json_node->name, val, len);
} else if (strcasecmp(last_key, "title_format") == 0) {
json_node->title_format = scalloc(len + 1, 1);
memcpy(json_node->title_format, val, len);
} else if (strcasecmp(last_key, "sticky_group") == 0) {
json_node->sticky_group = scalloc(len + 1, 1);
memcpy(json_node->sticky_group, val, len);
LOG("sticky_group of this container is %s\n", json_node->sticky_group);
} else if (strcasecmp(last_key, "orientation") == 0) {
/* Upgrade path from older versions of i3 (doing an inplace restart
* to a newer version):
* "orientation" is dumped before "layout". Therefore, we store
* whether the orientation was horizontal or vertical in the
* last_split_layout. When we then encounter layout == "default",
* we will use the last_split_layout as layout instead. */
char *buf = NULL;
sasprintf(&buf, "%.*s", (int)len, val);
if (strcasecmp(buf, "none") == 0 ||
strcasecmp(buf, "horizontal") == 0)
json_node->last_split_layout = L_SPLITH;
else if (strcasecmp(buf, "vertical") == 0)
json_node->last_split_layout = L_SPLITV;
else
LOG("Unhandled orientation: %s\n", buf);
free(buf);
} else if (strcasecmp(last_key, "border") == 0) {
char *buf = NULL;
sasprintf(&buf, "%.*s", (int)len, val);
if (strcasecmp(buf, "none") == 0)
json_node->border_style = BS_NONE;
else if (strcasecmp(buf, "1pixel") == 0) {
json_node->border_style = BS_PIXEL;
json_node->current_border_width = 1;
} else if (strcasecmp(buf, "pixel") == 0)
json_node->border_style = BS_PIXEL;
else if (strcasecmp(buf, "normal") == 0)
json_node->border_style = BS_NORMAL;
else
LOG("Unhandled \"border\": %s\n", buf);
free(buf);
} else if (strcasecmp(last_key, "type") == 0) {
char *buf = NULL;
sasprintf(&buf, "%.*s", (int)len, val);
if (strcasecmp(buf, "root") == 0)
json_node->type = CT_ROOT;
else if (strcasecmp(buf, "output") == 0)
json_node->type = CT_OUTPUT;
else if (strcasecmp(buf, "con") == 0)
json_node->type = CT_CON;
else if (strcasecmp(buf, "floating_con") == 0)
json_node->type = CT_FLOATING_CON;
else if (strcasecmp(buf, "workspace") == 0)
json_node->type = CT_WORKSPACE;
else if (strcasecmp(buf, "dockarea") == 0)
json_node->type = CT_DOCKAREA;
else
LOG("Unhandled \"type\": %s\n", buf);
free(buf);
} else if (strcasecmp(last_key, "layout") == 0) {
char *buf = NULL;
sasprintf(&buf, "%.*s", (int)len, val);
if (strcasecmp(buf, "default") == 0)
/* This set above when we read "orientation". */
json_node->layout = json_node->last_split_layout;
else if (strcasecmp(buf, "stacked") == 0)
json_node->layout = L_STACKED;
else if (strcasecmp(buf, "tabbed") == 0)
json_node->layout = L_TABBED;
else if (strcasecmp(buf, "dockarea") == 0)
json_node->layout = L_DOCKAREA;
else if (strcasecmp(buf, "output") == 0)
json_node->layout = L_OUTPUT;
else if (strcasecmp(buf, "splith") == 0)
json_node->layout = L_SPLITH;
else if (strcasecmp(buf, "splitv") == 0)
json_node->layout = L_SPLITV;
else
LOG("Unhandled \"layout\": %s\n", buf);
free(buf);
} else if (strcasecmp(last_key, "workspace_layout") == 0) {
char *buf = NULL;
sasprintf(&buf, "%.*s", (int)len, val);
if (strcasecmp(buf, "default") == 0)
json_node->workspace_layout = L_DEFAULT;
else if (strcasecmp(buf, "stacked") == 0)
json_node->workspace_layout = L_STACKED;
else if (strcasecmp(buf, "tabbed") == 0)
json_node->workspace_layout = L_TABBED;
else
LOG("Unhandled \"workspace_layout\": %s\n", buf);
free(buf);
} else if (strcasecmp(last_key, "last_split_layout") == 0) {
char *buf = NULL;
sasprintf(&buf, "%.*s", (int)len, val);
if (strcasecmp(buf, "splith") == 0)
json_node->last_split_layout = L_SPLITH;
else if (strcasecmp(buf, "splitv") == 0)
json_node->last_split_layout = L_SPLITV;
else
LOG("Unhandled \"last_splitlayout\": %s\n", buf);
free(buf);
} else if (strcasecmp(last_key, "mark") == 0) {
DLOG("Found deprecated key \"mark\".\n");
char *buf = NULL;
sasprintf(&buf, "%.*s", (int)len, val);
con_mark(json_node, buf, MM_REPLACE);
} else if (strcasecmp(last_key, "floating") == 0) {
char *buf = NULL;
sasprintf(&buf, "%.*s", (int)len, val);
if (strcasecmp(buf, "auto_off") == 0)
json_node->floating = FLOATING_AUTO_OFF;
else if (strcasecmp(buf, "auto_on") == 0)
json_node->floating = FLOATING_AUTO_ON;
else if (strcasecmp(buf, "user_off") == 0)
json_node->floating = FLOATING_USER_OFF;
else if (strcasecmp(buf, "user_on") == 0)
json_node->floating = FLOATING_USER_ON;
free(buf);
} else if (strcasecmp(last_key, "scratchpad_state") == 0) {
char *buf = NULL;
sasprintf(&buf, "%.*s", (int)len, val);
if (strcasecmp(buf, "none") == 0)
json_node->scratchpad_state = SCRATCHPAD_NONE;
else if (strcasecmp(buf, "fresh") == 0)
json_node->scratchpad_state = SCRATCHPAD_FRESH;
else if (strcasecmp(buf, "changed") == 0)
json_node->scratchpad_state = SCRATCHPAD_CHANGED;
free(buf);
} else if (strcasecmp(last_key, "previous_workspace_name") == 0) {
FREE(previous_workspace_name);
previous_workspace_name = sstrndup((const char *)val, len);
}
}
return 1;
}
static int json_int(void *ctx, long long val) {
LOG("int %lld for key %s\n", val, last_key);
/* For backwards compatibility with i3 < 4.8 */
if (strcasecmp(last_key, "type") == 0)
json_node->type = val;
if (strcasecmp(last_key, "fullscreen_mode") == 0)
json_node->fullscreen_mode = val;
if (strcasecmp(last_key, "num") == 0)
json_node->num = val;
if (strcasecmp(last_key, "current_border_width") == 0)
json_node->current_border_width = val;
if (strcasecmp(last_key, "depth") == 0)
json_node->depth = val;
if (!parsing_swallows && strcasecmp(last_key, "id") == 0)
json_node->old_id = val;
if (parsing_focus) {
struct focus_mapping *focus_mapping = scalloc(1, sizeof(struct focus_mapping));
focus_mapping->old_id = val;
TAILQ_INSERT_TAIL(&focus_mappings, focus_mapping, focus_mappings);
}
if (parsing_rect || parsing_window_rect || parsing_geometry) {
Rect *r;
if (parsing_rect)
r = &(json_node->rect);
else if (parsing_window_rect)
r = &(json_node->window_rect);
else
r = &(json_node->geometry);
if (strcasecmp(last_key, "x") == 0)
r->x = val;
else if (strcasecmp(last_key, "y") == 0)
r->y = val;
else if (strcasecmp(last_key, "width") == 0)
r->width = val;
else if (strcasecmp(last_key, "height") == 0)
r->height = val;
else
ELOG("WARNING: unknown key %s in rect\n", last_key);
DLOG("rect now: (%d, %d, %d, %d)\n",
r->x, r->y, r->width, r->height);
}
if (parsing_swallows) {
if (strcasecmp(last_key, "id") == 0) {
current_swallow->id = val;
swallow_is_empty = false;
}
if (strcasecmp(last_key, "dock") == 0) {
current_swallow->dock = val;
swallow_is_empty = false;
}
if (strcasecmp(last_key, "insert_where") == 0) {
current_swallow->insert_where = val;
swallow_is_empty = false;
}
}
return 1;
}
static int json_bool(void *ctx, int val) {
LOG("bool %d for key %s\n", val, last_key);
if (strcasecmp(last_key, "focused") == 0 && val) {
to_focus = json_node;
}
if (strcasecmp(last_key, "sticky") == 0)
json_node->sticky = val;
if (parsing_swallows) {
if (strcasecmp(last_key, "restart_mode") == 0) {
current_swallow->restart_mode = val;
swallow_is_empty = false;
}
}
return 1;
}
static int json_double(void *ctx, double val) {
LOG("double %f for key %s\n", val, last_key);
if (strcasecmp(last_key, "percent") == 0) {
json_node->percent = val;
}
return 1;
}
static json_content_t content_result;
static int content_level;
static int json_determine_content_deeper(void *ctx) {
content_level++;
return 1;
}
static int json_determine_content_shallower(void *ctx) {
content_level--;
return 1;
}
static int json_determine_content_string(void *ctx, const unsigned char *val, size_t len) {
if (strcasecmp(last_key, "type") != 0 || content_level > 1)
return 1;
DLOG("string = %.*s, last_key = %s\n", (int)len, val, last_key);
if (strncasecmp((const char *)val, "workspace", len) == 0)
content_result = JSON_CONTENT_WORKSPACE;
return 0;
}
/*
* Returns true if the provided JSON could be parsed by yajl.
*
*/
bool json_validate(const char *buf, const size_t len) {
bool valid = true;
yajl_handle hand = yajl_alloc(NULL, NULL, NULL);
/* Allowing comments allows for more user-friendly layout files. */
yajl_config(hand, yajl_allow_comments, true);
/* Allow multiple values, i.e. multiple nodes to attach */
yajl_config(hand, yajl_allow_multiple_values, true);
setlocale(LC_NUMERIC, "C");
if (yajl_parse(hand, (const unsigned char *)buf, len) != yajl_status_ok) {
unsigned char *str = yajl_get_error(hand, 1, (const unsigned char *)buf, len);
ELOG("JSON parsing error: %s\n", str);
yajl_free_error(hand, str);
valid = false;
}
setlocale(LC_NUMERIC, "");
yajl_complete_parse(hand);
yajl_free(hand);
return valid;
}
/* Parses the given JSON file until it encounters the first “type” property to
* determine whether the file contains workspaces or regular containers, which
* is important to know when deciding where (and how) to append the contents.
* */
json_content_t json_determine_content(const char *buf, const size_t len) {
// We default to JSON_CONTENT_CON because it is legal to not include
// “"type": "con"” in the JSON files for better readability.
content_result = JSON_CONTENT_CON;
content_level = 0;
static yajl_callbacks callbacks = {
.yajl_string = json_determine_content_string,
.yajl_map_key = json_key,
.yajl_start_array = json_determine_content_deeper,
.yajl_start_map = json_determine_content_deeper,
.yajl_end_map = json_determine_content_shallower,
.yajl_end_array = json_determine_content_shallower,
};
yajl_handle hand = yajl_alloc(&callbacks, NULL, NULL);
/* Allowing comments allows for more user-friendly layout files. */
yajl_config(hand, yajl_allow_comments, true);
/* Allow multiple values, i.e. multiple nodes to attach */
yajl_config(hand, yajl_allow_multiple_values, true);
setlocale(LC_NUMERIC, "C");
const yajl_status stat = yajl_parse(hand, (const unsigned char *)buf, len);
if (stat != yajl_status_ok && stat != yajl_status_client_canceled) {
unsigned char *str = yajl_get_error(hand, 1, (const unsigned char *)buf, len);
ELOG("JSON parsing error: %s\n", str);
yajl_free_error(hand, str);
}
setlocale(LC_NUMERIC, "");
yajl_complete_parse(hand);
yajl_free(hand);
return content_result;
}
void tree_append_json(Con *con, const char *buf, const size_t len, char **errormsg) {
static yajl_callbacks callbacks = {
.yajl_boolean = json_bool,
.yajl_integer = json_int,
.yajl_double = json_double,
.yajl_string = json_string,
.yajl_start_map = json_start_map,
.yajl_map_key = json_key,
.yajl_end_map = json_end_map,
.yajl_end_array = json_end_array,
};
yajl_handle hand = yajl_alloc(&callbacks, NULL, NULL);
/* Allowing comments allows for more user-friendly layout files. */
yajl_config(hand, yajl_allow_comments, true);
/* Allow multiple values, i.e. multiple nodes to attach */
yajl_config(hand, yajl_allow_multiple_values, true);
/* We don't need to validate that the input is valid UTF8 here.
* tree_append_json is called in two cases:
* 1. With the append_layout command. json_validate is called first and will
* fail on invalid UTF8 characters so we don't need to recheck.
* 2. With an in-place restart. The rest of the codebase should be
* responsible for producing valid UTF8 JSON output. If not,
* tree_append_json will just preserve invalid UTF8 strings in the tree
* instead of failing to parse the layout file which could lead to
* problems like in #3156.
* Either way, disabling UTF8 validation slightly speeds up yajl. */
yajl_config(hand, yajl_dont_validate_strings, true);
json_node = con;
to_focus = NULL;
incomplete = 0;
parsing_swallows = false;
parsing_rect = false;
parsing_deco_rect = false;
parsing_window_rect = false;
parsing_geometry = false;
parsing_focus = false;
parsing_marks = false;
setlocale(LC_NUMERIC, "C");
const yajl_status stat = yajl_parse(hand, (const unsigned char *)buf, len);
if (stat != yajl_status_ok) {
unsigned char *str = yajl_get_error(hand, 1, (const unsigned char *)buf, len);
ELOG("JSON parsing error: %s\n", str);
if (errormsg != NULL)
*errormsg = sstrdup((const char *)str);
yajl_free_error(hand, str);
while (incomplete-- > 0) {
Con *parent = json_node->parent;
DLOG("freeing incomplete container %p\n", json_node);
if (json_node == to_focus) {
to_focus = NULL;
}
con_free(json_node);
json_node = parent;
}
}
/* In case not all containers were restored, we need to fix the
* percentages, otherwise i3 will crash immediately when rendering the
* next time. */
con_fix_percent(con);
setlocale(LC_NUMERIC, "");
yajl_complete_parse(hand);
yajl_free(hand);
if (to_focus) {
con_activate(to_focus);
}
}