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