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;
903 this_command_key_count
= 0;
904 last_command
= this_command
;
906 /* Make sure this hook runs after commands that get errors and
907 throw to top level. */
908 if (!NILP (Vpost_command_hook
))
910 /* If we get an error during the post-command-hook,
911 cause post-command-hook to be nil. */
912 Vcommand_hook_internal
= Vpost_command_hook
;
913 Vpost_command_hook
= Qnil
;
915 call1 (Vrun_hooks
, Qcommand_hook_internal
);
917 Vpost_command_hook
= Vcommand_hook_internal
;
922 /* Install chars successfully executed in kbd macro. */
924 if (defining_kbd_macro
&& NILP (Vprefix_arg
))
925 finalize_kbd_macro_chars ();
927 /* Make sure the current window's buffer is selected. */
928 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
929 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
931 /* Display any malloc warning that just came out. Use while because
932 displaying one warning can cause another. */
934 while (pending_malloc_warning
)
935 display_malloc_warning ();
939 Vdeactivate_mark
= Qnil
;
941 /* If minibuffer on and echo area in use,
942 wait 2 sec and redraw minibuffer. */
944 if (minibuf_level
&& echo_area_glyphs
)
946 /* Bind inhibit-quit to t so that C-g gets read in
947 rather than quitting back to the minibuffer. */
948 int count
= specpdl_ptr
- specpdl
;
949 specbind (Qinhibit_quit
, Qt
);
950 Fsit_for (make_number (2), Qnil
, Qnil
);
951 unbind_to (count
, Qnil
);
953 echo_area_glyphs
= 0;
955 if (!NILP (Vquit_flag
))
958 unread_command_events
= Fcons (make_number (quit_char
), Qnil
);
963 alloca (0); /* Cause a garbage collection now */
964 /* Since we can free the most stuff here. */
965 #endif /* C_ALLOCA */
969 /* Select the frame that the last event came from. Usually,
970 switch-frame events will take care of this, but if some lisp
971 code swallows a switch-frame event, we'll fix things up here.
972 Is this a good idea? */
973 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
974 && XFRAME (internal_last_event_frame
) != selected_frame
)
975 Fselect_frame (internal_last_event_frame
, Qnil
);
978 /* If it has changed current-menubar from previous value,
979 really recompute the menubar from the value. */
980 if (! NILP (Vlucid_menu_bar_dirty_flag
)
981 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
982 call0 (Qrecompute_lucid_menubar
);
984 #if 0 /* This is done in xdisp.c now. */
986 for (tem
= Vframe_list
; CONSP (tem
); tem
= XCONS (tem
)->cdr
)
988 struct frame
*f
= XFRAME (XCONS (tem
)->car
);
989 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
991 /* If the user has switched buffers or windows, we need to
992 recompute to reflect the new bindings. But we'll
993 recompute when update_mode_lines is set too; that means
994 that people can use force-mode-line-update to request
995 that the menu bar be recomputed. The adverse effect on
996 the rest of the redisplay algorithm is about the same as
997 windows_or_buffers_changed anyway. */
998 if (windows_or_buffers_changed
1000 || (XFASTINT (w
->last_modified
) < MODIFF
1001 && (XFASTINT (w
->last_modified
)
1002 <= XBUFFER (w
->buffer
)->save_modified
)))
1004 struct buffer
*prev
= current_buffer
;
1005 current_buffer
= XBUFFER (w
->buffer
);
1006 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items ();
1007 current_buffer
= prev
;
1010 #endif /* MULTI_FRAME */
1013 /* Read next key sequence; i gets its length. */
1014 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), Qnil
);
1018 /* Now we have read a key sequence of length I,
1019 or else I is 0 and we found end of file. */
1021 if (i
== 0) /* End of file -- happens only in */
1022 return Qnil
; /* a kbd macro, at the end. */
1023 /* -1 means read_key_sequence got a menu that was rejected.
1024 Just loop around and read another command. */
1028 this_command_key_count
= 0;
1032 last_command_char
= keybuf
[i
- 1];
1034 /* If the previous command tried to force a specific window-start,
1035 forget about that, in case this command moves point far away
1036 from that position. */
1037 XWINDOW (selected_window
)->force_start
= Qnil
;
1039 cmd
= read_key_sequence_cmd
;
1040 if (!NILP (Vexecuting_macro
))
1042 if (!NILP (Vquit_flag
))
1044 Vexecuting_macro
= Qt
;
1045 QUIT
; /* Make some noise. */
1046 /* Will return since macro now empty. */
1050 /* Do redisplay processing after this command except in special
1051 cases identified below that set no_redisplay to 1.
1052 (actually, there's currently no way to prevent the redisplay,
1053 and no_redisplay is ignored.
1054 Perhaps someday we will really implement it. */
1057 prev_buffer
= current_buffer
;
1058 prev_modiff
= MODIFF
;
1060 /* Execute the command. */
1063 if (!NILP (Vpre_command_hook
))
1065 /* If we get an error during the pre-command-hook,
1066 cause pre-command-hook to be nil. */
1067 Vcommand_hook_internal
= Vpre_command_hook
;
1068 Vpre_command_hook
= Qnil
;
1070 call1 (Vrun_hooks
, Qcommand_hook_internal
);
1072 Vpre_command_hook
= Vcommand_hook_internal
;
1075 if (NILP (this_command
))
1077 /* nil means key is undefined. */
1079 defining_kbd_macro
= 0;
1080 update_mode_lines
= 1;
1086 if (NILP (Vprefix_arg
) && ! no_direct
)
1088 /* Recognize some common commands in common situations and
1089 do them directly. */
1090 if (EQ (this_command
, Qforward_char
) && point
< ZV
)
1092 struct Lisp_Vector
*dp
1093 = window_display_table (XWINDOW (selected_window
));
1094 lose
= FETCH_CHAR (point
);
1097 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1098 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1099 : (lose
>= 0x20 && lose
< 0x7f))
1100 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1102 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1104 && !windows_or_buffers_changed
1105 && EQ (current_buffer
->selective_display
, Qnil
)
1106 && !detect_input_pending ()
1107 && NILP (Vexecuting_macro
))
1108 no_redisplay
= direct_output_forward_char (1);
1111 else if (EQ (this_command
, Qbackward_char
) && point
> BEGV
)
1113 struct Lisp_Vector
*dp
1114 = window_display_table (XWINDOW (selected_window
));
1116 lose
= FETCH_CHAR (point
);
1118 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1119 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1120 : (lose
>= 0x20 && lose
< 0x7f))
1121 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1123 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1125 && !windows_or_buffers_changed
1126 && EQ (current_buffer
->selective_display
, Qnil
)
1127 && !detect_input_pending ()
1128 && NILP (Vexecuting_macro
))
1129 no_redisplay
= direct_output_forward_char (-1);
1132 else if (EQ (this_command
, Qself_insert_command
)
1133 /* Try this optimization only on ascii keystrokes. */
1134 && XTYPE (last_command_char
) == Lisp_Int
)
1136 unsigned char c
= XINT (last_command_char
);
1138 if (NILP (Vexecuting_macro
) &&
1139 !EQ (minibuf_window
, selected_window
))
1141 if (!nonundocount
|| nonundocount
>= 20)
1148 lose
= (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1150 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1152 || MODIFF
<= current_buffer
->save_modified
1153 || windows_or_buffers_changed
1154 || !EQ (current_buffer
->selective_display
, Qnil
)
1155 || detect_input_pending ()
1156 || !NILP (Vexecuting_macro
);
1157 if (internal_self_insert (c
, 0))
1163 (point
== ZV
|| FETCH_CHAR (point
) == '\n'))
1165 struct Lisp_Vector
*dp
1166 = window_display_table (XWINDOW (selected_window
));
1171 Lisp_Object obj
= DISP_CHAR_VECTOR (dp
, lose
);
1173 if (XTYPE (obj
) == Lisp_Vector
1174 && XVECTOR (obj
)->size
== 1
1175 && (XTYPE (obj
= XVECTOR (obj
)->contents
[0])
1178 direct_output_for_insert (XINT (obj
));
1182 if (lose
>= 0x20 && lose
<= 0x7e)
1183 no_redisplay
= direct_output_for_insert (lose
);
1190 /* Here for a command that isn't executed directly */
1193 if (NILP (Vprefix_arg
))
1195 Fcommand_execute (this_command
, Qnil
);
1200 if (!NILP (Vpost_command_hook
))
1202 /* If we get an error during the post-command-hook,
1203 cause post-command-hook to be nil. */
1204 Vcommand_hook_internal
= Vpost_command_hook
;
1205 Vpost_command_hook
= Qnil
;
1207 call1 (Vrun_hooks
, Qcommand_hook_internal
);
1209 Vpost_command_hook
= Vcommand_hook_internal
;
1212 /* If there is a prefix argument,
1213 1) We don't want last_command to be ``universal-argument''
1214 (that would be dumb), so don't set last_command,
1215 2) we want to leave echoing on so that the prefix will be
1216 echoed as part of this key sequence, so don't call
1218 3) we want to leave this_command_key_count non-zero, so that
1219 read_char will realize that it is re-reading a character, and
1220 not echo it a second time. */
1221 if (NILP (Vprefix_arg
))
1223 last_command
= this_command
;
1225 this_command_key_count
= 0;
1228 if (!NILP (current_buffer
->mark_active
))
1230 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1232 current_buffer
->mark_active
= Qnil
;
1233 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1235 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1236 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1241 /* Number of seconds between polling for input. */
1244 /* Nonzero means polling for input is temporarily suppressed. */
1245 int poll_suppress_count
;
1247 #ifdef POLL_FOR_INPUT
1248 int polling_for_input
;
1250 /* Handle an alarm once each second and read pending input
1251 so as to handle a C-g if it comces in. */
1254 input_poll_signal ()
1256 if (interrupt_input_blocked
== 0
1257 && !waiting_for_input
)
1258 read_avail_input (0);
1259 signal (SIGALRM
, input_poll_signal
);
1260 alarm (polling_period
);
1265 /* Begin signals to poll for input, if they are appropriate.
1266 This function is called unconditionally from various places. */
1270 #ifdef POLL_FOR_INPUT
1271 if (read_socket_hook
&& !interrupt_input
)
1273 poll_suppress_count
--;
1274 if (poll_suppress_count
== 0)
1276 signal (SIGALRM
, input_poll_signal
);
1277 polling_for_input
= 1;
1278 alarm (polling_period
);
1284 /* Turn off polling. */
1288 #ifdef POLL_FOR_INPUT
1289 if (read_socket_hook
&& !interrupt_input
)
1291 if (poll_suppress_count
== 0)
1293 polling_for_input
= 0;
1296 poll_suppress_count
++;
1301 /* Set the value of poll_suppress_count to COUNT
1302 and start or stop polling accordingly. */
1305 set_poll_suppress_count (count
)
1308 #ifdef POLL_FOR_INPUT
1309 if (count
== 0 && poll_suppress_count
!= 0)
1311 poll_suppress_count
= 1;
1314 else if (count
!= 0 && poll_suppress_count
== 0)
1318 poll_suppress_count
= count
;
1322 /* Applying the control modifier to CHARACTER. */
1327 /* Save the upper bits here. */
1328 int upper
= c
& ~0177;
1332 /* Everything in the columns containing the upper-case letters
1333 denotes a control character. */
1334 if (c
>= 0100 && c
< 0140)
1338 /* Set the shift modifier for a control char
1339 made from a shifted letter. But only for letters! */
1340 if (oc
>= 'A' && oc
<= 'Z')
1341 c
|= shift_modifier
;
1344 /* The lower-case letters denote control characters too. */
1345 else if (c
>= 'a' && c
<= 'z')
1348 /* Include the bits for control and shift
1349 only if the basic ASCII code can't indicate them. */
1353 /* Replace the high bits. */
1354 c
|= (upper
& ~ctrl_modifier
);
1361 /* Input of single characters from keyboard */
1363 Lisp_Object
print_help ();
1364 static Lisp_Object
kbd_buffer_get_event ();
1366 /* read a character from the keyboard; call the redisplay if needed */
1367 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1368 -1 means do not do redisplay, but do do autosaving.
1371 /* The arguments MAPS and NMAPS are for menu prompting.
1372 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1374 PREV_EVENT is the previous input event, or nil if we are reading
1375 the first event of a key sequence.
1377 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1378 if we used a mouse menu to read the input, or zero otherwise. If
1379 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
1381 Value is t if we showed a menu and the user rejected it. */
1384 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1388 Lisp_Object prev_event
;
1389 int *used_mouse_menu
;
1391 register Lisp_Object c
;
1395 if (CONSP (unread_command_events
))
1397 c
= XCONS (unread_command_events
)->car
;
1398 unread_command_events
= XCONS (unread_command_events
)->cdr
;
1400 if (this_command_key_count
== 0)
1406 if (unread_command_char
!= -1)
1408 XSET (c
, Lisp_Int
, unread_command_char
);
1409 unread_command_char
= -1;
1411 if (this_command_key_count
== 0)
1417 if (!NILP (Vexecuting_macro
))
1420 /* We set this to Qmacro; since that's not a frame, nobody will
1421 try to switch frames on us, and the selected window will
1424 Since this event came from a macro, it would be misleading to
1425 leave internal_last_event_frame set to wherever the last
1426 real event came from. Normally, a switch-frame event selects
1427 internal_last_event_frame after each command is read, but
1428 events read from a macro should never cause a new frame to be
1430 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1433 /* Exit the macro if we are at the end.
1434 Also, some things replace the macro with t
1435 to force an early exit. */
1436 if (EQ (Vexecuting_macro
, Qt
)
1437 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1439 XSET (c
, Lisp_Int
, -1);
1443 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1444 if (XTYPE (Vexecuting_macro
) == Lisp_String
1445 && (XINT (c
) & 0x80))
1446 XFASTINT (c
) = CHAR_META
| (XINT (c
) & ~0x80);
1448 executing_macro_index
++;
1453 if (!NILP (unread_switch_frame
))
1455 c
= unread_switch_frame
;
1456 unread_switch_frame
= Qnil
;
1458 /* This event should make it into this_command_keys, and get echoed
1459 again, so we go to reread_first, rather than reread. */
1463 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1464 prepare_menu_bars ();
1466 /* Save outer setjmp data, in case called recursively. */
1467 save_getcjmp (save_jump
);
1471 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1474 if (_setjmp (getcjmp
))
1476 XSET (c
, Lisp_Int
, quit_char
);
1478 XSET (internal_last_event_frame
, Lisp_Frame
, selected_frame
);
1479 Vlast_event_frame
= internal_last_event_frame
;
1481 /* If we report the quit char as an event,
1482 don't do so more than once. */
1483 if (!NILP (Vinhibit_quit
))
1489 /* Message turns off echoing unless more keystrokes turn it on again. */
1490 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1493 /* If already echoing, continue. */
1496 /* Try reading a character via menu prompting in the minibuf.
1497 Try this before the sit-for, because the sit-for
1498 would do the wrong thing if we are supposed to do
1499 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1500 after a mouse event so don't try a minibuf menu. */
1502 if (nmaps
> 0 && INTERACTIVE
&&
1503 !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
))
1505 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1506 if ( ! NILP(c
) ) return c
;
1509 /* If in middle of key sequence and minibuffer not active,
1510 start echoing if enough time elapses. */
1511 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1513 && echo_keystrokes
> 0
1514 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1518 /* After a mouse event, start echoing right away.
1519 This is because we are probably about to display a menu,
1520 and we don't want to delay before doing so. */
1521 if (EVENT_HAS_PARAMETERS (prev_event
))
1525 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1531 /* Maybe auto save due to number of keystrokes or idle time. */
1533 if (commandflag
!= 0
1534 && auto_save_interval
> 0
1535 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1536 && !detect_input_pending ())
1539 save_getcjmp (temp
);
1540 Fdo_auto_save (Qnil
, Qnil
);
1541 restore_getcjmp (temp
);
1544 /* Try reading using an X menu.
1545 This is never confused with reading using the minibuf because the recursive
1546 call of read_char in read_char_minibuf_menu_prompt does not pass on
1548 if (nmaps
> 0 && INTERACTIVE
&&
1549 !NILP (prev_event
) && EVENT_HAS_PARAMETERS (prev_event
))
1550 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1552 /* Slow down auto saves logarithmically in size of current buffer,
1553 and garbage collect while we're at it. */
1554 if (INTERACTIVE
&& NILP (c
))
1556 int delay_level
, buffer_size
;
1558 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1559 last_non_minibuf_size
= Z
- BEG
;
1560 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1562 while (buffer_size
> 64)
1563 delay_level
++, buffer_size
-= buffer_size
>> 2;
1564 if (delay_level
< 4) delay_level
= 4;
1565 /* delay_level is 4 for files under around 50k, 7 at 100k,
1566 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1568 /* Auto save if enough time goes by without input. */
1569 if (commandflag
!= 0
1570 && num_nonmacro_input_chars
> last_auto_save
1571 && XTYPE (Vauto_save_timeout
) == Lisp_Int
1572 && XINT (Vauto_save_timeout
) > 0)
1575 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1576 tem0
= sit_for (delay
, 0, 1, 1);
1580 save_getcjmp (temp
);
1581 Fdo_auto_save (Qnil
, Qnil
);
1582 restore_getcjmp (temp
);
1584 /* If we have auto-saved and there is still no input
1585 available, garbage collect if there has been enough
1586 consing going on to make it worthwhile. */
1587 if (!detect_input_pending ()
1588 && consing_since_gc
> gc_cons_threshold
/ 2)
1590 Fgarbage_collect ();
1591 /* prepare_menu_bars isn't safe here, but it should
1592 also be unnecessary. */
1599 /* Actually read a character, waiting if necessary. */
1602 c
= kbd_buffer_get_event ();
1605 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1609 /* Terminate Emacs in batch mode if at eof. */
1610 if (noninteractive
&& XTYPE (c
) == Lisp_Int
&& XINT (c
) < 0)
1611 Fkill_emacs (make_number (1));
1613 if (XTYPE (c
) == Lisp_Int
)
1615 /* Add in any extra modifiers, where appropriate. */
1616 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1617 || ((extra_keyboard_modifiers
& 0177) < ' '
1618 && (extra_keyboard_modifiers
& 0177) != 0))
1619 XSETINT (c
, make_ctrl_char (XINT (c
)));
1621 /* Transfer any other modifier bits directly from
1622 extra_keyboard_modifiers to c. Ignore the actual character code
1623 in the low 16 bits of extra_keyboard_modifiers. */
1624 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
1629 restore_getcjmp (save_jump
);
1633 echo_area_glyphs
= 0;
1635 /* Handle things that only apply to characters. */
1636 if (XTYPE (c
) == Lisp_Int
)
1638 /* If kbd_buffer_get_event gave us an EOF, return that. */
1642 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
1643 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1644 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1648 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1649 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1650 recent_keys_index
= 0;
1652 /* Write c to the dribble file. If c is a lispy event, write
1653 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1654 If you, dear reader, have a better idea, you've got the source. :-) */
1657 if (XTYPE (c
) == Lisp_Int
)
1658 putc (XINT (c
), dribble
);
1661 Lisp_Object dribblee
= c
;
1663 /* If it's a structured event, take the event header. */
1664 dribblee
= EVENT_HEAD (dribblee
);
1666 if (XTYPE (dribblee
) == Lisp_Symbol
)
1668 putc ('<', dribble
);
1669 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1670 XSYMBOL (dribblee
)->name
->size
,
1672 putc ('>', dribble
);
1679 store_kbd_macro_char (c
);
1681 num_nonmacro_input_chars
++;
1686 /* Record this character as part of the current key.
1687 Don't record mouse motion; it should never matter. */
1688 if (! (EVENT_HAS_PARAMETERS (c
)
1689 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1692 add_command_key (c
);
1695 /* Re-reading in the middle of a command */
1697 last_input_char
= c
;
1700 /* Process the help character specially if enabled */
1701 if (EQ (c
, Vhelp_char
) && !NILP (Vhelp_form
))
1704 count
= specpdl_ptr
- specpdl
;
1706 record_unwind_protect (Fset_window_configuration
,
1707 Fcurrent_window_configuration (Qnil
));
1709 tem0
= Feval (Vhelp_form
);
1710 if (XTYPE (tem0
) == Lisp_String
)
1711 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1715 c
= read_char (0, 0, 0, Qnil
, 0);
1716 while (XTYPE (c
) == Lisp_Buffer
);
1717 /* Remove the help from the frame */
1718 unbind_to (count
, Qnil
);
1719 prepare_menu_bars ();
1721 if (EQ (c
, make_number (040)))
1725 c
= read_char (0, 0, 0, Qnil
, 0);
1726 while (XTYPE (c
) == Lisp_Buffer
);
1737 Fprinc (object
, Qnil
);
1741 /* Copy out or in the info on where C-g should throw to.
1742 This is used when running Lisp code from within get_char,
1743 in case get_char is called recursively.
1744 See read_process_output. */
1749 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1752 restore_getcjmp (temp
)
1755 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1759 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1760 of this function. */
1762 tracking_off (old_value
)
1763 Lisp_Object old_value
;
1765 if (! XFASTINT (old_value
))
1767 do_mouse_tracking
= 0;
1769 /* Redisplay may have been preempted because there was input
1770 available, and it assumes it will be called again after the
1771 input has been processed. If the only input available was
1772 the sort that we have just disabled, then we need to call
1774 if (!readable_events ())
1776 prepare_menu_bars ();
1777 redisplay_preserve_echo_area ();
1778 get_input_pending (&input_pending
);
1783 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1784 "Evaluate BODY with mouse movement events enabled.\n\
1785 Within a `track-mouse' form, mouse motion generates input events that\n\
1786 you can read with `read-event'.\n\
1787 Normally, mouse motion is ignored.")
1791 int count
= specpdl_ptr
- specpdl
;
1794 XSET (val
, Lisp_Int
, do_mouse_tracking
);
1795 record_unwind_protect (tracking_off
, val
);
1797 do_mouse_tracking
= 1;
1799 val
= Fprogn (args
);
1800 return unbind_to (count
, val
);
1803 /* Low level keyboard/mouse input.
1804 kbd_buffer_store_event places events in kbd_buffer, and
1805 kbd_buffer_get_event retrieves them.
1806 mouse_moved indicates when the mouse has moved again, and
1807 *mouse_position_hook provides the mouse position. */
1809 /* Return true iff there are any events in the queue that read-char
1810 would return. If this returns false, a read-char would block. */
1814 return ! EVENT_QUEUES_EMPTY
;
1817 /* Set this for debugging, to have a way to get out */
1820 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
1823 kbd_buffer_store_event (event
)
1824 register struct input_event
*event
;
1826 if (event
->kind
== no_event
)
1829 if (event
->kind
== ascii_keystroke
)
1831 register int c
= event
->code
& 0377;
1833 if (event
->modifiers
& ctrl_modifier
)
1834 c
= make_ctrl_char (c
);
1836 c
|= (event
->modifiers
1837 & (meta_modifier
| alt_modifier
1838 | hyper_modifier
| super_modifier
));
1842 extern SIGTYPE
interrupt_signal ();
1845 /* If this results in a quit_char being returned to Emacs as
1846 input, set Vlast_event_frame properly. If this doesn't
1847 get returned to Emacs as an event, the next event read
1848 will set Vlast_event_frame again, so this is safe to do. */
1851 = FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
1854 internal_last_event_frame
= event
->frame_or_window
;
1856 internal_last_event_frame
= focus
;
1857 Vlast_event_frame
= internal_last_event_frame
;
1861 last_event_timestamp
= event
->timestamp
;
1862 interrupt_signal ();
1866 if (c
&& c
== stop_character
)
1873 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
1874 kbd_store_ptr
= kbd_buffer
;
1876 /* Don't let the very last slot in the buffer become full,
1877 since that would make the two pointers equal,
1878 and that is indistinguishable from an empty buffer.
1879 Discard the event if it would fill the last slot. */
1880 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
1882 kbd_store_ptr
->kind
= event
->kind
;
1883 if (event
->kind
== selection_request_event
)
1885 /* We must not use the ordinary copying code for this case,
1886 since `part' is an enum and copying it might not copy enough
1888 bcopy (event
, kbd_store_ptr
, sizeof (*event
));
1892 kbd_store_ptr
->code
= event
->code
;
1893 kbd_store_ptr
->part
= event
->part
;
1894 kbd_store_ptr
->frame_or_window
= event
->frame_or_window
;
1895 kbd_store_ptr
->modifiers
= event
->modifiers
;
1896 kbd_store_ptr
->x
= event
->x
;
1897 kbd_store_ptr
->y
= event
->y
;
1898 kbd_store_ptr
->timestamp
= event
->timestamp
;
1900 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
1902 = event
->frame_or_window
);
1908 /* Read one event from the event buffer, waiting if necessary.
1909 The value is a Lisp object representing the event.
1910 The value is nil for an event that should be ignored,
1911 or that was handled here.
1912 We always read and discard one event. */
1915 kbd_buffer_get_event ()
1923 XSET (obj
, Lisp_Int
, c
);
1927 /* Wait until there is input available. */
1930 if (!EVENT_QUEUES_EMPTY
)
1933 /* If the quit flag is set, then read_char will return
1934 quit_char, so that counts as "available input." */
1935 if (!NILP (Vquit_flag
))
1936 quit_throw_to_read_char ();
1938 /* One way or another, wait until input is available; then, if
1939 interrupt handlers have not read it, read it now. */
1942 wait_for_kbd_input ();
1944 /* Note SIGIO has been undef'd if FIONREAD is missing. */
1948 if (EVENT_QUEUES_EMPTY
)
1950 Lisp_Object minus_one
;
1952 XSET (minus_one
, Lisp_Int
, -1);
1953 wait_reading_process_input (0, 0, minus_one
, 1);
1955 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
1956 /* Pass 1 for EXPECT since we just waited to have input. */
1957 read_avail_input (1);
1959 #endif /* not VMS */
1962 /* At this point, we know that there is a readable event available
1963 somewhere. If the event queue is empty, then there must be a
1964 mouse movement enabled and available. */
1965 if (kbd_fetch_ptr
!= kbd_store_ptr
)
1967 struct input_event
*event
;
1969 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
1973 last_event_timestamp
= event
->timestamp
;
1977 /* These two kinds of events get special handling
1978 and don't actually appear to the command loop.
1979 We return nil for them. */
1980 if (event
->kind
== selection_request_event
)
1983 x_handle_selection_request (event
);
1984 kbd_fetch_ptr
= event
+ 1;
1986 /* We're getting selection request events, but we don't have
1992 else if (event
->kind
== selection_clear_event
)
1995 x_handle_selection_clear (event
);
1996 kbd_fetch_ptr
= event
+ 1;
1998 /* We're getting selection request events, but we don't have
2004 else if (event
->kind
== delete_window_event
)
2006 Lisp_Object tail
, frame
;
2009 /* If the user destroys the only frame, Emacs should exit.
2010 Count visible frames and iconified frames. */
2011 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2013 frame
= XCONS (tail
)->car
;
2014 if (XTYPE (frame
) != Lisp_Frame
|| EQ (frame
, event
->frame_or_window
))
2017 if (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
))
2024 Fdelete_frame (event
->frame_or_window
, Qt
);
2025 kbd_fetch_ptr
= event
+ 1;
2028 /* Just discard these, by returning nil.
2029 (They shouldn't be found in the buffer,
2030 but on some machines it appears they do show up.) */
2031 else if (event
->kind
== no_event
)
2032 kbd_fetch_ptr
= event
+ 1;
2034 /* If this event is on a different frame, return a switch-frame this
2035 time, and leave the event in the queue for next time. */
2039 Lisp_Object frame
= event
->frame_or_window
;
2042 if (XTYPE (frame
) == Lisp_Window
)
2043 frame
= WINDOW_FRAME (XWINDOW (frame
));
2045 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2049 if (! EQ (frame
, internal_last_event_frame
)
2050 && XFRAME (frame
) != selected_frame
)
2051 obj
= make_lispy_switch_frame (frame
);
2052 internal_last_event_frame
= frame
;
2053 #endif /* MULTI_FRAME */
2055 /* If we didn't decide to make a switch-frame event, go ahead
2056 and build a real event from the queue entry. */
2060 obj
= make_lispy_event (event
);
2062 /* Wipe out this event, to catch bugs. */
2063 event
->kind
= no_event
;
2064 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
2067 kbd_fetch_ptr
= event
+ 1;
2071 /* Try generating a mouse motion event. */
2072 else if (do_mouse_tracking
&& mouse_moved
)
2075 Lisp_Object bar_window
;
2076 enum scroll_bar_part part
;
2080 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
2085 /* Decide if we should generate a switch-frame event. Don't
2086 generate switch-frame events for motion outside of all Emacs
2090 Lisp_Object frame
= FRAME_FOCUS_FRAME (f
);
2093 XSET (frame
, Lisp_Frame
, f
);
2095 if (! EQ (frame
, internal_last_event_frame
)
2096 && XFRAME (frame
) != selected_frame
)
2097 obj
= make_lispy_switch_frame (frame
);
2098 internal_last_event_frame
= frame
;
2102 /* If we didn't decide to make a switch-frame event, go ahead and
2103 return a mouse-motion event. */
2105 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2108 /* We were promised by the above while loop that there was
2109 something for us to read! */
2112 input_pending
= readable_events ();
2115 Vlast_event_frame
= internal_last_event_frame
;
2121 /* Process any events that are not user-visible,
2122 then return, without reading any user-visible events. */
2127 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2129 struct input_event
*event
;
2131 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2135 last_event_timestamp
= event
->timestamp
;
2137 /* These two kinds of events get special handling
2138 and don't actually appear to the command loop. */
2139 if (event
->kind
== selection_request_event
)
2142 x_handle_selection_request (event
);
2143 kbd_fetch_ptr
= event
+ 1;
2145 /* We're getting selection request events, but we don't have
2151 else if (event
->kind
== selection_clear_event
)
2154 x_handle_selection_clear (event
);
2155 kbd_fetch_ptr
= event
+ 1;
2157 /* We're getting selection request events, but we don't have
2166 get_input_pending (&input_pending
);
2169 /* Caches for modify_event_symbol. */
2170 static Lisp_Object accent_key_syms
;
2171 static Lisp_Object system_key_syms
;
2172 static Lisp_Object func_key_syms
;
2173 static Lisp_Object mouse_syms
;
2175 Lisp_Object Vsystem_key_alist
;
2177 /* This is a list of keysym codes for special "accent" characters.
2178 It parallels lispy_accent_keys. */
2180 static int lispy_accent_codes
[] =
2182 #ifdef XK_dead_circumflex
2187 #ifdef XK_dead_grave
2192 #ifdef XK_dead_tilde
2197 #ifdef XK_dead_diaeresis
2202 #ifdef XK_dead_macron
2207 #ifdef XK_dead_degree
2212 #ifdef XK_dead_acute
2217 #ifdef XK_dead_cedilla
2222 #ifdef XK_dead_breve
2227 #ifdef XK_dead_ogonek
2232 #ifdef XK_dead_caron
2237 #ifdef XK_dead_doubleacute
2238 XK_dead_doubleacute
,
2242 #ifdef XK_dead_abovedot
2249 /* This is a list of Lisp names for special "accent" characters.
2250 It parallels lispy_accent_codes. */
2252 static char *lispy_accent_keys
[] =
2269 /* You'll notice that this table is arranged to be conveniently
2270 indexed by X Windows keysym values. */
2271 static char *lispy_function_keys
[] =
2273 /* X Keysym value */
2275 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2283 0, 0, 0, /* 0xff10 */
2285 0, 0, 0, 0, 0, 0, 0,
2288 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2289 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2290 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2292 "home", /* 0xff50 */ /* IsCursorKey */
2303 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2314 "break", /* 0xff6b */
2316 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2318 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2319 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2320 0, 0, 0, 0, 0, 0, 0, 0,
2321 "kp-tab", /* 0xff89 */
2323 "kp-enter", /* 0xff8d */
2325 "kp-f1", /* 0xff91 */
2330 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2331 "kp-multiply", /* 0xffaa */
2336 "kp-divide", /* 0xffaf */
2337 "kp-0", /* 0xffb0 */
2338 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2341 "kp-equal", /* 0xffbd */
2342 "f1", /* 0xffbe */ /* IsFunctionKey */
2344 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2345 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2346 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2347 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2348 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2349 0, 0, 0, 0, 0, 0, 0, 0,
2350 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2351 0, 0, 0, 0, 0, 0, 0, "delete"
2354 static char *lispy_mouse_names
[] =
2356 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2359 /* Scroll bar parts. */
2360 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2362 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2363 Lisp_Object
*scroll_bar_parts
[] = {
2364 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2368 /* A vector, indexed by button number, giving the down-going location
2369 of currently depressed buttons, both scroll bar and non-scroll bar.
2371 The elements have the form
2372 (BUTTON-NUMBER MODIFIER-MASK . REST)
2373 where REST is the cdr of a position as it would be reported in the event.
2375 The make_lispy_event function stores positions here to tell the
2376 difference between click and drag events, and to store the starting
2377 location to be included in drag events. */
2379 static Lisp_Object button_down_location
;
2381 /* Information about the most recent up-going button event: Which
2382 button, what location, and what time. */
2384 static int last_mouse_button
;
2385 static int last_mouse_x
;
2386 static int last_mouse_y
;
2387 static unsigned long button_down_time
;
2389 /* The maximum time between clicks to make a double-click,
2390 or Qnil to disable double-click detection,
2391 or Qt for no time limit. */
2392 Lisp_Object Vdouble_click_time
;
2394 /* The number of clicks in this multiple-click. */
2396 int double_click_count
;
2398 #ifdef USE_X_TOOLKIT
2399 extern Lisp_Object
map_event_to_object ();
2400 #endif /* USE_X_TOOLKIT */
2402 /* Given a struct input_event, build the lisp event which represents
2403 it. If EVENT is 0, build a mouse movement event from the mouse
2404 movement buffer, which should have a movement event in it.
2406 Note that events must be passed to this function in the order they
2407 are received; this function stores the location of button presses
2408 in order to build drag events when the button is released. */
2411 make_lispy_event (event
)
2412 struct input_event
*event
;
2416 #ifdef SWITCH_ENUM_BUG
2417 switch ((int) event
->kind
)
2419 switch (event
->kind
)
2422 /* A simple keystroke. */
2423 case ascii_keystroke
:
2425 int c
= event
->code
& 0377;
2426 /* Turn ASCII characters into control characters
2428 if (event
->modifiers
& ctrl_modifier
)
2429 c
= make_ctrl_char (c
);
2431 /* Add in the other modifier bits. We took care of ctrl_modifier
2432 just above, and the shift key was taken care of by the X code,
2433 and applied to control characters by make_ctrl_char. */
2434 c
|= (event
->modifiers
2435 & (meta_modifier
| alt_modifier
2436 | hyper_modifier
| super_modifier
));
2437 button_down_time
= 0;
2441 /* A function key. The symbol may need to have modifier prefixes
2443 case non_ascii_keystroke
:
2444 button_down_time
= 0;
2446 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
2447 if (event
->code
== lispy_accent_codes
[i
])
2448 return modify_event_symbol (i
,
2450 Qfunction_key
, Qnil
,
2451 lispy_accent_keys
, &accent_key_syms
,
2452 (sizeof (lispy_accent_keys
)
2453 / sizeof (lispy_accent_keys
[0])));
2455 /* Handle system-specific keysyms. */
2456 if (event
->code
& (1 << 28))
2458 /* We need to use an alist rather than a vector as the cache
2459 since we can't make a vector long enuf. */
2460 if (NILP (system_key_syms
))
2461 system_key_syms
= Fcons (Qnil
, Qnil
);
2462 return modify_event_symbol (event
->code
& 0xffffff,
2464 Qfunction_key
, Vsystem_key_alist
,
2465 0, &system_key_syms
, 0xffffff);
2468 return modify_event_symbol (event
->code
- 0xff00,
2470 Qfunction_key
, Qnil
,
2471 lispy_function_keys
, &func_key_syms
,
2472 (sizeof (lispy_function_keys
)
2473 / sizeof (lispy_function_keys
[0])));
2476 /* A mouse click. Figure out where it is, decide whether it's
2477 a press, click or drag, and build the appropriate structure. */
2479 case scroll_bar_click
:
2481 int button
= event
->code
;
2483 Lisp_Object position
;
2484 Lisp_Object
*start_pos_ptr
;
2485 Lisp_Object start_pos
;
2487 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2490 /* Build the position as appropriate for this mouse click. */
2491 if (event
->kind
== mouse_click
)
2494 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2499 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
2500 &column
, &row
, 0, 0);
2502 #ifdef USE_X_TOOLKIT
2503 if (FRAME_EXTERNAL_MENU_BAR (f
) && XINT (event
->y
) == -1)
2505 if (row
< FRAME_MENU_BAR_LINES (f
))
2510 #ifdef USE_X_TOOLKIT
2511 /* The click happened in the menubar.
2512 Look for the menu item selected. */
2513 items
= map_event_to_object (event
, f
);
2515 XFASTINT (event
->y
) = 1;
2516 #else /* not USE_X_TOOLKIT */
2519 items
= FRAME_MENU_BAR_ITEMS (f
);
2520 for (; CONSP (items
); items
= XCONS (items
)->cdr
)
2522 Lisp_Object pos
, string
;
2523 pos
= Fcdr (Fcdr (Fcar (items
)));
2524 string
= Fcar (Fcdr (Fcar (items
)));
2525 if (column
>= XINT (pos
)
2526 && column
< XINT (pos
) + XSTRING (string
)->size
)
2529 #endif /* not USE_X_TOOLKIT */
2532 = Fcons (event
->frame_or_window
,
2534 Fcons (Fcons (event
->x
, event
->y
),
2535 Fcons (make_number (event
->timestamp
),
2539 return Fcons (Fcar (Fcar (items
)),
2540 Fcons (position
, Qnil
));
2542 return Fcons (Qnil
, Fcons (position
, Qnil
));
2545 window
= window_from_coordinates (f
, column
, row
, &part
);
2547 if (XTYPE (window
) != Lisp_Window
)
2551 int pixcolumn
, pixrow
;
2552 column
-= XINT (XWINDOW (window
)->left
);
2553 row
-= XINT (XWINDOW (window
)->top
);
2554 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
2555 XSETINT (event
->x
, pixcolumn
);
2556 XSETINT (event
->y
, pixrow
);
2561 posn
= Qvertical_line
;
2563 XSET (posn
, Lisp_Int
,
2564 buffer_posn_from_coords (XWINDOW (window
),
2571 Fcons (Fcons (event
->x
, event
->y
),
2572 Fcons (make_number (event
->timestamp
),
2578 Lisp_Object portion_whole
;
2581 window
= event
->frame_or_window
;
2582 portion_whole
= Fcons (event
->x
, event
->y
);
2583 part
= *scroll_bar_parts
[(int) event
->part
];
2587 Fcons (Qvertical_scroll_bar
,
2588 Fcons (portion_whole
,
2589 Fcons (make_number (event
->timestamp
),
2590 Fcons (part
, Qnil
)))));
2593 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2595 start_pos
= *start_pos_ptr
;
2596 *start_pos_ptr
= Qnil
;
2598 is_double
= (button
== last_mouse_button
2599 && XINT (event
->x
) == last_mouse_x
2600 && XINT (event
->y
) == last_mouse_y
2601 && button_down_time
!= 0
2602 && (EQ (Vdouble_click_time
, Qt
)
2603 || (INTEGERP (Vdouble_click_time
)
2604 && ((int)(event
->timestamp
- button_down_time
)
2605 < XINT (Vdouble_click_time
)))));
2606 last_mouse_button
= button
;
2607 last_mouse_x
= XINT (event
->x
);
2608 last_mouse_y
= XINT (event
->y
);
2610 /* If this is a button press, squirrel away the location, so
2611 we can decide later whether it was a click or a drag. */
2612 if (event
->modifiers
& down_modifier
)
2616 double_click_count
++;
2617 event
->modifiers
|= ((double_click_count
> 2)
2622 double_click_count
= 1;
2623 button_down_time
= event
->timestamp
;
2624 *start_pos_ptr
= Fcopy_alist (position
);
2627 /* Now we're releasing a button - check the co-ordinates to
2628 see if this was a click or a drag. */
2629 else if (event
->modifiers
& up_modifier
)
2631 /* If we did not see a down before this up,
2632 ignore the up. Probably this happened because
2633 the down event chose a menu item.
2634 It would be an annoyance to treat the release
2635 of the button that chose the menu item
2636 as a separate event. */
2638 if (XTYPE (start_pos
) != Lisp_Cons
)
2641 event
->modifiers
&= ~up_modifier
;
2642 #if 0 /* Formerly we treated an up with no down as a click event. */
2643 if (XTYPE (start_pos
) != Lisp_Cons
)
2644 event
->modifiers
|= click_modifier
;
2648 /* The third element of every position should be the (x,y)
2650 Lisp_Object down
= Fnth (make_number (2), start_pos
);
2652 if (EQ (event
->x
, XCONS (down
)->car
)
2653 && EQ (event
->y
, XCONS (down
)->cdr
))
2655 if (is_double
&& double_click_count
> 1)
2656 event
->modifiers
|= ((double_click_count
> 2)
2660 event
->modifiers
|= click_modifier
;
2664 button_down_time
= 0;
2665 event
->modifiers
|= drag_modifier
;
2670 /* Every mouse event should either have the down_modifier or
2671 the up_modifier set. */
2675 /* Get the symbol we should use for the mouse click. */
2677 = modify_event_symbol (button
,
2680 lispy_mouse_names
, &mouse_syms
,
2681 (sizeof (lispy_mouse_names
)
2682 / sizeof (lispy_mouse_names
[0])));
2684 if (event
->modifiers
& drag_modifier
)
2689 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2692 Fcons (make_number (double_click_count
),
2701 /* The 'kind' field of the event is something we don't recognize. */
2708 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2710 Lisp_Object bar_window
;
2711 enum scroll_bar_part part
;
2715 /* Is it a scroll bar movement? */
2716 if (frame
&& ! NILP (bar_window
))
2718 Lisp_Object part_sym
= *scroll_bar_parts
[(int) part
];
2720 return Fcons (Qscroll_bar_movement
,
2721 (Fcons (Fcons (bar_window
,
2722 Fcons (Qvertical_scroll_bar
,
2723 Fcons (Fcons (x
, y
),
2724 Fcons (make_number (time
),
2730 /* Or is it an ordinary mouse movement? */
2738 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
, 0, 0);
2741 window
= window_from_coordinates (frame
, column
, row
, &area
);
2745 if (XTYPE (window
) == Lisp_Window
)
2747 int pixcolumn
, pixrow
;
2748 column
-= XINT (XWINDOW (window
)->left
);
2749 row
-= XINT (XWINDOW (window
)->top
);
2750 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
2751 XSETINT (x
, pixcolumn
);
2752 XSETINT (y
, pixrow
);
2757 posn
= Qvertical_line
;
2759 XSET (posn
, Lisp_Int
,
2760 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
2762 else if (frame
!= 0)
2764 XSET (window
, Lisp_Frame
, frame
);
2775 return Fcons (Qmouse_movement
,
2776 Fcons (Fcons (window
,
2778 Fcons (Fcons (x
, y
),
2779 Fcons (make_number (time
),
2785 /* Construct a switch frame event. */
2787 make_lispy_switch_frame (frame
)
2790 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
2793 /* Manipulating modifiers. */
2795 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
2797 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2798 SYMBOL's name of the end of the modifiers; the string from this
2799 position is the unmodified symbol name.
2801 This doesn't use any caches. */
2803 parse_modifiers_uncached (symbol
, modifier_end
)
2807 struct Lisp_String
*name
;
2811 CHECK_SYMBOL (symbol
, 1);
2814 name
= XSYMBOL (symbol
)->name
;
2817 for (i
= 0; i
+2 <= name
->size
; )
2818 switch (name
->data
[i
])
2820 #define SINGLE_LETTER_MOD(bit) \
2821 if (name->data[i+1] != '-') \
2822 goto no_more_modifiers; \
2827 SINGLE_LETTER_MOD (alt_modifier
);
2831 SINGLE_LETTER_MOD (ctrl_modifier
);
2835 SINGLE_LETTER_MOD (hyper_modifier
);
2839 SINGLE_LETTER_MOD (meta_modifier
);
2843 SINGLE_LETTER_MOD (shift_modifier
);
2847 SINGLE_LETTER_MOD (super_modifier
);
2851 if (i
+ 5 > name
->size
)
2852 goto no_more_modifiers
;
2853 if (! strncmp (name
->data
+ i
, "drag-", 5))
2855 modifiers
|= drag_modifier
;
2858 else if (! strncmp (name
->data
+ i
, "down-", 5))
2860 modifiers
|= down_modifier
;
2863 else if (i
+ 7 <= name
->size
2864 && ! strncmp (name
->data
+ i
, "double-", 7))
2866 modifiers
|= double_modifier
;
2870 goto no_more_modifiers
;
2874 if (i
+ 7 > name
->size
)
2875 goto no_more_modifiers
;
2876 if (! strncmp (name
->data
+ i
, "triple-", 7))
2878 modifiers
|= triple_modifier
;
2882 goto no_more_modifiers
;
2886 goto no_more_modifiers
;
2888 #undef SINGLE_LETTER_MOD
2892 /* Should we include the `click' modifier? */
2893 if (! (modifiers
& (down_modifier
| drag_modifier
2894 | double_modifier
| triple_modifier
))
2895 && i
+ 7 == name
->size
2896 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
2897 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
2898 modifiers
|= click_modifier
;
2907 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
2908 prepended to the string BASE[0..BASE_LEN-1].
2909 This doesn't use any caches. */
2911 apply_modifiers_uncached (modifiers
, base
, base_len
)
2916 /* Since BASE could contain nulls, we can't use intern here; we have
2917 to use Fintern, which expects a genuine Lisp_String, and keeps a
2920 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
2926 /* Only the event queue may use the `up' modifier; it should always
2927 be turned into a click or drag event before presented to lisp code. */
2928 if (modifiers
& up_modifier
)
2931 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
2932 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
2933 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
2934 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
2935 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
2936 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
2937 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
2938 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
2939 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
2940 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
2941 /* The click modifier is denoted by the absence of other modifiers. */
2945 mod_len
= p
- new_mods
;
2949 Lisp_Object new_name
= make_uninit_string (mod_len
+ base_len
);
2951 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
2952 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
2954 return Fintern (new_name
, Qnil
);
2959 static char *modifier_names
[] =
2961 "up", "down", "drag", "click", "double", "triple", 0, 0,
2962 0, 0, 0, 0, 0, 0, 0, 0,
2963 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
2965 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
2967 static Lisp_Object modifier_symbols
;
2969 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
2971 lispy_modifier_list (modifiers
)
2974 Lisp_Object modifier_list
;
2977 modifier_list
= Qnil
;
2978 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
2979 if (modifiers
& (1<<i
))
2980 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
2983 return modifier_list
;
2987 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
2988 where UNMODIFIED is the unmodified form of SYMBOL,
2989 MASK is the set of modifiers present in SYMBOL's name.
2990 This is similar to parse_modifiers_uncached, but uses the cache in
2991 SYMBOL's Qevent_symbol_element_mask property, and maintains the
2992 Qevent_symbol_elements property. */
2994 parse_modifiers (symbol
)
2997 Lisp_Object elements
= Fget (symbol
, Qevent_symbol_element_mask
);
2999 if (CONSP (elements
))
3004 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
3005 Lisp_Object unmodified
3006 = Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
3007 XSYMBOL (symbol
)->name
->size
- end
),
3011 if (modifiers
& ~((1<<VALBITS
) - 1))
3013 XFASTINT (mask
) = modifiers
;
3014 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
3016 /* Cache the parsing results on SYMBOL. */
3017 Fput (symbol
, Qevent_symbol_element_mask
,
3019 Fput (symbol
, Qevent_symbol_elements
,
3020 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
3022 /* Since we know that SYMBOL is modifiers applied to unmodified,
3023 it would be nice to put that in unmodified's cache.
3024 But we can't, since we're not sure that parse_modifiers is
3031 /* Apply the modifiers MODIFIERS to the symbol BASE.
3032 BASE must be unmodified.
3034 This is like apply_modifiers_uncached, but uses BASE's
3035 Qmodifier_cache property, if present. It also builds
3036 Qevent_symbol_elements properties, since it has that info anyway.
3038 apply_modifiers copies the value of BASE's Qevent_kind property to
3039 the modified symbol. */
3041 apply_modifiers (modifiers
, base
)
3045 Lisp_Object cache
, index
, entry
, new_symbol
;
3047 /* Mask out upper bits. We don't know where this value's been. */
3048 modifiers
&= (1<<VALBITS
) - 1;
3050 /* The click modifier never figures into cache indices. */
3051 cache
= Fget (base
, Qmodifier_cache
);
3052 XFASTINT (index
) = (modifiers
& ~click_modifier
);
3053 entry
= Fassq (index
, cache
);
3056 new_symbol
= XCONS (entry
)->cdr
;
3059 /* We have to create the symbol ourselves. */
3060 new_symbol
= apply_modifiers_uncached (modifiers
,
3061 XSYMBOL (base
)->name
->data
,
3062 XSYMBOL (base
)->name
->size
);
3064 /* Add the new symbol to the base's cache. */
3065 entry
= Fcons (index
, new_symbol
);
3066 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
3068 /* We have the parsing info now for free, so add it to the caches. */
3069 XFASTINT (index
) = modifiers
;
3070 Fput (new_symbol
, Qevent_symbol_element_mask
,
3071 Fcons (base
, Fcons (index
, Qnil
)));
3072 Fput (new_symbol
, Qevent_symbol_elements
,
3073 Fcons (base
, lispy_modifier_list (modifiers
)));
3076 /* Make sure this symbol is of the same kind as BASE.
3078 You'd think we could just set this once and for all when we
3079 intern the symbol above, but reorder_modifiers may call us when
3080 BASE's property isn't set right; we can't assume that just
3081 because it has a Qmodifier_cache property it must have its
3082 Qevent_kind set right as well. */
3083 if (NILP (Fget (new_symbol
, Qevent_kind
)))
3085 Lisp_Object kind
= Fget (base
, Qevent_kind
);
3088 Fput (new_symbol
, Qevent_kind
, kind
);
3095 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
3096 return a symbol with the modifiers placed in the canonical order.
3097 Canonical order is alphabetical, except for down and drag, which
3098 always come last. The 'click' modifier is never written out.
3100 Fdefine_key calls this to make sure that (for example) C-M-foo
3101 and M-C-foo end up being equivalent in the keymap. */
3104 reorder_modifiers (symbol
)
3107 /* It's hopefully okay to write the code this way, since everything
3108 will soon be in caches, and no consing will be done at all. */
3109 Lisp_Object parsed
= parse_modifiers (symbol
);
3111 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
3112 XCONS (parsed
)->car
);
3116 /* For handling events, we often want to produce a symbol whose name
3117 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
3118 to some base, like the name of a function key or mouse button.
3119 modify_event_symbol produces symbols of this sort.
3121 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
3122 is the name of the i'th symbol. TABLE_SIZE is the number of elements
3125 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
3126 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
3128 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
3129 persist between calls to modify_event_symbol that it can use to
3130 store a cache of the symbols it's generated for this NAME_TABLE
3131 before. The object stored there may be a vector or an alist.
3133 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
3135 MODIFIERS is a set of modifier bits (as given in struct input_events)
3136 whose prefixes should be applied to the symbol name.
3138 SYMBOL_KIND is the value to be placed in the event_kind property of
3139 the returned symbol.
3141 The symbols we create are supposed to have an
3142 `event-symbol-elements' property, which lists the modifiers present
3143 in the symbol's name. */
3146 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
3147 name_table
, symbol_table
, table_size
)
3150 Lisp_Object symbol_kind
;
3151 Lisp_Object name_alist
;
3153 Lisp_Object
*symbol_table
;
3157 Lisp_Object symbol_int
;
3159 XSET (symbol_int
, Lisp_Int
, symbol_num
);
3161 /* Is this a request for a valid symbol? */
3162 if (symbol_num
< 0 || symbol_num
>= table_size
)
3165 if (CONSP (*symbol_table
))
3166 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
3168 /* If *symbol_table doesn't seem to be initialized properly, fix that.
3169 *symbol_table should be a lisp vector TABLE_SIZE elements long,
3170 where the Nth element is the symbol for NAME_TABLE[N], or nil if
3171 we've never used that symbol before. */
3174 if (! VECTORP (*symbol_table
)
3175 || XVECTOR (*symbol_table
)->size
!= table_size
)
3179 XFASTINT (size
) = table_size
;
3180 *symbol_table
= Fmake_vector (size
, Qnil
);
3183 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
3186 /* Have we already used this symbol before? */
3189 /* No; let's create it. */
3190 if (!NILP (name_alist
))
3191 value
= Fassq (symbol_int
, name_alist
);
3192 else if (name_table
[symbol_num
])
3193 value
= intern (name_table
[symbol_num
]);
3197 sprintf (buf
, "key-%d", symbol_num
);
3198 value
= intern (buf
);
3201 if (CONSP (*symbol_table
))
3202 *symbol_table
= Fcons (value
, *symbol_table
);
3204 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
3206 /* Fill in the cache entries for this symbol; this also
3207 builds the Qevent_symbol_elements property, which the user
3209 apply_modifiers (modifiers
& click_modifier
, value
);
3210 Fput (value
, Qevent_kind
, symbol_kind
);
3213 /* Apply modifiers to that symbol. */
3214 return apply_modifiers (modifiers
, value
);
3218 /* Store into *addr a value nonzero if terminal input chars are available.
3219 Serves the purpose of ioctl (0, FIONREAD, addr)
3220 but works even if FIONREAD does not exist.
3221 (In fact, this may actually read some input.) */
3224 get_input_pending (addr
)
3227 /* First of all, have we already counted some input? */
3228 *addr
= !NILP (Vquit_flag
) || readable_events ();
3230 /* If input is being read as it arrives, and we have none, there is none. */
3231 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
3234 /* Try to read some input and see how much we get. */
3236 *addr
= !NILP (Vquit_flag
) || readable_events ();
3239 /* Interface to read_avail_input, blocking SIGIO if necessary. */
3242 gobble_input (expected
)
3247 if (interrupt_input
)
3250 mask
= sigblockx (SIGIO
);
3251 read_avail_input (expected
);
3256 read_avail_input (expected
);
3262 /* Read any terminal input already buffered up by the system
3263 into the kbd_buffer, but do not wait.
3265 EXPECTED should be nonzero if the caller knows there is some input.
3267 Except on VMS, all input is read by this function.
3268 If interrupt_input is nonzero, this function MUST be called
3269 only when SIGIO is blocked.
3271 Returns the number of keyboard chars read, or -1 meaning
3272 this is a bad time to try to read input. */
3275 read_avail_input (expected
)
3278 struct input_event buf
[KBD_BUFFER_SIZE
];
3282 if (read_socket_hook
)
3283 /* No need for FIONREAD or fcntl; just say don't wait. */
3284 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
3287 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
3288 the kbd_buffer can really hold. That may prevent loss
3289 of characters on some systems when input is stuffed at us. */
3290 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
3293 nread
= dos_keysns ();
3294 if (nread
== 0) return 0;
3295 #else */ not MSDOS */
3297 /* Find out how much input is available. */
3298 if (ioctl (0, FIONREAD
, &nread
) < 0)
3299 /* Formerly simply reported no input, but that sometimes led to
3300 a failure of Emacs to terminate.
3301 SIGHUP seems appropriate if we can't reach the terminal. */
3302 /* ??? Is it really right to send the signal just to this process
3303 rather than to the whole process group?
3304 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3305 kill (getpid (), SIGHUP
);
3308 if (nread
> sizeof cbuf
)
3309 nread
= sizeof cbuf
;
3310 #else /* no FIONREAD */
3311 #if defined(USG) || defined(DGUX)
3312 /* Read some input if available, but don't wait. */
3313 nread
= sizeof cbuf
;
3314 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
3319 #endif /* not MSDOS */
3321 /* Now read; for one reason or another, this will not block. */
3325 cbuf
[0] = dos_keyread();
3328 nread
= read (fileno (stdin
), cbuf
, nread
);
3331 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3332 This looks incorrect, but it isn't, because _BSD causes
3333 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3334 and that causes a value other than 0 when there is no input. */
3338 /* This code is wrong, but at least it gets the right results.
3339 Fix it for 19.23. */
3340 /* Retry the read if it is interrupted. */
3343 || ! (errno
== EAGAIN
|| errno
== EFAULT
3345 || ! (errno
== EAGAIN
3355 #if defined (USG) || defined (DGUX)
3356 fcntl (fileno (stdin
), F_SETFL
, 0);
3357 #endif /* USG or DGUX */
3358 #endif /* no FIONREAD */
3359 for (i
= 0; i
< nread
; i
++)
3361 buf
[i
].kind
= ascii_keystroke
;
3362 buf
[i
].modifiers
= 0;
3363 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3364 buf
[i
].modifiers
= meta_modifier
;
3368 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
3370 XSET (buf
[i
].frame_or_window
, Lisp_Frame
, selected_frame
);
3372 buf
[i
].frame_or_window
= Qnil
;
3377 /* Scan the chars for C-g and store them in kbd_buffer. */
3378 for (i
= 0; i
< nread
; i
++)
3380 kbd_buffer_store_event (&buf
[i
]);
3381 /* Don't look at input that follows a C-g too closely.
3382 This reduces lossage due to autorepeat on C-g. */
3383 if (buf
[i
].kind
== ascii_keystroke
3384 && XINT(buf
[i
].code
) == quit_char
)
3390 #endif /* not VMS */
3392 #ifdef SIGIO /* for entire page */
3393 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3396 input_available_signal (signo
)
3399 /* Must preserve main program's value of errno. */
3400 int old_errno
= errno
;
3402 extern int select_alarmed
;
3406 /* USG systems forget handlers when they are used;
3407 must reestablish each time */
3408 signal (signo
, input_available_signal
);
3415 if (input_available_clear_time
)
3416 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3421 nread
= read_avail_input (1);
3422 /* -1 means it's not ok to read the input now.
3423 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3424 0 means there was no keyboard input available. */
3429 select_alarmed
= 1; /* Force the select emulator back to life */
3440 /* Send ourselves a SIGIO.
3442 This function exists so that the UNBLOCK_INPUT macro in
3443 blockinput.h can have some way to take care of input we put off
3444 dealing with, without assuming that every file which uses
3445 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3447 reinvoke_input_signal ()
3456 /* Return the prompt-string of a sparse keymap.
3457 This is the first element which is a string.
3458 Return nil if there is none. */
3466 register Lisp_Object tem
;
3468 if (XTYPE (tem
) == Lisp_String
)
3475 static Lisp_Object
menu_bar_item ();
3476 static Lisp_Object
menu_bar_one_keymap ();
3478 /* Return a list of menu items for a menu bar, appropriate
3479 to the current buffer.
3480 The elements have the form (KEY STRING . nil). */
3485 /* The number of keymaps we're scanning right now, and the number of
3486 keymaps we have allocated space for. */
3489 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3490 in the current keymaps, or nil where it is not a prefix. */
3493 Lisp_Object def
, tem
, tail
;
3500 /* In order to build the menus, we need to call the keymap
3501 accessors. They all call QUIT. But this function is called
3502 during redisplay, during which a quit is fatal. So inhibit
3503 quitting while building the menus.
3504 We do this instead of specbind because (1) errors will clear it anyway
3505 and (2) this avoids risk of specpdl overflow. */
3506 oquit
= Vinhibit_quit
;
3509 /* Build our list of keymaps.
3510 If we recognize a function key and replace its escape sequence in
3511 keybuf with its symbol, or if the sequence starts with a mouse
3512 click and we need to switch buffers, we jump back here to rebuild
3513 the initial keymaps from the current buffer. */
3517 if (!NILP (Voverriding_local_map
))
3520 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3521 maps
[0] = Voverriding_local_map
;
3525 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3526 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3527 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3528 #ifdef USE_TEXT_PROPERTIES
3529 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3531 maps
[nmaps
-2] = current_buffer
->keymap
;
3534 maps
[nmaps
-1] = current_global_map
;
3537 /* Look up in each map the dummy prefix key `menu-bar'. */
3541 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3543 if (! NILP (maps
[mapno
]))
3544 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3548 tem
= Fkeymapp (def
);
3550 result
= menu_bar_one_keymap (def
, result
);
3553 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3557 elt
= Fassq (XCONS (tail
)->car
, result
);
3559 result
= Fcons (elt
, Fdelq (elt
, result
));
3562 result
= Fnreverse (result
);
3563 Vinhibit_quit
= oquit
;
3567 /* Scan one map KEYMAP, accumulating any menu items it defines
3568 that have not yet been seen in RESULT. Return the updated RESULT. */
3571 menu_bar_one_keymap (keymap
, result
)
3572 Lisp_Object keymap
, result
;
3574 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3576 /* Loop over all keymap entries that have menu strings. */
3577 for (tail
= keymap
; XTYPE (tail
) == Lisp_Cons
; tail
= XCONS (tail
)->cdr
)
3579 item
= XCONS (tail
)->car
;
3580 if (XTYPE (item
) == Lisp_Cons
)
3582 key
= XCONS (item
)->car
;
3583 binding
= XCONS (item
)->cdr
;
3584 if (XTYPE (binding
) == Lisp_Cons
)
3586 item_string
= XCONS (binding
)->car
;
3587 if (XTYPE (item_string
) == Lisp_String
)
3588 result
= menu_bar_item (key
, item_string
,
3589 Fcdr (binding
), result
);
3591 else if (EQ (binding
, Qundefined
))
3592 result
= menu_bar_item (key
, item_string
,
3595 else if (XTYPE (item
) == Lisp_Vector
)
3597 /* Loop over the char values represented in the vector. */
3598 int len
= XVECTOR (item
)->size
;
3600 for (c
= 0; c
< len
; c
++)
3602 Lisp_Object character
;
3603 XFASTINT (character
) = c
;
3604 binding
= XVECTOR (item
)->contents
[c
];
3605 if (XTYPE (binding
) == Lisp_Cons
)
3607 item_string
= XCONS (binding
)->car
;
3608 if (XTYPE (item_string
) == Lisp_String
)
3609 result
= menu_bar_item (key
, item_string
,
3610 Fcdr (binding
), result
);
3612 else if (EQ (binding
, Qundefined
))
3613 result
= menu_bar_item (key
, item_string
,
3622 /* This is used as the handler when calling internal_condition_case_1. */
3625 menu_bar_item_1 (arg
)
3632 menu_bar_item (key
, item_string
, def
, result
)
3633 Lisp_Object key
, item_string
, def
, result
;
3636 Lisp_Object enabled
;
3638 if (EQ (def
, Qundefined
))
3640 /* If a map has an explicit nil as definition,
3641 discard any previously made menu bar item. */
3642 tem
= Fassq (key
, result
);
3643 return Fdelq (tem
, result
);
3646 /* See if this entry is enabled. */
3649 if (XTYPE (def
) == Lisp_Symbol
)
3651 /* No property, or nil, means enable.
3652 Otherwise, enable if value is not nil. */
3653 tem
= Fget (def
, Qmenu_enable
);
3655 /* (condition-case nil (eval tem)
3657 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
3661 /* Add an entry for this key and string
3662 if there is none yet. */
3663 tem
= Fassq (key
, result
);
3664 if (!NILP (enabled
) && NILP (tem
))
3665 result
= Fcons (Fcons (key
, Fcons (item_string
, Qnil
)), result
);
3670 /* Read a character using menus based on maps in the array MAPS.
3671 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
3672 Return t if we displayed a menu but the user rejected it.
3674 PREV_EVENT is the previous input event, or nil if we are reading
3675 the first event of a key sequence.
3677 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3678 if we used a mouse menu to read the input, or zero otherwise. If
3679 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
3681 The prompting is done based on the prompt-string of the map
3682 and the strings associated with various map elements.
3684 This can be done with X menus or with menus put in the minibuf.
3685 These are done in different ways, depending on how the input will be read.
3686 Menus using X are done after auto-saving in read-char, getting the input
3687 event from Fx_popup_menu; menus using the minibuf use read_char recursively
3688 and do auto-saving in the inner call of read_char. */
3691 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
3694 Lisp_Object prev_event
;
3695 int *used_mouse_menu
;
3698 register Lisp_Object name
;
3699 Lisp_Object rest
, vector
;
3701 if (used_mouse_menu
)
3702 *used_mouse_menu
= 0;
3704 /* Use local over global Menu maps */
3706 if (! menu_prompting
)
3709 /* Get the menu name from the first map that has one (a prompt string). */
3710 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3712 name
= map_prompt (maps
[mapno
]);
3717 /* If we don't have any menus, just read a character normally. */
3721 #ifdef HAVE_X_WINDOWS
3723 /* If we got to this point via a mouse click,
3724 use a real menu for mouse selection. */
3725 if (EVENT_HAS_PARAMETERS (prev_event
))
3727 /* Display the menu and get the selection. */
3728 Lisp_Object
*realmaps
3729 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
3733 /* Use the maps that are not nil. */
3734 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3735 if (!NILP (maps
[mapno
]))
3736 realmaps
[nmaps1
++] = maps
[mapno
];
3738 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
3741 /* If we got more than one event, put all but the first
3742 onto this list to be read later.
3743 Return just the first event now. */
3744 unread_command_events
3745 = nconc2 (XCONS (value
)->cdr
, unread_command_events
);
3746 value
= XCONS (value
)->car
;
3750 if (used_mouse_menu
)
3751 *used_mouse_menu
= 1;
3754 #endif /* HAVE_X_MENU */
3755 #endif /* HAVE_X_WINDOWS */
3760 read_char_minibuf_menu_prompt(commandflag
, nmaps
, maps
)
3766 register Lisp_Object name
;
3768 int width
= FRAME_WIDTH (selected_frame
) - 4;
3769 char *menu
= (char *) alloca (width
+ 4);
3772 Lisp_Object rest
, vector
;
3774 if (! menu_prompting
)
3777 /* Get the menu name from the first map that has one (a prompt string). */
3778 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3780 name
= map_prompt (maps
[mapno
]);
3785 /* If we don't have any menus, just read a character normally. */
3789 /* Prompt string always starts with map's prompt, and a space. */
3790 strcpy (menu
, XSTRING (name
)->data
);
3791 nlength
= XSTRING (name
)->size
;
3792 menu
[nlength
++] = ':';
3793 menu
[nlength
++] = ' ';
3796 /* Start prompting at start of first map. */
3800 /* Present the documented bindings, a line at a time. */
3807 int orig_defn_macro
;
3809 /* Loop over elements of map. */
3814 /* If reached end of map, start at beginning of next map. */
3818 /* At end of last map, wrap around to first map if just starting,
3819 or end this line if already have something on it. */
3823 if (notfirst
|| nobindings
) break;
3828 /* Look at the next element of the map. */
3830 elt
= XVECTOR (vector
)->contents
[idx
];
3832 elt
= Fcar_safe (rest
);
3834 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
3836 /* If we found a dense table in the keymap,
3837 advanced past it, but start scanning its contents. */
3838 rest
= Fcdr_safe (rest
);
3844 /* An ordinary element. */
3846 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
3848 s
= Fcar_safe(elt
); /* vector */
3849 if (XTYPE (s
) != Lisp_String
)
3850 /* Ignore the element if it has no prompt string. */
3852 /* If we have room for the prompt string, add it to this line.
3853 If this is the first on the line, always add it. */
3854 else if (XSTRING (s
)->size
+ i
+ 2 < width
3859 /* Punctuate between strings. */
3862 strcpy (menu
+ i
, ", ");
3868 /* Add as much of string as fits. */
3869 thiswidth
= XSTRING (s
)->size
;
3870 if (thiswidth
+ i
> width
)
3871 thiswidth
= width
- i
;
3872 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
3878 /* If this element does not fit, end the line now,
3879 and save the element for the next line. */
3880 strcpy (menu
+ i
, "...");
3884 /* Move past this element. */
3885 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
3886 /* Handle reaching end of dense table. */
3891 rest
= Fcdr_safe (rest
);
3895 /* Prompt with that and read response. */
3898 /* Make believe its not a keyboard macro in case the help char
3899 is pressed. Help characters are not recorded because menu prompting
3900 is not used on replay.
3902 orig_defn_macro
= defining_kbd_macro
;
3903 defining_kbd_macro
= 0 ;
3905 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
3906 while (XTYPE (obj
) == Lisp_Buffer
);
3907 defining_kbd_macro
= orig_defn_macro
;
3909 if (XTYPE (obj
) != Lisp_Int
)
3914 if (! EQ (obj
, menu_prompt_more_char
)
3915 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
3916 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
3918 if ( defining_kbd_macro
)
3919 store_kbd_macro_char(obj
) ;
3922 /* Help char - go round again */
3926 /* Reading key sequences. */
3928 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
3929 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
3930 keymap, or nil otherwise. Return the index of the first keymap in
3931 which KEY has any binding, or NMAPS if no map has a binding.
3933 If KEY is a meta ASCII character, treat it like meta-prefix-char
3934 followed by the corresponding non-meta character. Keymaps in
3935 CURRENT with non-prefix bindings for meta-prefix-char become nil in
3938 When KEY is not defined in any of the keymaps, if it is an upper
3939 case letter and there are bindings for the corresponding lower-case
3940 letter, return the bindings for the lower-case letter.
3941 We store 1 in *CASE_CONVERTED in this case.
3942 Otherwise, we don't change *CASE_CONVERTED.
3944 If KEY has no bindings in any of the CURRENT maps, NEXT is left
3947 NEXT may == CURRENT. */
3950 follow_key (key
, nmaps
, current
, defs
, next
, case_converted
)
3952 Lisp_Object
*current
, *defs
, *next
;
3954 int *case_converted
;
3956 int i
, first_binding
;
3958 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
3959 followed by the corresponding non-meta character. */
3960 if (XTYPE (key
) == Lisp_Int
&& (XINT (key
) & CHAR_META
))
3962 for (i
= 0; i
< nmaps
; i
++)
3963 if (! NILP (current
[i
]))
3966 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
3968 /* Note that since we pass the resulting bindings through
3969 get_keymap_1, non-prefix bindings for meta-prefix-char
3971 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
3977 XSET (key
, Lisp_Int
, XFASTINT (key
) & ~CHAR_META
);
3980 first_binding
= nmaps
;
3981 for (i
= nmaps
- 1; i
>= 0; i
--)
3983 if (! NILP (current
[i
]))
3985 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3986 if (! NILP (defs
[i
]))
3993 /* When KEY is not defined in any of the keymaps, if it is an upper
3994 case letter and there are bindings for the corresponding
3995 lower-case letter, return the bindings for the lower-case letter. */
3996 if (first_binding
== nmaps
3997 && XTYPE (key
) == Lisp_Int
3998 && ((((XINT (key
) & 0x3ffff)
3999 < XSTRING (current_buffer
->downcase_table
)->size
)
4000 && UPPERCASEP (XINT (key
) & 0x3ffff))
4001 || (XINT (key
) & shift_modifier
)))
4003 if (XINT (key
) & shift_modifier
)
4004 XSETINT (key
, XINT (key
) & ~shift_modifier
);
4006 XSETINT (key
, (DOWNCASE (XINT (key
) & 0x3ffff)
4007 | (XINT (key
) & ~0x3ffff)));
4009 first_binding
= nmaps
;
4010 for (i
= nmaps
- 1; i
>= 0; i
--)
4012 if (! NILP (current
[i
]))
4014 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
4015 if (! NILP (defs
[i
]))
4021 if (first_binding
!= nmaps
)
4022 *case_converted
= 1;
4025 /* Given the set of bindings we've found, produce the next set of maps. */
4026 if (first_binding
< nmaps
)
4027 for (i
= 0; i
< nmaps
; i
++)
4028 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
4030 return first_binding
;
4033 /* Read a sequence of keys that ends with a non prefix character,
4034 storing it in KEYBUF, a buffer of size BUFSIZE.
4036 Return the length of the key sequence stored.
4037 Return -1 if the user rejected a command menu.
4039 Echo starting immediately unless `prompt' is 0.
4041 Where a key sequence ends depends on the currently active keymaps.
4042 These include any minor mode keymaps active in the current buffer,
4043 the current buffer's local map, and the global map.
4045 If a key sequence has no other bindings, we check Vfunction_key_map
4046 to see if some trailing subsequence might be the beginning of a
4047 function key's sequence. If so, we try to read the whole function
4048 key, and substitute its symbolic name into the key sequence.
4050 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
4051 `double-' events into similar click events, if that would make them
4052 bound. We try to turn `triple-' events first into `double-' events,
4055 If we get a mouse click in a mode line, vertical divider, or other
4056 non-text area, we treat the click as if it were prefixed by the
4057 symbol denoting that area - `mode-line', `vertical-line', or
4060 If the sequence starts with a mouse click, we read the key sequence
4061 with respect to the buffer clicked on, not the current buffer.
4063 If the user switches frames in the midst of a key sequence, we put
4064 off the switch-frame event until later; the next call to
4065 read_char will return it. */
4068 read_key_sequence (keybuf
, bufsize
, prompt
)
4069 Lisp_Object
*keybuf
;
4073 int count
= specpdl_ptr
- specpdl
;
4075 /* How many keys there are in the current key sequence. */
4078 /* The length of the echo buffer when we started reading, and
4079 the length of this_command_keys when we started reading. */
4083 /* The number of keymaps we're scanning right now, and the number of
4084 keymaps we have allocated space for. */
4086 int nmaps_allocated
= 0;
4088 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
4089 the current keymaps. */
4092 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
4093 in the current keymaps, or nil where it is not a prefix. */
4094 Lisp_Object
*submaps
;
4096 /* The index in defs[] of the first keymap that has a binding for
4097 this key sequence. In other words, the lowest i such that
4098 defs[i] is non-nil. */
4101 /* If t < mock_input, then KEYBUF[t] should be read as the next
4104 We use this to recover after recognizing a function key. Once we
4105 realize that a suffix of the current key sequence is actually a
4106 function key's escape sequence, we replace the suffix with the
4107 function key's binding from Vfunction_key_map. Now keybuf
4108 contains a new and different key sequence, so the echo area,
4109 this_command_keys, and the submaps and defs arrays are wrong. In
4110 this situation, we set mock_input to t, set t to 0, and jump to
4111 restart_sequence; the loop will read keys from keybuf up until
4112 mock_input, thus rebuilding the state; and then it will resume
4113 reading characters from the keyboard. */
4116 /* If the sequence is unbound in submaps[], then
4117 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
4118 and fkey_map is its binding.
4120 These might be > t, indicating that all function key scanning
4121 should hold off until t reaches them. We do this when we've just
4122 recognized a function key, to avoid searching for the function
4123 key's again in Vfunction_key_map. */
4124 int fkey_start
= 0, fkey_end
= 0;
4125 Lisp_Object fkey_map
;
4127 /* Likewise, for key_translation_map. */
4128 int keytran_start
= 0, keytran_end
= 0;
4129 Lisp_Object keytran_map
;
4131 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
4132 we put it off for later. While we're reading, we keep the event here. */
4133 Lisp_Object delayed_switch_frame
;
4135 /* See the comment below... */
4136 #if defined (GOBBLE_FIRST_EVENT)
4137 Lisp_Object first_event
;
4140 struct buffer
*starting_buffer
;
4142 /* Nonzero if we found the binding for one of the chars
4143 in this key sequence by downcasing it. */
4144 int case_converted
= 0;
4146 /* Nonzero if we seem to have got the beginning of a binding
4147 in function_key_map. */
4148 int function_key_possible
= 0;
4152 last_nonmenu_event
= Qnil
;
4154 delayed_switch_frame
= Qnil
;
4155 fkey_map
= Vfunction_key_map
;
4156 keytran_map
= Vkey_translation_map
;
4158 /* If there is no function-key-map, turn off function key scanning. */
4159 if (NILP (Fkeymapp (Vfunction_key_map
)))
4160 fkey_start
= fkey_end
= bufsize
+ 1;
4162 /* If there is no key-translation-map, turn off scanning. */
4163 if (NILP (Fkeymapp (Vkey_translation_map
)))
4164 keytran_start
= keytran_end
= bufsize
+ 1;
4169 echo_prompt (XSTRING (prompt
)->data
);
4170 else if (cursor_in_echo_area
)
4171 /* This doesn't put in a dash if the echo buffer is empty, so
4172 you don't always see a dash hanging out in the minibuffer. */
4176 /* Record the initial state of the echo area and this_command_keys;
4177 we will need to restore them if we replay a key sequence. */
4179 echo_start
= echo_length ();
4180 keys_start
= this_command_key_count
;
4182 #if defined (GOBBLE_FIRST_EVENT)
4183 /* This doesn't quite work, because some of the things that read_char
4184 does cannot safely be bypassed. It seems too risky to try to make
4187 /* Read the first char of the sequence specially, before setting
4188 up any keymaps, in case a filter runs and switches buffers on us. */
4189 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
4191 #endif /* GOBBLE_FIRST_EVENT */
4193 /* We jump here when the key sequence has been thoroughly changed, and
4194 we need to rescan it starting from the beginning. When we jump here,
4195 keybuf[0..mock_input] holds the sequence we should reread. */
4198 starting_buffer
= current_buffer
;
4200 function_key_possible
= 0;
4202 /* Build our list of keymaps.
4203 If we recognize a function key and replace its escape sequence in
4204 keybuf with its symbol, or if the sequence starts with a mouse
4205 click and we need to switch buffers, we jump back here to rebuild
4206 the initial keymaps from the current buffer. */
4210 if (!NILP (Voverriding_local_map
))
4213 if (nmaps
> nmaps_allocated
)
4215 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4216 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4217 nmaps_allocated
= nmaps
;
4219 submaps
[0] = Voverriding_local_map
;
4223 nmaps
= current_minor_maps (0, &maps
) + 2;
4224 if (nmaps
> nmaps_allocated
)
4226 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4227 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4228 nmaps_allocated
= nmaps
;
4230 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
4231 #ifdef USE_TEXT_PROPERTIES
4232 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
4234 submaps
[nmaps
-2] = current_buffer
->keymap
;
4237 submaps
[nmaps
-1] = current_global_map
;
4240 /* Find an accurate initial value for first_binding. */
4241 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
4242 if (! NILP (submaps
[first_binding
]))
4245 /* Start from the beginning in keybuf. */
4248 /* These are no-ops the first time through, but if we restart, they
4249 revert the echo area and this_command_keys to their original state. */
4250 this_command_key_count
= keys_start
;
4251 if (INTERACTIVE
&& t
< mock_input
)
4252 echo_truncate (echo_start
);
4254 /* If the best binding for the current key sequence is a keymap, or
4255 we may be looking at a function key's escape sequence, keep on
4257 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
4258 || (first_binding
>= nmaps
4260 /* mock input is never part of a function key's sequence. */
4261 && mock_input
<= fkey_start
)
4262 || (first_binding
>= nmaps
4263 && keytran_start
< t
4264 /* mock input is never part of a function key's sequence. */
4265 && mock_input
<= keytran_start
)
4266 /* Don't return in the middle of a possible function key sequence,
4267 if the only bindings we found were via case conversion.
4268 Thus, if ESC O a has a function-key-map translation
4269 and ESC o has a binding, don't return after ESC O,
4270 so that we can translate ESC O plus the next character. */
4271 || (function_key_possible
&& case_converted
))
4274 int used_mouse_menu
= 0;
4276 /* Where the last real key started. If we need to throw away a
4277 key that has expanded into more than one element of keybuf
4278 (say, a mouse click on the mode line which is being treated
4279 as [mode-line (mouse-...)], then we backtrack to this point
4281 int last_real_key_start
;
4283 /* These variables are analogous to echo_start and keys_start;
4284 while those allow us to restart the entire key sequence,
4285 echo_local_start and keys_local_start allow us to throw away
4287 int echo_local_start
, keys_local_start
, local_first_binding
;
4290 error ("key sequence too long");
4293 echo_local_start
= echo_length ();
4294 keys_local_start
= this_command_key_count
;
4295 local_first_binding
= first_binding
;
4298 /* These are no-ops, unless we throw away a keystroke below and
4299 jumped back up to replay_key; in that case, these restore the
4300 variables to their original state, allowing us to replay the
4302 if (INTERACTIVE
&& t
< mock_input
)
4303 echo_truncate (echo_local_start
);
4304 this_command_key_count
= keys_local_start
;
4305 first_binding
= local_first_binding
;
4307 /* By default, assume each event is "real". */
4308 last_real_key_start
= t
;
4310 /* Does mock_input indicate that we are re-reading a key sequence? */
4314 add_command_key (key
);
4318 /* If not, we should actually read a character. */
4321 struct buffer
*buf
= current_buffer
;
4323 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
4326 /* read_char returns t when it shows a menu and the user rejects it.
4331 /* read_char returns -1 at the end of a macro.
4332 Emacs 18 handles this by returning immediately with a
4333 zero, so that's what we'll do. */
4334 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) == -1)
4340 /* If the current buffer has been changed from under us, the
4341 keymap may have changed, so replay the sequence. */
4342 if (XTYPE (key
) == Lisp_Buffer
)
4345 goto replay_sequence
;
4348 /* If we have a quit that was typed in another frame, and
4349 quit_throw_to_read_char switched buffers,
4350 replay to get the right keymap. */
4351 if (EQ (key
, quit_char
) && current_buffer
!= starting_buffer
)
4356 goto replay_sequence
;
4362 /* Clicks in non-text areas get prefixed by the symbol
4363 in their CHAR-ADDRESS field. For example, a click on
4364 the mode line is prefixed by the symbol `mode-line'.
4366 Furthermore, key sequences beginning with mouse clicks
4367 are read using the keymaps of the buffer clicked on, not
4368 the current buffer. So we may have to switch the buffer
4371 When we turn one event into two events, we must make sure
4372 that neither of the two looks like the original--so that,
4373 if we replay the events, they won't be expanded again.
4374 If not for this, such reexpansion could happen either here
4375 or when user programs play with this-command-keys. */
4376 if (EVENT_HAS_PARAMETERS (key
))
4378 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
4380 if (EQ (kind
, Qmouse_click
))
4382 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
4383 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4385 if (XTYPE (posn
) == Lisp_Cons
)
4387 /* We're looking at the second event of a
4388 sequence which we expanded before. Set
4389 last_real_key_start appropriately. */
4391 last_real_key_start
= t
- 1;
4394 /* Key sequences beginning with mouse clicks are
4395 read using the keymaps in the buffer clicked on,
4396 not the current buffer. If we're at the
4397 beginning of a key sequence, switch buffers. */
4398 if (last_real_key_start
== 0
4399 && XTYPE (window
) == Lisp_Window
4400 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
4401 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
4406 /* Arrange to go back to the original buffer once we're
4407 done reading the key sequence. Note that we can't
4408 use save_excursion_{save,restore} here, because they
4409 save point as well as the current buffer; we don't
4410 want to save point, because redisplay may change it,
4411 to accommodate a Fset_window_start or something. We
4412 don't want to do this at the top of the function,
4413 because we may get input from a subprocess which
4414 wants to change the selected window and stuff (say,
4416 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
4418 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
4419 goto replay_sequence
;
4421 else if (XTYPE (posn
) == Lisp_Symbol
)
4423 /* Expand mode-line and scroll-bar events into two events:
4424 use posn as a fake prefix key. */
4426 if (t
+ 1 >= bufsize
)
4427 error ("key sequence too long");
4432 /* Zap the position in key, so we know that we've
4433 expanded it, and don't try to do so again. */
4434 POSN_BUFFER_POSN (EVENT_START (key
))
4435 = Fcons (posn
, Qnil
);
4439 else if (EQ (kind
, Qswitch_frame
))
4441 /* If we're at the beginning of a key sequence, go
4442 ahead and return this event. If we're in the
4443 midst of a key sequence, delay it until the end. */
4446 delayed_switch_frame
= key
;
4452 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4454 /* Handle menu-bar events:
4455 insert the dummy prefix event `menu-bar'. */
4456 if (EQ (posn
, Qmenu_bar
))
4458 if (t
+ 1 >= bufsize
)
4459 error ("key sequence too long");
4460 /* Run the Lucid hook. */
4461 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4462 /* If it has changed current-menubar from previous value,
4463 really recompute the menubar from the value. */
4464 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4465 call0 (Qrecompute_lucid_menubar
);
4469 /* Zap the position in key, so we know that we've
4470 expanded it, and don't try to do so again. */
4471 POSN_BUFFER_POSN (EVENT_START (key
))
4472 = Fcons (posn
, Qnil
);
4475 goto replay_sequence
;
4477 else if (XTYPE (posn
) == Lisp_Cons
)
4479 /* We're looking at the second event of a
4480 sequence which we expanded before. Set
4481 last_real_key_start appropriately. */
4482 if (last_real_key_start
== t
&& t
> 0)
4483 last_real_key_start
= t
- 1;
4488 /* We have finally decided that KEY is something we might want
4490 first_binding
= (follow_key (key
,
4491 nmaps
- first_binding
,
4492 submaps
+ first_binding
,
4493 defs
+ first_binding
,
4494 submaps
+ first_binding
,
4498 /* If KEY wasn't bound, we'll try some fallbacks. */
4499 if (first_binding
>= nmaps
)
4501 Lisp_Object head
= EVENT_HEAD (key
);
4503 if (EQ (head
, Vhelp_char
))
4505 read_key_sequence_cmd
= Vprefix_help_command
;
4507 last_nonmenu_event
= key
;
4511 if (XTYPE (head
) == Lisp_Symbol
)
4513 Lisp_Object breakdown
= parse_modifiers (head
);
4514 int modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4516 /* Attempt to reduce an unbound mouse event to a simpler
4517 event that is bound:
4518 Drags reduce to clicks.
4519 Double-clicks reduce to clicks.
4520 Triple-clicks reduce to double-clicks, then to clicks.
4521 Down-clicks are eliminated.
4522 Double-downs reduce to downs, then are eliminated.
4523 Triple-downs reduce to double-downs, then to downs,
4524 then are eliminated. */
4525 if (modifiers
& (down_modifier
| drag_modifier
4526 | double_modifier
| triple_modifier
))
4528 while (modifiers
& (down_modifier
| drag_modifier
4529 | double_modifier
| triple_modifier
))
4531 Lisp_Object new_head
, new_click
;
4532 if (modifiers
& triple_modifier
)
4533 modifiers
^= (double_modifier
| triple_modifier
);
4534 else if (modifiers
& (drag_modifier
| double_modifier
))
4535 modifiers
&= ~(drag_modifier
| double_modifier
);
4538 /* Dispose of this `down' event by simply jumping
4539 back to replay_key, to get another event.
4541 Note that if this event came from mock input,
4542 then just jumping back to replay_key will just
4543 hand it to us again. So we have to wipe out any
4546 We could delete keybuf[t] and shift everything
4547 after that to the left by one spot, but we'd also
4548 have to fix up any variable that points into
4549 keybuf, and shifting isn't really necessary
4552 Adding prefixes for non-textual mouse clicks
4553 creates two characters of mock input, and both
4554 must be thrown away. If we're only looking at
4555 the prefix now, we can just jump back to
4556 replay_key. On the other hand, if we've already
4557 processed the prefix, and now the actual click
4558 itself is giving us trouble, then we've lost the
4559 state of the keymaps we want to backtrack to, and
4560 we need to replay the whole sequence to rebuild
4563 Beyond that, only function key expansion could
4564 create more than two keys, but that should never
4565 generate mouse events, so it's okay to zero
4566 mock_input in that case too.
4568 Isn't this just the most wonderful code ever? */
4569 if (t
== last_real_key_start
)
4576 mock_input
= last_real_key_start
;
4577 goto replay_sequence
;
4582 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
4584 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
4586 /* Look for a binding for this new key. follow_key
4587 promises that it didn't munge submaps the
4588 last time we called it, since key was unbound. */
4590 = (follow_key (new_click
,
4591 nmaps
- local_first_binding
,
4592 submaps
+ local_first_binding
,
4593 defs
+ local_first_binding
,
4594 submaps
+ local_first_binding
,
4596 + local_first_binding
);
4598 /* If that click is bound, go for it. */
4599 if (first_binding
< nmaps
)
4604 /* Otherwise, we'll leave key set to the drag event. */
4611 /* Normally, last_nonmenu_event gets the previous key we read.
4612 But when a mouse popup menu is being used,
4613 we don't update last_nonmenu_event; it continues to hold the mouse
4614 event that preceded the first level of menu. */
4615 if (!used_mouse_menu
)
4616 last_nonmenu_event
= key
;
4618 /* If the sequence is unbound, see if we can hang a function key
4619 off the end of it. We only want to scan real keyboard input
4620 for function key sequences, so if mock_input says that we're
4621 re-reading old events, don't examine it. */
4622 if ((first_binding
>= nmaps
|| case_converted
)
4625 Lisp_Object fkey_next
;
4627 /* Continue scan from fkey_end until we find a bound suffix.
4628 If we fail, increment fkey_start
4629 and start fkey_end from there. */
4630 while (fkey_end
< t
)
4634 key
= keybuf
[fkey_end
++];
4635 /* Look up meta-characters by prefixing them
4636 with meta_prefix_char. I hate this. */
4637 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4642 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
4644 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4647 fkey_next
= fkey_map
;
4650 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
4652 /* If the function key map gives a function, not an
4653 array, then call the function with no args and use
4654 its value instead. */
4655 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
4658 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4662 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4663 fkey_next
= call1 (fkey_next
, prompt
);
4665 /* If the function returned something invalid,
4666 barf--don't ignore it.
4667 (To ignore it safely, we would need to gcpro a bunch of
4668 other variables.) */
4669 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
4670 error ("Function in function-key-map returns invalid key sequence");
4673 function_key_possible
= ! NILP (fkey_next
);
4675 /* If keybuf[fkey_start..fkey_end] is bound in the
4676 function key map and it's a suffix of the current
4677 sequence (i.e. fkey_end == t), replace it with
4678 the binding and restart with fkey_start at the end. */
4679 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
4682 int len
= XFASTINT (Flength (fkey_next
));
4684 t
= fkey_start
+ len
;
4686 error ("key sequence too long");
4688 if (VECTORP (fkey_next
))
4689 bcopy (XVECTOR (fkey_next
)->contents
,
4690 keybuf
+ fkey_start
,
4691 (t
- fkey_start
) * sizeof (keybuf
[0]));
4692 else if (STRINGP (fkey_next
))
4696 for (i
= 0; i
< len
; i
++)
4697 XFASTINT (keybuf
[fkey_start
+ i
])
4698 = XSTRING (fkey_next
)->data
[i
];
4702 fkey_start
= fkey_end
= t
;
4703 fkey_map
= Vfunction_key_map
;
4705 goto replay_sequence
;
4708 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
4710 /* If we no longer have a bound suffix, try a new positions for
4712 if (NILP (fkey_map
))
4714 fkey_end
= ++fkey_start
;
4715 fkey_map
= Vfunction_key_map
;
4716 function_key_possible
= 0;
4721 /* Look for this sequence in key-translation-map. */
4723 Lisp_Object keytran_next
;
4725 /* Scan from keytran_end until we find a bound suffix. */
4726 while (keytran_end
< t
)
4730 key
= keybuf
[keytran_end
++];
4731 /* Look up meta-characters by prefixing them
4732 with meta_prefix_char. I hate this. */
4733 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4738 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
4740 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4743 keytran_next
= keytran_map
;
4746 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
4748 /* If the key translation map gives a function, not an
4749 array, then call the function with no args and use
4750 its value instead. */
4751 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
4752 && keytran_end
== t
)
4754 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4758 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4759 keytran_next
= call1 (keytran_next
, prompt
);
4761 /* If the function returned something invalid,
4762 barf--don't ignore it.
4763 (To ignore it safely, we would need to gcpro a bunch of
4764 other variables.) */
4765 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
4766 error ("Function in key-translation-map returns invalid key sequence");
4769 /* If keybuf[keytran_start..keytran_end] is bound in the
4770 key translation map and it's a suffix of the current
4771 sequence (i.e. keytran_end == t), replace it with
4772 the binding and restart with keytran_start at the end. */
4773 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
4774 && keytran_end
== t
)
4776 int len
= XFASTINT (Flength (keytran_next
));
4778 t
= keytran_start
+ len
;
4780 error ("key sequence too long");
4782 if (VECTORP (keytran_next
))
4783 bcopy (XVECTOR (keytran_next
)->contents
,
4784 keybuf
+ keytran_start
,
4785 (t
- keytran_start
) * sizeof (keybuf
[0]));
4786 else if (STRINGP (keytran_next
))
4790 for (i
= 0; i
< len
; i
++)
4791 XFASTINT (keybuf
[keytran_start
+ i
])
4792 = XSTRING (keytran_next
)->data
[i
];
4796 keytran_start
= keytran_end
= t
;
4797 keytran_map
= Vkey_translation_map
;
4799 goto replay_sequence
;
4802 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
4804 /* If we no longer have a bound suffix, try a new positions for
4806 if (NILP (keytran_map
))
4808 keytran_end
= ++keytran_start
;
4809 keytran_map
= Vkey_translation_map
;
4815 read_key_sequence_cmd
= (first_binding
< nmaps
4816 ? defs
[first_binding
]
4820 unread_switch_frame
= delayed_switch_frame
;
4821 unbind_to (count
, Qnil
);
4823 /* Occasionally we fabricate events, perhaps by expanding something
4824 according to function-key-map, or by adding a prefix symbol to a
4825 mouse click in the scroll bar or modeline. In this cases, return
4826 the entire generated key sequence, even if we hit an unbound
4827 prefix or a definition before the end. This means that you will
4828 be able to push back the event properly, and also means that
4829 read-key-sequence will always return a logical unit.
4832 for (; t
< mock_input
; t
++)
4834 echo_char (keybuf
[t
]);
4835 add_command_key (keybuf
[t
]);
4841 #if 0 /* This doc string is too long for some compilers.
4842 This commented-out definition serves for DOC. */
4843 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4844 "Read a sequence of keystrokes and return as a string or vector.\n\
4845 The sequence is sufficient to specify a non-prefix command in the\n\
4846 current local and global maps.\n\
4848 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
4849 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
4850 as a continuation of the previous key.\n\
4852 A C-g typed while in this function is treated like any other character,\n\
4853 and `quit-flag' is not set.\n\
4855 If the key sequence starts with a mouse click, then the sequence is read\n\
4856 using the keymaps of the buffer of the window clicked in, not the buffer\n\
4857 of the selected window as normal.\n\
4859 `read-key-sequence' drops unbound button-down events, since you normally\n\
4860 only care about the click or drag events which follow them. If a drag\n\
4861 or multi-click event is unbound, but the corresponding click event would\n\
4862 be bound, `read-key-sequence' turns the event into a click event at the\n\
4863 drag's starting position. This means that you don't have to distinguish\n\
4864 between click and drag, double, or triple events unless you want to.\n\
4866 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
4867 lines separating windows, and scroll bars with imaginary keys\n\
4868 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
4870 If the user switches frames in the middle of a key sequence, the\n\
4871 frame-switch event is put off until after the current key sequence.\n\
4873 `read-key-sequence' checks `function-key-map' for function key\n\
4874 sequences, where they wouldn't conflict with ordinary bindings. See\n\
4875 `function-key-map' for more details.")
4876 (prompt
, continue_echo
)
4879 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4881 (prompt
, continue_echo
)
4882 Lisp_Object prompt
, continue_echo
;
4884 Lisp_Object keybuf
[30];
4886 struct gcpro gcpro1
, gcpro2
;
4889 CHECK_STRING (prompt
, 0);
4892 bzero (keybuf
, sizeof keybuf
);
4894 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
4896 if (NILP (continue_echo
))
4897 this_command_key_count
= 0;
4899 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])), prompt
);
4907 return make_event_array (i
, keybuf
);
4910 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
4911 "Execute CMD as an editor command.\n\
4912 CMD must be a symbol that satisfies the `commandp' predicate.\n\
4913 Optional second arg RECORD-FLAG non-nil\n\
4914 means unconditionally put this command in `command-history'.\n\
4915 Otherwise, that is done only if an arg is read using the minibuffer.")
4917 Lisp_Object cmd
, record
;
4919 register Lisp_Object final
;
4920 register Lisp_Object tem
;
4921 Lisp_Object prefixarg
;
4922 struct backtrace backtrace
;
4923 extern int debug_on_next_call
;
4925 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
4926 Vcurrent_prefix_arg
= prefixarg
;
4927 debug_on_next_call
= 0;
4929 if (XTYPE (cmd
) == Lisp_Symbol
)
4931 tem
= Fget (cmd
, Qdisabled
);
4933 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
4938 final
= Findirect_function (cmd
);
4940 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
4941 do_autoload (final
, cmd
);
4946 if (XTYPE (final
) == Lisp_String
4947 || XTYPE (final
) == Lisp_Vector
)
4949 /* If requested, place the macro in the command history. For
4950 other sorts of commands, call-interactively takes care of
4954 = Fcons (Fcons (Qexecute_kbd_macro
,
4955 Fcons (final
, Fcons (prefixarg
, Qnil
))),
4958 return Fexecute_kbd_macro (final
, prefixarg
);
4960 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
4961 || XTYPE (final
) == Lisp_Compiled
)
4963 backtrace
.next
= backtrace_list
;
4964 backtrace_list
= &backtrace
;
4965 backtrace
.function
= &Qcall_interactively
;
4966 backtrace
.args
= &cmd
;
4967 backtrace
.nargs
= 1;
4968 backtrace
.evalargs
= 0;
4970 tem
= Fcall_interactively (cmd
, record
);
4972 backtrace_list
= backtrace
.next
;
4978 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
4980 "Read function name, then read its arguments and call it.")
4982 Lisp_Object prefixarg
;
4984 Lisp_Object function
;
4986 Lisp_Object saved_keys
;
4987 struct gcpro gcpro1
;
4989 saved_keys
= Fvector (this_command_key_count
,
4990 XVECTOR (this_command_keys
)->contents
);
4992 GCPRO1 (saved_keys
);
4994 if (EQ (prefixarg
, Qminus
))
4996 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
4997 strcpy (buf
, "C-u ");
4998 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
4999 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
5000 else if (XTYPE (prefixarg
) == Lisp_Int
)
5001 sprintf (buf
, "%d ", XINT (prefixarg
));
5003 /* This isn't strictly correct if execute-extended-command
5004 is bound to anything else. Perhaps it should use
5005 this_command_keys? */
5006 strcat (buf
, "M-x ");
5008 /* Prompt with buf, and then read a string, completing from and
5009 restricting to the set of all defined commands. Don't provide
5010 any initial input. Save the command read on the extended-command
5012 function
= Fcompleting_read (build_string (buf
),
5013 Vobarray
, Qcommandp
,
5014 Qt
, Qnil
, Qextended_command_history
);
5016 /* Set this_command_keys to the concatenation of saved_keys and
5017 function, followed by a RET. */
5019 struct Lisp_String
*str
;
5024 this_command_key_count
= 0;
5026 keys
= XVECTOR (saved_keys
)->contents
;
5027 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
5028 add_command_key (keys
[i
]);
5030 str
= XSTRING (function
);
5031 for (i
= 0; i
< str
->size
; i
++)
5033 XFASTINT (tem
) = str
->data
[i
];
5034 add_command_key (tem
);
5037 XFASTINT (tem
) = '\015';
5038 add_command_key (tem
);
5043 function
= Fintern (function
, Qnil
);
5044 Vprefix_arg
= prefixarg
;
5045 this_command
= function
;
5047 return Fcommand_execute (function
, Qt
);
5051 detect_input_pending ()
5054 get_input_pending (&input_pending
);
5056 return input_pending
;
5059 /* This is called in some cases before a possible quit.
5060 It cases the next call to detect_input_pending to recompute input_pending.
5061 So calling this function unnecessarily can't do any harm. */
5062 clear_input_pending ()
5067 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
5068 "T if command input is currently available with no waiting.\n\
5069 Actually, the value is nil only if we can be sure that no input is available.")
5072 if (!NILP (unread_command_events
) || unread_command_char
!= -1)
5075 return detect_input_pending () ? Qt
: Qnil
;
5078 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
5079 "Return vector of last 100 events, not counting those from keyboard macros.")
5082 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
5085 if (total_keys
< NUM_RECENT_KEYS
)
5086 return Fvector (total_keys
, keys
);
5089 val
= Fvector (NUM_RECENT_KEYS
, keys
);
5090 bcopy (keys
+ recent_keys_index
,
5091 XVECTOR (val
)->contents
,
5092 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
5094 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
5095 recent_keys_index
* sizeof (Lisp_Object
));
5100 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
5101 "Return the key sequence that invoked this command.\n\
5102 The value is a string or a vector.")
5105 return make_event_array (this_command_key_count
,
5106 XVECTOR (this_command_keys
)->contents
);
5109 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
5110 "Return the current depth in recursive edits.")
5114 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
5118 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
5119 "FOpen dribble file: ",
5120 "Start writing all keyboard characters to a dribble file called FILE.\n\
5121 If FILE is nil, close any open dribble file.")
5132 file
= Fexpand_file_name (file
, Qnil
);
5133 dribble
= fopen (XSTRING (file
)->data
, "w");
5138 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
5139 "Discard the contents of the terminal input buffer.\n\
5140 Also cancel any kbd macro being defined.")
5143 defining_kbd_macro
= 0;
5144 update_mode_lines
++;
5146 unread_command_events
= Qnil
;
5147 unread_command_char
= -1;
5149 discard_tty_input ();
5151 /* Without the cast, GCC complains that this assignment loses the
5152 volatile qualifier of kbd_store_ptr. Is there anything wrong
5154 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
5155 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5161 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
5162 "Stop Emacs and return to superior process. You can resume later.\n\
5163 On systems that don't have job control, run a subshell instead.\n\n\
5164 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
5165 to be read as terminal input by Emacs's parent, after suspension.\n\
5167 Before suspending, call the functions in `suspend-hook' with no args.\n\
5168 If any of them returns nil, don't call the rest and don't suspend.\n\
5169 Otherwise, suspend normally and after resumption run the normal hook\n\
5170 `suspend-resume-hook' if that is bound and non-nil.\n\
5172 Some operating systems cannot stop the Emacs process and resume it later.\n\
5173 On such systems, Emacs starts a subshell instead of suspending.")
5175 Lisp_Object stuffstring
;
5178 int count
= specpdl_ptr
- specpdl
;
5179 int old_height
, old_width
;
5181 struct gcpro gcpro1
, gcpro2
;
5182 extern init_sys_modes ();
5184 if (!NILP (stuffstring
))
5185 CHECK_STRING (stuffstring
, 0);
5187 /* Run the functions in suspend-hook. */
5188 if (!NILP (Vrun_hooks
))
5189 call1 (Vrun_hooks
, intern ("suspend-hook"));
5191 GCPRO1 (stuffstring
);
5192 get_frame_size (&old_width
, &old_height
);
5194 /* sys_suspend can get an error if it tries to fork a subshell
5195 and the system resources aren't available for that. */
5196 record_unwind_protect (init_sys_modes
, 0);
5197 stuff_buffered_input (stuffstring
);
5199 unbind_to (count
, Qnil
);
5201 /* Check if terminal/window size has changed.
5202 Note that this is not useful when we are running directly
5203 with a window system; but suspend should be disabled in that case. */
5204 get_frame_size (&width
, &height
);
5205 if (width
!= old_width
|| height
!= old_height
)
5206 change_frame_size (selected_frame
, height
, width
, 0, 0);
5208 /* Run suspend-resume-hook. */
5209 if (!NILP (Vrun_hooks
))
5210 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
5216 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
5217 Then in any case stuff anything Emacs has read ahead and not used. */
5219 stuff_buffered_input (stuffstring
)
5220 Lisp_Object stuffstring
;
5222 register unsigned char *p
;
5224 /* stuff_char works only in BSD, versions 4.2 and up. */
5227 if (XTYPE (stuffstring
) == Lisp_String
)
5231 p
= XSTRING (stuffstring
)->data
;
5232 count
= XSTRING (stuffstring
)->size
;
5237 /* Anything we have read ahead, put back for the shell to read. */
5238 while (kbd_fetch_ptr
!= kbd_store_ptr
)
5240 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
5241 kbd_fetch_ptr
= kbd_buffer
;
5242 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
5243 stuff_char (kbd_fetch_ptr
->code
);
5244 kbd_fetch_ptr
->kind
= no_event
;
5245 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
5252 #endif /* BSD and not BSD4_1 */
5255 set_waiting_for_input (time_to_clear
)
5256 EMACS_TIME
*time_to_clear
;
5258 input_available_clear_time
= time_to_clear
;
5260 /* Tell interrupt_signal to throw back to read_char, */
5261 waiting_for_input
= 1;
5263 /* If interrupt_signal was called before and buffered a C-g,
5264 make it run again now, to avoid timing error. */
5265 if (!NILP (Vquit_flag
))
5266 quit_throw_to_read_char ();
5269 clear_waiting_for_input ()
5271 /* Tell interrupt_signal not to throw back to read_char, */
5272 waiting_for_input
= 0;
5273 input_available_clear_time
= 0;
5276 /* This routine is called at interrupt level in response to C-G.
5277 If interrupt_input, this is the handler for SIGINT.
5278 Otherwise, it is called from kbd_buffer_store_event,
5279 in handling SIGIO or SIGTINT.
5281 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
5282 immediately throw back to read_char.
5284 Otherwise it sets the Lisp variable quit-flag not-nil.
5285 This causes eval to throw, when it gets a chance.
5286 If quit-flag is already non-nil, it stops the job right away. */
5292 /* Must preserve main program's value of errno. */
5293 int old_errno
= errno
;
5296 /* USG systems forget handlers when they are used;
5297 must reestablish each time */
5298 signal (SIGINT
, interrupt_signal
);
5299 signal (SIGQUIT
, interrupt_signal
);
5304 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
5309 #ifdef SIGTSTP /* Support possible in later USG versions */
5311 * On systems which can suspend the current process and return to the original
5312 * shell, this command causes the user to end up back at the shell.
5313 * The "Auto-save" and "Abort" questions are not asked until
5314 * the user elects to return to emacs, at which point he can save the current
5315 * job and either dump core or continue.
5320 if (sys_suspend () == -1)
5322 printf ("Not running as a subprocess;\n");
5323 printf ("you can continue or abort.\n");
5326 /* Perhaps should really fork an inferior shell?
5327 But that would not provide any way to get back
5328 to the original shell, ever. */
5329 printf ("No support for stopping a process on this operating system;\n");
5330 printf ("you can continue or abort.\n");
5331 #endif /* not VMS */
5332 #endif /* not SIGTSTP */
5334 /* We must remain inside the screen area when the internal terminal
5335 is used. Note that [Enter] is not echoed by dos. */
5338 printf ("Auto-save? (y or n) ");
5340 if (((c
= getchar ()) & ~040) == 'Y')
5342 Fdo_auto_save (Qt
, Qnil
);
5344 printf ("\r\nAuto-save done");
5345 #else /* not MSDOS */
5346 printf ("Auto-save done\n");
5347 #endif /* not MSDOS */
5349 while (c
!= '\n') c
= getchar ();
5351 printf ("\r\nAbort? (y or n) ");
5352 #else /* not MSDOS */
5354 printf ("Abort (and enter debugger)? (y or n) ");
5356 printf ("Abort (and dump core)? (y or n) ");
5357 #endif /* not VMS */
5358 #endif /* not MSDOS */
5360 if (((c
= getchar ()) & ~040) == 'Y')
5362 while (c
!= '\n') c
= getchar ();
5364 printf ("\r\nContinuing...\r\n");
5365 #else /* not MSDOS */
5366 printf ("Continuing...\n");
5367 #endif /* not MSDOS */
5373 /* If executing a function that wants to be interrupted out of
5374 and the user has not deferred quitting by binding `inhibit-quit'
5375 then quit right away. */
5376 if (immediate_quit
&& NILP (Vinhibit_quit
))
5380 Fsignal (Qquit
, Qnil
);
5383 /* Else request quit when it's safe */
5387 if (waiting_for_input
&& !echoing
)
5388 quit_throw_to_read_char ();
5393 /* Handle a C-g by making read_char return C-g. */
5395 quit_throw_to_read_char ()
5397 quit_error_check ();
5399 /* Prevent another signal from doing this before we finish. */
5400 clear_waiting_for_input ();
5403 unread_command_events
= Qnil
;
5404 unread_command_char
= -1;
5406 #ifdef POLL_FOR_INPUT
5407 /* May be > 1 if in recursive minibuffer. */
5408 if (poll_suppress_count
== 0)
5412 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
5413 && XFRAME (internal_last_event_frame
) != selected_frame
)
5414 Fhandle_switch_frame (make_lispy_switch_frame (internal_last_event_frame
));
5417 _longjmp (getcjmp
, 1);
5420 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
5421 "Set mode of reading keyboard input.\n\
5422 First arg INTERRUPT non-nil means use input interrupts;\n\
5423 nil means use CBREAK mode.\n\
5424 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
5425 (no effect except in CBREAK mode).\n\
5426 Third arg META t means accept 8-bit input (for a Meta key).\n\
5427 META nil means ignore the top bit, on the assumption it is parity.\n\
5428 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
5429 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
5430 See also `current-input-mode'.")
5431 (interrupt
, flow
, meta
, quit
)
5432 Lisp_Object interrupt
, flow
, meta
, quit
;
5435 && (XTYPE (quit
) != Lisp_Int
5436 || XINT (quit
) < 0 || XINT (quit
) > 0400))
5437 error ("set-input-mode: QUIT must be an ASCII character");
5439 #ifdef POLL_FOR_INPUT
5445 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5446 #ifdef NO_SOCK_SIGIO
5447 if (read_socket_hook
)
5448 interrupt_input
= 0; /* No interrupts if reading from a socket. */
5450 #endif /* NO_SOCK_SIGIO */
5451 interrupt_input
= !NILP (interrupt
);
5452 #else /* not SIGIO */
5453 interrupt_input
= 0;
5454 #endif /* not SIGIO */
5455 /* Our VMS input only works by interrupts, as of now. */
5457 interrupt_input
= 1;
5459 flow_control
= !NILP (flow
);
5462 else if (EQ (meta
, Qt
))
5467 /* Don't let this value be out of range. */
5468 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
5472 #ifdef POLL_FOR_INPUT
5473 poll_suppress_count
= 1;
5479 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
5480 "Return information about the way Emacs currently reads keyboard input.\n\
5481 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
5482 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
5483 nil, Emacs is using CBREAK mode.\n\
5484 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
5485 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
5486 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
5487 META nil means ignoring the top bit, on the assumption it is parity.\n\
5488 META is neither t nor nil if accepting 8-bit input and using\n\
5489 all 8 bits as the character code.\n\
5490 QUIT is the character Emacs currently uses to quit.\n\
5491 The elements of this list correspond to the arguments of\n\
5497 val
[0] = interrupt_input
? Qt
: Qnil
;
5498 val
[1] = flow_control
? Qt
: Qnil
;
5499 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
5500 XFASTINT (val
[3]) = quit_char
;
5502 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
5508 /* This is correct before outermost invocation of the editor loop */
5509 command_loop_level
= -1;
5511 quit_char
= Ctl ('g');
5512 unread_command_events
= Qnil
;
5513 unread_command_char
= -1;
5515 recent_keys_index
= 0;
5516 kbd_fetch_ptr
= kbd_buffer
;
5517 kbd_store_ptr
= kbd_buffer
;
5518 do_mouse_tracking
= 0;
5522 /* This means that command_loop_1 won't try to select anything the first
5524 internal_last_event_frame
= Qnil
;
5525 Vlast_event_frame
= internal_last_event_frame
;
5528 /* If we're running a dumped Emacs, we need to clear out
5529 kbd_buffer_frame_or_window, in case some events got into it
5532 If we're running an undumped Emacs, it hasn't been initialized by
5533 syms_of_keyboard yet. */
5535 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5537 if (!noninteractive
)
5539 signal (SIGINT
, interrupt_signal
);
5540 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
5541 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
5542 SIGQUIT and we can't tell which one it will give us. */
5543 signal (SIGQUIT
, interrupt_signal
);
5544 #endif /* HAVE_TERMIO */
5545 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5547 signal (SIGIO
, input_available_signal
);
5551 /* Use interrupt input by default, if it works and noninterrupt input
5552 has deficiencies. */
5554 #ifdef INTERRUPT_INPUT
5555 interrupt_input
= 1;
5557 interrupt_input
= 0;
5560 /* Our VMS input only works by interrupts, as of now. */
5562 interrupt_input
= 1;
5568 if (keyboard_init_hook
)
5569 (*keyboard_init_hook
) ();
5571 #ifdef POLL_FOR_INPUT
5572 poll_suppress_count
= 1;
5577 /* This type's only use is in syms_of_keyboard, to initialize the
5578 event header symbols and put properties on them. */
5585 struct event_head head_table
[] = {
5586 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
5587 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
5588 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
5593 Qdisabled_command_hook
= intern ("disabled-command-hook");
5594 staticpro (&Qdisabled_command_hook
);
5596 Qself_insert_command
= intern ("self-insert-command");
5597 staticpro (&Qself_insert_command
);
5599 Qforward_char
= intern ("forward-char");
5600 staticpro (&Qforward_char
);
5602 Qbackward_char
= intern ("backward-char");
5603 staticpro (&Qbackward_char
);
5605 Qdisabled
= intern ("disabled");
5606 staticpro (&Qdisabled
);
5608 Qundefined
= intern ("undefined");
5609 staticpro (&Qundefined
);
5611 Qpre_command_hook
= intern ("pre-command-hook");
5612 staticpro (&Qpre_command_hook
);
5614 Qpost_command_hook
= intern ("post-command-hook");
5615 staticpro (&Qpost_command_hook
);
5617 Qcommand_hook_internal
= intern ("command-hook-internal");
5618 staticpro (&Qcommand_hook_internal
);
5620 Qfunction_key
= intern ("function-key");
5621 staticpro (&Qfunction_key
);
5622 Qmouse_click
= intern ("mouse-click");
5623 staticpro (&Qmouse_click
);
5625 Qmenu_enable
= intern ("menu-enable");
5626 staticpro (&Qmenu_enable
);
5628 Qmode_line
= intern ("mode-line");
5629 staticpro (&Qmode_line
);
5630 Qvertical_line
= intern ("vertical-line");
5631 staticpro (&Qvertical_line
);
5632 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
5633 staticpro (&Qvertical_scroll_bar
);
5634 Qmenu_bar
= intern ("menu-bar");
5635 staticpro (&Qmenu_bar
);
5637 Qabove_handle
= intern ("above-handle");
5638 staticpro (&Qabove_handle
);
5639 Qhandle
= intern ("handle");
5640 staticpro (&Qhandle
);
5641 Qbelow_handle
= intern ("below-handle");
5642 staticpro (&Qbelow_handle
);
5644 Qevent_kind
= intern ("event-kind");
5645 staticpro (&Qevent_kind
);
5646 Qevent_symbol_elements
= intern ("event-symbol-elements");
5647 staticpro (&Qevent_symbol_elements
);
5648 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
5649 staticpro (&Qevent_symbol_element_mask
);
5650 Qmodifier_cache
= intern ("modifier-cache");
5651 staticpro (&Qmodifier_cache
);
5653 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
5654 staticpro (&Qrecompute_lucid_menubar
);
5655 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
5656 staticpro (&Qactivate_menubar_hook
);
5659 struct event_head
*p
;
5661 for (p
= head_table
;
5662 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
5665 *p
->var
= intern (p
->name
);
5667 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
5668 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
5672 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
5673 staticpro (&button_down_location
);
5677 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
5679 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
5680 for (i
= 0; i
< len
; i
++)
5681 if (modifier_names
[i
])
5682 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
5683 staticpro (&modifier_symbols
);
5686 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
5687 staticpro (&recent_keys
);
5689 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
5690 staticpro (&this_command_keys
);
5692 Qextended_command_history
= intern ("extended-command-history");
5693 Fset (Qextended_command_history
, Qnil
);
5694 staticpro (&Qextended_command_history
);
5696 kbd_buffer_frame_or_window
5697 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
5698 staticpro (&kbd_buffer_frame_or_window
);
5700 func_key_syms
= Qnil
;
5701 staticpro (&func_key_syms
);
5704 staticpro (&mouse_syms
);
5706 unread_switch_frame
= Qnil
;
5707 staticpro (&unread_switch_frame
);
5709 defsubr (&Sread_key_sequence
);
5710 defsubr (&Srecursive_edit
);
5711 defsubr (&Strack_mouse
);
5712 defsubr (&Sinput_pending_p
);
5713 defsubr (&Scommand_execute
);
5714 defsubr (&Srecent_keys
);
5715 defsubr (&Sthis_command_keys
);
5716 defsubr (&Ssuspend_emacs
);
5717 defsubr (&Sabort_recursive_edit
);
5718 defsubr (&Sexit_recursive_edit
);
5719 defsubr (&Srecursion_depth
);
5720 defsubr (&Stop_level
);
5721 defsubr (&Sdiscard_input
);
5722 defsubr (&Sopen_dribble_file
);
5723 defsubr (&Sset_input_mode
);
5724 defsubr (&Scurrent_input_mode
);
5725 defsubr (&Sexecute_extended_command
);
5727 DEFVAR_LISP ("last-command-char", &last_command_char
,
5728 "Last input event that was part of a command.");
5730 DEFVAR_LISP ("last-command-event", &last_command_char
,
5731 "Last input event that was part of a command.");
5733 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
5734 "Last input event in a command, except for mouse menu events.\n\
5735 Mouse menus give back keys that don't look like mouse events;\n\
5736 this variable holds the actual mouse event that led to the menu,\n\
5737 so that you can determine whether the command was run by mouse or not.");
5739 DEFVAR_LISP ("last-input-char", &last_input_char
,
5740 "Last input event.");
5742 DEFVAR_LISP ("last-input-event", &last_input_char
,
5743 "Last input event.");
5745 DEFVAR_LISP ("unread-command-events", &unread_command_events
,
5746 "List of objects to be read as next command input events.");
5748 DEFVAR_INT ("unread-command-char", &unread_command_char
,
5749 "If not -1, an object to be read as next command input event.");
5751 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
5752 "Meta-prefix character code. Meta-foo as command input\n\
5753 turns into this character followed by foo.");
5754 XSET (meta_prefix_char
, Lisp_Int
, 033);
5756 DEFVAR_LISP ("last-command", &last_command
,
5757 "The last command executed. Normally a symbol with a function definition,\n\
5758 but can be whatever was found in the keymap, or whatever the variable\n\
5759 `this-command' was set to by that command.");
5760 last_command
= Qnil
;
5762 DEFVAR_LISP ("this-command", &this_command
,
5763 "The command now being executed.\n\
5764 The command can set this variable; whatever is put here\n\
5765 will be in `last-command' during the following command.");
5766 this_command
= Qnil
;
5768 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
5769 "*Number of keyboard input characters between auto-saves.\n\
5770 Zero means disable autosaving due to number of characters typed.");
5771 auto_save_interval
= 300;
5773 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
5774 "*Number of seconds idle time before auto-save.\n\
5775 Zero or nil means disable auto-saving due to idleness.\n\
5776 After auto-saving due to this many seconds of idle time,\n\
5777 Emacs also does a garbage collection if that seems to be warranted.");
5778 XFASTINT (Vauto_save_timeout
) = 30;
5780 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
5781 "*Nonzero means echo unfinished commands after this many seconds of pause.");
5782 echo_keystrokes
= 1;
5784 DEFVAR_INT ("polling-period", &polling_period
,
5785 "*Interval between polling for input during Lisp execution.\n\
5786 The reason for polling is to make C-g work to stop a running program.\n\
5787 Polling is needed only when using X windows and SIGIO does not work.\n\
5788 Polling is automatically disabled in all other cases.");
5791 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
5792 "*Maximum time between mouse clicks to make a double-click.\n\
5793 Measured in milliseconds. nil means disable double-click recognition;\n\
5794 t means double-clicks have no time limit and are detected\n\
5795 by position only.");
5796 Vdouble_click_time
= make_number (500);
5798 DEFVAR_INT ("num-input-keys", &num_input_keys
,
5799 "*Number of complete keys read from the keyboard so far.");
5803 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
5804 "*The frame in which the most recently read event occurred.\n\
5805 If the last event came from a keyboard macro, this is set to `macro'.");
5806 Vlast_event_frame
= Qnil
;
5809 DEFVAR_LISP ("help-char", &Vhelp_char
,
5810 "Character to recognize as meaning Help.\n\
5811 When it is read, do `(eval help-form)', and display result if it's a string.\n\
5812 If the value of `help-form' is nil, this char can be read normally.");
5813 XSET (Vhelp_char
, Lisp_Int
, Ctl ('H'));
5815 DEFVAR_LISP ("help-form", &Vhelp_form
,
5816 "Form to execute when character `help-char' is read.\n\
5817 If the form returns a string, that string is displayed.\n\
5818 If `help-form' is nil, the help char is not recognized.");
5821 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
5822 "Command to run when `help-char' character follows a prefix key.\n\
5823 This command is used only when there is no actual binding\n\
5824 for that character after that prefix key.");
5825 Vprefix_help_command
= Qnil
;
5827 DEFVAR_LISP ("top-level", &Vtop_level
,
5828 "Form to evaluate when Emacs starts up.\n\
5829 Useful to set before you dump a modified Emacs.");
5832 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
5833 "String used as translate table for keyboard input, or nil.\n\
5834 Each character is looked up in this string and the contents used instead.\n\
5835 If string is of length N, character codes N and up are untranslated.");
5836 Vkeyboard_translate_table
= Qnil
;
5838 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
5839 "Keymap of key translations that can override keymaps.\n\
5840 This keymap works like `function-key-map', but comes after that,\n\
5841 and applies even for keys that have ordinary bindings.");
5842 Vkey_translation_map
= Qnil
;
5844 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
5845 "Non-nil means prompt with menus when appropriate.\n\
5846 This is done when reading from a keymap that has a prompt string,\n\
5847 for elements that have prompt strings.\n\
5848 The menu is displayed on the screen\n\
5849 if X menus were enabled at configuration\n\
5850 time and the previous event was a mouse click prefix key.\n\
5851 Otherwise, menu prompting uses the echo area.");
5854 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
5855 "Character to see next line of menu prompt.\n\
5856 Type this character while in a menu prompt to rotate around the lines of it.");
5857 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
5859 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
5860 "A mask of additional modifier keys to use with every keyboard character.\n\
5861 Emacs applies the modifiers of the character stored here to each keyboard\n\
5862 character it reads. For example, after evaluating the expression\n\
5863 (setq extra-keyboard-modifiers ?\C-x)\n\
5864 all input characters will have the control modifier applied to them.\n\
5866 Note that the character ?\C-@, equivalent to the integer zero, does\n\
5867 not count as a control character; rather, it counts as a character\n\
5868 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
5869 cancels any modification.");
5870 extra_keyboard_modifiers
= 0;
5872 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
5873 "If an editing command sets this to t, deactivate the mark afterward.\n\
5874 The command loop sets this to nil before each command,\n\
5875 and tests the value when the command returns.\n\
5876 Buffer modification stores t in this variable.");
5877 Vdeactivate_mark
= Qnil
;
5879 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
5880 "Temporary storage of pre-command-hook or post-command-hook.");
5881 Vcommand_hook_internal
= Qnil
;
5883 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
5884 "Normal hook run before each command is executed.");
5885 Vpre_command_hook
= Qnil
;
5887 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
5888 "Normal hook run after each command is executed.");
5889 Vpost_command_hook
= Qnil
;
5891 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
5892 "t means menu bar, specified Lucid style, needs to be recomputed.");
5893 Vlucid_menu_bar_dirty_flag
= Qnil
;
5895 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
5896 "List of menu bar items to move to the end of the menu bar.\n\
5897 The elements of the list are event types that may have menu bar bindings.");
5898 Vmenu_bar_final_items
= Qnil
;
5900 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
5901 "Keymap that overrides all other local keymaps.\n\
5902 If this variable is non-nil, it is used as a keymap instead of the\n\
5903 buffer's local map, and the minor mode keymaps and text property keymaps.");
5904 Voverriding_local_map
= Qnil
;
5906 DEFVAR_BOOL ("track-mouse", &do_mouse_tracking
,
5907 "*Non-nil means generate motion events for mouse motion.");
5909 DEFVAR_LISP ("system-key-alist", &Vsystem_key_alist
,
5910 "Alist of system-specific X windows key symbols.\n\
5911 Each element should have the form (N . SYMBOL) where N is the\n\
5912 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
5913 and SYMBOL is its name.");
5914 Vmenu_bar_final_items
= Qnil
;
5919 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
5920 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
5921 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
5922 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
5923 initial_define_key (meta_map
, 'x', "execute-extended-command");