1 /* Declarations useful when processing input.
2 Copyright (C) 1985-1987, 1993, 2001-2023 Free Software Foundation,
3 Inc.
4
5 This file is part of GNU Emacs.
6
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or (at
10 your option) any later version.
11
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. */
19
20 #ifndef EMACS_KEYBOARD_H
21 #define EMACS_KEYBOARD_H
22
23 #include "coding.h" /* for ENCODE_UTF_8 and ENCODE_SYSTEM */
24 #include "termhooks.h"
25
26 #ifdef HAVE_X11
27 # include "xterm.h" /* for struct selection_input_event */
28 #endif
29
30 #ifdef HAVE_PGTK
31 #include "pgtkterm.h" /* for struct selection_input_event */
32 #endif
33
34 INLINE_HEADER_BEGIN
35
36 /* Most code should use this macro to access Lisp fields in struct kboard. */
37
38 #define KVAR(kboard, field) ((kboard)->field ## _)
39
40 /* Each KBOARD represents one logical input stream from which Emacs
41 gets input. If we are using ordinary terminals, it has one KBOARD
42 object for each terminal device.
43 Usually each X display screen has its own KBOARD,
44 but when two of them are on the same X server,
45 we assume they share a keyboard and give them one KBOARD in common.
46
47 Some Lisp variables are per-kboard; they are stored in the KBOARD structure
48 and accessed indirectly via a Lisp_Misc_Kboard_Objfwd object.
49
50 So that definition of keyboard macros, and reading of prefix arguments,
51 can happen in parallel on various KBOARDs at once,
52 the state information for those activities is stored in the KBOARD.
53
54 Emacs has two states for reading input:
55
56 ** Any kboard. Emacs can accept input from any KBOARD,
57 and as soon as any of them provides a complete command, Emacs can run it.
58
59 ** Single kboard. Then Emacs is running a command for one KBOARD
60 and can only read input from that KBOARD.
61
62 All input, from all KBOARDs, goes together in a single event queue
63 at interrupt level. read_char sees the events sequentially,
64 but deals with them in accord with the current input state.
65
66 In the any-kboard state, read_key_sequence processes input from any KBOARD
67 immediately. When a new event comes in from a particular KBOARD,
68 read_key_sequence switches to that KBOARD. As a result,
69 as soon as a complete key arrives from some KBOARD or other,
70 Emacs starts executing that key's binding. It switches to the
71 single-kboard state for the execution of that command,
72 so that the command can get input only from its own KBOARD.
73
74 While in the single-kboard state, read_char can consider input only
75 from the current KBOARD. If events come from other KBOARDs, they
76 are put aside for later in the KBOARDs' kbd_queue lists.
77 The flag kbd_queue_has_data in a KBOARD is 1 if this has happened.
78 When Emacs goes back to the any-kboard state, it looks at all the KBOARDs
79 to find those; and it tries processing their input right away. */
80
81 typedef struct kboard KBOARD;
82 struct kboard
83 {
84 KBOARD *next_kboard;
85
86 /* If non-nil, a keymap that overrides all others but applies only to
87 this KBOARD. Lisp code that uses this instead of calling read-char
88 can effectively wait for input in the any-kboard state, and hence
89 avoid blocking out the other KBOARDs. See universal-argument in
90 lisp/simple.el for an example. */
91 Lisp_Object Voverriding_terminal_local_map_;
92
93 /* Last command executed by the editor command loop, not counting
94 commands that set the prefix argument. */
95 Lisp_Object Vlast_command_;
96
97 /* Normally same as last-command, but never modified by other commands. */
98 Lisp_Object Vreal_last_command_;
99
100 /* User-supplied table to translate input characters through. */
101 Lisp_Object Vkeyboard_translate_table_;
102
103 /* Last command that may be repeated by `repeat'. */
104 Lisp_Object Vlast_repeatable_command_;
105
106 /* The prefix argument for the next command, in raw form. */
107 Lisp_Object Vprefix_arg_;
108
109 /* Saved prefix argument for the last command, in raw form. */
110 Lisp_Object Vlast_prefix_arg_;
111
112 /* Unread events specific to this kboard. */
113 Lisp_Object kbd_queue_;
114
115 /* Non-nil while a kbd macro is being defined. */
116 Lisp_Object defining_kbd_macro_;
117
118 /* The start of storage for the current keyboard macro. */
119 Lisp_Object *kbd_macro_buffer;
120
121 /* Where to store the next keystroke of the macro. */
122 Lisp_Object *kbd_macro_ptr;
123
124 /* The finalized section of the macro starts at kbd_macro_buffer and
125 ends before this. This is not the same as kbd_macro_ptr, because
126 we advance this to kbd_macro_ptr when a key's command is complete.
127 This way, the keystrokes for "end-kbd-macro" are not included in the
128 macro. This also allows us to throw away the events added to the
129 macro by the last command: all the events between kbd_macro_end and
130 kbd_macro_ptr belong to the last command; see
131 cancel-kbd-macro-events. */
132 Lisp_Object *kbd_macro_end;
133
134 /* Allocated size of kbd_macro_buffer. */
135 ptrdiff_t kbd_macro_bufsize;
136
137 /* Last anonymous kbd macro defined. */
138 Lisp_Object Vlast_kbd_macro_;
139
140 /* Alist of system-specific X windows key symbols. */
141 Lisp_Object Vsystem_key_alist_;
142
143 /* Cache for modify_event_symbol. */
144 Lisp_Object system_key_syms_;
145
146 /* The kind of display: x, w32, ... */
147 Lisp_Object Vwindow_system_;
148
149 /* Keymap mapping keys to alternative preferred forms.
150 See the DEFVAR for more documentation. */
151 Lisp_Object Vlocal_function_key_map_;
152
153 /* Keymap mapping ASCII function key sequences onto their preferred
154 forms. Initialized by the terminal-specific lisp files. See the
155 DEFVAR for more documentation. */
156 Lisp_Object Vinput_decode_map_;
157
158 /* Minibufferless frames on this display use this frame's minibuffer. */
159 Lisp_Object Vdefault_minibuffer_frame_;
160
161 /* Number of displays using this KBOARD. Normally 1, but can be
162 larger when you have multiple screens on a single X display. */
163 int reference_count;
164
165 /* The text we're echoing in the modeline - partial key sequences,
166 usually. This is nil when not echoing. */
167 Lisp_Object echo_string_;
168
169 /* This flag indicates that events were put into kbd_queue
170 while Emacs was running for some other KBOARD.
171 The flag means that, when Emacs goes into the any-kboard state again,
172 it should check this KBOARD to see if there is a complete command
173 waiting.
174
175 Note that the kbd_queue field can be non-nil even when
176 kbd_queue_has_data is 0. When we push back an incomplete
177 command, then this flag is 0, meaning we don't want to try
178 reading from this KBOARD again until more input arrives. */
179 bool_bf kbd_queue_has_data;
180
181 /* True means echo each character as typed. */
182 bool_bf immediate_echo : 1;
183
184 /* If we have a prompt string specified by the user, this is it. */
185 Lisp_Object echo_prompt_;
186 };
187
188 INLINE void
189 kset_default_minibuffer_frame (struct kboard *kb, Lisp_Object val)
190 {
191 kb->Vdefault_minibuffer_frame_ = val;
192 }
193 INLINE void
194 kset_defining_kbd_macro (struct kboard *kb, Lisp_Object val)
195 {
196 kb->defining_kbd_macro_ = val;
197 }
198 INLINE void
199 kset_input_decode_map (struct kboard *kb, Lisp_Object val)
200 {
201 kb->Vinput_decode_map_ = val;
202 }
203 INLINE void
204 kset_last_command (struct kboard *kb, Lisp_Object val)
205 {
206 kb->Vlast_command_ = val;
207 }
208 INLINE void
209 kset_last_kbd_macro (struct kboard *kb, Lisp_Object val)
210 {
211 kb->Vlast_kbd_macro_ = val;
212 }
213 INLINE void
214 kset_prefix_arg (struct kboard *kb, Lisp_Object val)
215 {
216 kb->Vprefix_arg_ = val;
217 }
218 INLINE void
219 kset_system_key_alist (struct kboard *kb, Lisp_Object val)
220 {
221 kb->Vsystem_key_alist_ = val;
222 }
223 INLINE void
224 kset_window_system (struct kboard *kb, Lisp_Object val)
225 {
226 kb->Vwindow_system_ = val;
227 }
228
229 union buffered_input_event
230 {
231 ENUM_BF (event_kind) kind : EVENT_KIND_WIDTH;
232 struct input_event ie;
233 #if defined HAVE_X11 || defined HAVE_PGTK
234 struct selection_input_event sie;
235 #endif
236 };
237
238 /* Temporarily used before a frame has been opened. */
239 extern KBOARD *initial_kboard;
240
241 /* In the single-kboard state, this is the kboard
242 from which input is accepted.
243
244 In the any-kboard state, this is the kboard from which we are
245 right now considering input. We can consider input from another
246 kboard, but doing so requires throwing to wrong_kboard_jmpbuf. */
247 extern KBOARD *current_kboard;
248
249 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
250 extern uintmax_t num_input_events;
251
252 /* The location of point immediately before the last command was
253 executed, or the last time the undo-boundary command added a
254 boundary.*/
255 extern ptrdiff_t point_before_last_command_or_undo;
256
257 /* The value of current_buffer immediately before the last command was
258 executed, or the last time the undo-boundary command added a
259 boundary.*/
260 extern struct buffer *buffer_before_last_command_or_undo;
261
262 extern struct buffer *prev_buffer;
263
264 /* Nonzero means polling for input is temporarily suppressed. */
265 extern int poll_suppress_count;
266
267 /* Vector holding the key sequence that invoked the current command.
268 It is reused for each command, and it may be longer than the current
269 sequence; this_command_key_count indicates how many elements
270 actually mean something. */
271 extern Lisp_Object this_command_keys;
272 extern ptrdiff_t this_command_key_count;
273
274 /* The frame in which the last input event occurred, or Qmacro if the
275 last event came from a macro. We use this to determine when to
276 generate switch-frame events. This may be cleared by functions
277 like Fselect_frame, to make sure that a switch-frame event is
278 generated by the next character. */
279 extern Lisp_Object internal_last_event_frame;
280
281 /* This holds a Lisp vector that holds the properties of a single
282 menu item while decoding it in parse_menu_item.
283 Using a Lisp vector to hold this information while we decode it
284 takes care of protecting all the data from GC. */
285 extern Lisp_Object item_properties;
286
287 /* This describes the elements of item_properties.
288 The first element is not a property, it is a pointer to the item properties
289 that is saved for GC protection. */
290 #define ITEM_PROPERTY_ITEM 0
291 /* The item string. */
292 #define ITEM_PROPERTY_NAME 1
293 /* Start of initialize to nil */
294 /* The binding: nil, a command or a keymap. */
295 #define ITEM_PROPERTY_DEF 2
296 /* The keymap if the binding is a keymap, otherwise nil. */
297 #define ITEM_PROPERTY_MAP 3
298 /* Nil, :radio or :toggle. */
299 #define ITEM_PROPERTY_TYPE 4
300 /* Nil or a string describing an equivalent key binding. */
301 #define ITEM_PROPERTY_KEYEQ 5
302 /* Not nil if a selected toggle box or radio button, otherwise nil. */
303 #define ITEM_PROPERTY_SELECTED 6
304 /* Place for a help string. Not yet used. */
305 #define ITEM_PROPERTY_HELP 7
306 /* Start of initialize to t */
307 /* Last property. */
308 /* Not nil if item is enabled. */
309 #define ITEM_PROPERTY_ENABLE 8
310
311 /* This holds a Lisp vector that holds the results of decoding
312 the keymaps or alist-of-alists that specify a menu.
313
314 It describes the panes and items within the panes.
315
316 Each pane is described by 3 elements in the vector:
317 t, the pane name, the pane's prefix key.
318 Then follow the pane's items, with 5 elements per item:
319 the item string, the enable flag, the item's value,
320 the definition, and the equivalent keyboard key's description string.
321
322 In some cases, multiple levels of menus may be described.
323 A single vector slot containing nil indicates the start of a submenu.
324 A single vector slot containing lambda indicates the end of a submenu.
325 The submenu follows a menu item which is the way to reach the submenu.
326
327 A single vector slot containing quote indicates that the
328 following items should appear on the right of a dialog box.
329
330 Using a Lisp vector to hold this information while we decode it
331 takes care of protecting all the data from GC. */
332 extern Lisp_Object menu_items;
333
334 /* Whether the global vars defined here are already in use.
335 Used to detect cases where we try to re-enter this non-reentrant code. */
336 extern bool menu_items_inuse;
337
338 /* Number of slots currently allocated in menu_items. */
339 extern int menu_items_allocated;
340
341 /* This is the index in menu_items of the first empty slot. */
342 extern int menu_items_used;
343
344 /* The number of panes currently recorded in menu_items,
345 excluding those within submenus. */
346 extern int menu_items_n_panes;
347
348 #define MENU_ITEMS_PANE_NAME 1
349 #define MENU_ITEMS_PANE_PREFIX 2
350 #define MENU_ITEMS_PANE_LENGTH 3
351
352 enum menu_item_idx
353 {
354 MENU_ITEMS_ITEM_NAME = 0,
355 MENU_ITEMS_ITEM_ENABLE,
356 MENU_ITEMS_ITEM_VALUE,
357 MENU_ITEMS_ITEM_EQUIV_KEY,
358 MENU_ITEMS_ITEM_DEFINITION,
359 MENU_ITEMS_ITEM_TYPE,
360 MENU_ITEMS_ITEM_SELECTED,
361 MENU_ITEMS_ITEM_HELP,
362 MENU_ITEMS_ITEM_LENGTH
363 };
364
365 enum
366 {
367 KBD_BUFFER_SIZE = 4096
368 };
369
370 extern void unuse_menu_items (void);
371
372 /* This is how to deal with multibyte text if HAVE_MULTILINGUAL_MENU
373 isn't defined. The use of HAVE_MULTILINGUAL_MENU could probably be
374 confined to an extended version of this with sections of code below
375 using it unconditionally. */
376 #ifndef HAVE_NTGUI
377 #if defined (USE_GTK) || defined (HAVE_NS)
378 # define ENCODE_MENU_STRING(str) ENCODE_UTF_8 (str)
379 #elif defined HAVE_X_I18N
380 #define ENCODE_MENU_STRING(str) ENCODE_SYSTEM (str)
381 #else
382 #define ENCODE_MENU_STRING(str) string_make_unibyte (str)
383 #endif /* USE_GTK */
384 #else /* HAVE_NTGUI */
385 #define ENCODE_MENU_STRING(str) (str)
386 #endif
387
388 /* Macros for dealing with lispy events. */
389
390 /* True if EVENT has data fields describing it (i.e. a mouse click). */
391 #define EVENT_HAS_PARAMETERS(event) (CONSP (event))
392
393 /* Extract the head from an event.
394 This works on composite and simple events. */
395 #define EVENT_HEAD(event) \
396 (EVENT_HAS_PARAMETERS (event) ? XCAR (event) : (event))
397
398 /* Extract the starting and ending positions from a composite event. */
399 #define EVENT_START(event) (CAR_SAFE (CDR_SAFE (event)))
400 #define EVENT_END(event) (CAR_SAFE (CDR_SAFE (CDR_SAFE (event))))
401
402 /* Extract the click count from a multi-click event. */
403 #define EVENT_CLICK_COUNT(event) (Fnth (make_fixnum (2), (event)))
404
405 /* Extract the fields of a position. */
406 #define POSN_WINDOW(posn) (CAR_SAFE (posn))
407 #define POSN_POSN(posn) (CAR_SAFE (CDR_SAFE (posn)))
408 #define POSN_SET_POSN(posn,x) (XSETCAR (XCDR (posn), (x)))
409 #define POSN_WINDOW_POSN(posn) (CAR_SAFE (CDR_SAFE (CDR_SAFE (posn))))
410 #define POSN_TIMESTAMP(posn) (CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (posn)))))
411 #define POSN_SCROLLBAR_PART(posn) (Fnth (make_fixnum (4), (posn)))
412
413 /* A cons (STRING . STRING-CHARPOS), or nil in mouse-click events.
414 It's a cons if the click is over a string in the mode line. */
415
416 #define POSN_STRING(posn) (Fnth (make_fixnum (4), (posn)))
417
418 /* If POSN_STRING is nil, event refers to buffer location. */
419
420 #define POSN_INBUFFER_P(posn) (NILP (POSN_STRING (posn)))
421 #define POSN_BUFFER_POSN(posn) (Fnth (make_fixnum (5), (posn)))
422
423 /* Getting the kind of an event head. */
424 #define EVENT_HEAD_KIND(event_head) \
425 (Fget ((event_head), Qevent_kind))
426
427 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
428 happens. */
429 extern struct timespec *input_available_clear_time;
430
431 extern union buffered_input_event kbd_buffer[KBD_BUFFER_SIZE];
432 extern union buffered_input_event *kbd_fetch_ptr;
433 extern union buffered_input_event *kbd_store_ptr;
434
435 extern bool ignore_mouse_drag_p;
436
437 extern Lisp_Object parse_modifiers (Lisp_Object);
438 extern Lisp_Object reorder_modifiers (Lisp_Object);
439 extern Lisp_Object read_char (int, Lisp_Object, Lisp_Object,
440 bool *, struct timespec *);
441 extern int parse_solitary_modifier (Lisp_Object symbol);
442
443
444 /* This is like Vthis_command, except that commands never set it. */
445 extern Lisp_Object real_this_command;
446
447 extern int quit_char;
448 extern bool input_was_pending;
449 extern unsigned int timers_run;
450
451 extern bool menu_separator_name_p (const char *);
452 extern bool parse_menu_item (Lisp_Object, int);
453
454 extern void init_raw_keybuf_count (void);
455 extern KBOARD *allocate_kboard (Lisp_Object);
456 extern void delete_kboard (KBOARD *);
457 extern void not_single_kboard_state (KBOARD *);
458 extern void push_kboard (struct kboard *);
459 extern void push_frame_kboard (struct frame *);
460 extern void pop_kboard (void);
461 extern void temporarily_switch_to_single_kboard (struct frame *);
462 extern void input_poll_signal (int);
463 extern void start_polling (void);
464 extern void stop_polling (void);
465 extern void set_poll_suppress_count (int);
466 extern int gobble_input (void);
467 extern bool input_polling_used (void);
468 extern void clear_input_pending (void);
469 extern bool requeued_events_pending_p (void);
470 extern void bind_polling_period (int);
471 extern int make_ctrl_char (int) ATTRIBUTE_CONST;
472 extern void stuff_buffered_input (Lisp_Object);
473 extern void clear_waiting_for_input (void);
474 extern void swallow_events (bool);
475 extern bool lucid_event_type_list_p (Lisp_Object);
476 extern void kbd_buffer_store_event (struct input_event *);
477 extern void kbd_buffer_store_buffered_event (union buffered_input_event *,
478 struct input_event *);
479 INLINE void
480 kbd_buffer_store_event_hold (struct input_event *event,
481 struct input_event *hold_quit)
482 {
483 verify (alignof (struct input_event) == alignof (union buffered_input_event)
484 && sizeof (struct input_event) == sizeof (union buffered_input_event));
485 kbd_buffer_store_buffered_event ((union buffered_input_event *) event,
486 hold_quit);
487 }
488 extern void poll_for_input_1 (void);
489 extern void show_help_echo (Lisp_Object, Lisp_Object, Lisp_Object,
490 Lisp_Object);
491 extern void gen_help_event (Lisp_Object, Lisp_Object, Lisp_Object,
492 Lisp_Object, ptrdiff_t);
493 extern void kbd_buffer_store_help_event (Lisp_Object, Lisp_Object);
494 extern Lisp_Object menu_item_eval_property (Lisp_Object);
495 extern bool kbd_buffer_events_waiting (void);
496 extern void add_user_signal (int, const char *);
497
498 extern int tty_read_avail_input (struct terminal *, struct input_event *);
499 extern struct timespec timer_check (void);
500 extern void mark_kboards (void);
501
502 #if defined HAVE_NTGUI || defined HAVE_X_WINDOWS || defined HAVE_PGTK
503 extern const char *const lispy_function_keys[];
504 #endif
505
506 extern char const DEV_TTY[];
507
508 INLINE_HEADER_END
509
510 #endif /* EMACS_KEYBOARD_H */