src/keyboard.h

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