1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
20 /* Allow config.h to undefine symbols found here. */
29 #include "termhooks.h"
36 #include "dispextern.h"
38 #include "intervals.h"
39 #include "blockinput.h"
44 #include <sys/ioctl.h>
47 #include "syssignal.h"
53 /* Variables for blockinput.h: */
55 /* Non-zero if interrupt input is blocked right now. */
56 int interrupt_input_blocked
;
58 /* Nonzero means an input interrupt has arrived
59 during the current critical section. */
60 int interrupt_input_pending
;
64 extern Lisp_Object Vmouse_grabbed
;
66 /* Make all keyboard buffers much bigger when using X windows. */
67 #define KBD_BUFFER_SIZE 4096
68 #else /* No X-windows, character input */
69 #define KBD_BUFFER_SIZE 256
70 #endif /* No X-windows */
72 /* Following definition copied from eval.c */
76 struct backtrace
*next
;
77 Lisp_Object
*function
;
78 Lisp_Object
*args
; /* Points to vector of args. */
79 int nargs
; /* length of vector. If nargs is UNEVALLED,
80 args points to slot holding list of
85 /* Non-nil disable property on a command means
86 do not execute it; call disabled-command-hook's value instead. */
87 Lisp_Object Qdisabled
, Vdisabled_command_hook
;
89 #define NUM_RECENT_KEYS (100)
90 int recent_keys_index
; /* Index for storing next element into recent_keys */
91 int total_keys
; /* Total number of elements stored into recent_keys */
92 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
94 /* Vector holding the key sequence that invoked the current command.
95 It is reused for each command, and it may be longer than the current
96 sequence; this_command_key_count indicates how many elements
97 actually mean something.
98 It's easier to staticpro a single Lisp_Object than an array. */
99 Lisp_Object this_command_keys
;
100 int this_command_key_count
;
102 extern int minbuf_level
;
104 extern struct backtrace
*backtrace_list
;
106 /* Nonzero means do menu prompting. */
107 static int menu_prompting
;
109 /* Character to see next line of menu prompt. */
110 static Lisp_Object menu_prompt_more_char
;
112 /* For longjmp to where kbd input is being done. */
113 static jmp_buf getcjmp
;
115 /* True while doing kbd input. */
116 int waiting_for_input
;
118 /* True while displaying for echoing. Delays C-g throwing. */
121 /* Nonzero means C-G should cause immediate error-signal. */
124 /* Character to recognize as the help char. */
125 Lisp_Object help_char
;
127 /* Form to execute when help char is typed. */
128 Lisp_Object Vhelp_form
;
130 /* Character that causes a quit. Normally C-g.
132 If we are running on an ordinary terminal, this must be an ordinary
133 ASCII char, since we want to make it our interrupt character.
135 If we are not running on an ordinary terminal, it still needs to be
136 an ordinary ASCII char. This character needs to be recognized in
137 the input interrupt handler. At this point, the keystroke is
138 represented as a struct input_event, while the desired quit
139 character is specified as a lispy event. The mapping from struct
140 input_events to lispy events cannot run in an interrupt handler,
141 and the reverse mapping is difficult for anything but ASCII
144 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
148 extern Lisp_Object current_global_map
;
149 extern int minibuf_level
;
151 /* Current depth in recursive edits. */
152 int command_loop_level
;
154 /* Total number of times command_loop has read a key sequence. */
157 /* Last input character read as a command. */
158 Lisp_Object last_command_char
;
160 /* Last input character read as a command, not counting menus
161 reached by the mouse. */
162 Lisp_Object last_nonmenu_event
;
164 /* Last input character read for any purpose. */
165 Lisp_Object last_input_char
;
167 /* If not Qnil, a list of objects to be read as subsequent command input. */
168 Lisp_Object unread_command_events
;
170 /* If not -1, an event to be read as subsequent command input. */
171 int unread_command_char
;
173 /* If not Qnil, this is a switch-frame event which we decided to put
174 off until the end of a key sequence. This should be read as the
175 next command input, after any unread_command_events.
177 read_key_sequence uses this to delay switch-frame events until the
178 end of the key sequence; Fread_char uses it to put off switch-frame
179 events until a non-ASCII event is acceptable as input. */
180 Lisp_Object unread_switch_frame
;
182 /* A mask of extra modifier bits to put into every keyboard char. */
183 int extra_keyboard_modifiers
;
185 /* Char to use as prefix when a meta character is typed in.
186 This is bound on entry to minibuffer in case ESC is changed there. */
188 Lisp_Object meta_prefix_char
;
190 /* Last size recorded for a current buffer which is not a minibuffer. */
191 static int last_non_minibuf_size
;
193 /* Number of idle seconds before an auto-save and garbage collection. */
194 static Lisp_Object Vauto_save_timeout
;
196 /* Total number of times read_char has returned. */
199 /* Total number of times read_char has returned, outside of macros. */
200 int num_nonmacro_input_chars
;
202 /* Auto-save automatically when this many characters have been typed
203 since the last time. */
205 static int auto_save_interval
;
207 /* Value of num_nonmacro_input_chars as of last auto save. */
211 /* Last command executed by the editor command loop, not counting
212 commands that set the prefix argument. */
214 Lisp_Object last_command
;
216 /* The command being executed by the command loop.
217 Commands may set this, and the value set will be copied into last_command
218 instead of the actual command. */
219 Lisp_Object this_command
;
222 /* The frame in which the last input event occurred, or Qmacro if the
223 last event came from a macro. We use this to determine when to
224 generate switch-frame events. This may be cleared by functions
225 like Fselect_frame, to make sure that a switch-frame event is
226 generated by the next character. */
227 Lisp_Object internal_last_event_frame
;
229 /* A user-visible version of the above, intended to allow users to
230 figure out where the last event came from, if the event doesn't
231 carry that information itself (i.e. if it was a character). */
232 Lisp_Object Vlast_event_frame
;
235 /* The timestamp of the last input event we received from the X server.
236 X Windows wants this for selection ownership. */
237 unsigned long last_event_timestamp
;
239 Lisp_Object Qself_insert_command
;
240 Lisp_Object Qforward_char
;
241 Lisp_Object Qbackward_char
;
243 /* read_key_sequence stores here the command definition of the
244 key sequence that it reads. */
245 Lisp_Object read_key_sequence_cmd
;
247 /* Form to evaluate (if non-nil) when Emacs is started. */
248 Lisp_Object Vtop_level
;
250 /* User-supplied string to translate input characters through. */
251 Lisp_Object Vkeyboard_translate_table
;
253 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
254 extern Lisp_Object Vfunction_key_map
;
256 /* Non-nil means deactivate the mark at end of this command. */
257 Lisp_Object Vdeactivate_mark
;
259 /* Menu bar specified in Lucid Emacs fashion. */
261 Lisp_Object Vlucid_menu_bar_dirty_flag
;
262 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
264 /* Hooks to run before and after each command. */
265 Lisp_Object Qpre_command_hook
, Qpost_command_hook
;
266 Lisp_Object Vpre_command_hook
, Vpost_command_hook
;
268 /* File in which we write all commands we read. */
271 /* Nonzero if input is available. */
274 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
275 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
279 extern char *pending_malloc_warning
;
281 /* Circular buffer for pre-read keyboard input. */
282 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
284 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
286 The interrupt-level event handlers will never enqueue an event on a
287 frame which is not in Vframe_list, and once an event is dequeued,
288 internal_last_event_frame or the event itself points to the frame.
291 But while the event is sitting in the queue, it's completely
292 unprotected. Suppose the user types one command which will run for
293 a while and then delete a frame, and then types another event at
294 the frame that will be deleted, before the command gets around to
295 it. Suppose there are no references to this frame elsewhere in
296 Emacs, and a GC occurs before the second event is dequeued. Now we
297 have an event referring to a freed frame, which will crash Emacs
300 Similar things happen when an event on a scroll bar is enqueued; the
301 window may be deleted while the event is in the queue.
303 So, we use this vector to protect the frame_or_window field in the
304 event queue. That way, they'll be dequeued as dead frames or
305 windows, but still valid lisp objects.
307 If kbd_buffer[i].kind != no_event, then
308 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
309 == kbd_buffer[i].frame_or_window. */
310 static Lisp_Object kbd_buffer_frame_or_window
;
312 /* Pointer to next available character in kbd_buffer.
313 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
314 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
315 next available char is in kbd_buffer[0]. */
316 static struct input_event
*kbd_fetch_ptr
;
318 /* Pointer to next place to store character in kbd_buffer. This
319 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
320 character should go in kbd_buffer[0]. */
324 static struct input_event
*kbd_store_ptr
;
326 /* The above pair of variables forms a "queue empty" flag. When we
327 enqueue a non-hook event, we increment kbd_write_count. When we
328 dequeue a non-hook event, we increment kbd_read_count. We say that
329 there is input available iff the two counters are not equal.
331 Why not just have a flag set and cleared by the enqueuing and
332 dequeuing functions? Such a flag could be screwed up by interrupts
333 at inopportune times. */
335 /* If this flag is non-zero, we check mouse_moved to see when the
336 mouse moves, and motion events will appear in the input stream. If
337 it is zero, mouse motion is ignored. */
338 static int do_mouse_tracking
;
340 /* The window system handling code should set this if the mouse has
341 moved since the last call to the mouse_position_hook. Calling that
342 hook should clear this. Code assumes that if this is set, it can
343 call mouse_position_hook to get the promised position, so don't set
344 it unless you're prepared to substantiate the claim! */
347 /* True iff there is an event in kbd_buffer, or if mouse tracking is
348 enabled and there is a new mouse position in the mouse movement
349 buffer. Note that if this is false, that doesn't mean that there
350 is readable input; all the events in the queue might be button-up
351 events, and do_mouse_tracking might be off. */
352 #define EVENT_QUEUES_EMPTY \
353 ((kbd_fetch_ptr == kbd_store_ptr) && (!do_mouse_tracking || !mouse_moved))
356 /* Symbols to head events. */
357 Lisp_Object Qmouse_movement
;
358 Lisp_Object Qscroll_bar_movement
;
359 Lisp_Object Qswitch_frame
;
361 /* Symbols to denote kinds of events. */
362 Lisp_Object Qfunction_key
;
363 Lisp_Object Qmouse_click
;
364 /* Lisp_Object Qmouse_movement; - also an event header */
366 /* Properties of event headers. */
367 Lisp_Object Qevent_kind
;
368 Lisp_Object Qevent_symbol_elements
;
370 Lisp_Object Qmenu_enable
;
372 /* An event header symbol HEAD may have a property named
373 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
374 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
375 mask of modifiers applied to it. If present, this is used to help
376 speed up parse_modifiers. */
377 Lisp_Object Qevent_symbol_element_mask
;
379 /* An unmodified event header BASE may have a property named
380 Qmodifier_cache, which is an alist mapping modifier masks onto
381 modified versions of BASE. If present, this helps speed up
383 Lisp_Object Qmodifier_cache
;
385 /* Symbols to use for parts of windows. */
386 Lisp_Object Qmode_line
;
387 Lisp_Object Qvertical_line
;
388 Lisp_Object Qvertical_scroll_bar
;
389 Lisp_Object Qmenu_bar
;
391 extern Lisp_Object Qmenu_enable
;
393 Lisp_Object
recursive_edit_unwind (), command_loop ();
394 Lisp_Object
Fthis_command_keys ();
396 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
398 EMACS_TIME
*input_available_clear_time
;
400 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
401 Default is 1 if INTERRUPT_INPUT is defined. */
404 /* Nonzero while interrupts are temporarily deferred during redisplay. */
405 int interrupts_deferred
;
407 /* nonzero means use ^S/^Q for flow control. */
410 /* Allow m- file to inhibit use of FIONREAD. */
411 #ifdef BROKEN_FIONREAD
415 /* We are unable to use interrupts if FIONREAD is not available,
416 so flush SIGIO so we won't try. */
423 /* If we support X Windows, and won't get an interrupt when input
424 arrives from the server, poll periodically so we can detect C-g. */
425 #ifdef HAVE_X_WINDOWS
427 #define POLL_FOR_INPUT
431 /* Global variable declarations. */
433 /* Function for init_keyboard to call with no args (if nonzero). */
434 void (*keyboard_init_hook
) ();
436 static int read_avail_input ();
437 static void get_input_pending ();
439 /* > 0 if we are to echo keystrokes. */
440 static int echo_keystrokes
;
442 /* Nonzero means echo each character as typed. */
443 static int immediate_echo
;
445 /* The text we're echoing in the modeline - partial key sequences,
446 usually. '\0'-terminated. This really shouldn't have a fixed size. */
447 static char echobuf
[300];
449 /* Where to append more text to echobuf if we want to. */
450 static char *echoptr
;
452 #define min(a,b) ((a)<(b)?(a):(b))
453 #define max(a,b) ((a)>(b)?(a):(b))
455 /* Install the string STR as the beginning of the string of echoing,
456 so that it serves as a prompt for the next character.
457 Also start echoing. */
462 int len
= strlen (str
);
463 if (len
> sizeof echobuf
- 4)
464 len
= sizeof echobuf
- 4;
465 bcopy (str
, echobuf
, len
);
466 echoptr
= echobuf
+ len
;
472 /* Add C to the echo string, if echoing is going on.
473 C can be a character, which is printed prettily ("M-C-x" and all that
474 jazz), or a symbol, whose name is printed. */
479 extern char *push_key_description ();
488 /* If someone has passed us a composite event, use its head symbol. */
491 if (XTYPE (c
) == Lisp_Int
)
493 if (ptr
- echobuf
> sizeof echobuf
- 6)
496 ptr
= push_key_description (XINT (c
), ptr
);
498 else if (XTYPE (c
) == Lisp_Symbol
)
500 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
501 if (((ptr
- echobuf
) + name
->size
+ 4) > sizeof echobuf
)
503 bcopy (name
->data
, ptr
, name
->size
);
507 if (echoptr
== echobuf
&& EQ (c
, help_char
))
509 strcpy (ptr
, " (Type ? for further options)");
520 /* Temporarily add a dash to the end of the echo string if it's not
521 empty, so that it serves as a mini-prompt for the very next character. */
525 if (!immediate_echo
&& echoptr
== echobuf
)
527 /* Do nothing if not echoing at all. */
531 /* Put a dash at the end of the buffer temporarily,
532 but make it go away when the next character is added. */
539 /* Display the current echo string, and begin echoing if not already
549 for (i
= 0; i
< this_command_key_count
; i
++)
550 echo_char (XVECTOR (this_command_keys
)->contents
[i
]);
558 if (waiting_for_input
&& !NILP (Vquit_flag
))
559 quit_throw_to_read_char ();
562 /* Turn off echoing, for the start of a new command. */
570 /* Return the length of the current echo string. */
575 return echoptr
- echobuf
;
578 /* Truncate the current echo message to its first LEN chars.
579 This and echo_char get used by read_key_sequence when the user
580 switches frames while entering a key sequence. */
587 echoptr
= echobuf
+ len
;
591 /* Functions for manipulating this_command_keys. */
593 add_command_key (key
)
596 int size
= XVECTOR (this_command_keys
)->size
;
598 if (this_command_key_count
>= size
)
600 Lisp_Object new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
602 bcopy (XVECTOR (this_command_keys
)->contents
,
603 XVECTOR (new_keys
)->contents
,
604 size
* sizeof (Lisp_Object
));
606 this_command_keys
= new_keys
;
609 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
615 int count
= specpdl_ptr
- specpdl
;
618 if (command_loop_level
> 0)
620 specbind (Qstandard_output
, Qt
);
621 specbind (Qstandard_input
, Qt
);
624 val
= command_loop ();
626 Fsignal (Qquit
, Qnil
);
628 return unbind_to (count
, Qnil
);
631 /* When an auto-save happens, record the "time", and don't do again soon. */
634 last_auto_save
= num_nonmacro_input_chars
;
637 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
638 "Invoke the editor command loop recursively.\n\
639 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
640 that tells this function to return.\n\
641 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
642 This function is called by the editor initialization to begin editing.")
645 int count
= specpdl_ptr
- specpdl
;
648 command_loop_level
++;
649 update_mode_lines
= 1;
651 record_unwind_protect (recursive_edit_unwind
,
653 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
657 return unbind_to (count
, Qnil
);
661 recursive_edit_unwind (buffer
)
665 Fset_buffer (buffer
);
667 command_loop_level
--;
668 update_mode_lines
= 1;
676 Lisp_Object errmsg
, tail
, errname
, file_error
;
683 Vstandard_output
= Qt
;
684 Vstandard_input
= Qt
;
685 Vexecuting_macro
= Qnil
;
686 echo_area_glyphs
= 0;
688 /* If the window system or terminal frame hasn't been initialized
689 yet, or we're not interactive, it's best to dump this message out
690 to stderr and exit. */
691 if (! FRAME_MESSAGE_BUF (selected_frame
)
693 stream
= Qexternal_debugging_output
;
701 errname
= Fcar (data
);
703 if (EQ (errname
, Qerror
))
706 if (!CONSP (data
)) data
= Qnil
;
707 errmsg
= Fcar (data
);
712 errmsg
= Fget (errname
, Qerror_message
);
713 file_error
= Fmemq (Qfile_error
,
714 Fget (errname
, Qerror_conditions
));
717 /* Print an error message including the data items.
718 This is done by printing it into a scratch buffer
719 and then making a copy of the text in the buffer. */
721 if (!CONSP (data
)) data
= Qnil
;
725 /* For file-error, make error message by concatenating
726 all the data items. They are all strings. */
727 if (!NILP (file_error
) && !NILP (tail
))
728 errmsg
= XCONS (tail
)->car
, tail
= XCONS (tail
)->cdr
;
730 if (XTYPE (errmsg
) == Lisp_String
)
731 Fprinc (errmsg
, stream
);
733 write_string_1 ("peculiar error", -1, stream
);
735 for (i
= 0; CONSP (tail
); tail
= Fcdr (tail
), i
++)
737 write_string_1 (i
? ", " : ": ", 2, stream
);
738 if (!NILP (file_error
))
739 Fprinc (Fcar (tail
), stream
);
741 Fprin1 (Fcar (tail
), stream
);
745 /* If the window system or terminal frame hasn't been initialized
746 yet, or we're in -batch mode, this error should cause Emacs to exit. */
747 if (! FRAME_MESSAGE_BUF (selected_frame
)
751 Fkill_emacs (make_number (-1));
756 Vinhibit_quit
= Qnil
;
757 return make_number (0);
760 Lisp_Object
command_loop_1 ();
761 Lisp_Object
command_loop_2 ();
762 Lisp_Object
top_level_1 ();
764 /* Entry to editor-command-loop.
765 This level has the catches for exiting/returning to editor command loop.
766 It returns nil to exit recursive edit, t to abort it. */
771 if (command_loop_level
> 0 || minibuf_level
> 0)
773 return internal_catch (Qexit
, command_loop_2
, Qnil
);
778 internal_catch (Qtop_level
, top_level_1
, Qnil
);
779 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
781 /* End of file in -batch run causes exit here. */
787 /* Here we catch errors in execution of commands within the
788 editing loop, and reenter the editing loop.
789 When there is an error, cmd_error runs and returns a non-nil
790 value to us. A value of nil means that cmd_loop_1 itself
791 returned due to end of file (or end of kbd macro). */
796 register Lisp_Object val
;
799 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
808 return Feval (Vtop_level
);
814 /* On entry to the outer level, run the startup file */
815 if (!NILP (Vtop_level
))
816 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
817 else if (!NILP (Vpurify_flag
))
818 message ("Bare impure Emacs (standard Lisp code not loaded)");
820 message ("Bare Emacs (standard Lisp code not loaded)");
824 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
825 "Exit all recursive editing levels.")
828 Fthrow (Qtop_level
, Qnil
);
831 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
832 "Exit from the innermost recursive edit or minibuffer.")
835 if (command_loop_level
> 0 || minibuf_level
> 0)
836 Fthrow (Qexit
, Qnil
);
838 error ("No recursive edit is in progress");
841 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
842 "Abort the command that requested this recursive edit or minibuffer input.")
845 if (command_loop_level
> 0 || minibuf_level
> 0)
848 error ("No recursive edit is in progress");
851 /* This is the actual command reading loop,
852 sans error-handling encapsulation. */
854 Lisp_Object
Fcommand_execute ();
855 static int read_key_sequence ();
860 Lisp_Object cmd
, tem
;
863 Lisp_Object keybuf
[30];
868 struct buffer
*prev_buffer
;
871 Vdeactivate_mark
= Qnil
;
872 waiting_for_input
= 0;
875 /* Don't clear out last_command at the beginning of a macro. */
876 if (XTYPE (Vexecuting_macro
) != Lisp_String
)
881 this_command_key_count
= 0;
885 /* Install chars successfully executed in kbd macro. */
887 if (defining_kbd_macro
&& NILP (Vprefix_arg
))
888 finalize_kbd_macro_chars ();
890 /* Make sure the current window's buffer is selected. */
891 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
892 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
894 /* Display any malloc warning that just came out. Use while because
895 displaying one warning can cause another. */
897 while (pending_malloc_warning
)
898 display_malloc_warning ();
902 Vdeactivate_mark
= Qnil
;
904 /* If minibuffer on and echo area in use,
905 wait 2 sec and redraw minibufer. */
907 if (minibuf_level
&& echo_area_glyphs
)
909 /* Bind inhibit-quit to t so that C-g gets read in
910 rather than quitting back to the minibuffer. */
911 int count
= specpdl_ptr
- specpdl
;
912 specbind (Qinhibit_quit
, Qt
);
913 Fsit_for (make_number (2), Qnil
, Qnil
);
914 unbind_to (count
, Qnil
);
916 echo_area_glyphs
= 0;
918 if (!NILP (Vquit_flag
))
921 unread_command_events
= Fcons (make_number (quit_char
), Qnil
);
926 alloca (0); /* Cause a garbage collection now */
927 /* Since we can free the most stuff here. */
928 #endif /* C_ALLOCA */
932 /* Select the frame that the last event came from. Usually,
933 switch-frame events will take care of this, but if some lisp
934 code swallows a switch-frame event, we'll fix things up here.
935 Is this a good idea? */
936 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
937 && XFRAME (internal_last_event_frame
) != selected_frame
)
938 Fselect_frame (internal_last_event_frame
, Qnil
);
941 /* If it has changed current-menubar from previous value,
942 really recompute the menubar from the value. */
943 if (! NILP (Vlucid_menu_bar_dirty_flag
))
944 call0 (Qrecompute_lucid_menubar
);
946 #if 0 /* This is done in xdisp.c now. */
948 for (tem
= Vframe_list
; CONSP (tem
); tem
= XCONS (tem
)->cdr
)
950 struct frame
*f
= XFRAME (XCONS (tem
)->car
);
951 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
953 /* If the user has switched buffers or windows, we need to
954 recompute to reflect the new bindings. But we'll
955 recompute when update_mode_lines is set too; that means
956 that people can use force-mode-line-update to request
957 that the menu bar be recomputed. The adverse effect on
958 the rest of the redisplay algorithm is about the same as
959 windows_or_buffers_changed anyway. */
960 if (windows_or_buffers_changed
962 || (XFASTINT (w
->last_modified
) < MODIFF
963 && (XFASTINT (w
->last_modified
)
964 <= XBUFFER (w
->buffer
)->save_modified
)))
966 struct buffer
*prev
= current_buffer
;
967 current_buffer
= XBUFFER (w
->buffer
);
968 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items ();
969 current_buffer
= prev
;
972 #endif /* MULTI_FRAME */
975 /* Read next key sequence; i gets its length. */
976 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), 0);
980 /* Now we have read a key sequence of length I,
981 or else I is 0 and we found end of file. */
983 if (i
== 0) /* End of file -- happens only in */
984 return Qnil
; /* a kbd macro, at the end. */
986 last_command_char
= keybuf
[i
- 1];
988 /* If the previous command tried to force a specific window-start,
989 forget about that, in case this command moves point far away
990 from that position. */
991 XWINDOW (selected_window
)->force_start
= Qnil
;
993 cmd
= read_key_sequence_cmd
;
994 if (!NILP (Vexecuting_macro
))
996 if (!NILP (Vquit_flag
))
998 Vexecuting_macro
= Qt
;
999 QUIT
; /* Make some noise. */
1000 /* Will return since macro now empty. */
1004 /* Do redisplay processing after this command except in special
1005 cases identified below that set no_redisplay to 1. */
1008 prev_buffer
= current_buffer
;
1009 prev_modiff
= MODIFF
;
1011 /* Execute the command. */
1014 if (!NILP (Vpre_command_hook
))
1015 call1 (Vrun_hooks
, Qpre_command_hook
);
1017 if (NILP (this_command
))
1019 /* nil means key is undefined. */
1021 defining_kbd_macro
= 0;
1022 update_mode_lines
= 1;
1028 if (NILP (Vprefix_arg
) && ! no_direct
)
1030 /* Recognize some common commands in common situations and
1031 do them directly. */
1032 if (EQ (this_command
, Qforward_char
) && point
< ZV
)
1034 struct Lisp_Vector
*dp
1035 = window_display_table (XWINDOW (selected_window
));
1036 lose
= FETCH_CHAR (point
);
1039 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1040 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1041 : (lose
>= 0x20 && lose
< 0x7f))
1042 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1044 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1046 && !windows_or_buffers_changed
1047 && EQ (current_buffer
->selective_display
, Qnil
)
1048 && !detect_input_pending ()
1049 && NILP (Vexecuting_macro
))
1050 no_redisplay
= direct_output_forward_char (1);
1053 else if (EQ (this_command
, Qbackward_char
) && point
> BEGV
)
1055 struct Lisp_Vector
*dp
1056 = window_display_table (XWINDOW (selected_window
));
1058 lose
= FETCH_CHAR (point
);
1060 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1061 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1062 : (lose
>= 0x20 && lose
< 0x7f))
1063 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1065 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1067 && !windows_or_buffers_changed
1068 && EQ (current_buffer
->selective_display
, Qnil
)
1069 && !detect_input_pending ()
1070 && NILP (Vexecuting_macro
))
1071 no_redisplay
= direct_output_forward_char (-1);
1074 else if (EQ (this_command
, Qself_insert_command
)
1075 /* Try this optimization only on ascii keystrokes. */
1076 && XTYPE (last_command_char
) == Lisp_Int
)
1078 unsigned char c
= XINT (last_command_char
);
1080 if (NILP (Vexecuting_macro
) &&
1081 !EQ (minibuf_window
, selected_window
))
1083 if (!nonundocount
|| nonundocount
>= 20)
1090 lose
= (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1092 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1094 || MODIFF
<= current_buffer
->save_modified
1095 || windows_or_buffers_changed
1096 || !EQ (current_buffer
->selective_display
, Qnil
)
1097 || detect_input_pending ()
1098 || !NILP (Vexecuting_macro
);
1099 if (internal_self_insert (XINT (c
), 0))
1105 (point
== ZV
|| FETCH_CHAR (point
) == '\n'))
1107 struct Lisp_Vector
*dp
1108 = window_display_table (XWINDOW (selected_window
));
1109 int lose
= XINT (c
);
1113 Lisp_Object obj
= DISP_CHAR_VECTOR (dp
, lose
);
1115 if (XTYPE (obj
) == Lisp_Vector
1116 && XVECTOR (obj
)->size
== 1
1117 && (XTYPE (obj
= XVECTOR (obj
)->contents
[0])
1120 direct_output_for_insert (XINT (obj
));
1124 if (lose
>= 0x20 && lose
<= 0x7e)
1125 no_redisplay
= direct_output_for_insert (lose
);
1132 /* Here for a command that isn't executed directly */
1135 if (NILP (Vprefix_arg
))
1137 Fcommand_execute (this_command
, Qnil
);
1142 if (!NILP (Vpost_command_hook
))
1143 call1 (Vrun_hooks
, Qpost_command_hook
);
1145 /* If there is a prefix argument,
1146 1) We don't want last_command to be ``universal-argument''
1147 (that would be dumb), so don't set last_command,
1148 2) we want to leave echoing on so that the prefix will be
1149 echoed as part of this key sequence, so don't call
1151 3) we want to leave this_command_key_count non-zero, so that
1152 read_char will realize that it is re-reading a character, and
1153 not echo it a second time. */
1154 if (NILP (Vprefix_arg
))
1156 last_command
= this_command
;
1158 this_command_key_count
= 0;
1161 if (!NILP (current_buffer
->mark_active
))
1163 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1165 current_buffer
->mark_active
= Qnil
;
1166 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1168 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1169 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1174 /* Number of seconds between polling for input. */
1177 /* Nonzero means polling for input is temporarily suppresed. */
1178 int poll_suppress_count
;
1180 #ifdef POLL_FOR_INPUT
1181 int polling_for_input
;
1183 /* Handle an alarm once each second and read pending input
1184 so as to handle a C-g if it comces in. */
1187 input_poll_signal ()
1189 if (interrupt_input_blocked
== 0
1190 && !waiting_for_input
)
1191 read_avail_input (0);
1192 signal (SIGALRM
, input_poll_signal
);
1193 alarm (polling_period
);
1198 /* Begin signals to poll for input, if they are appropriate.
1199 This function is called unconditionally from various places. */
1203 #ifdef POLL_FOR_INPUT
1204 if (read_socket_hook
)
1206 poll_suppress_count
--;
1207 if (poll_suppress_count
== 0)
1209 signal (SIGALRM
, input_poll_signal
);
1210 polling_for_input
= 1;
1211 alarm (polling_period
);
1217 /* Turn off polling. */
1221 #ifdef POLL_FOR_INPUT
1222 if (read_socket_hook
)
1224 if (poll_suppress_count
== 0)
1226 polling_for_input
= 0;
1229 poll_suppress_count
++;
1234 /* Applying the control modifier to CHARACTER. */
1239 /* Save the upper bits here. */
1240 int upper
= c
& ~0177;
1244 /* Everything in the columns containing the upper-case letters
1245 denotes a control character. */
1246 if (c
>= 0100 && c
< 0140)
1250 /* Set the shift modifier for a control char
1251 made from a shifted letter. But only for letters! */
1252 if (oc
>= 'A' && oc
<= 'Z')
1253 c
|= shift_modifier
;
1256 /* The lower-case letters denote control characters too. */
1257 else if (c
>= 'a' && c
<= 'z')
1260 /* Include the bits for control and shift
1261 only if the basic ASCII code can't indicate them. */
1265 /* Replace the high bits. */
1266 c
|= (upper
& ~ctrl_modifier
);
1273 /* Input of single characters from keyboard */
1275 Lisp_Object
print_help ();
1276 static Lisp_Object
kbd_buffer_get_event ();
1278 /* read a character from the keyboard; call the redisplay if needed */
1279 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1280 -1 means do not do redisplay, but do do autosaving.
1283 /* The arguments MAPS and NMAPS are for menu prompting.
1284 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1286 PREV_EVENT is the previous input event, or nil if we are reading
1287 the first event of a key sequence.
1289 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1290 if we used a mouse menu to read the input, or zero otherwise. If
1291 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone. */
1294 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1298 Lisp_Object prev_event
;
1299 int *used_mouse_menu
;
1301 register Lisp_Object c
;
1305 if (CONSP (unread_command_events
))
1307 c
= XCONS (unread_command_events
)->car
;
1308 unread_command_events
= XCONS (unread_command_events
)->cdr
;
1310 if (this_command_key_count
== 0)
1316 if (unread_command_char
!= -1)
1318 XSET (c
, Lisp_Int
, unread_command_char
);
1319 unread_command_char
= -1;
1321 if (this_command_key_count
== 0)
1327 if (!NILP (Vexecuting_macro
))
1330 /* We set this to Qmacro; since that's not a frame, nobody will
1331 try to switch frames on us, and the selected window will
1334 Since this event came from a macro, it would be misleading to
1335 leave internal_last_event_frame set to whereever the last
1336 real event came from. Normally, a switch-frame event selects
1337 internal_last_event_frame after each command is read, but
1338 events read from a macro should never cause a new frame to be
1340 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1343 /* Exit the macro if we are at the end.
1344 Also, some things replace the macro with t
1345 to force an early exit. */
1346 if (EQ (Vexecuting_macro
, Qt
)
1347 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1349 XSET (c
, Lisp_Int
, -1);
1353 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1354 if (XTYPE (Vexecuting_macro
) == Lisp_String
1355 && (XINT (c
) & 0x80))
1356 XFASTINT (c
) = CHAR_META
| (XINT (c
) & ~0x80);
1358 executing_macro_index
++;
1363 if (!NILP (unread_switch_frame
))
1365 c
= unread_switch_frame
;
1366 unread_switch_frame
= Qnil
;
1368 /* This event should make it into this_command_keys, and get echoed
1369 again, so we go to reread_first, rather than reread. */
1373 /* Save outer setjmp data, in case called recursively. */
1374 save_getcjmp (save_jump
);
1378 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1381 if (_setjmp (getcjmp
))
1383 XSET (c
, Lisp_Int
, quit_char
);
1385 XSET (internal_last_event_frame
, Lisp_Frame
, selected_frame
);
1386 Vlast_event_frame
= internal_last_event_frame
;
1388 /* If we report the quit char as an event,
1389 don't do so more than once. */
1390 if (!NILP (Vinhibit_quit
))
1396 /* Message turns off echoing unless more keystrokes turn it on again. */
1397 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1400 /* If already echoing, continue. */
1403 /* If in middle of key sequence and minibuffer not active,
1404 start echoing if enough time elapses. */
1405 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1406 && echo_keystrokes
> 0
1407 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1411 /* After a mouse event, start echoing right away.
1412 This is because we are probably about to display a menu,
1413 and we don't want to delay before doing so. */
1414 if (EVENT_HAS_PARAMETERS (prev_event
))
1418 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1424 /* Maybe auto save due to number of keystrokes or idle time. */
1426 if (commandflag
!= 0
1427 && auto_save_interval
> 0
1428 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1429 && !detect_input_pending ())
1432 save_getcjmp (temp
);
1433 Fdo_auto_save (Qnil
, Qnil
);
1434 restore_getcjmp (temp
);
1437 /* Try reading a character via menu prompting.
1438 Try this before the sit-for, because the sit-for
1439 would do the wrong thing if we are supposed to do
1442 if (INTERACTIVE
&& !NILP (prev_event
))
1443 c
= read_char_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1445 /* Slow down auto saves logarithmically in size of current buffer,
1446 and garbage collect while we're at it. */
1449 int delay_level
, buffer_size
;
1451 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1452 last_non_minibuf_size
= Z
- BEG
;
1453 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1455 while (buffer_size
> 64)
1456 delay_level
++, buffer_size
-= buffer_size
>> 2;
1457 if (delay_level
< 4) delay_level
= 4;
1458 /* delay_level is 4 for files under around 50k, 7 at 100k,
1459 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1461 /* Auto save if enough time goes by without input. */
1462 if (commandflag
!= 0
1463 && num_nonmacro_input_chars
> last_auto_save
1464 && XTYPE (Vauto_save_timeout
) == Lisp_Int
1465 && XINT (Vauto_save_timeout
) > 0)
1468 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1469 tem0
= sit_for (delay
, 0, 1, 1);
1473 save_getcjmp (temp
);
1474 Fdo_auto_save (Qnil
, Qnil
);
1475 restore_getcjmp (temp
);
1477 /* If we have auto-saved and there is still no input
1478 available, garbage collect if there has been enough
1479 consing going on to make it worthwhile. */
1480 if (!detect_input_pending ()
1481 && consing_since_gc
> gc_cons_threshold
/ 2)
1482 Fgarbage_collect ();
1487 /* Actually read a character, waiting if necessary. */
1490 c
= kbd_buffer_get_event ();
1493 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1497 /* Terminate Emacs in batch mode if at eof. */
1498 if (noninteractive
&& XTYPE (c
) == Lisp_Int
&& XINT (c
) < 0)
1499 Fkill_emacs (make_number (1));
1501 if (XTYPE (c
) == Lisp_Int
)
1503 /* Add in any extra modifiers, where appropriate. */
1504 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1505 || ((extra_keyboard_modifiers
& 0177) < ' '
1506 && (extra_keyboard_modifiers
& 0177) != 0))
1507 XSETINT (c
, make_ctrl_char (XINT (c
)));
1509 /* Transfer any other modifier bits directly from
1510 extra_keyboard_modifiers to c. Ignore the actual character code
1511 in the low 16 bits of extra_keyboard_modifiers. */
1512 c
|= (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
);
1517 restore_getcjmp (save_jump
);
1521 echo_area_glyphs
= 0;
1523 /* Handle things that only apply to characters. */
1524 if (XTYPE (c
) == Lisp_Int
)
1526 /* If kbd_buffer_get_event gave us an EOF, return that. */
1530 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
1531 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1532 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1536 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1537 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1538 recent_keys_index
= 0;
1540 /* Write c to the dribble file. If c is a lispy event, write
1541 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1542 If you, dear reader, have a better idea, you've got the source. :-) */
1545 if (XTYPE (c
) == Lisp_Int
)
1546 putc (XINT (c
), dribble
);
1549 Lisp_Object dribblee
= c
;
1551 /* If it's a structured event, take the event header. */
1552 dribblee
= EVENT_HEAD (dribblee
);
1554 if (XTYPE (dribblee
) == Lisp_Symbol
)
1556 putc ('<', dribble
);
1557 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1558 XSYMBOL (dribblee
)->name
->size
,
1560 putc ('>', dribble
);
1567 store_kbd_macro_char (c
);
1569 num_nonmacro_input_chars
++;
1574 /* Record this character as part of the current key.
1575 Don't record mouse motion; it should never matter. */
1576 if (! (EVENT_HAS_PARAMETERS (c
)
1577 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1580 add_command_key (c
);
1583 /* Re-reading in the middle of a command */
1585 last_input_char
= c
;
1588 /* Process the help character specially if enabled */
1589 if (EQ (c
, help_char
) && !NILP (Vhelp_form
))
1592 count
= specpdl_ptr
- specpdl
;
1594 record_unwind_protect (Fset_window_configuration
,
1595 Fcurrent_window_configuration (Qnil
));
1597 tem0
= Feval (Vhelp_form
);
1598 if (XTYPE (tem0
) == Lisp_String
)
1599 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1602 c
= read_char (0, 0, 0, Qnil
, 0);
1603 /* Remove the help from the frame */
1604 unbind_to (count
, Qnil
);
1606 if (EQ (c
, make_number (040)))
1609 c
= read_char (0, 0, 0, Qnil
, 0);
1620 Fprinc (object
, Qnil
);
1624 /* Copy out or in the info on where C-g should throw to.
1625 This is used when running Lisp code from within get_char,
1626 in case get_char is called recursively.
1627 See read_process_output. */
1632 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1635 restore_getcjmp (temp
)
1638 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1642 /* Low level keyboard/mouse input.
1643 kbd_buffer_store_event places events in kbd_buffer, and
1644 kbd_buffer_get_event retrieves them.
1645 mouse_moved indicates when the mouse has moved again, and
1646 *mouse_position_hook provides the mouse position. */
1648 /* Set this for debugging, to have a way to get out */
1651 extern int frame_garbaged
;
1653 /* Return true iff there are any events in the queue that read-char
1654 would return. If this returns false, a read-char would block. */
1658 return ! EVENT_QUEUES_EMPTY
;
1662 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1663 of this function. */
1665 tracking_off (old_value
)
1666 Lisp_Object old_value
;
1668 if (! XFASTINT (old_value
))
1670 do_mouse_tracking
= 0;
1672 /* Redisplay may have been preempted because there was input
1673 available, and it assumes it will be called again after the
1674 input has been processed. If the only input available was
1675 the sort that we have just disabled, then we need to call
1677 if (!readable_events ())
1679 redisplay_preserve_echo_area ();
1680 get_input_pending (&input_pending
);
1685 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1686 "Evaluate BODY with mouse movement events enabled.\n\
1687 Within a `track-mouse' form, mouse motion generates input events that\n\
1688 you can read with `read-event'.\n\
1689 Normally, mouse motion is ignored.")
1693 int count
= specpdl_ptr
- specpdl
;
1696 XSET (val
, Lisp_Int
, do_mouse_tracking
);
1697 record_unwind_protect (tracking_off
, val
);
1699 do_mouse_tracking
= 1;
1701 val
= Fprogn (args
);
1702 return unbind_to (count
, val
);
1705 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
1708 kbd_buffer_store_event (event
)
1709 register struct input_event
*event
;
1711 if (event
->kind
== no_event
)
1714 if (event
->kind
== ascii_keystroke
)
1716 register int c
= XFASTINT (event
->code
) & 0377;
1718 if (event
->modifiers
& ctrl_modifier
)
1719 c
= make_ctrl_char (c
);
1723 extern SIGTYPE
interrupt_signal ();
1726 /* If this results in a quit_char being returned to Emacs as
1727 input, set Vlast_event_frame properly. If this doesn't
1728 get returned to Emacs as an event, the next event read
1729 will set Vlast_event_frame again, so this is safe to do. */
1732 FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
1735 internal_last_event_frame
= event
->frame_or_window
;
1737 internal_last_event_frame
= focus
;
1738 Vlast_event_frame
= internal_last_event_frame
;
1742 last_event_timestamp
= event
->timestamp
;
1743 interrupt_signal ();
1747 if (c
&& c
== stop_character
)
1753 XSET (event
->code
, Lisp_Int
, c
);
1756 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
1757 kbd_store_ptr
= kbd_buffer
;
1759 /* Don't let the very last slot in the buffer become full,
1760 since that would make the two pointers equal,
1761 and that is indistinguishable from an empty buffer.
1762 Discard the event if it would fill the last slot. */
1763 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
1765 kbd_store_ptr
->kind
= event
->kind
;
1766 kbd_store_ptr
->code
= event
->code
;
1767 kbd_store_ptr
->part
= event
->part
;
1768 kbd_store_ptr
->frame_or_window
= event
->frame_or_window
;
1769 kbd_store_ptr
->modifiers
= event
->modifiers
;
1770 kbd_store_ptr
->x
= event
->x
;
1771 kbd_store_ptr
->y
= event
->y
;
1772 kbd_store_ptr
->timestamp
= event
->timestamp
;
1773 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
1775 = event
->frame_or_window
);
1781 static Lisp_Object
make_lispy_event ();
1782 static Lisp_Object
make_lispy_movement ();
1783 static Lisp_Object
modify_event_symbol ();
1784 static Lisp_Object
make_lispy_switch_frame ();
1787 kbd_buffer_get_event ()
1795 XSET (obj
, Lisp_Int
, c
);
1800 /* Wait until there is input available. */
1803 if (!EVENT_QUEUES_EMPTY
)
1806 /* If the quit flag is set, then read_char will return
1807 quit_char, so that counts as "available input." */
1808 if (!NILP (Vquit_flag
))
1809 quit_throw_to_read_char ();
1811 /* One way or another, wait until input is available; then, if
1812 interrupt handlers have not read it, read it now. */
1815 wait_for_kbd_input ();
1817 /* Note SIGIO has been undef'd if FIONREAD is missing. */
1821 if (EVENT_QUEUES_EMPTY
)
1823 Lisp_Object minus_one
;
1825 XSET (minus_one
, Lisp_Int
, -1);
1826 wait_reading_process_input (0, 0, minus_one
, 1);
1828 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
1830 read_avail_input (0);
1833 #endif /* not VMS */
1836 /* At this point, we know that there is a readable event available
1837 somewhere. If the event queue is empty, then there must be a
1838 mouse movement enabled and available. */
1839 if (kbd_fetch_ptr
!= kbd_store_ptr
)
1841 struct input_event
*event
;
1843 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
1847 last_event_timestamp
= event
->timestamp
;
1851 /* These two kinds of events get special handling
1852 and don't actually appear to the command loop. */
1853 if (event
->kind
== selection_request_event
)
1856 x_handle_selection_request (event
);
1857 kbd_fetch_ptr
= event
+ 1;
1859 /* We're getting selection request events, but we don't have
1865 else if (event
->kind
== selection_clear_event
)
1868 x_handle_selection_clear (event
);
1869 kbd_fetch_ptr
= event
+ 1;
1871 /* We're getting selection request events, but we don't have
1878 /* If this event is on a different frame, return a switch-frame this
1879 time, and leave the event in the queue for next time. */
1882 Lisp_Object frame
= event
->frame_or_window
;
1885 if (XTYPE (frame
) == Lisp_Window
)
1886 frame
= WINDOW_FRAME (XWINDOW (frame
));
1888 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
1892 if (! EQ (frame
, internal_last_event_frame
)
1893 && XFRAME (frame
) != selected_frame
)
1894 obj
= make_lispy_switch_frame (frame
);
1895 internal_last_event_frame
= frame
;
1897 /* If we didn't decide to make a switch-frame event, go ahead
1898 and build a real event from the queue entry. */
1902 obj
= make_lispy_event (event
);
1904 /* Wipe out this event, to catch bugs. */
1905 event
->kind
= no_event
;
1906 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
1909 kbd_fetch_ptr
= event
+ 1;
1914 else if (do_mouse_tracking
&& mouse_moved
)
1917 Lisp_Object bar_window
;
1918 enum scroll_bar_part part
;
1922 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
1927 /* Decide if we should generate a switch-frame event. Don't
1928 generate switch-frame events for motion outside of all Emacs
1932 Lisp_Object frame
= FRAME_FOCUS_FRAME (f
);
1935 XSET (frame
, Lisp_Frame
, f
);
1937 if (! EQ (frame
, internal_last_event_frame
)
1938 && XFRAME (frame
) != selected_frame
)
1939 obj
= make_lispy_switch_frame (internal_last_event_frame
);
1940 internal_last_event_frame
= frame
;
1944 /* If we didn't decide to make a switch-frame event, go ahead and
1945 return a mouse-motion event. */
1947 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
1950 /* We were promised by the above while loop that there was
1951 something for us to read! */
1955 /* If something gave back nil as the Lispy event,
1956 it means the event was discarded, so try again. */
1961 input_pending
= readable_events ();
1964 Vlast_event_frame
= internal_last_event_frame
;
1970 /* Process any events that are not user-visible. */
1975 while (kbd_fetch_ptr
!= kbd_store_ptr
)
1977 struct input_event
*event
;
1979 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
1983 last_event_timestamp
= event
->timestamp
;
1985 /* These two kinds of events get special handling
1986 and don't actually appear to the command loop. */
1987 if (event
->kind
== selection_request_event
)
1990 x_handle_selection_request (event
);
1991 kbd_fetch_ptr
= event
+ 1;
1993 /* We're getting selection request events, but we don't have
1999 else if (event
->kind
== selection_clear_event
)
2002 x_handle_selection_clear (event
);
2003 kbd_fetch_ptr
= event
+ 1;
2005 /* We're getting selection request events, but we don't have
2014 get_input_pending (&input_pending
);
2017 /* Caches for modify_event_symbol. */
2018 static Lisp_Object func_key_syms
;
2019 static Lisp_Object mouse_syms
;
2021 /* You'll notice that this table is arranged to be conveniently
2022 indexed by X Windows keysym values. */
2023 static char *lispy_function_keys
[] =
2025 /* X Keysym value */
2027 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2035 0, 0, 0, /* 0xff10 */
2037 0, 0, 0, 0, 0, 0, 0,
2040 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2041 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2042 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2044 "home", /* 0xff50 */ /* IsCursorKey */
2055 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2066 "break", /* 0xff6b */
2068 /* Here are some keys found mostly on HP keyboards. The X event
2069 handling code will strip bit 29, which flags vendor-specific
2071 "reset", /* 0x1000ff6c */
2080 "kp-backtab", /* 0x1000ff75 */
2082 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2083 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2084 0, 0, 0, 0, 0, 0, 0, 0,
2085 "kp-tab", /* 0xff89 */
2087 "kp-enter", /* 0xff8d */
2089 "kp-f1", /* 0xff91 */
2094 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2095 "kp-multiply", /* 0xffaa */
2100 "kp-divide", /* 0xffaf */
2101 "kp-0", /* 0xffb0 */
2102 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2105 "kp-equal", /* 0xffbd */
2106 "f1", /* 0xffbe */ /* IsFunctionKey */
2108 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2109 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2110 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2111 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2112 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2113 0, 0, 0, 0, 0, 0, 0, 0,
2114 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2115 0, 0, 0, 0, 0, 0, 0, "delete"
2118 static char *lispy_mouse_names
[] =
2120 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2123 /* Scroll bar parts. */
2124 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2126 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2127 Lisp_Object
*scroll_bar_parts
[] = {
2128 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2132 /* A vector, indexed by button number, giving the down-going location
2133 of currently depressed buttons, both scroll bar and non-scroll bar.
2135 The elements have the form
2136 (BUTTON-NUMBER MODIFIER-MASK . REST)
2137 where REST is the cdr of a position as it would be reported in the event.
2139 The make_lispy_event function stores positions here to tell the
2140 difference between click and drag events, and to store the starting
2141 location to be included in drag events. */
2143 static Lisp_Object button_down_location
;
2145 /* Given a struct input_event, build the lisp event which represents
2146 it. If EVENT is 0, build a mouse movement event from the mouse
2147 movement buffer, which should have a movement event in it.
2149 Note that events must be passed to this function in the order they
2150 are received; this function stores the location of button presses
2151 in order to build drag events when the button is released. */
2154 make_lispy_event (event
)
2155 struct input_event
*event
;
2157 #ifdef SWITCH_ENUM_BUG
2158 switch ((int) event
->kind
)
2160 switch (event
->kind
)
2163 /* A simple keystroke. */
2164 case ascii_keystroke
:
2166 int c
= XFASTINT (event
->code
);
2167 /* Turn ASCII characters into control characters
2169 if (event
->modifiers
& ctrl_modifier
)
2170 c
= make_ctrl_char (c
);
2172 /* Add in the other modifier bits. We took care of ctrl_modifier
2173 just above, and the shift key was taken care of by the X code,
2174 and applied to control characters by make_ctrl_char. */
2175 c
|= (event
->modifiers
2176 & (meta_modifier
| alt_modifier
2177 | hyper_modifier
| super_modifier
));
2181 /* A function key. The symbol may need to have modifier prefixes
2183 case non_ascii_keystroke
:
2184 return modify_event_symbol (XFASTINT (event
->code
), event
->modifiers
,
2186 lispy_function_keys
, &func_key_syms
,
2187 (sizeof (lispy_function_keys
)
2188 / sizeof (lispy_function_keys
[0])));
2191 /* A mouse click. Figure out where it is, decide whether it's
2192 a press, click or drag, and build the appropriate structure. */
2194 case scroll_bar_click
:
2196 int button
= XFASTINT (event
->code
);
2197 Lisp_Object position
;
2198 Lisp_Object
*start_pos_ptr
;
2199 Lisp_Object start_pos
;
2201 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2204 /* Build the position as appropriate for this mouse click. */
2205 if (event
->kind
== mouse_click
)
2208 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2210 = window_from_coordinates (f
, XINT (event
->x
), XINT (event
->y
),
2214 if (XINT (event
->y
) < FRAME_MENU_BAR_LINES (f
))
2218 items
= FRAME_MENU_BAR_ITEMS (f
);
2219 for (; CONSP (items
); items
= XCONS (items
)->cdr
)
2221 Lisp_Object pos
, string
;
2222 pos
= Fcdr (Fcdr (Fcar (items
)));
2223 string
= Fcar (Fcdr (Fcar (items
)));
2224 if (XINT (event
->x
) > XINT (pos
)
2225 && XINT (event
->x
) <= XINT (pos
) + XSTRING (string
)->size
)
2229 = Fcons (event
->frame_or_window
,
2231 Fcons (Fcons (event
->x
, event
->y
),
2232 Fcons (make_number (event
->timestamp
),
2236 return Fcons (Fcar (Fcar (items
)),
2237 Fcons (position
, Qnil
));
2239 return Fcons (Qnil
, Fcons (position
, Qnil
));
2241 else if (XTYPE (window
) != Lisp_Window
)
2246 (XINT (event
->x
) - XINT (XWINDOW (window
)->left
)));
2248 (XINT (event
->y
) - XINT (XWINDOW (window
)->top
)));
2253 posn
= Qvertical_line
;
2255 XSET (posn
, Lisp_Int
,
2256 buffer_posn_from_coords (XWINDOW (window
),
2264 Fcons (Fcons (event
->x
, event
->y
),
2265 Fcons (make_number (event
->timestamp
),
2270 Lisp_Object window
= event
->frame_or_window
;
2271 Lisp_Object portion_whole
= Fcons (event
->x
, event
->y
);
2272 Lisp_Object part
= *scroll_bar_parts
[(int) event
->part
];
2276 Fcons (Qvertical_scroll_bar
,
2277 Fcons (portion_whole
,
2278 Fcons (make_number (event
->timestamp
),
2283 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2285 start_pos
= *start_pos_ptr
;
2286 *start_pos_ptr
= Qnil
;
2288 /* If this is a button press, squirrel away the location, so
2289 we can decide later whether it was a click or a drag. */
2290 if (event
->modifiers
& down_modifier
)
2291 *start_pos_ptr
= Fcopy_alist (position
);
2293 /* Now we're releasing a button - check the co-ordinates to
2294 see if this was a click or a drag. */
2295 else if (event
->modifiers
& up_modifier
)
2297 /* If we did not see a down before this up,
2298 ignore the up. Probably this happened because
2299 the down event chose a menu item.
2300 It would be an annoyance to treat the release
2301 of the button that chose the menu item
2302 as a separate event. */
2304 if (XTYPE (start_pos
) != Lisp_Cons
)
2307 event
->modifiers
&= ~up_modifier
;
2308 #if 0 /* Formerly we treated an up with no down as a click event. */
2309 if (XTYPE (start_pos
) != Lisp_Cons
)
2310 event
->modifiers
|= click_modifier
;
2314 /* The third element of every position should be the (x,y)
2316 Lisp_Object down
= Fnth (make_number (2), start_pos
);
2318 event
->modifiers
|= ((EQ (event
->x
, XCONS (down
)->car
)
2319 && EQ (event
->y
, XCONS (down
)->cdr
))
2325 /* Every mouse event should either have the down_modifier or
2326 the up_modifier set. */
2330 /* Get the symbol we should use for the mouse click. */
2332 = modify_event_symbol (button
,
2335 lispy_mouse_names
, &mouse_syms
,
2336 (sizeof (lispy_mouse_names
)
2337 / sizeof (lispy_mouse_names
[0])));
2339 if (event
->modifiers
& drag_modifier
)
2351 /* The 'kind' field of the event is something we don't recognize. */
2358 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2360 Lisp_Object bar_window
;
2361 enum scroll_bar_part part
;
2365 /* Is it a scroll bar movement? */
2366 if (frame
&& ! NILP (bar_window
))
2368 Lisp_Object part_sym
= *scroll_bar_parts
[(int) part
];
2370 return Fcons (Qscroll_bar_movement
,
2371 (Fcons (Fcons (bar_window
,
2372 Fcons (Qvertical_scroll_bar
,
2373 Fcons (Fcons (x
, y
),
2374 Fcons (make_number (time
),
2380 /* Or is it an ordinary mouse movement? */
2384 Lisp_Object window
=
2386 ? window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
)
2390 if (XTYPE (window
) == Lisp_Window
)
2392 XSETINT (x
, XINT (x
) - XINT (XWINDOW (window
)->left
));
2393 XSETINT (y
, XINT (y
) - XINT (XWINDOW (window
)->top
));
2398 posn
= Qvertical_line
;
2400 XSET (posn
, Lisp_Int
,
2401 buffer_posn_from_coords (XWINDOW (window
),
2402 XINT (x
), XINT (y
)));
2412 return Fcons (Qmouse_movement
,
2413 Fcons (Fcons (window
,
2415 Fcons (Fcons (x
, y
),
2416 Fcons (make_number (time
),
2422 /* Construct a switch frame event. */
2424 make_lispy_switch_frame (frame
)
2427 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
2430 /* Manipulating modifiers. */
2432 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
2434 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2435 SYMBOL's name of the end of the modifiers; the string from this
2436 position is the unmodified symbol name.
2438 This doesn't use any caches. */
2440 parse_modifiers_uncached (symbol
, modifier_end
)
2444 struct Lisp_String
*name
;
2448 CHECK_SYMBOL (symbol
, 1);
2451 name
= XSYMBOL (symbol
)->name
;
2454 for (i
= 0; i
+2 <= name
->size
; )
2455 switch (name
->data
[i
])
2457 #define SINGLE_LETTER_MOD(bit) \
2458 if (name->data[i+1] != '-') \
2459 goto no_more_modifiers; \
2464 SINGLE_LETTER_MOD (alt_modifier
);
2468 SINGLE_LETTER_MOD (ctrl_modifier
);
2472 SINGLE_LETTER_MOD (hyper_modifier
);
2476 SINGLE_LETTER_MOD (meta_modifier
);
2480 SINGLE_LETTER_MOD (shift_modifier
);
2484 SINGLE_LETTER_MOD (super_modifier
);
2488 if (i
+ 5 > name
->size
)
2489 goto no_more_modifiers
;
2490 if (! strncmp (name
->data
+ i
, "drag-", 5))
2492 modifiers
|= drag_modifier
;
2495 else if (! strncmp (name
->data
+ i
, "down-", 5))
2497 modifiers
|= down_modifier
;
2501 goto no_more_modifiers
;
2505 goto no_more_modifiers
;
2507 #undef SINGLE_LETTER_MOD
2511 /* Should we include the `click' modifier? */
2512 if (! (modifiers
& (down_modifier
| drag_modifier
))
2513 && i
+ 7 == name
->size
2514 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
2515 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
2516 modifiers
|= click_modifier
;
2525 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
2526 prepended to the string BASE[0..BASE_LEN-1].
2527 This doesn't use any caches. */
2529 apply_modifiers_uncached (modifiers
, base
, base_len
)
2534 /* Since BASE could contain nulls, we can't use intern here; we have
2535 to use Fintern, which expects a genuine Lisp_String, and keeps a
2538 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-"));
2544 /* Only the event queue may use the `up' modifier; it should always
2545 be turned into a click or drag event before presented to lisp code. */
2546 if (modifiers
& up_modifier
)
2549 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
2550 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
2551 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
2552 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
2553 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
2554 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
2555 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
2556 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
2557 /* The click modifier is denoted by the absence of other modifiers. */
2561 mod_len
= p
- new_mods
;
2565 Lisp_Object new_name
= make_uninit_string (mod_len
+ base_len
);
2567 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
2568 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
2570 return Fintern (new_name
, Qnil
);
2575 static char *modifier_names
[] =
2577 "up", "down", "drag", "click", 0, 0, 0, 0,
2578 0, 0, 0, 0, 0, 0, 0, 0,
2579 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
2581 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
2583 static Lisp_Object modifier_symbols
;
2585 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
2587 lispy_modifier_list (modifiers
)
2590 Lisp_Object modifier_list
;
2593 modifier_list
= Qnil
;
2594 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
2595 if (modifiers
& (1<<i
))
2596 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
2599 return modifier_list
;
2603 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
2604 where UNMODIFIED is the unmodified form of SYMBOL,
2605 MASK is the set of modifiers present in SYMBOL's name.
2606 This is similar to parse_modifiers_uncached, but uses the cache in
2607 SYMBOL's Qevent_symbol_element_mask property, and maintains the
2608 Qevent_symbol_elements property. */
2610 parse_modifiers (symbol
)
2613 Lisp_Object elements
= Fget (symbol
, Qevent_symbol_element_mask
);
2615 if (CONSP (elements
))
2620 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
2621 Lisp_Object unmodified
2622 = Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
2623 XSYMBOL (symbol
)->name
->size
- end
),
2627 if (modifiers
& ~((1<<VALBITS
) - 1))
2629 XFASTINT (mask
) = modifiers
;
2630 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
2632 /* Cache the parsing results on SYMBOL. */
2633 Fput (symbol
, Qevent_symbol_element_mask
,
2635 Fput (symbol
, Qevent_symbol_elements
,
2636 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
2638 /* Since we know that SYMBOL is modifiers applied to unmodified,
2639 it would be nice to put that in unmodified's cache.
2640 But we can't, since we're not sure that parse_modifiers is
2647 /* Apply the modifiers MODIFIERS to the symbol BASE.
2648 BASE must be unmodified.
2650 This is like apply_modifiers_uncached, but uses BASE's
2651 Qmodifier_cache property, if present. It also builds
2652 Qevent_symbol_elements properties, since it has that info anyway.
2654 apply_modifiers copies the value of BASE's Qevent_kind property to
2655 the modified symbol. */
2657 apply_modifiers (modifiers
, base
)
2661 Lisp_Object cache
, index
, entry
, new_symbol
;
2663 /* Mask out upper bits. We don't know where this value's been. */
2664 modifiers
&= (1<<VALBITS
) - 1;
2666 /* The click modifier never figures into cache indices. */
2667 cache
= Fget (base
, Qmodifier_cache
);
2668 XFASTINT (index
) = (modifiers
& ~click_modifier
);
2669 entry
= Fassq (index
, cache
);
2672 new_symbol
= XCONS (entry
)->cdr
;
2675 /* We have to create the symbol ourselves. */
2676 new_symbol
= apply_modifiers_uncached (modifiers
,
2677 XSYMBOL (base
)->name
->data
,
2678 XSYMBOL (base
)->name
->size
);
2680 /* Add the new symbol to the base's cache. */
2681 entry
= Fcons (index
, new_symbol
);
2682 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
2684 /* We have the parsing info now for free, so add it to the caches. */
2685 XFASTINT (index
) = modifiers
;
2686 Fput (new_symbol
, Qevent_symbol_element_mask
,
2687 Fcons (base
, Fcons (index
, Qnil
)));
2688 Fput (new_symbol
, Qevent_symbol_elements
,
2689 Fcons (base
, lispy_modifier_list (modifiers
)));
2692 /* Make sure this symbol is of the same kind as BASE.
2694 You'd think we could just set this once and for all when we
2695 intern the symbol above, but reorder_modifiers may call us when
2696 BASE's property isn't set right; we can't assume that just
2697 because it has a Qmodifier_cache property it must have its
2698 Qevent_kind set right as well. */
2699 if (NILP (Fget (new_symbol
, Qevent_kind
)))
2701 Lisp_Object kind
= Fget (base
, Qevent_kind
);
2704 Fput (new_symbol
, Qevent_kind
, kind
);
2711 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
2712 return a symbol with the modifiers placed in the canonical order.
2713 Canonical order is alphabetical, except for down and drag, which
2714 always come last. The 'click' modifier is never written out.
2716 Fdefine_key calls this to make sure that (for example) C-M-foo
2717 and M-C-foo end up being equivalent in the keymap. */
2720 reorder_modifiers (symbol
)
2723 /* It's hopefully okay to write the code this way, since everything
2724 will soon be in caches, and no consing will be done at all. */
2725 Lisp_Object parsed
= parse_modifiers (symbol
);
2727 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
2728 XCONS (parsed
)->car
);
2732 /* For handling events, we often want to produce a symbol whose name
2733 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
2734 to some base, like the name of a function key or mouse button.
2735 modify_event_symbol produces symbols of this sort.
2737 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
2738 is the name of the i'th symbol. TABLE_SIZE is the number of elements
2741 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
2742 persist between calls to modify_event_symbol that it can use to
2743 store a cache of the symbols it's generated for this NAME_TABLE
2746 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
2748 MODIFIERS is a set of modifier bits (as given in struct input_events)
2749 whose prefixes should be applied to the symbol name.
2751 SYMBOL_KIND is the value to be placed in the event_kind property of
2752 the returned symbol.
2754 The symbols we create are supposed to have an
2755 `event-symbol-elements' propery, which lists the modifiers present
2756 in the symbol's name. */
2759 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_table
,
2760 symbol_table
, table_size
)
2763 Lisp_Object symbol_kind
;
2765 Lisp_Object
*symbol_table
;
2770 /* Is this a request for a valid symbol? */
2771 if (symbol_num
< 0 || symbol_num
>= table_size
)
2774 /* If *symbol_table doesn't seem to be initialized properly, fix that.
2775 *symbol_table should be a lisp vector TABLE_SIZE elements long,
2776 where the Nth element is the symbol for NAME_TABLE[N], or nil if
2777 we've never used that symbol before. */
2778 if (XTYPE (*symbol_table
) != Lisp_Vector
2779 || XVECTOR (*symbol_table
)->size
!= table_size
)
2783 XFASTINT (size
) = table_size
;
2784 *symbol_table
= Fmake_vector (size
, Qnil
);
2787 slot
= & XVECTOR (*symbol_table
)->contents
[symbol_num
];
2789 /* Have we already used this symbol before? */
2792 /* No; let's create it. */
2793 if (name_table
[symbol_num
])
2794 *slot
= intern (name_table
[symbol_num
]);
2798 sprintf (buf
, "key-%d", symbol_num
);
2799 *slot
= intern (buf
);
2802 /* Fill in the cache entries for this symbol; this also
2803 builds the Qevent_symbol_elements property, which the user
2805 apply_modifiers (modifiers
& click_modifier
, *slot
);
2806 Fput (*slot
, Qevent_kind
, symbol_kind
);
2809 /* Apply modifiers to that symbol. */
2810 return apply_modifiers (modifiers
, *slot
);
2814 /* Store into *addr a value nonzero if terminal input chars are available.
2815 Serves the purpose of ioctl (0, FIONREAD, addr)
2816 but works even if FIONREAD does not exist.
2817 (In fact, this may actually read some input.) */
2820 get_input_pending (addr
)
2823 /* First of all, have we already counted some input? */
2824 *addr
= !NILP (Vquit_flag
) || readable_events ();
2826 /* If input is being read as it arrives, and we have none, there is none. */
2827 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
2830 /* Try to read some input and see how much we get. */
2832 *addr
= !NILP (Vquit_flag
) || readable_events ();
2835 /* Interface to read_avail_input, blocking SIGIO if necessary. */
2838 gobble_input (expected
)
2843 if (interrupt_input
)
2846 mask
= sigblockx (SIGIO
);
2847 read_avail_input (expected
);
2852 read_avail_input (expected
);
2858 /* Read any terminal input already buffered up by the system
2859 into the kbd_buffer, but do not wait.
2861 EXPECTED should be nonzero if the caller knows there is some input.
2863 Except on VMS, all input is read by this function.
2864 If interrupt_input is nonzero, this function MUST be called
2865 only when SIGIO is blocked.
2867 Returns the number of keyboard chars read, or -1 meaning
2868 this is a bad time to try to read input. */
2871 read_avail_input (expected
)
2874 struct input_event buf
[KBD_BUFFER_SIZE
];
2878 if (read_socket_hook
)
2879 /* No need for FIONREAD or fcntl; just say don't wait. */
2880 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
2883 unsigned char cbuf
[KBD_BUFFER_SIZE
];
2886 /* Find out how much input is available. */
2887 if (ioctl (0, FIONREAD
, &nread
) < 0)
2888 /* Formerly simply reported no input, but that sometimes led to
2889 a failure of Emacs to terminate.
2890 SIGHUP seems appropriate if we can't reach the terminal. */
2891 /* ??? Is it really right to send the signal just to this process
2892 rather than to the whole process group?
2893 Perhaps on systems with FIONREAD Emacs is alone in its group. */
2894 kill (getpid (), SIGHUP
);
2897 if (nread
> sizeof cbuf
)
2898 nread
= sizeof cbuf
;
2899 #else /* no FIONREAD */
2901 /* Read some input if available, but don't wait. */
2902 nread
= sizeof cbuf
;
2903 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
2909 /* Now read; for one reason or another, this will not block. */
2912 nread
= read (fileno (stdin
), cbuf
, nread
);
2914 /* The kernel sometimes fails to deliver SIGHUP for ptys.
2915 This looks incorrect, but it isn't, because _BSD causes
2916 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
2917 and that causes a value other than 0 when there is no input. */
2921 /* Retry the read if it is interrupted. */
2923 || ! (errno
== EAGAIN
|| errno
== EFAULT
2933 fcntl (fileno (stdin
), F_SETFL
, 0);
2935 #endif /* no FIONREAD */
2936 for (i
= 0; i
< nread
; i
++)
2938 buf
[i
].kind
= ascii_keystroke
;
2939 buf
[i
].modifiers
= 0;
2940 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
2941 buf
[i
].modifiers
= meta_modifier
;
2945 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
2947 XSET (buf
[i
].frame_or_window
, Lisp_Frame
, selected_frame
);
2949 buf
[i
].frame_or_window
= Qnil
;
2954 /* Scan the chars for C-g and store them in kbd_buffer. */
2955 for (i
= 0; i
< nread
; i
++)
2957 kbd_buffer_store_event (&buf
[i
]);
2958 /* Don't look at input that follows a C-g too closely.
2959 This reduces lossage due to autorepeat on C-g. */
2960 if (buf
[i
].kind
== ascii_keystroke
2961 && XINT(buf
[i
].code
) == quit_char
)
2967 #endif /* not VMS */
2969 #ifdef SIGIO /* for entire page */
2970 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2973 input_available_signal (signo
)
2976 /* Must preserve main program's value of errno. */
2977 int old_errno
= errno
;
2979 extern int select_alarmed
;
2983 /* USG systems forget handlers when they are used;
2984 must reestablish each time */
2985 signal (signo
, input_available_signal
);
2992 if (input_available_clear_time
)
2993 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
2998 nread
= read_avail_input (1);
2999 /* -1 means it's not ok to read the input now.
3000 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3001 0 means there was no keyboard input available. */
3006 select_alarmed
= 1; /* Force the select emulator back to life */
3017 /* Send ourselves a SIGIO.
3019 This function exists so that the UNBLOCK_INPUT macro in
3020 blockinput.h can have some way to take care of input we put off
3021 dealing with, without assuming that every file which uses
3022 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3024 reinvoke_input_signal ()
3033 /* Return the prompt-string of a sparse keymap.
3034 This is the first element which is a string.
3035 Return nil if there is none. */
3043 register Lisp_Object tem
;
3045 if (XTYPE (tem
) == Lisp_String
)
3052 static Lisp_Object
menu_bar_item ();
3053 static Lisp_Object
menu_bar_one_keymap ();
3055 /* Return a list of menu items for a menu bar, appropriate
3056 to the current buffer.
3057 The elements have the form (KEY STRING . nil). */
3062 /* The number of keymaps we're scanning right now, and the number of
3063 keymaps we have allocated space for. */
3066 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3067 in the current keymaps, or nil where it is not a prefix. */
3070 Lisp_Object def
, tem
;
3076 /* Build our list of keymaps.
3077 If we recognize a function key and replace its escape sequence in
3078 keybuf with its symbol, or if the sequence starts with a mouse
3079 click and we need to switch buffers, we jump back here to rebuild
3080 the initial keymaps from the current buffer. */
3084 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3085 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3086 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3087 #ifdef USE_TEXT_PROPERTIES
3088 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3090 maps
[nmaps
-2] = current_buffer
->local_map
;
3092 maps
[nmaps
-1] = global_map
;
3095 /* Look up in each map the dummy prefix key `menu-bar'. */
3099 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3101 if (! NILP (maps
[mapno
]))
3102 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1));
3106 tem
= Fkeymapp (def
);
3108 result
= menu_bar_one_keymap (def
, result
);
3111 return Fnreverse (result
);
3114 /* Scan one map KEYMAP, accumulating any menu items it defines
3115 that have not yet been seen in RESULT. Return the updated RESULT. */
3118 menu_bar_one_keymap (keymap
, result
)
3119 Lisp_Object keymap
, result
;
3121 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3123 /* Loop over all keymap entries that have menu strings. */
3124 for (tail
= keymap
; XTYPE (tail
) == Lisp_Cons
; tail
= XCONS (tail
)->cdr
)
3126 item
= XCONS (tail
)->car
;
3127 if (XTYPE (item
) == Lisp_Cons
)
3129 key
= XCONS (item
)->car
;
3130 binding
= XCONS (item
)->cdr
;
3131 if (XTYPE (binding
) == Lisp_Cons
)
3133 item_string
= XCONS (binding
)->car
;
3134 if (XTYPE (item_string
) == Lisp_String
)
3135 result
= menu_bar_item (key
, item_string
,
3136 Fcdr (binding
), result
);
3139 else if (XTYPE (item
) == Lisp_Vector
)
3141 /* Loop over the char values represented in the vector. */
3142 int len
= XVECTOR (item
)->size
;
3144 for (c
= 0; c
< len
; c
++)
3146 Lisp_Object character
;
3147 XFASTINT (character
) = c
;
3148 binding
= XVECTOR (item
)->contents
[c
];
3149 if (XTYPE (binding
) == Lisp_Cons
)
3151 item_string
= XCONS (binding
)->car
;
3152 if (XTYPE (item_string
) == Lisp_String
)
3153 result
= menu_bar_item (key
, item_string
,
3154 Fcdr (binding
), result
);
3164 menu_bar_item (key
, item_string
, def
, result
)
3165 Lisp_Object key
, item_string
, def
, result
;
3167 Lisp_Object tem
, elt
;
3168 Lisp_Object enabled
;
3170 /* See if this entry is enabled. */
3173 if (XTYPE (def
) == Lisp_Symbol
)
3175 /* No property, or nil, means enable.
3176 Otherwise, enable if value is not nil. */
3177 tem
= Fget (def
, Qmenu_enable
);
3179 enabled
= Feval (tem
);
3182 /* Add an entry for this key and string
3183 if there is none yet. */
3184 elt
= Fassq (key
, result
);
3185 if (!NILP (enabled
) && NILP (elt
))
3186 result
= Fcons (Fcons (key
, Fcons (item_string
, Qnil
)), result
);
3191 static int echo_flag
;
3192 static int echo_now
;
3194 /* Read a character like read_char but optionally prompt based on maps
3195 in the array MAPS. NMAPS is the length of MAPS. Return nil if we
3196 decided not to read a character, because there are no menu items in
3199 PREV_EVENT is the previous input event, or nil if we are reading
3200 the first event of a key sequence.
3202 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3203 if we used a mouse menu to read the input, or zero otherwise. If
3204 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
3206 The prompting is done based on the prompt-string of the map
3207 and the strings associated with various map elements. */
3210 read_char_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
3213 Lisp_Object prev_event
;
3214 int *used_mouse_menu
;
3217 register Lisp_Object name
;
3219 int width
= FRAME_WIDTH (selected_frame
) - 4;
3220 char *menu
= (char *) alloca (width
+ 4);
3222 Lisp_Object rest
, vector
;
3224 if (used_mouse_menu
)
3225 *used_mouse_menu
= 0;
3227 /* Use local over global Menu maps */
3229 if (! menu_prompting
)
3232 /* Get the menu name from the first map that has one (a prompt string). */
3233 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3235 name
= map_prompt (maps
[mapno
]);
3240 /* If we don't have any menus, just read a character normally. */
3244 #ifdef HAVE_X_WINDOWS
3246 /* If we got to this point via a mouse click,
3247 use a real menu for mouse selection. */
3248 if (EVENT_HAS_PARAMETERS (prev_event
))
3250 /* Display the menu and get the selection. */
3251 Lisp_Object
*realmaps
3252 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
3256 /* Use the maps that are not nil. */
3257 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3258 if (!NILP (maps
[mapno
]))
3259 realmaps
[nmaps1
++] = maps
[mapno
];
3261 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
3264 /* If we got more than one event, put all but the first
3265 onto this list to be read later.
3266 Return just the first event now. */
3267 unread_command_events
3268 = nconc2 (XCONS (value
)->cdr
, unread_command_events
);
3269 value
= XCONS (value
)->car
;
3272 XSET (value
, Lisp_Int
, quit_char
);
3273 if (used_mouse_menu
)
3274 *used_mouse_menu
= 1;
3277 #endif /* HAVE_X_MENU */
3278 #endif /* HAVE_X_WINDOWS */
3280 /* Prompt string always starts with map's prompt, and a space. */
3281 strcpy (menu
, XSTRING (name
)->data
);
3282 nlength
= XSTRING (name
)->size
;
3283 menu
[nlength
++] = ':';
3284 menu
[nlength
++] = ' ';
3287 /* Start prompting at start of first map. */
3291 /* Present the documented bindings, a line at a time. */
3299 /* Loop over elements of map. */
3304 /* If reached end of map, start at beginning of next map. */
3308 /* At end of last map, wrap around to first map if just starting,
3309 or end this line if already have something on it. */
3320 /* Look at the next element of the map. */
3322 elt
= XVECTOR (vector
)->contents
[idx
];
3324 elt
= Fcar_safe (rest
);
3326 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
3328 /* If we found a dense table in the keymap,
3329 advanced past it, but start scanning its contents. */
3330 rest
= Fcdr_safe (rest
);
3336 /* An ordinary element. */
3337 s
= Fcar_safe (Fcdr_safe (elt
));
3338 if (XTYPE (s
) != Lisp_String
)
3339 /* Ignore the element if it has no prompt string. */
3341 /* If we have room for the prompt string, add it to this line.
3342 If this is the first on the line, always add it. */
3343 else if (XSTRING (s
)->size
+ i
< width
3348 /* Punctuate between strings. */
3351 strcpy (menu
+ i
, ", ");
3356 /* Add as much of string as fits. */
3357 thiswidth
= XSTRING (s
)->size
;
3358 if (thiswidth
+ i
> width
)
3359 thiswidth
= width
- i
;
3360 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
3365 /* If this element does not fit, end the line now,
3366 and save the element for the next line. */
3367 strcpy (menu
+ i
, "...");
3371 /* Move past this element. */
3372 if (idx
>= 0 && idx
+ 1 >= XVECTOR (rest
)->size
)
3373 /* Handle reaching end of dense table. */
3378 rest
= Fcdr_safe (rest
);
3382 /* Prompt with that and read response. */
3384 obj
= read_char (1, 0, 0, Qnil
, 0);
3386 if (XTYPE (obj
) != Lisp_Int
)
3391 if (! EQ (obj
, menu_prompt_more_char
)
3392 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
3393 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
3398 /* Reading key sequences. */
3400 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
3401 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
3402 keymap, or nil otherwise. Return the index of the first keymap in
3403 which KEY has any binding, or NMAPS if no map has a binding.
3405 If KEY is a meta ASCII character, treat it like meta-prefix-char
3406 followed by the corresponding non-meta character. Keymaps in
3407 CURRENT with non-prefix bindings for meta-prefix-char become nil in
3410 When KEY is not defined in any of the keymaps, if it is an upper
3411 case letter and there are bindings for the corresponding lower-case
3412 letter, return the bindings for the lower-case letter.
3414 If KEY has no bindings in any of the CURRENT maps, NEXT is left
3417 NEXT may == CURRENT. */
3420 follow_key (key
, nmaps
, current
, defs
, next
)
3422 Lisp_Object
*current
, *defs
, *next
;
3425 int i
, first_binding
;
3427 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
3428 followed by the corresponding non-meta character. */
3429 if (XTYPE (key
) == Lisp_Int
&& (XINT (key
) & CHAR_META
))
3431 for (i
= 0; i
< nmaps
; i
++)
3432 if (! NILP (current
[i
]))
3435 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1));
3437 /* Note that since we pass the resulting bindings through
3438 get_keymap_1, non-prefix bindings for meta-prefix-char
3440 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
3446 XSET (key
, Lisp_Int
, XFASTINT (key
) & ~CHAR_META
);
3449 first_binding
= nmaps
;
3450 for (i
= nmaps
- 1; i
>= 0; i
--)
3452 if (! NILP (current
[i
]))
3454 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1));
3455 if (! NILP (defs
[i
]))
3462 /* When KEY is not defined in any of the keymaps, if it is an upper
3463 case letter and there are bindings for the corresponding
3464 lower-case letter, return the bindings for the lower-case letter. */
3465 if (first_binding
== nmaps
3466 && XTYPE (key
) == Lisp_Int
3467 && ((((XINT (key
) & 0x3ffff)
3468 < XSTRING (current_buffer
->downcase_table
)->size
)
3469 && UPPERCASEP (XINT (key
) & 0x3ffff))
3470 || (XINT (key
) & shift_modifier
)))
3472 if (XINT (key
) & shift_modifier
)
3473 XSETINT (key
, XINT (key
) & ~shift_modifier
);
3475 XSETINT (key
, DOWNCASE (XINT (key
)));
3477 first_binding
= nmaps
;
3478 for (i
= nmaps
- 1; i
>= 0; i
--)
3480 if (! NILP (current
[i
]))
3482 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1));
3483 if (! NILP (defs
[i
]))
3491 /* Given the set of bindings we've found, produce the next set of maps. */
3492 if (first_binding
< nmaps
)
3493 for (i
= 0; i
< nmaps
; i
++)
3494 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
3496 return first_binding
;
3499 /* Read a sequence of keys that ends with a non prefix character,
3500 storing it in KEYBUF, a buffer of size BUFSIZE.
3502 Return the length of the key sequence stored.
3504 Echo starting immediately unless `prompt' is 0.
3506 Where a key sequence ends depends on the currently active keymaps.
3507 These include any minor mode keymaps active in the current buffer,
3508 the current buffer's local map, and the global map.
3510 If a key sequence has no other bindings, we check Vfunction_key_map
3511 to see if some trailing subsequence might be the beginning of a
3512 function key's sequence. If so, we try to read the whole function
3513 key, and substitute its symbolic name into the key sequence.
3515 We ignore unbound `down-' mouse clicks. We turn unbound `drag-'
3516 events into similar click events, if that would make them bound.
3518 If we get a mouse click in a mode line, vertical divider, or other
3519 non-text area, we treat the click as if it were prefixed by the
3520 symbol denoting that area - `mode-line', `vertical-line', or
3523 If the sequence starts with a mouse click, we read the key sequence
3524 with respect to the buffer clicked on, not the current buffer.
3526 If the user switches frames in the midst of a key sequence, we put
3527 off the switch-frame event until later; the next call to
3528 read_char will return it. */
3531 read_key_sequence (keybuf
, bufsize
, prompt
)
3532 Lisp_Object
*keybuf
;
3536 int count
= specpdl_ptr
- specpdl
;
3538 /* How many keys there are in the current key sequence. */
3541 /* The length of the echo buffer when we started reading, and
3542 the length of this_command_keys when we started reading. */
3546 /* The number of keymaps we're scanning right now, and the number of
3547 keymaps we have allocated space for. */
3549 int nmaps_allocated
= 0;
3551 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
3552 the current keymaps. */
3555 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3556 in the current keymaps, or nil where it is not a prefix. */
3557 Lisp_Object
*submaps
;
3559 /* The index in defs[] of the first keymap that has a binding for
3560 this key sequence. In other words, the lowest i such that
3561 defs[i] is non-nil. */
3564 /* If t < mock_input, then KEYBUF[t] should be read as the next
3567 We use this to recover after recognizing a function key. Once we
3568 realize that a suffix of the current key sequence is actually a
3569 function key's escape sequence, we replace the suffix with the
3570 function key's binding from Vfunction_key_map. Now keybuf
3571 contains a new and different key sequence, so the echo area,
3572 this_command_keys, and the submaps and defs arrays are wrong. In
3573 this situation, we set mock_input to t, set t to 0, and jump to
3574 restart_sequence; the loop will read keys from keybuf up until
3575 mock_input, thus rebuilding the state; and then it will resume
3576 reading characters from the keyboard. */
3579 /* If the sequence is unbound in submaps[], then
3580 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
3581 and fkey_map is its binding.
3583 These might be > t, indicating that all function key scanning
3584 should hold off until t reaches them. We do this when we've just
3585 recognized a function key, to avoid searching for the function
3586 key's again in Vfunction_key_map. */
3587 int fkey_start
= 0, fkey_end
= 0;
3588 Lisp_Object fkey_map
= Vfunction_key_map
;
3590 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
3591 we put it off for later. While we're reading, we keep the event here. */
3592 Lisp_Object delayed_switch_frame
= Qnil
;
3595 /* If there is no function key map, turn off function key scanning. */
3596 if (NILP (Fkeymapp (Vfunction_key_map
)))
3597 fkey_start
= fkey_end
= bufsize
+ 1;
3599 last_nonmenu_event
= Qnil
;
3604 echo_prompt (prompt
);
3605 else if (cursor_in_echo_area
)
3606 /* This doesn't put in a dash if the echo buffer is empty, so
3607 you don't always see a dash hanging out in the minibuffer. */
3611 /* Record the initial state of the echo area and this_command_keys;
3612 we will need to restore them if we replay a key sequence. */
3614 echo_start
= echo_length ();
3615 keys_start
= this_command_key_count
;
3617 /* We jump here when the key sequence has been thoroughly changed, and
3618 we need to rescan it starting from the beginning. When we jump here,
3619 keybuf[0..mock_input] holds the sequence we should reread. */
3622 /* Build our list of keymaps.
3623 If we recognize a function key and replace its escape sequence in
3624 keybuf with its symbol, or if the sequence starts with a mouse
3625 click and we need to switch buffers, we jump back here to rebuild
3626 the initial keymaps from the current buffer. */
3630 nmaps
= current_minor_maps (0, &maps
) + 2;
3631 if (nmaps
> nmaps_allocated
)
3633 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
3634 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
3635 nmaps_allocated
= nmaps
;
3637 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
3638 #ifdef USE_TEXT_PROPERTIES
3639 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3641 submaps
[nmaps
-2] = current_buffer
->local_map
;
3643 submaps
[nmaps
-1] = global_map
;
3646 /* Find an accurate initial value for first_binding. */
3647 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
3648 if (! NILP (submaps
[first_binding
]))
3651 /* We jump here when a function key substitution has forced us to
3652 reprocess the current key sequence. keybuf[0..mock_input] is the
3653 sequence we want to reread. */
3656 /* These are no-ops the first time through, but if we restart, they
3657 revert the echo area and this_command_keys to their original state. */
3658 this_command_key_count
= keys_start
;
3660 echo_truncate (echo_start
);
3662 /* If the best binding for the current key sequence is a keymap,
3663 or we may be looking at a function key's escape sequence, keep
3665 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
3666 || (first_binding
>= nmaps
&& fkey_start
< t
))
3669 int used_mouse_menu
= 0;
3671 /* Where the last real key started. If we need to throw away a
3672 key that has expanded into more than one element of keybuf
3673 (say, a mouse click on the mode line which is being treated
3674 as [mode-line (mouse-...)], then we backtrack to this point
3676 int last_real_key_start
;
3678 /* These variables are analogous to echo_start and keys_start;
3679 while those allow us to restart the entire key sequence,
3680 echo_local_start and keys_local_start allow us to throw away
3682 int echo_local_start
, keys_local_start
, local_first_binding
;
3685 error ("key sequence too long");
3688 echo_local_start
= echo_length ();
3689 keys_local_start
= this_command_key_count
;
3690 local_first_binding
= first_binding
;
3693 /* These are no-ops, unless we throw away a keystroke below and
3694 jumped back up to replay_key; in that case, these restore the
3695 variables to their original state, allowing us to replay the
3698 echo_truncate (echo_local_start
);
3699 this_command_key_count
= keys_local_start
;
3700 first_binding
= local_first_binding
;
3702 /* Does mock_input indicate that we are re-reading a key sequence? */
3706 add_command_key (key
);
3710 /* If not, we should actually read a character. */
3713 last_real_key_start
= t
;
3715 key
= read_char (!prompt
, nmaps
, submaps
, last_nonmenu_event
,
3718 /* read_char returns -1 at the end of a macro.
3719 Emacs 18 handles this by returning immediately with a
3720 zero, so that's what we'll do. */
3721 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) == -1)
3729 /* Clicks in non-text areas get prefixed by the symbol
3730 in their CHAR-ADDRESS field. For example, a click on
3731 the mode line is prefixed by the symbol `mode-line'.
3733 Furthermore, key sequences beginning with mouse clicks
3734 are read using the keymaps of the buffer clicked on, not
3735 the current buffer. So we may have to switch the buffer
3737 if (EVENT_HAS_PARAMETERS (key
))
3739 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
3741 if (EQ (kind
, Qmouse_click
))
3743 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
3744 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
3746 /* Key sequences beginning with mouse clicks are
3747 read using the keymaps in the buffer clicked on,
3748 not the current buffer. If we're at the
3749 beginning of a key sequence, switch buffers. */
3751 && XTYPE (window
) == Lisp_Window
3752 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
3753 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
3755 if (XTYPE (posn
) == Lisp_Symbol
)
3757 if (t
+ 1 >= bufsize
)
3758 error ("key sequence too long");
3769 /* Arrange to go back to the original buffer once we're
3770 done reading the key sequence. Note that we can't
3771 use save_excursion_{save,restore} here, because they
3772 save point as well as the current buffer; we don't
3773 want to save point, because redisplay may change it,
3774 to accomodate a Fset_window_start or something. We
3775 don't want to do this at the top of the function,
3776 because we may get input from a subprocess which
3777 wants to change the selected window and stuff (say,
3779 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3781 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
3782 goto replay_sequence
;
3784 else if (XTYPE (posn
) == Lisp_Symbol
)
3786 if (t
+ 1 >= bufsize
)
3787 error ("key sequence too long");
3795 else if (EQ (kind
, Qswitch_frame
))
3797 /* If we're at the beginning of a key sequence, go
3798 ahead and return this event. If we're in the
3799 midst of a key sequence, delay it until the end. */
3802 delayed_switch_frame
= key
;
3808 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
3810 /* Handle menu-bar events:
3811 insert the dummy prefix char `menu-bar'. */
3812 if (EQ (posn
, Qmenu_bar
))
3814 if (t
+ 1 >= bufsize
)
3815 error ("key sequence too long");
3816 /* Run the Lucid hook. */
3817 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
3818 /* If it has changed current-menubar from previous value,
3819 really recompute the menubar from the value. */
3820 if (! NILP (Vlucid_menu_bar_dirty_flag
))
3821 call0 (Qrecompute_lucid_menubar
);
3825 goto replay_sequence
;
3831 /* We have finally decided that KEY is something we might want
3833 first_binding
= (follow_key (key
,
3834 nmaps
- first_binding
,
3835 submaps
+ first_binding
,
3836 defs
+ first_binding
,
3837 submaps
+ first_binding
)
3840 /* If KEY wasn't bound, we'll try some fallbacks. */
3841 if (first_binding
>= nmaps
)
3843 Lisp_Object head
= EVENT_HEAD (key
);
3845 if (XTYPE (head
) == Lisp_Symbol
)
3847 Lisp_Object breakdown
= parse_modifiers (head
);
3848 int modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
3850 /* We drop unbound `down-' events altogether. */
3851 if (modifiers
& down_modifier
)
3853 /* Dispose of this event by simply jumping back to
3854 replay_key, to get another event.
3856 Note that if this event came from mock input,
3857 then just jumping back to replay_key will just
3858 hand it to us again. So we have to wipe out any
3861 We could delete keybuf[t] and shift everything
3862 after that to the left by one spot, but we'd also
3863 have to fix up any variable that points into
3864 keybuf, and shifting isn't really necessary
3867 Adding prefixes for non-textual mouse clicks
3868 creates two characters of mock input, and both
3869 must be thrown away. If we're only looking at
3870 the prefix now, we can just jump back to
3871 replay_key. On the other hand, if we've already
3872 processed the prefix, and now the actual click
3873 itself is giving us trouble, then we've lost the
3874 state of the keymaps we want to backtrack to, and
3875 we need to replay the whole sequence to rebuild
3878 Beyond that, only function key expansion could
3879 create more than two keys, but that should never
3880 generate mouse events, so it's okay to zero
3881 mock_input in that case too.
3883 Isn't this just the most wonderful code ever? */
3884 if (t
== last_real_key_start
)
3891 mock_input
= last_real_key_start
;
3892 goto replay_sequence
;
3896 /* We turn unbound `drag-' events into `click-'
3897 events, if the click would be bound. */
3898 else if (modifiers
& drag_modifier
)
3900 Lisp_Object new_head
=
3901 apply_modifiers (modifiers
& ~drag_modifier
,
3902 XCONS (breakdown
)->car
);
3903 Lisp_Object new_click
=
3904 Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
3906 /* Look for a binding for this new key. follow_key
3907 promises that it didn't munge submaps the
3908 last time we called it, since key was unbound. */
3910 (follow_key (new_click
,
3911 nmaps
- local_first_binding
,
3912 submaps
+ local_first_binding
,
3913 defs
+ local_first_binding
,
3914 submaps
+ local_first_binding
)
3915 + local_first_binding
);
3917 /* If that click is bound, go for it. */
3918 if (first_binding
< nmaps
)
3920 /* Otherwise, we'll leave key set to the drag event. */
3926 /* Normally, last_nonmenu_event gets the previous key we read.
3927 But when a mouse popup menu is being used,
3928 we don't update last_nonmenu_event; it continues to hold the mouse
3929 event that preceded the first level of menu. */
3930 if (!used_mouse_menu
)
3931 last_nonmenu_event
= key
;
3933 /* If the sequence is unbound, see if we can hang a function key
3934 off the end of it. We only want to scan real keyboard input
3935 for function key sequences, so if mock_input says that we're
3936 re-reading old events, don't examine it. */
3937 if (first_binding
>= nmaps
3940 Lisp_Object fkey_next
;
3942 /* Scan from fkey_end until we find a bound suffix. */
3943 while (fkey_end
< t
)
3947 key
= keybuf
[fkey_end
++];
3948 /* Look up meta-characters by prefixing them
3949 with meta_prefix_char. I hate this. */
3950 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
3956 (fkey_map
, meta_prefix_char
, 1)),
3958 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
3961 fkey_next
= fkey_map
;
3964 get_keyelt (access_keymap (fkey_next
, key
, 1));
3966 /* If keybuf[fkey_start..fkey_end] is bound in the
3967 function key map and it's a suffix of the current
3968 sequence (i.e. fkey_end == t), replace it with
3969 the binding and restart with fkey_start at the end. */
3970 if (XTYPE (fkey_next
) == Lisp_Vector
3973 t
= fkey_start
+ XVECTOR (fkey_next
)->size
;
3975 error ("key sequence too long");
3977 bcopy (XVECTOR (fkey_next
)->contents
,
3978 keybuf
+ fkey_start
,
3979 (t
- fkey_start
) * sizeof (keybuf
[0]));
3982 fkey_start
= fkey_end
= t
;
3984 goto replay_sequence
;
3987 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
3989 /* If we no longer have a bound suffix, try a new positions for
3991 if (NILP (fkey_map
))
3993 fkey_end
= ++fkey_start
;
3994 fkey_map
= Vfunction_key_map
;
4000 read_key_sequence_cmd
= (first_binding
< nmaps
4001 ? defs
[first_binding
]
4005 unread_switch_frame
= delayed_switch_frame
;
4006 unbind_to (count
, Qnil
);
4010 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4011 "Read a sequence of keystrokes and return as a string or vector.\n\
4012 The sequence is sufficient to specify a non-prefix command in the\n\
4013 current local and global maps.\n\
4015 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
4016 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
4017 as a continuation of the previous key.\n\
4019 A C-g typed while in this function is treated like any other character,\n\
4020 and `quit-flag' is not set.\n\
4022 If the key sequence starts with a mouse click, then the sequence is read\n\
4023 using the keymaps of the buffer of the window clicked in, not the buffer\n\
4024 of the selected window as normal.\n\
4026 `read-key-sequence' drops unbound button-down events, since you normally\n\
4027 only care about the click or drag events which follow them. If a drag\n\
4028 event is unbound, but the corresponding click event would be bound,\n\
4029 `read-key-sequence' turns the drag event into a click event at the\n\
4030 drag's starting position. This means that you don't have to distinguish\n\
4031 between click and drag events unless you want to.\n\
4033 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
4034 lines separating windows, and scroll bars with imaginary keys\n\
4035 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
4037 If the user switches frames in the middle of a key sequence, the\n\
4038 frame-switch event is put off until after the current key sequence.\n\
4040 `read-key-sequence' checks `function-key-map' for function key\n\
4041 sequences, where they wouldn't conflict with ordinary bindings. See\n\
4042 `function-key-map' for more details.")
4043 (prompt
, continue_echo
)
4044 Lisp_Object prompt
, continue_echo
;
4046 Lisp_Object keybuf
[30];
4048 struct gcpro gcpro1
, gcpro2
;
4051 CHECK_STRING (prompt
, 0);
4054 bzero (keybuf
, sizeof keybuf
);
4056 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
4058 if (NILP (continue_echo
))
4059 this_command_key_count
= 0;
4061 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
4062 NILP (prompt
) ? 0 : XSTRING (prompt
)->data
);
4065 return make_event_array (i
, keybuf
);
4068 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
4069 "Execute CMD as an editor command.\n\
4070 CMD must be a symbol that satisfies the `commandp' predicate.\n\
4071 Optional second arg RECORD-FLAG non-nil\n\
4072 means unconditionally put this command in `command-history'.\n\
4073 Otherwise, that is done only if an arg is read using the minibuffer.")
4075 Lisp_Object cmd
, record
;
4077 register Lisp_Object final
;
4078 register Lisp_Object tem
;
4079 Lisp_Object prefixarg
;
4080 struct backtrace backtrace
;
4081 extern int debug_on_next_call
;
4083 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
4084 Vcurrent_prefix_arg
= prefixarg
;
4085 debug_on_next_call
= 0;
4087 if (XTYPE (cmd
) == Lisp_Symbol
)
4089 tem
= Fget (cmd
, Qdisabled
);
4091 return call1 (Vrun_hooks
, Vdisabled_command_hook
);
4096 final
= Findirect_function (cmd
);
4098 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
4099 do_autoload (final
, cmd
);
4104 if (XTYPE (final
) == Lisp_String
4105 || XTYPE (final
) == Lisp_Vector
)
4107 /* If requested, place the macro in the command history. For
4108 other sorts of commands, call-interactively takes care of
4112 = Fcons (Fcons (Qexecute_kbd_macro
,
4113 Fcons (final
, Fcons (prefixarg
, Qnil
))),
4116 return Fexecute_kbd_macro (final
, prefixarg
);
4118 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
4119 || XTYPE (final
) == Lisp_Compiled
)
4121 backtrace
.next
= backtrace_list
;
4122 backtrace_list
= &backtrace
;
4123 backtrace
.function
= &Qcall_interactively
;
4124 backtrace
.args
= &cmd
;
4125 backtrace
.nargs
= 1;
4126 backtrace
.evalargs
= 0;
4128 tem
= Fcall_interactively (cmd
, record
);
4130 backtrace_list
= backtrace
.next
;
4136 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
4138 "Read function name, then read its arguments and call it.")
4140 Lisp_Object prefixarg
;
4142 Lisp_Object function
;
4144 Lisp_Object saved_keys
;
4145 struct gcpro gcpro1
;
4147 saved_keys
= Fthis_command_keys ();
4149 GCPRO1 (saved_keys
);
4151 if (EQ (prefixarg
, Qminus
))
4153 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
4154 strcpy (buf
, "C-u ");
4155 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
4156 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
4157 else if (XTYPE (prefixarg
) == Lisp_Int
)
4158 sprintf (buf
, "%d ", XINT (prefixarg
));
4160 /* This isn't strictly correct if execute-extended-command
4161 is bound to anything else. Perhaps it should use
4162 this_command_keys? */
4163 strcat (buf
, "M-x ");
4165 /* Prompt with buf, and then read a string, completing from and
4166 restricting to the set of all defined commands. Don't provide
4167 any initial input. The last Qnil says not to perform a
4168 peculiar hack on the initial input. */
4169 function
= Fcompleting_read (build_string (buf
),
4170 Vobarray
, Qcommandp
,
4173 /* Set this_command_keys to the concatenation of saved_keys and
4174 function, followed by a RET. */
4176 struct Lisp_String
*str
;
4180 this_command_key_count
= 0;
4182 str
= XSTRING (saved_keys
);
4183 for (i
= 0; i
< str
->size
; i
++)
4185 XFASTINT (tem
) = str
->data
[i
];
4186 add_command_key (tem
);
4189 str
= XSTRING (function
);
4190 for (i
= 0; i
< str
->size
; i
++)
4192 XFASTINT (tem
) = str
->data
[i
];
4193 add_command_key (tem
);
4196 XFASTINT (tem
) = '\015';
4197 add_command_key (tem
);
4202 function
= Fintern (function
, Qnil
);
4203 Vprefix_arg
= prefixarg
;
4204 this_command
= function
;
4206 return Fcommand_execute (function
, Qt
);
4210 detect_input_pending ()
4213 get_input_pending (&input_pending
);
4215 return input_pending
;
4218 /* This is called in some cases before a possible quit.
4219 It cases the next call to detect_input_pending to recompute input_pending.
4220 So calling this function unnecessarily can't do any harm. */
4221 clear_input_pending ()
4226 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
4227 "T if command input is currently available with no waiting.\n\
4228 Actually, the value is nil only if we can be sure that no input is available.")
4231 if (!NILP (unread_command_events
) || unread_command_char
!= -1)
4234 return detect_input_pending () ? Qt
: Qnil
;
4237 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
4238 "Return vector of last 100 events, not counting those from keyboard macros.")
4241 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
4244 if (total_keys
< NUM_RECENT_KEYS
)
4245 return Fvector (total_keys
, keys
);
4248 val
= Fvector (NUM_RECENT_KEYS
, keys
);
4249 bcopy (keys
+ recent_keys_index
,
4250 XVECTOR (val
)->contents
,
4251 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
4253 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
4254 recent_keys_index
* sizeof (Lisp_Object
));
4259 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
4260 "Return the key sequence that invoked this command.\n\
4261 The value is a string or a vector.")
4264 return make_event_array (this_command_key_count
,
4265 XVECTOR (this_command_keys
)->contents
);
4268 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
4269 "Return the current depth in recursive edits.")
4273 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
4277 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
4278 "FOpen dribble file: ",
4279 "Start writing all keyboard characters to a dribble file called FILE.\n\
4280 If FILE is nil, close any open dribble file.")
4291 file
= Fexpand_file_name (file
, Qnil
);
4292 dribble
= fopen (XSTRING (file
)->data
, "w");
4297 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
4298 "Discard the contents of the terminal input buffer.\n\
4299 Also cancel any kbd macro being defined.")
4302 defining_kbd_macro
= 0;
4303 update_mode_lines
++;
4305 unread_command_events
= Qnil
;
4306 unread_command_char
= -1;
4308 discard_tty_input ();
4310 /* Without the cast, GCC complains that this assignment loses the
4311 volatile qualifier of kbd_store_ptr. Is there anything wrong
4313 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
4314 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
4320 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
4321 "Stop Emacs and return to superior process. You can resume later.\n\
4322 On systems that don't have job control, run a subshell instead.\n\n\
4323 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
4324 to be read as terminal input by Emacs's parent, after suspension.\n\
4326 Before suspending, call the functions in `suspend-hook' with no args.\n\
4327 If any of them returns nil, don't call the rest and don't suspend.\n\
4328 Otherwise, suspend normally and after resumption run the normal hook\n\
4329 `suspend-resume-hook' if that is bound and non-nil.\n\
4331 Some operating systems cannot stop the Emacs process and resume it later.\n\
4332 On such systems, Emacs starts a subshell instead of suspending.")
4334 Lisp_Object stuffstring
;
4337 int count
= specpdl_ptr
- specpdl
;
4338 int old_height
, old_width
;
4340 struct gcpro gcpro1
, gcpro2
;
4341 extern init_sys_modes ();
4343 if (!NILP (stuffstring
))
4344 CHECK_STRING (stuffstring
, 0);
4346 /* Run the functions in suspend-hook. */
4347 if (!NILP (Vrun_hooks
))
4348 call1 (Vrun_hooks
, intern ("suspend-hook"));
4350 GCPRO1 (stuffstring
);
4351 get_frame_size (&old_width
, &old_height
);
4353 /* sys_suspend can get an error if it tries to fork a subshell
4354 and the system resources aren't available for that. */
4355 record_unwind_protect (init_sys_modes
, 0);
4356 stuff_buffered_input (stuffstring
);
4358 unbind_to (count
, Qnil
);
4360 /* Check if terminal/window size has changed.
4361 Note that this is not useful when we are running directly
4362 with a window system; but suspend should be disabled in that case. */
4363 get_frame_size (&width
, &height
);
4364 if (width
!= old_width
|| height
!= old_height
)
4365 change_frame_size (0, height
, width
, 0, 0);
4367 /* Run suspend-resume-hook. */
4368 if (!NILP (Vrun_hooks
))
4369 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
4375 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
4376 Then in any case stuff anthing Emacs has read ahead and not used. */
4378 stuff_buffered_input (stuffstring
)
4379 Lisp_Object stuffstring
;
4381 register unsigned char *p
;
4383 /* stuff_char works only in BSD, versions 4.2 and up. */
4386 if (XTYPE (stuffstring
) == Lisp_String
)
4390 p
= XSTRING (stuffstring
)->data
;
4391 count
= XSTRING (stuffstring
)->size
;
4396 /* Anything we have read ahead, put back for the shell to read. */
4397 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4399 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4400 kbd_fetch_ptr
= kbd_buffer
;
4401 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
4402 stuff_char (XINT (kbd_fetch_ptr
->code
));
4403 kbd_fetch_ptr
->kind
= no_event
;
4404 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
4411 #endif /* BSD and not BSD4_1 */
4414 set_waiting_for_input (time_to_clear
)
4415 EMACS_TIME
*time_to_clear
;
4417 input_available_clear_time
= time_to_clear
;
4419 /* Tell interrupt_signal to throw back to read_char, */
4420 waiting_for_input
= 1;
4422 /* If interrupt_signal was called before and buffered a C-g,
4423 make it run again now, to avoid timing error. */
4424 if (!NILP (Vquit_flag
))
4425 quit_throw_to_read_char ();
4427 /* If alarm has gone off already, echo now. */
4435 clear_waiting_for_input ()
4437 /* Tell interrupt_signal not to throw back to read_char, */
4438 waiting_for_input
= 0;
4439 input_available_clear_time
= 0;
4442 /* This routine is called at interrupt level in response to C-G.
4443 If interrupt_input, this is the handler for SIGINT.
4444 Otherwise, it is called from kbd_buffer_store_event,
4445 in handling SIGIO or SIGTINT.
4447 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
4448 immediately throw back to read_char.
4450 Otherwise it sets the Lisp variable quit-flag not-nil.
4451 This causes eval to throw, when it gets a chance.
4452 If quit-flag is already non-nil, it stops the job right away. */
4458 /* Must preserve main program's value of errno. */
4459 int old_errno
= errno
;
4462 /* USG systems forget handlers when they are used;
4463 must reestablish each time */
4464 signal (SIGINT
, interrupt_signal
);
4465 signal (SIGQUIT
, interrupt_signal
);
4470 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
4475 #ifdef SIGTSTP /* Support possible in later USG versions */
4477 * On systems which can suspend the current process and return to the original
4478 * shell, this command causes the user to end up back at the shell.
4479 * The "Auto-save" and "Abort" questions are not asked until
4480 * the user elects to return to emacs, at which point he can save the current
4481 * job and either dump core or continue.
4486 if (sys_suspend () == -1)
4488 printf ("Not running as a subprocess;\n");
4489 printf ("you can continue or abort.\n");
4492 /* Perhaps should really fork an inferior shell?
4493 But that would not provide any way to get back
4494 to the original shell, ever. */
4495 printf ("No support for stopping a process on this operating system;\n");
4496 printf ("you can continue or abort.\n");
4497 #endif /* not VMS */
4498 #endif /* not SIGTSTP */
4499 printf ("Auto-save? (y or n) ");
4501 if (((c
= getchar ()) & ~040) == 'Y')
4502 Fdo_auto_save (Qnil
, Qnil
);
4503 while (c
!= '\n') c
= getchar ();
4505 printf ("Abort (and enter debugger)? (y or n) ");
4507 printf ("Abort (and dump core)? (y or n) ");
4508 #endif /* not VMS */
4510 if (((c
= getchar ()) & ~040) == 'Y')
4512 while (c
!= '\n') c
= getchar ();
4513 printf ("Continuing...\n");
4519 /* If executing a function that wants to be interrupted out of
4520 and the user has not deferred quitting by binding `inhibit-quit'
4521 then quit right away. */
4522 if (immediate_quit
&& NILP (Vinhibit_quit
))
4526 Fsignal (Qquit
, Qnil
);
4529 /* Else request quit when it's safe */
4533 if (waiting_for_input
&& !echoing
)
4534 quit_throw_to_read_char ();
4539 /* Handle a C-g by making read_char return C-g. */
4541 quit_throw_to_read_char ()
4543 quit_error_check ();
4545 /* Prevent another signal from doing this before we finish. */
4546 clear_waiting_for_input ();
4549 unread_command_events
= Qnil
;
4550 unread_command_char
= -1;
4552 #ifdef POLL_FOR_INPUT
4553 /* May be > 1 if in recursive minibuffer. */
4554 if (poll_suppress_count
== 0)
4558 _longjmp (getcjmp
, 1);
4561 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
4562 "Set mode of reading keyboard input.\n\
4563 First arg INTERRUPT non-nil means use input interrupts;\n\
4564 nil means use CBREAK mode.\n\
4565 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
4566 (no effect except in CBREAK mode).\n\
4567 Third arg META t means accept 8-bit input (for a Meta key).\n\
4568 META nil means ignore the top bit, on the assumption it is parity.\n\
4569 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
4570 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
4571 See also `current-input-mode'.")
4572 (interrupt
, flow
, meta
, quit
)
4573 Lisp_Object interrupt
, flow
, meta
, quit
;
4576 && (XTYPE (quit
) != Lisp_Int
4577 || XINT (quit
) < 0 || XINT (quit
) > 0400))
4578 error ("set-input-mode: QUIT must be an ASCII character.");
4582 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4583 #ifdef NO_SOCK_SIGIO
4584 if (read_socket_hook
)
4585 interrupt_input
= 0; /* No interrupts if reading from a socket. */
4587 #endif /* NO_SOCK_SIGIO */
4588 interrupt_input
= !NILP (interrupt
);
4589 #else /* not SIGIO */
4590 interrupt_input
= 0;
4591 #endif /* not SIGIO */
4592 /* Our VMS input only works by interrupts, as of now. */
4594 interrupt_input
= 1;
4596 flow_control
= !NILP (flow
);
4599 else if (EQ (meta
, Qt
))
4604 /* Don't let this value be out of range. */
4605 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
4611 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
4612 "Return information about the way Emacs currently reads keyboard input.\n\
4613 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
4614 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
4615 nil, Emacs is using CBREAK mode.\n\
4616 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
4617 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
4618 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
4619 META nil means ignoring the top bit, on the assumption it is parity.\n\
4620 META is neither t nor nil if accepting 8-bit input and using\n\
4621 all 8 bits as the character code.\n\
4622 QUIT is the character Emacs currently uses to quit.\n\
4623 The elements of this list correspond to the arguments of\n\
4629 val
[0] = interrupt_input
? Qt
: Qnil
;
4630 val
[1] = flow_control
? Qt
: Qnil
;
4631 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
4632 XFASTINT (val
[3]) = quit_char
;
4634 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
4640 /* This is correct before outermost invocation of the editor loop */
4641 command_loop_level
= -1;
4643 quit_char
= Ctl ('g');
4644 unread_command_events
= Qnil
;
4645 unread_command_char
= -1;
4647 recent_keys_index
= 0;
4648 kbd_fetch_ptr
= kbd_buffer
;
4649 kbd_store_ptr
= kbd_buffer
;
4650 do_mouse_tracking
= 0;
4654 /* This means that command_loop_1 won't try to select anything the first
4656 internal_last_event_frame
= Qnil
;
4657 Vlast_event_frame
= internal_last_event_frame
;
4660 /* If we're running a dumped Emacs, we need to clear out
4661 kbd_buffer_frame_or_window, in case some events got into it
4664 If we're running an undumped Emacs, it hasn't been initialized by
4665 syms_of_keyboard yet. */
4667 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
4669 if (!noninteractive
)
4671 signal (SIGINT
, interrupt_signal
);
4672 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
4673 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
4674 SIGQUIT and we can't tell which one it will give us. */
4675 signal (SIGQUIT
, interrupt_signal
);
4676 #endif /* HAVE_TERMIO */
4677 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4679 signal (SIGIO
, input_available_signal
);
4683 /* Use interrupt input by default, if it works and noninterrupt input
4684 has deficiencies. */
4686 #ifdef INTERRUPT_INPUT
4687 interrupt_input
= 1;
4689 interrupt_input
= 0;
4692 /* Our VMS input only works by interrupts, as of now. */
4694 interrupt_input
= 1;
4700 if (keyboard_init_hook
)
4701 (*keyboard_init_hook
) ();
4703 #ifdef POLL_FOR_INPUT
4704 poll_suppress_count
= 1;
4709 /* This type's only use is in syms_of_keyboard, to initialize the
4710 event header symbols and put properties on them. */
4717 struct event_head head_table
[] = {
4718 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
4719 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
4720 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
4725 Qself_insert_command
= intern ("self-insert-command");
4726 staticpro (&Qself_insert_command
);
4728 Qforward_char
= intern ("forward-char");
4729 staticpro (&Qforward_char
);
4731 Qbackward_char
= intern ("backward-char");
4732 staticpro (&Qbackward_char
);
4734 Qdisabled
= intern ("disabled");
4735 staticpro (&Qdisabled
);
4737 Qpre_command_hook
= intern ("pre-command-hook");
4738 staticpro (&Qpre_command_hook
);
4740 Qpost_command_hook
= intern ("post-command-hook");
4741 staticpro (&Qpost_command_hook
);
4743 Qfunction_key
= intern ("function-key");
4744 staticpro (&Qfunction_key
);
4745 Qmouse_click
= intern ("mouse-click");
4746 staticpro (&Qmouse_click
);
4748 Qmenu_enable
= intern ("menu-enable");
4749 staticpro (&Qmenu_enable
);
4751 Qmode_line
= intern ("mode-line");
4752 staticpro (&Qmode_line
);
4753 Qvertical_line
= intern ("vertical-line");
4754 staticpro (&Qvertical_line
);
4755 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
4756 staticpro (&Qvertical_scroll_bar
);
4757 Qmenu_bar
= intern ("menu-bar");
4758 staticpro (&Qmenu_bar
);
4760 Qabove_handle
= intern ("above-handle");
4761 staticpro (&Qabove_handle
);
4762 Qhandle
= intern ("handle");
4763 staticpro (&Qhandle
);
4764 Qbelow_handle
= intern ("below-handle");
4765 staticpro (&Qbelow_handle
);
4767 Qevent_kind
= intern ("event-kind");
4768 staticpro (&Qevent_kind
);
4769 Qevent_symbol_elements
= intern ("event-symbol-elements");
4770 staticpro (&Qevent_symbol_elements
);
4771 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
4772 staticpro (&Qevent_symbol_element_mask
);
4773 Qmodifier_cache
= intern ("modifier-cache");
4774 staticpro (&Qmodifier_cache
);
4776 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
4777 staticpro (&Qrecompute_lucid_menubar
);
4778 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
4779 staticpro (&Qactivate_menubar_hook
);
4782 struct event_head
*p
;
4784 for (p
= head_table
;
4785 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
4788 *p
->var
= intern (p
->name
);
4790 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
4791 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
4795 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
4796 staticpro (&button_down_location
);
4800 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
4802 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
4803 for (i
= 0; i
< len
; i
++)
4804 if (modifier_names
[i
])
4805 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
4806 staticpro (&modifier_symbols
);
4809 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
4810 staticpro (&recent_keys
);
4812 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
4813 staticpro (&this_command_keys
);
4815 kbd_buffer_frame_or_window
4816 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
4817 staticpro (&kbd_buffer_frame_or_window
);
4819 func_key_syms
= Qnil
;
4820 staticpro (&func_key_syms
);
4823 staticpro (&mouse_syms
);
4825 unread_switch_frame
= Qnil
;
4826 staticpro (&unread_switch_frame
);
4828 defsubr (&Sread_key_sequence
);
4829 defsubr (&Srecursive_edit
);
4830 defsubr (&Strack_mouse
);
4831 defsubr (&Sinput_pending_p
);
4832 defsubr (&Scommand_execute
);
4833 defsubr (&Srecent_keys
);
4834 defsubr (&Sthis_command_keys
);
4835 defsubr (&Ssuspend_emacs
);
4836 defsubr (&Sabort_recursive_edit
);
4837 defsubr (&Sexit_recursive_edit
);
4838 defsubr (&Srecursion_depth
);
4839 defsubr (&Stop_level
);
4840 defsubr (&Sdiscard_input
);
4841 defsubr (&Sopen_dribble_file
);
4842 defsubr (&Sset_input_mode
);
4843 defsubr (&Scurrent_input_mode
);
4844 defsubr (&Sexecute_extended_command
);
4846 DEFVAR_LISP ("disabled-command-hook", &Vdisabled_command_hook
,
4847 "Value is called instead of any command that is disabled\n\
4848 \(has a non-nil `disabled' property).");
4850 DEFVAR_LISP ("last-command-char", &last_command_char
,
4851 "Last input event that was part of a command.");
4853 DEFVAR_LISP ("last-command-event", &last_command_char
,
4854 "Last input event that was part of a command.");
4856 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
4857 "Last input event in a command, except for mouse menu events.\n\
4858 Mouse menus give back keys that don't look like mouse events;\n\
4859 this variable holds the actual mouse event that led to the menu,\n\
4860 so that you can determine whether the command was run by mouse or not.");
4862 DEFVAR_LISP ("last-input-char", &last_input_char
,
4863 "Last input event.");
4865 DEFVAR_LISP ("last-input-event", &last_input_char
,
4866 "Last input event.");
4868 DEFVAR_LISP ("unread-command-events", &unread_command_events
,
4869 "List of objects to be read as next command input events.");
4871 DEFVAR_INT ("unread-command-char", &unread_command_char
,
4872 "If not -1, an object to be read as next command input event.");
4874 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
4875 "Meta-prefix character code. Meta-foo as command input\n\
4876 turns into this character followed by foo.");
4877 XSET (meta_prefix_char
, Lisp_Int
, 033);
4879 DEFVAR_LISP ("last-command", &last_command
,
4880 "The last command executed. Normally a symbol with a function definition,\n\
4881 but can be whatever was found in the keymap, or whatever the variable\n\
4882 `this-command' was set to by that command.");
4883 last_command
= Qnil
;
4885 DEFVAR_LISP ("this-command", &this_command
,
4886 "The command now being executed.\n\
4887 The command can set this variable; whatever is put here\n\
4888 will be in `last-command' during the following command.");
4889 this_command
= Qnil
;
4891 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
4892 "*Number of keyboard input characters between auto-saves.\n\
4893 Zero means disable autosaving due to number of characters typed.");
4894 auto_save_interval
= 300;
4896 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
4897 "*Number of seconds idle time before auto-save.\n\
4898 Zero or nil means disable auto-saving due to idleness.\n\
4899 After auto-saving due to this many seconds of idle time,\n\
4900 Emacs also does a garbage collection if that seems to be warranted.");
4901 XFASTINT (Vauto_save_timeout
) = 30;
4903 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
4904 "*Nonzero means echo unfinished commands after this many seconds of pause.");
4905 echo_keystrokes
= 1;
4907 DEFVAR_INT ("polling-period", &polling_period
,
4908 "*Interval between polling for input during Lisp execution.\n\
4909 The reason for polling is to make C-g work to stop a running program.\n\
4910 Polling is needed only when using X windows and SIGIO does not work.\n\
4911 Polling is automatically disabled in all other cases.");
4914 DEFVAR_INT ("num-input-keys", &num_input_keys
,
4915 "*Number of complete keys read from the keyboard so far.");
4919 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
4920 "*The frame in which the most recently read event occurred.\n\
4921 If the last event came from a keyboard macro, this is set to `macro'.");
4922 Vlast_event_frame
= Qnil
;
4925 DEFVAR_LISP ("help-char", &help_char
,
4926 "Character to recognize as meaning Help.\n\
4927 When it is read, do `(eval help-form)', and display result if it's a string.\n\
4928 If the value of `help-form' is nil, this char can be read normally.");
4929 XSET (help_char
, Lisp_Int
, Ctl ('H'));
4931 DEFVAR_LISP ("help-form", &Vhelp_form
,
4932 "Form to execute when character help-char is read.\n\
4933 If the form returns a string, that string is displayed.\n\
4934 If `help-form' is nil, the help char is not recognized.");
4937 DEFVAR_LISP ("top-level", &Vtop_level
,
4938 "Form to evaluate when Emacs starts up.\n\
4939 Useful to set before you dump a modified Emacs.");
4942 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
4943 "String used as translate table for keyboard input, or nil.\n\
4944 Each character is looked up in this string and the contents used instead.\n\
4945 If string is of length N, character codes N and up are untranslated.");
4946 Vkeyboard_translate_table
= Qnil
;
4948 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
4949 "Non-nil means prompt with menus when appropriate.\n\
4950 This is done when reading from a keymap that has a prompt string,\n\
4951 for elements that have prompt strings.\n\
4952 The menu is displayed on the screen\n\
4953 if X menus were enabled at configuration\n\
4954 time and the previous event was a mouse click prefix key.\n\
4955 Otherwise, menu prompting uses the echo area.");
4958 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
4959 "Character to see next line of menu prompt.\n\
4960 Type this character while in a menu prompt to rotate around the lines of it.");
4961 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
4963 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
4964 "A mask of additional modifier keys to use with every keyboard character.\n\
4965 Emacs applies the modifiers of the character stored here to each keyboard\n\
4966 character it reads. For example, after evaluating the expression\n\
4967 (setq extra-keyboard-modifiers ?\C-x)\n\
4968 all input characters will have the control modifier applied to them.\n\
4970 Note that the character ?\C-@, equivalent to the integer zero, does\n\
4971 not count as a control character; rather, it counts as a character\n\
4972 with no modifiers; thus, setting extra_keyboard_modifiers to zero\n\
4973 cancels any modification.");
4974 extra_keyboard_modifiers
= 0;
4976 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
4977 "If an editing command sets this to t, deactivate the mark afterward.\n\
4978 The command loop sets this to nil before each command,\n\
4979 and tests the value when the command returns.\n\
4980 Buffer modification stores t in this variable.");
4981 Vdeactivate_mark
= Qnil
;
4983 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
4984 "Normal hook run before each command is executed.");
4985 Vpre_command_hook
= Qnil
;
4987 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
4988 "Normal hook run before each command is executed.");
4989 Vpost_command_hook
= Qnil
;
4991 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
4992 "t means menu bar, specified Lucid style, needs to be recomputed.");
4993 Vlucid_menu_bar_dirty_flag
= Qnil
;
4998 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
4999 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
5000 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
5001 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
5002 initial_define_key (meta_map
, 'x', "execute-extended-command");