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