git.sur5r.net Git - i3/i3/blob - include/bindings.h

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
   6  *
   7  * bindings.h: Functions for configuring, finding, and running bindings.
   8  *
   9  */
  10 #pragma once
  11
  12 #include <config.h>
  13
  14 extern pid_t command_error_nagbar_pid;
  15
  16 /**
  17  * The name of the default mode.
  18  *
  19  */
  20 extern const char *DEFAULT_BINDING_MODE;
  21
  22 /**
  23  * Adds a binding from config parameters given as strings and returns a
  24  * pointer to the binding structure. Returns NULL if the input code could not
  25  * be parsed.
  26  *
  27  */
  28 Binding *configure_binding(const char *bindtype, const char *modifiers, const char *input_code,
  29                            const char *release, const char *border, const char *whole_window,
  30                            const char *command, const char *mode, bool pango_markup);
  31
  32 /**
  33  * Grab the bound keys (tell X to send us keypress events for those keycodes)
  34  *
  35  */
  36 void grab_all_keys(xcb_connection_t *conn);
  37
  38 /**
  39  * Release the button grabs on all managed windows and regrab them,
  40  * reevaluating which buttons need to be grabbed.
  41  *
  42  */
  43 void regrab_all_buttons(xcb_connection_t *conn);
  44
  45 /**
  46  * Returns a pointer to the Binding that matches the given xcb event or NULL if
  47  * no such binding exists.
  48  *
  49  */
  50 Binding *get_binding_from_xcb_event(xcb_generic_event_t *event);
  51
  52 /**
  53  * Translates keysymbols to keycodes for all bindings which use keysyms.
  54  *
  55  */
  56 void translate_keysyms(void);
  57
  58 /**
  59  * Switches the key bindings to the given mode, if the mode exists
  60  *
  61  */
  62 void switch_mode(const char *new_mode);
  63
  64 /**
  65  * Reorders bindings by event_state_mask descendingly so that get_binding()
  66  * correctly matches more specific bindings before more generic bindings. Take
  67  * the following binding configuration as an example:
  68  *
  69  *   bindsym n nop lower-case n pressed
  70  *   bindsym Shift+n nop upper-case n pressed
  71  *
  72  * Without reordering, the first binding’s event_state_mask of 0x0 would match
  73  * the actual event_stat_mask of 0x1 and hence trigger instead of the second
  74  * keybinding.
  75  *
  76  */
  77 void reorder_bindings(void);
  78
  79 /**
  80  * Checks for duplicate key bindings (the same keycode or keysym is configured
  81  * more than once). If a duplicate binding is found, a message is printed to
  82  * stderr and the has_errors variable is set to true, which will start
  83  * i3-nagbar.
  84  *
  85  */
  86 void check_for_duplicate_bindings(struct context *context);
  87
  88 /**
  89  * Frees the binding. If bind is null, it simply returns.
  90  */
  91 void binding_free(Binding *bind);
  92
  93 /**
  94  * Runs the given binding and handles parse errors. If con is passed, it will
  95  * execute the command binding with that container selected by criteria.
  96  * Returns a CommandResult for running the binding's command. Caller should
  97  * render tree if needs_tree_render is true. Free with command_result_free().
  98  *
  99  */
 100 CommandResult *run_binding(Binding *bind, Con *con);
 101
 102 /**
 103  * Loads the XKB keymap from the X11 server and feeds it to xkbcommon.
 104  *
 105  */
 106 bool load_keymap(void);
 107
 108 /**
 109  * Returns a list of buttons that should be grabbed on a window.
 110  * This list will always contain 1–3, all higher buttons will only be returned
 111  * if there is a whole-window binding for it on some window in the current
 112  * config.
 113  * The list is terminated by a 0.
 114  */
 115 int *bindings_get_buttons_to_grab(void);