src/keyboard.h

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