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 #if 0 /* This is done in xdisp.c now. */
990 for (tem
= Vframe_list
; CONSP (tem
); tem
= XCONS (tem
)->cdr
)
992 struct frame
*f
= XFRAME (XCONS (tem
)->car
);
993 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
995 /* If the user has switched buffers or windows, we need to
996 recompute to reflect the new bindings. But we'll
997 recompute when update_mode_lines is set too; that means
998 that people can use force-mode-line-update to request
999 that the menu bar be recomputed. The adverse effect on
1000 the rest of the redisplay algorithm is about the same as
1001 windows_or_buffers_changed anyway. */
1002 if (windows_or_buffers_changed
1003 || update_mode_lines
1004 || (XFASTINT (w
->last_modified
) < MODIFF
1005 && (XFASTINT (w
->last_modified
)
1006 <= XBUFFER (w
->buffer
)->save_modified
)))
1008 struct buffer
*prev
= current_buffer
;
1009 current_buffer
= XBUFFER (w
->buffer
);
1010 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items ();
1011 current_buffer
= prev
;
1014 #endif /* MULTI_FRAME */
1017 /* Read next key sequence; i gets its length. */
1018 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), Qnil
);
1022 /* Now we have read a key sequence of length I,
1023 or else I is 0 and we found end of file. */
1025 if (i
== 0) /* End of file -- happens only in */
1026 return Qnil
; /* a kbd macro, at the end. */
1027 /* -1 means read_key_sequence got a menu that was rejected.
1028 Just loop around and read another command. */
1032 this_command_key_count
= 0;
1036 last_command_char
= keybuf
[i
- 1];
1038 /* If the previous command tried to force a specific window-start,
1039 forget about that, in case this command moves point far away
1040 from that position. */
1041 XWINDOW (selected_window
)->force_start
= Qnil
;
1043 cmd
= read_key_sequence_cmd
;
1044 if (!NILP (Vexecuting_macro
))
1046 if (!NILP (Vquit_flag
))
1048 Vexecuting_macro
= Qt
;
1049 QUIT
; /* Make some noise. */
1050 /* Will return since macro now empty. */
1054 /* Do redisplay processing after this command except in special
1055 cases identified below that set no_redisplay to 1.
1056 (actually, there's currently no way to prevent the redisplay,
1057 and no_redisplay is ignored.
1058 Perhaps someday we will really implement it. */
1061 prev_buffer
= current_buffer
;
1062 prev_modiff
= MODIFF
;
1064 /* Execute the command. */
1067 if (!NILP (Vpre_command_hook
))
1069 /* If we get an error during the pre-command-hook,
1070 cause pre-command-hook to be nil. */
1071 Vcommand_hook_internal
= Vpre_command_hook
;
1072 Vpre_command_hook
= Qnil
;
1074 call1 (Vrun_hooks
, Qcommand_hook_internal
);
1076 Vpre_command_hook
= Vcommand_hook_internal
;
1079 if (NILP (this_command
))
1081 /* nil means key is undefined. */
1083 defining_kbd_macro
= 0;
1084 update_mode_lines
= 1;
1090 if (NILP (Vprefix_arg
) && ! no_direct
)
1092 /* Recognize some common commands in common situations and
1093 do them directly. */
1094 if (EQ (this_command
, Qforward_char
) && point
< ZV
)
1096 struct Lisp_Vector
*dp
1097 = window_display_table (XWINDOW (selected_window
));
1098 lose
= FETCH_CHAR (point
);
1101 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1102 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1103 : (lose
>= 0x20 && lose
< 0x7f))
1104 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1106 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1108 && !windows_or_buffers_changed
1109 && EQ (current_buffer
->selective_display
, Qnil
)
1110 && !detect_input_pending ()
1111 && NILP (Vexecuting_macro
))
1112 no_redisplay
= direct_output_forward_char (1);
1115 else if (EQ (this_command
, Qbackward_char
) && point
> BEGV
)
1117 struct Lisp_Vector
*dp
1118 = window_display_table (XWINDOW (selected_window
));
1120 lose
= FETCH_CHAR (point
);
1122 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1123 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1124 : (lose
>= 0x20 && lose
< 0x7f))
1125 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1127 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1129 && !windows_or_buffers_changed
1130 && EQ (current_buffer
->selective_display
, Qnil
)
1131 && !detect_input_pending ()
1132 && NILP (Vexecuting_macro
))
1133 no_redisplay
= direct_output_forward_char (-1);
1136 else if (EQ (this_command
, Qself_insert_command
)
1137 /* Try this optimization only on ascii keystrokes. */
1138 && XTYPE (last_command_char
) == Lisp_Int
)
1140 unsigned char c
= XINT (last_command_char
);
1142 if (NILP (Vexecuting_macro
) &&
1143 !EQ (minibuf_window
, selected_window
))
1145 if (!nonundocount
|| nonundocount
>= 20)
1152 lose
= (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1154 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1156 || MODIFF
<= current_buffer
->save_modified
1157 || windows_or_buffers_changed
1158 || !EQ (current_buffer
->selective_display
, Qnil
)
1159 || detect_input_pending ()
1160 || !NILP (Vexecuting_macro
);
1161 if (internal_self_insert (c
, 0))
1167 (point
== ZV
|| FETCH_CHAR (point
) == '\n'))
1169 struct Lisp_Vector
*dp
1170 = window_display_table (XWINDOW (selected_window
));
1175 Lisp_Object obj
= DISP_CHAR_VECTOR (dp
, lose
);
1177 if (XTYPE (obj
) == Lisp_Vector
1178 && XVECTOR (obj
)->size
== 1
1179 && (XTYPE (obj
= XVECTOR (obj
)->contents
[0])
1182 direct_output_for_insert (XINT (obj
));
1186 if (lose
>= 0x20 && lose
<= 0x7e)
1187 no_redisplay
= direct_output_for_insert (lose
);
1194 /* Here for a command that isn't executed directly */
1197 if (NILP (Vprefix_arg
))
1199 Fcommand_execute (this_command
, Qnil
);
1204 if (!NILP (Vpost_command_hook
))
1206 /* If we get an error during the post-command-hook,
1207 cause post-command-hook to be nil. */
1208 Vcommand_hook_internal
= Vpost_command_hook
;
1209 Vpost_command_hook
= Qnil
;
1211 call1 (Vrun_hooks
, Qcommand_hook_internal
);
1213 Vpost_command_hook
= Vcommand_hook_internal
;
1216 /* If there is a prefix argument,
1217 1) We don't want last_command to be ``universal-argument''
1218 (that would be dumb), so don't set last_command,
1219 2) we want to leave echoing on so that the prefix will be
1220 echoed as part of this key sequence, so don't call
1222 3) we want to leave this_command_key_count non-zero, so that
1223 read_char will realize that it is re-reading a character, and
1224 not echo it a second time. */
1225 if (NILP (Vprefix_arg
))
1227 last_command
= this_command
;
1229 this_command_key_count
= 0;
1232 if (!NILP (current_buffer
->mark_active
))
1234 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1236 current_buffer
->mark_active
= Qnil
;
1237 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1239 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1240 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1245 /* Number of seconds between polling for input. */
1248 /* Nonzero means polling for input is temporarily suppressed. */
1249 int poll_suppress_count
;
1251 #ifdef POLL_FOR_INPUT
1252 int polling_for_input
;
1254 /* Handle an alarm once each second and read pending input
1255 so as to handle a C-g if it comces in. */
1258 input_poll_signal ()
1260 if (interrupt_input_blocked
== 0
1261 && !waiting_for_input
)
1262 read_avail_input (0);
1263 signal (SIGALRM
, input_poll_signal
);
1264 alarm (polling_period
);
1269 /* Begin signals to poll for input, if they are appropriate.
1270 This function is called unconditionally from various places. */
1274 #ifdef POLL_FOR_INPUT
1275 if (read_socket_hook
&& !interrupt_input
)
1277 poll_suppress_count
--;
1278 if (poll_suppress_count
== 0)
1280 signal (SIGALRM
, input_poll_signal
);
1281 polling_for_input
= 1;
1282 alarm (polling_period
);
1288 /* Turn off polling. */
1292 #ifdef POLL_FOR_INPUT
1293 if (read_socket_hook
&& !interrupt_input
)
1295 if (poll_suppress_count
== 0)
1297 polling_for_input
= 0;
1300 poll_suppress_count
++;
1305 /* Set the value of poll_suppress_count to COUNT
1306 and start or stop polling accordingly. */
1309 set_poll_suppress_count (count
)
1312 #ifdef POLL_FOR_INPUT
1313 if (count
== 0 && poll_suppress_count
!= 0)
1315 poll_suppress_count
= 1;
1318 else if (count
!= 0 && poll_suppress_count
== 0)
1322 poll_suppress_count
= count
;
1326 /* Applying the control modifier to CHARACTER. */
1331 /* Save the upper bits here. */
1332 int upper
= c
& ~0177;
1336 /* Everything in the columns containing the upper-case letters
1337 denotes a control character. */
1338 if (c
>= 0100 && c
< 0140)
1342 /* Set the shift modifier for a control char
1343 made from a shifted letter. But only for letters! */
1344 if (oc
>= 'A' && oc
<= 'Z')
1345 c
|= shift_modifier
;
1348 /* The lower-case letters denote control characters too. */
1349 else if (c
>= 'a' && c
<= 'z')
1352 /* Include the bits for control and shift
1353 only if the basic ASCII code can't indicate them. */
1357 /* Replace the high bits. */
1358 c
|= (upper
& ~ctrl_modifier
);
1365 /* Input of single characters from keyboard */
1367 Lisp_Object
print_help ();
1368 static Lisp_Object
kbd_buffer_get_event ();
1370 /* read a character from the keyboard; call the redisplay if needed */
1371 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1372 -1 means do not do redisplay, but do do autosaving.
1375 /* The arguments MAPS and NMAPS are for menu prompting.
1376 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1378 PREV_EVENT is the previous input event, or nil if we are reading
1379 the first event of a key sequence.
1381 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1382 if we used a mouse menu to read the input, or zero otherwise. If
1383 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
1385 Value is t if we showed a menu and the user rejected it. */
1388 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1392 Lisp_Object prev_event
;
1393 int *used_mouse_menu
;
1395 register Lisp_Object c
;
1399 if (CONSP (unread_command_events
))
1401 c
= XCONS (unread_command_events
)->car
;
1402 unread_command_events
= XCONS (unread_command_events
)->cdr
;
1404 if (this_command_key_count
== 0)
1410 if (unread_command_char
!= -1)
1412 XSET (c
, Lisp_Int
, unread_command_char
);
1413 unread_command_char
= -1;
1415 if (this_command_key_count
== 0)
1421 if (!NILP (Vexecuting_macro
))
1424 /* We set this to Qmacro; since that's not a frame, nobody will
1425 try to switch frames on us, and the selected window will
1428 Since this event came from a macro, it would be misleading to
1429 leave internal_last_event_frame set to wherever the last
1430 real event came from. Normally, a switch-frame event selects
1431 internal_last_event_frame after each command is read, but
1432 events read from a macro should never cause a new frame to be
1434 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1437 /* Exit the macro if we are at the end.
1438 Also, some things replace the macro with t
1439 to force an early exit. */
1440 if (EQ (Vexecuting_macro
, Qt
)
1441 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1443 XSET (c
, Lisp_Int
, -1);
1447 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1448 if (XTYPE (Vexecuting_macro
) == Lisp_String
1449 && (XINT (c
) & 0x80))
1450 XFASTINT (c
) = CHAR_META
| (XINT (c
) & ~0x80);
1452 executing_macro_index
++;
1457 if (!NILP (unread_switch_frame
))
1459 c
= unread_switch_frame
;
1460 unread_switch_frame
= Qnil
;
1462 /* This event should make it into this_command_keys, and get echoed
1463 again, so we go to reread_first, rather than reread. */
1467 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1468 prepare_menu_bars ();
1470 /* Save outer setjmp data, in case called recursively. */
1471 save_getcjmp (save_jump
);
1475 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1478 if (_setjmp (getcjmp
))
1480 XSET (c
, Lisp_Int
, quit_char
);
1482 XSET (internal_last_event_frame
, Lisp_Frame
, selected_frame
);
1483 Vlast_event_frame
= internal_last_event_frame
;
1485 /* If we report the quit char as an event,
1486 don't do so more than once. */
1487 if (!NILP (Vinhibit_quit
))
1493 /* Message turns off echoing unless more keystrokes turn it on again. */
1494 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1497 /* If already echoing, continue. */
1500 /* Try reading a character via menu prompting in the minibuf.
1501 Try this before the sit-for, because the sit-for
1502 would do the wrong thing if we are supposed to do
1503 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1504 after a mouse event so don't try a minibuf menu. */
1506 if (nmaps
> 0 && INTERACTIVE
&&
1507 !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
))
1509 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1510 if ( ! NILP(c
) ) return c
;
1513 /* If in middle of key sequence and minibuffer not active,
1514 start echoing if enough time elapses. */
1515 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1517 && echo_keystrokes
> 0
1518 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1522 /* After a mouse event, start echoing right away.
1523 This is because we are probably about to display a menu,
1524 and we don't want to delay before doing so. */
1525 if (EVENT_HAS_PARAMETERS (prev_event
))
1529 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1535 /* Maybe auto save due to number of keystrokes or idle time. */
1537 if (commandflag
!= 0
1538 && auto_save_interval
> 0
1539 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1540 && !detect_input_pending ())
1543 save_getcjmp (temp
);
1544 Fdo_auto_save (Qnil
, Qnil
);
1545 restore_getcjmp (temp
);
1548 /* Try reading using an X menu.
1549 This is never confused with reading using the minibuf because the recursive
1550 call of read_char in read_char_minibuf_menu_prompt does not pass on
1552 if (nmaps
> 0 && INTERACTIVE
&&
1553 !NILP (prev_event
) && EVENT_HAS_PARAMETERS (prev_event
))
1554 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1556 /* Slow down auto saves logarithmically in size of current buffer,
1557 and garbage collect while we're at it. */
1558 if (INTERACTIVE
&& NILP (c
))
1560 int delay_level
, buffer_size
;
1562 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1563 last_non_minibuf_size
= Z
- BEG
;
1564 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1566 while (buffer_size
> 64)
1567 delay_level
++, buffer_size
-= buffer_size
>> 2;
1568 if (delay_level
< 4) delay_level
= 4;
1569 /* delay_level is 4 for files under around 50k, 7 at 100k,
1570 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1572 /* Auto save if enough time goes by without input. */
1573 if (commandflag
!= 0
1574 && num_nonmacro_input_chars
> last_auto_save
1575 && XTYPE (Vauto_save_timeout
) == Lisp_Int
1576 && XINT (Vauto_save_timeout
) > 0)
1579 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1580 tem0
= sit_for (delay
, 0, 1, 1);
1584 save_getcjmp (temp
);
1585 Fdo_auto_save (Qnil
, Qnil
);
1586 restore_getcjmp (temp
);
1588 /* If we have auto-saved and there is still no input
1589 available, garbage collect if there has been enough
1590 consing going on to make it worthwhile. */
1591 if (!detect_input_pending ()
1592 && consing_since_gc
> gc_cons_threshold
/ 2)
1594 Fgarbage_collect ();
1595 /* prepare_menu_bars isn't safe here, but it should
1596 also be unnecessary. */
1603 /* Actually read a character, waiting if necessary. */
1606 c
= kbd_buffer_get_event ();
1609 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1613 /* Terminate Emacs in batch mode if at eof. */
1614 if (noninteractive
&& XTYPE (c
) == Lisp_Int
&& XINT (c
) < 0)
1615 Fkill_emacs (make_number (1));
1617 if (XTYPE (c
) == Lisp_Int
)
1619 /* Add in any extra modifiers, where appropriate. */
1620 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1621 || ((extra_keyboard_modifiers
& 0177) < ' '
1622 && (extra_keyboard_modifiers
& 0177) != 0))
1623 XSETINT (c
, make_ctrl_char (XINT (c
)));
1625 /* Transfer any other modifier bits directly from
1626 extra_keyboard_modifiers to c. Ignore the actual character code
1627 in the low 16 bits of extra_keyboard_modifiers. */
1628 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
1633 restore_getcjmp (save_jump
);
1637 echo_area_glyphs
= 0;
1639 /* Handle things that only apply to characters. */
1640 if (XTYPE (c
) == Lisp_Int
)
1642 /* If kbd_buffer_get_event gave us an EOF, return that. */
1646 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
1647 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1648 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1652 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1653 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1654 recent_keys_index
= 0;
1656 /* Write c to the dribble file. If c is a lispy event, write
1657 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1658 If you, dear reader, have a better idea, you've got the source. :-) */
1661 if (XTYPE (c
) == Lisp_Int
)
1662 putc (XINT (c
), dribble
);
1665 Lisp_Object dribblee
= c
;
1667 /* If it's a structured event, take the event header. */
1668 dribblee
= EVENT_HEAD (dribblee
);
1670 if (XTYPE (dribblee
) == Lisp_Symbol
)
1672 putc ('<', dribble
);
1673 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1674 XSYMBOL (dribblee
)->name
->size
,
1676 putc ('>', dribble
);
1683 store_kbd_macro_char (c
);
1685 num_nonmacro_input_chars
++;
1690 /* Record this character as part of the current key.
1691 Don't record mouse motion; it should never matter. */
1692 if (! (EVENT_HAS_PARAMETERS (c
)
1693 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1696 add_command_key (c
);
1699 /* Re-reading in the middle of a command */
1701 last_input_char
= c
;
1704 /* Process the help character specially if enabled */
1705 if (EQ (c
, Vhelp_char
) && !NILP (Vhelp_form
))
1708 count
= specpdl_ptr
- specpdl
;
1710 record_unwind_protect (Fset_window_configuration
,
1711 Fcurrent_window_configuration (Qnil
));
1713 tem0
= Feval (Vhelp_form
);
1714 if (XTYPE (tem0
) == Lisp_String
)
1715 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1719 c
= read_char (0, 0, 0, Qnil
, 0);
1720 while (XTYPE (c
) == Lisp_Buffer
);
1721 /* Remove the help from the frame */
1722 unbind_to (count
, Qnil
);
1723 prepare_menu_bars ();
1725 if (EQ (c
, make_number (040)))
1729 c
= read_char (0, 0, 0, Qnil
, 0);
1730 while (XTYPE (c
) == Lisp_Buffer
);
1741 Fprinc (object
, Qnil
);
1745 /* Copy out or in the info on where C-g should throw to.
1746 This is used when running Lisp code from within get_char,
1747 in case get_char is called recursively.
1748 See read_process_output. */
1753 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1756 restore_getcjmp (temp
)
1759 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1763 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1764 of this function. */
1766 tracking_off (old_value
)
1767 Lisp_Object old_value
;
1769 if (! XFASTINT (old_value
))
1771 do_mouse_tracking
= 0;
1773 /* Redisplay may have been preempted because there was input
1774 available, and it assumes it will be called again after the
1775 input has been processed. If the only input available was
1776 the sort that we have just disabled, then we need to call
1778 if (!readable_events ())
1780 prepare_menu_bars ();
1781 redisplay_preserve_echo_area ();
1782 get_input_pending (&input_pending
);
1787 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1788 "Evaluate BODY with mouse movement events enabled.\n\
1789 Within a `track-mouse' form, mouse motion generates input events that\n\
1790 you can read with `read-event'.\n\
1791 Normally, mouse motion is ignored.")
1795 int count
= specpdl_ptr
- specpdl
;
1798 XSET (val
, Lisp_Int
, do_mouse_tracking
);
1799 record_unwind_protect (tracking_off
, val
);
1801 do_mouse_tracking
= 1;
1803 val
= Fprogn (args
);
1804 return unbind_to (count
, val
);
1807 /* Low level keyboard/mouse input.
1808 kbd_buffer_store_event places events in kbd_buffer, and
1809 kbd_buffer_get_event retrieves them.
1810 mouse_moved indicates when the mouse has moved again, and
1811 *mouse_position_hook provides the mouse position. */
1813 /* Return true iff there are any events in the queue that read-char
1814 would return. If this returns false, a read-char would block. */
1818 return ! EVENT_QUEUES_EMPTY
;
1821 /* Set this for debugging, to have a way to get out */
1824 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
1827 kbd_buffer_store_event (event
)
1828 register struct input_event
*event
;
1830 if (event
->kind
== no_event
)
1833 if (event
->kind
== ascii_keystroke
)
1835 register int c
= event
->code
& 0377;
1837 if (event
->modifiers
& ctrl_modifier
)
1838 c
= make_ctrl_char (c
);
1840 c
|= (event
->modifiers
1841 & (meta_modifier
| alt_modifier
1842 | hyper_modifier
| super_modifier
));
1846 extern SIGTYPE
interrupt_signal ();
1849 /* If this results in a quit_char being returned to Emacs as
1850 input, set Vlast_event_frame properly. If this doesn't
1851 get returned to Emacs as an event, the next event read
1852 will set Vlast_event_frame again, so this is safe to do. */
1855 = FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
1858 internal_last_event_frame
= event
->frame_or_window
;
1860 internal_last_event_frame
= focus
;
1861 Vlast_event_frame
= internal_last_event_frame
;
1865 last_event_timestamp
= event
->timestamp
;
1866 interrupt_signal ();
1870 if (c
&& c
== stop_character
)
1877 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
1878 kbd_store_ptr
= kbd_buffer
;
1880 /* Don't let the very last slot in the buffer become full,
1881 since that would make the two pointers equal,
1882 and that is indistinguishable from an empty buffer.
1883 Discard the event if it would fill the last slot. */
1884 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
1886 kbd_store_ptr
->kind
= event
->kind
;
1887 if (event
->kind
== selection_request_event
)
1889 /* We must not use the ordinary copying code for this case,
1890 since `part' is an enum and copying it might not copy enough
1892 bcopy (event
, kbd_store_ptr
, sizeof (*event
));
1896 kbd_store_ptr
->code
= event
->code
;
1897 kbd_store_ptr
->part
= event
->part
;
1898 kbd_store_ptr
->frame_or_window
= event
->frame_or_window
;
1899 kbd_store_ptr
->modifiers
= event
->modifiers
;
1900 kbd_store_ptr
->x
= event
->x
;
1901 kbd_store_ptr
->y
= event
->y
;
1902 kbd_store_ptr
->timestamp
= event
->timestamp
;
1904 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
1906 = event
->frame_or_window
);
1912 /* Read one event from the event buffer, waiting if necessary.
1913 The value is a Lisp object representing the event.
1914 The value is nil for an event that should be ignored,
1915 or that was handled here.
1916 We always read and discard one event. */
1919 kbd_buffer_get_event ()
1927 XSET (obj
, Lisp_Int
, c
);
1931 /* Wait until there is input available. */
1934 if (!EVENT_QUEUES_EMPTY
)
1937 /* If the quit flag is set, then read_char will return
1938 quit_char, so that counts as "available input." */
1939 if (!NILP (Vquit_flag
))
1940 quit_throw_to_read_char ();
1942 /* One way or another, wait until input is available; then, if
1943 interrupt handlers have not read it, read it now. */
1946 wait_for_kbd_input ();
1948 /* Note SIGIO has been undef'd if FIONREAD is missing. */
1952 if (EVENT_QUEUES_EMPTY
)
1954 Lisp_Object minus_one
;
1956 XSET (minus_one
, Lisp_Int
, -1);
1957 wait_reading_process_input (0, 0, minus_one
, 1);
1959 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
1960 /* Pass 1 for EXPECT since we just waited to have input. */
1961 read_avail_input (1);
1963 #endif /* not VMS */
1966 /* At this point, we know that there is a readable event available
1967 somewhere. If the event queue is empty, then there must be a
1968 mouse movement enabled and available. */
1969 if (kbd_fetch_ptr
!= kbd_store_ptr
)
1971 struct input_event
*event
;
1973 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
1977 last_event_timestamp
= event
->timestamp
;
1981 /* These two kinds of events get special handling
1982 and don't actually appear to the command loop.
1983 We return nil for them. */
1984 if (event
->kind
== selection_request_event
)
1987 x_handle_selection_request (event
);
1988 kbd_fetch_ptr
= event
+ 1;
1990 /* We're getting selection request events, but we don't have
1996 else if (event
->kind
== selection_clear_event
)
1999 x_handle_selection_clear (event
);
2000 kbd_fetch_ptr
= event
+ 1;
2002 /* We're getting selection request events, but we don't have
2008 else if (event
->kind
== delete_window_event
)
2010 Lisp_Object tail
, frame
;
2013 /* If the user destroys the only frame, Emacs should exit.
2014 Count visible frames and iconified frames. */
2015 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2017 frame
= XCONS (tail
)->car
;
2018 if (XTYPE (frame
) != Lisp_Frame
|| EQ (frame
, event
->frame_or_window
))
2021 if (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
))
2028 Fdelete_frame (event
->frame_or_window
, Qt
);
2029 kbd_fetch_ptr
= event
+ 1;
2032 /* Just discard these, by returning nil.
2033 (They shouldn't be found in the buffer,
2034 but on some machines it appears they do show up.) */
2035 else if (event
->kind
== no_event
)
2036 kbd_fetch_ptr
= event
+ 1;
2038 /* If this event is on a different frame, return a switch-frame this
2039 time, and leave the event in the queue for next time. */
2043 Lisp_Object frame
= event
->frame_or_window
;
2046 if (XTYPE (frame
) == Lisp_Window
)
2047 frame
= WINDOW_FRAME (XWINDOW (frame
));
2049 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2053 if (! EQ (frame
, internal_last_event_frame
)
2054 && XFRAME (frame
) != selected_frame
)
2055 obj
= make_lispy_switch_frame (frame
);
2056 internal_last_event_frame
= frame
;
2057 #endif /* MULTI_FRAME */
2059 /* If we didn't decide to make a switch-frame event, go ahead
2060 and build a real event from the queue entry. */
2064 obj
= make_lispy_event (event
);
2066 /* Wipe out this event, to catch bugs. */
2067 event
->kind
= no_event
;
2068 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
2071 kbd_fetch_ptr
= event
+ 1;
2075 /* Try generating a mouse motion event. */
2076 else if (do_mouse_tracking
&& mouse_moved
)
2079 Lisp_Object bar_window
;
2080 enum scroll_bar_part part
;
2084 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
2089 /* Decide if we should generate a switch-frame event. Don't
2090 generate switch-frame events for motion outside of all Emacs
2094 Lisp_Object frame
= FRAME_FOCUS_FRAME (f
);
2097 XSET (frame
, Lisp_Frame
, f
);
2099 if (! EQ (frame
, internal_last_event_frame
)
2100 && XFRAME (frame
) != selected_frame
)
2101 obj
= make_lispy_switch_frame (frame
);
2102 internal_last_event_frame
= frame
;
2106 /* If we didn't decide to make a switch-frame event, go ahead and
2107 return a mouse-motion event. */
2109 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2112 /* We were promised by the above while loop that there was
2113 something for us to read! */
2116 input_pending
= readable_events ();
2119 Vlast_event_frame
= internal_last_event_frame
;
2125 /* Process any events that are not user-visible,
2126 then return, without reading any user-visible events. */
2131 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2133 struct input_event
*event
;
2135 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2139 last_event_timestamp
= event
->timestamp
;
2141 /* These two kinds of events get special handling
2142 and don't actually appear to the command loop. */
2143 if (event
->kind
== selection_request_event
)
2146 x_handle_selection_request (event
);
2147 kbd_fetch_ptr
= event
+ 1;
2149 /* We're getting selection request events, but we don't have
2155 else if (event
->kind
== selection_clear_event
)
2158 x_handle_selection_clear (event
);
2159 kbd_fetch_ptr
= event
+ 1;
2161 /* We're getting selection request events, but we don't have
2170 get_input_pending (&input_pending
);
2173 /* Caches for modify_event_symbol. */
2174 static Lisp_Object accent_key_syms
;
2175 static Lisp_Object system_key_syms
;
2176 static Lisp_Object func_key_syms
;
2177 static Lisp_Object mouse_syms
;
2179 Lisp_Object Vsystem_key_alist
;
2181 /* This is a list of keysym codes for special "accent" characters.
2182 It parallels lispy_accent_keys. */
2184 static int lispy_accent_codes
[] =
2186 #ifdef XK_dead_circumflex
2191 #ifdef XK_dead_grave
2196 #ifdef XK_dead_tilde
2201 #ifdef XK_dead_diaeresis
2206 #ifdef XK_dead_macron
2211 #ifdef XK_dead_degree
2216 #ifdef XK_dead_acute
2221 #ifdef XK_dead_cedilla
2226 #ifdef XK_dead_breve
2231 #ifdef XK_dead_ogonek
2236 #ifdef XK_dead_caron
2241 #ifdef XK_dead_doubleacute
2242 XK_dead_doubleacute
,
2246 #ifdef XK_dead_abovedot
2253 /* This is a list of Lisp names for special "accent" characters.
2254 It parallels lispy_accent_codes. */
2256 static char *lispy_accent_keys
[] =
2273 /* You'll notice that this table is arranged to be conveniently
2274 indexed by X Windows keysym values. */
2275 static char *lispy_function_keys
[] =
2277 /* X Keysym value */
2279 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2287 0, 0, 0, /* 0xff10 */
2289 0, 0, 0, 0, 0, 0, 0,
2292 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2293 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2294 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2296 "home", /* 0xff50 */ /* IsCursorKey */
2307 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2318 "break", /* 0xff6b */
2320 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2322 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2323 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2324 0, 0, 0, 0, 0, 0, 0, 0,
2325 "kp-tab", /* 0xff89 */
2327 "kp-enter", /* 0xff8d */
2329 "kp-f1", /* 0xff91 */
2334 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2335 "kp-multiply", /* 0xffaa */
2340 "kp-divide", /* 0xffaf */
2341 "kp-0", /* 0xffb0 */
2342 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2345 "kp-equal", /* 0xffbd */
2346 "f1", /* 0xffbe */ /* IsFunctionKey */
2348 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2349 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2350 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2351 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2352 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2353 0, 0, 0, 0, 0, 0, 0, 0,
2354 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2355 0, 0, 0, 0, 0, 0, 0, "delete"
2358 static char *lispy_mouse_names
[] =
2360 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2363 /* Scroll bar parts. */
2364 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2366 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2367 Lisp_Object
*scroll_bar_parts
[] = {
2368 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2372 /* A vector, indexed by button number, giving the down-going location
2373 of currently depressed buttons, both scroll bar and non-scroll bar.
2375 The elements have the form
2376 (BUTTON-NUMBER MODIFIER-MASK . REST)
2377 where REST is the cdr of a position as it would be reported in the event.
2379 The make_lispy_event function stores positions here to tell the
2380 difference between click and drag events, and to store the starting
2381 location to be included in drag events. */
2383 static Lisp_Object button_down_location
;
2385 /* Information about the most recent up-going button event: Which
2386 button, what location, and what time. */
2388 static int last_mouse_button
;
2389 static int last_mouse_x
;
2390 static int last_mouse_y
;
2391 static unsigned long button_down_time
;
2393 /* The maximum time between clicks to make a double-click,
2394 or Qnil to disable double-click detection,
2395 or Qt for no time limit. */
2396 Lisp_Object Vdouble_click_time
;
2398 /* The number of clicks in this multiple-click. */
2400 int double_click_count
;
2402 #ifdef USE_X_TOOLKIT
2403 extern Lisp_Object
map_event_to_object ();
2404 #endif /* USE_X_TOOLKIT */
2406 /* Given a struct input_event, build the lisp event which represents
2407 it. If EVENT is 0, build a mouse movement event from the mouse
2408 movement buffer, which should have a movement event in it.
2410 Note that events must be passed to this function in the order they
2411 are received; this function stores the location of button presses
2412 in order to build drag events when the button is released. */
2415 make_lispy_event (event
)
2416 struct input_event
*event
;
2420 #ifdef SWITCH_ENUM_BUG
2421 switch ((int) event
->kind
)
2423 switch (event
->kind
)
2426 /* A simple keystroke. */
2427 case ascii_keystroke
:
2429 int c
= event
->code
& 0377;
2430 /* Turn ASCII characters into control characters
2432 if (event
->modifiers
& ctrl_modifier
)
2433 c
= make_ctrl_char (c
);
2435 /* Add in the other modifier bits. We took care of ctrl_modifier
2436 just above, and the shift key was taken care of by the X code,
2437 and applied to control characters by make_ctrl_char. */
2438 c
|= (event
->modifiers
2439 & (meta_modifier
| alt_modifier
2440 | hyper_modifier
| super_modifier
));
2441 button_down_time
= 0;
2445 /* A function key. The symbol may need to have modifier prefixes
2447 case non_ascii_keystroke
:
2448 button_down_time
= 0;
2450 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
2451 if (event
->code
== lispy_accent_codes
[i
])
2452 return modify_event_symbol (i
,
2454 Qfunction_key
, Qnil
,
2455 lispy_accent_keys
, &accent_key_syms
,
2456 (sizeof (lispy_accent_keys
)
2457 / sizeof (lispy_accent_keys
[0])));
2459 /* Handle system-specific keysyms. */
2460 if (event
->code
& (1 << 28))
2462 /* We need to use an alist rather than a vector as the cache
2463 since we can't make a vector long enuf. */
2464 if (NILP (system_key_syms
))
2465 system_key_syms
= Fcons (Qnil
, Qnil
);
2466 return modify_event_symbol (event
->code
& 0xffffff,
2468 Qfunction_key
, Vsystem_key_alist
,
2469 0, &system_key_syms
, 0xffffff);
2472 return modify_event_symbol (event
->code
- 0xff00,
2474 Qfunction_key
, Qnil
,
2475 lispy_function_keys
, &func_key_syms
,
2476 (sizeof (lispy_function_keys
)
2477 / sizeof (lispy_function_keys
[0])));
2480 /* A mouse click. Figure out where it is, decide whether it's
2481 a press, click or drag, and build the appropriate structure. */
2483 case scroll_bar_click
:
2485 int button
= event
->code
;
2487 Lisp_Object position
;
2488 Lisp_Object
*start_pos_ptr
;
2489 Lisp_Object start_pos
;
2491 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2494 /* Build the position as appropriate for this mouse click. */
2495 if (event
->kind
== mouse_click
)
2498 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2503 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
2504 &column
, &row
, 0, 0);
2506 #ifdef USE_X_TOOLKIT
2507 if (FRAME_EXTERNAL_MENU_BAR (f
) && XINT (event
->y
) == -1)
2509 if (row
< FRAME_MENU_BAR_LINES (f
))
2514 #ifdef USE_X_TOOLKIT
2515 /* The click happened in the menubar.
2516 Look for the menu item selected. */
2517 items
= map_event_to_object (event
, f
);
2519 XFASTINT (event
->y
) = 1;
2520 #else /* not USE_X_TOOLKIT */
2523 items
= FRAME_MENU_BAR_ITEMS (f
);
2524 for (; CONSP (items
); items
= XCONS (items
)->cdr
)
2526 Lisp_Object pos
, string
;
2527 pos
= Fcdr (Fcdr (Fcar (items
)));
2528 string
= Fcar (Fcdr (Fcar (items
)));
2529 if (column
>= XINT (pos
)
2530 && column
< XINT (pos
) + XSTRING (string
)->size
)
2533 #endif /* not USE_X_TOOLKIT */
2536 = Fcons (event
->frame_or_window
,
2538 Fcons (Fcons (event
->x
, event
->y
),
2539 Fcons (make_number (event
->timestamp
),
2543 return Fcons (Fcar (Fcar (items
)),
2544 Fcons (position
, Qnil
));
2546 return Fcons (Qnil
, Fcons (position
, Qnil
));
2549 window
= window_from_coordinates (f
, column
, row
, &part
);
2551 if (XTYPE (window
) != Lisp_Window
)
2555 int pixcolumn
, pixrow
;
2556 column
-= XINT (XWINDOW (window
)->left
);
2557 row
-= XINT (XWINDOW (window
)->top
);
2558 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
2559 XSETINT (event
->x
, pixcolumn
);
2560 XSETINT (event
->y
, pixrow
);
2565 posn
= Qvertical_line
;
2567 XSET (posn
, Lisp_Int
,
2568 buffer_posn_from_coords (XWINDOW (window
),
2575 Fcons (Fcons (event
->x
, event
->y
),
2576 Fcons (make_number (event
->timestamp
),
2582 Lisp_Object portion_whole
;
2585 window
= event
->frame_or_window
;
2586 portion_whole
= Fcons (event
->x
, event
->y
);
2587 part
= *scroll_bar_parts
[(int) event
->part
];
2591 Fcons (Qvertical_scroll_bar
,
2592 Fcons (portion_whole
,
2593 Fcons (make_number (event
->timestamp
),
2594 Fcons (part
, Qnil
)))));
2597 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2599 start_pos
= *start_pos_ptr
;
2600 *start_pos_ptr
= Qnil
;
2602 is_double
= (button
== last_mouse_button
2603 && XINT (event
->x
) == last_mouse_x
2604 && XINT (event
->y
) == last_mouse_y
2605 && button_down_time
!= 0
2606 && (EQ (Vdouble_click_time
, Qt
)
2607 || (INTEGERP (Vdouble_click_time
)
2608 && ((int)(event
->timestamp
- button_down_time
)
2609 < XINT (Vdouble_click_time
)))));
2610 last_mouse_button
= button
;
2611 last_mouse_x
= XINT (event
->x
);
2612 last_mouse_y
= XINT (event
->y
);
2614 /* If this is a button press, squirrel away the location, so
2615 we can decide later whether it was a click or a drag. */
2616 if (event
->modifiers
& down_modifier
)
2620 double_click_count
++;
2621 event
->modifiers
|= ((double_click_count
> 2)
2626 double_click_count
= 1;
2627 button_down_time
= event
->timestamp
;
2628 *start_pos_ptr
= Fcopy_alist (position
);
2631 /* Now we're releasing a button - check the co-ordinates to
2632 see if this was a click or a drag. */
2633 else if (event
->modifiers
& up_modifier
)
2635 /* If we did not see a down before this up,
2636 ignore the up. Probably this happened because
2637 the down event chose a menu item.
2638 It would be an annoyance to treat the release
2639 of the button that chose the menu item
2640 as a separate event. */
2642 if (XTYPE (start_pos
) != Lisp_Cons
)
2645 event
->modifiers
&= ~up_modifier
;
2646 #if 0 /* Formerly we treated an up with no down as a click event. */
2647 if (XTYPE (start_pos
) != Lisp_Cons
)
2648 event
->modifiers
|= click_modifier
;
2652 /* The third element of every position should be the (x,y)
2654 Lisp_Object down
= Fnth (make_number (2), start_pos
);
2656 if (EQ (event
->x
, XCONS (down
)->car
)
2657 && EQ (event
->y
, XCONS (down
)->cdr
))
2659 if (is_double
&& double_click_count
> 1)
2660 event
->modifiers
|= ((double_click_count
> 2)
2664 event
->modifiers
|= click_modifier
;
2668 button_down_time
= 0;
2669 event
->modifiers
|= drag_modifier
;
2674 /* Every mouse event should either have the down_modifier or
2675 the up_modifier set. */
2679 /* Get the symbol we should use for the mouse click. */
2681 = modify_event_symbol (button
,
2684 lispy_mouse_names
, &mouse_syms
,
2685 (sizeof (lispy_mouse_names
)
2686 / sizeof (lispy_mouse_names
[0])));
2688 if (event
->modifiers
& drag_modifier
)
2693 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2696 Fcons (make_number (double_click_count
),
2705 /* The 'kind' field of the event is something we don't recognize. */
2712 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2714 Lisp_Object bar_window
;
2715 enum scroll_bar_part part
;
2719 /* Is it a scroll bar movement? */
2720 if (frame
&& ! NILP (bar_window
))
2722 Lisp_Object part_sym
= *scroll_bar_parts
[(int) part
];
2724 return Fcons (Qscroll_bar_movement
,
2725 (Fcons (Fcons (bar_window
,
2726 Fcons (Qvertical_scroll_bar
,
2727 Fcons (Fcons (x
, y
),
2728 Fcons (make_number (time
),
2734 /* Or is it an ordinary mouse movement? */
2742 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
, 0, 0);
2745 window
= window_from_coordinates (frame
, column
, row
, &area
);
2749 if (XTYPE (window
) == Lisp_Window
)
2751 int pixcolumn
, pixrow
;
2752 column
-= XINT (XWINDOW (window
)->left
);
2753 row
-= XINT (XWINDOW (window
)->top
);
2754 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
2755 XSETINT (x
, pixcolumn
);
2756 XSETINT (y
, pixrow
);
2761 posn
= Qvertical_line
;
2763 XSET (posn
, Lisp_Int
,
2764 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
2766 else if (frame
!= 0)
2768 XSET (window
, Lisp_Frame
, frame
);
2779 return Fcons (Qmouse_movement
,
2780 Fcons (Fcons (window
,
2782 Fcons (Fcons (x
, y
),
2783 Fcons (make_number (time
),
2789 /* Construct a switch frame event. */
2791 make_lispy_switch_frame (frame
)
2794 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
2797 /* Manipulating modifiers. */
2799 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
2801 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2802 SYMBOL's name of the end of the modifiers; the string from this
2803 position is the unmodified symbol name.
2805 This doesn't use any caches. */
2807 parse_modifiers_uncached (symbol
, modifier_end
)
2811 struct Lisp_String
*name
;
2815 CHECK_SYMBOL (symbol
, 1);
2818 name
= XSYMBOL (symbol
)->name
;
2821 for (i
= 0; i
+2 <= name
->size
; )
2822 switch (name
->data
[i
])
2824 #define SINGLE_LETTER_MOD(bit) \
2825 if (name->data[i+1] != '-') \
2826 goto no_more_modifiers; \
2831 SINGLE_LETTER_MOD (alt_modifier
);
2835 SINGLE_LETTER_MOD (ctrl_modifier
);
2839 SINGLE_LETTER_MOD (hyper_modifier
);
2843 SINGLE_LETTER_MOD (meta_modifier
);
2847 SINGLE_LETTER_MOD (shift_modifier
);
2851 SINGLE_LETTER_MOD (super_modifier
);
2855 if (i
+ 5 > name
->size
)
2856 goto no_more_modifiers
;
2857 if (! strncmp (name
->data
+ i
, "drag-", 5))
2859 modifiers
|= drag_modifier
;
2862 else if (! strncmp (name
->data
+ i
, "down-", 5))
2864 modifiers
|= down_modifier
;
2867 else if (i
+ 7 <= name
->size
2868 && ! strncmp (name
->data
+ i
, "double-", 7))
2870 modifiers
|= double_modifier
;
2874 goto no_more_modifiers
;
2878 if (i
+ 7 > name
->size
)
2879 goto no_more_modifiers
;
2880 if (! strncmp (name
->data
+ i
, "triple-", 7))
2882 modifiers
|= triple_modifier
;
2886 goto no_more_modifiers
;
2890 goto no_more_modifiers
;
2892 #undef SINGLE_LETTER_MOD
2896 /* Should we include the `click' modifier? */
2897 if (! (modifiers
& (down_modifier
| drag_modifier
2898 | double_modifier
| triple_modifier
))
2899 && i
+ 7 == name
->size
2900 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
2901 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
2902 modifiers
|= click_modifier
;
2911 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
2912 prepended to the string BASE[0..BASE_LEN-1].
2913 This doesn't use any caches. */
2915 apply_modifiers_uncached (modifiers
, base
, base_len
)
2920 /* Since BASE could contain nulls, we can't use intern here; we have
2921 to use Fintern, which expects a genuine Lisp_String, and keeps a
2924 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
2930 /* Only the event queue may use the `up' modifier; it should always
2931 be turned into a click or drag event before presented to lisp code. */
2932 if (modifiers
& up_modifier
)
2935 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
2936 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
2937 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
2938 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
2939 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
2940 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
2941 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
2942 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
2943 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
2944 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
2945 /* The click modifier is denoted by the absence of other modifiers. */
2949 mod_len
= p
- new_mods
;
2953 Lisp_Object new_name
= make_uninit_string (mod_len
+ base_len
);
2955 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
2956 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
2958 return Fintern (new_name
, Qnil
);
2963 static char *modifier_names
[] =
2965 "up", "down", "drag", "click", "double", "triple", 0, 0,
2966 0, 0, 0, 0, 0, 0, 0, 0,
2967 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
2969 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
2971 static Lisp_Object modifier_symbols
;
2973 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
2975 lispy_modifier_list (modifiers
)
2978 Lisp_Object modifier_list
;
2981 modifier_list
= Qnil
;
2982 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
2983 if (modifiers
& (1<<i
))
2984 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
2987 return modifier_list
;
2991 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
2992 where UNMODIFIED is the unmodified form of SYMBOL,
2993 MASK is the set of modifiers present in SYMBOL's name.
2994 This is similar to parse_modifiers_uncached, but uses the cache in
2995 SYMBOL's Qevent_symbol_element_mask property, and maintains the
2996 Qevent_symbol_elements property. */
2998 parse_modifiers (symbol
)
3001 Lisp_Object elements
= Fget (symbol
, Qevent_symbol_element_mask
);
3003 if (CONSP (elements
))
3008 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
3009 Lisp_Object unmodified
3010 = Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
3011 XSYMBOL (symbol
)->name
->size
- end
),
3015 if (modifiers
& ~((1<<VALBITS
) - 1))
3017 XFASTINT (mask
) = modifiers
;
3018 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
3020 /* Cache the parsing results on SYMBOL. */
3021 Fput (symbol
, Qevent_symbol_element_mask
,
3023 Fput (symbol
, Qevent_symbol_elements
,
3024 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
3026 /* Since we know that SYMBOL is modifiers applied to unmodified,
3027 it would be nice to put that in unmodified's cache.
3028 But we can't, since we're not sure that parse_modifiers is
3035 /* Apply the modifiers MODIFIERS to the symbol BASE.
3036 BASE must be unmodified.
3038 This is like apply_modifiers_uncached, but uses BASE's
3039 Qmodifier_cache property, if present. It also builds
3040 Qevent_symbol_elements properties, since it has that info anyway.
3042 apply_modifiers copies the value of BASE's Qevent_kind property to
3043 the modified symbol. */
3045 apply_modifiers (modifiers
, base
)
3049 Lisp_Object cache
, index
, entry
, new_symbol
;
3051 /* Mask out upper bits. We don't know where this value's been. */
3052 modifiers
&= (1<<VALBITS
) - 1;
3054 /* The click modifier never figures into cache indices. */
3055 cache
= Fget (base
, Qmodifier_cache
);
3056 XFASTINT (index
) = (modifiers
& ~click_modifier
);
3057 entry
= Fassq (index
, cache
);
3060 new_symbol
= XCONS (entry
)->cdr
;
3063 /* We have to create the symbol ourselves. */
3064 new_symbol
= apply_modifiers_uncached (modifiers
,
3065 XSYMBOL (base
)->name
->data
,
3066 XSYMBOL (base
)->name
->size
);
3068 /* Add the new symbol to the base's cache. */
3069 entry
= Fcons (index
, new_symbol
);
3070 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
3072 /* We have the parsing info now for free, so add it to the caches. */
3073 XFASTINT (index
) = modifiers
;
3074 Fput (new_symbol
, Qevent_symbol_element_mask
,
3075 Fcons (base
, Fcons (index
, Qnil
)));
3076 Fput (new_symbol
, Qevent_symbol_elements
,
3077 Fcons (base
, lispy_modifier_list (modifiers
)));
3080 /* Make sure this symbol is of the same kind as BASE.
3082 You'd think we could just set this once and for all when we
3083 intern the symbol above, but reorder_modifiers may call us when
3084 BASE's property isn't set right; we can't assume that just
3085 because it has a Qmodifier_cache property it must have its
3086 Qevent_kind set right as well. */
3087 if (NILP (Fget (new_symbol
, Qevent_kind
)))
3089 Lisp_Object kind
= Fget (base
, Qevent_kind
);
3092 Fput (new_symbol
, Qevent_kind
, kind
);
3099 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
3100 return a symbol with the modifiers placed in the canonical order.
3101 Canonical order is alphabetical, except for down and drag, which
3102 always come last. The 'click' modifier is never written out.
3104 Fdefine_key calls this to make sure that (for example) C-M-foo
3105 and M-C-foo end up being equivalent in the keymap. */
3108 reorder_modifiers (symbol
)
3111 /* It's hopefully okay to write the code this way, since everything
3112 will soon be in caches, and no consing will be done at all. */
3113 Lisp_Object parsed
= parse_modifiers (symbol
);
3115 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
3116 XCONS (parsed
)->car
);
3120 /* For handling events, we often want to produce a symbol whose name
3121 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
3122 to some base, like the name of a function key or mouse button.
3123 modify_event_symbol produces symbols of this sort.
3125 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
3126 is the name of the i'th symbol. TABLE_SIZE is the number of elements
3129 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
3130 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
3132 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
3133 persist between calls to modify_event_symbol that it can use to
3134 store a cache of the symbols it's generated for this NAME_TABLE
3135 before. The object stored there may be a vector or an alist.
3137 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
3139 MODIFIERS is a set of modifier bits (as given in struct input_events)
3140 whose prefixes should be applied to the symbol name.
3142 SYMBOL_KIND is the value to be placed in the event_kind property of
3143 the returned symbol.
3145 The symbols we create are supposed to have an
3146 `event-symbol-elements' property, which lists the modifiers present
3147 in the symbol's name. */
3150 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
3151 name_table
, symbol_table
, table_size
)
3154 Lisp_Object symbol_kind
;
3155 Lisp_Object name_alist
;
3157 Lisp_Object
*symbol_table
;
3161 Lisp_Object symbol_int
;
3163 XSET (symbol_int
, Lisp_Int
, symbol_num
);
3165 /* Is this a request for a valid symbol? */
3166 if (symbol_num
< 0 || symbol_num
>= table_size
)
3169 if (CONSP (*symbol_table
))
3170 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
3172 /* If *symbol_table doesn't seem to be initialized properly, fix that.
3173 *symbol_table should be a lisp vector TABLE_SIZE elements long,
3174 where the Nth element is the symbol for NAME_TABLE[N], or nil if
3175 we've never used that symbol before. */
3178 if (! VECTORP (*symbol_table
)
3179 || XVECTOR (*symbol_table
)->size
!= table_size
)
3183 XFASTINT (size
) = table_size
;
3184 *symbol_table
= Fmake_vector (size
, Qnil
);
3187 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
3190 /* Have we already used this symbol before? */
3193 /* No; let's create it. */
3194 if (!NILP (name_alist
))
3195 value
= Fassq (symbol_int
, name_alist
);
3196 else if (name_table
[symbol_num
])
3197 value
= intern (name_table
[symbol_num
]);
3201 sprintf (buf
, "key-%d", symbol_num
);
3202 value
= intern (buf
);
3205 if (CONSP (*symbol_table
))
3206 *symbol_table
= Fcons (value
, *symbol_table
);
3208 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
3210 /* Fill in the cache entries for this symbol; this also
3211 builds the Qevent_symbol_elements property, which the user
3213 apply_modifiers (modifiers
& click_modifier
, value
);
3214 Fput (value
, Qevent_kind
, symbol_kind
);
3217 /* Apply modifiers to that symbol. */
3218 return apply_modifiers (modifiers
, value
);
3222 /* Store into *addr a value nonzero if terminal input chars are available.
3223 Serves the purpose of ioctl (0, FIONREAD, addr)
3224 but works even if FIONREAD does not exist.
3225 (In fact, this may actually read some input.) */
3228 get_input_pending (addr
)
3231 /* First of all, have we already counted some input? */
3232 *addr
= !NILP (Vquit_flag
) || readable_events ();
3234 /* If input is being read as it arrives, and we have none, there is none. */
3235 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
3238 /* Try to read some input and see how much we get. */
3240 *addr
= !NILP (Vquit_flag
) || readable_events ();
3243 /* Interface to read_avail_input, blocking SIGIO if necessary. */
3246 gobble_input (expected
)
3251 if (interrupt_input
)
3254 mask
= sigblockx (SIGIO
);
3255 read_avail_input (expected
);
3260 read_avail_input (expected
);
3266 /* Read any terminal input already buffered up by the system
3267 into the kbd_buffer, but do not wait.
3269 EXPECTED should be nonzero if the caller knows there is some input.
3271 Except on VMS, all input is read by this function.
3272 If interrupt_input is nonzero, this function MUST be called
3273 only when SIGIO is blocked.
3275 Returns the number of keyboard chars read, or -1 meaning
3276 this is a bad time to try to read input. */
3279 read_avail_input (expected
)
3282 struct input_event buf
[KBD_BUFFER_SIZE
];
3286 if (read_socket_hook
)
3287 /* No need for FIONREAD or fcntl; just say don't wait. */
3288 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
3291 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
3292 the kbd_buffer can really hold. That may prevent loss
3293 of characters on some systems when input is stuffed at us. */
3294 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
3297 nread
= dos_keysns ();
3298 if (nread
== 0) return 0;
3299 #else */ not MSDOS */
3301 /* Find out how much input is available. */
3302 if (ioctl (0, FIONREAD
, &nread
) < 0)
3303 /* Formerly simply reported no input, but that sometimes led to
3304 a failure of Emacs to terminate.
3305 SIGHUP seems appropriate if we can't reach the terminal. */
3306 /* ??? Is it really right to send the signal just to this process
3307 rather than to the whole process group?
3308 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3309 kill (getpid (), SIGHUP
);
3312 if (nread
> sizeof cbuf
)
3313 nread
= sizeof cbuf
;
3314 #else /* no FIONREAD */
3315 #if defined(USG) || defined(DGUX)
3316 /* Read some input if available, but don't wait. */
3317 nread
= sizeof cbuf
;
3318 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
3323 #endif /* not MSDOS */
3325 /* Now read; for one reason or another, this will not block. */
3329 cbuf
[0] = dos_keyread();
3332 nread
= read (fileno (stdin
), cbuf
, nread
);
3335 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3336 This looks incorrect, but it isn't, because _BSD causes
3337 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3338 and that causes a value other than 0 when there is no input. */
3342 /* This code is wrong, but at least it gets the right results.
3343 Fix it for 19.23. */
3344 /* Retry the read if it is interrupted. */
3347 || ! (errno
== EAGAIN
|| errno
== EFAULT
3349 || ! (errno
== EAGAIN
3359 #if defined (USG) || defined (DGUX)
3360 fcntl (fileno (stdin
), F_SETFL
, 0);
3361 #endif /* USG or DGUX */
3362 #endif /* no FIONREAD */
3363 for (i
= 0; i
< nread
; i
++)
3365 buf
[i
].kind
= ascii_keystroke
;
3366 buf
[i
].modifiers
= 0;
3367 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3368 buf
[i
].modifiers
= meta_modifier
;
3372 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
3374 XSET (buf
[i
].frame_or_window
, Lisp_Frame
, selected_frame
);
3376 buf
[i
].frame_or_window
= Qnil
;
3381 /* Scan the chars for C-g and store them in kbd_buffer. */
3382 for (i
= 0; i
< nread
; i
++)
3384 kbd_buffer_store_event (&buf
[i
]);
3385 /* Don't look at input that follows a C-g too closely.
3386 This reduces lossage due to autorepeat on C-g. */
3387 if (buf
[i
].kind
== ascii_keystroke
3388 && XINT(buf
[i
].code
) == quit_char
)
3394 #endif /* not VMS */
3396 #ifdef SIGIO /* for entire page */
3397 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3400 input_available_signal (signo
)
3403 /* Must preserve main program's value of errno. */
3404 int old_errno
= errno
;
3406 extern int select_alarmed
;
3410 /* USG systems forget handlers when they are used;
3411 must reestablish each time */
3412 signal (signo
, input_available_signal
);
3419 if (input_available_clear_time
)
3420 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3425 nread
= read_avail_input (1);
3426 /* -1 means it's not ok to read the input now.
3427 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3428 0 means there was no keyboard input available. */
3433 select_alarmed
= 1; /* Force the select emulator back to life */
3444 /* Send ourselves a SIGIO.
3446 This function exists so that the UNBLOCK_INPUT macro in
3447 blockinput.h can have some way to take care of input we put off
3448 dealing with, without assuming that every file which uses
3449 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3451 reinvoke_input_signal ()
3460 /* Return the prompt-string of a sparse keymap.
3461 This is the first element which is a string.
3462 Return nil if there is none. */
3470 register Lisp_Object tem
;
3472 if (XTYPE (tem
) == Lisp_String
)
3479 static Lisp_Object
menu_bar_item ();
3480 static Lisp_Object
menu_bar_one_keymap ();
3482 /* Return a list of menu items for a menu bar, appropriate
3483 to the current buffer.
3484 The elements have the form (KEY STRING . nil). */
3489 /* The number of keymaps we're scanning right now, and the number of
3490 keymaps we have allocated space for. */
3493 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3494 in the current keymaps, or nil where it is not a prefix. */
3497 Lisp_Object def
, tem
, tail
;
3504 /* In order to build the menus, we need to call the keymap
3505 accessors. They all call QUIT. But this function is called
3506 during redisplay, during which a quit is fatal. So inhibit
3507 quitting while building the menus.
3508 We do this instead of specbind because (1) errors will clear it anyway
3509 and (2) this avoids risk of specpdl overflow. */
3510 oquit
= Vinhibit_quit
;
3513 /* Build our list of keymaps.
3514 If we recognize a function key and replace its escape sequence in
3515 keybuf with its symbol, or if the sequence starts with a mouse
3516 click and we need to switch buffers, we jump back here to rebuild
3517 the initial keymaps from the current buffer. */
3521 if (!NILP (Voverriding_local_map
))
3524 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3525 maps
[0] = Voverriding_local_map
;
3529 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3530 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3531 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3532 #ifdef USE_TEXT_PROPERTIES
3533 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3535 maps
[nmaps
-2] = current_buffer
->keymap
;
3538 maps
[nmaps
-1] = current_global_map
;
3541 /* Look up in each map the dummy prefix key `menu-bar'. */
3545 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3547 if (! NILP (maps
[mapno
]))
3548 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3552 tem
= Fkeymapp (def
);
3554 result
= menu_bar_one_keymap (def
, result
);
3557 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3561 elt
= Fassq (XCONS (tail
)->car
, result
);
3563 result
= Fcons (elt
, Fdelq (elt
, result
));
3566 result
= Fnreverse (result
);
3567 Vinhibit_quit
= oquit
;
3571 /* Scan one map KEYMAP, accumulating any menu items it defines
3572 that have not yet been seen in RESULT. Return the updated RESULT. */
3575 menu_bar_one_keymap (keymap
, result
)
3576 Lisp_Object keymap
, result
;
3578 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3580 /* Loop over all keymap entries that have menu strings. */
3581 for (tail
= keymap
; XTYPE (tail
) == Lisp_Cons
; tail
= XCONS (tail
)->cdr
)
3583 item
= XCONS (tail
)->car
;
3584 if (XTYPE (item
) == Lisp_Cons
)
3586 key
= XCONS (item
)->car
;
3587 binding
= XCONS (item
)->cdr
;
3588 if (XTYPE (binding
) == Lisp_Cons
)
3590 item_string
= XCONS (binding
)->car
;
3591 if (XTYPE (item_string
) == Lisp_String
)
3592 result
= menu_bar_item (key
, item_string
,
3593 Fcdr (binding
), result
);
3595 else if (EQ (binding
, Qundefined
))
3596 result
= menu_bar_item (key
, item_string
,
3599 else if (XTYPE (item
) == Lisp_Vector
)
3601 /* Loop over the char values represented in the vector. */
3602 int len
= XVECTOR (item
)->size
;
3604 for (c
= 0; c
< len
; c
++)
3606 Lisp_Object character
;
3607 XFASTINT (character
) = c
;
3608 binding
= XVECTOR (item
)->contents
[c
];
3609 if (XTYPE (binding
) == Lisp_Cons
)
3611 item_string
= XCONS (binding
)->car
;
3612 if (XTYPE (item_string
) == Lisp_String
)
3613 result
= menu_bar_item (key
, item_string
,
3614 Fcdr (binding
), result
);
3616 else if (EQ (binding
, Qundefined
))
3617 result
= menu_bar_item (key
, item_string
,
3626 /* This is used as the handler when calling internal_condition_case_1. */
3629 menu_bar_item_1 (arg
)
3636 menu_bar_item (key
, item_string
, def
, result
)
3637 Lisp_Object key
, item_string
, def
, result
;
3640 Lisp_Object enabled
;
3642 if (EQ (def
, Qundefined
))
3644 /* If a map has an explicit nil as definition,
3645 discard any previously made menu bar item. */
3646 tem
= Fassq (key
, result
);
3647 return Fdelq (tem
, result
);
3650 /* See if this entry is enabled. */
3653 if (XTYPE (def
) == Lisp_Symbol
)
3655 /* No property, or nil, means enable.
3656 Otherwise, enable if value is not nil. */
3657 tem
= Fget (def
, Qmenu_enable
);
3659 /* (condition-case nil (eval tem)
3661 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
3665 /* Add an entry for this key and string
3666 if there is none yet. */
3667 tem
= Fassq (key
, result
);
3668 if (!NILP (enabled
) && NILP (tem
))
3669 result
= Fcons (Fcons (key
, Fcons (item_string
, Qnil
)), result
);
3674 /* Read a character using menus based on maps in the array MAPS.
3675 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
3676 Return t if we displayed a menu but the user rejected it.
3678 PREV_EVENT is the previous input event, or nil if we are reading
3679 the first event of a key sequence.
3681 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3682 if we used a mouse menu to read the input, or zero otherwise. If
3683 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
3685 The prompting is done based on the prompt-string of the map
3686 and the strings associated with various map elements.
3688 This can be done with X menus or with menus put in the minibuf.
3689 These are done in different ways, depending on how the input will be read.
3690 Menus using X are done after auto-saving in read-char, getting the input
3691 event from Fx_popup_menu; menus using the minibuf use read_char recursively
3692 and do auto-saving in the inner call of read_char. */
3695 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
3698 Lisp_Object prev_event
;
3699 int *used_mouse_menu
;
3702 register Lisp_Object name
;
3703 Lisp_Object rest
, vector
;
3705 if (used_mouse_menu
)
3706 *used_mouse_menu
= 0;
3708 /* Use local over global Menu maps */
3710 if (! menu_prompting
)
3713 /* Get the menu name from the first map that has one (a prompt string). */
3714 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3716 name
= map_prompt (maps
[mapno
]);
3721 /* If we don't have any menus, just read a character normally. */
3725 #ifdef HAVE_X_WINDOWS
3727 /* If we got to this point via a mouse click,
3728 use a real menu for mouse selection. */
3729 if (EVENT_HAS_PARAMETERS (prev_event
))
3731 /* Display the menu and get the selection. */
3732 Lisp_Object
*realmaps
3733 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
3737 /* Use the maps that are not nil. */
3738 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3739 if (!NILP (maps
[mapno
]))
3740 realmaps
[nmaps1
++] = maps
[mapno
];
3742 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
3745 /* If we got more than one event, put all but the first
3746 onto this list to be read later.
3747 Return just the first event now. */
3748 unread_command_events
3749 = nconc2 (XCONS (value
)->cdr
, unread_command_events
);
3750 value
= XCONS (value
)->car
;
3754 if (used_mouse_menu
)
3755 *used_mouse_menu
= 1;
3758 #endif /* HAVE_X_MENU */
3759 #endif /* HAVE_X_WINDOWS */
3764 read_char_minibuf_menu_prompt(commandflag
, nmaps
, maps
)
3770 register Lisp_Object name
;
3772 int width
= FRAME_WIDTH (selected_frame
) - 4;
3773 char *menu
= (char *) alloca (width
+ 4);
3776 Lisp_Object rest
, vector
;
3778 if (! menu_prompting
)
3781 /* Get the menu name from the first map that has one (a prompt string). */
3782 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3784 name
= map_prompt (maps
[mapno
]);
3789 /* If we don't have any menus, just read a character normally. */
3793 /* Prompt string always starts with map's prompt, and a space. */
3794 strcpy (menu
, XSTRING (name
)->data
);
3795 nlength
= XSTRING (name
)->size
;
3796 menu
[nlength
++] = ':';
3797 menu
[nlength
++] = ' ';
3800 /* Start prompting at start of first map. */
3804 /* Present the documented bindings, a line at a time. */
3811 int orig_defn_macro
;
3813 /* Loop over elements of map. */
3818 /* If reached end of map, start at beginning of next map. */
3822 /* At end of last map, wrap around to first map if just starting,
3823 or end this line if already have something on it. */
3827 if (notfirst
|| nobindings
) break;
3832 /* Look at the next element of the map. */
3834 elt
= XVECTOR (vector
)->contents
[idx
];
3836 elt
= Fcar_safe (rest
);
3838 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
3840 /* If we found a dense table in the keymap,
3841 advanced past it, but start scanning its contents. */
3842 rest
= Fcdr_safe (rest
);
3848 /* An ordinary element. */
3850 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
3852 s
= Fcar_safe(elt
); /* vector */
3853 if (XTYPE (s
) != Lisp_String
)
3854 /* Ignore the element if it has no prompt string. */
3856 /* If we have room for the prompt string, add it to this line.
3857 If this is the first on the line, always add it. */
3858 else if (XSTRING (s
)->size
+ i
+ 2 < width
3863 /* Punctuate between strings. */
3866 strcpy (menu
+ i
, ", ");
3872 /* Add as much of string as fits. */
3873 thiswidth
= XSTRING (s
)->size
;
3874 if (thiswidth
+ i
> width
)
3875 thiswidth
= width
- i
;
3876 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
3882 /* If this element does not fit, end the line now,
3883 and save the element for the next line. */
3884 strcpy (menu
+ i
, "...");
3888 /* Move past this element. */
3889 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
3890 /* Handle reaching end of dense table. */
3895 rest
= Fcdr_safe (rest
);
3899 /* Prompt with that and read response. */
3902 /* Make believe its not a keyboard macro in case the help char
3903 is pressed. Help characters are not recorded because menu prompting
3904 is not used on replay.
3906 orig_defn_macro
= defining_kbd_macro
;
3907 defining_kbd_macro
= 0 ;
3909 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
3910 while (XTYPE (obj
) == Lisp_Buffer
);
3911 defining_kbd_macro
= orig_defn_macro
;
3913 if (XTYPE (obj
) != Lisp_Int
)
3918 if (! EQ (obj
, menu_prompt_more_char
)
3919 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
3920 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
3922 if ( defining_kbd_macro
)
3923 store_kbd_macro_char(obj
) ;
3926 /* Help char - go round again */
3930 /* Reading key sequences. */
3932 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
3933 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
3934 keymap, or nil otherwise. Return the index of the first keymap in
3935 which KEY has any binding, or NMAPS if no map has a binding.
3937 If KEY is a meta ASCII character, treat it like meta-prefix-char
3938 followed by the corresponding non-meta character. Keymaps in
3939 CURRENT with non-prefix bindings for meta-prefix-char become nil in
3942 When KEY is not defined in any of the keymaps, if it is an upper
3943 case letter and there are bindings for the corresponding lower-case
3944 letter, return the bindings for the lower-case letter.
3945 We store 1 in *CASE_CONVERTED in this case.
3946 Otherwise, we don't change *CASE_CONVERTED.
3948 If KEY has no bindings in any of the CURRENT maps, NEXT is left
3951 NEXT may == CURRENT. */
3954 follow_key (key
, nmaps
, current
, defs
, next
, case_converted
)
3956 Lisp_Object
*current
, *defs
, *next
;
3958 int *case_converted
;
3960 int i
, first_binding
;
3962 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
3963 followed by the corresponding non-meta character. */
3964 if (XTYPE (key
) == Lisp_Int
&& (XINT (key
) & CHAR_META
))
3966 for (i
= 0; i
< nmaps
; i
++)
3967 if (! NILP (current
[i
]))
3970 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
3972 /* Note that since we pass the resulting bindings through
3973 get_keymap_1, non-prefix bindings for meta-prefix-char
3975 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
3981 XSET (key
, Lisp_Int
, XFASTINT (key
) & ~CHAR_META
);
3984 first_binding
= nmaps
;
3985 for (i
= nmaps
- 1; i
>= 0; i
--)
3987 if (! NILP (current
[i
]))
3989 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3990 if (! NILP (defs
[i
]))
3997 /* When KEY is not defined in any of the keymaps, if it is an upper
3998 case letter and there are bindings for the corresponding
3999 lower-case letter, return the bindings for the lower-case letter. */
4000 if (first_binding
== nmaps
4001 && XTYPE (key
) == Lisp_Int
4002 && ((((XINT (key
) & 0x3ffff)
4003 < XSTRING (current_buffer
->downcase_table
)->size
)
4004 && UPPERCASEP (XINT (key
) & 0x3ffff))
4005 || (XINT (key
) & shift_modifier
)))
4007 if (XINT (key
) & shift_modifier
)
4008 XSETINT (key
, XINT (key
) & ~shift_modifier
);
4010 XSETINT (key
, (DOWNCASE (XINT (key
) & 0x3ffff)
4011 | (XINT (key
) & ~0x3ffff)));
4013 first_binding
= nmaps
;
4014 for (i
= nmaps
- 1; i
>= 0; i
--)
4016 if (! NILP (current
[i
]))
4018 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
4019 if (! NILP (defs
[i
]))
4025 if (first_binding
!= nmaps
)
4026 *case_converted
= 1;
4029 /* Given the set of bindings we've found, produce the next set of maps. */
4030 if (first_binding
< nmaps
)
4031 for (i
= 0; i
< nmaps
; i
++)
4032 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
4034 return first_binding
;
4037 /* Read a sequence of keys that ends with a non prefix character,
4038 storing it in KEYBUF, a buffer of size BUFSIZE.
4040 Return the length of the key sequence stored.
4041 Return -1 if the user rejected a command menu.
4043 Echo starting immediately unless `prompt' is 0.
4045 Where a key sequence ends depends on the currently active keymaps.
4046 These include any minor mode keymaps active in the current buffer,
4047 the current buffer's local map, and the global map.
4049 If a key sequence has no other bindings, we check Vfunction_key_map
4050 to see if some trailing subsequence might be the beginning of a
4051 function key's sequence. If so, we try to read the whole function
4052 key, and substitute its symbolic name into the key sequence.
4054 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
4055 `double-' events into similar click events, if that would make them
4056 bound. We try to turn `triple-' events first into `double-' events,
4059 If we get a mouse click in a mode line, vertical divider, or other
4060 non-text area, we treat the click as if it were prefixed by the
4061 symbol denoting that area - `mode-line', `vertical-line', or
4064 If the sequence starts with a mouse click, we read the key sequence
4065 with respect to the buffer clicked on, not the current buffer.
4067 If the user switches frames in the midst of a key sequence, we put
4068 off the switch-frame event until later; the next call to
4069 read_char will return it. */
4072 read_key_sequence (keybuf
, bufsize
, prompt
)
4073 Lisp_Object
*keybuf
;
4077 int count
= specpdl_ptr
- specpdl
;
4079 /* How many keys there are in the current key sequence. */
4082 /* The length of the echo buffer when we started reading, and
4083 the length of this_command_keys when we started reading. */
4087 /* The number of keymaps we're scanning right now, and the number of
4088 keymaps we have allocated space for. */
4090 int nmaps_allocated
= 0;
4092 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
4093 the current keymaps. */
4096 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
4097 in the current keymaps, or nil where it is not a prefix. */
4098 Lisp_Object
*submaps
;
4100 /* The index in defs[] of the first keymap that has a binding for
4101 this key sequence. In other words, the lowest i such that
4102 defs[i] is non-nil. */
4105 /* If t < mock_input, then KEYBUF[t] should be read as the next
4108 We use this to recover after recognizing a function key. Once we
4109 realize that a suffix of the current key sequence is actually a
4110 function key's escape sequence, we replace the suffix with the
4111 function key's binding from Vfunction_key_map. Now keybuf
4112 contains a new and different key sequence, so the echo area,
4113 this_command_keys, and the submaps and defs arrays are wrong. In
4114 this situation, we set mock_input to t, set t to 0, and jump to
4115 restart_sequence; the loop will read keys from keybuf up until
4116 mock_input, thus rebuilding the state; and then it will resume
4117 reading characters from the keyboard. */
4120 /* If the sequence is unbound in submaps[], then
4121 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
4122 and fkey_map is its binding.
4124 These might be > t, indicating that all function key scanning
4125 should hold off until t reaches them. We do this when we've just
4126 recognized a function key, to avoid searching for the function
4127 key's again in Vfunction_key_map. */
4128 int fkey_start
= 0, fkey_end
= 0;
4129 Lisp_Object fkey_map
;
4131 /* Likewise, for key_translation_map. */
4132 int keytran_start
= 0, keytran_end
= 0;
4133 Lisp_Object keytran_map
;
4135 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
4136 we put it off for later. While we're reading, we keep the event here. */
4137 Lisp_Object delayed_switch_frame
;
4139 /* See the comment below... */
4140 #if defined (GOBBLE_FIRST_EVENT)
4141 Lisp_Object first_event
;
4144 struct buffer
*starting_buffer
;
4146 /* Nonzero if we found the binding for one of the chars
4147 in this key sequence by downcasing it. */
4148 int case_converted
= 0;
4150 /* Nonzero if we seem to have got the beginning of a binding
4151 in function_key_map. */
4152 int function_key_possible
= 0;
4156 last_nonmenu_event
= Qnil
;
4158 delayed_switch_frame
= Qnil
;
4159 fkey_map
= Vfunction_key_map
;
4160 keytran_map
= Vkey_translation_map
;
4162 /* If there is no function-key-map, turn off function key scanning. */
4163 if (NILP (Fkeymapp (Vfunction_key_map
)))
4164 fkey_start
= fkey_end
= bufsize
+ 1;
4166 /* If there is no key-translation-map, turn off scanning. */
4167 if (NILP (Fkeymapp (Vkey_translation_map
)))
4168 keytran_start
= keytran_end
= bufsize
+ 1;
4173 echo_prompt (XSTRING (prompt
)->data
);
4174 else if (cursor_in_echo_area
)
4175 /* This doesn't put in a dash if the echo buffer is empty, so
4176 you don't always see a dash hanging out in the minibuffer. */
4180 /* Record the initial state of the echo area and this_command_keys;
4181 we will need to restore them if we replay a key sequence. */
4183 echo_start
= echo_length ();
4184 keys_start
= this_command_key_count
;
4186 #if defined (GOBBLE_FIRST_EVENT)
4187 /* This doesn't quite work, because some of the things that read_char
4188 does cannot safely be bypassed. It seems too risky to try to make
4191 /* Read the first char of the sequence specially, before setting
4192 up any keymaps, in case a filter runs and switches buffers on us. */
4193 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
4195 #endif /* GOBBLE_FIRST_EVENT */
4197 /* We jump here when the key sequence has been thoroughly changed, and
4198 we need to rescan it starting from the beginning. When we jump here,
4199 keybuf[0..mock_input] holds the sequence we should reread. */
4202 starting_buffer
= current_buffer
;
4204 function_key_possible
= 0;
4206 /* Build our list of keymaps.
4207 If we recognize a function key and replace its escape sequence in
4208 keybuf with its symbol, or if the sequence starts with a mouse
4209 click and we need to switch buffers, we jump back here to rebuild
4210 the initial keymaps from the current buffer. */
4214 if (!NILP (Voverriding_local_map
))
4217 if (nmaps
> nmaps_allocated
)
4219 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4220 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4221 nmaps_allocated
= nmaps
;
4223 submaps
[0] = Voverriding_local_map
;
4227 nmaps
= current_minor_maps (0, &maps
) + 2;
4228 if (nmaps
> nmaps_allocated
)
4230 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4231 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4232 nmaps_allocated
= nmaps
;
4234 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
4235 #ifdef USE_TEXT_PROPERTIES
4236 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
4238 submaps
[nmaps
-2] = current_buffer
->keymap
;
4241 submaps
[nmaps
-1] = current_global_map
;
4244 /* Find an accurate initial value for first_binding. */
4245 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
4246 if (! NILP (submaps
[first_binding
]))
4249 /* Start from the beginning in keybuf. */
4252 /* These are no-ops the first time through, but if we restart, they
4253 revert the echo area and this_command_keys to their original state. */
4254 this_command_key_count
= keys_start
;
4255 if (INTERACTIVE
&& t
< mock_input
)
4256 echo_truncate (echo_start
);
4258 /* If the best binding for the current key sequence is a keymap, or
4259 we may be looking at a function key's escape sequence, keep on
4261 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
4262 || (first_binding
>= nmaps
4264 /* mock input is never part of a function key's sequence. */
4265 && mock_input
<= fkey_start
)
4266 || (first_binding
>= nmaps
4267 && keytran_start
< t
4268 /* mock input is never part of a function key's sequence. */
4269 && mock_input
<= keytran_start
)
4270 /* Don't return in the middle of a possible function key sequence,
4271 if the only bindings we found were via case conversion.
4272 Thus, if ESC O a has a function-key-map translation
4273 and ESC o has a binding, don't return after ESC O,
4274 so that we can translate ESC O plus the next character. */
4275 || (function_key_possible
&& case_converted
))
4278 int used_mouse_menu
= 0;
4280 /* Where the last real key started. If we need to throw away a
4281 key that has expanded into more than one element of keybuf
4282 (say, a mouse click on the mode line which is being treated
4283 as [mode-line (mouse-...)], then we backtrack to this point
4285 int last_real_key_start
;
4287 /* These variables are analogous to echo_start and keys_start;
4288 while those allow us to restart the entire key sequence,
4289 echo_local_start and keys_local_start allow us to throw away
4291 int echo_local_start
, keys_local_start
, local_first_binding
;
4294 error ("key sequence too long");
4297 echo_local_start
= echo_length ();
4298 keys_local_start
= this_command_key_count
;
4299 local_first_binding
= first_binding
;
4302 /* These are no-ops, unless we throw away a keystroke below and
4303 jumped back up to replay_key; in that case, these restore the
4304 variables to their original state, allowing us to replay the
4306 if (INTERACTIVE
&& t
< mock_input
)
4307 echo_truncate (echo_local_start
);
4308 this_command_key_count
= keys_local_start
;
4309 first_binding
= local_first_binding
;
4311 /* By default, assume each event is "real". */
4312 last_real_key_start
= t
;
4314 /* Does mock_input indicate that we are re-reading a key sequence? */
4318 add_command_key (key
);
4322 /* If not, we should actually read a character. */
4325 struct buffer
*buf
= current_buffer
;
4327 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
4330 /* read_char returns t when it shows a menu and the user rejects it.
4335 /* read_char returns -1 at the end of a macro.
4336 Emacs 18 handles this by returning immediately with a
4337 zero, so that's what we'll do. */
4338 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) == -1)
4344 /* If the current buffer has been changed from under us, the
4345 keymap may have changed, so replay the sequence. */
4346 if (XTYPE (key
) == Lisp_Buffer
)
4349 goto replay_sequence
;
4352 /* If we have a quit that was typed in another frame, and
4353 quit_throw_to_read_char switched buffers,
4354 replay to get the right keymap. */
4355 if (EQ (key
, quit_char
) && current_buffer
!= starting_buffer
)
4360 goto replay_sequence
;
4366 /* Clicks in non-text areas get prefixed by the symbol
4367 in their CHAR-ADDRESS field. For example, a click on
4368 the mode line is prefixed by the symbol `mode-line'.
4370 Furthermore, key sequences beginning with mouse clicks
4371 are read using the keymaps of the buffer clicked on, not
4372 the current buffer. So we may have to switch the buffer
4375 When we turn one event into two events, we must make sure
4376 that neither of the two looks like the original--so that,
4377 if we replay the events, they won't be expanded again.
4378 If not for this, such reexpansion could happen either here
4379 or when user programs play with this-command-keys. */
4380 if (EVENT_HAS_PARAMETERS (key
))
4382 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
4384 if (EQ (kind
, Qmouse_click
))
4386 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
4387 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4389 if (XTYPE (posn
) == Lisp_Cons
)
4391 /* We're looking at the second event of a
4392 sequence which we expanded before. Set
4393 last_real_key_start appropriately. */
4395 last_real_key_start
= t
- 1;
4398 /* Key sequences beginning with mouse clicks are
4399 read using the keymaps in the buffer clicked on,
4400 not the current buffer. If we're at the
4401 beginning of a key sequence, switch buffers. */
4402 if (last_real_key_start
== 0
4403 && XTYPE (window
) == Lisp_Window
4404 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
4405 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
4410 /* Arrange to go back to the original buffer once we're
4411 done reading the key sequence. Note that we can't
4412 use save_excursion_{save,restore} here, because they
4413 save point as well as the current buffer; we don't
4414 want to save point, because redisplay may change it,
4415 to accommodate a Fset_window_start or something. We
4416 don't want to do this at the top of the function,
4417 because we may get input from a subprocess which
4418 wants to change the selected window and stuff (say,
4420 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
4422 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
4423 goto replay_sequence
;
4425 else if (XTYPE (posn
) == Lisp_Symbol
)
4427 /* Expand mode-line and scroll-bar events into two events:
4428 use posn as a fake prefix key. */
4430 if (t
+ 1 >= bufsize
)
4431 error ("key sequence too long");
4436 /* Zap the position in key, so we know that we've
4437 expanded it, and don't try to do so again. */
4438 POSN_BUFFER_POSN (EVENT_START (key
))
4439 = Fcons (posn
, Qnil
);
4443 else if (EQ (kind
, Qswitch_frame
))
4445 /* If we're at the beginning of a key sequence, go
4446 ahead and return this event. If we're in the
4447 midst of a key sequence, delay it until the end. */
4450 delayed_switch_frame
= key
;
4456 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4458 /* Handle menu-bar events:
4459 insert the dummy prefix event `menu-bar'. */
4460 if (EQ (posn
, Qmenu_bar
))
4462 if (t
+ 1 >= bufsize
)
4463 error ("key sequence too long");
4464 /* Run the Lucid hook. */
4465 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4466 /* If it has changed current-menubar from previous value,
4467 really recompute the menubar from the value. */
4468 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4469 call0 (Qrecompute_lucid_menubar
);
4473 /* Zap the position in key, so we know that we've
4474 expanded it, and don't try to do so again. */
4475 POSN_BUFFER_POSN (EVENT_START (key
))
4476 = Fcons (posn
, Qnil
);
4479 goto replay_sequence
;
4481 else if (XTYPE (posn
) == Lisp_Cons
)
4483 /* We're looking at the second event of a
4484 sequence which we expanded before. Set
4485 last_real_key_start appropriately. */
4486 if (last_real_key_start
== t
&& t
> 0)
4487 last_real_key_start
= t
- 1;
4492 /* We have finally decided that KEY is something we might want
4494 first_binding
= (follow_key (key
,
4495 nmaps
- first_binding
,
4496 submaps
+ first_binding
,
4497 defs
+ first_binding
,
4498 submaps
+ first_binding
,
4502 /* If KEY wasn't bound, we'll try some fallbacks. */
4503 if (first_binding
>= nmaps
)
4505 Lisp_Object head
= EVENT_HEAD (key
);
4507 if (EQ (head
, Vhelp_char
))
4509 read_key_sequence_cmd
= Vprefix_help_command
;
4511 last_nonmenu_event
= key
;
4515 if (XTYPE (head
) == Lisp_Symbol
)
4517 Lisp_Object breakdown
= parse_modifiers (head
);
4518 int modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4520 /* Attempt to reduce an unbound mouse event to a simpler
4521 event that is bound:
4522 Drags reduce to clicks.
4523 Double-clicks reduce to clicks.
4524 Triple-clicks reduce to double-clicks, then to clicks.
4525 Down-clicks are eliminated.
4526 Double-downs reduce to downs, then are eliminated.
4527 Triple-downs reduce to double-downs, then to downs,
4528 then are eliminated. */
4529 if (modifiers
& (down_modifier
| drag_modifier
4530 | double_modifier
| triple_modifier
))
4532 while (modifiers
& (down_modifier
| drag_modifier
4533 | double_modifier
| triple_modifier
))
4535 Lisp_Object new_head
, new_click
;
4536 if (modifiers
& triple_modifier
)
4537 modifiers
^= (double_modifier
| triple_modifier
);
4538 else if (modifiers
& (drag_modifier
| double_modifier
))
4539 modifiers
&= ~(drag_modifier
| double_modifier
);
4542 /* Dispose of this `down' event by simply jumping
4543 back to replay_key, to get another event.
4545 Note that if this event came from mock input,
4546 then just jumping back to replay_key will just
4547 hand it to us again. So we have to wipe out any
4550 We could delete keybuf[t] and shift everything
4551 after that to the left by one spot, but we'd also
4552 have to fix up any variable that points into
4553 keybuf, and shifting isn't really necessary
4556 Adding prefixes for non-textual mouse clicks
4557 creates two characters of mock input, and both
4558 must be thrown away. If we're only looking at
4559 the prefix now, we can just jump back to
4560 replay_key. On the other hand, if we've already
4561 processed the prefix, and now the actual click
4562 itself is giving us trouble, then we've lost the
4563 state of the keymaps we want to backtrack to, and
4564 we need to replay the whole sequence to rebuild
4567 Beyond that, only function key expansion could
4568 create more than two keys, but that should never
4569 generate mouse events, so it's okay to zero
4570 mock_input in that case too.
4572 Isn't this just the most wonderful code ever? */
4573 if (t
== last_real_key_start
)
4580 mock_input
= last_real_key_start
;
4581 goto replay_sequence
;
4586 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
4588 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
4590 /* Look for a binding for this new key. follow_key
4591 promises that it didn't munge submaps the
4592 last time we called it, since key was unbound. */
4594 = (follow_key (new_click
,
4595 nmaps
- local_first_binding
,
4596 submaps
+ local_first_binding
,
4597 defs
+ local_first_binding
,
4598 submaps
+ local_first_binding
,
4600 + local_first_binding
);
4602 /* If that click is bound, go for it. */
4603 if (first_binding
< nmaps
)
4608 /* Otherwise, we'll leave key set to the drag event. */
4615 /* Normally, last_nonmenu_event gets the previous key we read.
4616 But when a mouse popup menu is being used,
4617 we don't update last_nonmenu_event; it continues to hold the mouse
4618 event that preceded the first level of menu. */
4619 if (!used_mouse_menu
)
4620 last_nonmenu_event
= key
;
4622 /* If the sequence is unbound, see if we can hang a function key
4623 off the end of it. We only want to scan real keyboard input
4624 for function key sequences, so if mock_input says that we're
4625 re-reading old events, don't examine it. */
4626 if ((first_binding
>= nmaps
|| case_converted
)
4629 Lisp_Object fkey_next
;
4631 /* Continue scan from fkey_end until we find a bound suffix.
4632 If we fail, increment fkey_start
4633 and start fkey_end from there. */
4634 while (fkey_end
< t
)
4638 key
= keybuf
[fkey_end
++];
4639 /* Look up meta-characters by prefixing them
4640 with meta_prefix_char. I hate this. */
4641 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4646 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
4648 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4651 fkey_next
= fkey_map
;
4654 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
4656 /* If the function key map gives a function, not an
4657 array, then call the function with no args and use
4658 its value instead. */
4659 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
4662 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4666 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4667 fkey_next
= call1 (fkey_next
, prompt
);
4669 /* If the function returned something invalid,
4670 barf--don't ignore it.
4671 (To ignore it safely, we would need to gcpro a bunch of
4672 other variables.) */
4673 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
4674 error ("Function in function-key-map returns invalid key sequence");
4677 function_key_possible
= ! NILP (fkey_next
);
4679 /* If keybuf[fkey_start..fkey_end] is bound in the
4680 function key map and it's a suffix of the current
4681 sequence (i.e. fkey_end == t), replace it with
4682 the binding and restart with fkey_start at the end. */
4683 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
4686 int len
= XFASTINT (Flength (fkey_next
));
4688 t
= fkey_start
+ len
;
4690 error ("key sequence too long");
4692 if (VECTORP (fkey_next
))
4693 bcopy (XVECTOR (fkey_next
)->contents
,
4694 keybuf
+ fkey_start
,
4695 (t
- fkey_start
) * sizeof (keybuf
[0]));
4696 else if (STRINGP (fkey_next
))
4700 for (i
= 0; i
< len
; i
++)
4701 XFASTINT (keybuf
[fkey_start
+ i
])
4702 = XSTRING (fkey_next
)->data
[i
];
4706 fkey_start
= fkey_end
= t
;
4707 fkey_map
= Vfunction_key_map
;
4709 goto replay_sequence
;
4712 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
4714 /* If we no longer have a bound suffix, try a new positions for
4716 if (NILP (fkey_map
))
4718 fkey_end
= ++fkey_start
;
4719 fkey_map
= Vfunction_key_map
;
4720 function_key_possible
= 0;
4725 /* Look for this sequence in key-translation-map. */
4727 Lisp_Object keytran_next
;
4729 /* Scan from keytran_end until we find a bound suffix. */
4730 while (keytran_end
< t
)
4734 key
= keybuf
[keytran_end
++];
4735 /* Look up meta-characters by prefixing them
4736 with meta_prefix_char. I hate this. */
4737 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4742 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
4744 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4747 keytran_next
= keytran_map
;
4750 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
4752 /* If the key translation map gives a function, not an
4753 array, then call the function with no args and use
4754 its value instead. */
4755 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
4756 && keytran_end
== t
)
4758 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4762 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4763 keytran_next
= call1 (keytran_next
, prompt
);
4765 /* If the function returned something invalid,
4766 barf--don't ignore it.
4767 (To ignore it safely, we would need to gcpro a bunch of
4768 other variables.) */
4769 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
4770 error ("Function in key-translation-map returns invalid key sequence");
4773 /* If keybuf[keytran_start..keytran_end] is bound in the
4774 key translation map and it's a suffix of the current
4775 sequence (i.e. keytran_end == t), replace it with
4776 the binding and restart with keytran_start at the end. */
4777 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
4778 && keytran_end
== t
)
4780 int len
= XFASTINT (Flength (keytran_next
));
4782 t
= keytran_start
+ len
;
4784 error ("key sequence too long");
4786 if (VECTORP (keytran_next
))
4787 bcopy (XVECTOR (keytran_next
)->contents
,
4788 keybuf
+ keytran_start
,
4789 (t
- keytran_start
) * sizeof (keybuf
[0]));
4790 else if (STRINGP (keytran_next
))
4794 for (i
= 0; i
< len
; i
++)
4795 XFASTINT (keybuf
[keytran_start
+ i
])
4796 = XSTRING (keytran_next
)->data
[i
];
4800 keytran_start
= keytran_end
= t
;
4801 keytran_map
= Vkey_translation_map
;
4803 goto replay_sequence
;
4806 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
4808 /* If we no longer have a bound suffix, try a new positions for
4810 if (NILP (keytran_map
))
4812 keytran_end
= ++keytran_start
;
4813 keytran_map
= Vkey_translation_map
;
4819 read_key_sequence_cmd
= (first_binding
< nmaps
4820 ? defs
[first_binding
]
4824 unread_switch_frame
= delayed_switch_frame
;
4825 unbind_to (count
, Qnil
);
4827 /* Occasionally we fabricate events, perhaps by expanding something
4828 according to function-key-map, or by adding a prefix symbol to a
4829 mouse click in the scroll bar or modeline. In this cases, return
4830 the entire generated key sequence, even if we hit an unbound
4831 prefix or a definition before the end. This means that you will
4832 be able to push back the event properly, and also means that
4833 read-key-sequence will always return a logical unit.
4836 for (; t
< mock_input
; t
++)
4838 echo_char (keybuf
[t
]);
4839 add_command_key (keybuf
[t
]);
4845 #if 0 /* This doc string is too long for some compilers.
4846 This commented-out definition serves for DOC. */
4847 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4848 "Read a sequence of keystrokes and return as a string or vector.\n\
4849 The sequence is sufficient to specify a non-prefix command in the\n\
4850 current local and global maps.\n\
4852 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
4853 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
4854 as a continuation of the previous key.\n\
4856 A C-g typed while in this function is treated like any other character,\n\
4857 and `quit-flag' is not set.\n\
4859 If the key sequence starts with a mouse click, then the sequence is read\n\
4860 using the keymaps of the buffer of the window clicked in, not the buffer\n\
4861 of the selected window as normal.\n\
4863 `read-key-sequence' drops unbound button-down events, since you normally\n\
4864 only care about the click or drag events which follow them. If a drag\n\
4865 or multi-click event is unbound, but the corresponding click event would\n\
4866 be bound, `read-key-sequence' turns the event into a click event at the\n\
4867 drag's starting position. This means that you don't have to distinguish\n\
4868 between click and drag, double, or triple events unless you want to.\n\
4870 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
4871 lines separating windows, and scroll bars with imaginary keys\n\
4872 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
4874 If the user switches frames in the middle of a key sequence, the\n\
4875 frame-switch event is put off until after the current key sequence.\n\
4877 `read-key-sequence' checks `function-key-map' for function key\n\
4878 sequences, where they wouldn't conflict with ordinary bindings. See\n\
4879 `function-key-map' for more details.")
4880 (prompt
, continue_echo
)
4883 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4885 (prompt
, continue_echo
)
4886 Lisp_Object prompt
, continue_echo
;
4888 Lisp_Object keybuf
[30];
4890 struct gcpro gcpro1
, gcpro2
;
4893 CHECK_STRING (prompt
, 0);
4896 bzero (keybuf
, sizeof keybuf
);
4898 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
4900 if (NILP (continue_echo
))
4901 this_command_key_count
= 0;
4903 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])), prompt
);
4911 return make_event_array (i
, keybuf
);
4914 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
4915 "Execute CMD as an editor command.\n\
4916 CMD must be a symbol that satisfies the `commandp' predicate.\n\
4917 Optional second arg RECORD-FLAG non-nil\n\
4918 means unconditionally put this command in `command-history'.\n\
4919 Otherwise, that is done only if an arg is read using the minibuffer.")
4921 Lisp_Object cmd
, record
;
4923 register Lisp_Object final
;
4924 register Lisp_Object tem
;
4925 Lisp_Object prefixarg
;
4926 struct backtrace backtrace
;
4927 extern int debug_on_next_call
;
4929 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
4930 Vcurrent_prefix_arg
= prefixarg
;
4931 debug_on_next_call
= 0;
4933 if (XTYPE (cmd
) == Lisp_Symbol
)
4935 tem
= Fget (cmd
, Qdisabled
);
4937 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
4942 final
= Findirect_function (cmd
);
4944 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
4945 do_autoload (final
, cmd
);
4950 if (XTYPE (final
) == Lisp_String
4951 || XTYPE (final
) == Lisp_Vector
)
4953 /* If requested, place the macro in the command history. For
4954 other sorts of commands, call-interactively takes care of
4958 = Fcons (Fcons (Qexecute_kbd_macro
,
4959 Fcons (final
, Fcons (prefixarg
, Qnil
))),
4962 return Fexecute_kbd_macro (final
, prefixarg
);
4964 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
4965 || XTYPE (final
) == Lisp_Compiled
)
4967 backtrace
.next
= backtrace_list
;
4968 backtrace_list
= &backtrace
;
4969 backtrace
.function
= &Qcall_interactively
;
4970 backtrace
.args
= &cmd
;
4971 backtrace
.nargs
= 1;
4972 backtrace
.evalargs
= 0;
4974 tem
= Fcall_interactively (cmd
, record
);
4976 backtrace_list
= backtrace
.next
;
4982 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
4984 "Read function name, then read its arguments and call it.")
4986 Lisp_Object prefixarg
;
4988 Lisp_Object function
;
4990 Lisp_Object saved_keys
;
4991 struct gcpro gcpro1
;
4993 saved_keys
= Fvector (this_command_key_count
,
4994 XVECTOR (this_command_keys
)->contents
);
4996 GCPRO1 (saved_keys
);
4998 if (EQ (prefixarg
, Qminus
))
5000 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
5001 strcpy (buf
, "C-u ");
5002 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
5003 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
5004 else if (XTYPE (prefixarg
) == Lisp_Int
)
5005 sprintf (buf
, "%d ", XINT (prefixarg
));
5007 /* This isn't strictly correct if execute-extended-command
5008 is bound to anything else. Perhaps it should use
5009 this_command_keys? */
5010 strcat (buf
, "M-x ");
5012 /* Prompt with buf, and then read a string, completing from and
5013 restricting to the set of all defined commands. Don't provide
5014 any initial input. Save the command read on the extended-command
5016 function
= Fcompleting_read (build_string (buf
),
5017 Vobarray
, Qcommandp
,
5018 Qt
, Qnil
, Qextended_command_history
);
5020 /* Set this_command_keys to the concatenation of saved_keys and
5021 function, followed by a RET. */
5023 struct Lisp_String
*str
;
5028 this_command_key_count
= 0;
5030 keys
= XVECTOR (saved_keys
)->contents
;
5031 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
5032 add_command_key (keys
[i
]);
5034 str
= XSTRING (function
);
5035 for (i
= 0; i
< str
->size
; i
++)
5037 XFASTINT (tem
) = str
->data
[i
];
5038 add_command_key (tem
);
5041 XFASTINT (tem
) = '\015';
5042 add_command_key (tem
);
5047 function
= Fintern (function
, Qnil
);
5048 Vprefix_arg
= prefixarg
;
5049 this_command
= function
;
5051 return Fcommand_execute (function
, Qt
);
5055 detect_input_pending ()
5058 get_input_pending (&input_pending
);
5060 return input_pending
;
5063 /* This is called in some cases before a possible quit.
5064 It cases the next call to detect_input_pending to recompute input_pending.
5065 So calling this function unnecessarily can't do any harm. */
5066 clear_input_pending ()
5071 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
5072 "T if command input is currently available with no waiting.\n\
5073 Actually, the value is nil only if we can be sure that no input is available.")
5076 if (!NILP (unread_command_events
) || unread_command_char
!= -1)
5079 return detect_input_pending () ? Qt
: Qnil
;
5082 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
5083 "Return vector of last 100 events, not counting those from keyboard macros.")
5086 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
5089 if (total_keys
< NUM_RECENT_KEYS
)
5090 return Fvector (total_keys
, keys
);
5093 val
= Fvector (NUM_RECENT_KEYS
, keys
);
5094 bcopy (keys
+ recent_keys_index
,
5095 XVECTOR (val
)->contents
,
5096 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
5098 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
5099 recent_keys_index
* sizeof (Lisp_Object
));
5104 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
5105 "Return the key sequence that invoked this command.\n\
5106 The value is a string or a vector.")
5109 return make_event_array (this_command_key_count
,
5110 XVECTOR (this_command_keys
)->contents
);
5113 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
5114 "Return the current depth in recursive edits.")
5118 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
5122 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
5123 "FOpen dribble file: ",
5124 "Start writing all keyboard characters to a dribble file called FILE.\n\
5125 If FILE is nil, close any open dribble file.")
5136 file
= Fexpand_file_name (file
, Qnil
);
5137 dribble
= fopen (XSTRING (file
)->data
, "w");
5142 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
5143 "Discard the contents of the terminal input buffer.\n\
5144 Also cancel any kbd macro being defined.")
5147 defining_kbd_macro
= 0;
5148 update_mode_lines
++;
5150 unread_command_events
= Qnil
;
5151 unread_command_char
= -1;
5153 discard_tty_input ();
5155 /* Without the cast, GCC complains that this assignment loses the
5156 volatile qualifier of kbd_store_ptr. Is there anything wrong
5158 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
5159 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5165 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
5166 "Stop Emacs and return to superior process. You can resume later.\n\
5167 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
5168 control, run a subshell instead.\n\n\
5169 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
5170 to be read as terminal input by Emacs's parent, after suspension.\n\
5172 Before suspending, call the functions in `suspend-hook' with no args.\n\
5173 If any of them returns nil, don't call the rest and don't suspend.\n\
5174 Otherwise, suspend normally and after resumption run the normal hook\n\
5175 `suspend-resume-hook' if that is bound and non-nil.\n\
5177 Some operating systems cannot stop the Emacs process and resume it later.\n\
5178 On such systems, Emacs starts a subshell instead of suspending.")
5180 Lisp_Object stuffstring
;
5183 int count
= specpdl_ptr
- specpdl
;
5184 int old_height
, old_width
;
5186 struct gcpro gcpro1
, gcpro2
;
5187 extern init_sys_modes ();
5189 if (!NILP (stuffstring
))
5190 CHECK_STRING (stuffstring
, 0);
5192 /* Run the functions in suspend-hook. */
5193 if (!NILP (Vrun_hooks
))
5194 call1 (Vrun_hooks
, intern ("suspend-hook"));
5196 GCPRO1 (stuffstring
);
5197 get_frame_size (&old_width
, &old_height
);
5199 /* sys_suspend can get an error if it tries to fork a subshell
5200 and the system resources aren't available for that. */
5201 record_unwind_protect (init_sys_modes
, 0);
5202 stuff_buffered_input (stuffstring
);
5207 unbind_to (count
, Qnil
);
5209 /* Check if terminal/window size has changed.
5210 Note that this is not useful when we are running directly
5211 with a window system; but suspend should be disabled in that case. */
5212 get_frame_size (&width
, &height
);
5213 if (width
!= old_width
|| height
!= old_height
)
5214 change_frame_size (selected_frame
, height
, width
, 0, 0);
5216 /* Run suspend-resume-hook. */
5217 if (!NILP (Vrun_hooks
))
5218 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
5224 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
5225 Then in any case stuff anything Emacs has read ahead and not used. */
5227 stuff_buffered_input (stuffstring
)
5228 Lisp_Object stuffstring
;
5230 register unsigned char *p
;
5232 /* stuff_char works only in BSD, versions 4.2 and up. */
5235 if (XTYPE (stuffstring
) == Lisp_String
)
5239 p
= XSTRING (stuffstring
)->data
;
5240 count
= XSTRING (stuffstring
)->size
;
5245 /* Anything we have read ahead, put back for the shell to read. */
5246 while (kbd_fetch_ptr
!= kbd_store_ptr
)
5248 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
5249 kbd_fetch_ptr
= kbd_buffer
;
5250 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
5251 stuff_char (kbd_fetch_ptr
->code
);
5252 kbd_fetch_ptr
->kind
= no_event
;
5253 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
5260 #endif /* BSD and not BSD4_1 */
5263 set_waiting_for_input (time_to_clear
)
5264 EMACS_TIME
*time_to_clear
;
5266 input_available_clear_time
= time_to_clear
;
5268 /* Tell interrupt_signal to throw back to read_char, */
5269 waiting_for_input
= 1;
5271 /* If interrupt_signal was called before and buffered a C-g,
5272 make it run again now, to avoid timing error. */
5273 if (!NILP (Vquit_flag
))
5274 quit_throw_to_read_char ();
5277 clear_waiting_for_input ()
5279 /* Tell interrupt_signal not to throw back to read_char, */
5280 waiting_for_input
= 0;
5281 input_available_clear_time
= 0;
5284 /* This routine is called at interrupt level in response to C-G.
5285 If interrupt_input, this is the handler for SIGINT.
5286 Otherwise, it is called from kbd_buffer_store_event,
5287 in handling SIGIO or SIGTINT.
5289 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
5290 immediately throw back to read_char.
5292 Otherwise it sets the Lisp variable quit-flag not-nil.
5293 This causes eval to throw, when it gets a chance.
5294 If quit-flag is already non-nil, it stops the job right away. */
5300 /* Must preserve main program's value of errno. */
5301 int old_errno
= errno
;
5304 /* USG systems forget handlers when they are used;
5305 must reestablish each time */
5306 signal (SIGINT
, interrupt_signal
);
5307 signal (SIGQUIT
, interrupt_signal
);
5312 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
5317 #ifdef SIGTSTP /* Support possible in later USG versions */
5319 * On systems which can suspend the current process and return to the original
5320 * shell, this command causes the user to end up back at the shell.
5321 * The "Auto-save" and "Abort" questions are not asked until
5322 * the user elects to return to emacs, at which point he can save the current
5323 * job and either dump core or continue.
5328 if (sys_suspend () == -1)
5330 printf ("Not running as a subprocess;\n");
5331 printf ("you can continue or abort.\n");
5334 /* Perhaps should really fork an inferior shell?
5335 But that would not provide any way to get back
5336 to the original shell, ever. */
5337 printf ("No support for stopping a process on this operating system;\n");
5338 printf ("you can continue or abort.\n");
5339 #endif /* not VMS */
5340 #endif /* not SIGTSTP */
5342 /* We must remain inside the screen area when the internal terminal
5343 is used. Note that [Enter] is not echoed by dos. */
5346 printf ("Auto-save? (y or n) ");
5348 if (((c
= getchar ()) & ~040) == 'Y')
5350 Fdo_auto_save (Qt
, Qnil
);
5352 printf ("\r\nAuto-save done");
5353 #else /* not MSDOS */
5354 printf ("Auto-save done\n");
5355 #endif /* not MSDOS */
5357 while (c
!= '\n') c
= getchar ();
5359 printf ("\r\nAbort? (y or n) ");
5360 #else /* not MSDOS */
5362 printf ("Abort (and enter debugger)? (y or n) ");
5364 printf ("Abort (and dump core)? (y or n) ");
5365 #endif /* not VMS */
5366 #endif /* not MSDOS */
5368 if (((c
= getchar ()) & ~040) == 'Y')
5370 while (c
!= '\n') c
= getchar ();
5372 printf ("\r\nContinuing...\r\n");
5373 #else /* not MSDOS */
5374 printf ("Continuing...\n");
5375 #endif /* not MSDOS */
5381 /* If executing a function that wants to be interrupted out of
5382 and the user has not deferred quitting by binding `inhibit-quit'
5383 then quit right away. */
5384 if (immediate_quit
&& NILP (Vinhibit_quit
))
5388 Fsignal (Qquit
, Qnil
);
5391 /* Else request quit when it's safe */
5395 if (waiting_for_input
&& !echoing
)
5396 quit_throw_to_read_char ();
5401 /* Handle a C-g by making read_char return C-g. */
5403 quit_throw_to_read_char ()
5405 quit_error_check ();
5407 /* Prevent another signal from doing this before we finish. */
5408 clear_waiting_for_input ();
5411 unread_command_events
= Qnil
;
5412 unread_command_char
= -1;
5414 #ifdef POLL_FOR_INPUT
5415 /* May be > 1 if in recursive minibuffer. */
5416 if (poll_suppress_count
== 0)
5420 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
5421 && XFRAME (internal_last_event_frame
) != selected_frame
)
5422 Fhandle_switch_frame (make_lispy_switch_frame (internal_last_event_frame
));
5425 _longjmp (getcjmp
, 1);
5428 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
5429 "Set mode of reading keyboard input.\n\
5430 First arg INTERRUPT non-nil means use input interrupts;\n\
5431 nil means use CBREAK mode.\n\
5432 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
5433 (no effect except in CBREAK mode).\n\
5434 Third arg META t means accept 8-bit input (for a Meta key).\n\
5435 META nil means ignore the top bit, on the assumption it is parity.\n\
5436 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
5437 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
5438 See also `current-input-mode'.")
5439 (interrupt
, flow
, meta
, quit
)
5440 Lisp_Object interrupt
, flow
, meta
, quit
;
5443 && (XTYPE (quit
) != Lisp_Int
5444 || XINT (quit
) < 0 || XINT (quit
) > 0400))
5445 error ("set-input-mode: QUIT must be an ASCII character");
5447 #ifdef POLL_FOR_INPUT
5453 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5454 #ifdef NO_SOCK_SIGIO
5455 if (read_socket_hook
)
5456 interrupt_input
= 0; /* No interrupts if reading from a socket. */
5458 #endif /* NO_SOCK_SIGIO */
5459 interrupt_input
= !NILP (interrupt
);
5460 #else /* not SIGIO */
5461 interrupt_input
= 0;
5462 #endif /* not SIGIO */
5463 /* Our VMS input only works by interrupts, as of now. */
5465 interrupt_input
= 1;
5467 flow_control
= !NILP (flow
);
5470 else if (EQ (meta
, Qt
))
5475 /* Don't let this value be out of range. */
5476 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
5480 #ifdef POLL_FOR_INPUT
5481 poll_suppress_count
= 1;
5487 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
5488 "Return information about the way Emacs currently reads keyboard input.\n\
5489 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
5490 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
5491 nil, Emacs is using CBREAK mode.\n\
5492 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
5493 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
5494 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
5495 META nil means ignoring the top bit, on the assumption it is parity.\n\
5496 META is neither t nor nil if accepting 8-bit input and using\n\
5497 all 8 bits as the character code.\n\
5498 QUIT is the character Emacs currently uses to quit.\n\
5499 The elements of this list correspond to the arguments of\n\
5505 val
[0] = interrupt_input
? Qt
: Qnil
;
5506 val
[1] = flow_control
? Qt
: Qnil
;
5507 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
5508 XFASTINT (val
[3]) = quit_char
;
5510 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
5516 /* This is correct before outermost invocation of the editor loop */
5517 command_loop_level
= -1;
5519 quit_char
= Ctl ('g');
5520 unread_command_events
= Qnil
;
5521 unread_command_char
= -1;
5523 recent_keys_index
= 0;
5524 kbd_fetch_ptr
= kbd_buffer
;
5525 kbd_store_ptr
= kbd_buffer
;
5526 do_mouse_tracking
= 0;
5530 /* This means that command_loop_1 won't try to select anything the first
5532 internal_last_event_frame
= Qnil
;
5533 Vlast_event_frame
= internal_last_event_frame
;
5536 /* If we're running a dumped Emacs, we need to clear out
5537 kbd_buffer_frame_or_window, in case some events got into it
5540 If we're running an undumped Emacs, it hasn't been initialized by
5541 syms_of_keyboard yet. */
5543 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5545 if (!noninteractive
)
5547 signal (SIGINT
, interrupt_signal
);
5548 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
5549 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
5550 SIGQUIT and we can't tell which one it will give us. */
5551 signal (SIGQUIT
, interrupt_signal
);
5552 #endif /* HAVE_TERMIO */
5553 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5555 signal (SIGIO
, input_available_signal
);
5559 /* Use interrupt input by default, if it works and noninterrupt input
5560 has deficiencies. */
5562 #ifdef INTERRUPT_INPUT
5563 interrupt_input
= 1;
5565 interrupt_input
= 0;
5568 /* Our VMS input only works by interrupts, as of now. */
5570 interrupt_input
= 1;
5576 if (keyboard_init_hook
)
5577 (*keyboard_init_hook
) ();
5579 #ifdef POLL_FOR_INPUT
5580 poll_suppress_count
= 1;
5585 /* This type's only use is in syms_of_keyboard, to initialize the
5586 event header symbols and put properties on them. */
5593 struct event_head head_table
[] = {
5594 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
5595 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
5596 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
5601 Qdisabled_command_hook
= intern ("disabled-command-hook");
5602 staticpro (&Qdisabled_command_hook
);
5604 Qself_insert_command
= intern ("self-insert-command");
5605 staticpro (&Qself_insert_command
);
5607 Qforward_char
= intern ("forward-char");
5608 staticpro (&Qforward_char
);
5610 Qbackward_char
= intern ("backward-char");
5611 staticpro (&Qbackward_char
);
5613 Qdisabled
= intern ("disabled");
5614 staticpro (&Qdisabled
);
5616 Qundefined
= intern ("undefined");
5617 staticpro (&Qundefined
);
5619 Qpre_command_hook
= intern ("pre-command-hook");
5620 staticpro (&Qpre_command_hook
);
5622 Qpost_command_hook
= intern ("post-command-hook");
5623 staticpro (&Qpost_command_hook
);
5625 Qcommand_hook_internal
= intern ("command-hook-internal");
5626 staticpro (&Qcommand_hook_internal
);
5628 Qfunction_key
= intern ("function-key");
5629 staticpro (&Qfunction_key
);
5630 Qmouse_click
= intern ("mouse-click");
5631 staticpro (&Qmouse_click
);
5633 Qmenu_enable
= intern ("menu-enable");
5634 staticpro (&Qmenu_enable
);
5636 Qmode_line
= intern ("mode-line");
5637 staticpro (&Qmode_line
);
5638 Qvertical_line
= intern ("vertical-line");
5639 staticpro (&Qvertical_line
);
5640 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
5641 staticpro (&Qvertical_scroll_bar
);
5642 Qmenu_bar
= intern ("menu-bar");
5643 staticpro (&Qmenu_bar
);
5645 Qabove_handle
= intern ("above-handle");
5646 staticpro (&Qabove_handle
);
5647 Qhandle
= intern ("handle");
5648 staticpro (&Qhandle
);
5649 Qbelow_handle
= intern ("below-handle");
5650 staticpro (&Qbelow_handle
);
5652 Qevent_kind
= intern ("event-kind");
5653 staticpro (&Qevent_kind
);
5654 Qevent_symbol_elements
= intern ("event-symbol-elements");
5655 staticpro (&Qevent_symbol_elements
);
5656 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
5657 staticpro (&Qevent_symbol_element_mask
);
5658 Qmodifier_cache
= intern ("modifier-cache");
5659 staticpro (&Qmodifier_cache
);
5661 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
5662 staticpro (&Qrecompute_lucid_menubar
);
5663 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
5664 staticpro (&Qactivate_menubar_hook
);
5667 struct event_head
*p
;
5669 for (p
= head_table
;
5670 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
5673 *p
->var
= intern (p
->name
);
5675 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
5676 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
5680 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
5681 staticpro (&button_down_location
);
5685 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
5687 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
5688 for (i
= 0; i
< len
; i
++)
5689 if (modifier_names
[i
])
5690 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
5691 staticpro (&modifier_symbols
);
5694 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
5695 staticpro (&recent_keys
);
5697 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
5698 staticpro (&this_command_keys
);
5700 Qextended_command_history
= intern ("extended-command-history");
5701 Fset (Qextended_command_history
, Qnil
);
5702 staticpro (&Qextended_command_history
);
5704 kbd_buffer_frame_or_window
5705 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
5706 staticpro (&kbd_buffer_frame_or_window
);
5708 func_key_syms
= Qnil
;
5709 staticpro (&func_key_syms
);
5712 staticpro (&mouse_syms
);
5714 unread_switch_frame
= Qnil
;
5715 staticpro (&unread_switch_frame
);
5717 defsubr (&Sread_key_sequence
);
5718 defsubr (&Srecursive_edit
);
5719 defsubr (&Strack_mouse
);
5720 defsubr (&Sinput_pending_p
);
5721 defsubr (&Scommand_execute
);
5722 defsubr (&Srecent_keys
);
5723 defsubr (&Sthis_command_keys
);
5724 defsubr (&Ssuspend_emacs
);
5725 defsubr (&Sabort_recursive_edit
);
5726 defsubr (&Sexit_recursive_edit
);
5727 defsubr (&Srecursion_depth
);
5728 defsubr (&Stop_level
);
5729 defsubr (&Sdiscard_input
);
5730 defsubr (&Sopen_dribble_file
);
5731 defsubr (&Sset_input_mode
);
5732 defsubr (&Scurrent_input_mode
);
5733 defsubr (&Sexecute_extended_command
);
5735 DEFVAR_LISP ("last-command-char", &last_command_char
,
5736 "Last input event that was part of a command.");
5738 DEFVAR_LISP ("last-command-event", &last_command_char
,
5739 "Last input event that was part of a command.");
5741 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
5742 "Last input event in a command, except for mouse menu events.\n\
5743 Mouse menus give back keys that don't look like mouse events;\n\
5744 this variable holds the actual mouse event that led to the menu,\n\
5745 so that you can determine whether the command was run by mouse or not.");
5747 DEFVAR_LISP ("last-input-char", &last_input_char
,
5748 "Last input event.");
5750 DEFVAR_LISP ("last-input-event", &last_input_char
,
5751 "Last input event.");
5753 DEFVAR_LISP ("unread-command-events", &unread_command_events
,
5754 "List of objects to be read as next command input events.");
5756 DEFVAR_INT ("unread-command-char", &unread_command_char
,
5757 "If not -1, an object to be read as next command input event.");
5759 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
5760 "Meta-prefix character code. Meta-foo as command input\n\
5761 turns into this character followed by foo.");
5762 XSET (meta_prefix_char
, Lisp_Int
, 033);
5764 DEFVAR_LISP ("last-command", &last_command
,
5765 "The last command executed. Normally a symbol with a function definition,\n\
5766 but can be whatever was found in the keymap, or whatever the variable\n\
5767 `this-command' was set to by that command.");
5768 last_command
= Qnil
;
5770 DEFVAR_LISP ("this-command", &this_command
,
5771 "The command now being executed.\n\
5772 The command can set this variable; whatever is put here\n\
5773 will be in `last-command' during the following command.");
5774 this_command
= Qnil
;
5776 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
5777 "*Number of keyboard input characters between auto-saves.\n\
5778 Zero means disable autosaving due to number of characters typed.");
5779 auto_save_interval
= 300;
5781 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
5782 "*Number of seconds idle time before auto-save.\n\
5783 Zero or nil means disable auto-saving due to idleness.\n\
5784 After auto-saving due to this many seconds of idle time,\n\
5785 Emacs also does a garbage collection if that seems to be warranted.");
5786 XFASTINT (Vauto_save_timeout
) = 30;
5788 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
5789 "*Nonzero means echo unfinished commands after this many seconds of pause.");
5790 echo_keystrokes
= 1;
5792 DEFVAR_INT ("polling-period", &polling_period
,
5793 "*Interval between polling for input during Lisp execution.\n\
5794 The reason for polling is to make C-g work to stop a running program.\n\
5795 Polling is needed only when using X windows and SIGIO does not work.\n\
5796 Polling is automatically disabled in all other cases.");
5799 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
5800 "*Maximum time between mouse clicks to make a double-click.\n\
5801 Measured in milliseconds. nil means disable double-click recognition;\n\
5802 t means double-clicks have no time limit and are detected\n\
5803 by position only.");
5804 Vdouble_click_time
= make_number (500);
5806 DEFVAR_INT ("num-input-keys", &num_input_keys
,
5807 "*Number of complete keys read from the keyboard so far.");
5811 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
5812 "*The frame in which the most recently read event occurred.\n\
5813 If the last event came from a keyboard macro, this is set to `macro'.");
5814 Vlast_event_frame
= Qnil
;
5817 DEFVAR_LISP ("help-char", &Vhelp_char
,
5818 "Character to recognize as meaning Help.\n\
5819 When it is read, do `(eval help-form)', and display result if it's a string.\n\
5820 If the value of `help-form' is nil, this char can be read normally.");
5821 XSET (Vhelp_char
, Lisp_Int
, Ctl ('H'));
5823 DEFVAR_LISP ("help-form", &Vhelp_form
,
5824 "Form to execute when character `help-char' is read.\n\
5825 If the form returns a string, that string is displayed.\n\
5826 If `help-form' is nil, the help char is not recognized.");
5829 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
5830 "Command to run when `help-char' character follows a prefix key.\n\
5831 This command is used only when there is no actual binding\n\
5832 for that character after that prefix key.");
5833 Vprefix_help_command
= Qnil
;
5835 DEFVAR_LISP ("top-level", &Vtop_level
,
5836 "Form to evaluate when Emacs starts up.\n\
5837 Useful to set before you dump a modified Emacs.");
5840 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
5841 "String used as translate table for keyboard input, or nil.\n\
5842 Each character is looked up in this string and the contents used instead.\n\
5843 If string is of length N, character codes N and up are untranslated.");
5844 Vkeyboard_translate_table
= Qnil
;
5846 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
5847 "Keymap of key translations that can override keymaps.\n\
5848 This keymap works like `function-key-map', but comes after that,\n\
5849 and applies even for keys that have ordinary bindings.");
5850 Vkey_translation_map
= Qnil
;
5852 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
5853 "Non-nil means to always spawn a subshell instead of suspending,\n\
5854 even if the operating system has support for stopping a process.");
5857 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
5858 "Non-nil means prompt with menus when appropriate.\n\
5859 This is done when reading from a keymap that has a prompt string,\n\
5860 for elements that have prompt strings.\n\
5861 The menu is displayed on the screen\n\
5862 if X menus were enabled at configuration\n\
5863 time and the previous event was a mouse click prefix key.\n\
5864 Otherwise, menu prompting uses the echo area.");
5867 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
5868 "Character to see next line of menu prompt.\n\
5869 Type this character while in a menu prompt to rotate around the lines of it.");
5870 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
5872 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
5873 "A mask of additional modifier keys to use with every keyboard character.\n\
5874 Emacs applies the modifiers of the character stored here to each keyboard\n\
5875 character it reads. For example, after evaluating the expression\n\
5876 (setq extra-keyboard-modifiers ?\C-x)\n\
5877 all input characters will have the control modifier applied to them.\n\
5879 Note that the character ?\C-@, equivalent to the integer zero, does\n\
5880 not count as a control character; rather, it counts as a character\n\
5881 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
5882 cancels any modification.");
5883 extra_keyboard_modifiers
= 0;
5885 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
5886 "If an editing command sets this to t, deactivate the mark afterward.\n\
5887 The command loop sets this to nil before each command,\n\
5888 and tests the value when the command returns.\n\
5889 Buffer modification stores t in this variable.");
5890 Vdeactivate_mark
= Qnil
;
5892 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
5893 "Temporary storage of pre-command-hook or post-command-hook.");
5894 Vcommand_hook_internal
= Qnil
;
5896 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
5897 "Normal hook run before each command is executed.");
5898 Vpre_command_hook
= Qnil
;
5900 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
5901 "Normal hook run after each command is executed.");
5902 Vpost_command_hook
= Qnil
;
5904 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
5905 "t means menu bar, specified Lucid style, needs to be recomputed.");
5906 Vlucid_menu_bar_dirty_flag
= Qnil
;
5908 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
5909 "List of menu bar items to move to the end of the menu bar.\n\
5910 The elements of the list are event types that may have menu bar bindings.");
5911 Vmenu_bar_final_items
= Qnil
;
5913 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
5914 "Keymap that overrides all other local keymaps.\n\
5915 If this variable is non-nil, it is used as a keymap instead of the\n\
5916 buffer's local map, and the minor mode keymaps and text property keymaps.");
5917 Voverriding_local_map
= Qnil
;
5919 DEFVAR_BOOL ("track-mouse", &do_mouse_tracking
,
5920 "*Non-nil means generate motion events for mouse motion.");
5922 DEFVAR_LISP ("system-key-alist", &Vsystem_key_alist
,
5923 "Alist of system-specific X windows key symbols.\n\
5924 Each element should have the form (N . SYMBOL) where N is the\n\
5925 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
5926 and SYMBOL is its name.");
5927 Vmenu_bar_final_items
= Qnil
;
5932 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
5933 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
5934 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
5935 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
5936 initial_define_key (meta_map
, 'x', "execute-extended-command");