rofi  1.7.0
keyb.c
Go to the documentation of this file.
1 /*
2  * rofi
3  *
4  * MIT/X11 License
5  * Copyright © 2013-2021 Qball Cow <qball@gmpclient.org>
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining
8  * a copy of this software and associated documentation files (the
9  * "Software"), to deal in the Software without restriction, including
10  * without limitation the rights to use, copy, modify, merge, publish,
11  * distribute, sublicense, and/or sell copies of the Software, and to
12  * permit persons to whom the Software is furnished to do so, subject to
13  * the following conditions:
14  *
15  * The above copyright notice and this permission notice shall be
16  * included in all copies or substantial portions of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
21  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
22  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25  *
26  */
27 
28 #include "config.h"
29 #include <string.h>
30 #include "rofi.h"
31 #include "nkutils-bindings.h"
32 #include "xrmoptions.h"
33 
34 typedef struct
35 {
36  guint id;
37  guint scope;
38  char *name;
39  char *binding;
40  char *comment;
42 
47 {
48  { .id = PASTE_PRIMARY, .name = "kb-primary-paste", .binding = "Control+V,Shift+Insert", .comment = "Paste primary selection" },
49  { .id = PASTE_SECONDARY, .name = "kb-secondary-paste", .binding = "Control+v,Insert", .comment = "Paste clipboard" },
50  { .id = CLEAR_LINE, .name = "kb-clear-line", .binding = "Control+w", .comment = "Clear input line" },
51  { .id = MOVE_FRONT, .name = "kb-move-front", .binding = "Control+a", .comment = "Beginning of line" },
52  { .id = MOVE_END, .name = "kb-move-end", .binding = "Control+e", .comment = "End of line" },
53  { .id = MOVE_WORD_BACK, .name = "kb-move-word-back", .binding = "Alt+b,Control+Left", .comment = "Move back one word" },
54  { .id = MOVE_WORD_FORWARD, .name = "kb-move-word-forward", .binding = "Alt+f,Control+Right", .comment = "Move forward one word" },
55  { .id = MOVE_CHAR_BACK, .name = "kb-move-char-back", .binding = "Left,Control+b", .comment = "Move back one char" },
56  { .id = MOVE_CHAR_FORWARD, .name = "kb-move-char-forward", .binding = "Right,Control+f", .comment = "Move forward one char" },
57  { .id = REMOVE_WORD_BACK, .name = "kb-remove-word-back", .binding = "Control+Alt+h,Control+BackSpace", .comment = "Delete previous word" },
58  { .id = REMOVE_WORD_FORWARD, .name = "kb-remove-word-forward", .binding = "Control+Alt+d", .comment = "Delete next word" },
59  { .id = REMOVE_CHAR_FORWARD, .name = "kb-remove-char-forward", .binding = "Delete,Control+d", .comment = "Delete next char" },
60  { .id = REMOVE_CHAR_BACK, .name = "kb-remove-char-back", .binding = "BackSpace,Shift+BackSpace,Control+h", .comment = "Delete previous char" },
61  { .id = REMOVE_TO_EOL, .name = "kb-remove-to-eol", .binding = "Control+k", .comment = "Delete till the end of line" },
62  { .id = REMOVE_TO_SOL, .name = "kb-remove-to-sol", .binding = "Control+u", .comment = "Delete till the start of line" },
63  { .id = ACCEPT_ENTRY, .name = "kb-accept-entry", .binding = "Control+j,Control+m,Return,KP_Enter", .comment = "Accept entry" },
64  { .id = ACCEPT_CUSTOM, .name = "kb-accept-custom", .binding = "Control+Return", .comment = "Use entered text as command (in ssh/run modi)" },
65  { .id = ACCEPT_CUSTOM_ALT, .name = "kb-accept-custom-alt", .binding = "Control+Shift+Return", .comment = "Use entered text as command (in ssh/run modi)" },
66  { .id = ACCEPT_ALT, .name = "kb-accept-alt", .binding = "Shift+Return", .comment = "Use alternate accept command." },
67  { .id = DELETE_ENTRY, .name = "kb-delete-entry", .binding = "Shift+Delete", .comment = "Delete entry from history" },
68  { .id = MODE_NEXT, .name = "kb-mode-next", .binding = "Shift+Right,Control+Tab", .comment = "Switch to the next mode." },
69  { .id = MODE_PREVIOUS, .name = "kb-mode-previous", .binding = "Shift+Left,Control+ISO_Left_Tab", .comment = "Switch to the previous mode." },
70  { .id = MODE_COMPLETE, .name = "kb-mode-complete", .binding = "Control+l", .comment = "Start completion for mode." },
71  { .id = ROW_LEFT, .name = "kb-row-left", .binding = "Control+Page_Up", .comment = "Go to the previous column" },
72  { .id = ROW_RIGHT, .name = "kb-row-right", .binding = "Control+Page_Down", .comment = "Go to the next column" },
73  { .id = ROW_UP, .name = "kb-row-up", .binding = "Up,Control+p,ISO_Left_Tab", .comment = "Select previous entry" },
74  { .id = ROW_DOWN, .name = "kb-row-down", .binding = "Down,Control+n", .comment = "Select next entry" },
75  { .id = ROW_TAB, .name = "kb-row-tab", .binding = "Tab", .comment = "Go to next row, if one left, accept it, if no left next mode." },
76  { .id = PAGE_PREV, .name = "kb-page-prev", .binding = "Page_Up", .comment = "Go to the previous page" },
77  { .id = PAGE_NEXT, .name = "kb-page-next", .binding = "Page_Down", .comment = "Go to the next page" },
78  { .id = ROW_FIRST, .name = "kb-row-first", .binding = "Home,KP_Home", .comment = "Go to the first entry" },
79  { .id = ROW_LAST, .name = "kb-row-last", .binding = "End,KP_End", .comment = "Go to the last entry" },
80  { .id = ROW_SELECT, .name = "kb-row-select", .binding = "Control+space", .comment = "Set selected item as input text" },
81  { .id = SCREENSHOT, .name = "kb-screenshot", .binding = "Alt+S", .comment = "Take a screenshot of the rofi window" },
82  { .id = CHANGE_ELLIPSIZE, .name = "kb-ellipsize", .binding = "Alt+period", .comment = "Toggle between ellipsize modes for displayed data" },
83  { .id = TOGGLE_CASE_SENSITIVITY, .name = "kb-toggle-case-sensitivity", .binding = "grave,dead_grave", .comment = "Toggle case sensitivity" },
84  { .id = TOGGLE_SORT, .name = "kb-toggle-sort", .binding = "Alt+grave", .comment = "Toggle sort" },
85  { .id = CANCEL, .name = "kb-cancel", .binding = "Escape,Control+g,Control+bracketleft", .comment = "Quit rofi" },
86  { .id = CUSTOM_1, .name = "kb-custom-1", .binding = "Alt+1", .comment = "Custom keybinding 1" },
87  { .id = CUSTOM_2, .name = "kb-custom-2", .binding = "Alt+2", .comment = "Custom keybinding 2" },
88  { .id = CUSTOM_3, .name = "kb-custom-3", .binding = "Alt+3", .comment = "Custom keybinding 3" },
89  { .id = CUSTOM_4, .name = "kb-custom-4", .binding = "Alt+4", .comment = "Custom keybinding 4" },
90  { .id = CUSTOM_5, .name = "kb-custom-5", .binding = "Alt+5", .comment = "Custom Keybinding 5" },
91  { .id = CUSTOM_6, .name = "kb-custom-6", .binding = "Alt+6", .comment = "Custom keybinding 6" },
92  { .id = CUSTOM_7, .name = "kb-custom-7", .binding = "Alt+7", .comment = "Custom Keybinding 7" },
93  { .id = CUSTOM_8, .name = "kb-custom-8", .binding = "Alt+8", .comment = "Custom keybinding 8" },
94  { .id = CUSTOM_9, .name = "kb-custom-9", .binding = "Alt+9", .comment = "Custom keybinding 9" },
95  { .id = CUSTOM_10, .name = "kb-custom-10", .binding = "Alt+0", .comment = "Custom keybinding 10" },
96  { .id = CUSTOM_11, .name = "kb-custom-11", .binding = "Alt+exclam", .comment = "Custom keybinding 11" },
97  { .id = CUSTOM_12, .name = "kb-custom-12", .binding = "Alt+at", .comment = "Custom keybinding 12" },
98  { .id = CUSTOM_13, .name = "kb-custom-13", .binding = "Alt+numbersign", .comment = "Custom keybinding 13" },
99  { .id = CUSTOM_14, .name = "kb-custom-14", .binding = "Alt+dollar", .comment = "Custom keybinding 14" },
100  { .id = CUSTOM_15, .name = "kb-custom-15", .binding = "Alt+percent", .comment = "Custom keybinding 15" },
101  { .id = CUSTOM_16, .name = "kb-custom-16", .binding = "Alt+dead_circumflex", .comment = "Custom keybinding 16" },
102  { .id = CUSTOM_17, .name = "kb-custom-17", .binding = "Alt+ampersand", .comment = "Custom keybinding 17" },
103  { .id = CUSTOM_18, .name = "kb-custom-18", .binding = "Alt+asterisk", .comment = "Custom keybinding 18" },
104  { .id = CUSTOM_19, .name = "kb-custom-19", .binding = "Alt+parenleft", .comment = "Custom Keybinding 19" },
105  { .id = SELECT_ELEMENT_1, .name = "kb-select-1", .binding = "Super+1", .comment = "Select row 1" },
106  { .id = SELECT_ELEMENT_2, .name = "kb-select-2", .binding = "Super+2", .comment = "Select row 2" },
107  { .id = SELECT_ELEMENT_3, .name = "kb-select-3", .binding = "Super+3", .comment = "Select row 3" },
108  { .id = SELECT_ELEMENT_4, .name = "kb-select-4", .binding = "Super+4", .comment = "Select row 4" },
109  { .id = SELECT_ELEMENT_5, .name = "kb-select-5", .binding = "Super+5", .comment = "Select row 5" },
110  { .id = SELECT_ELEMENT_6, .name = "kb-select-6", .binding = "Super+6", .comment = "Select row 6" },
111  { .id = SELECT_ELEMENT_7, .name = "kb-select-7", .binding = "Super+7", .comment = "Select row 7" },
112  { .id = SELECT_ELEMENT_8, .name = "kb-select-8", .binding = "Super+8", .comment = "Select row 8" },
113  { .id = SELECT_ELEMENT_9, .name = "kb-select-9", .binding = "Super+9", .comment = "Select row 9" },
114  { .id = SELECT_ELEMENT_10, .name = "kb-select-10", .binding = "Super+0", .comment = "Select row 10" },
115 
116  /* Mouse-aware bindings */
117 
118  { .id = SCROLL_LEFT, .scope = SCOPE_MOUSE_LISTVIEW, .name = "ml-row-left", .binding = "ScrollLeft", .comment = "Go to the previous column" },
119  { .id = SCROLL_RIGHT, .scope = SCOPE_MOUSE_LISTVIEW, .name = "ml-row-right", .binding = "ScrollRight", .comment = "Go to the next column" },
120  { .id = SCROLL_UP, .scope = SCOPE_MOUSE_LISTVIEW, .name = "ml-row-up", .binding = "ScrollUp", .comment = "Select previous entry" },
121  { .id = SCROLL_DOWN, .scope = SCOPE_MOUSE_LISTVIEW, .name = "ml-row-down", .binding = "ScrollDown", .comment = "Select next entry" },
122 
123  { .id = SELECT_HOVERED_ENTRY, .scope = SCOPE_MOUSE_LISTVIEW_ELEMENT, .name = "me-select-entry", .binding = "MousePrimary", .comment = "Select hovered row" },
124  { .id = ACCEPT_HOVERED_ENTRY, .scope = SCOPE_MOUSE_LISTVIEW_ELEMENT, .name = "me-accept-entry", .binding = "MouseDPrimary", .comment = "Accept hovered row" },
125  { .id = ACCEPT_HOVERED_CUSTOM, .scope = SCOPE_MOUSE_LISTVIEW_ELEMENT, .name = "me-accept-custom", .binding = "Control+MouseDPrimary", .comment = "Accept hovered row with custom action"},
126 };
127 
129 static const gchar *mouse_default_bindings[] = {
130  [MOUSE_CLICK_DOWN] = "MousePrimary",
131  [MOUSE_CLICK_UP] = "!MousePrimary",
132  [MOUSE_DCLICK_DOWN] = "MouseDPrimary",
133  [MOUSE_DCLICK_UP] = "!MouseDPrimary",
134 };
135 
136 void setup_abe ( void )
137 {
138  for ( gsize i = 0; i < G_N_ELEMENTS ( rofi_bindings ); ++i ) {
140  b->binding = g_strdup ( b->binding );
141  config_parser_add_option ( xrm_String, b->name, (void * *) &( b->binding ), b->comment );
142  }
143 }
144 
145 static gboolean binding_trigger_action ( guint64 scope, G_GNUC_UNUSED gpointer target, gpointer user_data )
146 {
147  return rofi_view_trigger_action ( rofi_view_get_active (), scope, GPOINTER_TO_UINT ( user_data ) );
148 }
149 
150 guint key_binding_get_action_from_name ( const char *name )
151 {
152  for ( gsize i = 0; i < G_N_ELEMENTS ( rofi_bindings ); ++i ) {
154  if ( g_strcmp0(b->name, name) == 0 ) {
155  return b->id;
156  }
157  }
158  return UINT32_MAX;
159 }
160 
161 
162 gboolean parse_keys_abe ( NkBindings *bindings )
163 {
164  GError *error = NULL;
165  GString *error_msg = g_string_new ( "" );
166  for ( gsize i = 0; i < G_N_ELEMENTS ( rofi_bindings ); ++i ) {
168  char *keystr = g_strdup ( b->binding );
169  char *sp = NULL;
170 
171  // Iter over bindings.
172  const char *const sep = ",";
173  for ( char *entry = strtok_r ( keystr, sep, &sp ); entry != NULL; entry = strtok_r ( NULL, sep, &sp ) ) {
174  if ( !nk_bindings_add_binding ( bindings, b->scope, entry, binding_trigger_action, GUINT_TO_POINTER ( b->id ), NULL, &error ) ) {
175  char *str = g_markup_printf_escaped ( "Failed to set binding <i>%s</i> for: <i>%s (%s)</i>:\n\t<span size=\"smaller\" style=\"italic\">%s</span>\n",
176  b->binding, b->comment, b->name, error->message );
177  g_string_append ( error_msg, str );
178  g_free ( str );
179  g_clear_error ( &error );
180  }
181  }
182 
183  g_free ( keystr );
184  }
185  if ( error_msg->len > 0 ) {
186  //rofi_view_error_dialog ( error_msg->str, TRUE );
187  rofi_add_error_message ( error_msg );
188 // g_string_free ( error_msg, TRUE );
189  return FALSE;
190  }
191 
192  for ( gsize i = SCOPE_MIN_FIXED; i <= SCOPE_MAX_FIXED; ++i ) {
193  for ( gsize j = 1; j < G_N_ELEMENTS ( mouse_default_bindings ); ++j ) {
194  nk_bindings_add_binding ( bindings, i, mouse_default_bindings[j], binding_trigger_action, GSIZE_TO_POINTER ( j ), NULL, NULL );
195  }
196  }
197 
198  g_string_free ( error_msg, TRUE );
199  return TRUE;
200 }
void config_parser_add_option(XrmOptionType type, const char *key, void **value, const char *comment)
Definition: xrmoptions.c:424
@ xrm_String
Definition: xrmoptions.h:74
gboolean parse_keys_abe(NkBindings *bindings)
Definition: keyb.c:162
guint key_binding_get_action_from_name(const char *name)
Definition: keyb.c:150
void setup_abe(void)
Definition: keyb.c:136
@ SCOPE_MOUSE_LISTVIEW_ELEMENT
Definition: keyb.h:46
@ SCOPE_MOUSE_LISTVIEW
Definition: keyb.h:45
@ ROW_LAST
Definition: keyb.h:107
@ CUSTOM_4
Definition: keyb.h:113
@ CUSTOM_17
Definition: keyb.h:126
@ CUSTOM_12
Definition: keyb.h:121
@ CUSTOM_9
Definition: keyb.h:118
@ REMOVE_TO_SOL
Definition: keyb.h:88
@ ROW_RIGHT
Definition: keyb.h:100
@ ROW_UP
Definition: keyb.h:101
@ CUSTOM_8
Definition: keyb.h:117
@ SELECT_ELEMENT_9
Definition: keyb.h:140
@ MOVE_FRONT
Definition: keyb.h:66
@ REMOVE_WORD_FORWARD
Definition: keyb.h:80
@ CHANGE_ELLIPSIZE
Definition: keyb.h:130
@ ACCEPT_CUSTOM_ALT
Definition: keyb.h:93
@ REMOVE_WORD_BACK
Definition: keyb.h:78
@ TOGGLE_SORT
Definition: keyb.h:131
@ ACCEPT_ENTRY
Definition: keyb.h:90
@ ROW_TAB
Definition: keyb.h:103
@ PAGE_NEXT
Definition: keyb.h:105
@ TOGGLE_CASE_SENSITIVITY
Definition: keyb.h:97
@ MOVE_CHAR_FORWARD
Definition: keyb.h:76
@ MOVE_WORD_FORWARD
Definition: keyb.h:72
@ MODE_COMPLETE
Definition: keyb.h:95
@ CUSTOM_1
Definition: keyb.h:110
@ SELECT_ELEMENT_6
Definition: keyb.h:137
@ CUSTOM_18
Definition: keyb.h:127
@ CUSTOM_15
Definition: keyb.h:124
@ CUSTOM_11
Definition: keyb.h:120
@ ACCEPT_CUSTOM
Definition: keyb.h:92
@ CUSTOM_5
Definition: keyb.h:114
@ CUSTOM_19
Definition: keyb.h:128
@ REMOVE_TO_EOL
Definition: keyb.h:86
@ SELECT_ELEMENT_3
Definition: keyb.h:134
@ ROW_SELECT
Definition: keyb.h:108
@ PASTE_PRIMARY
Definition: keyb.h:60
@ ROW_DOWN
Definition: keyb.h:102
@ CUSTOM_13
Definition: keyb.h:122
@ PASTE_SECONDARY
Definition: keyb.h:62
@ SELECT_ELEMENT_10
Definition: keyb.h:141
@ PAGE_PREV
Definition: keyb.h:104
@ CUSTOM_3
Definition: keyb.h:112
@ CUSTOM_7
Definition: keyb.h:116
@ SELECT_ELEMENT_5
Definition: keyb.h:136
@ ROW_FIRST
Definition: keyb.h:106
@ CUSTOM_6
Definition: keyb.h:115
@ ROW_LEFT
Definition: keyb.h:99
@ CUSTOM_14
Definition: keyb.h:123
@ SELECT_ELEMENT_4
Definition: keyb.h:135
@ MOVE_WORD_BACK
Definition: keyb.h:70
@ MOVE_END
Definition: keyb.h:68
@ CUSTOM_10
Definition: keyb.h:119
@ MODE_NEXT
Definition: keyb.h:94
@ REMOVE_CHAR_BACK
Definition: keyb.h:84
@ DELETE_ENTRY
Definition: keyb.h:98
@ SELECT_ELEMENT_1
Definition: keyb.h:132
@ CLEAR_LINE
Definition: keyb.h:64
@ CUSTOM_2
Definition: keyb.h:111
@ SELECT_ELEMENT_2
Definition: keyb.h:133
@ SCREENSHOT
Definition: keyb.h:129
@ CANCEL
Definition: keyb.h:109
@ MODE_PREVIOUS
Definition: keyb.h:96
@ ACCEPT_ALT
Definition: keyb.h:91
@ SELECT_ELEMENT_7
Definition: keyb.h:138
@ MOVE_CHAR_BACK
Definition: keyb.h:74
@ SELECT_ELEMENT_8
Definition: keyb.h:139
@ REMOVE_CHAR_FORWARD
Definition: keyb.h:82
@ CUSTOM_16
Definition: keyb.h:125
@ ACCEPT_HOVERED_ENTRY
Definition: keyb.h:159
@ ACCEPT_HOVERED_CUSTOM
Definition: keyb.h:160
@ SELECT_HOVERED_ENTRY
Definition: keyb.h:158
@ SCROLL_LEFT
Definition: keyb.h:148
@ SCROLL_DOWN
Definition: keyb.h:150
@ SCROLL_RIGHT
Definition: keyb.h:149
@ SCROLL_UP
Definition: keyb.h:151
@ MOUSE_CLICK_DOWN
Definition: keyb.h:167
@ MOUSE_DCLICK_UP
Definition: keyb.h:170
@ MOUSE_CLICK_UP
Definition: keyb.h:168
@ MOUSE_DCLICK_DOWN
Definition: keyb.h:169
void rofi_add_error_message(GString *str)
Definition: rofi.c:89
RofiViewState * rofi_view_get_active(void)
Definition: view.c:518
gboolean rofi_view_trigger_action(RofiViewState *state, BindingsScope scope, guint action)
Definition: view.c:1462
ActionBindingEntry rofi_bindings[]
Definition: keyb.c:46
static gboolean binding_trigger_action(guint64 scope, G_GNUC_UNUSED gpointer target, gpointer user_data)
Definition: keyb.c:145
static const gchar * mouse_default_bindings[]
Definition: keyb.c:129
#define SCOPE_MAX_FIXED
Definition: keyb.h:52
#define SCOPE_MIN_FIXED
Definition: keyb.h:48
NkBindings * bindings
Definition: rofi.c:119
guint scope
Definition: keyb.c:37
char * name
Definition: keyb.c:38
char * comment
Definition: keyb.c:40
char * binding
Definition: keyb.c:39