1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
20 /* Allow config.h to undefine symbols found here. */
29 #include "termhooks.h"
36 #include "dispextern.h"
38 #include "intervals.h"
39 #include "blockinput.h"
44 #include <sys/ioctl.h>
47 #include "syssignal.h"
53 /* Variables for blockinput.h: */
55 /* Non-zero if interrupt input is blocked right now. */
56 int interrupt_input_blocked
;
58 /* Nonzero means an input interrupt has arrived
59 during the current critical section. */
60 int interrupt_input_pending
;
64 extern Lisp_Object Vmouse_grabbed
;
66 /* Make all keyboard buffers much bigger when using X windows. */
67 #define KBD_BUFFER_SIZE 4096
68 #else /* No X-windows, character input */
69 #define KBD_BUFFER_SIZE 256
70 #endif /* No X-windows */
72 /* Following definition copied from eval.c */
76 struct backtrace
*next
;
77 Lisp_Object
*function
;
78 Lisp_Object
*args
; /* Points to vector of args. */
79 int nargs
; /* length of vector. If nargs is UNEVALLED,
80 args points to slot holding list of
85 /* Non-nil disable property on a command means
86 do not execute it; call disabled-command-hook's value instead. */
87 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
89 #define NUM_RECENT_KEYS (100)
90 int recent_keys_index
; /* Index for storing next element into recent_keys */
91 int total_keys
; /* Total number of elements stored into recent_keys */
92 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
94 /* Vector holding the key sequence that invoked the current command.
95 It is reused for each command, and it may be longer than the current
96 sequence; this_command_key_count indicates how many elements
97 actually mean something.
98 It's easier to staticpro a single Lisp_Object than an array. */
99 Lisp_Object this_command_keys
;
100 int this_command_key_count
;
102 extern int minbuf_level
;
104 extern struct backtrace
*backtrace_list
;
106 /* Nonzero means do menu prompting. */
107 static int menu_prompting
;
109 /* Character to see next line of menu prompt. */
110 static Lisp_Object menu_prompt_more_char
;
112 /* For longjmp to where kbd input is being done. */
113 static jmp_buf getcjmp
;
115 /* True while doing kbd input. */
116 int waiting_for_input
;
118 /* True while displaying for echoing. Delays C-g throwing. */
121 /* Nonzero means C-G should cause immediate error-signal. */
124 /* Character to recognize as the help char. */
125 Lisp_Object Vhelp_char
;
127 /* Form to execute when help char is typed. */
128 Lisp_Object Vhelp_form
;
130 /* Command to run when the help character follows a prefix key. */
131 Lisp_Object Vprefix_help_command
;
133 /* List of items that should move to the end of the menu bar. */
134 Lisp_Object Vmenu_bar_final_items
;
136 /* Character that causes a quit. Normally C-g.
138 If we are running on an ordinary terminal, this must be an ordinary
139 ASCII char, since we want to make it our interrupt character.
141 If we are not running on an ordinary terminal, it still needs to be
142 an ordinary ASCII char. This character needs to be recognized in
143 the input interrupt handler. At this point, the keystroke is
144 represented as a struct input_event, while the desired quit
145 character is specified as a lispy event. The mapping from struct
146 input_events to lispy events cannot run in an interrupt handler,
147 and the reverse mapping is difficult for anything but ASCII
150 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
154 extern Lisp_Object current_global_map
;
155 extern int minibuf_level
;
157 /* Current depth in recursive edits. */
158 int command_loop_level
;
160 /* Total number of times command_loop has read a key sequence. */
163 /* Last input character read as a command. */
164 Lisp_Object last_command_char
;
166 /* Last input character read as a command, not counting menus
167 reached by the mouse. */
168 Lisp_Object last_nonmenu_event
;
170 /* Last input character read for any purpose. */
171 Lisp_Object last_input_char
;
173 /* If not Qnil, a list of objects to be read as subsequent command input. */
174 Lisp_Object unread_command_events
;
176 /* If not -1, an event to be read as subsequent command input. */
177 int unread_command_char
;
179 /* If not Qnil, this is a switch-frame event which we decided to put
180 off until the end of a key sequence. This should be read as the
181 next command input, after any unread_command_events.
183 read_key_sequence uses this to delay switch-frame events until the
184 end of the key sequence; Fread_char uses it to put off switch-frame
185 events until a non-ASCII event is acceptable as input. */
186 Lisp_Object unread_switch_frame
;
188 /* A mask of extra modifier bits to put into every keyboard char. */
189 int extra_keyboard_modifiers
;
191 /* Char to use as prefix when a meta character is typed in.
192 This is bound on entry to minibuffer in case ESC is changed there. */
194 Lisp_Object meta_prefix_char
;
196 /* Last size recorded for a current buffer which is not a minibuffer. */
197 static int last_non_minibuf_size
;
199 /* Number of idle seconds before an auto-save and garbage collection. */
200 static Lisp_Object Vauto_save_timeout
;
202 /* Total number of times read_char has returned. */
205 /* Total number of times read_char has returned, outside of macros. */
206 int num_nonmacro_input_chars
;
208 /* Auto-save automatically when this many characters have been typed
209 since the last time. */
211 static int auto_save_interval
;
213 /* Value of num_nonmacro_input_chars as of last auto save. */
217 /* Last command executed by the editor command loop, not counting
218 commands that set the prefix argument. */
220 Lisp_Object last_command
;
222 /* The command being executed by the command loop.
223 Commands may set this, and the value set will be copied into last_command
224 instead of the actual command. */
225 Lisp_Object this_command
;
228 /* The frame in which the last input event occurred, or Qmacro if the
229 last event came from a macro. We use this to determine when to
230 generate switch-frame events. This may be cleared by functions
231 like Fselect_frame, to make sure that a switch-frame event is
232 generated by the next character. */
233 Lisp_Object internal_last_event_frame
;
235 /* A user-visible version of the above, intended to allow users to
236 figure out where the last event came from, if the event doesn't
237 carry that information itself (i.e. if it was a character). */
238 Lisp_Object Vlast_event_frame
;
241 /* The timestamp of the last input event we received from the X server.
242 X Windows wants this for selection ownership. */
243 unsigned long last_event_timestamp
;
245 Lisp_Object Qself_insert_command
;
246 Lisp_Object Qforward_char
;
247 Lisp_Object Qbackward_char
;
248 Lisp_Object Qundefined
;
250 /* read_key_sequence stores here the command definition of the
251 key sequence that it reads. */
252 Lisp_Object read_key_sequence_cmd
;
254 /* Form to evaluate (if non-nil) when Emacs is started. */
255 Lisp_Object Vtop_level
;
257 /* User-supplied string to translate input characters through. */
258 Lisp_Object Vkeyboard_translate_table
;
260 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
261 extern Lisp_Object Vfunction_key_map
;
263 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
264 Lisp_Object Vkey_translation_map
;
266 /* Non-nil means deactivate the mark at end of this command. */
267 Lisp_Object Vdeactivate_mark
;
269 /* Menu bar specified in Lucid Emacs fashion. */
271 Lisp_Object Vlucid_menu_bar_dirty_flag
;
272 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
274 /* Hooks to run before and after each command. */
275 Lisp_Object Qpre_command_hook
, Qpost_command_hook
;
276 Lisp_Object Vpre_command_hook
, Vpost_command_hook
;
278 /* File in which we write all commands we read. */
281 /* Nonzero if input is available. */
284 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
285 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
289 extern char *pending_malloc_warning
;
291 /* Circular buffer for pre-read keyboard input. */
292 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
294 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
296 The interrupt-level event handlers will never enqueue an event on a
297 frame which is not in Vframe_list, and once an event is dequeued,
298 internal_last_event_frame or the event itself points to the frame.
301 But while the event is sitting in the queue, it's completely
302 unprotected. Suppose the user types one command which will run for
303 a while and then delete a frame, and then types another event at
304 the frame that will be deleted, before the command gets around to
305 it. Suppose there are no references to this frame elsewhere in
306 Emacs, and a GC occurs before the second event is dequeued. Now we
307 have an event referring to a freed frame, which will crash Emacs
310 Similar things happen when an event on a scroll bar is enqueued; the
311 window may be deleted while the event is in the queue.
313 So, we use this vector to protect the frame_or_window field in the
314 event queue. That way, they'll be dequeued as dead frames or
315 windows, but still valid lisp objects.
317 If kbd_buffer[i].kind != no_event, then
318 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
319 == kbd_buffer[i].frame_or_window. */
320 static Lisp_Object kbd_buffer_frame_or_window
;
322 /* Pointer to next available character in kbd_buffer.
323 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
324 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
325 next available char is in kbd_buffer[0]. */
326 static struct input_event
*kbd_fetch_ptr
;
328 /* Pointer to next place to store character in kbd_buffer. This
329 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
330 character should go in kbd_buffer[0]. */
334 static struct input_event
*kbd_store_ptr
;
336 /* The above pair of variables forms a "queue empty" flag. When we
337 enqueue a non-hook event, we increment kbd_write_count. When we
338 dequeue a non-hook event, we increment kbd_read_count. We say that
339 there is input available iff the two counters are not equal.
341 Why not just have a flag set and cleared by the enqueuing and
342 dequeuing functions? Such a flag could be screwed up by interrupts
343 at inopportune times. */
345 /* If this flag is non-zero, we check mouse_moved to see when the
346 mouse moves, and motion events will appear in the input stream. If
347 it is zero, mouse motion is ignored. */
348 static int do_mouse_tracking
;
350 /* The window system handling code should set this if the mouse has
351 moved since the last call to the mouse_position_hook. Calling that
352 hook should clear this. Code assumes that if this is set, it can
353 call mouse_position_hook to get the promised position, so don't set
354 it unless you're prepared to substantiate the claim! */
357 /* True iff there is an event in kbd_buffer, or if mouse tracking is
358 enabled and there is a new mouse position in the mouse movement
359 buffer. Note that if this is false, that doesn't mean that there
360 is readable input; all the events in the queue might be button-up
361 events, and do_mouse_tracking might be off. */
362 #define EVENT_QUEUES_EMPTY \
363 ((kbd_fetch_ptr == kbd_store_ptr) && (!do_mouse_tracking || !mouse_moved))
366 /* Symbols to head events. */
367 Lisp_Object Qmouse_movement
;
368 Lisp_Object Qscroll_bar_movement
;
369 Lisp_Object Qswitch_frame
;
371 /* Symbols to denote kinds of events. */
372 Lisp_Object Qfunction_key
;
373 Lisp_Object Qmouse_click
;
374 /* Lisp_Object Qmouse_movement; - also an event header */
376 /* Properties of event headers. */
377 Lisp_Object Qevent_kind
;
378 Lisp_Object Qevent_symbol_elements
;
380 Lisp_Object Qmenu_enable
;
382 /* An event header symbol HEAD may have a property named
383 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
384 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
385 mask of modifiers applied to it. If present, this is used to help
386 speed up parse_modifiers. */
387 Lisp_Object Qevent_symbol_element_mask
;
389 /* An unmodified event header BASE may have a property named
390 Qmodifier_cache, which is an alist mapping modifier masks onto
391 modified versions of BASE. If present, this helps speed up
393 Lisp_Object Qmodifier_cache
;
395 /* Symbols to use for parts of windows. */
396 Lisp_Object Qmode_line
;
397 Lisp_Object Qvertical_line
;
398 Lisp_Object Qvertical_scroll_bar
;
399 Lisp_Object Qmenu_bar
;
401 extern Lisp_Object Qmenu_enable
;
403 Lisp_Object
recursive_edit_unwind (), command_loop ();
404 Lisp_Object
Fthis_command_keys ();
406 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
408 EMACS_TIME
*input_available_clear_time
;
410 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
411 Default is 1 if INTERRUPT_INPUT is defined. */
414 /* Nonzero while interrupts are temporarily deferred during redisplay. */
415 int interrupts_deferred
;
417 /* nonzero means use ^S/^Q for flow control. */
420 /* Allow m- file to inhibit use of FIONREAD. */
421 #ifdef BROKEN_FIONREAD
425 /* We are unable to use interrupts if FIONREAD is not available,
426 so flush SIGIO so we won't try. */
433 /* If we support X Windows, and won't get an interrupt when input
434 arrives from the server, poll periodically so we can detect C-g. */
435 #ifdef HAVE_X_WINDOWS
437 #define POLL_FOR_INPUT
441 /* Global variable declarations. */
443 /* Function for init_keyboard to call with no args (if nonzero). */
444 void (*keyboard_init_hook
) ();
446 static int read_avail_input ();
447 static void get_input_pending ();
448 static int readable_events ();
449 static Lisp_Object
read_char_menu_prompt ();
450 static Lisp_Object
make_lispy_event ();
451 static Lisp_Object
make_lispy_movement ();
452 static Lisp_Object
modify_event_symbol ();
453 static Lisp_Object
make_lispy_switch_frame ();
455 /* > 0 if we are to echo keystrokes. */
456 static int echo_keystrokes
;
458 /* Nonzero means echo each character as typed. */
459 static int immediate_echo
;
461 /* The text we're echoing in the modeline - partial key sequences,
462 usually. '\0'-terminated. This really shouldn't have a fixed size. */
463 static char echobuf
[300];
465 /* Where to append more text to echobuf if we want to. */
466 static char *echoptr
;
468 #define min(a,b) ((a)<(b)?(a):(b))
469 #define max(a,b) ((a)>(b)?(a):(b))
471 /* Install the string STR as the beginning of the string of echoing,
472 so that it serves as a prompt for the next character.
473 Also start echoing. */
478 int len
= strlen (str
);
479 if (len
> sizeof echobuf
- 4)
480 len
= sizeof echobuf
- 4;
481 bcopy (str
, echobuf
, len
);
482 echoptr
= echobuf
+ len
;
488 /* Add C to the echo string, if echoing is going on.
489 C can be a character, which is printed prettily ("M-C-x" and all that
490 jazz), or a symbol, whose name is printed. */
495 extern char *push_key_description ();
504 /* If someone has passed us a composite event, use its head symbol. */
507 if (XTYPE (c
) == Lisp_Int
)
509 if (ptr
- echobuf
> sizeof echobuf
- 6)
512 ptr
= push_key_description (XINT (c
), ptr
);
514 else if (XTYPE (c
) == Lisp_Symbol
)
516 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
517 if (((ptr
- echobuf
) + name
->size
+ 4) > sizeof echobuf
)
519 bcopy (name
->data
, ptr
, name
->size
);
523 if (echoptr
== echobuf
&& EQ (c
, Vhelp_char
))
525 strcpy (ptr
, " (Type ? for further options)");
536 /* Temporarily add a dash to the end of the echo string if it's not
537 empty, so that it serves as a mini-prompt for the very next character. */
541 if (!immediate_echo
&& echoptr
== echobuf
)
543 /* Do nothing if not echoing at all. */
547 /* Put a dash at the end of the buffer temporarily,
548 but make it go away when the next character is added. */
555 /* Display the current echo string, and begin echoing if not already
565 for (i
= 0; i
< this_command_key_count
; i
++)
566 echo_char (XVECTOR (this_command_keys
)->contents
[i
]);
574 if (waiting_for_input
&& !NILP (Vquit_flag
))
575 quit_throw_to_read_char ();
578 /* Turn off echoing, for the start of a new command. */
586 /* Return the length of the current echo string. */
591 return echoptr
- echobuf
;
594 /* Truncate the current echo message to its first LEN chars.
595 This and echo_char get used by read_key_sequence when the user
596 switches frames while entering a key sequence. */
603 echoptr
= echobuf
+ len
;
607 /* Functions for manipulating this_command_keys. */
609 add_command_key (key
)
612 int size
= XVECTOR (this_command_keys
)->size
;
614 if (this_command_key_count
>= size
)
616 Lisp_Object new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
618 bcopy (XVECTOR (this_command_keys
)->contents
,
619 XVECTOR (new_keys
)->contents
,
620 size
* sizeof (Lisp_Object
));
622 this_command_keys
= new_keys
;
625 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
631 int count
= specpdl_ptr
- specpdl
;
634 if (command_loop_level
> 0)
636 specbind (Qstandard_output
, Qt
);
637 specbind (Qstandard_input
, Qt
);
640 val
= command_loop ();
642 Fsignal (Qquit
, Qnil
);
644 return unbind_to (count
, Qnil
);
647 /* When an auto-save happens, record the "time", and don't do again soon. */
650 last_auto_save
= num_nonmacro_input_chars
;
653 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
654 "Invoke the editor command loop recursively.\n\
655 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
656 that tells this function to return.\n\
657 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
658 This function is called by the editor initialization to begin editing.")
661 int count
= specpdl_ptr
- specpdl
;
664 command_loop_level
++;
665 update_mode_lines
= 1;
667 record_unwind_protect (recursive_edit_unwind
,
669 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
673 return unbind_to (count
, Qnil
);
677 recursive_edit_unwind (buffer
)
681 Fset_buffer (buffer
);
683 command_loop_level
--;
684 update_mode_lines
= 1;
692 Lisp_Object errmsg
, tail
, errname
, file_error
;
699 Vstandard_output
= Qt
;
700 Vstandard_input
= Qt
;
701 Vexecuting_macro
= Qnil
;
702 echo_area_glyphs
= 0;
704 /* If the window system or terminal frame hasn't been initialized
705 yet, or we're not interactive, it's best to dump this message out
706 to stderr and exit. */
707 if (! FRAME_MESSAGE_BUF (selected_frame
)
709 stream
= Qexternal_debugging_output
;
717 errname
= Fcar (data
);
719 if (EQ (errname
, Qerror
))
722 if (!CONSP (data
)) data
= Qnil
;
723 errmsg
= Fcar (data
);
728 errmsg
= Fget (errname
, Qerror_message
);
729 file_error
= Fmemq (Qfile_error
,
730 Fget (errname
, Qerror_conditions
));
733 /* Print an error message including the data items.
734 This is done by printing it into a scratch buffer
735 and then making a copy of the text in the buffer. */
737 if (!CONSP (data
)) data
= Qnil
;
741 /* For file-error, make error message by concatenating
742 all the data items. They are all strings. */
743 if (!NILP (file_error
) && !NILP (tail
))
744 errmsg
= XCONS (tail
)->car
, tail
= XCONS (tail
)->cdr
;
746 if (XTYPE (errmsg
) == Lisp_String
)
747 Fprinc (errmsg
, stream
);
749 write_string_1 ("peculiar error", -1, stream
);
751 for (i
= 0; CONSP (tail
); tail
= Fcdr (tail
), i
++)
753 write_string_1 (i
? ", " : ": ", 2, stream
);
754 if (!NILP (file_error
))
755 Fprinc (Fcar (tail
), stream
);
757 Fprin1 (Fcar (tail
), stream
);
761 /* If the window system or terminal frame hasn't been initialized
762 yet, or we're in -batch mode, this error should cause Emacs to exit. */
763 if (! FRAME_MESSAGE_BUF (selected_frame
)
767 Fkill_emacs (make_number (-1));
772 Vinhibit_quit
= Qnil
;
773 return make_number (0);
776 Lisp_Object
command_loop_1 ();
777 Lisp_Object
command_loop_2 ();
778 Lisp_Object
top_level_1 ();
780 /* Entry to editor-command-loop.
781 This level has the catches for exiting/returning to editor command loop.
782 It returns nil to exit recursive edit, t to abort it. */
787 if (command_loop_level
> 0 || minibuf_level
> 0)
789 return internal_catch (Qexit
, command_loop_2
, Qnil
);
794 internal_catch (Qtop_level
, top_level_1
, Qnil
);
795 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
797 /* End of file in -batch run causes exit here. */
803 /* Here we catch errors in execution of commands within the
804 editing loop, and reenter the editing loop.
805 When there is an error, cmd_error runs and returns a non-nil
806 value to us. A value of nil means that cmd_loop_1 itself
807 returned due to end of file (or end of kbd macro). */
812 register Lisp_Object val
;
815 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
824 return Feval (Vtop_level
);
830 /* On entry to the outer level, run the startup file */
831 if (!NILP (Vtop_level
))
832 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
833 else if (!NILP (Vpurify_flag
))
834 message ("Bare impure Emacs (standard Lisp code not loaded)");
836 message ("Bare Emacs (standard Lisp code not loaded)");
840 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
841 "Exit all recursive editing levels.")
844 Fthrow (Qtop_level
, Qnil
);
847 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
848 "Exit from the innermost recursive edit or minibuffer.")
851 if (command_loop_level
> 0 || minibuf_level
> 0)
852 Fthrow (Qexit
, Qnil
);
854 error ("No recursive edit is in progress");
857 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
858 "Abort the command that requested this recursive edit or minibuffer input.")
861 if (command_loop_level
> 0 || minibuf_level
> 0)
864 error ("No recursive edit is in progress");
867 /* This is the actual command reading loop,
868 sans error-handling encapsulation. */
870 Lisp_Object
Fcommand_execute ();
871 static int read_key_sequence ();
876 Lisp_Object cmd
, tem
;
879 Lisp_Object keybuf
[30];
884 struct buffer
*prev_buffer
;
887 Vdeactivate_mark
= Qnil
;
888 waiting_for_input
= 0;
891 /* Don't clear out last_command at the beginning of a macro. */
892 if (XTYPE (Vexecuting_macro
) != Lisp_String
)
897 this_command_key_count
= 0;
899 /* Make sure this hook runs after commands that get errors and
900 throw to top level. */
901 if (!NILP (Vpost_command_hook
))
902 call1 (Vrun_hooks
, Qpost_command_hook
);
906 /* Install chars successfully executed in kbd macro. */
908 if (defining_kbd_macro
&& NILP (Vprefix_arg
))
909 finalize_kbd_macro_chars ();
911 /* Make sure the current window's buffer is selected. */
912 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
913 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
915 /* Display any malloc warning that just came out. Use while because
916 displaying one warning can cause another. */
918 while (pending_malloc_warning
)
919 display_malloc_warning ();
923 Vdeactivate_mark
= Qnil
;
925 /* If minibuffer on and echo area in use,
926 wait 2 sec and redraw minibuffer. */
928 if (minibuf_level
&& echo_area_glyphs
)
930 /* Bind inhibit-quit to t so that C-g gets read in
931 rather than quitting back to the minibuffer. */
932 int count
= specpdl_ptr
- specpdl
;
933 specbind (Qinhibit_quit
, Qt
);
934 Fsit_for (make_number (2), Qnil
, Qnil
);
935 unbind_to (count
, Qnil
);
937 echo_area_glyphs
= 0;
939 if (!NILP (Vquit_flag
))
942 unread_command_events
= Fcons (make_number (quit_char
), Qnil
);
947 alloca (0); /* Cause a garbage collection now */
948 /* Since we can free the most stuff here. */
949 #endif /* C_ALLOCA */
953 /* Select the frame that the last event came from. Usually,
954 switch-frame events will take care of this, but if some lisp
955 code swallows a switch-frame event, we'll fix things up here.
956 Is this a good idea? */
957 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
958 && XFRAME (internal_last_event_frame
) != selected_frame
)
959 Fselect_frame (internal_last_event_frame
, Qnil
);
962 /* If it has changed current-menubar from previous value,
963 really recompute the menubar from the value. */
964 if (! NILP (Vlucid_menu_bar_dirty_flag
))
965 call0 (Qrecompute_lucid_menubar
);
967 #if 0 /* This is done in xdisp.c now. */
969 for (tem
= Vframe_list
; CONSP (tem
); tem
= XCONS (tem
)->cdr
)
971 struct frame
*f
= XFRAME (XCONS (tem
)->car
);
972 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
974 /* If the user has switched buffers or windows, we need to
975 recompute to reflect the new bindings. But we'll
976 recompute when update_mode_lines is set too; that means
977 that people can use force-mode-line-update to request
978 that the menu bar be recomputed. The adverse effect on
979 the rest of the redisplay algorithm is about the same as
980 windows_or_buffers_changed anyway. */
981 if (windows_or_buffers_changed
983 || (XFASTINT (w
->last_modified
) < MODIFF
984 && (XFASTINT (w
->last_modified
)
985 <= XBUFFER (w
->buffer
)->save_modified
)))
987 struct buffer
*prev
= current_buffer
;
988 current_buffer
= XBUFFER (w
->buffer
);
989 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items ();
990 current_buffer
= prev
;
993 #endif /* MULTI_FRAME */
996 /* Read next key sequence; i gets its length. */
997 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), 0);
1001 /* Now we have read a key sequence of length I,
1002 or else I is 0 and we found end of file. */
1004 if (i
== 0) /* End of file -- happens only in */
1005 return Qnil
; /* a kbd macro, at the end. */
1006 /* -1 means read_key_sequence got a menu that was rejected.
1007 Just loop around and read another command. */
1011 this_command_key_count
= 0;
1015 last_command_char
= keybuf
[i
- 1];
1017 /* If the previous command tried to force a specific window-start,
1018 forget about that, in case this command moves point far away
1019 from that position. */
1020 XWINDOW (selected_window
)->force_start
= Qnil
;
1022 cmd
= read_key_sequence_cmd
;
1023 if (!NILP (Vexecuting_macro
))
1025 if (!NILP (Vquit_flag
))
1027 Vexecuting_macro
= Qt
;
1028 QUIT
; /* Make some noise. */
1029 /* Will return since macro now empty. */
1033 /* Do redisplay processing after this command except in special
1034 cases identified below that set no_redisplay to 1. */
1037 prev_buffer
= current_buffer
;
1038 prev_modiff
= MODIFF
;
1040 /* Execute the command. */
1043 if (!NILP (Vpre_command_hook
))
1044 call1 (Vrun_hooks
, Qpre_command_hook
);
1046 if (NILP (this_command
))
1048 /* nil means key is undefined. */
1050 defining_kbd_macro
= 0;
1051 update_mode_lines
= 1;
1057 if (NILP (Vprefix_arg
) && ! no_direct
)
1059 /* Recognize some common commands in common situations and
1060 do them directly. */
1061 if (EQ (this_command
, Qforward_char
) && point
< ZV
)
1063 struct Lisp_Vector
*dp
1064 = window_display_table (XWINDOW (selected_window
));
1065 lose
= FETCH_CHAR (point
);
1068 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1069 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1070 : (lose
>= 0x20 && lose
< 0x7f))
1071 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1073 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1075 && !windows_or_buffers_changed
1076 && EQ (current_buffer
->selective_display
, Qnil
)
1077 && !detect_input_pending ()
1078 && NILP (Vexecuting_macro
))
1079 no_redisplay
= direct_output_forward_char (1);
1082 else if (EQ (this_command
, Qbackward_char
) && point
> BEGV
)
1084 struct Lisp_Vector
*dp
1085 = window_display_table (XWINDOW (selected_window
));
1087 lose
= FETCH_CHAR (point
);
1089 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1090 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1091 : (lose
>= 0x20 && lose
< 0x7f))
1092 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1094 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1096 && !windows_or_buffers_changed
1097 && EQ (current_buffer
->selective_display
, Qnil
)
1098 && !detect_input_pending ()
1099 && NILP (Vexecuting_macro
))
1100 no_redisplay
= direct_output_forward_char (-1);
1103 else if (EQ (this_command
, Qself_insert_command
)
1104 /* Try this optimization only on ascii keystrokes. */
1105 && XTYPE (last_command_char
) == Lisp_Int
)
1107 unsigned char c
= XINT (last_command_char
);
1109 if (NILP (Vexecuting_macro
) &&
1110 !EQ (minibuf_window
, selected_window
))
1112 if (!nonundocount
|| nonundocount
>= 20)
1119 lose
= (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1121 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1123 || MODIFF
<= current_buffer
->save_modified
1124 || windows_or_buffers_changed
1125 || !EQ (current_buffer
->selective_display
, Qnil
)
1126 || detect_input_pending ()
1127 || !NILP (Vexecuting_macro
);
1128 if (internal_self_insert (c
, 0))
1134 (point
== ZV
|| FETCH_CHAR (point
) == '\n'))
1136 struct Lisp_Vector
*dp
1137 = window_display_table (XWINDOW (selected_window
));
1142 Lisp_Object obj
= DISP_CHAR_VECTOR (dp
, lose
);
1144 if (XTYPE (obj
) == Lisp_Vector
1145 && XVECTOR (obj
)->size
== 1
1146 && (XTYPE (obj
= XVECTOR (obj
)->contents
[0])
1149 direct_output_for_insert (XINT (obj
));
1153 if (lose
>= 0x20 && lose
<= 0x7e)
1154 no_redisplay
= direct_output_for_insert (lose
);
1161 /* Here for a command that isn't executed directly */
1164 if (NILP (Vprefix_arg
))
1166 Fcommand_execute (this_command
, Qnil
);
1171 if (!NILP (Vpost_command_hook
))
1172 call1 (Vrun_hooks
, Qpost_command_hook
);
1174 /* If there is a prefix argument,
1175 1) We don't want last_command to be ``universal-argument''
1176 (that would be dumb), so don't set last_command,
1177 2) we want to leave echoing on so that the prefix will be
1178 echoed as part of this key sequence, so don't call
1180 3) we want to leave this_command_key_count non-zero, so that
1181 read_char will realize that it is re-reading a character, and
1182 not echo it a second time. */
1183 if (NILP (Vprefix_arg
))
1185 last_command
= this_command
;
1187 this_command_key_count
= 0;
1190 if (!NILP (current_buffer
->mark_active
))
1192 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1194 current_buffer
->mark_active
= Qnil
;
1195 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1197 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1198 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1203 /* Number of seconds between polling for input. */
1206 /* Nonzero means polling for input is temporarily suppressed. */
1207 int poll_suppress_count
;
1209 #ifdef POLL_FOR_INPUT
1210 int polling_for_input
;
1212 /* Handle an alarm once each second and read pending input
1213 so as to handle a C-g if it comces in. */
1216 input_poll_signal ()
1218 if (interrupt_input_blocked
== 0
1219 && !waiting_for_input
)
1220 read_avail_input (0);
1221 signal (SIGALRM
, input_poll_signal
);
1222 alarm (polling_period
);
1227 /* Begin signals to poll for input, if they are appropriate.
1228 This function is called unconditionally from various places. */
1232 #ifdef POLL_FOR_INPUT
1233 if (read_socket_hook
)
1235 poll_suppress_count
--;
1236 if (poll_suppress_count
== 0)
1238 signal (SIGALRM
, input_poll_signal
);
1239 polling_for_input
= 1;
1240 alarm (polling_period
);
1246 /* Turn off polling. */
1250 #ifdef POLL_FOR_INPUT
1251 if (read_socket_hook
)
1253 if (poll_suppress_count
== 0)
1255 polling_for_input
= 0;
1258 poll_suppress_count
++;
1263 /* Applying the control modifier to CHARACTER. */
1268 /* Save the upper bits here. */
1269 int upper
= c
& ~0177;
1273 /* Everything in the columns containing the upper-case letters
1274 denotes a control character. */
1275 if (c
>= 0100 && c
< 0140)
1279 /* Set the shift modifier for a control char
1280 made from a shifted letter. But only for letters! */
1281 if (oc
>= 'A' && oc
<= 'Z')
1282 c
|= shift_modifier
;
1285 /* The lower-case letters denote control characters too. */
1286 else if (c
>= 'a' && c
<= 'z')
1289 /* Include the bits for control and shift
1290 only if the basic ASCII code can't indicate them. */
1294 /* Replace the high bits. */
1295 c
|= (upper
& ~ctrl_modifier
);
1302 /* Input of single characters from keyboard */
1304 Lisp_Object
print_help ();
1305 static Lisp_Object
kbd_buffer_get_event ();
1307 /* read a character from the keyboard; call the redisplay if needed */
1308 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1309 -1 means do not do redisplay, but do do autosaving.
1312 /* The arguments MAPS and NMAPS are for menu prompting.
1313 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1315 PREV_EVENT is the previous input event, or nil if we are reading
1316 the first event of a key sequence.
1318 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1319 if we used a mouse menu to read the input, or zero otherwise. If
1320 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
1322 Value is t if we showed a menu and the user rejected it. */
1325 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1329 Lisp_Object prev_event
;
1330 int *used_mouse_menu
;
1332 register Lisp_Object c
;
1336 if (CONSP (unread_command_events
))
1338 c
= XCONS (unread_command_events
)->car
;
1339 unread_command_events
= XCONS (unread_command_events
)->cdr
;
1341 if (this_command_key_count
== 0)
1347 if (unread_command_char
!= -1)
1349 XSET (c
, Lisp_Int
, unread_command_char
);
1350 unread_command_char
= -1;
1352 if (this_command_key_count
== 0)
1358 if (!NILP (Vexecuting_macro
))
1361 /* We set this to Qmacro; since that's not a frame, nobody will
1362 try to switch frames on us, and the selected window will
1365 Since this event came from a macro, it would be misleading to
1366 leave internal_last_event_frame set to wherever the last
1367 real event came from. Normally, a switch-frame event selects
1368 internal_last_event_frame after each command is read, but
1369 events read from a macro should never cause a new frame to be
1371 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1374 /* Exit the macro if we are at the end.
1375 Also, some things replace the macro with t
1376 to force an early exit. */
1377 if (EQ (Vexecuting_macro
, Qt
)
1378 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1380 XSET (c
, Lisp_Int
, -1);
1384 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1385 if (XTYPE (Vexecuting_macro
) == Lisp_String
1386 && (XINT (c
) & 0x80))
1387 XFASTINT (c
) = CHAR_META
| (XINT (c
) & ~0x80);
1389 executing_macro_index
++;
1394 if (!NILP (unread_switch_frame
))
1396 c
= unread_switch_frame
;
1397 unread_switch_frame
= Qnil
;
1399 /* This event should make it into this_command_keys, and get echoed
1400 again, so we go to reread_first, rather than reread. */
1404 /* Save outer setjmp data, in case called recursively. */
1405 save_getcjmp (save_jump
);
1409 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1412 if (_setjmp (getcjmp
))
1414 XSET (c
, Lisp_Int
, quit_char
);
1416 XSET (internal_last_event_frame
, Lisp_Frame
, selected_frame
);
1417 Vlast_event_frame
= internal_last_event_frame
;
1419 /* If we report the quit char as an event,
1420 don't do so more than once. */
1421 if (!NILP (Vinhibit_quit
))
1427 /* Message turns off echoing unless more keystrokes turn it on again. */
1428 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1431 /* If already echoing, continue. */
1434 /* If in middle of key sequence and minibuffer not active,
1435 start echoing if enough time elapses. */
1436 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1437 && echo_keystrokes
> 0
1438 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1442 /* After a mouse event, start echoing right away.
1443 This is because we are probably about to display a menu,
1444 and we don't want to delay before doing so. */
1445 if (EVENT_HAS_PARAMETERS (prev_event
))
1449 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1455 /* Maybe auto save due to number of keystrokes or idle time. */
1457 if (commandflag
!= 0
1458 && auto_save_interval
> 0
1459 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1460 && !detect_input_pending ())
1463 save_getcjmp (temp
);
1464 Fdo_auto_save (Qnil
, Qnil
);
1465 restore_getcjmp (temp
);
1468 /* Try reading a character via menu prompting.
1469 Try this before the sit-for, because the sit-for
1470 would do the wrong thing if we are supposed to do
1473 if (INTERACTIVE
&& !NILP (prev_event
))
1474 c
= read_char_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1476 /* Slow down auto saves logarithmically in size of current buffer,
1477 and garbage collect while we're at it. */
1478 if (INTERACTIVE
&& NILP (c
))
1480 int delay_level
, buffer_size
;
1482 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1483 last_non_minibuf_size
= Z
- BEG
;
1484 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1486 while (buffer_size
> 64)
1487 delay_level
++, buffer_size
-= buffer_size
>> 2;
1488 if (delay_level
< 4) delay_level
= 4;
1489 /* delay_level is 4 for files under around 50k, 7 at 100k,
1490 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1492 /* Auto save if enough time goes by without input. */
1493 if (commandflag
!= 0
1494 && num_nonmacro_input_chars
> last_auto_save
1495 && XTYPE (Vauto_save_timeout
) == Lisp_Int
1496 && XINT (Vauto_save_timeout
) > 0)
1499 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1500 tem0
= sit_for (delay
, 0, 1, 1);
1504 save_getcjmp (temp
);
1505 Fdo_auto_save (Qnil
, Qnil
);
1506 restore_getcjmp (temp
);
1508 /* If we have auto-saved and there is still no input
1509 available, garbage collect if there has been enough
1510 consing going on to make it worthwhile. */
1511 if (!detect_input_pending ()
1512 && consing_since_gc
> gc_cons_threshold
/ 2)
1514 Fgarbage_collect ();
1521 /* Actually read a character, waiting if necessary. */
1524 c
= kbd_buffer_get_event ();
1527 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1531 /* Terminate Emacs in batch mode if at eof. */
1532 if (noninteractive
&& XTYPE (c
) == Lisp_Int
&& XINT (c
) < 0)
1533 Fkill_emacs (make_number (1));
1535 if (XTYPE (c
) == Lisp_Int
)
1537 /* Add in any extra modifiers, where appropriate. */
1538 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1539 || ((extra_keyboard_modifiers
& 0177) < ' '
1540 && (extra_keyboard_modifiers
& 0177) != 0))
1541 XSETINT (c
, make_ctrl_char (XINT (c
)));
1543 /* Transfer any other modifier bits directly from
1544 extra_keyboard_modifiers to c. Ignore the actual character code
1545 in the low 16 bits of extra_keyboard_modifiers. */
1546 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
1551 restore_getcjmp (save_jump
);
1555 echo_area_glyphs
= 0;
1557 /* Handle things that only apply to characters. */
1558 if (XTYPE (c
) == Lisp_Int
)
1560 /* If kbd_buffer_get_event gave us an EOF, return that. */
1564 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
1565 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1566 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1570 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1571 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1572 recent_keys_index
= 0;
1574 /* Write c to the dribble file. If c is a lispy event, write
1575 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1576 If you, dear reader, have a better idea, you've got the source. :-) */
1579 if (XTYPE (c
) == Lisp_Int
)
1580 putc (XINT (c
), dribble
);
1583 Lisp_Object dribblee
= c
;
1585 /* If it's a structured event, take the event header. */
1586 dribblee
= EVENT_HEAD (dribblee
);
1588 if (XTYPE (dribblee
) == Lisp_Symbol
)
1590 putc ('<', dribble
);
1591 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1592 XSYMBOL (dribblee
)->name
->size
,
1594 putc ('>', dribble
);
1601 store_kbd_macro_char (c
);
1603 num_nonmacro_input_chars
++;
1608 /* Record this character as part of the current key.
1609 Don't record mouse motion; it should never matter. */
1610 if (! (EVENT_HAS_PARAMETERS (c
)
1611 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1614 add_command_key (c
);
1617 /* Re-reading in the middle of a command */
1619 last_input_char
= c
;
1622 /* Process the help character specially if enabled */
1623 if (EQ (c
, Vhelp_char
) && !NILP (Vhelp_form
))
1626 count
= specpdl_ptr
- specpdl
;
1628 record_unwind_protect (Fset_window_configuration
,
1629 Fcurrent_window_configuration (Qnil
));
1631 tem0
= Feval (Vhelp_form
);
1632 if (XTYPE (tem0
) == Lisp_String
)
1633 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1636 c
= read_char (0, 0, 0, Qnil
, 0);
1637 /* Remove the help from the frame */
1638 unbind_to (count
, Qnil
);
1640 if (EQ (c
, make_number (040)))
1643 c
= read_char (0, 0, 0, Qnil
, 0);
1654 Fprinc (object
, Qnil
);
1658 /* Copy out or in the info on where C-g should throw to.
1659 This is used when running Lisp code from within get_char,
1660 in case get_char is called recursively.
1661 See read_process_output. */
1666 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1669 restore_getcjmp (temp
)
1672 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1676 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1677 of this function. */
1679 tracking_off (old_value
)
1680 Lisp_Object old_value
;
1682 if (! XFASTINT (old_value
))
1684 do_mouse_tracking
= 0;
1686 /* Redisplay may have been preempted because there was input
1687 available, and it assumes it will be called again after the
1688 input has been processed. If the only input available was
1689 the sort that we have just disabled, then we need to call
1691 if (!readable_events ())
1693 redisplay_preserve_echo_area ();
1694 get_input_pending (&input_pending
);
1699 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1700 "Evaluate BODY with mouse movement events enabled.\n\
1701 Within a `track-mouse' form, mouse motion generates input events that\n\
1702 you can read with `read-event'.\n\
1703 Normally, mouse motion is ignored.")
1707 int count
= specpdl_ptr
- specpdl
;
1710 XSET (val
, Lisp_Int
, do_mouse_tracking
);
1711 record_unwind_protect (tracking_off
, val
);
1713 do_mouse_tracking
= 1;
1715 val
= Fprogn (args
);
1716 return unbind_to (count
, val
);
1719 /* Low level keyboard/mouse input.
1720 kbd_buffer_store_event places events in kbd_buffer, and
1721 kbd_buffer_get_event retrieves them.
1722 mouse_moved indicates when the mouse has moved again, and
1723 *mouse_position_hook provides the mouse position. */
1725 /* Return true iff there are any events in the queue that read-char
1726 would return. If this returns false, a read-char would block. */
1730 return ! EVENT_QUEUES_EMPTY
;
1733 /* Set this for debugging, to have a way to get out */
1736 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
1739 kbd_buffer_store_event (event
)
1740 register struct input_event
*event
;
1742 if (event
->kind
== no_event
)
1745 if (event
->kind
== ascii_keystroke
)
1747 register int c
= XFASTINT (event
->code
) & 0377;
1749 if (event
->modifiers
& ctrl_modifier
)
1750 c
= make_ctrl_char (c
);
1752 c
|= (event
->modifiers
1753 & (meta_modifier
| alt_modifier
1754 | hyper_modifier
| super_modifier
));
1758 extern SIGTYPE
interrupt_signal ();
1761 /* If this results in a quit_char being returned to Emacs as
1762 input, set Vlast_event_frame properly. If this doesn't
1763 get returned to Emacs as an event, the next event read
1764 will set Vlast_event_frame again, so this is safe to do. */
1767 FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
1770 internal_last_event_frame
= event
->frame_or_window
;
1772 internal_last_event_frame
= focus
;
1773 Vlast_event_frame
= internal_last_event_frame
;
1777 last_event_timestamp
= event
->timestamp
;
1778 interrupt_signal ();
1782 if (c
&& c
== stop_character
)
1789 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
1790 kbd_store_ptr
= kbd_buffer
;
1792 /* Don't let the very last slot in the buffer become full,
1793 since that would make the two pointers equal,
1794 and that is indistinguishable from an empty buffer.
1795 Discard the event if it would fill the last slot. */
1796 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
1798 kbd_store_ptr
->kind
= event
->kind
;
1799 kbd_store_ptr
->code
= event
->code
;
1800 kbd_store_ptr
->part
= event
->part
;
1801 kbd_store_ptr
->frame_or_window
= event
->frame_or_window
;
1802 kbd_store_ptr
->modifiers
= event
->modifiers
;
1803 kbd_store_ptr
->x
= event
->x
;
1804 kbd_store_ptr
->y
= event
->y
;
1805 kbd_store_ptr
->timestamp
= event
->timestamp
;
1806 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
1808 = event
->frame_or_window
);
1814 /* Read one event from the event buffer, waiting if necessary.
1815 The value is a Lisp object representing the event.
1816 The value is nil for an event that should be ignored,
1817 or that was handled here.
1818 We always read and discard one event. */
1821 kbd_buffer_get_event ()
1829 XSET (obj
, Lisp_Int
, c
);
1833 /* Wait until there is input available. */
1836 if (!EVENT_QUEUES_EMPTY
)
1839 /* If the quit flag is set, then read_char will return
1840 quit_char, so that counts as "available input." */
1841 if (!NILP (Vquit_flag
))
1842 quit_throw_to_read_char ();
1844 /* One way or another, wait until input is available; then, if
1845 interrupt handlers have not read it, read it now. */
1848 wait_for_kbd_input ();
1850 /* Note SIGIO has been undef'd if FIONREAD is missing. */
1854 if (EVENT_QUEUES_EMPTY
)
1856 Lisp_Object minus_one
;
1858 XSET (minus_one
, Lisp_Int
, -1);
1859 wait_reading_process_input (0, 0, minus_one
, 1);
1861 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
1863 read_avail_input (0);
1866 #endif /* not VMS */
1869 /* At this point, we know that there is a readable event available
1870 somewhere. If the event queue is empty, then there must be a
1871 mouse movement enabled and available. */
1872 if (kbd_fetch_ptr
!= kbd_store_ptr
)
1874 struct input_event
*event
;
1876 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
1880 last_event_timestamp
= event
->timestamp
;
1884 /* These two kinds of events get special handling
1885 and don't actually appear to the command loop.
1886 We return nil for them. */
1887 if (event
->kind
== selection_request_event
)
1890 x_handle_selection_request (event
);
1891 kbd_fetch_ptr
= event
+ 1;
1893 /* We're getting selection request events, but we don't have
1899 else if (event
->kind
== selection_clear_event
)
1902 x_handle_selection_clear (event
);
1903 kbd_fetch_ptr
= event
+ 1;
1905 /* We're getting selection request events, but we don't have
1910 /* Just discard these, by returning nil.
1911 (They shouldn't be found in the buffer,
1912 but on some machines it appears they do show up.) */
1913 else if (event
->kind
== no_event
)
1914 kbd_fetch_ptr
= event
+ 1;
1916 /* If this event is on a different frame, return a switch-frame this
1917 time, and leave the event in the queue for next time. */
1921 Lisp_Object frame
= event
->frame_or_window
;
1924 if (XTYPE (frame
) == Lisp_Window
)
1925 frame
= WINDOW_FRAME (XWINDOW (frame
));
1927 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
1931 if (! EQ (frame
, internal_last_event_frame
)
1932 && XFRAME (frame
) != selected_frame
)
1933 obj
= make_lispy_switch_frame (frame
);
1934 internal_last_event_frame
= frame
;
1935 #endif /* MULTI_FRAME */
1937 /* If we didn't decide to make a switch-frame event, go ahead
1938 and build a real event from the queue entry. */
1942 obj
= make_lispy_event (event
);
1944 /* Wipe out this event, to catch bugs. */
1945 event
->kind
= no_event
;
1946 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
1949 kbd_fetch_ptr
= event
+ 1;
1953 /* Try generating a mouse motion event. */
1954 else if (do_mouse_tracking
&& mouse_moved
)
1957 Lisp_Object bar_window
;
1958 enum scroll_bar_part part
;
1962 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
1967 /* Decide if we should generate a switch-frame event. Don't
1968 generate switch-frame events for motion outside of all Emacs
1972 Lisp_Object frame
= FRAME_FOCUS_FRAME (f
);
1975 XSET (frame
, Lisp_Frame
, f
);
1977 if (! EQ (frame
, internal_last_event_frame
)
1978 && XFRAME (frame
) != selected_frame
)
1979 obj
= make_lispy_switch_frame (frame
);
1980 internal_last_event_frame
= frame
;
1984 /* If we didn't decide to make a switch-frame event, go ahead and
1985 return a mouse-motion event. */
1987 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
1990 /* We were promised by the above while loop that there was
1991 something for us to read! */
1994 input_pending
= readable_events ();
1997 Vlast_event_frame
= internal_last_event_frame
;
2003 /* Process any events that are not user-visible,
2004 then return, without reading any user-visible events. */
2009 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2011 struct input_event
*event
;
2013 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2017 last_event_timestamp
= event
->timestamp
;
2019 /* These two kinds of events get special handling
2020 and don't actually appear to the command loop. */
2021 if (event
->kind
== selection_request_event
)
2024 x_handle_selection_request (event
);
2025 kbd_fetch_ptr
= event
+ 1;
2027 /* We're getting selection request events, but we don't have
2033 else if (event
->kind
== selection_clear_event
)
2036 x_handle_selection_clear (event
);
2037 kbd_fetch_ptr
= event
+ 1;
2039 /* We're getting selection request events, but we don't have
2048 get_input_pending (&input_pending
);
2051 /* Caches for modify_event_symbol. */
2052 static Lisp_Object func_key_syms
;
2053 static Lisp_Object mouse_syms
;
2055 /* You'll notice that this table is arranged to be conveniently
2056 indexed by X Windows keysym values. */
2057 static char *lispy_function_keys
[] =
2059 /* X Keysym value */
2061 "remove", 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2069 0, 0, 0, /* 0xff10 */
2071 0, 0, 0, 0, 0, 0, 0,
2074 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2075 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2076 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2078 "home", /* 0xff50 */ /* IsCursorKey */
2089 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2100 "break", /* 0xff6b */
2102 /* Here are some keys found mostly on HP keyboards. The X event
2103 handling code will strip bit 29, which flags vendor-specific
2105 "reset", /* 0x1000ff6c */
2114 "kp-backtab", /* 0x1000ff75 */
2116 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2117 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2118 0, 0, 0, 0, 0, 0, 0, 0,
2119 "kp-tab", /* 0xff89 */
2121 "kp-enter", /* 0xff8d */
2123 "kp-f1", /* 0xff91 */
2128 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2129 "kp-multiply", /* 0xffaa */
2134 "kp-divide", /* 0xffaf */
2135 "kp-0", /* 0xffb0 */
2136 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2139 "kp-equal", /* 0xffbd */
2140 "f1", /* 0xffbe */ /* IsFunctionKey */
2142 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2143 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2144 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2145 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2146 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2147 0, 0, 0, 0, 0, 0, 0, 0,
2148 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2149 0, 0, 0, 0, 0, 0, 0, "delete"
2152 static char *lispy_mouse_names
[] =
2154 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2157 /* Scroll bar parts. */
2158 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2160 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2161 Lisp_Object
*scroll_bar_parts
[] = {
2162 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2166 /* A vector, indexed by button number, giving the down-going location
2167 of currently depressed buttons, both scroll bar and non-scroll bar.
2169 The elements have the form
2170 (BUTTON-NUMBER MODIFIER-MASK . REST)
2171 where REST is the cdr of a position as it would be reported in the event.
2173 The make_lispy_event function stores positions here to tell the
2174 difference between click and drag events, and to store the starting
2175 location to be included in drag events. */
2177 static Lisp_Object button_down_location
;
2179 /* Information about the most recent up-going button event: Which
2180 button, what location, and what time. */
2182 static int button_up_button
;
2183 static int button_up_x
;
2184 static int button_up_y
;
2185 static unsigned long button_up_time
;
2187 /* The maximum time between clicks to make a double-click,
2188 or Qnil to disable double-click detection,
2189 or Qt for no time limit. */
2190 Lisp_Object Vdouble_click_time
;
2192 /* The number of clicks in this multiple-click. */
2194 int double_click_count
;
2196 /* Given a struct input_event, build the lisp event which represents
2197 it. If EVENT is 0, build a mouse movement event from the mouse
2198 movement buffer, which should have a movement event in it.
2200 Note that events must be passed to this function in the order they
2201 are received; this function stores the location of button presses
2202 in order to build drag events when the button is released. */
2205 make_lispy_event (event
)
2206 struct input_event
*event
;
2208 #ifdef SWITCH_ENUM_BUG
2209 switch ((int) event
->kind
)
2211 switch (event
->kind
)
2214 /* A simple keystroke. */
2215 case ascii_keystroke
:
2217 int c
= XFASTINT (event
->code
);
2218 /* Turn ASCII characters into control characters
2220 if (event
->modifiers
& ctrl_modifier
)
2221 c
= make_ctrl_char (c
);
2223 /* Add in the other modifier bits. We took care of ctrl_modifier
2224 just above, and the shift key was taken care of by the X code,
2225 and applied to control characters by make_ctrl_char. */
2226 c
|= (event
->modifiers
2227 & (meta_modifier
| alt_modifier
2228 | hyper_modifier
| super_modifier
));
2233 /* A function key. The symbol may need to have modifier prefixes
2235 case non_ascii_keystroke
:
2237 return modify_event_symbol (XFASTINT (event
->code
), event
->modifiers
,
2239 lispy_function_keys
, &func_key_syms
,
2240 (sizeof (lispy_function_keys
)
2241 / sizeof (lispy_function_keys
[0])));
2244 /* A mouse click. Figure out where it is, decide whether it's
2245 a press, click or drag, and build the appropriate structure. */
2247 case scroll_bar_click
:
2249 int button
= XFASTINT (event
->code
);
2250 Lisp_Object position
;
2251 Lisp_Object
*start_pos_ptr
;
2252 Lisp_Object start_pos
;
2254 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2257 /* Build the position as appropriate for this mouse click. */
2258 if (event
->kind
== mouse_click
)
2261 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2263 = window_from_coordinates (f
, XINT (event
->x
), XINT (event
->y
),
2267 if (XINT (event
->y
) < FRAME_MENU_BAR_LINES (f
))
2271 items
= FRAME_MENU_BAR_ITEMS (f
);
2272 for (; CONSP (items
); items
= XCONS (items
)->cdr
)
2274 Lisp_Object pos
, string
;
2275 pos
= Fcdr (Fcdr (Fcar (items
)));
2276 string
= Fcar (Fcdr (Fcar (items
)));
2277 if (XINT (event
->x
) >= XINT (pos
)
2278 && XINT (event
->x
) < XINT (pos
) + XSTRING (string
)->size
)
2282 = Fcons (event
->frame_or_window
,
2284 Fcons (Fcons (event
->x
, event
->y
),
2285 Fcons (make_number (event
->timestamp
),
2289 return Fcons (Fcar (Fcar (items
)),
2290 Fcons (position
, Qnil
));
2292 return Fcons (Qnil
, Fcons (position
, Qnil
));
2294 else if (XTYPE (window
) != Lisp_Window
)
2299 (XINT (event
->x
) - XINT (XWINDOW (window
)->left
)));
2301 (XINT (event
->y
) - XINT (XWINDOW (window
)->top
)));
2306 posn
= Qvertical_line
;
2308 XSET (posn
, Lisp_Int
,
2309 buffer_posn_from_coords (XWINDOW (window
),
2317 Fcons (Fcons (event
->x
, event
->y
),
2318 Fcons (make_number (event
->timestamp
),
2323 Lisp_Object window
= event
->frame_or_window
;
2324 Lisp_Object portion_whole
= Fcons (event
->x
, event
->y
);
2325 Lisp_Object part
= *scroll_bar_parts
[(int) event
->part
];
2329 Fcons (Qvertical_scroll_bar
,
2330 Fcons (portion_whole
,
2331 Fcons (make_number (event
->timestamp
),
2336 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2338 start_pos
= *start_pos_ptr
;
2339 *start_pos_ptr
= Qnil
;
2341 /* If this is a button press, squirrel away the location, so
2342 we can decide later whether it was a click or a drag. */
2343 if (event
->modifiers
& down_modifier
)
2344 *start_pos_ptr
= Fcopy_alist (position
);
2346 /* Now we're releasing a button - check the co-ordinates to
2347 see if this was a click or a drag. */
2348 else if (event
->modifiers
& up_modifier
)
2350 /* If we did not see a down before this up,
2351 ignore the up. Probably this happened because
2352 the down event chose a menu item.
2353 It would be an annoyance to treat the release
2354 of the button that chose the menu item
2355 as a separate event. */
2357 if (XTYPE (start_pos
) != Lisp_Cons
)
2360 event
->modifiers
&= ~up_modifier
;
2361 #if 0 /* Formerly we treated an up with no down as a click event. */
2362 if (XTYPE (start_pos
) != Lisp_Cons
)
2363 event
->modifiers
|= click_modifier
;
2367 /* The third element of every position should be the (x,y)
2369 Lisp_Object down
= Fnth (make_number (2), start_pos
);
2371 if (EQ (event
->x
, XCONS (down
)->car
)
2372 && EQ (event
->y
, XCONS (down
)->cdr
))
2374 if (button
== button_up_button
2375 && XINT (event
->x
) == button_up_x
2376 && XINT (event
->y
) == button_up_y
2377 && button_up_time
!= 0
2378 && (EQ (Vdouble_click_time
, Qt
)
2379 || (INTEGERP (Vdouble_click_time
)
2380 && ((int)(event
->timestamp
- button_up_time
)
2381 < XINT (Vdouble_click_time
)))))
2383 double_click_count
++;
2384 event
->modifiers
|= ((double_click_count
> 2)
2390 double_click_count
= 1;
2391 event
->modifiers
|= click_modifier
;
2393 button_up_button
= button
;
2394 button_up_x
= XINT (event
->x
);
2395 button_up_y
= XINT (event
->y
);
2396 button_up_time
= event
->timestamp
;
2401 event
->modifiers
|= drag_modifier
;
2406 /* Every mouse event should either have the down_modifier or
2407 the up_modifier set. */
2411 /* Get the symbol we should use for the mouse click. */
2413 = modify_event_symbol (button
,
2416 lispy_mouse_names
, &mouse_syms
,
2417 (sizeof (lispy_mouse_names
)
2418 / sizeof (lispy_mouse_names
[0])));
2420 if (event
->modifiers
& drag_modifier
)
2425 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2428 Fcons (make_number (double_click_count
),
2437 /* The 'kind' field of the event is something we don't recognize. */
2444 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2446 Lisp_Object bar_window
;
2447 enum scroll_bar_part part
;
2451 /* Is it a scroll bar movement? */
2452 if (frame
&& ! NILP (bar_window
))
2454 Lisp_Object part_sym
= *scroll_bar_parts
[(int) part
];
2456 return Fcons (Qscroll_bar_movement
,
2457 (Fcons (Fcons (bar_window
,
2458 Fcons (Qvertical_scroll_bar
,
2459 Fcons (Fcons (x
, y
),
2460 Fcons (make_number (time
),
2466 /* Or is it an ordinary mouse movement? */
2470 Lisp_Object window
=
2472 ? window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
)
2476 if (XTYPE (window
) == Lisp_Window
)
2478 XSETINT (x
, XINT (x
) - XINT (XWINDOW (window
)->left
));
2479 XSETINT (y
, XINT (y
) - XINT (XWINDOW (window
)->top
));
2484 posn
= Qvertical_line
;
2486 XSET (posn
, Lisp_Int
,
2487 buffer_posn_from_coords (XWINDOW (window
),
2488 XINT (x
), XINT (y
)));
2498 return Fcons (Qmouse_movement
,
2499 Fcons (Fcons (window
,
2501 Fcons (Fcons (x
, y
),
2502 Fcons (make_number (time
),
2508 /* Construct a switch frame event. */
2510 make_lispy_switch_frame (frame
)
2513 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
2516 /* Manipulating modifiers. */
2518 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
2520 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2521 SYMBOL's name of the end of the modifiers; the string from this
2522 position is the unmodified symbol name.
2524 This doesn't use any caches. */
2526 parse_modifiers_uncached (symbol
, modifier_end
)
2530 struct Lisp_String
*name
;
2534 CHECK_SYMBOL (symbol
, 1);
2537 name
= XSYMBOL (symbol
)->name
;
2540 for (i
= 0; i
+2 <= name
->size
; )
2541 switch (name
->data
[i
])
2543 #define SINGLE_LETTER_MOD(bit) \
2544 if (name->data[i+1] != '-') \
2545 goto no_more_modifiers; \
2550 SINGLE_LETTER_MOD (alt_modifier
);
2554 SINGLE_LETTER_MOD (ctrl_modifier
);
2558 SINGLE_LETTER_MOD (hyper_modifier
);
2562 SINGLE_LETTER_MOD (meta_modifier
);
2566 SINGLE_LETTER_MOD (shift_modifier
);
2570 SINGLE_LETTER_MOD (super_modifier
);
2574 if (i
+ 5 > name
->size
)
2575 goto no_more_modifiers
;
2576 if (! strncmp (name
->data
+ i
, "drag-", 5))
2578 modifiers
|= drag_modifier
;
2581 else if (! strncmp (name
->data
+ i
, "down-", 5))
2583 modifiers
|= down_modifier
;
2586 else if (i
+ 7 <= name
->size
2587 && ! strncmp (name
->data
+ i
, "double-", 7))
2589 modifiers
|= double_modifier
;
2593 goto no_more_modifiers
;
2597 if (i
+ 7 > name
->size
)
2598 goto no_more_modifiers
;
2599 if (! strncmp (name
->data
+ i
, "triple-", 7))
2601 modifiers
|= triple_modifier
;
2605 goto no_more_modifiers
;
2609 goto no_more_modifiers
;
2611 #undef SINGLE_LETTER_MOD
2615 /* Should we include the `click' modifier? */
2616 if (! (modifiers
& (down_modifier
| drag_modifier
2617 | double_modifier
| triple_modifier
))
2618 && i
+ 7 == name
->size
2619 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
2620 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
2621 modifiers
|= click_modifier
;
2630 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
2631 prepended to the string BASE[0..BASE_LEN-1].
2632 This doesn't use any caches. */
2634 apply_modifiers_uncached (modifiers
, base
, base_len
)
2639 /* Since BASE could contain nulls, we can't use intern here; we have
2640 to use Fintern, which expects a genuine Lisp_String, and keeps a
2643 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
2649 /* Only the event queue may use the `up' modifier; it should always
2650 be turned into a click or drag event before presented to lisp code. */
2651 if (modifiers
& up_modifier
)
2654 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
2655 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
2656 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
2657 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
2658 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
2659 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
2660 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
2661 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
2662 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
2663 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
2664 /* The click modifier is denoted by the absence of other modifiers. */
2668 mod_len
= p
- new_mods
;
2672 Lisp_Object new_name
= make_uninit_string (mod_len
+ base_len
);
2674 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
2675 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
2677 return Fintern (new_name
, Qnil
);
2682 static char *modifier_names
[] =
2684 "up", "down", "drag", "click", "double", "triple", 0, 0,
2685 0, 0, 0, 0, 0, 0, 0, 0,
2686 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
2688 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
2690 static Lisp_Object modifier_symbols
;
2692 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
2694 lispy_modifier_list (modifiers
)
2697 Lisp_Object modifier_list
;
2700 modifier_list
= Qnil
;
2701 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
2702 if (modifiers
& (1<<i
))
2703 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
2706 return modifier_list
;
2710 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
2711 where UNMODIFIED is the unmodified form of SYMBOL,
2712 MASK is the set of modifiers present in SYMBOL's name.
2713 This is similar to parse_modifiers_uncached, but uses the cache in
2714 SYMBOL's Qevent_symbol_element_mask property, and maintains the
2715 Qevent_symbol_elements property. */
2717 parse_modifiers (symbol
)
2720 Lisp_Object elements
= Fget (symbol
, Qevent_symbol_element_mask
);
2722 if (CONSP (elements
))
2727 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
2728 Lisp_Object unmodified
2729 = Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
2730 XSYMBOL (symbol
)->name
->size
- end
),
2734 if (modifiers
& ~((1<<VALBITS
) - 1))
2736 XFASTINT (mask
) = modifiers
;
2737 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
2739 /* Cache the parsing results on SYMBOL. */
2740 Fput (symbol
, Qevent_symbol_element_mask
,
2742 Fput (symbol
, Qevent_symbol_elements
,
2743 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
2745 /* Since we know that SYMBOL is modifiers applied to unmodified,
2746 it would be nice to put that in unmodified's cache.
2747 But we can't, since we're not sure that parse_modifiers is
2754 /* Apply the modifiers MODIFIERS to the symbol BASE.
2755 BASE must be unmodified.
2757 This is like apply_modifiers_uncached, but uses BASE's
2758 Qmodifier_cache property, if present. It also builds
2759 Qevent_symbol_elements properties, since it has that info anyway.
2761 apply_modifiers copies the value of BASE's Qevent_kind property to
2762 the modified symbol. */
2764 apply_modifiers (modifiers
, base
)
2768 Lisp_Object cache
, index
, entry
, new_symbol
;
2770 /* Mask out upper bits. We don't know where this value's been. */
2771 modifiers
&= (1<<VALBITS
) - 1;
2773 /* The click modifier never figures into cache indices. */
2774 cache
= Fget (base
, Qmodifier_cache
);
2775 XFASTINT (index
) = (modifiers
& ~click_modifier
);
2776 entry
= Fassq (index
, cache
);
2779 new_symbol
= XCONS (entry
)->cdr
;
2782 /* We have to create the symbol ourselves. */
2783 new_symbol
= apply_modifiers_uncached (modifiers
,
2784 XSYMBOL (base
)->name
->data
,
2785 XSYMBOL (base
)->name
->size
);
2787 /* Add the new symbol to the base's cache. */
2788 entry
= Fcons (index
, new_symbol
);
2789 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
2791 /* We have the parsing info now for free, so add it to the caches. */
2792 XFASTINT (index
) = modifiers
;
2793 Fput (new_symbol
, Qevent_symbol_element_mask
,
2794 Fcons (base
, Fcons (index
, Qnil
)));
2795 Fput (new_symbol
, Qevent_symbol_elements
,
2796 Fcons (base
, lispy_modifier_list (modifiers
)));
2799 /* Make sure this symbol is of the same kind as BASE.
2801 You'd think we could just set this once and for all when we
2802 intern the symbol above, but reorder_modifiers may call us when
2803 BASE's property isn't set right; we can't assume that just
2804 because it has a Qmodifier_cache property it must have its
2805 Qevent_kind set right as well. */
2806 if (NILP (Fget (new_symbol
, Qevent_kind
)))
2808 Lisp_Object kind
= Fget (base
, Qevent_kind
);
2811 Fput (new_symbol
, Qevent_kind
, kind
);
2818 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
2819 return a symbol with the modifiers placed in the canonical order.
2820 Canonical order is alphabetical, except for down and drag, which
2821 always come last. The 'click' modifier is never written out.
2823 Fdefine_key calls this to make sure that (for example) C-M-foo
2824 and M-C-foo end up being equivalent in the keymap. */
2827 reorder_modifiers (symbol
)
2830 /* It's hopefully okay to write the code this way, since everything
2831 will soon be in caches, and no consing will be done at all. */
2832 Lisp_Object parsed
= parse_modifiers (symbol
);
2834 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
2835 XCONS (parsed
)->car
);
2839 /* For handling events, we often want to produce a symbol whose name
2840 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
2841 to some base, like the name of a function key or mouse button.
2842 modify_event_symbol produces symbols of this sort.
2844 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
2845 is the name of the i'th symbol. TABLE_SIZE is the number of elements
2848 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
2849 persist between calls to modify_event_symbol that it can use to
2850 store a cache of the symbols it's generated for this NAME_TABLE
2853 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
2855 MODIFIERS is a set of modifier bits (as given in struct input_events)
2856 whose prefixes should be applied to the symbol name.
2858 SYMBOL_KIND is the value to be placed in the event_kind property of
2859 the returned symbol.
2861 The symbols we create are supposed to have an
2862 `event-symbol-elements' property, which lists the modifiers present
2863 in the symbol's name. */
2866 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_table
,
2867 symbol_table
, table_size
)
2870 Lisp_Object symbol_kind
;
2872 Lisp_Object
*symbol_table
;
2877 /* Is this a request for a valid symbol? */
2878 if (symbol_num
< 0 || symbol_num
>= table_size
)
2881 /* If *symbol_table doesn't seem to be initialized properly, fix that.
2882 *symbol_table should be a lisp vector TABLE_SIZE elements long,
2883 where the Nth element is the symbol for NAME_TABLE[N], or nil if
2884 we've never used that symbol before. */
2885 if (XTYPE (*symbol_table
) != Lisp_Vector
2886 || XVECTOR (*symbol_table
)->size
!= table_size
)
2890 XFASTINT (size
) = table_size
;
2891 *symbol_table
= Fmake_vector (size
, Qnil
);
2894 slot
= & XVECTOR (*symbol_table
)->contents
[symbol_num
];
2896 /* Have we already used this symbol before? */
2899 /* No; let's create it. */
2900 if (name_table
[symbol_num
])
2901 *slot
= intern (name_table
[symbol_num
]);
2905 sprintf (buf
, "key-%d", symbol_num
);
2906 *slot
= intern (buf
);
2909 /* Fill in the cache entries for this symbol; this also
2910 builds the Qevent_symbol_elements property, which the user
2912 apply_modifiers (modifiers
& click_modifier
, *slot
);
2913 Fput (*slot
, Qevent_kind
, symbol_kind
);
2916 /* Apply modifiers to that symbol. */
2917 return apply_modifiers (modifiers
, *slot
);
2921 /* Store into *addr a value nonzero if terminal input chars are available.
2922 Serves the purpose of ioctl (0, FIONREAD, addr)
2923 but works even if FIONREAD does not exist.
2924 (In fact, this may actually read some input.) */
2927 get_input_pending (addr
)
2930 /* First of all, have we already counted some input? */
2931 *addr
= !NILP (Vquit_flag
) || readable_events ();
2933 /* If input is being read as it arrives, and we have none, there is none. */
2934 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
2937 /* Try to read some input and see how much we get. */
2939 *addr
= !NILP (Vquit_flag
) || readable_events ();
2942 /* Interface to read_avail_input, blocking SIGIO if necessary. */
2945 gobble_input (expected
)
2950 if (interrupt_input
)
2953 mask
= sigblockx (SIGIO
);
2954 read_avail_input (expected
);
2959 read_avail_input (expected
);
2965 /* Read any terminal input already buffered up by the system
2966 into the kbd_buffer, but do not wait.
2968 EXPECTED should be nonzero if the caller knows there is some input.
2970 Except on VMS, all input is read by this function.
2971 If interrupt_input is nonzero, this function MUST be called
2972 only when SIGIO is blocked.
2974 Returns the number of keyboard chars read, or -1 meaning
2975 this is a bad time to try to read input. */
2978 read_avail_input (expected
)
2981 struct input_event buf
[KBD_BUFFER_SIZE
];
2985 if (read_socket_hook
)
2986 /* No need for FIONREAD or fcntl; just say don't wait. */
2987 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
2990 unsigned char cbuf
[KBD_BUFFER_SIZE
];
2993 /* Find out how much input is available. */
2994 if (ioctl (0, FIONREAD
, &nread
) < 0)
2995 /* Formerly simply reported no input, but that sometimes led to
2996 a failure of Emacs to terminate.
2997 SIGHUP seems appropriate if we can't reach the terminal. */
2998 /* ??? Is it really right to send the signal just to this process
2999 rather than to the whole process group?
3000 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3001 kill (getpid (), SIGHUP
);
3004 if (nread
> sizeof cbuf
)
3005 nread
= sizeof cbuf
;
3006 #else /* no FIONREAD */
3008 /* Read some input if available, but don't wait. */
3009 nread
= sizeof cbuf
;
3010 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
3016 /* Now read; for one reason or another, this will not block. */
3019 nread
= read (fileno (stdin
), cbuf
, nread
);
3021 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3022 This looks incorrect, but it isn't, because _BSD causes
3023 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3024 and that causes a value other than 0 when there is no input. */
3028 /* Retry the read if it is interrupted. */
3030 || ! (errno
== EAGAIN
|| errno
== EFAULT
3040 fcntl (fileno (stdin
), F_SETFL
, 0);
3042 #endif /* no FIONREAD */
3043 for (i
= 0; i
< nread
; i
++)
3045 buf
[i
].kind
= ascii_keystroke
;
3046 buf
[i
].modifiers
= 0;
3047 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3048 buf
[i
].modifiers
= meta_modifier
;
3052 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
3054 XSET (buf
[i
].frame_or_window
, Lisp_Frame
, selected_frame
);
3056 buf
[i
].frame_or_window
= Qnil
;
3061 /* Scan the chars for C-g and store them in kbd_buffer. */
3062 for (i
= 0; i
< nread
; i
++)
3064 kbd_buffer_store_event (&buf
[i
]);
3065 /* Don't look at input that follows a C-g too closely.
3066 This reduces lossage due to autorepeat on C-g. */
3067 if (buf
[i
].kind
== ascii_keystroke
3068 && XINT(buf
[i
].code
) == quit_char
)
3074 #endif /* not VMS */
3076 #ifdef SIGIO /* for entire page */
3077 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3080 input_available_signal (signo
)
3083 /* Must preserve main program's value of errno. */
3084 int old_errno
= errno
;
3086 extern int select_alarmed
;
3090 /* USG systems forget handlers when they are used;
3091 must reestablish each time */
3092 signal (signo
, input_available_signal
);
3099 if (input_available_clear_time
)
3100 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3105 nread
= read_avail_input (1);
3106 /* -1 means it's not ok to read the input now.
3107 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3108 0 means there was no keyboard input available. */
3113 select_alarmed
= 1; /* Force the select emulator back to life */
3124 /* Send ourselves a SIGIO.
3126 This function exists so that the UNBLOCK_INPUT macro in
3127 blockinput.h can have some way to take care of input we put off
3128 dealing with, without assuming that every file which uses
3129 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3131 reinvoke_input_signal ()
3140 /* Return the prompt-string of a sparse keymap.
3141 This is the first element which is a string.
3142 Return nil if there is none. */
3150 register Lisp_Object tem
;
3152 if (XTYPE (tem
) == Lisp_String
)
3159 static Lisp_Object
menu_bar_item ();
3160 static Lisp_Object
menu_bar_one_keymap ();
3162 /* Return a list of menu items for a menu bar, appropriate
3163 to the current buffer.
3164 The elements have the form (KEY STRING . nil). */
3169 /* The number of keymaps we're scanning right now, and the number of
3170 keymaps we have allocated space for. */
3173 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3174 in the current keymaps, or nil where it is not a prefix. */
3177 Lisp_Object def
, tem
, tail
;
3184 /* In order to build the menus, we need to call the keymap
3185 accessors. They all call QUIT. But this function is called
3186 during redisplay, during which a quit is fatal. So inhibit
3187 quitting while building the menus.
3188 We do this instead of specbind because (1) errors will clear it anyway
3189 and (2) this avoids risk of specpdl overflow. */
3190 oquit
= Vinhibit_quit
;
3193 /* Build our list of keymaps.
3194 If we recognize a function key and replace its escape sequence in
3195 keybuf with its symbol, or if the sequence starts with a mouse
3196 click and we need to switch buffers, we jump back here to rebuild
3197 the initial keymaps from the current buffer. */
3201 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3202 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3203 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3204 #ifdef USE_TEXT_PROPERTIES
3205 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3207 maps
[nmaps
-2] = current_buffer
->keymap
;
3209 maps
[nmaps
-1] = current_global_map
;
3212 /* Look up in each map the dummy prefix key `menu-bar'. */
3216 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3218 if (! NILP (maps
[mapno
]))
3219 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3223 tem
= Fkeymapp (def
);
3225 result
= menu_bar_one_keymap (def
, result
);
3228 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3232 elt
= Fassq (XCONS (tail
)->car
, result
);
3234 result
= Fcons (elt
, Fdelq (elt
, result
));
3237 result
= Fnreverse (result
);
3238 Vinhibit_quit
= oquit
;
3242 /* Scan one map KEYMAP, accumulating any menu items it defines
3243 that have not yet been seen in RESULT. Return the updated RESULT. */
3246 menu_bar_one_keymap (keymap
, result
)
3247 Lisp_Object keymap
, result
;
3249 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3251 /* Loop over all keymap entries that have menu strings. */
3252 for (tail
= keymap
; XTYPE (tail
) == Lisp_Cons
; tail
= XCONS (tail
)->cdr
)
3254 item
= XCONS (tail
)->car
;
3255 if (XTYPE (item
) == Lisp_Cons
)
3257 key
= XCONS (item
)->car
;
3258 binding
= XCONS (item
)->cdr
;
3259 if (XTYPE (binding
) == Lisp_Cons
)
3261 item_string
= XCONS (binding
)->car
;
3262 if (XTYPE (item_string
) == Lisp_String
)
3263 result
= menu_bar_item (key
, item_string
,
3264 Fcdr (binding
), result
);
3266 else if (EQ (binding
, Qundefined
))
3267 result
= menu_bar_item (key
, item_string
,
3270 else if (XTYPE (item
) == Lisp_Vector
)
3272 /* Loop over the char values represented in the vector. */
3273 int len
= XVECTOR (item
)->size
;
3275 for (c
= 0; c
< len
; c
++)
3277 Lisp_Object character
;
3278 XFASTINT (character
) = c
;
3279 binding
= XVECTOR (item
)->contents
[c
];
3280 if (XTYPE (binding
) == Lisp_Cons
)
3282 item_string
= XCONS (binding
)->car
;
3283 if (XTYPE (item_string
) == Lisp_String
)
3284 result
= menu_bar_item (key
, item_string
,
3285 Fcdr (binding
), result
);
3287 else if (EQ (binding
, Qundefined
))
3288 result
= menu_bar_item (key
, item_string
,
3298 menu_bar_item (key
, item_string
, def
, result
)
3299 Lisp_Object key
, item_string
, def
, result
;
3302 Lisp_Object enabled
;
3304 if (EQ (def
, Qundefined
))
3306 /* If a map has an explicit nil as definition,
3307 discard any previously made menu bar item. */
3308 tem
= Fassq (key
, result
);
3309 return Fdelq (tem
, result
);
3312 /* See if this entry is enabled. */
3315 if (XTYPE (def
) == Lisp_Symbol
)
3317 /* No property, or nil, means enable.
3318 Otherwise, enable if value is not nil. */
3319 tem
= Fget (def
, Qmenu_enable
);
3321 enabled
= Feval (tem
);
3324 /* Add an entry for this key and string
3325 if there is none yet. */
3326 tem
= Fassq (key
, result
);
3327 if (!NILP (enabled
) && NILP (tem
))
3328 result
= Fcons (Fcons (key
, Fcons (item_string
, Qnil
)), result
);
3333 static int echo_flag
;
3334 static int echo_now
;
3336 /* Read a character using menus based on maps in the array MAPS.
3337 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
3338 Return t if we displayed a menu but the user rejected it.
3340 PREV_EVENT is the previous input event, or nil if we are reading
3341 the first event of a key sequence.
3343 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3344 if we used a mouse menu to read the input, or zero otherwise. If
3345 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
3347 The prompting is done based on the prompt-string of the map
3348 and the strings associated with various map elements. */
3351 read_char_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
3354 Lisp_Object prev_event
;
3355 int *used_mouse_menu
;
3358 register Lisp_Object name
;
3360 int width
= FRAME_WIDTH (selected_frame
) - 4;
3361 char *menu
= (char *) alloca (width
+ 4);
3363 Lisp_Object rest
, vector
;
3365 if (used_mouse_menu
)
3366 *used_mouse_menu
= 0;
3368 /* Use local over global Menu maps */
3370 if (! menu_prompting
)
3373 /* Get the menu name from the first map that has one (a prompt string). */
3374 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3376 name
= map_prompt (maps
[mapno
]);
3381 /* If we don't have any menus, just read a character normally. */
3385 #ifdef HAVE_X_WINDOWS
3387 /* If we got to this point via a mouse click,
3388 use a real menu for mouse selection. */
3389 if (EVENT_HAS_PARAMETERS (prev_event
))
3391 /* Display the menu and get the selection. */
3392 Lisp_Object
*realmaps
3393 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
3397 /* Use the maps that are not nil. */
3398 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3399 if (!NILP (maps
[mapno
]))
3400 realmaps
[nmaps1
++] = maps
[mapno
];
3402 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
3405 /* If we got more than one event, put all but the first
3406 onto this list to be read later.
3407 Return just the first event now. */
3408 unread_command_events
3409 = nconc2 (XCONS (value
)->cdr
, unread_command_events
);
3410 value
= XCONS (value
)->car
;
3414 if (used_mouse_menu
)
3415 *used_mouse_menu
= 1;
3418 #endif /* HAVE_X_MENU */
3419 #endif /* HAVE_X_WINDOWS */
3421 /* Prompt string always starts with map's prompt, and a space. */
3422 strcpy (menu
, XSTRING (name
)->data
);
3423 nlength
= XSTRING (name
)->size
;
3424 menu
[nlength
++] = ':';
3425 menu
[nlength
++] = ' ';
3428 /* Start prompting at start of first map. */
3432 /* Present the documented bindings, a line at a time. */
3440 /* Loop over elements of map. */
3445 /* If reached end of map, start at beginning of next map. */
3449 /* At end of last map, wrap around to first map if just starting,
3450 or end this line if already have something on it. */
3461 /* Look at the next element of the map. */
3463 elt
= XVECTOR (vector
)->contents
[idx
];
3465 elt
= Fcar_safe (rest
);
3467 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
3469 /* If we found a dense table in the keymap,
3470 advanced past it, but start scanning its contents. */
3471 rest
= Fcdr_safe (rest
);
3477 /* An ordinary element. */
3478 s
= Fcar_safe (Fcdr_safe (elt
));
3479 if (XTYPE (s
) != Lisp_String
)
3480 /* Ignore the element if it has no prompt string. */
3482 /* If we have room for the prompt string, add it to this line.
3483 If this is the first on the line, always add it. */
3484 else if (XSTRING (s
)->size
+ i
< width
3489 /* Punctuate between strings. */
3492 strcpy (menu
+ i
, ", ");
3497 /* Add as much of string as fits. */
3498 thiswidth
= XSTRING (s
)->size
;
3499 if (thiswidth
+ i
> width
)
3500 thiswidth
= width
- i
;
3501 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
3506 /* If this element does not fit, end the line now,
3507 and save the element for the next line. */
3508 strcpy (menu
+ i
, "...");
3512 /* Move past this element. */
3513 if (idx
>= 0 && idx
+ 1 >= XVECTOR (rest
)->size
)
3514 /* Handle reaching end of dense table. */
3519 rest
= Fcdr_safe (rest
);
3523 /* Prompt with that and read response. */
3525 obj
= read_char (1, 0, 0, Qnil
, 0);
3527 if (XTYPE (obj
) != Lisp_Int
)
3532 if (! EQ (obj
, menu_prompt_more_char
)
3533 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
3534 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
3539 /* Reading key sequences. */
3541 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
3542 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
3543 keymap, or nil otherwise. Return the index of the first keymap in
3544 which KEY has any binding, or NMAPS if no map has a binding.
3546 If KEY is a meta ASCII character, treat it like meta-prefix-char
3547 followed by the corresponding non-meta character. Keymaps in
3548 CURRENT with non-prefix bindings for meta-prefix-char become nil in
3551 When KEY is not defined in any of the keymaps, if it is an upper
3552 case letter and there are bindings for the corresponding lower-case
3553 letter, return the bindings for the lower-case letter.
3555 If KEY has no bindings in any of the CURRENT maps, NEXT is left
3558 NEXT may == CURRENT. */
3561 follow_key (key
, nmaps
, current
, defs
, next
)
3563 Lisp_Object
*current
, *defs
, *next
;
3566 int i
, first_binding
;
3568 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
3569 followed by the corresponding non-meta character. */
3570 if (XTYPE (key
) == Lisp_Int
&& (XINT (key
) & CHAR_META
))
3572 for (i
= 0; i
< nmaps
; i
++)
3573 if (! NILP (current
[i
]))
3576 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
3578 /* Note that since we pass the resulting bindings through
3579 get_keymap_1, non-prefix bindings for meta-prefix-char
3581 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
3587 XSET (key
, Lisp_Int
, XFASTINT (key
) & ~CHAR_META
);
3590 first_binding
= nmaps
;
3591 for (i
= nmaps
- 1; i
>= 0; i
--)
3593 if (! NILP (current
[i
]))
3595 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3596 if (! NILP (defs
[i
]))
3603 /* When KEY is not defined in any of the keymaps, if it is an upper
3604 case letter and there are bindings for the corresponding
3605 lower-case letter, return the bindings for the lower-case letter. */
3606 if (first_binding
== nmaps
3607 && XTYPE (key
) == Lisp_Int
3608 && ((((XINT (key
) & 0x3ffff)
3609 < XSTRING (current_buffer
->downcase_table
)->size
)
3610 && UPPERCASEP (XINT (key
) & 0x3ffff))
3611 || (XINT (key
) & shift_modifier
)))
3613 if (XINT (key
) & shift_modifier
)
3614 XSETINT (key
, XINT (key
) & ~shift_modifier
);
3616 XSETINT (key
, DOWNCASE (XINT (key
)));
3618 first_binding
= nmaps
;
3619 for (i
= nmaps
- 1; i
>= 0; i
--)
3621 if (! NILP (current
[i
]))
3623 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3624 if (! NILP (defs
[i
]))
3632 /* Given the set of bindings we've found, produce the next set of maps. */
3633 if (first_binding
< nmaps
)
3634 for (i
= 0; i
< nmaps
; i
++)
3635 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
3637 return first_binding
;
3640 /* Read a sequence of keys that ends with a non prefix character,
3641 storing it in KEYBUF, a buffer of size BUFSIZE.
3643 Return the length of the key sequence stored.
3644 Return -1 if the user rejected a command menu.
3646 Echo starting immediately unless `prompt' is 0.
3648 Where a key sequence ends depends on the currently active keymaps.
3649 These include any minor mode keymaps active in the current buffer,
3650 the current buffer's local map, and the global map.
3652 If a key sequence has no other bindings, we check Vfunction_key_map
3653 to see if some trailing subsequence might be the beginning of a
3654 function key's sequence. If so, we try to read the whole function
3655 key, and substitute its symbolic name into the key sequence.
3657 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
3658 `double-' events into similar click events, if that would make them
3659 bound. We try to turn `triple-' events first into `double-' events,
3662 If we get a mouse click in a mode line, vertical divider, or other
3663 non-text area, we treat the click as if it were prefixed by the
3664 symbol denoting that area - `mode-line', `vertical-line', or
3667 If the sequence starts with a mouse click, we read the key sequence
3668 with respect to the buffer clicked on, not the current buffer.
3670 If the user switches frames in the midst of a key sequence, we put
3671 off the switch-frame event until later; the next call to
3672 read_char will return it. */
3675 read_key_sequence (keybuf
, bufsize
, prompt
)
3676 Lisp_Object
*keybuf
;
3680 int count
= specpdl_ptr
- specpdl
;
3682 /* How many keys there are in the current key sequence. */
3685 /* The length of the echo buffer when we started reading, and
3686 the length of this_command_keys when we started reading. */
3690 /* The number of keymaps we're scanning right now, and the number of
3691 keymaps we have allocated space for. */
3693 int nmaps_allocated
= 0;
3695 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
3696 the current keymaps. */
3699 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3700 in the current keymaps, or nil where it is not a prefix. */
3701 Lisp_Object
*submaps
;
3703 /* The index in defs[] of the first keymap that has a binding for
3704 this key sequence. In other words, the lowest i such that
3705 defs[i] is non-nil. */
3708 /* If t < mock_input, then KEYBUF[t] should be read as the next
3711 We use this to recover after recognizing a function key. Once we
3712 realize that a suffix of the current key sequence is actually a
3713 function key's escape sequence, we replace the suffix with the
3714 function key's binding from Vfunction_key_map. Now keybuf
3715 contains a new and different key sequence, so the echo area,
3716 this_command_keys, and the submaps and defs arrays are wrong. In
3717 this situation, we set mock_input to t, set t to 0, and jump to
3718 restart_sequence; the loop will read keys from keybuf up until
3719 mock_input, thus rebuilding the state; and then it will resume
3720 reading characters from the keyboard. */
3723 /* If the sequence is unbound in submaps[], then
3724 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
3725 and fkey_map is its binding.
3727 These might be > t, indicating that all function key scanning
3728 should hold off until t reaches them. We do this when we've just
3729 recognized a function key, to avoid searching for the function
3730 key's again in Vfunction_key_map. */
3731 int fkey_start
= 0, fkey_end
= 0;
3732 Lisp_Object fkey_map
;
3734 /* Likewise, for key_translation_map. */
3735 int keytran_start
= 0, keytran_end
= 0;
3736 Lisp_Object keytran_map
;
3738 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
3739 we put it off for later. While we're reading, we keep the event here. */
3740 Lisp_Object delayed_switch_frame
;
3742 Lisp_Object first_event
;
3746 last_nonmenu_event
= Qnil
;
3748 delayed_switch_frame
= Qnil
;
3749 fkey_map
= Vfunction_key_map
;
3750 keytran_map
= Vkey_translation_map
;
3752 /* If there is no function-key-map, turn off function key scanning. */
3753 if (NILP (Fkeymapp (Vfunction_key_map
)))
3754 fkey_start
= fkey_end
= bufsize
+ 1;
3756 /* If there is no key-translation-map, turn off scanning. */
3757 if (NILP (Fkeymapp (Vkey_translation_map
)))
3758 keytran_start
= keytran_end
= bufsize
+ 1;
3763 echo_prompt (prompt
);
3764 else if (cursor_in_echo_area
)
3765 /* This doesn't put in a dash if the echo buffer is empty, so
3766 you don't always see a dash hanging out in the minibuffer. */
3770 /* Record the initial state of the echo area and this_command_keys;
3771 we will need to restore them if we replay a key sequence. */
3773 echo_start
= echo_length ();
3774 keys_start
= this_command_key_count
;
3776 #if 0 /* This doesn't quite work, because some of the things
3777 that read_char does cannot safely be bypassed.
3778 It seems too risky to try to make this work right. */
3779 /* Read the first char of the sequence specially, before setting
3780 up any keymaps, in case a filter runs and switches buffers on us. */
3781 first_event
= read_char (!prompt
, 0, submaps
, last_nonmenu_event
,
3785 /* We jump here when the key sequence has been thoroughly changed, and
3786 we need to rescan it starting from the beginning. When we jump here,
3787 keybuf[0..mock_input] holds the sequence we should reread. */
3790 /* Build our list of keymaps.
3791 If we recognize a function key and replace its escape sequence in
3792 keybuf with its symbol, or if the sequence starts with a mouse
3793 click and we need to switch buffers, we jump back here to rebuild
3794 the initial keymaps from the current buffer. */
3798 nmaps
= current_minor_maps (0, &maps
) + 2;
3799 if (nmaps
> nmaps_allocated
)
3801 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
3802 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
3803 nmaps_allocated
= nmaps
;
3805 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
3806 #ifdef USE_TEXT_PROPERTIES
3807 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3809 submaps
[nmaps
-2] = current_buffer
->keymap
;
3811 submaps
[nmaps
-1] = current_global_map
;
3814 /* Find an accurate initial value for first_binding. */
3815 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
3816 if (! NILP (submaps
[first_binding
]))
3819 /* We jump here when a function key substitution has forced us to
3820 reprocess the current key sequence. keybuf[0..mock_input] is the
3821 sequence we want to reread. */
3824 /* These are no-ops the first time through, but if we restart, they
3825 revert the echo area and this_command_keys to their original state. */
3826 this_command_key_count
= keys_start
;
3828 echo_truncate (echo_start
);
3830 /* If the best binding for the current key sequence is a keymap, or
3831 we may be looking at a function key's escape sequence, keep on
3833 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
3834 || (first_binding
>= nmaps
3836 /* mock input is never part of a function key's sequence. */
3837 && mock_input
<= fkey_start
)
3838 || (first_binding
>= nmaps
3839 && keytran_start
< t
3840 /* mock input is never part of a function key's sequence. */
3841 && mock_input
<= keytran_start
))
3844 int used_mouse_menu
= 0;
3846 /* Where the last real key started. If we need to throw away a
3847 key that has expanded into more than one element of keybuf
3848 (say, a mouse click on the mode line which is being treated
3849 as [mode-line (mouse-...)], then we backtrack to this point
3851 int last_real_key_start
;
3853 /* These variables are analogous to echo_start and keys_start;
3854 while those allow us to restart the entire key sequence,
3855 echo_local_start and keys_local_start allow us to throw away
3857 int echo_local_start
, keys_local_start
, local_first_binding
;
3860 error ("key sequence too long");
3863 echo_local_start
= echo_length ();
3864 keys_local_start
= this_command_key_count
;
3865 local_first_binding
= first_binding
;
3868 /* These are no-ops, unless we throw away a keystroke below and
3869 jumped back up to replay_key; in that case, these restore the
3870 variables to their original state, allowing us to replay the
3873 echo_truncate (echo_local_start
);
3874 this_command_key_count
= keys_local_start
;
3875 first_binding
= local_first_binding
;
3877 /* By default, assume each event is "real". */
3878 last_real_key_start
= t
;
3880 /* Does mock_input indicate that we are re-reading a key sequence? */
3884 add_command_key (key
);
3888 /* If not, we should actually read a character. */
3891 struct buffer
*buf
= current_buffer
;
3893 key
= read_char (!prompt
, nmaps
, submaps
, last_nonmenu_event
,
3896 /* read_char returns t when it shows a menu and the user rejects it.
3901 /* read_char returns -1 at the end of a macro.
3902 Emacs 18 handles this by returning immediately with a
3903 zero, so that's what we'll do. */
3904 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) == -1)
3913 /* Clicks in non-text areas get prefixed by the symbol
3914 in their CHAR-ADDRESS field. For example, a click on
3915 the mode line is prefixed by the symbol `mode-line'.
3917 Furthermore, key sequences beginning with mouse clicks
3918 are read using the keymaps of the buffer clicked on, not
3919 the current buffer. So we may have to switch the buffer
3922 When we turn one event into two events, we must make sure
3923 that neither of the two looks like the original--so that,
3924 if we replay the events, they won't be expanded again.
3925 If not for this, such reexpansion could happen either here
3926 or when user programs play with this-command-keys. */
3927 if (EVENT_HAS_PARAMETERS (key
))
3929 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
3931 if (EQ (kind
, Qmouse_click
))
3933 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
3934 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
3936 if (XTYPE (posn
) == Lisp_Cons
)
3938 /* We're looking at the second event of a
3939 sequence which we expanded before. Set
3940 last_real_key_start appropriately. */
3942 last_real_key_start
= t
- 1;
3945 /* Key sequences beginning with mouse clicks are
3946 read using the keymaps in the buffer clicked on,
3947 not the current buffer. If we're at the
3948 beginning of a key sequence, switch buffers. */
3949 if (last_real_key_start
== 0
3950 && XTYPE (window
) == Lisp_Window
3951 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
3952 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
3957 /* Arrange to go back to the original buffer once we're
3958 done reading the key sequence. Note that we can't
3959 use save_excursion_{save,restore} here, because they
3960 save point as well as the current buffer; we don't
3961 want to save point, because redisplay may change it,
3962 to accommodate a Fset_window_start or something. We
3963 don't want to do this at the top of the function,
3964 because we may get input from a subprocess which
3965 wants to change the selected window and stuff (say,
3967 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3969 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
3970 goto replay_sequence
;
3972 else if (XTYPE (posn
) == Lisp_Symbol
)
3974 /* Expand mode-line and scroll-bar events into two events:
3975 use posn as a fake prefix key. */
3977 if (t
+ 1 >= bufsize
)
3978 error ("key sequence too long");
3983 /* Zap the position in key, so we know that we've
3984 expanded it, and don't try to do so again. */
3985 POSN_BUFFER_POSN (EVENT_START (key
))
3986 = Fcons (posn
, Qnil
);
3990 else if (EQ (kind
, Qswitch_frame
))
3992 /* If we're at the beginning of a key sequence, go
3993 ahead and return this event. If we're in the
3994 midst of a key sequence, delay it until the end. */
3997 delayed_switch_frame
= key
;
4003 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4005 /* Handle menu-bar events:
4006 insert the dummy prefix event `menu-bar'. */
4007 if (EQ (posn
, Qmenu_bar
))
4009 if (t
+ 1 >= bufsize
)
4010 error ("key sequence too long");
4011 /* Run the Lucid hook. */
4012 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4013 /* If it has changed current-menubar from previous value,
4014 really recompute the menubar from the value. */
4015 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4016 call0 (Qrecompute_lucid_menubar
);
4020 /* Zap the position in key, so we know that we've
4021 expanded it, and don't try to do so again. */
4022 POSN_BUFFER_POSN (EVENT_START (key
))
4023 = Fcons (posn
, Qnil
);
4026 goto replay_sequence
;
4028 else if (XTYPE (posn
) == Lisp_Cons
)
4030 /* We're looking at the second event of a
4031 sequence which we expanded before. Set
4032 last_real_key_start appropriately. */
4033 if (last_real_key_start
== t
&& t
> 0)
4034 last_real_key_start
= t
- 1;
4039 /* We have finally decided that KEY is something we might want
4041 first_binding
= (follow_key (key
,
4042 nmaps
- first_binding
,
4043 submaps
+ first_binding
,
4044 defs
+ first_binding
,
4045 submaps
+ first_binding
)
4048 /* If KEY wasn't bound, we'll try some fallbacks. */
4049 if (first_binding
>= nmaps
)
4051 Lisp_Object head
= EVENT_HEAD (key
);
4053 if (EQ (head
, Vhelp_char
))
4055 read_key_sequence_cmd
= Vprefix_help_command
;
4057 last_nonmenu_event
= key
;
4061 if (XTYPE (head
) == Lisp_Symbol
)
4063 Lisp_Object breakdown
= parse_modifiers (head
);
4064 int modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4066 /* We drop unbound `down-' events altogether. */
4067 if (modifiers
& down_modifier
)
4069 /* Dispose of this event by simply jumping back to
4070 replay_key, to get another event.
4072 Note that if this event came from mock input,
4073 then just jumping back to replay_key will just
4074 hand it to us again. So we have to wipe out any
4077 We could delete keybuf[t] and shift everything
4078 after that to the left by one spot, but we'd also
4079 have to fix up any variable that points into
4080 keybuf, and shifting isn't really necessary
4083 Adding prefixes for non-textual mouse clicks
4084 creates two characters of mock input, and both
4085 must be thrown away. If we're only looking at
4086 the prefix now, we can just jump back to
4087 replay_key. On the other hand, if we've already
4088 processed the prefix, and now the actual click
4089 itself is giving us trouble, then we've lost the
4090 state of the keymaps we want to backtrack to, and
4091 we need to replay the whole sequence to rebuild
4094 Beyond that, only function key expansion could
4095 create more than two keys, but that should never
4096 generate mouse events, so it's okay to zero
4097 mock_input in that case too.
4099 Isn't this just the most wonderful code ever? */
4100 if (t
== last_real_key_start
)
4107 mock_input
= last_real_key_start
;
4108 goto replay_sequence
;
4112 /* We turn unbound `drag-' events into `click-'
4113 events, if the click would be bound. */
4114 else if (modifiers
& (drag_modifier
| double_modifier
4117 while (modifiers
& (drag_modifier
| double_modifier
4120 Lisp_Object new_head
, new_click
;
4121 if (modifiers
& triple_modifier
)
4122 modifiers
^= (double_modifier
| triple_modifier
);
4124 modifiers
&= ~(drag_modifier
| double_modifier
);
4126 apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
4128 Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
4130 /* Look for a binding for this new key. follow_key
4131 promises that it didn't munge submaps the
4132 last time we called it, since key was unbound. */
4134 (follow_key (new_click
,
4135 nmaps
- local_first_binding
,
4136 submaps
+ local_first_binding
,
4137 defs
+ local_first_binding
,
4138 submaps
+ local_first_binding
)
4139 + local_first_binding
);
4141 /* If that click is bound, go for it. */
4142 if (first_binding
< nmaps
)
4147 /* Otherwise, we'll leave key set to the drag event. */
4154 /* Normally, last_nonmenu_event gets the previous key we read.
4155 But when a mouse popup menu is being used,
4156 we don't update last_nonmenu_event; it continues to hold the mouse
4157 event that preceded the first level of menu. */
4158 if (!used_mouse_menu
)
4159 last_nonmenu_event
= key
;
4161 /* If the sequence is unbound, see if we can hang a function key
4162 off the end of it. We only want to scan real keyboard input
4163 for function key sequences, so if mock_input says that we're
4164 re-reading old events, don't examine it. */
4165 if (first_binding
>= nmaps
4168 Lisp_Object fkey_next
;
4170 /* Scan from fkey_end until we find a bound suffix. */
4171 while (fkey_end
< t
)
4175 key
= keybuf
[fkey_end
++];
4176 /* Look up meta-characters by prefixing them
4177 with meta_prefix_char. I hate this. */
4178 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4183 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
4185 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4188 fkey_next
= fkey_map
;
4191 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
4193 /* If keybuf[fkey_start..fkey_end] is bound in the
4194 function key map and it's a suffix of the current
4195 sequence (i.e. fkey_end == t), replace it with
4196 the binding and restart with fkey_start at the end. */
4197 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
4200 int len
= Flength (fkey_next
);
4202 t
= fkey_start
+ len
;
4204 error ("key sequence too long");
4206 if (VECTORP (fkey_next
))
4207 bcopy (XVECTOR (fkey_next
)->contents
,
4208 keybuf
+ fkey_start
,
4209 (t
- fkey_start
) * sizeof (keybuf
[0]));
4210 else if (STRINGP (fkey_next
))
4214 for (i
= 0; i
< len
; i
++)
4215 XFASTINT (keybuf
[fkey_start
+ i
]) =
4216 XSTRING (fkey_next
)->data
[i
];
4220 fkey_start
= fkey_end
= t
;
4221 fkey_map
= Vfunction_key_map
;
4223 goto replay_sequence
;
4226 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
4228 /* If we no longer have a bound suffix, try a new positions for
4230 if (NILP (fkey_map
))
4232 fkey_end
= ++fkey_start
;
4233 fkey_map
= Vfunction_key_map
;
4238 /* Look for this sequence in key-translation-map. */
4240 Lisp_Object keytran_next
;
4242 /* Scan from keytran_end until we find a bound suffix. */
4243 while (keytran_end
< t
)
4247 key
= keybuf
[keytran_end
++];
4248 /* Look up meta-characters by prefixing them
4249 with meta_prefix_char. I hate this. */
4250 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4255 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
4257 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4260 keytran_next
= keytran_map
;
4263 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
4265 /* If keybuf[keytran_start..keytran_end] is bound in the
4266 function key map and it's a suffix of the current
4267 sequence (i.e. keytran_end == t), replace it with
4268 the binding and restart with keytran_start at the end. */
4269 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
4270 && keytran_end
== t
)
4272 int len
= Flength (keytran_next
);
4274 t
= keytran_start
+ len
;
4276 error ("key sequence too long");
4278 if (VECTORP (keytran_next
))
4279 bcopy (XVECTOR (keytran_next
)->contents
,
4280 keybuf
+ keytran_start
,
4281 (t
- keytran_start
) * sizeof (keybuf
[0]));
4282 else if (STRINGP (keytran_next
))
4286 for (i
= 0; i
< len
; i
++)
4287 XFASTINT (keybuf
[keytran_start
+ i
])
4288 = XSTRING (keytran_next
)->data
[i
];
4292 keytran_start
= keytran_end
= t
;
4293 keytran_map
= Vkey_translation_map
;
4295 goto replay_sequence
;
4298 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
4300 /* If we no longer have a bound suffix, try a new positions for
4302 if (NILP (keytran_map
))
4304 keytran_end
= ++keytran_start
;
4305 keytran_map
= Vkey_translation_map
;
4311 read_key_sequence_cmd
= (first_binding
< nmaps
4312 ? defs
[first_binding
]
4316 unread_switch_frame
= delayed_switch_frame
;
4317 unbind_to (count
, Qnil
);
4319 /* Occasionally we fabricate events, perhaps by expanding something
4320 according to function-key-map, or by adding a prefix symbol to a
4321 mouse click in the scroll bar or modeline. In this cases, return
4322 the entire generated key sequence, even if we hit an unbound
4323 prefix or a definition before the end. This means that you will
4324 be able to push back the event properly, and also means that
4325 read-key-sequence will always return a logical unit.
4328 for (; t
< mock_input
; t
++)
4330 echo_char (keybuf
[t
]);
4331 add_command_key (keybuf
[t
]);
4337 #if 0 /* This doc string is too long for some compilers.
4338 This commented-out definition serves for DOC. */
4339 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4340 "Read a sequence of keystrokes and return as a string or vector.\n\
4341 The sequence is sufficient to specify a non-prefix command in the\n\
4342 current local and global maps.\n\
4344 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
4345 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
4346 as a continuation of the previous key.\n\
4348 A C-g typed while in this function is treated like any other character,\n\
4349 and `quit-flag' is not set.\n\
4351 If the key sequence starts with a mouse click, then the sequence is read\n\
4352 using the keymaps of the buffer of the window clicked in, not the buffer\n\
4353 of the selected window as normal.\n\
4355 `read-key-sequence' drops unbound button-down events, since you normally\n\
4356 only care about the click or drag events which follow them. If a drag\n\
4357 or multi-click event is unbound, but the corresponding click event would\n\
4358 be bound, `read-key-sequence' turns the event into a click event at the\n\
4359 drag's starting position. This means that you don't have to distinguish\n\
4360 between click and drag, double, or triple events unless you want to.\n\
4362 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
4363 lines separating windows, and scroll bars with imaginary keys\n\
4364 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
4366 If the user switches frames in the middle of a key sequence, the\n\
4367 frame-switch event is put off until after the current key sequence.\n\
4369 `read-key-sequence' checks `function-key-map' for function key\n\
4370 sequences, where they wouldn't conflict with ordinary bindings. See\n\
4371 `function-key-map' for more details.")
4372 (prompt
, continue_echo
)
4375 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4377 (prompt
, continue_echo
)
4378 Lisp_Object prompt
, continue_echo
;
4380 Lisp_Object keybuf
[30];
4382 struct gcpro gcpro1
, gcpro2
;
4385 CHECK_STRING (prompt
, 0);
4388 bzero (keybuf
, sizeof keybuf
);
4390 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
4392 if (NILP (continue_echo
))
4393 this_command_key_count
= 0;
4395 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
4396 NILP (prompt
) ? 0 : XSTRING (prompt
)->data
);
4404 return make_event_array (i
, keybuf
);
4407 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
4408 "Execute CMD as an editor command.\n\
4409 CMD must be a symbol that satisfies the `commandp' predicate.\n\
4410 Optional second arg RECORD-FLAG non-nil\n\
4411 means unconditionally put this command in `command-history'.\n\
4412 Otherwise, that is done only if an arg is read using the minibuffer.")
4414 Lisp_Object cmd
, record
;
4416 register Lisp_Object final
;
4417 register Lisp_Object tem
;
4418 Lisp_Object prefixarg
;
4419 struct backtrace backtrace
;
4420 extern int debug_on_next_call
;
4422 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
4423 Vcurrent_prefix_arg
= prefixarg
;
4424 debug_on_next_call
= 0;
4426 if (XTYPE (cmd
) == Lisp_Symbol
)
4428 tem
= Fget (cmd
, Qdisabled
);
4430 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
4435 final
= Findirect_function (cmd
);
4437 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
4438 do_autoload (final
, cmd
);
4443 if (XTYPE (final
) == Lisp_String
4444 || XTYPE (final
) == Lisp_Vector
)
4446 /* If requested, place the macro in the command history. For
4447 other sorts of commands, call-interactively takes care of
4451 = Fcons (Fcons (Qexecute_kbd_macro
,
4452 Fcons (final
, Fcons (prefixarg
, Qnil
))),
4455 return Fexecute_kbd_macro (final
, prefixarg
);
4457 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
4458 || XTYPE (final
) == Lisp_Compiled
)
4460 backtrace
.next
= backtrace_list
;
4461 backtrace_list
= &backtrace
;
4462 backtrace
.function
= &Qcall_interactively
;
4463 backtrace
.args
= &cmd
;
4464 backtrace
.nargs
= 1;
4465 backtrace
.evalargs
= 0;
4467 tem
= Fcall_interactively (cmd
, record
);
4469 backtrace_list
= backtrace
.next
;
4475 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
4477 "Read function name, then read its arguments and call it.")
4479 Lisp_Object prefixarg
;
4481 Lisp_Object function
;
4483 Lisp_Object saved_keys
;
4484 struct gcpro gcpro1
;
4486 saved_keys
= Fthis_command_keys ();
4488 GCPRO1 (saved_keys
);
4490 if (EQ (prefixarg
, Qminus
))
4492 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
4493 strcpy (buf
, "C-u ");
4494 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
4495 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
4496 else if (XTYPE (prefixarg
) == Lisp_Int
)
4497 sprintf (buf
, "%d ", XINT (prefixarg
));
4499 /* This isn't strictly correct if execute-extended-command
4500 is bound to anything else. Perhaps it should use
4501 this_command_keys? */
4502 strcat (buf
, "M-x ");
4504 /* Prompt with buf, and then read a string, completing from and
4505 restricting to the set of all defined commands. Don't provide
4506 any initial input. The last Qnil says not to perform a
4507 peculiar hack on the initial input. */
4508 function
= Fcompleting_read (build_string (buf
),
4509 Vobarray
, Qcommandp
,
4512 /* Set this_command_keys to the concatenation of saved_keys and
4513 function, followed by a RET. */
4515 struct Lisp_String
*str
;
4519 this_command_key_count
= 0;
4521 str
= XSTRING (saved_keys
);
4522 for (i
= 0; i
< str
->size
; i
++)
4524 XFASTINT (tem
) = str
->data
[i
];
4525 add_command_key (tem
);
4528 str
= XSTRING (function
);
4529 for (i
= 0; i
< str
->size
; i
++)
4531 XFASTINT (tem
) = str
->data
[i
];
4532 add_command_key (tem
);
4535 XFASTINT (tem
) = '\015';
4536 add_command_key (tem
);
4541 function
= Fintern (function
, Qnil
);
4542 Vprefix_arg
= prefixarg
;
4543 this_command
= function
;
4545 return Fcommand_execute (function
, Qt
);
4549 detect_input_pending ()
4552 get_input_pending (&input_pending
);
4554 return input_pending
;
4557 /* This is called in some cases before a possible quit.
4558 It cases the next call to detect_input_pending to recompute input_pending.
4559 So calling this function unnecessarily can't do any harm. */
4560 clear_input_pending ()
4565 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
4566 "T if command input is currently available with no waiting.\n\
4567 Actually, the value is nil only if we can be sure that no input is available.")
4570 if (!NILP (unread_command_events
) || unread_command_char
!= -1)
4573 return detect_input_pending () ? Qt
: Qnil
;
4576 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
4577 "Return vector of last 100 events, not counting those from keyboard macros.")
4580 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
4583 if (total_keys
< NUM_RECENT_KEYS
)
4584 return Fvector (total_keys
, keys
);
4587 val
= Fvector (NUM_RECENT_KEYS
, keys
);
4588 bcopy (keys
+ recent_keys_index
,
4589 XVECTOR (val
)->contents
,
4590 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
4592 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
4593 recent_keys_index
* sizeof (Lisp_Object
));
4598 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
4599 "Return the key sequence that invoked this command.\n\
4600 The value is a string or a vector.")
4603 return make_event_array (this_command_key_count
,
4604 XVECTOR (this_command_keys
)->contents
);
4607 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
4608 "Return the current depth in recursive edits.")
4612 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
4616 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
4617 "FOpen dribble file: ",
4618 "Start writing all keyboard characters to a dribble file called FILE.\n\
4619 If FILE is nil, close any open dribble file.")
4630 file
= Fexpand_file_name (file
, Qnil
);
4631 dribble
= fopen (XSTRING (file
)->data
, "w");
4636 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
4637 "Discard the contents of the terminal input buffer.\n\
4638 Also cancel any kbd macro being defined.")
4641 defining_kbd_macro
= 0;
4642 update_mode_lines
++;
4644 unread_command_events
= Qnil
;
4645 unread_command_char
= -1;
4647 discard_tty_input ();
4649 /* Without the cast, GCC complains that this assignment loses the
4650 volatile qualifier of kbd_store_ptr. Is there anything wrong
4652 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
4653 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
4659 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
4660 "Stop Emacs and return to superior process. You can resume later.\n\
4661 On systems that don't have job control, run a subshell instead.\n\n\
4662 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
4663 to be read as terminal input by Emacs's parent, after suspension.\n\
4665 Before suspending, call the functions in `suspend-hook' with no args.\n\
4666 If any of them returns nil, don't call the rest and don't suspend.\n\
4667 Otherwise, suspend normally and after resumption run the normal hook\n\
4668 `suspend-resume-hook' if that is bound and non-nil.\n\
4670 Some operating systems cannot stop the Emacs process and resume it later.\n\
4671 On such systems, Emacs starts a subshell instead of suspending.")
4673 Lisp_Object stuffstring
;
4676 int count
= specpdl_ptr
- specpdl
;
4677 int old_height
, old_width
;
4679 struct gcpro gcpro1
, gcpro2
;
4680 extern init_sys_modes ();
4682 if (!NILP (stuffstring
))
4683 CHECK_STRING (stuffstring
, 0);
4685 /* Run the functions in suspend-hook. */
4686 if (!NILP (Vrun_hooks
))
4687 call1 (Vrun_hooks
, intern ("suspend-hook"));
4689 GCPRO1 (stuffstring
);
4690 get_frame_size (&old_width
, &old_height
);
4692 /* sys_suspend can get an error if it tries to fork a subshell
4693 and the system resources aren't available for that. */
4694 record_unwind_protect (init_sys_modes
, 0);
4695 stuff_buffered_input (stuffstring
);
4697 unbind_to (count
, Qnil
);
4699 /* Check if terminal/window size has changed.
4700 Note that this is not useful when we are running directly
4701 with a window system; but suspend should be disabled in that case. */
4702 get_frame_size (&width
, &height
);
4703 if (width
!= old_width
|| height
!= old_height
)
4704 change_frame_size (selected_frame
, height
, width
, 0, 0);
4706 /* Run suspend-resume-hook. */
4707 if (!NILP (Vrun_hooks
))
4708 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
4714 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
4715 Then in any case stuff anything Emacs has read ahead and not used. */
4717 stuff_buffered_input (stuffstring
)
4718 Lisp_Object stuffstring
;
4720 register unsigned char *p
;
4722 /* stuff_char works only in BSD, versions 4.2 and up. */
4725 if (XTYPE (stuffstring
) == Lisp_String
)
4729 p
= XSTRING (stuffstring
)->data
;
4730 count
= XSTRING (stuffstring
)->size
;
4735 /* Anything we have read ahead, put back for the shell to read. */
4736 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4738 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4739 kbd_fetch_ptr
= kbd_buffer
;
4740 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
4741 stuff_char (XINT (kbd_fetch_ptr
->code
));
4742 kbd_fetch_ptr
->kind
= no_event
;
4743 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
4750 #endif /* BSD and not BSD4_1 */
4753 set_waiting_for_input (time_to_clear
)
4754 EMACS_TIME
*time_to_clear
;
4756 input_available_clear_time
= time_to_clear
;
4758 /* Tell interrupt_signal to throw back to read_char, */
4759 waiting_for_input
= 1;
4761 /* If interrupt_signal was called before and buffered a C-g,
4762 make it run again now, to avoid timing error. */
4763 if (!NILP (Vquit_flag
))
4764 quit_throw_to_read_char ();
4766 /* If alarm has gone off already, echo now. */
4774 clear_waiting_for_input ()
4776 /* Tell interrupt_signal not to throw back to read_char, */
4777 waiting_for_input
= 0;
4778 input_available_clear_time
= 0;
4781 /* This routine is called at interrupt level in response to C-G.
4782 If interrupt_input, this is the handler for SIGINT.
4783 Otherwise, it is called from kbd_buffer_store_event,
4784 in handling SIGIO or SIGTINT.
4786 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
4787 immediately throw back to read_char.
4789 Otherwise it sets the Lisp variable quit-flag not-nil.
4790 This causes eval to throw, when it gets a chance.
4791 If quit-flag is already non-nil, it stops the job right away. */
4797 /* Must preserve main program's value of errno. */
4798 int old_errno
= errno
;
4801 /* USG systems forget handlers when they are used;
4802 must reestablish each time */
4803 signal (SIGINT
, interrupt_signal
);
4804 signal (SIGQUIT
, interrupt_signal
);
4809 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
4814 #ifdef SIGTSTP /* Support possible in later USG versions */
4816 * On systems which can suspend the current process and return to the original
4817 * shell, this command causes the user to end up back at the shell.
4818 * The "Auto-save" and "Abort" questions are not asked until
4819 * the user elects to return to emacs, at which point he can save the current
4820 * job and either dump core or continue.
4825 if (sys_suspend () == -1)
4827 printf ("Not running as a subprocess;\n");
4828 printf ("you can continue or abort.\n");
4831 /* Perhaps should really fork an inferior shell?
4832 But that would not provide any way to get back
4833 to the original shell, ever. */
4834 printf ("No support for stopping a process on this operating system;\n");
4835 printf ("you can continue or abort.\n");
4836 #endif /* not VMS */
4837 #endif /* not SIGTSTP */
4838 printf ("Auto-save? (y or n) ");
4840 if (((c
= getchar ()) & ~040) == 'Y')
4842 Fdo_auto_save (Qt
, Qnil
);
4843 printf ("Auto-save done\n");
4845 while (c
!= '\n') c
= getchar ();
4847 printf ("Abort (and enter debugger)? (y or n) ");
4849 printf ("Abort (and dump core)? (y or n) ");
4850 #endif /* not VMS */
4852 if (((c
= getchar ()) & ~040) == 'Y')
4854 while (c
!= '\n') c
= getchar ();
4855 printf ("Continuing...\n");
4861 /* If executing a function that wants to be interrupted out of
4862 and the user has not deferred quitting by binding `inhibit-quit'
4863 then quit right away. */
4864 if (immediate_quit
&& NILP (Vinhibit_quit
))
4868 Fsignal (Qquit
, Qnil
);
4871 /* Else request quit when it's safe */
4875 if (waiting_for_input
&& !echoing
)
4876 quit_throw_to_read_char ();
4881 /* Handle a C-g by making read_char return C-g. */
4883 quit_throw_to_read_char ()
4885 quit_error_check ();
4887 /* Prevent another signal from doing this before we finish. */
4888 clear_waiting_for_input ();
4891 unread_command_events
= Qnil
;
4892 unread_command_char
= -1;
4894 #ifdef POLL_FOR_INPUT
4895 /* May be > 1 if in recursive minibuffer. */
4896 if (poll_suppress_count
== 0)
4900 _longjmp (getcjmp
, 1);
4903 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
4904 "Set mode of reading keyboard input.\n\
4905 First arg INTERRUPT non-nil means use input interrupts;\n\
4906 nil means use CBREAK mode.\n\
4907 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
4908 (no effect except in CBREAK mode).\n\
4909 Third arg META t means accept 8-bit input (for a Meta key).\n\
4910 META nil means ignore the top bit, on the assumption it is parity.\n\
4911 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
4912 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
4913 See also `current-input-mode'.")
4914 (interrupt
, flow
, meta
, quit
)
4915 Lisp_Object interrupt
, flow
, meta
, quit
;
4918 && (XTYPE (quit
) != Lisp_Int
4919 || XINT (quit
) < 0 || XINT (quit
) > 0400))
4920 error ("set-input-mode: QUIT must be an ASCII character.");
4924 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4925 #ifdef NO_SOCK_SIGIO
4926 if (read_socket_hook
)
4927 interrupt_input
= 0; /* No interrupts if reading from a socket. */
4929 #endif /* NO_SOCK_SIGIO */
4930 interrupt_input
= !NILP (interrupt
);
4931 #else /* not SIGIO */
4932 interrupt_input
= 0;
4933 #endif /* not SIGIO */
4934 /* Our VMS input only works by interrupts, as of now. */
4936 interrupt_input
= 1;
4938 flow_control
= !NILP (flow
);
4941 else if (EQ (meta
, Qt
))
4946 /* Don't let this value be out of range. */
4947 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
4953 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
4954 "Return information about the way Emacs currently reads keyboard input.\n\
4955 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
4956 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
4957 nil, Emacs is using CBREAK mode.\n\
4958 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
4959 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
4960 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
4961 META nil means ignoring the top bit, on the assumption it is parity.\n\
4962 META is neither t nor nil if accepting 8-bit input and using\n\
4963 all 8 bits as the character code.\n\
4964 QUIT is the character Emacs currently uses to quit.\n\
4965 The elements of this list correspond to the arguments of\n\
4971 val
[0] = interrupt_input
? Qt
: Qnil
;
4972 val
[1] = flow_control
? Qt
: Qnil
;
4973 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
4974 XFASTINT (val
[3]) = quit_char
;
4976 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
4982 /* This is correct before outermost invocation of the editor loop */
4983 command_loop_level
= -1;
4985 quit_char
= Ctl ('g');
4986 unread_command_events
= Qnil
;
4987 unread_command_char
= -1;
4989 recent_keys_index
= 0;
4990 kbd_fetch_ptr
= kbd_buffer
;
4991 kbd_store_ptr
= kbd_buffer
;
4992 do_mouse_tracking
= 0;
4996 /* This means that command_loop_1 won't try to select anything the first
4998 internal_last_event_frame
= Qnil
;
4999 Vlast_event_frame
= internal_last_event_frame
;
5002 /* If we're running a dumped Emacs, we need to clear out
5003 kbd_buffer_frame_or_window, in case some events got into it
5006 If we're running an undumped Emacs, it hasn't been initialized by
5007 syms_of_keyboard yet. */
5009 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5011 if (!noninteractive
)
5013 signal (SIGINT
, interrupt_signal
);
5014 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
5015 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
5016 SIGQUIT and we can't tell which one it will give us. */
5017 signal (SIGQUIT
, interrupt_signal
);
5018 #endif /* HAVE_TERMIO */
5019 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5021 signal (SIGIO
, input_available_signal
);
5025 /* Use interrupt input by default, if it works and noninterrupt input
5026 has deficiencies. */
5028 #ifdef INTERRUPT_INPUT
5029 interrupt_input
= 1;
5031 interrupt_input
= 0;
5034 /* Our VMS input only works by interrupts, as of now. */
5036 interrupt_input
= 1;
5042 if (keyboard_init_hook
)
5043 (*keyboard_init_hook
) ();
5045 #ifdef POLL_FOR_INPUT
5046 poll_suppress_count
= 1;
5051 /* This type's only use is in syms_of_keyboard, to initialize the
5052 event header symbols and put properties on them. */
5059 struct event_head head_table
[] = {
5060 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
5061 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
5062 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
5067 Qdisabled_command_hook
= intern ("disabled-command-hook");
5068 staticpro (&Qdisabled_command_hook
);
5070 Qself_insert_command
= intern ("self-insert-command");
5071 staticpro (&Qself_insert_command
);
5073 Qforward_char
= intern ("forward-char");
5074 staticpro (&Qforward_char
);
5076 Qbackward_char
= intern ("backward-char");
5077 staticpro (&Qbackward_char
);
5079 Qdisabled
= intern ("disabled");
5080 staticpro (&Qdisabled
);
5082 Qundefined
= intern ("undefined");
5083 staticpro (&Qundefined
);
5085 Qpre_command_hook
= intern ("pre-command-hook");
5086 staticpro (&Qpre_command_hook
);
5088 Qpost_command_hook
= intern ("post-command-hook");
5089 staticpro (&Qpost_command_hook
);
5091 Qfunction_key
= intern ("function-key");
5092 staticpro (&Qfunction_key
);
5093 Qmouse_click
= intern ("mouse-click");
5094 staticpro (&Qmouse_click
);
5096 Qmenu_enable
= intern ("menu-enable");
5097 staticpro (&Qmenu_enable
);
5099 Qmode_line
= intern ("mode-line");
5100 staticpro (&Qmode_line
);
5101 Qvertical_line
= intern ("vertical-line");
5102 staticpro (&Qvertical_line
);
5103 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
5104 staticpro (&Qvertical_scroll_bar
);
5105 Qmenu_bar
= intern ("menu-bar");
5106 staticpro (&Qmenu_bar
);
5108 Qabove_handle
= intern ("above-handle");
5109 staticpro (&Qabove_handle
);
5110 Qhandle
= intern ("handle");
5111 staticpro (&Qhandle
);
5112 Qbelow_handle
= intern ("below-handle");
5113 staticpro (&Qbelow_handle
);
5115 Qevent_kind
= intern ("event-kind");
5116 staticpro (&Qevent_kind
);
5117 Qevent_symbol_elements
= intern ("event-symbol-elements");
5118 staticpro (&Qevent_symbol_elements
);
5119 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
5120 staticpro (&Qevent_symbol_element_mask
);
5121 Qmodifier_cache
= intern ("modifier-cache");
5122 staticpro (&Qmodifier_cache
);
5124 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
5125 staticpro (&Qrecompute_lucid_menubar
);
5126 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
5127 staticpro (&Qactivate_menubar_hook
);
5130 struct event_head
*p
;
5132 for (p
= head_table
;
5133 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
5136 *p
->var
= intern (p
->name
);
5138 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
5139 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
5143 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
5144 staticpro (&button_down_location
);
5148 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
5150 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
5151 for (i
= 0; i
< len
; i
++)
5152 if (modifier_names
[i
])
5153 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
5154 staticpro (&modifier_symbols
);
5157 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
5158 staticpro (&recent_keys
);
5160 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
5161 staticpro (&this_command_keys
);
5163 kbd_buffer_frame_or_window
5164 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
5165 staticpro (&kbd_buffer_frame_or_window
);
5167 func_key_syms
= Qnil
;
5168 staticpro (&func_key_syms
);
5171 staticpro (&mouse_syms
);
5173 unread_switch_frame
= Qnil
;
5174 staticpro (&unread_switch_frame
);
5176 defsubr (&Sread_key_sequence
);
5177 defsubr (&Srecursive_edit
);
5178 defsubr (&Strack_mouse
);
5179 defsubr (&Sinput_pending_p
);
5180 defsubr (&Scommand_execute
);
5181 defsubr (&Srecent_keys
);
5182 defsubr (&Sthis_command_keys
);
5183 defsubr (&Ssuspend_emacs
);
5184 defsubr (&Sabort_recursive_edit
);
5185 defsubr (&Sexit_recursive_edit
);
5186 defsubr (&Srecursion_depth
);
5187 defsubr (&Stop_level
);
5188 defsubr (&Sdiscard_input
);
5189 defsubr (&Sopen_dribble_file
);
5190 defsubr (&Sset_input_mode
);
5191 defsubr (&Scurrent_input_mode
);
5192 defsubr (&Sexecute_extended_command
);
5194 DEFVAR_LISP ("last-command-char", &last_command_char
,
5195 "Last input event that was part of a command.");
5197 DEFVAR_LISP ("last-command-event", &last_command_char
,
5198 "Last input event that was part of a command.");
5200 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
5201 "Last input event in a command, except for mouse menu events.\n\
5202 Mouse menus give back keys that don't look like mouse events;\n\
5203 this variable holds the actual mouse event that led to the menu,\n\
5204 so that you can determine whether the command was run by mouse or not.");
5206 DEFVAR_LISP ("last-input-char", &last_input_char
,
5207 "Last input event.");
5209 DEFVAR_LISP ("last-input-event", &last_input_char
,
5210 "Last input event.");
5212 DEFVAR_LISP ("unread-command-events", &unread_command_events
,
5213 "List of objects to be read as next command input events.");
5215 DEFVAR_INT ("unread-command-char", &unread_command_char
,
5216 "If not -1, an object to be read as next command input event.");
5218 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
5219 "Meta-prefix character code. Meta-foo as command input\n\
5220 turns into this character followed by foo.");
5221 XSET (meta_prefix_char
, Lisp_Int
, 033);
5223 DEFVAR_LISP ("last-command", &last_command
,
5224 "The last command executed. Normally a symbol with a function definition,\n\
5225 but can be whatever was found in the keymap, or whatever the variable\n\
5226 `this-command' was set to by that command.");
5227 last_command
= Qnil
;
5229 DEFVAR_LISP ("this-command", &this_command
,
5230 "The command now being executed.\n\
5231 The command can set this variable; whatever is put here\n\
5232 will be in `last-command' during the following command.");
5233 this_command
= Qnil
;
5235 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
5236 "*Number of keyboard input characters between auto-saves.\n\
5237 Zero means disable autosaving due to number of characters typed.");
5238 auto_save_interval
= 300;
5240 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
5241 "*Number of seconds idle time before auto-save.\n\
5242 Zero or nil means disable auto-saving due to idleness.\n\
5243 After auto-saving due to this many seconds of idle time,\n\
5244 Emacs also does a garbage collection if that seems to be warranted.");
5245 XFASTINT (Vauto_save_timeout
) = 30;
5247 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
5248 "*Nonzero means echo unfinished commands after this many seconds of pause.");
5249 echo_keystrokes
= 1;
5251 DEFVAR_INT ("polling-period", &polling_period
,
5252 "*Interval between polling for input during Lisp execution.\n\
5253 The reason for polling is to make C-g work to stop a running program.\n\
5254 Polling is needed only when using X windows and SIGIO does not work.\n\
5255 Polling is automatically disabled in all other cases.");
5258 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
5259 "*Maximum time between mouse clicks to make a double-click.\n\
5260 Measured in milliseconds. nil means disable double-click recognition;\n\
5261 t means double-clicks have no time limit and are detected\n\
5262 by position only.");
5263 Vdouble_click_time
= make_number (500);
5265 DEFVAR_INT ("num-input-keys", &num_input_keys
,
5266 "*Number of complete keys read from the keyboard so far.");
5270 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
5271 "*The frame in which the most recently read event occurred.\n\
5272 If the last event came from a keyboard macro, this is set to `macro'.");
5273 Vlast_event_frame
= Qnil
;
5276 DEFVAR_LISP ("help-char", &Vhelp_char
,
5277 "Character to recognize as meaning Help.\n\
5278 When it is read, do `(eval help-form)', and display result if it's a string.\n\
5279 If the value of `help-form' is nil, this char can be read normally.");
5280 XSET (Vhelp_char
, Lisp_Int
, Ctl ('H'));
5282 DEFVAR_LISP ("help-form", &Vhelp_form
,
5283 "Form to execute when character `help-char' is read.\n\
5284 If the form returns a string, that string is displayed.\n\
5285 If `help-form' is nil, the help char is not recognized.");
5288 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
5289 "Command to run when `help-char' character follows a prefix key.\n\
5290 This command is used only when there is no actual binding\n\
5291 for that character after that prefix key.");
5292 Vprefix_help_command
= Qnil
;
5294 DEFVAR_LISP ("top-level", &Vtop_level
,
5295 "Form to evaluate when Emacs starts up.\n\
5296 Useful to set before you dump a modified Emacs.");
5299 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
5300 "String used as translate table for keyboard input, or nil.\n\
5301 Each character is looked up in this string and the contents used instead.\n\
5302 If string is of length N, character codes N and up are untranslated.");
5303 Vkeyboard_translate_table
= Qnil
;
5305 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
5306 "Keymap of key translations that can override keymaps.\n\
5307 This keymap works like `function-key-map', but comes after that,\n\
5308 and applies even for keys that have ordinary bindings.");
5309 Vkey_translation_map
= Qnil
;
5311 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
5312 "Non-nil means prompt with menus when appropriate.\n\
5313 This is done when reading from a keymap that has a prompt string,\n\
5314 for elements that have prompt strings.\n\
5315 The menu is displayed on the screen\n\
5316 if X menus were enabled at configuration\n\
5317 time and the previous event was a mouse click prefix key.\n\
5318 Otherwise, menu prompting uses the echo area.");
5321 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
5322 "Character to see next line of menu prompt.\n\
5323 Type this character while in a menu prompt to rotate around the lines of it.");
5324 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
5326 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
5327 "A mask of additional modifier keys to use with every keyboard character.\n\
5328 Emacs applies the modifiers of the character stored here to each keyboard\n\
5329 character it reads. For example, after evaluating the expression\n\
5330 (setq extra-keyboard-modifiers ?\C-x)\n\
5331 all input characters will have the control modifier applied to them.\n\
5333 Note that the character ?\C-@, equivalent to the integer zero, does\n\
5334 not count as a control character; rather, it counts as a character\n\
5335 with no modifiers; thus, setting extra_keyboard_modifiers to zero\n\
5336 cancels any modification.");
5337 extra_keyboard_modifiers
= 0;
5339 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
5340 "If an editing command sets this to t, deactivate the mark afterward.\n\
5341 The command loop sets this to nil before each command,\n\
5342 and tests the value when the command returns.\n\
5343 Buffer modification stores t in this variable.");
5344 Vdeactivate_mark
= Qnil
;
5346 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
5347 "Normal hook run before each command is executed.");
5348 Vpre_command_hook
= Qnil
;
5350 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
5351 "Normal hook run after each command is executed.");
5352 Vpost_command_hook
= Qnil
;
5354 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
5355 "t means menu bar, specified Lucid style, needs to be recomputed.");
5356 Vlucid_menu_bar_dirty_flag
= Qnil
;
5358 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
5359 "List of menu bar items to move to the end of the menu bar.\n\
5360 The elements of the list are event types that may have menu bar bindings.");
5361 Vmenu_bar_final_items
= Qnil
;
5366 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
5367 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
5368 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
5369 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
5370 initial_define_key (meta_map
, 'x', "execute-extended-command");