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
;
236 /* The frame in which the last input event occurred, or Qmacro if the
237 last event came from a macro. We use this to determine when to
238 generate switch-frame events. This may be cleared by functions
239 like Fselect_frame, to make sure that a switch-frame event is
240 generated by the next character. */
241 Lisp_Object internal_last_event_frame
;
243 /* A user-visible version of the above, intended to allow users to
244 figure out where the last event came from, if the event doesn't
245 carry that information itself (i.e. if it was a character). */
246 Lisp_Object Vlast_event_frame
;
249 /* The timestamp of the last input event we received from the X server.
250 X Windows wants this for selection ownership. */
251 unsigned long last_event_timestamp
;
253 Lisp_Object Qself_insert_command
;
254 Lisp_Object Qforward_char
;
255 Lisp_Object Qbackward_char
;
256 Lisp_Object Qundefined
;
258 /* read_key_sequence stores here the command definition of the
259 key sequence that it reads. */
260 Lisp_Object read_key_sequence_cmd
;
262 /* Form to evaluate (if non-nil) when Emacs is started. */
263 Lisp_Object Vtop_level
;
265 /* User-supplied string to translate input characters through. */
266 Lisp_Object Vkeyboard_translate_table
;
268 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
269 extern Lisp_Object Vfunction_key_map
;
271 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
272 Lisp_Object Vkey_translation_map
;
274 /* Non-nil means deactivate the mark at end of this command. */
275 Lisp_Object Vdeactivate_mark
;
277 /* Menu bar specified in Lucid Emacs fashion. */
279 Lisp_Object Vlucid_menu_bar_dirty_flag
;
280 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
282 /* Hooks to run before and after each command. */
283 Lisp_Object Qpre_command_hook
, Qpost_command_hook
;
284 Lisp_Object Vpre_command_hook
, Vpost_command_hook
;
285 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
287 /* File in which we write all commands we read. */
290 /* Nonzero if input is available. */
293 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
294 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
298 extern char *pending_malloc_warning
;
300 /* Circular buffer for pre-read keyboard input. */
301 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
303 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
305 The interrupt-level event handlers will never enqueue an event on a
306 frame which is not in Vframe_list, and once an event is dequeued,
307 internal_last_event_frame or the event itself points to the frame.
310 But while the event is sitting in the queue, it's completely
311 unprotected. Suppose the user types one command which will run for
312 a while and then delete a frame, and then types another event at
313 the frame that will be deleted, before the command gets around to
314 it. Suppose there are no references to this frame elsewhere in
315 Emacs, and a GC occurs before the second event is dequeued. Now we
316 have an event referring to a freed frame, which will crash Emacs
319 Similar things happen when an event on a scroll bar is enqueued; the
320 window may be deleted while the event is in the queue.
322 So, we use this vector to protect the frame_or_window field in the
323 event queue. That way, they'll be dequeued as dead frames or
324 windows, but still valid lisp objects.
326 If kbd_buffer[i].kind != no_event, then
327 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
328 == kbd_buffer[i].frame_or_window. */
329 static Lisp_Object kbd_buffer_frame_or_window
;
331 /* Pointer to next available character in kbd_buffer.
332 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
333 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
334 next available char is in kbd_buffer[0]. */
335 static struct input_event
*kbd_fetch_ptr
;
337 /* Pointer to next place to store character in kbd_buffer. This
338 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
339 character should go in kbd_buffer[0]. */
343 static struct input_event
*kbd_store_ptr
;
345 /* The above pair of variables forms a "queue empty" flag. When we
346 enqueue a non-hook event, we increment kbd_write_count. When we
347 dequeue a non-hook event, we increment kbd_read_count. We say that
348 there is input available iff the two counters are not equal.
350 Why not just have a flag set and cleared by the enqueuing and
351 dequeuing functions? Such a flag could be screwed up by interrupts
352 at inopportune times. */
354 /* If this flag is non-zero, we check mouse_moved to see when the
355 mouse moves, and motion events will appear in the input stream. If
356 it is zero, mouse motion is ignored. */
357 static int do_mouse_tracking
;
359 /* The window system handling code should set this if the mouse has
360 moved since the last call to the mouse_position_hook. Calling that
361 hook should clear this. Code assumes that if this is set, it can
362 call mouse_position_hook to get the promised position, so don't set
363 it unless you're prepared to substantiate the claim! */
366 /* True iff there is an event in kbd_buffer, or if mouse tracking is
367 enabled and there is a new mouse position in the mouse movement
368 buffer. Note that if this is false, that doesn't mean that there
369 is readable input; all the events in the queue might be button-up
370 events, and do_mouse_tracking might be off. */
371 #define EVENT_QUEUES_EMPTY \
372 ((kbd_fetch_ptr == kbd_store_ptr) && (!do_mouse_tracking || !mouse_moved))
375 /* Symbols to head events. */
376 Lisp_Object Qmouse_movement
;
377 Lisp_Object Qscroll_bar_movement
;
378 Lisp_Object Qswitch_frame
;
380 /* Symbols to denote kinds of events. */
381 Lisp_Object Qfunction_key
;
382 Lisp_Object Qmouse_click
;
383 /* Lisp_Object Qmouse_movement; - also an event header */
385 /* Properties of event headers. */
386 Lisp_Object Qevent_kind
;
387 Lisp_Object Qevent_symbol_elements
;
389 Lisp_Object Qmenu_enable
;
391 /* An event header symbol HEAD may have a property named
392 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
393 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
394 mask of modifiers applied to it. If present, this is used to help
395 speed up parse_modifiers. */
396 Lisp_Object Qevent_symbol_element_mask
;
398 /* An unmodified event header BASE may have a property named
399 Qmodifier_cache, which is an alist mapping modifier masks onto
400 modified versions of BASE. If present, this helps speed up
402 Lisp_Object Qmodifier_cache
;
404 /* Symbols to use for parts of windows. */
405 Lisp_Object Qmode_line
;
406 Lisp_Object Qvertical_line
;
407 Lisp_Object Qvertical_scroll_bar
;
408 Lisp_Object Qmenu_bar
;
410 extern Lisp_Object Qmenu_enable
;
412 Lisp_Object
recursive_edit_unwind (), command_loop ();
413 Lisp_Object
Fthis_command_keys ();
414 Lisp_Object Qextended_command_history
;
416 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
418 EMACS_TIME
*input_available_clear_time
;
420 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
421 Default is 1 if INTERRUPT_INPUT is defined. */
424 /* Nonzero while interrupts are temporarily deferred during redisplay. */
425 int interrupts_deferred
;
427 /* nonzero means use ^S/^Q for flow control. */
430 /* Allow m- file to inhibit use of FIONREAD. */
431 #ifdef BROKEN_FIONREAD
435 /* We are unable to use interrupts if FIONREAD is not available,
436 so flush SIGIO so we won't try. */
443 /* If we support X Windows, turn on the code to poll periodically
444 to detect C-g. It isn't actually used when doing interrupt input. */
445 #ifdef HAVE_X_WINDOWS
446 #define POLL_FOR_INPUT
449 /* Global variable declarations. */
451 /* Function for init_keyboard to call with no args (if nonzero). */
452 void (*keyboard_init_hook
) ();
454 static int read_avail_input ();
455 static void get_input_pending ();
456 static int readable_events ();
457 static Lisp_Object
read_char_x_menu_prompt ();
458 static Lisp_Object
read_char_minibuf_menu_prompt ();
459 static Lisp_Object
make_lispy_event ();
460 static Lisp_Object
make_lispy_movement ();
461 static Lisp_Object
modify_event_symbol ();
462 static Lisp_Object
make_lispy_switch_frame ();
464 /* > 0 if we are to echo keystrokes. */
465 static int echo_keystrokes
;
467 /* Nonzero means echo each character as typed. */
468 static int immediate_echo
;
470 /* The text we're echoing in the modeline - partial key sequences,
471 usually. '\0'-terminated. This really shouldn't have a fixed size. */
472 static char echobuf
[300];
474 /* Where to append more text to echobuf if we want to. */
475 static char *echoptr
;
477 #define min(a,b) ((a)<(b)?(a):(b))
478 #define max(a,b) ((a)>(b)?(a):(b))
480 /* Install the string STR as the beginning of the string of echoing,
481 so that it serves as a prompt for the next character.
482 Also start echoing. */
487 int len
= strlen (str
);
488 if (len
> sizeof echobuf
- 4)
489 len
= sizeof echobuf
- 4;
490 bcopy (str
, echobuf
, len
);
491 echoptr
= echobuf
+ len
;
497 /* Add C to the echo string, if echoing is going on.
498 C can be a character, which is printed prettily ("M-C-x" and all that
499 jazz), or a symbol, whose name is printed. */
504 extern char *push_key_description ();
513 /* If someone has passed us a composite event, use its head symbol. */
516 if (XTYPE (c
) == Lisp_Int
)
518 if (ptr
- echobuf
> sizeof echobuf
- 6)
521 ptr
= push_key_description (XINT (c
), ptr
);
523 else if (XTYPE (c
) == Lisp_Symbol
)
525 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
526 if (((ptr
- echobuf
) + name
->size
+ 4) > sizeof echobuf
)
528 bcopy (name
->data
, ptr
, name
->size
);
532 if (echoptr
== echobuf
&& EQ (c
, Vhelp_char
))
534 strcpy (ptr
, " (Type ? for further options)");
545 /* Temporarily add a dash to the end of the echo string if it's not
546 empty, so that it serves as a mini-prompt for the very next character. */
550 if (!immediate_echo
&& echoptr
== echobuf
)
552 /* Do nothing if not echoing at all. */
556 /* Put a dash at the end of the buffer temporarily,
557 but make it go away when the next character is added. */
564 /* Display the current echo string, and begin echoing if not already
574 for (i
= 0; i
< this_command_key_count
; i
++)
575 echo_char (XVECTOR (this_command_keys
)->contents
[i
]);
583 if (waiting_for_input
&& !NILP (Vquit_flag
))
584 quit_throw_to_read_char ();
587 /* Turn off echoing, for the start of a new command. */
595 /* Return the length of the current echo string. */
600 return echoptr
- echobuf
;
603 /* Truncate the current echo message to its first LEN chars.
604 This and echo_char get used by read_key_sequence when the user
605 switches frames while entering a key sequence. */
612 echoptr
= echobuf
+ len
;
613 truncate_echo_area (len
);
617 /* Functions for manipulating this_command_keys. */
619 add_command_key (key
)
622 int size
= XVECTOR (this_command_keys
)->size
;
624 if (this_command_key_count
>= size
)
626 Lisp_Object new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
628 bcopy (XVECTOR (this_command_keys
)->contents
,
629 XVECTOR (new_keys
)->contents
,
630 size
* sizeof (Lisp_Object
));
632 this_command_keys
= new_keys
;
635 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
641 int count
= specpdl_ptr
- specpdl
;
644 if (command_loop_level
> 0)
646 specbind (Qstandard_output
, Qt
);
647 specbind (Qstandard_input
, Qt
);
650 val
= command_loop ();
652 Fsignal (Qquit
, Qnil
);
654 return unbind_to (count
, Qnil
);
657 /* When an auto-save happens, record the "time", and don't do again soon. */
660 last_auto_save
= num_nonmacro_input_chars
;
663 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
664 "Invoke the editor command loop recursively.\n\
665 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
666 that tells this function to return.\n\
667 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
668 This function is called by the editor initialization to begin editing.")
671 int count
= specpdl_ptr
- specpdl
;
674 command_loop_level
++;
675 update_mode_lines
= 1;
677 record_unwind_protect (recursive_edit_unwind
,
679 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
683 return unbind_to (count
, Qnil
);
687 recursive_edit_unwind (buffer
)
691 Fset_buffer (buffer
);
693 command_loop_level
--;
694 update_mode_lines
= 1;
702 Lisp_Object errmsg
, tail
, errname
, file_error
;
709 Vstandard_output
= Qt
;
710 Vstandard_input
= Qt
;
711 Vexecuting_macro
= Qnil
;
712 echo_area_glyphs
= 0;
714 /* If the window system or terminal frame hasn't been initialized
715 yet, or we're not interactive, it's best to dump this message out
716 to stderr and exit. */
717 if (! FRAME_MESSAGE_BUF (selected_frame
)
719 stream
= Qexternal_debugging_output
;
727 errname
= Fcar (data
);
729 if (EQ (errname
, Qerror
))
732 if (!CONSP (data
)) data
= Qnil
;
733 errmsg
= Fcar (data
);
738 errmsg
= Fget (errname
, Qerror_message
);
739 file_error
= Fmemq (Qfile_error
,
740 Fget (errname
, Qerror_conditions
));
743 /* Print an error message including the data items.
744 This is done by printing it into a scratch buffer
745 and then making a copy of the text in the buffer. */
747 if (!CONSP (data
)) data
= Qnil
;
751 /* For file-error, make error message by concatenating
752 all the data items. They are all strings. */
753 if (!NILP (file_error
) && !NILP (tail
))
754 errmsg
= XCONS (tail
)->car
, tail
= XCONS (tail
)->cdr
;
756 if (XTYPE (errmsg
) == Lisp_String
)
757 Fprinc (errmsg
, stream
);
759 write_string_1 ("peculiar error", -1, stream
);
761 for (i
= 0; CONSP (tail
); tail
= Fcdr (tail
), i
++)
763 write_string_1 (i
? ", " : ": ", 2, stream
);
764 if (!NILP (file_error
))
765 Fprinc (Fcar (tail
), stream
);
767 Fprin1 (Fcar (tail
), stream
);
771 /* If the window system or terminal frame hasn't been initialized
772 yet, or we're in -batch mode, this error should cause Emacs to exit. */
773 if (! FRAME_MESSAGE_BUF (selected_frame
)
777 Fkill_emacs (make_number (-1));
782 Vinhibit_quit
= Qnil
;
783 return make_number (0);
786 Lisp_Object
command_loop_1 ();
787 Lisp_Object
command_loop_2 ();
788 Lisp_Object
top_level_1 ();
790 /* Entry to editor-command-loop.
791 This level has the catches for exiting/returning to editor command loop.
792 It returns nil to exit recursive edit, t to abort it. */
797 if (command_loop_level
> 0 || minibuf_level
> 0)
799 return internal_catch (Qexit
, command_loop_2
, Qnil
);
804 internal_catch (Qtop_level
, top_level_1
, Qnil
);
805 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
807 /* End of file in -batch run causes exit here. */
813 /* Here we catch errors in execution of commands within the
814 editing loop, and reenter the editing loop.
815 When there is an error, cmd_error runs and returns a non-nil
816 value to us. A value of nil means that cmd_loop_1 itself
817 returned due to end of file (or end of kbd macro). */
822 register Lisp_Object val
;
825 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
834 return Feval (Vtop_level
);
840 /* On entry to the outer level, run the startup file */
841 if (!NILP (Vtop_level
))
842 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
843 else if (!NILP (Vpurify_flag
))
844 message ("Bare impure Emacs (standard Lisp code not loaded)");
846 message ("Bare Emacs (standard Lisp code not loaded)");
850 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
851 "Exit all recursive editing levels.")
854 Fthrow (Qtop_level
, Qnil
);
857 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
858 "Exit from the innermost recursive edit or minibuffer.")
861 if (command_loop_level
> 0 || minibuf_level
> 0)
862 Fthrow (Qexit
, Qnil
);
864 error ("No recursive edit is in progress");
867 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
868 "Abort the command that requested this recursive edit or minibuffer input.")
871 if (command_loop_level
> 0 || minibuf_level
> 0)
874 error ("No recursive edit is in progress");
877 /* This is the actual command reading loop,
878 sans error-handling encapsulation. */
880 Lisp_Object
Fcommand_execute ();
881 static int read_key_sequence ();
886 Lisp_Object cmd
, tem
;
889 Lisp_Object keybuf
[30];
894 struct buffer
*prev_buffer
;
897 Vdeactivate_mark
= Qnil
;
898 waiting_for_input
= 0;
901 /* Don't clear out last_command at the beginning of a macro. */
902 if (XTYPE (Vexecuting_macro
) != Lisp_String
)
907 this_command_key_count
= 0;
909 /* Make sure this hook runs after commands that get errors and
910 throw to top level. */
911 if (!NILP (Vpost_command_hook
))
913 /* If we get an error during the post-command-hook,
914 cause post-command-hook to be nil. */
915 Vcommand_hook_internal
= Vpost_command_hook
;
916 Vpost_command_hook
= Qnil
;
918 call1 (Vrun_hooks
, Qcommand_hook_internal
);
920 Vpost_command_hook
= Vcommand_hook_internal
;
925 /* Install chars successfully executed in kbd macro. */
927 if (defining_kbd_macro
&& NILP (Vprefix_arg
))
928 finalize_kbd_macro_chars ();
930 /* Make sure the current window's buffer is selected. */
931 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
932 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
934 /* Display any malloc warning that just came out. Use while because
935 displaying one warning can cause another. */
937 while (pending_malloc_warning
)
938 display_malloc_warning ();
942 Vdeactivate_mark
= Qnil
;
944 /* If minibuffer on and echo area in use,
945 wait 2 sec and redraw minibuffer. */
947 if (minibuf_level
&& echo_area_glyphs
)
949 /* Bind inhibit-quit to t so that C-g gets read in
950 rather than quitting back to the minibuffer. */
951 int count
= specpdl_ptr
- specpdl
;
952 specbind (Qinhibit_quit
, Qt
);
953 Fsit_for (make_number (2), Qnil
, Qnil
);
954 unbind_to (count
, Qnil
);
956 echo_area_glyphs
= 0;
958 if (!NILP (Vquit_flag
))
961 unread_command_events
= Fcons (make_number (quit_char
), Qnil
);
966 alloca (0); /* Cause a garbage collection now */
967 /* Since we can free the most stuff here. */
968 #endif /* C_ALLOCA */
972 /* Select the frame that the last event came from. Usually,
973 switch-frame events will take care of this, but if some lisp
974 code swallows a switch-frame event, we'll fix things up here.
975 Is this a good idea? */
976 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
977 && XFRAME (internal_last_event_frame
) != selected_frame
)
978 Fselect_frame (internal_last_event_frame
, Qnil
);
981 /* If it has changed current-menubar from previous value,
982 really recompute the menubar from the value. */
983 if (! NILP (Vlucid_menu_bar_dirty_flag
)
984 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
985 call0 (Qrecompute_lucid_menubar
);
987 #if 0 /* This is done in xdisp.c now. */
989 for (tem
= Vframe_list
; CONSP (tem
); tem
= XCONS (tem
)->cdr
)
991 struct frame
*f
= XFRAME (XCONS (tem
)->car
);
992 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
994 /* If the user has switched buffers or windows, we need to
995 recompute to reflect the new bindings. But we'll
996 recompute when update_mode_lines is set too; that means
997 that people can use force-mode-line-update to request
998 that the menu bar be recomputed. The adverse effect on
999 the rest of the redisplay algorithm is about the same as
1000 windows_or_buffers_changed anyway. */
1001 if (windows_or_buffers_changed
1002 || update_mode_lines
1003 || (XFASTINT (w
->last_modified
) < MODIFF
1004 && (XFASTINT (w
->last_modified
)
1005 <= XBUFFER (w
->buffer
)->save_modified
)))
1007 struct buffer
*prev
= current_buffer
;
1008 current_buffer
= XBUFFER (w
->buffer
);
1009 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items ();
1010 current_buffer
= prev
;
1013 #endif /* MULTI_FRAME */
1016 /* Read next key sequence; i gets its length. */
1017 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), Qnil
);
1021 /* Now we have read a key sequence of length I,
1022 or else I is 0 and we found end of file. */
1024 if (i
== 0) /* End of file -- happens only in */
1025 return Qnil
; /* a kbd macro, at the end. */
1026 /* -1 means read_key_sequence got a menu that was rejected.
1027 Just loop around and read another command. */
1031 this_command_key_count
= 0;
1035 last_command_char
= keybuf
[i
- 1];
1037 /* If the previous command tried to force a specific window-start,
1038 forget about that, in case this command moves point far away
1039 from that position. */
1040 XWINDOW (selected_window
)->force_start
= Qnil
;
1042 cmd
= read_key_sequence_cmd
;
1043 if (!NILP (Vexecuting_macro
))
1045 if (!NILP (Vquit_flag
))
1047 Vexecuting_macro
= Qt
;
1048 QUIT
; /* Make some noise. */
1049 /* Will return since macro now empty. */
1053 /* Do redisplay processing after this command except in special
1054 cases identified below that set no_redisplay to 1.
1055 (actually, there's currently no way to prevent the redisplay,
1056 and no_redisplay is ignored.
1057 Perhaps someday we will really implement it. */
1060 prev_buffer
= current_buffer
;
1061 prev_modiff
= MODIFF
;
1063 /* Execute the command. */
1066 if (!NILP (Vpre_command_hook
))
1068 /* If we get an error during the pre-command-hook,
1069 cause pre-command-hook to be nil. */
1070 Vcommand_hook_internal
= Vpre_command_hook
;
1071 Vpre_command_hook
= Qnil
;
1073 call1 (Vrun_hooks
, Qcommand_hook_internal
);
1075 Vpre_command_hook
= Vcommand_hook_internal
;
1078 if (NILP (this_command
))
1080 /* nil means key is undefined. */
1082 defining_kbd_macro
= 0;
1083 update_mode_lines
= 1;
1089 if (NILP (Vprefix_arg
) && ! no_direct
)
1091 /* Recognize some common commands in common situations and
1092 do them directly. */
1093 if (EQ (this_command
, Qforward_char
) && point
< ZV
)
1095 struct Lisp_Vector
*dp
1096 = window_display_table (XWINDOW (selected_window
));
1097 lose
= FETCH_CHAR (point
);
1100 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
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
, Qbackward_char
) && point
> BEGV
)
1116 struct Lisp_Vector
*dp
1117 = window_display_table (XWINDOW (selected_window
));
1119 lose
= FETCH_CHAR (point
);
1121 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1122 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1123 : (lose
>= 0x20 && lose
< 0x7f))
1124 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1126 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1128 && !windows_or_buffers_changed
1129 && EQ (current_buffer
->selective_display
, Qnil
)
1130 && !detect_input_pending ()
1131 && NILP (Vexecuting_macro
))
1132 no_redisplay
= direct_output_forward_char (-1);
1135 else if (EQ (this_command
, Qself_insert_command
)
1136 /* Try this optimization only on ascii keystrokes. */
1137 && XTYPE (last_command_char
) == Lisp_Int
)
1139 unsigned char c
= XINT (last_command_char
);
1141 if (NILP (Vexecuting_macro
) &&
1142 !EQ (minibuf_window
, selected_window
))
1144 if (!nonundocount
|| nonundocount
>= 20)
1151 lose
= (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1153 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1155 || MODIFF
<= current_buffer
->save_modified
1156 || windows_or_buffers_changed
1157 || !EQ (current_buffer
->selective_display
, Qnil
)
1158 || detect_input_pending ()
1159 || !NILP (Vexecuting_macro
);
1160 if (internal_self_insert (c
, 0))
1166 (point
== ZV
|| FETCH_CHAR (point
) == '\n'))
1168 struct Lisp_Vector
*dp
1169 = window_display_table (XWINDOW (selected_window
));
1174 Lisp_Object obj
= DISP_CHAR_VECTOR (dp
, lose
);
1176 if (XTYPE (obj
) == Lisp_Vector
1177 && XVECTOR (obj
)->size
== 1
1178 && (XTYPE (obj
= XVECTOR (obj
)->contents
[0])
1181 direct_output_for_insert (XINT (obj
));
1185 if (lose
>= 0x20 && lose
<= 0x7e)
1186 no_redisplay
= direct_output_for_insert (lose
);
1193 /* Here for a command that isn't executed directly */
1196 if (NILP (Vprefix_arg
))
1198 Fcommand_execute (this_command
, Qnil
);
1203 if (!NILP (Vpost_command_hook
))
1205 /* If we get an error during the post-command-hook,
1206 cause post-command-hook to be nil. */
1207 Vcommand_hook_internal
= Vpost_command_hook
;
1208 Vpost_command_hook
= Qnil
;
1210 call1 (Vrun_hooks
, Qcommand_hook_internal
);
1212 Vpost_command_hook
= Vcommand_hook_internal
;
1215 /* If there is a prefix argument,
1216 1) We don't want last_command to be ``universal-argument''
1217 (that would be dumb), so don't set last_command,
1218 2) we want to leave echoing on so that the prefix will be
1219 echoed as part of this key sequence, so don't call
1221 3) we want to leave this_command_key_count non-zero, so that
1222 read_char will realize that it is re-reading a character, and
1223 not echo it a second time. */
1224 if (NILP (Vprefix_arg
))
1226 last_command
= this_command
;
1228 this_command_key_count
= 0;
1231 if (!NILP (current_buffer
->mark_active
))
1233 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1235 current_buffer
->mark_active
= Qnil
;
1236 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1238 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1239 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1244 /* Number of seconds between polling for input. */
1247 /* Nonzero means polling for input is temporarily suppressed. */
1248 int poll_suppress_count
;
1250 #ifdef POLL_FOR_INPUT
1251 int polling_for_input
;
1253 /* Handle an alarm once each second and read pending input
1254 so as to handle a C-g if it comces in. */
1257 input_poll_signal ()
1259 if (interrupt_input_blocked
== 0
1260 && !waiting_for_input
)
1261 read_avail_input (0);
1262 signal (SIGALRM
, input_poll_signal
);
1263 alarm (polling_period
);
1268 /* Begin signals to poll for input, if they are appropriate.
1269 This function is called unconditionally from various places. */
1273 #ifdef POLL_FOR_INPUT
1274 if (read_socket_hook
&& !interrupt_input
)
1276 poll_suppress_count
--;
1277 if (poll_suppress_count
== 0)
1279 signal (SIGALRM
, input_poll_signal
);
1280 polling_for_input
= 1;
1281 alarm (polling_period
);
1287 /* Turn off polling. */
1291 #ifdef POLL_FOR_INPUT
1292 if (read_socket_hook
&& !interrupt_input
)
1294 if (poll_suppress_count
== 0)
1296 polling_for_input
= 0;
1299 poll_suppress_count
++;
1304 /* Set the value of poll_suppress_count to COUNT
1305 and start or stop polling accordingly. */
1308 set_poll_suppress_count (count
)
1311 #ifdef POLL_FOR_INPUT
1312 if (count
== 0 && poll_suppress_count
!= 0)
1314 poll_suppress_count
= 1;
1317 else if (count
!= 0 && poll_suppress_count
== 0)
1321 poll_suppress_count
= count
;
1325 /* Applying the control modifier to CHARACTER. */
1330 /* Save the upper bits here. */
1331 int upper
= c
& ~0177;
1335 /* Everything in the columns containing the upper-case letters
1336 denotes a control character. */
1337 if (c
>= 0100 && c
< 0140)
1341 /* Set the shift modifier for a control char
1342 made from a shifted letter. But only for letters! */
1343 if (oc
>= 'A' && oc
<= 'Z')
1344 c
|= shift_modifier
;
1347 /* The lower-case letters denote control characters too. */
1348 else if (c
>= 'a' && c
<= 'z')
1351 /* Include the bits for control and shift
1352 only if the basic ASCII code can't indicate them. */
1356 /* Replace the high bits. */
1357 c
|= (upper
& ~ctrl_modifier
);
1364 /* Input of single characters from keyboard */
1366 Lisp_Object
print_help ();
1367 static Lisp_Object
kbd_buffer_get_event ();
1369 /* read a character from the keyboard; call the redisplay if needed */
1370 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1371 -1 means do not do redisplay, but do do autosaving.
1374 /* The arguments MAPS and NMAPS are for menu prompting.
1375 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1377 PREV_EVENT is the previous input event, or nil if we are reading
1378 the first event of a key sequence.
1380 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1381 if we used a mouse menu to read the input, or zero otherwise. If
1382 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
1384 Value is t if we showed a menu and the user rejected it. */
1387 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1391 Lisp_Object prev_event
;
1392 int *used_mouse_menu
;
1394 register Lisp_Object c
;
1398 if (CONSP (unread_command_events
))
1400 c
= XCONS (unread_command_events
)->car
;
1401 unread_command_events
= XCONS (unread_command_events
)->cdr
;
1403 if (this_command_key_count
== 0)
1409 if (unread_command_char
!= -1)
1411 XSET (c
, Lisp_Int
, unread_command_char
);
1412 unread_command_char
= -1;
1414 if (this_command_key_count
== 0)
1420 if (!NILP (Vexecuting_macro
))
1423 /* We set this to Qmacro; since that's not a frame, nobody will
1424 try to switch frames on us, and the selected window will
1427 Since this event came from a macro, it would be misleading to
1428 leave internal_last_event_frame set to wherever the last
1429 real event came from. Normally, a switch-frame event selects
1430 internal_last_event_frame after each command is read, but
1431 events read from a macro should never cause a new frame to be
1433 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1436 /* Exit the macro if we are at the end.
1437 Also, some things replace the macro with t
1438 to force an early exit. */
1439 if (EQ (Vexecuting_macro
, Qt
)
1440 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1442 XSET (c
, Lisp_Int
, -1);
1446 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1447 if (XTYPE (Vexecuting_macro
) == Lisp_String
1448 && (XINT (c
) & 0x80))
1449 XFASTINT (c
) = CHAR_META
| (XINT (c
) & ~0x80);
1451 executing_macro_index
++;
1456 if (!NILP (unread_switch_frame
))
1458 c
= unread_switch_frame
;
1459 unread_switch_frame
= Qnil
;
1461 /* This event should make it into this_command_keys, and get echoed
1462 again, so we go to reread_first, rather than reread. */
1466 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1467 prepare_menu_bars ();
1469 /* Save outer setjmp data, in case called recursively. */
1470 save_getcjmp (save_jump
);
1474 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1477 if (_setjmp (getcjmp
))
1479 XSET (c
, Lisp_Int
, quit_char
);
1481 XSET (internal_last_event_frame
, Lisp_Frame
, selected_frame
);
1482 Vlast_event_frame
= internal_last_event_frame
;
1484 /* If we report the quit char as an event,
1485 don't do so more than once. */
1486 if (!NILP (Vinhibit_quit
))
1492 /* Message turns off echoing unless more keystrokes turn it on again. */
1493 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1496 /* If already echoing, continue. */
1499 /* Try reading a character via menu prompting in the minibuf.
1500 Try this before the sit-for, because the sit-for
1501 would do the wrong thing if we are supposed to do
1502 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1503 after a mouse event so don't try a minibuf menu. */
1505 if (nmaps
> 0 && INTERACTIVE
&&
1506 !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
))
1508 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1509 if ( ! NILP(c
) ) return c
;
1512 /* If in middle of key sequence and minibuffer not active,
1513 start echoing if enough time elapses. */
1514 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1516 && echo_keystrokes
> 0
1517 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1521 /* After a mouse event, start echoing right away.
1522 This is because we are probably about to display a menu,
1523 and we don't want to delay before doing so. */
1524 if (EVENT_HAS_PARAMETERS (prev_event
))
1528 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1534 /* Maybe auto save due to number of keystrokes or idle time. */
1536 if (commandflag
!= 0
1537 && auto_save_interval
> 0
1538 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1539 && !detect_input_pending ())
1542 save_getcjmp (temp
);
1543 Fdo_auto_save (Qnil
, Qnil
);
1544 restore_getcjmp (temp
);
1547 /* Try reading using an X menu.
1548 This is never confused with reading using the minibuf because the recursive
1549 call of read_char in read_char_minibuf_menu_prompt does not pass on
1551 if (nmaps
> 0 && INTERACTIVE
&&
1552 !NILP (prev_event
) && EVENT_HAS_PARAMETERS (prev_event
))
1553 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1555 /* Slow down auto saves logarithmically in size of current buffer,
1556 and garbage collect while we're at it. */
1557 if (INTERACTIVE
&& NILP (c
))
1559 int delay_level
, buffer_size
;
1561 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1562 last_non_minibuf_size
= Z
- BEG
;
1563 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1565 while (buffer_size
> 64)
1566 delay_level
++, buffer_size
-= buffer_size
>> 2;
1567 if (delay_level
< 4) delay_level
= 4;
1568 /* delay_level is 4 for files under around 50k, 7 at 100k,
1569 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1571 /* Auto save if enough time goes by without input. */
1572 if (commandflag
!= 0
1573 && num_nonmacro_input_chars
> last_auto_save
1574 && XTYPE (Vauto_save_timeout
) == Lisp_Int
1575 && XINT (Vauto_save_timeout
) > 0)
1578 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1579 tem0
= sit_for (delay
, 0, 1, 1);
1583 save_getcjmp (temp
);
1584 Fdo_auto_save (Qnil
, Qnil
);
1585 restore_getcjmp (temp
);
1587 /* If we have auto-saved and there is still no input
1588 available, garbage collect if there has been enough
1589 consing going on to make it worthwhile. */
1590 if (!detect_input_pending ()
1591 && consing_since_gc
> gc_cons_threshold
/ 2)
1593 Fgarbage_collect ();
1594 /* prepare_menu_bars isn't safe here, but it should
1595 also be unnecessary. */
1602 /* Actually read a character, waiting if necessary. */
1605 c
= kbd_buffer_get_event ();
1608 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1612 /* Terminate Emacs in batch mode if at eof. */
1613 if (noninteractive
&& XTYPE (c
) == Lisp_Int
&& XINT (c
) < 0)
1614 Fkill_emacs (make_number (1));
1616 if (XTYPE (c
) == Lisp_Int
)
1618 /* Add in any extra modifiers, where appropriate. */
1619 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1620 || ((extra_keyboard_modifiers
& 0177) < ' '
1621 && (extra_keyboard_modifiers
& 0177) != 0))
1622 XSETINT (c
, make_ctrl_char (XINT (c
)));
1624 /* Transfer any other modifier bits directly from
1625 extra_keyboard_modifiers to c. Ignore the actual character code
1626 in the low 16 bits of extra_keyboard_modifiers. */
1627 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
1632 restore_getcjmp (save_jump
);
1636 echo_area_glyphs
= 0;
1638 /* Handle things that only apply to characters. */
1639 if (XTYPE (c
) == Lisp_Int
)
1641 /* If kbd_buffer_get_event gave us an EOF, return that. */
1645 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
1646 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1647 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1651 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1652 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1653 recent_keys_index
= 0;
1655 /* Write c to the dribble file. If c is a lispy event, write
1656 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1657 If you, dear reader, have a better idea, you've got the source. :-) */
1660 if (XTYPE (c
) == Lisp_Int
)
1661 putc (XINT (c
), dribble
);
1664 Lisp_Object dribblee
= c
;
1666 /* If it's a structured event, take the event header. */
1667 dribblee
= EVENT_HEAD (dribblee
);
1669 if (XTYPE (dribblee
) == Lisp_Symbol
)
1671 putc ('<', dribble
);
1672 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1673 XSYMBOL (dribblee
)->name
->size
,
1675 putc ('>', dribble
);
1682 store_kbd_macro_char (c
);
1684 num_nonmacro_input_chars
++;
1689 /* Record this character as part of the current key.
1690 Don't record mouse motion; it should never matter. */
1691 if (! (EVENT_HAS_PARAMETERS (c
)
1692 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1695 add_command_key (c
);
1698 /* Re-reading in the middle of a command */
1700 last_input_char
= c
;
1703 /* Process the help character specially if enabled */
1704 if (EQ (c
, Vhelp_char
) && !NILP (Vhelp_form
))
1707 count
= specpdl_ptr
- specpdl
;
1709 record_unwind_protect (Fset_window_configuration
,
1710 Fcurrent_window_configuration (Qnil
));
1712 tem0
= Feval (Vhelp_form
);
1713 if (XTYPE (tem0
) == Lisp_String
)
1714 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1718 c
= read_char (0, 0, 0, Qnil
, 0);
1719 while (XTYPE (c
) == Lisp_Buffer
);
1720 /* Remove the help from the frame */
1721 unbind_to (count
, Qnil
);
1722 prepare_menu_bars ();
1724 if (EQ (c
, make_number (040)))
1728 c
= read_char (0, 0, 0, Qnil
, 0);
1729 while (XTYPE (c
) == Lisp_Buffer
);
1740 Fprinc (object
, Qnil
);
1744 /* Copy out or in the info on where C-g should throw to.
1745 This is used when running Lisp code from within get_char,
1746 in case get_char is called recursively.
1747 See read_process_output. */
1752 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1755 restore_getcjmp (temp
)
1758 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1762 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1763 of this function. */
1765 tracking_off (old_value
)
1766 Lisp_Object old_value
;
1768 if (! XFASTINT (old_value
))
1770 do_mouse_tracking
= 0;
1772 /* Redisplay may have been preempted because there was input
1773 available, and it assumes it will be called again after the
1774 input has been processed. If the only input available was
1775 the sort that we have just disabled, then we need to call
1777 if (!readable_events ())
1779 prepare_menu_bars ();
1780 redisplay_preserve_echo_area ();
1781 get_input_pending (&input_pending
);
1786 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1787 "Evaluate BODY with mouse movement events enabled.\n\
1788 Within a `track-mouse' form, mouse motion generates input events that\n\
1789 you can read with `read-event'.\n\
1790 Normally, mouse motion is ignored.")
1794 int count
= specpdl_ptr
- specpdl
;
1797 XSET (val
, Lisp_Int
, do_mouse_tracking
);
1798 record_unwind_protect (tracking_off
, val
);
1800 do_mouse_tracking
= 1;
1802 val
= Fprogn (args
);
1803 return unbind_to (count
, val
);
1806 /* Low level keyboard/mouse input.
1807 kbd_buffer_store_event places events in kbd_buffer, and
1808 kbd_buffer_get_event retrieves them.
1809 mouse_moved indicates when the mouse has moved again, and
1810 *mouse_position_hook provides the mouse position. */
1812 /* Return true iff there are any events in the queue that read-char
1813 would return. If this returns false, a read-char would block. */
1817 return ! EVENT_QUEUES_EMPTY
;
1820 /* Set this for debugging, to have a way to get out */
1823 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
1826 kbd_buffer_store_event (event
)
1827 register struct input_event
*event
;
1829 if (event
->kind
== no_event
)
1832 if (event
->kind
== ascii_keystroke
)
1834 register int c
= event
->code
& 0377;
1836 if (event
->modifiers
& ctrl_modifier
)
1837 c
= make_ctrl_char (c
);
1839 c
|= (event
->modifiers
1840 & (meta_modifier
| alt_modifier
1841 | hyper_modifier
| super_modifier
));
1845 extern SIGTYPE
interrupt_signal ();
1848 /* If this results in a quit_char being returned to Emacs as
1849 input, set Vlast_event_frame properly. If this doesn't
1850 get returned to Emacs as an event, the next event read
1851 will set Vlast_event_frame again, so this is safe to do. */
1854 = FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
1857 internal_last_event_frame
= event
->frame_or_window
;
1859 internal_last_event_frame
= focus
;
1860 Vlast_event_frame
= internal_last_event_frame
;
1864 last_event_timestamp
= event
->timestamp
;
1865 interrupt_signal ();
1869 if (c
&& c
== stop_character
)
1876 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
1877 kbd_store_ptr
= kbd_buffer
;
1879 /* Don't let the very last slot in the buffer become full,
1880 since that would make the two pointers equal,
1881 and that is indistinguishable from an empty buffer.
1882 Discard the event if it would fill the last slot. */
1883 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
1885 kbd_store_ptr
->kind
= event
->kind
;
1886 if (event
->kind
== selection_request_event
)
1888 /* We must not use the ordinary copying code for this case,
1889 since `part' is an enum and copying it might not copy enough
1891 bcopy (event
, kbd_store_ptr
, sizeof (*event
));
1895 kbd_store_ptr
->code
= event
->code
;
1896 kbd_store_ptr
->part
= event
->part
;
1897 kbd_store_ptr
->frame_or_window
= event
->frame_or_window
;
1898 kbd_store_ptr
->modifiers
= event
->modifiers
;
1899 kbd_store_ptr
->x
= event
->x
;
1900 kbd_store_ptr
->y
= event
->y
;
1901 kbd_store_ptr
->timestamp
= event
->timestamp
;
1903 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
1905 = event
->frame_or_window
);
1911 /* Read one event from the event buffer, waiting if necessary.
1912 The value is a Lisp object representing the event.
1913 The value is nil for an event that should be ignored,
1914 or that was handled here.
1915 We always read and discard one event. */
1918 kbd_buffer_get_event ()
1926 XSET (obj
, Lisp_Int
, c
);
1930 /* Wait until there is input available. */
1933 if (!EVENT_QUEUES_EMPTY
)
1936 /* If the quit flag is set, then read_char will return
1937 quit_char, so that counts as "available input." */
1938 if (!NILP (Vquit_flag
))
1939 quit_throw_to_read_char ();
1941 /* One way or another, wait until input is available; then, if
1942 interrupt handlers have not read it, read it now. */
1945 wait_for_kbd_input ();
1947 /* Note SIGIO has been undef'd if FIONREAD is missing. */
1951 if (EVENT_QUEUES_EMPTY
)
1953 Lisp_Object minus_one
;
1955 XSET (minus_one
, Lisp_Int
, -1);
1956 wait_reading_process_input (0, 0, minus_one
, 1);
1958 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
1959 /* Pass 1 for EXPECT since we just waited to have input. */
1960 read_avail_input (1);
1962 #endif /* not VMS */
1965 /* At this point, we know that there is a readable event available
1966 somewhere. If the event queue is empty, then there must be a
1967 mouse movement enabled and available. */
1968 if (kbd_fetch_ptr
!= kbd_store_ptr
)
1970 struct input_event
*event
;
1972 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
1976 last_event_timestamp
= event
->timestamp
;
1980 /* These two kinds of events get special handling
1981 and don't actually appear to the command loop.
1982 We return nil for them. */
1983 if (event
->kind
== selection_request_event
)
1986 x_handle_selection_request (event
);
1987 kbd_fetch_ptr
= event
+ 1;
1989 /* We're getting selection request events, but we don't have
1995 else if (event
->kind
== selection_clear_event
)
1998 x_handle_selection_clear (event
);
1999 kbd_fetch_ptr
= event
+ 1;
2001 /* We're getting selection request events, but we don't have
2007 else if (event
->kind
== delete_window_event
)
2009 Lisp_Object tail
, frame
;
2012 /* If the user destroys the only frame, Emacs should exit.
2013 Count visible frames and iconified frames. */
2014 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2016 frame
= XCONS (tail
)->car
;
2017 if (XTYPE (frame
) != Lisp_Frame
|| EQ (frame
, event
->frame_or_window
))
2020 if (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
))
2027 Fdelete_frame (event
->frame_or_window
, Qt
);
2028 kbd_fetch_ptr
= event
+ 1;
2031 /* Just discard these, by returning nil.
2032 (They shouldn't be found in the buffer,
2033 but on some machines it appears they do show up.) */
2034 else if (event
->kind
== no_event
)
2035 kbd_fetch_ptr
= event
+ 1;
2037 /* If this event is on a different frame, return a switch-frame this
2038 time, and leave the event in the queue for next time. */
2042 Lisp_Object frame
= event
->frame_or_window
;
2045 if (XTYPE (frame
) == Lisp_Window
)
2046 frame
= WINDOW_FRAME (XWINDOW (frame
));
2048 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2052 if (! EQ (frame
, internal_last_event_frame
)
2053 && XFRAME (frame
) != selected_frame
)
2054 obj
= make_lispy_switch_frame (frame
);
2055 internal_last_event_frame
= frame
;
2056 #endif /* MULTI_FRAME */
2058 /* If we didn't decide to make a switch-frame event, go ahead
2059 and build a real event from the queue entry. */
2063 obj
= make_lispy_event (event
);
2065 /* Wipe out this event, to catch bugs. */
2066 event
->kind
= no_event
;
2067 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
2070 kbd_fetch_ptr
= event
+ 1;
2074 /* Try generating a mouse motion event. */
2075 else if (do_mouse_tracking
&& mouse_moved
)
2078 Lisp_Object bar_window
;
2079 enum scroll_bar_part part
;
2083 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
2088 /* Decide if we should generate a switch-frame event. Don't
2089 generate switch-frame events for motion outside of all Emacs
2093 Lisp_Object frame
= FRAME_FOCUS_FRAME (f
);
2096 XSET (frame
, Lisp_Frame
, f
);
2098 if (! EQ (frame
, internal_last_event_frame
)
2099 && XFRAME (frame
) != selected_frame
)
2100 obj
= make_lispy_switch_frame (frame
);
2101 internal_last_event_frame
= frame
;
2105 /* If we didn't decide to make a switch-frame event, go ahead and
2106 return a mouse-motion event. */
2108 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2111 /* We were promised by the above while loop that there was
2112 something for us to read! */
2115 input_pending
= readable_events ();
2118 Vlast_event_frame
= internal_last_event_frame
;
2124 /* Process any events that are not user-visible,
2125 then return, without reading any user-visible events. */
2130 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2132 struct input_event
*event
;
2134 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2138 last_event_timestamp
= event
->timestamp
;
2140 /* These two kinds of events get special handling
2141 and don't actually appear to the command loop. */
2142 if (event
->kind
== selection_request_event
)
2145 x_handle_selection_request (event
);
2146 kbd_fetch_ptr
= event
+ 1;
2148 /* We're getting selection request events, but we don't have
2154 else if (event
->kind
== selection_clear_event
)
2157 x_handle_selection_clear (event
);
2158 kbd_fetch_ptr
= event
+ 1;
2160 /* We're getting selection request events, but we don't have
2169 get_input_pending (&input_pending
);
2172 /* Caches for modify_event_symbol. */
2173 static Lisp_Object accent_key_syms
;
2174 static Lisp_Object vendor_key_syms
;
2175 static Lisp_Object func_key_syms
;
2176 static Lisp_Object mouse_syms
;
2178 Lisp_Object Vvendor_key_alist
;
2180 /* This is a list of keysym codes for special "accent" characters.
2181 It parallels lispy_accent_keys. */
2183 static int lispy_accent_codes
[] =
2185 #ifdef XK_dead_circumflex
2190 #ifdef XK_dead_grave
2195 #ifdef XK_dead_tilde
2200 #ifdef XK_dead_diaeresis
2205 #ifdef XK_dead_macron
2210 #ifdef XK_dead_degree
2215 #ifdef XK_dead_acute
2220 #ifdef XK_dead_cedilla
2225 #ifdef XK_dead_breve
2230 #ifdef XK_dead_ogonek
2235 #ifdef XK_dead_caron
2240 #ifdef XK_dead_doubleacute
2241 XK_dead_doubleacute
,
2245 #ifdef XK_dead_abovedot
2252 /* This is a list of Lisp names for special "accent" characters.
2253 It parallels lispy_accent_codes. */
2255 static char *lispy_accent_keys
[] =
2272 /* You'll notice that this table is arranged to be conveniently
2273 indexed by X Windows keysym values. */
2274 static char *lispy_function_keys
[] =
2276 /* X Keysym value */
2278 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2286 0, 0, 0, /* 0xff10 */
2288 0, 0, 0, 0, 0, 0, 0,
2291 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2292 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2293 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2295 "home", /* 0xff50 */ /* IsCursorKey */
2306 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2317 "break", /* 0xff6b */
2319 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2321 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2322 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2323 0, 0, 0, 0, 0, 0, 0, 0,
2324 "kp-tab", /* 0xff89 */
2326 "kp-enter", /* 0xff8d */
2328 "kp-f1", /* 0xff91 */
2333 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2334 "kp-multiply", /* 0xffaa */
2339 "kp-divide", /* 0xffaf */
2340 "kp-0", /* 0xffb0 */
2341 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2344 "kp-equal", /* 0xffbd */
2345 "f1", /* 0xffbe */ /* IsFunctionKey */
2347 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2348 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2349 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2350 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2351 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2352 0, 0, 0, 0, 0, 0, 0, 0,
2353 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2354 0, 0, 0, 0, 0, 0, 0, "delete"
2357 static char *lispy_mouse_names
[] =
2359 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2362 /* Scroll bar parts. */
2363 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2365 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2366 Lisp_Object
*scroll_bar_parts
[] = {
2367 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2371 /* A vector, indexed by button number, giving the down-going location
2372 of currently depressed buttons, both scroll bar and non-scroll bar.
2374 The elements have the form
2375 (BUTTON-NUMBER MODIFIER-MASK . REST)
2376 where REST is the cdr of a position as it would be reported in the event.
2378 The make_lispy_event function stores positions here to tell the
2379 difference between click and drag events, and to store the starting
2380 location to be included in drag events. */
2382 static Lisp_Object button_down_location
;
2384 /* Information about the most recent up-going button event: Which
2385 button, what location, and what time. */
2387 static int last_mouse_button
;
2388 static int last_mouse_x
;
2389 static int last_mouse_y
;
2390 static unsigned long button_down_time
;
2392 /* The maximum time between clicks to make a double-click,
2393 or Qnil to disable double-click detection,
2394 or Qt for no time limit. */
2395 Lisp_Object Vdouble_click_time
;
2397 /* The number of clicks in this multiple-click. */
2399 int double_click_count
;
2401 #ifdef USE_X_TOOLKIT
2402 extern Lisp_Object
map_event_to_object ();
2403 #endif /* USE_X_TOOLKIT */
2405 /* Given a struct input_event, build the lisp event which represents
2406 it. If EVENT is 0, build a mouse movement event from the mouse
2407 movement buffer, which should have a movement event in it.
2409 Note that events must be passed to this function in the order they
2410 are received; this function stores the location of button presses
2411 in order to build drag events when the button is released. */
2414 make_lispy_event (event
)
2415 struct input_event
*event
;
2419 #ifdef SWITCH_ENUM_BUG
2420 switch ((int) event
->kind
)
2422 switch (event
->kind
)
2425 /* A simple keystroke. */
2426 case ascii_keystroke
:
2428 int c
= event
->code
& 0377;
2429 /* Turn ASCII characters into control characters
2431 if (event
->modifiers
& ctrl_modifier
)
2432 c
= make_ctrl_char (c
);
2434 /* Add in the other modifier bits. We took care of ctrl_modifier
2435 just above, and the shift key was taken care of by the X code,
2436 and applied to control characters by make_ctrl_char. */
2437 c
|= (event
->modifiers
2438 & (meta_modifier
| alt_modifier
2439 | hyper_modifier
| super_modifier
));
2440 button_down_time
= 0;
2444 /* A function key. The symbol may need to have modifier prefixes
2446 case non_ascii_keystroke
:
2447 button_down_time
= 0;
2449 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
2450 if (event
->code
== lispy_accent_codes
[i
])
2451 return modify_event_symbol (i
,
2453 Qfunction_key
, Qnil
,
2454 lispy_accent_keys
, &accent_key_syms
,
2455 (sizeof (lispy_accent_keys
)
2456 / sizeof (lispy_accent_keys
[0])));
2458 /* Handle vendor-specific keysyms. */
2459 if (event
->code
& (1 << 28))
2461 /* We need to use an alist rather than a vector as the cache
2462 since we can't make a vector long enuf. */
2463 if (NILP (vendor_key_syms
))
2464 vendor_key_syms
= Fcons (Qnil
, Qnil
);
2465 return modify_event_symbol (event
->code
& 0xffffff,
2467 Qfunction_key
, Vvendor_key_alist
,
2468 0, &vendor_key_syms
, 0xffffff);
2471 return modify_event_symbol (event
->code
- 0xff00,
2473 Qfunction_key
, Qnil
,
2474 lispy_function_keys
, &func_key_syms
,
2475 (sizeof (lispy_function_keys
)
2476 / sizeof (lispy_function_keys
[0])));
2479 /* A mouse click. Figure out where it is, decide whether it's
2480 a press, click or drag, and build the appropriate structure. */
2482 case scroll_bar_click
:
2484 int button
= event
->code
;
2486 Lisp_Object position
;
2487 Lisp_Object
*start_pos_ptr
;
2488 Lisp_Object start_pos
;
2490 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2493 /* Build the position as appropriate for this mouse click. */
2494 if (event
->kind
== mouse_click
)
2497 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2499 = window_from_coordinates (f
, XINT (event
->x
), XINT (event
->y
),
2503 #ifdef USE_X_TOOLKIT
2504 if (FRAME_EXTERNAL_MENU_BAR (f
) && XINT (event
->y
) == -1)
2506 if (XINT (event
->y
) < FRAME_MENU_BAR_LINES (f
))
2509 #ifdef USE_X_TOOLKIT
2510 /* The click happened in the menubar.
2511 Look for the menu item selected. */
2512 Lisp_Object items
= map_event_to_object(event
, f
);
2513 XFASTINT (event
->y
) = 1;
2514 #else /* not USE_X_TOOLKIT */
2517 items
= FRAME_MENU_BAR_ITEMS (f
);
2518 for (; CONSP (items
); items
= XCONS (items
)->cdr
)
2520 Lisp_Object pos
, string
;
2521 pos
= Fcdr (Fcdr (Fcar (items
)));
2522 string
= Fcar (Fcdr (Fcar (items
)));
2523 if (XINT (event
->x
) >= XINT (pos
)
2524 && XINT (event
->x
) < XINT (pos
) + XSTRING (string
)->size
)
2527 #endif /* not USE_X_TOOLKIT */
2529 = Fcons (event
->frame_or_window
,
2531 Fcons (Fcons (event
->x
, event
->y
),
2532 Fcons (make_number (event
->timestamp
),
2536 return Fcons (Fcar (Fcar (items
)),
2537 Fcons (position
, Qnil
));
2539 return Fcons (Qnil
, Fcons (position
, Qnil
));
2541 else if (XTYPE (window
) != Lisp_Window
)
2546 (XINT (event
->x
) - XINT (XWINDOW (window
)->left
)));
2548 (XINT (event
->y
) - XINT (XWINDOW (window
)->top
)));
2553 posn
= Qvertical_line
;
2555 XSET (posn
, Lisp_Int
,
2556 buffer_posn_from_coords (XWINDOW (window
),
2564 Fcons (Fcons (event
->x
, event
->y
),
2565 Fcons (make_number (event
->timestamp
),
2570 Lisp_Object window
= event
->frame_or_window
;
2571 Lisp_Object portion_whole
= Fcons (event
->x
, event
->y
);
2572 Lisp_Object part
= *scroll_bar_parts
[(int) event
->part
];
2576 Fcons (Qvertical_scroll_bar
,
2577 Fcons (portion_whole
,
2578 Fcons (make_number (event
->timestamp
),
2583 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2585 start_pos
= *start_pos_ptr
;
2586 *start_pos_ptr
= Qnil
;
2588 is_double
= (button
== last_mouse_button
2589 && XINT (event
->x
) == last_mouse_x
2590 && XINT (event
->y
) == last_mouse_y
2591 && button_down_time
!= 0
2592 && (EQ (Vdouble_click_time
, Qt
)
2593 || (INTEGERP (Vdouble_click_time
)
2594 && ((int)(event
->timestamp
- button_down_time
)
2595 < XINT (Vdouble_click_time
)))));
2596 last_mouse_button
= button
;
2597 last_mouse_x
= XINT (event
->x
);
2598 last_mouse_y
= XINT (event
->y
);
2600 /* If this is a button press, squirrel away the location, so
2601 we can decide later whether it was a click or a drag. */
2602 if (event
->modifiers
& down_modifier
)
2606 double_click_count
++;
2607 event
->modifiers
|= ((double_click_count
> 2)
2612 double_click_count
= 1;
2613 button_down_time
= event
->timestamp
;
2614 *start_pos_ptr
= Fcopy_alist (position
);
2617 /* Now we're releasing a button - check the co-ordinates to
2618 see if this was a click or a drag. */
2619 else if (event
->modifiers
& up_modifier
)
2621 /* If we did not see a down before this up,
2622 ignore the up. Probably this happened because
2623 the down event chose a menu item.
2624 It would be an annoyance to treat the release
2625 of the button that chose the menu item
2626 as a separate event. */
2628 if (XTYPE (start_pos
) != Lisp_Cons
)
2631 event
->modifiers
&= ~up_modifier
;
2632 #if 0 /* Formerly we treated an up with no down as a click event. */
2633 if (XTYPE (start_pos
) != Lisp_Cons
)
2634 event
->modifiers
|= click_modifier
;
2638 /* The third element of every position should be the (x,y)
2640 Lisp_Object down
= Fnth (make_number (2), start_pos
);
2642 if (EQ (event
->x
, XCONS (down
)->car
)
2643 && EQ (event
->y
, XCONS (down
)->cdr
))
2645 if (is_double
&& double_click_count
> 1)
2646 event
->modifiers
|= ((double_click_count
> 2)
2650 event
->modifiers
|= click_modifier
;
2654 button_down_time
= 0;
2655 event
->modifiers
|= drag_modifier
;
2660 /* Every mouse event should either have the down_modifier or
2661 the up_modifier set. */
2665 /* Get the symbol we should use for the mouse click. */
2667 = modify_event_symbol (button
,
2670 lispy_mouse_names
, &mouse_syms
,
2671 (sizeof (lispy_mouse_names
)
2672 / sizeof (lispy_mouse_names
[0])));
2674 if (event
->modifiers
& drag_modifier
)
2679 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2682 Fcons (make_number (double_click_count
),
2691 /* The 'kind' field of the event is something we don't recognize. */
2698 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2700 Lisp_Object bar_window
;
2701 enum scroll_bar_part part
;
2705 /* Is it a scroll bar movement? */
2706 if (frame
&& ! NILP (bar_window
))
2708 Lisp_Object part_sym
= *scroll_bar_parts
[(int) part
];
2710 return Fcons (Qscroll_bar_movement
,
2711 (Fcons (Fcons (bar_window
,
2712 Fcons (Qvertical_scroll_bar
,
2713 Fcons (Fcons (x
, y
),
2714 Fcons (make_number (time
),
2720 /* Or is it an ordinary mouse movement? */
2724 Lisp_Object window
=
2726 ? window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
)
2730 if (XTYPE (window
) == Lisp_Window
)
2732 XSETINT (x
, XINT (x
) - XINT (XWINDOW (window
)->left
));
2733 XSETINT (y
, XINT (y
) - XINT (XWINDOW (window
)->top
));
2738 posn
= Qvertical_line
;
2740 XSET (posn
, Lisp_Int
,
2741 buffer_posn_from_coords (XWINDOW (window
),
2742 XINT (x
), XINT (y
)));
2744 else if (frame
!= 0)
2746 XSET (window
, Lisp_Frame
, frame
);
2757 return Fcons (Qmouse_movement
,
2758 Fcons (Fcons (window
,
2760 Fcons (Fcons (x
, y
),
2761 Fcons (make_number (time
),
2767 /* Construct a switch frame event. */
2769 make_lispy_switch_frame (frame
)
2772 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
2775 /* Manipulating modifiers. */
2777 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
2779 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2780 SYMBOL's name of the end of the modifiers; the string from this
2781 position is the unmodified symbol name.
2783 This doesn't use any caches. */
2785 parse_modifiers_uncached (symbol
, modifier_end
)
2789 struct Lisp_String
*name
;
2793 CHECK_SYMBOL (symbol
, 1);
2796 name
= XSYMBOL (symbol
)->name
;
2799 for (i
= 0; i
+2 <= name
->size
; )
2800 switch (name
->data
[i
])
2802 #define SINGLE_LETTER_MOD(bit) \
2803 if (name->data[i+1] != '-') \
2804 goto no_more_modifiers; \
2809 SINGLE_LETTER_MOD (alt_modifier
);
2813 SINGLE_LETTER_MOD (ctrl_modifier
);
2817 SINGLE_LETTER_MOD (hyper_modifier
);
2821 SINGLE_LETTER_MOD (meta_modifier
);
2825 SINGLE_LETTER_MOD (shift_modifier
);
2829 SINGLE_LETTER_MOD (super_modifier
);
2833 if (i
+ 5 > name
->size
)
2834 goto no_more_modifiers
;
2835 if (! strncmp (name
->data
+ i
, "drag-", 5))
2837 modifiers
|= drag_modifier
;
2840 else if (! strncmp (name
->data
+ i
, "down-", 5))
2842 modifiers
|= down_modifier
;
2845 else if (i
+ 7 <= name
->size
2846 && ! strncmp (name
->data
+ i
, "double-", 7))
2848 modifiers
|= double_modifier
;
2852 goto no_more_modifiers
;
2856 if (i
+ 7 > name
->size
)
2857 goto no_more_modifiers
;
2858 if (! strncmp (name
->data
+ i
, "triple-", 7))
2860 modifiers
|= triple_modifier
;
2864 goto no_more_modifiers
;
2868 goto no_more_modifiers
;
2870 #undef SINGLE_LETTER_MOD
2874 /* Should we include the `click' modifier? */
2875 if (! (modifiers
& (down_modifier
| drag_modifier
2876 | double_modifier
| triple_modifier
))
2877 && i
+ 7 == name
->size
2878 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
2879 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
2880 modifiers
|= click_modifier
;
2889 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
2890 prepended to the string BASE[0..BASE_LEN-1].
2891 This doesn't use any caches. */
2893 apply_modifiers_uncached (modifiers
, base
, base_len
)
2898 /* Since BASE could contain nulls, we can't use intern here; we have
2899 to use Fintern, which expects a genuine Lisp_String, and keeps a
2902 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
2908 /* Only the event queue may use the `up' modifier; it should always
2909 be turned into a click or drag event before presented to lisp code. */
2910 if (modifiers
& up_modifier
)
2913 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
2914 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
2915 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
2916 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
2917 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
2918 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
2919 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
2920 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
2921 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
2922 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
2923 /* The click modifier is denoted by the absence of other modifiers. */
2927 mod_len
= p
- new_mods
;
2931 Lisp_Object new_name
= make_uninit_string (mod_len
+ base_len
);
2933 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
2934 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
2936 return Fintern (new_name
, Qnil
);
2941 static char *modifier_names
[] =
2943 "up", "down", "drag", "click", "double", "triple", 0, 0,
2944 0, 0, 0, 0, 0, 0, 0, 0,
2945 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
2947 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
2949 static Lisp_Object modifier_symbols
;
2951 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
2953 lispy_modifier_list (modifiers
)
2956 Lisp_Object modifier_list
;
2959 modifier_list
= Qnil
;
2960 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
2961 if (modifiers
& (1<<i
))
2962 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
2965 return modifier_list
;
2969 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
2970 where UNMODIFIED is the unmodified form of SYMBOL,
2971 MASK is the set of modifiers present in SYMBOL's name.
2972 This is similar to parse_modifiers_uncached, but uses the cache in
2973 SYMBOL's Qevent_symbol_element_mask property, and maintains the
2974 Qevent_symbol_elements property. */
2976 parse_modifiers (symbol
)
2979 Lisp_Object elements
= Fget (symbol
, Qevent_symbol_element_mask
);
2981 if (CONSP (elements
))
2986 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
2987 Lisp_Object unmodified
2988 = Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
2989 XSYMBOL (symbol
)->name
->size
- end
),
2993 if (modifiers
& ~((1<<VALBITS
) - 1))
2995 XFASTINT (mask
) = modifiers
;
2996 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
2998 /* Cache the parsing results on SYMBOL. */
2999 Fput (symbol
, Qevent_symbol_element_mask
,
3001 Fput (symbol
, Qevent_symbol_elements
,
3002 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
3004 /* Since we know that SYMBOL is modifiers applied to unmodified,
3005 it would be nice to put that in unmodified's cache.
3006 But we can't, since we're not sure that parse_modifiers is
3013 /* Apply the modifiers MODIFIERS to the symbol BASE.
3014 BASE must be unmodified.
3016 This is like apply_modifiers_uncached, but uses BASE's
3017 Qmodifier_cache property, if present. It also builds
3018 Qevent_symbol_elements properties, since it has that info anyway.
3020 apply_modifiers copies the value of BASE's Qevent_kind property to
3021 the modified symbol. */
3023 apply_modifiers (modifiers
, base
)
3027 Lisp_Object cache
, index
, entry
, new_symbol
;
3029 /* Mask out upper bits. We don't know where this value's been. */
3030 modifiers
&= (1<<VALBITS
) - 1;
3032 /* The click modifier never figures into cache indices. */
3033 cache
= Fget (base
, Qmodifier_cache
);
3034 XFASTINT (index
) = (modifiers
& ~click_modifier
);
3035 entry
= Fassq (index
, cache
);
3038 new_symbol
= XCONS (entry
)->cdr
;
3041 /* We have to create the symbol ourselves. */
3042 new_symbol
= apply_modifiers_uncached (modifiers
,
3043 XSYMBOL (base
)->name
->data
,
3044 XSYMBOL (base
)->name
->size
);
3046 /* Add the new symbol to the base's cache. */
3047 entry
= Fcons (index
, new_symbol
);
3048 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
3050 /* We have the parsing info now for free, so add it to the caches. */
3051 XFASTINT (index
) = modifiers
;
3052 Fput (new_symbol
, Qevent_symbol_element_mask
,
3053 Fcons (base
, Fcons (index
, Qnil
)));
3054 Fput (new_symbol
, Qevent_symbol_elements
,
3055 Fcons (base
, lispy_modifier_list (modifiers
)));
3058 /* Make sure this symbol is of the same kind as BASE.
3060 You'd think we could just set this once and for all when we
3061 intern the symbol above, but reorder_modifiers may call us when
3062 BASE's property isn't set right; we can't assume that just
3063 because it has a Qmodifier_cache property it must have its
3064 Qevent_kind set right as well. */
3065 if (NILP (Fget (new_symbol
, Qevent_kind
)))
3067 Lisp_Object kind
= Fget (base
, Qevent_kind
);
3070 Fput (new_symbol
, Qevent_kind
, kind
);
3077 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
3078 return a symbol with the modifiers placed in the canonical order.
3079 Canonical order is alphabetical, except for down and drag, which
3080 always come last. The 'click' modifier is never written out.
3082 Fdefine_key calls this to make sure that (for example) C-M-foo
3083 and M-C-foo end up being equivalent in the keymap. */
3086 reorder_modifiers (symbol
)
3089 /* It's hopefully okay to write the code this way, since everything
3090 will soon be in caches, and no consing will be done at all. */
3091 Lisp_Object parsed
= parse_modifiers (symbol
);
3093 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
3094 XCONS (parsed
)->car
);
3098 /* For handling events, we often want to produce a symbol whose name
3099 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
3100 to some base, like the name of a function key or mouse button.
3101 modify_event_symbol produces symbols of this sort.
3103 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
3104 is the name of the i'th symbol. TABLE_SIZE is the number of elements
3107 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
3108 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
3110 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
3111 persist between calls to modify_event_symbol that it can use to
3112 store a cache of the symbols it's generated for this NAME_TABLE
3113 before. The object stored there may be a vector or an alist.
3115 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
3117 MODIFIERS is a set of modifier bits (as given in struct input_events)
3118 whose prefixes should be applied to the symbol name.
3120 SYMBOL_KIND is the value to be placed in the event_kind property of
3121 the returned symbol.
3123 The symbols we create are supposed to have an
3124 `event-symbol-elements' property, which lists the modifiers present
3125 in the symbol's name. */
3128 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
3129 name_table
, symbol_table
, table_size
)
3132 Lisp_Object symbol_kind
;
3133 Lisp_Object name_alist
;
3135 Lisp_Object
*symbol_table
;
3139 Lisp_Object symbol_int
;
3141 XSET (symbol_int
, Lisp_Int
, symbol_num
);
3143 /* Is this a request for a valid symbol? */
3144 if (symbol_num
< 0 || symbol_num
>= table_size
)
3147 if (CONSP (*symbol_table
))
3148 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
3150 /* If *symbol_table doesn't seem to be initialized properly, fix that.
3151 *symbol_table should be a lisp vector TABLE_SIZE elements long,
3152 where the Nth element is the symbol for NAME_TABLE[N], or nil if
3153 we've never used that symbol before. */
3156 if (! VECTORP (*symbol_table
)
3157 || XVECTOR (*symbol_table
)->size
!= table_size
)
3161 XFASTINT (size
) = table_size
;
3162 *symbol_table
= Fmake_vector (size
, Qnil
);
3165 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
3168 /* Have we already used this symbol before? */
3171 /* No; let's create it. */
3172 if (!NILP (name_alist
))
3173 value
= Fassq (symbol_int
, name_alist
);
3174 else if (name_table
[symbol_num
])
3175 value
= intern (name_table
[symbol_num
]);
3179 sprintf (buf
, "key-%d", symbol_num
);
3180 value
= intern (buf
);
3183 if (CONSP (*symbol_table
))
3184 *symbol_table
= Fcons (value
, *symbol_table
);
3186 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
3188 /* Fill in the cache entries for this symbol; this also
3189 builds the Qevent_symbol_elements property, which the user
3191 apply_modifiers (modifiers
& click_modifier
, value
);
3192 Fput (value
, Qevent_kind
, symbol_kind
);
3195 /* Apply modifiers to that symbol. */
3196 return apply_modifiers (modifiers
, value
);
3200 /* Store into *addr a value nonzero if terminal input chars are available.
3201 Serves the purpose of ioctl (0, FIONREAD, addr)
3202 but works even if FIONREAD does not exist.
3203 (In fact, this may actually read some input.) */
3206 get_input_pending (addr
)
3209 /* First of all, have we already counted some input? */
3210 *addr
= !NILP (Vquit_flag
) || readable_events ();
3212 /* If input is being read as it arrives, and we have none, there is none. */
3213 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
3216 /* Try to read some input and see how much we get. */
3218 *addr
= !NILP (Vquit_flag
) || readable_events ();
3221 /* Interface to read_avail_input, blocking SIGIO if necessary. */
3224 gobble_input (expected
)
3229 if (interrupt_input
)
3232 mask
= sigblockx (SIGIO
);
3233 read_avail_input (expected
);
3238 read_avail_input (expected
);
3244 /* Read any terminal input already buffered up by the system
3245 into the kbd_buffer, but do not wait.
3247 EXPECTED should be nonzero if the caller knows there is some input.
3249 Except on VMS, all input is read by this function.
3250 If interrupt_input is nonzero, this function MUST be called
3251 only when SIGIO is blocked.
3253 Returns the number of keyboard chars read, or -1 meaning
3254 this is a bad time to try to read input. */
3257 read_avail_input (expected
)
3260 struct input_event buf
[KBD_BUFFER_SIZE
];
3264 if (read_socket_hook
)
3265 /* No need for FIONREAD or fcntl; just say don't wait. */
3266 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
3269 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
3270 the kbd_buffer can really hold. That may prevent loss
3271 of characters on some systems when input is stuffed at us. */
3272 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
3275 nread
= dos_keysns ();
3276 if (nread
== 0) return 0;
3277 #else */ not MSDOS */
3279 /* Find out how much input is available. */
3280 if (ioctl (0, FIONREAD
, &nread
) < 0)
3281 /* Formerly simply reported no input, but that sometimes led to
3282 a failure of Emacs to terminate.
3283 SIGHUP seems appropriate if we can't reach the terminal. */
3284 /* ??? Is it really right to send the signal just to this process
3285 rather than to the whole process group?
3286 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3287 kill (getpid (), SIGHUP
);
3290 if (nread
> sizeof cbuf
)
3291 nread
= sizeof cbuf
;
3292 #else /* no FIONREAD */
3293 #if defined(USG) || defined(DGUX)
3294 /* Read some input if available, but don't wait. */
3295 nread
= sizeof cbuf
;
3296 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
3301 #endif /* not MSDOS */
3303 /* Now read; for one reason or another, this will not block. */
3307 cbuf
[0] = dos_keyread();
3310 nread
= read (fileno (stdin
), cbuf
, nread
);
3313 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3314 This looks incorrect, but it isn't, because _BSD causes
3315 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3316 and that causes a value other than 0 when there is no input. */
3320 /* This code is wrong, but at least it gets the right results.
3321 Fix it for 19.23. */
3322 /* Retry the read if it is interrupted. */
3325 || ! (errno
== EAGAIN
|| errno
== EFAULT
3327 || ! (errno
== EAGAIN
3337 #if defined (USG) || defined (DGUX)
3338 fcntl (fileno (stdin
), F_SETFL
, 0);
3339 #endif /* USG or DGUX */
3340 #endif /* no FIONREAD */
3341 for (i
= 0; i
< nread
; i
++)
3343 buf
[i
].kind
= ascii_keystroke
;
3344 buf
[i
].modifiers
= 0;
3345 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3346 buf
[i
].modifiers
= meta_modifier
;
3350 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
3352 XSET (buf
[i
].frame_or_window
, Lisp_Frame
, selected_frame
);
3354 buf
[i
].frame_or_window
= Qnil
;
3359 /* Scan the chars for C-g and store them in kbd_buffer. */
3360 for (i
= 0; i
< nread
; i
++)
3362 kbd_buffer_store_event (&buf
[i
]);
3363 /* Don't look at input that follows a C-g too closely.
3364 This reduces lossage due to autorepeat on C-g. */
3365 if (buf
[i
].kind
== ascii_keystroke
3366 && XINT(buf
[i
].code
) == quit_char
)
3372 #endif /* not VMS */
3374 #ifdef SIGIO /* for entire page */
3375 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3378 input_available_signal (signo
)
3381 /* Must preserve main program's value of errno. */
3382 int old_errno
= errno
;
3384 extern int select_alarmed
;
3388 /* USG systems forget handlers when they are used;
3389 must reestablish each time */
3390 signal (signo
, input_available_signal
);
3397 if (input_available_clear_time
)
3398 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3403 nread
= read_avail_input (1);
3404 /* -1 means it's not ok to read the input now.
3405 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3406 0 means there was no keyboard input available. */
3411 select_alarmed
= 1; /* Force the select emulator back to life */
3422 /* Send ourselves a SIGIO.
3424 This function exists so that the UNBLOCK_INPUT macro in
3425 blockinput.h can have some way to take care of input we put off
3426 dealing with, without assuming that every file which uses
3427 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3429 reinvoke_input_signal ()
3438 /* Return the prompt-string of a sparse keymap.
3439 This is the first element which is a string.
3440 Return nil if there is none. */
3448 register Lisp_Object tem
;
3450 if (XTYPE (tem
) == Lisp_String
)
3457 static Lisp_Object
menu_bar_item ();
3458 static Lisp_Object
menu_bar_one_keymap ();
3460 /* Return a list of menu items for a menu bar, appropriate
3461 to the current buffer.
3462 The elements have the form (KEY STRING . nil). */
3467 /* The number of keymaps we're scanning right now, and the number of
3468 keymaps we have allocated space for. */
3471 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3472 in the current keymaps, or nil where it is not a prefix. */
3475 Lisp_Object def
, tem
, tail
;
3482 /* In order to build the menus, we need to call the keymap
3483 accessors. They all call QUIT. But this function is called
3484 during redisplay, during which a quit is fatal. So inhibit
3485 quitting while building the menus.
3486 We do this instead of specbind because (1) errors will clear it anyway
3487 and (2) this avoids risk of specpdl overflow. */
3488 oquit
= Vinhibit_quit
;
3491 /* Build our list of keymaps.
3492 If we recognize a function key and replace its escape sequence in
3493 keybuf with its symbol, or if the sequence starts with a mouse
3494 click and we need to switch buffers, we jump back here to rebuild
3495 the initial keymaps from the current buffer. */
3499 if (!NILP (Voverriding_local_map
))
3502 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3503 maps
[0] = Voverriding_local_map
;
3507 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3508 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3509 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3510 #ifdef USE_TEXT_PROPERTIES
3511 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3513 maps
[nmaps
-2] = current_buffer
->keymap
;
3516 maps
[nmaps
-1] = current_global_map
;
3519 /* Look up in each map the dummy prefix key `menu-bar'. */
3523 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3525 if (! NILP (maps
[mapno
]))
3526 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3530 tem
= Fkeymapp (def
);
3532 result
= menu_bar_one_keymap (def
, result
);
3535 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3539 elt
= Fassq (XCONS (tail
)->car
, result
);
3541 result
= Fcons (elt
, Fdelq (elt
, result
));
3544 result
= Fnreverse (result
);
3545 Vinhibit_quit
= oquit
;
3549 /* Scan one map KEYMAP, accumulating any menu items it defines
3550 that have not yet been seen in RESULT. Return the updated RESULT. */
3553 menu_bar_one_keymap (keymap
, result
)
3554 Lisp_Object keymap
, result
;
3556 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3558 /* Loop over all keymap entries that have menu strings. */
3559 for (tail
= keymap
; XTYPE (tail
) == Lisp_Cons
; tail
= XCONS (tail
)->cdr
)
3561 item
= XCONS (tail
)->car
;
3562 if (XTYPE (item
) == Lisp_Cons
)
3564 key
= XCONS (item
)->car
;
3565 binding
= XCONS (item
)->cdr
;
3566 if (XTYPE (binding
) == Lisp_Cons
)
3568 item_string
= XCONS (binding
)->car
;
3569 if (XTYPE (item_string
) == Lisp_String
)
3570 result
= menu_bar_item (key
, item_string
,
3571 Fcdr (binding
), result
);
3573 else if (EQ (binding
, Qundefined
))
3574 result
= menu_bar_item (key
, item_string
,
3577 else if (XTYPE (item
) == Lisp_Vector
)
3579 /* Loop over the char values represented in the vector. */
3580 int len
= XVECTOR (item
)->size
;
3582 for (c
= 0; c
< len
; c
++)
3584 Lisp_Object character
;
3585 XFASTINT (character
) = c
;
3586 binding
= XVECTOR (item
)->contents
[c
];
3587 if (XTYPE (binding
) == Lisp_Cons
)
3589 item_string
= XCONS (binding
)->car
;
3590 if (XTYPE (item_string
) == Lisp_String
)
3591 result
= menu_bar_item (key
, item_string
,
3592 Fcdr (binding
), result
);
3594 else if (EQ (binding
, Qundefined
))
3595 result
= menu_bar_item (key
, item_string
,
3604 /* This is used as the handler when calling internal_condition_case_1. */
3607 menu_bar_item_1 (arg
)
3614 menu_bar_item (key
, item_string
, def
, result
)
3615 Lisp_Object key
, item_string
, def
, result
;
3618 Lisp_Object enabled
;
3620 if (EQ (def
, Qundefined
))
3622 /* If a map has an explicit nil as definition,
3623 discard any previously made menu bar item. */
3624 tem
= Fassq (key
, result
);
3625 return Fdelq (tem
, result
);
3628 /* See if this entry is enabled. */
3631 if (XTYPE (def
) == Lisp_Symbol
)
3633 /* No property, or nil, means enable.
3634 Otherwise, enable if value is not nil. */
3635 tem
= Fget (def
, Qmenu_enable
);
3637 /* (condition-case nil (eval tem)
3639 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
3643 /* Add an entry for this key and string
3644 if there is none yet. */
3645 tem
= Fassq (key
, result
);
3646 if (!NILP (enabled
) && NILP (tem
))
3647 result
= Fcons (Fcons (key
, Fcons (item_string
, Qnil
)), result
);
3652 /* Read a character using menus based on maps in the array MAPS.
3653 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
3654 Return t if we displayed a menu but the user rejected it.
3656 PREV_EVENT is the previous input event, or nil if we are reading
3657 the first event of a key sequence.
3659 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3660 if we used a mouse menu to read the input, or zero otherwise. If
3661 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
3663 The prompting is done based on the prompt-string of the map
3664 and the strings associated with various map elements.
3666 This can be done with X menus or with menus put in the minibuf.
3667 These are done in different ways, depending on how the input will be read.
3668 Menus using X are done after auto-saving in read-char, getting the input
3669 event from Fx_popup_menu; menus using the minibuf use read_char recursively
3670 and do auto-saving in the inner call of read_char. */
3673 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
3676 Lisp_Object prev_event
;
3677 int *used_mouse_menu
;
3680 register Lisp_Object name
;
3681 Lisp_Object rest
, vector
;
3683 if (used_mouse_menu
)
3684 *used_mouse_menu
= 0;
3686 /* Use local over global Menu maps */
3688 if (! menu_prompting
)
3691 /* Get the menu name from the first map that has one (a prompt string). */
3692 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3694 name
= map_prompt (maps
[mapno
]);
3699 /* If we don't have any menus, just read a character normally. */
3703 #ifdef HAVE_X_WINDOWS
3705 /* If we got to this point via a mouse click,
3706 use a real menu for mouse selection. */
3707 if (EVENT_HAS_PARAMETERS (prev_event
))
3709 /* Display the menu and get the selection. */
3710 Lisp_Object
*realmaps
3711 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
3715 /* Use the maps that are not nil. */
3716 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3717 if (!NILP (maps
[mapno
]))
3718 realmaps
[nmaps1
++] = maps
[mapno
];
3720 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
3723 /* If we got more than one event, put all but the first
3724 onto this list to be read later.
3725 Return just the first event now. */
3726 unread_command_events
3727 = nconc2 (XCONS (value
)->cdr
, unread_command_events
);
3728 value
= XCONS (value
)->car
;
3732 if (used_mouse_menu
)
3733 *used_mouse_menu
= 1;
3736 #endif /* HAVE_X_MENU */
3737 #endif /* HAVE_X_WINDOWS */
3742 read_char_minibuf_menu_prompt(commandflag
, nmaps
, maps
)
3748 register Lisp_Object name
;
3750 int width
= FRAME_WIDTH (selected_frame
) - 4;
3751 char *menu
= (char *) alloca (width
+ 4);
3754 Lisp_Object rest
, vector
;
3756 if (! menu_prompting
)
3759 /* Get the menu name from the first map that has one (a prompt string). */
3760 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3762 name
= map_prompt (maps
[mapno
]);
3767 /* If we don't have any menus, just read a character normally. */
3771 /* Prompt string always starts with map's prompt, and a space. */
3772 strcpy (menu
, XSTRING (name
)->data
);
3773 nlength
= XSTRING (name
)->size
;
3774 menu
[nlength
++] = ':';
3775 menu
[nlength
++] = ' ';
3778 /* Start prompting at start of first map. */
3782 /* Present the documented bindings, a line at a time. */
3789 int orig_defn_macro
;
3791 /* Loop over elements of map. */
3796 /* If reached end of map, start at beginning of next map. */
3800 /* At end of last map, wrap around to first map if just starting,
3801 or end this line if already have something on it. */
3805 if (notfirst
|| nobindings
) break;
3810 /* Look at the next element of the map. */
3812 elt
= XVECTOR (vector
)->contents
[idx
];
3814 elt
= Fcar_safe (rest
);
3816 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
3818 /* If we found a dense table in the keymap,
3819 advanced past it, but start scanning its contents. */
3820 rest
= Fcdr_safe (rest
);
3826 /* An ordinary element. */
3828 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
3830 s
= Fcar_safe(elt
); /* vector */
3831 if (XTYPE (s
) != Lisp_String
)
3832 /* Ignore the element if it has no prompt string. */
3834 /* If we have room for the prompt string, add it to this line.
3835 If this is the first on the line, always add it. */
3836 else if (XSTRING (s
)->size
+ i
+ 2 < width
3841 /* Punctuate between strings. */
3844 strcpy (menu
+ i
, ", ");
3850 /* Add as much of string as fits. */
3851 thiswidth
= XSTRING (s
)->size
;
3852 if (thiswidth
+ i
> width
)
3853 thiswidth
= width
- i
;
3854 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
3860 /* If this element does not fit, end the line now,
3861 and save the element for the next line. */
3862 strcpy (menu
+ i
, "...");
3866 /* Move past this element. */
3867 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
3868 /* Handle reaching end of dense table. */
3873 rest
= Fcdr_safe (rest
);
3877 /* Prompt with that and read response. */
3880 /* Make believe its not a keyboard macro in case the help char
3881 is pressed. Help characters are not recorded because menu prompting
3882 is not used on replay.
3884 orig_defn_macro
= defining_kbd_macro
;
3885 defining_kbd_macro
= 0 ;
3887 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
3888 while (XTYPE (obj
) == Lisp_Buffer
);
3889 defining_kbd_macro
= orig_defn_macro
;
3891 if (XTYPE (obj
) != Lisp_Int
)
3896 if (! EQ (obj
, menu_prompt_more_char
)
3897 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
3898 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
3900 if ( defining_kbd_macro
)
3901 store_kbd_macro_char(obj
) ;
3904 /* Help char - go round again */
3908 /* Reading key sequences. */
3910 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
3911 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
3912 keymap, or nil otherwise. Return the index of the first keymap in
3913 which KEY has any binding, or NMAPS if no map has a binding.
3915 If KEY is a meta ASCII character, treat it like meta-prefix-char
3916 followed by the corresponding non-meta character. Keymaps in
3917 CURRENT with non-prefix bindings for meta-prefix-char become nil in
3920 When KEY is not defined in any of the keymaps, if it is an upper
3921 case letter and there are bindings for the corresponding lower-case
3922 letter, return the bindings for the lower-case letter.
3923 We store 1 in *CASE_CONVERTED in this case.
3924 Otherwise, we don't change *CASE_CONVERTED.
3926 If KEY has no bindings in any of the CURRENT maps, NEXT is left
3929 NEXT may == CURRENT. */
3932 follow_key (key
, nmaps
, current
, defs
, next
, case_converted
)
3934 Lisp_Object
*current
, *defs
, *next
;
3936 int *case_converted
;
3938 int i
, first_binding
;
3940 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
3941 followed by the corresponding non-meta character. */
3942 if (XTYPE (key
) == Lisp_Int
&& (XINT (key
) & CHAR_META
))
3944 for (i
= 0; i
< nmaps
; i
++)
3945 if (! NILP (current
[i
]))
3948 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
3950 /* Note that since we pass the resulting bindings through
3951 get_keymap_1, non-prefix bindings for meta-prefix-char
3953 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
3959 XSET (key
, Lisp_Int
, XFASTINT (key
) & ~CHAR_META
);
3962 first_binding
= nmaps
;
3963 for (i
= nmaps
- 1; i
>= 0; i
--)
3965 if (! NILP (current
[i
]))
3967 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3968 if (! NILP (defs
[i
]))
3975 /* When KEY is not defined in any of the keymaps, if it is an upper
3976 case letter and there are bindings for the corresponding
3977 lower-case letter, return the bindings for the lower-case letter. */
3978 if (first_binding
== nmaps
3979 && XTYPE (key
) == Lisp_Int
3980 && ((((XINT (key
) & 0x3ffff)
3981 < XSTRING (current_buffer
->downcase_table
)->size
)
3982 && UPPERCASEP (XINT (key
) & 0x3ffff))
3983 || (XINT (key
) & shift_modifier
)))
3985 if (XINT (key
) & shift_modifier
)
3986 XSETINT (key
, XINT (key
) & ~shift_modifier
);
3988 XSETINT (key
, (DOWNCASE (XINT (key
) & 0x3ffff)
3989 | (XINT (key
) & ~0x3ffff)));
3991 first_binding
= nmaps
;
3992 for (i
= nmaps
- 1; i
>= 0; i
--)
3994 if (! NILP (current
[i
]))
3996 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3997 if (! NILP (defs
[i
]))
4003 if (first_binding
!= nmaps
)
4004 *case_converted
= 1;
4007 /* Given the set of bindings we've found, produce the next set of maps. */
4008 if (first_binding
< nmaps
)
4009 for (i
= 0; i
< nmaps
; i
++)
4010 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
4012 return first_binding
;
4015 /* Read a sequence of keys that ends with a non prefix character,
4016 storing it in KEYBUF, a buffer of size BUFSIZE.
4018 Return the length of the key sequence stored.
4019 Return -1 if the user rejected a command menu.
4021 Echo starting immediately unless `prompt' is 0.
4023 Where a key sequence ends depends on the currently active keymaps.
4024 These include any minor mode keymaps active in the current buffer,
4025 the current buffer's local map, and the global map.
4027 If a key sequence has no other bindings, we check Vfunction_key_map
4028 to see if some trailing subsequence might be the beginning of a
4029 function key's sequence. If so, we try to read the whole function
4030 key, and substitute its symbolic name into the key sequence.
4032 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
4033 `double-' events into similar click events, if that would make them
4034 bound. We try to turn `triple-' events first into `double-' events,
4037 If we get a mouse click in a mode line, vertical divider, or other
4038 non-text area, we treat the click as if it were prefixed by the
4039 symbol denoting that area - `mode-line', `vertical-line', or
4042 If the sequence starts with a mouse click, we read the key sequence
4043 with respect to the buffer clicked on, not the current buffer.
4045 If the user switches frames in the midst of a key sequence, we put
4046 off the switch-frame event until later; the next call to
4047 read_char will return it. */
4050 read_key_sequence (keybuf
, bufsize
, prompt
)
4051 Lisp_Object
*keybuf
;
4055 int count
= specpdl_ptr
- specpdl
;
4057 /* How many keys there are in the current key sequence. */
4060 /* The length of the echo buffer when we started reading, and
4061 the length of this_command_keys when we started reading. */
4065 /* The number of keymaps we're scanning right now, and the number of
4066 keymaps we have allocated space for. */
4068 int nmaps_allocated
= 0;
4070 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
4071 the current keymaps. */
4074 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
4075 in the current keymaps, or nil where it is not a prefix. */
4076 Lisp_Object
*submaps
;
4078 /* The index in defs[] of the first keymap that has a binding for
4079 this key sequence. In other words, the lowest i such that
4080 defs[i] is non-nil. */
4083 /* If t < mock_input, then KEYBUF[t] should be read as the next
4086 We use this to recover after recognizing a function key. Once we
4087 realize that a suffix of the current key sequence is actually a
4088 function key's escape sequence, we replace the suffix with the
4089 function key's binding from Vfunction_key_map. Now keybuf
4090 contains a new and different key sequence, so the echo area,
4091 this_command_keys, and the submaps and defs arrays are wrong. In
4092 this situation, we set mock_input to t, set t to 0, and jump to
4093 restart_sequence; the loop will read keys from keybuf up until
4094 mock_input, thus rebuilding the state; and then it will resume
4095 reading characters from the keyboard. */
4098 /* If the sequence is unbound in submaps[], then
4099 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
4100 and fkey_map is its binding.
4102 These might be > t, indicating that all function key scanning
4103 should hold off until t reaches them. We do this when we've just
4104 recognized a function key, to avoid searching for the function
4105 key's again in Vfunction_key_map. */
4106 int fkey_start
= 0, fkey_end
= 0;
4107 Lisp_Object fkey_map
;
4109 /* Likewise, for key_translation_map. */
4110 int keytran_start
= 0, keytran_end
= 0;
4111 Lisp_Object keytran_map
;
4113 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
4114 we put it off for later. While we're reading, we keep the event here. */
4115 Lisp_Object delayed_switch_frame
;
4117 /* See the comment below... */
4118 #if defined (GOBBLE_FIRST_EVENT)
4119 Lisp_Object first_event
;
4122 struct buffer
*starting_buffer
;
4124 /* Nonzero if we found the binding for one of the chars
4125 in this key sequence by downcasing it. */
4126 int case_converted
= 0;
4128 /* Nonzero if we seem to have got the beginning of a binding
4129 in function_key_map. */
4130 int function_key_possible
= 0;
4134 last_nonmenu_event
= Qnil
;
4136 delayed_switch_frame
= Qnil
;
4137 fkey_map
= Vfunction_key_map
;
4138 keytran_map
= Vkey_translation_map
;
4140 /* If there is no function-key-map, turn off function key scanning. */
4141 if (NILP (Fkeymapp (Vfunction_key_map
)))
4142 fkey_start
= fkey_end
= bufsize
+ 1;
4144 /* If there is no key-translation-map, turn off scanning. */
4145 if (NILP (Fkeymapp (Vkey_translation_map
)))
4146 keytran_start
= keytran_end
= bufsize
+ 1;
4151 echo_prompt (XSTRING (prompt
)->data
);
4152 else if (cursor_in_echo_area
)
4153 /* This doesn't put in a dash if the echo buffer is empty, so
4154 you don't always see a dash hanging out in the minibuffer. */
4158 /* Record the initial state of the echo area and this_command_keys;
4159 we will need to restore them if we replay a key sequence. */
4161 echo_start
= echo_length ();
4162 keys_start
= this_command_key_count
;
4164 #if defined (GOBBLE_FIRST_EVENT)
4165 /* This doesn't quite work, because some of the things that read_char
4166 does cannot safely be bypassed. It seems too risky to try to make
4169 /* Read the first char of the sequence specially, before setting
4170 up any keymaps, in case a filter runs and switches buffers on us. */
4171 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
4173 #endif /* GOBBLE_FIRST_EVENT */
4175 /* We jump here when the key sequence has been thoroughly changed, and
4176 we need to rescan it starting from the beginning. When we jump here,
4177 keybuf[0..mock_input] holds the sequence we should reread. */
4180 starting_buffer
= current_buffer
;
4182 function_key_possible
= 0;
4184 /* Build our list of keymaps.
4185 If we recognize a function key and replace its escape sequence in
4186 keybuf with its symbol, or if the sequence starts with a mouse
4187 click and we need to switch buffers, we jump back here to rebuild
4188 the initial keymaps from the current buffer. */
4192 if (!NILP (Voverriding_local_map
))
4195 if (nmaps
> nmaps_allocated
)
4197 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4198 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4199 nmaps_allocated
= nmaps
;
4201 submaps
[0] = Voverriding_local_map
;
4205 nmaps
= current_minor_maps (0, &maps
) + 2;
4206 if (nmaps
> nmaps_allocated
)
4208 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4209 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4210 nmaps_allocated
= nmaps
;
4212 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
4213 #ifdef USE_TEXT_PROPERTIES
4214 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
4216 submaps
[nmaps
-2] = current_buffer
->keymap
;
4219 submaps
[nmaps
-1] = current_global_map
;
4222 /* Find an accurate initial value for first_binding. */
4223 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
4224 if (! NILP (submaps
[first_binding
]))
4227 /* Start from the beginning in keybuf. */
4230 /* These are no-ops the first time through, but if we restart, they
4231 revert the echo area and this_command_keys to their original state. */
4232 this_command_key_count
= keys_start
;
4233 if (INTERACTIVE
&& t
< mock_input
)
4234 echo_truncate (echo_start
);
4236 /* If the best binding for the current key sequence is a keymap, or
4237 we may be looking at a function key's escape sequence, keep on
4239 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
4240 || (first_binding
>= nmaps
4242 /* mock input is never part of a function key's sequence. */
4243 && mock_input
<= fkey_start
)
4244 || (first_binding
>= nmaps
4245 && keytran_start
< t
4246 /* mock input is never part of a function key's sequence. */
4247 && mock_input
<= keytran_start
)
4248 /* Don't return in the middle of a possible function key sequence,
4249 if the only bindings we found were via case conversion.
4250 Thus, if ESC O a has a function-key-map translation
4251 and ESC o has a binding, don't return after ESC O,
4252 so that we can translate ESC O plus the next character. */
4253 || (function_key_possible
&& case_converted
))
4256 int used_mouse_menu
= 0;
4258 /* Where the last real key started. If we need to throw away a
4259 key that has expanded into more than one element of keybuf
4260 (say, a mouse click on the mode line which is being treated
4261 as [mode-line (mouse-...)], then we backtrack to this point
4263 int last_real_key_start
;
4265 /* These variables are analogous to echo_start and keys_start;
4266 while those allow us to restart the entire key sequence,
4267 echo_local_start and keys_local_start allow us to throw away
4269 int echo_local_start
, keys_local_start
, local_first_binding
;
4272 error ("key sequence too long");
4275 echo_local_start
= echo_length ();
4276 keys_local_start
= this_command_key_count
;
4277 local_first_binding
= first_binding
;
4280 /* These are no-ops, unless we throw away a keystroke below and
4281 jumped back up to replay_key; in that case, these restore the
4282 variables to their original state, allowing us to replay the
4284 if (INTERACTIVE
&& t
< mock_input
)
4285 echo_truncate (echo_local_start
);
4286 this_command_key_count
= keys_local_start
;
4287 first_binding
= local_first_binding
;
4289 /* By default, assume each event is "real". */
4290 last_real_key_start
= t
;
4292 /* Does mock_input indicate that we are re-reading a key sequence? */
4296 add_command_key (key
);
4300 /* If not, we should actually read a character. */
4303 struct buffer
*buf
= current_buffer
;
4305 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
4308 /* read_char returns t when it shows a menu and the user rejects it.
4313 /* read_char returns -1 at the end of a macro.
4314 Emacs 18 handles this by returning immediately with a
4315 zero, so that's what we'll do. */
4316 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) == -1)
4322 /* If the current buffer has been changed from under us, the
4323 keymap may have changed, so replay the sequence. */
4324 if (XTYPE (key
) == Lisp_Buffer
)
4327 goto replay_sequence
;
4330 /* If we have a quit that was typed in another frame, and
4331 quit_throw_to_read_char switched buffers,
4332 replay to get the right keymap. */
4333 if (EQ (key
, quit_char
) && current_buffer
!= starting_buffer
)
4338 goto replay_sequence
;
4344 /* Clicks in non-text areas get prefixed by the symbol
4345 in their CHAR-ADDRESS field. For example, a click on
4346 the mode line is prefixed by the symbol `mode-line'.
4348 Furthermore, key sequences beginning with mouse clicks
4349 are read using the keymaps of the buffer clicked on, not
4350 the current buffer. So we may have to switch the buffer
4353 When we turn one event into two events, we must make sure
4354 that neither of the two looks like the original--so that,
4355 if we replay the events, they won't be expanded again.
4356 If not for this, such reexpansion could happen either here
4357 or when user programs play with this-command-keys. */
4358 if (EVENT_HAS_PARAMETERS (key
))
4360 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
4362 if (EQ (kind
, Qmouse_click
))
4364 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
4365 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4367 if (XTYPE (posn
) == Lisp_Cons
)
4369 /* We're looking at the second event of a
4370 sequence which we expanded before. Set
4371 last_real_key_start appropriately. */
4373 last_real_key_start
= t
- 1;
4376 /* Key sequences beginning with mouse clicks are
4377 read using the keymaps in the buffer clicked on,
4378 not the current buffer. If we're at the
4379 beginning of a key sequence, switch buffers. */
4380 if (last_real_key_start
== 0
4381 && XTYPE (window
) == Lisp_Window
4382 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
4383 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
4388 /* Arrange to go back to the original buffer once we're
4389 done reading the key sequence. Note that we can't
4390 use save_excursion_{save,restore} here, because they
4391 save point as well as the current buffer; we don't
4392 want to save point, because redisplay may change it,
4393 to accommodate a Fset_window_start or something. We
4394 don't want to do this at the top of the function,
4395 because we may get input from a subprocess which
4396 wants to change the selected window and stuff (say,
4398 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
4400 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
4401 goto replay_sequence
;
4403 else if (XTYPE (posn
) == Lisp_Symbol
)
4405 /* Expand mode-line and scroll-bar events into two events:
4406 use posn as a fake prefix key. */
4408 if (t
+ 1 >= bufsize
)
4409 error ("key sequence too long");
4414 /* Zap the position in key, so we know that we've
4415 expanded it, and don't try to do so again. */
4416 POSN_BUFFER_POSN (EVENT_START (key
))
4417 = Fcons (posn
, Qnil
);
4421 else if (EQ (kind
, Qswitch_frame
))
4423 /* If we're at the beginning of a key sequence, go
4424 ahead and return this event. If we're in the
4425 midst of a key sequence, delay it until the end. */
4428 delayed_switch_frame
= key
;
4434 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4436 /* Handle menu-bar events:
4437 insert the dummy prefix event `menu-bar'. */
4438 if (EQ (posn
, Qmenu_bar
))
4440 if (t
+ 1 >= bufsize
)
4441 error ("key sequence too long");
4442 /* Run the Lucid hook. */
4443 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4444 /* If it has changed current-menubar from previous value,
4445 really recompute the menubar from the value. */
4446 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4447 call0 (Qrecompute_lucid_menubar
);
4451 /* Zap the position in key, so we know that we've
4452 expanded it, and don't try to do so again. */
4453 POSN_BUFFER_POSN (EVENT_START (key
))
4454 = Fcons (posn
, Qnil
);
4457 goto replay_sequence
;
4459 else if (XTYPE (posn
) == Lisp_Cons
)
4461 /* We're looking at the second event of a
4462 sequence which we expanded before. Set
4463 last_real_key_start appropriately. */
4464 if (last_real_key_start
== t
&& t
> 0)
4465 last_real_key_start
= t
- 1;
4470 /* We have finally decided that KEY is something we might want
4472 first_binding
= (follow_key (key
,
4473 nmaps
- first_binding
,
4474 submaps
+ first_binding
,
4475 defs
+ first_binding
,
4476 submaps
+ first_binding
,
4480 /* If KEY wasn't bound, we'll try some fallbacks. */
4481 if (first_binding
>= nmaps
)
4483 Lisp_Object head
= EVENT_HEAD (key
);
4485 if (EQ (head
, Vhelp_char
))
4487 read_key_sequence_cmd
= Vprefix_help_command
;
4489 last_nonmenu_event
= key
;
4493 if (XTYPE (head
) == Lisp_Symbol
)
4495 Lisp_Object breakdown
= parse_modifiers (head
);
4496 int modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4498 /* Attempt to reduce an unbound mouse event to a simpler
4499 event that is bound:
4500 Drags reduce to clicks.
4501 Double-clicks reduce to clicks.
4502 Triple-clicks reduce to double-clicks, then to clicks.
4503 Down-clicks are eliminated.
4504 Double-downs reduce to downs, then are eliminated.
4505 Triple-downs reduce to double-downs, then to downs,
4506 then are eliminated. */
4507 if (modifiers
& (down_modifier
| drag_modifier
4508 | double_modifier
| triple_modifier
))
4510 while (modifiers
& (down_modifier
| drag_modifier
4511 | double_modifier
| triple_modifier
))
4513 Lisp_Object new_head
, new_click
;
4514 if (modifiers
& triple_modifier
)
4515 modifiers
^= (double_modifier
| triple_modifier
);
4516 else if (modifiers
& (drag_modifier
| double_modifier
))
4517 modifiers
&= ~(drag_modifier
| double_modifier
);
4520 /* Dispose of this `down' event by simply jumping
4521 back to replay_key, to get another event.
4523 Note that if this event came from mock input,
4524 then just jumping back to replay_key will just
4525 hand it to us again. So we have to wipe out any
4528 We could delete keybuf[t] and shift everything
4529 after that to the left by one spot, but we'd also
4530 have to fix up any variable that points into
4531 keybuf, and shifting isn't really necessary
4534 Adding prefixes for non-textual mouse clicks
4535 creates two characters of mock input, and both
4536 must be thrown away. If we're only looking at
4537 the prefix now, we can just jump back to
4538 replay_key. On the other hand, if we've already
4539 processed the prefix, and now the actual click
4540 itself is giving us trouble, then we've lost the
4541 state of the keymaps we want to backtrack to, and
4542 we need to replay the whole sequence to rebuild
4545 Beyond that, only function key expansion could
4546 create more than two keys, but that should never
4547 generate mouse events, so it's okay to zero
4548 mock_input in that case too.
4550 Isn't this just the most wonderful code ever? */
4551 if (t
== last_real_key_start
)
4558 mock_input
= last_real_key_start
;
4559 goto replay_sequence
;
4564 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
4566 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
4568 /* Look for a binding for this new key. follow_key
4569 promises that it didn't munge submaps the
4570 last time we called it, since key was unbound. */
4572 = (follow_key (new_click
,
4573 nmaps
- local_first_binding
,
4574 submaps
+ local_first_binding
,
4575 defs
+ local_first_binding
,
4576 submaps
+ local_first_binding
,
4578 + local_first_binding
);
4580 /* If that click is bound, go for it. */
4581 if (first_binding
< nmaps
)
4586 /* Otherwise, we'll leave key set to the drag event. */
4593 /* Normally, last_nonmenu_event gets the previous key we read.
4594 But when a mouse popup menu is being used,
4595 we don't update last_nonmenu_event; it continues to hold the mouse
4596 event that preceded the first level of menu. */
4597 if (!used_mouse_menu
)
4598 last_nonmenu_event
= key
;
4600 /* If the sequence is unbound, see if we can hang a function key
4601 off the end of it. We only want to scan real keyboard input
4602 for function key sequences, so if mock_input says that we're
4603 re-reading old events, don't examine it. */
4604 if ((first_binding
>= nmaps
|| case_converted
)
4607 Lisp_Object fkey_next
;
4609 /* Continue scan from fkey_end until we find a bound suffix.
4610 If we fail, increment fkey_start
4611 and start fkey_end from there. */
4612 while (fkey_end
< t
)
4616 key
= keybuf
[fkey_end
++];
4617 /* Look up meta-characters by prefixing them
4618 with meta_prefix_char. I hate this. */
4619 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4624 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
4626 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4629 fkey_next
= fkey_map
;
4632 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
4634 /* If the function key map gives a function, not an
4635 array, then call the function with no args and use
4636 its value instead. */
4637 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
4640 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4644 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4645 fkey_next
= call1 (fkey_next
, prompt
);
4647 /* If the function returned something invalid,
4648 barf--don't ignore it.
4649 (To ignore it safely, we would need to gcpro a bunch of
4650 other variables.) */
4651 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
4652 error ("Function in function-key-map returns invalid key sequence");
4655 function_key_possible
= ! NILP (fkey_next
);
4657 /* If keybuf[fkey_start..fkey_end] is bound in the
4658 function key map and it's a suffix of the current
4659 sequence (i.e. fkey_end == t), replace it with
4660 the binding and restart with fkey_start at the end. */
4661 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
4664 int len
= XFASTINT (Flength (fkey_next
));
4666 t
= fkey_start
+ len
;
4668 error ("key sequence too long");
4670 if (VECTORP (fkey_next
))
4671 bcopy (XVECTOR (fkey_next
)->contents
,
4672 keybuf
+ fkey_start
,
4673 (t
- fkey_start
) * sizeof (keybuf
[0]));
4674 else if (STRINGP (fkey_next
))
4678 for (i
= 0; i
< len
; i
++)
4679 XFASTINT (keybuf
[fkey_start
+ i
])
4680 = XSTRING (fkey_next
)->data
[i
];
4684 fkey_start
= fkey_end
= t
;
4685 fkey_map
= Vfunction_key_map
;
4687 goto replay_sequence
;
4690 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
4692 /* If we no longer have a bound suffix, try a new positions for
4694 if (NILP (fkey_map
))
4696 fkey_end
= ++fkey_start
;
4697 fkey_map
= Vfunction_key_map
;
4698 function_key_possible
= 0;
4703 /* Look for this sequence in key-translation-map. */
4705 Lisp_Object keytran_next
;
4707 /* Scan from keytran_end until we find a bound suffix. */
4708 while (keytran_end
< t
)
4712 key
= keybuf
[keytran_end
++];
4713 /* Look up meta-characters by prefixing them
4714 with meta_prefix_char. I hate this. */
4715 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4720 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
4722 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4725 keytran_next
= keytran_map
;
4728 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
4730 /* If the key translation map gives a function, not an
4731 array, then call the function with no args and use
4732 its value instead. */
4733 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
4734 && keytran_end
== t
)
4736 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4740 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4741 keytran_next
= call1 (keytran_next
, prompt
);
4743 /* If the function returned something invalid,
4744 barf--don't ignore it.
4745 (To ignore it safely, we would need to gcpro a bunch of
4746 other variables.) */
4747 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
4748 error ("Function in key-translation-map returns invalid key sequence");
4751 /* If keybuf[keytran_start..keytran_end] is bound in the
4752 key translation map and it's a suffix of the current
4753 sequence (i.e. keytran_end == t), replace it with
4754 the binding and restart with keytran_start at the end. */
4755 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
4756 && keytran_end
== t
)
4758 int len
= XFASTINT (Flength (keytran_next
));
4760 t
= keytran_start
+ len
;
4762 error ("key sequence too long");
4764 if (VECTORP (keytran_next
))
4765 bcopy (XVECTOR (keytran_next
)->contents
,
4766 keybuf
+ keytran_start
,
4767 (t
- keytran_start
) * sizeof (keybuf
[0]));
4768 else if (STRINGP (keytran_next
))
4772 for (i
= 0; i
< len
; i
++)
4773 XFASTINT (keybuf
[keytran_start
+ i
])
4774 = XSTRING (keytran_next
)->data
[i
];
4778 keytran_start
= keytran_end
= t
;
4779 keytran_map
= Vkey_translation_map
;
4781 goto replay_sequence
;
4784 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
4786 /* If we no longer have a bound suffix, try a new positions for
4788 if (NILP (keytran_map
))
4790 keytran_end
= ++keytran_start
;
4791 keytran_map
= Vkey_translation_map
;
4797 read_key_sequence_cmd
= (first_binding
< nmaps
4798 ? defs
[first_binding
]
4802 unread_switch_frame
= delayed_switch_frame
;
4803 unbind_to (count
, Qnil
);
4805 /* Occasionally we fabricate events, perhaps by expanding something
4806 according to function-key-map, or by adding a prefix symbol to a
4807 mouse click in the scroll bar or modeline. In this cases, return
4808 the entire generated key sequence, even if we hit an unbound
4809 prefix or a definition before the end. This means that you will
4810 be able to push back the event properly, and also means that
4811 read-key-sequence will always return a logical unit.
4814 for (; t
< mock_input
; t
++)
4816 echo_char (keybuf
[t
]);
4817 add_command_key (keybuf
[t
]);
4823 #if 0 /* This doc string is too long for some compilers.
4824 This commented-out definition serves for DOC. */
4825 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4826 "Read a sequence of keystrokes and return as a string or vector.\n\
4827 The sequence is sufficient to specify a non-prefix command in the\n\
4828 current local and global maps.\n\
4830 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
4831 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
4832 as a continuation of the previous key.\n\
4834 A C-g typed while in this function is treated like any other character,\n\
4835 and `quit-flag' is not set.\n\
4837 If the key sequence starts with a mouse click, then the sequence is read\n\
4838 using the keymaps of the buffer of the window clicked in, not the buffer\n\
4839 of the selected window as normal.\n\
4841 `read-key-sequence' drops unbound button-down events, since you normally\n\
4842 only care about the click or drag events which follow them. If a drag\n\
4843 or multi-click event is unbound, but the corresponding click event would\n\
4844 be bound, `read-key-sequence' turns the event into a click event at the\n\
4845 drag's starting position. This means that you don't have to distinguish\n\
4846 between click and drag, double, or triple events unless you want to.\n\
4848 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
4849 lines separating windows, and scroll bars with imaginary keys\n\
4850 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
4852 If the user switches frames in the middle of a key sequence, the\n\
4853 frame-switch event is put off until after the current key sequence.\n\
4855 `read-key-sequence' checks `function-key-map' for function key\n\
4856 sequences, where they wouldn't conflict with ordinary bindings. See\n\
4857 `function-key-map' for more details.")
4858 (prompt
, continue_echo
)
4861 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4863 (prompt
, continue_echo
)
4864 Lisp_Object prompt
, continue_echo
;
4866 Lisp_Object keybuf
[30];
4868 struct gcpro gcpro1
, gcpro2
;
4871 CHECK_STRING (prompt
, 0);
4874 bzero (keybuf
, sizeof keybuf
);
4876 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
4878 if (NILP (continue_echo
))
4879 this_command_key_count
= 0;
4881 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])), prompt
);
4889 return make_event_array (i
, keybuf
);
4892 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
4893 "Execute CMD as an editor command.\n\
4894 CMD must be a symbol that satisfies the `commandp' predicate.\n\
4895 Optional second arg RECORD-FLAG non-nil\n\
4896 means unconditionally put this command in `command-history'.\n\
4897 Otherwise, that is done only if an arg is read using the minibuffer.")
4899 Lisp_Object cmd
, record
;
4901 register Lisp_Object final
;
4902 register Lisp_Object tem
;
4903 Lisp_Object prefixarg
;
4904 struct backtrace backtrace
;
4905 extern int debug_on_next_call
;
4907 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
4908 Vcurrent_prefix_arg
= prefixarg
;
4909 debug_on_next_call
= 0;
4911 if (XTYPE (cmd
) == Lisp_Symbol
)
4913 tem
= Fget (cmd
, Qdisabled
);
4915 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
4920 final
= Findirect_function (cmd
);
4922 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
4923 do_autoload (final
, cmd
);
4928 if (XTYPE (final
) == Lisp_String
4929 || XTYPE (final
) == Lisp_Vector
)
4931 /* If requested, place the macro in the command history. For
4932 other sorts of commands, call-interactively takes care of
4936 = Fcons (Fcons (Qexecute_kbd_macro
,
4937 Fcons (final
, Fcons (prefixarg
, Qnil
))),
4940 return Fexecute_kbd_macro (final
, prefixarg
);
4942 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
4943 || XTYPE (final
) == Lisp_Compiled
)
4945 backtrace
.next
= backtrace_list
;
4946 backtrace_list
= &backtrace
;
4947 backtrace
.function
= &Qcall_interactively
;
4948 backtrace
.args
= &cmd
;
4949 backtrace
.nargs
= 1;
4950 backtrace
.evalargs
= 0;
4952 tem
= Fcall_interactively (cmd
, record
);
4954 backtrace_list
= backtrace
.next
;
4960 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
4962 "Read function name, then read its arguments and call it.")
4964 Lisp_Object prefixarg
;
4966 Lisp_Object function
;
4968 Lisp_Object saved_keys
;
4969 struct gcpro gcpro1
;
4971 saved_keys
= Fvector (this_command_key_count
,
4972 XVECTOR (this_command_keys
)->contents
);
4974 GCPRO1 (saved_keys
);
4976 if (EQ (prefixarg
, Qminus
))
4978 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
4979 strcpy (buf
, "C-u ");
4980 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
4981 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
4982 else if (XTYPE (prefixarg
) == Lisp_Int
)
4983 sprintf (buf
, "%d ", XINT (prefixarg
));
4985 /* This isn't strictly correct if execute-extended-command
4986 is bound to anything else. Perhaps it should use
4987 this_command_keys? */
4988 strcat (buf
, "M-x ");
4990 /* Prompt with buf, and then read a string, completing from and
4991 restricting to the set of all defined commands. Don't provide
4992 any initial input. Save the command read on the extended-command
4994 function
= Fcompleting_read (build_string (buf
),
4995 Vobarray
, Qcommandp
,
4996 Qt
, Qnil
, Qextended_command_history
);
4998 /* Set this_command_keys to the concatenation of saved_keys and
4999 function, followed by a RET. */
5001 struct Lisp_String
*str
;
5006 this_command_key_count
= 0;
5008 keys
= XVECTOR (saved_keys
)->contents
;
5009 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
5010 add_command_key (keys
[i
]);
5012 str
= XSTRING (function
);
5013 for (i
= 0; i
< str
->size
; i
++)
5015 XFASTINT (tem
) = str
->data
[i
];
5016 add_command_key (tem
);
5019 XFASTINT (tem
) = '\015';
5020 add_command_key (tem
);
5025 function
= Fintern (function
, Qnil
);
5026 Vprefix_arg
= prefixarg
;
5027 this_command
= function
;
5029 return Fcommand_execute (function
, Qt
);
5033 detect_input_pending ()
5036 get_input_pending (&input_pending
);
5038 return input_pending
;
5041 /* This is called in some cases before a possible quit.
5042 It cases the next call to detect_input_pending to recompute input_pending.
5043 So calling this function unnecessarily can't do any harm. */
5044 clear_input_pending ()
5049 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
5050 "T if command input is currently available with no waiting.\n\
5051 Actually, the value is nil only if we can be sure that no input is available.")
5054 if (!NILP (unread_command_events
) || unread_command_char
!= -1)
5057 return detect_input_pending () ? Qt
: Qnil
;
5060 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
5061 "Return vector of last 100 events, not counting those from keyboard macros.")
5064 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
5067 if (total_keys
< NUM_RECENT_KEYS
)
5068 return Fvector (total_keys
, keys
);
5071 val
= Fvector (NUM_RECENT_KEYS
, keys
);
5072 bcopy (keys
+ recent_keys_index
,
5073 XVECTOR (val
)->contents
,
5074 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
5076 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
5077 recent_keys_index
* sizeof (Lisp_Object
));
5082 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
5083 "Return the key sequence that invoked this command.\n\
5084 The value is a string or a vector.")
5087 return make_event_array (this_command_key_count
,
5088 XVECTOR (this_command_keys
)->contents
);
5091 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
5092 "Return the current depth in recursive edits.")
5096 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
5100 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
5101 "FOpen dribble file: ",
5102 "Start writing all keyboard characters to a dribble file called FILE.\n\
5103 If FILE is nil, close any open dribble file.")
5114 file
= Fexpand_file_name (file
, Qnil
);
5115 dribble
= fopen (XSTRING (file
)->data
, "w");
5120 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
5121 "Discard the contents of the terminal input buffer.\n\
5122 Also cancel any kbd macro being defined.")
5125 defining_kbd_macro
= 0;
5126 update_mode_lines
++;
5128 unread_command_events
= Qnil
;
5129 unread_command_char
= -1;
5131 discard_tty_input ();
5133 /* Without the cast, GCC complains that this assignment loses the
5134 volatile qualifier of kbd_store_ptr. Is there anything wrong
5136 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
5137 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5143 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
5144 "Stop Emacs and return to superior process. You can resume later.\n\
5145 On systems that don't have job control, run a subshell instead.\n\n\
5146 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
5147 to be read as terminal input by Emacs's parent, after suspension.\n\
5149 Before suspending, call the functions in `suspend-hook' with no args.\n\
5150 If any of them returns nil, don't call the rest and don't suspend.\n\
5151 Otherwise, suspend normally and after resumption run the normal hook\n\
5152 `suspend-resume-hook' if that is bound and non-nil.\n\
5154 Some operating systems cannot stop the Emacs process and resume it later.\n\
5155 On such systems, Emacs starts a subshell instead of suspending.")
5157 Lisp_Object stuffstring
;
5160 int count
= specpdl_ptr
- specpdl
;
5161 int old_height
, old_width
;
5163 struct gcpro gcpro1
, gcpro2
;
5164 extern init_sys_modes ();
5166 if (!NILP (stuffstring
))
5167 CHECK_STRING (stuffstring
, 0);
5169 /* Run the functions in suspend-hook. */
5170 if (!NILP (Vrun_hooks
))
5171 call1 (Vrun_hooks
, intern ("suspend-hook"));
5173 GCPRO1 (stuffstring
);
5174 get_frame_size (&old_width
, &old_height
);
5176 /* sys_suspend can get an error if it tries to fork a subshell
5177 and the system resources aren't available for that. */
5178 record_unwind_protect (init_sys_modes
, 0);
5179 stuff_buffered_input (stuffstring
);
5181 unbind_to (count
, Qnil
);
5183 /* Check if terminal/window size has changed.
5184 Note that this is not useful when we are running directly
5185 with a window system; but suspend should be disabled in that case. */
5186 get_frame_size (&width
, &height
);
5187 if (width
!= old_width
|| height
!= old_height
)
5188 change_frame_size (selected_frame
, height
, width
, 0, 0);
5190 /* Run suspend-resume-hook. */
5191 if (!NILP (Vrun_hooks
))
5192 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
5198 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
5199 Then in any case stuff anything Emacs has read ahead and not used. */
5201 stuff_buffered_input (stuffstring
)
5202 Lisp_Object stuffstring
;
5204 register unsigned char *p
;
5206 /* stuff_char works only in BSD, versions 4.2 and up. */
5209 if (XTYPE (stuffstring
) == Lisp_String
)
5213 p
= XSTRING (stuffstring
)->data
;
5214 count
= XSTRING (stuffstring
)->size
;
5219 /* Anything we have read ahead, put back for the shell to read. */
5220 while (kbd_fetch_ptr
!= kbd_store_ptr
)
5222 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
5223 kbd_fetch_ptr
= kbd_buffer
;
5224 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
5225 stuff_char (kbd_fetch_ptr
->code
);
5226 kbd_fetch_ptr
->kind
= no_event
;
5227 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
5234 #endif /* BSD and not BSD4_1 */
5237 set_waiting_for_input (time_to_clear
)
5238 EMACS_TIME
*time_to_clear
;
5240 input_available_clear_time
= time_to_clear
;
5242 /* Tell interrupt_signal to throw back to read_char, */
5243 waiting_for_input
= 1;
5245 /* If interrupt_signal was called before and buffered a C-g,
5246 make it run again now, to avoid timing error. */
5247 if (!NILP (Vquit_flag
))
5248 quit_throw_to_read_char ();
5251 clear_waiting_for_input ()
5253 /* Tell interrupt_signal not to throw back to read_char, */
5254 waiting_for_input
= 0;
5255 input_available_clear_time
= 0;
5258 /* This routine is called at interrupt level in response to C-G.
5259 If interrupt_input, this is the handler for SIGINT.
5260 Otherwise, it is called from kbd_buffer_store_event,
5261 in handling SIGIO or SIGTINT.
5263 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
5264 immediately throw back to read_char.
5266 Otherwise it sets the Lisp variable quit-flag not-nil.
5267 This causes eval to throw, when it gets a chance.
5268 If quit-flag is already non-nil, it stops the job right away. */
5274 /* Must preserve main program's value of errno. */
5275 int old_errno
= errno
;
5278 /* USG systems forget handlers when they are used;
5279 must reestablish each time */
5280 signal (SIGINT
, interrupt_signal
);
5281 signal (SIGQUIT
, interrupt_signal
);
5286 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
5291 #ifdef SIGTSTP /* Support possible in later USG versions */
5293 * On systems which can suspend the current process and return to the original
5294 * shell, this command causes the user to end up back at the shell.
5295 * The "Auto-save" and "Abort" questions are not asked until
5296 * the user elects to return to emacs, at which point he can save the current
5297 * job and either dump core or continue.
5302 if (sys_suspend () == -1)
5304 printf ("Not running as a subprocess;\n");
5305 printf ("you can continue or abort.\n");
5308 /* Perhaps should really fork an inferior shell?
5309 But that would not provide any way to get back
5310 to the original shell, ever. */
5311 printf ("No support for stopping a process on this operating system;\n");
5312 printf ("you can continue or abort.\n");
5313 #endif /* not VMS */
5314 #endif /* not SIGTSTP */
5316 /* We must remain inside the screen area when the internal terminal
5317 is used. Note that [Enter] is not echoed by dos. */
5320 printf ("Auto-save? (y or n) ");
5322 if (((c
= getchar ()) & ~040) == 'Y')
5324 Fdo_auto_save (Qt
, Qnil
);
5326 printf ("\r\nAuto-save done");
5327 #else /* not MSDOS */
5328 printf ("Auto-save done\n");
5329 #endif /* not MSDOS */
5331 while (c
!= '\n') c
= getchar ();
5333 printf ("\r\nAbort? (y or n) ");
5334 #else /* not MSDOS */
5336 printf ("Abort (and enter debugger)? (y or n) ");
5338 printf ("Abort (and dump core)? (y or n) ");
5339 #endif /* not VMS */
5340 #endif /* not MSDOS */
5342 if (((c
= getchar ()) & ~040) == 'Y')
5344 while (c
!= '\n') c
= getchar ();
5346 printf ("\r\nContinuing...\r\n");
5347 #else /* not MSDOS */
5348 printf ("Continuing...\n");
5349 #endif /* not MSDOS */
5355 /* If executing a function that wants to be interrupted out of
5356 and the user has not deferred quitting by binding `inhibit-quit'
5357 then quit right away. */
5358 if (immediate_quit
&& NILP (Vinhibit_quit
))
5362 Fsignal (Qquit
, Qnil
);
5365 /* Else request quit when it's safe */
5369 if (waiting_for_input
&& !echoing
)
5370 quit_throw_to_read_char ();
5375 /* Handle a C-g by making read_char return C-g. */
5377 quit_throw_to_read_char ()
5379 quit_error_check ();
5381 /* Prevent another signal from doing this before we finish. */
5382 clear_waiting_for_input ();
5385 unread_command_events
= Qnil
;
5386 unread_command_char
= -1;
5388 #ifdef POLL_FOR_INPUT
5389 /* May be > 1 if in recursive minibuffer. */
5390 if (poll_suppress_count
== 0)
5394 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
5395 && XFRAME (internal_last_event_frame
) != selected_frame
)
5396 Fhandle_switch_frame (make_lispy_switch_frame (internal_last_event_frame
));
5399 _longjmp (getcjmp
, 1);
5402 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
5403 "Set mode of reading keyboard input.\n\
5404 First arg INTERRUPT non-nil means use input interrupts;\n\
5405 nil means use CBREAK mode.\n\
5406 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
5407 (no effect except in CBREAK mode).\n\
5408 Third arg META t means accept 8-bit input (for a Meta key).\n\
5409 META nil means ignore the top bit, on the assumption it is parity.\n\
5410 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
5411 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
5412 See also `current-input-mode'.")
5413 (interrupt
, flow
, meta
, quit
)
5414 Lisp_Object interrupt
, flow
, meta
, quit
;
5417 && (XTYPE (quit
) != Lisp_Int
5418 || XINT (quit
) < 0 || XINT (quit
) > 0400))
5419 error ("set-input-mode: QUIT must be an ASCII character");
5421 #ifdef POLL_FOR_INPUT
5427 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5428 #ifdef NO_SOCK_SIGIO
5429 if (read_socket_hook
)
5430 interrupt_input
= 0; /* No interrupts if reading from a socket. */
5432 #endif /* NO_SOCK_SIGIO */
5433 interrupt_input
= !NILP (interrupt
);
5434 #else /* not SIGIO */
5435 interrupt_input
= 0;
5436 #endif /* not SIGIO */
5437 /* Our VMS input only works by interrupts, as of now. */
5439 interrupt_input
= 1;
5441 flow_control
= !NILP (flow
);
5444 else if (EQ (meta
, Qt
))
5449 /* Don't let this value be out of range. */
5450 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
5454 #ifdef POLL_FOR_INPUT
5455 poll_suppress_count
= 1;
5461 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
5462 "Return information about the way Emacs currently reads keyboard input.\n\
5463 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
5464 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
5465 nil, Emacs is using CBREAK mode.\n\
5466 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
5467 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
5468 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
5469 META nil means ignoring the top bit, on the assumption it is parity.\n\
5470 META is neither t nor nil if accepting 8-bit input and using\n\
5471 all 8 bits as the character code.\n\
5472 QUIT is the character Emacs currently uses to quit.\n\
5473 The elements of this list correspond to the arguments of\n\
5479 val
[0] = interrupt_input
? Qt
: Qnil
;
5480 val
[1] = flow_control
? Qt
: Qnil
;
5481 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
5482 XFASTINT (val
[3]) = quit_char
;
5484 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
5490 /* This is correct before outermost invocation of the editor loop */
5491 command_loop_level
= -1;
5493 quit_char
= Ctl ('g');
5494 unread_command_events
= Qnil
;
5495 unread_command_char
= -1;
5497 recent_keys_index
= 0;
5498 kbd_fetch_ptr
= kbd_buffer
;
5499 kbd_store_ptr
= kbd_buffer
;
5500 do_mouse_tracking
= 0;
5504 /* This means that command_loop_1 won't try to select anything the first
5506 internal_last_event_frame
= Qnil
;
5507 Vlast_event_frame
= internal_last_event_frame
;
5510 /* If we're running a dumped Emacs, we need to clear out
5511 kbd_buffer_frame_or_window, in case some events got into it
5514 If we're running an undumped Emacs, it hasn't been initialized by
5515 syms_of_keyboard yet. */
5517 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5519 if (!noninteractive
)
5521 signal (SIGINT
, interrupt_signal
);
5522 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
5523 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
5524 SIGQUIT and we can't tell which one it will give us. */
5525 signal (SIGQUIT
, interrupt_signal
);
5526 #endif /* HAVE_TERMIO */
5527 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5529 signal (SIGIO
, input_available_signal
);
5533 /* Use interrupt input by default, if it works and noninterrupt input
5534 has deficiencies. */
5536 #ifdef INTERRUPT_INPUT
5537 interrupt_input
= 1;
5539 interrupt_input
= 0;
5542 /* Our VMS input only works by interrupts, as of now. */
5544 interrupt_input
= 1;
5550 if (keyboard_init_hook
)
5551 (*keyboard_init_hook
) ();
5553 #ifdef POLL_FOR_INPUT
5554 poll_suppress_count
= 1;
5559 /* This type's only use is in syms_of_keyboard, to initialize the
5560 event header symbols and put properties on them. */
5567 struct event_head head_table
[] = {
5568 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
5569 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
5570 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
5575 Qdisabled_command_hook
= intern ("disabled-command-hook");
5576 staticpro (&Qdisabled_command_hook
);
5578 Qself_insert_command
= intern ("self-insert-command");
5579 staticpro (&Qself_insert_command
);
5581 Qforward_char
= intern ("forward-char");
5582 staticpro (&Qforward_char
);
5584 Qbackward_char
= intern ("backward-char");
5585 staticpro (&Qbackward_char
);
5587 Qdisabled
= intern ("disabled");
5588 staticpro (&Qdisabled
);
5590 Qundefined
= intern ("undefined");
5591 staticpro (&Qundefined
);
5593 Qpre_command_hook
= intern ("pre-command-hook");
5594 staticpro (&Qpre_command_hook
);
5596 Qpost_command_hook
= intern ("post-command-hook");
5597 staticpro (&Qpost_command_hook
);
5599 Qcommand_hook_internal
= intern ("command-hook-internal");
5600 staticpro (&Qcommand_hook_internal
);
5602 Qfunction_key
= intern ("function-key");
5603 staticpro (&Qfunction_key
);
5604 Qmouse_click
= intern ("mouse-click");
5605 staticpro (&Qmouse_click
);
5607 Qmenu_enable
= intern ("menu-enable");
5608 staticpro (&Qmenu_enable
);
5610 Qmode_line
= intern ("mode-line");
5611 staticpro (&Qmode_line
);
5612 Qvertical_line
= intern ("vertical-line");
5613 staticpro (&Qvertical_line
);
5614 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
5615 staticpro (&Qvertical_scroll_bar
);
5616 Qmenu_bar
= intern ("menu-bar");
5617 staticpro (&Qmenu_bar
);
5619 Qabove_handle
= intern ("above-handle");
5620 staticpro (&Qabove_handle
);
5621 Qhandle
= intern ("handle");
5622 staticpro (&Qhandle
);
5623 Qbelow_handle
= intern ("below-handle");
5624 staticpro (&Qbelow_handle
);
5626 Qevent_kind
= intern ("event-kind");
5627 staticpro (&Qevent_kind
);
5628 Qevent_symbol_elements
= intern ("event-symbol-elements");
5629 staticpro (&Qevent_symbol_elements
);
5630 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
5631 staticpro (&Qevent_symbol_element_mask
);
5632 Qmodifier_cache
= intern ("modifier-cache");
5633 staticpro (&Qmodifier_cache
);
5635 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
5636 staticpro (&Qrecompute_lucid_menubar
);
5637 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
5638 staticpro (&Qactivate_menubar_hook
);
5641 struct event_head
*p
;
5643 for (p
= head_table
;
5644 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
5647 *p
->var
= intern (p
->name
);
5649 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
5650 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
5654 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
5655 staticpro (&button_down_location
);
5659 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
5661 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
5662 for (i
= 0; i
< len
; i
++)
5663 if (modifier_names
[i
])
5664 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
5665 staticpro (&modifier_symbols
);
5668 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
5669 staticpro (&recent_keys
);
5671 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
5672 staticpro (&this_command_keys
);
5674 Qextended_command_history
= intern ("extended-command-history");
5675 Fset (Qextended_command_history
, Qnil
);
5676 staticpro (&Qextended_command_history
);
5678 kbd_buffer_frame_or_window
5679 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
5680 staticpro (&kbd_buffer_frame_or_window
);
5682 func_key_syms
= Qnil
;
5683 staticpro (&func_key_syms
);
5686 staticpro (&mouse_syms
);
5688 unread_switch_frame
= Qnil
;
5689 staticpro (&unread_switch_frame
);
5691 defsubr (&Sread_key_sequence
);
5692 defsubr (&Srecursive_edit
);
5693 defsubr (&Strack_mouse
);
5694 defsubr (&Sinput_pending_p
);
5695 defsubr (&Scommand_execute
);
5696 defsubr (&Srecent_keys
);
5697 defsubr (&Sthis_command_keys
);
5698 defsubr (&Ssuspend_emacs
);
5699 defsubr (&Sabort_recursive_edit
);
5700 defsubr (&Sexit_recursive_edit
);
5701 defsubr (&Srecursion_depth
);
5702 defsubr (&Stop_level
);
5703 defsubr (&Sdiscard_input
);
5704 defsubr (&Sopen_dribble_file
);
5705 defsubr (&Sset_input_mode
);
5706 defsubr (&Scurrent_input_mode
);
5707 defsubr (&Sexecute_extended_command
);
5709 DEFVAR_LISP ("last-command-char", &last_command_char
,
5710 "Last input event that was part of a command.");
5712 DEFVAR_LISP ("last-command-event", &last_command_char
,
5713 "Last input event that was part of a command.");
5715 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
5716 "Last input event in a command, except for mouse menu events.\n\
5717 Mouse menus give back keys that don't look like mouse events;\n\
5718 this variable holds the actual mouse event that led to the menu,\n\
5719 so that you can determine whether the command was run by mouse or not.");
5721 DEFVAR_LISP ("last-input-char", &last_input_char
,
5722 "Last input event.");
5724 DEFVAR_LISP ("last-input-event", &last_input_char
,
5725 "Last input event.");
5727 DEFVAR_LISP ("unread-command-events", &unread_command_events
,
5728 "List of objects to be read as next command input events.");
5730 DEFVAR_INT ("unread-command-char", &unread_command_char
,
5731 "If not -1, an object to be read as next command input event.");
5733 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
5734 "Meta-prefix character code. Meta-foo as command input\n\
5735 turns into this character followed by foo.");
5736 XSET (meta_prefix_char
, Lisp_Int
, 033);
5738 DEFVAR_LISP ("last-command", &last_command
,
5739 "The last command executed. Normally a symbol with a function definition,\n\
5740 but can be whatever was found in the keymap, or whatever the variable\n\
5741 `this-command' was set to by that command.");
5742 last_command
= Qnil
;
5744 DEFVAR_LISP ("this-command", &this_command
,
5745 "The command now being executed.\n\
5746 The command can set this variable; whatever is put here\n\
5747 will be in `last-command' during the following command.");
5748 this_command
= Qnil
;
5750 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
5751 "*Number of keyboard input characters between auto-saves.\n\
5752 Zero means disable autosaving due to number of characters typed.");
5753 auto_save_interval
= 300;
5755 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
5756 "*Number of seconds idle time before auto-save.\n\
5757 Zero or nil means disable auto-saving due to idleness.\n\
5758 After auto-saving due to this many seconds of idle time,\n\
5759 Emacs also does a garbage collection if that seems to be warranted.");
5760 XFASTINT (Vauto_save_timeout
) = 30;
5762 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
5763 "*Nonzero means echo unfinished commands after this many seconds of pause.");
5764 echo_keystrokes
= 1;
5766 DEFVAR_INT ("polling-period", &polling_period
,
5767 "*Interval between polling for input during Lisp execution.\n\
5768 The reason for polling is to make C-g work to stop a running program.\n\
5769 Polling is needed only when using X windows and SIGIO does not work.\n\
5770 Polling is automatically disabled in all other cases.");
5773 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
5774 "*Maximum time between mouse clicks to make a double-click.\n\
5775 Measured in milliseconds. nil means disable double-click recognition;\n\
5776 t means double-clicks have no time limit and are detected\n\
5777 by position only.");
5778 Vdouble_click_time
= make_number (500);
5780 DEFVAR_INT ("num-input-keys", &num_input_keys
,
5781 "*Number of complete keys read from the keyboard so far.");
5785 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
5786 "*The frame in which the most recently read event occurred.\n\
5787 If the last event came from a keyboard macro, this is set to `macro'.");
5788 Vlast_event_frame
= Qnil
;
5791 DEFVAR_LISP ("help-char", &Vhelp_char
,
5792 "Character to recognize as meaning Help.\n\
5793 When it is read, do `(eval help-form)', and display result if it's a string.\n\
5794 If the value of `help-form' is nil, this char can be read normally.");
5795 XSET (Vhelp_char
, Lisp_Int
, Ctl ('H'));
5797 DEFVAR_LISP ("help-form", &Vhelp_form
,
5798 "Form to execute when character `help-char' is read.\n\
5799 If the form returns a string, that string is displayed.\n\
5800 If `help-form' is nil, the help char is not recognized.");
5803 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
5804 "Command to run when `help-char' character follows a prefix key.\n\
5805 This command is used only when there is no actual binding\n\
5806 for that character after that prefix key.");
5807 Vprefix_help_command
= Qnil
;
5809 DEFVAR_LISP ("top-level", &Vtop_level
,
5810 "Form to evaluate when Emacs starts up.\n\
5811 Useful to set before you dump a modified Emacs.");
5814 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
5815 "String used as translate table for keyboard input, or nil.\n\
5816 Each character is looked up in this string and the contents used instead.\n\
5817 If string is of length N, character codes N and up are untranslated.");
5818 Vkeyboard_translate_table
= Qnil
;
5820 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
5821 "Keymap of key translations that can override keymaps.\n\
5822 This keymap works like `function-key-map', but comes after that,\n\
5823 and applies even for keys that have ordinary bindings.");
5824 Vkey_translation_map
= Qnil
;
5826 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
5827 "Non-nil means prompt with menus when appropriate.\n\
5828 This is done when reading from a keymap that has a prompt string,\n\
5829 for elements that have prompt strings.\n\
5830 The menu is displayed on the screen\n\
5831 if X menus were enabled at configuration\n\
5832 time and the previous event was a mouse click prefix key.\n\
5833 Otherwise, menu prompting uses the echo area.");
5836 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
5837 "Character to see next line of menu prompt.\n\
5838 Type this character while in a menu prompt to rotate around the lines of it.");
5839 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
5841 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
5842 "A mask of additional modifier keys to use with every keyboard character.\n\
5843 Emacs applies the modifiers of the character stored here to each keyboard\n\
5844 character it reads. For example, after evaluating the expression\n\
5845 (setq extra-keyboard-modifiers ?\C-x)\n\
5846 all input characters will have the control modifier applied to them.\n\
5848 Note that the character ?\C-@, equivalent to the integer zero, does\n\
5849 not count as a control character; rather, it counts as a character\n\
5850 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
5851 cancels any modification.");
5852 extra_keyboard_modifiers
= 0;
5854 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
5855 "If an editing command sets this to t, deactivate the mark afterward.\n\
5856 The command loop sets this to nil before each command,\n\
5857 and tests the value when the command returns.\n\
5858 Buffer modification stores t in this variable.");
5859 Vdeactivate_mark
= Qnil
;
5861 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
5862 "Temporary storage of pre-command-hook or post-command-hook.");
5863 Vcommand_hook_internal
= Qnil
;
5865 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
5866 "Normal hook run before each command is executed.");
5867 Vpre_command_hook
= Qnil
;
5869 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
5870 "Normal hook run after each command is executed.");
5871 Vpost_command_hook
= Qnil
;
5873 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
5874 "t means menu bar, specified Lucid style, needs to be recomputed.");
5875 Vlucid_menu_bar_dirty_flag
= Qnil
;
5877 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
5878 "List of menu bar items to move to the end of the menu bar.\n\
5879 The elements of the list are event types that may have menu bar bindings.");
5880 Vmenu_bar_final_items
= Qnil
;
5882 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
5883 "Keymap that overrides all other local keymaps.\n\
5884 If this variable is non-nil, it is used as a keymap instead of the\n\
5885 buffer's local map, and the minor mode keymaps and text property keymaps.");
5886 Voverriding_local_map
= Qnil
;
5888 DEFVAR_BOOL ("track-mouse", &do_mouse_tracking
,
5889 "*Non-nil means generate motion events for mouse motion.");
5891 DEFVAR_LISP ("vendor-key-alist", &Vvendor_key_alist
,
5892 "Alist of vendor-specific X windows key symbols.\n\
5893 Each element should have the form (N . SYMBOL) where N is the\n\
5894 numeric keysym code (sans the \"vendor-specific\" bit 1<<28)\n\
5895 and SYMBOL is its name.");
5896 Vmenu_bar_final_items
= Qnil
;
5901 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
5902 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
5903 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
5904 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
5905 initial_define_key (meta_map
, 'x', "execute-extended-command");