2 * vim:ts=4:sw=4:expandtab
4 * i3bar - an xcb-based status- and ws-bar for i3
5 * © 2010-2012 Axel Wagner and contributors (see also: LICENSE)
7 * child.c: Getting Input for the statusline
12 #include <sys/types.h>
22 #include <yajl/yajl_common.h>
23 #include <yajl/yajl_parse.h>
24 #include <yajl/yajl_version.h>
25 #include <yajl/yajl_gen.h>
30 /* Global variables for child_*() */
33 /* stdin- and SIGCHLD-watchers */
37 /* JSON parser for stdin */
40 /* JSON generator for stdout */
43 typedef struct parser_ctx {
44 /* True if one of the parsed blocks was urgent */
47 /* A copy of the last JSON map key. */
50 /* The current block. Will be filled, then copied and put into the list of
52 struct status_block block;
55 parser_ctx parser_context;
57 struct statusline_head statusline_head = TAILQ_HEAD_INITIALIZER(statusline_head);
58 /* Used temporarily while reading a statusline */
59 struct statusline_head statusline_buffer = TAILQ_HEAD_INITIALIZER(statusline_buffer);
64 * Remove all blocks from the given statusline.
65 * If free_resources is set, the fields of each status block will be free'd.
67 static void clear_statusline(struct statusline_head *head, bool free_resources) {
68 struct status_block *first;
69 while (!TAILQ_EMPTY(head)) {
70 first = TAILQ_FIRST(head);
72 I3STRING_FREE(first->full_text);
73 I3STRING_FREE(first->short_text);
76 FREE(first->instance);
77 FREE(first->min_width_str);
80 TAILQ_REMOVE(head, first, blocks);
85 static void copy_statusline(struct statusline_head *from, struct statusline_head *to) {
86 struct status_block *current;
87 TAILQ_FOREACH(current, from, blocks) {
88 struct status_block *new_block = smalloc(sizeof(struct status_block));
89 memcpy(new_block, current, sizeof(struct status_block));
90 TAILQ_INSERT_TAIL(to, new_block, blocks);
95 * Replaces the statusline in memory with an error message. Pass a format
96 * string and format parameters as you would in `printf'. The next time
97 * `draw_bars' is called, the error message text will be drawn on the bar in
98 * the space allocated for the statusline.
100 __attribute__((format(printf, 1, 2))) static void set_statusline_error(const char *format, ...) {
101 clear_statusline(&statusline_head, true);
105 va_start(args, format);
106 vasprintf(&message, format, args);
108 struct status_block *err_block = scalloc(sizeof(struct status_block));
109 err_block->full_text = i3string_from_utf8("Error: ");
110 err_block->name = "error";
111 err_block->color = "red";
112 err_block->no_separator = true;
114 struct status_block *message_block = scalloc(sizeof(struct status_block));
115 message_block->full_text = i3string_from_utf8(message);
116 message_block->name = "error_message";
117 message_block->color = "red";
118 message_block->no_separator = true;
120 TAILQ_INSERT_HEAD(&statusline_head, err_block, blocks);
121 TAILQ_INSERT_TAIL(&statusline_head, message_block, blocks);
128 * Stop and free() the stdin- and SIGCHLD-watchers
132 if (stdin_io != NULL) {
133 ev_io_stop(main_loop, stdin_io);
137 if (child_sig != NULL) {
138 ev_child_stop(main_loop, child_sig);
142 memset(&child, 0, sizeof(i3bar_child));
146 * The start of a new array is the start of a new status line, so we clear all
147 * previous entries from the buffer.
149 static int stdin_start_array(void *context) {
150 // the blocks are still used by statusline_head, so we won't free the
152 clear_statusline(&statusline_buffer, false);
157 * The start of a map is the start of a single block of the status line.
160 static int stdin_start_map(void *context) {
161 parser_ctx *ctx = context;
162 memset(&(ctx->block), '\0', sizeof(struct status_block));
164 /* Default width of the separator block. */
165 ctx->block.sep_block_width = logical_px(9);
167 /* Use markup by default */
168 ctx->block.is_markup = true;
173 static int stdin_map_key(void *context, const unsigned char *key, size_t len) {
174 parser_ctx *ctx = context;
175 FREE(ctx->last_map_key);
176 sasprintf(&(ctx->last_map_key), "%.*s", len, key);
180 static int stdin_boolean(void *context, int val) {
181 parser_ctx *ctx = context;
182 if (strcasecmp(ctx->last_map_key, "urgent") == 0) {
183 ctx->block.urgent = val;
185 if (strcasecmp(ctx->last_map_key, "separator") == 0) {
186 ctx->block.no_separator = !val;
191 static int stdin_string(void *context, const unsigned char *val, size_t len) {
192 parser_ctx *ctx = context;
193 if (strcasecmp(ctx->last_map_key, "full_text") == 0) {
194 ctx->block.full_text = i3string_from_markup_with_length((const char *)val, len);
196 if (strcasecmp(ctx->last_map_key, "short_text") == 0) {
197 ctx->block.short_text = i3string_from_markup_with_length((const char *)val, len);
199 if (strcasecmp(ctx->last_map_key, "color") == 0) {
200 sasprintf(&(ctx->block.color), "%.*s", len, val);
202 if (strcasecmp(ctx->last_map_key, "markup") == 0) {
203 ctx->block.is_markup = (len == strlen("pango") && !strncasecmp((const char *)val, "pango", strlen("pango")));
205 if (strcasecmp(ctx->last_map_key, "align") == 0) {
206 if (len == strlen("center") && !strncmp((const char *)val, "center", strlen("center"))) {
207 ctx->block.align = ALIGN_CENTER;
208 } else if (len == strlen("right") && !strncmp((const char *)val, "right", strlen("right"))) {
209 ctx->block.align = ALIGN_RIGHT;
211 ctx->block.align = ALIGN_LEFT;
213 } else if (strcasecmp(ctx->last_map_key, "min_width") == 0) {
214 char *copy = (char *)malloc(len + 1);
215 strncpy(copy, (const char *)val, len);
217 ctx->block.min_width_str = copy;
219 if (strcasecmp(ctx->last_map_key, "name") == 0) {
220 char *copy = (char *)malloc(len + 1);
221 strncpy(copy, (const char *)val, len);
223 ctx->block.name = copy;
225 if (strcasecmp(ctx->last_map_key, "instance") == 0) {
226 char *copy = (char *)malloc(len + 1);
227 strncpy(copy, (const char *)val, len);
229 ctx->block.instance = copy;
234 static int stdin_integer(void *context, long long val) {
235 parser_ctx *ctx = context;
236 if (strcasecmp(ctx->last_map_key, "min_width") == 0) {
237 ctx->block.min_width = (uint32_t)val;
239 if (strcasecmp(ctx->last_map_key, "separator_block_width") == 0) {
240 ctx->block.sep_block_width = (uint32_t)val;
246 * When a map is finished, we have an entire status block.
247 * Move it from the parser's context to the statusline buffer.
249 static int stdin_end_map(void *context) {
250 parser_ctx *ctx = context;
251 struct status_block *new_block = smalloc(sizeof(struct status_block));
252 memcpy(new_block, &(ctx->block), sizeof(struct status_block));
253 /* Ensure we have a full_text set, so that when it is missing (or null),
254 * i3bar doesn’t crash and the user gets an annoying message. */
255 if (!new_block->full_text)
256 new_block->full_text = i3string_from_utf8("SPEC VIOLATION: full_text is NULL!");
257 if (new_block->urgent)
258 ctx->has_urgent = true;
260 if (new_block->min_width_str) {
261 i3String *text = i3string_from_utf8(new_block->min_width_str);
262 i3string_set_markup(text, new_block->is_markup);
263 new_block->min_width = (uint32_t)predict_text_width(text);
267 i3string_set_markup(new_block->full_text, new_block->is_markup);
268 i3string_set_markup(new_block->short_text, new_block->is_markup);
270 TAILQ_INSERT_TAIL(&statusline_buffer, new_block, blocks);
275 * When an array is finished, we have an entire statusline.
276 * Copy it from the buffer to the actual statusline.
278 static int stdin_end_array(void *context) {
279 DLOG("copying statusline_buffer to statusline_head\n");
280 clear_statusline(&statusline_head, true);
281 copy_statusline(&statusline_buffer, &statusline_head);
283 DLOG("dumping statusline:\n");
284 struct status_block *current;
285 TAILQ_FOREACH(current, &statusline_head, blocks) {
286 DLOG("full_text = %s\n", i3string_as_utf8(current->full_text));
287 DLOG("short_text = %s\n", i3string_as_utf8(current->short_text));
288 DLOG("color = %s\n", current->color);
290 DLOG("end of dump\n");
295 * Helper function to read stdin
297 * Returns NULL on EOF.
300 static unsigned char *get_buffer(ev_io *watcher, int *ret_buffer_len) {
301 int fd = watcher->fd;
304 int buffer_len = STDIN_CHUNK_SIZE;
305 unsigned char *buffer = smalloc(buffer_len + 1);
308 n = read(fd, buffer + rec, buffer_len - rec);
310 if (errno == EAGAIN) {
314 ELOG("read() failed!: %s\n", strerror(errno));
318 ELOG("stdin: received EOF\n");
319 *ret_buffer_len = -1;
324 if (rec == buffer_len) {
325 buffer_len += STDIN_CHUNK_SIZE;
326 buffer = srealloc(buffer, buffer_len);
329 if (*buffer == '\0') {
333 *ret_buffer_len = rec;
337 static void read_flat_input(char *buffer, int length) {
338 struct status_block *first = TAILQ_FIRST(&statusline_head);
339 /* Clear the old buffer if any. */
340 I3STRING_FREE(first->full_text);
341 /* Remove the trailing newline and terminate the string at the same
343 if (buffer[length - 1] == '\n' || buffer[length - 1] == '\r')
344 buffer[length - 1] = '\0';
346 buffer[length] = '\0';
347 first->full_text = i3string_from_markup(buffer);
350 static bool read_json_input(unsigned char *input, int length) {
351 yajl_status status = yajl_parse(parser, input, length);
352 bool has_urgent = false;
353 if (status != yajl_status_ok) {
354 char *message = (char *)yajl_get_error(parser, 0, input, length);
356 /* strip the newline yajl adds to the error message */
357 if (message[strlen(message) - 1] == '\n')
358 message[strlen(message) - 1] = '\0';
360 fprintf(stderr, "[i3bar] Could not parse JSON input (code = %d, message = %s): %.*s\n",
361 status, message, length, input);
363 set_statusline_error("Could not parse JSON (%s)", message);
364 yajl_free_error(parser, (unsigned char *)message);
366 } else if (parser_context.has_urgent) {
373 * Callbalk for stdin. We read a line from stdin and store the result
377 void stdin_io_cb(struct ev_loop *loop, ev_io *watcher, int revents) {
379 unsigned char *buffer = get_buffer(watcher, &rec);
382 bool has_urgent = false;
383 if (child.version > 0) {
384 has_urgent = read_json_input(buffer, rec);
386 read_flat_input((char *)buffer, rec);
389 draw_bars(has_urgent);
393 * Callbalk for stdin first line. We read the first line to detect
394 * whether this is JSON or plain text
397 void stdin_io_first_line_cb(struct ev_loop *loop, ev_io *watcher, int revents) {
399 unsigned char *buffer = get_buffer(watcher, &rec);
402 DLOG("Detecting input type based on buffer *%.*s*\n", rec, buffer);
403 /* Detect whether this is JSON or plain text. */
404 unsigned int consumed = 0;
405 /* At the moment, we don’t care for the version. This might change
406 * in the future, but for now, we just discard it. */
407 parse_json_header(&child, buffer, rec, &consumed);
408 if (child.version > 0) {
409 /* If hide-on-modifier is set, we start of by sending the
410 * child a SIGSTOP, because the bars aren't mapped at start */
411 if (config.hide_on_modifier) {
414 draw_bars(read_json_input(buffer + consumed, rec - consumed));
416 /* In case of plaintext, we just add a single block and change its
417 * full_text pointer later. */
418 struct status_block *new_block = scalloc(sizeof(struct status_block));
419 TAILQ_INSERT_TAIL(&statusline_head, new_block, blocks);
420 read_flat_input((char *)buffer, rec);
423 ev_io_stop(main_loop, stdin_io);
424 ev_io_init(stdin_io, &stdin_io_cb, STDIN_FILENO, EV_READ);
425 ev_io_start(main_loop, stdin_io);
429 * We received a SIGCHLD, meaning, that the child process terminated.
430 * We simply free the respective data structures and don't care for input
434 void child_sig_cb(struct ev_loop *loop, ev_child *watcher, int revents) {
435 int exit_status = WEXITSTATUS(watcher->rstatus);
437 ELOG("Child (pid: %d) unexpectedly exited with status %d\n",
441 /* this error is most likely caused by a user giving a nonexecutable or
442 * nonexistent file, so we will handle those cases separately. */
443 if (exit_status == 126)
444 set_statusline_error("status_command is not executable (exit %d)", exit_status);
445 else if (exit_status == 127)
446 set_statusline_error("status_command not found or is missing a library dependency (exit %d)", exit_status);
448 set_statusline_error("status_command process exited unexpectedly (exit %d)", exit_status);
454 void child_write_output(void) {
455 if (child.click_events) {
456 const unsigned char *output;
459 yajl_gen_get_buf(gen, &output, &size);
460 write(child_stdin, output, size);
461 write(child_stdin, "\n", 1);
467 * Start a child process with the specified command and reroute stdin.
468 * We actually start a $SHELL to execute the command so we don't have to care
469 * about arguments and such.
471 * If `command' is NULL, such as in the case when no `status_command' is given
472 * in the bar config, no child will be started.
475 void start_child(char *command) {
479 /* Allocate a yajl parser which will be used to parse stdin. */
480 static yajl_callbacks callbacks = {
481 .yajl_boolean = stdin_boolean,
482 .yajl_integer = stdin_integer,
483 .yajl_string = stdin_string,
484 .yajl_start_map = stdin_start_map,
485 .yajl_map_key = stdin_map_key,
486 .yajl_end_map = stdin_end_map,
487 .yajl_start_array = stdin_start_array,
488 .yajl_end_array = stdin_end_array,
490 parser = yajl_alloc(&callbacks, NULL, &parser_context);
492 gen = yajl_gen_alloc(NULL);
494 int pipe_in[2]; /* pipe we read from */
495 int pipe_out[2]; /* pipe we write to */
497 if (pipe(pipe_in) == -1)
498 err(EXIT_FAILURE, "pipe(pipe_in)");
499 if (pipe(pipe_out) == -1)
500 err(EXIT_FAILURE, "pipe(pipe_out)");
505 ELOG("Couldn't fork(): %s\n", strerror(errno));
508 /* Child-process. Reroute streams and start shell */
513 dup2(pipe_in[1], STDOUT_FILENO);
514 dup2(pipe_out[0], STDIN_FILENO);
516 setpgid(child.pid, 0);
517 execl(_PATH_BSHELL, _PATH_BSHELL, "-c", command, (char *)NULL);
520 /* Parent-process. Reroute streams */
525 dup2(pipe_in[0], STDIN_FILENO);
526 child_stdin = pipe_out[1];
531 /* We set O_NONBLOCK because blocking is evil in event-driven software */
532 fcntl(STDIN_FILENO, F_SETFL, O_NONBLOCK);
534 stdin_io = smalloc(sizeof(ev_io));
535 ev_io_init(stdin_io, &stdin_io_first_line_cb, STDIN_FILENO, EV_READ);
536 ev_io_start(main_loop, stdin_io);
538 /* We must cleanup, if the child unexpectedly terminates */
539 child_sig = smalloc(sizeof(ev_child));
540 ev_child_init(child_sig, &child_sig_cb, child.pid, 0);
541 ev_child_start(main_loop, child_sig);
543 atexit(kill_child_at_exit);
546 void child_click_events_initialize(void) {
547 if (!child.click_events_init) {
548 yajl_gen_array_open(gen);
549 child_write_output();
550 child.click_events_init = true;
554 void child_click_events_key(const char *key) {
555 yajl_gen_string(gen, (const unsigned char *)key, strlen(key));
559 * Generates a click event, if enabled.
562 void send_block_clicked(int button, const char *name, const char *instance, int x, int y) {
563 if (!child.click_events) {
567 child_click_events_initialize();
569 yajl_gen_map_open(gen);
572 child_click_events_key("name");
573 yajl_gen_string(gen, (const unsigned char *)name, strlen(name));
577 child_click_events_key("instance");
578 yajl_gen_string(gen, (const unsigned char *)instance, strlen(instance));
581 child_click_events_key("button");
582 yajl_gen_integer(gen, button);
584 child_click_events_key("x");
585 yajl_gen_integer(gen, x);
587 child_click_events_key("y");
588 yajl_gen_integer(gen, y);
590 yajl_gen_map_close(gen);
591 child_write_output();
595 * kill()s the child process (if any). Called when exit()ing.
598 void kill_child_at_exit(void) {
600 if (child.cont_signal > 0 && child.stopped)
601 killpg(child.pid, child.cont_signal);
602 killpg(child.pid, SIGTERM);
607 * kill()s the child process (if existent) and closes and
608 * free()s the stdin- and SIGCHLD-watchers
611 void kill_child(void) {
613 if (child.cont_signal > 0 && child.stopped)
614 killpg(child.pid, child.cont_signal);
615 killpg(child.pid, SIGTERM);
617 waitpid(child.pid, &status, 0);
623 * Sends a SIGSTOP to the child process (if existent)
626 void stop_child(void) {
627 if (child.stop_signal > 0 && !child.stopped) {
628 child.stopped = true;
629 killpg(child.pid, child.stop_signal);
634 * Sends a SIGCONT to the child process (if existent)
637 void cont_child(void) {
638 if (child.cont_signal > 0 && child.stopped) {
639 child.stopped = false;
640 killpg(child.pid, child.cont_signal);
645 * Whether or not the child want click events
648 bool child_want_click_events(void) {
649 return child.click_events;