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 *exclude_titlebar, const char *command, const char *mode,
  31                            bool pango_markup);
  32
  33 /**
  34  * Grab the bound keys (tell X to send us keypress events for those keycodes)
  35  *
  36  */
  37 void grab_all_keys(xcb_connection_t *conn);
  38
  39 /**
  40  * Release the button grabs on all managed windows and regrab them,
  41  * reevaluating which buttons need to be grabbed.
  42  *
  43  */
  44 void regrab_all_buttons(xcb_connection_t *conn);
  45
  46 /**
  47  * Returns a pointer to the Binding that matches the given xcb event or NULL if
  48  * no such binding exists.
  49  *
  50  */
  51 Binding *get_binding_from_xcb_event(xcb_generic_event_t *event);
  52
  53 /**
  54  * Translates keysymbols to keycodes for all bindings which use keysyms.
  55  *
  56  */
  57 void translate_keysyms(void);
  58
  59 /**
  60  * Switches the key bindings to the given mode, if the mode exists
  61  *
  62  */
  63 void switch_mode(const char *new_mode);
  64
  65 /**
  66  * Reorders bindings by event_state_mask descendingly so that get_binding()
  67  * correctly matches more specific bindings before more generic bindings. Take
  68  * the following binding configuration as an example:
  69  *
  70  *   bindsym n nop lower-case n pressed
  71  *   bindsym Shift+n nop upper-case n pressed
  72  *
  73  * Without reordering, the first binding’s event_state_mask of 0x0 would match
  74  * the actual event_stat_mask of 0x1 and hence trigger instead of the second
  75  * keybinding.
  76  *
  77  */
  78 void reorder_bindings(void);
  79
  80 /**
  81  * Checks for duplicate key bindings (the same keycode or keysym is configured
  82  * more than once). If a duplicate binding is found, a message is printed to
  83  * stderr and the has_errors variable is set to true, which will start
  84  * i3-nagbar.
  85  *
  86  */
  87 void check_for_duplicate_bindings(struct context *context);
  88
  89 /**
  90  * Frees the binding. If bind is null, it simply returns.
  91  */
  92 void binding_free(Binding *bind);
  93
  94 /**
  95  * Runs the given binding and handles parse errors. If con is passed, it will
  96  * execute the command binding with that container selected by criteria.
  97  * Returns a CommandResult for running the binding's command. Caller should
  98  * render tree if needs_tree_render is true. Free with command_result_free().
  99  *
 100  */
 101 CommandResult *run_binding(Binding *bind, Con *con);
 102
 103 /**
 104  * Loads the XKB keymap from the X11 server and feeds it to xkbcommon.
 105  *
 106  */
 107 bool load_keymap(void);
 108
 109 /**
 110  * Returns a list of buttons that should be grabbed on a window.
 111  * This list will always contain 1–3, all higher buttons will only be returned
 112  * if there is a whole-window binding for it on some window in the current
 113  * config.
 114  * The list is terminated by a 0.
 115  */
 116 int *bindings_get_buttons_to_grab(void);