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"
55 /* This is to get the definitions of the XK_ symbols. */
60 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
65 /* Variables for blockinput.h: */
67 /* Non-zero if interrupt input is blocked right now. */
68 int interrupt_input_blocked
;
70 /* Nonzero means an input interrupt has arrived
71 during the current critical section. */
72 int interrupt_input_pending
;
76 extern Lisp_Object Vmouse_grabbed
;
78 /* Make all keyboard buffers much bigger when using X windows. */
79 #define KBD_BUFFER_SIZE 4096
80 #else /* No X-windows, character input */
81 #define KBD_BUFFER_SIZE 256
82 #endif /* No X-windows */
84 /* Following definition copied from eval.c */
88 struct backtrace
*next
;
89 Lisp_Object
*function
;
90 Lisp_Object
*args
; /* Points to vector of args. */
91 int nargs
; /* length of vector. If nargs is UNEVALLED,
92 args points to slot holding list of
97 /* Non-nil disable property on a command means
98 do not execute it; call disabled-command-hook's value instead. */
99 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
101 #define NUM_RECENT_KEYS (100)
102 int recent_keys_index
; /* Index for storing next element into recent_keys */
103 int total_keys
; /* Total number of elements stored into recent_keys */
104 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
106 /* Vector holding the key sequence that invoked the current command.
107 It is reused for each command, and it may be longer than the current
108 sequence; this_command_key_count indicates how many elements
109 actually mean something.
110 It's easier to staticpro a single Lisp_Object than an array. */
111 Lisp_Object this_command_keys
;
112 int this_command_key_count
;
114 extern int minbuf_level
;
116 extern struct backtrace
*backtrace_list
;
118 /* Nonzero means do menu prompting. */
119 static int menu_prompting
;
121 /* Character to see next line of menu prompt. */
122 static Lisp_Object menu_prompt_more_char
;
124 /* For longjmp to where kbd input is being done. */
125 static jmp_buf getcjmp
;
127 /* True while doing kbd input. */
128 int waiting_for_input
;
130 /* True while displaying for echoing. Delays C-g throwing. */
133 /* Nonzero means C-g should cause immediate error-signal. */
136 /* Character to recognize as the help char. */
137 Lisp_Object Vhelp_char
;
139 /* Form to execute when help char is typed. */
140 Lisp_Object Vhelp_form
;
142 /* Command to run when the help character follows a prefix key. */
143 Lisp_Object Vprefix_help_command
;
145 /* List of items that should move to the end of the menu bar. */
146 Lisp_Object Vmenu_bar_final_items
;
148 /* Character that causes a quit. Normally C-g.
150 If we are running on an ordinary terminal, this must be an ordinary
151 ASCII char, since we want to make it our interrupt character.
153 If we are not running on an ordinary terminal, it still needs to be
154 an ordinary ASCII char. This character needs to be recognized in
155 the input interrupt handler. At this point, the keystroke is
156 represented as a struct input_event, while the desired quit
157 character is specified as a lispy event. The mapping from struct
158 input_events to lispy events cannot run in an interrupt handler,
159 and the reverse mapping is difficult for anything but ASCII
162 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
166 extern Lisp_Object current_global_map
;
167 extern int minibuf_level
;
169 /* If non-nil, this is a map that overrides all other local maps. */
170 Lisp_Object Voverriding_local_map
;
172 /* Current depth in recursive edits. */
173 int command_loop_level
;
175 /* Total number of times command_loop has read a key sequence. */
178 /* Last input character read as a command. */
179 Lisp_Object last_command_char
;
181 /* Last input character read as a command, not counting menus
182 reached by the mouse. */
183 Lisp_Object last_nonmenu_event
;
185 /* Last input character read for any purpose. */
186 Lisp_Object last_input_char
;
188 /* If not Qnil, a list of objects to be read as subsequent command input. */
189 Lisp_Object Vunread_command_events
;
191 /* If not -1, an event to be read as subsequent command input. */
192 int unread_command_char
;
194 /* If not Qnil, this is a switch-frame event which we decided to put
195 off until the end of a key sequence. This should be read as the
196 next command input, after any unread_command_events.
198 read_key_sequence uses this to delay switch-frame events until the
199 end of the key sequence; Fread_char uses it to put off switch-frame
200 events until a non-ASCII event is acceptable as input. */
201 Lisp_Object unread_switch_frame
;
203 /* A mask of extra modifier bits to put into every keyboard char. */
204 int extra_keyboard_modifiers
;
206 /* Char to use as prefix when a meta character is typed in.
207 This is bound on entry to minibuffer in case ESC is changed there. */
209 Lisp_Object meta_prefix_char
;
211 /* Last size recorded for a current buffer which is not a minibuffer. */
212 static int last_non_minibuf_size
;
214 /* Number of idle seconds before an auto-save and garbage collection. */
215 static Lisp_Object Vauto_save_timeout
;
217 /* Total number of times read_char has returned. */
220 /* Total number of times read_char has returned, outside of macros. */
221 int num_nonmacro_input_chars
;
223 /* Auto-save automatically when this many characters have been typed
224 since the last time. */
226 static int auto_save_interval
;
228 /* Value of num_nonmacro_input_chars as of last auto save. */
232 /* Last command executed by the editor command loop, not counting
233 commands that set the prefix argument. */
235 Lisp_Object last_command
;
237 /* The command being executed by the command loop.
238 Commands may set this, and the value set will be copied into last_command
239 instead of the actual command. */
240 Lisp_Object this_command
;
242 /* The value of point when the last command was executed. */
243 int last_point_position
;
245 /* The buffer that was current when the last command was started. */
246 Lisp_Object last_point_position_buffer
;
249 /* The frame in which the last input event occurred, or Qmacro if the
250 last event came from a macro. We use this to determine when to
251 generate switch-frame events. This may be cleared by functions
252 like Fselect_frame, to make sure that a switch-frame event is
253 generated by the next character. */
254 Lisp_Object internal_last_event_frame
;
257 /* A user-visible version of the above, intended to allow users to
258 figure out where the last event came from, if the event doesn't
259 carry that information itself (i.e. if it was a character). */
260 Lisp_Object Vlast_event_frame
;
262 /* The timestamp of the last input event we received from the X server.
263 X Windows wants this for selection ownership. */
264 unsigned long last_event_timestamp
;
266 Lisp_Object Qself_insert_command
;
267 Lisp_Object Qforward_char
;
268 Lisp_Object Qbackward_char
;
269 Lisp_Object Qundefined
;
271 /* read_key_sequence stores here the command definition of the
272 key sequence that it reads. */
273 Lisp_Object read_key_sequence_cmd
;
275 /* Form to evaluate (if non-nil) when Emacs is started. */
276 Lisp_Object Vtop_level
;
278 /* User-supplied string to translate input characters through. */
279 Lisp_Object Vkeyboard_translate_table
;
281 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
282 extern Lisp_Object Vfunction_key_map
;
284 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
285 Lisp_Object Vkey_translation_map
;
287 /* Non-nil means deactivate the mark at end of this command. */
288 Lisp_Object Vdeactivate_mark
;
290 /* Menu bar specified in Lucid Emacs fashion. */
292 Lisp_Object Vlucid_menu_bar_dirty_flag
;
293 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
295 /* Hooks to run before and after each command. */
296 Lisp_Object Qpre_command_hook
, Qpost_command_hook
;
297 Lisp_Object Vpre_command_hook
, Vpost_command_hook
;
298 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
300 /* File in which we write all commands we read. */
303 /* Nonzero if input is available. */
306 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
307 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
311 extern char *pending_malloc_warning
;
313 /* Circular buffer for pre-read keyboard input. */
314 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
316 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
318 The interrupt-level event handlers will never enqueue an event on a
319 frame which is not in Vframe_list, and once an event is dequeued,
320 internal_last_event_frame or the event itself points to the frame.
323 But while the event is sitting in the queue, it's completely
324 unprotected. Suppose the user types one command which will run for
325 a while and then delete a frame, and then types another event at
326 the frame that will be deleted, before the command gets around to
327 it. Suppose there are no references to this frame elsewhere in
328 Emacs, and a GC occurs before the second event is dequeued. Now we
329 have an event referring to a freed frame, which will crash Emacs
332 Similar things happen when an event on a scroll bar is enqueued; the
333 window may be deleted while the event is in the queue.
335 So, we use this vector to protect the frame_or_window field in the
336 event queue. That way, they'll be dequeued as dead frames or
337 windows, but still valid lisp objects.
339 If kbd_buffer[i].kind != no_event, then
340 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
341 == kbd_buffer[i].frame_or_window. */
342 static Lisp_Object kbd_buffer_frame_or_window
;
344 /* Pointer to next available character in kbd_buffer.
345 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
346 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
347 next available char is in kbd_buffer[0]. */
348 static struct input_event
*kbd_fetch_ptr
;
350 /* Pointer to next place to store character in kbd_buffer. This
351 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
352 character should go in kbd_buffer[0]. */
356 static struct input_event
*kbd_store_ptr
;
358 /* The above pair of variables forms a "queue empty" flag. When we
359 enqueue a non-hook event, we increment kbd_write_count. When we
360 dequeue a non-hook event, we increment kbd_read_count. We say that
361 there is input available iff the two counters are not equal.
363 Why not just have a flag set and cleared by the enqueuing and
364 dequeuing functions? Such a flag could be screwed up by interrupts
365 at inopportune times. */
367 /* If this flag is non-zero, we check mouse_moved to see when the
368 mouse moves, and motion events will appear in the input stream. If
369 it is zero, mouse motion is ignored. */
370 static int do_mouse_tracking
;
372 /* The window system handling code should set this if the mouse has
373 moved since the last call to the mouse_position_hook. Calling that
374 hook should clear this. Code assumes that if this is set, it can
375 call mouse_position_hook to get the promised position, so don't set
376 it unless you're prepared to substantiate the claim! */
379 /* True iff there is an event in kbd_buffer, or if mouse tracking is
380 enabled and there is a new mouse position in the mouse movement
381 buffer. Note that if this is false, that doesn't mean that there
382 is readable input; all the events in the queue might be button-up
383 events, and do_mouse_tracking might be off. */
384 #define EVENT_QUEUES_EMPTY \
385 ((kbd_fetch_ptr == kbd_store_ptr) && (!do_mouse_tracking || !mouse_moved))
388 /* Symbols to head events. */
389 Lisp_Object Qmouse_movement
;
390 Lisp_Object Qscroll_bar_movement
;
391 Lisp_Object Qswitch_frame
;
393 /* Symbols to denote kinds of events. */
394 Lisp_Object Qfunction_key
;
395 Lisp_Object Qmouse_click
;
396 /* Lisp_Object Qmouse_movement; - also an event header */
398 /* Properties of event headers. */
399 Lisp_Object Qevent_kind
;
400 Lisp_Object Qevent_symbol_elements
;
402 Lisp_Object Qmenu_enable
;
404 /* An event header symbol HEAD may have a property named
405 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
406 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
407 mask of modifiers applied to it. If present, this is used to help
408 speed up parse_modifiers. */
409 Lisp_Object Qevent_symbol_element_mask
;
411 /* An unmodified event header BASE may have a property named
412 Qmodifier_cache, which is an alist mapping modifier masks onto
413 modified versions of BASE. If present, this helps speed up
415 Lisp_Object Qmodifier_cache
;
417 /* Symbols to use for parts of windows. */
418 Lisp_Object Qmode_line
;
419 Lisp_Object Qvertical_line
;
420 Lisp_Object Qvertical_scroll_bar
;
421 Lisp_Object Qmenu_bar
;
423 extern Lisp_Object Qmenu_enable
;
425 Lisp_Object
recursive_edit_unwind (), command_loop ();
426 Lisp_Object
Fthis_command_keys ();
427 Lisp_Object Qextended_command_history
;
429 Lisp_Object Qpolling_period
;
431 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
433 EMACS_TIME
*input_available_clear_time
;
435 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
436 Default is 1 if INTERRUPT_INPUT is defined. */
439 /* Nonzero while interrupts are temporarily deferred during redisplay. */
440 int interrupts_deferred
;
442 /* nonzero means use ^S/^Q for flow control. */
445 /* Allow m- file to inhibit use of FIONREAD. */
446 #ifdef BROKEN_FIONREAD
450 /* We are unable to use interrupts if FIONREAD is not available,
451 so flush SIGIO so we won't try. */
458 /* If we support X Windows, turn on the code to poll periodically
459 to detect C-g. It isn't actually used when doing interrupt input. */
460 #ifdef HAVE_X_WINDOWS
461 #define POLL_FOR_INPUT
464 /* Global variable declarations. */
466 /* Function for init_keyboard to call with no args (if nonzero). */
467 void (*keyboard_init_hook
) ();
469 static int read_avail_input ();
470 static void get_input_pending ();
471 static int readable_events ();
472 static Lisp_Object
read_char_x_menu_prompt ();
473 static Lisp_Object
read_char_minibuf_menu_prompt ();
474 static Lisp_Object
make_lispy_event ();
475 static Lisp_Object
make_lispy_movement ();
476 static Lisp_Object
modify_event_symbol ();
477 static Lisp_Object
make_lispy_switch_frame ();
479 /* > 0 if we are to echo keystrokes. */
480 static int echo_keystrokes
;
482 /* Nonzero means echo each character as typed. */
483 static int immediate_echo
;
485 /* The text we're echoing in the modeline - partial key sequences,
486 usually. '\0'-terminated. This really shouldn't have a fixed size. */
487 static char echobuf
[300];
489 /* Where to append more text to echobuf if we want to. */
490 static char *echoptr
;
492 /* Nonzero means don't try to suspend even if the operating system seems
494 static int cannot_suspend
;
496 #define min(a,b) ((a)<(b)?(a):(b))
497 #define max(a,b) ((a)>(b)?(a):(b))
499 /* Install the string STR as the beginning of the string of echoing,
500 so that it serves as a prompt for the next character.
501 Also start echoing. */
506 int len
= strlen (str
);
507 if (len
> sizeof echobuf
- 4)
508 len
= sizeof echobuf
- 4;
509 bcopy (str
, echobuf
, len
);
510 echoptr
= echobuf
+ len
;
516 /* Add C to the echo string, if echoing is going on.
517 C can be a character, which is printed prettily ("M-C-x" and all that
518 jazz), or a symbol, whose name is printed. */
523 extern char *push_key_description ();
532 /* If someone has passed us a composite event, use its head symbol. */
535 if (XTYPE (c
) == Lisp_Int
)
537 if (ptr
- echobuf
> sizeof echobuf
- 6)
540 ptr
= push_key_description (XINT (c
), ptr
);
542 else if (XTYPE (c
) == Lisp_Symbol
)
544 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
545 if (((ptr
- echobuf
) + name
->size
+ 4) > sizeof echobuf
)
547 bcopy (name
->data
, ptr
, name
->size
);
551 if (echoptr
== echobuf
&& EQ (c
, Vhelp_char
))
553 strcpy (ptr
, " (Type ? for further options)");
564 /* Temporarily add a dash to the end of the echo string if it's not
565 empty, so that it serves as a mini-prompt for the very next character. */
569 if (!immediate_echo
&& echoptr
== echobuf
)
571 /* Do nothing if not echoing at all. */
575 /* Put a dash at the end of the buffer temporarily,
576 but make it go away when the next character is added. */
583 /* Display the current echo string, and begin echoing if not already
593 for (i
= 0; i
< this_command_key_count
; i
++)
596 c
= XVECTOR (this_command_keys
)->contents
[i
];
597 if (! (EVENT_HAS_PARAMETERS (c
)
598 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
608 if (waiting_for_input
&& !NILP (Vquit_flag
))
609 quit_throw_to_read_char ();
612 /* Turn off echoing, for the start of a new command. */
620 /* Return the length of the current echo string. */
625 return echoptr
- echobuf
;
628 /* Truncate the current echo message to its first LEN chars.
629 This and echo_char get used by read_key_sequence when the user
630 switches frames while entering a key sequence. */
637 echoptr
= echobuf
+ len
;
638 truncate_echo_area (len
);
642 /* Functions for manipulating this_command_keys. */
644 add_command_key (key
)
647 int size
= XVECTOR (this_command_keys
)->size
;
649 if (this_command_key_count
>= size
)
651 Lisp_Object new_keys
;
653 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
654 bcopy (XVECTOR (this_command_keys
)->contents
,
655 XVECTOR (new_keys
)->contents
,
656 size
* sizeof (Lisp_Object
));
658 this_command_keys
= new_keys
;
661 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
667 int count
= specpdl_ptr
- specpdl
;
670 if (command_loop_level
> 0)
672 specbind (Qstandard_output
, Qt
);
673 specbind (Qstandard_input
, Qt
);
676 val
= command_loop ();
678 Fsignal (Qquit
, Qnil
);
680 return unbind_to (count
, Qnil
);
683 /* When an auto-save happens, record the "time", and don't do again soon. */
687 last_auto_save
= num_nonmacro_input_chars
;
690 /* Make an auto save happen as soon as possible at command level. */
692 force_auto_save_soon ()
694 last_auto_save
= - auto_save_interval
- 1;
696 record_asynch_buffer_change ();
699 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
700 "Invoke the editor command loop recursively.\n\
701 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
702 that tells this function to return.\n\
703 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
704 This function is called by the editor initialization to begin editing.")
707 int count
= specpdl_ptr
- specpdl
;
710 command_loop_level
++;
711 update_mode_lines
= 1;
713 record_unwind_protect (recursive_edit_unwind
,
715 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
719 return unbind_to (count
, Qnil
);
723 recursive_edit_unwind (buffer
)
727 Fset_buffer (buffer
);
729 command_loop_level
--;
730 update_mode_lines
= 1;
738 Lisp_Object errmsg
, tail
, errname
, file_error
;
745 Vstandard_output
= Qt
;
746 Vstandard_input
= Qt
;
747 Vexecuting_macro
= Qnil
;
748 echo_area_glyphs
= 0;
750 /* If the window system or terminal frame hasn't been initialized
751 yet, or we're not interactive, it's best to dump this message out
752 to stderr and exit. */
753 if (! FRAME_MESSAGE_BUF (selected_frame
)
755 stream
= Qexternal_debugging_output
;
763 errname
= Fcar (data
);
765 if (EQ (errname
, Qerror
))
768 if (!CONSP (data
)) data
= Qnil
;
769 errmsg
= Fcar (data
);
774 errmsg
= Fget (errname
, Qerror_message
);
775 file_error
= Fmemq (Qfile_error
,
776 Fget (errname
, Qerror_conditions
));
779 /* Print an error message including the data items.
780 This is done by printing it into a scratch buffer
781 and then making a copy of the text in the buffer. */
783 if (!CONSP (data
)) data
= Qnil
;
787 /* For file-error, make error message by concatenating
788 all the data items. They are all strings. */
789 if (!NILP (file_error
) && !NILP (tail
))
790 errmsg
= XCONS (tail
)->car
, tail
= XCONS (tail
)->cdr
;
792 if (XTYPE (errmsg
) == Lisp_String
)
793 Fprinc (errmsg
, stream
);
795 write_string_1 ("peculiar error", -1, stream
);
797 for (i
= 0; CONSP (tail
); tail
= Fcdr (tail
), i
++)
799 write_string_1 (i
? ", " : ": ", 2, stream
);
800 if (!NILP (file_error
))
801 Fprinc (Fcar (tail
), stream
);
803 Fprin1 (Fcar (tail
), stream
);
807 /* If the window system or terminal frame hasn't been initialized
808 yet, or we're in -batch mode, this error should cause Emacs to exit. */
809 if (! FRAME_MESSAGE_BUF (selected_frame
)
813 Fkill_emacs (make_number (-1));
818 Vinhibit_quit
= Qnil
;
819 return make_number (0);
822 Lisp_Object
command_loop_1 ();
823 Lisp_Object
command_loop_2 ();
824 Lisp_Object
top_level_1 ();
826 /* Entry to editor-command-loop.
827 This level has the catches for exiting/returning to editor command loop.
828 It returns nil to exit recursive edit, t to abort it. */
833 if (command_loop_level
> 0 || minibuf_level
> 0)
835 return internal_catch (Qexit
, command_loop_2
, Qnil
);
840 internal_catch (Qtop_level
, top_level_1
, Qnil
);
841 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
843 /* End of file in -batch run causes exit here. */
849 /* Here we catch errors in execution of commands within the
850 editing loop, and reenter the editing loop.
851 When there is an error, cmd_error runs and returns a non-nil
852 value to us. A value of nil means that cmd_loop_1 itself
853 returned due to end of file (or end of kbd macro). */
858 register Lisp_Object val
;
861 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
870 return Feval (Vtop_level
);
876 /* On entry to the outer level, run the startup file */
877 if (!NILP (Vtop_level
))
878 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
879 else if (!NILP (Vpurify_flag
))
880 message ("Bare impure Emacs (standard Lisp code not loaded)");
882 message ("Bare Emacs (standard Lisp code not loaded)");
886 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
887 "Exit all recursive editing levels.")
890 Fthrow (Qtop_level
, Qnil
);
893 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
894 "Exit from the innermost recursive edit or minibuffer.")
897 if (command_loop_level
> 0 || minibuf_level
> 0)
898 Fthrow (Qexit
, Qnil
);
900 error ("No recursive edit is in progress");
903 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
904 "Abort the command that requested this recursive edit or minibuffer input.")
907 if (command_loop_level
> 0 || minibuf_level
> 0)
910 error ("No recursive edit is in progress");
913 /* This is the actual command reading loop,
914 sans error-handling encapsulation. */
916 Lisp_Object
Fcommand_execute ();
917 static int read_key_sequence ();
918 static void safe_run_hooks ();
923 Lisp_Object cmd
, tem
;
926 Lisp_Object keybuf
[30];
931 struct buffer
*prev_buffer
;
934 Vdeactivate_mark
= Qnil
;
935 waiting_for_input
= 0;
940 this_command_key_count
= 0;
942 /* Make sure this hook runs after commands that get errors and
943 throw to top level. */
944 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
945 safe_run_hooks (&Vpost_command_hook
);
947 /* Do this after running Vpost_command_hook, for consistency. */
948 last_command
= this_command
;
952 /* Install chars successfully executed in kbd macro. */
954 if (defining_kbd_macro
&& NILP (Vprefix_arg
))
955 finalize_kbd_macro_chars ();
957 /* Make sure the current window's buffer is selected. */
958 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
959 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
961 /* Display any malloc warning that just came out. Use while because
962 displaying one warning can cause another. */
964 while (pending_malloc_warning
)
965 display_malloc_warning ();
969 Vdeactivate_mark
= Qnil
;
971 /* If minibuffer on and echo area in use,
972 wait 2 sec and redraw minibuffer. */
974 if (minibuf_level
&& echo_area_glyphs
)
976 /* Bind inhibit-quit to t so that C-g gets read in
977 rather than quitting back to the minibuffer. */
978 int count
= specpdl_ptr
- specpdl
;
979 specbind (Qinhibit_quit
, Qt
);
980 Fsit_for (make_number (2), Qnil
, Qnil
);
981 unbind_to (count
, Qnil
);
983 echo_area_glyphs
= 0;
985 if (!NILP (Vquit_flag
))
988 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
993 alloca (0); /* Cause a garbage collection now */
994 /* Since we can free the most stuff here. */
995 #endif /* C_ALLOCA */
999 /* Select the frame that the last event came from. Usually,
1000 switch-frame events will take care of this, but if some lisp
1001 code swallows a switch-frame event, we'll fix things up here.
1002 Is this a good idea? */
1003 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
1004 && XFRAME (internal_last_event_frame
) != selected_frame
)
1005 Fselect_frame (internal_last_event_frame
, Qnil
);
1008 /* If it has changed current-menubar from previous value,
1009 really recompute the menubar from the value. */
1010 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1011 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1012 call0 (Qrecompute_lucid_menubar
);
1014 /* Read next key sequence; i gets its length. */
1015 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), Qnil
);
1019 /* Now we have read a key sequence of length I,
1020 or else I is 0 and we found end of file. */
1022 if (i
== 0) /* End of file -- happens only in */
1023 return Qnil
; /* a kbd macro, at the end. */
1024 /* -1 means read_key_sequence got a menu that was rejected.
1025 Just loop around and read another command. */
1029 this_command_key_count
= 0;
1033 last_command_char
= keybuf
[i
- 1];
1035 /* If the previous command tried to force a specific window-start,
1036 forget about that, in case this command moves point far away
1037 from that position. */
1038 XWINDOW (selected_window
)->force_start
= Qnil
;
1040 cmd
= read_key_sequence_cmd
;
1041 if (!NILP (Vexecuting_macro
))
1043 if (!NILP (Vquit_flag
))
1045 Vexecuting_macro
= Qt
;
1046 QUIT
; /* Make some noise. */
1047 /* Will return since macro now empty. */
1051 /* Do redisplay processing after this command except in special
1052 cases identified below that set no_redisplay to 1.
1053 (actually, there's currently no way to prevent the redisplay,
1054 and no_redisplay is ignored.
1055 Perhaps someday we will really implement it. */
1058 prev_buffer
= current_buffer
;
1059 prev_modiff
= MODIFF
;
1060 last_point_position
= PT
;
1061 XSET (last_point_position_buffer
, Lisp_Buffer
, prev_buffer
);
1063 /* Execute the command. */
1066 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1067 safe_run_hooks (&Vpre_command_hook
);
1069 if (NILP (this_command
))
1071 /* nil means key is undefined. */
1073 defining_kbd_macro
= 0;
1074 update_mode_lines
= 1;
1080 if (NILP (Vprefix_arg
) && ! no_direct
)
1082 /* Recognize some common commands in common situations and
1083 do them directly. */
1084 if (EQ (this_command
, Qforward_char
) && PT
< ZV
)
1086 struct Lisp_Vector
*dp
1087 = window_display_table (XWINDOW (selected_window
));
1088 lose
= FETCH_CHAR (PT
);
1091 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1092 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1093 : (lose
>= 0x20 && lose
< 0x7f))
1094 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1096 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1098 && !windows_or_buffers_changed
1099 && EQ (current_buffer
->selective_display
, Qnil
)
1100 && !detect_input_pending ()
1101 && NILP (Vexecuting_macro
))
1102 no_redisplay
= direct_output_forward_char (1);
1105 else if (EQ (this_command
, Qbackward_char
) && PT
> BEGV
)
1107 struct Lisp_Vector
*dp
1108 = window_display_table (XWINDOW (selected_window
));
1110 lose
= FETCH_CHAR (PT
);
1112 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1113 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1114 : (lose
>= 0x20 && lose
< 0x7f))
1115 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1117 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1119 && !windows_or_buffers_changed
1120 && EQ (current_buffer
->selective_display
, Qnil
)
1121 && !detect_input_pending ()
1122 && NILP (Vexecuting_macro
))
1123 no_redisplay
= direct_output_forward_char (-1);
1126 else if (EQ (this_command
, Qself_insert_command
)
1127 /* Try this optimization only on ascii keystrokes. */
1128 && XTYPE (last_command_char
) == Lisp_Int
)
1130 unsigned char c
= XINT (last_command_char
);
1132 if (NILP (Vexecuting_macro
) &&
1133 !EQ (minibuf_window
, selected_window
))
1135 if (!nonundocount
|| nonundocount
>= 20)
1142 lose
= (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1144 || (XFASTINT (XWINDOW (selected_window
)->last_point
) != PT
)
1145 || MODIFF
<= current_buffer
->save_modified
1146 || windows_or_buffers_changed
1147 || !EQ (current_buffer
->selective_display
, Qnil
)
1148 || detect_input_pending ()
1149 || !NILP (Vexecuting_macro
);
1150 if (internal_self_insert (c
, 0))
1156 (PT
== ZV
|| FETCH_CHAR (PT
) == '\n'))
1158 struct Lisp_Vector
*dp
1159 = window_display_table (XWINDOW (selected_window
));
1166 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1169 /* Do it only for char codes
1170 that by default display as themselves. */
1171 if (lose
>= 0x20 && lose
<= 0x7e)
1172 no_redisplay
= direct_output_for_insert (lose
);
1174 else if (XTYPE (obj
) == Lisp_Vector
1175 && XVECTOR (obj
)->size
== 1
1176 && (XTYPE (obj
= XVECTOR (obj
)->contents
[0])
1178 /* Insist face not specified in glyph. */
1179 && (XINT (obj
) & ((-1) << 8)) == 0)
1181 = direct_output_for_insert (XINT (obj
));
1185 if (lose
>= 0x20 && lose
<= 0x7e)
1186 no_redisplay
= direct_output_for_insert (lose
);
1193 /* Here for a command that isn't executed directly */
1196 if (NILP (Vprefix_arg
))
1198 Fcommand_execute (this_command
, Qnil
);
1203 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1204 safe_run_hooks (&Vpost_command_hook
);
1206 /* If there is a prefix argument,
1207 1) We don't want last_command to be ``universal-argument''
1208 (that would be dumb), so don't set last_command,
1209 2) we want to leave echoing on so that the prefix will be
1210 echoed as part of this key sequence, so don't call
1212 3) we want to leave this_command_key_count non-zero, so that
1213 read_char will realize that it is re-reading a character, and
1214 not echo it a second time. */
1215 if (NILP (Vprefix_arg
))
1217 last_command
= this_command
;
1219 this_command_key_count
= 0;
1222 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1224 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1226 current_buffer
->mark_active
= Qnil
;
1227 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1229 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1230 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1235 /* If we get an error while running the hook, cause the hook variable
1236 to be nil. Also inhibit quits, so that C-g won't cause the hook
1237 to mysteriously evaporate. */
1239 safe_run_hooks (hook
)
1242 int count
= specpdl_ptr
- specpdl
;
1243 specbind (Qinhibit_quit
, Qt
);
1245 Vcommand_hook_internal
= *hook
;
1247 call1 (Vrun_hooks
, Qcommand_hook_internal
);
1248 *hook
= Vcommand_hook_internal
;
1250 unbind_to (count
, Qnil
);
1253 /* Number of seconds between polling for input. */
1256 /* Nonzero means polling for input is temporarily suppressed. */
1257 int poll_suppress_count
;
1259 #ifdef POLL_FOR_INPUT
1260 int polling_for_input
;
1262 /* Handle an alarm once each second and read pending input
1263 so as to handle a C-g if it comces in. */
1266 input_poll_signal ()
1268 if (interrupt_input_blocked
== 0
1269 && !waiting_for_input
)
1270 read_avail_input (0);
1271 signal (SIGALRM
, input_poll_signal
);
1272 alarm (polling_period
);
1277 /* Begin signals to poll for input, if they are appropriate.
1278 This function is called unconditionally from various places. */
1282 #ifdef POLL_FOR_INPUT
1283 if (read_socket_hook
&& !interrupt_input
)
1285 poll_suppress_count
--;
1286 if (poll_suppress_count
== 0)
1288 signal (SIGALRM
, input_poll_signal
);
1289 polling_for_input
= 1;
1290 alarm (polling_period
);
1296 /* Turn off polling. */
1300 #ifdef POLL_FOR_INPUT
1301 if (read_socket_hook
&& !interrupt_input
)
1303 if (poll_suppress_count
== 0)
1305 polling_for_input
= 0;
1308 poll_suppress_count
++;
1313 /* Set the value of poll_suppress_count to COUNT
1314 and start or stop polling accordingly. */
1317 set_poll_suppress_count (count
)
1320 #ifdef POLL_FOR_INPUT
1321 if (count
== 0 && poll_suppress_count
!= 0)
1323 poll_suppress_count
= 1;
1326 else if (count
!= 0 && poll_suppress_count
== 0)
1330 poll_suppress_count
= count
;
1334 /* Bind polling_period to a value at least N.
1335 But don't decrease it. */
1337 bind_polling_period (n
)
1340 #ifdef POLL_FOR_INPUT
1341 int new = polling_period
;
1347 specbind (Qpolling_period
, make_number (new));
1348 /* Start a new alarm with the new period. */
1353 /* Applying the control modifier to CHARACTER. */
1358 /* Save the upper bits here. */
1359 int upper
= c
& ~0177;
1363 /* Everything in the columns containing the upper-case letters
1364 denotes a control character. */
1365 if (c
>= 0100 && c
< 0140)
1369 /* Set the shift modifier for a control char
1370 made from a shifted letter. But only for letters! */
1371 if (oc
>= 'A' && oc
<= 'Z')
1372 c
|= shift_modifier
;
1375 /* The lower-case letters denote control characters too. */
1376 else if (c
>= 'a' && c
<= 'z')
1379 /* Include the bits for control and shift
1380 only if the basic ASCII code can't indicate them. */
1384 /* Replace the high bits. */
1385 c
|= (upper
& ~ctrl_modifier
);
1392 /* Input of single characters from keyboard */
1394 Lisp_Object
print_help ();
1395 static Lisp_Object
kbd_buffer_get_event ();
1397 /* read a character from the keyboard; call the redisplay if needed */
1398 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1399 -1 means do not do redisplay, but do do autosaving.
1402 /* The arguments MAPS and NMAPS are for menu prompting.
1403 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1405 PREV_EVENT is the previous input event, or nil if we are reading
1406 the first event of a key sequence.
1408 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1409 if we used a mouse menu to read the input, or zero otherwise. If
1410 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
1412 Value is t if we showed a menu and the user rejected it. */
1415 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1419 Lisp_Object prev_event
;
1420 int *used_mouse_menu
;
1422 register Lisp_Object c
;
1426 if (CONSP (Vunread_command_events
))
1428 c
= XCONS (Vunread_command_events
)->car
;
1429 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1431 if (this_command_key_count
== 0)
1437 if (unread_command_char
!= -1)
1439 XSET (c
, Lisp_Int
, unread_command_char
);
1440 unread_command_char
= -1;
1442 if (this_command_key_count
== 0)
1448 if (!NILP (Vexecuting_macro
))
1451 /* We set this to Qmacro; since that's not a frame, nobody will
1452 try to switch frames on us, and the selected window will
1455 Since this event came from a macro, it would be misleading to
1456 leave internal_last_event_frame set to wherever the last
1457 real event came from. Normally, a switch-frame event selects
1458 internal_last_event_frame after each command is read, but
1459 events read from a macro should never cause a new frame to be
1461 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1464 /* Exit the macro if we are at the end.
1465 Also, some things replace the macro with t
1466 to force an early exit. */
1467 if (EQ (Vexecuting_macro
, Qt
)
1468 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1470 XSET (c
, Lisp_Int
, -1);
1474 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1475 if (XTYPE (Vexecuting_macro
) == Lisp_String
1476 && (XINT (c
) & 0x80))
1477 XFASTINT (c
) = CHAR_META
| (XINT (c
) & ~0x80);
1479 executing_macro_index
++;
1484 if (!NILP (unread_switch_frame
))
1486 c
= unread_switch_frame
;
1487 unread_switch_frame
= Qnil
;
1489 /* This event should make it into this_command_keys, and get echoed
1490 again, so we go to reread_first, rather than reread. */
1494 /* Don't bother updating menu bars while doing mouse tracking.
1495 We get events very rapidly then, and the menu bar won't be changing.
1496 We do update the menu bar once on entry to Ftrack_mouse. */
1497 if (commandflag
> 0 && !input_pending
&& !detect_input_pending ())
1498 prepare_menu_bars ();
1500 /* Save outer setjmp data, in case called recursively. */
1501 save_getcjmp (save_jump
);
1505 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1508 if (_setjmp (getcjmp
))
1510 XSET (c
, Lisp_Int
, quit_char
);
1512 XSET (internal_last_event_frame
, Lisp_Frame
, selected_frame
);
1513 Vlast_event_frame
= internal_last_event_frame
;
1515 /* If we report the quit char as an event,
1516 don't do so more than once. */
1517 if (!NILP (Vinhibit_quit
))
1523 /* Message turns off echoing unless more keystrokes turn it on again. */
1524 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1527 /* If already echoing, continue. */
1530 /* Try reading a character via menu prompting in the minibuf.
1531 Try this before the sit-for, because the sit-for
1532 would do the wrong thing if we are supposed to do
1533 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1534 after a mouse event so don't try a minibuf menu. */
1536 if (nmaps
> 0 && INTERACTIVE
1537 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1538 /* Don't bring up a menu if we already have another event. */
1539 && NILP (Vunread_command_events
)
1540 && unread_command_char
< 0
1541 && !detect_input_pending ())
1543 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1548 /* If in middle of key sequence and minibuffer not active,
1549 start echoing if enough time elapses. */
1550 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1552 && echo_keystrokes
> 0
1553 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1557 /* After a mouse event, start echoing right away.
1558 This is because we are probably about to display a menu,
1559 and we don't want to delay before doing so. */
1560 if (EVENT_HAS_PARAMETERS (prev_event
))
1564 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1570 /* Maybe auto save due to number of keystrokes or idle time. */
1572 if (commandflag
!= 0
1573 && auto_save_interval
> 0
1574 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1575 && !detect_input_pending ())
1578 save_getcjmp (temp
);
1579 Fdo_auto_save (Qnil
, Qnil
);
1580 restore_getcjmp (temp
);
1583 /* Try reading using an X menu.
1584 This is never confused with reading using the minibuf
1585 because the recursive call of read_char in read_char_minibuf_menu_prompt
1586 does not pass on any keymaps. */
1587 if (nmaps
> 0 && INTERACTIVE
1588 && !NILP (prev_event
) && EVENT_HAS_PARAMETERS (prev_event
)
1589 /* Don't bring up a menu if we already have another event. */
1590 && NILP (Vunread_command_events
)
1591 && unread_command_char
< 0)
1592 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1594 /* Slow down auto saves logarithmically in size of current buffer,
1595 and garbage collect while we're at it. */
1596 if (INTERACTIVE
&& NILP (c
))
1598 int delay_level
, buffer_size
;
1600 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1601 last_non_minibuf_size
= Z
- BEG
;
1602 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1604 while (buffer_size
> 64)
1605 delay_level
++, buffer_size
-= buffer_size
>> 2;
1606 if (delay_level
< 4) delay_level
= 4;
1607 /* delay_level is 4 for files under around 50k, 7 at 100k,
1608 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1610 /* Auto save if enough time goes by without input. */
1611 if (commandflag
!= 0
1612 && num_nonmacro_input_chars
> last_auto_save
1613 && XTYPE (Vauto_save_timeout
) == Lisp_Int
1614 && XINT (Vauto_save_timeout
) > 0)
1617 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1618 tem0
= sit_for (delay
, 0, 1, 1);
1622 save_getcjmp (temp
);
1623 Fdo_auto_save (Qnil
, Qnil
);
1624 restore_getcjmp (temp
);
1626 /* If we have auto-saved and there is still no input
1627 available, garbage collect if there has been enough
1628 consing going on to make it worthwhile. */
1629 if (!detect_input_pending ()
1630 && consing_since_gc
> gc_cons_threshold
/ 2)
1632 Fgarbage_collect ();
1633 /* prepare_menu_bars isn't safe here, but it should
1634 also be unnecessary. */
1641 /* Actually read a character, waiting if necessary. */
1644 c
= kbd_buffer_get_event ();
1647 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1651 /* Terminate Emacs in batch mode if at eof. */
1652 if (noninteractive
&& XTYPE (c
) == Lisp_Int
&& XINT (c
) < 0)
1653 Fkill_emacs (make_number (1));
1655 if (XTYPE (c
) == Lisp_Int
)
1657 /* Add in any extra modifiers, where appropriate. */
1658 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1659 || ((extra_keyboard_modifiers
& 0177) < ' '
1660 && (extra_keyboard_modifiers
& 0177) != 0))
1661 XSETINT (c
, make_ctrl_char (XINT (c
)));
1663 /* Transfer any other modifier bits directly from
1664 extra_keyboard_modifiers to c. Ignore the actual character code
1665 in the low 16 bits of extra_keyboard_modifiers. */
1666 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
1671 restore_getcjmp (save_jump
);
1675 /* Don't wipe the echo area for a trivial event. */
1676 if (XTYPE (c
) != Lisp_Buffer
)
1677 echo_area_glyphs
= 0;
1679 /* Handle things that only apply to characters. */
1680 if (XTYPE (c
) == Lisp_Int
)
1682 /* If kbd_buffer_get_event gave us an EOF, return that. */
1686 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
1687 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1688 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1692 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1693 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1694 recent_keys_index
= 0;
1696 /* Write c to the dribble file. If c is a lispy event, write
1697 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1698 If you, dear reader, have a better idea, you've got the source. :-) */
1701 if (XTYPE (c
) == Lisp_Int
)
1702 putc (XINT (c
), dribble
);
1705 Lisp_Object dribblee
;
1707 /* If it's a structured event, take the event header. */
1708 dribblee
= EVENT_HEAD (c
);
1710 if (XTYPE (dribblee
) == Lisp_Symbol
)
1712 putc ('<', dribble
);
1713 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1714 XSYMBOL (dribblee
)->name
->size
,
1716 putc ('>', dribble
);
1723 store_kbd_macro_char (c
);
1725 num_nonmacro_input_chars
++;
1730 /* Don't echo mouse motion events. */
1731 if (! (EVENT_HAS_PARAMETERS (c
)
1732 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1735 /* Record this character as part of the current key. */
1736 add_command_key (c
);
1738 /* Re-reading in the middle of a command */
1740 last_input_char
= c
;
1743 /* Process the help character specially if enabled */
1744 if (EQ (c
, Vhelp_char
) && !NILP (Vhelp_form
))
1747 count
= specpdl_ptr
- specpdl
;
1749 record_unwind_protect (Fset_window_configuration
,
1750 Fcurrent_window_configuration (Qnil
));
1752 tem0
= Feval (Vhelp_form
);
1753 if (XTYPE (tem0
) == Lisp_String
)
1754 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1758 c
= read_char (0, 0, 0, Qnil
, 0);
1759 while (XTYPE (c
) == Lisp_Buffer
);
1760 /* Remove the help from the frame */
1761 unbind_to (count
, Qnil
);
1762 prepare_menu_bars ();
1764 if (EQ (c
, make_number (040)))
1768 c
= read_char (0, 0, 0, Qnil
, 0);
1769 while (XTYPE (c
) == Lisp_Buffer
);
1780 Fprinc (object
, Qnil
);
1784 /* Copy out or in the info on where C-g should throw to.
1785 This is used when running Lisp code from within get_char,
1786 in case get_char is called recursively.
1787 See read_process_output. */
1792 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1795 restore_getcjmp (temp
)
1798 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1802 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1803 of this function. */
1805 tracking_off (old_value
)
1806 Lisp_Object old_value
;
1808 if (! XFASTINT (old_value
))
1810 do_mouse_tracking
= 0;
1812 /* Redisplay may have been preempted because there was input
1813 available, and it assumes it will be called again after the
1814 input has been processed. If the only input available was
1815 the sort that we have just disabled, then we need to call
1817 if (!readable_events ())
1819 prepare_menu_bars ();
1820 redisplay_preserve_echo_area ();
1821 get_input_pending (&input_pending
);
1826 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1827 "Evaluate BODY with mouse movement events enabled.\n\
1828 Within a `track-mouse' form, mouse motion generates input events that\n\
1829 you can read with `read-event'.\n\
1830 Normally, mouse motion is ignored.")
1834 int count
= specpdl_ptr
- specpdl
;
1837 XSET (val
, Lisp_Int
, do_mouse_tracking
);
1838 record_unwind_protect (tracking_off
, val
);
1840 if (!input_pending
&& !detect_input_pending ())
1841 prepare_menu_bars ();
1843 do_mouse_tracking
= 1;
1845 val
= Fprogn (args
);
1846 return unbind_to (count
, val
);
1849 /* Low level keyboard/mouse input.
1850 kbd_buffer_store_event places events in kbd_buffer, and
1851 kbd_buffer_get_event retrieves them.
1852 mouse_moved indicates when the mouse has moved again, and
1853 *mouse_position_hook provides the mouse position. */
1855 /* Return true iff there are any events in the queue that read-char
1856 would return. If this returns false, a read-char would block. */
1860 return ! EVENT_QUEUES_EMPTY
;
1863 /* Set this for debugging, to have a way to get out */
1866 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
1869 kbd_buffer_store_event (event
)
1870 register struct input_event
*event
;
1872 if (event
->kind
== no_event
)
1875 if (event
->kind
== ascii_keystroke
)
1877 register int c
= event
->code
& 0377;
1879 if (event
->modifiers
& ctrl_modifier
)
1880 c
= make_ctrl_char (c
);
1882 c
|= (event
->modifiers
1883 & (meta_modifier
| alt_modifier
1884 | hyper_modifier
| super_modifier
));
1888 extern SIGTYPE
interrupt_signal ();
1891 /* If this results in a quit_char being returned to Emacs as
1892 input, set Vlast_event_frame properly. If this doesn't
1893 get returned to Emacs as an event, the next event read
1894 will set Vlast_event_frame again, so this is safe to do. */
1898 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
1900 internal_last_event_frame
= event
->frame_or_window
;
1902 internal_last_event_frame
= focus
;
1903 Vlast_event_frame
= internal_last_event_frame
;
1907 last_event_timestamp
= event
->timestamp
;
1908 interrupt_signal ();
1912 if (c
&& c
== stop_character
)
1919 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
1920 kbd_store_ptr
= kbd_buffer
;
1922 /* Don't let the very last slot in the buffer become full,
1923 since that would make the two pointers equal,
1924 and that is indistinguishable from an empty buffer.
1925 Discard the event if it would fill the last slot. */
1926 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
1928 kbd_store_ptr
->kind
= event
->kind
;
1929 if (event
->kind
== selection_request_event
)
1931 /* We must not use the ordinary copying code for this case,
1932 since `part' is an enum and copying it might not copy enough
1934 bcopy (event
, kbd_store_ptr
, sizeof (*event
));
1938 kbd_store_ptr
->code
= event
->code
;
1939 kbd_store_ptr
->part
= event
->part
;
1940 kbd_store_ptr
->frame_or_window
= event
->frame_or_window
;
1941 kbd_store_ptr
->modifiers
= event
->modifiers
;
1942 kbd_store_ptr
->x
= event
->x
;
1943 kbd_store_ptr
->y
= event
->y
;
1944 kbd_store_ptr
->timestamp
= event
->timestamp
;
1946 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
1948 = event
->frame_or_window
);
1954 /* Read one event from the event buffer, waiting if necessary.
1955 The value is a Lisp object representing the event.
1956 The value is nil for an event that should be ignored,
1957 or that was handled here.
1958 We always read and discard one event. */
1961 kbd_buffer_get_event ()
1969 XSET (obj
, Lisp_Int
, c
);
1973 /* Wait until there is input available. */
1976 if (!EVENT_QUEUES_EMPTY
)
1979 /* If the quit flag is set, then read_char will return
1980 quit_char, so that counts as "available input." */
1981 if (!NILP (Vquit_flag
))
1982 quit_throw_to_read_char ();
1984 /* One way or another, wait until input is available; then, if
1985 interrupt handlers have not read it, read it now. */
1988 wait_for_kbd_input ();
1990 /* Note SIGIO has been undef'd if FIONREAD is missing. */
1994 if (EVENT_QUEUES_EMPTY
)
1996 Lisp_Object minus_one
;
1998 XSET (minus_one
, Lisp_Int
, -1);
1999 wait_reading_process_input (0, 0, minus_one
, 1);
2001 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
2002 /* Pass 1 for EXPECT since we just waited to have input. */
2003 read_avail_input (1);
2005 #endif /* not VMS */
2008 /* At this point, we know that there is a readable event available
2009 somewhere. If the event queue is empty, then there must be a
2010 mouse movement enabled and available. */
2011 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2013 struct input_event
*event
;
2015 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2019 last_event_timestamp
= event
->timestamp
;
2023 /* These two kinds of events get special handling
2024 and don't actually appear to the command loop.
2025 We return nil for them. */
2026 if (event
->kind
== selection_request_event
)
2029 x_handle_selection_request (event
);
2030 kbd_fetch_ptr
= event
+ 1;
2032 /* We're getting selection request events, but we don't have
2038 else if (event
->kind
== selection_clear_event
)
2041 x_handle_selection_clear (event
);
2042 kbd_fetch_ptr
= event
+ 1;
2044 /* We're getting selection request events, but we don't have
2050 else if (event
->kind
== delete_window_event
)
2052 Lisp_Object tail
, frame
;
2055 /* If the user destroys the only frame, Emacs should exit.
2056 Count visible frames and iconified frames. */
2057 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2059 frame
= XCONS (tail
)->car
;
2060 if (XTYPE (frame
) != Lisp_Frame
|| EQ (frame
, event
->frame_or_window
))
2063 if (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
))
2070 Fdelete_frame (event
->frame_or_window
, Qt
);
2071 kbd_fetch_ptr
= event
+ 1;
2074 else if (event
->kind
== menu_bar_event
)
2076 /* The event value is in the frame_or_window slot. */
2077 obj
= event
->frame_or_window
;
2078 kbd_fetch_ptr
= event
+ 1;
2080 else if (event
->kind
== buffer_switch_event
)
2082 /* The value doesn't matter here; only the type is tested. */
2083 XSET (obj
, Lisp_Buffer
, current_buffer
);
2084 kbd_fetch_ptr
= event
+ 1;
2086 /* Just discard these, by returning nil.
2087 (They shouldn't be found in the buffer,
2088 but on some machines it appears they do show up.) */
2089 else if (event
->kind
== no_event
)
2090 kbd_fetch_ptr
= event
+ 1;
2092 /* If this event is on a different frame, return a switch-frame this
2093 time, and leave the event in the queue for next time. */
2100 frame
= event
->frame_or_window
;
2101 if (XTYPE (frame
) == Lisp_Window
)
2102 frame
= WINDOW_FRAME (XWINDOW (frame
));
2104 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2108 if (! EQ (frame
, internal_last_event_frame
)
2109 && XFRAME (frame
) != selected_frame
)
2110 obj
= make_lispy_switch_frame (frame
);
2111 internal_last_event_frame
= frame
;
2112 #endif /* MULTI_FRAME */
2114 /* If we didn't decide to make a switch-frame event, go ahead
2115 and build a real event from the queue entry. */
2119 obj
= make_lispy_event (event
);
2121 /* Wipe out this event, to catch bugs. */
2122 event
->kind
= no_event
;
2123 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
2126 kbd_fetch_ptr
= event
+ 1;
2130 /* Try generating a mouse motion event. */
2131 else if (do_mouse_tracking
&& mouse_moved
)
2134 Lisp_Object bar_window
;
2135 enum scroll_bar_part part
;
2139 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
2144 /* Decide if we should generate a switch-frame event. Don't
2145 generate switch-frame events for motion outside of all Emacs
2151 frame
= FRAME_FOCUS_FRAME (f
);
2153 XSET (frame
, Lisp_Frame
, f
);
2155 if (! EQ (frame
, internal_last_event_frame
)
2156 && XFRAME (frame
) != selected_frame
)
2157 obj
= make_lispy_switch_frame (frame
);
2158 internal_last_event_frame
= frame
;
2161 /* If we didn't decide to make a switch-frame event, go ahead and
2162 return a mouse-motion event. */
2164 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2168 /* We were promised by the above while loop that there was
2169 something for us to read! */
2172 input_pending
= readable_events ();
2175 Vlast_event_frame
= internal_last_event_frame
;
2181 /* Process any events that are not user-visible,
2182 then return, without reading any user-visible events. */
2187 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2189 struct input_event
*event
;
2191 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2195 last_event_timestamp
= event
->timestamp
;
2197 /* These two kinds of events get special handling
2198 and don't actually appear to the command loop. */
2199 if (event
->kind
== selection_request_event
)
2202 x_handle_selection_request (event
);
2203 kbd_fetch_ptr
= event
+ 1;
2205 /* We're getting selection request events, but we don't have
2211 else if (event
->kind
== selection_clear_event
)
2214 x_handle_selection_clear (event
);
2215 kbd_fetch_ptr
= event
+ 1;
2217 /* We're getting selection request events, but we don't have
2226 get_input_pending (&input_pending
);
2229 /* Caches for modify_event_symbol. */
2230 static Lisp_Object accent_key_syms
;
2231 static Lisp_Object system_key_syms
;
2232 static Lisp_Object func_key_syms
;
2233 static Lisp_Object mouse_syms
;
2235 Lisp_Object Vsystem_key_alist
;
2237 /* This is a list of keysym codes for special "accent" characters.
2238 It parallels lispy_accent_keys. */
2240 static int lispy_accent_codes
[] =
2242 #ifdef XK_dead_circumflex
2247 #ifdef XK_dead_grave
2252 #ifdef XK_dead_tilde
2257 #ifdef XK_dead_diaeresis
2262 #ifdef XK_dead_macron
2267 #ifdef XK_dead_degree
2272 #ifdef XK_dead_acute
2277 #ifdef XK_dead_cedilla
2282 #ifdef XK_dead_breve
2287 #ifdef XK_dead_ogonek
2292 #ifdef XK_dead_caron
2297 #ifdef XK_dead_doubleacute
2298 XK_dead_doubleacute
,
2302 #ifdef XK_dead_abovedot
2309 /* This is a list of Lisp names for special "accent" characters.
2310 It parallels lispy_accent_codes. */
2312 static char *lispy_accent_keys
[] =
2329 /* You'll notice that this table is arranged to be conveniently
2330 indexed by X Windows keysym values. */
2331 static char *lispy_function_keys
[] =
2333 /* X Keysym value */
2335 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2343 0, 0, 0, /* 0xff10 */
2345 0, 0, 0, 0, 0, 0, 0,
2348 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2349 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2350 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2352 "home", /* 0xff50 */ /* IsCursorKey */
2363 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2374 "break", /* 0xff6b */
2376 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
2378 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2379 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2380 0, 0, 0, 0, 0, 0, 0, 0,
2381 "kp-tab", /* 0xff89 */
2383 "kp-enter", /* 0xff8d */
2385 "kp-f1", /* 0xff91 */
2389 "kp-home", /* 0xff95 */
2394 "kp-prior", /* kp-page-up */
2395 "kp-next", /* kp-page-down */
2401 0, 0, 0, 0, 0, 0, 0, 0, 0,
2402 "kp-multiply", /* 0xffaa */
2407 "kp-divide", /* 0xffaf */
2408 "kp-0", /* 0xffb0 */
2409 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2412 "kp-equal", /* 0xffbd */
2413 "f1", /* 0xffbe */ /* IsFunctionKey */
2415 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2416 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2417 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2418 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2419 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2420 0, 0, 0, 0, 0, 0, 0, 0,
2421 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2422 0, 0, 0, 0, 0, 0, 0, "delete"
2425 static char *lispy_mouse_names
[] =
2427 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2430 /* Scroll bar parts. */
2431 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2433 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2434 Lisp_Object
*scroll_bar_parts
[] = {
2435 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2439 /* A vector, indexed by button number, giving the down-going location
2440 of currently depressed buttons, both scroll bar and non-scroll bar.
2442 The elements have the form
2443 (BUTTON-NUMBER MODIFIER-MASK . REST)
2444 where REST is the cdr of a position as it would be reported in the event.
2446 The make_lispy_event function stores positions here to tell the
2447 difference between click and drag events, and to store the starting
2448 location to be included in drag events. */
2450 static Lisp_Object button_down_location
;
2452 /* Information about the most recent up-going button event: Which
2453 button, what location, and what time. */
2455 static int last_mouse_button
;
2456 static int last_mouse_x
;
2457 static int last_mouse_y
;
2458 static unsigned long button_down_time
;
2460 /* The maximum time between clicks to make a double-click,
2461 or Qnil to disable double-click detection,
2462 or Qt for no time limit. */
2463 Lisp_Object Vdouble_click_time
;
2465 /* The number of clicks in this multiple-click. */
2467 int double_click_count
;
2469 #ifdef USE_X_TOOLKIT
2470 extern Lisp_Object
map_event_to_object ();
2471 #endif /* USE_X_TOOLKIT */
2473 /* Given a struct input_event, build the lisp event which represents
2474 it. If EVENT is 0, build a mouse movement event from the mouse
2475 movement buffer, which should have a movement event in it.
2477 Note that events must be passed to this function in the order they
2478 are received; this function stores the location of button presses
2479 in order to build drag events when the button is released. */
2482 make_lispy_event (event
)
2483 struct input_event
*event
;
2487 #ifdef SWITCH_ENUM_BUG
2488 switch ((int) event
->kind
)
2490 switch (event
->kind
)
2493 /* A simple keystroke. */
2494 case ascii_keystroke
:
2496 int c
= event
->code
& 0377;
2497 /* Turn ASCII characters into control characters
2499 if (event
->modifiers
& ctrl_modifier
)
2500 c
= make_ctrl_char (c
);
2502 /* Add in the other modifier bits. We took care of ctrl_modifier
2503 just above, and the shift key was taken care of by the X code,
2504 and applied to control characters by make_ctrl_char. */
2505 c
|= (event
->modifiers
2506 & (meta_modifier
| alt_modifier
2507 | hyper_modifier
| super_modifier
));
2508 button_down_time
= 0;
2512 /* A function key. The symbol may need to have modifier prefixes
2514 case non_ascii_keystroke
:
2515 button_down_time
= 0;
2517 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
2518 if (event
->code
== lispy_accent_codes
[i
])
2519 return modify_event_symbol (i
,
2521 Qfunction_key
, Qnil
,
2522 lispy_accent_keys
, &accent_key_syms
,
2523 (sizeof (lispy_accent_keys
)
2524 / sizeof (lispy_accent_keys
[0])));
2526 /* Handle system-specific keysyms. */
2527 if (event
->code
& (1 << 28))
2529 /* We need to use an alist rather than a vector as the cache
2530 since we can't make a vector long enuf. */
2531 if (NILP (system_key_syms
))
2532 system_key_syms
= Fcons (Qnil
, Qnil
);
2533 return modify_event_symbol (event
->code
& 0xffffff,
2535 Qfunction_key
, Vsystem_key_alist
,
2536 0, &system_key_syms
, 0xffffff);
2539 return modify_event_symbol (event
->code
- 0xff00,
2541 Qfunction_key
, Qnil
,
2542 lispy_function_keys
, &func_key_syms
,
2543 (sizeof (lispy_function_keys
)
2544 / sizeof (lispy_function_keys
[0])));
2547 #if defined(MULTI_FRAME) || defined(HAVE_MOUSE)
2548 /* A mouse click. Figure out where it is, decide whether it's
2549 a press, click or drag, and build the appropriate structure. */
2551 case scroll_bar_click
:
2553 int button
= event
->code
;
2555 Lisp_Object position
;
2556 Lisp_Object
*start_pos_ptr
;
2557 Lisp_Object start_pos
;
2559 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2562 /* Build the position as appropriate for this mouse click. */
2563 if (event
->kind
== mouse_click
)
2566 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2571 /* Ignore mouse events that were made on frame that
2572 have been deleted. */
2573 if (! FRAME_LIVE_P (f
))
2576 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
2577 &column
, &row
, 0, 0);
2579 #ifdef USE_X_TOOLKIT
2580 if (FRAME_EXTERNAL_MENU_BAR (f
) && XINT (event
->y
) == -1)
2582 if (row
< FRAME_MENU_BAR_LINES (f
))
2585 Lisp_Object items
, item
;
2587 #ifdef USE_X_TOOLKIT
2588 /* The click happened in the menubar.
2589 Look for the menu item selected. */
2590 item
= map_event_to_object (event
, f
);
2592 XFASTINT (event
->y
) = 1;
2593 #else /* not USE_X_TOOLKIT */
2598 items
= FRAME_MENU_BAR_ITEMS (f
);
2599 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 3)
2601 Lisp_Object pos
, string
;
2602 string
= XVECTOR (items
)->contents
[i
+ 1];
2603 pos
= XVECTOR (items
)->contents
[i
+ 2];
2606 if (column
>= XINT (pos
)
2607 && column
< XINT (pos
) + XSTRING (string
)->size
)
2609 item
= XVECTOR (items
)->contents
[i
];
2613 #endif /* not USE_X_TOOLKIT */
2616 = Fcons (event
->frame_or_window
,
2618 Fcons (Fcons (event
->x
, event
->y
),
2619 Fcons (make_number (event
->timestamp
),
2622 return Fcons (item
, Fcons (position
, Qnil
));
2625 window
= window_from_coordinates (f
, column
, row
, &part
);
2627 if (XTYPE (window
) != Lisp_Window
)
2631 int pixcolumn
, pixrow
;
2632 column
-= XINT (XWINDOW (window
)->left
);
2633 row
-= XINT (XWINDOW (window
)->top
);
2634 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
2635 XSETINT (event
->x
, pixcolumn
);
2636 XSETINT (event
->y
, pixrow
);
2641 posn
= Qvertical_line
;
2643 XSET (posn
, Lisp_Int
,
2644 buffer_posn_from_coords (XWINDOW (window
),
2651 Fcons (Fcons (event
->x
, event
->y
),
2652 Fcons (make_number (event
->timestamp
),
2658 Lisp_Object portion_whole
;
2661 window
= event
->frame_or_window
;
2662 portion_whole
= Fcons (event
->x
, event
->y
);
2663 part
= *scroll_bar_parts
[(int) event
->part
];
2667 Fcons (Qvertical_scroll_bar
,
2668 Fcons (portion_whole
,
2669 Fcons (make_number (event
->timestamp
),
2670 Fcons (part
, Qnil
)))));
2673 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2675 start_pos
= *start_pos_ptr
;
2676 *start_pos_ptr
= Qnil
;
2678 is_double
= (button
== last_mouse_button
2679 && XINT (event
->x
) == last_mouse_x
2680 && XINT (event
->y
) == last_mouse_y
2681 && button_down_time
!= 0
2682 && (EQ (Vdouble_click_time
, Qt
)
2683 || (INTEGERP (Vdouble_click_time
)
2684 && ((int)(event
->timestamp
- button_down_time
)
2685 < XINT (Vdouble_click_time
)))));
2686 last_mouse_button
= button
;
2687 last_mouse_x
= XINT (event
->x
);
2688 last_mouse_y
= XINT (event
->y
);
2690 /* If this is a button press, squirrel away the location, so
2691 we can decide later whether it was a click or a drag. */
2692 if (event
->modifiers
& down_modifier
)
2696 double_click_count
++;
2697 event
->modifiers
|= ((double_click_count
> 2)
2702 double_click_count
= 1;
2703 button_down_time
= event
->timestamp
;
2704 *start_pos_ptr
= Fcopy_alist (position
);
2707 /* Now we're releasing a button - check the co-ordinates to
2708 see if this was a click or a drag. */
2709 else if (event
->modifiers
& up_modifier
)
2711 /* If we did not see a down before this up,
2712 ignore the up. Probably this happened because
2713 the down event chose a menu item.
2714 It would be an annoyance to treat the release
2715 of the button that chose the menu item
2716 as a separate event. */
2718 if (XTYPE (start_pos
) != Lisp_Cons
)
2721 event
->modifiers
&= ~up_modifier
;
2722 #if 0 /* Formerly we treated an up with no down as a click event. */
2723 if (XTYPE (start_pos
) != Lisp_Cons
)
2724 event
->modifiers
|= click_modifier
;
2728 /* The third element of every position should be the (x,y)
2732 down
= Fnth (make_number (2), start_pos
);
2733 if (EQ (event
->x
, XCONS (down
)->car
)
2734 && EQ (event
->y
, XCONS (down
)->cdr
))
2736 if (is_double
&& double_click_count
> 1)
2737 event
->modifiers
|= ((double_click_count
> 2)
2741 event
->modifiers
|= click_modifier
;
2745 button_down_time
= 0;
2746 event
->modifiers
|= drag_modifier
;
2751 /* Every mouse event should either have the down_modifier or
2752 the up_modifier set. */
2756 /* Get the symbol we should use for the mouse click. */
2759 head
= modify_event_symbol (button
,
2762 lispy_mouse_names
, &mouse_syms
,
2763 (sizeof (lispy_mouse_names
)
2764 / sizeof (lispy_mouse_names
[0])));
2765 if (event
->modifiers
& drag_modifier
)
2770 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2773 Fcons (make_number (double_click_count
),
2781 #endif /* MULTI_FRAME or HAVE_MOUSE */
2783 /* The 'kind' field of the event is something we don't recognize. */
2792 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2794 Lisp_Object bar_window
;
2795 enum scroll_bar_part part
;
2799 /* Is it a scroll bar movement? */
2800 if (frame
&& ! NILP (bar_window
))
2802 Lisp_Object part_sym
;
2804 part_sym
= *scroll_bar_parts
[(int) part
];
2805 return Fcons (Qscroll_bar_movement
,
2806 (Fcons (Fcons (bar_window
,
2807 Fcons (Qvertical_scroll_bar
,
2808 Fcons (Fcons (x
, y
),
2809 Fcons (make_number (time
),
2815 /* Or is it an ordinary mouse movement? */
2825 /* It's in a frame; which window on that frame? */
2826 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
, 0, 1);
2827 window
= window_from_coordinates (frame
, column
, row
, &area
);
2832 if (XTYPE (window
) == Lisp_Window
)
2834 int pixcolumn
, pixrow
;
2835 column
-= XINT (XWINDOW (window
)->left
);
2836 row
-= XINT (XWINDOW (window
)->top
);
2837 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
2838 XSETINT (x
, pixcolumn
);
2839 XSETINT (y
, pixrow
);
2844 posn
= Qvertical_line
;
2846 XSET (posn
, Lisp_Int
,
2847 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
2849 else if (frame
!= 0)
2851 XSET (window
, Lisp_Frame
, frame
);
2862 return Fcons (Qmouse_movement
,
2863 Fcons (Fcons (window
,
2865 Fcons (Fcons (x
, y
),
2866 Fcons (make_number (time
),
2872 #endif /* MULTI_FRAME */
2874 /* Construct a switch frame event. */
2876 make_lispy_switch_frame (frame
)
2879 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
2882 /* Manipulating modifiers. */
2884 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
2886 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2887 SYMBOL's name of the end of the modifiers; the string from this
2888 position is the unmodified symbol name.
2890 This doesn't use any caches. */
2892 parse_modifiers_uncached (symbol
, modifier_end
)
2896 struct Lisp_String
*name
;
2900 CHECK_SYMBOL (symbol
, 1);
2903 name
= XSYMBOL (symbol
)->name
;
2906 for (i
= 0; i
+2 <= name
->size
; )
2907 switch (name
->data
[i
])
2909 #define SINGLE_LETTER_MOD(bit) \
2910 if (name->data[i+1] != '-') \
2911 goto no_more_modifiers; \
2916 SINGLE_LETTER_MOD (alt_modifier
);
2920 SINGLE_LETTER_MOD (ctrl_modifier
);
2924 SINGLE_LETTER_MOD (hyper_modifier
);
2928 SINGLE_LETTER_MOD (meta_modifier
);
2932 SINGLE_LETTER_MOD (shift_modifier
);
2936 SINGLE_LETTER_MOD (super_modifier
);
2940 if (i
+ 5 > name
->size
)
2941 goto no_more_modifiers
;
2942 if (! strncmp (name
->data
+ i
, "drag-", 5))
2944 modifiers
|= drag_modifier
;
2947 else if (! strncmp (name
->data
+ i
, "down-", 5))
2949 modifiers
|= down_modifier
;
2952 else if (i
+ 7 <= name
->size
2953 && ! strncmp (name
->data
+ i
, "double-", 7))
2955 modifiers
|= double_modifier
;
2959 goto no_more_modifiers
;
2963 if (i
+ 7 > name
->size
)
2964 goto no_more_modifiers
;
2965 if (! strncmp (name
->data
+ i
, "triple-", 7))
2967 modifiers
|= triple_modifier
;
2971 goto no_more_modifiers
;
2975 goto no_more_modifiers
;
2977 #undef SINGLE_LETTER_MOD
2981 /* Should we include the `click' modifier? */
2982 if (! (modifiers
& (down_modifier
| drag_modifier
2983 | double_modifier
| triple_modifier
))
2984 && i
+ 7 == name
->size
2985 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
2986 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
2987 modifiers
|= click_modifier
;
2996 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
2997 prepended to the string BASE[0..BASE_LEN-1].
2998 This doesn't use any caches. */
3000 apply_modifiers_uncached (modifiers
, base
, base_len
)
3005 /* Since BASE could contain nulls, we can't use intern here; we have
3006 to use Fintern, which expects a genuine Lisp_String, and keeps a
3009 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
3015 /* Only the event queue may use the `up' modifier; it should always
3016 be turned into a click or drag event before presented to lisp code. */
3017 if (modifiers
& up_modifier
)
3020 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
3021 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
3022 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
3023 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
3024 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
3025 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
3026 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
3027 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
3028 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
3029 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
3030 /* The click modifier is denoted by the absence of other modifiers. */
3034 mod_len
= p
- new_mods
;
3038 Lisp_Object new_name
;
3040 new_name
= make_uninit_string (mod_len
+ base_len
);
3041 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
3042 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
3044 return Fintern (new_name
, Qnil
);
3049 static char *modifier_names
[] =
3051 "up", "down", "drag", "click", "double", "triple", 0, 0,
3052 0, 0, 0, 0, 0, 0, 0, 0,
3053 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
3055 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
3057 static Lisp_Object modifier_symbols
;
3059 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
3061 lispy_modifier_list (modifiers
)
3064 Lisp_Object modifier_list
;
3067 modifier_list
= Qnil
;
3068 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
3069 if (modifiers
& (1<<i
))
3070 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
3073 return modifier_list
;
3077 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
3078 where UNMODIFIED is the unmodified form of SYMBOL,
3079 MASK is the set of modifiers present in SYMBOL's name.
3080 This is similar to parse_modifiers_uncached, but uses the cache in
3081 SYMBOL's Qevent_symbol_element_mask property, and maintains the
3082 Qevent_symbol_elements property. */
3084 parse_modifiers (symbol
)
3087 Lisp_Object elements
;
3089 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
3090 if (CONSP (elements
))
3095 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
3096 Lisp_Object unmodified
;
3099 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
3100 XSYMBOL (symbol
)->name
->size
- end
),
3103 if (modifiers
& ~((1<<VALBITS
) - 1))
3105 XFASTINT (mask
) = modifiers
;
3106 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
3108 /* Cache the parsing results on SYMBOL. */
3109 Fput (symbol
, Qevent_symbol_element_mask
,
3111 Fput (symbol
, Qevent_symbol_elements
,
3112 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
3114 /* Since we know that SYMBOL is modifiers applied to unmodified,
3115 it would be nice to put that in unmodified's cache.
3116 But we can't, since we're not sure that parse_modifiers is
3123 /* Apply the modifiers MODIFIERS to the symbol BASE.
3124 BASE must be unmodified.
3126 This is like apply_modifiers_uncached, but uses BASE's
3127 Qmodifier_cache property, if present. It also builds
3128 Qevent_symbol_elements properties, since it has that info anyway.
3130 apply_modifiers copies the value of BASE's Qevent_kind property to
3131 the modified symbol. */
3133 apply_modifiers (modifiers
, base
)
3137 Lisp_Object cache
, index
, entry
, new_symbol
;
3139 /* Mask out upper bits. We don't know where this value's been. */
3140 modifiers
&= (1<<VALBITS
) - 1;
3142 /* The click modifier never figures into cache indices. */
3143 cache
= Fget (base
, Qmodifier_cache
);
3144 XFASTINT (index
) = (modifiers
& ~click_modifier
);
3145 entry
= Fassq (index
, cache
);
3148 new_symbol
= XCONS (entry
)->cdr
;
3151 /* We have to create the symbol ourselves. */
3152 new_symbol
= apply_modifiers_uncached (modifiers
,
3153 XSYMBOL (base
)->name
->data
,
3154 XSYMBOL (base
)->name
->size
);
3156 /* Add the new symbol to the base's cache. */
3157 entry
= Fcons (index
, new_symbol
);
3158 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
3160 /* We have the parsing info now for free, so add it to the caches. */
3161 XFASTINT (index
) = modifiers
;
3162 Fput (new_symbol
, Qevent_symbol_element_mask
,
3163 Fcons (base
, Fcons (index
, Qnil
)));
3164 Fput (new_symbol
, Qevent_symbol_elements
,
3165 Fcons (base
, lispy_modifier_list (modifiers
)));
3168 /* Make sure this symbol is of the same kind as BASE.
3170 You'd think we could just set this once and for all when we
3171 intern the symbol above, but reorder_modifiers may call us when
3172 BASE's property isn't set right; we can't assume that just
3173 because it has a Qmodifier_cache property it must have its
3174 Qevent_kind set right as well. */
3175 if (NILP (Fget (new_symbol
, Qevent_kind
)))
3179 kind
= Fget (base
, Qevent_kind
);
3181 Fput (new_symbol
, Qevent_kind
, kind
);
3188 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
3189 return a symbol with the modifiers placed in the canonical order.
3190 Canonical order is alphabetical, except for down and drag, which
3191 always come last. The 'click' modifier is never written out.
3193 Fdefine_key calls this to make sure that (for example) C-M-foo
3194 and M-C-foo end up being equivalent in the keymap. */
3197 reorder_modifiers (symbol
)
3200 /* It's hopefully okay to write the code this way, since everything
3201 will soon be in caches, and no consing will be done at all. */
3204 parsed
= parse_modifiers (symbol
);
3205 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
3206 XCONS (parsed
)->car
);
3210 /* For handling events, we often want to produce a symbol whose name
3211 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
3212 to some base, like the name of a function key or mouse button.
3213 modify_event_symbol produces symbols of this sort.
3215 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
3216 is the name of the i'th symbol. TABLE_SIZE is the number of elements
3219 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
3220 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
3222 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
3223 persist between calls to modify_event_symbol that it can use to
3224 store a cache of the symbols it's generated for this NAME_TABLE
3225 before. The object stored there may be a vector or an alist.
3227 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
3229 MODIFIERS is a set of modifier bits (as given in struct input_events)
3230 whose prefixes should be applied to the symbol name.
3232 SYMBOL_KIND is the value to be placed in the event_kind property of
3233 the returned symbol.
3235 The symbols we create are supposed to have an
3236 `event-symbol-elements' property, which lists the modifiers present
3237 in the symbol's name. */
3240 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
3241 name_table
, symbol_table
, table_size
)
3244 Lisp_Object symbol_kind
;
3245 Lisp_Object name_alist
;
3247 Lisp_Object
*symbol_table
;
3251 Lisp_Object symbol_int
;
3253 XSET (symbol_int
, Lisp_Int
, symbol_num
);
3255 /* Is this a request for a valid symbol? */
3256 if (symbol_num
< 0 || symbol_num
>= table_size
)
3259 if (CONSP (*symbol_table
))
3260 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
3262 /* If *symbol_table doesn't seem to be initialized properly, fix that.
3263 *symbol_table should be a lisp vector TABLE_SIZE elements long,
3264 where the Nth element is the symbol for NAME_TABLE[N], or nil if
3265 we've never used that symbol before. */
3268 if (! VECTORP (*symbol_table
)
3269 || XVECTOR (*symbol_table
)->size
!= table_size
)
3273 XFASTINT (size
) = table_size
;
3274 *symbol_table
= Fmake_vector (size
, Qnil
);
3277 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
3280 /* Have we already used this symbol before? */
3283 /* No; let's create it. */
3284 if (!NILP (name_alist
))
3285 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
3286 else if (name_table
[symbol_num
])
3287 value
= intern (name_table
[symbol_num
]);
3292 sprintf (buf
, "key-%d", symbol_num
);
3293 value
= intern (buf
);
3296 if (CONSP (*symbol_table
))
3297 *symbol_table
= Fcons (value
, *symbol_table
);
3299 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
3301 /* Fill in the cache entries for this symbol; this also
3302 builds the Qevent_symbol_elements property, which the user
3304 apply_modifiers (modifiers
& click_modifier
, value
);
3305 Fput (value
, Qevent_kind
, symbol_kind
);
3308 /* Apply modifiers to that symbol. */
3309 return apply_modifiers (modifiers
, value
);
3313 /* Store into *addr a value nonzero if terminal input chars are available.
3314 Serves the purpose of ioctl (0, FIONREAD, addr)
3315 but works even if FIONREAD does not exist.
3316 (In fact, this may actually read some input.) */
3319 get_input_pending (addr
)
3322 /* First of all, have we already counted some input? */
3323 *addr
= !NILP (Vquit_flag
) || readable_events ();
3325 /* If input is being read as it arrives, and we have none, there is none. */
3326 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
3329 /* Try to read some input and see how much we get. */
3331 *addr
= !NILP (Vquit_flag
) || readable_events ();
3334 /* Interface to read_avail_input, blocking SIGIO if necessary. */
3337 gobble_input (expected
)
3342 if (interrupt_input
)
3345 mask
= sigblockx (SIGIO
);
3346 read_avail_input (expected
);
3351 read_avail_input (expected
);
3355 /* Put a buffer_switch_event in the buffer
3356 so that read_key_sequence will notice the new current buffer. */
3358 record_asynch_buffer_change ()
3360 struct input_event event
;
3361 event
.kind
= buffer_switch_event
;
3362 event
.frame_or_window
= Qnil
;
3364 /* Make sure no interrupt happens while storing the event. */
3366 if (interrupt_input
)
3369 mask
= sigblockx (SIGIO
);
3370 kbd_buffer_store_event (&event
);
3377 kbd_buffer_store_event (&event
);
3384 /* Read any terminal input already buffered up by the system
3385 into the kbd_buffer, but do not wait.
3387 EXPECTED should be nonzero if the caller knows there is some input.
3389 Except on VMS, all input is read by this function.
3390 If interrupt_input is nonzero, this function MUST be called
3391 only when SIGIO is blocked.
3393 Returns the number of keyboard chars read, or -1 meaning
3394 this is a bad time to try to read input. */
3397 read_avail_input (expected
)
3400 struct input_event buf
[KBD_BUFFER_SIZE
];
3404 if (read_socket_hook
)
3405 /* No need for FIONREAD or fcntl; just say don't wait. */
3406 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
3409 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
3410 the kbd_buffer can really hold. That may prevent loss
3411 of characters on some systems when input is stuffed at us. */
3412 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
3415 /* Determine how many characters we should *try* to read. */
3417 n_to_read
= dos_keysns ();
3420 #else /* not MSDOS */
3422 /* Find out how much input is available. */
3423 if (ioctl (0, FIONREAD
, &n_to_read
) < 0)
3424 /* Formerly simply reported no input, but that sometimes led to
3425 a failure of Emacs to terminate.
3426 SIGHUP seems appropriate if we can't reach the terminal. */
3427 /* ??? Is it really right to send the signal just to this process
3428 rather than to the whole process group?
3429 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3430 kill (getpid (), SIGHUP
);
3433 if (n_to_read
> sizeof cbuf
)
3434 n_to_read
= sizeof cbuf
;
3435 #else /* no FIONREAD */
3436 #if defined(USG) || defined(DGUX)
3437 /* Read some input if available, but don't wait. */
3438 n_to_read
= sizeof cbuf
;
3439 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
3444 #endif /* not MSDOS */
3446 /* Now read; for one reason or another, this will not block.
3447 NREAD is set to the number of chars read. */
3451 cbuf
[0] = dos_keyread();
3454 nread
= read (fileno (stdin
), cbuf
, n_to_read
);
3456 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
3457 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3458 This looks incorrect, but it isn't, because _BSD causes
3459 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3460 and that causes a value other than 0 when there is no input. */
3466 /* We used to retry the read if it was interrupted.
3467 But this does the wrong thing when O_NDELAY causes
3468 an EAGAIN error. Does anybody know of a situation
3469 where a retry is actually needed? */
3471 nread
< 0 && (errno
== EAGAIN
3485 #if defined (USG) || defined (DGUX)
3486 fcntl (fileno (stdin
), F_SETFL
, 0);
3487 #endif /* USG or DGUX */
3488 #endif /* no FIONREAD */
3489 for (i
= 0; i
< nread
; i
++)
3491 buf
[i
].kind
= ascii_keystroke
;
3492 buf
[i
].modifiers
= 0;
3493 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3494 buf
[i
].modifiers
= meta_modifier
;
3498 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
3500 XSET (buf
[i
].frame_or_window
, Lisp_Frame
, selected_frame
);
3502 buf
[i
].frame_or_window
= Qnil
;
3507 /* Scan the chars for C-g and store them in kbd_buffer. */
3508 for (i
= 0; i
< nread
; i
++)
3510 kbd_buffer_store_event (&buf
[i
]);
3511 /* Don't look at input that follows a C-g too closely.
3512 This reduces lossage due to autorepeat on C-g. */
3513 if (buf
[i
].kind
== ascii_keystroke
3514 && XINT(buf
[i
].code
) == quit_char
)
3520 #endif /* not VMS */
3522 #ifdef SIGIO /* for entire page */
3523 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3526 input_available_signal (signo
)
3529 /* Must preserve main program's value of errno. */
3530 int old_errno
= errno
;
3532 extern int select_alarmed
;
3536 /* USG systems forget handlers when they are used;
3537 must reestablish each time */
3538 signal (signo
, input_available_signal
);
3545 if (input_available_clear_time
)
3546 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3551 nread
= read_avail_input (1);
3552 /* -1 means it's not ok to read the input now.
3553 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3554 0 means there was no keyboard input available. */
3559 select_alarmed
= 1; /* Force the select emulator back to life */
3570 /* Send ourselves a SIGIO.
3572 This function exists so that the UNBLOCK_INPUT macro in
3573 blockinput.h can have some way to take care of input we put off
3574 dealing with, without assuming that every file which uses
3575 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3577 reinvoke_input_signal ()
3586 /* Return the prompt-string of a sparse keymap.
3587 This is the first element which is a string.
3588 Return nil if there is none. */
3596 register Lisp_Object tem
;
3598 if (XTYPE (tem
) == Lisp_String
)
3605 static void menu_bar_item ();
3606 static void menu_bar_one_keymap ();
3608 /* These variables hold the vector under construction within
3609 menu_bar_items and its subroutines, and the current index
3610 for storing into that vector. */
3611 static Lisp_Object menu_bar_items_vector
;
3612 static Lisp_Object menu_bar_items_index
;
3614 /* Return a vector of menu items for a menu bar, appropriate
3615 to the current buffer. Each item has three elements in the vector:
3618 OLD is an old vector we can optionally reuse, or nil. */
3621 menu_bar_items (old
)
3624 /* The number of keymaps we're scanning right now, and the number of
3625 keymaps we have allocated space for. */
3628 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3629 in the current keymaps, or nil where it is not a prefix. */
3632 Lisp_Object def
, tem
, tail
;
3641 struct gcpro gcpro1
;
3643 /* In order to build the menus, we need to call the keymap
3644 accessors. They all call QUIT. But this function is called
3645 during redisplay, during which a quit is fatal. So inhibit
3646 quitting while building the menus.
3647 We do this instead of specbind because (1) errors will clear it anyway
3648 and (2) this avoids risk of specpdl overflow. */
3649 oquit
= Vinhibit_quit
;
3653 menu_bar_items_vector
= old
;
3655 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
3656 menu_bar_items_index
= 0;
3658 GCPRO1 (menu_bar_items_vector
);
3660 /* Build our list of keymaps.
3661 If we recognize a function key and replace its escape sequence in
3662 keybuf with its symbol, or if the sequence starts with a mouse
3663 click and we need to switch buffers, we jump back here to rebuild
3664 the initial keymaps from the current buffer. */
3668 if (!NILP (Voverriding_local_map
))
3671 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3672 maps
[0] = Voverriding_local_map
;
3676 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3677 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3678 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3679 #ifdef USE_TEXT_PROPERTIES
3680 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3682 maps
[nmaps
-2] = current_buffer
->keymap
;
3685 maps
[nmaps
-1] = current_global_map
;
3688 /* Look up in each map the dummy prefix key `menu-bar'. */
3692 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3694 if (! NILP (maps
[mapno
]))
3695 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3699 tem
= Fkeymapp (def
);
3701 menu_bar_one_keymap (def
);
3704 /* Move to the end those items that should be at the end. */
3706 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3709 int end
= menu_bar_items_index
;
3711 for (i
= 0; i
< end
; i
+= 3)
3712 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3714 Lisp_Object tem0
, tem1
, tem2
;
3715 /* Move the item at index I to the end,
3716 shifting all the others forward. */
3717 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
3718 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
3719 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
3721 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
3722 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
3723 (end
- i
- 3) * sizeof (Lisp_Object
));
3724 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem0
;
3725 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem1
;
3726 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem2
;
3731 /* Add nil, nil, nil at the end. */
3732 i
= menu_bar_items_index
;
3733 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
3736 int newsize
= 2 * i
;
3737 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
3738 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
3739 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
3740 menu_bar_items_vector
= tem
;
3742 /* Add this item. */
3743 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3744 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3745 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3746 menu_bar_items_index
= i
;
3748 Vinhibit_quit
= oquit
;
3750 return menu_bar_items_vector
;
3753 /* Scan one map KEYMAP, accumulating any menu items it defines
3754 in menu_bar_items_vector. */
3757 menu_bar_one_keymap (keymap
)
3760 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3762 /* Loop over all keymap entries that have menu strings. */
3763 for (tail
= keymap
; XTYPE (tail
) == Lisp_Cons
; tail
= XCONS (tail
)->cdr
)
3765 item
= XCONS (tail
)->car
;
3766 if (XTYPE (item
) == Lisp_Cons
)
3768 key
= XCONS (item
)->car
;
3769 binding
= XCONS (item
)->cdr
;
3770 if (XTYPE (binding
) == Lisp_Cons
)
3772 item_string
= XCONS (binding
)->car
;
3773 if (XTYPE (item_string
) == Lisp_String
)
3774 menu_bar_item (key
, item_string
, Fcdr (binding
));
3776 else if (EQ (binding
, Qundefined
))
3777 menu_bar_item (key
, Qnil
, binding
);
3779 else if (XTYPE (item
) == Lisp_Vector
)
3781 /* Loop over the char values represented in the vector. */
3782 int len
= XVECTOR (item
)->size
;
3784 for (c
= 0; c
< len
; c
++)
3786 Lisp_Object character
;
3787 XFASTINT (character
) = c
;
3788 binding
= XVECTOR (item
)->contents
[c
];
3789 if (XTYPE (binding
) == Lisp_Cons
)
3791 item_string
= XCONS (binding
)->car
;
3792 if (XTYPE (item_string
) == Lisp_String
)
3793 menu_bar_item (key
, item_string
, Fcdr (binding
));
3795 else if (EQ (binding
, Qundefined
))
3796 menu_bar_item (key
, Qnil
, binding
);
3802 /* This is used as the handler when calling internal_condition_case_1. */
3805 menu_bar_item_1 (arg
)
3811 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
3812 If there's already an item for KEY, add this DEF to it. */
3815 menu_bar_item (key
, item_string
, def
)
3816 Lisp_Object key
, item_string
, def
;
3819 Lisp_Object enabled
;
3822 if (EQ (def
, Qundefined
))
3824 /* If a map has an explicit `undefined' as definition,
3825 discard any previously made menu bar item. */
3827 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
3828 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3830 if (menu_bar_items_index
> i
+ 3)
3831 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
3832 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
3833 (menu_bar_items_index
- i
- 3) * sizeof (Lisp_Object
));
3834 menu_bar_items_index
-= 3;
3838 /* If there's no definition for this key yet,
3839 just ignore `undefined'. */
3843 /* See if this entry is enabled. */
3846 if (XTYPE (def
) == Lisp_Symbol
)
3848 /* No property, or nil, means enable.
3849 Otherwise, enable if value is not nil. */
3850 tem
= Fget (def
, Qmenu_enable
);
3852 /* (condition-case nil (eval tem)
3854 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
3858 /* Ignore this item if it's not enabled. */
3862 /* Find any existing item for this KEY. */
3863 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
3864 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3867 /* If we did not find this KEY, add it at the end. */
3868 if (i
== menu_bar_items_index
)
3870 /* If vector is too small, get a bigger one. */
3871 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
3874 int newsize
= 2 * i
;
3875 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
3876 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
3877 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
3878 menu_bar_items_vector
= tem
;
3880 /* Add this item. */
3881 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
3882 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
3883 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (def
, Qnil
);
3884 menu_bar_items_index
= i
;
3886 /* We did find an item for this KEY. Add DEF to its list of maps. */
3890 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
3891 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (def
, old
);
3895 /* Read a character using menus based on maps in the array MAPS.
3896 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
3897 Return t if we displayed a menu but the user rejected it.
3899 PREV_EVENT is the previous input event, or nil if we are reading
3900 the first event of a key sequence.
3902 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3903 if we used a mouse menu to read the input, or zero otherwise. If
3904 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
3906 The prompting is done based on the prompt-string of the map
3907 and the strings associated with various map elements.
3909 This can be done with X menus or with menus put in the minibuf.
3910 These are done in different ways, depending on how the input will be read.
3911 Menus using X are done after auto-saving in read-char, getting the input
3912 event from Fx_popup_menu; menus using the minibuf use read_char recursively
3913 and do auto-saving in the inner call of read_char. */
3916 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
3919 Lisp_Object prev_event
;
3920 int *used_mouse_menu
;
3923 register Lisp_Object name
;
3924 Lisp_Object rest
, vector
;
3926 if (used_mouse_menu
)
3927 *used_mouse_menu
= 0;
3929 /* Use local over global Menu maps */
3931 if (! menu_prompting
)
3934 /* Get the menu name from the first map that has one (a prompt string). */
3935 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3937 name
= map_prompt (maps
[mapno
]);
3942 /* If we don't have any menus, just read a character normally. */
3946 #ifdef HAVE_X_WINDOWS
3948 /* If we got to this point via a mouse click,
3949 use a real menu for mouse selection. */
3950 if (EVENT_HAS_PARAMETERS (prev_event
))
3952 /* Display the menu and get the selection. */
3953 Lisp_Object
*realmaps
3954 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
3958 /* Use the maps that are not nil. */
3959 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3960 if (!NILP (maps
[mapno
]))
3961 realmaps
[nmaps1
++] = maps
[mapno
];
3963 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
3966 /* If we got more than one event, put all but the first
3967 onto this list to be read later.
3968 Return just the first event now. */
3969 Vunread_command_events
3970 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
3971 value
= XCONS (value
)->car
;
3973 else if (NILP (value
))
3975 if (used_mouse_menu
)
3976 *used_mouse_menu
= 1;
3979 #endif /* HAVE_X_MENU */
3980 #endif /* HAVE_X_WINDOWS */
3985 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
3991 register Lisp_Object name
;
3993 int width
= FRAME_WIDTH (selected_frame
) - 4;
3994 char *menu
= (char *) alloca (width
+ 4);
3997 Lisp_Object rest
, vector
;
3999 if (! menu_prompting
)
4002 /* Get the menu name from the first map that has one (a prompt string). */
4003 for (mapno
= 0; mapno
< nmaps
; mapno
++)
4005 name
= map_prompt (maps
[mapno
]);
4010 /* If we don't have any menus, just read a character normally. */
4014 /* Prompt string always starts with map's prompt, and a space. */
4015 strcpy (menu
, XSTRING (name
)->data
);
4016 nlength
= XSTRING (name
)->size
;
4017 menu
[nlength
++] = ':';
4018 menu
[nlength
++] = ' ';
4021 /* Start prompting at start of first map. */
4025 /* Present the documented bindings, a line at a time. */
4032 int orig_defn_macro
;
4034 /* Loop over elements of map. */
4039 /* If reached end of map, start at beginning of next map. */
4043 /* At end of last map, wrap around to first map if just starting,
4044 or end this line if already have something on it. */
4048 if (notfirst
|| nobindings
) break;
4053 /* Look at the next element of the map. */
4055 elt
= XVECTOR (vector
)->contents
[idx
];
4057 elt
= Fcar_safe (rest
);
4059 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
4061 /* If we found a dense table in the keymap,
4062 advanced past it, but start scanning its contents. */
4063 rest
= Fcdr_safe (rest
);
4069 /* An ordinary element. */
4071 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
4073 s
= Fcar_safe(elt
); /* vector */
4074 if (XTYPE (s
) != Lisp_String
)
4075 /* Ignore the element if it has no prompt string. */
4077 /* If we have room for the prompt string, add it to this line.
4078 If this is the first on the line, always add it. */
4079 else if (XSTRING (s
)->size
+ i
+ 2 < width
4084 /* Punctuate between strings. */
4087 strcpy (menu
+ i
, ", ");
4093 /* Add as much of string as fits. */
4094 thiswidth
= XSTRING (s
)->size
;
4095 if (thiswidth
+ i
> width
)
4096 thiswidth
= width
- i
;
4097 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
4103 /* If this element does not fit, end the line now,
4104 and save the element for the next line. */
4105 strcpy (menu
+ i
, "...");
4109 /* Move past this element. */
4110 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
4111 /* Handle reaching end of dense table. */
4116 rest
= Fcdr_safe (rest
);
4120 /* Prompt with that and read response. */
4123 /* Make believe its not a keyboard macro in case the help char
4124 is pressed. Help characters are not recorded because menu prompting
4125 is not used on replay.
4127 orig_defn_macro
= defining_kbd_macro
;
4128 defining_kbd_macro
= 0 ;
4130 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
4131 while (XTYPE (obj
) == Lisp_Buffer
);
4132 defining_kbd_macro
= orig_defn_macro
;
4134 if (XTYPE (obj
) != Lisp_Int
)
4139 if (! EQ (obj
, menu_prompt_more_char
)
4140 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
4141 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
4143 if ( defining_kbd_macro
)
4144 store_kbd_macro_char(obj
) ;
4147 /* Help char - go round again */
4151 /* Reading key sequences. */
4153 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
4154 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
4155 keymap, or nil otherwise. Return the index of the first keymap in
4156 which KEY has any binding, or NMAPS if no map has a binding.
4158 If KEY is a meta ASCII character, treat it like meta-prefix-char
4159 followed by the corresponding non-meta character. Keymaps in
4160 CURRENT with non-prefix bindings for meta-prefix-char become nil in
4163 When KEY is not defined in any of the keymaps, if it is an upper
4164 case letter and there are bindings for the corresponding lower-case
4165 letter, return the bindings for the lower-case letter.
4166 We store 1 in *CASE_CONVERTED in this case.
4167 Otherwise, we don't change *CASE_CONVERTED.
4169 If KEY has no bindings in any of the CURRENT maps, NEXT is left
4172 NEXT may == CURRENT. */
4175 follow_key (key
, nmaps
, current
, defs
, next
, case_converted
)
4177 Lisp_Object
*current
, *defs
, *next
;
4179 int *case_converted
;
4181 int i
, first_binding
;
4183 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
4184 followed by the corresponding non-meta character. */
4185 if (XTYPE (key
) == Lisp_Int
&& (XINT (key
) & CHAR_META
))
4187 for (i
= 0; i
< nmaps
; i
++)
4188 if (! NILP (current
[i
]))
4191 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
4193 /* Note that since we pass the resulting bindings through
4194 get_keymap_1, non-prefix bindings for meta-prefix-char
4196 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
4202 XSET (key
, Lisp_Int
, XFASTINT (key
) & ~CHAR_META
);
4205 first_binding
= nmaps
;
4206 for (i
= nmaps
- 1; i
>= 0; i
--)
4208 if (! NILP (current
[i
]))
4210 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
4211 if (! NILP (defs
[i
]))
4218 /* When KEY is not defined in any of the keymaps, if it is an upper
4219 case letter and there are bindings for the corresponding
4220 lower-case letter, return the bindings for the lower-case letter. */
4221 if (first_binding
== nmaps
4222 && XTYPE (key
) == Lisp_Int
4223 && ((((XINT (key
) & 0x3ffff)
4224 < XSTRING (current_buffer
->downcase_table
)->size
)
4225 && UPPERCASEP (XINT (key
) & 0x3ffff))
4226 || (XINT (key
) & shift_modifier
)))
4228 if (XINT (key
) & shift_modifier
)
4229 XSETINT (key
, XINT (key
) & ~shift_modifier
);
4231 XSETINT (key
, (DOWNCASE (XINT (key
) & 0x3ffff)
4232 | (XINT (key
) & ~0x3ffff)));
4234 first_binding
= nmaps
;
4235 for (i
= nmaps
- 1; i
>= 0; i
--)
4237 if (! NILP (current
[i
]))
4239 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
4240 if (! NILP (defs
[i
]))
4246 if (first_binding
!= nmaps
)
4247 *case_converted
= 1;
4250 /* Given the set of bindings we've found, produce the next set of maps. */
4251 if (first_binding
< nmaps
)
4252 for (i
= 0; i
< nmaps
; i
++)
4253 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
4255 return first_binding
;
4258 /* Read a sequence of keys that ends with a non prefix character,
4259 storing it in KEYBUF, a buffer of size BUFSIZE.
4261 Return the length of the key sequence stored.
4262 Return -1 if the user rejected a command menu.
4264 Echo starting immediately unless `prompt' is 0.
4266 Where a key sequence ends depends on the currently active keymaps.
4267 These include any minor mode keymaps active in the current buffer,
4268 the current buffer's local map, and the global map.
4270 If a key sequence has no other bindings, we check Vfunction_key_map
4271 to see if some trailing subsequence might be the beginning of a
4272 function key's sequence. If so, we try to read the whole function
4273 key, and substitute its symbolic name into the key sequence.
4275 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
4276 `double-' events into similar click events, if that would make them
4277 bound. We try to turn `triple-' events first into `double-' events,
4280 If we get a mouse click in a mode line, vertical divider, or other
4281 non-text area, we treat the click as if it were prefixed by the
4282 symbol denoting that area - `mode-line', `vertical-line', or
4285 If the sequence starts with a mouse click, we read the key sequence
4286 with respect to the buffer clicked on, not the current buffer.
4288 If the user switches frames in the midst of a key sequence, we put
4289 off the switch-frame event until later; the next call to
4290 read_char will return it. */
4293 read_key_sequence (keybuf
, bufsize
, prompt
)
4294 Lisp_Object
*keybuf
;
4298 int count
= specpdl_ptr
- specpdl
;
4300 /* How many keys there are in the current key sequence. */
4303 /* The length of the echo buffer when we started reading, and
4304 the length of this_command_keys when we started reading. */
4308 /* The number of keymaps we're scanning right now, and the number of
4309 keymaps we have allocated space for. */
4311 int nmaps_allocated
= 0;
4313 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
4314 the current keymaps. */
4317 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
4318 in the current keymaps, or nil where it is not a prefix. */
4319 Lisp_Object
*submaps
;
4321 /* The index in defs[] of the first keymap that has a binding for
4322 this key sequence. In other words, the lowest i such that
4323 defs[i] is non-nil. */
4326 /* If t < mock_input, then KEYBUF[t] should be read as the next
4329 We use this to recover after recognizing a function key. Once we
4330 realize that a suffix of the current key sequence is actually a
4331 function key's escape sequence, we replace the suffix with the
4332 function key's binding from Vfunction_key_map. Now keybuf
4333 contains a new and different key sequence, so the echo area,
4334 this_command_keys, and the submaps and defs arrays are wrong. In
4335 this situation, we set mock_input to t, set t to 0, and jump to
4336 restart_sequence; the loop will read keys from keybuf up until
4337 mock_input, thus rebuilding the state; and then it will resume
4338 reading characters from the keyboard. */
4341 /* If the sequence is unbound in submaps[], then
4342 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
4343 and fkey_map is its binding.
4345 These might be > t, indicating that all function key scanning
4346 should hold off until t reaches them. We do this when we've just
4347 recognized a function key, to avoid searching for the function
4348 key's again in Vfunction_key_map. */
4349 int fkey_start
= 0, fkey_end
= 0;
4350 Lisp_Object fkey_map
;
4352 /* Likewise, for key_translation_map. */
4353 int keytran_start
= 0, keytran_end
= 0;
4354 Lisp_Object keytran_map
;
4356 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
4357 we put it off for later. While we're reading, we keep the event here. */
4358 Lisp_Object delayed_switch_frame
;
4360 /* See the comment below... */
4361 #if defined (GOBBLE_FIRST_EVENT)
4362 Lisp_Object first_event
;
4365 struct buffer
*starting_buffer
;
4367 /* Nonzero if we found the binding for one of the chars
4368 in this key sequence by downcasing it. */
4369 int case_converted
= 0;
4371 /* Nonzero if we seem to have got the beginning of a binding
4372 in function_key_map. */
4373 int function_key_possible
= 0;
4377 last_nonmenu_event
= Qnil
;
4379 delayed_switch_frame
= Qnil
;
4380 fkey_map
= Vfunction_key_map
;
4381 keytran_map
= Vkey_translation_map
;
4383 /* If there is no function-key-map, turn off function key scanning. */
4384 if (NILP (Fkeymapp (Vfunction_key_map
)))
4385 fkey_start
= fkey_end
= bufsize
+ 1;
4387 /* If there is no key-translation-map, turn off scanning. */
4388 if (NILP (Fkeymapp (Vkey_translation_map
)))
4389 keytran_start
= keytran_end
= bufsize
+ 1;
4394 echo_prompt (XSTRING (prompt
)->data
);
4395 else if (cursor_in_echo_area
)
4396 /* This doesn't put in a dash if the echo buffer is empty, so
4397 you don't always see a dash hanging out in the minibuffer. */
4401 /* Record the initial state of the echo area and this_command_keys;
4402 we will need to restore them if we replay a key sequence. */
4404 echo_start
= echo_length ();
4405 keys_start
= this_command_key_count
;
4407 #if defined (GOBBLE_FIRST_EVENT)
4408 /* This doesn't quite work, because some of the things that read_char
4409 does cannot safely be bypassed. It seems too risky to try to make
4412 /* Read the first char of the sequence specially, before setting
4413 up any keymaps, in case a filter runs and switches buffers on us. */
4414 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
4416 #endif /* GOBBLE_FIRST_EVENT */
4418 /* We jump here when the key sequence has been thoroughly changed, and
4419 we need to rescan it starting from the beginning. When we jump here,
4420 keybuf[0..mock_input] holds the sequence we should reread. */
4423 starting_buffer
= current_buffer
;
4425 function_key_possible
= 0;
4427 /* Build our list of keymaps.
4428 If we recognize a function key and replace its escape sequence in
4429 keybuf with its symbol, or if the sequence starts with a mouse
4430 click and we need to switch buffers, we jump back here to rebuild
4431 the initial keymaps from the current buffer. */
4435 if (!NILP (Voverriding_local_map
))
4438 if (nmaps
> nmaps_allocated
)
4440 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4441 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4442 nmaps_allocated
= nmaps
;
4444 submaps
[0] = Voverriding_local_map
;
4448 nmaps
= current_minor_maps (0, &maps
) + 2;
4449 if (nmaps
> nmaps_allocated
)
4451 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4452 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4453 nmaps_allocated
= nmaps
;
4455 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
4456 #ifdef USE_TEXT_PROPERTIES
4457 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
4459 submaps
[nmaps
-2] = current_buffer
->keymap
;
4462 submaps
[nmaps
-1] = current_global_map
;
4465 /* Find an accurate initial value for first_binding. */
4466 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
4467 if (! NILP (submaps
[first_binding
]))
4470 /* Start from the beginning in keybuf. */
4473 /* These are no-ops the first time through, but if we restart, they
4474 revert the echo area and this_command_keys to their original state. */
4475 this_command_key_count
= keys_start
;
4476 if (INTERACTIVE
&& t
< mock_input
)
4477 echo_truncate (echo_start
);
4479 /* If the best binding for the current key sequence is a keymap, or
4480 we may be looking at a function key's escape sequence, keep on
4482 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
4483 || (first_binding
>= nmaps
4485 /* mock input is never part of a function key's sequence. */
4486 && mock_input
<= fkey_start
)
4487 || (first_binding
>= nmaps
4488 && keytran_start
< t
4489 /* mock input is never part of a function key's sequence. */
4490 && mock_input
<= keytran_start
)
4491 /* Don't return in the middle of a possible function key sequence,
4492 if the only bindings we found were via case conversion.
4493 Thus, if ESC O a has a function-key-map translation
4494 and ESC o has a binding, don't return after ESC O,
4495 so that we can translate ESC O plus the next character. */
4496 || (function_key_possible
&& case_converted
))
4499 int used_mouse_menu
= 0;
4501 /* Where the last real key started. If we need to throw away a
4502 key that has expanded into more than one element of keybuf
4503 (say, a mouse click on the mode line which is being treated
4504 as [mode-line (mouse-...)], then we backtrack to this point
4506 int last_real_key_start
;
4508 /* These variables are analogous to echo_start and keys_start;
4509 while those allow us to restart the entire key sequence,
4510 echo_local_start and keys_local_start allow us to throw away
4512 int echo_local_start
, keys_local_start
, local_first_binding
;
4515 error ("key sequence too long");
4518 echo_local_start
= echo_length ();
4519 keys_local_start
= this_command_key_count
;
4520 local_first_binding
= first_binding
;
4523 /* These are no-ops, unless we throw away a keystroke below and
4524 jumped back up to replay_key; in that case, these restore the
4525 variables to their original state, allowing us to replay the
4527 if (INTERACTIVE
&& t
< mock_input
)
4528 echo_truncate (echo_local_start
);
4529 this_command_key_count
= keys_local_start
;
4530 first_binding
= local_first_binding
;
4532 /* By default, assume each event is "real". */
4533 last_real_key_start
= t
;
4535 /* Does mock_input indicate that we are re-reading a key sequence? */
4539 add_command_key (key
);
4543 /* If not, we should actually read a character. */
4546 struct buffer
*buf
= current_buffer
;
4548 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
4551 /* read_char returns t when it shows a menu and the user rejects it.
4556 /* read_char returns -1 at the end of a macro.
4557 Emacs 18 handles this by returning immediately with a
4558 zero, so that's what we'll do. */
4559 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) == -1)
4565 /* If the current buffer has been changed from under us, the
4566 keymap may have changed, so replay the sequence. */
4567 if (XTYPE (key
) == Lisp_Buffer
)
4570 goto replay_sequence
;
4573 /* If we have a quit that was typed in another frame, and
4574 quit_throw_to_read_char switched buffers,
4575 replay to get the right keymap. */
4576 if (EQ (key
, quit_char
) && current_buffer
!= starting_buffer
)
4581 goto replay_sequence
;
4587 /* Clicks in non-text areas get prefixed by the symbol
4588 in their CHAR-ADDRESS field. For example, a click on
4589 the mode line is prefixed by the symbol `mode-line'.
4591 Furthermore, key sequences beginning with mouse clicks
4592 are read using the keymaps of the buffer clicked on, not
4593 the current buffer. So we may have to switch the buffer
4596 When we turn one event into two events, we must make sure
4597 that neither of the two looks like the original--so that,
4598 if we replay the events, they won't be expanded again.
4599 If not for this, such reexpansion could happen either here
4600 or when user programs play with this-command-keys. */
4601 if (EVENT_HAS_PARAMETERS (key
))
4605 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
4606 if (EQ (kind
, Qmouse_click
))
4608 Lisp_Object window
, posn
;
4610 window
= POSN_WINDOW (EVENT_START (key
));
4611 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4612 if (XTYPE (posn
) == Lisp_Cons
)
4614 /* We're looking at the second event of a
4615 sequence which we expanded before. Set
4616 last_real_key_start appropriately. */
4618 last_real_key_start
= t
- 1;
4621 /* Key sequences beginning with mouse clicks are
4622 read using the keymaps in the buffer clicked on,
4623 not the current buffer. If we're at the
4624 beginning of a key sequence, switch buffers. */
4625 if (last_real_key_start
== 0
4626 && XTYPE (window
) == Lisp_Window
4627 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
4628 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
4633 /* Arrange to go back to the original buffer once we're
4634 done reading the key sequence. Note that we can't
4635 use save_excursion_{save,restore} here, because they
4636 save point as well as the current buffer; we don't
4637 want to save point, because redisplay may change it,
4638 to accommodate a Fset_window_start or something. We
4639 don't want to do this at the top of the function,
4640 because we may get input from a subprocess which
4641 wants to change the selected window and stuff (say,
4643 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
4645 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
4646 goto replay_sequence
;
4648 else if (XTYPE (posn
) == Lisp_Symbol
)
4650 /* Expand mode-line and scroll-bar events into two events:
4651 use posn as a fake prefix key. */
4653 if (t
+ 1 >= bufsize
)
4654 error ("key sequence too long");
4659 /* Zap the position in key, so we know that we've
4660 expanded it, and don't try to do so again. */
4661 POSN_BUFFER_POSN (EVENT_START (key
))
4662 = Fcons (posn
, Qnil
);
4666 else if (EQ (kind
, Qswitch_frame
))
4668 /* If we're at the beginning of a key sequence, go
4669 ahead and return this event. If we're in the
4670 midst of a key sequence, delay it until the end. */
4673 delayed_switch_frame
= key
;
4681 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4682 /* Handle menu-bar events:
4683 insert the dummy prefix event `menu-bar'. */
4684 if (EQ (posn
, Qmenu_bar
))
4686 if (t
+ 1 >= bufsize
)
4687 error ("key sequence too long");
4688 /* Run the Lucid hook. */
4689 if (!NILP (Vrun_hooks
))
4690 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4691 /* If it has changed current-menubar from previous value,
4692 really recompute the menubar from the value. */
4693 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4694 call0 (Qrecompute_lucid_menubar
);
4698 /* Zap the position in key, so we know that we've
4699 expanded it, and don't try to do so again. */
4700 POSN_BUFFER_POSN (EVENT_START (key
))
4701 = Fcons (posn
, Qnil
);
4704 goto replay_sequence
;
4706 else if (XTYPE (posn
) == Lisp_Cons
)
4708 /* We're looking at the second event of a
4709 sequence which we expanded before. Set
4710 last_real_key_start appropriately. */
4711 if (last_real_key_start
== t
&& t
> 0)
4712 last_real_key_start
= t
- 1;
4717 /* We have finally decided that KEY is something we might want
4719 first_binding
= (follow_key (key
,
4720 nmaps
- first_binding
,
4721 submaps
+ first_binding
,
4722 defs
+ first_binding
,
4723 submaps
+ first_binding
,
4727 /* If KEY wasn't bound, we'll try some fallbacks. */
4728 if (first_binding
>= nmaps
)
4732 head
= EVENT_HEAD (key
);
4733 if (EQ (head
, Vhelp_char
))
4735 read_key_sequence_cmd
= Vprefix_help_command
;
4737 last_nonmenu_event
= key
;
4741 if (XTYPE (head
) == Lisp_Symbol
)
4743 Lisp_Object breakdown
;
4746 breakdown
= parse_modifiers (head
);
4747 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4748 /* Attempt to reduce an unbound mouse event to a simpler
4749 event that is bound:
4750 Drags reduce to clicks.
4751 Double-clicks reduce to clicks.
4752 Triple-clicks reduce to double-clicks, then to clicks.
4753 Down-clicks are eliminated.
4754 Double-downs reduce to downs, then are eliminated.
4755 Triple-downs reduce to double-downs, then to downs,
4756 then are eliminated. */
4757 if (modifiers
& (down_modifier
| drag_modifier
4758 | double_modifier
| triple_modifier
))
4760 while (modifiers
& (down_modifier
| drag_modifier
4761 | double_modifier
| triple_modifier
))
4763 Lisp_Object new_head
, new_click
;
4764 if (modifiers
& triple_modifier
)
4765 modifiers
^= (double_modifier
| triple_modifier
);
4766 else if (modifiers
& (drag_modifier
| double_modifier
))
4767 modifiers
&= ~(drag_modifier
| double_modifier
);
4770 /* Dispose of this `down' event by simply jumping
4771 back to replay_key, to get another event.
4773 Note that if this event came from mock input,
4774 then just jumping back to replay_key will just
4775 hand it to us again. So we have to wipe out any
4778 We could delete keybuf[t] and shift everything
4779 after that to the left by one spot, but we'd also
4780 have to fix up any variable that points into
4781 keybuf, and shifting isn't really necessary
4784 Adding prefixes for non-textual mouse clicks
4785 creates two characters of mock input, and both
4786 must be thrown away. If we're only looking at
4787 the prefix now, we can just jump back to
4788 replay_key. On the other hand, if we've already
4789 processed the prefix, and now the actual click
4790 itself is giving us trouble, then we've lost the
4791 state of the keymaps we want to backtrack to, and
4792 we need to replay the whole sequence to rebuild
4795 Beyond that, only function key expansion could
4796 create more than two keys, but that should never
4797 generate mouse events, so it's okay to zero
4798 mock_input in that case too.
4800 Isn't this just the most wonderful code ever? */
4801 if (t
== last_real_key_start
)
4808 mock_input
= last_real_key_start
;
4809 goto replay_sequence
;
4814 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
4816 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
4818 /* Look for a binding for this new key. follow_key
4819 promises that it didn't munge submaps the
4820 last time we called it, since key was unbound. */
4822 = (follow_key (new_click
,
4823 nmaps
- local_first_binding
,
4824 submaps
+ local_first_binding
,
4825 defs
+ local_first_binding
,
4826 submaps
+ local_first_binding
,
4828 + local_first_binding
);
4830 /* If that click is bound, go for it. */
4831 if (first_binding
< nmaps
)
4836 /* Otherwise, we'll leave key set to the drag event. */
4843 /* Normally, last_nonmenu_event gets the previous key we read.
4844 But when a mouse popup menu is being used,
4845 we don't update last_nonmenu_event; it continues to hold the mouse
4846 event that preceded the first level of menu. */
4847 if (!used_mouse_menu
)
4848 last_nonmenu_event
= key
;
4850 /* If the sequence is unbound, see if we can hang a function key
4851 off the end of it. We only want to scan real keyboard input
4852 for function key sequences, so if mock_input says that we're
4853 re-reading old events, don't examine it. */
4854 if ((first_binding
>= nmaps
|| case_converted
)
4857 Lisp_Object fkey_next
;
4859 /* Continue scan from fkey_end until we find a bound suffix.
4860 If we fail, increment fkey_start
4861 and start fkey_end from there. */
4862 while (fkey_end
< t
)
4866 key
= keybuf
[fkey_end
++];
4867 /* Look up meta-characters by prefixing them
4868 with meta_prefix_char. I hate this. */
4869 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4874 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
4876 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4879 fkey_next
= fkey_map
;
4882 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
4884 /* If the function key map gives a function, not an
4885 array, then call the function with no args and use
4886 its value instead. */
4887 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
4890 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4894 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4895 fkey_next
= call1 (fkey_next
, prompt
);
4897 /* If the function returned something invalid,
4898 barf--don't ignore it.
4899 (To ignore it safely, we would need to gcpro a bunch of
4900 other variables.) */
4901 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
4902 error ("Function in function-key-map returns invalid key sequence");
4905 function_key_possible
= ! NILP (fkey_next
);
4907 /* If keybuf[fkey_start..fkey_end] is bound in the
4908 function key map and it's a suffix of the current
4909 sequence (i.e. fkey_end == t), replace it with
4910 the binding and restart with fkey_start at the end. */
4911 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
4914 int len
= XFASTINT (Flength (fkey_next
));
4916 t
= fkey_start
+ len
;
4918 error ("key sequence too long");
4920 if (VECTORP (fkey_next
))
4921 bcopy (XVECTOR (fkey_next
)->contents
,
4922 keybuf
+ fkey_start
,
4923 (t
- fkey_start
) * sizeof (keybuf
[0]));
4924 else if (STRINGP (fkey_next
))
4928 for (i
= 0; i
< len
; i
++)
4929 XFASTINT (keybuf
[fkey_start
+ i
])
4930 = XSTRING (fkey_next
)->data
[i
];
4934 fkey_start
= fkey_end
= t
;
4935 fkey_map
= Vfunction_key_map
;
4937 goto replay_sequence
;
4940 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
4942 /* If we no longer have a bound suffix, try a new positions for
4944 if (NILP (fkey_map
))
4946 fkey_end
= ++fkey_start
;
4947 fkey_map
= Vfunction_key_map
;
4948 function_key_possible
= 0;
4953 /* Look for this sequence in key-translation-map. */
4955 Lisp_Object keytran_next
;
4957 /* Scan from keytran_end until we find a bound suffix. */
4958 while (keytran_end
< t
)
4962 key
= keybuf
[keytran_end
++];
4963 /* Look up meta-characters by prefixing them
4964 with meta_prefix_char. I hate this. */
4965 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4970 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
4972 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4975 keytran_next
= keytran_map
;
4978 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
4980 /* If the key translation map gives a function, not an
4981 array, then call the function with no args and use
4982 its value instead. */
4983 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
4984 && keytran_end
== t
)
4986 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4990 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4991 keytran_next
= call1 (keytran_next
, prompt
);
4993 /* If the function returned something invalid,
4994 barf--don't ignore it.
4995 (To ignore it safely, we would need to gcpro a bunch of
4996 other variables.) */
4997 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
4998 error ("Function in key-translation-map returns invalid key sequence");
5001 /* If keybuf[keytran_start..keytran_end] is bound in the
5002 key translation map and it's a suffix of the current
5003 sequence (i.e. keytran_end == t), replace it with
5004 the binding and restart with keytran_start at the end. */
5005 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
5006 && keytran_end
== t
)
5008 int len
= XFASTINT (Flength (keytran_next
));
5010 t
= keytran_start
+ len
;
5012 error ("key sequence too long");
5014 if (VECTORP (keytran_next
))
5015 bcopy (XVECTOR (keytran_next
)->contents
,
5016 keybuf
+ keytran_start
,
5017 (t
- keytran_start
) * sizeof (keybuf
[0]));
5018 else if (STRINGP (keytran_next
))
5022 for (i
= 0; i
< len
; i
++)
5023 XFASTINT (keybuf
[keytran_start
+ i
])
5024 = XSTRING (keytran_next
)->data
[i
];
5028 keytran_start
= keytran_end
= t
;
5029 keytran_map
= Vkey_translation_map
;
5031 goto replay_sequence
;
5034 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
5036 /* If we no longer have a bound suffix, try a new positions for
5038 if (NILP (keytran_map
))
5040 keytran_end
= ++keytran_start
;
5041 keytran_map
= Vkey_translation_map
;
5047 read_key_sequence_cmd
= (first_binding
< nmaps
5048 ? defs
[first_binding
]
5052 unread_switch_frame
= delayed_switch_frame
;
5053 unbind_to (count
, Qnil
);
5055 /* Occasionally we fabricate events, perhaps by expanding something
5056 according to function-key-map, or by adding a prefix symbol to a
5057 mouse click in the scroll bar or modeline. In this cases, return
5058 the entire generated key sequence, even if we hit an unbound
5059 prefix or a definition before the end. This means that you will
5060 be able to push back the event properly, and also means that
5061 read-key-sequence will always return a logical unit.
5064 for (; t
< mock_input
; t
++)
5066 echo_char (keybuf
[t
]);
5067 add_command_key (keybuf
[t
]);
5073 #if 0 /* This doc string is too long for some compilers.
5074 This commented-out definition serves for DOC. */
5075 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
5076 "Read a sequence of keystrokes and return as a string or vector.\n\
5077 The sequence is sufficient to specify a non-prefix command in the\n\
5078 current local and global maps.\n\
5080 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
5081 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
5082 as a continuation of the previous key.\n\
5084 A C-g typed while in this function is treated like any other character,\n\
5085 and `quit-flag' is not set.\n\
5087 If the key sequence starts with a mouse click, then the sequence is read\n\
5088 using the keymaps of the buffer of the window clicked in, not the buffer\n\
5089 of the selected window as normal.\n\
5091 `read-key-sequence' drops unbound button-down events, since you normally\n\
5092 only care about the click or drag events which follow them. If a drag\n\
5093 or multi-click event is unbound, but the corresponding click event would\n\
5094 be bound, `read-key-sequence' turns the event into a click event at the\n\
5095 drag's starting position. This means that you don't have to distinguish\n\
5096 between click and drag, double, or triple events unless you want to.\n\
5098 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
5099 lines separating windows, and scroll bars with imaginary keys\n\
5100 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
5102 If the user switches frames in the middle of a key sequence, the\n\
5103 frame-switch event is put off until after the current key sequence.\n\
5105 `read-key-sequence' checks `function-key-map' for function key\n\
5106 sequences, where they wouldn't conflict with ordinary bindings. See\n\
5107 `function-key-map' for more details.")
5108 (prompt
, continue_echo
)
5111 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
5113 (prompt
, continue_echo
)
5114 Lisp_Object prompt
, continue_echo
;
5116 Lisp_Object keybuf
[30];
5118 struct gcpro gcpro1
, gcpro2
;
5121 CHECK_STRING (prompt
, 0);
5124 bzero (keybuf
, sizeof keybuf
);
5126 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
5128 if (NILP (continue_echo
))
5129 this_command_key_count
= 0;
5131 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])), prompt
);
5139 return make_event_array (i
, keybuf
);
5142 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
5143 "Execute CMD as an editor command.\n\
5144 CMD must be a symbol that satisfies the `commandp' predicate.\n\
5145 Optional second arg RECORD-FLAG non-nil\n\
5146 means unconditionally put this command in `command-history'.\n\
5147 Otherwise, that is done only if an arg is read using the minibuffer.")
5149 Lisp_Object cmd
, record
;
5151 register Lisp_Object final
;
5152 register Lisp_Object tem
;
5153 Lisp_Object prefixarg
;
5154 struct backtrace backtrace
;
5155 extern int debug_on_next_call
;
5157 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
5158 Vcurrent_prefix_arg
= prefixarg
;
5159 debug_on_next_call
= 0;
5161 if (XTYPE (cmd
) == Lisp_Symbol
)
5163 tem
= Fget (cmd
, Qdisabled
);
5164 if (!NILP (tem
) && !NILP (Vrun_hooks
))
5165 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
5170 final
= Findirect_function (cmd
);
5172 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
5173 do_autoload (final
, cmd
);
5178 if (XTYPE (final
) == Lisp_String
5179 || XTYPE (final
) == Lisp_Vector
)
5181 /* If requested, place the macro in the command history. For
5182 other sorts of commands, call-interactively takes care of
5186 = Fcons (Fcons (Qexecute_kbd_macro
,
5187 Fcons (final
, Fcons (prefixarg
, Qnil
))),
5190 return Fexecute_kbd_macro (final
, prefixarg
);
5192 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
5193 || XTYPE (final
) == Lisp_Compiled
)
5195 backtrace
.next
= backtrace_list
;
5196 backtrace_list
= &backtrace
;
5197 backtrace
.function
= &Qcall_interactively
;
5198 backtrace
.args
= &cmd
;
5199 backtrace
.nargs
= 1;
5200 backtrace
.evalargs
= 0;
5202 tem
= Fcall_interactively (cmd
, record
);
5204 backtrace_list
= backtrace
.next
;
5210 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
5212 "Read function name, then read its arguments and call it.")
5214 Lisp_Object prefixarg
;
5216 Lisp_Object function
;
5218 Lisp_Object saved_keys
;
5219 struct gcpro gcpro1
;
5221 saved_keys
= Fvector (this_command_key_count
,
5222 XVECTOR (this_command_keys
)->contents
);
5224 GCPRO1 (saved_keys
);
5226 if (EQ (prefixarg
, Qminus
))
5228 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
5229 strcpy (buf
, "C-u ");
5230 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
5231 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
5232 else if (XTYPE (prefixarg
) == Lisp_Int
)
5233 sprintf (buf
, "%d ", XINT (prefixarg
));
5235 /* This isn't strictly correct if execute-extended-command
5236 is bound to anything else. Perhaps it should use
5237 this_command_keys? */
5238 strcat (buf
, "M-x ");
5240 /* Prompt with buf, and then read a string, completing from and
5241 restricting to the set of all defined commands. Don't provide
5242 any initial input. Save the command read on the extended-command
5244 function
= Fcompleting_read (build_string (buf
),
5245 Vobarray
, Qcommandp
,
5246 Qt
, Qnil
, Qextended_command_history
);
5248 /* Set this_command_keys to the concatenation of saved_keys and
5249 function, followed by a RET. */
5251 struct Lisp_String
*str
;
5256 this_command_key_count
= 0;
5258 keys
= XVECTOR (saved_keys
)->contents
;
5259 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
5260 add_command_key (keys
[i
]);
5262 str
= XSTRING (function
);
5263 for (i
= 0; i
< str
->size
; i
++)
5265 XFASTINT (tem
) = str
->data
[i
];
5266 add_command_key (tem
);
5269 XFASTINT (tem
) = '\015';
5270 add_command_key (tem
);
5275 function
= Fintern (function
, Qnil
);
5276 Vprefix_arg
= prefixarg
;
5277 this_command
= function
;
5279 return Fcommand_execute (function
, Qt
);
5283 detect_input_pending ()
5286 get_input_pending (&input_pending
);
5288 return input_pending
;
5291 /* This is called in some cases before a possible quit.
5292 It cases the next call to detect_input_pending to recompute input_pending.
5293 So calling this function unnecessarily can't do any harm. */
5294 clear_input_pending ()
5299 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
5300 "T if command input is currently available with no waiting.\n\
5301 Actually, the value is nil only if we can be sure that no input is available.")
5304 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
5307 return detect_input_pending () ? Qt
: Qnil
;
5310 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
5311 "Return vector of last 100 events, not counting those from keyboard macros.")
5314 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
5317 if (total_keys
< NUM_RECENT_KEYS
)
5318 return Fvector (total_keys
, keys
);
5321 val
= Fvector (NUM_RECENT_KEYS
, keys
);
5322 bcopy (keys
+ recent_keys_index
,
5323 XVECTOR (val
)->contents
,
5324 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
5326 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
5327 recent_keys_index
* sizeof (Lisp_Object
));
5332 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
5333 "Return the key sequence that invoked this command.\n\
5334 The value is a string or a vector.")
5337 return make_event_array (this_command_key_count
,
5338 XVECTOR (this_command_keys
)->contents
);
5341 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
5342 "Return the current depth in recursive edits.")
5346 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
5350 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
5351 "FOpen dribble file: ",
5352 "Start writing all keyboard characters to a dribble file called FILE.\n\
5353 If FILE is nil, close any open dribble file.")
5364 file
= Fexpand_file_name (file
, Qnil
);
5365 dribble
= fopen (XSTRING (file
)->data
, "w");
5370 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
5371 "Discard the contents of the terminal input buffer.\n\
5372 Also cancel any kbd macro being defined.")
5375 defining_kbd_macro
= 0;
5376 update_mode_lines
++;
5378 Vunread_command_events
= Qnil
;
5379 unread_command_char
= -1;
5381 discard_tty_input ();
5383 /* Without the cast, GCC complains that this assignment loses the
5384 volatile qualifier of kbd_store_ptr. Is there anything wrong
5386 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
5387 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5393 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
5394 "Stop Emacs and return to superior process. You can resume later.\n\
5395 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
5396 control, run a subshell instead.\n\n\
5397 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
5398 to be read as terminal input by Emacs's parent, after suspension.\n\
5400 Before suspending, call the functions in `suspend-hook' with no args.\n\
5401 If any of them returns nil, don't call the rest and don't suspend.\n\
5402 Otherwise, suspend normally and after resumption run the normal hook\n\
5403 `suspend-resume-hook' if that is bound and non-nil.\n\
5405 Some operating systems cannot stop the Emacs process and resume it later.\n\
5406 On such systems, Emacs starts a subshell instead of suspending.")
5408 Lisp_Object stuffstring
;
5411 int count
= specpdl_ptr
- specpdl
;
5412 int old_height
, old_width
;
5414 struct gcpro gcpro1
, gcpro2
;
5415 extern init_sys_modes ();
5417 if (!NILP (stuffstring
))
5418 CHECK_STRING (stuffstring
, 0);
5420 /* Run the functions in suspend-hook. */
5421 if (!NILP (Vrun_hooks
))
5422 call1 (Vrun_hooks
, intern ("suspend-hook"));
5424 GCPRO1 (stuffstring
);
5425 get_frame_size (&old_width
, &old_height
);
5427 /* sys_suspend can get an error if it tries to fork a subshell
5428 and the system resources aren't available for that. */
5429 record_unwind_protect (init_sys_modes
, 0);
5430 stuff_buffered_input (stuffstring
);
5435 unbind_to (count
, Qnil
);
5437 /* Check if terminal/window size has changed.
5438 Note that this is not useful when we are running directly
5439 with a window system; but suspend should be disabled in that case. */
5440 get_frame_size (&width
, &height
);
5441 if (width
!= old_width
|| height
!= old_height
)
5442 change_frame_size (selected_frame
, height
, width
, 0, 0);
5444 /* Run suspend-resume-hook. */
5445 if (!NILP (Vrun_hooks
))
5446 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
5452 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
5453 Then in any case stuff anything Emacs has read ahead and not used. */
5455 stuff_buffered_input (stuffstring
)
5456 Lisp_Object stuffstring
;
5458 register unsigned char *p
;
5460 /* stuff_char works only in BSD, versions 4.2 and up. */
5463 if (XTYPE (stuffstring
) == Lisp_String
)
5467 p
= XSTRING (stuffstring
)->data
;
5468 count
= XSTRING (stuffstring
)->size
;
5473 /* Anything we have read ahead, put back for the shell to read. */
5474 while (kbd_fetch_ptr
!= kbd_store_ptr
)
5476 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
5477 kbd_fetch_ptr
= kbd_buffer
;
5478 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
5479 stuff_char (kbd_fetch_ptr
->code
);
5480 kbd_fetch_ptr
->kind
= no_event
;
5481 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
5488 #endif /* BSD and not BSD4_1 */
5491 set_waiting_for_input (time_to_clear
)
5492 EMACS_TIME
*time_to_clear
;
5494 input_available_clear_time
= time_to_clear
;
5496 /* Tell interrupt_signal to throw back to read_char, */
5497 waiting_for_input
= 1;
5499 /* If interrupt_signal was called before and buffered a C-g,
5500 make it run again now, to avoid timing error. */
5501 if (!NILP (Vquit_flag
))
5502 quit_throw_to_read_char ();
5505 clear_waiting_for_input ()
5507 /* Tell interrupt_signal not to throw back to read_char, */
5508 waiting_for_input
= 0;
5509 input_available_clear_time
= 0;
5512 /* This routine is called at interrupt level in response to C-G.
5513 If interrupt_input, this is the handler for SIGINT.
5514 Otherwise, it is called from kbd_buffer_store_event,
5515 in handling SIGIO or SIGTINT.
5517 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
5518 immediately throw back to read_char.
5520 Otherwise it sets the Lisp variable quit-flag not-nil.
5521 This causes eval to throw, when it gets a chance.
5522 If quit-flag is already non-nil, it stops the job right away. */
5528 /* Must preserve main program's value of errno. */
5529 int old_errno
= errno
;
5532 /* USG systems forget handlers when they are used;
5533 must reestablish each time */
5534 signal (SIGINT
, interrupt_signal
);
5535 signal (SIGQUIT
, interrupt_signal
);
5540 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
5545 #ifdef SIGTSTP /* Support possible in later USG versions */
5547 * On systems which can suspend the current process and return to the original
5548 * shell, this command causes the user to end up back at the shell.
5549 * The "Auto-save" and "Abort" questions are not asked until
5550 * the user elects to return to emacs, at which point he can save the current
5551 * job and either dump core or continue.
5556 if (sys_suspend () == -1)
5558 printf ("Not running as a subprocess;\n");
5559 printf ("you can continue or abort.\n");
5562 /* Perhaps should really fork an inferior shell?
5563 But that would not provide any way to get back
5564 to the original shell, ever. */
5565 printf ("No support for stopping a process on this operating system;\n");
5566 printf ("you can continue or abort.\n");
5567 #endif /* not VMS */
5568 #endif /* not SIGTSTP */
5570 /* We must remain inside the screen area when the internal terminal
5571 is used. Note that [Enter] is not echoed by dos. */
5574 printf ("Auto-save? (y or n) ");
5576 if (((c
= getchar ()) & ~040) == 'Y')
5578 Fdo_auto_save (Qt
, Qnil
);
5580 printf ("\r\nAuto-save done");
5581 #else /* not MSDOS */
5582 printf ("Auto-save done\n");
5583 #endif /* not MSDOS */
5585 while (c
!= '\n') c
= getchar ();
5587 printf ("\r\nAbort? (y or n) ");
5588 #else /* not MSDOS */
5590 printf ("Abort (and enter debugger)? (y or n) ");
5592 printf ("Abort (and dump core)? (y or n) ");
5593 #endif /* not VMS */
5594 #endif /* not MSDOS */
5596 if (((c
= getchar ()) & ~040) == 'Y')
5598 while (c
!= '\n') c
= getchar ();
5600 printf ("\r\nContinuing...\r\n");
5601 #else /* not MSDOS */
5602 printf ("Continuing...\n");
5603 #endif /* not MSDOS */
5609 /* If executing a function that wants to be interrupted out of
5610 and the user has not deferred quitting by binding `inhibit-quit'
5611 then quit right away. */
5612 if (immediate_quit
&& NILP (Vinhibit_quit
))
5616 Fsignal (Qquit
, Qnil
);
5619 /* Else request quit when it's safe */
5623 if (waiting_for_input
&& !echoing
)
5624 quit_throw_to_read_char ();
5629 /* Handle a C-g by making read_char return C-g. */
5631 quit_throw_to_read_char ()
5633 quit_error_check ();
5635 /* Prevent another signal from doing this before we finish. */
5636 clear_waiting_for_input ();
5639 Vunread_command_events
= Qnil
;
5640 unread_command_char
= -1;
5642 #ifdef POLL_FOR_INPUT
5643 /* May be > 1 if in recursive minibuffer. */
5644 if (poll_suppress_count
== 0)
5648 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
5649 && XFRAME (internal_last_event_frame
) != selected_frame
)
5650 Fhandle_switch_frame (make_lispy_switch_frame (internal_last_event_frame
));
5653 _longjmp (getcjmp
, 1);
5656 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
5657 "Set mode of reading keyboard input.\n\
5658 First arg INTERRUPT non-nil means use input interrupts;\n\
5659 nil means use CBREAK mode.\n\
5660 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
5661 (no effect except in CBREAK mode).\n\
5662 Third arg META t means accept 8-bit input (for a Meta key).\n\
5663 META nil means ignore the top bit, on the assumption it is parity.\n\
5664 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
5665 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
5666 See also `current-input-mode'.")
5667 (interrupt
, flow
, meta
, quit
)
5668 Lisp_Object interrupt
, flow
, meta
, quit
;
5671 && (XTYPE (quit
) != Lisp_Int
5672 || XINT (quit
) < 0 || XINT (quit
) > 0400))
5673 error ("set-input-mode: QUIT must be an ASCII character");
5675 #ifdef POLL_FOR_INPUT
5681 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5682 #ifdef NO_SOCK_SIGIO
5683 if (read_socket_hook
)
5684 interrupt_input
= 0; /* No interrupts if reading from a socket. */
5686 #endif /* NO_SOCK_SIGIO */
5687 interrupt_input
= !NILP (interrupt
);
5688 #else /* not SIGIO */
5689 interrupt_input
= 0;
5690 #endif /* not SIGIO */
5691 /* Our VMS input only works by interrupts, as of now. */
5693 interrupt_input
= 1;
5695 flow_control
= !NILP (flow
);
5698 else if (EQ (meta
, Qt
))
5703 /* Don't let this value be out of range. */
5704 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
5708 #ifdef POLL_FOR_INPUT
5709 poll_suppress_count
= 1;
5715 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
5716 "Return information about the way Emacs currently reads keyboard input.\n\
5717 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
5718 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
5719 nil, Emacs is using CBREAK mode.\n\
5720 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
5721 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
5722 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
5723 META nil means ignoring the top bit, on the assumption it is parity.\n\
5724 META is neither t nor nil if accepting 8-bit input and using\n\
5725 all 8 bits as the character code.\n\
5726 QUIT is the character Emacs currently uses to quit.\n\
5727 The elements of this list correspond to the arguments of\n\
5733 val
[0] = interrupt_input
? Qt
: Qnil
;
5734 val
[1] = flow_control
? Qt
: Qnil
;
5735 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
5736 XFASTINT (val
[3]) = quit_char
;
5738 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
5744 /* This is correct before outermost invocation of the editor loop */
5745 command_loop_level
= -1;
5747 quit_char
= Ctl ('g');
5748 Vunread_command_events
= Qnil
;
5749 unread_command_char
= -1;
5751 recent_keys_index
= 0;
5752 kbd_fetch_ptr
= kbd_buffer
;
5753 kbd_store_ptr
= kbd_buffer
;
5754 do_mouse_tracking
= 0;
5758 /* This means that command_loop_1 won't try to select anything the first
5760 internal_last_event_frame
= Qnil
;
5761 Vlast_event_frame
= internal_last_event_frame
;
5764 /* If we're running a dumped Emacs, we need to clear out
5765 kbd_buffer_frame_or_window, in case some events got into it
5768 If we're running an undumped Emacs, it hasn't been initialized by
5769 syms_of_keyboard yet. */
5771 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5773 if (!noninteractive
)
5775 signal (SIGINT
, interrupt_signal
);
5776 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
5777 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
5778 SIGQUIT and we can't tell which one it will give us. */
5779 signal (SIGQUIT
, interrupt_signal
);
5780 #endif /* HAVE_TERMIO */
5781 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5783 signal (SIGIO
, input_available_signal
);
5787 /* Use interrupt input by default, if it works and noninterrupt input
5788 has deficiencies. */
5790 #ifdef INTERRUPT_INPUT
5791 interrupt_input
= 1;
5793 interrupt_input
= 0;
5796 /* Our VMS input only works by interrupts, as of now. */
5798 interrupt_input
= 1;
5804 if (keyboard_init_hook
)
5805 (*keyboard_init_hook
) ();
5807 #ifdef POLL_FOR_INPUT
5808 poll_suppress_count
= 1;
5813 /* This type's only use is in syms_of_keyboard, to initialize the
5814 event header symbols and put properties on them. */
5821 struct event_head head_table
[] = {
5822 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
5823 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
5824 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
5829 Qdisabled_command_hook
= intern ("disabled-command-hook");
5830 staticpro (&Qdisabled_command_hook
);
5832 Qself_insert_command
= intern ("self-insert-command");
5833 staticpro (&Qself_insert_command
);
5835 Qforward_char
= intern ("forward-char");
5836 staticpro (&Qforward_char
);
5838 Qbackward_char
= intern ("backward-char");
5839 staticpro (&Qbackward_char
);
5841 Qdisabled
= intern ("disabled");
5842 staticpro (&Qdisabled
);
5844 Qundefined
= intern ("undefined");
5845 staticpro (&Qundefined
);
5847 Qpre_command_hook
= intern ("pre-command-hook");
5848 staticpro (&Qpre_command_hook
);
5850 Qpost_command_hook
= intern ("post-command-hook");
5851 staticpro (&Qpost_command_hook
);
5853 Qcommand_hook_internal
= intern ("command-hook-internal");
5854 staticpro (&Qcommand_hook_internal
);
5856 Qfunction_key
= intern ("function-key");
5857 staticpro (&Qfunction_key
);
5858 Qmouse_click
= intern ("mouse-click");
5859 staticpro (&Qmouse_click
);
5861 Qmenu_enable
= intern ("menu-enable");
5862 staticpro (&Qmenu_enable
);
5864 Qmode_line
= intern ("mode-line");
5865 staticpro (&Qmode_line
);
5866 Qvertical_line
= intern ("vertical-line");
5867 staticpro (&Qvertical_line
);
5868 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
5869 staticpro (&Qvertical_scroll_bar
);
5870 Qmenu_bar
= intern ("menu-bar");
5871 staticpro (&Qmenu_bar
);
5873 Qabove_handle
= intern ("above-handle");
5874 staticpro (&Qabove_handle
);
5875 Qhandle
= intern ("handle");
5876 staticpro (&Qhandle
);
5877 Qbelow_handle
= intern ("below-handle");
5878 staticpro (&Qbelow_handle
);
5880 Qevent_kind
= intern ("event-kind");
5881 staticpro (&Qevent_kind
);
5882 Qevent_symbol_elements
= intern ("event-symbol-elements");
5883 staticpro (&Qevent_symbol_elements
);
5884 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
5885 staticpro (&Qevent_symbol_element_mask
);
5886 Qmodifier_cache
= intern ("modifier-cache");
5887 staticpro (&Qmodifier_cache
);
5889 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
5890 staticpro (&Qrecompute_lucid_menubar
);
5891 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
5892 staticpro (&Qactivate_menubar_hook
);
5894 Qpolling_period
= intern ("polling-period");
5895 staticpro (&Qpolling_period
);
5898 struct event_head
*p
;
5900 for (p
= head_table
;
5901 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
5904 *p
->var
= intern (p
->name
);
5906 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
5907 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
5911 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
5912 staticpro (&button_down_location
);
5916 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
5918 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
5919 for (i
= 0; i
< len
; i
++)
5920 if (modifier_names
[i
])
5921 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
5922 staticpro (&modifier_symbols
);
5925 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
5926 staticpro (&recent_keys
);
5928 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
5929 staticpro (&this_command_keys
);
5931 Qextended_command_history
= intern ("extended-command-history");
5932 Fset (Qextended_command_history
, Qnil
);
5933 staticpro (&Qextended_command_history
);
5935 kbd_buffer_frame_or_window
5936 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
5937 staticpro (&kbd_buffer_frame_or_window
);
5939 accent_key_syms
= Qnil
;
5940 staticpro (&accent_key_syms
);
5942 func_key_syms
= Qnil
;
5943 staticpro (&func_key_syms
);
5945 system_key_syms
= Qnil
;
5946 staticpro (&system_key_syms
);
5949 staticpro (&mouse_syms
);
5951 unread_switch_frame
= Qnil
;
5952 staticpro (&unread_switch_frame
);
5954 defsubr (&Sread_key_sequence
);
5955 defsubr (&Srecursive_edit
);
5956 defsubr (&Strack_mouse
);
5957 defsubr (&Sinput_pending_p
);
5958 defsubr (&Scommand_execute
);
5959 defsubr (&Srecent_keys
);
5960 defsubr (&Sthis_command_keys
);
5961 defsubr (&Ssuspend_emacs
);
5962 defsubr (&Sabort_recursive_edit
);
5963 defsubr (&Sexit_recursive_edit
);
5964 defsubr (&Srecursion_depth
);
5965 defsubr (&Stop_level
);
5966 defsubr (&Sdiscard_input
);
5967 defsubr (&Sopen_dribble_file
);
5968 defsubr (&Sset_input_mode
);
5969 defsubr (&Scurrent_input_mode
);
5970 defsubr (&Sexecute_extended_command
);
5972 DEFVAR_LISP ("last-command-char", &last_command_char
,
5973 "Last input event that was part of a command.");
5975 DEFVAR_LISP ("last-command-event", &last_command_char
,
5976 "Last input event that was part of a command.");
5978 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
5979 "Last input event in a command, except for mouse menu events.\n\
5980 Mouse menus give back keys that don't look like mouse events;\n\
5981 this variable holds the actual mouse event that led to the menu,\n\
5982 so that you can determine whether the command was run by mouse or not.");
5984 DEFVAR_LISP ("last-input-char", &last_input_char
,
5985 "Last input event.");
5987 DEFVAR_LISP ("last-input-event", &last_input_char
,
5988 "Last input event.");
5990 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
5991 "List of objects to be read as next command input events.");
5993 DEFVAR_INT ("unread-command-char", &unread_command_char
,
5994 "If not -1, an object to be read as next command input event.");
5996 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
5997 "Meta-prefix character code. Meta-foo as command input\n\
5998 turns into this character followed by foo.");
5999 XSET (meta_prefix_char
, Lisp_Int
, 033);
6001 DEFVAR_LISP ("last-command", &last_command
,
6002 "The last command executed. Normally a symbol with a function definition,\n\
6003 but can be whatever was found in the keymap, or whatever the variable\n\
6004 `this-command' was set to by that command.");
6005 last_command
= Qnil
;
6007 DEFVAR_LISP ("this-command", &this_command
,
6008 "The command now being executed.\n\
6009 The command can set this variable; whatever is put here\n\
6010 will be in `last-command' during the following command.");
6011 this_command
= Qnil
;
6013 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
6014 "*Number of keyboard input characters between auto-saves.\n\
6015 Zero means disable autosaving due to number of characters typed.");
6016 auto_save_interval
= 300;
6018 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
6019 "*Number of seconds idle time before auto-save.\n\
6020 Zero or nil means disable auto-saving due to idleness.\n\
6021 After auto-saving due to this many seconds of idle time,\n\
6022 Emacs also does a garbage collection if that seems to be warranted.");
6023 XFASTINT (Vauto_save_timeout
) = 30;
6025 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
6026 "*Nonzero means echo unfinished commands after this many seconds of pause.");
6027 echo_keystrokes
= 1;
6029 DEFVAR_INT ("polling-period", &polling_period
,
6030 "*Interval between polling for input during Lisp execution.\n\
6031 The reason for polling is to make C-g work to stop a running program.\n\
6032 Polling is needed only when using X windows and SIGIO does not work.\n\
6033 Polling is automatically disabled in all other cases.");
6036 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
6037 "*Maximum time between mouse clicks to make a double-click.\n\
6038 Measured in milliseconds. nil means disable double-click recognition;\n\
6039 t means double-clicks have no time limit and are detected\n\
6040 by position only.");
6041 Vdouble_click_time
= make_number (500);
6043 DEFVAR_INT ("num-input-keys", &num_input_keys
,
6044 "*Number of complete keys read from the keyboard so far.");
6047 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
6048 "*The frame in which the most recently read event occurred.\n\
6049 If the last event came from a keyboard macro, this is set to `macro'.");
6050 Vlast_event_frame
= Qnil
;
6052 DEFVAR_LISP ("help-char", &Vhelp_char
,
6053 "Character to recognize as meaning Help.\n\
6054 When it is read, do `(eval help-form)', and display result if it's a string.\n\
6055 If the value of `help-form' is nil, this char can be read normally.");
6056 XSET (Vhelp_char
, Lisp_Int
, Ctl ('H'));
6058 DEFVAR_LISP ("help-form", &Vhelp_form
,
6059 "Form to execute when character `help-char' is read.\n\
6060 If the form returns a string, that string is displayed.\n\
6061 If `help-form' is nil, the help char is not recognized.");
6064 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
6065 "Command to run when `help-char' character follows a prefix key.\n\
6066 This command is used only when there is no actual binding\n\
6067 for that character after that prefix key.");
6068 Vprefix_help_command
= Qnil
;
6070 DEFVAR_LISP ("top-level", &Vtop_level
,
6071 "Form to evaluate when Emacs starts up.\n\
6072 Useful to set before you dump a modified Emacs.");
6075 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
6076 "String used as translate table for keyboard input, or nil.\n\
6077 Each character is looked up in this string and the contents used instead.\n\
6078 If string is of length N, character codes N and up are untranslated.");
6079 Vkeyboard_translate_table
= Qnil
;
6081 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
6082 "Keymap of key translations that can override keymaps.\n\
6083 This keymap works like `function-key-map', but comes after that,\n\
6084 and applies even for keys that have ordinary bindings.");
6085 Vkey_translation_map
= Qnil
;
6087 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
6088 "Non-nil means to always spawn a subshell instead of suspending,\n\
6089 even if the operating system has support for stopping a process.");
6092 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
6093 "Non-nil means prompt with menus when appropriate.\n\
6094 This is done when reading from a keymap that has a prompt string,\n\
6095 for elements that have prompt strings.\n\
6096 The menu is displayed on the screen\n\
6097 if X menus were enabled at configuration\n\
6098 time and the previous event was a mouse click prefix key.\n\
6099 Otherwise, menu prompting uses the echo area.");
6102 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
6103 "Character to see next line of menu prompt.\n\
6104 Type this character while in a menu prompt to rotate around the lines of it.");
6105 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
6107 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
6108 "A mask of additional modifier keys to use with every keyboard character.\n\
6109 Emacs applies the modifiers of the character stored here to each keyboard\n\
6110 character it reads. For example, after evaluating the expression\n\
6111 (setq extra-keyboard-modifiers ?\C-x)\n\
6112 all input characters will have the control modifier applied to them.\n\
6114 Note that the character ?\C-@, equivalent to the integer zero, does\n\
6115 not count as a control character; rather, it counts as a character\n\
6116 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
6117 cancels any modification.");
6118 extra_keyboard_modifiers
= 0;
6120 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
6121 "If an editing command sets this to t, deactivate the mark afterward.\n\
6122 The command loop sets this to nil before each command,\n\
6123 and tests the value when the command returns.\n\
6124 Buffer modification stores t in this variable.");
6125 Vdeactivate_mark
= Qnil
;
6127 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
6128 "Temporary storage of pre-command-hook or post-command-hook.");
6129 Vcommand_hook_internal
= Qnil
;
6131 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
6132 "Normal hook run before each command is executed.\n\
6133 While the hook is run, its value is temporarily set to nil\n\
6134 to avoid an unbreakable infinite loop if a hook function gets an error.\n\
6135 As a result, a hook function cannot straightforwardly alter the value of\n\
6136 `pre-command-hook'. See the Emacs Lisp manual for a way of\n\
6137 implementing hook functions that alter the set of hook functions.");
6138 Vpre_command_hook
= Qnil
;
6140 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
6141 "Normal hook run after each command is executed.\n\
6142 While the hook is run, its value is temporarily set to nil\n\
6143 to avoid an unbreakable infinite loop if a hook function gets an error.\n\
6144 As a result, a hook function cannot straightforwardly alter the value of\n\
6145 `post-command-hook'. See the Emacs Lisp manual for a way of\n\
6146 implementing hook functions that alter the set of hook functions.");
6147 Vpost_command_hook
= Qnil
;
6149 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
6150 "t means menu bar, specified Lucid style, needs to be recomputed.");
6151 Vlucid_menu_bar_dirty_flag
= Qnil
;
6153 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
6154 "List of menu bar items to move to the end of the menu bar.\n\
6155 The elements of the list are event types that may have menu bar bindings.");
6156 Vmenu_bar_final_items
= Qnil
;
6158 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
6159 "Keymap that overrides all other local keymaps.\n\
6160 If this variable is non-nil, it is used as a keymap instead of the\n\
6161 buffer's local map, and the minor mode keymaps and text property keymaps.");
6162 Voverriding_local_map
= Qnil
;
6164 DEFVAR_BOOL ("track-mouse", &do_mouse_tracking
,
6165 "*Non-nil means generate motion events for mouse motion.");
6167 DEFVAR_LISP ("system-key-alist", &Vsystem_key_alist
,
6168 "Alist of system-specific X windows key symbols.\n\
6169 Each element should have the form (N . SYMBOL) where N is the\n\
6170 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
6171 and SYMBOL is its name.");
6172 Vmenu_bar_final_items
= Qnil
;
6177 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
6178 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
6179 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
6180 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
6181 initial_define_key (meta_map
, 'x', "execute-extended-command");