Add forgotten ChangeLog entry for bug#16244
[emacs.git] / src / keyboard.h
blobda83b9b01ed9d8d5f2e36dd7733ab15969885642
1 /* Declarations useful when processing input.
2 Copyright (C) 1985-1987, 1993, 2001-2014 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 struct timespec, Time */
21 #include "coding.h" /* for ENCODE_UTF_8 and ENCODE_SYSTEM */
22 #include "termhooks.h"
24 INLINE_HEADER_BEGIN
26 /* Most code should use this macro to access Lisp fields in struct kboard. */
28 #define KVAR(kboard, field) ((kboard)->INTERNAL_FIELD (field))
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.
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.
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.
44 Emacs has two states for reading input:
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.
49 ** Single kboard. Then Emacs is running a command for one KBOARD
50 and can only read input from that KBOARD.
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.
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.
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. */
71 typedef struct kboard KBOARD;
72 struct kboard
74 KBOARD *next_kboard;
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);
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);
87 /* Normally same as last-command, but never modified by other commands. */
88 Lisp_Object INTERNAL_FIELD (Vreal_last_command);
90 /* User-supplied table to translate input characters through. */
91 Lisp_Object INTERNAL_FIELD (Vkeyboard_translate_table);
93 /* Last command that may be repeated by `repeat'. */
94 Lisp_Object INTERNAL_FIELD (Vlast_repeatable_command);
96 /* The prefix argument for the next command, in raw form. */
97 Lisp_Object INTERNAL_FIELD (Vprefix_arg);
99 /* Saved prefix argument for the last command, in raw form. */
100 Lisp_Object INTERNAL_FIELD (Vlast_prefix_arg);
102 /* Unread events specific to this kboard. */
103 Lisp_Object INTERNAL_FIELD (kbd_queue);
105 /* Non-nil while a kbd macro is being defined. */
106 Lisp_Object INTERNAL_FIELD (defining_kbd_macro);
108 /* The start of storage for the current keyboard macro. */
109 Lisp_Object *kbd_macro_buffer;
111 /* Where to store the next keystroke of the macro. */
112 Lisp_Object *kbd_macro_ptr;
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;
124 /* Allocated size of kbd_macro_buffer. */
125 ptrdiff_t kbd_macro_bufsize;
127 /* Last anonymous kbd macro defined. */
128 Lisp_Object INTERNAL_FIELD (Vlast_kbd_macro);
130 /* Alist of system-specific X windows key symbols. */
131 Lisp_Object INTERNAL_FIELD (Vsystem_key_alist);
133 /* Cache for modify_event_symbol. */
134 Lisp_Object INTERNAL_FIELD (system_key_syms);
136 /* The kind of display: x, w32, ... */
137 Lisp_Object INTERNAL_FIELD (Vwindow_system);
139 /* Keymap mapping keys to alternative preferred forms.
140 See the DEFVAR for more documentation. */
141 Lisp_Object INTERNAL_FIELD (Vlocal_function_key_map);
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);
148 /* Minibufferless frames on this display use this frame's minibuffer. */
149 Lisp_Object INTERNAL_FIELD (Vdefault_minibuffer_frame);
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;
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);
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.
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;
171 /* True means echo each character as typed. */
172 bool_bf immediate_echo : 1;
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;
179 INLINE void
180 kset_default_minibuffer_frame (struct kboard *kb, Lisp_Object val)
182 kb->INTERNAL_FIELD (Vdefault_minibuffer_frame) = val;
184 INLINE void
185 kset_defining_kbd_macro (struct kboard *kb, Lisp_Object val)
187 kb->INTERNAL_FIELD (defining_kbd_macro) = val;
189 INLINE void
190 kset_input_decode_map (struct kboard *kb, Lisp_Object val)
192 kb->INTERNAL_FIELD (Vinput_decode_map) = val;
194 INLINE void
195 kset_last_command (struct kboard *kb, Lisp_Object val)
197 kb->INTERNAL_FIELD (Vlast_command) = val;
199 INLINE void
200 kset_last_kbd_macro (struct kboard *kb, Lisp_Object val)
202 kb->INTERNAL_FIELD (Vlast_kbd_macro) = val;
204 INLINE void
205 kset_prefix_arg (struct kboard *kb, Lisp_Object val)
207 kb->INTERNAL_FIELD (Vprefix_arg) = val;
209 INLINE void
210 kset_system_key_alist (struct kboard *kb, Lisp_Object val)
212 kb->INTERNAL_FIELD (Vsystem_key_alist) = val;
214 INLINE void
215 kset_window_system (struct kboard *kb, Lisp_Object val)
217 kb->INTERNAL_FIELD (Vwindow_system) = val;
220 /* Temporarily used before a frame has been opened. */
221 extern KBOARD *initial_kboard;
223 /* In the single-kboard state, this is the kboard
224 from which input is accepted.
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;
231 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
232 extern uintmax_t num_input_events;
234 /* Nonzero means polling for input is temporarily suppressed. */
235 extern int poll_suppress_count;
237 /* Vector holding the key sequence that invoked the current command.
238 It is reused for each command, and it may be longer than the current
239 sequence; this_command_key_count indicates how many elements
240 actually mean something. */
241 extern Lisp_Object this_command_keys;
242 extern ptrdiff_t this_command_key_count;
244 /* The frame in which the last input event occurred, or Qmacro if the
245 last event came from a macro. We use this to determine when to
246 generate switch-frame events. This may be cleared by functions
247 like Fselect_frame, to make sure that a switch-frame event is
248 generated by the next character. */
249 extern Lisp_Object internal_last_event_frame;
251 extern Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;
253 /* This holds a Lisp vector that holds the properties of a single
254 menu item while decoding it in parse_menu_item.
255 Using a Lisp vector to hold this information while we decode it
256 takes care of protecting all the data from GC. */
257 extern Lisp_Object item_properties;
259 /* This describes the elements of item_properties.
260 The first element is not a property, it is a pointer to the item properties
261 that is saved for GC protection. */
262 #define ITEM_PROPERTY_ITEM 0
263 /* The item string. */
264 #define ITEM_PROPERTY_NAME 1
265 /* Start of initialize to nil */
266 /* The binding: nil, a command or a keymap. */
267 #define ITEM_PROPERTY_DEF 2
268 /* The keymap if the binding is a keymap, otherwise nil. */
269 #define ITEM_PROPERTY_MAP 3
270 /* Nil, :radio or :toggle. */
271 #define ITEM_PROPERTY_TYPE 4
272 /* Nil or a string describing an equivalent key binding. */
273 #define ITEM_PROPERTY_KEYEQ 5
274 /* Not nil if a selected toggle box or radio button, otherwise nil. */
275 #define ITEM_PROPERTY_SELECTED 6
276 /* Place for a help string. Not yet used. */
277 #define ITEM_PROPERTY_HELP 7
278 /* Start of initialize to t */
279 /* Last property. */
280 /* Not nil if item is enabled. */
281 #define ITEM_PROPERTY_ENABLE 8
283 /* This holds a Lisp vector that holds the results of decoding
284 the keymaps or alist-of-alists that specify a menu.
286 It describes the panes and items within the panes.
288 Each pane is described by 3 elements in the vector:
289 t, the pane name, the pane's prefix key.
290 Then follow the pane's items, with 5 elements per item:
291 the item string, the enable flag, the item's value,
292 the definition, and the equivalent keyboard key's description string.
294 In some cases, multiple levels of menus may be described.
295 A single vector slot containing nil indicates the start of a submenu.
296 A single vector slot containing lambda indicates the end of a submenu.
297 The submenu follows a menu item which is the way to reach the submenu.
299 A single vector slot containing quote indicates that the
300 following items should appear on the right of a dialog box.
302 Using a Lisp vector to hold this information while we decode it
303 takes care of protecting all the data from GC. */
304 extern Lisp_Object menu_items;
306 /* If non-nil, means that the global vars defined here are already in use.
307 Used to detect cases where we try to re-enter this non-reentrant code. */
308 extern Lisp_Object menu_items_inuse;
310 /* Number of slots currently allocated in menu_items. */
311 extern int menu_items_allocated;
313 /* This is the index in menu_items of the first empty slot. */
314 extern int menu_items_used;
316 /* The number of panes currently recorded in menu_items,
317 excluding those within submenus. */
318 extern int menu_items_n_panes;
320 #define MENU_ITEMS_PANE_NAME 1
321 #define MENU_ITEMS_PANE_PREFIX 2
322 #define MENU_ITEMS_PANE_LENGTH 3
324 enum menu_item_idx
326 MENU_ITEMS_ITEM_NAME = 0,
327 MENU_ITEMS_ITEM_ENABLE,
328 MENU_ITEMS_ITEM_VALUE,
329 MENU_ITEMS_ITEM_EQUIV_KEY,
330 MENU_ITEMS_ITEM_DEFINITION,
331 MENU_ITEMS_ITEM_TYPE,
332 MENU_ITEMS_ITEM_SELECTED,
333 MENU_ITEMS_ITEM_HELP,
334 MENU_ITEMS_ITEM_LENGTH
337 extern void unuse_menu_items (void);
339 /* This is how to deal with multibyte text if HAVE_MULTILINGUAL_MENU
340 isn't defined. The use of HAVE_MULTILINGUAL_MENU could probably be
341 confined to an extended version of this with sections of code below
342 using it unconditionally. */
343 #ifndef HAVE_NTGUI
344 #if defined (USE_GTK) || defined (HAVE_NS)
345 # define ENCODE_MENU_STRING(str) ENCODE_UTF_8 (str)
346 #elif defined HAVE_X_I18N
347 #define ENCODE_MENU_STRING(str) ENCODE_SYSTEM (str)
348 #else
349 #define ENCODE_MENU_STRING(str) string_make_unibyte (str)
350 #endif /* USE_GTK */
351 #else /* HAVE_NTGUI */
352 #define ENCODE_MENU_STRING(str) (str)
353 #endif
355 /* Macros for dealing with lispy events. */
357 /* True if EVENT has data fields describing it (i.e. a mouse click). */
358 #define EVENT_HAS_PARAMETERS(event) (CONSP (event))
360 /* Extract the head from an event.
361 This works on composite and simple events. */
362 #define EVENT_HEAD(event) \
363 (EVENT_HAS_PARAMETERS (event) ? XCAR (event) : (event))
365 /* Extract the starting and ending positions from a composite event. */
366 #define EVENT_START(event) (CAR_SAFE (CDR_SAFE (event)))
367 #define EVENT_END(event) (CAR_SAFE (CDR_SAFE (CDR_SAFE (event))))
369 /* Extract the click count from a multi-click event. */
370 #define EVENT_CLICK_COUNT(event) (Fnth (make_number (2), (event)))
372 /* Extract the fields of a position. */
373 #define POSN_WINDOW(posn) (CAR_SAFE (posn))
374 #define POSN_POSN(posn) (CAR_SAFE (CDR_SAFE (posn)))
375 #define POSN_SET_POSN(posn,x) (XSETCAR (XCDR (posn), (x)))
376 #define POSN_WINDOW_POSN(posn) (CAR_SAFE (CDR_SAFE (CDR_SAFE (posn))))
377 #define POSN_TIMESTAMP(posn) (CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (posn)))))
378 #define POSN_SCROLLBAR_PART(posn) (Fnth (make_number (4), (posn)))
380 /* A cons (STRING . STRING-CHARPOS), or nil in mouse-click events.
381 It's a cons if the click is over a string in the mode line. */
383 #define POSN_STRING(posn) (Fnth (make_number (4), (posn)))
385 /* If POSN_STRING is nil, event refers to buffer location. */
387 #define POSN_INBUFFER_P(posn) (NILP (POSN_STRING (posn)))
388 #define POSN_BUFFER_POSN(posn) (Fnth (make_number (5), (posn)))
390 /* Some of the event heads. */
391 extern Lisp_Object Qswitch_frame;
393 /* Properties on event heads. */
394 extern Lisp_Object Qevent_kind;
396 /* The values of Qevent_kind properties. */
397 extern Lisp_Object Qmouse_click;
399 extern Lisp_Object Qhelp_echo;
401 /* Getting the kind of an event head. */
402 #define EVENT_HEAD_KIND(event_head) \
403 (Fget ((event_head), Qevent_kind))
405 /* Symbols to use for non-text mouse positions. */
406 extern Lisp_Object Qmode_line, Qvertical_line, Qheader_line;
407 extern Lisp_Object Qright_divider, Qbottom_divider;
409 /* True while doing kbd input. */
410 extern bool waiting_for_input;
412 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
413 happens. */
414 extern struct timespec *input_available_clear_time;
416 extern bool ignore_mouse_drag_p;
418 /* The primary selection. */
419 extern Lisp_Object QPRIMARY;
421 extern Lisp_Object parse_modifiers (Lisp_Object);
422 extern Lisp_Object reorder_modifiers (Lisp_Object);
423 extern Lisp_Object read_char (int, Lisp_Object, Lisp_Object,
424 bool *, struct timespec *);
425 extern int parse_solitary_modifier (Lisp_Object symbol);
428 /* This is like Vthis_command, except that commands never set it. */
429 extern Lisp_Object real_this_command;
431 /* Non-nil disable property on a command means
432 do not execute it; call disabled-command-function's value instead. */
433 extern Lisp_Object QCtoggle, QCradio;
435 /* An event header symbol HEAD may have a property named
436 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
437 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
438 mask of modifiers applied to it. If present, this is used to help
439 speed up parse_modifiers. */
440 extern Lisp_Object Qevent_symbol_element_mask;
442 extern int quit_char;
444 extern unsigned int timers_run;
446 extern bool menu_separator_name_p (const char *);
447 extern bool parse_menu_item (Lisp_Object, int);
449 extern KBOARD *allocate_kboard (Lisp_Object);
450 extern void delete_kboard (KBOARD *);
451 extern void not_single_kboard_state (KBOARD *);
452 extern void push_kboard (struct kboard *);
453 extern void push_frame_kboard (struct frame *);
454 extern void pop_kboard (void);
455 extern void temporarily_switch_to_single_kboard (struct frame *);
456 extern void record_asynch_buffer_change (void);
457 extern void input_poll_signal (int);
458 extern void start_polling (void);
459 extern void stop_polling (void);
460 extern void set_poll_suppress_count (int);
461 extern int gobble_input (void);
462 extern bool input_polling_used (void);
463 extern void clear_input_pending (void);
464 extern bool requeued_events_pending_p (void);
465 extern void bind_polling_period (int);
466 extern int make_ctrl_char (int) ATTRIBUTE_CONST;
467 extern void stuff_buffered_input (Lisp_Object);
468 extern void clear_waiting_for_input (void);
469 extern void swallow_events (bool);
470 extern bool lucid_event_type_list_p (Lisp_Object);
471 extern void kbd_buffer_store_event (struct input_event *);
472 extern void kbd_buffer_store_event_hold (struct input_event *,
473 struct input_event *);
474 extern void kbd_buffer_unget_event (struct input_event *);
475 extern void poll_for_input_1 (void);
476 extern void show_help_echo (Lisp_Object, Lisp_Object, Lisp_Object,
477 Lisp_Object);
478 extern void gen_help_event (Lisp_Object, Lisp_Object, Lisp_Object,
479 Lisp_Object, ptrdiff_t);
480 extern void kbd_buffer_store_help_event (Lisp_Object, Lisp_Object);
481 extern Lisp_Object menu_item_eval_property (Lisp_Object);
482 extern bool kbd_buffer_events_waiting (void);
483 extern void add_user_signal (int, const char *);
485 extern int tty_read_avail_input (struct terminal *, struct input_event *);
486 extern struct timespec timer_check (void);
487 extern void mark_kboards (void);
489 #ifdef HAVE_NTGUI
490 extern const char *const lispy_function_keys[];
491 #endif
493 INLINE_HEADER_END