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 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
966 call0 (Qrecompute_lucid_menubar
);
968 #if 0 /* This is done in xdisp.c now. */
970 for (tem
= Vframe_list
; CONSP (tem
); tem
= XCONS (tem
)->cdr
)
972 struct frame
*f
= XFRAME (XCONS (tem
)->car
);
973 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
975 /* If the user has switched buffers or windows, we need to
976 recompute to reflect the new bindings. But we'll
977 recompute when update_mode_lines is set too; that means
978 that people can use force-mode-line-update to request
979 that the menu bar be recomputed. The adverse effect on
980 the rest of the redisplay algorithm is about the same as
981 windows_or_buffers_changed anyway. */
982 if (windows_or_buffers_changed
984 || (XFASTINT (w
->last_modified
) < MODIFF
985 && (XFASTINT (w
->last_modified
)
986 <= XBUFFER (w
->buffer
)->save_modified
)))
988 struct buffer
*prev
= current_buffer
;
989 current_buffer
= XBUFFER (w
->buffer
);
990 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items ();
991 current_buffer
= prev
;
994 #endif /* MULTI_FRAME */
997 /* Read next key sequence; i gets its length. */
998 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), 0);
1002 /* Now we have read a key sequence of length I,
1003 or else I is 0 and we found end of file. */
1005 if (i
== 0) /* End of file -- happens only in */
1006 return Qnil
; /* a kbd macro, at the end. */
1007 /* -1 means read_key_sequence got a menu that was rejected.
1008 Just loop around and read another command. */
1012 this_command_key_count
= 0;
1016 last_command_char
= keybuf
[i
- 1];
1018 /* If the previous command tried to force a specific window-start,
1019 forget about that, in case this command moves point far away
1020 from that position. */
1021 XWINDOW (selected_window
)->force_start
= Qnil
;
1023 cmd
= read_key_sequence_cmd
;
1024 if (!NILP (Vexecuting_macro
))
1026 if (!NILP (Vquit_flag
))
1028 Vexecuting_macro
= Qt
;
1029 QUIT
; /* Make some noise. */
1030 /* Will return since macro now empty. */
1034 /* Do redisplay processing after this command except in special
1035 cases identified below that set no_redisplay to 1. */
1038 prev_buffer
= current_buffer
;
1039 prev_modiff
= MODIFF
;
1041 /* Execute the command. */
1044 if (!NILP (Vpre_command_hook
))
1045 call1 (Vrun_hooks
, Qpre_command_hook
);
1047 if (NILP (this_command
))
1049 /* nil means key is undefined. */
1051 defining_kbd_macro
= 0;
1052 update_mode_lines
= 1;
1058 if (NILP (Vprefix_arg
) && ! no_direct
)
1060 /* Recognize some common commands in common situations and
1061 do them directly. */
1062 if (EQ (this_command
, Qforward_char
) && point
< ZV
)
1064 struct Lisp_Vector
*dp
1065 = window_display_table (XWINDOW (selected_window
));
1066 lose
= FETCH_CHAR (point
);
1069 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1070 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1071 : (lose
>= 0x20 && lose
< 0x7f))
1072 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1074 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1076 && !windows_or_buffers_changed
1077 && EQ (current_buffer
->selective_display
, Qnil
)
1078 && !detect_input_pending ()
1079 && NILP (Vexecuting_macro
))
1080 no_redisplay
= direct_output_forward_char (1);
1083 else if (EQ (this_command
, Qbackward_char
) && point
> BEGV
)
1085 struct Lisp_Vector
*dp
1086 = window_display_table (XWINDOW (selected_window
));
1088 lose
= FETCH_CHAR (point
);
1090 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1091 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1092 : (lose
>= 0x20 && lose
< 0x7f))
1093 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1095 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1097 && !windows_or_buffers_changed
1098 && EQ (current_buffer
->selective_display
, Qnil
)
1099 && !detect_input_pending ()
1100 && NILP (Vexecuting_macro
))
1101 no_redisplay
= direct_output_forward_char (-1);
1104 else if (EQ (this_command
, Qself_insert_command
)
1105 /* Try this optimization only on ascii keystrokes. */
1106 && XTYPE (last_command_char
) == Lisp_Int
)
1108 unsigned char c
= XINT (last_command_char
);
1110 if (NILP (Vexecuting_macro
) &&
1111 !EQ (minibuf_window
, selected_window
))
1113 if (!nonundocount
|| nonundocount
>= 20)
1120 lose
= (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1122 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1124 || MODIFF
<= current_buffer
->save_modified
1125 || windows_or_buffers_changed
1126 || !EQ (current_buffer
->selective_display
, Qnil
)
1127 || detect_input_pending ()
1128 || !NILP (Vexecuting_macro
);
1129 if (internal_self_insert (c
, 0))
1135 (point
== ZV
|| FETCH_CHAR (point
) == '\n'))
1137 struct Lisp_Vector
*dp
1138 = window_display_table (XWINDOW (selected_window
));
1143 Lisp_Object obj
= DISP_CHAR_VECTOR (dp
, lose
);
1145 if (XTYPE (obj
) == Lisp_Vector
1146 && XVECTOR (obj
)->size
== 1
1147 && (XTYPE (obj
= XVECTOR (obj
)->contents
[0])
1150 direct_output_for_insert (XINT (obj
));
1154 if (lose
>= 0x20 && lose
<= 0x7e)
1155 no_redisplay
= direct_output_for_insert (lose
);
1162 /* Here for a command that isn't executed directly */
1165 if (NILP (Vprefix_arg
))
1167 Fcommand_execute (this_command
, Qnil
);
1172 if (!NILP (Vpost_command_hook
))
1173 call1 (Vrun_hooks
, Qpost_command_hook
);
1175 /* If there is a prefix argument,
1176 1) We don't want last_command to be ``universal-argument''
1177 (that would be dumb), so don't set last_command,
1178 2) we want to leave echoing on so that the prefix will be
1179 echoed as part of this key sequence, so don't call
1181 3) we want to leave this_command_key_count non-zero, so that
1182 read_char will realize that it is re-reading a character, and
1183 not echo it a second time. */
1184 if (NILP (Vprefix_arg
))
1186 last_command
= this_command
;
1188 this_command_key_count
= 0;
1191 if (!NILP (current_buffer
->mark_active
))
1193 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1195 current_buffer
->mark_active
= Qnil
;
1196 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1198 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1199 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1204 /* Number of seconds between polling for input. */
1207 /* Nonzero means polling for input is temporarily suppressed. */
1208 int poll_suppress_count
;
1210 #ifdef POLL_FOR_INPUT
1211 int polling_for_input
;
1213 /* Handle an alarm once each second and read pending input
1214 so as to handle a C-g if it comces in. */
1217 input_poll_signal ()
1219 if (interrupt_input_blocked
== 0
1220 && !waiting_for_input
)
1221 read_avail_input (0);
1222 signal (SIGALRM
, input_poll_signal
);
1223 alarm (polling_period
);
1228 /* Begin signals to poll for input, if they are appropriate.
1229 This function is called unconditionally from various places. */
1233 #ifdef POLL_FOR_INPUT
1234 if (read_socket_hook
)
1236 poll_suppress_count
--;
1237 if (poll_suppress_count
== 0)
1239 signal (SIGALRM
, input_poll_signal
);
1240 polling_for_input
= 1;
1241 alarm (polling_period
);
1247 /* Turn off polling. */
1251 #ifdef POLL_FOR_INPUT
1252 if (read_socket_hook
)
1254 if (poll_suppress_count
== 0)
1256 polling_for_input
= 0;
1259 poll_suppress_count
++;
1264 /* Applying the control modifier to CHARACTER. */
1269 /* Save the upper bits here. */
1270 int upper
= c
& ~0177;
1274 /* Everything in the columns containing the upper-case letters
1275 denotes a control character. */
1276 if (c
>= 0100 && c
< 0140)
1280 /* Set the shift modifier for a control char
1281 made from a shifted letter. But only for letters! */
1282 if (oc
>= 'A' && oc
<= 'Z')
1283 c
|= shift_modifier
;
1286 /* The lower-case letters denote control characters too. */
1287 else if (c
>= 'a' && c
<= 'z')
1290 /* Include the bits for control and shift
1291 only if the basic ASCII code can't indicate them. */
1295 /* Replace the high bits. */
1296 c
|= (upper
& ~ctrl_modifier
);
1303 /* Input of single characters from keyboard */
1305 Lisp_Object
print_help ();
1306 static Lisp_Object
kbd_buffer_get_event ();
1308 /* read a character from the keyboard; call the redisplay if needed */
1309 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1310 -1 means do not do redisplay, but do do autosaving.
1313 /* The arguments MAPS and NMAPS are for menu prompting.
1314 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1316 PREV_EVENT is the previous input event, or nil if we are reading
1317 the first event of a key sequence.
1319 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1320 if we used a mouse menu to read the input, or zero otherwise. If
1321 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
1323 Value is t if we showed a menu and the user rejected it. */
1326 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1330 Lisp_Object prev_event
;
1331 int *used_mouse_menu
;
1333 register Lisp_Object c
;
1337 if (CONSP (unread_command_events
))
1339 c
= XCONS (unread_command_events
)->car
;
1340 unread_command_events
= XCONS (unread_command_events
)->cdr
;
1342 if (this_command_key_count
== 0)
1348 if (unread_command_char
!= -1)
1350 XSET (c
, Lisp_Int
, unread_command_char
);
1351 unread_command_char
= -1;
1353 if (this_command_key_count
== 0)
1359 if (!NILP (Vexecuting_macro
))
1362 /* We set this to Qmacro; since that's not a frame, nobody will
1363 try to switch frames on us, and the selected window will
1366 Since this event came from a macro, it would be misleading to
1367 leave internal_last_event_frame set to wherever the last
1368 real event came from. Normally, a switch-frame event selects
1369 internal_last_event_frame after each command is read, but
1370 events read from a macro should never cause a new frame to be
1372 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1375 /* Exit the macro if we are at the end.
1376 Also, some things replace the macro with t
1377 to force an early exit. */
1378 if (EQ (Vexecuting_macro
, Qt
)
1379 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1381 XSET (c
, Lisp_Int
, -1);
1385 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1386 if (XTYPE (Vexecuting_macro
) == Lisp_String
1387 && (XINT (c
) & 0x80))
1388 XFASTINT (c
) = CHAR_META
| (XINT (c
) & ~0x80);
1390 executing_macro_index
++;
1395 if (!NILP (unread_switch_frame
))
1397 c
= unread_switch_frame
;
1398 unread_switch_frame
= Qnil
;
1400 /* This event should make it into this_command_keys, and get echoed
1401 again, so we go to reread_first, rather than reread. */
1405 /* Save outer setjmp data, in case called recursively. */
1406 save_getcjmp (save_jump
);
1410 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1413 if (_setjmp (getcjmp
))
1415 XSET (c
, Lisp_Int
, quit_char
);
1417 XSET (internal_last_event_frame
, Lisp_Frame
, selected_frame
);
1418 Vlast_event_frame
= internal_last_event_frame
;
1420 /* If we report the quit char as an event,
1421 don't do so more than once. */
1422 if (!NILP (Vinhibit_quit
))
1428 /* Message turns off echoing unless more keystrokes turn it on again. */
1429 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1432 /* If already echoing, continue. */
1435 /* If in middle of key sequence and minibuffer not active,
1436 start echoing if enough time elapses. */
1437 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1438 && echo_keystrokes
> 0
1439 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1443 /* After a mouse event, start echoing right away.
1444 This is because we are probably about to display a menu,
1445 and we don't want to delay before doing so. */
1446 if (EVENT_HAS_PARAMETERS (prev_event
))
1450 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1456 /* Maybe auto save due to number of keystrokes or idle time. */
1458 if (commandflag
!= 0
1459 && auto_save_interval
> 0
1460 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1461 && !detect_input_pending ())
1464 save_getcjmp (temp
);
1465 Fdo_auto_save (Qnil
, Qnil
);
1466 restore_getcjmp (temp
);
1469 /* Try reading a character via menu prompting.
1470 Try this before the sit-for, because the sit-for
1471 would do the wrong thing if we are supposed to do
1474 if (INTERACTIVE
&& !NILP (prev_event
))
1475 c
= read_char_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1477 /* Slow down auto saves logarithmically in size of current buffer,
1478 and garbage collect while we're at it. */
1479 if (INTERACTIVE
&& NILP (c
))
1481 int delay_level
, buffer_size
;
1483 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1484 last_non_minibuf_size
= Z
- BEG
;
1485 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1487 while (buffer_size
> 64)
1488 delay_level
++, buffer_size
-= buffer_size
>> 2;
1489 if (delay_level
< 4) delay_level
= 4;
1490 /* delay_level is 4 for files under around 50k, 7 at 100k,
1491 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1493 /* Auto save if enough time goes by without input. */
1494 if (commandflag
!= 0
1495 && num_nonmacro_input_chars
> last_auto_save
1496 && XTYPE (Vauto_save_timeout
) == Lisp_Int
1497 && XINT (Vauto_save_timeout
) > 0)
1500 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1501 tem0
= sit_for (delay
, 0, 1, 1);
1505 save_getcjmp (temp
);
1506 Fdo_auto_save (Qnil
, Qnil
);
1507 restore_getcjmp (temp
);
1509 /* If we have auto-saved and there is still no input
1510 available, garbage collect if there has been enough
1511 consing going on to make it worthwhile. */
1512 if (!detect_input_pending ()
1513 && consing_since_gc
> gc_cons_threshold
/ 2)
1515 Fgarbage_collect ();
1522 /* Actually read a character, waiting if necessary. */
1525 c
= kbd_buffer_get_event ();
1528 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1532 /* Terminate Emacs in batch mode if at eof. */
1533 if (noninteractive
&& XTYPE (c
) == Lisp_Int
&& XINT (c
) < 0)
1534 Fkill_emacs (make_number (1));
1536 if (XTYPE (c
) == Lisp_Int
)
1538 /* Add in any extra modifiers, where appropriate. */
1539 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1540 || ((extra_keyboard_modifiers
& 0177) < ' '
1541 && (extra_keyboard_modifiers
& 0177) != 0))
1542 XSETINT (c
, make_ctrl_char (XINT (c
)));
1544 /* Transfer any other modifier bits directly from
1545 extra_keyboard_modifiers to c. Ignore the actual character code
1546 in the low 16 bits of extra_keyboard_modifiers. */
1547 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
1552 restore_getcjmp (save_jump
);
1556 echo_area_glyphs
= 0;
1558 /* Handle things that only apply to characters. */
1559 if (XTYPE (c
) == Lisp_Int
)
1561 /* If kbd_buffer_get_event gave us an EOF, return that. */
1565 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
1566 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1567 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1571 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1572 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1573 recent_keys_index
= 0;
1575 /* Write c to the dribble file. If c is a lispy event, write
1576 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1577 If you, dear reader, have a better idea, you've got the source. :-) */
1580 if (XTYPE (c
) == Lisp_Int
)
1581 putc (XINT (c
), dribble
);
1584 Lisp_Object dribblee
= c
;
1586 /* If it's a structured event, take the event header. */
1587 dribblee
= EVENT_HEAD (dribblee
);
1589 if (XTYPE (dribblee
) == Lisp_Symbol
)
1591 putc ('<', dribble
);
1592 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1593 XSYMBOL (dribblee
)->name
->size
,
1595 putc ('>', dribble
);
1602 store_kbd_macro_char (c
);
1604 num_nonmacro_input_chars
++;
1609 /* Record this character as part of the current key.
1610 Don't record mouse motion; it should never matter. */
1611 if (! (EVENT_HAS_PARAMETERS (c
)
1612 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1615 add_command_key (c
);
1618 /* Re-reading in the middle of a command */
1620 last_input_char
= c
;
1623 /* Process the help character specially if enabled */
1624 if (EQ (c
, Vhelp_char
) && !NILP (Vhelp_form
))
1627 count
= specpdl_ptr
- specpdl
;
1629 record_unwind_protect (Fset_window_configuration
,
1630 Fcurrent_window_configuration (Qnil
));
1632 tem0
= Feval (Vhelp_form
);
1633 if (XTYPE (tem0
) == Lisp_String
)
1634 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1637 c
= read_char (0, 0, 0, Qnil
, 0);
1638 /* Remove the help from the frame */
1639 unbind_to (count
, Qnil
);
1641 if (EQ (c
, make_number (040)))
1644 c
= read_char (0, 0, 0, Qnil
, 0);
1655 Fprinc (object
, Qnil
);
1659 /* Copy out or in the info on where C-g should throw to.
1660 This is used when running Lisp code from within get_char,
1661 in case get_char is called recursively.
1662 See read_process_output. */
1667 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1670 restore_getcjmp (temp
)
1673 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1677 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1678 of this function. */
1680 tracking_off (old_value
)
1681 Lisp_Object old_value
;
1683 if (! XFASTINT (old_value
))
1685 do_mouse_tracking
= 0;
1687 /* Redisplay may have been preempted because there was input
1688 available, and it assumes it will be called again after the
1689 input has been processed. If the only input available was
1690 the sort that we have just disabled, then we need to call
1692 if (!readable_events ())
1694 redisplay_preserve_echo_area ();
1695 get_input_pending (&input_pending
);
1700 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1701 "Evaluate BODY with mouse movement events enabled.\n\
1702 Within a `track-mouse' form, mouse motion generates input events that\n\
1703 you can read with `read-event'.\n\
1704 Normally, mouse motion is ignored.")
1708 int count
= specpdl_ptr
- specpdl
;
1711 XSET (val
, Lisp_Int
, do_mouse_tracking
);
1712 record_unwind_protect (tracking_off
, val
);
1714 do_mouse_tracking
= 1;
1716 val
= Fprogn (args
);
1717 return unbind_to (count
, val
);
1720 /* Low level keyboard/mouse input.
1721 kbd_buffer_store_event places events in kbd_buffer, and
1722 kbd_buffer_get_event retrieves them.
1723 mouse_moved indicates when the mouse has moved again, and
1724 *mouse_position_hook provides the mouse position. */
1726 /* Return true iff there are any events in the queue that read-char
1727 would return. If this returns false, a read-char would block. */
1731 return ! EVENT_QUEUES_EMPTY
;
1734 /* Set this for debugging, to have a way to get out */
1737 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
1740 kbd_buffer_store_event (event
)
1741 register struct input_event
*event
;
1743 if (event
->kind
== no_event
)
1746 if (event
->kind
== ascii_keystroke
)
1748 register int c
= XFASTINT (event
->code
) & 0377;
1750 if (event
->modifiers
& ctrl_modifier
)
1751 c
= make_ctrl_char (c
);
1753 c
|= (event
->modifiers
1754 & (meta_modifier
| alt_modifier
1755 | hyper_modifier
| super_modifier
));
1759 extern SIGTYPE
interrupt_signal ();
1762 /* If this results in a quit_char being returned to Emacs as
1763 input, set Vlast_event_frame properly. If this doesn't
1764 get returned to Emacs as an event, the next event read
1765 will set Vlast_event_frame again, so this is safe to do. */
1768 FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
1771 internal_last_event_frame
= event
->frame_or_window
;
1773 internal_last_event_frame
= focus
;
1774 Vlast_event_frame
= internal_last_event_frame
;
1778 last_event_timestamp
= event
->timestamp
;
1779 interrupt_signal ();
1783 if (c
&& c
== stop_character
)
1790 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
1791 kbd_store_ptr
= kbd_buffer
;
1793 /* Don't let the very last slot in the buffer become full,
1794 since that would make the two pointers equal,
1795 and that is indistinguishable from an empty buffer.
1796 Discard the event if it would fill the last slot. */
1797 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
1799 kbd_store_ptr
->kind
= event
->kind
;
1800 kbd_store_ptr
->code
= event
->code
;
1801 kbd_store_ptr
->part
= event
->part
;
1802 kbd_store_ptr
->frame_or_window
= event
->frame_or_window
;
1803 kbd_store_ptr
->modifiers
= event
->modifiers
;
1804 kbd_store_ptr
->x
= event
->x
;
1805 kbd_store_ptr
->y
= event
->y
;
1806 kbd_store_ptr
->timestamp
= event
->timestamp
;
1807 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
1809 = event
->frame_or_window
);
1815 /* Read one event from the event buffer, waiting if necessary.
1816 The value is a Lisp object representing the event.
1817 The value is nil for an event that should be ignored,
1818 or that was handled here.
1819 We always read and discard one event. */
1822 kbd_buffer_get_event ()
1830 XSET (obj
, Lisp_Int
, c
);
1834 /* Wait until there is input available. */
1837 if (!EVENT_QUEUES_EMPTY
)
1840 /* If the quit flag is set, then read_char will return
1841 quit_char, so that counts as "available input." */
1842 if (!NILP (Vquit_flag
))
1843 quit_throw_to_read_char ();
1845 /* One way or another, wait until input is available; then, if
1846 interrupt handlers have not read it, read it now. */
1849 wait_for_kbd_input ();
1851 /* Note SIGIO has been undef'd if FIONREAD is missing. */
1855 if (EVENT_QUEUES_EMPTY
)
1857 Lisp_Object minus_one
;
1859 XSET (minus_one
, Lisp_Int
, -1);
1860 wait_reading_process_input (0, 0, minus_one
, 1);
1862 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
1864 read_avail_input (0);
1867 #endif /* not VMS */
1870 /* At this point, we know that there is a readable event available
1871 somewhere. If the event queue is empty, then there must be a
1872 mouse movement enabled and available. */
1873 if (kbd_fetch_ptr
!= kbd_store_ptr
)
1875 struct input_event
*event
;
1877 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
1881 last_event_timestamp
= event
->timestamp
;
1885 /* These two kinds of events get special handling
1886 and don't actually appear to the command loop.
1887 We return nil for them. */
1888 if (event
->kind
== selection_request_event
)
1891 x_handle_selection_request (event
);
1892 kbd_fetch_ptr
= event
+ 1;
1894 /* We're getting selection request events, but we don't have
1900 else if (event
->kind
== selection_clear_event
)
1903 x_handle_selection_clear (event
);
1904 kbd_fetch_ptr
= event
+ 1;
1906 /* We're getting selection request events, but we don't have
1911 /* Just discard these, by returning nil.
1912 (They shouldn't be found in the buffer,
1913 but on some machines it appears they do show up.) */
1914 else if (event
->kind
== no_event
)
1915 kbd_fetch_ptr
= event
+ 1;
1917 /* If this event is on a different frame, return a switch-frame this
1918 time, and leave the event in the queue for next time. */
1922 Lisp_Object frame
= event
->frame_or_window
;
1925 if (XTYPE (frame
) == Lisp_Window
)
1926 frame
= WINDOW_FRAME (XWINDOW (frame
));
1928 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
1932 if (! EQ (frame
, internal_last_event_frame
)
1933 && XFRAME (frame
) != selected_frame
)
1934 obj
= make_lispy_switch_frame (frame
);
1935 internal_last_event_frame
= frame
;
1936 #endif /* MULTI_FRAME */
1938 /* If we didn't decide to make a switch-frame event, go ahead
1939 and build a real event from the queue entry. */
1943 obj
= make_lispy_event (event
);
1945 /* Wipe out this event, to catch bugs. */
1946 event
->kind
= no_event
;
1947 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
1950 kbd_fetch_ptr
= event
+ 1;
1954 /* Try generating a mouse motion event. */
1955 else if (do_mouse_tracking
&& mouse_moved
)
1958 Lisp_Object bar_window
;
1959 enum scroll_bar_part part
;
1963 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
1968 /* Decide if we should generate a switch-frame event. Don't
1969 generate switch-frame events for motion outside of all Emacs
1973 Lisp_Object frame
= FRAME_FOCUS_FRAME (f
);
1976 XSET (frame
, Lisp_Frame
, f
);
1978 if (! EQ (frame
, internal_last_event_frame
)
1979 && XFRAME (frame
) != selected_frame
)
1980 obj
= make_lispy_switch_frame (frame
);
1981 internal_last_event_frame
= frame
;
1985 /* If we didn't decide to make a switch-frame event, go ahead and
1986 return a mouse-motion event. */
1988 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
1991 /* We were promised by the above while loop that there was
1992 something for us to read! */
1995 input_pending
= readable_events ();
1998 Vlast_event_frame
= internal_last_event_frame
;
2004 /* Process any events that are not user-visible,
2005 then return, without reading any user-visible events. */
2010 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2012 struct input_event
*event
;
2014 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2018 last_event_timestamp
= event
->timestamp
;
2020 /* These two kinds of events get special handling
2021 and don't actually appear to the command loop. */
2022 if (event
->kind
== selection_request_event
)
2025 x_handle_selection_request (event
);
2026 kbd_fetch_ptr
= event
+ 1;
2028 /* We're getting selection request events, but we don't have
2034 else if (event
->kind
== selection_clear_event
)
2037 x_handle_selection_clear (event
);
2038 kbd_fetch_ptr
= event
+ 1;
2040 /* We're getting selection request events, but we don't have
2049 get_input_pending (&input_pending
);
2052 /* Caches for modify_event_symbol. */
2053 static Lisp_Object func_key_syms
;
2054 static Lisp_Object mouse_syms
;
2056 /* You'll notice that this table is arranged to be conveniently
2057 indexed by X Windows keysym values. */
2058 static char *lispy_function_keys
[] =
2060 /* X Keysym value */
2062 "remove", 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2070 0, 0, 0, /* 0xff10 */
2072 0, 0, 0, 0, 0, 0, 0,
2075 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2076 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2077 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2079 "home", /* 0xff50 */ /* IsCursorKey */
2090 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2101 "break", /* 0xff6b */
2103 /* Here are some keys found mostly on HP keyboards. The X event
2104 handling code will strip bit 29, which flags vendor-specific
2106 "reset", /* 0x1000ff6c */
2115 "kp-backtab", /* 0x1000ff75 */
2117 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2118 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2119 0, 0, 0, 0, 0, 0, 0, 0,
2120 "kp-tab", /* 0xff89 */
2122 "kp-enter", /* 0xff8d */
2124 "kp-f1", /* 0xff91 */
2129 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2130 "kp-multiply", /* 0xffaa */
2135 "kp-divide", /* 0xffaf */
2136 "kp-0", /* 0xffb0 */
2137 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2140 "kp-equal", /* 0xffbd */
2141 "f1", /* 0xffbe */ /* IsFunctionKey */
2143 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2144 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2145 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2146 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2147 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2148 0, 0, 0, 0, 0, 0, 0, 0,
2149 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2150 0, 0, 0, 0, 0, 0, 0, "delete"
2153 static char *lispy_mouse_names
[] =
2155 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2158 /* Scroll bar parts. */
2159 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2161 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2162 Lisp_Object
*scroll_bar_parts
[] = {
2163 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2167 /* A vector, indexed by button number, giving the down-going location
2168 of currently depressed buttons, both scroll bar and non-scroll bar.
2170 The elements have the form
2171 (BUTTON-NUMBER MODIFIER-MASK . REST)
2172 where REST is the cdr of a position as it would be reported in the event.
2174 The make_lispy_event function stores positions here to tell the
2175 difference between click and drag events, and to store the starting
2176 location to be included in drag events. */
2178 static Lisp_Object button_down_location
;
2180 /* Information about the most recent up-going button event: Which
2181 button, what location, and what time. */
2183 static int button_up_button
;
2184 static int button_up_x
;
2185 static int button_up_y
;
2186 static unsigned long button_up_time
;
2188 /* The maximum time between clicks to make a double-click,
2189 or Qnil to disable double-click detection,
2190 or Qt for no time limit. */
2191 Lisp_Object Vdouble_click_time
;
2193 /* The number of clicks in this multiple-click. */
2195 int double_click_count
;
2197 /* Given a struct input_event, build the lisp event which represents
2198 it. If EVENT is 0, build a mouse movement event from the mouse
2199 movement buffer, which should have a movement event in it.
2201 Note that events must be passed to this function in the order they
2202 are received; this function stores the location of button presses
2203 in order to build drag events when the button is released. */
2206 make_lispy_event (event
)
2207 struct input_event
*event
;
2209 #ifdef SWITCH_ENUM_BUG
2210 switch ((int) event
->kind
)
2212 switch (event
->kind
)
2215 /* A simple keystroke. */
2216 case ascii_keystroke
:
2218 int c
= XFASTINT (event
->code
);
2219 /* Turn ASCII characters into control characters
2221 if (event
->modifiers
& ctrl_modifier
)
2222 c
= make_ctrl_char (c
);
2224 /* Add in the other modifier bits. We took care of ctrl_modifier
2225 just above, and the shift key was taken care of by the X code,
2226 and applied to control characters by make_ctrl_char. */
2227 c
|= (event
->modifiers
2228 & (meta_modifier
| alt_modifier
2229 | hyper_modifier
| super_modifier
));
2234 /* A function key. The symbol may need to have modifier prefixes
2236 case non_ascii_keystroke
:
2238 return modify_event_symbol (XFASTINT (event
->code
), event
->modifiers
,
2240 lispy_function_keys
, &func_key_syms
,
2241 (sizeof (lispy_function_keys
)
2242 / sizeof (lispy_function_keys
[0])));
2245 /* A mouse click. Figure out where it is, decide whether it's
2246 a press, click or drag, and build the appropriate structure. */
2248 case scroll_bar_click
:
2250 int button
= XFASTINT (event
->code
);
2251 Lisp_Object position
;
2252 Lisp_Object
*start_pos_ptr
;
2253 Lisp_Object start_pos
;
2255 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2258 /* Build the position as appropriate for this mouse click. */
2259 if (event
->kind
== mouse_click
)
2262 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2264 = window_from_coordinates (f
, XINT (event
->x
), XINT (event
->y
),
2268 if (XINT (event
->y
) < FRAME_MENU_BAR_LINES (f
))
2272 items
= FRAME_MENU_BAR_ITEMS (f
);
2273 for (; CONSP (items
); items
= XCONS (items
)->cdr
)
2275 Lisp_Object pos
, string
;
2276 pos
= Fcdr (Fcdr (Fcar (items
)));
2277 string
= Fcar (Fcdr (Fcar (items
)));
2278 if (XINT (event
->x
) >= XINT (pos
)
2279 && XINT (event
->x
) < XINT (pos
) + XSTRING (string
)->size
)
2283 = Fcons (event
->frame_or_window
,
2285 Fcons (Fcons (event
->x
, event
->y
),
2286 Fcons (make_number (event
->timestamp
),
2290 return Fcons (Fcar (Fcar (items
)),
2291 Fcons (position
, Qnil
));
2293 return Fcons (Qnil
, Fcons (position
, Qnil
));
2295 else if (XTYPE (window
) != Lisp_Window
)
2300 (XINT (event
->x
) - XINT (XWINDOW (window
)->left
)));
2302 (XINT (event
->y
) - XINT (XWINDOW (window
)->top
)));
2307 posn
= Qvertical_line
;
2309 XSET (posn
, Lisp_Int
,
2310 buffer_posn_from_coords (XWINDOW (window
),
2318 Fcons (Fcons (event
->x
, event
->y
),
2319 Fcons (make_number (event
->timestamp
),
2324 Lisp_Object window
= event
->frame_or_window
;
2325 Lisp_Object portion_whole
= Fcons (event
->x
, event
->y
);
2326 Lisp_Object part
= *scroll_bar_parts
[(int) event
->part
];
2330 Fcons (Qvertical_scroll_bar
,
2331 Fcons (portion_whole
,
2332 Fcons (make_number (event
->timestamp
),
2337 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2339 start_pos
= *start_pos_ptr
;
2340 *start_pos_ptr
= Qnil
;
2342 /* If this is a button press, squirrel away the location, so
2343 we can decide later whether it was a click or a drag. */
2344 if (event
->modifiers
& down_modifier
)
2345 *start_pos_ptr
= Fcopy_alist (position
);
2347 /* Now we're releasing a button - check the co-ordinates to
2348 see if this was a click or a drag. */
2349 else if (event
->modifiers
& up_modifier
)
2351 /* If we did not see a down before this up,
2352 ignore the up. Probably this happened because
2353 the down event chose a menu item.
2354 It would be an annoyance to treat the release
2355 of the button that chose the menu item
2356 as a separate event. */
2358 if (XTYPE (start_pos
) != Lisp_Cons
)
2361 event
->modifiers
&= ~up_modifier
;
2362 #if 0 /* Formerly we treated an up with no down as a click event. */
2363 if (XTYPE (start_pos
) != Lisp_Cons
)
2364 event
->modifiers
|= click_modifier
;
2368 /* The third element of every position should be the (x,y)
2370 Lisp_Object down
= Fnth (make_number (2), start_pos
);
2372 if (EQ (event
->x
, XCONS (down
)->car
)
2373 && EQ (event
->y
, XCONS (down
)->cdr
))
2375 if (button
== button_up_button
2376 && XINT (event
->x
) == button_up_x
2377 && XINT (event
->y
) == button_up_y
2378 && button_up_time
!= 0
2379 && (EQ (Vdouble_click_time
, Qt
)
2380 || (INTEGERP (Vdouble_click_time
)
2381 && ((int)(event
->timestamp
- button_up_time
)
2382 < XINT (Vdouble_click_time
)))))
2384 double_click_count
++;
2385 event
->modifiers
|= ((double_click_count
> 2)
2391 double_click_count
= 1;
2392 event
->modifiers
|= click_modifier
;
2394 button_up_button
= button
;
2395 button_up_x
= XINT (event
->x
);
2396 button_up_y
= XINT (event
->y
);
2397 button_up_time
= event
->timestamp
;
2402 event
->modifiers
|= drag_modifier
;
2407 /* Every mouse event should either have the down_modifier or
2408 the up_modifier set. */
2412 /* Get the symbol we should use for the mouse click. */
2414 = modify_event_symbol (button
,
2417 lispy_mouse_names
, &mouse_syms
,
2418 (sizeof (lispy_mouse_names
)
2419 / sizeof (lispy_mouse_names
[0])));
2421 if (event
->modifiers
& drag_modifier
)
2426 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2429 Fcons (make_number (double_click_count
),
2438 /* The 'kind' field of the event is something we don't recognize. */
2445 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2447 Lisp_Object bar_window
;
2448 enum scroll_bar_part part
;
2452 /* Is it a scroll bar movement? */
2453 if (frame
&& ! NILP (bar_window
))
2455 Lisp_Object part_sym
= *scroll_bar_parts
[(int) part
];
2457 return Fcons (Qscroll_bar_movement
,
2458 (Fcons (Fcons (bar_window
,
2459 Fcons (Qvertical_scroll_bar
,
2460 Fcons (Fcons (x
, y
),
2461 Fcons (make_number (time
),
2467 /* Or is it an ordinary mouse movement? */
2471 Lisp_Object window
=
2473 ? window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
)
2477 if (XTYPE (window
) == Lisp_Window
)
2479 XSETINT (x
, XINT (x
) - XINT (XWINDOW (window
)->left
));
2480 XSETINT (y
, XINT (y
) - XINT (XWINDOW (window
)->top
));
2485 posn
= Qvertical_line
;
2487 XSET (posn
, Lisp_Int
,
2488 buffer_posn_from_coords (XWINDOW (window
),
2489 XINT (x
), XINT (y
)));
2499 return Fcons (Qmouse_movement
,
2500 Fcons (Fcons (window
,
2502 Fcons (Fcons (x
, y
),
2503 Fcons (make_number (time
),
2509 /* Construct a switch frame event. */
2511 make_lispy_switch_frame (frame
)
2514 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
2517 /* Manipulating modifiers. */
2519 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
2521 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2522 SYMBOL's name of the end of the modifiers; the string from this
2523 position is the unmodified symbol name.
2525 This doesn't use any caches. */
2527 parse_modifiers_uncached (symbol
, modifier_end
)
2531 struct Lisp_String
*name
;
2535 CHECK_SYMBOL (symbol
, 1);
2538 name
= XSYMBOL (symbol
)->name
;
2541 for (i
= 0; i
+2 <= name
->size
; )
2542 switch (name
->data
[i
])
2544 #define SINGLE_LETTER_MOD(bit) \
2545 if (name->data[i+1] != '-') \
2546 goto no_more_modifiers; \
2551 SINGLE_LETTER_MOD (alt_modifier
);
2555 SINGLE_LETTER_MOD (ctrl_modifier
);
2559 SINGLE_LETTER_MOD (hyper_modifier
);
2563 SINGLE_LETTER_MOD (meta_modifier
);
2567 SINGLE_LETTER_MOD (shift_modifier
);
2571 SINGLE_LETTER_MOD (super_modifier
);
2575 if (i
+ 5 > name
->size
)
2576 goto no_more_modifiers
;
2577 if (! strncmp (name
->data
+ i
, "drag-", 5))
2579 modifiers
|= drag_modifier
;
2582 else if (! strncmp (name
->data
+ i
, "down-", 5))
2584 modifiers
|= down_modifier
;
2587 else if (i
+ 7 <= name
->size
2588 && ! strncmp (name
->data
+ i
, "double-", 7))
2590 modifiers
|= double_modifier
;
2594 goto no_more_modifiers
;
2598 if (i
+ 7 > name
->size
)
2599 goto no_more_modifiers
;
2600 if (! strncmp (name
->data
+ i
, "triple-", 7))
2602 modifiers
|= triple_modifier
;
2606 goto no_more_modifiers
;
2610 goto no_more_modifiers
;
2612 #undef SINGLE_LETTER_MOD
2616 /* Should we include the `click' modifier? */
2617 if (! (modifiers
& (down_modifier
| drag_modifier
2618 | double_modifier
| triple_modifier
))
2619 && i
+ 7 == name
->size
2620 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
2621 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
2622 modifiers
|= click_modifier
;
2631 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
2632 prepended to the string BASE[0..BASE_LEN-1].
2633 This doesn't use any caches. */
2635 apply_modifiers_uncached (modifiers
, base
, base_len
)
2640 /* Since BASE could contain nulls, we can't use intern here; we have
2641 to use Fintern, which expects a genuine Lisp_String, and keeps a
2644 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
2650 /* Only the event queue may use the `up' modifier; it should always
2651 be turned into a click or drag event before presented to lisp code. */
2652 if (modifiers
& up_modifier
)
2655 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
2656 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
2657 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
2658 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
2659 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
2660 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
2661 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
2662 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
2663 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
2664 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
2665 /* The click modifier is denoted by the absence of other modifiers. */
2669 mod_len
= p
- new_mods
;
2673 Lisp_Object new_name
= make_uninit_string (mod_len
+ base_len
);
2675 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
2676 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
2678 return Fintern (new_name
, Qnil
);
2683 static char *modifier_names
[] =
2685 "up", "down", "drag", "click", "double", "triple", 0, 0,
2686 0, 0, 0, 0, 0, 0, 0, 0,
2687 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
2689 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
2691 static Lisp_Object modifier_symbols
;
2693 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
2695 lispy_modifier_list (modifiers
)
2698 Lisp_Object modifier_list
;
2701 modifier_list
= Qnil
;
2702 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
2703 if (modifiers
& (1<<i
))
2704 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
2707 return modifier_list
;
2711 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
2712 where UNMODIFIED is the unmodified form of SYMBOL,
2713 MASK is the set of modifiers present in SYMBOL's name.
2714 This is similar to parse_modifiers_uncached, but uses the cache in
2715 SYMBOL's Qevent_symbol_element_mask property, and maintains the
2716 Qevent_symbol_elements property. */
2718 parse_modifiers (symbol
)
2721 Lisp_Object elements
= Fget (symbol
, Qevent_symbol_element_mask
);
2723 if (CONSP (elements
))
2728 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
2729 Lisp_Object unmodified
2730 = Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
2731 XSYMBOL (symbol
)->name
->size
- end
),
2735 if (modifiers
& ~((1<<VALBITS
) - 1))
2737 XFASTINT (mask
) = modifiers
;
2738 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
2740 /* Cache the parsing results on SYMBOL. */
2741 Fput (symbol
, Qevent_symbol_element_mask
,
2743 Fput (symbol
, Qevent_symbol_elements
,
2744 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
2746 /* Since we know that SYMBOL is modifiers applied to unmodified,
2747 it would be nice to put that in unmodified's cache.
2748 But we can't, since we're not sure that parse_modifiers is
2755 /* Apply the modifiers MODIFIERS to the symbol BASE.
2756 BASE must be unmodified.
2758 This is like apply_modifiers_uncached, but uses BASE's
2759 Qmodifier_cache property, if present. It also builds
2760 Qevent_symbol_elements properties, since it has that info anyway.
2762 apply_modifiers copies the value of BASE's Qevent_kind property to
2763 the modified symbol. */
2765 apply_modifiers (modifiers
, base
)
2769 Lisp_Object cache
, index
, entry
, new_symbol
;
2771 /* Mask out upper bits. We don't know where this value's been. */
2772 modifiers
&= (1<<VALBITS
) - 1;
2774 /* The click modifier never figures into cache indices. */
2775 cache
= Fget (base
, Qmodifier_cache
);
2776 XFASTINT (index
) = (modifiers
& ~click_modifier
);
2777 entry
= Fassq (index
, cache
);
2780 new_symbol
= XCONS (entry
)->cdr
;
2783 /* We have to create the symbol ourselves. */
2784 new_symbol
= apply_modifiers_uncached (modifiers
,
2785 XSYMBOL (base
)->name
->data
,
2786 XSYMBOL (base
)->name
->size
);
2788 /* Add the new symbol to the base's cache. */
2789 entry
= Fcons (index
, new_symbol
);
2790 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
2792 /* We have the parsing info now for free, so add it to the caches. */
2793 XFASTINT (index
) = modifiers
;
2794 Fput (new_symbol
, Qevent_symbol_element_mask
,
2795 Fcons (base
, Fcons (index
, Qnil
)));
2796 Fput (new_symbol
, Qevent_symbol_elements
,
2797 Fcons (base
, lispy_modifier_list (modifiers
)));
2800 /* Make sure this symbol is of the same kind as BASE.
2802 You'd think we could just set this once and for all when we
2803 intern the symbol above, but reorder_modifiers may call us when
2804 BASE's property isn't set right; we can't assume that just
2805 because it has a Qmodifier_cache property it must have its
2806 Qevent_kind set right as well. */
2807 if (NILP (Fget (new_symbol
, Qevent_kind
)))
2809 Lisp_Object kind
= Fget (base
, Qevent_kind
);
2812 Fput (new_symbol
, Qevent_kind
, kind
);
2819 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
2820 return a symbol with the modifiers placed in the canonical order.
2821 Canonical order is alphabetical, except for down and drag, which
2822 always come last. The 'click' modifier is never written out.
2824 Fdefine_key calls this to make sure that (for example) C-M-foo
2825 and M-C-foo end up being equivalent in the keymap. */
2828 reorder_modifiers (symbol
)
2831 /* It's hopefully okay to write the code this way, since everything
2832 will soon be in caches, and no consing will be done at all. */
2833 Lisp_Object parsed
= parse_modifiers (symbol
);
2835 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
2836 XCONS (parsed
)->car
);
2840 /* For handling events, we often want to produce a symbol whose name
2841 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
2842 to some base, like the name of a function key or mouse button.
2843 modify_event_symbol produces symbols of this sort.
2845 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
2846 is the name of the i'th symbol. TABLE_SIZE is the number of elements
2849 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
2850 persist between calls to modify_event_symbol that it can use to
2851 store a cache of the symbols it's generated for this NAME_TABLE
2854 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
2856 MODIFIERS is a set of modifier bits (as given in struct input_events)
2857 whose prefixes should be applied to the symbol name.
2859 SYMBOL_KIND is the value to be placed in the event_kind property of
2860 the returned symbol.
2862 The symbols we create are supposed to have an
2863 `event-symbol-elements' property, which lists the modifiers present
2864 in the symbol's name. */
2867 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_table
,
2868 symbol_table
, table_size
)
2871 Lisp_Object symbol_kind
;
2873 Lisp_Object
*symbol_table
;
2878 /* Is this a request for a valid symbol? */
2879 if (symbol_num
< 0 || symbol_num
>= table_size
)
2882 /* If *symbol_table doesn't seem to be initialized properly, fix that.
2883 *symbol_table should be a lisp vector TABLE_SIZE elements long,
2884 where the Nth element is the symbol for NAME_TABLE[N], or nil if
2885 we've never used that symbol before. */
2886 if (XTYPE (*symbol_table
) != Lisp_Vector
2887 || XVECTOR (*symbol_table
)->size
!= table_size
)
2891 XFASTINT (size
) = table_size
;
2892 *symbol_table
= Fmake_vector (size
, Qnil
);
2895 slot
= & XVECTOR (*symbol_table
)->contents
[symbol_num
];
2897 /* Have we already used this symbol before? */
2900 /* No; let's create it. */
2901 if (name_table
[symbol_num
])
2902 *slot
= intern (name_table
[symbol_num
]);
2906 sprintf (buf
, "key-%d", symbol_num
);
2907 *slot
= intern (buf
);
2910 /* Fill in the cache entries for this symbol; this also
2911 builds the Qevent_symbol_elements property, which the user
2913 apply_modifiers (modifiers
& click_modifier
, *slot
);
2914 Fput (*slot
, Qevent_kind
, symbol_kind
);
2917 /* Apply modifiers to that symbol. */
2918 return apply_modifiers (modifiers
, *slot
);
2922 /* Store into *addr a value nonzero if terminal input chars are available.
2923 Serves the purpose of ioctl (0, FIONREAD, addr)
2924 but works even if FIONREAD does not exist.
2925 (In fact, this may actually read some input.) */
2928 get_input_pending (addr
)
2931 /* First of all, have we already counted some input? */
2932 *addr
= !NILP (Vquit_flag
) || readable_events ();
2934 /* If input is being read as it arrives, and we have none, there is none. */
2935 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
2938 /* Try to read some input and see how much we get. */
2940 *addr
= !NILP (Vquit_flag
) || readable_events ();
2943 /* Interface to read_avail_input, blocking SIGIO if necessary. */
2946 gobble_input (expected
)
2951 if (interrupt_input
)
2954 mask
= sigblockx (SIGIO
);
2955 read_avail_input (expected
);
2960 read_avail_input (expected
);
2966 /* Read any terminal input already buffered up by the system
2967 into the kbd_buffer, but do not wait.
2969 EXPECTED should be nonzero if the caller knows there is some input.
2971 Except on VMS, all input is read by this function.
2972 If interrupt_input is nonzero, this function MUST be called
2973 only when SIGIO is blocked.
2975 Returns the number of keyboard chars read, or -1 meaning
2976 this is a bad time to try to read input. */
2979 read_avail_input (expected
)
2982 struct input_event buf
[KBD_BUFFER_SIZE
];
2986 if (read_socket_hook
)
2987 /* No need for FIONREAD or fcntl; just say don't wait. */
2988 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
2991 unsigned char cbuf
[KBD_BUFFER_SIZE
];
2994 /* Find out how much input is available. */
2995 if (ioctl (0, FIONREAD
, &nread
) < 0)
2996 /* Formerly simply reported no input, but that sometimes led to
2997 a failure of Emacs to terminate.
2998 SIGHUP seems appropriate if we can't reach the terminal. */
2999 /* ??? Is it really right to send the signal just to this process
3000 rather than to the whole process group?
3001 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3002 kill (getpid (), SIGHUP
);
3005 if (nread
> sizeof cbuf
)
3006 nread
= sizeof cbuf
;
3007 #else /* no FIONREAD */
3009 /* Read some input if available, but don't wait. */
3010 nread
= sizeof cbuf
;
3011 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
3017 /* Now read; for one reason or another, this will not block. */
3020 nread
= read (fileno (stdin
), cbuf
, nread
);
3022 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3023 This looks incorrect, but it isn't, because _BSD causes
3024 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3025 and that causes a value other than 0 when there is no input. */
3029 /* Retry the read if it is interrupted. */
3031 || ! (errno
== EAGAIN
|| errno
== EFAULT
3041 fcntl (fileno (stdin
), F_SETFL
, 0);
3043 #endif /* no FIONREAD */
3044 for (i
= 0; i
< nread
; i
++)
3046 buf
[i
].kind
= ascii_keystroke
;
3047 buf
[i
].modifiers
= 0;
3048 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3049 buf
[i
].modifiers
= meta_modifier
;
3053 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
3055 XSET (buf
[i
].frame_or_window
, Lisp_Frame
, selected_frame
);
3057 buf
[i
].frame_or_window
= Qnil
;
3062 /* Scan the chars for C-g and store them in kbd_buffer. */
3063 for (i
= 0; i
< nread
; i
++)
3065 kbd_buffer_store_event (&buf
[i
]);
3066 /* Don't look at input that follows a C-g too closely.
3067 This reduces lossage due to autorepeat on C-g. */
3068 if (buf
[i
].kind
== ascii_keystroke
3069 && XINT(buf
[i
].code
) == quit_char
)
3075 #endif /* not VMS */
3077 #ifdef SIGIO /* for entire page */
3078 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3081 input_available_signal (signo
)
3084 /* Must preserve main program's value of errno. */
3085 int old_errno
= errno
;
3087 extern int select_alarmed
;
3091 /* USG systems forget handlers when they are used;
3092 must reestablish each time */
3093 signal (signo
, input_available_signal
);
3100 if (input_available_clear_time
)
3101 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3106 nread
= read_avail_input (1);
3107 /* -1 means it's not ok to read the input now.
3108 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3109 0 means there was no keyboard input available. */
3114 select_alarmed
= 1; /* Force the select emulator back to life */
3125 /* Send ourselves a SIGIO.
3127 This function exists so that the UNBLOCK_INPUT macro in
3128 blockinput.h can have some way to take care of input we put off
3129 dealing with, without assuming that every file which uses
3130 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3132 reinvoke_input_signal ()
3141 /* Return the prompt-string of a sparse keymap.
3142 This is the first element which is a string.
3143 Return nil if there is none. */
3151 register Lisp_Object tem
;
3153 if (XTYPE (tem
) == Lisp_String
)
3160 static Lisp_Object
menu_bar_item ();
3161 static Lisp_Object
menu_bar_one_keymap ();
3163 /* Return a list of menu items for a menu bar, appropriate
3164 to the current buffer.
3165 The elements have the form (KEY STRING . nil). */
3170 /* The number of keymaps we're scanning right now, and the number of
3171 keymaps we have allocated space for. */
3174 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3175 in the current keymaps, or nil where it is not a prefix. */
3178 Lisp_Object def
, tem
, tail
;
3185 /* In order to build the menus, we need to call the keymap
3186 accessors. They all call QUIT. But this function is called
3187 during redisplay, during which a quit is fatal. So inhibit
3188 quitting while building the menus.
3189 We do this instead of specbind because (1) errors will clear it anyway
3190 and (2) this avoids risk of specpdl overflow. */
3191 oquit
= Vinhibit_quit
;
3194 /* Build our list of keymaps.
3195 If we recognize a function key and replace its escape sequence in
3196 keybuf with its symbol, or if the sequence starts with a mouse
3197 click and we need to switch buffers, we jump back here to rebuild
3198 the initial keymaps from the current buffer. */
3202 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3203 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3204 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3205 #ifdef USE_TEXT_PROPERTIES
3206 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3208 maps
[nmaps
-2] = current_buffer
->keymap
;
3210 maps
[nmaps
-1] = current_global_map
;
3213 /* Look up in each map the dummy prefix key `menu-bar'. */
3217 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3219 if (! NILP (maps
[mapno
]))
3220 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3224 tem
= Fkeymapp (def
);
3226 result
= menu_bar_one_keymap (def
, result
);
3229 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3233 elt
= Fassq (XCONS (tail
)->car
, result
);
3235 result
= Fcons (elt
, Fdelq (elt
, result
));
3238 result
= Fnreverse (result
);
3239 Vinhibit_quit
= oquit
;
3243 /* Scan one map KEYMAP, accumulating any menu items it defines
3244 that have not yet been seen in RESULT. Return the updated RESULT. */
3247 menu_bar_one_keymap (keymap
, result
)
3248 Lisp_Object keymap
, result
;
3250 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3252 /* Loop over all keymap entries that have menu strings. */
3253 for (tail
= keymap
; XTYPE (tail
) == Lisp_Cons
; tail
= XCONS (tail
)->cdr
)
3255 item
= XCONS (tail
)->car
;
3256 if (XTYPE (item
) == Lisp_Cons
)
3258 key
= XCONS (item
)->car
;
3259 binding
= XCONS (item
)->cdr
;
3260 if (XTYPE (binding
) == Lisp_Cons
)
3262 item_string
= XCONS (binding
)->car
;
3263 if (XTYPE (item_string
) == Lisp_String
)
3264 result
= menu_bar_item (key
, item_string
,
3265 Fcdr (binding
), result
);
3267 else if (EQ (binding
, Qundefined
))
3268 result
= menu_bar_item (key
, item_string
,
3271 else if (XTYPE (item
) == Lisp_Vector
)
3273 /* Loop over the char values represented in the vector. */
3274 int len
= XVECTOR (item
)->size
;
3276 for (c
= 0; c
< len
; c
++)
3278 Lisp_Object character
;
3279 XFASTINT (character
) = c
;
3280 binding
= XVECTOR (item
)->contents
[c
];
3281 if (XTYPE (binding
) == Lisp_Cons
)
3283 item_string
= XCONS (binding
)->car
;
3284 if (XTYPE (item_string
) == Lisp_String
)
3285 result
= menu_bar_item (key
, item_string
,
3286 Fcdr (binding
), result
);
3288 else if (EQ (binding
, Qundefined
))
3289 result
= menu_bar_item (key
, item_string
,
3299 menu_bar_item (key
, item_string
, def
, result
)
3300 Lisp_Object key
, item_string
, def
, result
;
3303 Lisp_Object enabled
;
3305 if (EQ (def
, Qundefined
))
3307 /* If a map has an explicit nil as definition,
3308 discard any previously made menu bar item. */
3309 tem
= Fassq (key
, result
);
3310 return Fdelq (tem
, result
);
3313 /* See if this entry is enabled. */
3316 if (XTYPE (def
) == Lisp_Symbol
)
3318 /* No property, or nil, means enable.
3319 Otherwise, enable if value is not nil. */
3320 tem
= Fget (def
, Qmenu_enable
);
3322 enabled
= Feval (tem
);
3325 /* Add an entry for this key and string
3326 if there is none yet. */
3327 tem
= Fassq (key
, result
);
3328 if (!NILP (enabled
) && NILP (tem
))
3329 result
= Fcons (Fcons (key
, Fcons (item_string
, Qnil
)), result
);
3334 static int echo_flag
;
3335 static int echo_now
;
3337 /* Read a character using menus based on maps in the array MAPS.
3338 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
3339 Return t if we displayed a menu but the user rejected it.
3341 PREV_EVENT is the previous input event, or nil if we are reading
3342 the first event of a key sequence.
3344 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3345 if we used a mouse menu to read the input, or zero otherwise. If
3346 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
3348 The prompting is done based on the prompt-string of the map
3349 and the strings associated with various map elements. */
3352 read_char_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
3355 Lisp_Object prev_event
;
3356 int *used_mouse_menu
;
3359 register Lisp_Object name
;
3361 int width
= FRAME_WIDTH (selected_frame
) - 4;
3362 char *menu
= (char *) alloca (width
+ 4);
3364 Lisp_Object rest
, vector
;
3366 if (used_mouse_menu
)
3367 *used_mouse_menu
= 0;
3369 /* Use local over global Menu maps */
3371 if (! menu_prompting
)
3374 /* Get the menu name from the first map that has one (a prompt string). */
3375 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3377 name
= map_prompt (maps
[mapno
]);
3382 /* If we don't have any menus, just read a character normally. */
3386 #ifdef HAVE_X_WINDOWS
3388 /* If we got to this point via a mouse click,
3389 use a real menu for mouse selection. */
3390 if (EVENT_HAS_PARAMETERS (prev_event
))
3392 /* Display the menu and get the selection. */
3393 Lisp_Object
*realmaps
3394 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
3398 /* Use the maps that are not nil. */
3399 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3400 if (!NILP (maps
[mapno
]))
3401 realmaps
[nmaps1
++] = maps
[mapno
];
3403 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
3406 /* If we got more than one event, put all but the first
3407 onto this list to be read later.
3408 Return just the first event now. */
3409 unread_command_events
3410 = nconc2 (XCONS (value
)->cdr
, unread_command_events
);
3411 value
= XCONS (value
)->car
;
3415 if (used_mouse_menu
)
3416 *used_mouse_menu
= 1;
3419 #endif /* HAVE_X_MENU */
3420 #endif /* HAVE_X_WINDOWS */
3422 /* Prompt string always starts with map's prompt, and a space. */
3423 strcpy (menu
, XSTRING (name
)->data
);
3424 nlength
= XSTRING (name
)->size
;
3425 menu
[nlength
++] = ':';
3426 menu
[nlength
++] = ' ';
3429 /* Start prompting at start of first map. */
3433 /* Present the documented bindings, a line at a time. */
3441 /* Loop over elements of map. */
3446 /* If reached end of map, start at beginning of next map. */
3450 /* At end of last map, wrap around to first map if just starting,
3451 or end this line if already have something on it. */
3462 /* Look at the next element of the map. */
3464 elt
= XVECTOR (vector
)->contents
[idx
];
3466 elt
= Fcar_safe (rest
);
3468 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
3470 /* If we found a dense table in the keymap,
3471 advanced past it, but start scanning its contents. */
3472 rest
= Fcdr_safe (rest
);
3478 /* An ordinary element. */
3479 s
= Fcar_safe (Fcdr_safe (elt
));
3480 if (XTYPE (s
) != Lisp_String
)
3481 /* Ignore the element if it has no prompt string. */
3483 /* If we have room for the prompt string, add it to this line.
3484 If this is the first on the line, always add it. */
3485 else if (XSTRING (s
)->size
+ i
< width
3490 /* Punctuate between strings. */
3493 strcpy (menu
+ i
, ", ");
3498 /* Add as much of string as fits. */
3499 thiswidth
= XSTRING (s
)->size
;
3500 if (thiswidth
+ i
> width
)
3501 thiswidth
= width
- i
;
3502 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
3507 /* If this element does not fit, end the line now,
3508 and save the element for the next line. */
3509 strcpy (menu
+ i
, "...");
3513 /* Move past this element. */
3514 if (idx
>= 0 && idx
+ 1 >= XVECTOR (rest
)->size
)
3515 /* Handle reaching end of dense table. */
3520 rest
= Fcdr_safe (rest
);
3524 /* Prompt with that and read response. */
3526 obj
= read_char (1, 0, 0, Qnil
, 0);
3528 if (XTYPE (obj
) != Lisp_Int
)
3533 if (! EQ (obj
, menu_prompt_more_char
)
3534 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
3535 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
3540 /* Reading key sequences. */
3542 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
3543 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
3544 keymap, or nil otherwise. Return the index of the first keymap in
3545 which KEY has any binding, or NMAPS if no map has a binding.
3547 If KEY is a meta ASCII character, treat it like meta-prefix-char
3548 followed by the corresponding non-meta character. Keymaps in
3549 CURRENT with non-prefix bindings for meta-prefix-char become nil in
3552 When KEY is not defined in any of the keymaps, if it is an upper
3553 case letter and there are bindings for the corresponding lower-case
3554 letter, return the bindings for the lower-case letter.
3556 If KEY has no bindings in any of the CURRENT maps, NEXT is left
3559 NEXT may == CURRENT. */
3562 follow_key (key
, nmaps
, current
, defs
, next
)
3564 Lisp_Object
*current
, *defs
, *next
;
3567 int i
, first_binding
;
3569 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
3570 followed by the corresponding non-meta character. */
3571 if (XTYPE (key
) == Lisp_Int
&& (XINT (key
) & CHAR_META
))
3573 for (i
= 0; i
< nmaps
; i
++)
3574 if (! NILP (current
[i
]))
3577 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
3579 /* Note that since we pass the resulting bindings through
3580 get_keymap_1, non-prefix bindings for meta-prefix-char
3582 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
3588 XSET (key
, Lisp_Int
, XFASTINT (key
) & ~CHAR_META
);
3591 first_binding
= nmaps
;
3592 for (i
= nmaps
- 1; i
>= 0; i
--)
3594 if (! NILP (current
[i
]))
3596 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3597 if (! NILP (defs
[i
]))
3604 /* When KEY is not defined in any of the keymaps, if it is an upper
3605 case letter and there are bindings for the corresponding
3606 lower-case letter, return the bindings for the lower-case letter. */
3607 if (first_binding
== nmaps
3608 && XTYPE (key
) == Lisp_Int
3609 && ((((XINT (key
) & 0x3ffff)
3610 < XSTRING (current_buffer
->downcase_table
)->size
)
3611 && UPPERCASEP (XINT (key
) & 0x3ffff))
3612 || (XINT (key
) & shift_modifier
)))
3614 if (XINT (key
) & shift_modifier
)
3615 XSETINT (key
, XINT (key
) & ~shift_modifier
);
3617 XSETINT (key
, DOWNCASE (XINT (key
)));
3619 first_binding
= nmaps
;
3620 for (i
= nmaps
- 1; i
>= 0; i
--)
3622 if (! NILP (current
[i
]))
3624 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3625 if (! NILP (defs
[i
]))
3633 /* Given the set of bindings we've found, produce the next set of maps. */
3634 if (first_binding
< nmaps
)
3635 for (i
= 0; i
< nmaps
; i
++)
3636 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
3638 return first_binding
;
3641 /* Read a sequence of keys that ends with a non prefix character,
3642 storing it in KEYBUF, a buffer of size BUFSIZE.
3644 Return the length of the key sequence stored.
3645 Return -1 if the user rejected a command menu.
3647 Echo starting immediately unless `prompt' is 0.
3649 Where a key sequence ends depends on the currently active keymaps.
3650 These include any minor mode keymaps active in the current buffer,
3651 the current buffer's local map, and the global map.
3653 If a key sequence has no other bindings, we check Vfunction_key_map
3654 to see if some trailing subsequence might be the beginning of a
3655 function key's sequence. If so, we try to read the whole function
3656 key, and substitute its symbolic name into the key sequence.
3658 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
3659 `double-' events into similar click events, if that would make them
3660 bound. We try to turn `triple-' events first into `double-' events,
3663 If we get a mouse click in a mode line, vertical divider, or other
3664 non-text area, we treat the click as if it were prefixed by the
3665 symbol denoting that area - `mode-line', `vertical-line', or
3668 If the sequence starts with a mouse click, we read the key sequence
3669 with respect to the buffer clicked on, not the current buffer.
3671 If the user switches frames in the midst of a key sequence, we put
3672 off the switch-frame event until later; the next call to
3673 read_char will return it. */
3676 read_key_sequence (keybuf
, bufsize
, prompt
)
3677 Lisp_Object
*keybuf
;
3681 int count
= specpdl_ptr
- specpdl
;
3683 /* How many keys there are in the current key sequence. */
3686 /* The length of the echo buffer when we started reading, and
3687 the length of this_command_keys when we started reading. */
3691 /* The number of keymaps we're scanning right now, and the number of
3692 keymaps we have allocated space for. */
3694 int nmaps_allocated
= 0;
3696 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
3697 the current keymaps. */
3700 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3701 in the current keymaps, or nil where it is not a prefix. */
3702 Lisp_Object
*submaps
;
3704 /* The index in defs[] of the first keymap that has a binding for
3705 this key sequence. In other words, the lowest i such that
3706 defs[i] is non-nil. */
3709 /* If t < mock_input, then KEYBUF[t] should be read as the next
3712 We use this to recover after recognizing a function key. Once we
3713 realize that a suffix of the current key sequence is actually a
3714 function key's escape sequence, we replace the suffix with the
3715 function key's binding from Vfunction_key_map. Now keybuf
3716 contains a new and different key sequence, so the echo area,
3717 this_command_keys, and the submaps and defs arrays are wrong. In
3718 this situation, we set mock_input to t, set t to 0, and jump to
3719 restart_sequence; the loop will read keys from keybuf up until
3720 mock_input, thus rebuilding the state; and then it will resume
3721 reading characters from the keyboard. */
3724 /* If the sequence is unbound in submaps[], then
3725 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
3726 and fkey_map is its binding.
3728 These might be > t, indicating that all function key scanning
3729 should hold off until t reaches them. We do this when we've just
3730 recognized a function key, to avoid searching for the function
3731 key's again in Vfunction_key_map. */
3732 int fkey_start
= 0, fkey_end
= 0;
3733 Lisp_Object fkey_map
;
3735 /* Likewise, for key_translation_map. */
3736 int keytran_start
= 0, keytran_end
= 0;
3737 Lisp_Object keytran_map
;
3739 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
3740 we put it off for later. While we're reading, we keep the event here. */
3741 Lisp_Object delayed_switch_frame
;
3743 Lisp_Object first_event
;
3747 last_nonmenu_event
= Qnil
;
3749 delayed_switch_frame
= Qnil
;
3750 fkey_map
= Vfunction_key_map
;
3751 keytran_map
= Vkey_translation_map
;
3753 /* If there is no function-key-map, turn off function key scanning. */
3754 if (NILP (Fkeymapp (Vfunction_key_map
)))
3755 fkey_start
= fkey_end
= bufsize
+ 1;
3757 /* If there is no key-translation-map, turn off scanning. */
3758 if (NILP (Fkeymapp (Vkey_translation_map
)))
3759 keytran_start
= keytran_end
= bufsize
+ 1;
3764 echo_prompt (prompt
);
3765 else if (cursor_in_echo_area
)
3766 /* This doesn't put in a dash if the echo buffer is empty, so
3767 you don't always see a dash hanging out in the minibuffer. */
3771 /* Record the initial state of the echo area and this_command_keys;
3772 we will need to restore them if we replay a key sequence. */
3774 echo_start
= echo_length ();
3775 keys_start
= this_command_key_count
;
3777 #if 0 /* This doesn't quite work, because some of the things
3778 that read_char does cannot safely be bypassed.
3779 It seems too risky to try to make this work right. */
3780 /* Read the first char of the sequence specially, before setting
3781 up any keymaps, in case a filter runs and switches buffers on us. */
3782 first_event
= read_char (!prompt
, 0, submaps
, last_nonmenu_event
,
3786 /* We jump here when the key sequence has been thoroughly changed, and
3787 we need to rescan it starting from the beginning. When we jump here,
3788 keybuf[0..mock_input] holds the sequence we should reread. */
3791 /* Build our list of keymaps.
3792 If we recognize a function key and replace its escape sequence in
3793 keybuf with its symbol, or if the sequence starts with a mouse
3794 click and we need to switch buffers, we jump back here to rebuild
3795 the initial keymaps from the current buffer. */
3799 nmaps
= current_minor_maps (0, &maps
) + 2;
3800 if (nmaps
> nmaps_allocated
)
3802 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
3803 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
3804 nmaps_allocated
= nmaps
;
3806 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
3807 #ifdef USE_TEXT_PROPERTIES
3808 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3810 submaps
[nmaps
-2] = current_buffer
->keymap
;
3812 submaps
[nmaps
-1] = current_global_map
;
3815 /* Find an accurate initial value for first_binding. */
3816 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
3817 if (! NILP (submaps
[first_binding
]))
3820 /* We jump here when a function key substitution has forced us to
3821 reprocess the current key sequence. keybuf[0..mock_input] is the
3822 sequence we want to reread. */
3825 /* These are no-ops the first time through, but if we restart, they
3826 revert the echo area and this_command_keys to their original state. */
3827 this_command_key_count
= keys_start
;
3829 echo_truncate (echo_start
);
3831 /* If the best binding for the current key sequence is a keymap, or
3832 we may be looking at a function key's escape sequence, keep on
3834 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
3835 || (first_binding
>= nmaps
3837 /* mock input is never part of a function key's sequence. */
3838 && mock_input
<= fkey_start
)
3839 || (first_binding
>= nmaps
3840 && keytran_start
< t
3841 /* mock input is never part of a function key's sequence. */
3842 && mock_input
<= keytran_start
))
3845 int used_mouse_menu
= 0;
3847 /* Where the last real key started. If we need to throw away a
3848 key that has expanded into more than one element of keybuf
3849 (say, a mouse click on the mode line which is being treated
3850 as [mode-line (mouse-...)], then we backtrack to this point
3852 int last_real_key_start
;
3854 /* These variables are analogous to echo_start and keys_start;
3855 while those allow us to restart the entire key sequence,
3856 echo_local_start and keys_local_start allow us to throw away
3858 int echo_local_start
, keys_local_start
, local_first_binding
;
3861 error ("key sequence too long");
3864 echo_local_start
= echo_length ();
3865 keys_local_start
= this_command_key_count
;
3866 local_first_binding
= first_binding
;
3869 /* These are no-ops, unless we throw away a keystroke below and
3870 jumped back up to replay_key; in that case, these restore the
3871 variables to their original state, allowing us to replay the
3874 echo_truncate (echo_local_start
);
3875 this_command_key_count
= keys_local_start
;
3876 first_binding
= local_first_binding
;
3878 /* By default, assume each event is "real". */
3879 last_real_key_start
= t
;
3881 /* Does mock_input indicate that we are re-reading a key sequence? */
3885 add_command_key (key
);
3889 /* If not, we should actually read a character. */
3892 struct buffer
*buf
= current_buffer
;
3894 key
= read_char (!prompt
, nmaps
, submaps
, last_nonmenu_event
,
3897 /* read_char returns t when it shows a menu and the user rejects it.
3902 /* read_char returns -1 at the end of a macro.
3903 Emacs 18 handles this by returning immediately with a
3904 zero, so that's what we'll do. */
3905 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) == -1)
3914 /* Clicks in non-text areas get prefixed by the symbol
3915 in their CHAR-ADDRESS field. For example, a click on
3916 the mode line is prefixed by the symbol `mode-line'.
3918 Furthermore, key sequences beginning with mouse clicks
3919 are read using the keymaps of the buffer clicked on, not
3920 the current buffer. So we may have to switch the buffer
3923 When we turn one event into two events, we must make sure
3924 that neither of the two looks like the original--so that,
3925 if we replay the events, they won't be expanded again.
3926 If not for this, such reexpansion could happen either here
3927 or when user programs play with this-command-keys. */
3928 if (EVENT_HAS_PARAMETERS (key
))
3930 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
3932 if (EQ (kind
, Qmouse_click
))
3934 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
3935 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
3937 if (XTYPE (posn
) == Lisp_Cons
)
3939 /* We're looking at the second event of a
3940 sequence which we expanded before. Set
3941 last_real_key_start appropriately. */
3943 last_real_key_start
= t
- 1;
3946 /* Key sequences beginning with mouse clicks are
3947 read using the keymaps in the buffer clicked on,
3948 not the current buffer. If we're at the
3949 beginning of a key sequence, switch buffers. */
3950 if (last_real_key_start
== 0
3951 && XTYPE (window
) == Lisp_Window
3952 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
3953 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
3958 /* Arrange to go back to the original buffer once we're
3959 done reading the key sequence. Note that we can't
3960 use save_excursion_{save,restore} here, because they
3961 save point as well as the current buffer; we don't
3962 want to save point, because redisplay may change it,
3963 to accommodate a Fset_window_start or something. We
3964 don't want to do this at the top of the function,
3965 because we may get input from a subprocess which
3966 wants to change the selected window and stuff (say,
3968 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3970 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
3971 goto replay_sequence
;
3973 else if (XTYPE (posn
) == Lisp_Symbol
)
3975 /* Expand mode-line and scroll-bar events into two events:
3976 use posn as a fake prefix key. */
3978 if (t
+ 1 >= bufsize
)
3979 error ("key sequence too long");
3984 /* Zap the position in key, so we know that we've
3985 expanded it, and don't try to do so again. */
3986 POSN_BUFFER_POSN (EVENT_START (key
))
3987 = Fcons (posn
, Qnil
);
3991 else if (EQ (kind
, Qswitch_frame
))
3993 /* If we're at the beginning of a key sequence, go
3994 ahead and return this event. If we're in the
3995 midst of a key sequence, delay it until the end. */
3998 delayed_switch_frame
= key
;
4004 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4006 /* Handle menu-bar events:
4007 insert the dummy prefix event `menu-bar'. */
4008 if (EQ (posn
, Qmenu_bar
))
4010 if (t
+ 1 >= bufsize
)
4011 error ("key sequence too long");
4012 /* Run the Lucid hook. */
4013 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4014 /* If it has changed current-menubar from previous value,
4015 really recompute the menubar from the value. */
4016 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4017 call0 (Qrecompute_lucid_menubar
);
4021 /* Zap the position in key, so we know that we've
4022 expanded it, and don't try to do so again. */
4023 POSN_BUFFER_POSN (EVENT_START (key
))
4024 = Fcons (posn
, Qnil
);
4027 goto replay_sequence
;
4029 else if (XTYPE (posn
) == Lisp_Cons
)
4031 /* We're looking at the second event of a
4032 sequence which we expanded before. Set
4033 last_real_key_start appropriately. */
4034 if (last_real_key_start
== t
&& t
> 0)
4035 last_real_key_start
= t
- 1;
4040 /* We have finally decided that KEY is something we might want
4042 first_binding
= (follow_key (key
,
4043 nmaps
- first_binding
,
4044 submaps
+ first_binding
,
4045 defs
+ first_binding
,
4046 submaps
+ first_binding
)
4049 /* If KEY wasn't bound, we'll try some fallbacks. */
4050 if (first_binding
>= nmaps
)
4052 Lisp_Object head
= EVENT_HEAD (key
);
4054 if (EQ (head
, Vhelp_char
))
4056 read_key_sequence_cmd
= Vprefix_help_command
;
4058 last_nonmenu_event
= key
;
4062 if (XTYPE (head
) == Lisp_Symbol
)
4064 Lisp_Object breakdown
= parse_modifiers (head
);
4065 int modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4067 /* We drop unbound `down-' events altogether. */
4068 if (modifiers
& down_modifier
)
4070 /* Dispose of this event by simply jumping back to
4071 replay_key, to get another event.
4073 Note that if this event came from mock input,
4074 then just jumping back to replay_key will just
4075 hand it to us again. So we have to wipe out any
4078 We could delete keybuf[t] and shift everything
4079 after that to the left by one spot, but we'd also
4080 have to fix up any variable that points into
4081 keybuf, and shifting isn't really necessary
4084 Adding prefixes for non-textual mouse clicks
4085 creates two characters of mock input, and both
4086 must be thrown away. If we're only looking at
4087 the prefix now, we can just jump back to
4088 replay_key. On the other hand, if we've already
4089 processed the prefix, and now the actual click
4090 itself is giving us trouble, then we've lost the
4091 state of the keymaps we want to backtrack to, and
4092 we need to replay the whole sequence to rebuild
4095 Beyond that, only function key expansion could
4096 create more than two keys, but that should never
4097 generate mouse events, so it's okay to zero
4098 mock_input in that case too.
4100 Isn't this just the most wonderful code ever? */
4101 if (t
== last_real_key_start
)
4108 mock_input
= last_real_key_start
;
4109 goto replay_sequence
;
4113 /* We turn unbound `drag-' events into `click-'
4114 events, if the click would be bound. */
4115 else if (modifiers
& (drag_modifier
| double_modifier
4118 while (modifiers
& (drag_modifier
| double_modifier
4121 Lisp_Object new_head
, new_click
;
4122 if (modifiers
& triple_modifier
)
4123 modifiers
^= (double_modifier
| triple_modifier
);
4125 modifiers
&= ~(drag_modifier
| double_modifier
);
4127 apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
4129 Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
4131 /* Look for a binding for this new key. follow_key
4132 promises that it didn't munge submaps the
4133 last time we called it, since key was unbound. */
4135 (follow_key (new_click
,
4136 nmaps
- local_first_binding
,
4137 submaps
+ local_first_binding
,
4138 defs
+ local_first_binding
,
4139 submaps
+ local_first_binding
)
4140 + local_first_binding
);
4142 /* If that click is bound, go for it. */
4143 if (first_binding
< nmaps
)
4148 /* Otherwise, we'll leave key set to the drag event. */
4155 /* Normally, last_nonmenu_event gets the previous key we read.
4156 But when a mouse popup menu is being used,
4157 we don't update last_nonmenu_event; it continues to hold the mouse
4158 event that preceded the first level of menu. */
4159 if (!used_mouse_menu
)
4160 last_nonmenu_event
= key
;
4162 /* If the sequence is unbound, see if we can hang a function key
4163 off the end of it. We only want to scan real keyboard input
4164 for function key sequences, so if mock_input says that we're
4165 re-reading old events, don't examine it. */
4166 if (first_binding
>= nmaps
4169 Lisp_Object fkey_next
;
4171 /* Scan from fkey_end until we find a bound suffix. */
4172 while (fkey_end
< t
)
4176 key
= keybuf
[fkey_end
++];
4177 /* Look up meta-characters by prefixing them
4178 with meta_prefix_char. I hate this. */
4179 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4184 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
4186 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4189 fkey_next
= fkey_map
;
4192 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
4194 /* If keybuf[fkey_start..fkey_end] is bound in the
4195 function key map and it's a suffix of the current
4196 sequence (i.e. fkey_end == t), replace it with
4197 the binding and restart with fkey_start at the end. */
4198 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
4201 int len
= Flength (fkey_next
);
4203 t
= fkey_start
+ len
;
4205 error ("key sequence too long");
4207 if (VECTORP (fkey_next
))
4208 bcopy (XVECTOR (fkey_next
)->contents
,
4209 keybuf
+ fkey_start
,
4210 (t
- fkey_start
) * sizeof (keybuf
[0]));
4211 else if (STRINGP (fkey_next
))
4215 for (i
= 0; i
< len
; i
++)
4216 XFASTINT (keybuf
[fkey_start
+ i
]) =
4217 XSTRING (fkey_next
)->data
[i
];
4221 fkey_start
= fkey_end
= t
;
4222 fkey_map
= Vfunction_key_map
;
4224 goto replay_sequence
;
4227 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
4229 /* If we no longer have a bound suffix, try a new positions for
4231 if (NILP (fkey_map
))
4233 fkey_end
= ++fkey_start
;
4234 fkey_map
= Vfunction_key_map
;
4239 /* Look for this sequence in key-translation-map. */
4241 Lisp_Object keytran_next
;
4243 /* Scan from keytran_end until we find a bound suffix. */
4244 while (keytran_end
< t
)
4248 key
= keybuf
[keytran_end
++];
4249 /* Look up meta-characters by prefixing them
4250 with meta_prefix_char. I hate this. */
4251 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4256 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
4258 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4261 keytran_next
= keytran_map
;
4264 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
4266 /* If keybuf[keytran_start..keytran_end] is bound in the
4267 function key map and it's a suffix of the current
4268 sequence (i.e. keytran_end == t), replace it with
4269 the binding and restart with keytran_start at the end. */
4270 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
4271 && keytran_end
== t
)
4273 int len
= Flength (keytran_next
);
4275 t
= keytran_start
+ len
;
4277 error ("key sequence too long");
4279 if (VECTORP (keytran_next
))
4280 bcopy (XVECTOR (keytran_next
)->contents
,
4281 keybuf
+ keytran_start
,
4282 (t
- keytran_start
) * sizeof (keybuf
[0]));
4283 else if (STRINGP (keytran_next
))
4287 for (i
= 0; i
< len
; i
++)
4288 XFASTINT (keybuf
[keytran_start
+ i
])
4289 = XSTRING (keytran_next
)->data
[i
];
4293 keytran_start
= keytran_end
= t
;
4294 keytran_map
= Vkey_translation_map
;
4296 goto replay_sequence
;
4299 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
4301 /* If we no longer have a bound suffix, try a new positions for
4303 if (NILP (keytran_map
))
4305 keytran_end
= ++keytran_start
;
4306 keytran_map
= Vkey_translation_map
;
4312 read_key_sequence_cmd
= (first_binding
< nmaps
4313 ? defs
[first_binding
]
4317 unread_switch_frame
= delayed_switch_frame
;
4318 unbind_to (count
, Qnil
);
4320 /* Occasionally we fabricate events, perhaps by expanding something
4321 according to function-key-map, or by adding a prefix symbol to a
4322 mouse click in the scroll bar or modeline. In this cases, return
4323 the entire generated key sequence, even if we hit an unbound
4324 prefix or a definition before the end. This means that you will
4325 be able to push back the event properly, and also means that
4326 read-key-sequence will always return a logical unit.
4329 for (; t
< mock_input
; t
++)
4331 echo_char (keybuf
[t
]);
4332 add_command_key (keybuf
[t
]);
4338 #if 0 /* This doc string is too long for some compilers.
4339 This commented-out definition serves for DOC. */
4340 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4341 "Read a sequence of keystrokes and return as a string or vector.\n\
4342 The sequence is sufficient to specify a non-prefix command in the\n\
4343 current local and global maps.\n\
4345 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
4346 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
4347 as a continuation of the previous key.\n\
4349 A C-g typed while in this function is treated like any other character,\n\
4350 and `quit-flag' is not set.\n\
4352 If the key sequence starts with a mouse click, then the sequence is read\n\
4353 using the keymaps of the buffer of the window clicked in, not the buffer\n\
4354 of the selected window as normal.\n\
4356 `read-key-sequence' drops unbound button-down events, since you normally\n\
4357 only care about the click or drag events which follow them. If a drag\n\
4358 or multi-click event is unbound, but the corresponding click event would\n\
4359 be bound, `read-key-sequence' turns the event into a click event at the\n\
4360 drag's starting position. This means that you don't have to distinguish\n\
4361 between click and drag, double, or triple events unless you want to.\n\
4363 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
4364 lines separating windows, and scroll bars with imaginary keys\n\
4365 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
4367 If the user switches frames in the middle of a key sequence, the\n\
4368 frame-switch event is put off until after the current key sequence.\n\
4370 `read-key-sequence' checks `function-key-map' for function key\n\
4371 sequences, where they wouldn't conflict with ordinary bindings. See\n\
4372 `function-key-map' for more details.")
4373 (prompt
, continue_echo
)
4376 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4378 (prompt
, continue_echo
)
4379 Lisp_Object prompt
, continue_echo
;
4381 Lisp_Object keybuf
[30];
4383 struct gcpro gcpro1
, gcpro2
;
4386 CHECK_STRING (prompt
, 0);
4389 bzero (keybuf
, sizeof keybuf
);
4391 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
4393 if (NILP (continue_echo
))
4394 this_command_key_count
= 0;
4396 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
4397 NILP (prompt
) ? 0 : XSTRING (prompt
)->data
);
4405 return make_event_array (i
, keybuf
);
4408 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
4409 "Execute CMD as an editor command.\n\
4410 CMD must be a symbol that satisfies the `commandp' predicate.\n\
4411 Optional second arg RECORD-FLAG non-nil\n\
4412 means unconditionally put this command in `command-history'.\n\
4413 Otherwise, that is done only if an arg is read using the minibuffer.")
4415 Lisp_Object cmd
, record
;
4417 register Lisp_Object final
;
4418 register Lisp_Object tem
;
4419 Lisp_Object prefixarg
;
4420 struct backtrace backtrace
;
4421 extern int debug_on_next_call
;
4423 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
4424 Vcurrent_prefix_arg
= prefixarg
;
4425 debug_on_next_call
= 0;
4427 if (XTYPE (cmd
) == Lisp_Symbol
)
4429 tem
= Fget (cmd
, Qdisabled
);
4431 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
4436 final
= Findirect_function (cmd
);
4438 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
4439 do_autoload (final
, cmd
);
4444 if (XTYPE (final
) == Lisp_String
4445 || XTYPE (final
) == Lisp_Vector
)
4447 /* If requested, place the macro in the command history. For
4448 other sorts of commands, call-interactively takes care of
4452 = Fcons (Fcons (Qexecute_kbd_macro
,
4453 Fcons (final
, Fcons (prefixarg
, Qnil
))),
4456 return Fexecute_kbd_macro (final
, prefixarg
);
4458 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
4459 || XTYPE (final
) == Lisp_Compiled
)
4461 backtrace
.next
= backtrace_list
;
4462 backtrace_list
= &backtrace
;
4463 backtrace
.function
= &Qcall_interactively
;
4464 backtrace
.args
= &cmd
;
4465 backtrace
.nargs
= 1;
4466 backtrace
.evalargs
= 0;
4468 tem
= Fcall_interactively (cmd
, record
);
4470 backtrace_list
= backtrace
.next
;
4476 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
4478 "Read function name, then read its arguments and call it.")
4480 Lisp_Object prefixarg
;
4482 Lisp_Object function
;
4484 Lisp_Object saved_keys
;
4485 struct gcpro gcpro1
;
4487 saved_keys
= Fthis_command_keys ();
4489 GCPRO1 (saved_keys
);
4491 if (EQ (prefixarg
, Qminus
))
4493 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
4494 strcpy (buf
, "C-u ");
4495 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
4496 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
4497 else if (XTYPE (prefixarg
) == Lisp_Int
)
4498 sprintf (buf
, "%d ", XINT (prefixarg
));
4500 /* This isn't strictly correct if execute-extended-command
4501 is bound to anything else. Perhaps it should use
4502 this_command_keys? */
4503 strcat (buf
, "M-x ");
4505 /* Prompt with buf, and then read a string, completing from and
4506 restricting to the set of all defined commands. Don't provide
4507 any initial input. The last Qnil says not to perform a
4508 peculiar hack on the initial input. */
4509 function
= Fcompleting_read (build_string (buf
),
4510 Vobarray
, Qcommandp
,
4513 /* Set this_command_keys to the concatenation of saved_keys and
4514 function, followed by a RET. */
4516 struct Lisp_String
*str
;
4520 this_command_key_count
= 0;
4522 str
= XSTRING (saved_keys
);
4523 for (i
= 0; i
< str
->size
; i
++)
4525 XFASTINT (tem
) = str
->data
[i
];
4526 add_command_key (tem
);
4529 str
= XSTRING (function
);
4530 for (i
= 0; i
< str
->size
; i
++)
4532 XFASTINT (tem
) = str
->data
[i
];
4533 add_command_key (tem
);
4536 XFASTINT (tem
) = '\015';
4537 add_command_key (tem
);
4542 function
= Fintern (function
, Qnil
);
4543 Vprefix_arg
= prefixarg
;
4544 this_command
= function
;
4546 return Fcommand_execute (function
, Qt
);
4550 detect_input_pending ()
4553 get_input_pending (&input_pending
);
4555 return input_pending
;
4558 /* This is called in some cases before a possible quit.
4559 It cases the next call to detect_input_pending to recompute input_pending.
4560 So calling this function unnecessarily can't do any harm. */
4561 clear_input_pending ()
4566 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
4567 "T if command input is currently available with no waiting.\n\
4568 Actually, the value is nil only if we can be sure that no input is available.")
4571 if (!NILP (unread_command_events
) || unread_command_char
!= -1)
4574 return detect_input_pending () ? Qt
: Qnil
;
4577 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
4578 "Return vector of last 100 events, not counting those from keyboard macros.")
4581 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
4584 if (total_keys
< NUM_RECENT_KEYS
)
4585 return Fvector (total_keys
, keys
);
4588 val
= Fvector (NUM_RECENT_KEYS
, keys
);
4589 bcopy (keys
+ recent_keys_index
,
4590 XVECTOR (val
)->contents
,
4591 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
4593 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
4594 recent_keys_index
* sizeof (Lisp_Object
));
4599 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
4600 "Return the key sequence that invoked this command.\n\
4601 The value is a string or a vector.")
4604 return make_event_array (this_command_key_count
,
4605 XVECTOR (this_command_keys
)->contents
);
4608 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
4609 "Return the current depth in recursive edits.")
4613 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
4617 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
4618 "FOpen dribble file: ",
4619 "Start writing all keyboard characters to a dribble file called FILE.\n\
4620 If FILE is nil, close any open dribble file.")
4631 file
= Fexpand_file_name (file
, Qnil
);
4632 dribble
= fopen (XSTRING (file
)->data
, "w");
4637 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
4638 "Discard the contents of the terminal input buffer.\n\
4639 Also cancel any kbd macro being defined.")
4642 defining_kbd_macro
= 0;
4643 update_mode_lines
++;
4645 unread_command_events
= Qnil
;
4646 unread_command_char
= -1;
4648 discard_tty_input ();
4650 /* Without the cast, GCC complains that this assignment loses the
4651 volatile qualifier of kbd_store_ptr. Is there anything wrong
4653 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
4654 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
4660 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
4661 "Stop Emacs and return to superior process. You can resume later.\n\
4662 On systems that don't have job control, run a subshell instead.\n\n\
4663 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
4664 to be read as terminal input by Emacs's parent, after suspension.\n\
4666 Before suspending, call the functions in `suspend-hook' with no args.\n\
4667 If any of them returns nil, don't call the rest and don't suspend.\n\
4668 Otherwise, suspend normally and after resumption run the normal hook\n\
4669 `suspend-resume-hook' if that is bound and non-nil.\n\
4671 Some operating systems cannot stop the Emacs process and resume it later.\n\
4672 On such systems, Emacs starts a subshell instead of suspending.")
4674 Lisp_Object stuffstring
;
4677 int count
= specpdl_ptr
- specpdl
;
4678 int old_height
, old_width
;
4680 struct gcpro gcpro1
, gcpro2
;
4681 extern init_sys_modes ();
4683 if (!NILP (stuffstring
))
4684 CHECK_STRING (stuffstring
, 0);
4686 /* Run the functions in suspend-hook. */
4687 if (!NILP (Vrun_hooks
))
4688 call1 (Vrun_hooks
, intern ("suspend-hook"));
4690 GCPRO1 (stuffstring
);
4691 get_frame_size (&old_width
, &old_height
);
4693 /* sys_suspend can get an error if it tries to fork a subshell
4694 and the system resources aren't available for that. */
4695 record_unwind_protect (init_sys_modes
, 0);
4696 stuff_buffered_input (stuffstring
);
4698 unbind_to (count
, Qnil
);
4700 /* Check if terminal/window size has changed.
4701 Note that this is not useful when we are running directly
4702 with a window system; but suspend should be disabled in that case. */
4703 get_frame_size (&width
, &height
);
4704 if (width
!= old_width
|| height
!= old_height
)
4705 change_frame_size (selected_frame
, height
, width
, 0, 0);
4707 /* Run suspend-resume-hook. */
4708 if (!NILP (Vrun_hooks
))
4709 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
4715 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
4716 Then in any case stuff anything Emacs has read ahead and not used. */
4718 stuff_buffered_input (stuffstring
)
4719 Lisp_Object stuffstring
;
4721 register unsigned char *p
;
4723 /* stuff_char works only in BSD, versions 4.2 and up. */
4726 if (XTYPE (stuffstring
) == Lisp_String
)
4730 p
= XSTRING (stuffstring
)->data
;
4731 count
= XSTRING (stuffstring
)->size
;
4736 /* Anything we have read ahead, put back for the shell to read. */
4737 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4739 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4740 kbd_fetch_ptr
= kbd_buffer
;
4741 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
4742 stuff_char (XINT (kbd_fetch_ptr
->code
));
4743 kbd_fetch_ptr
->kind
= no_event
;
4744 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
4751 #endif /* BSD and not BSD4_1 */
4754 set_waiting_for_input (time_to_clear
)
4755 EMACS_TIME
*time_to_clear
;
4757 input_available_clear_time
= time_to_clear
;
4759 /* Tell interrupt_signal to throw back to read_char, */
4760 waiting_for_input
= 1;
4762 /* If interrupt_signal was called before and buffered a C-g,
4763 make it run again now, to avoid timing error. */
4764 if (!NILP (Vquit_flag
))
4765 quit_throw_to_read_char ();
4767 /* If alarm has gone off already, echo now. */
4775 clear_waiting_for_input ()
4777 /* Tell interrupt_signal not to throw back to read_char, */
4778 waiting_for_input
= 0;
4779 input_available_clear_time
= 0;
4782 /* This routine is called at interrupt level in response to C-G.
4783 If interrupt_input, this is the handler for SIGINT.
4784 Otherwise, it is called from kbd_buffer_store_event,
4785 in handling SIGIO or SIGTINT.
4787 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
4788 immediately throw back to read_char.
4790 Otherwise it sets the Lisp variable quit-flag not-nil.
4791 This causes eval to throw, when it gets a chance.
4792 If quit-flag is already non-nil, it stops the job right away. */
4798 /* Must preserve main program's value of errno. */
4799 int old_errno
= errno
;
4802 /* USG systems forget handlers when they are used;
4803 must reestablish each time */
4804 signal (SIGINT
, interrupt_signal
);
4805 signal (SIGQUIT
, interrupt_signal
);
4810 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
4815 #ifdef SIGTSTP /* Support possible in later USG versions */
4817 * On systems which can suspend the current process and return to the original
4818 * shell, this command causes the user to end up back at the shell.
4819 * The "Auto-save" and "Abort" questions are not asked until
4820 * the user elects to return to emacs, at which point he can save the current
4821 * job and either dump core or continue.
4826 if (sys_suspend () == -1)
4828 printf ("Not running as a subprocess;\n");
4829 printf ("you can continue or abort.\n");
4832 /* Perhaps should really fork an inferior shell?
4833 But that would not provide any way to get back
4834 to the original shell, ever. */
4835 printf ("No support for stopping a process on this operating system;\n");
4836 printf ("you can continue or abort.\n");
4837 #endif /* not VMS */
4838 #endif /* not SIGTSTP */
4839 printf ("Auto-save? (y or n) ");
4841 if (((c
= getchar ()) & ~040) == 'Y')
4843 Fdo_auto_save (Qt
, Qnil
);
4844 printf ("Auto-save done\n");
4846 while (c
!= '\n') c
= getchar ();
4848 printf ("Abort (and enter debugger)? (y or n) ");
4850 printf ("Abort (and dump core)? (y or n) ");
4851 #endif /* not VMS */
4853 if (((c
= getchar ()) & ~040) == 'Y')
4855 while (c
!= '\n') c
= getchar ();
4856 printf ("Continuing...\n");
4862 /* If executing a function that wants to be interrupted out of
4863 and the user has not deferred quitting by binding `inhibit-quit'
4864 then quit right away. */
4865 if (immediate_quit
&& NILP (Vinhibit_quit
))
4869 Fsignal (Qquit
, Qnil
);
4872 /* Else request quit when it's safe */
4876 if (waiting_for_input
&& !echoing
)
4877 quit_throw_to_read_char ();
4882 /* Handle a C-g by making read_char return C-g. */
4884 quit_throw_to_read_char ()
4886 quit_error_check ();
4888 /* Prevent another signal from doing this before we finish. */
4889 clear_waiting_for_input ();
4892 unread_command_events
= Qnil
;
4893 unread_command_char
= -1;
4895 #ifdef POLL_FOR_INPUT
4896 /* May be > 1 if in recursive minibuffer. */
4897 if (poll_suppress_count
== 0)
4901 _longjmp (getcjmp
, 1);
4904 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
4905 "Set mode of reading keyboard input.\n\
4906 First arg INTERRUPT non-nil means use input interrupts;\n\
4907 nil means use CBREAK mode.\n\
4908 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
4909 (no effect except in CBREAK mode).\n\
4910 Third arg META t means accept 8-bit input (for a Meta key).\n\
4911 META nil means ignore the top bit, on the assumption it is parity.\n\
4912 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
4913 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
4914 See also `current-input-mode'.")
4915 (interrupt
, flow
, meta
, quit
)
4916 Lisp_Object interrupt
, flow
, meta
, quit
;
4919 && (XTYPE (quit
) != Lisp_Int
4920 || XINT (quit
) < 0 || XINT (quit
) > 0400))
4921 error ("set-input-mode: QUIT must be an ASCII character.");
4925 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4926 #ifdef NO_SOCK_SIGIO
4927 if (read_socket_hook
)
4928 interrupt_input
= 0; /* No interrupts if reading from a socket. */
4930 #endif /* NO_SOCK_SIGIO */
4931 interrupt_input
= !NILP (interrupt
);
4932 #else /* not SIGIO */
4933 interrupt_input
= 0;
4934 #endif /* not SIGIO */
4935 /* Our VMS input only works by interrupts, as of now. */
4937 interrupt_input
= 1;
4939 flow_control
= !NILP (flow
);
4942 else if (EQ (meta
, Qt
))
4947 /* Don't let this value be out of range. */
4948 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
4954 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
4955 "Return information about the way Emacs currently reads keyboard input.\n\
4956 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
4957 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
4958 nil, Emacs is using CBREAK mode.\n\
4959 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
4960 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
4961 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
4962 META nil means ignoring the top bit, on the assumption it is parity.\n\
4963 META is neither t nor nil if accepting 8-bit input and using\n\
4964 all 8 bits as the character code.\n\
4965 QUIT is the character Emacs currently uses to quit.\n\
4966 The elements of this list correspond to the arguments of\n\
4972 val
[0] = interrupt_input
? Qt
: Qnil
;
4973 val
[1] = flow_control
? Qt
: Qnil
;
4974 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
4975 XFASTINT (val
[3]) = quit_char
;
4977 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
4983 /* This is correct before outermost invocation of the editor loop */
4984 command_loop_level
= -1;
4986 quit_char
= Ctl ('g');
4987 unread_command_events
= Qnil
;
4988 unread_command_char
= -1;
4990 recent_keys_index
= 0;
4991 kbd_fetch_ptr
= kbd_buffer
;
4992 kbd_store_ptr
= kbd_buffer
;
4993 do_mouse_tracking
= 0;
4997 /* This means that command_loop_1 won't try to select anything the first
4999 internal_last_event_frame
= Qnil
;
5000 Vlast_event_frame
= internal_last_event_frame
;
5003 /* If we're running a dumped Emacs, we need to clear out
5004 kbd_buffer_frame_or_window, in case some events got into it
5007 If we're running an undumped Emacs, it hasn't been initialized by
5008 syms_of_keyboard yet. */
5010 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5012 if (!noninteractive
)
5014 signal (SIGINT
, interrupt_signal
);
5015 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
5016 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
5017 SIGQUIT and we can't tell which one it will give us. */
5018 signal (SIGQUIT
, interrupt_signal
);
5019 #endif /* HAVE_TERMIO */
5020 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5022 signal (SIGIO
, input_available_signal
);
5026 /* Use interrupt input by default, if it works and noninterrupt input
5027 has deficiencies. */
5029 #ifdef INTERRUPT_INPUT
5030 interrupt_input
= 1;
5032 interrupt_input
= 0;
5035 /* Our VMS input only works by interrupts, as of now. */
5037 interrupt_input
= 1;
5043 if (keyboard_init_hook
)
5044 (*keyboard_init_hook
) ();
5046 #ifdef POLL_FOR_INPUT
5047 poll_suppress_count
= 1;
5052 /* This type's only use is in syms_of_keyboard, to initialize the
5053 event header symbols and put properties on them. */
5060 struct event_head head_table
[] = {
5061 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
5062 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
5063 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
5068 Qdisabled_command_hook
= intern ("disabled-command-hook");
5069 staticpro (&Qdisabled_command_hook
);
5071 Qself_insert_command
= intern ("self-insert-command");
5072 staticpro (&Qself_insert_command
);
5074 Qforward_char
= intern ("forward-char");
5075 staticpro (&Qforward_char
);
5077 Qbackward_char
= intern ("backward-char");
5078 staticpro (&Qbackward_char
);
5080 Qdisabled
= intern ("disabled");
5081 staticpro (&Qdisabled
);
5083 Qundefined
= intern ("undefined");
5084 staticpro (&Qundefined
);
5086 Qpre_command_hook
= intern ("pre-command-hook");
5087 staticpro (&Qpre_command_hook
);
5089 Qpost_command_hook
= intern ("post-command-hook");
5090 staticpro (&Qpost_command_hook
);
5092 Qfunction_key
= intern ("function-key");
5093 staticpro (&Qfunction_key
);
5094 Qmouse_click
= intern ("mouse-click");
5095 staticpro (&Qmouse_click
);
5097 Qmenu_enable
= intern ("menu-enable");
5098 staticpro (&Qmenu_enable
);
5100 Qmode_line
= intern ("mode-line");
5101 staticpro (&Qmode_line
);
5102 Qvertical_line
= intern ("vertical-line");
5103 staticpro (&Qvertical_line
);
5104 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
5105 staticpro (&Qvertical_scroll_bar
);
5106 Qmenu_bar
= intern ("menu-bar");
5107 staticpro (&Qmenu_bar
);
5109 Qabove_handle
= intern ("above-handle");
5110 staticpro (&Qabove_handle
);
5111 Qhandle
= intern ("handle");
5112 staticpro (&Qhandle
);
5113 Qbelow_handle
= intern ("below-handle");
5114 staticpro (&Qbelow_handle
);
5116 Qevent_kind
= intern ("event-kind");
5117 staticpro (&Qevent_kind
);
5118 Qevent_symbol_elements
= intern ("event-symbol-elements");
5119 staticpro (&Qevent_symbol_elements
);
5120 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
5121 staticpro (&Qevent_symbol_element_mask
);
5122 Qmodifier_cache
= intern ("modifier-cache");
5123 staticpro (&Qmodifier_cache
);
5125 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
5126 staticpro (&Qrecompute_lucid_menubar
);
5127 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
5128 staticpro (&Qactivate_menubar_hook
);
5131 struct event_head
*p
;
5133 for (p
= head_table
;
5134 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
5137 *p
->var
= intern (p
->name
);
5139 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
5140 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
5144 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
5145 staticpro (&button_down_location
);
5149 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
5151 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
5152 for (i
= 0; i
< len
; i
++)
5153 if (modifier_names
[i
])
5154 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
5155 staticpro (&modifier_symbols
);
5158 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
5159 staticpro (&recent_keys
);
5161 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
5162 staticpro (&this_command_keys
);
5164 kbd_buffer_frame_or_window
5165 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
5166 staticpro (&kbd_buffer_frame_or_window
);
5168 func_key_syms
= Qnil
;
5169 staticpro (&func_key_syms
);
5172 staticpro (&mouse_syms
);
5174 unread_switch_frame
= Qnil
;
5175 staticpro (&unread_switch_frame
);
5177 defsubr (&Sread_key_sequence
);
5178 defsubr (&Srecursive_edit
);
5179 defsubr (&Strack_mouse
);
5180 defsubr (&Sinput_pending_p
);
5181 defsubr (&Scommand_execute
);
5182 defsubr (&Srecent_keys
);
5183 defsubr (&Sthis_command_keys
);
5184 defsubr (&Ssuspend_emacs
);
5185 defsubr (&Sabort_recursive_edit
);
5186 defsubr (&Sexit_recursive_edit
);
5187 defsubr (&Srecursion_depth
);
5188 defsubr (&Stop_level
);
5189 defsubr (&Sdiscard_input
);
5190 defsubr (&Sopen_dribble_file
);
5191 defsubr (&Sset_input_mode
);
5192 defsubr (&Scurrent_input_mode
);
5193 defsubr (&Sexecute_extended_command
);
5195 DEFVAR_LISP ("last-command-char", &last_command_char
,
5196 "Last input event that was part of a command.");
5198 DEFVAR_LISP ("last-command-event", &last_command_char
,
5199 "Last input event that was part of a command.");
5201 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
5202 "Last input event in a command, except for mouse menu events.\n\
5203 Mouse menus give back keys that don't look like mouse events;\n\
5204 this variable holds the actual mouse event that led to the menu,\n\
5205 so that you can determine whether the command was run by mouse or not.");
5207 DEFVAR_LISP ("last-input-char", &last_input_char
,
5208 "Last input event.");
5210 DEFVAR_LISP ("last-input-event", &last_input_char
,
5211 "Last input event.");
5213 DEFVAR_LISP ("unread-command-events", &unread_command_events
,
5214 "List of objects to be read as next command input events.");
5216 DEFVAR_INT ("unread-command-char", &unread_command_char
,
5217 "If not -1, an object to be read as next command input event.");
5219 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
5220 "Meta-prefix character code. Meta-foo as command input\n\
5221 turns into this character followed by foo.");
5222 XSET (meta_prefix_char
, Lisp_Int
, 033);
5224 DEFVAR_LISP ("last-command", &last_command
,
5225 "The last command executed. Normally a symbol with a function definition,\n\
5226 but can be whatever was found in the keymap, or whatever the variable\n\
5227 `this-command' was set to by that command.");
5228 last_command
= Qnil
;
5230 DEFVAR_LISP ("this-command", &this_command
,
5231 "The command now being executed.\n\
5232 The command can set this variable; whatever is put here\n\
5233 will be in `last-command' during the following command.");
5234 this_command
= Qnil
;
5236 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
5237 "*Number of keyboard input characters between auto-saves.\n\
5238 Zero means disable autosaving due to number of characters typed.");
5239 auto_save_interval
= 300;
5241 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
5242 "*Number of seconds idle time before auto-save.\n\
5243 Zero or nil means disable auto-saving due to idleness.\n\
5244 After auto-saving due to this many seconds of idle time,\n\
5245 Emacs also does a garbage collection if that seems to be warranted.");
5246 XFASTINT (Vauto_save_timeout
) = 30;
5248 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
5249 "*Nonzero means echo unfinished commands after this many seconds of pause.");
5250 echo_keystrokes
= 1;
5252 DEFVAR_INT ("polling-period", &polling_period
,
5253 "*Interval between polling for input during Lisp execution.\n\
5254 The reason for polling is to make C-g work to stop a running program.\n\
5255 Polling is needed only when using X windows and SIGIO does not work.\n\
5256 Polling is automatically disabled in all other cases.");
5259 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
5260 "*Maximum time between mouse clicks to make a double-click.\n\
5261 Measured in milliseconds. nil means disable double-click recognition;\n\
5262 t means double-clicks have no time limit and are detected\n\
5263 by position only.");
5264 Vdouble_click_time
= make_number (500);
5266 DEFVAR_INT ("num-input-keys", &num_input_keys
,
5267 "*Number of complete keys read from the keyboard so far.");
5271 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
5272 "*The frame in which the most recently read event occurred.\n\
5273 If the last event came from a keyboard macro, this is set to `macro'.");
5274 Vlast_event_frame
= Qnil
;
5277 DEFVAR_LISP ("help-char", &Vhelp_char
,
5278 "Character to recognize as meaning Help.\n\
5279 When it is read, do `(eval help-form)', and display result if it's a string.\n\
5280 If the value of `help-form' is nil, this char can be read normally.");
5281 XSET (Vhelp_char
, Lisp_Int
, Ctl ('H'));
5283 DEFVAR_LISP ("help-form", &Vhelp_form
,
5284 "Form to execute when character `help-char' is read.\n\
5285 If the form returns a string, that string is displayed.\n\
5286 If `help-form' is nil, the help char is not recognized.");
5289 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
5290 "Command to run when `help-char' character follows a prefix key.\n\
5291 This command is used only when there is no actual binding\n\
5292 for that character after that prefix key.");
5293 Vprefix_help_command
= Qnil
;
5295 DEFVAR_LISP ("top-level", &Vtop_level
,
5296 "Form to evaluate when Emacs starts up.\n\
5297 Useful to set before you dump a modified Emacs.");
5300 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
5301 "String used as translate table for keyboard input, or nil.\n\
5302 Each character is looked up in this string and the contents used instead.\n\
5303 If string is of length N, character codes N and up are untranslated.");
5304 Vkeyboard_translate_table
= Qnil
;
5306 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
5307 "Keymap of key translations that can override keymaps.\n\
5308 This keymap works like `function-key-map', but comes after that,\n\
5309 and applies even for keys that have ordinary bindings.");
5310 Vkey_translation_map
= Qnil
;
5312 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
5313 "Non-nil means prompt with menus when appropriate.\n\
5314 This is done when reading from a keymap that has a prompt string,\n\
5315 for elements that have prompt strings.\n\
5316 The menu is displayed on the screen\n\
5317 if X menus were enabled at configuration\n\
5318 time and the previous event was a mouse click prefix key.\n\
5319 Otherwise, menu prompting uses the echo area.");
5322 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
5323 "Character to see next line of menu prompt.\n\
5324 Type this character while in a menu prompt to rotate around the lines of it.");
5325 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
5327 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
5328 "A mask of additional modifier keys to use with every keyboard character.\n\
5329 Emacs applies the modifiers of the character stored here to each keyboard\n\
5330 character it reads. For example, after evaluating the expression\n\
5331 (setq extra-keyboard-modifiers ?\C-x)\n\
5332 all input characters will have the control modifier applied to them.\n\
5334 Note that the character ?\C-@, equivalent to the integer zero, does\n\
5335 not count as a control character; rather, it counts as a character\n\
5336 with no modifiers; thus, setting extra_keyboard_modifiers to zero\n\
5337 cancels any modification.");
5338 extra_keyboard_modifiers
= 0;
5340 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
5341 "If an editing command sets this to t, deactivate the mark afterward.\n\
5342 The command loop sets this to nil before each command,\n\
5343 and tests the value when the command returns.\n\
5344 Buffer modification stores t in this variable.");
5345 Vdeactivate_mark
= Qnil
;
5347 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
5348 "Normal hook run before each command is executed.");
5349 Vpre_command_hook
= Qnil
;
5351 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
5352 "Normal hook run after each command is executed.");
5353 Vpost_command_hook
= Qnil
;
5355 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
5356 "t means menu bar, specified Lucid style, needs to be recomputed.");
5357 Vlucid_menu_bar_dirty_flag
= Qnil
;
5359 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
5360 "List of menu bar items to move to the end of the menu bar.\n\
5361 The elements of the list are event types that may have menu bar bindings.");
5362 Vmenu_bar_final_items
= Qnil
;
5367 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
5368 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
5369 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
5370 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
5371 initial_define_key (meta_map
, 'x', "execute-extended-command");