src/keyboard.h

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