1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
20 /* Allow config.h to undefine symbols found here. */
29 #include "termhooks.h"
36 #include "dispextern.h"
38 #include "intervals.h"
39 #include "blockinput.h"
44 #include <sys/ioctl.h>
47 #include "syssignal.h"
53 /* Variables for blockinput.h: */
55 /* Non-zero if interrupt input is blocked right now. */
56 int interrupt_input_blocked
;
58 /* Nonzero means an input interrupt has arrived
59 during the current critical section. */
60 int interrupt_input_pending
;
64 extern Lisp_Object Vmouse_grabbed
;
66 /* Make all keyboard buffers much bigger when using X windows. */
67 #define KBD_BUFFER_SIZE 4096
68 #else /* No X-windows, character input */
69 #define KBD_BUFFER_SIZE 256
70 #endif /* No X-windows */
72 /* Following definition copied from eval.c */
76 struct backtrace
*next
;
77 Lisp_Object
*function
;
78 Lisp_Object
*args
; /* Points to vector of args. */
79 int nargs
; /* length of vector. If nargs is UNEVALLED,
80 args points to slot holding list of
85 /* Non-nil disable property on a command means
86 do not execute it; call disabled-command-hook's value instead. */
87 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
89 #define NUM_RECENT_KEYS (100)
90 int recent_keys_index
; /* Index for storing next element into recent_keys */
91 int total_keys
; /* Total number of elements stored into recent_keys */
92 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
94 /* Vector holding the key sequence that invoked the current command.
95 It is reused for each command, and it may be longer than the current
96 sequence; this_command_key_count indicates how many elements
97 actually mean something.
98 It's easier to staticpro a single Lisp_Object than an array. */
99 Lisp_Object this_command_keys
;
100 int this_command_key_count
;
102 extern int minbuf_level
;
104 extern struct backtrace
*backtrace_list
;
106 /* Nonzero means do menu prompting. */
107 static int menu_prompting
;
109 /* Character to see next line of menu prompt. */
110 static Lisp_Object menu_prompt_more_char
;
112 /* For longjmp to where kbd input is being done. */
113 static jmp_buf getcjmp
;
115 /* True while doing kbd input. */
116 int waiting_for_input
;
118 /* True while displaying for echoing. Delays C-g throwing. */
121 /* Nonzero means C-G should cause immediate error-signal. */
124 /* Character to recognize as the help char. */
125 Lisp_Object Vhelp_char
;
127 /* Form to execute when help char is typed. */
128 Lisp_Object Vhelp_form
;
130 /* Command to run when the help character follows a prefix key. */
131 Lisp_Object Vprefix_help_command
;
133 /* Keymap for items that appear at end of menu bar. */
134 Lisp_Object Vhelp_menu_bar_map
;
136 /* Character that causes a quit. Normally C-g.
138 If we are running on an ordinary terminal, this must be an ordinary
139 ASCII char, since we want to make it our interrupt character.
141 If we are not running on an ordinary terminal, it still needs to be
142 an ordinary ASCII char. This character needs to be recognized in
143 the input interrupt handler. At this point, the keystroke is
144 represented as a struct input_event, while the desired quit
145 character is specified as a lispy event. The mapping from struct
146 input_events to lispy events cannot run in an interrupt handler,
147 and the reverse mapping is difficult for anything but ASCII
150 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
154 extern Lisp_Object current_global_map
;
155 extern int minibuf_level
;
157 /* Current depth in recursive edits. */
158 int command_loop_level
;
160 /* Total number of times command_loop has read a key sequence. */
163 /* Last input character read as a command. */
164 Lisp_Object last_command_char
;
166 /* Last input character read as a command, not counting menus
167 reached by the mouse. */
168 Lisp_Object last_nonmenu_event
;
170 /* Last input character read for any purpose. */
171 Lisp_Object last_input_char
;
173 /* If not Qnil, a list of objects to be read as subsequent command input. */
174 Lisp_Object unread_command_events
;
176 /* If not -1, an event to be read as subsequent command input. */
177 int unread_command_char
;
179 /* If not Qnil, this is a switch-frame event which we decided to put
180 off until the end of a key sequence. This should be read as the
181 next command input, after any unread_command_events.
183 read_key_sequence uses this to delay switch-frame events until the
184 end of the key sequence; Fread_char uses it to put off switch-frame
185 events until a non-ASCII event is acceptable as input. */
186 Lisp_Object unread_switch_frame
;
188 /* A mask of extra modifier bits to put into every keyboard char. */
189 int extra_keyboard_modifiers
;
191 /* Char to use as prefix when a meta character is typed in.
192 This is bound on entry to minibuffer in case ESC is changed there. */
194 Lisp_Object meta_prefix_char
;
196 /* Last size recorded for a current buffer which is not a minibuffer. */
197 static int last_non_minibuf_size
;
199 /* Number of idle seconds before an auto-save and garbage collection. */
200 static Lisp_Object Vauto_save_timeout
;
202 /* Total number of times read_char has returned. */
205 /* Total number of times read_char has returned, outside of macros. */
206 int num_nonmacro_input_chars
;
208 /* Auto-save automatically when this many characters have been typed
209 since the last time. */
211 static int auto_save_interval
;
213 /* Value of num_nonmacro_input_chars as of last auto save. */
217 /* Last command executed by the editor command loop, not counting
218 commands that set the prefix argument. */
220 Lisp_Object last_command
;
222 /* The command being executed by the command loop.
223 Commands may set this, and the value set will be copied into last_command
224 instead of the actual command. */
225 Lisp_Object this_command
;
228 /* The frame in which the last input event occurred, or Qmacro if the
229 last event came from a macro. We use this to determine when to
230 generate switch-frame events. This may be cleared by functions
231 like Fselect_frame, to make sure that a switch-frame event is
232 generated by the next character. */
233 Lisp_Object internal_last_event_frame
;
235 /* A user-visible version of the above, intended to allow users to
236 figure out where the last event came from, if the event doesn't
237 carry that information itself (i.e. if it was a character). */
238 Lisp_Object Vlast_event_frame
;
241 /* The timestamp of the last input event we received from the X server.
242 X Windows wants this for selection ownership. */
243 unsigned long last_event_timestamp
;
245 Lisp_Object Qself_insert_command
;
246 Lisp_Object Qforward_char
;
247 Lisp_Object Qbackward_char
;
248 Lisp_Object Qundefined
;
250 /* read_key_sequence stores here the command definition of the
251 key sequence that it reads. */
252 Lisp_Object read_key_sequence_cmd
;
254 /* Form to evaluate (if non-nil) when Emacs is started. */
255 Lisp_Object Vtop_level
;
257 /* User-supplied string to translate input characters through. */
258 Lisp_Object Vkeyboard_translate_table
;
260 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
261 extern Lisp_Object Vfunction_key_map
;
263 /* Non-nil means deactivate the mark at end of this command. */
264 Lisp_Object Vdeactivate_mark
;
266 /* Menu bar specified in Lucid Emacs fashion. */
268 Lisp_Object Vlucid_menu_bar_dirty_flag
;
269 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
271 /* Hooks to run before and after each command. */
272 Lisp_Object Qpre_command_hook
, Qpost_command_hook
;
273 Lisp_Object Vpre_command_hook
, Vpost_command_hook
;
275 /* File in which we write all commands we read. */
278 /* Nonzero if input is available. */
281 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
282 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
286 extern char *pending_malloc_warning
;
288 /* Circular buffer for pre-read keyboard input. */
289 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
291 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
293 The interrupt-level event handlers will never enqueue an event on a
294 frame which is not in Vframe_list, and once an event is dequeued,
295 internal_last_event_frame or the event itself points to the frame.
298 But while the event is sitting in the queue, it's completely
299 unprotected. Suppose the user types one command which will run for
300 a while and then delete a frame, and then types another event at
301 the frame that will be deleted, before the command gets around to
302 it. Suppose there are no references to this frame elsewhere in
303 Emacs, and a GC occurs before the second event is dequeued. Now we
304 have an event referring to a freed frame, which will crash Emacs
307 Similar things happen when an event on a scroll bar is enqueued; the
308 window may be deleted while the event is in the queue.
310 So, we use this vector to protect the frame_or_window field in the
311 event queue. That way, they'll be dequeued as dead frames or
312 windows, but still valid lisp objects.
314 If kbd_buffer[i].kind != no_event, then
315 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
316 == kbd_buffer[i].frame_or_window. */
317 static Lisp_Object kbd_buffer_frame_or_window
;
319 /* Pointer to next available character in kbd_buffer.
320 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
321 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
322 next available char is in kbd_buffer[0]. */
323 static struct input_event
*kbd_fetch_ptr
;
325 /* Pointer to next place to store character in kbd_buffer. This
326 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
327 character should go in kbd_buffer[0]. */
331 static struct input_event
*kbd_store_ptr
;
333 /* The above pair of variables forms a "queue empty" flag. When we
334 enqueue a non-hook event, we increment kbd_write_count. When we
335 dequeue a non-hook event, we increment kbd_read_count. We say that
336 there is input available iff the two counters are not equal.
338 Why not just have a flag set and cleared by the enqueuing and
339 dequeuing functions? Such a flag could be screwed up by interrupts
340 at inopportune times. */
342 /* If this flag is non-zero, we check mouse_moved to see when the
343 mouse moves, and motion events will appear in the input stream. If
344 it is zero, mouse motion is ignored. */
345 static int do_mouse_tracking
;
347 /* The window system handling code should set this if the mouse has
348 moved since the last call to the mouse_position_hook. Calling that
349 hook should clear this. Code assumes that if this is set, it can
350 call mouse_position_hook to get the promised position, so don't set
351 it unless you're prepared to substantiate the claim! */
354 /* True iff there is an event in kbd_buffer, or if mouse tracking is
355 enabled and there is a new mouse position in the mouse movement
356 buffer. Note that if this is false, that doesn't mean that there
357 is readable input; all the events in the queue might be button-up
358 events, and do_mouse_tracking might be off. */
359 #define EVENT_QUEUES_EMPTY \
360 ((kbd_fetch_ptr == kbd_store_ptr) && (!do_mouse_tracking || !mouse_moved))
363 /* Symbols to head events. */
364 Lisp_Object Qmouse_movement
;
365 Lisp_Object Qscroll_bar_movement
;
366 Lisp_Object Qswitch_frame
;
368 /* Symbols to denote kinds of events. */
369 Lisp_Object Qfunction_key
;
370 Lisp_Object Qmouse_click
;
371 /* Lisp_Object Qmouse_movement; - also an event header */
373 /* Properties of event headers. */
374 Lisp_Object Qevent_kind
;
375 Lisp_Object Qevent_symbol_elements
;
377 Lisp_Object Qmenu_enable
;
379 /* An event header symbol HEAD may have a property named
380 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
381 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
382 mask of modifiers applied to it. If present, this is used to help
383 speed up parse_modifiers. */
384 Lisp_Object Qevent_symbol_element_mask
;
386 /* An unmodified event header BASE may have a property named
387 Qmodifier_cache, which is an alist mapping modifier masks onto
388 modified versions of BASE. If present, this helps speed up
390 Lisp_Object Qmodifier_cache
;
392 /* Symbols to use for parts of windows. */
393 Lisp_Object Qmode_line
;
394 Lisp_Object Qvertical_line
;
395 Lisp_Object Qvertical_scroll_bar
;
396 Lisp_Object Qmenu_bar
;
398 extern Lisp_Object Qmenu_enable
;
400 Lisp_Object
recursive_edit_unwind (), command_loop ();
401 Lisp_Object
Fthis_command_keys ();
403 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
405 EMACS_TIME
*input_available_clear_time
;
407 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
408 Default is 1 if INTERRUPT_INPUT is defined. */
411 /* Nonzero while interrupts are temporarily deferred during redisplay. */
412 int interrupts_deferred
;
414 /* nonzero means use ^S/^Q for flow control. */
417 /* Allow m- file to inhibit use of FIONREAD. */
418 #ifdef BROKEN_FIONREAD
422 /* We are unable to use interrupts if FIONREAD is not available,
423 so flush SIGIO so we won't try. */
430 /* If we support X Windows, and won't get an interrupt when input
431 arrives from the server, poll periodically so we can detect C-g. */
432 #ifdef HAVE_X_WINDOWS
434 #define POLL_FOR_INPUT
438 /* Global variable declarations. */
440 /* Function for init_keyboard to call with no args (if nonzero). */
441 void (*keyboard_init_hook
) ();
443 static int read_avail_input ();
444 static void get_input_pending ();
445 static Lisp_Object
read_char_menu_prompt ();
447 /* > 0 if we are to echo keystrokes. */
448 static int echo_keystrokes
;
450 /* Nonzero means echo each character as typed. */
451 static int immediate_echo
;
453 /* The text we're echoing in the modeline - partial key sequences,
454 usually. '\0'-terminated. This really shouldn't have a fixed size. */
455 static char echobuf
[300];
457 /* Where to append more text to echobuf if we want to. */
458 static char *echoptr
;
460 #define min(a,b) ((a)<(b)?(a):(b))
461 #define max(a,b) ((a)>(b)?(a):(b))
463 /* Install the string STR as the beginning of the string of echoing,
464 so that it serves as a prompt for the next character.
465 Also start echoing. */
470 int len
= strlen (str
);
471 if (len
> sizeof echobuf
- 4)
472 len
= sizeof echobuf
- 4;
473 bcopy (str
, echobuf
, len
);
474 echoptr
= echobuf
+ len
;
480 /* Add C to the echo string, if echoing is going on.
481 C can be a character, which is printed prettily ("M-C-x" and all that
482 jazz), or a symbol, whose name is printed. */
487 extern char *push_key_description ();
496 /* If someone has passed us a composite event, use its head symbol. */
499 if (XTYPE (c
) == Lisp_Int
)
501 if (ptr
- echobuf
> sizeof echobuf
- 6)
504 ptr
= push_key_description (XINT (c
), ptr
);
506 else if (XTYPE (c
) == Lisp_Symbol
)
508 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
509 if (((ptr
- echobuf
) + name
->size
+ 4) > sizeof echobuf
)
511 bcopy (name
->data
, ptr
, name
->size
);
515 if (echoptr
== echobuf
&& EQ (c
, Vhelp_char
))
517 strcpy (ptr
, " (Type ? for further options)");
528 /* Temporarily add a dash to the end of the echo string if it's not
529 empty, so that it serves as a mini-prompt for the very next character. */
533 if (!immediate_echo
&& echoptr
== echobuf
)
535 /* Do nothing if not echoing at all. */
539 /* Put a dash at the end of the buffer temporarily,
540 but make it go away when the next character is added. */
547 /* Display the current echo string, and begin echoing if not already
557 for (i
= 0; i
< this_command_key_count
; i
++)
558 echo_char (XVECTOR (this_command_keys
)->contents
[i
]);
566 if (waiting_for_input
&& !NILP (Vquit_flag
))
567 quit_throw_to_read_char ();
570 /* Turn off echoing, for the start of a new command. */
578 /* Return the length of the current echo string. */
583 return echoptr
- echobuf
;
586 /* Truncate the current echo message to its first LEN chars.
587 This and echo_char get used by read_key_sequence when the user
588 switches frames while entering a key sequence. */
595 echoptr
= echobuf
+ len
;
599 /* Functions for manipulating this_command_keys. */
601 add_command_key (key
)
604 int size
= XVECTOR (this_command_keys
)->size
;
606 if (this_command_key_count
>= size
)
608 Lisp_Object new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
610 bcopy (XVECTOR (this_command_keys
)->contents
,
611 XVECTOR (new_keys
)->contents
,
612 size
* sizeof (Lisp_Object
));
614 this_command_keys
= new_keys
;
617 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
623 int count
= specpdl_ptr
- specpdl
;
626 if (command_loop_level
> 0)
628 specbind (Qstandard_output
, Qt
);
629 specbind (Qstandard_input
, Qt
);
632 val
= command_loop ();
634 Fsignal (Qquit
, Qnil
);
636 return unbind_to (count
, Qnil
);
639 /* When an auto-save happens, record the "time", and don't do again soon. */
642 last_auto_save
= num_nonmacro_input_chars
;
645 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
646 "Invoke the editor command loop recursively.\n\
647 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
648 that tells this function to return.\n\
649 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
650 This function is called by the editor initialization to begin editing.")
653 int count
= specpdl_ptr
- specpdl
;
656 command_loop_level
++;
657 update_mode_lines
= 1;
659 record_unwind_protect (recursive_edit_unwind
,
661 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
665 return unbind_to (count
, Qnil
);
669 recursive_edit_unwind (buffer
)
673 Fset_buffer (buffer
);
675 command_loop_level
--;
676 update_mode_lines
= 1;
684 Lisp_Object errmsg
, tail
, errname
, file_error
;
691 Vstandard_output
= Qt
;
692 Vstandard_input
= Qt
;
693 Vexecuting_macro
= Qnil
;
694 echo_area_glyphs
= 0;
696 /* If the window system or terminal frame hasn't been initialized
697 yet, or we're not interactive, it's best to dump this message out
698 to stderr and exit. */
699 if (! FRAME_MESSAGE_BUF (selected_frame
)
701 stream
= Qexternal_debugging_output
;
709 errname
= Fcar (data
);
711 if (EQ (errname
, Qerror
))
714 if (!CONSP (data
)) data
= Qnil
;
715 errmsg
= Fcar (data
);
720 errmsg
= Fget (errname
, Qerror_message
);
721 file_error
= Fmemq (Qfile_error
,
722 Fget (errname
, Qerror_conditions
));
725 /* Print an error message including the data items.
726 This is done by printing it into a scratch buffer
727 and then making a copy of the text in the buffer. */
729 if (!CONSP (data
)) data
= Qnil
;
733 /* For file-error, make error message by concatenating
734 all the data items. They are all strings. */
735 if (!NILP (file_error
) && !NILP (tail
))
736 errmsg
= XCONS (tail
)->car
, tail
= XCONS (tail
)->cdr
;
738 if (XTYPE (errmsg
) == Lisp_String
)
739 Fprinc (errmsg
, stream
);
741 write_string_1 ("peculiar error", -1, stream
);
743 for (i
= 0; CONSP (tail
); tail
= Fcdr (tail
), i
++)
745 write_string_1 (i
? ", " : ": ", 2, stream
);
746 if (!NILP (file_error
))
747 Fprinc (Fcar (tail
), stream
);
749 Fprin1 (Fcar (tail
), stream
);
753 /* If the window system or terminal frame hasn't been initialized
754 yet, or we're in -batch mode, this error should cause Emacs to exit. */
755 if (! FRAME_MESSAGE_BUF (selected_frame
)
759 Fkill_emacs (make_number (-1));
764 Vinhibit_quit
= Qnil
;
765 return make_number (0);
768 Lisp_Object
command_loop_1 ();
769 Lisp_Object
command_loop_2 ();
770 Lisp_Object
top_level_1 ();
772 /* Entry to editor-command-loop.
773 This level has the catches for exiting/returning to editor command loop.
774 It returns nil to exit recursive edit, t to abort it. */
779 if (command_loop_level
> 0 || minibuf_level
> 0)
781 return internal_catch (Qexit
, command_loop_2
, Qnil
);
786 internal_catch (Qtop_level
, top_level_1
, Qnil
);
787 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
789 /* End of file in -batch run causes exit here. */
795 /* Here we catch errors in execution of commands within the
796 editing loop, and reenter the editing loop.
797 When there is an error, cmd_error runs and returns a non-nil
798 value to us. A value of nil means that cmd_loop_1 itself
799 returned due to end of file (or end of kbd macro). */
804 register Lisp_Object val
;
807 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
816 return Feval (Vtop_level
);
822 /* On entry to the outer level, run the startup file */
823 if (!NILP (Vtop_level
))
824 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
825 else if (!NILP (Vpurify_flag
))
826 message ("Bare impure Emacs (standard Lisp code not loaded)");
828 message ("Bare Emacs (standard Lisp code not loaded)");
832 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
833 "Exit all recursive editing levels.")
836 Fthrow (Qtop_level
, Qnil
);
839 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
840 "Exit from the innermost recursive edit or minibuffer.")
843 if (command_loop_level
> 0 || minibuf_level
> 0)
844 Fthrow (Qexit
, Qnil
);
846 error ("No recursive edit is in progress");
849 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
850 "Abort the command that requested this recursive edit or minibuffer input.")
853 if (command_loop_level
> 0 || minibuf_level
> 0)
856 error ("No recursive edit is in progress");
859 /* This is the actual command reading loop,
860 sans error-handling encapsulation. */
862 Lisp_Object
Fcommand_execute ();
863 static int read_key_sequence ();
868 Lisp_Object cmd
, tem
;
871 Lisp_Object keybuf
[30];
876 struct buffer
*prev_buffer
;
879 Vdeactivate_mark
= Qnil
;
880 waiting_for_input
= 0;
883 /* Don't clear out last_command at the beginning of a macro. */
884 if (XTYPE (Vexecuting_macro
) != Lisp_String
)
889 this_command_key_count
= 0;
893 /* Install chars successfully executed in kbd macro. */
895 if (defining_kbd_macro
&& NILP (Vprefix_arg
))
896 finalize_kbd_macro_chars ();
898 /* Make sure the current window's buffer is selected. */
899 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
900 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
902 /* Display any malloc warning that just came out. Use while because
903 displaying one warning can cause another. */
905 while (pending_malloc_warning
)
906 display_malloc_warning ();
910 Vdeactivate_mark
= Qnil
;
912 /* If minibuffer on and echo area in use,
913 wait 2 sec and redraw minibuffer. */
915 if (minibuf_level
&& echo_area_glyphs
)
917 /* Bind inhibit-quit to t so that C-g gets read in
918 rather than quitting back to the minibuffer. */
919 int count
= specpdl_ptr
- specpdl
;
920 specbind (Qinhibit_quit
, Qt
);
921 Fsit_for (make_number (2), Qnil
, Qnil
);
922 unbind_to (count
, Qnil
);
924 echo_area_glyphs
= 0;
926 if (!NILP (Vquit_flag
))
929 unread_command_events
= Fcons (make_number (quit_char
), Qnil
);
934 alloca (0); /* Cause a garbage collection now */
935 /* Since we can free the most stuff here. */
936 #endif /* C_ALLOCA */
940 /* Select the frame that the last event came from. Usually,
941 switch-frame events will take care of this, but if some lisp
942 code swallows a switch-frame event, we'll fix things up here.
943 Is this a good idea? */
944 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
945 && XFRAME (internal_last_event_frame
) != selected_frame
)
946 Fselect_frame (internal_last_event_frame
, Qnil
);
949 /* If it has changed current-menubar from previous value,
950 really recompute the menubar from the value. */
951 if (! NILP (Vlucid_menu_bar_dirty_flag
))
952 call0 (Qrecompute_lucid_menubar
);
954 #if 0 /* This is done in xdisp.c now. */
956 for (tem
= Vframe_list
; CONSP (tem
); tem
= XCONS (tem
)->cdr
)
958 struct frame
*f
= XFRAME (XCONS (tem
)->car
);
959 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
961 /* If the user has switched buffers or windows, we need to
962 recompute to reflect the new bindings. But we'll
963 recompute when update_mode_lines is set too; that means
964 that people can use force-mode-line-update to request
965 that the menu bar be recomputed. The adverse effect on
966 the rest of the redisplay algorithm is about the same as
967 windows_or_buffers_changed anyway. */
968 if (windows_or_buffers_changed
970 || (XFASTINT (w
->last_modified
) < MODIFF
971 && (XFASTINT (w
->last_modified
)
972 <= XBUFFER (w
->buffer
)->save_modified
)))
974 struct buffer
*prev
= current_buffer
;
975 current_buffer
= XBUFFER (w
->buffer
);
976 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items ();
977 current_buffer
= prev
;
980 #endif /* MULTI_FRAME */
983 /* Read next key sequence; i gets its length. */
984 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), 0);
988 /* Now we have read a key sequence of length I,
989 or else I is 0 and we found end of file. */
991 if (i
== 0) /* End of file -- happens only in */
992 return Qnil
; /* a kbd macro, at the end. */
994 last_command_char
= keybuf
[i
- 1];
996 /* If the previous command tried to force a specific window-start,
997 forget about that, in case this command moves point far away
998 from that position. */
999 XWINDOW (selected_window
)->force_start
= Qnil
;
1001 cmd
= read_key_sequence_cmd
;
1002 if (!NILP (Vexecuting_macro
))
1004 if (!NILP (Vquit_flag
))
1006 Vexecuting_macro
= Qt
;
1007 QUIT
; /* Make some noise. */
1008 /* Will return since macro now empty. */
1012 /* Do redisplay processing after this command except in special
1013 cases identified below that set no_redisplay to 1. */
1016 prev_buffer
= current_buffer
;
1017 prev_modiff
= MODIFF
;
1019 /* Execute the command. */
1022 if (!NILP (Vpre_command_hook
))
1023 call1 (Vrun_hooks
, Qpre_command_hook
);
1025 if (NILP (this_command
))
1027 /* nil means key is undefined. */
1029 defining_kbd_macro
= 0;
1030 update_mode_lines
= 1;
1036 if (NILP (Vprefix_arg
) && ! no_direct
)
1038 /* Recognize some common commands in common situations and
1039 do them directly. */
1040 if (EQ (this_command
, Qforward_char
) && point
< ZV
)
1042 struct Lisp_Vector
*dp
1043 = window_display_table (XWINDOW (selected_window
));
1044 lose
= FETCH_CHAR (point
);
1047 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1048 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1049 : (lose
>= 0x20 && lose
< 0x7f))
1050 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1052 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1054 && !windows_or_buffers_changed
1055 && EQ (current_buffer
->selective_display
, Qnil
)
1056 && !detect_input_pending ()
1057 && NILP (Vexecuting_macro
))
1058 no_redisplay
= direct_output_forward_char (1);
1061 else if (EQ (this_command
, Qbackward_char
) && point
> BEGV
)
1063 struct Lisp_Vector
*dp
1064 = window_display_table (XWINDOW (selected_window
));
1066 lose
= FETCH_CHAR (point
);
1068 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1069 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1070 : (lose
>= 0x20 && lose
< 0x7f))
1071 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1073 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1075 && !windows_or_buffers_changed
1076 && EQ (current_buffer
->selective_display
, Qnil
)
1077 && !detect_input_pending ()
1078 && NILP (Vexecuting_macro
))
1079 no_redisplay
= direct_output_forward_char (-1);
1082 else if (EQ (this_command
, Qself_insert_command
)
1083 /* Try this optimization only on ascii keystrokes. */
1084 && XTYPE (last_command_char
) == Lisp_Int
)
1086 unsigned char c
= XINT (last_command_char
);
1088 if (NILP (Vexecuting_macro
) &&
1089 !EQ (minibuf_window
, selected_window
))
1091 if (!nonundocount
|| nonundocount
>= 20)
1098 lose
= (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1100 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1102 || MODIFF
<= current_buffer
->save_modified
1103 || windows_or_buffers_changed
1104 || !EQ (current_buffer
->selective_display
, Qnil
)
1105 || detect_input_pending ()
1106 || !NILP (Vexecuting_macro
);
1107 if (internal_self_insert (c
, 0))
1113 (point
== ZV
|| FETCH_CHAR (point
) == '\n'))
1115 struct Lisp_Vector
*dp
1116 = window_display_table (XWINDOW (selected_window
));
1121 Lisp_Object obj
= DISP_CHAR_VECTOR (dp
, lose
);
1123 if (XTYPE (obj
) == Lisp_Vector
1124 && XVECTOR (obj
)->size
== 1
1125 && (XTYPE (obj
= XVECTOR (obj
)->contents
[0])
1128 direct_output_for_insert (XINT (obj
));
1132 if (lose
>= 0x20 && lose
<= 0x7e)
1133 no_redisplay
= direct_output_for_insert (lose
);
1140 /* Here for a command that isn't executed directly */
1143 if (NILP (Vprefix_arg
))
1145 Fcommand_execute (this_command
, Qnil
);
1150 if (!NILP (Vpost_command_hook
))
1151 call1 (Vrun_hooks
, Qpost_command_hook
);
1153 /* If there is a prefix argument,
1154 1) We don't want last_command to be ``universal-argument''
1155 (that would be dumb), so don't set last_command,
1156 2) we want to leave echoing on so that the prefix will be
1157 echoed as part of this key sequence, so don't call
1159 3) we want to leave this_command_key_count non-zero, so that
1160 read_char will realize that it is re-reading a character, and
1161 not echo it a second time. */
1162 if (NILP (Vprefix_arg
))
1164 last_command
= this_command
;
1166 this_command_key_count
= 0;
1169 if (!NILP (current_buffer
->mark_active
))
1171 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1173 current_buffer
->mark_active
= Qnil
;
1174 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1176 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1177 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1182 /* Number of seconds between polling for input. */
1185 /* Nonzero means polling for input is temporarily suppressed. */
1186 int poll_suppress_count
;
1188 #ifdef POLL_FOR_INPUT
1189 int polling_for_input
;
1191 /* Handle an alarm once each second and read pending input
1192 so as to handle a C-g if it comces in. */
1195 input_poll_signal ()
1197 if (interrupt_input_blocked
== 0
1198 && !waiting_for_input
)
1199 read_avail_input (0);
1200 signal (SIGALRM
, input_poll_signal
);
1201 alarm (polling_period
);
1206 /* Begin signals to poll for input, if they are appropriate.
1207 This function is called unconditionally from various places. */
1211 #ifdef POLL_FOR_INPUT
1212 if (read_socket_hook
)
1214 poll_suppress_count
--;
1215 if (poll_suppress_count
== 0)
1217 signal (SIGALRM
, input_poll_signal
);
1218 polling_for_input
= 1;
1219 alarm (polling_period
);
1225 /* Turn off polling. */
1229 #ifdef POLL_FOR_INPUT
1230 if (read_socket_hook
)
1232 if (poll_suppress_count
== 0)
1234 polling_for_input
= 0;
1237 poll_suppress_count
++;
1242 /* Applying the control modifier to CHARACTER. */
1247 /* Save the upper bits here. */
1248 int upper
= c
& ~0177;
1252 /* Everything in the columns containing the upper-case letters
1253 denotes a control character. */
1254 if (c
>= 0100 && c
< 0140)
1258 /* Set the shift modifier for a control char
1259 made from a shifted letter. But only for letters! */
1260 if (oc
>= 'A' && oc
<= 'Z')
1261 c
|= shift_modifier
;
1264 /* The lower-case letters denote control characters too. */
1265 else if (c
>= 'a' && c
<= 'z')
1268 /* Include the bits for control and shift
1269 only if the basic ASCII code can't indicate them. */
1273 /* Replace the high bits. */
1274 c
|= (upper
& ~ctrl_modifier
);
1281 /* Input of single characters from keyboard */
1283 Lisp_Object
print_help ();
1284 static Lisp_Object
kbd_buffer_get_event ();
1286 /* read a character from the keyboard; call the redisplay if needed */
1287 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1288 -1 means do not do redisplay, but do do autosaving.
1291 /* The arguments MAPS and NMAPS are for menu prompting.
1292 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1294 PREV_EVENT is the previous input event, or nil if we are reading
1295 the first event of a key sequence.
1297 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1298 if we used a mouse menu to read the input, or zero otherwise. If
1299 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone. */
1302 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1306 Lisp_Object prev_event
;
1307 int *used_mouse_menu
;
1309 register Lisp_Object c
;
1313 if (CONSP (unread_command_events
))
1315 c
= XCONS (unread_command_events
)->car
;
1316 unread_command_events
= XCONS (unread_command_events
)->cdr
;
1318 if (this_command_key_count
== 0)
1324 if (unread_command_char
!= -1)
1326 XSET (c
, Lisp_Int
, unread_command_char
);
1327 unread_command_char
= -1;
1329 if (this_command_key_count
== 0)
1335 if (!NILP (Vexecuting_macro
))
1338 /* We set this to Qmacro; since that's not a frame, nobody will
1339 try to switch frames on us, and the selected window will
1342 Since this event came from a macro, it would be misleading to
1343 leave internal_last_event_frame set to wherever the last
1344 real event came from. Normally, a switch-frame event selects
1345 internal_last_event_frame after each command is read, but
1346 events read from a macro should never cause a new frame to be
1348 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1351 /* Exit the macro if we are at the end.
1352 Also, some things replace the macro with t
1353 to force an early exit. */
1354 if (EQ (Vexecuting_macro
, Qt
)
1355 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1357 XSET (c
, Lisp_Int
, -1);
1361 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1362 if (XTYPE (Vexecuting_macro
) == Lisp_String
1363 && (XINT (c
) & 0x80))
1364 XFASTINT (c
) = CHAR_META
| (XINT (c
) & ~0x80);
1366 executing_macro_index
++;
1371 if (!NILP (unread_switch_frame
))
1373 c
= unread_switch_frame
;
1374 unread_switch_frame
= Qnil
;
1376 /* This event should make it into this_command_keys, and get echoed
1377 again, so we go to reread_first, rather than reread. */
1381 /* Save outer setjmp data, in case called recursively. */
1382 save_getcjmp (save_jump
);
1386 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1389 if (_setjmp (getcjmp
))
1391 XSET (c
, Lisp_Int
, quit_char
);
1393 XSET (internal_last_event_frame
, Lisp_Frame
, selected_frame
);
1394 Vlast_event_frame
= internal_last_event_frame
;
1396 /* If we report the quit char as an event,
1397 don't do so more than once. */
1398 if (!NILP (Vinhibit_quit
))
1404 /* Message turns off echoing unless more keystrokes turn it on again. */
1405 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1408 /* If already echoing, continue. */
1411 /* If in middle of key sequence and minibuffer not active,
1412 start echoing if enough time elapses. */
1413 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1414 && echo_keystrokes
> 0
1415 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1419 /* After a mouse event, start echoing right away.
1420 This is because we are probably about to display a menu,
1421 and we don't want to delay before doing so. */
1422 if (EVENT_HAS_PARAMETERS (prev_event
))
1426 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1432 /* Maybe auto save due to number of keystrokes or idle time. */
1434 if (commandflag
!= 0
1435 && auto_save_interval
> 0
1436 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1437 && !detect_input_pending ())
1440 save_getcjmp (temp
);
1441 Fdo_auto_save (Qnil
, Qnil
);
1442 restore_getcjmp (temp
);
1445 /* Try reading a character via menu prompting.
1446 Try this before the sit-for, because the sit-for
1447 would do the wrong thing if we are supposed to do
1450 if (INTERACTIVE
&& !NILP (prev_event
))
1451 c
= read_char_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1453 /* Slow down auto saves logarithmically in size of current buffer,
1454 and garbage collect while we're at it. */
1455 if (INTERACTIVE
&& NILP (c
))
1457 int delay_level
, buffer_size
;
1459 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1460 last_non_minibuf_size
= Z
- BEG
;
1461 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1463 while (buffer_size
> 64)
1464 delay_level
++, buffer_size
-= buffer_size
>> 2;
1465 if (delay_level
< 4) delay_level
= 4;
1466 /* delay_level is 4 for files under around 50k, 7 at 100k,
1467 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1469 /* Auto save if enough time goes by without input. */
1470 if (commandflag
!= 0
1471 && num_nonmacro_input_chars
> last_auto_save
1472 && XTYPE (Vauto_save_timeout
) == Lisp_Int
1473 && XINT (Vauto_save_timeout
) > 0)
1476 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1477 tem0
= sit_for (delay
, 0, 1, 1);
1481 save_getcjmp (temp
);
1482 Fdo_auto_save (Qnil
, Qnil
);
1483 restore_getcjmp (temp
);
1485 /* If we have auto-saved and there is still no input
1486 available, garbage collect if there has been enough
1487 consing going on to make it worthwhile. */
1488 if (!detect_input_pending ()
1489 && consing_since_gc
> gc_cons_threshold
/ 2)
1491 Fgarbage_collect ();
1498 /* Actually read a character, waiting if necessary. */
1501 c
= kbd_buffer_get_event ();
1504 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1508 /* Terminate Emacs in batch mode if at eof. */
1509 if (noninteractive
&& XTYPE (c
) == Lisp_Int
&& XINT (c
) < 0)
1510 Fkill_emacs (make_number (1));
1512 if (XTYPE (c
) == Lisp_Int
)
1514 /* Add in any extra modifiers, where appropriate. */
1515 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1516 || ((extra_keyboard_modifiers
& 0177) < ' '
1517 && (extra_keyboard_modifiers
& 0177) != 0))
1518 XSETINT (c
, make_ctrl_char (XINT (c
)));
1520 /* Transfer any other modifier bits directly from
1521 extra_keyboard_modifiers to c. Ignore the actual character code
1522 in the low 16 bits of extra_keyboard_modifiers. */
1523 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
1528 restore_getcjmp (save_jump
);
1532 echo_area_glyphs
= 0;
1534 /* Handle things that only apply to characters. */
1535 if (XTYPE (c
) == Lisp_Int
)
1537 /* If kbd_buffer_get_event gave us an EOF, return that. */
1541 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
1542 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1543 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1547 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1548 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1549 recent_keys_index
= 0;
1551 /* Write c to the dribble file. If c is a lispy event, write
1552 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1553 If you, dear reader, have a better idea, you've got the source. :-) */
1556 if (XTYPE (c
) == Lisp_Int
)
1557 putc (XINT (c
), dribble
);
1560 Lisp_Object dribblee
= c
;
1562 /* If it's a structured event, take the event header. */
1563 dribblee
= EVENT_HEAD (dribblee
);
1565 if (XTYPE (dribblee
) == Lisp_Symbol
)
1567 putc ('<', dribble
);
1568 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1569 XSYMBOL (dribblee
)->name
->size
,
1571 putc ('>', dribble
);
1578 store_kbd_macro_char (c
);
1580 num_nonmacro_input_chars
++;
1585 /* Record this character as part of the current key.
1586 Don't record mouse motion; it should never matter. */
1587 if (! (EVENT_HAS_PARAMETERS (c
)
1588 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1591 add_command_key (c
);
1594 /* Re-reading in the middle of a command */
1596 last_input_char
= c
;
1599 /* Process the help character specially if enabled */
1600 if (EQ (c
, Vhelp_char
) && !NILP (Vhelp_form
))
1603 count
= specpdl_ptr
- specpdl
;
1605 record_unwind_protect (Fset_window_configuration
,
1606 Fcurrent_window_configuration (Qnil
));
1608 tem0
= Feval (Vhelp_form
);
1609 if (XTYPE (tem0
) == Lisp_String
)
1610 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1613 c
= read_char (0, 0, 0, Qnil
, 0);
1614 /* Remove the help from the frame */
1615 unbind_to (count
, Qnil
);
1617 if (EQ (c
, make_number (040)))
1620 c
= read_char (0, 0, 0, Qnil
, 0);
1631 Fprinc (object
, Qnil
);
1635 /* Copy out or in the info on where C-g should throw to.
1636 This is used when running Lisp code from within get_char,
1637 in case get_char is called recursively.
1638 See read_process_output. */
1643 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1646 restore_getcjmp (temp
)
1649 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1653 /* Low level keyboard/mouse input.
1654 kbd_buffer_store_event places events in kbd_buffer, and
1655 kbd_buffer_get_event retrieves them.
1656 mouse_moved indicates when the mouse has moved again, and
1657 *mouse_position_hook provides the mouse position. */
1659 /* Set this for debugging, to have a way to get out */
1662 extern int frame_garbaged
;
1664 /* Return true iff there are any events in the queue that read-char
1665 would return. If this returns false, a read-char would block. */
1669 return ! EVENT_QUEUES_EMPTY
;
1673 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1674 of this function. */
1676 tracking_off (old_value
)
1677 Lisp_Object old_value
;
1679 if (! XFASTINT (old_value
))
1681 do_mouse_tracking
= 0;
1683 /* Redisplay may have been preempted because there was input
1684 available, and it assumes it will be called again after the
1685 input has been processed. If the only input available was
1686 the sort that we have just disabled, then we need to call
1688 if (!readable_events ())
1690 redisplay_preserve_echo_area ();
1691 get_input_pending (&input_pending
);
1696 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1697 "Evaluate BODY with mouse movement events enabled.\n\
1698 Within a `track-mouse' form, mouse motion generates input events that\n\
1699 you can read with `read-event'.\n\
1700 Normally, mouse motion is ignored.")
1704 int count
= specpdl_ptr
- specpdl
;
1707 XSET (val
, Lisp_Int
, do_mouse_tracking
);
1708 record_unwind_protect (tracking_off
, val
);
1710 do_mouse_tracking
= 1;
1712 val
= Fprogn (args
);
1713 return unbind_to (count
, val
);
1716 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
1719 kbd_buffer_store_event (event
)
1720 register struct input_event
*event
;
1722 if (event
->kind
== no_event
)
1725 if (event
->kind
== ascii_keystroke
)
1727 register int c
= XFASTINT (event
->code
) & 0377;
1729 if (event
->modifiers
& ctrl_modifier
)
1730 c
= make_ctrl_char (c
);
1734 extern SIGTYPE
interrupt_signal ();
1737 /* If this results in a quit_char being returned to Emacs as
1738 input, set Vlast_event_frame properly. If this doesn't
1739 get returned to Emacs as an event, the next event read
1740 will set Vlast_event_frame again, so this is safe to do. */
1743 FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
1746 internal_last_event_frame
= event
->frame_or_window
;
1748 internal_last_event_frame
= focus
;
1749 Vlast_event_frame
= internal_last_event_frame
;
1753 last_event_timestamp
= event
->timestamp
;
1754 interrupt_signal ();
1758 if (c
&& c
== stop_character
)
1764 XSET (event
->code
, Lisp_Int
, c
);
1767 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
1768 kbd_store_ptr
= kbd_buffer
;
1770 /* Don't let the very last slot in the buffer become full,
1771 since that would make the two pointers equal,
1772 and that is indistinguishable from an empty buffer.
1773 Discard the event if it would fill the last slot. */
1774 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
1776 kbd_store_ptr
->kind
= event
->kind
;
1777 kbd_store_ptr
->code
= event
->code
;
1778 kbd_store_ptr
->part
= event
->part
;
1779 kbd_store_ptr
->frame_or_window
= event
->frame_or_window
;
1780 kbd_store_ptr
->modifiers
= event
->modifiers
;
1781 kbd_store_ptr
->x
= event
->x
;
1782 kbd_store_ptr
->y
= event
->y
;
1783 kbd_store_ptr
->timestamp
= event
->timestamp
;
1784 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
1786 = event
->frame_or_window
);
1792 static Lisp_Object
make_lispy_event ();
1793 static Lisp_Object
make_lispy_movement ();
1794 static Lisp_Object
modify_event_symbol ();
1795 static Lisp_Object
make_lispy_switch_frame ();
1798 kbd_buffer_get_event ()
1806 XSET (obj
, Lisp_Int
, c
);
1811 /* Wait until there is input available. */
1814 if (!EVENT_QUEUES_EMPTY
)
1817 /* If the quit flag is set, then read_char will return
1818 quit_char, so that counts as "available input." */
1819 if (!NILP (Vquit_flag
))
1820 quit_throw_to_read_char ();
1822 /* One way or another, wait until input is available; then, if
1823 interrupt handlers have not read it, read it now. */
1826 wait_for_kbd_input ();
1828 /* Note SIGIO has been undef'd if FIONREAD is missing. */
1832 if (EVENT_QUEUES_EMPTY
)
1834 Lisp_Object minus_one
;
1836 XSET (minus_one
, Lisp_Int
, -1);
1837 wait_reading_process_input (0, 0, minus_one
, 1);
1839 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
1841 read_avail_input (0);
1844 #endif /* not VMS */
1847 /* At this point, we know that there is a readable event available
1848 somewhere. If the event queue is empty, then there must be a
1849 mouse movement enabled and available. */
1850 if (kbd_fetch_ptr
!= kbd_store_ptr
)
1852 struct input_event
*event
;
1854 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
1858 last_event_timestamp
= event
->timestamp
;
1862 /* These two kinds of events get special handling
1863 and don't actually appear to the command loop. */
1864 if (event
->kind
== selection_request_event
)
1867 x_handle_selection_request (event
);
1868 kbd_fetch_ptr
= event
+ 1;
1870 /* We're getting selection request events, but we don't have
1876 else if (event
->kind
== selection_clear_event
)
1879 x_handle_selection_clear (event
);
1880 kbd_fetch_ptr
= event
+ 1;
1882 /* We're getting selection request events, but we don't have
1888 /* If this event is on a different frame, return a switch-frame this
1889 time, and leave the event in the queue for next time. */
1893 Lisp_Object frame
= event
->frame_or_window
;
1896 if (XTYPE (frame
) == Lisp_Window
)
1897 frame
= WINDOW_FRAME (XWINDOW (frame
));
1899 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
1903 if (! EQ (frame
, internal_last_event_frame
)
1904 && XFRAME (frame
) != selected_frame
)
1905 obj
= make_lispy_switch_frame (frame
);
1906 internal_last_event_frame
= frame
;
1907 #endif /* MULTI_FRAME */
1909 /* If we didn't decide to make a switch-frame event, go ahead
1910 and build a real event from the queue entry. */
1914 obj
= make_lispy_event (event
);
1916 /* Wipe out this event, to catch bugs. */
1917 event
->kind
= no_event
;
1918 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
1921 kbd_fetch_ptr
= event
+ 1;
1925 else if (do_mouse_tracking
&& mouse_moved
)
1928 Lisp_Object bar_window
;
1929 enum scroll_bar_part part
;
1933 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
1938 /* Decide if we should generate a switch-frame event. Don't
1939 generate switch-frame events for motion outside of all Emacs
1943 Lisp_Object frame
= FRAME_FOCUS_FRAME (f
);
1946 XSET (frame
, Lisp_Frame
, f
);
1948 if (! EQ (frame
, internal_last_event_frame
)
1949 && XFRAME (frame
) != selected_frame
)
1950 obj
= make_lispy_switch_frame (frame
);
1951 internal_last_event_frame
= frame
;
1955 /* If we didn't decide to make a switch-frame event, go ahead and
1956 return a mouse-motion event. */
1958 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
1961 /* We were promised by the above while loop that there was
1962 something for us to read! */
1966 /* If something gave back nil as the Lispy event,
1967 it means the event was discarded, so try again. */
1972 input_pending
= readable_events ();
1975 Vlast_event_frame
= internal_last_event_frame
;
1981 /* Process any events that are not user-visible. */
1986 while (kbd_fetch_ptr
!= kbd_store_ptr
)
1988 struct input_event
*event
;
1990 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
1994 last_event_timestamp
= event
->timestamp
;
1996 /* These two kinds of events get special handling
1997 and don't actually appear to the command loop. */
1998 if (event
->kind
== selection_request_event
)
2001 x_handle_selection_request (event
);
2002 kbd_fetch_ptr
= event
+ 1;
2004 /* We're getting selection request events, but we don't have
2010 else if (event
->kind
== selection_clear_event
)
2013 x_handle_selection_clear (event
);
2014 kbd_fetch_ptr
= event
+ 1;
2016 /* We're getting selection request events, but we don't have
2025 get_input_pending (&input_pending
);
2028 /* Caches for modify_event_symbol. */
2029 static Lisp_Object func_key_syms
;
2030 static Lisp_Object mouse_syms
;
2032 /* You'll notice that this table is arranged to be conveniently
2033 indexed by X Windows keysym values. */
2034 static char *lispy_function_keys
[] =
2036 /* X Keysym value */
2038 "remove", 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2046 0, 0, 0, /* 0xff10 */
2048 0, 0, 0, 0, 0, 0, 0,
2051 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2052 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2053 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2055 "home", /* 0xff50 */ /* IsCursorKey */
2066 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2077 "break", /* 0xff6b */
2079 /* Here are some keys found mostly on HP keyboards. The X event
2080 handling code will strip bit 29, which flags vendor-specific
2082 "reset", /* 0x1000ff6c */
2091 "kp-backtab", /* 0x1000ff75 */
2093 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2094 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2095 0, 0, 0, 0, 0, 0, 0, 0,
2096 "kp-tab", /* 0xff89 */
2098 "kp-enter", /* 0xff8d */
2100 "kp-f1", /* 0xff91 */
2105 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2106 "kp-multiply", /* 0xffaa */
2111 "kp-divide", /* 0xffaf */
2112 "kp-0", /* 0xffb0 */
2113 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2116 "kp-equal", /* 0xffbd */
2117 "f1", /* 0xffbe */ /* IsFunctionKey */
2119 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2120 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2121 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2122 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2123 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2124 0, 0, 0, 0, 0, 0, 0, 0,
2125 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2126 0, 0, 0, 0, 0, 0, 0, "delete"
2129 static char *lispy_mouse_names
[] =
2131 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2134 /* Scroll bar parts. */
2135 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2137 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2138 Lisp_Object
*scroll_bar_parts
[] = {
2139 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2143 /* A vector, indexed by button number, giving the down-going location
2144 of currently depressed buttons, both scroll bar and non-scroll bar.
2146 The elements have the form
2147 (BUTTON-NUMBER MODIFIER-MASK . REST)
2148 where REST is the cdr of a position as it would be reported in the event.
2150 The make_lispy_event function stores positions here to tell the
2151 difference between click and drag events, and to store the starting
2152 location to be included in drag events. */
2154 static Lisp_Object button_down_location
;
2156 /* Information about the most recent up-going button event: Which
2157 button, what location, and what time. */
2159 static int button_up_button
;
2160 static int button_up_x
;
2161 static int button_up_y
;
2162 static unsigned long button_up_time
;
2164 /* The maximum time between clicks to make a double-click,
2165 or Qnil to disable double-click detection,
2166 or Qt for no time limit. */
2167 Lisp_Object Vdouble_click_time
;
2169 /* The number of clicks in this multiple-click. */
2171 int double_click_count
;
2173 /* Given a struct input_event, build the lisp event which represents
2174 it. If EVENT is 0, build a mouse movement event from the mouse
2175 movement buffer, which should have a movement event in it.
2177 Note that events must be passed to this function in the order they
2178 are received; this function stores the location of button presses
2179 in order to build drag events when the button is released. */
2182 make_lispy_event (event
)
2183 struct input_event
*event
;
2185 #ifdef SWITCH_ENUM_BUG
2186 switch ((int) event
->kind
)
2188 switch (event
->kind
)
2191 /* A simple keystroke. */
2192 case ascii_keystroke
:
2194 int c
= XFASTINT (event
->code
);
2195 /* Turn ASCII characters into control characters
2197 if (event
->modifiers
& ctrl_modifier
)
2198 c
= make_ctrl_char (c
);
2200 /* Add in the other modifier bits. We took care of ctrl_modifier
2201 just above, and the shift key was taken care of by the X code,
2202 and applied to control characters by make_ctrl_char. */
2203 c
|= (event
->modifiers
2204 & (meta_modifier
| alt_modifier
2205 | hyper_modifier
| super_modifier
));
2210 /* A function key. The symbol may need to have modifier prefixes
2212 case non_ascii_keystroke
:
2214 return modify_event_symbol (XFASTINT (event
->code
), event
->modifiers
,
2216 lispy_function_keys
, &func_key_syms
,
2217 (sizeof (lispy_function_keys
)
2218 / sizeof (lispy_function_keys
[0])));
2221 /* A mouse click. Figure out where it is, decide whether it's
2222 a press, click or drag, and build the appropriate structure. */
2224 case scroll_bar_click
:
2226 int button
= XFASTINT (event
->code
);
2227 Lisp_Object position
;
2228 Lisp_Object
*start_pos_ptr
;
2229 Lisp_Object start_pos
;
2231 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2234 /* Build the position as appropriate for this mouse click. */
2235 if (event
->kind
== mouse_click
)
2238 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2240 = window_from_coordinates (f
, XINT (event
->x
), XINT (event
->y
),
2244 if (XINT (event
->y
) < FRAME_MENU_BAR_LINES (f
))
2248 items
= FRAME_MENU_BAR_ITEMS (f
);
2249 for (; CONSP (items
); items
= XCONS (items
)->cdr
)
2251 Lisp_Object pos
, string
;
2252 pos
= Fcdr (Fcdr (Fcar (items
)));
2253 string
= Fcar (Fcdr (Fcar (items
)));
2254 if (XINT (event
->x
) >= XINT (pos
)
2255 && XINT (event
->x
) < XINT (pos
) + XSTRING (string
)->size
)
2259 = Fcons (event
->frame_or_window
,
2261 Fcons (Fcons (event
->x
, event
->y
),
2262 Fcons (make_number (event
->timestamp
),
2266 return Fcons (Fcar (Fcar (items
)),
2267 Fcons (position
, Qnil
));
2269 return Fcons (Qnil
, Fcons (position
, Qnil
));
2271 else if (XTYPE (window
) != Lisp_Window
)
2276 (XINT (event
->x
) - XINT (XWINDOW (window
)->left
)));
2278 (XINT (event
->y
) - XINT (XWINDOW (window
)->top
)));
2283 posn
= Qvertical_line
;
2285 XSET (posn
, Lisp_Int
,
2286 buffer_posn_from_coords (XWINDOW (window
),
2294 Fcons (Fcons (event
->x
, event
->y
),
2295 Fcons (make_number (event
->timestamp
),
2300 Lisp_Object window
= event
->frame_or_window
;
2301 Lisp_Object portion_whole
= Fcons (event
->x
, event
->y
);
2302 Lisp_Object part
= *scroll_bar_parts
[(int) event
->part
];
2306 Fcons (Qvertical_scroll_bar
,
2307 Fcons (portion_whole
,
2308 Fcons (make_number (event
->timestamp
),
2313 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2315 start_pos
= *start_pos_ptr
;
2316 *start_pos_ptr
= Qnil
;
2318 /* If this is a button press, squirrel away the location, so
2319 we can decide later whether it was a click or a drag. */
2320 if (event
->modifiers
& down_modifier
)
2321 *start_pos_ptr
= Fcopy_alist (position
);
2323 /* Now we're releasing a button - check the co-ordinates to
2324 see if this was a click or a drag. */
2325 else if (event
->modifiers
& up_modifier
)
2327 /* If we did not see a down before this up,
2328 ignore the up. Probably this happened because
2329 the down event chose a menu item.
2330 It would be an annoyance to treat the release
2331 of the button that chose the menu item
2332 as a separate event. */
2334 if (XTYPE (start_pos
) != Lisp_Cons
)
2337 event
->modifiers
&= ~up_modifier
;
2338 #if 0 /* Formerly we treated an up with no down as a click event. */
2339 if (XTYPE (start_pos
) != Lisp_Cons
)
2340 event
->modifiers
|= click_modifier
;
2344 /* The third element of every position should be the (x,y)
2346 Lisp_Object down
= Fnth (make_number (2), start_pos
);
2348 if (EQ (event
->x
, XCONS (down
)->car
)
2349 && EQ (event
->y
, XCONS (down
)->cdr
))
2351 if (button
== button_up_button
2352 && XINT (event
->x
) == button_up_x
2353 && XINT (event
->y
) == button_up_y
2354 && button_up_time
!= 0
2355 && (EQ (Vdouble_click_time
, Qt
)
2356 || (INTEGERP (Vdouble_click_time
)
2357 && ((int)(event
->timestamp
- button_up_time
)
2358 < XINT (Vdouble_click_time
)))))
2360 double_click_count
++;
2361 event
->modifiers
|= ((double_click_count
> 2)
2367 double_click_count
= 1;
2368 event
->modifiers
|= click_modifier
;
2370 button_up_button
= button
;
2371 button_up_x
= XINT (event
->x
);
2372 button_up_y
= XINT (event
->y
);
2373 button_up_time
= event
->timestamp
;
2378 event
->modifiers
|= drag_modifier
;
2383 /* Every mouse event should either have the down_modifier or
2384 the up_modifier set. */
2388 /* Get the symbol we should use for the mouse click. */
2390 = modify_event_symbol (button
,
2393 lispy_mouse_names
, &mouse_syms
,
2394 (sizeof (lispy_mouse_names
)
2395 / sizeof (lispy_mouse_names
[0])));
2397 if (event
->modifiers
& drag_modifier
)
2402 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2405 Fcons (make_number (double_click_count
),
2414 /* The 'kind' field of the event is something we don't recognize. */
2421 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2423 Lisp_Object bar_window
;
2424 enum scroll_bar_part part
;
2428 /* Is it a scroll bar movement? */
2429 if (frame
&& ! NILP (bar_window
))
2431 Lisp_Object part_sym
= *scroll_bar_parts
[(int) part
];
2433 return Fcons (Qscroll_bar_movement
,
2434 (Fcons (Fcons (bar_window
,
2435 Fcons (Qvertical_scroll_bar
,
2436 Fcons (Fcons (x
, y
),
2437 Fcons (make_number (time
),
2443 /* Or is it an ordinary mouse movement? */
2447 Lisp_Object window
=
2449 ? window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
)
2453 if (XTYPE (window
) == Lisp_Window
)
2455 XSETINT (x
, XINT (x
) - XINT (XWINDOW (window
)->left
));
2456 XSETINT (y
, XINT (y
) - XINT (XWINDOW (window
)->top
));
2461 posn
= Qvertical_line
;
2463 XSET (posn
, Lisp_Int
,
2464 buffer_posn_from_coords (XWINDOW (window
),
2465 XINT (x
), XINT (y
)));
2475 return Fcons (Qmouse_movement
,
2476 Fcons (Fcons (window
,
2478 Fcons (Fcons (x
, y
),
2479 Fcons (make_number (time
),
2485 /* Construct a switch frame event. */
2487 make_lispy_switch_frame (frame
)
2490 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
2493 /* Manipulating modifiers. */
2495 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
2497 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2498 SYMBOL's name of the end of the modifiers; the string from this
2499 position is the unmodified symbol name.
2501 This doesn't use any caches. */
2503 parse_modifiers_uncached (symbol
, modifier_end
)
2507 struct Lisp_String
*name
;
2511 CHECK_SYMBOL (symbol
, 1);
2514 name
= XSYMBOL (symbol
)->name
;
2517 for (i
= 0; i
+2 <= name
->size
; )
2518 switch (name
->data
[i
])
2520 #define SINGLE_LETTER_MOD(bit) \
2521 if (name->data[i+1] != '-') \
2522 goto no_more_modifiers; \
2527 SINGLE_LETTER_MOD (alt_modifier
);
2531 SINGLE_LETTER_MOD (ctrl_modifier
);
2535 SINGLE_LETTER_MOD (hyper_modifier
);
2539 SINGLE_LETTER_MOD (meta_modifier
);
2543 SINGLE_LETTER_MOD (shift_modifier
);
2547 SINGLE_LETTER_MOD (super_modifier
);
2551 if (i
+ 5 > name
->size
)
2552 goto no_more_modifiers
;
2553 if (! strncmp (name
->data
+ i
, "drag-", 5))
2555 modifiers
|= drag_modifier
;
2558 else if (! strncmp (name
->data
+ i
, "down-", 5))
2560 modifiers
|= down_modifier
;
2563 else if (i
+ 7 <= name
->size
2564 && ! strncmp (name
->data
+ i
, "double-", 7))
2566 modifiers
|= double_modifier
;
2570 goto no_more_modifiers
;
2574 if (i
+ 7 > name
->size
)
2575 goto no_more_modifiers
;
2576 if (! strncmp (name
->data
+ i
, "triple-", 7))
2578 modifiers
|= triple_modifier
;
2582 goto no_more_modifiers
;
2586 goto no_more_modifiers
;
2588 #undef SINGLE_LETTER_MOD
2592 /* Should we include the `click' modifier? */
2593 if (! (modifiers
& (down_modifier
| drag_modifier
2594 | double_modifier
| triple_modifier
))
2595 && i
+ 7 == name
->size
2596 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
2597 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
2598 modifiers
|= click_modifier
;
2607 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
2608 prepended to the string BASE[0..BASE_LEN-1].
2609 This doesn't use any caches. */
2611 apply_modifiers_uncached (modifiers
, base
, base_len
)
2616 /* Since BASE could contain nulls, we can't use intern here; we have
2617 to use Fintern, which expects a genuine Lisp_String, and keeps a
2620 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
2626 /* Only the event queue may use the `up' modifier; it should always
2627 be turned into a click or drag event before presented to lisp code. */
2628 if (modifiers
& up_modifier
)
2631 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
2632 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
2633 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
2634 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
2635 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
2636 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
2637 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
2638 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
2639 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
2640 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
2641 /* The click modifier is denoted by the absence of other modifiers. */
2645 mod_len
= p
- new_mods
;
2649 Lisp_Object new_name
= make_uninit_string (mod_len
+ base_len
);
2651 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
2652 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
2654 return Fintern (new_name
, Qnil
);
2659 static char *modifier_names
[] =
2661 "up", "down", "drag", "click", "double", "triple", 0, 0,
2662 0, 0, 0, 0, 0, 0, 0, 0,
2663 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
2665 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
2667 static Lisp_Object modifier_symbols
;
2669 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
2671 lispy_modifier_list (modifiers
)
2674 Lisp_Object modifier_list
;
2677 modifier_list
= Qnil
;
2678 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
2679 if (modifiers
& (1<<i
))
2680 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
2683 return modifier_list
;
2687 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
2688 where UNMODIFIED is the unmodified form of SYMBOL,
2689 MASK is the set of modifiers present in SYMBOL's name.
2690 This is similar to parse_modifiers_uncached, but uses the cache in
2691 SYMBOL's Qevent_symbol_element_mask property, and maintains the
2692 Qevent_symbol_elements property. */
2694 parse_modifiers (symbol
)
2697 Lisp_Object elements
= Fget (symbol
, Qevent_symbol_element_mask
);
2699 if (CONSP (elements
))
2704 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
2705 Lisp_Object unmodified
2706 = Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
2707 XSYMBOL (symbol
)->name
->size
- end
),
2711 if (modifiers
& ~((1<<VALBITS
) - 1))
2713 XFASTINT (mask
) = modifiers
;
2714 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
2716 /* Cache the parsing results on SYMBOL. */
2717 Fput (symbol
, Qevent_symbol_element_mask
,
2719 Fput (symbol
, Qevent_symbol_elements
,
2720 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
2722 /* Since we know that SYMBOL is modifiers applied to unmodified,
2723 it would be nice to put that in unmodified's cache.
2724 But we can't, since we're not sure that parse_modifiers is
2731 /* Apply the modifiers MODIFIERS to the symbol BASE.
2732 BASE must be unmodified.
2734 This is like apply_modifiers_uncached, but uses BASE's
2735 Qmodifier_cache property, if present. It also builds
2736 Qevent_symbol_elements properties, since it has that info anyway.
2738 apply_modifiers copies the value of BASE's Qevent_kind property to
2739 the modified symbol. */
2741 apply_modifiers (modifiers
, base
)
2745 Lisp_Object cache
, index
, entry
, new_symbol
;
2747 /* Mask out upper bits. We don't know where this value's been. */
2748 modifiers
&= (1<<VALBITS
) - 1;
2750 /* The click modifier never figures into cache indices. */
2751 cache
= Fget (base
, Qmodifier_cache
);
2752 XFASTINT (index
) = (modifiers
& ~click_modifier
);
2753 entry
= Fassq (index
, cache
);
2756 new_symbol
= XCONS (entry
)->cdr
;
2759 /* We have to create the symbol ourselves. */
2760 new_symbol
= apply_modifiers_uncached (modifiers
,
2761 XSYMBOL (base
)->name
->data
,
2762 XSYMBOL (base
)->name
->size
);
2764 /* Add the new symbol to the base's cache. */
2765 entry
= Fcons (index
, new_symbol
);
2766 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
2768 /* We have the parsing info now for free, so add it to the caches. */
2769 XFASTINT (index
) = modifiers
;
2770 Fput (new_symbol
, Qevent_symbol_element_mask
,
2771 Fcons (base
, Fcons (index
, Qnil
)));
2772 Fput (new_symbol
, Qevent_symbol_elements
,
2773 Fcons (base
, lispy_modifier_list (modifiers
)));
2776 /* Make sure this symbol is of the same kind as BASE.
2778 You'd think we could just set this once and for all when we
2779 intern the symbol above, but reorder_modifiers may call us when
2780 BASE's property isn't set right; we can't assume that just
2781 because it has a Qmodifier_cache property it must have its
2782 Qevent_kind set right as well. */
2783 if (NILP (Fget (new_symbol
, Qevent_kind
)))
2785 Lisp_Object kind
= Fget (base
, Qevent_kind
);
2788 Fput (new_symbol
, Qevent_kind
, kind
);
2795 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
2796 return a symbol with the modifiers placed in the canonical order.
2797 Canonical order is alphabetical, except for down and drag, which
2798 always come last. The 'click' modifier is never written out.
2800 Fdefine_key calls this to make sure that (for example) C-M-foo
2801 and M-C-foo end up being equivalent in the keymap. */
2804 reorder_modifiers (symbol
)
2807 /* It's hopefully okay to write the code this way, since everything
2808 will soon be in caches, and no consing will be done at all. */
2809 Lisp_Object parsed
= parse_modifiers (symbol
);
2811 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
2812 XCONS (parsed
)->car
);
2816 /* For handling events, we often want to produce a symbol whose name
2817 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
2818 to some base, like the name of a function key or mouse button.
2819 modify_event_symbol produces symbols of this sort.
2821 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
2822 is the name of the i'th symbol. TABLE_SIZE is the number of elements
2825 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
2826 persist between calls to modify_event_symbol that it can use to
2827 store a cache of the symbols it's generated for this NAME_TABLE
2830 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
2832 MODIFIERS is a set of modifier bits (as given in struct input_events)
2833 whose prefixes should be applied to the symbol name.
2835 SYMBOL_KIND is the value to be placed in the event_kind property of
2836 the returned symbol.
2838 The symbols we create are supposed to have an
2839 `event-symbol-elements' property, which lists the modifiers present
2840 in the symbol's name. */
2843 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_table
,
2844 symbol_table
, table_size
)
2847 Lisp_Object symbol_kind
;
2849 Lisp_Object
*symbol_table
;
2854 /* Is this a request for a valid symbol? */
2855 if (symbol_num
< 0 || symbol_num
>= table_size
)
2858 /* If *symbol_table doesn't seem to be initialized properly, fix that.
2859 *symbol_table should be a lisp vector TABLE_SIZE elements long,
2860 where the Nth element is the symbol for NAME_TABLE[N], or nil if
2861 we've never used that symbol before. */
2862 if (XTYPE (*symbol_table
) != Lisp_Vector
2863 || XVECTOR (*symbol_table
)->size
!= table_size
)
2867 XFASTINT (size
) = table_size
;
2868 *symbol_table
= Fmake_vector (size
, Qnil
);
2871 slot
= & XVECTOR (*symbol_table
)->contents
[symbol_num
];
2873 /* Have we already used this symbol before? */
2876 /* No; let's create it. */
2877 if (name_table
[symbol_num
])
2878 *slot
= intern (name_table
[symbol_num
]);
2882 sprintf (buf
, "key-%d", symbol_num
);
2883 *slot
= intern (buf
);
2886 /* Fill in the cache entries for this symbol; this also
2887 builds the Qevent_symbol_elements property, which the user
2889 apply_modifiers (modifiers
& click_modifier
, *slot
);
2890 Fput (*slot
, Qevent_kind
, symbol_kind
);
2893 /* Apply modifiers to that symbol. */
2894 return apply_modifiers (modifiers
, *slot
);
2898 /* Store into *addr a value nonzero if terminal input chars are available.
2899 Serves the purpose of ioctl (0, FIONREAD, addr)
2900 but works even if FIONREAD does not exist.
2901 (In fact, this may actually read some input.) */
2904 get_input_pending (addr
)
2907 /* First of all, have we already counted some input? */
2908 *addr
= !NILP (Vquit_flag
) || readable_events ();
2910 /* If input is being read as it arrives, and we have none, there is none. */
2911 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
2914 /* Try to read some input and see how much we get. */
2916 *addr
= !NILP (Vquit_flag
) || readable_events ();
2919 /* Interface to read_avail_input, blocking SIGIO if necessary. */
2922 gobble_input (expected
)
2927 if (interrupt_input
)
2930 mask
= sigblockx (SIGIO
);
2931 read_avail_input (expected
);
2936 read_avail_input (expected
);
2942 /* Read any terminal input already buffered up by the system
2943 into the kbd_buffer, but do not wait.
2945 EXPECTED should be nonzero if the caller knows there is some input.
2947 Except on VMS, all input is read by this function.
2948 If interrupt_input is nonzero, this function MUST be called
2949 only when SIGIO is blocked.
2951 Returns the number of keyboard chars read, or -1 meaning
2952 this is a bad time to try to read input. */
2955 read_avail_input (expected
)
2958 struct input_event buf
[KBD_BUFFER_SIZE
];
2962 if (read_socket_hook
)
2963 /* No need for FIONREAD or fcntl; just say don't wait. */
2964 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
2967 unsigned char cbuf
[KBD_BUFFER_SIZE
];
2970 /* Find out how much input is available. */
2971 if (ioctl (0, FIONREAD
, &nread
) < 0)
2972 /* Formerly simply reported no input, but that sometimes led to
2973 a failure of Emacs to terminate.
2974 SIGHUP seems appropriate if we can't reach the terminal. */
2975 /* ??? Is it really right to send the signal just to this process
2976 rather than to the whole process group?
2977 Perhaps on systems with FIONREAD Emacs is alone in its group. */
2978 kill (getpid (), SIGHUP
);
2981 if (nread
> sizeof cbuf
)
2982 nread
= sizeof cbuf
;
2983 #else /* no FIONREAD */
2985 /* Read some input if available, but don't wait. */
2986 nread
= sizeof cbuf
;
2987 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
2993 /* Now read; for one reason or another, this will not block. */
2996 nread
= read (fileno (stdin
), cbuf
, nread
);
2998 /* The kernel sometimes fails to deliver SIGHUP for ptys.
2999 This looks incorrect, but it isn't, because _BSD causes
3000 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3001 and that causes a value other than 0 when there is no input. */
3005 /* Retry the read if it is interrupted. */
3007 || ! (errno
== EAGAIN
|| errno
== EFAULT
3017 fcntl (fileno (stdin
), F_SETFL
, 0);
3019 #endif /* no FIONREAD */
3020 for (i
= 0; i
< nread
; i
++)
3022 buf
[i
].kind
= ascii_keystroke
;
3023 buf
[i
].modifiers
= 0;
3024 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3025 buf
[i
].modifiers
= meta_modifier
;
3029 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
3031 XSET (buf
[i
].frame_or_window
, Lisp_Frame
, selected_frame
);
3033 buf
[i
].frame_or_window
= Qnil
;
3038 /* Scan the chars for C-g and store them in kbd_buffer. */
3039 for (i
= 0; i
< nread
; i
++)
3041 kbd_buffer_store_event (&buf
[i
]);
3042 /* Don't look at input that follows a C-g too closely.
3043 This reduces lossage due to autorepeat on C-g. */
3044 if (buf
[i
].kind
== ascii_keystroke
3045 && XINT(buf
[i
].code
) == quit_char
)
3051 #endif /* not VMS */
3053 #ifdef SIGIO /* for entire page */
3054 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3057 input_available_signal (signo
)
3060 /* Must preserve main program's value of errno. */
3061 int old_errno
= errno
;
3063 extern int select_alarmed
;
3067 /* USG systems forget handlers when they are used;
3068 must reestablish each time */
3069 signal (signo
, input_available_signal
);
3076 if (input_available_clear_time
)
3077 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3082 nread
= read_avail_input (1);
3083 /* -1 means it's not ok to read the input now.
3084 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3085 0 means there was no keyboard input available. */
3090 select_alarmed
= 1; /* Force the select emulator back to life */
3101 /* Send ourselves a SIGIO.
3103 This function exists so that the UNBLOCK_INPUT macro in
3104 blockinput.h can have some way to take care of input we put off
3105 dealing with, without assuming that every file which uses
3106 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3108 reinvoke_input_signal ()
3117 /* Return the prompt-string of a sparse keymap.
3118 This is the first element which is a string.
3119 Return nil if there is none. */
3127 register Lisp_Object tem
;
3129 if (XTYPE (tem
) == Lisp_String
)
3136 static Lisp_Object
menu_bar_item ();
3137 static Lisp_Object
menu_bar_one_keymap ();
3139 /* Return a list of menu items for a menu bar, appropriate
3140 to the current buffer.
3141 The elements have the form (KEY STRING . nil). */
3146 /* The number of keymaps we're scanning right now, and the number of
3147 keymaps we have allocated space for. */
3150 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3151 in the current keymaps, or nil where it is not a prefix. */
3154 Lisp_Object def
, tem
;
3161 /* In order to build the menus, we need to call the keymap
3162 accessors. They all call QUIT. But this function is called
3163 during redisplay, during which a quit is fatal. So inhibit
3164 quitting while building the menus.
3165 We do this instead of specbind because (1) errors will clear it anyway
3166 and (2) this avoids risk of specpdl overflow. */
3167 oquit
= Vinhibit_quit
;
3170 /* Build our list of keymaps.
3171 If we recognize a function key and replace its escape sequence in
3172 keybuf with its symbol, or if the sequence starts with a mouse
3173 click and we need to switch buffers, we jump back here to rebuild
3174 the initial keymaps from the current buffer. */
3178 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3179 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3180 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3181 #ifdef USE_TEXT_PROPERTIES
3182 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3184 maps
[nmaps
-2] = current_buffer
->keymap
;
3186 maps
[nmaps
-1] = current_global_map
;
3189 /* Look up in each map the dummy prefix key `menu-bar'. */
3193 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3195 if (! NILP (maps
[mapno
]))
3196 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3200 tem
= Fkeymapp (def
);
3202 result
= menu_bar_one_keymap (def
, result
);
3205 result
= menu_bar_one_keymap (Vhelp_menu_bar_map
, result
);
3207 result
= Fnreverse (result
);
3208 Vinhibit_quit
= oquit
;
3212 /* Scan one map KEYMAP, accumulating any menu items it defines
3213 that have not yet been seen in RESULT. Return the updated RESULT. */
3216 menu_bar_one_keymap (keymap
, result
)
3217 Lisp_Object keymap
, result
;
3219 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3221 /* Loop over all keymap entries that have menu strings. */
3222 for (tail
= keymap
; XTYPE (tail
) == Lisp_Cons
; tail
= XCONS (tail
)->cdr
)
3224 item
= XCONS (tail
)->car
;
3225 if (XTYPE (item
) == Lisp_Cons
)
3227 key
= XCONS (item
)->car
;
3228 binding
= XCONS (item
)->cdr
;
3229 if (XTYPE (binding
) == Lisp_Cons
)
3231 item_string
= XCONS (binding
)->car
;
3232 if (XTYPE (item_string
) == Lisp_String
)
3233 result
= menu_bar_item (key
, item_string
,
3234 Fcdr (binding
), result
);
3236 else if (EQ (binding
, Qundefined
))
3237 result
= menu_bar_item (key
, item_string
,
3240 else if (XTYPE (item
) == Lisp_Vector
)
3242 /* Loop over the char values represented in the vector. */
3243 int len
= XVECTOR (item
)->size
;
3245 for (c
= 0; c
< len
; c
++)
3247 Lisp_Object character
;
3248 XFASTINT (character
) = c
;
3249 binding
= XVECTOR (item
)->contents
[c
];
3250 if (XTYPE (binding
) == Lisp_Cons
)
3252 item_string
= XCONS (binding
)->car
;
3253 if (XTYPE (item_string
) == Lisp_String
)
3254 result
= menu_bar_item (key
, item_string
,
3255 Fcdr (binding
), result
);
3257 else if (EQ (binding
, Qundefined
))
3258 result
= menu_bar_item (key
, item_string
,
3268 menu_bar_item (key
, item_string
, def
, result
)
3269 Lisp_Object key
, item_string
, def
, result
;
3272 Lisp_Object enabled
;
3274 if (EQ (def
, Qundefined
))
3276 /* If a map has an explicit nil as definition,
3277 discard any previously made menu bar item. */
3278 tem
= Fassq (key
, result
);
3279 return Fdelq (tem
, result
);
3282 /* See if this entry is enabled. */
3285 if (XTYPE (def
) == Lisp_Symbol
)
3287 /* No property, or nil, means enable.
3288 Otherwise, enable if value is not nil. */
3289 tem
= Fget (def
, Qmenu_enable
);
3291 enabled
= Feval (tem
);
3294 /* Add an entry for this key and string
3295 if there is none yet. */
3296 tem
= Fassq (key
, result
);
3297 if (!NILP (enabled
) && NILP (tem
))
3298 result
= Fcons (Fcons (key
, Fcons (item_string
, Qnil
)), result
);
3303 static int echo_flag
;
3304 static int echo_now
;
3306 /* Read a character like read_char but optionally prompt based on maps
3307 in the array MAPS. NMAPS is the length of MAPS. Return nil if we
3308 decided not to read a character, because there are no menu items in
3311 PREV_EVENT is the previous input event, or nil if we are reading
3312 the first event of a key sequence.
3314 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3315 if we used a mouse menu to read the input, or zero otherwise. If
3316 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
3318 The prompting is done based on the prompt-string of the map
3319 and the strings associated with various map elements. */
3322 read_char_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
3325 Lisp_Object prev_event
;
3326 int *used_mouse_menu
;
3329 register Lisp_Object name
;
3331 int width
= FRAME_WIDTH (selected_frame
) - 4;
3332 char *menu
= (char *) alloca (width
+ 4);
3334 Lisp_Object rest
, vector
;
3336 if (used_mouse_menu
)
3337 *used_mouse_menu
= 0;
3339 /* Use local over global Menu maps */
3341 if (! menu_prompting
)
3344 /* Get the menu name from the first map that has one (a prompt string). */
3345 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3347 name
= map_prompt (maps
[mapno
]);
3352 /* If we don't have any menus, just read a character normally. */
3356 #ifdef HAVE_X_WINDOWS
3358 /* If we got to this point via a mouse click,
3359 use a real menu for mouse selection. */
3360 if (EVENT_HAS_PARAMETERS (prev_event
))
3362 /* Display the menu and get the selection. */
3363 Lisp_Object
*realmaps
3364 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
3368 /* Use the maps that are not nil. */
3369 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3370 if (!NILP (maps
[mapno
]))
3371 realmaps
[nmaps1
++] = maps
[mapno
];
3373 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
3376 /* If we got more than one event, put all but the first
3377 onto this list to be read later.
3378 Return just the first event now. */
3379 unread_command_events
3380 = nconc2 (XCONS (value
)->cdr
, unread_command_events
);
3381 value
= XCONS (value
)->car
;
3384 XSET (value
, Lisp_Int
, quit_char
);
3385 if (used_mouse_menu
)
3386 *used_mouse_menu
= 1;
3389 #endif /* HAVE_X_MENU */
3390 #endif /* HAVE_X_WINDOWS */
3392 /* Prompt string always starts with map's prompt, and a space. */
3393 strcpy (menu
, XSTRING (name
)->data
);
3394 nlength
= XSTRING (name
)->size
;
3395 menu
[nlength
++] = ':';
3396 menu
[nlength
++] = ' ';
3399 /* Start prompting at start of first map. */
3403 /* Present the documented bindings, a line at a time. */
3411 /* Loop over elements of map. */
3416 /* If reached end of map, start at beginning of next map. */
3420 /* At end of last map, wrap around to first map if just starting,
3421 or end this line if already have something on it. */
3432 /* Look at the next element of the map. */
3434 elt
= XVECTOR (vector
)->contents
[idx
];
3436 elt
= Fcar_safe (rest
);
3438 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
3440 /* If we found a dense table in the keymap,
3441 advanced past it, but start scanning its contents. */
3442 rest
= Fcdr_safe (rest
);
3448 /* An ordinary element. */
3449 s
= Fcar_safe (Fcdr_safe (elt
));
3450 if (XTYPE (s
) != Lisp_String
)
3451 /* Ignore the element if it has no prompt string. */
3453 /* If we have room for the prompt string, add it to this line.
3454 If this is the first on the line, always add it. */
3455 else if (XSTRING (s
)->size
+ i
< width
3460 /* Punctuate between strings. */
3463 strcpy (menu
+ i
, ", ");
3468 /* Add as much of string as fits. */
3469 thiswidth
= XSTRING (s
)->size
;
3470 if (thiswidth
+ i
> width
)
3471 thiswidth
= width
- i
;
3472 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
3477 /* If this element does not fit, end the line now,
3478 and save the element for the next line. */
3479 strcpy (menu
+ i
, "...");
3483 /* Move past this element. */
3484 if (idx
>= 0 && idx
+ 1 >= XVECTOR (rest
)->size
)
3485 /* Handle reaching end of dense table. */
3490 rest
= Fcdr_safe (rest
);
3494 /* Prompt with that and read response. */
3496 obj
= read_char (1, 0, 0, Qnil
, 0);
3498 if (XTYPE (obj
) != Lisp_Int
)
3503 if (! EQ (obj
, menu_prompt_more_char
)
3504 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
3505 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
3510 /* Reading key sequences. */
3512 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
3513 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
3514 keymap, or nil otherwise. Return the index of the first keymap in
3515 which KEY has any binding, or NMAPS if no map has a binding.
3517 If KEY is a meta ASCII character, treat it like meta-prefix-char
3518 followed by the corresponding non-meta character. Keymaps in
3519 CURRENT with non-prefix bindings for meta-prefix-char become nil in
3522 When KEY is not defined in any of the keymaps, if it is an upper
3523 case letter and there are bindings for the corresponding lower-case
3524 letter, return the bindings for the lower-case letter.
3526 If KEY has no bindings in any of the CURRENT maps, NEXT is left
3529 NEXT may == CURRENT. */
3532 follow_key (key
, nmaps
, current
, defs
, next
)
3534 Lisp_Object
*current
, *defs
, *next
;
3537 int i
, first_binding
;
3539 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
3540 followed by the corresponding non-meta character. */
3541 if (XTYPE (key
) == Lisp_Int
&& (XINT (key
) & CHAR_META
))
3543 for (i
= 0; i
< nmaps
; i
++)
3544 if (! NILP (current
[i
]))
3547 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
3549 /* Note that since we pass the resulting bindings through
3550 get_keymap_1, non-prefix bindings for meta-prefix-char
3552 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
3558 XSET (key
, Lisp_Int
, XFASTINT (key
) & ~CHAR_META
);
3561 first_binding
= nmaps
;
3562 for (i
= nmaps
- 1; i
>= 0; i
--)
3564 if (! NILP (current
[i
]))
3566 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3567 if (! NILP (defs
[i
]))
3574 /* When KEY is not defined in any of the keymaps, if it is an upper
3575 case letter and there are bindings for the corresponding
3576 lower-case letter, return the bindings for the lower-case letter. */
3577 if (first_binding
== nmaps
3578 && XTYPE (key
) == Lisp_Int
3579 && ((((XINT (key
) & 0x3ffff)
3580 < XSTRING (current_buffer
->downcase_table
)->size
)
3581 && UPPERCASEP (XINT (key
) & 0x3ffff))
3582 || (XINT (key
) & shift_modifier
)))
3584 if (XINT (key
) & shift_modifier
)
3585 XSETINT (key
, XINT (key
) & ~shift_modifier
);
3587 XSETINT (key
, DOWNCASE (XINT (key
)));
3589 first_binding
= nmaps
;
3590 for (i
= nmaps
- 1; i
>= 0; i
--)
3592 if (! NILP (current
[i
]))
3594 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3595 if (! NILP (defs
[i
]))
3603 /* Given the set of bindings we've found, produce the next set of maps. */
3604 if (first_binding
< nmaps
)
3605 for (i
= 0; i
< nmaps
; i
++)
3606 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
3608 return first_binding
;
3611 /* Read a sequence of keys that ends with a non prefix character,
3612 storing it in KEYBUF, a buffer of size BUFSIZE.
3614 Return the length of the key sequence stored.
3616 Echo starting immediately unless `prompt' is 0.
3618 Where a key sequence ends depends on the currently active keymaps.
3619 These include any minor mode keymaps active in the current buffer,
3620 the current buffer's local map, and the global map.
3622 If a key sequence has no other bindings, we check Vfunction_key_map
3623 to see if some trailing subsequence might be the beginning of a
3624 function key's sequence. If so, we try to read the whole function
3625 key, and substitute its symbolic name into the key sequence.
3627 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
3628 `double-' events into similar click events, if that would make them
3629 bound. We try to turn `triple-' events first into `double-' events,
3632 If we get a mouse click in a mode line, vertical divider, or other
3633 non-text area, we treat the click as if it were prefixed by the
3634 symbol denoting that area - `mode-line', `vertical-line', or
3637 If the sequence starts with a mouse click, we read the key sequence
3638 with respect to the buffer clicked on, not the current buffer.
3640 If the user switches frames in the midst of a key sequence, we put
3641 off the switch-frame event until later; the next call to
3642 read_char will return it. */
3645 read_key_sequence (keybuf
, bufsize
, prompt
)
3646 Lisp_Object
*keybuf
;
3650 int count
= specpdl_ptr
- specpdl
;
3652 /* How many keys there are in the current key sequence. */
3655 /* The length of the echo buffer when we started reading, and
3656 the length of this_command_keys when we started reading. */
3660 /* The number of keymaps we're scanning right now, and the number of
3661 keymaps we have allocated space for. */
3663 int nmaps_allocated
= 0;
3665 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
3666 the current keymaps. */
3669 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3670 in the current keymaps, or nil where it is not a prefix. */
3671 Lisp_Object
*submaps
;
3673 /* The index in defs[] of the first keymap that has a binding for
3674 this key sequence. In other words, the lowest i such that
3675 defs[i] is non-nil. */
3678 /* If t < mock_input, then KEYBUF[t] should be read as the next
3681 We use this to recover after recognizing a function key. Once we
3682 realize that a suffix of the current key sequence is actually a
3683 function key's escape sequence, we replace the suffix with the
3684 function key's binding from Vfunction_key_map. Now keybuf
3685 contains a new and different key sequence, so the echo area,
3686 this_command_keys, and the submaps and defs arrays are wrong. In
3687 this situation, we set mock_input to t, set t to 0, and jump to
3688 restart_sequence; the loop will read keys from keybuf up until
3689 mock_input, thus rebuilding the state; and then it will resume
3690 reading characters from the keyboard. */
3693 /* If the sequence is unbound in submaps[], then
3694 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
3695 and fkey_map is its binding.
3697 These might be > t, indicating that all function key scanning
3698 should hold off until t reaches them. We do this when we've just
3699 recognized a function key, to avoid searching for the function
3700 key's again in Vfunction_key_map. */
3701 int fkey_start
= 0, fkey_end
= 0;
3702 Lisp_Object fkey_map
;
3704 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
3705 we put it off for later. While we're reading, we keep the event here. */
3706 Lisp_Object delayed_switch_frame
;
3708 Lisp_Object first_event
;
3712 last_nonmenu_event
= Qnil
;
3714 delayed_switch_frame
= Qnil
;
3715 fkey_map
= Vfunction_key_map
;
3717 /* If there is no function key map, turn off function key scanning. */
3718 if (NILP (Fkeymapp (Vfunction_key_map
)))
3719 fkey_start
= fkey_end
= bufsize
+ 1;
3724 echo_prompt (prompt
);
3725 else if (cursor_in_echo_area
)
3726 /* This doesn't put in a dash if the echo buffer is empty, so
3727 you don't always see a dash hanging out in the minibuffer. */
3731 /* Record the initial state of the echo area and this_command_keys;
3732 we will need to restore them if we replay a key sequence. */
3734 echo_start
= echo_length ();
3735 keys_start
= this_command_key_count
;
3737 #if 0 /* This doesn't quite work, because some of the things
3738 that read_char does cannot safely be bypassed.
3739 It seems too risky to try to make this work right. */
3740 /* Read the first char of the sequence specially, before setting
3741 up any keymaps, in case a filter runs and switches buffers on us. */
3742 first_event
= read_char (!prompt
, 0, submaps
, last_nonmenu_event
,
3746 /* We jump here when the key sequence has been thoroughly changed, and
3747 we need to rescan it starting from the beginning. When we jump here,
3748 keybuf[0..mock_input] holds the sequence we should reread. */
3751 /* Build our list of keymaps.
3752 If we recognize a function key and replace its escape sequence in
3753 keybuf with its symbol, or if the sequence starts with a mouse
3754 click and we need to switch buffers, we jump back here to rebuild
3755 the initial keymaps from the current buffer. */
3759 nmaps
= current_minor_maps (0, &maps
) + 2;
3760 if (nmaps
> nmaps_allocated
)
3762 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
3763 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
3764 nmaps_allocated
= nmaps
;
3766 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
3767 #ifdef USE_TEXT_PROPERTIES
3768 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3770 submaps
[nmaps
-2] = current_buffer
->keymap
;
3772 submaps
[nmaps
-1] = current_global_map
;
3775 /* Find an accurate initial value for first_binding. */
3776 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
3777 if (! NILP (submaps
[first_binding
]))
3780 /* We jump here when a function key substitution has forced us to
3781 reprocess the current key sequence. keybuf[0..mock_input] is the
3782 sequence we want to reread. */
3785 /* These are no-ops the first time through, but if we restart, they
3786 revert the echo area and this_command_keys to their original state. */
3787 this_command_key_count
= keys_start
;
3789 echo_truncate (echo_start
);
3791 /* If the best binding for the current key sequence is a keymap, or
3792 we may be looking at a function key's escape sequence, keep on
3794 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
3795 || (first_binding
>= nmaps
3797 /* mock input is never part of a function key's sequence. */
3798 && mock_input
<= fkey_start
))
3801 int used_mouse_menu
= 0;
3803 /* Where the last real key started. If we need to throw away a
3804 key that has expanded into more than one element of keybuf
3805 (say, a mouse click on the mode line which is being treated
3806 as [mode-line (mouse-...)], then we backtrack to this point
3808 int last_real_key_start
;
3810 /* These variables are analogous to echo_start and keys_start;
3811 while those allow us to restart the entire key sequence,
3812 echo_local_start and keys_local_start allow us to throw away
3814 int echo_local_start
, keys_local_start
, local_first_binding
;
3817 error ("key sequence too long");
3820 echo_local_start
= echo_length ();
3821 keys_local_start
= this_command_key_count
;
3822 local_first_binding
= first_binding
;
3825 /* These are no-ops, unless we throw away a keystroke below and
3826 jumped back up to replay_key; in that case, these restore the
3827 variables to their original state, allowing us to replay the
3830 echo_truncate (echo_local_start
);
3831 this_command_key_count
= keys_local_start
;
3832 first_binding
= local_first_binding
;
3834 /* By default, assume each event is "real". */
3835 last_real_key_start
= t
;
3837 /* Does mock_input indicate that we are re-reading a key sequence? */
3841 add_command_key (key
);
3845 /* If not, we should actually read a character. */
3848 struct buffer
*buf
= current_buffer
;
3850 key
= read_char (!prompt
, nmaps
, submaps
, last_nonmenu_event
,
3853 /* read_char returns -1 at the end of a macro.
3854 Emacs 18 handles this by returning immediately with a
3855 zero, so that's what we'll do. */
3856 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) == -1)
3865 /* Clicks in non-text areas get prefixed by the symbol
3866 in their CHAR-ADDRESS field. For example, a click on
3867 the mode line is prefixed by the symbol `mode-line'.
3869 Furthermore, key sequences beginning with mouse clicks
3870 are read using the keymaps of the buffer clicked on, not
3871 the current buffer. So we may have to switch the buffer
3874 When we turn one event into two events, we must make sure
3875 that neither of the two looks like the original--so that,
3876 if we replay the events, they won't be expanded again.
3877 If not for this, such reexpansion could happen either here
3878 or when user programs play with this-command-keys. */
3879 if (EVENT_HAS_PARAMETERS (key
))
3881 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
3883 if (EQ (kind
, Qmouse_click
))
3885 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
3886 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
3888 if (XTYPE (posn
) == Lisp_Cons
)
3890 /* We're looking at the second event of a
3891 sequence which we expanded before. Set
3892 last_real_key_start appropriately. */
3894 last_real_key_start
= t
- 1;
3897 /* Key sequences beginning with mouse clicks are
3898 read using the keymaps in the buffer clicked on,
3899 not the current buffer. If we're at the
3900 beginning of a key sequence, switch buffers. */
3901 if (last_real_key_start
== 0
3902 && XTYPE (window
) == Lisp_Window
3903 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
3904 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
3909 /* Arrange to go back to the original buffer once we're
3910 done reading the key sequence. Note that we can't
3911 use save_excursion_{save,restore} here, because they
3912 save point as well as the current buffer; we don't
3913 want to save point, because redisplay may change it,
3914 to accommodate a Fset_window_start or something. We
3915 don't want to do this at the top of the function,
3916 because we may get input from a subprocess which
3917 wants to change the selected window and stuff (say,
3919 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3921 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
3922 goto replay_sequence
;
3924 else if (XTYPE (posn
) == Lisp_Symbol
)
3926 /* Expand mode-line and scroll-bar events into two events:
3927 use posn as a fake prefix key. */
3929 if (t
+ 1 >= bufsize
)
3930 error ("key sequence too long");
3935 /* Zap the position in key, so we know that we've
3936 expanded it, and don't try to do so again. */
3937 POSN_BUFFER_POSN (EVENT_START (key
))
3938 = Fcons (posn
, Qnil
);
3942 else if (EQ (kind
, Qswitch_frame
))
3944 /* If we're at the beginning of a key sequence, go
3945 ahead and return this event. If we're in the
3946 midst of a key sequence, delay it until the end. */
3949 delayed_switch_frame
= key
;
3955 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
3957 /* Handle menu-bar events:
3958 insert the dummy prefix event `menu-bar'. */
3959 if (EQ (posn
, Qmenu_bar
))
3961 if (t
+ 1 >= bufsize
)
3962 error ("key sequence too long");
3963 /* Run the Lucid hook. */
3964 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
3965 /* If it has changed current-menubar from previous value,
3966 really recompute the menubar from the value. */
3967 if (! NILP (Vlucid_menu_bar_dirty_flag
))
3968 call0 (Qrecompute_lucid_menubar
);
3972 /* Zap the position in key, so we know that we've
3973 expanded it, and don't try to do so again. */
3974 POSN_BUFFER_POSN (EVENT_START (key
))
3975 = Fcons (posn
, Qnil
);
3978 goto replay_sequence
;
3980 else if (XTYPE (posn
) == Lisp_Cons
)
3982 /* We're looking at the second event of a
3983 sequence which we expanded before. Set
3984 last_real_key_start appropriately. */
3985 if (last_real_key_start
== t
&& t
> 0)
3986 last_real_key_start
= t
- 1;
3991 /* We have finally decided that KEY is something we might want
3993 first_binding
= (follow_key (key
,
3994 nmaps
- first_binding
,
3995 submaps
+ first_binding
,
3996 defs
+ first_binding
,
3997 submaps
+ first_binding
)
4000 /* If KEY wasn't bound, we'll try some fallbacks. */
4001 if (first_binding
>= nmaps
)
4003 Lisp_Object head
= EVENT_HEAD (key
);
4005 if (EQ (head
, Vhelp_char
))
4007 read_key_sequence_cmd
= Vprefix_help_command
;
4009 last_nonmenu_event
= key
;
4013 if (XTYPE (head
) == Lisp_Symbol
)
4015 Lisp_Object breakdown
= parse_modifiers (head
);
4016 int modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4018 /* We drop unbound `down-' events altogether. */
4019 if (modifiers
& down_modifier
)
4021 /* Dispose of this event by simply jumping back to
4022 replay_key, to get another event.
4024 Note that if this event came from mock input,
4025 then just jumping back to replay_key will just
4026 hand it to us again. So we have to wipe out any
4029 We could delete keybuf[t] and shift everything
4030 after that to the left by one spot, but we'd also
4031 have to fix up any variable that points into
4032 keybuf, and shifting isn't really necessary
4035 Adding prefixes for non-textual mouse clicks
4036 creates two characters of mock input, and both
4037 must be thrown away. If we're only looking at
4038 the prefix now, we can just jump back to
4039 replay_key. On the other hand, if we've already
4040 processed the prefix, and now the actual click
4041 itself is giving us trouble, then we've lost the
4042 state of the keymaps we want to backtrack to, and
4043 we need to replay the whole sequence to rebuild
4046 Beyond that, only function key expansion could
4047 create more than two keys, but that should never
4048 generate mouse events, so it's okay to zero
4049 mock_input in that case too.
4051 Isn't this just the most wonderful code ever? */
4052 if (t
== last_real_key_start
)
4059 mock_input
= last_real_key_start
;
4060 goto replay_sequence
;
4064 /* We turn unbound `drag-' events into `click-'
4065 events, if the click would be bound. */
4066 else if (modifiers
& (drag_modifier
| double_modifier
4069 while (modifiers
& (drag_modifier
| double_modifier
4072 Lisp_Object new_head
, new_click
;
4073 if (modifiers
& triple_modifier
)
4074 modifiers
^= (double_modifier
| triple_modifier
);
4076 modifiers
&= ~(drag_modifier
| double_modifier
);
4078 apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
4080 Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
4082 /* Look for a binding for this new key. follow_key
4083 promises that it didn't munge submaps the
4084 last time we called it, since key was unbound. */
4086 (follow_key (new_click
,
4087 nmaps
- local_first_binding
,
4088 submaps
+ local_first_binding
,
4089 defs
+ local_first_binding
,
4090 submaps
+ local_first_binding
)
4091 + local_first_binding
);
4093 /* If that click is bound, go for it. */
4094 if (first_binding
< nmaps
)
4099 /* Otherwise, we'll leave key set to the drag event. */
4106 /* Normally, last_nonmenu_event gets the previous key we read.
4107 But when a mouse popup menu is being used,
4108 we don't update last_nonmenu_event; it continues to hold the mouse
4109 event that preceded the first level of menu. */
4110 if (!used_mouse_menu
)
4111 last_nonmenu_event
= key
;
4113 /* If the sequence is unbound, see if we can hang a function key
4114 off the end of it. We only want to scan real keyboard input
4115 for function key sequences, so if mock_input says that we're
4116 re-reading old events, don't examine it. */
4117 if (first_binding
>= nmaps
4120 Lisp_Object fkey_next
;
4122 /* Scan from fkey_end until we find a bound suffix. */
4123 while (fkey_end
< t
)
4127 key
= keybuf
[fkey_end
++];
4128 /* Look up meta-characters by prefixing them
4129 with meta_prefix_char. I hate this. */
4130 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4135 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
4137 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4140 fkey_next
= fkey_map
;
4143 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
4145 /* If keybuf[fkey_start..fkey_end] is bound in the
4146 function key map and it's a suffix of the current
4147 sequence (i.e. fkey_end == t), replace it with
4148 the binding and restart with fkey_start at the end. */
4149 if (XTYPE (fkey_next
) == Lisp_Vector
4152 t
= fkey_start
+ XVECTOR (fkey_next
)->size
;
4154 error ("key sequence too long");
4156 bcopy (XVECTOR (fkey_next
)->contents
,
4157 keybuf
+ fkey_start
,
4158 (t
- fkey_start
) * sizeof (keybuf
[0]));
4161 fkey_start
= fkey_end
= t
;
4162 fkey_map
= Vfunction_key_map
;
4164 goto replay_sequence
;
4167 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
4169 /* If we no longer have a bound suffix, try a new positions for
4171 if (NILP (fkey_map
))
4173 fkey_end
= ++fkey_start
;
4174 fkey_map
= Vfunction_key_map
;
4180 read_key_sequence_cmd
= (first_binding
< nmaps
4181 ? defs
[first_binding
]
4185 unread_switch_frame
= delayed_switch_frame
;
4186 unbind_to (count
, Qnil
);
4188 /* Occasionally we fabricate events, perhaps by expanding something
4189 according to function-key-map, or by adding a prefix symbol to a
4190 mouse click in the scroll bar or modeline. In this cases, return
4191 the entire generated key sequence, even if we hit an unbound
4192 prefix or a definition before the end. This means that you will
4193 be able to push back the event properly, and also means that
4194 read-key-sequence will always return a logical unit.
4197 for (; t
< mock_input
; t
++)
4199 echo_char (keybuf
[t
]);
4200 add_command_key (keybuf
[t
]);
4206 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4207 "Read a sequence of keystrokes and return as a string or vector.\n\
4208 The sequence is sufficient to specify a non-prefix command in the\n\
4209 current local and global maps.\n\
4211 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
4212 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
4213 as a continuation of the previous key.\n\
4215 A C-g typed while in this function is treated like any other character,\n\
4216 and `quit-flag' is not set.\n\
4218 If the key sequence starts with a mouse click, then the sequence is read\n\
4219 using the keymaps of the buffer of the window clicked in, not the buffer\n\
4220 of the selected window as normal.\n\
4222 `read-key-sequence' drops unbound button-down events, since you normally\n\
4223 only care about the click or drag events which follow them. If a drag\n\
4224 or multi-click event is unbound, but the corresponding click event would\n\
4225 be bound, `read-key-sequence' turns the event into a click event at the\n\
4226 drag's starting position. This means that you don't have to distinguish\n\
4227 between click and drag, double, or triple events unless you want to.\n\
4229 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
4230 lines separating windows, and scroll bars with imaginary keys\n\
4231 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
4233 If the user switches frames in the middle of a key sequence, the\n\
4234 frame-switch event is put off until after the current key sequence.\n\
4236 `read-key-sequence' checks `function-key-map' for function key\n\
4237 sequences, where they wouldn't conflict with ordinary bindings. See\n\
4238 `function-key-map' for more details.")
4239 (prompt
, continue_echo
)
4240 Lisp_Object prompt
, continue_echo
;
4242 Lisp_Object keybuf
[30];
4244 struct gcpro gcpro1
, gcpro2
;
4247 CHECK_STRING (prompt
, 0);
4250 bzero (keybuf
, sizeof keybuf
);
4252 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
4254 if (NILP (continue_echo
))
4255 this_command_key_count
= 0;
4257 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
4258 NILP (prompt
) ? 0 : XSTRING (prompt
)->data
);
4261 return make_event_array (i
, keybuf
);
4264 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
4265 "Execute CMD as an editor command.\n\
4266 CMD must be a symbol that satisfies the `commandp' predicate.\n\
4267 Optional second arg RECORD-FLAG non-nil\n\
4268 means unconditionally put this command in `command-history'.\n\
4269 Otherwise, that is done only if an arg is read using the minibuffer.")
4271 Lisp_Object cmd
, record
;
4273 register Lisp_Object final
;
4274 register Lisp_Object tem
;
4275 Lisp_Object prefixarg
;
4276 struct backtrace backtrace
;
4277 extern int debug_on_next_call
;
4279 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
4280 Vcurrent_prefix_arg
= prefixarg
;
4281 debug_on_next_call
= 0;
4283 if (XTYPE (cmd
) == Lisp_Symbol
)
4285 tem
= Fget (cmd
, Qdisabled
);
4287 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
4292 final
= Findirect_function (cmd
);
4294 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
4295 do_autoload (final
, cmd
);
4300 if (XTYPE (final
) == Lisp_String
4301 || XTYPE (final
) == Lisp_Vector
)
4303 /* If requested, place the macro in the command history. For
4304 other sorts of commands, call-interactively takes care of
4308 = Fcons (Fcons (Qexecute_kbd_macro
,
4309 Fcons (final
, Fcons (prefixarg
, Qnil
))),
4312 return Fexecute_kbd_macro (final
, prefixarg
);
4314 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
4315 || XTYPE (final
) == Lisp_Compiled
)
4317 backtrace
.next
= backtrace_list
;
4318 backtrace_list
= &backtrace
;
4319 backtrace
.function
= &Qcall_interactively
;
4320 backtrace
.args
= &cmd
;
4321 backtrace
.nargs
= 1;
4322 backtrace
.evalargs
= 0;
4324 tem
= Fcall_interactively (cmd
, record
);
4326 backtrace_list
= backtrace
.next
;
4332 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
4334 "Read function name, then read its arguments and call it.")
4336 Lisp_Object prefixarg
;
4338 Lisp_Object function
;
4340 Lisp_Object saved_keys
;
4341 struct gcpro gcpro1
;
4343 saved_keys
= Fthis_command_keys ();
4345 GCPRO1 (saved_keys
);
4347 if (EQ (prefixarg
, Qminus
))
4349 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
4350 strcpy (buf
, "C-u ");
4351 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
4352 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
4353 else if (XTYPE (prefixarg
) == Lisp_Int
)
4354 sprintf (buf
, "%d ", XINT (prefixarg
));
4356 /* This isn't strictly correct if execute-extended-command
4357 is bound to anything else. Perhaps it should use
4358 this_command_keys? */
4359 strcat (buf
, "M-x ");
4361 /* Prompt with buf, and then read a string, completing from and
4362 restricting to the set of all defined commands. Don't provide
4363 any initial input. The last Qnil says not to perform a
4364 peculiar hack on the initial input. */
4365 function
= Fcompleting_read (build_string (buf
),
4366 Vobarray
, Qcommandp
,
4369 /* Set this_command_keys to the concatenation of saved_keys and
4370 function, followed by a RET. */
4372 struct Lisp_String
*str
;
4376 this_command_key_count
= 0;
4378 str
= XSTRING (saved_keys
);
4379 for (i
= 0; i
< str
->size
; i
++)
4381 XFASTINT (tem
) = str
->data
[i
];
4382 add_command_key (tem
);
4385 str
= XSTRING (function
);
4386 for (i
= 0; i
< str
->size
; i
++)
4388 XFASTINT (tem
) = str
->data
[i
];
4389 add_command_key (tem
);
4392 XFASTINT (tem
) = '\015';
4393 add_command_key (tem
);
4398 function
= Fintern (function
, Qnil
);
4399 Vprefix_arg
= prefixarg
;
4400 this_command
= function
;
4402 return Fcommand_execute (function
, Qt
);
4406 detect_input_pending ()
4409 get_input_pending (&input_pending
);
4411 return input_pending
;
4414 /* This is called in some cases before a possible quit.
4415 It cases the next call to detect_input_pending to recompute input_pending.
4416 So calling this function unnecessarily can't do any harm. */
4417 clear_input_pending ()
4422 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
4423 "T if command input is currently available with no waiting.\n\
4424 Actually, the value is nil only if we can be sure that no input is available.")
4427 if (!NILP (unread_command_events
) || unread_command_char
!= -1)
4430 return detect_input_pending () ? Qt
: Qnil
;
4433 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
4434 "Return vector of last 100 events, not counting those from keyboard macros.")
4437 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
4440 if (total_keys
< NUM_RECENT_KEYS
)
4441 return Fvector (total_keys
, keys
);
4444 val
= Fvector (NUM_RECENT_KEYS
, keys
);
4445 bcopy (keys
+ recent_keys_index
,
4446 XVECTOR (val
)->contents
,
4447 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
4449 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
4450 recent_keys_index
* sizeof (Lisp_Object
));
4455 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
4456 "Return the key sequence that invoked this command.\n\
4457 The value is a string or a vector.")
4460 return make_event_array (this_command_key_count
,
4461 XVECTOR (this_command_keys
)->contents
);
4464 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
4465 "Return the current depth in recursive edits.")
4469 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
4473 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
4474 "FOpen dribble file: ",
4475 "Start writing all keyboard characters to a dribble file called FILE.\n\
4476 If FILE is nil, close any open dribble file.")
4487 file
= Fexpand_file_name (file
, Qnil
);
4488 dribble
= fopen (XSTRING (file
)->data
, "w");
4493 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
4494 "Discard the contents of the terminal input buffer.\n\
4495 Also cancel any kbd macro being defined.")
4498 defining_kbd_macro
= 0;
4499 update_mode_lines
++;
4501 unread_command_events
= Qnil
;
4502 unread_command_char
= -1;
4504 discard_tty_input ();
4506 /* Without the cast, GCC complains that this assignment loses the
4507 volatile qualifier of kbd_store_ptr. Is there anything wrong
4509 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
4510 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
4516 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
4517 "Stop Emacs and return to superior process. You can resume later.\n\
4518 On systems that don't have job control, run a subshell instead.\n\n\
4519 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
4520 to be read as terminal input by Emacs's parent, after suspension.\n\
4522 Before suspending, call the functions in `suspend-hook' with no args.\n\
4523 If any of them returns nil, don't call the rest and don't suspend.\n\
4524 Otherwise, suspend normally and after resumption run the normal hook\n\
4525 `suspend-resume-hook' if that is bound and non-nil.\n\
4527 Some operating systems cannot stop the Emacs process and resume it later.\n\
4528 On such systems, Emacs starts a subshell instead of suspending.")
4530 Lisp_Object stuffstring
;
4533 int count
= specpdl_ptr
- specpdl
;
4534 int old_height
, old_width
;
4536 struct gcpro gcpro1
, gcpro2
;
4537 extern init_sys_modes ();
4539 if (!NILP (stuffstring
))
4540 CHECK_STRING (stuffstring
, 0);
4542 /* Run the functions in suspend-hook. */
4543 if (!NILP (Vrun_hooks
))
4544 call1 (Vrun_hooks
, intern ("suspend-hook"));
4546 GCPRO1 (stuffstring
);
4547 get_frame_size (&old_width
, &old_height
);
4549 /* sys_suspend can get an error if it tries to fork a subshell
4550 and the system resources aren't available for that. */
4551 record_unwind_protect (init_sys_modes
, 0);
4552 stuff_buffered_input (stuffstring
);
4554 unbind_to (count
, Qnil
);
4556 /* Check if terminal/window size has changed.
4557 Note that this is not useful when we are running directly
4558 with a window system; but suspend should be disabled in that case. */
4559 get_frame_size (&width
, &height
);
4560 if (width
!= old_width
|| height
!= old_height
)
4561 change_frame_size (0, height
, width
, 0, 0);
4563 /* Run suspend-resume-hook. */
4564 if (!NILP (Vrun_hooks
))
4565 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
4571 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
4572 Then in any case stuff anything Emacs has read ahead and not used. */
4574 stuff_buffered_input (stuffstring
)
4575 Lisp_Object stuffstring
;
4577 register unsigned char *p
;
4579 /* stuff_char works only in BSD, versions 4.2 and up. */
4582 if (XTYPE (stuffstring
) == Lisp_String
)
4586 p
= XSTRING (stuffstring
)->data
;
4587 count
= XSTRING (stuffstring
)->size
;
4592 /* Anything we have read ahead, put back for the shell to read. */
4593 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4595 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4596 kbd_fetch_ptr
= kbd_buffer
;
4597 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
4598 stuff_char (XINT (kbd_fetch_ptr
->code
));
4599 kbd_fetch_ptr
->kind
= no_event
;
4600 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
4607 #endif /* BSD and not BSD4_1 */
4610 set_waiting_for_input (time_to_clear
)
4611 EMACS_TIME
*time_to_clear
;
4613 input_available_clear_time
= time_to_clear
;
4615 /* Tell interrupt_signal to throw back to read_char, */
4616 waiting_for_input
= 1;
4618 /* If interrupt_signal was called before and buffered a C-g,
4619 make it run again now, to avoid timing error. */
4620 if (!NILP (Vquit_flag
))
4621 quit_throw_to_read_char ();
4623 /* If alarm has gone off already, echo now. */
4631 clear_waiting_for_input ()
4633 /* Tell interrupt_signal not to throw back to read_char, */
4634 waiting_for_input
= 0;
4635 input_available_clear_time
= 0;
4638 /* This routine is called at interrupt level in response to C-G.
4639 If interrupt_input, this is the handler for SIGINT.
4640 Otherwise, it is called from kbd_buffer_store_event,
4641 in handling SIGIO or SIGTINT.
4643 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
4644 immediately throw back to read_char.
4646 Otherwise it sets the Lisp variable quit-flag not-nil.
4647 This causes eval to throw, when it gets a chance.
4648 If quit-flag is already non-nil, it stops the job right away. */
4654 /* Must preserve main program's value of errno. */
4655 int old_errno
= errno
;
4658 /* USG systems forget handlers when they are used;
4659 must reestablish each time */
4660 signal (SIGINT
, interrupt_signal
);
4661 signal (SIGQUIT
, interrupt_signal
);
4666 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
4671 #ifdef SIGTSTP /* Support possible in later USG versions */
4673 * On systems which can suspend the current process and return to the original
4674 * shell, this command causes the user to end up back at the shell.
4675 * The "Auto-save" and "Abort" questions are not asked until
4676 * the user elects to return to emacs, at which point he can save the current
4677 * job and either dump core or continue.
4682 if (sys_suspend () == -1)
4684 printf ("Not running as a subprocess;\n");
4685 printf ("you can continue or abort.\n");
4688 /* Perhaps should really fork an inferior shell?
4689 But that would not provide any way to get back
4690 to the original shell, ever. */
4691 printf ("No support for stopping a process on this operating system;\n");
4692 printf ("you can continue or abort.\n");
4693 #endif /* not VMS */
4694 #endif /* not SIGTSTP */
4695 printf ("Auto-save? (y or n) ");
4697 if (((c
= getchar ()) & ~040) == 'Y')
4698 Fdo_auto_save (Qnil
, Qnil
);
4699 while (c
!= '\n') c
= getchar ();
4701 printf ("Abort (and enter debugger)? (y or n) ");
4703 printf ("Abort (and dump core)? (y or n) ");
4704 #endif /* not VMS */
4706 if (((c
= getchar ()) & ~040) == 'Y')
4708 while (c
!= '\n') c
= getchar ();
4709 printf ("Continuing...\n");
4715 /* If executing a function that wants to be interrupted out of
4716 and the user has not deferred quitting by binding `inhibit-quit'
4717 then quit right away. */
4718 if (immediate_quit
&& NILP (Vinhibit_quit
))
4722 Fsignal (Qquit
, Qnil
);
4725 /* Else request quit when it's safe */
4729 if (waiting_for_input
&& !echoing
)
4730 quit_throw_to_read_char ();
4735 /* Handle a C-g by making read_char return C-g. */
4737 quit_throw_to_read_char ()
4739 quit_error_check ();
4741 /* Prevent another signal from doing this before we finish. */
4742 clear_waiting_for_input ();
4745 unread_command_events
= Qnil
;
4746 unread_command_char
= -1;
4748 #ifdef POLL_FOR_INPUT
4749 /* May be > 1 if in recursive minibuffer. */
4750 if (poll_suppress_count
== 0)
4754 _longjmp (getcjmp
, 1);
4757 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
4758 "Set mode of reading keyboard input.\n\
4759 First arg INTERRUPT non-nil means use input interrupts;\n\
4760 nil means use CBREAK mode.\n\
4761 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
4762 (no effect except in CBREAK mode).\n\
4763 Third arg META t means accept 8-bit input (for a Meta key).\n\
4764 META nil means ignore the top bit, on the assumption it is parity.\n\
4765 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
4766 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
4767 See also `current-input-mode'.")
4768 (interrupt
, flow
, meta
, quit
)
4769 Lisp_Object interrupt
, flow
, meta
, quit
;
4772 && (XTYPE (quit
) != Lisp_Int
4773 || XINT (quit
) < 0 || XINT (quit
) > 0400))
4774 error ("set-input-mode: QUIT must be an ASCII character.");
4778 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4779 #ifdef NO_SOCK_SIGIO
4780 if (read_socket_hook
)
4781 interrupt_input
= 0; /* No interrupts if reading from a socket. */
4783 #endif /* NO_SOCK_SIGIO */
4784 interrupt_input
= !NILP (interrupt
);
4785 #else /* not SIGIO */
4786 interrupt_input
= 0;
4787 #endif /* not SIGIO */
4788 /* Our VMS input only works by interrupts, as of now. */
4790 interrupt_input
= 1;
4792 flow_control
= !NILP (flow
);
4795 else if (EQ (meta
, Qt
))
4800 /* Don't let this value be out of range. */
4801 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
4807 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
4808 "Return information about the way Emacs currently reads keyboard input.\n\
4809 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
4810 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
4811 nil, Emacs is using CBREAK mode.\n\
4812 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
4813 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
4814 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
4815 META nil means ignoring the top bit, on the assumption it is parity.\n\
4816 META is neither t nor nil if accepting 8-bit input and using\n\
4817 all 8 bits as the character code.\n\
4818 QUIT is the character Emacs currently uses to quit.\n\
4819 The elements of this list correspond to the arguments of\n\
4825 val
[0] = interrupt_input
? Qt
: Qnil
;
4826 val
[1] = flow_control
? Qt
: Qnil
;
4827 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
4828 XFASTINT (val
[3]) = quit_char
;
4830 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
4836 /* This is correct before outermost invocation of the editor loop */
4837 command_loop_level
= -1;
4839 quit_char
= Ctl ('g');
4840 unread_command_events
= Qnil
;
4841 unread_command_char
= -1;
4843 recent_keys_index
= 0;
4844 kbd_fetch_ptr
= kbd_buffer
;
4845 kbd_store_ptr
= kbd_buffer
;
4846 do_mouse_tracking
= 0;
4850 /* This means that command_loop_1 won't try to select anything the first
4852 internal_last_event_frame
= Qnil
;
4853 Vlast_event_frame
= internal_last_event_frame
;
4856 /* If we're running a dumped Emacs, we need to clear out
4857 kbd_buffer_frame_or_window, in case some events got into it
4860 If we're running an undumped Emacs, it hasn't been initialized by
4861 syms_of_keyboard yet. */
4863 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
4865 if (!noninteractive
)
4867 signal (SIGINT
, interrupt_signal
);
4868 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
4869 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
4870 SIGQUIT and we can't tell which one it will give us. */
4871 signal (SIGQUIT
, interrupt_signal
);
4872 #endif /* HAVE_TERMIO */
4873 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4875 signal (SIGIO
, input_available_signal
);
4879 /* Use interrupt input by default, if it works and noninterrupt input
4880 has deficiencies. */
4882 #ifdef INTERRUPT_INPUT
4883 interrupt_input
= 1;
4885 interrupt_input
= 0;
4888 /* Our VMS input only works by interrupts, as of now. */
4890 interrupt_input
= 1;
4896 if (keyboard_init_hook
)
4897 (*keyboard_init_hook
) ();
4899 #ifdef POLL_FOR_INPUT
4900 poll_suppress_count
= 1;
4905 /* This type's only use is in syms_of_keyboard, to initialize the
4906 event header symbols and put properties on them. */
4913 struct event_head head_table
[] = {
4914 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
4915 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
4916 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
4921 Qdisabled_command_hook
= intern ("disabled-command-hook");
4922 staticpro (&Qdisabled_command_hook
);
4924 Qself_insert_command
= intern ("self-insert-command");
4925 staticpro (&Qself_insert_command
);
4927 Qforward_char
= intern ("forward-char");
4928 staticpro (&Qforward_char
);
4930 Qbackward_char
= intern ("backward-char");
4931 staticpro (&Qbackward_char
);
4933 Qdisabled
= intern ("disabled");
4934 staticpro (&Qdisabled
);
4936 Qundefined
= intern ("undefined");
4937 staticpro (&Qundefined
);
4939 Qpre_command_hook
= intern ("pre-command-hook");
4940 staticpro (&Qpre_command_hook
);
4942 Qpost_command_hook
= intern ("post-command-hook");
4943 staticpro (&Qpost_command_hook
);
4945 Qfunction_key
= intern ("function-key");
4946 staticpro (&Qfunction_key
);
4947 Qmouse_click
= intern ("mouse-click");
4948 staticpro (&Qmouse_click
);
4950 Qmenu_enable
= intern ("menu-enable");
4951 staticpro (&Qmenu_enable
);
4953 Qmode_line
= intern ("mode-line");
4954 staticpro (&Qmode_line
);
4955 Qvertical_line
= intern ("vertical-line");
4956 staticpro (&Qvertical_line
);
4957 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
4958 staticpro (&Qvertical_scroll_bar
);
4959 Qmenu_bar
= intern ("menu-bar");
4960 staticpro (&Qmenu_bar
);
4962 Qabove_handle
= intern ("above-handle");
4963 staticpro (&Qabove_handle
);
4964 Qhandle
= intern ("handle");
4965 staticpro (&Qhandle
);
4966 Qbelow_handle
= intern ("below-handle");
4967 staticpro (&Qbelow_handle
);
4969 Qevent_kind
= intern ("event-kind");
4970 staticpro (&Qevent_kind
);
4971 Qevent_symbol_elements
= intern ("event-symbol-elements");
4972 staticpro (&Qevent_symbol_elements
);
4973 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
4974 staticpro (&Qevent_symbol_element_mask
);
4975 Qmodifier_cache
= intern ("modifier-cache");
4976 staticpro (&Qmodifier_cache
);
4978 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
4979 staticpro (&Qrecompute_lucid_menubar
);
4980 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
4981 staticpro (&Qactivate_menubar_hook
);
4984 struct event_head
*p
;
4986 for (p
= head_table
;
4987 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
4990 *p
->var
= intern (p
->name
);
4992 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
4993 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
4997 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
4998 staticpro (&button_down_location
);
5002 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
5004 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
5005 for (i
= 0; i
< len
; i
++)
5006 if (modifier_names
[i
])
5007 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
5008 staticpro (&modifier_symbols
);
5011 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
5012 staticpro (&recent_keys
);
5014 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
5015 staticpro (&this_command_keys
);
5017 kbd_buffer_frame_or_window
5018 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
5019 staticpro (&kbd_buffer_frame_or_window
);
5021 func_key_syms
= Qnil
;
5022 staticpro (&func_key_syms
);
5025 staticpro (&mouse_syms
);
5027 unread_switch_frame
= Qnil
;
5028 staticpro (&unread_switch_frame
);
5030 defsubr (&Sread_key_sequence
);
5031 defsubr (&Srecursive_edit
);
5032 defsubr (&Strack_mouse
);
5033 defsubr (&Sinput_pending_p
);
5034 defsubr (&Scommand_execute
);
5035 defsubr (&Srecent_keys
);
5036 defsubr (&Sthis_command_keys
);
5037 defsubr (&Ssuspend_emacs
);
5038 defsubr (&Sabort_recursive_edit
);
5039 defsubr (&Sexit_recursive_edit
);
5040 defsubr (&Srecursion_depth
);
5041 defsubr (&Stop_level
);
5042 defsubr (&Sdiscard_input
);
5043 defsubr (&Sopen_dribble_file
);
5044 defsubr (&Sset_input_mode
);
5045 defsubr (&Scurrent_input_mode
);
5046 defsubr (&Sexecute_extended_command
);
5048 DEFVAR_LISP ("last-command-char", &last_command_char
,
5049 "Last input event that was part of a command.");
5051 DEFVAR_LISP ("last-command-event", &last_command_char
,
5052 "Last input event that was part of a command.");
5054 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
5055 "Last input event in a command, except for mouse menu events.\n\
5056 Mouse menus give back keys that don't look like mouse events;\n\
5057 this variable holds the actual mouse event that led to the menu,\n\
5058 so that you can determine whether the command was run by mouse or not.");
5060 DEFVAR_LISP ("last-input-char", &last_input_char
,
5061 "Last input event.");
5063 DEFVAR_LISP ("last-input-event", &last_input_char
,
5064 "Last input event.");
5066 DEFVAR_LISP ("unread-command-events", &unread_command_events
,
5067 "List of objects to be read as next command input events.");
5069 DEFVAR_INT ("unread-command-char", &unread_command_char
,
5070 "If not -1, an object to be read as next command input event.");
5072 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
5073 "Meta-prefix character code. Meta-foo as command input\n\
5074 turns into this character followed by foo.");
5075 XSET (meta_prefix_char
, Lisp_Int
, 033);
5077 DEFVAR_LISP ("last-command", &last_command
,
5078 "The last command executed. Normally a symbol with a function definition,\n\
5079 but can be whatever was found in the keymap, or whatever the variable\n\
5080 `this-command' was set to by that command.");
5081 last_command
= Qnil
;
5083 DEFVAR_LISP ("this-command", &this_command
,
5084 "The command now being executed.\n\
5085 The command can set this variable; whatever is put here\n\
5086 will be in `last-command' during the following command.");
5087 this_command
= Qnil
;
5089 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
5090 "*Number of keyboard input characters between auto-saves.\n\
5091 Zero means disable autosaving due to number of characters typed.");
5092 auto_save_interval
= 300;
5094 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
5095 "*Number of seconds idle time before auto-save.\n\
5096 Zero or nil means disable auto-saving due to idleness.\n\
5097 After auto-saving due to this many seconds of idle time,\n\
5098 Emacs also does a garbage collection if that seems to be warranted.");
5099 XFASTINT (Vauto_save_timeout
) = 30;
5101 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
5102 "*Nonzero means echo unfinished commands after this many seconds of pause.");
5103 echo_keystrokes
= 1;
5105 DEFVAR_INT ("polling-period", &polling_period
,
5106 "*Interval between polling for input during Lisp execution.\n\
5107 The reason for polling is to make C-g work to stop a running program.\n\
5108 Polling is needed only when using X windows and SIGIO does not work.\n\
5109 Polling is automatically disabled in all other cases.");
5112 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
5113 "*Maximum time between mouse clicks to make a double-click.\n\
5114 Measured in milliseconds. nil means disable double-click recognition;\n\
5115 t means double-clicks have no time limit and are detected\n\
5116 by position only.");
5117 Vdouble_click_time
= make_number (500);
5119 DEFVAR_INT ("num-input-keys", &num_input_keys
,
5120 "*Number of complete keys read from the keyboard so far.");
5124 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
5125 "*The frame in which the most recently read event occurred.\n\
5126 If the last event came from a keyboard macro, this is set to `macro'.");
5127 Vlast_event_frame
= Qnil
;
5130 DEFVAR_LISP ("help-char", &Vhelp_char
,
5131 "Character to recognize as meaning Help.\n\
5132 When it is read, do `(eval help-form)', and display result if it's a string.\n\
5133 If the value of `help-form' is nil, this char can be read normally.");
5134 XSET (Vhelp_char
, Lisp_Int
, Ctl ('H'));
5136 DEFVAR_LISP ("help-form", &Vhelp_form
,
5137 "Form to execute when character `help-char' is read.\n\
5138 If the form returns a string, that string is displayed.\n\
5139 If `help-form' is nil, the help char is not recognized.");
5142 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
5143 "Command to run when `help-char' character follows a prefix key.\n\
5144 This command is used only when there is no actual binding\n\
5145 for that character after that prefix key.");
5146 Vprefix_help_command
= Qnil
;
5148 DEFVAR_LISP ("top-level", &Vtop_level
,
5149 "Form to evaluate when Emacs starts up.\n\
5150 Useful to set before you dump a modified Emacs.");
5153 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
5154 "String used as translate table for keyboard input, or nil.\n\
5155 Each character is looked up in this string and the contents used instead.\n\
5156 If string is of length N, character codes N and up are untranslated.");
5157 Vkeyboard_translate_table
= Qnil
;
5159 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
5160 "Non-nil means prompt with menus when appropriate.\n\
5161 This is done when reading from a keymap that has a prompt string,\n\
5162 for elements that have prompt strings.\n\
5163 The menu is displayed on the screen\n\
5164 if X menus were enabled at configuration\n\
5165 time and the previous event was a mouse click prefix key.\n\
5166 Otherwise, menu prompting uses the echo area.");
5169 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
5170 "Character to see next line of menu prompt.\n\
5171 Type this character while in a menu prompt to rotate around the lines of it.");
5172 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
5174 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
5175 "A mask of additional modifier keys to use with every keyboard character.\n\
5176 Emacs applies the modifiers of the character stored here to each keyboard\n\
5177 character it reads. For example, after evaluating the expression\n\
5178 (setq extra-keyboard-modifiers ?\C-x)\n\
5179 all input characters will have the control modifier applied to them.\n\
5181 Note that the character ?\C-@, equivalent to the integer zero, does\n\
5182 not count as a control character; rather, it counts as a character\n\
5183 with no modifiers; thus, setting extra_keyboard_modifiers to zero\n\
5184 cancels any modification.");
5185 extra_keyboard_modifiers
= 0;
5187 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
5188 "If an editing command sets this to t, deactivate the mark afterward.\n\
5189 The command loop sets this to nil before each command,\n\
5190 and tests the value when the command returns.\n\
5191 Buffer modification stores t in this variable.");
5192 Vdeactivate_mark
= Qnil
;
5194 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
5195 "Normal hook run before each command is executed.");
5196 Vpre_command_hook
= Qnil
;
5198 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
5199 "Normal hook run after each command is executed.");
5200 Vpost_command_hook
= Qnil
;
5202 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
5203 "t means menu bar, specified Lucid style, needs to be recomputed.");
5204 Vlucid_menu_bar_dirty_flag
= Qnil
;
5206 DEFVAR_LISP ("help-menu-bar-map", &Vhelp_menu_bar_map
,
5207 "Keymap defining global menu items to appear at end of menu bar.");
5208 Vhelp_menu_bar_map
= Qnil
;
5213 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
5214 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
5215 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
5216 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
5217 initial_define_key (meta_map
, 'x', "execute-extended-command");