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 * i3-input/main.c: Utility which lets the user input commands and sends them
12 #include <sys/types.h>
24 #include <xcb/xcb_aux.h>
25 #include <xcb/xcb_event.h>
26 #include <xcb/xcb_keysyms.h>
28 #include <X11/keysym.h>
30 #include "keysym2ucs.h"
36 /* IPC format string. %s will be replaced with what the user entered, then
37 * the command will be sent to i3 */
40 static char *socket_path;
42 static xcb_key_symbols_t *symbols;
43 static bool modeswitch_active = false;
44 static xcb_window_t win;
45 static xcb_pixmap_t pixmap;
46 static xcb_gcontext_t pixmap_gc;
47 static xcb_char2b_t glyphs_ucs[512];
48 static char *glyphs_utf8[512];
49 static int input_position;
51 static i3String *prompt;
52 static int prompt_offset = 0;
55 xcb_connection_t *conn;
56 xcb_screen_t *root_screen;
57 static xcb_get_input_focus_cookie_t focus_cookie;
60 * Having verboselog(), errorlog() and debuglog() is necessary when using libi3.
63 void verboselog(char *fmt, ...) {
67 vfprintf(stdout, fmt, args);
71 void errorlog(char *fmt, ...) {
75 vfprintf(stderr, fmt, args);
79 void debuglog(char *fmt, ...) {
83 * Restores the X11 input focus to wherever it was before.
84 * This is necessary because i3-input’s window has override_redirect=1
85 * (→ unmanaged by the window manager) and thus i3-input changes focus itself.
86 * This function is called on exit().
89 static void restore_input_focus(void) {
90 xcb_generic_error_t *error;
91 xcb_get_input_focus_reply_t *reply = xcb_get_input_focus_reply(conn, focus_cookie, &error);
93 fprintf(stderr, "[i3-input] ERROR: Could not restore input focus (X error %d)\n", error->error_code);
96 xcb_set_input_focus(conn, XCB_INPUT_FOCUS_POINTER_ROOT, reply->focus, XCB_CURRENT_TIME);
101 * Concats the glyphs (either UCS-2 or UTF-8) to a single string, suitable for
102 * rendering it (UCS-2) or sending it to i3 (UTF-8).
105 static uint8_t *concat_strings(char **glyphs, int max) {
106 uint8_t *output = scalloc(max + 1, 4);
107 uint8_t *walk = output;
108 for (int c = 0; c < max; c++) {
109 printf("at %c\n", glyphs[c][0]);
110 /* if the first byte is 0, this has to be UCS2 */
111 if (glyphs[c][0] == '\0') {
112 memcpy(walk, glyphs[c], 2);
115 strcpy((char *)walk, glyphs[c]);
116 walk += strlen(glyphs[c]);
119 printf("output = %s\n", output);
124 * Handles expose events (redraws of the window) and rendering in general. Will
125 * be called from the code with event == NULL or from X with event != NULL.
128 static int handle_expose(void *data, xcb_connection_t *conn, xcb_expose_event_t *event) {
131 /* re-draw the background */
132 xcb_rectangle_t border = {0, 0, logical_px(500), font.height + logical_px(8)},
133 inner = {logical_px(2), logical_px(2), logical_px(496), font.height + logical_px(8) - logical_px(4)};
134 xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND, (uint32_t[]){get_colorpixel("#FF0000")});
135 xcb_poly_fill_rectangle(conn, pixmap, pixmap_gc, 1, &border);
136 xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND, (uint32_t[]){get_colorpixel("#000000")});
137 xcb_poly_fill_rectangle(conn, pixmap, pixmap_gc, 1, &inner);
139 /* restore font color */
140 set_font_colors(pixmap_gc, draw_util_hex_to_color("#FFFFFF"), draw_util_hex_to_color("#000000"));
142 /* draw the prompt … */
143 if (prompt != NULL) {
144 draw_text(prompt, pixmap, pixmap_gc, NULL, logical_px(4), logical_px(4), logical_px(492));
147 if (input_position > 0) {
148 i3String *input = i3string_from_ucs2(glyphs_ucs, input_position);
149 draw_text(input, pixmap, pixmap_gc, NULL, prompt_offset + logical_px(4), logical_px(4), logical_px(492));
150 i3string_free(input);
153 /* Copy the contents of the pixmap to the real window */
154 xcb_copy_area(conn, pixmap, win, pixmap_gc, 0, 0, 0, 0, logical_px(500), font.height + logical_px(8));
161 * Deactivates the Mode_switch bit upon release of the Mode_switch key.
164 static int handle_key_release(void *ignored, xcb_connection_t *conn, xcb_key_release_event_t *event) {
165 printf("releasing %d, state raw = %d\n", event->detail, event->state);
167 xcb_keysym_t sym = xcb_key_press_lookup_keysym(symbols, event, event->state);
168 if (sym == XK_Mode_switch) {
169 printf("Mode switch disabled\n");
170 modeswitch_active = false;
176 static void finish_input() {
177 char *command = (char *)concat_strings(glyphs_utf8, input_position);
179 /* count the occurrences of %s in the string */
181 int len = strlen(format);
183 for (c = 0; c < (len - 1); c++)
184 if (format[c] == '%' && format[c + 1] == 's')
186 printf("occurrences = %d\n", cnt);
188 /* allocate space for the output */
189 int inputlen = strlen(command);
190 char *full = scalloc(strlen(format) - (2 * cnt) /* format without all %s */
191 + (inputlen * cnt) /* replaced %s */
192 + 1, /* trailing NUL */
195 for (c = 0; c < len; c++) {
196 /* if this is not % or it is % but without a following 's',
197 * just copy the character */
198 if (format[c] != '%' || (c == (len - 1)) || format[c + 1] != 's')
199 *(dest++) = format[c];
201 strncat(dest, command, inputlen);
203 /* skip the following 's' of '%s' */
208 /* prefix the command if a prefix was specified on commandline */
209 printf("command = %s\n", full);
211 restore_input_focus();
215 ipc_send_message(sockfd, strlen(full), 0, (uint8_t *)full);
223 * Handles keypresses by converting the keycodes to keysymbols, then the
224 * keysymbols to UCS-2. If the conversion succeeded, the glyph is saved in the
225 * internal buffers and displayed in the input window.
227 * Also handles backspace (deleting one character) and return (sending the
231 static int handle_key_press(void *ignored, xcb_connection_t *conn, xcb_key_press_event_t *event) {
232 printf("Keypress %d, state raw = %d\n", event->detail, event->state);
234 // TODO: port the input handling code from i3lock once libxkbcommon ≥ 0.5.0
235 // is available in distros.
237 /* See the documentation of xcb_key_symbols_get_keysym for this one.
238 * Basically: We get either col 0 or col 1, depending on whether shift is
240 int col = (event->state & XCB_MOD_MASK_SHIFT);
242 /* If modeswitch is currently active, we need to look in group 2 or 3,
244 if (modeswitch_active)
247 xcb_keysym_t sym = xcb_key_press_lookup_keysym(symbols, event, col);
248 if (sym == XK_Mode_switch) {
249 printf("Mode switch enabled\n");
250 modeswitch_active = true;
254 if (sym == XK_Return)
257 if (sym == XK_BackSpace) {
258 if (input_position == 0)
262 free(glyphs_utf8[input_position]);
264 handle_expose(NULL, conn, NULL);
267 if (sym == XK_Escape) {
268 restore_input_focus();
272 /* TODO: handle all of these? */
273 printf("is_keypad_key = %d\n", xcb_is_keypad_key(sym));
274 printf("is_private_keypad_key = %d\n", xcb_is_private_keypad_key(sym));
275 printf("xcb_is_cursor_key = %d\n", xcb_is_cursor_key(sym));
276 printf("xcb_is_pf_key = %d\n", xcb_is_pf_key(sym));
277 printf("xcb_is_function_key = %d\n", xcb_is_function_key(sym));
278 printf("xcb_is_misc_function_key = %d\n", xcb_is_misc_function_key(sym));
279 printf("xcb_is_modifier_key = %d\n", xcb_is_modifier_key(sym));
281 if (xcb_is_modifier_key(sym) || xcb_is_cursor_key(sym))
284 printf("sym = %c (%d)\n", sym, sym);
286 /* convert the keysym to UCS */
287 uint16_t ucs = keysym2ucs(sym);
288 if ((int16_t)ucs == -1) {
289 fprintf(stderr, "Keysym could not be converted to UCS, skipping\n");
294 inp.byte1 = (ucs & 0xff00) >> 2;
295 inp.byte2 = (ucs & 0x00ff) >> 0;
297 printf("inp.byte1 = %02x, inp.byte2 = %02x\n", inp.byte1, inp.byte2);
298 /* convert it to UTF-8 */
299 char *out = convert_ucs2_to_utf8(&inp, 1);
300 printf("converted to %s\n", out);
302 glyphs_ucs[input_position] = inp;
303 glyphs_utf8[input_position] = out;
306 if (input_position == limit)
309 handle_expose(NULL, conn, NULL);
313 static xcb_rectangle_t get_window_position(void) {
314 xcb_rectangle_t result = (xcb_rectangle_t){logical_px(50), logical_px(50), logical_px(500), font.height + logical_px(8)};
316 xcb_get_property_reply_t *supporting_wm_reply = NULL;
317 xcb_get_input_focus_reply_t *input_focus = NULL;
318 xcb_get_geometry_reply_t *geometry = NULL;
319 xcb_get_property_reply_t *wm_class = NULL;
320 xcb_translate_coordinates_reply_t *coordinates = NULL;
322 xcb_atom_t A__NET_SUPPORTING_WM_CHECK;
323 xcb_intern_atom_cookie_t nswc_cookie = xcb_intern_atom(conn, 0, strlen("_NET_SUPPORTING_WM_CHECK"), "_NET_SUPPORTING_WM_CHECK");
324 xcb_intern_atom_reply_t *nswc_reply = xcb_intern_atom_reply(conn, nswc_cookie, NULL);
325 if (nswc_reply == NULL) {
326 ELOG("Could not intern atom _NET_SUPPORTING_WM_CHECK\n");
329 A__NET_SUPPORTING_WM_CHECK = nswc_reply->atom;
332 supporting_wm_reply = xcb_get_property_reply(
333 conn, xcb_get_property(conn, false, root, A__NET_SUPPORTING_WM_CHECK, XCB_ATOM_WINDOW, 0, 32), NULL);
334 xcb_window_t *supporting_wm_win = NULL;
335 if (supporting_wm_reply == NULL || xcb_get_property_value_length(supporting_wm_reply) == 0) {
336 DLOG("Could not determine EWMH support window.\n");
338 supporting_wm_win = xcb_get_property_value(supporting_wm_reply);
341 /* In rare cases, the window holding the input focus might disappear while we are figuring out its
342 * position. To avoid this, we grab the server in the meantime. */
343 xcb_grab_server(conn);
345 input_focus = xcb_get_input_focus_reply(conn, xcb_get_input_focus(conn), NULL);
346 if (input_focus == NULL || input_focus->focus == XCB_NONE) {
347 DLOG("Failed to receive the current input focus or no window has the input focus right now.\n");
351 /* We need to ignore the EWMH support window to which the focus can be set if there's no suitable window to focus. */
352 if (supporting_wm_win != NULL && input_focus->focus == *supporting_wm_win) {
353 DLOG("Input focus is on the EWMH support window, ignoring.\n");
357 geometry = xcb_get_geometry_reply(conn, xcb_get_geometry(conn, input_focus->focus), NULL);
358 if (geometry == NULL) {
359 DLOG("Failed to received window geometry.\n");
363 wm_class = xcb_get_property_reply(
364 conn, xcb_get_property(conn, false, input_focus->focus, XCB_ATOM_WM_CLASS, XCB_GET_PROPERTY_TYPE_ANY, 0, 32), NULL);
366 /* We need to find out whether the input focus is on an i3 frame window. If it is, we must not translate the coordinates. */
367 if (wm_class == NULL || xcb_get_property_value_length(wm_class) == 0 || strcmp(xcb_get_property_value(wm_class), "i3-frame") != 0) {
368 coordinates = xcb_translate_coordinates_reply(
369 conn, xcb_translate_coordinates(conn, input_focus->focus, root, geometry->x, geometry->y), NULL);
370 if (coordinates == NULL) {
371 DLOG("Failed to translate coordinates.\n");
375 DLOG("Determined coordinates of window with input focus at x = %i / y = %i.\n", coordinates->dst_x, coordinates->dst_y);
376 result.x += coordinates->dst_x;
377 result.y += coordinates->dst_y;
379 DLOG("Determined coordinates of window with input focus at x = %i / y = %i.\n", geometry->x, geometry->y);
380 result.x += geometry->x;
381 result.y += geometry->y;
385 xcb_ungrab_server(conn);
388 FREE(supporting_wm_reply);
396 int main(int argc, char *argv[]) {
397 format = sstrdup("%s");
398 socket_path = getenv("I3SOCK");
399 char *pattern = sstrdup("pango:monospace 8");
400 int o, option_index = 0;
402 static struct option long_options[] = {
403 {"socket", required_argument, 0, 's'},
404 {"version", no_argument, 0, 'v'},
405 {"limit", required_argument, 0, 'l'},
406 {"prompt", required_argument, 0, 'P'},
407 {"prefix", required_argument, 0, 'p'},
408 {"format", required_argument, 0, 'F'},
409 {"font", required_argument, 0, 'f'},
410 {"help", no_argument, 0, 'h'},
413 char *options_string = "s:p:P:f:l:F:vh";
415 while ((o = getopt_long(argc, argv, options_string, long_options, &option_index)) != -1) {
419 socket_path = sstrdup(optarg);
422 printf("i3-input " I3_VERSION);
425 /* This option is deprecated, but will still work in i3 v4.1, 4.2 and 4.3 */
426 fprintf(stderr, "i3-input: WARNING: the -p option is DEPRECATED in favor of the -F (format) option\n");
428 sasprintf(&format, "%s%%s", optarg);
431 limit = atoi(optarg);
434 i3string_free(prompt);
435 prompt = i3string_from_utf8(optarg);
439 pattern = sstrdup(optarg);
443 format = sstrdup(optarg);
446 printf("i3-input " I3_VERSION "\n");
447 printf("i3-input [-s <socket>] [-F <format>] [-l <limit>] [-P <prompt>] [-f <font>] [-v]\n");
449 printf("Example:\n");
450 printf(" i3-input -F 'workspace \"%%s\"' -P 'Switch to workspace: '\n");
455 printf("using format \"%s\"\n", format);
458 conn = xcb_connect(NULL, &screen);
459 if (!conn || xcb_connection_has_error(conn))
460 die("Cannot open display\n");
462 if (socket_path == NULL)
463 socket_path = root_atom_contents("I3_SOCKET_PATH", conn, screen);
465 if (socket_path == NULL)
466 socket_path = "/tmp/i3-ipc.sock";
468 sockfd = ipc_connect(socket_path);
470 /* Request the current InputFocus to restore when i3-input exits. */
471 focus_cookie = xcb_get_input_focus(conn);
473 root_screen = xcb_aux_get_screen(conn, screen);
474 root = root_screen->root;
476 symbols = xcb_key_symbols_alloc(conn);
478 font = load_font(pattern, true);
482 prompt_offset = predict_text_width(prompt);
484 const xcb_rectangle_t win_pos = get_window_position();
486 /* Open an input window */
487 win = xcb_generate_id(conn);
490 XCB_COPY_FROM_PARENT,
491 win, /* the window id */
492 root, /* parent == root */
493 win_pos.x, win_pos.y, win_pos.width, win_pos.height, /* dimensions */
494 0, /* X11 border = 0, we draw our own */
495 XCB_WINDOW_CLASS_INPUT_OUTPUT,
496 XCB_WINDOW_CLASS_COPY_FROM_PARENT, /* copy visual from parent */
497 XCB_CW_BACK_PIXEL | XCB_CW_OVERRIDE_REDIRECT | XCB_CW_EVENT_MASK,
499 0, /* back pixel: black */
500 1, /* override redirect: don’t manage this window */
501 XCB_EVENT_MASK_EXPOSURE});
503 /* Map the window (make it visible) */
504 xcb_map_window(conn, win);
507 pixmap = xcb_generate_id(conn);
508 pixmap_gc = xcb_generate_id(conn);
509 xcb_create_pixmap(conn, root_screen->root_depth, pixmap, win, logical_px(500), font.height + logical_px(8));
510 xcb_create_gc(conn, pixmap_gc, pixmap, 0, 0);
512 /* Set input focus (we have override_redirect=1, so the wm will not do
514 xcb_set_input_focus(conn, XCB_INPUT_FOCUS_POINTER_ROOT, win, XCB_CURRENT_TIME);
516 /* Grab the keyboard to get all input */
519 /* Try (repeatedly, if necessary) to grab the keyboard. We might not
520 * get the keyboard at the first attempt because of the keybinding
521 * still being active when started via a wm’s keybinding. */
522 xcb_grab_keyboard_cookie_t cookie;
523 xcb_grab_keyboard_reply_t *reply = NULL;
526 while ((reply == NULL || reply->status != XCB_GRAB_STATUS_SUCCESS) && (count++ < 500)) {
527 cookie = xcb_grab_keyboard(conn, false, win, XCB_CURRENT_TIME, XCB_GRAB_MODE_ASYNC, XCB_GRAB_MODE_ASYNC);
528 reply = xcb_grab_keyboard_reply(conn, cookie, NULL);
532 if (reply->status != XCB_GRAB_STATUS_SUCCESS) {
533 fprintf(stderr, "Could not grab keyboard, status = %d\n", reply->status);
534 restore_input_focus();
540 xcb_generic_event_t *event;
541 while ((event = xcb_wait_for_event(conn)) != NULL) {
542 if (event->response_type == 0) {
543 fprintf(stderr, "X11 Error received! sequence %x\n", event->sequence);
547 /* Strip off the highest bit (set if the event is generated) */
548 int type = (event->response_type & 0x7F);
552 handle_key_press(NULL, conn, (xcb_key_press_event_t *)event);
555 case XCB_KEY_RELEASE:
556 handle_key_release(NULL, conn, (xcb_key_release_event_t *)event);
560 handle_expose(NULL, conn, (xcb_expose_event_t *)event);