1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
20 /* Allow config.h to undefine symbols found here. */
29 #include "termhooks.h"
36 #include "dispextern.h"
38 #include "intervals.h"
39 #include "blockinput.h"
44 #include <sys/ioctl.h>
47 #include "syssignal.h"
53 /* Variables for blockinput.h: */
55 /* Non-zero if interrupt input is blocked right now. */
56 int interrupt_input_blocked
;
58 /* Nonzero means an input interrupt has arrived
59 during the current critical section. */
60 int interrupt_input_pending
;
64 extern Lisp_Object Vmouse_grabbed
;
66 /* Make all keyboard buffers much bigger when using X windows. */
67 #define KBD_BUFFER_SIZE 4096
68 #else /* No X-windows, character input */
69 #define KBD_BUFFER_SIZE 256
70 #endif /* No X-windows */
72 /* Following definition copied from eval.c */
76 struct backtrace
*next
;
77 Lisp_Object
*function
;
78 Lisp_Object
*args
; /* Points to vector of args. */
79 int nargs
; /* length of vector. If nargs is UNEVALLED,
80 args points to slot holding list of
85 /* Non-nil disable property on a command means
86 do not execute it; call disabled-command-hook's value instead. */
87 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
89 #define NUM_RECENT_KEYS (100)
90 int recent_keys_index
; /* Index for storing next element into recent_keys */
91 int total_keys
; /* Total number of elements stored into recent_keys */
92 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
94 /* Vector holding the key sequence that invoked the current command.
95 It is reused for each command, and it may be longer than the current
96 sequence; this_command_key_count indicates how many elements
97 actually mean something.
98 It's easier to staticpro a single Lisp_Object than an array. */
99 Lisp_Object this_command_keys
;
100 int this_command_key_count
;
102 extern int minbuf_level
;
104 extern struct backtrace
*backtrace_list
;
106 /* Nonzero means do menu prompting. */
107 static int menu_prompting
;
109 /* Character to see next line of menu prompt. */
110 static Lisp_Object menu_prompt_more_char
;
112 /* For longjmp to where kbd input is being done. */
113 static jmp_buf getcjmp
;
115 /* True while doing kbd input. */
116 int waiting_for_input
;
118 /* True while displaying for echoing. Delays C-g throwing. */
121 /* Nonzero means C-G should cause immediate error-signal. */
124 /* Character to recognize as the help char. */
125 Lisp_Object Vhelp_char
;
127 /* Form to execute when help char is typed. */
128 Lisp_Object Vhelp_form
;
130 /* Command to run when the help character follows a prefix key. */
131 Lisp_Object Vprefix_help_command
;
133 /* List of items that should move to the end of the menu bar. */
134 Lisp_Object Vmenu_bar_final_items
;
136 /* Character that causes a quit. Normally C-g.
138 If we are running on an ordinary terminal, this must be an ordinary
139 ASCII char, since we want to make it our interrupt character.
141 If we are not running on an ordinary terminal, it still needs to be
142 an ordinary ASCII char. This character needs to be recognized in
143 the input interrupt handler. At this point, the keystroke is
144 represented as a struct input_event, while the desired quit
145 character is specified as a lispy event. The mapping from struct
146 input_events to lispy events cannot run in an interrupt handler,
147 and the reverse mapping is difficult for anything but ASCII
150 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
154 extern Lisp_Object current_global_map
;
155 extern int minibuf_level
;
157 /* Current depth in recursive edits. */
158 int command_loop_level
;
160 /* Total number of times command_loop has read a key sequence. */
163 /* Last input character read as a command. */
164 Lisp_Object last_command_char
;
166 /* Last input character read as a command, not counting menus
167 reached by the mouse. */
168 Lisp_Object last_nonmenu_event
;
170 /* Last input character read for any purpose. */
171 Lisp_Object last_input_char
;
173 /* If not Qnil, a list of objects to be read as subsequent command input. */
174 Lisp_Object unread_command_events
;
176 /* If not -1, an event to be read as subsequent command input. */
177 int unread_command_char
;
179 /* If not Qnil, this is a switch-frame event which we decided to put
180 off until the end of a key sequence. This should be read as the
181 next command input, after any unread_command_events.
183 read_key_sequence uses this to delay switch-frame events until the
184 end of the key sequence; Fread_char uses it to put off switch-frame
185 events until a non-ASCII event is acceptable as input. */
186 Lisp_Object unread_switch_frame
;
188 /* A mask of extra modifier bits to put into every keyboard char. */
189 int extra_keyboard_modifiers
;
191 /* Char to use as prefix when a meta character is typed in.
192 This is bound on entry to minibuffer in case ESC is changed there. */
194 Lisp_Object meta_prefix_char
;
196 /* Last size recorded for a current buffer which is not a minibuffer. */
197 static int last_non_minibuf_size
;
199 /* Number of idle seconds before an auto-save and garbage collection. */
200 static Lisp_Object Vauto_save_timeout
;
202 /* Total number of times read_char has returned. */
205 /* Total number of times read_char has returned, outside of macros. */
206 int num_nonmacro_input_chars
;
208 /* Auto-save automatically when this many characters have been typed
209 since the last time. */
211 static int auto_save_interval
;
213 /* Value of num_nonmacro_input_chars as of last auto save. */
217 /* Last command executed by the editor command loop, not counting
218 commands that set the prefix argument. */
220 Lisp_Object last_command
;
222 /* The command being executed by the command loop.
223 Commands may set this, and the value set will be copied into last_command
224 instead of the actual command. */
225 Lisp_Object this_command
;
228 /* The frame in which the last input event occurred, or Qmacro if the
229 last event came from a macro. We use this to determine when to
230 generate switch-frame events. This may be cleared by functions
231 like Fselect_frame, to make sure that a switch-frame event is
232 generated by the next character. */
233 Lisp_Object internal_last_event_frame
;
235 /* A user-visible version of the above, intended to allow users to
236 figure out where the last event came from, if the event doesn't
237 carry that information itself (i.e. if it was a character). */
238 Lisp_Object Vlast_event_frame
;
241 /* The timestamp of the last input event we received from the X server.
242 X Windows wants this for selection ownership. */
243 unsigned long last_event_timestamp
;
245 Lisp_Object Qself_insert_command
;
246 Lisp_Object Qforward_char
;
247 Lisp_Object Qbackward_char
;
248 Lisp_Object Qundefined
;
250 /* read_key_sequence stores here the command definition of the
251 key sequence that it reads. */
252 Lisp_Object read_key_sequence_cmd
;
254 /* Form to evaluate (if non-nil) when Emacs is started. */
255 Lisp_Object Vtop_level
;
257 /* User-supplied string to translate input characters through. */
258 Lisp_Object Vkeyboard_translate_table
;
260 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
261 extern Lisp_Object Vfunction_key_map
;
263 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
264 Lisp_Object Vkey_translation_map
;
266 /* Non-nil means deactivate the mark at end of this command. */
267 Lisp_Object Vdeactivate_mark
;
269 /* Menu bar specified in Lucid Emacs fashion. */
271 Lisp_Object Vlucid_menu_bar_dirty_flag
;
272 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
274 /* Hooks to run before and after each command. */
275 Lisp_Object Qpre_command_hook
, Qpost_command_hook
;
276 Lisp_Object Vpre_command_hook
, Vpost_command_hook
;
278 /* File in which we write all commands we read. */
281 /* Nonzero if input is available. */
284 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
285 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
289 extern char *pending_malloc_warning
;
291 /* Circular buffer for pre-read keyboard input. */
292 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
294 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
296 The interrupt-level event handlers will never enqueue an event on a
297 frame which is not in Vframe_list, and once an event is dequeued,
298 internal_last_event_frame or the event itself points to the frame.
301 But while the event is sitting in the queue, it's completely
302 unprotected. Suppose the user types one command which will run for
303 a while and then delete a frame, and then types another event at
304 the frame that will be deleted, before the command gets around to
305 it. Suppose there are no references to this frame elsewhere in
306 Emacs, and a GC occurs before the second event is dequeued. Now we
307 have an event referring to a freed frame, which will crash Emacs
310 Similar things happen when an event on a scroll bar is enqueued; the
311 window may be deleted while the event is in the queue.
313 So, we use this vector to protect the frame_or_window field in the
314 event queue. That way, they'll be dequeued as dead frames or
315 windows, but still valid lisp objects.
317 If kbd_buffer[i].kind != no_event, then
318 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
319 == kbd_buffer[i].frame_or_window. */
320 static Lisp_Object kbd_buffer_frame_or_window
;
322 /* Pointer to next available character in kbd_buffer.
323 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
324 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
325 next available char is in kbd_buffer[0]. */
326 static struct input_event
*kbd_fetch_ptr
;
328 /* Pointer to next place to store character in kbd_buffer. This
329 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
330 character should go in kbd_buffer[0]. */
334 static struct input_event
*kbd_store_ptr
;
336 /* The above pair of variables forms a "queue empty" flag. When we
337 enqueue a non-hook event, we increment kbd_write_count. When we
338 dequeue a non-hook event, we increment kbd_read_count. We say that
339 there is input available iff the two counters are not equal.
341 Why not just have a flag set and cleared by the enqueuing and
342 dequeuing functions? Such a flag could be screwed up by interrupts
343 at inopportune times. */
345 /* If this flag is non-zero, we check mouse_moved to see when the
346 mouse moves, and motion events will appear in the input stream. If
347 it is zero, mouse motion is ignored. */
348 static int do_mouse_tracking
;
350 /* The window system handling code should set this if the mouse has
351 moved since the last call to the mouse_position_hook. Calling that
352 hook should clear this. Code assumes that if this is set, it can
353 call mouse_position_hook to get the promised position, so don't set
354 it unless you're prepared to substantiate the claim! */
357 /* True iff there is an event in kbd_buffer, or if mouse tracking is
358 enabled and there is a new mouse position in the mouse movement
359 buffer. Note that if this is false, that doesn't mean that there
360 is readable input; all the events in the queue might be button-up
361 events, and do_mouse_tracking might be off. */
362 #define EVENT_QUEUES_EMPTY \
363 ((kbd_fetch_ptr == kbd_store_ptr) && (!do_mouse_tracking || !mouse_moved))
366 /* Symbols to head events. */
367 Lisp_Object Qmouse_movement
;
368 Lisp_Object Qscroll_bar_movement
;
369 Lisp_Object Qswitch_frame
;
371 /* Symbols to denote kinds of events. */
372 Lisp_Object Qfunction_key
;
373 Lisp_Object Qmouse_click
;
374 /* Lisp_Object Qmouse_movement; - also an event header */
376 /* Properties of event headers. */
377 Lisp_Object Qevent_kind
;
378 Lisp_Object Qevent_symbol_elements
;
380 Lisp_Object Qmenu_enable
;
382 /* An event header symbol HEAD may have a property named
383 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
384 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
385 mask of modifiers applied to it. If present, this is used to help
386 speed up parse_modifiers. */
387 Lisp_Object Qevent_symbol_element_mask
;
389 /* An unmodified event header BASE may have a property named
390 Qmodifier_cache, which is an alist mapping modifier masks onto
391 modified versions of BASE. If present, this helps speed up
393 Lisp_Object Qmodifier_cache
;
395 /* Symbols to use for parts of windows. */
396 Lisp_Object Qmode_line
;
397 Lisp_Object Qvertical_line
;
398 Lisp_Object Qvertical_scroll_bar
;
399 Lisp_Object Qmenu_bar
;
401 extern Lisp_Object Qmenu_enable
;
403 Lisp_Object
recursive_edit_unwind (), command_loop ();
404 Lisp_Object
Fthis_command_keys ();
405 Lisp_Object Qextended_command_history
;
407 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
409 EMACS_TIME
*input_available_clear_time
;
411 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
412 Default is 1 if INTERRUPT_INPUT is defined. */
415 /* Nonzero while interrupts are temporarily deferred during redisplay. */
416 int interrupts_deferred
;
418 /* nonzero means use ^S/^Q for flow control. */
421 /* Allow m- file to inhibit use of FIONREAD. */
422 #ifdef BROKEN_FIONREAD
426 /* We are unable to use interrupts if FIONREAD is not available,
427 so flush SIGIO so we won't try. */
434 /* If we support X Windows, turn on the code to poll periodically
435 to detect C-g. It isn't actually used when doing interrupt input. */
436 #ifdef HAVE_X_WINDOWS
437 #define POLL_FOR_INPUT
440 /* Global variable declarations. */
442 /* Function for init_keyboard to call with no args (if nonzero). */
443 void (*keyboard_init_hook
) ();
445 static int read_avail_input ();
446 static void get_input_pending ();
447 static int readable_events ();
448 static Lisp_Object
read_char_menu_prompt ();
449 static Lisp_Object
make_lispy_event ();
450 static Lisp_Object
make_lispy_movement ();
451 static Lisp_Object
modify_event_symbol ();
452 static Lisp_Object
make_lispy_switch_frame ();
454 /* > 0 if we are to echo keystrokes. */
455 static int echo_keystrokes
;
457 /* Nonzero means echo each character as typed. */
458 static int immediate_echo
;
460 /* The text we're echoing in the modeline - partial key sequences,
461 usually. '\0'-terminated. This really shouldn't have a fixed size. */
462 static char echobuf
[300];
464 /* Where to append more text to echobuf if we want to. */
465 static char *echoptr
;
467 #define min(a,b) ((a)<(b)?(a):(b))
468 #define max(a,b) ((a)>(b)?(a):(b))
470 /* Install the string STR as the beginning of the string of echoing,
471 so that it serves as a prompt for the next character.
472 Also start echoing. */
477 int len
= strlen (str
);
478 if (len
> sizeof echobuf
- 4)
479 len
= sizeof echobuf
- 4;
480 bcopy (str
, echobuf
, len
);
481 echoptr
= echobuf
+ len
;
487 /* Add C to the echo string, if echoing is going on.
488 C can be a character, which is printed prettily ("M-C-x" and all that
489 jazz), or a symbol, whose name is printed. */
494 extern char *push_key_description ();
503 /* If someone has passed us a composite event, use its head symbol. */
506 if (XTYPE (c
) == Lisp_Int
)
508 if (ptr
- echobuf
> sizeof echobuf
- 6)
511 ptr
= push_key_description (XINT (c
), ptr
);
513 else if (XTYPE (c
) == Lisp_Symbol
)
515 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
516 if (((ptr
- echobuf
) + name
->size
+ 4) > sizeof echobuf
)
518 bcopy (name
->data
, ptr
, name
->size
);
522 if (echoptr
== echobuf
&& EQ (c
, Vhelp_char
))
524 strcpy (ptr
, " (Type ? for further options)");
535 /* Temporarily add a dash to the end of the echo string if it's not
536 empty, so that it serves as a mini-prompt for the very next character. */
540 if (!immediate_echo
&& echoptr
== echobuf
)
542 /* Do nothing if not echoing at all. */
546 /* Put a dash at the end of the buffer temporarily,
547 but make it go away when the next character is added. */
554 /* Display the current echo string, and begin echoing if not already
564 for (i
= 0; i
< this_command_key_count
; i
++)
565 echo_char (XVECTOR (this_command_keys
)->contents
[i
]);
573 if (waiting_for_input
&& !NILP (Vquit_flag
))
574 quit_throw_to_read_char ();
577 /* Turn off echoing, for the start of a new command. */
585 /* Return the length of the current echo string. */
590 return echoptr
- echobuf
;
593 /* Truncate the current echo message to its first LEN chars.
594 This and echo_char get used by read_key_sequence when the user
595 switches frames while entering a key sequence. */
602 echoptr
= echobuf
+ len
;
606 /* Functions for manipulating this_command_keys. */
608 add_command_key (key
)
611 int size
= XVECTOR (this_command_keys
)->size
;
613 if (this_command_key_count
>= size
)
615 Lisp_Object new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
617 bcopy (XVECTOR (this_command_keys
)->contents
,
618 XVECTOR (new_keys
)->contents
,
619 size
* sizeof (Lisp_Object
));
621 this_command_keys
= new_keys
;
624 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
630 int count
= specpdl_ptr
- specpdl
;
633 if (command_loop_level
> 0)
635 specbind (Qstandard_output
, Qt
);
636 specbind (Qstandard_input
, Qt
);
639 val
= command_loop ();
641 Fsignal (Qquit
, Qnil
);
643 return unbind_to (count
, Qnil
);
646 /* When an auto-save happens, record the "time", and don't do again soon. */
649 last_auto_save
= num_nonmacro_input_chars
;
652 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
653 "Invoke the editor command loop recursively.\n\
654 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
655 that tells this function to return.\n\
656 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
657 This function is called by the editor initialization to begin editing.")
660 int count
= specpdl_ptr
- specpdl
;
663 command_loop_level
++;
664 update_mode_lines
= 1;
666 record_unwind_protect (recursive_edit_unwind
,
668 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
672 return unbind_to (count
, Qnil
);
676 recursive_edit_unwind (buffer
)
680 Fset_buffer (buffer
);
682 command_loop_level
--;
683 update_mode_lines
= 1;
691 Lisp_Object errmsg
, tail
, errname
, file_error
;
698 Vstandard_output
= Qt
;
699 Vstandard_input
= Qt
;
700 Vexecuting_macro
= Qnil
;
701 echo_area_glyphs
= 0;
703 /* If the window system or terminal frame hasn't been initialized
704 yet, or we're not interactive, it's best to dump this message out
705 to stderr and exit. */
706 if (! FRAME_MESSAGE_BUF (selected_frame
)
708 stream
= Qexternal_debugging_output
;
716 errname
= Fcar (data
);
718 if (EQ (errname
, Qerror
))
721 if (!CONSP (data
)) data
= Qnil
;
722 errmsg
= Fcar (data
);
727 errmsg
= Fget (errname
, Qerror_message
);
728 file_error
= Fmemq (Qfile_error
,
729 Fget (errname
, Qerror_conditions
));
732 /* Print an error message including the data items.
733 This is done by printing it into a scratch buffer
734 and then making a copy of the text in the buffer. */
736 if (!CONSP (data
)) data
= Qnil
;
740 /* For file-error, make error message by concatenating
741 all the data items. They are all strings. */
742 if (!NILP (file_error
) && !NILP (tail
))
743 errmsg
= XCONS (tail
)->car
, tail
= XCONS (tail
)->cdr
;
745 if (XTYPE (errmsg
) == Lisp_String
)
746 Fprinc (errmsg
, stream
);
748 write_string_1 ("peculiar error", -1, stream
);
750 for (i
= 0; CONSP (tail
); tail
= Fcdr (tail
), i
++)
752 write_string_1 (i
? ", " : ": ", 2, stream
);
753 if (!NILP (file_error
))
754 Fprinc (Fcar (tail
), stream
);
756 Fprin1 (Fcar (tail
), stream
);
760 /* If the window system or terminal frame hasn't been initialized
761 yet, or we're in -batch mode, this error should cause Emacs to exit. */
762 if (! FRAME_MESSAGE_BUF (selected_frame
)
766 Fkill_emacs (make_number (-1));
771 Vinhibit_quit
= Qnil
;
772 return make_number (0);
775 Lisp_Object
command_loop_1 ();
776 Lisp_Object
command_loop_2 ();
777 Lisp_Object
top_level_1 ();
779 /* Entry to editor-command-loop.
780 This level has the catches for exiting/returning to editor command loop.
781 It returns nil to exit recursive edit, t to abort it. */
786 if (command_loop_level
> 0 || minibuf_level
> 0)
788 return internal_catch (Qexit
, command_loop_2
, Qnil
);
793 internal_catch (Qtop_level
, top_level_1
, Qnil
);
794 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
796 /* End of file in -batch run causes exit here. */
802 /* Here we catch errors in execution of commands within the
803 editing loop, and reenter the editing loop.
804 When there is an error, cmd_error runs and returns a non-nil
805 value to us. A value of nil means that cmd_loop_1 itself
806 returned due to end of file (or end of kbd macro). */
811 register Lisp_Object val
;
814 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
823 return Feval (Vtop_level
);
829 /* On entry to the outer level, run the startup file */
830 if (!NILP (Vtop_level
))
831 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
832 else if (!NILP (Vpurify_flag
))
833 message ("Bare impure Emacs (standard Lisp code not loaded)");
835 message ("Bare Emacs (standard Lisp code not loaded)");
839 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
840 "Exit all recursive editing levels.")
843 Fthrow (Qtop_level
, Qnil
);
846 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
847 "Exit from the innermost recursive edit or minibuffer.")
850 if (command_loop_level
> 0 || minibuf_level
> 0)
851 Fthrow (Qexit
, Qnil
);
853 error ("No recursive edit is in progress");
856 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
857 "Abort the command that requested this recursive edit or minibuffer input.")
860 if (command_loop_level
> 0 || minibuf_level
> 0)
863 error ("No recursive edit is in progress");
866 /* This is the actual command reading loop,
867 sans error-handling encapsulation. */
869 Lisp_Object
Fcommand_execute ();
870 static int read_key_sequence ();
875 Lisp_Object cmd
, tem
;
878 Lisp_Object keybuf
[30];
883 struct buffer
*prev_buffer
;
886 Vdeactivate_mark
= Qnil
;
887 waiting_for_input
= 0;
890 /* Don't clear out last_command at the beginning of a macro. */
891 if (XTYPE (Vexecuting_macro
) != Lisp_String
)
896 this_command_key_count
= 0;
898 /* Make sure this hook runs after commands that get errors and
899 throw to top level. */
900 if (!NILP (Vpost_command_hook
))
901 call1 (Vrun_hooks
, Qpost_command_hook
);
905 /* Install chars successfully executed in kbd macro. */
907 if (defining_kbd_macro
&& NILP (Vprefix_arg
))
908 finalize_kbd_macro_chars ();
910 /* Make sure the current window's buffer is selected. */
911 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
912 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
914 /* Display any malloc warning that just came out. Use while because
915 displaying one warning can cause another. */
917 while (pending_malloc_warning
)
918 display_malloc_warning ();
922 Vdeactivate_mark
= Qnil
;
924 /* If minibuffer on and echo area in use,
925 wait 2 sec and redraw minibuffer. */
927 if (minibuf_level
&& echo_area_glyphs
)
929 /* Bind inhibit-quit to t so that C-g gets read in
930 rather than quitting back to the minibuffer. */
931 int count
= specpdl_ptr
- specpdl
;
932 specbind (Qinhibit_quit
, Qt
);
933 Fsit_for (make_number (2), Qnil
, Qnil
);
934 unbind_to (count
, Qnil
);
936 echo_area_glyphs
= 0;
938 if (!NILP (Vquit_flag
))
941 unread_command_events
= Fcons (make_number (quit_char
), Qnil
);
946 alloca (0); /* Cause a garbage collection now */
947 /* Since we can free the most stuff here. */
948 #endif /* C_ALLOCA */
952 /* Select the frame that the last event came from. Usually,
953 switch-frame events will take care of this, but if some lisp
954 code swallows a switch-frame event, we'll fix things up here.
955 Is this a good idea? */
956 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
957 && XFRAME (internal_last_event_frame
) != selected_frame
)
958 Fselect_frame (internal_last_event_frame
, Qnil
);
961 /* If it has changed current-menubar from previous value,
962 really recompute the menubar from the value. */
963 if (! NILP (Vlucid_menu_bar_dirty_flag
)
964 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
965 call0 (Qrecompute_lucid_menubar
);
967 #if 0 /* This is done in xdisp.c now. */
969 for (tem
= Vframe_list
; CONSP (tem
); tem
= XCONS (tem
)->cdr
)
971 struct frame
*f
= XFRAME (XCONS (tem
)->car
);
972 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
974 /* If the user has switched buffers or windows, we need to
975 recompute to reflect the new bindings. But we'll
976 recompute when update_mode_lines is set too; that means
977 that people can use force-mode-line-update to request
978 that the menu bar be recomputed. The adverse effect on
979 the rest of the redisplay algorithm is about the same as
980 windows_or_buffers_changed anyway. */
981 if (windows_or_buffers_changed
983 || (XFASTINT (w
->last_modified
) < MODIFF
984 && (XFASTINT (w
->last_modified
)
985 <= XBUFFER (w
->buffer
)->save_modified
)))
987 struct buffer
*prev
= current_buffer
;
988 current_buffer
= XBUFFER (w
->buffer
);
989 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items ();
990 current_buffer
= prev
;
993 #endif /* MULTI_FRAME */
996 /* Read next key sequence; i gets its length. */
997 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), Qnil
);
1001 /* Now we have read a key sequence of length I,
1002 or else I is 0 and we found end of file. */
1004 if (i
== 0) /* End of file -- happens only in */
1005 return Qnil
; /* a kbd macro, at the end. */
1006 /* -1 means read_key_sequence got a menu that was rejected.
1007 Just loop around and read another command. */
1011 this_command_key_count
= 0;
1015 last_command_char
= keybuf
[i
- 1];
1017 /* If the previous command tried to force a specific window-start,
1018 forget about that, in case this command moves point far away
1019 from that position. */
1020 XWINDOW (selected_window
)->force_start
= Qnil
;
1022 cmd
= read_key_sequence_cmd
;
1023 if (!NILP (Vexecuting_macro
))
1025 if (!NILP (Vquit_flag
))
1027 Vexecuting_macro
= Qt
;
1028 QUIT
; /* Make some noise. */
1029 /* Will return since macro now empty. */
1033 /* Do redisplay processing after this command except in special
1034 cases identified below that set no_redisplay to 1. */
1037 prev_buffer
= current_buffer
;
1038 prev_modiff
= MODIFF
;
1040 /* Execute the command. */
1043 if (!NILP (Vpre_command_hook
))
1044 call1 (Vrun_hooks
, Qpre_command_hook
);
1046 if (NILP (this_command
))
1048 /* nil means key is undefined. */
1050 defining_kbd_macro
= 0;
1051 update_mode_lines
= 1;
1057 if (NILP (Vprefix_arg
) && ! no_direct
)
1059 /* Recognize some common commands in common situations and
1060 do them directly. */
1061 if (EQ (this_command
, Qforward_char
) && point
< ZV
)
1063 struct Lisp_Vector
*dp
1064 = window_display_table (XWINDOW (selected_window
));
1065 lose
= FETCH_CHAR (point
);
1068 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1069 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1070 : (lose
>= 0x20 && lose
< 0x7f))
1071 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1073 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1075 && !windows_or_buffers_changed
1076 && EQ (current_buffer
->selective_display
, Qnil
)
1077 && !detect_input_pending ()
1078 && NILP (Vexecuting_macro
))
1079 no_redisplay
= direct_output_forward_char (1);
1082 else if (EQ (this_command
, Qbackward_char
) && point
> BEGV
)
1084 struct Lisp_Vector
*dp
1085 = window_display_table (XWINDOW (selected_window
));
1087 lose
= FETCH_CHAR (point
);
1089 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1090 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1091 : (lose
>= 0x20 && lose
< 0x7f))
1092 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1094 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1096 && !windows_or_buffers_changed
1097 && EQ (current_buffer
->selective_display
, Qnil
)
1098 && !detect_input_pending ()
1099 && NILP (Vexecuting_macro
))
1100 no_redisplay
= direct_output_forward_char (-1);
1103 else if (EQ (this_command
, Qself_insert_command
)
1104 /* Try this optimization only on ascii keystrokes. */
1105 && XTYPE (last_command_char
) == Lisp_Int
)
1107 unsigned char c
= XINT (last_command_char
);
1109 if (NILP (Vexecuting_macro
) &&
1110 !EQ (minibuf_window
, selected_window
))
1112 if (!nonundocount
|| nonundocount
>= 20)
1119 lose
= (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1121 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1123 || MODIFF
<= current_buffer
->save_modified
1124 || windows_or_buffers_changed
1125 || !EQ (current_buffer
->selective_display
, Qnil
)
1126 || detect_input_pending ()
1127 || !NILP (Vexecuting_macro
);
1128 if (internal_self_insert (c
, 0))
1134 (point
== ZV
|| FETCH_CHAR (point
) == '\n'))
1136 struct Lisp_Vector
*dp
1137 = window_display_table (XWINDOW (selected_window
));
1142 Lisp_Object obj
= DISP_CHAR_VECTOR (dp
, lose
);
1144 if (XTYPE (obj
) == Lisp_Vector
1145 && XVECTOR (obj
)->size
== 1
1146 && (XTYPE (obj
= XVECTOR (obj
)->contents
[0])
1149 direct_output_for_insert (XINT (obj
));
1153 if (lose
>= 0x20 && lose
<= 0x7e)
1154 no_redisplay
= direct_output_for_insert (lose
);
1161 /* Here for a command that isn't executed directly */
1164 if (NILP (Vprefix_arg
))
1166 Fcommand_execute (this_command
, Qnil
);
1171 if (!NILP (Vpost_command_hook
))
1172 call1 (Vrun_hooks
, Qpost_command_hook
);
1174 /* If there is a prefix argument,
1175 1) We don't want last_command to be ``universal-argument''
1176 (that would be dumb), so don't set last_command,
1177 2) we want to leave echoing on so that the prefix will be
1178 echoed as part of this key sequence, so don't call
1180 3) we want to leave this_command_key_count non-zero, so that
1181 read_char will realize that it is re-reading a character, and
1182 not echo it a second time. */
1183 if (NILP (Vprefix_arg
))
1185 last_command
= this_command
;
1187 this_command_key_count
= 0;
1190 if (!NILP (current_buffer
->mark_active
))
1192 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1194 current_buffer
->mark_active
= Qnil
;
1195 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1197 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1198 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1203 /* Number of seconds between polling for input. */
1206 /* Nonzero means polling for input is temporarily suppressed. */
1207 int poll_suppress_count
;
1209 #ifdef POLL_FOR_INPUT
1210 int polling_for_input
;
1212 /* Handle an alarm once each second and read pending input
1213 so as to handle a C-g if it comces in. */
1216 input_poll_signal ()
1218 if (interrupt_input_blocked
== 0
1219 && !waiting_for_input
)
1220 read_avail_input (0);
1221 signal (SIGALRM
, input_poll_signal
);
1222 alarm (polling_period
);
1227 /* Begin signals to poll for input, if they are appropriate.
1228 This function is called unconditionally from various places. */
1232 #ifdef POLL_FOR_INPUT
1233 if (read_socket_hook
&& !interrupt_input
)
1235 poll_suppress_count
--;
1236 if (poll_suppress_count
== 0)
1238 signal (SIGALRM
, input_poll_signal
);
1239 polling_for_input
= 1;
1240 alarm (polling_period
);
1246 /* Turn off polling. */
1250 #ifdef POLL_FOR_INPUT
1251 if (read_socket_hook
&& !interrupt_input
)
1253 if (poll_suppress_count
== 0)
1255 polling_for_input
= 0;
1258 poll_suppress_count
++;
1263 /* Set the value of poll_suppress_count to COUNT
1264 and start or stop polling accordingly. */
1267 set_poll_suppress_count (count
)
1270 #ifdef POLL_FOR_INPUT
1271 if (count
== 0 && poll_suppress_count
!= 0)
1273 poll_suppress_count
= 1;
1276 else if (count
!= 0 && poll_suppress_count
== 0)
1280 poll_suppress_count
= count
;
1284 /* Applying the control modifier to CHARACTER. */
1289 /* Save the upper bits here. */
1290 int upper
= c
& ~0177;
1294 /* Everything in the columns containing the upper-case letters
1295 denotes a control character. */
1296 if (c
>= 0100 && c
< 0140)
1300 /* Set the shift modifier for a control char
1301 made from a shifted letter. But only for letters! */
1302 if (oc
>= 'A' && oc
<= 'Z')
1303 c
|= shift_modifier
;
1306 /* The lower-case letters denote control characters too. */
1307 else if (c
>= 'a' && c
<= 'z')
1310 /* Include the bits for control and shift
1311 only if the basic ASCII code can't indicate them. */
1315 /* Replace the high bits. */
1316 c
|= (upper
& ~ctrl_modifier
);
1323 /* Input of single characters from keyboard */
1325 Lisp_Object
print_help ();
1326 static Lisp_Object
kbd_buffer_get_event ();
1328 /* read a character from the keyboard; call the redisplay if needed */
1329 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1330 -1 means do not do redisplay, but do do autosaving.
1333 /* The arguments MAPS and NMAPS are for menu prompting.
1334 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1336 PREV_EVENT is the previous input event, or nil if we are reading
1337 the first event of a key sequence.
1339 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1340 if we used a mouse menu to read the input, or zero otherwise. If
1341 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
1343 Value is t if we showed a menu and the user rejected it. */
1346 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1350 Lisp_Object prev_event
;
1351 int *used_mouse_menu
;
1353 register Lisp_Object c
;
1357 if (CONSP (unread_command_events
))
1359 c
= XCONS (unread_command_events
)->car
;
1360 unread_command_events
= XCONS (unread_command_events
)->cdr
;
1362 if (this_command_key_count
== 0)
1368 if (unread_command_char
!= -1)
1370 XSET (c
, Lisp_Int
, unread_command_char
);
1371 unread_command_char
= -1;
1373 if (this_command_key_count
== 0)
1379 if (!NILP (Vexecuting_macro
))
1382 /* We set this to Qmacro; since that's not a frame, nobody will
1383 try to switch frames on us, and the selected window will
1386 Since this event came from a macro, it would be misleading to
1387 leave internal_last_event_frame set to wherever the last
1388 real event came from. Normally, a switch-frame event selects
1389 internal_last_event_frame after each command is read, but
1390 events read from a macro should never cause a new frame to be
1392 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1395 /* Exit the macro if we are at the end.
1396 Also, some things replace the macro with t
1397 to force an early exit. */
1398 if (EQ (Vexecuting_macro
, Qt
)
1399 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1401 XSET (c
, Lisp_Int
, -1);
1405 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1406 if (XTYPE (Vexecuting_macro
) == Lisp_String
1407 && (XINT (c
) & 0x80))
1408 XFASTINT (c
) = CHAR_META
| (XINT (c
) & ~0x80);
1410 executing_macro_index
++;
1415 if (!NILP (unread_switch_frame
))
1417 c
= unread_switch_frame
;
1418 unread_switch_frame
= Qnil
;
1420 /* This event should make it into this_command_keys, and get echoed
1421 again, so we go to reread_first, rather than reread. */
1425 /* Save outer setjmp data, in case called recursively. */
1426 save_getcjmp (save_jump
);
1430 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1433 if (_setjmp (getcjmp
))
1435 XSET (c
, Lisp_Int
, quit_char
);
1437 XSET (internal_last_event_frame
, Lisp_Frame
, selected_frame
);
1438 Vlast_event_frame
= internal_last_event_frame
;
1440 /* If we report the quit char as an event,
1441 don't do so more than once. */
1442 if (!NILP (Vinhibit_quit
))
1448 /* Message turns off echoing unless more keystrokes turn it on again. */
1449 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1452 /* If already echoing, continue. */
1455 /* If in middle of key sequence and minibuffer not active,
1456 start echoing if enough time elapses. */
1457 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1459 && echo_keystrokes
> 0
1460 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1464 /* After a mouse event, start echoing right away.
1465 This is because we are probably about to display a menu,
1466 and we don't want to delay before doing so. */
1467 if (EVENT_HAS_PARAMETERS (prev_event
))
1471 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1477 /* Maybe auto save due to number of keystrokes or idle time. */
1479 if (commandflag
!= 0
1480 && auto_save_interval
> 0
1481 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1482 && !detect_input_pending ())
1485 save_getcjmp (temp
);
1486 Fdo_auto_save (Qnil
, Qnil
);
1487 restore_getcjmp (temp
);
1490 /* Try reading a character via menu prompting.
1491 Try this before the sit-for, because the sit-for
1492 would do the wrong thing if we are supposed to do
1495 if (INTERACTIVE
&& !NILP (prev_event
))
1496 c
= read_char_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1498 /* Slow down auto saves logarithmically in size of current buffer,
1499 and garbage collect while we're at it. */
1500 if (INTERACTIVE
&& NILP (c
))
1502 int delay_level
, buffer_size
;
1504 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1505 last_non_minibuf_size
= Z
- BEG
;
1506 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1508 while (buffer_size
> 64)
1509 delay_level
++, buffer_size
-= buffer_size
>> 2;
1510 if (delay_level
< 4) delay_level
= 4;
1511 /* delay_level is 4 for files under around 50k, 7 at 100k,
1512 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1514 /* Auto save if enough time goes by without input. */
1515 if (commandflag
!= 0
1516 && num_nonmacro_input_chars
> last_auto_save
1517 && XTYPE (Vauto_save_timeout
) == Lisp_Int
1518 && XINT (Vauto_save_timeout
) > 0)
1521 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1522 tem0
= sit_for (delay
, 0, 1, 1);
1526 save_getcjmp (temp
);
1527 Fdo_auto_save (Qnil
, Qnil
);
1528 restore_getcjmp (temp
);
1530 /* If we have auto-saved and there is still no input
1531 available, garbage collect if there has been enough
1532 consing going on to make it worthwhile. */
1533 if (!detect_input_pending ()
1534 && consing_since_gc
> gc_cons_threshold
/ 2)
1536 Fgarbage_collect ();
1543 /* Actually read a character, waiting if necessary. */
1546 c
= kbd_buffer_get_event ();
1549 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1553 /* Terminate Emacs in batch mode if at eof. */
1554 if (noninteractive
&& XTYPE (c
) == Lisp_Int
&& XINT (c
) < 0)
1555 Fkill_emacs (make_number (1));
1557 if (XTYPE (c
) == Lisp_Int
)
1559 /* Add in any extra modifiers, where appropriate. */
1560 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1561 || ((extra_keyboard_modifiers
& 0177) < ' '
1562 && (extra_keyboard_modifiers
& 0177) != 0))
1563 XSETINT (c
, make_ctrl_char (XINT (c
)));
1565 /* Transfer any other modifier bits directly from
1566 extra_keyboard_modifiers to c. Ignore the actual character code
1567 in the low 16 bits of extra_keyboard_modifiers. */
1568 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
1573 restore_getcjmp (save_jump
);
1577 echo_area_glyphs
= 0;
1579 /* Handle things that only apply to characters. */
1580 if (XTYPE (c
) == Lisp_Int
)
1582 /* If kbd_buffer_get_event gave us an EOF, return that. */
1586 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
1587 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1588 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1592 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1593 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1594 recent_keys_index
= 0;
1596 /* Write c to the dribble file. If c is a lispy event, write
1597 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1598 If you, dear reader, have a better idea, you've got the source. :-) */
1601 if (XTYPE (c
) == Lisp_Int
)
1602 putc (XINT (c
), dribble
);
1605 Lisp_Object dribblee
= c
;
1607 /* If it's a structured event, take the event header. */
1608 dribblee
= EVENT_HEAD (dribblee
);
1610 if (XTYPE (dribblee
) == Lisp_Symbol
)
1612 putc ('<', dribble
);
1613 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1614 XSYMBOL (dribblee
)->name
->size
,
1616 putc ('>', dribble
);
1623 store_kbd_macro_char (c
);
1625 num_nonmacro_input_chars
++;
1630 /* Record this character as part of the current key.
1631 Don't record mouse motion; it should never matter. */
1632 if (! (EVENT_HAS_PARAMETERS (c
)
1633 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1636 add_command_key (c
);
1639 /* Re-reading in the middle of a command */
1641 last_input_char
= c
;
1644 /* Process the help character specially if enabled */
1645 if (EQ (c
, Vhelp_char
) && !NILP (Vhelp_form
))
1648 count
= specpdl_ptr
- specpdl
;
1650 record_unwind_protect (Fset_window_configuration
,
1651 Fcurrent_window_configuration (Qnil
));
1653 tem0
= Feval (Vhelp_form
);
1654 if (XTYPE (tem0
) == Lisp_String
)
1655 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1658 c
= read_char (0, 0, 0, Qnil
, 0);
1659 /* Remove the help from the frame */
1660 unbind_to (count
, Qnil
);
1662 if (EQ (c
, make_number (040)))
1665 c
= read_char (0, 0, 0, Qnil
, 0);
1676 Fprinc (object
, Qnil
);
1680 /* Copy out or in the info on where C-g should throw to.
1681 This is used when running Lisp code from within get_char,
1682 in case get_char is called recursively.
1683 See read_process_output. */
1688 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1691 restore_getcjmp (temp
)
1694 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1698 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1699 of this function. */
1701 tracking_off (old_value
)
1702 Lisp_Object old_value
;
1704 if (! XFASTINT (old_value
))
1706 do_mouse_tracking
= 0;
1708 /* Redisplay may have been preempted because there was input
1709 available, and it assumes it will be called again after the
1710 input has been processed. If the only input available was
1711 the sort that we have just disabled, then we need to call
1713 if (!readable_events ())
1715 redisplay_preserve_echo_area ();
1716 get_input_pending (&input_pending
);
1721 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1722 "Evaluate BODY with mouse movement events enabled.\n\
1723 Within a `track-mouse' form, mouse motion generates input events that\n\
1724 you can read with `read-event'.\n\
1725 Normally, mouse motion is ignored.")
1729 int count
= specpdl_ptr
- specpdl
;
1732 XSET (val
, Lisp_Int
, do_mouse_tracking
);
1733 record_unwind_protect (tracking_off
, val
);
1735 do_mouse_tracking
= 1;
1737 val
= Fprogn (args
);
1738 return unbind_to (count
, val
);
1741 /* Low level keyboard/mouse input.
1742 kbd_buffer_store_event places events in kbd_buffer, and
1743 kbd_buffer_get_event retrieves them.
1744 mouse_moved indicates when the mouse has moved again, and
1745 *mouse_position_hook provides the mouse position. */
1747 /* Return true iff there are any events in the queue that read-char
1748 would return. If this returns false, a read-char would block. */
1752 return ! EVENT_QUEUES_EMPTY
;
1755 /* Set this for debugging, to have a way to get out */
1758 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
1761 kbd_buffer_store_event (event
)
1762 register struct input_event
*event
;
1764 if (event
->kind
== no_event
)
1767 if (event
->kind
== ascii_keystroke
)
1769 register int c
= XFASTINT (event
->code
) & 0377;
1771 if (event
->modifiers
& ctrl_modifier
)
1772 c
= make_ctrl_char (c
);
1774 c
|= (event
->modifiers
1775 & (meta_modifier
| alt_modifier
1776 | hyper_modifier
| super_modifier
));
1780 extern SIGTYPE
interrupt_signal ();
1783 /* If this results in a quit_char being returned to Emacs as
1784 input, set Vlast_event_frame properly. If this doesn't
1785 get returned to Emacs as an event, the next event read
1786 will set Vlast_event_frame again, so this is safe to do. */
1789 = FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
1792 internal_last_event_frame
= event
->frame_or_window
;
1794 internal_last_event_frame
= focus
;
1795 Vlast_event_frame
= internal_last_event_frame
;
1799 last_event_timestamp
= event
->timestamp
;
1800 interrupt_signal ();
1804 if (c
&& c
== stop_character
)
1811 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
1812 kbd_store_ptr
= kbd_buffer
;
1814 /* Don't let the very last slot in the buffer become full,
1815 since that would make the two pointers equal,
1816 and that is indistinguishable from an empty buffer.
1817 Discard the event if it would fill the last slot. */
1818 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
1820 kbd_store_ptr
->kind
= event
->kind
;
1821 if (event
->kind
== selection_request_event
)
1823 /* We must not use the ordinary copying code for this case,
1824 since `part' is an enum and copying it might not copy enough
1826 bcopy (event
, kbd_store_ptr
, sizeof (*event
));
1830 kbd_store_ptr
->code
= event
->code
;
1831 kbd_store_ptr
->part
= event
->part
;
1832 kbd_store_ptr
->frame_or_window
= event
->frame_or_window
;
1833 kbd_store_ptr
->modifiers
= event
->modifiers
;
1834 kbd_store_ptr
->x
= event
->x
;
1835 kbd_store_ptr
->y
= event
->y
;
1836 kbd_store_ptr
->timestamp
= event
->timestamp
;
1838 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
1840 = event
->frame_or_window
);
1846 /* Read one event from the event buffer, waiting if necessary.
1847 The value is a Lisp object representing the event.
1848 The value is nil for an event that should be ignored,
1849 or that was handled here.
1850 We always read and discard one event. */
1853 kbd_buffer_get_event ()
1861 XSET (obj
, Lisp_Int
, c
);
1865 /* Wait until there is input available. */
1868 if (!EVENT_QUEUES_EMPTY
)
1871 /* If the quit flag is set, then read_char will return
1872 quit_char, so that counts as "available input." */
1873 if (!NILP (Vquit_flag
))
1874 quit_throw_to_read_char ();
1876 /* One way or another, wait until input is available; then, if
1877 interrupt handlers have not read it, read it now. */
1880 wait_for_kbd_input ();
1882 /* Note SIGIO has been undef'd if FIONREAD is missing. */
1886 if (EVENT_QUEUES_EMPTY
)
1888 Lisp_Object minus_one
;
1890 XSET (minus_one
, Lisp_Int
, -1);
1891 wait_reading_process_input (0, 0, minus_one
, 1);
1893 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
1895 read_avail_input (0);
1898 #endif /* not VMS */
1901 /* At this point, we know that there is a readable event available
1902 somewhere. If the event queue is empty, then there must be a
1903 mouse movement enabled and available. */
1904 if (kbd_fetch_ptr
!= kbd_store_ptr
)
1906 struct input_event
*event
;
1908 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
1912 last_event_timestamp
= event
->timestamp
;
1916 /* These two kinds of events get special handling
1917 and don't actually appear to the command loop.
1918 We return nil for them. */
1919 if (event
->kind
== selection_request_event
)
1922 x_handle_selection_request (event
);
1923 kbd_fetch_ptr
= event
+ 1;
1925 /* We're getting selection request events, but we don't have
1931 else if (event
->kind
== selection_clear_event
)
1934 x_handle_selection_clear (event
);
1935 kbd_fetch_ptr
= event
+ 1;
1937 /* We're getting selection request events, but we don't have
1943 else if (event
->kind
== delete_window_event
)
1947 Fdelete_frame (event
->frame_or_window
, Qt
);
1948 kbd_fetch_ptr
= event
+ 1;
1950 value
= Fvisible_frame_list ();
1951 if (! CONSP (value
))
1952 kill (getpid (), SIGHUP
);
1955 /* Just discard these, by returning nil.
1956 (They shouldn't be found in the buffer,
1957 but on some machines it appears they do show up.) */
1958 else if (event
->kind
== no_event
)
1959 kbd_fetch_ptr
= event
+ 1;
1961 /* If this event is on a different frame, return a switch-frame this
1962 time, and leave the event in the queue for next time. */
1966 Lisp_Object frame
= event
->frame_or_window
;
1969 if (XTYPE (frame
) == Lisp_Window
)
1970 frame
= WINDOW_FRAME (XWINDOW (frame
));
1972 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
1976 if (! EQ (frame
, internal_last_event_frame
)
1977 && XFRAME (frame
) != selected_frame
)
1978 obj
= make_lispy_switch_frame (frame
);
1979 internal_last_event_frame
= frame
;
1980 #endif /* MULTI_FRAME */
1982 /* If we didn't decide to make a switch-frame event, go ahead
1983 and build a real event from the queue entry. */
1987 obj
= make_lispy_event (event
);
1989 /* Wipe out this event, to catch bugs. */
1990 event
->kind
= no_event
;
1991 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
1994 kbd_fetch_ptr
= event
+ 1;
1998 /* Try generating a mouse motion event. */
1999 else if (do_mouse_tracking
&& mouse_moved
)
2002 Lisp_Object bar_window
;
2003 enum scroll_bar_part part
;
2007 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
2012 /* Decide if we should generate a switch-frame event. Don't
2013 generate switch-frame events for motion outside of all Emacs
2017 Lisp_Object frame
= FRAME_FOCUS_FRAME (f
);
2020 XSET (frame
, Lisp_Frame
, f
);
2022 if (! EQ (frame
, internal_last_event_frame
)
2023 && XFRAME (frame
) != selected_frame
)
2024 obj
= make_lispy_switch_frame (frame
);
2025 internal_last_event_frame
= frame
;
2029 /* If we didn't decide to make a switch-frame event, go ahead and
2030 return a mouse-motion event. */
2032 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2035 /* We were promised by the above while loop that there was
2036 something for us to read! */
2039 input_pending
= readable_events ();
2042 Vlast_event_frame
= internal_last_event_frame
;
2048 /* Process any events that are not user-visible,
2049 then return, without reading any user-visible events. */
2054 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2056 struct input_event
*event
;
2058 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2062 last_event_timestamp
= event
->timestamp
;
2064 /* These two kinds of events get special handling
2065 and don't actually appear to the command loop. */
2066 if (event
->kind
== selection_request_event
)
2069 x_handle_selection_request (event
);
2070 kbd_fetch_ptr
= event
+ 1;
2072 /* We're getting selection request events, but we don't have
2078 else if (event
->kind
== selection_clear_event
)
2081 x_handle_selection_clear (event
);
2082 kbd_fetch_ptr
= event
+ 1;
2084 /* We're getting selection request events, but we don't have
2093 get_input_pending (&input_pending
);
2096 /* Caches for modify_event_symbol. */
2097 static Lisp_Object func_key_syms
;
2098 static Lisp_Object mouse_syms
;
2100 /* You'll notice that this table is arranged to be conveniently
2101 indexed by X Windows keysym values. */
2102 static char *lispy_function_keys
[] =
2104 /* X Keysym value */
2106 "remove", 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2114 0, 0, 0, /* 0xff10 */
2116 0, 0, 0, 0, 0, 0, 0,
2119 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2120 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2121 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2123 "home", /* 0xff50 */ /* IsCursorKey */
2134 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2145 "break", /* 0xff6b */
2147 /* Here are some keys found mostly on HP keyboards. The X event
2148 handling code will strip bit 29, which flags vendor-specific
2150 "reset", /* 0x1000ff6c */
2159 "kp-backtab", /* 0x1000ff75 */
2161 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2162 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2163 0, 0, 0, 0, 0, 0, 0, 0,
2164 "kp-tab", /* 0xff89 */
2166 "kp-enter", /* 0xff8d */
2168 "kp-f1", /* 0xff91 */
2173 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2174 "kp-multiply", /* 0xffaa */
2179 "kp-divide", /* 0xffaf */
2180 "kp-0", /* 0xffb0 */
2181 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2184 "kp-equal", /* 0xffbd */
2185 "f1", /* 0xffbe */ /* IsFunctionKey */
2187 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2188 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2189 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2190 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2191 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2192 0, 0, 0, 0, 0, 0, 0, 0,
2193 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2194 0, 0, 0, 0, 0, 0, 0, "delete"
2197 static char *lispy_mouse_names
[] =
2199 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2202 /* Scroll bar parts. */
2203 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2205 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2206 Lisp_Object
*scroll_bar_parts
[] = {
2207 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2211 /* A vector, indexed by button number, giving the down-going location
2212 of currently depressed buttons, both scroll bar and non-scroll bar.
2214 The elements have the form
2215 (BUTTON-NUMBER MODIFIER-MASK . REST)
2216 where REST is the cdr of a position as it would be reported in the event.
2218 The make_lispy_event function stores positions here to tell the
2219 difference between click and drag events, and to store the starting
2220 location to be included in drag events. */
2222 static Lisp_Object button_down_location
;
2224 /* Information about the most recent up-going button event: Which
2225 button, what location, and what time. */
2227 static int last_mouse_button
;
2228 static int last_mouse_x
;
2229 static int last_mouse_y
;
2230 static unsigned long button_down_time
;
2232 /* The maximum time between clicks to make a double-click,
2233 or Qnil to disable double-click detection,
2234 or Qt for no time limit. */
2235 Lisp_Object Vdouble_click_time
;
2237 /* The number of clicks in this multiple-click. */
2239 int double_click_count
;
2241 /* Given a struct input_event, build the lisp event which represents
2242 it. If EVENT is 0, build a mouse movement event from the mouse
2243 movement buffer, which should have a movement event in it.
2245 Note that events must be passed to this function in the order they
2246 are received; this function stores the location of button presses
2247 in order to build drag events when the button is released. */
2250 make_lispy_event (event
)
2251 struct input_event
*event
;
2253 #ifdef SWITCH_ENUM_BUG
2254 switch ((int) event
->kind
)
2256 switch (event
->kind
)
2259 /* A simple keystroke. */
2260 case ascii_keystroke
:
2262 int c
= XFASTINT (event
->code
) & 0377;
2263 /* Turn ASCII characters into control characters
2265 if (event
->modifiers
& ctrl_modifier
)
2266 c
= make_ctrl_char (c
);
2268 /* Add in the other modifier bits. We took care of ctrl_modifier
2269 just above, and the shift key was taken care of by the X code,
2270 and applied to control characters by make_ctrl_char. */
2271 c
|= (event
->modifiers
2272 & (meta_modifier
| alt_modifier
2273 | hyper_modifier
| super_modifier
));
2274 button_down_time
= 0;
2278 /* A function key. The symbol may need to have modifier prefixes
2280 case non_ascii_keystroke
:
2281 button_down_time
= 0;
2282 return modify_event_symbol (XFASTINT (event
->code
), event
->modifiers
,
2284 lispy_function_keys
, &func_key_syms
,
2285 (sizeof (lispy_function_keys
)
2286 / sizeof (lispy_function_keys
[0])));
2289 /* A mouse click. Figure out where it is, decide whether it's
2290 a press, click or drag, and build the appropriate structure. */
2292 case scroll_bar_click
:
2294 int button
= XFASTINT (event
->code
);
2296 Lisp_Object position
;
2297 Lisp_Object
*start_pos_ptr
;
2298 Lisp_Object start_pos
;
2300 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2303 /* Build the position as appropriate for this mouse click. */
2304 if (event
->kind
== mouse_click
)
2307 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2309 = window_from_coordinates (f
, XINT (event
->x
), XINT (event
->y
),
2313 if (XINT (event
->y
) < FRAME_MENU_BAR_LINES (f
))
2317 items
= FRAME_MENU_BAR_ITEMS (f
);
2318 for (; CONSP (items
); items
= XCONS (items
)->cdr
)
2320 Lisp_Object pos
, string
;
2321 pos
= Fcdr (Fcdr (Fcar (items
)));
2322 string
= Fcar (Fcdr (Fcar (items
)));
2323 if (XINT (event
->x
) >= XINT (pos
)
2324 && XINT (event
->x
) < XINT (pos
) + XSTRING (string
)->size
)
2328 = Fcons (event
->frame_or_window
,
2330 Fcons (Fcons (event
->x
, event
->y
),
2331 Fcons (make_number (event
->timestamp
),
2335 return Fcons (Fcar (Fcar (items
)),
2336 Fcons (position
, Qnil
));
2338 return Fcons (Qnil
, Fcons (position
, Qnil
));
2340 else if (XTYPE (window
) != Lisp_Window
)
2345 (XINT (event
->x
) - XINT (XWINDOW (window
)->left
)));
2347 (XINT (event
->y
) - XINT (XWINDOW (window
)->top
)));
2352 posn
= Qvertical_line
;
2354 XSET (posn
, Lisp_Int
,
2355 buffer_posn_from_coords (XWINDOW (window
),
2363 Fcons (Fcons (event
->x
, event
->y
),
2364 Fcons (make_number (event
->timestamp
),
2369 Lisp_Object window
= event
->frame_or_window
;
2370 Lisp_Object portion_whole
= Fcons (event
->x
, event
->y
);
2371 Lisp_Object part
= *scroll_bar_parts
[(int) event
->part
];
2375 Fcons (Qvertical_scroll_bar
,
2376 Fcons (portion_whole
,
2377 Fcons (make_number (event
->timestamp
),
2382 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2384 start_pos
= *start_pos_ptr
;
2385 *start_pos_ptr
= Qnil
;
2387 is_double
= (button
== last_mouse_button
2388 && XINT (event
->x
) == last_mouse_x
2389 && XINT (event
->y
) == last_mouse_y
2390 && button_down_time
!= 0
2391 && (EQ (Vdouble_click_time
, Qt
)
2392 || (INTEGERP (Vdouble_click_time
)
2393 && ((int)(event
->timestamp
- button_down_time
)
2394 < XINT (Vdouble_click_time
)))));
2395 last_mouse_button
= button
;
2396 last_mouse_x
= XINT (event
->x
);
2397 last_mouse_y
= XINT (event
->y
);
2399 /* If this is a button press, squirrel away the location, so
2400 we can decide later whether it was a click or a drag. */
2401 if (event
->modifiers
& down_modifier
)
2405 double_click_count
++;
2406 event
->modifiers
|= ((double_click_count
> 2)
2411 double_click_count
= 1;
2412 button_down_time
= event
->timestamp
;
2413 *start_pos_ptr
= Fcopy_alist (position
);
2416 /* Now we're releasing a button - check the co-ordinates to
2417 see if this was a click or a drag. */
2418 else if (event
->modifiers
& up_modifier
)
2420 /* If we did not see a down before this up,
2421 ignore the up. Probably this happened because
2422 the down event chose a menu item.
2423 It would be an annoyance to treat the release
2424 of the button that chose the menu item
2425 as a separate event. */
2427 if (XTYPE (start_pos
) != Lisp_Cons
)
2430 event
->modifiers
&= ~up_modifier
;
2431 #if 0 /* Formerly we treated an up with no down as a click event. */
2432 if (XTYPE (start_pos
) != Lisp_Cons
)
2433 event
->modifiers
|= click_modifier
;
2437 /* The third element of every position should be the (x,y)
2439 Lisp_Object down
= Fnth (make_number (2), start_pos
);
2441 if (EQ (event
->x
, XCONS (down
)->car
)
2442 && EQ (event
->y
, XCONS (down
)->cdr
))
2444 if (is_double
&& double_click_count
> 1)
2445 event
->modifiers
|= ((double_click_count
> 2)
2449 event
->modifiers
|= click_modifier
;
2453 button_down_time
= 0;
2454 event
->modifiers
|= drag_modifier
;
2459 /* Every mouse event should either have the down_modifier or
2460 the up_modifier set. */
2464 /* Get the symbol we should use for the mouse click. */
2466 = modify_event_symbol (button
,
2469 lispy_mouse_names
, &mouse_syms
,
2470 (sizeof (lispy_mouse_names
)
2471 / sizeof (lispy_mouse_names
[0])));
2473 if (event
->modifiers
& drag_modifier
)
2478 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2481 Fcons (make_number (double_click_count
),
2490 /* The 'kind' field of the event is something we don't recognize. */
2497 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2499 Lisp_Object bar_window
;
2500 enum scroll_bar_part part
;
2504 /* Is it a scroll bar movement? */
2505 if (frame
&& ! NILP (bar_window
))
2507 Lisp_Object part_sym
= *scroll_bar_parts
[(int) part
];
2509 return Fcons (Qscroll_bar_movement
,
2510 (Fcons (Fcons (bar_window
,
2511 Fcons (Qvertical_scroll_bar
,
2512 Fcons (Fcons (x
, y
),
2513 Fcons (make_number (time
),
2519 /* Or is it an ordinary mouse movement? */
2523 Lisp_Object window
=
2525 ? window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
)
2529 if (XTYPE (window
) == Lisp_Window
)
2531 XSETINT (x
, XINT (x
) - XINT (XWINDOW (window
)->left
));
2532 XSETINT (y
, XINT (y
) - XINT (XWINDOW (window
)->top
));
2537 posn
= Qvertical_line
;
2539 XSET (posn
, Lisp_Int
,
2540 buffer_posn_from_coords (XWINDOW (window
),
2541 XINT (x
), XINT (y
)));
2551 return Fcons (Qmouse_movement
,
2552 Fcons (Fcons (window
,
2554 Fcons (Fcons (x
, y
),
2555 Fcons (make_number (time
),
2561 /* Construct a switch frame event. */
2563 make_lispy_switch_frame (frame
)
2566 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
2569 /* Manipulating modifiers. */
2571 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
2573 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2574 SYMBOL's name of the end of the modifiers; the string from this
2575 position is the unmodified symbol name.
2577 This doesn't use any caches. */
2579 parse_modifiers_uncached (symbol
, modifier_end
)
2583 struct Lisp_String
*name
;
2587 CHECK_SYMBOL (symbol
, 1);
2590 name
= XSYMBOL (symbol
)->name
;
2593 for (i
= 0; i
+2 <= name
->size
; )
2594 switch (name
->data
[i
])
2596 #define SINGLE_LETTER_MOD(bit) \
2597 if (name->data[i+1] != '-') \
2598 goto no_more_modifiers; \
2603 SINGLE_LETTER_MOD (alt_modifier
);
2607 SINGLE_LETTER_MOD (ctrl_modifier
);
2611 SINGLE_LETTER_MOD (hyper_modifier
);
2615 SINGLE_LETTER_MOD (meta_modifier
);
2619 SINGLE_LETTER_MOD (shift_modifier
);
2623 SINGLE_LETTER_MOD (super_modifier
);
2627 if (i
+ 5 > name
->size
)
2628 goto no_more_modifiers
;
2629 if (! strncmp (name
->data
+ i
, "drag-", 5))
2631 modifiers
|= drag_modifier
;
2634 else if (! strncmp (name
->data
+ i
, "down-", 5))
2636 modifiers
|= down_modifier
;
2639 else if (i
+ 7 <= name
->size
2640 && ! strncmp (name
->data
+ i
, "double-", 7))
2642 modifiers
|= double_modifier
;
2646 goto no_more_modifiers
;
2650 if (i
+ 7 > name
->size
)
2651 goto no_more_modifiers
;
2652 if (! strncmp (name
->data
+ i
, "triple-", 7))
2654 modifiers
|= triple_modifier
;
2658 goto no_more_modifiers
;
2662 goto no_more_modifiers
;
2664 #undef SINGLE_LETTER_MOD
2668 /* Should we include the `click' modifier? */
2669 if (! (modifiers
& (down_modifier
| drag_modifier
2670 | double_modifier
| triple_modifier
))
2671 && i
+ 7 == name
->size
2672 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
2673 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
2674 modifiers
|= click_modifier
;
2683 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
2684 prepended to the string BASE[0..BASE_LEN-1].
2685 This doesn't use any caches. */
2687 apply_modifiers_uncached (modifiers
, base
, base_len
)
2692 /* Since BASE could contain nulls, we can't use intern here; we have
2693 to use Fintern, which expects a genuine Lisp_String, and keeps a
2696 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
2702 /* Only the event queue may use the `up' modifier; it should always
2703 be turned into a click or drag event before presented to lisp code. */
2704 if (modifiers
& up_modifier
)
2707 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
2708 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
2709 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
2710 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
2711 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
2712 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
2713 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
2714 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
2715 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
2716 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
2717 /* The click modifier is denoted by the absence of other modifiers. */
2721 mod_len
= p
- new_mods
;
2725 Lisp_Object new_name
= make_uninit_string (mod_len
+ base_len
);
2727 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
2728 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
2730 return Fintern (new_name
, Qnil
);
2735 static char *modifier_names
[] =
2737 "up", "down", "drag", "click", "double", "triple", 0, 0,
2738 0, 0, 0, 0, 0, 0, 0, 0,
2739 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
2741 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
2743 static Lisp_Object modifier_symbols
;
2745 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
2747 lispy_modifier_list (modifiers
)
2750 Lisp_Object modifier_list
;
2753 modifier_list
= Qnil
;
2754 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
2755 if (modifiers
& (1<<i
))
2756 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
2759 return modifier_list
;
2763 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
2764 where UNMODIFIED is the unmodified form of SYMBOL,
2765 MASK is the set of modifiers present in SYMBOL's name.
2766 This is similar to parse_modifiers_uncached, but uses the cache in
2767 SYMBOL's Qevent_symbol_element_mask property, and maintains the
2768 Qevent_symbol_elements property. */
2770 parse_modifiers (symbol
)
2773 Lisp_Object elements
= Fget (symbol
, Qevent_symbol_element_mask
);
2775 if (CONSP (elements
))
2780 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
2781 Lisp_Object unmodified
2782 = Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
2783 XSYMBOL (symbol
)->name
->size
- end
),
2787 if (modifiers
& ~((1<<VALBITS
) - 1))
2789 XFASTINT (mask
) = modifiers
;
2790 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
2792 /* Cache the parsing results on SYMBOL. */
2793 Fput (symbol
, Qevent_symbol_element_mask
,
2795 Fput (symbol
, Qevent_symbol_elements
,
2796 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
2798 /* Since we know that SYMBOL is modifiers applied to unmodified,
2799 it would be nice to put that in unmodified's cache.
2800 But we can't, since we're not sure that parse_modifiers is
2807 /* Apply the modifiers MODIFIERS to the symbol BASE.
2808 BASE must be unmodified.
2810 This is like apply_modifiers_uncached, but uses BASE's
2811 Qmodifier_cache property, if present. It also builds
2812 Qevent_symbol_elements properties, since it has that info anyway.
2814 apply_modifiers copies the value of BASE's Qevent_kind property to
2815 the modified symbol. */
2817 apply_modifiers (modifiers
, base
)
2821 Lisp_Object cache
, index
, entry
, new_symbol
;
2823 /* Mask out upper bits. We don't know where this value's been. */
2824 modifiers
&= (1<<VALBITS
) - 1;
2826 /* The click modifier never figures into cache indices. */
2827 cache
= Fget (base
, Qmodifier_cache
);
2828 XFASTINT (index
) = (modifiers
& ~click_modifier
);
2829 entry
= Fassq (index
, cache
);
2832 new_symbol
= XCONS (entry
)->cdr
;
2835 /* We have to create the symbol ourselves. */
2836 new_symbol
= apply_modifiers_uncached (modifiers
,
2837 XSYMBOL (base
)->name
->data
,
2838 XSYMBOL (base
)->name
->size
);
2840 /* Add the new symbol to the base's cache. */
2841 entry
= Fcons (index
, new_symbol
);
2842 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
2844 /* We have the parsing info now for free, so add it to the caches. */
2845 XFASTINT (index
) = modifiers
;
2846 Fput (new_symbol
, Qevent_symbol_element_mask
,
2847 Fcons (base
, Fcons (index
, Qnil
)));
2848 Fput (new_symbol
, Qevent_symbol_elements
,
2849 Fcons (base
, lispy_modifier_list (modifiers
)));
2852 /* Make sure this symbol is of the same kind as BASE.
2854 You'd think we could just set this once and for all when we
2855 intern the symbol above, but reorder_modifiers may call us when
2856 BASE's property isn't set right; we can't assume that just
2857 because it has a Qmodifier_cache property it must have its
2858 Qevent_kind set right as well. */
2859 if (NILP (Fget (new_symbol
, Qevent_kind
)))
2861 Lisp_Object kind
= Fget (base
, Qevent_kind
);
2864 Fput (new_symbol
, Qevent_kind
, kind
);
2871 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
2872 return a symbol with the modifiers placed in the canonical order.
2873 Canonical order is alphabetical, except for down and drag, which
2874 always come last. The 'click' modifier is never written out.
2876 Fdefine_key calls this to make sure that (for example) C-M-foo
2877 and M-C-foo end up being equivalent in the keymap. */
2880 reorder_modifiers (symbol
)
2883 /* It's hopefully okay to write the code this way, since everything
2884 will soon be in caches, and no consing will be done at all. */
2885 Lisp_Object parsed
= parse_modifiers (symbol
);
2887 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
2888 XCONS (parsed
)->car
);
2892 /* For handling events, we often want to produce a symbol whose name
2893 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
2894 to some base, like the name of a function key or mouse button.
2895 modify_event_symbol produces symbols of this sort.
2897 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
2898 is the name of the i'th symbol. TABLE_SIZE is the number of elements
2901 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
2902 persist between calls to modify_event_symbol that it can use to
2903 store a cache of the symbols it's generated for this NAME_TABLE
2906 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
2908 MODIFIERS is a set of modifier bits (as given in struct input_events)
2909 whose prefixes should be applied to the symbol name.
2911 SYMBOL_KIND is the value to be placed in the event_kind property of
2912 the returned symbol.
2914 The symbols we create are supposed to have an
2915 `event-symbol-elements' property, which lists the modifiers present
2916 in the symbol's name. */
2919 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_table
,
2920 symbol_table
, table_size
)
2923 Lisp_Object symbol_kind
;
2925 Lisp_Object
*symbol_table
;
2930 /* Is this a request for a valid symbol? */
2931 if (symbol_num
< 0 || symbol_num
>= table_size
)
2934 /* If *symbol_table doesn't seem to be initialized properly, fix that.
2935 *symbol_table should be a lisp vector TABLE_SIZE elements long,
2936 where the Nth element is the symbol for NAME_TABLE[N], or nil if
2937 we've never used that symbol before. */
2938 if (XTYPE (*symbol_table
) != Lisp_Vector
2939 || XVECTOR (*symbol_table
)->size
!= table_size
)
2943 XFASTINT (size
) = table_size
;
2944 *symbol_table
= Fmake_vector (size
, Qnil
);
2947 slot
= & XVECTOR (*symbol_table
)->contents
[symbol_num
];
2949 /* Have we already used this symbol before? */
2952 /* No; let's create it. */
2953 if (name_table
[symbol_num
])
2954 *slot
= intern (name_table
[symbol_num
]);
2958 sprintf (buf
, "key-%d", symbol_num
);
2959 *slot
= intern (buf
);
2962 /* Fill in the cache entries for this symbol; this also
2963 builds the Qevent_symbol_elements property, which the user
2965 apply_modifiers (modifiers
& click_modifier
, *slot
);
2966 Fput (*slot
, Qevent_kind
, symbol_kind
);
2969 /* Apply modifiers to that symbol. */
2970 return apply_modifiers (modifiers
, *slot
);
2974 /* Store into *addr a value nonzero if terminal input chars are available.
2975 Serves the purpose of ioctl (0, FIONREAD, addr)
2976 but works even if FIONREAD does not exist.
2977 (In fact, this may actually read some input.) */
2980 get_input_pending (addr
)
2983 /* First of all, have we already counted some input? */
2984 *addr
= !NILP (Vquit_flag
) || readable_events ();
2986 /* If input is being read as it arrives, and we have none, there is none. */
2987 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
2990 /* Try to read some input and see how much we get. */
2992 *addr
= !NILP (Vquit_flag
) || readable_events ();
2995 /* Interface to read_avail_input, blocking SIGIO if necessary. */
2998 gobble_input (expected
)
3003 if (interrupt_input
)
3006 mask
= sigblockx (SIGIO
);
3007 read_avail_input (expected
);
3012 read_avail_input (expected
);
3018 /* Read any terminal input already buffered up by the system
3019 into the kbd_buffer, but do not wait.
3021 EXPECTED should be nonzero if the caller knows there is some input.
3023 Except on VMS, all input is read by this function.
3024 If interrupt_input is nonzero, this function MUST be called
3025 only when SIGIO is blocked.
3027 Returns the number of keyboard chars read, or -1 meaning
3028 this is a bad time to try to read input. */
3031 read_avail_input (expected
)
3034 struct input_event buf
[KBD_BUFFER_SIZE
];
3038 if (read_socket_hook
)
3039 /* No need for FIONREAD or fcntl; just say don't wait. */
3040 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
3043 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
3044 the kbd_buffer can really hold. That may prevent loss
3045 of characters on some systems when input is stuffed at us. */
3046 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
3049 /* Find out how much input is available. */
3050 if (ioctl (0, FIONREAD
, &nread
) < 0)
3051 /* Formerly simply reported no input, but that sometimes led to
3052 a failure of Emacs to terminate.
3053 SIGHUP seems appropriate if we can't reach the terminal. */
3054 /* ??? Is it really right to send the signal just to this process
3055 rather than to the whole process group?
3056 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3057 kill (getpid (), SIGHUP
);
3060 if (nread
> sizeof cbuf
)
3061 nread
= sizeof cbuf
;
3062 #else /* no FIONREAD */
3063 #if defined(USG) || defined(DGUX)
3064 /* Read some input if available, but don't wait. */
3065 nread
= sizeof cbuf
;
3066 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
3072 /* Now read; for one reason or another, this will not block. */
3075 int value
= read (fileno (stdin
), cbuf
, nread
);
3077 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3078 This looks incorrect, but it isn't, because _BSD causes
3079 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3080 and that causes a value other than 0 when there is no input. */
3084 /* Retry the read if it is interrupted. */
3086 || ! (errno
== EAGAIN
|| errno
== EFAULT
3099 fcntl (fileno (stdin
), F_SETFL
, 0);
3101 #endif /* no FIONREAD */
3102 for (i
= 0; i
< nread
; i
++)
3104 buf
[i
].kind
= ascii_keystroke
;
3105 buf
[i
].modifiers
= 0;
3106 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3107 buf
[i
].modifiers
= meta_modifier
;
3111 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
3113 XSET (buf
[i
].frame_or_window
, Lisp_Frame
, selected_frame
);
3115 buf
[i
].frame_or_window
= Qnil
;
3120 /* Scan the chars for C-g and store them in kbd_buffer. */
3121 for (i
= 0; i
< nread
; i
++)
3123 kbd_buffer_store_event (&buf
[i
]);
3124 /* Don't look at input that follows a C-g too closely.
3125 This reduces lossage due to autorepeat on C-g. */
3126 if (buf
[i
].kind
== ascii_keystroke
3127 && XINT(buf
[i
].code
) == quit_char
)
3133 #endif /* not VMS */
3135 #ifdef SIGIO /* for entire page */
3136 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3139 input_available_signal (signo
)
3142 /* Must preserve main program's value of errno. */
3143 int old_errno
= errno
;
3145 extern int select_alarmed
;
3149 /* USG systems forget handlers when they are used;
3150 must reestablish each time */
3151 signal (signo
, input_available_signal
);
3158 if (input_available_clear_time
)
3159 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3164 nread
= read_avail_input (1);
3165 /* -1 means it's not ok to read the input now.
3166 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3167 0 means there was no keyboard input available. */
3172 select_alarmed
= 1; /* Force the select emulator back to life */
3183 /* Send ourselves a SIGIO.
3185 This function exists so that the UNBLOCK_INPUT macro in
3186 blockinput.h can have some way to take care of input we put off
3187 dealing with, without assuming that every file which uses
3188 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3190 reinvoke_input_signal ()
3199 /* Return the prompt-string of a sparse keymap.
3200 This is the first element which is a string.
3201 Return nil if there is none. */
3209 register Lisp_Object tem
;
3211 if (XTYPE (tem
) == Lisp_String
)
3218 static Lisp_Object
menu_bar_item ();
3219 static Lisp_Object
menu_bar_one_keymap ();
3221 /* Return a list of menu items for a menu bar, appropriate
3222 to the current buffer.
3223 The elements have the form (KEY STRING . nil). */
3228 /* The number of keymaps we're scanning right now, and the number of
3229 keymaps we have allocated space for. */
3232 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3233 in the current keymaps, or nil where it is not a prefix. */
3236 Lisp_Object def
, tem
, tail
;
3243 /* In order to build the menus, we need to call the keymap
3244 accessors. They all call QUIT. But this function is called
3245 during redisplay, during which a quit is fatal. So inhibit
3246 quitting while building the menus.
3247 We do this instead of specbind because (1) errors will clear it anyway
3248 and (2) this avoids risk of specpdl overflow. */
3249 oquit
= Vinhibit_quit
;
3252 /* Build our list of keymaps.
3253 If we recognize a function key and replace its escape sequence in
3254 keybuf with its symbol, or if the sequence starts with a mouse
3255 click and we need to switch buffers, we jump back here to rebuild
3256 the initial keymaps from the current buffer. */
3260 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3261 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3262 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3263 #ifdef USE_TEXT_PROPERTIES
3264 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3266 maps
[nmaps
-2] = current_buffer
->keymap
;
3268 maps
[nmaps
-1] = current_global_map
;
3271 /* Look up in each map the dummy prefix key `menu-bar'. */
3275 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3277 if (! NILP (maps
[mapno
]))
3278 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3282 tem
= Fkeymapp (def
);
3284 result
= menu_bar_one_keymap (def
, result
);
3287 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3291 elt
= Fassq (XCONS (tail
)->car
, result
);
3293 result
= Fcons (elt
, Fdelq (elt
, result
));
3296 result
= Fnreverse (result
);
3297 Vinhibit_quit
= oquit
;
3301 /* Scan one map KEYMAP, accumulating any menu items it defines
3302 that have not yet been seen in RESULT. Return the updated RESULT. */
3305 menu_bar_one_keymap (keymap
, result
)
3306 Lisp_Object keymap
, result
;
3308 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3310 /* Loop over all keymap entries that have menu strings. */
3311 for (tail
= keymap
; XTYPE (tail
) == Lisp_Cons
; tail
= XCONS (tail
)->cdr
)
3313 item
= XCONS (tail
)->car
;
3314 if (XTYPE (item
) == Lisp_Cons
)
3316 key
= XCONS (item
)->car
;
3317 binding
= XCONS (item
)->cdr
;
3318 if (XTYPE (binding
) == Lisp_Cons
)
3320 item_string
= XCONS (binding
)->car
;
3321 if (XTYPE (item_string
) == Lisp_String
)
3322 result
= menu_bar_item (key
, item_string
,
3323 Fcdr (binding
), result
);
3325 else if (EQ (binding
, Qundefined
))
3326 result
= menu_bar_item (key
, item_string
,
3329 else if (XTYPE (item
) == Lisp_Vector
)
3331 /* Loop over the char values represented in the vector. */
3332 int len
= XVECTOR (item
)->size
;
3334 for (c
= 0; c
< len
; c
++)
3336 Lisp_Object character
;
3337 XFASTINT (character
) = c
;
3338 binding
= XVECTOR (item
)->contents
[c
];
3339 if (XTYPE (binding
) == Lisp_Cons
)
3341 item_string
= XCONS (binding
)->car
;
3342 if (XTYPE (item_string
) == Lisp_String
)
3343 result
= menu_bar_item (key
, item_string
,
3344 Fcdr (binding
), result
);
3346 else if (EQ (binding
, Qundefined
))
3347 result
= menu_bar_item (key
, item_string
,
3357 menu_bar_item (key
, item_string
, def
, result
)
3358 Lisp_Object key
, item_string
, def
, result
;
3361 Lisp_Object enabled
;
3363 if (EQ (def
, Qundefined
))
3365 /* If a map has an explicit nil as definition,
3366 discard any previously made menu bar item. */
3367 tem
= Fassq (key
, result
);
3368 return Fdelq (tem
, result
);
3371 /* See if this entry is enabled. */
3374 if (XTYPE (def
) == Lisp_Symbol
)
3376 /* No property, or nil, means enable.
3377 Otherwise, enable if value is not nil. */
3378 tem
= Fget (def
, Qmenu_enable
);
3380 enabled
= Feval (tem
);
3383 /* Add an entry for this key and string
3384 if there is none yet. */
3385 tem
= Fassq (key
, result
);
3386 if (!NILP (enabled
) && NILP (tem
))
3387 result
= Fcons (Fcons (key
, Fcons (item_string
, Qnil
)), result
);
3392 static int echo_flag
;
3393 static int echo_now
;
3395 /* Read a character using menus based on maps in the array MAPS.
3396 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
3397 Return t if we displayed a menu but the user rejected it.
3399 PREV_EVENT is the previous input event, or nil if we are reading
3400 the first event of a key sequence.
3402 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3403 if we used a mouse menu to read the input, or zero otherwise. If
3404 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
3406 The prompting is done based on the prompt-string of the map
3407 and the strings associated with various map elements. */
3410 read_char_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
3413 Lisp_Object prev_event
;
3414 int *used_mouse_menu
;
3417 register Lisp_Object name
;
3419 int width
= FRAME_WIDTH (selected_frame
) - 4;
3420 char *menu
= (char *) alloca (width
+ 4);
3422 Lisp_Object rest
, vector
;
3424 if (used_mouse_menu
)
3425 *used_mouse_menu
= 0;
3427 /* Use local over global Menu maps */
3429 if (! menu_prompting
)
3432 /* Get the menu name from the first map that has one (a prompt string). */
3433 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3435 name
= map_prompt (maps
[mapno
]);
3440 /* If we don't have any menus, just read a character normally. */
3444 #ifdef HAVE_X_WINDOWS
3446 /* If we got to this point via a mouse click,
3447 use a real menu for mouse selection. */
3448 if (EVENT_HAS_PARAMETERS (prev_event
))
3450 /* Display the menu and get the selection. */
3451 Lisp_Object
*realmaps
3452 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
3456 /* Use the maps that are not nil. */
3457 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3458 if (!NILP (maps
[mapno
]))
3459 realmaps
[nmaps1
++] = maps
[mapno
];
3461 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
3464 /* If we got more than one event, put all but the first
3465 onto this list to be read later.
3466 Return just the first event now. */
3467 unread_command_events
3468 = nconc2 (XCONS (value
)->cdr
, unread_command_events
);
3469 value
= XCONS (value
)->car
;
3473 if (used_mouse_menu
)
3474 *used_mouse_menu
= 1;
3477 #endif /* HAVE_X_MENU */
3478 #endif /* HAVE_X_WINDOWS */
3480 /* Prompt string always starts with map's prompt, and a space. */
3481 strcpy (menu
, XSTRING (name
)->data
);
3482 nlength
= XSTRING (name
)->size
;
3483 menu
[nlength
++] = ':';
3484 menu
[nlength
++] = ' ';
3487 /* Start prompting at start of first map. */
3491 /* Present the documented bindings, a line at a time. */
3499 /* Loop over elements of map. */
3504 /* If reached end of map, start at beginning of next map. */
3508 /* At end of last map, wrap around to first map if just starting,
3509 or end this line if already have something on it. */
3520 /* Look at the next element of the map. */
3522 elt
= XVECTOR (vector
)->contents
[idx
];
3524 elt
= Fcar_safe (rest
);
3526 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
3528 /* If we found a dense table in the keymap,
3529 advanced past it, but start scanning its contents. */
3530 rest
= Fcdr_safe (rest
);
3536 /* An ordinary element. */
3537 s
= Fcar_safe (Fcdr_safe (elt
));
3538 if (XTYPE (s
) != Lisp_String
)
3539 /* Ignore the element if it has no prompt string. */
3541 /* If we have room for the prompt string, add it to this line.
3542 If this is the first on the line, always add it. */
3543 else if (XSTRING (s
)->size
+ i
< width
3548 /* Punctuate between strings. */
3551 strcpy (menu
+ i
, ", ");
3556 /* Add as much of string as fits. */
3557 thiswidth
= XSTRING (s
)->size
;
3558 if (thiswidth
+ i
> width
)
3559 thiswidth
= width
- i
;
3560 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
3565 /* If this element does not fit, end the line now,
3566 and save the element for the next line. */
3567 strcpy (menu
+ i
, "...");
3571 /* Move past this element. */
3572 if (idx
>= 0 && idx
+ 1 >= XVECTOR (rest
)->size
)
3573 /* Handle reaching end of dense table. */
3578 rest
= Fcdr_safe (rest
);
3582 /* Prompt with that and read response. */
3584 obj
= read_char (1, 0, 0, Qnil
, 0);
3586 if (XTYPE (obj
) != Lisp_Int
)
3591 if (! EQ (obj
, menu_prompt_more_char
)
3592 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
3593 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
3598 /* Reading key sequences. */
3600 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
3601 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
3602 keymap, or nil otherwise. Return the index of the first keymap in
3603 which KEY has any binding, or NMAPS if no map has a binding.
3605 If KEY is a meta ASCII character, treat it like meta-prefix-char
3606 followed by the corresponding non-meta character. Keymaps in
3607 CURRENT with non-prefix bindings for meta-prefix-char become nil in
3610 When KEY is not defined in any of the keymaps, if it is an upper
3611 case letter and there are bindings for the corresponding lower-case
3612 letter, return the bindings for the lower-case letter.
3614 If KEY has no bindings in any of the CURRENT maps, NEXT is left
3617 NEXT may == CURRENT. */
3620 follow_key (key
, nmaps
, current
, defs
, next
)
3622 Lisp_Object
*current
, *defs
, *next
;
3625 int i
, first_binding
;
3627 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
3628 followed by the corresponding non-meta character. */
3629 if (XTYPE (key
) == Lisp_Int
&& (XINT (key
) & CHAR_META
))
3631 for (i
= 0; i
< nmaps
; i
++)
3632 if (! NILP (current
[i
]))
3635 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
3637 /* Note that since we pass the resulting bindings through
3638 get_keymap_1, non-prefix bindings for meta-prefix-char
3640 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
3646 XSET (key
, Lisp_Int
, XFASTINT (key
) & ~CHAR_META
);
3649 first_binding
= nmaps
;
3650 for (i
= nmaps
- 1; i
>= 0; i
--)
3652 if (! NILP (current
[i
]))
3654 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3655 if (! NILP (defs
[i
]))
3662 /* When KEY is not defined in any of the keymaps, if it is an upper
3663 case letter and there are bindings for the corresponding
3664 lower-case letter, return the bindings for the lower-case letter. */
3665 if (first_binding
== nmaps
3666 && XTYPE (key
) == Lisp_Int
3667 && ((((XINT (key
) & 0x3ffff)
3668 < XSTRING (current_buffer
->downcase_table
)->size
)
3669 && UPPERCASEP (XINT (key
) & 0x3ffff))
3670 || (XINT (key
) & shift_modifier
)))
3672 if (XINT (key
) & shift_modifier
)
3673 XSETINT (key
, XINT (key
) & ~shift_modifier
);
3675 XSETINT (key
, (DOWNCASE (XINT (key
) & 0x3ffff)
3676 | (XINT (key
) & ~0x3ffff)));
3678 first_binding
= nmaps
;
3679 for (i
= nmaps
- 1; i
>= 0; i
--)
3681 if (! NILP (current
[i
]))
3683 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3684 if (! NILP (defs
[i
]))
3692 /* Given the set of bindings we've found, produce the next set of maps. */
3693 if (first_binding
< nmaps
)
3694 for (i
= 0; i
< nmaps
; i
++)
3695 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
3697 return first_binding
;
3700 /* Read a sequence of keys that ends with a non prefix character,
3701 storing it in KEYBUF, a buffer of size BUFSIZE.
3703 Return the length of the key sequence stored.
3704 Return -1 if the user rejected a command menu.
3706 Echo starting immediately unless `prompt' is 0.
3708 Where a key sequence ends depends on the currently active keymaps.
3709 These include any minor mode keymaps active in the current buffer,
3710 the current buffer's local map, and the global map.
3712 If a key sequence has no other bindings, we check Vfunction_key_map
3713 to see if some trailing subsequence might be the beginning of a
3714 function key's sequence. If so, we try to read the whole function
3715 key, and substitute its symbolic name into the key sequence.
3717 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
3718 `double-' events into similar click events, if that would make them
3719 bound. We try to turn `triple-' events first into `double-' events,
3722 If we get a mouse click in a mode line, vertical divider, or other
3723 non-text area, we treat the click as if it were prefixed by the
3724 symbol denoting that area - `mode-line', `vertical-line', or
3727 If the sequence starts with a mouse click, we read the key sequence
3728 with respect to the buffer clicked on, not the current buffer.
3730 If the user switches frames in the midst of a key sequence, we put
3731 off the switch-frame event until later; the next call to
3732 read_char will return it. */
3735 read_key_sequence (keybuf
, bufsize
, prompt
)
3736 Lisp_Object
*keybuf
;
3740 int count
= specpdl_ptr
- specpdl
;
3742 /* How many keys there are in the current key sequence. */
3745 /* The length of the echo buffer when we started reading, and
3746 the length of this_command_keys when we started reading. */
3750 /* The number of keymaps we're scanning right now, and the number of
3751 keymaps we have allocated space for. */
3753 int nmaps_allocated
= 0;
3755 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
3756 the current keymaps. */
3759 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3760 in the current keymaps, or nil where it is not a prefix. */
3761 Lisp_Object
*submaps
;
3763 /* The index in defs[] of the first keymap that has a binding for
3764 this key sequence. In other words, the lowest i such that
3765 defs[i] is non-nil. */
3768 /* If t < mock_input, then KEYBUF[t] should be read as the next
3771 We use this to recover after recognizing a function key. Once we
3772 realize that a suffix of the current key sequence is actually a
3773 function key's escape sequence, we replace the suffix with the
3774 function key's binding from Vfunction_key_map. Now keybuf
3775 contains a new and different key sequence, so the echo area,
3776 this_command_keys, and the submaps and defs arrays are wrong. In
3777 this situation, we set mock_input to t, set t to 0, and jump to
3778 restart_sequence; the loop will read keys from keybuf up until
3779 mock_input, thus rebuilding the state; and then it will resume
3780 reading characters from the keyboard. */
3783 /* If the sequence is unbound in submaps[], then
3784 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
3785 and fkey_map is its binding.
3787 These might be > t, indicating that all function key scanning
3788 should hold off until t reaches them. We do this when we've just
3789 recognized a function key, to avoid searching for the function
3790 key's again in Vfunction_key_map. */
3791 int fkey_start
= 0, fkey_end
= 0;
3792 Lisp_Object fkey_map
;
3794 /* Likewise, for key_translation_map. */
3795 int keytran_start
= 0, keytran_end
= 0;
3796 Lisp_Object keytran_map
;
3798 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
3799 we put it off for later. While we're reading, we keep the event here. */
3800 Lisp_Object delayed_switch_frame
;
3802 /* See the comment below... */
3803 #if defined (GOBBLE_FIRST_EVENT)
3804 Lisp_Object first_event
;
3807 struct buffer
*starting_buffer
;
3811 last_nonmenu_event
= Qnil
;
3813 delayed_switch_frame
= Qnil
;
3814 fkey_map
= Vfunction_key_map
;
3815 keytran_map
= Vkey_translation_map
;
3817 /* If there is no function-key-map, turn off function key scanning. */
3818 if (NILP (Fkeymapp (Vfunction_key_map
)))
3819 fkey_start
= fkey_end
= bufsize
+ 1;
3821 /* If there is no key-translation-map, turn off scanning. */
3822 if (NILP (Fkeymapp (Vkey_translation_map
)))
3823 keytran_start
= keytran_end
= bufsize
+ 1;
3828 echo_prompt (XSTRING (prompt
)->data
);
3829 else if (cursor_in_echo_area
)
3830 /* This doesn't put in a dash if the echo buffer is empty, so
3831 you don't always see a dash hanging out in the minibuffer. */
3835 /* Record the initial state of the echo area and this_command_keys;
3836 we will need to restore them if we replay a key sequence. */
3838 echo_start
= echo_length ();
3839 keys_start
= this_command_key_count
;
3841 #if defined (GOBBLE_FIRST_EVENT)
3842 /* This doesn't quite work, because some of the things that read_char
3843 does cannot safely be bypassed. It seems too risky to try to make
3846 /* Read the first char of the sequence specially, before setting
3847 up any keymaps, in case a filter runs and switches buffers on us. */
3848 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
3850 #endif /* GOBBLE_FIRST_EVENT */
3852 /* We jump here when the key sequence has been thoroughly changed, and
3853 we need to rescan it starting from the beginning. When we jump here,
3854 keybuf[0..mock_input] holds the sequence we should reread. */
3857 starting_buffer
= current_buffer
;
3859 /* Build our list of keymaps.
3860 If we recognize a function key and replace its escape sequence in
3861 keybuf with its symbol, or if the sequence starts with a mouse
3862 click and we need to switch buffers, we jump back here to rebuild
3863 the initial keymaps from the current buffer. */
3867 nmaps
= current_minor_maps (0, &maps
) + 2;
3868 if (nmaps
> nmaps_allocated
)
3870 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
3871 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
3872 nmaps_allocated
= nmaps
;
3874 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
3875 #ifdef USE_TEXT_PROPERTIES
3876 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3878 submaps
[nmaps
-2] = current_buffer
->keymap
;
3880 submaps
[nmaps
-1] = current_global_map
;
3883 /* Find an accurate initial value for first_binding. */
3884 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
3885 if (! NILP (submaps
[first_binding
]))
3888 /* Start from the beginning in keybuf. */
3891 /* These are no-ops the first time through, but if we restart, they
3892 revert the echo area and this_command_keys to their original state. */
3893 this_command_key_count
= keys_start
;
3895 echo_truncate (echo_start
);
3897 /* If the best binding for the current key sequence is a keymap, or
3898 we may be looking at a function key's escape sequence, keep on
3900 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
3901 || (first_binding
>= nmaps
3903 /* mock input is never part of a function key's sequence. */
3904 && mock_input
<= fkey_start
)
3905 || (first_binding
>= nmaps
3906 && keytran_start
< t
3907 /* mock input is never part of a function key's sequence. */
3908 && mock_input
<= keytran_start
))
3911 int used_mouse_menu
= 0;
3913 /* Where the last real key started. If we need to throw away a
3914 key that has expanded into more than one element of keybuf
3915 (say, a mouse click on the mode line which is being treated
3916 as [mode-line (mouse-...)], then we backtrack to this point
3918 int last_real_key_start
;
3920 /* These variables are analogous to echo_start and keys_start;
3921 while those allow us to restart the entire key sequence,
3922 echo_local_start and keys_local_start allow us to throw away
3924 int echo_local_start
, keys_local_start
, local_first_binding
;
3927 error ("key sequence too long");
3930 echo_local_start
= echo_length ();
3931 keys_local_start
= this_command_key_count
;
3932 local_first_binding
= first_binding
;
3935 /* These are no-ops, unless we throw away a keystroke below and
3936 jumped back up to replay_key; in that case, these restore the
3937 variables to their original state, allowing us to replay the
3940 echo_truncate (echo_local_start
);
3941 this_command_key_count
= keys_local_start
;
3942 first_binding
= local_first_binding
;
3944 /* By default, assume each event is "real". */
3945 last_real_key_start
= t
;
3947 /* Does mock_input indicate that we are re-reading a key sequence? */
3951 add_command_key (key
);
3955 /* If not, we should actually read a character. */
3958 struct buffer
*buf
= current_buffer
;
3960 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
3963 /* read_char returns t when it shows a menu and the user rejects it.
3968 /* read_char returns -1 at the end of a macro.
3969 Emacs 18 handles this by returning immediately with a
3970 zero, so that's what we'll do. */
3971 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) == -1)
3977 /* If we have a quit that was typed in another frame, and
3978 quit_throw_to_read_char switched buffers,
3979 replay to get the right keymap. */
3980 if (EQ (key
, quit_char
) && current_buffer
!= starting_buffer
)
3985 goto replay_sequence
;
3991 /* Clicks in non-text areas get prefixed by the symbol
3992 in their CHAR-ADDRESS field. For example, a click on
3993 the mode line is prefixed by the symbol `mode-line'.
3995 Furthermore, key sequences beginning with mouse clicks
3996 are read using the keymaps of the buffer clicked on, not
3997 the current buffer. So we may have to switch the buffer
4000 When we turn one event into two events, we must make sure
4001 that neither of the two looks like the original--so that,
4002 if we replay the events, they won't be expanded again.
4003 If not for this, such reexpansion could happen either here
4004 or when user programs play with this-command-keys. */
4005 if (EVENT_HAS_PARAMETERS (key
))
4007 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
4009 if (EQ (kind
, Qmouse_click
))
4011 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
4012 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4014 if (XTYPE (posn
) == Lisp_Cons
)
4016 /* We're looking at the second event of a
4017 sequence which we expanded before. Set
4018 last_real_key_start appropriately. */
4020 last_real_key_start
= t
- 1;
4023 /* Key sequences beginning with mouse clicks are
4024 read using the keymaps in the buffer clicked on,
4025 not the current buffer. If we're at the
4026 beginning of a key sequence, switch buffers. */
4027 if (last_real_key_start
== 0
4028 && XTYPE (window
) == Lisp_Window
4029 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
4030 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
4035 /* Arrange to go back to the original buffer once we're
4036 done reading the key sequence. Note that we can't
4037 use save_excursion_{save,restore} here, because they
4038 save point as well as the current buffer; we don't
4039 want to save point, because redisplay may change it,
4040 to accommodate a Fset_window_start or something. We
4041 don't want to do this at the top of the function,
4042 because we may get input from a subprocess which
4043 wants to change the selected window and stuff (say,
4045 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
4047 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
4048 goto replay_sequence
;
4050 else if (XTYPE (posn
) == Lisp_Symbol
)
4052 /* Expand mode-line and scroll-bar events into two events:
4053 use posn as a fake prefix key. */
4055 if (t
+ 1 >= bufsize
)
4056 error ("key sequence too long");
4061 /* Zap the position in key, so we know that we've
4062 expanded it, and don't try to do so again. */
4063 POSN_BUFFER_POSN (EVENT_START (key
))
4064 = Fcons (posn
, Qnil
);
4068 else if (EQ (kind
, Qswitch_frame
))
4070 /* If we're at the beginning of a key sequence, go
4071 ahead and return this event. If we're in the
4072 midst of a key sequence, delay it until the end. */
4075 delayed_switch_frame
= key
;
4081 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4083 /* Handle menu-bar events:
4084 insert the dummy prefix event `menu-bar'. */
4085 if (EQ (posn
, Qmenu_bar
))
4087 if (t
+ 1 >= bufsize
)
4088 error ("key sequence too long");
4089 /* Run the Lucid hook. */
4090 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4091 /* If it has changed current-menubar from previous value,
4092 really recompute the menubar from the value. */
4093 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4094 call0 (Qrecompute_lucid_menubar
);
4098 /* Zap the position in key, so we know that we've
4099 expanded it, and don't try to do so again. */
4100 POSN_BUFFER_POSN (EVENT_START (key
))
4101 = Fcons (posn
, Qnil
);
4104 goto replay_sequence
;
4106 else if (XTYPE (posn
) == Lisp_Cons
)
4108 /* We're looking at the second event of a
4109 sequence which we expanded before. Set
4110 last_real_key_start appropriately. */
4111 if (last_real_key_start
== t
&& t
> 0)
4112 last_real_key_start
= t
- 1;
4117 /* We have finally decided that KEY is something we might want
4119 first_binding
= (follow_key (key
,
4120 nmaps
- first_binding
,
4121 submaps
+ first_binding
,
4122 defs
+ first_binding
,
4123 submaps
+ first_binding
)
4126 /* If KEY wasn't bound, we'll try some fallbacks. */
4127 if (first_binding
>= nmaps
)
4129 Lisp_Object head
= EVENT_HEAD (key
);
4131 if (EQ (head
, Vhelp_char
))
4133 read_key_sequence_cmd
= Vprefix_help_command
;
4135 last_nonmenu_event
= key
;
4139 if (XTYPE (head
) == Lisp_Symbol
)
4141 Lisp_Object breakdown
= parse_modifiers (head
);
4142 int modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4144 /* Attempt to reduce an unbound mouse event to a simpler
4145 event that is bound:
4146 Drags reduce to clicks.
4147 Double-clicks reduce to clicks.
4148 Triple-clicks reduce to double-clicks, then to clicks.
4149 Down-clicks are eliminated.
4150 Double-downs reduce to downs, then are eliminated.
4151 Triple-downs reduce to double-downs, then to downs,
4152 then are eliminated. */
4153 if (modifiers
& (down_modifier
| drag_modifier
4154 | double_modifier
| triple_modifier
))
4156 while (modifiers
& (down_modifier
| drag_modifier
4157 | double_modifier
| triple_modifier
))
4159 Lisp_Object new_head
, new_click
;
4160 if (modifiers
& triple_modifier
)
4161 modifiers
^= (double_modifier
| triple_modifier
);
4162 else if (modifiers
& (drag_modifier
| double_modifier
))
4163 modifiers
&= ~(drag_modifier
| double_modifier
);
4166 /* Dispose of this `down' event by simply jumping
4167 back to replay_key, to get another event.
4169 Note that if this event came from mock input,
4170 then just jumping back to replay_key will just
4171 hand it to us again. So we have to wipe out any
4174 We could delete keybuf[t] and shift everything
4175 after that to the left by one spot, but we'd also
4176 have to fix up any variable that points into
4177 keybuf, and shifting isn't really necessary
4180 Adding prefixes for non-textual mouse clicks
4181 creates two characters of mock input, and both
4182 must be thrown away. If we're only looking at
4183 the prefix now, we can just jump back to
4184 replay_key. On the other hand, if we've already
4185 processed the prefix, and now the actual click
4186 itself is giving us trouble, then we've lost the
4187 state of the keymaps we want to backtrack to, and
4188 we need to replay the whole sequence to rebuild
4191 Beyond that, only function key expansion could
4192 create more than two keys, but that should never
4193 generate mouse events, so it's okay to zero
4194 mock_input in that case too.
4196 Isn't this just the most wonderful code ever? */
4197 if (t
== last_real_key_start
)
4204 mock_input
= last_real_key_start
;
4205 goto replay_sequence
;
4210 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
4212 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
4214 /* Look for a binding for this new key. follow_key
4215 promises that it didn't munge submaps the
4216 last time we called it, since key was unbound. */
4218 = (follow_key (new_click
,
4219 nmaps
- local_first_binding
,
4220 submaps
+ local_first_binding
,
4221 defs
+ local_first_binding
,
4222 submaps
+ local_first_binding
)
4223 + local_first_binding
);
4225 /* If that click is bound, go for it. */
4226 if (first_binding
< nmaps
)
4231 /* Otherwise, we'll leave key set to the drag event. */
4238 /* Normally, last_nonmenu_event gets the previous key we read.
4239 But when a mouse popup menu is being used,
4240 we don't update last_nonmenu_event; it continues to hold the mouse
4241 event that preceded the first level of menu. */
4242 if (!used_mouse_menu
)
4243 last_nonmenu_event
= key
;
4245 /* If the sequence is unbound, see if we can hang a function key
4246 off the end of it. We only want to scan real keyboard input
4247 for function key sequences, so if mock_input says that we're
4248 re-reading old events, don't examine it. */
4249 if (first_binding
>= nmaps
4252 Lisp_Object fkey_next
;
4254 /* Scan from fkey_end until we find a bound suffix. */
4255 while (fkey_end
< t
)
4259 key
= keybuf
[fkey_end
++];
4260 /* Look up meta-characters by prefixing them
4261 with meta_prefix_char. I hate this. */
4262 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4267 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
4269 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4272 fkey_next
= fkey_map
;
4275 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
4277 /* If the function key map gives a function, not an
4278 array, then call the function with no args and use
4279 its value instead. */
4280 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
4283 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4287 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4288 fkey_next
= call1 (fkey_next
, prompt
);
4290 /* If the function returned something invalid,
4291 barf--don't ignore it.
4292 (To ignore it safely, we would need to gcpro a bunch of
4293 other variables.) */
4294 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
4295 error ("Function in function-key-map returns invalid key sequence");
4298 /* If keybuf[fkey_start..fkey_end] is bound in the
4299 function key map and it's a suffix of the current
4300 sequence (i.e. fkey_end == t), replace it with
4301 the binding and restart with fkey_start at the end. */
4302 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
4305 int len
= XFASTINT (Flength (fkey_next
));
4307 t
= fkey_start
+ len
;
4309 error ("key sequence too long");
4311 if (VECTORP (fkey_next
))
4312 bcopy (XVECTOR (fkey_next
)->contents
,
4313 keybuf
+ fkey_start
,
4314 (t
- fkey_start
) * sizeof (keybuf
[0]));
4315 else if (STRINGP (fkey_next
))
4319 for (i
= 0; i
< len
; i
++)
4320 XFASTINT (keybuf
[fkey_start
+ i
])
4321 = XSTRING (fkey_next
)->data
[i
];
4325 fkey_start
= fkey_end
= t
;
4326 fkey_map
= Vfunction_key_map
;
4328 goto replay_sequence
;
4331 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
4333 /* If we no longer have a bound suffix, try a new positions for
4335 if (NILP (fkey_map
))
4337 fkey_end
= ++fkey_start
;
4338 fkey_map
= Vfunction_key_map
;
4343 /* Look for this sequence in key-translation-map. */
4345 Lisp_Object keytran_next
;
4347 /* Scan from keytran_end until we find a bound suffix. */
4348 while (keytran_end
< t
)
4352 key
= keybuf
[keytran_end
++];
4353 /* Look up meta-characters by prefixing them
4354 with meta_prefix_char. I hate this. */
4355 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4360 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
4362 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4365 keytran_next
= keytran_map
;
4368 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
4370 /* If the key translation map gives a function, not an
4371 array, then call the function with no args and use
4372 its value instead. */
4373 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
4374 && keytran_end
== t
)
4376 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4380 GCPRO3 (keytran_map
, keytran_map
, delayed_switch_frame
);
4381 keytran_next
= call1 (keytran_next
, prompt
);
4383 /* If the function returned something invalid,
4384 barf--don't ignore it.
4385 (To ignore it safely, we would need to gcpro a bunch of
4386 other variables.) */
4387 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
4388 error ("Function in function-key-map returns invalid key sequence");
4391 /* If keybuf[keytran_start..keytran_end] is bound in the
4392 key translation map and it's a suffix of the current
4393 sequence (i.e. keytran_end == t), replace it with
4394 the binding and restart with keytran_start at the end. */
4395 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
4396 && keytran_end
== t
)
4398 int len
= XFASTINT (Flength (keytran_next
));
4400 t
= keytran_start
+ len
;
4402 error ("key sequence too long");
4404 if (VECTORP (keytran_next
))
4405 bcopy (XVECTOR (keytran_next
)->contents
,
4406 keybuf
+ keytran_start
,
4407 (t
- keytran_start
) * sizeof (keybuf
[0]));
4408 else if (STRINGP (keytran_next
))
4412 for (i
= 0; i
< len
; i
++)
4413 XFASTINT (keybuf
[keytran_start
+ i
])
4414 = XSTRING (keytran_next
)->data
[i
];
4418 keytran_start
= keytran_end
= t
;
4419 keytran_map
= Vkey_translation_map
;
4421 goto replay_sequence
;
4424 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
4426 /* If we no longer have a bound suffix, try a new positions for
4428 if (NILP (keytran_map
))
4430 keytran_end
= ++keytran_start
;
4431 keytran_map
= Vkey_translation_map
;
4437 read_key_sequence_cmd
= (first_binding
< nmaps
4438 ? defs
[first_binding
]
4442 unread_switch_frame
= delayed_switch_frame
;
4443 unbind_to (count
, Qnil
);
4445 /* Occasionally we fabricate events, perhaps by expanding something
4446 according to function-key-map, or by adding a prefix symbol to a
4447 mouse click in the scroll bar or modeline. In this cases, return
4448 the entire generated key sequence, even if we hit an unbound
4449 prefix or a definition before the end. This means that you will
4450 be able to push back the event properly, and also means that
4451 read-key-sequence will always return a logical unit.
4454 for (; t
< mock_input
; t
++)
4456 echo_char (keybuf
[t
]);
4457 add_command_key (keybuf
[t
]);
4463 #if 0 /* This doc string is too long for some compilers.
4464 This commented-out definition serves for DOC. */
4465 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4466 "Read a sequence of keystrokes and return as a string or vector.\n\
4467 The sequence is sufficient to specify a non-prefix command in the\n\
4468 current local and global maps.\n\
4470 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
4471 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
4472 as a continuation of the previous key.\n\
4474 A C-g typed while in this function is treated like any other character,\n\
4475 and `quit-flag' is not set.\n\
4477 If the key sequence starts with a mouse click, then the sequence is read\n\
4478 using the keymaps of the buffer of the window clicked in, not the buffer\n\
4479 of the selected window as normal.\n\
4481 `read-key-sequence' drops unbound button-down events, since you normally\n\
4482 only care about the click or drag events which follow them. If a drag\n\
4483 or multi-click event is unbound, but the corresponding click event would\n\
4484 be bound, `read-key-sequence' turns the event into a click event at the\n\
4485 drag's starting position. This means that you don't have to distinguish\n\
4486 between click and drag, double, or triple events unless you want to.\n\
4488 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
4489 lines separating windows, and scroll bars with imaginary keys\n\
4490 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
4492 If the user switches frames in the middle of a key sequence, the\n\
4493 frame-switch event is put off until after the current key sequence.\n\
4495 `read-key-sequence' checks `function-key-map' for function key\n\
4496 sequences, where they wouldn't conflict with ordinary bindings. See\n\
4497 `function-key-map' for more details.")
4498 (prompt
, continue_echo
)
4501 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4503 (prompt
, continue_echo
)
4504 Lisp_Object prompt
, continue_echo
;
4506 Lisp_Object keybuf
[30];
4508 struct gcpro gcpro1
, gcpro2
;
4511 CHECK_STRING (prompt
, 0);
4514 bzero (keybuf
, sizeof keybuf
);
4516 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
4518 if (NILP (continue_echo
))
4519 this_command_key_count
= 0;
4521 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])), prompt
);
4529 return make_event_array (i
, keybuf
);
4532 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
4533 "Execute CMD as an editor command.\n\
4534 CMD must be a symbol that satisfies the `commandp' predicate.\n\
4535 Optional second arg RECORD-FLAG non-nil\n\
4536 means unconditionally put this command in `command-history'.\n\
4537 Otherwise, that is done only if an arg is read using the minibuffer.")
4539 Lisp_Object cmd
, record
;
4541 register Lisp_Object final
;
4542 register Lisp_Object tem
;
4543 Lisp_Object prefixarg
;
4544 struct backtrace backtrace
;
4545 extern int debug_on_next_call
;
4547 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
4548 Vcurrent_prefix_arg
= prefixarg
;
4549 debug_on_next_call
= 0;
4551 if (XTYPE (cmd
) == Lisp_Symbol
)
4553 tem
= Fget (cmd
, Qdisabled
);
4555 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
4560 final
= Findirect_function (cmd
);
4562 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
4563 do_autoload (final
, cmd
);
4568 if (XTYPE (final
) == Lisp_String
4569 || XTYPE (final
) == Lisp_Vector
)
4571 /* If requested, place the macro in the command history. For
4572 other sorts of commands, call-interactively takes care of
4576 = Fcons (Fcons (Qexecute_kbd_macro
,
4577 Fcons (final
, Fcons (prefixarg
, Qnil
))),
4580 return Fexecute_kbd_macro (final
, prefixarg
);
4582 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
4583 || XTYPE (final
) == Lisp_Compiled
)
4585 backtrace
.next
= backtrace_list
;
4586 backtrace_list
= &backtrace
;
4587 backtrace
.function
= &Qcall_interactively
;
4588 backtrace
.args
= &cmd
;
4589 backtrace
.nargs
= 1;
4590 backtrace
.evalargs
= 0;
4592 tem
= Fcall_interactively (cmd
, record
);
4594 backtrace_list
= backtrace
.next
;
4600 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
4602 "Read function name, then read its arguments and call it.")
4604 Lisp_Object prefixarg
;
4606 Lisp_Object function
;
4608 Lisp_Object saved_keys
;
4609 struct gcpro gcpro1
;
4611 saved_keys
= Fthis_command_keys ();
4613 GCPRO1 (saved_keys
);
4615 if (EQ (prefixarg
, Qminus
))
4617 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
4618 strcpy (buf
, "C-u ");
4619 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
4620 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
4621 else if (XTYPE (prefixarg
) == Lisp_Int
)
4622 sprintf (buf
, "%d ", XINT (prefixarg
));
4624 /* This isn't strictly correct if execute-extended-command
4625 is bound to anything else. Perhaps it should use
4626 this_command_keys? */
4627 strcat (buf
, "M-x ");
4629 /* Prompt with buf, and then read a string, completing from and
4630 restricting to the set of all defined commands. Don't provide
4631 any initial input. Save the command read on the extended-command
4633 function
= Fcompleting_read (build_string (buf
),
4634 Vobarray
, Qcommandp
,
4635 Qt
, Qnil
, Qextended_command_history
);
4637 /* Set this_command_keys to the concatenation of saved_keys and
4638 function, followed by a RET. */
4640 struct Lisp_String
*str
;
4644 this_command_key_count
= 0;
4646 str
= XSTRING (saved_keys
);
4647 for (i
= 0; i
< str
->size
; i
++)
4649 XFASTINT (tem
) = str
->data
[i
];
4650 add_command_key (tem
);
4653 str
= XSTRING (function
);
4654 for (i
= 0; i
< str
->size
; i
++)
4656 XFASTINT (tem
) = str
->data
[i
];
4657 add_command_key (tem
);
4660 XFASTINT (tem
) = '\015';
4661 add_command_key (tem
);
4666 function
= Fintern (function
, Qnil
);
4667 Vprefix_arg
= prefixarg
;
4668 this_command
= function
;
4670 return Fcommand_execute (function
, Qt
);
4674 detect_input_pending ()
4677 get_input_pending (&input_pending
);
4679 return input_pending
;
4682 /* This is called in some cases before a possible quit.
4683 It cases the next call to detect_input_pending to recompute input_pending.
4684 So calling this function unnecessarily can't do any harm. */
4685 clear_input_pending ()
4690 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
4691 "T if command input is currently available with no waiting.\n\
4692 Actually, the value is nil only if we can be sure that no input is available.")
4695 if (!NILP (unread_command_events
) || unread_command_char
!= -1)
4698 return detect_input_pending () ? Qt
: Qnil
;
4701 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
4702 "Return vector of last 100 events, not counting those from keyboard macros.")
4705 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
4708 if (total_keys
< NUM_RECENT_KEYS
)
4709 return Fvector (total_keys
, keys
);
4712 val
= Fvector (NUM_RECENT_KEYS
, keys
);
4713 bcopy (keys
+ recent_keys_index
,
4714 XVECTOR (val
)->contents
,
4715 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
4717 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
4718 recent_keys_index
* sizeof (Lisp_Object
));
4723 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
4724 "Return the key sequence that invoked this command.\n\
4725 The value is a string or a vector.")
4728 return make_event_array (this_command_key_count
,
4729 XVECTOR (this_command_keys
)->contents
);
4732 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
4733 "Return the current depth in recursive edits.")
4737 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
4741 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
4742 "FOpen dribble file: ",
4743 "Start writing all keyboard characters to a dribble file called FILE.\n\
4744 If FILE is nil, close any open dribble file.")
4755 file
= Fexpand_file_name (file
, Qnil
);
4756 dribble
= fopen (XSTRING (file
)->data
, "w");
4761 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
4762 "Discard the contents of the terminal input buffer.\n\
4763 Also cancel any kbd macro being defined.")
4766 defining_kbd_macro
= 0;
4767 update_mode_lines
++;
4769 unread_command_events
= Qnil
;
4770 unread_command_char
= -1;
4772 discard_tty_input ();
4774 /* Without the cast, GCC complains that this assignment loses the
4775 volatile qualifier of kbd_store_ptr. Is there anything wrong
4777 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
4778 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
4784 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
4785 "Stop Emacs and return to superior process. You can resume later.\n\
4786 On systems that don't have job control, run a subshell instead.\n\n\
4787 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
4788 to be read as terminal input by Emacs's parent, after suspension.\n\
4790 Before suspending, call the functions in `suspend-hook' with no args.\n\
4791 If any of them returns nil, don't call the rest and don't suspend.\n\
4792 Otherwise, suspend normally and after resumption run the normal hook\n\
4793 `suspend-resume-hook' if that is bound and non-nil.\n\
4795 Some operating systems cannot stop the Emacs process and resume it later.\n\
4796 On such systems, Emacs starts a subshell instead of suspending.")
4798 Lisp_Object stuffstring
;
4801 int count
= specpdl_ptr
- specpdl
;
4802 int old_height
, old_width
;
4804 struct gcpro gcpro1
, gcpro2
;
4805 extern init_sys_modes ();
4807 if (!NILP (stuffstring
))
4808 CHECK_STRING (stuffstring
, 0);
4810 /* Run the functions in suspend-hook. */
4811 if (!NILP (Vrun_hooks
))
4812 call1 (Vrun_hooks
, intern ("suspend-hook"));
4814 GCPRO1 (stuffstring
);
4815 get_frame_size (&old_width
, &old_height
);
4817 /* sys_suspend can get an error if it tries to fork a subshell
4818 and the system resources aren't available for that. */
4819 record_unwind_protect (init_sys_modes
, 0);
4820 stuff_buffered_input (stuffstring
);
4822 unbind_to (count
, Qnil
);
4824 /* Check if terminal/window size has changed.
4825 Note that this is not useful when we are running directly
4826 with a window system; but suspend should be disabled in that case. */
4827 get_frame_size (&width
, &height
);
4828 if (width
!= old_width
|| height
!= old_height
)
4829 change_frame_size (selected_frame
, height
, width
, 0, 0);
4831 /* Run suspend-resume-hook. */
4832 if (!NILP (Vrun_hooks
))
4833 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
4839 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
4840 Then in any case stuff anything Emacs has read ahead and not used. */
4842 stuff_buffered_input (stuffstring
)
4843 Lisp_Object stuffstring
;
4845 register unsigned char *p
;
4847 /* stuff_char works only in BSD, versions 4.2 and up. */
4850 if (XTYPE (stuffstring
) == Lisp_String
)
4854 p
= XSTRING (stuffstring
)->data
;
4855 count
= XSTRING (stuffstring
)->size
;
4860 /* Anything we have read ahead, put back for the shell to read. */
4861 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4863 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4864 kbd_fetch_ptr
= kbd_buffer
;
4865 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
4866 stuff_char (XINT (kbd_fetch_ptr
->code
));
4867 kbd_fetch_ptr
->kind
= no_event
;
4868 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
4875 #endif /* BSD and not BSD4_1 */
4878 set_waiting_for_input (time_to_clear
)
4879 EMACS_TIME
*time_to_clear
;
4881 input_available_clear_time
= time_to_clear
;
4883 /* Tell interrupt_signal to throw back to read_char, */
4884 waiting_for_input
= 1;
4886 /* If interrupt_signal was called before and buffered a C-g,
4887 make it run again now, to avoid timing error. */
4888 if (!NILP (Vquit_flag
))
4889 quit_throw_to_read_char ();
4891 /* If alarm has gone off already, echo now. */
4899 clear_waiting_for_input ()
4901 /* Tell interrupt_signal not to throw back to read_char, */
4902 waiting_for_input
= 0;
4903 input_available_clear_time
= 0;
4906 /* This routine is called at interrupt level in response to C-G.
4907 If interrupt_input, this is the handler for SIGINT.
4908 Otherwise, it is called from kbd_buffer_store_event,
4909 in handling SIGIO or SIGTINT.
4911 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
4912 immediately throw back to read_char.
4914 Otherwise it sets the Lisp variable quit-flag not-nil.
4915 This causes eval to throw, when it gets a chance.
4916 If quit-flag is already non-nil, it stops the job right away. */
4922 /* Must preserve main program's value of errno. */
4923 int old_errno
= errno
;
4926 /* USG systems forget handlers when they are used;
4927 must reestablish each time */
4928 signal (SIGINT
, interrupt_signal
);
4929 signal (SIGQUIT
, interrupt_signal
);
4934 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
4939 #ifdef SIGTSTP /* Support possible in later USG versions */
4941 * On systems which can suspend the current process and return to the original
4942 * shell, this command causes the user to end up back at the shell.
4943 * The "Auto-save" and "Abort" questions are not asked until
4944 * the user elects to return to emacs, at which point he can save the current
4945 * job and either dump core or continue.
4950 if (sys_suspend () == -1)
4952 printf ("Not running as a subprocess;\n");
4953 printf ("you can continue or abort.\n");
4956 /* Perhaps should really fork an inferior shell?
4957 But that would not provide any way to get back
4958 to the original shell, ever. */
4959 printf ("No support for stopping a process on this operating system;\n");
4960 printf ("you can continue or abort.\n");
4961 #endif /* not VMS */
4962 #endif /* not SIGTSTP */
4963 printf ("Auto-save? (y or n) ");
4965 if (((c
= getchar ()) & ~040) == 'Y')
4967 Fdo_auto_save (Qt
, Qnil
);
4968 printf ("Auto-save done\n");
4970 while (c
!= '\n') c
= getchar ();
4972 printf ("Abort (and enter debugger)? (y or n) ");
4974 printf ("Abort (and dump core)? (y or n) ");
4975 #endif /* not VMS */
4977 if (((c
= getchar ()) & ~040) == 'Y')
4979 while (c
!= '\n') c
= getchar ();
4980 printf ("Continuing...\n");
4986 /* If executing a function that wants to be interrupted out of
4987 and the user has not deferred quitting by binding `inhibit-quit'
4988 then quit right away. */
4989 if (immediate_quit
&& NILP (Vinhibit_quit
))
4993 Fsignal (Qquit
, Qnil
);
4996 /* Else request quit when it's safe */
5000 if (waiting_for_input
&& !echoing
)
5001 quit_throw_to_read_char ();
5006 /* Handle a C-g by making read_char return C-g. */
5008 quit_throw_to_read_char ()
5010 quit_error_check ();
5012 /* Prevent another signal from doing this before we finish. */
5013 clear_waiting_for_input ();
5016 unread_command_events
= Qnil
;
5017 unread_command_char
= -1;
5019 #ifdef POLL_FOR_INPUT
5020 /* May be > 1 if in recursive minibuffer. */
5021 if (poll_suppress_count
== 0)
5025 if (XFRAME (internal_last_event_frame
) != selected_frame
)
5026 Fhandle_switch_frame (make_lispy_switch_frame (internal_last_event_frame
));
5029 _longjmp (getcjmp
, 1);
5032 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
5033 "Set mode of reading keyboard input.\n\
5034 First arg INTERRUPT non-nil means use input interrupts;\n\
5035 nil means use CBREAK mode.\n\
5036 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
5037 (no effect except in CBREAK mode).\n\
5038 Third arg META t means accept 8-bit input (for a Meta key).\n\
5039 META nil means ignore the top bit, on the assumption it is parity.\n\
5040 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
5041 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
5042 See also `current-input-mode'.")
5043 (interrupt
, flow
, meta
, quit
)
5044 Lisp_Object interrupt
, flow
, meta
, quit
;
5047 && (XTYPE (quit
) != Lisp_Int
5048 || XINT (quit
) < 0 || XINT (quit
) > 0400))
5049 error ("set-input-mode: QUIT must be an ASCII character");
5051 #ifdef POLL_FOR_INPUT
5057 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5058 #ifdef NO_SOCK_SIGIO
5059 if (read_socket_hook
)
5060 interrupt_input
= 0; /* No interrupts if reading from a socket. */
5062 #endif /* NO_SOCK_SIGIO */
5063 interrupt_input
= !NILP (interrupt
);
5064 #else /* not SIGIO */
5065 interrupt_input
= 0;
5066 #endif /* not SIGIO */
5067 /* Our VMS input only works by interrupts, as of now. */
5069 interrupt_input
= 1;
5071 flow_control
= !NILP (flow
);
5074 else if (EQ (meta
, Qt
))
5079 /* Don't let this value be out of range. */
5080 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
5084 #ifdef POLL_FOR_INPUT
5085 poll_suppress_count
= 1;
5091 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
5092 "Return information about the way Emacs currently reads keyboard input.\n\
5093 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
5094 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
5095 nil, Emacs is using CBREAK mode.\n\
5096 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
5097 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
5098 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
5099 META nil means ignoring the top bit, on the assumption it is parity.\n\
5100 META is neither t nor nil if accepting 8-bit input and using\n\
5101 all 8 bits as the character code.\n\
5102 QUIT is the character Emacs currently uses to quit.\n\
5103 The elements of this list correspond to the arguments of\n\
5109 val
[0] = interrupt_input
? Qt
: Qnil
;
5110 val
[1] = flow_control
? Qt
: Qnil
;
5111 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
5112 XFASTINT (val
[3]) = quit_char
;
5114 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
5120 /* This is correct before outermost invocation of the editor loop */
5121 command_loop_level
= -1;
5123 quit_char
= Ctl ('g');
5124 unread_command_events
= Qnil
;
5125 unread_command_char
= -1;
5127 recent_keys_index
= 0;
5128 kbd_fetch_ptr
= kbd_buffer
;
5129 kbd_store_ptr
= kbd_buffer
;
5130 do_mouse_tracking
= 0;
5134 /* This means that command_loop_1 won't try to select anything the first
5136 internal_last_event_frame
= Qnil
;
5137 Vlast_event_frame
= internal_last_event_frame
;
5140 /* If we're running a dumped Emacs, we need to clear out
5141 kbd_buffer_frame_or_window, in case some events got into it
5144 If we're running an undumped Emacs, it hasn't been initialized by
5145 syms_of_keyboard yet. */
5147 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5149 if (!noninteractive
)
5151 signal (SIGINT
, interrupt_signal
);
5152 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
5153 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
5154 SIGQUIT and we can't tell which one it will give us. */
5155 signal (SIGQUIT
, interrupt_signal
);
5156 #endif /* HAVE_TERMIO */
5157 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5159 signal (SIGIO
, input_available_signal
);
5163 /* Use interrupt input by default, if it works and noninterrupt input
5164 has deficiencies. */
5166 #ifdef INTERRUPT_INPUT
5167 interrupt_input
= 1;
5169 interrupt_input
= 0;
5172 /* Our VMS input only works by interrupts, as of now. */
5174 interrupt_input
= 1;
5180 if (keyboard_init_hook
)
5181 (*keyboard_init_hook
) ();
5183 #ifdef POLL_FOR_INPUT
5184 poll_suppress_count
= 1;
5189 /* This type's only use is in syms_of_keyboard, to initialize the
5190 event header symbols and put properties on them. */
5197 struct event_head head_table
[] = {
5198 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
5199 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
5200 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
5205 Qdisabled_command_hook
= intern ("disabled-command-hook");
5206 staticpro (&Qdisabled_command_hook
);
5208 Qself_insert_command
= intern ("self-insert-command");
5209 staticpro (&Qself_insert_command
);
5211 Qforward_char
= intern ("forward-char");
5212 staticpro (&Qforward_char
);
5214 Qbackward_char
= intern ("backward-char");
5215 staticpro (&Qbackward_char
);
5217 Qdisabled
= intern ("disabled");
5218 staticpro (&Qdisabled
);
5220 Qundefined
= intern ("undefined");
5221 staticpro (&Qundefined
);
5223 Qpre_command_hook
= intern ("pre-command-hook");
5224 staticpro (&Qpre_command_hook
);
5226 Qpost_command_hook
= intern ("post-command-hook");
5227 staticpro (&Qpost_command_hook
);
5229 Qfunction_key
= intern ("function-key");
5230 staticpro (&Qfunction_key
);
5231 Qmouse_click
= intern ("mouse-click");
5232 staticpro (&Qmouse_click
);
5234 Qmenu_enable
= intern ("menu-enable");
5235 staticpro (&Qmenu_enable
);
5237 Qmode_line
= intern ("mode-line");
5238 staticpro (&Qmode_line
);
5239 Qvertical_line
= intern ("vertical-line");
5240 staticpro (&Qvertical_line
);
5241 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
5242 staticpro (&Qvertical_scroll_bar
);
5243 Qmenu_bar
= intern ("menu-bar");
5244 staticpro (&Qmenu_bar
);
5246 Qabove_handle
= intern ("above-handle");
5247 staticpro (&Qabove_handle
);
5248 Qhandle
= intern ("handle");
5249 staticpro (&Qhandle
);
5250 Qbelow_handle
= intern ("below-handle");
5251 staticpro (&Qbelow_handle
);
5253 Qevent_kind
= intern ("event-kind");
5254 staticpro (&Qevent_kind
);
5255 Qevent_symbol_elements
= intern ("event-symbol-elements");
5256 staticpro (&Qevent_symbol_elements
);
5257 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
5258 staticpro (&Qevent_symbol_element_mask
);
5259 Qmodifier_cache
= intern ("modifier-cache");
5260 staticpro (&Qmodifier_cache
);
5262 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
5263 staticpro (&Qrecompute_lucid_menubar
);
5264 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
5265 staticpro (&Qactivate_menubar_hook
);
5268 struct event_head
*p
;
5270 for (p
= head_table
;
5271 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
5274 *p
->var
= intern (p
->name
);
5276 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
5277 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
5281 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
5282 staticpro (&button_down_location
);
5286 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
5288 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
5289 for (i
= 0; i
< len
; i
++)
5290 if (modifier_names
[i
])
5291 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
5292 staticpro (&modifier_symbols
);
5295 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
5296 staticpro (&recent_keys
);
5298 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
5299 staticpro (&this_command_keys
);
5301 Qextended_command_history
= intern ("extended-command-history");
5302 Fset (Qextended_command_history
, Qnil
);
5303 staticpro (&Qextended_command_history
);
5305 kbd_buffer_frame_or_window
5306 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
5307 staticpro (&kbd_buffer_frame_or_window
);
5309 func_key_syms
= Qnil
;
5310 staticpro (&func_key_syms
);
5313 staticpro (&mouse_syms
);
5315 unread_switch_frame
= Qnil
;
5316 staticpro (&unread_switch_frame
);
5318 defsubr (&Sread_key_sequence
);
5319 defsubr (&Srecursive_edit
);
5320 defsubr (&Strack_mouse
);
5321 defsubr (&Sinput_pending_p
);
5322 defsubr (&Scommand_execute
);
5323 defsubr (&Srecent_keys
);
5324 defsubr (&Sthis_command_keys
);
5325 defsubr (&Ssuspend_emacs
);
5326 defsubr (&Sabort_recursive_edit
);
5327 defsubr (&Sexit_recursive_edit
);
5328 defsubr (&Srecursion_depth
);
5329 defsubr (&Stop_level
);
5330 defsubr (&Sdiscard_input
);
5331 defsubr (&Sopen_dribble_file
);
5332 defsubr (&Sset_input_mode
);
5333 defsubr (&Scurrent_input_mode
);
5334 defsubr (&Sexecute_extended_command
);
5336 DEFVAR_LISP ("last-command-char", &last_command_char
,
5337 "Last input event that was part of a command.");
5339 DEFVAR_LISP ("last-command-event", &last_command_char
,
5340 "Last input event that was part of a command.");
5342 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
5343 "Last input event in a command, except for mouse menu events.\n\
5344 Mouse menus give back keys that don't look like mouse events;\n\
5345 this variable holds the actual mouse event that led to the menu,\n\
5346 so that you can determine whether the command was run by mouse or not.");
5348 DEFVAR_LISP ("last-input-char", &last_input_char
,
5349 "Last input event.");
5351 DEFVAR_LISP ("last-input-event", &last_input_char
,
5352 "Last input event.");
5354 DEFVAR_LISP ("unread-command-events", &unread_command_events
,
5355 "List of objects to be read as next command input events.");
5357 DEFVAR_INT ("unread-command-char", &unread_command_char
,
5358 "If not -1, an object to be read as next command input event.");
5360 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
5361 "Meta-prefix character code. Meta-foo as command input\n\
5362 turns into this character followed by foo.");
5363 XSET (meta_prefix_char
, Lisp_Int
, 033);
5365 DEFVAR_LISP ("last-command", &last_command
,
5366 "The last command executed. Normally a symbol with a function definition,\n\
5367 but can be whatever was found in the keymap, or whatever the variable\n\
5368 `this-command' was set to by that command.");
5369 last_command
= Qnil
;
5371 DEFVAR_LISP ("this-command", &this_command
,
5372 "The command now being executed.\n\
5373 The command can set this variable; whatever is put here\n\
5374 will be in `last-command' during the following command.");
5375 this_command
= Qnil
;
5377 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
5378 "*Number of keyboard input characters between auto-saves.\n\
5379 Zero means disable autosaving due to number of characters typed.");
5380 auto_save_interval
= 300;
5382 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
5383 "*Number of seconds idle time before auto-save.\n\
5384 Zero or nil means disable auto-saving due to idleness.\n\
5385 After auto-saving due to this many seconds of idle time,\n\
5386 Emacs also does a garbage collection if that seems to be warranted.");
5387 XFASTINT (Vauto_save_timeout
) = 30;
5389 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
5390 "*Nonzero means echo unfinished commands after this many seconds of pause.");
5391 echo_keystrokes
= 1;
5393 DEFVAR_INT ("polling-period", &polling_period
,
5394 "*Interval between polling for input during Lisp execution.\n\
5395 The reason for polling is to make C-g work to stop a running program.\n\
5396 Polling is needed only when using X windows and SIGIO does not work.\n\
5397 Polling is automatically disabled in all other cases.");
5400 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
5401 "*Maximum time between mouse clicks to make a double-click.\n\
5402 Measured in milliseconds. nil means disable double-click recognition;\n\
5403 t means double-clicks have no time limit and are detected\n\
5404 by position only.");
5405 Vdouble_click_time
= make_number (500);
5407 DEFVAR_INT ("num-input-keys", &num_input_keys
,
5408 "*Number of complete keys read from the keyboard so far.");
5412 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
5413 "*The frame in which the most recently read event occurred.\n\
5414 If the last event came from a keyboard macro, this is set to `macro'.");
5415 Vlast_event_frame
= Qnil
;
5418 DEFVAR_LISP ("help-char", &Vhelp_char
,
5419 "Character to recognize as meaning Help.\n\
5420 When it is read, do `(eval help-form)', and display result if it's a string.\n\
5421 If the value of `help-form' is nil, this char can be read normally.");
5422 XSET (Vhelp_char
, Lisp_Int
, Ctl ('H'));
5424 DEFVAR_LISP ("help-form", &Vhelp_form
,
5425 "Form to execute when character `help-char' is read.\n\
5426 If the form returns a string, that string is displayed.\n\
5427 If `help-form' is nil, the help char is not recognized.");
5430 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
5431 "Command to run when `help-char' character follows a prefix key.\n\
5432 This command is used only when there is no actual binding\n\
5433 for that character after that prefix key.");
5434 Vprefix_help_command
= Qnil
;
5436 DEFVAR_LISP ("top-level", &Vtop_level
,
5437 "Form to evaluate when Emacs starts up.\n\
5438 Useful to set before you dump a modified Emacs.");
5441 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
5442 "String used as translate table for keyboard input, or nil.\n\
5443 Each character is looked up in this string and the contents used instead.\n\
5444 If string is of length N, character codes N and up are untranslated.");
5445 Vkeyboard_translate_table
= Qnil
;
5447 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
5448 "Keymap of key translations that can override keymaps.\n\
5449 This keymap works like `function-key-map', but comes after that,\n\
5450 and applies even for keys that have ordinary bindings.");
5451 Vkey_translation_map
= Qnil
;
5453 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
5454 "Non-nil means prompt with menus when appropriate.\n\
5455 This is done when reading from a keymap that has a prompt string,\n\
5456 for elements that have prompt strings.\n\
5457 The menu is displayed on the screen\n\
5458 if X menus were enabled at configuration\n\
5459 time and the previous event was a mouse click prefix key.\n\
5460 Otherwise, menu prompting uses the echo area.");
5463 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
5464 "Character to see next line of menu prompt.\n\
5465 Type this character while in a menu prompt to rotate around the lines of it.");
5466 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
5468 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
5469 "A mask of additional modifier keys to use with every keyboard character.\n\
5470 Emacs applies the modifiers of the character stored here to each keyboard\n\
5471 character it reads. For example, after evaluating the expression\n\
5472 (setq extra-keyboard-modifiers ?\C-x)\n\
5473 all input characters will have the control modifier applied to them.\n\
5475 Note that the character ?\C-@, equivalent to the integer zero, does\n\
5476 not count as a control character; rather, it counts as a character\n\
5477 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
5478 cancels any modification.");
5479 extra_keyboard_modifiers
= 0;
5481 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
5482 "If an editing command sets this to t, deactivate the mark afterward.\n\
5483 The command loop sets this to nil before each command,\n\
5484 and tests the value when the command returns.\n\
5485 Buffer modification stores t in this variable.");
5486 Vdeactivate_mark
= Qnil
;
5488 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
5489 "Normal hook run before each command is executed.");
5490 Vpre_command_hook
= Qnil
;
5492 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
5493 "Normal hook run after each command is executed.");
5494 Vpost_command_hook
= Qnil
;
5496 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
5497 "t means menu bar, specified Lucid style, needs to be recomputed.");
5498 Vlucid_menu_bar_dirty_flag
= Qnil
;
5500 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
5501 "List of menu bar items to move to the end of the menu bar.\n\
5502 The elements of the list are event types that may have menu bar bindings.");
5503 Vmenu_bar_final_items
= Qnil
;
5508 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
5509 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
5510 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
5511 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
5512 initial_define_key (meta_map
, 'x', "execute-extended-command");