1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1992 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"
36 #include "dispextern.h"
42 #include <sys/ioctl.h>
45 #include "syssignal.h"
52 extern Lisp_Object Vmouse_grabbed
;
54 /* Make all keyboard buffers much bigger when using X windows. */
55 #define KBD_BUFFER_SIZE 4096
56 #else /* No X-windows, character input */
57 #define KBD_BUFFER_SIZE 256
58 #endif /* No X-windows */
60 /* Following definition copied from eval.c */
64 struct backtrace
*next
;
65 Lisp_Object
*function
;
66 Lisp_Object
*args
; /* Points to vector of args. */
67 int nargs
; /* length of vector. If nargs is UNEVALLED,
68 args points to slot holding list of
73 /* Non-nil disable property on a command means
74 do not execute it; call disabled-command-hook's value instead. */
75 Lisp_Object Qdisabled
, Vdisabled_command_hook
;
77 #define NUM_RECENT_KEYS (100)
78 int recent_keys_index
; /* Index for storing next element into recent_keys */
79 int total_keys
; /* Total number of elements stored into recent_keys */
80 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
82 /* Vector holding the key sequence that invoked the current command.
83 It is reused for each command, and it may be longer than the current
84 sequence; this_command_key_count indicates how many elements
85 actually mean something.
86 It's easier to staticpro a single Lisp_Object than an array. */
87 Lisp_Object this_command_keys
;
88 int this_command_key_count
;
90 extern int minbuf_level
;
92 extern struct backtrace
*backtrace_list
;
94 /* Nonzero means do menu prompting. */
95 static int menu_prompting
;
97 /* Character to see next line of menu prompt. */
98 static Lisp_Object menu_prompt_more_char
;
100 /* For longjmp to where kbd input is being done. */
101 static jmp_buf getcjmp
;
103 /* True while doing kbd input. */
104 int waiting_for_input
;
106 /* True while displaying for echoing. Delays C-g throwing. */
109 /* Nonzero means C-G should cause immediate error-signal. */
112 /* Character to recognize as the help char. */
113 Lisp_Object help_char
;
115 /* Form to execute when help char is typed. */
116 Lisp_Object Vhelp_form
;
118 /* Character that causes a quit. Normally C-g.
120 If we are running on an ordinary terminal, this must be an ordinary
121 ASCII char, since we want to make it our interrupt character.
123 If we are not running on an ordinary terminal, it still needs to be
124 an ordinary ASCII char. This character needs to be recognized in
125 the input interrupt handler. At this point, the keystroke is
126 represented as a struct input_event, while the desired quit
127 character is specified as a lispy event. The mapping from struct
128 input_events to lispy events cannot run in an interrupt handler,
129 and the reverse mapping is difficult for anything but ASCII
132 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
136 extern Lisp_Object current_global_map
;
137 extern int minibuf_level
;
139 /* Current depth in recursive edits. */
140 int command_loop_level
;
142 /* Total number of times command_loop has read a key sequence. */
145 /* Last input character read as a command. */
146 Lisp_Object last_command_char
;
148 /* Last input character read as a command, not counting menus
149 reached by the mouse. */
150 Lisp_Object last_nonmenu_event
;
152 /* Last input character read for any purpose. */
153 Lisp_Object last_input_char
;
155 /* If not Qnil, an object to be read as the next command input. */
156 Lisp_Object unread_command_event
;
158 /* If not Qnil, this is a switch-frame event which we decided to put
159 off until the end of a key sequence. This should be read as the
160 next command input, after any unread_command_event.
162 read_key_sequence uses this to delay switch-frame events until the
163 end of the key sequence; Fread_char uses it to put off switch-frame
164 events until a non-ASCII event is acceptable as input. */
165 Lisp_Object unread_switch_frame
;
167 /* Char to use as prefix when a meta character is typed in.
168 This is bound on entry to minibuffer in case ESC is changed there. */
170 Lisp_Object meta_prefix_char
;
172 /* Last size recorded for a current buffer which is not a minibuffer. */
173 static int last_non_minibuf_size
;
175 /* Number of idle seconds before an auto-save and garbage collection. */
176 static Lisp_Object Vauto_save_timeout
;
178 /* Total number of times read_char has returned. */
181 /* Total number of times read_char has returned, outside of macros. */
182 int num_nonmacro_input_chars
;
184 /* Auto-save automatically when this many characters have been typed
185 since the last time. */
187 static int auto_save_interval
;
189 /* Value of num_nonmacro_input_chars as of last auto save. */
193 /* Last command executed by the editor command loop, not counting
194 commands that set the prefix argument. */
196 Lisp_Object last_command
;
198 /* The command being executed by the command loop.
199 Commands may set this, and the value set will be copied into last_command
200 instead of the actual command. */
201 Lisp_Object this_command
;
204 /* The frame in which the last input event occurred, or Qmacro if the
205 last event came from a macro. */
206 Lisp_Object Vlast_event_frame
;
209 /* The timestamp of the last input event we received from the X server.
210 X Windows wants this for selection ownership. */
211 unsigned long last_event_timestamp
;
213 Lisp_Object Qself_insert_command
;
214 Lisp_Object Qforward_char
;
215 Lisp_Object Qbackward_char
;
217 /* read_key_sequence stores here the command definition of the
218 key sequence that it reads. */
219 Lisp_Object read_key_sequence_cmd
;
221 /* Form to evaluate (if non-nil) when Emacs is started. */
222 Lisp_Object Vtop_level
;
224 /* User-supplied string to translate input characters through. */
225 Lisp_Object Vkeyboard_translate_table
;
227 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
228 extern Lisp_Object Vfunction_key_map
;
230 /* File in which we write all commands we read. */
233 /* Nonzero if input is available. */
236 /* Nonzero if should obey 0200 bit in input chars as "Meta". */
239 extern char *pending_malloc_warning
;
241 /* Circular buffer for pre-read keyboard input. */
242 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
244 /* Pointer to next available character in kbd_buffer.
245 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
246 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
247 next available char is in kbd_buffer[0]. */
248 static struct input_event
*kbd_fetch_ptr
;
250 /* Pointer to next place to store character in kbd_buffer. This
251 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
252 character should go in kbd_buffer[0]. */
256 static struct input_event
*kbd_store_ptr
;
258 /* The above pair of variables forms a "queue empty" flag. When we
259 enqueue a non-hook event, we increment kbd_write_count. When we
260 dequeue a non-hook event, we increment kbd_read_count. We say that
261 there is input available iff the two counters are equal.
263 Why not just have a flag set and cleared by the enqueuing and
264 dequeuing functions? Such a flag could be screwed up by interrupts
265 at inopportune times. */
267 /* If this flag is non-zero, mouse movement events will appear in the
268 input stream. If is zero, mouse movement will be ignored. */
269 int do_mouse_tracking
;
271 /* The window system handling code should set this if the mouse has
272 moved since the last call to the mouse_position_hook. Calling that
273 hook should clear this. Code assumes that if this is set, it can
274 call mouse_position_hook to get the promised position, so don't set
275 it unless you're prepared to substantiate the claim! */
278 /* True iff there is an event in kbd_buffer, or if mouse tracking is
279 enabled and there is a new mouse position in the mouse movement
280 buffer. Note that if this is false, that doesn't mean that there
281 is readable input; all the events in the queue might be button-up
282 events, and do_mouse_tracking might be off. */
283 #define EVENT_QUEUES_EMPTY \
284 ((kbd_fetch_ptr == kbd_store_ptr) && (!do_mouse_tracking || !mouse_moved))
287 /* Symbols to head events. */
288 Lisp_Object Qmouse_movement
;
290 Lisp_Object Qvscrollbar_part
;
291 Lisp_Object Qvslider_part
;
292 Lisp_Object Qvthumbup_part
;
293 Lisp_Object Qvthumbdown_part
;
295 Lisp_Object Qhscrollbar_part
;
296 Lisp_Object Qhslider_part
;
297 Lisp_Object Qhthumbleft_part
;
298 Lisp_Object Qhthumbright_part
;
300 Lisp_Object Qswitch_frame
;
302 /* Symbols to denote kinds of events. */
303 Lisp_Object Qfunction_key
;
304 Lisp_Object Qmouse_click
;
305 /* Lisp_Object Qmouse_movement; - also an event header */
306 Lisp_Object Qscrollbar_click
;
308 /* Properties of event headers. */
309 Lisp_Object Qevent_kind
;
310 Lisp_Object Qevent_symbol_elements
;
312 /* An event header symbol HEAD may have a property named
313 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
314 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
315 mask of modifiers applied to it. If present, this is used to help
316 speed up parse_modifiers. */
317 Lisp_Object Qevent_symbol_element_mask
;
319 /* An unmodified event header BASE may have a property named
320 Qmodifier_cache, which is an alist mapping modifier masks onto
321 modified versions of BASE. If present, this helps speed up
323 Lisp_Object Qmodifier_cache
;
325 /* Symbols to use for non-text mouse positions. */
326 Lisp_Object Qmode_line
;
327 Lisp_Object Qvertical_line
;
329 Lisp_Object
recursive_edit_unwind (), command_loop ();
330 Lisp_Object
Fthis_command_keys ();
332 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
334 EMACS_TIME
*input_available_clear_time
;
336 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
337 Default is 1 if INTERRUPT_INPUT is defined. */
340 /* Nonzero while interrupts are temporarily deferred during redisplay. */
341 int interrupts_deferred
;
343 /* nonzero means use ^S/^Q for flow control. */
346 /* Allow m- file to inhibit use of FIONREAD. */
347 #ifdef BROKEN_FIONREAD
351 /* We are unable to use interrupts if FIONREAD is not available,
352 so flush SIGIO so we won't try. */
359 /* If we support X Windows, and won't get an interrupt when input
360 arrives from the server, poll periodically so we can detect C-g. */
361 #ifdef HAVE_X_WINDOWS
363 #define POLL_FOR_INPUT
367 /* Global variable declarations. */
369 /* Function for init_keyboard to call with no args (if nonzero). */
370 void (*keyboard_init_hook
) ();
372 static int read_avail_input ();
373 static void get_input_pending ();
375 /* > 0 if we are to echo keystrokes. */
376 static int echo_keystrokes
;
378 /* Nonzero means echo each character as typed. */
379 static int immediate_echo
;
381 /* The text we're echoing in the modeline - partial key sequences,
382 usually. '\0'-terminated. This really shouldn't have a fixed size. */
383 static char echobuf
[300];
385 /* Where to append more text to echobuf if we want to. */
386 static char *echoptr
;
388 #define min(a,b) ((a)<(b)?(a):(b))
389 #define max(a,b) ((a)>(b)?(a):(b))
391 /* Install the string STR as the beginning of the string of echoing,
392 so that it serves as a prompt for the next character.
393 Also start echoing. */
398 int len
= strlen (str
);
399 if (len
> sizeof echobuf
- 4)
400 len
= sizeof echobuf
- 4;
401 bcopy (str
, echobuf
, len
);
402 echoptr
= echobuf
+ len
;
408 /* Add C to the echo string, if echoing is going on.
409 C can be a character, which is printed prettily ("M-C-x" and all that
410 jazz), or a symbol, whose name is printed. */
415 extern char *push_key_description ();
424 /* If someone has passed us a composite event, use its head symbol. */
427 if (XTYPE (c
) == Lisp_Int
)
429 if (ptr
- echobuf
> sizeof echobuf
- 6)
432 ptr
= push_key_description (c
, ptr
);
434 else if (XTYPE (c
) == Lisp_Symbol
)
436 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
437 if (((ptr
- echobuf
) + name
->size
+ 4) > sizeof echobuf
)
439 bcopy (name
->data
, ptr
, name
->size
);
443 if (echoptr
== echobuf
&& EQ (c
, help_char
))
445 strcpy (ptr
, " (Type ? for further options)");
456 /* Temporarily add a dash to the end of the echo string if it's not
457 empty, so that it serves as a mini-prompt for the very next character. */
461 if (!immediate_echo
&& echoptr
== echobuf
)
464 /* Put a dash at the end of the buffer temporarily,
465 but make it go away when the next character is added. */
472 /* Display the current echo string, and begin echoing if not already
482 for (i
= 0; i
< this_command_key_count
; i
++)
483 echo_char (XVECTOR (this_command_keys
)->contents
[i
]);
491 if (waiting_for_input
&& !NILP (Vquit_flag
))
492 quit_throw_to_read_char ();
495 /* Turn off echoing, for the start of a new command. */
503 /* Return the length of the current echo string. */
508 return echoptr
- echobuf
;
511 /* Truncate the current echo message to its first LEN chars.
512 This and echo_char get used by read_key_sequence when the user
513 switches frames while entering a key sequence. */
520 echoptr
= echobuf
+ len
;
524 /* Functions for manipulating this_command_keys. */
526 add_command_key (key
)
529 int size
= XVECTOR (this_command_keys
)->size
;
531 if (this_command_key_count
>= size
)
533 Lisp_Object new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
535 bcopy (XVECTOR (this_command_keys
)->contents
,
536 XVECTOR (new_keys
)->contents
,
537 size
* sizeof (Lisp_Object
));
539 this_command_keys
= new_keys
;
542 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
548 int count
= specpdl_ptr
- specpdl
;
551 if (command_loop_level
> 0)
553 specbind (Qstandard_output
, Qt
);
554 specbind (Qstandard_input
, Qt
);
557 val
= command_loop ();
559 Fsignal (Qquit
, Qnil
);
565 /* When an auto-save happens, record the "time", and don't do again soon. */
568 last_auto_save
= num_nonmacro_input_chars
;
571 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
572 "Invoke the editor command loop recursively.\n\
573 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
574 that tells this function to return.\n\
575 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
576 This function is called by the editor initialization to begin editing.")
579 int count
= specpdl_ptr
- specpdl
;
582 command_loop_level
++;
583 update_mode_lines
= 1;
585 record_unwind_protect (recursive_edit_unwind
,
587 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
591 return unbind_to (count
, Qnil
);
595 recursive_edit_unwind (buffer
)
599 Fset_buffer (buffer
);
601 command_loop_level
--;
602 update_mode_lines
= 1;
610 Lisp_Object errmsg
, tail
, errname
, file_error
;
617 Vstandard_output
= Qt
;
618 Vstandard_input
= Qt
;
619 Vexecuting_macro
= Qnil
;
620 echo_area_glyphs
= 0;
622 /* If the window system or terminal frame hasn't been initialized
623 yet, or we're not interactive, it's best to dump this message out
624 to stderr and exit. */
625 if (! FRAME_MESSAGE_BUF (selected_frame
)
627 stream
= Qexternal_debugging_output
;
635 errname
= Fcar (data
);
637 if (EQ (errname
, Qerror
))
640 if (!CONSP (data
)) data
= Qnil
;
641 errmsg
= Fcar (data
);
646 errmsg
= Fget (errname
, Qerror_message
);
647 file_error
= Fmemq (Qfile_error
,
648 Fget (errname
, Qerror_conditions
));
651 /* Print an error message including the data items.
652 This is done by printing it into a scratch buffer
653 and then making a copy of the text in the buffer. */
655 if (!CONSP (data
)) data
= Qnil
;
659 /* For file-error, make error message by concatenating
660 all the data items. They are all strings. */
661 if (!NILP (file_error
) && !NILP (tail
))
662 errmsg
= XCONS (tail
)->car
, tail
= XCONS (tail
)->cdr
;
664 if (XTYPE (errmsg
) == Lisp_String
)
665 Fprinc (errmsg
, stream
);
667 write_string_1 ("peculiar error", -1, stream
);
669 for (i
= 0; CONSP (tail
); tail
= Fcdr (tail
), i
++)
671 write_string_1 (i
? ", " : ": ", 2, stream
);
672 if (!NILP (file_error
))
673 Fprinc (Fcar (tail
), stream
);
675 Fprin1 (Fcar (tail
), stream
);
679 /* If the window system or terminal frame hasn't been initialized
680 yet, or we're in -batch mode, this error should cause Emacs to exit. */
681 if (! FRAME_MESSAGE_BUF (selected_frame
)
685 Fkill_emacs (make_number (-1));
690 Vinhibit_quit
= Qnil
;
691 return make_number (0);
694 Lisp_Object
command_loop_1 ();
695 Lisp_Object
command_loop_2 ();
696 Lisp_Object
top_level_1 ();
698 /* Entry to editor-command-loop.
699 This level has the catches for exiting/returning to editor command loop.
700 It returns nil to exit recursive edit, t to abort it. */
705 if (command_loop_level
> 0 || minibuf_level
> 0)
707 return internal_catch (Qexit
, command_loop_2
, Qnil
);
712 internal_catch (Qtop_level
, top_level_1
, Qnil
);
713 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
715 /* End of file in -batch run causes exit here. */
721 /* Here we catch errors in execution of commands within the
722 editing loop, and reenter the editing loop.
723 When there is an error, cmd_error runs and returns a non-nil
724 value to us. A value of nil means that cmd_loop_1 itself
725 returned due to end of file (or end of kbd macro). */
730 register Lisp_Object val
;
733 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
742 return Feval (Vtop_level
);
748 /* On entry to the outer level, run the startup file */
749 if (!NILP (Vtop_level
))
750 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
751 else if (!NILP (Vpurify_flag
))
752 message ("Bare impure Emacs (standard Lisp code not loaded)");
754 message ("Bare Emacs (standard Lisp code not loaded)");
758 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
759 "Exit all recursive editing levels.")
762 Fthrow (Qtop_level
, Qnil
);
765 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
766 "Exit from the innermost recursive edit or minibuffer.")
769 if (command_loop_level
> 0 || minibuf_level
> 0)
770 Fthrow (Qexit
, Qnil
);
772 error ("No recursive edit is in progress");
775 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
776 "Abort the command that requested this recursive edit or minibuffer input.")
779 if (command_loop_level
> 0 || minibuf_level
> 0)
782 error ("No recursive edit is in progress");
785 /* This is the actual command reading loop,
786 sans error-handling encapsulation. */
788 Lisp_Object
Fcommand_execute ();
789 static int read_key_sequence ();
797 Lisp_Object keybuf
[30];
803 waiting_for_input
= 0;
806 /* Don't clear out last_command at the beginning of a macro. */
807 if (XTYPE (Vexecuting_macro
) != Lisp_String
)
812 this_command_key_count
= 0;
816 /* Install chars successfully executed in kbd macro. */
818 if (defining_kbd_macro
&& NILP (Vprefix_arg
))
819 finalize_kbd_macro_chars ();
821 /* Make sure the current window's buffer is selected. */
822 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
823 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
825 /* Display any malloc warning that just came out. Use while because
826 displaying one warning can cause another. */
828 while (pending_malloc_warning
)
829 display_malloc_warning ();
833 /* If minibuffer on and echo area in use,
834 wait 2 sec and redraw minibufer. */
836 if (minibuf_level
&& echo_area_glyphs
)
838 /* Bind inhibit-quit to t so that C-g gets read in
839 rather than quitting back to the minibuffer. */
840 int count
= specpdl_ptr
- specpdl
;
841 specbind (Qinhibit_quit
, Qt
);
842 Fsit_for (make_number (2), Qnil
, Qnil
);
845 echo_area_glyphs
= 0;
847 if (!NILP (Vquit_flag
))
850 unread_command_event
= make_number (quit_char
);
855 alloca (0); /* Cause a garbage collection now */
856 /* Since we can free the most stuff here. */
857 #endif /* C_ALLOCA */
861 /* Select the frame that the last event came from. Usually,
862 switch-frame events will take care of this, but if some lisp
863 code swallows a switch-frame event, we'll fix things up here.
864 Is this a good idea? */
865 if (XTYPE (Vlast_event_frame
) == Lisp_Frame
866 && XFRAME (Vlast_event_frame
) != selected_frame
)
867 Fselect_frame (Vlast_event_frame
, Qnil
);
871 /* Read next key sequence; i gets its length. */
872 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), 0);
876 /* Now we have read a key sequence of length I,
877 or else I is 0 and we found end of file. */
879 if (i
== 0) /* End of file -- happens only in */
880 return Qnil
; /* a kbd macro, at the end. */
882 last_command_char
= keybuf
[i
- 1];
884 cmd
= read_key_sequence_cmd
;
885 if (!NILP (Vexecuting_macro
))
887 if (!NILP (Vquit_flag
))
889 Vexecuting_macro
= Qt
;
890 QUIT
; /* Make some noise. */
891 /* Will return since macro now empty. */
895 /* Do redisplay processing after this command except in special
896 cases identified below that set no_redisplay to 1. */
899 /* Execute the command. */
903 /* nil means key is undefined. */
905 defining_kbd_macro
= 0;
906 update_mode_lines
= 1;
912 if (NILP (Vprefix_arg
) && ! no_direct
)
914 /* Recognize some common commands in common situations and
916 if (EQ (cmd
, Qforward_char
) && point
< ZV
)
918 struct Lisp_Vector
*dp
919 = window_display_table (XWINDOW (selected_window
));
920 lose
= FETCH_CHAR (point
);
922 if (((dp
== 0 && lose
>= 040 && lose
< 0177)
924 (dp
&& (XTYPE (dp
->contents
[lose
]) != Lisp_String
925 || XSTRING (dp
->contents
[lose
])->size
== sizeof (GLYPH
))))
926 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
928 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
930 && !windows_or_buffers_changed
931 && EQ (current_buffer
->selective_display
, Qnil
)
932 && !detect_input_pending ()
933 && NILP (Vexecuting_macro
))
934 no_redisplay
= direct_output_forward_char (1);
937 else if (EQ (cmd
, Qbackward_char
) && point
> BEGV
)
939 struct Lisp_Vector
*dp
940 = window_display_table (XWINDOW (selected_window
));
942 lose
= FETCH_CHAR (point
);
943 if (((dp
== 0 && lose
>= 040 && lose
< 0177)
945 (dp
&& (XTYPE (dp
->contents
[lose
]) != Lisp_String
946 || XSTRING (dp
->contents
[lose
])->size
== sizeof (GLYPH
))))
947 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
949 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
951 && !windows_or_buffers_changed
952 && EQ (current_buffer
->selective_display
, Qnil
)
953 && !detect_input_pending ()
954 && NILP (Vexecuting_macro
))
955 no_redisplay
= direct_output_forward_char (-1);
958 else if (EQ (cmd
, Qself_insert_command
)
959 /* Try this optimization only on ascii keystrokes. */
960 && XTYPE (last_command_char
) == Lisp_Int
)
962 unsigned char c
= XINT (last_command_char
);
964 if (NILP (Vexecuting_macro
) &&
965 !EQ (minibuf_window
, selected_window
))
967 if (!nonundocount
|| nonundocount
>= 20)
974 lose
= (XFASTINT (XWINDOW (selected_window
)->last_modified
)
976 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
978 || MODIFF
<= current_buffer
->save_modified
979 || windows_or_buffers_changed
980 || !EQ (current_buffer
->selective_display
, Qnil
)
981 || detect_input_pending ()
982 || !NILP (Vexecuting_macro
);
983 if (internal_self_insert (c
, 0))
989 (point
== ZV
|| FETCH_CHAR (point
) == '\n'))
991 struct Lisp_Vector
*dp
992 = window_display_table (XWINDOW (selected_window
));
994 if (dp
== 0 || XTYPE (dp
->contents
[c
]) != Lisp_String
)
995 no_redisplay
= direct_output_for_insert (c
);
996 else if (XSTRING (dp
->contents
[c
])->size
999 direct_output_for_insert (*(GLYPH
*)XSTRING (dp
->contents
[c
])->data
);
1005 /* Here for a command that isn't executed directly */
1008 if (NILP (Vprefix_arg
))
1010 Fcommand_execute (cmd
, Qnil
);
1015 /* If there is a prefix argument,
1016 1) We don't want last_command to be ``universal-argument''
1017 (that would be dumb), so don't set last_command,
1018 2) we want to leave echoing on so that the prefix will be
1019 echoed as part of this key sequence, so don't call
1021 3) we want to leave this_command_key_count non-zero, so that
1022 read_char will realize that it is re-reading a character, and
1023 not echo it a second time. */
1024 if (NILP (Vprefix_arg
))
1026 last_command
= this_command
;
1028 this_command_key_count
= 0;
1033 /* Number of seconds between polling for input. */
1036 /* Nonzero means polling for input is temporarily suppresed. */
1037 int poll_suppress_count
;
1039 #ifdef POLL_FOR_INPUT
1040 int polling_for_input
;
1042 /* Handle an alarm once each second and read pending input
1043 so as to handle a C-g if it comces in. */
1046 input_poll_signal ()
1048 #ifdef HAVE_X_WINDOWS
1049 extern int x_input_blocked
;
1050 if (x_input_blocked
== 0)
1052 if (!waiting_for_input
)
1053 read_avail_input (0);
1054 signal (SIGALRM
, input_poll_signal
);
1055 alarm (polling_period
);
1060 /* Begin signals to poll for input, if they are appropriate.
1061 This function is called unconditionally from various places. */
1065 #ifdef POLL_FOR_INPUT
1066 if (read_socket_hook
)
1068 poll_suppress_count
--;
1069 if (poll_suppress_count
== 0)
1071 signal (SIGALRM
, input_poll_signal
);
1072 polling_for_input
= 1;
1073 alarm (polling_period
);
1079 /* Turn off polling. */
1083 #ifdef POLL_FOR_INPUT
1084 if (read_socket_hook
)
1086 if (poll_suppress_count
== 0)
1088 polling_for_input
= 0;
1091 poll_suppress_count
++;
1096 /* Input of single characters from keyboard */
1098 Lisp_Object
print_help ();
1099 static Lisp_Object
kbd_buffer_get_event ();
1101 /* read a character from the keyboard; call the redisplay if needed */
1102 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1103 -1 means do not do redisplay, but do do autosaving.
1106 /* The arguments MAPS and NMAPS are for menu prompting.
1107 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1109 PREV_EVENT is the previous input event, or nil if we are reading
1110 the first event of a key sequence.
1112 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1113 if we used a mouse menu to read the input, or zero otherwise. If
1114 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone. */
1117 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1121 Lisp_Object prev_event
;
1122 int *used_mouse_menu
;
1124 register Lisp_Object c
;
1128 if (!NILP (unread_command_event
))
1130 c
= unread_command_event
;
1131 unread_command_event
= Qnil
;
1133 if (this_command_key_count
== 0)
1139 if (!NILP (Vexecuting_macro
))
1142 /* We set this to Qmacro; since that's not a frame, nobody will
1143 try to switch frames on us, and the selected window will
1146 Since this event came from a macro, it would be misleading to
1147 leave Vlast_event_frame set to whereever the last real event
1148 came from. Normally, command_loop_1 selects
1149 Vlast_event_frame after each command is read, but events read
1150 from a macro should never cause a new frame to be selected. */
1151 Vlast_event_frame
= Qmacro
;
1154 if (executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1156 XSET (c
, Lisp_Int
, -1);
1160 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1161 executing_macro_index
++;
1166 if (!NILP (unread_switch_frame
))
1168 c
= unread_switch_frame
;
1169 unread_switch_frame
= Qnil
;
1171 /* This event should make it into this_command_keys, and get echoed
1172 again, so we go to reread_first, rather than reread. */
1176 /* Save outer setjmp data, in case called recursively. */
1177 save_getcjmp (save_jump
);
1181 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1184 if (_setjmp (getcjmp
))
1186 XSET (c
, Lisp_Int
, quit_char
);
1188 XSET (Vlast_event_frame
, Lisp_Frame
, selected_frame
);
1194 /* Message turns off echoing unless more keystrokes turn it on again. */
1195 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1198 /* If already echoing, continue. */
1201 /* If in middle of key sequence and minibuffer not active,
1202 start echoing if enough time elapses. */
1203 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1204 && echo_keystrokes
> 0
1205 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1209 /* After a mouse event, start echoing right away.
1210 This is because we are probably about to display a menu,
1211 and we don't want to delay before doing so. */
1212 if (XTYPE (prev_event
) == Lisp_Cons
)
1216 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1222 /* Maybe auto save due to number of keystrokes or idle time. */
1224 if (commandflag
!= 0
1225 && auto_save_interval
> 0
1226 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1227 && !detect_input_pending ())
1230 save_getcjmp (temp
);
1231 Fdo_auto_save (Qnil
, Qnil
);
1232 restore_getcjmp (temp
);
1235 /* Try reading a character via menu prompting.
1236 Try this before the sit-for, because the sit-for
1237 would do the wrong thing if we are supposed to do
1240 if (INTERACTIVE
&& !NILP (prev_event
))
1241 c
= read_char_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1243 /* Slow down auto saves logarithmically in size of current buffer,
1244 and garbage collect while we're at it. */
1247 int delay_level
, buffer_size
;
1249 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1250 last_non_minibuf_size
= Z
- BEG
;
1251 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1253 while (buffer_size
> 64)
1254 delay_level
++, buffer_size
-= buffer_size
>> 2;
1255 if (delay_level
< 4) delay_level
= 4;
1256 /* delay_level is 4 for files under around 50k, 7 at 100k,
1257 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1259 /* Auto save if enough time goes by without input. */
1260 if (commandflag
!= 0
1261 && num_nonmacro_input_chars
> last_auto_save
1262 && XTYPE (Vauto_save_timeout
) == Lisp_Int
1263 && XINT (Vauto_save_timeout
) > 0)
1266 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1267 tem0
= sit_for (delay
, 0, 1, 1);
1271 save_getcjmp (temp
);
1272 Fdo_auto_save (Qnil
, Qnil
);
1273 restore_getcjmp (temp
);
1275 /* If we have auto-saved and there is still no input
1276 available, garbage collect if there has been enough
1277 consing going on to make it worthwhile. */
1278 if (!detect_input_pending ()
1279 && consing_since_gc
> gc_cons_threshold
/ 2)
1280 Fgarbage_collect ();
1285 /* Actually read a character, waiting if necessary. */
1287 c
= kbd_buffer_get_event ();
1290 abort (); /* Don't think this can happen. */
1292 /* Terminate Emacs in batch mode if at eof. */
1293 if (noninteractive
&& XTYPE (c
) == Lisp_Int
&& XINT (c
) < 0)
1294 Fkill_emacs (make_number (1));
1298 restore_getcjmp (save_jump
);
1302 echo_area_glyphs
= 0;
1304 /* Handle things that only apply to characters. */
1305 if (XTYPE (c
) == Lisp_Int
)
1307 /* If kbd_buffer_get_event gave us an EOF, return that. */
1311 /* Strip the high bits, and maybe the meta bit too. */
1312 XSETINT (c
, XINT (c
) & (meta_key
? 0377 : 0177));
1314 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
1315 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1316 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1320 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1321 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1322 recent_keys_index
= 0;
1324 /* Write c to the dribble file. If c is a lispy event, write
1325 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1326 If you, dear reader, have a better idea, you've got the source. :-) */
1329 if (XTYPE (c
) == Lisp_Int
)
1330 putc (XINT (c
), dribble
);
1333 Lisp_Object dribblee
= c
;
1335 /* If it's a structured event, take the event header. */
1336 dribblee
= EVENT_HEAD (dribblee
);
1338 if (XTYPE (dribblee
) == Lisp_Symbol
)
1340 putc ('<', dribble
);
1341 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1342 XSYMBOL (dribblee
)->name
->size
,
1344 putc ('>', dribble
);
1351 store_kbd_macro_char (c
);
1353 num_nonmacro_input_chars
++;
1359 /* Record this character as part of the current key. */
1360 add_command_key (c
);
1362 /* Re-reading in the middle of a command */
1364 last_input_char
= c
;
1367 /* Process the help character specially if enabled */
1368 if (EQ (c
, help_char
) && !NILP (Vhelp_form
))
1371 count
= specpdl_ptr
- specpdl
;
1373 record_unwind_protect (Fset_window_configuration
,
1374 Fcurrent_window_configuration (Qnil
));
1376 tem0
= Feval (Vhelp_form
);
1377 if (XTYPE (tem0
) == Lisp_String
)
1378 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1381 c
= read_char (0, 0, 0, Qnil
, 0);
1382 /* Remove the help from the frame */
1383 unbind_to (count
, Qnil
);
1385 if (EQ (c
, make_number (040)))
1388 c
= read_char (0, 0, 0, Qnil
, 0);
1399 Fprinc (object
, Qnil
);
1403 /* Copy out or in the info on where C-g should throw to.
1404 This is used when running Lisp code from within get_char,
1405 in case get_char is called recursively.
1406 See read_process_output. */
1411 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1414 restore_getcjmp (temp
)
1417 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1421 /* Low level keyboard/mouse input.
1422 kbd_buffer_store_event places events in kbd_buffer, and
1423 kbd_buffer_get_event retrieves them.
1424 mouse_moved indicates when the mouse has moved again, and
1425 *mouse_position_hook provides the mouse position. */
1427 /* Set this for debugging, to have a way to get out */
1430 extern int frame_garbaged
;
1432 /* Return true iff there are any events in the queue that read-char
1433 would return. If this returns false, a read-char would block. */
1437 return ! EVENT_QUEUES_EMPTY
;
1441 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1442 of this function. */
1444 tracking_off (old_value
)
1445 Lisp_Object old_value
;
1447 if (! XFASTINT (old_value
))
1449 do_mouse_tracking
= 0;
1451 /* Redisplay may have been preempted because there was input
1452 available, and it assumes it will be called again after the
1453 input has been processed. If the only input available was
1454 the sort that we have just disabled, then we need to call
1456 if (!readable_events ())
1458 redisplay_preserve_echo_area ();
1459 get_input_pending (&input_pending
);
1464 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1465 "Evaluate BODY with mouse movement and button release events enabled.\n\
1466 Within a `track-mouse', mouse motion and button releases generate input\n\
1467 events that you can read with `read-event'.\n\
1468 Normally, these occurrences don't generate events.")
1472 int count
= specpdl_ptr
- specpdl
;
1475 XSET (val
, Lisp_Int
, do_mouse_tracking
);
1476 record_unwind_protect (tracking_off
, val
);
1478 do_mouse_tracking
= 1;
1480 val
= Fprogn (args
);
1481 return unbind_to (count
, val
);
1484 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
1487 kbd_buffer_store_event (event
)
1488 register struct input_event
*event
;
1490 if (event
->kind
== no_event
)
1493 if (event
->kind
== ascii_keystroke
)
1495 register int c
= XFASTINT (event
->code
) & 0377;
1498 || ((c
== (0200 | quit_char
)) && !meta_key
))
1500 extern SIGTYPE
interrupt_signal ();
1503 /* If this results in a quit_char being returned to Emacs as
1504 input, set last-event-frame properly. If this doesn't
1505 get returned to Emacs as an event, the next event read
1506 will set Vlast_event_frame again, so this is safe to do. */
1507 Vlast_event_frame
= FRAME_FOCUS_FRAME (event
->frame
);
1510 last_event_timestamp
= event
->timestamp
;
1511 interrupt_signal ();
1515 if (c
&& c
== stop_character
)
1521 XSET (event
->code
, Lisp_Int
, c
);
1524 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
1525 kbd_store_ptr
= kbd_buffer
;
1527 /* Don't let the very last slot in the buffer become full,
1528 since that would make the two pointers equal,
1529 and that is indistinguishable from an empty buffer.
1530 Discard the event if it would fill the last slot. */
1531 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
1533 kbd_store_ptr
->kind
= event
->kind
;
1534 kbd_store_ptr
->code
= event
->code
;
1535 kbd_store_ptr
->part
= event
->part
;
1536 kbd_store_ptr
->frame
= event
->frame
;
1537 kbd_store_ptr
->modifiers
= event
->modifiers
;
1538 kbd_store_ptr
->x
= event
->x
;
1539 kbd_store_ptr
->y
= event
->y
;
1540 kbd_store_ptr
->timestamp
= event
->timestamp
;
1546 static Lisp_Object
make_lispy_event ();
1547 static Lisp_Object
make_lispy_movement ();
1548 static Lisp_Object
modify_event_symbol ();
1549 static Lisp_Object
make_lispy_switch_frame ();
1552 kbd_buffer_get_event ()
1560 XSET (obj
, Lisp_Int
, c
);
1564 /* Wait until there is input available. */
1567 if (!EVENT_QUEUES_EMPTY
)
1570 /* If the quit flag is set, then read_char will return
1571 quit_char, so that counts as "available input." */
1572 if (!NILP (Vquit_flag
))
1573 quit_throw_to_read_char ();
1575 /* One way or another, wait until input is available; then, if
1576 interrupt handlers have not read it, read it now. */
1579 wait_for_kbd_input ();
1581 /* Note SIGIO has been undef'd if FIONREAD is missing. */
1585 if (EVENT_QUEUES_EMPTY
)
1587 Lisp_Object minus_one
;
1589 XSET (minus_one
, Lisp_Int
, -1);
1590 wait_reading_process_input (0, 0, minus_one
, 1);
1592 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
1594 read_avail_input (0);
1597 #endif /* not VMS */
1600 /* At this point, we know that there is a readable event available
1601 somewhere. If the event queue is empty, then there must be a
1602 mouse movement enabled and available. */
1603 if (kbd_fetch_ptr
!= kbd_store_ptr
)
1605 struct input_event
*event
;
1607 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
1611 last_event_timestamp
= event
->timestamp
;
1617 /* If this event is on a different frame, return a switch-frame this
1618 time, and leave the event in the queue for next time. */
1619 XSET (frame
, Lisp_Frame
, XFRAME (FRAME_FOCUS_FRAME (event
->frame
)));
1620 if (! EQ (frame
, Vlast_event_frame
))
1622 Vlast_event_frame
= frame
;
1623 obj
= make_lispy_switch_frame (frame
);
1628 obj
= make_lispy_event (event
);
1629 if (XTYPE (obj
) == Lisp_Int
)
1630 XSET (obj
, Lisp_Int
, XINT (obj
) & (meta_key
? 0377 : 0177));
1632 /* Wipe out this event, to catch bugs. */
1633 event
->kind
= no_event
;
1635 kbd_fetch_ptr
= event
+ 1;
1639 else if (do_mouse_tracking
&& mouse_moved
)
1645 (*mouse_position_hook
) (&frame
, &x
, &y
, &time
);
1648 /* Decide if we should generate a switch-frame event. Don't generate
1649 switch-frame events for motion outside of all Emacs frames. */
1651 && (XTYPE (Vlast_event_frame
) != Lisp_Frame
1652 || frame
!= XFRAME (Vlast_event_frame
)))
1654 XSET (Vlast_event_frame
, Lisp_Frame
, frame
);
1655 obj
= make_lispy_switch_frame (Vlast_event_frame
);
1659 obj
= make_lispy_movement (frame
, x
, y
, time
);
1662 /* We were promised by the above while loop that there was
1663 something for us to read! */
1666 input_pending
= readable_events ();
1671 /* Caches for modify_event_symbol. */
1672 static Lisp_Object func_key_syms
;
1673 static Lisp_Object mouse_syms
;
1675 /* You'll notice that this table is arranged to be conveniently
1676 indexed by X Windows keysym values. */
1677 static char *lispy_function_keys
[] =
1679 /* X Keysym value */
1681 "home", /* 0xff50 */ /* IsCursorKey */
1692 "select", /* 0xff60 */ /* IsMiscFunctionKey */
1703 "break", /* 0xff6b */
1705 /* Here are some keys found mostly on HP keyboards. The X event
1706 handling code will strip bit 29, which flags vendor-specific
1708 "reset", /* 0x1000ff6c */
1717 "kp_backtab", /* 0x1000ff75 */
1719 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff7f */
1720 "kp-space", /* 0xff80 */ /* IsKeypadKey */
1721 0, 0, 0, 0, 0, 0, 0, 0,
1722 "kp-tab", /* 0xff89 */
1724 "kp-enter", /* 0xff8d */
1726 "kp-f1", /* 0xff91 */
1731 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
1732 "kp-multiply", /* 0xffaa */
1737 "kp-divide", /* 0xffaf */
1738 "kp-0", /* 0xffb0 */
1739 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
1742 "kp-equal", /* 0xffbd */
1743 "f1", /* 0xffbe */ /* IsFunctionKey */
1745 "f5", "f6", "f7", "f8", "f9", "f10", "f11", "f12",
1746 "f13", "f14", "f15", "f16", "f17", "f18", "f19", "f20",
1747 "f21", "f22", "f23", "f24", "f25", "f26", "f27", "f28",
1748 "f29", "f30", "f31", "f32", "f33", "f34", "f35" /* 0xffe0 */
1751 static char *lispy_mouse_names
[] =
1753 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
1756 /* make_lispy_event stores the down-going location of the currently
1757 depressed buttons in button_down_locations. */
1758 struct mouse_position
{
1760 Lisp_Object buffer_pos
;
1762 Lisp_Object timestamp
;
1764 static struct mouse_position button_down_location
[NUM_MOUSE_BUTTONS
];
1766 /* Given a struct input_event, build the lisp event which represents
1767 it. If EVENT is 0, build a mouse movement event from the mouse
1768 movement buffer, which should have a movement event in it.
1770 Note that events must be passed to this function in the order they
1771 are received; this function stores the location of button presses
1772 in order to build drag events when the button is released. */
1775 make_lispy_event (event
)
1776 struct input_event
*event
;
1778 #ifdef SWITCH_ENUM_BUG
1779 switch ((int) event
->kind
)
1781 switch (event
->kind
)
1784 /* A simple keystroke. */
1785 case ascii_keystroke
:
1786 return XFASTINT (event
->code
);
1789 /* A function key. The symbol may need to have modifier prefixes
1791 case non_ascii_keystroke
:
1792 return modify_event_symbol (XFASTINT (event
->code
), event
->modifiers
,
1794 lispy_function_keys
, &func_key_syms
,
1795 (sizeof (lispy_function_keys
)
1796 / sizeof (lispy_function_keys
[0])));
1799 /* A mouse click. Figure out where it is, decide whether it's
1800 a press, click or drag, and build the appropriate structure. */
1803 int button
= XFASTINT (event
->code
);
1807 struct mouse_position
*loc
;
1809 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
1812 /* Where did this mouse click occur? */
1813 window
= window_from_coordinates (event
->frame
,
1814 XINT (event
->x
), XINT (event
->y
),
1816 if (XTYPE (window
) != Lisp_Window
)
1820 XSETINT (event
->x
, (XINT (event
->x
)
1821 - XINT (XWINDOW (window
)->left
)));
1822 XSETINT (event
->y
, (XINT (event
->y
)
1823 - XINT (XWINDOW (window
)->top
)));
1827 posn
= Qvertical_line
;
1829 XSET (posn
, Lisp_Int
,
1830 buffer_posn_from_coords (XWINDOW (window
),
1835 /* If this is a button press, squirrel away the location, so we
1836 can decide later whether it was a click or a drag. */
1837 loc
= button_down_location
+ button
;
1838 if (event
->modifiers
& down_modifier
)
1840 loc
->window
= window
;
1841 loc
->buffer_pos
= posn
;
1844 loc
->timestamp
= event
->timestamp
;
1847 /* Now we're releasing a button - check the co-ordinates to
1848 see if this was a click or a drag. */
1849 else if (event
->modifiers
& up_modifier
)
1851 event
->modifiers
&= ~up_modifier
;
1852 event
->modifiers
|= ((event
->x
== loc
->x
&& event
->y
== loc
->y
)
1857 /* Every mouse event should either have the down_modifier or
1858 the up_modifier set. */
1862 /* Build the event. */
1864 Lisp_Object head
, start
, end
;
1866 /* Build the components of the event. */
1867 head
= modify_event_symbol (button
- 1,
1870 lispy_mouse_names
, &mouse_syms
,
1871 (sizeof (lispy_mouse_names
)
1872 / sizeof (lispy_mouse_names
[0])));
1873 end
= Fcons (window
,
1875 Fcons (Fcons (event
->x
, event
->y
),
1876 Fcons (make_number (event
->timestamp
),
1878 if (event
->modifiers
& drag_modifier
)
1879 start
= Fcons (loc
->window
,
1880 Fcons (loc
->buffer_pos
,
1881 Fcons (Fcons (loc
->x
, loc
->y
),
1882 Fcons (make_number (loc
->timestamp
),
1885 /* Assemble the pieces. */
1886 if (event
->modifiers
& drag_modifier
)
1898 /* A scrollbar click. Build a list containing the relevant
1900 case scrollbar_click
:
1903 = modify_event_symbol (XFASTINT (event
->code
) - 1,
1906 lispy_mouse_names
, &mouse_syms
,
1907 (sizeof (lispy_mouse_names
)
1908 / sizeof (lispy_mouse_names
[0])));
1909 return Fcons (event
->part
,
1910 Fcons (FRAME_SELECTED_WINDOW (event
->frame
),
1912 Fcons (Fcons (event
->x
, event
->y
),
1918 /* The 'kind' field of the event is something we don't recognize. */
1925 make_lispy_movement (frame
, x
, y
, time
)
1938 ? window_from_coordinates (frame
, ix
, iy
, &part
)
1940 if (XTYPE (window
) != Lisp_Window
)
1944 ix
-= XINT (XWINDOW (window
)->left
);
1945 iy
-= XINT (XWINDOW (window
)->top
);
1949 posn
= Qvertical_line
;
1951 XSET (posn
, Lisp_Int
, buffer_posn_from_coords (XWINDOW (window
),
1957 return Fcons (Qmouse_movement
,
1958 Fcons (Fcons (window
,
1960 Fcons (Fcons (x
, y
),
1961 Fcons (make_number (time
),
1967 /* Construct a switch frame event. */
1969 make_lispy_switch_frame (frame
)
1972 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
1976 /* Manipulating modifiers. */
1978 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
1980 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
1981 SYMBOL's name of the end of the modifiers; the string from this
1982 position is the unmodified symbol name.
1984 This doesn't use any caches. */
1986 parse_modifiers_uncached (symbol
, modifier_end
)
1990 struct Lisp_String
*name
;
1994 CHECK_SYMBOL (symbol
, 1);
1997 name
= XSYMBOL (symbol
)->name
;
2000 for (i
= 0; i
+2 <= name
->size
; )
2001 switch (name
->data
[i
])
2003 #define SINGLE_LETTER_MOD(bit) \
2004 if (name->data[i+1] != '-') \
2005 goto no_more_modifiers; \
2010 SINGLE_LETTER_MOD (alt_modifier
);
2014 SINGLE_LETTER_MOD (ctrl_modifier
);
2018 SINGLE_LETTER_MOD (hyper_modifier
);
2022 SINGLE_LETTER_MOD (meta_modifier
);
2026 SINGLE_LETTER_MOD (shift_modifier
);
2030 if (i
+ 6 > name
->size
2031 || strncmp (name
->data
+ i
, "super-", 6))
2032 goto no_more_modifiers
;
2033 modifiers
|= super_modifier
;
2038 if (i
+ 5 > name
->size
)
2039 goto no_more_modifiers
;
2040 if (! strncmp (name
->data
+ i
, "drag-", 5))
2042 modifiers
|= drag_modifier
;
2045 else if (! strncmp (name
->data
+ i
, "down-", 5))
2047 modifiers
|= down_modifier
;
2051 goto no_more_modifiers
;
2055 goto no_more_modifiers
;
2057 #undef SINGLE_LETTER_MOD
2061 /* Should we include the `click' modifier? */
2062 if (! (modifiers
& (down_modifier
| drag_modifier
))
2063 && i
+ 7 == name
->size
2064 && strncmp (name
->data
+ i
, "mouse-", 6)
2065 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
2066 modifiers
|= click_modifier
;
2075 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
2076 prepended to the string BASE[0..BASE_LEN-1].
2077 This doesn't use any caches. */
2079 apply_modifiers_uncached (modifiers
, base
, base_len
)
2084 /* Since BASE could contain nulls, we can't use intern here; we have
2085 to use Fintern, which expects a genuine Lisp_String, and keeps a
2088 (char *) alloca (sizeof ("A-C-H-M-S-super-down-drag-"));
2094 /* Only the event queue may use the `up' modifier; it should always
2095 be turned into a click or drag event before presented to lisp code. */
2096 if (modifiers
& up_modifier
)
2099 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
2100 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
2101 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
2102 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
2103 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
2104 if (modifiers
& super_modifier
) { strcpy (p
, "super-"); p
+= 6; }
2105 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
2106 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
2107 /* The click modifier is denoted by the absence of other modifiers. */
2111 mod_len
= p
- new_mods
;
2115 Lisp_Object new_name
= make_uninit_string (mod_len
+ base_len
);
2117 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
2118 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
2120 return Fintern (new_name
, Qnil
);
2125 static char *modifier_names
[] =
2127 "up", "alt", "control", "hyper", "meta", "shift", "super", "down", "drag",
2131 static Lisp_Object modifier_symbols
;
2133 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
2135 lispy_modifier_list (modifiers
)
2138 Lisp_Object modifier_list
;
2141 modifier_list
= Qnil
;
2142 for (i
= 0; (1<<i
) <= modifiers
; i
++)
2143 if (modifiers
& (1<<i
))
2145 if (i
>= XVECTOR (modifier_symbols
)->size
)
2147 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
2151 return modifier_list
;
2155 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
2156 where UNMODIFIED is the unmodified form of SYMBOL,
2157 MASK is the set of modifiers present in SYMBOL's name.
2158 This is similar to parse_modifiers_uncached, but uses the cache in
2159 SYMBOL's Qevent_symbol_element_mask property, and maintains the
2160 Qevent_symbol_elements property. */
2162 parse_modifiers (symbol
)
2165 Lisp_Object elements
= Fget (symbol
, Qevent_symbol_element_mask
);
2167 if (CONSP (elements
))
2172 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
2173 Lisp_Object unmodified
2174 = Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
2175 XSYMBOL (symbol
)->name
->size
- end
),
2179 XFASTINT (mask
) = modifiers
;
2180 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
2182 /* Cache the parsing results on SYMBOL. */
2183 Fput (symbol
, Qevent_symbol_element_mask
,
2185 Fput (symbol
, Qevent_symbol_elements
,
2186 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
2188 /* Since we know that SYMBOL is modifiers applied to unmodified,
2189 it would be nice to put that in unmodified's cache.
2190 But we can't, since we're not sure that parse_modifiers is
2197 /* Apply the modifiers MODIFIERS to the symbol BASE.
2198 BASE must be unmodified.
2200 This is like apply_modifiers_uncached, but uses BASE's
2201 Qmodifier_cache property, if present. It also builds
2202 Qevent_symbol_elements properties, since it has that info anyway.
2204 apply_modifiers copies the value of BASE's Qevent_kind property to
2205 the modified symbol. */
2207 apply_modifiers (modifiers
, base
)
2211 Lisp_Object cache
, index
, entry
;
2213 /* The click modifier never figures into cache indices. */
2214 cache
= Fget (base
, Qmodifier_cache
);
2215 XFASTINT (index
) = (modifiers
& ~click_modifier
);
2216 entry
= Fassq (index
, cache
);
2219 return XCONS (entry
)->cdr
;
2221 /* We have to create the symbol ourselves. */
2223 Lisp_Object new_symbol
2224 = apply_modifiers_uncached (modifiers
,
2225 XSYMBOL (base
)->name
->data
,
2226 XSYMBOL (base
)->name
->size
);
2228 /* Add the new symbol to the base's cache. */
2229 Fput (base
, Qmodifier_cache
,
2230 Fcons (Fcons (index
, new_symbol
), cache
));
2232 /* We have the parsing info now for free, so add it to the caches. */
2233 XFASTINT (index
) = modifiers
;
2234 Fput (new_symbol
, Qevent_symbol_element_mask
,
2235 Fcons (base
, Fcons (index
, Qnil
)));
2236 Fput (new_symbol
, Qevent_symbol_elements
,
2237 Fcons (base
, lispy_modifier_list (modifiers
)));
2239 /* This symbol is of the same kind as BASE. */
2240 Fput (new_symbol
, Qevent_kind
, Fget (new_symbol
, Qevent_kind
));
2247 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
2248 return a symbol with the modifiers placed in the canonical order.
2249 Canonical order is alphabetical, except for down and drag, which
2250 always come last. The 'click' modifier is never written out.
2252 Fdefine_key calls this to make sure that (for example) C-M-foo
2253 and M-C-foo end up being equivalent in the keymap. */
2256 reorder_modifiers (symbol
)
2259 /* It's hopefully okay to write the code this way, since everything
2260 will soon be in caches, and no consing will be done at all. */
2261 Lisp_Object parsed
= parse_modifiers (symbol
);
2263 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
2264 XCONS (parsed
)->car
);
2268 /* For handling events, we often want to produce a symbol whose name
2269 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
2270 to some base, like the name of a function key or mouse button.
2271 modify_event_symbol produces symbols of this sort.
2273 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
2274 is the name of the i'th symbol. TABLE_SIZE is the number of elements
2277 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
2278 persist between calls to modify_event_symbol that it can use to
2279 store a cache of the symbols it's generated for this NAME_TABLE
2282 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
2284 MODIFIERS is a set of modifier bits (as given in struct input_events)
2285 whose prefixes should be applied to the symbol name.
2287 SYMBOL_KIND is the value to be placed in the event_kind property of
2288 the returned symbol.
2290 The symbols we create are supposed to have an
2291 `event-symbol-elements' propery, which lists the modifiers present
2292 in the symbol's name. */
2295 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_table
,
2296 symbol_table
, table_size
)
2299 Lisp_Object symbol_kind
;
2301 Lisp_Object
*symbol_table
;
2306 /* Is this a request for a valid symbol? */
2307 if (symbol_num
< 0 || symbol_num
>= table_size
)
2310 /* If *symbol_table doesn't seem to be initialized properly, fix that.
2311 *symbol_table should be a lisp vector TABLE_SIZE elements long,
2312 where the Nth element is the symbol for NAME_TABLE[N]. */
2313 if (XTYPE (*symbol_table
) != Lisp_Vector
2314 || XVECTOR (*symbol_table
)->size
!= table_size
)
2318 XFASTINT (size
) = table_size
;
2319 *symbol_table
= Fmake_vector (size
, Qnil
);
2322 slot
= & XVECTOR (*symbol_table
)->contents
[symbol_num
];
2324 /* Have we already used this symbol before? */
2327 /* No; let's create it. */
2328 *slot
= intern (name_table
[symbol_num
]);
2330 /* Fill in the cache entries for this symbol; this also
2331 builds the Qevent_symbol_elements property, which the user
2333 apply_modifiers (modifiers
& click_modifier
, *slot
);
2334 Fput (*slot
, Qevent_kind
, symbol_kind
);
2337 /* Apply modifiers to that symbol. */
2338 return apply_modifiers (modifiers
, *slot
);
2342 DEFUN ("mouse-click-p", Fmouse_click_p
, Smouse_click_p
, 1, 1, 0,
2343 "Return non-nil iff OBJECT is a representation of a mouse event.\n\
2344 A mouse event is a list of five elements whose car is a symbol of the\n\
2345 form <MODIFIERS>mouse-<DIGIT>. I hope this is a temporary hack.")
2349 if (EVENT_HAS_PARAMETERS (object
)
2350 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (object
)),
2357 /* Store into *addr a value nonzero if terminal input chars are available.
2358 Serves the purpose of ioctl (0, FIONREAD, addr)
2359 but works even if FIONREAD does not exist.
2360 (In fact, this may actually read some input.) */
2363 get_input_pending (addr
)
2366 /* First of all, have we already counted some input? */
2367 *addr
= !NILP (Vquit_flag
) || readable_events ();
2369 /* If input is being read as it arrives, and we have none, there is none. */
2370 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
2373 /* Try to read some input and see how much we get. */
2375 *addr
= !NILP (Vquit_flag
) || readable_events ();
2378 /* Interface to read_avail_input, blocking SIGIO if necessary. */
2381 gobble_input (expected
)
2386 if (interrupt_input
)
2389 mask
= sigblockx (SIGIO
);
2390 read_avail_input (expected
);
2395 read_avail_input (expected
);
2401 /* Read any terminal input already buffered up by the system
2402 into the kbd_buffer, but do not wait.
2404 EXPECTED should be nonzero if the caller knows there is some input.
2406 Except on VMS, all input is read by this function.
2407 If interrupt_input is nonzero, this function MUST be called
2408 only when SIGIO is blocked.
2410 Returns the number of keyboard chars read, or -1 meaning
2411 this is a bad time to try to read input. */
2414 read_avail_input (expected
)
2417 struct input_event buf
[KBD_BUFFER_SIZE
];
2421 if (read_socket_hook
)
2422 /* No need for FIONREAD or fcntl; just say don't wait. */
2423 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
2426 unsigned char cbuf
[KBD_BUFFER_SIZE
];
2429 /* Find out how much input is available. */
2430 if (ioctl (0, FIONREAD
, &nread
) < 0)
2431 /* Formerly simply reported no input, but that sometimes led to
2432 a failure of Emacs to terminate.
2433 SIGHUP seems appropriate if we can't reach the terminal. */
2434 kill (getpid (), SIGHUP
);
2437 if (nread
> sizeof cbuf
)
2438 nread
= sizeof cbuf
;
2439 #else /* no FIONREAD */
2441 /* Read some input if available, but don't wait. */
2442 nread
= sizeof cbuf
;
2443 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
2449 /* Now read; for one reason or another, this will not block. */
2452 nread
= read (fileno (stdin
), cbuf
, nread
);
2454 /* The kernel sometimes fails to deliver SIGHUP for ptys.
2455 This looks incorrect, but it isn't, because _BSD causes
2456 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
2457 and that causes a value other than 0 when there is no input. */
2461 /* Retry the read if it is interrupted. */
2463 || ! (errno
== EAGAIN
|| errno
== EFAULT
2473 fcntl (fileno (stdin
), F_SETFL
, 0);
2475 #endif /* no FIONREAD */
2476 for (i
= 0; i
< nread
; i
++)
2478 buf
[i
].kind
= ascii_keystroke
;
2479 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
2480 buf
[i
].frame
= selected_frame
;
2484 /* Scan the chars for C-g and store them in kbd_buffer. */
2485 for (i
= 0; i
< nread
; i
++)
2487 kbd_buffer_store_event (&buf
[i
]);
2488 /* Don't look at input that follows a C-g too closely.
2489 This reduces lossage due to autorepeat on C-g. */
2490 if (buf
[i
].kind
== ascii_keystroke
2491 && XINT(buf
[i
].code
) == quit_char
)
2497 #endif /* not VMS */
2499 #ifdef SIGIO /* for entire page */
2500 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2503 input_available_signal (signo
)
2506 /* Must preserve main program's value of errno. */
2507 int old_errno
= errno
;
2509 extern int select_alarmed
;
2513 /* USG systems forget handlers when they are used;
2514 must reestablish each time */
2515 signal (signo
, input_available_signal
);
2522 if (input_available_clear_time
)
2523 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
2528 nread
= read_avail_input (1);
2529 /* -1 means it's not ok to read the input now.
2530 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
2531 0 means there was no keyboard input available. */
2536 select_alarmed
= 1; /* Force the select emulator back to life */
2547 /* Return the prompt-string of a sparse keymap.
2548 This is the first element which is a string.
2549 Return nil if there is none. */
2557 register Lisp_Object tem
;
2559 if (XTYPE (tem
) == Lisp_String
)
2566 static int echo_flag
;
2567 static int echo_now
;
2569 /* Read a character like read_char but optionally prompt based on maps
2570 in the array MAPS. NMAPS is the length of MAPS.
2572 PREV_EVENT is the previous input event, or nil if we are reading
2573 the first event of a key sequence.
2575 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
2576 if we used a mouse menu to read the input, or zero otherwise. If
2577 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
2579 The prompting is done based on the prompt-string of the map
2580 and the strings associated with various map elements. */
2583 read_char_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
2586 Lisp_Object prev_event
;
2587 int *used_mouse_menu
;
2590 register Lisp_Object name
;
2592 int width
= FRAME_WIDTH (selected_frame
) - 4;
2593 char *menu
= (char *) alloca (width
+ 4);
2595 Lisp_Object rest
, vector
;
2597 if (used_mouse_menu
)
2598 *used_mouse_menu
= 0;
2600 /* Use local over global Menu maps */
2602 if (! menu_prompting
)
2605 /* Get the menu name from the first map that has one (a prompt string). */
2606 for (mapno
= 0; mapno
< nmaps
; mapno
++)
2608 name
= map_prompt (maps
[mapno
]);
2613 /* If we don't have any menus, just read a character normally. */
2617 #ifdef HAVE_X_WINDOW
2619 /* If we got to this point via a mouse click,
2620 use a real menu for mouse selection. */
2621 if (XTYPE (prev_event
) == Lisp_Cons
)
2623 /* Display the menu and get the selection. */
2624 Lisp_Object
*realmaps
2625 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
2629 /* Use the maps that are not nil. */
2630 for (mapno
= 0; mapno
< nmaps
; mapno
++)
2631 if (!NILP (maps
[mapno
]))
2632 realmaps
[nmaps1
++] = maps
[mapno
];
2634 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
2636 XSET (value
, Lisp_Int
, quit_char
);
2637 if (used_mouse_menu
)
2638 *used_mouse_menu
= 1;
2641 #endif /* not NO_X_MENU */
2642 #endif /* HAVE_X_WINDOW */
2644 /* Prompt string always starts with map's prompt, and a space. */
2645 strcpy (menu
, XSTRING (name
)->data
);
2646 nlength
= XSTRING (name
)->size
;
2647 menu
[nlength
++] = ':';
2648 menu
[nlength
++] = ' ';
2651 /* Start prompting at start of first map. */
2655 /* Present the documented bindings, a line at a time. */
2663 /* Loop over elements of map. */
2668 /* If reached end of map, start at beginning of next map. */
2672 /* At end of last map, wrap around to first map if just starting,
2673 or end this line if already have something on it. */
2684 /* Look at the next element of the map. */
2686 elt
= XVECTOR (vector
)->contents
[idx
];
2688 elt
= Fcar_safe (rest
);
2690 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
2692 /* If we found a dense table in the keymap,
2693 advanced past it, but start scanning its contents. */
2694 rest
= Fcdr_safe (rest
);
2700 /* An ordinary element. */
2701 s
= Fcar_safe (Fcdr_safe (elt
));
2702 if (XTYPE (s
) != Lisp_String
)
2703 /* Ignore the element if it has no prompt string. */
2705 /* If we have room for the prompt string, add it to this line.
2706 If this is the first on the line, always add it. */
2707 else if (XSTRING (s
)->size
+ i
< width
2712 /* Punctuate between strings. */
2715 strcpy (menu
+ i
, ", ");
2720 /* Add as much of string as fits. */
2721 thiswidth
= XSTRING (s
)->size
;
2722 if (thiswidth
+ i
> width
)
2723 thiswidth
= width
- i
;
2724 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
2729 /* If this element does not fit, end the line now,
2730 and save the element for the next line. */
2731 strcpy (menu
+ i
, "...");
2735 /* Move past this element. */
2736 if (idx
>= 0 && idx
+ 1 >= XVECTOR (rest
)->size
)
2737 /* Handle reaching end of dense table. */
2742 rest
= Fcdr_safe (rest
);
2746 /* Prompt with that and read response. */
2748 obj
= read_char (1, 0, 0, Qnil
, 0);
2750 if (XTYPE (obj
) != Lisp_Int
)
2755 if (! EQ (obj
, menu_prompt_more_char
)
2756 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
2757 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
2762 /* Reading key sequences. */
2764 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
2765 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
2766 keymap, or nil otherwise. Return the index of the first keymap in
2767 which KEY has any binding, or NMAPS if no map has a binding.
2769 If KEY is a meta ASCII character, treat it like meta-prefix-char
2770 followed by the corresponding non-meta character. Keymaps in
2771 CURRENT with non-prefix bindings for meta-prefix-char become nil in
2774 When KEY is not defined in any of the keymaps, if it is an upper
2775 case letter and there are bindings for the corresponding lower-case
2776 letter, return the bindings for the lower-case letter.
2778 If KEY has no bindings in any of the CURRENT maps, NEXT is left
2781 NEXT may == CURRENT. */
2784 follow_key (key
, nmaps
, current
, defs
, next
)
2786 Lisp_Object
*current
, *defs
, *next
;
2789 int i
, first_binding
;
2791 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
2792 followed by the corresponding non-meta character. */
2793 if (XTYPE (key
) == Lisp_Int
2794 && XINT (key
) >= 0200)
2796 for (i
= 0; i
< nmaps
; i
++)
2797 if (! NILP (current
[i
]))
2800 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1));
2802 /* Note that since we pass the resulting bindings through
2803 get_keymap_1, non-prefix bindings for meta-prefix-char
2805 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
2811 XSET (key
, Lisp_Int
, XFASTINT (key
) & 0177);
2814 first_binding
= nmaps
;
2815 for (i
= nmaps
- 1; i
>= 0; i
--)
2817 if (! NILP (current
[i
]))
2819 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1));
2820 if (! NILP (defs
[i
]))
2827 /* When KEY is not defined in any of the keymaps, if it is an upper
2828 case letter and there are bindings for the corresponding
2829 lower-case letter, return the bindings for the lower-case letter. */
2830 if (first_binding
== nmaps
2831 && XTYPE (key
) == Lisp_Int
2832 && UPPERCASEP (XINT (key
)))
2834 XSETINT (key
, DOWNCASE (XINT (key
)));
2836 first_binding
= nmaps
;
2837 for (i
= nmaps
- 1; i
>= 0; i
--)
2839 if (! NILP (current
[i
]))
2841 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1));
2842 if (! NILP (defs
[i
]))
2850 /* Given the set of bindings we've found, produce the next set of maps. */
2851 if (first_binding
< nmaps
)
2852 for (i
= 0; i
< nmaps
; i
++)
2853 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
2855 return first_binding
;
2858 /* Read a sequence of keys that ends with a non prefix character,
2859 storing it in KEYBUF, a buffer of size BUFSIZE.
2861 Return the length of the key sequence stored.
2863 Echo starting immediately unless `prompt' is 0.
2865 Where a key sequence ends depends on the currently active keymaps.
2866 These include any minor mode keymaps active in the current buffer,
2867 the current buffer's local map, and the global map.
2869 If a key sequence has no other bindings, we check Vfunction_key_map
2870 to see if some trailing subsequence might be the beginning of a
2871 function key's sequence. If so, we try to read the whole function
2872 key, and substitute its symbolic name into the key sequence.
2874 We ignore unbound `down-' mouse clicks. We turn unbound `drag-'
2875 events into similar click events, if that would make them bound.
2877 If we get a mouse click in a mode line, vertical divider, or other
2878 non-text area, we treat the click as if it were prefixed by the
2879 symbol denoting that area - `mode-line', `vertical-line', or
2882 If the sequence starts with a mouse click, we read the key sequence
2883 with respect to the buffer clicked on, not the current buffer.
2885 If the user switches frames in the midst of a key sequence, we put
2886 off the switch-frame event until later; the next call to
2887 read_char will return it. */
2889 read_key_sequence (keybuf
, bufsize
, prompt
)
2890 Lisp_Object
*keybuf
;
2894 int count
= specpdl_ptr
- specpdl
;
2896 /* How many keys there are in the current key sequence. */
2899 /* The length of the echo buffer when we started reading, and
2900 the length of this_command_keys when we started reading. */
2904 /* The number of keymaps we're scanning right now, and the number of
2905 keymaps we have allocated space for. */
2907 int nmaps_allocated
= 0;
2909 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
2910 the current keymaps. */
2913 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
2914 in the current keymaps, or nil where it is not a prefix. */
2915 Lisp_Object
*submaps
;
2917 /* The index in defs[] of the first keymap that has a binding for
2918 this key sequence. In other words, the lowest i such that
2919 defs[i] is non-nil. */
2922 /* If t < mock_input, then KEYBUF[t] should be read as the next
2925 We use this to recover after recognizing a function key. Once we
2926 realize that a suffix of the current key sequence is actually a
2927 function key's escape sequence, we replace the suffix with the
2928 function key's binding from Vfunction_key_map. Now keybuf
2929 contains a new and different key sequence, so the echo area,
2930 this_command_keys, and the submaps and defs arrays are wrong. In
2931 this situation, we set mock_input to t, set t to 0, and jump to
2932 restart_sequence; the loop will read keys from keybuf up until
2933 mock_input, thus rebuilding the state; and then it will resume
2934 reading characters from the keyboard. */
2937 /* If the sequence is unbound in submaps[], then
2938 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
2939 and fkey_map is its binding.
2941 These might be > t, indicating that all function key scanning
2942 should hold off until t reaches them. We do this when we've just
2943 recognized a function key, to avoid searching for the function
2944 key's again in Vfunction_key_map. */
2945 int fkey_start
= 0, fkey_end
= 0;
2946 Lisp_Object fkey_map
= Vfunction_key_map
;
2948 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
2949 we put it off for later. While we're reading, we keep the event here. */
2950 Lisp_Object delayed_switch_frame
= Qnil
;
2953 /* If there is no function key map, turn off function key scanning. */
2954 if (NILP (Fkeymapp (Vfunction_key_map
)))
2955 fkey_start
= fkey_end
= bufsize
+ 1;
2957 /* We need to save the current buffer in case we switch buffers to
2958 find the right binding for a mouse click. Note that we can't use
2959 save_excursion_{save,restore} here, because they save point as
2960 well as the current buffer; we don't want to save point, because
2961 redisplay may change it, to accomodate a Fset_window_start or
2963 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
2965 last_nonmenu_event
= Qnil
;
2970 echo_prompt (prompt
);
2971 else if (cursor_in_echo_area
)
2972 /* This doesn't put in a dash if the echo buffer is empty, so
2973 you don't always see a dash hanging out in the minibuffer. */
2977 /* Record the initial state of the echo area and this_command_keys;
2978 we will need to restore them if we replay a key sequence. */
2980 echo_start
= echo_length ();
2981 keys_start
= this_command_key_count
;
2984 /* Build our list of keymaps.
2985 If we recognize a function key and replace its escape sequence in
2986 keybuf with its symbol, or if the sequence starts with a mouse
2987 click and we need to switch buffers, we jump back here to rebuild
2988 the initial keymaps from the current buffer. */
2992 nmaps
= current_minor_maps (0, &maps
) + 2;
2993 if (nmaps
> nmaps_allocated
)
2995 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
2996 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
2997 nmaps_allocated
= nmaps
;
2999 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
3000 submaps
[nmaps
-2] = current_buffer
->keymap
;
3001 submaps
[nmaps
-1] = global_map
;
3004 /* Find an accurate initial value for first_binding. */
3005 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
3006 if (! NILP (submaps
[first_binding
]))
3009 /* We jump here when a function key substitution has forced us to
3010 reprocess the current key sequence. keybuf[0..mock_input] is the
3011 sequence we want to reread. */
3014 /* These are no-ops the first time through, but if we restart, they
3015 revert the echo area and this_command_keys to their original state. */
3016 this_command_key_count
= keys_start
;
3018 echo_truncate (echo_start
);
3020 /* If the best binding for the current key sequence is a keymap,
3021 or we may be looking at a function key's escape sequence, keep
3023 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
3024 || (first_binding
>= nmaps
&& fkey_start
< t
))
3027 int used_mouse_menu
= 0;
3029 /* These variables are analogous to echo_start and keys_start;
3030 while those allow us to restart the entire key sequence,
3031 echo_local_start and keys_local_start allow us to throw away
3033 int echo_local_start
, keys_local_start
, local_first_binding
;
3036 error ("key sequence too long");
3039 echo_local_start
= echo_length ();
3040 keys_local_start
= this_command_key_count
;
3041 local_first_binding
= first_binding
;
3044 /* These are no-ops, unless we throw away a keystroke below and
3045 jumped back up to replay_key; in that case, these restore the
3046 variables to their original state, allowing us to replay the
3049 echo_truncate (echo_local_start
);
3050 this_command_key_count
= keys_local_start
;
3051 first_binding
= local_first_binding
;
3053 /* Does mock_input indicate that we are re-reading a key sequence? */
3057 add_command_key (key
);
3061 /* If not, we should actually read a character. */
3064 key
= read_char (!prompt
, nmaps
, submaps
, last_nonmenu_event
,
3067 /* read_char returns -1 at the end of a macro.
3068 Emacs 18 handles this by returning immediately with a
3069 zero, so that's what we'll do. */
3070 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) < 0)
3078 /* Clicks in non-text areas get prefixed by the symbol
3079 in their CHAR-ADDRESS field. For example, a click on
3080 the mode line is prefixed by the symbol `mode-line'.
3082 Furthermore, key sequences beginning with mouse clicks
3083 are read using the keymaps of the buffer clicked on, not
3084 the current buffer. So we may have to switch the buffer
3086 if (EVENT_HAS_PARAMETERS (key
))
3088 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
3090 if (EQ (kind
, Qmouse_click
))
3092 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
3093 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
3095 /* Key sequences beginning with mouse clicks are
3096 read using the keymaps in the buffer clicked on,
3097 not the current buffer. If we're at the
3098 beginning of a key sequence, switch buffers. */
3100 && XTYPE (window
) == Lisp_Window
3101 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
3102 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
3104 if (XTYPE (posn
) == Lisp_Symbol
)
3106 if (t
+ 1 >= bufsize
)
3107 error ("key sequence too long");
3118 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
3119 goto replay_sequence
;
3121 else if (XTYPE (posn
) == Lisp_Symbol
)
3123 if (t
+ 1 >= bufsize
)
3124 error ("key sequence too long");
3132 else if (EQ (kind
, Qswitch_frame
))
3134 /* If we're at the beginning of a key sequence, go
3135 ahead and return this event. If we're in the
3136 midst of a key sequence, delay it until the end. */
3139 delayed_switch_frame
= key
;
3146 /* We have finally decided that KEY is something we might want
3148 first_binding
= (follow_key (key
,
3149 nmaps
- first_binding
,
3150 submaps
+ first_binding
,
3151 defs
+ first_binding
,
3152 submaps
+ first_binding
)
3155 /* If KEY wasn't bound, we'll try some fallbacks. */
3156 if (first_binding
>= nmaps
)
3158 Lisp_Object head
= EVENT_HEAD (key
);
3160 if (XTYPE (head
) == Lisp_Symbol
)
3162 Lisp_Object breakdown
= parse_modifiers (head
);
3163 Lisp_Object modifiers
=
3164 XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
3166 /* We drop unbound `down-' events altogether. */
3167 if (modifiers
& down_modifier
)
3169 /* To make sure that mock_input doesn't just give
3170 this event back to us; we want to delete this
3171 event from the mock input queue. We could delete
3172 keybuf[t] and shift everything after that to the
3173 left by one spot, but we'd also have to fix up
3174 any variable that points into keybuf, and shifting
3175 isn't really necessary anyway.
3177 Adding prefixes for non-textual mouse clicks creates
3178 two characters of mock input, and this must be the
3179 second, so mock_input would be over anyway; it's okay
3182 Beyond that, only function key expansion could
3183 create more than two keys, but that should never
3184 generate mouse events, so it's okay to zero
3185 mock_input in that case too.
3187 Isn't this just the most wonderful code ever? */
3192 /* We turn unbound `drag-' events into `click-'
3193 events, if the click would be bound. */
3194 else if (modifiers
& drag_modifier
)
3196 Lisp_Object new_head
=
3197 apply_modifiers (modifiers
& ~drag_modifier
,
3198 XCONS (breakdown
)->car
);
3199 Lisp_Object new_click
=
3200 Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
3202 /* Look for a binding for this new key. follow_key
3203 promises that it didn't munge submaps the
3204 last time we called it, since key was unbound. */
3206 (follow_key (new_click
,
3207 nmaps
- local_first_binding
,
3208 submaps
+ local_first_binding
,
3209 defs
+ local_first_binding
,
3210 submaps
+ local_first_binding
)
3211 + local_first_binding
);
3213 /* If that click is bound, go for it. */
3214 if (first_binding
< nmaps
)
3216 /* Otherwise, we'll leave key set to the drag event. */
3222 /* Normally, last_nonmenu_event gets the previous key we read.
3223 But when a mouse popup menu is being used,
3224 we don't update last_nonmenu_event; it continues to hold the mouse
3225 event that preceded the first level of menu. */
3226 if (!used_mouse_menu
)
3227 last_nonmenu_event
= key
;
3229 /* If the sequence is unbound, see if we can hang a function key
3230 off the end of it. We only want to scan real keyboard input
3231 for function key sequences, so if mock_input says that we're
3232 re-reading old events, don't examine it. */
3233 if (first_binding
>= nmaps
3236 Lisp_Object fkey_next
;
3238 /* Scan from fkey_end until we find a bound suffix. */
3239 while (fkey_end
< t
)
3243 key
= keybuf
[fkey_end
++];
3244 /* Look up meta-characters by prefixing them
3245 with meta_prefix_char. I hate this. */
3246 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & 0x80)
3252 (fkey_map
, meta_prefix_char
, 1)),
3254 XFASTINT (key
) = XFASTINT (key
) & 0x7f;
3257 fkey_next
= fkey_map
;
3260 get_keyelt (access_keymap (fkey_next
, key
, 1));
3262 /* If keybuf[fkey_start..fkey_end] is bound in the
3263 function key map and it's a suffix of the current
3264 sequence (i.e. fkey_end == t), replace it with
3265 the binding and restart with fkey_start at the end. */
3266 if (XTYPE (fkey_next
) == Lisp_Vector
3269 t
= fkey_start
+ XVECTOR (fkey_next
)->size
;
3271 error ("key sequence too long");
3273 bcopy (XVECTOR (fkey_next
)->contents
,
3274 keybuf
+ fkey_start
,
3275 (t
- fkey_start
) * sizeof (keybuf
[0]));
3278 fkey_start
= fkey_end
= t
;
3280 goto replay_sequence
;
3283 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
3285 /* If we no longer have a bound suffix, try a new positions for
3287 if (NILP (fkey_map
))
3289 fkey_end
= ++fkey_start
;
3290 fkey_map
= Vfunction_key_map
;
3296 read_key_sequence_cmd
= (first_binding
< nmaps
3297 ? defs
[first_binding
]
3301 unread_switch_frame
= delayed_switch_frame
;
3302 unbind_to (count
, Qnil
);
3306 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
3307 "Read a sequence of keystrokes and return as a string or vector.\n\
3308 The sequence is sufficient to specify a non-prefix command in the\n\
3309 current local and global maps.\n\
3311 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
3312 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
3313 as a continuation of the previous key.\n\
3315 If Emacs is running on multiple frames, switching between frames in\n\
3316 the midst of a keystroke will toss any prefix typed so far. A C-g\n\
3317 typed while in this function is treated like any other character, and\n\
3318 `quit-flag' is not set.")
3319 (prompt
, continue_echo
)
3320 Lisp_Object prompt
, continue_echo
;
3322 Lisp_Object keybuf
[30];
3324 struct gcpro gcpro1
, gcpro2
;
3327 CHECK_STRING (prompt
, 0);
3330 bzero (keybuf
, sizeof keybuf
);
3332 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
3334 if (NILP (continue_echo
))
3335 this_command_key_count
= 0;
3337 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
3338 NILP (prompt
) ? 0 : XSTRING (prompt
)->data
);
3341 return make_array (i
, keybuf
);
3344 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
3345 "Execute CMD as an editor command.\n\
3346 CMD must be a symbol that satisfies the `commandp' predicate.\n\
3347 Optional second arg RECORD-FLAG non-nil\n\
3348 means unconditionally put this command in `command-history'.\n\
3349 Otherwise, that is done only if an arg is read using the minibuffer.")
3351 Lisp_Object cmd
, record
;
3353 register Lisp_Object final
;
3354 register Lisp_Object tem
;
3355 Lisp_Object prefixarg
;
3356 struct backtrace backtrace
;
3357 extern int debug_on_next_call
;
3359 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
3360 Vcurrent_prefix_arg
= prefixarg
;
3361 debug_on_next_call
= 0;
3363 if (XTYPE (cmd
) == Lisp_Symbol
)
3365 tem
= Fget (cmd
, Qdisabled
);
3367 return call1 (Vrun_hooks
, Vdisabled_command_hook
);
3372 final
= Findirect_function (cmd
);
3374 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
3375 do_autoload (final
, cmd
);
3380 if (XTYPE (final
) == Lisp_String
3381 || XTYPE (final
) == Lisp_Vector
)
3383 /* If requested, place the macro in the command history. For
3384 other sorts of commands, call-interactively takes care of
3388 = Fcons (Fcons (Qexecute_kbd_macro
,
3389 Fcons (final
, Fcons (prefixarg
, Qnil
))),
3392 return Fexecute_kbd_macro (final
, prefixarg
);
3394 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
3395 || XTYPE (final
) == Lisp_Compiled
)
3397 backtrace
.next
= backtrace_list
;
3398 backtrace_list
= &backtrace
;
3399 backtrace
.function
= &Qcall_interactively
;
3400 backtrace
.args
= &cmd
;
3401 backtrace
.nargs
= 1;
3402 backtrace
.evalargs
= 0;
3404 tem
= Fcall_interactively (cmd
, record
);
3406 backtrace_list
= backtrace
.next
;
3412 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
3414 "Read function name, then read its arguments and call it.")
3416 Lisp_Object prefixarg
;
3418 Lisp_Object function
;
3420 Lisp_Object saved_keys
;
3421 struct gcpro gcpro1
;
3423 saved_keys
= Fthis_command_keys ();
3425 GCPRO1 (saved_keys
);
3427 if (EQ (prefixarg
, Qminus
))
3429 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
3430 strcpy (buf
, "C-u ");
3431 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
3432 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
3433 else if (XTYPE (prefixarg
) == Lisp_Int
)
3434 sprintf (buf
, "%d ", XINT (prefixarg
));
3436 /* This isn't strictly correct if execute-extended-command
3437 is bound to anything else. Perhaps it should use
3438 this_command_keys? */
3439 strcat (buf
, "M-x ");
3441 /* Prompt with buf, and then read a string, completing from and
3442 restricting to the set of all defined commands. Don't provide
3443 any initial input. The last Qnil says not to perform a
3444 peculiar hack on the initial input. */
3445 function
= Fcompleting_read (build_string (buf
),
3446 Vobarray
, Qcommandp
,
3449 /* Set this_command_keys to the concatenation of saved_keys and
3450 function, followed by a RET. */
3452 struct Lisp_String
*str
;
3456 this_command_key_count
= 0;
3458 str
= XSTRING (saved_keys
);
3459 for (i
= 0; i
< str
->size
; i
++)
3461 XFASTINT (tem
) = str
->data
[i
];
3462 add_command_key (tem
);
3465 str
= XSTRING (function
);
3466 for (i
= 0; i
< str
->size
; i
++)
3468 XFASTINT (tem
) = str
->data
[i
];
3469 add_command_key (tem
);
3472 XFASTINT (tem
) = '\015';
3473 add_command_key (tem
);
3478 function
= Fintern (function
, Qnil
);
3479 Vprefix_arg
= prefixarg
;
3480 this_command
= function
;
3482 return Fcommand_execute (function
, Qt
);
3486 detect_input_pending ()
3489 get_input_pending (&input_pending
);
3491 return input_pending
;
3494 /* This is called in some cases before a possible quit.
3495 It cases the next call to detect_input_pending to recompute input_pending.
3496 So calling this function unnecessarily can't do any harm. */
3497 clear_input_pending ()
3502 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
3503 "T if command input is currently available with no waiting.\n\
3504 Actually, the value is nil only if we can be sure that no input is available.")
3507 if (!NILP (unread_command_event
))
3510 return detect_input_pending () ? Qt
: Qnil
;
3513 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
3514 "Return vector of last 100 chars read from terminal.")
3517 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
3520 if (total_keys
< NUM_RECENT_KEYS
)
3521 return Fvector (total_keys
, keys
);
3524 val
= Fvector (NUM_RECENT_KEYS
, keys
);
3525 bcopy (keys
+ recent_keys_index
,
3526 XVECTOR (val
)->contents
,
3527 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
3529 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
3530 recent_keys_index
* sizeof (Lisp_Object
));
3535 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
3536 "Return string of the keystrokes that invoked this command.")
3539 return make_array (this_command_key_count
,
3540 XVECTOR (this_command_keys
)->contents
);
3543 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
3544 "Return the current depth in recursive edits.")
3548 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
3552 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
3553 "FOpen dribble file: ",
3554 "Start writing all keyboard characters to FILE.")
3565 file
= Fexpand_file_name (file
, Qnil
);
3566 dribble
= fopen (XSTRING (file
)->data
, "w");
3571 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
3572 "Discard the contents of the terminal input buffer.\n\
3573 Also cancel any kbd macro being defined.")
3576 defining_kbd_macro
= 0;
3577 update_mode_lines
++;
3579 unread_command_event
= Qnil
;
3581 discard_tty_input ();
3583 /* Without the cast, GCC complains that this assignment loses the
3584 volatile qualifier of kbd_store_ptr. Is there anything wrong
3586 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
3592 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
3593 "Stop Emacs and return to superior process. You can resume later.\n\
3594 On systems that don't have job control, run a subshell instead.\n\n\
3595 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
3596 to be read as terminal input by Emacs's superior shell.\n\
3597 Before suspending, if `suspend-hook' is bound and value is non-nil\n\
3598 call the value as a function of no args. Don't suspend if it returns non-nil.\n\
3599 Otherwise, suspend normally and after resumption call\n\
3600 `suspend-resume-hook' if that is bound and non-nil.\n\
3602 Some operating systems cannot stop the Emacs process and resume it later.\n\
3603 On such systems, Emacs will start a subshell and wait for it to exit.")
3605 Lisp_Object stuffstring
;
3607 register Lisp_Object tem
;
3608 int count
= specpdl_ptr
- specpdl
;
3609 int old_height
, old_width
;
3611 struct gcpro gcpro1
;
3612 extern init_sys_modes ();
3614 if (!NILP (stuffstring
))
3615 CHECK_STRING (stuffstring
, 0);
3616 GCPRO1 (stuffstring
);
3618 /* Call value of suspend-hook
3619 if it is bound and value is non-nil. */
3620 if (!NILP (Vrun_hooks
))
3622 tem
= call1 (Vrun_hooks
, intern ("suspend-hook"));
3623 if (!EQ (tem
, Qnil
)) return Qnil
;
3626 get_frame_size (&old_width
, &old_height
);
3628 /* sys_suspend can get an error if it tries to fork a subshell
3629 and the system resources aren't available for that. */
3630 record_unwind_protect (init_sys_modes
, 0);
3631 stuff_buffered_input (stuffstring
);
3633 unbind_to (count
, Qnil
);
3635 /* Check if terminal/window size has changed.
3636 Note that this is not useful when we are running directly
3637 with a window system; but suspend should be disabled in that case. */
3638 get_frame_size (&width
, &height
);
3639 if (width
!= old_width
|| height
!= old_height
)
3640 change_frame_size (0, height
, width
, 0, 0);
3642 /* Call value of suspend-resume-hook
3643 if it is bound and value is non-nil. */
3644 if (!NILP (Vrun_hooks
))
3645 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
3651 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
3652 Then in any case stuff anthing Emacs has read ahead and not used. */
3654 stuff_buffered_input (stuffstring
)
3655 Lisp_Object stuffstring
;
3657 register unsigned char *p
;
3659 /* stuff_char works only in BSD, versions 4.2 and up. */
3662 if (XTYPE (stuffstring
) == Lisp_String
)
3666 p
= XSTRING (stuffstring
)->data
;
3667 count
= XSTRING (stuffstring
)->size
;
3672 /* Anything we have read ahead, put back for the shell to read. */
3673 while (kbd_fetch_ptr
!= kbd_store_ptr
)
3675 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3676 kbd_fetch_ptr
= kbd_buffer
;
3677 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
3678 stuff_char (XINT (kbd_fetch_ptr
->code
));
3683 #endif /* BSD and not BSD4_1 */
3686 set_waiting_for_input (time_to_clear
)
3687 EMACS_TIME
*time_to_clear
;
3689 input_available_clear_time
= time_to_clear
;
3691 /* Tell interrupt_signal to throw back to read_char, */
3692 waiting_for_input
= 1;
3694 /* If interrupt_signal was called before and buffered a C-g,
3695 make it run again now, to avoid timing error. */
3696 if (!NILP (Vquit_flag
))
3697 quit_throw_to_read_char ();
3699 /* If alarm has gone off already, echo now. */
3707 clear_waiting_for_input ()
3709 /* Tell interrupt_signal not to throw back to read_char, */
3710 waiting_for_input
= 0;
3711 input_available_clear_time
= 0;
3714 /* This routine is called at interrupt level in response to C-G.
3715 If interrupt_input, this is the handler for SIGINT.
3716 Otherwise, it is called from kbd_buffer_store_event,
3717 in handling SIGIO or SIGTINT.
3719 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
3720 immediately throw back to read_char.
3722 Otherwise it sets the Lisp variable quit-flag not-nil.
3723 This causes eval to throw, when it gets a chance.
3724 If quit-flag is already non-nil, it stops the job right away. */
3730 /* Must preserve main program's value of errno. */
3731 int old_errno
= errno
;
3732 extern Lisp_Object Vwindow_system
;
3735 /* USG systems forget handlers when they are used;
3736 must reestablish each time */
3737 signal (SIGINT
, interrupt_signal
);
3738 signal (SIGQUIT
, interrupt_signal
);
3743 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
3748 #ifdef SIGTSTP /* Support possible in later USG versions */
3750 * On systems which can suspend the current process and return to the original
3751 * shell, this command causes the user to end up back at the shell.
3752 * The "Auto-save" and "Abort" questions are not asked until
3753 * the user elects to return to emacs, at which point he can save the current
3754 * job and either dump core or continue.
3759 if (sys_suspend () == -1)
3761 printf ("Not running as a subprocess;\n");
3762 printf ("you can continue or abort.\n");
3765 /* Perhaps should really fork an inferior shell?
3766 But that would not provide any way to get back
3767 to the original shell, ever. */
3768 printf ("No support for stopping a process on this operating system;\n");
3769 printf ("you can continue or abort.\n");
3770 #endif /* not VMS */
3771 #endif /* not SIGTSTP */
3772 printf ("Auto-save? (y or n) ");
3774 if (((c
= getchar ()) & ~040) == 'Y')
3775 Fdo_auto_save (Qnil
, Qnil
);
3776 while (c
!= '\n') c
= getchar ();
3778 printf ("Abort (and enter debugger)? (y or n) ");
3780 printf ("Abort (and dump core)? (y or n) ");
3781 #endif /* not VMS */
3783 if (((c
= getchar ()) & ~040) == 'Y')
3785 while (c
!= '\n') c
= getchar ();
3786 printf ("Continuing...\n");
3792 /* If executing a function that wants to be interrupted out of
3793 and the user has not deferred quitting by binding `inhibit-quit'
3794 then quit right away. */
3795 if (immediate_quit
&& NILP (Vinhibit_quit
))
3799 Fsignal (Qquit
, Qnil
);
3802 /* Else request quit when it's safe */
3806 if (waiting_for_input
&& !echoing
)
3807 quit_throw_to_read_char ();
3812 /* Handle a C-g by making read_char return C-g. */
3814 quit_throw_to_read_char ()
3816 quit_error_check ();
3818 /* Prevent another signal from doing this before we finish. */
3819 clear_waiting_for_input ();
3822 unread_command_event
= Qnil
;
3824 _longjmp (getcjmp
, 1);
3827 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
3828 "Set mode of reading keyboard input.\n\
3829 First arg INTERRUPT non-nil means use input interrupts;\n\
3830 nil means use CBREAK mode.\n\
3831 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
3832 (no effect except in CBREAK mode).\n\
3833 Third arg META non-nil means accept 8-bit input (for a Meta key).\n\
3834 Otherwise, the top bit is ignored, on the assumption it is parity.\n\
3835 Optional fourth arg QUIT if non-nil specifies character to use for quitting.")
3836 (interrupt
, flow
, meta
, quit
)
3837 Lisp_Object interrupt
, flow
, meta
, quit
;
3840 && (XTYPE (quit
) != Lisp_Int
3841 || XINT (quit
) < 0 || XINT (quit
) > 0400))
3842 error ("set-input-mode: QUIT must be an ASCII character.");
3846 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3847 #ifdef NO_SOCK_SIGIO
3848 if (read_socket_hook
)
3849 interrupt_input
= 0; /* No interrupts if reading from a socket. */
3851 #endif /* NO_SOCK_SIGIO */
3852 interrupt_input
= !NILP (interrupt
);
3853 #else /* not SIGIO */
3854 interrupt_input
= 0;
3855 #endif /* not SIGIO */
3856 /* Our VMS input only works by interrupts, as of now. */
3858 interrupt_input
= 1;
3860 flow_control
= !NILP (flow
);
3861 meta_key
= !NILP (meta
);
3863 /* Don't let this value be out of range. */
3864 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
3872 /* This is correct before outermost invocation of the editor loop */
3873 command_loop_level
= -1;
3875 quit_char
= Ctl ('g');
3876 unread_command_event
= Qnil
;
3878 recent_keys_index
= 0;
3879 kbd_fetch_ptr
= kbd_buffer
;
3880 kbd_store_ptr
= kbd_buffer
;
3881 do_mouse_tracking
= 0;
3885 /* This means that command_loop_1 won't try to select anything the first
3887 Vlast_event_frame
= Qnil
;
3890 if (!noninteractive
)
3892 signal (SIGINT
, interrupt_signal
);
3894 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
3895 SIGQUIT and we can't tell which one it will give us. */
3896 signal (SIGQUIT
, interrupt_signal
);
3897 #endif /* HAVE_TERMIO */
3898 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3900 signal (SIGIO
, input_available_signal
);
3904 /* Use interrupt input by default, if it works and noninterrupt input
3905 has deficiencies. */
3907 #ifdef INTERRUPT_INPUT
3908 interrupt_input
= 1;
3910 interrupt_input
= 0;
3913 /* Our VMS input only works by interrupts, as of now. */
3915 interrupt_input
= 1;
3921 if (keyboard_init_hook
)
3922 (*keyboard_init_hook
) ();
3924 #ifdef POLL_FOR_INPUT
3925 poll_suppress_count
= 1;
3930 /* This type's only use is in syms_of_keyboard, to initialize the
3931 event header symbols and put properties on them. */
3938 struct event_head head_table
[] = {
3939 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
3940 &Qvscrollbar_part
, "vscrollbar-part", &Qscrollbar_click
,
3941 &Qvslider_part
, "vslider-part", &Qscrollbar_click
,
3942 &Qvthumbup_part
, "vthumbup-part", &Qscrollbar_click
,
3943 &Qvthumbdown_part
, "vthumbdown-part", &Qscrollbar_click
,
3944 &Qhscrollbar_part
, "hscrollbar-part", &Qscrollbar_click
,
3945 &Qhslider_part
, "hslider-part", &Qscrollbar_click
,
3946 &Qhthumbleft_part
, "hthumbleft-part", &Qscrollbar_click
,
3947 &Qhthumbright_part
,"hthumbright-part", &Qscrollbar_click
,
3948 &Qswitch_frame
, "switch-frame", &Qswitch_frame
3953 Qself_insert_command
= intern ("self-insert-command");
3954 staticpro (&Qself_insert_command
);
3956 Qforward_char
= intern ("forward-char");
3957 staticpro (&Qforward_char
);
3959 Qbackward_char
= intern ("backward-char");
3960 staticpro (&Qbackward_char
);
3962 Qdisabled
= intern ("disabled");
3963 staticpro (&Qdisabled
);
3965 Qfunction_key
= intern ("function-key");
3966 staticpro (&Qfunction_key
);
3967 Qmouse_click
= intern ("mouse-click");
3968 staticpro (&Qmouse_click
);
3969 Qmouse_movement
= intern ("scrollbar-click");
3970 staticpro (&Qmouse_movement
);
3972 Qmode_line
= intern ("mode-line");
3973 staticpro (&Qmode_line
);
3974 Qvertical_line
= intern ("vertical-line");
3975 staticpro (&Qvertical_line
);
3977 Qevent_kind
= intern ("event-kind");
3978 staticpro (&Qevent_kind
);
3979 Qevent_symbol_elements
= intern ("event-symbol-elements");
3980 staticpro (&Qevent_symbol_elements
);
3981 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
3982 staticpro (&Qevent_symbol_element_mask
);
3983 Qmodifier_cache
= intern ("modifier-cache");
3984 staticpro (&Qmodifier_cache
);
3987 struct event_head
*p
;
3989 for (p
= head_table
;
3990 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
3993 *p
->var
= intern (p
->name
);
3995 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
3996 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
4003 for (i
= 0; i
< NUM_MOUSE_BUTTONS
; i
++)
4004 staticpro (&button_down_location
[i
].window
);
4009 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
4011 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
4012 for (i
= 0; i
< len
; i
++)
4013 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
4014 staticpro (&modifier_symbols
);
4017 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
4018 staticpro (&recent_keys
);
4020 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
4021 staticpro (&this_command_keys
);
4023 func_key_syms
= Qnil
;
4024 staticpro (&func_key_syms
);
4027 staticpro (&mouse_syms
);
4029 unread_switch_frame
= Qnil
;
4030 staticpro (&unread_switch_frame
);
4032 defsubr (&Sread_key_sequence
);
4033 defsubr (&Srecursive_edit
);
4034 defsubr (&Strack_mouse
);
4035 defsubr (&Smouse_click_p
);
4036 defsubr (&Sinput_pending_p
);
4037 defsubr (&Scommand_execute
);
4038 defsubr (&Srecent_keys
);
4039 defsubr (&Sthis_command_keys
);
4040 defsubr (&Ssuspend_emacs
);
4041 defsubr (&Sabort_recursive_edit
);
4042 defsubr (&Sexit_recursive_edit
);
4043 defsubr (&Srecursion_depth
);
4044 defsubr (&Stop_level
);
4045 defsubr (&Sdiscard_input
);
4046 defsubr (&Sopen_dribble_file
);
4047 defsubr (&Sset_input_mode
);
4048 defsubr (&Sexecute_extended_command
);
4050 DEFVAR_LISP ("disabled-command-hook", &Vdisabled_command_hook
,
4051 "Value is called instead of any command that is disabled\n\
4052 \(has a non-nil `disabled' property).");
4054 DEFVAR_LISP ("last-command-char", &last_command_char
,
4055 "Last terminal input key that was part of a command.");
4057 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
4058 "Last terminal input key in a command, except for mouse menus.\n\
4059 Mouse menus give back keys that don't look like mouse events;\n\
4060 this variable holds the actual mouse event that led to the menu,\n\
4061 so that you can determine whether the command was run by mouse or not.");
4063 DEFVAR_LISP ("last-input-char", &last_input_char
,
4064 "Last terminal input key.");
4066 DEFVAR_LISP ("unread-command-event", &unread_command_event
,
4067 "Object to be read as next input from input stream, or nil if none.");
4069 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
4070 "Meta-prefix character code. Meta-foo as command input\n\
4071 turns into this character followed by foo.");
4072 XSET (meta_prefix_char
, Lisp_Int
, 033);
4074 DEFVAR_LISP ("last-command", &last_command
,
4075 "The last command executed. Normally a symbol with a function definition,\n\
4076 but can be whatever was found in the keymap, or whatever the variable\n\
4077 `this-command' was set to by that command.");
4078 last_command
= Qnil
;
4080 DEFVAR_LISP ("this-command", &this_command
,
4081 "The command now being executed.\n\
4082 The command can set this variable; whatever is put here\n\
4083 will be in `last-command' during the following command.");
4084 this_command
= Qnil
;
4086 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
4087 "*Number of keyboard input characters between auto-saves.\n\
4088 Zero means disable autosaving due to number of characters typed.");
4089 auto_save_interval
= 300;
4091 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
4092 "*Number of seconds idle time before auto-save.\n\
4093 Zero or nil means disable auto-saving due to idleness.\n\
4094 After auto-saving due to this many seconds of idle time,\n\
4095 Emacs also does a garbage collection if that seems to be warranted.");
4096 XFASTINT (Vauto_save_timeout
) = 30;
4098 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
4099 "*Nonzero means echo unfinished commands after this many seconds of pause.");
4100 echo_keystrokes
= 1;
4102 DEFVAR_INT ("polling-period", &polling_period
,
4103 "*Interval between polling for input during Lisp execution.\n\
4104 The reason for polling is to make C-g work to stop a running program.\n\
4105 Polling is needed only when using X windows and SIGIO does not work.\n\
4106 Polling is automatically disabled in all other cases.");
4109 DEFVAR_INT ("num-input-keys", &num_input_keys
,
4110 "*Number of complete keys read from the keyboard so far.");
4114 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
4115 "*The frame in which the most recently read event occurred.\n\
4116 If the last event came from a keyboard macro, this is set to `macro'.");
4117 Vlast_event_frame
= Qnil
;
4120 DEFVAR_LISP ("help-char", &help_char
,
4121 "Character to recognize as meaning Help.\n\
4122 When it is read, do `(eval help-form)', and display result if it's a string.\n\
4123 If the value of `help-form' is nil, this char can be read normally.");
4124 XSET (help_char
, Lisp_Int
, Ctl ('H'));
4126 DEFVAR_LISP ("help-form", &Vhelp_form
,
4127 "Form to execute when character help-char is read.\n\
4128 If the form returns a string, that string is displayed.\n\
4129 If `help-form' is nil, the help char is not recognized.");
4132 DEFVAR_LISP ("top-level", &Vtop_level
,
4133 "Form to evaluate when Emacs starts up.\n\
4134 Useful to set before you dump a modified Emacs.");
4137 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
4138 "String used as translate table for keyboard input, or nil.\n\
4139 Each character is looked up in this string and the contents used instead.\n\
4140 If string is of length N, character codes N and up are untranslated.");
4141 Vkeyboard_translate_table
= Qnil
;
4143 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
4144 "Non-nil means prompt with menus when appropriate.\n\
4145 This is done when reading from a keymap that has a prompt string,\n\
4146 for elements that have prompt strings.\n\
4147 The menu is displayed on the screen\n\
4148 if X menus were enabled at configuration\n\
4149 time and the previous event was a mouse click prefix key.\n\
4150 Otherwise, menu prompting uses the echo area.");
4153 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
4154 "Character to see next line of menu prompt.\n\
4155 Type this character while in a menu prompt to rotate around the lines of it.");
4156 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
4161 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
4162 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
4163 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
4164 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
4165 initial_define_key (meta_map
, 'x', "execute-extended-command");