src/keyboard.h

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