1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94,95 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"
48 #include <sys/ioctl.h>
50 #endif /* not MSDOS */
52 #include "syssignal.h"
55 /* This is to get the definitions of the XK_ symbols. */
60 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
65 /* Variables for blockinput.h: */
67 /* Non-zero if interrupt input is blocked right now. */
68 int interrupt_input_blocked
;
70 /* Nonzero means an input interrupt has arrived
71 during the current critical section. */
72 int interrupt_input_pending
;
75 /* File descriptor to use for input. */
79 /* Make all keyboard buffers much bigger when using X windows. */
80 #define KBD_BUFFER_SIZE 4096
81 #else /* No X-windows, character input */
82 #define KBD_BUFFER_SIZE 256
83 #endif /* No X-windows */
85 /* Following definition copied from eval.c */
89 struct backtrace
*next
;
90 Lisp_Object
*function
;
91 Lisp_Object
*args
; /* Points to vector of args. */
92 int nargs
; /* length of vector. If nargs is UNEVALLED,
93 args points to slot holding list of
100 /* Non-nil disable property on a command means
101 do not execute it; call disabled-command-hook's value instead. */
102 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
104 #define NUM_RECENT_KEYS (100)
105 int recent_keys_index
; /* Index for storing next element into recent_keys */
106 int total_keys
; /* Total number of elements stored into recent_keys */
107 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
109 /* Vector holding the key sequence that invoked the current command.
110 It is reused for each command, and it may be longer than the current
111 sequence; this_command_key_count indicates how many elements
112 actually mean something.
113 It's easier to staticpro a single Lisp_Object than an array. */
114 Lisp_Object this_command_keys
;
115 int this_command_key_count
;
117 extern int minbuf_level
;
119 extern struct backtrace
*backtrace_list
;
121 /* Nonzero means do menu prompting. */
122 static int menu_prompting
;
124 /* Character to see next line of menu prompt. */
125 static Lisp_Object menu_prompt_more_char
;
127 /* For longjmp to where kbd input is being done. */
128 static jmp_buf getcjmp
;
130 /* True while doing kbd input. */
131 int waiting_for_input
;
133 /* True while displaying for echoing. Delays C-g throwing. */
136 /* Nonzero means disregard local maps for the menu bar. */
137 static int inhibit_local_menu_bar_menus
;
139 /* Nonzero means C-g should cause immediate error-signal. */
142 /* Character to recognize as the help char. */
143 Lisp_Object Vhelp_char
;
145 /* Form to execute when help char is typed. */
146 Lisp_Object Vhelp_form
;
148 /* Command to run when the help character follows a prefix key. */
149 Lisp_Object Vprefix_help_command
;
151 /* List of items that should move to the end of the menu bar. */
152 Lisp_Object Vmenu_bar_final_items
;
154 /* Character that causes a quit. Normally C-g.
156 If we are running on an ordinary terminal, this must be an ordinary
157 ASCII char, since we want to make it our interrupt character.
159 If we are not running on an ordinary terminal, it still needs to be
160 an ordinary ASCII char. This character needs to be recognized in
161 the input interrupt handler. At this point, the keystroke is
162 represented as a struct input_event, while the desired quit
163 character is specified as a lispy event. The mapping from struct
164 input_events to lispy events cannot run in an interrupt handler,
165 and the reverse mapping is difficult for anything but ASCII
168 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
172 extern Lisp_Object current_global_map
;
173 extern int minibuf_level
;
175 /* If non-nil, this is a map that overrides all other local maps. */
176 Lisp_Object Voverriding_local_map
;
178 /* If non-nil, Voverriding_local_map applies to the menu bar. */
179 Lisp_Object Voverriding_local_map_menu_flag
;
181 /* Current depth in recursive edits. */
182 int command_loop_level
;
184 /* Total number of times command_loop has read a key sequence. */
187 /* Last input character read as a command. */
188 Lisp_Object last_command_char
;
190 /* Last input character read as a command, not counting menus
191 reached by the mouse. */
192 Lisp_Object last_nonmenu_event
;
194 /* Last input character read for any purpose. */
195 Lisp_Object last_input_char
;
197 /* If not Qnil, a list of objects to be read as subsequent command input. */
198 Lisp_Object Vunread_command_events
;
200 /* If not -1, an event to be read as subsequent command input. */
201 int unread_command_char
;
203 /* If not Qnil, this is a switch-frame event which we decided to put
204 off until the end of a key sequence. This should be read as the
205 next command input, after any unread_command_events.
207 read_key_sequence uses this to delay switch-frame events until the
208 end of the key sequence; Fread_char uses it to put off switch-frame
209 events until a non-ASCII event is acceptable as input. */
210 Lisp_Object unread_switch_frame
;
212 /* A mask of extra modifier bits to put into every keyboard char. */
213 int extra_keyboard_modifiers
;
215 /* Char to use as prefix when a meta character is typed in.
216 This is bound on entry to minibuffer in case ESC is changed there. */
218 Lisp_Object meta_prefix_char
;
220 /* Last size recorded for a current buffer which is not a minibuffer. */
221 static int last_non_minibuf_size
;
223 /* Number of idle seconds before an auto-save and garbage collection. */
224 static Lisp_Object Vauto_save_timeout
;
226 /* Total number of times read_char has returned. */
229 /* Total number of times read_char has returned, outside of macros. */
230 int num_nonmacro_input_chars
;
232 /* Auto-save automatically when this many characters have been typed
233 since the last time. */
235 static int auto_save_interval
;
237 /* Value of num_nonmacro_input_chars as of last auto save. */
241 /* Last command executed by the editor command loop, not counting
242 commands that set the prefix argument. */
244 Lisp_Object last_command
;
246 /* The command being executed by the command loop.
247 Commands may set this, and the value set will be copied into last_command
248 instead of the actual command. */
249 Lisp_Object this_command
;
251 /* The value of point when the last command was executed. */
252 int last_point_position
;
254 /* The buffer that was current when the last command was started. */
255 Lisp_Object last_point_position_buffer
;
258 /* The frame in which the last input event occurred, or Qmacro if the
259 last event came from a macro. We use this to determine when to
260 generate switch-frame events. This may be cleared by functions
261 like Fselect_frame, to make sure that a switch-frame event is
262 generated by the next character. */
263 Lisp_Object internal_last_event_frame
;
266 /* A user-visible version of the above, intended to allow users to
267 figure out where the last event came from, if the event doesn't
268 carry that information itself (i.e. if it was a character). */
269 Lisp_Object Vlast_event_frame
;
271 /* The timestamp of the last input event we received from the X server.
272 X Windows wants this for selection ownership. */
273 unsigned long last_event_timestamp
;
275 Lisp_Object Qself_insert_command
;
276 Lisp_Object Qforward_char
;
277 Lisp_Object Qbackward_char
;
278 Lisp_Object Qundefined
;
280 /* read_key_sequence stores here the command definition of the
281 key sequence that it reads. */
282 Lisp_Object read_key_sequence_cmd
;
284 /* Form to evaluate (if non-nil) when Emacs is started. */
285 Lisp_Object Vtop_level
;
287 /* User-supplied string to translate input characters through. */
288 Lisp_Object Vkeyboard_translate_table
;
290 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
291 extern Lisp_Object Vfunction_key_map
;
293 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
294 Lisp_Object Vkey_translation_map
;
296 /* Non-nil means deactivate the mark at end of this command. */
297 Lisp_Object Vdeactivate_mark
;
299 /* Menu bar specified in Lucid Emacs fashion. */
301 Lisp_Object Vlucid_menu_bar_dirty_flag
;
302 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
304 /* Hooks to run before and after each command. */
305 Lisp_Object Qpre_command_hook
, Qpost_command_hook
;
306 Lisp_Object Vpre_command_hook
, Vpost_command_hook
;
307 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
309 /* List of deferred actions to be performed at a later time.
310 The precise format isn't relevant here; we just check whether it is nil. */
311 Lisp_Object Vdeferred_action_list
;
313 /* Function to call to handle deferred actions, when there are any. */
314 Lisp_Object Vdeferred_action_function
;
315 Lisp_Object Qdeferred_action_function
;
317 /* File in which we write all commands we read. */
320 /* Nonzero if input is available. */
323 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
324 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
328 extern char *pending_malloc_warning
;
330 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
332 The interrupt-level event handlers will never enqueue an event on a
333 frame which is not in Vframe_list, and once an event is dequeued,
334 internal_last_event_frame or the event itself points to the frame.
337 But while the event is sitting in the queue, it's completely
338 unprotected. Suppose the user types one command which will run for
339 a while and then delete a frame, and then types another event at
340 the frame that will be deleted, before the command gets around to
341 it. Suppose there are no references to this frame elsewhere in
342 Emacs, and a GC occurs before the second event is dequeued. Now we
343 have an event referring to a freed frame, which will crash Emacs
346 Similar things happen when an event on a scroll bar is enqueued; the
347 window may be deleted while the event is in the queue.
349 So, we use this vector to protect the frame_or_window field in the
350 event queue. That way, they'll be dequeued as dead frames or
351 windows, but still valid lisp objects.
353 If perd->kbd_buffer[i].kind != no_event, then
354 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
355 == perd->kbd_buffer[i].frame_or_window. */
356 static Lisp_Object kbd_buffer_frame_or_window
;
359 /* If this flag is a frame, we check mouse_moved to see when the
360 mouse moves, and motion events will appear in the input stream.
361 Otherwise, mouse motion is ignored. */
362 static Lisp_Object do_mouse_tracking
;
364 /* The window system handling code should set this if the mouse has
365 moved since the last call to the mouse_position_hook. Calling that
366 hook should clear this. Code assumes that if this is set, it can
367 call mouse_position_hook to get the promised position, so don't set
368 it unless you're prepared to substantiate the claim! */
371 #define MOUSE_ACTIVITY_AVAILABLE (FRAMEP (do_mouse_tracking) && mouse_moved)
372 #else /* Not HAVE_MOUSE. */
373 #define MOUSE_ACTIVITY_AVAILABLE 0
374 #endif /* HAVE_MOUSE. */
376 /* Symbols to head events. */
377 Lisp_Object Qmouse_movement
;
378 Lisp_Object Qscroll_bar_movement
;
379 Lisp_Object Qswitch_frame
;
380 Lisp_Object Qdelete_frame
;
381 Lisp_Object Qiconify_frame
;
382 Lisp_Object Qmake_frame_visible
;
384 /* Symbols to denote kinds of events. */
385 Lisp_Object Qfunction_key
;
386 Lisp_Object Qmouse_click
;
387 /* Lisp_Object Qmouse_movement; - also an event header */
389 /* Properties of event headers. */
390 Lisp_Object Qevent_kind
;
391 Lisp_Object Qevent_symbol_elements
;
393 Lisp_Object Qmenu_enable
;
395 /* An event header symbol HEAD may have a property named
396 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
397 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
398 mask of modifiers applied to it. If present, this is used to help
399 speed up parse_modifiers. */
400 Lisp_Object Qevent_symbol_element_mask
;
402 /* An unmodified event header BASE may have a property named
403 Qmodifier_cache, which is an alist mapping modifier masks onto
404 modified versions of BASE. If present, this helps speed up
406 Lisp_Object Qmodifier_cache
;
408 /* Symbols to use for parts of windows. */
409 Lisp_Object Qmode_line
;
410 Lisp_Object Qvertical_line
;
411 Lisp_Object Qvertical_scroll_bar
;
412 Lisp_Object Qmenu_bar
;
414 extern Lisp_Object Qmenu_enable
;
416 Lisp_Object
recursive_edit_unwind (), command_loop ();
417 Lisp_Object
Fthis_command_keys ();
418 Lisp_Object Qextended_command_history
;
420 Lisp_Object Qpolling_period
;
422 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
424 EMACS_TIME
*input_available_clear_time
;
426 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
427 Default is 1 if INTERRUPT_INPUT is defined. */
430 /* Nonzero while interrupts are temporarily deferred during redisplay. */
431 int interrupts_deferred
;
433 /* nonzero means use ^S/^Q for flow control. */
436 /* Allow m- file to inhibit use of FIONREAD. */
437 #ifdef BROKEN_FIONREAD
441 /* We are unable to use interrupts if FIONREAD is not available,
442 so flush SIGIO so we won't try. */
449 /* If we support X Windows, turn on the code to poll periodically
450 to detect C-g. It isn't actually used when doing interrupt input. */
451 #ifdef HAVE_X_WINDOWS
452 #define POLL_FOR_INPUT
455 /* Global variable declarations. */
457 /* Function for init_keyboard to call with no args (if nonzero). */
458 void (*keyboard_init_hook
) ();
460 static int read_avail_input ();
461 static void get_input_pending ();
462 static int readable_events ();
463 static Lisp_Object
read_char_x_menu_prompt ();
464 static Lisp_Object
read_char_minibuf_menu_prompt ();
465 static Lisp_Object
make_lispy_event ();
466 static Lisp_Object
make_lispy_movement ();
467 static Lisp_Object
modify_event_symbol ();
468 static Lisp_Object
make_lispy_switch_frame ();
470 /* > 0 if we are to echo keystrokes. */
471 static int echo_keystrokes
;
473 /* Nonzero means echo each character as typed. */
474 static int immediate_echo
;
476 /* The text we're echoing in the modeline - partial key sequences,
477 usually. '\0'-terminated. This really shouldn't have a fixed size. */
478 static char echobuf
[300];
480 /* Where to append more text to echobuf if we want to. */
481 static char *echoptr
;
483 /* If we have echoed a prompt string specified by the user,
484 this is its length. Otherwise this is -1. */
485 static int echo_after_prompt
;
487 /* Nonzero means don't try to suspend even if the operating system seems
489 static int cannot_suspend
;
491 #define min(a,b) ((a)<(b)?(a):(b))
492 #define max(a,b) ((a)>(b)?(a):(b))
494 /* Install the string STR as the beginning of the string of echoing,
495 so that it serves as a prompt for the next character.
496 Also start echoing. */
501 int len
= strlen (str
);
503 if (len
> sizeof echobuf
- 4)
504 len
= sizeof echobuf
- 4;
505 bcopy (str
, echobuf
, len
);
506 echoptr
= echobuf
+ len
;
509 echo_after_prompt
= len
;
514 /* Add C to the echo string, if echoing is going on.
515 C can be a character, which is printed prettily ("M-C-x" and all that
516 jazz), or a symbol, whose name is printed. */
521 extern char *push_key_description ();
530 /* If someone has passed us a composite event, use its head symbol. */
535 if (ptr
- echobuf
> sizeof echobuf
- 6)
538 ptr
= push_key_description (XINT (c
), ptr
);
540 else if (SYMBOLP (c
))
542 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
543 if (((ptr
- echobuf
) + name
->size
+ 4) > sizeof echobuf
)
545 bcopy (name
->data
, ptr
, name
->size
);
549 if (echoptr
== echobuf
&& EQ (c
, Vhelp_char
))
551 strcpy (ptr
, " (Type ? for further options)");
562 /* Temporarily add a dash to the end of the echo string if it's not
563 empty, so that it serves as a mini-prompt for the very next character. */
567 if (!immediate_echo
&& echoptr
== echobuf
)
569 /* Do nothing if we just printed a prompt. */
570 if (echo_after_prompt
== echoptr
- echobuf
)
572 /* Do nothing if not echoing at all. */
576 /* Put a dash at the end of the buffer temporarily,
577 but make it go away when the next character is added. */
584 /* Display the current echo string, and begin echoing if not already
594 for (i
= 0; i
< this_command_key_count
; i
++)
597 c
= XVECTOR (this_command_keys
)->contents
[i
];
598 if (! (EVENT_HAS_PARAMETERS (c
)
599 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
606 message2_nolog (echobuf
, strlen (echobuf
));
609 if (waiting_for_input
&& !NILP (Vquit_flag
))
610 quit_throw_to_read_char ();
613 /* Turn off echoing, for the start of a new command. */
619 echo_after_prompt
= -1;
622 /* Return the length of the current echo string. */
627 return echoptr
- echobuf
;
630 /* Truncate the current echo message to its first LEN chars.
631 This and echo_char get used by read_key_sequence when the user
632 switches frames while entering a key sequence. */
639 echoptr
= echobuf
+ len
;
640 truncate_echo_area (len
);
644 /* Functions for manipulating this_command_keys. */
646 add_command_key (key
)
649 int size
= XVECTOR (this_command_keys
)->size
;
651 if (this_command_key_count
>= size
)
653 Lisp_Object new_keys
;
655 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
656 bcopy (XVECTOR (this_command_keys
)->contents
,
657 XVECTOR (new_keys
)->contents
,
658 size
* sizeof (Lisp_Object
));
660 this_command_keys
= new_keys
;
663 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
669 int count
= specpdl_ptr
- specpdl
;
672 if (command_loop_level
> 0)
674 specbind (Qstandard_output
, Qt
);
675 specbind (Qstandard_input
, Qt
);
678 val
= command_loop ();
680 Fsignal (Qquit
, Qnil
);
682 return unbind_to (count
, Qnil
);
685 /* When an auto-save happens, record the "time", and don't do again soon. */
689 last_auto_save
= num_nonmacro_input_chars
;
692 /* Make an auto save happen as soon as possible at command level. */
694 force_auto_save_soon ()
696 last_auto_save
= - auto_save_interval
- 1;
698 record_asynch_buffer_change ();
701 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
702 "Invoke the editor command loop recursively.\n\
703 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
704 that tells this function to return.\n\
705 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
706 This function is called by the editor initialization to begin editing.")
709 int count
= specpdl_ptr
- specpdl
;
712 command_loop_level
++;
713 update_mode_lines
= 1;
715 record_unwind_protect (recursive_edit_unwind
,
717 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
721 return unbind_to (count
, Qnil
);
725 recursive_edit_unwind (buffer
)
729 Fset_buffer (buffer
);
731 command_loop_level
--;
732 update_mode_lines
= 1;
740 Vstandard_output
= Qt
;
741 Vstandard_input
= Qt
;
742 Vexecuting_macro
= Qnil
;
743 cmd_error_internal (data
, 0);
747 Vinhibit_quit
= Qnil
;
749 return make_number (0);
752 cmd_error_internal (data
, context
)
756 Lisp_Object errmsg
, tail
, errname
, file_error
;
763 echo_area_glyphs
= 0;
765 /* If the window system or terminal frame hasn't been initialized
766 yet, or we're not interactive, it's best to dump this message out
767 to stderr and exit. */
768 if (! FRAME_MESSAGE_BUF (selected_frame
)
770 stream
= Qexternal_debugging_output
;
779 write_string_1 (context
, -1, stream
);
781 errname
= Fcar (data
);
783 if (EQ (errname
, Qerror
))
786 if (!CONSP (data
)) data
= Qnil
;
787 errmsg
= Fcar (data
);
792 errmsg
= Fget (errname
, Qerror_message
);
793 file_error
= Fmemq (Qfile_error
,
794 Fget (errname
, Qerror_conditions
));
797 /* Print an error message including the data items.
798 This is done by printing it into a scratch buffer
799 and then making a copy of the text in the buffer. */
801 if (!CONSP (data
)) data
= Qnil
;
805 /* For file-error, make error message by concatenating
806 all the data items. They are all strings. */
807 if (!NILP (file_error
) && !NILP (tail
))
808 errmsg
= XCONS (tail
)->car
, tail
= XCONS (tail
)->cdr
;
810 if (STRINGP (errmsg
))
811 Fprinc (errmsg
, stream
);
813 write_string_1 ("peculiar error", -1, stream
);
815 for (i
= 0; CONSP (tail
); tail
= Fcdr (tail
), i
++)
817 write_string_1 (i
? ", " : ": ", 2, stream
);
818 if (!NILP (file_error
))
819 Fprinc (Fcar (tail
), stream
);
821 Fprin1 (Fcar (tail
), stream
);
825 /* If the window system or terminal frame hasn't been initialized
826 yet, or we're in -batch mode, this error should cause Emacs to exit. */
827 if (! FRAME_MESSAGE_BUF (selected_frame
)
831 Fkill_emacs (make_number (-1));
835 Lisp_Object
command_loop_1 ();
836 Lisp_Object
command_loop_2 ();
837 Lisp_Object
top_level_1 ();
839 /* Entry to editor-command-loop.
840 This level has the catches for exiting/returning to editor command loop.
841 It returns nil to exit recursive edit, t to abort it. */
846 if (command_loop_level
> 0 || minibuf_level
> 0)
848 return internal_catch (Qexit
, command_loop_2
, Qnil
);
853 internal_catch (Qtop_level
, top_level_1
, Qnil
);
854 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
856 /* End of file in -batch run causes exit here. */
862 /* Here we catch errors in execution of commands within the
863 editing loop, and reenter the editing loop.
864 When there is an error, cmd_error runs and returns a non-nil
865 value to us. A value of nil means that cmd_loop_1 itself
866 returned due to end of file (or end of kbd macro). */
871 register Lisp_Object val
;
874 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
883 return Feval (Vtop_level
);
889 /* On entry to the outer level, run the startup file */
890 if (!NILP (Vtop_level
))
891 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
892 else if (!NILP (Vpurify_flag
))
893 message ("Bare impure Emacs (standard Lisp code not loaded)");
895 message ("Bare Emacs (standard Lisp code not loaded)");
899 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
900 "Exit all recursive editing levels.")
903 Fthrow (Qtop_level
, Qnil
);
906 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
907 "Exit from the innermost recursive edit or minibuffer.")
910 if (command_loop_level
> 0 || minibuf_level
> 0)
911 Fthrow (Qexit
, Qnil
);
913 error ("No recursive edit is in progress");
916 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
917 "Abort the command that requested this recursive edit or minibuffer input.")
920 if (command_loop_level
> 0 || minibuf_level
> 0)
923 error ("No recursive edit is in progress");
926 /* This is the actual command reading loop,
927 sans error-handling encapsulation. */
929 Lisp_Object
Fcommand_execute ();
930 static int read_key_sequence ();
931 static void safe_run_hooks ();
936 Lisp_Object cmd
, tem
;
939 Lisp_Object keybuf
[30];
944 struct buffer
*prev_buffer
;
947 Vdeactivate_mark
= Qnil
;
948 waiting_for_input
= 0;
953 this_command_key_count
= 0;
955 /* Make sure this hook runs after commands that get errors and
956 throw to top level. */
957 /* Note that the value cell will never directly contain nil
958 if the symbol is a local variable. */
959 if (!NILP (XSYMBOL (Qpost_command_hook
)->value
) && !NILP (Vrun_hooks
))
960 safe_run_hooks (Qpost_command_hook
);
962 if (!NILP (Vdeferred_action_list
))
963 call0 (Vdeferred_action_function
);
965 /* Do this after running Vpost_command_hook, for consistency. */
966 last_command
= this_command
;
970 /* Install chars successfully executed in kbd macro. */
972 if (defining_kbd_macro
&& NILP (Vprefix_arg
))
973 finalize_kbd_macro_chars ();
975 /* Make sure the current window's buffer is selected. */
976 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
977 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
979 /* Display any malloc warning that just came out. Use while because
980 displaying one warning can cause another. */
982 while (pending_malloc_warning
)
983 display_malloc_warning ();
987 Vdeactivate_mark
= Qnil
;
989 /* If minibuffer on and echo area in use,
990 wait 2 sec and redraw minibuffer. */
992 if (minibuf_level
&& echo_area_glyphs
)
994 /* Bind inhibit-quit to t so that C-g gets read in
995 rather than quitting back to the minibuffer. */
996 int count
= specpdl_ptr
- specpdl
;
997 specbind (Qinhibit_quit
, Qt
);
998 Fsit_for (make_number (2), Qnil
, Qnil
);
999 unbind_to (count
, Qnil
);
1001 echo_area_glyphs
= 0;
1003 if (!NILP (Vquit_flag
))
1006 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1011 alloca (0); /* Cause a garbage collection now */
1012 /* Since we can free the most stuff here. */
1013 #endif /* C_ALLOCA */
1017 /* Select the frame that the last event came from. Usually,
1018 switch-frame events will take care of this, but if some lisp
1019 code swallows a switch-frame event, we'll fix things up here.
1020 Is this a good idea? */
1021 if (FRAMEP (internal_last_event_frame
)
1022 && XFRAME (internal_last_event_frame
) != selected_frame
)
1023 Fselect_frame (internal_last_event_frame
, Qnil
);
1026 /* If it has changed current-menubar from previous value,
1027 really recompute the menubar from the value. */
1028 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1029 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1030 call0 (Qrecompute_lucid_menubar
);
1032 /* Read next key sequence; i gets its length. */
1033 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), Qnil
, 0);
1037 /* Now we have read a key sequence of length I,
1038 or else I is 0 and we found end of file. */
1040 if (i
== 0) /* End of file -- happens only in */
1041 return Qnil
; /* a kbd macro, at the end. */
1042 /* -1 means read_key_sequence got a menu that was rejected.
1043 Just loop around and read another command. */
1047 this_command_key_count
= 0;
1051 last_command_char
= keybuf
[i
- 1];
1053 /* If the previous command tried to force a specific window-start,
1054 forget about that, in case this command moves point far away
1055 from that position. */
1056 XWINDOW (selected_window
)->force_start
= Qnil
;
1058 cmd
= read_key_sequence_cmd
;
1059 if (!NILP (Vexecuting_macro
))
1061 if (!NILP (Vquit_flag
))
1063 Vexecuting_macro
= Qt
;
1064 QUIT
; /* Make some noise. */
1065 /* Will return since macro now empty. */
1069 /* Do redisplay processing after this command except in special
1070 cases identified below that set no_redisplay to 1.
1071 (actually, there's currently no way to prevent the redisplay,
1072 and no_redisplay is ignored.
1073 Perhaps someday we will really implement it. */
1076 prev_buffer
= current_buffer
;
1077 prev_modiff
= MODIFF
;
1078 last_point_position
= PT
;
1079 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1081 /* Execute the command. */
1084 /* Note that the value cell will never directly contain nil
1085 if the symbol is a local variable. */
1086 if (!NILP (XSYMBOL (Qpre_command_hook
)->value
) && !NILP (Vrun_hooks
))
1087 safe_run_hooks (Qpre_command_hook
);
1089 if (NILP (this_command
))
1091 /* nil means key is undefined. */
1093 defining_kbd_macro
= 0;
1094 update_mode_lines
= 1;
1100 if (NILP (Vprefix_arg
) && ! no_direct
)
1102 /* Recognize some common commands in common situations and
1103 do them directly. */
1104 if (EQ (this_command
, Qforward_char
) && PT
< ZV
)
1106 struct Lisp_Vector
*dp
1107 = window_display_table (XWINDOW (selected_window
));
1108 lose
= FETCH_CHAR (PT
);
1111 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1112 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1113 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1114 && (lose
>= 0x20 && lose
< 0x7f)))
1115 : (lose
>= 0x20 && lose
< 0x7f))
1116 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1118 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1120 && !windows_or_buffers_changed
1121 && EQ (current_buffer
->selective_display
, Qnil
)
1122 && !detect_input_pending ()
1123 && NILP (Vexecuting_macro
))
1124 no_redisplay
= direct_output_forward_char (1);
1127 else if (EQ (this_command
, Qbackward_char
) && PT
> BEGV
)
1129 struct Lisp_Vector
*dp
1130 = window_display_table (XWINDOW (selected_window
));
1132 lose
= FETCH_CHAR (PT
);
1134 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1135 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1136 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1137 && (lose
>= 0x20 && lose
< 0x7f)))
1138 : (lose
>= 0x20 && lose
< 0x7f))
1139 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1141 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1143 && !windows_or_buffers_changed
1144 && EQ (current_buffer
->selective_display
, Qnil
)
1145 && !detect_input_pending ()
1146 && NILP (Vexecuting_macro
))
1147 no_redisplay
= direct_output_forward_char (-1);
1150 else if (EQ (this_command
, Qself_insert_command
)
1151 /* Try this optimization only on ascii keystrokes. */
1152 && INTEGERP (last_command_char
))
1154 unsigned char c
= XINT (last_command_char
);
1157 if (NILP (Vexecuting_macro
)
1158 && !EQ (minibuf_window
, selected_window
))
1160 if (!nonundocount
|| nonundocount
>= 20)
1167 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1169 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1171 || MODIFF
<= SAVE_MODIFF
1172 || windows_or_buffers_changed
1173 || !EQ (current_buffer
->selective_display
, Qnil
)
1174 || detect_input_pending ()
1175 || !NILP (Vexecuting_macro
));
1176 value
= internal_self_insert (c
, 0);
1183 && (PT
== ZV
|| FETCH_CHAR (PT
) == '\n'))
1185 struct Lisp_Vector
*dp
1186 = window_display_table (XWINDOW (selected_window
));
1193 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1196 /* Do it only for char codes
1197 that by default display as themselves. */
1198 if (lose
>= 0x20 && lose
<= 0x7e)
1199 no_redisplay
= direct_output_for_insert (lose
);
1201 else if (VECTORP (obj
)
1202 && XVECTOR (obj
)->size
== 1
1203 && (obj
= XVECTOR (obj
)->contents
[0],
1205 /* Insist face not specified in glyph. */
1206 && (XINT (obj
) & ((-1) << 8)) == 0)
1208 = direct_output_for_insert (XINT (obj
));
1212 if (lose
>= 0x20 && lose
<= 0x7e)
1213 no_redisplay
= direct_output_for_insert (lose
);
1220 /* Here for a command that isn't executed directly */
1223 if (NILP (Vprefix_arg
))
1225 Fcommand_execute (this_command
, Qnil
);
1230 /* Note that the value cell will never directly contain nil
1231 if the symbol is a local variable. */
1232 if (!NILP (XSYMBOL (Qpost_command_hook
)->value
) && !NILP (Vrun_hooks
))
1233 safe_run_hooks (Qpost_command_hook
);
1235 if (!NILP (Vdeferred_action_list
))
1236 safe_run_hooks (Qdeferred_action_function
);
1238 /* If there is a prefix argument,
1239 1) We don't want last_command to be ``universal-argument''
1240 (that would be dumb), so don't set last_command,
1241 2) we want to leave echoing on so that the prefix will be
1242 echoed as part of this key sequence, so don't call
1244 3) we want to leave this_command_key_count non-zero, so that
1245 read_char will realize that it is re-reading a character, and
1246 not echo it a second time. */
1247 if (NILP (Vprefix_arg
))
1249 last_command
= this_command
;
1251 this_command_key_count
= 0;
1254 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1256 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1258 current_buffer
->mark_active
= Qnil
;
1259 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1261 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1262 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1267 /* If we get an error while running the hook, cause the hook variable
1268 to be nil. Also inhibit quits, so that C-g won't cause the hook
1269 to mysteriously evaporate. */
1271 safe_run_hooks (hook
)
1275 int count
= specpdl_ptr
- specpdl
;
1276 specbind (Qinhibit_quit
, Qt
);
1278 /* We read and set the variable with functions,
1279 in case it's buffer-local. */
1280 value
= Vcommand_hook_internal
= Fsymbol_value (hook
);
1282 call1 (Vrun_hooks
, Qcommand_hook_internal
);
1285 unbind_to (count
, Qnil
);
1288 /* Number of seconds between polling for input. */
1291 /* Nonzero means polling for input is temporarily suppressed. */
1292 int poll_suppress_count
;
1294 /* Nonzero if polling_for_input is actually being used. */
1295 int polling_for_input
;
1297 #ifdef POLL_FOR_INPUT
1299 /* Handle an alarm once each second and read pending input
1300 so as to handle a C-g if it comces in. */
1303 input_poll_signal ()
1305 if (interrupt_input_blocked
== 0
1306 && !waiting_for_input
)
1307 read_avail_input (0);
1308 signal (SIGALRM
, input_poll_signal
);
1309 alarm (polling_period
);
1314 /* Begin signals to poll for input, if they are appropriate.
1315 This function is called unconditionally from various places. */
1319 #ifdef POLL_FOR_INPUT
1320 if (read_socket_hook
&& !interrupt_input
)
1322 poll_suppress_count
--;
1323 if (poll_suppress_count
== 0)
1325 signal (SIGALRM
, input_poll_signal
);
1326 polling_for_input
= 1;
1327 alarm (polling_period
);
1333 /* Nonzero if we are using polling to handle input asynchronously. */
1336 input_polling_used ()
1338 #ifdef POLL_FOR_INPUT
1339 return read_socket_hook
&& !interrupt_input
;
1345 /* Turn off polling. */
1349 #ifdef POLL_FOR_INPUT
1350 if (read_socket_hook
&& !interrupt_input
)
1352 if (poll_suppress_count
== 0)
1354 polling_for_input
= 0;
1357 poll_suppress_count
++;
1362 /* Set the value of poll_suppress_count to COUNT
1363 and start or stop polling accordingly. */
1366 set_poll_suppress_count (count
)
1369 #ifdef POLL_FOR_INPUT
1370 if (count
== 0 && poll_suppress_count
!= 0)
1372 poll_suppress_count
= 1;
1375 else if (count
!= 0 && poll_suppress_count
== 0)
1379 poll_suppress_count
= count
;
1383 /* Bind polling_period to a value at least N.
1384 But don't decrease it. */
1386 bind_polling_period (n
)
1389 #ifdef POLL_FOR_INPUT
1390 int new = polling_period
;
1396 specbind (Qpolling_period
, make_number (new));
1397 /* Start a new alarm with the new period. */
1402 /* Applying the control modifier to CHARACTER. */
1407 /* Save the upper bits here. */
1408 int upper
= c
& ~0177;
1412 /* Everything in the columns containing the upper-case letters
1413 denotes a control character. */
1414 if (c
>= 0100 && c
< 0140)
1418 /* Set the shift modifier for a control char
1419 made from a shifted letter. But only for letters! */
1420 if (oc
>= 'A' && oc
<= 'Z')
1421 c
|= shift_modifier
;
1424 /* The lower-case letters denote control characters too. */
1425 else if (c
>= 'a' && c
<= 'z')
1428 /* Include the bits for control and shift
1429 only if the basic ASCII code can't indicate them. */
1433 /* Replace the high bits. */
1434 c
|= (upper
& ~ctrl_modifier
);
1441 /* Input of single characters from keyboard */
1443 Lisp_Object
print_help ();
1444 static Lisp_Object
kbd_buffer_get_event ();
1445 static void record_char ();
1447 /* read a character from the keyboard; call the redisplay if needed */
1448 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1449 -1 means do not do redisplay, but do do autosaving.
1452 /* The arguments MAPS and NMAPS are for menu prompting.
1453 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1455 PREV_EVENT is the previous input event, or nil if we are reading
1456 the first event of a key sequence.
1458 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1459 if we used a mouse menu to read the input, or zero otherwise. If
1460 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
1462 Value is t if we showed a menu and the user rejected it. */
1465 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1469 Lisp_Object prev_event
;
1470 int *used_mouse_menu
;
1472 register Lisp_Object c
;
1475 int key_already_recorded
= 0;
1476 Lisp_Object also_record
;
1479 if (CONSP (Vunread_command_events
))
1481 c
= XCONS (Vunread_command_events
)->car
;
1482 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1484 if (this_command_key_count
== 0)
1490 if (unread_command_char
!= -1)
1492 XSETINT (c
, unread_command_char
);
1493 unread_command_char
= -1;
1495 if (this_command_key_count
== 0)
1501 if (!NILP (Vexecuting_macro
))
1504 /* We set this to Qmacro; since that's not a frame, nobody will
1505 try to switch frames on us, and the selected window will
1508 Since this event came from a macro, it would be misleading to
1509 leave internal_last_event_frame set to wherever the last
1510 real event came from. Normally, a switch-frame event selects
1511 internal_last_event_frame after each command is read, but
1512 events read from a macro should never cause a new frame to be
1514 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1517 /* Exit the macro if we are at the end.
1518 Also, some things replace the macro with t
1519 to force an early exit. */
1520 if (EQ (Vexecuting_macro
, Qt
)
1521 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1527 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1528 if (STRINGP (Vexecuting_macro
)
1529 && (XINT (c
) & 0x80))
1530 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
1532 executing_macro_index
++;
1537 if (!NILP (unread_switch_frame
))
1539 c
= unread_switch_frame
;
1540 unread_switch_frame
= Qnil
;
1542 /* This event should make it into this_command_keys, and get echoed
1543 again, so we go to reread_first, rather than reread. */
1547 /* Don't bother updating menu bars while doing mouse tracking.
1548 We get events very rapidly then, and the menu bar won't be changing.
1549 We do update the menu bar once on entry to Ftrack_mouse. */
1550 if (commandflag
> 0 && !input_pending
&& !detect_input_pending ())
1551 prepare_menu_bars ();
1553 /* Save outer setjmp data, in case called recursively. */
1554 save_getcjmp (save_jump
);
1558 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1561 if (_setjmp (getcjmp
))
1563 XSETINT (c
, quit_char
);
1565 XSETFRAME (internal_last_event_frame
, selected_frame
);
1566 Vlast_event_frame
= internal_last_event_frame
;
1568 /* If we report the quit char as an event,
1569 don't do so more than once. */
1570 if (!NILP (Vinhibit_quit
))
1576 /* Message turns off echoing unless more keystrokes turn it on again. */
1577 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1580 /* If already echoing, continue. */
1583 /* Try reading a character via menu prompting in the minibuf.
1584 Try this before the sit-for, because the sit-for
1585 would do the wrong thing if we are supposed to do
1586 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1587 after a mouse event so don't try a minibuf menu. */
1589 if (nmaps
> 0 && INTERACTIVE
1590 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1591 /* Don't bring up a menu if we already have another event. */
1592 && NILP (Vunread_command_events
)
1593 && unread_command_char
< 0
1594 && !detect_input_pending ())
1596 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1599 key_already_recorded
= 1;
1604 /* If in middle of key sequence and minibuffer not active,
1605 start echoing if enough time elapses. */
1606 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1608 && echo_keystrokes
> 0
1609 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1613 /* After a mouse event, start echoing right away.
1614 This is because we are probably about to display a menu,
1615 and we don't want to delay before doing so. */
1616 if (EVENT_HAS_PARAMETERS (prev_event
))
1620 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1626 /* Maybe auto save due to number of keystrokes or idle time. */
1628 if (commandflag
!= 0
1629 && auto_save_interval
> 0
1630 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1631 && !detect_input_pending ())
1634 save_getcjmp (temp
);
1635 Fdo_auto_save (Qnil
, Qnil
);
1636 /* Hooks can actually change some buffers in auto save. */
1638 restore_getcjmp (temp
);
1641 /* Try reading using an X menu.
1642 This is never confused with reading using the minibuf
1643 because the recursive call of read_char in read_char_minibuf_menu_prompt
1644 does not pass on any keymaps. */
1645 if (nmaps
> 0 && INTERACTIVE
1646 && !NILP (prev_event
) && EVENT_HAS_PARAMETERS (prev_event
)
1647 /* Don't bring up a menu if we already have another event. */
1648 && NILP (Vunread_command_events
)
1649 && unread_command_char
< 0)
1650 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1652 /* Slow down auto saves logarithmically in size of current buffer,
1653 and garbage collect while we're at it. */
1654 if (INTERACTIVE
&& NILP (c
))
1656 int delay_level
, buffer_size
;
1658 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1659 last_non_minibuf_size
= Z
- BEG
;
1660 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1662 while (buffer_size
> 64)
1663 delay_level
++, buffer_size
-= buffer_size
>> 2;
1664 if (delay_level
< 4) delay_level
= 4;
1665 /* delay_level is 4 for files under around 50k, 7 at 100k,
1666 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1668 /* Auto save if enough time goes by without input. */
1669 if (commandflag
!= 0
1670 && num_nonmacro_input_chars
> last_auto_save
1671 && INTEGERP (Vauto_save_timeout
)
1672 && XINT (Vauto_save_timeout
) > 0)
1675 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1676 tem0
= sit_for (delay
, 0, 1, 1);
1680 save_getcjmp (temp
);
1681 Fdo_auto_save (Qnil
, Qnil
);
1682 restore_getcjmp (temp
);
1684 /* If we have auto-saved and there is still no input
1685 available, garbage collect if there has been enough
1686 consing going on to make it worthwhile. */
1687 if (!detect_input_pending ()
1688 && consing_since_gc
> gc_cons_threshold
/ 2)
1689 Fgarbage_collect ();
1690 /* prepare_menu_bars isn't safe here, but it should
1691 also be unnecessary. */
1697 /* Actually read a character, waiting if necessary. */
1700 c
= kbd_buffer_get_event ();
1703 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1705 prepare_menu_bars ();
1710 /* Terminate Emacs in batch mode if at eof. */
1711 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
1712 Fkill_emacs (make_number (1));
1716 /* Add in any extra modifiers, where appropriate. */
1717 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1718 || ((extra_keyboard_modifiers
& 0177) < ' '
1719 && (extra_keyboard_modifiers
& 0177) != 0))
1720 XSETINT (c
, make_ctrl_char (XINT (c
)));
1722 /* Transfer any other modifier bits directly from
1723 extra_keyboard_modifiers to c. Ignore the actual character code
1724 in the low 16 bits of extra_keyboard_modifiers. */
1725 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
1730 restore_getcjmp (save_jump
);
1734 /* Buffer switch events are only for internal wakeups
1735 so don't show them to the user. */
1739 if (key_already_recorded
)
1742 /* Wipe the echo area. */
1743 echo_area_glyphs
= 0;
1745 /* Handle things that only apply to characters. */
1748 /* If kbd_buffer_get_event gave us an EOF, return that. */
1752 if (STRINGP (Vkeyboard_translate_table
)
1753 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1754 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1757 /* If this event is a mouse click in the menu bar,
1758 return just menu-bar for now. Modify the mouse click event
1759 so we won't do this twice, then queue it up. */
1760 if (EVENT_HAS_PARAMETERS (c
)
1761 && CONSP (XCONS (c
)->cdr
)
1762 && CONSP (EVENT_START (c
))
1763 && CONSP (XCONS (EVENT_START (c
))->cdr
))
1767 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
1768 /* Handle menu-bar events:
1769 insert the dummy prefix event `menu-bar'. */
1770 if (EQ (posn
, Qmenu_bar
))
1772 /* Change menu-bar to (menu-bar) as the event "position". */
1773 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
1776 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
1782 if (! NILP (also_record
))
1783 record_char (also_record
);
1788 /* Don't echo mouse motion events. */
1790 && ! (EVENT_HAS_PARAMETERS (c
)
1791 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1794 if (! NILP (also_record
))
1795 echo_char (also_record
);
1798 /* Record this character as part of the current key. */
1799 add_command_key (c
);
1800 if (! NILP (also_record
))
1801 add_command_key (also_record
);
1803 /* Re-reading in the middle of a command */
1805 last_input_char
= c
;
1808 /* Process the help character specially if enabled */
1809 if (EQ (c
, Vhelp_char
) && !NILP (Vhelp_form
))
1812 count
= specpdl_ptr
- specpdl
;
1814 record_unwind_protect (Fset_window_configuration
,
1815 Fcurrent_window_configuration (Qnil
));
1817 tem0
= Feval (Vhelp_form
);
1819 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1823 c
= read_char (0, 0, 0, Qnil
, 0);
1824 while (BUFFERP (c
));
1825 /* Remove the help from the frame */
1826 unbind_to (count
, Qnil
);
1827 prepare_menu_bars ();
1829 if (EQ (c
, make_number (040)))
1833 c
= read_char (0, 0, 0, Qnil
, 0);
1834 while (BUFFERP (c
));
1841 /* Record the input event C in various ways. */
1848 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1849 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1850 recent_keys_index
= 0;
1852 /* Write c to the dribble file. If c is a lispy event, write
1853 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1854 If you, dear reader, have a better idea, you've got the source. :-) */
1859 if (XUINT (c
) < 0x100)
1860 putc (XINT (c
), dribble
);
1862 fprintf (dribble
, " 0x%x", XUINT (c
));
1866 Lisp_Object dribblee
;
1868 /* If it's a structured event, take the event header. */
1869 dribblee
= EVENT_HEAD (c
);
1871 if (SYMBOLP (dribblee
))
1873 putc ('<', dribble
);
1874 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1875 XSYMBOL (dribblee
)->name
->size
,
1877 putc ('>', dribble
);
1884 store_kbd_macro_char (c
);
1886 num_nonmacro_input_chars
++;
1893 struct buffer
*old
= current_buffer
;
1894 Fprinc (object
, Qnil
);
1895 set_buffer_internal (XBUFFER (Vstandard_output
));
1896 call0 (intern ("help-mode"));
1897 set_buffer_internal (old
);
1901 /* Copy out or in the info on where C-g should throw to.
1902 This is used when running Lisp code from within get_char,
1903 in case get_char is called recursively.
1904 See read_process_output. */
1909 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1912 restore_getcjmp (temp
)
1915 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1921 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1922 of this function. */
1925 tracking_off (old_value
)
1926 Lisp_Object old_value
;
1928 do_mouse_tracking
= old_value
;
1929 if (NILP (old_value
))
1931 /* Redisplay may have been preempted because there was input
1932 available, and it assumes it will be called again after the
1933 input has been processed. If the only input available was
1934 the sort that we have just disabled, then we need to call
1936 if (!readable_events ())
1938 prepare_menu_bars ();
1939 redisplay_preserve_echo_area ();
1940 get_input_pending (&input_pending
);
1945 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1946 "Evaluate BODY with mouse movement events enabled.\n\
1947 Within a `track-mouse' form, mouse motion generates input events that\n\
1948 you can read with `read-event'.\n\
1949 Normally, mouse motion is ignored.")
1953 int count
= specpdl_ptr
- specpdl
;
1956 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1958 if (!input_pending
&& !detect_input_pending ())
1959 prepare_menu_bars ();
1961 XSETFRAME (do_mouse_tracking
, selected_frame
);
1963 val
= Fprogn (args
);
1964 return unbind_to (count
, val
);
1967 #endif /* HAVE_MOUSE */
1969 /* Low level keyboard/mouse input.
1970 kbd_buffer_store_event places events in kbd_buffer, and
1971 kbd_buffer_get_event retrieves them.
1972 mouse_moved indicates when the mouse has moved again, and
1973 *mouse_position_hook provides the mouse position. */
1976 find_active_event_queue ()
1979 perd
= &the_only_perd
;
1980 /* FOR_ALL_PERDS (perd) */
1982 if (perd
->kbd_fetch_ptr
!= perd
->kbd_store_ptr
)
1988 /* Return true iff there are any events in the queue that read-char
1989 would return. If this returns false, a read-char would block. */
1993 return find_active_event_queue () != NULL
|| MOUSE_ACTIVITY_AVAILABLE
;
1996 /* Set this for debugging, to have a way to get out */
1999 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
2002 kbd_buffer_store_event (event
)
2003 register struct input_event
*event
;
2005 PERD
*perd
= get_perd (XFRAME (event
->frame_or_window
));
2007 if (event
->kind
== no_event
)
2010 if (event
->kind
== ascii_keystroke
)
2012 register int c
= event
->code
& 0377;
2014 if (event
->modifiers
& ctrl_modifier
)
2015 c
= make_ctrl_char (c
);
2017 c
|= (event
->modifiers
2018 & (meta_modifier
| alt_modifier
2019 | hyper_modifier
| super_modifier
));
2023 extern SIGTYPE
interrupt_signal ();
2026 /* If this results in a quit_char being returned to Emacs as
2027 input, set Vlast_event_frame properly. If this doesn't
2028 get returned to Emacs as an event, the next event read
2029 will set Vlast_event_frame again, so this is safe to do. */
2033 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
2035 internal_last_event_frame
= event
->frame_or_window
;
2037 internal_last_event_frame
= focus
;
2038 Vlast_event_frame
= internal_last_event_frame
;
2042 last_event_timestamp
= event
->timestamp
;
2043 interrupt_signal ();
2047 if (c
&& c
== stop_character
)
2054 if (perd
->kbd_store_ptr
- perd
->kbd_buffer
== KBD_BUFFER_SIZE
)
2055 perd
->kbd_store_ptr
= perd
->kbd_buffer
;
2057 /* Don't let the very last slot in the buffer become full,
2058 since that would make the two pointers equal,
2059 and that is indistinguishable from an empty buffer.
2060 Discard the event if it would fill the last slot. */
2061 if (perd
->kbd_fetch_ptr
- 1 != perd
->kbd_store_ptr
)
2063 volatile struct input_event
*sp
= perd
->kbd_store_ptr
;
2064 sp
->kind
= event
->kind
;
2065 if (event
->kind
== selection_request_event
)
2067 /* We must not use the ordinary copying code for this case,
2068 since `part' is an enum and copying it might not copy enough
2070 bcopy (event
, (char *) sp
, sizeof (*event
));
2074 sp
->code
= event
->code
;
2075 sp
->part
= event
->part
;
2076 sp
->frame_or_window
= event
->frame_or_window
;
2077 sp
->modifiers
= event
->modifiers
;
2080 sp
->timestamp
= event
->timestamp
;
2082 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[perd
->kbd_store_ptr
2084 = event
->frame_or_window
);
2086 perd
->kbd_store_ptr
++;
2090 /* Read one event from the event buffer, waiting if necessary.
2091 The value is a Lisp object representing the event.
2092 The value is nil for an event that should be ignored,
2093 or that was handled here.
2094 We always read and discard one event. */
2097 kbd_buffer_get_event ()
2110 /* Wait until there is input available. */
2113 perd
= find_active_event_queue ();
2114 if (perd
|| MOUSE_ACTIVITY_AVAILABLE
)
2117 /* If the quit flag is set, then read_char will return
2118 quit_char, so that counts as "available input." */
2119 if (!NILP (Vquit_flag
))
2120 quit_throw_to_read_char ();
2122 /* One way or another, wait until input is available; then, if
2123 interrupt handlers have not read it, read it now. */
2126 wait_for_kbd_input ();
2128 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2132 perd
= find_active_event_queue ();
2133 if (!(perd
|| MOUSE_ACTIVITY_AVAILABLE
))
2135 Lisp_Object minus_one
;
2137 XSETINT (minus_one
, -1);
2138 wait_reading_process_input (0, 0, minus_one
, 1);
2140 if (!interrupt_input
&& find_active_event_queue () == NULL
)
2141 /* Pass 1 for EXPECT since we just waited to have input. */
2142 read_avail_input (1);
2144 #endif /* not VMS */
2147 /* At this point, we know that there is a readable event available
2148 somewhere. If the event queue is empty, then there must be a
2149 mouse movement enabled and available. */
2152 struct input_event
*event
;
2154 event
= ((perd
->kbd_fetch_ptr
< perd
->kbd_buffer
+ KBD_BUFFER_SIZE
)
2155 ? perd
->kbd_fetch_ptr
2156 : perd
->kbd_buffer
);
2158 last_event_timestamp
= event
->timestamp
;
2162 /* These two kinds of events get special handling
2163 and don't actually appear to the command loop.
2164 We return nil for them. */
2165 if (event
->kind
== selection_request_event
)
2168 x_handle_selection_request (event
);
2169 perd
->kbd_fetch_ptr
= event
+ 1;
2171 /* We're getting selection request events, but we don't have
2177 else if (event
->kind
== selection_clear_event
)
2180 x_handle_selection_clear (event
);
2181 perd
->kbd_fetch_ptr
= event
+ 1;
2183 /* We're getting selection request events, but we don't have
2189 else if (event
->kind
== delete_window_event
)
2191 /* Make an event (delete-frame (FRAME)). */
2192 obj
= Fcons (event
->frame_or_window
, Qnil
);
2193 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
2194 perd
->kbd_fetch_ptr
= event
+ 1;
2196 else if (event
->kind
== iconify_event
)
2198 /* Make an event (iconify-frame (FRAME)). */
2199 obj
= Fcons (event
->frame_or_window
, Qnil
);
2200 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
2201 perd
->kbd_fetch_ptr
= event
+ 1;
2203 else if (event
->kind
== deiconify_event
)
2205 /* Make an event (make-frame-visible (FRAME)). */
2206 obj
= Fcons (event
->frame_or_window
, Qnil
);
2207 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
2208 perd
->kbd_fetch_ptr
= event
+ 1;
2211 else if (event
->kind
== menu_bar_event
)
2213 /* The event value is in the frame_or_window slot. */
2214 obj
= event
->frame_or_window
;
2215 perd
->kbd_fetch_ptr
= event
+ 1;
2217 else if (event
->kind
== buffer_switch_event
)
2219 /* The value doesn't matter here; only the type is tested. */
2220 XSETBUFFER (obj
, current_buffer
);
2221 perd
->kbd_fetch_ptr
= event
+ 1;
2223 /* Just discard these, by returning nil.
2224 (They shouldn't be found in the buffer,
2225 but on some machines it appears they do show up.) */
2226 else if (event
->kind
== no_event
)
2227 perd
->kbd_fetch_ptr
= event
+ 1;
2229 /* If this event is on a different frame, return a switch-frame this
2230 time, and leave the event in the queue for next time. */
2237 frame
= event
->frame_or_window
;
2238 if (WINDOWP (frame
))
2239 frame
= WINDOW_FRAME (XWINDOW (frame
));
2241 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2245 if (! EQ (frame
, internal_last_event_frame
)
2246 && XFRAME (frame
) != selected_frame
)
2247 obj
= make_lispy_switch_frame (frame
);
2248 internal_last_event_frame
= frame
;
2249 #endif /* MULTI_FRAME */
2251 /* If we didn't decide to make a switch-frame event, go ahead
2252 and build a real event from the queue entry. */
2256 obj
= make_lispy_event (event
);
2258 /* Wipe out this event, to catch bugs. */
2259 event
->kind
= no_event
;
2260 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- perd
->kbd_buffer
]
2263 perd
->kbd_fetch_ptr
= event
+ 1;
2268 /* Try generating a mouse motion event. */
2269 else if (FRAMEP (do_mouse_tracking
) && mouse_moved
)
2271 FRAME_PTR f
= XFRAME (do_mouse_tracking
);
2272 Lisp_Object bar_window
;
2273 enum scroll_bar_part part
;
2277 /* Note that this uses F to determine which display to look at.
2278 If there is no valid info, it does not store anything
2279 so x remains nil. */
2281 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
2286 /* Decide if we should generate a switch-frame event. Don't
2287 generate switch-frame events for motion outside of all Emacs
2293 frame
= FRAME_FOCUS_FRAME (f
);
2295 XSETFRAME (frame
, f
);
2297 if (! EQ (frame
, internal_last_event_frame
)
2298 && XFRAME (frame
) != selected_frame
)
2299 obj
= make_lispy_switch_frame (frame
);
2300 internal_last_event_frame
= frame
;
2304 /* If we didn't decide to make a switch-frame event, go ahead and
2305 return a mouse-motion event. */
2306 if (!NILP (x
) && NILP (obj
))
2307 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2309 #endif /* HAVE_MOUSE */
2311 /* We were promised by the above while loop that there was
2312 something for us to read! */
2315 input_pending
= readable_events ();
2318 Vlast_event_frame
= internal_last_event_frame
;
2324 /* Process any events that are not user-visible,
2325 then return, without reading any user-visible events. */
2331 while ((perd
= find_active_event_queue ()) != NULL
)
2333 struct input_event
*event
;
2335 event
= ((perd
->kbd_fetch_ptr
< perd
->kbd_buffer
+ KBD_BUFFER_SIZE
)
2336 ? perd
->kbd_fetch_ptr
2337 : perd
->kbd_buffer
);
2339 last_event_timestamp
= event
->timestamp
;
2341 /* These two kinds of events get special handling
2342 and don't actually appear to the command loop. */
2343 if (event
->kind
== selection_request_event
)
2346 x_handle_selection_request (event
);
2347 perd
->kbd_fetch_ptr
= event
+ 1;
2349 /* We're getting selection request events, but we don't have
2355 else if (event
->kind
== selection_clear_event
)
2358 x_handle_selection_clear (event
);
2359 perd
->kbd_fetch_ptr
= event
+ 1;
2361 /* We're getting selection request events, but we don't have
2370 get_input_pending (&input_pending
);
2373 /* Caches for modify_event_symbol. */
2374 static Lisp_Object accent_key_syms
;
2375 static Lisp_Object system_key_syms
;
2376 static Lisp_Object func_key_syms
;
2377 static Lisp_Object mouse_syms
;
2379 Lisp_Object Vsystem_key_alist
;
2381 /* This is a list of keysym codes for special "accent" characters.
2382 It parallels lispy_accent_keys. */
2384 static int lispy_accent_codes
[] =
2386 #ifdef XK_dead_circumflex
2391 #ifdef XK_dead_grave
2396 #ifdef XK_dead_tilde
2401 #ifdef XK_dead_diaeresis
2406 #ifdef XK_dead_macron
2411 #ifdef XK_dead_degree
2416 #ifdef XK_dead_acute
2421 #ifdef XK_dead_cedilla
2426 #ifdef XK_dead_breve
2431 #ifdef XK_dead_ogonek
2436 #ifdef XK_dead_caron
2441 #ifdef XK_dead_doubleacute
2442 XK_dead_doubleacute
,
2446 #ifdef XK_dead_abovedot
2453 /* This is a list of Lisp names for special "accent" characters.
2454 It parallels lispy_accent_codes. */
2456 static char *lispy_accent_keys
[] =
2473 /* You'll notice that this table is arranged to be conveniently
2474 indexed by X Windows keysym values. */
2475 static char *lispy_function_keys
[] =
2477 /* X Keysym value */
2479 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2487 0, 0, 0, /* 0xff10 */
2489 0, 0, 0, 0, 0, 0, 0,
2492 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2493 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2494 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2496 "home", /* 0xff50 */ /* IsCursorKey */
2507 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2518 "break", /* 0xff6b */
2520 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
2522 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2523 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2524 0, 0, 0, 0, 0, 0, 0, 0,
2525 "kp-tab", /* 0xff89 */
2527 "kp-enter", /* 0xff8d */
2529 "kp-f1", /* 0xff91 */
2533 "kp-home", /* 0xff95 */
2538 "kp-prior", /* kp-page-up */
2539 "kp-next", /* kp-page-down */
2545 0, 0, 0, 0, 0, 0, 0, 0, 0,
2546 "kp-multiply", /* 0xffaa */
2551 "kp-divide", /* 0xffaf */
2552 "kp-0", /* 0xffb0 */
2553 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2556 "kp-equal", /* 0xffbd */
2557 "f1", /* 0xffbe */ /* IsFunctionKey */
2559 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2560 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2561 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2562 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2563 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2564 0, 0, 0, 0, 0, 0, 0, 0,
2565 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2566 0, 0, 0, 0, 0, 0, 0, "delete"
2569 static char *lispy_mouse_names
[] =
2571 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2574 /* Scroll bar parts. */
2575 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2577 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2578 Lisp_Object
*scroll_bar_parts
[] = {
2579 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2583 /* A vector, indexed by button number, giving the down-going location
2584 of currently depressed buttons, both scroll bar and non-scroll bar.
2586 The elements have the form
2587 (BUTTON-NUMBER MODIFIER-MASK . REST)
2588 where REST is the cdr of a position as it would be reported in the event.
2590 The make_lispy_event function stores positions here to tell the
2591 difference between click and drag events, and to store the starting
2592 location to be included in drag events. */
2594 static Lisp_Object button_down_location
;
2596 /* Information about the most recent up-going button event: Which
2597 button, what location, and what time. */
2599 static int last_mouse_button
;
2600 static int last_mouse_x
;
2601 static int last_mouse_y
;
2602 static unsigned long button_down_time
;
2604 /* The maximum time between clicks to make a double-click,
2605 or Qnil to disable double-click detection,
2606 or Qt for no time limit. */
2607 Lisp_Object Vdouble_click_time
;
2609 /* The number of clicks in this multiple-click. */
2611 int double_click_count
;
2613 #ifdef USE_X_TOOLKIT
2614 extern Lisp_Object
map_event_to_object ();
2615 #endif /* USE_X_TOOLKIT */
2617 /* Given a struct input_event, build the lisp event which represents
2618 it. If EVENT is 0, build a mouse movement event from the mouse
2619 movement buffer, which should have a movement event in it.
2621 Note that events must be passed to this function in the order they
2622 are received; this function stores the location of button presses
2623 in order to build drag events when the button is released. */
2626 make_lispy_event (event
)
2627 struct input_event
*event
;
2631 switch (SWITCH_ENUM_CAST (event
->kind
))
2633 /* A simple keystroke. */
2634 case ascii_keystroke
:
2636 Lisp_Object lispy_c
;
2637 int c
= event
->code
& 0377;
2638 /* Turn ASCII characters into control characters
2640 if (event
->modifiers
& ctrl_modifier
)
2641 c
= make_ctrl_char (c
);
2643 /* Add in the other modifier bits. We took care of ctrl_modifier
2644 just above, and the shift key was taken care of by the X code,
2645 and applied to control characters by make_ctrl_char. */
2646 c
|= (event
->modifiers
2647 & (meta_modifier
| alt_modifier
2648 | hyper_modifier
| super_modifier
));
2649 button_down_time
= 0;
2650 XSETFASTINT (lispy_c
, c
);
2654 /* A function key. The symbol may need to have modifier prefixes
2656 case non_ascii_keystroke
:
2657 button_down_time
= 0;
2659 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
2660 if (event
->code
== lispy_accent_codes
[i
])
2661 return modify_event_symbol (i
,
2663 Qfunction_key
, Qnil
,
2664 lispy_accent_keys
, &accent_key_syms
,
2665 (sizeof (lispy_accent_keys
)
2666 / sizeof (lispy_accent_keys
[0])));
2668 /* Handle system-specific keysyms. */
2669 if (event
->code
& (1 << 28))
2671 /* We need to use an alist rather than a vector as the cache
2672 since we can't make a vector long enuf. */
2673 if (NILP (system_key_syms
))
2674 system_key_syms
= Fcons (Qnil
, Qnil
);
2675 return modify_event_symbol (event
->code
& 0xffffff,
2677 Qfunction_key
, Vsystem_key_alist
,
2678 0, &system_key_syms
, 0xffffff);
2681 return modify_event_symbol (event
->code
- 0xff00,
2683 Qfunction_key
, Qnil
,
2684 lispy_function_keys
, &func_key_syms
,
2685 (sizeof (lispy_function_keys
)
2686 / sizeof (lispy_function_keys
[0])));
2689 #if defined (MULTI_FRAME) || defined (HAVE_MOUSE)
2690 /* A mouse click. Figure out where it is, decide whether it's
2691 a press, click or drag, and build the appropriate structure. */
2693 case scroll_bar_click
:
2695 int button
= event
->code
;
2697 Lisp_Object position
;
2698 Lisp_Object
*start_pos_ptr
;
2699 Lisp_Object start_pos
;
2701 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2704 /* Build the position as appropriate for this mouse click. */
2705 if (event
->kind
== mouse_click
)
2708 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2713 /* Ignore mouse events that were made on frame that
2714 have been deleted. */
2715 if (! FRAME_LIVE_P (f
))
2718 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
2719 &column
, &row
, 0, 1);
2721 #ifndef USE_X_TOOLKIT
2722 /* In the non-toolkit version, clicks on the menu bar
2723 are ordinary button events in the event buffer.
2724 Distinguish them, and invoke the menu.
2726 (In the toolkit version, the toolkit handles the menu bar
2727 and Emacs doesn't know about it until after the user
2728 makes a selection.) */
2729 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
))
2731 Lisp_Object items
, item
;
2735 /* Activate the menu bar on the down event. If the
2736 up event comes in before the menu code can deal with it,
2738 if (! (event
->modifiers
& down_modifier
))
2742 items
= FRAME_MENU_BAR_ITEMS (f
);
2743 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 3)
2745 Lisp_Object pos
, string
;
2746 string
= XVECTOR (items
)->contents
[i
+ 1];
2747 pos
= XVECTOR (items
)->contents
[i
+ 2];
2750 if (column
>= XINT (pos
)
2751 && column
< XINT (pos
) + XSTRING (string
)->size
)
2753 item
= XVECTOR (items
)->contents
[i
];
2759 = Fcons (event
->frame_or_window
,
2761 Fcons (Fcons (event
->x
, event
->y
),
2762 Fcons (make_number (event
->timestamp
),
2765 return Fcons (item
, Fcons (position
, Qnil
));
2767 #endif /* not USE_X_TOOLKIT */
2769 window
= window_from_coordinates (f
, column
, row
, &part
);
2771 if (!WINDOWP (window
))
2773 window
= event
->frame_or_window
;
2778 int pixcolumn
, pixrow
;
2779 column
-= XINT (XWINDOW (window
)->left
);
2780 row
-= XINT (XWINDOW (window
)->top
);
2781 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
2782 XSETINT (event
->x
, pixcolumn
);
2783 XSETINT (event
->y
, pixrow
);
2788 posn
= Qvertical_line
;
2791 buffer_posn_from_coords (XWINDOW (window
),
2798 Fcons (Fcons (event
->x
, event
->y
),
2799 Fcons (make_number (event
->timestamp
),
2805 Lisp_Object portion_whole
;
2808 window
= event
->frame_or_window
;
2809 portion_whole
= Fcons (event
->x
, event
->y
);
2810 part
= *scroll_bar_parts
[(int) event
->part
];
2814 Fcons (Qvertical_scroll_bar
,
2815 Fcons (portion_whole
,
2816 Fcons (make_number (event
->timestamp
),
2817 Fcons (part
, Qnil
)))));
2820 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2822 start_pos
= *start_pos_ptr
;
2823 *start_pos_ptr
= Qnil
;
2825 is_double
= (button
== last_mouse_button
2826 && XINT (event
->x
) == last_mouse_x
2827 && XINT (event
->y
) == last_mouse_y
2828 && button_down_time
!= 0
2829 && (EQ (Vdouble_click_time
, Qt
)
2830 || (INTEGERP (Vdouble_click_time
)
2831 && ((int)(event
->timestamp
- button_down_time
)
2832 < XINT (Vdouble_click_time
)))));
2833 last_mouse_button
= button
;
2834 last_mouse_x
= XINT (event
->x
);
2835 last_mouse_y
= XINT (event
->y
);
2837 /* If this is a button press, squirrel away the location, so
2838 we can decide later whether it was a click or a drag. */
2839 if (event
->modifiers
& down_modifier
)
2843 double_click_count
++;
2844 event
->modifiers
|= ((double_click_count
> 2)
2849 double_click_count
= 1;
2850 button_down_time
= event
->timestamp
;
2851 *start_pos_ptr
= Fcopy_alist (position
);
2854 /* Now we're releasing a button - check the co-ordinates to
2855 see if this was a click or a drag. */
2856 else if (event
->modifiers
& up_modifier
)
2858 /* If we did not see a down before this up,
2859 ignore the up. Probably this happened because
2860 the down event chose a menu item.
2861 It would be an annoyance to treat the release
2862 of the button that chose the menu item
2863 as a separate event. */
2865 if (!CONSP (start_pos
))
2868 event
->modifiers
&= ~up_modifier
;
2869 #if 0 /* Formerly we treated an up with no down as a click event. */
2870 if (!CONSP (start_pos
))
2871 event
->modifiers
|= click_modifier
;
2875 /* The third element of every position should be the (x,y)
2879 down
= Fnth (make_number (2), start_pos
);
2880 if (EQ (event
->x
, XCONS (down
)->car
)
2881 && EQ (event
->y
, XCONS (down
)->cdr
))
2883 event
->modifiers
|= click_modifier
;
2887 button_down_time
= 0;
2888 event
->modifiers
|= drag_modifier
;
2890 /* Don't check is_double; treat this as multiple
2891 if the down-event was multiple. */
2892 if (double_click_count
> 1)
2893 event
->modifiers
|= ((double_click_count
> 2)
2899 /* Every mouse event should either have the down_modifier or
2900 the up_modifier set. */
2904 /* Get the symbol we should use for the mouse click. */
2907 head
= modify_event_symbol (button
,
2910 lispy_mouse_names
, &mouse_syms
,
2911 (sizeof (lispy_mouse_names
)
2912 / sizeof (lispy_mouse_names
[0])));
2913 if (event
->modifiers
& drag_modifier
)
2918 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2921 Fcons (make_number (double_click_count
),
2929 #endif /* MULTI_FRAME or HAVE_MOUSE */
2931 /* The 'kind' field of the event is something we don't recognize. */
2937 #if defined (MULTI_FRAME) || defined (HAVE_MOUSE)
2940 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2942 Lisp_Object bar_window
;
2943 enum scroll_bar_part part
;
2948 /* Is it a scroll bar movement? */
2949 if (frame
&& ! NILP (bar_window
))
2951 Lisp_Object part_sym
;
2953 part_sym
= *scroll_bar_parts
[(int) part
];
2954 return Fcons (Qscroll_bar_movement
,
2955 (Fcons (Fcons (bar_window
,
2956 Fcons (Qvertical_scroll_bar
,
2957 Fcons (Fcons (x
, y
),
2958 Fcons (make_number (time
),
2964 /* Or is it an ordinary mouse movement? */
2966 #endif /* MULTI_FRAME */
2979 /* It's in a frame; which window on that frame? */
2980 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
, 0, 1);
2981 window
= window_from_coordinates (frame
, column
, row
, &area
);
2986 if (WINDOWP (window
))
2988 int pixcolumn
, pixrow
;
2989 column
-= XINT (XWINDOW (window
)->left
);
2990 row
-= XINT (XWINDOW (window
)->top
);
2991 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
2992 XSETINT (x
, pixcolumn
);
2993 XSETINT (y
, pixrow
);
2998 posn
= Qvertical_line
;
3001 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
3004 else if (frame
!= 0)
3006 XSETFRAME (window
, frame
);
3018 return Fcons (Qmouse_movement
,
3019 Fcons (Fcons (window
,
3021 Fcons (Fcons (x
, y
),
3022 Fcons (make_number (time
),
3028 #endif /* neither MULTI_FRAME nor HAVE_MOUSE */
3030 /* Construct a switch frame event. */
3032 make_lispy_switch_frame (frame
)
3035 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
3038 /* Manipulating modifiers. */
3040 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
3042 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
3043 SYMBOL's name of the end of the modifiers; the string from this
3044 position is the unmodified symbol name.
3046 This doesn't use any caches. */
3048 parse_modifiers_uncached (symbol
, modifier_end
)
3052 struct Lisp_String
*name
;
3056 CHECK_SYMBOL (symbol
, 1);
3059 name
= XSYMBOL (symbol
)->name
;
3062 for (i
= 0; i
+2 <= name
->size
; )
3063 switch (name
->data
[i
])
3065 #define SINGLE_LETTER_MOD(bit) \
3066 if (name->data[i+1] != '-') \
3067 goto no_more_modifiers; \
3072 SINGLE_LETTER_MOD (alt_modifier
);
3076 SINGLE_LETTER_MOD (ctrl_modifier
);
3080 SINGLE_LETTER_MOD (hyper_modifier
);
3084 SINGLE_LETTER_MOD (meta_modifier
);
3088 SINGLE_LETTER_MOD (shift_modifier
);
3092 SINGLE_LETTER_MOD (super_modifier
);
3096 if (i
+ 5 > name
->size
)
3097 goto no_more_modifiers
;
3098 if (! strncmp (name
->data
+ i
, "drag-", 5))
3100 modifiers
|= drag_modifier
;
3103 else if (! strncmp (name
->data
+ i
, "down-", 5))
3105 modifiers
|= down_modifier
;
3108 else if (i
+ 7 <= name
->size
3109 && ! strncmp (name
->data
+ i
, "double-", 7))
3111 modifiers
|= double_modifier
;
3115 goto no_more_modifiers
;
3119 if (i
+ 7 > name
->size
)
3120 goto no_more_modifiers
;
3121 if (! strncmp (name
->data
+ i
, "triple-", 7))
3123 modifiers
|= triple_modifier
;
3127 goto no_more_modifiers
;
3131 goto no_more_modifiers
;
3133 #undef SINGLE_LETTER_MOD
3137 /* Should we include the `click' modifier? */
3138 if (! (modifiers
& (down_modifier
| drag_modifier
3139 | double_modifier
| triple_modifier
))
3140 && i
+ 7 == name
->size
3141 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
3142 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
3143 modifiers
|= click_modifier
;
3152 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
3153 prepended to the string BASE[0..BASE_LEN-1].
3154 This doesn't use any caches. */
3156 apply_modifiers_uncached (modifiers
, base
, base_len
)
3161 /* Since BASE could contain nulls, we can't use intern here; we have
3162 to use Fintern, which expects a genuine Lisp_String, and keeps a
3165 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
3171 /* Only the event queue may use the `up' modifier; it should always
3172 be turned into a click or drag event before presented to lisp code. */
3173 if (modifiers
& up_modifier
)
3176 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
3177 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
3178 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
3179 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
3180 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
3181 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
3182 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
3183 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
3184 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
3185 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
3186 /* The click modifier is denoted by the absence of other modifiers. */
3190 mod_len
= p
- new_mods
;
3194 Lisp_Object new_name
;
3196 new_name
= make_uninit_string (mod_len
+ base_len
);
3197 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
3198 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
3200 return Fintern (new_name
, Qnil
);
3205 static char *modifier_names
[] =
3207 "up", "down", "drag", "click", "double", "triple", 0, 0,
3208 0, 0, 0, 0, 0, 0, 0, 0,
3209 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
3211 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
3213 static Lisp_Object modifier_symbols
;
3215 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
3217 lispy_modifier_list (modifiers
)
3220 Lisp_Object modifier_list
;
3223 modifier_list
= Qnil
;
3224 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
3225 if (modifiers
& (1<<i
))
3226 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
3229 return modifier_list
;
3233 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
3234 where UNMODIFIED is the unmodified form of SYMBOL,
3235 MASK is the set of modifiers present in SYMBOL's name.
3236 This is similar to parse_modifiers_uncached, but uses the cache in
3237 SYMBOL's Qevent_symbol_element_mask property, and maintains the
3238 Qevent_symbol_elements property. */
3240 parse_modifiers (symbol
)
3243 Lisp_Object elements
;
3245 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
3246 if (CONSP (elements
))
3251 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
3252 Lisp_Object unmodified
;
3255 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
3256 XSYMBOL (symbol
)->name
->size
- end
),
3259 if (modifiers
& ~((1<<VALBITS
) - 1))
3261 XSETFASTINT (mask
, modifiers
);
3262 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
3264 /* Cache the parsing results on SYMBOL. */
3265 Fput (symbol
, Qevent_symbol_element_mask
,
3267 Fput (symbol
, Qevent_symbol_elements
,
3268 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
3270 /* Since we know that SYMBOL is modifiers applied to unmodified,
3271 it would be nice to put that in unmodified's cache.
3272 But we can't, since we're not sure that parse_modifiers is
3279 /* Apply the modifiers MODIFIERS to the symbol BASE.
3280 BASE must be unmodified.
3282 This is like apply_modifiers_uncached, but uses BASE's
3283 Qmodifier_cache property, if present. It also builds
3284 Qevent_symbol_elements properties, since it has that info anyway.
3286 apply_modifiers copies the value of BASE's Qevent_kind property to
3287 the modified symbol. */
3289 apply_modifiers (modifiers
, base
)
3293 Lisp_Object cache
, index
, entry
, new_symbol
;
3295 /* Mask out upper bits. We don't know where this value's been. */
3296 modifiers
&= (1<<VALBITS
) - 1;
3298 /* The click modifier never figures into cache indices. */
3299 cache
= Fget (base
, Qmodifier_cache
);
3300 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
3301 entry
= assq_no_quit (index
, cache
);
3304 new_symbol
= XCONS (entry
)->cdr
;
3307 /* We have to create the symbol ourselves. */
3308 new_symbol
= apply_modifiers_uncached (modifiers
,
3309 XSYMBOL (base
)->name
->data
,
3310 XSYMBOL (base
)->name
->size
);
3312 /* Add the new symbol to the base's cache. */
3313 entry
= Fcons (index
, new_symbol
);
3314 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
3316 /* We have the parsing info now for free, so add it to the caches. */
3317 XSETFASTINT (index
, modifiers
);
3318 Fput (new_symbol
, Qevent_symbol_element_mask
,
3319 Fcons (base
, Fcons (index
, Qnil
)));
3320 Fput (new_symbol
, Qevent_symbol_elements
,
3321 Fcons (base
, lispy_modifier_list (modifiers
)));
3324 /* Make sure this symbol is of the same kind as BASE.
3326 You'd think we could just set this once and for all when we
3327 intern the symbol above, but reorder_modifiers may call us when
3328 BASE's property isn't set right; we can't assume that just
3329 because it has a Qmodifier_cache property it must have its
3330 Qevent_kind set right as well. */
3331 if (NILP (Fget (new_symbol
, Qevent_kind
)))
3335 kind
= Fget (base
, Qevent_kind
);
3337 Fput (new_symbol
, Qevent_kind
, kind
);
3344 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
3345 return a symbol with the modifiers placed in the canonical order.
3346 Canonical order is alphabetical, except for down and drag, which
3347 always come last. The 'click' modifier is never written out.
3349 Fdefine_key calls this to make sure that (for example) C-M-foo
3350 and M-C-foo end up being equivalent in the keymap. */
3353 reorder_modifiers (symbol
)
3356 /* It's hopefully okay to write the code this way, since everything
3357 will soon be in caches, and no consing will be done at all. */
3360 parsed
= parse_modifiers (symbol
);
3361 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
3362 XCONS (parsed
)->car
);
3366 /* For handling events, we often want to produce a symbol whose name
3367 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
3368 to some base, like the name of a function key or mouse button.
3369 modify_event_symbol produces symbols of this sort.
3371 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
3372 is the name of the i'th symbol. TABLE_SIZE is the number of elements
3375 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
3376 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
3378 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
3379 persist between calls to modify_event_symbol that it can use to
3380 store a cache of the symbols it's generated for this NAME_TABLE
3381 before. The object stored there may be a vector or an alist.
3383 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
3385 MODIFIERS is a set of modifier bits (as given in struct input_events)
3386 whose prefixes should be applied to the symbol name.
3388 SYMBOL_KIND is the value to be placed in the event_kind property of
3389 the returned symbol.
3391 The symbols we create are supposed to have an
3392 `event-symbol-elements' property, which lists the modifiers present
3393 in the symbol's name. */
3396 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
3397 name_table
, symbol_table
, table_size
)
3400 Lisp_Object symbol_kind
;
3401 Lisp_Object name_alist
;
3403 Lisp_Object
*symbol_table
;
3407 Lisp_Object symbol_int
;
3409 XSETINT (symbol_int
, symbol_num
);
3411 /* Is this a request for a valid symbol? */
3412 if (symbol_num
< 0 || symbol_num
>= table_size
)
3415 if (CONSP (*symbol_table
))
3416 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
3418 /* If *symbol_table doesn't seem to be initialized properly, fix that.
3419 *symbol_table should be a lisp vector TABLE_SIZE elements long,
3420 where the Nth element is the symbol for NAME_TABLE[N], or nil if
3421 we've never used that symbol before. */
3424 if (! VECTORP (*symbol_table
)
3425 || XVECTOR (*symbol_table
)->size
!= table_size
)
3429 XSETFASTINT (size
, table_size
);
3430 *symbol_table
= Fmake_vector (size
, Qnil
);
3433 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
3436 /* Have we already used this symbol before? */
3439 /* No; let's create it. */
3440 if (!NILP (name_alist
))
3441 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
3442 else if (name_table
[symbol_num
])
3443 value
= intern (name_table
[symbol_num
]);
3448 sprintf (buf
, "key-%d", symbol_num
);
3449 value
= intern (buf
);
3452 if (CONSP (*symbol_table
))
3453 *symbol_table
= Fcons (value
, *symbol_table
);
3455 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
3457 /* Fill in the cache entries for this symbol; this also
3458 builds the Qevent_symbol_elements property, which the user
3460 apply_modifiers (modifiers
& click_modifier
, value
);
3461 Fput (value
, Qevent_kind
, symbol_kind
);
3464 /* Apply modifiers to that symbol. */
3465 return apply_modifiers (modifiers
, value
);
3469 /* Store into *addr a value nonzero if terminal input chars are available.
3470 Serves the purpose of ioctl (0, FIONREAD, addr)
3471 but works even if FIONREAD does not exist.
3472 (In fact, this may actually read some input.) */
3475 get_input_pending (addr
)
3478 /* First of all, have we already counted some input? */
3479 *addr
= !NILP (Vquit_flag
) || readable_events ();
3481 /* If input is being read as it arrives, and we have none, there is none. */
3482 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
3485 /* Try to read some input and see how much we get. */
3487 *addr
= !NILP (Vquit_flag
) || readable_events ();
3490 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
3493 gobble_input (expected
)
3498 if (interrupt_input
)
3501 mask
= sigblockx (SIGIO
);
3502 read_avail_input (expected
);
3506 #ifdef POLL_FOR_INPUT
3507 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
3510 mask
= sigblockx (SIGALRM
);
3511 read_avail_input (expected
);
3517 read_avail_input (expected
);
3521 /* Put a buffer_switch_event in the buffer
3522 so that read_key_sequence will notice the new current buffer. */
3524 record_asynch_buffer_change ()
3526 struct input_event event
;
3529 event
.kind
= buffer_switch_event
;
3530 event
.frame_or_window
= Qnil
;
3533 /* We don't need a buffer-switch event unless Emacs is waiting for input.
3534 The purpose of the event is to make read_key_sequence look up the
3535 keymaps again. If we aren't in read_key_sequence, we don't need one,
3536 and the event could cause trouble by messing up (input-pending-p). */
3537 tem
= Fwaiting_for_user_input_p ();
3541 /* We never need these events if we have no asynchronous subprocesses. */
3545 /* Make sure no interrupt happens while storing the event. */
3547 if (interrupt_input
)
3550 mask
= sigblockx (SIGIO
);
3551 kbd_buffer_store_event (&event
);
3558 kbd_buffer_store_event (&event
);
3565 /* Read any terminal input already buffered up by the system
3566 into the kbd_buffer, but do not wait.
3568 EXPECTED should be nonzero if the caller knows there is some input.
3570 Except on VMS, all input is read by this function.
3571 If interrupt_input is nonzero, this function MUST be called
3572 only when SIGIO is blocked.
3574 Returns the number of keyboard chars read, or -1 meaning
3575 this is a bad time to try to read input. */
3578 read_avail_input (expected
)
3581 struct input_event buf
[KBD_BUFFER_SIZE
];
3585 if (read_socket_hook
)
3586 /* No need for FIONREAD or fcntl; just say don't wait. */
3587 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
,
3588 expected
, expected
);
3591 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
3592 the kbd_buffer can really hold. That may prevent loss
3593 of characters on some systems when input is stuffed at us. */
3594 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
3597 /* Determine how many characters we should *try* to read. */
3600 #else /* not WINDOWSNT */
3602 n_to_read
= dos_keysns ();
3605 #else /* not MSDOS */
3607 /* Find out how much input is available. */
3608 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
3609 /* Formerly simply reported no input, but that sometimes led to
3610 a failure of Emacs to terminate.
3611 SIGHUP seems appropriate if we can't reach the terminal. */
3612 /* ??? Is it really right to send the signal just to this process
3613 rather than to the whole process group?
3614 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3615 kill (getpid (), SIGHUP
);
3618 if (n_to_read
> sizeof cbuf
)
3619 n_to_read
= sizeof cbuf
;
3620 #else /* no FIONREAD */
3621 #if defined(USG) || defined(DGUX)
3622 /* Read some input if available, but don't wait. */
3623 n_to_read
= sizeof cbuf
;
3624 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
3629 #endif /* not MSDOS */
3630 #endif /* not WINDOWSNT */
3632 /* Now read; for one reason or another, this will not block.
3633 NREAD is set to the number of chars read. */
3637 cbuf
[0] = dos_keyread();
3640 nread
= read (input_fd
, cbuf
, n_to_read
);
3642 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
3643 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3644 This looks incorrect, but it isn't, because _BSD causes
3645 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3646 and that causes a value other than 0 when there is no input. */
3652 /* We used to retry the read if it was interrupted.
3653 But this does the wrong thing when O_NDELAY causes
3654 an EAGAIN error. Does anybody know of a situation
3655 where a retry is actually needed? */
3657 nread
< 0 && (errno
== EAGAIN
3671 #if defined (USG) || defined (DGUX)
3672 fcntl (input_fd
, F_SETFL
, 0);
3673 #endif /* USG or DGUX */
3674 #endif /* no FIONREAD */
3675 for (i
= 0; i
< nread
; i
++)
3677 buf
[i
].kind
= ascii_keystroke
;
3678 buf
[i
].modifiers
= 0;
3679 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3680 buf
[i
].modifiers
= meta_modifier
;
3684 buf
[i
].code
= cbuf
[i
];
3686 XSETFRAME (buf
[i
].frame_or_window
, selected_frame
);
3688 buf
[i
].frame_or_window
= Qnil
;
3693 /* Scan the chars for C-g and store them in kbd_buffer. */
3694 for (i
= 0; i
< nread
; i
++)
3696 kbd_buffer_store_event (&buf
[i
]);
3697 /* Don't look at input that follows a C-g too closely.
3698 This reduces lossage due to autorepeat on C-g. */
3699 if (buf
[i
].kind
== ascii_keystroke
3700 && buf
[i
].code
== quit_char
)
3706 #endif /* not VMS */
3708 #ifdef SIGIO /* for entire page */
3709 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3712 input_available_signal (signo
)
3715 /* Must preserve main program's value of errno. */
3716 int old_errno
= errno
;
3718 extern int select_alarmed
;
3722 /* USG systems forget handlers when they are used;
3723 must reestablish each time */
3724 signal (signo
, input_available_signal
);
3731 if (input_available_clear_time
)
3732 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3737 nread
= read_avail_input (1);
3738 /* -1 means it's not ok to read the input now.
3739 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3740 0 means there was no keyboard input available. */
3745 select_alarmed
= 1; /* Force the select emulator back to life */
3756 /* Send ourselves a SIGIO.
3758 This function exists so that the UNBLOCK_INPUT macro in
3759 blockinput.h can have some way to take care of input we put off
3760 dealing with, without assuming that every file which uses
3761 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3763 reinvoke_input_signal ()
3772 /* Return the prompt-string of a sparse keymap.
3773 This is the first element which is a string.
3774 Return nil if there is none. */
3782 register Lisp_Object tem
;
3791 static void menu_bar_item ();
3792 static void menu_bar_one_keymap ();
3794 /* These variables hold the vector under construction within
3795 menu_bar_items and its subroutines, and the current index
3796 for storing into that vector. */
3797 static Lisp_Object menu_bar_items_vector
;
3798 static int menu_bar_items_index
;
3800 /* Return a vector of menu items for a menu bar, appropriate
3801 to the current buffer. Each item has three elements in the vector:
3804 OLD is an old vector we can optionally reuse, or nil. */
3807 menu_bar_items (old
)
3810 /* The number of keymaps we're scanning right now, and the number of
3811 keymaps we have allocated space for. */
3814 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3815 in the current keymaps, or nil where it is not a prefix. */
3818 Lisp_Object def
, tem
, tail
;
3827 struct gcpro gcpro1
;
3829 /* In order to build the menus, we need to call the keymap
3830 accessors. They all call QUIT. But this function is called
3831 during redisplay, during which a quit is fatal. So inhibit
3832 quitting while building the menus.
3833 We do this instead of specbind because (1) errors will clear it anyway
3834 and (2) this avoids risk of specpdl overflow. */
3835 oquit
= Vinhibit_quit
;
3839 menu_bar_items_vector
= old
;
3841 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
3842 menu_bar_items_index
= 0;
3844 GCPRO1 (menu_bar_items_vector
);
3846 /* Build our list of keymaps.
3847 If we recognize a function key and replace its escape sequence in
3848 keybuf with its symbol, or if the sequence starts with a mouse
3849 click and we need to switch buffers, we jump back here to rebuild
3850 the initial keymaps from the current buffer. */
3854 /* Should overriding-local-map apply, here? */
3855 if (!NILP (Voverriding_local_map_menu_flag
))
3857 if (NILP (Voverriding_local_map
))
3859 /* Yes, and it is nil. Use just global map. */
3861 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3865 /* Yes, and it is non-nil. Use it and the global map. */
3867 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3868 maps
[0] = Voverriding_local_map
;
3873 /* No, so use major and minor mode keymaps. */
3874 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3875 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3876 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3877 #ifdef USE_TEXT_PROPERTIES
3878 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3880 maps
[nmaps
-2] = current_buffer
->keymap
;
3883 maps
[nmaps
-1] = current_global_map
;
3886 /* Look up in each map the dummy prefix key `menu-bar'. */
3890 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3892 if (! NILP (maps
[mapno
]))
3893 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3897 tem
= Fkeymapp (def
);
3899 menu_bar_one_keymap (def
);
3902 /* Move to the end those items that should be at the end. */
3904 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3907 int end
= menu_bar_items_index
;
3909 for (i
= 0; i
< end
; i
+= 3)
3910 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3912 Lisp_Object tem0
, tem1
, tem2
;
3913 /* Move the item at index I to the end,
3914 shifting all the others forward. */
3915 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
3916 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
3917 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
3919 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
3920 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
3921 (end
- i
- 3) * sizeof (Lisp_Object
));
3922 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem0
;
3923 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem1
;
3924 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem2
;
3929 /* Add nil, nil, nil at the end. */
3930 i
= menu_bar_items_index
;
3931 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
3934 int newsize
= 2 * i
;
3935 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
3936 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
3937 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
3938 menu_bar_items_vector
= tem
;
3940 /* Add this item. */
3941 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3942 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3943 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3944 menu_bar_items_index
= i
;
3946 Vinhibit_quit
= oquit
;
3948 return menu_bar_items_vector
;
3951 /* Scan one map KEYMAP, accumulating any menu items it defines
3952 in menu_bar_items_vector. */
3955 menu_bar_one_keymap (keymap
)
3958 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3960 /* Loop over all keymap entries that have menu strings. */
3961 for (tail
= keymap
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3963 item
= XCONS (tail
)->car
;
3966 key
= XCONS (item
)->car
;
3967 binding
= XCONS (item
)->cdr
;
3968 if (CONSP (binding
))
3970 item_string
= XCONS (binding
)->car
;
3971 if (STRINGP (item_string
))
3972 menu_bar_item (key
, item_string
, Fcdr (binding
));
3974 else if (EQ (binding
, Qundefined
))
3975 menu_bar_item (key
, Qnil
, binding
);
3977 else if (VECTORP (item
))
3979 /* Loop over the char values represented in the vector. */
3980 int len
= XVECTOR (item
)->size
;
3982 for (c
= 0; c
< len
; c
++)
3984 Lisp_Object character
;
3985 XSETFASTINT (character
, c
);
3986 binding
= XVECTOR (item
)->contents
[c
];
3987 if (CONSP (binding
))
3989 item_string
= XCONS (binding
)->car
;
3990 if (STRINGP (item_string
))
3991 menu_bar_item (key
, item_string
, Fcdr (binding
));
3993 else if (EQ (binding
, Qundefined
))
3994 menu_bar_item (key
, Qnil
, binding
);
4000 /* This is used as the handler when calling internal_condition_case_1. */
4003 menu_bar_item_1 (arg
)
4009 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
4010 If there's already an item for KEY, add this DEF to it. */
4013 menu_bar_item (key
, item_string
, def
)
4014 Lisp_Object key
, item_string
, def
;
4017 Lisp_Object enabled
;
4020 if (EQ (def
, Qundefined
))
4022 /* If a map has an explicit `undefined' as definition,
4023 discard any previously made menu bar item. */
4025 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
4026 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
4028 if (menu_bar_items_index
> i
+ 3)
4029 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
4030 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
4031 (menu_bar_items_index
- i
- 3) * sizeof (Lisp_Object
));
4032 menu_bar_items_index
-= 3;
4036 /* If there's no definition for this key yet,
4037 just ignore `undefined'. */
4041 /* See if this entry is enabled. */
4046 /* No property, or nil, means enable.
4047 Otherwise, enable if value is not nil. */
4048 tem
= Fget (def
, Qmenu_enable
);
4050 /* (condition-case nil (eval tem)
4052 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
4056 /* Ignore this item if it's not enabled. */
4060 /* Find any existing item for this KEY. */
4061 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
4062 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
4065 /* If we did not find this KEY, add it at the end. */
4066 if (i
== menu_bar_items_index
)
4068 /* If vector is too small, get a bigger one. */
4069 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
4072 int newsize
= 2 * i
;
4073 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
4074 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
4075 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
4076 menu_bar_items_vector
= tem
;
4078 /* Add this item. */
4079 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
4080 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
4081 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (def
, Qnil
);
4082 menu_bar_items_index
= i
;
4084 /* We did find an item for this KEY. Add DEF to its list of maps. */
4088 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
4089 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (def
, old
);
4093 /* Read a character using menus based on maps in the array MAPS.
4094 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
4095 Return t if we displayed a menu but the user rejected it.
4097 PREV_EVENT is the previous input event, or nil if we are reading
4098 the first event of a key sequence.
4100 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
4101 if we used a mouse menu to read the input, or zero otherwise. If
4102 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
4104 The prompting is done based on the prompt-string of the map
4105 and the strings associated with various map elements.
4107 This can be done with X menus or with menus put in the minibuf.
4108 These are done in different ways, depending on how the input will be read.
4109 Menus using X are done after auto-saving in read-char, getting the input
4110 event from Fx_popup_menu; menus using the minibuf use read_char recursively
4111 and do auto-saving in the inner call of read_char. */
4114 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
4117 Lisp_Object prev_event
;
4118 int *used_mouse_menu
;
4121 register Lisp_Object name
;
4122 Lisp_Object rest
, vector
;
4124 if (used_mouse_menu
)
4125 *used_mouse_menu
= 0;
4127 /* Use local over global Menu maps */
4129 if (! menu_prompting
)
4132 /* Optionally disregard all but the global map. */
4133 if (inhibit_local_menu_bar_menus
)
4135 maps
+= (nmaps
- 1);
4139 /* Get the menu name from the first map that has one (a prompt string). */
4140 for (mapno
= 0; mapno
< nmaps
; mapno
++)
4142 name
= map_prompt (maps
[mapno
]);
4147 /* If we don't have any menus, just read a character normally. */
4151 #if (defined (HAVE_X_WINDOWS) && defined (HAVE_X_MENU)) || defined (MSDOS)
4152 /* If we got to this point via a mouse click,
4153 use a real menu for mouse selection. */
4154 if (EVENT_HAS_PARAMETERS (prev_event
))
4156 /* Display the menu and get the selection. */
4157 Lisp_Object
*realmaps
4158 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
4162 /* Use the maps that are not nil. */
4163 for (mapno
= 0; mapno
< nmaps
; mapno
++)
4164 if (!NILP (maps
[mapno
]))
4165 realmaps
[nmaps1
++] = maps
[mapno
];
4167 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
4170 /* If we got more than one event, put all but the first
4171 onto this list to be read later.
4172 Return just the first event now. */
4173 Vunread_command_events
4174 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
4175 value
= XCONS (value
)->car
;
4177 else if (NILP (value
))
4179 if (used_mouse_menu
)
4180 *used_mouse_menu
= 1;
4183 #endif /* (HAVE_X_WINDOWS && HAVE_X_MENU) || MSDOS */
4188 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
4194 register Lisp_Object name
;
4196 int width
= FRAME_WIDTH (selected_frame
) - 4;
4197 char *menu
= (char *) alloca (width
+ 4);
4200 Lisp_Object rest
, vector
;
4202 if (! menu_prompting
)
4205 /* Get the menu name from the first map that has one (a prompt string). */
4206 for (mapno
= 0; mapno
< nmaps
; mapno
++)
4208 name
= map_prompt (maps
[mapno
]);
4213 /* If we don't have any menus, just read a character normally. */
4217 /* Prompt string always starts with map's prompt, and a space. */
4218 strcpy (menu
, XSTRING (name
)->data
);
4219 nlength
= XSTRING (name
)->size
;
4220 menu
[nlength
++] = ':';
4221 menu
[nlength
++] = ' ';
4224 /* Start prompting at start of first map. */
4228 /* Present the documented bindings, a line at a time. */
4235 int orig_defn_macro
;
4237 /* Loop over elements of map. */
4242 /* If reached end of map, start at beginning of next map. */
4246 /* At end of last map, wrap around to first map if just starting,
4247 or end this line if already have something on it. */
4251 if (notfirst
|| nobindings
) break;
4256 /* Look at the next element of the map. */
4258 elt
= XVECTOR (vector
)->contents
[idx
];
4260 elt
= Fcar_safe (rest
);
4262 if (idx
< 0 && VECTORP (elt
))
4264 /* If we found a dense table in the keymap,
4265 advanced past it, but start scanning its contents. */
4266 rest
= Fcdr_safe (rest
);
4272 /* An ordinary element. */
4274 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
4276 s
= Fcar_safe(elt
); /* vector */
4278 /* Ignore the element if it has no prompt string. */
4280 /* If we have room for the prompt string, add it to this line.
4281 If this is the first on the line, always add it. */
4282 else if (XSTRING (s
)->size
+ i
+ 2 < width
4287 /* Punctuate between strings. */
4290 strcpy (menu
+ i
, ", ");
4296 /* Add as much of string as fits. */
4297 thiswidth
= XSTRING (s
)->size
;
4298 if (thiswidth
+ i
> width
)
4299 thiswidth
= width
- i
;
4300 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
4306 /* If this element does not fit, end the line now,
4307 and save the element for the next line. */
4308 strcpy (menu
+ i
, "...");
4312 /* Move past this element. */
4313 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
4314 /* Handle reaching end of dense table. */
4319 rest
= Fcdr_safe (rest
);
4323 /* Prompt with that and read response. */
4326 /* Make believe its not a keyboard macro in case the help char
4327 is pressed. Help characters are not recorded because menu prompting
4328 is not used on replay.
4330 orig_defn_macro
= defining_kbd_macro
;
4331 defining_kbd_macro
= 0 ;
4333 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
4334 while (BUFFERP (obj
));
4335 defining_kbd_macro
= orig_defn_macro
;
4337 if (!INTEGERP (obj
))
4342 if (! EQ (obj
, menu_prompt_more_char
)
4343 && (!INTEGERP (menu_prompt_more_char
)
4344 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
4346 if ( defining_kbd_macro
)
4347 store_kbd_macro_char(obj
) ;
4350 /* Help char - go round again */
4354 /* Reading key sequences. */
4356 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
4357 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
4358 keymap, or nil otherwise. Return the index of the first keymap in
4359 which KEY has any binding, or NMAPS if no map has a binding.
4361 If KEY is a meta ASCII character, treat it like meta-prefix-char
4362 followed by the corresponding non-meta character. Keymaps in
4363 CURRENT with non-prefix bindings for meta-prefix-char become nil in
4366 If KEY has no bindings in any of the CURRENT maps, NEXT is left
4369 NEXT may == CURRENT. */
4372 follow_key (key
, nmaps
, current
, defs
, next
)
4374 Lisp_Object
*current
, *defs
, *next
;
4377 int i
, first_binding
;
4379 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
4380 followed by the corresponding non-meta character. */
4381 if (INTEGERP (key
) && (XINT (key
) & CHAR_META
))
4383 for (i
= 0; i
< nmaps
; i
++)
4384 if (! NILP (current
[i
]))
4387 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
4389 /* Note that since we pass the resulting bindings through
4390 get_keymap_1, non-prefix bindings for meta-prefix-char
4392 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
4398 XSETINT (key
, XFASTINT (key
) & ~CHAR_META
);
4401 first_binding
= nmaps
;
4402 for (i
= nmaps
- 1; i
>= 0; i
--)
4404 if (! NILP (current
[i
]))
4406 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
4407 if (! NILP (defs
[i
]))
4414 /* Given the set of bindings we've found, produce the next set of maps. */
4415 if (first_binding
< nmaps
)
4416 for (i
= 0; i
< nmaps
; i
++)
4417 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
4419 return first_binding
;
4422 /* Read a sequence of keys that ends with a non prefix character,
4423 storing it in KEYBUF, a buffer of size BUFSIZE.
4425 Return the length of the key sequence stored.
4426 Return -1 if the user rejected a command menu.
4428 Echo starting immediately unless `prompt' is 0.
4430 Where a key sequence ends depends on the currently active keymaps.
4431 These include any minor mode keymaps active in the current buffer,
4432 the current buffer's local map, and the global map.
4434 If a key sequence has no other bindings, we check Vfunction_key_map
4435 to see if some trailing subsequence might be the beginning of a
4436 function key's sequence. If so, we try to read the whole function
4437 key, and substitute its symbolic name into the key sequence.
4439 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
4440 `double-' events into similar click events, if that would make them
4441 bound. We try to turn `triple-' events first into `double-' events,
4444 If we get a mouse click in a mode line, vertical divider, or other
4445 non-text area, we treat the click as if it were prefixed by the
4446 symbol denoting that area - `mode-line', `vertical-line', or
4449 If the sequence starts with a mouse click, we read the key sequence
4450 with respect to the buffer clicked on, not the current buffer.
4452 If the user switches frames in the midst of a key sequence, we put
4453 off the switch-frame event until later; the next call to
4454 read_char will return it. */
4457 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
)
4458 Lisp_Object
*keybuf
;
4461 int dont_downcase_last
;
4463 int count
= specpdl_ptr
- specpdl
;
4465 /* How many keys there are in the current key sequence. */
4468 /* The length of the echo buffer when we started reading, and
4469 the length of this_command_keys when we started reading. */
4473 /* The number of keymaps we're scanning right now, and the number of
4474 keymaps we have allocated space for. */
4476 int nmaps_allocated
= 0;
4478 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
4479 the current keymaps. */
4482 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
4483 in the current keymaps, or nil where it is not a prefix. */
4484 Lisp_Object
*submaps
;
4486 /* The local map to start out with at start of key sequence. */
4487 Lisp_Object orig_local_map
;
4489 /* 1 if we have already considered switching to the local-map property
4490 of the place where a mouse click occurred. */
4491 int localized_local_map
= 0;
4493 /* The index in defs[] of the first keymap that has a binding for
4494 this key sequence. In other words, the lowest i such that
4495 defs[i] is non-nil. */
4498 /* If t < mock_input, then KEYBUF[t] should be read as the next
4501 We use this to recover after recognizing a function key. Once we
4502 realize that a suffix of the current key sequence is actually a
4503 function key's escape sequence, we replace the suffix with the
4504 function key's binding from Vfunction_key_map. Now keybuf
4505 contains a new and different key sequence, so the echo area,
4506 this_command_keys, and the submaps and defs arrays are wrong. In
4507 this situation, we set mock_input to t, set t to 0, and jump to
4508 restart_sequence; the loop will read keys from keybuf up until
4509 mock_input, thus rebuilding the state; and then it will resume
4510 reading characters from the keyboard. */
4513 /* If the sequence is unbound in submaps[], then
4514 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
4515 and fkey_map is its binding.
4517 These might be > t, indicating that all function key scanning
4518 should hold off until t reaches them. We do this when we've just
4519 recognized a function key, to avoid searching for the function
4520 key's again in Vfunction_key_map. */
4521 int fkey_start
= 0, fkey_end
= 0;
4522 Lisp_Object fkey_map
;
4524 /* Likewise, for key_translation_map. */
4525 int keytran_start
= 0, keytran_end
= 0;
4526 Lisp_Object keytran_map
;
4528 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
4529 we put it off for later. While we're reading, we keep the event here. */
4530 Lisp_Object delayed_switch_frame
;
4532 /* See the comment below... */
4533 #if defined (GOBBLE_FIRST_EVENT)
4534 Lisp_Object first_event
;
4537 Lisp_Object original_uppercase
;
4538 int original_uppercase_position
= -1;
4540 /* Gets around Microsoft compiler limitations. */
4543 struct buffer
*starting_buffer
;
4545 /* Nonzero if we seem to have got the beginning of a binding
4546 in function_key_map. */
4547 int function_key_possible
= 0;
4548 int key_translation_possible
= 0;
4552 last_nonmenu_event
= Qnil
;
4554 delayed_switch_frame
= Qnil
;
4555 fkey_map
= Vfunction_key_map
;
4556 keytran_map
= Vkey_translation_map
;
4558 /* If there is no function-key-map, turn off function key scanning. */
4559 if (NILP (Fkeymapp (Vfunction_key_map
)))
4560 fkey_start
= fkey_end
= bufsize
+ 1;
4562 /* If there is no key-translation-map, turn off scanning. */
4563 if (NILP (Fkeymapp (Vkey_translation_map
)))
4564 keytran_start
= keytran_end
= bufsize
+ 1;
4569 echo_prompt (XSTRING (prompt
)->data
);
4570 else if (cursor_in_echo_area
&& echo_keystrokes
)
4571 /* This doesn't put in a dash if the echo buffer is empty, so
4572 you don't always see a dash hanging out in the minibuffer. */
4576 /* Record the initial state of the echo area and this_command_keys;
4577 we will need to restore them if we replay a key sequence. */
4579 echo_start
= echo_length ();
4580 keys_start
= this_command_key_count
;
4582 #if defined (GOBBLE_FIRST_EVENT)
4583 /* This doesn't quite work, because some of the things that read_char
4584 does cannot safely be bypassed. It seems too risky to try to make
4587 /* Read the first char of the sequence specially, before setting
4588 up any keymaps, in case a filter runs and switches buffers on us. */
4589 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
4591 #endif /* GOBBLE_FIRST_EVENT */
4593 orig_local_map
= get_local_map (PT
, current_buffer
);
4595 /* We jump here when the key sequence has been thoroughly changed, and
4596 we need to rescan it starting from the beginning. When we jump here,
4597 keybuf[0..mock_input] holds the sequence we should reread. */
4600 starting_buffer
= current_buffer
;
4601 function_key_possible
= 0;
4602 key_translation_possible
= 0;
4604 /* Build our list of keymaps.
4605 If we recognize a function key and replace its escape sequence in
4606 keybuf with its symbol, or if the sequence starts with a mouse
4607 click and we need to switch buffers, we jump back here to rebuild
4608 the initial keymaps from the current buffer. */
4612 if (!NILP (Voverriding_local_map
))
4615 if (nmaps
> nmaps_allocated
)
4617 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4618 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4619 nmaps_allocated
= nmaps
;
4621 submaps
[0] = Voverriding_local_map
;
4625 nmaps
= current_minor_maps (0, &maps
) + 2;
4626 if (nmaps
> nmaps_allocated
)
4628 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4629 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4630 nmaps_allocated
= nmaps
;
4632 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
4633 #ifdef USE_TEXT_PROPERTIES
4634 submaps
[nmaps
-2] = orig_local_map
;
4636 submaps
[nmaps
-2] = current_buffer
->keymap
;
4639 submaps
[nmaps
-1] = current_global_map
;
4642 /* Find an accurate initial value for first_binding. */
4643 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
4644 if (! NILP (submaps
[first_binding
]))
4647 /* Start from the beginning in keybuf. */
4650 /* These are no-ops the first time through, but if we restart, they
4651 revert the echo area and this_command_keys to their original state. */
4652 this_command_key_count
= keys_start
;
4653 if (INTERACTIVE
&& t
< mock_input
)
4654 echo_truncate (echo_start
);
4656 /* If the best binding for the current key sequence is a keymap, or
4657 we may be looking at a function key's escape sequence, keep on
4659 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
4660 || (first_binding
>= nmaps
4662 /* mock input is never part of a function key's sequence. */
4663 && mock_input
<= fkey_start
)
4664 || (first_binding
>= nmaps
4665 && keytran_start
< t
&& key_translation_possible
)
4666 /* Don't return in the middle of a possible function key sequence,
4667 if the only bindings we found were via case conversion.
4668 Thus, if ESC O a has a function-key-map translation
4669 and ESC o has a binding, don't return after ESC O,
4670 so that we can translate ESC O plus the next character. */
4674 int used_mouse_menu
= 0;
4676 /* Where the last real key started. If we need to throw away a
4677 key that has expanded into more than one element of keybuf
4678 (say, a mouse click on the mode line which is being treated
4679 as [mode-line (mouse-...)], then we backtrack to this point
4681 int last_real_key_start
;
4683 /* These variables are analogous to echo_start and keys_start;
4684 while those allow us to restart the entire key sequence,
4685 echo_local_start and keys_local_start allow us to throw away
4687 int echo_local_start
, keys_local_start
, local_first_binding
;
4690 error ("key sequence too long");
4693 echo_local_start
= echo_length ();
4694 keys_local_start
= this_command_key_count
;
4695 local_first_binding
= first_binding
;
4698 /* These are no-ops, unless we throw away a keystroke below and
4699 jumped back up to replay_key; in that case, these restore the
4700 variables to their original state, allowing us to replay the
4702 if (INTERACTIVE
&& t
< mock_input
)
4703 echo_truncate (echo_local_start
);
4704 this_command_key_count
= keys_local_start
;
4705 first_binding
= local_first_binding
;
4707 /* By default, assume each event is "real". */
4708 last_real_key_start
= t
;
4710 /* Does mock_input indicate that we are re-reading a key sequence? */
4714 add_command_key (key
);
4715 if (echo_keystrokes
)
4719 /* If not, we should actually read a character. */
4722 struct buffer
*buf
= current_buffer
;
4724 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
4727 /* read_char returns t when it shows a menu and the user rejects it.
4732 /* read_char returns -1 at the end of a macro.
4733 Emacs 18 handles this by returning immediately with a
4734 zero, so that's what we'll do. */
4735 if (INTEGERP (key
) && XINT (key
) == -1)
4738 /* The Microsoft C compiler can't handle the goto that
4744 /* If the current buffer has been changed from under us, the
4745 keymap may have changed, so replay the sequence. */
4749 goto replay_sequence
;
4752 /* If we have a quit that was typed in another frame, and
4753 quit_throw_to_read_char switched buffers,
4754 replay to get the right keymap. */
4755 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
4760 goto replay_sequence
;
4766 /* Clicks in non-text areas get prefixed by the symbol
4767 in their CHAR-ADDRESS field. For example, a click on
4768 the mode line is prefixed by the symbol `mode-line'.
4770 Furthermore, key sequences beginning with mouse clicks
4771 are read using the keymaps of the buffer clicked on, not
4772 the current buffer. So we may have to switch the buffer
4775 When we turn one event into two events, we must make sure
4776 that neither of the two looks like the original--so that,
4777 if we replay the events, they won't be expanded again.
4778 If not for this, such reexpansion could happen either here
4779 or when user programs play with this-command-keys. */
4780 if (EVENT_HAS_PARAMETERS (key
))
4784 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
4785 if (EQ (kind
, Qmouse_click
))
4787 Lisp_Object window
, posn
;
4789 window
= POSN_WINDOW (EVENT_START (key
));
4790 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4793 /* We're looking at the second event of a
4794 sequence which we expanded before. Set
4795 last_real_key_start appropriately. */
4797 last_real_key_start
= t
- 1;
4800 /* Key sequences beginning with mouse clicks are
4801 read using the keymaps in the buffer clicked on,
4802 not the current buffer. If we're at the
4803 beginning of a key sequence, switch buffers. */
4804 if (last_real_key_start
== 0
4806 && BUFFERP (XWINDOW (window
)->buffer
)
4807 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
4812 /* Arrange to go back to the original buffer once we're
4813 done reading the key sequence. Note that we can't
4814 use save_excursion_{save,restore} here, because they
4815 save point as well as the current buffer; we don't
4816 want to save point, because redisplay may change it,
4817 to accommodate a Fset_window_start or something. We
4818 don't want to do this at the top of the function,
4819 because we may get input from a subprocess which
4820 wants to change the selected window and stuff (say,
4822 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
4824 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
4825 orig_local_map
= get_local_map (PT
, current_buffer
);
4826 goto replay_sequence
;
4828 /* For a mouse click, get the local text-property keymap
4829 of the place clicked on, rather than point. */
4830 if (last_real_key_start
== 0 && CONSP (XCONS (key
)->cdr
)
4831 && ! localized_local_map
)
4833 Lisp_Object map_here
, start
, pos
;
4835 localized_local_map
= 1;
4836 start
= EVENT_START (key
);
4837 if (CONSP (start
) && CONSP (XCONS (start
)->cdr
))
4839 pos
= POSN_BUFFER_POSN (start
);
4842 map_here
= get_local_map (XINT (pos
), current_buffer
);
4843 if (!EQ (map_here
, orig_local_map
))
4845 orig_local_map
= map_here
;
4849 goto replay_sequence
;
4855 /* Expand mode-line and scroll-bar events into two events:
4856 use posn as a fake prefix key. */
4859 if (t
+ 1 >= bufsize
)
4860 error ("key sequence too long");
4865 /* Zap the position in key, so we know that we've
4866 expanded it, and don't try to do so again. */
4867 POSN_BUFFER_POSN (EVENT_START (key
))
4868 = Fcons (posn
, Qnil
);
4872 else if (EQ (kind
, Qswitch_frame
))
4874 /* If we're at the beginning of a key sequence, go
4875 ahead and return this event. If we're in the
4876 midst of a key sequence, delay it until the end. */
4879 delayed_switch_frame
= key
;
4883 else if (CONSP (XCONS (key
)->cdr
)
4884 && CONSP (EVENT_START (key
))
4885 && CONSP (XCONS (EVENT_START (key
))->cdr
))
4889 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4890 /* Handle menu-bar events:
4891 insert the dummy prefix event `menu-bar'. */
4892 if (EQ (posn
, Qmenu_bar
))
4894 if (t
+ 1 >= bufsize
)
4895 error ("key sequence too long");
4896 /* Run the Lucid hook. */
4897 if (!NILP (Vrun_hooks
))
4898 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4899 /* If it has changed current-menubar from previous value,
4900 really recompute the menubar from the value. */
4901 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4902 call0 (Qrecompute_lucid_menubar
);
4906 /* Zap the position in key, so we know that we've
4907 expanded it, and don't try to do so again. */
4908 POSN_BUFFER_POSN (EVENT_START (key
))
4909 = Fcons (posn
, Qnil
);
4912 goto replay_sequence
;
4914 else if (CONSP (posn
))
4916 /* We're looking at the second event of a
4917 sequence which we expanded before. Set
4918 last_real_key_start appropriately. */
4919 if (last_real_key_start
== t
&& t
> 0)
4920 last_real_key_start
= t
- 1;
4925 /* We have finally decided that KEY is something we might want
4927 first_binding
= (follow_key (key
,
4928 nmaps
- first_binding
,
4929 submaps
+ first_binding
,
4930 defs
+ first_binding
,
4931 submaps
+ first_binding
)
4934 /* If KEY wasn't bound, we'll try some fallbacks. */
4935 if (first_binding
>= nmaps
)
4939 head
= EVENT_HEAD (key
);
4940 if (EQ (head
, Vhelp_char
))
4942 read_key_sequence_cmd
= Vprefix_help_command
;
4944 last_nonmenu_event
= key
;
4945 /* The Microsoft C compiler can't handle the goto that
4953 Lisp_Object breakdown
;
4956 breakdown
= parse_modifiers (head
);
4957 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4958 /* Attempt to reduce an unbound mouse event to a simpler
4959 event that is bound:
4960 Drags reduce to clicks.
4961 Double-clicks reduce to clicks.
4962 Triple-clicks reduce to double-clicks, then to clicks.
4963 Down-clicks are eliminated.
4964 Double-downs reduce to downs, then are eliminated.
4965 Triple-downs reduce to double-downs, then to downs,
4966 then are eliminated. */
4967 if (modifiers
& (down_modifier
| drag_modifier
4968 | double_modifier
| triple_modifier
))
4970 while (modifiers
& (down_modifier
| drag_modifier
4971 | double_modifier
| triple_modifier
))
4973 Lisp_Object new_head
, new_click
;
4974 if (modifiers
& triple_modifier
)
4975 modifiers
^= (double_modifier
| triple_modifier
);
4976 else if (modifiers
& double_modifier
)
4977 modifiers
&= ~double_modifier
;
4978 else if (modifiers
& drag_modifier
)
4979 modifiers
&= ~drag_modifier
;
4982 /* Dispose of this `down' event by simply jumping
4983 back to replay_key, to get another event.
4985 Note that if this event came from mock input,
4986 then just jumping back to replay_key will just
4987 hand it to us again. So we have to wipe out any
4990 We could delete keybuf[t] and shift everything
4991 after that to the left by one spot, but we'd also
4992 have to fix up any variable that points into
4993 keybuf, and shifting isn't really necessary
4996 Adding prefixes for non-textual mouse clicks
4997 creates two characters of mock input, and both
4998 must be thrown away. If we're only looking at
4999 the prefix now, we can just jump back to
5000 replay_key. On the other hand, if we've already
5001 processed the prefix, and now the actual click
5002 itself is giving us trouble, then we've lost the
5003 state of the keymaps we want to backtrack to, and
5004 we need to replay the whole sequence to rebuild
5007 Beyond that, only function key expansion could
5008 create more than two keys, but that should never
5009 generate mouse events, so it's okay to zero
5010 mock_input in that case too.
5012 Isn't this just the most wonderful code ever? */
5013 if (t
== last_real_key_start
)
5020 mock_input
= last_real_key_start
;
5021 goto replay_sequence
;
5026 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
5028 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
5030 /* Look for a binding for this new key. follow_key
5031 promises that it didn't munge submaps the
5032 last time we called it, since key was unbound. */
5034 = (follow_key (new_click
,
5035 nmaps
- local_first_binding
,
5036 submaps
+ local_first_binding
,
5037 defs
+ local_first_binding
,
5038 submaps
+ local_first_binding
)
5039 + local_first_binding
);
5041 /* If that click is bound, go for it. */
5042 if (first_binding
< nmaps
)
5047 /* Otherwise, we'll leave key set to the drag event. */
5054 /* Normally, last_nonmenu_event gets the previous key we read.
5055 But when a mouse popup menu is being used,
5056 we don't update last_nonmenu_event; it continues to hold the mouse
5057 event that preceded the first level of menu. */
5058 if (!used_mouse_menu
)
5059 last_nonmenu_event
= key
;
5061 /* If the sequence is unbound, see if we can hang a function key
5062 off the end of it. We only want to scan real keyboard input
5063 for function key sequences, so if mock_input says that we're
5064 re-reading old events, don't examine it. */
5065 if (first_binding
>= nmaps
5068 Lisp_Object fkey_next
;
5070 /* Continue scan from fkey_end until we find a bound suffix.
5071 If we fail, increment fkey_start
5072 and start fkey_end from there. */
5073 while (fkey_end
< t
)
5077 key
= keybuf
[fkey_end
++];
5078 /* Look up meta-characters by prefixing them
5079 with meta_prefix_char. I hate this. */
5080 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
5085 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
5087 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
5090 fkey_next
= fkey_map
;
5093 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
5095 #if 0 /* I didn't turn this on, because it might cause trouble
5096 for the mapping of return into C-m and tab into C-i. */
5097 /* Optionally don't map function keys into other things.
5098 This enables the user to redefine kp- keys easily. */
5099 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
5103 /* If the function key map gives a function, not an
5104 array, then call the function with no args and use
5105 its value instead. */
5106 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
5109 struct gcpro gcpro1
, gcpro2
, gcpro3
;
5113 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
5114 fkey_next
= call1 (fkey_next
, prompt
);
5116 /* If the function returned something invalid,
5117 barf--don't ignore it.
5118 (To ignore it safely, we would need to gcpro a bunch of
5119 other variables.) */
5120 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
5121 error ("Function in function-key-map returns invalid key sequence");
5124 function_key_possible
= ! NILP (fkey_next
);
5126 /* If keybuf[fkey_start..fkey_end] is bound in the
5127 function key map and it's a suffix of the current
5128 sequence (i.e. fkey_end == t), replace it with
5129 the binding and restart with fkey_start at the end. */
5130 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
5133 int len
= XFASTINT (Flength (fkey_next
));
5135 t
= fkey_start
+ len
;
5137 error ("key sequence too long");
5139 if (VECTORP (fkey_next
))
5140 bcopy (XVECTOR (fkey_next
)->contents
,
5141 keybuf
+ fkey_start
,
5142 (t
- fkey_start
) * sizeof (keybuf
[0]));
5143 else if (STRINGP (fkey_next
))
5147 for (i
= 0; i
< len
; i
++)
5148 XSETFASTINT (keybuf
[fkey_start
+ i
],
5149 XSTRING (fkey_next
)->data
[i
]);
5153 fkey_start
= fkey_end
= t
;
5154 fkey_map
= Vfunction_key_map
;
5156 /* Do pass the results through key-translation-map. */
5157 keytran_start
= keytran_end
= 0;
5158 keytran_map
= Vkey_translation_map
;
5160 goto replay_sequence
;
5163 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
5165 /* If we no longer have a bound suffix, try a new positions for
5167 if (NILP (fkey_map
))
5169 fkey_end
= ++fkey_start
;
5170 fkey_map
= Vfunction_key_map
;
5171 function_key_possible
= 0;
5176 /* Look for this sequence in key-translation-map. */
5178 Lisp_Object keytran_next
;
5180 /* Scan from keytran_end until we find a bound suffix. */
5181 while (keytran_end
< t
)
5185 key
= keybuf
[keytran_end
++];
5186 /* Look up meta-characters by prefixing them
5187 with meta_prefix_char. I hate this. */
5188 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
5193 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
5195 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
5198 keytran_next
= keytran_map
;
5201 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
5203 /* If the key translation map gives a function, not an
5204 array, then call the function with no args and use
5205 its value instead. */
5206 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
5207 && keytran_end
== t
)
5209 struct gcpro gcpro1
, gcpro2
, gcpro3
;
5213 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
5214 keytran_next
= call1 (keytran_next
, prompt
);
5216 /* If the function returned something invalid,
5217 barf--don't ignore it.
5218 (To ignore it safely, we would need to gcpro a bunch of
5219 other variables.) */
5220 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
5221 error ("Function in key-translation-map returns invalid key sequence");
5224 key_translation_possible
= ! NILP (keytran_next
);
5226 /* If keybuf[keytran_start..keytran_end] is bound in the
5227 key translation map and it's a suffix of the current
5228 sequence (i.e. keytran_end == t), replace it with
5229 the binding and restart with keytran_start at the end. */
5230 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
5231 && keytran_end
== t
)
5233 int len
= XFASTINT (Flength (keytran_next
));
5235 t
= keytran_start
+ len
;
5237 error ("key sequence too long");
5239 if (VECTORP (keytran_next
))
5240 bcopy (XVECTOR (keytran_next
)->contents
,
5241 keybuf
+ keytran_start
,
5242 (t
- keytran_start
) * sizeof (keybuf
[0]));
5243 else if (STRINGP (keytran_next
))
5247 for (i
= 0; i
< len
; i
++)
5248 XSETFASTINT (keybuf
[keytran_start
+ i
],
5249 XSTRING (keytran_next
)->data
[i
]);
5253 keytran_start
= keytran_end
= t
;
5254 keytran_map
= Vkey_translation_map
;
5256 /* Don't pass the results of key-translation-map
5257 through function-key-map. */
5258 fkey_start
= fkey_end
= t
;
5259 fkey_map
= Vkey_translation_map
;
5261 goto replay_sequence
;
5264 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
5266 /* If we no longer have a bound suffix, try a new positions for
5268 if (NILP (keytran_map
))
5270 keytran_end
= ++keytran_start
;
5271 keytran_map
= Vkey_translation_map
;
5272 key_translation_possible
= 0;
5277 /* If KEY is not defined in any of the keymaps,
5278 and cannot be part of a function key or translation,
5279 and is an upper case letter
5280 use the corresponding lower-case letter instead. */
5281 if (first_binding
== nmaps
&& ! function_key_possible
5282 && ! key_translation_possible
5284 && ((((XINT (key
) & 0x3ffff)
5285 < XSTRING (current_buffer
->downcase_table
)->size
)
5286 && UPPERCASEP (XINT (key
) & 0x3ffff))
5287 || (XINT (key
) & shift_modifier
)))
5289 original_uppercase
= key
;
5290 original_uppercase_position
= t
- 1;
5292 if (XINT (key
) & shift_modifier
)
5293 XSETINT (key
, XINT (key
) & ~shift_modifier
);
5295 XSETINT (key
, (DOWNCASE (XINT (key
) & 0x3ffff)
5296 | (XINT (key
) & ~0x3ffff)));
5298 keybuf
[t
- 1] = key
;
5300 goto replay_sequence
;
5302 /* If KEY is not defined in any of the keymaps,
5303 and cannot be part of a function key or translation,
5304 and is a shifted function key,
5305 use the corresponding unshifted function key instead. */
5306 if (first_binding
== nmaps
&& ! function_key_possible
5307 && ! key_translation_possible
5310 Lisp_Object breakdown
;
5313 original_uppercase
= key
;
5314 original_uppercase_position
= t
- 1;
5316 breakdown
= parse_modifiers (key
);
5317 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
5318 if (modifiers
& shift_modifier
)
5320 modifiers
&= ~shift_modifier
;
5321 key
= apply_modifiers (make_number (modifiers
),
5322 XCONS (breakdown
)->car
);
5324 keybuf
[t
- 1] = key
;
5326 goto replay_sequence
;
5332 read_key_sequence_cmd
= (first_binding
< nmaps
5333 ? defs
[first_binding
]
5336 unread_switch_frame
= delayed_switch_frame
;
5337 unbind_to (count
, Qnil
);
5339 if (dont_downcase_last
&& t
- 1 == original_uppercase_position
)
5340 keybuf
[t
- 1] = original_uppercase
;
5342 /* Occasionally we fabricate events, perhaps by expanding something
5343 according to function-key-map, or by adding a prefix symbol to a
5344 mouse click in the scroll bar or modeline. In this cases, return
5345 the entire generated key sequence, even if we hit an unbound
5346 prefix or a definition before the end. This means that you will
5347 be able to push back the event properly, and also means that
5348 read-key-sequence will always return a logical unit.
5351 for (; t
< mock_input
; t
++)
5353 if (echo_keystrokes
)
5354 echo_char (keybuf
[t
]);
5355 add_command_key (keybuf
[t
]);
5361 #if 0 /* This doc string is too long for some compilers.
5362 This commented-out definition serves for DOC. */
5363 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
5364 "Read a sequence of keystrokes and return as a string or vector.\n\
5365 The sequence is sufficient to specify a non-prefix command in the\n\
5366 current local and global maps.\n\
5368 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
5369 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
5370 as a continuation of the previous key.\n\
5372 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
5373 convert the last event to lower case. (Normally any upper case event\n\
5374 is converted to lower case if the original event is undefined and the lower\n\
5375 case equivalent is defined.) A non-nil value is appropriate for reading\n\
5376 a key sequence to be defined.\n\
5378 A C-g typed while in this function is treated like any other character,\n\
5379 and `quit-flag' is not set.\n\
5381 If the key sequence starts with a mouse click, then the sequence is read\n\
5382 using the keymaps of the buffer of the window clicked in, not the buffer\n\
5383 of the selected window as normal.\n\
5385 `read-key-sequence' drops unbound button-down events, since you normally\n\
5386 only care about the click or drag events which follow them. If a drag\n\
5387 or multi-click event is unbound, but the corresponding click event would\n\
5388 be bound, `read-key-sequence' turns the event into a click event at the\n\
5389 drag's starting position. This means that you don't have to distinguish\n\
5390 between click and drag, double, or triple events unless you want to.\n\
5392 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
5393 lines separating windows, and scroll bars with imaginary keys\n\
5394 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
5396 If the user switches frames in the middle of a key sequence, the\n\
5397 frame-switch event is put off until after the current key sequence.\n\
5399 `read-key-sequence' checks `function-key-map' for function key\n\
5400 sequences, where they wouldn't conflict with ordinary bindings. See\n\
5401 `function-key-map' for more details.")
5402 (prompt
, continue_echo
)
5405 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 3, 0,
5407 (prompt
, continue_echo
, dont_downcase_last
)
5408 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
5410 Lisp_Object keybuf
[30];
5412 struct gcpro gcpro1
, gcpro2
;
5415 CHECK_STRING (prompt
, 0);
5418 bzero (keybuf
, sizeof keybuf
);
5420 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
5422 if (NILP (continue_echo
))
5423 this_command_key_count
= 0;
5425 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
5426 prompt
, ! NILP (dont_downcase_last
));
5434 return make_event_array (i
, keybuf
);
5437 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
5438 "Execute CMD as an editor command.\n\
5439 CMD must be a symbol that satisfies the `commandp' predicate.\n\
5440 Optional second arg RECORD-FLAG non-nil\n\
5441 means unconditionally put this command in `command-history'.\n\
5442 Otherwise, that is done only if an arg is read using the minibuffer.")
5444 Lisp_Object cmd
, record
;
5446 register Lisp_Object final
;
5447 register Lisp_Object tem
;
5448 Lisp_Object prefixarg
;
5449 struct backtrace backtrace
;
5450 extern int debug_on_next_call
;
5452 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
5453 Vcurrent_prefix_arg
= prefixarg
;
5454 debug_on_next_call
= 0;
5458 tem
= Fget (cmd
, Qdisabled
);
5459 if (!NILP (tem
) && !NILP (Vrun_hooks
))
5460 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
5465 final
= Findirect_function (cmd
);
5467 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
5468 do_autoload (final
, cmd
);
5473 if (STRINGP (final
) || VECTORP (final
))
5475 /* If requested, place the macro in the command history. For
5476 other sorts of commands, call-interactively takes care of
5480 = Fcons (Fcons (Qexecute_kbd_macro
,
5481 Fcons (final
, Fcons (prefixarg
, Qnil
))),
5484 return Fexecute_kbd_macro (final
, prefixarg
);
5486 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
5488 backtrace
.next
= backtrace_list
;
5489 backtrace_list
= &backtrace
;
5490 backtrace
.function
= &Qcall_interactively
;
5491 backtrace
.args
= &cmd
;
5492 backtrace
.nargs
= 1;
5493 backtrace
.evalargs
= 0;
5495 tem
= Fcall_interactively (cmd
, record
);
5497 backtrace_list
= backtrace
.next
;
5503 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
5505 "Read function name, then read its arguments and call it.")
5507 Lisp_Object prefixarg
;
5509 Lisp_Object function
;
5511 Lisp_Object saved_keys
;
5512 struct gcpro gcpro1
;
5514 saved_keys
= Fvector (this_command_key_count
,
5515 XVECTOR (this_command_keys
)->contents
);
5517 GCPRO1 (saved_keys
);
5519 if (EQ (prefixarg
, Qminus
))
5521 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
5522 strcpy (buf
, "C-u ");
5523 else if (CONSP (prefixarg
) && INTEGERP (XCONS (prefixarg
)->car
))
5524 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
5525 else if (INTEGERP (prefixarg
))
5526 sprintf (buf
, "%d ", XINT (prefixarg
));
5528 /* This isn't strictly correct if execute-extended-command
5529 is bound to anything else. Perhaps it should use
5530 this_command_keys? */
5531 strcat (buf
, "M-x ");
5533 /* Prompt with buf, and then read a string, completing from and
5534 restricting to the set of all defined commands. Don't provide
5535 any initial input. Save the command read on the extended-command
5537 function
= Fcompleting_read (build_string (buf
),
5538 Vobarray
, Qcommandp
,
5539 Qt
, Qnil
, Qextended_command_history
);
5541 /* Set this_command_keys to the concatenation of saved_keys and
5542 function, followed by a RET. */
5544 struct Lisp_String
*str
;
5549 this_command_key_count
= 0;
5551 keys
= XVECTOR (saved_keys
)->contents
;
5552 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
5553 add_command_key (keys
[i
]);
5555 str
= XSTRING (function
);
5556 for (i
= 0; i
< str
->size
; i
++)
5558 XSETFASTINT (tem
, str
->data
[i
]);
5559 add_command_key (tem
);
5562 XSETFASTINT (tem
, '\015');
5563 add_command_key (tem
);
5568 function
= Fintern (function
, Qnil
);
5569 Vprefix_arg
= prefixarg
;
5570 this_command
= function
;
5572 return Fcommand_execute (function
, Qt
);
5576 detect_input_pending ()
5579 get_input_pending (&input_pending
);
5581 return input_pending
;
5584 /* This is called in some cases before a possible quit.
5585 It cases the next call to detect_input_pending to recompute input_pending.
5586 So calling this function unnecessarily can't do any harm. */
5587 clear_input_pending ()
5592 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
5593 "T if command input is currently available with no waiting.\n\
5594 Actually, the value is nil only if we can be sure that no input is available.")
5597 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
5600 return detect_input_pending () ? Qt
: Qnil
;
5603 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
5604 "Return vector of last 100 events, not counting those from keyboard macros.")
5607 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
5610 if (total_keys
< NUM_RECENT_KEYS
)
5611 return Fvector (total_keys
, keys
);
5614 val
= Fvector (NUM_RECENT_KEYS
, keys
);
5615 bcopy (keys
+ recent_keys_index
,
5616 XVECTOR (val
)->contents
,
5617 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
5619 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
5620 recent_keys_index
* sizeof (Lisp_Object
));
5625 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
5626 "Return the key sequence that invoked this command.\n\
5627 The value is a string or a vector.")
5630 return make_event_array (this_command_key_count
,
5631 XVECTOR (this_command_keys
)->contents
);
5634 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
5635 "Return the current depth in recursive edits.")
5639 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
5643 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
5644 "FOpen dribble file: ",
5645 "Start writing all keyboard characters to a dribble file called FILE.\n\
5646 If FILE is nil, close any open dribble file.")
5660 file
= Fexpand_file_name (file
, Qnil
);
5661 dribble
= fopen (XSTRING (file
)->data
, "w");
5666 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
5667 "Discard the contents of the terminal input buffer.\n\
5668 Also cancel any kbd macro being defined.")
5671 PERD
*perd
= &the_only_perd
;
5672 defining_kbd_macro
= 0;
5673 update_mode_lines
++;
5675 Vunread_command_events
= Qnil
;
5676 unread_command_char
= -1;
5678 discard_tty_input ();
5680 /* Without the cast, GCC complains that this assignment loses the
5681 volatile qualifier of kbd_store_ptr. Is there anything wrong
5683 perd
->kbd_fetch_ptr
= (struct input_event
*) perd
->kbd_store_ptr
;
5684 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5690 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
5691 "Stop Emacs and return to superior process. You can resume later.\n\
5692 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
5693 control, run a subshell instead.\n\n\
5694 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
5695 to be read as terminal input by Emacs's parent, after suspension.\n\
5697 Before suspending, run the normal hook `suspend-hook'.\n\
5698 After resumption run the normal hook `suspend-resume-hook'.\n\
5700 Some operating systems cannot stop the Emacs process and resume it later.\n\
5701 On such systems, Emacs starts a subshell instead of suspending.")
5703 Lisp_Object stuffstring
;
5706 int count
= specpdl_ptr
- specpdl
;
5707 int old_height
, old_width
;
5709 struct gcpro gcpro1
, gcpro2
;
5710 extern init_sys_modes ();
5712 if (!NILP (stuffstring
))
5713 CHECK_STRING (stuffstring
, 0);
5715 /* Run the functions in suspend-hook. */
5716 if (!NILP (Vrun_hooks
))
5717 call1 (Vrun_hooks
, intern ("suspend-hook"));
5719 GCPRO1 (stuffstring
);
5720 get_frame_size (&old_width
, &old_height
);
5722 /* sys_suspend can get an error if it tries to fork a subshell
5723 and the system resources aren't available for that. */
5724 record_unwind_protect (init_sys_modes
, 0);
5725 stuff_buffered_input (stuffstring
);
5730 unbind_to (count
, Qnil
);
5732 /* Check if terminal/window size has changed.
5733 Note that this is not useful when we are running directly
5734 with a window system; but suspend should be disabled in that case. */
5735 get_frame_size (&width
, &height
);
5736 if (width
!= old_width
|| height
!= old_height
)
5737 change_frame_size (selected_frame
, height
, width
, 0, 0);
5739 /* Run suspend-resume-hook. */
5740 if (!NILP (Vrun_hooks
))
5741 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
5747 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
5748 Then in any case stuff anything Emacs has read ahead and not used. */
5750 stuff_buffered_input (stuffstring
)
5751 Lisp_Object stuffstring
;
5753 /* stuff_char works only in BSD, versions 4.2 and up. */
5756 register unsigned char *p
;
5757 PERD
*perd
= &the_only_perd
; /* We really want the primary display's perd */
5759 if (STRINGP (stuffstring
))
5763 p
= XSTRING (stuffstring
)->data
;
5764 count
= XSTRING (stuffstring
)->size
;
5769 /* Anything we have read ahead, put back for the shell to read. */
5770 while (perd
->kbd_fetch_ptr
!= perd
->kbd_store_ptr
)
5772 if (perd
->kbd_fetch_ptr
== perd
->kbd_buffer
+ KBD_BUFFER_SIZE
)
5773 perd
->kbd_fetch_ptr
= perd
->kbd_buffer
;
5774 if (perd
->kbd_fetch_ptr
->kind
== ascii_keystroke
)
5775 stuff_char (perd
->kbd_fetch_ptr
->code
);
5776 perd
->kbd_fetch_ptr
->kind
= no_event
;
5777 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[perd
->kbd_fetch_ptr
5780 perd
->kbd_fetch_ptr
++;
5784 #endif /* BSD and not BSD4_1 */
5787 set_waiting_for_input (time_to_clear
)
5788 EMACS_TIME
*time_to_clear
;
5790 input_available_clear_time
= time_to_clear
;
5792 /* Tell interrupt_signal to throw back to read_char, */
5793 waiting_for_input
= 1;
5795 /* If interrupt_signal was called before and buffered a C-g,
5796 make it run again now, to avoid timing error. */
5797 if (!NILP (Vquit_flag
))
5798 quit_throw_to_read_char ();
5801 clear_waiting_for_input ()
5803 /* Tell interrupt_signal not to throw back to read_char, */
5804 waiting_for_input
= 0;
5805 input_available_clear_time
= 0;
5808 /* This routine is called at interrupt level in response to C-G.
5809 If interrupt_input, this is the handler for SIGINT.
5810 Otherwise, it is called from kbd_buffer_store_event,
5811 in handling SIGIO or SIGTINT.
5813 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
5814 immediately throw back to read_char.
5816 Otherwise it sets the Lisp variable quit-flag not-nil.
5817 This causes eval to throw, when it gets a chance.
5818 If quit-flag is already non-nil, it stops the job right away. */
5824 /* Must preserve main program's value of errno. */
5825 int old_errno
= errno
;
5828 if (!read_socket_hook
&& NILP (Vwindow_system
))
5830 /* USG systems forget handlers when they are used;
5831 must reestablish each time */
5832 signal (SIGINT
, interrupt_signal
);
5833 signal (SIGQUIT
, interrupt_signal
);
5839 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
5844 #ifdef SIGTSTP /* Support possible in later USG versions */
5846 * On systems which can suspend the current process and return to the original
5847 * shell, this command causes the user to end up back at the shell.
5848 * The "Auto-save" and "Abort" questions are not asked until
5849 * the user elects to return to emacs, at which point he can save the current
5850 * job and either dump core or continue.
5855 if (sys_suspend () == -1)
5857 printf ("Not running as a subprocess;\n");
5858 printf ("you can continue or abort.\n");
5861 /* Perhaps should really fork an inferior shell?
5862 But that would not provide any way to get back
5863 to the original shell, ever. */
5864 printf ("No support for stopping a process on this operating system;\n");
5865 printf ("you can continue or abort.\n");
5866 #endif /* not VMS */
5867 #endif /* not SIGTSTP */
5869 /* We must remain inside the screen area when the internal terminal
5870 is used. Note that [Enter] is not echoed by dos. */
5873 printf ("Auto-save? (y or n) ");
5875 if (((c
= getchar ()) & ~040) == 'Y')
5877 Fdo_auto_save (Qt
, Qnil
);
5879 printf ("\r\nAuto-save done");
5880 #else /* not MSDOS */
5881 printf ("Auto-save done\n");
5882 #endif /* not MSDOS */
5884 while (c
!= '\n') c
= getchar ();
5886 printf ("\r\nAbort? (y or n) ");
5887 #else /* not MSDOS */
5889 printf ("Abort (and enter debugger)? (y or n) ");
5891 printf ("Abort (and dump core)? (y or n) ");
5892 #endif /* not VMS */
5893 #endif /* not MSDOS */
5895 if (((c
= getchar ()) & ~040) == 'Y')
5897 while (c
!= '\n') c
= getchar ();
5899 printf ("\r\nContinuing...\r\n");
5900 #else /* not MSDOS */
5901 printf ("Continuing...\n");
5902 #endif /* not MSDOS */
5908 /* If executing a function that wants to be interrupted out of
5909 and the user has not deferred quitting by binding `inhibit-quit'
5910 then quit right away. */
5911 if (immediate_quit
&& NILP (Vinhibit_quit
))
5915 Fsignal (Qquit
, Qnil
);
5918 /* Else request quit when it's safe */
5922 if (waiting_for_input
&& !echoing
)
5923 quit_throw_to_read_char ();
5928 /* Handle a C-g by making read_char return C-g. */
5930 quit_throw_to_read_char ()
5932 quit_error_check ();
5934 /* Prevent another signal from doing this before we finish. */
5935 clear_waiting_for_input ();
5938 Vunread_command_events
= Qnil
;
5939 unread_command_char
= -1;
5941 #ifdef POLL_FOR_INPUT
5942 /* May be > 1 if in recursive minibuffer. */
5943 if (poll_suppress_count
== 0)
5947 if (FRAMEP (internal_last_event_frame
)
5948 && XFRAME (internal_last_event_frame
) != selected_frame
)
5949 Fhandle_switch_frame (make_lispy_switch_frame (internal_last_event_frame
));
5952 _longjmp (getcjmp
, 1);
5955 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
5956 "Set mode of reading keyboard input.\n\
5957 First arg INTERRUPT non-nil means use input interrupts;\n\
5958 nil means use CBREAK mode.\n\
5959 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
5960 (no effect except in CBREAK mode).\n\
5961 Third arg META t means accept 8-bit input (for a Meta key).\n\
5962 META nil means ignore the top bit, on the assumption it is parity.\n\
5963 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
5964 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
5965 See also `current-input-mode'.")
5966 (interrupt
, flow
, meta
, quit
)
5967 Lisp_Object interrupt
, flow
, meta
, quit
;
5970 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
5971 error ("set-input-mode: QUIT must be an ASCII character");
5973 #ifdef POLL_FOR_INPUT
5979 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5980 #ifdef NO_SOCK_SIGIO
5981 if (read_socket_hook
)
5982 interrupt_input
= 0; /* No interrupts if reading from a socket. */
5984 #endif /* NO_SOCK_SIGIO */
5985 interrupt_input
= !NILP (interrupt
);
5986 #else /* not SIGIO */
5987 interrupt_input
= 0;
5988 #endif /* not SIGIO */
5989 /* Our VMS input only works by interrupts, as of now. */
5991 interrupt_input
= 1;
5993 flow_control
= !NILP (flow
);
5996 else if (EQ (meta
, Qt
))
6001 /* Don't let this value be out of range. */
6002 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
6006 #ifdef POLL_FOR_INPUT
6007 poll_suppress_count
= 1;
6013 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
6014 "Return information about the way Emacs currently reads keyboard input.\n\
6015 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
6016 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
6017 nil, Emacs is using CBREAK mode.\n\
6018 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
6019 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
6020 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
6021 META nil means ignoring the top bit, on the assumption it is parity.\n\
6022 META is neither t nor nil if accepting 8-bit input and using\n\
6023 all 8 bits as the character code.\n\
6024 QUIT is the character Emacs currently uses to quit.\n\
6025 The elements of this list correspond to the arguments of\n\
6031 val
[0] = interrupt_input
? Qt
: Qnil
;
6032 val
[1] = flow_control
? Qt
: Qnil
;
6033 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
6034 XSETFASTINT (val
[3], quit_char
);
6036 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
6042 /* This is correct before outermost invocation of the editor loop */
6043 command_loop_level
= -1;
6045 quit_char
= Ctl ('g');
6046 Vunread_command_events
= Qnil
;
6047 unread_command_char
= -1;
6049 recent_keys_index
= 0;
6050 the_only_perd
.kbd_buffer
6051 = (struct input_event
*)xmalloc (KBD_BUFFER_SIZE
6052 * sizeof (struct input_event
));
6053 the_only_perd
.kbd_fetch_ptr
= the_only_perd
.kbd_buffer
;
6054 the_only_perd
.kbd_store_ptr
= the_only_perd
.kbd_buffer
;
6056 do_mouse_tracking
= Qnil
;
6061 /* This means that command_loop_1 won't try to select anything the first
6063 internal_last_event_frame
= Qnil
;
6064 Vlast_event_frame
= internal_last_event_frame
;
6067 /* If we're running a dumped Emacs, we need to clear out
6068 kbd_buffer_frame_or_window, in case some events got into it
6071 If we're running an undumped Emacs, it hasn't been initialized by
6072 syms_of_keyboard yet. */
6074 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
6076 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
6078 signal (SIGINT
, interrupt_signal
);
6079 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
6080 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
6081 SIGQUIT and we can't tell which one it will give us. */
6082 signal (SIGQUIT
, interrupt_signal
);
6083 #endif /* HAVE_TERMIO */
6085 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6087 if (!noninteractive
)
6088 signal (SIGIO
, input_available_signal
);
6091 /* Use interrupt input by default, if it works and noninterrupt input
6092 has deficiencies. */
6094 #ifdef INTERRUPT_INPUT
6095 interrupt_input
= 1;
6097 interrupt_input
= 0;
6100 /* Our VMS input only works by interrupts, as of now. */
6102 interrupt_input
= 1;
6108 if (keyboard_init_hook
)
6109 (*keyboard_init_hook
) ();
6111 #ifdef POLL_FOR_INPUT
6112 poll_suppress_count
= 1;
6117 /* This type's only use is in syms_of_keyboard, to initialize the
6118 event header symbols and put properties on them. */
6125 struct event_head head_table
[] = {
6126 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
6127 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
6128 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
6129 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
6130 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
6131 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
6136 Qdisabled_command_hook
= intern ("disabled-command-hook");
6137 staticpro (&Qdisabled_command_hook
);
6139 Qself_insert_command
= intern ("self-insert-command");
6140 staticpro (&Qself_insert_command
);
6142 Qforward_char
= intern ("forward-char");
6143 staticpro (&Qforward_char
);
6145 Qbackward_char
= intern ("backward-char");
6146 staticpro (&Qbackward_char
);
6148 Qdisabled
= intern ("disabled");
6149 staticpro (&Qdisabled
);
6151 Qundefined
= intern ("undefined");
6152 staticpro (&Qundefined
);
6154 Qpre_command_hook
= intern ("pre-command-hook");
6155 staticpro (&Qpre_command_hook
);
6157 Qpost_command_hook
= intern ("post-command-hook");
6158 staticpro (&Qpost_command_hook
);
6160 Qdeferred_action_function
= intern ("deferred-action-function");
6161 staticpro (&Qdeferred_action_function
);
6163 Qcommand_hook_internal
= intern ("command-hook-internal");
6164 staticpro (&Qcommand_hook_internal
);
6166 Qfunction_key
= intern ("function-key");
6167 staticpro (&Qfunction_key
);
6168 Qmouse_click
= intern ("mouse-click");
6169 staticpro (&Qmouse_click
);
6171 Qmenu_enable
= intern ("menu-enable");
6172 staticpro (&Qmenu_enable
);
6174 Qmode_line
= intern ("mode-line");
6175 staticpro (&Qmode_line
);
6176 Qvertical_line
= intern ("vertical-line");
6177 staticpro (&Qvertical_line
);
6178 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
6179 staticpro (&Qvertical_scroll_bar
);
6180 Qmenu_bar
= intern ("menu-bar");
6181 staticpro (&Qmenu_bar
);
6183 Qabove_handle
= intern ("above-handle");
6184 staticpro (&Qabove_handle
);
6185 Qhandle
= intern ("handle");
6186 staticpro (&Qhandle
);
6187 Qbelow_handle
= intern ("below-handle");
6188 staticpro (&Qbelow_handle
);
6190 Qevent_kind
= intern ("event-kind");
6191 staticpro (&Qevent_kind
);
6192 Qevent_symbol_elements
= intern ("event-symbol-elements");
6193 staticpro (&Qevent_symbol_elements
);
6194 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
6195 staticpro (&Qevent_symbol_element_mask
);
6196 Qmodifier_cache
= intern ("modifier-cache");
6197 staticpro (&Qmodifier_cache
);
6199 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
6200 staticpro (&Qrecompute_lucid_menubar
);
6201 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
6202 staticpro (&Qactivate_menubar_hook
);
6204 Qpolling_period
= intern ("polling-period");
6205 staticpro (&Qpolling_period
);
6208 struct event_head
*p
;
6210 for (p
= head_table
;
6211 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
6214 *p
->var
= intern (p
->name
);
6216 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
6217 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
6221 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
6222 staticpro (&button_down_location
);
6226 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
6228 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
6229 for (i
= 0; i
< len
; i
++)
6230 if (modifier_names
[i
])
6231 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
6232 staticpro (&modifier_symbols
);
6235 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
6236 staticpro (&recent_keys
);
6238 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
6239 staticpro (&this_command_keys
);
6241 Qextended_command_history
= intern ("extended-command-history");
6242 Fset (Qextended_command_history
, Qnil
);
6243 staticpro (&Qextended_command_history
);
6245 kbd_buffer_frame_or_window
6246 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
6247 staticpro (&kbd_buffer_frame_or_window
);
6249 accent_key_syms
= Qnil
;
6250 staticpro (&accent_key_syms
);
6252 func_key_syms
= Qnil
;
6253 staticpro (&func_key_syms
);
6255 system_key_syms
= Qnil
;
6256 staticpro (&system_key_syms
);
6259 staticpro (&mouse_syms
);
6261 unread_switch_frame
= Qnil
;
6262 staticpro (&unread_switch_frame
);
6264 defsubr (&Sread_key_sequence
);
6265 defsubr (&Srecursive_edit
);
6267 defsubr (&Strack_mouse
);
6269 defsubr (&Sinput_pending_p
);
6270 defsubr (&Scommand_execute
);
6271 defsubr (&Srecent_keys
);
6272 defsubr (&Sthis_command_keys
);
6273 defsubr (&Ssuspend_emacs
);
6274 defsubr (&Sabort_recursive_edit
);
6275 defsubr (&Sexit_recursive_edit
);
6276 defsubr (&Srecursion_depth
);
6277 defsubr (&Stop_level
);
6278 defsubr (&Sdiscard_input
);
6279 defsubr (&Sopen_dribble_file
);
6280 defsubr (&Sset_input_mode
);
6281 defsubr (&Scurrent_input_mode
);
6282 defsubr (&Sexecute_extended_command
);
6284 DEFVAR_LISP ("last-command-char", &last_command_char
,
6285 "Last input event that was part of a command.");
6287 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
6288 "Last input event that was part of a command.");
6290 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
6291 "Last input event in a command, except for mouse menu events.\n\
6292 Mouse menus give back keys that don't look like mouse events;\n\
6293 this variable holds the actual mouse event that led to the menu,\n\
6294 so that you can determine whether the command was run by mouse or not.");
6296 DEFVAR_LISP ("last-input-char", &last_input_char
,
6297 "Last input event.");
6299 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
6300 "Last input event.");
6302 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
6303 "List of objects to be read as next command input events.");
6305 DEFVAR_INT ("unread-command-char", &unread_command_char
,
6306 "If not -1, an object to be read as next command input event.");
6308 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
6309 "Meta-prefix character code. Meta-foo as command input\n\
6310 turns into this character followed by foo.");
6311 XSETINT (meta_prefix_char
, 033);
6313 DEFVAR_LISP ("last-command", &last_command
,
6314 "The last command executed. Normally a symbol with a function definition,\n\
6315 but can be whatever was found in the keymap, or whatever the variable\n\
6316 `this-command' was set to by that command.\n\
6318 The value `mode-exit' is special; it means that the previous command\n\
6319 read an event that told it to exit, and it did so and unread that event.\n\
6320 In other words, the present command is the event that made the previous\n\
6323 The value `kill-region' is special; it means that the previous command\n\
6324 was a kill command.");
6325 last_command
= Qnil
;
6327 DEFVAR_LISP ("this-command", &this_command
,
6328 "The command now being executed.\n\
6329 The command can set this variable; whatever is put here\n\
6330 will be in `last-command' during the following command.");
6331 this_command
= Qnil
;
6333 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
6334 "*Number of keyboard input characters between auto-saves.\n\
6335 Zero means disable autosaving due to number of characters typed.");
6336 auto_save_interval
= 300;
6338 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
6339 "*Number of seconds idle time before auto-save.\n\
6340 Zero or nil means disable auto-saving due to idleness.\n\
6341 After auto-saving due to this many seconds of idle time,\n\
6342 Emacs also does a garbage collection if that seems to be warranted.");
6343 XSETFASTINT (Vauto_save_timeout
, 30);
6345 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
6346 "*Nonzero means echo unfinished commands after this many seconds of pause.");
6347 echo_keystrokes
= 1;
6349 DEFVAR_INT ("polling-period", &polling_period
,
6350 "*Interval between polling for input during Lisp execution.\n\
6351 The reason for polling is to make C-g work to stop a running program.\n\
6352 Polling is needed only when using X windows and SIGIO does not work.\n\
6353 Polling is automatically disabled in all other cases.");
6356 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
6357 "*Maximum time between mouse clicks to make a double-click.\n\
6358 Measured in milliseconds. nil means disable double-click recognition;\n\
6359 t means double-clicks have no time limit and are detected\n\
6360 by position only.");
6361 Vdouble_click_time
= make_number (500);
6363 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
6364 "*Non-nil means inhibit local map menu bar menus.");
6365 inhibit_local_menu_bar_menus
= 0;
6367 DEFVAR_INT ("num-input-keys", &num_input_keys
,
6368 "Number of complete keys read from the keyboard so far.");
6371 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
6372 "The frame in which the most recently read event occurred.\n\
6373 If the last event came from a keyboard macro, this is set to `macro'.");
6374 Vlast_event_frame
= Qnil
;
6376 DEFVAR_LISP ("help-char", &Vhelp_char
,
6377 "Character to recognize as meaning Help.\n\
6378 When it is read, do `(eval help-form)', and display result if it's a string.\n\
6379 If the value of `help-form' is nil, this char can be read normally.");
6380 XSETINT (Vhelp_char
, Ctl ('H'));
6382 DEFVAR_LISP ("help-form", &Vhelp_form
,
6383 "Form to execute when character `help-char' is read.\n\
6384 If the form returns a string, that string is displayed.\n\
6385 If `help-form' is nil, the help char is not recognized.");
6388 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
6389 "Command to run when `help-char' character follows a prefix key.\n\
6390 This command is used only when there is no actual binding\n\
6391 for that character after that prefix key.");
6392 Vprefix_help_command
= Qnil
;
6394 DEFVAR_LISP ("top-level", &Vtop_level
,
6395 "Form to evaluate when Emacs starts up.\n\
6396 Useful to set before you dump a modified Emacs.");
6399 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
6400 "String used as translate table for keyboard input, or nil.\n\
6401 Each character is looked up in this string and the contents used instead.\n\
6402 If string is of length N, character codes N and up are untranslated.");
6403 Vkeyboard_translate_table
= Qnil
;
6405 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
6406 "Keymap of key translations that can override keymaps.\n\
6407 This keymap works like `function-key-map', but comes after that,\n\
6408 and applies even for keys that have ordinary bindings.");
6409 Vkey_translation_map
= Qnil
;
6411 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
6412 "Non-nil means to always spawn a subshell instead of suspending,\n\
6413 even if the operating system has support for stopping a process.");
6416 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
6417 "Non-nil means prompt with menus when appropriate.\n\
6418 This is done when reading from a keymap that has a prompt string,\n\
6419 for elements that have prompt strings.\n\
6420 The menu is displayed on the screen\n\
6421 if X menus were enabled at configuration\n\
6422 time and the previous event was a mouse click prefix key.\n\
6423 Otherwise, menu prompting uses the echo area.");
6426 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
6427 "Character to see next line of menu prompt.\n\
6428 Type this character while in a menu prompt to rotate around the lines of it.");
6429 XSETINT (menu_prompt_more_char
, ' ');
6431 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
6432 "A mask of additional modifier keys to use with every keyboard character.\n\
6433 Emacs applies the modifiers of the character stored here to each keyboard\n\
6434 character it reads. For example, after evaluating the expression\n\
6435 (setq extra-keyboard-modifiers ?\C-x)\n\
6436 all input characters will have the control modifier applied to them.\n\
6438 Note that the character ?\C-@, equivalent to the integer zero, does\n\
6439 not count as a control character; rather, it counts as a character\n\
6440 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
6441 cancels any modification.");
6442 extra_keyboard_modifiers
= 0;
6444 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
6445 "If an editing command sets this to t, deactivate the mark afterward.\n\
6446 The command loop sets this to nil before each command,\n\
6447 and tests the value when the command returns.\n\
6448 Buffer modification stores t in this variable.");
6449 Vdeactivate_mark
= Qnil
;
6451 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
6452 "Temporary storage of pre-command-hook or post-command-hook.");
6453 Vcommand_hook_internal
= Qnil
;
6455 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
6456 "Normal hook run before each command is executed.\n\
6457 While the hook is run, its value is temporarily set to nil\n\
6458 to avoid an unbreakable infinite loop if a hook function gets an error.\n\
6459 As a result, a hook function cannot straightforwardly alter the value of\n\
6460 `pre-command-hook'. See the Emacs Lisp manual for a way of\n\
6461 implementing hook functions that alter the set of hook functions.");
6462 Vpre_command_hook
= Qnil
;
6464 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
6465 "Normal hook run after each command is executed.\n\
6466 While the hook is run, its value is temporarily set to nil\n\
6467 to avoid an unbreakable infinite loop if a hook function gets an error.\n\
6468 As a result, a hook function cannot straightforwardly alter the value of\n\
6469 `post-command-hook'. See the Emacs Lisp manual for a way of\n\
6470 implementing hook functions that alter the set of hook functions.");
6471 Vpost_command_hook
= Qnil
;
6473 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
6474 "t means menu bar, specified Lucid style, needs to be recomputed.");
6475 Vlucid_menu_bar_dirty_flag
= Qnil
;
6477 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
6478 "List of menu bar items to move to the end of the menu bar.\n\
6479 The elements of the list are event types that may have menu bar bindings.");
6480 Vmenu_bar_final_items
= Qnil
;
6482 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
6483 "Keymap that overrides all other local keymaps.\n\
6484 If this variable is non-nil, it is used as a keymap instead of the\n\
6485 buffer's local map, and the minor mode keymaps and text property keymaps.");
6486 Voverriding_local_map
= Qnil
;
6488 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
6489 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
6490 Otherwise, the menu bar continues to reflect the buffer's local map\n\
6491 and the minor mode maps regardless of `overriding-local-map'.");
6492 Voverriding_local_map_menu_flag
= Qnil
;
6495 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
6496 "*Non-nil means generate motion events for mouse motion.");
6499 DEFVAR_LISP ("system-key-alist", &Vsystem_key_alist
,
6500 "Alist of system-specific X windows key symbols.\n\
6501 Each element should have the form (N . SYMBOL) where N is the\n\
6502 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
6503 and SYMBOL is its name.");
6504 Vsystem_key_alist
= Qnil
;
6506 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
6507 "List of deferred actions to be performed at a later time.\n\
6508 The precise format isn't relevant here; we just check whether it is nil.");
6509 Vdeferred_action_list
= Qnil
;
6511 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
6512 "Function to call to handle deferred actions, after each command.\n\
6513 This function is called with no arguments after each command\n\
6514 whenever `deferred-action-list' is non-nil.");
6515 Vdeferred_action_function
= Qnil
;
6520 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
6521 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
6522 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
6523 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
6524 initial_define_key (meta_map
, 'x', "execute-extended-command");