*** empty log message ***
[emacs.git] / src / keyboard.h
blob87af2e846922aa438311cb057a15fa0b30550867
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 /* Each KBOARD represents one logical input stream from which Emacs gets input.
24 If we are using an ordinary terminal, it has one KBOARD object.
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.
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.
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.
36 Emacs has two states for reading input:
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.
41 ** Single kboard. Then Emacs is running a command for one KBOARD
42 and can only read input from that KBOARD.
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.
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.
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. */
63 typedef struct kboard KBOARD;
64 struct kboard
66 KBOARD *next_kboard;
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;
75 /* Last command executed by the editor command loop, not counting
76 commands that set the prefix argument. */
77 Lisp_Object Vlast_command;
79 /* Normally same as last-command, but never modified by
80 other commands. */
81 Lisp_Object Vreal_last_command;
83 /* The prefix argument for the next command, in raw form. */
84 Lisp_Object Vprefix_arg;
86 /* Saved prefix argument for the last command, in raw form. */
87 Lisp_Object Vlast_prefix_arg;
89 /* Unread events specific to this kboard. */
90 Lisp_Object kbd_queue;
92 /* Non-nil while a kbd macro is being defined. */
93 Lisp_Object defining_kbd_macro;
95 /* The start of storage for the current keyboard macro. */
96 Lisp_Object *kbd_macro_buffer;
98 /* Where to store the next keystroke of the macro. */
99 Lisp_Object *kbd_macro_ptr;
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;
111 /* Allocated size of kbd_macro_buffer. */
112 int kbd_macro_bufsize;
114 /* Last anonymous kbd macro defined. */
115 Lisp_Object Vlast_kbd_macro;
117 /* Alist of system-specific X windows key symbols. */
118 Lisp_Object Vsystem_key_alist;
120 /* Cache for modify_event_symbol. */
121 Lisp_Object system_key_syms;
123 /* Minibufferless frames on this display use this frame's minibuffer. */
124 Lisp_Object Vdefault_minibuffer_frame;
126 /* Number of displays using this KBOARD. Normally 1, but can be
127 larger when you have multiple screens on a single X display. */
128 int reference_count;
130 /* The text we're echoing in the modeline - partial key sequences,
131 usually. This is nil when not echoing. */
132 Lisp_Object echo_string;
134 /* This flag indicates that events were put into kbd_queue
135 while Emacs was running for some other KBOARD.
136 The flag means that, when Emacs goes into the any-kboard state again,
137 it should check this KBOARD to see if there is a complete command
138 waiting.
140 Note that the kbd_queue field can be non-nil even when
141 kbd_queue_has_data is 0. When we push back an incomplete
142 command, then this flag is 0, meaning we don't want to try
143 reading from this KBOARD again until more input arrives. */
144 char kbd_queue_has_data;
146 /* Nonzero means echo each character as typed. */
147 char immediate_echo;
149 /* If we have echoed a prompt string specified by the user,
150 this is its length in characters. Otherwise this is -1. */
151 char echo_after_prompt;
154 #ifdef MULTI_KBOARD
155 /* Temporarily used before a frame has been opened, and for termcap frames */
156 extern KBOARD *initial_kboard;
158 /* In the single-kboard state, this is the kboard
159 from which input is accepted.
161 In the any-kboard state, this is the kboard from which we are
162 right now considering input. We can consider input from another
163 kboard, but doing so requires throwing to wrong_kboard_jmpbuf. */
164 extern KBOARD *current_kboard;
166 /* A list of all kboard objects, linked through next_kboard. */
167 extern KBOARD *all_kboards;
169 /* Nonzero in the single-kboard state, 0 in the any-kboard state. */
170 extern int single_kboard;
171 #else
172 extern KBOARD the_only_kboard;
173 #define current_kboard (&the_only_kboard)
174 #define all_kboards (&the_only_kboard)
175 #define single_kboard 1
176 #endif
178 extern Lisp_Object Vlucid_menu_bar_dirty_flag;
179 extern Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;
181 /* Total number of times read_char has returned. */
182 extern int num_input_events;
184 /* Total number of times read_char has returned, outside of macros. */
185 extern EMACS_INT num_nonmacro_input_events;
187 /* Nonzero means polling for input is temporarily suppressed. */
188 extern int poll_suppress_count;
190 /* Keymap mapping ASCII function key sequences onto their preferred forms.
191 Initialized by the terminal-specific lisp files. */
192 extern Lisp_Object Vfunction_key_map;
194 /* Vector holding the key sequence that invoked the current command.
195 It is reused for each command, and it may be longer than the current
196 sequence; this_command_key_count indicates how many elements
197 actually mean something. */
198 extern Lisp_Object this_command_keys;
199 extern int this_command_key_count;
201 /* The frame in which the last input event occurred, or Qmacro if the
202 last event came from a macro. We use this to determine when to
203 generate switch-frame events. This may be cleared by functions
204 like Fselect_frame, to make sure that a switch-frame event is
205 generated by the next character. */
206 extern Lisp_Object internal_last_event_frame;
208 /* This holds a Lisp vector that holds the properties of a single
209 menu item while decoding it in parse_menu_item.
210 Using a Lisp vector to hold this information while we decode it
211 takes care of protecting all the data from GC. */
212 extern Lisp_Object item_properties;
214 /* This describes the elements of item_properties.
215 The first element is not a property, it is a pointer to the item properties
216 that is saved for GC protection. */
217 #define ITEM_PROPERTY_ITEM 0
218 /* The item string. */
219 #define ITEM_PROPERTY_NAME 1
220 /* Start of initialize to nil */
221 /* The binding: nil, a command or a keymap. */
222 #define ITEM_PROPERTY_DEF 2
223 /* The keymap if the binding is a keymap, otherwise nil. */
224 #define ITEM_PROPERTY_MAP 3
225 /* Nil, :radio or :toggle. */
226 #define ITEM_PROPERTY_TYPE 4
227 /* Nil or a string describing an equivalent key binding. */
228 #define ITEM_PROPERTY_KEYEQ 5
229 /* Not nil if a selected toggle box or radio button, otherwise nil. */
230 #define ITEM_PROPERTY_SELECTED 6
231 /* Place for a help string. Not yet used. */
232 #define ITEM_PROPERTY_HELP 7
233 /* Start of initialize to t */
234 /* Last property. */
235 /* Not nil if item is enabled. */
236 #define ITEM_PROPERTY_ENABLE 8
238 /* Macros for dealing with lispy events. */
240 /* True iff EVENT has data fields describing it (i.e. a mouse click). */
241 #define EVENT_HAS_PARAMETERS(event) (CONSP (event))
243 /* Extract the head from an event.
244 This works on composite and simple events. */
245 #define EVENT_HEAD(event) \
246 (EVENT_HAS_PARAMETERS (event) ? XCAR (event) : (event))
248 /* Extract the starting and ending positions from a composite event. */
249 #define EVENT_START(event) (XCAR (XCDR (event)))
250 #define EVENT_END(event) (XCAR (XCDR (XCDR (event))))
252 /* Extract the click count from a multi-click event. */
253 #define EVENT_CLICK_COUNT(event) (Fnth ((event), make_number (2)))
255 /* Extract the fields of a position. */
256 #define POSN_WINDOW(posn) (XCAR (posn))
257 #define POSN_BUFFER_POSN(posn) (XCAR (XCDR (posn)))
258 #define POSN_BUFFER_SET_POSN(posn,x) (XSETCAR (XCDR (posn), (x)))
259 #define POSN_WINDOW_POSN(posn) (XCAR (XCDR (XCDR (posn))))
260 #define POSN_TIMESTAMP(posn) \
261 (XCAR (XCDR (XCDR (XCDR (posn)))))
262 #define POSN_SCROLLBAR_PART(posn) (Fnth ((posn), make_number (4)))
264 /* A cons (STRING . STRING-CHARPOS), or nil in mouse-click events.
265 It's a cons if the click is over a string in the mode line. */
267 #define POSN_STRING(POSN) Fnth (make_number (4), (POSN))
269 /* Some of the event heads. */
270 extern Lisp_Object Qswitch_frame;
272 /* Properties on event heads. */
273 extern Lisp_Object Qevent_kind, Qevent_symbol_elements;
275 /* Getting an unmodified version of an event head. */
276 #define EVENT_HEAD_UNMODIFIED(event_head) \
277 (Fcar (Fget ((event_head), Qevent_symbol_elements)))
279 /* The values of Qevent_kind properties. */
280 extern Lisp_Object Qfunction_key, Qmouse_click, Qmouse_movement;
281 extern Lisp_Object Qscroll_bar_movement;
283 /* Getting the kind of an event head. */
284 #define EVENT_HEAD_KIND(event_head) \
285 (Fget ((event_head), Qevent_kind))
287 /* Symbols to use for non-text mouse positions. */
288 extern Lisp_Object Qmode_line, Qvertical_line, Qheader_line;
290 /* Forward declaration for prototypes. */
291 struct input_event;
293 extern Lisp_Object parse_modifiers P_ ((Lisp_Object));
294 extern Lisp_Object reorder_modifiers P_ ((Lisp_Object));
295 extern Lisp_Object read_char P_ ((int, int, Lisp_Object *, Lisp_Object, int *));
296 /* User-supplied string to translate input characters through. */
297 extern Lisp_Object Vkeyboard_translate_table;
300 extern int parse_menu_item P_ ((Lisp_Object, int, int));
302 extern void echo_now P_ ((void));
303 extern void init_kboard P_ ((KBOARD *));
304 extern void delete_kboard P_ ((KBOARD *));
305 extern void single_kboard_state P_ ((void));
306 extern void push_frame_kboard P_ ((struct frame *));
307 extern void pop_frame_kboard P_ ((void));
308 extern void record_asynch_buffer_change P_ ((void));
309 extern SIGTYPE input_poll_signal P_ ((int));
310 extern void start_polling P_ ((void));
311 extern void stop_polling P_ ((void));
312 extern void set_poll_suppress_count P_ ((int));
313 extern void gobble_input P_ ((int));
314 extern int input_polling_used P_ ((void));
315 extern void clear_input_pending P_ ((void));
316 extern int requeued_events_pending_p P_ ((void));
317 extern void bind_polling_period P_ ((int));
318 extern void stuff_buffered_input P_ ((Lisp_Object));
319 extern void clear_waiting_for_input P_ ((void));
320 extern void swallow_events P_ ((int));
321 extern int help_char_p P_ ((Lisp_Object));
322 extern void quit_throw_to_read_char P_ ((void)) NO_RETURN;
323 extern void cmd_error_internal P_ ((Lisp_Object, char *));
324 extern void timer_start_idle P_ ((void));
325 extern void timer_stop_idle P_ ((void));
326 extern int lucid_event_type_list_p P_ ((Lisp_Object));
327 extern void kbd_buffer_store_event P_ ((struct input_event *));
328 #ifdef POLL_FOR_INPUT
329 extern void poll_for_input_1 P_ ((void));
330 #endif
331 extern void show_help_echo P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
332 Lisp_Object, int));
333 extern int gen_help_event P_ ((struct input_event *, int, Lisp_Object,
334 Lisp_Object, Lisp_Object, Lisp_Object, int));
335 extern void kbd_buffer_store_help_event P_ ((Lisp_Object, Lisp_Object));
336 extern Lisp_Object menu_item_eval_property P_ ((Lisp_Object));
337 extern int kbd_buffer_events_waiting P_ ((int));