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"
48 #include <sys/ioctl.h>
50 #endif /* not MSDOS */
52 #include "syssignal.h"
58 /* Variables for blockinput.h: */
60 /* Non-zero if interrupt input is blocked right now. */
61 int interrupt_input_blocked
;
63 /* Nonzero means an input interrupt has arrived
64 during the current critical section. */
65 int interrupt_input_pending
;
69 extern Lisp_Object Vmouse_grabbed
;
71 /* Make all keyboard buffers much bigger when using X windows. */
72 #define KBD_BUFFER_SIZE 4096
73 #else /* No X-windows, character input */
74 #define KBD_BUFFER_SIZE 256
75 #endif /* No X-windows */
77 /* Following definition copied from eval.c */
81 struct backtrace
*next
;
82 Lisp_Object
*function
;
83 Lisp_Object
*args
; /* Points to vector of args. */
84 int nargs
; /* length of vector. If nargs is UNEVALLED,
85 args points to slot holding list of
90 /* Non-nil disable property on a command means
91 do not execute it; call disabled-command-hook's value instead. */
92 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
94 #define NUM_RECENT_KEYS (100)
95 int recent_keys_index
; /* Index for storing next element into recent_keys */
96 int total_keys
; /* Total number of elements stored into recent_keys */
97 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
99 /* Vector holding the key sequence that invoked the current command.
100 It is reused for each command, and it may be longer than the current
101 sequence; this_command_key_count indicates how many elements
102 actually mean something.
103 It's easier to staticpro a single Lisp_Object than an array. */
104 Lisp_Object this_command_keys
;
105 int this_command_key_count
;
107 extern int minbuf_level
;
109 extern struct backtrace
*backtrace_list
;
111 /* Nonzero means do menu prompting. */
112 static int menu_prompting
;
114 /* Character to see next line of menu prompt. */
115 static Lisp_Object menu_prompt_more_char
;
117 /* For longjmp to where kbd input is being done. */
118 static jmp_buf getcjmp
;
120 /* True while doing kbd input. */
121 int waiting_for_input
;
123 /* True while displaying for echoing. Delays C-g throwing. */
126 /* Nonzero means C-g should cause immediate error-signal. */
129 /* Character to recognize as the help char. */
130 Lisp_Object Vhelp_char
;
132 /* Form to execute when help char is typed. */
133 Lisp_Object Vhelp_form
;
135 /* Command to run when the help character follows a prefix key. */
136 Lisp_Object Vprefix_help_command
;
138 /* List of items that should move to the end of the menu bar. */
139 Lisp_Object Vmenu_bar_final_items
;
141 /* Character that causes a quit. Normally C-g.
143 If we are running on an ordinary terminal, this must be an ordinary
144 ASCII char, since we want to make it our interrupt character.
146 If we are not running on an ordinary terminal, it still needs to be
147 an ordinary ASCII char. This character needs to be recognized in
148 the input interrupt handler. At this point, the keystroke is
149 represented as a struct input_event, while the desired quit
150 character is specified as a lispy event. The mapping from struct
151 input_events to lispy events cannot run in an interrupt handler,
152 and the reverse mapping is difficult for anything but ASCII
155 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
159 extern Lisp_Object current_global_map
;
160 extern int minibuf_level
;
162 /* If non-nil, this is a map that overrides all other local maps. */
163 Lisp_Object Voverriding_local_map
;
165 /* Current depth in recursive edits. */
166 int command_loop_level
;
168 /* Total number of times command_loop has read a key sequence. */
171 /* Last input character read as a command. */
172 Lisp_Object last_command_char
;
174 /* Last input character read as a command, not counting menus
175 reached by the mouse. */
176 Lisp_Object last_nonmenu_event
;
178 /* Last input character read for any purpose. */
179 Lisp_Object last_input_char
;
181 /* If not Qnil, a list of objects to be read as subsequent command input. */
182 Lisp_Object unread_command_events
;
184 /* If not -1, an event to be read as subsequent command input. */
185 int unread_command_char
;
187 /* If not Qnil, this is a switch-frame event which we decided to put
188 off until the end of a key sequence. This should be read as the
189 next command input, after any unread_command_events.
191 read_key_sequence uses this to delay switch-frame events until the
192 end of the key sequence; Fread_char uses it to put off switch-frame
193 events until a non-ASCII event is acceptable as input. */
194 Lisp_Object unread_switch_frame
;
196 /* A mask of extra modifier bits to put into every keyboard char. */
197 int extra_keyboard_modifiers
;
199 /* Char to use as prefix when a meta character is typed in.
200 This is bound on entry to minibuffer in case ESC is changed there. */
202 Lisp_Object meta_prefix_char
;
204 /* Last size recorded for a current buffer which is not a minibuffer. */
205 static int last_non_minibuf_size
;
207 /* Number of idle seconds before an auto-save and garbage collection. */
208 static Lisp_Object Vauto_save_timeout
;
210 /* Total number of times read_char has returned. */
213 /* Total number of times read_char has returned, outside of macros. */
214 int num_nonmacro_input_chars
;
216 /* Auto-save automatically when this many characters have been typed
217 since the last time. */
219 static int auto_save_interval
;
221 /* Value of num_nonmacro_input_chars as of last auto save. */
225 /* Last command executed by the editor command loop, not counting
226 commands that set the prefix argument. */
228 Lisp_Object last_command
;
230 /* The command being executed by the command loop.
231 Commands may set this, and the value set will be copied into last_command
232 instead of the actual command. */
233 Lisp_Object this_command
;
236 /* The frame in which the last input event occurred, or Qmacro if the
237 last event came from a macro. We use this to determine when to
238 generate switch-frame events. This may be cleared by functions
239 like Fselect_frame, to make sure that a switch-frame event is
240 generated by the next character. */
241 Lisp_Object internal_last_event_frame
;
243 /* A user-visible version of the above, intended to allow users to
244 figure out where the last event came from, if the event doesn't
245 carry that information itself (i.e. if it was a character). */
246 Lisp_Object Vlast_event_frame
;
249 /* The timestamp of the last input event we received from the X server.
250 X Windows wants this for selection ownership. */
251 unsigned long last_event_timestamp
;
253 Lisp_Object Qself_insert_command
;
254 Lisp_Object Qforward_char
;
255 Lisp_Object Qbackward_char
;
256 Lisp_Object Qundefined
;
258 /* read_key_sequence stores here the command definition of the
259 key sequence that it reads. */
260 Lisp_Object read_key_sequence_cmd
;
262 /* Form to evaluate (if non-nil) when Emacs is started. */
263 Lisp_Object Vtop_level
;
265 /* User-supplied string to translate input characters through. */
266 Lisp_Object Vkeyboard_translate_table
;
268 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
269 extern Lisp_Object Vfunction_key_map
;
271 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
272 Lisp_Object Vkey_translation_map
;
274 /* Non-nil means deactivate the mark at end of this command. */
275 Lisp_Object Vdeactivate_mark
;
277 /* Menu bar specified in Lucid Emacs fashion. */
279 Lisp_Object Vlucid_menu_bar_dirty_flag
;
280 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
282 /* Hooks to run before and after each command. */
283 Lisp_Object Qpre_command_hook
, Qpost_command_hook
;
284 Lisp_Object Vpre_command_hook
, Vpost_command_hook
;
285 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
287 /* File in which we write all commands we read. */
290 /* Nonzero if input is available. */
293 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
294 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
298 extern char *pending_malloc_warning
;
300 /* Circular buffer for pre-read keyboard input. */
301 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
303 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
305 The interrupt-level event handlers will never enqueue an event on a
306 frame which is not in Vframe_list, and once an event is dequeued,
307 internal_last_event_frame or the event itself points to the frame.
310 But while the event is sitting in the queue, it's completely
311 unprotected. Suppose the user types one command which will run for
312 a while and then delete a frame, and then types another event at
313 the frame that will be deleted, before the command gets around to
314 it. Suppose there are no references to this frame elsewhere in
315 Emacs, and a GC occurs before the second event is dequeued. Now we
316 have an event referring to a freed frame, which will crash Emacs
319 Similar things happen when an event on a scroll bar is enqueued; the
320 window may be deleted while the event is in the queue.
322 So, we use this vector to protect the frame_or_window field in the
323 event queue. That way, they'll be dequeued as dead frames or
324 windows, but still valid lisp objects.
326 If kbd_buffer[i].kind != no_event, then
327 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
328 == kbd_buffer[i].frame_or_window. */
329 static Lisp_Object kbd_buffer_frame_or_window
;
331 /* Pointer to next available character in kbd_buffer.
332 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
333 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
334 next available char is in kbd_buffer[0]. */
335 static struct input_event
*kbd_fetch_ptr
;
337 /* Pointer to next place to store character in kbd_buffer. This
338 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
339 character should go in kbd_buffer[0]. */
343 static struct input_event
*kbd_store_ptr
;
345 /* The above pair of variables forms a "queue empty" flag. When we
346 enqueue a non-hook event, we increment kbd_write_count. When we
347 dequeue a non-hook event, we increment kbd_read_count. We say that
348 there is input available iff the two counters are not equal.
350 Why not just have a flag set and cleared by the enqueuing and
351 dequeuing functions? Such a flag could be screwed up by interrupts
352 at inopportune times. */
354 /* If this flag is non-zero, we check mouse_moved to see when the
355 mouse moves, and motion events will appear in the input stream. If
356 it is zero, mouse motion is ignored. */
357 static int do_mouse_tracking
;
359 /* The window system handling code should set this if the mouse has
360 moved since the last call to the mouse_position_hook. Calling that
361 hook should clear this. Code assumes that if this is set, it can
362 call mouse_position_hook to get the promised position, so don't set
363 it unless you're prepared to substantiate the claim! */
366 /* True iff there is an event in kbd_buffer, or if mouse tracking is
367 enabled and there is a new mouse position in the mouse movement
368 buffer. Note that if this is false, that doesn't mean that there
369 is readable input; all the events in the queue might be button-up
370 events, and do_mouse_tracking might be off. */
371 #define EVENT_QUEUES_EMPTY \
372 ((kbd_fetch_ptr == kbd_store_ptr) && (!do_mouse_tracking || !mouse_moved))
375 /* Symbols to head events. */
376 Lisp_Object Qmouse_movement
;
377 Lisp_Object Qscroll_bar_movement
;
378 Lisp_Object Qswitch_frame
;
380 /* Symbols to denote kinds of events. */
381 Lisp_Object Qfunction_key
;
382 Lisp_Object Qmouse_click
;
383 /* Lisp_Object Qmouse_movement; - also an event header */
385 /* Properties of event headers. */
386 Lisp_Object Qevent_kind
;
387 Lisp_Object Qevent_symbol_elements
;
389 Lisp_Object Qmenu_enable
;
391 /* An event header symbol HEAD may have a property named
392 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
393 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
394 mask of modifiers applied to it. If present, this is used to help
395 speed up parse_modifiers. */
396 Lisp_Object Qevent_symbol_element_mask
;
398 /* An unmodified event header BASE may have a property named
399 Qmodifier_cache, which is an alist mapping modifier masks onto
400 modified versions of BASE. If present, this helps speed up
402 Lisp_Object Qmodifier_cache
;
404 /* Symbols to use for parts of windows. */
405 Lisp_Object Qmode_line
;
406 Lisp_Object Qvertical_line
;
407 Lisp_Object Qvertical_scroll_bar
;
408 Lisp_Object Qmenu_bar
;
410 extern Lisp_Object Qmenu_enable
;
412 Lisp_Object
recursive_edit_unwind (), command_loop ();
413 Lisp_Object
Fthis_command_keys ();
414 Lisp_Object Qextended_command_history
;
416 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
418 EMACS_TIME
*input_available_clear_time
;
420 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
421 Default is 1 if INTERRUPT_INPUT is defined. */
424 /* Nonzero while interrupts are temporarily deferred during redisplay. */
425 int interrupts_deferred
;
427 /* nonzero means use ^S/^Q for flow control. */
430 /* Allow m- file to inhibit use of FIONREAD. */
431 #ifdef BROKEN_FIONREAD
435 /* We are unable to use interrupts if FIONREAD is not available,
436 so flush SIGIO so we won't try. */
443 /* If we support X Windows, turn on the code to poll periodically
444 to detect C-g. It isn't actually used when doing interrupt input. */
445 #ifdef HAVE_X_WINDOWS
446 #define POLL_FOR_INPUT
449 /* Global variable declarations. */
451 /* Function for init_keyboard to call with no args (if nonzero). */
452 void (*keyboard_init_hook
) ();
454 static int read_avail_input ();
455 static void get_input_pending ();
456 static int readable_events ();
457 static Lisp_Object
read_char_x_menu_prompt ();
458 static Lisp_Object
read_char_minibuf_menu_prompt ();
459 static Lisp_Object
make_lispy_event ();
460 static Lisp_Object
make_lispy_movement ();
461 static Lisp_Object
modify_event_symbol ();
462 static Lisp_Object
make_lispy_switch_frame ();
464 /* > 0 if we are to echo keystrokes. */
465 static int echo_keystrokes
;
467 /* Nonzero means echo each character as typed. */
468 static int immediate_echo
;
470 /* The text we're echoing in the modeline - partial key sequences,
471 usually. '\0'-terminated. This really shouldn't have a fixed size. */
472 static char echobuf
[300];
474 /* Where to append more text to echobuf if we want to. */
475 static char *echoptr
;
477 /* Nonzero means don't try to suspend even if the operating system seems
479 static int cannot_suspend
;
481 #define min(a,b) ((a)<(b)?(a):(b))
482 #define max(a,b) ((a)>(b)?(a):(b))
484 /* Install the string STR as the beginning of the string of echoing,
485 so that it serves as a prompt for the next character.
486 Also start echoing. */
491 int len
= strlen (str
);
492 if (len
> sizeof echobuf
- 4)
493 len
= sizeof echobuf
- 4;
494 bcopy (str
, echobuf
, len
);
495 echoptr
= echobuf
+ len
;
501 /* Add C to the echo string, if echoing is going on.
502 C can be a character, which is printed prettily ("M-C-x" and all that
503 jazz), or a symbol, whose name is printed. */
508 extern char *push_key_description ();
517 /* If someone has passed us a composite event, use its head symbol. */
520 if (XTYPE (c
) == Lisp_Int
)
522 if (ptr
- echobuf
> sizeof echobuf
- 6)
525 ptr
= push_key_description (XINT (c
), ptr
);
527 else if (XTYPE (c
) == Lisp_Symbol
)
529 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
530 if (((ptr
- echobuf
) + name
->size
+ 4) > sizeof echobuf
)
532 bcopy (name
->data
, ptr
, name
->size
);
536 if (echoptr
== echobuf
&& EQ (c
, Vhelp_char
))
538 strcpy (ptr
, " (Type ? for further options)");
549 /* Temporarily add a dash to the end of the echo string if it's not
550 empty, so that it serves as a mini-prompt for the very next character. */
554 if (!immediate_echo
&& echoptr
== echobuf
)
556 /* Do nothing if not echoing at all. */
560 /* Put a dash at the end of the buffer temporarily,
561 but make it go away when the next character is added. */
568 /* Display the current echo string, and begin echoing if not already
578 for (i
= 0; i
< this_command_key_count
; i
++)
579 echo_char (XVECTOR (this_command_keys
)->contents
[i
]);
587 if (waiting_for_input
&& !NILP (Vquit_flag
))
588 quit_throw_to_read_char ();
591 /* Turn off echoing, for the start of a new command. */
599 /* Return the length of the current echo string. */
604 return echoptr
- echobuf
;
607 /* Truncate the current echo message to its first LEN chars.
608 This and echo_char get used by read_key_sequence when the user
609 switches frames while entering a key sequence. */
616 echoptr
= echobuf
+ len
;
617 truncate_echo_area (len
);
621 /* Functions for manipulating this_command_keys. */
623 add_command_key (key
)
626 int size
= XVECTOR (this_command_keys
)->size
;
628 if (this_command_key_count
>= size
)
630 Lisp_Object new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
632 bcopy (XVECTOR (this_command_keys
)->contents
,
633 XVECTOR (new_keys
)->contents
,
634 size
* sizeof (Lisp_Object
));
636 this_command_keys
= new_keys
;
639 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
645 int count
= specpdl_ptr
- specpdl
;
648 if (command_loop_level
> 0)
650 specbind (Qstandard_output
, Qt
);
651 specbind (Qstandard_input
, Qt
);
654 val
= command_loop ();
656 Fsignal (Qquit
, Qnil
);
658 return unbind_to (count
, Qnil
);
661 /* When an auto-save happens, record the "time", and don't do again soon. */
664 last_auto_save
= num_nonmacro_input_chars
;
667 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
668 "Invoke the editor command loop recursively.\n\
669 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
670 that tells this function to return.\n\
671 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
672 This function is called by the editor initialization to begin editing.")
675 int count
= specpdl_ptr
- specpdl
;
678 command_loop_level
++;
679 update_mode_lines
= 1;
681 record_unwind_protect (recursive_edit_unwind
,
683 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
687 return unbind_to (count
, Qnil
);
691 recursive_edit_unwind (buffer
)
695 Fset_buffer (buffer
);
697 command_loop_level
--;
698 update_mode_lines
= 1;
706 Lisp_Object errmsg
, tail
, errname
, file_error
;
713 Vstandard_output
= Qt
;
714 Vstandard_input
= Qt
;
715 Vexecuting_macro
= Qnil
;
716 echo_area_glyphs
= 0;
718 /* If the window system or terminal frame hasn't been initialized
719 yet, or we're not interactive, it's best to dump this message out
720 to stderr and exit. */
721 if (! FRAME_MESSAGE_BUF (selected_frame
)
723 stream
= Qexternal_debugging_output
;
731 errname
= Fcar (data
);
733 if (EQ (errname
, Qerror
))
736 if (!CONSP (data
)) data
= Qnil
;
737 errmsg
= Fcar (data
);
742 errmsg
= Fget (errname
, Qerror_message
);
743 file_error
= Fmemq (Qfile_error
,
744 Fget (errname
, Qerror_conditions
));
747 /* Print an error message including the data items.
748 This is done by printing it into a scratch buffer
749 and then making a copy of the text in the buffer. */
751 if (!CONSP (data
)) data
= Qnil
;
755 /* For file-error, make error message by concatenating
756 all the data items. They are all strings. */
757 if (!NILP (file_error
) && !NILP (tail
))
758 errmsg
= XCONS (tail
)->car
, tail
= XCONS (tail
)->cdr
;
760 if (XTYPE (errmsg
) == Lisp_String
)
761 Fprinc (errmsg
, stream
);
763 write_string_1 ("peculiar error", -1, stream
);
765 for (i
= 0; CONSP (tail
); tail
= Fcdr (tail
), i
++)
767 write_string_1 (i
? ", " : ": ", 2, stream
);
768 if (!NILP (file_error
))
769 Fprinc (Fcar (tail
), stream
);
771 Fprin1 (Fcar (tail
), stream
);
775 /* If the window system or terminal frame hasn't been initialized
776 yet, or we're in -batch mode, this error should cause Emacs to exit. */
777 if (! FRAME_MESSAGE_BUF (selected_frame
)
781 Fkill_emacs (make_number (-1));
786 Vinhibit_quit
= Qnil
;
787 return make_number (0);
790 Lisp_Object
command_loop_1 ();
791 Lisp_Object
command_loop_2 ();
792 Lisp_Object
top_level_1 ();
794 /* Entry to editor-command-loop.
795 This level has the catches for exiting/returning to editor command loop.
796 It returns nil to exit recursive edit, t to abort it. */
801 if (command_loop_level
> 0 || minibuf_level
> 0)
803 return internal_catch (Qexit
, command_loop_2
, Qnil
);
808 internal_catch (Qtop_level
, top_level_1
, Qnil
);
809 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
811 /* End of file in -batch run causes exit here. */
817 /* Here we catch errors in execution of commands within the
818 editing loop, and reenter the editing loop.
819 When there is an error, cmd_error runs and returns a non-nil
820 value to us. A value of nil means that cmd_loop_1 itself
821 returned due to end of file (or end of kbd macro). */
826 register Lisp_Object val
;
829 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
838 return Feval (Vtop_level
);
844 /* On entry to the outer level, run the startup file */
845 if (!NILP (Vtop_level
))
846 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
847 else if (!NILP (Vpurify_flag
))
848 message ("Bare impure Emacs (standard Lisp code not loaded)");
850 message ("Bare Emacs (standard Lisp code not loaded)");
854 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
855 "Exit all recursive editing levels.")
858 Fthrow (Qtop_level
, Qnil
);
861 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
862 "Exit from the innermost recursive edit or minibuffer.")
865 if (command_loop_level
> 0 || minibuf_level
> 0)
866 Fthrow (Qexit
, Qnil
);
868 error ("No recursive edit is in progress");
871 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
872 "Abort the command that requested this recursive edit or minibuffer input.")
875 if (command_loop_level
> 0 || minibuf_level
> 0)
878 error ("No recursive edit is in progress");
881 /* This is the actual command reading loop,
882 sans error-handling encapsulation. */
884 Lisp_Object
Fcommand_execute ();
885 static int read_key_sequence ();
890 Lisp_Object cmd
, tem
;
893 Lisp_Object keybuf
[30];
898 struct buffer
*prev_buffer
;
901 Vdeactivate_mark
= Qnil
;
902 waiting_for_input
= 0;
907 this_command_key_count
= 0;
908 last_command
= this_command
;
910 /* Make sure this hook runs after commands that get errors and
911 throw to top level. */
912 if (!NILP (Vpost_command_hook
))
914 /* If we get an error during the post-command-hook,
915 cause post-command-hook to be nil. */
916 Vcommand_hook_internal
= Vpost_command_hook
;
917 Vpost_command_hook
= Qnil
;
919 call1 (Vrun_hooks
, Qcommand_hook_internal
);
921 Vpost_command_hook
= Vcommand_hook_internal
;
926 /* Install chars successfully executed in kbd macro. */
928 if (defining_kbd_macro
&& NILP (Vprefix_arg
))
929 finalize_kbd_macro_chars ();
931 /* Make sure the current window's buffer is selected. */
932 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
933 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
935 /* Display any malloc warning that just came out. Use while because
936 displaying one warning can cause another. */
938 while (pending_malloc_warning
)
939 display_malloc_warning ();
943 Vdeactivate_mark
= Qnil
;
945 /* If minibuffer on and echo area in use,
946 wait 2 sec and redraw minibuffer. */
948 if (minibuf_level
&& echo_area_glyphs
)
950 /* Bind inhibit-quit to t so that C-g gets read in
951 rather than quitting back to the minibuffer. */
952 int count
= specpdl_ptr
- specpdl
;
953 specbind (Qinhibit_quit
, Qt
);
954 Fsit_for (make_number (2), Qnil
, Qnil
);
955 unbind_to (count
, Qnil
);
957 echo_area_glyphs
= 0;
959 if (!NILP (Vquit_flag
))
962 unread_command_events
= Fcons (make_number (quit_char
), Qnil
);
967 alloca (0); /* Cause a garbage collection now */
968 /* Since we can free the most stuff here. */
969 #endif /* C_ALLOCA */
973 /* Select the frame that the last event came from. Usually,
974 switch-frame events will take care of this, but if some lisp
975 code swallows a switch-frame event, we'll fix things up here.
976 Is this a good idea? */
977 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
978 && XFRAME (internal_last_event_frame
) != selected_frame
)
979 Fselect_frame (internal_last_event_frame
, Qnil
);
982 /* If it has changed current-menubar from previous value,
983 really recompute the menubar from the value. */
984 if (! NILP (Vlucid_menu_bar_dirty_flag
)
985 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
986 call0 (Qrecompute_lucid_menubar
);
988 /* Read next key sequence; i gets its length. */
989 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), Qnil
);
993 /* Now we have read a key sequence of length I,
994 or else I is 0 and we found end of file. */
996 if (i
== 0) /* End of file -- happens only in */
997 return Qnil
; /* a kbd macro, at the end. */
998 /* -1 means read_key_sequence got a menu that was rejected.
999 Just loop around and read another command. */
1003 this_command_key_count
= 0;
1007 last_command_char
= keybuf
[i
- 1];
1009 /* If the previous command tried to force a specific window-start,
1010 forget about that, in case this command moves point far away
1011 from that position. */
1012 XWINDOW (selected_window
)->force_start
= Qnil
;
1014 cmd
= read_key_sequence_cmd
;
1015 if (!NILP (Vexecuting_macro
))
1017 if (!NILP (Vquit_flag
))
1019 Vexecuting_macro
= Qt
;
1020 QUIT
; /* Make some noise. */
1021 /* Will return since macro now empty. */
1025 /* Do redisplay processing after this command except in special
1026 cases identified below that set no_redisplay to 1.
1027 (actually, there's currently no way to prevent the redisplay,
1028 and no_redisplay is ignored.
1029 Perhaps someday we will really implement it. */
1032 prev_buffer
= current_buffer
;
1033 prev_modiff
= MODIFF
;
1035 /* Execute the command. */
1038 if (!NILP (Vpre_command_hook
))
1040 /* If we get an error during the pre-command-hook,
1041 cause pre-command-hook to be nil. */
1042 Vcommand_hook_internal
= Vpre_command_hook
;
1043 Vpre_command_hook
= Qnil
;
1045 call1 (Vrun_hooks
, Qcommand_hook_internal
);
1047 Vpre_command_hook
= Vcommand_hook_internal
;
1050 if (NILP (this_command
))
1052 /* nil means key is undefined. */
1054 defining_kbd_macro
= 0;
1055 update_mode_lines
= 1;
1061 if (NILP (Vprefix_arg
) && ! no_direct
)
1063 /* Recognize some common commands in common situations and
1064 do them directly. */
1065 if (EQ (this_command
, Qforward_char
) && point
< ZV
)
1067 struct Lisp_Vector
*dp
1068 = window_display_table (XWINDOW (selected_window
));
1069 lose
= FETCH_CHAR (point
);
1072 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1073 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1074 : (lose
>= 0x20 && lose
< 0x7f))
1075 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1077 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1079 && !windows_or_buffers_changed
1080 && EQ (current_buffer
->selective_display
, Qnil
)
1081 && !detect_input_pending ()
1082 && NILP (Vexecuting_macro
))
1083 no_redisplay
= direct_output_forward_char (1);
1086 else if (EQ (this_command
, Qbackward_char
) && point
> BEGV
)
1088 struct Lisp_Vector
*dp
1089 = window_display_table (XWINDOW (selected_window
));
1091 lose
= FETCH_CHAR (point
);
1093 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1094 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1095 : (lose
>= 0x20 && lose
< 0x7f))
1096 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1098 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1100 && !windows_or_buffers_changed
1101 && EQ (current_buffer
->selective_display
, Qnil
)
1102 && !detect_input_pending ()
1103 && NILP (Vexecuting_macro
))
1104 no_redisplay
= direct_output_forward_char (-1);
1107 else if (EQ (this_command
, Qself_insert_command
)
1108 /* Try this optimization only on ascii keystrokes. */
1109 && XTYPE (last_command_char
) == Lisp_Int
)
1111 unsigned char c
= XINT (last_command_char
);
1113 if (NILP (Vexecuting_macro
) &&
1114 !EQ (minibuf_window
, selected_window
))
1116 if (!nonundocount
|| nonundocount
>= 20)
1123 lose
= (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1125 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1127 || MODIFF
<= current_buffer
->save_modified
1128 || windows_or_buffers_changed
1129 || !EQ (current_buffer
->selective_display
, Qnil
)
1130 || detect_input_pending ()
1131 || !NILP (Vexecuting_macro
);
1132 if (internal_self_insert (c
, 0))
1138 (point
== ZV
|| FETCH_CHAR (point
) == '\n'))
1140 struct Lisp_Vector
*dp
1141 = window_display_table (XWINDOW (selected_window
));
1146 Lisp_Object obj
= DISP_CHAR_VECTOR (dp
, lose
);
1148 if (XTYPE (obj
) == Lisp_Vector
1149 && XVECTOR (obj
)->size
== 1
1150 && (XTYPE (obj
= XVECTOR (obj
)->contents
[0])
1153 direct_output_for_insert (XINT (obj
));
1157 if (lose
>= 0x20 && lose
<= 0x7e)
1158 no_redisplay
= direct_output_for_insert (lose
);
1165 /* Here for a command that isn't executed directly */
1168 if (NILP (Vprefix_arg
))
1170 Fcommand_execute (this_command
, Qnil
);
1175 if (!NILP (Vpost_command_hook
))
1177 /* If we get an error during the post-command-hook,
1178 cause post-command-hook to be nil. */
1179 Vcommand_hook_internal
= Vpost_command_hook
;
1180 Vpost_command_hook
= Qnil
;
1182 call1 (Vrun_hooks
, Qcommand_hook_internal
);
1184 Vpost_command_hook
= Vcommand_hook_internal
;
1187 /* If there is a prefix argument,
1188 1) We don't want last_command to be ``universal-argument''
1189 (that would be dumb), so don't set last_command,
1190 2) we want to leave echoing on so that the prefix will be
1191 echoed as part of this key sequence, so don't call
1193 3) we want to leave this_command_key_count non-zero, so that
1194 read_char will realize that it is re-reading a character, and
1195 not echo it a second time. */
1196 if (NILP (Vprefix_arg
))
1198 last_command
= this_command
;
1200 this_command_key_count
= 0;
1203 if (!NILP (current_buffer
->mark_active
))
1205 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1207 current_buffer
->mark_active
= Qnil
;
1208 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1210 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1211 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1216 /* Number of seconds between polling for input. */
1219 /* Nonzero means polling for input is temporarily suppressed. */
1220 int poll_suppress_count
;
1222 #ifdef POLL_FOR_INPUT
1223 int polling_for_input
;
1225 /* Handle an alarm once each second and read pending input
1226 so as to handle a C-g if it comces in. */
1229 input_poll_signal ()
1231 if (interrupt_input_blocked
== 0
1232 && !waiting_for_input
)
1233 read_avail_input (0);
1234 signal (SIGALRM
, input_poll_signal
);
1235 alarm (polling_period
);
1240 /* Begin signals to poll for input, if they are appropriate.
1241 This function is called unconditionally from various places. */
1245 #ifdef POLL_FOR_INPUT
1246 if (read_socket_hook
&& !interrupt_input
)
1248 poll_suppress_count
--;
1249 if (poll_suppress_count
== 0)
1251 signal (SIGALRM
, input_poll_signal
);
1252 polling_for_input
= 1;
1253 alarm (polling_period
);
1259 /* Turn off polling. */
1263 #ifdef POLL_FOR_INPUT
1264 if (read_socket_hook
&& !interrupt_input
)
1266 if (poll_suppress_count
== 0)
1268 polling_for_input
= 0;
1271 poll_suppress_count
++;
1276 /* Set the value of poll_suppress_count to COUNT
1277 and start or stop polling accordingly. */
1280 set_poll_suppress_count (count
)
1283 #ifdef POLL_FOR_INPUT
1284 if (count
== 0 && poll_suppress_count
!= 0)
1286 poll_suppress_count
= 1;
1289 else if (count
!= 0 && poll_suppress_count
== 0)
1293 poll_suppress_count
= count
;
1297 /* Applying the control modifier to CHARACTER. */
1302 /* Save the upper bits here. */
1303 int upper
= c
& ~0177;
1307 /* Everything in the columns containing the upper-case letters
1308 denotes a control character. */
1309 if (c
>= 0100 && c
< 0140)
1313 /* Set the shift modifier for a control char
1314 made from a shifted letter. But only for letters! */
1315 if (oc
>= 'A' && oc
<= 'Z')
1316 c
|= shift_modifier
;
1319 /* The lower-case letters denote control characters too. */
1320 else if (c
>= 'a' && c
<= 'z')
1323 /* Include the bits for control and shift
1324 only if the basic ASCII code can't indicate them. */
1328 /* Replace the high bits. */
1329 c
|= (upper
& ~ctrl_modifier
);
1336 /* Input of single characters from keyboard */
1338 Lisp_Object
print_help ();
1339 static Lisp_Object
kbd_buffer_get_event ();
1341 /* read a character from the keyboard; call the redisplay if needed */
1342 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1343 -1 means do not do redisplay, but do do autosaving.
1346 /* The arguments MAPS and NMAPS are for menu prompting.
1347 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1349 PREV_EVENT is the previous input event, or nil if we are reading
1350 the first event of a key sequence.
1352 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1353 if we used a mouse menu to read the input, or zero otherwise. If
1354 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
1356 Value is t if we showed a menu and the user rejected it. */
1359 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1363 Lisp_Object prev_event
;
1364 int *used_mouse_menu
;
1366 register Lisp_Object c
;
1370 if (CONSP (unread_command_events
))
1372 c
= XCONS (unread_command_events
)->car
;
1373 unread_command_events
= XCONS (unread_command_events
)->cdr
;
1375 if (this_command_key_count
== 0)
1381 if (unread_command_char
!= -1)
1383 XSET (c
, Lisp_Int
, unread_command_char
);
1384 unread_command_char
= -1;
1386 if (this_command_key_count
== 0)
1392 if (!NILP (Vexecuting_macro
))
1395 /* We set this to Qmacro; since that's not a frame, nobody will
1396 try to switch frames on us, and the selected window will
1399 Since this event came from a macro, it would be misleading to
1400 leave internal_last_event_frame set to wherever the last
1401 real event came from. Normally, a switch-frame event selects
1402 internal_last_event_frame after each command is read, but
1403 events read from a macro should never cause a new frame to be
1405 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1408 /* Exit the macro if we are at the end.
1409 Also, some things replace the macro with t
1410 to force an early exit. */
1411 if (EQ (Vexecuting_macro
, Qt
)
1412 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1414 XSET (c
, Lisp_Int
, -1);
1418 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1419 if (XTYPE (Vexecuting_macro
) == Lisp_String
1420 && (XINT (c
) & 0x80))
1421 XFASTINT (c
) = CHAR_META
| (XINT (c
) & ~0x80);
1423 executing_macro_index
++;
1428 if (!NILP (unread_switch_frame
))
1430 c
= unread_switch_frame
;
1431 unread_switch_frame
= Qnil
;
1433 /* This event should make it into this_command_keys, and get echoed
1434 again, so we go to reread_first, rather than reread. */
1438 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1439 prepare_menu_bars ();
1441 /* Save outer setjmp data, in case called recursively. */
1442 save_getcjmp (save_jump
);
1446 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1449 if (_setjmp (getcjmp
))
1451 XSET (c
, Lisp_Int
, quit_char
);
1453 XSET (internal_last_event_frame
, Lisp_Frame
, selected_frame
);
1454 Vlast_event_frame
= internal_last_event_frame
;
1456 /* If we report the quit char as an event,
1457 don't do so more than once. */
1458 if (!NILP (Vinhibit_quit
))
1464 /* Message turns off echoing unless more keystrokes turn it on again. */
1465 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1468 /* If already echoing, continue. */
1471 /* Try reading a character via menu prompting in the minibuf.
1472 Try this before the sit-for, because the sit-for
1473 would do the wrong thing if we are supposed to do
1474 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1475 after a mouse event so don't try a minibuf menu. */
1477 if (nmaps
> 0 && INTERACTIVE
&&
1478 !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
))
1480 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1481 if ( ! NILP(c
) ) return c
;
1484 /* If in middle of key sequence and minibuffer not active,
1485 start echoing if enough time elapses. */
1486 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1488 && echo_keystrokes
> 0
1489 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1493 /* After a mouse event, start echoing right away.
1494 This is because we are probably about to display a menu,
1495 and we don't want to delay before doing so. */
1496 if (EVENT_HAS_PARAMETERS (prev_event
))
1500 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1506 /* Maybe auto save due to number of keystrokes or idle time. */
1508 if (commandflag
!= 0
1509 && auto_save_interval
> 0
1510 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1511 && !detect_input_pending ())
1514 save_getcjmp (temp
);
1515 Fdo_auto_save (Qnil
, Qnil
);
1516 restore_getcjmp (temp
);
1519 /* Try reading using an X menu.
1520 This is never confused with reading using the minibuf because the recursive
1521 call of read_char in read_char_minibuf_menu_prompt does not pass on
1523 if (nmaps
> 0 && INTERACTIVE
&&
1524 !NILP (prev_event
) && EVENT_HAS_PARAMETERS (prev_event
))
1525 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1527 /* Slow down auto saves logarithmically in size of current buffer,
1528 and garbage collect while we're at it. */
1529 if (INTERACTIVE
&& NILP (c
))
1531 int delay_level
, buffer_size
;
1533 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1534 last_non_minibuf_size
= Z
- BEG
;
1535 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1537 while (buffer_size
> 64)
1538 delay_level
++, buffer_size
-= buffer_size
>> 2;
1539 if (delay_level
< 4) delay_level
= 4;
1540 /* delay_level is 4 for files under around 50k, 7 at 100k,
1541 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1543 /* Auto save if enough time goes by without input. */
1544 if (commandflag
!= 0
1545 && num_nonmacro_input_chars
> last_auto_save
1546 && XTYPE (Vauto_save_timeout
) == Lisp_Int
1547 && XINT (Vauto_save_timeout
) > 0)
1550 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1551 tem0
= sit_for (delay
, 0, 1, 1);
1555 save_getcjmp (temp
);
1556 Fdo_auto_save (Qnil
, Qnil
);
1557 restore_getcjmp (temp
);
1559 /* If we have auto-saved and there is still no input
1560 available, garbage collect if there has been enough
1561 consing going on to make it worthwhile. */
1562 if (!detect_input_pending ()
1563 && consing_since_gc
> gc_cons_threshold
/ 2)
1565 Fgarbage_collect ();
1566 /* prepare_menu_bars isn't safe here, but it should
1567 also be unnecessary. */
1574 /* Actually read a character, waiting if necessary. */
1577 c
= kbd_buffer_get_event ();
1580 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1584 /* Terminate Emacs in batch mode if at eof. */
1585 if (noninteractive
&& XTYPE (c
) == Lisp_Int
&& XINT (c
) < 0)
1586 Fkill_emacs (make_number (1));
1588 if (XTYPE (c
) == Lisp_Int
)
1590 /* Add in any extra modifiers, where appropriate. */
1591 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1592 || ((extra_keyboard_modifiers
& 0177) < ' '
1593 && (extra_keyboard_modifiers
& 0177) != 0))
1594 XSETINT (c
, make_ctrl_char (XINT (c
)));
1596 /* Transfer any other modifier bits directly from
1597 extra_keyboard_modifiers to c. Ignore the actual character code
1598 in the low 16 bits of extra_keyboard_modifiers. */
1599 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
1604 restore_getcjmp (save_jump
);
1608 echo_area_glyphs
= 0;
1610 /* Handle things that only apply to characters. */
1611 if (XTYPE (c
) == Lisp_Int
)
1613 /* If kbd_buffer_get_event gave us an EOF, return that. */
1617 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
1618 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1619 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1623 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1624 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1625 recent_keys_index
= 0;
1627 /* Write c to the dribble file. If c is a lispy event, write
1628 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1629 If you, dear reader, have a better idea, you've got the source. :-) */
1632 if (XTYPE (c
) == Lisp_Int
)
1633 putc (XINT (c
), dribble
);
1636 Lisp_Object dribblee
= c
;
1638 /* If it's a structured event, take the event header. */
1639 dribblee
= EVENT_HEAD (dribblee
);
1641 if (XTYPE (dribblee
) == Lisp_Symbol
)
1643 putc ('<', dribble
);
1644 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1645 XSYMBOL (dribblee
)->name
->size
,
1647 putc ('>', dribble
);
1654 store_kbd_macro_char (c
);
1656 num_nonmacro_input_chars
++;
1661 /* Record this character as part of the current key.
1662 Don't record mouse motion; it should never matter. */
1663 if (! (EVENT_HAS_PARAMETERS (c
)
1664 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1667 add_command_key (c
);
1670 /* Re-reading in the middle of a command */
1672 last_input_char
= c
;
1675 /* Process the help character specially if enabled */
1676 if (EQ (c
, Vhelp_char
) && !NILP (Vhelp_form
))
1679 count
= specpdl_ptr
- specpdl
;
1681 record_unwind_protect (Fset_window_configuration
,
1682 Fcurrent_window_configuration (Qnil
));
1684 tem0
= Feval (Vhelp_form
);
1685 if (XTYPE (tem0
) == Lisp_String
)
1686 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1690 c
= read_char (0, 0, 0, Qnil
, 0);
1691 while (XTYPE (c
) == Lisp_Buffer
);
1692 /* Remove the help from the frame */
1693 unbind_to (count
, Qnil
);
1694 prepare_menu_bars ();
1696 if (EQ (c
, make_number (040)))
1700 c
= read_char (0, 0, 0, Qnil
, 0);
1701 while (XTYPE (c
) == Lisp_Buffer
);
1712 Fprinc (object
, Qnil
);
1716 /* Copy out or in the info on where C-g should throw to.
1717 This is used when running Lisp code from within get_char,
1718 in case get_char is called recursively.
1719 See read_process_output. */
1724 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1727 restore_getcjmp (temp
)
1730 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1734 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1735 of this function. */
1737 tracking_off (old_value
)
1738 Lisp_Object old_value
;
1740 if (! XFASTINT (old_value
))
1742 do_mouse_tracking
= 0;
1744 /* Redisplay may have been preempted because there was input
1745 available, and it assumes it will be called again after the
1746 input has been processed. If the only input available was
1747 the sort that we have just disabled, then we need to call
1749 if (!readable_events ())
1751 prepare_menu_bars ();
1752 redisplay_preserve_echo_area ();
1753 get_input_pending (&input_pending
);
1758 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1759 "Evaluate BODY with mouse movement events enabled.\n\
1760 Within a `track-mouse' form, mouse motion generates input events that\n\
1761 you can read with `read-event'.\n\
1762 Normally, mouse motion is ignored.")
1766 int count
= specpdl_ptr
- specpdl
;
1769 XSET (val
, Lisp_Int
, do_mouse_tracking
);
1770 record_unwind_protect (tracking_off
, val
);
1772 do_mouse_tracking
= 1;
1774 val
= Fprogn (args
);
1775 return unbind_to (count
, val
);
1778 /* Low level keyboard/mouse input.
1779 kbd_buffer_store_event places events in kbd_buffer, and
1780 kbd_buffer_get_event retrieves them.
1781 mouse_moved indicates when the mouse has moved again, and
1782 *mouse_position_hook provides the mouse position. */
1784 /* Return true iff there are any events in the queue that read-char
1785 would return. If this returns false, a read-char would block. */
1789 return ! EVENT_QUEUES_EMPTY
;
1792 /* Set this for debugging, to have a way to get out */
1795 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
1798 kbd_buffer_store_event (event
)
1799 register struct input_event
*event
;
1801 if (event
->kind
== no_event
)
1804 if (event
->kind
== ascii_keystroke
)
1806 register int c
= event
->code
& 0377;
1808 if (event
->modifiers
& ctrl_modifier
)
1809 c
= make_ctrl_char (c
);
1811 c
|= (event
->modifiers
1812 & (meta_modifier
| alt_modifier
1813 | hyper_modifier
| super_modifier
));
1817 extern SIGTYPE
interrupt_signal ();
1820 /* If this results in a quit_char being returned to Emacs as
1821 input, set Vlast_event_frame properly. If this doesn't
1822 get returned to Emacs as an event, the next event read
1823 will set Vlast_event_frame again, so this is safe to do. */
1826 = FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
1829 internal_last_event_frame
= event
->frame_or_window
;
1831 internal_last_event_frame
= focus
;
1832 Vlast_event_frame
= internal_last_event_frame
;
1836 last_event_timestamp
= event
->timestamp
;
1837 interrupt_signal ();
1841 if (c
&& c
== stop_character
)
1848 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
1849 kbd_store_ptr
= kbd_buffer
;
1851 /* Don't let the very last slot in the buffer become full,
1852 since that would make the two pointers equal,
1853 and that is indistinguishable from an empty buffer.
1854 Discard the event if it would fill the last slot. */
1855 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
1857 kbd_store_ptr
->kind
= event
->kind
;
1858 if (event
->kind
== selection_request_event
)
1860 /* We must not use the ordinary copying code for this case,
1861 since `part' is an enum and copying it might not copy enough
1863 bcopy (event
, kbd_store_ptr
, sizeof (*event
));
1867 kbd_store_ptr
->code
= event
->code
;
1868 kbd_store_ptr
->part
= event
->part
;
1869 kbd_store_ptr
->frame_or_window
= event
->frame_or_window
;
1870 kbd_store_ptr
->modifiers
= event
->modifiers
;
1871 kbd_store_ptr
->x
= event
->x
;
1872 kbd_store_ptr
->y
= event
->y
;
1873 kbd_store_ptr
->timestamp
= event
->timestamp
;
1875 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
1877 = event
->frame_or_window
);
1883 /* Read one event from the event buffer, waiting if necessary.
1884 The value is a Lisp object representing the event.
1885 The value is nil for an event that should be ignored,
1886 or that was handled here.
1887 We always read and discard one event. */
1890 kbd_buffer_get_event ()
1898 XSET (obj
, Lisp_Int
, c
);
1902 /* Wait until there is input available. */
1905 if (!EVENT_QUEUES_EMPTY
)
1908 /* If the quit flag is set, then read_char will return
1909 quit_char, so that counts as "available input." */
1910 if (!NILP (Vquit_flag
))
1911 quit_throw_to_read_char ();
1913 /* One way or another, wait until input is available; then, if
1914 interrupt handlers have not read it, read it now. */
1917 wait_for_kbd_input ();
1919 /* Note SIGIO has been undef'd if FIONREAD is missing. */
1923 if (EVENT_QUEUES_EMPTY
)
1925 Lisp_Object minus_one
;
1927 XSET (minus_one
, Lisp_Int
, -1);
1928 wait_reading_process_input (0, 0, minus_one
, 1);
1930 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
1931 /* Pass 1 for EXPECT since we just waited to have input. */
1932 read_avail_input (1);
1934 #endif /* not VMS */
1937 /* At this point, we know that there is a readable event available
1938 somewhere. If the event queue is empty, then there must be a
1939 mouse movement enabled and available. */
1940 if (kbd_fetch_ptr
!= kbd_store_ptr
)
1942 struct input_event
*event
;
1944 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
1948 last_event_timestamp
= event
->timestamp
;
1952 /* These two kinds of events get special handling
1953 and don't actually appear to the command loop.
1954 We return nil for them. */
1955 if (event
->kind
== selection_request_event
)
1958 x_handle_selection_request (event
);
1959 kbd_fetch_ptr
= event
+ 1;
1961 /* We're getting selection request events, but we don't have
1967 else if (event
->kind
== selection_clear_event
)
1970 x_handle_selection_clear (event
);
1971 kbd_fetch_ptr
= event
+ 1;
1973 /* We're getting selection request events, but we don't have
1979 else if (event
->kind
== delete_window_event
)
1981 Lisp_Object tail
, frame
;
1984 /* If the user destroys the only frame, Emacs should exit.
1985 Count visible frames and iconified frames. */
1986 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
1988 frame
= XCONS (tail
)->car
;
1989 if (XTYPE (frame
) != Lisp_Frame
|| EQ (frame
, event
->frame_or_window
))
1992 if (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
))
1999 Fdelete_frame (event
->frame_or_window
, Qt
);
2000 kbd_fetch_ptr
= event
+ 1;
2003 /* Just discard these, by returning nil.
2004 (They shouldn't be found in the buffer,
2005 but on some machines it appears they do show up.) */
2006 else if (event
->kind
== no_event
)
2007 kbd_fetch_ptr
= event
+ 1;
2009 /* If this event is on a different frame, return a switch-frame this
2010 time, and leave the event in the queue for next time. */
2014 Lisp_Object frame
= event
->frame_or_window
;
2017 if (XTYPE (frame
) == Lisp_Window
)
2018 frame
= WINDOW_FRAME (XWINDOW (frame
));
2020 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2024 if (! EQ (frame
, internal_last_event_frame
)
2025 && XFRAME (frame
) != selected_frame
)
2026 obj
= make_lispy_switch_frame (frame
);
2027 internal_last_event_frame
= frame
;
2028 #endif /* MULTI_FRAME */
2030 /* If we didn't decide to make a switch-frame event, go ahead
2031 and build a real event from the queue entry. */
2035 obj
= make_lispy_event (event
);
2037 /* Wipe out this event, to catch bugs. */
2038 event
->kind
= no_event
;
2039 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
2042 kbd_fetch_ptr
= event
+ 1;
2046 /* Try generating a mouse motion event. */
2047 else if (do_mouse_tracking
&& mouse_moved
)
2050 Lisp_Object bar_window
;
2051 enum scroll_bar_part part
;
2055 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
2060 /* Decide if we should generate a switch-frame event. Don't
2061 generate switch-frame events for motion outside of all Emacs
2065 Lisp_Object frame
= FRAME_FOCUS_FRAME (f
);
2068 XSET (frame
, Lisp_Frame
, f
);
2070 if (! EQ (frame
, internal_last_event_frame
)
2071 && XFRAME (frame
) != selected_frame
)
2072 obj
= make_lispy_switch_frame (frame
);
2073 internal_last_event_frame
= frame
;
2077 /* If we didn't decide to make a switch-frame event, go ahead and
2078 return a mouse-motion event. */
2080 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2083 /* We were promised by the above while loop that there was
2084 something for us to read! */
2087 input_pending
= readable_events ();
2090 Vlast_event_frame
= internal_last_event_frame
;
2096 /* Process any events that are not user-visible,
2097 then return, without reading any user-visible events. */
2102 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2104 struct input_event
*event
;
2106 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2110 last_event_timestamp
= event
->timestamp
;
2112 /* These two kinds of events get special handling
2113 and don't actually appear to the command loop. */
2114 if (event
->kind
== selection_request_event
)
2117 x_handle_selection_request (event
);
2118 kbd_fetch_ptr
= event
+ 1;
2120 /* We're getting selection request events, but we don't have
2126 else if (event
->kind
== selection_clear_event
)
2129 x_handle_selection_clear (event
);
2130 kbd_fetch_ptr
= event
+ 1;
2132 /* We're getting selection request events, but we don't have
2141 get_input_pending (&input_pending
);
2144 /* Caches for modify_event_symbol. */
2145 static Lisp_Object accent_key_syms
;
2146 static Lisp_Object system_key_syms
;
2147 static Lisp_Object func_key_syms
;
2148 static Lisp_Object mouse_syms
;
2150 Lisp_Object Vsystem_key_alist
;
2152 /* This is a list of keysym codes for special "accent" characters.
2153 It parallels lispy_accent_keys. */
2155 static int lispy_accent_codes
[] =
2157 #ifdef XK_dead_circumflex
2162 #ifdef XK_dead_grave
2167 #ifdef XK_dead_tilde
2172 #ifdef XK_dead_diaeresis
2177 #ifdef XK_dead_macron
2182 #ifdef XK_dead_degree
2187 #ifdef XK_dead_acute
2192 #ifdef XK_dead_cedilla
2197 #ifdef XK_dead_breve
2202 #ifdef XK_dead_ogonek
2207 #ifdef XK_dead_caron
2212 #ifdef XK_dead_doubleacute
2213 XK_dead_doubleacute
,
2217 #ifdef XK_dead_abovedot
2224 /* This is a list of Lisp names for special "accent" characters.
2225 It parallels lispy_accent_codes. */
2227 static char *lispy_accent_keys
[] =
2244 /* You'll notice that this table is arranged to be conveniently
2245 indexed by X Windows keysym values. */
2246 static char *lispy_function_keys
[] =
2248 /* X Keysym value */
2250 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2258 0, 0, 0, /* 0xff10 */
2260 0, 0, 0, 0, 0, 0, 0,
2263 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2264 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2265 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2267 "home", /* 0xff50 */ /* IsCursorKey */
2278 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2289 "break", /* 0xff6b */
2291 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2293 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2294 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2295 0, 0, 0, 0, 0, 0, 0, 0,
2296 "kp-tab", /* 0xff89 */
2298 "kp-enter", /* 0xff8d */
2300 "kp-f1", /* 0xff91 */
2305 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2306 "kp-multiply", /* 0xffaa */
2311 "kp-divide", /* 0xffaf */
2312 "kp-0", /* 0xffb0 */
2313 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2316 "kp-equal", /* 0xffbd */
2317 "f1", /* 0xffbe */ /* IsFunctionKey */
2319 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2320 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2321 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2322 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2323 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2324 0, 0, 0, 0, 0, 0, 0, 0,
2325 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2326 0, 0, 0, 0, 0, 0, 0, "delete"
2329 static char *lispy_mouse_names
[] =
2331 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2334 /* Scroll bar parts. */
2335 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2337 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2338 Lisp_Object
*scroll_bar_parts
[] = {
2339 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2343 /* A vector, indexed by button number, giving the down-going location
2344 of currently depressed buttons, both scroll bar and non-scroll bar.
2346 The elements have the form
2347 (BUTTON-NUMBER MODIFIER-MASK . REST)
2348 where REST is the cdr of a position as it would be reported in the event.
2350 The make_lispy_event function stores positions here to tell the
2351 difference between click and drag events, and to store the starting
2352 location to be included in drag events. */
2354 static Lisp_Object button_down_location
;
2356 /* Information about the most recent up-going button event: Which
2357 button, what location, and what time. */
2359 static int last_mouse_button
;
2360 static int last_mouse_x
;
2361 static int last_mouse_y
;
2362 static unsigned long button_down_time
;
2364 /* The maximum time between clicks to make a double-click,
2365 or Qnil to disable double-click detection,
2366 or Qt for no time limit. */
2367 Lisp_Object Vdouble_click_time
;
2369 /* The number of clicks in this multiple-click. */
2371 int double_click_count
;
2373 #ifdef USE_X_TOOLKIT
2374 extern Lisp_Object
map_event_to_object ();
2375 #endif /* USE_X_TOOLKIT */
2377 /* Given a struct input_event, build the lisp event which represents
2378 it. If EVENT is 0, build a mouse movement event from the mouse
2379 movement buffer, which should have a movement event in it.
2381 Note that events must be passed to this function in the order they
2382 are received; this function stores the location of button presses
2383 in order to build drag events when the button is released. */
2386 make_lispy_event (event
)
2387 struct input_event
*event
;
2391 #ifdef SWITCH_ENUM_BUG
2392 switch ((int) event
->kind
)
2394 switch (event
->kind
)
2397 /* A simple keystroke. */
2398 case ascii_keystroke
:
2400 int c
= event
->code
& 0377;
2401 /* Turn ASCII characters into control characters
2403 if (event
->modifiers
& ctrl_modifier
)
2404 c
= make_ctrl_char (c
);
2406 /* Add in the other modifier bits. We took care of ctrl_modifier
2407 just above, and the shift key was taken care of by the X code,
2408 and applied to control characters by make_ctrl_char. */
2409 c
|= (event
->modifiers
2410 & (meta_modifier
| alt_modifier
2411 | hyper_modifier
| super_modifier
));
2412 button_down_time
= 0;
2416 /* A function key. The symbol may need to have modifier prefixes
2418 case non_ascii_keystroke
:
2419 button_down_time
= 0;
2421 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
2422 if (event
->code
== lispy_accent_codes
[i
])
2423 return modify_event_symbol (i
,
2425 Qfunction_key
, Qnil
,
2426 lispy_accent_keys
, &accent_key_syms
,
2427 (sizeof (lispy_accent_keys
)
2428 / sizeof (lispy_accent_keys
[0])));
2430 /* Handle system-specific keysyms. */
2431 if (event
->code
& (1 << 28))
2433 /* We need to use an alist rather than a vector as the cache
2434 since we can't make a vector long enuf. */
2435 if (NILP (system_key_syms
))
2436 system_key_syms
= Fcons (Qnil
, Qnil
);
2437 return modify_event_symbol (event
->code
& 0xffffff,
2439 Qfunction_key
, Vsystem_key_alist
,
2440 0, &system_key_syms
, 0xffffff);
2443 return modify_event_symbol (event
->code
- 0xff00,
2445 Qfunction_key
, Qnil
,
2446 lispy_function_keys
, &func_key_syms
,
2447 (sizeof (lispy_function_keys
)
2448 / sizeof (lispy_function_keys
[0])));
2451 /* A mouse click. Figure out where it is, decide whether it's
2452 a press, click or drag, and build the appropriate structure. */
2454 case scroll_bar_click
:
2456 int button
= event
->code
;
2458 Lisp_Object position
;
2459 Lisp_Object
*start_pos_ptr
;
2460 Lisp_Object start_pos
;
2462 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2465 /* Build the position as appropriate for this mouse click. */
2466 if (event
->kind
== mouse_click
)
2469 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2474 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
2475 &column
, &row
, 0, 0);
2477 #ifdef USE_X_TOOLKIT
2478 if (FRAME_EXTERNAL_MENU_BAR (f
) && XINT (event
->y
) == -1)
2480 if (row
< FRAME_MENU_BAR_LINES (f
))
2483 Lisp_Object items
, item
;
2485 #ifdef USE_X_TOOLKIT
2486 /* The click happened in the menubar.
2487 Look for the menu item selected. */
2488 item
= map_event_to_object (event
, f
);
2490 XFASTINT (event
->y
) = 1;
2491 #else /* not USE_X_TOOLKIT */
2495 items
= FRAME_MENU_BAR_ITEMS (f
);
2496 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 3)
2498 Lisp_Object pos
, string
;
2499 string
= XVECTOR (items
)->contents
[i
+ 1];
2500 pos
= XVECTOR (items
)->contents
[i
+ 2];
2503 if (column
>= XINT (pos
)
2504 && column
< XINT (pos
) + XSTRING (string
)->size
)
2506 item
= XVECTOR (items
)->contents
[i
];
2510 #endif /* not USE_X_TOOLKIT */
2513 = Fcons (event
->frame_or_window
,
2515 Fcons (Fcons (event
->x
, event
->y
),
2516 Fcons (make_number (event
->timestamp
),
2519 return Fcons (item
, Fcons (position
, Qnil
));
2522 window
= window_from_coordinates (f
, column
, row
, &part
);
2524 if (XTYPE (window
) != Lisp_Window
)
2528 int pixcolumn
, pixrow
;
2529 column
-= XINT (XWINDOW (window
)->left
);
2530 row
-= XINT (XWINDOW (window
)->top
);
2531 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
2532 XSETINT (event
->x
, pixcolumn
);
2533 XSETINT (event
->y
, pixrow
);
2538 posn
= Qvertical_line
;
2540 XSET (posn
, Lisp_Int
,
2541 buffer_posn_from_coords (XWINDOW (window
),
2548 Fcons (Fcons (event
->x
, event
->y
),
2549 Fcons (make_number (event
->timestamp
),
2555 Lisp_Object portion_whole
;
2558 window
= event
->frame_or_window
;
2559 portion_whole
= Fcons (event
->x
, event
->y
);
2560 part
= *scroll_bar_parts
[(int) event
->part
];
2564 Fcons (Qvertical_scroll_bar
,
2565 Fcons (portion_whole
,
2566 Fcons (make_number (event
->timestamp
),
2567 Fcons (part
, Qnil
)))));
2570 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2572 start_pos
= *start_pos_ptr
;
2573 *start_pos_ptr
= Qnil
;
2575 is_double
= (button
== last_mouse_button
2576 && XINT (event
->x
) == last_mouse_x
2577 && XINT (event
->y
) == last_mouse_y
2578 && button_down_time
!= 0
2579 && (EQ (Vdouble_click_time
, Qt
)
2580 || (INTEGERP (Vdouble_click_time
)
2581 && ((int)(event
->timestamp
- button_down_time
)
2582 < XINT (Vdouble_click_time
)))));
2583 last_mouse_button
= button
;
2584 last_mouse_x
= XINT (event
->x
);
2585 last_mouse_y
= XINT (event
->y
);
2587 /* If this is a button press, squirrel away the location, so
2588 we can decide later whether it was a click or a drag. */
2589 if (event
->modifiers
& down_modifier
)
2593 double_click_count
++;
2594 event
->modifiers
|= ((double_click_count
> 2)
2599 double_click_count
= 1;
2600 button_down_time
= event
->timestamp
;
2601 *start_pos_ptr
= Fcopy_alist (position
);
2604 /* Now we're releasing a button - check the co-ordinates to
2605 see if this was a click or a drag. */
2606 else if (event
->modifiers
& up_modifier
)
2608 /* If we did not see a down before this up,
2609 ignore the up. Probably this happened because
2610 the down event chose a menu item.
2611 It would be an annoyance to treat the release
2612 of the button that chose the menu item
2613 as a separate event. */
2615 if (XTYPE (start_pos
) != Lisp_Cons
)
2618 event
->modifiers
&= ~up_modifier
;
2619 #if 0 /* Formerly we treated an up with no down as a click event. */
2620 if (XTYPE (start_pos
) != Lisp_Cons
)
2621 event
->modifiers
|= click_modifier
;
2625 /* The third element of every position should be the (x,y)
2627 Lisp_Object down
= Fnth (make_number (2), start_pos
);
2629 if (EQ (event
->x
, XCONS (down
)->car
)
2630 && EQ (event
->y
, XCONS (down
)->cdr
))
2632 if (is_double
&& double_click_count
> 1)
2633 event
->modifiers
|= ((double_click_count
> 2)
2637 event
->modifiers
|= click_modifier
;
2641 button_down_time
= 0;
2642 event
->modifiers
|= drag_modifier
;
2647 /* Every mouse event should either have the down_modifier or
2648 the up_modifier set. */
2652 /* Get the symbol we should use for the mouse click. */
2654 = modify_event_symbol (button
,
2657 lispy_mouse_names
, &mouse_syms
,
2658 (sizeof (lispy_mouse_names
)
2659 / sizeof (lispy_mouse_names
[0])));
2661 if (event
->modifiers
& drag_modifier
)
2666 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2669 Fcons (make_number (double_click_count
),
2678 /* The 'kind' field of the event is something we don't recognize. */
2685 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2687 Lisp_Object bar_window
;
2688 enum scroll_bar_part part
;
2692 /* Is it a scroll bar movement? */
2693 if (frame
&& ! NILP (bar_window
))
2695 Lisp_Object part_sym
= *scroll_bar_parts
[(int) part
];
2697 return Fcons (Qscroll_bar_movement
,
2698 (Fcons (Fcons (bar_window
,
2699 Fcons (Qvertical_scroll_bar
,
2700 Fcons (Fcons (x
, y
),
2701 Fcons (make_number (time
),
2707 /* Or is it an ordinary mouse movement? */
2715 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
, 0, 0);
2718 window
= window_from_coordinates (frame
, column
, row
, &area
);
2722 if (XTYPE (window
) == Lisp_Window
)
2724 int pixcolumn
, pixrow
;
2725 column
-= XINT (XWINDOW (window
)->left
);
2726 row
-= XINT (XWINDOW (window
)->top
);
2727 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
2728 XSETINT (x
, pixcolumn
);
2729 XSETINT (y
, pixrow
);
2734 posn
= Qvertical_line
;
2736 XSET (posn
, Lisp_Int
,
2737 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
2739 else if (frame
!= 0)
2741 XSET (window
, Lisp_Frame
, frame
);
2752 return Fcons (Qmouse_movement
,
2753 Fcons (Fcons (window
,
2755 Fcons (Fcons (x
, y
),
2756 Fcons (make_number (time
),
2762 /* Construct a switch frame event. */
2764 make_lispy_switch_frame (frame
)
2767 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
2770 /* Manipulating modifiers. */
2772 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
2774 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2775 SYMBOL's name of the end of the modifiers; the string from this
2776 position is the unmodified symbol name.
2778 This doesn't use any caches. */
2780 parse_modifiers_uncached (symbol
, modifier_end
)
2784 struct Lisp_String
*name
;
2788 CHECK_SYMBOL (symbol
, 1);
2791 name
= XSYMBOL (symbol
)->name
;
2794 for (i
= 0; i
+2 <= name
->size
; )
2795 switch (name
->data
[i
])
2797 #define SINGLE_LETTER_MOD(bit) \
2798 if (name->data[i+1] != '-') \
2799 goto no_more_modifiers; \
2804 SINGLE_LETTER_MOD (alt_modifier
);
2808 SINGLE_LETTER_MOD (ctrl_modifier
);
2812 SINGLE_LETTER_MOD (hyper_modifier
);
2816 SINGLE_LETTER_MOD (meta_modifier
);
2820 SINGLE_LETTER_MOD (shift_modifier
);
2824 SINGLE_LETTER_MOD (super_modifier
);
2828 if (i
+ 5 > name
->size
)
2829 goto no_more_modifiers
;
2830 if (! strncmp (name
->data
+ i
, "drag-", 5))
2832 modifiers
|= drag_modifier
;
2835 else if (! strncmp (name
->data
+ i
, "down-", 5))
2837 modifiers
|= down_modifier
;
2840 else if (i
+ 7 <= name
->size
2841 && ! strncmp (name
->data
+ i
, "double-", 7))
2843 modifiers
|= double_modifier
;
2847 goto no_more_modifiers
;
2851 if (i
+ 7 > name
->size
)
2852 goto no_more_modifiers
;
2853 if (! strncmp (name
->data
+ i
, "triple-", 7))
2855 modifiers
|= triple_modifier
;
2859 goto no_more_modifiers
;
2863 goto no_more_modifiers
;
2865 #undef SINGLE_LETTER_MOD
2869 /* Should we include the `click' modifier? */
2870 if (! (modifiers
& (down_modifier
| drag_modifier
2871 | double_modifier
| triple_modifier
))
2872 && i
+ 7 == name
->size
2873 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
2874 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
2875 modifiers
|= click_modifier
;
2884 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
2885 prepended to the string BASE[0..BASE_LEN-1].
2886 This doesn't use any caches. */
2888 apply_modifiers_uncached (modifiers
, base
, base_len
)
2893 /* Since BASE could contain nulls, we can't use intern here; we have
2894 to use Fintern, which expects a genuine Lisp_String, and keeps a
2897 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
2903 /* Only the event queue may use the `up' modifier; it should always
2904 be turned into a click or drag event before presented to lisp code. */
2905 if (modifiers
& up_modifier
)
2908 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
2909 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
2910 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
2911 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
2912 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
2913 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
2914 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
2915 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
2916 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
2917 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
2918 /* The click modifier is denoted by the absence of other modifiers. */
2922 mod_len
= p
- new_mods
;
2926 Lisp_Object new_name
= make_uninit_string (mod_len
+ base_len
);
2928 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
2929 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
2931 return Fintern (new_name
, Qnil
);
2936 static char *modifier_names
[] =
2938 "up", "down", "drag", "click", "double", "triple", 0, 0,
2939 0, 0, 0, 0, 0, 0, 0, 0,
2940 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
2942 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
2944 static Lisp_Object modifier_symbols
;
2946 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
2948 lispy_modifier_list (modifiers
)
2951 Lisp_Object modifier_list
;
2954 modifier_list
= Qnil
;
2955 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
2956 if (modifiers
& (1<<i
))
2957 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
2960 return modifier_list
;
2964 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
2965 where UNMODIFIED is the unmodified form of SYMBOL,
2966 MASK is the set of modifiers present in SYMBOL's name.
2967 This is similar to parse_modifiers_uncached, but uses the cache in
2968 SYMBOL's Qevent_symbol_element_mask property, and maintains the
2969 Qevent_symbol_elements property. */
2971 parse_modifiers (symbol
)
2974 Lisp_Object elements
= Fget (symbol
, Qevent_symbol_element_mask
);
2976 if (CONSP (elements
))
2981 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
2982 Lisp_Object unmodified
2983 = Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
2984 XSYMBOL (symbol
)->name
->size
- end
),
2988 if (modifiers
& ~((1<<VALBITS
) - 1))
2990 XFASTINT (mask
) = modifiers
;
2991 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
2993 /* Cache the parsing results on SYMBOL. */
2994 Fput (symbol
, Qevent_symbol_element_mask
,
2996 Fput (symbol
, Qevent_symbol_elements
,
2997 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
2999 /* Since we know that SYMBOL is modifiers applied to unmodified,
3000 it would be nice to put that in unmodified's cache.
3001 But we can't, since we're not sure that parse_modifiers is
3008 /* Apply the modifiers MODIFIERS to the symbol BASE.
3009 BASE must be unmodified.
3011 This is like apply_modifiers_uncached, but uses BASE's
3012 Qmodifier_cache property, if present. It also builds
3013 Qevent_symbol_elements properties, since it has that info anyway.
3015 apply_modifiers copies the value of BASE's Qevent_kind property to
3016 the modified symbol. */
3018 apply_modifiers (modifiers
, base
)
3022 Lisp_Object cache
, index
, entry
, new_symbol
;
3024 /* Mask out upper bits. We don't know where this value's been. */
3025 modifiers
&= (1<<VALBITS
) - 1;
3027 /* The click modifier never figures into cache indices. */
3028 cache
= Fget (base
, Qmodifier_cache
);
3029 XFASTINT (index
) = (modifiers
& ~click_modifier
);
3030 entry
= Fassq (index
, cache
);
3033 new_symbol
= XCONS (entry
)->cdr
;
3036 /* We have to create the symbol ourselves. */
3037 new_symbol
= apply_modifiers_uncached (modifiers
,
3038 XSYMBOL (base
)->name
->data
,
3039 XSYMBOL (base
)->name
->size
);
3041 /* Add the new symbol to the base's cache. */
3042 entry
= Fcons (index
, new_symbol
);
3043 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
3045 /* We have the parsing info now for free, so add it to the caches. */
3046 XFASTINT (index
) = modifiers
;
3047 Fput (new_symbol
, Qevent_symbol_element_mask
,
3048 Fcons (base
, Fcons (index
, Qnil
)));
3049 Fput (new_symbol
, Qevent_symbol_elements
,
3050 Fcons (base
, lispy_modifier_list (modifiers
)));
3053 /* Make sure this symbol is of the same kind as BASE.
3055 You'd think we could just set this once and for all when we
3056 intern the symbol above, but reorder_modifiers may call us when
3057 BASE's property isn't set right; we can't assume that just
3058 because it has a Qmodifier_cache property it must have its
3059 Qevent_kind set right as well. */
3060 if (NILP (Fget (new_symbol
, Qevent_kind
)))
3062 Lisp_Object kind
= Fget (base
, Qevent_kind
);
3065 Fput (new_symbol
, Qevent_kind
, kind
);
3072 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
3073 return a symbol with the modifiers placed in the canonical order.
3074 Canonical order is alphabetical, except for down and drag, which
3075 always come last. The 'click' modifier is never written out.
3077 Fdefine_key calls this to make sure that (for example) C-M-foo
3078 and M-C-foo end up being equivalent in the keymap. */
3081 reorder_modifiers (symbol
)
3084 /* It's hopefully okay to write the code this way, since everything
3085 will soon be in caches, and no consing will be done at all. */
3086 Lisp_Object parsed
= parse_modifiers (symbol
);
3088 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
3089 XCONS (parsed
)->car
);
3093 /* For handling events, we often want to produce a symbol whose name
3094 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
3095 to some base, like the name of a function key or mouse button.
3096 modify_event_symbol produces symbols of this sort.
3098 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
3099 is the name of the i'th symbol. TABLE_SIZE is the number of elements
3102 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
3103 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
3105 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
3106 persist between calls to modify_event_symbol that it can use to
3107 store a cache of the symbols it's generated for this NAME_TABLE
3108 before. The object stored there may be a vector or an alist.
3110 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
3112 MODIFIERS is a set of modifier bits (as given in struct input_events)
3113 whose prefixes should be applied to the symbol name.
3115 SYMBOL_KIND is the value to be placed in the event_kind property of
3116 the returned symbol.
3118 The symbols we create are supposed to have an
3119 `event-symbol-elements' property, which lists the modifiers present
3120 in the symbol's name. */
3123 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
3124 name_table
, symbol_table
, table_size
)
3127 Lisp_Object symbol_kind
;
3128 Lisp_Object name_alist
;
3130 Lisp_Object
*symbol_table
;
3134 Lisp_Object symbol_int
;
3136 XSET (symbol_int
, Lisp_Int
, symbol_num
);
3138 /* Is this a request for a valid symbol? */
3139 if (symbol_num
< 0 || symbol_num
>= table_size
)
3142 if (CONSP (*symbol_table
))
3143 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
3145 /* If *symbol_table doesn't seem to be initialized properly, fix that.
3146 *symbol_table should be a lisp vector TABLE_SIZE elements long,
3147 where the Nth element is the symbol for NAME_TABLE[N], or nil if
3148 we've never used that symbol before. */
3151 if (! VECTORP (*symbol_table
)
3152 || XVECTOR (*symbol_table
)->size
!= table_size
)
3156 XFASTINT (size
) = table_size
;
3157 *symbol_table
= Fmake_vector (size
, Qnil
);
3160 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
3163 /* Have we already used this symbol before? */
3166 /* No; let's create it. */
3167 if (!NILP (name_alist
))
3168 value
= Fassq (symbol_int
, name_alist
);
3169 else if (name_table
[symbol_num
])
3170 value
= intern (name_table
[symbol_num
]);
3174 sprintf (buf
, "key-%d", symbol_num
);
3175 value
= intern (buf
);
3178 if (CONSP (*symbol_table
))
3179 *symbol_table
= Fcons (value
, *symbol_table
);
3181 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
3183 /* Fill in the cache entries for this symbol; this also
3184 builds the Qevent_symbol_elements property, which the user
3186 apply_modifiers (modifiers
& click_modifier
, value
);
3187 Fput (value
, Qevent_kind
, symbol_kind
);
3190 /* Apply modifiers to that symbol. */
3191 return apply_modifiers (modifiers
, value
);
3195 /* Store into *addr a value nonzero if terminal input chars are available.
3196 Serves the purpose of ioctl (0, FIONREAD, addr)
3197 but works even if FIONREAD does not exist.
3198 (In fact, this may actually read some input.) */
3201 get_input_pending (addr
)
3204 /* First of all, have we already counted some input? */
3205 *addr
= !NILP (Vquit_flag
) || readable_events ();
3207 /* If input is being read as it arrives, and we have none, there is none. */
3208 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
3211 /* Try to read some input and see how much we get. */
3213 *addr
= !NILP (Vquit_flag
) || readable_events ();
3216 /* Interface to read_avail_input, blocking SIGIO if necessary. */
3219 gobble_input (expected
)
3224 if (interrupt_input
)
3227 mask
= sigblockx (SIGIO
);
3228 read_avail_input (expected
);
3233 read_avail_input (expected
);
3239 /* Read any terminal input already buffered up by the system
3240 into the kbd_buffer, but do not wait.
3242 EXPECTED should be nonzero if the caller knows there is some input.
3244 Except on VMS, all input is read by this function.
3245 If interrupt_input is nonzero, this function MUST be called
3246 only when SIGIO is blocked.
3248 Returns the number of keyboard chars read, or -1 meaning
3249 this is a bad time to try to read input. */
3252 read_avail_input (expected
)
3255 struct input_event buf
[KBD_BUFFER_SIZE
];
3259 if (read_socket_hook
)
3260 /* No need for FIONREAD or fcntl; just say don't wait. */
3261 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
3264 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
3265 the kbd_buffer can really hold. That may prevent loss
3266 of characters on some systems when input is stuffed at us. */
3267 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
3270 nread
= dos_keysns ();
3271 if (nread
== 0) return 0;
3272 #else */ not MSDOS */
3274 /* Find out how much input is available. */
3275 if (ioctl (0, FIONREAD
, &nread
) < 0)
3276 /* Formerly simply reported no input, but that sometimes led to
3277 a failure of Emacs to terminate.
3278 SIGHUP seems appropriate if we can't reach the terminal. */
3279 /* ??? Is it really right to send the signal just to this process
3280 rather than to the whole process group?
3281 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3282 kill (getpid (), SIGHUP
);
3285 if (nread
> sizeof cbuf
)
3286 nread
= sizeof cbuf
;
3287 #else /* no FIONREAD */
3288 #if defined(USG) || defined(DGUX)
3289 /* Read some input if available, but don't wait. */
3290 nread
= sizeof cbuf
;
3291 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
3296 #endif /* not MSDOS */
3298 /* Now read; for one reason or another, this will not block. */
3302 cbuf
[0] = dos_keyread();
3305 nread
= read (fileno (stdin
), cbuf
, nread
);
3308 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3309 This looks incorrect, but it isn't, because _BSD causes
3310 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3311 and that causes a value other than 0 when there is no input. */
3315 /* This code is wrong, but at least it gets the right results.
3316 Fix it for 19.23. */
3317 /* Retry the read if it is interrupted. */
3320 || ! (errno
== EAGAIN
|| errno
== EFAULT
3322 || ! (errno
== EAGAIN
3332 #if defined (USG) || defined (DGUX)
3333 fcntl (fileno (stdin
), F_SETFL
, 0);
3334 #endif /* USG or DGUX */
3335 #endif /* no FIONREAD */
3336 for (i
= 0; i
< nread
; i
++)
3338 buf
[i
].kind
= ascii_keystroke
;
3339 buf
[i
].modifiers
= 0;
3340 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3341 buf
[i
].modifiers
= meta_modifier
;
3345 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
3347 XSET (buf
[i
].frame_or_window
, Lisp_Frame
, selected_frame
);
3349 buf
[i
].frame_or_window
= Qnil
;
3354 /* Scan the chars for C-g and store them in kbd_buffer. */
3355 for (i
= 0; i
< nread
; i
++)
3357 kbd_buffer_store_event (&buf
[i
]);
3358 /* Don't look at input that follows a C-g too closely.
3359 This reduces lossage due to autorepeat on C-g. */
3360 if (buf
[i
].kind
== ascii_keystroke
3361 && XINT(buf
[i
].code
) == quit_char
)
3367 #endif /* not VMS */
3369 #ifdef SIGIO /* for entire page */
3370 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3373 input_available_signal (signo
)
3376 /* Must preserve main program's value of errno. */
3377 int old_errno
= errno
;
3379 extern int select_alarmed
;
3383 /* USG systems forget handlers when they are used;
3384 must reestablish each time */
3385 signal (signo
, input_available_signal
);
3392 if (input_available_clear_time
)
3393 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3398 nread
= read_avail_input (1);
3399 /* -1 means it's not ok to read the input now.
3400 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3401 0 means there was no keyboard input available. */
3406 select_alarmed
= 1; /* Force the select emulator back to life */
3417 /* Send ourselves a SIGIO.
3419 This function exists so that the UNBLOCK_INPUT macro in
3420 blockinput.h can have some way to take care of input we put off
3421 dealing with, without assuming that every file which uses
3422 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3424 reinvoke_input_signal ()
3433 /* Return the prompt-string of a sparse keymap.
3434 This is the first element which is a string.
3435 Return nil if there is none. */
3443 register Lisp_Object tem
;
3445 if (XTYPE (tem
) == Lisp_String
)
3452 static void menu_bar_item ();
3453 static void menu_bar_one_keymap ();
3455 /* These variables hold the vector under construction within
3456 menu_bar_items and its subroutines, and the current index
3457 for storing into that vector. */
3458 static Lisp_Object menu_bar_items_vector
;
3459 static Lisp_Object menu_bar_items_index
;
3461 /* Return a vector of menu items for a menu bar, appropriate
3462 to the current buffer. Each item has three elements in the vector:
3465 OLD is an old vector we can optionally reuse, or nil. */
3468 menu_bar_items (old
)
3471 /* The number of keymaps we're scanning right now, and the number of
3472 keymaps we have allocated space for. */
3475 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3476 in the current keymaps, or nil where it is not a prefix. */
3479 Lisp_Object def
, tem
, tail
;
3488 struct gcpro gcpro1
;
3490 /* In order to build the menus, we need to call the keymap
3491 accessors. They all call QUIT. But this function is called
3492 during redisplay, during which a quit is fatal. So inhibit
3493 quitting while building the menus.
3494 We do this instead of specbind because (1) errors will clear it anyway
3495 and (2) this avoids risk of specpdl overflow. */
3496 oquit
= Vinhibit_quit
;
3500 menu_bar_items_vector
= old
;
3502 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
3503 menu_bar_items_index
= 0;
3505 GCPRO1 (menu_bar_items_vector
);
3507 /* Build our list of keymaps.
3508 If we recognize a function key and replace its escape sequence in
3509 keybuf with its symbol, or if the sequence starts with a mouse
3510 click and we need to switch buffers, we jump back here to rebuild
3511 the initial keymaps from the current buffer. */
3515 if (!NILP (Voverriding_local_map
))
3518 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3519 maps
[0] = Voverriding_local_map
;
3523 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3524 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3525 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3526 #ifdef USE_TEXT_PROPERTIES
3527 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3529 maps
[nmaps
-2] = current_buffer
->keymap
;
3532 maps
[nmaps
-1] = current_global_map
;
3535 /* Look up in each map the dummy prefix key `menu-bar'. */
3539 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3541 if (! NILP (maps
[mapno
]))
3542 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3546 tem
= Fkeymapp (def
);
3548 menu_bar_one_keymap (def
);
3551 /* Move to the end those items that should be at the end. */
3553 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3556 int end
= menu_bar_items_index
;
3558 for (i
= 0; i
< end
; i
+= 3)
3559 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3561 Lisp_Object tem0
, tem1
, tem2
;
3562 /* Move the item at index I to the end,
3563 shifting all the others forward. */
3564 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
3565 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
3566 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
3568 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
3569 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
3570 (end
- i
- 3) * sizeof (Lisp_Object
));
3571 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem0
;
3572 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem1
;
3573 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem2
;
3578 /* Add nil, nil, nil at the end. */
3579 i
= menu_bar_items_index
;
3580 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
3583 int newsize
= 2 * i
;
3584 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
3585 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
3586 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
3587 menu_bar_items_vector
= tem
;
3589 /* Add this item. */
3590 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3591 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3592 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3593 menu_bar_items_index
= i
;
3595 Vinhibit_quit
= oquit
;
3597 return menu_bar_items_vector
;
3600 /* Scan one map KEYMAP, accumulating any menu items it defines
3601 that have not yet been seen in RESULT. Return the updated RESULT.
3602 *OLD is the frame's old menu bar list; we swipe elts from that
3603 to avoid consing. */
3606 menu_bar_one_keymap (keymap
)
3609 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3611 /* Loop over all keymap entries that have menu strings. */
3612 for (tail
= keymap
; XTYPE (tail
) == Lisp_Cons
; tail
= XCONS (tail
)->cdr
)
3614 item
= XCONS (tail
)->car
;
3615 if (XTYPE (item
) == Lisp_Cons
)
3617 key
= XCONS (item
)->car
;
3618 binding
= XCONS (item
)->cdr
;
3619 if (XTYPE (binding
) == Lisp_Cons
)
3621 item_string
= XCONS (binding
)->car
;
3622 if (XTYPE (item_string
) == Lisp_String
)
3623 menu_bar_item (key
, item_string
, Fcdr (binding
));
3625 else if (EQ (binding
, Qundefined
))
3626 menu_bar_item (key
, item_string
, binding
);
3628 else if (XTYPE (item
) == Lisp_Vector
)
3630 /* Loop over the char values represented in the vector. */
3631 int len
= XVECTOR (item
)->size
;
3633 for (c
= 0; c
< len
; c
++)
3635 Lisp_Object character
;
3636 XFASTINT (character
) = c
;
3637 binding
= XVECTOR (item
)->contents
[c
];
3638 if (XTYPE (binding
) == Lisp_Cons
)
3640 item_string
= XCONS (binding
)->car
;
3641 if (XTYPE (item_string
) == Lisp_String
)
3642 menu_bar_item (key
, item_string
, Fcdr (binding
));
3644 else if (EQ (binding
, Qundefined
))
3645 menu_bar_item (key
, item_string
, binding
);
3651 /* This is used as the handler when calling internal_condition_case_1. */
3654 menu_bar_item_1 (arg
)
3661 menu_bar_item (key
, item_string
, def
)
3662 Lisp_Object key
, item_string
, def
;
3665 Lisp_Object enabled
;
3668 if (EQ (def
, Qundefined
))
3670 /* If a map has an explicit nil as definition,
3671 discard any previously made menu bar item. */
3673 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
3674 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3676 if (menu_bar_items_index
> i
+ 3)
3677 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
3678 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
3679 (menu_bar_items_index
- i
- 3) * sizeof (Lisp_Object
));
3680 menu_bar_items_index
-= 3;
3685 /* See if this entry is enabled. */
3688 if (XTYPE (def
) == Lisp_Symbol
)
3690 /* No property, or nil, means enable.
3691 Otherwise, enable if value is not nil. */
3692 tem
= Fget (def
, Qmenu_enable
);
3694 /* (condition-case nil (eval tem)
3696 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
3700 /* Ignore this item if it's not enabled. */
3704 /* If there's already such an item, don't make another. */
3705 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
3706 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3709 /* If we did not find this item, add it at the end. */
3710 if (i
== menu_bar_items_index
)
3712 /* If vector is too small, get a bigger one. */
3713 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
3716 int newsize
= 2 * i
;
3717 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
3718 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
3719 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
3720 menu_bar_items_vector
= tem
;
3722 /* Add this item. */
3723 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
3724 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
3725 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3726 menu_bar_items_index
= i
;
3730 /* Read a character using menus based on maps in the array MAPS.
3731 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
3732 Return t if we displayed a menu but the user rejected it.
3734 PREV_EVENT is the previous input event, or nil if we are reading
3735 the first event of a key sequence.
3737 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3738 if we used a mouse menu to read the input, or zero otherwise. If
3739 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
3741 The prompting is done based on the prompt-string of the map
3742 and the strings associated with various map elements.
3744 This can be done with X menus or with menus put in the minibuf.
3745 These are done in different ways, depending on how the input will be read.
3746 Menus using X are done after auto-saving in read-char, getting the input
3747 event from Fx_popup_menu; menus using the minibuf use read_char recursively
3748 and do auto-saving in the inner call of read_char. */
3751 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
3754 Lisp_Object prev_event
;
3755 int *used_mouse_menu
;
3758 register Lisp_Object name
;
3759 Lisp_Object rest
, vector
;
3761 if (used_mouse_menu
)
3762 *used_mouse_menu
= 0;
3764 /* Use local over global Menu maps */
3766 if (! menu_prompting
)
3769 /* Get the menu name from the first map that has one (a prompt string). */
3770 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3772 name
= map_prompt (maps
[mapno
]);
3777 /* If we don't have any menus, just read a character normally. */
3781 #ifdef HAVE_X_WINDOWS
3783 /* If we got to this point via a mouse click,
3784 use a real menu for mouse selection. */
3785 if (EVENT_HAS_PARAMETERS (prev_event
))
3787 /* Display the menu and get the selection. */
3788 Lisp_Object
*realmaps
3789 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
3793 /* Use the maps that are not nil. */
3794 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3795 if (!NILP (maps
[mapno
]))
3796 realmaps
[nmaps1
++] = maps
[mapno
];
3798 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
3801 /* If we got more than one event, put all but the first
3802 onto this list to be read later.
3803 Return just the first event now. */
3804 unread_command_events
3805 = nconc2 (XCONS (value
)->cdr
, unread_command_events
);
3806 value
= XCONS (value
)->car
;
3810 if (used_mouse_menu
)
3811 *used_mouse_menu
= 1;
3814 #endif /* HAVE_X_MENU */
3815 #endif /* HAVE_X_WINDOWS */
3820 read_char_minibuf_menu_prompt(commandflag
, nmaps
, maps
)
3826 register Lisp_Object name
;
3828 int width
= FRAME_WIDTH (selected_frame
) - 4;
3829 char *menu
= (char *) alloca (width
+ 4);
3832 Lisp_Object rest
, vector
;
3834 if (! menu_prompting
)
3837 /* Get the menu name from the first map that has one (a prompt string). */
3838 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3840 name
= map_prompt (maps
[mapno
]);
3845 /* If we don't have any menus, just read a character normally. */
3849 /* Prompt string always starts with map's prompt, and a space. */
3850 strcpy (menu
, XSTRING (name
)->data
);
3851 nlength
= XSTRING (name
)->size
;
3852 menu
[nlength
++] = ':';
3853 menu
[nlength
++] = ' ';
3856 /* Start prompting at start of first map. */
3860 /* Present the documented bindings, a line at a time. */
3867 int orig_defn_macro
;
3869 /* Loop over elements of map. */
3874 /* If reached end of map, start at beginning of next map. */
3878 /* At end of last map, wrap around to first map if just starting,
3879 or end this line if already have something on it. */
3883 if (notfirst
|| nobindings
) break;
3888 /* Look at the next element of the map. */
3890 elt
= XVECTOR (vector
)->contents
[idx
];
3892 elt
= Fcar_safe (rest
);
3894 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
3896 /* If we found a dense table in the keymap,
3897 advanced past it, but start scanning its contents. */
3898 rest
= Fcdr_safe (rest
);
3904 /* An ordinary element. */
3906 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
3908 s
= Fcar_safe(elt
); /* vector */
3909 if (XTYPE (s
) != Lisp_String
)
3910 /* Ignore the element if it has no prompt string. */
3912 /* If we have room for the prompt string, add it to this line.
3913 If this is the first on the line, always add it. */
3914 else if (XSTRING (s
)->size
+ i
+ 2 < width
3919 /* Punctuate between strings. */
3922 strcpy (menu
+ i
, ", ");
3928 /* Add as much of string as fits. */
3929 thiswidth
= XSTRING (s
)->size
;
3930 if (thiswidth
+ i
> width
)
3931 thiswidth
= width
- i
;
3932 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
3938 /* If this element does not fit, end the line now,
3939 and save the element for the next line. */
3940 strcpy (menu
+ i
, "...");
3944 /* Move past this element. */
3945 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
3946 /* Handle reaching end of dense table. */
3951 rest
= Fcdr_safe (rest
);
3955 /* Prompt with that and read response. */
3958 /* Make believe its not a keyboard macro in case the help char
3959 is pressed. Help characters are not recorded because menu prompting
3960 is not used on replay.
3962 orig_defn_macro
= defining_kbd_macro
;
3963 defining_kbd_macro
= 0 ;
3965 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
3966 while (XTYPE (obj
) == Lisp_Buffer
);
3967 defining_kbd_macro
= orig_defn_macro
;
3969 if (XTYPE (obj
) != Lisp_Int
)
3974 if (! EQ (obj
, menu_prompt_more_char
)
3975 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
3976 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
3978 if ( defining_kbd_macro
)
3979 store_kbd_macro_char(obj
) ;
3982 /* Help char - go round again */
3986 /* Reading key sequences. */
3988 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
3989 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
3990 keymap, or nil otherwise. Return the index of the first keymap in
3991 which KEY has any binding, or NMAPS if no map has a binding.
3993 If KEY is a meta ASCII character, treat it like meta-prefix-char
3994 followed by the corresponding non-meta character. Keymaps in
3995 CURRENT with non-prefix bindings for meta-prefix-char become nil in
3998 When KEY is not defined in any of the keymaps, if it is an upper
3999 case letter and there are bindings for the corresponding lower-case
4000 letter, return the bindings for the lower-case letter.
4001 We store 1 in *CASE_CONVERTED in this case.
4002 Otherwise, we don't change *CASE_CONVERTED.
4004 If KEY has no bindings in any of the CURRENT maps, NEXT is left
4007 NEXT may == CURRENT. */
4010 follow_key (key
, nmaps
, current
, defs
, next
, case_converted
)
4012 Lisp_Object
*current
, *defs
, *next
;
4014 int *case_converted
;
4016 int i
, first_binding
;
4018 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
4019 followed by the corresponding non-meta character. */
4020 if (XTYPE (key
) == Lisp_Int
&& (XINT (key
) & CHAR_META
))
4022 for (i
= 0; i
< nmaps
; i
++)
4023 if (! NILP (current
[i
]))
4026 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
4028 /* Note that since we pass the resulting bindings through
4029 get_keymap_1, non-prefix bindings for meta-prefix-char
4031 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
4037 XSET (key
, Lisp_Int
, XFASTINT (key
) & ~CHAR_META
);
4040 first_binding
= nmaps
;
4041 for (i
= nmaps
- 1; i
>= 0; i
--)
4043 if (! NILP (current
[i
]))
4045 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
4046 if (! NILP (defs
[i
]))
4053 /* When KEY is not defined in any of the keymaps, if it is an upper
4054 case letter and there are bindings for the corresponding
4055 lower-case letter, return the bindings for the lower-case letter. */
4056 if (first_binding
== nmaps
4057 && XTYPE (key
) == Lisp_Int
4058 && ((((XINT (key
) & 0x3ffff)
4059 < XSTRING (current_buffer
->downcase_table
)->size
)
4060 && UPPERCASEP (XINT (key
) & 0x3ffff))
4061 || (XINT (key
) & shift_modifier
)))
4063 if (XINT (key
) & shift_modifier
)
4064 XSETINT (key
, XINT (key
) & ~shift_modifier
);
4066 XSETINT (key
, (DOWNCASE (XINT (key
) & 0x3ffff)
4067 | (XINT (key
) & ~0x3ffff)));
4069 first_binding
= nmaps
;
4070 for (i
= nmaps
- 1; i
>= 0; i
--)
4072 if (! NILP (current
[i
]))
4074 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
4075 if (! NILP (defs
[i
]))
4081 if (first_binding
!= nmaps
)
4082 *case_converted
= 1;
4085 /* Given the set of bindings we've found, produce the next set of maps. */
4086 if (first_binding
< nmaps
)
4087 for (i
= 0; i
< nmaps
; i
++)
4088 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
4090 return first_binding
;
4093 /* Read a sequence of keys that ends with a non prefix character,
4094 storing it in KEYBUF, a buffer of size BUFSIZE.
4096 Return the length of the key sequence stored.
4097 Return -1 if the user rejected a command menu.
4099 Echo starting immediately unless `prompt' is 0.
4101 Where a key sequence ends depends on the currently active keymaps.
4102 These include any minor mode keymaps active in the current buffer,
4103 the current buffer's local map, and the global map.
4105 If a key sequence has no other bindings, we check Vfunction_key_map
4106 to see if some trailing subsequence might be the beginning of a
4107 function key's sequence. If so, we try to read the whole function
4108 key, and substitute its symbolic name into the key sequence.
4110 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
4111 `double-' events into similar click events, if that would make them
4112 bound. We try to turn `triple-' events first into `double-' events,
4115 If we get a mouse click in a mode line, vertical divider, or other
4116 non-text area, we treat the click as if it were prefixed by the
4117 symbol denoting that area - `mode-line', `vertical-line', or
4120 If the sequence starts with a mouse click, we read the key sequence
4121 with respect to the buffer clicked on, not the current buffer.
4123 If the user switches frames in the midst of a key sequence, we put
4124 off the switch-frame event until later; the next call to
4125 read_char will return it. */
4128 read_key_sequence (keybuf
, bufsize
, prompt
)
4129 Lisp_Object
*keybuf
;
4133 int count
= specpdl_ptr
- specpdl
;
4135 /* How many keys there are in the current key sequence. */
4138 /* The length of the echo buffer when we started reading, and
4139 the length of this_command_keys when we started reading. */
4143 /* The number of keymaps we're scanning right now, and the number of
4144 keymaps we have allocated space for. */
4146 int nmaps_allocated
= 0;
4148 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
4149 the current keymaps. */
4152 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
4153 in the current keymaps, or nil where it is not a prefix. */
4154 Lisp_Object
*submaps
;
4156 /* The index in defs[] of the first keymap that has a binding for
4157 this key sequence. In other words, the lowest i such that
4158 defs[i] is non-nil. */
4161 /* If t < mock_input, then KEYBUF[t] should be read as the next
4164 We use this to recover after recognizing a function key. Once we
4165 realize that a suffix of the current key sequence is actually a
4166 function key's escape sequence, we replace the suffix with the
4167 function key's binding from Vfunction_key_map. Now keybuf
4168 contains a new and different key sequence, so the echo area,
4169 this_command_keys, and the submaps and defs arrays are wrong. In
4170 this situation, we set mock_input to t, set t to 0, and jump to
4171 restart_sequence; the loop will read keys from keybuf up until
4172 mock_input, thus rebuilding the state; and then it will resume
4173 reading characters from the keyboard. */
4176 /* If the sequence is unbound in submaps[], then
4177 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
4178 and fkey_map is its binding.
4180 These might be > t, indicating that all function key scanning
4181 should hold off until t reaches them. We do this when we've just
4182 recognized a function key, to avoid searching for the function
4183 key's again in Vfunction_key_map. */
4184 int fkey_start
= 0, fkey_end
= 0;
4185 Lisp_Object fkey_map
;
4187 /* Likewise, for key_translation_map. */
4188 int keytran_start
= 0, keytran_end
= 0;
4189 Lisp_Object keytran_map
;
4191 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
4192 we put it off for later. While we're reading, we keep the event here. */
4193 Lisp_Object delayed_switch_frame
;
4195 /* See the comment below... */
4196 #if defined (GOBBLE_FIRST_EVENT)
4197 Lisp_Object first_event
;
4200 struct buffer
*starting_buffer
;
4202 /* Nonzero if we found the binding for one of the chars
4203 in this key sequence by downcasing it. */
4204 int case_converted
= 0;
4206 /* Nonzero if we seem to have got the beginning of a binding
4207 in function_key_map. */
4208 int function_key_possible
= 0;
4212 last_nonmenu_event
= Qnil
;
4214 delayed_switch_frame
= Qnil
;
4215 fkey_map
= Vfunction_key_map
;
4216 keytran_map
= Vkey_translation_map
;
4218 /* If there is no function-key-map, turn off function key scanning. */
4219 if (NILP (Fkeymapp (Vfunction_key_map
)))
4220 fkey_start
= fkey_end
= bufsize
+ 1;
4222 /* If there is no key-translation-map, turn off scanning. */
4223 if (NILP (Fkeymapp (Vkey_translation_map
)))
4224 keytran_start
= keytran_end
= bufsize
+ 1;
4229 echo_prompt (XSTRING (prompt
)->data
);
4230 else if (cursor_in_echo_area
)
4231 /* This doesn't put in a dash if the echo buffer is empty, so
4232 you don't always see a dash hanging out in the minibuffer. */
4236 /* Record the initial state of the echo area and this_command_keys;
4237 we will need to restore them if we replay a key sequence. */
4239 echo_start
= echo_length ();
4240 keys_start
= this_command_key_count
;
4242 #if defined (GOBBLE_FIRST_EVENT)
4243 /* This doesn't quite work, because some of the things that read_char
4244 does cannot safely be bypassed. It seems too risky to try to make
4247 /* Read the first char of the sequence specially, before setting
4248 up any keymaps, in case a filter runs and switches buffers on us. */
4249 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
4251 #endif /* GOBBLE_FIRST_EVENT */
4253 /* We jump here when the key sequence has been thoroughly changed, and
4254 we need to rescan it starting from the beginning. When we jump here,
4255 keybuf[0..mock_input] holds the sequence we should reread. */
4258 starting_buffer
= current_buffer
;
4260 function_key_possible
= 0;
4262 /* Build our list of keymaps.
4263 If we recognize a function key and replace its escape sequence in
4264 keybuf with its symbol, or if the sequence starts with a mouse
4265 click and we need to switch buffers, we jump back here to rebuild
4266 the initial keymaps from the current buffer. */
4270 if (!NILP (Voverriding_local_map
))
4273 if (nmaps
> nmaps_allocated
)
4275 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4276 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4277 nmaps_allocated
= nmaps
;
4279 submaps
[0] = Voverriding_local_map
;
4283 nmaps
= current_minor_maps (0, &maps
) + 2;
4284 if (nmaps
> nmaps_allocated
)
4286 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4287 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4288 nmaps_allocated
= nmaps
;
4290 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
4291 #ifdef USE_TEXT_PROPERTIES
4292 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
4294 submaps
[nmaps
-2] = current_buffer
->keymap
;
4297 submaps
[nmaps
-1] = current_global_map
;
4300 /* Find an accurate initial value for first_binding. */
4301 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
4302 if (! NILP (submaps
[first_binding
]))
4305 /* Start from the beginning in keybuf. */
4308 /* These are no-ops the first time through, but if we restart, they
4309 revert the echo area and this_command_keys to their original state. */
4310 this_command_key_count
= keys_start
;
4311 if (INTERACTIVE
&& t
< mock_input
)
4312 echo_truncate (echo_start
);
4314 /* If the best binding for the current key sequence is a keymap, or
4315 we may be looking at a function key's escape sequence, keep on
4317 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
4318 || (first_binding
>= nmaps
4320 /* mock input is never part of a function key's sequence. */
4321 && mock_input
<= fkey_start
)
4322 || (first_binding
>= nmaps
4323 && keytran_start
< t
4324 /* mock input is never part of a function key's sequence. */
4325 && mock_input
<= keytran_start
)
4326 /* Don't return in the middle of a possible function key sequence,
4327 if the only bindings we found were via case conversion.
4328 Thus, if ESC O a has a function-key-map translation
4329 and ESC o has a binding, don't return after ESC O,
4330 so that we can translate ESC O plus the next character. */
4331 || (function_key_possible
&& case_converted
))
4334 int used_mouse_menu
= 0;
4336 /* Where the last real key started. If we need to throw away a
4337 key that has expanded into more than one element of keybuf
4338 (say, a mouse click on the mode line which is being treated
4339 as [mode-line (mouse-...)], then we backtrack to this point
4341 int last_real_key_start
;
4343 /* These variables are analogous to echo_start and keys_start;
4344 while those allow us to restart the entire key sequence,
4345 echo_local_start and keys_local_start allow us to throw away
4347 int echo_local_start
, keys_local_start
, local_first_binding
;
4350 error ("key sequence too long");
4353 echo_local_start
= echo_length ();
4354 keys_local_start
= this_command_key_count
;
4355 local_first_binding
= first_binding
;
4358 /* These are no-ops, unless we throw away a keystroke below and
4359 jumped back up to replay_key; in that case, these restore the
4360 variables to their original state, allowing us to replay the
4362 if (INTERACTIVE
&& t
< mock_input
)
4363 echo_truncate (echo_local_start
);
4364 this_command_key_count
= keys_local_start
;
4365 first_binding
= local_first_binding
;
4367 /* By default, assume each event is "real". */
4368 last_real_key_start
= t
;
4370 /* Does mock_input indicate that we are re-reading a key sequence? */
4374 add_command_key (key
);
4378 /* If not, we should actually read a character. */
4381 struct buffer
*buf
= current_buffer
;
4383 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
4386 /* read_char returns t when it shows a menu and the user rejects it.
4391 /* read_char returns -1 at the end of a macro.
4392 Emacs 18 handles this by returning immediately with a
4393 zero, so that's what we'll do. */
4394 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) == -1)
4400 /* If the current buffer has been changed from under us, the
4401 keymap may have changed, so replay the sequence. */
4402 if (XTYPE (key
) == Lisp_Buffer
)
4405 goto replay_sequence
;
4408 /* If we have a quit that was typed in another frame, and
4409 quit_throw_to_read_char switched buffers,
4410 replay to get the right keymap. */
4411 if (EQ (key
, quit_char
) && current_buffer
!= starting_buffer
)
4416 goto replay_sequence
;
4422 /* Clicks in non-text areas get prefixed by the symbol
4423 in their CHAR-ADDRESS field. For example, a click on
4424 the mode line is prefixed by the symbol `mode-line'.
4426 Furthermore, key sequences beginning with mouse clicks
4427 are read using the keymaps of the buffer clicked on, not
4428 the current buffer. So we may have to switch the buffer
4431 When we turn one event into two events, we must make sure
4432 that neither of the two looks like the original--so that,
4433 if we replay the events, they won't be expanded again.
4434 If not for this, such reexpansion could happen either here
4435 or when user programs play with this-command-keys. */
4436 if (EVENT_HAS_PARAMETERS (key
))
4438 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
4440 if (EQ (kind
, Qmouse_click
))
4442 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
4443 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4445 if (XTYPE (posn
) == Lisp_Cons
)
4447 /* We're looking at the second event of a
4448 sequence which we expanded before. Set
4449 last_real_key_start appropriately. */
4451 last_real_key_start
= t
- 1;
4454 /* Key sequences beginning with mouse clicks are
4455 read using the keymaps in the buffer clicked on,
4456 not the current buffer. If we're at the
4457 beginning of a key sequence, switch buffers. */
4458 if (last_real_key_start
== 0
4459 && XTYPE (window
) == Lisp_Window
4460 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
4461 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
4466 /* Arrange to go back to the original buffer once we're
4467 done reading the key sequence. Note that we can't
4468 use save_excursion_{save,restore} here, because they
4469 save point as well as the current buffer; we don't
4470 want to save point, because redisplay may change it,
4471 to accommodate a Fset_window_start or something. We
4472 don't want to do this at the top of the function,
4473 because we may get input from a subprocess which
4474 wants to change the selected window and stuff (say,
4476 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
4478 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
4479 goto replay_sequence
;
4481 else if (XTYPE (posn
) == Lisp_Symbol
)
4483 /* Expand mode-line and scroll-bar events into two events:
4484 use posn as a fake prefix key. */
4486 if (t
+ 1 >= bufsize
)
4487 error ("key sequence too long");
4492 /* Zap the position in key, so we know that we've
4493 expanded it, and don't try to do so again. */
4494 POSN_BUFFER_POSN (EVENT_START (key
))
4495 = Fcons (posn
, Qnil
);
4499 else if (EQ (kind
, Qswitch_frame
))
4501 /* If we're at the beginning of a key sequence, go
4502 ahead and return this event. If we're in the
4503 midst of a key sequence, delay it until the end. */
4506 delayed_switch_frame
= key
;
4512 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4514 /* Handle menu-bar events:
4515 insert the dummy prefix event `menu-bar'. */
4516 if (EQ (posn
, Qmenu_bar
))
4518 if (t
+ 1 >= bufsize
)
4519 error ("key sequence too long");
4520 /* Run the Lucid hook. */
4521 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4522 /* If it has changed current-menubar from previous value,
4523 really recompute the menubar from the value. */
4524 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4525 call0 (Qrecompute_lucid_menubar
);
4529 /* Zap the position in key, so we know that we've
4530 expanded it, and don't try to do so again. */
4531 POSN_BUFFER_POSN (EVENT_START (key
))
4532 = Fcons (posn
, Qnil
);
4535 goto replay_sequence
;
4537 else if (XTYPE (posn
) == Lisp_Cons
)
4539 /* We're looking at the second event of a
4540 sequence which we expanded before. Set
4541 last_real_key_start appropriately. */
4542 if (last_real_key_start
== t
&& t
> 0)
4543 last_real_key_start
= t
- 1;
4548 /* We have finally decided that KEY is something we might want
4550 first_binding
= (follow_key (key
,
4551 nmaps
- first_binding
,
4552 submaps
+ first_binding
,
4553 defs
+ first_binding
,
4554 submaps
+ first_binding
,
4558 /* If KEY wasn't bound, we'll try some fallbacks. */
4559 if (first_binding
>= nmaps
)
4561 Lisp_Object head
= EVENT_HEAD (key
);
4563 if (EQ (head
, Vhelp_char
))
4565 read_key_sequence_cmd
= Vprefix_help_command
;
4567 last_nonmenu_event
= key
;
4571 if (XTYPE (head
) == Lisp_Symbol
)
4573 Lisp_Object breakdown
= parse_modifiers (head
);
4574 int modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4576 /* Attempt to reduce an unbound mouse event to a simpler
4577 event that is bound:
4578 Drags reduce to clicks.
4579 Double-clicks reduce to clicks.
4580 Triple-clicks reduce to double-clicks, then to clicks.
4581 Down-clicks are eliminated.
4582 Double-downs reduce to downs, then are eliminated.
4583 Triple-downs reduce to double-downs, then to downs,
4584 then are eliminated. */
4585 if (modifiers
& (down_modifier
| drag_modifier
4586 | double_modifier
| triple_modifier
))
4588 while (modifiers
& (down_modifier
| drag_modifier
4589 | double_modifier
| triple_modifier
))
4591 Lisp_Object new_head
, new_click
;
4592 if (modifiers
& triple_modifier
)
4593 modifiers
^= (double_modifier
| triple_modifier
);
4594 else if (modifiers
& (drag_modifier
| double_modifier
))
4595 modifiers
&= ~(drag_modifier
| double_modifier
);
4598 /* Dispose of this `down' event by simply jumping
4599 back to replay_key, to get another event.
4601 Note that if this event came from mock input,
4602 then just jumping back to replay_key will just
4603 hand it to us again. So we have to wipe out any
4606 We could delete keybuf[t] and shift everything
4607 after that to the left by one spot, but we'd also
4608 have to fix up any variable that points into
4609 keybuf, and shifting isn't really necessary
4612 Adding prefixes for non-textual mouse clicks
4613 creates two characters of mock input, and both
4614 must be thrown away. If we're only looking at
4615 the prefix now, we can just jump back to
4616 replay_key. On the other hand, if we've already
4617 processed the prefix, and now the actual click
4618 itself is giving us trouble, then we've lost the
4619 state of the keymaps we want to backtrack to, and
4620 we need to replay the whole sequence to rebuild
4623 Beyond that, only function key expansion could
4624 create more than two keys, but that should never
4625 generate mouse events, so it's okay to zero
4626 mock_input in that case too.
4628 Isn't this just the most wonderful code ever? */
4629 if (t
== last_real_key_start
)
4636 mock_input
= last_real_key_start
;
4637 goto replay_sequence
;
4642 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
4644 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
4646 /* Look for a binding for this new key. follow_key
4647 promises that it didn't munge submaps the
4648 last time we called it, since key was unbound. */
4650 = (follow_key (new_click
,
4651 nmaps
- local_first_binding
,
4652 submaps
+ local_first_binding
,
4653 defs
+ local_first_binding
,
4654 submaps
+ local_first_binding
,
4656 + local_first_binding
);
4658 /* If that click is bound, go for it. */
4659 if (first_binding
< nmaps
)
4664 /* Otherwise, we'll leave key set to the drag event. */
4671 /* Normally, last_nonmenu_event gets the previous key we read.
4672 But when a mouse popup menu is being used,
4673 we don't update last_nonmenu_event; it continues to hold the mouse
4674 event that preceded the first level of menu. */
4675 if (!used_mouse_menu
)
4676 last_nonmenu_event
= key
;
4678 /* If the sequence is unbound, see if we can hang a function key
4679 off the end of it. We only want to scan real keyboard input
4680 for function key sequences, so if mock_input says that we're
4681 re-reading old events, don't examine it. */
4682 if ((first_binding
>= nmaps
|| case_converted
)
4685 Lisp_Object fkey_next
;
4687 /* Continue scan from fkey_end until we find a bound suffix.
4688 If we fail, increment fkey_start
4689 and start fkey_end from there. */
4690 while (fkey_end
< t
)
4694 key
= keybuf
[fkey_end
++];
4695 /* Look up meta-characters by prefixing them
4696 with meta_prefix_char. I hate this. */
4697 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4702 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
4704 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4707 fkey_next
= fkey_map
;
4710 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
4712 /* If the function key map gives a function, not an
4713 array, then call the function with no args and use
4714 its value instead. */
4715 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
4718 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4722 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4723 fkey_next
= call1 (fkey_next
, prompt
);
4725 /* If the function returned something invalid,
4726 barf--don't ignore it.
4727 (To ignore it safely, we would need to gcpro a bunch of
4728 other variables.) */
4729 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
4730 error ("Function in function-key-map returns invalid key sequence");
4733 function_key_possible
= ! NILP (fkey_next
);
4735 /* If keybuf[fkey_start..fkey_end] is bound in the
4736 function key map and it's a suffix of the current
4737 sequence (i.e. fkey_end == t), replace it with
4738 the binding and restart with fkey_start at the end. */
4739 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
4742 int len
= XFASTINT (Flength (fkey_next
));
4744 t
= fkey_start
+ len
;
4746 error ("key sequence too long");
4748 if (VECTORP (fkey_next
))
4749 bcopy (XVECTOR (fkey_next
)->contents
,
4750 keybuf
+ fkey_start
,
4751 (t
- fkey_start
) * sizeof (keybuf
[0]));
4752 else if (STRINGP (fkey_next
))
4756 for (i
= 0; i
< len
; i
++)
4757 XFASTINT (keybuf
[fkey_start
+ i
])
4758 = XSTRING (fkey_next
)->data
[i
];
4762 fkey_start
= fkey_end
= t
;
4763 fkey_map
= Vfunction_key_map
;
4765 goto replay_sequence
;
4768 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
4770 /* If we no longer have a bound suffix, try a new positions for
4772 if (NILP (fkey_map
))
4774 fkey_end
= ++fkey_start
;
4775 fkey_map
= Vfunction_key_map
;
4776 function_key_possible
= 0;
4781 /* Look for this sequence in key-translation-map. */
4783 Lisp_Object keytran_next
;
4785 /* Scan from keytran_end until we find a bound suffix. */
4786 while (keytran_end
< t
)
4790 key
= keybuf
[keytran_end
++];
4791 /* Look up meta-characters by prefixing them
4792 with meta_prefix_char. I hate this. */
4793 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4798 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
4800 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4803 keytran_next
= keytran_map
;
4806 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
4808 /* If the key translation map gives a function, not an
4809 array, then call the function with no args and use
4810 its value instead. */
4811 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
4812 && keytran_end
== t
)
4814 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4818 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4819 keytran_next
= call1 (keytran_next
, prompt
);
4821 /* If the function returned something invalid,
4822 barf--don't ignore it.
4823 (To ignore it safely, we would need to gcpro a bunch of
4824 other variables.) */
4825 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
4826 error ("Function in key-translation-map returns invalid key sequence");
4829 /* If keybuf[keytran_start..keytran_end] is bound in the
4830 key translation map and it's a suffix of the current
4831 sequence (i.e. keytran_end == t), replace it with
4832 the binding and restart with keytran_start at the end. */
4833 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
4834 && keytran_end
== t
)
4836 int len
= XFASTINT (Flength (keytran_next
));
4838 t
= keytran_start
+ len
;
4840 error ("key sequence too long");
4842 if (VECTORP (keytran_next
))
4843 bcopy (XVECTOR (keytran_next
)->contents
,
4844 keybuf
+ keytran_start
,
4845 (t
- keytran_start
) * sizeof (keybuf
[0]));
4846 else if (STRINGP (keytran_next
))
4850 for (i
= 0; i
< len
; i
++)
4851 XFASTINT (keybuf
[keytran_start
+ i
])
4852 = XSTRING (keytran_next
)->data
[i
];
4856 keytran_start
= keytran_end
= t
;
4857 keytran_map
= Vkey_translation_map
;
4859 goto replay_sequence
;
4862 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
4864 /* If we no longer have a bound suffix, try a new positions for
4866 if (NILP (keytran_map
))
4868 keytran_end
= ++keytran_start
;
4869 keytran_map
= Vkey_translation_map
;
4875 read_key_sequence_cmd
= (first_binding
< nmaps
4876 ? defs
[first_binding
]
4880 unread_switch_frame
= delayed_switch_frame
;
4881 unbind_to (count
, Qnil
);
4883 /* Occasionally we fabricate events, perhaps by expanding something
4884 according to function-key-map, or by adding a prefix symbol to a
4885 mouse click in the scroll bar or modeline. In this cases, return
4886 the entire generated key sequence, even if we hit an unbound
4887 prefix or a definition before the end. This means that you will
4888 be able to push back the event properly, and also means that
4889 read-key-sequence will always return a logical unit.
4892 for (; t
< mock_input
; t
++)
4894 echo_char (keybuf
[t
]);
4895 add_command_key (keybuf
[t
]);
4901 #if 0 /* This doc string is too long for some compilers.
4902 This commented-out definition serves for DOC. */
4903 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4904 "Read a sequence of keystrokes and return as a string or vector.\n\
4905 The sequence is sufficient to specify a non-prefix command in the\n\
4906 current local and global maps.\n\
4908 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
4909 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
4910 as a continuation of the previous key.\n\
4912 A C-g typed while in this function is treated like any other character,\n\
4913 and `quit-flag' is not set.\n\
4915 If the key sequence starts with a mouse click, then the sequence is read\n\
4916 using the keymaps of the buffer of the window clicked in, not the buffer\n\
4917 of the selected window as normal.\n\
4919 `read-key-sequence' drops unbound button-down events, since you normally\n\
4920 only care about the click or drag events which follow them. If a drag\n\
4921 or multi-click event is unbound, but the corresponding click event would\n\
4922 be bound, `read-key-sequence' turns the event into a click event at the\n\
4923 drag's starting position. This means that you don't have to distinguish\n\
4924 between click and drag, double, or triple events unless you want to.\n\
4926 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
4927 lines separating windows, and scroll bars with imaginary keys\n\
4928 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
4930 If the user switches frames in the middle of a key sequence, the\n\
4931 frame-switch event is put off until after the current key sequence.\n\
4933 `read-key-sequence' checks `function-key-map' for function key\n\
4934 sequences, where they wouldn't conflict with ordinary bindings. See\n\
4935 `function-key-map' for more details.")
4936 (prompt
, continue_echo
)
4939 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4941 (prompt
, continue_echo
)
4942 Lisp_Object prompt
, continue_echo
;
4944 Lisp_Object keybuf
[30];
4946 struct gcpro gcpro1
, gcpro2
;
4949 CHECK_STRING (prompt
, 0);
4952 bzero (keybuf
, sizeof keybuf
);
4954 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
4956 if (NILP (continue_echo
))
4957 this_command_key_count
= 0;
4959 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])), prompt
);
4967 return make_event_array (i
, keybuf
);
4970 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
4971 "Execute CMD as an editor command.\n\
4972 CMD must be a symbol that satisfies the `commandp' predicate.\n\
4973 Optional second arg RECORD-FLAG non-nil\n\
4974 means unconditionally put this command in `command-history'.\n\
4975 Otherwise, that is done only if an arg is read using the minibuffer.")
4977 Lisp_Object cmd
, record
;
4979 register Lisp_Object final
;
4980 register Lisp_Object tem
;
4981 Lisp_Object prefixarg
;
4982 struct backtrace backtrace
;
4983 extern int debug_on_next_call
;
4985 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
4986 Vcurrent_prefix_arg
= prefixarg
;
4987 debug_on_next_call
= 0;
4989 if (XTYPE (cmd
) == Lisp_Symbol
)
4991 tem
= Fget (cmd
, Qdisabled
);
4993 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
4998 final
= Findirect_function (cmd
);
5000 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
5001 do_autoload (final
, cmd
);
5006 if (XTYPE (final
) == Lisp_String
5007 || XTYPE (final
) == Lisp_Vector
)
5009 /* If requested, place the macro in the command history. For
5010 other sorts of commands, call-interactively takes care of
5014 = Fcons (Fcons (Qexecute_kbd_macro
,
5015 Fcons (final
, Fcons (prefixarg
, Qnil
))),
5018 return Fexecute_kbd_macro (final
, prefixarg
);
5020 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
5021 || XTYPE (final
) == Lisp_Compiled
)
5023 backtrace
.next
= backtrace_list
;
5024 backtrace_list
= &backtrace
;
5025 backtrace
.function
= &Qcall_interactively
;
5026 backtrace
.args
= &cmd
;
5027 backtrace
.nargs
= 1;
5028 backtrace
.evalargs
= 0;
5030 tem
= Fcall_interactively (cmd
, record
);
5032 backtrace_list
= backtrace
.next
;
5038 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
5040 "Read function name, then read its arguments and call it.")
5042 Lisp_Object prefixarg
;
5044 Lisp_Object function
;
5046 Lisp_Object saved_keys
;
5047 struct gcpro gcpro1
;
5049 saved_keys
= Fvector (this_command_key_count
,
5050 XVECTOR (this_command_keys
)->contents
);
5052 GCPRO1 (saved_keys
);
5054 if (EQ (prefixarg
, Qminus
))
5056 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
5057 strcpy (buf
, "C-u ");
5058 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
5059 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
5060 else if (XTYPE (prefixarg
) == Lisp_Int
)
5061 sprintf (buf
, "%d ", XINT (prefixarg
));
5063 /* This isn't strictly correct if execute-extended-command
5064 is bound to anything else. Perhaps it should use
5065 this_command_keys? */
5066 strcat (buf
, "M-x ");
5068 /* Prompt with buf, and then read a string, completing from and
5069 restricting to the set of all defined commands. Don't provide
5070 any initial input. Save the command read on the extended-command
5072 function
= Fcompleting_read (build_string (buf
),
5073 Vobarray
, Qcommandp
,
5074 Qt
, Qnil
, Qextended_command_history
);
5076 /* Set this_command_keys to the concatenation of saved_keys and
5077 function, followed by a RET. */
5079 struct Lisp_String
*str
;
5084 this_command_key_count
= 0;
5086 keys
= XVECTOR (saved_keys
)->contents
;
5087 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
5088 add_command_key (keys
[i
]);
5090 str
= XSTRING (function
);
5091 for (i
= 0; i
< str
->size
; i
++)
5093 XFASTINT (tem
) = str
->data
[i
];
5094 add_command_key (tem
);
5097 XFASTINT (tem
) = '\015';
5098 add_command_key (tem
);
5103 function
= Fintern (function
, Qnil
);
5104 Vprefix_arg
= prefixarg
;
5105 this_command
= function
;
5107 return Fcommand_execute (function
, Qt
);
5111 detect_input_pending ()
5114 get_input_pending (&input_pending
);
5116 return input_pending
;
5119 /* This is called in some cases before a possible quit.
5120 It cases the next call to detect_input_pending to recompute input_pending.
5121 So calling this function unnecessarily can't do any harm. */
5122 clear_input_pending ()
5127 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
5128 "T if command input is currently available with no waiting.\n\
5129 Actually, the value is nil only if we can be sure that no input is available.")
5132 if (!NILP (unread_command_events
) || unread_command_char
!= -1)
5135 return detect_input_pending () ? Qt
: Qnil
;
5138 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
5139 "Return vector of last 100 events, not counting those from keyboard macros.")
5142 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
5145 if (total_keys
< NUM_RECENT_KEYS
)
5146 return Fvector (total_keys
, keys
);
5149 val
= Fvector (NUM_RECENT_KEYS
, keys
);
5150 bcopy (keys
+ recent_keys_index
,
5151 XVECTOR (val
)->contents
,
5152 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
5154 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
5155 recent_keys_index
* sizeof (Lisp_Object
));
5160 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
5161 "Return the key sequence that invoked this command.\n\
5162 The value is a string or a vector.")
5165 return make_event_array (this_command_key_count
,
5166 XVECTOR (this_command_keys
)->contents
);
5169 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
5170 "Return the current depth in recursive edits.")
5174 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
5178 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
5179 "FOpen dribble file: ",
5180 "Start writing all keyboard characters to a dribble file called FILE.\n\
5181 If FILE is nil, close any open dribble file.")
5192 file
= Fexpand_file_name (file
, Qnil
);
5193 dribble
= fopen (XSTRING (file
)->data
, "w");
5198 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
5199 "Discard the contents of the terminal input buffer.\n\
5200 Also cancel any kbd macro being defined.")
5203 defining_kbd_macro
= 0;
5204 update_mode_lines
++;
5206 unread_command_events
= Qnil
;
5207 unread_command_char
= -1;
5209 discard_tty_input ();
5211 /* Without the cast, GCC complains that this assignment loses the
5212 volatile qualifier of kbd_store_ptr. Is there anything wrong
5214 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
5215 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5221 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
5222 "Stop Emacs and return to superior process. You can resume later.\n\
5223 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
5224 control, run a subshell instead.\n\n\
5225 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
5226 to be read as terminal input by Emacs's parent, after suspension.\n\
5228 Before suspending, call the functions in `suspend-hook' with no args.\n\
5229 If any of them returns nil, don't call the rest and don't suspend.\n\
5230 Otherwise, suspend normally and after resumption run the normal hook\n\
5231 `suspend-resume-hook' if that is bound and non-nil.\n\
5233 Some operating systems cannot stop the Emacs process and resume it later.\n\
5234 On such systems, Emacs starts a subshell instead of suspending.")
5236 Lisp_Object stuffstring
;
5239 int count
= specpdl_ptr
- specpdl
;
5240 int old_height
, old_width
;
5242 struct gcpro gcpro1
, gcpro2
;
5243 extern init_sys_modes ();
5245 if (!NILP (stuffstring
))
5246 CHECK_STRING (stuffstring
, 0);
5248 /* Run the functions in suspend-hook. */
5249 if (!NILP (Vrun_hooks
))
5250 call1 (Vrun_hooks
, intern ("suspend-hook"));
5252 GCPRO1 (stuffstring
);
5253 get_frame_size (&old_width
, &old_height
);
5255 /* sys_suspend can get an error if it tries to fork a subshell
5256 and the system resources aren't available for that. */
5257 record_unwind_protect (init_sys_modes
, 0);
5258 stuff_buffered_input (stuffstring
);
5263 unbind_to (count
, Qnil
);
5265 /* Check if terminal/window size has changed.
5266 Note that this is not useful when we are running directly
5267 with a window system; but suspend should be disabled in that case. */
5268 get_frame_size (&width
, &height
);
5269 if (width
!= old_width
|| height
!= old_height
)
5270 change_frame_size (selected_frame
, height
, width
, 0, 0);
5272 /* Run suspend-resume-hook. */
5273 if (!NILP (Vrun_hooks
))
5274 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
5280 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
5281 Then in any case stuff anything Emacs has read ahead and not used. */
5283 stuff_buffered_input (stuffstring
)
5284 Lisp_Object stuffstring
;
5286 register unsigned char *p
;
5288 /* stuff_char works only in BSD, versions 4.2 and up. */
5291 if (XTYPE (stuffstring
) == Lisp_String
)
5295 p
= XSTRING (stuffstring
)->data
;
5296 count
= XSTRING (stuffstring
)->size
;
5301 /* Anything we have read ahead, put back for the shell to read. */
5302 while (kbd_fetch_ptr
!= kbd_store_ptr
)
5304 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
5305 kbd_fetch_ptr
= kbd_buffer
;
5306 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
5307 stuff_char (kbd_fetch_ptr
->code
);
5308 kbd_fetch_ptr
->kind
= no_event
;
5309 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
5316 #endif /* BSD and not BSD4_1 */
5319 set_waiting_for_input (time_to_clear
)
5320 EMACS_TIME
*time_to_clear
;
5322 input_available_clear_time
= time_to_clear
;
5324 /* Tell interrupt_signal to throw back to read_char, */
5325 waiting_for_input
= 1;
5327 /* If interrupt_signal was called before and buffered a C-g,
5328 make it run again now, to avoid timing error. */
5329 if (!NILP (Vquit_flag
))
5330 quit_throw_to_read_char ();
5333 clear_waiting_for_input ()
5335 /* Tell interrupt_signal not to throw back to read_char, */
5336 waiting_for_input
= 0;
5337 input_available_clear_time
= 0;
5340 /* This routine is called at interrupt level in response to C-G.
5341 If interrupt_input, this is the handler for SIGINT.
5342 Otherwise, it is called from kbd_buffer_store_event,
5343 in handling SIGIO or SIGTINT.
5345 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
5346 immediately throw back to read_char.
5348 Otherwise it sets the Lisp variable quit-flag not-nil.
5349 This causes eval to throw, when it gets a chance.
5350 If quit-flag is already non-nil, it stops the job right away. */
5356 /* Must preserve main program's value of errno. */
5357 int old_errno
= errno
;
5360 /* USG systems forget handlers when they are used;
5361 must reestablish each time */
5362 signal (SIGINT
, interrupt_signal
);
5363 signal (SIGQUIT
, interrupt_signal
);
5368 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
5373 #ifdef SIGTSTP /* Support possible in later USG versions */
5375 * On systems which can suspend the current process and return to the original
5376 * shell, this command causes the user to end up back at the shell.
5377 * The "Auto-save" and "Abort" questions are not asked until
5378 * the user elects to return to emacs, at which point he can save the current
5379 * job and either dump core or continue.
5384 if (sys_suspend () == -1)
5386 printf ("Not running as a subprocess;\n");
5387 printf ("you can continue or abort.\n");
5390 /* Perhaps should really fork an inferior shell?
5391 But that would not provide any way to get back
5392 to the original shell, ever. */
5393 printf ("No support for stopping a process on this operating system;\n");
5394 printf ("you can continue or abort.\n");
5395 #endif /* not VMS */
5396 #endif /* not SIGTSTP */
5398 /* We must remain inside the screen area when the internal terminal
5399 is used. Note that [Enter] is not echoed by dos. */
5402 printf ("Auto-save? (y or n) ");
5404 if (((c
= getchar ()) & ~040) == 'Y')
5406 Fdo_auto_save (Qt
, Qnil
);
5408 printf ("\r\nAuto-save done");
5409 #else /* not MSDOS */
5410 printf ("Auto-save done\n");
5411 #endif /* not MSDOS */
5413 while (c
!= '\n') c
= getchar ();
5415 printf ("\r\nAbort? (y or n) ");
5416 #else /* not MSDOS */
5418 printf ("Abort (and enter debugger)? (y or n) ");
5420 printf ("Abort (and dump core)? (y or n) ");
5421 #endif /* not VMS */
5422 #endif /* not MSDOS */
5424 if (((c
= getchar ()) & ~040) == 'Y')
5426 while (c
!= '\n') c
= getchar ();
5428 printf ("\r\nContinuing...\r\n");
5429 #else /* not MSDOS */
5430 printf ("Continuing...\n");
5431 #endif /* not MSDOS */
5437 /* If executing a function that wants to be interrupted out of
5438 and the user has not deferred quitting by binding `inhibit-quit'
5439 then quit right away. */
5440 if (immediate_quit
&& NILP (Vinhibit_quit
))
5444 Fsignal (Qquit
, Qnil
);
5447 /* Else request quit when it's safe */
5451 if (waiting_for_input
&& !echoing
)
5452 quit_throw_to_read_char ();
5457 /* Handle a C-g by making read_char return C-g. */
5459 quit_throw_to_read_char ()
5461 quit_error_check ();
5463 /* Prevent another signal from doing this before we finish. */
5464 clear_waiting_for_input ();
5467 unread_command_events
= Qnil
;
5468 unread_command_char
= -1;
5470 #ifdef POLL_FOR_INPUT
5471 /* May be > 1 if in recursive minibuffer. */
5472 if (poll_suppress_count
== 0)
5476 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
5477 && XFRAME (internal_last_event_frame
) != selected_frame
)
5478 Fhandle_switch_frame (make_lispy_switch_frame (internal_last_event_frame
));
5481 _longjmp (getcjmp
, 1);
5484 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
5485 "Set mode of reading keyboard input.\n\
5486 First arg INTERRUPT non-nil means use input interrupts;\n\
5487 nil means use CBREAK mode.\n\
5488 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
5489 (no effect except in CBREAK mode).\n\
5490 Third arg META t means accept 8-bit input (for a Meta key).\n\
5491 META nil means ignore the top bit, on the assumption it is parity.\n\
5492 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
5493 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
5494 See also `current-input-mode'.")
5495 (interrupt
, flow
, meta
, quit
)
5496 Lisp_Object interrupt
, flow
, meta
, quit
;
5499 && (XTYPE (quit
) != Lisp_Int
5500 || XINT (quit
) < 0 || XINT (quit
) > 0400))
5501 error ("set-input-mode: QUIT must be an ASCII character");
5503 #ifdef POLL_FOR_INPUT
5509 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5510 #ifdef NO_SOCK_SIGIO
5511 if (read_socket_hook
)
5512 interrupt_input
= 0; /* No interrupts if reading from a socket. */
5514 #endif /* NO_SOCK_SIGIO */
5515 interrupt_input
= !NILP (interrupt
);
5516 #else /* not SIGIO */
5517 interrupt_input
= 0;
5518 #endif /* not SIGIO */
5519 /* Our VMS input only works by interrupts, as of now. */
5521 interrupt_input
= 1;
5523 flow_control
= !NILP (flow
);
5526 else if (EQ (meta
, Qt
))
5531 /* Don't let this value be out of range. */
5532 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
5536 #ifdef POLL_FOR_INPUT
5537 poll_suppress_count
= 1;
5543 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
5544 "Return information about the way Emacs currently reads keyboard input.\n\
5545 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
5546 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
5547 nil, Emacs is using CBREAK mode.\n\
5548 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
5549 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
5550 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
5551 META nil means ignoring the top bit, on the assumption it is parity.\n\
5552 META is neither t nor nil if accepting 8-bit input and using\n\
5553 all 8 bits as the character code.\n\
5554 QUIT is the character Emacs currently uses to quit.\n\
5555 The elements of this list correspond to the arguments of\n\
5561 val
[0] = interrupt_input
? Qt
: Qnil
;
5562 val
[1] = flow_control
? Qt
: Qnil
;
5563 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
5564 XFASTINT (val
[3]) = quit_char
;
5566 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
5572 /* This is correct before outermost invocation of the editor loop */
5573 command_loop_level
= -1;
5575 quit_char
= Ctl ('g');
5576 unread_command_events
= Qnil
;
5577 unread_command_char
= -1;
5579 recent_keys_index
= 0;
5580 kbd_fetch_ptr
= kbd_buffer
;
5581 kbd_store_ptr
= kbd_buffer
;
5582 do_mouse_tracking
= 0;
5586 /* This means that command_loop_1 won't try to select anything the first
5588 internal_last_event_frame
= Qnil
;
5589 Vlast_event_frame
= internal_last_event_frame
;
5592 /* If we're running a dumped Emacs, we need to clear out
5593 kbd_buffer_frame_or_window, in case some events got into it
5596 If we're running an undumped Emacs, it hasn't been initialized by
5597 syms_of_keyboard yet. */
5599 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5601 if (!noninteractive
)
5603 signal (SIGINT
, interrupt_signal
);
5604 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
5605 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
5606 SIGQUIT and we can't tell which one it will give us. */
5607 signal (SIGQUIT
, interrupt_signal
);
5608 #endif /* HAVE_TERMIO */
5609 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5611 signal (SIGIO
, input_available_signal
);
5615 /* Use interrupt input by default, if it works and noninterrupt input
5616 has deficiencies. */
5618 #ifdef INTERRUPT_INPUT
5619 interrupt_input
= 1;
5621 interrupt_input
= 0;
5624 /* Our VMS input only works by interrupts, as of now. */
5626 interrupt_input
= 1;
5632 if (keyboard_init_hook
)
5633 (*keyboard_init_hook
) ();
5635 #ifdef POLL_FOR_INPUT
5636 poll_suppress_count
= 1;
5641 /* This type's only use is in syms_of_keyboard, to initialize the
5642 event header symbols and put properties on them. */
5649 struct event_head head_table
[] = {
5650 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
5651 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
5652 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
5657 Qdisabled_command_hook
= intern ("disabled-command-hook");
5658 staticpro (&Qdisabled_command_hook
);
5660 Qself_insert_command
= intern ("self-insert-command");
5661 staticpro (&Qself_insert_command
);
5663 Qforward_char
= intern ("forward-char");
5664 staticpro (&Qforward_char
);
5666 Qbackward_char
= intern ("backward-char");
5667 staticpro (&Qbackward_char
);
5669 Qdisabled
= intern ("disabled");
5670 staticpro (&Qdisabled
);
5672 Qundefined
= intern ("undefined");
5673 staticpro (&Qundefined
);
5675 Qpre_command_hook
= intern ("pre-command-hook");
5676 staticpro (&Qpre_command_hook
);
5678 Qpost_command_hook
= intern ("post-command-hook");
5679 staticpro (&Qpost_command_hook
);
5681 Qcommand_hook_internal
= intern ("command-hook-internal");
5682 staticpro (&Qcommand_hook_internal
);
5684 Qfunction_key
= intern ("function-key");
5685 staticpro (&Qfunction_key
);
5686 Qmouse_click
= intern ("mouse-click");
5687 staticpro (&Qmouse_click
);
5689 Qmenu_enable
= intern ("menu-enable");
5690 staticpro (&Qmenu_enable
);
5692 Qmode_line
= intern ("mode-line");
5693 staticpro (&Qmode_line
);
5694 Qvertical_line
= intern ("vertical-line");
5695 staticpro (&Qvertical_line
);
5696 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
5697 staticpro (&Qvertical_scroll_bar
);
5698 Qmenu_bar
= intern ("menu-bar");
5699 staticpro (&Qmenu_bar
);
5701 Qabove_handle
= intern ("above-handle");
5702 staticpro (&Qabove_handle
);
5703 Qhandle
= intern ("handle");
5704 staticpro (&Qhandle
);
5705 Qbelow_handle
= intern ("below-handle");
5706 staticpro (&Qbelow_handle
);
5708 Qevent_kind
= intern ("event-kind");
5709 staticpro (&Qevent_kind
);
5710 Qevent_symbol_elements
= intern ("event-symbol-elements");
5711 staticpro (&Qevent_symbol_elements
);
5712 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
5713 staticpro (&Qevent_symbol_element_mask
);
5714 Qmodifier_cache
= intern ("modifier-cache");
5715 staticpro (&Qmodifier_cache
);
5717 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
5718 staticpro (&Qrecompute_lucid_menubar
);
5719 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
5720 staticpro (&Qactivate_menubar_hook
);
5723 struct event_head
*p
;
5725 for (p
= head_table
;
5726 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
5729 *p
->var
= intern (p
->name
);
5731 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
5732 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
5736 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
5737 staticpro (&button_down_location
);
5741 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
5743 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
5744 for (i
= 0; i
< len
; i
++)
5745 if (modifier_names
[i
])
5746 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
5747 staticpro (&modifier_symbols
);
5750 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
5751 staticpro (&recent_keys
);
5753 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
5754 staticpro (&this_command_keys
);
5756 Qextended_command_history
= intern ("extended-command-history");
5757 Fset (Qextended_command_history
, Qnil
);
5758 staticpro (&Qextended_command_history
);
5760 kbd_buffer_frame_or_window
5761 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
5762 staticpro (&kbd_buffer_frame_or_window
);
5764 func_key_syms
= Qnil
;
5765 staticpro (&func_key_syms
);
5768 staticpro (&mouse_syms
);
5770 unread_switch_frame
= Qnil
;
5771 staticpro (&unread_switch_frame
);
5773 defsubr (&Sread_key_sequence
);
5774 defsubr (&Srecursive_edit
);
5775 defsubr (&Strack_mouse
);
5776 defsubr (&Sinput_pending_p
);
5777 defsubr (&Scommand_execute
);
5778 defsubr (&Srecent_keys
);
5779 defsubr (&Sthis_command_keys
);
5780 defsubr (&Ssuspend_emacs
);
5781 defsubr (&Sabort_recursive_edit
);
5782 defsubr (&Sexit_recursive_edit
);
5783 defsubr (&Srecursion_depth
);
5784 defsubr (&Stop_level
);
5785 defsubr (&Sdiscard_input
);
5786 defsubr (&Sopen_dribble_file
);
5787 defsubr (&Sset_input_mode
);
5788 defsubr (&Scurrent_input_mode
);
5789 defsubr (&Sexecute_extended_command
);
5791 DEFVAR_LISP ("last-command-char", &last_command_char
,
5792 "Last input event that was part of a command.");
5794 DEFVAR_LISP ("last-command-event", &last_command_char
,
5795 "Last input event that was part of a command.");
5797 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
5798 "Last input event in a command, except for mouse menu events.\n\
5799 Mouse menus give back keys that don't look like mouse events;\n\
5800 this variable holds the actual mouse event that led to the menu,\n\
5801 so that you can determine whether the command was run by mouse or not.");
5803 DEFVAR_LISP ("last-input-char", &last_input_char
,
5804 "Last input event.");
5806 DEFVAR_LISP ("last-input-event", &last_input_char
,
5807 "Last input event.");
5809 DEFVAR_LISP ("unread-command-events", &unread_command_events
,
5810 "List of objects to be read as next command input events.");
5812 DEFVAR_INT ("unread-command-char", &unread_command_char
,
5813 "If not -1, an object to be read as next command input event.");
5815 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
5816 "Meta-prefix character code. Meta-foo as command input\n\
5817 turns into this character followed by foo.");
5818 XSET (meta_prefix_char
, Lisp_Int
, 033);
5820 DEFVAR_LISP ("last-command", &last_command
,
5821 "The last command executed. Normally a symbol with a function definition,\n\
5822 but can be whatever was found in the keymap, or whatever the variable\n\
5823 `this-command' was set to by that command.");
5824 last_command
= Qnil
;
5826 DEFVAR_LISP ("this-command", &this_command
,
5827 "The command now being executed.\n\
5828 The command can set this variable; whatever is put here\n\
5829 will be in `last-command' during the following command.");
5830 this_command
= Qnil
;
5832 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
5833 "*Number of keyboard input characters between auto-saves.\n\
5834 Zero means disable autosaving due to number of characters typed.");
5835 auto_save_interval
= 300;
5837 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
5838 "*Number of seconds idle time before auto-save.\n\
5839 Zero or nil means disable auto-saving due to idleness.\n\
5840 After auto-saving due to this many seconds of idle time,\n\
5841 Emacs also does a garbage collection if that seems to be warranted.");
5842 XFASTINT (Vauto_save_timeout
) = 30;
5844 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
5845 "*Nonzero means echo unfinished commands after this many seconds of pause.");
5846 echo_keystrokes
= 1;
5848 DEFVAR_INT ("polling-period", &polling_period
,
5849 "*Interval between polling for input during Lisp execution.\n\
5850 The reason for polling is to make C-g work to stop a running program.\n\
5851 Polling is needed only when using X windows and SIGIO does not work.\n\
5852 Polling is automatically disabled in all other cases.");
5855 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
5856 "*Maximum time between mouse clicks to make a double-click.\n\
5857 Measured in milliseconds. nil means disable double-click recognition;\n\
5858 t means double-clicks have no time limit and are detected\n\
5859 by position only.");
5860 Vdouble_click_time
= make_number (500);
5862 DEFVAR_INT ("num-input-keys", &num_input_keys
,
5863 "*Number of complete keys read from the keyboard so far.");
5867 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
5868 "*The frame in which the most recently read event occurred.\n\
5869 If the last event came from a keyboard macro, this is set to `macro'.");
5870 Vlast_event_frame
= Qnil
;
5873 DEFVAR_LISP ("help-char", &Vhelp_char
,
5874 "Character to recognize as meaning Help.\n\
5875 When it is read, do `(eval help-form)', and display result if it's a string.\n\
5876 If the value of `help-form' is nil, this char can be read normally.");
5877 XSET (Vhelp_char
, Lisp_Int
, Ctl ('H'));
5879 DEFVAR_LISP ("help-form", &Vhelp_form
,
5880 "Form to execute when character `help-char' is read.\n\
5881 If the form returns a string, that string is displayed.\n\
5882 If `help-form' is nil, the help char is not recognized.");
5885 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
5886 "Command to run when `help-char' character follows a prefix key.\n\
5887 This command is used only when there is no actual binding\n\
5888 for that character after that prefix key.");
5889 Vprefix_help_command
= Qnil
;
5891 DEFVAR_LISP ("top-level", &Vtop_level
,
5892 "Form to evaluate when Emacs starts up.\n\
5893 Useful to set before you dump a modified Emacs.");
5896 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
5897 "String used as translate table for keyboard input, or nil.\n\
5898 Each character is looked up in this string and the contents used instead.\n\
5899 If string is of length N, character codes N and up are untranslated.");
5900 Vkeyboard_translate_table
= Qnil
;
5902 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
5903 "Keymap of key translations that can override keymaps.\n\
5904 This keymap works like `function-key-map', but comes after that,\n\
5905 and applies even for keys that have ordinary bindings.");
5906 Vkey_translation_map
= Qnil
;
5908 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
5909 "Non-nil means to always spawn a subshell instead of suspending,\n\
5910 even if the operating system has support for stopping a process.");
5913 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
5914 "Non-nil means prompt with menus when appropriate.\n\
5915 This is done when reading from a keymap that has a prompt string,\n\
5916 for elements that have prompt strings.\n\
5917 The menu is displayed on the screen\n\
5918 if X menus were enabled at configuration\n\
5919 time and the previous event was a mouse click prefix key.\n\
5920 Otherwise, menu prompting uses the echo area.");
5923 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
5924 "Character to see next line of menu prompt.\n\
5925 Type this character while in a menu prompt to rotate around the lines of it.");
5926 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
5928 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
5929 "A mask of additional modifier keys to use with every keyboard character.\n\
5930 Emacs applies the modifiers of the character stored here to each keyboard\n\
5931 character it reads. For example, after evaluating the expression\n\
5932 (setq extra-keyboard-modifiers ?\C-x)\n\
5933 all input characters will have the control modifier applied to them.\n\
5935 Note that the character ?\C-@, equivalent to the integer zero, does\n\
5936 not count as a control character; rather, it counts as a character\n\
5937 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
5938 cancels any modification.");
5939 extra_keyboard_modifiers
= 0;
5941 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
5942 "If an editing command sets this to t, deactivate the mark afterward.\n\
5943 The command loop sets this to nil before each command,\n\
5944 and tests the value when the command returns.\n\
5945 Buffer modification stores t in this variable.");
5946 Vdeactivate_mark
= Qnil
;
5948 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
5949 "Temporary storage of pre-command-hook or post-command-hook.");
5950 Vcommand_hook_internal
= Qnil
;
5952 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
5953 "Normal hook run before each command is executed.");
5954 Vpre_command_hook
= Qnil
;
5956 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
5957 "Normal hook run after each command is executed.");
5958 Vpost_command_hook
= Qnil
;
5960 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
5961 "t means menu bar, specified Lucid style, needs to be recomputed.");
5962 Vlucid_menu_bar_dirty_flag
= Qnil
;
5964 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
5965 "List of menu bar items to move to the end of the menu bar.\n\
5966 The elements of the list are event types that may have menu bar bindings.");
5967 Vmenu_bar_final_items
= Qnil
;
5969 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
5970 "Keymap that overrides all other local keymaps.\n\
5971 If this variable is non-nil, it is used as a keymap instead of the\n\
5972 buffer's local map, and the minor mode keymaps and text property keymaps.");
5973 Voverriding_local_map
= Qnil
;
5975 DEFVAR_BOOL ("track-mouse", &do_mouse_tracking
,
5976 "*Non-nil means generate motion events for mouse motion.");
5978 DEFVAR_LISP ("system-key-alist", &Vsystem_key_alist
,
5979 "Alist of system-specific X windows key symbols.\n\
5980 Each element should have the form (N . SYMBOL) where N is the\n\
5981 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
5982 and SYMBOL is its name.");
5983 Vmenu_bar_final_items
= Qnil
;
5988 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
5989 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
5990 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
5991 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
5992 initial_define_key (meta_map
, 'x', "execute-extended-command");