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 vendor_key_syms
;
2172 static Lisp_Object func_key_syms
;
2173 static Lisp_Object mouse_syms
;
2175 Lisp_Object Vvendor_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 vendor-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 (vendor_key_syms
))
2461 vendor_key_syms
= Fcons (Qnil
, Qnil
);
2462 return modify_event_symbol (event
->code
& 0xffffff,
2464 Qfunction_key
, Vvendor_key_alist
,
2465 0, &vendor_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
);
2496 = window_from_coordinates (f
, XINT (event
->x
), XINT (event
->y
),
2500 #ifdef USE_X_TOOLKIT
2501 if (FRAME_EXTERNAL_MENU_BAR (f
) && XINT (event
->y
) == -1)
2503 if (XINT (event
->y
) < FRAME_MENU_BAR_LINES (f
))
2506 #ifdef USE_X_TOOLKIT
2507 /* The click happened in the menubar.
2508 Look for the menu item selected. */
2509 Lisp_Object items
= map_event_to_object(event
, f
);
2510 XFASTINT (event
->y
) = 1;
2511 #else /* not USE_X_TOOLKIT */
2514 items
= FRAME_MENU_BAR_ITEMS (f
);
2515 for (; CONSP (items
); items
= XCONS (items
)->cdr
)
2517 Lisp_Object pos
, string
;
2518 pos
= Fcdr (Fcdr (Fcar (items
)));
2519 string
= Fcar (Fcdr (Fcar (items
)));
2520 if (XINT (event
->x
) >= XINT (pos
)
2521 && XINT (event
->x
) < XINT (pos
) + XSTRING (string
)->size
)
2524 #endif /* not USE_X_TOOLKIT */
2526 = Fcons (event
->frame_or_window
,
2528 Fcons (Fcons (event
->x
, event
->y
),
2529 Fcons (make_number (event
->timestamp
),
2533 return Fcons (Fcar (Fcar (items
)),
2534 Fcons (position
, Qnil
));
2536 return Fcons (Qnil
, Fcons (position
, Qnil
));
2538 else if (XTYPE (window
) != Lisp_Window
)
2543 (XINT (event
->x
) - XINT (XWINDOW (window
)->left
)));
2545 (XINT (event
->y
) - XINT (XWINDOW (window
)->top
)));
2550 posn
= Qvertical_line
;
2552 XSET (posn
, Lisp_Int
,
2553 buffer_posn_from_coords (XWINDOW (window
),
2561 Fcons (Fcons (event
->x
, event
->y
),
2562 Fcons (make_number (event
->timestamp
),
2567 Lisp_Object window
= event
->frame_or_window
;
2568 Lisp_Object portion_whole
= Fcons (event
->x
, event
->y
);
2569 Lisp_Object part
= *scroll_bar_parts
[(int) event
->part
];
2573 Fcons (Qvertical_scroll_bar
,
2574 Fcons (portion_whole
,
2575 Fcons (make_number (event
->timestamp
),
2580 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2582 start_pos
= *start_pos_ptr
;
2583 *start_pos_ptr
= Qnil
;
2585 is_double
= (button
== last_mouse_button
2586 && XINT (event
->x
) == last_mouse_x
2587 && XINT (event
->y
) == last_mouse_y
2588 && button_down_time
!= 0
2589 && (EQ (Vdouble_click_time
, Qt
)
2590 || (INTEGERP (Vdouble_click_time
)
2591 && ((int)(event
->timestamp
- button_down_time
)
2592 < XINT (Vdouble_click_time
)))));
2593 last_mouse_button
= button
;
2594 last_mouse_x
= XINT (event
->x
);
2595 last_mouse_y
= XINT (event
->y
);
2597 /* If this is a button press, squirrel away the location, so
2598 we can decide later whether it was a click or a drag. */
2599 if (event
->modifiers
& down_modifier
)
2603 double_click_count
++;
2604 event
->modifiers
|= ((double_click_count
> 2)
2609 double_click_count
= 1;
2610 button_down_time
= event
->timestamp
;
2611 *start_pos_ptr
= Fcopy_alist (position
);
2614 /* Now we're releasing a button - check the co-ordinates to
2615 see if this was a click or a drag. */
2616 else if (event
->modifiers
& up_modifier
)
2618 /* If we did not see a down before this up,
2619 ignore the up. Probably this happened because
2620 the down event chose a menu item.
2621 It would be an annoyance to treat the release
2622 of the button that chose the menu item
2623 as a separate event. */
2625 if (XTYPE (start_pos
) != Lisp_Cons
)
2628 event
->modifiers
&= ~up_modifier
;
2629 #if 0 /* Formerly we treated an up with no down as a click event. */
2630 if (XTYPE (start_pos
) != Lisp_Cons
)
2631 event
->modifiers
|= click_modifier
;
2635 /* The third element of every position should be the (x,y)
2637 Lisp_Object down
= Fnth (make_number (2), start_pos
);
2639 if (EQ (event
->x
, XCONS (down
)->car
)
2640 && EQ (event
->y
, XCONS (down
)->cdr
))
2642 if (is_double
&& double_click_count
> 1)
2643 event
->modifiers
|= ((double_click_count
> 2)
2647 event
->modifiers
|= click_modifier
;
2651 button_down_time
= 0;
2652 event
->modifiers
|= drag_modifier
;
2657 /* Every mouse event should either have the down_modifier or
2658 the up_modifier set. */
2662 /* Get the symbol we should use for the mouse click. */
2664 = modify_event_symbol (button
,
2667 lispy_mouse_names
, &mouse_syms
,
2668 (sizeof (lispy_mouse_names
)
2669 / sizeof (lispy_mouse_names
[0])));
2671 if (event
->modifiers
& drag_modifier
)
2676 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2679 Fcons (make_number (double_click_count
),
2688 /* The 'kind' field of the event is something we don't recognize. */
2695 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2697 Lisp_Object bar_window
;
2698 enum scroll_bar_part part
;
2702 /* Is it a scroll bar movement? */
2703 if (frame
&& ! NILP (bar_window
))
2705 Lisp_Object part_sym
= *scroll_bar_parts
[(int) part
];
2707 return Fcons (Qscroll_bar_movement
,
2708 (Fcons (Fcons (bar_window
,
2709 Fcons (Qvertical_scroll_bar
,
2710 Fcons (Fcons (x
, y
),
2711 Fcons (make_number (time
),
2717 /* Or is it an ordinary mouse movement? */
2721 Lisp_Object window
=
2723 ? window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
)
2727 if (XTYPE (window
) == Lisp_Window
)
2729 XSETINT (x
, XINT (x
) - XINT (XWINDOW (window
)->left
));
2730 XSETINT (y
, XINT (y
) - XINT (XWINDOW (window
)->top
));
2735 posn
= Qvertical_line
;
2737 XSET (posn
, Lisp_Int
,
2738 buffer_posn_from_coords (XWINDOW (window
),
2739 XINT (x
), XINT (y
)));
2741 else if (frame
!= 0)
2743 XSET (window
, Lisp_Frame
, frame
);
2754 return Fcons (Qmouse_movement
,
2755 Fcons (Fcons (window
,
2757 Fcons (Fcons (x
, y
),
2758 Fcons (make_number (time
),
2764 /* Construct a switch frame event. */
2766 make_lispy_switch_frame (frame
)
2769 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
2772 /* Manipulating modifiers. */
2774 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
2776 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2777 SYMBOL's name of the end of the modifiers; the string from this
2778 position is the unmodified symbol name.
2780 This doesn't use any caches. */
2782 parse_modifiers_uncached (symbol
, modifier_end
)
2786 struct Lisp_String
*name
;
2790 CHECK_SYMBOL (symbol
, 1);
2793 name
= XSYMBOL (symbol
)->name
;
2796 for (i
= 0; i
+2 <= name
->size
; )
2797 switch (name
->data
[i
])
2799 #define SINGLE_LETTER_MOD(bit) \
2800 if (name->data[i+1] != '-') \
2801 goto no_more_modifiers; \
2806 SINGLE_LETTER_MOD (alt_modifier
);
2810 SINGLE_LETTER_MOD (ctrl_modifier
);
2814 SINGLE_LETTER_MOD (hyper_modifier
);
2818 SINGLE_LETTER_MOD (meta_modifier
);
2822 SINGLE_LETTER_MOD (shift_modifier
);
2826 SINGLE_LETTER_MOD (super_modifier
);
2830 if (i
+ 5 > name
->size
)
2831 goto no_more_modifiers
;
2832 if (! strncmp (name
->data
+ i
, "drag-", 5))
2834 modifiers
|= drag_modifier
;
2837 else if (! strncmp (name
->data
+ i
, "down-", 5))
2839 modifiers
|= down_modifier
;
2842 else if (i
+ 7 <= name
->size
2843 && ! strncmp (name
->data
+ i
, "double-", 7))
2845 modifiers
|= double_modifier
;
2849 goto no_more_modifiers
;
2853 if (i
+ 7 > name
->size
)
2854 goto no_more_modifiers
;
2855 if (! strncmp (name
->data
+ i
, "triple-", 7))
2857 modifiers
|= triple_modifier
;
2861 goto no_more_modifiers
;
2865 goto no_more_modifiers
;
2867 #undef SINGLE_LETTER_MOD
2871 /* Should we include the `click' modifier? */
2872 if (! (modifiers
& (down_modifier
| drag_modifier
2873 | double_modifier
| triple_modifier
))
2874 && i
+ 7 == name
->size
2875 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
2876 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
2877 modifiers
|= click_modifier
;
2886 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
2887 prepended to the string BASE[0..BASE_LEN-1].
2888 This doesn't use any caches. */
2890 apply_modifiers_uncached (modifiers
, base
, base_len
)
2895 /* Since BASE could contain nulls, we can't use intern here; we have
2896 to use Fintern, which expects a genuine Lisp_String, and keeps a
2899 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
2905 /* Only the event queue may use the `up' modifier; it should always
2906 be turned into a click or drag event before presented to lisp code. */
2907 if (modifiers
& up_modifier
)
2910 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
2911 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
2912 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
2913 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
2914 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
2915 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
2916 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
2917 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
2918 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
2919 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
2920 /* The click modifier is denoted by the absence of other modifiers. */
2924 mod_len
= p
- new_mods
;
2928 Lisp_Object new_name
= make_uninit_string (mod_len
+ base_len
);
2930 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
2931 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
2933 return Fintern (new_name
, Qnil
);
2938 static char *modifier_names
[] =
2940 "up", "down", "drag", "click", "double", "triple", 0, 0,
2941 0, 0, 0, 0, 0, 0, 0, 0,
2942 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
2944 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
2946 static Lisp_Object modifier_symbols
;
2948 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
2950 lispy_modifier_list (modifiers
)
2953 Lisp_Object modifier_list
;
2956 modifier_list
= Qnil
;
2957 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
2958 if (modifiers
& (1<<i
))
2959 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
2962 return modifier_list
;
2966 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
2967 where UNMODIFIED is the unmodified form of SYMBOL,
2968 MASK is the set of modifiers present in SYMBOL's name.
2969 This is similar to parse_modifiers_uncached, but uses the cache in
2970 SYMBOL's Qevent_symbol_element_mask property, and maintains the
2971 Qevent_symbol_elements property. */
2973 parse_modifiers (symbol
)
2976 Lisp_Object elements
= Fget (symbol
, Qevent_symbol_element_mask
);
2978 if (CONSP (elements
))
2983 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
2984 Lisp_Object unmodified
2985 = Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
2986 XSYMBOL (symbol
)->name
->size
- end
),
2990 if (modifiers
& ~((1<<VALBITS
) - 1))
2992 XFASTINT (mask
) = modifiers
;
2993 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
2995 /* Cache the parsing results on SYMBOL. */
2996 Fput (symbol
, Qevent_symbol_element_mask
,
2998 Fput (symbol
, Qevent_symbol_elements
,
2999 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
3001 /* Since we know that SYMBOL is modifiers applied to unmodified,
3002 it would be nice to put that in unmodified's cache.
3003 But we can't, since we're not sure that parse_modifiers is
3010 /* Apply the modifiers MODIFIERS to the symbol BASE.
3011 BASE must be unmodified.
3013 This is like apply_modifiers_uncached, but uses BASE's
3014 Qmodifier_cache property, if present. It also builds
3015 Qevent_symbol_elements properties, since it has that info anyway.
3017 apply_modifiers copies the value of BASE's Qevent_kind property to
3018 the modified symbol. */
3020 apply_modifiers (modifiers
, base
)
3024 Lisp_Object cache
, index
, entry
, new_symbol
;
3026 /* Mask out upper bits. We don't know where this value's been. */
3027 modifiers
&= (1<<VALBITS
) - 1;
3029 /* The click modifier never figures into cache indices. */
3030 cache
= Fget (base
, Qmodifier_cache
);
3031 XFASTINT (index
) = (modifiers
& ~click_modifier
);
3032 entry
= Fassq (index
, cache
);
3035 new_symbol
= XCONS (entry
)->cdr
;
3038 /* We have to create the symbol ourselves. */
3039 new_symbol
= apply_modifiers_uncached (modifiers
,
3040 XSYMBOL (base
)->name
->data
,
3041 XSYMBOL (base
)->name
->size
);
3043 /* Add the new symbol to the base's cache. */
3044 entry
= Fcons (index
, new_symbol
);
3045 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
3047 /* We have the parsing info now for free, so add it to the caches. */
3048 XFASTINT (index
) = modifiers
;
3049 Fput (new_symbol
, Qevent_symbol_element_mask
,
3050 Fcons (base
, Fcons (index
, Qnil
)));
3051 Fput (new_symbol
, Qevent_symbol_elements
,
3052 Fcons (base
, lispy_modifier_list (modifiers
)));
3055 /* Make sure this symbol is of the same kind as BASE.
3057 You'd think we could just set this once and for all when we
3058 intern the symbol above, but reorder_modifiers may call us when
3059 BASE's property isn't set right; we can't assume that just
3060 because it has a Qmodifier_cache property it must have its
3061 Qevent_kind set right as well. */
3062 if (NILP (Fget (new_symbol
, Qevent_kind
)))
3064 Lisp_Object kind
= Fget (base
, Qevent_kind
);
3067 Fput (new_symbol
, Qevent_kind
, kind
);
3074 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
3075 return a symbol with the modifiers placed in the canonical order.
3076 Canonical order is alphabetical, except for down and drag, which
3077 always come last. The 'click' modifier is never written out.
3079 Fdefine_key calls this to make sure that (for example) C-M-foo
3080 and M-C-foo end up being equivalent in the keymap. */
3083 reorder_modifiers (symbol
)
3086 /* It's hopefully okay to write the code this way, since everything
3087 will soon be in caches, and no consing will be done at all. */
3088 Lisp_Object parsed
= parse_modifiers (symbol
);
3090 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
3091 XCONS (parsed
)->car
);
3095 /* For handling events, we often want to produce a symbol whose name
3096 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
3097 to some base, like the name of a function key or mouse button.
3098 modify_event_symbol produces symbols of this sort.
3100 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
3101 is the name of the i'th symbol. TABLE_SIZE is the number of elements
3104 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
3105 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
3107 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
3108 persist between calls to modify_event_symbol that it can use to
3109 store a cache of the symbols it's generated for this NAME_TABLE
3110 before. The object stored there may be a vector or an alist.
3112 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
3114 MODIFIERS is a set of modifier bits (as given in struct input_events)
3115 whose prefixes should be applied to the symbol name.
3117 SYMBOL_KIND is the value to be placed in the event_kind property of
3118 the returned symbol.
3120 The symbols we create are supposed to have an
3121 `event-symbol-elements' property, which lists the modifiers present
3122 in the symbol's name. */
3125 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
3126 name_table
, symbol_table
, table_size
)
3129 Lisp_Object symbol_kind
;
3130 Lisp_Object name_alist
;
3132 Lisp_Object
*symbol_table
;
3136 Lisp_Object symbol_int
;
3138 XSET (symbol_int
, Lisp_Int
, symbol_num
);
3140 /* Is this a request for a valid symbol? */
3141 if (symbol_num
< 0 || symbol_num
>= table_size
)
3144 if (CONSP (*symbol_table
))
3145 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
3147 /* If *symbol_table doesn't seem to be initialized properly, fix that.
3148 *symbol_table should be a lisp vector TABLE_SIZE elements long,
3149 where the Nth element is the symbol for NAME_TABLE[N], or nil if
3150 we've never used that symbol before. */
3153 if (! VECTORP (*symbol_table
)
3154 || XVECTOR (*symbol_table
)->size
!= table_size
)
3158 XFASTINT (size
) = table_size
;
3159 *symbol_table
= Fmake_vector (size
, Qnil
);
3162 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
3165 /* Have we already used this symbol before? */
3168 /* No; let's create it. */
3169 if (!NILP (name_alist
))
3170 value
= Fassq (symbol_int
, name_alist
);
3171 else if (name_table
[symbol_num
])
3172 value
= intern (name_table
[symbol_num
]);
3176 sprintf (buf
, "key-%d", symbol_num
);
3177 value
= intern (buf
);
3180 if (CONSP (*symbol_table
))
3181 *symbol_table
= Fcons (value
, *symbol_table
);
3183 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
3185 /* Fill in the cache entries for this symbol; this also
3186 builds the Qevent_symbol_elements property, which the user
3188 apply_modifiers (modifiers
& click_modifier
, value
);
3189 Fput (value
, Qevent_kind
, symbol_kind
);
3192 /* Apply modifiers to that symbol. */
3193 return apply_modifiers (modifiers
, value
);
3197 /* Store into *addr a value nonzero if terminal input chars are available.
3198 Serves the purpose of ioctl (0, FIONREAD, addr)
3199 but works even if FIONREAD does not exist.
3200 (In fact, this may actually read some input.) */
3203 get_input_pending (addr
)
3206 /* First of all, have we already counted some input? */
3207 *addr
= !NILP (Vquit_flag
) || readable_events ();
3209 /* If input is being read as it arrives, and we have none, there is none. */
3210 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
3213 /* Try to read some input and see how much we get. */
3215 *addr
= !NILP (Vquit_flag
) || readable_events ();
3218 /* Interface to read_avail_input, blocking SIGIO if necessary. */
3221 gobble_input (expected
)
3226 if (interrupt_input
)
3229 mask
= sigblockx (SIGIO
);
3230 read_avail_input (expected
);
3235 read_avail_input (expected
);
3241 /* Read any terminal input already buffered up by the system
3242 into the kbd_buffer, but do not wait.
3244 EXPECTED should be nonzero if the caller knows there is some input.
3246 Except on VMS, all input is read by this function.
3247 If interrupt_input is nonzero, this function MUST be called
3248 only when SIGIO is blocked.
3250 Returns the number of keyboard chars read, or -1 meaning
3251 this is a bad time to try to read input. */
3254 read_avail_input (expected
)
3257 struct input_event buf
[KBD_BUFFER_SIZE
];
3261 if (read_socket_hook
)
3262 /* No need for FIONREAD or fcntl; just say don't wait. */
3263 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
3266 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
3267 the kbd_buffer can really hold. That may prevent loss
3268 of characters on some systems when input is stuffed at us. */
3269 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
3272 nread
= dos_keysns ();
3273 if (nread
== 0) return 0;
3274 #else */ not MSDOS */
3276 /* Find out how much input is available. */
3277 if (ioctl (0, FIONREAD
, &nread
) < 0)
3278 /* Formerly simply reported no input, but that sometimes led to
3279 a failure of Emacs to terminate.
3280 SIGHUP seems appropriate if we can't reach the terminal. */
3281 /* ??? Is it really right to send the signal just to this process
3282 rather than to the whole process group?
3283 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3284 kill (getpid (), SIGHUP
);
3287 if (nread
> sizeof cbuf
)
3288 nread
= sizeof cbuf
;
3289 #else /* no FIONREAD */
3290 #if defined(USG) || defined(DGUX)
3291 /* Read some input if available, but don't wait. */
3292 nread
= sizeof cbuf
;
3293 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
3298 #endif /* not MSDOS */
3300 /* Now read; for one reason or another, this will not block. */
3304 cbuf
[0] = dos_keyread();
3307 nread
= read (fileno (stdin
), cbuf
, nread
);
3310 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3311 This looks incorrect, but it isn't, because _BSD causes
3312 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3313 and that causes a value other than 0 when there is no input. */
3317 /* This code is wrong, but at least it gets the right results.
3318 Fix it for 19.23. */
3319 /* Retry the read if it is interrupted. */
3322 || ! (errno
== EAGAIN
|| errno
== EFAULT
3324 || ! (errno
== EAGAIN
3334 #if defined (USG) || defined (DGUX)
3335 fcntl (fileno (stdin
), F_SETFL
, 0);
3336 #endif /* USG or DGUX */
3337 #endif /* no FIONREAD */
3338 for (i
= 0; i
< nread
; i
++)
3340 buf
[i
].kind
= ascii_keystroke
;
3341 buf
[i
].modifiers
= 0;
3342 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3343 buf
[i
].modifiers
= meta_modifier
;
3347 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
3349 XSET (buf
[i
].frame_or_window
, Lisp_Frame
, selected_frame
);
3351 buf
[i
].frame_or_window
= Qnil
;
3356 /* Scan the chars for C-g and store them in kbd_buffer. */
3357 for (i
= 0; i
< nread
; i
++)
3359 kbd_buffer_store_event (&buf
[i
]);
3360 /* Don't look at input that follows a C-g too closely.
3361 This reduces lossage due to autorepeat on C-g. */
3362 if (buf
[i
].kind
== ascii_keystroke
3363 && XINT(buf
[i
].code
) == quit_char
)
3369 #endif /* not VMS */
3371 #ifdef SIGIO /* for entire page */
3372 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3375 input_available_signal (signo
)
3378 /* Must preserve main program's value of errno. */
3379 int old_errno
= errno
;
3381 extern int select_alarmed
;
3385 /* USG systems forget handlers when they are used;
3386 must reestablish each time */
3387 signal (signo
, input_available_signal
);
3394 if (input_available_clear_time
)
3395 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3400 nread
= read_avail_input (1);
3401 /* -1 means it's not ok to read the input now.
3402 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3403 0 means there was no keyboard input available. */
3408 select_alarmed
= 1; /* Force the select emulator back to life */
3419 /* Send ourselves a SIGIO.
3421 This function exists so that the UNBLOCK_INPUT macro in
3422 blockinput.h can have some way to take care of input we put off
3423 dealing with, without assuming that every file which uses
3424 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3426 reinvoke_input_signal ()
3435 /* Return the prompt-string of a sparse keymap.
3436 This is the first element which is a string.
3437 Return nil if there is none. */
3445 register Lisp_Object tem
;
3447 if (XTYPE (tem
) == Lisp_String
)
3454 static Lisp_Object
menu_bar_item ();
3455 static Lisp_Object
menu_bar_one_keymap ();
3457 /* Return a list of menu items for a menu bar, appropriate
3458 to the current buffer.
3459 The elements have the form (KEY STRING . nil). */
3464 /* The number of keymaps we're scanning right now, and the number of
3465 keymaps we have allocated space for. */
3468 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3469 in the current keymaps, or nil where it is not a prefix. */
3472 Lisp_Object def
, tem
, tail
;
3479 /* In order to build the menus, we need to call the keymap
3480 accessors. They all call QUIT. But this function is called
3481 during redisplay, during which a quit is fatal. So inhibit
3482 quitting while building the menus.
3483 We do this instead of specbind because (1) errors will clear it anyway
3484 and (2) this avoids risk of specpdl overflow. */
3485 oquit
= Vinhibit_quit
;
3488 /* Build our list of keymaps.
3489 If we recognize a function key and replace its escape sequence in
3490 keybuf with its symbol, or if the sequence starts with a mouse
3491 click and we need to switch buffers, we jump back here to rebuild
3492 the initial keymaps from the current buffer. */
3496 if (!NILP (Voverriding_local_map
))
3499 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3500 maps
[0] = Voverriding_local_map
;
3504 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3505 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3506 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3507 #ifdef USE_TEXT_PROPERTIES
3508 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3510 maps
[nmaps
-2] = current_buffer
->keymap
;
3513 maps
[nmaps
-1] = current_global_map
;
3516 /* Look up in each map the dummy prefix key `menu-bar'. */
3520 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3522 if (! NILP (maps
[mapno
]))
3523 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3527 tem
= Fkeymapp (def
);
3529 result
= menu_bar_one_keymap (def
, result
);
3532 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3536 elt
= Fassq (XCONS (tail
)->car
, result
);
3538 result
= Fcons (elt
, Fdelq (elt
, result
));
3541 result
= Fnreverse (result
);
3542 Vinhibit_quit
= oquit
;
3546 /* Scan one map KEYMAP, accumulating any menu items it defines
3547 that have not yet been seen in RESULT. Return the updated RESULT. */
3550 menu_bar_one_keymap (keymap
, result
)
3551 Lisp_Object keymap
, result
;
3553 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3555 /* Loop over all keymap entries that have menu strings. */
3556 for (tail
= keymap
; XTYPE (tail
) == Lisp_Cons
; tail
= XCONS (tail
)->cdr
)
3558 item
= XCONS (tail
)->car
;
3559 if (XTYPE (item
) == Lisp_Cons
)
3561 key
= XCONS (item
)->car
;
3562 binding
= XCONS (item
)->cdr
;
3563 if (XTYPE (binding
) == Lisp_Cons
)
3565 item_string
= XCONS (binding
)->car
;
3566 if (XTYPE (item_string
) == Lisp_String
)
3567 result
= menu_bar_item (key
, item_string
,
3568 Fcdr (binding
), result
);
3570 else if (EQ (binding
, Qundefined
))
3571 result
= menu_bar_item (key
, item_string
,
3574 else if (XTYPE (item
) == Lisp_Vector
)
3576 /* Loop over the char values represented in the vector. */
3577 int len
= XVECTOR (item
)->size
;
3579 for (c
= 0; c
< len
; c
++)
3581 Lisp_Object character
;
3582 XFASTINT (character
) = c
;
3583 binding
= XVECTOR (item
)->contents
[c
];
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
,
3601 /* This is used as the handler when calling internal_condition_case_1. */
3604 menu_bar_item_1 (arg
)
3611 menu_bar_item (key
, item_string
, def
, result
)
3612 Lisp_Object key
, item_string
, def
, result
;
3615 Lisp_Object enabled
;
3617 if (EQ (def
, Qundefined
))
3619 /* If a map has an explicit nil as definition,
3620 discard any previously made menu bar item. */
3621 tem
= Fassq (key
, result
);
3622 return Fdelq (tem
, result
);
3625 /* See if this entry is enabled. */
3628 if (XTYPE (def
) == Lisp_Symbol
)
3630 /* No property, or nil, means enable.
3631 Otherwise, enable if value is not nil. */
3632 tem
= Fget (def
, Qmenu_enable
);
3634 /* (condition-case nil (eval tem)
3636 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
3640 /* Add an entry for this key and string
3641 if there is none yet. */
3642 tem
= Fassq (key
, result
);
3643 if (!NILP (enabled
) && NILP (tem
))
3644 result
= Fcons (Fcons (key
, Fcons (item_string
, Qnil
)), result
);
3649 /* Read a character using menus based on maps in the array MAPS.
3650 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
3651 Return t if we displayed a menu but the user rejected it.
3653 PREV_EVENT is the previous input event, or nil if we are reading
3654 the first event of a key sequence.
3656 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3657 if we used a mouse menu to read the input, or zero otherwise. If
3658 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
3660 The prompting is done based on the prompt-string of the map
3661 and the strings associated with various map elements.
3663 This can be done with X menus or with menus put in the minibuf.
3664 These are done in different ways, depending on how the input will be read.
3665 Menus using X are done after auto-saving in read-char, getting the input
3666 event from Fx_popup_menu; menus using the minibuf use read_char recursively
3667 and do auto-saving in the inner call of read_char. */
3670 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
3673 Lisp_Object prev_event
;
3674 int *used_mouse_menu
;
3677 register Lisp_Object name
;
3678 Lisp_Object rest
, vector
;
3680 if (used_mouse_menu
)
3681 *used_mouse_menu
= 0;
3683 /* Use local over global Menu maps */
3685 if (! menu_prompting
)
3688 /* Get the menu name from the first map that has one (a prompt string). */
3689 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3691 name
= map_prompt (maps
[mapno
]);
3696 /* If we don't have any menus, just read a character normally. */
3700 #ifdef HAVE_X_WINDOWS
3702 /* If we got to this point via a mouse click,
3703 use a real menu for mouse selection. */
3704 if (EVENT_HAS_PARAMETERS (prev_event
))
3706 /* Display the menu and get the selection. */
3707 Lisp_Object
*realmaps
3708 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
3712 /* Use the maps that are not nil. */
3713 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3714 if (!NILP (maps
[mapno
]))
3715 realmaps
[nmaps1
++] = maps
[mapno
];
3717 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
3720 /* If we got more than one event, put all but the first
3721 onto this list to be read later.
3722 Return just the first event now. */
3723 unread_command_events
3724 = nconc2 (XCONS (value
)->cdr
, unread_command_events
);
3725 value
= XCONS (value
)->car
;
3729 if (used_mouse_menu
)
3730 *used_mouse_menu
= 1;
3733 #endif /* HAVE_X_MENU */
3734 #endif /* HAVE_X_WINDOWS */
3739 read_char_minibuf_menu_prompt(commandflag
, nmaps
, maps
)
3745 register Lisp_Object name
;
3747 int width
= FRAME_WIDTH (selected_frame
) - 4;
3748 char *menu
= (char *) alloca (width
+ 4);
3751 Lisp_Object rest
, vector
;
3753 if (! menu_prompting
)
3756 /* Get the menu name from the first map that has one (a prompt string). */
3757 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3759 name
= map_prompt (maps
[mapno
]);
3764 /* If we don't have any menus, just read a character normally. */
3768 /* Prompt string always starts with map's prompt, and a space. */
3769 strcpy (menu
, XSTRING (name
)->data
);
3770 nlength
= XSTRING (name
)->size
;
3771 menu
[nlength
++] = ':';
3772 menu
[nlength
++] = ' ';
3775 /* Start prompting at start of first map. */
3779 /* Present the documented bindings, a line at a time. */
3786 int orig_defn_macro
;
3788 /* Loop over elements of map. */
3793 /* If reached end of map, start at beginning of next map. */
3797 /* At end of last map, wrap around to first map if just starting,
3798 or end this line if already have something on it. */
3802 if (notfirst
|| nobindings
) break;
3807 /* Look at the next element of the map. */
3809 elt
= XVECTOR (vector
)->contents
[idx
];
3811 elt
= Fcar_safe (rest
);
3813 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
3815 /* If we found a dense table in the keymap,
3816 advanced past it, but start scanning its contents. */
3817 rest
= Fcdr_safe (rest
);
3823 /* An ordinary element. */
3825 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
3827 s
= Fcar_safe(elt
); /* vector */
3828 if (XTYPE (s
) != Lisp_String
)
3829 /* Ignore the element if it has no prompt string. */
3831 /* If we have room for the prompt string, add it to this line.
3832 If this is the first on the line, always add it. */
3833 else if (XSTRING (s
)->size
+ i
+ 2 < width
3838 /* Punctuate between strings. */
3841 strcpy (menu
+ i
, ", ");
3847 /* Add as much of string as fits. */
3848 thiswidth
= XSTRING (s
)->size
;
3849 if (thiswidth
+ i
> width
)
3850 thiswidth
= width
- i
;
3851 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
3857 /* If this element does not fit, end the line now,
3858 and save the element for the next line. */
3859 strcpy (menu
+ i
, "...");
3863 /* Move past this element. */
3864 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
3865 /* Handle reaching end of dense table. */
3870 rest
= Fcdr_safe (rest
);
3874 /* Prompt with that and read response. */
3877 /* Make believe its not a keyboard macro in case the help char
3878 is pressed. Help characters are not recorded because menu prompting
3879 is not used on replay.
3881 orig_defn_macro
= defining_kbd_macro
;
3882 defining_kbd_macro
= 0 ;
3884 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
3885 while (XTYPE (obj
) == Lisp_Buffer
);
3886 defining_kbd_macro
= orig_defn_macro
;
3888 if (XTYPE (obj
) != Lisp_Int
)
3893 if (! EQ (obj
, menu_prompt_more_char
)
3894 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
3895 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
3897 if ( defining_kbd_macro
)
3898 store_kbd_macro_char(obj
) ;
3901 /* Help char - go round again */
3905 /* Reading key sequences. */
3907 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
3908 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
3909 keymap, or nil otherwise. Return the index of the first keymap in
3910 which KEY has any binding, or NMAPS if no map has a binding.
3912 If KEY is a meta ASCII character, treat it like meta-prefix-char
3913 followed by the corresponding non-meta character. Keymaps in
3914 CURRENT with non-prefix bindings for meta-prefix-char become nil in
3917 When KEY is not defined in any of the keymaps, if it is an upper
3918 case letter and there are bindings for the corresponding lower-case
3919 letter, return the bindings for the lower-case letter.
3920 We store 1 in *CASE_CONVERTED in this case.
3921 Otherwise, we don't change *CASE_CONVERTED.
3923 If KEY has no bindings in any of the CURRENT maps, NEXT is left
3926 NEXT may == CURRENT. */
3929 follow_key (key
, nmaps
, current
, defs
, next
, case_converted
)
3931 Lisp_Object
*current
, *defs
, *next
;
3933 int *case_converted
;
3935 int i
, first_binding
;
3937 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
3938 followed by the corresponding non-meta character. */
3939 if (XTYPE (key
) == Lisp_Int
&& (XINT (key
) & CHAR_META
))
3941 for (i
= 0; i
< nmaps
; i
++)
3942 if (! NILP (current
[i
]))
3945 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
3947 /* Note that since we pass the resulting bindings through
3948 get_keymap_1, non-prefix bindings for meta-prefix-char
3950 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
3956 XSET (key
, Lisp_Int
, XFASTINT (key
) & ~CHAR_META
);
3959 first_binding
= nmaps
;
3960 for (i
= nmaps
- 1; i
>= 0; i
--)
3962 if (! NILP (current
[i
]))
3964 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3965 if (! NILP (defs
[i
]))
3972 /* When KEY is not defined in any of the keymaps, if it is an upper
3973 case letter and there are bindings for the corresponding
3974 lower-case letter, return the bindings for the lower-case letter. */
3975 if (first_binding
== nmaps
3976 && XTYPE (key
) == Lisp_Int
3977 && ((((XINT (key
) & 0x3ffff)
3978 < XSTRING (current_buffer
->downcase_table
)->size
)
3979 && UPPERCASEP (XINT (key
) & 0x3ffff))
3980 || (XINT (key
) & shift_modifier
)))
3982 if (XINT (key
) & shift_modifier
)
3983 XSETINT (key
, XINT (key
) & ~shift_modifier
);
3985 XSETINT (key
, (DOWNCASE (XINT (key
) & 0x3ffff)
3986 | (XINT (key
) & ~0x3ffff)));
3988 first_binding
= nmaps
;
3989 for (i
= nmaps
- 1; i
>= 0; i
--)
3991 if (! NILP (current
[i
]))
3993 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3994 if (! NILP (defs
[i
]))
4000 if (first_binding
!= nmaps
)
4001 *case_converted
= 1;
4004 /* Given the set of bindings we've found, produce the next set of maps. */
4005 if (first_binding
< nmaps
)
4006 for (i
= 0; i
< nmaps
; i
++)
4007 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
4009 return first_binding
;
4012 /* Read a sequence of keys that ends with a non prefix character,
4013 storing it in KEYBUF, a buffer of size BUFSIZE.
4015 Return the length of the key sequence stored.
4016 Return -1 if the user rejected a command menu.
4018 Echo starting immediately unless `prompt' is 0.
4020 Where a key sequence ends depends on the currently active keymaps.
4021 These include any minor mode keymaps active in the current buffer,
4022 the current buffer's local map, and the global map.
4024 If a key sequence has no other bindings, we check Vfunction_key_map
4025 to see if some trailing subsequence might be the beginning of a
4026 function key's sequence. If so, we try to read the whole function
4027 key, and substitute its symbolic name into the key sequence.
4029 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
4030 `double-' events into similar click events, if that would make them
4031 bound. We try to turn `triple-' events first into `double-' events,
4034 If we get a mouse click in a mode line, vertical divider, or other
4035 non-text area, we treat the click as if it were prefixed by the
4036 symbol denoting that area - `mode-line', `vertical-line', or
4039 If the sequence starts with a mouse click, we read the key sequence
4040 with respect to the buffer clicked on, not the current buffer.
4042 If the user switches frames in the midst of a key sequence, we put
4043 off the switch-frame event until later; the next call to
4044 read_char will return it. */
4047 read_key_sequence (keybuf
, bufsize
, prompt
)
4048 Lisp_Object
*keybuf
;
4052 int count
= specpdl_ptr
- specpdl
;
4054 /* How many keys there are in the current key sequence. */
4057 /* The length of the echo buffer when we started reading, and
4058 the length of this_command_keys when we started reading. */
4062 /* The number of keymaps we're scanning right now, and the number of
4063 keymaps we have allocated space for. */
4065 int nmaps_allocated
= 0;
4067 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
4068 the current keymaps. */
4071 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
4072 in the current keymaps, or nil where it is not a prefix. */
4073 Lisp_Object
*submaps
;
4075 /* The index in defs[] of the first keymap that has a binding for
4076 this key sequence. In other words, the lowest i such that
4077 defs[i] is non-nil. */
4080 /* If t < mock_input, then KEYBUF[t] should be read as the next
4083 We use this to recover after recognizing a function key. Once we
4084 realize that a suffix of the current key sequence is actually a
4085 function key's escape sequence, we replace the suffix with the
4086 function key's binding from Vfunction_key_map. Now keybuf
4087 contains a new and different key sequence, so the echo area,
4088 this_command_keys, and the submaps and defs arrays are wrong. In
4089 this situation, we set mock_input to t, set t to 0, and jump to
4090 restart_sequence; the loop will read keys from keybuf up until
4091 mock_input, thus rebuilding the state; and then it will resume
4092 reading characters from the keyboard. */
4095 /* If the sequence is unbound in submaps[], then
4096 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
4097 and fkey_map is its binding.
4099 These might be > t, indicating that all function key scanning
4100 should hold off until t reaches them. We do this when we've just
4101 recognized a function key, to avoid searching for the function
4102 key's again in Vfunction_key_map. */
4103 int fkey_start
= 0, fkey_end
= 0;
4104 Lisp_Object fkey_map
;
4106 /* Likewise, for key_translation_map. */
4107 int keytran_start
= 0, keytran_end
= 0;
4108 Lisp_Object keytran_map
;
4110 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
4111 we put it off for later. While we're reading, we keep the event here. */
4112 Lisp_Object delayed_switch_frame
;
4114 /* See the comment below... */
4115 #if defined (GOBBLE_FIRST_EVENT)
4116 Lisp_Object first_event
;
4119 struct buffer
*starting_buffer
;
4121 /* Nonzero if we found the binding for one of the chars
4122 in this key sequence by downcasing it. */
4123 int case_converted
= 0;
4125 /* Nonzero if we seem to have got the beginning of a binding
4126 in function_key_map. */
4127 int function_key_possible
= 0;
4131 last_nonmenu_event
= Qnil
;
4133 delayed_switch_frame
= Qnil
;
4134 fkey_map
= Vfunction_key_map
;
4135 keytran_map
= Vkey_translation_map
;
4137 /* If there is no function-key-map, turn off function key scanning. */
4138 if (NILP (Fkeymapp (Vfunction_key_map
)))
4139 fkey_start
= fkey_end
= bufsize
+ 1;
4141 /* If there is no key-translation-map, turn off scanning. */
4142 if (NILP (Fkeymapp (Vkey_translation_map
)))
4143 keytran_start
= keytran_end
= bufsize
+ 1;
4148 echo_prompt (XSTRING (prompt
)->data
);
4149 else if (cursor_in_echo_area
)
4150 /* This doesn't put in a dash if the echo buffer is empty, so
4151 you don't always see a dash hanging out in the minibuffer. */
4155 /* Record the initial state of the echo area and this_command_keys;
4156 we will need to restore them if we replay a key sequence. */
4158 echo_start
= echo_length ();
4159 keys_start
= this_command_key_count
;
4161 #if defined (GOBBLE_FIRST_EVENT)
4162 /* This doesn't quite work, because some of the things that read_char
4163 does cannot safely be bypassed. It seems too risky to try to make
4166 /* Read the first char of the sequence specially, before setting
4167 up any keymaps, in case a filter runs and switches buffers on us. */
4168 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
4170 #endif /* GOBBLE_FIRST_EVENT */
4172 /* We jump here when the key sequence has been thoroughly changed, and
4173 we need to rescan it starting from the beginning. When we jump here,
4174 keybuf[0..mock_input] holds the sequence we should reread. */
4177 starting_buffer
= current_buffer
;
4179 function_key_possible
= 0;
4181 /* Build our list of keymaps.
4182 If we recognize a function key and replace its escape sequence in
4183 keybuf with its symbol, or if the sequence starts with a mouse
4184 click and we need to switch buffers, we jump back here to rebuild
4185 the initial keymaps from the current buffer. */
4189 if (!NILP (Voverriding_local_map
))
4192 if (nmaps
> nmaps_allocated
)
4194 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4195 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4196 nmaps_allocated
= nmaps
;
4198 submaps
[0] = Voverriding_local_map
;
4202 nmaps
= current_minor_maps (0, &maps
) + 2;
4203 if (nmaps
> nmaps_allocated
)
4205 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4206 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4207 nmaps_allocated
= nmaps
;
4209 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
4210 #ifdef USE_TEXT_PROPERTIES
4211 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
4213 submaps
[nmaps
-2] = current_buffer
->keymap
;
4216 submaps
[nmaps
-1] = current_global_map
;
4219 /* Find an accurate initial value for first_binding. */
4220 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
4221 if (! NILP (submaps
[first_binding
]))
4224 /* Start from the beginning in keybuf. */
4227 /* These are no-ops the first time through, but if we restart, they
4228 revert the echo area and this_command_keys to their original state. */
4229 this_command_key_count
= keys_start
;
4230 if (INTERACTIVE
&& t
< mock_input
)
4231 echo_truncate (echo_start
);
4233 /* If the best binding for the current key sequence is a keymap, or
4234 we may be looking at a function key's escape sequence, keep on
4236 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
4237 || (first_binding
>= nmaps
4239 /* mock input is never part of a function key's sequence. */
4240 && mock_input
<= fkey_start
)
4241 || (first_binding
>= nmaps
4242 && keytran_start
< t
4243 /* mock input is never part of a function key's sequence. */
4244 && mock_input
<= keytran_start
)
4245 /* Don't return in the middle of a possible function key sequence,
4246 if the only bindings we found were via case conversion.
4247 Thus, if ESC O a has a function-key-map translation
4248 and ESC o has a binding, don't return after ESC O,
4249 so that we can translate ESC O plus the next character. */
4250 || (function_key_possible
&& case_converted
))
4253 int used_mouse_menu
= 0;
4255 /* Where the last real key started. If we need to throw away a
4256 key that has expanded into more than one element of keybuf
4257 (say, a mouse click on the mode line which is being treated
4258 as [mode-line (mouse-...)], then we backtrack to this point
4260 int last_real_key_start
;
4262 /* These variables are analogous to echo_start and keys_start;
4263 while those allow us to restart the entire key sequence,
4264 echo_local_start and keys_local_start allow us to throw away
4266 int echo_local_start
, keys_local_start
, local_first_binding
;
4269 error ("key sequence too long");
4272 echo_local_start
= echo_length ();
4273 keys_local_start
= this_command_key_count
;
4274 local_first_binding
= first_binding
;
4277 /* These are no-ops, unless we throw away a keystroke below and
4278 jumped back up to replay_key; in that case, these restore the
4279 variables to their original state, allowing us to replay the
4281 if (INTERACTIVE
&& t
< mock_input
)
4282 echo_truncate (echo_local_start
);
4283 this_command_key_count
= keys_local_start
;
4284 first_binding
= local_first_binding
;
4286 /* By default, assume each event is "real". */
4287 last_real_key_start
= t
;
4289 /* Does mock_input indicate that we are re-reading a key sequence? */
4293 add_command_key (key
);
4297 /* If not, we should actually read a character. */
4300 struct buffer
*buf
= current_buffer
;
4302 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
4305 /* read_char returns t when it shows a menu and the user rejects it.
4310 /* read_char returns -1 at the end of a macro.
4311 Emacs 18 handles this by returning immediately with a
4312 zero, so that's what we'll do. */
4313 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) == -1)
4319 /* If the current buffer has been changed from under us, the
4320 keymap may have changed, so replay the sequence. */
4321 if (XTYPE (key
) == Lisp_Buffer
)
4324 goto replay_sequence
;
4327 /* If we have a quit that was typed in another frame, and
4328 quit_throw_to_read_char switched buffers,
4329 replay to get the right keymap. */
4330 if (EQ (key
, quit_char
) && current_buffer
!= starting_buffer
)
4335 goto replay_sequence
;
4341 /* Clicks in non-text areas get prefixed by the symbol
4342 in their CHAR-ADDRESS field. For example, a click on
4343 the mode line is prefixed by the symbol `mode-line'.
4345 Furthermore, key sequences beginning with mouse clicks
4346 are read using the keymaps of the buffer clicked on, not
4347 the current buffer. So we may have to switch the buffer
4350 When we turn one event into two events, we must make sure
4351 that neither of the two looks like the original--so that,
4352 if we replay the events, they won't be expanded again.
4353 If not for this, such reexpansion could happen either here
4354 or when user programs play with this-command-keys. */
4355 if (EVENT_HAS_PARAMETERS (key
))
4357 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
4359 if (EQ (kind
, Qmouse_click
))
4361 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
4362 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4364 if (XTYPE (posn
) == Lisp_Cons
)
4366 /* We're looking at the second event of a
4367 sequence which we expanded before. Set
4368 last_real_key_start appropriately. */
4370 last_real_key_start
= t
- 1;
4373 /* Key sequences beginning with mouse clicks are
4374 read using the keymaps in the buffer clicked on,
4375 not the current buffer. If we're at the
4376 beginning of a key sequence, switch buffers. */
4377 if (last_real_key_start
== 0
4378 && XTYPE (window
) == Lisp_Window
4379 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
4380 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
4385 /* Arrange to go back to the original buffer once we're
4386 done reading the key sequence. Note that we can't
4387 use save_excursion_{save,restore} here, because they
4388 save point as well as the current buffer; we don't
4389 want to save point, because redisplay may change it,
4390 to accommodate a Fset_window_start or something. We
4391 don't want to do this at the top of the function,
4392 because we may get input from a subprocess which
4393 wants to change the selected window and stuff (say,
4395 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
4397 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
4398 goto replay_sequence
;
4400 else if (XTYPE (posn
) == Lisp_Symbol
)
4402 /* Expand mode-line and scroll-bar events into two events:
4403 use posn as a fake prefix key. */
4405 if (t
+ 1 >= bufsize
)
4406 error ("key sequence too long");
4411 /* Zap the position in key, so we know that we've
4412 expanded it, and don't try to do so again. */
4413 POSN_BUFFER_POSN (EVENT_START (key
))
4414 = Fcons (posn
, Qnil
);
4418 else if (EQ (kind
, Qswitch_frame
))
4420 /* If we're at the beginning of a key sequence, go
4421 ahead and return this event. If we're in the
4422 midst of a key sequence, delay it until the end. */
4425 delayed_switch_frame
= key
;
4431 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4433 /* Handle menu-bar events:
4434 insert the dummy prefix event `menu-bar'. */
4435 if (EQ (posn
, Qmenu_bar
))
4437 if (t
+ 1 >= bufsize
)
4438 error ("key sequence too long");
4439 /* Run the Lucid hook. */
4440 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4441 /* If it has changed current-menubar from previous value,
4442 really recompute the menubar from the value. */
4443 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4444 call0 (Qrecompute_lucid_menubar
);
4448 /* Zap the position in key, so we know that we've
4449 expanded it, and don't try to do so again. */
4450 POSN_BUFFER_POSN (EVENT_START (key
))
4451 = Fcons (posn
, Qnil
);
4454 goto replay_sequence
;
4456 else if (XTYPE (posn
) == Lisp_Cons
)
4458 /* We're looking at the second event of a
4459 sequence which we expanded before. Set
4460 last_real_key_start appropriately. */
4461 if (last_real_key_start
== t
&& t
> 0)
4462 last_real_key_start
= t
- 1;
4467 /* We have finally decided that KEY is something we might want
4469 first_binding
= (follow_key (key
,
4470 nmaps
- first_binding
,
4471 submaps
+ first_binding
,
4472 defs
+ first_binding
,
4473 submaps
+ first_binding
,
4477 /* If KEY wasn't bound, we'll try some fallbacks. */
4478 if (first_binding
>= nmaps
)
4480 Lisp_Object head
= EVENT_HEAD (key
);
4482 if (EQ (head
, Vhelp_char
))
4484 read_key_sequence_cmd
= Vprefix_help_command
;
4486 last_nonmenu_event
= key
;
4490 if (XTYPE (head
) == Lisp_Symbol
)
4492 Lisp_Object breakdown
= parse_modifiers (head
);
4493 int modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4495 /* Attempt to reduce an unbound mouse event to a simpler
4496 event that is bound:
4497 Drags reduce to clicks.
4498 Double-clicks reduce to clicks.
4499 Triple-clicks reduce to double-clicks, then to clicks.
4500 Down-clicks are eliminated.
4501 Double-downs reduce to downs, then are eliminated.
4502 Triple-downs reduce to double-downs, then to downs,
4503 then are eliminated. */
4504 if (modifiers
& (down_modifier
| drag_modifier
4505 | double_modifier
| triple_modifier
))
4507 while (modifiers
& (down_modifier
| drag_modifier
4508 | double_modifier
| triple_modifier
))
4510 Lisp_Object new_head
, new_click
;
4511 if (modifiers
& triple_modifier
)
4512 modifiers
^= (double_modifier
| triple_modifier
);
4513 else if (modifiers
& (drag_modifier
| double_modifier
))
4514 modifiers
&= ~(drag_modifier
| double_modifier
);
4517 /* Dispose of this `down' event by simply jumping
4518 back to replay_key, to get another event.
4520 Note that if this event came from mock input,
4521 then just jumping back to replay_key will just
4522 hand it to us again. So we have to wipe out any
4525 We could delete keybuf[t] and shift everything
4526 after that to the left by one spot, but we'd also
4527 have to fix up any variable that points into
4528 keybuf, and shifting isn't really necessary
4531 Adding prefixes for non-textual mouse clicks
4532 creates two characters of mock input, and both
4533 must be thrown away. If we're only looking at
4534 the prefix now, we can just jump back to
4535 replay_key. On the other hand, if we've already
4536 processed the prefix, and now the actual click
4537 itself is giving us trouble, then we've lost the
4538 state of the keymaps we want to backtrack to, and
4539 we need to replay the whole sequence to rebuild
4542 Beyond that, only function key expansion could
4543 create more than two keys, but that should never
4544 generate mouse events, so it's okay to zero
4545 mock_input in that case too.
4547 Isn't this just the most wonderful code ever? */
4548 if (t
== last_real_key_start
)
4555 mock_input
= last_real_key_start
;
4556 goto replay_sequence
;
4561 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
4563 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
4565 /* Look for a binding for this new key. follow_key
4566 promises that it didn't munge submaps the
4567 last time we called it, since key was unbound. */
4569 = (follow_key (new_click
,
4570 nmaps
- local_first_binding
,
4571 submaps
+ local_first_binding
,
4572 defs
+ local_first_binding
,
4573 submaps
+ local_first_binding
,
4575 + local_first_binding
);
4577 /* If that click is bound, go for it. */
4578 if (first_binding
< nmaps
)
4583 /* Otherwise, we'll leave key set to the drag event. */
4590 /* Normally, last_nonmenu_event gets the previous key we read.
4591 But when a mouse popup menu is being used,
4592 we don't update last_nonmenu_event; it continues to hold the mouse
4593 event that preceded the first level of menu. */
4594 if (!used_mouse_menu
)
4595 last_nonmenu_event
= key
;
4597 /* If the sequence is unbound, see if we can hang a function key
4598 off the end of it. We only want to scan real keyboard input
4599 for function key sequences, so if mock_input says that we're
4600 re-reading old events, don't examine it. */
4601 if ((first_binding
>= nmaps
|| case_converted
)
4604 Lisp_Object fkey_next
;
4606 /* Continue scan from fkey_end until we find a bound suffix.
4607 If we fail, increment fkey_start
4608 and start fkey_end from there. */
4609 while (fkey_end
< t
)
4613 key
= keybuf
[fkey_end
++];
4614 /* Look up meta-characters by prefixing them
4615 with meta_prefix_char. I hate this. */
4616 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4621 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
4623 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4626 fkey_next
= fkey_map
;
4629 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
4631 /* If the function key map gives a function, not an
4632 array, then call the function with no args and use
4633 its value instead. */
4634 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
4637 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4641 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4642 fkey_next
= call1 (fkey_next
, prompt
);
4644 /* If the function returned something invalid,
4645 barf--don't ignore it.
4646 (To ignore it safely, we would need to gcpro a bunch of
4647 other variables.) */
4648 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
4649 error ("Function in function-key-map returns invalid key sequence");
4652 function_key_possible
= ! NILP (fkey_next
);
4654 /* If keybuf[fkey_start..fkey_end] is bound in the
4655 function key map and it's a suffix of the current
4656 sequence (i.e. fkey_end == t), replace it with
4657 the binding and restart with fkey_start at the end. */
4658 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
4661 int len
= XFASTINT (Flength (fkey_next
));
4663 t
= fkey_start
+ len
;
4665 error ("key sequence too long");
4667 if (VECTORP (fkey_next
))
4668 bcopy (XVECTOR (fkey_next
)->contents
,
4669 keybuf
+ fkey_start
,
4670 (t
- fkey_start
) * sizeof (keybuf
[0]));
4671 else if (STRINGP (fkey_next
))
4675 for (i
= 0; i
< len
; i
++)
4676 XFASTINT (keybuf
[fkey_start
+ i
])
4677 = XSTRING (fkey_next
)->data
[i
];
4681 fkey_start
= fkey_end
= t
;
4682 fkey_map
= Vfunction_key_map
;
4684 goto replay_sequence
;
4687 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
4689 /* If we no longer have a bound suffix, try a new positions for
4691 if (NILP (fkey_map
))
4693 fkey_end
= ++fkey_start
;
4694 fkey_map
= Vfunction_key_map
;
4695 function_key_possible
= 0;
4700 /* Look for this sequence in key-translation-map. */
4702 Lisp_Object keytran_next
;
4704 /* Scan from keytran_end until we find a bound suffix. */
4705 while (keytran_end
< t
)
4709 key
= keybuf
[keytran_end
++];
4710 /* Look up meta-characters by prefixing them
4711 with meta_prefix_char. I hate this. */
4712 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4717 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
4719 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4722 keytran_next
= keytran_map
;
4725 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
4727 /* If the key translation map gives a function, not an
4728 array, then call the function with no args and use
4729 its value instead. */
4730 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
4731 && keytran_end
== t
)
4733 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4737 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4738 keytran_next
= call1 (keytran_next
, prompt
);
4740 /* If the function returned something invalid,
4741 barf--don't ignore it.
4742 (To ignore it safely, we would need to gcpro a bunch of
4743 other variables.) */
4744 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
4745 error ("Function in key-translation-map returns invalid key sequence");
4748 /* If keybuf[keytran_start..keytran_end] is bound in the
4749 key translation map and it's a suffix of the current
4750 sequence (i.e. keytran_end == t), replace it with
4751 the binding and restart with keytran_start at the end. */
4752 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
4753 && keytran_end
== t
)
4755 int len
= XFASTINT (Flength (keytran_next
));
4757 t
= keytran_start
+ len
;
4759 error ("key sequence too long");
4761 if (VECTORP (keytran_next
))
4762 bcopy (XVECTOR (keytran_next
)->contents
,
4763 keybuf
+ keytran_start
,
4764 (t
- keytran_start
) * sizeof (keybuf
[0]));
4765 else if (STRINGP (keytran_next
))
4769 for (i
= 0; i
< len
; i
++)
4770 XFASTINT (keybuf
[keytran_start
+ i
])
4771 = XSTRING (keytran_next
)->data
[i
];
4775 keytran_start
= keytran_end
= t
;
4776 keytran_map
= Vkey_translation_map
;
4778 goto replay_sequence
;
4781 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
4783 /* If we no longer have a bound suffix, try a new positions for
4785 if (NILP (keytran_map
))
4787 keytran_end
= ++keytran_start
;
4788 keytran_map
= Vkey_translation_map
;
4794 read_key_sequence_cmd
= (first_binding
< nmaps
4795 ? defs
[first_binding
]
4799 unread_switch_frame
= delayed_switch_frame
;
4800 unbind_to (count
, Qnil
);
4802 /* Occasionally we fabricate events, perhaps by expanding something
4803 according to function-key-map, or by adding a prefix symbol to a
4804 mouse click in the scroll bar or modeline. In this cases, return
4805 the entire generated key sequence, even if we hit an unbound
4806 prefix or a definition before the end. This means that you will
4807 be able to push back the event properly, and also means that
4808 read-key-sequence will always return a logical unit.
4811 for (; t
< mock_input
; t
++)
4813 echo_char (keybuf
[t
]);
4814 add_command_key (keybuf
[t
]);
4820 #if 0 /* This doc string is too long for some compilers.
4821 This commented-out definition serves for DOC. */
4822 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4823 "Read a sequence of keystrokes and return as a string or vector.\n\
4824 The sequence is sufficient to specify a non-prefix command in the\n\
4825 current local and global maps.\n\
4827 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
4828 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
4829 as a continuation of the previous key.\n\
4831 A C-g typed while in this function is treated like any other character,\n\
4832 and `quit-flag' is not set.\n\
4834 If the key sequence starts with a mouse click, then the sequence is read\n\
4835 using the keymaps of the buffer of the window clicked in, not the buffer\n\
4836 of the selected window as normal.\n\
4838 `read-key-sequence' drops unbound button-down events, since you normally\n\
4839 only care about the click or drag events which follow them. If a drag\n\
4840 or multi-click event is unbound, but the corresponding click event would\n\
4841 be bound, `read-key-sequence' turns the event into a click event at the\n\
4842 drag's starting position. This means that you don't have to distinguish\n\
4843 between click and drag, double, or triple events unless you want to.\n\
4845 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
4846 lines separating windows, and scroll bars with imaginary keys\n\
4847 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
4849 If the user switches frames in the middle of a key sequence, the\n\
4850 frame-switch event is put off until after the current key sequence.\n\
4852 `read-key-sequence' checks `function-key-map' for function key\n\
4853 sequences, where they wouldn't conflict with ordinary bindings. See\n\
4854 `function-key-map' for more details.")
4855 (prompt
, continue_echo
)
4858 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4860 (prompt
, continue_echo
)
4861 Lisp_Object prompt
, continue_echo
;
4863 Lisp_Object keybuf
[30];
4865 struct gcpro gcpro1
, gcpro2
;
4868 CHECK_STRING (prompt
, 0);
4871 bzero (keybuf
, sizeof keybuf
);
4873 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
4875 if (NILP (continue_echo
))
4876 this_command_key_count
= 0;
4878 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])), prompt
);
4886 return make_event_array (i
, keybuf
);
4889 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
4890 "Execute CMD as an editor command.\n\
4891 CMD must be a symbol that satisfies the `commandp' predicate.\n\
4892 Optional second arg RECORD-FLAG non-nil\n\
4893 means unconditionally put this command in `command-history'.\n\
4894 Otherwise, that is done only if an arg is read using the minibuffer.")
4896 Lisp_Object cmd
, record
;
4898 register Lisp_Object final
;
4899 register Lisp_Object tem
;
4900 Lisp_Object prefixarg
;
4901 struct backtrace backtrace
;
4902 extern int debug_on_next_call
;
4904 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
4905 Vcurrent_prefix_arg
= prefixarg
;
4906 debug_on_next_call
= 0;
4908 if (XTYPE (cmd
) == Lisp_Symbol
)
4910 tem
= Fget (cmd
, Qdisabled
);
4912 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
4917 final
= Findirect_function (cmd
);
4919 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
4920 do_autoload (final
, cmd
);
4925 if (XTYPE (final
) == Lisp_String
4926 || XTYPE (final
) == Lisp_Vector
)
4928 /* If requested, place the macro in the command history. For
4929 other sorts of commands, call-interactively takes care of
4933 = Fcons (Fcons (Qexecute_kbd_macro
,
4934 Fcons (final
, Fcons (prefixarg
, Qnil
))),
4937 return Fexecute_kbd_macro (final
, prefixarg
);
4939 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
4940 || XTYPE (final
) == Lisp_Compiled
)
4942 backtrace
.next
= backtrace_list
;
4943 backtrace_list
= &backtrace
;
4944 backtrace
.function
= &Qcall_interactively
;
4945 backtrace
.args
= &cmd
;
4946 backtrace
.nargs
= 1;
4947 backtrace
.evalargs
= 0;
4949 tem
= Fcall_interactively (cmd
, record
);
4951 backtrace_list
= backtrace
.next
;
4957 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
4959 "Read function name, then read its arguments and call it.")
4961 Lisp_Object prefixarg
;
4963 Lisp_Object function
;
4965 Lisp_Object saved_keys
;
4966 struct gcpro gcpro1
;
4968 saved_keys
= Fvector (this_command_key_count
,
4969 XVECTOR (this_command_keys
)->contents
);
4971 GCPRO1 (saved_keys
);
4973 if (EQ (prefixarg
, Qminus
))
4975 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
4976 strcpy (buf
, "C-u ");
4977 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
4978 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
4979 else if (XTYPE (prefixarg
) == Lisp_Int
)
4980 sprintf (buf
, "%d ", XINT (prefixarg
));
4982 /* This isn't strictly correct if execute-extended-command
4983 is bound to anything else. Perhaps it should use
4984 this_command_keys? */
4985 strcat (buf
, "M-x ");
4987 /* Prompt with buf, and then read a string, completing from and
4988 restricting to the set of all defined commands. Don't provide
4989 any initial input. Save the command read on the extended-command
4991 function
= Fcompleting_read (build_string (buf
),
4992 Vobarray
, Qcommandp
,
4993 Qt
, Qnil
, Qextended_command_history
);
4995 /* Set this_command_keys to the concatenation of saved_keys and
4996 function, followed by a RET. */
4998 struct Lisp_String
*str
;
5003 this_command_key_count
= 0;
5005 keys
= XVECTOR (saved_keys
)->contents
;
5006 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
5007 add_command_key (keys
[i
]);
5009 str
= XSTRING (function
);
5010 for (i
= 0; i
< str
->size
; i
++)
5012 XFASTINT (tem
) = str
->data
[i
];
5013 add_command_key (tem
);
5016 XFASTINT (tem
) = '\015';
5017 add_command_key (tem
);
5022 function
= Fintern (function
, Qnil
);
5023 Vprefix_arg
= prefixarg
;
5024 this_command
= function
;
5026 return Fcommand_execute (function
, Qt
);
5030 detect_input_pending ()
5033 get_input_pending (&input_pending
);
5035 return input_pending
;
5038 /* This is called in some cases before a possible quit.
5039 It cases the next call to detect_input_pending to recompute input_pending.
5040 So calling this function unnecessarily can't do any harm. */
5041 clear_input_pending ()
5046 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
5047 "T if command input is currently available with no waiting.\n\
5048 Actually, the value is nil only if we can be sure that no input is available.")
5051 if (!NILP (unread_command_events
) || unread_command_char
!= -1)
5054 return detect_input_pending () ? Qt
: Qnil
;
5057 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
5058 "Return vector of last 100 events, not counting those from keyboard macros.")
5061 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
5064 if (total_keys
< NUM_RECENT_KEYS
)
5065 return Fvector (total_keys
, keys
);
5068 val
= Fvector (NUM_RECENT_KEYS
, keys
);
5069 bcopy (keys
+ recent_keys_index
,
5070 XVECTOR (val
)->contents
,
5071 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
5073 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
5074 recent_keys_index
* sizeof (Lisp_Object
));
5079 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
5080 "Return the key sequence that invoked this command.\n\
5081 The value is a string or a vector.")
5084 return make_event_array (this_command_key_count
,
5085 XVECTOR (this_command_keys
)->contents
);
5088 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
5089 "Return the current depth in recursive edits.")
5093 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
5097 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
5098 "FOpen dribble file: ",
5099 "Start writing all keyboard characters to a dribble file called FILE.\n\
5100 If FILE is nil, close any open dribble file.")
5111 file
= Fexpand_file_name (file
, Qnil
);
5112 dribble
= fopen (XSTRING (file
)->data
, "w");
5117 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
5118 "Discard the contents of the terminal input buffer.\n\
5119 Also cancel any kbd macro being defined.")
5122 defining_kbd_macro
= 0;
5123 update_mode_lines
++;
5125 unread_command_events
= Qnil
;
5126 unread_command_char
= -1;
5128 discard_tty_input ();
5130 /* Without the cast, GCC complains that this assignment loses the
5131 volatile qualifier of kbd_store_ptr. Is there anything wrong
5133 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
5134 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5140 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
5141 "Stop Emacs and return to superior process. You can resume later.\n\
5142 On systems that don't have job control, run a subshell instead.\n\n\
5143 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
5144 to be read as terminal input by Emacs's parent, after suspension.\n\
5146 Before suspending, call the functions in `suspend-hook' with no args.\n\
5147 If any of them returns nil, don't call the rest and don't suspend.\n\
5148 Otherwise, suspend normally and after resumption run the normal hook\n\
5149 `suspend-resume-hook' if that is bound and non-nil.\n\
5151 Some operating systems cannot stop the Emacs process and resume it later.\n\
5152 On such systems, Emacs starts a subshell instead of suspending.")
5154 Lisp_Object stuffstring
;
5157 int count
= specpdl_ptr
- specpdl
;
5158 int old_height
, old_width
;
5160 struct gcpro gcpro1
, gcpro2
;
5161 extern init_sys_modes ();
5163 if (!NILP (stuffstring
))
5164 CHECK_STRING (stuffstring
, 0);
5166 /* Run the functions in suspend-hook. */
5167 if (!NILP (Vrun_hooks
))
5168 call1 (Vrun_hooks
, intern ("suspend-hook"));
5170 GCPRO1 (stuffstring
);
5171 get_frame_size (&old_width
, &old_height
);
5173 /* sys_suspend can get an error if it tries to fork a subshell
5174 and the system resources aren't available for that. */
5175 record_unwind_protect (init_sys_modes
, 0);
5176 stuff_buffered_input (stuffstring
);
5178 unbind_to (count
, Qnil
);
5180 /* Check if terminal/window size has changed.
5181 Note that this is not useful when we are running directly
5182 with a window system; but suspend should be disabled in that case. */
5183 get_frame_size (&width
, &height
);
5184 if (width
!= old_width
|| height
!= old_height
)
5185 change_frame_size (selected_frame
, height
, width
, 0, 0);
5187 /* Run suspend-resume-hook. */
5188 if (!NILP (Vrun_hooks
))
5189 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
5195 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
5196 Then in any case stuff anything Emacs has read ahead and not used. */
5198 stuff_buffered_input (stuffstring
)
5199 Lisp_Object stuffstring
;
5201 register unsigned char *p
;
5203 /* stuff_char works only in BSD, versions 4.2 and up. */
5206 if (XTYPE (stuffstring
) == Lisp_String
)
5210 p
= XSTRING (stuffstring
)->data
;
5211 count
= XSTRING (stuffstring
)->size
;
5216 /* Anything we have read ahead, put back for the shell to read. */
5217 while (kbd_fetch_ptr
!= kbd_store_ptr
)
5219 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
5220 kbd_fetch_ptr
= kbd_buffer
;
5221 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
5222 stuff_char (kbd_fetch_ptr
->code
);
5223 kbd_fetch_ptr
->kind
= no_event
;
5224 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
5231 #endif /* BSD and not BSD4_1 */
5234 set_waiting_for_input (time_to_clear
)
5235 EMACS_TIME
*time_to_clear
;
5237 input_available_clear_time
= time_to_clear
;
5239 /* Tell interrupt_signal to throw back to read_char, */
5240 waiting_for_input
= 1;
5242 /* If interrupt_signal was called before and buffered a C-g,
5243 make it run again now, to avoid timing error. */
5244 if (!NILP (Vquit_flag
))
5245 quit_throw_to_read_char ();
5248 clear_waiting_for_input ()
5250 /* Tell interrupt_signal not to throw back to read_char, */
5251 waiting_for_input
= 0;
5252 input_available_clear_time
= 0;
5255 /* This routine is called at interrupt level in response to C-G.
5256 If interrupt_input, this is the handler for SIGINT.
5257 Otherwise, it is called from kbd_buffer_store_event,
5258 in handling SIGIO or SIGTINT.
5260 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
5261 immediately throw back to read_char.
5263 Otherwise it sets the Lisp variable quit-flag not-nil.
5264 This causes eval to throw, when it gets a chance.
5265 If quit-flag is already non-nil, it stops the job right away. */
5271 /* Must preserve main program's value of errno. */
5272 int old_errno
= errno
;
5275 /* USG systems forget handlers when they are used;
5276 must reestablish each time */
5277 signal (SIGINT
, interrupt_signal
);
5278 signal (SIGQUIT
, interrupt_signal
);
5283 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
5288 #ifdef SIGTSTP /* Support possible in later USG versions */
5290 * On systems which can suspend the current process and return to the original
5291 * shell, this command causes the user to end up back at the shell.
5292 * The "Auto-save" and "Abort" questions are not asked until
5293 * the user elects to return to emacs, at which point he can save the current
5294 * job and either dump core or continue.
5299 if (sys_suspend () == -1)
5301 printf ("Not running as a subprocess;\n");
5302 printf ("you can continue or abort.\n");
5305 /* Perhaps should really fork an inferior shell?
5306 But that would not provide any way to get back
5307 to the original shell, ever. */
5308 printf ("No support for stopping a process on this operating system;\n");
5309 printf ("you can continue or abort.\n");
5310 #endif /* not VMS */
5311 #endif /* not SIGTSTP */
5313 /* We must remain inside the screen area when the internal terminal
5314 is used. Note that [Enter] is not echoed by dos. */
5317 printf ("Auto-save? (y or n) ");
5319 if (((c
= getchar ()) & ~040) == 'Y')
5321 Fdo_auto_save (Qt
, Qnil
);
5323 printf ("\r\nAuto-save done");
5324 #else /* not MSDOS */
5325 printf ("Auto-save done\n");
5326 #endif /* not MSDOS */
5328 while (c
!= '\n') c
= getchar ();
5330 printf ("\r\nAbort? (y or n) ");
5331 #else /* not MSDOS */
5333 printf ("Abort (and enter debugger)? (y or n) ");
5335 printf ("Abort (and dump core)? (y or n) ");
5336 #endif /* not VMS */
5337 #endif /* not MSDOS */
5339 if (((c
= getchar ()) & ~040) == 'Y')
5341 while (c
!= '\n') c
= getchar ();
5343 printf ("\r\nContinuing...\r\n");
5344 #else /* not MSDOS */
5345 printf ("Continuing...\n");
5346 #endif /* not MSDOS */
5352 /* If executing a function that wants to be interrupted out of
5353 and the user has not deferred quitting by binding `inhibit-quit'
5354 then quit right away. */
5355 if (immediate_quit
&& NILP (Vinhibit_quit
))
5359 Fsignal (Qquit
, Qnil
);
5362 /* Else request quit when it's safe */
5366 if (waiting_for_input
&& !echoing
)
5367 quit_throw_to_read_char ();
5372 /* Handle a C-g by making read_char return C-g. */
5374 quit_throw_to_read_char ()
5376 quit_error_check ();
5378 /* Prevent another signal from doing this before we finish. */
5379 clear_waiting_for_input ();
5382 unread_command_events
= Qnil
;
5383 unread_command_char
= -1;
5385 #ifdef POLL_FOR_INPUT
5386 /* May be > 1 if in recursive minibuffer. */
5387 if (poll_suppress_count
== 0)
5391 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
5392 && XFRAME (internal_last_event_frame
) != selected_frame
)
5393 Fhandle_switch_frame (make_lispy_switch_frame (internal_last_event_frame
));
5396 _longjmp (getcjmp
, 1);
5399 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
5400 "Set mode of reading keyboard input.\n\
5401 First arg INTERRUPT non-nil means use input interrupts;\n\
5402 nil means use CBREAK mode.\n\
5403 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
5404 (no effect except in CBREAK mode).\n\
5405 Third arg META t means accept 8-bit input (for a Meta key).\n\
5406 META nil means ignore the top bit, on the assumption it is parity.\n\
5407 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
5408 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
5409 See also `current-input-mode'.")
5410 (interrupt
, flow
, meta
, quit
)
5411 Lisp_Object interrupt
, flow
, meta
, quit
;
5414 && (XTYPE (quit
) != Lisp_Int
5415 || XINT (quit
) < 0 || XINT (quit
) > 0400))
5416 error ("set-input-mode: QUIT must be an ASCII character");
5418 #ifdef POLL_FOR_INPUT
5424 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5425 #ifdef NO_SOCK_SIGIO
5426 if (read_socket_hook
)
5427 interrupt_input
= 0; /* No interrupts if reading from a socket. */
5429 #endif /* NO_SOCK_SIGIO */
5430 interrupt_input
= !NILP (interrupt
);
5431 #else /* not SIGIO */
5432 interrupt_input
= 0;
5433 #endif /* not SIGIO */
5434 /* Our VMS input only works by interrupts, as of now. */
5436 interrupt_input
= 1;
5438 flow_control
= !NILP (flow
);
5441 else if (EQ (meta
, Qt
))
5446 /* Don't let this value be out of range. */
5447 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
5451 #ifdef POLL_FOR_INPUT
5452 poll_suppress_count
= 1;
5458 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
5459 "Return information about the way Emacs currently reads keyboard input.\n\
5460 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
5461 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
5462 nil, Emacs is using CBREAK mode.\n\
5463 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
5464 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
5465 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
5466 META nil means ignoring the top bit, on the assumption it is parity.\n\
5467 META is neither t nor nil if accepting 8-bit input and using\n\
5468 all 8 bits as the character code.\n\
5469 QUIT is the character Emacs currently uses to quit.\n\
5470 The elements of this list correspond to the arguments of\n\
5476 val
[0] = interrupt_input
? Qt
: Qnil
;
5477 val
[1] = flow_control
? Qt
: Qnil
;
5478 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
5479 XFASTINT (val
[3]) = quit_char
;
5481 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
5487 /* This is correct before outermost invocation of the editor loop */
5488 command_loop_level
= -1;
5490 quit_char
= Ctl ('g');
5491 unread_command_events
= Qnil
;
5492 unread_command_char
= -1;
5494 recent_keys_index
= 0;
5495 kbd_fetch_ptr
= kbd_buffer
;
5496 kbd_store_ptr
= kbd_buffer
;
5497 do_mouse_tracking
= 0;
5501 /* This means that command_loop_1 won't try to select anything the first
5503 internal_last_event_frame
= Qnil
;
5504 Vlast_event_frame
= internal_last_event_frame
;
5507 /* If we're running a dumped Emacs, we need to clear out
5508 kbd_buffer_frame_or_window, in case some events got into it
5511 If we're running an undumped Emacs, it hasn't been initialized by
5512 syms_of_keyboard yet. */
5514 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5516 if (!noninteractive
)
5518 signal (SIGINT
, interrupt_signal
);
5519 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
5520 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
5521 SIGQUIT and we can't tell which one it will give us. */
5522 signal (SIGQUIT
, interrupt_signal
);
5523 #endif /* HAVE_TERMIO */
5524 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5526 signal (SIGIO
, input_available_signal
);
5530 /* Use interrupt input by default, if it works and noninterrupt input
5531 has deficiencies. */
5533 #ifdef INTERRUPT_INPUT
5534 interrupt_input
= 1;
5536 interrupt_input
= 0;
5539 /* Our VMS input only works by interrupts, as of now. */
5541 interrupt_input
= 1;
5547 if (keyboard_init_hook
)
5548 (*keyboard_init_hook
) ();
5550 #ifdef POLL_FOR_INPUT
5551 poll_suppress_count
= 1;
5556 /* This type's only use is in syms_of_keyboard, to initialize the
5557 event header symbols and put properties on them. */
5564 struct event_head head_table
[] = {
5565 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
5566 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
5567 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
5572 Qdisabled_command_hook
= intern ("disabled-command-hook");
5573 staticpro (&Qdisabled_command_hook
);
5575 Qself_insert_command
= intern ("self-insert-command");
5576 staticpro (&Qself_insert_command
);
5578 Qforward_char
= intern ("forward-char");
5579 staticpro (&Qforward_char
);
5581 Qbackward_char
= intern ("backward-char");
5582 staticpro (&Qbackward_char
);
5584 Qdisabled
= intern ("disabled");
5585 staticpro (&Qdisabled
);
5587 Qundefined
= intern ("undefined");
5588 staticpro (&Qundefined
);
5590 Qpre_command_hook
= intern ("pre-command-hook");
5591 staticpro (&Qpre_command_hook
);
5593 Qpost_command_hook
= intern ("post-command-hook");
5594 staticpro (&Qpost_command_hook
);
5596 Qcommand_hook_internal
= intern ("command-hook-internal");
5597 staticpro (&Qcommand_hook_internal
);
5599 Qfunction_key
= intern ("function-key");
5600 staticpro (&Qfunction_key
);
5601 Qmouse_click
= intern ("mouse-click");
5602 staticpro (&Qmouse_click
);
5604 Qmenu_enable
= intern ("menu-enable");
5605 staticpro (&Qmenu_enable
);
5607 Qmode_line
= intern ("mode-line");
5608 staticpro (&Qmode_line
);
5609 Qvertical_line
= intern ("vertical-line");
5610 staticpro (&Qvertical_line
);
5611 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
5612 staticpro (&Qvertical_scroll_bar
);
5613 Qmenu_bar
= intern ("menu-bar");
5614 staticpro (&Qmenu_bar
);
5616 Qabove_handle
= intern ("above-handle");
5617 staticpro (&Qabove_handle
);
5618 Qhandle
= intern ("handle");
5619 staticpro (&Qhandle
);
5620 Qbelow_handle
= intern ("below-handle");
5621 staticpro (&Qbelow_handle
);
5623 Qevent_kind
= intern ("event-kind");
5624 staticpro (&Qevent_kind
);
5625 Qevent_symbol_elements
= intern ("event-symbol-elements");
5626 staticpro (&Qevent_symbol_elements
);
5627 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
5628 staticpro (&Qevent_symbol_element_mask
);
5629 Qmodifier_cache
= intern ("modifier-cache");
5630 staticpro (&Qmodifier_cache
);
5632 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
5633 staticpro (&Qrecompute_lucid_menubar
);
5634 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
5635 staticpro (&Qactivate_menubar_hook
);
5638 struct event_head
*p
;
5640 for (p
= head_table
;
5641 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
5644 *p
->var
= intern (p
->name
);
5646 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
5647 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
5651 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
5652 staticpro (&button_down_location
);
5656 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
5658 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
5659 for (i
= 0; i
< len
; i
++)
5660 if (modifier_names
[i
])
5661 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
5662 staticpro (&modifier_symbols
);
5665 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
5666 staticpro (&recent_keys
);
5668 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
5669 staticpro (&this_command_keys
);
5671 Qextended_command_history
= intern ("extended-command-history");
5672 Fset (Qextended_command_history
, Qnil
);
5673 staticpro (&Qextended_command_history
);
5675 kbd_buffer_frame_or_window
5676 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
5677 staticpro (&kbd_buffer_frame_or_window
);
5679 func_key_syms
= Qnil
;
5680 staticpro (&func_key_syms
);
5683 staticpro (&mouse_syms
);
5685 unread_switch_frame
= Qnil
;
5686 staticpro (&unread_switch_frame
);
5688 defsubr (&Sread_key_sequence
);
5689 defsubr (&Srecursive_edit
);
5690 defsubr (&Strack_mouse
);
5691 defsubr (&Sinput_pending_p
);
5692 defsubr (&Scommand_execute
);
5693 defsubr (&Srecent_keys
);
5694 defsubr (&Sthis_command_keys
);
5695 defsubr (&Ssuspend_emacs
);
5696 defsubr (&Sabort_recursive_edit
);
5697 defsubr (&Sexit_recursive_edit
);
5698 defsubr (&Srecursion_depth
);
5699 defsubr (&Stop_level
);
5700 defsubr (&Sdiscard_input
);
5701 defsubr (&Sopen_dribble_file
);
5702 defsubr (&Sset_input_mode
);
5703 defsubr (&Scurrent_input_mode
);
5704 defsubr (&Sexecute_extended_command
);
5706 DEFVAR_LISP ("last-command-char", &last_command_char
,
5707 "Last input event that was part of a command.");
5709 DEFVAR_LISP ("last-command-event", &last_command_char
,
5710 "Last input event that was part of a command.");
5712 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
5713 "Last input event in a command, except for mouse menu events.\n\
5714 Mouse menus give back keys that don't look like mouse events;\n\
5715 this variable holds the actual mouse event that led to the menu,\n\
5716 so that you can determine whether the command was run by mouse or not.");
5718 DEFVAR_LISP ("last-input-char", &last_input_char
,
5719 "Last input event.");
5721 DEFVAR_LISP ("last-input-event", &last_input_char
,
5722 "Last input event.");
5724 DEFVAR_LISP ("unread-command-events", &unread_command_events
,
5725 "List of objects to be read as next command input events.");
5727 DEFVAR_INT ("unread-command-char", &unread_command_char
,
5728 "If not -1, an object to be read as next command input event.");
5730 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
5731 "Meta-prefix character code. Meta-foo as command input\n\
5732 turns into this character followed by foo.");
5733 XSET (meta_prefix_char
, Lisp_Int
, 033);
5735 DEFVAR_LISP ("last-command", &last_command
,
5736 "The last command executed. Normally a symbol with a function definition,\n\
5737 but can be whatever was found in the keymap, or whatever the variable\n\
5738 `this-command' was set to by that command.");
5739 last_command
= Qnil
;
5741 DEFVAR_LISP ("this-command", &this_command
,
5742 "The command now being executed.\n\
5743 The command can set this variable; whatever is put here\n\
5744 will be in `last-command' during the following command.");
5745 this_command
= Qnil
;
5747 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
5748 "*Number of keyboard input characters between auto-saves.\n\
5749 Zero means disable autosaving due to number of characters typed.");
5750 auto_save_interval
= 300;
5752 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
5753 "*Number of seconds idle time before auto-save.\n\
5754 Zero or nil means disable auto-saving due to idleness.\n\
5755 After auto-saving due to this many seconds of idle time,\n\
5756 Emacs also does a garbage collection if that seems to be warranted.");
5757 XFASTINT (Vauto_save_timeout
) = 30;
5759 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
5760 "*Nonzero means echo unfinished commands after this many seconds of pause.");
5761 echo_keystrokes
= 1;
5763 DEFVAR_INT ("polling-period", &polling_period
,
5764 "*Interval between polling for input during Lisp execution.\n\
5765 The reason for polling is to make C-g work to stop a running program.\n\
5766 Polling is needed only when using X windows and SIGIO does not work.\n\
5767 Polling is automatically disabled in all other cases.");
5770 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
5771 "*Maximum time between mouse clicks to make a double-click.\n\
5772 Measured in milliseconds. nil means disable double-click recognition;\n\
5773 t means double-clicks have no time limit and are detected\n\
5774 by position only.");
5775 Vdouble_click_time
= make_number (500);
5777 DEFVAR_INT ("num-input-keys", &num_input_keys
,
5778 "*Number of complete keys read from the keyboard so far.");
5782 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
5783 "*The frame in which the most recently read event occurred.\n\
5784 If the last event came from a keyboard macro, this is set to `macro'.");
5785 Vlast_event_frame
= Qnil
;
5788 DEFVAR_LISP ("help-char", &Vhelp_char
,
5789 "Character to recognize as meaning Help.\n\
5790 When it is read, do `(eval help-form)', and display result if it's a string.\n\
5791 If the value of `help-form' is nil, this char can be read normally.");
5792 XSET (Vhelp_char
, Lisp_Int
, Ctl ('H'));
5794 DEFVAR_LISP ("help-form", &Vhelp_form
,
5795 "Form to execute when character `help-char' is read.\n\
5796 If the form returns a string, that string is displayed.\n\
5797 If `help-form' is nil, the help char is not recognized.");
5800 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
5801 "Command to run when `help-char' character follows a prefix key.\n\
5802 This command is used only when there is no actual binding\n\
5803 for that character after that prefix key.");
5804 Vprefix_help_command
= Qnil
;
5806 DEFVAR_LISP ("top-level", &Vtop_level
,
5807 "Form to evaluate when Emacs starts up.\n\
5808 Useful to set before you dump a modified Emacs.");
5811 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
5812 "String used as translate table for keyboard input, or nil.\n\
5813 Each character is looked up in this string and the contents used instead.\n\
5814 If string is of length N, character codes N and up are untranslated.");
5815 Vkeyboard_translate_table
= Qnil
;
5817 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
5818 "Keymap of key translations that can override keymaps.\n\
5819 This keymap works like `function-key-map', but comes after that,\n\
5820 and applies even for keys that have ordinary bindings.");
5821 Vkey_translation_map
= Qnil
;
5823 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
5824 "Non-nil means prompt with menus when appropriate.\n\
5825 This is done when reading from a keymap that has a prompt string,\n\
5826 for elements that have prompt strings.\n\
5827 The menu is displayed on the screen\n\
5828 if X menus were enabled at configuration\n\
5829 time and the previous event was a mouse click prefix key.\n\
5830 Otherwise, menu prompting uses the echo area.");
5833 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
5834 "Character to see next line of menu prompt.\n\
5835 Type this character while in a menu prompt to rotate around the lines of it.");
5836 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
5838 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
5839 "A mask of additional modifier keys to use with every keyboard character.\n\
5840 Emacs applies the modifiers of the character stored here to each keyboard\n\
5841 character it reads. For example, after evaluating the expression\n\
5842 (setq extra-keyboard-modifiers ?\C-x)\n\
5843 all input characters will have the control modifier applied to them.\n\
5845 Note that the character ?\C-@, equivalent to the integer zero, does\n\
5846 not count as a control character; rather, it counts as a character\n\
5847 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
5848 cancels any modification.");
5849 extra_keyboard_modifiers
= 0;
5851 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
5852 "If an editing command sets this to t, deactivate the mark afterward.\n\
5853 The command loop sets this to nil before each command,\n\
5854 and tests the value when the command returns.\n\
5855 Buffer modification stores t in this variable.");
5856 Vdeactivate_mark
= Qnil
;
5858 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
5859 "Temporary storage of pre-command-hook or post-command-hook.");
5860 Vcommand_hook_internal
= Qnil
;
5862 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
5863 "Normal hook run before each command is executed.");
5864 Vpre_command_hook
= Qnil
;
5866 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
5867 "Normal hook run after each command is executed.");
5868 Vpost_command_hook
= Qnil
;
5870 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
5871 "t means menu bar, specified Lucid style, needs to be recomputed.");
5872 Vlucid_menu_bar_dirty_flag
= Qnil
;
5874 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
5875 "List of menu bar items to move to the end of the menu bar.\n\
5876 The elements of the list are event types that may have menu bar bindings.");
5877 Vmenu_bar_final_items
= Qnil
;
5879 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
5880 "Keymap that overrides all other local keymaps.\n\
5881 If this variable is non-nil, it is used as a keymap instead of the\n\
5882 buffer's local map, and the minor mode keymaps and text property keymaps.");
5883 Voverriding_local_map
= Qnil
;
5885 DEFVAR_BOOL ("track-mouse", &do_mouse_tracking
,
5886 "*Non-nil means generate motion events for mouse motion.");
5888 DEFVAR_LISP ("vendor-key-alist", &Vvendor_key_alist
,
5889 "Alist of vendor-specific X windows key symbols.\n\
5890 Each element should have the form (N . SYMBOL) where N is the\n\
5891 numeric keysym code (sans the \"vendor-specific\" bit 1<<28)\n\
5892 and SYMBOL is its name.");
5893 Vmenu_bar_final_items
= Qnil
;
5898 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
5899 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
5900 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
5901 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
5902 initial_define_key (meta_map
, 'x', "execute-extended-command");