| blob | 0474c0404b7e400aae666c152219f427d68b88f1 |
1 /* Declarations useful when processing input.
2 Copyright (C) 1985, 1986, 1987, 1993 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
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.
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.
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., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 /* Length of echobuf field in each KBOARD. */
23 #define ECHOBUFSIZE 300
25 /* Each KBOARD represents one logical input stream from which Emacs gets input.
26 If we are using an ordinary terminal, it has one KBOARD object.
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.
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.
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.
38 Emacs has two states for reading input:
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.
43 ** Single kboard. Then Emacs is running a command for one KBOARD
44 and can only read input from that KBOARD.
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.
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.
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. */
66 struct kboard
67 {
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;
77 /* Last command executed by the editor command loop, not counting
78 commands that set the prefix argument. */
79 Lisp_Object Vlast_command;
81 /* Normally same as last-command, but never modified by
82 other commands. */
83 Lisp_Object Vreal_last_command;
85 /* The prefix argument for the next command, in raw form. */
86 Lisp_Object Vprefix_arg;
88 /* Saved prefix argument for the last command, in raw form. */
89 Lisp_Object Vlast_prefix_arg;
91 /* Unread events specific to this kboard. */
92 Lisp_Object kbd_queue;
94 /* Non-nil while a kbd macro is being defined. */
95 Lisp_Object defining_kbd_macro;
97 /* The start of storage for the current keyboard macro. */
100 /* Where to store the next keystroke of the macro. */
103 /* The finalized section of the macro starts at kbd_macro_buffer and
104 ends before this. This is not the same as kbd_macro_ptr, because
105 we advance this to kbd_macro_ptr when a key's command is complete.
106 This way, the keystrokes for "end-kbd-macro" are not included in the
107 macro. */
110 /* Allocated size of kbd_macro_buffer. */
113 /* Last anonymous kbd macro defined. */
114 Lisp_Object Vlast_kbd_macro;
116 /* Alist of system-specific X windows key symbols. */
117 Lisp_Object Vsystem_key_alist;
119 /* Cache for modify_event_symbol. */
120 Lisp_Object system_key_syms;
122 /* Minibufferless frames on this display use this frame's minibuffer. */
123 Lisp_Object Vdefault_minibuffer_frame;
125 /* Number of displays using this KBOARD. Normally 1, but can be
126 larger when you have multiple screens on a single X display. */
129 /* Where to append more text to echobuf if we want to. */
132 /* The text we're echoing in the modeline - partial key sequences,
133 usually. '\0'-terminated. This really shouldn't have a fixed size. */
136 /* This flag indicates that events were put into kbd_queue
137 while Emacs was running for some other KBOARD.
138 The flag means that, when Emacs goes into the any-kboard state again,
139 it should check this KBOARD to see if there is a complete command
140 waiting.
142 Note that the kbd_queue field can be non-nil even when
143 kbd_queue_has_data is 0. When we push back an incomplete
144 command, then this flag is 0, meaning we don't want to try
145 reading from this KBOARD again until more input arrives. */
148 /* Nonzero means echo each character as typed. */
151 /* If we have echoed a prompt string specified by the user,
152 this is its length. Otherwise this is -1. */
154 };
156 #ifdef MULTI_KBOARD
157 /* Temporarily used before a frame has been opened, and for termcap frames */
160 /* In the single-kboard state, this is the kboard
161 from which input is accepted.
163 In the any-kboard state, this is the kboard from which we are
164 right now considering input. We can consider input from another
165 kboard, but doing so requires throwing to wrong_kboard_jmpbuf. */
168 /* A list of all kboard objects, linked through next_kboard. */
171 /* Nonzero in the single-kboard state, 0 in the any-kboard state. */
173 #else
175 #define current_kboard (&the_only_kboard)
176 #define all_kboards (&the_only_kboard)
177 #define single_kboard 1
178 #endif
179 \f
183 /* Total number of times read_char has returned. */
186 /* Total number of times read_char has returned, outside of macros. */
189 /* Nonzero means polling for input is temporarily suppressed. */
192 /* Keymap mapping ASCII function key sequences onto their preferred forms.
193 Initialized by the terminal-specific lisp files. */
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. */
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. */
209 \f
210 /* This holds a Lisp vector that holds the properties of a single
211 menu item while decoding it in parse_menu_item.
212 Using a Lisp vector to hold this information while we decode it
213 takes care of protecting all the data from GC. */
216 /* This describes the elements of item_properties.
217 The first element is not a property, it is a pointer to the item properties
218 that is saved for GC protection. */
219 #define ITEM_PROPERTY_ITEM 0
220 /* The item string. */
221 #define ITEM_PROPERTY_NAME 1
222 /* Start of initilize to nil */
223 /* The binding: nil, a command or a keymap. */
224 #define ITEM_PROPERTY_DEF 2
225 /* The keymap if the binding is a keymap, otherwise nil. */
226 #define ITEM_PROPERTY_MAP 3
227 /* Nil, :radio or :toggle. */
228 #define ITEM_PROPERTY_TYPE 4
229 /* Nil or a string describing an equivalent key binding. */
230 #define ITEM_PROPERTY_KEYEQ 5
231 /* Not nil if a selected toggle box or radio button, otherwise nil. */
232 #define ITEM_PROPERTY_SELECTED 6
233 /* Place for a help string. Not yet used. */
234 #define ITEM_PROPERTY_HELP 7
235 /* Start of initilize to t */
236 /* Last property. */
237 /* Not nil if item is enabled. */
238 #define ITEM_PROPERTY_ENABLE 8
239 \f
240 /* Macros for dealing with lispy events. */
242 /* True iff EVENT has data fields describing it (i.e. a mouse click). */
243 #define EVENT_HAS_PARAMETERS(event) (CONSP (event))
245 /* Extract the head from an event.
246 This works on composite and simple events. */
247 #define EVENT_HEAD(event) \
248 (EVENT_HAS_PARAMETERS (event) ? XCAR (event) : (event))
250 /* Extract the starting and ending positions from a composite event. */
251 #define EVENT_START(event) (XCAR (XCDR (event)))
252 #define EVENT_END(event) (XCAR (XCDR (XCDR (event))))
254 /* Extract the click count from a multi-click event. */
255 #define EVENT_CLICK_COUNT(event) (Fnth ((event), make_number (2)))
257 /* Extract the fields of a position. */
258 #define POSN_WINDOW(posn) (XCAR (posn))
259 #define POSN_BUFFER_POSN(posn) (XCAR (XCDR (posn)))
260 #define POSN_WINDOW_POSN(posn) (XCAR (XCDR (XCDR (posn))))
261 #define POSN_TIMESTAMP(posn) \
262 (XCAR (XCDR (XCDR (XCDR (posn)))))
263 #define POSN_SCROLLBAR_PART(posn) (Fnth ((posn), make_number (4)))
265 /* A cons (STRING . STRING-CHARPOS), or nil in mouse-click events.
266 It's a cons if the click is over a string in the mode line. */
268 #define POSN_STRING(POSN) Fnth (make_number (4), (POSN))
270 /* Some of the event heads. */
273 /* Properties on event heads. */
276 /* Getting an unmodified version of an event head. */
277 #define EVENT_HEAD_UNMODIFIED(event_head) \
278 (Fcar (Fget ((event_head), Qevent_symbol_elements)))
280 /* The values of Qevent_kind properties. */
284 /* Getting the kind of an event head. */
285 #define EVENT_HEAD_KIND(event_head) \
286 (Fget ((event_head), Qevent_kind))
288 /* Symbols to use for non-text mouse positions. */
291 /* Forward declaration for prototypes. */
299 /* User-supplied string to translate input characters through. */