Commit | Line | Data |
---|---|---|
284f4730 | 1 | /* Declarations useful when processing input. |
c6c5df7f | 2 | Copyright (C) 1985, 1986, 1987, 1993 Free Software Foundation, Inc. |
284f4730 JB |
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 | |
e5d77022 | 8 | the Free Software Foundation; either version 2, or (at your option) |
284f4730 JB |
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 | ||
931e7866 RS |
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 | ||
16701811 KH |
69 | /* The state of a prefix arg. |
70 | After pressing C-u COUNT times, prefix_factor is 4^COUNT | |
71 | and prefix_value is nil. | |
72 | After C-u NUM, prefix_factor is nil and prefix_value is abs(NUM). | |
73 | (prefix_factor and prefix_value are never both non-nil.) | |
74 | prefix_sign is always either +1 or -1; a value of -1 means that | |
75 | the actual numeric argument is the negative of what's in prefix_value, | |
76 | or just `-' if prefix_value is nil. | |
77 | The boolean prefix_partial means that the user is in the process | |
78 | of building a prefix argument, so that a minus or digit key at | |
79 | this point is handled specially. */ | |
931e7866 RS |
80 | Lisp_Object prefix_factor, prefix_value; |
81 | int prefix_sign, prefix_partial; | |
82 | ||
83 | /* Unread events specific to this kboard. */ | |
84 | Lisp_Object kbd_queue; | |
85 | ||
86 | /* Non-nil while a kbd macro is being defined. */ | |
87 | Lisp_Object defining_kbd_macro; | |
88 | ||
89 | /* The start of storage for the current keyboard macro. */ | |
90 | Lisp_Object *kbd_macro_buffer; | |
91 | ||
92 | /* Where to store the next keystroke of the macro. */ | |
93 | Lisp_Object *kbd_macro_ptr; | |
94 | ||
95 | /* The finalized section of the macro starts at kbd_macro_buffer and | |
96 | ends before this. This is not the same as kbd_macro_ptr, because | |
97 | we advance this to kbd_macro_ptr when a key's command is complete. | |
98 | This way, the keystrokes for "end-kbd-macro" are not included in the | |
99 | macro. */ | |
100 | Lisp_Object *kbd_macro_end; | |
101 | ||
102 | /* Allocated size of kbd_macro_buffer. */ | |
103 | int kbd_macro_bufsize; | |
104 | ||
105 | /* Last anonymous kbd macro defined. */ | |
106 | Lisp_Object Vlast_kbd_macro; | |
107 | ||
be2f0083 KH |
108 | /* Alist of system-specific X windows key symbols. */ |
109 | Lisp_Object Vsystem_key_alist; | |
110 | ||
2db45b7b KH |
111 | /* Minibufferless frames on this display use this frame's minibuffer. */ |
112 | Lisp_Object Vdefault_minibuffer_frame; | |
113 | ||
931e7866 RS |
114 | /* Number of displays using this KBOARD. Normally 1, but can be |
115 | larger when you have multiple screens on a single X display. */ | |
116 | int reference_count; | |
117 | ||
118 | /* Where to append more text to echobuf if we want to. */ | |
119 | char *echoptr; | |
120 | ||
121 | /* The text we're echoing in the modeline - partial key sequences, | |
122 | usually. '\0'-terminated. This really shouldn't have a fixed size. */ | |
123 | char echobuf[ECHOBUFSIZE]; | |
124 | ||
125 | /* This flag indicates that events were put into kbd_queue | |
126 | while Emacs was running for some other KBOARD. | |
127 | The flag means that, when Emacs goes into the any-kboard state again, | |
128 | it should check this KBOARD to see if there is a complete command | |
129 | waiting. | |
130 | ||
131 | Note that the kbd_queue field can be non-nil even when | |
132 | kbd_queue_has_data is 0. When we push back an incomplete | |
133 | command, then this flag is 0, meaning we don't want to try | |
134 | reading from this KBOARD again until more input arrives. */ | |
135 | char kbd_queue_has_data; | |
136 | ||
137 | /* Nonzero means echo each character as typed. */ | |
138 | char immediate_echo; | |
139 | ||
140 | /* If we have echoed a prompt string specified by the user, | |
141 | this is its length. Otherwise this is -1. */ | |
142 | char echo_after_prompt; | |
143 | }; | |
144 | ||
145 | #ifdef MULTI_KBOARD | |
146 | /* Temporarily used before a frame has been opened, and for termcap frames */ | |
147 | extern KBOARD *initial_kboard; | |
148 | ||
149 | /* In the single-kboard state, this is the kboard | |
150 | from which input is accepted. | |
151 | ||
152 | In the any-kboard state, this is the kboard from which we are | |
153 | right now considering input. We can consider input from another | |
154 | kboard, but doing so requires throwing to wrong_kboard_jmpbuf. */ | |
155 | extern KBOARD *current_kboard; | |
156 | ||
157 | /* A list of all kboard objects, linked through next_kboard. */ | |
158 | extern KBOARD *all_kboards; | |
159 | ||
160 | /* Nonzero in the single-kboard state, 0 in the any-kboard state. */ | |
161 | extern int single_kboard; | |
162 | #else | |
163 | extern KBOARD the_only_kboard; | |
164 | #define current_kboard (&the_only_kboard) | |
165 | #define all_kboards (&the_only_kboard) | |
166 | #define single_kboard 1 | |
167 | #endif | |
168 | \f | |
284f4730 JB |
169 | /* Total number of times read_char has returned. */ |
170 | extern int num_input_chars; | |
171 | ||
0ca96cef JB |
172 | /* Total number of times read_char has returned, outside of macros. */ |
173 | extern int num_nonmacro_input_chars; | |
174 | ||
eb8c3be9 | 175 | /* Nonzero means polling for input is temporarily suppressed. */ |
284f4730 JB |
176 | extern int poll_suppress_count; |
177 | ||
3b0deae5 RS |
178 | /* Nonzero if polling_for_input is actually being used. */ |
179 | extern int polling_for_input; | |
180 | ||
284f4730 JB |
181 | /* Keymap mapping ASCII function key sequences onto their preferred forms. |
182 | Initialized by the terminal-specific lisp files. */ | |
183 | extern Lisp_Object Vfunction_key_map; | |
184 | ||
49fcd3de JB |
185 | /* Vector holding the key sequence that invoked the current command. |
186 | It is reused for each command, and it may be longer than the current | |
187 | sequence; this_command_key_count indicates how many elements | |
188 | actually mean something. */ | |
189 | extern Lisp_Object this_command_keys; | |
190 | extern int this_command_key_count; | |
6084b314 | 191 | |
fd2777e0 JB |
192 | #ifdef MULTI_FRAME |
193 | /* The frame in which the last input event occurred, or Qmacro if the | |
194 | last event came from a macro. We use this to determine when to | |
195 | generate switch-frame events. This may be cleared by functions | |
196 | like Fselect_frame, to make sure that a switch-frame event is | |
197 | generated by the next character. */ | |
9e6314a4 | 198 | extern Lisp_Object internal_last_event_frame; |
fd2777e0 JB |
199 | #endif |
200 | ||
284f4730 JB |
201 | \f |
202 | /* Macros for dealing with lispy events. */ | |
203 | ||
204 | /* True iff EVENT has data fields describing it (i.e. a mouse click). */ | |
4a2fb8bd | 205 | #define EVENT_HAS_PARAMETERS(event) (CONSP (event)) |
284f4730 | 206 | |
53ce28d6 JB |
207 | /* Extract the head from an event. |
208 | This works on composite and simple events. */ | |
ac501cd9 JB |
209 | #define EVENT_HEAD(event) \ |
210 | (EVENT_HAS_PARAMETERS (event) ? XCONS (event)->car : (event)) | |
211 | ||
53ce28d6 | 212 | /* Extract the starting and ending positions from a composite event. */ |
ac501cd9 JB |
213 | #define EVENT_START(event) (XCONS (XCONS (event)->cdr)->car) |
214 | #define EVENT_END(event) (XCONS (XCONS (XCONS (event)->cdr)->cdr)->car) | |
215 | ||
6765e5b0 JB |
216 | /* Extract the click count from a multi-click event. */ |
217 | #define EVENT_CLICK_COUNT(event) (Fnth ((event), make_number (2))) | |
218 | ||
53ce28d6 | 219 | /* Extract the fields of a position. */ |
ac501cd9 JB |
220 | #define POSN_WINDOW(posn) (XCONS (posn)->car) |
221 | #define POSN_BUFFER_POSN(posn) (XCONS (XCONS (posn)->cdr)->car) | |
ac501cd9 JB |
222 | #define POSN_WINDOW_POSN(posn) (XCONS (XCONS (XCONS (posn)->cdr)->cdr)->car) |
223 | #define POSN_TIMESTAMP(posn) \ | |
224 | (XCONS (XCONS (XCONS (XCONS (posn)->cdr)->cdr)->cdr)->car) | |
6765e5b0 | 225 | #define POSN_SCROLLBAR_PART(posn) (Fnth ((posn), make_number (4))) |
284f4730 JB |
226 | |
227 | /* Some of the event heads. */ | |
6084b314 | 228 | extern Lisp_Object Qswitch_frame; |
284f4730 JB |
229 | |
230 | /* Properties on event heads. */ | |
ac501cd9 | 231 | extern Lisp_Object Qevent_kind, Qevent_symbol_elements; |
284f4730 JB |
232 | |
233 | /* Getting an unmodified version of an event head. */ | |
234 | #define EVENT_HEAD_UNMODIFIED(event_head) \ | |
ac501cd9 | 235 | (Fcar (Fget ((event_head), Qevent_symbol_elements))) |
284f4730 JB |
236 | |
237 | /* The values of Qevent_kind properties. */ | |
238 | extern Lisp_Object Qfunction_key, Qmouse_click, Qmouse_movement; | |
fd2777e0 | 239 | extern Lisp_Object Qscroll_bar_movement; |
284f4730 JB |
240 | |
241 | /* Getting the kind of an event head. */ | |
242 | #define EVENT_HEAD_KIND(event_head) \ | |
243 | (Fget ((event_head), Qevent_kind)) | |
244 | ||
245 | /* Symbols to use for non-text mouse positions. */ | |
e5d77022 | 246 | extern Lisp_Object Qmode_line, Qvertical_line; |
284f4730 | 247 | |
5bb46ecf JB |
248 | extern Lisp_Object get_keymap_1 (); |
249 | extern Lisp_Object Fkeymapp (); | |
250 | extern Lisp_Object reorder_modifiers (); | |
5bb46ecf | 251 | extern Lisp_Object read_char (); |
ec558adc JB |
252 | /* User-supplied string to translate input characters through. */ |
253 | extern Lisp_Object Vkeyboard_translate_table; | |
254 | ||
71e61810 | 255 | extern Lisp_Object map_prompt (); |