|
0
|
1 /* The portable interface to event streams.
|
|
|
2 Copyright (C) 1991, 1992, 1993, 1994, 1995 Free Software Foundation, Inc.
|
|
|
3 Copyright (C) 1995 Board of Trustees, University of Illinois.
|
|
|
4 Copyright (C) 1995 Sun Microsystems, Inc.
|
|
|
5 Copyright (C) 1995, 1996 Ben Wing.
|
|
|
6
|
|
|
7 This file is part of XEmacs.
|
|
|
8
|
|
|
9 XEmacs is free software; you can redistribute it and/or modify it
|
|
|
10 under the terms of the GNU General Public License as published by the
|
|
|
11 Free Software Foundation; either version 2, or (at your option) any
|
|
|
12 later version.
|
|
|
13
|
|
|
14 XEmacs is distributed in the hope that it will be useful, but WITHOUT
|
|
|
15 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
16 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
|
17 for more details.
|
|
|
18
|
|
|
19 You should have received a copy of the GNU General Public License
|
|
|
20 along with XEmacs; see the file COPYING. If not, write to
|
|
|
21 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
22 Boston, MA 02111-1307, USA. */
|
|
|
23
|
|
|
24 /* Synched up with: Not in FSF. */
|
|
|
25
|
|
|
26 /* This file has been Mule-ized. */
|
|
|
27
|
|
|
28 /*
|
|
|
29 * DANGER!!
|
|
|
30 *
|
|
|
31 * If you ever change ANYTHING in this file, you MUST run the
|
|
|
32 * testcases at the end to make sure that you haven't changed
|
|
|
33 * the semantics of recent-keys, last-input-char, or keyboard
|
|
|
34 * macros. You'd be surprised how easy it is to break this.
|
|
|
35 *
|
|
|
36 */
|
|
|
37
|
|
|
38 #include <config.h>
|
|
|
39 #include "lisp.h"
|
|
|
40
|
|
|
41 #include "buffer.h"
|
|
|
42 #include "commands.h"
|
|
|
43 #include "device.h"
|
|
|
44 #include "elhash.h"
|
|
|
45 #include "events.h"
|
|
|
46 #include "frame.h"
|
|
|
47 #include "insdel.h" /* for buffer_reset_changes */
|
|
|
48 #include "keymap.h"
|
|
|
49 #include "lstream.h"
|
|
|
50 #include "macros.h" /* for defining_keyboard_macro */
|
|
|
51 #include "opaque.h"
|
|
|
52 #include "process.h"
|
|
|
53 #include "window.h"
|
|
|
54
|
|
|
55 #include "sysdep.h" /* init_poll_for_quit() */
|
|
|
56 #include "syssignal.h" /* SIGCHLD, etc. */
|
|
|
57 #include "systime.h" /* to set Vlast_input_time */
|
|
|
58
|
|
100
|
59 #include "events-mod.h"
|
|
|
60
|
|
70
|
61 #ifdef MULE
|
|
|
62 #include "mule-coding.h"
|
|
|
63 #endif
|
|
|
64
|
|
0
|
65 #include <errno.h>
|
|
|
66
|
|
|
67 /* The number of keystrokes between auto-saves. */
|
|
|
68 static int auto_save_interval;
|
|
|
69
|
|
|
70 Lisp_Object Qundefined_keystroke_sequence;
|
|
|
71
|
|
|
72 Lisp_Object Qcommand_execute;
|
|
|
73
|
|
|
74 Lisp_Object Qcommand_event_p;
|
|
|
75
|
|
|
76 /* Hooks to run before and after each command. */
|
|
|
77 Lisp_Object Vpre_command_hook, Vpost_command_hook;
|
|
|
78 Lisp_Object Qpre_command_hook, Qpost_command_hook;
|
|
|
79
|
|
|
80 /* Hook run when XEmacs is about to be idle. */
|
|
|
81 Lisp_Object Qpre_idle_hook, Vpre_idle_hook;
|
|
|
82
|
|
72
|
83 /* Control gratuitous keyboard focus throwing. */
|
|
|
84 int focus_follows_mouse;
|
|
|
85
|
|
0
|
86 #ifdef ILL_CONCEIVED_HOOK
|
|
|
87 /* Hook run after a command if there's no more input soon. */
|
|
|
88 Lisp_Object Qpost_command_idle_hook, Vpost_command_idle_hook;
|
|
|
89
|
|
|
90 /* Delay time in microseconds before running post-command-idle-hook. */
|
|
|
91 int post_command_idle_delay;
|
|
|
92 #endif /* ILL_CONCEIVED_HOOK */
|
|
|
93
|
|
|
94 #ifdef DEFERRED_ACTION_CRAP
|
|
|
95 /* List of deferred actions to be performed at a later time.
|
|
|
96 The precise format isn't relevant here; we just check whether it is nil. */
|
|
|
97 Lisp_Object Vdeferred_action_list;
|
|
|
98
|
|
|
99 /* Function to call to handle deferred actions, when there are any. */
|
|
|
100 Lisp_Object Vdeferred_action_function;
|
|
|
101 Lisp_Object Qdeferred_action_function;
|
|
|
102 #endif /* DEFERRED_ACTION_CRAP */
|
|
|
103
|
|
|
104 /* Non-nil disable property on a command means
|
|
|
105 do not execute it; call disabled-command-hook's value instead. */
|
|
|
106 Lisp_Object Qdisabled, Vdisabled_command_hook;
|
|
|
107
|
|
|
108 static void pre_command_hook (void);
|
|
|
109 static void post_command_hook (void);
|
|
|
110
|
|
|
111 /* Last keyboard or mouse input event read as a command. */
|
|
|
112 Lisp_Object Vlast_command_event;
|
|
|
113
|
|
|
114 /* The nearest ASCII equivalent of the above. */
|
|
|
115 Lisp_Object Vlast_command_char;
|
|
|
116
|
|
|
117 /* Last keyboard or mouse event read for any purpose. */
|
|
|
118 Lisp_Object Vlast_input_event;
|
|
|
119
|
|
|
120 /* The nearest ASCII equivalent of the above. */
|
|
|
121 Lisp_Object Vlast_input_char;
|
|
|
122
|
|
|
123 Lisp_Object Vcurrent_mouse_event;
|
|
|
124
|
|
|
125 /* If not Qnil, event objects to be read as the next command input */
|
|
|
126 Lisp_Object Vunread_command_events;
|
|
|
127 Lisp_Object Vunread_command_event; /* obsoleteness support */
|
|
|
128
|
|
|
129 static Lisp_Object Qunread_command_events, Qunread_command_event;
|
|
|
130
|
|
|
131 /* Previous command, represented by a Lisp object.
|
|
|
132 Does not include prefix commands and arg setting commands */
|
|
|
133 Lisp_Object Vlast_command;
|
|
|
134
|
|
|
135 /* If a command sets this, the value goes into
|
|
|
136 previous-command for the next command. */
|
|
|
137 Lisp_Object Vthis_command;
|
|
|
138
|
|
|
139 /* The value of point when the last command was executed. */
|
|
|
140 Bufpos last_point_position;
|
|
|
141
|
|
|
142 /* The frame that was current when the last command was started. */
|
|
|
143 Lisp_Object Vlast_selected_frame;
|
|
|
144
|
|
|
145 /* The buffer that was current when the last command was started. */
|
|
|
146 Lisp_Object last_point_position_buffer;
|
|
|
147
|
|
|
148 /* A (16bit . 16bit) representation of the time of the last-command-event.
|
|
|
149 */
|
|
|
150 Lisp_Object Vlast_input_time;
|
|
|
151
|
|
|
152 /* Character to recognize as the help char. */
|
|
|
153 Lisp_Object Vhelp_char;
|
|
|
154
|
|
|
155 /* Form to execute when help char is typed. */
|
|
|
156 Lisp_Object Vhelp_form;
|
|
|
157
|
|
|
158 /* Flag to tell QUIT that some interesting occurrence (e.g. a keypress)
|
|
|
159 may have happened. */
|
|
|
160 volatile int something_happened;
|
|
|
161
|
|
|
162 /* Command to run when the help character follows a prefix key. */
|
|
|
163 Lisp_Object Vprefix_help_command;
|
|
|
164
|
|
|
165 /* Hash table to translate keysyms through */
|
|
|
166 Lisp_Object Vkeyboard_translate_table;
|
|
|
167
|
|
|
168 /* If control-meta-super-shift-X is undefined, try control-meta-super-x */
|
|
|
169 Lisp_Object Vretry_undefined_key_binding_unshifted;
|
|
|
170 Lisp_Object Qretry_undefined_key_binding_unshifted;
|
|
|
171
|
|
70
|
172 #ifdef HAVE_XIM
|
|
|
173 /* If composed input is undefined, use self-insert-char */
|
|
|
174 Lisp_Object Vcomposed_character_default_binding;
|
|
|
175 #endif /* HAVE_XIM */
|
|
|
176
|
|
0
|
177 /* Console that corresponds to our controlling terminal */
|
|
|
178 Lisp_Object Vcontrolling_terminal;
|
|
|
179
|
|
|
180 /* An event (actually an event chain linked through event_next) or Qnil.
|
|
|
181 */
|
|
|
182 Lisp_Object Vthis_command_keys;
|
|
|
183 Lisp_Object Vthis_command_keys_tail;
|
|
|
184
|
|
|
185 /* #### kludge! */
|
|
|
186 Lisp_Object Qauto_show_make_point_visible;
|
|
|
187
|
|
|
188 /* File in which we write all commands we read; an lstream */
|
|
|
189 static Lisp_Object Vdribble_file;
|
|
|
190
|
|
153
|
191 /* Recent keys ring location; a vector of events or nil-s */
|
|
|
192 Lisp_Object Vrecent_keys_ring;
|
|
|
193 int recent_keys_ring_size;
|
|
|
194 int recent_keys_ring_index;
|
|
|
195
|
|
0
|
196 #ifdef DEBUG_XEMACS
|
|
|
197 int debug_emacs_events;
|
|
|
198 #endif
|
|
|
199
|
|
|
200
|
|
|
201 /* The callback routines for the window system or terminal driver */
|
|
|
202 struct event_stream *event_stream;
|
|
|
203
|
|
|
204 /* This structure is what we use to excapsulate the state of a command sequence
|
|
|
205 being composed; key events are executed by adding themselves to the command
|
|
|
206 builder; if the command builder is then complete (does not still represent
|
|
|
207 a prefix key sequence) it executes the corresponding command.
|
|
|
208 */
|
|
|
209 struct command_builder
|
|
|
210 {
|
|
|
211 struct lcrecord_header header;
|
|
|
212 Lisp_Object console; /* back pointer to the console this command
|
|
|
213 builder is for */
|
|
|
214 /* Qnil, or a Lisp_Event representing the first event read
|
|
|
215 * after the last command completed. Threaded. */
|
|
|
216 /* #### NYI */
|
|
|
217 Lisp_Object prefix_events;
|
|
|
218 /* Qnil, or a Lisp_Event representing event in the current
|
|
|
219 * keymap-lookup sequence. Subsequent events are threaded via
|
|
|
220 * the event's next slot */
|
|
|
221 Lisp_Object current_events;
|
|
|
222 /* Last elt of above */
|
|
|
223 Lisp_Object most_current_event;
|
|
|
224 /* Last elt before function map code took over.
|
|
|
225 What this means is: All prefixes up to (but not including)
|
|
|
226 this event have non-nil bindings, but the prefix including
|
|
|
227 this event has a nil binding. Any events in the chain after
|
|
|
228 this one were read solely because we're part of a possible
|
|
|
229 function key. If we end up with something that's not part
|
|
|
230 of a possible function key, we have to unread all of those
|
|
|
231 events. */
|
|
|
232 Lisp_Object last_non_munged_event;
|
|
|
233 /* One set of values for function-key-map, one for key-translation-map */
|
|
|
234 struct munging_key_translation
|
|
|
235 {
|
|
|
236 /* First event that can begin a possible function key sequence
|
|
|
237 (to be translated according to function-key-map). Normally
|
|
|
238 this is the first event in the chain. However, once we've
|
|
|
239 translated a sequence through function-key-map, this will
|
|
|
240 point to the first event after the translated sequence:
|
|
|
241 we don't ever want to translate any events twice through
|
|
|
242 function-key-map, or things could get really screwed up
|
|
|
243 (e.g. if the user created a translation loop). If this
|
|
|
244 is nil, then the next-read event is the first that can
|
|
|
245 begin a function key sequence. */
|
|
|
246 Lisp_Object first_mungeable_event;
|
|
|
247 } munge_me[2];
|
|
|
248
|
|
|
249 Bufbyte *echo_buf;
|
|
|
250 Bytecount echo_buf_length; /* size of echo_buf */
|
|
|
251 Bytecount echo_buf_index; /* index into echo_buf
|
|
|
252 * -1 before doing echoing for new cmd */
|
|
|
253 /* Self-insert-command is magic in that it doesn't always push an undo-
|
|
|
254 boundary: up to 20 consecutive self-inserts can happen before an undo-
|
|
|
255 boundary is pushed. This variable is that counter.
|
|
|
256 */
|
|
|
257 int self_insert_countdown;
|
|
|
258 };
|
|
|
259
|
|
|
260 static void echo_key_event (struct command_builder *, Lisp_Object event);
|
|
|
261 static void maybe_kbd_translate (Lisp_Object event);
|
|
|
262
|
|
|
263 /* This structure is basically a typeahead queue: things like
|
|
|
264 wait-reading-process-output will delay the execution of
|
|
|
265 keyboard and mouse events by pushing them here.
|
|
|
266
|
|
|
267 Chained through event_next()
|
|
|
268 command_event_queue_tail is a pointer to the last-added element.
|
|
|
269 */
|
|
|
270 static Lisp_Object command_event_queue;
|
|
|
271 static Lisp_Object command_event_queue_tail;
|
|
|
272
|
|
|
273 /* Nonzero means echo unfinished commands after this many seconds of pause. */
|
|
|
274 static int echo_keystrokes;
|
|
|
275
|
|
|
276 /* The number of keystrokes since the last auto-save. */
|
|
|
277 static int keystrokes_since_auto_save;
|
|
|
278
|
|
|
279 /* Used by the C-g signal handler so that it will never "hard quit"
|
|
|
280 when waiting for an event. Otherwise holding down C-g could
|
|
|
281 cause a suspension back to the shell, which is generally
|
|
|
282 undesirable. (#### This doesn't fully work.) */
|
|
|
283
|
|
|
284 int emacs_is_blocking;
|
|
|
285
|
|
108
|
286 /* Handlers which run during sit-for, sleep-for and accept-process-output
|
|
|
287 are not allowed to recursively call these routines. We record here
|
|
|
288 if we are in that situation. */
|
|
|
289
|
|
|
290 static Lisp_Object recursive_sit_for;
|
|
|
291
|
|
|
292
|
|
0
|
293
|
|
|
294 /**********************************************************************/
|
|
|
295 /* Command-builder object */
|
|
|
296 /**********************************************************************/
|
|
|
297
|
|
|
298 #define XCOMMAND_BUILDER(x) \
|
|
|
299 XRECORD (x, command_builder, struct command_builder)
|
|
|
300 #define XSETCOMMAND_BUILDER(x, p) XSETRECORD (x, p, command_builder)
|
|
|
301 #define COMMAND_BUILDERP(x) RECORDP (x, command_builder)
|
|
|
302 #define GC_COMMAND_BUILDERP(x) GC_RECORDP (x, command_builder)
|
|
|
303 #define CHECK_COMMAND_BUILDER(x) CHECK_RECORD (x, command_builder)
|
|
|
304
|
|
|
305 static Lisp_Object mark_command_builder (Lisp_Object obj,
|
|
|
306 void (*markobj) (Lisp_Object));
|
|
|
307 static void finalize_command_builder (void *header, int for_disksave);
|
|
|
308 DEFINE_LRECORD_IMPLEMENTATION ("command-builder", command_builder,
|
|
|
309 mark_command_builder, internal_object_printer,
|
|
|
310 finalize_command_builder, 0, 0,
|
|
|
311 struct command_builder);
|
|
|
312
|
|
|
313 static Lisp_Object
|
|
|
314 mark_command_builder (Lisp_Object obj, void (*markobj) (Lisp_Object))
|
|
|
315 {
|
|
|
316 struct command_builder *builder = XCOMMAND_BUILDER (obj);
|
|
|
317 (markobj) (builder->prefix_events);
|
|
|
318 (markobj) (builder->current_events);
|
|
|
319 (markobj) (builder->most_current_event);
|
|
|
320 (markobj) (builder->last_non_munged_event);
|
|
|
321 (markobj) (builder->munge_me[0].first_mungeable_event);
|
|
|
322 (markobj) (builder->munge_me[1].first_mungeable_event);
|
|
|
323 return builder->console;
|
|
|
324 }
|
|
|
325
|
|
|
326 static void
|
|
|
327 finalize_command_builder (void *header, int for_disksave)
|
|
|
328 {
|
|
|
329 struct command_builder *c = (struct command_builder *) header;
|
|
|
330
|
|
|
331 if (!for_disksave)
|
|
|
332 {
|
|
|
333 xfree (c->echo_buf);
|
|
|
334 c->echo_buf = 0;
|
|
|
335 }
|
|
|
336 }
|
|
|
337
|
|
|
338 static void
|
|
|
339 reset_command_builder_event_chain (struct command_builder *builder)
|
|
|
340 {
|
|
|
341 builder->prefix_events = Qnil;
|
|
|
342 builder->current_events = Qnil;
|
|
|
343 builder->most_current_event = Qnil;
|
|
|
344 builder->last_non_munged_event = Qnil;
|
|
|
345 builder->munge_me[0].first_mungeable_event = Qnil;
|
|
|
346 builder->munge_me[1].first_mungeable_event = Qnil;
|
|
|
347 }
|
|
|
348
|
|
|
349 Lisp_Object
|
|
|
350 allocate_command_builder (Lisp_Object console)
|
|
|
351 {
|
|
|
352 Lisp_Object builder_obj = Qnil;
|
|
|
353 struct command_builder *builder =
|
|
|
354 alloc_lcrecord (sizeof (struct command_builder),
|
|
|
355 lrecord_command_builder);
|
|
|
356
|
|
|
357 builder->console = console;
|
|
|
358 reset_command_builder_event_chain (builder);
|
|
|
359 builder->echo_buf_length = 300; /* #### Kludge */
|
|
|
360 builder->echo_buf =
|
|
|
361 (Bufbyte *) xmalloc (builder->echo_buf_length);
|
|
|
362 builder->echo_buf[0] = 0;
|
|
|
363 builder->echo_buf_index = -1;
|
|
|
364 builder->echo_buf_index = -1;
|
|
|
365 builder->self_insert_countdown = 0;
|
|
|
366
|
|
|
367 XSETCOMMAND_BUILDER (builder_obj, builder);
|
|
|
368 return builder_obj;
|
|
|
369 }
|
|
|
370
|
|
|
371 static void
|
|
|
372 command_builder_append_event (struct command_builder *builder,
|
|
|
373 Lisp_Object event)
|
|
|
374 {
|
|
|
375 assert (EVENTP (event));
|
|
|
376
|
|
|
377 if (EVENTP (builder->most_current_event))
|
|
|
378 XSET_EVENT_NEXT (builder->most_current_event, event);
|
|
|
379 else
|
|
|
380 builder->current_events = event;
|
|
|
381
|
|
|
382 builder->most_current_event = event;
|
|
|
383 if (NILP (builder->munge_me[0].first_mungeable_event))
|
|
|
384 builder->munge_me[0].first_mungeable_event = event;
|
|
|
385 if (NILP (builder->munge_me[1].first_mungeable_event))
|
|
|
386 builder->munge_me[1].first_mungeable_event = event;
|
|
|
387 }
|
|
|
388
|
|
|
389
|
|
|
390 /**********************************************************************/
|
|
|
391 /* Low-level interfaces onto event methods */
|
|
|
392 /**********************************************************************/
|
|
|
393
|
|
|
394 enum event_stream_operation
|
|
|
395 {
|
|
|
396 EVENT_STREAM_PROCESS,
|
|
|
397 EVENT_STREAM_TIMEOUT,
|
|
|
398 EVENT_STREAM_CONSOLE,
|
|
|
399 EVENT_STREAM_READ
|
|
|
400 };
|
|
|
401
|
|
|
402 static void
|
|
|
403 check_event_stream_ok (enum event_stream_operation op)
|
|
|
404 {
|
|
|
405 if (!event_stream && noninteractive)
|
|
|
406 {
|
|
|
407 switch (op)
|
|
|
408 {
|
|
|
409 case EVENT_STREAM_PROCESS:
|
|
|
410 error ("Can't start subprocesses in -batch mode");
|
|
|
411 case EVENT_STREAM_TIMEOUT:
|
|
|
412 error ("Can't add timeouts in -batch mode");
|
|
|
413 case EVENT_STREAM_CONSOLE:
|
|
|
414 error ("Can't add consoles in -batch mode");
|
|
|
415 case EVENT_STREAM_READ:
|
|
|
416 error ("Can't read events in -batch mode");
|
|
|
417 default:
|
|
|
418 abort ();
|
|
|
419 }
|
|
|
420 }
|
|
|
421 else if (!event_stream)
|
|
|
422 {
|
|
|
423 error ("event-stream callbacks not initialized (internal error?)");
|
|
|
424 }
|
|
|
425 }
|
|
|
426
|
|
|
427 int
|
|
|
428 event_stream_event_pending_p (int user)
|
|
|
429 {
|
|
|
430 if (!event_stream)
|
|
|
431 return 0;
|
|
|
432 return event_stream->event_pending_p (user);
|
|
|
433 }
|
|
|
434
|
|
|
435 static int
|
|
|
436 maybe_read_quit_event (struct Lisp_Event *event)
|
|
|
437 {
|
|
|
438 /* A C-g that came from `sigint_happened' will always come from the
|
|
|
439 controlling terminal. If that doesn't exist, however, then the
|
|
|
440 user manually sent us a SIGINT, and we pretend the C-g came from
|
|
|
441 the selected console. */
|
|
|
442 struct console *con;
|
|
|
443
|
|
|
444 if (CONSOLEP (Vcontrolling_terminal) &&
|
|
|
445 CONSOLE_LIVE_P (XCONSOLE (Vcontrolling_terminal)))
|
|
|
446 con = XCONSOLE (Vcontrolling_terminal);
|
|
|
447 else
|
|
|
448 con = XCONSOLE (Fselected_console ());
|
|
|
449
|
|
|
450 if (sigint_happened)
|
|
|
451 {
|
|
|
452 int ch = CONSOLE_QUIT_CHAR (con);
|
|
|
453 sigint_happened = 0;
|
|
|
454 Vquit_flag = Qnil;
|
|
|
455 character_to_event (ch, event, con, 1);
|
|
|
456 event->channel = make_console (con);
|
|
|
457 return 1;
|
|
|
458 }
|
|
|
459 return 0;
|
|
|
460 }
|
|
|
461
|
|
|
462 void
|
|
|
463 event_stream_next_event (struct Lisp_Event *event)
|
|
|
464 {
|
|
|
465 Lisp_Object event_obj = Qnil;
|
|
|
466
|
|
|
467 check_event_stream_ok (EVENT_STREAM_READ);
|
|
|
468
|
|
|
469 XSETEVENT (event_obj, event);
|
|
|
470 zero_event (event);
|
|
|
471 /* If C-g was pressed, treat it as a character to be read.
|
|
|
472 Note that if C-g was pressed while we were blocking,
|
|
|
473 the SIGINT signal handler will be called. It will
|
|
|
474 set Vquit_flag and write a byte on our "fake pipe",
|
|
|
475 which will unblock us. */
|
|
|
476 if (maybe_read_quit_event (event))
|
|
|
477 {
|
|
|
478 #ifdef DEBUG_XEMACS
|
|
|
479 if (debug_emacs_events)
|
|
|
480 {
|
|
|
481 write_c_string ("(SIGINT) ",
|
|
|
482 Qexternal_debugging_output);
|
|
|
483 print_internal (event_obj, Qexternal_debugging_output, 1);
|
|
|
484 write_c_string ("\n", Qexternal_debugging_output);
|
|
|
485 }
|
|
|
486 #endif
|
|
|
487 return;
|
|
|
488 }
|
|
|
489
|
|
|
490 /* If a longjmp() happens in the callback, we're screwed.
|
|
|
491 Let's hope it doesn't. I think the code here is fairly
|
|
|
492 clean and doesn't do this. */
|
|
|
493 emacs_is_blocking = 1;
|
|
|
494 #if 0
|
|
|
495 /* Do this if the poll-for-quit timer seems to be taking too
|
|
|
496 much CPU time when idle ... */
|
|
|
497 reset_poll_for_quit ();
|
|
|
498 #endif
|
|
|
499 event_stream->next_event_cb (event);
|
|
|
500 #if 0
|
|
|
501 init_poll_for_quit ();
|
|
|
502 #endif
|
|
|
503 emacs_is_blocking = 0;
|
|
|
504
|
|
|
505 #ifdef DEBUG_XEMACS
|
|
|
506 if (debug_emacs_events)
|
|
|
507 {
|
|
|
508 write_c_string ("(real) ",
|
|
|
509 Qexternal_debugging_output);
|
|
|
510 /* timeout events have more info set later, so
|
|
|
511 print the event out in next_event_internal(). */
|
|
|
512 if (event->event_type != timeout_event)
|
|
|
513 {
|
|
|
514 print_internal (event_obj, Qexternal_debugging_output, 1);
|
|
|
515 write_c_string ("\n", Qexternal_debugging_output);
|
|
|
516 }
|
|
|
517 }
|
|
|
518 #endif
|
|
|
519 maybe_kbd_translate (event_obj);
|
|
|
520 }
|
|
|
521
|
|
|
522 void
|
|
|
523 event_stream_handle_magic_event (struct Lisp_Event *event)
|
|
|
524 {
|
|
|
525 check_event_stream_ok (EVENT_STREAM_READ);
|
|
|
526 event_stream->handle_magic_event_cb (event);
|
|
|
527 }
|
|
|
528
|
|
|
529 static int
|
|
|
530 event_stream_add_timeout (EMACS_TIME timeout)
|
|
|
531 {
|
|
|
532 check_event_stream_ok (EVENT_STREAM_TIMEOUT);
|
|
|
533 return event_stream->add_timeout_cb (timeout);
|
|
|
534 }
|
|
|
535
|
|
|
536 static void
|
|
|
537 event_stream_remove_timeout (int id)
|
|
|
538 {
|
|
|
539 check_event_stream_ok (EVENT_STREAM_TIMEOUT);
|
|
|
540 event_stream->remove_timeout_cb (id);
|
|
|
541 }
|
|
|
542
|
|
|
543 void
|
|
|
544 event_stream_select_console (struct console *con)
|
|
|
545 {
|
|
|
546 check_event_stream_ok (EVENT_STREAM_CONSOLE);
|
|
|
547 if (!con->input_enabled)
|
|
|
548 {
|
|
|
549 event_stream->select_console_cb (con);
|
|
|
550 con->input_enabled = 1;
|
|
|
551 }
|
|
|
552 }
|
|
|
553
|
|
|
554 void
|
|
|
555 event_stream_unselect_console (struct console *con)
|
|
|
556 {
|
|
|
557 check_event_stream_ok (EVENT_STREAM_CONSOLE);
|
|
|
558 if (con->input_enabled)
|
|
|
559 {
|
|
|
560 event_stream->unselect_console_cb (con);
|
|
|
561 con->input_enabled = 0;
|
|
|
562 }
|
|
|
563 }
|
|
|
564
|
|
|
565 void
|
|
|
566 event_stream_select_process (struct Lisp_Process *proc)
|
|
|
567 {
|
|
|
568 check_event_stream_ok (EVENT_STREAM_PROCESS);
|
|
|
569 if (!get_process_selected_p (proc))
|
|
|
570 {
|
|
|
571 event_stream->select_process_cb (proc);
|
|
|
572 set_process_selected_p (proc, 1);
|
|
|
573 }
|
|
|
574 }
|
|
|
575
|
|
|
576 void
|
|
|
577 event_stream_unselect_process (struct Lisp_Process *proc)
|
|
|
578 {
|
|
|
579 check_event_stream_ok (EVENT_STREAM_PROCESS);
|
|
|
580 if (get_process_selected_p (proc))
|
|
|
581 {
|
|
|
582 event_stream->unselect_process_cb (proc);
|
|
|
583 set_process_selected_p (proc, 0);
|
|
|
584 }
|
|
|
585 }
|
|
|
586
|
|
|
587 void
|
|
|
588 event_stream_quit_p (void)
|
|
|
589 {
|
|
|
590 if (event_stream)
|
|
|
591 event_stream->quit_p_cb ();
|
|
|
592 }
|
|
|
593
|
|
|
594
|
|
|
595
|
|
|
596 /**********************************************************************/
|
|
|
597 /* Character prompting */
|
|
|
598 /**********************************************************************/
|
|
|
599
|
|
|
600 static void
|
|
|
601 echo_key_event (struct command_builder *command_builder,
|
|
|
602 Lisp_Object event)
|
|
|
603 {
|
|
|
604 /* This function can GC */
|
|
|
605 char buf[255];
|
|
|
606 Bytecount buf_index = command_builder->echo_buf_index;
|
|
|
607 Bufbyte *e;
|
|
|
608 Bytecount len;
|
|
|
609
|
|
|
610 if (buf_index < 0)
|
|
|
611 {
|
|
|
612 buf_index = 0; /* We're echoing now */
|
|
|
613 clear_echo_area (selected_frame (), Qnil, 0);
|
|
|
614 }
|
|
|
615
|
|
|
616 format_event_object (buf, XEVENT (event), 1);
|
|
|
617 len = strlen (buf);
|
|
|
618
|
|
|
619 if (len + buf_index + 4 > command_builder->echo_buf_length)
|
|
|
620 return;
|
|
|
621 e = command_builder->echo_buf + buf_index;
|
|
|
622 memcpy (e, buf, len);
|
|
|
623 e += len;
|
|
|
624
|
|
|
625 e[0] = ' ';
|
|
|
626 e[1] = '-';
|
|
|
627 e[2] = ' ';
|
|
|
628 e[3] = 0;
|
|
|
629
|
|
|
630 command_builder->echo_buf_index = buf_index + len + 1;
|
|
|
631 }
|
|
|
632
|
|
|
633 static void
|
|
|
634 regenerate_echo_keys_from_this_command_keys (struct command_builder *
|
|
|
635 builder)
|
|
|
636 {
|
|
|
637 Lisp_Object event;
|
|
|
638
|
|
|
639 builder->echo_buf_index = 0;
|
|
|
640
|
|
|
641 EVENT_CHAIN_LOOP (event, Vthis_command_keys)
|
|
|
642 echo_key_event (builder, event);
|
|
|
643 }
|
|
|
644
|
|
|
645 static void
|
|
|
646 maybe_echo_keys (struct command_builder *command_builder, int no_snooze)
|
|
|
647 {
|
|
|
648 /* This function can GC */
|
|
|
649 struct frame *f = selected_frame ();
|
|
|
650 /* Message turns off echoing unless more keystrokes turn it on again. */
|
|
|
651 if (echo_area_active (f) && !EQ (Qcommand, echo_area_status (f)))
|
|
|
652 return;
|
|
|
653
|
|
|
654 if (minibuf_level == 0
|
|
|
655 && echo_keystrokes > 0)
|
|
|
656 {
|
|
|
657 if (!no_snooze)
|
|
|
658 {
|
|
|
659 /* #### C-g here will cause QUIT. Setting dont_check_for_quit
|
|
|
660 doesn't work. See check_quit. */
|
|
|
661 if (NILP (Fsit_for (make_int (echo_keystrokes), Qnil)))
|
|
|
662 /* input came in, so don't echo. */
|
|
|
663 return;
|
|
|
664 }
|
|
|
665
|
|
|
666 echo_area_message (f, command_builder->echo_buf, Qnil, 0,
|
|
|
667 /* not echo_buf_index. That doesn't include
|
|
|
668 the terminating " - ". */
|
|
|
669 strlen ((char *) command_builder->echo_buf),
|
|
|
670 Qcommand);
|
|
|
671 }
|
|
|
672 }
|
|
|
673
|
|
|
674 static void
|
|
|
675 reset_key_echo (struct command_builder *command_builder,
|
|
|
676 int remove_echo_area_echo)
|
|
|
677 {
|
|
|
678 /* This function can GC */
|
|
|
679 struct frame *f = selected_frame ();
|
|
|
680
|
|
|
681 command_builder->echo_buf_index = -1;
|
|
|
682
|
|
|
683 if (remove_echo_area_echo)
|
|
|
684 clear_echo_area (f, Qcommand, 0);
|
|
|
685 }
|
|
|
686
|
|
|
687
|
|
|
688 /**********************************************************************/
|
|
|
689 /* random junk */
|
|
|
690 /**********************************************************************/
|
|
|
691
|
|
|
692 static void
|
|
|
693 maybe_kbd_translate (Lisp_Object event)
|
|
|
694 {
|
|
|
695 Emchar c;
|
|
|
696 int did_translate = 0;
|
|
|
697
|
|
|
698 if (XEVENT_TYPE (event) != key_press_event)
|
|
|
699 return;
|
|
|
700 if (!HASHTABLEP (Vkeyboard_translate_table))
|
|
|
701 return;
|
|
|
702 if (EQ (Fhashtable_fullness (Vkeyboard_translate_table), Qzero))
|
|
|
703 return;
|
|
|
704
|
|
|
705 c = event_to_character (XEVENT (event), 0, 0, 0);
|
|
|
706 if (c != -1)
|
|
|
707 {
|
|
|
708 Lisp_Object traduit = Fgethash (make_char (c), Vkeyboard_translate_table,
|
|
|
709 Qnil);
|
|
|
710 if (!NILP (traduit) && SYMBOLP (traduit))
|
|
|
711 {
|
|
|
712 XEVENT (event)->event.key.keysym = traduit;
|
|
|
713 XEVENT (event)->event.key.modifiers = 0;
|
|
|
714 did_translate = 1;
|
|
|
715 }
|
|
|
716 else if (CHARP (traduit))
|
|
|
717 {
|
|
|
718 struct Lisp_Event ev2;
|
|
|
719
|
|
|
720 /* This used to call Fcharacter_to_event() directly into EVENT,
|
|
|
721 but that can eradicate timestamps and other such stuff.
|
|
|
722 This way is safer. */
|
|
|
723 zero_event (&ev2);
|
|
|
724 character_to_event (XCHAR (traduit), &ev2,
|
|
|
725 XCONSOLE (EVENT_CHANNEL (XEVENT (event))), 1);
|
|
|
726 XEVENT (event)->event.key.keysym = ev2.event.key.keysym;
|
|
|
727 XEVENT (event)->event.key.modifiers = ev2.event.key.modifiers;
|
|
|
728 did_translate = 1;
|
|
|
729 }
|
|
|
730 }
|
|
|
731
|
|
|
732 if (!did_translate)
|
|
|
733 {
|
|
|
734 Lisp_Object traduit = Fgethash (XEVENT (event)->event.key.keysym,
|
|
|
735 Vkeyboard_translate_table, Qnil);
|
|
|
736 if (!NILP (traduit) && SYMBOLP (traduit))
|
|
|
737 {
|
|
|
738 XEVENT (event)->event.key.keysym = traduit;
|
|
|
739 did_translate = 1;
|
|
|
740 }
|
|
|
741 }
|
|
|
742
|
|
|
743 #ifdef DEBUG_XEMACS
|
|
|
744 if (did_translate && debug_emacs_events)
|
|
|
745 {
|
|
|
746 write_c_string ("(->keyboard-translate-table) ",
|
|
|
747 Qexternal_debugging_output);
|
|
|
748 print_internal (event, Qexternal_debugging_output, 1);
|
|
|
749 write_c_string ("\n", Qexternal_debugging_output);
|
|
|
750 }
|
|
|
751 #endif
|
|
|
752 }
|
|
|
753
|
|
|
754 /* NB: The following auto-save stuff is in keyboard.c in FSFmacs, and
|
|
|
755 keystrokes_since_auto_save is equivalent to the difference between
|
|
|
756 num_nonmacro_input_chars and last_auto_save. */
|
|
|
757
|
|
|
758 /* When an auto-save happens, record the "time", and don't do again soon. */
|
|
|
759
|
|
|
760 void
|
|
|
761 record_auto_save (void)
|
|
|
762 {
|
|
|
763 keystrokes_since_auto_save = 0;
|
|
|
764 }
|
|
|
765
|
|
|
766 /* Make an auto save happen as soon as possible at command level. */
|
|
|
767
|
|
|
768 void
|
|
|
769 force_auto_save_soon (void)
|
|
|
770 {
|
|
|
771 keystrokes_since_auto_save = 1 + max (auto_save_interval, 20);
|
|
|
772
|
|
|
773 #if 0 /* FSFmacs */
|
|
|
774 record_asynch_buffer_change ();
|
|
|
775 #endif
|
|
|
776 }
|
|
|
777
|
|
|
778 static void
|
|
|
779 maybe_do_auto_save (void)
|
|
|
780 {
|
|
116
|
781 /* This function can call lisp */
|
|
0
|
782 keystrokes_since_auto_save++;
|
|
|
783 if (auto_save_interval > 0 &&
|
|
|
784 keystrokes_since_auto_save > max (auto_save_interval, 20) &&
|
|
|
785 !detect_input_pending ())
|
|
|
786 {
|
|
|
787 Fdo_auto_save (Qnil, Qnil);
|
|
|
788 record_auto_save ();
|
|
|
789 }
|
|
|
790 }
|
|
|
791
|
|
|
792 static Lisp_Object
|
|
|
793 print_help (Lisp_Object object)
|
|
|
794 {
|
|
|
795 Fprinc (object, Qnil);
|
|
|
796 return Qnil;
|
|
|
797 }
|
|
|
798
|
|
|
799 static void
|
|
|
800 execute_help_form (struct command_builder *command_builder,
|
|
|
801 Lisp_Object event)
|
|
|
802 {
|
|
|
803 /* This function can GC */
|
|
|
804 Lisp_Object help = Qnil;
|
|
|
805 int speccount = specpdl_depth ();
|
|
|
806 Bytecount buf_index = command_builder->echo_buf_index;
|
|
|
807 Lisp_Object echo = ((buf_index <= 0)
|
|
|
808 ? Qnil
|
|
|
809 : make_string (command_builder->echo_buf,
|
|
|
810 buf_index));
|
|
|
811 struct gcpro gcpro1, gcpro2;
|
|
|
812 GCPRO2 (echo, help);
|
|
|
813
|
|
|
814 record_unwind_protect (save_window_excursion_unwind,
|
|
|
815 Fcurrent_window_configuration (Qnil));
|
|
|
816 reset_key_echo (command_builder, 1);
|
|
|
817
|
|
|
818 help = Feval (Vhelp_form);
|
|
|
819 if (STRINGP (help))
|
|
|
820 internal_with_output_to_temp_buffer ("*Help*",
|
|
|
821 print_help, help, Qnil);
|
|
|
822 Fnext_command_event (event, Qnil);
|
|
|
823 /* Remove the help from the frame */
|
|
|
824 unbind_to (speccount, Qnil);
|
|
|
825 /* Hmmmm. Tricky. The unbind restores an old window configuration,
|
|
|
826 apparently bypassing any setting of windows_structure_changed.
|
|
|
827 So we need to set it so that things get redrawn properly. */
|
|
|
828 /* #### This is massive overkill. Look at doing it better once the
|
|
|
829 new redisplay is fully in place. */
|
|
|
830 {
|
|
|
831 Lisp_Object frmcons, devcons, concons;
|
|
|
832 FRAME_LOOP_NO_BREAK (frmcons, devcons, concons)
|
|
|
833 {
|
|
|
834 MARK_FRAME_WINDOWS_STRUCTURE_CHANGED (XFRAME (XCAR (frmcons)));
|
|
|
835 }
|
|
|
836 }
|
|
|
837
|
|
|
838 redisplay ();
|
|
|
839 if (event_matches_key_specifier_p (XEVENT (event), make_char (' ')))
|
|
|
840 {
|
|
2
|
841 /* Discard next key if it is a space */
|
|
0
|
842 reset_key_echo (command_builder, 1);
|
|
|
843 Fnext_command_event (event, Qnil);
|
|
|
844 }
|
|
|
845
|
|
|
846 command_builder->echo_buf_index = buf_index;
|
|
|
847 if (buf_index > 0)
|
|
|
848 memcpy (command_builder->echo_buf,
|
|
14
|
849 XSTRING_DATA (echo), buf_index + 1); /* terminating 0 */
|
|
0
|
850 UNGCPRO;
|
|
|
851 }
|
|
|
852
|
|
|
853
|
|
|
854 /**********************************************************************/
|
|
|
855 /* input pending */
|
|
|
856 /**********************************************************************/
|
|
|
857
|
|
|
858 int
|
|
|
859 detect_input_pending (void)
|
|
|
860 {
|
|
|
861 /* Always call the event_pending_p hook even if there's an unread
|
|
|
862 character, because that might do some needed ^G detection (on
|
|
|
863 systems without SIGIO, for example).
|
|
|
864 */
|
|
|
865 if (event_stream_event_pending_p (1))
|
|
|
866 return 1;
|
|
|
867 if (!NILP (Vunread_command_events) || !NILP (Vunread_command_event))
|
|
|
868 return 1;
|
|
|
869 if (!NILP (command_event_queue))
|
|
|
870 {
|
|
|
871 Lisp_Object event;
|
|
|
872
|
|
|
873 EVENT_CHAIN_LOOP (event, command_event_queue)
|
|
|
874 {
|
|
|
875 if (XEVENT_TYPE (event) != eval_event
|
|
|
876 && XEVENT_TYPE (event) != magic_eval_event)
|
|
|
877 return (1);
|
|
|
878 }
|
|
|
879 }
|
|
|
880 return 0;
|
|
|
881 }
|
|
|
882
|
|
20
|
883 DEFUN ("input-pending-p", Finput_pending_p, 0, 0, 0, /*
|
|
0
|
884 T if command input is currently available with no waiting.
|
|
|
885 Actually, the value is nil only if we can be sure that no input is available.
|
|
20
|
886 */
|
|
70
|
887 ())
|
|
0
|
888 {
|
|
|
889 return ((detect_input_pending ()) ? Qt : Qnil);
|
|
|
890 }
|
|
|
891
|
|
|
892
|
|
|
893 /**********************************************************************/
|
|
|
894 /* timeouts */
|
|
|
895 /**********************************************************************/
|
|
|
896
|
|
|
897 /**** Low-level timeout functions. ****
|
|
|
898
|
|
|
899 These functions maintain a sorted list of one-shot timeouts (where
|
|
|
900 the timeouts are in absolute time). They are intended for use by
|
|
|
901 functions that need to convert a list of absolute timeouts into a
|
|
|
902 series of intervals to wait for. */
|
|
|
903
|
|
|
904 /* We ensure that 0 is never a valid ID, so that a value of 0 can be
|
|
|
905 used to indicate an absence of a timer. */
|
|
|
906 static int low_level_timeout_id_tick;
|
|
|
907
|
|
|
908 struct low_level_timeout_blocktype
|
|
|
909 {
|
|
|
910 Blocktype_declare (struct low_level_timeout);
|
|
|
911 } *the_low_level_timeout_blocktype;
|
|
|
912
|
|
|
913 /* Add a one-shot timeout at time TIME to TIMEOUT_LIST. Return
|
|
|
914 a unique ID identifying the timeout. */
|
|
|
915
|
|
|
916 int
|
|
|
917 add_low_level_timeout (struct low_level_timeout **timeout_list,
|
|
|
918 EMACS_TIME thyme)
|
|
|
919 {
|
|
|
920 struct low_level_timeout *tm;
|
|
|
921 struct low_level_timeout *t, **tt;
|
|
|
922
|
|
|
923 /* Allocate a new time struct. */
|
|
|
924
|
|
|
925 tm = Blocktype_alloc (the_low_level_timeout_blocktype);
|
|
|
926 tm->next = NULL;
|
|
|
927 if (low_level_timeout_id_tick == 0)
|
|
|
928 low_level_timeout_id_tick++;
|
|
|
929 tm->id = low_level_timeout_id_tick++;
|
|
|
930 tm->time = thyme;
|
|
|
931
|
|
|
932 /* Add it to the queue. */
|
|
|
933
|
|
|
934 tt = timeout_list;
|
|
|
935 t = *tt;
|
|
|
936 while (t && EMACS_TIME_EQUAL_OR_GREATER (tm->time, t->time))
|
|
|
937 {
|
|
|
938 tt = &t->next;
|
|
|
939 t = *tt;
|
|
|
940 }
|
|
|
941 tm->next = t;
|
|
|
942 *tt = tm;
|
|
|
943
|
|
|
944 return tm->id;
|
|
|
945 }
|
|
|
946
|
|
|
947 /* Remove the low-level timeout identified by ID from TIMEOUT_LIST.
|
|
|
948 If the timeout is not there, do nothing. */
|
|
|
949
|
|
|
950 void
|
|
|
951 remove_low_level_timeout (struct low_level_timeout **timeout_list, int id)
|
|
|
952 {
|
|
|
953 struct low_level_timeout *t, *prev;
|
|
|
954
|
|
|
955 /* find it */
|
|
|
956
|
|
|
957 for (t = *timeout_list, prev = NULL; t && t->id != id; t = t->next)
|
|
|
958 prev = t;
|
|
|
959
|
|
|
960 if (!t)
|
|
|
961 return; /* couldn't find it */
|
|
|
962
|
|
|
963 if (!prev)
|
|
|
964 *timeout_list = t->next;
|
|
|
965 else prev->next = t->next;
|
|
|
966
|
|
|
967 Blocktype_free (the_low_level_timeout_blocktype, t);
|
|
|
968 }
|
|
|
969
|
|
|
970 /* If there are timeouts on TIMEOUT_LIST, store the relative time
|
|
|
971 interval to the first timeout on the list into INTERVAL and
|
|
|
972 return 1. Otherwise, return 0. */
|
|
|
973
|
|
|
974 int
|
|
|
975 get_low_level_timeout_interval (struct low_level_timeout *timeout_list,
|
|
|
976 EMACS_TIME *interval)
|
|
|
977 {
|
|
|
978 if (!timeout_list) /* no timer events; block indefinitely */
|
|
|
979 return 0;
|
|
|
980 else
|
|
|
981 {
|
|
|
982 EMACS_TIME current_time;
|
|
|
983
|
|
|
984 /* The time to block is the difference between the first
|
|
|
985 (earliest) timer on the queue and the current time.
|
|
|
986 If that is negative, then the timer will fire immediately
|
|
|
987 but we still have to call select(), with a zero-valued
|
|
|
988 timeout: user events must have precedence over timer events. */
|
|
|
989 EMACS_GET_TIME (current_time);
|
|
|
990 if (EMACS_TIME_GREATER (timeout_list->time, current_time))
|
|
|
991 EMACS_SUB_TIME (*interval, timeout_list->time,
|
|
|
992 current_time);
|
|
|
993 else
|
|
|
994 EMACS_SET_SECS_USECS (*interval, 0, 0);
|
|
|
995 return 1;
|
|
|
996 }
|
|
|
997 }
|
|
|
998
|
|
|
999 /* Pop the first (i.e. soonest) timeout off of TIMEOUT_LIST and return
|
|
|
1000 its ID. Also, if TIME_OUT is not 0, store the absolute time of the
|
|
|
1001 timeout into TIME_OUT. */
|
|
|
1002
|
|
|
1003 int
|
|
|
1004 pop_low_level_timeout (struct low_level_timeout **timeout_list,
|
|
|
1005 EMACS_TIME *time_out)
|
|
|
1006 {
|
|
|
1007 struct low_level_timeout *tm = *timeout_list;
|
|
|
1008 int id;
|
|
|
1009
|
|
|
1010 assert (tm);
|
|
|
1011 id = tm->id;
|
|
|
1012 if (time_out)
|
|
|
1013 *time_out = tm->time;
|
|
|
1014 *timeout_list = tm->next;
|
|
|
1015 Blocktype_free (the_low_level_timeout_blocktype, tm);
|
|
|
1016 return id;
|
|
|
1017 }
|
|
|
1018
|
|
|
1019
|
|
|
1020 /**** High-level timeout functions. ****/
|
|
|
1021
|
|
|
1022 static int timeout_id_tick;
|
|
|
1023
|
|
|
1024 /* Since timeout structures contain Lisp_Objects, they need to be GC'd
|
|
|
1025 properly. The opaque data type provides a convenient way of doing
|
|
|
1026 this without having to create a new Lisp object, since we can
|
|
|
1027 provide our own mark function. */
|
|
|
1028
|
|
|
1029 struct timeout
|
|
|
1030 {
|
|
|
1031 int id; /* Id we use to identify the timeout over its lifetime */
|
|
|
1032 int interval_id; /* Id for this particular interval; this may
|
|
|
1033 be different each time the timeout is
|
|
|
1034 signalled.*/
|
|
|
1035 Lisp_Object function, object; /* Function and object associated
|
|
|
1036 with timeout. */
|
|
|
1037 EMACS_TIME next_signal_time; /* Absolute time when the timeout
|
|
|
1038 is next going to be signalled. */
|
|
|
1039 unsigned int resignal_msecs; /* How far after the next timeout
|
|
|
1040 should the one after that
|
|
|
1041 occur? */
|
|
|
1042 };
|
|
|
1043
|
|
|
1044 static Lisp_Object pending_timeout_list, pending_async_timeout_list;
|
|
|
1045
|
|
|
1046 static Lisp_Object Vtimeout_free_list;
|
|
|
1047
|
|
|
1048 static Lisp_Object
|
|
|
1049 mark_timeout (Lisp_Object obj, void (*markobj) (Lisp_Object))
|
|
|
1050 {
|
|
|
1051 struct timeout *tm = (struct timeout *) XOPAQUE_DATA (obj);
|
|
|
1052 (markobj) (tm->function);
|
|
|
1053 return tm->object;
|
|
|
1054 }
|
|
|
1055
|
|
|
1056 /* Generate a timeout and return its ID. */
|
|
|
1057
|
|
|
1058 int
|
|
|
1059 event_stream_generate_wakeup (unsigned int milliseconds,
|
|
|
1060 unsigned int vanilliseconds,
|
|
|
1061 Lisp_Object function, Lisp_Object object,
|
|
|
1062 int async_p)
|
|
|
1063 {
|
|
|
1064 Lisp_Object op = allocate_managed_opaque (Vtimeout_free_list, 0);
|
|
|
1065 struct timeout *timeout = (struct timeout *) XOPAQUE_DATA (op);
|
|
|
1066 EMACS_TIME current_time;
|
|
|
1067 EMACS_TIME interval;
|
|
|
1068
|
|
|
1069 timeout->id = timeout_id_tick++;
|
|
|
1070 timeout->resignal_msecs = vanilliseconds;
|
|
|
1071 timeout->function = function;
|
|
|
1072 timeout->object = object;
|
|
|
1073
|
|
|
1074 EMACS_GET_TIME (current_time);
|
|
|
1075 EMACS_SET_SECS_USECS (interval, milliseconds / 1000,
|
|
|
1076 1000 * (milliseconds % 1000));
|
|
|
1077 EMACS_ADD_TIME (timeout->next_signal_time, current_time, interval);
|
|
|
1078
|
|
|
1079 if (async_p)
|
|
|
1080 {
|
|
|
1081 timeout->interval_id =
|
|
|
1082 event_stream_add_async_timeout (timeout->next_signal_time);
|
|
|
1083 pending_async_timeout_list = noseeum_cons (op,
|
|
|
1084 pending_async_timeout_list);
|
|
|
1085 }
|
|
|
1086 else
|
|
|
1087 {
|
|
|
1088 timeout->interval_id =
|
|
|
1089 event_stream_add_timeout (timeout->next_signal_time);
|
|
|
1090 pending_timeout_list = noseeum_cons (op, pending_timeout_list);
|
|
|
1091 }
|
|
|
1092 return timeout->id;
|
|
|
1093 }
|
|
|
1094
|
|
|
1095 /* Given the INTERVAL-ID of a timeout just signalled, resignal the timeout
|
|
|
1096 as necessary and return the timeout's ID and function and object slots.
|
|
|
1097
|
|
|
1098 This should be called as a result of receiving notice that a timeout
|
|
|
1099 has fired. INTERVAL-ID is *not* the timeout's ID, but is the ID that
|
|
|
1100 identifies this particular firing of the timeout. INTERVAL-ID's and
|
|
|
1101 timeout ID's are in separate number spaces and bear no relation to
|
|
|
1102 each other. The INTERVAL-ID is all that the event callback routines
|
|
|
1103 work with: they work only with one-shot intervals, not with timeouts
|
|
|
1104 that may fire repeatedly.
|
|
|
1105
|
|
|
1106 NOTE: The returned FUNCTION and OBJECT are *not* GC-protected at all.
|
|
|
1107 */
|
|
|
1108
|
|
|
1109 static int
|
|
|
1110 event_stream_resignal_wakeup (int interval_id, int async_p,
|
|
|
1111 Lisp_Object *function, Lisp_Object *object)
|
|
|
1112 {
|
|
|
1113 Lisp_Object op = Qnil, rest;
|
|
|
1114 struct timeout *timeout;
|
|
|
1115 Lisp_Object *timeout_list;
|
|
|
1116 struct gcpro gcpro1;
|
|
|
1117 int id;
|
|
|
1118
|
|
|
1119 GCPRO1 (op); /* just in case ... because it's removed from the list
|
|
|
1120 for awhile. */
|
|
|
1121
|
|
|
1122 if (async_p)
|
|
|
1123 timeout_list = &pending_async_timeout_list;
|
|
|
1124 else
|
|
|
1125 timeout_list = &pending_timeout_list;
|
|
|
1126
|
|
|
1127 /* Find the timeout on the list of pending ones. */
|
|
|
1128 LIST_LOOP (rest, *timeout_list)
|
|
|
1129 {
|
|
|
1130 timeout = (struct timeout *) XOPAQUE_DATA (XCAR (rest));
|
|
|
1131 if (timeout->interval_id == interval_id)
|
|
|
1132 break;
|
|
|
1133 }
|
|
|
1134
|
|
|
1135 assert (!NILP (rest));
|
|
|
1136 op = XCAR (rest);
|
|
|
1137 timeout = (struct timeout *) XOPAQUE_DATA (op);
|
|
|
1138 /* We make sure to snarf the data out of the timeout object before
|
|
|
1139 we free it with free_managed_opaque(). */
|
|
|
1140 id = timeout->id;
|
|
|
1141 *function = timeout->function;
|
|
|
1142 *object = timeout->object;
|
|
|
1143
|
|
|
1144 /* Remove this one from the list of pending timeouts */
|
|
|
1145 *timeout_list = delq_no_quit_and_free_cons (op, *timeout_list);
|
|
|
1146
|
|
|
1147 /* If this timeout wants to be resignalled, do it now. */
|
|
|
1148 if (timeout->resignal_msecs)
|
|
|
1149 {
|
|
|
1150 EMACS_TIME current_time;
|
|
|
1151 EMACS_TIME interval;
|
|
|
1152
|
|
|
1153 /* Determine the time that the next resignalling should occur.
|
|
|
1154 We do that by adding the interval time to the last signalled
|
|
|
1155 time until we get a time that's current.
|
|
|
1156
|
|
|
1157 (This way, it doesn't matter if the timeout was signalled
|
|
|
1158 exactly when we asked for it, or at some time later.)
|
|
|
1159 */
|
|
|
1160 EMACS_GET_TIME (current_time);
|
|
|
1161 EMACS_SET_SECS_USECS (interval, timeout->resignal_msecs / 1000,
|
|
|
1162 1000 * (timeout->resignal_msecs % 1000));
|
|
|
1163 do
|
|
|
1164 {
|
|
|
1165 EMACS_ADD_TIME (timeout->next_signal_time, timeout->next_signal_time,
|
|
|
1166 interval);
|
|
|
1167 } while (EMACS_TIME_GREATER (current_time, timeout->next_signal_time));
|
|
|
1168
|
|
|
1169 if (async_p)
|
|
|
1170 timeout->interval_id =
|
|
|
1171 event_stream_add_async_timeout (timeout->next_signal_time);
|
|
|
1172 else
|
|
|
1173 timeout->interval_id =
|
|
|
1174 event_stream_add_timeout (timeout->next_signal_time);
|
|
|
1175 /* Add back onto the list. Note that the effect of this
|
|
|
1176 is to move frequently-hit timeouts to the front of the
|
|
|
1177 list, which is a good thing. */
|
|
|
1178 *timeout_list = noseeum_cons (op, *timeout_list);
|
|
|
1179 }
|
|
|
1180 else
|
|
|
1181 free_managed_opaque (Vtimeout_free_list, op);
|
|
|
1182
|
|
|
1183 UNGCPRO;
|
|
|
1184 return id;
|
|
|
1185 }
|
|
|
1186
|
|
|
1187 void
|
|
|
1188 event_stream_disable_wakeup (int id, int async_p)
|
|
|
1189 {
|
|
|
1190 struct timeout *timeout = 0;
|
|
|
1191 Lisp_Object rest = Qnil;
|
|
|
1192 Lisp_Object *timeout_list;
|
|
|
1193
|
|
|
1194 if (async_p)
|
|
|
1195 timeout_list = &pending_async_timeout_list;
|
|
|
1196 else
|
|
|
1197 timeout_list = &pending_timeout_list;
|
|
|
1198
|
|
|
1199 /* Find the timeout on the list of pending ones, if it's still there. */
|
|
|
1200 LIST_LOOP (rest, *timeout_list)
|
|
|
1201 {
|
|
|
1202 timeout = (struct timeout *) XOPAQUE_DATA (XCAR (rest));
|
|
|
1203 if (timeout->id == id)
|
|
|
1204 break;
|
|
|
1205 }
|
|
|
1206
|
|
|
1207 /* If we found it, remove it from the list and disable the pending
|
|
|
1208 one-shot. */
|
|
|
1209 if (!NILP (rest))
|
|
|
1210 {
|
|
|
1211 Lisp_Object op = XCAR (rest);
|
|
|
1212 *timeout_list =
|
|
|
1213 delq_no_quit_and_free_cons (op, *timeout_list);
|
|
|
1214 if (async_p)
|
|
|
1215 event_stream_remove_async_timeout (timeout->interval_id);
|
|
|
1216 else
|
|
|
1217 event_stream_remove_timeout (timeout->interval_id);
|
|
|
1218 free_managed_opaque (Vtimeout_free_list, op);
|
|
|
1219 }
|
|
|
1220 }
|
|
|
1221
|
|
74
|
1222 int
|
|
|
1223 event_stream_wakeup_pending_p (int id, int async_p)
|
|
|
1224 {
|
|
|
1225 struct timeout *timeout;
|
|
|
1226 Lisp_Object rest = Qnil;
|
|
|
1227 Lisp_Object timeout_list;
|
|
|
1228 int found = 0;
|
|
|
1229
|
|
|
1230
|
|
|
1231 if (async_p)
|
|
|
1232 timeout_list = pending_async_timeout_list;
|
|
|
1233 else
|
|
|
1234 timeout_list = pending_timeout_list;
|
|
|
1235
|
|
|
1236 /* Find the element on the list of pending ones, if it's still there. */
|
|
|
1237 LIST_LOOP (rest, timeout_list)
|
|
|
1238 {
|
|
|
1239 timeout = (struct timeout *) XOPAQUE_DATA (XCAR (rest));
|
|
|
1240 if (timeout->id == id)
|
|
|
1241 {
|
|
|
1242 found = 1;
|
|
|
1243 break;
|
|
|
1244 }
|
|
|
1245 }
|
|
|
1246
|
|
|
1247 return found;
|
|
|
1248 }
|
|
|
1249
|
|
0
|
1250
|
|
|
1251 /**** Asynch. timeout functions (see also signal.c) ****/
|
|
|
1252
|
|
|
1253 #if !defined (SIGIO) && !defined (DONT_POLL_FOR_QUIT)
|
|
|
1254 extern int poll_for_quit_id;
|
|
|
1255 #endif
|
|
|
1256
|
|
|
1257 #ifndef SIGCHLD
|
|
|
1258 extern int poll_for_sigchld_id;
|
|
|
1259 #endif
|
|
|
1260
|
|
|
1261 void
|
|
|
1262 event_stream_deal_with_async_timeout (int interval_id)
|
|
|
1263 {
|
|
|
1264 /* This function can GC */
|
|
|
1265 Lisp_Object humpty, dumpty;
|
|
|
1266 #if (!defined (SIGIO) && !defined (DONT_POLL_FOR_QUIT)) || !defined (SIGCHLD)
|
|
|
1267 int id =
|
|
|
1268 #endif
|
|
|
1269 event_stream_resignal_wakeup (interval_id, 1, &humpty, &dumpty);
|
|
|
1270
|
|
|
1271 #if !defined (SIGIO) && !defined (DONT_POLL_FOR_QUIT)
|
|
|
1272 if (id == poll_for_quit_id)
|
|
|
1273 {
|
|
|
1274 quit_check_signal_happened = 1;
|
|
|
1275 quit_check_signal_tick_count++;
|
|
|
1276 return;
|
|
|
1277 }
|
|
|
1278 #endif
|
|
|
1279
|
|
|
1280 #if !defined (SIGCHLD)
|
|
|
1281 if (id == poll_for_sigchld_id)
|
|
|
1282 {
|
|
|
1283 kick_status_notify ();
|
|
|
1284 return;
|
|
|
1285 }
|
|
|
1286 #endif
|
|
|
1287
|
|
|
1288 /* call1 GC-protects its arguments */
|
|
|
1289 call1_trapping_errors ("Error in asynchronous timeout callback",
|
|
|
1290 humpty, dumpty);
|
|
|
1291 }
|
|
|
1292
|
|
|
1293
|
|
|
1294 /**** Lisp-level timeout functions. ****/
|
|
|
1295
|
|
|
1296 static unsigned long
|
|
|
1297 lisp_number_to_milliseconds (Lisp_Object secs, int allow_0)
|
|
|
1298 {
|
|
|
1299 unsigned long msecs;
|
|
|
1300 #ifdef LISP_FLOAT_TYPE
|
|
|
1301 double fsecs;
|
|
|
1302 CHECK_INT_OR_FLOAT (secs);
|
|
|
1303 fsecs = XFLOATINT (secs);
|
|
|
1304 #else
|
|
|
1305 long fsecs;
|
|
|
1306 CHECK_INT_OR_FLOAT (secs);
|
|
|
1307 fsecs = XINT (secs);
|
|
|
1308 #endif
|
|
|
1309 msecs = 1000 * fsecs;
|
|
|
1310 if (fsecs < 0)
|
|
|
1311 signal_simple_error ("timeout is negative", secs);
|
|
|
1312 if (!allow_0 && fsecs == 0)
|
|
|
1313 signal_simple_error ("timeout is non-positive", secs);
|
|
|
1314 if (fsecs >= (((unsigned int) 0xFFFFFFFF) / 1000))
|
|
|
1315 signal_simple_error
|
|
|
1316 ("timeout would exceed 32 bits when represented in milliseconds", secs);
|
|
|
1317 return msecs;
|
|
|
1318 }
|
|
|
1319
|
|
20
|
1320 DEFUN ("add-timeout", Fadd_timeout, 3, 4, 0, /*
|
|
0
|
1321 Add a timeout, to be signaled after the timeout period has elapsed.
|
|
|
1322 SECS is a number of seconds, expressed as an integer or a float.
|
|
|
1323 FUNCTION will be called after that many seconds have elapsed, with one
|
|
|
1324 argument, the given OBJECT. If the optional RESIGNAL argument is provided,
|
|
|
1325 then after this timeout expires, `add-timeout' will automatically be called
|
|
|
1326 again with RESIGNAL as the first argument.
|
|
|
1327
|
|
|
1328 This function returns an object which is the id number of this particular
|
|
|
1329 timeout. You can pass that object to `disable-timeout' to turn off the
|
|
|
1330 timeout before it has been signalled.
|
|
|
1331
|
|
|
1332 NOTE: Id numbers as returned by this function are in a distinct namespace
|
|
|
1333 from those returned by `add-async-timeout'. This means that the same id
|
|
|
1334 number could refer to a pending synchronous timeout and a different pending
|
|
|
1335 asynchronous timeout, and that you cannot pass an id from `add-timeout'
|
|
|
1336 to `disable-async-timeout', or vice-versa.
|
|
|
1337
|
|
|
1338 The number of seconds may be expressed as a floating-point number, in which
|
|
|
1339 case some fractional part of a second will be used. Caveat: the usable
|
|
|
1340 timeout granularity will vary from system to system.
|
|
|
1341
|
|
|
1342 Adding a timeout causes a timeout event to be returned by `next-event', and
|
|
|
1343 the function will be invoked by `dispatch-event,' so if emacs is in a tight
|
|
|
1344 loop, the function will not be invoked until the next call to sit-for or
|
|
|
1345 until the return to top-level (the same is true of process filters).
|
|
|
1346
|
|
|
1347 If you need to have a timeout executed even when XEmacs is in the midst of
|
|
|
1348 running Lisp code, use `add-async-timeout'.
|
|
|
1349
|
|
|
1350 WARNING: if you are thinking of calling add-timeout from inside of a
|
|
|
1351 callback function as a way of resignalling a timeout, think again. There
|
|
|
1352 is a race condition. That's why the RESIGNAL argument exists.
|
|
20
|
1353 */
|
|
|
1354 (secs, function, object, resignal))
|
|
0
|
1355 {
|
|
|
1356 unsigned long msecs = lisp_number_to_milliseconds (secs, 0);
|
|
|
1357 unsigned long msecs2 = (NILP (resignal) ? 0 :
|
|
|
1358 lisp_number_to_milliseconds (resignal, 0));
|
|
|
1359 int id;
|
|
|
1360 Lisp_Object lid;
|
|
|
1361 id = event_stream_generate_wakeup (msecs, msecs2, function, object, 0);
|
|
|
1362 lid = make_int (id);
|
|
|
1363 if (id != XINT (lid)) abort ();
|
|
|
1364 return lid;
|
|
|
1365 }
|
|
|
1366
|
|
20
|
1367 DEFUN ("disable-timeout", Fdisable_timeout, 1, 1, 0, /*
|
|
0
|
1368 Disable a timeout from signalling any more.
|
|
|
1369 ID should be a timeout id number as returned by `add-timeout'. If ID
|
|
|
1370 corresponds to a one-shot timeout that has already signalled, nothing
|
|
|
1371 will happen.
|
|
|
1372
|
|
|
1373 It will not work to call this function on an id number returned by
|
|
|
1374 `add-async-timeout'. Use `disable-async-timeout' for that.
|
|
20
|
1375 */
|
|
|
1376 (id))
|
|
0
|
1377 {
|
|
|
1378 CHECK_INT (id);
|
|
|
1379 event_stream_disable_wakeup (XINT (id), 0);
|
|
|
1380 return Qnil;
|
|
|
1381 }
|
|
|
1382
|
|
20
|
1383 DEFUN ("add-async-timeout", Fadd_async_timeout, 3, 4, 0, /*
|
|
0
|
1384 Add an asynchronous timeout, to be signaled after an interval has elapsed.
|
|
|
1385 SECS is a number of seconds, expressed as an integer or a float.
|
|
|
1386 FUNCTION will be called after that many seconds have elapsed, with one
|
|
|
1387 argument, the given OBJECT. If the optional RESIGNAL argument is provided,
|
|
|
1388 then after this timeout expires, `add-async-timeout' will automatically be
|
|
|
1389 called again with RESIGNAL as the first argument.
|
|
|
1390
|
|
|
1391 This function returns an object which is the id number of this particular
|
|
|
1392 timeout. You can pass that object to `disable-async-timeout' to turn off
|
|
|
1393 the timeout before it has been signalled.
|
|
|
1394
|
|
|
1395 NOTE: Id numbers as returned by this function are in a distinct namespace
|
|
|
1396 from those returned by `add-timeout'. This means that the same id number
|
|
|
1397 could refer to a pending synchronous timeout and a different pending
|
|
|
1398 asynchronous timeout, and that you cannot pass an id from
|
|
|
1399 `add-async-timeout' to `disable-timeout', or vice-versa.
|
|
|
1400
|
|
|
1401 The number of seconds may be expressed as a floating-point number, in which
|
|
|
1402 case some fractional part of a second will be used. Caveat: the usable
|
|
|
1403 timeout granularity will vary from system to system.
|
|
|
1404
|
|
|
1405 Adding an asynchronous timeout causes the function to be invoked as soon
|
|
|
1406 as the timeout occurs, even if XEmacs is in the midst of executing some
|
|
|
1407 other code. (This is unlike the synchronous timeouts added with
|
|
|
1408 `add-timeout', where the timeout will only be signalled when XEmacs is
|
|
|
1409 waiting for events, i.e. the next return to top-level or invocation of
|
|
|
1410 `sit-for' or related functions.) This means that the function that is
|
|
|
1411 called *must* not signal an error or change any global state (e.g. switch
|
|
|
1412 buffers or windows) except when locking code is in place to make sure
|
|
|
1413 that race conditions don't occur in the interaction between the
|
|
|
1414 asynchronous timeout function and other code.
|
|
|
1415
|
|
|
1416 Under most circumstances, you should use `add-timeout' instead, as it is
|
|
|
1417 much safer. Asynchronous timeouts should only be used when such behavior
|
|
|
1418 is really necessary.
|
|
|
1419
|
|
|
1420 Asynchronous timeouts are blocked and will not occur when `inhibit-quit'
|
|
|
1421 is non-nil. As soon as `inhibit-quit' becomes nil again, any pending
|
|
|
1422 asynchronous timeouts will get called immediately. (Multiple occurrences
|
|
|
1423 of the same asynchronous timeout are not queued, however.) While the
|
|
|
1424 callback function of an asynchronous timeout is invoked, `inhibit-quit'
|
|
|
1425 is automatically bound to non-nil, and thus other asynchronous timeouts
|
|
|
1426 will be blocked unless the callback function explicitly sets `inhibit-quit'
|
|
|
1427 to nil.
|
|
|
1428
|
|
|
1429 WARNING: if you are thinking of calling `add-async-timeout' from inside of a
|
|
|
1430 callback function as a way of resignalling a timeout, think again. There
|
|
|
1431 is a race condition. That's why the RESIGNAL argument exists.
|
|
20
|
1432 */
|
|
70
|
1433 (secs, function, object, resignal))
|
|
0
|
1434 {
|
|
|
1435 unsigned long msecs = lisp_number_to_milliseconds (secs, 0);
|
|
|
1436 unsigned long msecs2 = (NILP (resignal) ? 0 :
|
|
|
1437 lisp_number_to_milliseconds (resignal, 0));
|
|
|
1438 int id;
|
|
|
1439 Lisp_Object lid;
|
|
|
1440 id = event_stream_generate_wakeup (msecs, msecs2, function, object, 1);
|
|
|
1441 lid = make_int (id);
|
|
|
1442 if (id != XINT (lid)) abort ();
|
|
|
1443 return lid;
|
|
|
1444 }
|
|
|
1445
|
|
20
|
1446 DEFUN ("disable-async-timeout", Fdisable_async_timeout, 1, 1, 0, /*
|
|
0
|
1447 Disable an asynchronous timeout from signalling any more.
|
|
|
1448 ID should be a timeout id number as returned by `add-async-timeout'. If ID
|
|
|
1449 corresponds to a one-shot timeout that has already signalled, nothing
|
|
|
1450 will happen.
|
|
|
1451
|
|
|
1452 It will not work to call this function on an id number returned by
|
|
|
1453 `add-timeout'. Use `disable-timeout' for that.
|
|
20
|
1454 */
|
|
|
1455 (id))
|
|
0
|
1456 {
|
|
|
1457 CHECK_INT (id);
|
|
|
1458 event_stream_disable_wakeup (XINT (id), 1);
|
|
|
1459 return Qnil;
|
|
|
1460 }
|
|
|
1461
|
|
|
1462
|
|
|
1463 /**********************************************************************/
|
|
|
1464 /* enqueuing and dequeuing events */
|
|
|
1465 /**********************************************************************/
|
|
|
1466
|
|
|
1467 /* Add an event to the back of the command-event queue: it will be the next
|
|
|
1468 event read after all pending events. This only works on keyboard,
|
|
|
1469 mouse-click, misc-user, and eval events.
|
|
|
1470 */
|
|
|
1471 void
|
|
|
1472 enqueue_command_event (Lisp_Object event)
|
|
|
1473 {
|
|
|
1474 enqueue_event (event, &command_event_queue, &command_event_queue_tail);
|
|
|
1475 }
|
|
|
1476
|
|
|
1477 Lisp_Object
|
|
|
1478 dequeue_command_event (void)
|
|
|
1479 {
|
|
|
1480 return dequeue_event (&command_event_queue, &command_event_queue_tail);
|
|
|
1481 }
|
|
|
1482
|
|
|
1483 /* put the event on the typeahead queue, unless
|
|
|
1484 the event is the quit char, in which case the `QUIT'
|
|
|
1485 which will occur on the next trip through this loop is
|
|
|
1486 all the processing we should do - leaving it on the queue
|
|
|
1487 would cause the quit to be processed twice.
|
|
|
1488 */
|
|
|
1489 static void
|
|
|
1490 enqueue_command_event_1 (Lisp_Object event_to_copy)
|
|
|
1491 {
|
|
|
1492 /* do not call check_quit() here. Vquit_flag was set in
|
|
|
1493 next_event_internal. */
|
|
|
1494 if (NILP (Vquit_flag))
|
|
|
1495 enqueue_command_event (Fcopy_event (event_to_copy, Qnil));
|
|
|
1496 }
|
|
|
1497
|
|
|
1498 void
|
|
|
1499 enqueue_magic_eval_event (void (*fun) (Lisp_Object), Lisp_Object object)
|
|
|
1500 {
|
|
|
1501 Lisp_Object event;
|
|
|
1502
|
|
|
1503 event = Fmake_event ();
|
|
|
1504
|
|
|
1505 XEVENT (event)->event_type = magic_eval_event;
|
|
|
1506 /* channel for magic_eval events is nil */
|
|
|
1507 XEVENT (event)->event.magic_eval.internal_function = fun;
|
|
|
1508 XEVENT (event)->event.magic_eval.object = object;
|
|
|
1509 enqueue_command_event (event);
|
|
|
1510 }
|
|
|
1511
|
|
20
|
1512 DEFUN ("enqueue-eval-event", Fenqueue_eval_event, 2, 2, 0, /*
|
|
0
|
1513 Add an eval event to the back of the eval event queue.
|
|
|
1514 When this event is dispatched, FUNCTION (which should be a function
|
|
|
1515 of one argument) will be called with OBJECT as its argument.
|
|
|
1516 See `next-event' for a description of event types and how events
|
|
|
1517 are received.
|
|
20
|
1518 */
|
|
|
1519 (function, object))
|
|
0
|
1520 {
|
|
|
1521 Lisp_Object event;
|
|
|
1522
|
|
|
1523 event = Fmake_event ();
|
|
|
1524
|
|
|
1525 XEVENT (event)->event_type = eval_event;
|
|
|
1526 /* channel for eval events is nil */
|
|
|
1527 XEVENT (event)->event.eval.function = function;
|
|
|
1528 XEVENT (event)->event.eval.object = object;
|
|
|
1529 enqueue_command_event (event);
|
|
|
1530
|
|
|
1531 return event;
|
|
|
1532 }
|
|
|
1533
|
|
|
1534 Lisp_Object
|
|
|
1535 enqueue_misc_user_event (Lisp_Object channel, Lisp_Object function,
|
|
|
1536 Lisp_Object object)
|
|
|
1537 {
|
|
|
1538 Lisp_Object event;
|
|
|
1539
|
|
|
1540 event = Fmake_event ();
|
|
|
1541
|
|
|
1542 XEVENT (event)->event_type = misc_user_event;
|
|
|
1543 XEVENT (event)->channel = channel;
|
|
|
1544 XEVENT (event)->event.eval.function = function;
|
|
|
1545 XEVENT (event)->event.eval.object = object;
|
|
|
1546 enqueue_command_event (event);
|
|
|
1547
|
|
|
1548 return event;
|
|
|
1549 }
|
|
|
1550
|
|
|
1551
|
|
|
1552 /**********************************************************************/
|
|
|
1553 /* focus-event handling */
|
|
|
1554 /**********************************************************************/
|
|
|
1555
|
|
|
1556 /*
|
|
|
1557
|
|
|
1558 Ben's capsule lecture on focus:
|
|
|
1559
|
|
|
1560 In FSFmacs `select-frame' never changes the window-manager frame
|
|
|
1561 focus. All it does is change the "selected frame". This is similar
|
|
|
1562 to what happens when we call `select-device' or `select-console'.
|
|
|
1563 Whenever an event comes in (including a keyboard event), its frame is
|
|
|
1564 selected; therefore, evaluating `select-frame' in *scratch* won't
|
|
|
1565 cause any effects because the next received event (in the same frame)
|
|
|
1566 will cause a switch back to the frame displaying *scratch*.
|
|
|
1567
|
|
|
1568 Whenever a focus-change event is received from the window manager, it
|
|
|
1569 generates a `switch-frame' event, which causes the Lisp function
|
|
|
1570 `handle-switch-frame' to get run. This basically just runs
|
|
|
1571 `select-frame' (see below, however).
|
|
|
1572
|
|
|
1573 In FSFmacs, if you want to have an operation run when a frame is
|
|
|
1574 selected, you supply an event binding for `switch-frame' (and then
|
|
|
1575 maybe call `handle-switch-frame', or something ...).
|
|
|
1576
|
|
|
1577 In XEmacs, we *do* change the window-manager frame focus as a result
|
|
|
1578 of `select-frame', but not until the next time an event is received,
|
|
|
1579 so that a function that momentarily changes the selected frame won't
|
|
|
1580 cause WM focus flashing. (#### There's something not quite right here;
|
|
|
1581 this is causing the wrong-cursor-focus problems that you occasionally
|
|
|
1582 see. But the general idea is correct.) This approach is winning for
|
|
|
1583 people who use the explicit-focus model, but is trickier to implement.
|
|
|
1584
|
|
|
1585 We also don't make the `switch-frame' event visible but instead have
|
|
|
1586 `select-frame-hook', which is a better approach.
|
|
|
1587
|
|
|
1588 There is the problem of surrogate minibuffers, where when we enter the
|
|
|
1589 minibuffer, you essentially want to temporarily switch the WM focus to
|
|
|
1590 the frame with the minibuffer, and switch it back when you exit the
|
|
|
1591 minibuffer.
|
|
|
1592
|
|
|
1593 FSFmacs solves this with the crockish `redirect-frame-focus', which
|
|
|
1594 says "for keyboard events received from FRAME, act like they're
|
|
|
1595 coming from FOCUS-FRAME". I think what this means is that, when
|
|
|
1596 a keyboard event comes in and the event manager is about to select the
|
|
|
1597 event's frame, if that frame has its focus redirected, the redirected-to
|
|
|
1598 frame is selected instead. That way, if you're in a minibufferless
|
|
|
1599 frame and enter the minibuffer, then all Lisp functions that run see
|
|
|
1600 the selected frame as the minibuffer's frame rather than the minibufferless
|
|
|
1601 frame you came from, so that (e.g.) your typing actually appears in
|
|
|
1602 the minibuffer's frame and things behave sanely.
|
|
|
1603
|
|
|
1604 There's also some weird logic that switches the redirected frame focus
|
|
|
1605 from one frame to another if Lisp code explicitly calls `select-frame'
|
|
|
1606 \(but not if `handle-switch-frame' is called), and saves and restores
|
|
|
1607 the frame focus in window configurations, etc. etc. All of this logic
|
|
|
1608 is heavily #if 0'd, with lots of comments saying "No, this approach
|
|
|
1609 doesn't seem to work, so I'm trying this ... is it reasonable?
|
|
|
1610 Well, I'm not sure ..." that are a red flag indicating crockishness.
|
|
|
1611
|
|
|
1612 Because of our way of doing things, we can avoid all this crock.
|
|
|
1613 Keyboard events never cause a select-frame (who cares what frame
|
|
|
1614 they're associated with? They come from a console, only). We change
|
|
|
1615 the actual WM focus to a surrogate minibuffer frame, so we don't have
|
|
|
1616 to do any internal redirection. In order to get the focus back,
|
|
|
1617 I took the approach in minibuf.el of just checking to see if the
|
|
|
1618 frame we moved to is still the selected frame, and move back to the
|
|
|
1619 old one if so. Conceivably we might have to do the weird "tracking"
|
|
|
1620 that FSFmacs does when `select-frame' is called, but I don't think
|
|
|
1621 so. If the selected frame moved from the minibuffer frame, then
|
|
|
1622 we just leave it there, figuring that someone knows what they're
|
|
|
1623 doing. Because we don't have any redirection recorded anywhere,
|
|
|
1624 it's safe to do this, and we don't end up with unwanted redirection.
|
|
|
1625
|
|
|
1626 */
|
|
|
1627
|
|
|
1628 static void
|
|
|
1629 run_select_frame_hook (void)
|
|
|
1630 {
|
|
|
1631 run_hook (Qselect_frame_hook);
|
|
|
1632 }
|
|
|
1633
|
|
|
1634 static void
|
|
|
1635 run_deselect_frame_hook (void)
|
|
|
1636 {
|
|
|
1637 #if 0 /* unclean! FSF calls this at all sorts of random places,
|
|
|
1638 including a bunch of places in their mouse.el. If this
|
|
|
1639 is implemented, it has to be done cleanly. */
|
|
|
1640 run_hook (Qmouse_leave_buffer_hook); /* #### Correct? It's also
|
|
|
1641 called in `call-interactively'.
|
|
|
1642 Does this mean it will be
|
|
|
1643 called twice? Oh well, FSF
|
|
|
1644 bug -- FSF calls it in
|
|
|
1645 `handle-switch-frame',
|
|
|
1646 which is approximately the
|
|
|
1647 same as the caller of this
|
|
|
1648 function. */
|
|
|
1649 #endif
|
|
|
1650 run_hook (Qdeselect_frame_hook);
|
|
|
1651 }
|
|
|
1652
|
|
|
1653 /* When select-frame is called, we want to tell the window system that
|
|
|
1654 the focus should be changed to point to the new frame. However,
|
|
|
1655 sometimes Lisp functions will temporarily change the selected frame
|
|
|
1656 (e.g. to call a function that operates on the selected frame),
|
|
|
1657 and it's annoying if this focus-change happens exactly when
|
|
|
1658 select-frame is called, because then you get some flickering of the
|
|
|
1659 window-manager border and perhaps other undesirable results. We
|
|
|
1660 really only want to change the focus when we're about to retrieve
|
|
|
1661 an event from the user. To do this, we keep track of the frame
|
|
|
1662 where the window-manager focus lies on, and just before waiting
|
|
|
1663 for user events, check the currently selected frame and change
|
|
|
1664 the focus as necessary. */
|
|
|
1665
|
|
|
1666 static void
|
|
|
1667 investigate_frame_change (void)
|
|
|
1668 {
|
|
|
1669 Lisp_Object devcons, concons;
|
|
|
1670
|
|
|
1671 /* if the selected frame was changed, change the window-system
|
|
|
1672 focus to the new frame. We don't do it when select-frame was
|
|
|
1673 called, to avoid flickering and other unwanted side effects when
|
|
|
1674 the frame is just changed temporarily. */
|
|
|
1675 DEVICE_LOOP_NO_BREAK (devcons, concons)
|
|
|
1676 {
|
|
|
1677 struct device *d = XDEVICE (XCAR (devcons));
|
|
|
1678 Lisp_Object sel_frame = DEVICE_SELECTED_FRAME (d);
|
|
|
1679
|
|
|
1680 /* You'd think that maybe we should use FRAME_WITH_FOCUS_REAL,
|
|
98
|
1681 but that can cause us to end up in an infinite loop focusing
|
|
0
|
1682 between two frames. It seems that since the call to `select-frame'
|
|
|
1683 in emacs_handle_focus_change_final() is based on the _FOR_HOOKS
|
|
|
1684 value, we need to do so too. */
|
|
|
1685 if (!NILP (sel_frame) &&
|
|
72
|
1686 !focus_follows_mouse &&
|
|
0
|
1687 !EQ (DEVICE_FRAME_THAT_OUGHT_TO_HAVE_FOCUS (d), sel_frame) &&
|
|
|
1688 !NILP (DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d)) &&
|
|
|
1689 !EQ (DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d), sel_frame))
|
|
|
1690 {
|
|
|
1691 /* prevent us from issuing the same request more than once */
|
|
|
1692 DEVICE_FRAME_THAT_OUGHT_TO_HAVE_FOCUS (d) = sel_frame;
|
|
|
1693 MAYBE_DEVMETH (d, focus_on_frame, (XFRAME (sel_frame)));
|
|
|
1694 }
|
|
|
1695 }
|
|
|
1696 }
|
|
|
1697
|
|
|
1698 static Lisp_Object
|
|
|
1699 cleanup_after_missed_defocusing (Lisp_Object frame)
|
|
|
1700 {
|
|
|
1701 if (FRAMEP (frame) && FRAME_LIVE_P (XFRAME (frame)))
|
|
|
1702 Fselect_frame (frame);
|
|
|
1703 return Qnil;
|
|
|
1704 }
|
|
|
1705
|
|
|
1706 void
|
|
|
1707 emacs_handle_focus_change_preliminary (Lisp_Object frame_inp_and_dev)
|
|
|
1708 {
|
|
|
1709 Lisp_Object frame = Fcar (frame_inp_and_dev);
|
|
|
1710 Lisp_Object device = Fcar (Fcdr (frame_inp_and_dev));
|
|
|
1711 int in_p = !NILP (Fcdr (Fcdr (frame_inp_and_dev)));
|
|
|
1712 struct device *d;
|
|
|
1713
|
|
|
1714 if (!DEVICE_LIVE_P (XDEVICE (device)))
|
|
|
1715 return;
|
|
|
1716 else
|
|
|
1717 d = XDEVICE (device);
|
|
|
1718
|
|
|
1719 /* Any received focus-change notifications render invalid any
|
|
|
1720 pending focus-change requests. */
|
|
|
1721 DEVICE_FRAME_THAT_OUGHT_TO_HAVE_FOCUS (d) = Qnil;
|
|
|
1722 if (in_p)
|
|
|
1723 {
|
|
|
1724 Lisp_Object focus_frame;
|
|
|
1725
|
|
|
1726 if (!FRAME_LIVE_P (XFRAME (frame)))
|
|
|
1727 return;
|
|
|
1728 else
|
|
|
1729 focus_frame = DEVICE_FRAME_WITH_FOCUS_REAL (d);
|
|
|
1730
|
|
|
1731 /* Mark the minibuffer as changed to make sure it gets updated
|
|
|
1732 properly if the echo area is active. */
|
|
|
1733 MARK_WINDOWS_CHANGED (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
|
|
|
1734
|
|
|
1735 if (FRAMEP (focus_frame) && !EQ (frame, focus_frame))
|
|
|
1736 {
|
|
|
1737 /* Oops, we missed a focus-out event. */
|
|
|
1738 DEVICE_FRAME_WITH_FOCUS_REAL (d) = Qnil;
|
|
|
1739 redisplay_redraw_cursor (XFRAME (focus_frame), 1);
|
|
|
1740 }
|
|
|
1741 DEVICE_FRAME_WITH_FOCUS_REAL (d) = frame;
|
|
|
1742 if (!EQ (frame, focus_frame))
|
|
|
1743 {
|
|
|
1744 redisplay_redraw_cursor (XFRAME (frame), 1);
|
|
|
1745 }
|
|
|
1746 }
|
|
|
1747 else
|
|
|
1748 {
|
|
|
1749 /* We ignore the frame reported in the event. If it's different
|
|
|
1750 from where we think the focus was, oh well -- we messed up.
|
|
|
1751 Nonetheless, we pretend we were right, for sensible behavior. */
|
|
|
1752 frame = DEVICE_FRAME_WITH_FOCUS_REAL (d);
|
|
|
1753 if (!NILP (frame))
|
|
|
1754 {
|
|
|
1755 DEVICE_FRAME_WITH_FOCUS_REAL (d) = Qnil;
|
|
|
1756
|
|
|
1757 if (FRAME_LIVE_P (XFRAME (frame)))
|
|
|
1758 redisplay_redraw_cursor (XFRAME (frame), 1);
|
|
|
1759 }
|
|
|
1760 }
|
|
|
1761 }
|
|
|
1762
|
|
|
1763 /* Called from the window-system-specific code when we receive a
|
|
|
1764 notification that the focus lies on a particular frame.
|
|
|
1765 Argument is a cons: (frame . (device . in-p)) where in-p is non-nil
|
|
|
1766 for focus-in.
|
|
|
1767 */
|
|
|
1768 void
|
|
|
1769 emacs_handle_focus_change_final (Lisp_Object frame_inp_and_dev)
|
|
|
1770 {
|
|
|
1771 Lisp_Object frame = Fcar (frame_inp_and_dev);
|
|
|
1772 Lisp_Object device = Fcar (Fcdr (frame_inp_and_dev));
|
|
|
1773 int in_p = !NILP (Fcdr (Fcdr (frame_inp_and_dev)));
|
|
|
1774 struct device *d;
|
|
|
1775 int count;
|
|
|
1776
|
|
|
1777 if (!DEVICE_LIVE_P (XDEVICE (device)))
|
|
|
1778 return;
|
|
|
1779 else
|
|
|
1780 d = XDEVICE (device);
|
|
|
1781
|
|
|
1782 if (in_p)
|
|
|
1783 {
|
|
|
1784 Lisp_Object focus_frame;
|
|
|
1785
|
|
|
1786 if (!FRAME_LIVE_P (XFRAME (frame)))
|
|
|
1787 return;
|
|
|
1788 else
|
|
|
1789 focus_frame = DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d);
|
|
|
1790
|
|
|
1791 DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d) = frame;
|
|
|
1792 if (FRAMEP (focus_frame) && !EQ (frame, focus_frame))
|
|
|
1793 {
|
|
|
1794 /* Oops, we missed a focus-out event. */
|
|
|
1795 Fselect_frame (focus_frame);
|
|
|
1796 /* Do an unwind-protect in case an error occurs in
|
|
|
1797 the deselect-frame-hook */
|
|
|
1798 count = specpdl_depth ();
|
|
|
1799 record_unwind_protect (cleanup_after_missed_defocusing, frame);
|
|
|
1800 run_deselect_frame_hook ();
|
|
|
1801 unbind_to (count, Qnil);
|
|
|
1802 /* the cleanup method changed the focus frame to nil, so
|
|
|
1803 we need to reflect this */
|
|
|
1804 focus_frame = Qnil;
|
|
|
1805 }
|
|
|
1806 else
|
|
|
1807 Fselect_frame (frame);
|
|
|
1808 if (!EQ (frame, focus_frame))
|
|
|
1809 run_select_frame_hook ();
|
|
|
1810 }
|
|
|
1811 else
|
|
|
1812 {
|
|
|
1813 /* We ignore the frame reported in the event. If it's different
|
|
|
1814 from where we think the focus was, oh well -- we messed up.
|
|
|
1815 Nonetheless, we pretend we were right, for sensible behavior. */
|
|
|
1816 frame = DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d);
|
|
|
1817 if (!NILP (frame))
|
|
|
1818 {
|
|
|
1819 DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d) = Qnil;
|
|
|
1820 run_deselect_frame_hook ();
|
|
|
1821 }
|
|
|
1822 }
|
|
|
1823 }
|
|
|
1824
|
|
|
1825
|
|
|
1826 /**********************************************************************/
|
|
|
1827 /* retrieving the next event */
|
|
|
1828 /**********************************************************************/
|
|
|
1829
|
|
|
1830 static int in_single_console;
|
|
|
1831
|
|
|
1832 /* #### These functions don't currently do anything. */
|
|
|
1833 void
|
|
|
1834 single_console_state (void)
|
|
|
1835 {
|
|
|
1836 in_single_console = 1;
|
|
|
1837 }
|
|
|
1838
|
|
|
1839 void
|
|
|
1840 any_console_state (void)
|
|
|
1841 {
|
|
|
1842 in_single_console = 0;
|
|
|
1843 }
|
|
|
1844
|
|
|
1845 int
|
|
|
1846 in_single_console_state (void)
|
|
|
1847 {
|
|
|
1848 return in_single_console;
|
|
|
1849 }
|
|
|
1850
|
|
|
1851 /* the number of keyboard characters read. callint.c wants this.
|
|
|
1852 */
|
|
|
1853 Charcount num_input_chars;
|
|
|
1854
|
|
|
1855 static void
|
|
108
|
1856 next_event_internal (Lisp_Object target_event, int allow_queued)
|
|
0
|
1857 {
|
|
|
1858 struct gcpro gcpro1;
|
|
|
1859 /* QUIT; This is incorrect - the caller must do this because some
|
|
|
1860 callers (ie, Fnext_event()) do not want to QUIT. */
|
|
|
1861
|
|
|
1862 assert (NILP (XEVENT_NEXT (target_event)));
|
|
|
1863
|
|
|
1864 GCPRO1 (target_event);
|
|
|
1865 investigate_frame_change ();
|
|
|
1866
|
|
|
1867 if (allow_queued && !NILP (command_event_queue))
|
|
|
1868 {
|
|
|
1869 Lisp_Object event = dequeue_command_event ();
|
|
|
1870 Fcopy_event (event, target_event);
|
|
|
1871 Fdeallocate_event (event);
|
|
|
1872 #ifdef DEBUG_XEMACS
|
|
|
1873 if (debug_emacs_events)
|
|
|
1874 {
|
|
|
1875 write_c_string ("(command event queue) ",
|
|
|
1876 Qexternal_debugging_output);
|
|
|
1877 print_internal (target_event, Qexternal_debugging_output, 1);
|
|
|
1878 write_c_string ("\n", Qexternal_debugging_output);
|
|
|
1879 }
|
|
|
1880 #endif
|
|
|
1881 }
|
|
|
1882 else
|
|
|
1883 {
|
|
|
1884 struct Lisp_Event *e = XEVENT (target_event);
|
|
|
1885
|
|
|
1886 /* The command_event_queue was empty. Wait for an event. */
|
|
|
1887 event_stream_next_event (e);
|
|
|
1888 /* If this was a timeout, then we need to extract some data
|
|
|
1889 out of the returned closure and might need to resignal
|
|
|
1890 it. */
|
|
|
1891 if (e->event_type == timeout_event)
|
|
|
1892 {
|
|
|
1893 Lisp_Object tristan, isolde;
|
|
|
1894
|
|
|
1895 e->event.timeout.id_number =
|
|
|
1896 event_stream_resignal_wakeup (e->event.timeout.interval_id, 0,
|
|
|
1897 &tristan, &isolde);
|
|
|
1898
|
|
|
1899 e->event.timeout.function = tristan;
|
|
|
1900 e->event.timeout.object = isolde;
|
|
|
1901 #ifdef DEBUG_XEMACS
|
|
|
1902 /* next_event_internal() doesn't print out timeout events
|
|
|
1903 because of the extra info we just set. */
|
|
|
1904 if (debug_emacs_events)
|
|
|
1905 {
|
|
|
1906 print_internal (target_event, Qexternal_debugging_output, 1);
|
|
|
1907 write_c_string ("\n", Qexternal_debugging_output);
|
|
|
1908 }
|
|
|
1909 #endif
|
|
|
1910 }
|
|
|
1911
|
|
|
1912 /* If we read a ^G, then set quit-flag but do not discard the ^G.
|
|
|
1913 The callers of next_event_internal() will do one of two things:
|
|
|
1914
|
|
|
1915 -- set Vquit_flag to Qnil. (next-event does this.) This will
|
|
|
1916 cause the ^G to be treated as a normal keystroke.
|
|
|
1917 -- not change Vquit_flag but attempt to enqueue the ^G, at
|
|
|
1918 which point it will be discarded. The next time QUIT is
|
|
|
1919 called, it will notice that Vquit_flag was set.
|
|
|
1920
|
|
|
1921 */
|
|
|
1922 if (e->event_type == key_press_event &&
|
|
|
1923 event_matches_key_specifier_p
|
|
|
1924 (e, make_char (CONSOLE_QUIT_CHAR (XCONSOLE (EVENT_CHANNEL (e))))))
|
|
|
1925 {
|
|
|
1926 Vquit_flag = Qt;
|
|
|
1927 }
|
|
|
1928 }
|
|
|
1929
|
|
|
1930 UNGCPRO;
|
|
|
1931 }
|
|
|
1932
|
|
|
1933 static void
|
|
|
1934 run_pre_idle_hook (void)
|
|
|
1935 {
|
|
|
1936 if (!NILP (Vpre_idle_hook)
|
|
|
1937 && !detect_input_pending ())
|
|
|
1938 safe_run_hook_trapping_errors
|
|
|
1939 ("Error in `pre-idle-hook' (setting hook to nil)",
|
|
|
1940 Qpre_idle_hook, 1);
|
|
|
1941 }
|
|
|
1942
|
|
|
1943 static void push_this_command_keys (Lisp_Object event);
|
|
|
1944 static void push_recent_keys (Lisp_Object event);
|
|
|
1945 static void dribble_out_event (Lisp_Object event);
|
|
|
1946 static void execute_internal_event (Lisp_Object event);
|
|
|
1947
|
|
20
|
1948 DEFUN ("next-event", Fnext_event, 0, 2, 0, /*
|
|
0
|
1949 Return the next available event.
|
|
|
1950 Pass this object to `dispatch-event' to handle it.
|
|
|
1951 In most cases, you will want to use `next-command-event', which returns
|
|
|
1952 the next available \"user\" event (i.e. keypress, button-press,
|
|
|
1953 button-release, or menu selection) instead of this function.
|
|
|
1954
|
|
|
1955 If EVENT is non-nil, it should be an event object and will be filled in
|
|
|
1956 and returned; otherwise a new event object will be created and returned.
|
|
|
1957 If PROMPT is non-nil, it should be a string and will be displayed in the
|
|
|
1958 echo area while this function is waiting for an event.
|
|
|
1959
|
|
|
1960 The next available event will be
|
|
|
1961
|
|
|
1962 -- any events in `unread-command-events' or `unread-command-event'; else
|
|
|
1963 -- the next event in the currently executing keyboard macro, if any; else
|
|
|
1964 -- an event queued by `enqueue-eval-event', if any; else
|
|
|
1965 -- the next available event from the window system or terminal driver.
|
|
|
1966
|
|
|
1967 In the last case, this function will block until an event is available.
|
|
|
1968
|
|
|
1969 The returned event will be one of the following types:
|
|
|
1970
|
|
|
1971 -- a key-press event.
|
|
|
1972 -- a button-press or button-release event.
|
|
|
1973 -- a misc-user-event, meaning the user selected an item on a menu or used
|
|
|
1974 the scrollbar.
|
|
|
1975 -- a process event, meaning that output from a subprocess is available.
|
|
|
1976 -- a timeout event, meaning that a timeout has elapsed.
|
|
|
1977 -- an eval event, which simply causes a function to be executed when the
|
|
|
1978 event is dispatched. Eval events are generated by `enqueue-eval-event'
|
|
|
1979 or by certain other conditions happening.
|
|
|
1980 -- a magic event, indicating that some window-system-specific event
|
|
|
1981 happened (such as an focus-change notification) that must be handled
|
|
|
1982 synchronously with other events. `dispatch-event' knows what to do with
|
|
|
1983 these events.
|
|
20
|
1984 */
|
|
|
1985 (event, prompt))
|
|
0
|
1986 {
|
|
116
|
1987 /* This function can call lisp */
|
|
0
|
1988 /* #### We start out using the selected console before an event
|
|
|
1989 is received, for echoing the partially completed command.
|
|
|
1990 This is most definitely wrong -- there needs to be a separate
|
|
|
1991 echo area for each console! */
|
|
|
1992 struct console *con = XCONSOLE (Vselected_console);
|
|
|
1993 struct command_builder *command_builder =
|
|
|
1994 XCOMMAND_BUILDER (con->command_builder);
|
|
|
1995 int store_this_key = 0;
|
|
|
1996 struct gcpro gcpro1;
|
|
138
|
1997 #ifdef LWLIB_MENUBARS_LUCID
|
|
|
1998 extern int in_menu_callback; /* defined in menubar-x.c */
|
|
|
1999 #endif /* LWLIB_MENUBARS_LUCID */
|
|
|
2000
|
|
0
|
2001 GCPRO1 (event);
|
|
|
2002 /* DO NOT do QUIT anywhere within this function or the functions it calls.
|
|
|
2003 We want to read the ^G as an event. */
|
|
|
2004
|
|
138
|
2005 #ifdef LWLIB_MENUBARS_LUCID
|
|
|
2006 /*
|
|
|
2007 * #### Fix the menu code so this isn't necessary.
|
|
|
2008 *
|
|
|
2009 * We cannot allow the lwmenu code to be reentered, because the
|
|
|
2010 * code is not written to be reentrant and will crash. Therefore
|
|
|
2011 * paths from the menu callbacks back into the menu code have to
|
|
|
2012 * be blocked. Fnext_event is the normal path into the menu code,
|
|
|
2013 * so we signal an error here.
|
|
|
2014 */
|
|
|
2015 if (in_menu_callback)
|
|
|
2016 error ("Attempt to call next-event inside menu callback");
|
|
|
2017 #endif /* LWLIB_MENUBARS_LUCID */
|
|
|
2018
|
|
0
|
2019 if (NILP (event))
|
|
|
2020 event = Fmake_event ();
|
|
|
2021 else
|
|
|
2022 CHECK_LIVE_EVENT (event);
|
|
|
2023
|
|
|
2024 if (!NILP (prompt))
|
|
|
2025 {
|
|
|
2026 Bytecount len;
|
|
|
2027 CHECK_STRING (prompt);
|
|
|
2028
|
|
14
|
2029 len = XSTRING_LENGTH (prompt);
|
|
0
|
2030 if (command_builder->echo_buf_length < len)
|
|
|
2031 len = command_builder->echo_buf_length - 1;
|
|
14
|
2032 memcpy (command_builder->echo_buf, XSTRING_DATA (prompt), len);
|
|
0
|
2033 command_builder->echo_buf[len] = 0;
|
|
|
2034 command_builder->echo_buf_index = len;
|
|
|
2035 echo_area_message (XFRAME (CONSOLE_SELECTED_FRAME (con)),
|
|
|
2036 command_builder->echo_buf,
|
|
|
2037 Qnil, 0,
|
|
|
2038 command_builder->echo_buf_index,
|
|
|
2039 Qcommand);
|
|
|
2040 }
|
|
|
2041
|
|
|
2042 start_over_and_avoid_hosage:
|
|
|
2043
|
|
|
2044 /* If there is something in unread-command-events, simply return it.
|
|
|
2045 But do some error checking to make sure the user hasn't put something
|
|
|
2046 in the unread-command-events that they shouldn't have.
|
|
|
2047 This does not update this-command-keys and recent-keys.
|
|
|
2048 */
|
|
|
2049 if (!NILP (Vunread_command_events))
|
|
|
2050 {
|
|
|
2051 if (!CONSP (Vunread_command_events))
|
|
|
2052 {
|
|
|
2053 Vunread_command_events = Qnil;
|
|
|
2054 signal_error (Qwrong_type_argument,
|
|
|
2055 list3 (Qconsp, Vunread_command_events,
|
|
|
2056 Qunread_command_events));
|
|
|
2057 }
|
|
|
2058 else
|
|
|
2059 {
|
|
|
2060 Lisp_Object e = XCAR (Vunread_command_events);
|
|
|
2061 Vunread_command_events = XCDR (Vunread_command_events);
|
|
|
2062 if (!EVENTP (e) || !command_event_p (e))
|
|
|
2063 signal_error (Qwrong_type_argument,
|
|
|
2064 list3 (Qcommand_event_p, e, Qunread_command_events));
|
|
|
2065 redisplay ();
|
|
|
2066 if (!EQ (e, event))
|
|
|
2067 Fcopy_event (e, event);
|
|
|
2068 #ifdef DEBUG_XEMACS
|
|
|
2069 if (debug_emacs_events)
|
|
|
2070 {
|
|
|
2071 write_c_string ("(unread-command-events) ",
|
|
|
2072 Qexternal_debugging_output);
|
|
|
2073 print_internal (event, Qexternal_debugging_output, 1);
|
|
|
2074 write_c_string ("\n", Qexternal_debugging_output);
|
|
|
2075 }
|
|
|
2076 #endif
|
|
|
2077 }
|
|
|
2078 }
|
|
|
2079
|
|
|
2080 /* Do similar for unread-command-event (obsoleteness support).
|
|
|
2081 */
|
|
|
2082 else if (!NILP (Vunread_command_event))
|
|
|
2083 {
|
|
|
2084 Lisp_Object e = Vunread_command_event;
|
|
|
2085 Vunread_command_event = Qnil;
|
|
|
2086
|
|
|
2087 if (!EVENTP (e) || !command_event_p (e))
|
|
|
2088 {
|
|
|
2089 signal_error (Qwrong_type_argument,
|
|
|
2090 list3 (Qeventp, e, Qunread_command_event));
|
|
|
2091 }
|
|
|
2092 if (!EQ (e, event))
|
|
|
2093 Fcopy_event (e, event);
|
|
|
2094 redisplay ();
|
|
|
2095 #ifdef DEBUG_XEMACS
|
|
|
2096 if (debug_emacs_events)
|
|
|
2097 {
|
|
|
2098 write_c_string ("(unread-command-event) ",
|
|
|
2099 Qexternal_debugging_output);
|
|
|
2100 print_internal (event, Qexternal_debugging_output, 1);
|
|
|
2101 write_c_string ("\n", Qexternal_debugging_output);
|
|
|
2102 }
|
|
|
2103 #endif
|
|
|
2104 }
|
|
|
2105
|
|
|
2106 /* If we're executing a keyboard macro, take the next event from that,
|
|
|
2107 and update this-command-keys and recent-keys.
|
|
|
2108 Note that the unread-command-events take precedence over kbd macros.
|
|
|
2109 */
|
|
|
2110 else
|
|
|
2111 {
|
|
|
2112 if (!NILP (Vexecuting_macro))
|
|
|
2113 {
|
|
|
2114 redisplay ();
|
|
|
2115 pop_kbd_macro_event (event); /* This throws past us at
|
|
|
2116 end-of-macro. */
|
|
|
2117 store_this_key = 1;
|
|
|
2118 #ifdef DEBUG_XEMACS
|
|
|
2119 if (debug_emacs_events)
|
|
|
2120 {
|
|
|
2121 write_c_string ("(keyboard macro) ",
|
|
|
2122 Qexternal_debugging_output);
|
|
|
2123 print_internal (event, Qexternal_debugging_output, 1);
|
|
|
2124 write_c_string ("\n", Qexternal_debugging_output);
|
|
|
2125 }
|
|
|
2126 #endif
|
|
|
2127 }
|
|
|
2128 /* Otherwise, read a real event, possibly from the
|
|
|
2129 command_event_queue, and update this-command-keys and
|
|
|
2130 recent-keys. */
|
|
|
2131 else
|
|
|
2132 {
|
|
|
2133 run_pre_idle_hook ();
|
|
|
2134 redisplay ();
|
|
108
|
2135 next_event_internal (event, 1);
|
|
0
|
2136 Vquit_flag = Qnil; /* Read C-g as an event. */
|
|
|
2137 store_this_key = 1;
|
|
|
2138 }
|
|
|
2139 }
|
|
|
2140
|
|
|
2141 status_notify (); /* Notice process change */
|
|
|
2142
|
|
|
2143 #ifdef C_ALLOCA
|
|
|
2144 alloca (0); /* Cause a garbage collection now */
|
|
|
2145 /* Since we can free the most stuff here
|
|
|
2146 * (since this is typically called from
|
|
|
2147 * the command-loop top-level). */
|
|
|
2148 #endif /* C_ALLOCA */
|
|
|
2149
|
|
|
2150 if (object_dead_p (XEVENT (event)->channel))
|
|
|
2151 /* event_console_or_selected may crash if the channel is dead.
|
|
|
2152 Best just to eat it and get the next event. */
|
|
|
2153 goto start_over_and_avoid_hosage;
|
|
|
2154
|
|
|
2155 /* OK, now we can stop the selected-console kludge and use the
|
|
|
2156 actual console from the event. */
|
|
|
2157 con = event_console_or_selected (event);
|
|
|
2158 command_builder = XCOMMAND_BUILDER (con->command_builder);
|
|
|
2159
|
|
|
2160 switch (XEVENT_TYPE (event))
|
|
|
2161 {
|
|
|
2162 default:
|
|
|
2163 goto RETURN;
|
|
|
2164 case button_release_event:
|
|
|
2165 case misc_user_event:
|
|
|
2166 goto EXECUTE_KEY;
|
|
|
2167 case button_press_event: /* key or mouse input can trigger prompting */
|
|
|
2168 goto STORE_AND_EXECUTE_KEY;
|
|
|
2169 case key_press_event: /* any key input can trigger autosave */
|
|
|
2170 break;
|
|
|
2171 }
|
|
|
2172
|
|
|
2173 maybe_do_auto_save ();
|
|
|
2174 num_input_chars++;
|
|
|
2175 STORE_AND_EXECUTE_KEY:
|
|
|
2176 if (store_this_key)
|
|
|
2177 {
|
|
|
2178 echo_key_event (command_builder, event);
|
|
|
2179 }
|
|
|
2180
|
|
|
2181 EXECUTE_KEY:
|
|
|
2182 /* Store the last-input-event. The semantics of this is that it is
|
|
|
2183 the thing most recently returned by next-command-event. It need
|
|
|
2184 not have come from the keyboard or a keyboard macro, it may have
|
|
|
2185 come from unread-command-events. It's always a command-event (a
|
|
|
2186 key, click, or menu selection), never a motion or process event.
|
|
|
2187 */
|
|
|
2188 if (!EVENTP (Vlast_input_event))
|
|
|
2189 Vlast_input_event = Fmake_event ();
|
|
|
2190 if (XEVENT_TYPE (Vlast_input_event) == dead_event)
|
|
|
2191 {
|
|
|
2192 Vlast_input_event = Fmake_event ();
|
|
|
2193 error ("Someone deallocated last-input-event!");
|
|
|
2194 }
|
|
|
2195 if (! EQ (event, Vlast_input_event))
|
|
|
2196 Fcopy_event (event, Vlast_input_event);
|
|
|
2197
|
|
|
2198 /* last-input-char and last-input-time are derived from
|
|
|
2199 last-input-event.
|
|
|
2200 Note that last-input-char will never have its high-bit set, in an
|
|
|
2201 effort to sidestep the ambiguity between M-x and oslash.
|
|
|
2202 */
|
|
|
2203 Vlast_input_char = Fevent_to_character (Vlast_input_event,
|
|
|
2204 Qnil, Qnil, Qnil);
|
|
|
2205 {
|
|
|
2206 EMACS_TIME t;
|
|
|
2207 EMACS_GET_TIME (t);
|
|
|
2208 if (!CONSP (Vlast_input_time))
|
|
|
2209 Vlast_input_time = Fcons (Qnil, Qnil);
|
|
|
2210 XCAR (Vlast_input_time)
|
|
|
2211 = make_int ((EMACS_SECS (t) >> 16) & 0xffff);
|
|
|
2212 XCDR (Vlast_input_time)
|
|
|
2213 = make_int ((EMACS_SECS (t) >> 0) & 0xffff);
|
|
|
2214 }
|
|
|
2215
|
|
|
2216 /* If this key came from the keyboard or from a keyboard macro, then
|
|
|
2217 it goes into the recent-keys and this-command-keys vectors.
|
|
|
2218 If this key came from the keyboard, and we're defining a keyboard
|
|
|
2219 macro, then it goes into the macro.
|
|
|
2220 */
|
|
|
2221 if (store_this_key)
|
|
|
2222 {
|
|
|
2223 push_this_command_keys (event);
|
|
|
2224 push_recent_keys (event);
|
|
|
2225 dribble_out_event (event);
|
|
|
2226 if (!NILP (con->defining_kbd_macro) && NILP (Vexecuting_macro))
|
|
|
2227 {
|
|
|
2228 if (!EVENTP (command_builder->current_events))
|
|
|
2229 finalize_kbd_macro_chars (con);
|
|
|
2230 store_kbd_macro_event (event);
|
|
|
2231 }
|
|
|
2232 }
|
|
|
2233 /* If this is the help char and there is a help form, then execute the
|
|
|
2234 help form and swallow this character. This is the only place where
|
|
|
2235 calling Fnext_event() can cause arbitrary lisp code to run. Note
|
|
|
2236 that execute_help_form() calls Fnext_command_event(), which calls
|
|
|
2237 this function, as well as Fdispatch_event.
|
|
|
2238 */
|
|
|
2239 if (!NILP (Vhelp_form) &&
|
|
|
2240 event_matches_key_specifier_p (XEVENT (event), Vhelp_char))
|
|
|
2241 execute_help_form (command_builder, event);
|
|
|
2242
|
|
|
2243 RETURN:
|
|
|
2244 UNGCPRO;
|
|
|
2245 return (event);
|
|
|
2246 }
|
|
|
2247
|
|
20
|
2248 DEFUN ("next-command-event", Fnext_command_event, 0, 2, 0, /*
|
|
0
|
2249 Return the next available \"user\" event.
|
|
|
2250 Pass this object to `dispatch-event' to handle it.
|
|
|
2251
|
|
|
2252 If EVENT is non-nil, it should be an event object and will be filled in
|
|
|
2253 and returned; otherwise a new event object will be created and returned.
|
|
|
2254 If PROMPT is non-nil, it should be a string and will be displayed in the
|
|
|
2255 echo area while this function is waiting for an event.
|
|
|
2256
|
|
|
2257 The event returned will be a keyboard, mouse press, or mouse release event.
|
|
|
2258 If there are non-command events available (mouse motion, sub-process output,
|
|
|
2259 etc) then these will be executed (with `dispatch-event') and discarded. This
|
|
|
2260 function is provided as a convenience; it is equivalent to the lisp code
|
|
|
2261
|
|
|
2262 (while (progn
|
|
|
2263 (next-event event prompt)
|
|
|
2264 (not (or (key-press-event-p event)
|
|
|
2265 (button-press-event-p event)
|
|
|
2266 (button-release-event-p event)
|
|
|
2267 (misc-user-event-p event))))
|
|
|
2268 (dispatch-event event))
|
|
|
2269
|
|
20
|
2270 */
|
|
|
2271 (event, prompt))
|
|
0
|
2272 {
|
|
|
2273 /* This function can GC */
|
|
|
2274 struct gcpro gcpro1;
|
|
|
2275 GCPRO1 (event);
|
|
|
2276 maybe_echo_keys (XCOMMAND_BUILDER
|
|
|
2277 (XCONSOLE (Vselected_console)->
|
|
|
2278 command_builder), 0); /* #### This sucks bigtime */
|
|
|
2279 for (;;)
|
|
|
2280 {
|
|
|
2281 event = Fnext_event (event, prompt);
|
|
|
2282 if (command_event_p (event))
|
|
|
2283 break;
|
|
|
2284 else
|
|
|
2285 execute_internal_event (event);
|
|
|
2286 }
|
|
|
2287 UNGCPRO;
|
|
|
2288 return (event);
|
|
|
2289 }
|
|
|
2290
|
|
|
2291 static void
|
|
|
2292 reset_current_events (struct command_builder *command_builder)
|
|
|
2293 {
|
|
|
2294 Lisp_Object event = command_builder->current_events;
|
|
|
2295 reset_command_builder_event_chain (command_builder);
|
|
|
2296 if (EVENTP (event))
|
|
|
2297 deallocate_event_chain (event);
|
|
|
2298 }
|
|
|
2299
|
|
20
|
2300 DEFUN ("discard-input", Fdiscard_input, 0, 0, 0, /*
|
|
0
|
2301 Discard any pending \"user\" events.
|
|
|
2302 Also cancel any kbd macro being defined.
|
|
|
2303 A user event is a key press, button press, button release, or
|
|
|
2304 \"other-user\" event (menu selection or scrollbar action).
|
|
20
|
2305 */
|
|
|
2306 ())
|
|
0
|
2307 {
|
|
|
2308 /* This throws away user-input on the queue, but doesn't process any
|
|
|
2309 events. Calling dispatch_event() here leads to a race condition.
|
|
|
2310 */
|
|
|
2311 Lisp_Object event = Fmake_event ();
|
|
|
2312 Lisp_Object head = Qnil, tail = Qnil;
|
|
|
2313 Lisp_Object oiq = Vinhibit_quit;
|
|
|
2314 struct gcpro gcpro1, gcpro2;
|
|
|
2315 /* #### not correct here with Vselected_console? Should
|
|
|
2316 discard-input take a console argument, or maybe map over
|
|
|
2317 all consoles? */
|
|
|
2318 struct console *con = XCONSOLE (Vselected_console);
|
|
|
2319
|
|
|
2320 /* next_event_internal() can cause arbitrary Lisp code to be evalled */
|
|
|
2321 GCPRO2 (event, oiq);
|
|
|
2322 Vinhibit_quit = Qt;
|
|
|
2323 /* If a macro was being defined then we have to mark the modeline
|
|
|
2324 has changed to ensure that it gets updated correctly. */
|
|
|
2325 if (!NILP (con->defining_kbd_macro))
|
|
|
2326 MARK_MODELINE_CHANGED;
|
|
|
2327 con->defining_kbd_macro = Qnil;
|
|
|
2328 reset_current_events (XCOMMAND_BUILDER (con->command_builder));
|
|
|
2329
|
|
|
2330 while (!NILP (command_event_queue)
|
|
|
2331 || event_stream_event_pending_p (1))
|
|
|
2332 {
|
|
|
2333 /* This will take stuff off the command_event_queue, or read it
|
|
|
2334 from the event_stream, but it will not block.
|
|
|
2335 */
|
|
108
|
2336 next_event_internal (event, 1);
|
|
0
|
2337 Vquit_flag = Qnil; /* Treat C-g as a user event (ignore it).
|
|
|
2338 It is vitally important that we reset
|
|
|
2339 Vquit_flag here. Otherwise, if we're
|
|
|
2340 reading from a TTY console,
|
|
|
2341 maybe_read_quit_event() will notice
|
|
|
2342 that C-g has been set and send us
|
|
|
2343 another C-g. That will cause us
|
|
|
2344 to get right back here, and read
|
|
|
2345 another C-g, ad infinitum ... */
|
|
|
2346
|
|
|
2347 /* If the event is a user event, ignore it. */
|
|
|
2348 if (!command_event_p (event))
|
|
|
2349 {
|
|
|
2350 /* Otherwise, chain the event onto our list of events not to ignore,
|
|
|
2351 and keep reading until the queue is empty. This does not mean
|
|
|
2352 that if a subprocess is generating an infinite amount of output,
|
|
|
2353 we will never terminate (*provided* that the behavior of
|
|
|
2354 next_event_cb() is correct -- see the comment in events.h),
|
|
|
2355 because this loop ends as soon as there are no more user events
|
|
|
2356 on the command_event_queue or event_stream.
|
|
|
2357 */
|
|
|
2358 enqueue_event (Fcopy_event (event, Qnil), &head, &tail);
|
|
|
2359 }
|
|
|
2360 }
|
|
|
2361
|
|
|
2362 if (!NILP (command_event_queue) || !NILP (command_event_queue_tail))
|
|
|
2363 abort ();
|
|
|
2364
|
|
|
2365 /* Now tack our chain of events back on to the front of the queue.
|
|
|
2366 Actually, since the queue is now drained, we can just replace it.
|
|
|
2367 The effect of this will be that we have deleted all user events
|
|
|
2368 from the input stream without changing the relative ordering of
|
|
|
2369 any other events. (Some events may have been taken from the
|
|
|
2370 event_stream and added to the command_event_queue, however.)
|
|
|
2371
|
|
|
2372 At this time, the command_event_queue will contain only eval_events.
|
|
|
2373 */
|
|
|
2374
|
|
|
2375 command_event_queue = head;
|
|
|
2376 command_event_queue_tail = tail;
|
|
|
2377
|
|
|
2378 Fdeallocate_event (event);
|
|
|
2379 UNGCPRO;
|
|
|
2380
|
|
|
2381 Vinhibit_quit = oiq;
|
|
|
2382 return Qnil;
|
|
|
2383 }
|
|
|
2384
|
|
|
2385
|
|
|
2386 /**********************************************************************/
|
|
|
2387 /* pausing until an action occurs */
|
|
|
2388 /**********************************************************************/
|
|
|
2389
|
|
108
|
2390 /* This is used in accept-process-output, sleep-for and sit-for.
|
|
|
2391 Before running any process_events in these routines, we set
|
|
|
2392 recursive_sit_for to Qt, and use this unwind protect to reset it to
|
|
110
|
2393 Qnil upon exit. When recursive_sit_for is Qt, calling sit-for will
|
|
|
2394 cause it to return immediately.
|
|
108
|
2395
|
|
|
2396 All of these routines install timeouts, so we clear the installed
|
|
|
2397 timeout as well.
|
|
|
2398
|
|
|
2399 Note: It's very easy to break the desired behaviours of these
|
|
|
2400 3 routines. If you make any changes to anything in this area, run
|
|
|
2401 the regression tests at the bottom of the file. -- dmoore */
|
|
|
2402
|
|
|
2403
|
|
|
2404 static Lisp_Object
|
|
|
2405 sit_for_unwind (Lisp_Object timeout_id)
|
|
|
2406 {
|
|
|
2407 if (!NILP(timeout_id))
|
|
|
2408 Fdisable_timeout (timeout_id);
|
|
|
2409
|
|
|
2410 recursive_sit_for = Qnil;
|
|
|
2411 return Qnil;
|
|
|
2412 }
|
|
|
2413
|
|
0
|
2414 /* #### Is (accept-process-output nil 3) supposed to be like (sleep-for 3)?
|
|
|
2415 */
|
|
|
2416
|
|
20
|
2417 DEFUN ("accept-process-output", Faccept_process_output, 0, 3, 0, /*
|
|
0
|
2418 Allow any pending output from subprocesses to be read by Emacs.
|
|
|
2419 It is read into the process' buffers or given to their filter functions.
|
|
|
2420 Non-nil arg PROCESS means do not return until some output has been received
|
|
86
|
2421 from PROCESS. Nil arg PROCESS means do not return until some output has
|
|
|
2422 been received from any process.
|
|
0
|
2423 If the second arg is non-nil, it is the maximum number of seconds to wait:
|
|
|
2424 this function will return after that much time even if no input has arrived
|
|
|
2425 from PROCESS. This argument may be a float, meaning wait some fractional
|
|
|
2426 part of a second.
|
|
|
2427 If the third arg is non-nil, it is a number of milliseconds that is added
|
|
|
2428 to the second arg. (This exists only for compatibility.)
|
|
|
2429 Return non-nil iff we received any output before the timeout expired.
|
|
20
|
2430 */
|
|
|
2431 (process, timeout_secs, timeout_msecs))
|
|
0
|
2432 {
|
|
|
2433 /* This function can GC */
|
|
|
2434 struct gcpro gcpro1, gcpro2;
|
|
|
2435 Lisp_Object event = Qnil;
|
|
|
2436 Lisp_Object result = Qnil;
|
|
|
2437 int timeout_id;
|
|
|
2438 int timeout_enabled = 0;
|
|
86
|
2439 int done = 0;
|
|
0
|
2440 struct buffer *old_buffer = current_buffer;
|
|
108
|
2441 int count;
|
|
|
2442
|
|
0
|
2443 /* We preserve the current buffer but nothing else. If a focus
|
|
|
2444 change alters the selected window then the top level event loop
|
|
|
2445 will eventually alter current_buffer to match. In the mean time
|
|
|
2446 we don't want to mess up whatever called this function. */
|
|
|
2447
|
|
|
2448 if (!NILP (process))
|
|
|
2449 CHECK_PROCESS (process);
|
|
|
2450
|
|
|
2451 GCPRO2 (event, process);
|
|
|
2452
|
|
86
|
2453 if (!NILP (timeout_secs) || !NILP (timeout_msecs))
|
|
0
|
2454 {
|
|
|
2455 unsigned long msecs = 0;
|
|
|
2456 if (!NILP (timeout_secs))
|
|
|
2457 msecs = lisp_number_to_milliseconds (timeout_secs, 1);
|
|
|
2458 if (!NILP (timeout_msecs))
|
|
|
2459 {
|
|
|
2460 CHECK_NATNUM (timeout_msecs);
|
|
|
2461 msecs += XINT (timeout_msecs);
|
|
|
2462 }
|
|
|
2463 if (msecs)
|
|
|
2464 {
|
|
|
2465 timeout_id = event_stream_generate_wakeup (msecs, 0, Qnil, Qnil, 0);
|
|
|
2466 timeout_enabled = 1;
|
|
|
2467 }
|
|
|
2468 }
|
|
|
2469
|
|
|
2470 event = Fmake_event ();
|
|
|
2471
|
|
108
|
2472 count = specpdl_depth ();
|
|
|
2473 record_unwind_protect (sit_for_unwind,
|
|
|
2474 timeout_enabled ? make_int (timeout_id) : Qnil);
|
|
|
2475 recursive_sit_for = Qt;
|
|
|
2476
|
|
86
|
2477 while (!done &&
|
|
|
2478 ((NILP (process) && timeout_enabled) ||
|
|
|
2479 (NILP (process) && event_stream_event_pending_p (0)) ||
|
|
|
2480 (!NILP (process))))
|
|
0
|
2481 /* Calling detect_input_pending() is the wrong thing here, because
|
|
|
2482 that considers the Vunread_command_events and command_event_queue.
|
|
|
2483 We don't need to look at the command_event_queue because we are
|
|
|
2484 only interested in process events, which don't go on that. In
|
|
|
2485 fact, we can't read from it anyway, because we put stuff on it.
|
|
|
2486
|
|
|
2487 Note that event_stream->event_pending_p must be called in such
|
|
|
2488 a way that it says whether any events *of any kind* are ready,
|
|
|
2489 not just user events, or (accept-process-output nil) will fail
|
|
|
2490 to dispatch any process events that may be on the queue. It is
|
|
|
2491 not clear to me that this is important, because the top-level
|
|
|
2492 loop will process it, and I don't think that there is ever a
|
|
|
2493 time when one calls accept-process-output with a nil argument
|
|
|
2494 and really need the processes to be handled. */
|
|
|
2495 {
|
|
74
|
2496 /* If our timeout has arrived, we move along. */
|
|
82
|
2497 if (timeout_enabled && !event_stream_wakeup_pending_p (timeout_id, 0))
|
|
74
|
2498 {
|
|
|
2499 timeout_enabled = 0;
|
|
86
|
2500 done = 1; /* We're done. */
|
|
|
2501 continue; /* Don't call next_event_internal */
|
|
74
|
2502 }
|
|
|
2503
|
|
0
|
2504 QUIT; /* next_event_internal() does not QUIT, so check for ^G
|
|
|
2505 before reading output from the process - this makes it
|
|
|
2506 less likely that the filter will actually be aborted.
|
|
|
2507 */
|
|
|
2508
|
|
108
|
2509 next_event_internal (event, 0);
|
|
0
|
2510 /* If C-g was pressed while we were waiting, Vquit_flag got
|
|
|
2511 set and next_event_internal() also returns C-g. When
|
|
|
2512 we enqueue the C-g below, it will get discarded. The
|
|
|
2513 next time through, QUIT will be called and will signal a quit. */
|
|
|
2514 switch (XEVENT_TYPE (event))
|
|
|
2515 {
|
|
|
2516 case process_event:
|
|
|
2517 {
|
|
86
|
2518 if (NILP (process) ||
|
|
|
2519 EQ (XEVENT (event)->event.process.process, process))
|
|
0
|
2520 {
|
|
86
|
2521 done = 1;
|
|
0
|
2522 /* RMS's version always returns nil when proc is nil,
|
|
|
2523 and only returns t if input ever arrived on proc. */
|
|
|
2524 result = Qt;
|
|
|
2525 }
|
|
|
2526
|
|
|
2527 execute_internal_event (event);
|
|
|
2528 break;
|
|
|
2529 }
|
|
|
2530 case timeout_event:
|
|
74
|
2531 /* We execute the event even if it's ours, and notice that it's
|
|
|
2532 happened above. */
|
|
0
|
2533 case pointer_motion_event:
|
|
|
2534 case magic_event:
|
|
|
2535 {
|
|
20
|
2536 EXECUTE_INTERNAL:
|
|
0
|
2537 execute_internal_event (event);
|
|
|
2538 break;
|
|
|
2539 }
|
|
|
2540 default:
|
|
|
2541 {
|
|
|
2542 enqueue_command_event_1 (event);
|
|
|
2543 break;
|
|
|
2544 }
|
|
|
2545 }
|
|
|
2546 }
|
|
|
2547
|
|
108
|
2548 unbind_to (count, timeout_enabled ? make_int (timeout_id) : Qnil);
|
|
0
|
2549
|
|
|
2550 Fdeallocate_event (event);
|
|
|
2551 UNGCPRO;
|
|
|
2552 current_buffer = old_buffer;
|
|
|
2553 return result;
|
|
|
2554 }
|
|
|
2555
|
|
20
|
2556 DEFUN ("sleep-for", Fsleep_for, 1, 1, 0, /*
|
|
0
|
2557 Pause, without updating display, for ARG seconds.
|
|
|
2558 ARG may be a float, meaning pause for some fractional part of a second.
|
|
108
|
2559
|
|
110
|
2560 It is recommended that you never call sleep-for from inside of a process
|
|
|
2561 filter function or timer event (either synchronous or asynchronous).
|
|
20
|
2562 */
|
|
|
2563 (seconds))
|
|
0
|
2564 {
|
|
|
2565 /* This function can GC */
|
|
|
2566 unsigned long msecs = lisp_number_to_milliseconds (seconds, 1);
|
|
|
2567 int id;
|
|
|
2568 Lisp_Object event = Qnil;
|
|
108
|
2569 int count;
|
|
0
|
2570 struct gcpro gcpro1;
|
|
|
2571
|
|
|
2572 GCPRO1 (event);
|
|
|
2573
|
|
|
2574 id = event_stream_generate_wakeup (msecs, 0, Qnil, Qnil, 0);
|
|
|
2575 event = Fmake_event ();
|
|
108
|
2576
|
|
|
2577 count = specpdl_depth ();
|
|
|
2578 record_unwind_protect (sit_for_unwind, make_int (id));
|
|
|
2579 recursive_sit_for = Qt;
|
|
|
2580
|
|
0
|
2581 while (1)
|
|
|
2582 {
|
|
74
|
2583 /* If our timeout has arrived, we move along. */
|
|
|
2584 if (!event_stream_wakeup_pending_p (id, 0))
|
|
|
2585 goto DONE_LABEL;
|
|
|
2586
|
|
0
|
2587 QUIT; /* next_event_internal() does not QUIT, so check for ^G
|
|
|
2588 before reading output from the process - this makes it
|
|
|
2589 less likely that the filter will actually be aborted.
|
|
|
2590 */
|
|
|
2591 /* We're a generator of the command_event_queue, so we can't be a
|
|
|
2592 consumer as well. We don't care about command and eval-events
|
|
|
2593 anyway.
|
|
|
2594 */
|
|
108
|
2595 next_event_internal (event, 0); /* blocks */
|
|
0
|
2596 /* See the comment in accept-process-output about Vquit_flag */
|
|
|
2597 switch (XEVENT_TYPE (event))
|
|
|
2598 {
|
|
|
2599 case timeout_event:
|
|
74
|
2600 /* We execute the event even if it's ours, and notice that it's
|
|
|
2601 happened above. */
|
|
108
|
2602 case process_event:
|
|
0
|
2603 case pointer_motion_event:
|
|
|
2604 case magic_event:
|
|
|
2605 {
|
|
|
2606 EXECUTE_INTERNAL:
|
|
|
2607 execute_internal_event (event);
|
|
|
2608 break;
|
|
|
2609 }
|
|
|
2610 default:
|
|
|
2611 {
|
|
|
2612 enqueue_command_event_1 (event);
|
|
|
2613 break;
|
|
|
2614 }
|
|
|
2615 }
|
|
|
2616 }
|
|
|
2617 DONE_LABEL:
|
|
108
|
2618 unbind_to (count, make_int (id));
|
|
0
|
2619 Fdeallocate_event (event);
|
|
|
2620 UNGCPRO;
|
|
|
2621 return Qnil;
|
|
|
2622 }
|
|
|
2623
|
|
20
|
2624 DEFUN ("sit-for", Fsit_for, 1, 2, 0, /*
|
|
0
|
2625 Perform redisplay, then wait ARG seconds or until user input is available.
|
|
|
2626 ARG may be a float, meaning a fractional part of a second.
|
|
|
2627 Optional second arg non-nil means don't redisplay, just wait for input.
|
|
|
2628 Redisplay is preempted as always if user input arrives, and does not
|
|
108
|
2629 happen if input is available before it starts.
|
|
0
|
2630 Value is t if waited the full time with no input arriving.
|
|
108
|
2631
|
|
110
|
2632 If sit-for is called from within a process filter function or timer
|
|
|
2633 event (either synchronous or asynchronous) it will return immediately.
|
|
20
|
2634 */
|
|
|
2635 (seconds, nodisplay))
|
|
0
|
2636 {
|
|
|
2637 /* This function can GC */
|
|
|
2638 unsigned long msecs = lisp_number_to_milliseconds (seconds, 1);
|
|
|
2639 Lisp_Object event, result;
|
|
|
2640 struct gcpro gcpro1;
|
|
|
2641 int id;
|
|
108
|
2642 int count;
|
|
|
2643
|
|
0
|
2644 /* The unread-command-events count as pending input */
|
|
|
2645 if (!NILP (Vunread_command_events) || !NILP (Vunread_command_event))
|
|
|
2646 return Qnil;
|
|
|
2647
|
|
|
2648 /* If the command-builder already has user-input on it (not eval events)
|
|
|
2649 then that means we're done too.
|
|
|
2650 */
|
|
|
2651 if (!NILP (command_event_queue))
|
|
|
2652 {
|
|
|
2653 EVENT_CHAIN_LOOP (event, command_event_queue)
|
|
|
2654 {
|
|
|
2655 if (command_event_p (event))
|
|
|
2656 return (Qnil);
|
|
|
2657 }
|
|
|
2658 }
|
|
|
2659
|
|
|
2660 /* If we're in a macro, or noninteractive, or early in temacs, then
|
|
|
2661 don't wait. */
|
|
|
2662 if (noninteractive || !NILP (Vexecuting_macro))
|
|
|
2663 return (Qnil);
|
|
|
2664
|
|
110
|
2665 /* Recusive call from a filter function or timeout handler. */
|
|
|
2666 if (!NILP(recursive_sit_for))
|
|
|
2667 {
|
|
|
2668 if (!event_stream_event_pending_p (1) && NILP (nodisplay))
|
|
|
2669 {
|
|
|
2670 run_pre_idle_hook ();
|
|
|
2671 redisplay ();
|
|
|
2672 }
|
|
|
2673 return Qnil;
|
|
|
2674 }
|
|
|
2675
|
|
|
2676
|
|
0
|
2677 /* Otherwise, start reading events from the event_stream.
|
|
|
2678 Do this loop at least once even if (sit-for 0) so that we
|
|
|
2679 redisplay when no input pending.
|
|
|
2680 */
|
|
108
|
2681 GCPRO1 (event);
|
|
70
|
2682 event = Fmake_event ();
|
|
0
|
2683
|
|
|
2684 /* Generate the wakeup even if MSECS is 0, so that existing timeout/etc.
|
|
|
2685 events get processed. The old (pre-19.12) code special-cased this
|
|
|
2686 and didn't generate a wakeup, but the resulting behavior was less than
|
|
|
2687 ideal; viz. the occurrence of (sit-for 0.001) scattered throughout
|
|
|
2688 the E-Lisp universe. */
|
|
|
2689
|
|
|
2690 id = event_stream_generate_wakeup (msecs, 0, Qnil, Qnil, 0);
|
|
|
2691
|
|
108
|
2692 count = specpdl_depth ();
|
|
|
2693 record_unwind_protect (sit_for_unwind, make_int (id));
|
|
|
2694 recursive_sit_for = Qt;
|
|
|
2695
|
|
0
|
2696 while (1)
|
|
|
2697 {
|
|
|
2698 /* If there is no user input pending, then redisplay.
|
|
|
2699 */
|
|
|
2700 if (!event_stream_event_pending_p (1) && NILP (nodisplay))
|
|
|
2701 {
|
|
|
2702 run_pre_idle_hook ();
|
|
|
2703 redisplay ();
|
|
|
2704 }
|
|
|
2705
|
|
74
|
2706 /* If our timeout has arrived, we move along. */
|
|
|
2707 if (!event_stream_wakeup_pending_p (id, 0))
|
|
0
|
2708 {
|
|
|
2709 result = Qt;
|
|
|
2710 goto DONE_LABEL;
|
|
|
2711 }
|
|
|
2712
|
|
|
2713 QUIT; /* next_event_internal() does not QUIT, so check for ^G
|
|
|
2714 before reading output from the process - this makes it
|
|
|
2715 less likely that the filter will actually be aborted.
|
|
|
2716 */
|
|
|
2717 /* We're a generator of the command_event_queue, so we can't be a
|
|
|
2718 consumer as well. In fact, we know there's nothing on the
|
|
|
2719 command_event_queue that we didn't just put there.
|
|
|
2720 */
|
|
108
|
2721 next_event_internal (event, 0); /* blocks */
|
|
0
|
2722 /* See the comment in accept-process-output about Vquit_flag */
|
|
|
2723
|
|
|
2724 if (command_event_p (event))
|
|
|
2725 {
|
|
108
|
2726 QUIT; /* If the command was C-g check it here
|
|
|
2727 so that we abort out of the sit-for,
|
|
|
2728 not the next command. sleep-for and
|
|
|
2729 accept-process-output continue looping
|
|
|
2730 so they check QUIT again implicitly.*/
|
|
0
|
2731 result = Qnil;
|
|
|
2732 goto DONE_LABEL;
|
|
|
2733 }
|
|
|
2734 switch (XEVENT_TYPE (event))
|
|
|
2735 {
|
|
|
2736 case eval_event:
|
|
|
2737 {
|
|
|
2738 /* eval-events get delayed until later. */
|
|
|
2739 enqueue_command_event (Fcopy_event (event, Qnil));
|
|
|
2740 break;
|
|
|
2741 }
|
|
86
|
2742
|
|
0
|
2743 case timeout_event:
|
|
74
|
2744 /* We execute the event even if it's ours, and notice that it's
|
|
|
2745 happened above. */
|
|
|
2746 default:
|
|
0
|
2747 {
|
|
|
2748 EXECUTE_INTERNAL:
|
|
|
2749 execute_internal_event (event);
|
|
|
2750 break;
|
|
|
2751 }
|
|
|
2752 }
|
|
|
2753 }
|
|
|
2754
|
|
|
2755 DONE_LABEL:
|
|
108
|
2756 unbind_to (count, make_int (id));
|
|
0
|
2757
|
|
|
2758 /* Put back the event (if any) that made Fsit_for() exit before the
|
|
|
2759 timeout. Note that it is being added to the back of the queue, which
|
|
|
2760 would be inappropriate if there were any user events on the queue
|
|
|
2761 already: we would be misordering them. But we know that there are
|
|
|
2762 no user-events on the queue, or else we would not have reached this
|
|
|
2763 point at all.
|
|
|
2764 */
|
|
|
2765 if (NILP (result))
|
|
|
2766 enqueue_command_event (event);
|
|
|
2767 else
|
|
|
2768 Fdeallocate_event (event);
|
|
|
2769
|
|
|
2770 UNGCPRO;
|
|
|
2771 return (result);
|
|
|
2772 }
|
|
|
2773
|
|
|
2774 /* This handy little function is used by xselect.c and energize.c to
|
|
|
2775 wait for replies from processes that aren't really processes (that is,
|
|
|
2776 the X server and the Energize server).
|
|
|
2777 */
|
|
|
2778 void
|
|
|
2779 wait_delaying_user_input (int (*predicate) (void *arg), void *predicate_arg)
|
|
|
2780 {
|
|
|
2781 /* This function can GC */
|
|
|
2782 Lisp_Object event = Fmake_event ();
|
|
|
2783 struct gcpro gcpro1;
|
|
|
2784 GCPRO1 (event);
|
|
|
2785
|
|
|
2786 while (!(*predicate) (predicate_arg))
|
|
|
2787 {
|
|
|
2788 QUIT; /* next_event_internal() does not QUIT. */
|
|
|
2789
|
|
|
2790 /* We're a generator of the command_event_queue, so we can't be a
|
|
|
2791 consumer as well. Also, we have no reason to consult the
|
|
|
2792 command_event_queue; there are only user and eval-events there,
|
|
|
2793 and we'd just have to put them back anyway.
|
|
|
2794 */
|
|
108
|
2795 next_event_internal (event, 0);
|
|
0
|
2796 /* See the comment in accept-process-output about Vquit_flag */
|
|
|
2797 if (command_event_p (event)
|
|
|
2798 || (XEVENT_TYPE (event) == eval_event)
|
|
|
2799 || (XEVENT_TYPE (event) == magic_eval_event))
|
|
|
2800 enqueue_command_event_1 (event);
|
|
|
2801 else
|
|
|
2802 execute_internal_event (event);
|
|
|
2803 }
|
|
|
2804 UNGCPRO;
|
|
|
2805 }
|
|
|
2806
|
|
|
2807
|
|
|
2808 /**********************************************************************/
|
|
|
2809 /* dispatching events; command builder */
|
|
|
2810 /**********************************************************************/
|
|
|
2811
|
|
|
2812 static void
|
|
|
2813 execute_internal_event (Lisp_Object event)
|
|
|
2814 {
|
|
|
2815 /* events on dead channels get silently eaten */
|
|
|
2816 if (object_dead_p (XEVENT (event)->channel))
|
|
|
2817 return;
|
|
|
2818
|
|
|
2819 /* This function can GC */
|
|
|
2820 switch (XEVENT_TYPE (event))
|
|
|
2821 {
|
|
|
2822 case empty_event:
|
|
|
2823 return;
|
|
|
2824
|
|
|
2825 case eval_event:
|
|
|
2826 {
|
|
|
2827 call1 (XEVENT (event)->event.eval.function,
|
|
|
2828 XEVENT (event)->event.eval.object);
|
|
|
2829 return;
|
|
|
2830 }
|
|
|
2831
|
|
|
2832 case magic_eval_event:
|
|
|
2833 {
|
|
|
2834 (XEVENT (event)->event.magic_eval.internal_function)
|
|
|
2835 (XEVENT (event)->event.magic_eval.object);
|
|
|
2836 return;
|
|
|
2837 }
|
|
|
2838
|
|
|
2839 case pointer_motion_event:
|
|
|
2840 {
|
|
|
2841 if (!NILP (Vmouse_motion_handler))
|
|
|
2842 call1 (Vmouse_motion_handler, event);
|
|
|
2843 return;
|
|
|
2844 }
|
|
|
2845
|
|
|
2846 case process_event:
|
|
|
2847 {
|
|
|
2848 Lisp_Object p = XEVENT (event)->event.process.process;
|
|
|
2849 Charcount readstatus;
|
|
|
2850
|
|
|
2851 assert (PROCESSP (p));
|
|
|
2852 while ((readstatus = read_process_output (p)) > 0)
|
|
|
2853 ;
|
|
|
2854 if (readstatus > 0)
|
|
|
2855 ; /* this clauses never gets executed but allows the #ifdefs
|
|
|
2856 to work cleanly. */
|
|
|
2857 #ifdef EWOULDBLOCK
|
|
|
2858 else if (readstatus == -1 && errno == EWOULDBLOCK)
|
|
|
2859 ;
|
|
|
2860 #endif /* EWOULDBLOCK */
|
|
|
2861 #ifdef EAGAIN
|
|
|
2862 else if (readstatus == -1 && errno == EAGAIN)
|
|
|
2863 ;
|
|
|
2864 #endif /* EAGAIN */
|
|
|
2865 else if ((readstatus == 0 &&
|
|
|
2866 /* Note that we cannot distinguish between no input
|
|
|
2867 available now and a closed pipe.
|
|
|
2868 With luck, a closed pipe will be accompanied by
|
|
|
2869 subprocess termination and SIGCHLD. */
|
|
|
2870 (!network_connection_p (p) ||
|
|
|
2871 /*
|
|
|
2872 When connected to ToolTalk (i.e.
|
|
|
2873 connected_via_filedesc_p()), it's not possible to
|
|
|
2874 reliably determine whether there is a message
|
|
|
2875 waiting for ToolTalk to receive. ToolTalk expects
|
|
|
2876 to have tt_message_receive() called exactly once
|
|
|
2877 every time the file descriptor becomes active, so
|
|
|
2878 the filter function forces this by returning 0.
|
|
|
2879 Emacs must not interpret this as a closed pipe. */
|
|
|
2880 connected_via_filedesc_p (XPROCESS (p))))
|
|
|
2881 #ifdef HAVE_PTYS
|
|
|
2882 /* On some OSs with ptys, when the process on one end of
|
|
|
2883 a pty exits, the other end gets an error reading with
|
|
|
2884 errno = EIO instead of getting an EOF (0 bytes read).
|
|
|
2885 Therefore, if we get an error reading and errno =
|
|
|
2886 EIO, just continue, because the child process has
|
|
|
2887 exited and should clean itself up soon (e.g. when we
|
|
|
2888 get a SIGCHLD). */
|
|
|
2889 || (readstatus == -1 && errno == EIO)
|
|
|
2890 #endif
|
|
|
2891 )
|
|
|
2892 {
|
|
80
|
2893 /* Currently, we rely on SIGCHLD to indicate that the
|
|
|
2894 process has terminated. Unfortunately, on some systems
|
|
|
2895 the SIGCHLD gets missed some of the time. So we put an
|
|
|
2896 additional check in status_notify() to see whether a
|
|
|
2897 process has terminated. We must tell status_notify()
|
|
|
2898 to enable that check, and we do so now. */
|
|
0
|
2899 kick_status_notify ();
|
|
|
2900 }
|
|
|
2901 else
|
|
|
2902 {
|
|
|
2903 /* Deactivate network connection */
|
|
|
2904 Lisp_Object status = Fprocess_status (p);
|
|
|
2905 if (EQ (status, Qopen)
|
|
|
2906 /* In case somebody changes the theory of whether to
|
|
|
2907 return open as opposed to run for network connection
|
|
|
2908 "processes"... */
|
|
|
2909 || EQ (status, Qrun))
|
|
|
2910 update_process_status (p, Qexit, 256, 0);
|
|
|
2911 deactivate_process (p);
|
|
|
2912 }
|
|
|
2913
|
|
|
2914 /* We must call status_notify here to allow the
|
|
|
2915 event_stream->unselect_process_cb to be run if appropriate.
|
|
|
2916 Otherwise, dead fds may be selected for, and we will get a
|
|
|
2917 continuous stream of process events for them. Since we don't
|
|
|
2918 return until all process events have been flushed, we would
|
|
|
2919 get stuck here, processing events on a process whose status
|
|
|
2920 was 'exit. Call this after dispatch-event, or the fds will
|
|
|
2921 have been closed before we read the last data from them.
|
|
|
2922 It's safe for the filter to signal an error because
|
|
|
2923 status_notify() will be called on return to top-level.
|
|
|
2924 */
|
|
|
2925 status_notify ();
|
|
|
2926 return;
|
|
|
2927 }
|
|
|
2928
|
|
|
2929 case timeout_event:
|
|
|
2930 {
|
|
|
2931 struct Lisp_Event *e = XEVENT (event);
|
|
|
2932 if (!NILP (e->event.timeout.function))
|
|
|
2933 call1 (e->event.timeout.function,
|
|
|
2934 e->event.timeout.object);
|
|
|
2935 return;
|
|
|
2936 }
|
|
|
2937 case magic_event:
|
|
|
2938 {
|
|
|
2939 event_stream_handle_magic_event (XEVENT (event));
|
|
|
2940 return;
|
|
|
2941 }
|
|
|
2942 default:
|
|
|
2943 abort ();
|
|
|
2944 }
|
|
|
2945 }
|
|
|
2946
|
|
|
2947
|
|
|
2948
|
|
|
2949 static void
|
|
|
2950 this_command_keys_replace_suffix (Lisp_Object suffix, Lisp_Object chain)
|
|
|
2951 {
|
|
|
2952 Lisp_Object first_before_suffix =
|
|
|
2953 event_chain_find_previous (Vthis_command_keys, suffix);
|
|
|
2954
|
|
|
2955 if (NILP (first_before_suffix))
|
|
|
2956 Vthis_command_keys = chain;
|
|
|
2957 else
|
|
|
2958 XSET_EVENT_NEXT (first_before_suffix, chain);
|
|
|
2959 deallocate_event_chain (suffix);
|
|
|
2960 Vthis_command_keys_tail = event_chain_tail (chain);
|
|
|
2961 }
|
|
|
2962
|
|
|
2963 static void
|
|
|
2964 command_builder_replace_suffix (struct command_builder *builder,
|
|
|
2965 Lisp_Object suffix, Lisp_Object chain)
|
|
|
2966 {
|
|
|
2967 Lisp_Object first_before_suffix =
|
|
|
2968 event_chain_find_previous (builder->current_events, suffix);
|
|
|
2969
|
|
|
2970 if (NILP (first_before_suffix))
|
|
|
2971 builder->current_events = chain;
|
|
|
2972 else
|
|
|
2973 XSET_EVENT_NEXT (first_before_suffix, chain);
|
|
|
2974 deallocate_event_chain (suffix);
|
|
|
2975 builder->most_current_event = event_chain_tail (chain);
|
|
|
2976 }
|
|
|
2977
|
|
|
2978 static Lisp_Object
|
|
|
2979 command_builder_find_leaf_1 (struct command_builder *builder)
|
|
|
2980 {
|
|
|
2981 Lisp_Object event0 = builder->current_events;
|
|
|
2982
|
|
|
2983 if (NILP (event0))
|
|
|
2984 return (Qnil);
|
|
|
2985
|
|
|
2986 return event_binding (event0, 1);
|
|
|
2987 }
|
|
|
2988
|
|
|
2989 /* See if we can do function-key-map or key-translation-map translation
|
|
|
2990 on the current events in the command builder. If so, do this, and
|
|
|
2991 return the resulting binding, if any. */
|
|
|
2992
|
|
|
2993 static Lisp_Object
|
|
|
2994 munge_keymap_translate (struct command_builder *builder,
|
|
|
2995 enum munge_me_out_the_door munge,
|
|
|
2996 int has_normal_binding_p)
|
|
|
2997 {
|
|
|
2998 Lisp_Object suffix;
|
|
|
2999
|
|
|
3000 EVENT_CHAIN_LOOP (suffix, builder->munge_me[munge].first_mungeable_event)
|
|
|
3001 {
|
|
|
3002 Lisp_Object result = munging_key_map_event_binding (suffix, munge);
|
|
|
3003
|
|
|
3004 if (!NILP (result))
|
|
|
3005 {
|
|
|
3006 if (KEYMAPP (result))
|
|
|
3007 {
|
|
|
3008 if (NILP (builder->last_non_munged_event)
|
|
|
3009 && !has_normal_binding_p)
|
|
|
3010 builder->last_non_munged_event =
|
|
|
3011 builder->most_current_event;
|
|
|
3012 }
|
|
|
3013 else
|
|
|
3014 builder->last_non_munged_event = Qnil;
|
|
|
3015
|
|
|
3016 if (!KEYMAPP (result) && !VECTORP (result)
|
|
|
3017 && !STRINGP (result))
|
|
|
3018 {
|
|
|
3019 struct gcpro gcpro1;
|
|
|
3020 GCPRO1 (suffix);
|
|
|
3021 result = call1 (result, Qnil);
|
|
|
3022 UNGCPRO;
|
|
|
3023 }
|
|
|
3024
|
|
|
3025 if (KEYMAPP (result))
|
|
|
3026 return result;
|
|
|
3027
|
|
|
3028 if (VECTORP (result) || STRINGP (result))
|
|
|
3029 {
|
|
|
3030 Lisp_Object new_chain =
|
|
|
3031 key_sequence_to_event_chain (result);
|
|
|
3032 Lisp_Object tempev;
|
|
|
3033 int n, tckn;
|
|
|
3034
|
|
|
3035 /* If the first_mungeable_event of the other munger
|
|
|
3036 is within the events we're munging, then it will
|
|
|
3037 point to deallocated events afterwards, which is
|
|
|
3038 bad -- so make it point at the beginning of the
|
|
|
3039 munged events. */
|
|
|
3040 EVENT_CHAIN_LOOP (tempev, suffix)
|
|
|
3041 {
|
|
|
3042 if (EQ (tempev, builder->munge_me[1 - munge].
|
|
|
3043 first_mungeable_event))
|
|
|
3044 {
|
|
|
3045 builder->munge_me[1 - munge].first_mungeable_event =
|
|
|
3046 new_chain;
|
|
|
3047 break;
|
|
|
3048 }
|
|
|
3049 }
|
|
|
3050
|
|
|
3051 n = event_chain_count (suffix);
|
|
|
3052 command_builder_replace_suffix (builder, suffix, new_chain);
|
|
|
3053 builder->munge_me[munge].first_mungeable_event = Qnil;
|
|
|
3054 /* Now hork this-command-keys as well. */
|
|
|
3055
|
|
|
3056 /* We just assume that the events we just replaced
|
|
|
3057 are sitting in copied form at the end of this-command-keys.
|
|
|
3058 If the user did weird things with `dispatch-event'
|
|
|
3059 this may not be the case, but at least we make
|
|
|
3060 sure we won't crash. */
|
|
|
3061 new_chain = copy_event_chain (new_chain);
|
|
|
3062 tckn = event_chain_count (Vthis_command_keys);
|
|
|
3063 if (tckn >= n)
|
|
|
3064 {
|
|
|
3065 this_command_keys_replace_suffix
|
|
|
3066 (event_chain_nth (Vthis_command_keys, tckn - n),
|
|
|
3067 new_chain);
|
|
|
3068 }
|
|
|
3069
|
|
|
3070 result = command_builder_find_leaf_1 (builder);
|
|
|
3071 return result;
|
|
|
3072 }
|
|
|
3073
|
|
|
3074 if (munge == MUNGE_ME_FUNCTION_KEY)
|
|
|
3075 signal_simple_error ("Invalid binding in function-key-map",
|
|
|
3076 result);
|
|
|
3077 else
|
|
|
3078 signal_simple_error ("Invalid binding in key-translation-map",
|
|
|
3079 result);
|
|
|
3080 }
|
|
|
3081 }
|
|
|
3082
|
|
|
3083 return Qnil;
|
|
|
3084 }
|
|
|
3085
|
|
|
3086 /* Compare the current state of the command builder against the local and
|
|
|
3087 global keymaps, and return the binding. If there is no match, try again,
|
|
2
|
3088 case-insensitively. The return value will be one of:
|
|
0
|
3089 -- nil (there is no binding)
|
|
|
3090 -- a keymap (part of a command has been specified)
|
|
|
3091 -- a command (anything that satisfies `commandp'; this includes
|
|
|
3092 some symbols, lists, subrs, strings, vectors, and
|
|
|
3093 compiled-function objects)
|
|
|
3094 */
|
|
|
3095 static Lisp_Object
|
|
|
3096 command_builder_find_leaf (struct command_builder *builder,
|
|
|
3097 int allow_misc_user_events_p)
|
|
|
3098 {
|
|
|
3099 /* This function can GC */
|
|
|
3100 Lisp_Object result;
|
|
|
3101 Lisp_Object evee = builder->current_events;
|
|
|
3102
|
|
|
3103 if (allow_misc_user_events_p
|
|
|
3104 && (NILP (XEVENT_NEXT (evee)))
|
|
|
3105 && (XEVENT_TYPE (evee) == misc_user_event))
|
|
|
3106 {
|
|
2
|
3107 Lisp_Object fn = XEVENT (evee)->event.eval.function;
|
|
0
|
3108 Lisp_Object arg = XEVENT (evee)->event.eval.object;
|
|
|
3109 return (list2 (fn, arg));
|
|
|
3110 }
|
|
|
3111
|
|
|
3112 else if (XEVENT_TYPE (evee) == misc_user_event)
|
|
|
3113 return Qnil;
|
|
|
3114
|
|
|
3115 result = command_builder_find_leaf_1 (builder);
|
|
|
3116
|
|
|
3117 /* Check to see if we have a potential function-key-map match. */
|
|
|
3118 if (NILP (result))
|
|
|
3119 {
|
|
|
3120 result = munge_keymap_translate (builder, MUNGE_ME_FUNCTION_KEY, 0);
|
|
|
3121 regenerate_echo_keys_from_this_command_keys (builder);
|
|
|
3122 }
|
|
|
3123 /* Check to see if we have a potential key-translation-map match. */
|
|
|
3124 {
|
|
|
3125 Lisp_Object key_translate_result =
|
|
|
3126 munge_keymap_translate (builder, MUNGE_ME_KEY_TRANSLATION,
|
|
|
3127 !NILP (result));
|
|
|
3128 if (!NILP (key_translate_result))
|
|
|
3129 {
|
|
|
3130 result = key_translate_result;
|
|
|
3131 regenerate_echo_keys_from_this_command_keys (builder);
|
|
|
3132 }
|
|
|
3133 }
|
|
|
3134
|
|
|
3135 if (!NILP (result))
|
|
|
3136 return result;
|
|
|
3137
|
|
|
3138 /* If key-sequence wasn't bound, we'll try some fallbacks. */
|
|
|
3139
|
|
|
3140 /* If we didn't find a binding, and the last event in the sequence is
|
|
|
3141 a shifted character, then try again with the lowercase version. */
|
|
|
3142
|
|
2
|
3143 if (XEVENT_TYPE (builder->most_current_event) == key_press_event
|
|
|
3144 && !NILP (Vretry_undefined_key_binding_unshifted))
|
|
|
3145 {
|
|
|
3146 Lisp_Object terminal = builder->most_current_event;
|
|
|
3147 struct key_data* key = & XEVENT (terminal)->event.key;
|
|
|
3148 Emchar c;
|
|
|
3149 if ((key->modifiers & MOD_SHIFT)
|
|
|
3150 || (CHAR_OR_CHAR_INTP (key->keysym)
|
|
|
3151 && ((c = XCHAR_OR_CHAR_INT (key->keysym)), c >= 'A' && c <= 'Z')))
|
|
|
3152 {
|
|
|
3153 struct Lisp_Event terminal_copy;
|
|
|
3154 terminal_copy = *XEVENT (terminal);
|
|
|
3155
|
|
|
3156 if (key->modifiers & MOD_SHIFT)
|
|
|
3157 key->modifiers &= (~ MOD_SHIFT);
|
|
|
3158 else
|
|
|
3159 key->keysym = make_char (c + 'a' - 'A');
|
|
|
3160
|
|
|
3161 result = command_builder_find_leaf (builder, allow_misc_user_events_p);
|
|
|
3162 if (!NILP (result))
|
|
|
3163 return (result);
|
|
|
3164 /* If there was no match with the lower-case version either,
|
|
|
3165 then put back the upper-case event for the error
|
|
|
3166 message. But make sure that function-key-map didn't
|
|
|
3167 change things out from under us. */
|
|
|
3168 if (EQ (terminal, builder->most_current_event))
|
|
|
3169 *XEVENT (terminal) = terminal_copy;
|
|
|
3170 }
|
|
|
3171 }
|
|
|
3172
|
|
|
3173 /* help-char is `auto-bound' in every keymap */
|
|
0
|
3174 if (!NILP (Vprefix_help_command) &&
|
|
|
3175 event_matches_key_specifier_p (XEVENT (builder->most_current_event),
|
|
|
3176 Vhelp_char))
|
|
|
3177 return (Vprefix_help_command);
|
|
|
3178
|
|
70
|
3179 #ifdef HAVE_XIM
|
|
|
3180 /* If keysym is a non-ASCII char, bind it to self-insert-char by default. */
|
|
|
3181 if (XEVENT_TYPE (builder->most_current_event) == key_press_event
|
|
|
3182 && !NILP (Vcomposed_character_default_binding))
|
|
|
3183 {
|
|
|
3184 Lisp_Object keysym = XEVENT (builder->most_current_event)->event.key.keysym;
|
|
|
3185 if (CHARP (keysym) && !CHAR_ASCII_P (XCHAR (keysym)))
|
|
|
3186 return Vcomposed_character_default_binding;
|
|
|
3187 }
|
|
|
3188 #endif /* HAVE_XIM */
|
|
|
3189
|
|
0
|
3190 /* If we read extra events attempting to match a function key but end
|
|
|
3191 up failing, then we release those events back to the command loop
|
|
|
3192 and fail on the original lookup. The released events will then be
|
|
|
3193 reprocessed in the context of the first part having failed. */
|
|
|
3194 if (!NILP (builder->last_non_munged_event))
|
|
|
3195 {
|
|
|
3196 Lisp_Object event0 = builder->last_non_munged_event;
|
|
|
3197
|
|
|
3198 /* Put the commands back on the event queue. */
|
|
|
3199 enqueue_event_chain (XEVENT_NEXT (event0),
|
|
|
3200 &command_event_queue,
|
|
|
3201 &command_event_queue_tail);
|
|
|
3202
|
|
|
3203 /* Then remove them from the command builder. */
|
|
|
3204 XSET_EVENT_NEXT (event0, Qnil);
|
|
|
3205 builder->most_current_event = event0;
|
|
|
3206 builder->last_non_munged_event = Qnil;
|
|
|
3207 }
|
|
|
3208
|
|
|
3209 return Qnil;
|
|
|
3210 }
|
|
|
3211
|
|
|
3212
|
|
|
3213 /* Every time a command-event (a key, button, or menu selection) is read by
|
|
|
3214 Fnext_event(), it is stored in the recent_keys_ring, in Vlast_input_event,
|
|
|
3215 and in Vthis_command_keys. (Eval-events are not stored there.)
|
|
|
3216
|
|
|
3217 Every time a command is invoked, Vlast_command_event is set to the last
|
|
|
3218 event in the sequence.
|
|
|
3219
|
|
|
3220 This means that Vthis_command_keys is really about "input read since the
|
|
|
3221 last command was executed" rather than about "what keys invoked this
|
|
|
3222 command." This is a little counterintuitive, but that's the way it
|
|
|
3223 has always worked.
|
|
|
3224
|
|
|
3225 As an extra kink, the function read-key-sequence resets/updates the
|
|
|
3226 last-command-event and this-command-keys. It doesn't append to the
|
|
|
3227 command-keys as read-char does. Such are the pitfalls of having to
|
|
|
3228 maintain compatibility with a program for which the only specification
|
|
|
3229 is the code itself.
|
|
|
3230
|
|
|
3231 (We could implement recent_keys_ring and Vthis_command_keys as the same
|
|
|
3232 data structure.)
|
|
|
3233 */
|
|
|
3234
|
|
153
|
3235 DEFUN ("recent-keys", Frecent_keys, 0, 1, 0, /*
|
|
|
3236 Return a vector of recent keyboard or mouse button events read.
|
|
|
3237 If NUMBER is non-nil, not more than NUMBER events will be returned.
|
|
|
3238 Change number of events stored using `set-recent-keys-size'.
|
|
|
3239
|
|
0
|
3240 This copies the event objects into a new vector; it is safe to keep and
|
|
|
3241 modify them.
|
|
20
|
3242 */
|
|
153
|
3243 (number))
|
|
0
|
3244 {
|
|
|
3245 struct gcpro gcpro1;
|
|
|
3246 Lisp_Object val = Qnil;
|
|
153
|
3247 int nwanted;
|
|
0
|
3248 int start, nkeys, i, j;
|
|
|
3249 GCPRO1 (val);
|
|
|
3250
|
|
153
|
3251 if (NILP (number))
|
|
|
3252 nwanted = recent_keys_ring_size;
|
|
|
3253 else
|
|
|
3254 {
|
|
|
3255 CHECK_NATNUM (number);
|
|
|
3256 nwanted = XINT (number);
|
|
|
3257 }
|
|
|
3258
|
|
|
3259 /* Create the keys ring vector, if none present. */
|
|
|
3260 if (NILP (Vrecent_keys_ring))
|
|
|
3261 {
|
|
|
3262 Vrecent_keys_ring = make_vector (recent_keys_ring_size, Qnil);
|
|
|
3263 /* And return nothing in particular. */
|
|
|
3264 return make_vector (0, Qnil);
|
|
|
3265 }
|
|
|
3266
|
|
|
3267 if (NILP (vector_data (XVECTOR (Vrecent_keys_ring))[recent_keys_ring_index]))
|
|
0
|
3268 /* This means the vector has not yet wrapped */
|
|
|
3269 {
|
|
|
3270 nkeys = recent_keys_ring_index;
|
|
|
3271 start = 0;
|
|
|
3272 }
|
|
|
3273 else
|
|
|
3274 {
|
|
153
|
3275 nkeys = recent_keys_ring_size;
|
|
|
3276 start = ((recent_keys_ring_index == nkeys) ? 0 : recent_keys_ring_index);
|
|
0
|
3277 }
|
|
|
3278
|
|
153
|
3279 if (nwanted < nkeys)
|
|
|
3280 {
|
|
|
3281 start += nkeys - nwanted;
|
|
|
3282 if (start >= recent_keys_ring_size)
|
|
|
3283 start -= recent_keys_ring_size;
|
|
|
3284 nkeys = nwanted;
|
|
|
3285 }
|
|
|
3286 else
|
|
|
3287 nwanted = nkeys;
|
|
|
3288
|
|
|
3289 val = make_vector (nwanted, Qnil);
|
|
0
|
3290
|
|
|
3291 for (i = 0, j = start; i < nkeys; i++)
|
|
|
3292 {
|
|
153
|
3293 Lisp_Object e = vector_data (XVECTOR (Vrecent_keys_ring))[j];
|
|
0
|
3294
|
|
|
3295 if (NILP (e))
|
|
|
3296 abort ();
|
|
|
3297 vector_data (XVECTOR (val))[i] = Fcopy_event (e, Qnil);
|
|
153
|
3298 if (++j >= recent_keys_ring_size)
|
|
0
|
3299 j = 0;
|
|
|
3300 }
|
|
|
3301 UNGCPRO;
|
|
|
3302 return (val);
|
|
|
3303 }
|
|
|
3304
|
|
153
|
3305
|
|
|
3306 DEFUN ("recent-keys-ring-size", Frecent_keys_ring_size, 0, 0, 0, /*
|
|
|
3307 The maximum number of events `recent-keys' can return.
|
|
|
3308 */
|
|
|
3309 ())
|
|
|
3310 {
|
|
|
3311 return make_int (recent_keys_ring_size);
|
|
|
3312 }
|
|
|
3313
|
|
|
3314 DEFUN ("set-recent-keys-ring-size", Fset_recent_keys_ring_size, 1, 1, 0, /*
|
|
|
3315 Set the maximum number of events to be stored internally.
|
|
|
3316 */
|
|
|
3317 (size))
|
|
|
3318 {
|
|
|
3319 Lisp_Object new_vector = Qnil;
|
|
|
3320 int i, j, nkeys, start, min;
|
|
|
3321 struct gcpro gcpro1;
|
|
|
3322 GCPRO1 (new_vector);
|
|
|
3323
|
|
|
3324 CHECK_INT (size);
|
|
|
3325 if (XINT (size) <= 0)
|
|
|
3326 error ("Recent keys ring size must be positive");
|
|
|
3327 if (XINT (size) == recent_keys_ring_size)
|
|
|
3328 return size;
|
|
|
3329
|
|
|
3330 new_vector = make_vector (XINT (size), Qnil);
|
|
|
3331
|
|
|
3332 if (NILP (Vrecent_keys_ring))
|
|
|
3333 {
|
|
|
3334 Vrecent_keys_ring = new_vector;
|
|
|
3335 return size;
|
|
|
3336 }
|
|
|
3337
|
|
|
3338 if (NILP (vector_data (XVECTOR (Vrecent_keys_ring))[recent_keys_ring_index]))
|
|
|
3339 /* This means the vector has not yet wrapped */
|
|
|
3340 {
|
|
|
3341 nkeys = recent_keys_ring_index;
|
|
|
3342 start = 0;
|
|
|
3343 }
|
|
|
3344 else
|
|
|
3345 {
|
|
|
3346 nkeys = recent_keys_ring_size;
|
|
|
3347 start = ((recent_keys_ring_index == nkeys) ? 0 : recent_keys_ring_index);
|
|
|
3348 }
|
|
|
3349
|
|
|
3350 if (XINT (size) > nkeys)
|
|
|
3351 min = nkeys;
|
|
|
3352 else
|
|
|
3353 min = XINT (size);
|
|
|
3354
|
|
|
3355 for (i = 0, j = start; i < min; i++)
|
|
|
3356 {
|
|
|
3357 vector_data (XVECTOR (new_vector))[i]
|
|
|
3358 = vector_data (XVECTOR (Vrecent_keys_ring))[j];
|
|
|
3359 if (++j >= recent_keys_ring_size)
|
|
|
3360 j = 0;
|
|
|
3361 }
|
|
|
3362 recent_keys_ring_size = XINT (size);
|
|
|
3363 recent_keys_ring_index = (i < recent_keys_ring_size) ? i : 0;
|
|
|
3364
|
|
|
3365 Vrecent_keys_ring = new_vector;
|
|
|
3366
|
|
|
3367 UNGCPRO;
|
|
|
3368 return size;
|
|
|
3369 }
|
|
|
3370
|
|
0
|
3371 /* Vthis_command_keys having value Qnil means that the next time
|
|
|
3372 push_this_command_keys is called, it should start over.
|
|
2
|
3373 The times at which the command-keys are reset
|
|
0
|
3374 (instead of merely being augmented) are pretty conterintuitive.
|
|
|
3375 (More specifically:
|
|
|
3376
|
|
|
3377 -- We do not reset this-command-keys when we finish reading a
|
|
|
3378 command. This is because some commands (e.g. C-u) act
|
|
|
3379 like command prefixes; they signal this by setting prefix-arg
|
|
|
3380 to non-nil.
|
|
|
3381 -- Therefore, we reset this-command-keys when we finish
|
|
110
|
3382 executing a command, unless prefix-arg is set.
|
|
0
|
3383 -- However, if we ever do a non-local exit out of a command
|
|
|
3384 loop (e.g. an error in a command), we need to reset
|
|
|
3385 this-command-keys. We do this by calling reset_this_command_keys()
|
|
|
3386 from cmdloop.c, whenever an error causes an invocation of the
|
|
|
3387 default error handler, and whenever there's a throw to top-level.)
|
|
|
3388 */
|
|
|
3389
|
|
|
3390 void
|
|
|
3391 reset_this_command_keys (Lisp_Object console, int clear_echo_area_p)
|
|
|
3392 {
|
|
|
3393 struct command_builder *command_builder =
|
|
|
3394 XCOMMAND_BUILDER (XCONSOLE (console)->command_builder);
|
|
|
3395
|
|
|
3396 reset_key_echo (command_builder, clear_echo_area_p);
|
|
|
3397
|
|
|
3398 deallocate_event_chain (Vthis_command_keys);
|
|
|
3399 Vthis_command_keys = Qnil;
|
|
|
3400 Vthis_command_keys_tail = Qnil;
|
|
|
3401
|
|
|
3402 reset_current_events (command_builder);
|
|
|
3403 }
|
|
|
3404
|
|
|
3405 static void
|
|
|
3406 push_this_command_keys (Lisp_Object event)
|
|
|
3407 {
|
|
|
3408 Lisp_Object new = Fmake_event ();
|
|
|
3409
|
|
|
3410 Fcopy_event (event, new);
|
|
|
3411 enqueue_event (new, &Vthis_command_keys, &Vthis_command_keys_tail);
|
|
|
3412 }
|
|
|
3413
|
|
|
3414 /* The following two functions are used in call-interactively,
|
|
|
3415 for the @ and e specifications. We used to just use
|
|
110
|
3416 `current-mouse-event' (i.e. the last mouse event in this-command-keys),
|
|
0
|
3417 but FSF does it more generally so we follow their lead. */
|
|
|
3418
|
|
|
3419 Lisp_Object
|
|
|
3420 extract_this_command_keys_nth_mouse_event (int n)
|
|
|
3421 {
|
|
|
3422 Lisp_Object event;
|
|
|
3423
|
|
|
3424 EVENT_CHAIN_LOOP (event, Vthis_command_keys)
|
|
|
3425 {
|
|
|
3426 if (EVENTP (event)
|
|
|
3427 && (XEVENT_TYPE (event) == button_press_event
|
|
|
3428 || XEVENT_TYPE (event) == button_release_event
|
|
|
3429 || XEVENT_TYPE (event) == misc_user_event))
|
|
|
3430 {
|
|
|
3431 if (!n)
|
|
|
3432 {
|
|
|
3433 /* must copy to avoid an abort() in next_event_internal() */
|
|
|
3434 if (!NILP (XEVENT_NEXT (event)))
|
|
|
3435 return Fcopy_event (event, Qnil);
|
|
|
3436 else
|
|
|
3437 return event;
|
|
|
3438 }
|
|
|
3439 n--;
|
|
|
3440 }
|
|
|
3441 }
|
|
|
3442
|
|
|
3443 return Qnil;
|
|
|
3444 }
|
|
|
3445
|
|
|
3446 Lisp_Object
|
|
|
3447 extract_vector_nth_mouse_event (Lisp_Object vector, int n)
|
|
|
3448 {
|
|
|
3449 int i;
|
|
|
3450
|
|
|
3451 for (i = 0; i < vector_length (XVECTOR (vector)); i++)
|
|
|
3452 {
|
|
|
3453 Lisp_Object event = vector_data (XVECTOR (vector))[i];
|
|
|
3454 if (EVENTP (event)
|
|
|
3455 && (XEVENT_TYPE (event) == button_press_event
|
|
|
3456 || XEVENT_TYPE (event) == button_release_event
|
|
|
3457 || XEVENT_TYPE (event) == misc_user_event))
|
|
|
3458 {
|
|
|
3459 if (!n)
|
|
|
3460 return event;
|
|
|
3461 n--;
|
|
|
3462 }
|
|
|
3463 }
|
|
|
3464
|
|
|
3465 return Qnil;
|
|
|
3466 }
|
|
|
3467
|
|
|
3468 static void
|
|
|
3469 push_recent_keys (Lisp_Object event)
|
|
|
3470 {
|
|
153
|
3471 Lisp_Object e;
|
|
|
3472
|
|
|
3473 if (NILP (Vrecent_keys_ring))
|
|
|
3474 Vrecent_keys_ring = make_vector (recent_keys_ring_size, Qnil);
|
|
|
3475
|
|
|
3476 e = vector_data (XVECTOR (Vrecent_keys_ring)) [recent_keys_ring_index];
|
|
0
|
3477
|
|
|
3478 if (NILP (e))
|
|
|
3479 {
|
|
|
3480 e = Fmake_event ();
|
|
153
|
3481 vector_data (XVECTOR (Vrecent_keys_ring)) [recent_keys_ring_index] = e;
|
|
0
|
3482 }
|
|
|
3483 Fcopy_event (event, e);
|
|
153
|
3484 if (++recent_keys_ring_index == recent_keys_ring_size)
|
|
0
|
3485 recent_keys_ring_index = 0;
|
|
|
3486 }
|
|
|
3487
|
|
|
3488
|
|
|
3489 static Lisp_Object
|
|
|
3490 current_events_into_vector (struct command_builder *command_builder)
|
|
|
3491 {
|
|
|
3492 Lisp_Object vector;
|
|
|
3493 Lisp_Object event;
|
|
|
3494 int n = event_chain_count (command_builder->current_events);
|
|
|
3495
|
|
|
3496 /* Copy the vector and the events in it. */
|
|
|
3497 /* No need to copy the events, since they're already copies, and
|
|
|
3498 nobody other than the command-builder has pointers to them */
|
|
|
3499 vector = make_vector (n, Qnil);
|
|
|
3500 n = 0;
|
|
|
3501 EVENT_CHAIN_LOOP (event, command_builder->current_events)
|
|
|
3502 vector_data (XVECTOR (vector))[n++] = event;
|
|
|
3503 reset_command_builder_event_chain (command_builder);
|
|
|
3504 return (vector);
|
|
|
3505 }
|
|
|
3506
|
|
|
3507
|
|
|
3508 /*
|
|
|
3509 Given the current state of the command builder and a new command event
|
|
|
3510 that has just been dispatched:
|
|
|
3511
|
|
|
3512 -- add the event to the event chain forming the current command
|
|
|
3513 (doing meta-translation as necessary)
|
|
2
|
3514 -- return the binding of this event chain; this will be one of:
|
|
0
|
3515 -- nil (there is no binding)
|
|
|
3516 -- a keymap (part of a command has been specified)
|
|
|
3517 -- a command (anything that satisfies `commandp'; this includes
|
|
|
3518 some symbols, lists, subrs, strings, vectors, and
|
|
|
3519 compiled-function objects)
|
|
|
3520 */
|
|
|
3521 static Lisp_Object
|
|
|
3522 lookup_command_event (struct command_builder *command_builder,
|
|
|
3523 Lisp_Object event, int allow_misc_user_events_p)
|
|
|
3524 {
|
|
|
3525 /* This function can GC */
|
|
|
3526 struct frame *f = selected_frame ();
|
|
|
3527 /* Clear output from previous command execution */
|
|
|
3528 if (!EQ (Qcommand, echo_area_status (f))
|
|
|
3529 /* but don't let mouse-up clear what mouse-down just printed */
|
|
|
3530 && (XEVENT (event)->event_type != button_release_event))
|
|
|
3531 clear_echo_area (f, Qnil, 0);
|
|
|
3532
|
|
|
3533 /* Add the given event to the command builder.
|
|
|
3534 Extra hack: this also updates the recent_keys_ring and Vthis_command_keys
|
|
|
3535 vectors to translate "ESC x" to "M-x" (for any "x" of course).
|
|
|
3536 */
|
|
|
3537 {
|
|
|
3538 Lisp_Object recent = command_builder->most_current_event;
|
|
|
3539
|
|
|
3540 if (EVENTP (recent)
|
|
|
3541 && event_matches_key_specifier_p (XEVENT (recent), Vmeta_prefix_char))
|
|
|
3542 {
|
|
|
3543 struct Lisp_Event *e;
|
|
|
3544 /* When we see a sequence like "ESC x", pretend we really saw "M-x".
|
|
|
3545 DoubleThink the recent-keys and this-command-keys as well. */
|
|
|
3546
|
|
|
3547 /* Modify the previous most-recently-pushed event on the command
|
|
|
3548 builder to be a copy of this one with the meta-bit set instead of
|
|
|
3549 pushing a new event.
|
|
|
3550 */
|
|
|
3551 Fcopy_event (event, recent);
|
|
|
3552 e = XEVENT (recent);
|
|
|
3553 if (e->event_type == key_press_event)
|
|
|
3554 e->event.key.modifiers |= MOD_META;
|
|
|
3555 else if (e->event_type == button_press_event
|
|
|
3556 || e->event_type == button_release_event)
|
|
|
3557 e->event.button.modifiers |= MOD_META;
|
|
|
3558 else
|
|
|
3559 abort ();
|
|
|
3560
|
|
|
3561 {
|
|
|
3562 int tckn = event_chain_count (Vthis_command_keys);
|
|
|
3563 if (tckn >= 2)
|
|
|
3564 /* ??? very strange if it's < 2. */
|
|
|
3565 this_command_keys_replace_suffix
|
|
|
3566 (event_chain_nth (Vthis_command_keys, tckn - 2),
|
|
|
3567 Fcopy_event (recent, Qnil));
|
|
|
3568 }
|
|
|
3569
|
|
|
3570 regenerate_echo_keys_from_this_command_keys (command_builder);
|
|
|
3571 }
|
|
|
3572 else
|
|
|
3573 {
|
|
|
3574 event = Fcopy_event (event, Fmake_event ());
|
|
|
3575
|
|
|
3576 command_builder_append_event (command_builder, event);
|
|
|
3577 }
|
|
|
3578 }
|
|
|
3579
|
|
|
3580 {
|
|
|
3581 Lisp_Object leaf = command_builder_find_leaf (command_builder,
|
|
|
3582 allow_misc_user_events_p);
|
|
|
3583 struct gcpro gcpro1;
|
|
|
3584 GCPRO1 (leaf);
|
|
|
3585
|
|
|
3586 if (KEYMAPP (leaf))
|
|
|
3587 {
|
|
|
3588 Lisp_Object prompt = Fkeymap_prompt (leaf, Qt);
|
|
|
3589 if (STRINGP (prompt))
|
|
|
3590 {
|
|
|
3591 /* Append keymap prompt to key echo buffer */
|
|
|
3592 int buf_index = command_builder->echo_buf_index;
|
|
14
|
3593 Bytecount len = XSTRING_LENGTH (prompt);
|
|
0
|
3594
|
|
|
3595 if (len + buf_index + 1 <= command_builder->echo_buf_length)
|
|
|
3596 {
|
|
|
3597 Bufbyte *echo = command_builder->echo_buf + buf_index;
|
|
14
|
3598 memcpy (echo, XSTRING_DATA (prompt), len);
|
|
0
|
3599 echo[len] = 0;
|
|
|
3600 }
|
|
|
3601 maybe_echo_keys (command_builder, 1);
|
|
|
3602 }
|
|
|
3603 else
|
|
|
3604 maybe_echo_keys (command_builder, 0);
|
|
|
3605 }
|
|
|
3606 else if (!NILP (leaf))
|
|
|
3607 {
|
|
|
3608 if (EQ (Qcommand, echo_area_status (f))
|
|
|
3609 && command_builder->echo_buf_index > 0)
|
|
|
3610 {
|
|
|
3611 /* If we had been echoing keys, echo the last one (without
|
|
|
3612 the trailing dash) and redisplay before executing the
|
|
|
3613 command. */
|
|
|
3614 command_builder->echo_buf[command_builder->echo_buf_index] = 0;
|
|
|
3615 maybe_echo_keys (command_builder, 1);
|
|
|
3616 Fsit_for (Qzero, Qt);
|
|
|
3617 }
|
|
|
3618 }
|
|
|
3619 RETURN_UNGCPRO (leaf);
|
|
|
3620 }
|
|
|
3621 }
|
|
|
3622
|
|
|
3623 static void
|
|
|
3624 execute_command_event (struct command_builder *command_builder,
|
|
|
3625 Lisp_Object event)
|
|
|
3626 {
|
|
|
3627 /* This function can GC */
|
|
|
3628 struct console *con = XCONSOLE (command_builder->console);
|
|
|
3629 struct gcpro gcpro1;
|
|
|
3630
|
|
|
3631 GCPRO1 (event); /* event may be freshly created */
|
|
|
3632 reset_current_events (command_builder);
|
|
|
3633
|
|
|
3634 if (XEVENT (event)->event_type == key_press_event)
|
|
|
3635 Vcurrent_mouse_event = Qnil;
|
|
|
3636 else if (XEVENT (event)->event_type == button_press_event
|
|
|
3637 || XEVENT (event)->event_type == button_release_event
|
|
|
3638 || XEVENT (event)->event_type == misc_user_event)
|
|
|
3639 Vcurrent_mouse_event = Fcopy_event (event, Qnil);
|
|
|
3640
|
|
|
3641 /* Store the last-command-event. The semantics of this is that it is
|
|
|
3642 the last event most recently involved in command-lookup.
|
|
|
3643 */
|
|
|
3644 if (!EVENTP (Vlast_command_event))
|
|
|
3645 Vlast_command_event = Fmake_event ();
|
|
|
3646 if (XEVENT (Vlast_command_event)->event_type == dead_event)
|
|
|
3647 {
|
|
|
3648 Vlast_command_event = Fmake_event ();
|
|
|
3649 error ("Someone deallocated the last-command-event!");
|
|
|
3650 }
|
|
|
3651
|
|
|
3652 if (! EQ (event, Vlast_command_event))
|
|
|
3653 Fcopy_event (event, Vlast_command_event);
|
|
|
3654
|
|
|
3655 /* Note that last-command-char will never have its high-bit set, in
|
|
|
3656 an effort to sidestep the ambiguity between M-x and oslash.
|
|
|
3657 */
|
|
|
3658 Vlast_command_char = Fevent_to_character (Vlast_command_event,
|
|
|
3659 Qnil, Qnil, Qnil);
|
|
|
3660
|
|
|
3661 /* Actually call the command, with all sorts of hair to preserve or clear
|
|
|
3662 the echo-area and region as appropriate and call the pre- and post-
|
|
|
3663 command-hooks.
|
|
|
3664 */
|
|
|
3665 {
|
|
|
3666 int old_kbd_macro = con->kbd_macro_end;
|
|
|
3667 struct window *w;
|
|
|
3668
|
|
|
3669 w = XWINDOW (Fselected_window (Qnil));
|
|
|
3670
|
|
2
|
3671 /* We're executing a new command, so the old value is irrelevant. */
|
|
0
|
3672 zmacs_region_stays = 0;
|
|
|
3673
|
|
|
3674 /* If the previous command tried to force a specific window-start,
|
|
|
3675 reset the flag in case this command moves point far away from
|
|
|
3676 that position. Also, reset the window's buffer's change
|
|
|
3677 information so that we don't trigger an incremental update. */
|
|
|
3678 if (w->force_start)
|
|
|
3679 {
|
|
|
3680 w->force_start = 0;
|
|
|
3681 buffer_reset_changes (XBUFFER (w->buffer));
|
|
|
3682 }
|
|
|
3683
|
|
|
3684 pre_command_hook ();
|
|
|
3685
|
|
|
3686 if (XEVENT (event)->event_type == misc_user_event)
|
|
|
3687 {
|
|
|
3688 call1 (XEVENT (event)->event.eval.function,
|
|
|
3689 XEVENT (event)->event.eval.object);
|
|
|
3690 }
|
|
|
3691 else
|
|
|
3692 {
|
|
|
3693 #if 0
|
|
|
3694 call3 (Qcommand_execute, Vthis_command, Qnil, Qnil);
|
|
|
3695 #else
|
|
|
3696 Fcommand_execute (Vthis_command, Qnil, Qnil);
|
|
|
3697 #endif
|
|
|
3698 }
|
|
|
3699
|
|
|
3700 post_command_hook ();
|
|
|
3701
|
|
|
3702 if (!NILP (con->prefix_arg))
|
|
|
3703 {
|
|
|
3704 /* Commands that set the prefix arg don't update last-command, don't
|
|
|
3705 reset the echoing state, and don't go into keyboard macros unless
|
|
|
3706 followed by another command.
|
|
|
3707 */
|
|
|
3708 maybe_echo_keys (command_builder, 0);
|
|
|
3709
|
|
|
3710 /* If we're recording a keyboard macro, and the last command
|
|
|
3711 executed set a prefix argument, then decrement the pointer to
|
|
|
3712 the "last character really in the macro" to be just before this
|
|
|
3713 command. This is so that the ^U in "^U ^X )" doesn't go onto
|
|
|
3714 the end of macro.
|
|
|
3715 */
|
|
|
3716 if (!NILP (con->defining_kbd_macro))
|
|
|
3717 con->kbd_macro_end = old_kbd_macro;
|
|
|
3718 }
|
|
|
3719 else
|
|
|
3720 {
|
|
|
3721 /* Start a new command next time */
|
|
|
3722 Vlast_command = Vthis_command;
|
|
|
3723 /* Emacs 18 doesn't unconditionally clear the echoed keystrokes,
|
|
|
3724 so we don't either */
|
|
|
3725 reset_this_command_keys (make_console (con), 0);
|
|
|
3726 }
|
|
|
3727 }
|
|
|
3728
|
|
|
3729 UNGCPRO;
|
|
|
3730 }
|
|
|
3731
|
|
|
3732 /* Run the pre command hook. */
|
|
|
3733
|
|
|
3734 static void
|
|
|
3735 pre_command_hook (void)
|
|
|
3736 {
|
|
|
3737 last_point_position = BUF_PT (current_buffer);
|
|
|
3738 XSETBUFFER (last_point_position_buffer, current_buffer);
|
|
|
3739 /* This function can GC */
|
|
|
3740 safe_run_hook_trapping_errors
|
|
|
3741 ("Error in `pre-command-hook' (setting hook to nil)",
|
|
|
3742 Qpre_command_hook, 1);
|
|
|
3743 }
|
|
|
3744
|
|
|
3745 /* Run the post command hook. */
|
|
|
3746
|
|
|
3747 static void
|
|
|
3748 post_command_hook (void)
|
|
|
3749 {
|
|
|
3750 /* This function can GC */
|
|
|
3751 /* Turn off region highlighting unless this command requested that
|
|
|
3752 it be left on, or we're in the minibuffer. We don't turn it off
|
|
|
3753 when we're in the minibuffer so that things like M-x write-region
|
|
|
3754 still work!
|
|
|
3755
|
|
|
3756 This could be done via a function on the post-command-hook, but
|
|
|
3757 we don't want the user to accidentally remove it.
|
|
|
3758 */
|
|
2
|
3759
|
|
|
3760 Lisp_Object win = Fselected_window (Qnil);
|
|
|
3761
|
|
|
3762 #if 0
|
|
|
3763 /* If the last command deleted the frame, `win' might be nil.
|
|
|
3764 It seems safest to do nothing in this case. */
|
|
|
3765 /* ### This doesn't really fix the problem,
|
|
|
3766 if delete-frame is called by some hook */
|
|
|
3767 if (NILP (win))
|
|
|
3768 return;
|
|
|
3769 #endif
|
|
|
3770
|
|
0
|
3771 if (! zmacs_region_stays
|
|
2
|
3772 && (!MINI_WINDOW_P (XWINDOW (win))
|
|
|
3773 || EQ (zmacs_region_buffer (), WINDOW_BUFFER (XWINDOW (win)))))
|
|
0
|
3774 zmacs_deactivate_region ();
|
|
|
3775 else
|
|
|
3776 zmacs_update_region ();
|
|
|
3777
|
|
|
3778 safe_run_hook_trapping_errors
|
|
|
3779 ("Error in `post-command-hook' (setting hook to nil)",
|
|
|
3780 Qpost_command_hook, 1);
|
|
|
3781
|
|
|
3782 #ifdef DEFERRED_ACTION_CRAP
|
|
|
3783 if (!NILP (Vdeferred_action_list))
|
|
|
3784 call0 (Vdeferred_action_function);
|
|
|
3785 #endif
|
|
|
3786
|
|
|
3787 #ifdef ILL_CONCEIVED_HOOK
|
|
|
3788 if (NILP (Vunread_command_events)
|
|
|
3789 && NILP (Vexecuting_macro)
|
|
|
3790 && !NILP (Vpost_command_idle_hook)
|
|
|
3791 && !NILP (Fsit_for (make_float ((double) post_command_idle_delay
|
|
|
3792 / 1000000), Qnil)))
|
|
|
3793 safe_run_hook_trapping_errors
|
|
|
3794 ("Error in `post-command-idle-hook' (setting hook to nil)",
|
|
|
3795 Qpost_command_idle_hook, 1);
|
|
|
3796 #endif
|
|
|
3797
|
|
|
3798 #if 0 /* FSFmacs */
|
|
|
3799 if (!NILP (current_buffer->mark_active))
|
|
|
3800 {
|
|
|
3801 if (!NILP (Vdeactivate_mark) && !NILP (Vtransient_mark_mode))
|
|
|
3802 {
|
|
|
3803 current_buffer->mark_active = Qnil;
|
|
|
3804 run_hook (intern ("deactivate-mark-hook"));
|
|
|
3805 }
|
|
|
3806 else if (current_buffer != prev_buffer ||
|
|
|
3807 BUF_MODIFF (current_buffer) != prev_modiff)
|
|
|
3808 run_hook (intern ("activate-mark-hook"));
|
|
|
3809 }
|
|
|
3810 #endif /* FSFmacs */
|
|
|
3811
|
|
|
3812 /* #### Kludge!!! This is necessary to make sure that things
|
|
|
3813 are properly positioned even if post-command-hook moves point.
|
|
|
3814 #### There should be a cleaner way of handling this. */
|
|
|
3815 call0 (Qauto_show_make_point_visible);
|
|
|
3816 }
|
|
|
3817
|
|
|
3818
|
|
20
|
3819 DEFUN ("dispatch-event", Fdispatch_event, 1, 1, 0, /*
|
|
0
|
3820 Given an event object as returned by `next-event', execute it.
|
|
|
3821
|
|
|
3822 Key-press, button-press, and button-release events get accumulated
|
|
|
3823 until a complete key sequence (see `read-key-sequence') is reached,
|
|
|
3824 at which point the sequence is looked up in the current keymaps and
|
|
|
3825 acted upon.
|
|
|
3826
|
|
|
3827 Mouse motion events cause the low-level handling function stored in
|
|
|
3828 `mouse-motion-handler' to be called. (There are very few circumstances
|
|
|
3829 under which you should change this handler. Use `mode-motion-hook'
|
|
|
3830 instead.)
|
|
|
3831
|
|
|
3832 Menu, timeout, and eval events cause the associated function or handler
|
|
|
3833 to be called.
|
|
|
3834
|
|
|
3835 Process events cause the subprocess's output to be read and acted upon
|
|
|
3836 appropriately (see `start-process').
|
|
|
3837
|
|
|
3838 Magic events are handled as necessary.
|
|
20
|
3839 */
|
|
|
3840 (event))
|
|
0
|
3841 {
|
|
|
3842 /* This function can GC */
|
|
|
3843 struct command_builder *command_builder;
|
|
|
3844 struct Lisp_Event *ev;
|
|
|
3845 Lisp_Object console;
|
|
|
3846 Lisp_Object channel;
|
|
|
3847
|
|
|
3848 CHECK_LIVE_EVENT (event);
|
|
|
3849 ev = XEVENT (event);
|
|
|
3850
|
|
|
3851 /* events on dead channels get silently eaten */
|
|
|
3852 channel = EVENT_CHANNEL (ev);
|
|
|
3853 if (object_dead_p (channel))
|
|
|
3854 return Qnil;
|
|
|
3855
|
|
|
3856 /* Some events don't have channels (e.g. eval events). */
|
|
|
3857 console = CDFW_CONSOLE (channel);
|
|
|
3858 if (NILP (console))
|
|
|
3859 console = Vselected_console;
|
|
|
3860 else if (!EQ (console, Vselected_console))
|
|
|
3861 Fselect_console (console);
|
|
|
3862
|
|
|
3863 command_builder = XCOMMAND_BUILDER (XCONSOLE (console)->command_builder);
|
|
|
3864 switch (XEVENT (event)->event_type)
|
|
|
3865 {
|
|
|
3866 case button_press_event:
|
|
|
3867 case button_release_event:
|
|
|
3868 case key_press_event:
|
|
|
3869 {
|
|
|
3870 Lisp_Object leaf;
|
|
|
3871
|
|
|
3872 leaf = lookup_command_event (command_builder, event, 1);
|
|
|
3873 if (KEYMAPP (leaf))
|
|
|
3874 /* Incomplete key sequence */
|
|
|
3875 break;
|
|
|
3876 if (NILP (leaf))
|
|
|
3877 {
|
|
|
3878 /* At this point, we know that the sequence is not bound to a
|
|
|
3879 command. Normally, we beep and print a message informing the
|
|
|
3880 user of this. But we do not beep or print a message when:
|
|
|
3881
|
|
|
3882 o the last event in this sequence is a mouse-up event; or
|
|
|
3883 o the last event in this sequence is a mouse-down event and
|
|
|
3884 there is a binding for the mouse-up version.
|
|
|
3885
|
|
|
3886 That is, if the sequence ``C-x button1'' is typed, and is not
|
|
|
3887 bound to a command, but the sequence ``C-x button1up'' is bound
|
|
|
3888 to a command, we do not complain about the ``C-x button1''
|
|
|
3889 sequence. If neither ``C-x button1'' nor ``C-x button1up'' is
|
|
|
3890 bound to a command, then we complain about the ``C-x button1''
|
|
|
3891 sequence, but later will *not* complain about the
|
|
|
3892 ``C-x button1up'' sequence, which would be redundant.
|
|
|
3893
|
|
|
3894 This is pretty hairy, but I think it's the most intuitive
|
|
|
3895 behavior.
|
|
|
3896 */
|
|
|
3897 Lisp_Object terminal = command_builder->most_current_event;
|
|
|
3898
|
|
|
3899 if (XEVENT_TYPE (terminal) == button_press_event)
|
|
|
3900 {
|
|
|
3901 int no_bitching;
|
|
|
3902 /* Temporarily pretend the last event was an "up" instead of a
|
|
|
3903 "down", and look up its binding. */
|
|
|
3904 XEVENT_TYPE (terminal) = button_release_event;
|
|
|
3905 /* If the "up" version is bound, don't complain. */
|
|
|
3906 no_bitching
|
|
|
3907 = !NILP (command_builder_find_leaf
|
|
|
3908 (command_builder, 0));
|
|
|
3909 /* Undo the temporary changes we just made. */
|
|
|
3910 XEVENT_TYPE (terminal) = button_press_event;
|
|
|
3911 if (no_bitching)
|
|
|
3912 {
|
|
|
3913 /* Pretend this press was not seen (treat as a prefix) */
|
|
|
3914 if (EQ (command_builder->current_events, terminal))
|
|
|
3915 {
|
|
|
3916 reset_current_events (command_builder);
|
|
|
3917 }
|
|
|
3918 else
|
|
|
3919 {
|
|
|
3920 Lisp_Object eve;
|
|
|
3921
|
|
|
3922 EVENT_CHAIN_LOOP (eve, command_builder->current_events)
|
|
|
3923 if (EQ (XEVENT_NEXT (eve), terminal))
|
|
|
3924 break;
|
|
|
3925
|
|
|
3926 Fdeallocate_event (command_builder->
|
|
|
3927 most_current_event);
|
|
|
3928 XSET_EVENT_NEXT (eve, Qnil);
|
|
|
3929 command_builder->most_current_event = eve;
|
|
|
3930 }
|
|
|
3931 maybe_echo_keys (command_builder, 1);
|
|
|
3932 break;
|
|
|
3933 }
|
|
|
3934 }
|
|
|
3935
|
|
|
3936 /* Complain that the typed sequence is not defined, if this is the
|
|
|
3937 kind of sequence that warrants a complaint.
|
|
|
3938 */
|
|
|
3939 XCONSOLE (console)->defining_kbd_macro = Qnil;
|
|
|
3940 XCONSOLE (console)->prefix_arg = Qnil;
|
|
|
3941 /* Don't complain about undefined button-release events */
|
|
|
3942 if (XEVENT_TYPE (terminal) != button_release_event)
|
|
|
3943 {
|
|
|
3944 Lisp_Object keys =
|
|
|
3945 current_events_into_vector (command_builder);
|
|
|
3946 struct gcpro gcpro1;
|
|
|
3947
|
|
|
3948 /* Run the pre-command-hook before barfing about an undefined
|
|
|
3949 key. */
|
|
|
3950 Vthis_command = Qnil;
|
|
|
3951 GCPRO1 (keys);
|
|
|
3952 pre_command_hook ();
|
|
|
3953 UNGCPRO;
|
|
|
3954 /* The post-command-hook doesn't run. */
|
|
|
3955 Fsignal (Qundefined_keystroke_sequence, list1 (keys));
|
|
|
3956 }
|
|
|
3957 /* Reset the command builder for reading the next sequence. */
|
|
|
3958 reset_this_command_keys (console, 1);
|
|
|
3959 }
|
|
2
|
3960 else /* key sequence is bound to a command */
|
|
0
|
3961 {
|
|
|
3962 Vthis_command = leaf;
|
|
|
3963 /* Don't push an undo boundary if the command set the prefix arg,
|
|
|
3964 or if we are executing a keyboard macro, or if in the
|
|
|
3965 minibuffer. If the command we are about to execute is
|
|
|
3966 self-insert, it's tricky: up to 20 consecutive self-inserts may
|
|
|
3967 be done without an undo boundary. This counter is reset as
|
|
|
3968 soon as a command other than self-insert-command is executed.
|
|
|
3969 */
|
|
|
3970 if (! EQ (leaf, Qself_insert_command))
|
|
|
3971 command_builder->self_insert_countdown = 0;
|
|
|
3972 if (NILP (XCONSOLE (console)->prefix_arg)
|
|
|
3973 && NILP (Vexecuting_macro)
|
|
|
3974 #if 0
|
|
|
3975 /* This was done in the days when there was no undo
|
|
|
3976 in the minibuffer. If we don't disable this code,
|
|
|
3977 then each instance of "undo" undoes everything in
|
|
|
3978 the minibuffer. */
|
|
|
3979 && !EQ (minibuf_window, Fselected_window (Qnil))
|
|
|
3980 #endif
|
|
|
3981 && command_builder->self_insert_countdown == 0)
|
|
|
3982 Fundo_boundary ();
|
|
|
3983
|
|
|
3984 if (EQ (leaf, Qself_insert_command))
|
|
|
3985 {
|
|
|
3986 if (--command_builder->self_insert_countdown < 0)
|
|
|
3987 command_builder->self_insert_countdown = 20;
|
|
|
3988 }
|
|
2
|
3989 execute_command_event
|
|
|
3990 (command_builder,
|
|
|
3991 !NILP (Fequal (event, command_builder-> most_current_event))
|
|
|
3992 ? event
|
|
|
3993 /* Use the translated event that was most recently seen.
|
|
|
3994 This way, last-command-event becomes f1 instead of
|
|
|
3995 the P from ESC O P. But we must copy it, else we'll
|
|
|
3996 lose when the command-builder events are deallocated. */
|
|
|
3997 : Fcopy_event (command_builder-> most_current_event, Qnil));
|
|
0
|
3998 }
|
|
|
3999 break;
|
|
|
4000 }
|
|
|
4001 case misc_user_event:
|
|
|
4002 {
|
|
|
4003 /* Jamie said:
|
|
|
4004
|
|
|
4005 We could just always use the menu item entry, whatever it is, but
|
|
|
4006 this might break some Lisp code that expects `this-command' to
|
|
|
4007 always contain a symbol. So only store it if this is a simple
|
|
|
4008 `call-interactively' sort of menu item.
|
|
|
4009
|
|
|
4010 But this is bogus. `this-command' could be a string or vector
|
|
|
4011 anyway (for keyboard macros). There's even one instance
|
|
|
4012 (in pending-del.el) of `this-command' getting set to a cons
|
|
|
4013 (a lambda expression). So in the `eval' case I'll just
|
|
|
4014 convert it into a lambda expression.
|
|
|
4015 */
|
|
|
4016 if (EQ (XEVENT (event)->event.eval.function, Qcall_interactively)
|
|
|
4017 && SYMBOLP (XEVENT (event)->event.eval.object))
|
|
|
4018 Vthis_command = XEVENT (event)->event.eval.object;
|
|
|
4019 else if (EQ (XEVENT (event)->event.eval.function, Qeval))
|
|
|
4020 Vthis_command =
|
|
|
4021 Fcons (Qlambda, Fcons (Qnil, XEVENT (event)->event.eval.object));
|
|
|
4022 else if (SYMBOLP (XEVENT (event)->event.eval.function))
|
|
|
4023 /* A scrollbar command or the like. */
|
|
|
4024 Vthis_command = XEVENT (event)->event.eval.function;
|
|
|
4025 else
|
|
|
4026 /* Huh? */
|
|
|
4027 Vthis_command = Qnil;
|
|
|
4028
|
|
|
4029 command_builder->self_insert_countdown = 0;
|
|
|
4030 if (NILP (XCONSOLE (console)->prefix_arg)
|
|
|
4031 && NILP (Vexecuting_macro)
|
|
|
4032 && !EQ (minibuf_window, Fselected_window (Qnil)))
|
|
|
4033 Fundo_boundary ();
|
|
|
4034 execute_command_event (command_builder, event);
|
|
|
4035 break;
|
|
|
4036 }
|
|
|
4037 default:
|
|
|
4038 {
|
|
|
4039 execute_internal_event (event);
|
|
|
4040 break;
|
|
|
4041 }
|
|
|
4042 }
|
|
|
4043 return (Qnil);
|
|
|
4044 }
|
|
|
4045
|
|
20
|
4046 DEFUN ("read-key-sequence", Fread_key_sequence, 1, 3, 0, /*
|
|
0
|
4047 Read a sequence of keystrokes or mouse clicks.
|
|
|
4048 Returns a vector of the event objects read. The vector and the event
|
|
|
4049 objects it contains are freshly created (and will not be side-effected
|
|
|
4050 by subsequent calls to this function).
|
|
|
4051
|
|
|
4052 The sequence read is sufficient to specify a non-prefix command starting
|
|
|
4053 from the current local and global keymaps. A C-g typed while in this
|
|
|
4054 function is treated like any other character, and `quit-flag' is not set.
|
|
|
4055
|
|
|
4056 First arg PROMPT is a prompt string. If nil, do not prompt specially.
|
|
98
|
4057 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echoes
|
|
0
|
4058 as a continuation of the previous key.
|
|
|
4059
|
|
|
4060 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
|
|
|
4061 convert the last event to lower case. (Normally any upper case event
|
|
|
4062 is converted to lower case if the original event is undefined and the lower
|
|
|
4063 case equivalent is defined.) This argument is provided mostly for
|
|
|
4064 FSF compatibility; the equivalent effect can be achieved more generally
|
|
|
4065 by binding `retry-undefined-key-binding-unshifted' to nil around the
|
|
|
4066 call to `read-key-sequence'.
|
|
|
4067
|
|
|
4068 A C-g typed while in this function is treated like any other character,
|
|
|
4069 and `quit-flag' is not set.
|
|
|
4070
|
|
|
4071 If the user selects a menu item while we are prompting for a key-sequence,
|
|
|
4072 the returned value will be a vector of a single menu-selection event.
|
|
|
4073 An error will be signalled if you pass this value to `lookup-key' or a
|
|
|
4074 related function.
|
|
|
4075
|
|
|
4076 `read-key-sequence' checks `function-key-map' for function key
|
|
|
4077 sequences, where they wouldn't conflict with ordinary bindings. See
|
|
|
4078 `function-key-map' for more details.
|
|
20
|
4079 */
|
|
|
4080 (prompt, continue_echo, dont_downcase_last))
|
|
0
|
4081 {
|
|
|
4082 /* This function can GC */
|
|
|
4083 struct console *con = XCONSOLE (Vselected_console); /* #### correct?
|
|
|
4084 Probably not -- see
|
|
|
4085 comment in
|
|
|
4086 next-event */
|
|
|
4087 struct command_builder *command_builder =
|
|
|
4088 XCOMMAND_BUILDER (con->command_builder);
|
|
|
4089 Lisp_Object result;
|
|
|
4090 Lisp_Object event = Fmake_event ();
|
|
|
4091 int speccount = specpdl_depth ();
|
|
|
4092 struct gcpro gcpro1;
|
|
|
4093 GCPRO1 (event);
|
|
|
4094
|
|
|
4095 if (!NILP (prompt))
|
|
|
4096 CHECK_STRING (prompt);
|
|
|
4097 /* else prompt = Fkeymap_prompt (current_buffer->keymap); may GC */
|
|
|
4098 QUIT;
|
|
|
4099
|
|
|
4100 if (NILP (continue_echo))
|
|
|
4101 reset_this_command_keys (make_console (con), 1);
|
|
|
4102
|
|
|
4103 specbind (Qinhibit_quit, Qt);
|
|
|
4104
|
|
|
4105 if (!NILP (dont_downcase_last))
|
|
|
4106 specbind (Qretry_undefined_key_binding_unshifted, Qnil);
|
|
|
4107
|
|
|
4108 for (;;)
|
|
|
4109 {
|
|
|
4110 Fnext_event (event, prompt);
|
|
|
4111 /* restore the selected-console damage */
|
|
|
4112 con = event_console_or_selected (event);
|
|
|
4113 command_builder = XCOMMAND_BUILDER (con->command_builder);
|
|
|
4114 if (! command_event_p (event))
|
|
|
4115 execute_internal_event (event);
|
|
|
4116 else
|
|
|
4117 {
|
|
|
4118 if (XEVENT (event)->event_type == misc_user_event)
|
|
|
4119 reset_current_events (command_builder);
|
|
|
4120 result = lookup_command_event (command_builder, event, 1);
|
|
|
4121 if (!KEYMAPP (result))
|
|
|
4122 {
|
|
|
4123 result = current_events_into_vector (command_builder);
|
|
|
4124 reset_key_echo (command_builder, 0);
|
|
|
4125 break;
|
|
|
4126 }
|
|
|
4127 prompt = Qnil;
|
|
|
4128 }
|
|
|
4129 }
|
|
|
4130
|
|
|
4131 Vquit_flag = Qnil; /* In case we read a ^G; do not call check_quit() here */
|
|
|
4132 Fdeallocate_event (event);
|
|
|
4133 RETURN_UNGCPRO (unbind_to (speccount, result));
|
|
|
4134 }
|
|
|
4135
|
|
20
|
4136 DEFUN ("this-command-keys", Fthis_command_keys, 0, 0, 0, /*
|
|
0
|
4137 Return a vector of the keyboard or mouse button events that were used
|
|
|
4138 to invoke this command. This copies the vector and the events; it is safe
|
|
|
4139 to keep and modify them.
|
|
20
|
4140 */
|
|
|
4141 ())
|
|
0
|
4142 {
|
|
|
4143 Lisp_Object event;
|
|
|
4144 Lisp_Object result;
|
|
|
4145 int len;
|
|
|
4146
|
|
|
4147 if (NILP (Vthis_command_keys))
|
|
|
4148 return (make_vector (0, Qnil));
|
|
|
4149
|
|
|
4150 len = event_chain_count (Vthis_command_keys);
|
|
|
4151
|
|
|
4152 result = make_vector (len, Qnil);
|
|
|
4153 len = 0;
|
|
|
4154 EVENT_CHAIN_LOOP (event, Vthis_command_keys)
|
|
|
4155 vector_data (XVECTOR (result))[len++] = Fcopy_event (event, Qnil);
|
|
|
4156 return (result);
|
|
|
4157 }
|
|
|
4158
|
|
20
|
4159 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths, 0, 0, 0, /*
|
|
0
|
4160 Used for complicated reasons in `universal-argument-other-key'.
|
|
|
4161
|
|
|
4162 `universal-argument-other-key' rereads the event just typed.
|
|
|
4163 It then gets translated through `function-key-map'.
|
|
|
4164 The translated event gets included in the echo area and in
|
|
|
4165 the value of `this-command-keys' in addition to the raw original event.
|
|
|
4166 That is not right.
|
|
|
4167
|
|
|
4168 Calling this function directs the translated event to replace
|
|
|
4169 the original event, so that only one version of the event actually
|
|
|
4170 appears in the echo area and in the value of `this-command-keys.'.
|
|
20
|
4171 */
|
|
|
4172 ())
|
|
0
|
4173 {
|
|
|
4174 /* #### I don't understand this at all, so currently it does nothing.
|
|
|
4175 If there is ever a problem, maybe someone should investigate. */
|
|
|
4176 return Qnil;
|
|
|
4177 }
|
|
|
4178
|
|
|
4179
|
|
|
4180 static void
|
|
|
4181 dribble_out_event (Lisp_Object event)
|
|
|
4182 {
|
|
|
4183 if (NILP (Vdribble_file))
|
|
|
4184 return;
|
|
|
4185
|
|
|
4186 if (XEVENT (event)->event_type == key_press_event &&
|
|
|
4187 !XEVENT (event)->event.key.modifiers)
|
|
|
4188 {
|
|
|
4189 Lisp_Object keysym = XEVENT (event)->event.key.keysym;
|
|
|
4190 if (CHARP (XEVENT (event)->event.key.keysym))
|
|
|
4191 {
|
|
|
4192 Emchar ch = XCHAR (keysym);
|
|
|
4193 Bufbyte str[MAX_EMCHAR_LEN];
|
|
|
4194 Bytecount len;
|
|
|
4195
|
|
|
4196 len = set_charptr_emchar (str, ch);
|
|
|
4197 Lstream_write (XLSTREAM (Vdribble_file), str, len);
|
|
|
4198 }
|
|
|
4199 else if (string_char_length (XSYMBOL (keysym)->name) == 1)
|
|
|
4200 /* one-char key events are printed with just the key name */
|
|
|
4201 Fprinc (keysym, Vdribble_file);
|
|
|
4202 else if (EQ (keysym, Qreturn))
|
|
|
4203 Lstream_putc (XLSTREAM (Vdribble_file), '\n');
|
|
|
4204 else if (EQ (keysym, Qspace))
|
|
|
4205 Lstream_putc (XLSTREAM (Vdribble_file), ' ');
|
|
|
4206 else
|
|
|
4207 Fprinc (event, Vdribble_file);
|
|
|
4208 }
|
|
|
4209 else
|
|
|
4210 Fprinc (event, Vdribble_file);
|
|
|
4211 Lstream_flush (XLSTREAM (Vdribble_file));
|
|
|
4212 }
|
|
|
4213
|
|
20
|
4214 DEFUN ("open-dribble-file", Fopen_dribble_file, 1, 1,
|
|
|
4215 "FOpen dribble file: ", /*
|
|
0
|
4216 Start writing all keyboard characters to a dribble file called FILE.
|
|
|
4217 If FILE is nil, close any open dribble file.
|
|
20
|
4218 */
|
|
|
4219 (file))
|
|
0
|
4220 {
|
|
|
4221 /* This function can GC */
|
|
|
4222 /* XEmacs change: always close existing dribble file. */
|
|
|
4223 /* FSFmacs uses FILE *'s here. With lstreams, that's unnecessary. */
|
|
|
4224 if (!NILP (Vdribble_file))
|
|
|
4225 {
|
|
|
4226 Lstream_close (XLSTREAM (Vdribble_file));
|
|
|
4227 Vdribble_file = Qnil;
|
|
|
4228 }
|
|
|
4229 if (!NILP (file))
|
|
|
4230 {
|
|
|
4231 int fd;
|
|
|
4232
|
|
|
4233 file = Fexpand_file_name (file, Qnil);
|
|
14
|
4234 fd = creat ((char *) XSTRING_DATA (file), 0666);
|
|
0
|
4235 if (fd < 0)
|
|
|
4236 error ("Unable to create dribble file");
|
|
|
4237 Vdribble_file = make_filedesc_output_stream (fd, 0, 0, LSTR_CLOSING);
|
|
70
|
4238 #ifdef MULE
|
|
|
4239 Vdribble_file =
|
|
|
4240 make_encoding_output_stream (XLSTREAM (Vdribble_file),
|
|
|
4241 Fget_coding_system (Qescape_quoted));
|
|
|
4242 #endif
|
|
0
|
4243 }
|
|
|
4244 return Qnil;
|
|
|
4245 }
|
|
|
4246
|
|
|
4247
|
|
|
4248 /************************************************************************/
|
|
|
4249 /* initialization */
|
|
|
4250 /************************************************************************/
|
|
|
4251
|
|
|
4252 void
|
|
|
4253 syms_of_event_stream (void)
|
|
|
4254 {
|
|
|
4255 defsymbol (&Qdisabled, "disabled");
|
|
|
4256 defsymbol (&Qcommand_event_p, "command-event-p");
|
|
|
4257
|
|
|
4258 deferror (&Qundefined_keystroke_sequence, "undefined-keystroke-sequence",
|
|
|
4259 "Undefined keystroke sequence", Qerror);
|
|
|
4260 defsymbol (&Qcommand_execute, "command-execute");
|
|
|
4261
|
|
20
|
4262 DEFSUBR (Frecent_keys);
|
|
153
|
4263 DEFSUBR (Frecent_keys_ring_size);
|
|
|
4264 DEFSUBR (Fset_recent_keys_ring_size);
|
|
20
|
4265 DEFSUBR (Finput_pending_p);
|
|
|
4266 DEFSUBR (Fenqueue_eval_event);
|
|
|
4267 DEFSUBR (Fnext_event);
|
|
|
4268 DEFSUBR (Fnext_command_event);
|
|
|
4269 DEFSUBR (Fdiscard_input);
|
|
|
4270 DEFSUBR (Fsit_for);
|
|
|
4271 DEFSUBR (Fsleep_for);
|
|
|
4272 DEFSUBR (Faccept_process_output);
|
|
|
4273 DEFSUBR (Fadd_timeout);
|
|
|
4274 DEFSUBR (Fdisable_timeout);
|
|
|
4275 DEFSUBR (Fadd_async_timeout);
|
|
|
4276 DEFSUBR (Fdisable_async_timeout);
|
|
|
4277 DEFSUBR (Fdispatch_event);
|
|
|
4278 DEFSUBR (Fread_key_sequence);
|
|
|
4279 DEFSUBR (Fthis_command_keys);
|
|
|
4280 DEFSUBR (Freset_this_command_lengths);
|
|
|
4281 DEFSUBR (Fopen_dribble_file);
|
|
0
|
4282
|
|
|
4283 defsymbol (&Qpre_command_hook, "pre-command-hook");
|
|
|
4284 defsymbol (&Qpost_command_hook, "post-command-hook");
|
|
|
4285 defsymbol (&Qunread_command_events, "unread-command-events");
|
|
|
4286 defsymbol (&Qunread_command_event, "unread-command-event");
|
|
|
4287 defsymbol (&Qpre_idle_hook, "pre-idle-hook");
|
|
|
4288 #ifdef ILL_CONCEIVED_HOOK
|
|
|
4289 defsymbol (&Qpost_command_idle_hook, "post-command-idle-hook");
|
|
|
4290 #endif
|
|
|
4291 #ifdef DEFERRED_ACTION_CRAP
|
|
|
4292 defsymbol (&Qdeferred_action_function, "deferred-action-function");
|
|
|
4293 #endif
|
|
|
4294 defsymbol (&Qretry_undefined_key_binding_unshifted,
|
|
|
4295 "retry-undefined-key-binding-unshifted");
|
|
|
4296 defsymbol (&Qauto_show_make_point_visible,
|
|
|
4297 "auto-show-make-point-visible");
|
|
|
4298 }
|
|
|
4299
|
|
|
4300 void
|
|
|
4301 vars_of_event_stream (void)
|
|
|
4302 {
|
|
|
4303 #ifdef HAVE_X_WINDOWS
|
|
|
4304 vars_of_event_Xt ();
|
|
|
4305 #endif
|
|
|
4306 #if defined (DEBUG_TTY_EVENT_STREAM) || !defined (HAVE_X_WINDOWS)
|
|
|
4307 vars_of_event_tty ();
|
|
|
4308 #endif
|
|
|
4309
|
|
|
4310
|
|
|
4311 recent_keys_ring_index = 0;
|
|
153
|
4312 recent_keys_ring_size = 100;
|
|
|
4313 Vrecent_keys_ring = Qnil;
|
|
|
4314 staticpro (&Vrecent_keys_ring);
|
|
0
|
4315
|
|
|
4316 Vthis_command_keys = Qnil;
|
|
|
4317 staticpro (&Vthis_command_keys);
|
|
|
4318 Vthis_command_keys_tail = Qnil;
|
|
|
4319
|
|
|
4320 num_input_chars = 0;
|
|
|
4321
|
|
|
4322 command_event_queue = Qnil;
|
|
|
4323 staticpro (&command_event_queue);
|
|
|
4324 command_event_queue_tail = Qnil;
|
|
|
4325
|
|
|
4326 Vlast_selected_frame = Qnil;
|
|
|
4327 staticpro (&Vlast_selected_frame);
|
|
|
4328
|
|
|
4329 pending_timeout_list = Qnil;
|
|
|
4330 staticpro (&pending_timeout_list);
|
|
|
4331
|
|
|
4332 pending_async_timeout_list = Qnil;
|
|
|
4333 staticpro (&pending_async_timeout_list);
|
|
|
4334
|
|
|
4335 Vtimeout_free_list = make_opaque_list (sizeof (struct timeout),
|
|
|
4336 mark_timeout);
|
|
|
4337 staticpro (&Vtimeout_free_list);
|
|
|
4338
|
|
|
4339 the_low_level_timeout_blocktype =
|
|
|
4340 Blocktype_new (struct low_level_timeout_blocktype);
|
|
|
4341
|
|
|
4342 something_happened = 0;
|
|
|
4343
|
|
|
4344 last_point_position_buffer = Qnil;
|
|
|
4345 staticpro (&last_point_position_buffer);
|
|
|
4346
|
|
108
|
4347 recursive_sit_for = Qnil;
|
|
|
4348
|
|
0
|
4349 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes /*
|
|
|
4350 *Nonzero means echo unfinished commands after this many seconds of pause.
|
|
|
4351 */ );
|
|
|
4352 echo_keystrokes = 1;
|
|
|
4353
|
|
|
4354 DEFVAR_INT ("auto-save-interval", &auto_save_interval /*
|
|
|
4355 *Number of keyboard input characters between auto-saves.
|
|
|
4356 Zero means disable autosaving due to number of characters typed.
|
|
|
4357 See also the variable `auto-save-timeout'.
|
|
|
4358 */ );
|
|
|
4359 auto_save_interval = 300;
|
|
|
4360
|
|
|
4361 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook /*
|
|
|
4362 Function or functions to run before every command.
|
|
|
4363 This may examine the `this-command' variable to find out what command
|
|
|
4364 is about to be run, or may change it to cause a different command to run.
|
|
|
4365 Function on this hook must be careful to avoid signalling errors!
|
|
|
4366 */ );
|
|
|
4367 Vpre_command_hook = Qnil;
|
|
|
4368
|
|
|
4369 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook /*
|
|
|
4370 Function or functions to run after every command.
|
|
|
4371 This may examine the `this-command' variable to find out what command
|
|
|
4372 was just executed.
|
|
|
4373 */ );
|
|
|
4374 Vpost_command_hook = Qnil;
|
|
|
4375
|
|
|
4376 DEFVAR_LISP ("pre-idle-hook", &Vpre_idle_hook /*
|
|
|
4377 Normal hook run when XEmacs it about to be idle.
|
|
|
4378 This occurs whenever it is going to block, waiting for an event.
|
|
|
4379 This generally happens as a result of a call to `next-event',
|
|
|
4380 `next-command-event', `sit-for', `sleep-for', `accept-process-output',
|
|
|
4381 `x-get-selection', or various Energize-specific commands.
|
|
|
4382 Errors running the hook are caught and ignored.
|
|
|
4383 */ );
|
|
|
4384 Vpre_idle_hook = Qnil;
|
|
|
4385
|
|
72
|
4386 DEFVAR_BOOL ("focus-follows-mouse", &focus_follows_mouse /*
|
|
142
|
4387 *Variable to control XEmacs behavior with respect to focus changing.
|
|
72
|
4388 If this variable is set to t, then XEmacs will not gratuitously change
|
|
142
|
4389 the keyboard focus. XEmacs cannot in general detect when this mode is
|
|
|
4390 use by the window manager, so it is up to the user to set it.
|
|
72
|
4391 */ );
|
|
|
4392 focus_follows_mouse = 0;
|
|
|
4393
|
|
0
|
4394 #ifdef ILL_CONCEIVED_HOOK
|
|
|
4395 /* Ill-conceived because it's not run in all sorts of cases
|
|
|
4396 where XEmacs is blocking. That's what `pre-idle-hook'
|
|
|
4397 is designed to solve. */
|
|
|
4398 xxDEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook /*
|
|
|
4399 Normal hook run after each command is executed, if idle.
|
|
|
4400 `post-command-idle-delay' specifies a time in microseconds that XEmacs
|
|
|
4401 must be idle for in order for the functions on this hook to be called.
|
|
|
4402 Errors running the hook are caught and ignored.
|
|
|
4403 */ );
|
|
|
4404 Vpost_command_idle_hook = Qnil;
|
|
|
4405
|
|
|
4406 xxDEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay /*
|
|
|
4407 Delay time before running `post-command-idle-hook'.
|
|
|
4408 This is measured in microseconds.
|
|
|
4409 */ );
|
|
|
4410 post_command_idle_delay = 5000;
|
|
|
4411 #endif /* ILL_CONCEIVED_HOOK */
|
|
|
4412
|
|
|
4413 #ifdef DEFERRED_ACTION_CRAP
|
|
|
4414 /* Random FSFmacs crap. There is absolutely nothing to gain,
|
|
|
4415 and a great deal to lose, in using this in place of just
|
|
|
4416 setting `post-command-hook'. */
|
|
|
4417 xxDEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list /*
|
|
|
4418 List of deferred actions to be performed at a later time.
|
|
|
4419 The precise format isn't relevant here; we just check whether it is nil.
|
|
|
4420 */ );
|
|
|
4421 Vdeferred_action_list = Qnil;
|
|
|
4422
|
|
|
4423 xxDEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function /*
|
|
|
4424 Function to call to handle deferred actions, after each command.
|
|
|
4425 This function is called with no arguments after each command
|
|
|
4426 whenever `deferred-action-list' is non-nil.
|
|
|
4427 */ );
|
|
|
4428 Vdeferred_action_function = Qnil;
|
|
|
4429 #endif /* DEFERRED_ACTION_CRAP */
|
|
|
4430
|
|
|
4431 DEFVAR_LISP ("last-command-event", &Vlast_command_event /*
|
|
|
4432 Last keyboard or mouse button event that was part of a command. This
|
|
|
4433 variable is off limits: you may not set its value or modify the event that
|
|
|
4434 is its value, as it is destructively modified by `read-key-sequence'. If
|
|
|
4435 you want to keep a pointer to this value, you must use `copy-event'.
|
|
|
4436 */ );
|
|
|
4437 Vlast_command_event = Qnil;
|
|
|
4438
|
|
|
4439 DEFVAR_LISP ("last-command-char", &Vlast_command_char /*
|
|
|
4440 If the value of `last-command-event' is a keyboard event, then
|
|
2
|
4441 this is the nearest ASCII equivalent to it. This is the value that
|
|
0
|
4442 `self-insert-command' will put in the buffer. Remember that there is
|
|
|
4443 NOT a 1:1 mapping between keyboard events and ASCII characters: the set
|
|
|
4444 of keyboard events is much larger, so writing code that examines this
|
|
|
4445 variable to determine what key has been typed is bad practice, unless
|
|
|
4446 you are certain that it will be one of a small set of characters.
|
|
|
4447 */ );
|
|
|
4448 Vlast_command_char = Qnil;
|
|
|
4449
|
|
|
4450 DEFVAR_LISP ("last-input-event", &Vlast_input_event /*
|
|
|
4451 Last keyboard or mouse button event received. This variable is off
|
|
|
4452 limits: you may not set its value or modify the event that is its value, as
|
|
|
4453 it is destructively modified by `next-event'. If you want to keep a pointer
|
|
|
4454 to this value, you must use `copy-event'.
|
|
|
4455 */ );
|
|
|
4456 Vlast_input_event = Qnil;
|
|
|
4457
|
|
|
4458 DEFVAR_LISP ("current-mouse-event", &Vcurrent_mouse_event /*
|
|
|
4459 The mouse-button event which invoked this command, or nil.
|
|
|
4460 This is usually what `(interactive \"e\")' returns.
|
|
|
4461 */ );
|
|
|
4462 Vcurrent_mouse_event = Qnil;
|
|
|
4463
|
|
|
4464 DEFVAR_LISP ("last-input-char", &Vlast_input_char /*
|
|
|
4465 If the value of `last-input-event' is a keyboard event, then
|
|
|
4466 this is the nearest ASCII equivalent to it. Remember that there is
|
|
|
4467 NOT a 1:1 mapping between keyboard events and ASCII characters: the set
|
|
|
4468 of keyboard events is much larger, so writing code that examines this
|
|
|
4469 variable to determine what key has been typed is bad practice, unless
|
|
|
4470 you are certain that it will be one of a small set of characters.
|
|
|
4471 */ );
|
|
|
4472 Vlast_input_char = Qnil;
|
|
|
4473
|
|
|
4474 DEFVAR_LISP ("last-input-time", &Vlast_input_time /*
|
|
|
4475 The time (in seconds since Jan 1, 1970) of the last-command-event,
|
|
|
4476 represented as a cons of two 16-bit integers. This is destructively
|
|
|
4477 modified, so copy it if you want to keep it.
|
|
|
4478 */ );
|
|
|
4479 Vlast_input_time = Qnil;
|
|
|
4480
|
|
|
4481 DEFVAR_LISP ("unread-command-events", &Vunread_command_events /*
|
|
|
4482 List of event objects to be read as next command input events.
|
|
|
4483 This can be used to simulate the receipt of events from the user.
|
|
|
4484 Normally this is nil.
|
|
|
4485 Events are removed from the front of this list.
|
|
|
4486 */ );
|
|
|
4487 Vunread_command_events = Qnil;
|
|
|
4488
|
|
|
4489 DEFVAR_LISP ("unread-command-event", &Vunread_command_event /*
|
|
|
4490 Obsolete. Use `unread-command-events' instead.
|
|
|
4491 */ );
|
|
|
4492 Vunread_command_event = Qnil;
|
|
|
4493
|
|
|
4494 DEFVAR_LISP ("last-command", &Vlast_command /*
|
|
|
4495 The last command executed. Normally a symbol with a function definition,
|
|
|
4496 but can be whatever was found in the keymap, or whatever the variable
|
|
|
4497 `this-command' was set to by that command.
|
|
|
4498 */ );
|
|
|
4499 Vlast_command = Qnil;
|
|
|
4500
|
|
|
4501 DEFVAR_LISP ("this-command", &Vthis_command /*
|
|
|
4502 The command now being executed.
|
|
|
4503 The command can set this variable; whatever is put here
|
|
|
4504 will be in `last-command' during the following command.
|
|
|
4505 */ );
|
|
|
4506 Vthis_command = Qnil;
|
|
|
4507
|
|
|
4508 DEFVAR_LISP ("help-char", &Vhelp_char /*
|
|
|
4509 Character to recognize as meaning Help.
|
|
|
4510 When it is read, do `(eval help-form)', and display result if it's a string.
|
|
|
4511 If the value of `help-form' is nil, this char can be read normally.
|
|
|
4512 This can be any form recognized as a single key specifier.
|
|
98
|
4513 The help-char cannot be a negative number in XEmacs.
|
|
0
|
4514 */ );
|
|
|
4515 Vhelp_char = make_char (8); /* C-h */
|
|
|
4516
|
|
|
4517 DEFVAR_LISP ("help-form", &Vhelp_form /*
|
|
|
4518 Form to execute when character help-char is read.
|
|
|
4519 If the form returns a string, that string is displayed.
|
|
|
4520 If `help-form' is nil, the help char is not recognized.
|
|
|
4521 */ );
|
|
|
4522 Vhelp_form = Qnil;
|
|
|
4523
|
|
|
4524 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command /*
|
|
|
4525 Command to run when `help-char' character follows a prefix key.
|
|
|
4526 This command is used only when there is no actual binding
|
|
|
4527 for that character after that prefix key.
|
|
|
4528 */ );
|
|
|
4529 Vprefix_help_command = Qnil;
|
|
|
4530
|
|
|
4531 DEFVAR_CONST_LISP ("keyboard-translate-table", &Vkeyboard_translate_table /*
|
|
|
4532 Hash table used as translate table for keyboard input.
|
|
|
4533 Use `keyboard-translate' to portably add entries to this table.
|
|
|
4534 Each key-press event is looked up in this table as follows:
|
|
|
4535
|
|
|
4536 -- If an entry maps a symbol to a symbol, then a key-press event whose
|
|
|
4537 keysym is the former symbol (with any modifiers at all) gets its
|
|
|
4538 keysym changed and its modifiers left alone. This is useful for
|
|
|
4539 dealing with non-standard X keyboards, such as the grievous damage
|
|
|
4540 that Sun has inflicted upon the world.
|
|
|
4541 -- If an entry maps a character to a character, then a key-press event
|
|
|
4542 matching the former character gets converted to a key-press event
|
|
|
4543 matching the latter character. This is useful on ASCII terminals
|
|
|
4544 for (e.g.) making C-\\ look like C-s, to get around flow-control
|
|
|
4545 problems.
|
|
|
4546 -- If an entry maps a character to a symbol, then a key-press event
|
|
|
4547 matching the character gets converted to a key-press event whose
|
|
|
4548 keysym is the given symbol and which has no modifiers.
|
|
|
4549 */ );
|
|
|
4550
|
|
|
4551 DEFVAR_LISP ("retry-undefined-key-binding-unshifted",
|
|
|
4552 &Vretry_undefined_key_binding_unshifted /*
|
|
|
4553 If a key-sequence which ends with a shifted keystroke is undefined
|
|
|
4554 and this variable is non-nil then the command lookup is retried again
|
|
|
4555 with the last key unshifted. (e.g. C-X C-F would be retried as C-X C-f.)
|
|
|
4556 If lookup still fails, a normal error is signalled. In general,
|
|
|
4557 you should *bind* this, not set it.
|
|
|
4558 */ );
|
|
|
4559 Vretry_undefined_key_binding_unshifted = Qt;
|
|
|
4560
|
|
70
|
4561 #ifdef HAVE_XIM
|
|
|
4562 DEFVAR_LISP ("Vcomposed_character_default_binding",
|
|
|
4563 &Vretry_undefined_key_binding_unshifted /*
|
|
|
4564 The default keybinding to use for key events from composed input.
|
|
|
4565 Window systems frequently have ways to allow the user to compose
|
|
|
4566 single characters in a language using multiple keystrokes.
|
|
|
4567 XEmacs sees these as single character keypress events.
|
|
|
4568 */ );
|
|
|
4569 Vcomposed_character_default_binding = Qself_insert_command;
|
|
|
4570 #endif /* HAVE_XIM */
|
|
|
4571
|
|
0
|
4572 Vcontrolling_terminal = Qnil;
|
|
|
4573 staticpro (&Vcontrolling_terminal);
|
|
|
4574
|
|
|
4575 Vdribble_file = Qnil;
|
|
|
4576 staticpro (&Vdribble_file);
|
|
|
4577
|
|
|
4578 #ifdef DEBUG_XEMACS
|
|
|
4579 DEFVAR_INT ("debug-emacs-events", &debug_emacs_events /*
|
|
|
4580 If non-zero, display debug information about Emacs events that XEmacs sees.
|
|
|
4581 Information is displayed on stderr.
|
|
|
4582
|
|
|
4583 Before the event, the source of the event is displayed in parentheses,
|
|
|
4584 and is one of the following:
|
|
|
4585
|
|
|
4586 \(real) A real event from the window system or
|
|
|
4587 terminal driver, as far as XEmacs can tell.
|
|
|
4588
|
|
|
4589 \(keyboard macro) An event generated from a keyboard macro.
|
|
|
4590
|
|
|
4591 \(unread-command-events) An event taken from `unread-command-events'.
|
|
|
4592
|
|
|
4593 \(unread-command-event) An event taken from `unread-command-event'.
|
|
|
4594
|
|
|
4595 \(command event queue) An event taken from an internal queue.
|
|
|
4596 Events end up on this queue when
|
|
|
4597 `enqueue-eval-event' is called or when
|
|
|
4598 user or eval events are received while
|
|
|
4599 XEmacs is blocking (e.g. in `sit-for',
|
|
|
4600 `sleep-for', or `accept-process-output',
|
|
|
4601 or while waiting for the reply to an
|
|
|
4602 X selection).
|
|
|
4603
|
|
|
4604 \(->keyboard-translate-table) The result of an event translated through
|
|
|
4605 keyboard-translate-table. Note that in
|
|
|
4606 this case, two events are printed even
|
|
|
4607 though only one is really generated.
|
|
|
4608
|
|
|
4609 \(SIGINT) A faked C-g resulting when XEmacs receives
|
|
|
4610 a SIGINT (e.g. C-c was pressed in XEmacs'
|
|
|
4611 controlling terminal or the signal was
|
|
|
4612 explicitly sent to the XEmacs process).
|
|
|
4613 */ );
|
|
|
4614 debug_emacs_events = 0;
|
|
|
4615 #endif
|
|
|
4616 }
|
|
|
4617
|
|
|
4618 void
|
|
|
4619 complex_vars_of_event_stream (void)
|
|
|
4620 {
|
|
|
4621 Vkeyboard_translate_table = Fmake_hashtable (make_int (100), Qnil);
|
|
|
4622 }
|
|
|
4623
|
|
|
4624 void
|
|
|
4625 init_event_stream (void)
|
|
|
4626 {
|
|
|
4627 if (initialized)
|
|
|
4628 {
|
|
|
4629 #ifdef HAVE_UNIXOID_EVENT_LOOP
|
|
|
4630 init_event_unixoid ();
|
|
|
4631 #endif
|
|
|
4632
|
|
|
4633 #ifdef HAVE_X_WINDOWS
|
|
|
4634 if (!strcmp (display_use, "x"))
|
|
|
4635 init_event_Xt_late ();
|
|
|
4636 else
|
|
|
4637 #endif
|
|
|
4638 {
|
|
|
4639 /* For TTY's, use the Xt event loop if we can; it allows
|
|
|
4640 us to later open an X connection. */
|
|
|
4641 #if defined (HAVE_X_WINDOWS) && !defined (DEBUG_TTY_EVENT_STREAM)
|
|
|
4642 init_event_Xt_late ();
|
|
|
4643 #else
|
|
|
4644 init_event_tty_late ();
|
|
|
4645 #endif
|
|
|
4646 }
|
|
|
4647 init_interrupts_late ();
|
|
|
4648 }
|
|
|
4649 }
|
|
|
4650
|
|
|
4651
|
|
|
4652 /*
|
|
|
4653 useful testcases for v18/v19 compatibility:
|
|
|
4654
|
|
|
4655 (defun foo ()
|
|
|
4656 (interactive)
|
|
|
4657 (setq unread-command-event (character-to-event ?A (allocate-event)))
|
|
|
4658 (setq x (list (read-char)
|
|
|
4659 ; (read-key-sequence "") ; try it with and without this
|
|
|
4660 last-command-char last-input-char
|
|
|
4661 (recent-keys) (this-command-keys))))
|
|
|
4662 (global-set-key "\^Q" 'foo)
|
|
|
4663
|
|
|
4664 without the read-key-sequence:
|
|
|
4665 ^Q ==> (65 17 65 [... ^Q] [^Q])
|
|
|
4666 ^U^U^Q ==> (65 17 65 [... ^U ^U ^Q] [^U ^U ^Q])
|
|
|
4667 ^U^U^U^G^Q ==> (65 17 65 [... ^U ^U ^U ^G ^Q] [^Q])
|
|
|
4668
|
|
|
4669 with the read-key-sequence:
|
|
|
4670 ^Qb ==> (65 [b] 17 98 [... ^Q b] [b])
|
|
|
4671 ^U^U^Qb ==> (65 [b] 17 98 [... ^U ^U ^Q b] [b])
|
|
|
4672 ^U^U^U^G^Qb ==> (65 [b] 17 98 [... ^U ^U ^U ^G ^Q b] [b])
|
|
|
4673
|
|
|
4674 ;the evi-mode command "4dlj.j.j.j.j.j." is also a good testcase (gag)
|
|
|
4675
|
|
|
4676 ;(setq x (list (read-char) quit-flag))^J^G
|
|
|
4677 ;(let ((inhibit-quit t)) (setq x (list (read-char) quit-flag)))^J^G
|
|
|
4678 ;for BOTH, x should get set to (7 t), but no result should be printed.
|
|
|
4679
|
|
|
4680 ;also do this: make two frames, one viewing "*scratch*", the other "foo".
|
|
|
4681 ;in *scratch*, type (sit-for 20)^J
|
|
|
4682 ;wait a couple of seconds, move cursor to foo, type "a"
|
|
|
4683 ;a should be inserted in foo. Cursor highlighting should not change in
|
|
|
4684 ;the meantime.
|
|
|
4685
|
|
|
4686 ;do it with sleep-for. move cursor into foo, then back into *scratch*
|
|
|
4687 ;before typing.
|
|
108
|
4688 ;repeat also with (accept-process-output nil 20)
|
|
|
4689
|
|
|
4690 ;make sure ^G aborts sit-for, sleep-for and accept-process-output:
|
|
0
|
4691
|
|
|
4692 (defun tst ()
|
|
|
4693 (list (condition-case c
|
|
|
4694 (sleep-for 20)
|
|
|
4695 (quit c))
|
|
|
4696 (read-char)))
|
|
|
4697
|
|
|
4698 (tst)^Ja^G ==> ((quit) 97) with no signal
|
|
|
4699 (tst)^J^Ga ==> ((quit) 97) with no signal
|
|
|
4700 (tst)^Jabc^G ==> ((quit) 97) with no signal, and "bc" inserted in buffer
|
|
|
4701
|
|
108
|
4702 ; with sit-for only do the 2nd test.
|
|
|
4703 ; Do all 3 tests with (accept-proccess-output nil 20)
|
|
|
4704
|
|
0
|
4705 Do this:
|
|
|
4706 (setq enable-recursive-minibuffers t
|
|
|
4707 minibuffer-max-depth nil)
|
|
|
4708 ESC ESC ESC ESC - there are now two minibuffers active
|
|
|
4709 C-g C-g C-g - there should be active 0, not 1
|
|
|
4710 Similarly:
|
|
|
4711 C-x C-f ~ / ? - wait for "Making completion list..." to display
|
|
|
4712 C-g - wait for "Quit" to display
|
|
|
4713 C-g - minibuffer should not be active
|
|
|
4714 however C-g before "Quit" is displayed should leave minibuffer active.
|
|
|
4715
|
|
|
4716 ;do it all in both v18 and v19 and make sure all results are the same.
|
|
|
4717 ;all of these cases matter a lot, but some in quite subtle ways.
|
|
|
4718 */
|
|
108
|
4719
|
|
|
4720 /*
|
|
|
4721 Additional test cases for accept-process-output, sleep-for, sit-for.
|
|
|
4722 Be sure you do all of the above checking for C-g and focus, too!
|
|
|
4723
|
|
|
4724 ; Make sure that timer handlers are run during, not after sit-for:
|
|
|
4725 (defun timer-check ()
|
|
|
4726 (add-timeout 2 '(lambda (ignore) (message "timer ran")) nil)
|
|
|
4727 (sit-for 5)
|
|
|
4728 (message "after sit-for"))
|
|
|
4729
|
|
|
4730 ; The first message should appear after 2 seconds, and the final message
|
|
|
4731 ; 3 seconds after that.
|
|
|
4732 ; repeat above test with (sleep-for 5) and (accept-process-output nil 5)
|
|
|
4733
|
|
|
4734
|
|
|
4735
|
|
|
4736 ; Make sure that process filters are run during, not after sit-for.
|
|
|
4737 (defun fubar ()
|
|
|
4738 (message "sit-for = %s" (sit-for 30)))
|
|
|
4739 (add-hook 'post-command-hook 'fubar)
|
|
|
4740
|
|
|
4741 ; Now type M-x shell RET
|
|
|
4742 ; wait for the shell prompt then send: ls RET
|
|
|
4743 ; the output of ls should fill immediately, and not wait 30 seconds.
|
|
|
4744
|
|
|
4745 ; repeat above test with (sleep-for 30) and (accept-process-output nil 30)
|
|
|
4746
|
|
|
4747
|
|
|
4748
|
|
|
4749 ; Make sure that recursive invocations return immediately:
|
|
|
4750 (defmacro test-diff-time (start end)
|
|
|
4751 `(+ (* (- (car ,end) (car ,start)) 65536.0)
|
|
|
4752 (- (cadr ,end) (cadr ,start))
|
|
|
4753 (/ (- (caddr ,end) (caddr ,start)) 1000000.0)))
|
|
|
4754
|
|
|
4755 (defun testee (ignore)
|
|
110
|
4756 (sit-for 10))
|
|
108
|
4757
|
|
|
4758 (defun test-them ()
|
|
|
4759 (let ((start (current-time))
|
|
|
4760 end)
|
|
|
4761 (add-timeout 2 'testee nil)
|
|
|
4762 (sit-for 5)
|
|
|
4763 (add-timeout 2 'testee nil)
|
|
|
4764 (sleep-for 5)
|
|
|
4765 (add-timeout 2 'testee nil)
|
|
|
4766 (accept-process-output nil 5)
|
|
|
4767 (setq end (current-time))
|
|
|
4768 (test-diff-time start end)))
|
|
|
4769
|
|
110
|
4770 (test-them) should sit for 15 seconds.
|
|
|
4771 Repeat with testee set to sleep-for and accept-process-output.
|
|
|
4772 These should each delay 36 seconds.
|
|
108
|
4773
|
|
|
4774 */
|
