code.delx.au - gnu-emacs/blob - 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, 675 Mass Ave, Cambridge, MA 02139, USA.  */
  19
  20 /* Length of echobuf field in each KBOARD.  */
  21
  22 #define ECHOBUFSIZE 300
  23
  24 /* Each KBOARD represents one logical input stream from which Emacs gets input.
  25    If we are using an ordinary terminal, it has one KBOARD object.
  26    Usually each X display screen has its own KBOARD,
  27    but when two of them are on the same X server,
  28    we assume they share a keyboard and give them one KBOARD in common.
  29
  30    Some Lisp variables are per-kboard; they are stored in the KBOARD structure
  31    and accessed indirectly via a Lisp_Misc_Kboard_Objfwd object.
  32
  33    So that definition of keyboard macros, and reading of prefix arguments,
  34    can happen in parallel on various KBOARDs at once,
  35    the state information for those activities is stored in the KBOARD.
  36
  37    Emacs has two states for reading input:
  38
  39    ** Any kboard.  Emacs can accept input from any KBOARD,
  40    and as soon as any of them provides a complete command, Emacs can run it.
  41
  42    ** Single kboard.  Then Emacs is running a command for one KBOARD
  43    and can only read input from that KBOARD.
  44
  45    All input, from all KBOARDs, goes together in a single event queue
  46    at interrupt level.  read_char sees the events sequentially,
  47    but deals with them in accord with the current input state.
  48
  49    In the any-kboard state, read_key_sequence processes input from any KBOARD
  50    immediately.  When a new event comes in from a particular KBOARD,
  51    read_key_sequence switches to that KBOARD.  As a result,
  52    as soon as a complete key arrives from some KBOARD or other,
  53    Emacs starts executing that key's binding.  It switches to the
  54    single-kboard state for the execution of that command,
  55    so that that command can get input only from its own KBOARD.
  56
  57    While in the single-kboard state, read_char can consider input only
  58    from the current KBOARD.  If events come from other KBOARDs, they
  59    are put aside for later in the KBOARDs' kbd_queue lists.
  60    The flag kbd_queue_has_data in a KBOARD is 1 if this has happened.
  61    When Emacs goes back to the any-kboard state, it looks at all the KBOARDS
  62    to find those; and it tries processing their input right away.  */
  63
  64 typedef struct kboard KBOARD;
  65 struct kboard
  66   {
  67     KBOARD *next_kboard;
  68
  69     /* Last command executed by the editor command loop, not counting
  70        commands that set the prefix argument.  */
  71     Lisp_Object Vlast_command;
  72
  73     /* The prefix argument for the next command, in raw form.  */
  74     Lisp_Object Vprefix_arg;
  75
  76     /* Unread events specific to this kboard.  */
  77     Lisp_Object kbd_queue;
  78
  79     /* Non-nil while a kbd macro is being defined.  */
  80     Lisp_Object defining_kbd_macro;
  81
  82     /* The start of storage for the current keyboard macro.  */
  83     Lisp_Object *kbd_macro_buffer;
  84
  85     /* Where to store the next keystroke of the macro.  */
  86     Lisp_Object *kbd_macro_ptr;
  87
  88     /* The finalized section of the macro starts at kbd_macro_buffer and
  89        ends before this.  This is not the same as kbd_macro_ptr, because
  90        we advance this to kbd_macro_ptr when a key's command is complete.
  91        This way, the keystrokes for "end-kbd-macro" are not included in the
  92        macro.  */
  93     Lisp_Object *kbd_macro_end;
  94
  95     /* Allocated size of kbd_macro_buffer.  */
  96     int kbd_macro_bufsize;
  97
  98     /* Last anonymous kbd macro defined.  */
  99     Lisp_Object Vlast_kbd_macro;
 100
 101     /* Alist of system-specific X windows key symbols.  */
 102     Lisp_Object Vsystem_key_alist;
 103
 104     /* Cache for modify_event_symbol.  */
 105     Lisp_Object system_key_syms;
 106
 107     /* Minibufferless frames on this display use this frame's minibuffer.  */
 108     Lisp_Object Vdefault_minibuffer_frame;
 109
 110     /* Number of displays using this KBOARD.  Normally 1, but can be
 111        larger when you have multiple screens on a single X display.  */
 112     int reference_count;
 113
 114     /* Where to append more text to echobuf if we want to.  */
 115     char *echoptr;
 116
 117     /* The text we're echoing in the modeline - partial key sequences,
 118        usually.  '\0'-terminated.  This really shouldn't have a fixed size.  */
 119     char echobuf[ECHOBUFSIZE];
 120
 121     /* This flag indicates that events were put into kbd_queue
 122        while Emacs was running for some other KBOARD.
 123        The flag means that, when Emacs goes into the any-kboard state again,
 124        it should check this KBOARD to see if there is a complete command
 125        waiting.
 126
 127        Note that the kbd_queue field can be non-nil even when
 128        kbd_queue_has_data is 0.  When we push back an incomplete
 129        command, then this flag is 0, meaning we don't want to try
 130        reading from this KBOARD again until more input arrives.  */
 131     char kbd_queue_has_data;
 132
 133     /* Nonzero means echo each character as typed.  */
 134     char immediate_echo;
 135
 136     /* If we have echoed a prompt string specified by the user,
 137        this is its length.  Otherwise this is -1.  */
 138     char echo_after_prompt;
 139   };
 140
 141 #ifdef MULTI_KBOARD
 142 /* Temporarily used before a frame has been opened, and for termcap frames */
 143 extern KBOARD *initial_kboard;
 144
 145 /* In the single-kboard state, this is the kboard
 146    from which input is accepted.
 147
 148    In the any-kboard state, this is the kboard from which we are
 149    right now considering input.  We can consider input from another
 150    kboard, but doing so requires throwing to wrong_kboard_jmpbuf.  */
 151 extern KBOARD *current_kboard;
 152
 153 /* A list of all kboard objects, linked through next_kboard.  */
 154 extern KBOARD *all_kboards;
 155
 156 /* Nonzero in the single-kboard state, 0 in the any-kboard state.  */
 157 extern int single_kboard;
 158 #else
 159 extern KBOARD the_only_kboard;
 160 #define current_kboard (&the_only_kboard)
 161 #define all_kboards (&the_only_kboard)
 162 #define single_kboard 1
 163 #endif
 164 \f
 165 extern Lisp_Object Vlucid_menu_bar_dirty_flag;
 166 extern Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;
 167
 168 /* Total number of times read_char has returned.  */
 169 extern int num_input_chars;
 170
 171 /* Total number of times read_char has returned, outside of macros.  */
 172 extern int num_nonmacro_input_chars;
 173
 174 /* Nonzero means polling for input is temporarily suppressed.  */
 175 extern int poll_suppress_count;
 176
 177 /* Nonzero if polling_for_input is actually being used.  */
 178 extern int polling_for_input;
 179
 180 /* Keymap mapping ASCII function key sequences onto their preferred forms.
 181    Initialized by the terminal-specific lisp files.  */
 182 extern Lisp_Object Vfunction_key_map;
 183
 184 /* Vector holding the key sequence that invoked the current command.
 185    It is reused for each command, and it may be longer than the current
 186    sequence; this_command_key_count indicates how many elements
 187    actually mean something.  */
 188 extern Lisp_Object this_command_keys;
 189 extern int this_command_key_count;
 190
 191 #ifdef MULTI_FRAME
 192 /* The frame in which the last input event occurred, or Qmacro if the
 193    last event came from a macro.  We use this to determine when to
 194    generate switch-frame events.  This may be cleared by functions
 195    like Fselect_frame, to make sure that a switch-frame event is
 196    generated by the next character.  */
 197 extern Lisp_Object internal_last_event_frame;
 198 #endif
 199
 200 \f
 201 /* Macros for dealing with lispy events.  */
 202
 203 /* True iff EVENT has data fields describing it (i.e. a mouse click).  */
 204 #define EVENT_HAS_PARAMETERS(event) (CONSP (event))
 205
 206 /* Extract the head from an event.
 207    This works on composite and simple events.  */
 208 #define EVENT_HEAD(event) \
 209   (EVENT_HAS_PARAMETERS (event) ? XCONS (event)->car : (event))
 210
 211 /* Extract the starting and ending positions from a composite event.  */
 212 #define EVENT_START(event) (XCONS (XCONS (event)->cdr)->car)
 213 #define EVENT_END(event) (XCONS (XCONS (XCONS (event)->cdr)->cdr)->car)
 214
 215 /* Extract the click count from a multi-click event.  */
 216 #define EVENT_CLICK_COUNT(event) (Fnth ((event), make_number (2)))
 217
 218 /* Extract the fields of a position.  */
 219 #define POSN_WINDOW(posn) (XCONS (posn)->car)
 220 #define POSN_BUFFER_POSN(posn) (XCONS (XCONS (posn)->cdr)->car)
 221 #define POSN_WINDOW_POSN(posn) (XCONS (XCONS (XCONS (posn)->cdr)->cdr)->car)
 222 #define POSN_TIMESTAMP(posn) \
 223   (XCONS (XCONS (XCONS (XCONS (posn)->cdr)->cdr)->cdr)->car)
 224 #define POSN_SCROLLBAR_PART(posn)       (Fnth ((posn), make_number (4)))
 225
 226 /* Some of the event heads.  */
 227 extern Lisp_Object Qswitch_frame;
 228
 229 /* Properties on event heads.  */
 230 extern Lisp_Object Qevent_kind, Qevent_symbol_elements;
 231
 232 /* Getting an unmodified version of an event head.  */
 233 #define EVENT_HEAD_UNMODIFIED(event_head) \
 234   (Fcar (Fget ((event_head), Qevent_symbol_elements)))
 235
 236 /* The values of Qevent_kind properties.  */
 237 extern Lisp_Object Qfunction_key, Qmouse_click, Qmouse_movement;
 238 extern Lisp_Object Qscroll_bar_movement;
 239
 240 /* Getting the kind of an event head.  */
 241 #define EVENT_HEAD_KIND(event_head) \
 242   (Fget ((event_head), Qevent_kind))
 243
 244 /* Symbols to use for non-text mouse positions.  */
 245 extern Lisp_Object Qmode_line, Qvertical_line;
 246
 247 extern Lisp_Object get_keymap_1 ();
 248 extern Lisp_Object Fkeymapp ();
 249 extern Lisp_Object reorder_modifiers ();
 250 extern Lisp_Object read_char ();
 251 /* User-supplied string to translate input characters through.  */
 252 extern Lisp_Object Vkeyboard_translate_table;
 253
 254 extern Lisp_Object map_prompt ();