1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989 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 1, 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"
40 #include "emacssignal.h"
44 /* Get FIONREAD, if it is available. */
50 #include <sys/ioctl.h>
54 /* UNIPLUS systems may have FIONREAD. */
56 #include <sys.ioctl.h>
60 extern Lisp_Object Vmouse_grabbed
;
62 /* Make all keyboard buffers much bigger when using X windows. */
63 #define KBD_BUFFER_SIZE 4096
64 #else /* No X-windows, character input */
65 #define KBD_BUFFER_SIZE 256
66 #endif /* No X-windows */
68 /* Following definition copied from eval.c */
72 struct backtrace
*next
;
73 Lisp_Object
*function
;
74 Lisp_Object
*args
; /* Points to vector of args. */
75 int nargs
; /* length of vector. If nargs is UNEVALLED,
76 args points to slot holding list of
81 /* Non-nil disable property on a command means
82 do not execute it; call disabled-command-hook's value instead. */
83 Lisp_Object Qdisabled
, Vdisabled_command_hook
;
85 #define NUM_RECENT_KEYS (100)
86 int recent_keys_index
; /* Index for storing next element into recent_keys */
87 int total_keys
; /* Total number of elements stored into recent_keys */
88 Lisp_Object recent_keys
[NUM_RECENT_KEYS
]; /* Holds last 100 keystrokes */
90 /* Buffer holding the key that invoked the current command. */
91 Lisp_Object
*this_command_keys
;
92 int this_command_key_count
; /* Size in use. */
93 int this_command_keys_size
; /* Size allocated. */
95 extern int minbuf_level
;
97 extern struct backtrace
*backtrace_list
;
99 /* Nonzero means do menu prompting. */
100 static int menu_prompting
;
102 /* Character to see next line of menu prompt. */
103 static Lisp_Object menu_prompt_more_char
;
105 /* For longjmp to where kbd input is being done. */
106 static jmp_buf getcjmp
;
108 /* True while doing kbd input. */
109 int waiting_for_input
;
111 /* True while displaying for echoing. Delays C-g throwing. */
114 /* Nonzero means C-G should cause immediate error-signal. */
117 /* Character to recognize as the help char. */
118 Lisp_Object help_char
;
120 /* Form to execute when help char is typed. */
121 Lisp_Object Vhelp_form
;
123 /* Character that causes a quit. Normally C-g.
125 If we are running on an ordinary terminal, this must be an ordinary
126 ASCII char, since we want to make it our interrupt character.
128 If we are not running on an ordinary terminal, it still needs to be
129 an ordinary ASCII char. This character needs to be recognized in
130 the input interrupt handler. At this point, the keystroke is
131 represented as a struct input_event, while the desired quit
132 character is specified as a lispy event. The mapping from struct
133 input_events to lispy events cannot run in an interrupt handler,
134 and the reverse mapping is difficult for anything but ASCII
137 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
141 extern Lisp_Object current_global_map
;
142 extern int minibuf_level
;
144 /* Current depth in recursive edits. */
145 int command_loop_level
;
147 /* Total number of times command_loop has read a key sequence. */
150 /* Last input character read as a command. */
151 Lisp_Object last_command_char
;
153 /* Last input character read for any purpose. */
154 Lisp_Object last_input_char
;
156 /* If not Qnil, an object to be read as the next command input. */
157 Lisp_Object unread_command_char
;
159 /* Char to use as prefix when a meta character is typed in.
160 This is bound on entry to minibuffer in case ESC is changed there. */
162 Lisp_Object meta_prefix_char
;
164 /* Last size recorded for a current buffer which is not a minibuffer. */
165 static int last_non_minibuf_size
;
167 /* Number of idle seconds before an auto-save. */
168 static Lisp_Object Vauto_save_timeout
;
170 /* Total number of times read_char has returned. */
173 /* Auto-save automatically when this many characters have been typed
174 since the last time. */
176 static int auto_save_interval
;
178 /* Value of num_input_chars as of last auto save. */
182 /* Last command executed by the editor command loop, not counting
183 commands that set the prefix argument. */
185 Lisp_Object last_command
;
187 /* The command being executed by the command loop.
188 Commands may set this, and the value set will be copied into last_command
189 instead of the actual command. */
190 Lisp_Object this_command
;
193 /* Window of last mouse click. */
194 extern Lisp_Object Vmouse_window
;
196 /* List containing details of last mouse click. */
197 extern Lisp_Object Vmouse_event
;
198 #endif /* defined HAVE_X11 */
200 /* Hook to call on each mouse event after running its definition. */
201 Lisp_Object Vmouse_event_function
;
203 /* Hook to call when mouse leaves screen. */
204 Lisp_Object Vmouse_left_hook
;
206 /* Hook to call when a screen is mapped. */
207 Lisp_Object Vmap_screen_hook
;
209 /* Hook to call when a screen is unmapped. */
210 Lisp_Object Vunmap_screen_hook
;
212 /* Handler for non-grabbed (no keys depressed) mouse motion. */
213 Lisp_Object Vmouse_motion_handler
;
215 /* The screen in which the last input event occurred.
216 command_loop_1 will select this screen before running the
217 command bound to an event sequence, and read_key_sequence will
218 toss the existing prefix if the user starts typing at a
220 Lisp_Object Vlast_event_screen
;
222 /* X Windows wants this for selection ownership. */
223 unsigned long last_event_timestamp
;
225 Lisp_Object Qself_insert_command
;
226 Lisp_Object Qforward_char
;
227 Lisp_Object Qbackward_char
;
229 /* read_key_sequence stores here the command definition of the
230 key sequence that it reads. */
231 Lisp_Object read_key_sequence_cmd
;
233 /* Form to evaluate (if non-nil) when Emacs is started. */
234 Lisp_Object Vtop_level
;
236 /* User-supplied string to translate input characters through. */
237 Lisp_Object Vkeyboard_translate_table
;
239 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
240 extern Lisp_Object Vfunction_key_map
;
242 /* File in which we write all commands we read. */
245 /* Nonzero if input is available. */
248 /* Nonzero if should obey 0200 bit in input chars as "Meta". */
251 extern char *pending_malloc_warning
;
253 /* Circular buffer for pre-read keyboard input. */
254 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
256 /* Pointer to next available character in kbd_buffer.
257 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
258 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
259 next available char is in kbd_buffer[0]. */
260 static struct input_event
*kbd_fetch_ptr
;
262 /* Pointer to next place to store character in kbd_buffer. This
263 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
264 character should go in kbd_buffer[0]. */
265 static struct input_event
*kbd_store_ptr
;
267 /* The above pair of variables forms a "queue empty" flag. When we
268 enqueue a non-hook event, we increment kbd_write_count. When we
269 dequeue a non-hook event, we increment kbd_read_count. We say that
270 there is input available iff the two counters are equal.
272 Why not just have a flag set and cleared by the enqueuing and
273 dequeuing functions? Such a flag could be screwed up by interrupts
274 at inopportune times. */
276 /* If this flag is non-zero, mouse movement events will appear in the
277 input stream. If is zero, mouse movement will be ignored. */
278 int do_mouse_tracking
;
280 /* The window system handling code should set this if the mouse has
281 moved since the last call to the mouse_position_hook. Calling that
282 hook should clear this. Code assumes that if this is set, it can
283 call mouse_position_hook to get the promised position, so don't set
284 it unless you're prepared to substantiate the claim! */
287 /* True iff there is an event in kbd_buffer, or if mouse tracking is
288 enabled and there is a new mouse position in the mouse movement
289 buffer. Note that if this is false, that doesn't mean that there
290 is readable input; all the events in the queue might be button-up
291 events, and do_mouse_tracking might be off. */
292 #define EVENT_QUEUES_EMPTY \
293 ((kbd_fetch_ptr == kbd_store_ptr) && (!do_mouse_tracking || !mouse_moved))
296 /* Symbols to head events. */
297 Lisp_Object Qmouse_movement
;
299 Lisp_Object Qvscrollbar_part
;
300 Lisp_Object Qvslider_part
;
301 Lisp_Object Qvthumbup_part
;
302 Lisp_Object Qvthumbdown_part
;
304 Lisp_Object Qhscrollbar_part
;
305 Lisp_Object Qhslider_part
;
306 Lisp_Object Qhthumbleft_part
;
307 Lisp_Object Qhthumbright_part
;
309 /* Symbols to denote kinds of events. */
310 Lisp_Object Qfunction_key
;
311 Lisp_Object Qmouse_click
;
312 /* Lisp_Object Qmouse_movement; - also an event header */
313 Lisp_Object Qscrollbar_click
;
315 /* Properties of event headers. */
316 Lisp_Object Qevent_kind
;
317 Lisp_Object Qevent_unmodified
;
319 /* Symbols to use for non-text mouse positions. */
320 Lisp_Object Qmode_line
;
321 Lisp_Object Qvertical_split
;
324 /* Address (if not 0) of word to zero out if a SIGIO interrupt happens. */
325 long *input_available_clear_word
;
327 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
328 Default is 1 if INTERRUPT_INPUT is defined. */
331 /* Nonzero while interrupts are temporarily deferred during redisplay. */
332 int interrupts_deferred
;
334 /* nonzero means use ^S/^Q for flow control. */
338 #define sigfree() sigsetmask (SIGEMPTYMASK)
339 #define sigholdx(sig) sigsetmask (sigmask (sig))
340 #define sigblockx(sig) sigblock (sigmask (sig))
341 #define sigunblockx(sig) sigblock (SIGEMPTYMASK)
342 #define sigpausex(sig) sigpause (0)
343 #endif /* not BSD4_1 */
346 #define SIGIO SIGTINT
347 /* sigfree and sigholdx are in sysdep.c */
348 #define sigblockx(sig) sighold (sig)
349 #define sigunblockx(sig) sigrelse (sig)
350 #define sigpausex(sig) sigpause (sig)
353 /* Allow m- file to inhibit use of FIONREAD. */
354 #ifdef BROKEN_FIONREAD
358 /* We are unable to use interrupts if FIONREAD is not available,
359 so flush SIGIO so we won't try. */
366 /* If we support X Windows, and won't get an interrupt when input
367 arrives from the server, poll periodically so we can detect C-g. */
368 #ifdef HAVE_X_WINDOWS
370 #define POLL_FOR_INPUT
374 /* Global variable declarations. */
376 /* Function for init_keyboard to call with no args (if nonzero). */
377 void (*keyboard_init_hook
) ();
379 static int read_avail_input ();
380 static void get_input_pending ();
382 /* > 0 if we are to echo keystrokes. */
383 static int echo_keystrokes
;
385 /* Nonzero means echo each character as typed. */
386 static int immediate_echo
;
388 /* The text we're echoing in the modeline - partial key sequences,
389 usually. '\0'-terminated. */
390 static char echobuf
[100];
392 /* Where to append more text to echobuf if we want to. */
393 static char *echoptr
;
395 #define min(a,b) ((a)<(b)?(a):(b))
396 #define max(a,b) ((a)>(b)?(a):(b))
398 /* Install the string STR as the beginning of the string of echoing,
399 so that it serves as a prompt for the next character.
400 Also start echoing. */
405 int len
= strlen (str
);
406 if (len
> sizeof echobuf
- 4)
407 len
= sizeof echobuf
- 4;
408 bcopy (str
, echobuf
, len
+ 1);
409 echoptr
= echobuf
+ len
;
414 /* Add C to the echo string, if echoing is going on.
415 C can be a character, which is printed prettily ("M-C-x" and all that
416 jazz), or a symbol, whose name is printed. */
421 extern char *push_key_description ();
430 /* If someone has passed us a composite event, use its head symbol. */
431 if (EVENT_HAS_PARAMETERS (c
))
434 if (XTYPE (c
) == Lisp_Int
)
436 if (ptr
- echobuf
> sizeof echobuf
- 6)
439 ptr
= push_key_description (c
, ptr
);
441 else if (XTYPE (c
) == Lisp_Symbol
)
443 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
444 if (((ptr
- echobuf
) + name
->size
+ 4) > sizeof echobuf
)
446 bcopy (name
->data
, ptr
, name
->size
);
450 if (echoptr
== echobuf
&& c
== help_char
)
452 strcpy (ptr
, " (Type ? for further options)");
463 /* Temporarily add a dash to the end of the echo string if it's not
464 empty, so that it serves as a mini-prompt for the very next character. */
468 if (!immediate_echo
&& echoptr
== echobuf
)
471 /* Put a dash at the end of the buffer temporarily,
472 but make it go away when the next character is added. */
479 /* Display the current echo string, and begin echoing if not already
489 for (i
= 0; i
< this_command_key_count
; i
++)
490 echo_char (this_command_keys
[i
]);
498 if (waiting_for_input
&& !NILP (Vquit_flag
))
499 quit_throw_to_read_char ();
502 /* Turn off echoing, for the start of a new command. */
510 /* Return the length of the current echo string. */
515 return echoptr
- echobuf
;
518 /* Truncate the current echo message to its first LEN chars.
519 This and echo_char get used by read_key_sequence when the user
520 switches screens while entering a key sequence. */
527 echoptr
= echobuf
+ strlen (echobuf
);
531 /* Functions for manipulating this_command_keys. */
533 add_command_key (key
)
536 if (this_command_key_count
== this_command_keys_size
)
538 this_command_keys_size
*= 2;
540 = (Lisp_Object
*) xrealloc (this_command_keys
,
541 (this_command_keys_size
542 * sizeof (Lisp_Object
)));
544 this_command_keys
[this_command_key_count
++] = key
;
550 int count
= specpdl_ptr
- specpdl
;
553 if (command_loop_level
> 0)
555 specbind (Qstandard_output
, Qt
);
556 specbind (Qstandard_input
, Qt
);
559 val
= command_loop ();
561 Fsignal (Qquit
, Qnil
);
567 /* When an auto-save happens, record the "time", and don't do again soon. */
570 last_auto_save
= num_input_chars
;
573 Lisp_Object
recursive_edit_unwind (), command_loop ();
575 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
576 "Invoke the editor command loop recursively.\n\
577 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
578 that tells this function to return.\n\
579 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
580 This function is called by the editor initialization to begin editing.")
583 int count
= specpdl_ptr
- specpdl
;
586 command_loop_level
++;
587 update_mode_lines
= 1;
589 record_unwind_protect (recursive_edit_unwind
,
591 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
595 return unbind_to (count
, Qnil
);
599 recursive_edit_unwind (buffer
)
603 Fset_buffer (buffer
);
605 command_loop_level
--;
606 update_mode_lines
= 1;
614 Lisp_Object errmsg
, tail
, errname
, file_error
;
621 Vstandard_output
= Qt
;
622 Vstandard_input
= Qt
;
623 Vexecuting_macro
= Qnil
;
624 echo_area_glyphs
= 0;
626 /* If the window system or terminal screen hasn't been initialized
627 yet, or we're not interactive, it's best to dump this message out
628 to stderr and exit. */
629 if (! SCREEN_MESSAGE_BUF (selected_screen
)
631 stream
= Qexternal_debugging_output
;
639 errname
= Fcar (data
);
641 if (EQ (errname
, Qerror
))
644 if (!CONSP (data
)) data
= Qnil
;
645 errmsg
= Fcar (data
);
650 errmsg
= Fget (errname
, Qerror_message
);
651 file_error
= Fmemq (Qfile_error
,
652 Fget (errname
, Qerror_conditions
));
655 /* Print an error message including the data items.
656 This is done by printing it into a scratch buffer
657 and then making a copy of the text in the buffer. */
659 if (!CONSP (data
)) data
= Qnil
;
663 /* For file-error, make error message by concatenating
664 all the data items. They are all strings. */
665 if (!NILP (file_error
) && !NILP (tail
))
666 errmsg
= XCONS (tail
)->car
, tail
= XCONS (tail
)->cdr
;
668 if (XTYPE (errmsg
) == Lisp_String
)
669 Fprinc (errmsg
, stream
);
671 write_string_1 ("peculiar error", -1, stream
);
673 for (i
= 0; CONSP (tail
); tail
= Fcdr (tail
), i
++)
675 write_string_1 (i
? ", " : ": ", 2, stream
);
676 if (!NILP (file_error
))
677 Fprinc (Fcar (tail
), stream
);
679 Fprin1 (Fcar (tail
), stream
);
683 /* If the window system or terminal screen hasn't been initialized
684 yet, or we're in -batch mode, this error should cause Emacs to exit. */
685 if (! SCREEN_MESSAGE_BUF (selected_screen
)
689 Fkill_emacs (make_number (-1));
694 Vinhibit_quit
= Qnil
;
695 return make_number (0);
698 Lisp_Object
command_loop_1 ();
699 Lisp_Object
command_loop_2 ();
700 Lisp_Object
top_level_1 ();
702 /* Entry to editor-command-loop.
703 This level has the catches for exiting/returning to editor command loop.
704 It returns nil to exit recursive edit, t to abort it. */
709 if (command_loop_level
> 0 || minibuf_level
> 0)
711 return internal_catch (Qexit
, command_loop_2
, Qnil
);
716 internal_catch (Qtop_level
, top_level_1
, Qnil
);
717 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
719 /* End of file in -batch run causes exit here. */
725 /* Here we catch errors in execution of commands within the
726 editing loop, and reenter the editing loop.
727 When there is an error, cmd_error runs and returns a non-nil
728 value to us. A value of nil means that cmd_loop_1 itself
729 returned due to end of file (or end of kbd macro). */
734 register Lisp_Object val
;
737 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
746 return Feval (Vtop_level
);
752 /* On entry to the outer level, run the startup file */
753 if (!NILP (Vtop_level
))
754 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
755 else if (!NILP (Vpurify_flag
))
756 message ("Bare impure Emacs (standard Lisp code not loaded)");
758 message ("Bare Emacs (standard Lisp code not loaded)");
762 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
763 "Exit all recursive editing levels.")
766 Fthrow (Qtop_level
, Qnil
);
769 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
770 "Exit from the innermost recursive edit or minibuffer.")
773 if (command_loop_level
> 0 || minibuf_level
> 0)
774 Fthrow (Qexit
, Qnil
);
776 error ("No recursive edit is in progress");
779 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
780 "Abort the command that requested this recursive edit or minibuffer input.")
783 if (command_loop_level
> 0 || minibuf_level
> 0)
786 error ("No recursive edit is in progress");
789 /* This is the actual command reading loop,
790 sans error-handling encapsulation. */
792 Lisp_Object
Fcommand_execute ();
793 static int read_key_sequence ();
801 Lisp_Object keybuf
[30];
807 waiting_for_input
= 0;
810 /* Don't clear out last_command at the beginning of a macro. */
811 if (XTYPE (Vexecuting_macro
) != Lisp_String
)
816 this_command_key_count
= 0;
820 /* Install chars successfully executed in kbd macro. */
822 if (defining_kbd_macro
&& NILP (Vprefix_arg
))
823 finalize_kbd_macro_chars ();
825 /* Make sure the current window's buffer is selected. */
826 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
827 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
829 /* Display any malloc warning that just came out. Use while because
830 displaying one warning can cause another. */
832 while (pending_malloc_warning
)
833 display_malloc_warning ();
837 /* If minibuffer on and echo area in use,
838 wait 2 sec and redraw minibufer. */
840 if (minibuf_level
&& echo_area_glyphs
)
842 Fsit_for (make_number (2), Qnil
, Qnil
);
843 echo_area_glyphs
= 0;
845 if (!NILP (Vquit_flag
))
848 unread_command_char
= make_number (quit_char
);
853 alloca (0); /* Cause a garbage collection now */
854 /* Since we can free the most stuff here. */
855 #endif /* C_ALLOCA */
857 /* Read next key sequence; i gets its length. */
858 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), 0);
863 /* Select the screen that the key sequence came from. */
864 if (XTYPE (Vlast_event_screen
) == Lisp_Screen
865 && XSCREEN (Vlast_event_screen
) != selected_screen
)
866 Fselect_screen (Vlast_event_screen
, Qnil
);
869 /* Now we have read a key sequence of length I,
870 or else I is 0 and we found end of file. */
872 if (i
== 0) /* End of file -- happens only in */
873 return Qnil
; /* a kbd macro, at the end. */
876 #ifdef HAVE_X_WINDOWS
877 if (SCREEN_IS_X (selected_screen
))
879 if (i
== -1) /* Mouse event */
882 if (NILP (Vprefix_arg
) && NILP (Vexecuting_macro
) &&
883 !EQ (minibuf_window
, selected_window
))
886 if (defining_kbd_macro
)
888 /* Be nice if this worked... */
890 Fexecute_mouse_event (read_key_sequence_cmd
);
895 if (i
== -2) /* Lisp Symbol */
898 if (NILP (Vprefix_arg
) && NILP (Vexecuting_macro
) &&
899 !EQ (minibuf_window
, selected_window
))
905 #endif /* HAVE_X_WINDOWS */
908 last_command_char
= keybuf
[i
- 1];
910 cmd
= read_key_sequence_cmd
;
911 if (!NILP (Vexecuting_macro
))
913 if (!NILP (Vquit_flag
))
915 Vexecuting_macro
= Qt
;
916 QUIT
; /* Make some noise. */
917 /* Will return since macro now empty. */
921 /* Do redisplay processing after this command except in special
922 cases identified below that set no_redisplay to 1. */
925 /* Execute the command. */
929 /* nil means key is undefined. */
931 defining_kbd_macro
= 0;
932 update_mode_lines
= 1;
938 if (NILP (Vprefix_arg
) && ! no_direct
)
940 /* Recognize some common commands in common situations and
942 if (EQ (cmd
, Qforward_char
) && point
< ZV
)
944 struct Lisp_Vector
*dp
945 = window_display_table (XWINDOW (selected_window
));
946 lose
= FETCH_CHAR (point
);
948 if (((dp
== 0 && lose
>= 040 && lose
< 0177)
950 (dp
&& (XTYPE (dp
->contents
[lose
]) != Lisp_String
951 || XSTRING (dp
->contents
[lose
])->size
== sizeof (GLYPH
))))
952 && (SCREEN_CURSOR_X (selected_screen
)
953 != SCREEN_WIDTH (selected_screen
) - 1)
954 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
956 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
958 && !windows_or_buffers_changed
959 && EQ (current_buffer
->selective_display
, Qnil
)
960 && !detect_input_pending ()
961 && NILP (Vexecuting_macro
))
962 no_redisplay
= direct_output_forward_char (1);
965 else if (EQ (cmd
, Qbackward_char
) && point
> BEGV
)
967 struct Lisp_Vector
*dp
968 = window_display_table (XWINDOW (selected_window
));
970 lose
= FETCH_CHAR (point
);
971 if (((dp
== 0 && lose
>= 040 && lose
< 0177)
973 (dp
&& (XTYPE (dp
->contents
[lose
]) != Lisp_String
974 || XSTRING (dp
->contents
[lose
])->size
== sizeof (GLYPH
))))
975 && (SCREEN_CURSOR_X (selected_screen
) != 0)
976 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
978 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
980 && !windows_or_buffers_changed
981 && EQ (current_buffer
->selective_display
, Qnil
)
982 && !detect_input_pending ()
983 && NILP (Vexecuting_macro
))
984 no_redisplay
= direct_output_forward_char (-1);
987 else if (EQ (cmd
, Qself_insert_command
)
988 /* Try this optimization only on ascii keystrokes. */
989 && XTYPE (last_command_char
) == Lisp_Int
)
991 unsigned char c
= XINT (last_command_char
);
993 if (NILP (Vexecuting_macro
) &&
994 !EQ (minibuf_window
, selected_window
))
996 if (!nonundocount
|| nonundocount
>= 20)
1003 lose
= (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1005 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1007 || MODIFF
<= current_buffer
->save_modified
1008 || windows_or_buffers_changed
1009 || !EQ (current_buffer
->selective_display
, Qnil
)
1010 || detect_input_pending ()
1011 || !NILP (Vexecuting_macro
);
1012 if (internal_self_insert (c
, 0))
1018 (point
== ZV
|| FETCH_CHAR (point
) == '\n'))
1020 struct Lisp_Vector
*dp
1021 = window_display_table (XWINDOW (selected_window
));
1023 if (dp
== 0 || XTYPE (dp
->contents
[c
]) != Lisp_String
)
1024 no_redisplay
= direct_output_for_insert (c
);
1025 else if (XSTRING (dp
->contents
[c
])->size
1028 direct_output_for_insert (*(GLYPH
*)XSTRING (dp
->contents
[c
])->data
);
1034 /* Here for a command that isn't executed directly */
1037 if (NILP (Vprefix_arg
))
1039 Fcommand_execute (cmd
, Qnil
);
1044 /* If there is a prefix argument,
1045 1) We don't want last_command to be ``universal-argument''
1046 (that would be dumb), so don't set last_command,
1047 2) we want to leave echoing on so that the prefix will be
1048 echoed as part of this key sequence, so don't call
1050 3) we want to leave this_command_key_count non-zero, so that
1051 read_char will realize that it is re-reading a character, and
1052 not echo it a second time. */
1053 if (NILP (Vprefix_arg
))
1055 last_command
= this_command
;
1057 this_command_key_count
= 0;
1062 /* Number of seconds between polling for input. */
1065 /* Nonzero means polling for input is temporarily suppresed. */
1066 int poll_suppress_count
;
1068 #ifdef POLL_FOR_INPUT
1069 int polling_for_input
;
1071 /* Handle an alarm once each second and read pending input
1072 so as to handle a C-g if it comces in. */
1075 input_poll_signal ()
1077 #ifdef HAVE_X_WINDOWS
1078 extern int x_input_blocked
;
1079 if (x_input_blocked
== 0)
1081 if (!waiting_for_input
)
1082 read_avail_input (0);
1083 signal (SIGALRM
, input_poll_signal
);
1084 alarm (polling_period
);
1089 /* Begin signals to poll for input, if they are appropriate.
1090 This function is called unconditionally from various places. */
1094 #ifdef POLL_FOR_INPUT
1095 if (read_socket_hook
)
1097 poll_suppress_count
--;
1098 if (poll_suppress_count
== 0)
1100 signal (SIGALRM
, input_poll_signal
);
1101 polling_for_input
= 1;
1102 alarm (polling_period
);
1108 /* Turn off polling. */
1112 #ifdef POLL_FOR_INPUT
1113 if (read_socket_hook
)
1115 if (poll_suppress_count
== 0)
1117 polling_for_input
= 0;
1120 poll_suppress_count
++;
1125 /* Input of single characters from keyboard */
1127 Lisp_Object
print_help ();
1128 static Lisp_Object
kbd_buffer_get_event ();
1130 /* read a character from the keyboard; call the redisplay if needed */
1131 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1132 -1 means do not do redisplay, but do do autosaving.
1136 read_char (commandflag
)
1139 register Lisp_Object c
;
1143 if (!NILP (unread_command_char
))
1145 c
= unread_command_char
;
1146 unread_command_char
= Qnil
;
1148 #if 0 /* We're not handling mouse keys specially anymore. */
1149 if (!EQ (XTYPE (obj
), Lisp_Int
)) /* Mouse thing */
1152 last_input_char
= 0;
1157 if (this_command_key_count
== 0)
1163 if (!NILP (Vexecuting_macro
))
1165 if (executing_macro_index
>= Flength (Vexecuting_macro
))
1167 XSET (c
, Lisp_Int
, -1);
1171 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1172 executing_macro_index
++;
1177 /* Save outer setjmp data, in case called recursively. */
1178 bcopy (getcjmp
, save_jump
, sizeof getcjmp
);
1182 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1185 if (_setjmp (getcjmp
))
1187 XSET (c
, Lisp_Int
, quit_char
);
1189 /* Returning quit_char from this function represents a
1190 resolution to the quit request, so clear the quit flag.
1191 This prevents us from returning quit_char many times
1192 for the same quit request. */
1195 waiting_for_input
= 0;
1196 input_available_clear_word
= 0;
1201 /* Message turns off echoing unless more keystrokes turn it on again. */
1202 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1205 /* If already echoing, continue. */
1208 /* If in middle of key sequence and minibuffer not active,
1209 start echoing if enough time elapses. */
1210 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1211 && echo_keystrokes
> 0
1212 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1216 tem0
= Fsit_for (make_number (echo_keystrokes
), Qnil
, Qt
);
1221 /* Maybe auto save due to number of keystrokes or idle time. */
1223 if (commandflag
!= 0
1224 && auto_save_interval
> 0
1225 && num_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1226 && !detect_input_pending ())
1229 save_getcjmp (temp
);
1230 Fdo_auto_save (Qnil
, Qnil
);
1231 restore_getcjmp (temp
);
1234 /* Slow down auto saves logarithmically in size of current buffer,
1235 and garbage collect while we're at it. */
1237 int delay_level
, buffer_size
;
1239 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1240 last_non_minibuf_size
= Z
- BEG
;
1241 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1243 while (buffer_size
> 64)
1244 delay_level
++, buffer_size
-= buffer_size
>> 2;
1245 if (delay_level
< 4) delay_level
= 4;
1246 /* delay_level is 4 for files under around 50k, 7 at 100k,
1247 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1249 /* Auto save if enough time goes by without input. */
1250 if (commandflag
!= 0
1251 && num_input_chars
> last_auto_save
1252 && XTYPE (Vauto_save_timeout
) == Lisp_Int
1253 && XINT (Vauto_save_timeout
) > 0)
1256 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1257 tem0
= Fsit_for (make_number (delay
), Qnil
, Qt
);
1261 save_getcjmp (temp
);
1262 Fdo_auto_save (Qnil
, Qnil
);
1263 restore_getcjmp (temp
);
1265 /* If we have auto-saved and there is still no input
1266 available, garbage collect if there has been enough
1267 consing going on to make it worthwhile. */
1268 if (!detect_input_pending ()
1269 && consing_since_gc
> gc_cons_threshold
/ 2)
1270 Fgarbage_collect ();
1275 /* Actually read a character, waiting if necessary. */
1276 c
= kbd_buffer_get_event ();
1279 abort (); /* Don't think this can happen. */
1281 #if 0 /* I think that all the different kinds of events should be
1282 handled together now... */
1283 if (XTYPE (c
) != Lisp_Int
)
1291 /* Terminate Emacs in batch mode if at eof. */
1292 if (noninteractive
&& c
< 0)
1293 Fkill_emacs (make_number (1));
1297 bcopy (save_jump
, getcjmp
, sizeof getcjmp
);
1301 echo_area_glyphs
= 0;
1303 /* Handle things that only apply to characters. */
1304 if (XTYPE (c
) == Lisp_Int
)
1306 /* If kbd_buffer_get_event gave us an EOF, return that. */
1310 /* Strip the high bits, and maybe the meta bit too. */
1311 XSETINT (c
, c
& (meta_key
? 0377 : 0177));
1313 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
1314 && XSTRING (Vkeyboard_translate_table
)->size
> XINT (c
))
1315 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[c
]);
1319 recent_keys
[recent_keys_index
] = c
;
1320 if (++recent_keys_index
>= (sizeof (recent_keys
)/sizeof(recent_keys
[0])))
1321 recent_keys_index
= 0;
1323 /* Write c to the dribble file. If c is a lispy event, write
1324 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1325 If you, dear reader, have a better idea, you've got the source. :-) */
1328 if (XTYPE (c
) == Lisp_Int
)
1332 Lisp_Object dribblee
= c
;
1334 /* If it's a structured event, take the event header. */
1335 if (EVENT_HAS_PARAMETERS (dribblee
))
1336 dribblee
= EVENT_HEAD (dribblee
);
1338 if (XTYPE (c
) == Lisp_Symbol
)
1340 putc ('<', dribble
);
1341 fwrite (XSYMBOL (c
)->name
->data
, sizeof (char),
1342 XSYMBOL (c
)->name
->size
,
1344 putc ('>', dribble
);
1351 store_kbd_macro_char (c
);
1357 /* Record this character as part of the current key. */
1358 add_command_key (c
);
1360 /* Re-reading in the middle of a command */
1362 last_input_char
= c
;
1365 /* Process the help character specially if enabled */
1366 if (EQ (c
, help_char
) && !NILP (Vhelp_form
))
1369 count
= specpdl_ptr
- specpdl
;
1371 record_unwind_protect (Fset_window_configuration
,
1372 Fcurrent_window_configuration (Qnil
));
1374 tem0
= Feval (Vhelp_form
);
1375 if (XTYPE (tem0
) == Lisp_String
)
1376 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1380 /* Remove the help from the screen */
1381 unbind_to (count
, Qnil
);
1383 if (EQ (c
, make_number (040)))
1397 Fprinc (object
, Qnil
);
1401 /* Copy out or in the info on where C-g should throw to.
1402 This is used when running Lisp code from within get_char,
1403 in case get_char is called recursively.
1404 See read_process_output. */
1409 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1412 restore_getcjmp (temp
)
1415 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1419 /* Low level keyboard/mouse input.
1420 kbd_buffer_store_event places events in kbd_buffer, and
1421 kbd_buffer_get_event retrieves them.
1422 mouse_moved indicates when the mouse has moved again, and
1423 *mouse_position_hook provides the mouse position. */
1425 /* Set this for debugging, to have a way to get out */
1428 extern int screen_garbaged
;
1430 /* Return true iff there are any events in the queue that read-char
1431 would return. If this returns false, a read-char would block. */
1435 struct input_event
*ep
;
1437 if (EVENT_QUEUES_EMPTY
)
1440 if (do_mouse_tracking
)
1443 /* Mouse tracking is disabled, so we need to actually scan the
1444 input queue to see if any events are currently readable. */
1445 for (ep
= kbd_fetch_ptr
; ep
!= kbd_store_ptr
; ep
++)
1447 if (ep
== kbd_buffer
+ KBD_BUFFER_SIZE
)
1450 /* Skip button-up events. */
1451 if ((ep
->kind
== mouse_click
|| ep
->kind
== scrollbar_click
)
1452 && (ep
->modifiers
& up_modifier
))
1462 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1463 of this function. */
1465 tracking_off (old_value
)
1466 Lisp_Object old_value
;
1468 if (! XFASTINT (old_value
))
1470 do_mouse_tracking
= 0;
1472 /* Redisplay may have been preempted because there was input
1473 available, and it assumes it will be called again after the
1474 input has been processed. If the only input available was
1475 the sort that we have just disabled, then we need to call
1477 if (!readable_events ())
1479 redisplay_preserve_echo_area ();
1480 get_input_pending (&input_pending
);
1485 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1486 "Evaluate BODY with mouse movement and button release events enabled.\n\
1487 Within a track-mouse, read-event reports mouse movement and button releases;\n\
1488 otherwise, they are ignored.")
1492 int count
= specpdl_ptr
- specpdl
;
1495 XSET (val
, Lisp_Int
, do_mouse_tracking
);
1496 record_unwind_protect (tracking_off
, val
);
1498 do_mouse_tracking
= 1;
1500 val
= Fprogn (args
);
1501 return unbind_to (count
, val
);
1504 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
1507 kbd_buffer_store_event (event
)
1508 register struct input_event
*event
;
1510 if (event
->kind
== no_event
)
1513 if (event
->kind
== ascii_keystroke
)
1515 register int c
= XFASTINT (event
->code
) & 0377;
1518 || ((c
== (0200 | quit_char
)) && !meta_key
))
1520 /* If this results in a quit_char being returned to Emacs as
1521 input, set last-event-screen properly. If this doesn't
1522 get returned to Emacs as an event, the next event read
1523 will set Vlast_event_screen again, so this is safe to do. */
1524 extern SIGTYPE
interrupt_signal ();
1525 XSET (Vlast_event_screen
, Lisp_Screen
, event
->screen
);
1526 last_event_timestamp
= XINT (event
->timestamp
);
1527 interrupt_signal ();
1531 if (c
&& c
== stop_character
)
1537 XSET (event
->code
, Lisp_Int
, c
);
1540 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
1541 kbd_store_ptr
= kbd_buffer
;
1543 /* Don't let the very last slot in the buffer become full,
1544 since that would make the two pointers equal,
1545 and that is indistinguishable from an empty buffer.
1546 Discard the event if it would fill the last slot. */
1547 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
1549 kbd_store_ptr
->kind
= event
->kind
;
1550 kbd_store_ptr
->code
= event
->code
;
1551 kbd_store_ptr
->part
= event
->part
;
1552 kbd_store_ptr
->screen
= event
->screen
;
1553 kbd_store_ptr
->modifiers
= event
->modifiers
;
1554 kbd_store_ptr
->x
= event
->x
;
1555 kbd_store_ptr
->y
= event
->y
;
1556 kbd_store_ptr
->timestamp
= event
->timestamp
;
1562 static Lisp_Object
make_lispy_event ();
1563 static Lisp_Object
make_lispy_movement ();
1564 static Lisp_Object
modify_event_symbol ();
1567 kbd_buffer_get_event ()
1575 XSET (obj
, Lisp_Int
, c
);
1579 /* Wait until there is input available. */
1583 /* Process or toss any events that we don't want to return as
1584 input. The fact that we remove undesirable events here
1585 allows us to use EVENT_QUEUES_EMPTY in the rest of this loop. */
1586 if (! do_mouse_tracking
)
1587 while (kbd_fetch_ptr
!= kbd_store_ptr
)
1589 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
1590 kbd_fetch_ptr
= kbd_buffer
;
1592 if (kbd_fetch_ptr
->kind
== mouse_click
1593 || kbd_fetch_ptr
->kind
== scrollbar_click
)
1595 if ((kbd_fetch_ptr
->modifiers
& up_modifier
) == 0)
1604 if (!EVENT_QUEUES_EMPTY
)
1607 /* If the quit flag is set, then read_char will return
1608 quit_char, so that counts as "available input." */
1609 if (!NILP (Vquit_flag
))
1610 quit_throw_to_read_char ();
1612 /* One way or another, wait until input is available; then, if
1613 interrupt handlers have not read it, read it now. */
1616 wait_for_kbd_input ();
1618 /* Note SIGIO has been undef'd if FIONREAD is missing. */
1622 if (EVENT_QUEUES_EMPTY
)
1625 wait_reading_process_input (0, 0, -1, 1);
1627 /* Note SIGIO has been undef'd if FIONREAD is missing. */
1629 if (interrupt_input
)
1632 set_waiting_for_input (0);
1633 while (EVENT_QUEUES_EMPTY
)
1635 clear_waiting_for_input ();
1636 sigunblockx (SIGIO
);
1639 interrupt_input
= 0;
1640 #endif /* not SIGIO */
1641 #endif /* subprocesses */
1643 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
1645 read_avail_input (0);
1648 #endif /* not VMS */
1651 /* At this point, we know that there is a readable event available
1652 somewhere. If the event queue is empty, then there must be a
1653 mouse movement enabled and available. */
1654 if (kbd_fetch_ptr
!= kbd_store_ptr
)
1656 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
1657 kbd_fetch_ptr
= kbd_buffer
;
1658 XSET (Vlast_event_screen
, Lisp_Screen
, kbd_fetch_ptr
->screen
);
1659 last_event_timestamp
= XINT (kbd_fetch_ptr
->timestamp
);
1660 obj
= make_lispy_event (kbd_fetch_ptr
);
1661 kbd_fetch_ptr
->kind
= no_event
;
1663 if (XTYPE (obj
) == Lisp_Int
)
1664 XSET (obj
, Lisp_Int
, XINT (obj
) & (meta_key
? 0377 : 0177));
1666 else if (do_mouse_tracking
&& mouse_moved
)
1669 Lisp_Object x
, y
, time
;
1671 (*mouse_position_hook
) (&screen
, &x
, &y
, &time
);
1672 XSET (Vlast_event_screen
, Lisp_Screen
, screen
);
1674 obj
= make_lispy_movement (screen
, x
, y
, time
);
1677 /* We were promised by the above while loop that there was
1678 something for us to read! */
1681 input_pending
= readable_events ();
1686 /* Caches for modify_event_symbol. */
1687 static Lisp_Object func_key_syms
;
1688 static Lisp_Object mouse_syms
;
1690 /* You'll notice that this table is arranged to be conveniently
1691 indexed by X Windows keysym values. */
1692 static char *lispy_function_keys
[] =
1694 /* X Keysym value */
1696 "home", /* 0xff50 */ /* IsCursorKey */
1707 "select", /* 0xff60 */ /* IsMiscFunctionKey */
1718 "break", /* 0xff6b */
1720 /* Here are some keys found mostly on HP keyboards. The X event
1721 handling code will strip bit 29, which flags vendor-specific
1723 "reset", /* 0x1000ff6c */
1732 "kp_backtab", /* 0x1000ff75 */
1734 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff7f */
1735 "kp-space", /* 0xff80 */ /* IsKeypadKey */
1736 0, 0, 0, 0, 0, 0, 0, 0,
1737 "kp-tab", /* 0xff89 */
1739 "kp-enter", /* 0xff8d */
1741 "kp-f1", /* 0xff91 */
1746 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
1747 "kp-multiply", /* 0xffaa */
1752 "kp-divide", /* 0xffaf */
1753 "kp-0", /* 0xffb0 */
1754 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
1757 "kp-equal", /* 0xffbd */
1758 "f1", /* 0xffbe */ /* IsFunctionKey */
1760 "f5", "f6", "f7", "f8", "f9", "f10", "f11", "f12",
1761 "f13", "f14", "f15", "f16", "f17", "f18", "f19", "f20",
1762 "f21", "f22", "f23", "f24", "f25", "f26", "f27", "f28",
1763 "f29", "f30", "f31", "f32", "f33", "f34", "f35" /* 0xffe0 */
1766 static char *lispy_mouse_names
[] =
1768 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
1771 /* Given a struct input_event, build the lisp event which represents
1772 it. If EVENT is 0, build a mouse movement event from the mouse
1773 movement buffer, which should have a movement event in it. */
1776 make_lispy_event (event
)
1777 struct input_event
*event
;
1779 #ifdef SWITCH_ENUM_BUG
1780 switch ((int) event
->kind
)
1782 switch (event
->kind
)
1786 /* A simple keystroke. */
1787 case ascii_keystroke
:
1791 /* A function key. The symbol may need to have modifier prefixes
1793 case non_ascii_keystroke
:
1794 return modify_event_symbol (XFASTINT (event
->code
), event
->modifiers
,
1796 lispy_function_keys
, &func_key_syms
,
1797 (sizeof (lispy_function_keys
)
1798 / sizeof (lispy_function_keys
[0])));
1801 /* A mouse click - build a list of the relevant information. */
1805 Lisp_Object window
=
1806 window_from_coordinates (event
->screen
,
1807 XINT (event
->x
), XINT (event
->y
),
1811 if (XTYPE (window
) != Lisp_Window
)
1815 XSETINT (event
->x
, (XINT (event
->x
)
1816 - XINT (XWINDOW (window
)->left
)));
1817 XSETINT (event
->y
, (XINT (event
->y
)
1818 - XINT (XWINDOW (window
)->top
)));
1823 posn
= Qvertical_split
;
1825 XSET (posn
, Lisp_Int
,
1826 buffer_posn_from_coords (XWINDOW (window
),
1831 return Fcons (modify_event_symbol (XFASTINT (event
->code
) - 1,
1834 lispy_mouse_names
, &mouse_syms
,
1835 (sizeof (lispy_mouse_names
)
1836 / sizeof (lispy_mouse_names
[0]))),
1839 Fcons (Fcons (event
->x
, event
->y
),
1840 Fcons (event
->timestamp
,
1844 /* A scrollbar click. Build a list containing the relevant
1846 case scrollbar_click
:
1849 = modify_event_symbol (XFASTINT (event
->code
) - 1,
1852 lispy_mouse_names
, &mouse_syms
,
1853 (sizeof (lispy_mouse_names
)
1854 / sizeof (lispy_mouse_names
[0])));
1855 return Fcons (event
->part
,
1856 Fcons (SCREEN_SELECTED_WINDOW (event
->screen
),
1858 Fcons (Fcons (event
->x
, event
->y
),
1859 Fcons (event
->timestamp
,
1863 /* The 'kind' field of the event is something we don't recognize. */
1870 make_lispy_movement (screen
, x
, y
, time
)
1883 ? window_from_coordinates (screen
, ix
, iy
, &part
)
1885 if (XTYPE (window
) != Lisp_Window
)
1889 ix
-= XINT (XWINDOW (window
)->left
);
1890 iy
-= XINT (XWINDOW (window
)->top
);
1894 posn
= Qvertical_split
;
1896 XSET (posn
, Lisp_Int
, buffer_posn_from_coords (XWINDOW (window
),
1902 return Fcons (Qmouse_movement
,
1905 Fcons (Fcons (x
, y
),
1906 Fcons (time
, Qnil
)))));
1911 /* Place the written representation of MODIFIERS in BUF, '\0'-terminated,
1912 and return its length. */
1915 format_modifiers (modifiers
, buf
)
1921 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
1922 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
1923 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
1924 if (modifiers
& up_modifier
) { *p
++ = 'U'; *p
++ = '-'; }
1931 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
1932 return a symbol with the modifiers placed in the canonical order.
1934 Fdefine_key calls this to make sure that (for example) C-M-foo
1935 and M-C-foo end up being equivalent in the keymap. */
1938 reorder_modifiers (symbol
)
1941 struct Lisp_String
*name
;
1946 CHECK_SYMBOL (symbol
, 1);
1949 name
= XSYMBOL (symbol
)->name
;
1951 /* Special case for things with only one modifier, which is
1952 (hopefully) the vast majority of cases. */
1953 if (! (name
->size
>= 4 && name
->data
[1] == '-' && name
->data
[3] == '-'))
1956 for (i
= 0; i
+ 1 < name
->size
&& name
->data
[i
+ 1] == '-'; i
+= 2)
1957 switch (name
->data
[i
])
1960 not_canonical
|= (modifiers
& (meta_modifier
|ctrl_modifier
1961 |shift_modifier
|up_modifier
));
1962 modifiers
|= meta_modifier
;
1966 not_canonical
|= (modifiers
&
1967 (ctrl_modifier
|shift_modifier
|up_modifier
));
1968 modifiers
|= ctrl_modifier
;
1972 not_canonical
|= (modifiers
& (shift_modifier
|up_modifier
));
1973 modifiers
|= shift_modifier
;
1977 not_canonical
|= (modifiers
& (up_modifier
));
1978 modifiers
|= up_modifier
;
1982 goto no_more_modifiers
;
1989 /* The modifiers were out of order, so find a new symbol with the
1990 mods in order. Since the symbol name could contain nulls, we can't
1991 use intern here; we have to use Fintern, which expects a genuine
1992 Lisp_String, and keeps a reference to it. */
1994 char *new_mods
= (char *) alloca (sizeof ("C-M-S-U-"));
1995 int len
= format_modifiers (modifiers
, new_mods
);
1996 Lisp_Object new_name
= make_uninit_string (len
+ name
->size
- i
);
1998 bcopy (new_mods
, XSTRING (new_name
)->data
, len
);
1999 bcopy (name
->data
+ i
, XSTRING (new_name
)->data
+ len
, name
->size
- i
);
2001 return Fintern (new_name
, Qnil
);
2006 /* For handling events, we often want to produce a symbol whose name
2007 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
2008 to some base, like the name of a function key or mouse button.
2009 modify_event_symbol produces symbols of this sort.
2011 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
2012 is the name of the i'th symbol. TABLE_SIZE is the number of elements
2015 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
2016 persist between calls to modify_event_symbol that it can use to
2017 store a cache of the symbols it's generated for this NAME_TABLE
2020 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
2022 MODIFIERS is a set of modifier bits (as given in struct input_events)
2023 whose prefixes should be applied to the symbol name.
2025 SYMBOL_KIND is the value to be placed in the event_kind property of
2026 the returned symbol. */
2029 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_table
,
2030 symbol_table
, table_size
)
2033 Lisp_Object symbol_kind
;
2035 Lisp_Object
*symbol_table
;
2038 Lisp_Object
*slot
, *unmodified_slot
;
2040 /* Is this a request for a valid symbol? */
2041 if (symbol_num
< 0 || symbol_num
>= table_size
2042 || modifiers
>= NUM_MODIFIER_COMBOS
)
2045 /* If *symbol_table is not a vector of the appropriate size,
2047 if (XTYPE (*symbol_table
) != Lisp_Vector
2048 || XVECTOR (*symbol_table
)->size
!= table_size
)
2049 *symbol_table
= Fmake_vector (make_number (table_size
), Qnil
);
2051 unmodified_slot
= slot
= & XVECTOR (*symbol_table
)->contents
[symbol_num
];
2053 /* If there are modifier keys, there had better be a vector in
2054 this symbol's position of the symbol_table. */
2057 Lisp_Object slot_contents
= *slot
;
2059 /* If there isn't the right sort of vector there, put one in. */
2060 if (XTYPE (slot_contents
) != Lisp_Vector
2061 || XVECTOR (slot_contents
)->size
!= NUM_MODIFIER_COMBOS
)
2063 *slot
= Fmake_vector (make_number (NUM_MODIFIER_COMBOS
), Qnil
);
2065 /* Make sure that the vector has an entry for the unmodified
2066 symbol, so we can put it on the event_unmodified property. */
2067 if (! NILP (slot_contents
))
2068 XVECTOR (*slot
)->contents
[0] = slot_contents
;
2070 XVECTOR (*slot
)->contents
[0] = intern (name_table
[symbol_num
]);
2074 /* If this entry has been filled in with a modified symbol vector,
2075 point to the appropriate slot within that. */
2076 if (XTYPE (*slot
) == Lisp_Vector
)
2078 unmodified_slot
= & XVECTOR (*slot
)->contents
[0];
2079 slot
= & XVECTOR (*slot
)->contents
[modifiers
];
2082 /* Make sure we have an unmodified version of the symbol in its
2084 if (NILP (*unmodified_slot
))
2086 *unmodified_slot
= intern (name_table
[symbol_num
]);
2087 Fput (*unmodified_slot
, Qevent_kind
, symbol_kind
);
2088 Fput (*unmodified_slot
, Qevent_unmodified
, *unmodified_slot
);
2091 /* Have we already created a symbol for this combination of modifiers? */
2094 /* No, let's create one. */
2096 = (char *) alloca (sizeof ("C-M-S-U-")
2097 + strlen (name_table
[symbol_num
]));
2099 strcpy (modified_name
+ format_modifiers (modifiers
, modified_name
),
2100 name_table
[symbol_num
]);
2102 *slot
= intern (modified_name
);
2103 Fput (*slot
, Qevent_kind
, symbol_kind
);
2104 Fput (*slot
, Qevent_unmodified
, *unmodified_slot
);
2110 DEFUN ("mouse-click-p", Fmouse_click_p
, Smouse_click_p
, 1, 1, 0,
2111 "Return non-nil iff OBJECT is a representation of a mouse event.\n\
2112 A mouse event is a list of five elements whose car is a symbol of the\n\
2113 form <MODIFIERS>mouse-<DIGIT>. I hope this is a temporary hack.")
2117 if (EVENT_HAS_PARAMETERS (object
)
2118 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (object
)),
2125 /* Store into *addr a value nonzero if terminal input chars are available.
2126 Serves the purpose of ioctl (0, FIONREAD, addr)
2127 but works even if FIONREAD does not exist.
2128 (In fact, this may actually read some input.) */
2131 get_input_pending (addr
)
2134 /* First of all, have we already counted some input? */
2135 *addr
= !NILP (Vquit_flag
) || readable_events ();
2137 /* If input is being read as it arrives, and we have none, there is none. */
2138 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
2141 /* Try to read some input and see how much we get. */
2143 *addr
= !NILP (Vquit_flag
) || readable_events ();
2146 /* Interface to read_avail_input, blocking SIGIO if necessary. */
2149 gobble_input (expected
)
2154 if (interrupt_input
)
2156 SIGMASKTYPE mask
= sigblockx (SIGIO
);
2157 read_avail_input (expected
);
2162 read_avail_input (expected
);
2168 /* Read any terminal input already buffered up by the system
2169 into the kbd_buffer, but do not wait.
2171 EXPECTED should be nonzero if the caller knows there is some input.
2173 Except on VMS, all input is read by this function.
2174 If interrupt_input is nonzero, this function MUST be called
2175 only when SIGIO is blocked.
2177 Returns the number of keyboard chars read, or -1 meaning
2178 this is a bad time to try to read input. */
2181 read_avail_input (expected
)
2184 struct input_event buf
[KBD_BUFFER_SIZE
];
2188 if (read_socket_hook
)
2189 /* No need for FIONREAD or fcntl; just say don't wait. */
2190 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
2193 unsigned char cbuf
[KBD_BUFFER_SIZE
];
2196 /* Find out how much input is available. */
2197 if (ioctl (0, FIONREAD
, &nread
) < 0)
2198 /* Formerly simply reported no input, but that sometimes led to
2199 a failure of Emacs to terminate.
2200 SIGHUP seems appropriate if we can't reach the terminal. */
2201 kill (getpid (), SIGHUP
);
2204 if (nread
> sizeof cbuf
)
2205 nread
= sizeof cbuf
;
2206 #else /* no FIONREAD */
2208 /* Read some input if available, but don't wait. */
2209 nread
= sizeof cbuf
;
2210 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
2216 /* Now read; for one reason or another, this will not block. */
2219 nread
= read (fileno (stdin
), cbuf
, nread
);
2221 /* The kernel sometimes fails to deliver SIGHUP for ptys.
2222 This looks incorrect, but it isn't, because _BSD causes
2223 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
2224 and that causes a value other than 0 when there is no input. */
2228 /* Retry the read if it is interrupted. */
2230 || ! (errno
== EAGAIN
|| errno
== EFAULT
2240 fcntl (fileno (stdin
), F_SETFL
, 0);
2242 #endif /* no FIONREAD */
2243 for (i
= 0; i
< nread
; i
++)
2245 buf
[i
].kind
= ascii_keystroke
;
2246 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
2247 buf
[i
].screen
= selected_screen
;
2251 /* Scan the chars for C-g and store them in kbd_buffer. */
2252 for (i
= 0; i
< nread
; i
++)
2254 kbd_buffer_store_event (&buf
[i
]);
2255 /* Don't look at input that follows a C-g too closely.
2256 This reduces lossage due to autorepeat on C-g. */
2257 if (buf
[i
].kind
== ascii_keystroke
2258 && XINT(buf
[i
].code
) == quit_char
)
2264 #endif /* not VMS */
2266 #ifdef SIGIO /* for entire page */
2267 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2269 input_available_signal (signo
)
2272 /* Must preserve main program's value of errno. */
2273 int old_errno
= errno
;
2275 extern int select_alarmed
;
2279 /* USG systems forget handlers when they are used;
2280 must reestablish each time */
2281 signal (signo
, input_available_signal
);
2288 if (input_available_clear_word
)
2289 *input_available_clear_word
= 0;
2294 nread
= read_avail_input (1);
2295 /* -1 means it's not ok to read the input now.
2296 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
2297 0 means there was no keyboard input available. */
2302 select_alarmed
= 1; /* Force the select emulator back to life */
2313 /* Return the prompt-string of a sparse keymap.
2314 This is the first element which is a string.
2315 Return nil if there is none. */
2323 register Lisp_Object tem
;
2325 if (XTYPE (tem
) == Lisp_String
)
2332 static int echo_flag
;
2333 static int echo_now
;
2335 /* Read a character like read_char but optionally prompt based on maps
2338 The prompting is done based on the prompt-string of the map
2339 and the strings associated with various map elements. */
2342 read_char_menu_prompt (prompt
, local
, global
)
2344 Lisp_Object local
, global
;
2346 register Lisp_Object rest
, name
;
2349 int width
= SCREEN_WIDTH (selected_screen
) - 4;
2350 char *menu
= (char *) alloca (width
);
2352 /* Use local over global Menu maps */
2355 return read_char (!prompt
);
2357 /* We can't get prompt strings from dense keymaps. */
2359 && EQ (Fcar (local
), Qkeymap
)
2360 && !(CONSP (XCONS (local
)->cdr
)
2361 && XTYPE (XCONS (XCONS (local
)->cdr
)->car
) == Lisp_Vector
))
2363 else if (CONSP (global
)
2364 && EQ (Fcar (global
), Qkeymap
)
2365 && !(CONSP (XCONS (global
)->cdr
)
2366 && XTYPE (XCONS (XCONS (global
)->cdr
)->car
) == Lisp_Vector
))
2369 return read_char (!prompt
);
2371 /* Get the map's prompt string. */
2372 name
= map_prompt (hmap
);
2374 return read_char (!prompt
);
2376 /* Prompt string always starts with map's prompt, and a space. */
2377 strcpy (menu
, XSTRING (name
)->data
);
2378 nlength
= XSTRING (name
)->size
;
2379 menu
[nlength
++] = ' ';
2382 /* Start prompting at start of map. */
2383 rest
= hmap
; /* Current menu item */
2385 /* Present the documented bindings, a line at a time. */
2393 /* If reached end of map, start at beginning. */
2394 if (NILP (Fcdr (rest
))) rest
= hmap
;
2396 /* Loop over elements of map. */
2397 while (!NILP (rest
) && i
< width
)
2401 /* Look for conses whose cadrs are strings. */
2402 s
= Fcar_safe (Fcdr_safe (Fcar_safe (rest
)));
2403 if (XTYPE (s
) != Lisp_String
)
2404 /* Ignore all other elements. */
2406 /* If first such element, or enough room, add string to prompt. */
2407 else if (XSTRING (s
)->size
+ i
< width
2412 /* Punctuate between strings. */
2415 strcpy (menu
+ i
, ", ");
2420 /* Add as much of string as fits. */
2421 thiswidth
= XSTRING (s
)->size
;
2422 if (thiswidth
+ i
> width
)
2423 thiswidth
= width
- i
;
2424 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
2429 /* If some elts don't fit, show there are more. */
2430 strcpy (menu
+ i
, "...");
2434 /* Move past this element. */
2435 rest
= Fcdr_safe (rest
);
2438 /* Prompt with that and read response. */
2440 obj
= read_char (1);
2442 if (XTYPE (obj
) != Lisp_Int
)
2447 if (obj
!= menu_prompt_more_char
2448 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
2449 || obj
!= make_number (Ctl (XINT (menu_prompt_more_char
)))))
2455 /* Reading key sequences. */
2457 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
2458 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
2459 keymap, or nil otherwise. Return the index of the first keymap in
2460 which KEY has any binding, or NMAPS if no map has a binding.
2462 If KEY is a meta ASCII character, treat it like meta-prefix-char
2463 followed by the corresponding non-meta character. Keymaps in
2464 CURRENT with non-prefix bindings for meta-prefix-char become nil in
2467 When KEY is not defined in any of the keymaps, if it is an upper
2468 case letter and there are bindings for the corresponding lower-case
2469 letter, return the bindings for the lower-case letter.
2471 NEXT may == CURRENT. */
2474 follow_key (key
, nmaps
, current
, defs
, next
)
2476 Lisp_Object
*current
, *defs
, *next
;
2479 int i
, first_binding
;
2481 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
2482 followed by the corresponding non-meta character. */
2483 if (XTYPE (key
) == Lisp_Int
2484 && XINT (key
) >= 0200)
2486 for (i
= 0; i
< nmaps
; i
++)
2487 if (! NILP (current
[i
]))
2489 next
[i
] = get_keyelt (access_keymap (current
[i
],
2492 /* Note that since we pass the resulting bindings through
2493 get_keymap_1, non-prefix bindings for meta-prefix-char
2495 next
[i
] = get_keymap_1 (next
[i
], 0);
2501 XSET (key
, Lisp_Int
, XFASTINT (key
) & 0177);
2504 first_binding
= nmaps
;
2505 for (i
= nmaps
- 1; i
>= 0; i
--)
2507 if (! NILP (current
[i
]))
2509 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
));
2510 if (! NILP (defs
[i
]))
2517 /* When KEY is not defined in any of the keymaps, if it is an upper
2518 case letter and there are bindings for the corresponding
2519 lower-case letter, return the bindings for the lower-case letter. */
2520 if (first_binding
== nmaps
2521 && XTYPE (key
) == Lisp_Int
2522 && UPPERCASEP (XINT (key
)))
2524 XSETINT (key
, DOWNCASE (XINT (key
)));
2526 first_binding
= nmaps
;
2527 for (i
= nmaps
- 1; i
>= 0; i
--)
2529 if (! NILP (current
[i
]))
2531 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
));
2532 if (! NILP (defs
[i
]))
2540 /* Given the set of bindings we've found, produce the next set of maps. */
2541 for (i
= 0; i
< nmaps
; i
++)
2542 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0);
2544 return first_binding
;
2547 /* Read a sequence of keys that ends with a non prefix character
2548 according to the keymaps in KEYMAPS[0..nmaps-1]. Keymaps appearing
2549 earlier in KEYMAPS take precidence over those appearing later.
2551 Store the sequence in KEYBUF, a buffer of size BUFSIZE. Prompt
2552 with PROMPT. Echo starting immediately unless `prompt' is 0.
2553 Return the length of the key sequence stored.
2555 If the user switches screens in the midst of a key sequence, we
2556 throw away any prefix we have read so far, and start afresh. For
2557 mouse clicks, we look up the click in the keymap of the buffer
2558 clicked on, throwing away any prefix if it is not the same buffer
2559 we used to be reading from. */
2562 read_key_sequence (keybuf
, bufsize
, prompt
)
2563 Lisp_Object
*keybuf
;
2567 /* How many keys there are in the current key sequence. */
2570 /* The buffer that the most recently read event was typed at. This
2571 helps us read mouse clicks according to the buffer clicked in,
2572 and notice when the mouse has moved from one screen to another. */
2573 struct buffer
*last_event_buffer
= current_buffer
;
2575 /* The length of the echo buffer when we started reading, and
2576 the length of this_command_keys when we started reading. */
2578 int keys_start
= this_command_key_count
;
2580 /* The number of keymaps we're scanning right now, and the number of
2581 keymaps we have allocated space for. */
2583 int nmaps_allocated
= 0;
2585 /* current[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
2586 in the current keymaps, or nil where it is not a prefix. */
2587 Lisp_Object
*current
;
2589 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
2590 the current keymaps. */
2593 /* The lowest i such that defs[i] is non-nil. */
2596 /* If mock_input > t, then KEYBUF[t] should be read as the next
2600 /* If the sequence is unbound in current[], keymap[fkey_start..fkey_end-1]
2601 is a prefix in Vfunction_key_map, and fkey_map is its binding.
2602 These might be > t, indicating that all function key scanning should
2603 hold off until t reaches them. */
2604 int fkey_start
= 0, fkey_end
= 0;
2605 Lisp_Object fkey_map
= Vfunction_key_map
;
2610 echo_prompt (prompt
);
2611 else if (cursor_in_echo_area
)
2612 /* This doesn't put in a dash if the echo buffer is empty, so
2613 you don't always see a dash hanging out in the minibuffer. */
2615 echo_start
= echo_length ();
2618 /* If there is no function key map, turn of function key scanning. */
2619 if (NILP (Fkeymapp (Vfunction_key_map
)))
2620 fkey_start
= fkey_end
= bufsize
+ 1;
2624 this_command_key_count
= keys_start
;
2629 nmaps
= current_minor_maps (0, &maps
) + 2;
2630 if (nmaps
> nmaps_allocated
)
2632 current
= (Lisp_Object
*) alloca (nmaps
* sizeof (current
[0]));
2633 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
2634 nmaps_allocated
= nmaps
;
2636 bcopy (maps
, current
, (nmaps
- 2) * sizeof (current
[0]));
2637 current
[nmaps
-2] = last_event_buffer
->keymap
;
2638 current
[nmaps
-1] = global_map
;
2641 /* Find an accurate initial value for first_binding. */
2642 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
2643 if (! NILP (current
[first_binding
]))
2646 while ((first_binding
< nmaps
&& ! NILP (current
[first_binding
]))
2647 || (first_binding
>= nmaps
&& fkey_start
< t
))
2652 error ("key sequence too long");
2654 /* Are we reading keys stuffed into keybuf? */
2658 add_command_key (key
);
2661 /* Otherwise, we should actually read a character. */
2666 if (!prompt
&& INTERACTIVE
)
2667 key
= read_char_menu_prompt (prompt
, Qnil
, Qnil
);
2669 key
= read_char (!prompt
);
2671 /* The above routines return -1 at the end of a macro.
2672 Emacs 18 handles this by returning immediately with a
2673 zero, so that's what we'll do. */
2674 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) < 0)
2679 /* What buffer was this event typed/moused at? */
2680 if (XTYPE (key
) == Lisp_Int
|| XTYPE (key
) == Lisp_Symbol
)
2683 (SCREEN_SELECTED_WINDOW
2684 (XSCREEN (Vlast_event_screen
)))->buffer
));
2685 else if (EVENT_HAS_PARAMETERS (key
))
2687 Lisp_Object window
= EVENT_WINDOW (key
);
2692 buf
= XBUFFER (XWINDOW (window
)->buffer
);
2697 /* If this event came to a different buffer than the one
2698 we're currently in, switch buffers and start a new key
2699 sequence, starting with key. */
2700 if (buf
!= last_event_buffer
)
2702 last_event_buffer
= buf
;
2703 Fselect_screen (Vlast_event_screen
, Qnil
);
2705 /* Arrange to read key as the next event. */
2709 /* Truncate the key sequence in the echo area. */
2711 echo_truncate (echo_start
);
2717 first_binding
= (follow_key (key
,
2718 nmaps
- first_binding
,
2719 current
+ first_binding
,
2720 defs
+ first_binding
,
2721 current
+ first_binding
)
2725 /* If the sequence is unbound, see if we can hang a function key
2726 off the end of it. Don't reread the expansion of a function key. */
2727 if (first_binding
>= nmaps
2730 Lisp_Object fkey_next
;
2732 /* Scan from fkey_end until we find a bound suffix. */
2733 while (fkey_end
< t
)
2736 get_keyelt (access_keymap (fkey_map
, keybuf
[fkey_end
++]));
2738 /* If keybuf[fkey_start..fkey_next] is bound in the
2739 function key map and it's a suffix, replace it with
2740 the binding and restart. */
2741 if (XTYPE (fkey_next
) == Lisp_Vector
2744 t
= fkey_start
+ XVECTOR (fkey_next
)->size
;
2746 error ("key sequence too long");
2748 bcopy (XVECTOR (fkey_next
)->contents
,
2749 keybuf
+ fkey_start
,
2750 (t
- fkey_start
) * sizeof (keybuf
[0]));
2753 fkey_start
= fkey_end
= t
;
2755 /* Truncate the key sequence in the echo area. */
2757 echo_truncate (echo_start
);
2762 fkey_map
= get_keymap_1 (fkey_next
, 0);
2764 /* If we no longer have a bound suffix, advance
2765 the start of the function key suffix and continue
2766 scanning from there. */
2767 if (NILP (fkey_map
))
2769 fkey_end
= ++fkey_start
;
2770 fkey_map
= Vfunction_key_map
;
2776 read_key_sequence_cmd
= (first_binding
< nmaps
2777 ? defs
[first_binding
]
2783 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 1, 0,
2784 "Read a sequence of keystrokes and return as a string or vector.\n\
2785 The sequence is sufficient to specify a non-prefix command in the\n\
2786 current local and global maps.\n\
2788 Arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
2790 If Emacs is running on multiple screens, switching between screens in\n\
2791 the midst of a keystroke will toss any prefix typed so far. A C-g\n\
2792 typed while in this function is treated like any other character, and\n\
2793 `quit-flag' is not set.")
2797 Lisp_Object keybuf
[30];
2799 struct gcpro gcpro1
, gcpro2
;
2802 CHECK_STRING (prompt
, 0);
2805 bzero (keybuf
, sizeof keybuf
);
2807 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
2809 this_command_key_count
= 0;
2810 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
2811 NILP (prompt
) ? 0 : XSTRING (prompt
)->data
);
2814 return make_array (i
, keybuf
);
2817 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
2818 "Execute CMD as an editor command.\n\
2819 CMD must be a symbol that satisfies the `commandp' predicate.\n\
2820 Optional second arg RECORD-FLAG non-nil\n\
2821 means unconditionally put this command in `command-history'.\n\
2822 Otherwise, that is done only if an arg is read using the minibuffer.")
2824 Lisp_Object cmd
, record
;
2826 register Lisp_Object final
;
2827 register Lisp_Object tem
;
2828 Lisp_Object prefixarg
;
2829 struct backtrace backtrace
;
2830 extern int debug_on_next_call
;
2832 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
2833 Vcurrent_prefix_arg
= prefixarg
;
2834 debug_on_next_call
= 0;
2836 if (XTYPE (cmd
) == Lisp_Symbol
)
2838 tem
= Fget (cmd
, Qdisabled
);
2840 return call1 (Vrun_hooks
, Vdisabled_command_hook
);
2846 while (XTYPE (final
) == Lisp_Symbol
)
2848 if (EQ (Qunbound
, XSYMBOL (final
)->function
))
2849 Fsymbol_function (final
); /* Get an error! */
2850 final
= XSYMBOL (final
)->function
;
2853 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
2854 do_autoload (final
, cmd
);
2859 if (XTYPE (final
) == Lisp_String
2860 || XTYPE (final
) == Lisp_Vector
)
2862 /* If requested, place the macro in the command history. For
2863 other sorts of commands, call-interactively takes care of
2867 = Fcons (Fcons (Qexecute_kbd_macro
,
2868 Fcons (final
, Fcons (prefixarg
, Qnil
))),
2871 return Fexecute_kbd_macro (final
, prefixarg
);
2873 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
2874 || XTYPE (final
) == Lisp_Compiled
)
2876 backtrace
.next
= backtrace_list
;
2877 backtrace_list
= &backtrace
;
2878 backtrace
.function
= &Qcall_interactively
;
2879 backtrace
.args
= &cmd
;
2880 backtrace
.nargs
= 1;
2881 backtrace
.evalargs
= 0;
2883 tem
= Fcall_interactively (cmd
, record
);
2885 backtrace_list
= backtrace
.next
;
2892 DEFUN ("execute-mouse-event", Fexecute_mouse_event
, Sexecute_mouse_event
,
2894 "Execute the definition of the mouse-click event EVENT.\n\
2895 The handler function is found by looking the event's key sequence up\n\
2896 in the buffer's local mouse map and in `global-mouse-map'.\n\
2898 After running the handler, call the value of `mouse-event-function'\n\
2899 with EVENT as arg.")
2904 Lisp_Object mouse_cmd
;
2905 Lisp_Object keyseq
, window
, screen_part
, pos
, time
;
2908 Vmouse_event
= event
;
2911 if (EQ (event
, Qnil
))
2917 CHECK_CONS (event
, 0);
2919 window
= Fcar (Fcdr (event
));
2920 screen_part
= Fcar (Fcdr (Fcdr (event
)));
2921 keyseq
= Fcar (Fcdr (Fcdr (Fcdr (event
))));
2922 time
= Fcar (Fcdr (Fcdr (Fcdr (Fcdr (event
)))));
2923 CHECK_STRING (keyseq
, 0);
2924 CHECK_WINDOW (window
, 0);
2926 /* Look up KEYSEQ in the buffer's local mouse map, then in global one. */
2930 if (!NILP (XWINDOW (window
)->buffer
))
2932 Lisp_Object local_map
;
2934 local_map
= XBUFFER (XWINDOW (window
)->buffer
)->mouse_map
;
2935 tem
= Fkeymapp (local_map
);
2937 mouse_cmd
= Flookup_key (local_map
, keyseq
);
2938 /* A number as value means the key is too long; treat as undefined. */
2939 if (XTYPE (mouse_cmd
) == Lisp_Int
)
2943 tem
= Fkeymapp (Vglobal_mouse_map
);
2944 if (NILP (mouse_cmd
) && !NILP (tem
))
2945 mouse_cmd
= Flookup_key (Vglobal_mouse_map
, keyseq
);
2946 if (XTYPE (mouse_cmd
) == Lisp_Int
)
2949 if (NILP (mouse_cmd
))
2951 /* This button/shift combination is not defined.
2952 If it is a button-down event, ring the bell. */
2954 if (XSTRING (keyseq
)->data
[XSTRING (keyseq
)->size
- 1] & 0x18 == 0)
2956 if (XSTRING (keyseq
)->data
[XSTRING (keyseq
)->size
- 1] & 4 == 0)
2962 SCREEN_PTR s
= XSCREEN (WINDOW_SCREEN (XWINDOW (window
)));
2965 Vmouse_window
= s
->selected_window
;
2966 #endif /* HAVE_X11 */
2967 /* It's defined; call the definition. */
2969 if (!NILP (screen_part
))
2971 /* For a scroll-bar click, set the prefix arg
2972 to the number of lines down from the top the click was.
2973 Many scroll commands want to scroll by this many lines. */
2974 Lisp_Object position
;
2978 position
= Fcar (pos
);
2979 length
= Fcar (Fcdr (pos
));
2980 offset
= Fcar (Fcdr (Fcdr (pos
)));
2982 if (XINT (length
) != 0)
2983 XSET (Vprefix_arg
, Lisp_Int
,
2984 (SCREEN_HEIGHT (s
) * (XINT (position
) + XINT (offset
))
2985 / (XINT (length
) + 2 * XINT (offset
))));
2987 Fcommand_execute (mouse_cmd
, Qnil
);
2990 if (!NILP (Vmouse_event_function
)) /* Not `event' so no need for GCPRO */
2991 call1 (Vmouse_event_function
, Vmouse_event
);
2996 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
2998 "Read function name, then read its arguments and call it.")
3000 Lisp_Object prefixarg
;
3002 Lisp_Object function
;
3004 Lisp_Object saved_keys
;
3005 struct gcpro gcpro1
;
3007 saved_keys
= Fthis_command_keys ();
3009 GCPRO1 (saved_keys
);
3011 if (EQ (prefixarg
, Qminus
))
3013 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
3014 strcpy (buf
, "C-u ");
3015 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
3016 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
3017 else if (XTYPE (prefixarg
) == Lisp_Int
)
3018 sprintf (buf
, "%d ", XINT (prefixarg
));
3020 /* This isn't strictly correct if execute-extended-command
3021 is bound to anything else. Perhaps it should use
3022 this_command_keys? */
3023 strcat (buf
, "M-x ");
3025 /* Prompt with buf, and then read a string, completing from and
3026 restricting to the set of all defined commands. Don't provide
3027 any initial input. The last Qnil says not to perform a
3028 peculiar hack on the initial input. */
3029 function
= Fcompleting_read (build_string (buf
),
3030 Vobarray
, Qcommandp
,
3033 /* Add the text read to this_command_keys. */
3035 struct Lisp_String
*func_str
= XSTRING (function
);
3039 for (i
= 0; i
< func_str
->size
; i
++)
3041 XSET (tem
, Lisp_Int
, func_str
->data
[i
]);
3042 add_command_key (tem
);
3048 function
= Fintern (function
, Vobarray
);
3049 Vprefix_arg
= prefixarg
;
3050 this_command
= function
;
3052 return Fcommand_execute (function
, Qt
);
3056 detect_input_pending ()
3059 get_input_pending (&input_pending
);
3061 return input_pending
;
3064 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
3065 "T if command input is currently available with no waiting.\n\
3066 Actually, the value is nil only if we can be sure that no input is available.")
3069 if (!NILP (unread_command_char
))
3072 return detect_input_pending () ? Qt
: Qnil
;
3075 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
3076 "Return vector of last 100 chars read from terminal.")
3081 if (total_keys
< NUM_RECENT_KEYS
)
3082 return Fvector (total_keys
, recent_keys
);
3085 val
= Fvector (NUM_RECENT_KEYS
, recent_keys
);
3086 bcopy (recent_keys
+ recent_keys_index
,
3087 XVECTOR (val
)->contents
,
3088 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
3090 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
3091 recent_keys_index
* sizeof (Lisp_Object
));
3096 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
3097 "Return string of the keystrokes that invoked this command.")
3100 return make_array (this_command_key_count
, this_command_keys
);
3103 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
3104 "Return the current depth in recursive edits.")
3108 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
3112 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
3113 "FOpen dribble file: ",
3114 "Start writing all keyboard characters to FILE.")
3125 file
= Fexpand_file_name (file
, Qnil
);
3126 dribble
= fopen (XSTRING (file
)->data
, "w");
3131 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
3132 "Discard the contents of the terminal input buffer.\n\
3133 Also cancel any kbd macro being defined.")
3136 defining_kbd_macro
= 0;
3137 update_mode_lines
++;
3140 unread_command_char
= make_number (-1);
3142 unread_command_char
= Qnil
;
3144 discard_tty_input ();
3146 kbd_fetch_ptr
= kbd_store_ptr
;
3152 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
3153 "Stop Emacs and return to superior process. You can resume later.\n\
3154 On systems that don't have job control, run a subshell instead.\n\n\
3155 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
3156 to be read as terminal input by Emacs's superior shell.\n\
3157 Before suspending, if `suspend-hook' is bound and value is non-nil\n\
3158 call the value as a function of no args. Don't suspend if it returns non-nil.\n\
3159 Otherwise, suspend normally and after resumption call\n\
3160 `suspend-resume-hook' if that is bound and non-nil.\n\
3162 Some operating systems cannot stop the Emacs process and resume it later.\n\
3163 On such systems, Emacs will start a subshell and wait for it to exit.")
3165 Lisp_Object stuffstring
;
3167 register Lisp_Object tem
;
3168 int count
= specpdl_ptr
- specpdl
;
3169 int old_height
, old_width
;
3171 struct gcpro gcpro1
;
3172 extern init_sys_modes ();
3174 if (!NILP (stuffstring
))
3175 CHECK_STRING (stuffstring
, 0);
3176 GCPRO1 (stuffstring
);
3178 /* Call value of suspend-hook
3179 if it is bound and value is non-nil. */
3180 if (!NILP (Vrun_hooks
))
3182 tem
= call1 (Vrun_hooks
, intern ("suspend-hook"));
3183 if (!EQ (tem
, Qnil
)) return Qnil
;
3186 get_screen_size (&old_width
, &old_height
);
3188 /* sys_suspend can get an error if it tries to fork a subshell
3189 and the system resources aren't available for that. */
3190 record_unwind_protect (init_sys_modes
, 0);
3191 stuff_buffered_input (stuffstring
);
3193 unbind_to (count
, Qnil
);
3195 /* Check if terminal/window size has changed.
3196 Note that this is not useful when we are running directly
3197 with a window system; but suspend should be disabled in that case. */
3198 get_screen_size (&width
, &height
);
3199 if (width
!= old_width
|| height
!= old_height
)
3200 change_screen_size (height
, width
, 0);
3202 /* Call value of suspend-resume-hook
3203 if it is bound and value is non-nil. */
3204 if (!NILP (Vrun_hooks
))
3205 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
3211 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
3212 Then in any case stuff anthing Emacs has read ahead and not used. */
3214 stuff_buffered_input (stuffstring
)
3215 Lisp_Object stuffstring
;
3217 register unsigned char *p
;
3219 /* stuff_char works only in BSD, versions 4.2 and up. */
3222 if (XTYPE (stuffstring
) == Lisp_String
)
3226 p
= XSTRING (stuffstring
)->data
;
3227 count
= XSTRING (stuffstring
)->size
;
3232 /* Anything we have read ahead, put back for the shell to read. */
3233 while (kbd_fetch_ptr
!= kbd_store_ptr
)
3235 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3236 kbd_fetch_ptr
= kbd_buffer
;
3237 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
3238 stuff_char (XINT (kbd_fetch_ptr
->code
));
3243 #endif /* BSD and not BSD4_1 */
3246 set_waiting_for_input (word_to_clear
)
3247 long *word_to_clear
;
3249 input_available_clear_word
= word_to_clear
;
3251 /* Tell interrupt_signal to throw back to read_char, */
3252 waiting_for_input
= 1;
3254 /* If interrupt_signal was called before and buffered a C-g,
3255 make it run again now, to avoid timing error. */
3256 if (!NILP (Vquit_flag
))
3257 quit_throw_to_read_char ();
3259 /* If alarm has gone off already, echo now. */
3267 clear_waiting_for_input ()
3269 /* Tell interrupt_signal not to throw back to read_char, */
3270 waiting_for_input
= 0;
3271 input_available_clear_word
= 0;
3274 /* This routine is called at interrupt level in response to C-G.
3275 If interrupt_input, this is the handler for SIGINT.
3276 Otherwise, it is called from kbd_buffer_store_event,
3277 in handling SIGIO or SIGTINT.
3279 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
3280 immediately throw back to read_char.
3282 Otherwise it sets the Lisp variable quit-flag not-nil.
3283 This causes eval to throw, when it gets a chance.
3284 If quit-flag is already non-nil, it stops the job right away. */
3290 /* Must preserve main program's value of errno. */
3291 int old_errno
= errno
;
3292 extern Lisp_Object Vwindow_system
;
3295 /* USG systems forget handlers when they are used;
3296 must reestablish each time */
3297 signal (SIGINT
, interrupt_signal
);
3298 signal (SIGQUIT
, interrupt_signal
);
3303 if (!NILP (Vquit_flag
) && SCREEN_IS_TERMCAP (selected_screen
))
3308 #ifdef SIGTSTP /* Support possible in later USG versions */
3310 * On systems which can suspend the current process and return to the original
3311 * shell, this command causes the user to end up back at the shell.
3312 * The "Auto-save" and "Abort" questions are not asked until
3313 * the user elects to return to emacs, at which point he can save the current
3314 * job and either dump core or continue.
3319 if (sys_suspend () == -1)
3321 printf ("Not running as a subprocess;\n");
3322 printf ("you can continue or abort.\n");
3325 /* Perhaps should really fork an inferior shell?
3326 But that would not provide any way to get back
3327 to the original shell, ever. */
3328 printf ("No support for stopping a process on this operating system;\n");
3329 printf ("you can continue or abort.\n");
3330 #endif /* not VMS */
3331 #endif /* not SIGTSTP */
3332 printf ("Auto-save? (y or n) ");
3334 if (((c
= getchar ()) & ~040) == 'Y')
3335 Fdo_auto_save (Qnil
, Qnil
);
3336 while (c
!= '\n') c
= getchar ();
3338 printf ("Abort (and enter debugger)? (y or n) ");
3340 printf ("Abort (and dump core)? (y or n) ");
3341 #endif /* not VMS */
3343 if (((c
= getchar ()) & ~040) == 'Y')
3345 while (c
!= '\n') c
= getchar ();
3346 printf ("Continuing...\n");
3352 /* If executing a function that wants to be interrupted out of
3353 and the user has not deferred quitting by binding `inhibit-quit'
3354 then quit right away. */
3355 if (immediate_quit
&& NILP (Vinhibit_quit
))
3359 Fsignal (Qquit
, Qnil
);
3362 /* Else request quit when it's safe */
3366 if (waiting_for_input
&& !echoing
)
3367 quit_throw_to_read_char ();
3372 /* Handle a C-g by making read_char return C-g. */
3374 quit_throw_to_read_char ()
3376 quit_error_check ();
3378 /* Prevent another signal from doing this before we finish. */
3379 waiting_for_input
= 0;
3383 unread_command_char
= make_number (-1);
3385 unread_command_char
= Qnil
;
3387 _longjmp (getcjmp
, 1);
3390 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
3391 "Set mode of reading keyboard input.\n\
3392 First arg non-nil means use input interrupts; nil means use CBREAK mode.\n\
3393 Second arg non-nil means use ^S/^Q flow control for output to terminal\n\
3394 (no effect except in CBREAK mode).\n\
3395 Third arg non-nil means accept 8-bit input (for a Meta key).\n\
3396 Otherwise, the top bit is ignored, on the assumption it is parity.\n\
3397 Optional fourth arg non-nil specifies character to use for quitting.")
3398 (interrupt
, flow
, meta
, quit
)
3399 Lisp_Object interrupt
, flow
, meta
, quit
;
3402 && (XTYPE (quit
) != Lisp_Int
3403 || XINT (quit
) < 0 || XINT (quit
) > 0400))
3404 error ("set-input-mode: QUIT must be an ASCII character.");
3408 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3409 #ifdef NO_SOCK_SIGIO
3410 if (read_socket_hook
)
3411 interrupt_input
= 0; /* No interrupts if reading from a socket. */
3413 #endif /* NO_SOCK_SIGIO */
3414 interrupt_input
= !NILP (interrupt
);
3415 #else /* not SIGIO */
3416 interrupt_input
= 0;
3417 #endif /* not SIGIO */
3418 /* Our VMS input only works by interrupts, as of now. */
3420 interrupt_input
= 1;
3422 flow_control
= !NILP (flow
);
3423 meta_key
= !NILP (meta
);
3425 /* Don't let this value be out of range. */
3426 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
3434 this_command_keys_size
= 40;
3436 (Lisp_Object
*) xmalloc (this_command_keys_size
* sizeof (Lisp_Object
));
3438 /* This is correct before outermost invocation of the editor loop */
3439 command_loop_level
= -1;
3441 quit_char
= Ctl ('g');
3442 unread_command_char
= Qnil
;
3443 recent_keys_index
= 0;
3445 kbd_fetch_ptr
= kbd_buffer
;
3446 kbd_store_ptr
= kbd_buffer
;
3447 do_mouse_tracking
= 0;
3450 if (!noninteractive
)
3452 signal (SIGINT
, interrupt_signal
);
3454 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
3455 SIGQUIT and we can't tell which one it will give us. */
3456 signal (SIGQUIT
, interrupt_signal
);
3457 #endif /* HAVE_TERMIO */
3458 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3460 signal (SIGIO
, input_available_signal
);
3464 /* Use interrupt input by default, if it works and noninterrupt input
3465 has deficiencies. */
3467 #ifdef INTERRUPT_INPUT
3468 interrupt_input
= 1;
3470 interrupt_input
= 0;
3473 /* Our VMS input only works by interrupts, as of now. */
3475 interrupt_input
= 1;
3481 if (keyboard_init_hook
)
3482 (*keyboard_init_hook
) ();
3484 #ifdef POLL_FOR_INPUT
3485 poll_suppress_count
= 1;
3490 /* This type's only use is in syms_of_keyboard, to initialize the
3491 event header symbols and put properties on them. */
3498 struct event_head head_table
[] = {
3499 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
3500 &Qvscrollbar_part
, "vscrollbar-part", &Qscrollbar_click
,
3501 &Qvslider_part
, "vslider-part", &Qscrollbar_click
,
3502 &Qvthumbup_part
, "vthumbup-part", &Qscrollbar_click
,
3503 &Qvthumbdown_part
, "vthumbdown-part", &Qscrollbar_click
,
3504 &Qhscrollbar_part
, "hscrollbar-part", &Qscrollbar_click
,
3505 &Qhslider_part
, "hslider-part", &Qscrollbar_click
,
3506 &Qhthumbleft_part
, "hthumbleft-part", &Qscrollbar_click
,
3507 &Qhthumbright_part
,"hthumbright-part", &Qscrollbar_click
3512 Qself_insert_command
= intern ("self-insert-command");
3513 staticpro (&Qself_insert_command
);
3515 Qforward_char
= intern ("forward-char");
3516 staticpro (&Qforward_char
);
3518 Qbackward_char
= intern ("backward-char");
3519 staticpro (&Qbackward_char
);
3521 Qdisabled
= intern ("disabled");
3522 staticpro (&Qdisabled
);
3524 Qfunction_key
= intern ("function-key");
3525 staticpro (&Qfunction_key
);
3526 Qmouse_movement
= intern ("mouse-click");
3527 staticpro (&Qmouse_click
);
3528 Qmouse_movement
= intern ("scrollbar-click");
3529 staticpro (&Qmouse_movement
);
3531 Qmode_line
= intern ("mode-line");
3532 staticpro (&Qmode_line
);
3533 Qvertical_split
= intern ("vertical-split");
3534 staticpro (&Qvertical_split
);
3536 Qevent_kind
= intern ("event-type");
3537 staticpro (&Qevent_kind
);
3538 Qevent_unmodified
= intern ("event-unmodified");
3539 staticpro (&Qevent_unmodified
);
3542 struct event_head
*p
;
3544 for (p
= head_table
;
3545 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
3548 *p
->var
= intern (p
->name
);
3550 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
3551 Fput (*p
->var
, Qevent_unmodified
, *p
->var
);
3555 func_key_syms
= Qnil
;
3556 staticpro (&func_key_syms
);
3559 staticpro (&mouse_syms
);
3561 defsubr (&Sread_key_sequence
);
3562 defsubr (&Srecursive_edit
);
3563 defsubr (&Strack_mouse
);
3564 defsubr (&Smouse_click_p
);
3565 defsubr (&Sinput_pending_p
);
3566 defsubr (&Scommand_execute
);
3567 defsubr (&Srecent_keys
);
3568 defsubr (&Sthis_command_keys
);
3569 defsubr (&Ssuspend_emacs
);
3570 defsubr (&Sabort_recursive_edit
);
3571 defsubr (&Sexit_recursive_edit
);
3572 defsubr (&Srecursion_depth
);
3573 defsubr (&Stop_level
);
3574 defsubr (&Sdiscard_input
);
3575 defsubr (&Sopen_dribble_file
);
3576 defsubr (&Sset_input_mode
);
3577 defsubr (&Sexecute_extended_command
);
3579 DEFVAR_LISP ("disabled-command-hook", &Vdisabled_command_hook
,
3580 "Value is called instead of any command that is disabled\n\
3581 (has a non-nil `disabled' property).");
3583 DEFVAR_LISP ("last-command-char", &last_command_char
,
3584 "Last terminal input key that was part of a command.");
3586 DEFVAR_LISP ("last-input-char", &last_input_char
,
3587 "Last terminal input key.");
3589 DEFVAR_LISP ("unread-command-char", &unread_command_char
,
3590 "Object to be read as next input from input stream, or nil if none.");
3592 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
3593 "Meta-prefix character code. Meta-foo as command input\n\
3594 turns into this character followed by foo.");
3595 XSET (meta_prefix_char
, Lisp_Int
, 033);
3597 DEFVAR_LISP ("last-command", &last_command
,
3598 "The last command executed. Normally a symbol with a function definition,\n\
3599 but can be whatever was found in the keymap, or whatever the variable\n\
3600 `this-command' was set to by that command.");
3601 last_command
= Qnil
;
3603 DEFVAR_LISP ("this-command", &this_command
,
3604 "The command now being executed.\n\
3605 The command can set this variable; whatever is put here\n\
3606 will be in `last-command' during the following command.");
3607 this_command
= Qnil
;
3609 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
3610 "*Number of keyboard input characters between auto-saves.\n\
3611 Zero means disable autosaving due to number of characters typed.");
3612 auto_save_interval
= 300;
3614 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
3615 "*Number of seconds idle time before auto-save.\n\
3616 Zero or nil means disable auto-saving due to idleness.");
3617 XFASTINT (Vauto_save_timeout
) = 30;
3619 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
3620 "*Nonzero means echo unfinished commands after this many seconds of pause.");
3621 echo_keystrokes
= 1;
3623 DEFVAR_INT ("polling-period", &polling_period
,
3624 "*Interval between polling for input during Lisp execution.\n\
3625 The reason for polling is to make C-g work to stop a running program.\n\
3626 Polling is needed only when using X windows and SIGIO does not work.\n\
3627 Polling is automatically disabled in all other cases.");
3630 DEFVAR_INT ("num-input-keys", &num_input_keys
,
3631 "*Number of complete keys read from the keyboard so far.");
3634 DEFVAR_LISP ("last-event-screen", &Vlast_event_screen
,
3635 "*The screen in which the most recently read event occurred.");
3636 Vlast_event_screen
= Qnil
;
3638 DEFVAR_LISP ("help-char", &help_char
,
3639 "Character to recognize as meaning Help.\n\
3640 When it is read, do `(eval help-form)', and display result if it's a string.\n\
3641 If the value of `help-form' is nil, this char can be read normally.");
3642 XSET (help_char
, Lisp_Int
, Ctl ('H'));
3644 DEFVAR_LISP ("help-form", &Vhelp_form
,
3645 "Form to execute when character help-char is read.\n\
3646 If the form returns a string, that string is displayed.\n\
3647 If `help-form' is nil, the help char is not recognized.");
3650 DEFVAR_LISP ("top-level", &Vtop_level
,
3651 "Form to evaluate when Emacs starts up.\n\
3652 Useful to set before you dump a modified Emacs.");
3655 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
3656 "String used as translate table for keyboard input, or nil.\n\
3657 Each character is looked up in this string and the contents used instead.\n\
3658 If string is of length N, character codes N and up are untranslated.");
3659 Vkeyboard_translate_table
= Qnil
;
3661 #ifdef HAVE_X_WINDOWS
3662 DEFVAR_LISP ("mouse-event-function", &Vmouse_event_function
,
3663 "Function to call for each mouse event, after the event's definition.\n\
3664 Called, if non-nil, with one argument, which is the event-list.\n\
3665 See the variable `mouse-event' for the format of this list.");
3666 Vmouse_event_function
= Qnil
;
3668 DEFVAR_LISP ("mouse-left-hook", &Vmouse_left_hook
,
3669 "Function to call when mouse leaves window. No arguments.");
3670 Vmouse_left_hook
= Qnil
;
3672 DEFVAR_LISP ("map-screen-hook", &Vmap_screen_hook
,
3673 "Function to call when screen is mapped. No arguments.");
3674 Vmap_screen_hook
= Qnil
;
3676 DEFVAR_LISP ("unmap-screen-hook", &Vunmap_screen_hook
,
3677 "Function to call when screen is unmapped. No arguments.");
3678 Vunmap_screen_hook
= Qnil
;
3680 DEFVAR_LISP ("mouse-motion-handler", &Vmouse_motion_handler
,
3681 "Handler for motion events. No arguments.");
3682 Vmouse_motion_handler
= Qnil
;
3685 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
3686 "Non-nil means prompt with menus in echo area when appropriate.\n\
3687 This is done when reading from a keymap that has a prompt string,\n\
3688 for elements that have prompt strings.");
3691 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
3692 "Character to see next line of menu prompt.\n\
3693 Type this character while in a menu prompt to rotate around the lines of it.");
3694 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
3699 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
3700 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
3701 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
3702 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
3703 initial_define_key (meta_map
, 'x', "execute-extended-command");