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