src/keyboard.h

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