1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
20 /* Allow config.h to undefine symbols found here. */
29 #include "termhooks.h"
36 #include "dispextern.h"
38 #include "intervals.h"
39 #include "blockinput.h"
44 #include <sys/ioctl.h>
47 #include "syssignal.h"
53 /* Variables for blockinput.h: */
55 /* Non-zero if interrupt input is blocked right now. */
56 int interrupt_input_blocked
;
58 /* Nonzero means an input interrupt has arrived
59 during the current critical section. */
60 int interrupt_input_pending
;
64 extern Lisp_Object Vmouse_grabbed
;
66 /* Make all keyboard buffers much bigger when using X windows. */
67 #define KBD_BUFFER_SIZE 4096
68 #else /* No X-windows, character input */
69 #define KBD_BUFFER_SIZE 256
70 #endif /* No X-windows */
72 /* Following definition copied from eval.c */
76 struct backtrace
*next
;
77 Lisp_Object
*function
;
78 Lisp_Object
*args
; /* Points to vector of args. */
79 int nargs
; /* length of vector. If nargs is UNEVALLED,
80 args points to slot holding list of
85 /* Non-nil disable property on a command means
86 do not execute it; call disabled-command-hook's value instead. */
87 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
89 #define NUM_RECENT_KEYS (100)
90 int recent_keys_index
; /* Index for storing next element into recent_keys */
91 int total_keys
; /* Total number of elements stored into recent_keys */
92 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
94 /* Vector holding the key sequence that invoked the current command.
95 It is reused for each command, and it may be longer than the current
96 sequence; this_command_key_count indicates how many elements
97 actually mean something.
98 It's easier to staticpro a single Lisp_Object than an array. */
99 Lisp_Object this_command_keys
;
100 int this_command_key_count
;
102 extern int minbuf_level
;
104 extern struct backtrace
*backtrace_list
;
106 /* Nonzero means do menu prompting. */
107 static int menu_prompting
;
109 /* Character to see next line of menu prompt. */
110 static Lisp_Object menu_prompt_more_char
;
112 /* For longjmp to where kbd input is being done. */
113 static jmp_buf getcjmp
;
115 /* True while doing kbd input. */
116 int waiting_for_input
;
118 /* True while displaying for echoing. Delays C-g throwing. */
121 /* Nonzero means C-G should cause immediate error-signal. */
124 /* Character to recognize as the help char. */
125 Lisp_Object Vhelp_char
;
127 /* Form to execute when help char is typed. */
128 Lisp_Object Vhelp_form
;
130 /* Command to run when the help character follows a prefix key. */
131 Lisp_Object Vprefix_help_command
;
133 /* List of items that should move to the end of the menu bar. */
134 Lisp_Object Vmenu_bar_final_items
;
136 /* Character that causes a quit. Normally C-g.
138 If we are running on an ordinary terminal, this must be an ordinary
139 ASCII char, since we want to make it our interrupt character.
141 If we are not running on an ordinary terminal, it still needs to be
142 an ordinary ASCII char. This character needs to be recognized in
143 the input interrupt handler. At this point, the keystroke is
144 represented as a struct input_event, while the desired quit
145 character is specified as a lispy event. The mapping from struct
146 input_events to lispy events cannot run in an interrupt handler,
147 and the reverse mapping is difficult for anything but ASCII
150 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
154 extern Lisp_Object current_global_map
;
155 extern int minibuf_level
;
157 /* Current depth in recursive edits. */
158 int command_loop_level
;
160 /* Total number of times command_loop has read a key sequence. */
163 /* Last input character read as a command. */
164 Lisp_Object last_command_char
;
166 /* Last input character read as a command, not counting menus
167 reached by the mouse. */
168 Lisp_Object last_nonmenu_event
;
170 /* Last input character read for any purpose. */
171 Lisp_Object last_input_char
;
173 /* If not Qnil, a list of objects to be read as subsequent command input. */
174 Lisp_Object unread_command_events
;
176 /* If not -1, an event to be read as subsequent command input. */
177 int unread_command_char
;
179 /* If not Qnil, this is a switch-frame event which we decided to put
180 off until the end of a key sequence. This should be read as the
181 next command input, after any unread_command_events.
183 read_key_sequence uses this to delay switch-frame events until the
184 end of the key sequence; Fread_char uses it to put off switch-frame
185 events until a non-ASCII event is acceptable as input. */
186 Lisp_Object unread_switch_frame
;
188 /* A mask of extra modifier bits to put into every keyboard char. */
189 int extra_keyboard_modifiers
;
191 /* Char to use as prefix when a meta character is typed in.
192 This is bound on entry to minibuffer in case ESC is changed there. */
194 Lisp_Object meta_prefix_char
;
196 /* Last size recorded for a current buffer which is not a minibuffer. */
197 static int last_non_minibuf_size
;
199 /* Number of idle seconds before an auto-save and garbage collection. */
200 static Lisp_Object Vauto_save_timeout
;
202 /* Total number of times read_char has returned. */
205 /* Total number of times read_char has returned, outside of macros. */
206 int num_nonmacro_input_chars
;
208 /* Auto-save automatically when this many characters have been typed
209 since the last time. */
211 static int auto_save_interval
;
213 /* Value of num_nonmacro_input_chars as of last auto save. */
217 /* Last command executed by the editor command loop, not counting
218 commands that set the prefix argument. */
220 Lisp_Object last_command
;
222 /* The command being executed by the command loop.
223 Commands may set this, and the value set will be copied into last_command
224 instead of the actual command. */
225 Lisp_Object this_command
;
228 /* The frame in which the last input event occurred, or Qmacro if the
229 last event came from a macro. We use this to determine when to
230 generate switch-frame events. This may be cleared by functions
231 like Fselect_frame, to make sure that a switch-frame event is
232 generated by the next character. */
233 Lisp_Object internal_last_event_frame
;
235 /* A user-visible version of the above, intended to allow users to
236 figure out where the last event came from, if the event doesn't
237 carry that information itself (i.e. if it was a character). */
238 Lisp_Object Vlast_event_frame
;
241 /* The timestamp of the last input event we received from the X server.
242 X Windows wants this for selection ownership. */
243 unsigned long last_event_timestamp
;
245 Lisp_Object Qself_insert_command
;
246 Lisp_Object Qforward_char
;
247 Lisp_Object Qbackward_char
;
248 Lisp_Object Qundefined
;
250 /* read_key_sequence stores here the command definition of the
251 key sequence that it reads. */
252 Lisp_Object read_key_sequence_cmd
;
254 /* Form to evaluate (if non-nil) when Emacs is started. */
255 Lisp_Object Vtop_level
;
257 /* User-supplied string to translate input characters through. */
258 Lisp_Object Vkeyboard_translate_table
;
260 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
261 extern Lisp_Object Vfunction_key_map
;
263 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
264 Lisp_Object Vkey_translation_map
;
266 /* Non-nil means deactivate the mark at end of this command. */
267 Lisp_Object Vdeactivate_mark
;
269 /* Menu bar specified in Lucid Emacs fashion. */
271 Lisp_Object Vlucid_menu_bar_dirty_flag
;
272 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
274 /* Hooks to run before and after each command. */
275 Lisp_Object Qpre_command_hook
, Qpost_command_hook
;
276 Lisp_Object Vpre_command_hook
, Vpost_command_hook
;
278 /* File in which we write all commands we read. */
281 /* Nonzero if input is available. */
284 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
285 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
289 extern char *pending_malloc_warning
;
291 /* Circular buffer for pre-read keyboard input. */
292 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
294 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
296 The interrupt-level event handlers will never enqueue an event on a
297 frame which is not in Vframe_list, and once an event is dequeued,
298 internal_last_event_frame or the event itself points to the frame.
301 But while the event is sitting in the queue, it's completely
302 unprotected. Suppose the user types one command which will run for
303 a while and then delete a frame, and then types another event at
304 the frame that will be deleted, before the command gets around to
305 it. Suppose there are no references to this frame elsewhere in
306 Emacs, and a GC occurs before the second event is dequeued. Now we
307 have an event referring to a freed frame, which will crash Emacs
310 Similar things happen when an event on a scroll bar is enqueued; the
311 window may be deleted while the event is in the queue.
313 So, we use this vector to protect the frame_or_window field in the
314 event queue. That way, they'll be dequeued as dead frames or
315 windows, but still valid lisp objects.
317 If kbd_buffer[i].kind != no_event, then
318 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
319 == kbd_buffer[i].frame_or_window. */
320 static Lisp_Object kbd_buffer_frame_or_window
;
322 /* Pointer to next available character in kbd_buffer.
323 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
324 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
325 next available char is in kbd_buffer[0]. */
326 static struct input_event
*kbd_fetch_ptr
;
328 /* Pointer to next place to store character in kbd_buffer. This
329 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
330 character should go in kbd_buffer[0]. */
334 static struct input_event
*kbd_store_ptr
;
336 /* The above pair of variables forms a "queue empty" flag. When we
337 enqueue a non-hook event, we increment kbd_write_count. When we
338 dequeue a non-hook event, we increment kbd_read_count. We say that
339 there is input available iff the two counters are not equal.
341 Why not just have a flag set and cleared by the enqueuing and
342 dequeuing functions? Such a flag could be screwed up by interrupts
343 at inopportune times. */
345 /* If this flag is non-zero, we check mouse_moved to see when the
346 mouse moves, and motion events will appear in the input stream. If
347 it is zero, mouse motion is ignored. */
348 static int do_mouse_tracking
;
350 /* The window system handling code should set this if the mouse has
351 moved since the last call to the mouse_position_hook. Calling that
352 hook should clear this. Code assumes that if this is set, it can
353 call mouse_position_hook to get the promised position, so don't set
354 it unless you're prepared to substantiate the claim! */
357 /* True iff there is an event in kbd_buffer, or if mouse tracking is
358 enabled and there is a new mouse position in the mouse movement
359 buffer. Note that if this is false, that doesn't mean that there
360 is readable input; all the events in the queue might be button-up
361 events, and do_mouse_tracking might be off. */
362 #define EVENT_QUEUES_EMPTY \
363 ((kbd_fetch_ptr == kbd_store_ptr) && (!do_mouse_tracking || !mouse_moved))
366 /* Symbols to head events. */
367 Lisp_Object Qmouse_movement
;
368 Lisp_Object Qscroll_bar_movement
;
369 Lisp_Object Qswitch_frame
;
371 /* Symbols to denote kinds of events. */
372 Lisp_Object Qfunction_key
;
373 Lisp_Object Qmouse_click
;
374 /* Lisp_Object Qmouse_movement; - also an event header */
376 /* Properties of event headers. */
377 Lisp_Object Qevent_kind
;
378 Lisp_Object Qevent_symbol_elements
;
380 Lisp_Object Qmenu_enable
;
382 /* An event header symbol HEAD may have a property named
383 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
384 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
385 mask of modifiers applied to it. If present, this is used to help
386 speed up parse_modifiers. */
387 Lisp_Object Qevent_symbol_element_mask
;
389 /* An unmodified event header BASE may have a property named
390 Qmodifier_cache, which is an alist mapping modifier masks onto
391 modified versions of BASE. If present, this helps speed up
393 Lisp_Object Qmodifier_cache
;
395 /* Symbols to use for parts of windows. */
396 Lisp_Object Qmode_line
;
397 Lisp_Object Qvertical_line
;
398 Lisp_Object Qvertical_scroll_bar
;
399 Lisp_Object Qmenu_bar
;
401 extern Lisp_Object Qmenu_enable
;
403 Lisp_Object
recursive_edit_unwind (), command_loop ();
404 Lisp_Object
Fthis_command_keys ();
405 Lisp_Object Qextended_command_history
;
407 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
409 EMACS_TIME
*input_available_clear_time
;
411 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
412 Default is 1 if INTERRUPT_INPUT is defined. */
415 /* Nonzero while interrupts are temporarily deferred during redisplay. */
416 int interrupts_deferred
;
418 /* nonzero means use ^S/^Q for flow control. */
421 /* Allow m- file to inhibit use of FIONREAD. */
422 #ifdef BROKEN_FIONREAD
426 /* We are unable to use interrupts if FIONREAD is not available,
427 so flush SIGIO so we won't try. */
434 /* If we support X Windows, turn on the code to poll periodically
435 to detect C-g. It isn't actually used when doing interrupt input. */
436 #ifdef HAVE_X_WINDOWS
437 #define POLL_FOR_INPUT
440 /* Global variable declarations. */
442 /* Function for init_keyboard to call with no args (if nonzero). */
443 void (*keyboard_init_hook
) ();
445 static int read_avail_input ();
446 static void get_input_pending ();
447 static int readable_events ();
448 static Lisp_Object
read_char_menu_prompt ();
449 static Lisp_Object
make_lispy_event ();
450 static Lisp_Object
make_lispy_movement ();
451 static Lisp_Object
modify_event_symbol ();
452 static Lisp_Object
make_lispy_switch_frame ();
454 /* > 0 if we are to echo keystrokes. */
455 static int echo_keystrokes
;
457 /* Nonzero means echo each character as typed. */
458 static int immediate_echo
;
460 /* The text we're echoing in the modeline - partial key sequences,
461 usually. '\0'-terminated. This really shouldn't have a fixed size. */
462 static char echobuf
[300];
464 /* Where to append more text to echobuf if we want to. */
465 static char *echoptr
;
467 #define min(a,b) ((a)<(b)?(a):(b))
468 #define max(a,b) ((a)>(b)?(a):(b))
470 /* Install the string STR as the beginning of the string of echoing,
471 so that it serves as a prompt for the next character.
472 Also start echoing. */
477 int len
= strlen (str
);
478 if (len
> sizeof echobuf
- 4)
479 len
= sizeof echobuf
- 4;
480 bcopy (str
, echobuf
, len
);
481 echoptr
= echobuf
+ len
;
487 /* Add C to the echo string, if echoing is going on.
488 C can be a character, which is printed prettily ("M-C-x" and all that
489 jazz), or a symbol, whose name is printed. */
494 extern char *push_key_description ();
503 /* If someone has passed us a composite event, use its head symbol. */
506 if (XTYPE (c
) == Lisp_Int
)
508 if (ptr
- echobuf
> sizeof echobuf
- 6)
511 ptr
= push_key_description (XINT (c
), ptr
);
513 else if (XTYPE (c
) == Lisp_Symbol
)
515 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
516 if (((ptr
- echobuf
) + name
->size
+ 4) > sizeof echobuf
)
518 bcopy (name
->data
, ptr
, name
->size
);
522 if (echoptr
== echobuf
&& EQ (c
, Vhelp_char
))
524 strcpy (ptr
, " (Type ? for further options)");
535 /* Temporarily add a dash to the end of the echo string if it's not
536 empty, so that it serves as a mini-prompt for the very next character. */
540 if (!immediate_echo
&& echoptr
== echobuf
)
542 /* Do nothing if not echoing at all. */
546 /* Put a dash at the end of the buffer temporarily,
547 but make it go away when the next character is added. */
554 /* Display the current echo string, and begin echoing if not already
564 for (i
= 0; i
< this_command_key_count
; i
++)
565 echo_char (XVECTOR (this_command_keys
)->contents
[i
]);
573 if (waiting_for_input
&& !NILP (Vquit_flag
))
574 quit_throw_to_read_char ();
577 /* Turn off echoing, for the start of a new command. */
585 /* Return the length of the current echo string. */
590 return echoptr
- echobuf
;
593 /* Truncate the current echo message to its first LEN chars.
594 This and echo_char get used by read_key_sequence when the user
595 switches frames while entering a key sequence. */
602 echoptr
= echobuf
+ len
;
606 /* Functions for manipulating this_command_keys. */
608 add_command_key (key
)
611 int size
= XVECTOR (this_command_keys
)->size
;
613 if (this_command_key_count
>= size
)
615 Lisp_Object new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
617 bcopy (XVECTOR (this_command_keys
)->contents
,
618 XVECTOR (new_keys
)->contents
,
619 size
* sizeof (Lisp_Object
));
621 this_command_keys
= new_keys
;
624 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
630 int count
= specpdl_ptr
- specpdl
;
633 if (command_loop_level
> 0)
635 specbind (Qstandard_output
, Qt
);
636 specbind (Qstandard_input
, Qt
);
639 val
= command_loop ();
641 Fsignal (Qquit
, Qnil
);
643 return unbind_to (count
, Qnil
);
646 /* When an auto-save happens, record the "time", and don't do again soon. */
649 last_auto_save
= num_nonmacro_input_chars
;
652 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
653 "Invoke the editor command loop recursively.\n\
654 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
655 that tells this function to return.\n\
656 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
657 This function is called by the editor initialization to begin editing.")
660 int count
= specpdl_ptr
- specpdl
;
663 command_loop_level
++;
664 update_mode_lines
= 1;
666 record_unwind_protect (recursive_edit_unwind
,
668 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
672 return unbind_to (count
, Qnil
);
676 recursive_edit_unwind (buffer
)
680 Fset_buffer (buffer
);
682 command_loop_level
--;
683 update_mode_lines
= 1;
691 Lisp_Object errmsg
, tail
, errname
, file_error
;
698 Vstandard_output
= Qt
;
699 Vstandard_input
= Qt
;
700 Vexecuting_macro
= Qnil
;
701 echo_area_glyphs
= 0;
703 /* If the window system or terminal frame hasn't been initialized
704 yet, or we're not interactive, it's best to dump this message out
705 to stderr and exit. */
706 if (! FRAME_MESSAGE_BUF (selected_frame
)
708 stream
= Qexternal_debugging_output
;
716 errname
= Fcar (data
);
718 if (EQ (errname
, Qerror
))
721 if (!CONSP (data
)) data
= Qnil
;
722 errmsg
= Fcar (data
);
727 errmsg
= Fget (errname
, Qerror_message
);
728 file_error
= Fmemq (Qfile_error
,
729 Fget (errname
, Qerror_conditions
));
732 /* Print an error message including the data items.
733 This is done by printing it into a scratch buffer
734 and then making a copy of the text in the buffer. */
736 if (!CONSP (data
)) data
= Qnil
;
740 /* For file-error, make error message by concatenating
741 all the data items. They are all strings. */
742 if (!NILP (file_error
) && !NILP (tail
))
743 errmsg
= XCONS (tail
)->car
, tail
= XCONS (tail
)->cdr
;
745 if (XTYPE (errmsg
) == Lisp_String
)
746 Fprinc (errmsg
, stream
);
748 write_string_1 ("peculiar error", -1, stream
);
750 for (i
= 0; CONSP (tail
); tail
= Fcdr (tail
), i
++)
752 write_string_1 (i
? ", " : ": ", 2, stream
);
753 if (!NILP (file_error
))
754 Fprinc (Fcar (tail
), stream
);
756 Fprin1 (Fcar (tail
), stream
);
760 /* If the window system or terminal frame hasn't been initialized
761 yet, or we're in -batch mode, this error should cause Emacs to exit. */
762 if (! FRAME_MESSAGE_BUF (selected_frame
)
766 Fkill_emacs (make_number (-1));
771 Vinhibit_quit
= Qnil
;
772 return make_number (0);
775 Lisp_Object
command_loop_1 ();
776 Lisp_Object
command_loop_2 ();
777 Lisp_Object
top_level_1 ();
779 /* Entry to editor-command-loop.
780 This level has the catches for exiting/returning to editor command loop.
781 It returns nil to exit recursive edit, t to abort it. */
786 if (command_loop_level
> 0 || minibuf_level
> 0)
788 return internal_catch (Qexit
, command_loop_2
, Qnil
);
793 internal_catch (Qtop_level
, top_level_1
, Qnil
);
794 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
796 /* End of file in -batch run causes exit here. */
802 /* Here we catch errors in execution of commands within the
803 editing loop, and reenter the editing loop.
804 When there is an error, cmd_error runs and returns a non-nil
805 value to us. A value of nil means that cmd_loop_1 itself
806 returned due to end of file (or end of kbd macro). */
811 register Lisp_Object val
;
814 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
823 return Feval (Vtop_level
);
829 /* On entry to the outer level, run the startup file */
830 if (!NILP (Vtop_level
))
831 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
832 else if (!NILP (Vpurify_flag
))
833 message ("Bare impure Emacs (standard Lisp code not loaded)");
835 message ("Bare Emacs (standard Lisp code not loaded)");
839 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
840 "Exit all recursive editing levels.")
843 Fthrow (Qtop_level
, Qnil
);
846 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
847 "Exit from the innermost recursive edit or minibuffer.")
850 if (command_loop_level
> 0 || minibuf_level
> 0)
851 Fthrow (Qexit
, Qnil
);
853 error ("No recursive edit is in progress");
856 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
857 "Abort the command that requested this recursive edit or minibuffer input.")
860 if (command_loop_level
> 0 || minibuf_level
> 0)
863 error ("No recursive edit is in progress");
866 /* This is the actual command reading loop,
867 sans error-handling encapsulation. */
869 Lisp_Object
Fcommand_execute ();
870 static int read_key_sequence ();
875 Lisp_Object cmd
, tem
;
878 Lisp_Object keybuf
[30];
883 struct buffer
*prev_buffer
;
886 Vdeactivate_mark
= Qnil
;
887 waiting_for_input
= 0;
890 /* Don't clear out last_command at the beginning of a macro. */
891 if (XTYPE (Vexecuting_macro
) != Lisp_String
)
896 this_command_key_count
= 0;
898 /* Make sure this hook runs after commands that get errors and
899 throw to top level. */
900 if (!NILP (Vpost_command_hook
))
901 call1 (Vrun_hooks
, Qpost_command_hook
);
905 /* Install chars successfully executed in kbd macro. */
907 if (defining_kbd_macro
&& NILP (Vprefix_arg
))
908 finalize_kbd_macro_chars ();
910 /* Make sure the current window's buffer is selected. */
911 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
912 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
914 /* Display any malloc warning that just came out. Use while because
915 displaying one warning can cause another. */
917 while (pending_malloc_warning
)
918 display_malloc_warning ();
922 Vdeactivate_mark
= Qnil
;
924 /* If minibuffer on and echo area in use,
925 wait 2 sec and redraw minibuffer. */
927 if (minibuf_level
&& echo_area_glyphs
)
929 /* Bind inhibit-quit to t so that C-g gets read in
930 rather than quitting back to the minibuffer. */
931 int count
= specpdl_ptr
- specpdl
;
932 specbind (Qinhibit_quit
, Qt
);
933 Fsit_for (make_number (2), Qnil
, Qnil
);
934 unbind_to (count
, Qnil
);
936 echo_area_glyphs
= 0;
938 if (!NILP (Vquit_flag
))
941 unread_command_events
= Fcons (make_number (quit_char
), Qnil
);
946 alloca (0); /* Cause a garbage collection now */
947 /* Since we can free the most stuff here. */
948 #endif /* C_ALLOCA */
952 /* Select the frame that the last event came from. Usually,
953 switch-frame events will take care of this, but if some lisp
954 code swallows a switch-frame event, we'll fix things up here.
955 Is this a good idea? */
956 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
957 && XFRAME (internal_last_event_frame
) != selected_frame
)
958 Fselect_frame (internal_last_event_frame
, Qnil
);
961 /* If it has changed current-menubar from previous value,
962 really recompute the menubar from the value. */
963 if (! NILP (Vlucid_menu_bar_dirty_flag
)
964 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
965 call0 (Qrecompute_lucid_menubar
);
967 #if 0 /* This is done in xdisp.c now. */
969 for (tem
= Vframe_list
; CONSP (tem
); tem
= XCONS (tem
)->cdr
)
971 struct frame
*f
= XFRAME (XCONS (tem
)->car
);
972 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
974 /* If the user has switched buffers or windows, we need to
975 recompute to reflect the new bindings. But we'll
976 recompute when update_mode_lines is set too; that means
977 that people can use force-mode-line-update to request
978 that the menu bar be recomputed. The adverse effect on
979 the rest of the redisplay algorithm is about the same as
980 windows_or_buffers_changed anyway. */
981 if (windows_or_buffers_changed
983 || (XFASTINT (w
->last_modified
) < MODIFF
984 && (XFASTINT (w
->last_modified
)
985 <= XBUFFER (w
->buffer
)->save_modified
)))
987 struct buffer
*prev
= current_buffer
;
988 current_buffer
= XBUFFER (w
->buffer
);
989 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items ();
990 current_buffer
= prev
;
993 #endif /* MULTI_FRAME */
996 /* Read next key sequence; i gets its length. */
997 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), Qnil
);
1001 /* Now we have read a key sequence of length I,
1002 or else I is 0 and we found end of file. */
1004 if (i
== 0) /* End of file -- happens only in */
1005 return Qnil
; /* a kbd macro, at the end. */
1006 /* -1 means read_key_sequence got a menu that was rejected.
1007 Just loop around and read another command. */
1011 this_command_key_count
= 0;
1015 last_command_char
= keybuf
[i
- 1];
1017 /* If the previous command tried to force a specific window-start,
1018 forget about that, in case this command moves point far away
1019 from that position. */
1020 XWINDOW (selected_window
)->force_start
= Qnil
;
1022 cmd
= read_key_sequence_cmd
;
1023 if (!NILP (Vexecuting_macro
))
1025 if (!NILP (Vquit_flag
))
1027 Vexecuting_macro
= Qt
;
1028 QUIT
; /* Make some noise. */
1029 /* Will return since macro now empty. */
1033 /* Do redisplay processing after this command except in special
1034 cases identified below that set no_redisplay to 1. */
1037 prev_buffer
= current_buffer
;
1038 prev_modiff
= MODIFF
;
1040 /* Execute the command. */
1043 if (!NILP (Vpre_command_hook
))
1044 call1 (Vrun_hooks
, Qpre_command_hook
);
1046 if (NILP (this_command
))
1048 /* nil means key is undefined. */
1050 defining_kbd_macro
= 0;
1051 update_mode_lines
= 1;
1057 if (NILP (Vprefix_arg
) && ! no_direct
)
1059 /* Recognize some common commands in common situations and
1060 do them directly. */
1061 if (EQ (this_command
, Qforward_char
) && point
< ZV
)
1063 struct Lisp_Vector
*dp
1064 = window_display_table (XWINDOW (selected_window
));
1065 lose
= FETCH_CHAR (point
);
1068 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1069 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1070 : (lose
>= 0x20 && lose
< 0x7f))
1071 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1073 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1075 && !windows_or_buffers_changed
1076 && EQ (current_buffer
->selective_display
, Qnil
)
1077 && !detect_input_pending ()
1078 && NILP (Vexecuting_macro
))
1079 no_redisplay
= direct_output_forward_char (1);
1082 else if (EQ (this_command
, Qbackward_char
) && point
> BEGV
)
1084 struct Lisp_Vector
*dp
1085 = window_display_table (XWINDOW (selected_window
));
1087 lose
= FETCH_CHAR (point
);
1089 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1090 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1091 : (lose
>= 0x20 && lose
< 0x7f))
1092 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1094 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1096 && !windows_or_buffers_changed
1097 && EQ (current_buffer
->selective_display
, Qnil
)
1098 && !detect_input_pending ()
1099 && NILP (Vexecuting_macro
))
1100 no_redisplay
= direct_output_forward_char (-1);
1103 else if (EQ (this_command
, Qself_insert_command
)
1104 /* Try this optimization only on ascii keystrokes. */
1105 && XTYPE (last_command_char
) == Lisp_Int
)
1107 unsigned char c
= XINT (last_command_char
);
1109 if (NILP (Vexecuting_macro
) &&
1110 !EQ (minibuf_window
, selected_window
))
1112 if (!nonundocount
|| nonundocount
>= 20)
1119 lose
= (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1121 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1123 || MODIFF
<= current_buffer
->save_modified
1124 || windows_or_buffers_changed
1125 || !EQ (current_buffer
->selective_display
, Qnil
)
1126 || detect_input_pending ()
1127 || !NILP (Vexecuting_macro
);
1128 if (internal_self_insert (c
, 0))
1134 (point
== ZV
|| FETCH_CHAR (point
) == '\n'))
1136 struct Lisp_Vector
*dp
1137 = window_display_table (XWINDOW (selected_window
));
1142 Lisp_Object obj
= DISP_CHAR_VECTOR (dp
, lose
);
1144 if (XTYPE (obj
) == Lisp_Vector
1145 && XVECTOR (obj
)->size
== 1
1146 && (XTYPE (obj
= XVECTOR (obj
)->contents
[0])
1149 direct_output_for_insert (XINT (obj
));
1153 if (lose
>= 0x20 && lose
<= 0x7e)
1154 no_redisplay
= direct_output_for_insert (lose
);
1161 /* Here for a command that isn't executed directly */
1164 if (NILP (Vprefix_arg
))
1166 Fcommand_execute (this_command
, Qnil
);
1171 if (!NILP (Vpost_command_hook
))
1172 call1 (Vrun_hooks
, Qpost_command_hook
);
1174 /* If there is a prefix argument,
1175 1) We don't want last_command to be ``universal-argument''
1176 (that would be dumb), so don't set last_command,
1177 2) we want to leave echoing on so that the prefix will be
1178 echoed as part of this key sequence, so don't call
1180 3) we want to leave this_command_key_count non-zero, so that
1181 read_char will realize that it is re-reading a character, and
1182 not echo it a second time. */
1183 if (NILP (Vprefix_arg
))
1185 last_command
= this_command
;
1187 this_command_key_count
= 0;
1190 if (!NILP (current_buffer
->mark_active
))
1192 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1194 current_buffer
->mark_active
= Qnil
;
1195 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1197 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1198 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1203 /* Number of seconds between polling for input. */
1206 /* Nonzero means polling for input is temporarily suppressed. */
1207 int poll_suppress_count
;
1209 #ifdef POLL_FOR_INPUT
1210 int polling_for_input
;
1212 /* Handle an alarm once each second and read pending input
1213 so as to handle a C-g if it comces in. */
1216 input_poll_signal ()
1218 if (interrupt_input_blocked
== 0
1219 && !waiting_for_input
)
1220 read_avail_input (0);
1221 signal (SIGALRM
, input_poll_signal
);
1222 alarm (polling_period
);
1227 /* Begin signals to poll for input, if they are appropriate.
1228 This function is called unconditionally from various places. */
1232 #ifdef POLL_FOR_INPUT
1233 if (read_socket_hook
&& !interrupt_input
)
1235 poll_suppress_count
--;
1236 if (poll_suppress_count
== 0)
1238 signal (SIGALRM
, input_poll_signal
);
1239 polling_for_input
= 1;
1240 alarm (polling_period
);
1246 /* Turn off polling. */
1250 #ifdef POLL_FOR_INPUT
1251 if (read_socket_hook
&& !interrupt_input
)
1253 if (poll_suppress_count
== 0)
1255 polling_for_input
= 0;
1258 poll_suppress_count
++;
1263 /* Set the value of poll_suppress_count to COUNT
1264 and start or stop polling accordingly. */
1267 set_poll_suppress_count (count
)
1270 #ifdef POLL_FOR_INPUT
1271 if (count
== 0 && poll_suppress_count
!= 0)
1273 poll_suppress_count
= 1;
1276 else if (count
!= 0 && poll_suppress_count
== 0)
1280 poll_suppress_count
= count
;
1284 /* Applying the control modifier to CHARACTER. */
1289 /* Save the upper bits here. */
1290 int upper
= c
& ~0177;
1294 /* Everything in the columns containing the upper-case letters
1295 denotes a control character. */
1296 if (c
>= 0100 && c
< 0140)
1300 /* Set the shift modifier for a control char
1301 made from a shifted letter. But only for letters! */
1302 if (oc
>= 'A' && oc
<= 'Z')
1303 c
|= shift_modifier
;
1306 /* The lower-case letters denote control characters too. */
1307 else if (c
>= 'a' && c
<= 'z')
1310 /* Include the bits for control and shift
1311 only if the basic ASCII code can't indicate them. */
1315 /* Replace the high bits. */
1316 c
|= (upper
& ~ctrl_modifier
);
1323 /* Input of single characters from keyboard */
1325 Lisp_Object
print_help ();
1326 static Lisp_Object
kbd_buffer_get_event ();
1328 /* read a character from the keyboard; call the redisplay if needed */
1329 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1330 -1 means do not do redisplay, but do do autosaving.
1333 /* The arguments MAPS and NMAPS are for menu prompting.
1334 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1336 PREV_EVENT is the previous input event, or nil if we are reading
1337 the first event of a key sequence.
1339 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1340 if we used a mouse menu to read the input, or zero otherwise. If
1341 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
1343 Value is t if we showed a menu and the user rejected it. */
1346 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1350 Lisp_Object prev_event
;
1351 int *used_mouse_menu
;
1353 register Lisp_Object c
;
1357 if (CONSP (unread_command_events
))
1359 c
= XCONS (unread_command_events
)->car
;
1360 unread_command_events
= XCONS (unread_command_events
)->cdr
;
1362 if (this_command_key_count
== 0)
1368 if (unread_command_char
!= -1)
1370 XSET (c
, Lisp_Int
, unread_command_char
);
1371 unread_command_char
= -1;
1373 if (this_command_key_count
== 0)
1379 if (!NILP (Vexecuting_macro
))
1382 /* We set this to Qmacro; since that's not a frame, nobody will
1383 try to switch frames on us, and the selected window will
1386 Since this event came from a macro, it would be misleading to
1387 leave internal_last_event_frame set to wherever the last
1388 real event came from. Normally, a switch-frame event selects
1389 internal_last_event_frame after each command is read, but
1390 events read from a macro should never cause a new frame to be
1392 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1395 /* Exit the macro if we are at the end.
1396 Also, some things replace the macro with t
1397 to force an early exit. */
1398 if (EQ (Vexecuting_macro
, Qt
)
1399 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1401 XSET (c
, Lisp_Int
, -1);
1405 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1406 if (XTYPE (Vexecuting_macro
) == Lisp_String
1407 && (XINT (c
) & 0x80))
1408 XFASTINT (c
) = CHAR_META
| (XINT (c
) & ~0x80);
1410 executing_macro_index
++;
1415 if (!NILP (unread_switch_frame
))
1417 c
= unread_switch_frame
;
1418 unread_switch_frame
= Qnil
;
1420 /* This event should make it into this_command_keys, and get echoed
1421 again, so we go to reread_first, rather than reread. */
1425 /* Save outer setjmp data, in case called recursively. */
1426 save_getcjmp (save_jump
);
1430 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1433 if (_setjmp (getcjmp
))
1435 XSET (c
, Lisp_Int
, quit_char
);
1437 XSET (internal_last_event_frame
, Lisp_Frame
, selected_frame
);
1438 Vlast_event_frame
= internal_last_event_frame
;
1440 /* If we report the quit char as an event,
1441 don't do so more than once. */
1442 if (!NILP (Vinhibit_quit
))
1448 /* Message turns off echoing unless more keystrokes turn it on again. */
1449 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1452 /* If already echoing, continue. */
1455 /* If in middle of key sequence and minibuffer not active,
1456 start echoing if enough time elapses. */
1457 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1459 && echo_keystrokes
> 0
1460 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1464 /* After a mouse event, start echoing right away.
1465 This is because we are probably about to display a menu,
1466 and we don't want to delay before doing so. */
1467 if (EVENT_HAS_PARAMETERS (prev_event
))
1471 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1477 /* Maybe auto save due to number of keystrokes or idle time. */
1479 if (commandflag
!= 0
1480 && auto_save_interval
> 0
1481 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1482 && !detect_input_pending ())
1485 save_getcjmp (temp
);
1486 Fdo_auto_save (Qnil
, Qnil
);
1487 restore_getcjmp (temp
);
1490 /* Try reading a character via menu prompting.
1491 Try this before the sit-for, because the sit-for
1492 would do the wrong thing if we are supposed to do
1495 if (INTERACTIVE
&& !NILP (prev_event
))
1496 c
= read_char_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1498 /* Slow down auto saves logarithmically in size of current buffer,
1499 and garbage collect while we're at it. */
1500 if (INTERACTIVE
&& NILP (c
))
1502 int delay_level
, buffer_size
;
1504 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1505 last_non_minibuf_size
= Z
- BEG
;
1506 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1508 while (buffer_size
> 64)
1509 delay_level
++, buffer_size
-= buffer_size
>> 2;
1510 if (delay_level
< 4) delay_level
= 4;
1511 /* delay_level is 4 for files under around 50k, 7 at 100k,
1512 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1514 /* Auto save if enough time goes by without input. */
1515 if (commandflag
!= 0
1516 && num_nonmacro_input_chars
> last_auto_save
1517 && XTYPE (Vauto_save_timeout
) == Lisp_Int
1518 && XINT (Vauto_save_timeout
) > 0)
1521 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1522 tem0
= sit_for (delay
, 0, 1, 1);
1526 save_getcjmp (temp
);
1527 Fdo_auto_save (Qnil
, Qnil
);
1528 restore_getcjmp (temp
);
1530 /* If we have auto-saved and there is still no input
1531 available, garbage collect if there has been enough
1532 consing going on to make it worthwhile. */
1533 if (!detect_input_pending ()
1534 && consing_since_gc
> gc_cons_threshold
/ 2)
1536 Fgarbage_collect ();
1543 /* Actually read a character, waiting if necessary. */
1546 c
= kbd_buffer_get_event ();
1549 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1553 /* Terminate Emacs in batch mode if at eof. */
1554 if (noninteractive
&& XTYPE (c
) == Lisp_Int
&& XINT (c
) < 0)
1555 Fkill_emacs (make_number (1));
1557 if (XTYPE (c
) == Lisp_Int
)
1559 /* Add in any extra modifiers, where appropriate. */
1560 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1561 || ((extra_keyboard_modifiers
& 0177) < ' '
1562 && (extra_keyboard_modifiers
& 0177) != 0))
1563 XSETINT (c
, make_ctrl_char (XINT (c
)));
1565 /* Transfer any other modifier bits directly from
1566 extra_keyboard_modifiers to c. Ignore the actual character code
1567 in the low 16 bits of extra_keyboard_modifiers. */
1568 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
1573 restore_getcjmp (save_jump
);
1577 echo_area_glyphs
= 0;
1579 /* Handle things that only apply to characters. */
1580 if (XTYPE (c
) == Lisp_Int
)
1582 /* If kbd_buffer_get_event gave us an EOF, return that. */
1586 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
1587 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1588 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1592 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1593 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1594 recent_keys_index
= 0;
1596 /* Write c to the dribble file. If c is a lispy event, write
1597 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1598 If you, dear reader, have a better idea, you've got the source. :-) */
1601 if (XTYPE (c
) == Lisp_Int
)
1602 putc (XINT (c
), dribble
);
1605 Lisp_Object dribblee
= c
;
1607 /* If it's a structured event, take the event header. */
1608 dribblee
= EVENT_HEAD (dribblee
);
1610 if (XTYPE (dribblee
) == Lisp_Symbol
)
1612 putc ('<', dribble
);
1613 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1614 XSYMBOL (dribblee
)->name
->size
,
1616 putc ('>', dribble
);
1623 store_kbd_macro_char (c
);
1625 num_nonmacro_input_chars
++;
1630 /* Record this character as part of the current key.
1631 Don't record mouse motion; it should never matter. */
1632 if (! (EVENT_HAS_PARAMETERS (c
)
1633 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1636 add_command_key (c
);
1639 /* Re-reading in the middle of a command */
1641 last_input_char
= c
;
1644 /* Process the help character specially if enabled */
1645 if (EQ (c
, Vhelp_char
) && !NILP (Vhelp_form
))
1648 count
= specpdl_ptr
- specpdl
;
1650 record_unwind_protect (Fset_window_configuration
,
1651 Fcurrent_window_configuration (Qnil
));
1653 tem0
= Feval (Vhelp_form
);
1654 if (XTYPE (tem0
) == Lisp_String
)
1655 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1658 c
= read_char (0, 0, 0, Qnil
, 0);
1659 /* Remove the help from the frame */
1660 unbind_to (count
, Qnil
);
1662 if (EQ (c
, make_number (040)))
1665 c
= read_char (0, 0, 0, Qnil
, 0);
1676 Fprinc (object
, Qnil
);
1680 /* Copy out or in the info on where C-g should throw to.
1681 This is used when running Lisp code from within get_char,
1682 in case get_char is called recursively.
1683 See read_process_output. */
1688 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1691 restore_getcjmp (temp
)
1694 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1698 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1699 of this function. */
1701 tracking_off (old_value
)
1702 Lisp_Object old_value
;
1704 if (! XFASTINT (old_value
))
1706 do_mouse_tracking
= 0;
1708 /* Redisplay may have been preempted because there was input
1709 available, and it assumes it will be called again after the
1710 input has been processed. If the only input available was
1711 the sort that we have just disabled, then we need to call
1713 if (!readable_events ())
1715 redisplay_preserve_echo_area ();
1716 get_input_pending (&input_pending
);
1721 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1722 "Evaluate BODY with mouse movement events enabled.\n\
1723 Within a `track-mouse' form, mouse motion generates input events that\n\
1724 you can read with `read-event'.\n\
1725 Normally, mouse motion is ignored.")
1729 int count
= specpdl_ptr
- specpdl
;
1732 XSET (val
, Lisp_Int
, do_mouse_tracking
);
1733 record_unwind_protect (tracking_off
, val
);
1735 do_mouse_tracking
= 1;
1737 val
= Fprogn (args
);
1738 return unbind_to (count
, val
);
1741 /* Low level keyboard/mouse input.
1742 kbd_buffer_store_event places events in kbd_buffer, and
1743 kbd_buffer_get_event retrieves them.
1744 mouse_moved indicates when the mouse has moved again, and
1745 *mouse_position_hook provides the mouse position. */
1747 /* Return true iff there are any events in the queue that read-char
1748 would return. If this returns false, a read-char would block. */
1752 return ! EVENT_QUEUES_EMPTY
;
1755 /* Set this for debugging, to have a way to get out */
1758 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
1761 kbd_buffer_store_event (event
)
1762 register struct input_event
*event
;
1764 if (event
->kind
== no_event
)
1767 if (event
->kind
== ascii_keystroke
)
1769 register int c
= XFASTINT (event
->code
) & 0377;
1771 if (event
->modifiers
& ctrl_modifier
)
1772 c
= make_ctrl_char (c
);
1774 c
|= (event
->modifiers
1775 & (meta_modifier
| alt_modifier
1776 | hyper_modifier
| super_modifier
));
1780 extern SIGTYPE
interrupt_signal ();
1783 /* If this results in a quit_char being returned to Emacs as
1784 input, set Vlast_event_frame properly. If this doesn't
1785 get returned to Emacs as an event, the next event read
1786 will set Vlast_event_frame again, so this is safe to do. */
1789 = FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
1792 internal_last_event_frame
= event
->frame_or_window
;
1794 internal_last_event_frame
= focus
;
1795 Vlast_event_frame
= internal_last_event_frame
;
1799 last_event_timestamp
= event
->timestamp
;
1800 interrupt_signal ();
1804 if (c
&& c
== stop_character
)
1811 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
1812 kbd_store_ptr
= kbd_buffer
;
1814 /* Don't let the very last slot in the buffer become full,
1815 since that would make the two pointers equal,
1816 and that is indistinguishable from an empty buffer.
1817 Discard the event if it would fill the last slot. */
1818 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
1820 kbd_store_ptr
->kind
= event
->kind
;
1821 if (event
->kind
== selection_request_event
)
1823 /* We must not use the ordinary copying code for this case,
1824 since `part' is an enum and copying it might not copy enough
1826 bcopy (event
, kbd_store_ptr
, sizeof (*event
));
1830 kbd_store_ptr
->code
= event
->code
;
1831 kbd_store_ptr
->part
= event
->part
;
1832 kbd_store_ptr
->frame_or_window
= event
->frame_or_window
;
1833 kbd_store_ptr
->modifiers
= event
->modifiers
;
1834 kbd_store_ptr
->x
= event
->x
;
1835 kbd_store_ptr
->y
= event
->y
;
1836 kbd_store_ptr
->timestamp
= event
->timestamp
;
1838 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
1840 = event
->frame_or_window
);
1846 /* Read one event from the event buffer, waiting if necessary.
1847 The value is a Lisp object representing the event.
1848 The value is nil for an event that should be ignored,
1849 or that was handled here.
1850 We always read and discard one event. */
1853 kbd_buffer_get_event ()
1861 XSET (obj
, Lisp_Int
, c
);
1865 /* Wait until there is input available. */
1868 if (!EVENT_QUEUES_EMPTY
)
1871 /* If the quit flag is set, then read_char will return
1872 quit_char, so that counts as "available input." */
1873 if (!NILP (Vquit_flag
))
1874 quit_throw_to_read_char ();
1876 /* One way or another, wait until input is available; then, if
1877 interrupt handlers have not read it, read it now. */
1880 wait_for_kbd_input ();
1882 /* Note SIGIO has been undef'd if FIONREAD is missing. */
1886 if (EVENT_QUEUES_EMPTY
)
1888 Lisp_Object minus_one
;
1890 XSET (minus_one
, Lisp_Int
, -1);
1891 wait_reading_process_input (0, 0, minus_one
, 1);
1893 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
1895 read_avail_input (0);
1898 #endif /* not VMS */
1901 /* At this point, we know that there is a readable event available
1902 somewhere. If the event queue is empty, then there must be a
1903 mouse movement enabled and available. */
1904 if (kbd_fetch_ptr
!= kbd_store_ptr
)
1906 struct input_event
*event
;
1908 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
1912 last_event_timestamp
= event
->timestamp
;
1916 /* These two kinds of events get special handling
1917 and don't actually appear to the command loop.
1918 We return nil for them. */
1919 if (event
->kind
== selection_request_event
)
1922 x_handle_selection_request (event
);
1923 kbd_fetch_ptr
= event
+ 1;
1925 /* We're getting selection request events, but we don't have
1931 else if (event
->kind
== selection_clear_event
)
1934 x_handle_selection_clear (event
);
1935 kbd_fetch_ptr
= event
+ 1;
1937 /* We're getting selection request events, but we don't have
1943 else if (event
->kind
== delete_window_event
)
1945 Lisp_Object tail
, frame
;
1948 /* If the user destroys the only frame, Emacs should exit.
1949 Count visible frames and iconified frames. */
1950 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
1952 frame
= XCONS (tail
)->car
;
1953 if (XTYPE (frame
) != Lisp_Frame
|| EQ (frame
, event
->frame_or_window
))
1956 if (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
))
1961 kill (getpid (), SIGHUP
);
1963 Fdelete_frame (event
->frame_or_window
, Qt
);
1964 kbd_fetch_ptr
= event
+ 1;
1967 /* Just discard these, by returning nil.
1968 (They shouldn't be found in the buffer,
1969 but on some machines it appears they do show up.) */
1970 else if (event
->kind
== no_event
)
1971 kbd_fetch_ptr
= event
+ 1;
1973 /* If this event is on a different frame, return a switch-frame this
1974 time, and leave the event in the queue for next time. */
1978 Lisp_Object frame
= event
->frame_or_window
;
1981 if (XTYPE (frame
) == Lisp_Window
)
1982 frame
= WINDOW_FRAME (XWINDOW (frame
));
1984 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
1988 if (! EQ (frame
, internal_last_event_frame
)
1989 && XFRAME (frame
) != selected_frame
)
1990 obj
= make_lispy_switch_frame (frame
);
1991 internal_last_event_frame
= frame
;
1992 #endif /* MULTI_FRAME */
1994 /* If we didn't decide to make a switch-frame event, go ahead
1995 and build a real event from the queue entry. */
1999 obj
= make_lispy_event (event
);
2001 /* Wipe out this event, to catch bugs. */
2002 event
->kind
= no_event
;
2003 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
2006 kbd_fetch_ptr
= event
+ 1;
2010 /* Try generating a mouse motion event. */
2011 else if (do_mouse_tracking
&& mouse_moved
)
2014 Lisp_Object bar_window
;
2015 enum scroll_bar_part part
;
2019 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
2024 /* Decide if we should generate a switch-frame event. Don't
2025 generate switch-frame events for motion outside of all Emacs
2029 Lisp_Object frame
= FRAME_FOCUS_FRAME (f
);
2032 XSET (frame
, Lisp_Frame
, f
);
2034 if (! EQ (frame
, internal_last_event_frame
)
2035 && XFRAME (frame
) != selected_frame
)
2036 obj
= make_lispy_switch_frame (frame
);
2037 internal_last_event_frame
= frame
;
2041 /* If we didn't decide to make a switch-frame event, go ahead and
2042 return a mouse-motion event. */
2044 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2047 /* We were promised by the above while loop that there was
2048 something for us to read! */
2051 input_pending
= readable_events ();
2054 Vlast_event_frame
= internal_last_event_frame
;
2060 /* Process any events that are not user-visible,
2061 then return, without reading any user-visible events. */
2066 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2068 struct input_event
*event
;
2070 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2074 last_event_timestamp
= event
->timestamp
;
2076 /* These two kinds of events get special handling
2077 and don't actually appear to the command loop. */
2078 if (event
->kind
== selection_request_event
)
2081 x_handle_selection_request (event
);
2082 kbd_fetch_ptr
= event
+ 1;
2084 /* We're getting selection request events, but we don't have
2090 else if (event
->kind
== selection_clear_event
)
2093 x_handle_selection_clear (event
);
2094 kbd_fetch_ptr
= event
+ 1;
2096 /* We're getting selection request events, but we don't have
2105 get_input_pending (&input_pending
);
2108 /* Caches for modify_event_symbol. */
2109 static Lisp_Object func_key_syms
;
2110 static Lisp_Object mouse_syms
;
2112 /* You'll notice that this table is arranged to be conveniently
2113 indexed by X Windows keysym values. */
2114 static char *lispy_function_keys
[] =
2116 /* X Keysym value */
2118 "remove", 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2126 0, 0, 0, /* 0xff10 */
2128 0, 0, 0, 0, 0, 0, 0,
2131 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2132 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2133 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2135 "home", /* 0xff50 */ /* IsCursorKey */
2146 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2157 "break", /* 0xff6b */
2159 /* Here are some keys found mostly on HP keyboards. The X event
2160 handling code will strip bit 29, which flags vendor-specific
2162 "reset", /* 0x1000ff6c */
2171 "kp-backtab", /* 0x1000ff75 */
2173 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2174 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2175 0, 0, 0, 0, 0, 0, 0, 0,
2176 "kp-tab", /* 0xff89 */
2178 "kp-enter", /* 0xff8d */
2180 "kp-f1", /* 0xff91 */
2185 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2186 "kp-multiply", /* 0xffaa */
2191 "kp-divide", /* 0xffaf */
2192 "kp-0", /* 0xffb0 */
2193 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2196 "kp-equal", /* 0xffbd */
2197 "f1", /* 0xffbe */ /* IsFunctionKey */
2199 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2200 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2201 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2202 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2203 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2204 0, 0, 0, 0, 0, 0, 0, 0,
2205 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2206 0, 0, 0, 0, 0, 0, 0, "delete"
2209 static char *lispy_mouse_names
[] =
2211 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2214 /* Scroll bar parts. */
2215 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2217 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2218 Lisp_Object
*scroll_bar_parts
[] = {
2219 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2223 /* A vector, indexed by button number, giving the down-going location
2224 of currently depressed buttons, both scroll bar and non-scroll bar.
2226 The elements have the form
2227 (BUTTON-NUMBER MODIFIER-MASK . REST)
2228 where REST is the cdr of a position as it would be reported in the event.
2230 The make_lispy_event function stores positions here to tell the
2231 difference between click and drag events, and to store the starting
2232 location to be included in drag events. */
2234 static Lisp_Object button_down_location
;
2236 /* Information about the most recent up-going button event: Which
2237 button, what location, and what time. */
2239 static int last_mouse_button
;
2240 static int last_mouse_x
;
2241 static int last_mouse_y
;
2242 static unsigned long button_down_time
;
2244 /* The maximum time between clicks to make a double-click,
2245 or Qnil to disable double-click detection,
2246 or Qt for no time limit. */
2247 Lisp_Object Vdouble_click_time
;
2249 /* The number of clicks in this multiple-click. */
2251 int double_click_count
;
2253 /* Given a struct input_event, build the lisp event which represents
2254 it. If EVENT is 0, build a mouse movement event from the mouse
2255 movement buffer, which should have a movement event in it.
2257 Note that events must be passed to this function in the order they
2258 are received; this function stores the location of button presses
2259 in order to build drag events when the button is released. */
2262 make_lispy_event (event
)
2263 struct input_event
*event
;
2265 #ifdef SWITCH_ENUM_BUG
2266 switch ((int) event
->kind
)
2268 switch (event
->kind
)
2271 /* A simple keystroke. */
2272 case ascii_keystroke
:
2274 int c
= XFASTINT (event
->code
) & 0377;
2275 /* Turn ASCII characters into control characters
2277 if (event
->modifiers
& ctrl_modifier
)
2278 c
= make_ctrl_char (c
);
2280 /* Add in the other modifier bits. We took care of ctrl_modifier
2281 just above, and the shift key was taken care of by the X code,
2282 and applied to control characters by make_ctrl_char. */
2283 c
|= (event
->modifiers
2284 & (meta_modifier
| alt_modifier
2285 | hyper_modifier
| super_modifier
));
2286 button_down_time
= 0;
2290 /* A function key. The symbol may need to have modifier prefixes
2292 case non_ascii_keystroke
:
2293 button_down_time
= 0;
2294 return modify_event_symbol (XFASTINT (event
->code
), event
->modifiers
,
2296 lispy_function_keys
, &func_key_syms
,
2297 (sizeof (lispy_function_keys
)
2298 / sizeof (lispy_function_keys
[0])));
2301 /* A mouse click. Figure out where it is, decide whether it's
2302 a press, click or drag, and build the appropriate structure. */
2304 case scroll_bar_click
:
2306 int button
= XFASTINT (event
->code
);
2308 Lisp_Object position
;
2309 Lisp_Object
*start_pos_ptr
;
2310 Lisp_Object start_pos
;
2312 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2315 /* Build the position as appropriate for this mouse click. */
2316 if (event
->kind
== mouse_click
)
2319 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2321 = window_from_coordinates (f
, XINT (event
->x
), XINT (event
->y
),
2325 if (XINT (event
->y
) < FRAME_MENU_BAR_LINES (f
))
2329 items
= FRAME_MENU_BAR_ITEMS (f
);
2330 for (; CONSP (items
); items
= XCONS (items
)->cdr
)
2332 Lisp_Object pos
, string
;
2333 pos
= Fcdr (Fcdr (Fcar (items
)));
2334 string
= Fcar (Fcdr (Fcar (items
)));
2335 if (XINT (event
->x
) >= XINT (pos
)
2336 && XINT (event
->x
) < XINT (pos
) + XSTRING (string
)->size
)
2340 = Fcons (event
->frame_or_window
,
2342 Fcons (Fcons (event
->x
, event
->y
),
2343 Fcons (make_number (event
->timestamp
),
2347 return Fcons (Fcar (Fcar (items
)),
2348 Fcons (position
, Qnil
));
2350 return Fcons (Qnil
, Fcons (position
, Qnil
));
2352 else if (XTYPE (window
) != Lisp_Window
)
2357 (XINT (event
->x
) - XINT (XWINDOW (window
)->left
)));
2359 (XINT (event
->y
) - XINT (XWINDOW (window
)->top
)));
2364 posn
= Qvertical_line
;
2366 XSET (posn
, Lisp_Int
,
2367 buffer_posn_from_coords (XWINDOW (window
),
2375 Fcons (Fcons (event
->x
, event
->y
),
2376 Fcons (make_number (event
->timestamp
),
2381 Lisp_Object window
= event
->frame_or_window
;
2382 Lisp_Object portion_whole
= Fcons (event
->x
, event
->y
);
2383 Lisp_Object part
= *scroll_bar_parts
[(int) event
->part
];
2387 Fcons (Qvertical_scroll_bar
,
2388 Fcons (portion_whole
,
2389 Fcons (make_number (event
->timestamp
),
2394 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2396 start_pos
= *start_pos_ptr
;
2397 *start_pos_ptr
= Qnil
;
2399 is_double
= (button
== last_mouse_button
2400 && XINT (event
->x
) == last_mouse_x
2401 && XINT (event
->y
) == last_mouse_y
2402 && button_down_time
!= 0
2403 && (EQ (Vdouble_click_time
, Qt
)
2404 || (INTEGERP (Vdouble_click_time
)
2405 && ((int)(event
->timestamp
- button_down_time
)
2406 < XINT (Vdouble_click_time
)))));
2407 last_mouse_button
= button
;
2408 last_mouse_x
= XINT (event
->x
);
2409 last_mouse_y
= XINT (event
->y
);
2411 /* If this is a button press, squirrel away the location, so
2412 we can decide later whether it was a click or a drag. */
2413 if (event
->modifiers
& down_modifier
)
2417 double_click_count
++;
2418 event
->modifiers
|= ((double_click_count
> 2)
2423 double_click_count
= 1;
2424 button_down_time
= event
->timestamp
;
2425 *start_pos_ptr
= Fcopy_alist (position
);
2428 /* Now we're releasing a button - check the co-ordinates to
2429 see if this was a click or a drag. */
2430 else if (event
->modifiers
& up_modifier
)
2432 /* If we did not see a down before this up,
2433 ignore the up. Probably this happened because
2434 the down event chose a menu item.
2435 It would be an annoyance to treat the release
2436 of the button that chose the menu item
2437 as a separate event. */
2439 if (XTYPE (start_pos
) != Lisp_Cons
)
2442 event
->modifiers
&= ~up_modifier
;
2443 #if 0 /* Formerly we treated an up with no down as a click event. */
2444 if (XTYPE (start_pos
) != Lisp_Cons
)
2445 event
->modifiers
|= click_modifier
;
2449 /* The third element of every position should be the (x,y)
2451 Lisp_Object down
= Fnth (make_number (2), start_pos
);
2453 if (EQ (event
->x
, XCONS (down
)->car
)
2454 && EQ (event
->y
, XCONS (down
)->cdr
))
2456 if (is_double
&& double_click_count
> 1)
2457 event
->modifiers
|= ((double_click_count
> 2)
2461 event
->modifiers
|= click_modifier
;
2465 button_down_time
= 0;
2466 event
->modifiers
|= drag_modifier
;
2471 /* Every mouse event should either have the down_modifier or
2472 the up_modifier set. */
2476 /* Get the symbol we should use for the mouse click. */
2478 = modify_event_symbol (button
,
2481 lispy_mouse_names
, &mouse_syms
,
2482 (sizeof (lispy_mouse_names
)
2483 / sizeof (lispy_mouse_names
[0])));
2485 if (event
->modifiers
& drag_modifier
)
2490 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2493 Fcons (make_number (double_click_count
),
2502 /* The 'kind' field of the event is something we don't recognize. */
2509 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2511 Lisp_Object bar_window
;
2512 enum scroll_bar_part part
;
2516 /* Is it a scroll bar movement? */
2517 if (frame
&& ! NILP (bar_window
))
2519 Lisp_Object part_sym
= *scroll_bar_parts
[(int) part
];
2521 return Fcons (Qscroll_bar_movement
,
2522 (Fcons (Fcons (bar_window
,
2523 Fcons (Qvertical_scroll_bar
,
2524 Fcons (Fcons (x
, y
),
2525 Fcons (make_number (time
),
2531 /* Or is it an ordinary mouse movement? */
2535 Lisp_Object window
=
2537 ? window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
)
2541 if (XTYPE (window
) == Lisp_Window
)
2543 XSETINT (x
, XINT (x
) - XINT (XWINDOW (window
)->left
));
2544 XSETINT (y
, XINT (y
) - XINT (XWINDOW (window
)->top
));
2549 posn
= Qvertical_line
;
2551 XSET (posn
, Lisp_Int
,
2552 buffer_posn_from_coords (XWINDOW (window
),
2553 XINT (x
), XINT (y
)));
2563 return Fcons (Qmouse_movement
,
2564 Fcons (Fcons (window
,
2566 Fcons (Fcons (x
, y
),
2567 Fcons (make_number (time
),
2573 /* Construct a switch frame event. */
2575 make_lispy_switch_frame (frame
)
2578 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
2581 /* Manipulating modifiers. */
2583 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
2585 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2586 SYMBOL's name of the end of the modifiers; the string from this
2587 position is the unmodified symbol name.
2589 This doesn't use any caches. */
2591 parse_modifiers_uncached (symbol
, modifier_end
)
2595 struct Lisp_String
*name
;
2599 CHECK_SYMBOL (symbol
, 1);
2602 name
= XSYMBOL (symbol
)->name
;
2605 for (i
= 0; i
+2 <= name
->size
; )
2606 switch (name
->data
[i
])
2608 #define SINGLE_LETTER_MOD(bit) \
2609 if (name->data[i+1] != '-') \
2610 goto no_more_modifiers; \
2615 SINGLE_LETTER_MOD (alt_modifier
);
2619 SINGLE_LETTER_MOD (ctrl_modifier
);
2623 SINGLE_LETTER_MOD (hyper_modifier
);
2627 SINGLE_LETTER_MOD (meta_modifier
);
2631 SINGLE_LETTER_MOD (shift_modifier
);
2635 SINGLE_LETTER_MOD (super_modifier
);
2639 if (i
+ 5 > name
->size
)
2640 goto no_more_modifiers
;
2641 if (! strncmp (name
->data
+ i
, "drag-", 5))
2643 modifiers
|= drag_modifier
;
2646 else if (! strncmp (name
->data
+ i
, "down-", 5))
2648 modifiers
|= down_modifier
;
2651 else if (i
+ 7 <= name
->size
2652 && ! strncmp (name
->data
+ i
, "double-", 7))
2654 modifiers
|= double_modifier
;
2658 goto no_more_modifiers
;
2662 if (i
+ 7 > name
->size
)
2663 goto no_more_modifiers
;
2664 if (! strncmp (name
->data
+ i
, "triple-", 7))
2666 modifiers
|= triple_modifier
;
2670 goto no_more_modifiers
;
2674 goto no_more_modifiers
;
2676 #undef SINGLE_LETTER_MOD
2680 /* Should we include the `click' modifier? */
2681 if (! (modifiers
& (down_modifier
| drag_modifier
2682 | double_modifier
| triple_modifier
))
2683 && i
+ 7 == name
->size
2684 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
2685 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
2686 modifiers
|= click_modifier
;
2695 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
2696 prepended to the string BASE[0..BASE_LEN-1].
2697 This doesn't use any caches. */
2699 apply_modifiers_uncached (modifiers
, base
, base_len
)
2704 /* Since BASE could contain nulls, we can't use intern here; we have
2705 to use Fintern, which expects a genuine Lisp_String, and keeps a
2708 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
2714 /* Only the event queue may use the `up' modifier; it should always
2715 be turned into a click or drag event before presented to lisp code. */
2716 if (modifiers
& up_modifier
)
2719 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
2720 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
2721 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
2722 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
2723 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
2724 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
2725 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
2726 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
2727 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
2728 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
2729 /* The click modifier is denoted by the absence of other modifiers. */
2733 mod_len
= p
- new_mods
;
2737 Lisp_Object new_name
= make_uninit_string (mod_len
+ base_len
);
2739 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
2740 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
2742 return Fintern (new_name
, Qnil
);
2747 static char *modifier_names
[] =
2749 "up", "down", "drag", "click", "double", "triple", 0, 0,
2750 0, 0, 0, 0, 0, 0, 0, 0,
2751 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
2753 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
2755 static Lisp_Object modifier_symbols
;
2757 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
2759 lispy_modifier_list (modifiers
)
2762 Lisp_Object modifier_list
;
2765 modifier_list
= Qnil
;
2766 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
2767 if (modifiers
& (1<<i
))
2768 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
2771 return modifier_list
;
2775 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
2776 where UNMODIFIED is the unmodified form of SYMBOL,
2777 MASK is the set of modifiers present in SYMBOL's name.
2778 This is similar to parse_modifiers_uncached, but uses the cache in
2779 SYMBOL's Qevent_symbol_element_mask property, and maintains the
2780 Qevent_symbol_elements property. */
2782 parse_modifiers (symbol
)
2785 Lisp_Object elements
= Fget (symbol
, Qevent_symbol_element_mask
);
2787 if (CONSP (elements
))
2792 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
2793 Lisp_Object unmodified
2794 = Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
2795 XSYMBOL (symbol
)->name
->size
- end
),
2799 if (modifiers
& ~((1<<VALBITS
) - 1))
2801 XFASTINT (mask
) = modifiers
;
2802 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
2804 /* Cache the parsing results on SYMBOL. */
2805 Fput (symbol
, Qevent_symbol_element_mask
,
2807 Fput (symbol
, Qevent_symbol_elements
,
2808 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
2810 /* Since we know that SYMBOL is modifiers applied to unmodified,
2811 it would be nice to put that in unmodified's cache.
2812 But we can't, since we're not sure that parse_modifiers is
2819 /* Apply the modifiers MODIFIERS to the symbol BASE.
2820 BASE must be unmodified.
2822 This is like apply_modifiers_uncached, but uses BASE's
2823 Qmodifier_cache property, if present. It also builds
2824 Qevent_symbol_elements properties, since it has that info anyway.
2826 apply_modifiers copies the value of BASE's Qevent_kind property to
2827 the modified symbol. */
2829 apply_modifiers (modifiers
, base
)
2833 Lisp_Object cache
, index
, entry
, new_symbol
;
2835 /* Mask out upper bits. We don't know where this value's been. */
2836 modifiers
&= (1<<VALBITS
) - 1;
2838 /* The click modifier never figures into cache indices. */
2839 cache
= Fget (base
, Qmodifier_cache
);
2840 XFASTINT (index
) = (modifiers
& ~click_modifier
);
2841 entry
= Fassq (index
, cache
);
2844 new_symbol
= XCONS (entry
)->cdr
;
2847 /* We have to create the symbol ourselves. */
2848 new_symbol
= apply_modifiers_uncached (modifiers
,
2849 XSYMBOL (base
)->name
->data
,
2850 XSYMBOL (base
)->name
->size
);
2852 /* Add the new symbol to the base's cache. */
2853 entry
= Fcons (index
, new_symbol
);
2854 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
2856 /* We have the parsing info now for free, so add it to the caches. */
2857 XFASTINT (index
) = modifiers
;
2858 Fput (new_symbol
, Qevent_symbol_element_mask
,
2859 Fcons (base
, Fcons (index
, Qnil
)));
2860 Fput (new_symbol
, Qevent_symbol_elements
,
2861 Fcons (base
, lispy_modifier_list (modifiers
)));
2864 /* Make sure this symbol is of the same kind as BASE.
2866 You'd think we could just set this once and for all when we
2867 intern the symbol above, but reorder_modifiers may call us when
2868 BASE's property isn't set right; we can't assume that just
2869 because it has a Qmodifier_cache property it must have its
2870 Qevent_kind set right as well. */
2871 if (NILP (Fget (new_symbol
, Qevent_kind
)))
2873 Lisp_Object kind
= Fget (base
, Qevent_kind
);
2876 Fput (new_symbol
, Qevent_kind
, kind
);
2883 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
2884 return a symbol with the modifiers placed in the canonical order.
2885 Canonical order is alphabetical, except for down and drag, which
2886 always come last. The 'click' modifier is never written out.
2888 Fdefine_key calls this to make sure that (for example) C-M-foo
2889 and M-C-foo end up being equivalent in the keymap. */
2892 reorder_modifiers (symbol
)
2895 /* It's hopefully okay to write the code this way, since everything
2896 will soon be in caches, and no consing will be done at all. */
2897 Lisp_Object parsed
= parse_modifiers (symbol
);
2899 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
2900 XCONS (parsed
)->car
);
2904 /* For handling events, we often want to produce a symbol whose name
2905 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
2906 to some base, like the name of a function key or mouse button.
2907 modify_event_symbol produces symbols of this sort.
2909 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
2910 is the name of the i'th symbol. TABLE_SIZE is the number of elements
2913 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
2914 persist between calls to modify_event_symbol that it can use to
2915 store a cache of the symbols it's generated for this NAME_TABLE
2918 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
2920 MODIFIERS is a set of modifier bits (as given in struct input_events)
2921 whose prefixes should be applied to the symbol name.
2923 SYMBOL_KIND is the value to be placed in the event_kind property of
2924 the returned symbol.
2926 The symbols we create are supposed to have an
2927 `event-symbol-elements' property, which lists the modifiers present
2928 in the symbol's name. */
2931 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_table
,
2932 symbol_table
, table_size
)
2935 Lisp_Object symbol_kind
;
2937 Lisp_Object
*symbol_table
;
2942 /* Is this a request for a valid symbol? */
2943 if (symbol_num
< 0 || symbol_num
>= table_size
)
2946 /* If *symbol_table doesn't seem to be initialized properly, fix that.
2947 *symbol_table should be a lisp vector TABLE_SIZE elements long,
2948 where the Nth element is the symbol for NAME_TABLE[N], or nil if
2949 we've never used that symbol before. */
2950 if (XTYPE (*symbol_table
) != Lisp_Vector
2951 || XVECTOR (*symbol_table
)->size
!= table_size
)
2955 XFASTINT (size
) = table_size
;
2956 *symbol_table
= Fmake_vector (size
, Qnil
);
2959 slot
= & XVECTOR (*symbol_table
)->contents
[symbol_num
];
2961 /* Have we already used this symbol before? */
2964 /* No; let's create it. */
2965 if (name_table
[symbol_num
])
2966 *slot
= intern (name_table
[symbol_num
]);
2970 sprintf (buf
, "key-%d", symbol_num
);
2971 *slot
= intern (buf
);
2974 /* Fill in the cache entries for this symbol; this also
2975 builds the Qevent_symbol_elements property, which the user
2977 apply_modifiers (modifiers
& click_modifier
, *slot
);
2978 Fput (*slot
, Qevent_kind
, symbol_kind
);
2981 /* Apply modifiers to that symbol. */
2982 return apply_modifiers (modifiers
, *slot
);
2986 /* Store into *addr a value nonzero if terminal input chars are available.
2987 Serves the purpose of ioctl (0, FIONREAD, addr)
2988 but works even if FIONREAD does not exist.
2989 (In fact, this may actually read some input.) */
2992 get_input_pending (addr
)
2995 /* First of all, have we already counted some input? */
2996 *addr
= !NILP (Vquit_flag
) || readable_events ();
2998 /* If input is being read as it arrives, and we have none, there is none. */
2999 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
3002 /* Try to read some input and see how much we get. */
3004 *addr
= !NILP (Vquit_flag
) || readable_events ();
3007 /* Interface to read_avail_input, blocking SIGIO if necessary. */
3010 gobble_input (expected
)
3015 if (interrupt_input
)
3018 mask
= sigblockx (SIGIO
);
3019 read_avail_input (expected
);
3024 read_avail_input (expected
);
3030 /* Read any terminal input already buffered up by the system
3031 into the kbd_buffer, but do not wait.
3033 EXPECTED should be nonzero if the caller knows there is some input.
3035 Except on VMS, all input is read by this function.
3036 If interrupt_input is nonzero, this function MUST be called
3037 only when SIGIO is blocked.
3039 Returns the number of keyboard chars read, or -1 meaning
3040 this is a bad time to try to read input. */
3043 read_avail_input (expected
)
3046 struct input_event buf
[KBD_BUFFER_SIZE
];
3050 if (read_socket_hook
)
3051 /* No need for FIONREAD or fcntl; just say don't wait. */
3052 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
3055 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
3056 the kbd_buffer can really hold. That may prevent loss
3057 of characters on some systems when input is stuffed at us. */
3058 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
3061 /* Find out how much input is available. */
3062 if (ioctl (0, FIONREAD
, &nread
) < 0)
3063 /* Formerly simply reported no input, but that sometimes led to
3064 a failure of Emacs to terminate.
3065 SIGHUP seems appropriate if we can't reach the terminal. */
3066 /* ??? Is it really right to send the signal just to this process
3067 rather than to the whole process group?
3068 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3069 kill (getpid (), SIGHUP
);
3072 if (nread
> sizeof cbuf
)
3073 nread
= sizeof cbuf
;
3074 #else /* no FIONREAD */
3075 #if defined(USG) || defined(DGUX)
3076 /* Read some input if available, but don't wait. */
3077 nread
= sizeof cbuf
;
3078 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
3084 /* Now read; for one reason or another, this will not block. */
3087 nread
= read (fileno (stdin
), cbuf
, nread
);
3089 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3090 This looks incorrect, but it isn't, because _BSD causes
3091 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3092 and that causes a value other than 0 when there is no input. */
3096 /* This code is wrong, but at least it gets the right results.
3097 Fix it for 19.23. */
3098 /* Retry the read if it is interrupted. */
3100 || ! (errno
== EAGAIN
|| errno
== EFAULT
3110 fcntl (fileno (stdin
), F_SETFL
, 0);
3112 #endif /* no FIONREAD */
3113 for (i
= 0; i
< nread
; i
++)
3115 buf
[i
].kind
= ascii_keystroke
;
3116 buf
[i
].modifiers
= 0;
3117 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3118 buf
[i
].modifiers
= meta_modifier
;
3122 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
3124 XSET (buf
[i
].frame_or_window
, Lisp_Frame
, selected_frame
);
3126 buf
[i
].frame_or_window
= Qnil
;
3131 /* Scan the chars for C-g and store them in kbd_buffer. */
3132 for (i
= 0; i
< nread
; i
++)
3134 kbd_buffer_store_event (&buf
[i
]);
3135 /* Don't look at input that follows a C-g too closely.
3136 This reduces lossage due to autorepeat on C-g. */
3137 if (buf
[i
].kind
== ascii_keystroke
3138 && XINT(buf
[i
].code
) == quit_char
)
3144 #endif /* not VMS */
3146 #ifdef SIGIO /* for entire page */
3147 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3150 input_available_signal (signo
)
3153 /* Must preserve main program's value of errno. */
3154 int old_errno
= errno
;
3156 extern int select_alarmed
;
3160 /* USG systems forget handlers when they are used;
3161 must reestablish each time */
3162 signal (signo
, input_available_signal
);
3169 if (input_available_clear_time
)
3170 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3175 nread
= read_avail_input (1);
3176 /* -1 means it's not ok to read the input now.
3177 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3178 0 means there was no keyboard input available. */
3183 select_alarmed
= 1; /* Force the select emulator back to life */
3194 /* Send ourselves a SIGIO.
3196 This function exists so that the UNBLOCK_INPUT macro in
3197 blockinput.h can have some way to take care of input we put off
3198 dealing with, without assuming that every file which uses
3199 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3201 reinvoke_input_signal ()
3210 /* Return the prompt-string of a sparse keymap.
3211 This is the first element which is a string.
3212 Return nil if there is none. */
3220 register Lisp_Object tem
;
3222 if (XTYPE (tem
) == Lisp_String
)
3229 static Lisp_Object
menu_bar_item ();
3230 static Lisp_Object
menu_bar_one_keymap ();
3232 /* Return a list of menu items for a menu bar, appropriate
3233 to the current buffer.
3234 The elements have the form (KEY STRING . nil). */
3239 /* The number of keymaps we're scanning right now, and the number of
3240 keymaps we have allocated space for. */
3243 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3244 in the current keymaps, or nil where it is not a prefix. */
3247 Lisp_Object def
, tem
, tail
;
3254 /* In order to build the menus, we need to call the keymap
3255 accessors. They all call QUIT. But this function is called
3256 during redisplay, during which a quit is fatal. So inhibit
3257 quitting while building the menus.
3258 We do this instead of specbind because (1) errors will clear it anyway
3259 and (2) this avoids risk of specpdl overflow. */
3260 oquit
= Vinhibit_quit
;
3263 /* Build our list of keymaps.
3264 If we recognize a function key and replace its escape sequence in
3265 keybuf with its symbol, or if the sequence starts with a mouse
3266 click and we need to switch buffers, we jump back here to rebuild
3267 the initial keymaps from the current buffer. */
3271 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3272 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3273 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3274 #ifdef USE_TEXT_PROPERTIES
3275 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3277 maps
[nmaps
-2] = current_buffer
->keymap
;
3279 maps
[nmaps
-1] = current_global_map
;
3282 /* Look up in each map the dummy prefix key `menu-bar'. */
3286 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3288 if (! NILP (maps
[mapno
]))
3289 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3293 tem
= Fkeymapp (def
);
3295 result
= menu_bar_one_keymap (def
, result
);
3298 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3302 elt
= Fassq (XCONS (tail
)->car
, result
);
3304 result
= Fcons (elt
, Fdelq (elt
, result
));
3307 result
= Fnreverse (result
);
3308 Vinhibit_quit
= oquit
;
3312 /* Scan one map KEYMAP, accumulating any menu items it defines
3313 that have not yet been seen in RESULT. Return the updated RESULT. */
3316 menu_bar_one_keymap (keymap
, result
)
3317 Lisp_Object keymap
, result
;
3319 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3321 /* Loop over all keymap entries that have menu strings. */
3322 for (tail
= keymap
; XTYPE (tail
) == Lisp_Cons
; tail
= XCONS (tail
)->cdr
)
3324 item
= XCONS (tail
)->car
;
3325 if (XTYPE (item
) == Lisp_Cons
)
3327 key
= XCONS (item
)->car
;
3328 binding
= XCONS (item
)->cdr
;
3329 if (XTYPE (binding
) == Lisp_Cons
)
3331 item_string
= XCONS (binding
)->car
;
3332 if (XTYPE (item_string
) == Lisp_String
)
3333 result
= menu_bar_item (key
, item_string
,
3334 Fcdr (binding
), result
);
3336 else if (EQ (binding
, Qundefined
))
3337 result
= menu_bar_item (key
, item_string
,
3340 else if (XTYPE (item
) == Lisp_Vector
)
3342 /* Loop over the char values represented in the vector. */
3343 int len
= XVECTOR (item
)->size
;
3345 for (c
= 0; c
< len
; c
++)
3347 Lisp_Object character
;
3348 XFASTINT (character
) = c
;
3349 binding
= XVECTOR (item
)->contents
[c
];
3350 if (XTYPE (binding
) == Lisp_Cons
)
3352 item_string
= XCONS (binding
)->car
;
3353 if (XTYPE (item_string
) == Lisp_String
)
3354 result
= menu_bar_item (key
, item_string
,
3355 Fcdr (binding
), result
);
3357 else if (EQ (binding
, Qundefined
))
3358 result
= menu_bar_item (key
, item_string
,
3368 menu_bar_item (key
, item_string
, def
, result
)
3369 Lisp_Object key
, item_string
, def
, result
;
3372 Lisp_Object enabled
;
3374 if (EQ (def
, Qundefined
))
3376 /* If a map has an explicit nil as definition,
3377 discard any previously made menu bar item. */
3378 tem
= Fassq (key
, result
);
3379 return Fdelq (tem
, result
);
3382 /* See if this entry is enabled. */
3385 if (XTYPE (def
) == Lisp_Symbol
)
3387 /* No property, or nil, means enable.
3388 Otherwise, enable if value is not nil. */
3389 tem
= Fget (def
, Qmenu_enable
);
3391 enabled
= Feval (tem
);
3394 /* Add an entry for this key and string
3395 if there is none yet. */
3396 tem
= Fassq (key
, result
);
3397 if (!NILP (enabled
) && NILP (tem
))
3398 result
= Fcons (Fcons (key
, Fcons (item_string
, Qnil
)), result
);
3403 static int echo_flag
;
3404 static int echo_now
;
3406 /* Read a character using menus based on maps in the array MAPS.
3407 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
3408 Return t if we displayed a menu but the user rejected it.
3410 PREV_EVENT is the previous input event, or nil if we are reading
3411 the first event of a key sequence.
3413 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3414 if we used a mouse menu to read the input, or zero otherwise. If
3415 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
3417 The prompting is done based on the prompt-string of the map
3418 and the strings associated with various map elements. */
3421 read_char_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
3424 Lisp_Object prev_event
;
3425 int *used_mouse_menu
;
3428 register Lisp_Object name
;
3430 int width
= FRAME_WIDTH (selected_frame
) - 4;
3431 char *menu
= (char *) alloca (width
+ 4);
3433 Lisp_Object rest
, vector
;
3435 if (used_mouse_menu
)
3436 *used_mouse_menu
= 0;
3438 /* Use local over global Menu maps */
3440 if (! menu_prompting
)
3443 /* Get the menu name from the first map that has one (a prompt string). */
3444 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3446 name
= map_prompt (maps
[mapno
]);
3451 /* If we don't have any menus, just read a character normally. */
3455 #ifdef HAVE_X_WINDOWS
3457 /* If we got to this point via a mouse click,
3458 use a real menu for mouse selection. */
3459 if (EVENT_HAS_PARAMETERS (prev_event
))
3461 /* Display the menu and get the selection. */
3462 Lisp_Object
*realmaps
3463 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
3467 /* Use the maps that are not nil. */
3468 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3469 if (!NILP (maps
[mapno
]))
3470 realmaps
[nmaps1
++] = maps
[mapno
];
3472 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
3475 /* If we got more than one event, put all but the first
3476 onto this list to be read later.
3477 Return just the first event now. */
3478 unread_command_events
3479 = nconc2 (XCONS (value
)->cdr
, unread_command_events
);
3480 value
= XCONS (value
)->car
;
3484 if (used_mouse_menu
)
3485 *used_mouse_menu
= 1;
3488 #endif /* HAVE_X_MENU */
3489 #endif /* HAVE_X_WINDOWS */
3491 /* Prompt string always starts with map's prompt, and a space. */
3492 strcpy (menu
, XSTRING (name
)->data
);
3493 nlength
= XSTRING (name
)->size
;
3494 menu
[nlength
++] = ':';
3495 menu
[nlength
++] = ' ';
3498 /* Start prompting at start of first map. */
3502 /* Present the documented bindings, a line at a time. */
3510 /* Loop over elements of map. */
3515 /* If reached end of map, start at beginning of next map. */
3519 /* At end of last map, wrap around to first map if just starting,
3520 or end this line if already have something on it. */
3531 /* Look at the next element of the map. */
3533 elt
= XVECTOR (vector
)->contents
[idx
];
3535 elt
= Fcar_safe (rest
);
3537 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
3539 /* If we found a dense table in the keymap,
3540 advanced past it, but start scanning its contents. */
3541 rest
= Fcdr_safe (rest
);
3547 /* An ordinary element. */
3548 s
= Fcar_safe (Fcdr_safe (elt
));
3549 if (XTYPE (s
) != Lisp_String
)
3550 /* Ignore the element if it has no prompt string. */
3552 /* If we have room for the prompt string, add it to this line.
3553 If this is the first on the line, always add it. */
3554 else if (XSTRING (s
)->size
+ i
< width
3559 /* Punctuate between strings. */
3562 strcpy (menu
+ i
, ", ");
3567 /* Add as much of string as fits. */
3568 thiswidth
= XSTRING (s
)->size
;
3569 if (thiswidth
+ i
> width
)
3570 thiswidth
= width
- i
;
3571 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
3576 /* If this element does not fit, end the line now,
3577 and save the element for the next line. */
3578 strcpy (menu
+ i
, "...");
3582 /* Move past this element. */
3583 if (idx
>= 0 && idx
+ 1 >= XVECTOR (rest
)->size
)
3584 /* Handle reaching end of dense table. */
3589 rest
= Fcdr_safe (rest
);
3593 /* Prompt with that and read response. */
3595 obj
= read_char (1, 0, 0, Qnil
, 0);
3597 if (XTYPE (obj
) != Lisp_Int
)
3602 if (! EQ (obj
, menu_prompt_more_char
)
3603 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
3604 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
3609 /* Reading key sequences. */
3611 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
3612 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
3613 keymap, or nil otherwise. Return the index of the first keymap in
3614 which KEY has any binding, or NMAPS if no map has a binding.
3616 If KEY is a meta ASCII character, treat it like meta-prefix-char
3617 followed by the corresponding non-meta character. Keymaps in
3618 CURRENT with non-prefix bindings for meta-prefix-char become nil in
3621 When KEY is not defined in any of the keymaps, if it is an upper
3622 case letter and there are bindings for the corresponding lower-case
3623 letter, return the bindings for the lower-case letter.
3625 If KEY has no bindings in any of the CURRENT maps, NEXT is left
3628 NEXT may == CURRENT. */
3631 follow_key (key
, nmaps
, current
, defs
, next
)
3633 Lisp_Object
*current
, *defs
, *next
;
3636 int i
, first_binding
;
3638 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
3639 followed by the corresponding non-meta character. */
3640 if (XTYPE (key
) == Lisp_Int
&& (XINT (key
) & CHAR_META
))
3642 for (i
= 0; i
< nmaps
; i
++)
3643 if (! NILP (current
[i
]))
3646 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
3648 /* Note that since we pass the resulting bindings through
3649 get_keymap_1, non-prefix bindings for meta-prefix-char
3651 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
3657 XSET (key
, Lisp_Int
, XFASTINT (key
) & ~CHAR_META
);
3660 first_binding
= nmaps
;
3661 for (i
= nmaps
- 1; i
>= 0; i
--)
3663 if (! NILP (current
[i
]))
3665 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3666 if (! NILP (defs
[i
]))
3673 /* When KEY is not defined in any of the keymaps, if it is an upper
3674 case letter and there are bindings for the corresponding
3675 lower-case letter, return the bindings for the lower-case letter. */
3676 if (first_binding
== nmaps
3677 && XTYPE (key
) == Lisp_Int
3678 && ((((XINT (key
) & 0x3ffff)
3679 < XSTRING (current_buffer
->downcase_table
)->size
)
3680 && UPPERCASEP (XINT (key
) & 0x3ffff))
3681 || (XINT (key
) & shift_modifier
)))
3683 if (XINT (key
) & shift_modifier
)
3684 XSETINT (key
, XINT (key
) & ~shift_modifier
);
3686 XSETINT (key
, (DOWNCASE (XINT (key
) & 0x3ffff)
3687 | (XINT (key
) & ~0x3ffff)));
3689 first_binding
= nmaps
;
3690 for (i
= nmaps
- 1; i
>= 0; i
--)
3692 if (! NILP (current
[i
]))
3694 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3695 if (! NILP (defs
[i
]))
3703 /* Given the set of bindings we've found, produce the next set of maps. */
3704 if (first_binding
< nmaps
)
3705 for (i
= 0; i
< nmaps
; i
++)
3706 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
3708 return first_binding
;
3711 /* Read a sequence of keys that ends with a non prefix character,
3712 storing it in KEYBUF, a buffer of size BUFSIZE.
3714 Return the length of the key sequence stored.
3715 Return -1 if the user rejected a command menu.
3717 Echo starting immediately unless `prompt' is 0.
3719 Where a key sequence ends depends on the currently active keymaps.
3720 These include any minor mode keymaps active in the current buffer,
3721 the current buffer's local map, and the global map.
3723 If a key sequence has no other bindings, we check Vfunction_key_map
3724 to see if some trailing subsequence might be the beginning of a
3725 function key's sequence. If so, we try to read the whole function
3726 key, and substitute its symbolic name into the key sequence.
3728 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
3729 `double-' events into similar click events, if that would make them
3730 bound. We try to turn `triple-' events first into `double-' events,
3733 If we get a mouse click in a mode line, vertical divider, or other
3734 non-text area, we treat the click as if it were prefixed by the
3735 symbol denoting that area - `mode-line', `vertical-line', or
3738 If the sequence starts with a mouse click, we read the key sequence
3739 with respect to the buffer clicked on, not the current buffer.
3741 If the user switches frames in the midst of a key sequence, we put
3742 off the switch-frame event until later; the next call to
3743 read_char will return it. */
3746 read_key_sequence (keybuf
, bufsize
, prompt
)
3747 Lisp_Object
*keybuf
;
3751 int count
= specpdl_ptr
- specpdl
;
3753 /* How many keys there are in the current key sequence. */
3756 /* The length of the echo buffer when we started reading, and
3757 the length of this_command_keys when we started reading. */
3761 /* The number of keymaps we're scanning right now, and the number of
3762 keymaps we have allocated space for. */
3764 int nmaps_allocated
= 0;
3766 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
3767 the current keymaps. */
3770 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3771 in the current keymaps, or nil where it is not a prefix. */
3772 Lisp_Object
*submaps
;
3774 /* The index in defs[] of the first keymap that has a binding for
3775 this key sequence. In other words, the lowest i such that
3776 defs[i] is non-nil. */
3779 /* If t < mock_input, then KEYBUF[t] should be read as the next
3782 We use this to recover after recognizing a function key. Once we
3783 realize that a suffix of the current key sequence is actually a
3784 function key's escape sequence, we replace the suffix with the
3785 function key's binding from Vfunction_key_map. Now keybuf
3786 contains a new and different key sequence, so the echo area,
3787 this_command_keys, and the submaps and defs arrays are wrong. In
3788 this situation, we set mock_input to t, set t to 0, and jump to
3789 restart_sequence; the loop will read keys from keybuf up until
3790 mock_input, thus rebuilding the state; and then it will resume
3791 reading characters from the keyboard. */
3794 /* If the sequence is unbound in submaps[], then
3795 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
3796 and fkey_map is its binding.
3798 These might be > t, indicating that all function key scanning
3799 should hold off until t reaches them. We do this when we've just
3800 recognized a function key, to avoid searching for the function
3801 key's again in Vfunction_key_map. */
3802 int fkey_start
= 0, fkey_end
= 0;
3803 Lisp_Object fkey_map
;
3805 /* Likewise, for key_translation_map. */
3806 int keytran_start
= 0, keytran_end
= 0;
3807 Lisp_Object keytran_map
;
3809 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
3810 we put it off for later. While we're reading, we keep the event here. */
3811 Lisp_Object delayed_switch_frame
;
3813 /* See the comment below... */
3814 #if defined (GOBBLE_FIRST_EVENT)
3815 Lisp_Object first_event
;
3818 struct buffer
*starting_buffer
;
3822 last_nonmenu_event
= Qnil
;
3824 delayed_switch_frame
= Qnil
;
3825 fkey_map
= Vfunction_key_map
;
3826 keytran_map
= Vkey_translation_map
;
3828 /* If there is no function-key-map, turn off function key scanning. */
3829 if (NILP (Fkeymapp (Vfunction_key_map
)))
3830 fkey_start
= fkey_end
= bufsize
+ 1;
3832 /* If there is no key-translation-map, turn off scanning. */
3833 if (NILP (Fkeymapp (Vkey_translation_map
)))
3834 keytran_start
= keytran_end
= bufsize
+ 1;
3839 echo_prompt (XSTRING (prompt
)->data
);
3840 else if (cursor_in_echo_area
)
3841 /* This doesn't put in a dash if the echo buffer is empty, so
3842 you don't always see a dash hanging out in the minibuffer. */
3846 /* Record the initial state of the echo area and this_command_keys;
3847 we will need to restore them if we replay a key sequence. */
3849 echo_start
= echo_length ();
3850 keys_start
= this_command_key_count
;
3852 #if defined (GOBBLE_FIRST_EVENT)
3853 /* This doesn't quite work, because some of the things that read_char
3854 does cannot safely be bypassed. It seems too risky to try to make
3857 /* Read the first char of the sequence specially, before setting
3858 up any keymaps, in case a filter runs and switches buffers on us. */
3859 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
3861 #endif /* GOBBLE_FIRST_EVENT */
3863 /* We jump here when the key sequence has been thoroughly changed, and
3864 we need to rescan it starting from the beginning. When we jump here,
3865 keybuf[0..mock_input] holds the sequence we should reread. */
3868 starting_buffer
= current_buffer
;
3870 /* Build our list of keymaps.
3871 If we recognize a function key and replace its escape sequence in
3872 keybuf with its symbol, or if the sequence starts with a mouse
3873 click and we need to switch buffers, we jump back here to rebuild
3874 the initial keymaps from the current buffer. */
3878 nmaps
= current_minor_maps (0, &maps
) + 2;
3879 if (nmaps
> nmaps_allocated
)
3881 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
3882 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
3883 nmaps_allocated
= nmaps
;
3885 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
3886 #ifdef USE_TEXT_PROPERTIES
3887 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3889 submaps
[nmaps
-2] = current_buffer
->keymap
;
3891 submaps
[nmaps
-1] = current_global_map
;
3894 /* Find an accurate initial value for first_binding. */
3895 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
3896 if (! NILP (submaps
[first_binding
]))
3899 /* Start from the beginning in keybuf. */
3902 /* These are no-ops the first time through, but if we restart, they
3903 revert the echo area and this_command_keys to their original state. */
3904 this_command_key_count
= keys_start
;
3906 echo_truncate (echo_start
);
3908 /* If the best binding for the current key sequence is a keymap, or
3909 we may be looking at a function key's escape sequence, keep on
3911 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
3912 || (first_binding
>= nmaps
3914 /* mock input is never part of a function key's sequence. */
3915 && mock_input
<= fkey_start
)
3916 || (first_binding
>= nmaps
3917 && keytran_start
< t
3918 /* mock input is never part of a function key's sequence. */
3919 && mock_input
<= keytran_start
))
3922 int used_mouse_menu
= 0;
3924 /* Where the last real key started. If we need to throw away a
3925 key that has expanded into more than one element of keybuf
3926 (say, a mouse click on the mode line which is being treated
3927 as [mode-line (mouse-...)], then we backtrack to this point
3929 int last_real_key_start
;
3931 /* These variables are analogous to echo_start and keys_start;
3932 while those allow us to restart the entire key sequence,
3933 echo_local_start and keys_local_start allow us to throw away
3935 int echo_local_start
, keys_local_start
, local_first_binding
;
3938 error ("key sequence too long");
3941 echo_local_start
= echo_length ();
3942 keys_local_start
= this_command_key_count
;
3943 local_first_binding
= first_binding
;
3946 /* These are no-ops, unless we throw away a keystroke below and
3947 jumped back up to replay_key; in that case, these restore the
3948 variables to their original state, allowing us to replay the
3951 echo_truncate (echo_local_start
);
3952 this_command_key_count
= keys_local_start
;
3953 first_binding
= local_first_binding
;
3955 /* By default, assume each event is "real". */
3956 last_real_key_start
= t
;
3958 /* Does mock_input indicate that we are re-reading a key sequence? */
3962 add_command_key (key
);
3966 /* If not, we should actually read a character. */
3969 struct buffer
*buf
= current_buffer
;
3971 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
3974 /* read_char returns t when it shows a menu and the user rejects it.
3979 /* read_char returns -1 at the end of a macro.
3980 Emacs 18 handles this by returning immediately with a
3981 zero, so that's what we'll do. */
3982 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) == -1)
3988 /* If we have a quit that was typed in another frame, and
3989 quit_throw_to_read_char switched buffers,
3990 replay to get the right keymap. */
3991 if (EQ (key
, quit_char
) && current_buffer
!= starting_buffer
)
3996 goto replay_sequence
;
4002 /* Clicks in non-text areas get prefixed by the symbol
4003 in their CHAR-ADDRESS field. For example, a click on
4004 the mode line is prefixed by the symbol `mode-line'.
4006 Furthermore, key sequences beginning with mouse clicks
4007 are read using the keymaps of the buffer clicked on, not
4008 the current buffer. So we may have to switch the buffer
4011 When we turn one event into two events, we must make sure
4012 that neither of the two looks like the original--so that,
4013 if we replay the events, they won't be expanded again.
4014 If not for this, such reexpansion could happen either here
4015 or when user programs play with this-command-keys. */
4016 if (EVENT_HAS_PARAMETERS (key
))
4018 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
4020 if (EQ (kind
, Qmouse_click
))
4022 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
4023 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4025 if (XTYPE (posn
) == Lisp_Cons
)
4027 /* We're looking at the second event of a
4028 sequence which we expanded before. Set
4029 last_real_key_start appropriately. */
4031 last_real_key_start
= t
- 1;
4034 /* Key sequences beginning with mouse clicks are
4035 read using the keymaps in the buffer clicked on,
4036 not the current buffer. If we're at the
4037 beginning of a key sequence, switch buffers. */
4038 if (last_real_key_start
== 0
4039 && XTYPE (window
) == Lisp_Window
4040 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
4041 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
4046 /* Arrange to go back to the original buffer once we're
4047 done reading the key sequence. Note that we can't
4048 use save_excursion_{save,restore} here, because they
4049 save point as well as the current buffer; we don't
4050 want to save point, because redisplay may change it,
4051 to accommodate a Fset_window_start or something. We
4052 don't want to do this at the top of the function,
4053 because we may get input from a subprocess which
4054 wants to change the selected window and stuff (say,
4056 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
4058 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
4059 goto replay_sequence
;
4061 else if (XTYPE (posn
) == Lisp_Symbol
)
4063 /* Expand mode-line and scroll-bar events into two events:
4064 use posn as a fake prefix key. */
4066 if (t
+ 1 >= bufsize
)
4067 error ("key sequence too long");
4072 /* Zap the position in key, so we know that we've
4073 expanded it, and don't try to do so again. */
4074 POSN_BUFFER_POSN (EVENT_START (key
))
4075 = Fcons (posn
, Qnil
);
4079 else if (EQ (kind
, Qswitch_frame
))
4081 /* If we're at the beginning of a key sequence, go
4082 ahead and return this event. If we're in the
4083 midst of a key sequence, delay it until the end. */
4086 delayed_switch_frame
= key
;
4092 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4094 /* Handle menu-bar events:
4095 insert the dummy prefix event `menu-bar'. */
4096 if (EQ (posn
, Qmenu_bar
))
4098 if (t
+ 1 >= bufsize
)
4099 error ("key sequence too long");
4100 /* Run the Lucid hook. */
4101 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4102 /* If it has changed current-menubar from previous value,
4103 really recompute the menubar from the value. */
4104 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4105 call0 (Qrecompute_lucid_menubar
);
4109 /* Zap the position in key, so we know that we've
4110 expanded it, and don't try to do so again. */
4111 POSN_BUFFER_POSN (EVENT_START (key
))
4112 = Fcons (posn
, Qnil
);
4115 goto replay_sequence
;
4117 else if (XTYPE (posn
) == Lisp_Cons
)
4119 /* We're looking at the second event of a
4120 sequence which we expanded before. Set
4121 last_real_key_start appropriately. */
4122 if (last_real_key_start
== t
&& t
> 0)
4123 last_real_key_start
= t
- 1;
4128 /* We have finally decided that KEY is something we might want
4130 first_binding
= (follow_key (key
,
4131 nmaps
- first_binding
,
4132 submaps
+ first_binding
,
4133 defs
+ first_binding
,
4134 submaps
+ first_binding
)
4137 /* If KEY wasn't bound, we'll try some fallbacks. */
4138 if (first_binding
>= nmaps
)
4140 Lisp_Object head
= EVENT_HEAD (key
);
4142 if (EQ (head
, Vhelp_char
))
4144 read_key_sequence_cmd
= Vprefix_help_command
;
4146 last_nonmenu_event
= key
;
4150 if (XTYPE (head
) == Lisp_Symbol
)
4152 Lisp_Object breakdown
= parse_modifiers (head
);
4153 int modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4155 /* Attempt to reduce an unbound mouse event to a simpler
4156 event that is bound:
4157 Drags reduce to clicks.
4158 Double-clicks reduce to clicks.
4159 Triple-clicks reduce to double-clicks, then to clicks.
4160 Down-clicks are eliminated.
4161 Double-downs reduce to downs, then are eliminated.
4162 Triple-downs reduce to double-downs, then to downs,
4163 then are eliminated. */
4164 if (modifiers
& (down_modifier
| drag_modifier
4165 | double_modifier
| triple_modifier
))
4167 while (modifiers
& (down_modifier
| drag_modifier
4168 | double_modifier
| triple_modifier
))
4170 Lisp_Object new_head
, new_click
;
4171 if (modifiers
& triple_modifier
)
4172 modifiers
^= (double_modifier
| triple_modifier
);
4173 else if (modifiers
& (drag_modifier
| double_modifier
))
4174 modifiers
&= ~(drag_modifier
| double_modifier
);
4177 /* Dispose of this `down' event by simply jumping
4178 back to replay_key, to get another event.
4180 Note that if this event came from mock input,
4181 then just jumping back to replay_key will just
4182 hand it to us again. So we have to wipe out any
4185 We could delete keybuf[t] and shift everything
4186 after that to the left by one spot, but we'd also
4187 have to fix up any variable that points into
4188 keybuf, and shifting isn't really necessary
4191 Adding prefixes for non-textual mouse clicks
4192 creates two characters of mock input, and both
4193 must be thrown away. If we're only looking at
4194 the prefix now, we can just jump back to
4195 replay_key. On the other hand, if we've already
4196 processed the prefix, and now the actual click
4197 itself is giving us trouble, then we've lost the
4198 state of the keymaps we want to backtrack to, and
4199 we need to replay the whole sequence to rebuild
4202 Beyond that, only function key expansion could
4203 create more than two keys, but that should never
4204 generate mouse events, so it's okay to zero
4205 mock_input in that case too.
4207 Isn't this just the most wonderful code ever? */
4208 if (t
== last_real_key_start
)
4215 mock_input
= last_real_key_start
;
4216 goto replay_sequence
;
4221 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
4223 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
4225 /* Look for a binding for this new key. follow_key
4226 promises that it didn't munge submaps the
4227 last time we called it, since key was unbound. */
4229 = (follow_key (new_click
,
4230 nmaps
- local_first_binding
,
4231 submaps
+ local_first_binding
,
4232 defs
+ local_first_binding
,
4233 submaps
+ local_first_binding
)
4234 + local_first_binding
);
4236 /* If that click is bound, go for it. */
4237 if (first_binding
< nmaps
)
4242 /* Otherwise, we'll leave key set to the drag event. */
4249 /* Normally, last_nonmenu_event gets the previous key we read.
4250 But when a mouse popup menu is being used,
4251 we don't update last_nonmenu_event; it continues to hold the mouse
4252 event that preceded the first level of menu. */
4253 if (!used_mouse_menu
)
4254 last_nonmenu_event
= key
;
4256 /* If the sequence is unbound, see if we can hang a function key
4257 off the end of it. We only want to scan real keyboard input
4258 for function key sequences, so if mock_input says that we're
4259 re-reading old events, don't examine it. */
4260 if (first_binding
>= nmaps
4263 Lisp_Object fkey_next
;
4265 /* Scan from fkey_end until we find a bound suffix. */
4266 while (fkey_end
< t
)
4270 key
= keybuf
[fkey_end
++];
4271 /* Look up meta-characters by prefixing them
4272 with meta_prefix_char. I hate this. */
4273 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4278 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
4280 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4283 fkey_next
= fkey_map
;
4286 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
4288 /* If the function key map gives a function, not an
4289 array, then call the function with no args and use
4290 its value instead. */
4291 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
4294 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4298 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4299 fkey_next
= call1 (fkey_next
, prompt
);
4301 /* If the function returned something invalid,
4302 barf--don't ignore it.
4303 (To ignore it safely, we would need to gcpro a bunch of
4304 other variables.) */
4305 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
4306 error ("Function in function-key-map returns invalid key sequence");
4309 /* If keybuf[fkey_start..fkey_end] is bound in the
4310 function key map and it's a suffix of the current
4311 sequence (i.e. fkey_end == t), replace it with
4312 the binding and restart with fkey_start at the end. */
4313 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
4316 int len
= XFASTINT (Flength (fkey_next
));
4318 t
= fkey_start
+ len
;
4320 error ("key sequence too long");
4322 if (VECTORP (fkey_next
))
4323 bcopy (XVECTOR (fkey_next
)->contents
,
4324 keybuf
+ fkey_start
,
4325 (t
- fkey_start
) * sizeof (keybuf
[0]));
4326 else if (STRINGP (fkey_next
))
4330 for (i
= 0; i
< len
; i
++)
4331 XFASTINT (keybuf
[fkey_start
+ i
])
4332 = XSTRING (fkey_next
)->data
[i
];
4336 fkey_start
= fkey_end
= t
;
4337 fkey_map
= Vfunction_key_map
;
4339 goto replay_sequence
;
4342 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
4344 /* If we no longer have a bound suffix, try a new positions for
4346 if (NILP (fkey_map
))
4348 fkey_end
= ++fkey_start
;
4349 fkey_map
= Vfunction_key_map
;
4354 /* Look for this sequence in key-translation-map. */
4356 Lisp_Object keytran_next
;
4358 /* Scan from keytran_end until we find a bound suffix. */
4359 while (keytran_end
< t
)
4363 key
= keybuf
[keytran_end
++];
4364 /* Look up meta-characters by prefixing them
4365 with meta_prefix_char. I hate this. */
4366 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4371 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
4373 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4376 keytran_next
= keytran_map
;
4379 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
4381 /* If the key translation map gives a function, not an
4382 array, then call the function with no args and use
4383 its value instead. */
4384 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
4385 && keytran_end
== t
)
4387 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4391 GCPRO3 (keytran_map
, keytran_map
, delayed_switch_frame
);
4392 keytran_next
= call1 (keytran_next
, prompt
);
4394 /* If the function returned something invalid,
4395 barf--don't ignore it.
4396 (To ignore it safely, we would need to gcpro a bunch of
4397 other variables.) */
4398 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
4399 error ("Function in function-key-map returns invalid key sequence");
4402 /* If keybuf[keytran_start..keytran_end] is bound in the
4403 key translation map and it's a suffix of the current
4404 sequence (i.e. keytran_end == t), replace it with
4405 the binding and restart with keytran_start at the end. */
4406 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
4407 && keytran_end
== t
)
4409 int len
= XFASTINT (Flength (keytran_next
));
4411 t
= keytran_start
+ len
;
4413 error ("key sequence too long");
4415 if (VECTORP (keytran_next
))
4416 bcopy (XVECTOR (keytran_next
)->contents
,
4417 keybuf
+ keytran_start
,
4418 (t
- keytran_start
) * sizeof (keybuf
[0]));
4419 else if (STRINGP (keytran_next
))
4423 for (i
= 0; i
< len
; i
++)
4424 XFASTINT (keybuf
[keytran_start
+ i
])
4425 = XSTRING (keytran_next
)->data
[i
];
4429 keytran_start
= keytran_end
= t
;
4430 keytran_map
= Vkey_translation_map
;
4432 goto replay_sequence
;
4435 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
4437 /* If we no longer have a bound suffix, try a new positions for
4439 if (NILP (keytran_map
))
4441 keytran_end
= ++keytran_start
;
4442 keytran_map
= Vkey_translation_map
;
4448 read_key_sequence_cmd
= (first_binding
< nmaps
4449 ? defs
[first_binding
]
4453 unread_switch_frame
= delayed_switch_frame
;
4454 unbind_to (count
, Qnil
);
4456 /* Occasionally we fabricate events, perhaps by expanding something
4457 according to function-key-map, or by adding a prefix symbol to a
4458 mouse click in the scroll bar or modeline. In this cases, return
4459 the entire generated key sequence, even if we hit an unbound
4460 prefix or a definition before the end. This means that you will
4461 be able to push back the event properly, and also means that
4462 read-key-sequence will always return a logical unit.
4465 for (; t
< mock_input
; t
++)
4467 echo_char (keybuf
[t
]);
4468 add_command_key (keybuf
[t
]);
4474 #if 0 /* This doc string is too long for some compilers.
4475 This commented-out definition serves for DOC. */
4476 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4477 "Read a sequence of keystrokes and return as a string or vector.\n\
4478 The sequence is sufficient to specify a non-prefix command in the\n\
4479 current local and global maps.\n\
4481 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
4482 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
4483 as a continuation of the previous key.\n\
4485 A C-g typed while in this function is treated like any other character,\n\
4486 and `quit-flag' is not set.\n\
4488 If the key sequence starts with a mouse click, then the sequence is read\n\
4489 using the keymaps of the buffer of the window clicked in, not the buffer\n\
4490 of the selected window as normal.\n\
4492 `read-key-sequence' drops unbound button-down events, since you normally\n\
4493 only care about the click or drag events which follow them. If a drag\n\
4494 or multi-click event is unbound, but the corresponding click event would\n\
4495 be bound, `read-key-sequence' turns the event into a click event at the\n\
4496 drag's starting position. This means that you don't have to distinguish\n\
4497 between click and drag, double, or triple events unless you want to.\n\
4499 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
4500 lines separating windows, and scroll bars with imaginary keys\n\
4501 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
4503 If the user switches frames in the middle of a key sequence, the\n\
4504 frame-switch event is put off until after the current key sequence.\n\
4506 `read-key-sequence' checks `function-key-map' for function key\n\
4507 sequences, where they wouldn't conflict with ordinary bindings. See\n\
4508 `function-key-map' for more details.")
4509 (prompt
, continue_echo
)
4512 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4514 (prompt
, continue_echo
)
4515 Lisp_Object prompt
, continue_echo
;
4517 Lisp_Object keybuf
[30];
4519 struct gcpro gcpro1
, gcpro2
;
4522 CHECK_STRING (prompt
, 0);
4525 bzero (keybuf
, sizeof keybuf
);
4527 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
4529 if (NILP (continue_echo
))
4530 this_command_key_count
= 0;
4532 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])), prompt
);
4540 return make_event_array (i
, keybuf
);
4543 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
4544 "Execute CMD as an editor command.\n\
4545 CMD must be a symbol that satisfies the `commandp' predicate.\n\
4546 Optional second arg RECORD-FLAG non-nil\n\
4547 means unconditionally put this command in `command-history'.\n\
4548 Otherwise, that is done only if an arg is read using the minibuffer.")
4550 Lisp_Object cmd
, record
;
4552 register Lisp_Object final
;
4553 register Lisp_Object tem
;
4554 Lisp_Object prefixarg
;
4555 struct backtrace backtrace
;
4556 extern int debug_on_next_call
;
4558 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
4559 Vcurrent_prefix_arg
= prefixarg
;
4560 debug_on_next_call
= 0;
4562 if (XTYPE (cmd
) == Lisp_Symbol
)
4564 tem
= Fget (cmd
, Qdisabled
);
4566 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
4571 final
= Findirect_function (cmd
);
4573 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
4574 do_autoload (final
, cmd
);
4579 if (XTYPE (final
) == Lisp_String
4580 || XTYPE (final
) == Lisp_Vector
)
4582 /* If requested, place the macro in the command history. For
4583 other sorts of commands, call-interactively takes care of
4587 = Fcons (Fcons (Qexecute_kbd_macro
,
4588 Fcons (final
, Fcons (prefixarg
, Qnil
))),
4591 return Fexecute_kbd_macro (final
, prefixarg
);
4593 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
4594 || XTYPE (final
) == Lisp_Compiled
)
4596 backtrace
.next
= backtrace_list
;
4597 backtrace_list
= &backtrace
;
4598 backtrace
.function
= &Qcall_interactively
;
4599 backtrace
.args
= &cmd
;
4600 backtrace
.nargs
= 1;
4601 backtrace
.evalargs
= 0;
4603 tem
= Fcall_interactively (cmd
, record
);
4605 backtrace_list
= backtrace
.next
;
4611 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
4613 "Read function name, then read its arguments and call it.")
4615 Lisp_Object prefixarg
;
4617 Lisp_Object function
;
4619 Lisp_Object saved_keys
;
4620 struct gcpro gcpro1
;
4622 saved_keys
= Fthis_command_keys ();
4624 GCPRO1 (saved_keys
);
4626 if (EQ (prefixarg
, Qminus
))
4628 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
4629 strcpy (buf
, "C-u ");
4630 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
4631 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
4632 else if (XTYPE (prefixarg
) == Lisp_Int
)
4633 sprintf (buf
, "%d ", XINT (prefixarg
));
4635 /* This isn't strictly correct if execute-extended-command
4636 is bound to anything else. Perhaps it should use
4637 this_command_keys? */
4638 strcat (buf
, "M-x ");
4640 /* Prompt with buf, and then read a string, completing from and
4641 restricting to the set of all defined commands. Don't provide
4642 any initial input. Save the command read on the extended-command
4644 function
= Fcompleting_read (build_string (buf
),
4645 Vobarray
, Qcommandp
,
4646 Qt
, Qnil
, Qextended_command_history
);
4648 /* Set this_command_keys to the concatenation of saved_keys and
4649 function, followed by a RET. */
4651 struct Lisp_String
*str
;
4655 this_command_key_count
= 0;
4657 str
= XSTRING (saved_keys
);
4658 for (i
= 0; i
< str
->size
; i
++)
4660 XFASTINT (tem
) = str
->data
[i
];
4661 add_command_key (tem
);
4664 str
= XSTRING (function
);
4665 for (i
= 0; i
< str
->size
; i
++)
4667 XFASTINT (tem
) = str
->data
[i
];
4668 add_command_key (tem
);
4671 XFASTINT (tem
) = '\015';
4672 add_command_key (tem
);
4677 function
= Fintern (function
, Qnil
);
4678 Vprefix_arg
= prefixarg
;
4679 this_command
= function
;
4681 return Fcommand_execute (function
, Qt
);
4685 detect_input_pending ()
4688 get_input_pending (&input_pending
);
4690 return input_pending
;
4693 /* This is called in some cases before a possible quit.
4694 It cases the next call to detect_input_pending to recompute input_pending.
4695 So calling this function unnecessarily can't do any harm. */
4696 clear_input_pending ()
4701 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
4702 "T if command input is currently available with no waiting.\n\
4703 Actually, the value is nil only if we can be sure that no input is available.")
4706 if (!NILP (unread_command_events
) || unread_command_char
!= -1)
4709 return detect_input_pending () ? Qt
: Qnil
;
4712 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
4713 "Return vector of last 100 events, not counting those from keyboard macros.")
4716 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
4719 if (total_keys
< NUM_RECENT_KEYS
)
4720 return Fvector (total_keys
, keys
);
4723 val
= Fvector (NUM_RECENT_KEYS
, keys
);
4724 bcopy (keys
+ recent_keys_index
,
4725 XVECTOR (val
)->contents
,
4726 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
4728 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
4729 recent_keys_index
* sizeof (Lisp_Object
));
4734 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
4735 "Return the key sequence that invoked this command.\n\
4736 The value is a string or a vector.")
4739 return make_event_array (this_command_key_count
,
4740 XVECTOR (this_command_keys
)->contents
);
4743 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
4744 "Return the current depth in recursive edits.")
4748 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
4752 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
4753 "FOpen dribble file: ",
4754 "Start writing all keyboard characters to a dribble file called FILE.\n\
4755 If FILE is nil, close any open dribble file.")
4766 file
= Fexpand_file_name (file
, Qnil
);
4767 dribble
= fopen (XSTRING (file
)->data
, "w");
4772 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
4773 "Discard the contents of the terminal input buffer.\n\
4774 Also cancel any kbd macro being defined.")
4777 defining_kbd_macro
= 0;
4778 update_mode_lines
++;
4780 unread_command_events
= Qnil
;
4781 unread_command_char
= -1;
4783 discard_tty_input ();
4785 /* Without the cast, GCC complains that this assignment loses the
4786 volatile qualifier of kbd_store_ptr. Is there anything wrong
4788 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
4789 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
4795 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
4796 "Stop Emacs and return to superior process. You can resume later.\n\
4797 On systems that don't have job control, run a subshell instead.\n\n\
4798 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
4799 to be read as terminal input by Emacs's parent, after suspension.\n\
4801 Before suspending, call the functions in `suspend-hook' with no args.\n\
4802 If any of them returns nil, don't call the rest and don't suspend.\n\
4803 Otherwise, suspend normally and after resumption run the normal hook\n\
4804 `suspend-resume-hook' if that is bound and non-nil.\n\
4806 Some operating systems cannot stop the Emacs process and resume it later.\n\
4807 On such systems, Emacs starts a subshell instead of suspending.")
4809 Lisp_Object stuffstring
;
4812 int count
= specpdl_ptr
- specpdl
;
4813 int old_height
, old_width
;
4815 struct gcpro gcpro1
, gcpro2
;
4816 extern init_sys_modes ();
4818 if (!NILP (stuffstring
))
4819 CHECK_STRING (stuffstring
, 0);
4821 /* Run the functions in suspend-hook. */
4822 if (!NILP (Vrun_hooks
))
4823 call1 (Vrun_hooks
, intern ("suspend-hook"));
4825 GCPRO1 (stuffstring
);
4826 get_frame_size (&old_width
, &old_height
);
4828 /* sys_suspend can get an error if it tries to fork a subshell
4829 and the system resources aren't available for that. */
4830 record_unwind_protect (init_sys_modes
, 0);
4831 stuff_buffered_input (stuffstring
);
4833 unbind_to (count
, Qnil
);
4835 /* Check if terminal/window size has changed.
4836 Note that this is not useful when we are running directly
4837 with a window system; but suspend should be disabled in that case. */
4838 get_frame_size (&width
, &height
);
4839 if (width
!= old_width
|| height
!= old_height
)
4840 change_frame_size (selected_frame
, height
, width
, 0, 0);
4842 /* Run suspend-resume-hook. */
4843 if (!NILP (Vrun_hooks
))
4844 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
4850 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
4851 Then in any case stuff anything Emacs has read ahead and not used. */
4853 stuff_buffered_input (stuffstring
)
4854 Lisp_Object stuffstring
;
4856 register unsigned char *p
;
4858 /* stuff_char works only in BSD, versions 4.2 and up. */
4861 if (XTYPE (stuffstring
) == Lisp_String
)
4865 p
= XSTRING (stuffstring
)->data
;
4866 count
= XSTRING (stuffstring
)->size
;
4871 /* Anything we have read ahead, put back for the shell to read. */
4872 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4874 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4875 kbd_fetch_ptr
= kbd_buffer
;
4876 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
4877 stuff_char (XINT (kbd_fetch_ptr
->code
));
4878 kbd_fetch_ptr
->kind
= no_event
;
4879 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
4886 #endif /* BSD and not BSD4_1 */
4889 set_waiting_for_input (time_to_clear
)
4890 EMACS_TIME
*time_to_clear
;
4892 input_available_clear_time
= time_to_clear
;
4894 /* Tell interrupt_signal to throw back to read_char, */
4895 waiting_for_input
= 1;
4897 /* If interrupt_signal was called before and buffered a C-g,
4898 make it run again now, to avoid timing error. */
4899 if (!NILP (Vquit_flag
))
4900 quit_throw_to_read_char ();
4902 /* If alarm has gone off already, echo now. */
4910 clear_waiting_for_input ()
4912 /* Tell interrupt_signal not to throw back to read_char, */
4913 waiting_for_input
= 0;
4914 input_available_clear_time
= 0;
4917 /* This routine is called at interrupt level in response to C-G.
4918 If interrupt_input, this is the handler for SIGINT.
4919 Otherwise, it is called from kbd_buffer_store_event,
4920 in handling SIGIO or SIGTINT.
4922 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
4923 immediately throw back to read_char.
4925 Otherwise it sets the Lisp variable quit-flag not-nil.
4926 This causes eval to throw, when it gets a chance.
4927 If quit-flag is already non-nil, it stops the job right away. */
4933 /* Must preserve main program's value of errno. */
4934 int old_errno
= errno
;
4937 /* USG systems forget handlers when they are used;
4938 must reestablish each time */
4939 signal (SIGINT
, interrupt_signal
);
4940 signal (SIGQUIT
, interrupt_signal
);
4945 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
4950 #ifdef SIGTSTP /* Support possible in later USG versions */
4952 * On systems which can suspend the current process and return to the original
4953 * shell, this command causes the user to end up back at the shell.
4954 * The "Auto-save" and "Abort" questions are not asked until
4955 * the user elects to return to emacs, at which point he can save the current
4956 * job and either dump core or continue.
4961 if (sys_suspend () == -1)
4963 printf ("Not running as a subprocess;\n");
4964 printf ("you can continue or abort.\n");
4967 /* Perhaps should really fork an inferior shell?
4968 But that would not provide any way to get back
4969 to the original shell, ever. */
4970 printf ("No support for stopping a process on this operating system;\n");
4971 printf ("you can continue or abort.\n");
4972 #endif /* not VMS */
4973 #endif /* not SIGTSTP */
4974 printf ("Auto-save? (y or n) ");
4976 if (((c
= getchar ()) & ~040) == 'Y')
4978 Fdo_auto_save (Qt
, Qnil
);
4979 printf ("Auto-save done\n");
4981 while (c
!= '\n') c
= getchar ();
4983 printf ("Abort (and enter debugger)? (y or n) ");
4985 printf ("Abort (and dump core)? (y or n) ");
4986 #endif /* not VMS */
4988 if (((c
= getchar ()) & ~040) == 'Y')
4990 while (c
!= '\n') c
= getchar ();
4991 printf ("Continuing...\n");
4997 /* If executing a function that wants to be interrupted out of
4998 and the user has not deferred quitting by binding `inhibit-quit'
4999 then quit right away. */
5000 if (immediate_quit
&& NILP (Vinhibit_quit
))
5004 Fsignal (Qquit
, Qnil
);
5007 /* Else request quit when it's safe */
5011 if (waiting_for_input
&& !echoing
)
5012 quit_throw_to_read_char ();
5017 /* Handle a C-g by making read_char return C-g. */
5019 quit_throw_to_read_char ()
5021 quit_error_check ();
5023 /* Prevent another signal from doing this before we finish. */
5024 clear_waiting_for_input ();
5027 unread_command_events
= Qnil
;
5028 unread_command_char
= -1;
5030 #ifdef POLL_FOR_INPUT
5031 /* May be > 1 if in recursive minibuffer. */
5032 if (poll_suppress_count
== 0)
5036 if (XFRAME (internal_last_event_frame
) != selected_frame
)
5037 Fhandle_switch_frame (make_lispy_switch_frame (internal_last_event_frame
));
5040 _longjmp (getcjmp
, 1);
5043 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
5044 "Set mode of reading keyboard input.\n\
5045 First arg INTERRUPT non-nil means use input interrupts;\n\
5046 nil means use CBREAK mode.\n\
5047 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
5048 (no effect except in CBREAK mode).\n\
5049 Third arg META t means accept 8-bit input (for a Meta key).\n\
5050 META nil means ignore the top bit, on the assumption it is parity.\n\
5051 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
5052 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
5053 See also `current-input-mode'.")
5054 (interrupt
, flow
, meta
, quit
)
5055 Lisp_Object interrupt
, flow
, meta
, quit
;
5058 && (XTYPE (quit
) != Lisp_Int
5059 || XINT (quit
) < 0 || XINT (quit
) > 0400))
5060 error ("set-input-mode: QUIT must be an ASCII character");
5062 #ifdef POLL_FOR_INPUT
5068 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5069 #ifdef NO_SOCK_SIGIO
5070 if (read_socket_hook
)
5071 interrupt_input
= 0; /* No interrupts if reading from a socket. */
5073 #endif /* NO_SOCK_SIGIO */
5074 interrupt_input
= !NILP (interrupt
);
5075 #else /* not SIGIO */
5076 interrupt_input
= 0;
5077 #endif /* not SIGIO */
5078 /* Our VMS input only works by interrupts, as of now. */
5080 interrupt_input
= 1;
5082 flow_control
= !NILP (flow
);
5085 else if (EQ (meta
, Qt
))
5090 /* Don't let this value be out of range. */
5091 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
5095 #ifdef POLL_FOR_INPUT
5096 poll_suppress_count
= 1;
5102 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
5103 "Return information about the way Emacs currently reads keyboard input.\n\
5104 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
5105 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
5106 nil, Emacs is using CBREAK mode.\n\
5107 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
5108 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
5109 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
5110 META nil means ignoring the top bit, on the assumption it is parity.\n\
5111 META is neither t nor nil if accepting 8-bit input and using\n\
5112 all 8 bits as the character code.\n\
5113 QUIT is the character Emacs currently uses to quit.\n\
5114 The elements of this list correspond to the arguments of\n\
5120 val
[0] = interrupt_input
? Qt
: Qnil
;
5121 val
[1] = flow_control
? Qt
: Qnil
;
5122 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
5123 XFASTINT (val
[3]) = quit_char
;
5125 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
5131 /* This is correct before outermost invocation of the editor loop */
5132 command_loop_level
= -1;
5134 quit_char
= Ctl ('g');
5135 unread_command_events
= Qnil
;
5136 unread_command_char
= -1;
5138 recent_keys_index
= 0;
5139 kbd_fetch_ptr
= kbd_buffer
;
5140 kbd_store_ptr
= kbd_buffer
;
5141 do_mouse_tracking
= 0;
5145 /* This means that command_loop_1 won't try to select anything the first
5147 internal_last_event_frame
= Qnil
;
5148 Vlast_event_frame
= internal_last_event_frame
;
5151 /* If we're running a dumped Emacs, we need to clear out
5152 kbd_buffer_frame_or_window, in case some events got into it
5155 If we're running an undumped Emacs, it hasn't been initialized by
5156 syms_of_keyboard yet. */
5158 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5160 if (!noninteractive
)
5162 signal (SIGINT
, interrupt_signal
);
5163 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
5164 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
5165 SIGQUIT and we can't tell which one it will give us. */
5166 signal (SIGQUIT
, interrupt_signal
);
5167 #endif /* HAVE_TERMIO */
5168 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5170 signal (SIGIO
, input_available_signal
);
5174 /* Use interrupt input by default, if it works and noninterrupt input
5175 has deficiencies. */
5177 #ifdef INTERRUPT_INPUT
5178 interrupt_input
= 1;
5180 interrupt_input
= 0;
5183 /* Our VMS input only works by interrupts, as of now. */
5185 interrupt_input
= 1;
5191 if (keyboard_init_hook
)
5192 (*keyboard_init_hook
) ();
5194 #ifdef POLL_FOR_INPUT
5195 poll_suppress_count
= 1;
5200 /* This type's only use is in syms_of_keyboard, to initialize the
5201 event header symbols and put properties on them. */
5208 struct event_head head_table
[] = {
5209 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
5210 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
5211 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
5216 Qdisabled_command_hook
= intern ("disabled-command-hook");
5217 staticpro (&Qdisabled_command_hook
);
5219 Qself_insert_command
= intern ("self-insert-command");
5220 staticpro (&Qself_insert_command
);
5222 Qforward_char
= intern ("forward-char");
5223 staticpro (&Qforward_char
);
5225 Qbackward_char
= intern ("backward-char");
5226 staticpro (&Qbackward_char
);
5228 Qdisabled
= intern ("disabled");
5229 staticpro (&Qdisabled
);
5231 Qundefined
= intern ("undefined");
5232 staticpro (&Qundefined
);
5234 Qpre_command_hook
= intern ("pre-command-hook");
5235 staticpro (&Qpre_command_hook
);
5237 Qpost_command_hook
= intern ("post-command-hook");
5238 staticpro (&Qpost_command_hook
);
5240 Qfunction_key
= intern ("function-key");
5241 staticpro (&Qfunction_key
);
5242 Qmouse_click
= intern ("mouse-click");
5243 staticpro (&Qmouse_click
);
5245 Qmenu_enable
= intern ("menu-enable");
5246 staticpro (&Qmenu_enable
);
5248 Qmode_line
= intern ("mode-line");
5249 staticpro (&Qmode_line
);
5250 Qvertical_line
= intern ("vertical-line");
5251 staticpro (&Qvertical_line
);
5252 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
5253 staticpro (&Qvertical_scroll_bar
);
5254 Qmenu_bar
= intern ("menu-bar");
5255 staticpro (&Qmenu_bar
);
5257 Qabove_handle
= intern ("above-handle");
5258 staticpro (&Qabove_handle
);
5259 Qhandle
= intern ("handle");
5260 staticpro (&Qhandle
);
5261 Qbelow_handle
= intern ("below-handle");
5262 staticpro (&Qbelow_handle
);
5264 Qevent_kind
= intern ("event-kind");
5265 staticpro (&Qevent_kind
);
5266 Qevent_symbol_elements
= intern ("event-symbol-elements");
5267 staticpro (&Qevent_symbol_elements
);
5268 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
5269 staticpro (&Qevent_symbol_element_mask
);
5270 Qmodifier_cache
= intern ("modifier-cache");
5271 staticpro (&Qmodifier_cache
);
5273 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
5274 staticpro (&Qrecompute_lucid_menubar
);
5275 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
5276 staticpro (&Qactivate_menubar_hook
);
5279 struct event_head
*p
;
5281 for (p
= head_table
;
5282 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
5285 *p
->var
= intern (p
->name
);
5287 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
5288 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
5292 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
5293 staticpro (&button_down_location
);
5297 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
5299 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
5300 for (i
= 0; i
< len
; i
++)
5301 if (modifier_names
[i
])
5302 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
5303 staticpro (&modifier_symbols
);
5306 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
5307 staticpro (&recent_keys
);
5309 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
5310 staticpro (&this_command_keys
);
5312 Qextended_command_history
= intern ("extended-command-history");
5313 Fset (Qextended_command_history
, Qnil
);
5314 staticpro (&Qextended_command_history
);
5316 kbd_buffer_frame_or_window
5317 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
5318 staticpro (&kbd_buffer_frame_or_window
);
5320 func_key_syms
= Qnil
;
5321 staticpro (&func_key_syms
);
5324 staticpro (&mouse_syms
);
5326 unread_switch_frame
= Qnil
;
5327 staticpro (&unread_switch_frame
);
5329 defsubr (&Sread_key_sequence
);
5330 defsubr (&Srecursive_edit
);
5331 defsubr (&Strack_mouse
);
5332 defsubr (&Sinput_pending_p
);
5333 defsubr (&Scommand_execute
);
5334 defsubr (&Srecent_keys
);
5335 defsubr (&Sthis_command_keys
);
5336 defsubr (&Ssuspend_emacs
);
5337 defsubr (&Sabort_recursive_edit
);
5338 defsubr (&Sexit_recursive_edit
);
5339 defsubr (&Srecursion_depth
);
5340 defsubr (&Stop_level
);
5341 defsubr (&Sdiscard_input
);
5342 defsubr (&Sopen_dribble_file
);
5343 defsubr (&Sset_input_mode
);
5344 defsubr (&Scurrent_input_mode
);
5345 defsubr (&Sexecute_extended_command
);
5347 DEFVAR_LISP ("last-command-char", &last_command_char
,
5348 "Last input event that was part of a command.");
5350 DEFVAR_LISP ("last-command-event", &last_command_char
,
5351 "Last input event that was part of a command.");
5353 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
5354 "Last input event in a command, except for mouse menu events.\n\
5355 Mouse menus give back keys that don't look like mouse events;\n\
5356 this variable holds the actual mouse event that led to the menu,\n\
5357 so that you can determine whether the command was run by mouse or not.");
5359 DEFVAR_LISP ("last-input-char", &last_input_char
,
5360 "Last input event.");
5362 DEFVAR_LISP ("last-input-event", &last_input_char
,
5363 "Last input event.");
5365 DEFVAR_LISP ("unread-command-events", &unread_command_events
,
5366 "List of objects to be read as next command input events.");
5368 DEFVAR_INT ("unread-command-char", &unread_command_char
,
5369 "If not -1, an object to be read as next command input event.");
5371 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
5372 "Meta-prefix character code. Meta-foo as command input\n\
5373 turns into this character followed by foo.");
5374 XSET (meta_prefix_char
, Lisp_Int
, 033);
5376 DEFVAR_LISP ("last-command", &last_command
,
5377 "The last command executed. Normally a symbol with a function definition,\n\
5378 but can be whatever was found in the keymap, or whatever the variable\n\
5379 `this-command' was set to by that command.");
5380 last_command
= Qnil
;
5382 DEFVAR_LISP ("this-command", &this_command
,
5383 "The command now being executed.\n\
5384 The command can set this variable; whatever is put here\n\
5385 will be in `last-command' during the following command.");
5386 this_command
= Qnil
;
5388 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
5389 "*Number of keyboard input characters between auto-saves.\n\
5390 Zero means disable autosaving due to number of characters typed.");
5391 auto_save_interval
= 300;
5393 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
5394 "*Number of seconds idle time before auto-save.\n\
5395 Zero or nil means disable auto-saving due to idleness.\n\
5396 After auto-saving due to this many seconds of idle time,\n\
5397 Emacs also does a garbage collection if that seems to be warranted.");
5398 XFASTINT (Vauto_save_timeout
) = 30;
5400 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
5401 "*Nonzero means echo unfinished commands after this many seconds of pause.");
5402 echo_keystrokes
= 1;
5404 DEFVAR_INT ("polling-period", &polling_period
,
5405 "*Interval between polling for input during Lisp execution.\n\
5406 The reason for polling is to make C-g work to stop a running program.\n\
5407 Polling is needed only when using X windows and SIGIO does not work.\n\
5408 Polling is automatically disabled in all other cases.");
5411 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
5412 "*Maximum time between mouse clicks to make a double-click.\n\
5413 Measured in milliseconds. nil means disable double-click recognition;\n\
5414 t means double-clicks have no time limit and are detected\n\
5415 by position only.");
5416 Vdouble_click_time
= make_number (500);
5418 DEFVAR_INT ("num-input-keys", &num_input_keys
,
5419 "*Number of complete keys read from the keyboard so far.");
5423 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
5424 "*The frame in which the most recently read event occurred.\n\
5425 If the last event came from a keyboard macro, this is set to `macro'.");
5426 Vlast_event_frame
= Qnil
;
5429 DEFVAR_LISP ("help-char", &Vhelp_char
,
5430 "Character to recognize as meaning Help.\n\
5431 When it is read, do `(eval help-form)', and display result if it's a string.\n\
5432 If the value of `help-form' is nil, this char can be read normally.");
5433 XSET (Vhelp_char
, Lisp_Int
, Ctl ('H'));
5435 DEFVAR_LISP ("help-form", &Vhelp_form
,
5436 "Form to execute when character `help-char' is read.\n\
5437 If the form returns a string, that string is displayed.\n\
5438 If `help-form' is nil, the help char is not recognized.");
5441 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
5442 "Command to run when `help-char' character follows a prefix key.\n\
5443 This command is used only when there is no actual binding\n\
5444 for that character after that prefix key.");
5445 Vprefix_help_command
= Qnil
;
5447 DEFVAR_LISP ("top-level", &Vtop_level
,
5448 "Form to evaluate when Emacs starts up.\n\
5449 Useful to set before you dump a modified Emacs.");
5452 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
5453 "String used as translate table for keyboard input, or nil.\n\
5454 Each character is looked up in this string and the contents used instead.\n\
5455 If string is of length N, character codes N and up are untranslated.");
5456 Vkeyboard_translate_table
= Qnil
;
5458 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
5459 "Keymap of key translations that can override keymaps.\n\
5460 This keymap works like `function-key-map', but comes after that,\n\
5461 and applies even for keys that have ordinary bindings.");
5462 Vkey_translation_map
= Qnil
;
5464 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
5465 "Non-nil means prompt with menus when appropriate.\n\
5466 This is done when reading from a keymap that has a prompt string,\n\
5467 for elements that have prompt strings.\n\
5468 The menu is displayed on the screen\n\
5469 if X menus were enabled at configuration\n\
5470 time and the previous event was a mouse click prefix key.\n\
5471 Otherwise, menu prompting uses the echo area.");
5474 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
5475 "Character to see next line of menu prompt.\n\
5476 Type this character while in a menu prompt to rotate around the lines of it.");
5477 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
5479 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
5480 "A mask of additional modifier keys to use with every keyboard character.\n\
5481 Emacs applies the modifiers of the character stored here to each keyboard\n\
5482 character it reads. For example, after evaluating the expression\n\
5483 (setq extra-keyboard-modifiers ?\C-x)\n\
5484 all input characters will have the control modifier applied to them.\n\
5486 Note that the character ?\C-@, equivalent to the integer zero, does\n\
5487 not count as a control character; rather, it counts as a character\n\
5488 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
5489 cancels any modification.");
5490 extra_keyboard_modifiers
= 0;
5492 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
5493 "If an editing command sets this to t, deactivate the mark afterward.\n\
5494 The command loop sets this to nil before each command,\n\
5495 and tests the value when the command returns.\n\
5496 Buffer modification stores t in this variable.");
5497 Vdeactivate_mark
= Qnil
;
5499 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
5500 "Normal hook run before each command is executed.");
5501 Vpre_command_hook
= Qnil
;
5503 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
5504 "Normal hook run after each command is executed.");
5505 Vpost_command_hook
= Qnil
;
5507 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
5508 "t means menu bar, specified Lucid style, needs to be recomputed.");
5509 Vlucid_menu_bar_dirty_flag
= Qnil
;
5511 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
5512 "List of menu bar items to move to the end of the menu bar.\n\
5513 The elements of the list are event types that may have menu bar bindings.");
5514 Vmenu_bar_final_items
= Qnil
;
5519 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
5520 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
5521 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
5522 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
5523 initial_define_key (meta_map
, 'x', "execute-extended-command");