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"
48 #include <sys/ioctl.h>
50 #endif /* not MSDOS */
52 #include "syssignal.h"
58 /* Variables for blockinput.h: */
60 /* Non-zero if interrupt input is blocked right now. */
61 int interrupt_input_blocked
;
63 /* Nonzero means an input interrupt has arrived
64 during the current critical section. */
65 int interrupt_input_pending
;
69 extern Lisp_Object Vmouse_grabbed
;
71 /* Make all keyboard buffers much bigger when using X windows. */
72 #define KBD_BUFFER_SIZE 4096
73 #else /* No X-windows, character input */
74 #define KBD_BUFFER_SIZE 256
75 #endif /* No X-windows */
77 /* Following definition copied from eval.c */
81 struct backtrace
*next
;
82 Lisp_Object
*function
;
83 Lisp_Object
*args
; /* Points to vector of args. */
84 int nargs
; /* length of vector. If nargs is UNEVALLED,
85 args points to slot holding list of
90 /* Non-nil disable property on a command means
91 do not execute it; call disabled-command-hook's value instead. */
92 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
94 #define NUM_RECENT_KEYS (100)
95 int recent_keys_index
; /* Index for storing next element into recent_keys */
96 int total_keys
; /* Total number of elements stored into recent_keys */
97 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
99 /* Vector holding the key sequence that invoked the current command.
100 It is reused for each command, and it may be longer than the current
101 sequence; this_command_key_count indicates how many elements
102 actually mean something.
103 It's easier to staticpro a single Lisp_Object than an array. */
104 Lisp_Object this_command_keys
;
105 int this_command_key_count
;
107 extern int minbuf_level
;
109 extern struct backtrace
*backtrace_list
;
111 /* Nonzero means do menu prompting. */
112 static int menu_prompting
;
114 /* Character to see next line of menu prompt. */
115 static Lisp_Object menu_prompt_more_char
;
117 /* For longjmp to where kbd input is being done. */
118 static jmp_buf getcjmp
;
120 /* True while doing kbd input. */
121 int waiting_for_input
;
123 /* True while displaying for echoing. Delays C-g throwing. */
126 /* Nonzero means C-g should cause immediate error-signal. */
129 /* Character to recognize as the help char. */
130 Lisp_Object Vhelp_char
;
132 /* Form to execute when help char is typed. */
133 Lisp_Object Vhelp_form
;
135 /* Command to run when the help character follows a prefix key. */
136 Lisp_Object Vprefix_help_command
;
138 /* List of items that should move to the end of the menu bar. */
139 Lisp_Object Vmenu_bar_final_items
;
141 /* Character that causes a quit. Normally C-g.
143 If we are running on an ordinary terminal, this must be an ordinary
144 ASCII char, since we want to make it our interrupt character.
146 If we are not running on an ordinary terminal, it still needs to be
147 an ordinary ASCII char. This character needs to be recognized in
148 the input interrupt handler. At this point, the keystroke is
149 represented as a struct input_event, while the desired quit
150 character is specified as a lispy event. The mapping from struct
151 input_events to lispy events cannot run in an interrupt handler,
152 and the reverse mapping is difficult for anything but ASCII
155 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
159 extern Lisp_Object current_global_map
;
160 extern int minibuf_level
;
162 /* If non-nil, this is a map that overrides all other local maps. */
163 Lisp_Object Voverriding_local_map
;
165 /* Current depth in recursive edits. */
166 int command_loop_level
;
168 /* Total number of times command_loop has read a key sequence. */
171 /* Last input character read as a command. */
172 Lisp_Object last_command_char
;
174 /* Last input character read as a command, not counting menus
175 reached by the mouse. */
176 Lisp_Object last_nonmenu_event
;
178 /* Last input character read for any purpose. */
179 Lisp_Object last_input_char
;
181 /* If not Qnil, a list of objects to be read as subsequent command input. */
182 Lisp_Object unread_command_events
;
184 /* If not -1, an event to be read as subsequent command input. */
185 int unread_command_char
;
187 /* If not Qnil, this is a switch-frame event which we decided to put
188 off until the end of a key sequence. This should be read as the
189 next command input, after any unread_command_events.
191 read_key_sequence uses this to delay switch-frame events until the
192 end of the key sequence; Fread_char uses it to put off switch-frame
193 events until a non-ASCII event is acceptable as input. */
194 Lisp_Object unread_switch_frame
;
196 /* A mask of extra modifier bits to put into every keyboard char. */
197 int extra_keyboard_modifiers
;
199 /* Char to use as prefix when a meta character is typed in.
200 This is bound on entry to minibuffer in case ESC is changed there. */
202 Lisp_Object meta_prefix_char
;
204 /* Last size recorded for a current buffer which is not a minibuffer. */
205 static int last_non_minibuf_size
;
207 /* Number of idle seconds before an auto-save and garbage collection. */
208 static Lisp_Object Vauto_save_timeout
;
210 /* Total number of times read_char has returned. */
213 /* Total number of times read_char has returned, outside of macros. */
214 int num_nonmacro_input_chars
;
216 /* Auto-save automatically when this many characters have been typed
217 since the last time. */
219 static int auto_save_interval
;
221 /* Value of num_nonmacro_input_chars as of last auto save. */
225 /* Last command executed by the editor command loop, not counting
226 commands that set the prefix argument. */
228 Lisp_Object last_command
;
230 /* The command being executed by the command loop.
231 Commands may set this, and the value set will be copied into last_command
232 instead of the actual command. */
233 Lisp_Object this_command
;
235 /* The value of point when the last command was executed. */
236 int last_point_position
;
239 /* The frame in which the last input event occurred, or Qmacro if the
240 last event came from a macro. We use this to determine when to
241 generate switch-frame events. This may be cleared by functions
242 like Fselect_frame, to make sure that a switch-frame event is
243 generated by the next character. */
244 Lisp_Object internal_last_event_frame
;
246 /* A user-visible version of the above, intended to allow users to
247 figure out where the last event came from, if the event doesn't
248 carry that information itself (i.e. if it was a character). */
249 Lisp_Object Vlast_event_frame
;
252 /* The timestamp of the last input event we received from the X server.
253 X Windows wants this for selection ownership. */
254 unsigned long last_event_timestamp
;
256 Lisp_Object Qself_insert_command
;
257 Lisp_Object Qforward_char
;
258 Lisp_Object Qbackward_char
;
259 Lisp_Object Qundefined
;
261 /* read_key_sequence stores here the command definition of the
262 key sequence that it reads. */
263 Lisp_Object read_key_sequence_cmd
;
265 /* Form to evaluate (if non-nil) when Emacs is started. */
266 Lisp_Object Vtop_level
;
268 /* User-supplied string to translate input characters through. */
269 Lisp_Object Vkeyboard_translate_table
;
271 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
272 extern Lisp_Object Vfunction_key_map
;
274 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
275 Lisp_Object Vkey_translation_map
;
277 /* Non-nil means deactivate the mark at end of this command. */
278 Lisp_Object Vdeactivate_mark
;
280 /* Menu bar specified in Lucid Emacs fashion. */
282 Lisp_Object Vlucid_menu_bar_dirty_flag
;
283 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
285 /* Hooks to run before and after each command. */
286 Lisp_Object Qpre_command_hook
, Qpost_command_hook
;
287 Lisp_Object Vpre_command_hook
, Vpost_command_hook
;
288 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
290 /* File in which we write all commands we read. */
293 /* Nonzero if input is available. */
296 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
297 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
301 extern char *pending_malloc_warning
;
303 /* Circular buffer for pre-read keyboard input. */
304 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
306 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
308 The interrupt-level event handlers will never enqueue an event on a
309 frame which is not in Vframe_list, and once an event is dequeued,
310 internal_last_event_frame or the event itself points to the frame.
313 But while the event is sitting in the queue, it's completely
314 unprotected. Suppose the user types one command which will run for
315 a while and then delete a frame, and then types another event at
316 the frame that will be deleted, before the command gets around to
317 it. Suppose there are no references to this frame elsewhere in
318 Emacs, and a GC occurs before the second event is dequeued. Now we
319 have an event referring to a freed frame, which will crash Emacs
322 Similar things happen when an event on a scroll bar is enqueued; the
323 window may be deleted while the event is in the queue.
325 So, we use this vector to protect the frame_or_window field in the
326 event queue. That way, they'll be dequeued as dead frames or
327 windows, but still valid lisp objects.
329 If kbd_buffer[i].kind != no_event, then
330 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
331 == kbd_buffer[i].frame_or_window. */
332 static Lisp_Object kbd_buffer_frame_or_window
;
334 /* Pointer to next available character in kbd_buffer.
335 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
336 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
337 next available char is in kbd_buffer[0]. */
338 static struct input_event
*kbd_fetch_ptr
;
340 /* Pointer to next place to store character in kbd_buffer. This
341 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
342 character should go in kbd_buffer[0]. */
346 static struct input_event
*kbd_store_ptr
;
348 /* The above pair of variables forms a "queue empty" flag. When we
349 enqueue a non-hook event, we increment kbd_write_count. When we
350 dequeue a non-hook event, we increment kbd_read_count. We say that
351 there is input available iff the two counters are not equal.
353 Why not just have a flag set and cleared by the enqueuing and
354 dequeuing functions? Such a flag could be screwed up by interrupts
355 at inopportune times. */
357 /* If this flag is non-zero, we check mouse_moved to see when the
358 mouse moves, and motion events will appear in the input stream. If
359 it is zero, mouse motion is ignored. */
360 static int do_mouse_tracking
;
362 /* The window system handling code should set this if the mouse has
363 moved since the last call to the mouse_position_hook. Calling that
364 hook should clear this. Code assumes that if this is set, it can
365 call mouse_position_hook to get the promised position, so don't set
366 it unless you're prepared to substantiate the claim! */
369 /* True iff there is an event in kbd_buffer, or if mouse tracking is
370 enabled and there is a new mouse position in the mouse movement
371 buffer. Note that if this is false, that doesn't mean that there
372 is readable input; all the events in the queue might be button-up
373 events, and do_mouse_tracking might be off. */
374 #define EVENT_QUEUES_EMPTY \
375 ((kbd_fetch_ptr == kbd_store_ptr) && (!do_mouse_tracking || !mouse_moved))
378 /* Symbols to head events. */
379 Lisp_Object Qmouse_movement
;
380 Lisp_Object Qscroll_bar_movement
;
381 Lisp_Object Qswitch_frame
;
383 /* Symbols to denote kinds of events. */
384 Lisp_Object Qfunction_key
;
385 Lisp_Object Qmouse_click
;
386 /* Lisp_Object Qmouse_movement; - also an event header */
388 /* Properties of event headers. */
389 Lisp_Object Qevent_kind
;
390 Lisp_Object Qevent_symbol_elements
;
392 Lisp_Object Qmenu_enable
;
394 /* An event header symbol HEAD may have a property named
395 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
396 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
397 mask of modifiers applied to it. If present, this is used to help
398 speed up parse_modifiers. */
399 Lisp_Object Qevent_symbol_element_mask
;
401 /* An unmodified event header BASE may have a property named
402 Qmodifier_cache, which is an alist mapping modifier masks onto
403 modified versions of BASE. If present, this helps speed up
405 Lisp_Object Qmodifier_cache
;
407 /* Symbols to use for parts of windows. */
408 Lisp_Object Qmode_line
;
409 Lisp_Object Qvertical_line
;
410 Lisp_Object Qvertical_scroll_bar
;
411 Lisp_Object Qmenu_bar
;
413 extern Lisp_Object Qmenu_enable
;
415 Lisp_Object
recursive_edit_unwind (), command_loop ();
416 Lisp_Object
Fthis_command_keys ();
417 Lisp_Object Qextended_command_history
;
419 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
421 EMACS_TIME
*input_available_clear_time
;
423 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
424 Default is 1 if INTERRUPT_INPUT is defined. */
427 /* Nonzero while interrupts are temporarily deferred during redisplay. */
428 int interrupts_deferred
;
430 /* nonzero means use ^S/^Q for flow control. */
433 /* Allow m- file to inhibit use of FIONREAD. */
434 #ifdef BROKEN_FIONREAD
438 /* We are unable to use interrupts if FIONREAD is not available,
439 so flush SIGIO so we won't try. */
446 /* If we support X Windows, turn on the code to poll periodically
447 to detect C-g. It isn't actually used when doing interrupt input. */
448 #ifdef HAVE_X_WINDOWS
449 #define POLL_FOR_INPUT
452 /* Global variable declarations. */
454 /* Function for init_keyboard to call with no args (if nonzero). */
455 void (*keyboard_init_hook
) ();
457 static int read_avail_input ();
458 static void get_input_pending ();
459 static int readable_events ();
460 static Lisp_Object
read_char_x_menu_prompt ();
461 static Lisp_Object
read_char_minibuf_menu_prompt ();
462 static Lisp_Object
make_lispy_event ();
463 static Lisp_Object
make_lispy_movement ();
464 static Lisp_Object
modify_event_symbol ();
465 static Lisp_Object
make_lispy_switch_frame ();
467 /* > 0 if we are to echo keystrokes. */
468 static int echo_keystrokes
;
470 /* Nonzero means echo each character as typed. */
471 static int immediate_echo
;
473 /* The text we're echoing in the modeline - partial key sequences,
474 usually. '\0'-terminated. This really shouldn't have a fixed size. */
475 static char echobuf
[300];
477 /* Where to append more text to echobuf if we want to. */
478 static char *echoptr
;
480 /* Nonzero means don't try to suspend even if the operating system seems
482 static int cannot_suspend
;
484 #define min(a,b) ((a)<(b)?(a):(b))
485 #define max(a,b) ((a)>(b)?(a):(b))
487 /* Install the string STR as the beginning of the string of echoing,
488 so that it serves as a prompt for the next character.
489 Also start echoing. */
494 int len
= strlen (str
);
495 if (len
> sizeof echobuf
- 4)
496 len
= sizeof echobuf
- 4;
497 bcopy (str
, echobuf
, len
);
498 echoptr
= echobuf
+ len
;
504 /* Add C to the echo string, if echoing is going on.
505 C can be a character, which is printed prettily ("M-C-x" and all that
506 jazz), or a symbol, whose name is printed. */
511 extern char *push_key_description ();
520 /* If someone has passed us a composite event, use its head symbol. */
523 if (XTYPE (c
) == Lisp_Int
)
525 if (ptr
- echobuf
> sizeof echobuf
- 6)
528 ptr
= push_key_description (XINT (c
), ptr
);
530 else if (XTYPE (c
) == Lisp_Symbol
)
532 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
533 if (((ptr
- echobuf
) + name
->size
+ 4) > sizeof echobuf
)
535 bcopy (name
->data
, ptr
, name
->size
);
539 if (echoptr
== echobuf
&& EQ (c
, Vhelp_char
))
541 strcpy (ptr
, " (Type ? for further options)");
552 /* Temporarily add a dash to the end of the echo string if it's not
553 empty, so that it serves as a mini-prompt for the very next character. */
557 if (!immediate_echo
&& echoptr
== echobuf
)
559 /* Do nothing if not echoing at all. */
563 /* Put a dash at the end of the buffer temporarily,
564 but make it go away when the next character is added. */
571 /* Display the current echo string, and begin echoing if not already
581 for (i
= 0; i
< this_command_key_count
; i
++)
582 echo_char (XVECTOR (this_command_keys
)->contents
[i
]);
590 if (waiting_for_input
&& !NILP (Vquit_flag
))
591 quit_throw_to_read_char ();
594 /* Turn off echoing, for the start of a new command. */
602 /* Return the length of the current echo string. */
607 return echoptr
- echobuf
;
610 /* Truncate the current echo message to its first LEN chars.
611 This and echo_char get used by read_key_sequence when the user
612 switches frames while entering a key sequence. */
619 echoptr
= echobuf
+ len
;
620 truncate_echo_area (len
);
624 /* Functions for manipulating this_command_keys. */
626 add_command_key (key
)
629 int size
= XVECTOR (this_command_keys
)->size
;
631 if (this_command_key_count
>= size
)
633 Lisp_Object new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
635 bcopy (XVECTOR (this_command_keys
)->contents
,
636 XVECTOR (new_keys
)->contents
,
637 size
* sizeof (Lisp_Object
));
639 this_command_keys
= new_keys
;
642 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
648 int count
= specpdl_ptr
- specpdl
;
651 if (command_loop_level
> 0)
653 specbind (Qstandard_output
, Qt
);
654 specbind (Qstandard_input
, Qt
);
657 val
= command_loop ();
659 Fsignal (Qquit
, Qnil
);
661 return unbind_to (count
, Qnil
);
664 /* When an auto-save happens, record the "time", and don't do again soon. */
667 last_auto_save
= num_nonmacro_input_chars
;
670 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
671 "Invoke the editor command loop recursively.\n\
672 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
673 that tells this function to return.\n\
674 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
675 This function is called by the editor initialization to begin editing.")
678 int count
= specpdl_ptr
- specpdl
;
681 command_loop_level
++;
682 update_mode_lines
= 1;
684 record_unwind_protect (recursive_edit_unwind
,
686 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
690 return unbind_to (count
, Qnil
);
694 recursive_edit_unwind (buffer
)
698 Fset_buffer (buffer
);
700 command_loop_level
--;
701 update_mode_lines
= 1;
709 Lisp_Object errmsg
, tail
, errname
, file_error
;
716 Vstandard_output
= Qt
;
717 Vstandard_input
= Qt
;
718 Vexecuting_macro
= Qnil
;
719 echo_area_glyphs
= 0;
721 /* If the window system or terminal frame hasn't been initialized
722 yet, or we're not interactive, it's best to dump this message out
723 to stderr and exit. */
724 if (! FRAME_MESSAGE_BUF (selected_frame
)
726 stream
= Qexternal_debugging_output
;
734 errname
= Fcar (data
);
736 if (EQ (errname
, Qerror
))
739 if (!CONSP (data
)) data
= Qnil
;
740 errmsg
= Fcar (data
);
745 errmsg
= Fget (errname
, Qerror_message
);
746 file_error
= Fmemq (Qfile_error
,
747 Fget (errname
, Qerror_conditions
));
750 /* Print an error message including the data items.
751 This is done by printing it into a scratch buffer
752 and then making a copy of the text in the buffer. */
754 if (!CONSP (data
)) data
= Qnil
;
758 /* For file-error, make error message by concatenating
759 all the data items. They are all strings. */
760 if (!NILP (file_error
) && !NILP (tail
))
761 errmsg
= XCONS (tail
)->car
, tail
= XCONS (tail
)->cdr
;
763 if (XTYPE (errmsg
) == Lisp_String
)
764 Fprinc (errmsg
, stream
);
766 write_string_1 ("peculiar error", -1, stream
);
768 for (i
= 0; CONSP (tail
); tail
= Fcdr (tail
), i
++)
770 write_string_1 (i
? ", " : ": ", 2, stream
);
771 if (!NILP (file_error
))
772 Fprinc (Fcar (tail
), stream
);
774 Fprin1 (Fcar (tail
), stream
);
778 /* If the window system or terminal frame hasn't been initialized
779 yet, or we're in -batch mode, this error should cause Emacs to exit. */
780 if (! FRAME_MESSAGE_BUF (selected_frame
)
784 Fkill_emacs (make_number (-1));
789 Vinhibit_quit
= Qnil
;
790 return make_number (0);
793 Lisp_Object
command_loop_1 ();
794 Lisp_Object
command_loop_2 ();
795 Lisp_Object
top_level_1 ();
797 /* Entry to editor-command-loop.
798 This level has the catches for exiting/returning to editor command loop.
799 It returns nil to exit recursive edit, t to abort it. */
804 if (command_loop_level
> 0 || minibuf_level
> 0)
806 return internal_catch (Qexit
, command_loop_2
, Qnil
);
811 internal_catch (Qtop_level
, top_level_1
, Qnil
);
812 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
814 /* End of file in -batch run causes exit here. */
820 /* Here we catch errors in execution of commands within the
821 editing loop, and reenter the editing loop.
822 When there is an error, cmd_error runs and returns a non-nil
823 value to us. A value of nil means that cmd_loop_1 itself
824 returned due to end of file (or end of kbd macro). */
829 register Lisp_Object val
;
832 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
841 return Feval (Vtop_level
);
847 /* On entry to the outer level, run the startup file */
848 if (!NILP (Vtop_level
))
849 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
850 else if (!NILP (Vpurify_flag
))
851 message ("Bare impure Emacs (standard Lisp code not loaded)");
853 message ("Bare Emacs (standard Lisp code not loaded)");
857 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
858 "Exit all recursive editing levels.")
861 Fthrow (Qtop_level
, Qnil
);
864 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
865 "Exit from the innermost recursive edit or minibuffer.")
868 if (command_loop_level
> 0 || minibuf_level
> 0)
869 Fthrow (Qexit
, Qnil
);
871 error ("No recursive edit is in progress");
874 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
875 "Abort the command that requested this recursive edit or minibuffer input.")
878 if (command_loop_level
> 0 || minibuf_level
> 0)
881 error ("No recursive edit is in progress");
884 /* This is the actual command reading loop,
885 sans error-handling encapsulation. */
887 Lisp_Object
Fcommand_execute ();
888 static int read_key_sequence ();
893 Lisp_Object cmd
, tem
;
896 Lisp_Object keybuf
[30];
901 struct buffer
*prev_buffer
;
904 Vdeactivate_mark
= Qnil
;
905 waiting_for_input
= 0;
910 this_command_key_count
= 0;
912 /* Make sure this hook runs after commands that get errors and
913 throw to top level. */
914 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
916 /* If we get an error during the post-command-hook,
917 cause post-command-hook to be nil. */
918 Vcommand_hook_internal
= Vpost_command_hook
;
919 Vpost_command_hook
= Qnil
;
921 call1 (Vrun_hooks
, Qcommand_hook_internal
);
923 Vpost_command_hook
= Vcommand_hook_internal
;
926 /* Do this after running Vpost_command_hook, for consistency. */
927 last_command
= this_command
;
931 /* Install chars successfully executed in kbd macro. */
933 if (defining_kbd_macro
&& NILP (Vprefix_arg
))
934 finalize_kbd_macro_chars ();
936 /* Make sure the current window's buffer is selected. */
937 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
938 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
940 /* Display any malloc warning that just came out. Use while because
941 displaying one warning can cause another. */
943 while (pending_malloc_warning
)
944 display_malloc_warning ();
948 Vdeactivate_mark
= Qnil
;
950 /* If minibuffer on and echo area in use,
951 wait 2 sec and redraw minibuffer. */
953 if (minibuf_level
&& echo_area_glyphs
)
955 /* Bind inhibit-quit to t so that C-g gets read in
956 rather than quitting back to the minibuffer. */
957 int count
= specpdl_ptr
- specpdl
;
958 specbind (Qinhibit_quit
, Qt
);
959 Fsit_for (make_number (2), Qnil
, Qnil
);
960 unbind_to (count
, Qnil
);
962 echo_area_glyphs
= 0;
964 if (!NILP (Vquit_flag
))
967 unread_command_events
= Fcons (make_number (quit_char
), Qnil
);
972 alloca (0); /* Cause a garbage collection now */
973 /* Since we can free the most stuff here. */
974 #endif /* C_ALLOCA */
978 /* Select the frame that the last event came from. Usually,
979 switch-frame events will take care of this, but if some lisp
980 code swallows a switch-frame event, we'll fix things up here.
981 Is this a good idea? */
982 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
983 && XFRAME (internal_last_event_frame
) != selected_frame
)
984 Fselect_frame (internal_last_event_frame
, Qnil
);
987 /* If it has changed current-menubar from previous value,
988 really recompute the menubar from the value. */
989 if (! NILP (Vlucid_menu_bar_dirty_flag
)
990 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
991 call0 (Qrecompute_lucid_menubar
);
993 /* Read next key sequence; i gets its length. */
994 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), Qnil
);
998 /* Now we have read a key sequence of length I,
999 or else I is 0 and we found end of file. */
1001 if (i
== 0) /* End of file -- happens only in */
1002 return Qnil
; /* a kbd macro, at the end. */
1003 /* -1 means read_key_sequence got a menu that was rejected.
1004 Just loop around and read another command. */
1008 this_command_key_count
= 0;
1012 last_command_char
= keybuf
[i
- 1];
1014 /* If the previous command tried to force a specific window-start,
1015 forget about that, in case this command moves point far away
1016 from that position. */
1017 XWINDOW (selected_window
)->force_start
= Qnil
;
1019 cmd
= read_key_sequence_cmd
;
1020 if (!NILP (Vexecuting_macro
))
1022 if (!NILP (Vquit_flag
))
1024 Vexecuting_macro
= Qt
;
1025 QUIT
; /* Make some noise. */
1026 /* Will return since macro now empty. */
1030 /* Do redisplay processing after this command except in special
1031 cases identified below that set no_redisplay to 1.
1032 (actually, there's currently no way to prevent the redisplay,
1033 and no_redisplay is ignored.
1034 Perhaps someday we will really implement it. */
1037 prev_buffer
= current_buffer
;
1038 prev_modiff
= MODIFF
;
1039 last_point_position
= PT
;
1041 /* Execute the command. */
1044 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1046 /* If we get an error during the pre-command-hook,
1047 cause pre-command-hook to be nil. */
1048 Vcommand_hook_internal
= Vpre_command_hook
;
1049 Vpre_command_hook
= Qnil
;
1051 call1 (Vrun_hooks
, Qcommand_hook_internal
);
1053 Vpre_command_hook
= Vcommand_hook_internal
;
1056 if (NILP (this_command
))
1058 /* nil means key is undefined. */
1060 defining_kbd_macro
= 0;
1061 update_mode_lines
= 1;
1067 if (NILP (Vprefix_arg
) && ! no_direct
)
1069 /* Recognize some common commands in common situations and
1070 do them directly. */
1071 if (EQ (this_command
, Qforward_char
) && point
< ZV
)
1073 struct Lisp_Vector
*dp
1074 = window_display_table (XWINDOW (selected_window
));
1075 lose
= FETCH_CHAR (point
);
1078 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1079 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1080 : (lose
>= 0x20 && lose
< 0x7f))
1081 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1083 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1085 && !windows_or_buffers_changed
1086 && EQ (current_buffer
->selective_display
, Qnil
)
1087 && !detect_input_pending ()
1088 && NILP (Vexecuting_macro
))
1089 no_redisplay
= direct_output_forward_char (1);
1092 else if (EQ (this_command
, Qbackward_char
) && point
> BEGV
)
1094 struct Lisp_Vector
*dp
1095 = window_display_table (XWINDOW (selected_window
));
1097 lose
= FETCH_CHAR (point
);
1099 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1100 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1101 : (lose
>= 0x20 && lose
< 0x7f))
1102 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1104 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1106 && !windows_or_buffers_changed
1107 && EQ (current_buffer
->selective_display
, Qnil
)
1108 && !detect_input_pending ()
1109 && NILP (Vexecuting_macro
))
1110 no_redisplay
= direct_output_forward_char (-1);
1113 else if (EQ (this_command
, Qself_insert_command
)
1114 /* Try this optimization only on ascii keystrokes. */
1115 && XTYPE (last_command_char
) == Lisp_Int
)
1117 unsigned char c
= XINT (last_command_char
);
1119 if (NILP (Vexecuting_macro
) &&
1120 !EQ (minibuf_window
, selected_window
))
1122 if (!nonundocount
|| nonundocount
>= 20)
1129 lose
= (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1131 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1133 || MODIFF
<= current_buffer
->save_modified
1134 || windows_or_buffers_changed
1135 || !EQ (current_buffer
->selective_display
, Qnil
)
1136 || detect_input_pending ()
1137 || !NILP (Vexecuting_macro
);
1138 if (internal_self_insert (c
, 0))
1144 (point
== ZV
|| FETCH_CHAR (point
) == '\n'))
1146 struct Lisp_Vector
*dp
1147 = window_display_table (XWINDOW (selected_window
));
1152 Lisp_Object obj
= DISP_CHAR_VECTOR (dp
, lose
);
1154 if (XTYPE (obj
) == Lisp_Vector
1155 && XVECTOR (obj
)->size
== 1
1156 && (XTYPE (obj
= XVECTOR (obj
)->contents
[0])
1159 direct_output_for_insert (XINT (obj
));
1163 if (lose
>= 0x20 && lose
<= 0x7e)
1164 no_redisplay
= direct_output_for_insert (lose
);
1171 /* Here for a command that isn't executed directly */
1174 if (NILP (Vprefix_arg
))
1176 Fcommand_execute (this_command
, Qnil
);
1181 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1183 /* If we get an error during the post-command-hook,
1184 cause post-command-hook to be nil. */
1185 Vcommand_hook_internal
= Vpost_command_hook
;
1186 Vpost_command_hook
= Qnil
;
1188 call1 (Vrun_hooks
, Qcommand_hook_internal
);
1190 Vpost_command_hook
= Vcommand_hook_internal
;
1193 /* If there is a prefix argument,
1194 1) We don't want last_command to be ``universal-argument''
1195 (that would be dumb), so don't set last_command,
1196 2) we want to leave echoing on so that the prefix will be
1197 echoed as part of this key sequence, so don't call
1199 3) we want to leave this_command_key_count non-zero, so that
1200 read_char will realize that it is re-reading a character, and
1201 not echo it a second time. */
1202 if (NILP (Vprefix_arg
))
1204 last_command
= this_command
;
1206 this_command_key_count
= 0;
1209 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1211 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1213 current_buffer
->mark_active
= Qnil
;
1214 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1216 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1217 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1222 /* Number of seconds between polling for input. */
1225 /* Nonzero means polling for input is temporarily suppressed. */
1226 int poll_suppress_count
;
1228 #ifdef POLL_FOR_INPUT
1229 int polling_for_input
;
1231 /* Handle an alarm once each second and read pending input
1232 so as to handle a C-g if it comces in. */
1235 input_poll_signal ()
1237 if (interrupt_input_blocked
== 0
1238 && !waiting_for_input
)
1239 read_avail_input (0);
1240 signal (SIGALRM
, input_poll_signal
);
1241 alarm (polling_period
);
1246 /* Begin signals to poll for input, if they are appropriate.
1247 This function is called unconditionally from various places. */
1251 #ifdef POLL_FOR_INPUT
1252 if (read_socket_hook
&& !interrupt_input
)
1254 poll_suppress_count
--;
1255 if (poll_suppress_count
== 0)
1257 signal (SIGALRM
, input_poll_signal
);
1258 polling_for_input
= 1;
1259 alarm (polling_period
);
1265 /* Turn off polling. */
1269 #ifdef POLL_FOR_INPUT
1270 if (read_socket_hook
&& !interrupt_input
)
1272 if (poll_suppress_count
== 0)
1274 polling_for_input
= 0;
1277 poll_suppress_count
++;
1282 /* Set the value of poll_suppress_count to COUNT
1283 and start or stop polling accordingly. */
1286 set_poll_suppress_count (count
)
1289 #ifdef POLL_FOR_INPUT
1290 if (count
== 0 && poll_suppress_count
!= 0)
1292 poll_suppress_count
= 1;
1295 else if (count
!= 0 && poll_suppress_count
== 0)
1299 poll_suppress_count
= count
;
1303 /* Applying the control modifier to CHARACTER. */
1308 /* Save the upper bits here. */
1309 int upper
= c
& ~0177;
1313 /* Everything in the columns containing the upper-case letters
1314 denotes a control character. */
1315 if (c
>= 0100 && c
< 0140)
1319 /* Set the shift modifier for a control char
1320 made from a shifted letter. But only for letters! */
1321 if (oc
>= 'A' && oc
<= 'Z')
1322 c
|= shift_modifier
;
1325 /* The lower-case letters denote control characters too. */
1326 else if (c
>= 'a' && c
<= 'z')
1329 /* Include the bits for control and shift
1330 only if the basic ASCII code can't indicate them. */
1334 /* Replace the high bits. */
1335 c
|= (upper
& ~ctrl_modifier
);
1342 /* Input of single characters from keyboard */
1344 Lisp_Object
print_help ();
1345 static Lisp_Object
kbd_buffer_get_event ();
1347 /* read a character from the keyboard; call the redisplay if needed */
1348 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1349 -1 means do not do redisplay, but do do autosaving.
1352 /* The arguments MAPS and NMAPS are for menu prompting.
1353 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1355 PREV_EVENT is the previous input event, or nil if we are reading
1356 the first event of a key sequence.
1358 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1359 if we used a mouse menu to read the input, or zero otherwise. If
1360 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
1362 Value is t if we showed a menu and the user rejected it. */
1365 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1369 Lisp_Object prev_event
;
1370 int *used_mouse_menu
;
1372 register Lisp_Object c
;
1376 if (CONSP (unread_command_events
))
1378 c
= XCONS (unread_command_events
)->car
;
1379 unread_command_events
= XCONS (unread_command_events
)->cdr
;
1381 if (this_command_key_count
== 0)
1387 if (unread_command_char
!= -1)
1389 XSET (c
, Lisp_Int
, unread_command_char
);
1390 unread_command_char
= -1;
1392 if (this_command_key_count
== 0)
1398 if (!NILP (Vexecuting_macro
))
1401 /* We set this to Qmacro; since that's not a frame, nobody will
1402 try to switch frames on us, and the selected window will
1405 Since this event came from a macro, it would be misleading to
1406 leave internal_last_event_frame set to wherever the last
1407 real event came from. Normally, a switch-frame event selects
1408 internal_last_event_frame after each command is read, but
1409 events read from a macro should never cause a new frame to be
1411 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1414 /* Exit the macro if we are at the end.
1415 Also, some things replace the macro with t
1416 to force an early exit. */
1417 if (EQ (Vexecuting_macro
, Qt
)
1418 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1420 XSET (c
, Lisp_Int
, -1);
1424 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1425 if (XTYPE (Vexecuting_macro
) == Lisp_String
1426 && (XINT (c
) & 0x80))
1427 XFASTINT (c
) = CHAR_META
| (XINT (c
) & ~0x80);
1429 executing_macro_index
++;
1434 if (!NILP (unread_switch_frame
))
1436 c
= unread_switch_frame
;
1437 unread_switch_frame
= Qnil
;
1439 /* This event should make it into this_command_keys, and get echoed
1440 again, so we go to reread_first, rather than reread. */
1444 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1445 prepare_menu_bars ();
1447 /* Save outer setjmp data, in case called recursively. */
1448 save_getcjmp (save_jump
);
1452 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1455 if (_setjmp (getcjmp
))
1457 XSET (c
, Lisp_Int
, quit_char
);
1459 XSET (internal_last_event_frame
, Lisp_Frame
, selected_frame
);
1460 Vlast_event_frame
= internal_last_event_frame
;
1462 /* If we report the quit char as an event,
1463 don't do so more than once. */
1464 if (!NILP (Vinhibit_quit
))
1470 /* Message turns off echoing unless more keystrokes turn it on again. */
1471 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1474 /* If already echoing, continue. */
1477 /* Try reading a character via menu prompting in the minibuf.
1478 Try this before the sit-for, because the sit-for
1479 would do the wrong thing if we are supposed to do
1480 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1481 after a mouse event so don't try a minibuf menu. */
1483 if (nmaps
> 0 && INTERACTIVE
&&
1484 !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
))
1486 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1487 if ( ! NILP(c
) ) return c
;
1490 /* If in middle of key sequence and minibuffer not active,
1491 start echoing if enough time elapses. */
1492 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1494 && echo_keystrokes
> 0
1495 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1499 /* After a mouse event, start echoing right away.
1500 This is because we are probably about to display a menu,
1501 and we don't want to delay before doing so. */
1502 if (EVENT_HAS_PARAMETERS (prev_event
))
1506 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1512 /* Maybe auto save due to number of keystrokes or idle time. */
1514 if (commandflag
!= 0
1515 && auto_save_interval
> 0
1516 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1517 && !detect_input_pending ())
1520 save_getcjmp (temp
);
1521 Fdo_auto_save (Qnil
, Qnil
);
1522 restore_getcjmp (temp
);
1525 /* Try reading using an X menu.
1526 This is never confused with reading using the minibuf because the recursive
1527 call of read_char in read_char_minibuf_menu_prompt does not pass on
1529 if (nmaps
> 0 && INTERACTIVE
&&
1530 !NILP (prev_event
) && EVENT_HAS_PARAMETERS (prev_event
))
1531 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1533 /* Slow down auto saves logarithmically in size of current buffer,
1534 and garbage collect while we're at it. */
1535 if (INTERACTIVE
&& NILP (c
))
1537 int delay_level
, buffer_size
;
1539 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1540 last_non_minibuf_size
= Z
- BEG
;
1541 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1543 while (buffer_size
> 64)
1544 delay_level
++, buffer_size
-= buffer_size
>> 2;
1545 if (delay_level
< 4) delay_level
= 4;
1546 /* delay_level is 4 for files under around 50k, 7 at 100k,
1547 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1549 /* Auto save if enough time goes by without input. */
1550 if (commandflag
!= 0
1551 && num_nonmacro_input_chars
> last_auto_save
1552 && XTYPE (Vauto_save_timeout
) == Lisp_Int
1553 && XINT (Vauto_save_timeout
) > 0)
1556 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1557 tem0
= sit_for (delay
, 0, 1, 1);
1561 save_getcjmp (temp
);
1562 Fdo_auto_save (Qnil
, Qnil
);
1563 restore_getcjmp (temp
);
1565 /* If we have auto-saved and there is still no input
1566 available, garbage collect if there has been enough
1567 consing going on to make it worthwhile. */
1568 if (!detect_input_pending ()
1569 && consing_since_gc
> gc_cons_threshold
/ 2)
1571 Fgarbage_collect ();
1572 /* prepare_menu_bars isn't safe here, but it should
1573 also be unnecessary. */
1580 /* Actually read a character, waiting if necessary. */
1583 c
= kbd_buffer_get_event ();
1586 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1590 /* Terminate Emacs in batch mode if at eof. */
1591 if (noninteractive
&& XTYPE (c
) == Lisp_Int
&& XINT (c
) < 0)
1592 Fkill_emacs (make_number (1));
1594 if (XTYPE (c
) == Lisp_Int
)
1596 /* Add in any extra modifiers, where appropriate. */
1597 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1598 || ((extra_keyboard_modifiers
& 0177) < ' '
1599 && (extra_keyboard_modifiers
& 0177) != 0))
1600 XSETINT (c
, make_ctrl_char (XINT (c
)));
1602 /* Transfer any other modifier bits directly from
1603 extra_keyboard_modifiers to c. Ignore the actual character code
1604 in the low 16 bits of extra_keyboard_modifiers. */
1605 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
1610 restore_getcjmp (save_jump
);
1614 echo_area_glyphs
= 0;
1616 /* Handle things that only apply to characters. */
1617 if (XTYPE (c
) == Lisp_Int
)
1619 /* If kbd_buffer_get_event gave us an EOF, return that. */
1623 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
1624 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1625 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1629 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1630 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1631 recent_keys_index
= 0;
1633 /* Write c to the dribble file. If c is a lispy event, write
1634 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1635 If you, dear reader, have a better idea, you've got the source. :-) */
1638 if (XTYPE (c
) == Lisp_Int
)
1639 putc (XINT (c
), dribble
);
1642 Lisp_Object dribblee
= c
;
1644 /* If it's a structured event, take the event header. */
1645 dribblee
= EVENT_HEAD (dribblee
);
1647 if (XTYPE (dribblee
) == Lisp_Symbol
)
1649 putc ('<', dribble
);
1650 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1651 XSYMBOL (dribblee
)->name
->size
,
1653 putc ('>', dribble
);
1660 store_kbd_macro_char (c
);
1662 num_nonmacro_input_chars
++;
1667 /* Record this character as part of the current key.
1668 Don't record mouse motion; it should never matter. */
1669 if (! (EVENT_HAS_PARAMETERS (c
)
1670 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1673 add_command_key (c
);
1676 /* Re-reading in the middle of a command */
1678 last_input_char
= c
;
1681 /* Process the help character specially if enabled */
1682 if (EQ (c
, Vhelp_char
) && !NILP (Vhelp_form
))
1685 count
= specpdl_ptr
- specpdl
;
1687 record_unwind_protect (Fset_window_configuration
,
1688 Fcurrent_window_configuration (Qnil
));
1690 tem0
= Feval (Vhelp_form
);
1691 if (XTYPE (tem0
) == Lisp_String
)
1692 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1696 c
= read_char (0, 0, 0, Qnil
, 0);
1697 while (XTYPE (c
) == Lisp_Buffer
);
1698 /* Remove the help from the frame */
1699 unbind_to (count
, Qnil
);
1700 prepare_menu_bars ();
1702 if (EQ (c
, make_number (040)))
1706 c
= read_char (0, 0, 0, Qnil
, 0);
1707 while (XTYPE (c
) == Lisp_Buffer
);
1718 Fprinc (object
, Qnil
);
1722 /* Copy out or in the info on where C-g should throw to.
1723 This is used when running Lisp code from within get_char,
1724 in case get_char is called recursively.
1725 See read_process_output. */
1730 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1733 restore_getcjmp (temp
)
1736 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1740 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1741 of this function. */
1743 tracking_off (old_value
)
1744 Lisp_Object old_value
;
1746 if (! XFASTINT (old_value
))
1748 do_mouse_tracking
= 0;
1750 /* Redisplay may have been preempted because there was input
1751 available, and it assumes it will be called again after the
1752 input has been processed. If the only input available was
1753 the sort that we have just disabled, then we need to call
1755 if (!readable_events ())
1757 prepare_menu_bars ();
1758 redisplay_preserve_echo_area ();
1759 get_input_pending (&input_pending
);
1764 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1765 "Evaluate BODY with mouse movement events enabled.\n\
1766 Within a `track-mouse' form, mouse motion generates input events that\n\
1767 you can read with `read-event'.\n\
1768 Normally, mouse motion is ignored.")
1772 int count
= specpdl_ptr
- specpdl
;
1775 XSET (val
, Lisp_Int
, do_mouse_tracking
);
1776 record_unwind_protect (tracking_off
, val
);
1778 do_mouse_tracking
= 1;
1780 val
= Fprogn (args
);
1781 return unbind_to (count
, val
);
1784 /* Low level keyboard/mouse input.
1785 kbd_buffer_store_event places events in kbd_buffer, and
1786 kbd_buffer_get_event retrieves them.
1787 mouse_moved indicates when the mouse has moved again, and
1788 *mouse_position_hook provides the mouse position. */
1790 /* Return true iff there are any events in the queue that read-char
1791 would return. If this returns false, a read-char would block. */
1795 return ! EVENT_QUEUES_EMPTY
;
1798 /* Set this for debugging, to have a way to get out */
1801 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
1804 kbd_buffer_store_event (event
)
1805 register struct input_event
*event
;
1807 if (event
->kind
== no_event
)
1810 if (event
->kind
== ascii_keystroke
)
1812 register int c
= event
->code
& 0377;
1814 if (event
->modifiers
& ctrl_modifier
)
1815 c
= make_ctrl_char (c
);
1817 c
|= (event
->modifiers
1818 & (meta_modifier
| alt_modifier
1819 | hyper_modifier
| super_modifier
));
1823 extern SIGTYPE
interrupt_signal ();
1826 /* If this results in a quit_char being returned to Emacs as
1827 input, set Vlast_event_frame properly. If this doesn't
1828 get returned to Emacs as an event, the next event read
1829 will set Vlast_event_frame again, so this is safe to do. */
1832 = FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
1835 internal_last_event_frame
= event
->frame_or_window
;
1837 internal_last_event_frame
= focus
;
1838 Vlast_event_frame
= internal_last_event_frame
;
1842 last_event_timestamp
= event
->timestamp
;
1843 interrupt_signal ();
1847 if (c
&& c
== stop_character
)
1854 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
1855 kbd_store_ptr
= kbd_buffer
;
1857 /* Don't let the very last slot in the buffer become full,
1858 since that would make the two pointers equal,
1859 and that is indistinguishable from an empty buffer.
1860 Discard the event if it would fill the last slot. */
1861 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
1863 kbd_store_ptr
->kind
= event
->kind
;
1864 if (event
->kind
== selection_request_event
)
1866 /* We must not use the ordinary copying code for this case,
1867 since `part' is an enum and copying it might not copy enough
1869 bcopy (event
, kbd_store_ptr
, sizeof (*event
));
1873 kbd_store_ptr
->code
= event
->code
;
1874 kbd_store_ptr
->part
= event
->part
;
1875 kbd_store_ptr
->frame_or_window
= event
->frame_or_window
;
1876 kbd_store_ptr
->modifiers
= event
->modifiers
;
1877 kbd_store_ptr
->x
= event
->x
;
1878 kbd_store_ptr
->y
= event
->y
;
1879 kbd_store_ptr
->timestamp
= event
->timestamp
;
1881 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
1883 = event
->frame_or_window
);
1889 /* Read one event from the event buffer, waiting if necessary.
1890 The value is a Lisp object representing the event.
1891 The value is nil for an event that should be ignored,
1892 or that was handled here.
1893 We always read and discard one event. */
1896 kbd_buffer_get_event ()
1904 XSET (obj
, Lisp_Int
, c
);
1908 /* Wait until there is input available. */
1911 if (!EVENT_QUEUES_EMPTY
)
1914 /* If the quit flag is set, then read_char will return
1915 quit_char, so that counts as "available input." */
1916 if (!NILP (Vquit_flag
))
1917 quit_throw_to_read_char ();
1919 /* One way or another, wait until input is available; then, if
1920 interrupt handlers have not read it, read it now. */
1923 wait_for_kbd_input ();
1925 /* Note SIGIO has been undef'd if FIONREAD is missing. */
1929 if (EVENT_QUEUES_EMPTY
)
1931 Lisp_Object minus_one
;
1933 XSET (minus_one
, Lisp_Int
, -1);
1934 wait_reading_process_input (0, 0, minus_one
, 1);
1936 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
1937 /* Pass 1 for EXPECT since we just waited to have input. */
1938 read_avail_input (1);
1940 #endif /* not VMS */
1943 /* At this point, we know that there is a readable event available
1944 somewhere. If the event queue is empty, then there must be a
1945 mouse movement enabled and available. */
1946 if (kbd_fetch_ptr
!= kbd_store_ptr
)
1948 struct input_event
*event
;
1950 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
1954 last_event_timestamp
= event
->timestamp
;
1958 /* These two kinds of events get special handling
1959 and don't actually appear to the command loop.
1960 We return nil for them. */
1961 if (event
->kind
== selection_request_event
)
1964 x_handle_selection_request (event
);
1965 kbd_fetch_ptr
= event
+ 1;
1967 /* We're getting selection request events, but we don't have
1973 else if (event
->kind
== selection_clear_event
)
1976 x_handle_selection_clear (event
);
1977 kbd_fetch_ptr
= event
+ 1;
1979 /* We're getting selection request events, but we don't have
1985 else if (event
->kind
== delete_window_event
)
1987 Lisp_Object tail
, frame
;
1990 /* If the user destroys the only frame, Emacs should exit.
1991 Count visible frames and iconified frames. */
1992 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
1994 frame
= XCONS (tail
)->car
;
1995 if (XTYPE (frame
) != Lisp_Frame
|| EQ (frame
, event
->frame_or_window
))
1998 if (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
))
2005 Fdelete_frame (event
->frame_or_window
, Qt
);
2006 kbd_fetch_ptr
= event
+ 1;
2009 /* Just discard these, by returning nil.
2010 (They shouldn't be found in the buffer,
2011 but on some machines it appears they do show up.) */
2012 else if (event
->kind
== no_event
)
2013 kbd_fetch_ptr
= event
+ 1;
2015 /* If this event is on a different frame, return a switch-frame this
2016 time, and leave the event in the queue for next time. */
2020 Lisp_Object frame
= event
->frame_or_window
;
2023 if (XTYPE (frame
) == Lisp_Window
)
2024 frame
= WINDOW_FRAME (XWINDOW (frame
));
2026 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2030 if (! EQ (frame
, internal_last_event_frame
)
2031 && XFRAME (frame
) != selected_frame
)
2032 obj
= make_lispy_switch_frame (frame
);
2033 internal_last_event_frame
= frame
;
2034 #endif /* MULTI_FRAME */
2036 /* If we didn't decide to make a switch-frame event, go ahead
2037 and build a real event from the queue entry. */
2041 obj
= make_lispy_event (event
);
2043 /* Wipe out this event, to catch bugs. */
2044 event
->kind
= no_event
;
2045 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
2048 kbd_fetch_ptr
= event
+ 1;
2052 /* Try generating a mouse motion event. */
2053 else if (do_mouse_tracking
&& mouse_moved
)
2056 Lisp_Object bar_window
;
2057 enum scroll_bar_part part
;
2061 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
2066 /* Decide if we should generate a switch-frame event. Don't
2067 generate switch-frame events for motion outside of all Emacs
2071 Lisp_Object frame
= FRAME_FOCUS_FRAME (f
);
2074 XSET (frame
, Lisp_Frame
, f
);
2076 if (! EQ (frame
, internal_last_event_frame
)
2077 && XFRAME (frame
) != selected_frame
)
2078 obj
= make_lispy_switch_frame (frame
);
2079 internal_last_event_frame
= frame
;
2083 /* If we didn't decide to make a switch-frame event, go ahead and
2084 return a mouse-motion event. */
2086 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2089 /* We were promised by the above while loop that there was
2090 something for us to read! */
2093 input_pending
= readable_events ();
2096 Vlast_event_frame
= internal_last_event_frame
;
2102 /* Process any events that are not user-visible,
2103 then return, without reading any user-visible events. */
2108 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2110 struct input_event
*event
;
2112 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2116 last_event_timestamp
= event
->timestamp
;
2118 /* These two kinds of events get special handling
2119 and don't actually appear to the command loop. */
2120 if (event
->kind
== selection_request_event
)
2123 x_handle_selection_request (event
);
2124 kbd_fetch_ptr
= event
+ 1;
2126 /* We're getting selection request events, but we don't have
2132 else if (event
->kind
== selection_clear_event
)
2135 x_handle_selection_clear (event
);
2136 kbd_fetch_ptr
= event
+ 1;
2138 /* We're getting selection request events, but we don't have
2147 get_input_pending (&input_pending
);
2150 /* Caches for modify_event_symbol. */
2151 static Lisp_Object accent_key_syms
;
2152 static Lisp_Object system_key_syms
;
2153 static Lisp_Object func_key_syms
;
2154 static Lisp_Object mouse_syms
;
2156 Lisp_Object Vsystem_key_alist
;
2158 /* This is a list of keysym codes for special "accent" characters.
2159 It parallels lispy_accent_keys. */
2161 static int lispy_accent_codes
[] =
2163 #ifdef XK_dead_circumflex
2168 #ifdef XK_dead_grave
2173 #ifdef XK_dead_tilde
2178 #ifdef XK_dead_diaeresis
2183 #ifdef XK_dead_macron
2188 #ifdef XK_dead_degree
2193 #ifdef XK_dead_acute
2198 #ifdef XK_dead_cedilla
2203 #ifdef XK_dead_breve
2208 #ifdef XK_dead_ogonek
2213 #ifdef XK_dead_caron
2218 #ifdef XK_dead_doubleacute
2219 XK_dead_doubleacute
,
2223 #ifdef XK_dead_abovedot
2230 /* This is a list of Lisp names for special "accent" characters.
2231 It parallels lispy_accent_codes. */
2233 static char *lispy_accent_keys
[] =
2250 /* You'll notice that this table is arranged to be conveniently
2251 indexed by X Windows keysym values. */
2252 static char *lispy_function_keys
[] =
2254 /* X Keysym value */
2256 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2264 0, 0, 0, /* 0xff10 */
2266 0, 0, 0, 0, 0, 0, 0,
2269 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2270 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2271 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2273 "home", /* 0xff50 */ /* IsCursorKey */
2284 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2295 "break", /* 0xff6b */
2297 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2299 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2300 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2301 0, 0, 0, 0, 0, 0, 0, 0,
2302 "kp-tab", /* 0xff89 */
2304 "kp-enter", /* 0xff8d */
2306 "kp-f1", /* 0xff91 */
2311 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2312 "kp-multiply", /* 0xffaa */
2317 "kp-divide", /* 0xffaf */
2318 "kp-0", /* 0xffb0 */
2319 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2322 "kp-equal", /* 0xffbd */
2323 "f1", /* 0xffbe */ /* IsFunctionKey */
2325 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2326 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2327 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2328 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2329 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2330 0, 0, 0, 0, 0, 0, 0, 0,
2331 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2332 0, 0, 0, 0, 0, 0, 0, "delete"
2335 static char *lispy_mouse_names
[] =
2337 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2340 /* Scroll bar parts. */
2341 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2343 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2344 Lisp_Object
*scroll_bar_parts
[] = {
2345 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2349 /* A vector, indexed by button number, giving the down-going location
2350 of currently depressed buttons, both scroll bar and non-scroll bar.
2352 The elements have the form
2353 (BUTTON-NUMBER MODIFIER-MASK . REST)
2354 where REST is the cdr of a position as it would be reported in the event.
2356 The make_lispy_event function stores positions here to tell the
2357 difference between click and drag events, and to store the starting
2358 location to be included in drag events. */
2360 static Lisp_Object button_down_location
;
2362 /* Information about the most recent up-going button event: Which
2363 button, what location, and what time. */
2365 static int last_mouse_button
;
2366 static int last_mouse_x
;
2367 static int last_mouse_y
;
2368 static unsigned long button_down_time
;
2370 /* The maximum time between clicks to make a double-click,
2371 or Qnil to disable double-click detection,
2372 or Qt for no time limit. */
2373 Lisp_Object Vdouble_click_time
;
2375 /* The number of clicks in this multiple-click. */
2377 int double_click_count
;
2379 #ifdef USE_X_TOOLKIT
2380 extern Lisp_Object
map_event_to_object ();
2381 #endif /* USE_X_TOOLKIT */
2383 /* Given a struct input_event, build the lisp event which represents
2384 it. If EVENT is 0, build a mouse movement event from the mouse
2385 movement buffer, which should have a movement event in it.
2387 Note that events must be passed to this function in the order they
2388 are received; this function stores the location of button presses
2389 in order to build drag events when the button is released. */
2392 make_lispy_event (event
)
2393 struct input_event
*event
;
2397 #ifdef SWITCH_ENUM_BUG
2398 switch ((int) event
->kind
)
2400 switch (event
->kind
)
2403 /* A simple keystroke. */
2404 case ascii_keystroke
:
2406 int c
= event
->code
& 0377;
2407 /* Turn ASCII characters into control characters
2409 if (event
->modifiers
& ctrl_modifier
)
2410 c
= make_ctrl_char (c
);
2412 /* Add in the other modifier bits. We took care of ctrl_modifier
2413 just above, and the shift key was taken care of by the X code,
2414 and applied to control characters by make_ctrl_char. */
2415 c
|= (event
->modifiers
2416 & (meta_modifier
| alt_modifier
2417 | hyper_modifier
| super_modifier
));
2418 button_down_time
= 0;
2422 /* A function key. The symbol may need to have modifier prefixes
2424 case non_ascii_keystroke
:
2425 button_down_time
= 0;
2427 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
2428 if (event
->code
== lispy_accent_codes
[i
])
2429 return modify_event_symbol (i
,
2431 Qfunction_key
, Qnil
,
2432 lispy_accent_keys
, &accent_key_syms
,
2433 (sizeof (lispy_accent_keys
)
2434 / sizeof (lispy_accent_keys
[0])));
2436 /* Handle system-specific keysyms. */
2437 if (event
->code
& (1 << 28))
2439 /* We need to use an alist rather than a vector as the cache
2440 since we can't make a vector long enuf. */
2441 if (NILP (system_key_syms
))
2442 system_key_syms
= Fcons (Qnil
, Qnil
);
2443 return modify_event_symbol (event
->code
& 0xffffff,
2445 Qfunction_key
, Vsystem_key_alist
,
2446 0, &system_key_syms
, 0xffffff);
2449 return modify_event_symbol (event
->code
- 0xff00,
2451 Qfunction_key
, Qnil
,
2452 lispy_function_keys
, &func_key_syms
,
2453 (sizeof (lispy_function_keys
)
2454 / sizeof (lispy_function_keys
[0])));
2457 /* A mouse click. Figure out where it is, decide whether it's
2458 a press, click or drag, and build the appropriate structure. */
2460 case scroll_bar_click
:
2462 int button
= event
->code
;
2464 Lisp_Object position
;
2465 Lisp_Object
*start_pos_ptr
;
2466 Lisp_Object start_pos
;
2468 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2471 /* Build the position as appropriate for this mouse click. */
2472 if (event
->kind
== mouse_click
)
2475 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2480 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
2481 &column
, &row
, 0, 0);
2483 #ifdef USE_X_TOOLKIT
2484 if (FRAME_EXTERNAL_MENU_BAR (f
) && XINT (event
->y
) == -1)
2486 if (row
< FRAME_MENU_BAR_LINES (f
))
2489 Lisp_Object items
, item
;
2491 #ifdef USE_X_TOOLKIT
2492 /* The click happened in the menubar.
2493 Look for the menu item selected. */
2494 item
= map_event_to_object (event
, f
);
2496 XFASTINT (event
->y
) = 1;
2497 #else /* not USE_X_TOOLKIT */
2501 items
= FRAME_MENU_BAR_ITEMS (f
);
2502 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 3)
2504 Lisp_Object pos
, string
;
2505 string
= XVECTOR (items
)->contents
[i
+ 1];
2506 pos
= XVECTOR (items
)->contents
[i
+ 2];
2509 if (column
>= XINT (pos
)
2510 && column
< XINT (pos
) + XSTRING (string
)->size
)
2512 item
= XVECTOR (items
)->contents
[i
];
2516 #endif /* not USE_X_TOOLKIT */
2519 = Fcons (event
->frame_or_window
,
2521 Fcons (Fcons (event
->x
, event
->y
),
2522 Fcons (make_number (event
->timestamp
),
2525 return Fcons (item
, Fcons (position
, Qnil
));
2528 window
= window_from_coordinates (f
, column
, row
, &part
);
2530 if (XTYPE (window
) != Lisp_Window
)
2534 int pixcolumn
, pixrow
;
2535 column
-= XINT (XWINDOW (window
)->left
);
2536 row
-= XINT (XWINDOW (window
)->top
);
2537 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
2538 XSETINT (event
->x
, pixcolumn
);
2539 XSETINT (event
->y
, pixrow
);
2544 posn
= Qvertical_line
;
2546 XSET (posn
, Lisp_Int
,
2547 buffer_posn_from_coords (XWINDOW (window
),
2554 Fcons (Fcons (event
->x
, event
->y
),
2555 Fcons (make_number (event
->timestamp
),
2561 Lisp_Object portion_whole
;
2564 window
= event
->frame_or_window
;
2565 portion_whole
= Fcons (event
->x
, event
->y
);
2566 part
= *scroll_bar_parts
[(int) event
->part
];
2570 Fcons (Qvertical_scroll_bar
,
2571 Fcons (portion_whole
,
2572 Fcons (make_number (event
->timestamp
),
2573 Fcons (part
, Qnil
)))));
2576 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2578 start_pos
= *start_pos_ptr
;
2579 *start_pos_ptr
= Qnil
;
2581 is_double
= (button
== last_mouse_button
2582 && XINT (event
->x
) == last_mouse_x
2583 && XINT (event
->y
) == last_mouse_y
2584 && button_down_time
!= 0
2585 && (EQ (Vdouble_click_time
, Qt
)
2586 || (INTEGERP (Vdouble_click_time
)
2587 && ((int)(event
->timestamp
- button_down_time
)
2588 < XINT (Vdouble_click_time
)))));
2589 last_mouse_button
= button
;
2590 last_mouse_x
= XINT (event
->x
);
2591 last_mouse_y
= XINT (event
->y
);
2593 /* If this is a button press, squirrel away the location, so
2594 we can decide later whether it was a click or a drag. */
2595 if (event
->modifiers
& down_modifier
)
2599 double_click_count
++;
2600 event
->modifiers
|= ((double_click_count
> 2)
2605 double_click_count
= 1;
2606 button_down_time
= event
->timestamp
;
2607 *start_pos_ptr
= Fcopy_alist (position
);
2610 /* Now we're releasing a button - check the co-ordinates to
2611 see if this was a click or a drag. */
2612 else if (event
->modifiers
& up_modifier
)
2614 /* If we did not see a down before this up,
2615 ignore the up. Probably this happened because
2616 the down event chose a menu item.
2617 It would be an annoyance to treat the release
2618 of the button that chose the menu item
2619 as a separate event. */
2621 if (XTYPE (start_pos
) != Lisp_Cons
)
2624 event
->modifiers
&= ~up_modifier
;
2625 #if 0 /* Formerly we treated an up with no down as a click event. */
2626 if (XTYPE (start_pos
) != Lisp_Cons
)
2627 event
->modifiers
|= click_modifier
;
2631 /* The third element of every position should be the (x,y)
2633 Lisp_Object down
= Fnth (make_number (2), start_pos
);
2635 if (EQ (event
->x
, XCONS (down
)->car
)
2636 && EQ (event
->y
, XCONS (down
)->cdr
))
2638 if (is_double
&& double_click_count
> 1)
2639 event
->modifiers
|= ((double_click_count
> 2)
2643 event
->modifiers
|= click_modifier
;
2647 button_down_time
= 0;
2648 event
->modifiers
|= drag_modifier
;
2653 /* Every mouse event should either have the down_modifier or
2654 the up_modifier set. */
2658 /* Get the symbol we should use for the mouse click. */
2660 = modify_event_symbol (button
,
2663 lispy_mouse_names
, &mouse_syms
,
2664 (sizeof (lispy_mouse_names
)
2665 / sizeof (lispy_mouse_names
[0])));
2667 if (event
->modifiers
& drag_modifier
)
2672 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2675 Fcons (make_number (double_click_count
),
2684 /* The 'kind' field of the event is something we don't recognize. */
2691 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2693 Lisp_Object bar_window
;
2694 enum scroll_bar_part part
;
2698 /* Is it a scroll bar movement? */
2699 if (frame
&& ! NILP (bar_window
))
2701 Lisp_Object part_sym
= *scroll_bar_parts
[(int) part
];
2703 return Fcons (Qscroll_bar_movement
,
2704 (Fcons (Fcons (bar_window
,
2705 Fcons (Qvertical_scroll_bar
,
2706 Fcons (Fcons (x
, y
),
2707 Fcons (make_number (time
),
2713 /* Or is it an ordinary mouse movement? */
2721 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
, 0, 0);
2724 window
= window_from_coordinates (frame
, column
, row
, &area
);
2728 if (XTYPE (window
) == Lisp_Window
)
2730 int pixcolumn
, pixrow
;
2731 column
-= XINT (XWINDOW (window
)->left
);
2732 row
-= XINT (XWINDOW (window
)->top
);
2733 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
2734 XSETINT (x
, pixcolumn
);
2735 XSETINT (y
, pixrow
);
2740 posn
= Qvertical_line
;
2742 XSET (posn
, Lisp_Int
,
2743 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
2745 else if (frame
!= 0)
2747 XSET (window
, Lisp_Frame
, frame
);
2758 return Fcons (Qmouse_movement
,
2759 Fcons (Fcons (window
,
2761 Fcons (Fcons (x
, y
),
2762 Fcons (make_number (time
),
2768 /* Construct a switch frame event. */
2770 make_lispy_switch_frame (frame
)
2773 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
2776 /* Manipulating modifiers. */
2778 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
2780 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2781 SYMBOL's name of the end of the modifiers; the string from this
2782 position is the unmodified symbol name.
2784 This doesn't use any caches. */
2786 parse_modifiers_uncached (symbol
, modifier_end
)
2790 struct Lisp_String
*name
;
2794 CHECK_SYMBOL (symbol
, 1);
2797 name
= XSYMBOL (symbol
)->name
;
2800 for (i
= 0; i
+2 <= name
->size
; )
2801 switch (name
->data
[i
])
2803 #define SINGLE_LETTER_MOD(bit) \
2804 if (name->data[i+1] != '-') \
2805 goto no_more_modifiers; \
2810 SINGLE_LETTER_MOD (alt_modifier
);
2814 SINGLE_LETTER_MOD (ctrl_modifier
);
2818 SINGLE_LETTER_MOD (hyper_modifier
);
2822 SINGLE_LETTER_MOD (meta_modifier
);
2826 SINGLE_LETTER_MOD (shift_modifier
);
2830 SINGLE_LETTER_MOD (super_modifier
);
2834 if (i
+ 5 > name
->size
)
2835 goto no_more_modifiers
;
2836 if (! strncmp (name
->data
+ i
, "drag-", 5))
2838 modifiers
|= drag_modifier
;
2841 else if (! strncmp (name
->data
+ i
, "down-", 5))
2843 modifiers
|= down_modifier
;
2846 else if (i
+ 7 <= name
->size
2847 && ! strncmp (name
->data
+ i
, "double-", 7))
2849 modifiers
|= double_modifier
;
2853 goto no_more_modifiers
;
2857 if (i
+ 7 > name
->size
)
2858 goto no_more_modifiers
;
2859 if (! strncmp (name
->data
+ i
, "triple-", 7))
2861 modifiers
|= triple_modifier
;
2865 goto no_more_modifiers
;
2869 goto no_more_modifiers
;
2871 #undef SINGLE_LETTER_MOD
2875 /* Should we include the `click' modifier? */
2876 if (! (modifiers
& (down_modifier
| drag_modifier
2877 | double_modifier
| triple_modifier
))
2878 && i
+ 7 == name
->size
2879 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
2880 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
2881 modifiers
|= click_modifier
;
2890 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
2891 prepended to the string BASE[0..BASE_LEN-1].
2892 This doesn't use any caches. */
2894 apply_modifiers_uncached (modifiers
, base
, base_len
)
2899 /* Since BASE could contain nulls, we can't use intern here; we have
2900 to use Fintern, which expects a genuine Lisp_String, and keeps a
2903 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
2909 /* Only the event queue may use the `up' modifier; it should always
2910 be turned into a click or drag event before presented to lisp code. */
2911 if (modifiers
& up_modifier
)
2914 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
2915 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
2916 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
2917 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
2918 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
2919 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
2920 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
2921 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
2922 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
2923 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
2924 /* The click modifier is denoted by the absence of other modifiers. */
2928 mod_len
= p
- new_mods
;
2932 Lisp_Object new_name
= make_uninit_string (mod_len
+ base_len
);
2934 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
2935 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
2937 return Fintern (new_name
, Qnil
);
2942 static char *modifier_names
[] =
2944 "up", "down", "drag", "click", "double", "triple", 0, 0,
2945 0, 0, 0, 0, 0, 0, 0, 0,
2946 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
2948 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
2950 static Lisp_Object modifier_symbols
;
2952 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
2954 lispy_modifier_list (modifiers
)
2957 Lisp_Object modifier_list
;
2960 modifier_list
= Qnil
;
2961 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
2962 if (modifiers
& (1<<i
))
2963 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
2966 return modifier_list
;
2970 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
2971 where UNMODIFIED is the unmodified form of SYMBOL,
2972 MASK is the set of modifiers present in SYMBOL's name.
2973 This is similar to parse_modifiers_uncached, but uses the cache in
2974 SYMBOL's Qevent_symbol_element_mask property, and maintains the
2975 Qevent_symbol_elements property. */
2977 parse_modifiers (symbol
)
2980 Lisp_Object elements
= Fget (symbol
, Qevent_symbol_element_mask
);
2982 if (CONSP (elements
))
2987 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
2988 Lisp_Object unmodified
2989 = Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
2990 XSYMBOL (symbol
)->name
->size
- end
),
2994 if (modifiers
& ~((1<<VALBITS
) - 1))
2996 XFASTINT (mask
) = modifiers
;
2997 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
2999 /* Cache the parsing results on SYMBOL. */
3000 Fput (symbol
, Qevent_symbol_element_mask
,
3002 Fput (symbol
, Qevent_symbol_elements
,
3003 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
3005 /* Since we know that SYMBOL is modifiers applied to unmodified,
3006 it would be nice to put that in unmodified's cache.
3007 But we can't, since we're not sure that parse_modifiers is
3014 /* Apply the modifiers MODIFIERS to the symbol BASE.
3015 BASE must be unmodified.
3017 This is like apply_modifiers_uncached, but uses BASE's
3018 Qmodifier_cache property, if present. It also builds
3019 Qevent_symbol_elements properties, since it has that info anyway.
3021 apply_modifiers copies the value of BASE's Qevent_kind property to
3022 the modified symbol. */
3024 apply_modifiers (modifiers
, base
)
3028 Lisp_Object cache
, index
, entry
, new_symbol
;
3030 /* Mask out upper bits. We don't know where this value's been. */
3031 modifiers
&= (1<<VALBITS
) - 1;
3033 /* The click modifier never figures into cache indices. */
3034 cache
= Fget (base
, Qmodifier_cache
);
3035 XFASTINT (index
) = (modifiers
& ~click_modifier
);
3036 entry
= Fassq (index
, cache
);
3039 new_symbol
= XCONS (entry
)->cdr
;
3042 /* We have to create the symbol ourselves. */
3043 new_symbol
= apply_modifiers_uncached (modifiers
,
3044 XSYMBOL (base
)->name
->data
,
3045 XSYMBOL (base
)->name
->size
);
3047 /* Add the new symbol to the base's cache. */
3048 entry
= Fcons (index
, new_symbol
);
3049 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
3051 /* We have the parsing info now for free, so add it to the caches. */
3052 XFASTINT (index
) = modifiers
;
3053 Fput (new_symbol
, Qevent_symbol_element_mask
,
3054 Fcons (base
, Fcons (index
, Qnil
)));
3055 Fput (new_symbol
, Qevent_symbol_elements
,
3056 Fcons (base
, lispy_modifier_list (modifiers
)));
3059 /* Make sure this symbol is of the same kind as BASE.
3061 You'd think we could just set this once and for all when we
3062 intern the symbol above, but reorder_modifiers may call us when
3063 BASE's property isn't set right; we can't assume that just
3064 because it has a Qmodifier_cache property it must have its
3065 Qevent_kind set right as well. */
3066 if (NILP (Fget (new_symbol
, Qevent_kind
)))
3068 Lisp_Object kind
= Fget (base
, Qevent_kind
);
3071 Fput (new_symbol
, Qevent_kind
, kind
);
3078 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
3079 return a symbol with the modifiers placed in the canonical order.
3080 Canonical order is alphabetical, except for down and drag, which
3081 always come last. The 'click' modifier is never written out.
3083 Fdefine_key calls this to make sure that (for example) C-M-foo
3084 and M-C-foo end up being equivalent in the keymap. */
3087 reorder_modifiers (symbol
)
3090 /* It's hopefully okay to write the code this way, since everything
3091 will soon be in caches, and no consing will be done at all. */
3092 Lisp_Object parsed
= parse_modifiers (symbol
);
3094 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
3095 XCONS (parsed
)->car
);
3099 /* For handling events, we often want to produce a symbol whose name
3100 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
3101 to some base, like the name of a function key or mouse button.
3102 modify_event_symbol produces symbols of this sort.
3104 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
3105 is the name of the i'th symbol. TABLE_SIZE is the number of elements
3108 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
3109 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
3111 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
3112 persist between calls to modify_event_symbol that it can use to
3113 store a cache of the symbols it's generated for this NAME_TABLE
3114 before. The object stored there may be a vector or an alist.
3116 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
3118 MODIFIERS is a set of modifier bits (as given in struct input_events)
3119 whose prefixes should be applied to the symbol name.
3121 SYMBOL_KIND is the value to be placed in the event_kind property of
3122 the returned symbol.
3124 The symbols we create are supposed to have an
3125 `event-symbol-elements' property, which lists the modifiers present
3126 in the symbol's name. */
3129 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
3130 name_table
, symbol_table
, table_size
)
3133 Lisp_Object symbol_kind
;
3134 Lisp_Object name_alist
;
3136 Lisp_Object
*symbol_table
;
3140 Lisp_Object symbol_int
;
3142 XSET (symbol_int
, Lisp_Int
, symbol_num
);
3144 /* Is this a request for a valid symbol? */
3145 if (symbol_num
< 0 || symbol_num
>= table_size
)
3148 if (CONSP (*symbol_table
))
3149 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
3151 /* If *symbol_table doesn't seem to be initialized properly, fix that.
3152 *symbol_table should be a lisp vector TABLE_SIZE elements long,
3153 where the Nth element is the symbol for NAME_TABLE[N], or nil if
3154 we've never used that symbol before. */
3157 if (! VECTORP (*symbol_table
)
3158 || XVECTOR (*symbol_table
)->size
!= table_size
)
3162 XFASTINT (size
) = table_size
;
3163 *symbol_table
= Fmake_vector (size
, Qnil
);
3166 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
3169 /* Have we already used this symbol before? */
3172 /* No; let's create it. */
3173 if (!NILP (name_alist
))
3174 value
= Fassq (symbol_int
, name_alist
);
3175 else if (name_table
[symbol_num
])
3176 value
= intern (name_table
[symbol_num
]);
3180 sprintf (buf
, "key-%d", symbol_num
);
3181 value
= intern (buf
);
3184 if (CONSP (*symbol_table
))
3185 *symbol_table
= Fcons (value
, *symbol_table
);
3187 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
3189 /* Fill in the cache entries for this symbol; this also
3190 builds the Qevent_symbol_elements property, which the user
3192 apply_modifiers (modifiers
& click_modifier
, value
);
3193 Fput (value
, Qevent_kind
, symbol_kind
);
3196 /* Apply modifiers to that symbol. */
3197 return apply_modifiers (modifiers
, value
);
3201 /* Store into *addr a value nonzero if terminal input chars are available.
3202 Serves the purpose of ioctl (0, FIONREAD, addr)
3203 but works even if FIONREAD does not exist.
3204 (In fact, this may actually read some input.) */
3207 get_input_pending (addr
)
3210 /* First of all, have we already counted some input? */
3211 *addr
= !NILP (Vquit_flag
) || readable_events ();
3213 /* If input is being read as it arrives, and we have none, there is none. */
3214 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
3217 /* Try to read some input and see how much we get. */
3219 *addr
= !NILP (Vquit_flag
) || readable_events ();
3222 /* Interface to read_avail_input, blocking SIGIO if necessary. */
3225 gobble_input (expected
)
3230 if (interrupt_input
)
3233 mask
= sigblockx (SIGIO
);
3234 read_avail_input (expected
);
3239 read_avail_input (expected
);
3245 /* Read any terminal input already buffered up by the system
3246 into the kbd_buffer, but do not wait.
3248 EXPECTED should be nonzero if the caller knows there is some input.
3250 Except on VMS, all input is read by this function.
3251 If interrupt_input is nonzero, this function MUST be called
3252 only when SIGIO is blocked.
3254 Returns the number of keyboard chars read, or -1 meaning
3255 this is a bad time to try to read input. */
3258 read_avail_input (expected
)
3261 struct input_event buf
[KBD_BUFFER_SIZE
];
3265 if (read_socket_hook
)
3266 /* No need for FIONREAD or fcntl; just say don't wait. */
3267 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
3270 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
3271 the kbd_buffer can really hold. That may prevent loss
3272 of characters on some systems when input is stuffed at us. */
3273 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
3276 nread
= dos_keysns ();
3277 if (nread
== 0) return 0;
3278 #else */ not MSDOS */
3280 /* Find out how much input is available. */
3281 if (ioctl (0, FIONREAD
, &nread
) < 0)
3282 /* Formerly simply reported no input, but that sometimes led to
3283 a failure of Emacs to terminate.
3284 SIGHUP seems appropriate if we can't reach the terminal. */
3285 /* ??? Is it really right to send the signal just to this process
3286 rather than to the whole process group?
3287 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3288 kill (getpid (), SIGHUP
);
3291 if (nread
> sizeof cbuf
)
3292 nread
= sizeof cbuf
;
3293 #else /* no FIONREAD */
3294 #if defined(USG) || defined(DGUX)
3295 /* Read some input if available, but don't wait. */
3296 nread
= sizeof cbuf
;
3297 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
3302 #endif /* not MSDOS */
3304 /* Now read; for one reason or another, this will not block. */
3308 cbuf
[0] = dos_keyread();
3311 nread
= read (fileno (stdin
), cbuf
, nread
);
3314 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3315 This looks incorrect, but it isn't, because _BSD causes
3316 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3317 and that causes a value other than 0 when there is no input. */
3321 /* This code is wrong, but at least it gets the right results.
3322 Fix it for 19.23. */
3323 /* Retry the read if it is interrupted. */
3325 || ! (errno
== EAGAIN
3337 #if defined (USG) || defined (DGUX)
3338 fcntl (fileno (stdin
), F_SETFL
, 0);
3339 #endif /* USG or DGUX */
3340 #endif /* no FIONREAD */
3341 for (i
= 0; i
< nread
; i
++)
3343 buf
[i
].kind
= ascii_keystroke
;
3344 buf
[i
].modifiers
= 0;
3345 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3346 buf
[i
].modifiers
= meta_modifier
;
3350 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
3352 XSET (buf
[i
].frame_or_window
, Lisp_Frame
, selected_frame
);
3354 buf
[i
].frame_or_window
= Qnil
;
3359 /* Scan the chars for C-g and store them in kbd_buffer. */
3360 for (i
= 0; i
< nread
; i
++)
3362 kbd_buffer_store_event (&buf
[i
]);
3363 /* Don't look at input that follows a C-g too closely.
3364 This reduces lossage due to autorepeat on C-g. */
3365 if (buf
[i
].kind
== ascii_keystroke
3366 && XINT(buf
[i
].code
) == quit_char
)
3372 #endif /* not VMS */
3374 #ifdef SIGIO /* for entire page */
3375 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3378 input_available_signal (signo
)
3381 /* Must preserve main program's value of errno. */
3382 int old_errno
= errno
;
3384 extern int select_alarmed
;
3388 /* USG systems forget handlers when they are used;
3389 must reestablish each time */
3390 signal (signo
, input_available_signal
);
3397 if (input_available_clear_time
)
3398 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3403 nread
= read_avail_input (1);
3404 /* -1 means it's not ok to read the input now.
3405 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3406 0 means there was no keyboard input available. */
3411 select_alarmed
= 1; /* Force the select emulator back to life */
3422 /* Send ourselves a SIGIO.
3424 This function exists so that the UNBLOCK_INPUT macro in
3425 blockinput.h can have some way to take care of input we put off
3426 dealing with, without assuming that every file which uses
3427 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3429 reinvoke_input_signal ()
3438 /* Return the prompt-string of a sparse keymap.
3439 This is the first element which is a string.
3440 Return nil if there is none. */
3448 register Lisp_Object tem
;
3450 if (XTYPE (tem
) == Lisp_String
)
3457 static void menu_bar_item ();
3458 static void menu_bar_one_keymap ();
3460 /* These variables hold the vector under construction within
3461 menu_bar_items and its subroutines, and the current index
3462 for storing into that vector. */
3463 static Lisp_Object menu_bar_items_vector
;
3464 static Lisp_Object menu_bar_items_index
;
3466 /* Return a vector of menu items for a menu bar, appropriate
3467 to the current buffer. Each item has three elements in the vector:
3470 OLD is an old vector we can optionally reuse, or nil. */
3473 menu_bar_items (old
)
3476 /* The number of keymaps we're scanning right now, and the number of
3477 keymaps we have allocated space for. */
3480 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3481 in the current keymaps, or nil where it is not a prefix. */
3484 Lisp_Object def
, tem
, tail
;
3493 struct gcpro gcpro1
;
3495 /* In order to build the menus, we need to call the keymap
3496 accessors. They all call QUIT. But this function is called
3497 during redisplay, during which a quit is fatal. So inhibit
3498 quitting while building the menus.
3499 We do this instead of specbind because (1) errors will clear it anyway
3500 and (2) this avoids risk of specpdl overflow. */
3501 oquit
= Vinhibit_quit
;
3505 menu_bar_items_vector
= old
;
3507 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
3508 menu_bar_items_index
= 0;
3510 GCPRO1 (menu_bar_items_vector
);
3512 /* Build our list of keymaps.
3513 If we recognize a function key and replace its escape sequence in
3514 keybuf with its symbol, or if the sequence starts with a mouse
3515 click and we need to switch buffers, we jump back here to rebuild
3516 the initial keymaps from the current buffer. */
3520 if (!NILP (Voverriding_local_map
))
3523 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3524 maps
[0] = Voverriding_local_map
;
3528 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3529 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3530 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3531 #ifdef USE_TEXT_PROPERTIES
3532 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3534 maps
[nmaps
-2] = current_buffer
->keymap
;
3537 maps
[nmaps
-1] = current_global_map
;
3540 /* Look up in each map the dummy prefix key `menu-bar'. */
3544 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3546 if (! NILP (maps
[mapno
]))
3547 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3551 tem
= Fkeymapp (def
);
3553 menu_bar_one_keymap (def
);
3556 /* Move to the end those items that should be at the end. */
3558 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3561 int end
= menu_bar_items_index
;
3563 for (i
= 0; i
< end
; i
+= 3)
3564 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3566 Lisp_Object tem0
, tem1
, tem2
;
3567 /* Move the item at index I to the end,
3568 shifting all the others forward. */
3569 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
3570 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
3571 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
3573 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
3574 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
3575 (end
- i
- 3) * sizeof (Lisp_Object
));
3576 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem0
;
3577 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem1
;
3578 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem2
;
3583 /* Add nil, nil, nil at the end. */
3584 i
= menu_bar_items_index
;
3585 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
3588 int newsize
= 2 * i
;
3589 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
3590 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
3591 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
3592 menu_bar_items_vector
= tem
;
3594 /* Add this item. */
3595 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3596 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3597 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3598 menu_bar_items_index
= i
;
3600 Vinhibit_quit
= oquit
;
3602 return menu_bar_items_vector
;
3605 /* Scan one map KEYMAP, accumulating any menu items it defines
3606 that have not yet been seen in RESULT. Return the updated RESULT.
3607 *OLD is the frame's old menu bar list; we swipe elts from that
3608 to avoid consing. */
3611 menu_bar_one_keymap (keymap
)
3614 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3616 /* Loop over all keymap entries that have menu strings. */
3617 for (tail
= keymap
; XTYPE (tail
) == Lisp_Cons
; tail
= XCONS (tail
)->cdr
)
3619 item
= XCONS (tail
)->car
;
3620 if (XTYPE (item
) == Lisp_Cons
)
3622 key
= XCONS (item
)->car
;
3623 binding
= XCONS (item
)->cdr
;
3624 if (XTYPE (binding
) == Lisp_Cons
)
3626 item_string
= XCONS (binding
)->car
;
3627 if (XTYPE (item_string
) == Lisp_String
)
3628 menu_bar_item (key
, item_string
, Fcdr (binding
));
3630 else if (EQ (binding
, Qundefined
))
3631 menu_bar_item (key
, item_string
, binding
);
3633 else if (XTYPE (item
) == Lisp_Vector
)
3635 /* Loop over the char values represented in the vector. */
3636 int len
= XVECTOR (item
)->size
;
3638 for (c
= 0; c
< len
; c
++)
3640 Lisp_Object character
;
3641 XFASTINT (character
) = c
;
3642 binding
= XVECTOR (item
)->contents
[c
];
3643 if (XTYPE (binding
) == Lisp_Cons
)
3645 item_string
= XCONS (binding
)->car
;
3646 if (XTYPE (item_string
) == Lisp_String
)
3647 menu_bar_item (key
, item_string
, Fcdr (binding
));
3649 else if (EQ (binding
, Qundefined
))
3650 menu_bar_item (key
, item_string
, binding
);
3656 /* This is used as the handler when calling internal_condition_case_1. */
3659 menu_bar_item_1 (arg
)
3666 menu_bar_item (key
, item_string
, def
)
3667 Lisp_Object key
, item_string
, def
;
3670 Lisp_Object enabled
;
3673 if (EQ (def
, Qundefined
))
3675 /* If a map has an explicit nil as definition,
3676 discard any previously made menu bar item. */
3678 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
3679 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3681 if (menu_bar_items_index
> i
+ 3)
3682 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
3683 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
3684 (menu_bar_items_index
- i
- 3) * sizeof (Lisp_Object
));
3685 menu_bar_items_index
-= 3;
3690 /* See if this entry is enabled. */
3693 if (XTYPE (def
) == Lisp_Symbol
)
3695 /* No property, or nil, means enable.
3696 Otherwise, enable if value is not nil. */
3697 tem
= Fget (def
, Qmenu_enable
);
3699 /* (condition-case nil (eval tem)
3701 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
3705 /* Ignore this item if it's not enabled. */
3709 /* If there's already such an item, don't make another. */
3710 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
3711 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3714 /* If we did not find this item, add it at the end. */
3715 if (i
== menu_bar_items_index
)
3717 /* If vector is too small, get a bigger one. */
3718 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
3721 int newsize
= 2 * i
;
3722 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
3723 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
3724 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
3725 menu_bar_items_vector
= tem
;
3727 /* Add this item. */
3728 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
3729 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
3730 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3731 menu_bar_items_index
= i
;
3735 /* Read a character using menus based on maps in the array MAPS.
3736 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
3737 Return t if we displayed a menu but the user rejected it.
3739 PREV_EVENT is the previous input event, or nil if we are reading
3740 the first event of a key sequence.
3742 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3743 if we used a mouse menu to read the input, or zero otherwise. If
3744 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
3746 The prompting is done based on the prompt-string of the map
3747 and the strings associated with various map elements.
3749 This can be done with X menus or with menus put in the minibuf.
3750 These are done in different ways, depending on how the input will be read.
3751 Menus using X are done after auto-saving in read-char, getting the input
3752 event from Fx_popup_menu; menus using the minibuf use read_char recursively
3753 and do auto-saving in the inner call of read_char. */
3756 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
3759 Lisp_Object prev_event
;
3760 int *used_mouse_menu
;
3763 register Lisp_Object name
;
3764 Lisp_Object rest
, vector
;
3766 if (used_mouse_menu
)
3767 *used_mouse_menu
= 0;
3769 /* Use local over global Menu maps */
3771 if (! menu_prompting
)
3774 /* Get the menu name from the first map that has one (a prompt string). */
3775 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3777 name
= map_prompt (maps
[mapno
]);
3782 /* If we don't have any menus, just read a character normally. */
3786 #ifdef HAVE_X_WINDOWS
3788 /* If we got to this point via a mouse click,
3789 use a real menu for mouse selection. */
3790 if (EVENT_HAS_PARAMETERS (prev_event
))
3792 /* Display the menu and get the selection. */
3793 Lisp_Object
*realmaps
3794 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
3798 /* Use the maps that are not nil. */
3799 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3800 if (!NILP (maps
[mapno
]))
3801 realmaps
[nmaps1
++] = maps
[mapno
];
3803 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
3806 /* If we got more than one event, put all but the first
3807 onto this list to be read later.
3808 Return just the first event now. */
3809 unread_command_events
3810 = nconc2 (XCONS (value
)->cdr
, unread_command_events
);
3811 value
= XCONS (value
)->car
;
3815 if (used_mouse_menu
)
3816 *used_mouse_menu
= 1;
3819 #endif /* HAVE_X_MENU */
3820 #endif /* HAVE_X_WINDOWS */
3825 read_char_minibuf_menu_prompt(commandflag
, nmaps
, maps
)
3831 register Lisp_Object name
;
3833 int width
= FRAME_WIDTH (selected_frame
) - 4;
3834 char *menu
= (char *) alloca (width
+ 4);
3837 Lisp_Object rest
, vector
;
3839 if (! menu_prompting
)
3842 /* Get the menu name from the first map that has one (a prompt string). */
3843 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3845 name
= map_prompt (maps
[mapno
]);
3850 /* If we don't have any menus, just read a character normally. */
3854 /* Prompt string always starts with map's prompt, and a space. */
3855 strcpy (menu
, XSTRING (name
)->data
);
3856 nlength
= XSTRING (name
)->size
;
3857 menu
[nlength
++] = ':';
3858 menu
[nlength
++] = ' ';
3861 /* Start prompting at start of first map. */
3865 /* Present the documented bindings, a line at a time. */
3872 int orig_defn_macro
;
3874 /* Loop over elements of map. */
3879 /* If reached end of map, start at beginning of next map. */
3883 /* At end of last map, wrap around to first map if just starting,
3884 or end this line if already have something on it. */
3888 if (notfirst
|| nobindings
) break;
3893 /* Look at the next element of the map. */
3895 elt
= XVECTOR (vector
)->contents
[idx
];
3897 elt
= Fcar_safe (rest
);
3899 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
3901 /* If we found a dense table in the keymap,
3902 advanced past it, but start scanning its contents. */
3903 rest
= Fcdr_safe (rest
);
3909 /* An ordinary element. */
3911 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
3913 s
= Fcar_safe(elt
); /* vector */
3914 if (XTYPE (s
) != Lisp_String
)
3915 /* Ignore the element if it has no prompt string. */
3917 /* If we have room for the prompt string, add it to this line.
3918 If this is the first on the line, always add it. */
3919 else if (XSTRING (s
)->size
+ i
+ 2 < width
3924 /* Punctuate between strings. */
3927 strcpy (menu
+ i
, ", ");
3933 /* Add as much of string as fits. */
3934 thiswidth
= XSTRING (s
)->size
;
3935 if (thiswidth
+ i
> width
)
3936 thiswidth
= width
- i
;
3937 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
3943 /* If this element does not fit, end the line now,
3944 and save the element for the next line. */
3945 strcpy (menu
+ i
, "...");
3949 /* Move past this element. */
3950 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
3951 /* Handle reaching end of dense table. */
3956 rest
= Fcdr_safe (rest
);
3960 /* Prompt with that and read response. */
3963 /* Make believe its not a keyboard macro in case the help char
3964 is pressed. Help characters are not recorded because menu prompting
3965 is not used on replay.
3967 orig_defn_macro
= defining_kbd_macro
;
3968 defining_kbd_macro
= 0 ;
3970 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
3971 while (XTYPE (obj
) == Lisp_Buffer
);
3972 defining_kbd_macro
= orig_defn_macro
;
3974 if (XTYPE (obj
) != Lisp_Int
)
3979 if (! EQ (obj
, menu_prompt_more_char
)
3980 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
3981 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
3983 if ( defining_kbd_macro
)
3984 store_kbd_macro_char(obj
) ;
3987 /* Help char - go round again */
3991 /* Reading key sequences. */
3993 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
3994 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
3995 keymap, or nil otherwise. Return the index of the first keymap in
3996 which KEY has any binding, or NMAPS if no map has a binding.
3998 If KEY is a meta ASCII character, treat it like meta-prefix-char
3999 followed by the corresponding non-meta character. Keymaps in
4000 CURRENT with non-prefix bindings for meta-prefix-char become nil in
4003 When KEY is not defined in any of the keymaps, if it is an upper
4004 case letter and there are bindings for the corresponding lower-case
4005 letter, return the bindings for the lower-case letter.
4006 We store 1 in *CASE_CONVERTED in this case.
4007 Otherwise, we don't change *CASE_CONVERTED.
4009 If KEY has no bindings in any of the CURRENT maps, NEXT is left
4012 NEXT may == CURRENT. */
4015 follow_key (key
, nmaps
, current
, defs
, next
, case_converted
)
4017 Lisp_Object
*current
, *defs
, *next
;
4019 int *case_converted
;
4021 int i
, first_binding
;
4023 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
4024 followed by the corresponding non-meta character. */
4025 if (XTYPE (key
) == Lisp_Int
&& (XINT (key
) & CHAR_META
))
4027 for (i
= 0; i
< nmaps
; i
++)
4028 if (! NILP (current
[i
]))
4031 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
4033 /* Note that since we pass the resulting bindings through
4034 get_keymap_1, non-prefix bindings for meta-prefix-char
4036 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
4042 XSET (key
, Lisp_Int
, XFASTINT (key
) & ~CHAR_META
);
4045 first_binding
= nmaps
;
4046 for (i
= nmaps
- 1; i
>= 0; i
--)
4048 if (! NILP (current
[i
]))
4050 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
4051 if (! NILP (defs
[i
]))
4058 /* When KEY is not defined in any of the keymaps, if it is an upper
4059 case letter and there are bindings for the corresponding
4060 lower-case letter, return the bindings for the lower-case letter. */
4061 if (first_binding
== nmaps
4062 && XTYPE (key
) == Lisp_Int
4063 && ((((XINT (key
) & 0x3ffff)
4064 < XSTRING (current_buffer
->downcase_table
)->size
)
4065 && UPPERCASEP (XINT (key
) & 0x3ffff))
4066 || (XINT (key
) & shift_modifier
)))
4068 if (XINT (key
) & shift_modifier
)
4069 XSETINT (key
, XINT (key
) & ~shift_modifier
);
4071 XSETINT (key
, (DOWNCASE (XINT (key
) & 0x3ffff)
4072 | (XINT (key
) & ~0x3ffff)));
4074 first_binding
= nmaps
;
4075 for (i
= nmaps
- 1; i
>= 0; i
--)
4077 if (! NILP (current
[i
]))
4079 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
4080 if (! NILP (defs
[i
]))
4086 if (first_binding
!= nmaps
)
4087 *case_converted
= 1;
4090 /* Given the set of bindings we've found, produce the next set of maps. */
4091 if (first_binding
< nmaps
)
4092 for (i
= 0; i
< nmaps
; i
++)
4093 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
4095 return first_binding
;
4098 /* Read a sequence of keys that ends with a non prefix character,
4099 storing it in KEYBUF, a buffer of size BUFSIZE.
4101 Return the length of the key sequence stored.
4102 Return -1 if the user rejected a command menu.
4104 Echo starting immediately unless `prompt' is 0.
4106 Where a key sequence ends depends on the currently active keymaps.
4107 These include any minor mode keymaps active in the current buffer,
4108 the current buffer's local map, and the global map.
4110 If a key sequence has no other bindings, we check Vfunction_key_map
4111 to see if some trailing subsequence might be the beginning of a
4112 function key's sequence. If so, we try to read the whole function
4113 key, and substitute its symbolic name into the key sequence.
4115 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
4116 `double-' events into similar click events, if that would make them
4117 bound. We try to turn `triple-' events first into `double-' events,
4120 If we get a mouse click in a mode line, vertical divider, or other
4121 non-text area, we treat the click as if it were prefixed by the
4122 symbol denoting that area - `mode-line', `vertical-line', or
4125 If the sequence starts with a mouse click, we read the key sequence
4126 with respect to the buffer clicked on, not the current buffer.
4128 If the user switches frames in the midst of a key sequence, we put
4129 off the switch-frame event until later; the next call to
4130 read_char will return it. */
4133 read_key_sequence (keybuf
, bufsize
, prompt
)
4134 Lisp_Object
*keybuf
;
4138 int count
= specpdl_ptr
- specpdl
;
4140 /* How many keys there are in the current key sequence. */
4143 /* The length of the echo buffer when we started reading, and
4144 the length of this_command_keys when we started reading. */
4148 /* The number of keymaps we're scanning right now, and the number of
4149 keymaps we have allocated space for. */
4151 int nmaps_allocated
= 0;
4153 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
4154 the current keymaps. */
4157 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
4158 in the current keymaps, or nil where it is not a prefix. */
4159 Lisp_Object
*submaps
;
4161 /* The index in defs[] of the first keymap that has a binding for
4162 this key sequence. In other words, the lowest i such that
4163 defs[i] is non-nil. */
4166 /* If t < mock_input, then KEYBUF[t] should be read as the next
4169 We use this to recover after recognizing a function key. Once we
4170 realize that a suffix of the current key sequence is actually a
4171 function key's escape sequence, we replace the suffix with the
4172 function key's binding from Vfunction_key_map. Now keybuf
4173 contains a new and different key sequence, so the echo area,
4174 this_command_keys, and the submaps and defs arrays are wrong. In
4175 this situation, we set mock_input to t, set t to 0, and jump to
4176 restart_sequence; the loop will read keys from keybuf up until
4177 mock_input, thus rebuilding the state; and then it will resume
4178 reading characters from the keyboard. */
4181 /* If the sequence is unbound in submaps[], then
4182 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
4183 and fkey_map is its binding.
4185 These might be > t, indicating that all function key scanning
4186 should hold off until t reaches them. We do this when we've just
4187 recognized a function key, to avoid searching for the function
4188 key's again in Vfunction_key_map. */
4189 int fkey_start
= 0, fkey_end
= 0;
4190 Lisp_Object fkey_map
;
4192 /* Likewise, for key_translation_map. */
4193 int keytran_start
= 0, keytran_end
= 0;
4194 Lisp_Object keytran_map
;
4196 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
4197 we put it off for later. While we're reading, we keep the event here. */
4198 Lisp_Object delayed_switch_frame
;
4200 /* See the comment below... */
4201 #if defined (GOBBLE_FIRST_EVENT)
4202 Lisp_Object first_event
;
4205 struct buffer
*starting_buffer
;
4207 /* Nonzero if we found the binding for one of the chars
4208 in this key sequence by downcasing it. */
4209 int case_converted
= 0;
4211 /* Nonzero if we seem to have got the beginning of a binding
4212 in function_key_map. */
4213 int function_key_possible
= 0;
4217 last_nonmenu_event
= Qnil
;
4219 delayed_switch_frame
= Qnil
;
4220 fkey_map
= Vfunction_key_map
;
4221 keytran_map
= Vkey_translation_map
;
4223 /* If there is no function-key-map, turn off function key scanning. */
4224 if (NILP (Fkeymapp (Vfunction_key_map
)))
4225 fkey_start
= fkey_end
= bufsize
+ 1;
4227 /* If there is no key-translation-map, turn off scanning. */
4228 if (NILP (Fkeymapp (Vkey_translation_map
)))
4229 keytran_start
= keytran_end
= bufsize
+ 1;
4234 echo_prompt (XSTRING (prompt
)->data
);
4235 else if (cursor_in_echo_area
)
4236 /* This doesn't put in a dash if the echo buffer is empty, so
4237 you don't always see a dash hanging out in the minibuffer. */
4241 /* Record the initial state of the echo area and this_command_keys;
4242 we will need to restore them if we replay a key sequence. */
4244 echo_start
= echo_length ();
4245 keys_start
= this_command_key_count
;
4247 #if defined (GOBBLE_FIRST_EVENT)
4248 /* This doesn't quite work, because some of the things that read_char
4249 does cannot safely be bypassed. It seems too risky to try to make
4252 /* Read the first char of the sequence specially, before setting
4253 up any keymaps, in case a filter runs and switches buffers on us. */
4254 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
4256 #endif /* GOBBLE_FIRST_EVENT */
4258 /* We jump here when the key sequence has been thoroughly changed, and
4259 we need to rescan it starting from the beginning. When we jump here,
4260 keybuf[0..mock_input] holds the sequence we should reread. */
4263 starting_buffer
= current_buffer
;
4265 function_key_possible
= 0;
4267 /* Build our list of keymaps.
4268 If we recognize a function key and replace its escape sequence in
4269 keybuf with its symbol, or if the sequence starts with a mouse
4270 click and we need to switch buffers, we jump back here to rebuild
4271 the initial keymaps from the current buffer. */
4275 if (!NILP (Voverriding_local_map
))
4278 if (nmaps
> nmaps_allocated
)
4280 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4281 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4282 nmaps_allocated
= nmaps
;
4284 submaps
[0] = Voverriding_local_map
;
4288 nmaps
= current_minor_maps (0, &maps
) + 2;
4289 if (nmaps
> nmaps_allocated
)
4291 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4292 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4293 nmaps_allocated
= nmaps
;
4295 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
4296 #ifdef USE_TEXT_PROPERTIES
4297 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
4299 submaps
[nmaps
-2] = current_buffer
->keymap
;
4302 submaps
[nmaps
-1] = current_global_map
;
4305 /* Find an accurate initial value for first_binding. */
4306 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
4307 if (! NILP (submaps
[first_binding
]))
4310 /* Start from the beginning in keybuf. */
4313 /* These are no-ops the first time through, but if we restart, they
4314 revert the echo area and this_command_keys to their original state. */
4315 this_command_key_count
= keys_start
;
4316 if (INTERACTIVE
&& t
< mock_input
)
4317 echo_truncate (echo_start
);
4319 /* If the best binding for the current key sequence is a keymap, or
4320 we may be looking at a function key's escape sequence, keep on
4322 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
4323 || (first_binding
>= nmaps
4325 /* mock input is never part of a function key's sequence. */
4326 && mock_input
<= fkey_start
)
4327 || (first_binding
>= nmaps
4328 && keytran_start
< t
4329 /* mock input is never part of a function key's sequence. */
4330 && mock_input
<= keytran_start
)
4331 /* Don't return in the middle of a possible function key sequence,
4332 if the only bindings we found were via case conversion.
4333 Thus, if ESC O a has a function-key-map translation
4334 and ESC o has a binding, don't return after ESC O,
4335 so that we can translate ESC O plus the next character. */
4336 || (function_key_possible
&& case_converted
))
4339 int used_mouse_menu
= 0;
4341 /* Where the last real key started. If we need to throw away a
4342 key that has expanded into more than one element of keybuf
4343 (say, a mouse click on the mode line which is being treated
4344 as [mode-line (mouse-...)], then we backtrack to this point
4346 int last_real_key_start
;
4348 /* These variables are analogous to echo_start and keys_start;
4349 while those allow us to restart the entire key sequence,
4350 echo_local_start and keys_local_start allow us to throw away
4352 int echo_local_start
, keys_local_start
, local_first_binding
;
4355 error ("key sequence too long");
4358 echo_local_start
= echo_length ();
4359 keys_local_start
= this_command_key_count
;
4360 local_first_binding
= first_binding
;
4363 /* These are no-ops, unless we throw away a keystroke below and
4364 jumped back up to replay_key; in that case, these restore the
4365 variables to their original state, allowing us to replay the
4367 if (INTERACTIVE
&& t
< mock_input
)
4368 echo_truncate (echo_local_start
);
4369 this_command_key_count
= keys_local_start
;
4370 first_binding
= local_first_binding
;
4372 /* By default, assume each event is "real". */
4373 last_real_key_start
= t
;
4375 /* Does mock_input indicate that we are re-reading a key sequence? */
4379 add_command_key (key
);
4383 /* If not, we should actually read a character. */
4386 struct buffer
*buf
= current_buffer
;
4388 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
4391 /* read_char returns t when it shows a menu and the user rejects it.
4396 /* read_char returns -1 at the end of a macro.
4397 Emacs 18 handles this by returning immediately with a
4398 zero, so that's what we'll do. */
4399 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) == -1)
4405 /* If the current buffer has been changed from under us, the
4406 keymap may have changed, so replay the sequence. */
4407 if (XTYPE (key
) == Lisp_Buffer
)
4410 goto replay_sequence
;
4413 /* If we have a quit that was typed in another frame, and
4414 quit_throw_to_read_char switched buffers,
4415 replay to get the right keymap. */
4416 if (EQ (key
, quit_char
) && current_buffer
!= starting_buffer
)
4421 goto replay_sequence
;
4427 /* Clicks in non-text areas get prefixed by the symbol
4428 in their CHAR-ADDRESS field. For example, a click on
4429 the mode line is prefixed by the symbol `mode-line'.
4431 Furthermore, key sequences beginning with mouse clicks
4432 are read using the keymaps of the buffer clicked on, not
4433 the current buffer. So we may have to switch the buffer
4436 When we turn one event into two events, we must make sure
4437 that neither of the two looks like the original--so that,
4438 if we replay the events, they won't be expanded again.
4439 If not for this, such reexpansion could happen either here
4440 or when user programs play with this-command-keys. */
4441 if (EVENT_HAS_PARAMETERS (key
))
4443 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
4445 if (EQ (kind
, Qmouse_click
))
4447 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
4448 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4450 if (XTYPE (posn
) == Lisp_Cons
)
4452 /* We're looking at the second event of a
4453 sequence which we expanded before. Set
4454 last_real_key_start appropriately. */
4456 last_real_key_start
= t
- 1;
4459 /* Key sequences beginning with mouse clicks are
4460 read using the keymaps in the buffer clicked on,
4461 not the current buffer. If we're at the
4462 beginning of a key sequence, switch buffers. */
4463 if (last_real_key_start
== 0
4464 && XTYPE (window
) == Lisp_Window
4465 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
4466 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
4471 /* Arrange to go back to the original buffer once we're
4472 done reading the key sequence. Note that we can't
4473 use save_excursion_{save,restore} here, because they
4474 save point as well as the current buffer; we don't
4475 want to save point, because redisplay may change it,
4476 to accommodate a Fset_window_start or something. We
4477 don't want to do this at the top of the function,
4478 because we may get input from a subprocess which
4479 wants to change the selected window and stuff (say,
4481 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
4483 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
4484 goto replay_sequence
;
4486 else if (XTYPE (posn
) == Lisp_Symbol
)
4488 /* Expand mode-line and scroll-bar events into two events:
4489 use posn as a fake prefix key. */
4491 if (t
+ 1 >= bufsize
)
4492 error ("key sequence too long");
4497 /* Zap the position in key, so we know that we've
4498 expanded it, and don't try to do so again. */
4499 POSN_BUFFER_POSN (EVENT_START (key
))
4500 = Fcons (posn
, Qnil
);
4504 else if (EQ (kind
, Qswitch_frame
))
4506 /* If we're at the beginning of a key sequence, go
4507 ahead and return this event. If we're in the
4508 midst of a key sequence, delay it until the end. */
4511 delayed_switch_frame
= key
;
4517 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4519 /* Handle menu-bar events:
4520 insert the dummy prefix event `menu-bar'. */
4521 if (EQ (posn
, Qmenu_bar
))
4523 if (t
+ 1 >= bufsize
)
4524 error ("key sequence too long");
4525 /* Run the Lucid hook. */
4526 if (!NILP (Vrun_hooks
))
4527 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4528 /* If it has changed current-menubar from previous value,
4529 really recompute the menubar from the value. */
4530 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4531 call0 (Qrecompute_lucid_menubar
);
4535 /* Zap the position in key, so we know that we've
4536 expanded it, and don't try to do so again. */
4537 POSN_BUFFER_POSN (EVENT_START (key
))
4538 = Fcons (posn
, Qnil
);
4541 goto replay_sequence
;
4543 else if (XTYPE (posn
) == Lisp_Cons
)
4545 /* We're looking at the second event of a
4546 sequence which we expanded before. Set
4547 last_real_key_start appropriately. */
4548 if (last_real_key_start
== t
&& t
> 0)
4549 last_real_key_start
= t
- 1;
4554 /* We have finally decided that KEY is something we might want
4556 first_binding
= (follow_key (key
,
4557 nmaps
- first_binding
,
4558 submaps
+ first_binding
,
4559 defs
+ first_binding
,
4560 submaps
+ first_binding
,
4564 /* If KEY wasn't bound, we'll try some fallbacks. */
4565 if (first_binding
>= nmaps
)
4567 Lisp_Object head
= EVENT_HEAD (key
);
4569 if (EQ (head
, Vhelp_char
))
4571 read_key_sequence_cmd
= Vprefix_help_command
;
4573 last_nonmenu_event
= key
;
4577 if (XTYPE (head
) == Lisp_Symbol
)
4579 Lisp_Object breakdown
= parse_modifiers (head
);
4580 int modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4582 /* Attempt to reduce an unbound mouse event to a simpler
4583 event that is bound:
4584 Drags reduce to clicks.
4585 Double-clicks reduce to clicks.
4586 Triple-clicks reduce to double-clicks, then to clicks.
4587 Down-clicks are eliminated.
4588 Double-downs reduce to downs, then are eliminated.
4589 Triple-downs reduce to double-downs, then to downs,
4590 then are eliminated. */
4591 if (modifiers
& (down_modifier
| drag_modifier
4592 | double_modifier
| triple_modifier
))
4594 while (modifiers
& (down_modifier
| drag_modifier
4595 | double_modifier
| triple_modifier
))
4597 Lisp_Object new_head
, new_click
;
4598 if (modifiers
& triple_modifier
)
4599 modifiers
^= (double_modifier
| triple_modifier
);
4600 else if (modifiers
& (drag_modifier
| double_modifier
))
4601 modifiers
&= ~(drag_modifier
| double_modifier
);
4604 /* Dispose of this `down' event by simply jumping
4605 back to replay_key, to get another event.
4607 Note that if this event came from mock input,
4608 then just jumping back to replay_key will just
4609 hand it to us again. So we have to wipe out any
4612 We could delete keybuf[t] and shift everything
4613 after that to the left by one spot, but we'd also
4614 have to fix up any variable that points into
4615 keybuf, and shifting isn't really necessary
4618 Adding prefixes for non-textual mouse clicks
4619 creates two characters of mock input, and both
4620 must be thrown away. If we're only looking at
4621 the prefix now, we can just jump back to
4622 replay_key. On the other hand, if we've already
4623 processed the prefix, and now the actual click
4624 itself is giving us trouble, then we've lost the
4625 state of the keymaps we want to backtrack to, and
4626 we need to replay the whole sequence to rebuild
4629 Beyond that, only function key expansion could
4630 create more than two keys, but that should never
4631 generate mouse events, so it's okay to zero
4632 mock_input in that case too.
4634 Isn't this just the most wonderful code ever? */
4635 if (t
== last_real_key_start
)
4642 mock_input
= last_real_key_start
;
4643 goto replay_sequence
;
4648 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
4650 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
4652 /* Look for a binding for this new key. follow_key
4653 promises that it didn't munge submaps the
4654 last time we called it, since key was unbound. */
4656 = (follow_key (new_click
,
4657 nmaps
- local_first_binding
,
4658 submaps
+ local_first_binding
,
4659 defs
+ local_first_binding
,
4660 submaps
+ local_first_binding
,
4662 + local_first_binding
);
4664 /* If that click is bound, go for it. */
4665 if (first_binding
< nmaps
)
4670 /* Otherwise, we'll leave key set to the drag event. */
4677 /* Normally, last_nonmenu_event gets the previous key we read.
4678 But when a mouse popup menu is being used,
4679 we don't update last_nonmenu_event; it continues to hold the mouse
4680 event that preceded the first level of menu. */
4681 if (!used_mouse_menu
)
4682 last_nonmenu_event
= key
;
4684 /* If the sequence is unbound, see if we can hang a function key
4685 off the end of it. We only want to scan real keyboard input
4686 for function key sequences, so if mock_input says that we're
4687 re-reading old events, don't examine it. */
4688 if ((first_binding
>= nmaps
|| case_converted
)
4691 Lisp_Object fkey_next
;
4693 /* Continue scan from fkey_end until we find a bound suffix.
4694 If we fail, increment fkey_start
4695 and start fkey_end from there. */
4696 while (fkey_end
< t
)
4700 key
= keybuf
[fkey_end
++];
4701 /* Look up meta-characters by prefixing them
4702 with meta_prefix_char. I hate this. */
4703 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4708 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
4710 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4713 fkey_next
= fkey_map
;
4716 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
4718 /* If the function key map gives a function, not an
4719 array, then call the function with no args and use
4720 its value instead. */
4721 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
4724 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4728 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4729 fkey_next
= call1 (fkey_next
, prompt
);
4731 /* If the function returned something invalid,
4732 barf--don't ignore it.
4733 (To ignore it safely, we would need to gcpro a bunch of
4734 other variables.) */
4735 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
4736 error ("Function in function-key-map returns invalid key sequence");
4739 function_key_possible
= ! NILP (fkey_next
);
4741 /* If keybuf[fkey_start..fkey_end] is bound in the
4742 function key map and it's a suffix of the current
4743 sequence (i.e. fkey_end == t), replace it with
4744 the binding and restart with fkey_start at the end. */
4745 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
4748 int len
= XFASTINT (Flength (fkey_next
));
4750 t
= fkey_start
+ len
;
4752 error ("key sequence too long");
4754 if (VECTORP (fkey_next
))
4755 bcopy (XVECTOR (fkey_next
)->contents
,
4756 keybuf
+ fkey_start
,
4757 (t
- fkey_start
) * sizeof (keybuf
[0]));
4758 else if (STRINGP (fkey_next
))
4762 for (i
= 0; i
< len
; i
++)
4763 XFASTINT (keybuf
[fkey_start
+ i
])
4764 = XSTRING (fkey_next
)->data
[i
];
4768 fkey_start
= fkey_end
= t
;
4769 fkey_map
= Vfunction_key_map
;
4771 goto replay_sequence
;
4774 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
4776 /* If we no longer have a bound suffix, try a new positions for
4778 if (NILP (fkey_map
))
4780 fkey_end
= ++fkey_start
;
4781 fkey_map
= Vfunction_key_map
;
4782 function_key_possible
= 0;
4787 /* Look for this sequence in key-translation-map. */
4789 Lisp_Object keytran_next
;
4791 /* Scan from keytran_end until we find a bound suffix. */
4792 while (keytran_end
< t
)
4796 key
= keybuf
[keytran_end
++];
4797 /* Look up meta-characters by prefixing them
4798 with meta_prefix_char. I hate this. */
4799 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4804 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
4806 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4809 keytran_next
= keytran_map
;
4812 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
4814 /* If the key translation map gives a function, not an
4815 array, then call the function with no args and use
4816 its value instead. */
4817 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
4818 && keytran_end
== t
)
4820 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4824 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4825 keytran_next
= call1 (keytran_next
, prompt
);
4827 /* If the function returned something invalid,
4828 barf--don't ignore it.
4829 (To ignore it safely, we would need to gcpro a bunch of
4830 other variables.) */
4831 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
4832 error ("Function in key-translation-map returns invalid key sequence");
4835 /* If keybuf[keytran_start..keytran_end] is bound in the
4836 key translation map and it's a suffix of the current
4837 sequence (i.e. keytran_end == t), replace it with
4838 the binding and restart with keytran_start at the end. */
4839 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
4840 && keytran_end
== t
)
4842 int len
= XFASTINT (Flength (keytran_next
));
4844 t
= keytran_start
+ len
;
4846 error ("key sequence too long");
4848 if (VECTORP (keytran_next
))
4849 bcopy (XVECTOR (keytran_next
)->contents
,
4850 keybuf
+ keytran_start
,
4851 (t
- keytran_start
) * sizeof (keybuf
[0]));
4852 else if (STRINGP (keytran_next
))
4856 for (i
= 0; i
< len
; i
++)
4857 XFASTINT (keybuf
[keytran_start
+ i
])
4858 = XSTRING (keytran_next
)->data
[i
];
4862 keytran_start
= keytran_end
= t
;
4863 keytran_map
= Vkey_translation_map
;
4865 goto replay_sequence
;
4868 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
4870 /* If we no longer have a bound suffix, try a new positions for
4872 if (NILP (keytran_map
))
4874 keytran_end
= ++keytran_start
;
4875 keytran_map
= Vkey_translation_map
;
4881 read_key_sequence_cmd
= (first_binding
< nmaps
4882 ? defs
[first_binding
]
4886 unread_switch_frame
= delayed_switch_frame
;
4887 unbind_to (count
, Qnil
);
4889 /* Occasionally we fabricate events, perhaps by expanding something
4890 according to function-key-map, or by adding a prefix symbol to a
4891 mouse click in the scroll bar or modeline. In this cases, return
4892 the entire generated key sequence, even if we hit an unbound
4893 prefix or a definition before the end. This means that you will
4894 be able to push back the event properly, and also means that
4895 read-key-sequence will always return a logical unit.
4898 for (; t
< mock_input
; t
++)
4900 echo_char (keybuf
[t
]);
4901 add_command_key (keybuf
[t
]);
4907 #if 0 /* This doc string is too long for some compilers.
4908 This commented-out definition serves for DOC. */
4909 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4910 "Read a sequence of keystrokes and return as a string or vector.\n\
4911 The sequence is sufficient to specify a non-prefix command in the\n\
4912 current local and global maps.\n\
4914 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
4915 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
4916 as a continuation of the previous key.\n\
4918 A C-g typed while in this function is treated like any other character,\n\
4919 and `quit-flag' is not set.\n\
4921 If the key sequence starts with a mouse click, then the sequence is read\n\
4922 using the keymaps of the buffer of the window clicked in, not the buffer\n\
4923 of the selected window as normal.\n\
4925 `read-key-sequence' drops unbound button-down events, since you normally\n\
4926 only care about the click or drag events which follow them. If a drag\n\
4927 or multi-click event is unbound, but the corresponding click event would\n\
4928 be bound, `read-key-sequence' turns the event into a click event at the\n\
4929 drag's starting position. This means that you don't have to distinguish\n\
4930 between click and drag, double, or triple events unless you want to.\n\
4932 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
4933 lines separating windows, and scroll bars with imaginary keys\n\
4934 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
4936 If the user switches frames in the middle of a key sequence, the\n\
4937 frame-switch event is put off until after the current key sequence.\n\
4939 `read-key-sequence' checks `function-key-map' for function key\n\
4940 sequences, where they wouldn't conflict with ordinary bindings. See\n\
4941 `function-key-map' for more details.")
4942 (prompt
, continue_echo
)
4945 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4947 (prompt
, continue_echo
)
4948 Lisp_Object prompt
, continue_echo
;
4950 Lisp_Object keybuf
[30];
4952 struct gcpro gcpro1
, gcpro2
;
4955 CHECK_STRING (prompt
, 0);
4958 bzero (keybuf
, sizeof keybuf
);
4960 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
4962 if (NILP (continue_echo
))
4963 this_command_key_count
= 0;
4965 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])), prompt
);
4973 return make_event_array (i
, keybuf
);
4976 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
4977 "Execute CMD as an editor command.\n\
4978 CMD must be a symbol that satisfies the `commandp' predicate.\n\
4979 Optional second arg RECORD-FLAG non-nil\n\
4980 means unconditionally put this command in `command-history'.\n\
4981 Otherwise, that is done only if an arg is read using the minibuffer.")
4983 Lisp_Object cmd
, record
;
4985 register Lisp_Object final
;
4986 register Lisp_Object tem
;
4987 Lisp_Object prefixarg
;
4988 struct backtrace backtrace
;
4989 extern int debug_on_next_call
;
4991 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
4992 Vcurrent_prefix_arg
= prefixarg
;
4993 debug_on_next_call
= 0;
4995 if (XTYPE (cmd
) == Lisp_Symbol
)
4997 tem
= Fget (cmd
, Qdisabled
);
4998 if (!NILP (tem
) && !NILP (Vrun_hooks
))
4999 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
5004 final
= Findirect_function (cmd
);
5006 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
5007 do_autoload (final
, cmd
);
5012 if (XTYPE (final
) == Lisp_String
5013 || XTYPE (final
) == Lisp_Vector
)
5015 /* If requested, place the macro in the command history. For
5016 other sorts of commands, call-interactively takes care of
5020 = Fcons (Fcons (Qexecute_kbd_macro
,
5021 Fcons (final
, Fcons (prefixarg
, Qnil
))),
5024 return Fexecute_kbd_macro (final
, prefixarg
);
5026 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
5027 || XTYPE (final
) == Lisp_Compiled
)
5029 backtrace
.next
= backtrace_list
;
5030 backtrace_list
= &backtrace
;
5031 backtrace
.function
= &Qcall_interactively
;
5032 backtrace
.args
= &cmd
;
5033 backtrace
.nargs
= 1;
5034 backtrace
.evalargs
= 0;
5036 tem
= Fcall_interactively (cmd
, record
);
5038 backtrace_list
= backtrace
.next
;
5044 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
5046 "Read function name, then read its arguments and call it.")
5048 Lisp_Object prefixarg
;
5050 Lisp_Object function
;
5052 Lisp_Object saved_keys
;
5053 struct gcpro gcpro1
;
5055 saved_keys
= Fvector (this_command_key_count
,
5056 XVECTOR (this_command_keys
)->contents
);
5058 GCPRO1 (saved_keys
);
5060 if (EQ (prefixarg
, Qminus
))
5062 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
5063 strcpy (buf
, "C-u ");
5064 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
5065 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
5066 else if (XTYPE (prefixarg
) == Lisp_Int
)
5067 sprintf (buf
, "%d ", XINT (prefixarg
));
5069 /* This isn't strictly correct if execute-extended-command
5070 is bound to anything else. Perhaps it should use
5071 this_command_keys? */
5072 strcat (buf
, "M-x ");
5074 /* Prompt with buf, and then read a string, completing from and
5075 restricting to the set of all defined commands. Don't provide
5076 any initial input. Save the command read on the extended-command
5078 function
= Fcompleting_read (build_string (buf
),
5079 Vobarray
, Qcommandp
,
5080 Qt
, Qnil
, Qextended_command_history
);
5082 /* Set this_command_keys to the concatenation of saved_keys and
5083 function, followed by a RET. */
5085 struct Lisp_String
*str
;
5090 this_command_key_count
= 0;
5092 keys
= XVECTOR (saved_keys
)->contents
;
5093 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
5094 add_command_key (keys
[i
]);
5096 str
= XSTRING (function
);
5097 for (i
= 0; i
< str
->size
; i
++)
5099 XFASTINT (tem
) = str
->data
[i
];
5100 add_command_key (tem
);
5103 XFASTINT (tem
) = '\015';
5104 add_command_key (tem
);
5109 function
= Fintern (function
, Qnil
);
5110 Vprefix_arg
= prefixarg
;
5111 this_command
= function
;
5113 return Fcommand_execute (function
, Qt
);
5117 detect_input_pending ()
5120 get_input_pending (&input_pending
);
5122 return input_pending
;
5125 /* This is called in some cases before a possible quit.
5126 It cases the next call to detect_input_pending to recompute input_pending.
5127 So calling this function unnecessarily can't do any harm. */
5128 clear_input_pending ()
5133 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
5134 "T if command input is currently available with no waiting.\n\
5135 Actually, the value is nil only if we can be sure that no input is available.")
5138 if (!NILP (unread_command_events
) || unread_command_char
!= -1)
5141 return detect_input_pending () ? Qt
: Qnil
;
5144 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
5145 "Return vector of last 100 events, not counting those from keyboard macros.")
5148 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
5151 if (total_keys
< NUM_RECENT_KEYS
)
5152 return Fvector (total_keys
, keys
);
5155 val
= Fvector (NUM_RECENT_KEYS
, keys
);
5156 bcopy (keys
+ recent_keys_index
,
5157 XVECTOR (val
)->contents
,
5158 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
5160 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
5161 recent_keys_index
* sizeof (Lisp_Object
));
5166 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
5167 "Return the key sequence that invoked this command.\n\
5168 The value is a string or a vector.")
5171 return make_event_array (this_command_key_count
,
5172 XVECTOR (this_command_keys
)->contents
);
5175 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
5176 "Return the current depth in recursive edits.")
5180 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
5184 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
5185 "FOpen dribble file: ",
5186 "Start writing all keyboard characters to a dribble file called FILE.\n\
5187 If FILE is nil, close any open dribble file.")
5198 file
= Fexpand_file_name (file
, Qnil
);
5199 dribble
= fopen (XSTRING (file
)->data
, "w");
5204 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
5205 "Discard the contents of the terminal input buffer.\n\
5206 Also cancel any kbd macro being defined.")
5209 defining_kbd_macro
= 0;
5210 update_mode_lines
++;
5212 unread_command_events
= Qnil
;
5213 unread_command_char
= -1;
5215 discard_tty_input ();
5217 /* Without the cast, GCC complains that this assignment loses the
5218 volatile qualifier of kbd_store_ptr. Is there anything wrong
5220 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
5221 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5227 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
5228 "Stop Emacs and return to superior process. You can resume later.\n\
5229 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
5230 control, run a subshell instead.\n\n\
5231 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
5232 to be read as terminal input by Emacs's parent, after suspension.\n\
5234 Before suspending, call the functions in `suspend-hook' with no args.\n\
5235 If any of them returns nil, don't call the rest and don't suspend.\n\
5236 Otherwise, suspend normally and after resumption run the normal hook\n\
5237 `suspend-resume-hook' if that is bound and non-nil.\n\
5239 Some operating systems cannot stop the Emacs process and resume it later.\n\
5240 On such systems, Emacs starts a subshell instead of suspending.")
5242 Lisp_Object stuffstring
;
5245 int count
= specpdl_ptr
- specpdl
;
5246 int old_height
, old_width
;
5248 struct gcpro gcpro1
, gcpro2
;
5249 extern init_sys_modes ();
5251 if (!NILP (stuffstring
))
5252 CHECK_STRING (stuffstring
, 0);
5254 /* Run the functions in suspend-hook. */
5255 if (!NILP (Vrun_hooks
))
5256 call1 (Vrun_hooks
, intern ("suspend-hook"));
5258 GCPRO1 (stuffstring
);
5259 get_frame_size (&old_width
, &old_height
);
5261 /* sys_suspend can get an error if it tries to fork a subshell
5262 and the system resources aren't available for that. */
5263 record_unwind_protect (init_sys_modes
, 0);
5264 stuff_buffered_input (stuffstring
);
5269 unbind_to (count
, Qnil
);
5271 /* Check if terminal/window size has changed.
5272 Note that this is not useful when we are running directly
5273 with a window system; but suspend should be disabled in that case. */
5274 get_frame_size (&width
, &height
);
5275 if (width
!= old_width
|| height
!= old_height
)
5276 change_frame_size (selected_frame
, height
, width
, 0, 0);
5278 /* Run suspend-resume-hook. */
5279 if (!NILP (Vrun_hooks
))
5280 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
5286 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
5287 Then in any case stuff anything Emacs has read ahead and not used. */
5289 stuff_buffered_input (stuffstring
)
5290 Lisp_Object stuffstring
;
5292 register unsigned char *p
;
5294 /* stuff_char works only in BSD, versions 4.2 and up. */
5297 if (XTYPE (stuffstring
) == Lisp_String
)
5301 p
= XSTRING (stuffstring
)->data
;
5302 count
= XSTRING (stuffstring
)->size
;
5307 /* Anything we have read ahead, put back for the shell to read. */
5308 while (kbd_fetch_ptr
!= kbd_store_ptr
)
5310 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
5311 kbd_fetch_ptr
= kbd_buffer
;
5312 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
5313 stuff_char (kbd_fetch_ptr
->code
);
5314 kbd_fetch_ptr
->kind
= no_event
;
5315 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
5322 #endif /* BSD and not BSD4_1 */
5325 set_waiting_for_input (time_to_clear
)
5326 EMACS_TIME
*time_to_clear
;
5328 input_available_clear_time
= time_to_clear
;
5330 /* Tell interrupt_signal to throw back to read_char, */
5331 waiting_for_input
= 1;
5333 /* If interrupt_signal was called before and buffered a C-g,
5334 make it run again now, to avoid timing error. */
5335 if (!NILP (Vquit_flag
))
5336 quit_throw_to_read_char ();
5339 clear_waiting_for_input ()
5341 /* Tell interrupt_signal not to throw back to read_char, */
5342 waiting_for_input
= 0;
5343 input_available_clear_time
= 0;
5346 /* This routine is called at interrupt level in response to C-G.
5347 If interrupt_input, this is the handler for SIGINT.
5348 Otherwise, it is called from kbd_buffer_store_event,
5349 in handling SIGIO or SIGTINT.
5351 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
5352 immediately throw back to read_char.
5354 Otherwise it sets the Lisp variable quit-flag not-nil.
5355 This causes eval to throw, when it gets a chance.
5356 If quit-flag is already non-nil, it stops the job right away. */
5362 /* Must preserve main program's value of errno. */
5363 int old_errno
= errno
;
5366 /* USG systems forget handlers when they are used;
5367 must reestablish each time */
5368 signal (SIGINT
, interrupt_signal
);
5369 signal (SIGQUIT
, interrupt_signal
);
5374 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
5379 #ifdef SIGTSTP /* Support possible in later USG versions */
5381 * On systems which can suspend the current process and return to the original
5382 * shell, this command causes the user to end up back at the shell.
5383 * The "Auto-save" and "Abort" questions are not asked until
5384 * the user elects to return to emacs, at which point he can save the current
5385 * job and either dump core or continue.
5390 if (sys_suspend () == -1)
5392 printf ("Not running as a subprocess;\n");
5393 printf ("you can continue or abort.\n");
5396 /* Perhaps should really fork an inferior shell?
5397 But that would not provide any way to get back
5398 to the original shell, ever. */
5399 printf ("No support for stopping a process on this operating system;\n");
5400 printf ("you can continue or abort.\n");
5401 #endif /* not VMS */
5402 #endif /* not SIGTSTP */
5404 /* We must remain inside the screen area when the internal terminal
5405 is used. Note that [Enter] is not echoed by dos. */
5408 printf ("Auto-save? (y or n) ");
5410 if (((c
= getchar ()) & ~040) == 'Y')
5412 Fdo_auto_save (Qt
, Qnil
);
5414 printf ("\r\nAuto-save done");
5415 #else /* not MSDOS */
5416 printf ("Auto-save done\n");
5417 #endif /* not MSDOS */
5419 while (c
!= '\n') c
= getchar ();
5421 printf ("\r\nAbort? (y or n) ");
5422 #else /* not MSDOS */
5424 printf ("Abort (and enter debugger)? (y or n) ");
5426 printf ("Abort (and dump core)? (y or n) ");
5427 #endif /* not VMS */
5428 #endif /* not MSDOS */
5430 if (((c
= getchar ()) & ~040) == 'Y')
5432 while (c
!= '\n') c
= getchar ();
5434 printf ("\r\nContinuing...\r\n");
5435 #else /* not MSDOS */
5436 printf ("Continuing...\n");
5437 #endif /* not MSDOS */
5443 /* If executing a function that wants to be interrupted out of
5444 and the user has not deferred quitting by binding `inhibit-quit'
5445 then quit right away. */
5446 if (immediate_quit
&& NILP (Vinhibit_quit
))
5450 Fsignal (Qquit
, Qnil
);
5453 /* Else request quit when it's safe */
5457 if (waiting_for_input
&& !echoing
)
5458 quit_throw_to_read_char ();
5463 /* Handle a C-g by making read_char return C-g. */
5465 quit_throw_to_read_char ()
5467 quit_error_check ();
5469 /* Prevent another signal from doing this before we finish. */
5470 clear_waiting_for_input ();
5473 unread_command_events
= Qnil
;
5474 unread_command_char
= -1;
5476 #ifdef POLL_FOR_INPUT
5477 /* May be > 1 if in recursive minibuffer. */
5478 if (poll_suppress_count
== 0)
5482 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
5483 && XFRAME (internal_last_event_frame
) != selected_frame
)
5484 Fhandle_switch_frame (make_lispy_switch_frame (internal_last_event_frame
));
5487 _longjmp (getcjmp
, 1);
5490 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
5491 "Set mode of reading keyboard input.\n\
5492 First arg INTERRUPT non-nil means use input interrupts;\n\
5493 nil means use CBREAK mode.\n\
5494 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
5495 (no effect except in CBREAK mode).\n\
5496 Third arg META t means accept 8-bit input (for a Meta key).\n\
5497 META nil means ignore the top bit, on the assumption it is parity.\n\
5498 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
5499 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
5500 See also `current-input-mode'.")
5501 (interrupt
, flow
, meta
, quit
)
5502 Lisp_Object interrupt
, flow
, meta
, quit
;
5505 && (XTYPE (quit
) != Lisp_Int
5506 || XINT (quit
) < 0 || XINT (quit
) > 0400))
5507 error ("set-input-mode: QUIT must be an ASCII character");
5509 #ifdef POLL_FOR_INPUT
5515 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5516 #ifdef NO_SOCK_SIGIO
5517 if (read_socket_hook
)
5518 interrupt_input
= 0; /* No interrupts if reading from a socket. */
5520 #endif /* NO_SOCK_SIGIO */
5521 interrupt_input
= !NILP (interrupt
);
5522 #else /* not SIGIO */
5523 interrupt_input
= 0;
5524 #endif /* not SIGIO */
5525 /* Our VMS input only works by interrupts, as of now. */
5527 interrupt_input
= 1;
5529 flow_control
= !NILP (flow
);
5532 else if (EQ (meta
, Qt
))
5537 /* Don't let this value be out of range. */
5538 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
5542 #ifdef POLL_FOR_INPUT
5543 poll_suppress_count
= 1;
5549 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
5550 "Return information about the way Emacs currently reads keyboard input.\n\
5551 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
5552 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
5553 nil, Emacs is using CBREAK mode.\n\
5554 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
5555 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
5556 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
5557 META nil means ignoring the top bit, on the assumption it is parity.\n\
5558 META is neither t nor nil if accepting 8-bit input and using\n\
5559 all 8 bits as the character code.\n\
5560 QUIT is the character Emacs currently uses to quit.\n\
5561 The elements of this list correspond to the arguments of\n\
5567 val
[0] = interrupt_input
? Qt
: Qnil
;
5568 val
[1] = flow_control
? Qt
: Qnil
;
5569 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
5570 XFASTINT (val
[3]) = quit_char
;
5572 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
5578 /* This is correct before outermost invocation of the editor loop */
5579 command_loop_level
= -1;
5581 quit_char
= Ctl ('g');
5582 unread_command_events
= Qnil
;
5583 unread_command_char
= -1;
5585 recent_keys_index
= 0;
5586 kbd_fetch_ptr
= kbd_buffer
;
5587 kbd_store_ptr
= kbd_buffer
;
5588 do_mouse_tracking
= 0;
5592 /* This means that command_loop_1 won't try to select anything the first
5594 internal_last_event_frame
= Qnil
;
5595 Vlast_event_frame
= internal_last_event_frame
;
5598 /* If we're running a dumped Emacs, we need to clear out
5599 kbd_buffer_frame_or_window, in case some events got into it
5602 If we're running an undumped Emacs, it hasn't been initialized by
5603 syms_of_keyboard yet. */
5605 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5607 if (!noninteractive
)
5609 signal (SIGINT
, interrupt_signal
);
5610 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
5611 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
5612 SIGQUIT and we can't tell which one it will give us. */
5613 signal (SIGQUIT
, interrupt_signal
);
5614 #endif /* HAVE_TERMIO */
5615 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5617 signal (SIGIO
, input_available_signal
);
5621 /* Use interrupt input by default, if it works and noninterrupt input
5622 has deficiencies. */
5624 #ifdef INTERRUPT_INPUT
5625 interrupt_input
= 1;
5627 interrupt_input
= 0;
5630 /* Our VMS input only works by interrupts, as of now. */
5632 interrupt_input
= 1;
5638 if (keyboard_init_hook
)
5639 (*keyboard_init_hook
) ();
5641 #ifdef POLL_FOR_INPUT
5642 poll_suppress_count
= 1;
5647 /* This type's only use is in syms_of_keyboard, to initialize the
5648 event header symbols and put properties on them. */
5655 struct event_head head_table
[] = {
5656 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
5657 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
5658 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
5663 Qdisabled_command_hook
= intern ("disabled-command-hook");
5664 staticpro (&Qdisabled_command_hook
);
5666 Qself_insert_command
= intern ("self-insert-command");
5667 staticpro (&Qself_insert_command
);
5669 Qforward_char
= intern ("forward-char");
5670 staticpro (&Qforward_char
);
5672 Qbackward_char
= intern ("backward-char");
5673 staticpro (&Qbackward_char
);
5675 Qdisabled
= intern ("disabled");
5676 staticpro (&Qdisabled
);
5678 Qundefined
= intern ("undefined");
5679 staticpro (&Qundefined
);
5681 Qpre_command_hook
= intern ("pre-command-hook");
5682 staticpro (&Qpre_command_hook
);
5684 Qpost_command_hook
= intern ("post-command-hook");
5685 staticpro (&Qpost_command_hook
);
5687 Qcommand_hook_internal
= intern ("command-hook-internal");
5688 staticpro (&Qcommand_hook_internal
);
5690 Qfunction_key
= intern ("function-key");
5691 staticpro (&Qfunction_key
);
5692 Qmouse_click
= intern ("mouse-click");
5693 staticpro (&Qmouse_click
);
5695 Qmenu_enable
= intern ("menu-enable");
5696 staticpro (&Qmenu_enable
);
5698 Qmode_line
= intern ("mode-line");
5699 staticpro (&Qmode_line
);
5700 Qvertical_line
= intern ("vertical-line");
5701 staticpro (&Qvertical_line
);
5702 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
5703 staticpro (&Qvertical_scroll_bar
);
5704 Qmenu_bar
= intern ("menu-bar");
5705 staticpro (&Qmenu_bar
);
5707 Qabove_handle
= intern ("above-handle");
5708 staticpro (&Qabove_handle
);
5709 Qhandle
= intern ("handle");
5710 staticpro (&Qhandle
);
5711 Qbelow_handle
= intern ("below-handle");
5712 staticpro (&Qbelow_handle
);
5714 Qevent_kind
= intern ("event-kind");
5715 staticpro (&Qevent_kind
);
5716 Qevent_symbol_elements
= intern ("event-symbol-elements");
5717 staticpro (&Qevent_symbol_elements
);
5718 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
5719 staticpro (&Qevent_symbol_element_mask
);
5720 Qmodifier_cache
= intern ("modifier-cache");
5721 staticpro (&Qmodifier_cache
);
5723 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
5724 staticpro (&Qrecompute_lucid_menubar
);
5725 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
5726 staticpro (&Qactivate_menubar_hook
);
5729 struct event_head
*p
;
5731 for (p
= head_table
;
5732 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
5735 *p
->var
= intern (p
->name
);
5737 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
5738 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
5742 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
5743 staticpro (&button_down_location
);
5747 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
5749 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
5750 for (i
= 0; i
< len
; i
++)
5751 if (modifier_names
[i
])
5752 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
5753 staticpro (&modifier_symbols
);
5756 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
5757 staticpro (&recent_keys
);
5759 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
5760 staticpro (&this_command_keys
);
5762 Qextended_command_history
= intern ("extended-command-history");
5763 Fset (Qextended_command_history
, Qnil
);
5764 staticpro (&Qextended_command_history
);
5766 kbd_buffer_frame_or_window
5767 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
5768 staticpro (&kbd_buffer_frame_or_window
);
5770 func_key_syms
= Qnil
;
5771 staticpro (&func_key_syms
);
5774 staticpro (&mouse_syms
);
5776 unread_switch_frame
= Qnil
;
5777 staticpro (&unread_switch_frame
);
5779 defsubr (&Sread_key_sequence
);
5780 defsubr (&Srecursive_edit
);
5781 defsubr (&Strack_mouse
);
5782 defsubr (&Sinput_pending_p
);
5783 defsubr (&Scommand_execute
);
5784 defsubr (&Srecent_keys
);
5785 defsubr (&Sthis_command_keys
);
5786 defsubr (&Ssuspend_emacs
);
5787 defsubr (&Sabort_recursive_edit
);
5788 defsubr (&Sexit_recursive_edit
);
5789 defsubr (&Srecursion_depth
);
5790 defsubr (&Stop_level
);
5791 defsubr (&Sdiscard_input
);
5792 defsubr (&Sopen_dribble_file
);
5793 defsubr (&Sset_input_mode
);
5794 defsubr (&Scurrent_input_mode
);
5795 defsubr (&Sexecute_extended_command
);
5797 DEFVAR_LISP ("last-command-char", &last_command_char
,
5798 "Last input event that was part of a command.");
5800 DEFVAR_LISP ("last-command-event", &last_command_char
,
5801 "Last input event that was part of a command.");
5803 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
5804 "Last input event in a command, except for mouse menu events.\n\
5805 Mouse menus give back keys that don't look like mouse events;\n\
5806 this variable holds the actual mouse event that led to the menu,\n\
5807 so that you can determine whether the command was run by mouse or not.");
5809 DEFVAR_LISP ("last-input-char", &last_input_char
,
5810 "Last input event.");
5812 DEFVAR_LISP ("last-input-event", &last_input_char
,
5813 "Last input event.");
5815 DEFVAR_LISP ("unread-command-events", &unread_command_events
,
5816 "List of objects to be read as next command input events.");
5818 DEFVAR_INT ("unread-command-char", &unread_command_char
,
5819 "If not -1, an object to be read as next command input event.");
5821 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
5822 "Meta-prefix character code. Meta-foo as command input\n\
5823 turns into this character followed by foo.");
5824 XSET (meta_prefix_char
, Lisp_Int
, 033);
5826 DEFVAR_LISP ("last-command", &last_command
,
5827 "The last command executed. Normally a symbol with a function definition,\n\
5828 but can be whatever was found in the keymap, or whatever the variable\n\
5829 `this-command' was set to by that command.");
5830 last_command
= Qnil
;
5832 DEFVAR_LISP ("this-command", &this_command
,
5833 "The command now being executed.\n\
5834 The command can set this variable; whatever is put here\n\
5835 will be in `last-command' during the following command.");
5836 this_command
= Qnil
;
5838 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
5839 "*Number of keyboard input characters between auto-saves.\n\
5840 Zero means disable autosaving due to number of characters typed.");
5841 auto_save_interval
= 300;
5843 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
5844 "*Number of seconds idle time before auto-save.\n\
5845 Zero or nil means disable auto-saving due to idleness.\n\
5846 After auto-saving due to this many seconds of idle time,\n\
5847 Emacs also does a garbage collection if that seems to be warranted.");
5848 XFASTINT (Vauto_save_timeout
) = 30;
5850 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
5851 "*Nonzero means echo unfinished commands after this many seconds of pause.");
5852 echo_keystrokes
= 1;
5854 DEFVAR_INT ("polling-period", &polling_period
,
5855 "*Interval between polling for input during Lisp execution.\n\
5856 The reason for polling is to make C-g work to stop a running program.\n\
5857 Polling is needed only when using X windows and SIGIO does not work.\n\
5858 Polling is automatically disabled in all other cases.");
5861 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
5862 "*Maximum time between mouse clicks to make a double-click.\n\
5863 Measured in milliseconds. nil means disable double-click recognition;\n\
5864 t means double-clicks have no time limit and are detected\n\
5865 by position only.");
5866 Vdouble_click_time
= make_number (500);
5868 DEFVAR_INT ("num-input-keys", &num_input_keys
,
5869 "*Number of complete keys read from the keyboard so far.");
5873 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
5874 "*The frame in which the most recently read event occurred.\n\
5875 If the last event came from a keyboard macro, this is set to `macro'.");
5876 Vlast_event_frame
= Qnil
;
5879 DEFVAR_LISP ("help-char", &Vhelp_char
,
5880 "Character to recognize as meaning Help.\n\
5881 When it is read, do `(eval help-form)', and display result if it's a string.\n\
5882 If the value of `help-form' is nil, this char can be read normally.");
5883 XSET (Vhelp_char
, Lisp_Int
, Ctl ('H'));
5885 DEFVAR_LISP ("help-form", &Vhelp_form
,
5886 "Form to execute when character `help-char' is read.\n\
5887 If the form returns a string, that string is displayed.\n\
5888 If `help-form' is nil, the help char is not recognized.");
5891 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
5892 "Command to run when `help-char' character follows a prefix key.\n\
5893 This command is used only when there is no actual binding\n\
5894 for that character after that prefix key.");
5895 Vprefix_help_command
= Qnil
;
5897 DEFVAR_LISP ("top-level", &Vtop_level
,
5898 "Form to evaluate when Emacs starts up.\n\
5899 Useful to set before you dump a modified Emacs.");
5902 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
5903 "String used as translate table for keyboard input, or nil.\n\
5904 Each character is looked up in this string and the contents used instead.\n\
5905 If string is of length N, character codes N and up are untranslated.");
5906 Vkeyboard_translate_table
= Qnil
;
5908 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
5909 "Keymap of key translations that can override keymaps.\n\
5910 This keymap works like `function-key-map', but comes after that,\n\
5911 and applies even for keys that have ordinary bindings.");
5912 Vkey_translation_map
= Qnil
;
5914 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
5915 "Non-nil means to always spawn a subshell instead of suspending,\n\
5916 even if the operating system has support for stopping a process.");
5919 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
5920 "Non-nil means prompt with menus when appropriate.\n\
5921 This is done when reading from a keymap that has a prompt string,\n\
5922 for elements that have prompt strings.\n\
5923 The menu is displayed on the screen\n\
5924 if X menus were enabled at configuration\n\
5925 time and the previous event was a mouse click prefix key.\n\
5926 Otherwise, menu prompting uses the echo area.");
5929 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
5930 "Character to see next line of menu prompt.\n\
5931 Type this character while in a menu prompt to rotate around the lines of it.");
5932 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
5934 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
5935 "A mask of additional modifier keys to use with every keyboard character.\n\
5936 Emacs applies the modifiers of the character stored here to each keyboard\n\
5937 character it reads. For example, after evaluating the expression\n\
5938 (setq extra-keyboard-modifiers ?\C-x)\n\
5939 all input characters will have the control modifier applied to them.\n\
5941 Note that the character ?\C-@, equivalent to the integer zero, does\n\
5942 not count as a control character; rather, it counts as a character\n\
5943 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
5944 cancels any modification.");
5945 extra_keyboard_modifiers
= 0;
5947 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
5948 "If an editing command sets this to t, deactivate the mark afterward.\n\
5949 The command loop sets this to nil before each command,\n\
5950 and tests the value when the command returns.\n\
5951 Buffer modification stores t in this variable.");
5952 Vdeactivate_mark
= Qnil
;
5954 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
5955 "Temporary storage of pre-command-hook or post-command-hook.");
5956 Vcommand_hook_internal
= Qnil
;
5958 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
5959 "Normal hook run before each command is executed.");
5960 Vpre_command_hook
= Qnil
;
5962 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
5963 "Normal hook run after each command is executed.");
5964 Vpost_command_hook
= Qnil
;
5966 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
5967 "t means menu bar, specified Lucid style, needs to be recomputed.");
5968 Vlucid_menu_bar_dirty_flag
= Qnil
;
5970 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
5971 "List of menu bar items to move to the end of the menu bar.\n\
5972 The elements of the list are event types that may have menu bar bindings.");
5973 Vmenu_bar_final_items
= Qnil
;
5975 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
5976 "Keymap that overrides all other local keymaps.\n\
5977 If this variable is non-nil, it is used as a keymap instead of the\n\
5978 buffer's local map, and the minor mode keymaps and text property keymaps.");
5979 Voverriding_local_map
= Qnil
;
5981 DEFVAR_BOOL ("track-mouse", &do_mouse_tracking
,
5982 "*Non-nil means generate motion events for mouse motion.");
5984 DEFVAR_LISP ("system-key-alist", &Vsystem_key_alist
,
5985 "Alist of system-specific X windows key symbols.\n\
5986 Each element should have the form (N . SYMBOL) where N is the\n\
5987 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
5988 and SYMBOL is its name.");
5989 Vmenu_bar_final_items
= Qnil
;
5994 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
5995 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
5996 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
5997 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
5998 initial_define_key (meta_map
, 'x', "execute-extended-command");