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
;
247 /* A user-visible version of the above, intended to allow users to
248 figure out where the last event came from, if the event doesn't
249 carry that information itself (i.e. if it was a character). */
250 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
;
635 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
636 bcopy (XVECTOR (this_command_keys
)->contents
,
637 XVECTOR (new_keys
)->contents
,
638 size
* sizeof (Lisp_Object
));
640 this_command_keys
= new_keys
;
643 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
649 int count
= specpdl_ptr
- specpdl
;
652 if (command_loop_level
> 0)
654 specbind (Qstandard_output
, Qt
);
655 specbind (Qstandard_input
, Qt
);
658 val
= command_loop ();
660 Fsignal (Qquit
, Qnil
);
662 return unbind_to (count
, Qnil
);
665 /* When an auto-save happens, record the "time", and don't do again soon. */
668 last_auto_save
= num_nonmacro_input_chars
;
671 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
672 "Invoke the editor command loop recursively.\n\
673 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
674 that tells this function to return.\n\
675 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
676 This function is called by the editor initialization to begin editing.")
679 int count
= specpdl_ptr
- specpdl
;
682 command_loop_level
++;
683 update_mode_lines
= 1;
685 record_unwind_protect (recursive_edit_unwind
,
687 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
691 return unbind_to (count
, Qnil
);
695 recursive_edit_unwind (buffer
)
699 Fset_buffer (buffer
);
701 command_loop_level
--;
702 update_mode_lines
= 1;
710 Lisp_Object errmsg
, tail
, errname
, file_error
;
717 Vstandard_output
= Qt
;
718 Vstandard_input
= Qt
;
719 Vexecuting_macro
= Qnil
;
720 echo_area_glyphs
= 0;
722 /* If the window system or terminal frame hasn't been initialized
723 yet, or we're not interactive, it's best to dump this message out
724 to stderr and exit. */
725 if (! FRAME_MESSAGE_BUF (selected_frame
)
727 stream
= Qexternal_debugging_output
;
735 errname
= Fcar (data
);
737 if (EQ (errname
, Qerror
))
740 if (!CONSP (data
)) data
= Qnil
;
741 errmsg
= Fcar (data
);
746 errmsg
= Fget (errname
, Qerror_message
);
747 file_error
= Fmemq (Qfile_error
,
748 Fget (errname
, Qerror_conditions
));
751 /* Print an error message including the data items.
752 This is done by printing it into a scratch buffer
753 and then making a copy of the text in the buffer. */
755 if (!CONSP (data
)) data
= Qnil
;
759 /* For file-error, make error message by concatenating
760 all the data items. They are all strings. */
761 if (!NILP (file_error
) && !NILP (tail
))
762 errmsg
= XCONS (tail
)->car
, tail
= XCONS (tail
)->cdr
;
764 if (XTYPE (errmsg
) == Lisp_String
)
765 Fprinc (errmsg
, stream
);
767 write_string_1 ("peculiar error", -1, stream
);
769 for (i
= 0; CONSP (tail
); tail
= Fcdr (tail
), i
++)
771 write_string_1 (i
? ", " : ": ", 2, stream
);
772 if (!NILP (file_error
))
773 Fprinc (Fcar (tail
), stream
);
775 Fprin1 (Fcar (tail
), stream
);
779 /* If the window system or terminal frame hasn't been initialized
780 yet, or we're in -batch mode, this error should cause Emacs to exit. */
781 if (! FRAME_MESSAGE_BUF (selected_frame
)
785 Fkill_emacs (make_number (-1));
790 Vinhibit_quit
= Qnil
;
791 return make_number (0);
794 Lisp_Object
command_loop_1 ();
795 Lisp_Object
command_loop_2 ();
796 Lisp_Object
top_level_1 ();
798 /* Entry to editor-command-loop.
799 This level has the catches for exiting/returning to editor command loop.
800 It returns nil to exit recursive edit, t to abort it. */
805 if (command_loop_level
> 0 || minibuf_level
> 0)
807 return internal_catch (Qexit
, command_loop_2
, Qnil
);
812 internal_catch (Qtop_level
, top_level_1
, Qnil
);
813 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
815 /* End of file in -batch run causes exit here. */
821 /* Here we catch errors in execution of commands within the
822 editing loop, and reenter the editing loop.
823 When there is an error, cmd_error runs and returns a non-nil
824 value to us. A value of nil means that cmd_loop_1 itself
825 returned due to end of file (or end of kbd macro). */
830 register Lisp_Object val
;
833 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
842 return Feval (Vtop_level
);
848 /* On entry to the outer level, run the startup file */
849 if (!NILP (Vtop_level
))
850 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
851 else if (!NILP (Vpurify_flag
))
852 message ("Bare impure Emacs (standard Lisp code not loaded)");
854 message ("Bare Emacs (standard Lisp code not loaded)");
858 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
859 "Exit all recursive editing levels.")
862 Fthrow (Qtop_level
, Qnil
);
865 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
866 "Exit from the innermost recursive edit or minibuffer.")
869 if (command_loop_level
> 0 || minibuf_level
> 0)
870 Fthrow (Qexit
, Qnil
);
872 error ("No recursive edit is in progress");
875 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
876 "Abort the command that requested this recursive edit or minibuffer input.")
879 if (command_loop_level
> 0 || minibuf_level
> 0)
882 error ("No recursive edit is in progress");
885 /* This is the actual command reading loop,
886 sans error-handling encapsulation. */
888 Lisp_Object
Fcommand_execute ();
889 static int read_key_sequence ();
894 Lisp_Object cmd
, tem
;
897 Lisp_Object keybuf
[30];
902 struct buffer
*prev_buffer
;
905 Vdeactivate_mark
= Qnil
;
906 waiting_for_input
= 0;
911 this_command_key_count
= 0;
913 /* Make sure this hook runs after commands that get errors and
914 throw to top level. */
915 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
917 /* If we get an error during the post-command-hook,
918 cause post-command-hook to be nil. */
919 Vcommand_hook_internal
= Vpost_command_hook
;
920 Vpost_command_hook
= Qnil
;
922 call1 (Vrun_hooks
, Qcommand_hook_internal
);
924 Vpost_command_hook
= Vcommand_hook_internal
;
927 /* Do this after running Vpost_command_hook, for consistency. */
928 last_command
= this_command
;
932 /* Install chars successfully executed in kbd macro. */
934 if (defining_kbd_macro
&& NILP (Vprefix_arg
))
935 finalize_kbd_macro_chars ();
937 /* Make sure the current window's buffer is selected. */
938 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
939 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
941 /* Display any malloc warning that just came out. Use while because
942 displaying one warning can cause another. */
944 while (pending_malloc_warning
)
945 display_malloc_warning ();
949 Vdeactivate_mark
= Qnil
;
951 /* If minibuffer on and echo area in use,
952 wait 2 sec and redraw minibuffer. */
954 if (minibuf_level
&& echo_area_glyphs
)
956 /* Bind inhibit-quit to t so that C-g gets read in
957 rather than quitting back to the minibuffer. */
958 int count
= specpdl_ptr
- specpdl
;
959 specbind (Qinhibit_quit
, Qt
);
960 Fsit_for (make_number (2), Qnil
, Qnil
);
961 unbind_to (count
, Qnil
);
963 echo_area_glyphs
= 0;
965 if (!NILP (Vquit_flag
))
968 unread_command_events
= Fcons (make_number (quit_char
), Qnil
);
973 alloca (0); /* Cause a garbage collection now */
974 /* Since we can free the most stuff here. */
975 #endif /* C_ALLOCA */
979 /* Select the frame that the last event came from. Usually,
980 switch-frame events will take care of this, but if some lisp
981 code swallows a switch-frame event, we'll fix things up here.
982 Is this a good idea? */
983 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
984 && XFRAME (internal_last_event_frame
) != selected_frame
)
985 Fselect_frame (internal_last_event_frame
, Qnil
);
988 /* If it has changed current-menubar from previous value,
989 really recompute the menubar from the value. */
990 if (! NILP (Vlucid_menu_bar_dirty_flag
)
991 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
992 call0 (Qrecompute_lucid_menubar
);
994 /* Read next key sequence; i gets its length. */
995 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), Qnil
);
999 /* Now we have read a key sequence of length I,
1000 or else I is 0 and we found end of file. */
1002 if (i
== 0) /* End of file -- happens only in */
1003 return Qnil
; /* a kbd macro, at the end. */
1004 /* -1 means read_key_sequence got a menu that was rejected.
1005 Just loop around and read another command. */
1009 this_command_key_count
= 0;
1013 last_command_char
= keybuf
[i
- 1];
1015 /* If the previous command tried to force a specific window-start,
1016 forget about that, in case this command moves point far away
1017 from that position. */
1018 XWINDOW (selected_window
)->force_start
= Qnil
;
1020 cmd
= read_key_sequence_cmd
;
1021 if (!NILP (Vexecuting_macro
))
1023 if (!NILP (Vquit_flag
))
1025 Vexecuting_macro
= Qt
;
1026 QUIT
; /* Make some noise. */
1027 /* Will return since macro now empty. */
1031 /* Do redisplay processing after this command except in special
1032 cases identified below that set no_redisplay to 1.
1033 (actually, there's currently no way to prevent the redisplay,
1034 and no_redisplay is ignored.
1035 Perhaps someday we will really implement it. */
1038 prev_buffer
= current_buffer
;
1039 prev_modiff
= MODIFF
;
1040 last_point_position
= PT
;
1042 /* Execute the command. */
1045 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1047 /* If we get an error during the pre-command-hook,
1048 cause pre-command-hook to be nil. */
1049 Vcommand_hook_internal
= Vpre_command_hook
;
1050 Vpre_command_hook
= Qnil
;
1052 call1 (Vrun_hooks
, Qcommand_hook_internal
);
1054 Vpre_command_hook
= Vcommand_hook_internal
;
1057 if (NILP (this_command
))
1059 /* nil means key is undefined. */
1061 defining_kbd_macro
= 0;
1062 update_mode_lines
= 1;
1068 if (NILP (Vprefix_arg
) && ! no_direct
)
1070 /* Recognize some common commands in common situations and
1071 do them directly. */
1072 if (EQ (this_command
, Qforward_char
) && point
< ZV
)
1074 struct Lisp_Vector
*dp
1075 = window_display_table (XWINDOW (selected_window
));
1076 lose
= FETCH_CHAR (point
);
1079 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1080 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1081 : (lose
>= 0x20 && lose
< 0x7f))
1082 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1084 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1086 && !windows_or_buffers_changed
1087 && EQ (current_buffer
->selective_display
, Qnil
)
1088 && !detect_input_pending ()
1089 && NILP (Vexecuting_macro
))
1090 no_redisplay
= direct_output_forward_char (1);
1093 else if (EQ (this_command
, Qbackward_char
) && point
> BEGV
)
1095 struct Lisp_Vector
*dp
1096 = window_display_table (XWINDOW (selected_window
));
1098 lose
= FETCH_CHAR (point
);
1100 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1101 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1102 : (lose
>= 0x20 && lose
< 0x7f))
1103 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1105 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1107 && !windows_or_buffers_changed
1108 && EQ (current_buffer
->selective_display
, Qnil
)
1109 && !detect_input_pending ()
1110 && NILP (Vexecuting_macro
))
1111 no_redisplay
= direct_output_forward_char (-1);
1114 else if (EQ (this_command
, Qself_insert_command
)
1115 /* Try this optimization only on ascii keystrokes. */
1116 && XTYPE (last_command_char
) == Lisp_Int
)
1118 unsigned char c
= XINT (last_command_char
);
1120 if (NILP (Vexecuting_macro
) &&
1121 !EQ (minibuf_window
, selected_window
))
1123 if (!nonundocount
|| nonundocount
>= 20)
1130 lose
= (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1132 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1134 || MODIFF
<= current_buffer
->save_modified
1135 || windows_or_buffers_changed
1136 || !EQ (current_buffer
->selective_display
, Qnil
)
1137 || detect_input_pending ()
1138 || !NILP (Vexecuting_macro
);
1139 if (internal_self_insert (c
, 0))
1145 (point
== ZV
|| FETCH_CHAR (point
) == '\n'))
1147 struct Lisp_Vector
*dp
1148 = window_display_table (XWINDOW (selected_window
));
1155 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1156 if (XTYPE (obj
) == Lisp_Vector
1157 && XVECTOR (obj
)->size
== 1
1158 && (XTYPE (obj
= XVECTOR (obj
)->contents
[0])
1161 direct_output_for_insert (XINT (obj
));
1165 if (lose
>= 0x20 && lose
<= 0x7e)
1166 no_redisplay
= direct_output_for_insert (lose
);
1173 /* Here for a command that isn't executed directly */
1176 if (NILP (Vprefix_arg
))
1178 Fcommand_execute (this_command
, Qnil
);
1183 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1185 /* If we get an error during the post-command-hook,
1186 cause post-command-hook to be nil. */
1187 Vcommand_hook_internal
= Vpost_command_hook
;
1188 Vpost_command_hook
= Qnil
;
1190 call1 (Vrun_hooks
, Qcommand_hook_internal
);
1192 Vpost_command_hook
= Vcommand_hook_internal
;
1195 /* If there is a prefix argument,
1196 1) We don't want last_command to be ``universal-argument''
1197 (that would be dumb), so don't set last_command,
1198 2) we want to leave echoing on so that the prefix will be
1199 echoed as part of this key sequence, so don't call
1201 3) we want to leave this_command_key_count non-zero, so that
1202 read_char will realize that it is re-reading a character, and
1203 not echo it a second time. */
1204 if (NILP (Vprefix_arg
))
1206 last_command
= this_command
;
1208 this_command_key_count
= 0;
1211 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1213 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1215 current_buffer
->mark_active
= Qnil
;
1216 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1218 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1219 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1224 /* Number of seconds between polling for input. */
1227 /* Nonzero means polling for input is temporarily suppressed. */
1228 int poll_suppress_count
;
1230 #ifdef POLL_FOR_INPUT
1231 int polling_for_input
;
1233 /* Handle an alarm once each second and read pending input
1234 so as to handle a C-g if it comces in. */
1237 input_poll_signal ()
1239 if (interrupt_input_blocked
== 0
1240 && !waiting_for_input
)
1241 read_avail_input (0);
1242 signal (SIGALRM
, input_poll_signal
);
1243 alarm (polling_period
);
1248 /* Begin signals to poll for input, if they are appropriate.
1249 This function is called unconditionally from various places. */
1253 #ifdef POLL_FOR_INPUT
1254 if (read_socket_hook
&& !interrupt_input
)
1256 poll_suppress_count
--;
1257 if (poll_suppress_count
== 0)
1259 signal (SIGALRM
, input_poll_signal
);
1260 polling_for_input
= 1;
1261 alarm (polling_period
);
1267 /* Turn off polling. */
1271 #ifdef POLL_FOR_INPUT
1272 if (read_socket_hook
&& !interrupt_input
)
1274 if (poll_suppress_count
== 0)
1276 polling_for_input
= 0;
1279 poll_suppress_count
++;
1284 /* Set the value of poll_suppress_count to COUNT
1285 and start or stop polling accordingly. */
1288 set_poll_suppress_count (count
)
1291 #ifdef POLL_FOR_INPUT
1292 if (count
== 0 && poll_suppress_count
!= 0)
1294 poll_suppress_count
= 1;
1297 else if (count
!= 0 && poll_suppress_count
== 0)
1301 poll_suppress_count
= count
;
1305 /* Applying the control modifier to CHARACTER. */
1310 /* Save the upper bits here. */
1311 int upper
= c
& ~0177;
1315 /* Everything in the columns containing the upper-case letters
1316 denotes a control character. */
1317 if (c
>= 0100 && c
< 0140)
1321 /* Set the shift modifier for a control char
1322 made from a shifted letter. But only for letters! */
1323 if (oc
>= 'A' && oc
<= 'Z')
1324 c
|= shift_modifier
;
1327 /* The lower-case letters denote control characters too. */
1328 else if (c
>= 'a' && c
<= 'z')
1331 /* Include the bits for control and shift
1332 only if the basic ASCII code can't indicate them. */
1336 /* Replace the high bits. */
1337 c
|= (upper
& ~ctrl_modifier
);
1344 /* Input of single characters from keyboard */
1346 Lisp_Object
print_help ();
1347 static Lisp_Object
kbd_buffer_get_event ();
1349 /* read a character from the keyboard; call the redisplay if needed */
1350 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1351 -1 means do not do redisplay, but do do autosaving.
1354 /* The arguments MAPS and NMAPS are for menu prompting.
1355 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1357 PREV_EVENT is the previous input event, or nil if we are reading
1358 the first event of a key sequence.
1360 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1361 if we used a mouse menu to read the input, or zero otherwise. If
1362 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
1364 Value is t if we showed a menu and the user rejected it. */
1367 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1371 Lisp_Object prev_event
;
1372 int *used_mouse_menu
;
1374 register Lisp_Object c
;
1378 if (CONSP (unread_command_events
))
1380 c
= XCONS (unread_command_events
)->car
;
1381 unread_command_events
= XCONS (unread_command_events
)->cdr
;
1383 if (this_command_key_count
== 0)
1389 if (unread_command_char
!= -1)
1391 XSET (c
, Lisp_Int
, unread_command_char
);
1392 unread_command_char
= -1;
1394 if (this_command_key_count
== 0)
1400 if (!NILP (Vexecuting_macro
))
1403 /* We set this to Qmacro; since that's not a frame, nobody will
1404 try to switch frames on us, and the selected window will
1407 Since this event came from a macro, it would be misleading to
1408 leave internal_last_event_frame set to wherever the last
1409 real event came from. Normally, a switch-frame event selects
1410 internal_last_event_frame after each command is read, but
1411 events read from a macro should never cause a new frame to be
1413 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1416 /* Exit the macro if we are at the end.
1417 Also, some things replace the macro with t
1418 to force an early exit. */
1419 if (EQ (Vexecuting_macro
, Qt
)
1420 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1422 XSET (c
, Lisp_Int
, -1);
1426 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1427 if (XTYPE (Vexecuting_macro
) == Lisp_String
1428 && (XINT (c
) & 0x80))
1429 XFASTINT (c
) = CHAR_META
| (XINT (c
) & ~0x80);
1431 executing_macro_index
++;
1436 if (!NILP (unread_switch_frame
))
1438 c
= unread_switch_frame
;
1439 unread_switch_frame
= Qnil
;
1441 /* This event should make it into this_command_keys, and get echoed
1442 again, so we go to reread_first, rather than reread. */
1446 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1447 prepare_menu_bars ();
1449 /* Save outer setjmp data, in case called recursively. */
1450 save_getcjmp (save_jump
);
1454 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1457 if (_setjmp (getcjmp
))
1459 XSET (c
, Lisp_Int
, quit_char
);
1461 XSET (internal_last_event_frame
, Lisp_Frame
, selected_frame
);
1462 Vlast_event_frame
= internal_last_event_frame
;
1464 /* If we report the quit char as an event,
1465 don't do so more than once. */
1466 if (!NILP (Vinhibit_quit
))
1472 /* Message turns off echoing unless more keystrokes turn it on again. */
1473 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1476 /* If already echoing, continue. */
1479 /* Try reading a character via menu prompting in the minibuf.
1480 Try this before the sit-for, because the sit-for
1481 would do the wrong thing if we are supposed to do
1482 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1483 after a mouse event so don't try a minibuf menu. */
1485 if (nmaps
> 0 && INTERACTIVE
&&
1486 !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
))
1488 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1489 if ( ! NILP(c
) ) return c
;
1492 /* If in middle of key sequence and minibuffer not active,
1493 start echoing if enough time elapses. */
1494 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1496 && echo_keystrokes
> 0
1497 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1501 /* After a mouse event, start echoing right away.
1502 This is because we are probably about to display a menu,
1503 and we don't want to delay before doing so. */
1504 if (EVENT_HAS_PARAMETERS (prev_event
))
1508 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1514 /* Maybe auto save due to number of keystrokes or idle time. */
1516 if (commandflag
!= 0
1517 && auto_save_interval
> 0
1518 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1519 && !detect_input_pending ())
1522 save_getcjmp (temp
);
1523 Fdo_auto_save (Qnil
, Qnil
);
1524 restore_getcjmp (temp
);
1527 /* Try reading using an X menu.
1528 This is never confused with reading using the minibuf because the recursive
1529 call of read_char in read_char_minibuf_menu_prompt does not pass on
1531 if (nmaps
> 0 && INTERACTIVE
&&
1532 !NILP (prev_event
) && EVENT_HAS_PARAMETERS (prev_event
))
1533 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1535 /* Slow down auto saves logarithmically in size of current buffer,
1536 and garbage collect while we're at it. */
1537 if (INTERACTIVE
&& NILP (c
))
1539 int delay_level
, buffer_size
;
1541 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1542 last_non_minibuf_size
= Z
- BEG
;
1543 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1545 while (buffer_size
> 64)
1546 delay_level
++, buffer_size
-= buffer_size
>> 2;
1547 if (delay_level
< 4) delay_level
= 4;
1548 /* delay_level is 4 for files under around 50k, 7 at 100k,
1549 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1551 /* Auto save if enough time goes by without input. */
1552 if (commandflag
!= 0
1553 && num_nonmacro_input_chars
> last_auto_save
1554 && XTYPE (Vauto_save_timeout
) == Lisp_Int
1555 && XINT (Vauto_save_timeout
) > 0)
1558 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1559 tem0
= sit_for (delay
, 0, 1, 1);
1563 save_getcjmp (temp
);
1564 Fdo_auto_save (Qnil
, Qnil
);
1565 restore_getcjmp (temp
);
1567 /* If we have auto-saved and there is still no input
1568 available, garbage collect if there has been enough
1569 consing going on to make it worthwhile. */
1570 if (!detect_input_pending ()
1571 && consing_since_gc
> gc_cons_threshold
/ 2)
1573 Fgarbage_collect ();
1574 /* prepare_menu_bars isn't safe here, but it should
1575 also be unnecessary. */
1582 /* Actually read a character, waiting if necessary. */
1585 c
= kbd_buffer_get_event ();
1588 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1592 /* Terminate Emacs in batch mode if at eof. */
1593 if (noninteractive
&& XTYPE (c
) == Lisp_Int
&& XINT (c
) < 0)
1594 Fkill_emacs (make_number (1));
1596 if (XTYPE (c
) == Lisp_Int
)
1598 /* Add in any extra modifiers, where appropriate. */
1599 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1600 || ((extra_keyboard_modifiers
& 0177) < ' '
1601 && (extra_keyboard_modifiers
& 0177) != 0))
1602 XSETINT (c
, make_ctrl_char (XINT (c
)));
1604 /* Transfer any other modifier bits directly from
1605 extra_keyboard_modifiers to c. Ignore the actual character code
1606 in the low 16 bits of extra_keyboard_modifiers. */
1607 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
1612 restore_getcjmp (save_jump
);
1616 echo_area_glyphs
= 0;
1618 /* Handle things that only apply to characters. */
1619 if (XTYPE (c
) == Lisp_Int
)
1621 /* If kbd_buffer_get_event gave us an EOF, return that. */
1625 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
1626 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1627 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1631 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1632 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1633 recent_keys_index
= 0;
1635 /* Write c to the dribble file. If c is a lispy event, write
1636 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1637 If you, dear reader, have a better idea, you've got the source. :-) */
1640 if (XTYPE (c
) == Lisp_Int
)
1641 putc (XINT (c
), dribble
);
1644 Lisp_Object dribblee
;
1646 /* If it's a structured event, take the event header. */
1647 dribblee
= EVENT_HEAD (c
);
1649 if (XTYPE (dribblee
) == Lisp_Symbol
)
1651 putc ('<', dribble
);
1652 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1653 XSYMBOL (dribblee
)->name
->size
,
1655 putc ('>', dribble
);
1662 store_kbd_macro_char (c
);
1664 num_nonmacro_input_chars
++;
1669 /* Record this character as part of the current key.
1670 Don't record mouse motion; it should never matter. */
1671 if (! (EVENT_HAS_PARAMETERS (c
)
1672 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1675 add_command_key (c
);
1678 /* Re-reading in the middle of a command */
1680 last_input_char
= c
;
1683 /* Process the help character specially if enabled */
1684 if (EQ (c
, Vhelp_char
) && !NILP (Vhelp_form
))
1687 count
= specpdl_ptr
- specpdl
;
1689 record_unwind_protect (Fset_window_configuration
,
1690 Fcurrent_window_configuration (Qnil
));
1692 tem0
= Feval (Vhelp_form
);
1693 if (XTYPE (tem0
) == Lisp_String
)
1694 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1698 c
= read_char (0, 0, 0, Qnil
, 0);
1699 while (XTYPE (c
) == Lisp_Buffer
);
1700 /* Remove the help from the frame */
1701 unbind_to (count
, Qnil
);
1702 prepare_menu_bars ();
1704 if (EQ (c
, make_number (040)))
1708 c
= read_char (0, 0, 0, Qnil
, 0);
1709 while (XTYPE (c
) == Lisp_Buffer
);
1720 Fprinc (object
, Qnil
);
1724 /* Copy out or in the info on where C-g should throw to.
1725 This is used when running Lisp code from within get_char,
1726 in case get_char is called recursively.
1727 See read_process_output. */
1732 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1735 restore_getcjmp (temp
)
1738 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1742 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1743 of this function. */
1745 tracking_off (old_value
)
1746 Lisp_Object old_value
;
1748 if (! XFASTINT (old_value
))
1750 do_mouse_tracking
= 0;
1752 /* Redisplay may have been preempted because there was input
1753 available, and it assumes it will be called again after the
1754 input has been processed. If the only input available was
1755 the sort that we have just disabled, then we need to call
1757 if (!readable_events ())
1759 prepare_menu_bars ();
1760 redisplay_preserve_echo_area ();
1761 get_input_pending (&input_pending
);
1766 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1767 "Evaluate BODY with mouse movement events enabled.\n\
1768 Within a `track-mouse' form, mouse motion generates input events that\n\
1769 you can read with `read-event'.\n\
1770 Normally, mouse motion is ignored.")
1774 int count
= specpdl_ptr
- specpdl
;
1777 XSET (val
, Lisp_Int
, do_mouse_tracking
);
1778 record_unwind_protect (tracking_off
, val
);
1780 do_mouse_tracking
= 1;
1782 val
= Fprogn (args
);
1783 return unbind_to (count
, val
);
1786 /* Low level keyboard/mouse input.
1787 kbd_buffer_store_event places events in kbd_buffer, and
1788 kbd_buffer_get_event retrieves them.
1789 mouse_moved indicates when the mouse has moved again, and
1790 *mouse_position_hook provides the mouse position. */
1792 /* Return true iff there are any events in the queue that read-char
1793 would return. If this returns false, a read-char would block. */
1797 return ! EVENT_QUEUES_EMPTY
;
1800 /* Set this for debugging, to have a way to get out */
1803 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
1806 kbd_buffer_store_event (event
)
1807 register struct input_event
*event
;
1809 if (event
->kind
== no_event
)
1812 if (event
->kind
== ascii_keystroke
)
1814 register int c
= event
->code
& 0377;
1816 if (event
->modifiers
& ctrl_modifier
)
1817 c
= make_ctrl_char (c
);
1819 c
|= (event
->modifiers
1820 & (meta_modifier
| alt_modifier
1821 | hyper_modifier
| super_modifier
));
1825 extern SIGTYPE
interrupt_signal ();
1828 /* If this results in a quit_char being returned to Emacs as
1829 input, set Vlast_event_frame properly. If this doesn't
1830 get returned to Emacs as an event, the next event read
1831 will set Vlast_event_frame again, so this is safe to do. */
1835 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
1837 internal_last_event_frame
= event
->frame_or_window
;
1839 internal_last_event_frame
= focus
;
1840 Vlast_event_frame
= internal_last_event_frame
;
1844 last_event_timestamp
= event
->timestamp
;
1845 interrupt_signal ();
1849 if (c
&& c
== stop_character
)
1856 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
1857 kbd_store_ptr
= kbd_buffer
;
1859 /* Don't let the very last slot in the buffer become full,
1860 since that would make the two pointers equal,
1861 and that is indistinguishable from an empty buffer.
1862 Discard the event if it would fill the last slot. */
1863 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
1865 kbd_store_ptr
->kind
= event
->kind
;
1866 if (event
->kind
== selection_request_event
)
1868 /* We must not use the ordinary copying code for this case,
1869 since `part' is an enum and copying it might not copy enough
1871 bcopy (event
, kbd_store_ptr
, sizeof (*event
));
1875 kbd_store_ptr
->code
= event
->code
;
1876 kbd_store_ptr
->part
= event
->part
;
1877 kbd_store_ptr
->frame_or_window
= event
->frame_or_window
;
1878 kbd_store_ptr
->modifiers
= event
->modifiers
;
1879 kbd_store_ptr
->x
= event
->x
;
1880 kbd_store_ptr
->y
= event
->y
;
1881 kbd_store_ptr
->timestamp
= event
->timestamp
;
1883 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
1885 = event
->frame_or_window
);
1891 /* Read one event from the event buffer, waiting if necessary.
1892 The value is a Lisp object representing the event.
1893 The value is nil for an event that should be ignored,
1894 or that was handled here.
1895 We always read and discard one event. */
1898 kbd_buffer_get_event ()
1906 XSET (obj
, Lisp_Int
, c
);
1910 /* Wait until there is input available. */
1913 if (!EVENT_QUEUES_EMPTY
)
1916 /* If the quit flag is set, then read_char will return
1917 quit_char, so that counts as "available input." */
1918 if (!NILP (Vquit_flag
))
1919 quit_throw_to_read_char ();
1921 /* One way or another, wait until input is available; then, if
1922 interrupt handlers have not read it, read it now. */
1925 wait_for_kbd_input ();
1927 /* Note SIGIO has been undef'd if FIONREAD is missing. */
1931 if (EVENT_QUEUES_EMPTY
)
1933 Lisp_Object minus_one
;
1935 XSET (minus_one
, Lisp_Int
, -1);
1936 wait_reading_process_input (0, 0, minus_one
, 1);
1938 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
1939 /* Pass 1 for EXPECT since we just waited to have input. */
1940 read_avail_input (1);
1942 #endif /* not VMS */
1945 /* At this point, we know that there is a readable event available
1946 somewhere. If the event queue is empty, then there must be a
1947 mouse movement enabled and available. */
1948 if (kbd_fetch_ptr
!= kbd_store_ptr
)
1950 struct input_event
*event
;
1952 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
1956 last_event_timestamp
= event
->timestamp
;
1960 /* These two kinds of events get special handling
1961 and don't actually appear to the command loop.
1962 We return nil for them. */
1963 if (event
->kind
== selection_request_event
)
1966 x_handle_selection_request (event
);
1967 kbd_fetch_ptr
= event
+ 1;
1969 /* We're getting selection request events, but we don't have
1975 else if (event
->kind
== selection_clear_event
)
1978 x_handle_selection_clear (event
);
1979 kbd_fetch_ptr
= event
+ 1;
1981 /* We're getting selection request events, but we don't have
1987 else if (event
->kind
== delete_window_event
)
1989 Lisp_Object tail
, frame
;
1992 /* If the user destroys the only frame, Emacs should exit.
1993 Count visible frames and iconified frames. */
1994 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
1996 frame
= XCONS (tail
)->car
;
1997 if (XTYPE (frame
) != Lisp_Frame
|| EQ (frame
, event
->frame_or_window
))
2000 if (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
))
2007 Fdelete_frame (event
->frame_or_window
, Qt
);
2008 kbd_fetch_ptr
= event
+ 1;
2011 else if (event
->kind
== menu_bar_event
)
2013 /* The event value is in the frame_or_window slot. */
2014 obj
= event
->frame_or_window
;
2015 kbd_fetch_ptr
= event
+ 1;
2017 else if (event
->kind
== buffer_switch_event
)
2019 /* The value doesn't matter here; only the type is tested. */
2020 XSET (obj
, Lisp_Buffer
, current_buffer
);
2021 kbd_fetch_ptr
= event
+ 1;
2023 /* Just discard these, by returning nil.
2024 (They shouldn't be found in the buffer,
2025 but on some machines it appears they do show up.) */
2026 else if (event
->kind
== no_event
)
2027 kbd_fetch_ptr
= event
+ 1;
2029 /* If this event is on a different frame, return a switch-frame this
2030 time, and leave the event in the queue for next time. */
2037 frame
= event
->frame_or_window
;
2038 if (XTYPE (frame
) == Lisp_Window
)
2039 frame
= WINDOW_FRAME (XWINDOW (frame
));
2041 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2045 if (! EQ (frame
, internal_last_event_frame
)
2046 && XFRAME (frame
) != selected_frame
)
2047 obj
= make_lispy_switch_frame (frame
);
2048 internal_last_event_frame
= frame
;
2049 #endif /* MULTI_FRAME */
2051 /* If we didn't decide to make a switch-frame event, go ahead
2052 and build a real event from the queue entry. */
2056 obj
= make_lispy_event (event
);
2058 /* Wipe out this event, to catch bugs. */
2059 event
->kind
= no_event
;
2060 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
2063 kbd_fetch_ptr
= event
+ 1;
2067 /* Try generating a mouse motion event. */
2068 else if (do_mouse_tracking
&& mouse_moved
)
2071 Lisp_Object bar_window
;
2072 enum scroll_bar_part part
;
2076 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
2081 /* Decide if we should generate a switch-frame event. Don't
2082 generate switch-frame events for motion outside of all Emacs
2088 frame
= FRAME_FOCUS_FRAME (f
);
2090 XSET (frame
, Lisp_Frame
, f
);
2092 if (! EQ (frame
, internal_last_event_frame
)
2093 && XFRAME (frame
) != selected_frame
)
2094 obj
= make_lispy_switch_frame (frame
);
2095 internal_last_event_frame
= frame
;
2098 /* If we didn't decide to make a switch-frame event, go ahead and
2099 return a mouse-motion event. */
2101 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2105 /* We were promised by the above while loop that there was
2106 something for us to read! */
2109 input_pending
= readable_events ();
2112 Vlast_event_frame
= internal_last_event_frame
;
2118 /* Process any events that are not user-visible,
2119 then return, without reading any user-visible events. */
2124 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2126 struct input_event
*event
;
2128 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2132 last_event_timestamp
= event
->timestamp
;
2134 /* These two kinds of events get special handling
2135 and don't actually appear to the command loop. */
2136 if (event
->kind
== selection_request_event
)
2139 x_handle_selection_request (event
);
2140 kbd_fetch_ptr
= event
+ 1;
2142 /* We're getting selection request events, but we don't have
2148 else if (event
->kind
== selection_clear_event
)
2151 x_handle_selection_clear (event
);
2152 kbd_fetch_ptr
= event
+ 1;
2154 /* We're getting selection request events, but we don't have
2163 get_input_pending (&input_pending
);
2166 /* Caches for modify_event_symbol. */
2167 static Lisp_Object accent_key_syms
;
2168 static Lisp_Object system_key_syms
;
2169 static Lisp_Object func_key_syms
;
2170 static Lisp_Object mouse_syms
;
2172 Lisp_Object Vsystem_key_alist
;
2174 /* This is a list of keysym codes for special "accent" characters.
2175 It parallels lispy_accent_keys. */
2177 static int lispy_accent_codes
[] =
2179 #ifdef XK_dead_circumflex
2184 #ifdef XK_dead_grave
2189 #ifdef XK_dead_tilde
2194 #ifdef XK_dead_diaeresis
2199 #ifdef XK_dead_macron
2204 #ifdef XK_dead_degree
2209 #ifdef XK_dead_acute
2214 #ifdef XK_dead_cedilla
2219 #ifdef XK_dead_breve
2224 #ifdef XK_dead_ogonek
2229 #ifdef XK_dead_caron
2234 #ifdef XK_dead_doubleacute
2235 XK_dead_doubleacute
,
2239 #ifdef XK_dead_abovedot
2246 /* This is a list of Lisp names for special "accent" characters.
2247 It parallels lispy_accent_codes. */
2249 static char *lispy_accent_keys
[] =
2266 /* You'll notice that this table is arranged to be conveniently
2267 indexed by X Windows keysym values. */
2268 static char *lispy_function_keys
[] =
2270 /* X Keysym value */
2272 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2280 0, 0, 0, /* 0xff10 */
2282 0, 0, 0, 0, 0, 0, 0,
2285 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2286 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2287 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2289 "home", /* 0xff50 */ /* IsCursorKey */
2300 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2311 "break", /* 0xff6b */
2313 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2315 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2316 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2317 0, 0, 0, 0, 0, 0, 0, 0,
2318 "kp-tab", /* 0xff89 */
2320 "kp-enter", /* 0xff8d */
2322 "kp-f1", /* 0xff91 */
2327 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2328 "kp-multiply", /* 0xffaa */
2333 "kp-divide", /* 0xffaf */
2334 "kp-0", /* 0xffb0 */
2335 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2338 "kp-equal", /* 0xffbd */
2339 "f1", /* 0xffbe */ /* IsFunctionKey */
2341 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2342 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2343 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2344 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2345 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2346 0, 0, 0, 0, 0, 0, 0, 0,
2347 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2348 0, 0, 0, 0, 0, 0, 0, "delete"
2351 static char *lispy_mouse_names
[] =
2353 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2356 /* Scroll bar parts. */
2357 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2359 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2360 Lisp_Object
*scroll_bar_parts
[] = {
2361 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2365 /* A vector, indexed by button number, giving the down-going location
2366 of currently depressed buttons, both scroll bar and non-scroll bar.
2368 The elements have the form
2369 (BUTTON-NUMBER MODIFIER-MASK . REST)
2370 where REST is the cdr of a position as it would be reported in the event.
2372 The make_lispy_event function stores positions here to tell the
2373 difference between click and drag events, and to store the starting
2374 location to be included in drag events. */
2376 static Lisp_Object button_down_location
;
2378 /* Information about the most recent up-going button event: Which
2379 button, what location, and what time. */
2381 static int last_mouse_button
;
2382 static int last_mouse_x
;
2383 static int last_mouse_y
;
2384 static unsigned long button_down_time
;
2386 /* The maximum time between clicks to make a double-click,
2387 or Qnil to disable double-click detection,
2388 or Qt for no time limit. */
2389 Lisp_Object Vdouble_click_time
;
2391 /* The number of clicks in this multiple-click. */
2393 int double_click_count
;
2395 #ifdef USE_X_TOOLKIT
2396 extern Lisp_Object
map_event_to_object ();
2397 #endif /* USE_X_TOOLKIT */
2399 /* Given a struct input_event, build the lisp event which represents
2400 it. If EVENT is 0, build a mouse movement event from the mouse
2401 movement buffer, which should have a movement event in it.
2403 Note that events must be passed to this function in the order they
2404 are received; this function stores the location of button presses
2405 in order to build drag events when the button is released. */
2408 make_lispy_event (event
)
2409 struct input_event
*event
;
2413 #ifdef SWITCH_ENUM_BUG
2414 switch ((int) event
->kind
)
2416 switch (event
->kind
)
2419 /* A simple keystroke. */
2420 case ascii_keystroke
:
2422 int c
= event
->code
& 0377;
2423 /* Turn ASCII characters into control characters
2425 if (event
->modifiers
& ctrl_modifier
)
2426 c
= make_ctrl_char (c
);
2428 /* Add in the other modifier bits. We took care of ctrl_modifier
2429 just above, and the shift key was taken care of by the X code,
2430 and applied to control characters by make_ctrl_char. */
2431 c
|= (event
->modifiers
2432 & (meta_modifier
| alt_modifier
2433 | hyper_modifier
| super_modifier
));
2434 button_down_time
= 0;
2438 /* A function key. The symbol may need to have modifier prefixes
2440 case non_ascii_keystroke
:
2441 button_down_time
= 0;
2443 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
2444 if (event
->code
== lispy_accent_codes
[i
])
2445 return modify_event_symbol (i
,
2447 Qfunction_key
, Qnil
,
2448 lispy_accent_keys
, &accent_key_syms
,
2449 (sizeof (lispy_accent_keys
)
2450 / sizeof (lispy_accent_keys
[0])));
2452 /* Handle system-specific keysyms. */
2453 if (event
->code
& (1 << 28))
2455 /* We need to use an alist rather than a vector as the cache
2456 since we can't make a vector long enuf. */
2457 if (NILP (system_key_syms
))
2458 system_key_syms
= Fcons (Qnil
, Qnil
);
2459 return modify_event_symbol (event
->code
& 0xffffff,
2461 Qfunction_key
, Vsystem_key_alist
,
2462 0, &system_key_syms
, 0xffffff);
2465 return modify_event_symbol (event
->code
- 0xff00,
2467 Qfunction_key
, Qnil
,
2468 lispy_function_keys
, &func_key_syms
,
2469 (sizeof (lispy_function_keys
)
2470 / sizeof (lispy_function_keys
[0])));
2474 /* A mouse click. Figure out where it is, decide whether it's
2475 a press, click or drag, and build the appropriate structure. */
2477 case scroll_bar_click
:
2479 int button
= event
->code
;
2481 Lisp_Object position
;
2482 Lisp_Object
*start_pos_ptr
;
2483 Lisp_Object start_pos
;
2485 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2488 /* Build the position as appropriate for this mouse click. */
2489 if (event
->kind
== mouse_click
)
2492 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2497 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
2498 &column
, &row
, 0, 0);
2500 #ifdef USE_X_TOOLKIT
2501 if (FRAME_EXTERNAL_MENU_BAR (f
) && XINT (event
->y
) == -1)
2503 if (row
< FRAME_MENU_BAR_LINES (f
))
2506 Lisp_Object items
, item
;
2508 #ifdef USE_X_TOOLKIT
2509 /* The click happened in the menubar.
2510 Look for the menu item selected. */
2511 item
= map_event_to_object (event
, f
);
2513 XFASTINT (event
->y
) = 1;
2514 #else /* not USE_X_TOOLKIT */
2519 items
= FRAME_MENU_BAR_ITEMS (f
);
2520 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 3)
2522 Lisp_Object pos
, string
;
2523 string
= XVECTOR (items
)->contents
[i
+ 1];
2524 pos
= XVECTOR (items
)->contents
[i
+ 2];
2527 if (column
>= XINT (pos
)
2528 && column
< XINT (pos
) + XSTRING (string
)->size
)
2530 item
= XVECTOR (items
)->contents
[i
];
2534 #endif /* not USE_X_TOOLKIT */
2537 = Fcons (event
->frame_or_window
,
2539 Fcons (Fcons (event
->x
, event
->y
),
2540 Fcons (make_number (event
->timestamp
),
2543 return Fcons (item
, Fcons (position
, Qnil
));
2546 window
= window_from_coordinates (f
, column
, row
, &part
);
2548 if (XTYPE (window
) != Lisp_Window
)
2552 int pixcolumn
, pixrow
;
2553 column
-= XINT (XWINDOW (window
)->left
);
2554 row
-= XINT (XWINDOW (window
)->top
);
2555 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
2556 XSETINT (event
->x
, pixcolumn
);
2557 XSETINT (event
->y
, pixrow
);
2562 posn
= Qvertical_line
;
2564 XSET (posn
, Lisp_Int
,
2565 buffer_posn_from_coords (XWINDOW (window
),
2572 Fcons (Fcons (event
->x
, event
->y
),
2573 Fcons (make_number (event
->timestamp
),
2579 Lisp_Object portion_whole
;
2582 window
= event
->frame_or_window
;
2583 portion_whole
= Fcons (event
->x
, event
->y
);
2584 part
= *scroll_bar_parts
[(int) event
->part
];
2588 Fcons (Qvertical_scroll_bar
,
2589 Fcons (portion_whole
,
2590 Fcons (make_number (event
->timestamp
),
2591 Fcons (part
, Qnil
)))));
2594 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2596 start_pos
= *start_pos_ptr
;
2597 *start_pos_ptr
= Qnil
;
2599 is_double
= (button
== last_mouse_button
2600 && XINT (event
->x
) == last_mouse_x
2601 && XINT (event
->y
) == last_mouse_y
2602 && button_down_time
!= 0
2603 && (EQ (Vdouble_click_time
, Qt
)
2604 || (INTEGERP (Vdouble_click_time
)
2605 && ((int)(event
->timestamp
- button_down_time
)
2606 < XINT (Vdouble_click_time
)))));
2607 last_mouse_button
= button
;
2608 last_mouse_x
= XINT (event
->x
);
2609 last_mouse_y
= XINT (event
->y
);
2611 /* If this is a button press, squirrel away the location, so
2612 we can decide later whether it was a click or a drag. */
2613 if (event
->modifiers
& down_modifier
)
2617 double_click_count
++;
2618 event
->modifiers
|= ((double_click_count
> 2)
2623 double_click_count
= 1;
2624 button_down_time
= event
->timestamp
;
2625 *start_pos_ptr
= Fcopy_alist (position
);
2628 /* Now we're releasing a button - check the co-ordinates to
2629 see if this was a click or a drag. */
2630 else if (event
->modifiers
& up_modifier
)
2632 /* If we did not see a down before this up,
2633 ignore the up. Probably this happened because
2634 the down event chose a menu item.
2635 It would be an annoyance to treat the release
2636 of the button that chose the menu item
2637 as a separate event. */
2639 if (XTYPE (start_pos
) != Lisp_Cons
)
2642 event
->modifiers
&= ~up_modifier
;
2643 #if 0 /* Formerly we treated an up with no down as a click event. */
2644 if (XTYPE (start_pos
) != Lisp_Cons
)
2645 event
->modifiers
|= click_modifier
;
2649 /* The third element of every position should be the (x,y)
2653 down
= Fnth (make_number (2), start_pos
);
2654 if (EQ (event
->x
, XCONS (down
)->car
)
2655 && EQ (event
->y
, XCONS (down
)->cdr
))
2657 if (is_double
&& double_click_count
> 1)
2658 event
->modifiers
|= ((double_click_count
> 2)
2662 event
->modifiers
|= click_modifier
;
2666 button_down_time
= 0;
2667 event
->modifiers
|= drag_modifier
;
2672 /* Every mouse event should either have the down_modifier or
2673 the up_modifier set. */
2677 /* Get the symbol we should use for the mouse click. */
2680 head
= modify_event_symbol (button
,
2683 lispy_mouse_names
, &mouse_syms
,
2684 (sizeof (lispy_mouse_names
)
2685 / sizeof (lispy_mouse_names
[0])));
2686 if (event
->modifiers
& drag_modifier
)
2691 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2694 Fcons (make_number (double_click_count
),
2702 #endif /* MULTI_FRAME */
2704 /* The 'kind' field of the event is something we don't recognize. */
2713 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2715 Lisp_Object bar_window
;
2716 enum scroll_bar_part part
;
2720 /* Is it a scroll bar movement? */
2721 if (frame
&& ! NILP (bar_window
))
2723 Lisp_Object part_sym
;
2725 part_sym
= *scroll_bar_parts
[(int) part
];
2726 return Fcons (Qscroll_bar_movement
,
2727 (Fcons (Fcons (bar_window
,
2728 Fcons (Qvertical_scroll_bar
,
2729 Fcons (Fcons (x
, y
),
2730 Fcons (make_number (time
),
2736 /* Or is it an ordinary mouse movement? */
2744 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
, 0, 1);
2747 window
= window_from_coordinates (frame
, column
, row
, &area
);
2751 if (XTYPE (window
) == Lisp_Window
)
2753 int pixcolumn
, pixrow
;
2754 column
-= XINT (XWINDOW (window
)->left
);
2755 row
-= XINT (XWINDOW (window
)->top
);
2756 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
2757 XSETINT (x
, pixcolumn
);
2758 XSETINT (y
, pixrow
);
2763 posn
= Qvertical_line
;
2765 XSET (posn
, Lisp_Int
,
2766 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
2768 else if (frame
!= 0)
2770 XSET (window
, Lisp_Frame
, frame
);
2781 return Fcons (Qmouse_movement
,
2782 Fcons (Fcons (window
,
2784 Fcons (Fcons (x
, y
),
2785 Fcons (make_number (time
),
2791 #endif /* MULTI_FRAME */
2793 /* Construct a switch frame event. */
2795 make_lispy_switch_frame (frame
)
2798 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
2801 /* Manipulating modifiers. */
2803 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
2805 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2806 SYMBOL's name of the end of the modifiers; the string from this
2807 position is the unmodified symbol name.
2809 This doesn't use any caches. */
2811 parse_modifiers_uncached (symbol
, modifier_end
)
2815 struct Lisp_String
*name
;
2819 CHECK_SYMBOL (symbol
, 1);
2822 name
= XSYMBOL (symbol
)->name
;
2825 for (i
= 0; i
+2 <= name
->size
; )
2826 switch (name
->data
[i
])
2828 #define SINGLE_LETTER_MOD(bit) \
2829 if (name->data[i+1] != '-') \
2830 goto no_more_modifiers; \
2835 SINGLE_LETTER_MOD (alt_modifier
);
2839 SINGLE_LETTER_MOD (ctrl_modifier
);
2843 SINGLE_LETTER_MOD (hyper_modifier
);
2847 SINGLE_LETTER_MOD (meta_modifier
);
2851 SINGLE_LETTER_MOD (shift_modifier
);
2855 SINGLE_LETTER_MOD (super_modifier
);
2859 if (i
+ 5 > name
->size
)
2860 goto no_more_modifiers
;
2861 if (! strncmp (name
->data
+ i
, "drag-", 5))
2863 modifiers
|= drag_modifier
;
2866 else if (! strncmp (name
->data
+ i
, "down-", 5))
2868 modifiers
|= down_modifier
;
2871 else if (i
+ 7 <= name
->size
2872 && ! strncmp (name
->data
+ i
, "double-", 7))
2874 modifiers
|= double_modifier
;
2878 goto no_more_modifiers
;
2882 if (i
+ 7 > name
->size
)
2883 goto no_more_modifiers
;
2884 if (! strncmp (name
->data
+ i
, "triple-", 7))
2886 modifiers
|= triple_modifier
;
2890 goto no_more_modifiers
;
2894 goto no_more_modifiers
;
2896 #undef SINGLE_LETTER_MOD
2900 /* Should we include the `click' modifier? */
2901 if (! (modifiers
& (down_modifier
| drag_modifier
2902 | double_modifier
| triple_modifier
))
2903 && i
+ 7 == name
->size
2904 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
2905 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
2906 modifiers
|= click_modifier
;
2915 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
2916 prepended to the string BASE[0..BASE_LEN-1].
2917 This doesn't use any caches. */
2919 apply_modifiers_uncached (modifiers
, base
, base_len
)
2924 /* Since BASE could contain nulls, we can't use intern here; we have
2925 to use Fintern, which expects a genuine Lisp_String, and keeps a
2928 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
2934 /* Only the event queue may use the `up' modifier; it should always
2935 be turned into a click or drag event before presented to lisp code. */
2936 if (modifiers
& up_modifier
)
2939 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
2940 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
2941 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
2942 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
2943 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
2944 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
2945 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
2946 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
2947 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
2948 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
2949 /* The click modifier is denoted by the absence of other modifiers. */
2953 mod_len
= p
- new_mods
;
2957 Lisp_Object new_name
;
2959 new_name
= make_uninit_string (mod_len
+ base_len
);
2960 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
2961 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
2963 return Fintern (new_name
, Qnil
);
2968 static char *modifier_names
[] =
2970 "up", "down", "drag", "click", "double", "triple", 0, 0,
2971 0, 0, 0, 0, 0, 0, 0, 0,
2972 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
2974 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
2976 static Lisp_Object modifier_symbols
;
2978 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
2980 lispy_modifier_list (modifiers
)
2983 Lisp_Object modifier_list
;
2986 modifier_list
= Qnil
;
2987 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
2988 if (modifiers
& (1<<i
))
2989 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
2992 return modifier_list
;
2996 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
2997 where UNMODIFIED is the unmodified form of SYMBOL,
2998 MASK is the set of modifiers present in SYMBOL's name.
2999 This is similar to parse_modifiers_uncached, but uses the cache in
3000 SYMBOL's Qevent_symbol_element_mask property, and maintains the
3001 Qevent_symbol_elements property. */
3003 parse_modifiers (symbol
)
3006 Lisp_Object elements
;
3008 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
3009 if (CONSP (elements
))
3014 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
3015 Lisp_Object unmodified
;
3018 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
3019 XSYMBOL (symbol
)->name
->size
- end
),
3022 if (modifiers
& ~((1<<VALBITS
) - 1))
3024 XFASTINT (mask
) = modifiers
;
3025 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
3027 /* Cache the parsing results on SYMBOL. */
3028 Fput (symbol
, Qevent_symbol_element_mask
,
3030 Fput (symbol
, Qevent_symbol_elements
,
3031 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
3033 /* Since we know that SYMBOL is modifiers applied to unmodified,
3034 it would be nice to put that in unmodified's cache.
3035 But we can't, since we're not sure that parse_modifiers is
3042 /* Apply the modifiers MODIFIERS to the symbol BASE.
3043 BASE must be unmodified.
3045 This is like apply_modifiers_uncached, but uses BASE's
3046 Qmodifier_cache property, if present. It also builds
3047 Qevent_symbol_elements properties, since it has that info anyway.
3049 apply_modifiers copies the value of BASE's Qevent_kind property to
3050 the modified symbol. */
3052 apply_modifiers (modifiers
, base
)
3056 Lisp_Object cache
, index
, entry
, new_symbol
;
3058 /* Mask out upper bits. We don't know where this value's been. */
3059 modifiers
&= (1<<VALBITS
) - 1;
3061 /* The click modifier never figures into cache indices. */
3062 cache
= Fget (base
, Qmodifier_cache
);
3063 XFASTINT (index
) = (modifiers
& ~click_modifier
);
3064 entry
= Fassq (index
, cache
);
3067 new_symbol
= XCONS (entry
)->cdr
;
3070 /* We have to create the symbol ourselves. */
3071 new_symbol
= apply_modifiers_uncached (modifiers
,
3072 XSYMBOL (base
)->name
->data
,
3073 XSYMBOL (base
)->name
->size
);
3075 /* Add the new symbol to the base's cache. */
3076 entry
= Fcons (index
, new_symbol
);
3077 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
3079 /* We have the parsing info now for free, so add it to the caches. */
3080 XFASTINT (index
) = modifiers
;
3081 Fput (new_symbol
, Qevent_symbol_element_mask
,
3082 Fcons (base
, Fcons (index
, Qnil
)));
3083 Fput (new_symbol
, Qevent_symbol_elements
,
3084 Fcons (base
, lispy_modifier_list (modifiers
)));
3087 /* Make sure this symbol is of the same kind as BASE.
3089 You'd think we could just set this once and for all when we
3090 intern the symbol above, but reorder_modifiers may call us when
3091 BASE's property isn't set right; we can't assume that just
3092 because it has a Qmodifier_cache property it must have its
3093 Qevent_kind set right as well. */
3094 if (NILP (Fget (new_symbol
, Qevent_kind
)))
3098 kind
= Fget (base
, Qevent_kind
);
3100 Fput (new_symbol
, Qevent_kind
, kind
);
3107 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
3108 return a symbol with the modifiers placed in the canonical order.
3109 Canonical order is alphabetical, except for down and drag, which
3110 always come last. The 'click' modifier is never written out.
3112 Fdefine_key calls this to make sure that (for example) C-M-foo
3113 and M-C-foo end up being equivalent in the keymap. */
3116 reorder_modifiers (symbol
)
3119 /* It's hopefully okay to write the code this way, since everything
3120 will soon be in caches, and no consing will be done at all. */
3123 parsed
= parse_modifiers (symbol
);
3124 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
3125 XCONS (parsed
)->car
);
3129 /* For handling events, we often want to produce a symbol whose name
3130 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
3131 to some base, like the name of a function key or mouse button.
3132 modify_event_symbol produces symbols of this sort.
3134 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
3135 is the name of the i'th symbol. TABLE_SIZE is the number of elements
3138 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
3139 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
3141 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
3142 persist between calls to modify_event_symbol that it can use to
3143 store a cache of the symbols it's generated for this NAME_TABLE
3144 before. The object stored there may be a vector or an alist.
3146 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
3148 MODIFIERS is a set of modifier bits (as given in struct input_events)
3149 whose prefixes should be applied to the symbol name.
3151 SYMBOL_KIND is the value to be placed in the event_kind property of
3152 the returned symbol.
3154 The symbols we create are supposed to have an
3155 `event-symbol-elements' property, which lists the modifiers present
3156 in the symbol's name. */
3159 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
3160 name_table
, symbol_table
, table_size
)
3163 Lisp_Object symbol_kind
;
3164 Lisp_Object name_alist
;
3166 Lisp_Object
*symbol_table
;
3170 Lisp_Object symbol_int
;
3172 XSET (symbol_int
, Lisp_Int
, symbol_num
);
3174 /* Is this a request for a valid symbol? */
3175 if (symbol_num
< 0 || symbol_num
>= table_size
)
3178 if (CONSP (*symbol_table
))
3179 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
3181 /* If *symbol_table doesn't seem to be initialized properly, fix that.
3182 *symbol_table should be a lisp vector TABLE_SIZE elements long,
3183 where the Nth element is the symbol for NAME_TABLE[N], or nil if
3184 we've never used that symbol before. */
3187 if (! VECTORP (*symbol_table
)
3188 || XVECTOR (*symbol_table
)->size
!= table_size
)
3192 XFASTINT (size
) = table_size
;
3193 *symbol_table
= Fmake_vector (size
, Qnil
);
3196 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
3199 /* Have we already used this symbol before? */
3202 /* No; let's create it. */
3203 if (!NILP (name_alist
))
3204 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
3205 else if (name_table
[symbol_num
])
3206 value
= intern (name_table
[symbol_num
]);
3211 sprintf (buf
, "key-%d", symbol_num
);
3212 value
= intern (buf
);
3215 if (CONSP (*symbol_table
))
3216 *symbol_table
= Fcons (value
, *symbol_table
);
3218 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
3220 /* Fill in the cache entries for this symbol; this also
3221 builds the Qevent_symbol_elements property, which the user
3223 apply_modifiers (modifiers
& click_modifier
, value
);
3224 Fput (value
, Qevent_kind
, symbol_kind
);
3227 /* Apply modifiers to that symbol. */
3228 return apply_modifiers (modifiers
, value
);
3232 /* Store into *addr a value nonzero if terminal input chars are available.
3233 Serves the purpose of ioctl (0, FIONREAD, addr)
3234 but works even if FIONREAD does not exist.
3235 (In fact, this may actually read some input.) */
3238 get_input_pending (addr
)
3241 /* First of all, have we already counted some input? */
3242 *addr
= !NILP (Vquit_flag
) || readable_events ();
3244 /* If input is being read as it arrives, and we have none, there is none. */
3245 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
3248 /* Try to read some input and see how much we get. */
3250 *addr
= !NILP (Vquit_flag
) || readable_events ();
3253 /* Interface to read_avail_input, blocking SIGIO if necessary. */
3256 gobble_input (expected
)
3261 if (interrupt_input
)
3264 mask
= sigblockx (SIGIO
);
3265 read_avail_input (expected
);
3270 read_avail_input (expected
);
3274 record_asynch_buffer_change ()
3276 struct input_event event
;
3277 event
.kind
= buffer_switch_event
;
3278 event
.frame_or_window
= Qnil
;
3279 kbd_buffer_store_event (&event
);
3284 /* Read any terminal input already buffered up by the system
3285 into the kbd_buffer, but do not wait.
3287 EXPECTED should be nonzero if the caller knows there is some input.
3289 Except on VMS, all input is read by this function.
3290 If interrupt_input is nonzero, this function MUST be called
3291 only when SIGIO is blocked.
3293 Returns the number of keyboard chars read, or -1 meaning
3294 this is a bad time to try to read input. */
3297 read_avail_input (expected
)
3300 struct input_event buf
[KBD_BUFFER_SIZE
];
3304 if (read_socket_hook
)
3305 /* No need for FIONREAD or fcntl; just say don't wait. */
3306 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
3309 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
3310 the kbd_buffer can really hold. That may prevent loss
3311 of characters on some systems when input is stuffed at us. */
3312 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
3315 /* Determine how many characters we should *try* to read. */
3317 n_to_read
= dos_keysns ();
3320 #else /* not MSDOS */
3322 /* Find out how much input is available. */
3323 if (ioctl (0, FIONREAD
, &n_to_read
) < 0)
3324 /* Formerly simply reported no input, but that sometimes led to
3325 a failure of Emacs to terminate.
3326 SIGHUP seems appropriate if we can't reach the terminal. */
3327 /* ??? Is it really right to send the signal just to this process
3328 rather than to the whole process group?
3329 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3330 kill (getpid (), SIGHUP
);
3333 if (n_to_read
> sizeof cbuf
)
3334 n_to_read
= sizeof cbuf
;
3335 #else /* no FIONREAD */
3336 #if defined(USG) || defined(DGUX)
3337 /* Read some input if available, but don't wait. */
3338 n_to_read
= sizeof cbuf
;
3339 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
3344 #endif /* not MSDOS */
3346 /* Now read; for one reason or another, this will not block.
3347 NREAD is set to the number of chars read. */
3351 cbuf
[0] = dos_keyread();
3354 nread
= read (fileno (stdin
), cbuf
, n_to_read
);
3356 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
3357 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3358 This looks incorrect, but it isn't, because _BSD causes
3359 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3360 and that causes a value other than 0 when there is no input. */
3366 /* We used to retry the read if it was interrupted.
3367 But this does the wrong thing when O_NDELAY causes
3368 an EAGAIN error. Does anybody know of a situation
3369 where a retry is actually needed? */
3371 nread
< 0 && (errno
== EAGAIN
3385 #if defined (USG) || defined (DGUX)
3386 fcntl (fileno (stdin
), F_SETFL
, 0);
3387 #endif /* USG or DGUX */
3388 #endif /* no FIONREAD */
3389 for (i
= 0; i
< nread
; i
++)
3391 buf
[i
].kind
= ascii_keystroke
;
3392 buf
[i
].modifiers
= 0;
3393 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3394 buf
[i
].modifiers
= meta_modifier
;
3398 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
3400 XSET (buf
[i
].frame_or_window
, Lisp_Frame
, selected_frame
);
3402 buf
[i
].frame_or_window
= Qnil
;
3407 /* Scan the chars for C-g and store them in kbd_buffer. */
3408 for (i
= 0; i
< nread
; i
++)
3410 kbd_buffer_store_event (&buf
[i
]);
3411 /* Don't look at input that follows a C-g too closely.
3412 This reduces lossage due to autorepeat on C-g. */
3413 if (buf
[i
].kind
== ascii_keystroke
3414 && XINT(buf
[i
].code
) == quit_char
)
3420 #endif /* not VMS */
3422 #ifdef SIGIO /* for entire page */
3423 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3426 input_available_signal (signo
)
3429 /* Must preserve main program's value of errno. */
3430 int old_errno
= errno
;
3432 extern int select_alarmed
;
3436 /* USG systems forget handlers when they are used;
3437 must reestablish each time */
3438 signal (signo
, input_available_signal
);
3445 if (input_available_clear_time
)
3446 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3451 nread
= read_avail_input (1);
3452 /* -1 means it's not ok to read the input now.
3453 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3454 0 means there was no keyboard input available. */
3459 select_alarmed
= 1; /* Force the select emulator back to life */
3470 /* Send ourselves a SIGIO.
3472 This function exists so that the UNBLOCK_INPUT macro in
3473 blockinput.h can have some way to take care of input we put off
3474 dealing with, without assuming that every file which uses
3475 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3477 reinvoke_input_signal ()
3486 /* Return the prompt-string of a sparse keymap.
3487 This is the first element which is a string.
3488 Return nil if there is none. */
3496 register Lisp_Object tem
;
3498 if (XTYPE (tem
) == Lisp_String
)
3505 static void menu_bar_item ();
3506 static void menu_bar_one_keymap ();
3508 /* These variables hold the vector under construction within
3509 menu_bar_items and its subroutines, and the current index
3510 for storing into that vector. */
3511 static Lisp_Object menu_bar_items_vector
;
3512 static Lisp_Object menu_bar_items_index
;
3514 /* Return a vector of menu items for a menu bar, appropriate
3515 to the current buffer. Each item has three elements in the vector:
3518 OLD is an old vector we can optionally reuse, or nil. */
3521 menu_bar_items (old
)
3524 /* The number of keymaps we're scanning right now, and the number of
3525 keymaps we have allocated space for. */
3528 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3529 in the current keymaps, or nil where it is not a prefix. */
3532 Lisp_Object def
, tem
, tail
;
3541 struct gcpro gcpro1
;
3543 /* In order to build the menus, we need to call the keymap
3544 accessors. They all call QUIT. But this function is called
3545 during redisplay, during which a quit is fatal. So inhibit
3546 quitting while building the menus.
3547 We do this instead of specbind because (1) errors will clear it anyway
3548 and (2) this avoids risk of specpdl overflow. */
3549 oquit
= Vinhibit_quit
;
3553 menu_bar_items_vector
= old
;
3555 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
3556 menu_bar_items_index
= 0;
3558 GCPRO1 (menu_bar_items_vector
);
3560 /* Build our list of keymaps.
3561 If we recognize a function key and replace its escape sequence in
3562 keybuf with its symbol, or if the sequence starts with a mouse
3563 click and we need to switch buffers, we jump back here to rebuild
3564 the initial keymaps from the current buffer. */
3568 if (!NILP (Voverriding_local_map
))
3571 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3572 maps
[0] = Voverriding_local_map
;
3576 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3577 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3578 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3579 #ifdef USE_TEXT_PROPERTIES
3580 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3582 maps
[nmaps
-2] = current_buffer
->keymap
;
3585 maps
[nmaps
-1] = current_global_map
;
3588 /* Look up in each map the dummy prefix key `menu-bar'. */
3592 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3594 if (! NILP (maps
[mapno
]))
3595 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3599 tem
= Fkeymapp (def
);
3601 menu_bar_one_keymap (def
);
3604 /* Move to the end those items that should be at the end. */
3606 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3609 int end
= menu_bar_items_index
;
3611 for (i
= 0; i
< end
; i
+= 3)
3612 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3614 Lisp_Object tem0
, tem1
, tem2
;
3615 /* Move the item at index I to the end,
3616 shifting all the others forward. */
3617 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
3618 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
3619 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
3621 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
3622 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
3623 (end
- i
- 3) * sizeof (Lisp_Object
));
3624 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem0
;
3625 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem1
;
3626 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem2
;
3631 /* Add nil, nil, nil at the end. */
3632 i
= menu_bar_items_index
;
3633 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
3636 int newsize
= 2 * i
;
3637 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
3638 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
3639 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
3640 menu_bar_items_vector
= tem
;
3642 /* Add this item. */
3643 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3644 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3645 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3646 menu_bar_items_index
= i
;
3648 Vinhibit_quit
= oquit
;
3650 return menu_bar_items_vector
;
3653 /* Scan one map KEYMAP, accumulating any menu items it defines
3654 in menu_bar_items_vector. */
3657 menu_bar_one_keymap (keymap
)
3660 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3662 /* Loop over all keymap entries that have menu strings. */
3663 for (tail
= keymap
; XTYPE (tail
) == Lisp_Cons
; tail
= XCONS (tail
)->cdr
)
3665 item
= XCONS (tail
)->car
;
3666 if (XTYPE (item
) == Lisp_Cons
)
3668 key
= XCONS (item
)->car
;
3669 binding
= XCONS (item
)->cdr
;
3670 if (XTYPE (binding
) == Lisp_Cons
)
3672 item_string
= XCONS (binding
)->car
;
3673 if (XTYPE (item_string
) == Lisp_String
)
3674 menu_bar_item (key
, item_string
, Fcdr (binding
));
3676 else if (EQ (binding
, Qundefined
))
3677 menu_bar_item (key
, item_string
, binding
);
3679 else if (XTYPE (item
) == Lisp_Vector
)
3681 /* Loop over the char values represented in the vector. */
3682 int len
= XVECTOR (item
)->size
;
3684 for (c
= 0; c
< len
; c
++)
3686 Lisp_Object character
;
3687 XFASTINT (character
) = c
;
3688 binding
= XVECTOR (item
)->contents
[c
];
3689 if (XTYPE (binding
) == Lisp_Cons
)
3691 item_string
= XCONS (binding
)->car
;
3692 if (XTYPE (item_string
) == Lisp_String
)
3693 menu_bar_item (key
, item_string
, Fcdr (binding
));
3695 else if (EQ (binding
, Qundefined
))
3696 menu_bar_item (key
, item_string
, binding
);
3702 /* This is used as the handler when calling internal_condition_case_1. */
3705 menu_bar_item_1 (arg
)
3711 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
3712 If there's already an item for KEY, add this DEF to it. */
3715 menu_bar_item (key
, item_string
, def
)
3716 Lisp_Object key
, item_string
, def
;
3719 Lisp_Object enabled
;
3722 if (EQ (def
, Qundefined
))
3724 /* If a map has an explicit `undefined' as definition,
3725 discard any previously made menu bar item. */
3727 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
3728 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3730 if (menu_bar_items_index
> i
+ 3)
3731 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
3732 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
3733 (menu_bar_items_index
- i
- 3) * sizeof (Lisp_Object
));
3734 menu_bar_items_index
-= 3;
3739 /* See if this entry is enabled. */
3742 if (XTYPE (def
) == Lisp_Symbol
)
3744 /* No property, or nil, means enable.
3745 Otherwise, enable if value is not nil. */
3746 tem
= Fget (def
, Qmenu_enable
);
3748 /* (condition-case nil (eval tem)
3750 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
3754 /* Ignore this item if it's not enabled. */
3758 /* Find any existing item for this KEY. */
3759 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
3760 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3763 /* If we did not find this KEY, add it at the end. */
3764 if (i
== menu_bar_items_index
)
3766 /* If vector is too small, get a bigger one. */
3767 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
3770 int newsize
= 2 * i
;
3771 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
3772 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
3773 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
3774 menu_bar_items_vector
= tem
;
3776 /* Add this item. */
3777 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
3778 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
3779 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (def
, Qnil
);
3780 menu_bar_items_index
= i
;
3782 /* We did find an item for this KEY. Add DEF to its list of maps. */
3786 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
3787 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (def
, old
);
3791 /* Read a character using menus based on maps in the array MAPS.
3792 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
3793 Return t if we displayed a menu but the user rejected it.
3795 PREV_EVENT is the previous input event, or nil if we are reading
3796 the first event of a key sequence.
3798 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3799 if we used a mouse menu to read the input, or zero otherwise. If
3800 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
3802 The prompting is done based on the prompt-string of the map
3803 and the strings associated with various map elements.
3805 This can be done with X menus or with menus put in the minibuf.
3806 These are done in different ways, depending on how the input will be read.
3807 Menus using X are done after auto-saving in read-char, getting the input
3808 event from Fx_popup_menu; menus using the minibuf use read_char recursively
3809 and do auto-saving in the inner call of read_char. */
3812 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
3815 Lisp_Object prev_event
;
3816 int *used_mouse_menu
;
3819 register Lisp_Object name
;
3820 Lisp_Object rest
, vector
;
3822 if (used_mouse_menu
)
3823 *used_mouse_menu
= 0;
3825 /* Use local over global Menu maps */
3827 if (! menu_prompting
)
3830 /* Get the menu name from the first map that has one (a prompt string). */
3831 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3833 name
= map_prompt (maps
[mapno
]);
3838 /* If we don't have any menus, just read a character normally. */
3842 #ifdef HAVE_X_WINDOWS
3844 /* If we got to this point via a mouse click,
3845 use a real menu for mouse selection. */
3846 if (EVENT_HAS_PARAMETERS (prev_event
))
3848 /* Display the menu and get the selection. */
3849 Lisp_Object
*realmaps
3850 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
3854 /* Use the maps that are not nil. */
3855 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3856 if (!NILP (maps
[mapno
]))
3857 realmaps
[nmaps1
++] = maps
[mapno
];
3859 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
3862 /* If we got more than one event, put all but the first
3863 onto this list to be read later.
3864 Return just the first event now. */
3865 unread_command_events
3866 = nconc2 (XCONS (value
)->cdr
, unread_command_events
);
3867 value
= XCONS (value
)->car
;
3869 else if (NILP (value
))
3871 if (used_mouse_menu
)
3872 *used_mouse_menu
= 1;
3875 #endif /* HAVE_X_MENU */
3876 #endif /* HAVE_X_WINDOWS */
3881 read_char_minibuf_menu_prompt(commandflag
, nmaps
, maps
)
3887 register Lisp_Object name
;
3889 int width
= FRAME_WIDTH (selected_frame
) - 4;
3890 char *menu
= (char *) alloca (width
+ 4);
3893 Lisp_Object rest
, vector
;
3895 if (! menu_prompting
)
3898 /* Get the menu name from the first map that has one (a prompt string). */
3899 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3901 name
= map_prompt (maps
[mapno
]);
3906 /* If we don't have any menus, just read a character normally. */
3910 /* Prompt string always starts with map's prompt, and a space. */
3911 strcpy (menu
, XSTRING (name
)->data
);
3912 nlength
= XSTRING (name
)->size
;
3913 menu
[nlength
++] = ':';
3914 menu
[nlength
++] = ' ';
3917 /* Start prompting at start of first map. */
3921 /* Present the documented bindings, a line at a time. */
3928 int orig_defn_macro
;
3930 /* Loop over elements of map. */
3935 /* If reached end of map, start at beginning of next map. */
3939 /* At end of last map, wrap around to first map if just starting,
3940 or end this line if already have something on it. */
3944 if (notfirst
|| nobindings
) break;
3949 /* Look at the next element of the map. */
3951 elt
= XVECTOR (vector
)->contents
[idx
];
3953 elt
= Fcar_safe (rest
);
3955 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
3957 /* If we found a dense table in the keymap,
3958 advanced past it, but start scanning its contents. */
3959 rest
= Fcdr_safe (rest
);
3965 /* An ordinary element. */
3967 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
3969 s
= Fcar_safe(elt
); /* vector */
3970 if (XTYPE (s
) != Lisp_String
)
3971 /* Ignore the element if it has no prompt string. */
3973 /* If we have room for the prompt string, add it to this line.
3974 If this is the first on the line, always add it. */
3975 else if (XSTRING (s
)->size
+ i
+ 2 < width
3980 /* Punctuate between strings. */
3983 strcpy (menu
+ i
, ", ");
3989 /* Add as much of string as fits. */
3990 thiswidth
= XSTRING (s
)->size
;
3991 if (thiswidth
+ i
> width
)
3992 thiswidth
= width
- i
;
3993 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
3999 /* If this element does not fit, end the line now,
4000 and save the element for the next line. */
4001 strcpy (menu
+ i
, "...");
4005 /* Move past this element. */
4006 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
4007 /* Handle reaching end of dense table. */
4012 rest
= Fcdr_safe (rest
);
4016 /* Prompt with that and read response. */
4019 /* Make believe its not a keyboard macro in case the help char
4020 is pressed. Help characters are not recorded because menu prompting
4021 is not used on replay.
4023 orig_defn_macro
= defining_kbd_macro
;
4024 defining_kbd_macro
= 0 ;
4026 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
4027 while (XTYPE (obj
) == Lisp_Buffer
);
4028 defining_kbd_macro
= orig_defn_macro
;
4030 if (XTYPE (obj
) != Lisp_Int
)
4035 if (! EQ (obj
, menu_prompt_more_char
)
4036 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
4037 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
4039 if ( defining_kbd_macro
)
4040 store_kbd_macro_char(obj
) ;
4043 /* Help char - go round again */
4047 /* Reading key sequences. */
4049 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
4050 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
4051 keymap, or nil otherwise. Return the index of the first keymap in
4052 which KEY has any binding, or NMAPS if no map has a binding.
4054 If KEY is a meta ASCII character, treat it like meta-prefix-char
4055 followed by the corresponding non-meta character. Keymaps in
4056 CURRENT with non-prefix bindings for meta-prefix-char become nil in
4059 When KEY is not defined in any of the keymaps, if it is an upper
4060 case letter and there are bindings for the corresponding lower-case
4061 letter, return the bindings for the lower-case letter.
4062 We store 1 in *CASE_CONVERTED in this case.
4063 Otherwise, we don't change *CASE_CONVERTED.
4065 If KEY has no bindings in any of the CURRENT maps, NEXT is left
4068 NEXT may == CURRENT. */
4071 follow_key (key
, nmaps
, current
, defs
, next
, case_converted
)
4073 Lisp_Object
*current
, *defs
, *next
;
4075 int *case_converted
;
4077 int i
, first_binding
;
4079 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
4080 followed by the corresponding non-meta character. */
4081 if (XTYPE (key
) == Lisp_Int
&& (XINT (key
) & CHAR_META
))
4083 for (i
= 0; i
< nmaps
; i
++)
4084 if (! NILP (current
[i
]))
4087 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
4089 /* Note that since we pass the resulting bindings through
4090 get_keymap_1, non-prefix bindings for meta-prefix-char
4092 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
4098 XSET (key
, Lisp_Int
, XFASTINT (key
) & ~CHAR_META
);
4101 first_binding
= nmaps
;
4102 for (i
= nmaps
- 1; i
>= 0; i
--)
4104 if (! NILP (current
[i
]))
4106 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
4107 if (! NILP (defs
[i
]))
4114 /* When KEY is not defined in any of the keymaps, if it is an upper
4115 case letter and there are bindings for the corresponding
4116 lower-case letter, return the bindings for the lower-case letter. */
4117 if (first_binding
== nmaps
4118 && XTYPE (key
) == Lisp_Int
4119 && ((((XINT (key
) & 0x3ffff)
4120 < XSTRING (current_buffer
->downcase_table
)->size
)
4121 && UPPERCASEP (XINT (key
) & 0x3ffff))
4122 || (XINT (key
) & shift_modifier
)))
4124 if (XINT (key
) & shift_modifier
)
4125 XSETINT (key
, XINT (key
) & ~shift_modifier
);
4127 XSETINT (key
, (DOWNCASE (XINT (key
) & 0x3ffff)
4128 | (XINT (key
) & ~0x3ffff)));
4130 first_binding
= nmaps
;
4131 for (i
= nmaps
- 1; i
>= 0; i
--)
4133 if (! NILP (current
[i
]))
4135 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
4136 if (! NILP (defs
[i
]))
4142 if (first_binding
!= nmaps
)
4143 *case_converted
= 1;
4146 /* Given the set of bindings we've found, produce the next set of maps. */
4147 if (first_binding
< nmaps
)
4148 for (i
= 0; i
< nmaps
; i
++)
4149 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
4151 return first_binding
;
4154 /* Read a sequence of keys that ends with a non prefix character,
4155 storing it in KEYBUF, a buffer of size BUFSIZE.
4157 Return the length of the key sequence stored.
4158 Return -1 if the user rejected a command menu.
4160 Echo starting immediately unless `prompt' is 0.
4162 Where a key sequence ends depends on the currently active keymaps.
4163 These include any minor mode keymaps active in the current buffer,
4164 the current buffer's local map, and the global map.
4166 If a key sequence has no other bindings, we check Vfunction_key_map
4167 to see if some trailing subsequence might be the beginning of a
4168 function key's sequence. If so, we try to read the whole function
4169 key, and substitute its symbolic name into the key sequence.
4171 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
4172 `double-' events into similar click events, if that would make them
4173 bound. We try to turn `triple-' events first into `double-' events,
4176 If we get a mouse click in a mode line, vertical divider, or other
4177 non-text area, we treat the click as if it were prefixed by the
4178 symbol denoting that area - `mode-line', `vertical-line', or
4181 If the sequence starts with a mouse click, we read the key sequence
4182 with respect to the buffer clicked on, not the current buffer.
4184 If the user switches frames in the midst of a key sequence, we put
4185 off the switch-frame event until later; the next call to
4186 read_char will return it. */
4189 read_key_sequence (keybuf
, bufsize
, prompt
)
4190 Lisp_Object
*keybuf
;
4194 int count
= specpdl_ptr
- specpdl
;
4196 /* How many keys there are in the current key sequence. */
4199 /* The length of the echo buffer when we started reading, and
4200 the length of this_command_keys when we started reading. */
4204 /* The number of keymaps we're scanning right now, and the number of
4205 keymaps we have allocated space for. */
4207 int nmaps_allocated
= 0;
4209 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
4210 the current keymaps. */
4213 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
4214 in the current keymaps, or nil where it is not a prefix. */
4215 Lisp_Object
*submaps
;
4217 /* The index in defs[] of the first keymap that has a binding for
4218 this key sequence. In other words, the lowest i such that
4219 defs[i] is non-nil. */
4222 /* If t < mock_input, then KEYBUF[t] should be read as the next
4225 We use this to recover after recognizing a function key. Once we
4226 realize that a suffix of the current key sequence is actually a
4227 function key's escape sequence, we replace the suffix with the
4228 function key's binding from Vfunction_key_map. Now keybuf
4229 contains a new and different key sequence, so the echo area,
4230 this_command_keys, and the submaps and defs arrays are wrong. In
4231 this situation, we set mock_input to t, set t to 0, and jump to
4232 restart_sequence; the loop will read keys from keybuf up until
4233 mock_input, thus rebuilding the state; and then it will resume
4234 reading characters from the keyboard. */
4237 /* If the sequence is unbound in submaps[], then
4238 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
4239 and fkey_map is its binding.
4241 These might be > t, indicating that all function key scanning
4242 should hold off until t reaches them. We do this when we've just
4243 recognized a function key, to avoid searching for the function
4244 key's again in Vfunction_key_map. */
4245 int fkey_start
= 0, fkey_end
= 0;
4246 Lisp_Object fkey_map
;
4248 /* Likewise, for key_translation_map. */
4249 int keytran_start
= 0, keytran_end
= 0;
4250 Lisp_Object keytran_map
;
4252 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
4253 we put it off for later. While we're reading, we keep the event here. */
4254 Lisp_Object delayed_switch_frame
;
4256 /* See the comment below... */
4257 #if defined (GOBBLE_FIRST_EVENT)
4258 Lisp_Object first_event
;
4261 struct buffer
*starting_buffer
;
4263 /* Nonzero if we found the binding for one of the chars
4264 in this key sequence by downcasing it. */
4265 int case_converted
= 0;
4267 /* Nonzero if we seem to have got the beginning of a binding
4268 in function_key_map. */
4269 int function_key_possible
= 0;
4273 last_nonmenu_event
= Qnil
;
4275 delayed_switch_frame
= Qnil
;
4276 fkey_map
= Vfunction_key_map
;
4277 keytran_map
= Vkey_translation_map
;
4279 /* If there is no function-key-map, turn off function key scanning. */
4280 if (NILP (Fkeymapp (Vfunction_key_map
)))
4281 fkey_start
= fkey_end
= bufsize
+ 1;
4283 /* If there is no key-translation-map, turn off scanning. */
4284 if (NILP (Fkeymapp (Vkey_translation_map
)))
4285 keytran_start
= keytran_end
= bufsize
+ 1;
4290 echo_prompt (XSTRING (prompt
)->data
);
4291 else if (cursor_in_echo_area
)
4292 /* This doesn't put in a dash if the echo buffer is empty, so
4293 you don't always see a dash hanging out in the minibuffer. */
4297 /* Record the initial state of the echo area and this_command_keys;
4298 we will need to restore them if we replay a key sequence. */
4300 echo_start
= echo_length ();
4301 keys_start
= this_command_key_count
;
4303 #if defined (GOBBLE_FIRST_EVENT)
4304 /* This doesn't quite work, because some of the things that read_char
4305 does cannot safely be bypassed. It seems too risky to try to make
4308 /* Read the first char of the sequence specially, before setting
4309 up any keymaps, in case a filter runs and switches buffers on us. */
4310 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
4312 #endif /* GOBBLE_FIRST_EVENT */
4314 /* We jump here when the key sequence has been thoroughly changed, and
4315 we need to rescan it starting from the beginning. When we jump here,
4316 keybuf[0..mock_input] holds the sequence we should reread. */
4319 starting_buffer
= current_buffer
;
4321 function_key_possible
= 0;
4323 /* Build our list of keymaps.
4324 If we recognize a function key and replace its escape sequence in
4325 keybuf with its symbol, or if the sequence starts with a mouse
4326 click and we need to switch buffers, we jump back here to rebuild
4327 the initial keymaps from the current buffer. */
4331 if (!NILP (Voverriding_local_map
))
4334 if (nmaps
> nmaps_allocated
)
4336 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4337 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4338 nmaps_allocated
= nmaps
;
4340 submaps
[0] = Voverriding_local_map
;
4344 nmaps
= current_minor_maps (0, &maps
) + 2;
4345 if (nmaps
> nmaps_allocated
)
4347 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4348 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4349 nmaps_allocated
= nmaps
;
4351 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
4352 #ifdef USE_TEXT_PROPERTIES
4353 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
4355 submaps
[nmaps
-2] = current_buffer
->keymap
;
4358 submaps
[nmaps
-1] = current_global_map
;
4361 /* Find an accurate initial value for first_binding. */
4362 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
4363 if (! NILP (submaps
[first_binding
]))
4366 /* Start from the beginning in keybuf. */
4369 /* These are no-ops the first time through, but if we restart, they
4370 revert the echo area and this_command_keys to their original state. */
4371 this_command_key_count
= keys_start
;
4372 if (INTERACTIVE
&& t
< mock_input
)
4373 echo_truncate (echo_start
);
4375 /* If the best binding for the current key sequence is a keymap, or
4376 we may be looking at a function key's escape sequence, keep on
4378 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
4379 || (first_binding
>= nmaps
4381 /* mock input is never part of a function key's sequence. */
4382 && mock_input
<= fkey_start
)
4383 || (first_binding
>= nmaps
4384 && keytran_start
< t
4385 /* mock input is never part of a function key's sequence. */
4386 && mock_input
<= keytran_start
)
4387 /* Don't return in the middle of a possible function key sequence,
4388 if the only bindings we found were via case conversion.
4389 Thus, if ESC O a has a function-key-map translation
4390 and ESC o has a binding, don't return after ESC O,
4391 so that we can translate ESC O plus the next character. */
4392 || (function_key_possible
&& case_converted
))
4395 int used_mouse_menu
= 0;
4397 /* Where the last real key started. If we need to throw away a
4398 key that has expanded into more than one element of keybuf
4399 (say, a mouse click on the mode line which is being treated
4400 as [mode-line (mouse-...)], then we backtrack to this point
4402 int last_real_key_start
;
4404 /* These variables are analogous to echo_start and keys_start;
4405 while those allow us to restart the entire key sequence,
4406 echo_local_start and keys_local_start allow us to throw away
4408 int echo_local_start
, keys_local_start
, local_first_binding
;
4411 error ("key sequence too long");
4414 echo_local_start
= echo_length ();
4415 keys_local_start
= this_command_key_count
;
4416 local_first_binding
= first_binding
;
4419 /* These are no-ops, unless we throw away a keystroke below and
4420 jumped back up to replay_key; in that case, these restore the
4421 variables to their original state, allowing us to replay the
4423 if (INTERACTIVE
&& t
< mock_input
)
4424 echo_truncate (echo_local_start
);
4425 this_command_key_count
= keys_local_start
;
4426 first_binding
= local_first_binding
;
4428 /* By default, assume each event is "real". */
4429 last_real_key_start
= t
;
4431 /* Does mock_input indicate that we are re-reading a key sequence? */
4435 add_command_key (key
);
4439 /* If not, we should actually read a character. */
4442 struct buffer
*buf
= current_buffer
;
4444 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
4447 /* read_char returns t when it shows a menu and the user rejects it.
4452 /* read_char returns -1 at the end of a macro.
4453 Emacs 18 handles this by returning immediately with a
4454 zero, so that's what we'll do. */
4455 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) == -1)
4461 /* If the current buffer has been changed from under us, the
4462 keymap may have changed, so replay the sequence. */
4463 if (XTYPE (key
) == Lisp_Buffer
)
4466 goto replay_sequence
;
4469 /* If we have a quit that was typed in another frame, and
4470 quit_throw_to_read_char switched buffers,
4471 replay to get the right keymap. */
4472 if (EQ (key
, quit_char
) && current_buffer
!= starting_buffer
)
4477 goto replay_sequence
;
4483 /* Clicks in non-text areas get prefixed by the symbol
4484 in their CHAR-ADDRESS field. For example, a click on
4485 the mode line is prefixed by the symbol `mode-line'.
4487 Furthermore, key sequences beginning with mouse clicks
4488 are read using the keymaps of the buffer clicked on, not
4489 the current buffer. So we may have to switch the buffer
4492 When we turn one event into two events, we must make sure
4493 that neither of the two looks like the original--so that,
4494 if we replay the events, they won't be expanded again.
4495 If not for this, such reexpansion could happen either here
4496 or when user programs play with this-command-keys. */
4497 if (EVENT_HAS_PARAMETERS (key
))
4501 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
4502 if (EQ (kind
, Qmouse_click
))
4504 Lisp_Object window
, posn
;
4506 window
= POSN_WINDOW (EVENT_START (key
));
4507 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4508 if (XTYPE (posn
) == Lisp_Cons
)
4510 /* We're looking at the second event of a
4511 sequence which we expanded before. Set
4512 last_real_key_start appropriately. */
4514 last_real_key_start
= t
- 1;
4517 /* Key sequences beginning with mouse clicks are
4518 read using the keymaps in the buffer clicked on,
4519 not the current buffer. If we're at the
4520 beginning of a key sequence, switch buffers. */
4521 if (last_real_key_start
== 0
4522 && XTYPE (window
) == Lisp_Window
4523 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
4524 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
4529 /* Arrange to go back to the original buffer once we're
4530 done reading the key sequence. Note that we can't
4531 use save_excursion_{save,restore} here, because they
4532 save point as well as the current buffer; we don't
4533 want to save point, because redisplay may change it,
4534 to accommodate a Fset_window_start or something. We
4535 don't want to do this at the top of the function,
4536 because we may get input from a subprocess which
4537 wants to change the selected window and stuff (say,
4539 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
4541 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
4542 goto replay_sequence
;
4544 else if (XTYPE (posn
) == Lisp_Symbol
)
4546 /* Expand mode-line and scroll-bar events into two events:
4547 use posn as a fake prefix key. */
4549 if (t
+ 1 >= bufsize
)
4550 error ("key sequence too long");
4555 /* Zap the position in key, so we know that we've
4556 expanded it, and don't try to do so again. */
4557 POSN_BUFFER_POSN (EVENT_START (key
))
4558 = Fcons (posn
, Qnil
);
4562 else if (EQ (kind
, Qswitch_frame
))
4564 /* If we're at the beginning of a key sequence, go
4565 ahead and return this event. If we're in the
4566 midst of a key sequence, delay it until the end. */
4569 delayed_switch_frame
= key
;
4577 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4578 /* Handle menu-bar events:
4579 insert the dummy prefix event `menu-bar'. */
4580 if (EQ (posn
, Qmenu_bar
))
4582 if (t
+ 1 >= bufsize
)
4583 error ("key sequence too long");
4584 /* Run the Lucid hook. */
4585 if (!NILP (Vrun_hooks
))
4586 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4587 /* If it has changed current-menubar from previous value,
4588 really recompute the menubar from the value. */
4589 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4590 call0 (Qrecompute_lucid_menubar
);
4594 /* Zap the position in key, so we know that we've
4595 expanded it, and don't try to do so again. */
4596 POSN_BUFFER_POSN (EVENT_START (key
))
4597 = Fcons (posn
, Qnil
);
4600 goto replay_sequence
;
4602 else if (XTYPE (posn
) == Lisp_Cons
)
4604 /* We're looking at the second event of a
4605 sequence which we expanded before. Set
4606 last_real_key_start appropriately. */
4607 if (last_real_key_start
== t
&& t
> 0)
4608 last_real_key_start
= t
- 1;
4613 /* We have finally decided that KEY is something we might want
4615 first_binding
= (follow_key (key
,
4616 nmaps
- first_binding
,
4617 submaps
+ first_binding
,
4618 defs
+ first_binding
,
4619 submaps
+ first_binding
,
4623 /* If KEY wasn't bound, we'll try some fallbacks. */
4624 if (first_binding
>= nmaps
)
4628 head
= EVENT_HEAD (key
);
4629 if (EQ (head
, Vhelp_char
))
4631 read_key_sequence_cmd
= Vprefix_help_command
;
4633 last_nonmenu_event
= key
;
4637 if (XTYPE (head
) == Lisp_Symbol
)
4639 Lisp_Object breakdown
;
4642 breakdown
= parse_modifiers (head
);
4643 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4644 /* Attempt to reduce an unbound mouse event to a simpler
4645 event that is bound:
4646 Drags reduce to clicks.
4647 Double-clicks reduce to clicks.
4648 Triple-clicks reduce to double-clicks, then to clicks.
4649 Down-clicks are eliminated.
4650 Double-downs reduce to downs, then are eliminated.
4651 Triple-downs reduce to double-downs, then to downs,
4652 then are eliminated. */
4653 if (modifiers
& (down_modifier
| drag_modifier
4654 | double_modifier
| triple_modifier
))
4656 while (modifiers
& (down_modifier
| drag_modifier
4657 | double_modifier
| triple_modifier
))
4659 Lisp_Object new_head
, new_click
;
4660 if (modifiers
& triple_modifier
)
4661 modifiers
^= (double_modifier
| triple_modifier
);
4662 else if (modifiers
& (drag_modifier
| double_modifier
))
4663 modifiers
&= ~(drag_modifier
| double_modifier
);
4666 /* Dispose of this `down' event by simply jumping
4667 back to replay_key, to get another event.
4669 Note that if this event came from mock input,
4670 then just jumping back to replay_key will just
4671 hand it to us again. So we have to wipe out any
4674 We could delete keybuf[t] and shift everything
4675 after that to the left by one spot, but we'd also
4676 have to fix up any variable that points into
4677 keybuf, and shifting isn't really necessary
4680 Adding prefixes for non-textual mouse clicks
4681 creates two characters of mock input, and both
4682 must be thrown away. If we're only looking at
4683 the prefix now, we can just jump back to
4684 replay_key. On the other hand, if we've already
4685 processed the prefix, and now the actual click
4686 itself is giving us trouble, then we've lost the
4687 state of the keymaps we want to backtrack to, and
4688 we need to replay the whole sequence to rebuild
4691 Beyond that, only function key expansion could
4692 create more than two keys, but that should never
4693 generate mouse events, so it's okay to zero
4694 mock_input in that case too.
4696 Isn't this just the most wonderful code ever? */
4697 if (t
== last_real_key_start
)
4704 mock_input
= last_real_key_start
;
4705 goto replay_sequence
;
4710 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
4712 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
4714 /* Look for a binding for this new key. follow_key
4715 promises that it didn't munge submaps the
4716 last time we called it, since key was unbound. */
4718 = (follow_key (new_click
,
4719 nmaps
- local_first_binding
,
4720 submaps
+ local_first_binding
,
4721 defs
+ local_first_binding
,
4722 submaps
+ local_first_binding
,
4724 + local_first_binding
);
4726 /* If that click is bound, go for it. */
4727 if (first_binding
< nmaps
)
4732 /* Otherwise, we'll leave key set to the drag event. */
4739 /* Normally, last_nonmenu_event gets the previous key we read.
4740 But when a mouse popup menu is being used,
4741 we don't update last_nonmenu_event; it continues to hold the mouse
4742 event that preceded the first level of menu. */
4743 if (!used_mouse_menu
)
4744 last_nonmenu_event
= key
;
4746 /* If the sequence is unbound, see if we can hang a function key
4747 off the end of it. We only want to scan real keyboard input
4748 for function key sequences, so if mock_input says that we're
4749 re-reading old events, don't examine it. */
4750 if ((first_binding
>= nmaps
|| case_converted
)
4753 Lisp_Object fkey_next
;
4755 /* Continue scan from fkey_end until we find a bound suffix.
4756 If we fail, increment fkey_start
4757 and start fkey_end from there. */
4758 while (fkey_end
< t
)
4762 key
= keybuf
[fkey_end
++];
4763 /* Look up meta-characters by prefixing them
4764 with meta_prefix_char. I hate this. */
4765 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4770 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
4772 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4775 fkey_next
= fkey_map
;
4778 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
4780 /* If the function key map gives a function, not an
4781 array, then call the function with no args and use
4782 its value instead. */
4783 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
4786 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4790 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4791 fkey_next
= call1 (fkey_next
, prompt
);
4793 /* If the function returned something invalid,
4794 barf--don't ignore it.
4795 (To ignore it safely, we would need to gcpro a bunch of
4796 other variables.) */
4797 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
4798 error ("Function in function-key-map returns invalid key sequence");
4801 function_key_possible
= ! NILP (fkey_next
);
4803 /* If keybuf[fkey_start..fkey_end] is bound in the
4804 function key map and it's a suffix of the current
4805 sequence (i.e. fkey_end == t), replace it with
4806 the binding and restart with fkey_start at the end. */
4807 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
4810 int len
= XFASTINT (Flength (fkey_next
));
4812 t
= fkey_start
+ len
;
4814 error ("key sequence too long");
4816 if (VECTORP (fkey_next
))
4817 bcopy (XVECTOR (fkey_next
)->contents
,
4818 keybuf
+ fkey_start
,
4819 (t
- fkey_start
) * sizeof (keybuf
[0]));
4820 else if (STRINGP (fkey_next
))
4824 for (i
= 0; i
< len
; i
++)
4825 XFASTINT (keybuf
[fkey_start
+ i
])
4826 = XSTRING (fkey_next
)->data
[i
];
4830 fkey_start
= fkey_end
= t
;
4831 fkey_map
= Vfunction_key_map
;
4833 goto replay_sequence
;
4836 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
4838 /* If we no longer have a bound suffix, try a new positions for
4840 if (NILP (fkey_map
))
4842 fkey_end
= ++fkey_start
;
4843 fkey_map
= Vfunction_key_map
;
4844 function_key_possible
= 0;
4849 /* Look for this sequence in key-translation-map. */
4851 Lisp_Object keytran_next
;
4853 /* Scan from keytran_end until we find a bound suffix. */
4854 while (keytran_end
< t
)
4858 key
= keybuf
[keytran_end
++];
4859 /* Look up meta-characters by prefixing them
4860 with meta_prefix_char. I hate this. */
4861 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4866 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
4868 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4871 keytran_next
= keytran_map
;
4874 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
4876 /* If the key translation map gives a function, not an
4877 array, then call the function with no args and use
4878 its value instead. */
4879 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
4880 && keytran_end
== t
)
4882 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4886 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4887 keytran_next
= call1 (keytran_next
, prompt
);
4889 /* If the function returned something invalid,
4890 barf--don't ignore it.
4891 (To ignore it safely, we would need to gcpro a bunch of
4892 other variables.) */
4893 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
4894 error ("Function in key-translation-map returns invalid key sequence");
4897 /* If keybuf[keytran_start..keytran_end] is bound in the
4898 key translation map and it's a suffix of the current
4899 sequence (i.e. keytran_end == t), replace it with
4900 the binding and restart with keytran_start at the end. */
4901 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
4902 && keytran_end
== t
)
4904 int len
= XFASTINT (Flength (keytran_next
));
4906 t
= keytran_start
+ len
;
4908 error ("key sequence too long");
4910 if (VECTORP (keytran_next
))
4911 bcopy (XVECTOR (keytran_next
)->contents
,
4912 keybuf
+ keytran_start
,
4913 (t
- keytran_start
) * sizeof (keybuf
[0]));
4914 else if (STRINGP (keytran_next
))
4918 for (i
= 0; i
< len
; i
++)
4919 XFASTINT (keybuf
[keytran_start
+ i
])
4920 = XSTRING (keytran_next
)->data
[i
];
4924 keytran_start
= keytran_end
= t
;
4925 keytran_map
= Vkey_translation_map
;
4927 goto replay_sequence
;
4930 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
4932 /* If we no longer have a bound suffix, try a new positions for
4934 if (NILP (keytran_map
))
4936 keytran_end
= ++keytran_start
;
4937 keytran_map
= Vkey_translation_map
;
4943 read_key_sequence_cmd
= (first_binding
< nmaps
4944 ? defs
[first_binding
]
4948 unread_switch_frame
= delayed_switch_frame
;
4949 unbind_to (count
, Qnil
);
4951 /* Occasionally we fabricate events, perhaps by expanding something
4952 according to function-key-map, or by adding a prefix symbol to a
4953 mouse click in the scroll bar or modeline. In this cases, return
4954 the entire generated key sequence, even if we hit an unbound
4955 prefix or a definition before the end. This means that you will
4956 be able to push back the event properly, and also means that
4957 read-key-sequence will always return a logical unit.
4960 for (; t
< mock_input
; t
++)
4962 echo_char (keybuf
[t
]);
4963 add_command_key (keybuf
[t
]);
4969 #if 0 /* This doc string is too long for some compilers.
4970 This commented-out definition serves for DOC. */
4971 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4972 "Read a sequence of keystrokes and return as a string or vector.\n\
4973 The sequence is sufficient to specify a non-prefix command in the\n\
4974 current local and global maps.\n\
4976 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
4977 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
4978 as a continuation of the previous key.\n\
4980 A C-g typed while in this function is treated like any other character,\n\
4981 and `quit-flag' is not set.\n\
4983 If the key sequence starts with a mouse click, then the sequence is read\n\
4984 using the keymaps of the buffer of the window clicked in, not the buffer\n\
4985 of the selected window as normal.\n\
4987 `read-key-sequence' drops unbound button-down events, since you normally\n\
4988 only care about the click or drag events which follow them. If a drag\n\
4989 or multi-click event is unbound, but the corresponding click event would\n\
4990 be bound, `read-key-sequence' turns the event into a click event at the\n\
4991 drag's starting position. This means that you don't have to distinguish\n\
4992 between click and drag, double, or triple events unless you want to.\n\
4994 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
4995 lines separating windows, and scroll bars with imaginary keys\n\
4996 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
4998 If the user switches frames in the middle of a key sequence, the\n\
4999 frame-switch event is put off until after the current key sequence.\n\
5001 `read-key-sequence' checks `function-key-map' for function key\n\
5002 sequences, where they wouldn't conflict with ordinary bindings. See\n\
5003 `function-key-map' for more details.")
5004 (prompt
, continue_echo
)
5007 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
5009 (prompt
, continue_echo
)
5010 Lisp_Object prompt
, continue_echo
;
5012 Lisp_Object keybuf
[30];
5014 struct gcpro gcpro1
, gcpro2
;
5017 CHECK_STRING (prompt
, 0);
5020 bzero (keybuf
, sizeof keybuf
);
5022 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
5024 if (NILP (continue_echo
))
5025 this_command_key_count
= 0;
5027 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])), prompt
);
5035 return make_event_array (i
, keybuf
);
5038 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
5039 "Execute CMD as an editor command.\n\
5040 CMD must be a symbol that satisfies the `commandp' predicate.\n\
5041 Optional second arg RECORD-FLAG non-nil\n\
5042 means unconditionally put this command in `command-history'.\n\
5043 Otherwise, that is done only if an arg is read using the minibuffer.")
5045 Lisp_Object cmd
, record
;
5047 register Lisp_Object final
;
5048 register Lisp_Object tem
;
5049 Lisp_Object prefixarg
;
5050 struct backtrace backtrace
;
5051 extern int debug_on_next_call
;
5053 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
5054 Vcurrent_prefix_arg
= prefixarg
;
5055 debug_on_next_call
= 0;
5057 if (XTYPE (cmd
) == Lisp_Symbol
)
5059 tem
= Fget (cmd
, Qdisabled
);
5060 if (!NILP (tem
) && !NILP (Vrun_hooks
))
5061 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
5066 final
= Findirect_function (cmd
);
5068 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
5069 do_autoload (final
, cmd
);
5074 if (XTYPE (final
) == Lisp_String
5075 || XTYPE (final
) == Lisp_Vector
)
5077 /* If requested, place the macro in the command history. For
5078 other sorts of commands, call-interactively takes care of
5082 = Fcons (Fcons (Qexecute_kbd_macro
,
5083 Fcons (final
, Fcons (prefixarg
, Qnil
))),
5086 return Fexecute_kbd_macro (final
, prefixarg
);
5088 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
5089 || XTYPE (final
) == Lisp_Compiled
)
5091 backtrace
.next
= backtrace_list
;
5092 backtrace_list
= &backtrace
;
5093 backtrace
.function
= &Qcall_interactively
;
5094 backtrace
.args
= &cmd
;
5095 backtrace
.nargs
= 1;
5096 backtrace
.evalargs
= 0;
5098 tem
= Fcall_interactively (cmd
, record
);
5100 backtrace_list
= backtrace
.next
;
5106 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
5108 "Read function name, then read its arguments and call it.")
5110 Lisp_Object prefixarg
;
5112 Lisp_Object function
;
5114 Lisp_Object saved_keys
;
5115 struct gcpro gcpro1
;
5117 saved_keys
= Fvector (this_command_key_count
,
5118 XVECTOR (this_command_keys
)->contents
);
5120 GCPRO1 (saved_keys
);
5122 if (EQ (prefixarg
, Qminus
))
5124 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
5125 strcpy (buf
, "C-u ");
5126 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
5127 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
5128 else if (XTYPE (prefixarg
) == Lisp_Int
)
5129 sprintf (buf
, "%d ", XINT (prefixarg
));
5131 /* This isn't strictly correct if execute-extended-command
5132 is bound to anything else. Perhaps it should use
5133 this_command_keys? */
5134 strcat (buf
, "M-x ");
5136 /* Prompt with buf, and then read a string, completing from and
5137 restricting to the set of all defined commands. Don't provide
5138 any initial input. Save the command read on the extended-command
5140 function
= Fcompleting_read (build_string (buf
),
5141 Vobarray
, Qcommandp
,
5142 Qt
, Qnil
, Qextended_command_history
);
5144 /* Set this_command_keys to the concatenation of saved_keys and
5145 function, followed by a RET. */
5147 struct Lisp_String
*str
;
5152 this_command_key_count
= 0;
5154 keys
= XVECTOR (saved_keys
)->contents
;
5155 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
5156 add_command_key (keys
[i
]);
5158 str
= XSTRING (function
);
5159 for (i
= 0; i
< str
->size
; i
++)
5161 XFASTINT (tem
) = str
->data
[i
];
5162 add_command_key (tem
);
5165 XFASTINT (tem
) = '\015';
5166 add_command_key (tem
);
5171 function
= Fintern (function
, Qnil
);
5172 Vprefix_arg
= prefixarg
;
5173 this_command
= function
;
5175 return Fcommand_execute (function
, Qt
);
5179 detect_input_pending ()
5182 get_input_pending (&input_pending
);
5184 return input_pending
;
5187 /* This is called in some cases before a possible quit.
5188 It cases the next call to detect_input_pending to recompute input_pending.
5189 So calling this function unnecessarily can't do any harm. */
5190 clear_input_pending ()
5195 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
5196 "T if command input is currently available with no waiting.\n\
5197 Actually, the value is nil only if we can be sure that no input is available.")
5200 if (!NILP (unread_command_events
) || unread_command_char
!= -1)
5203 return detect_input_pending () ? Qt
: Qnil
;
5206 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
5207 "Return vector of last 100 events, not counting those from keyboard macros.")
5210 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
5213 if (total_keys
< NUM_RECENT_KEYS
)
5214 return Fvector (total_keys
, keys
);
5217 val
= Fvector (NUM_RECENT_KEYS
, keys
);
5218 bcopy (keys
+ recent_keys_index
,
5219 XVECTOR (val
)->contents
,
5220 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
5222 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
5223 recent_keys_index
* sizeof (Lisp_Object
));
5228 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
5229 "Return the key sequence that invoked this command.\n\
5230 The value is a string or a vector.")
5233 return make_event_array (this_command_key_count
,
5234 XVECTOR (this_command_keys
)->contents
);
5237 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
5238 "Return the current depth in recursive edits.")
5242 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
5246 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
5247 "FOpen dribble file: ",
5248 "Start writing all keyboard characters to a dribble file called FILE.\n\
5249 If FILE is nil, close any open dribble file.")
5260 file
= Fexpand_file_name (file
, Qnil
);
5261 dribble
= fopen (XSTRING (file
)->data
, "w");
5266 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
5267 "Discard the contents of the terminal input buffer.\n\
5268 Also cancel any kbd macro being defined.")
5271 defining_kbd_macro
= 0;
5272 update_mode_lines
++;
5274 unread_command_events
= Qnil
;
5275 unread_command_char
= -1;
5277 discard_tty_input ();
5279 /* Without the cast, GCC complains that this assignment loses the
5280 volatile qualifier of kbd_store_ptr. Is there anything wrong
5282 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
5283 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5289 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
5290 "Stop Emacs and return to superior process. You can resume later.\n\
5291 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
5292 control, run a subshell instead.\n\n\
5293 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
5294 to be read as terminal input by Emacs's parent, after suspension.\n\
5296 Before suspending, call the functions in `suspend-hook' with no args.\n\
5297 If any of them returns nil, don't call the rest and don't suspend.\n\
5298 Otherwise, suspend normally and after resumption run the normal hook\n\
5299 `suspend-resume-hook' if that is bound and non-nil.\n\
5301 Some operating systems cannot stop the Emacs process and resume it later.\n\
5302 On such systems, Emacs starts a subshell instead of suspending.")
5304 Lisp_Object stuffstring
;
5307 int count
= specpdl_ptr
- specpdl
;
5308 int old_height
, old_width
;
5310 struct gcpro gcpro1
, gcpro2
;
5311 extern init_sys_modes ();
5313 if (!NILP (stuffstring
))
5314 CHECK_STRING (stuffstring
, 0);
5316 /* Run the functions in suspend-hook. */
5317 if (!NILP (Vrun_hooks
))
5318 call1 (Vrun_hooks
, intern ("suspend-hook"));
5320 GCPRO1 (stuffstring
);
5321 get_frame_size (&old_width
, &old_height
);
5323 /* sys_suspend can get an error if it tries to fork a subshell
5324 and the system resources aren't available for that. */
5325 record_unwind_protect (init_sys_modes
, 0);
5326 stuff_buffered_input (stuffstring
);
5331 unbind_to (count
, Qnil
);
5333 /* Check if terminal/window size has changed.
5334 Note that this is not useful when we are running directly
5335 with a window system; but suspend should be disabled in that case. */
5336 get_frame_size (&width
, &height
);
5337 if (width
!= old_width
|| height
!= old_height
)
5338 change_frame_size (selected_frame
, height
, width
, 0, 0);
5340 /* Run suspend-resume-hook. */
5341 if (!NILP (Vrun_hooks
))
5342 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
5348 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
5349 Then in any case stuff anything Emacs has read ahead and not used. */
5351 stuff_buffered_input (stuffstring
)
5352 Lisp_Object stuffstring
;
5354 register unsigned char *p
;
5356 /* stuff_char works only in BSD, versions 4.2 and up. */
5359 if (XTYPE (stuffstring
) == Lisp_String
)
5363 p
= XSTRING (stuffstring
)->data
;
5364 count
= XSTRING (stuffstring
)->size
;
5369 /* Anything we have read ahead, put back for the shell to read. */
5370 while (kbd_fetch_ptr
!= kbd_store_ptr
)
5372 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
5373 kbd_fetch_ptr
= kbd_buffer
;
5374 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
5375 stuff_char (kbd_fetch_ptr
->code
);
5376 kbd_fetch_ptr
->kind
= no_event
;
5377 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
5384 #endif /* BSD and not BSD4_1 */
5387 set_waiting_for_input (time_to_clear
)
5388 EMACS_TIME
*time_to_clear
;
5390 input_available_clear_time
= time_to_clear
;
5392 /* Tell interrupt_signal to throw back to read_char, */
5393 waiting_for_input
= 1;
5395 /* If interrupt_signal was called before and buffered a C-g,
5396 make it run again now, to avoid timing error. */
5397 if (!NILP (Vquit_flag
))
5398 quit_throw_to_read_char ();
5401 clear_waiting_for_input ()
5403 /* Tell interrupt_signal not to throw back to read_char, */
5404 waiting_for_input
= 0;
5405 input_available_clear_time
= 0;
5408 /* This routine is called at interrupt level in response to C-G.
5409 If interrupt_input, this is the handler for SIGINT.
5410 Otherwise, it is called from kbd_buffer_store_event,
5411 in handling SIGIO or SIGTINT.
5413 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
5414 immediately throw back to read_char.
5416 Otherwise it sets the Lisp variable quit-flag not-nil.
5417 This causes eval to throw, when it gets a chance.
5418 If quit-flag is already non-nil, it stops the job right away. */
5424 /* Must preserve main program's value of errno. */
5425 int old_errno
= errno
;
5428 /* USG systems forget handlers when they are used;
5429 must reestablish each time */
5430 signal (SIGINT
, interrupt_signal
);
5431 signal (SIGQUIT
, interrupt_signal
);
5436 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
5441 #ifdef SIGTSTP /* Support possible in later USG versions */
5443 * On systems which can suspend the current process and return to the original
5444 * shell, this command causes the user to end up back at the shell.
5445 * The "Auto-save" and "Abort" questions are not asked until
5446 * the user elects to return to emacs, at which point he can save the current
5447 * job and either dump core or continue.
5452 if (sys_suspend () == -1)
5454 printf ("Not running as a subprocess;\n");
5455 printf ("you can continue or abort.\n");
5458 /* Perhaps should really fork an inferior shell?
5459 But that would not provide any way to get back
5460 to the original shell, ever. */
5461 printf ("No support for stopping a process on this operating system;\n");
5462 printf ("you can continue or abort.\n");
5463 #endif /* not VMS */
5464 #endif /* not SIGTSTP */
5466 /* We must remain inside the screen area when the internal terminal
5467 is used. Note that [Enter] is not echoed by dos. */
5470 printf ("Auto-save? (y or n) ");
5472 if (((c
= getchar ()) & ~040) == 'Y')
5474 Fdo_auto_save (Qt
, Qnil
);
5476 printf ("\r\nAuto-save done");
5477 #else /* not MSDOS */
5478 printf ("Auto-save done\n");
5479 #endif /* not MSDOS */
5481 while (c
!= '\n') c
= getchar ();
5483 printf ("\r\nAbort? (y or n) ");
5484 #else /* not MSDOS */
5486 printf ("Abort (and enter debugger)? (y or n) ");
5488 printf ("Abort (and dump core)? (y or n) ");
5489 #endif /* not VMS */
5490 #endif /* not MSDOS */
5492 if (((c
= getchar ()) & ~040) == 'Y')
5494 while (c
!= '\n') c
= getchar ();
5496 printf ("\r\nContinuing...\r\n");
5497 #else /* not MSDOS */
5498 printf ("Continuing...\n");
5499 #endif /* not MSDOS */
5505 /* If executing a function that wants to be interrupted out of
5506 and the user has not deferred quitting by binding `inhibit-quit'
5507 then quit right away. */
5508 if (immediate_quit
&& NILP (Vinhibit_quit
))
5512 Fsignal (Qquit
, Qnil
);
5515 /* Else request quit when it's safe */
5519 if (waiting_for_input
&& !echoing
)
5520 quit_throw_to_read_char ();
5525 /* Handle a C-g by making read_char return C-g. */
5527 quit_throw_to_read_char ()
5529 quit_error_check ();
5531 /* Prevent another signal from doing this before we finish. */
5532 clear_waiting_for_input ();
5535 unread_command_events
= Qnil
;
5536 unread_command_char
= -1;
5538 #ifdef POLL_FOR_INPUT
5539 /* May be > 1 if in recursive minibuffer. */
5540 if (poll_suppress_count
== 0)
5544 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
5545 && XFRAME (internal_last_event_frame
) != selected_frame
)
5546 Fhandle_switch_frame (make_lispy_switch_frame (internal_last_event_frame
));
5549 _longjmp (getcjmp
, 1);
5552 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
5553 "Set mode of reading keyboard input.\n\
5554 First arg INTERRUPT non-nil means use input interrupts;\n\
5555 nil means use CBREAK mode.\n\
5556 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
5557 (no effect except in CBREAK mode).\n\
5558 Third arg META t means accept 8-bit input (for a Meta key).\n\
5559 META nil means ignore the top bit, on the assumption it is parity.\n\
5560 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
5561 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
5562 See also `current-input-mode'.")
5563 (interrupt
, flow
, meta
, quit
)
5564 Lisp_Object interrupt
, flow
, meta
, quit
;
5567 && (XTYPE (quit
) != Lisp_Int
5568 || XINT (quit
) < 0 || XINT (quit
) > 0400))
5569 error ("set-input-mode: QUIT must be an ASCII character");
5571 #ifdef POLL_FOR_INPUT
5577 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5578 #ifdef NO_SOCK_SIGIO
5579 if (read_socket_hook
)
5580 interrupt_input
= 0; /* No interrupts if reading from a socket. */
5582 #endif /* NO_SOCK_SIGIO */
5583 interrupt_input
= !NILP (interrupt
);
5584 #else /* not SIGIO */
5585 interrupt_input
= 0;
5586 #endif /* not SIGIO */
5587 /* Our VMS input only works by interrupts, as of now. */
5589 interrupt_input
= 1;
5591 flow_control
= !NILP (flow
);
5594 else if (EQ (meta
, Qt
))
5599 /* Don't let this value be out of range. */
5600 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
5604 #ifdef POLL_FOR_INPUT
5605 poll_suppress_count
= 1;
5611 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
5612 "Return information about the way Emacs currently reads keyboard input.\n\
5613 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
5614 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
5615 nil, Emacs is using CBREAK mode.\n\
5616 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
5617 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
5618 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
5619 META nil means ignoring the top bit, on the assumption it is parity.\n\
5620 META is neither t nor nil if accepting 8-bit input and using\n\
5621 all 8 bits as the character code.\n\
5622 QUIT is the character Emacs currently uses to quit.\n\
5623 The elements of this list correspond to the arguments of\n\
5629 val
[0] = interrupt_input
? Qt
: Qnil
;
5630 val
[1] = flow_control
? Qt
: Qnil
;
5631 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
5632 XFASTINT (val
[3]) = quit_char
;
5634 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
5640 /* This is correct before outermost invocation of the editor loop */
5641 command_loop_level
= -1;
5643 quit_char
= Ctl ('g');
5644 unread_command_events
= Qnil
;
5645 unread_command_char
= -1;
5647 recent_keys_index
= 0;
5648 kbd_fetch_ptr
= kbd_buffer
;
5649 kbd_store_ptr
= kbd_buffer
;
5650 do_mouse_tracking
= 0;
5654 /* This means that command_loop_1 won't try to select anything the first
5656 internal_last_event_frame
= Qnil
;
5657 Vlast_event_frame
= internal_last_event_frame
;
5660 /* If we're running a dumped Emacs, we need to clear out
5661 kbd_buffer_frame_or_window, in case some events got into it
5664 If we're running an undumped Emacs, it hasn't been initialized by
5665 syms_of_keyboard yet. */
5667 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5669 if (!noninteractive
)
5671 signal (SIGINT
, interrupt_signal
);
5672 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
5673 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
5674 SIGQUIT and we can't tell which one it will give us. */
5675 signal (SIGQUIT
, interrupt_signal
);
5676 #endif /* HAVE_TERMIO */
5677 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5679 signal (SIGIO
, input_available_signal
);
5683 /* Use interrupt input by default, if it works and noninterrupt input
5684 has deficiencies. */
5686 #ifdef INTERRUPT_INPUT
5687 interrupt_input
= 1;
5689 interrupt_input
= 0;
5692 /* Our VMS input only works by interrupts, as of now. */
5694 interrupt_input
= 1;
5700 if (keyboard_init_hook
)
5701 (*keyboard_init_hook
) ();
5703 #ifdef POLL_FOR_INPUT
5704 poll_suppress_count
= 1;
5709 /* This type's only use is in syms_of_keyboard, to initialize the
5710 event header symbols and put properties on them. */
5717 struct event_head head_table
[] = {
5718 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
5719 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
5720 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
5725 Qdisabled_command_hook
= intern ("disabled-command-hook");
5726 staticpro (&Qdisabled_command_hook
);
5728 Qself_insert_command
= intern ("self-insert-command");
5729 staticpro (&Qself_insert_command
);
5731 Qforward_char
= intern ("forward-char");
5732 staticpro (&Qforward_char
);
5734 Qbackward_char
= intern ("backward-char");
5735 staticpro (&Qbackward_char
);
5737 Qdisabled
= intern ("disabled");
5738 staticpro (&Qdisabled
);
5740 Qundefined
= intern ("undefined");
5741 staticpro (&Qundefined
);
5743 Qpre_command_hook
= intern ("pre-command-hook");
5744 staticpro (&Qpre_command_hook
);
5746 Qpost_command_hook
= intern ("post-command-hook");
5747 staticpro (&Qpost_command_hook
);
5749 Qcommand_hook_internal
= intern ("command-hook-internal");
5750 staticpro (&Qcommand_hook_internal
);
5752 Qfunction_key
= intern ("function-key");
5753 staticpro (&Qfunction_key
);
5754 Qmouse_click
= intern ("mouse-click");
5755 staticpro (&Qmouse_click
);
5757 Qmenu_enable
= intern ("menu-enable");
5758 staticpro (&Qmenu_enable
);
5760 Qmode_line
= intern ("mode-line");
5761 staticpro (&Qmode_line
);
5762 Qvertical_line
= intern ("vertical-line");
5763 staticpro (&Qvertical_line
);
5764 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
5765 staticpro (&Qvertical_scroll_bar
);
5766 Qmenu_bar
= intern ("menu-bar");
5767 staticpro (&Qmenu_bar
);
5769 Qabove_handle
= intern ("above-handle");
5770 staticpro (&Qabove_handle
);
5771 Qhandle
= intern ("handle");
5772 staticpro (&Qhandle
);
5773 Qbelow_handle
= intern ("below-handle");
5774 staticpro (&Qbelow_handle
);
5776 Qevent_kind
= intern ("event-kind");
5777 staticpro (&Qevent_kind
);
5778 Qevent_symbol_elements
= intern ("event-symbol-elements");
5779 staticpro (&Qevent_symbol_elements
);
5780 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
5781 staticpro (&Qevent_symbol_element_mask
);
5782 Qmodifier_cache
= intern ("modifier-cache");
5783 staticpro (&Qmodifier_cache
);
5785 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
5786 staticpro (&Qrecompute_lucid_menubar
);
5787 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
5788 staticpro (&Qactivate_menubar_hook
);
5791 struct event_head
*p
;
5793 for (p
= head_table
;
5794 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
5797 *p
->var
= intern (p
->name
);
5799 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
5800 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
5804 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
5805 staticpro (&button_down_location
);
5809 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
5811 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
5812 for (i
= 0; i
< len
; i
++)
5813 if (modifier_names
[i
])
5814 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
5815 staticpro (&modifier_symbols
);
5818 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
5819 staticpro (&recent_keys
);
5821 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
5822 staticpro (&this_command_keys
);
5824 Qextended_command_history
= intern ("extended-command-history");
5825 Fset (Qextended_command_history
, Qnil
);
5826 staticpro (&Qextended_command_history
);
5828 kbd_buffer_frame_or_window
5829 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
5830 staticpro (&kbd_buffer_frame_or_window
);
5832 func_key_syms
= Qnil
;
5833 staticpro (&func_key_syms
);
5835 system_key_syms
= Qnil
;
5836 staticpro (&system_key_syms
);
5839 staticpro (&mouse_syms
);
5841 unread_switch_frame
= Qnil
;
5842 staticpro (&unread_switch_frame
);
5844 defsubr (&Sread_key_sequence
);
5845 defsubr (&Srecursive_edit
);
5846 defsubr (&Strack_mouse
);
5847 defsubr (&Sinput_pending_p
);
5848 defsubr (&Scommand_execute
);
5849 defsubr (&Srecent_keys
);
5850 defsubr (&Sthis_command_keys
);
5851 defsubr (&Ssuspend_emacs
);
5852 defsubr (&Sabort_recursive_edit
);
5853 defsubr (&Sexit_recursive_edit
);
5854 defsubr (&Srecursion_depth
);
5855 defsubr (&Stop_level
);
5856 defsubr (&Sdiscard_input
);
5857 defsubr (&Sopen_dribble_file
);
5858 defsubr (&Sset_input_mode
);
5859 defsubr (&Scurrent_input_mode
);
5860 defsubr (&Sexecute_extended_command
);
5862 DEFVAR_LISP ("last-command-char", &last_command_char
,
5863 "Last input event that was part of a command.");
5865 DEFVAR_LISP ("last-command-event", &last_command_char
,
5866 "Last input event that was part of a command.");
5868 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
5869 "Last input event in a command, except for mouse menu events.\n\
5870 Mouse menus give back keys that don't look like mouse events;\n\
5871 this variable holds the actual mouse event that led to the menu,\n\
5872 so that you can determine whether the command was run by mouse or not.");
5874 DEFVAR_LISP ("last-input-char", &last_input_char
,
5875 "Last input event.");
5877 DEFVAR_LISP ("last-input-event", &last_input_char
,
5878 "Last input event.");
5880 DEFVAR_LISP ("unread-command-events", &unread_command_events
,
5881 "List of objects to be read as next command input events.");
5883 DEFVAR_INT ("unread-command-char", &unread_command_char
,
5884 "If not -1, an object to be read as next command input event.");
5886 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
5887 "Meta-prefix character code. Meta-foo as command input\n\
5888 turns into this character followed by foo.");
5889 XSET (meta_prefix_char
, Lisp_Int
, 033);
5891 DEFVAR_LISP ("last-command", &last_command
,
5892 "The last command executed. Normally a symbol with a function definition,\n\
5893 but can be whatever was found in the keymap, or whatever the variable\n\
5894 `this-command' was set to by that command.");
5895 last_command
= Qnil
;
5897 DEFVAR_LISP ("this-command", &this_command
,
5898 "The command now being executed.\n\
5899 The command can set this variable; whatever is put here\n\
5900 will be in `last-command' during the following command.");
5901 this_command
= Qnil
;
5903 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
5904 "*Number of keyboard input characters between auto-saves.\n\
5905 Zero means disable autosaving due to number of characters typed.");
5906 auto_save_interval
= 300;
5908 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
5909 "*Number of seconds idle time before auto-save.\n\
5910 Zero or nil means disable auto-saving due to idleness.\n\
5911 After auto-saving due to this many seconds of idle time,\n\
5912 Emacs also does a garbage collection if that seems to be warranted.");
5913 XFASTINT (Vauto_save_timeout
) = 30;
5915 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
5916 "*Nonzero means echo unfinished commands after this many seconds of pause.");
5917 echo_keystrokes
= 1;
5919 DEFVAR_INT ("polling-period", &polling_period
,
5920 "*Interval between polling for input during Lisp execution.\n\
5921 The reason for polling is to make C-g work to stop a running program.\n\
5922 Polling is needed only when using X windows and SIGIO does not work.\n\
5923 Polling is automatically disabled in all other cases.");
5926 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
5927 "*Maximum time between mouse clicks to make a double-click.\n\
5928 Measured in milliseconds. nil means disable double-click recognition;\n\
5929 t means double-clicks have no time limit and are detected\n\
5930 by position only.");
5931 Vdouble_click_time
= make_number (500);
5933 DEFVAR_INT ("num-input-keys", &num_input_keys
,
5934 "*Number of complete keys read from the keyboard so far.");
5937 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
5938 "*The frame in which the most recently read event occurred.\n\
5939 If the last event came from a keyboard macro, this is set to `macro'.");
5940 Vlast_event_frame
= Qnil
;
5942 DEFVAR_LISP ("help-char", &Vhelp_char
,
5943 "Character to recognize as meaning Help.\n\
5944 When it is read, do `(eval help-form)', and display result if it's a string.\n\
5945 If the value of `help-form' is nil, this char can be read normally.");
5946 XSET (Vhelp_char
, Lisp_Int
, Ctl ('H'));
5948 DEFVAR_LISP ("help-form", &Vhelp_form
,
5949 "Form to execute when character `help-char' is read.\n\
5950 If the form returns a string, that string is displayed.\n\
5951 If `help-form' is nil, the help char is not recognized.");
5954 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
5955 "Command to run when `help-char' character follows a prefix key.\n\
5956 This command is used only when there is no actual binding\n\
5957 for that character after that prefix key.");
5958 Vprefix_help_command
= Qnil
;
5960 DEFVAR_LISP ("top-level", &Vtop_level
,
5961 "Form to evaluate when Emacs starts up.\n\
5962 Useful to set before you dump a modified Emacs.");
5965 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
5966 "String used as translate table for keyboard input, or nil.\n\
5967 Each character is looked up in this string and the contents used instead.\n\
5968 If string is of length N, character codes N and up are untranslated.");
5969 Vkeyboard_translate_table
= Qnil
;
5971 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
5972 "Keymap of key translations that can override keymaps.\n\
5973 This keymap works like `function-key-map', but comes after that,\n\
5974 and applies even for keys that have ordinary bindings.");
5975 Vkey_translation_map
= Qnil
;
5977 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
5978 "Non-nil means to always spawn a subshell instead of suspending,\n\
5979 even if the operating system has support for stopping a process.");
5982 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
5983 "Non-nil means prompt with menus when appropriate.\n\
5984 This is done when reading from a keymap that has a prompt string,\n\
5985 for elements that have prompt strings.\n\
5986 The menu is displayed on the screen\n\
5987 if X menus were enabled at configuration\n\
5988 time and the previous event was a mouse click prefix key.\n\
5989 Otherwise, menu prompting uses the echo area.");
5992 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
5993 "Character to see next line of menu prompt.\n\
5994 Type this character while in a menu prompt to rotate around the lines of it.");
5995 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
5997 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
5998 "A mask of additional modifier keys to use with every keyboard character.\n\
5999 Emacs applies the modifiers of the character stored here to each keyboard\n\
6000 character it reads. For example, after evaluating the expression\n\
6001 (setq extra-keyboard-modifiers ?\C-x)\n\
6002 all input characters will have the control modifier applied to them.\n\
6004 Note that the character ?\C-@, equivalent to the integer zero, does\n\
6005 not count as a control character; rather, it counts as a character\n\
6006 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
6007 cancels any modification.");
6008 extra_keyboard_modifiers
= 0;
6010 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
6011 "If an editing command sets this to t, deactivate the mark afterward.\n\
6012 The command loop sets this to nil before each command,\n\
6013 and tests the value when the command returns.\n\
6014 Buffer modification stores t in this variable.");
6015 Vdeactivate_mark
= Qnil
;
6017 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
6018 "Temporary storage of pre-command-hook or post-command-hook.");
6019 Vcommand_hook_internal
= Qnil
;
6021 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
6022 "Normal hook run before each command is executed.");
6023 Vpre_command_hook
= Qnil
;
6025 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
6026 "Normal hook run after each command is executed.");
6027 Vpost_command_hook
= Qnil
;
6029 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
6030 "t means menu bar, specified Lucid style, needs to be recomputed.");
6031 Vlucid_menu_bar_dirty_flag
= Qnil
;
6033 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
6034 "List of menu bar items to move to the end of the menu bar.\n\
6035 The elements of the list are event types that may have menu bar bindings.");
6036 Vmenu_bar_final_items
= Qnil
;
6038 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
6039 "Keymap that overrides all other local keymaps.\n\
6040 If this variable is non-nil, it is used as a keymap instead of the\n\
6041 buffer's local map, and the minor mode keymaps and text property keymaps.");
6042 Voverriding_local_map
= Qnil
;
6044 DEFVAR_BOOL ("track-mouse", &do_mouse_tracking
,
6045 "*Non-nil means generate motion events for mouse motion.");
6047 DEFVAR_LISP ("system-key-alist", &Vsystem_key_alist
,
6048 "Alist of system-specific X windows key symbols.\n\
6049 Each element should have the form (N . SYMBOL) where N is the\n\
6050 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
6051 and SYMBOL is its name.");
6052 Vmenu_bar_final_items
= Qnil
;
6057 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
6058 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
6059 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
6060 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
6061 initial_define_key (meta_map
, 'x', "execute-extended-command");