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