src/keyboard.h

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