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
1942 /* Just discard these, by returning nil.
1943 (They shouldn't be found in the buffer,
1944 but on some machines it appears they do show up.) */
1945 else if (event
->kind
== no_event
)
1946 kbd_fetch_ptr
= event
+ 1;
1948 /* If this event is on a different frame, return a switch-frame this
1949 time, and leave the event in the queue for next time. */
1953 Lisp_Object frame
= event
->frame_or_window
;
1956 if (XTYPE (frame
) == Lisp_Window
)
1957 frame
= WINDOW_FRAME (XWINDOW (frame
));
1959 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
1963 if (! EQ (frame
, internal_last_event_frame
)
1964 && XFRAME (frame
) != selected_frame
)
1965 obj
= make_lispy_switch_frame (frame
);
1966 internal_last_event_frame
= frame
;
1967 #endif /* MULTI_FRAME */
1969 /* If we didn't decide to make a switch-frame event, go ahead
1970 and build a real event from the queue entry. */
1974 obj
= make_lispy_event (event
);
1976 /* Wipe out this event, to catch bugs. */
1977 event
->kind
= no_event
;
1978 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
1981 kbd_fetch_ptr
= event
+ 1;
1985 /* Try generating a mouse motion event. */
1986 else if (do_mouse_tracking
&& mouse_moved
)
1989 Lisp_Object bar_window
;
1990 enum scroll_bar_part part
;
1994 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
1999 /* Decide if we should generate a switch-frame event. Don't
2000 generate switch-frame events for motion outside of all Emacs
2004 Lisp_Object frame
= FRAME_FOCUS_FRAME (f
);
2007 XSET (frame
, Lisp_Frame
, f
);
2009 if (! EQ (frame
, internal_last_event_frame
)
2010 && XFRAME (frame
) != selected_frame
)
2011 obj
= make_lispy_switch_frame (frame
);
2012 internal_last_event_frame
= frame
;
2016 /* If we didn't decide to make a switch-frame event, go ahead and
2017 return a mouse-motion event. */
2019 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2022 /* We were promised by the above while loop that there was
2023 something for us to read! */
2026 input_pending
= readable_events ();
2029 Vlast_event_frame
= internal_last_event_frame
;
2035 /* Process any events that are not user-visible,
2036 then return, without reading any user-visible events. */
2041 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2043 struct input_event
*event
;
2045 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2049 last_event_timestamp
= event
->timestamp
;
2051 /* These two kinds of events get special handling
2052 and don't actually appear to the command loop. */
2053 if (event
->kind
== selection_request_event
)
2056 x_handle_selection_request (event
);
2057 kbd_fetch_ptr
= event
+ 1;
2059 /* We're getting selection request events, but we don't have
2065 else if (event
->kind
== selection_clear_event
)
2068 x_handle_selection_clear (event
);
2069 kbd_fetch_ptr
= event
+ 1;
2071 /* We're getting selection request events, but we don't have
2080 get_input_pending (&input_pending
);
2083 /* Caches for modify_event_symbol. */
2084 static Lisp_Object func_key_syms
;
2085 static Lisp_Object mouse_syms
;
2087 /* You'll notice that this table is arranged to be conveniently
2088 indexed by X Windows keysym values. */
2089 static char *lispy_function_keys
[] =
2091 /* X Keysym value */
2093 "remove", 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2101 0, 0, 0, /* 0xff10 */
2103 0, 0, 0, 0, 0, 0, 0,
2106 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2107 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2108 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2110 "home", /* 0xff50 */ /* IsCursorKey */
2121 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2132 "break", /* 0xff6b */
2134 /* Here are some keys found mostly on HP keyboards. The X event
2135 handling code will strip bit 29, which flags vendor-specific
2137 "reset", /* 0x1000ff6c */
2146 "kp-backtab", /* 0x1000ff75 */
2148 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2149 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2150 0, 0, 0, 0, 0, 0, 0, 0,
2151 "kp-tab", /* 0xff89 */
2153 "kp-enter", /* 0xff8d */
2155 "kp-f1", /* 0xff91 */
2160 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2161 "kp-multiply", /* 0xffaa */
2166 "kp-divide", /* 0xffaf */
2167 "kp-0", /* 0xffb0 */
2168 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2171 "kp-equal", /* 0xffbd */
2172 "f1", /* 0xffbe */ /* IsFunctionKey */
2174 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2175 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2176 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2177 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2178 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2179 0, 0, 0, 0, 0, 0, 0, 0,
2180 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2181 0, 0, 0, 0, 0, 0, 0, "delete"
2184 static char *lispy_mouse_names
[] =
2186 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2189 /* Scroll bar parts. */
2190 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2192 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2193 Lisp_Object
*scroll_bar_parts
[] = {
2194 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2198 /* A vector, indexed by button number, giving the down-going location
2199 of currently depressed buttons, both scroll bar and non-scroll bar.
2201 The elements have the form
2202 (BUTTON-NUMBER MODIFIER-MASK . REST)
2203 where REST is the cdr of a position as it would be reported in the event.
2205 The make_lispy_event function stores positions here to tell the
2206 difference between click and drag events, and to store the starting
2207 location to be included in drag events. */
2209 static Lisp_Object button_down_location
;
2211 /* Information about the most recent up-going button event: Which
2212 button, what location, and what time. */
2214 static int last_mouse_button
;
2215 static int last_mouse_x
;
2216 static int last_mouse_y
;
2217 static unsigned long button_down_time
;
2219 /* The maximum time between clicks to make a double-click,
2220 or Qnil to disable double-click detection,
2221 or Qt for no time limit. */
2222 Lisp_Object Vdouble_click_time
;
2224 /* The number of clicks in this multiple-click. */
2226 int double_click_count
;
2228 /* Given a struct input_event, build the lisp event which represents
2229 it. If EVENT is 0, build a mouse movement event from the mouse
2230 movement buffer, which should have a movement event in it.
2232 Note that events must be passed to this function in the order they
2233 are received; this function stores the location of button presses
2234 in order to build drag events when the button is released. */
2237 make_lispy_event (event
)
2238 struct input_event
*event
;
2240 #ifdef SWITCH_ENUM_BUG
2241 switch ((int) event
->kind
)
2243 switch (event
->kind
)
2246 /* A simple keystroke. */
2247 case ascii_keystroke
:
2249 int c
= XFASTINT (event
->code
) & 0377;
2250 /* Turn ASCII characters into control characters
2252 if (event
->modifiers
& ctrl_modifier
)
2253 c
= make_ctrl_char (c
);
2255 /* Add in the other modifier bits. We took care of ctrl_modifier
2256 just above, and the shift key was taken care of by the X code,
2257 and applied to control characters by make_ctrl_char. */
2258 c
|= (event
->modifiers
2259 & (meta_modifier
| alt_modifier
2260 | hyper_modifier
| super_modifier
));
2261 button_down_time
= 0;
2265 /* A function key. The symbol may need to have modifier prefixes
2267 case non_ascii_keystroke
:
2268 button_down_time
= 0;
2269 return modify_event_symbol (XFASTINT (event
->code
), event
->modifiers
,
2271 lispy_function_keys
, &func_key_syms
,
2272 (sizeof (lispy_function_keys
)
2273 / sizeof (lispy_function_keys
[0])));
2276 /* A mouse click. Figure out where it is, decide whether it's
2277 a press, click or drag, and build the appropriate structure. */
2279 case scroll_bar_click
:
2281 int button
= XFASTINT (event
->code
);
2283 Lisp_Object position
;
2284 Lisp_Object
*start_pos_ptr
;
2285 Lisp_Object start_pos
;
2287 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2290 /* Build the position as appropriate for this mouse click. */
2291 if (event
->kind
== mouse_click
)
2294 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2296 = window_from_coordinates (f
, XINT (event
->x
), XINT (event
->y
),
2300 if (XINT (event
->y
) < FRAME_MENU_BAR_LINES (f
))
2304 items
= FRAME_MENU_BAR_ITEMS (f
);
2305 for (; CONSP (items
); items
= XCONS (items
)->cdr
)
2307 Lisp_Object pos
, string
;
2308 pos
= Fcdr (Fcdr (Fcar (items
)));
2309 string
= Fcar (Fcdr (Fcar (items
)));
2310 if (XINT (event
->x
) >= XINT (pos
)
2311 && XINT (event
->x
) < XINT (pos
) + XSTRING (string
)->size
)
2315 = Fcons (event
->frame_or_window
,
2317 Fcons (Fcons (event
->x
, event
->y
),
2318 Fcons (make_number (event
->timestamp
),
2322 return Fcons (Fcar (Fcar (items
)),
2323 Fcons (position
, Qnil
));
2325 return Fcons (Qnil
, Fcons (position
, Qnil
));
2327 else if (XTYPE (window
) != Lisp_Window
)
2332 (XINT (event
->x
) - XINT (XWINDOW (window
)->left
)));
2334 (XINT (event
->y
) - XINT (XWINDOW (window
)->top
)));
2339 posn
= Qvertical_line
;
2341 XSET (posn
, Lisp_Int
,
2342 buffer_posn_from_coords (XWINDOW (window
),
2350 Fcons (Fcons (event
->x
, event
->y
),
2351 Fcons (make_number (event
->timestamp
),
2356 Lisp_Object window
= event
->frame_or_window
;
2357 Lisp_Object portion_whole
= Fcons (event
->x
, event
->y
);
2358 Lisp_Object part
= *scroll_bar_parts
[(int) event
->part
];
2362 Fcons (Qvertical_scroll_bar
,
2363 Fcons (portion_whole
,
2364 Fcons (make_number (event
->timestamp
),
2369 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2371 start_pos
= *start_pos_ptr
;
2372 *start_pos_ptr
= Qnil
;
2374 is_double
= (button
== last_mouse_button
2375 && XINT (event
->x
) == last_mouse_x
2376 && XINT (event
->y
) == last_mouse_y
2377 && button_down_time
!= 0
2378 && (EQ (Vdouble_click_time
, Qt
)
2379 || (INTEGERP (Vdouble_click_time
)
2380 && ((int)(event
->timestamp
- button_down_time
)
2381 < XINT (Vdouble_click_time
)))));
2382 last_mouse_button
= button
;
2383 last_mouse_x
= XINT (event
->x
);
2384 last_mouse_y
= XINT (event
->y
);
2386 /* If this is a button press, squirrel away the location, so
2387 we can decide later whether it was a click or a drag. */
2388 if (event
->modifiers
& down_modifier
)
2392 double_click_count
++;
2393 event
->modifiers
|= ((double_click_count
> 2)
2398 double_click_count
= 1;
2399 button_down_time
= event
->timestamp
;
2400 *start_pos_ptr
= Fcopy_alist (position
);
2403 /* Now we're releasing a button - check the co-ordinates to
2404 see if this was a click or a drag. */
2405 else if (event
->modifiers
& up_modifier
)
2407 /* If we did not see a down before this up,
2408 ignore the up. Probably this happened because
2409 the down event chose a menu item.
2410 It would be an annoyance to treat the release
2411 of the button that chose the menu item
2412 as a separate event. */
2414 if (XTYPE (start_pos
) != Lisp_Cons
)
2417 event
->modifiers
&= ~up_modifier
;
2418 #if 0 /* Formerly we treated an up with no down as a click event. */
2419 if (XTYPE (start_pos
) != Lisp_Cons
)
2420 event
->modifiers
|= click_modifier
;
2424 /* The third element of every position should be the (x,y)
2426 Lisp_Object down
= Fnth (make_number (2), start_pos
);
2428 if (EQ (event
->x
, XCONS (down
)->car
)
2429 && EQ (event
->y
, XCONS (down
)->cdr
))
2431 if (is_double
&& double_click_count
> 1)
2432 event
->modifiers
|= ((double_click_count
> 2)
2436 event
->modifiers
|= click_modifier
;
2440 button_down_time
= 0;
2441 event
->modifiers
|= drag_modifier
;
2446 /* Every mouse event should either have the down_modifier or
2447 the up_modifier set. */
2451 /* Get the symbol we should use for the mouse click. */
2453 = modify_event_symbol (button
,
2456 lispy_mouse_names
, &mouse_syms
,
2457 (sizeof (lispy_mouse_names
)
2458 / sizeof (lispy_mouse_names
[0])));
2460 if (event
->modifiers
& drag_modifier
)
2465 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2468 Fcons (make_number (double_click_count
),
2477 /* The 'kind' field of the event is something we don't recognize. */
2484 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2486 Lisp_Object bar_window
;
2487 enum scroll_bar_part part
;
2491 /* Is it a scroll bar movement? */
2492 if (frame
&& ! NILP (bar_window
))
2494 Lisp_Object part_sym
= *scroll_bar_parts
[(int) part
];
2496 return Fcons (Qscroll_bar_movement
,
2497 (Fcons (Fcons (bar_window
,
2498 Fcons (Qvertical_scroll_bar
,
2499 Fcons (Fcons (x
, y
),
2500 Fcons (make_number (time
),
2506 /* Or is it an ordinary mouse movement? */
2510 Lisp_Object window
=
2512 ? window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
)
2516 if (XTYPE (window
) == Lisp_Window
)
2518 XSETINT (x
, XINT (x
) - XINT (XWINDOW (window
)->left
));
2519 XSETINT (y
, XINT (y
) - XINT (XWINDOW (window
)->top
));
2524 posn
= Qvertical_line
;
2526 XSET (posn
, Lisp_Int
,
2527 buffer_posn_from_coords (XWINDOW (window
),
2528 XINT (x
), XINT (y
)));
2538 return Fcons (Qmouse_movement
,
2539 Fcons (Fcons (window
,
2541 Fcons (Fcons (x
, y
),
2542 Fcons (make_number (time
),
2548 /* Construct a switch frame event. */
2550 make_lispy_switch_frame (frame
)
2553 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
2556 /* Manipulating modifiers. */
2558 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
2560 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2561 SYMBOL's name of the end of the modifiers; the string from this
2562 position is the unmodified symbol name.
2564 This doesn't use any caches. */
2566 parse_modifiers_uncached (symbol
, modifier_end
)
2570 struct Lisp_String
*name
;
2574 CHECK_SYMBOL (symbol
, 1);
2577 name
= XSYMBOL (symbol
)->name
;
2580 for (i
= 0; i
+2 <= name
->size
; )
2581 switch (name
->data
[i
])
2583 #define SINGLE_LETTER_MOD(bit) \
2584 if (name->data[i+1] != '-') \
2585 goto no_more_modifiers; \
2590 SINGLE_LETTER_MOD (alt_modifier
);
2594 SINGLE_LETTER_MOD (ctrl_modifier
);
2598 SINGLE_LETTER_MOD (hyper_modifier
);
2602 SINGLE_LETTER_MOD (meta_modifier
);
2606 SINGLE_LETTER_MOD (shift_modifier
);
2610 SINGLE_LETTER_MOD (super_modifier
);
2614 if (i
+ 5 > name
->size
)
2615 goto no_more_modifiers
;
2616 if (! strncmp (name
->data
+ i
, "drag-", 5))
2618 modifiers
|= drag_modifier
;
2621 else if (! strncmp (name
->data
+ i
, "down-", 5))
2623 modifiers
|= down_modifier
;
2626 else if (i
+ 7 <= name
->size
2627 && ! strncmp (name
->data
+ i
, "double-", 7))
2629 modifiers
|= double_modifier
;
2633 goto no_more_modifiers
;
2637 if (i
+ 7 > name
->size
)
2638 goto no_more_modifiers
;
2639 if (! strncmp (name
->data
+ i
, "triple-", 7))
2641 modifiers
|= triple_modifier
;
2645 goto no_more_modifiers
;
2649 goto no_more_modifiers
;
2651 #undef SINGLE_LETTER_MOD
2655 /* Should we include the `click' modifier? */
2656 if (! (modifiers
& (down_modifier
| drag_modifier
2657 | double_modifier
| triple_modifier
))
2658 && i
+ 7 == name
->size
2659 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
2660 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
2661 modifiers
|= click_modifier
;
2670 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
2671 prepended to the string BASE[0..BASE_LEN-1].
2672 This doesn't use any caches. */
2674 apply_modifiers_uncached (modifiers
, base
, base_len
)
2679 /* Since BASE could contain nulls, we can't use intern here; we have
2680 to use Fintern, which expects a genuine Lisp_String, and keeps a
2683 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
2689 /* Only the event queue may use the `up' modifier; it should always
2690 be turned into a click or drag event before presented to lisp code. */
2691 if (modifiers
& up_modifier
)
2694 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
2695 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
2696 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
2697 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
2698 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
2699 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
2700 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
2701 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
2702 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
2703 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
2704 /* The click modifier is denoted by the absence of other modifiers. */
2708 mod_len
= p
- new_mods
;
2712 Lisp_Object new_name
= make_uninit_string (mod_len
+ base_len
);
2714 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
2715 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
2717 return Fintern (new_name
, Qnil
);
2722 static char *modifier_names
[] =
2724 "up", "down", "drag", "click", "double", "triple", 0, 0,
2725 0, 0, 0, 0, 0, 0, 0, 0,
2726 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
2728 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
2730 static Lisp_Object modifier_symbols
;
2732 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
2734 lispy_modifier_list (modifiers
)
2737 Lisp_Object modifier_list
;
2740 modifier_list
= Qnil
;
2741 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
2742 if (modifiers
& (1<<i
))
2743 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
2746 return modifier_list
;
2750 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
2751 where UNMODIFIED is the unmodified form of SYMBOL,
2752 MASK is the set of modifiers present in SYMBOL's name.
2753 This is similar to parse_modifiers_uncached, but uses the cache in
2754 SYMBOL's Qevent_symbol_element_mask property, and maintains the
2755 Qevent_symbol_elements property. */
2757 parse_modifiers (symbol
)
2760 Lisp_Object elements
= Fget (symbol
, Qevent_symbol_element_mask
);
2762 if (CONSP (elements
))
2767 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
2768 Lisp_Object unmodified
2769 = Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
2770 XSYMBOL (symbol
)->name
->size
- end
),
2774 if (modifiers
& ~((1<<VALBITS
) - 1))
2776 XFASTINT (mask
) = modifiers
;
2777 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
2779 /* Cache the parsing results on SYMBOL. */
2780 Fput (symbol
, Qevent_symbol_element_mask
,
2782 Fput (symbol
, Qevent_symbol_elements
,
2783 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
2785 /* Since we know that SYMBOL is modifiers applied to unmodified,
2786 it would be nice to put that in unmodified's cache.
2787 But we can't, since we're not sure that parse_modifiers is
2794 /* Apply the modifiers MODIFIERS to the symbol BASE.
2795 BASE must be unmodified.
2797 This is like apply_modifiers_uncached, but uses BASE's
2798 Qmodifier_cache property, if present. It also builds
2799 Qevent_symbol_elements properties, since it has that info anyway.
2801 apply_modifiers copies the value of BASE's Qevent_kind property to
2802 the modified symbol. */
2804 apply_modifiers (modifiers
, base
)
2808 Lisp_Object cache
, index
, entry
, new_symbol
;
2810 /* Mask out upper bits. We don't know where this value's been. */
2811 modifiers
&= (1<<VALBITS
) - 1;
2813 /* The click modifier never figures into cache indices. */
2814 cache
= Fget (base
, Qmodifier_cache
);
2815 XFASTINT (index
) = (modifiers
& ~click_modifier
);
2816 entry
= Fassq (index
, cache
);
2819 new_symbol
= XCONS (entry
)->cdr
;
2822 /* We have to create the symbol ourselves. */
2823 new_symbol
= apply_modifiers_uncached (modifiers
,
2824 XSYMBOL (base
)->name
->data
,
2825 XSYMBOL (base
)->name
->size
);
2827 /* Add the new symbol to the base's cache. */
2828 entry
= Fcons (index
, new_symbol
);
2829 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
2831 /* We have the parsing info now for free, so add it to the caches. */
2832 XFASTINT (index
) = modifiers
;
2833 Fput (new_symbol
, Qevent_symbol_element_mask
,
2834 Fcons (base
, Fcons (index
, Qnil
)));
2835 Fput (new_symbol
, Qevent_symbol_elements
,
2836 Fcons (base
, lispy_modifier_list (modifiers
)));
2839 /* Make sure this symbol is of the same kind as BASE.
2841 You'd think we could just set this once and for all when we
2842 intern the symbol above, but reorder_modifiers may call us when
2843 BASE's property isn't set right; we can't assume that just
2844 because it has a Qmodifier_cache property it must have its
2845 Qevent_kind set right as well. */
2846 if (NILP (Fget (new_symbol
, Qevent_kind
)))
2848 Lisp_Object kind
= Fget (base
, Qevent_kind
);
2851 Fput (new_symbol
, Qevent_kind
, kind
);
2858 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
2859 return a symbol with the modifiers placed in the canonical order.
2860 Canonical order is alphabetical, except for down and drag, which
2861 always come last. The 'click' modifier is never written out.
2863 Fdefine_key calls this to make sure that (for example) C-M-foo
2864 and M-C-foo end up being equivalent in the keymap. */
2867 reorder_modifiers (symbol
)
2870 /* It's hopefully okay to write the code this way, since everything
2871 will soon be in caches, and no consing will be done at all. */
2872 Lisp_Object parsed
= parse_modifiers (symbol
);
2874 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
2875 XCONS (parsed
)->car
);
2879 /* For handling events, we often want to produce a symbol whose name
2880 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
2881 to some base, like the name of a function key or mouse button.
2882 modify_event_symbol produces symbols of this sort.
2884 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
2885 is the name of the i'th symbol. TABLE_SIZE is the number of elements
2888 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
2889 persist between calls to modify_event_symbol that it can use to
2890 store a cache of the symbols it's generated for this NAME_TABLE
2893 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
2895 MODIFIERS is a set of modifier bits (as given in struct input_events)
2896 whose prefixes should be applied to the symbol name.
2898 SYMBOL_KIND is the value to be placed in the event_kind property of
2899 the returned symbol.
2901 The symbols we create are supposed to have an
2902 `event-symbol-elements' property, which lists the modifiers present
2903 in the symbol's name. */
2906 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_table
,
2907 symbol_table
, table_size
)
2910 Lisp_Object symbol_kind
;
2912 Lisp_Object
*symbol_table
;
2917 /* Is this a request for a valid symbol? */
2918 if (symbol_num
< 0 || symbol_num
>= table_size
)
2921 /* If *symbol_table doesn't seem to be initialized properly, fix that.
2922 *symbol_table should be a lisp vector TABLE_SIZE elements long,
2923 where the Nth element is the symbol for NAME_TABLE[N], or nil if
2924 we've never used that symbol before. */
2925 if (XTYPE (*symbol_table
) != Lisp_Vector
2926 || XVECTOR (*symbol_table
)->size
!= table_size
)
2930 XFASTINT (size
) = table_size
;
2931 *symbol_table
= Fmake_vector (size
, Qnil
);
2934 slot
= & XVECTOR (*symbol_table
)->contents
[symbol_num
];
2936 /* Have we already used this symbol before? */
2939 /* No; let's create it. */
2940 if (name_table
[symbol_num
])
2941 *slot
= intern (name_table
[symbol_num
]);
2945 sprintf (buf
, "key-%d", symbol_num
);
2946 *slot
= intern (buf
);
2949 /* Fill in the cache entries for this symbol; this also
2950 builds the Qevent_symbol_elements property, which the user
2952 apply_modifiers (modifiers
& click_modifier
, *slot
);
2953 Fput (*slot
, Qevent_kind
, symbol_kind
);
2956 /* Apply modifiers to that symbol. */
2957 return apply_modifiers (modifiers
, *slot
);
2961 /* Store into *addr a value nonzero if terminal input chars are available.
2962 Serves the purpose of ioctl (0, FIONREAD, addr)
2963 but works even if FIONREAD does not exist.
2964 (In fact, this may actually read some input.) */
2967 get_input_pending (addr
)
2970 /* First of all, have we already counted some input? */
2971 *addr
= !NILP (Vquit_flag
) || readable_events ();
2973 /* If input is being read as it arrives, and we have none, there is none. */
2974 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
2977 /* Try to read some input and see how much we get. */
2979 *addr
= !NILP (Vquit_flag
) || readable_events ();
2982 /* Interface to read_avail_input, blocking SIGIO if necessary. */
2985 gobble_input (expected
)
2990 if (interrupt_input
)
2993 mask
= sigblockx (SIGIO
);
2994 read_avail_input (expected
);
2999 read_avail_input (expected
);
3005 /* Read any terminal input already buffered up by the system
3006 into the kbd_buffer, but do not wait.
3008 EXPECTED should be nonzero if the caller knows there is some input.
3010 Except on VMS, all input is read by this function.
3011 If interrupt_input is nonzero, this function MUST be called
3012 only when SIGIO is blocked.
3014 Returns the number of keyboard chars read, or -1 meaning
3015 this is a bad time to try to read input. */
3018 read_avail_input (expected
)
3021 struct input_event buf
[KBD_BUFFER_SIZE
];
3025 if (read_socket_hook
)
3026 /* No need for FIONREAD or fcntl; just say don't wait. */
3027 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
3030 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
3031 the kbd_buffer can really hold. That may prevent loss
3032 of characters on some systems when input is stuffed at us. */
3033 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
3036 /* Find out how much input is available. */
3037 if (ioctl (0, FIONREAD
, &nread
) < 0)
3038 /* Formerly simply reported no input, but that sometimes led to
3039 a failure of Emacs to terminate.
3040 SIGHUP seems appropriate if we can't reach the terminal. */
3041 /* ??? Is it really right to send the signal just to this process
3042 rather than to the whole process group?
3043 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3044 kill (getpid (), SIGHUP
);
3047 if (nread
> sizeof cbuf
)
3048 nread
= sizeof cbuf
;
3049 #else /* no FIONREAD */
3050 #if defined(USG) || defined(DGUX)
3051 /* Read some input if available, but don't wait. */
3052 nread
= sizeof cbuf
;
3053 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
3059 /* Now read; for one reason or another, this will not block. */
3062 nread
= read (fileno (stdin
), cbuf
, nread
);
3064 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3065 This looks incorrect, but it isn't, because _BSD causes
3066 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3067 and that causes a value other than 0 when there is no input. */
3071 /* Retry the read if it is interrupted. */
3073 || ! (errno
== EAGAIN
|| errno
== EFAULT
3083 fcntl (fileno (stdin
), F_SETFL
, 0);
3085 #endif /* no FIONREAD */
3086 for (i
= 0; i
< nread
; i
++)
3088 buf
[i
].kind
= ascii_keystroke
;
3089 buf
[i
].modifiers
= 0;
3090 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3091 buf
[i
].modifiers
= meta_modifier
;
3095 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
3097 XSET (buf
[i
].frame_or_window
, Lisp_Frame
, selected_frame
);
3099 buf
[i
].frame_or_window
= Qnil
;
3104 /* Scan the chars for C-g and store them in kbd_buffer. */
3105 for (i
= 0; i
< nread
; i
++)
3107 kbd_buffer_store_event (&buf
[i
]);
3108 /* Don't look at input that follows a C-g too closely.
3109 This reduces lossage due to autorepeat on C-g. */
3110 if (buf
[i
].kind
== ascii_keystroke
3111 && XINT(buf
[i
].code
) == quit_char
)
3117 #endif /* not VMS */
3119 #ifdef SIGIO /* for entire page */
3120 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3123 input_available_signal (signo
)
3126 /* Must preserve main program's value of errno. */
3127 int old_errno
= errno
;
3129 extern int select_alarmed
;
3133 /* USG systems forget handlers when they are used;
3134 must reestablish each time */
3135 signal (signo
, input_available_signal
);
3142 if (input_available_clear_time
)
3143 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3148 nread
= read_avail_input (1);
3149 /* -1 means it's not ok to read the input now.
3150 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3151 0 means there was no keyboard input available. */
3156 select_alarmed
= 1; /* Force the select emulator back to life */
3167 /* Send ourselves a SIGIO.
3169 This function exists so that the UNBLOCK_INPUT macro in
3170 blockinput.h can have some way to take care of input we put off
3171 dealing with, without assuming that every file which uses
3172 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3174 reinvoke_input_signal ()
3183 /* Return the prompt-string of a sparse keymap.
3184 This is the first element which is a string.
3185 Return nil if there is none. */
3193 register Lisp_Object tem
;
3195 if (XTYPE (tem
) == Lisp_String
)
3202 static Lisp_Object
menu_bar_item ();
3203 static Lisp_Object
menu_bar_one_keymap ();
3205 /* Return a list of menu items for a menu bar, appropriate
3206 to the current buffer.
3207 The elements have the form (KEY STRING . nil). */
3212 /* The number of keymaps we're scanning right now, and the number of
3213 keymaps we have allocated space for. */
3216 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3217 in the current keymaps, or nil where it is not a prefix. */
3220 Lisp_Object def
, tem
, tail
;
3227 /* In order to build the menus, we need to call the keymap
3228 accessors. They all call QUIT. But this function is called
3229 during redisplay, during which a quit is fatal. So inhibit
3230 quitting while building the menus.
3231 We do this instead of specbind because (1) errors will clear it anyway
3232 and (2) this avoids risk of specpdl overflow. */
3233 oquit
= Vinhibit_quit
;
3236 /* Build our list of keymaps.
3237 If we recognize a function key and replace its escape sequence in
3238 keybuf with its symbol, or if the sequence starts with a mouse
3239 click and we need to switch buffers, we jump back here to rebuild
3240 the initial keymaps from the current buffer. */
3244 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3245 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3246 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3247 #ifdef USE_TEXT_PROPERTIES
3248 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3250 maps
[nmaps
-2] = current_buffer
->keymap
;
3252 maps
[nmaps
-1] = current_global_map
;
3255 /* Look up in each map the dummy prefix key `menu-bar'. */
3259 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3261 if (! NILP (maps
[mapno
]))
3262 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3266 tem
= Fkeymapp (def
);
3268 result
= menu_bar_one_keymap (def
, result
);
3271 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3275 elt
= Fassq (XCONS (tail
)->car
, result
);
3277 result
= Fcons (elt
, Fdelq (elt
, result
));
3280 result
= Fnreverse (result
);
3281 Vinhibit_quit
= oquit
;
3285 /* Scan one map KEYMAP, accumulating any menu items it defines
3286 that have not yet been seen in RESULT. Return the updated RESULT. */
3289 menu_bar_one_keymap (keymap
, result
)
3290 Lisp_Object keymap
, result
;
3292 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3294 /* Loop over all keymap entries that have menu strings. */
3295 for (tail
= keymap
; XTYPE (tail
) == Lisp_Cons
; tail
= XCONS (tail
)->cdr
)
3297 item
= XCONS (tail
)->car
;
3298 if (XTYPE (item
) == Lisp_Cons
)
3300 key
= XCONS (item
)->car
;
3301 binding
= XCONS (item
)->cdr
;
3302 if (XTYPE (binding
) == Lisp_Cons
)
3304 item_string
= XCONS (binding
)->car
;
3305 if (XTYPE (item_string
) == Lisp_String
)
3306 result
= menu_bar_item (key
, item_string
,
3307 Fcdr (binding
), result
);
3309 else if (EQ (binding
, Qundefined
))
3310 result
= menu_bar_item (key
, item_string
,
3313 else if (XTYPE (item
) == Lisp_Vector
)
3315 /* Loop over the char values represented in the vector. */
3316 int len
= XVECTOR (item
)->size
;
3318 for (c
= 0; c
< len
; c
++)
3320 Lisp_Object character
;
3321 XFASTINT (character
) = c
;
3322 binding
= XVECTOR (item
)->contents
[c
];
3323 if (XTYPE (binding
) == Lisp_Cons
)
3325 item_string
= XCONS (binding
)->car
;
3326 if (XTYPE (item_string
) == Lisp_String
)
3327 result
= menu_bar_item (key
, item_string
,
3328 Fcdr (binding
), result
);
3330 else if (EQ (binding
, Qundefined
))
3331 result
= menu_bar_item (key
, item_string
,
3341 menu_bar_item (key
, item_string
, def
, result
)
3342 Lisp_Object key
, item_string
, def
, result
;
3345 Lisp_Object enabled
;
3347 if (EQ (def
, Qundefined
))
3349 /* If a map has an explicit nil as definition,
3350 discard any previously made menu bar item. */
3351 tem
= Fassq (key
, result
);
3352 return Fdelq (tem
, result
);
3355 /* See if this entry is enabled. */
3358 if (XTYPE (def
) == Lisp_Symbol
)
3360 /* No property, or nil, means enable.
3361 Otherwise, enable if value is not nil. */
3362 tem
= Fget (def
, Qmenu_enable
);
3364 enabled
= Feval (tem
);
3367 /* Add an entry for this key and string
3368 if there is none yet. */
3369 tem
= Fassq (key
, result
);
3370 if (!NILP (enabled
) && NILP (tem
))
3371 result
= Fcons (Fcons (key
, Fcons (item_string
, Qnil
)), result
);
3376 static int echo_flag
;
3377 static int echo_now
;
3379 /* Read a character using menus based on maps in the array MAPS.
3380 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
3381 Return t if we displayed a menu but the user rejected it.
3383 PREV_EVENT is the previous input event, or nil if we are reading
3384 the first event of a key sequence.
3386 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3387 if we used a mouse menu to read the input, or zero otherwise. If
3388 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
3390 The prompting is done based on the prompt-string of the map
3391 and the strings associated with various map elements. */
3394 read_char_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
3397 Lisp_Object prev_event
;
3398 int *used_mouse_menu
;
3401 register Lisp_Object name
;
3403 int width
= FRAME_WIDTH (selected_frame
) - 4;
3404 char *menu
= (char *) alloca (width
+ 4);
3406 Lisp_Object rest
, vector
;
3408 if (used_mouse_menu
)
3409 *used_mouse_menu
= 0;
3411 /* Use local over global Menu maps */
3413 if (! menu_prompting
)
3416 /* Get the menu name from the first map that has one (a prompt string). */
3417 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3419 name
= map_prompt (maps
[mapno
]);
3424 /* If we don't have any menus, just read a character normally. */
3428 #ifdef HAVE_X_WINDOWS
3430 /* If we got to this point via a mouse click,
3431 use a real menu for mouse selection. */
3432 if (EVENT_HAS_PARAMETERS (prev_event
))
3434 /* Display the menu and get the selection. */
3435 Lisp_Object
*realmaps
3436 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
3440 /* Use the maps that are not nil. */
3441 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3442 if (!NILP (maps
[mapno
]))
3443 realmaps
[nmaps1
++] = maps
[mapno
];
3445 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
3448 /* If we got more than one event, put all but the first
3449 onto this list to be read later.
3450 Return just the first event now. */
3451 unread_command_events
3452 = nconc2 (XCONS (value
)->cdr
, unread_command_events
);
3453 value
= XCONS (value
)->car
;
3457 if (used_mouse_menu
)
3458 *used_mouse_menu
= 1;
3461 #endif /* HAVE_X_MENU */
3462 #endif /* HAVE_X_WINDOWS */
3464 /* Prompt string always starts with map's prompt, and a space. */
3465 strcpy (menu
, XSTRING (name
)->data
);
3466 nlength
= XSTRING (name
)->size
;
3467 menu
[nlength
++] = ':';
3468 menu
[nlength
++] = ' ';
3471 /* Start prompting at start of first map. */
3475 /* Present the documented bindings, a line at a time. */
3483 /* Loop over elements of map. */
3488 /* If reached end of map, start at beginning of next map. */
3492 /* At end of last map, wrap around to first map if just starting,
3493 or end this line if already have something on it. */
3504 /* Look at the next element of the map. */
3506 elt
= XVECTOR (vector
)->contents
[idx
];
3508 elt
= Fcar_safe (rest
);
3510 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
3512 /* If we found a dense table in the keymap,
3513 advanced past it, but start scanning its contents. */
3514 rest
= Fcdr_safe (rest
);
3520 /* An ordinary element. */
3521 s
= Fcar_safe (Fcdr_safe (elt
));
3522 if (XTYPE (s
) != Lisp_String
)
3523 /* Ignore the element if it has no prompt string. */
3525 /* If we have room for the prompt string, add it to this line.
3526 If this is the first on the line, always add it. */
3527 else if (XSTRING (s
)->size
+ i
< width
3532 /* Punctuate between strings. */
3535 strcpy (menu
+ i
, ", ");
3540 /* Add as much of string as fits. */
3541 thiswidth
= XSTRING (s
)->size
;
3542 if (thiswidth
+ i
> width
)
3543 thiswidth
= width
- i
;
3544 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
3549 /* If this element does not fit, end the line now,
3550 and save the element for the next line. */
3551 strcpy (menu
+ i
, "...");
3555 /* Move past this element. */
3556 if (idx
>= 0 && idx
+ 1 >= XVECTOR (rest
)->size
)
3557 /* Handle reaching end of dense table. */
3562 rest
= Fcdr_safe (rest
);
3566 /* Prompt with that and read response. */
3568 obj
= read_char (1, 0, 0, Qnil
, 0);
3570 if (XTYPE (obj
) != Lisp_Int
)
3575 if (! EQ (obj
, menu_prompt_more_char
)
3576 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
3577 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
3582 /* Reading key sequences. */
3584 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
3585 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
3586 keymap, or nil otherwise. Return the index of the first keymap in
3587 which KEY has any binding, or NMAPS if no map has a binding.
3589 If KEY is a meta ASCII character, treat it like meta-prefix-char
3590 followed by the corresponding non-meta character. Keymaps in
3591 CURRENT with non-prefix bindings for meta-prefix-char become nil in
3594 When KEY is not defined in any of the keymaps, if it is an upper
3595 case letter and there are bindings for the corresponding lower-case
3596 letter, return the bindings for the lower-case letter.
3598 If KEY has no bindings in any of the CURRENT maps, NEXT is left
3601 NEXT may == CURRENT. */
3604 follow_key (key
, nmaps
, current
, defs
, next
)
3606 Lisp_Object
*current
, *defs
, *next
;
3609 int i
, first_binding
;
3611 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
3612 followed by the corresponding non-meta character. */
3613 if (XTYPE (key
) == Lisp_Int
&& (XINT (key
) & CHAR_META
))
3615 for (i
= 0; i
< nmaps
; i
++)
3616 if (! NILP (current
[i
]))
3619 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
3621 /* Note that since we pass the resulting bindings through
3622 get_keymap_1, non-prefix bindings for meta-prefix-char
3624 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
3630 XSET (key
, Lisp_Int
, XFASTINT (key
) & ~CHAR_META
);
3633 first_binding
= nmaps
;
3634 for (i
= nmaps
- 1; i
>= 0; i
--)
3636 if (! NILP (current
[i
]))
3638 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3639 if (! NILP (defs
[i
]))
3646 /* When KEY is not defined in any of the keymaps, if it is an upper
3647 case letter and there are bindings for the corresponding
3648 lower-case letter, return the bindings for the lower-case letter. */
3649 if (first_binding
== nmaps
3650 && XTYPE (key
) == Lisp_Int
3651 && ((((XINT (key
) & 0x3ffff)
3652 < XSTRING (current_buffer
->downcase_table
)->size
)
3653 && UPPERCASEP (XINT (key
) & 0x3ffff))
3654 || (XINT (key
) & shift_modifier
)))
3656 if (XINT (key
) & shift_modifier
)
3657 XSETINT (key
, XINT (key
) & ~shift_modifier
);
3659 XSETINT (key
, DOWNCASE (XINT (key
)));
3661 first_binding
= nmaps
;
3662 for (i
= nmaps
- 1; i
>= 0; i
--)
3664 if (! NILP (current
[i
]))
3666 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3667 if (! NILP (defs
[i
]))
3675 /* Given the set of bindings we've found, produce the next set of maps. */
3676 if (first_binding
< nmaps
)
3677 for (i
= 0; i
< nmaps
; i
++)
3678 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
3680 return first_binding
;
3683 /* Read a sequence of keys that ends with a non prefix character,
3684 storing it in KEYBUF, a buffer of size BUFSIZE.
3686 Return the length of the key sequence stored.
3687 Return -1 if the user rejected a command menu.
3689 Echo starting immediately unless `prompt' is 0.
3691 Where a key sequence ends depends on the currently active keymaps.
3692 These include any minor mode keymaps active in the current buffer,
3693 the current buffer's local map, and the global map.
3695 If a key sequence has no other bindings, we check Vfunction_key_map
3696 to see if some trailing subsequence might be the beginning of a
3697 function key's sequence. If so, we try to read the whole function
3698 key, and substitute its symbolic name into the key sequence.
3700 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
3701 `double-' events into similar click events, if that would make them
3702 bound. We try to turn `triple-' events first into `double-' events,
3705 If we get a mouse click in a mode line, vertical divider, or other
3706 non-text area, we treat the click as if it were prefixed by the
3707 symbol denoting that area - `mode-line', `vertical-line', or
3710 If the sequence starts with a mouse click, we read the key sequence
3711 with respect to the buffer clicked on, not the current buffer.
3713 If the user switches frames in the midst of a key sequence, we put
3714 off the switch-frame event until later; the next call to
3715 read_char will return it. */
3718 read_key_sequence (keybuf
, bufsize
, prompt
)
3719 Lisp_Object
*keybuf
;
3723 int count
= specpdl_ptr
- specpdl
;
3725 /* How many keys there are in the current key sequence. */
3728 /* The length of the echo buffer when we started reading, and
3729 the length of this_command_keys when we started reading. */
3733 /* The number of keymaps we're scanning right now, and the number of
3734 keymaps we have allocated space for. */
3736 int nmaps_allocated
= 0;
3738 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
3739 the current keymaps. */
3742 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3743 in the current keymaps, or nil where it is not a prefix. */
3744 Lisp_Object
*submaps
;
3746 /* The index in defs[] of the first keymap that has a binding for
3747 this key sequence. In other words, the lowest i such that
3748 defs[i] is non-nil. */
3751 /* If t < mock_input, then KEYBUF[t] should be read as the next
3754 We use this to recover after recognizing a function key. Once we
3755 realize that a suffix of the current key sequence is actually a
3756 function key's escape sequence, we replace the suffix with the
3757 function key's binding from Vfunction_key_map. Now keybuf
3758 contains a new and different key sequence, so the echo area,
3759 this_command_keys, and the submaps and defs arrays are wrong. In
3760 this situation, we set mock_input to t, set t to 0, and jump to
3761 restart_sequence; the loop will read keys from keybuf up until
3762 mock_input, thus rebuilding the state; and then it will resume
3763 reading characters from the keyboard. */
3766 /* If the sequence is unbound in submaps[], then
3767 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
3768 and fkey_map is its binding.
3770 These might be > t, indicating that all function key scanning
3771 should hold off until t reaches them. We do this when we've just
3772 recognized a function key, to avoid searching for the function
3773 key's again in Vfunction_key_map. */
3774 int fkey_start
= 0, fkey_end
= 0;
3775 Lisp_Object fkey_map
;
3777 /* Likewise, for key_translation_map. */
3778 int keytran_start
= 0, keytran_end
= 0;
3779 Lisp_Object keytran_map
;
3781 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
3782 we put it off for later. While we're reading, we keep the event here. */
3783 Lisp_Object delayed_switch_frame
;
3785 /* See the comment below... */
3786 #if defined (GOBBLE_FIRST_EVENT)
3787 Lisp_Object first_event
;
3792 last_nonmenu_event
= Qnil
;
3794 delayed_switch_frame
= Qnil
;
3795 fkey_map
= Vfunction_key_map
;
3796 keytran_map
= Vkey_translation_map
;
3798 /* If there is no function-key-map, turn off function key scanning. */
3799 if (NILP (Fkeymapp (Vfunction_key_map
)))
3800 fkey_start
= fkey_end
= bufsize
+ 1;
3802 /* If there is no key-translation-map, turn off scanning. */
3803 if (NILP (Fkeymapp (Vkey_translation_map
)))
3804 keytran_start
= keytran_end
= bufsize
+ 1;
3809 echo_prompt (XSTRING (prompt
)->data
);
3810 else if (cursor_in_echo_area
)
3811 /* This doesn't put in a dash if the echo buffer is empty, so
3812 you don't always see a dash hanging out in the minibuffer. */
3816 /* Record the initial state of the echo area and this_command_keys;
3817 we will need to restore them if we replay a key sequence. */
3819 echo_start
= echo_length ();
3820 keys_start
= this_command_key_count
;
3822 #if defined (GOBBLE_FIRST_EVENT)
3823 /* This doesn't quite work, because some of the things that read_char
3824 does cannot safely be bypassed. It seems too risky to try to make
3827 /* Read the first char of the sequence specially, before setting
3828 up any keymaps, in case a filter runs and switches buffers on us. */
3829 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
3831 #endif /* GOBBLE_FIRST_EVENT */
3833 /* We jump here when the key sequence has been thoroughly changed, and
3834 we need to rescan it starting from the beginning. When we jump here,
3835 keybuf[0..mock_input] holds the sequence we should reread. */
3838 /* Build our list of keymaps.
3839 If we recognize a function key and replace its escape sequence in
3840 keybuf with its symbol, or if the sequence starts with a mouse
3841 click and we need to switch buffers, we jump back here to rebuild
3842 the initial keymaps from the current buffer. */
3846 nmaps
= current_minor_maps (0, &maps
) + 2;
3847 if (nmaps
> nmaps_allocated
)
3849 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
3850 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
3851 nmaps_allocated
= nmaps
;
3853 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
3854 #ifdef USE_TEXT_PROPERTIES
3855 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3857 submaps
[nmaps
-2] = current_buffer
->keymap
;
3859 submaps
[nmaps
-1] = current_global_map
;
3862 /* Find an accurate initial value for first_binding. */
3863 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
3864 if (! NILP (submaps
[first_binding
]))
3867 /* We jump here when a function key substitution has forced us to
3868 reprocess the current key sequence. keybuf[0..mock_input] is the
3869 sequence we want to reread. */
3872 /* These are no-ops the first time through, but if we restart, they
3873 revert the echo area and this_command_keys to their original state. */
3874 this_command_key_count
= keys_start
;
3876 echo_truncate (echo_start
);
3878 /* If the best binding for the current key sequence is a keymap, or
3879 we may be looking at a function key's escape sequence, keep on
3881 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
3882 || (first_binding
>= nmaps
3884 /* mock input is never part of a function key's sequence. */
3885 && mock_input
<= fkey_start
)
3886 || (first_binding
>= nmaps
3887 && keytran_start
< t
3888 /* mock input is never part of a function key's sequence. */
3889 && mock_input
<= keytran_start
))
3892 int used_mouse_menu
= 0;
3894 /* Where the last real key started. If we need to throw away a
3895 key that has expanded into more than one element of keybuf
3896 (say, a mouse click on the mode line which is being treated
3897 as [mode-line (mouse-...)], then we backtrack to this point
3899 int last_real_key_start
;
3901 /* These variables are analogous to echo_start and keys_start;
3902 while those allow us to restart the entire key sequence,
3903 echo_local_start and keys_local_start allow us to throw away
3905 int echo_local_start
, keys_local_start
, local_first_binding
;
3908 error ("key sequence too long");
3911 echo_local_start
= echo_length ();
3912 keys_local_start
= this_command_key_count
;
3913 local_first_binding
= first_binding
;
3916 /* These are no-ops, unless we throw away a keystroke below and
3917 jumped back up to replay_key; in that case, these restore the
3918 variables to their original state, allowing us to replay the
3921 echo_truncate (echo_local_start
);
3922 this_command_key_count
= keys_local_start
;
3923 first_binding
= local_first_binding
;
3925 /* By default, assume each event is "real". */
3926 last_real_key_start
= t
;
3928 /* Does mock_input indicate that we are re-reading a key sequence? */
3932 add_command_key (key
);
3936 /* If not, we should actually read a character. */
3939 struct buffer
*buf
= current_buffer
;
3941 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
3944 /* read_char returns t when it shows a menu and the user rejects it.
3949 /* read_char returns -1 at the end of a macro.
3950 Emacs 18 handles this by returning immediately with a
3951 zero, so that's what we'll do. */
3952 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) == -1)
3961 /* Clicks in non-text areas get prefixed by the symbol
3962 in their CHAR-ADDRESS field. For example, a click on
3963 the mode line is prefixed by the symbol `mode-line'.
3965 Furthermore, key sequences beginning with mouse clicks
3966 are read using the keymaps of the buffer clicked on, not
3967 the current buffer. So we may have to switch the buffer
3970 When we turn one event into two events, we must make sure
3971 that neither of the two looks like the original--so that,
3972 if we replay the events, they won't be expanded again.
3973 If not for this, such reexpansion could happen either here
3974 or when user programs play with this-command-keys. */
3975 if (EVENT_HAS_PARAMETERS (key
))
3977 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
3979 if (EQ (kind
, Qmouse_click
))
3981 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
3982 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
3984 if (XTYPE (posn
) == Lisp_Cons
)
3986 /* We're looking at the second event of a
3987 sequence which we expanded before. Set
3988 last_real_key_start appropriately. */
3990 last_real_key_start
= t
- 1;
3993 /* Key sequences beginning with mouse clicks are
3994 read using the keymaps in the buffer clicked on,
3995 not the current buffer. If we're at the
3996 beginning of a key sequence, switch buffers. */
3997 if (last_real_key_start
== 0
3998 && XTYPE (window
) == Lisp_Window
3999 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
4000 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
4005 /* Arrange to go back to the original buffer once we're
4006 done reading the key sequence. Note that we can't
4007 use save_excursion_{save,restore} here, because they
4008 save point as well as the current buffer; we don't
4009 want to save point, because redisplay may change it,
4010 to accommodate a Fset_window_start or something. We
4011 don't want to do this at the top of the function,
4012 because we may get input from a subprocess which
4013 wants to change the selected window and stuff (say,
4015 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
4017 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
4018 goto replay_sequence
;
4020 else if (XTYPE (posn
) == Lisp_Symbol
)
4022 /* Expand mode-line and scroll-bar events into two events:
4023 use posn as a fake prefix key. */
4025 if (t
+ 1 >= bufsize
)
4026 error ("key sequence too long");
4031 /* Zap the position in key, so we know that we've
4032 expanded it, and don't try to do so again. */
4033 POSN_BUFFER_POSN (EVENT_START (key
))
4034 = Fcons (posn
, Qnil
);
4038 else if (EQ (kind
, Qswitch_frame
))
4040 /* If we're at the beginning of a key sequence, go
4041 ahead and return this event. If we're in the
4042 midst of a key sequence, delay it until the end. */
4045 delayed_switch_frame
= key
;
4051 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4053 /* Handle menu-bar events:
4054 insert the dummy prefix event `menu-bar'. */
4055 if (EQ (posn
, Qmenu_bar
))
4057 if (t
+ 1 >= bufsize
)
4058 error ("key sequence too long");
4059 /* Run the Lucid hook. */
4060 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4061 /* If it has changed current-menubar from previous value,
4062 really recompute the menubar from the value. */
4063 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4064 call0 (Qrecompute_lucid_menubar
);
4068 /* Zap the position in key, so we know that we've
4069 expanded it, and don't try to do so again. */
4070 POSN_BUFFER_POSN (EVENT_START (key
))
4071 = Fcons (posn
, Qnil
);
4074 goto replay_sequence
;
4076 else if (XTYPE (posn
) == Lisp_Cons
)
4078 /* We're looking at the second event of a
4079 sequence which we expanded before. Set
4080 last_real_key_start appropriately. */
4081 if (last_real_key_start
== t
&& t
> 0)
4082 last_real_key_start
= t
- 1;
4087 /* We have finally decided that KEY is something we might want
4089 first_binding
= (follow_key (key
,
4090 nmaps
- first_binding
,
4091 submaps
+ first_binding
,
4092 defs
+ first_binding
,
4093 submaps
+ first_binding
)
4096 /* If KEY wasn't bound, we'll try some fallbacks. */
4097 if (first_binding
>= nmaps
)
4099 Lisp_Object head
= EVENT_HEAD (key
);
4101 if (EQ (head
, Vhelp_char
))
4103 read_key_sequence_cmd
= Vprefix_help_command
;
4105 last_nonmenu_event
= key
;
4109 if (XTYPE (head
) == Lisp_Symbol
)
4111 Lisp_Object breakdown
= parse_modifiers (head
);
4112 int modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4114 /* Attempt to reduce an unbound mouse event to a simpler
4115 event that is bound:
4116 Drags reduce to clicks.
4117 Double-clicks reduce to clicks.
4118 Triple-clicks reduce to double-clicks, then to clicks.
4119 Down-clicks are eliminated.
4120 Double-downs reduce to downs, then are eliminated.
4121 Triple-downs reduce to double-downs, then to downs,
4122 then are eliminated. */
4123 if (modifiers
& (down_modifier
| drag_modifier
4124 | double_modifier
| triple_modifier
))
4126 while (modifiers
& (down_modifier
| drag_modifier
4127 | double_modifier
| triple_modifier
))
4129 Lisp_Object new_head
, new_click
;
4130 if (modifiers
& triple_modifier
)
4131 modifiers
^= (double_modifier
| triple_modifier
);
4132 else if (modifiers
& (drag_modifier
| double_modifier
))
4133 modifiers
&= ~(drag_modifier
| double_modifier
);
4136 /* Dispose of this `down' event by simply jumping
4137 back to replay_key, to get another event.
4139 Note that if this event came from mock input,
4140 then just jumping back to replay_key will just
4141 hand it to us again. So we have to wipe out any
4144 We could delete keybuf[t] and shift everything
4145 after that to the left by one spot, but we'd also
4146 have to fix up any variable that points into
4147 keybuf, and shifting isn't really necessary
4150 Adding prefixes for non-textual mouse clicks
4151 creates two characters of mock input, and both
4152 must be thrown away. If we're only looking at
4153 the prefix now, we can just jump back to
4154 replay_key. On the other hand, if we've already
4155 processed the prefix, and now the actual click
4156 itself is giving us trouble, then we've lost the
4157 state of the keymaps we want to backtrack to, and
4158 we need to replay the whole sequence to rebuild
4161 Beyond that, only function key expansion could
4162 create more than two keys, but that should never
4163 generate mouse events, so it's okay to zero
4164 mock_input in that case too.
4166 Isn't this just the most wonderful code ever? */
4167 if (t
== last_real_key_start
)
4174 mock_input
= last_real_key_start
;
4175 goto replay_sequence
;
4180 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
4182 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
4184 /* Look for a binding for this new key. follow_key
4185 promises that it didn't munge submaps the
4186 last time we called it, since key was unbound. */
4188 = (follow_key (new_click
,
4189 nmaps
- local_first_binding
,
4190 submaps
+ local_first_binding
,
4191 defs
+ local_first_binding
,
4192 submaps
+ local_first_binding
)
4193 + local_first_binding
);
4195 /* If that click is bound, go for it. */
4196 if (first_binding
< nmaps
)
4201 /* Otherwise, we'll leave key set to the drag event. */
4208 /* Normally, last_nonmenu_event gets the previous key we read.
4209 But when a mouse popup menu is being used,
4210 we don't update last_nonmenu_event; it continues to hold the mouse
4211 event that preceded the first level of menu. */
4212 if (!used_mouse_menu
)
4213 last_nonmenu_event
= key
;
4215 /* If the sequence is unbound, see if we can hang a function key
4216 off the end of it. We only want to scan real keyboard input
4217 for function key sequences, so if mock_input says that we're
4218 re-reading old events, don't examine it. */
4219 if (first_binding
>= nmaps
4222 Lisp_Object fkey_next
;
4224 /* Scan from fkey_end until we find a bound suffix. */
4225 while (fkey_end
< t
)
4229 key
= keybuf
[fkey_end
++];
4230 /* Look up meta-characters by prefixing them
4231 with meta_prefix_char. I hate this. */
4232 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4237 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
4239 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4242 fkey_next
= fkey_map
;
4245 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
4247 /* If the function key map gives a function, not an
4248 array, then call the function with no args and use
4249 its value instead. */
4250 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
4253 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4257 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4258 fkey_next
= call1 (fkey_next
, prompt
);
4260 /* If the function returned something invalid,
4261 barf--don't ignore it.
4262 (To ignore it safely, we would need to gcpro a bunch of
4263 other variables.) */
4264 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
4265 error ("Function in function-key-map returns invalid key sequence");
4268 /* If keybuf[fkey_start..fkey_end] is bound in the
4269 function key map and it's a suffix of the current
4270 sequence (i.e. fkey_end == t), replace it with
4271 the binding and restart with fkey_start at the end. */
4272 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
4275 int len
= XFASTINT (Flength (fkey_next
));
4277 t
= fkey_start
+ len
;
4279 error ("key sequence too long");
4281 if (VECTORP (fkey_next
))
4282 bcopy (XVECTOR (fkey_next
)->contents
,
4283 keybuf
+ fkey_start
,
4284 (t
- fkey_start
) * sizeof (keybuf
[0]));
4285 else if (STRINGP (fkey_next
))
4289 for (i
= 0; i
< len
; i
++)
4290 XFASTINT (keybuf
[fkey_start
+ i
])
4291 = XSTRING (fkey_next
)->data
[i
];
4295 fkey_start
= fkey_end
= t
;
4296 fkey_map
= Vfunction_key_map
;
4298 goto replay_sequence
;
4301 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
4303 /* If we no longer have a bound suffix, try a new positions for
4305 if (NILP (fkey_map
))
4307 fkey_end
= ++fkey_start
;
4308 fkey_map
= Vfunction_key_map
;
4313 /* Look for this sequence in key-translation-map. */
4315 Lisp_Object keytran_next
;
4317 /* Scan from keytran_end until we find a bound suffix. */
4318 while (keytran_end
< t
)
4322 key
= keybuf
[keytran_end
++];
4323 /* Look up meta-characters by prefixing them
4324 with meta_prefix_char. I hate this. */
4325 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4330 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
4332 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4335 keytran_next
= keytran_map
;
4338 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
4340 /* If the key translation map gives a function, not an
4341 array, then call the function with no args and use
4342 its value instead. */
4343 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
4344 && keytran_end
== t
)
4346 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4350 GCPRO3 (keytran_map
, keytran_map
, delayed_switch_frame
);
4351 keytran_next
= call1 (keytran_next
, prompt
);
4353 /* If the function returned something invalid,
4354 barf--don't ignore it.
4355 (To ignore it safely, we would need to gcpro a bunch of
4356 other variables.) */
4357 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
4358 error ("Function in function-key-map returns invalid key sequence");
4361 /* If keybuf[keytran_start..keytran_end] is bound in the
4362 key translation map and it's a suffix of the current
4363 sequence (i.e. keytran_end == t), replace it with
4364 the binding and restart with keytran_start at the end. */
4365 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
4366 && keytran_end
== t
)
4368 int len
= XFASTINT (Flength (keytran_next
));
4370 t
= keytran_start
+ len
;
4372 error ("key sequence too long");
4374 if (VECTORP (keytran_next
))
4375 bcopy (XVECTOR (keytran_next
)->contents
,
4376 keybuf
+ keytran_start
,
4377 (t
- keytran_start
) * sizeof (keybuf
[0]));
4378 else if (STRINGP (keytran_next
))
4382 for (i
= 0; i
< len
; i
++)
4383 XFASTINT (keybuf
[keytran_start
+ i
])
4384 = XSTRING (keytran_next
)->data
[i
];
4388 keytran_start
= keytran_end
= t
;
4389 keytran_map
= Vkey_translation_map
;
4391 goto replay_sequence
;
4394 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
4396 /* If we no longer have a bound suffix, try a new positions for
4398 if (NILP (keytran_map
))
4400 keytran_end
= ++keytran_start
;
4401 keytran_map
= Vkey_translation_map
;
4407 read_key_sequence_cmd
= (first_binding
< nmaps
4408 ? defs
[first_binding
]
4412 unread_switch_frame
= delayed_switch_frame
;
4413 unbind_to (count
, Qnil
);
4415 /* Occasionally we fabricate events, perhaps by expanding something
4416 according to function-key-map, or by adding a prefix symbol to a
4417 mouse click in the scroll bar or modeline. In this cases, return
4418 the entire generated key sequence, even if we hit an unbound
4419 prefix or a definition before the end. This means that you will
4420 be able to push back the event properly, and also means that
4421 read-key-sequence will always return a logical unit.
4424 for (; t
< mock_input
; t
++)
4426 echo_char (keybuf
[t
]);
4427 add_command_key (keybuf
[t
]);
4433 #if 0 /* This doc string is too long for some compilers.
4434 This commented-out definition serves for DOC. */
4435 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4436 "Read a sequence of keystrokes and return as a string or vector.\n\
4437 The sequence is sufficient to specify a non-prefix command in the\n\
4438 current local and global maps.\n\
4440 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
4441 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
4442 as a continuation of the previous key.\n\
4444 A C-g typed while in this function is treated like any other character,\n\
4445 and `quit-flag' is not set.\n\
4447 If the key sequence starts with a mouse click, then the sequence is read\n\
4448 using the keymaps of the buffer of the window clicked in, not the buffer\n\
4449 of the selected window as normal.\n\
4451 `read-key-sequence' drops unbound button-down events, since you normally\n\
4452 only care about the click or drag events which follow them. If a drag\n\
4453 or multi-click event is unbound, but the corresponding click event would\n\
4454 be bound, `read-key-sequence' turns the event into a click event at the\n\
4455 drag's starting position. This means that you don't have to distinguish\n\
4456 between click and drag, double, or triple events unless you want to.\n\
4458 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
4459 lines separating windows, and scroll bars with imaginary keys\n\
4460 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
4462 If the user switches frames in the middle of a key sequence, the\n\
4463 frame-switch event is put off until after the current key sequence.\n\
4465 `read-key-sequence' checks `function-key-map' for function key\n\
4466 sequences, where they wouldn't conflict with ordinary bindings. See\n\
4467 `function-key-map' for more details.")
4468 (prompt
, continue_echo
)
4471 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4473 (prompt
, continue_echo
)
4474 Lisp_Object prompt
, continue_echo
;
4476 Lisp_Object keybuf
[30];
4478 struct gcpro gcpro1
, gcpro2
;
4481 CHECK_STRING (prompt
, 0);
4484 bzero (keybuf
, sizeof keybuf
);
4486 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
4488 if (NILP (continue_echo
))
4489 this_command_key_count
= 0;
4491 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])), prompt
);
4499 return make_event_array (i
, keybuf
);
4502 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
4503 "Execute CMD as an editor command.\n\
4504 CMD must be a symbol that satisfies the `commandp' predicate.\n\
4505 Optional second arg RECORD-FLAG non-nil\n\
4506 means unconditionally put this command in `command-history'.\n\
4507 Otherwise, that is done only if an arg is read using the minibuffer.")
4509 Lisp_Object cmd
, record
;
4511 register Lisp_Object final
;
4512 register Lisp_Object tem
;
4513 Lisp_Object prefixarg
;
4514 struct backtrace backtrace
;
4515 extern int debug_on_next_call
;
4517 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
4518 Vcurrent_prefix_arg
= prefixarg
;
4519 debug_on_next_call
= 0;
4521 if (XTYPE (cmd
) == Lisp_Symbol
)
4523 tem
= Fget (cmd
, Qdisabled
);
4525 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
4530 final
= Findirect_function (cmd
);
4532 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
4533 do_autoload (final
, cmd
);
4538 if (XTYPE (final
) == Lisp_String
4539 || XTYPE (final
) == Lisp_Vector
)
4541 /* If requested, place the macro in the command history. For
4542 other sorts of commands, call-interactively takes care of
4546 = Fcons (Fcons (Qexecute_kbd_macro
,
4547 Fcons (final
, Fcons (prefixarg
, Qnil
))),
4550 return Fexecute_kbd_macro (final
, prefixarg
);
4552 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
4553 || XTYPE (final
) == Lisp_Compiled
)
4555 backtrace
.next
= backtrace_list
;
4556 backtrace_list
= &backtrace
;
4557 backtrace
.function
= &Qcall_interactively
;
4558 backtrace
.args
= &cmd
;
4559 backtrace
.nargs
= 1;
4560 backtrace
.evalargs
= 0;
4562 tem
= Fcall_interactively (cmd
, record
);
4564 backtrace_list
= backtrace
.next
;
4570 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
4572 "Read function name, then read its arguments and call it.")
4574 Lisp_Object prefixarg
;
4576 Lisp_Object function
;
4578 Lisp_Object saved_keys
;
4579 struct gcpro gcpro1
;
4581 saved_keys
= Fthis_command_keys ();
4583 GCPRO1 (saved_keys
);
4585 if (EQ (prefixarg
, Qminus
))
4587 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
4588 strcpy (buf
, "C-u ");
4589 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
4590 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
4591 else if (XTYPE (prefixarg
) == Lisp_Int
)
4592 sprintf (buf
, "%d ", XINT (prefixarg
));
4594 /* This isn't strictly correct if execute-extended-command
4595 is bound to anything else. Perhaps it should use
4596 this_command_keys? */
4597 strcat (buf
, "M-x ");
4599 /* Prompt with buf, and then read a string, completing from and
4600 restricting to the set of all defined commands. Don't provide
4601 any initial input. Save the command read on the extended-command
4603 function
= Fcompleting_read (build_string (buf
),
4604 Vobarray
, Qcommandp
,
4605 Qt
, Qnil
, Qextended_command_history
);
4607 /* Set this_command_keys to the concatenation of saved_keys and
4608 function, followed by a RET. */
4610 struct Lisp_String
*str
;
4614 this_command_key_count
= 0;
4616 str
= XSTRING (saved_keys
);
4617 for (i
= 0; i
< str
->size
; i
++)
4619 XFASTINT (tem
) = str
->data
[i
];
4620 add_command_key (tem
);
4623 str
= XSTRING (function
);
4624 for (i
= 0; i
< str
->size
; i
++)
4626 XFASTINT (tem
) = str
->data
[i
];
4627 add_command_key (tem
);
4630 XFASTINT (tem
) = '\015';
4631 add_command_key (tem
);
4636 function
= Fintern (function
, Qnil
);
4637 Vprefix_arg
= prefixarg
;
4638 this_command
= function
;
4640 return Fcommand_execute (function
, Qt
);
4644 detect_input_pending ()
4647 get_input_pending (&input_pending
);
4649 return input_pending
;
4652 /* This is called in some cases before a possible quit.
4653 It cases the next call to detect_input_pending to recompute input_pending.
4654 So calling this function unnecessarily can't do any harm. */
4655 clear_input_pending ()
4660 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
4661 "T if command input is currently available with no waiting.\n\
4662 Actually, the value is nil only if we can be sure that no input is available.")
4665 if (!NILP (unread_command_events
) || unread_command_char
!= -1)
4668 return detect_input_pending () ? Qt
: Qnil
;
4671 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
4672 "Return vector of last 100 events, not counting those from keyboard macros.")
4675 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
4678 if (total_keys
< NUM_RECENT_KEYS
)
4679 return Fvector (total_keys
, keys
);
4682 val
= Fvector (NUM_RECENT_KEYS
, keys
);
4683 bcopy (keys
+ recent_keys_index
,
4684 XVECTOR (val
)->contents
,
4685 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
4687 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
4688 recent_keys_index
* sizeof (Lisp_Object
));
4693 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
4694 "Return the key sequence that invoked this command.\n\
4695 The value is a string or a vector.")
4698 return make_event_array (this_command_key_count
,
4699 XVECTOR (this_command_keys
)->contents
);
4702 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
4703 "Return the current depth in recursive edits.")
4707 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
4711 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
4712 "FOpen dribble file: ",
4713 "Start writing all keyboard characters to a dribble file called FILE.\n\
4714 If FILE is nil, close any open dribble file.")
4725 file
= Fexpand_file_name (file
, Qnil
);
4726 dribble
= fopen (XSTRING (file
)->data
, "w");
4731 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
4732 "Discard the contents of the terminal input buffer.\n\
4733 Also cancel any kbd macro being defined.")
4736 defining_kbd_macro
= 0;
4737 update_mode_lines
++;
4739 unread_command_events
= Qnil
;
4740 unread_command_char
= -1;
4742 discard_tty_input ();
4744 /* Without the cast, GCC complains that this assignment loses the
4745 volatile qualifier of kbd_store_ptr. Is there anything wrong
4747 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
4748 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
4754 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
4755 "Stop Emacs and return to superior process. You can resume later.\n\
4756 On systems that don't have job control, run a subshell instead.\n\n\
4757 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
4758 to be read as terminal input by Emacs's parent, after suspension.\n\
4760 Before suspending, call the functions in `suspend-hook' with no args.\n\
4761 If any of them returns nil, don't call the rest and don't suspend.\n\
4762 Otherwise, suspend normally and after resumption run the normal hook\n\
4763 `suspend-resume-hook' if that is bound and non-nil.\n\
4765 Some operating systems cannot stop the Emacs process and resume it later.\n\
4766 On such systems, Emacs starts a subshell instead of suspending.")
4768 Lisp_Object stuffstring
;
4771 int count
= specpdl_ptr
- specpdl
;
4772 int old_height
, old_width
;
4774 struct gcpro gcpro1
, gcpro2
;
4775 extern init_sys_modes ();
4777 if (!NILP (stuffstring
))
4778 CHECK_STRING (stuffstring
, 0);
4780 /* Run the functions in suspend-hook. */
4781 if (!NILP (Vrun_hooks
))
4782 call1 (Vrun_hooks
, intern ("suspend-hook"));
4784 GCPRO1 (stuffstring
);
4785 get_frame_size (&old_width
, &old_height
);
4787 /* sys_suspend can get an error if it tries to fork a subshell
4788 and the system resources aren't available for that. */
4789 record_unwind_protect (init_sys_modes
, 0);
4790 stuff_buffered_input (stuffstring
);
4792 unbind_to (count
, Qnil
);
4794 /* Check if terminal/window size has changed.
4795 Note that this is not useful when we are running directly
4796 with a window system; but suspend should be disabled in that case. */
4797 get_frame_size (&width
, &height
);
4798 if (width
!= old_width
|| height
!= old_height
)
4799 change_frame_size (selected_frame
, height
, width
, 0, 0);
4801 /* Run suspend-resume-hook. */
4802 if (!NILP (Vrun_hooks
))
4803 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
4809 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
4810 Then in any case stuff anything Emacs has read ahead and not used. */
4812 stuff_buffered_input (stuffstring
)
4813 Lisp_Object stuffstring
;
4815 register unsigned char *p
;
4817 /* stuff_char works only in BSD, versions 4.2 and up. */
4820 if (XTYPE (stuffstring
) == Lisp_String
)
4824 p
= XSTRING (stuffstring
)->data
;
4825 count
= XSTRING (stuffstring
)->size
;
4830 /* Anything we have read ahead, put back for the shell to read. */
4831 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4833 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4834 kbd_fetch_ptr
= kbd_buffer
;
4835 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
4836 stuff_char (XINT (kbd_fetch_ptr
->code
));
4837 kbd_fetch_ptr
->kind
= no_event
;
4838 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
4845 #endif /* BSD and not BSD4_1 */
4848 set_waiting_for_input (time_to_clear
)
4849 EMACS_TIME
*time_to_clear
;
4851 input_available_clear_time
= time_to_clear
;
4853 /* Tell interrupt_signal to throw back to read_char, */
4854 waiting_for_input
= 1;
4856 /* If interrupt_signal was called before and buffered a C-g,
4857 make it run again now, to avoid timing error. */
4858 if (!NILP (Vquit_flag
))
4859 quit_throw_to_read_char ();
4861 /* If alarm has gone off already, echo now. */
4869 clear_waiting_for_input ()
4871 /* Tell interrupt_signal not to throw back to read_char, */
4872 waiting_for_input
= 0;
4873 input_available_clear_time
= 0;
4876 /* This routine is called at interrupt level in response to C-G.
4877 If interrupt_input, this is the handler for SIGINT.
4878 Otherwise, it is called from kbd_buffer_store_event,
4879 in handling SIGIO or SIGTINT.
4881 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
4882 immediately throw back to read_char.
4884 Otherwise it sets the Lisp variable quit-flag not-nil.
4885 This causes eval to throw, when it gets a chance.
4886 If quit-flag is already non-nil, it stops the job right away. */
4892 /* Must preserve main program's value of errno. */
4893 int old_errno
= errno
;
4896 /* USG systems forget handlers when they are used;
4897 must reestablish each time */
4898 signal (SIGINT
, interrupt_signal
);
4899 signal (SIGQUIT
, interrupt_signal
);
4904 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
4909 #ifdef SIGTSTP /* Support possible in later USG versions */
4911 * On systems which can suspend the current process and return to the original
4912 * shell, this command causes the user to end up back at the shell.
4913 * The "Auto-save" and "Abort" questions are not asked until
4914 * the user elects to return to emacs, at which point he can save the current
4915 * job and either dump core or continue.
4920 if (sys_suspend () == -1)
4922 printf ("Not running as a subprocess;\n");
4923 printf ("you can continue or abort.\n");
4926 /* Perhaps should really fork an inferior shell?
4927 But that would not provide any way to get back
4928 to the original shell, ever. */
4929 printf ("No support for stopping a process on this operating system;\n");
4930 printf ("you can continue or abort.\n");
4931 #endif /* not VMS */
4932 #endif /* not SIGTSTP */
4933 printf ("Auto-save? (y or n) ");
4935 if (((c
= getchar ()) & ~040) == 'Y')
4937 Fdo_auto_save (Qt
, Qnil
);
4938 printf ("Auto-save done\n");
4940 while (c
!= '\n') c
= getchar ();
4942 printf ("Abort (and enter debugger)? (y or n) ");
4944 printf ("Abort (and dump core)? (y or n) ");
4945 #endif /* not VMS */
4947 if (((c
= getchar ()) & ~040) == 'Y')
4949 while (c
!= '\n') c
= getchar ();
4950 printf ("Continuing...\n");
4956 /* If executing a function that wants to be interrupted out of
4957 and the user has not deferred quitting by binding `inhibit-quit'
4958 then quit right away. */
4959 if (immediate_quit
&& NILP (Vinhibit_quit
))
4963 Fsignal (Qquit
, Qnil
);
4966 /* Else request quit when it's safe */
4970 if (waiting_for_input
&& !echoing
)
4971 quit_throw_to_read_char ();
4976 /* Handle a C-g by making read_char return C-g. */
4978 quit_throw_to_read_char ()
4980 quit_error_check ();
4982 /* Prevent another signal from doing this before we finish. */
4983 clear_waiting_for_input ();
4986 unread_command_events
= Qnil
;
4987 unread_command_char
= -1;
4989 #ifdef POLL_FOR_INPUT
4990 /* May be > 1 if in recursive minibuffer. */
4991 if (poll_suppress_count
== 0)
4995 _longjmp (getcjmp
, 1);
4998 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
4999 "Set mode of reading keyboard input.\n\
5000 First arg INTERRUPT non-nil means use input interrupts;\n\
5001 nil means use CBREAK mode.\n\
5002 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
5003 (no effect except in CBREAK mode).\n\
5004 Third arg META t means accept 8-bit input (for a Meta key).\n\
5005 META nil means ignore the top bit, on the assumption it is parity.\n\
5006 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
5007 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
5008 See also `current-input-mode'.")
5009 (interrupt
, flow
, meta
, quit
)
5010 Lisp_Object interrupt
, flow
, meta
, quit
;
5013 && (XTYPE (quit
) != Lisp_Int
5014 || XINT (quit
) < 0 || XINT (quit
) > 0400))
5015 error ("set-input-mode: QUIT must be an ASCII character");
5017 #ifdef POLL_FOR_INPUT
5023 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5024 #ifdef NO_SOCK_SIGIO
5025 if (read_socket_hook
)
5026 interrupt_input
= 0; /* No interrupts if reading from a socket. */
5028 #endif /* NO_SOCK_SIGIO */
5029 interrupt_input
= !NILP (interrupt
);
5030 #else /* not SIGIO */
5031 interrupt_input
= 0;
5032 #endif /* not SIGIO */
5033 /* Our VMS input only works by interrupts, as of now. */
5035 interrupt_input
= 1;
5037 flow_control
= !NILP (flow
);
5040 else if (EQ (meta
, Qt
))
5045 /* Don't let this value be out of range. */
5046 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
5050 #ifdef POLL_FOR_INPUT
5051 poll_suppress_count
= 1;
5057 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
5058 "Return information about the way Emacs currently reads keyboard input.\n\
5059 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
5060 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
5061 nil, Emacs is using CBREAK mode.\n\
5062 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
5063 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
5064 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
5065 META nil means ignoring the top bit, on the assumption it is parity.\n\
5066 META is neither t nor nil if accepting 8-bit input and using\n\
5067 all 8 bits as the character code.\n\
5068 QUIT is the character Emacs currently uses to quit.\n\
5069 The elements of this list correspond to the arguments of\n\
5075 val
[0] = interrupt_input
? Qt
: Qnil
;
5076 val
[1] = flow_control
? Qt
: Qnil
;
5077 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
5078 XFASTINT (val
[3]) = quit_char
;
5080 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
5086 /* This is correct before outermost invocation of the editor loop */
5087 command_loop_level
= -1;
5089 quit_char
= Ctl ('g');
5090 unread_command_events
= Qnil
;
5091 unread_command_char
= -1;
5093 recent_keys_index
= 0;
5094 kbd_fetch_ptr
= kbd_buffer
;
5095 kbd_store_ptr
= kbd_buffer
;
5096 do_mouse_tracking
= 0;
5100 /* This means that command_loop_1 won't try to select anything the first
5102 internal_last_event_frame
= Qnil
;
5103 Vlast_event_frame
= internal_last_event_frame
;
5106 /* If we're running a dumped Emacs, we need to clear out
5107 kbd_buffer_frame_or_window, in case some events got into it
5110 If we're running an undumped Emacs, it hasn't been initialized by
5111 syms_of_keyboard yet. */
5113 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5115 if (!noninteractive
)
5117 signal (SIGINT
, interrupt_signal
);
5118 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
5119 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
5120 SIGQUIT and we can't tell which one it will give us. */
5121 signal (SIGQUIT
, interrupt_signal
);
5122 #endif /* HAVE_TERMIO */
5123 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5125 signal (SIGIO
, input_available_signal
);
5129 /* Use interrupt input by default, if it works and noninterrupt input
5130 has deficiencies. */
5132 #ifdef INTERRUPT_INPUT
5133 interrupt_input
= 1;
5135 interrupt_input
= 0;
5138 /* Our VMS input only works by interrupts, as of now. */
5140 interrupt_input
= 1;
5146 if (keyboard_init_hook
)
5147 (*keyboard_init_hook
) ();
5149 #ifdef POLL_FOR_INPUT
5150 poll_suppress_count
= 1;
5155 /* This type's only use is in syms_of_keyboard, to initialize the
5156 event header symbols and put properties on them. */
5163 struct event_head head_table
[] = {
5164 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
5165 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
5166 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
5171 Qdisabled_command_hook
= intern ("disabled-command-hook");
5172 staticpro (&Qdisabled_command_hook
);
5174 Qself_insert_command
= intern ("self-insert-command");
5175 staticpro (&Qself_insert_command
);
5177 Qforward_char
= intern ("forward-char");
5178 staticpro (&Qforward_char
);
5180 Qbackward_char
= intern ("backward-char");
5181 staticpro (&Qbackward_char
);
5183 Qdisabled
= intern ("disabled");
5184 staticpro (&Qdisabled
);
5186 Qundefined
= intern ("undefined");
5187 staticpro (&Qundefined
);
5189 Qpre_command_hook
= intern ("pre-command-hook");
5190 staticpro (&Qpre_command_hook
);
5192 Qpost_command_hook
= intern ("post-command-hook");
5193 staticpro (&Qpost_command_hook
);
5195 Qfunction_key
= intern ("function-key");
5196 staticpro (&Qfunction_key
);
5197 Qmouse_click
= intern ("mouse-click");
5198 staticpro (&Qmouse_click
);
5200 Qmenu_enable
= intern ("menu-enable");
5201 staticpro (&Qmenu_enable
);
5203 Qmode_line
= intern ("mode-line");
5204 staticpro (&Qmode_line
);
5205 Qvertical_line
= intern ("vertical-line");
5206 staticpro (&Qvertical_line
);
5207 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
5208 staticpro (&Qvertical_scroll_bar
);
5209 Qmenu_bar
= intern ("menu-bar");
5210 staticpro (&Qmenu_bar
);
5212 Qabove_handle
= intern ("above-handle");
5213 staticpro (&Qabove_handle
);
5214 Qhandle
= intern ("handle");
5215 staticpro (&Qhandle
);
5216 Qbelow_handle
= intern ("below-handle");
5217 staticpro (&Qbelow_handle
);
5219 Qevent_kind
= intern ("event-kind");
5220 staticpro (&Qevent_kind
);
5221 Qevent_symbol_elements
= intern ("event-symbol-elements");
5222 staticpro (&Qevent_symbol_elements
);
5223 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
5224 staticpro (&Qevent_symbol_element_mask
);
5225 Qmodifier_cache
= intern ("modifier-cache");
5226 staticpro (&Qmodifier_cache
);
5228 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
5229 staticpro (&Qrecompute_lucid_menubar
);
5230 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
5231 staticpro (&Qactivate_menubar_hook
);
5234 struct event_head
*p
;
5236 for (p
= head_table
;
5237 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
5240 *p
->var
= intern (p
->name
);
5242 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
5243 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
5247 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
5248 staticpro (&button_down_location
);
5252 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
5254 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
5255 for (i
= 0; i
< len
; i
++)
5256 if (modifier_names
[i
])
5257 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
5258 staticpro (&modifier_symbols
);
5261 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
5262 staticpro (&recent_keys
);
5264 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
5265 staticpro (&this_command_keys
);
5267 Qextended_command_history
= intern ("extended-command-history");
5268 Fset (Qextended_command_history
, Qnil
);
5269 staticpro (&Qextended_command_history
);
5271 kbd_buffer_frame_or_window
5272 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
5273 staticpro (&kbd_buffer_frame_or_window
);
5275 func_key_syms
= Qnil
;
5276 staticpro (&func_key_syms
);
5279 staticpro (&mouse_syms
);
5281 unread_switch_frame
= Qnil
;
5282 staticpro (&unread_switch_frame
);
5284 defsubr (&Sread_key_sequence
);
5285 defsubr (&Srecursive_edit
);
5286 defsubr (&Strack_mouse
);
5287 defsubr (&Sinput_pending_p
);
5288 defsubr (&Scommand_execute
);
5289 defsubr (&Srecent_keys
);
5290 defsubr (&Sthis_command_keys
);
5291 defsubr (&Ssuspend_emacs
);
5292 defsubr (&Sabort_recursive_edit
);
5293 defsubr (&Sexit_recursive_edit
);
5294 defsubr (&Srecursion_depth
);
5295 defsubr (&Stop_level
);
5296 defsubr (&Sdiscard_input
);
5297 defsubr (&Sopen_dribble_file
);
5298 defsubr (&Sset_input_mode
);
5299 defsubr (&Scurrent_input_mode
);
5300 defsubr (&Sexecute_extended_command
);
5302 DEFVAR_LISP ("last-command-char", &last_command_char
,
5303 "Last input event that was part of a command.");
5305 DEFVAR_LISP ("last-command-event", &last_command_char
,
5306 "Last input event that was part of a command.");
5308 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
5309 "Last input event in a command, except for mouse menu events.\n\
5310 Mouse menus give back keys that don't look like mouse events;\n\
5311 this variable holds the actual mouse event that led to the menu,\n\
5312 so that you can determine whether the command was run by mouse or not.");
5314 DEFVAR_LISP ("last-input-char", &last_input_char
,
5315 "Last input event.");
5317 DEFVAR_LISP ("last-input-event", &last_input_char
,
5318 "Last input event.");
5320 DEFVAR_LISP ("unread-command-events", &unread_command_events
,
5321 "List of objects to be read as next command input events.");
5323 DEFVAR_INT ("unread-command-char", &unread_command_char
,
5324 "If not -1, an object to be read as next command input event.");
5326 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
5327 "Meta-prefix character code. Meta-foo as command input\n\
5328 turns into this character followed by foo.");
5329 XSET (meta_prefix_char
, Lisp_Int
, 033);
5331 DEFVAR_LISP ("last-command", &last_command
,
5332 "The last command executed. Normally a symbol with a function definition,\n\
5333 but can be whatever was found in the keymap, or whatever the variable\n\
5334 `this-command' was set to by that command.");
5335 last_command
= Qnil
;
5337 DEFVAR_LISP ("this-command", &this_command
,
5338 "The command now being executed.\n\
5339 The command can set this variable; whatever is put here\n\
5340 will be in `last-command' during the following command.");
5341 this_command
= Qnil
;
5343 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
5344 "*Number of keyboard input characters between auto-saves.\n\
5345 Zero means disable autosaving due to number of characters typed.");
5346 auto_save_interval
= 300;
5348 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
5349 "*Number of seconds idle time before auto-save.\n\
5350 Zero or nil means disable auto-saving due to idleness.\n\
5351 After auto-saving due to this many seconds of idle time,\n\
5352 Emacs also does a garbage collection if that seems to be warranted.");
5353 XFASTINT (Vauto_save_timeout
) = 30;
5355 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
5356 "*Nonzero means echo unfinished commands after this many seconds of pause.");
5357 echo_keystrokes
= 1;
5359 DEFVAR_INT ("polling-period", &polling_period
,
5360 "*Interval between polling for input during Lisp execution.\n\
5361 The reason for polling is to make C-g work to stop a running program.\n\
5362 Polling is needed only when using X windows and SIGIO does not work.\n\
5363 Polling is automatically disabled in all other cases.");
5366 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
5367 "*Maximum time between mouse clicks to make a double-click.\n\
5368 Measured in milliseconds. nil means disable double-click recognition;\n\
5369 t means double-clicks have no time limit and are detected\n\
5370 by position only.");
5371 Vdouble_click_time
= make_number (500);
5373 DEFVAR_INT ("num-input-keys", &num_input_keys
,
5374 "*Number of complete keys read from the keyboard so far.");
5378 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
5379 "*The frame in which the most recently read event occurred.\n\
5380 If the last event came from a keyboard macro, this is set to `macro'.");
5381 Vlast_event_frame
= Qnil
;
5384 DEFVAR_LISP ("help-char", &Vhelp_char
,
5385 "Character to recognize as meaning Help.\n\
5386 When it is read, do `(eval help-form)', and display result if it's a string.\n\
5387 If the value of `help-form' is nil, this char can be read normally.");
5388 XSET (Vhelp_char
, Lisp_Int
, Ctl ('H'));
5390 DEFVAR_LISP ("help-form", &Vhelp_form
,
5391 "Form to execute when character `help-char' is read.\n\
5392 If the form returns a string, that string is displayed.\n\
5393 If `help-form' is nil, the help char is not recognized.");
5396 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
5397 "Command to run when `help-char' character follows a prefix key.\n\
5398 This command is used only when there is no actual binding\n\
5399 for that character after that prefix key.");
5400 Vprefix_help_command
= Qnil
;
5402 DEFVAR_LISP ("top-level", &Vtop_level
,
5403 "Form to evaluate when Emacs starts up.\n\
5404 Useful to set before you dump a modified Emacs.");
5407 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
5408 "String used as translate table for keyboard input, or nil.\n\
5409 Each character is looked up in this string and the contents used instead.\n\
5410 If string is of length N, character codes N and up are untranslated.");
5411 Vkeyboard_translate_table
= Qnil
;
5413 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
5414 "Keymap of key translations that can override keymaps.\n\
5415 This keymap works like `function-key-map', but comes after that,\n\
5416 and applies even for keys that have ordinary bindings.");
5417 Vkey_translation_map
= Qnil
;
5419 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
5420 "Non-nil means prompt with menus when appropriate.\n\
5421 This is done when reading from a keymap that has a prompt string,\n\
5422 for elements that have prompt strings.\n\
5423 The menu is displayed on the screen\n\
5424 if X menus were enabled at configuration\n\
5425 time and the previous event was a mouse click prefix key.\n\
5426 Otherwise, menu prompting uses the echo area.");
5429 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
5430 "Character to see next line of menu prompt.\n\
5431 Type this character while in a menu prompt to rotate around the lines of it.");
5432 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
5434 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
5435 "A mask of additional modifier keys to use with every keyboard character.\n\
5436 Emacs applies the modifiers of the character stored here to each keyboard\n\
5437 character it reads. For example, after evaluating the expression\n\
5438 (setq extra-keyboard-modifiers ?\C-x)\n\
5439 all input characters will have the control modifier applied to them.\n\
5441 Note that the character ?\C-@, equivalent to the integer zero, does\n\
5442 not count as a control character; rather, it counts as a character\n\
5443 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
5444 cancels any modification.");
5445 extra_keyboard_modifiers
= 0;
5447 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
5448 "If an editing command sets this to t, deactivate the mark afterward.\n\
5449 The command loop sets this to nil before each command,\n\
5450 and tests the value when the command returns.\n\
5451 Buffer modification stores t in this variable.");
5452 Vdeactivate_mark
= Qnil
;
5454 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
5455 "Normal hook run before each command is executed.");
5456 Vpre_command_hook
= Qnil
;
5458 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
5459 "Normal hook run after each command is executed.");
5460 Vpost_command_hook
= Qnil
;
5462 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
5463 "t means menu bar, specified Lucid style, needs to be recomputed.");
5464 Vlucid_menu_bar_dirty_flag
= Qnil
;
5466 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
5467 "List of menu bar items to move to the end of the menu bar.\n\
5468 The elements of the list are event types that may have menu bar bindings.");
5469 Vmenu_bar_final_items
= Qnil
;
5474 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
5475 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
5476 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
5477 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
5478 initial_define_key (meta_map
, 'x', "execute-extended-command");