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  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, or (at your option)
  10 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; see the file COPYING.  If not, write to
  19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  20 Boston, MA 02110-1301, USA.  */
  21
  22 #include "systime.h"            /* for EMACS_TIME */
  23
  24 /* Length of echobuf field in each KBOARD.  */
  25
  26 /* Each KBOARD represents one logical input stream from which Emacs
  27    gets input.  If we are using ordinary terminals, it has one KBOARD
  28    object for each terminal device.
  29    Usually each X display screen has its own KBOARD,
  30    but when two of them are on the same X server,
  31    we assume they share a keyboard and give them one KBOARD in common.
  32
  33    Some Lisp variables are per-kboard; they are stored in the KBOARD structure
  34    and accessed indirectly via a Lisp_Misc_Kboard_Objfwd object.
  35
  36    So that definition of keyboard macros, and reading of prefix arguments,
  37    can happen in parallel on various KBOARDs at once,
  38    the state information for those activities is stored in the KBOARD.
  39
  40    Emacs has two states for reading input:
  41
  42    ** Any kboard.  Emacs can accept input from any KBOARD,
  43    and as soon as any of them provides a complete command, Emacs can run it.
  44
  45    ** Single kboard.  Then Emacs is running a command for one KBOARD
  46    and can only read input from that KBOARD.
  47
  48    All input, from all KBOARDs, goes together in a single event queue
  49    at interrupt level.  read_char sees the events sequentially,
  50    but deals with them in accord with the current input state.
  51
  52    In the any-kboard state, read_key_sequence processes input from any KBOARD
  53    immediately.  When a new event comes in from a particular KBOARD,
  54    read_key_sequence switches to that KBOARD.  As a result,
  55    as soon as a complete key arrives from some KBOARD or other,
  56    Emacs starts executing that key's binding.  It switches to the
  57    single-kboard state for the execution of that command,
  58    so that that command can get input only from its own KBOARD.
  59
  60    While in the single-kboard state, read_char can consider input only
  61    from the current KBOARD.  If events come from other KBOARDs, they
  62    are put aside for later in the KBOARDs' kbd_queue lists.
  63    The flag kbd_queue_has_data in a KBOARD is 1 if this has happened.
  64    When Emacs goes back to the any-kboard state, it looks at all the KBOARDs
  65    to find those; and it tries processing their input right away.  */
  66
  67 typedef struct kboard KBOARD;
  68 struct kboard
  69   {
  70     KBOARD *next_kboard;
  71
  72     /* If non-nil, a keymap that overrides all others but applies only to
  73        this KBOARD.  Lisp code that uses this instead of calling read-char
  74        can effectively wait for input in the any-kboard state, and hence
  75        avoid blocking out the other KBOARDs.  See universal-argument in
  76        lisp/simple.el for an example.  */
  77     Lisp_Object Voverriding_terminal_local_map;
  78
  79     /* Last command executed by the editor command loop, not counting
  80        commands that set the prefix argument.  */
  81     Lisp_Object Vlast_command;
  82
  83     /* Normally same as last-command, but never modified by other commands.  */
  84     Lisp_Object Vreal_last_command;
  85
  86     /* User-supplied table to translate input characters through.  */
  87     Lisp_Object Vkeyboard_translate_table;
  88
  89     /* Last command that may be repeated by `repeat'.  */
  90     Lisp_Object Vlast_repeatable_command;
  91
  92     /* The prefix argument for the next command, in raw form.  */
  93     Lisp_Object Vprefix_arg;
  94
  95     /* Saved prefix argument for the last command, in raw form.  */
  96     Lisp_Object Vlast_prefix_arg;
  97
  98     /* Unread events specific to this kboard.  */
  99     Lisp_Object kbd_queue;
 100
 101     /* Non-nil while a kbd macro is being defined.  */
 102     Lisp_Object defining_kbd_macro;
 103
 104     /* The start of storage for the current keyboard macro.  */
 105     Lisp_Object *kbd_macro_buffer;
 106
 107     /* Where to store the next keystroke of the macro.  */
 108     Lisp_Object *kbd_macro_ptr;
 109
 110     /* The finalized section of the macro starts at kbd_macro_buffer and
 111        ends before this.  This is not the same as kbd_macro_ptr, because
 112        we advance this to kbd_macro_ptr when a key's command is complete.
 113        This way, the keystrokes for "end-kbd-macro" are not included in the
 114        macro.  This also allows us to throw away the events added to the
 115        macro by the last command: all the events between kbd_macro_end and
 116        kbd_macro_ptr belong to the last command; see
 117        cancel-kbd-macro-events.  */
 118     Lisp_Object *kbd_macro_end;
 119
 120     /* Allocated size of kbd_macro_buffer.  */
 121     int kbd_macro_bufsize;
 122
 123     /* Last anonymous kbd macro defined.  */
 124     Lisp_Object Vlast_kbd_macro;
 125
 126     /* Alist of system-specific X windows key symbols.  */
 127     Lisp_Object Vsystem_key_alist;
 128
 129     /* Cache for modify_event_symbol.  */
 130     Lisp_Object system_key_syms;
 131
 132     /* The kind of display: x, w32, ...  */
 133     Lisp_Object Vwindow_system;
 134
 135     /* Keymap mapping keys to alternative preferred forms.
 136        See the DEFVAR for more documentation.  */
 137     Lisp_Object Vlocal_function_key_map;
 138
 139     /* Keymap mapping ASCII function key sequences onto their preferred
 140        forms.  Initialized by the terminal-specific lisp files.  See the
 141        DEFVAR for more documentation.  */
 142     Lisp_Object Vinput_decode_map;
 143
 144     /* Minibufferless frames on this display use this frame's minibuffer.  */
 145     Lisp_Object Vdefault_minibuffer_frame;
 146
 147     /* Number of displays using this KBOARD.  Normally 1, but can be
 148        larger when you have multiple screens on a single X display.  */
 149     int reference_count;
 150
 151     /* The text we're echoing in the modeline - partial key sequences,
 152        usually.  This is nil when not echoing.  */
 153     Lisp_Object echo_string;
 154
 155     /* This flag indicates that events were put into kbd_queue
 156        while Emacs was running for some other KBOARD.
 157        The flag means that, when Emacs goes into the any-kboard state again,
 158        it should check this KBOARD to see if there is a complete command
 159        waiting.
 160
 161        Note that the kbd_queue field can be non-nil even when
 162        kbd_queue_has_data is 0.  When we push back an incomplete
 163        command, then this flag is 0, meaning we don't want to try
 164        reading from this KBOARD again until more input arrives.  */
 165     char kbd_queue_has_data;
 166
 167     /* Nonzero means echo each character as typed.  */
 168     char immediate_echo;
 169
 170     /* If we have echoed a prompt string specified by the user,
 171        this is its length in characters.  Otherwise this is -1.  */
 172     char echo_after_prompt;
 173   };
 174
 175 #ifdef MULTI_KBOARD
 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
 190 /* Nonzero in the single-kboard state, 0 in the any-kboard state.  */
 191 extern int single_kboard;
 192 #else
 193 extern KBOARD the_only_kboard;
 194 #define current_kboard (&the_only_kboard)
 195 #define all_kboards (&the_only_kboard)
 196 #define single_kboard 1
 197 #endif
 198 \f
 199 extern Lisp_Object Vlucid_menu_bar_dirty_flag;
 200 extern Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;
 201
 202 /* Total number of times read_char has returned.  */
 203 extern int num_input_events;
 204
 205 /* Total number of times read_char has returned, outside of macros.  */
 206 extern EMACS_INT num_nonmacro_input_events;
 207
 208 /* Nonzero means polling for input is temporarily suppressed.  */
 209 extern int poll_suppress_count;
 210
 211 /* Vector holding the key sequence that invoked the current command.
 212    It is reused for each command, and it may be longer than the current
 213    sequence; this_command_key_count indicates how many elements
 214    actually mean something.  */
 215 extern Lisp_Object this_command_keys;
 216 extern int this_command_key_count;
 217
 218 /* The frame in which the last input event occurred, or Qmacro if the
 219    last event came from a macro.  We use this to determine when to
 220    generate switch-frame events.  This may be cleared by functions
 221    like Fselect_frame, to make sure that a switch-frame event is
 222    generated by the next character.  */
 223 extern Lisp_Object internal_last_event_frame;
 224 \f
 225 /* This holds a Lisp vector that holds the properties of a single
 226    menu item while decoding it in parse_menu_item.
 227    Using a Lisp vector to hold this information while we decode it
 228    takes care of protecting all the data from GC.  */
 229 extern Lisp_Object item_properties;
 230
 231 /* This describes the elements of item_properties.
 232    The first element is not a property, it is a pointer to the item properties
 233    that is saved for GC protection. */
 234 #define ITEM_PROPERTY_ITEM 0
 235 /* The item string.  */
 236 #define ITEM_PROPERTY_NAME 1
 237 /* Start of initialize to nil */
 238 /* The binding: nil, a command or a keymap.  */
 239 #define ITEM_PROPERTY_DEF 2
 240 /* The keymap if the binding is a keymap, otherwise nil.  */
 241 #define ITEM_PROPERTY_MAP 3
 242 /* Nil, :radio or :toggle.  */
 243 #define ITEM_PROPERTY_TYPE 4
 244 /* Nil or a string describing an equivalent key binding.  */
 245 #define ITEM_PROPERTY_KEYEQ 5
 246 /* Not nil if a selected toggle box or radio button, otherwise nil.  */
 247 #define ITEM_PROPERTY_SELECTED 6
 248 /* Place for a help string. Not yet used.  */
 249 #define ITEM_PROPERTY_HELP 7
 250 /* Start of initialize to t */
 251 /* Last property. */
 252 /* Not nil if item is enabled.  */
 253 #define ITEM_PROPERTY_ENABLE 8
 254 \f
 255 /* Macros for dealing with lispy events.  */
 256
 257 /* True if EVENT has data fields describing it (i.e. a mouse click).  */
 258 #define EVENT_HAS_PARAMETERS(event) (CONSP (event))
 259
 260 /* Extract the head from an event.
 261    This works on composite and simple events.  */
 262 #define EVENT_HEAD(event) \
 263   (EVENT_HAS_PARAMETERS (event) ? XCAR (event) : (event))
 264
 265 /* Extract the starting and ending positions from a composite event.  */
 266 #define EVENT_START(event) (XCAR (XCDR (event)))
 267 #define EVENT_END(event) (XCAR (XCDR (XCDR (event))))
 268
 269 /* Extract the click count from a multi-click event.  */
 270 #define EVENT_CLICK_COUNT(event) (Fnth (make_number (2), (event)))
 271
 272 /* Extract the fields of a position.  */
 273 #define POSN_WINDOW(posn) (XCAR (posn))
 274 #define POSN_POSN(posn) (XCAR (XCDR (posn)))
 275 #define POSN_SET_POSN(posn,x) (XSETCAR (XCDR (posn), (x)))
 276 #define POSN_WINDOW_POSN(posn) (XCAR (XCDR (XCDR (posn))))
 277 #define POSN_TIMESTAMP(posn) (XCAR (XCDR (XCDR (XCDR (posn)))))
 278 #define POSN_SCROLLBAR_PART(posn)       (Fnth (make_number (4), (posn)))
 279
 280 /* A cons (STRING . STRING-CHARPOS), or nil in mouse-click events.
 281    It's a cons if the click is over a string in the mode line.  */
 282
 283 #define POSN_STRING(posn) (Fnth (make_number (4), (posn)))
 284
 285 /* If POSN_STRING is nil, event refers to buffer location.  */
 286
 287 #define POSN_INBUFFER_P(posn) (NILP (POSN_STRING (posn)))
 288 #define POSN_BUFFER_POSN(posn) (Fnth (make_number (5), (posn)))
 289
 290 /* Some of the event heads.  */
 291 extern Lisp_Object Qswitch_frame;
 292
 293 /* Properties on event heads.  */
 294 extern Lisp_Object Qevent_kind, Qevent_symbol_elements;
 295
 296 /* Getting an unmodified version of an event head.  */
 297 #define EVENT_HEAD_UNMODIFIED(event_head) \
 298   (Fcar (Fget ((event_head), Qevent_symbol_elements)))
 299
 300 /* The values of Qevent_kind properties.  */
 301 extern Lisp_Object Qfunction_key, Qmouse_click, Qmouse_movement;
 302 extern Lisp_Object Qscroll_bar_movement;
 303
 304 /* Getting the kind of an event head.  */
 305 #define EVENT_HEAD_KIND(event_head) \
 306   (Fget ((event_head), Qevent_kind))
 307
 308 /* Symbols to use for non-text mouse positions.  */
 309 extern Lisp_Object Qmode_line, Qvertical_line, Qheader_line;
 310
 311 /* Forward declaration for prototypes.  */
 312 struct input_event;
 313
 314 extern Lisp_Object parse_modifiers P_ ((Lisp_Object));
 315 extern Lisp_Object reorder_modifiers P_ ((Lisp_Object));
 316 extern Lisp_Object read_char P_ ((int, int, Lisp_Object *, Lisp_Object,
 317                                   int *, EMACS_TIME *));
 318
 319
 320 /* Parent keymap of terminal-local function-key-map instances.  */
 321 extern Lisp_Object Vfunction_key_map;
 322
 323 /* Keymap of key translations that can override keymaps.  */
 324 extern Lisp_Object Vkey_translation_map;
 325
 326 extern int parse_menu_item P_ ((Lisp_Object, int, int));
 327
 328 extern void echo_now P_ ((void));
 329 extern void init_kboard P_ ((KBOARD *));
 330 extern void delete_kboard P_ ((KBOARD *));
 331 extern void not_single_kboard_state P_ ((KBOARD *));
 332 extern void push_kboard P_ ((struct kboard *));
 333 extern void push_frame_kboard P_ ((struct frame *));
 334 extern void pop_kboard P_ ((void));
 335 extern void temporarily_switch_to_single_kboard P_ ((struct frame *));
 336 extern void record_asynch_buffer_change P_ ((void));
 337 extern SIGTYPE input_poll_signal P_ ((int));
 338 extern void start_polling P_ ((void));
 339 extern void stop_polling P_ ((void));
 340 extern void set_poll_suppress_count P_ ((int));
 341 extern void gobble_input P_ ((int));
 342 extern int input_polling_used P_ ((void));
 343 extern void clear_input_pending P_ ((void));
 344 extern int requeued_events_pending_p P_ ((void));
 345 extern void bind_polling_period P_ ((int));
 346 extern void stuff_buffered_input P_ ((Lisp_Object));
 347 extern void clear_waiting_for_input P_ ((void));
 348 extern void swallow_events P_ ((int));
 349 extern int help_char_p P_ ((Lisp_Object));
 350 extern void quit_throw_to_read_char P_ ((void)) NO_RETURN;
 351 extern void cmd_error_internal P_ ((Lisp_Object, char *));
 352 extern int lucid_event_type_list_p P_ ((Lisp_Object));
 353 extern void kbd_buffer_store_event P_ ((struct input_event *));
 354 extern void kbd_buffer_store_event_hold P_ ((struct input_event *,
 355                                              struct input_event *));
 356 extern void kbd_buffer_unget_event P_ ((struct input_event *));
 357 #ifdef POLL_FOR_INPUT
 358 extern void poll_for_input_1 P_ ((void));
 359 #endif
 360 extern void show_help_echo P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
 361                                 Lisp_Object, int));
 362 extern void gen_help_event P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
 363                                Lisp_Object, int));
 364 extern void kbd_buffer_store_help_event P_ ((Lisp_Object, Lisp_Object));
 365 extern Lisp_Object menu_item_eval_property P_ ((Lisp_Object));
 366 extern int  kbd_buffer_events_waiting P_ ((int));
 367 extern void add_user_signals P_ ((int, const char *));
 368
 369 extern int tty_read_avail_input P_ ((struct terminal *, int,
 370                                      struct input_event *));
 371
 372 /* arch-tag: 769cbade-1ba9-4950-b886-db265b061aa3
 373    (do not change this comment) */