1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94 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 Vunread_command_events
;
184 /* If not -1, an event to be read as subsequent command input. */
185 int unread_command_char
;
187 /* If not Qnil, this is a switch-frame event which we decided to put
188 off until the end of a key sequence. This should be read as the
189 next command input, after any unread_command_events.
191 read_key_sequence uses this to delay switch-frame events until the
192 end of the key sequence; Fread_char uses it to put off switch-frame
193 events until a non-ASCII event is acceptable as input. */
194 Lisp_Object unread_switch_frame
;
196 /* A mask of extra modifier bits to put into every keyboard char. */
197 int extra_keyboard_modifiers
;
199 /* Char to use as prefix when a meta character is typed in.
200 This is bound on entry to minibuffer in case ESC is changed there. */
202 Lisp_Object meta_prefix_char
;
204 /* Last size recorded for a current buffer which is not a minibuffer. */
205 static int last_non_minibuf_size
;
207 /* Number of idle seconds before an auto-save and garbage collection. */
208 static Lisp_Object Vauto_save_timeout
;
210 /* Total number of times read_char has returned. */
213 /* Total number of times read_char has returned, outside of macros. */
214 int num_nonmacro_input_chars
;
216 /* Auto-save automatically when this many characters have been typed
217 since the last time. */
219 static int auto_save_interval
;
221 /* Value of num_nonmacro_input_chars as of last auto save. */
225 /* Last command executed by the editor command loop, not counting
226 commands that set the prefix argument. */
228 Lisp_Object last_command
;
230 /* The command being executed by the command loop.
231 Commands may set this, and the value set will be copied into last_command
232 instead of the actual command. */
233 Lisp_Object this_command
;
235 /* The value of point when the last command was executed. */
236 int last_point_position
;
238 /* The buffer that was current when the last command was started. */
239 Lisp_Object last_point_position_buffer
;
242 /* The frame in which the last input event occurred, or Qmacro if the
243 last event came from a macro. We use this to determine when to
244 generate switch-frame events. This may be cleared by functions
245 like Fselect_frame, to make sure that a switch-frame event is
246 generated by the next character. */
247 Lisp_Object internal_last_event_frame
;
250 /* A user-visible version of the above, intended to allow users to
251 figure out where the last event came from, if the event doesn't
252 carry that information itself (i.e. if it was a character). */
253 Lisp_Object Vlast_event_frame
;
255 /* The timestamp of the last input event we received from the X server.
256 X Windows wants this for selection ownership. */
257 unsigned long last_event_timestamp
;
259 Lisp_Object Qself_insert_command
;
260 Lisp_Object Qforward_char
;
261 Lisp_Object Qbackward_char
;
262 Lisp_Object Qundefined
;
264 /* read_key_sequence stores here the command definition of the
265 key sequence that it reads. */
266 Lisp_Object read_key_sequence_cmd
;
268 /* Form to evaluate (if non-nil) when Emacs is started. */
269 Lisp_Object Vtop_level
;
271 /* User-supplied string to translate input characters through. */
272 Lisp_Object Vkeyboard_translate_table
;
274 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
275 extern Lisp_Object Vfunction_key_map
;
277 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
278 Lisp_Object Vkey_translation_map
;
280 /* Non-nil means deactivate the mark at end of this command. */
281 Lisp_Object Vdeactivate_mark
;
283 /* Menu bar specified in Lucid Emacs fashion. */
285 Lisp_Object Vlucid_menu_bar_dirty_flag
;
286 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
288 /* Hooks to run before and after each command. */
289 Lisp_Object Qpre_command_hook
, Qpost_command_hook
;
290 Lisp_Object Vpre_command_hook
, Vpost_command_hook
;
291 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
293 /* File in which we write all commands we read. */
296 /* Nonzero if input is available. */
299 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
300 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
304 extern char *pending_malloc_warning
;
306 /* Circular buffer for pre-read keyboard input. */
307 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
309 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
311 The interrupt-level event handlers will never enqueue an event on a
312 frame which is not in Vframe_list, and once an event is dequeued,
313 internal_last_event_frame or the event itself points to the frame.
316 But while the event is sitting in the queue, it's completely
317 unprotected. Suppose the user types one command which will run for
318 a while and then delete a frame, and then types another event at
319 the frame that will be deleted, before the command gets around to
320 it. Suppose there are no references to this frame elsewhere in
321 Emacs, and a GC occurs before the second event is dequeued. Now we
322 have an event referring to a freed frame, which will crash Emacs
325 Similar things happen when an event on a scroll bar is enqueued; the
326 window may be deleted while the event is in the queue.
328 So, we use this vector to protect the frame_or_window field in the
329 event queue. That way, they'll be dequeued as dead frames or
330 windows, but still valid lisp objects.
332 If kbd_buffer[i].kind != no_event, then
333 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
334 == kbd_buffer[i].frame_or_window. */
335 static Lisp_Object kbd_buffer_frame_or_window
;
337 /* Pointer to next available character in kbd_buffer.
338 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
339 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
340 next available char is in kbd_buffer[0]. */
341 static struct input_event
*kbd_fetch_ptr
;
343 /* Pointer to next place to store character in kbd_buffer. This
344 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
345 character should go in kbd_buffer[0]. */
349 static struct input_event
*kbd_store_ptr
;
351 /* The above pair of variables forms a "queue empty" flag. When we
352 enqueue a non-hook event, we increment kbd_write_count. When we
353 dequeue a non-hook event, we increment kbd_read_count. We say that
354 there is input available iff the two counters are not equal.
356 Why not just have a flag set and cleared by the enqueuing and
357 dequeuing functions? Such a flag could be screwed up by interrupts
358 at inopportune times. */
360 /* If this flag is non-zero, we check mouse_moved to see when the
361 mouse moves, and motion events will appear in the input stream. If
362 it is zero, mouse motion is ignored. */
363 static int do_mouse_tracking
;
365 /* The window system handling code should set this if the mouse has
366 moved since the last call to the mouse_position_hook. Calling that
367 hook should clear this. Code assumes that if this is set, it can
368 call mouse_position_hook to get the promised position, so don't set
369 it unless you're prepared to substantiate the claim! */
372 /* True iff there is an event in kbd_buffer, or if mouse tracking is
373 enabled and there is a new mouse position in the mouse movement
374 buffer. Note that if this is false, that doesn't mean that there
375 is readable input; all the events in the queue might be button-up
376 events, and do_mouse_tracking might be off. */
377 #define EVENT_QUEUES_EMPTY \
378 ((kbd_fetch_ptr == kbd_store_ptr) && (!do_mouse_tracking || !mouse_moved))
381 /* Symbols to head events. */
382 Lisp_Object Qmouse_movement
;
383 Lisp_Object Qscroll_bar_movement
;
384 Lisp_Object Qswitch_frame
;
386 /* Symbols to denote kinds of events. */
387 Lisp_Object Qfunction_key
;
388 Lisp_Object Qmouse_click
;
389 /* Lisp_Object Qmouse_movement; - also an event header */
391 /* Properties of event headers. */
392 Lisp_Object Qevent_kind
;
393 Lisp_Object Qevent_symbol_elements
;
395 Lisp_Object Qmenu_enable
;
397 /* An event header symbol HEAD may have a property named
398 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
399 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
400 mask of modifiers applied to it. If present, this is used to help
401 speed up parse_modifiers. */
402 Lisp_Object Qevent_symbol_element_mask
;
404 /* An unmodified event header BASE may have a property named
405 Qmodifier_cache, which is an alist mapping modifier masks onto
406 modified versions of BASE. If present, this helps speed up
408 Lisp_Object Qmodifier_cache
;
410 /* Symbols to use for parts of windows. */
411 Lisp_Object Qmode_line
;
412 Lisp_Object Qvertical_line
;
413 Lisp_Object Qvertical_scroll_bar
;
414 Lisp_Object Qmenu_bar
;
416 extern Lisp_Object Qmenu_enable
;
418 Lisp_Object
recursive_edit_unwind (), command_loop ();
419 Lisp_Object
Fthis_command_keys ();
420 Lisp_Object Qextended_command_history
;
422 Lisp_Object Qpolling_period
;
424 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
426 EMACS_TIME
*input_available_clear_time
;
428 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
429 Default is 1 if INTERRUPT_INPUT is defined. */
432 /* Nonzero while interrupts are temporarily deferred during redisplay. */
433 int interrupts_deferred
;
435 /* nonzero means use ^S/^Q for flow control. */
438 /* Allow m- file to inhibit use of FIONREAD. */
439 #ifdef BROKEN_FIONREAD
443 /* We are unable to use interrupts if FIONREAD is not available,
444 so flush SIGIO so we won't try. */
451 /* If we support X Windows, turn on the code to poll periodically
452 to detect C-g. It isn't actually used when doing interrupt input. */
453 #ifdef HAVE_X_WINDOWS
454 #define POLL_FOR_INPUT
457 /* Global variable declarations. */
459 /* Function for init_keyboard to call with no args (if nonzero). */
460 void (*keyboard_init_hook
) ();
462 static int read_avail_input ();
463 static void get_input_pending ();
464 static int readable_events ();
465 static Lisp_Object
read_char_x_menu_prompt ();
466 static Lisp_Object
read_char_minibuf_menu_prompt ();
467 static Lisp_Object
make_lispy_event ();
468 static Lisp_Object
make_lispy_movement ();
469 static Lisp_Object
modify_event_symbol ();
470 static Lisp_Object
make_lispy_switch_frame ();
472 /* > 0 if we are to echo keystrokes. */
473 static int echo_keystrokes
;
475 /* Nonzero means echo each character as typed. */
476 static int immediate_echo
;
478 /* The text we're echoing in the modeline - partial key sequences,
479 usually. '\0'-terminated. This really shouldn't have a fixed size. */
480 static char echobuf
[300];
482 /* Where to append more text to echobuf if we want to. */
483 static char *echoptr
;
485 /* Nonzero means don't try to suspend even if the operating system seems
487 static int cannot_suspend
;
489 #define min(a,b) ((a)<(b)?(a):(b))
490 #define max(a,b) ((a)>(b)?(a):(b))
492 /* Install the string STR as the beginning of the string of echoing,
493 so that it serves as a prompt for the next character.
494 Also start echoing. */
499 int len
= strlen (str
);
500 if (len
> sizeof echobuf
- 4)
501 len
= sizeof echobuf
- 4;
502 bcopy (str
, echobuf
, len
);
503 echoptr
= echobuf
+ len
;
509 /* Add C to the echo string, if echoing is going on.
510 C can be a character, which is printed prettily ("M-C-x" and all that
511 jazz), or a symbol, whose name is printed. */
516 extern char *push_key_description ();
525 /* If someone has passed us a composite event, use its head symbol. */
528 if (XTYPE (c
) == Lisp_Int
)
530 if (ptr
- echobuf
> sizeof echobuf
- 6)
533 ptr
= push_key_description (XINT (c
), ptr
);
535 else if (XTYPE (c
) == Lisp_Symbol
)
537 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
538 if (((ptr
- echobuf
) + name
->size
+ 4) > sizeof echobuf
)
540 bcopy (name
->data
, ptr
, name
->size
);
544 if (echoptr
== echobuf
&& EQ (c
, Vhelp_char
))
546 strcpy (ptr
, " (Type ? for further options)");
557 /* Temporarily add a dash to the end of the echo string if it's not
558 empty, so that it serves as a mini-prompt for the very next character. */
562 if (!immediate_echo
&& echoptr
== echobuf
)
564 /* Do nothing if not echoing at all. */
568 /* Put a dash at the end of the buffer temporarily,
569 but make it go away when the next character is added. */
576 /* Display the current echo string, and begin echoing if not already
586 for (i
= 0; i
< this_command_key_count
; i
++)
589 c
= XVECTOR (this_command_keys
)->contents
[i
];
590 if (! (EVENT_HAS_PARAMETERS (c
)
591 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
601 if (waiting_for_input
&& !NILP (Vquit_flag
))
602 quit_throw_to_read_char ();
605 /* Turn off echoing, for the start of a new command. */
613 /* Return the length of the current echo string. */
618 return echoptr
- echobuf
;
621 /* Truncate the current echo message to its first LEN chars.
622 This and echo_char get used by read_key_sequence when the user
623 switches frames while entering a key sequence. */
630 echoptr
= echobuf
+ len
;
631 truncate_echo_area (len
);
635 /* Functions for manipulating this_command_keys. */
637 add_command_key (key
)
640 int size
= XVECTOR (this_command_keys
)->size
;
642 if (this_command_key_count
>= size
)
644 Lisp_Object new_keys
;
646 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
647 bcopy (XVECTOR (this_command_keys
)->contents
,
648 XVECTOR (new_keys
)->contents
,
649 size
* sizeof (Lisp_Object
));
651 this_command_keys
= new_keys
;
654 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
660 int count
= specpdl_ptr
- specpdl
;
663 if (command_loop_level
> 0)
665 specbind (Qstandard_output
, Qt
);
666 specbind (Qstandard_input
, Qt
);
669 val
= command_loop ();
671 Fsignal (Qquit
, Qnil
);
673 return unbind_to (count
, Qnil
);
676 /* When an auto-save happens, record the "time", and don't do again soon. */
680 last_auto_save
= num_nonmacro_input_chars
;
683 /* Make an auto save happen as soon as possible at command level. */
685 force_auto_save_soon ()
687 last_auto_save
= - auto_save_interval
- 1;
689 record_asynch_buffer_change ();
692 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
693 "Invoke the editor command loop recursively.\n\
694 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
695 that tells this function to return.\n\
696 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
697 This function is called by the editor initialization to begin editing.")
700 int count
= specpdl_ptr
- specpdl
;
703 command_loop_level
++;
704 update_mode_lines
= 1;
706 record_unwind_protect (recursive_edit_unwind
,
708 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
712 return unbind_to (count
, Qnil
);
716 recursive_edit_unwind (buffer
)
720 Fset_buffer (buffer
);
722 command_loop_level
--;
723 update_mode_lines
= 1;
731 Lisp_Object errmsg
, tail
, errname
, file_error
;
738 Vstandard_output
= Qt
;
739 Vstandard_input
= Qt
;
740 Vexecuting_macro
= Qnil
;
741 echo_area_glyphs
= 0;
743 /* If the window system or terminal frame hasn't been initialized
744 yet, or we're not interactive, it's best to dump this message out
745 to stderr and exit. */
746 if (! FRAME_MESSAGE_BUF (selected_frame
)
748 stream
= Qexternal_debugging_output
;
756 errname
= Fcar (data
);
758 if (EQ (errname
, Qerror
))
761 if (!CONSP (data
)) data
= Qnil
;
762 errmsg
= Fcar (data
);
767 errmsg
= Fget (errname
, Qerror_message
);
768 file_error
= Fmemq (Qfile_error
,
769 Fget (errname
, Qerror_conditions
));
772 /* Print an error message including the data items.
773 This is done by printing it into a scratch buffer
774 and then making a copy of the text in the buffer. */
776 if (!CONSP (data
)) data
= Qnil
;
780 /* For file-error, make error message by concatenating
781 all the data items. They are all strings. */
782 if (!NILP (file_error
) && !NILP (tail
))
783 errmsg
= XCONS (tail
)->car
, tail
= XCONS (tail
)->cdr
;
785 if (XTYPE (errmsg
) == Lisp_String
)
786 Fprinc (errmsg
, stream
);
788 write_string_1 ("peculiar error", -1, stream
);
790 for (i
= 0; CONSP (tail
); tail
= Fcdr (tail
), i
++)
792 write_string_1 (i
? ", " : ": ", 2, stream
);
793 if (!NILP (file_error
))
794 Fprinc (Fcar (tail
), stream
);
796 Fprin1 (Fcar (tail
), stream
);
800 /* If the window system or terminal frame hasn't been initialized
801 yet, or we're in -batch mode, this error should cause Emacs to exit. */
802 if (! FRAME_MESSAGE_BUF (selected_frame
)
806 Fkill_emacs (make_number (-1));
811 Vinhibit_quit
= Qnil
;
812 return make_number (0);
815 Lisp_Object
command_loop_1 ();
816 Lisp_Object
command_loop_2 ();
817 Lisp_Object
top_level_1 ();
819 /* Entry to editor-command-loop.
820 This level has the catches for exiting/returning to editor command loop.
821 It returns nil to exit recursive edit, t to abort it. */
826 if (command_loop_level
> 0 || minibuf_level
> 0)
828 return internal_catch (Qexit
, command_loop_2
, Qnil
);
833 internal_catch (Qtop_level
, top_level_1
, Qnil
);
834 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
836 /* End of file in -batch run causes exit here. */
842 /* Here we catch errors in execution of commands within the
843 editing loop, and reenter the editing loop.
844 When there is an error, cmd_error runs and returns a non-nil
845 value to us. A value of nil means that cmd_loop_1 itself
846 returned due to end of file (or end of kbd macro). */
851 register Lisp_Object val
;
854 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
863 return Feval (Vtop_level
);
869 /* On entry to the outer level, run the startup file */
870 if (!NILP (Vtop_level
))
871 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
872 else if (!NILP (Vpurify_flag
))
873 message ("Bare impure Emacs (standard Lisp code not loaded)");
875 message ("Bare Emacs (standard Lisp code not loaded)");
879 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
880 "Exit all recursive editing levels.")
883 Fthrow (Qtop_level
, Qnil
);
886 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
887 "Exit from the innermost recursive edit or minibuffer.")
890 if (command_loop_level
> 0 || minibuf_level
> 0)
891 Fthrow (Qexit
, Qnil
);
893 error ("No recursive edit is in progress");
896 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
897 "Abort the command that requested this recursive edit or minibuffer input.")
900 if (command_loop_level
> 0 || minibuf_level
> 0)
903 error ("No recursive edit is in progress");
906 /* This is the actual command reading loop,
907 sans error-handling encapsulation. */
909 Lisp_Object
Fcommand_execute ();
910 static int read_key_sequence ();
911 static void safe_run_hooks ();
916 Lisp_Object cmd
, tem
;
919 Lisp_Object keybuf
[30];
924 struct buffer
*prev_buffer
;
927 Vdeactivate_mark
= Qnil
;
928 waiting_for_input
= 0;
933 this_command_key_count
= 0;
935 /* Make sure this hook runs after commands that get errors and
936 throw to top level. */
937 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
938 safe_run_hooks (&Vpost_command_hook
);
940 /* Do this after running Vpost_command_hook, for consistency. */
941 last_command
= this_command
;
945 /* Install chars successfully executed in kbd macro. */
947 if (defining_kbd_macro
&& NILP (Vprefix_arg
))
948 finalize_kbd_macro_chars ();
950 /* Make sure the current window's buffer is selected. */
951 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
952 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
954 /* Display any malloc warning that just came out. Use while because
955 displaying one warning can cause another. */
957 while (pending_malloc_warning
)
958 display_malloc_warning ();
962 Vdeactivate_mark
= Qnil
;
964 /* If minibuffer on and echo area in use,
965 wait 2 sec and redraw minibuffer. */
967 if (minibuf_level
&& echo_area_glyphs
)
969 /* Bind inhibit-quit to t so that C-g gets read in
970 rather than quitting back to the minibuffer. */
971 int count
= specpdl_ptr
- specpdl
;
972 specbind (Qinhibit_quit
, Qt
);
973 Fsit_for (make_number (2), Qnil
, Qnil
);
974 unbind_to (count
, Qnil
);
976 echo_area_glyphs
= 0;
978 if (!NILP (Vquit_flag
))
981 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
986 alloca (0); /* Cause a garbage collection now */
987 /* Since we can free the most stuff here. */
988 #endif /* C_ALLOCA */
992 /* Select the frame that the last event came from. Usually,
993 switch-frame events will take care of this, but if some lisp
994 code swallows a switch-frame event, we'll fix things up here.
995 Is this a good idea? */
996 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
997 && XFRAME (internal_last_event_frame
) != selected_frame
)
998 Fselect_frame (internal_last_event_frame
, Qnil
);
1001 /* If it has changed current-menubar from previous value,
1002 really recompute the menubar from the value. */
1003 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1004 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1005 call0 (Qrecompute_lucid_menubar
);
1007 /* Read next key sequence; i gets its length. */
1008 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), Qnil
);
1012 /* Now we have read a key sequence of length I,
1013 or else I is 0 and we found end of file. */
1015 if (i
== 0) /* End of file -- happens only in */
1016 return Qnil
; /* a kbd macro, at the end. */
1017 /* -1 means read_key_sequence got a menu that was rejected.
1018 Just loop around and read another command. */
1022 this_command_key_count
= 0;
1026 last_command_char
= keybuf
[i
- 1];
1028 /* If the previous command tried to force a specific window-start,
1029 forget about that, in case this command moves point far away
1030 from that position. */
1031 XWINDOW (selected_window
)->force_start
= Qnil
;
1033 cmd
= read_key_sequence_cmd
;
1034 if (!NILP (Vexecuting_macro
))
1036 if (!NILP (Vquit_flag
))
1038 Vexecuting_macro
= Qt
;
1039 QUIT
; /* Make some noise. */
1040 /* Will return since macro now empty. */
1044 /* Do redisplay processing after this command except in special
1045 cases identified below that set no_redisplay to 1.
1046 (actually, there's currently no way to prevent the redisplay,
1047 and no_redisplay is ignored.
1048 Perhaps someday we will really implement it. */
1051 prev_buffer
= current_buffer
;
1052 prev_modiff
= MODIFF
;
1053 last_point_position
= PT
;
1054 XSET (last_point_position_buffer
, Lisp_Buffer
, prev_buffer
);
1056 /* Execute the command. */
1059 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1060 safe_run_hooks (&Vpre_command_hook
);
1062 if (NILP (this_command
))
1064 /* nil means key is undefined. */
1066 defining_kbd_macro
= 0;
1067 update_mode_lines
= 1;
1073 if (NILP (Vprefix_arg
) && ! no_direct
)
1075 /* Recognize some common commands in common situations and
1076 do them directly. */
1077 if (EQ (this_command
, Qforward_char
) && PT
< ZV
)
1079 struct Lisp_Vector
*dp
1080 = window_display_table (XWINDOW (selected_window
));
1081 lose
= FETCH_CHAR (PT
);
1084 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1085 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1086 : (lose
>= 0x20 && lose
< 0x7f))
1087 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1089 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1091 && !windows_or_buffers_changed
1092 && EQ (current_buffer
->selective_display
, Qnil
)
1093 && !detect_input_pending ()
1094 && NILP (Vexecuting_macro
))
1095 no_redisplay
= direct_output_forward_char (1);
1098 else if (EQ (this_command
, Qbackward_char
) && PT
> BEGV
)
1100 struct Lisp_Vector
*dp
1101 = window_display_table (XWINDOW (selected_window
));
1103 lose
= FETCH_CHAR (PT
);
1105 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1106 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1107 : (lose
>= 0x20 && lose
< 0x7f))
1108 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1110 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1112 && !windows_or_buffers_changed
1113 && EQ (current_buffer
->selective_display
, Qnil
)
1114 && !detect_input_pending ()
1115 && NILP (Vexecuting_macro
))
1116 no_redisplay
= direct_output_forward_char (-1);
1119 else if (EQ (this_command
, Qself_insert_command
)
1120 /* Try this optimization only on ascii keystrokes. */
1121 && XTYPE (last_command_char
) == Lisp_Int
)
1123 unsigned char c
= XINT (last_command_char
);
1125 if (NILP (Vexecuting_macro
) &&
1126 !EQ (minibuf_window
, selected_window
))
1128 if (!nonundocount
|| nonundocount
>= 20)
1135 lose
= (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1137 || (XFASTINT (XWINDOW (selected_window
)->last_point
) != PT
)
1138 || MODIFF
<= current_buffer
->save_modified
1139 || windows_or_buffers_changed
1140 || !EQ (current_buffer
->selective_display
, Qnil
)
1141 || detect_input_pending ()
1142 || !NILP (Vexecuting_macro
);
1143 if (internal_self_insert (c
, 0))
1149 (PT
== ZV
|| FETCH_CHAR (PT
) == '\n'))
1151 struct Lisp_Vector
*dp
1152 = window_display_table (XWINDOW (selected_window
));
1159 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1160 if (XTYPE (obj
) == Lisp_Vector
1161 && XVECTOR (obj
)->size
== 1
1162 && (XTYPE (obj
= XVECTOR (obj
)->contents
[0])
1165 direct_output_for_insert (XINT (obj
));
1169 if (lose
>= 0x20 && lose
<= 0x7e)
1170 no_redisplay
= direct_output_for_insert (lose
);
1177 /* Here for a command that isn't executed directly */
1180 if (NILP (Vprefix_arg
))
1182 Fcommand_execute (this_command
, Qnil
);
1187 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1188 safe_run_hooks (&Vpost_command_hook
);
1190 /* If there is a prefix argument,
1191 1) We don't want last_command to be ``universal-argument''
1192 (that would be dumb), so don't set last_command,
1193 2) we want to leave echoing on so that the prefix will be
1194 echoed as part of this key sequence, so don't call
1196 3) we want to leave this_command_key_count non-zero, so that
1197 read_char will realize that it is re-reading a character, and
1198 not echo it a second time. */
1199 if (NILP (Vprefix_arg
))
1201 last_command
= this_command
;
1203 this_command_key_count
= 0;
1206 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1208 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1210 current_buffer
->mark_active
= Qnil
;
1211 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1213 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1214 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1219 /* If we get an error while running the hook, cause the hook variable
1220 to be nil. Also inhibit quits, so that C-g won't cause the hook
1221 to mysteriously evaporate. */
1223 safe_run_hooks (hook
)
1226 int count
= specpdl_ptr
- specpdl
;
1227 specbind (Qinhibit_quit
, Qt
);
1229 Vcommand_hook_internal
= *hook
;
1231 call1 (Vrun_hooks
, Qcommand_hook_internal
);
1232 *hook
= Vcommand_hook_internal
;
1234 unbind_to (count
, Qnil
);
1237 /* Number of seconds between polling for input. */
1240 /* Nonzero means polling for input is temporarily suppressed. */
1241 int poll_suppress_count
;
1243 #ifdef POLL_FOR_INPUT
1244 int polling_for_input
;
1246 /* Handle an alarm once each second and read pending input
1247 so as to handle a C-g if it comces in. */
1250 input_poll_signal ()
1252 if (interrupt_input_blocked
== 0
1253 && !waiting_for_input
)
1254 read_avail_input (0);
1255 signal (SIGALRM
, input_poll_signal
);
1256 alarm (polling_period
);
1261 /* Begin signals to poll for input, if they are appropriate.
1262 This function is called unconditionally from various places. */
1266 #ifdef POLL_FOR_INPUT
1267 if (read_socket_hook
&& !interrupt_input
)
1269 poll_suppress_count
--;
1270 if (poll_suppress_count
== 0)
1272 signal (SIGALRM
, input_poll_signal
);
1273 polling_for_input
= 1;
1274 alarm (polling_period
);
1280 /* Turn off polling. */
1284 #ifdef POLL_FOR_INPUT
1285 if (read_socket_hook
&& !interrupt_input
)
1287 if (poll_suppress_count
== 0)
1289 polling_for_input
= 0;
1292 poll_suppress_count
++;
1297 /* Set the value of poll_suppress_count to COUNT
1298 and start or stop polling accordingly. */
1301 set_poll_suppress_count (count
)
1304 #ifdef POLL_FOR_INPUT
1305 if (count
== 0 && poll_suppress_count
!= 0)
1307 poll_suppress_count
= 1;
1310 else if (count
!= 0 && poll_suppress_count
== 0)
1314 poll_suppress_count
= count
;
1318 /* Bind polling_period to a value at least N.
1319 But don't decrease it. */
1321 bind_polling_period (n
)
1324 #ifdef POLL_FOR_INPUT
1325 int new = polling_period
;
1331 specbind (Qpolling_period
, make_number (new));
1332 /* Start a new alarm with the new period. */
1337 /* Applying the control modifier to CHARACTER. */
1342 /* Save the upper bits here. */
1343 int upper
= c
& ~0177;
1347 /* Everything in the columns containing the upper-case letters
1348 denotes a control character. */
1349 if (c
>= 0100 && c
< 0140)
1353 /* Set the shift modifier for a control char
1354 made from a shifted letter. But only for letters! */
1355 if (oc
>= 'A' && oc
<= 'Z')
1356 c
|= shift_modifier
;
1359 /* The lower-case letters denote control characters too. */
1360 else if (c
>= 'a' && c
<= 'z')
1363 /* Include the bits for control and shift
1364 only if the basic ASCII code can't indicate them. */
1368 /* Replace the high bits. */
1369 c
|= (upper
& ~ctrl_modifier
);
1376 /* Input of single characters from keyboard */
1378 Lisp_Object
print_help ();
1379 static Lisp_Object
kbd_buffer_get_event ();
1381 /* read a character from the keyboard; call the redisplay if needed */
1382 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1383 -1 means do not do redisplay, but do do autosaving.
1386 /* The arguments MAPS and NMAPS are for menu prompting.
1387 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1389 PREV_EVENT is the previous input event, or nil if we are reading
1390 the first event of a key sequence.
1392 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1393 if we used a mouse menu to read the input, or zero otherwise. If
1394 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
1396 Value is t if we showed a menu and the user rejected it. */
1399 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1403 Lisp_Object prev_event
;
1404 int *used_mouse_menu
;
1406 register Lisp_Object c
;
1410 if (CONSP (Vunread_command_events
))
1412 c
= XCONS (Vunread_command_events
)->car
;
1413 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1415 if (this_command_key_count
== 0)
1421 if (unread_command_char
!= -1)
1423 XSET (c
, Lisp_Int
, unread_command_char
);
1424 unread_command_char
= -1;
1426 if (this_command_key_count
== 0)
1432 if (!NILP (Vexecuting_macro
))
1435 /* We set this to Qmacro; since that's not a frame, nobody will
1436 try to switch frames on us, and the selected window will
1439 Since this event came from a macro, it would be misleading to
1440 leave internal_last_event_frame set to wherever the last
1441 real event came from. Normally, a switch-frame event selects
1442 internal_last_event_frame after each command is read, but
1443 events read from a macro should never cause a new frame to be
1445 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1448 /* Exit the macro if we are at the end.
1449 Also, some things replace the macro with t
1450 to force an early exit. */
1451 if (EQ (Vexecuting_macro
, Qt
)
1452 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1454 XSET (c
, Lisp_Int
, -1);
1458 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1459 if (XTYPE (Vexecuting_macro
) == Lisp_String
1460 && (XINT (c
) & 0x80))
1461 XFASTINT (c
) = CHAR_META
| (XINT (c
) & ~0x80);
1463 executing_macro_index
++;
1468 if (!NILP (unread_switch_frame
))
1470 c
= unread_switch_frame
;
1471 unread_switch_frame
= Qnil
;
1473 /* This event should make it into this_command_keys, and get echoed
1474 again, so we go to reread_first, rather than reread. */
1478 /* Don't bother updating menu bars while doing mouse tracking.
1479 We get events very rapidly then, and the menu bar won't be changing.
1480 We do update the menu bar once on entry to Ftrack_mouse. */
1481 if (commandflag
> 0 && !input_pending
&& !detect_input_pending ())
1482 prepare_menu_bars ();
1484 /* Save outer setjmp data, in case called recursively. */
1485 save_getcjmp (save_jump
);
1489 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1492 if (_setjmp (getcjmp
))
1494 XSET (c
, Lisp_Int
, quit_char
);
1496 XSET (internal_last_event_frame
, Lisp_Frame
, selected_frame
);
1497 Vlast_event_frame
= internal_last_event_frame
;
1499 /* If we report the quit char as an event,
1500 don't do so more than once. */
1501 if (!NILP (Vinhibit_quit
))
1507 /* Message turns off echoing unless more keystrokes turn it on again. */
1508 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1511 /* If already echoing, continue. */
1514 /* Try reading a character via menu prompting in the minibuf.
1515 Try this before the sit-for, because the sit-for
1516 would do the wrong thing if we are supposed to do
1517 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1518 after a mouse event so don't try a minibuf menu. */
1520 if (nmaps
> 0 && INTERACTIVE
1521 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1522 /* Don't bring up a menu if we already have another event. */
1523 && NILP (Vunread_command_events
)
1524 && unread_command_char
< 0
1525 && !detect_input_pending ())
1527 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1532 /* If in middle of key sequence and minibuffer not active,
1533 start echoing if enough time elapses. */
1534 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1536 && echo_keystrokes
> 0
1537 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1541 /* After a mouse event, start echoing right away.
1542 This is because we are probably about to display a menu,
1543 and we don't want to delay before doing so. */
1544 if (EVENT_HAS_PARAMETERS (prev_event
))
1548 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1554 /* Maybe auto save due to number of keystrokes or idle time. */
1556 if (commandflag
!= 0
1557 && auto_save_interval
> 0
1558 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1559 && !detect_input_pending ())
1562 save_getcjmp (temp
);
1563 Fdo_auto_save (Qnil
, Qnil
);
1564 restore_getcjmp (temp
);
1567 /* Try reading using an X menu.
1568 This is never confused with reading using the minibuf
1569 because the recursive call of read_char in read_char_minibuf_menu_prompt
1570 does not pass on any keymaps. */
1571 if (nmaps
> 0 && INTERACTIVE
1572 && !NILP (prev_event
) && EVENT_HAS_PARAMETERS (prev_event
)
1573 /* Don't bring up a menu if we already have another event. */
1574 && NILP (Vunread_command_events
)
1575 && unread_command_char
< 0)
1576 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1578 /* Slow down auto saves logarithmically in size of current buffer,
1579 and garbage collect while we're at it. */
1580 if (INTERACTIVE
&& NILP (c
))
1582 int delay_level
, buffer_size
;
1584 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1585 last_non_minibuf_size
= Z
- BEG
;
1586 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1588 while (buffer_size
> 64)
1589 delay_level
++, buffer_size
-= buffer_size
>> 2;
1590 if (delay_level
< 4) delay_level
= 4;
1591 /* delay_level is 4 for files under around 50k, 7 at 100k,
1592 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1594 /* Auto save if enough time goes by without input. */
1595 if (commandflag
!= 0
1596 && num_nonmacro_input_chars
> last_auto_save
1597 && XTYPE (Vauto_save_timeout
) == Lisp_Int
1598 && XINT (Vauto_save_timeout
) > 0)
1601 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1602 tem0
= sit_for (delay
, 0, 1, 1);
1606 save_getcjmp (temp
);
1607 Fdo_auto_save (Qnil
, Qnil
);
1608 restore_getcjmp (temp
);
1610 /* If we have auto-saved and there is still no input
1611 available, garbage collect if there has been enough
1612 consing going on to make it worthwhile. */
1613 if (!detect_input_pending ()
1614 && consing_since_gc
> gc_cons_threshold
/ 2)
1616 Fgarbage_collect ();
1617 /* prepare_menu_bars isn't safe here, but it should
1618 also be unnecessary. */
1625 /* Actually read a character, waiting if necessary. */
1628 c
= kbd_buffer_get_event ();
1631 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1635 /* Terminate Emacs in batch mode if at eof. */
1636 if (noninteractive
&& XTYPE (c
) == Lisp_Int
&& XINT (c
) < 0)
1637 Fkill_emacs (make_number (1));
1639 if (XTYPE (c
) == Lisp_Int
)
1641 /* Add in any extra modifiers, where appropriate. */
1642 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1643 || ((extra_keyboard_modifiers
& 0177) < ' '
1644 && (extra_keyboard_modifiers
& 0177) != 0))
1645 XSETINT (c
, make_ctrl_char (XINT (c
)));
1647 /* Transfer any other modifier bits directly from
1648 extra_keyboard_modifiers to c. Ignore the actual character code
1649 in the low 16 bits of extra_keyboard_modifiers. */
1650 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
1655 restore_getcjmp (save_jump
);
1659 /* Don't wipe the echo area for a trivial event. */
1660 if (XTYPE (c
) != Lisp_Buffer
)
1661 echo_area_glyphs
= 0;
1663 /* Handle things that only apply to characters. */
1664 if (XTYPE (c
) == Lisp_Int
)
1666 /* If kbd_buffer_get_event gave us an EOF, return that. */
1670 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
1671 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1672 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1676 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1677 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1678 recent_keys_index
= 0;
1680 /* Write c to the dribble file. If c is a lispy event, write
1681 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1682 If you, dear reader, have a better idea, you've got the source. :-) */
1685 if (XTYPE (c
) == Lisp_Int
)
1686 putc (XINT (c
), dribble
);
1689 Lisp_Object dribblee
;
1691 /* If it's a structured event, take the event header. */
1692 dribblee
= EVENT_HEAD (c
);
1694 if (XTYPE (dribblee
) == Lisp_Symbol
)
1696 putc ('<', dribble
);
1697 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1698 XSYMBOL (dribblee
)->name
->size
,
1700 putc ('>', dribble
);
1707 store_kbd_macro_char (c
);
1709 num_nonmacro_input_chars
++;
1714 /* Don't echo mouse motion events. */
1715 if (! (EVENT_HAS_PARAMETERS (c
)
1716 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1719 /* Record this character as part of the current key. */
1720 add_command_key (c
);
1722 /* Re-reading in the middle of a command */
1724 last_input_char
= c
;
1727 /* Process the help character specially if enabled */
1728 if (EQ (c
, Vhelp_char
) && !NILP (Vhelp_form
))
1731 count
= specpdl_ptr
- specpdl
;
1733 record_unwind_protect (Fset_window_configuration
,
1734 Fcurrent_window_configuration (Qnil
));
1736 tem0
= Feval (Vhelp_form
);
1737 if (XTYPE (tem0
) == Lisp_String
)
1738 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1742 c
= read_char (0, 0, 0, Qnil
, 0);
1743 while (XTYPE (c
) == Lisp_Buffer
);
1744 /* Remove the help from the frame */
1745 unbind_to (count
, Qnil
);
1746 prepare_menu_bars ();
1748 if (EQ (c
, make_number (040)))
1752 c
= read_char (0, 0, 0, Qnil
, 0);
1753 while (XTYPE (c
) == Lisp_Buffer
);
1764 Fprinc (object
, Qnil
);
1768 /* Copy out or in the info on where C-g should throw to.
1769 This is used when running Lisp code from within get_char,
1770 in case get_char is called recursively.
1771 See read_process_output. */
1776 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1779 restore_getcjmp (temp
)
1782 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1786 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1787 of this function. */
1789 tracking_off (old_value
)
1790 Lisp_Object old_value
;
1792 if (! XFASTINT (old_value
))
1794 do_mouse_tracking
= 0;
1796 /* Redisplay may have been preempted because there was input
1797 available, and it assumes it will be called again after the
1798 input has been processed. If the only input available was
1799 the sort that we have just disabled, then we need to call
1801 if (!readable_events ())
1803 prepare_menu_bars ();
1804 redisplay_preserve_echo_area ();
1805 get_input_pending (&input_pending
);
1810 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1811 "Evaluate BODY with mouse movement events enabled.\n\
1812 Within a `track-mouse' form, mouse motion generates input events that\n\
1813 you can read with `read-event'.\n\
1814 Normally, mouse motion is ignored.")
1818 int count
= specpdl_ptr
- specpdl
;
1821 XSET (val
, Lisp_Int
, do_mouse_tracking
);
1822 record_unwind_protect (tracking_off
, val
);
1824 if (!input_pending
&& !detect_input_pending ())
1825 prepare_menu_bars ();
1827 do_mouse_tracking
= 1;
1829 val
= Fprogn (args
);
1830 return unbind_to (count
, val
);
1833 /* Low level keyboard/mouse input.
1834 kbd_buffer_store_event places events in kbd_buffer, and
1835 kbd_buffer_get_event retrieves them.
1836 mouse_moved indicates when the mouse has moved again, and
1837 *mouse_position_hook provides the mouse position. */
1839 /* Return true iff there are any events in the queue that read-char
1840 would return. If this returns false, a read-char would block. */
1844 return ! EVENT_QUEUES_EMPTY
;
1847 /* Set this for debugging, to have a way to get out */
1850 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
1853 kbd_buffer_store_event (event
)
1854 register struct input_event
*event
;
1856 if (event
->kind
== no_event
)
1859 if (event
->kind
== ascii_keystroke
)
1861 register int c
= event
->code
& 0377;
1863 if (event
->modifiers
& ctrl_modifier
)
1864 c
= make_ctrl_char (c
);
1866 c
|= (event
->modifiers
1867 & (meta_modifier
| alt_modifier
1868 | hyper_modifier
| super_modifier
));
1872 extern SIGTYPE
interrupt_signal ();
1875 /* If this results in a quit_char being returned to Emacs as
1876 input, set Vlast_event_frame properly. If this doesn't
1877 get returned to Emacs as an event, the next event read
1878 will set Vlast_event_frame again, so this is safe to do. */
1882 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
1884 internal_last_event_frame
= event
->frame_or_window
;
1886 internal_last_event_frame
= focus
;
1887 Vlast_event_frame
= internal_last_event_frame
;
1891 last_event_timestamp
= event
->timestamp
;
1892 interrupt_signal ();
1896 if (c
&& c
== stop_character
)
1903 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
1904 kbd_store_ptr
= kbd_buffer
;
1906 /* Don't let the very last slot in the buffer become full,
1907 since that would make the two pointers equal,
1908 and that is indistinguishable from an empty buffer.
1909 Discard the event if it would fill the last slot. */
1910 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
1912 kbd_store_ptr
->kind
= event
->kind
;
1913 if (event
->kind
== selection_request_event
)
1915 /* We must not use the ordinary copying code for this case,
1916 since `part' is an enum and copying it might not copy enough
1918 bcopy (event
, kbd_store_ptr
, sizeof (*event
));
1922 kbd_store_ptr
->code
= event
->code
;
1923 kbd_store_ptr
->part
= event
->part
;
1924 kbd_store_ptr
->frame_or_window
= event
->frame_or_window
;
1925 kbd_store_ptr
->modifiers
= event
->modifiers
;
1926 kbd_store_ptr
->x
= event
->x
;
1927 kbd_store_ptr
->y
= event
->y
;
1928 kbd_store_ptr
->timestamp
= event
->timestamp
;
1930 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
1932 = event
->frame_or_window
);
1938 /* Read one event from the event buffer, waiting if necessary.
1939 The value is a Lisp object representing the event.
1940 The value is nil for an event that should be ignored,
1941 or that was handled here.
1942 We always read and discard one event. */
1945 kbd_buffer_get_event ()
1953 XSET (obj
, Lisp_Int
, c
);
1957 /* Wait until there is input available. */
1960 if (!EVENT_QUEUES_EMPTY
)
1963 /* If the quit flag is set, then read_char will return
1964 quit_char, so that counts as "available input." */
1965 if (!NILP (Vquit_flag
))
1966 quit_throw_to_read_char ();
1968 /* One way or another, wait until input is available; then, if
1969 interrupt handlers have not read it, read it now. */
1972 wait_for_kbd_input ();
1974 /* Note SIGIO has been undef'd if FIONREAD is missing. */
1978 if (EVENT_QUEUES_EMPTY
)
1980 Lisp_Object minus_one
;
1982 XSET (minus_one
, Lisp_Int
, -1);
1983 wait_reading_process_input (0, 0, minus_one
, 1);
1985 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
1986 /* Pass 1 for EXPECT since we just waited to have input. */
1987 read_avail_input (1);
1989 #endif /* not VMS */
1992 /* At this point, we know that there is a readable event available
1993 somewhere. If the event queue is empty, then there must be a
1994 mouse movement enabled and available. */
1995 if (kbd_fetch_ptr
!= kbd_store_ptr
)
1997 struct input_event
*event
;
1999 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2003 last_event_timestamp
= event
->timestamp
;
2007 /* These two kinds of events get special handling
2008 and don't actually appear to the command loop.
2009 We return nil for them. */
2010 if (event
->kind
== selection_request_event
)
2013 x_handle_selection_request (event
);
2014 kbd_fetch_ptr
= event
+ 1;
2016 /* We're getting selection request events, but we don't have
2022 else if (event
->kind
== selection_clear_event
)
2025 x_handle_selection_clear (event
);
2026 kbd_fetch_ptr
= event
+ 1;
2028 /* We're getting selection request events, but we don't have
2034 else if (event
->kind
== delete_window_event
)
2036 Lisp_Object tail
, frame
;
2039 /* If the user destroys the only frame, Emacs should exit.
2040 Count visible frames and iconified frames. */
2041 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2043 frame
= XCONS (tail
)->car
;
2044 if (XTYPE (frame
) != Lisp_Frame
|| EQ (frame
, event
->frame_or_window
))
2047 if (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
))
2054 Fdelete_frame (event
->frame_or_window
, Qt
);
2055 kbd_fetch_ptr
= event
+ 1;
2058 else if (event
->kind
== menu_bar_event
)
2060 /* The event value is in the frame_or_window slot. */
2061 obj
= event
->frame_or_window
;
2062 kbd_fetch_ptr
= event
+ 1;
2064 else if (event
->kind
== buffer_switch_event
)
2066 /* The value doesn't matter here; only the type is tested. */
2067 XSET (obj
, Lisp_Buffer
, current_buffer
);
2068 kbd_fetch_ptr
= event
+ 1;
2070 /* Just discard these, by returning nil.
2071 (They shouldn't be found in the buffer,
2072 but on some machines it appears they do show up.) */
2073 else if (event
->kind
== no_event
)
2074 kbd_fetch_ptr
= event
+ 1;
2076 /* If this event is on a different frame, return a switch-frame this
2077 time, and leave the event in the queue for next time. */
2084 frame
= event
->frame_or_window
;
2085 if (XTYPE (frame
) == Lisp_Window
)
2086 frame
= WINDOW_FRAME (XWINDOW (frame
));
2088 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2092 if (! EQ (frame
, internal_last_event_frame
)
2093 && XFRAME (frame
) != selected_frame
)
2094 obj
= make_lispy_switch_frame (frame
);
2095 internal_last_event_frame
= frame
;
2096 #endif /* MULTI_FRAME */
2098 /* If we didn't decide to make a switch-frame event, go ahead
2099 and build a real event from the queue entry. */
2103 obj
= make_lispy_event (event
);
2105 /* Wipe out this event, to catch bugs. */
2106 event
->kind
= no_event
;
2107 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
2110 kbd_fetch_ptr
= event
+ 1;
2114 /* Try generating a mouse motion event. */
2115 else if (do_mouse_tracking
&& mouse_moved
)
2118 Lisp_Object bar_window
;
2119 enum scroll_bar_part part
;
2123 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
2128 /* Decide if we should generate a switch-frame event. Don't
2129 generate switch-frame events for motion outside of all Emacs
2135 frame
= FRAME_FOCUS_FRAME (f
);
2137 XSET (frame
, Lisp_Frame
, f
);
2139 if (! EQ (frame
, internal_last_event_frame
)
2140 && XFRAME (frame
) != selected_frame
)
2141 obj
= make_lispy_switch_frame (frame
);
2142 internal_last_event_frame
= frame
;
2145 /* If we didn't decide to make a switch-frame event, go ahead and
2146 return a mouse-motion event. */
2148 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2152 /* We were promised by the above while loop that there was
2153 something for us to read! */
2156 input_pending
= readable_events ();
2159 Vlast_event_frame
= internal_last_event_frame
;
2165 /* Process any events that are not user-visible,
2166 then return, without reading any user-visible events. */
2171 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2173 struct input_event
*event
;
2175 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2179 last_event_timestamp
= event
->timestamp
;
2181 /* These two kinds of events get special handling
2182 and don't actually appear to the command loop. */
2183 if (event
->kind
== selection_request_event
)
2186 x_handle_selection_request (event
);
2187 kbd_fetch_ptr
= event
+ 1;
2189 /* We're getting selection request events, but we don't have
2195 else if (event
->kind
== selection_clear_event
)
2198 x_handle_selection_clear (event
);
2199 kbd_fetch_ptr
= event
+ 1;
2201 /* We're getting selection request events, but we don't have
2210 get_input_pending (&input_pending
);
2213 /* Caches for modify_event_symbol. */
2214 static Lisp_Object accent_key_syms
;
2215 static Lisp_Object system_key_syms
;
2216 static Lisp_Object func_key_syms
;
2217 static Lisp_Object mouse_syms
;
2219 Lisp_Object Vsystem_key_alist
;
2221 /* This is a list of keysym codes for special "accent" characters.
2222 It parallels lispy_accent_keys. */
2224 static int lispy_accent_codes
[] =
2226 #ifdef XK_dead_circumflex
2231 #ifdef XK_dead_grave
2236 #ifdef XK_dead_tilde
2241 #ifdef XK_dead_diaeresis
2246 #ifdef XK_dead_macron
2251 #ifdef XK_dead_degree
2256 #ifdef XK_dead_acute
2261 #ifdef XK_dead_cedilla
2266 #ifdef XK_dead_breve
2271 #ifdef XK_dead_ogonek
2276 #ifdef XK_dead_caron
2281 #ifdef XK_dead_doubleacute
2282 XK_dead_doubleacute
,
2286 #ifdef XK_dead_abovedot
2293 /* This is a list of Lisp names for special "accent" characters.
2294 It parallels lispy_accent_codes. */
2296 static char *lispy_accent_keys
[] =
2313 /* You'll notice that this table is arranged to be conveniently
2314 indexed by X Windows keysym values. */
2315 static char *lispy_function_keys
[] =
2317 /* X Keysym value */
2319 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2327 0, 0, 0, /* 0xff10 */
2329 0, 0, 0, 0, 0, 0, 0,
2332 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2333 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2334 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2336 "home", /* 0xff50 */ /* IsCursorKey */
2347 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2358 "break", /* 0xff6b */
2360 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2362 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2363 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2364 0, 0, 0, 0, 0, 0, 0, 0,
2365 "kp-tab", /* 0xff89 */
2367 "kp-enter", /* 0xff8d */
2369 "kp-f1", /* 0xff91 */
2374 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2375 "kp-multiply", /* 0xffaa */
2380 "kp-divide", /* 0xffaf */
2381 "kp-0", /* 0xffb0 */
2382 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2385 "kp-equal", /* 0xffbd */
2386 "f1", /* 0xffbe */ /* IsFunctionKey */
2388 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2389 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2390 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2391 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2392 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2393 0, 0, 0, 0, 0, 0, 0, 0,
2394 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2395 0, 0, 0, 0, 0, 0, 0, "delete"
2398 static char *lispy_mouse_names
[] =
2400 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2403 /* Scroll bar parts. */
2404 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2406 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2407 Lisp_Object
*scroll_bar_parts
[] = {
2408 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2412 /* A vector, indexed by button number, giving the down-going location
2413 of currently depressed buttons, both scroll bar and non-scroll bar.
2415 The elements have the form
2416 (BUTTON-NUMBER MODIFIER-MASK . REST)
2417 where REST is the cdr of a position as it would be reported in the event.
2419 The make_lispy_event function stores positions here to tell the
2420 difference between click and drag events, and to store the starting
2421 location to be included in drag events. */
2423 static Lisp_Object button_down_location
;
2425 /* Information about the most recent up-going button event: Which
2426 button, what location, and what time. */
2428 static int last_mouse_button
;
2429 static int last_mouse_x
;
2430 static int last_mouse_y
;
2431 static unsigned long button_down_time
;
2433 /* The maximum time between clicks to make a double-click,
2434 or Qnil to disable double-click detection,
2435 or Qt for no time limit. */
2436 Lisp_Object Vdouble_click_time
;
2438 /* The number of clicks in this multiple-click. */
2440 int double_click_count
;
2442 #ifdef USE_X_TOOLKIT
2443 extern Lisp_Object
map_event_to_object ();
2444 #endif /* USE_X_TOOLKIT */
2446 /* Given a struct input_event, build the lisp event which represents
2447 it. If EVENT is 0, build a mouse movement event from the mouse
2448 movement buffer, which should have a movement event in it.
2450 Note that events must be passed to this function in the order they
2451 are received; this function stores the location of button presses
2452 in order to build drag events when the button is released. */
2455 make_lispy_event (event
)
2456 struct input_event
*event
;
2460 #ifdef SWITCH_ENUM_BUG
2461 switch ((int) event
->kind
)
2463 switch (event
->kind
)
2466 /* A simple keystroke. */
2467 case ascii_keystroke
:
2469 int c
= event
->code
& 0377;
2470 /* Turn ASCII characters into control characters
2472 if (event
->modifiers
& ctrl_modifier
)
2473 c
= make_ctrl_char (c
);
2475 /* Add in the other modifier bits. We took care of ctrl_modifier
2476 just above, and the shift key was taken care of by the X code,
2477 and applied to control characters by make_ctrl_char. */
2478 c
|= (event
->modifiers
2479 & (meta_modifier
| alt_modifier
2480 | hyper_modifier
| super_modifier
));
2481 button_down_time
= 0;
2485 /* A function key. The symbol may need to have modifier prefixes
2487 case non_ascii_keystroke
:
2488 button_down_time
= 0;
2490 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
2491 if (event
->code
== lispy_accent_codes
[i
])
2492 return modify_event_symbol (i
,
2494 Qfunction_key
, Qnil
,
2495 lispy_accent_keys
, &accent_key_syms
,
2496 (sizeof (lispy_accent_keys
)
2497 / sizeof (lispy_accent_keys
[0])));
2499 /* Handle system-specific keysyms. */
2500 if (event
->code
& (1 << 28))
2502 /* We need to use an alist rather than a vector as the cache
2503 since we can't make a vector long enuf. */
2504 if (NILP (system_key_syms
))
2505 system_key_syms
= Fcons (Qnil
, Qnil
);
2506 return modify_event_symbol (event
->code
& 0xffffff,
2508 Qfunction_key
, Vsystem_key_alist
,
2509 0, &system_key_syms
, 0xffffff);
2512 return modify_event_symbol (event
->code
- 0xff00,
2514 Qfunction_key
, Qnil
,
2515 lispy_function_keys
, &func_key_syms
,
2516 (sizeof (lispy_function_keys
)
2517 / sizeof (lispy_function_keys
[0])));
2520 #if defined(MULTI_FRAME) || defined(HAVE_MOUSE)
2521 /* A mouse click. Figure out where it is, decide whether it's
2522 a press, click or drag, and build the appropriate structure. */
2524 case scroll_bar_click
:
2526 int button
= event
->code
;
2528 Lisp_Object position
;
2529 Lisp_Object
*start_pos_ptr
;
2530 Lisp_Object start_pos
;
2532 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2535 /* Build the position as appropriate for this mouse click. */
2536 if (event
->kind
== mouse_click
)
2539 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2544 /* Ignore mouse events that were made on frame that
2545 have been deleted. */
2546 if (! FRAME_LIVE_P (f
))
2549 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
2550 &column
, &row
, 0, 0);
2552 #ifdef USE_X_TOOLKIT
2553 if (FRAME_EXTERNAL_MENU_BAR (f
) && XINT (event
->y
) == -1)
2555 if (row
< FRAME_MENU_BAR_LINES (f
))
2558 Lisp_Object items
, item
;
2560 #ifdef USE_X_TOOLKIT
2561 /* The click happened in the menubar.
2562 Look for the menu item selected. */
2563 item
= map_event_to_object (event
, f
);
2565 XFASTINT (event
->y
) = 1;
2566 #else /* not USE_X_TOOLKIT */
2571 items
= FRAME_MENU_BAR_ITEMS (f
);
2572 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 3)
2574 Lisp_Object pos
, string
;
2575 string
= XVECTOR (items
)->contents
[i
+ 1];
2576 pos
= XVECTOR (items
)->contents
[i
+ 2];
2579 if (column
>= XINT (pos
)
2580 && column
< XINT (pos
) + XSTRING (string
)->size
)
2582 item
= XVECTOR (items
)->contents
[i
];
2586 #endif /* not USE_X_TOOLKIT */
2589 = Fcons (event
->frame_or_window
,
2591 Fcons (Fcons (event
->x
, event
->y
),
2592 Fcons (make_number (event
->timestamp
),
2595 return Fcons (item
, Fcons (position
, Qnil
));
2598 window
= window_from_coordinates (f
, column
, row
, &part
);
2600 if (XTYPE (window
) != Lisp_Window
)
2604 int pixcolumn
, pixrow
;
2605 column
-= XINT (XWINDOW (window
)->left
);
2606 row
-= XINT (XWINDOW (window
)->top
);
2607 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
2608 XSETINT (event
->x
, pixcolumn
);
2609 XSETINT (event
->y
, pixrow
);
2614 posn
= Qvertical_line
;
2616 XSET (posn
, Lisp_Int
,
2617 buffer_posn_from_coords (XWINDOW (window
),
2624 Fcons (Fcons (event
->x
, event
->y
),
2625 Fcons (make_number (event
->timestamp
),
2631 Lisp_Object portion_whole
;
2634 window
= event
->frame_or_window
;
2635 portion_whole
= Fcons (event
->x
, event
->y
);
2636 part
= *scroll_bar_parts
[(int) event
->part
];
2640 Fcons (Qvertical_scroll_bar
,
2641 Fcons (portion_whole
,
2642 Fcons (make_number (event
->timestamp
),
2643 Fcons (part
, Qnil
)))));
2646 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2648 start_pos
= *start_pos_ptr
;
2649 *start_pos_ptr
= Qnil
;
2651 is_double
= (button
== last_mouse_button
2652 && XINT (event
->x
) == last_mouse_x
2653 && XINT (event
->y
) == last_mouse_y
2654 && button_down_time
!= 0
2655 && (EQ (Vdouble_click_time
, Qt
)
2656 || (INTEGERP (Vdouble_click_time
)
2657 && ((int)(event
->timestamp
- button_down_time
)
2658 < XINT (Vdouble_click_time
)))));
2659 last_mouse_button
= button
;
2660 last_mouse_x
= XINT (event
->x
);
2661 last_mouse_y
= XINT (event
->y
);
2663 /* If this is a button press, squirrel away the location, so
2664 we can decide later whether it was a click or a drag. */
2665 if (event
->modifiers
& down_modifier
)
2669 double_click_count
++;
2670 event
->modifiers
|= ((double_click_count
> 2)
2675 double_click_count
= 1;
2676 button_down_time
= event
->timestamp
;
2677 *start_pos_ptr
= Fcopy_alist (position
);
2680 /* Now we're releasing a button - check the co-ordinates to
2681 see if this was a click or a drag. */
2682 else if (event
->modifiers
& up_modifier
)
2684 /* If we did not see a down before this up,
2685 ignore the up. Probably this happened because
2686 the down event chose a menu item.
2687 It would be an annoyance to treat the release
2688 of the button that chose the menu item
2689 as a separate event. */
2691 if (XTYPE (start_pos
) != Lisp_Cons
)
2694 event
->modifiers
&= ~up_modifier
;
2695 #if 0 /* Formerly we treated an up with no down as a click event. */
2696 if (XTYPE (start_pos
) != Lisp_Cons
)
2697 event
->modifiers
|= click_modifier
;
2701 /* The third element of every position should be the (x,y)
2705 down
= Fnth (make_number (2), start_pos
);
2706 if (EQ (event
->x
, XCONS (down
)->car
)
2707 && EQ (event
->y
, XCONS (down
)->cdr
))
2709 if (is_double
&& double_click_count
> 1)
2710 event
->modifiers
|= ((double_click_count
> 2)
2714 event
->modifiers
|= click_modifier
;
2718 button_down_time
= 0;
2719 event
->modifiers
|= drag_modifier
;
2724 /* Every mouse event should either have the down_modifier or
2725 the up_modifier set. */
2729 /* Get the symbol we should use for the mouse click. */
2732 head
= modify_event_symbol (button
,
2735 lispy_mouse_names
, &mouse_syms
,
2736 (sizeof (lispy_mouse_names
)
2737 / sizeof (lispy_mouse_names
[0])));
2738 if (event
->modifiers
& drag_modifier
)
2743 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2746 Fcons (make_number (double_click_count
),
2754 #endif /* MULTI_FRAME or HAVE_MOUSE */
2756 /* The 'kind' field of the event is something we don't recognize. */
2765 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2767 Lisp_Object bar_window
;
2768 enum scroll_bar_part part
;
2772 /* Is it a scroll bar movement? */
2773 if (frame
&& ! NILP (bar_window
))
2775 Lisp_Object part_sym
;
2777 part_sym
= *scroll_bar_parts
[(int) part
];
2778 return Fcons (Qscroll_bar_movement
,
2779 (Fcons (Fcons (bar_window
,
2780 Fcons (Qvertical_scroll_bar
,
2781 Fcons (Fcons (x
, y
),
2782 Fcons (make_number (time
),
2788 /* Or is it an ordinary mouse movement? */
2798 /* It's in a frame; which window on that frame? */
2799 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
, 0, 1);
2800 window
= window_from_coordinates (frame
, column
, row
, &area
);
2805 if (XTYPE (window
) == Lisp_Window
)
2807 int pixcolumn
, pixrow
;
2808 column
-= XINT (XWINDOW (window
)->left
);
2809 row
-= XINT (XWINDOW (window
)->top
);
2810 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
2811 XSETINT (x
, pixcolumn
);
2812 XSETINT (y
, pixrow
);
2817 posn
= Qvertical_line
;
2819 XSET (posn
, Lisp_Int
,
2820 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
2822 else if (frame
!= 0)
2824 XSET (window
, Lisp_Frame
, frame
);
2835 return Fcons (Qmouse_movement
,
2836 Fcons (Fcons (window
,
2838 Fcons (Fcons (x
, y
),
2839 Fcons (make_number (time
),
2845 #endif /* MULTI_FRAME */
2847 /* Construct a switch frame event. */
2849 make_lispy_switch_frame (frame
)
2852 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
2855 /* Manipulating modifiers. */
2857 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
2859 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2860 SYMBOL's name of the end of the modifiers; the string from this
2861 position is the unmodified symbol name.
2863 This doesn't use any caches. */
2865 parse_modifiers_uncached (symbol
, modifier_end
)
2869 struct Lisp_String
*name
;
2873 CHECK_SYMBOL (symbol
, 1);
2876 name
= XSYMBOL (symbol
)->name
;
2879 for (i
= 0; i
+2 <= name
->size
; )
2880 switch (name
->data
[i
])
2882 #define SINGLE_LETTER_MOD(bit) \
2883 if (name->data[i+1] != '-') \
2884 goto no_more_modifiers; \
2889 SINGLE_LETTER_MOD (alt_modifier
);
2893 SINGLE_LETTER_MOD (ctrl_modifier
);
2897 SINGLE_LETTER_MOD (hyper_modifier
);
2901 SINGLE_LETTER_MOD (meta_modifier
);
2905 SINGLE_LETTER_MOD (shift_modifier
);
2909 SINGLE_LETTER_MOD (super_modifier
);
2913 if (i
+ 5 > name
->size
)
2914 goto no_more_modifiers
;
2915 if (! strncmp (name
->data
+ i
, "drag-", 5))
2917 modifiers
|= drag_modifier
;
2920 else if (! strncmp (name
->data
+ i
, "down-", 5))
2922 modifiers
|= down_modifier
;
2925 else if (i
+ 7 <= name
->size
2926 && ! strncmp (name
->data
+ i
, "double-", 7))
2928 modifiers
|= double_modifier
;
2932 goto no_more_modifiers
;
2936 if (i
+ 7 > name
->size
)
2937 goto no_more_modifiers
;
2938 if (! strncmp (name
->data
+ i
, "triple-", 7))
2940 modifiers
|= triple_modifier
;
2944 goto no_more_modifiers
;
2948 goto no_more_modifiers
;
2950 #undef SINGLE_LETTER_MOD
2954 /* Should we include the `click' modifier? */
2955 if (! (modifiers
& (down_modifier
| drag_modifier
2956 | double_modifier
| triple_modifier
))
2957 && i
+ 7 == name
->size
2958 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
2959 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
2960 modifiers
|= click_modifier
;
2969 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
2970 prepended to the string BASE[0..BASE_LEN-1].
2971 This doesn't use any caches. */
2973 apply_modifiers_uncached (modifiers
, base
, base_len
)
2978 /* Since BASE could contain nulls, we can't use intern here; we have
2979 to use Fintern, which expects a genuine Lisp_String, and keeps a
2982 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
2988 /* Only the event queue may use the `up' modifier; it should always
2989 be turned into a click or drag event before presented to lisp code. */
2990 if (modifiers
& up_modifier
)
2993 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
2994 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
2995 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
2996 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
2997 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
2998 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
2999 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
3000 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
3001 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
3002 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
3003 /* The click modifier is denoted by the absence of other modifiers. */
3007 mod_len
= p
- new_mods
;
3011 Lisp_Object new_name
;
3013 new_name
= make_uninit_string (mod_len
+ base_len
);
3014 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
3015 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
3017 return Fintern (new_name
, Qnil
);
3022 static char *modifier_names
[] =
3024 "up", "down", "drag", "click", "double", "triple", 0, 0,
3025 0, 0, 0, 0, 0, 0, 0, 0,
3026 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
3028 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
3030 static Lisp_Object modifier_symbols
;
3032 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
3034 lispy_modifier_list (modifiers
)
3037 Lisp_Object modifier_list
;
3040 modifier_list
= Qnil
;
3041 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
3042 if (modifiers
& (1<<i
))
3043 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
3046 return modifier_list
;
3050 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
3051 where UNMODIFIED is the unmodified form of SYMBOL,
3052 MASK is the set of modifiers present in SYMBOL's name.
3053 This is similar to parse_modifiers_uncached, but uses the cache in
3054 SYMBOL's Qevent_symbol_element_mask property, and maintains the
3055 Qevent_symbol_elements property. */
3057 parse_modifiers (symbol
)
3060 Lisp_Object elements
;
3062 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
3063 if (CONSP (elements
))
3068 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
3069 Lisp_Object unmodified
;
3072 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
3073 XSYMBOL (symbol
)->name
->size
- end
),
3076 if (modifiers
& ~((1<<VALBITS
) - 1))
3078 XFASTINT (mask
) = modifiers
;
3079 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
3081 /* Cache the parsing results on SYMBOL. */
3082 Fput (symbol
, Qevent_symbol_element_mask
,
3084 Fput (symbol
, Qevent_symbol_elements
,
3085 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
3087 /* Since we know that SYMBOL is modifiers applied to unmodified,
3088 it would be nice to put that in unmodified's cache.
3089 But we can't, since we're not sure that parse_modifiers is
3096 /* Apply the modifiers MODIFIERS to the symbol BASE.
3097 BASE must be unmodified.
3099 This is like apply_modifiers_uncached, but uses BASE's
3100 Qmodifier_cache property, if present. It also builds
3101 Qevent_symbol_elements properties, since it has that info anyway.
3103 apply_modifiers copies the value of BASE's Qevent_kind property to
3104 the modified symbol. */
3106 apply_modifiers (modifiers
, base
)
3110 Lisp_Object cache
, index
, entry
, new_symbol
;
3112 /* Mask out upper bits. We don't know where this value's been. */
3113 modifiers
&= (1<<VALBITS
) - 1;
3115 /* The click modifier never figures into cache indices. */
3116 cache
= Fget (base
, Qmodifier_cache
);
3117 XFASTINT (index
) = (modifiers
& ~click_modifier
);
3118 entry
= Fassq (index
, cache
);
3121 new_symbol
= XCONS (entry
)->cdr
;
3124 /* We have to create the symbol ourselves. */
3125 new_symbol
= apply_modifiers_uncached (modifiers
,
3126 XSYMBOL (base
)->name
->data
,
3127 XSYMBOL (base
)->name
->size
);
3129 /* Add the new symbol to the base's cache. */
3130 entry
= Fcons (index
, new_symbol
);
3131 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
3133 /* We have the parsing info now for free, so add it to the caches. */
3134 XFASTINT (index
) = modifiers
;
3135 Fput (new_symbol
, Qevent_symbol_element_mask
,
3136 Fcons (base
, Fcons (index
, Qnil
)));
3137 Fput (new_symbol
, Qevent_symbol_elements
,
3138 Fcons (base
, lispy_modifier_list (modifiers
)));
3141 /* Make sure this symbol is of the same kind as BASE.
3143 You'd think we could just set this once and for all when we
3144 intern the symbol above, but reorder_modifiers may call us when
3145 BASE's property isn't set right; we can't assume that just
3146 because it has a Qmodifier_cache property it must have its
3147 Qevent_kind set right as well. */
3148 if (NILP (Fget (new_symbol
, Qevent_kind
)))
3152 kind
= Fget (base
, Qevent_kind
);
3154 Fput (new_symbol
, Qevent_kind
, kind
);
3161 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
3162 return a symbol with the modifiers placed in the canonical order.
3163 Canonical order is alphabetical, except for down and drag, which
3164 always come last. The 'click' modifier is never written out.
3166 Fdefine_key calls this to make sure that (for example) C-M-foo
3167 and M-C-foo end up being equivalent in the keymap. */
3170 reorder_modifiers (symbol
)
3173 /* It's hopefully okay to write the code this way, since everything
3174 will soon be in caches, and no consing will be done at all. */
3177 parsed
= parse_modifiers (symbol
);
3178 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
3179 XCONS (parsed
)->car
);
3183 /* For handling events, we often want to produce a symbol whose name
3184 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
3185 to some base, like the name of a function key or mouse button.
3186 modify_event_symbol produces symbols of this sort.
3188 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
3189 is the name of the i'th symbol. TABLE_SIZE is the number of elements
3192 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
3193 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
3195 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
3196 persist between calls to modify_event_symbol that it can use to
3197 store a cache of the symbols it's generated for this NAME_TABLE
3198 before. The object stored there may be a vector or an alist.
3200 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
3202 MODIFIERS is a set of modifier bits (as given in struct input_events)
3203 whose prefixes should be applied to the symbol name.
3205 SYMBOL_KIND is the value to be placed in the event_kind property of
3206 the returned symbol.
3208 The symbols we create are supposed to have an
3209 `event-symbol-elements' property, which lists the modifiers present
3210 in the symbol's name. */
3213 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
3214 name_table
, symbol_table
, table_size
)
3217 Lisp_Object symbol_kind
;
3218 Lisp_Object name_alist
;
3220 Lisp_Object
*symbol_table
;
3224 Lisp_Object symbol_int
;
3226 XSET (symbol_int
, Lisp_Int
, symbol_num
);
3228 /* Is this a request for a valid symbol? */
3229 if (symbol_num
< 0 || symbol_num
>= table_size
)
3232 if (CONSP (*symbol_table
))
3233 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
3235 /* If *symbol_table doesn't seem to be initialized properly, fix that.
3236 *symbol_table should be a lisp vector TABLE_SIZE elements long,
3237 where the Nth element is the symbol for NAME_TABLE[N], or nil if
3238 we've never used that symbol before. */
3241 if (! VECTORP (*symbol_table
)
3242 || XVECTOR (*symbol_table
)->size
!= table_size
)
3246 XFASTINT (size
) = table_size
;
3247 *symbol_table
= Fmake_vector (size
, Qnil
);
3250 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
3253 /* Have we already used this symbol before? */
3256 /* No; let's create it. */
3257 if (!NILP (name_alist
))
3258 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
3259 else if (name_table
[symbol_num
])
3260 value
= intern (name_table
[symbol_num
]);
3265 sprintf (buf
, "key-%d", symbol_num
);
3266 value
= intern (buf
);
3269 if (CONSP (*symbol_table
))
3270 *symbol_table
= Fcons (value
, *symbol_table
);
3272 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
3274 /* Fill in the cache entries for this symbol; this also
3275 builds the Qevent_symbol_elements property, which the user
3277 apply_modifiers (modifiers
& click_modifier
, value
);
3278 Fput (value
, Qevent_kind
, symbol_kind
);
3281 /* Apply modifiers to that symbol. */
3282 return apply_modifiers (modifiers
, value
);
3286 /* Store into *addr a value nonzero if terminal input chars are available.
3287 Serves the purpose of ioctl (0, FIONREAD, addr)
3288 but works even if FIONREAD does not exist.
3289 (In fact, this may actually read some input.) */
3292 get_input_pending (addr
)
3295 /* First of all, have we already counted some input? */
3296 *addr
= !NILP (Vquit_flag
) || readable_events ();
3298 /* If input is being read as it arrives, and we have none, there is none. */
3299 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
3302 /* Try to read some input and see how much we get. */
3304 *addr
= !NILP (Vquit_flag
) || readable_events ();
3307 /* Interface to read_avail_input, blocking SIGIO if necessary. */
3310 gobble_input (expected
)
3315 if (interrupt_input
)
3318 mask
= sigblockx (SIGIO
);
3319 read_avail_input (expected
);
3324 read_avail_input (expected
);
3328 /* Put a buffer_switch_event in the buffer
3329 so that read_key_sequence will notice the new current buffer. */
3331 record_asynch_buffer_change ()
3333 struct input_event event
;
3334 event
.kind
= buffer_switch_event
;
3335 event
.frame_or_window
= Qnil
;
3337 /* Make sure no interrupt happens while storing the event. */
3339 if (interrupt_input
)
3342 mask
= sigblockx (SIGIO
);
3343 kbd_buffer_store_event (&event
);
3350 kbd_buffer_store_event (&event
);
3357 /* Read any terminal input already buffered up by the system
3358 into the kbd_buffer, but do not wait.
3360 EXPECTED should be nonzero if the caller knows there is some input.
3362 Except on VMS, all input is read by this function.
3363 If interrupt_input is nonzero, this function MUST be called
3364 only when SIGIO is blocked.
3366 Returns the number of keyboard chars read, or -1 meaning
3367 this is a bad time to try to read input. */
3370 read_avail_input (expected
)
3373 struct input_event buf
[KBD_BUFFER_SIZE
];
3377 if (read_socket_hook
)
3378 /* No need for FIONREAD or fcntl; just say don't wait. */
3379 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
3382 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
3383 the kbd_buffer can really hold. That may prevent loss
3384 of characters on some systems when input is stuffed at us. */
3385 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
3388 /* Determine how many characters we should *try* to read. */
3390 n_to_read
= dos_keysns ();
3393 #else /* not MSDOS */
3395 /* Find out how much input is available. */
3396 if (ioctl (0, FIONREAD
, &n_to_read
) < 0)
3397 /* Formerly simply reported no input, but that sometimes led to
3398 a failure of Emacs to terminate.
3399 SIGHUP seems appropriate if we can't reach the terminal. */
3400 /* ??? Is it really right to send the signal just to this process
3401 rather than to the whole process group?
3402 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3403 kill (getpid (), SIGHUP
);
3406 if (n_to_read
> sizeof cbuf
)
3407 n_to_read
= sizeof cbuf
;
3408 #else /* no FIONREAD */
3409 #if defined(USG) || defined(DGUX)
3410 /* Read some input if available, but don't wait. */
3411 n_to_read
= sizeof cbuf
;
3412 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
3417 #endif /* not MSDOS */
3419 /* Now read; for one reason or another, this will not block.
3420 NREAD is set to the number of chars read. */
3424 cbuf
[0] = dos_keyread();
3427 nread
= read (fileno (stdin
), cbuf
, n_to_read
);
3429 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
3430 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3431 This looks incorrect, but it isn't, because _BSD causes
3432 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3433 and that causes a value other than 0 when there is no input. */
3439 /* We used to retry the read if it was interrupted.
3440 But this does the wrong thing when O_NDELAY causes
3441 an EAGAIN error. Does anybody know of a situation
3442 where a retry is actually needed? */
3444 nread
< 0 && (errno
== EAGAIN
3458 #if defined (USG) || defined (DGUX)
3459 fcntl (fileno (stdin
), F_SETFL
, 0);
3460 #endif /* USG or DGUX */
3461 #endif /* no FIONREAD */
3462 for (i
= 0; i
< nread
; i
++)
3464 buf
[i
].kind
= ascii_keystroke
;
3465 buf
[i
].modifiers
= 0;
3466 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3467 buf
[i
].modifiers
= meta_modifier
;
3471 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
3473 XSET (buf
[i
].frame_or_window
, Lisp_Frame
, selected_frame
);
3475 buf
[i
].frame_or_window
= Qnil
;
3480 /* Scan the chars for C-g and store them in kbd_buffer. */
3481 for (i
= 0; i
< nread
; i
++)
3483 kbd_buffer_store_event (&buf
[i
]);
3484 /* Don't look at input that follows a C-g too closely.
3485 This reduces lossage due to autorepeat on C-g. */
3486 if (buf
[i
].kind
== ascii_keystroke
3487 && XINT(buf
[i
].code
) == quit_char
)
3493 #endif /* not VMS */
3495 #ifdef SIGIO /* for entire page */
3496 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3499 input_available_signal (signo
)
3502 /* Must preserve main program's value of errno. */
3503 int old_errno
= errno
;
3505 extern int select_alarmed
;
3509 /* USG systems forget handlers when they are used;
3510 must reestablish each time */
3511 signal (signo
, input_available_signal
);
3518 if (input_available_clear_time
)
3519 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3524 nread
= read_avail_input (1);
3525 /* -1 means it's not ok to read the input now.
3526 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3527 0 means there was no keyboard input available. */
3532 select_alarmed
= 1; /* Force the select emulator back to life */
3543 /* Send ourselves a SIGIO.
3545 This function exists so that the UNBLOCK_INPUT macro in
3546 blockinput.h can have some way to take care of input we put off
3547 dealing with, without assuming that every file which uses
3548 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3550 reinvoke_input_signal ()
3559 /* Return the prompt-string of a sparse keymap.
3560 This is the first element which is a string.
3561 Return nil if there is none. */
3569 register Lisp_Object tem
;
3571 if (XTYPE (tem
) == Lisp_String
)
3578 static void menu_bar_item ();
3579 static void menu_bar_one_keymap ();
3581 /* These variables hold the vector under construction within
3582 menu_bar_items and its subroutines, and the current index
3583 for storing into that vector. */
3584 static Lisp_Object menu_bar_items_vector
;
3585 static Lisp_Object menu_bar_items_index
;
3587 /* Return a vector of menu items for a menu bar, appropriate
3588 to the current buffer. Each item has three elements in the vector:
3591 OLD is an old vector we can optionally reuse, or nil. */
3594 menu_bar_items (old
)
3597 /* The number of keymaps we're scanning right now, and the number of
3598 keymaps we have allocated space for. */
3601 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3602 in the current keymaps, or nil where it is not a prefix. */
3605 Lisp_Object def
, tem
, tail
;
3614 struct gcpro gcpro1
;
3616 /* In order to build the menus, we need to call the keymap
3617 accessors. They all call QUIT. But this function is called
3618 during redisplay, during which a quit is fatal. So inhibit
3619 quitting while building the menus.
3620 We do this instead of specbind because (1) errors will clear it anyway
3621 and (2) this avoids risk of specpdl overflow. */
3622 oquit
= Vinhibit_quit
;
3626 menu_bar_items_vector
= old
;
3628 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
3629 menu_bar_items_index
= 0;
3631 GCPRO1 (menu_bar_items_vector
);
3633 /* Build our list of keymaps.
3634 If we recognize a function key and replace its escape sequence in
3635 keybuf with its symbol, or if the sequence starts with a mouse
3636 click and we need to switch buffers, we jump back here to rebuild
3637 the initial keymaps from the current buffer. */
3641 if (!NILP (Voverriding_local_map
))
3644 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3645 maps
[0] = Voverriding_local_map
;
3649 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3650 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3651 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3652 #ifdef USE_TEXT_PROPERTIES
3653 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3655 maps
[nmaps
-2] = current_buffer
->keymap
;
3658 maps
[nmaps
-1] = current_global_map
;
3661 /* Look up in each map the dummy prefix key `menu-bar'. */
3665 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3667 if (! NILP (maps
[mapno
]))
3668 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3672 tem
= Fkeymapp (def
);
3674 menu_bar_one_keymap (def
);
3677 /* Move to the end those items that should be at the end. */
3679 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3682 int end
= menu_bar_items_index
;
3684 for (i
= 0; i
< end
; i
+= 3)
3685 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3687 Lisp_Object tem0
, tem1
, tem2
;
3688 /* Move the item at index I to the end,
3689 shifting all the others forward. */
3690 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
3691 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
3692 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
3694 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
3695 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
3696 (end
- i
- 3) * sizeof (Lisp_Object
));
3697 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem0
;
3698 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem1
;
3699 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem2
;
3704 /* Add nil, nil, nil at the end. */
3705 i
= menu_bar_items_index
;
3706 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
3709 int newsize
= 2 * i
;
3710 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
3711 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
3712 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
3713 menu_bar_items_vector
= tem
;
3715 /* Add this item. */
3716 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3717 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3718 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3719 menu_bar_items_index
= i
;
3721 Vinhibit_quit
= oquit
;
3723 return menu_bar_items_vector
;
3726 /* Scan one map KEYMAP, accumulating any menu items it defines
3727 in menu_bar_items_vector. */
3730 menu_bar_one_keymap (keymap
)
3733 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3735 /* Loop over all keymap entries that have menu strings. */
3736 for (tail
= keymap
; XTYPE (tail
) == Lisp_Cons
; tail
= XCONS (tail
)->cdr
)
3738 item
= XCONS (tail
)->car
;
3739 if (XTYPE (item
) == Lisp_Cons
)
3741 key
= XCONS (item
)->car
;
3742 binding
= XCONS (item
)->cdr
;
3743 if (XTYPE (binding
) == Lisp_Cons
)
3745 item_string
= XCONS (binding
)->car
;
3746 if (XTYPE (item_string
) == Lisp_String
)
3747 menu_bar_item (key
, item_string
, Fcdr (binding
));
3749 else if (EQ (binding
, Qundefined
))
3750 menu_bar_item (key
, item_string
, binding
);
3752 else if (XTYPE (item
) == Lisp_Vector
)
3754 /* Loop over the char values represented in the vector. */
3755 int len
= XVECTOR (item
)->size
;
3757 for (c
= 0; c
< len
; c
++)
3759 Lisp_Object character
;
3760 XFASTINT (character
) = c
;
3761 binding
= XVECTOR (item
)->contents
[c
];
3762 if (XTYPE (binding
) == Lisp_Cons
)
3764 item_string
= XCONS (binding
)->car
;
3765 if (XTYPE (item_string
) == Lisp_String
)
3766 menu_bar_item (key
, item_string
, Fcdr (binding
));
3768 else if (EQ (binding
, Qundefined
))
3769 menu_bar_item (key
, item_string
, binding
);
3775 /* This is used as the handler when calling internal_condition_case_1. */
3778 menu_bar_item_1 (arg
)
3784 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
3785 If there's already an item for KEY, add this DEF to it. */
3788 menu_bar_item (key
, item_string
, def
)
3789 Lisp_Object key
, item_string
, def
;
3792 Lisp_Object enabled
;
3795 if (EQ (def
, Qundefined
))
3797 /* If a map has an explicit `undefined' as definition,
3798 discard any previously made menu bar item. */
3800 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
3801 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3803 if (menu_bar_items_index
> i
+ 3)
3804 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
3805 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
3806 (menu_bar_items_index
- i
- 3) * sizeof (Lisp_Object
));
3807 menu_bar_items_index
-= 3;
3812 /* See if this entry is enabled. */
3815 if (XTYPE (def
) == Lisp_Symbol
)
3817 /* No property, or nil, means enable.
3818 Otherwise, enable if value is not nil. */
3819 tem
= Fget (def
, Qmenu_enable
);
3821 /* (condition-case nil (eval tem)
3823 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
3827 /* Ignore this item if it's not enabled. */
3831 /* Find any existing item for this KEY. */
3832 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
3833 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3836 /* If we did not find this KEY, add it at the end. */
3837 if (i
== menu_bar_items_index
)
3839 /* If vector is too small, get a bigger one. */
3840 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
3843 int newsize
= 2 * i
;
3844 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
3845 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
3846 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
3847 menu_bar_items_vector
= tem
;
3849 /* Add this item. */
3850 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
3851 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
3852 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (def
, Qnil
);
3853 menu_bar_items_index
= i
;
3855 /* We did find an item for this KEY. Add DEF to its list of maps. */
3859 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
3860 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (def
, old
);
3864 /* Read a character using menus based on maps in the array MAPS.
3865 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
3866 Return t if we displayed a menu but the user rejected it.
3868 PREV_EVENT is the previous input event, or nil if we are reading
3869 the first event of a key sequence.
3871 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3872 if we used a mouse menu to read the input, or zero otherwise. If
3873 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
3875 The prompting is done based on the prompt-string of the map
3876 and the strings associated with various map elements.
3878 This can be done with X menus or with menus put in the minibuf.
3879 These are done in different ways, depending on how the input will be read.
3880 Menus using X are done after auto-saving in read-char, getting the input
3881 event from Fx_popup_menu; menus using the minibuf use read_char recursively
3882 and do auto-saving in the inner call of read_char. */
3885 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
3888 Lisp_Object prev_event
;
3889 int *used_mouse_menu
;
3892 register Lisp_Object name
;
3893 Lisp_Object rest
, vector
;
3895 if (used_mouse_menu
)
3896 *used_mouse_menu
= 0;
3898 /* Use local over global Menu maps */
3900 if (! menu_prompting
)
3903 /* Get the menu name from the first map that has one (a prompt string). */
3904 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3906 name
= map_prompt (maps
[mapno
]);
3911 /* If we don't have any menus, just read a character normally. */
3915 #ifdef HAVE_X_WINDOWS
3917 /* If we got to this point via a mouse click,
3918 use a real menu for mouse selection. */
3919 if (EVENT_HAS_PARAMETERS (prev_event
))
3921 /* Display the menu and get the selection. */
3922 Lisp_Object
*realmaps
3923 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
3927 /* Use the maps that are not nil. */
3928 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3929 if (!NILP (maps
[mapno
]))
3930 realmaps
[nmaps1
++] = maps
[mapno
];
3932 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
3935 /* If we got more than one event, put all but the first
3936 onto this list to be read later.
3937 Return just the first event now. */
3938 Vunread_command_events
3939 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
3940 value
= XCONS (value
)->car
;
3942 else if (NILP (value
))
3944 if (used_mouse_menu
)
3945 *used_mouse_menu
= 1;
3948 #endif /* HAVE_X_MENU */
3949 #endif /* HAVE_X_WINDOWS */
3954 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
3960 register Lisp_Object name
;
3962 int width
= FRAME_WIDTH (selected_frame
) - 4;
3963 char *menu
= (char *) alloca (width
+ 4);
3966 Lisp_Object rest
, vector
;
3968 if (! menu_prompting
)
3971 /* Get the menu name from the first map that has one (a prompt string). */
3972 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3974 name
= map_prompt (maps
[mapno
]);
3979 /* If we don't have any menus, just read a character normally. */
3983 /* Prompt string always starts with map's prompt, and a space. */
3984 strcpy (menu
, XSTRING (name
)->data
);
3985 nlength
= XSTRING (name
)->size
;
3986 menu
[nlength
++] = ':';
3987 menu
[nlength
++] = ' ';
3990 /* Start prompting at start of first map. */
3994 /* Present the documented bindings, a line at a time. */
4001 int orig_defn_macro
;
4003 /* Loop over elements of map. */
4008 /* If reached end of map, start at beginning of next map. */
4012 /* At end of last map, wrap around to first map if just starting,
4013 or end this line if already have something on it. */
4017 if (notfirst
|| nobindings
) break;
4022 /* Look at the next element of the map. */
4024 elt
= XVECTOR (vector
)->contents
[idx
];
4026 elt
= Fcar_safe (rest
);
4028 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
4030 /* If we found a dense table in the keymap,
4031 advanced past it, but start scanning its contents. */
4032 rest
= Fcdr_safe (rest
);
4038 /* An ordinary element. */
4040 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
4042 s
= Fcar_safe(elt
); /* vector */
4043 if (XTYPE (s
) != Lisp_String
)
4044 /* Ignore the element if it has no prompt string. */
4046 /* If we have room for the prompt string, add it to this line.
4047 If this is the first on the line, always add it. */
4048 else if (XSTRING (s
)->size
+ i
+ 2 < width
4053 /* Punctuate between strings. */
4056 strcpy (menu
+ i
, ", ");
4062 /* Add as much of string as fits. */
4063 thiswidth
= XSTRING (s
)->size
;
4064 if (thiswidth
+ i
> width
)
4065 thiswidth
= width
- i
;
4066 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
4072 /* If this element does not fit, end the line now,
4073 and save the element for the next line. */
4074 strcpy (menu
+ i
, "...");
4078 /* Move past this element. */
4079 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
4080 /* Handle reaching end of dense table. */
4085 rest
= Fcdr_safe (rest
);
4089 /* Prompt with that and read response. */
4092 /* Make believe its not a keyboard macro in case the help char
4093 is pressed. Help characters are not recorded because menu prompting
4094 is not used on replay.
4096 orig_defn_macro
= defining_kbd_macro
;
4097 defining_kbd_macro
= 0 ;
4099 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
4100 while (XTYPE (obj
) == Lisp_Buffer
);
4101 defining_kbd_macro
= orig_defn_macro
;
4103 if (XTYPE (obj
) != Lisp_Int
)
4108 if (! EQ (obj
, menu_prompt_more_char
)
4109 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
4110 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
4112 if ( defining_kbd_macro
)
4113 store_kbd_macro_char(obj
) ;
4116 /* Help char - go round again */
4120 /* Reading key sequences. */
4122 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
4123 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
4124 keymap, or nil otherwise. Return the index of the first keymap in
4125 which KEY has any binding, or NMAPS if no map has a binding.
4127 If KEY is a meta ASCII character, treat it like meta-prefix-char
4128 followed by the corresponding non-meta character. Keymaps in
4129 CURRENT with non-prefix bindings for meta-prefix-char become nil in
4132 When KEY is not defined in any of the keymaps, if it is an upper
4133 case letter and there are bindings for the corresponding lower-case
4134 letter, return the bindings for the lower-case letter.
4135 We store 1 in *CASE_CONVERTED in this case.
4136 Otherwise, we don't change *CASE_CONVERTED.
4138 If KEY has no bindings in any of the CURRENT maps, NEXT is left
4141 NEXT may == CURRENT. */
4144 follow_key (key
, nmaps
, current
, defs
, next
, case_converted
)
4146 Lisp_Object
*current
, *defs
, *next
;
4148 int *case_converted
;
4150 int i
, first_binding
;
4152 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
4153 followed by the corresponding non-meta character. */
4154 if (XTYPE (key
) == Lisp_Int
&& (XINT (key
) & CHAR_META
))
4156 for (i
= 0; i
< nmaps
; i
++)
4157 if (! NILP (current
[i
]))
4160 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
4162 /* Note that since we pass the resulting bindings through
4163 get_keymap_1, non-prefix bindings for meta-prefix-char
4165 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
4171 XSET (key
, Lisp_Int
, XFASTINT (key
) & ~CHAR_META
);
4174 first_binding
= nmaps
;
4175 for (i
= nmaps
- 1; i
>= 0; i
--)
4177 if (! NILP (current
[i
]))
4179 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
4180 if (! NILP (defs
[i
]))
4187 /* When KEY is not defined in any of the keymaps, if it is an upper
4188 case letter and there are bindings for the corresponding
4189 lower-case letter, return the bindings for the lower-case letter. */
4190 if (first_binding
== nmaps
4191 && XTYPE (key
) == Lisp_Int
4192 && ((((XINT (key
) & 0x3ffff)
4193 < XSTRING (current_buffer
->downcase_table
)->size
)
4194 && UPPERCASEP (XINT (key
) & 0x3ffff))
4195 || (XINT (key
) & shift_modifier
)))
4197 if (XINT (key
) & shift_modifier
)
4198 XSETINT (key
, XINT (key
) & ~shift_modifier
);
4200 XSETINT (key
, (DOWNCASE (XINT (key
) & 0x3ffff)
4201 | (XINT (key
) & ~0x3ffff)));
4203 first_binding
= nmaps
;
4204 for (i
= nmaps
- 1; i
>= 0; i
--)
4206 if (! NILP (current
[i
]))
4208 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
4209 if (! NILP (defs
[i
]))
4215 if (first_binding
!= nmaps
)
4216 *case_converted
= 1;
4219 /* Given the set of bindings we've found, produce the next set of maps. */
4220 if (first_binding
< nmaps
)
4221 for (i
= 0; i
< nmaps
; i
++)
4222 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
4224 return first_binding
;
4227 /* Read a sequence of keys that ends with a non prefix character,
4228 storing it in KEYBUF, a buffer of size BUFSIZE.
4230 Return the length of the key sequence stored.
4231 Return -1 if the user rejected a command menu.
4233 Echo starting immediately unless `prompt' is 0.
4235 Where a key sequence ends depends on the currently active keymaps.
4236 These include any minor mode keymaps active in the current buffer,
4237 the current buffer's local map, and the global map.
4239 If a key sequence has no other bindings, we check Vfunction_key_map
4240 to see if some trailing subsequence might be the beginning of a
4241 function key's sequence. If so, we try to read the whole function
4242 key, and substitute its symbolic name into the key sequence.
4244 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
4245 `double-' events into similar click events, if that would make them
4246 bound. We try to turn `triple-' events first into `double-' events,
4249 If we get a mouse click in a mode line, vertical divider, or other
4250 non-text area, we treat the click as if it were prefixed by the
4251 symbol denoting that area - `mode-line', `vertical-line', or
4254 If the sequence starts with a mouse click, we read the key sequence
4255 with respect to the buffer clicked on, not the current buffer.
4257 If the user switches frames in the midst of a key sequence, we put
4258 off the switch-frame event until later; the next call to
4259 read_char will return it. */
4262 read_key_sequence (keybuf
, bufsize
, prompt
)
4263 Lisp_Object
*keybuf
;
4267 int count
= specpdl_ptr
- specpdl
;
4269 /* How many keys there are in the current key sequence. */
4272 /* The length of the echo buffer when we started reading, and
4273 the length of this_command_keys when we started reading. */
4277 /* The number of keymaps we're scanning right now, and the number of
4278 keymaps we have allocated space for. */
4280 int nmaps_allocated
= 0;
4282 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
4283 the current keymaps. */
4286 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
4287 in the current keymaps, or nil where it is not a prefix. */
4288 Lisp_Object
*submaps
;
4290 /* The index in defs[] of the first keymap that has a binding for
4291 this key sequence. In other words, the lowest i such that
4292 defs[i] is non-nil. */
4295 /* If t < mock_input, then KEYBUF[t] should be read as the next
4298 We use this to recover after recognizing a function key. Once we
4299 realize that a suffix of the current key sequence is actually a
4300 function key's escape sequence, we replace the suffix with the
4301 function key's binding from Vfunction_key_map. Now keybuf
4302 contains a new and different key sequence, so the echo area,
4303 this_command_keys, and the submaps and defs arrays are wrong. In
4304 this situation, we set mock_input to t, set t to 0, and jump to
4305 restart_sequence; the loop will read keys from keybuf up until
4306 mock_input, thus rebuilding the state; and then it will resume
4307 reading characters from the keyboard. */
4310 /* If the sequence is unbound in submaps[], then
4311 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
4312 and fkey_map is its binding.
4314 These might be > t, indicating that all function key scanning
4315 should hold off until t reaches them. We do this when we've just
4316 recognized a function key, to avoid searching for the function
4317 key's again in Vfunction_key_map. */
4318 int fkey_start
= 0, fkey_end
= 0;
4319 Lisp_Object fkey_map
;
4321 /* Likewise, for key_translation_map. */
4322 int keytran_start
= 0, keytran_end
= 0;
4323 Lisp_Object keytran_map
;
4325 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
4326 we put it off for later. While we're reading, we keep the event here. */
4327 Lisp_Object delayed_switch_frame
;
4329 /* See the comment below... */
4330 #if defined (GOBBLE_FIRST_EVENT)
4331 Lisp_Object first_event
;
4334 struct buffer
*starting_buffer
;
4336 /* Nonzero if we found the binding for one of the chars
4337 in this key sequence by downcasing it. */
4338 int case_converted
= 0;
4340 /* Nonzero if we seem to have got the beginning of a binding
4341 in function_key_map. */
4342 int function_key_possible
= 0;
4346 last_nonmenu_event
= Qnil
;
4348 delayed_switch_frame
= Qnil
;
4349 fkey_map
= Vfunction_key_map
;
4350 keytran_map
= Vkey_translation_map
;
4352 /* If there is no function-key-map, turn off function key scanning. */
4353 if (NILP (Fkeymapp (Vfunction_key_map
)))
4354 fkey_start
= fkey_end
= bufsize
+ 1;
4356 /* If there is no key-translation-map, turn off scanning. */
4357 if (NILP (Fkeymapp (Vkey_translation_map
)))
4358 keytran_start
= keytran_end
= bufsize
+ 1;
4363 echo_prompt (XSTRING (prompt
)->data
);
4364 else if (cursor_in_echo_area
)
4365 /* This doesn't put in a dash if the echo buffer is empty, so
4366 you don't always see a dash hanging out in the minibuffer. */
4370 /* Record the initial state of the echo area and this_command_keys;
4371 we will need to restore them if we replay a key sequence. */
4373 echo_start
= echo_length ();
4374 keys_start
= this_command_key_count
;
4376 #if defined (GOBBLE_FIRST_EVENT)
4377 /* This doesn't quite work, because some of the things that read_char
4378 does cannot safely be bypassed. It seems too risky to try to make
4381 /* Read the first char of the sequence specially, before setting
4382 up any keymaps, in case a filter runs and switches buffers on us. */
4383 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
4385 #endif /* GOBBLE_FIRST_EVENT */
4387 /* We jump here when the key sequence has been thoroughly changed, and
4388 we need to rescan it starting from the beginning. When we jump here,
4389 keybuf[0..mock_input] holds the sequence we should reread. */
4392 starting_buffer
= current_buffer
;
4394 function_key_possible
= 0;
4396 /* Build our list of keymaps.
4397 If we recognize a function key and replace its escape sequence in
4398 keybuf with its symbol, or if the sequence starts with a mouse
4399 click and we need to switch buffers, we jump back here to rebuild
4400 the initial keymaps from the current buffer. */
4404 if (!NILP (Voverriding_local_map
))
4407 if (nmaps
> nmaps_allocated
)
4409 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4410 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4411 nmaps_allocated
= nmaps
;
4413 submaps
[0] = Voverriding_local_map
;
4417 nmaps
= current_minor_maps (0, &maps
) + 2;
4418 if (nmaps
> nmaps_allocated
)
4420 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4421 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4422 nmaps_allocated
= nmaps
;
4424 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
4425 #ifdef USE_TEXT_PROPERTIES
4426 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
4428 submaps
[nmaps
-2] = current_buffer
->keymap
;
4431 submaps
[nmaps
-1] = current_global_map
;
4434 /* Find an accurate initial value for first_binding. */
4435 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
4436 if (! NILP (submaps
[first_binding
]))
4439 /* Start from the beginning in keybuf. */
4442 /* These are no-ops the first time through, but if we restart, they
4443 revert the echo area and this_command_keys to their original state. */
4444 this_command_key_count
= keys_start
;
4445 if (INTERACTIVE
&& t
< mock_input
)
4446 echo_truncate (echo_start
);
4448 /* If the best binding for the current key sequence is a keymap, or
4449 we may be looking at a function key's escape sequence, keep on
4451 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
4452 || (first_binding
>= nmaps
4454 /* mock input is never part of a function key's sequence. */
4455 && mock_input
<= fkey_start
)
4456 || (first_binding
>= nmaps
4457 && keytran_start
< t
4458 /* mock input is never part of a function key's sequence. */
4459 && mock_input
<= keytran_start
)
4460 /* Don't return in the middle of a possible function key sequence,
4461 if the only bindings we found were via case conversion.
4462 Thus, if ESC O a has a function-key-map translation
4463 and ESC o has a binding, don't return after ESC O,
4464 so that we can translate ESC O plus the next character. */
4465 || (function_key_possible
&& case_converted
))
4468 int used_mouse_menu
= 0;
4470 /* Where the last real key started. If we need to throw away a
4471 key that has expanded into more than one element of keybuf
4472 (say, a mouse click on the mode line which is being treated
4473 as [mode-line (mouse-...)], then we backtrack to this point
4475 int last_real_key_start
;
4477 /* These variables are analogous to echo_start and keys_start;
4478 while those allow us to restart the entire key sequence,
4479 echo_local_start and keys_local_start allow us to throw away
4481 int echo_local_start
, keys_local_start
, local_first_binding
;
4484 error ("key sequence too long");
4487 echo_local_start
= echo_length ();
4488 keys_local_start
= this_command_key_count
;
4489 local_first_binding
= first_binding
;
4492 /* These are no-ops, unless we throw away a keystroke below and
4493 jumped back up to replay_key; in that case, these restore the
4494 variables to their original state, allowing us to replay the
4496 if (INTERACTIVE
&& t
< mock_input
)
4497 echo_truncate (echo_local_start
);
4498 this_command_key_count
= keys_local_start
;
4499 first_binding
= local_first_binding
;
4501 /* By default, assume each event is "real". */
4502 last_real_key_start
= t
;
4504 /* Does mock_input indicate that we are re-reading a key sequence? */
4508 add_command_key (key
);
4512 /* If not, we should actually read a character. */
4515 struct buffer
*buf
= current_buffer
;
4517 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
4520 /* read_char returns t when it shows a menu and the user rejects it.
4525 /* read_char returns -1 at the end of a macro.
4526 Emacs 18 handles this by returning immediately with a
4527 zero, so that's what we'll do. */
4528 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) == -1)
4534 /* If the current buffer has been changed from under us, the
4535 keymap may have changed, so replay the sequence. */
4536 if (XTYPE (key
) == Lisp_Buffer
)
4539 goto replay_sequence
;
4542 /* If we have a quit that was typed in another frame, and
4543 quit_throw_to_read_char switched buffers,
4544 replay to get the right keymap. */
4545 if (EQ (key
, quit_char
) && current_buffer
!= starting_buffer
)
4550 goto replay_sequence
;
4556 /* Clicks in non-text areas get prefixed by the symbol
4557 in their CHAR-ADDRESS field. For example, a click on
4558 the mode line is prefixed by the symbol `mode-line'.
4560 Furthermore, key sequences beginning with mouse clicks
4561 are read using the keymaps of the buffer clicked on, not
4562 the current buffer. So we may have to switch the buffer
4565 When we turn one event into two events, we must make sure
4566 that neither of the two looks like the original--so that,
4567 if we replay the events, they won't be expanded again.
4568 If not for this, such reexpansion could happen either here
4569 or when user programs play with this-command-keys. */
4570 if (EVENT_HAS_PARAMETERS (key
))
4574 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
4575 if (EQ (kind
, Qmouse_click
))
4577 Lisp_Object window
, posn
;
4579 window
= POSN_WINDOW (EVENT_START (key
));
4580 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4581 if (XTYPE (posn
) == Lisp_Cons
)
4583 /* We're looking at the second event of a
4584 sequence which we expanded before. Set
4585 last_real_key_start appropriately. */
4587 last_real_key_start
= t
- 1;
4590 /* Key sequences beginning with mouse clicks are
4591 read using the keymaps in the buffer clicked on,
4592 not the current buffer. If we're at the
4593 beginning of a key sequence, switch buffers. */
4594 if (last_real_key_start
== 0
4595 && XTYPE (window
) == Lisp_Window
4596 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
4597 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
4602 /* Arrange to go back to the original buffer once we're
4603 done reading the key sequence. Note that we can't
4604 use save_excursion_{save,restore} here, because they
4605 save point as well as the current buffer; we don't
4606 want to save point, because redisplay may change it,
4607 to accommodate a Fset_window_start or something. We
4608 don't want to do this at the top of the function,
4609 because we may get input from a subprocess which
4610 wants to change the selected window and stuff (say,
4612 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
4614 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
4615 goto replay_sequence
;
4617 else if (XTYPE (posn
) == Lisp_Symbol
)
4619 /* Expand mode-line and scroll-bar events into two events:
4620 use posn as a fake prefix key. */
4622 if (t
+ 1 >= bufsize
)
4623 error ("key sequence too long");
4628 /* Zap the position in key, so we know that we've
4629 expanded it, and don't try to do so again. */
4630 POSN_BUFFER_POSN (EVENT_START (key
))
4631 = Fcons (posn
, Qnil
);
4635 else if (EQ (kind
, Qswitch_frame
))
4637 /* If we're at the beginning of a key sequence, go
4638 ahead and return this event. If we're in the
4639 midst of a key sequence, delay it until the end. */
4642 delayed_switch_frame
= key
;
4650 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4651 /* Handle menu-bar events:
4652 insert the dummy prefix event `menu-bar'. */
4653 if (EQ (posn
, Qmenu_bar
))
4655 if (t
+ 1 >= bufsize
)
4656 error ("key sequence too long");
4657 /* Run the Lucid hook. */
4658 if (!NILP (Vrun_hooks
))
4659 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4660 /* If it has changed current-menubar from previous value,
4661 really recompute the menubar from the value. */
4662 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4663 call0 (Qrecompute_lucid_menubar
);
4667 /* Zap the position in key, so we know that we've
4668 expanded it, and don't try to do so again. */
4669 POSN_BUFFER_POSN (EVENT_START (key
))
4670 = Fcons (posn
, Qnil
);
4673 goto replay_sequence
;
4675 else if (XTYPE (posn
) == Lisp_Cons
)
4677 /* We're looking at the second event of a
4678 sequence which we expanded before. Set
4679 last_real_key_start appropriately. */
4680 if (last_real_key_start
== t
&& t
> 0)
4681 last_real_key_start
= t
- 1;
4686 /* We have finally decided that KEY is something we might want
4688 first_binding
= (follow_key (key
,
4689 nmaps
- first_binding
,
4690 submaps
+ first_binding
,
4691 defs
+ first_binding
,
4692 submaps
+ first_binding
,
4696 /* If KEY wasn't bound, we'll try some fallbacks. */
4697 if (first_binding
>= nmaps
)
4701 head
= EVENT_HEAD (key
);
4702 if (EQ (head
, Vhelp_char
))
4704 read_key_sequence_cmd
= Vprefix_help_command
;
4706 last_nonmenu_event
= key
;
4710 if (XTYPE (head
) == Lisp_Symbol
)
4712 Lisp_Object breakdown
;
4715 breakdown
= parse_modifiers (head
);
4716 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4717 /* Attempt to reduce an unbound mouse event to a simpler
4718 event that is bound:
4719 Drags reduce to clicks.
4720 Double-clicks reduce to clicks.
4721 Triple-clicks reduce to double-clicks, then to clicks.
4722 Down-clicks are eliminated.
4723 Double-downs reduce to downs, then are eliminated.
4724 Triple-downs reduce to double-downs, then to downs,
4725 then are eliminated. */
4726 if (modifiers
& (down_modifier
| drag_modifier
4727 | double_modifier
| triple_modifier
))
4729 while (modifiers
& (down_modifier
| drag_modifier
4730 | double_modifier
| triple_modifier
))
4732 Lisp_Object new_head
, new_click
;
4733 if (modifiers
& triple_modifier
)
4734 modifiers
^= (double_modifier
| triple_modifier
);
4735 else if (modifiers
& (drag_modifier
| double_modifier
))
4736 modifiers
&= ~(drag_modifier
| double_modifier
);
4739 /* Dispose of this `down' event by simply jumping
4740 back to replay_key, to get another event.
4742 Note that if this event came from mock input,
4743 then just jumping back to replay_key will just
4744 hand it to us again. So we have to wipe out any
4747 We could delete keybuf[t] and shift everything
4748 after that to the left by one spot, but we'd also
4749 have to fix up any variable that points into
4750 keybuf, and shifting isn't really necessary
4753 Adding prefixes for non-textual mouse clicks
4754 creates two characters of mock input, and both
4755 must be thrown away. If we're only looking at
4756 the prefix now, we can just jump back to
4757 replay_key. On the other hand, if we've already
4758 processed the prefix, and now the actual click
4759 itself is giving us trouble, then we've lost the
4760 state of the keymaps we want to backtrack to, and
4761 we need to replay the whole sequence to rebuild
4764 Beyond that, only function key expansion could
4765 create more than two keys, but that should never
4766 generate mouse events, so it's okay to zero
4767 mock_input in that case too.
4769 Isn't this just the most wonderful code ever? */
4770 if (t
== last_real_key_start
)
4777 mock_input
= last_real_key_start
;
4778 goto replay_sequence
;
4783 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
4785 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
4787 /* Look for a binding for this new key. follow_key
4788 promises that it didn't munge submaps the
4789 last time we called it, since key was unbound. */
4791 = (follow_key (new_click
,
4792 nmaps
- local_first_binding
,
4793 submaps
+ local_first_binding
,
4794 defs
+ local_first_binding
,
4795 submaps
+ local_first_binding
,
4797 + local_first_binding
);
4799 /* If that click is bound, go for it. */
4800 if (first_binding
< nmaps
)
4805 /* Otherwise, we'll leave key set to the drag event. */
4812 /* Normally, last_nonmenu_event gets the previous key we read.
4813 But when a mouse popup menu is being used,
4814 we don't update last_nonmenu_event; it continues to hold the mouse
4815 event that preceded the first level of menu. */
4816 if (!used_mouse_menu
)
4817 last_nonmenu_event
= key
;
4819 /* If the sequence is unbound, see if we can hang a function key
4820 off the end of it. We only want to scan real keyboard input
4821 for function key sequences, so if mock_input says that we're
4822 re-reading old events, don't examine it. */
4823 if ((first_binding
>= nmaps
|| case_converted
)
4826 Lisp_Object fkey_next
;
4828 /* Continue scan from fkey_end until we find a bound suffix.
4829 If we fail, increment fkey_start
4830 and start fkey_end from there. */
4831 while (fkey_end
< t
)
4835 key
= keybuf
[fkey_end
++];
4836 /* Look up meta-characters by prefixing them
4837 with meta_prefix_char. I hate this. */
4838 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4843 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
4845 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4848 fkey_next
= fkey_map
;
4851 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
4853 /* If the function key map gives a function, not an
4854 array, then call the function with no args and use
4855 its value instead. */
4856 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
4859 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4863 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4864 fkey_next
= call1 (fkey_next
, prompt
);
4866 /* If the function returned something invalid,
4867 barf--don't ignore it.
4868 (To ignore it safely, we would need to gcpro a bunch of
4869 other variables.) */
4870 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
4871 error ("Function in function-key-map returns invalid key sequence");
4874 function_key_possible
= ! NILP (fkey_next
);
4876 /* If keybuf[fkey_start..fkey_end] is bound in the
4877 function key map and it's a suffix of the current
4878 sequence (i.e. fkey_end == t), replace it with
4879 the binding and restart with fkey_start at the end. */
4880 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
4883 int len
= XFASTINT (Flength (fkey_next
));
4885 t
= fkey_start
+ len
;
4887 error ("key sequence too long");
4889 if (VECTORP (fkey_next
))
4890 bcopy (XVECTOR (fkey_next
)->contents
,
4891 keybuf
+ fkey_start
,
4892 (t
- fkey_start
) * sizeof (keybuf
[0]));
4893 else if (STRINGP (fkey_next
))
4897 for (i
= 0; i
< len
; i
++)
4898 XFASTINT (keybuf
[fkey_start
+ i
])
4899 = XSTRING (fkey_next
)->data
[i
];
4903 fkey_start
= fkey_end
= t
;
4904 fkey_map
= Vfunction_key_map
;
4906 goto replay_sequence
;
4909 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
4911 /* If we no longer have a bound suffix, try a new positions for
4913 if (NILP (fkey_map
))
4915 fkey_end
= ++fkey_start
;
4916 fkey_map
= Vfunction_key_map
;
4917 function_key_possible
= 0;
4922 /* Look for this sequence in key-translation-map. */
4924 Lisp_Object keytran_next
;
4926 /* Scan from keytran_end until we find a bound suffix. */
4927 while (keytran_end
< t
)
4931 key
= keybuf
[keytran_end
++];
4932 /* Look up meta-characters by prefixing them
4933 with meta_prefix_char. I hate this. */
4934 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4939 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
4941 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4944 keytran_next
= keytran_map
;
4947 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
4949 /* If the key translation map gives a function, not an
4950 array, then call the function with no args and use
4951 its value instead. */
4952 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
4953 && keytran_end
== t
)
4955 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4959 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4960 keytran_next
= call1 (keytran_next
, prompt
);
4962 /* If the function returned something invalid,
4963 barf--don't ignore it.
4964 (To ignore it safely, we would need to gcpro a bunch of
4965 other variables.) */
4966 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
4967 error ("Function in key-translation-map returns invalid key sequence");
4970 /* If keybuf[keytran_start..keytran_end] is bound in the
4971 key translation map and it's a suffix of the current
4972 sequence (i.e. keytran_end == t), replace it with
4973 the binding and restart with keytran_start at the end. */
4974 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
4975 && keytran_end
== t
)
4977 int len
= XFASTINT (Flength (keytran_next
));
4979 t
= keytran_start
+ len
;
4981 error ("key sequence too long");
4983 if (VECTORP (keytran_next
))
4984 bcopy (XVECTOR (keytran_next
)->contents
,
4985 keybuf
+ keytran_start
,
4986 (t
- keytran_start
) * sizeof (keybuf
[0]));
4987 else if (STRINGP (keytran_next
))
4991 for (i
= 0; i
< len
; i
++)
4992 XFASTINT (keybuf
[keytran_start
+ i
])
4993 = XSTRING (keytran_next
)->data
[i
];
4997 keytran_start
= keytran_end
= t
;
4998 keytran_map
= Vkey_translation_map
;
5000 goto replay_sequence
;
5003 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
5005 /* If we no longer have a bound suffix, try a new positions for
5007 if (NILP (keytran_map
))
5009 keytran_end
= ++keytran_start
;
5010 keytran_map
= Vkey_translation_map
;
5016 read_key_sequence_cmd
= (first_binding
< nmaps
5017 ? defs
[first_binding
]
5021 unread_switch_frame
= delayed_switch_frame
;
5022 unbind_to (count
, Qnil
);
5024 /* Occasionally we fabricate events, perhaps by expanding something
5025 according to function-key-map, or by adding a prefix symbol to a
5026 mouse click in the scroll bar or modeline. In this cases, return
5027 the entire generated key sequence, even if we hit an unbound
5028 prefix or a definition before the end. This means that you will
5029 be able to push back the event properly, and also means that
5030 read-key-sequence will always return a logical unit.
5033 for (; t
< mock_input
; t
++)
5035 echo_char (keybuf
[t
]);
5036 add_command_key (keybuf
[t
]);
5042 #if 0 /* This doc string is too long for some compilers.
5043 This commented-out definition serves for DOC. */
5044 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
5045 "Read a sequence of keystrokes and return as a string or vector.\n\
5046 The sequence is sufficient to specify a non-prefix command in the\n\
5047 current local and global maps.\n\
5049 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
5050 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
5051 as a continuation of the previous key.\n\
5053 A C-g typed while in this function is treated like any other character,\n\
5054 and `quit-flag' is not set.\n\
5056 If the key sequence starts with a mouse click, then the sequence is read\n\
5057 using the keymaps of the buffer of the window clicked in, not the buffer\n\
5058 of the selected window as normal.\n\
5060 `read-key-sequence' drops unbound button-down events, since you normally\n\
5061 only care about the click or drag events which follow them. If a drag\n\
5062 or multi-click event is unbound, but the corresponding click event would\n\
5063 be bound, `read-key-sequence' turns the event into a click event at the\n\
5064 drag's starting position. This means that you don't have to distinguish\n\
5065 between click and drag, double, or triple events unless you want to.\n\
5067 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
5068 lines separating windows, and scroll bars with imaginary keys\n\
5069 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
5071 If the user switches frames in the middle of a key sequence, the\n\
5072 frame-switch event is put off until after the current key sequence.\n\
5074 `read-key-sequence' checks `function-key-map' for function key\n\
5075 sequences, where they wouldn't conflict with ordinary bindings. See\n\
5076 `function-key-map' for more details.")
5077 (prompt
, continue_echo
)
5080 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
5082 (prompt
, continue_echo
)
5083 Lisp_Object prompt
, continue_echo
;
5085 Lisp_Object keybuf
[30];
5087 struct gcpro gcpro1
, gcpro2
;
5090 CHECK_STRING (prompt
, 0);
5093 bzero (keybuf
, sizeof keybuf
);
5095 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
5097 if (NILP (continue_echo
))
5098 this_command_key_count
= 0;
5100 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])), prompt
);
5108 return make_event_array (i
, keybuf
);
5111 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
5112 "Execute CMD as an editor command.\n\
5113 CMD must be a symbol that satisfies the `commandp' predicate.\n\
5114 Optional second arg RECORD-FLAG non-nil\n\
5115 means unconditionally put this command in `command-history'.\n\
5116 Otherwise, that is done only if an arg is read using the minibuffer.")
5118 Lisp_Object cmd
, record
;
5120 register Lisp_Object final
;
5121 register Lisp_Object tem
;
5122 Lisp_Object prefixarg
;
5123 struct backtrace backtrace
;
5124 extern int debug_on_next_call
;
5126 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
5127 Vcurrent_prefix_arg
= prefixarg
;
5128 debug_on_next_call
= 0;
5130 if (XTYPE (cmd
) == Lisp_Symbol
)
5132 tem
= Fget (cmd
, Qdisabled
);
5133 if (!NILP (tem
) && !NILP (Vrun_hooks
))
5134 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
5139 final
= Findirect_function (cmd
);
5141 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
5142 do_autoload (final
, cmd
);
5147 if (XTYPE (final
) == Lisp_String
5148 || XTYPE (final
) == Lisp_Vector
)
5150 /* If requested, place the macro in the command history. For
5151 other sorts of commands, call-interactively takes care of
5155 = Fcons (Fcons (Qexecute_kbd_macro
,
5156 Fcons (final
, Fcons (prefixarg
, Qnil
))),
5159 return Fexecute_kbd_macro (final
, prefixarg
);
5161 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
5162 || XTYPE (final
) == Lisp_Compiled
)
5164 backtrace
.next
= backtrace_list
;
5165 backtrace_list
= &backtrace
;
5166 backtrace
.function
= &Qcall_interactively
;
5167 backtrace
.args
= &cmd
;
5168 backtrace
.nargs
= 1;
5169 backtrace
.evalargs
= 0;
5171 tem
= Fcall_interactively (cmd
, record
);
5173 backtrace_list
= backtrace
.next
;
5179 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
5181 "Read function name, then read its arguments and call it.")
5183 Lisp_Object prefixarg
;
5185 Lisp_Object function
;
5187 Lisp_Object saved_keys
;
5188 struct gcpro gcpro1
;
5190 saved_keys
= Fvector (this_command_key_count
,
5191 XVECTOR (this_command_keys
)->contents
);
5193 GCPRO1 (saved_keys
);
5195 if (EQ (prefixarg
, Qminus
))
5197 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
5198 strcpy (buf
, "C-u ");
5199 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
5200 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
5201 else if (XTYPE (prefixarg
) == Lisp_Int
)
5202 sprintf (buf
, "%d ", XINT (prefixarg
));
5204 /* This isn't strictly correct if execute-extended-command
5205 is bound to anything else. Perhaps it should use
5206 this_command_keys? */
5207 strcat (buf
, "M-x ");
5209 /* Prompt with buf, and then read a string, completing from and
5210 restricting to the set of all defined commands. Don't provide
5211 any initial input. Save the command read on the extended-command
5213 function
= Fcompleting_read (build_string (buf
),
5214 Vobarray
, Qcommandp
,
5215 Qt
, Qnil
, Qextended_command_history
);
5217 /* Set this_command_keys to the concatenation of saved_keys and
5218 function, followed by a RET. */
5220 struct Lisp_String
*str
;
5225 this_command_key_count
= 0;
5227 keys
= XVECTOR (saved_keys
)->contents
;
5228 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
5229 add_command_key (keys
[i
]);
5231 str
= XSTRING (function
);
5232 for (i
= 0; i
< str
->size
; i
++)
5234 XFASTINT (tem
) = str
->data
[i
];
5235 add_command_key (tem
);
5238 XFASTINT (tem
) = '\015';
5239 add_command_key (tem
);
5244 function
= Fintern (function
, Qnil
);
5245 Vprefix_arg
= prefixarg
;
5246 this_command
= function
;
5248 return Fcommand_execute (function
, Qt
);
5252 detect_input_pending ()
5255 get_input_pending (&input_pending
);
5257 return input_pending
;
5260 /* This is called in some cases before a possible quit.
5261 It cases the next call to detect_input_pending to recompute input_pending.
5262 So calling this function unnecessarily can't do any harm. */
5263 clear_input_pending ()
5268 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
5269 "T if command input is currently available with no waiting.\n\
5270 Actually, the value is nil only if we can be sure that no input is available.")
5273 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
5276 return detect_input_pending () ? Qt
: Qnil
;
5279 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
5280 "Return vector of last 100 events, not counting those from keyboard macros.")
5283 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
5286 if (total_keys
< NUM_RECENT_KEYS
)
5287 return Fvector (total_keys
, keys
);
5290 val
= Fvector (NUM_RECENT_KEYS
, keys
);
5291 bcopy (keys
+ recent_keys_index
,
5292 XVECTOR (val
)->contents
,
5293 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
5295 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
5296 recent_keys_index
* sizeof (Lisp_Object
));
5301 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
5302 "Return the key sequence that invoked this command.\n\
5303 The value is a string or a vector.")
5306 return make_event_array (this_command_key_count
,
5307 XVECTOR (this_command_keys
)->contents
);
5310 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
5311 "Return the current depth in recursive edits.")
5315 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
5319 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
5320 "FOpen dribble file: ",
5321 "Start writing all keyboard characters to a dribble file called FILE.\n\
5322 If FILE is nil, close any open dribble file.")
5333 file
= Fexpand_file_name (file
, Qnil
);
5334 dribble
= fopen (XSTRING (file
)->data
, "w");
5339 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
5340 "Discard the contents of the terminal input buffer.\n\
5341 Also cancel any kbd macro being defined.")
5344 defining_kbd_macro
= 0;
5345 update_mode_lines
++;
5347 Vunread_command_events
= Qnil
;
5348 unread_command_char
= -1;
5350 discard_tty_input ();
5352 /* Without the cast, GCC complains that this assignment loses the
5353 volatile qualifier of kbd_store_ptr. Is there anything wrong
5355 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
5356 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5362 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
5363 "Stop Emacs and return to superior process. You can resume later.\n\
5364 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
5365 control, run a subshell instead.\n\n\
5366 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
5367 to be read as terminal input by Emacs's parent, after suspension.\n\
5369 Before suspending, call the functions in `suspend-hook' with no args.\n\
5370 If any of them returns nil, don't call the rest and don't suspend.\n\
5371 Otherwise, suspend normally and after resumption run the normal hook\n\
5372 `suspend-resume-hook' if that is bound and non-nil.\n\
5374 Some operating systems cannot stop the Emacs process and resume it later.\n\
5375 On such systems, Emacs starts a subshell instead of suspending.")
5377 Lisp_Object stuffstring
;
5380 int count
= specpdl_ptr
- specpdl
;
5381 int old_height
, old_width
;
5383 struct gcpro gcpro1
, gcpro2
;
5384 extern init_sys_modes ();
5386 if (!NILP (stuffstring
))
5387 CHECK_STRING (stuffstring
, 0);
5389 /* Run the functions in suspend-hook. */
5390 if (!NILP (Vrun_hooks
))
5391 call1 (Vrun_hooks
, intern ("suspend-hook"));
5393 GCPRO1 (stuffstring
);
5394 get_frame_size (&old_width
, &old_height
);
5396 /* sys_suspend can get an error if it tries to fork a subshell
5397 and the system resources aren't available for that. */
5398 record_unwind_protect (init_sys_modes
, 0);
5399 stuff_buffered_input (stuffstring
);
5404 unbind_to (count
, Qnil
);
5406 /* Check if terminal/window size has changed.
5407 Note that this is not useful when we are running directly
5408 with a window system; but suspend should be disabled in that case. */
5409 get_frame_size (&width
, &height
);
5410 if (width
!= old_width
|| height
!= old_height
)
5411 change_frame_size (selected_frame
, height
, width
, 0, 0);
5413 /* Run suspend-resume-hook. */
5414 if (!NILP (Vrun_hooks
))
5415 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
5421 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
5422 Then in any case stuff anything Emacs has read ahead and not used. */
5424 stuff_buffered_input (stuffstring
)
5425 Lisp_Object stuffstring
;
5427 register unsigned char *p
;
5429 /* stuff_char works only in BSD, versions 4.2 and up. */
5432 if (XTYPE (stuffstring
) == Lisp_String
)
5436 p
= XSTRING (stuffstring
)->data
;
5437 count
= XSTRING (stuffstring
)->size
;
5442 /* Anything we have read ahead, put back for the shell to read. */
5443 while (kbd_fetch_ptr
!= kbd_store_ptr
)
5445 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
5446 kbd_fetch_ptr
= kbd_buffer
;
5447 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
5448 stuff_char (kbd_fetch_ptr
->code
);
5449 kbd_fetch_ptr
->kind
= no_event
;
5450 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
5457 #endif /* BSD and not BSD4_1 */
5460 set_waiting_for_input (time_to_clear
)
5461 EMACS_TIME
*time_to_clear
;
5463 input_available_clear_time
= time_to_clear
;
5465 /* Tell interrupt_signal to throw back to read_char, */
5466 waiting_for_input
= 1;
5468 /* If interrupt_signal was called before and buffered a C-g,
5469 make it run again now, to avoid timing error. */
5470 if (!NILP (Vquit_flag
))
5471 quit_throw_to_read_char ();
5474 clear_waiting_for_input ()
5476 /* Tell interrupt_signal not to throw back to read_char, */
5477 waiting_for_input
= 0;
5478 input_available_clear_time
= 0;
5481 /* This routine is called at interrupt level in response to C-G.
5482 If interrupt_input, this is the handler for SIGINT.
5483 Otherwise, it is called from kbd_buffer_store_event,
5484 in handling SIGIO or SIGTINT.
5486 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
5487 immediately throw back to read_char.
5489 Otherwise it sets the Lisp variable quit-flag not-nil.
5490 This causes eval to throw, when it gets a chance.
5491 If quit-flag is already non-nil, it stops the job right away. */
5497 /* Must preserve main program's value of errno. */
5498 int old_errno
= errno
;
5501 /* USG systems forget handlers when they are used;
5502 must reestablish each time */
5503 signal (SIGINT
, interrupt_signal
);
5504 signal (SIGQUIT
, interrupt_signal
);
5509 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
5514 #ifdef SIGTSTP /* Support possible in later USG versions */
5516 * On systems which can suspend the current process and return to the original
5517 * shell, this command causes the user to end up back at the shell.
5518 * The "Auto-save" and "Abort" questions are not asked until
5519 * the user elects to return to emacs, at which point he can save the current
5520 * job and either dump core or continue.
5525 if (sys_suspend () == -1)
5527 printf ("Not running as a subprocess;\n");
5528 printf ("you can continue or abort.\n");
5531 /* Perhaps should really fork an inferior shell?
5532 But that would not provide any way to get back
5533 to the original shell, ever. */
5534 printf ("No support for stopping a process on this operating system;\n");
5535 printf ("you can continue or abort.\n");
5536 #endif /* not VMS */
5537 #endif /* not SIGTSTP */
5539 /* We must remain inside the screen area when the internal terminal
5540 is used. Note that [Enter] is not echoed by dos. */
5543 printf ("Auto-save? (y or n) ");
5545 if (((c
= getchar ()) & ~040) == 'Y')
5547 Fdo_auto_save (Qt
, Qnil
);
5549 printf ("\r\nAuto-save done");
5550 #else /* not MSDOS */
5551 printf ("Auto-save done\n");
5552 #endif /* not MSDOS */
5554 while (c
!= '\n') c
= getchar ();
5556 printf ("\r\nAbort? (y or n) ");
5557 #else /* not MSDOS */
5559 printf ("Abort (and enter debugger)? (y or n) ");
5561 printf ("Abort (and dump core)? (y or n) ");
5562 #endif /* not VMS */
5563 #endif /* not MSDOS */
5565 if (((c
= getchar ()) & ~040) == 'Y')
5567 while (c
!= '\n') c
= getchar ();
5569 printf ("\r\nContinuing...\r\n");
5570 #else /* not MSDOS */
5571 printf ("Continuing...\n");
5572 #endif /* not MSDOS */
5578 /* If executing a function that wants to be interrupted out of
5579 and the user has not deferred quitting by binding `inhibit-quit'
5580 then quit right away. */
5581 if (immediate_quit
&& NILP (Vinhibit_quit
))
5585 Fsignal (Qquit
, Qnil
);
5588 /* Else request quit when it's safe */
5592 if (waiting_for_input
&& !echoing
)
5593 quit_throw_to_read_char ();
5598 /* Handle a C-g by making read_char return C-g. */
5600 quit_throw_to_read_char ()
5602 quit_error_check ();
5604 /* Prevent another signal from doing this before we finish. */
5605 clear_waiting_for_input ();
5608 Vunread_command_events
= Qnil
;
5609 unread_command_char
= -1;
5611 #ifdef POLL_FOR_INPUT
5612 /* May be > 1 if in recursive minibuffer. */
5613 if (poll_suppress_count
== 0)
5617 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
5618 && XFRAME (internal_last_event_frame
) != selected_frame
)
5619 Fhandle_switch_frame (make_lispy_switch_frame (internal_last_event_frame
));
5622 _longjmp (getcjmp
, 1);
5625 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
5626 "Set mode of reading keyboard input.\n\
5627 First arg INTERRUPT non-nil means use input interrupts;\n\
5628 nil means use CBREAK mode.\n\
5629 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
5630 (no effect except in CBREAK mode).\n\
5631 Third arg META t means accept 8-bit input (for a Meta key).\n\
5632 META nil means ignore the top bit, on the assumption it is parity.\n\
5633 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
5634 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
5635 See also `current-input-mode'.")
5636 (interrupt
, flow
, meta
, quit
)
5637 Lisp_Object interrupt
, flow
, meta
, quit
;
5640 && (XTYPE (quit
) != Lisp_Int
5641 || XINT (quit
) < 0 || XINT (quit
) > 0400))
5642 error ("set-input-mode: QUIT must be an ASCII character");
5644 #ifdef POLL_FOR_INPUT
5650 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5651 #ifdef NO_SOCK_SIGIO
5652 if (read_socket_hook
)
5653 interrupt_input
= 0; /* No interrupts if reading from a socket. */
5655 #endif /* NO_SOCK_SIGIO */
5656 interrupt_input
= !NILP (interrupt
);
5657 #else /* not SIGIO */
5658 interrupt_input
= 0;
5659 #endif /* not SIGIO */
5660 /* Our VMS input only works by interrupts, as of now. */
5662 interrupt_input
= 1;
5664 flow_control
= !NILP (flow
);
5667 else if (EQ (meta
, Qt
))
5672 /* Don't let this value be out of range. */
5673 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
5677 #ifdef POLL_FOR_INPUT
5678 poll_suppress_count
= 1;
5684 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
5685 "Return information about the way Emacs currently reads keyboard input.\n\
5686 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
5687 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
5688 nil, Emacs is using CBREAK mode.\n\
5689 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
5690 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
5691 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
5692 META nil means ignoring the top bit, on the assumption it is parity.\n\
5693 META is neither t nor nil if accepting 8-bit input and using\n\
5694 all 8 bits as the character code.\n\
5695 QUIT is the character Emacs currently uses to quit.\n\
5696 The elements of this list correspond to the arguments of\n\
5702 val
[0] = interrupt_input
? Qt
: Qnil
;
5703 val
[1] = flow_control
? Qt
: Qnil
;
5704 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
5705 XFASTINT (val
[3]) = quit_char
;
5707 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
5713 /* This is correct before outermost invocation of the editor loop */
5714 command_loop_level
= -1;
5716 quit_char
= Ctl ('g');
5717 Vunread_command_events
= Qnil
;
5718 unread_command_char
= -1;
5720 recent_keys_index
= 0;
5721 kbd_fetch_ptr
= kbd_buffer
;
5722 kbd_store_ptr
= kbd_buffer
;
5723 do_mouse_tracking
= 0;
5727 /* This means that command_loop_1 won't try to select anything the first
5729 internal_last_event_frame
= Qnil
;
5730 Vlast_event_frame
= internal_last_event_frame
;
5733 /* If we're running a dumped Emacs, we need to clear out
5734 kbd_buffer_frame_or_window, in case some events got into it
5737 If we're running an undumped Emacs, it hasn't been initialized by
5738 syms_of_keyboard yet. */
5740 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5742 if (!noninteractive
)
5744 signal (SIGINT
, interrupt_signal
);
5745 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
5746 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
5747 SIGQUIT and we can't tell which one it will give us. */
5748 signal (SIGQUIT
, interrupt_signal
);
5749 #endif /* HAVE_TERMIO */
5750 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5752 signal (SIGIO
, input_available_signal
);
5756 /* Use interrupt input by default, if it works and noninterrupt input
5757 has deficiencies. */
5759 #ifdef INTERRUPT_INPUT
5760 interrupt_input
= 1;
5762 interrupt_input
= 0;
5765 /* Our VMS input only works by interrupts, as of now. */
5767 interrupt_input
= 1;
5773 if (keyboard_init_hook
)
5774 (*keyboard_init_hook
) ();
5776 #ifdef POLL_FOR_INPUT
5777 poll_suppress_count
= 1;
5782 /* This type's only use is in syms_of_keyboard, to initialize the
5783 event header symbols and put properties on them. */
5790 struct event_head head_table
[] = {
5791 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
5792 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
5793 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
5798 Qdisabled_command_hook
= intern ("disabled-command-hook");
5799 staticpro (&Qdisabled_command_hook
);
5801 Qself_insert_command
= intern ("self-insert-command");
5802 staticpro (&Qself_insert_command
);
5804 Qforward_char
= intern ("forward-char");
5805 staticpro (&Qforward_char
);
5807 Qbackward_char
= intern ("backward-char");
5808 staticpro (&Qbackward_char
);
5810 Qdisabled
= intern ("disabled");
5811 staticpro (&Qdisabled
);
5813 Qundefined
= intern ("undefined");
5814 staticpro (&Qundefined
);
5816 Qpre_command_hook
= intern ("pre-command-hook");
5817 staticpro (&Qpre_command_hook
);
5819 Qpost_command_hook
= intern ("post-command-hook");
5820 staticpro (&Qpost_command_hook
);
5822 Qcommand_hook_internal
= intern ("command-hook-internal");
5823 staticpro (&Qcommand_hook_internal
);
5825 Qfunction_key
= intern ("function-key");
5826 staticpro (&Qfunction_key
);
5827 Qmouse_click
= intern ("mouse-click");
5828 staticpro (&Qmouse_click
);
5830 Qmenu_enable
= intern ("menu-enable");
5831 staticpro (&Qmenu_enable
);
5833 Qmode_line
= intern ("mode-line");
5834 staticpro (&Qmode_line
);
5835 Qvertical_line
= intern ("vertical-line");
5836 staticpro (&Qvertical_line
);
5837 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
5838 staticpro (&Qvertical_scroll_bar
);
5839 Qmenu_bar
= intern ("menu-bar");
5840 staticpro (&Qmenu_bar
);
5842 Qabove_handle
= intern ("above-handle");
5843 staticpro (&Qabove_handle
);
5844 Qhandle
= intern ("handle");
5845 staticpro (&Qhandle
);
5846 Qbelow_handle
= intern ("below-handle");
5847 staticpro (&Qbelow_handle
);
5849 Qevent_kind
= intern ("event-kind");
5850 staticpro (&Qevent_kind
);
5851 Qevent_symbol_elements
= intern ("event-symbol-elements");
5852 staticpro (&Qevent_symbol_elements
);
5853 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
5854 staticpro (&Qevent_symbol_element_mask
);
5855 Qmodifier_cache
= intern ("modifier-cache");
5856 staticpro (&Qmodifier_cache
);
5858 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
5859 staticpro (&Qrecompute_lucid_menubar
);
5860 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
5861 staticpro (&Qactivate_menubar_hook
);
5863 Qpolling_period
= intern ("polling-period");
5864 staticpro (&Qpolling_period
);
5867 struct event_head
*p
;
5869 for (p
= head_table
;
5870 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
5873 *p
->var
= intern (p
->name
);
5875 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
5876 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
5880 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
5881 staticpro (&button_down_location
);
5885 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
5887 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
5888 for (i
= 0; i
< len
; i
++)
5889 if (modifier_names
[i
])
5890 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
5891 staticpro (&modifier_symbols
);
5894 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
5895 staticpro (&recent_keys
);
5897 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
5898 staticpro (&this_command_keys
);
5900 Qextended_command_history
= intern ("extended-command-history");
5901 Fset (Qextended_command_history
, Qnil
);
5902 staticpro (&Qextended_command_history
);
5904 kbd_buffer_frame_or_window
5905 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
5906 staticpro (&kbd_buffer_frame_or_window
);
5908 accent_key_syms
= Qnil
;
5909 staticpro (&accent_key_syms
);
5911 func_key_syms
= Qnil
;
5912 staticpro (&func_key_syms
);
5914 system_key_syms
= Qnil
;
5915 staticpro (&system_key_syms
);
5918 staticpro (&mouse_syms
);
5920 unread_switch_frame
= Qnil
;
5921 staticpro (&unread_switch_frame
);
5923 defsubr (&Sread_key_sequence
);
5924 defsubr (&Srecursive_edit
);
5925 defsubr (&Strack_mouse
);
5926 defsubr (&Sinput_pending_p
);
5927 defsubr (&Scommand_execute
);
5928 defsubr (&Srecent_keys
);
5929 defsubr (&Sthis_command_keys
);
5930 defsubr (&Ssuspend_emacs
);
5931 defsubr (&Sabort_recursive_edit
);
5932 defsubr (&Sexit_recursive_edit
);
5933 defsubr (&Srecursion_depth
);
5934 defsubr (&Stop_level
);
5935 defsubr (&Sdiscard_input
);
5936 defsubr (&Sopen_dribble_file
);
5937 defsubr (&Sset_input_mode
);
5938 defsubr (&Scurrent_input_mode
);
5939 defsubr (&Sexecute_extended_command
);
5941 DEFVAR_LISP ("last-command-char", &last_command_char
,
5942 "Last input event that was part of a command.");
5944 DEFVAR_LISP ("last-command-event", &last_command_char
,
5945 "Last input event that was part of a command.");
5947 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
5948 "Last input event in a command, except for mouse menu events.\n\
5949 Mouse menus give back keys that don't look like mouse events;\n\
5950 this variable holds the actual mouse event that led to the menu,\n\
5951 so that you can determine whether the command was run by mouse or not.");
5953 DEFVAR_LISP ("last-input-char", &last_input_char
,
5954 "Last input event.");
5956 DEFVAR_LISP ("last-input-event", &last_input_char
,
5957 "Last input event.");
5959 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
5960 "List of objects to be read as next command input events.");
5962 DEFVAR_INT ("unread-command-char", &unread_command_char
,
5963 "If not -1, an object to be read as next command input event.");
5965 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
5966 "Meta-prefix character code. Meta-foo as command input\n\
5967 turns into this character followed by foo.");
5968 XSET (meta_prefix_char
, Lisp_Int
, 033);
5970 DEFVAR_LISP ("last-command", &last_command
,
5971 "The last command executed. Normally a symbol with a function definition,\n\
5972 but can be whatever was found in the keymap, or whatever the variable\n\
5973 `this-command' was set to by that command.");
5974 last_command
= Qnil
;
5976 DEFVAR_LISP ("this-command", &this_command
,
5977 "The command now being executed.\n\
5978 The command can set this variable; whatever is put here\n\
5979 will be in `last-command' during the following command.");
5980 this_command
= Qnil
;
5982 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
5983 "*Number of keyboard input characters between auto-saves.\n\
5984 Zero means disable autosaving due to number of characters typed.");
5985 auto_save_interval
= 300;
5987 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
5988 "*Number of seconds idle time before auto-save.\n\
5989 Zero or nil means disable auto-saving due to idleness.\n\
5990 After auto-saving due to this many seconds of idle time,\n\
5991 Emacs also does a garbage collection if that seems to be warranted.");
5992 XFASTINT (Vauto_save_timeout
) = 30;
5994 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
5995 "*Nonzero means echo unfinished commands after this many seconds of pause.");
5996 echo_keystrokes
= 1;
5998 DEFVAR_INT ("polling-period", &polling_period
,
5999 "*Interval between polling for input during Lisp execution.\n\
6000 The reason for polling is to make C-g work to stop a running program.\n\
6001 Polling is needed only when using X windows and SIGIO does not work.\n\
6002 Polling is automatically disabled in all other cases.");
6005 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
6006 "*Maximum time between mouse clicks to make a double-click.\n\
6007 Measured in milliseconds. nil means disable double-click recognition;\n\
6008 t means double-clicks have no time limit and are detected\n\
6009 by position only.");
6010 Vdouble_click_time
= make_number (500);
6012 DEFVAR_INT ("num-input-keys", &num_input_keys
,
6013 "*Number of complete keys read from the keyboard so far.");
6016 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
6017 "*The frame in which the most recently read event occurred.\n\
6018 If the last event came from a keyboard macro, this is set to `macro'.");
6019 Vlast_event_frame
= Qnil
;
6021 DEFVAR_LISP ("help-char", &Vhelp_char
,
6022 "Character to recognize as meaning Help.\n\
6023 When it is read, do `(eval help-form)', and display result if it's a string.\n\
6024 If the value of `help-form' is nil, this char can be read normally.");
6025 XSET (Vhelp_char
, Lisp_Int
, Ctl ('H'));
6027 DEFVAR_LISP ("help-form", &Vhelp_form
,
6028 "Form to execute when character `help-char' is read.\n\
6029 If the form returns a string, that string is displayed.\n\
6030 If `help-form' is nil, the help char is not recognized.");
6033 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
6034 "Command to run when `help-char' character follows a prefix key.\n\
6035 This command is used only when there is no actual binding\n\
6036 for that character after that prefix key.");
6037 Vprefix_help_command
= Qnil
;
6039 DEFVAR_LISP ("top-level", &Vtop_level
,
6040 "Form to evaluate when Emacs starts up.\n\
6041 Useful to set before you dump a modified Emacs.");
6044 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
6045 "String used as translate table for keyboard input, or nil.\n\
6046 Each character is looked up in this string and the contents used instead.\n\
6047 If string is of length N, character codes N and up are untranslated.");
6048 Vkeyboard_translate_table
= Qnil
;
6050 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
6051 "Keymap of key translations that can override keymaps.\n\
6052 This keymap works like `function-key-map', but comes after that,\n\
6053 and applies even for keys that have ordinary bindings.");
6054 Vkey_translation_map
= Qnil
;
6056 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
6057 "Non-nil means to always spawn a subshell instead of suspending,\n\
6058 even if the operating system has support for stopping a process.");
6061 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
6062 "Non-nil means prompt with menus when appropriate.\n\
6063 This is done when reading from a keymap that has a prompt string,\n\
6064 for elements that have prompt strings.\n\
6065 The menu is displayed on the screen\n\
6066 if X menus were enabled at configuration\n\
6067 time and the previous event was a mouse click prefix key.\n\
6068 Otherwise, menu prompting uses the echo area.");
6071 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
6072 "Character to see next line of menu prompt.\n\
6073 Type this character while in a menu prompt to rotate around the lines of it.");
6074 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
6076 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
6077 "A mask of additional modifier keys to use with every keyboard character.\n\
6078 Emacs applies the modifiers of the character stored here to each keyboard\n\
6079 character it reads. For example, after evaluating the expression\n\
6080 (setq extra-keyboard-modifiers ?\C-x)\n\
6081 all input characters will have the control modifier applied to them.\n\
6083 Note that the character ?\C-@, equivalent to the integer zero, does\n\
6084 not count as a control character; rather, it counts as a character\n\
6085 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
6086 cancels any modification.");
6087 extra_keyboard_modifiers
= 0;
6089 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
6090 "If an editing command sets this to t, deactivate the mark afterward.\n\
6091 The command loop sets this to nil before each command,\n\
6092 and tests the value when the command returns.\n\
6093 Buffer modification stores t in this variable.");
6094 Vdeactivate_mark
= Qnil
;
6096 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
6097 "Temporary storage of pre-command-hook or post-command-hook.");
6098 Vcommand_hook_internal
= Qnil
;
6100 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
6101 "Normal hook run before each command is executed.\n\
6102 While the hook is run, its value is temporarily set to nil\n\
6103 to avoid an unbreakable infinite loop if a hook function gets an error.\n\
6104 As a result, a hook function cannot straightforwardly alter the value of\n\
6105 `pre-command-hook'. See the Emacs Lisp manual for a way of\n\
6106 implementing hook functions that alter the set of hook functions.");
6107 Vpre_command_hook
= Qnil
;
6109 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
6110 "Normal hook run after each command is executed.\n\
6111 While the hook is run, its value is temporarily set to nil\n\
6112 to avoid an unbreakable infinite loop if a hook function gets an error.\n\
6113 As a result, a hook function cannot straightforwardly alter the value of\n\
6114 `post-command-hook'. See the Emacs Lisp manual for a way of\n\
6115 implementing hook functions that alter the set of hook functions.");
6116 Vpost_command_hook
= Qnil
;
6118 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
6119 "t means menu bar, specified Lucid style, needs to be recomputed.");
6120 Vlucid_menu_bar_dirty_flag
= Qnil
;
6122 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
6123 "List of menu bar items to move to the end of the menu bar.\n\
6124 The elements of the list are event types that may have menu bar bindings.");
6125 Vmenu_bar_final_items
= Qnil
;
6127 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
6128 "Keymap that overrides all other local keymaps.\n\
6129 If this variable is non-nil, it is used as a keymap instead of the\n\
6130 buffer's local map, and the minor mode keymaps and text property keymaps.");
6131 Voverriding_local_map
= Qnil
;
6133 DEFVAR_BOOL ("track-mouse", &do_mouse_tracking
,
6134 "*Non-nil means generate motion events for mouse motion.");
6136 DEFVAR_LISP ("system-key-alist", &Vsystem_key_alist
,
6137 "Alist of system-specific X windows key symbols.\n\
6138 Each element should have the form (N . SYMBOL) where N is the\n\
6139 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
6140 and SYMBOL is its name.");
6141 Vmenu_bar_final_items
= Qnil
;
6146 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
6147 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
6148 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
6149 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
6150 initial_define_key (meta_map
, 'x', "execute-extended-command");