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