2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009-2013 Michael Stapelberg and contributors (see also: LICENSE)
7 * i3-nagbar is a utility which displays a nag message, for example in the case
8 * when the user has an error in their configuration file.
12 #include <sys/types.h>
28 #include <xcb/xcb_aux.h>
29 #include <xcb/xcb_event.h>
30 #include <xcb/randr.h>
33 #include "i3-nagbar.h"
35 static char *argv0 = NULL;
44 static xcb_window_t win;
45 static xcb_pixmap_t pixmap;
46 static xcb_gcontext_t pixmap_gc;
47 static xcb_rectangle_t rect = {0, 0, 600, 20};
49 static i3String *prompt;
50 static button_t *buttons;
53 /* Result of get_colorpixel() for the various colors. */
54 static uint32_t color_background; /* background of the bar */
55 static uint32_t color_button_background; /* background for buttons */
56 static uint32_t color_border; /* color of the button border */
57 static uint32_t color_border_bottom; /* color of the bottom border */
58 static uint32_t color_text; /* color of the text */
61 xcb_connection_t *conn;
62 xcb_screen_t *root_screen;
65 * Having verboselog(), errorlog() and debuglog() is necessary when using libi3.
68 void verboselog(char *fmt, ...) {
72 vfprintf(stdout, fmt, args);
76 void errorlog(char *fmt, ...) {
80 vfprintf(stderr, fmt, args);
84 void debuglog(char *fmt, ...) {
88 * Starts the given application by passing it through a shell. We use double fork
89 * to avoid zombie processes. As the started application’s parent exits (immediately),
90 * the application is reparented to init (process-id 1), which correctly handles
91 * childs, so we don’t have to do it :-).
93 * The shell is determined by looking for the SHELL environment variable. If it
94 * does not exist, /bin/sh is used.
97 static void start_application(const char *command) {
98 printf("executing: %s\n", command);
103 /* This is the child */
104 execl(_PATH_BSHELL, _PATH_BSHELL, "-c", command, (void *)NULL);
112 static button_t *get_button_at(int16_t x, int16_t y) {
113 for (int c = 0; c < buttoncnt; c++)
114 if (x >= (buttons[c].x) && x <= (buttons[c].x + buttons[c].width))
120 static void handle_button_press(xcb_connection_t *conn, xcb_button_press_event_t *event) {
121 printf("button pressed on x = %d, y = %d\n",
122 event->event_x, event->event_y);
123 /* TODO: set a flag for the button, re-render */
127 * Called when the user releases the mouse button. Checks whether the
128 * coordinates are over a button and executes the appropriate action.
131 static void handle_button_release(xcb_connection_t *conn, xcb_button_release_event_t *event) {
132 printf("button released on x = %d, y = %d\n",
133 event->event_x, event->event_y);
134 /* If the user hits the close button, we exit(0) */
135 if (event->event_x >= (rect.width - logical_px(32)))
137 button_t *button = get_button_at(event->event_x, event->event_y);
141 /* We need to create a custom script containing our actual command
142 * since not every terminal emulator which is contained in
143 * i3-sensible-terminal supports -e with multiple arguments (and not
144 * all of them support -e with one quoted argument either).
146 * NB: The paths need to be unique, that is, don’t assume users close
147 * their nagbars at any point in time (and they still need to work).
149 char *script_path = get_process_filename("nagbar-cmd");
151 int fd = open(script_path, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR);
153 warn("Could not create temporary script to store the nagbar command");
156 FILE *script = fdopen(fd, "w");
157 if (script == NULL) {
158 warn("Could not fdopen() temporary script to store the nagbar command");
161 fprintf(script, "#!/bin/sh\nrm %s\n%s", script_path, button->action);
166 char *exe_path = get_exe_path(argv0);
167 sasprintf(&link_path, "%s.nagbar_cmd", script_path);
168 symlink(exe_path, link_path);
171 sasprintf(&terminal_cmd, "i3-sensible-terminal -e %s", link_path);
172 printf("argv0 = %s\n", argv0);
173 printf("terminal_cmd = %s\n", terminal_cmd);
175 start_application(terminal_cmd);
182 /* TODO: unset flag, re-render */
186 * Handles expose events (redraws of the window) and rendering in general. Will
187 * be called from the code with event == NULL or from X with event != NULL.
190 static int handle_expose(xcb_connection_t *conn, xcb_expose_event_t *event) {
191 /* re-draw the background */
192 xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND, (uint32_t[]){color_background});
193 xcb_poly_fill_rectangle(conn, pixmap, pixmap_gc, 1, &rect);
195 /* restore font color */
196 set_font_colors(pixmap_gc, color_text, color_background);
197 draw_text(prompt, pixmap, pixmap_gc,
198 logical_px(4) + logical_px(4),
199 logical_px(4) + logical_px(4),
200 rect.width - logical_px(4) - logical_px(4));
202 /* render close button */
203 const char *close_button_label = "X";
204 int line_width = logical_px(4);
205 /* set width to the width of the label */
206 int w = predict_text_width(i3string_from_utf8(close_button_label));
207 /* account for left/right padding, which seems to be set to 8px (total) below */
211 values[0] = color_button_background;
212 values[1] = line_width;
213 xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND | XCB_GC_LINE_WIDTH, values);
215 xcb_rectangle_t close = {y - w - (2 * line_width), 0, w + (2 * line_width), rect.height};
216 xcb_poly_fill_rectangle(conn, pixmap, pixmap_gc, 1, &close);
218 xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND, (uint32_t[]){color_border});
219 xcb_point_t points[] = {
220 {y - w - (2 * line_width), line_width / 2},
221 {y - (line_width / 2), line_width / 2},
222 {y - (line_width / 2), (rect.height - (line_width / 2)) - logical_px(2)},
223 {y - w - (2 * line_width), (rect.height - (line_width / 2)) - logical_px(2)},
224 {y - w - (2 * line_width), line_width / 2}};
225 xcb_poly_line(conn, XCB_COORD_MODE_ORIGIN, pixmap, pixmap_gc, 5, points);
228 set_font_colors(pixmap_gc, color_text, color_button_background);
229 /* the x term here seems to set left/right padding */
230 draw_text_ascii(close_button_label, pixmap, pixmap_gc,
231 y - w - line_width + w / 2 - logical_px(4),
232 logical_px(4) + logical_px(3),
233 rect.width - y + w + line_width - w / 2 + logical_px(4));
238 /* render custom buttons */
240 for (int c = 0; c < buttoncnt; c++) {
241 /* set w to the width of the label */
242 w = predict_text_width(buttons[c].label);
243 /* account for left/right padding, which seems to be set to 12px (total) below */
246 xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND, (uint32_t[]){color_button_background});
247 close = (xcb_rectangle_t){y - w - (2 * line_width), logical_px(2), w + (2 * line_width), rect.height - logical_px(6)};
248 xcb_poly_fill_rectangle(conn, pixmap, pixmap_gc, 1, &close);
250 xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND, (uint32_t[]){color_border});
251 buttons[c].x = y - w - (2 * line_width);
252 buttons[c].width = w;
253 xcb_point_t points2[] = {
254 {y - w - (2 * line_width), (line_width / 2) + logical_px(2)},
255 {y - (line_width / 2), (line_width / 2) + logical_px(2)},
256 {y - (line_width / 2), (rect.height - logical_px(4) - (line_width / 2))},
257 {y - w - (2 * line_width), (rect.height - logical_px(4) - (line_width / 2))},
258 {y - w - (2 * line_width), (line_width / 2) + logical_px(2)}};
259 xcb_poly_line(conn, XCB_COORD_MODE_ORIGIN, pixmap, pixmap_gc, 5, points2);
261 values[0] = color_text;
262 values[1] = color_button_background;
263 set_font_colors(pixmap_gc, color_text, color_button_background);
264 /* the x term seems to set left/right padding */
265 draw_text(buttons[c].label, pixmap, pixmap_gc,
266 y - w - line_width + logical_px(6),
267 logical_px(4) + logical_px(3),
268 rect.width - y + w + line_width - logical_px(6));
273 /* border line at the bottom */
274 line_width = logical_px(2);
275 values[0] = color_border_bottom;
276 values[1] = line_width;
277 xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND | XCB_GC_LINE_WIDTH, values);
278 xcb_point_t bottom[] = {
279 {0, rect.height - 0},
280 {rect.width, rect.height - 0}};
281 xcb_poly_line(conn, XCB_COORD_MODE_ORIGIN, pixmap, pixmap_gc, 2, bottom);
283 /* Copy the contents of the pixmap to the real window */
284 xcb_copy_area(conn, pixmap, win, pixmap_gc, 0, 0, 0, 0, rect.width, rect.height);
291 * Return the position and size the i3-nagbar window should use.
292 * This will be the primary output or a fallback if it cannot be determined.
294 static xcb_rectangle_t get_window_position(void) {
295 /* Default values if we cannot determine the primary output or its CRTC info. */
296 xcb_rectangle_t result = (xcb_rectangle_t){50, 50, 500, font.height + logical_px(8) + logical_px(8)};
298 xcb_randr_get_screen_resources_current_cookie_t rcookie = xcb_randr_get_screen_resources_current(conn, root);
299 xcb_randr_get_output_primary_cookie_t pcookie = xcb_randr_get_output_primary(conn, root);
301 xcb_randr_get_output_primary_reply_t *primary;
302 xcb_randr_get_screen_resources_current_reply_t *res;
304 if ((primary = xcb_randr_get_output_primary_reply(conn, pcookie, NULL)) == NULL) {
305 DLOG("Could not determine the primary output.\n");
309 if ((res = xcb_randr_get_screen_resources_current_reply(conn, rcookie, NULL)) == NULL) {
313 xcb_randr_get_output_info_reply_t *output =
314 xcb_randr_get_output_info_reply(conn,
315 xcb_randr_get_output_info(conn, primary->output, res->config_timestamp),
317 if (output == NULL || output->crtc == XCB_NONE)
320 xcb_randr_get_crtc_info_reply_t *crtc =
321 xcb_randr_get_crtc_info_reply(conn,
322 xcb_randr_get_crtc_info(conn, output->crtc, res->config_timestamp),
327 DLOG("Found primary output on position x = %i / y = %i / w = %i / h = %i",
328 crtc->x, crtc->y, crtc->width, crtc->height);
329 if (crtc->width == 0 || crtc->height == 0) {
330 DLOG("Primary output is not active, ignoring it.\n");
344 int main(int argc, char *argv[]) {
345 /* The following lines are a terribly horrible kludge. Because terminal
346 * emulators have different ways of interpreting the -e command line
347 * argument (some need -e "less /etc/fstab", others need -e less
348 * /etc/fstab), we need to write commands to a script and then just run
349 * that script. However, since on some machines, $XDG_RUNTIME_DIR and
350 * $TMPDIR are mounted with noexec, we cannot directly execute the script
353 * Initially, we tried to pass the command via the environment variable
354 * _I3_NAGBAR_CMD. But turns out that some terminal emulators such as
355 * xfce4-terminal run all windows from a single master process and only
356 * pass on the command (not the environment) to that master process.
358 * Therefore, we symlink i3-nagbar (which MUST reside on an executable
359 * filesystem) with a special name and run that symlink. When i3-nagbar
360 * recognizes it’s started as a binary ending in .nagbar_cmd, it strips off
361 * the .nagbar_cmd suffix and runs /bin/sh on argv[0]. That way, we can run
362 * a shell script on a noexec filesystem.
364 * From a security point of view, i3-nagbar is just an alias to /bin/sh in
365 * certain circumstances. This should not open any new security issues, I
368 const size_t argv0_len = strlen(argv[0]);
369 if (argv0_len > strlen(".nagbar_cmd") &&
370 strcmp(argv[0] + argv0_len - strlen(".nagbar_cmd"), ".nagbar_cmd") == 0) {
372 cmd = strdup(argv[0]);
373 *(cmd + argv0_len - strlen(".nagbar_cmd")) = '\0';
374 execl("/bin/sh", "/bin/sh", cmd, NULL);
375 err(EXIT_FAILURE, "execv(/bin/sh, /bin/sh, %s)", cmd);
380 char *pattern = sstrdup("pango:monospace 8");
381 int o, option_index = 0;
382 enum { TYPE_ERROR = 0,
383 TYPE_WARNING = 1 } bar_type = TYPE_ERROR;
385 static struct option long_options[] = {
386 {"version", no_argument, 0, 'v'},
387 {"font", required_argument, 0, 'f'},
388 {"button", required_argument, 0, 'b'},
389 {"help", no_argument, 0, 'h'},
390 {"message", required_argument, 0, 'm'},
391 {"type", required_argument, 0, 't'},
394 char *options_string = "b:f:m:t:vh";
396 prompt = i3string_from_utf8("Please do not run this program.");
398 while ((o = getopt_long(argc, argv, options_string, long_options, &option_index)) != -1) {
401 printf("i3-nagbar " I3_VERSION "\n");
405 pattern = sstrdup(optarg);
408 i3string_free(prompt);
409 prompt = i3string_from_utf8(optarg);
412 bar_type = (strcasecmp(optarg, "warning") == 0 ? TYPE_WARNING : TYPE_ERROR);
415 printf("i3-nagbar " I3_VERSION "\n");
416 printf("i3-nagbar [-m <message>] [-b <button> <action>] [-t warning|error] [-f <font>] [-v]\n");
419 buttons = realloc(buttons, sizeof(button_t) * (buttoncnt + 1));
420 buttons[buttoncnt].label = i3string_from_utf8(optarg);
421 buttons[buttoncnt].action = argv[optind];
422 printf("button with label *%s* and action *%s*\n",
423 i3string_as_utf8(buttons[buttoncnt].label),
424 buttons[buttoncnt].action);
426 printf("now %d buttons\n", buttoncnt);
434 if ((conn = xcb_connect(NULL, &screens)) == NULL ||
435 xcb_connection_has_error(conn))
436 die("Cannot open display\n");
438 /* Place requests for the atoms we need as soon as possible */
439 #define xmacro(atom) \
440 xcb_intern_atom_cookie_t atom##_cookie = xcb_intern_atom(conn, 0, strlen(#atom), #atom);
441 #include "atoms.xmacro"
444 root_screen = xcb_aux_get_screen(conn, screens);
445 root = root_screen->root;
447 if (bar_type == TYPE_ERROR) {
448 /* Red theme for error messages */
449 color_button_background = get_colorpixel("#680a0a");
450 color_background = get_colorpixel("#900000");
451 color_text = get_colorpixel("#ffffff");
452 color_border = get_colorpixel("#d92424");
453 color_border_bottom = get_colorpixel("#470909");
455 /* Yellowish theme for warnings */
456 color_button_background = get_colorpixel("#ffc100");
457 color_background = get_colorpixel("#ffa8000");
458 color_text = get_colorpixel("#000000");
459 color_border = get_colorpixel("#ab7100");
460 color_border_bottom = get_colorpixel("#ab7100");
463 font = load_font(pattern, true);
466 xcb_rectangle_t win_pos = get_window_position();
468 /* Open an input window */
469 win = xcb_generate_id(conn);
473 XCB_COPY_FROM_PARENT,
474 win, /* the window id */
475 root, /* parent == root */
476 win_pos.x, win_pos.y, win_pos.width, win_pos.height, /* dimensions */
477 0, /* x11 border = 0, we draw our own */
478 XCB_WINDOW_CLASS_INPUT_OUTPUT,
479 XCB_WINDOW_CLASS_COPY_FROM_PARENT, /* copy visual from parent */
480 XCB_CW_BACK_PIXEL | XCB_CW_EVENT_MASK,
482 0, /* back pixel: black */
483 XCB_EVENT_MASK_EXPOSURE |
484 XCB_EVENT_MASK_STRUCTURE_NOTIFY |
485 XCB_EVENT_MASK_BUTTON_PRESS |
486 XCB_EVENT_MASK_BUTTON_RELEASE});
488 /* Map the window (make it visible) */
489 xcb_map_window(conn, win);
491 /* Setup NetWM atoms */
492 #define xmacro(name) \
494 xcb_intern_atom_reply_t *reply = xcb_intern_atom_reply(conn, name##_cookie, NULL); \
496 die("Could not get atom " #name "\n"); \
498 A_##name = reply->atom; \
501 #include "atoms.xmacro"
505 xcb_change_property(conn,
506 XCB_PROP_MODE_REPLACE,
508 A__NET_WM_WINDOW_TYPE,
512 (unsigned char *)&A__NET_WM_WINDOW_TYPE_DOCK);
514 /* Reserve some space at the top of the screen */
520 uint32_t left_start_y;
522 uint32_t right_start_y;
523 uint32_t right_end_y;
524 uint32_t top_start_x;
526 uint32_t bottom_start_x;
527 uint32_t bottom_end_x;
528 } __attribute__((__packed__)) strut_partial;
529 memset(&strut_partial, 0, sizeof(strut_partial));
531 strut_partial.top = font.height + logical_px(6);
532 strut_partial.top_start_x = 0;
533 strut_partial.top_end_x = 800;
535 xcb_change_property(conn,
536 XCB_PROP_MODE_REPLACE,
538 A__NET_WM_STRUT_PARTIAL,
545 pixmap = xcb_generate_id(conn);
546 pixmap_gc = xcb_generate_id(conn);
547 xcb_create_pixmap(conn, root_screen->root_depth, pixmap, win, 500, font.height + logical_px(8));
548 xcb_create_gc(conn, pixmap_gc, pixmap, 0, 0);
550 /* Grab the keyboard to get all input */
553 xcb_generic_event_t *event;
554 while ((event = xcb_wait_for_event(conn)) != NULL) {
555 if (event->response_type == 0) {
556 fprintf(stderr, "X11 Error received! sequence %x\n", event->sequence);
560 /* Strip off the highest bit (set if the event is generated) */
561 int type = (event->response_type & 0x7F);
565 handle_expose(conn, (xcb_expose_event_t *)event);
568 case XCB_BUTTON_PRESS:
569 handle_button_press(conn, (xcb_button_press_event_t *)event);
572 case XCB_BUTTON_RELEASE:
573 handle_button_release(conn, (xcb_button_release_event_t *)event);
576 case XCB_CONFIGURE_NOTIFY: {
577 xcb_configure_notify_event_t *configure_notify = (xcb_configure_notify_event_t *)event;
578 rect = (xcb_rectangle_t){
581 configure_notify->width,
582 configure_notify->height};
584 /* Recreate the pixmap / gc */
585 xcb_free_pixmap(conn, pixmap);
586 xcb_free_gc(conn, pixmap_gc);
588 xcb_create_pixmap(conn, root_screen->root_depth, pixmap, win, rect.width, rect.height);
589 xcb_create_gc(conn, pixmap_gc, pixmap, 0, 0);