]> git.sur5r.net Git - i3/i3/blob - src/load_layout.c
layout loading: allow comments in JSON files
[i3/i3] / 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         LOG("attaching\n");
77         con_attach(json_node, json_node->parent, true);
78         LOG("Creating window\n");
79         x_con_init(json_node, json_node->depth);
80         json_node = json_node->parent;
81     }
82     if (parsing_rect)
83         parsing_rect = false;
84     if (parsing_window_rect)
85         parsing_window_rect = false;
86     if (parsing_geometry)
87         parsing_geometry = false;
88     return 1;
89 }
90
91 static int json_end_array(void *ctx) {
92     LOG("end of array\n");
93     parsing_swallows = false;
94     if (parsing_focus) {
95         /* Clear the list of focus mappings */
96         struct focus_mapping *mapping;
97         TAILQ_FOREACH_REVERSE(mapping, &focus_mappings, focus_mappings_head, focus_mappings) {
98             LOG("focus (reverse) %d\n", mapping->old_id);
99             Con *con;
100             TAILQ_FOREACH(con, &(json_node->focus_head), focused) {
101                 if (con->old_id != mapping->old_id)
102                     continue;
103                 LOG("got it! %p\n", con);
104                 /* Move this entry to the top of the focus list. */
105                 TAILQ_REMOVE(&(json_node->focus_head), con, focused);
106                 TAILQ_INSERT_HEAD(&(json_node->focus_head), con, focused);
107                 break;
108             }
109         }
110         while (!TAILQ_EMPTY(&focus_mappings)) {
111             mapping = TAILQ_FIRST(&focus_mappings);
112             TAILQ_REMOVE(&focus_mappings, mapping, focus_mappings);
113             free(mapping);
114         }
115         parsing_focus = false;
116     }
117     return 1;
118 }
119
120 #if YAJL_MAJOR < 2
121 static int json_key(void *ctx, const unsigned char *val, unsigned int len) {
122 #else
123 static int json_key(void *ctx, const unsigned char *val, size_t len) {
124 #endif
125     LOG("key: %.*s\n", (int)len, val);
126     FREE(last_key);
127     last_key = scalloc((len+1) * sizeof(char));
128     memcpy(last_key, val, len);
129     if (strcasecmp(last_key, "swallows") == 0)
130         parsing_swallows = true;
131
132     if (strcasecmp(last_key, "rect") == 0)
133         parsing_rect = true;
134
135     if (strcasecmp(last_key, "window_rect") == 0)
136         parsing_window_rect = true;
137
138     if (strcasecmp(last_key, "geometry") == 0)
139         parsing_geometry = true;
140
141     if (strcasecmp(last_key, "focus") == 0)
142         parsing_focus = true;
143
144     return 1;
145 }
146
147 #if YAJL_MAJOR >= 2
148 static int json_string(void *ctx, const unsigned char *val, size_t len) {
149 #else
150 static int json_string(void *ctx, const unsigned char *val, unsigned int len) {
151 #endif
152     LOG("string: %.*s for key %s\n", (int)len, val, last_key);
153     if (parsing_swallows) {
154         /* TODO: the other swallowing keys */
155         if (strcasecmp(last_key, "class") == 0) {
156             char *sval;
157             sasprintf(&sval, "%.*s", len, val);
158             current_swallow->class = regex_new(sval);
159             free(sval);
160         } else {
161             ELOG("swallow key %s unknown\n", last_key);
162         }
163     } else {
164         if (strcasecmp(last_key, "name") == 0) {
165             json_node->name = scalloc((len+1) * sizeof(char));
166             memcpy(json_node->name, val, len);
167         } else if (strcasecmp(last_key, "sticky_group") == 0) {
168             json_node->sticky_group = scalloc((len+1) * sizeof(char));
169             memcpy(json_node->sticky_group, val, len);
170             LOG("sticky_group of this container is %s\n", json_node->sticky_group);
171         } else if (strcasecmp(last_key, "orientation") == 0) {
172             /* Upgrade path from older versions of i3 (doing an inplace restart
173              * to a newer version):
174              * "orientation" is dumped before "layout". Therefore, we store
175              * whether the orientation was horizontal or vertical in the
176              * last_split_layout. When we then encounter layout == "default",
177              * we will use the last_split_layout as layout instead. */
178             char *buf = NULL;
179             sasprintf(&buf, "%.*s", (int)len, val);
180             if (strcasecmp(buf, "none") == 0 ||
181                 strcasecmp(buf, "horizontal") == 0)
182                 json_node->last_split_layout = L_SPLITH;
183             else if (strcasecmp(buf, "vertical") == 0)
184                 json_node->last_split_layout = L_SPLITV;
185             else LOG("Unhandled orientation: %s\n", buf);
186             free(buf);
187         } else if (strcasecmp(last_key, "border") == 0) {
188             char *buf = NULL;
189             sasprintf(&buf, "%.*s", (int)len, val);
190             if (strcasecmp(buf, "none") == 0)
191                 json_node->border_style = BS_NONE;
192             else if (strcasecmp(buf, "1pixel") == 0) {
193                 json_node->border_style = BS_PIXEL;
194                 json_node->current_border_width = 1;
195             } else if (strcasecmp(buf, "pixel") == 0)
196                 json_node->border_style = BS_PIXEL;
197             else if (strcasecmp(buf, "normal") == 0)
198                 json_node->border_style = BS_NORMAL;
199             else LOG("Unhandled \"border\": %s\n", buf);
200             free(buf);
201         } else if (strcasecmp(last_key, "layout") == 0) {
202             char *buf = NULL;
203             sasprintf(&buf, "%.*s", (int)len, val);
204             if (strcasecmp(buf, "default") == 0)
205                 /* This set above when we read "orientation". */
206                 json_node->layout = json_node->last_split_layout;
207             else if (strcasecmp(buf, "stacked") == 0)
208                 json_node->layout = L_STACKED;
209             else if (strcasecmp(buf, "tabbed") == 0)
210                 json_node->layout = L_TABBED;
211             else if (strcasecmp(buf, "dockarea") == 0)
212                 json_node->layout = L_DOCKAREA;
213             else if (strcasecmp(buf, "output") == 0)
214                 json_node->layout = L_OUTPUT;
215             else if (strcasecmp(buf, "splith") == 0)
216                 json_node->layout = L_SPLITH;
217             else if (strcasecmp(buf, "splitv") == 0)
218                 json_node->layout = L_SPLITV;
219             else LOG("Unhandled \"layout\": %s\n", buf);
220             free(buf);
221         } else if (strcasecmp(last_key, "workspace_layout") == 0) {
222             char *buf = NULL;
223             sasprintf(&buf, "%.*s", (int)len, val);
224             if (strcasecmp(buf, "default") == 0)
225                 json_node->workspace_layout = L_DEFAULT;
226             else if (strcasecmp(buf, "stacked") == 0)
227                 json_node->workspace_layout = L_STACKED;
228             else if (strcasecmp(buf, "tabbed") == 0)
229                 json_node->workspace_layout = L_TABBED;
230             else LOG("Unhandled \"workspace_layout\": %s\n", buf);
231             free(buf);
232         } else if (strcasecmp(last_key, "last_split_layout") == 0) {
233             char *buf = NULL;
234             sasprintf(&buf, "%.*s", (int)len, val);
235             if (strcasecmp(buf, "splith") == 0)
236                 json_node->last_split_layout = L_SPLITH;
237             else if (strcasecmp(buf, "splitv") == 0)
238                 json_node->last_split_layout = L_SPLITV;
239             else LOG("Unhandled \"last_splitlayout\": %s\n", buf);
240             free(buf);
241         } else if (strcasecmp(last_key, "mark") == 0) {
242             char *buf = NULL;
243             sasprintf(&buf, "%.*s", (int)len, val);
244             json_node->mark = buf;
245         } else if (strcasecmp(last_key, "floating") == 0) {
246             char *buf = NULL;
247             sasprintf(&buf, "%.*s", (int)len, val);
248             if (strcasecmp(buf, "auto_off") == 0)
249                 json_node->floating = FLOATING_AUTO_OFF;
250             else if (strcasecmp(buf, "auto_on") == 0)
251                 json_node->floating = FLOATING_AUTO_ON;
252             else if (strcasecmp(buf, "user_off") == 0)
253                 json_node->floating = FLOATING_USER_OFF;
254             else if (strcasecmp(buf, "user_on") == 0)
255                 json_node->floating = FLOATING_USER_ON;
256             free(buf);
257         } else if (strcasecmp(last_key, "scratchpad_state") == 0) {
258             char *buf = NULL;
259             sasprintf(&buf, "%.*s", (int)len, val);
260             if (strcasecmp(buf, "none") == 0)
261                 json_node->scratchpad_state = SCRATCHPAD_NONE;
262             else if (strcasecmp(buf, "fresh") == 0)
263                 json_node->scratchpad_state = SCRATCHPAD_FRESH;
264             else if (strcasecmp(buf, "changed") == 0)
265                 json_node->scratchpad_state = SCRATCHPAD_CHANGED;
266             free(buf);
267         }
268     }
269     return 1;
270 }
271
272 #if YAJL_MAJOR >= 2
273 static int json_int(void *ctx, long long val) {
274     LOG("int %lld for key %s\n", val, last_key);
275 #else
276 static int json_int(void *ctx, long val) {
277     LOG("int %ld for key %s\n", val, last_key);
278 #endif
279     if (strcasecmp(last_key, "type") == 0)
280         json_node->type = val;
281
282     if (strcasecmp(last_key, "fullscreen_mode") == 0)
283         json_node->fullscreen_mode = val;
284
285     if (strcasecmp(last_key, "num") == 0)
286         json_node->num = val;
287
288     if (strcasecmp(last_key, "current_border_width") == 0)
289         json_node->current_border_width = val;
290
291     if (strcasecmp(last_key, "depth") == 0)
292         json_node->depth = val;
293
294     if (!parsing_swallows && strcasecmp(last_key, "id") == 0)
295         json_node->old_id = val;
296
297     if (parsing_focus) {
298         struct focus_mapping *focus_mapping = scalloc(sizeof(struct focus_mapping));
299         focus_mapping->old_id = val;
300         TAILQ_INSERT_TAIL(&focus_mappings, focus_mapping, focus_mappings);
301     }
302
303     if (parsing_rect || parsing_window_rect || parsing_geometry) {
304         Rect *r;
305         if (parsing_rect)
306             r = &(json_node->rect);
307         else if (parsing_window_rect)
308             r = &(json_node->window_rect);
309         else r = &(json_node->geometry);
310         if (strcasecmp(last_key, "x") == 0)
311             r->x = val;
312         else if (strcasecmp(last_key, "y") == 0)
313             r->y = val;
314         else if (strcasecmp(last_key, "width") == 0)
315             r->width = val;
316         else if (strcasecmp(last_key, "height") == 0)
317             r->height = val;
318         else printf("WARNING: unknown key %s in rect\n", last_key);
319         printf("rect now: (%d, %d, %d, %d)\n",
320                 r->x, r->y, r->width, r->height);
321     }
322     if (parsing_swallows) {
323         if (strcasecmp(last_key, "id") == 0) {
324             current_swallow->id = val;
325         }
326         if (strcasecmp(last_key, "dock") == 0) {
327             current_swallow->dock = val;
328         }
329         if (strcasecmp(last_key, "insert_where") == 0) {
330             current_swallow->insert_where = val;
331         }
332     }
333
334     return 1;
335 }
336
337 static int json_bool(void *ctx, int val) {
338     LOG("bool %d for key %s\n", val, last_key);
339     if (strcasecmp(last_key, "focused") == 0 && val) {
340         to_focus = json_node;
341     }
342
343     if (parsing_swallows) {
344         if (strcasecmp(last_key, "restart_mode") == 0)
345             current_swallow->restart_mode = val;
346     }
347
348     return 1;
349 }
350
351 static int json_double(void *ctx, double val) {
352     LOG("double %f for key %s\n", val, last_key);
353     if (strcasecmp(last_key, "percent") == 0) {
354         json_node->percent = val;
355     }
356     return 1;
357 }
358
359 void tree_append_json(const char *filename) {
360     /* TODO: percent of other windows are not correctly fixed at the moment */
361     FILE *f;
362     if ((f = fopen(filename, "r")) == NULL) {
363         LOG("Cannot open file \"%s\"\n", filename);
364         return;
365     }
366     struct stat stbuf;
367     if (fstat(fileno(f), &stbuf) != 0) {
368         LOG("Cannot fstat() the file\n");
369         fclose(f);
370         return;
371     }
372     char *buf = smalloc(stbuf.st_size);
373     int n = fread(buf, 1, stbuf.st_size, f);
374     if (n != stbuf.st_size) {
375         LOG("File \"%s\" could not be read entirely, not loading.\n", filename);
376         fclose(f);
377         return;
378     }
379     LOG("read %d bytes\n", n);
380     yajl_gen g;
381     yajl_handle hand;
382     yajl_callbacks callbacks;
383     memset(&callbacks, '\0', sizeof(yajl_callbacks));
384     callbacks.yajl_start_map = json_start_map;
385     callbacks.yajl_end_map = json_end_map;
386     callbacks.yajl_end_array = json_end_array;
387     callbacks.yajl_string = json_string;
388     callbacks.yajl_map_key = json_key;
389     callbacks.yajl_integer = json_int;
390     callbacks.yajl_double = json_double;
391     callbacks.yajl_boolean = json_bool;
392 #if YAJL_MAJOR >= 2
393     g = yajl_gen_alloc(NULL);
394     hand = yajl_alloc(&callbacks, NULL, (void*)g);
395 #else
396     g = yajl_gen_alloc(NULL, NULL);
397     hand = yajl_alloc(&callbacks, NULL, NULL, (void*)g);
398 #endif
399     /* Allowing comments allows for more user-friendly layout files. */
400     yajl_config(hand, yajl_allow_comments, true);
401     yajl_status stat;
402     json_node = focused;
403     to_focus = NULL;
404     parsing_rect = false;
405     parsing_window_rect = false;
406     parsing_geometry = false;
407     setlocale(LC_NUMERIC, "C");
408     stat = yajl_parse(hand, (const unsigned char*)buf, n);
409     if (stat != yajl_status_ok)
410     {
411         unsigned char * str = yajl_get_error(hand, 1, (const unsigned char*)buf, n);
412         fprintf(stderr, "%s\n", (const char *) str);
413         yajl_free_error(hand, str);
414     }
415
416     setlocale(LC_NUMERIC, "");
417 #if YAJL_MAJOR >= 2
418     yajl_complete_parse(hand);
419 #else
420     yajl_parse_complete(hand);
421 #endif
422
423     fclose(f);
424     if (to_focus)
425         con_focus(to_focus);
426 }