Merge branch 'release-4.16.1'

[i3/i3] / include / bindings.h

diff --git a/include/bindings.h b/include/bindings.h
index e2acc313485a805898a90ccac2ba922e858db2fb..df3c32a5a88c8edea7048a39fb7b8d40aefb1883 100644 (file)
--- a/include/bindings.h
+++ b/include/bindings.h
@@ -2,20 +2,22 @@
  * vim:ts=4:sw=4:expandtab
  *
  * i3 - an improved dynamic tiling window manager
- * © 2009-2014 Michael Stapelberg and contributors (see also: LICENSE)
+ * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
  *
  * bindings.h: Functions for configuring, finding, and running bindings.
  *
  */
 #pragma once
 
+#include <config.h>
+
 extern pid_t command_error_nagbar_pid;
 
 /**
  * The name of the default mode.
  *
  */
-const char *DEFAULT_BINDING_MODE;
+extern const char *DEFAULT_BINDING_MODE;
 
 /**
  * Adds a binding from config parameters given as strings and returns a
@@ -24,13 +26,22 @@ const char *DEFAULT_BINDING_MODE;
  *
  */
 Binding *configure_binding(const char *bindtype, const char *modifiers, const char *input_code,
-                           const char *release, const char *command, const char *mode);
+                           const char *release, const char *border, const char *whole_window,
+                           const char *exclude_titlebar, const char *command, const char *mode,
+                           bool pango_markup);
 
 /**
  * Grab the bound keys (tell X to send us keypress events for those keycodes)
  *
  */
-void grab_all_keys(xcb_connection_t *conn, bool bind_mode_switch);
+void grab_all_keys(xcb_connection_t *conn);
+
+/**
+ * Release the button grabs on all managed windows and regrab them,
+ * reevaluating which buttons need to be grabbed.
+ *
+ */
+void regrab_all_buttons(xcb_connection_t *conn);
 
 /**
  * Returns a pointer to the Binding that matches the given xcb event or NULL if
@@ -51,6 +62,21 @@ void translate_keysyms(void);
  */
 void switch_mode(const char *new_mode);
 
+/**
+ * Reorders bindings by event_state_mask descendingly so that get_binding()
+ * correctly matches more specific bindings before more generic bindings. Take
+ * the following binding configuration as an example:
+ *
+ *   bindsym n nop lower-case n pressed
+ *   bindsym Shift+n nop upper-case n pressed
+ *
+ * Without reordering, the first binding’s event_state_mask of 0x0 would match
+ * the actual event_stat_mask of 0x1 and hence trigger instead of the second
+ * keybinding.
+ *
+ */
+void reorder_bindings(void);
+
 /**
  * Checks for duplicate key bindings (the same keycode or keysym is configured
  * more than once). If a duplicate binding is found, a message is printed to
@@ -60,6 +86,11 @@ void switch_mode(const char *new_mode);
  */
 void check_for_duplicate_bindings(struct context *context);
 
+/**
+ * Frees the binding. If bind is null, it simply returns.
+ */
+void binding_free(Binding *bind);
+
 /**
  * Runs the given binding and handles parse errors. If con is passed, it will
  * execute the command binding with that container selected by criteria.
@@ -68,3 +99,18 @@ void check_for_duplicate_bindings(struct context *context);
  *
  */
 CommandResult *run_binding(Binding *bind, Con *con);
+
+/**
+ * Loads the XKB keymap from the X11 server and feeds it to xkbcommon.
+ *
+ */
+bool load_keymap(void);
+
+/**
+ * Returns a list of buttons that should be grabbed on a window.
+ * This list will always contain 1–3, all higher buttons will only be returned
+ * if there is a whole-window binding for it on some window in the current
+ * config.
+ * The list is terminated by a 0.
+ */
+int *bindings_get_buttons_to_grab(void);