1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94 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"
55 /* This is to get the definitions of the XK_ symbols. */
60 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
65 /* Variables for blockinput.h: */
67 /* Non-zero if interrupt input is blocked right now. */
68 int interrupt_input_blocked
;
70 /* Nonzero means an input interrupt has arrived
71 during the current critical section. */
72 int interrupt_input_pending
;
76 extern Lisp_Object Vmouse_grabbed
;
78 /* Make all keyboard buffers much bigger when using X windows. */
79 #define KBD_BUFFER_SIZE 4096
80 #else /* No X-windows, character input */
81 #define KBD_BUFFER_SIZE 256
82 #endif /* No X-windows */
84 /* Following definition copied from eval.c */
88 struct backtrace
*next
;
89 Lisp_Object
*function
;
90 Lisp_Object
*args
; /* Points to vector of args. */
91 int nargs
; /* length of vector. If nargs is UNEVALLED,
92 args points to slot holding list of
97 /* Non-nil disable property on a command means
98 do not execute it; call disabled-command-hook's value instead. */
99 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
101 #define NUM_RECENT_KEYS (100)
102 int recent_keys_index
; /* Index for storing next element into recent_keys */
103 int total_keys
; /* Total number of elements stored into recent_keys */
104 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
106 /* Vector holding the key sequence that invoked the current command.
107 It is reused for each command, and it may be longer than the current
108 sequence; this_command_key_count indicates how many elements
109 actually mean something.
110 It's easier to staticpro a single Lisp_Object than an array. */
111 Lisp_Object this_command_keys
;
112 int this_command_key_count
;
114 extern int minbuf_level
;
116 extern struct backtrace
*backtrace_list
;
118 /* Nonzero means do menu prompting. */
119 static int menu_prompting
;
121 /* Character to see next line of menu prompt. */
122 static Lisp_Object menu_prompt_more_char
;
124 /* For longjmp to where kbd input is being done. */
125 static jmp_buf getcjmp
;
127 /* True while doing kbd input. */
128 int waiting_for_input
;
130 /* True while displaying for echoing. Delays C-g throwing. */
133 /* Nonzero means C-g should cause immediate error-signal. */
136 /* Character to recognize as the help char. */
137 Lisp_Object Vhelp_char
;
139 /* Form to execute when help char is typed. */
140 Lisp_Object Vhelp_form
;
142 /* Command to run when the help character follows a prefix key. */
143 Lisp_Object Vprefix_help_command
;
145 /* List of items that should move to the end of the menu bar. */
146 Lisp_Object Vmenu_bar_final_items
;
148 /* Character that causes a quit. Normally C-g.
150 If we are running on an ordinary terminal, this must be an ordinary
151 ASCII char, since we want to make it our interrupt character.
153 If we are not running on an ordinary terminal, it still needs to be
154 an ordinary ASCII char. This character needs to be recognized in
155 the input interrupt handler. At this point, the keystroke is
156 represented as a struct input_event, while the desired quit
157 character is specified as a lispy event. The mapping from struct
158 input_events to lispy events cannot run in an interrupt handler,
159 and the reverse mapping is difficult for anything but ASCII
162 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
166 extern Lisp_Object current_global_map
;
167 extern int minibuf_level
;
169 /* If non-nil, this is a map that overrides all other local maps. */
170 Lisp_Object Voverriding_local_map
;
172 /* Current depth in recursive edits. */
173 int command_loop_level
;
175 /* Total number of times command_loop has read a key sequence. */
178 /* Last input character read as a command. */
179 Lisp_Object last_command_char
;
181 /* Last input character read as a command, not counting menus
182 reached by the mouse. */
183 Lisp_Object last_nonmenu_event
;
185 /* Last input character read for any purpose. */
186 Lisp_Object last_input_char
;
188 /* If not Qnil, a list of objects to be read as subsequent command input. */
189 Lisp_Object Vunread_command_events
;
191 /* If not -1, an event to be read as subsequent command input. */
192 int unread_command_char
;
194 /* If not Qnil, this is a switch-frame event which we decided to put
195 off until the end of a key sequence. This should be read as the
196 next command input, after any unread_command_events.
198 read_key_sequence uses this to delay switch-frame events until the
199 end of the key sequence; Fread_char uses it to put off switch-frame
200 events until a non-ASCII event is acceptable as input. */
201 Lisp_Object unread_switch_frame
;
203 /* A mask of extra modifier bits to put into every keyboard char. */
204 int extra_keyboard_modifiers
;
206 /* Char to use as prefix when a meta character is typed in.
207 This is bound on entry to minibuffer in case ESC is changed there. */
209 Lisp_Object meta_prefix_char
;
211 /* Last size recorded for a current buffer which is not a minibuffer. */
212 static int last_non_minibuf_size
;
214 /* Number of idle seconds before an auto-save and garbage collection. */
215 static Lisp_Object Vauto_save_timeout
;
217 /* Total number of times read_char has returned. */
220 /* Total number of times read_char has returned, outside of macros. */
221 int num_nonmacro_input_chars
;
223 /* Auto-save automatically when this many characters have been typed
224 since the last time. */
226 static int auto_save_interval
;
228 /* Value of num_nonmacro_input_chars as of last auto save. */
232 /* Last command executed by the editor command loop, not counting
233 commands that set the prefix argument. */
235 Lisp_Object last_command
;
237 /* The command being executed by the command loop.
238 Commands may set this, and the value set will be copied into last_command
239 instead of the actual command. */
240 Lisp_Object this_command
;
242 /* The value of point when the last command was executed. */
243 int last_point_position
;
245 /* The buffer that was current when the last command was started. */
246 Lisp_Object last_point_position_buffer
;
249 /* The frame in which the last input event occurred, or Qmacro if the
250 last event came from a macro. We use this to determine when to
251 generate switch-frame events. This may be cleared by functions
252 like Fselect_frame, to make sure that a switch-frame event is
253 generated by the next character. */
254 Lisp_Object internal_last_event_frame
;
257 /* A user-visible version of the above, intended to allow users to
258 figure out where the last event came from, if the event doesn't
259 carry that information itself (i.e. if it was a character). */
260 Lisp_Object Vlast_event_frame
;
262 /* The timestamp of the last input event we received from the X server.
263 X Windows wants this for selection ownership. */
264 unsigned long last_event_timestamp
;
266 Lisp_Object Qself_insert_command
;
267 Lisp_Object Qforward_char
;
268 Lisp_Object Qbackward_char
;
269 Lisp_Object Qundefined
;
271 /* read_key_sequence stores here the command definition of the
272 key sequence that it reads. */
273 Lisp_Object read_key_sequence_cmd
;
275 /* Form to evaluate (if non-nil) when Emacs is started. */
276 Lisp_Object Vtop_level
;
278 /* User-supplied string to translate input characters through. */
279 Lisp_Object Vkeyboard_translate_table
;
281 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
282 extern Lisp_Object Vfunction_key_map
;
284 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
285 Lisp_Object Vkey_translation_map
;
287 /* Non-nil means deactivate the mark at end of this command. */
288 Lisp_Object Vdeactivate_mark
;
290 /* Menu bar specified in Lucid Emacs fashion. */
292 Lisp_Object Vlucid_menu_bar_dirty_flag
;
293 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
295 /* Hooks to run before and after each command. */
296 Lisp_Object Qpre_command_hook
, Qpost_command_hook
;
297 Lisp_Object Vpre_command_hook
, Vpost_command_hook
;
298 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
300 /* File in which we write all commands we read. */
303 /* Nonzero if input is available. */
306 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
307 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
311 extern char *pending_malloc_warning
;
313 /* Circular buffer for pre-read keyboard input. */
314 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
316 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
318 The interrupt-level event handlers will never enqueue an event on a
319 frame which is not in Vframe_list, and once an event is dequeued,
320 internal_last_event_frame or the event itself points to the frame.
323 But while the event is sitting in the queue, it's completely
324 unprotected. Suppose the user types one command which will run for
325 a while and then delete a frame, and then types another event at
326 the frame that will be deleted, before the command gets around to
327 it. Suppose there are no references to this frame elsewhere in
328 Emacs, and a GC occurs before the second event is dequeued. Now we
329 have an event referring to a freed frame, which will crash Emacs
332 Similar things happen when an event on a scroll bar is enqueued; the
333 window may be deleted while the event is in the queue.
335 So, we use this vector to protect the frame_or_window field in the
336 event queue. That way, they'll be dequeued as dead frames or
337 windows, but still valid lisp objects.
339 If kbd_buffer[i].kind != no_event, then
340 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
341 == kbd_buffer[i].frame_or_window. */
342 static Lisp_Object kbd_buffer_frame_or_window
;
344 /* Pointer to next available character in kbd_buffer.
345 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
346 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
347 next available char is in kbd_buffer[0]. */
348 static struct input_event
*kbd_fetch_ptr
;
350 /* Pointer to next place to store character in kbd_buffer. This
351 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
352 character should go in kbd_buffer[0]. */
356 static struct input_event
*kbd_store_ptr
;
358 /* The above pair of variables forms a "queue empty" flag. When we
359 enqueue a non-hook event, we increment kbd_write_count. When we
360 dequeue a non-hook event, we increment kbd_read_count. We say that
361 there is input available iff the two counters are not equal.
363 Why not just have a flag set and cleared by the enqueuing and
364 dequeuing functions? Such a flag could be screwed up by interrupts
365 at inopportune times. */
367 /* If this flag is non-zero, we check mouse_moved to see when the
368 mouse moves, and motion events will appear in the input stream. If
369 it is zero, mouse motion is ignored. */
370 static int do_mouse_tracking
;
372 /* The window system handling code should set this if the mouse has
373 moved since the last call to the mouse_position_hook. Calling that
374 hook should clear this. Code assumes that if this is set, it can
375 call mouse_position_hook to get the promised position, so don't set
376 it unless you're prepared to substantiate the claim! */
379 /* True iff there is an event in kbd_buffer, or if mouse tracking is
380 enabled and there is a new mouse position in the mouse movement
381 buffer. Note that if this is false, that doesn't mean that there
382 is readable input; all the events in the queue might be button-up
383 events, and do_mouse_tracking might be off. */
384 #define EVENT_QUEUES_EMPTY \
385 ((kbd_fetch_ptr == kbd_store_ptr) && (!do_mouse_tracking || !mouse_moved))
388 /* Symbols to head events. */
389 Lisp_Object Qmouse_movement
;
390 Lisp_Object Qscroll_bar_movement
;
391 Lisp_Object Qswitch_frame
;
393 /* Symbols to denote kinds of events. */
394 Lisp_Object Qfunction_key
;
395 Lisp_Object Qmouse_click
;
396 /* Lisp_Object Qmouse_movement; - also an event header */
398 /* Properties of event headers. */
399 Lisp_Object Qevent_kind
;
400 Lisp_Object Qevent_symbol_elements
;
402 Lisp_Object Qmenu_enable
;
404 /* An event header symbol HEAD may have a property named
405 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
406 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
407 mask of modifiers applied to it. If present, this is used to help
408 speed up parse_modifiers. */
409 Lisp_Object Qevent_symbol_element_mask
;
411 /* An unmodified event header BASE may have a property named
412 Qmodifier_cache, which is an alist mapping modifier masks onto
413 modified versions of BASE. If present, this helps speed up
415 Lisp_Object Qmodifier_cache
;
417 /* Symbols to use for parts of windows. */
418 Lisp_Object Qmode_line
;
419 Lisp_Object Qvertical_line
;
420 Lisp_Object Qvertical_scroll_bar
;
421 Lisp_Object Qmenu_bar
;
423 extern Lisp_Object Qmenu_enable
;
425 Lisp_Object
recursive_edit_unwind (), command_loop ();
426 Lisp_Object
Fthis_command_keys ();
427 Lisp_Object Qextended_command_history
;
429 Lisp_Object Qpolling_period
;
431 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
433 EMACS_TIME
*input_available_clear_time
;
435 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
436 Default is 1 if INTERRUPT_INPUT is defined. */
439 /* Nonzero while interrupts are temporarily deferred during redisplay. */
440 int interrupts_deferred
;
442 /* nonzero means use ^S/^Q for flow control. */
445 /* Allow m- file to inhibit use of FIONREAD. */
446 #ifdef BROKEN_FIONREAD
450 /* We are unable to use interrupts if FIONREAD is not available,
451 so flush SIGIO so we won't try. */
458 /* If we support X Windows, turn on the code to poll periodically
459 to detect C-g. It isn't actually used when doing interrupt input. */
460 #ifdef HAVE_X_WINDOWS
461 #define POLL_FOR_INPUT
464 /* Global variable declarations. */
466 /* Function for init_keyboard to call with no args (if nonzero). */
467 void (*keyboard_init_hook
) ();
469 static int read_avail_input ();
470 static void get_input_pending ();
471 static int readable_events ();
472 static Lisp_Object
read_char_x_menu_prompt ();
473 static Lisp_Object
read_char_minibuf_menu_prompt ();
474 static Lisp_Object
make_lispy_event ();
475 static Lisp_Object
make_lispy_movement ();
476 static Lisp_Object
modify_event_symbol ();
477 static Lisp_Object
make_lispy_switch_frame ();
479 /* > 0 if we are to echo keystrokes. */
480 static int echo_keystrokes
;
482 /* Nonzero means echo each character as typed. */
483 static int immediate_echo
;
485 /* The text we're echoing in the modeline - partial key sequences,
486 usually. '\0'-terminated. This really shouldn't have a fixed size. */
487 static char echobuf
[300];
489 /* Where to append more text to echobuf if we want to. */
490 static char *echoptr
;
492 /* If we have echoed a prompt string specified by the user,
493 this is its length. Otherwise this is -1. */
494 static int echo_after_prompt
;
496 /* Nonzero means don't try to suspend even if the operating system seems
498 static int cannot_suspend
;
500 #define min(a,b) ((a)<(b)?(a):(b))
501 #define max(a,b) ((a)>(b)?(a):(b))
503 /* Install the string STR as the beginning of the string of echoing,
504 so that it serves as a prompt for the next character.
505 Also start echoing. */
510 int len
= strlen (str
);
512 if (len
> sizeof echobuf
- 4)
513 len
= sizeof echobuf
- 4;
514 bcopy (str
, echobuf
, len
);
515 echoptr
= echobuf
+ len
;
518 echo_after_prompt
= len
;
523 /* Add C to the echo string, if echoing is going on.
524 C can be a character, which is printed prettily ("M-C-x" and all that
525 jazz), or a symbol, whose name is printed. */
530 extern char *push_key_description ();
539 /* If someone has passed us a composite event, use its head symbol. */
542 if (XTYPE (c
) == Lisp_Int
)
544 if (ptr
- echobuf
> sizeof echobuf
- 6)
547 ptr
= push_key_description (XINT (c
), ptr
);
549 else if (XTYPE (c
) == Lisp_Symbol
)
551 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
552 if (((ptr
- echobuf
) + name
->size
+ 4) > sizeof echobuf
)
554 bcopy (name
->data
, ptr
, name
->size
);
558 if (echoptr
== echobuf
&& EQ (c
, Vhelp_char
))
560 strcpy (ptr
, " (Type ? for further options)");
571 /* Temporarily add a dash to the end of the echo string if it's not
572 empty, so that it serves as a mini-prompt for the very next character. */
576 if (!immediate_echo
&& echoptr
== echobuf
)
578 /* Do nothing if we just printed a prompt. */
579 if (echo_after_prompt
!= echoptr
- echobuf
)
581 /* Do nothing if not echoing at all. */
585 /* Put a dash at the end of the buffer temporarily,
586 but make it go away when the next character is added. */
593 /* Display the current echo string, and begin echoing if not already
603 for (i
= 0; i
< this_command_key_count
; i
++)
606 c
= XVECTOR (this_command_keys
)->contents
[i
];
607 if (! (EVENT_HAS_PARAMETERS (c
)
608 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
618 if (waiting_for_input
&& !NILP (Vquit_flag
))
619 quit_throw_to_read_char ();
622 /* Turn off echoing, for the start of a new command. */
628 echo_after_prompt
= -1;
631 /* Return the length of the current echo string. */
636 return echoptr
- echobuf
;
639 /* Truncate the current echo message to its first LEN chars.
640 This and echo_char get used by read_key_sequence when the user
641 switches frames while entering a key sequence. */
648 echoptr
= echobuf
+ len
;
649 truncate_echo_area (len
);
653 /* Functions for manipulating this_command_keys. */
655 add_command_key (key
)
658 int size
= XVECTOR (this_command_keys
)->size
;
660 if (this_command_key_count
>= size
)
662 Lisp_Object new_keys
;
664 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
665 bcopy (XVECTOR (this_command_keys
)->contents
,
666 XVECTOR (new_keys
)->contents
,
667 size
* sizeof (Lisp_Object
));
669 this_command_keys
= new_keys
;
672 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
678 int count
= specpdl_ptr
- specpdl
;
681 if (command_loop_level
> 0)
683 specbind (Qstandard_output
, Qt
);
684 specbind (Qstandard_input
, Qt
);
687 val
= command_loop ();
689 Fsignal (Qquit
, Qnil
);
691 return unbind_to (count
, Qnil
);
694 /* When an auto-save happens, record the "time", and don't do again soon. */
698 last_auto_save
= num_nonmacro_input_chars
;
701 /* Make an auto save happen as soon as possible at command level. */
703 force_auto_save_soon ()
705 last_auto_save
= - auto_save_interval
- 1;
707 record_asynch_buffer_change ();
710 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
711 "Invoke the editor command loop recursively.\n\
712 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
713 that tells this function to return.\n\
714 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
715 This function is called by the editor initialization to begin editing.")
718 int count
= specpdl_ptr
- specpdl
;
721 command_loop_level
++;
722 update_mode_lines
= 1;
724 record_unwind_protect (recursive_edit_unwind
,
726 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
730 return unbind_to (count
, Qnil
);
734 recursive_edit_unwind (buffer
)
738 Fset_buffer (buffer
);
740 command_loop_level
--;
741 update_mode_lines
= 1;
749 Lisp_Object errmsg
, tail
, errname
, file_error
;
756 Vstandard_output
= Qt
;
757 Vstandard_input
= Qt
;
758 Vexecuting_macro
= Qnil
;
759 echo_area_glyphs
= 0;
761 /* If the window system or terminal frame hasn't been initialized
762 yet, or we're not interactive, it's best to dump this message out
763 to stderr and exit. */
764 if (! FRAME_MESSAGE_BUF (selected_frame
)
766 stream
= Qexternal_debugging_output
;
774 errname
= Fcar (data
);
776 if (EQ (errname
, Qerror
))
779 if (!CONSP (data
)) data
= Qnil
;
780 errmsg
= Fcar (data
);
785 errmsg
= Fget (errname
, Qerror_message
);
786 file_error
= Fmemq (Qfile_error
,
787 Fget (errname
, Qerror_conditions
));
790 /* Print an error message including the data items.
791 This is done by printing it into a scratch buffer
792 and then making a copy of the text in the buffer. */
794 if (!CONSP (data
)) data
= Qnil
;
798 /* For file-error, make error message by concatenating
799 all the data items. They are all strings. */
800 if (!NILP (file_error
) && !NILP (tail
))
801 errmsg
= XCONS (tail
)->car
, tail
= XCONS (tail
)->cdr
;
803 if (XTYPE (errmsg
) == Lisp_String
)
804 Fprinc (errmsg
, stream
);
806 write_string_1 ("peculiar error", -1, stream
);
808 for (i
= 0; CONSP (tail
); tail
= Fcdr (tail
), i
++)
810 write_string_1 (i
? ", " : ": ", 2, stream
);
811 if (!NILP (file_error
))
812 Fprinc (Fcar (tail
), stream
);
814 Fprin1 (Fcar (tail
), stream
);
818 /* If the window system or terminal frame hasn't been initialized
819 yet, or we're in -batch mode, this error should cause Emacs to exit. */
820 if (! FRAME_MESSAGE_BUF (selected_frame
)
824 Fkill_emacs (make_number (-1));
829 Vinhibit_quit
= Qnil
;
830 return make_number (0);
833 Lisp_Object
command_loop_1 ();
834 Lisp_Object
command_loop_2 ();
835 Lisp_Object
top_level_1 ();
837 /* Entry to editor-command-loop.
838 This level has the catches for exiting/returning to editor command loop.
839 It returns nil to exit recursive edit, t to abort it. */
844 if (command_loop_level
> 0 || minibuf_level
> 0)
846 return internal_catch (Qexit
, command_loop_2
, Qnil
);
851 internal_catch (Qtop_level
, top_level_1
, Qnil
);
852 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
854 /* End of file in -batch run causes exit here. */
860 /* Here we catch errors in execution of commands within the
861 editing loop, and reenter the editing loop.
862 When there is an error, cmd_error runs and returns a non-nil
863 value to us. A value of nil means that cmd_loop_1 itself
864 returned due to end of file (or end of kbd macro). */
869 register Lisp_Object val
;
872 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
881 return Feval (Vtop_level
);
887 /* On entry to the outer level, run the startup file */
888 if (!NILP (Vtop_level
))
889 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
890 else if (!NILP (Vpurify_flag
))
891 message ("Bare impure Emacs (standard Lisp code not loaded)");
893 message ("Bare Emacs (standard Lisp code not loaded)");
897 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
898 "Exit all recursive editing levels.")
901 Fthrow (Qtop_level
, Qnil
);
904 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
905 "Exit from the innermost recursive edit or minibuffer.")
908 if (command_loop_level
> 0 || minibuf_level
> 0)
909 Fthrow (Qexit
, Qnil
);
911 error ("No recursive edit is in progress");
914 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
915 "Abort the command that requested this recursive edit or minibuffer input.")
918 if (command_loop_level
> 0 || minibuf_level
> 0)
921 error ("No recursive edit is in progress");
924 /* This is the actual command reading loop,
925 sans error-handling encapsulation. */
927 Lisp_Object
Fcommand_execute ();
928 static int read_key_sequence ();
929 static void safe_run_hooks ();
934 Lisp_Object cmd
, tem
;
937 Lisp_Object keybuf
[30];
942 struct buffer
*prev_buffer
;
945 Vdeactivate_mark
= Qnil
;
946 waiting_for_input
= 0;
951 this_command_key_count
= 0;
953 /* Make sure this hook runs after commands that get errors and
954 throw to top level. */
955 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
956 safe_run_hooks (&Vpost_command_hook
);
958 /* Do this after running Vpost_command_hook, for consistency. */
959 last_command
= this_command
;
963 /* Install chars successfully executed in kbd macro. */
965 if (defining_kbd_macro
&& NILP (Vprefix_arg
))
966 finalize_kbd_macro_chars ();
968 /* Make sure the current window's buffer is selected. */
969 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
970 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
972 /* Display any malloc warning that just came out. Use while because
973 displaying one warning can cause another. */
975 while (pending_malloc_warning
)
976 display_malloc_warning ();
980 Vdeactivate_mark
= Qnil
;
982 /* If minibuffer on and echo area in use,
983 wait 2 sec and redraw minibuffer. */
985 if (minibuf_level
&& echo_area_glyphs
)
987 /* Bind inhibit-quit to t so that C-g gets read in
988 rather than quitting back to the minibuffer. */
989 int count
= specpdl_ptr
- specpdl
;
990 specbind (Qinhibit_quit
, Qt
);
991 Fsit_for (make_number (2), Qnil
, Qnil
);
992 unbind_to (count
, Qnil
);
994 echo_area_glyphs
= 0;
996 if (!NILP (Vquit_flag
))
999 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1004 alloca (0); /* Cause a garbage collection now */
1005 /* Since we can free the most stuff here. */
1006 #endif /* C_ALLOCA */
1010 /* Select the frame that the last event came from. Usually,
1011 switch-frame events will take care of this, but if some lisp
1012 code swallows a switch-frame event, we'll fix things up here.
1013 Is this a good idea? */
1014 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
1015 && XFRAME (internal_last_event_frame
) != selected_frame
)
1016 Fselect_frame (internal_last_event_frame
, Qnil
);
1019 /* If it has changed current-menubar from previous value,
1020 really recompute the menubar from the value. */
1021 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1022 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1023 call0 (Qrecompute_lucid_menubar
);
1025 /* Read next key sequence; i gets its length. */
1026 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), Qnil
);
1030 /* Now we have read a key sequence of length I,
1031 or else I is 0 and we found end of file. */
1033 if (i
== 0) /* End of file -- happens only in */
1034 return Qnil
; /* a kbd macro, at the end. */
1035 /* -1 means read_key_sequence got a menu that was rejected.
1036 Just loop around and read another command. */
1040 this_command_key_count
= 0;
1044 last_command_char
= keybuf
[i
- 1];
1046 /* If the previous command tried to force a specific window-start,
1047 forget about that, in case this command moves point far away
1048 from that position. */
1049 XWINDOW (selected_window
)->force_start
= Qnil
;
1051 cmd
= read_key_sequence_cmd
;
1052 if (!NILP (Vexecuting_macro
))
1054 if (!NILP (Vquit_flag
))
1056 Vexecuting_macro
= Qt
;
1057 QUIT
; /* Make some noise. */
1058 /* Will return since macro now empty. */
1062 /* Do redisplay processing after this command except in special
1063 cases identified below that set no_redisplay to 1.
1064 (actually, there's currently no way to prevent the redisplay,
1065 and no_redisplay is ignored.
1066 Perhaps someday we will really implement it. */
1069 prev_buffer
= current_buffer
;
1070 prev_modiff
= MODIFF
;
1071 last_point_position
= PT
;
1072 XSET (last_point_position_buffer
, Lisp_Buffer
, prev_buffer
);
1074 /* Execute the command. */
1077 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1078 safe_run_hooks (&Vpre_command_hook
);
1080 if (NILP (this_command
))
1082 /* nil means key is undefined. */
1084 defining_kbd_macro
= 0;
1085 update_mode_lines
= 1;
1091 if (NILP (Vprefix_arg
) && ! no_direct
)
1093 /* Recognize some common commands in common situations and
1094 do them directly. */
1095 if (EQ (this_command
, Qforward_char
) && PT
< ZV
)
1097 struct Lisp_Vector
*dp
1098 = window_display_table (XWINDOW (selected_window
));
1099 lose
= FETCH_CHAR (PT
);
1102 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1103 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1104 : (lose
>= 0x20 && lose
< 0x7f))
1105 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1107 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1109 && !windows_or_buffers_changed
1110 && EQ (current_buffer
->selective_display
, Qnil
)
1111 && !detect_input_pending ()
1112 && NILP (Vexecuting_macro
))
1113 no_redisplay
= direct_output_forward_char (1);
1116 else if (EQ (this_command
, Qbackward_char
) && PT
> BEGV
)
1118 struct Lisp_Vector
*dp
1119 = window_display_table (XWINDOW (selected_window
));
1121 lose
= FETCH_CHAR (PT
);
1123 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1124 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1125 : (lose
>= 0x20 && lose
< 0x7f))
1126 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1128 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1130 && !windows_or_buffers_changed
1131 && EQ (current_buffer
->selective_display
, Qnil
)
1132 && !detect_input_pending ()
1133 && NILP (Vexecuting_macro
))
1134 no_redisplay
= direct_output_forward_char (-1);
1137 else if (EQ (this_command
, Qself_insert_command
)
1138 /* Try this optimization only on ascii keystrokes. */
1139 && XTYPE (last_command_char
) == Lisp_Int
)
1141 unsigned char c
= XINT (last_command_char
);
1143 if (NILP (Vexecuting_macro
) &&
1144 !EQ (minibuf_window
, selected_window
))
1146 if (!nonundocount
|| nonundocount
>= 20)
1153 lose
= (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1155 || (XFASTINT (XWINDOW (selected_window
)->last_point
) != PT
)
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 (PT
== ZV
|| FETCH_CHAR (PT
) == '\n'))
1169 struct Lisp_Vector
*dp
1170 = window_display_table (XWINDOW (selected_window
));
1177 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1180 /* Do it only for char codes
1181 that by default display as themselves. */
1182 if (lose
>= 0x20 && lose
<= 0x7e)
1183 no_redisplay
= direct_output_for_insert (lose
);
1185 else if (XTYPE (obj
) == Lisp_Vector
1186 && XVECTOR (obj
)->size
== 1
1187 && (XTYPE (obj
= XVECTOR (obj
)->contents
[0])
1189 /* Insist face not specified in glyph. */
1190 && (XINT (obj
) & ((-1) << 8)) == 0)
1192 = direct_output_for_insert (XINT (obj
));
1196 if (lose
>= 0x20 && lose
<= 0x7e)
1197 no_redisplay
= direct_output_for_insert (lose
);
1204 /* Here for a command that isn't executed directly */
1207 if (NILP (Vprefix_arg
))
1209 Fcommand_execute (this_command
, Qnil
);
1214 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1215 safe_run_hooks (&Vpost_command_hook
);
1217 /* If there is a prefix argument,
1218 1) We don't want last_command to be ``universal-argument''
1219 (that would be dumb), so don't set last_command,
1220 2) we want to leave echoing on so that the prefix will be
1221 echoed as part of this key sequence, so don't call
1223 3) we want to leave this_command_key_count non-zero, so that
1224 read_char will realize that it is re-reading a character, and
1225 not echo it a second time. */
1226 if (NILP (Vprefix_arg
))
1228 last_command
= this_command
;
1230 this_command_key_count
= 0;
1233 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1235 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1237 current_buffer
->mark_active
= Qnil
;
1238 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1240 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1241 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1246 /* If we get an error while running the hook, cause the hook variable
1247 to be nil. Also inhibit quits, so that C-g won't cause the hook
1248 to mysteriously evaporate. */
1250 safe_run_hooks (hook
)
1253 int count
= specpdl_ptr
- specpdl
;
1254 specbind (Qinhibit_quit
, Qt
);
1256 Vcommand_hook_internal
= *hook
;
1258 call1 (Vrun_hooks
, Qcommand_hook_internal
);
1259 *hook
= Vcommand_hook_internal
;
1261 unbind_to (count
, Qnil
);
1264 /* Number of seconds between polling for input. */
1267 /* Nonzero means polling for input is temporarily suppressed. */
1268 int poll_suppress_count
;
1270 #ifdef POLL_FOR_INPUT
1271 int polling_for_input
;
1273 /* Handle an alarm once each second and read pending input
1274 so as to handle a C-g if it comces in. */
1277 input_poll_signal ()
1279 if (interrupt_input_blocked
== 0
1280 && !waiting_for_input
)
1281 read_avail_input (0);
1282 signal (SIGALRM
, input_poll_signal
);
1283 alarm (polling_period
);
1288 /* Begin signals to poll for input, if they are appropriate.
1289 This function is called unconditionally from various places. */
1293 #ifdef POLL_FOR_INPUT
1294 if (read_socket_hook
&& !interrupt_input
)
1296 poll_suppress_count
--;
1297 if (poll_suppress_count
== 0)
1299 signal (SIGALRM
, input_poll_signal
);
1300 polling_for_input
= 1;
1301 alarm (polling_period
);
1307 /* Turn off polling. */
1311 #ifdef POLL_FOR_INPUT
1312 if (read_socket_hook
&& !interrupt_input
)
1314 if (poll_suppress_count
== 0)
1316 polling_for_input
= 0;
1319 poll_suppress_count
++;
1324 /* Set the value of poll_suppress_count to COUNT
1325 and start or stop polling accordingly. */
1328 set_poll_suppress_count (count
)
1331 #ifdef POLL_FOR_INPUT
1332 if (count
== 0 && poll_suppress_count
!= 0)
1334 poll_suppress_count
= 1;
1337 else if (count
!= 0 && poll_suppress_count
== 0)
1341 poll_suppress_count
= count
;
1345 /* Bind polling_period to a value at least N.
1346 But don't decrease it. */
1348 bind_polling_period (n
)
1351 #ifdef POLL_FOR_INPUT
1352 int new = polling_period
;
1358 specbind (Qpolling_period
, make_number (new));
1359 /* Start a new alarm with the new period. */
1364 /* Applying the control modifier to CHARACTER. */
1369 /* Save the upper bits here. */
1370 int upper
= c
& ~0177;
1374 /* Everything in the columns containing the upper-case letters
1375 denotes a control character. */
1376 if (c
>= 0100 && c
< 0140)
1380 /* Set the shift modifier for a control char
1381 made from a shifted letter. But only for letters! */
1382 if (oc
>= 'A' && oc
<= 'Z')
1383 c
|= shift_modifier
;
1386 /* The lower-case letters denote control characters too. */
1387 else if (c
>= 'a' && c
<= 'z')
1390 /* Include the bits for control and shift
1391 only if the basic ASCII code can't indicate them. */
1395 /* Replace the high bits. */
1396 c
|= (upper
& ~ctrl_modifier
);
1403 /* Input of single characters from keyboard */
1405 Lisp_Object
print_help ();
1406 static Lisp_Object
kbd_buffer_get_event ();
1408 /* read a character from the keyboard; call the redisplay if needed */
1409 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1410 -1 means do not do redisplay, but do do autosaving.
1413 /* The arguments MAPS and NMAPS are for menu prompting.
1414 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1416 PREV_EVENT is the previous input event, or nil if we are reading
1417 the first event of a key sequence.
1419 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1420 if we used a mouse menu to read the input, or zero otherwise. If
1421 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
1423 Value is t if we showed a menu and the user rejected it. */
1426 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1430 Lisp_Object prev_event
;
1431 int *used_mouse_menu
;
1433 register Lisp_Object c
;
1437 if (CONSP (Vunread_command_events
))
1439 c
= XCONS (Vunread_command_events
)->car
;
1440 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1442 if (this_command_key_count
== 0)
1448 if (unread_command_char
!= -1)
1450 XSET (c
, Lisp_Int
, unread_command_char
);
1451 unread_command_char
= -1;
1453 if (this_command_key_count
== 0)
1459 if (!NILP (Vexecuting_macro
))
1462 /* We set this to Qmacro; since that's not a frame, nobody will
1463 try to switch frames on us, and the selected window will
1466 Since this event came from a macro, it would be misleading to
1467 leave internal_last_event_frame set to wherever the last
1468 real event came from. Normally, a switch-frame event selects
1469 internal_last_event_frame after each command is read, but
1470 events read from a macro should never cause a new frame to be
1472 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1475 /* Exit the macro if we are at the end.
1476 Also, some things replace the macro with t
1477 to force an early exit. */
1478 if (EQ (Vexecuting_macro
, Qt
)
1479 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1481 XSET (c
, Lisp_Int
, -1);
1485 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1486 if (XTYPE (Vexecuting_macro
) == Lisp_String
1487 && (XINT (c
) & 0x80))
1488 XFASTINT (c
) = CHAR_META
| (XINT (c
) & ~0x80);
1490 executing_macro_index
++;
1495 if (!NILP (unread_switch_frame
))
1497 c
= unread_switch_frame
;
1498 unread_switch_frame
= Qnil
;
1500 /* This event should make it into this_command_keys, and get echoed
1501 again, so we go to reread_first, rather than reread. */
1505 /* Don't bother updating menu bars while doing mouse tracking.
1506 We get events very rapidly then, and the menu bar won't be changing.
1507 We do update the menu bar once on entry to Ftrack_mouse. */
1508 if (commandflag
> 0 && !input_pending
&& !detect_input_pending ())
1509 prepare_menu_bars ();
1511 /* Save outer setjmp data, in case called recursively. */
1512 save_getcjmp (save_jump
);
1516 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1519 if (_setjmp (getcjmp
))
1521 XSET (c
, Lisp_Int
, quit_char
);
1523 XSET (internal_last_event_frame
, Lisp_Frame
, selected_frame
);
1524 Vlast_event_frame
= internal_last_event_frame
;
1526 /* If we report the quit char as an event,
1527 don't do so more than once. */
1528 if (!NILP (Vinhibit_quit
))
1534 /* Message turns off echoing unless more keystrokes turn it on again. */
1535 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1538 /* If already echoing, continue. */
1541 /* Try reading a character via menu prompting in the minibuf.
1542 Try this before the sit-for, because the sit-for
1543 would do the wrong thing if we are supposed to do
1544 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1545 after a mouse event so don't try a minibuf menu. */
1547 if (nmaps
> 0 && INTERACTIVE
1548 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1549 /* Don't bring up a menu if we already have another event. */
1550 && NILP (Vunread_command_events
)
1551 && unread_command_char
< 0
1552 && !detect_input_pending ())
1554 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1559 /* If in middle of key sequence and minibuffer not active,
1560 start echoing if enough time elapses. */
1561 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1563 && echo_keystrokes
> 0
1564 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1568 /* After a mouse event, start echoing right away.
1569 This is because we are probably about to display a menu,
1570 and we don't want to delay before doing so. */
1571 if (EVENT_HAS_PARAMETERS (prev_event
))
1575 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1581 /* Maybe auto save due to number of keystrokes or idle time. */
1583 if (commandflag
!= 0
1584 && auto_save_interval
> 0
1585 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1586 && !detect_input_pending ())
1589 save_getcjmp (temp
);
1590 Fdo_auto_save (Qnil
, Qnil
);
1591 restore_getcjmp (temp
);
1594 /* Try reading using an X menu.
1595 This is never confused with reading using the minibuf
1596 because the recursive call of read_char in read_char_minibuf_menu_prompt
1597 does not pass on any keymaps. */
1598 if (nmaps
> 0 && INTERACTIVE
1599 && !NILP (prev_event
) && EVENT_HAS_PARAMETERS (prev_event
)
1600 /* Don't bring up a menu if we already have another event. */
1601 && NILP (Vunread_command_events
)
1602 && unread_command_char
< 0)
1603 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1605 /* Slow down auto saves logarithmically in size of current buffer,
1606 and garbage collect while we're at it. */
1607 if (INTERACTIVE
&& NILP (c
))
1609 int delay_level
, buffer_size
;
1611 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1612 last_non_minibuf_size
= Z
- BEG
;
1613 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1615 while (buffer_size
> 64)
1616 delay_level
++, buffer_size
-= buffer_size
>> 2;
1617 if (delay_level
< 4) delay_level
= 4;
1618 /* delay_level is 4 for files under around 50k, 7 at 100k,
1619 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1621 /* Auto save if enough time goes by without input. */
1622 if (commandflag
!= 0
1623 && num_nonmacro_input_chars
> last_auto_save
1624 && XTYPE (Vauto_save_timeout
) == Lisp_Int
1625 && XINT (Vauto_save_timeout
) > 0)
1628 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1629 tem0
= sit_for (delay
, 0, 1, 1);
1633 save_getcjmp (temp
);
1634 Fdo_auto_save (Qnil
, Qnil
);
1635 restore_getcjmp (temp
);
1637 /* If we have auto-saved and there is still no input
1638 available, garbage collect if there has been enough
1639 consing going on to make it worthwhile. */
1640 if (!detect_input_pending ()
1641 && consing_since_gc
> gc_cons_threshold
/ 2)
1643 Fgarbage_collect ();
1644 /* prepare_menu_bars isn't safe here, but it should
1645 also be unnecessary. */
1652 /* Actually read a character, waiting if necessary. */
1655 c
= kbd_buffer_get_event ();
1658 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1660 prepare_menu_bars ();
1665 /* Terminate Emacs in batch mode if at eof. */
1666 if (noninteractive
&& XTYPE (c
) == Lisp_Int
&& XINT (c
) < 0)
1667 Fkill_emacs (make_number (1));
1669 if (XTYPE (c
) == Lisp_Int
)
1671 /* Add in any extra modifiers, where appropriate. */
1672 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1673 || ((extra_keyboard_modifiers
& 0177) < ' '
1674 && (extra_keyboard_modifiers
& 0177) != 0))
1675 XSETINT (c
, make_ctrl_char (XINT (c
)));
1677 /* Transfer any other modifier bits directly from
1678 extra_keyboard_modifiers to c. Ignore the actual character code
1679 in the low 16 bits of extra_keyboard_modifiers. */
1680 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
1685 restore_getcjmp (save_jump
);
1689 /* Don't wipe the echo area for a trivial event. */
1690 if (XTYPE (c
) != Lisp_Buffer
)
1691 echo_area_glyphs
= 0;
1693 /* Handle things that only apply to characters. */
1694 if (XTYPE (c
) == Lisp_Int
)
1696 /* If kbd_buffer_get_event gave us an EOF, return that. */
1700 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
1701 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1702 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1706 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1707 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1708 recent_keys_index
= 0;
1710 /* Write c to the dribble file. If c is a lispy event, write
1711 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1712 If you, dear reader, have a better idea, you've got the source. :-) */
1715 if (XTYPE (c
) == Lisp_Int
)
1716 putc (XINT (c
), dribble
);
1719 Lisp_Object dribblee
;
1721 /* If it's a structured event, take the event header. */
1722 dribblee
= EVENT_HEAD (c
);
1724 if (XTYPE (dribblee
) == Lisp_Symbol
)
1726 putc ('<', dribble
);
1727 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1728 XSYMBOL (dribblee
)->name
->size
,
1730 putc ('>', dribble
);
1737 store_kbd_macro_char (c
);
1739 num_nonmacro_input_chars
++;
1744 /* Don't echo mouse motion events. */
1745 if (! (EVENT_HAS_PARAMETERS (c
)
1746 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1749 /* Record this character as part of the current key. */
1750 add_command_key (c
);
1752 /* Re-reading in the middle of a command */
1754 last_input_char
= c
;
1757 /* Process the help character specially if enabled */
1758 if (EQ (c
, Vhelp_char
) && !NILP (Vhelp_form
))
1761 count
= specpdl_ptr
- specpdl
;
1763 record_unwind_protect (Fset_window_configuration
,
1764 Fcurrent_window_configuration (Qnil
));
1766 tem0
= Feval (Vhelp_form
);
1767 if (XTYPE (tem0
) == Lisp_String
)
1768 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1772 c
= read_char (0, 0, 0, Qnil
, 0);
1773 while (XTYPE (c
) == Lisp_Buffer
);
1774 /* Remove the help from the frame */
1775 unbind_to (count
, Qnil
);
1776 prepare_menu_bars ();
1778 if (EQ (c
, make_number (040)))
1782 c
= read_char (0, 0, 0, Qnil
, 0);
1783 while (XTYPE (c
) == Lisp_Buffer
);
1794 Fprinc (object
, Qnil
);
1798 /* Copy out or in the info on where C-g should throw to.
1799 This is used when running Lisp code from within get_char,
1800 in case get_char is called recursively.
1801 See read_process_output. */
1806 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1809 restore_getcjmp (temp
)
1812 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1816 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1817 of this function. */
1819 tracking_off (old_value
)
1820 Lisp_Object old_value
;
1822 if (! XFASTINT (old_value
))
1824 do_mouse_tracking
= 0;
1826 /* Redisplay may have been preempted because there was input
1827 available, and it assumes it will be called again after the
1828 input has been processed. If the only input available was
1829 the sort that we have just disabled, then we need to call
1831 if (!readable_events ())
1833 prepare_menu_bars ();
1834 redisplay_preserve_echo_area ();
1835 get_input_pending (&input_pending
);
1840 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1841 "Evaluate BODY with mouse movement events enabled.\n\
1842 Within a `track-mouse' form, mouse motion generates input events that\n\
1843 you can read with `read-event'.\n\
1844 Normally, mouse motion is ignored.")
1848 int count
= specpdl_ptr
- specpdl
;
1851 XSET (val
, Lisp_Int
, do_mouse_tracking
);
1852 record_unwind_protect (tracking_off
, val
);
1854 if (!input_pending
&& !detect_input_pending ())
1855 prepare_menu_bars ();
1857 do_mouse_tracking
= 1;
1859 val
= Fprogn (args
);
1860 return unbind_to (count
, val
);
1863 /* Low level keyboard/mouse input.
1864 kbd_buffer_store_event places events in kbd_buffer, and
1865 kbd_buffer_get_event retrieves them.
1866 mouse_moved indicates when the mouse has moved again, and
1867 *mouse_position_hook provides the mouse position. */
1869 /* Return true iff there are any events in the queue that read-char
1870 would return. If this returns false, a read-char would block. */
1874 return ! EVENT_QUEUES_EMPTY
;
1877 /* Set this for debugging, to have a way to get out */
1880 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
1883 kbd_buffer_store_event (event
)
1884 register struct input_event
*event
;
1886 if (event
->kind
== no_event
)
1889 if (event
->kind
== ascii_keystroke
)
1891 register int c
= event
->code
& 0377;
1893 if (event
->modifiers
& ctrl_modifier
)
1894 c
= make_ctrl_char (c
);
1896 c
|= (event
->modifiers
1897 & (meta_modifier
| alt_modifier
1898 | hyper_modifier
| super_modifier
));
1902 extern SIGTYPE
interrupt_signal ();
1905 /* If this results in a quit_char being returned to Emacs as
1906 input, set Vlast_event_frame properly. If this doesn't
1907 get returned to Emacs as an event, the next event read
1908 will set Vlast_event_frame again, so this is safe to do. */
1912 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
1914 internal_last_event_frame
= event
->frame_or_window
;
1916 internal_last_event_frame
= focus
;
1917 Vlast_event_frame
= internal_last_event_frame
;
1921 last_event_timestamp
= event
->timestamp
;
1922 interrupt_signal ();
1926 if (c
&& c
== stop_character
)
1933 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
1934 kbd_store_ptr
= kbd_buffer
;
1936 /* Don't let the very last slot in the buffer become full,
1937 since that would make the two pointers equal,
1938 and that is indistinguishable from an empty buffer.
1939 Discard the event if it would fill the last slot. */
1940 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
1942 kbd_store_ptr
->kind
= event
->kind
;
1943 if (event
->kind
== selection_request_event
)
1945 /* We must not use the ordinary copying code for this case,
1946 since `part' is an enum and copying it might not copy enough
1948 bcopy (event
, kbd_store_ptr
, sizeof (*event
));
1952 kbd_store_ptr
->code
= event
->code
;
1953 kbd_store_ptr
->part
= event
->part
;
1954 kbd_store_ptr
->frame_or_window
= event
->frame_or_window
;
1955 kbd_store_ptr
->modifiers
= event
->modifiers
;
1956 kbd_store_ptr
->x
= event
->x
;
1957 kbd_store_ptr
->y
= event
->y
;
1958 kbd_store_ptr
->timestamp
= event
->timestamp
;
1960 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
1962 = event
->frame_or_window
);
1968 /* Read one event from the event buffer, waiting if necessary.
1969 The value is a Lisp object representing the event.
1970 The value is nil for an event that should be ignored,
1971 or that was handled here.
1972 We always read and discard one event. */
1975 kbd_buffer_get_event ()
1983 XSET (obj
, Lisp_Int
, c
);
1987 /* Wait until there is input available. */
1990 if (!EVENT_QUEUES_EMPTY
)
1993 /* If the quit flag is set, then read_char will return
1994 quit_char, so that counts as "available input." */
1995 if (!NILP (Vquit_flag
))
1996 quit_throw_to_read_char ();
1998 /* One way or another, wait until input is available; then, if
1999 interrupt handlers have not read it, read it now. */
2002 wait_for_kbd_input ();
2004 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2008 if (EVENT_QUEUES_EMPTY
)
2010 Lisp_Object minus_one
;
2012 XSET (minus_one
, Lisp_Int
, -1);
2013 wait_reading_process_input (0, 0, minus_one
, 1);
2015 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
2016 /* Pass 1 for EXPECT since we just waited to have input. */
2017 read_avail_input (1);
2019 #endif /* not VMS */
2022 /* At this point, we know that there is a readable event available
2023 somewhere. If the event queue is empty, then there must be a
2024 mouse movement enabled and available. */
2025 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2027 struct input_event
*event
;
2029 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2033 last_event_timestamp
= event
->timestamp
;
2037 /* These two kinds of events get special handling
2038 and don't actually appear to the command loop.
2039 We return nil for them. */
2040 if (event
->kind
== selection_request_event
)
2043 x_handle_selection_request (event
);
2044 kbd_fetch_ptr
= event
+ 1;
2046 /* We're getting selection request events, but we don't have
2052 else if (event
->kind
== selection_clear_event
)
2055 x_handle_selection_clear (event
);
2056 kbd_fetch_ptr
= event
+ 1;
2058 /* We're getting selection request events, but we don't have
2064 else if (event
->kind
== delete_window_event
)
2066 Lisp_Object tail
, frame
;
2069 /* If the user destroys the only frame, Emacs should exit.
2070 Count visible frames and iconified frames. */
2071 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2073 frame
= XCONS (tail
)->car
;
2074 if (XTYPE (frame
) != Lisp_Frame
|| EQ (frame
, event
->frame_or_window
))
2077 if (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
))
2084 Fdelete_frame (event
->frame_or_window
, Qt
);
2085 kbd_fetch_ptr
= event
+ 1;
2088 else if (event
->kind
== menu_bar_event
)
2090 /* The event value is in the frame_or_window slot. */
2091 obj
= event
->frame_or_window
;
2092 kbd_fetch_ptr
= event
+ 1;
2094 else if (event
->kind
== buffer_switch_event
)
2096 /* The value doesn't matter here; only the type is tested. */
2097 XSET (obj
, Lisp_Buffer
, current_buffer
);
2098 kbd_fetch_ptr
= event
+ 1;
2100 /* Just discard these, by returning nil.
2101 (They shouldn't be found in the buffer,
2102 but on some machines it appears they do show up.) */
2103 else if (event
->kind
== no_event
)
2104 kbd_fetch_ptr
= event
+ 1;
2106 /* If this event is on a different frame, return a switch-frame this
2107 time, and leave the event in the queue for next time. */
2114 frame
= event
->frame_or_window
;
2115 if (XTYPE (frame
) == Lisp_Window
)
2116 frame
= WINDOW_FRAME (XWINDOW (frame
));
2118 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2122 if (! EQ (frame
, internal_last_event_frame
)
2123 && XFRAME (frame
) != selected_frame
)
2124 obj
= make_lispy_switch_frame (frame
);
2125 internal_last_event_frame
= frame
;
2126 #endif /* MULTI_FRAME */
2128 /* If we didn't decide to make a switch-frame event, go ahead
2129 and build a real event from the queue entry. */
2133 obj
= make_lispy_event (event
);
2135 /* Wipe out this event, to catch bugs. */
2136 event
->kind
= no_event
;
2137 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
2140 kbd_fetch_ptr
= event
+ 1;
2144 /* Try generating a mouse motion event. */
2145 else if (do_mouse_tracking
&& mouse_moved
)
2148 Lisp_Object bar_window
;
2149 enum scroll_bar_part part
;
2153 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
2158 /* Decide if we should generate a switch-frame event. Don't
2159 generate switch-frame events for motion outside of all Emacs
2165 frame
= FRAME_FOCUS_FRAME (f
);
2167 XSET (frame
, Lisp_Frame
, f
);
2169 if (! EQ (frame
, internal_last_event_frame
)
2170 && XFRAME (frame
) != selected_frame
)
2171 obj
= make_lispy_switch_frame (frame
);
2172 internal_last_event_frame
= frame
;
2175 /* If we didn't decide to make a switch-frame event, go ahead and
2176 return a mouse-motion event. */
2178 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2182 /* We were promised by the above while loop that there was
2183 something for us to read! */
2186 input_pending
= readable_events ();
2189 Vlast_event_frame
= internal_last_event_frame
;
2195 /* Process any events that are not user-visible,
2196 then return, without reading any user-visible events. */
2201 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2203 struct input_event
*event
;
2205 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2209 last_event_timestamp
= event
->timestamp
;
2211 /* These two kinds of events get special handling
2212 and don't actually appear to the command loop. */
2213 if (event
->kind
== selection_request_event
)
2216 x_handle_selection_request (event
);
2217 kbd_fetch_ptr
= event
+ 1;
2219 /* We're getting selection request events, but we don't have
2225 else if (event
->kind
== selection_clear_event
)
2228 x_handle_selection_clear (event
);
2229 kbd_fetch_ptr
= event
+ 1;
2231 /* We're getting selection request events, but we don't have
2240 get_input_pending (&input_pending
);
2243 /* Caches for modify_event_symbol. */
2244 static Lisp_Object accent_key_syms
;
2245 static Lisp_Object system_key_syms
;
2246 static Lisp_Object func_key_syms
;
2247 static Lisp_Object mouse_syms
;
2249 Lisp_Object Vsystem_key_alist
;
2251 /* This is a list of keysym codes for special "accent" characters.
2252 It parallels lispy_accent_keys. */
2254 static int lispy_accent_codes
[] =
2256 #ifdef XK_dead_circumflex
2261 #ifdef XK_dead_grave
2266 #ifdef XK_dead_tilde
2271 #ifdef XK_dead_diaeresis
2276 #ifdef XK_dead_macron
2281 #ifdef XK_dead_degree
2286 #ifdef XK_dead_acute
2291 #ifdef XK_dead_cedilla
2296 #ifdef XK_dead_breve
2301 #ifdef XK_dead_ogonek
2306 #ifdef XK_dead_caron
2311 #ifdef XK_dead_doubleacute
2312 XK_dead_doubleacute
,
2316 #ifdef XK_dead_abovedot
2323 /* This is a list of Lisp names for special "accent" characters.
2324 It parallels lispy_accent_codes. */
2326 static char *lispy_accent_keys
[] =
2343 /* You'll notice that this table is arranged to be conveniently
2344 indexed by X Windows keysym values. */
2345 static char *lispy_function_keys
[] =
2347 /* X Keysym value */
2349 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2357 0, 0, 0, /* 0xff10 */
2359 0, 0, 0, 0, 0, 0, 0,
2362 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2363 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2364 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2366 "home", /* 0xff50 */ /* IsCursorKey */
2377 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2388 "break", /* 0xff6b */
2390 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
2392 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2393 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2394 0, 0, 0, 0, 0, 0, 0, 0,
2395 "kp-tab", /* 0xff89 */
2397 "kp-enter", /* 0xff8d */
2399 "kp-f1", /* 0xff91 */
2403 "kp-home", /* 0xff95 */
2408 "kp-prior", /* kp-page-up */
2409 "kp-next", /* kp-page-down */
2415 0, 0, 0, 0, 0, 0, 0, 0, 0,
2416 "kp-multiply", /* 0xffaa */
2421 "kp-divide", /* 0xffaf */
2422 "kp-0", /* 0xffb0 */
2423 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2426 "kp-equal", /* 0xffbd */
2427 "f1", /* 0xffbe */ /* IsFunctionKey */
2429 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2430 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2431 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2432 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2433 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2434 0, 0, 0, 0, 0, 0, 0, 0,
2435 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2436 0, 0, 0, 0, 0, 0, 0, "delete"
2439 static char *lispy_mouse_names
[] =
2441 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2444 /* Scroll bar parts. */
2445 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2447 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2448 Lisp_Object
*scroll_bar_parts
[] = {
2449 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2453 /* A vector, indexed by button number, giving the down-going location
2454 of currently depressed buttons, both scroll bar and non-scroll bar.
2456 The elements have the form
2457 (BUTTON-NUMBER MODIFIER-MASK . REST)
2458 where REST is the cdr of a position as it would be reported in the event.
2460 The make_lispy_event function stores positions here to tell the
2461 difference between click and drag events, and to store the starting
2462 location to be included in drag events. */
2464 static Lisp_Object button_down_location
;
2466 /* Information about the most recent up-going button event: Which
2467 button, what location, and what time. */
2469 static int last_mouse_button
;
2470 static int last_mouse_x
;
2471 static int last_mouse_y
;
2472 static unsigned long button_down_time
;
2474 /* The maximum time between clicks to make a double-click,
2475 or Qnil to disable double-click detection,
2476 or Qt for no time limit. */
2477 Lisp_Object Vdouble_click_time
;
2479 /* The number of clicks in this multiple-click. */
2481 int double_click_count
;
2483 #ifdef USE_X_TOOLKIT
2484 extern Lisp_Object
map_event_to_object ();
2485 #endif /* USE_X_TOOLKIT */
2487 /* Given a struct input_event, build the lisp event which represents
2488 it. If EVENT is 0, build a mouse movement event from the mouse
2489 movement buffer, which should have a movement event in it.
2491 Note that events must be passed to this function in the order they
2492 are received; this function stores the location of button presses
2493 in order to build drag events when the button is released. */
2496 make_lispy_event (event
)
2497 struct input_event
*event
;
2501 #ifdef SWITCH_ENUM_BUG
2502 switch ((int) event
->kind
)
2504 switch (event
->kind
)
2507 /* A simple keystroke. */
2508 case ascii_keystroke
:
2510 int c
= event
->code
& 0377;
2511 /* Turn ASCII characters into control characters
2513 if (event
->modifiers
& ctrl_modifier
)
2514 c
= make_ctrl_char (c
);
2516 /* Add in the other modifier bits. We took care of ctrl_modifier
2517 just above, and the shift key was taken care of by the X code,
2518 and applied to control characters by make_ctrl_char. */
2519 c
|= (event
->modifiers
2520 & (meta_modifier
| alt_modifier
2521 | hyper_modifier
| super_modifier
));
2522 button_down_time
= 0;
2526 /* A function key. The symbol may need to have modifier prefixes
2528 case non_ascii_keystroke
:
2529 button_down_time
= 0;
2531 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
2532 if (event
->code
== lispy_accent_codes
[i
])
2533 return modify_event_symbol (i
,
2535 Qfunction_key
, Qnil
,
2536 lispy_accent_keys
, &accent_key_syms
,
2537 (sizeof (lispy_accent_keys
)
2538 / sizeof (lispy_accent_keys
[0])));
2540 /* Handle system-specific keysyms. */
2541 if (event
->code
& (1 << 28))
2543 /* We need to use an alist rather than a vector as the cache
2544 since we can't make a vector long enuf. */
2545 if (NILP (system_key_syms
))
2546 system_key_syms
= Fcons (Qnil
, Qnil
);
2547 return modify_event_symbol (event
->code
& 0xffffff,
2549 Qfunction_key
, Vsystem_key_alist
,
2550 0, &system_key_syms
, 0xffffff);
2553 return modify_event_symbol (event
->code
- 0xff00,
2555 Qfunction_key
, Qnil
,
2556 lispy_function_keys
, &func_key_syms
,
2557 (sizeof (lispy_function_keys
)
2558 / sizeof (lispy_function_keys
[0])));
2561 #if defined(MULTI_FRAME) || defined(HAVE_MOUSE)
2562 /* A mouse click. Figure out where it is, decide whether it's
2563 a press, click or drag, and build the appropriate structure. */
2565 case scroll_bar_click
:
2567 int button
= event
->code
;
2569 Lisp_Object position
;
2570 Lisp_Object
*start_pos_ptr
;
2571 Lisp_Object start_pos
;
2573 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2576 /* Build the position as appropriate for this mouse click. */
2577 if (event
->kind
== mouse_click
)
2580 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2585 /* Ignore mouse events that were made on frame that
2586 have been deleted. */
2587 if (! FRAME_LIVE_P (f
))
2590 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
2591 &column
, &row
, 0, 0);
2593 #ifdef USE_X_TOOLKIT
2594 if (FRAME_EXTERNAL_MENU_BAR (f
) && XINT (event
->y
) == -1)
2596 if (row
< FRAME_MENU_BAR_LINES (f
))
2599 Lisp_Object items
, item
;
2601 #ifdef USE_X_TOOLKIT
2602 /* The click happened in the menubar.
2603 Look for the menu item selected. */
2604 item
= map_event_to_object (event
, f
);
2606 XFASTINT (event
->y
) = 1;
2607 #else /* not USE_X_TOOLKIT */
2612 items
= FRAME_MENU_BAR_ITEMS (f
);
2613 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 3)
2615 Lisp_Object pos
, string
;
2616 string
= XVECTOR (items
)->contents
[i
+ 1];
2617 pos
= XVECTOR (items
)->contents
[i
+ 2];
2620 if (column
>= XINT (pos
)
2621 && column
< XINT (pos
) + XSTRING (string
)->size
)
2623 item
= XVECTOR (items
)->contents
[i
];
2627 #endif /* not USE_X_TOOLKIT */
2630 = Fcons (event
->frame_or_window
,
2632 Fcons (Fcons (event
->x
, event
->y
),
2633 Fcons (make_number (event
->timestamp
),
2636 return Fcons (item
, Fcons (position
, Qnil
));
2639 window
= window_from_coordinates (f
, column
, row
, &part
);
2641 if (XTYPE (window
) != Lisp_Window
)
2645 int pixcolumn
, pixrow
;
2646 column
-= XINT (XWINDOW (window
)->left
);
2647 row
-= XINT (XWINDOW (window
)->top
);
2648 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
2649 XSETINT (event
->x
, pixcolumn
);
2650 XSETINT (event
->y
, pixrow
);
2655 posn
= Qvertical_line
;
2657 XSET (posn
, Lisp_Int
,
2658 buffer_posn_from_coords (XWINDOW (window
),
2665 Fcons (Fcons (event
->x
, event
->y
),
2666 Fcons (make_number (event
->timestamp
),
2672 Lisp_Object portion_whole
;
2675 window
= event
->frame_or_window
;
2676 portion_whole
= Fcons (event
->x
, event
->y
);
2677 part
= *scroll_bar_parts
[(int) event
->part
];
2681 Fcons (Qvertical_scroll_bar
,
2682 Fcons (portion_whole
,
2683 Fcons (make_number (event
->timestamp
),
2684 Fcons (part
, Qnil
)))));
2687 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2689 start_pos
= *start_pos_ptr
;
2690 *start_pos_ptr
= Qnil
;
2692 is_double
= (button
== last_mouse_button
2693 && XINT (event
->x
) == last_mouse_x
2694 && XINT (event
->y
) == last_mouse_y
2695 && button_down_time
!= 0
2696 && (EQ (Vdouble_click_time
, Qt
)
2697 || (INTEGERP (Vdouble_click_time
)
2698 && ((int)(event
->timestamp
- button_down_time
)
2699 < XINT (Vdouble_click_time
)))));
2700 last_mouse_button
= button
;
2701 last_mouse_x
= XINT (event
->x
);
2702 last_mouse_y
= XINT (event
->y
);
2704 /* If this is a button press, squirrel away the location, so
2705 we can decide later whether it was a click or a drag. */
2706 if (event
->modifiers
& down_modifier
)
2710 double_click_count
++;
2711 event
->modifiers
|= ((double_click_count
> 2)
2716 double_click_count
= 1;
2717 button_down_time
= event
->timestamp
;
2718 *start_pos_ptr
= Fcopy_alist (position
);
2721 /* Now we're releasing a button - check the co-ordinates to
2722 see if this was a click or a drag. */
2723 else if (event
->modifiers
& up_modifier
)
2725 /* If we did not see a down before this up,
2726 ignore the up. Probably this happened because
2727 the down event chose a menu item.
2728 It would be an annoyance to treat the release
2729 of the button that chose the menu item
2730 as a separate event. */
2732 if (XTYPE (start_pos
) != Lisp_Cons
)
2735 event
->modifiers
&= ~up_modifier
;
2736 #if 0 /* Formerly we treated an up with no down as a click event. */
2737 if (XTYPE (start_pos
) != Lisp_Cons
)
2738 event
->modifiers
|= click_modifier
;
2742 /* The third element of every position should be the (x,y)
2746 down
= Fnth (make_number (2), start_pos
);
2747 if (EQ (event
->x
, XCONS (down
)->car
)
2748 && EQ (event
->y
, XCONS (down
)->cdr
))
2750 if (is_double
&& double_click_count
> 1)
2751 event
->modifiers
|= ((double_click_count
> 2)
2755 event
->modifiers
|= click_modifier
;
2759 button_down_time
= 0;
2760 event
->modifiers
|= drag_modifier
;
2765 /* Every mouse event should either have the down_modifier or
2766 the up_modifier set. */
2770 /* Get the symbol we should use for the mouse click. */
2773 head
= modify_event_symbol (button
,
2776 lispy_mouse_names
, &mouse_syms
,
2777 (sizeof (lispy_mouse_names
)
2778 / sizeof (lispy_mouse_names
[0])));
2779 if (event
->modifiers
& drag_modifier
)
2784 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2787 Fcons (make_number (double_click_count
),
2795 #endif /* MULTI_FRAME or HAVE_MOUSE */
2797 /* The 'kind' field of the event is something we don't recognize. */
2806 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2808 Lisp_Object bar_window
;
2809 enum scroll_bar_part part
;
2813 /* Is it a scroll bar movement? */
2814 if (frame
&& ! NILP (bar_window
))
2816 Lisp_Object part_sym
;
2818 part_sym
= *scroll_bar_parts
[(int) part
];
2819 return Fcons (Qscroll_bar_movement
,
2820 (Fcons (Fcons (bar_window
,
2821 Fcons (Qvertical_scroll_bar
,
2822 Fcons (Fcons (x
, y
),
2823 Fcons (make_number (time
),
2829 /* Or is it an ordinary mouse movement? */
2839 /* It's in a frame; which window on that frame? */
2840 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
, 0, 1);
2841 window
= window_from_coordinates (frame
, column
, row
, &area
);
2846 if (XTYPE (window
) == Lisp_Window
)
2848 int pixcolumn
, pixrow
;
2849 column
-= XINT (XWINDOW (window
)->left
);
2850 row
-= XINT (XWINDOW (window
)->top
);
2851 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
2852 XSETINT (x
, pixcolumn
);
2853 XSETINT (y
, pixrow
);
2858 posn
= Qvertical_line
;
2860 XSET (posn
, Lisp_Int
,
2861 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
2863 else if (frame
!= 0)
2865 XSET (window
, Lisp_Frame
, frame
);
2876 return Fcons (Qmouse_movement
,
2877 Fcons (Fcons (window
,
2879 Fcons (Fcons (x
, y
),
2880 Fcons (make_number (time
),
2886 #endif /* MULTI_FRAME */
2888 /* Construct a switch frame event. */
2890 make_lispy_switch_frame (frame
)
2893 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
2896 /* Manipulating modifiers. */
2898 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
2900 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2901 SYMBOL's name of the end of the modifiers; the string from this
2902 position is the unmodified symbol name.
2904 This doesn't use any caches. */
2906 parse_modifiers_uncached (symbol
, modifier_end
)
2910 struct Lisp_String
*name
;
2914 CHECK_SYMBOL (symbol
, 1);
2917 name
= XSYMBOL (symbol
)->name
;
2920 for (i
= 0; i
+2 <= name
->size
; )
2921 switch (name
->data
[i
])
2923 #define SINGLE_LETTER_MOD(bit) \
2924 if (name->data[i+1] != '-') \
2925 goto no_more_modifiers; \
2930 SINGLE_LETTER_MOD (alt_modifier
);
2934 SINGLE_LETTER_MOD (ctrl_modifier
);
2938 SINGLE_LETTER_MOD (hyper_modifier
);
2942 SINGLE_LETTER_MOD (meta_modifier
);
2946 SINGLE_LETTER_MOD (shift_modifier
);
2950 SINGLE_LETTER_MOD (super_modifier
);
2954 if (i
+ 5 > name
->size
)
2955 goto no_more_modifiers
;
2956 if (! strncmp (name
->data
+ i
, "drag-", 5))
2958 modifiers
|= drag_modifier
;
2961 else if (! strncmp (name
->data
+ i
, "down-", 5))
2963 modifiers
|= down_modifier
;
2966 else if (i
+ 7 <= name
->size
2967 && ! strncmp (name
->data
+ i
, "double-", 7))
2969 modifiers
|= double_modifier
;
2973 goto no_more_modifiers
;
2977 if (i
+ 7 > name
->size
)
2978 goto no_more_modifiers
;
2979 if (! strncmp (name
->data
+ i
, "triple-", 7))
2981 modifiers
|= triple_modifier
;
2985 goto no_more_modifiers
;
2989 goto no_more_modifiers
;
2991 #undef SINGLE_LETTER_MOD
2995 /* Should we include the `click' modifier? */
2996 if (! (modifiers
& (down_modifier
| drag_modifier
2997 | double_modifier
| triple_modifier
))
2998 && i
+ 7 == name
->size
2999 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
3000 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
3001 modifiers
|= click_modifier
;
3010 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
3011 prepended to the string BASE[0..BASE_LEN-1].
3012 This doesn't use any caches. */
3014 apply_modifiers_uncached (modifiers
, base
, base_len
)
3019 /* Since BASE could contain nulls, we can't use intern here; we have
3020 to use Fintern, which expects a genuine Lisp_String, and keeps a
3023 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
3029 /* Only the event queue may use the `up' modifier; it should always
3030 be turned into a click or drag event before presented to lisp code. */
3031 if (modifiers
& up_modifier
)
3034 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
3035 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
3036 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
3037 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
3038 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
3039 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
3040 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
3041 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
3042 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
3043 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
3044 /* The click modifier is denoted by the absence of other modifiers. */
3048 mod_len
= p
- new_mods
;
3052 Lisp_Object new_name
;
3054 new_name
= make_uninit_string (mod_len
+ base_len
);
3055 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
3056 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
3058 return Fintern (new_name
, Qnil
);
3063 static char *modifier_names
[] =
3065 "up", "down", "drag", "click", "double", "triple", 0, 0,
3066 0, 0, 0, 0, 0, 0, 0, 0,
3067 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
3069 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
3071 static Lisp_Object modifier_symbols
;
3073 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
3075 lispy_modifier_list (modifiers
)
3078 Lisp_Object modifier_list
;
3081 modifier_list
= Qnil
;
3082 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
3083 if (modifiers
& (1<<i
))
3084 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
3087 return modifier_list
;
3091 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
3092 where UNMODIFIED is the unmodified form of SYMBOL,
3093 MASK is the set of modifiers present in SYMBOL's name.
3094 This is similar to parse_modifiers_uncached, but uses the cache in
3095 SYMBOL's Qevent_symbol_element_mask property, and maintains the
3096 Qevent_symbol_elements property. */
3098 parse_modifiers (symbol
)
3101 Lisp_Object elements
;
3103 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
3104 if (CONSP (elements
))
3109 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
3110 Lisp_Object unmodified
;
3113 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
3114 XSYMBOL (symbol
)->name
->size
- end
),
3117 if (modifiers
& ~((1<<VALBITS
) - 1))
3119 XFASTINT (mask
) = modifiers
;
3120 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
3122 /* Cache the parsing results on SYMBOL. */
3123 Fput (symbol
, Qevent_symbol_element_mask
,
3125 Fput (symbol
, Qevent_symbol_elements
,
3126 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
3128 /* Since we know that SYMBOL is modifiers applied to unmodified,
3129 it would be nice to put that in unmodified's cache.
3130 But we can't, since we're not sure that parse_modifiers is
3137 /* Apply the modifiers MODIFIERS to the symbol BASE.
3138 BASE must be unmodified.
3140 This is like apply_modifiers_uncached, but uses BASE's
3141 Qmodifier_cache property, if present. It also builds
3142 Qevent_symbol_elements properties, since it has that info anyway.
3144 apply_modifiers copies the value of BASE's Qevent_kind property to
3145 the modified symbol. */
3147 apply_modifiers (modifiers
, base
)
3151 Lisp_Object cache
, index
, entry
, new_symbol
;
3153 /* Mask out upper bits. We don't know where this value's been. */
3154 modifiers
&= (1<<VALBITS
) - 1;
3156 /* The click modifier never figures into cache indices. */
3157 cache
= Fget (base
, Qmodifier_cache
);
3158 XFASTINT (index
) = (modifiers
& ~click_modifier
);
3159 entry
= Fassq (index
, cache
);
3162 new_symbol
= XCONS (entry
)->cdr
;
3165 /* We have to create the symbol ourselves. */
3166 new_symbol
= apply_modifiers_uncached (modifiers
,
3167 XSYMBOL (base
)->name
->data
,
3168 XSYMBOL (base
)->name
->size
);
3170 /* Add the new symbol to the base's cache. */
3171 entry
= Fcons (index
, new_symbol
);
3172 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
3174 /* We have the parsing info now for free, so add it to the caches. */
3175 XFASTINT (index
) = modifiers
;
3176 Fput (new_symbol
, Qevent_symbol_element_mask
,
3177 Fcons (base
, Fcons (index
, Qnil
)));
3178 Fput (new_symbol
, Qevent_symbol_elements
,
3179 Fcons (base
, lispy_modifier_list (modifiers
)));
3182 /* Make sure this symbol is of the same kind as BASE.
3184 You'd think we could just set this once and for all when we
3185 intern the symbol above, but reorder_modifiers may call us when
3186 BASE's property isn't set right; we can't assume that just
3187 because it has a Qmodifier_cache property it must have its
3188 Qevent_kind set right as well. */
3189 if (NILP (Fget (new_symbol
, Qevent_kind
)))
3193 kind
= Fget (base
, Qevent_kind
);
3195 Fput (new_symbol
, Qevent_kind
, kind
);
3202 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
3203 return a symbol with the modifiers placed in the canonical order.
3204 Canonical order is alphabetical, except for down and drag, which
3205 always come last. The 'click' modifier is never written out.
3207 Fdefine_key calls this to make sure that (for example) C-M-foo
3208 and M-C-foo end up being equivalent in the keymap. */
3211 reorder_modifiers (symbol
)
3214 /* It's hopefully okay to write the code this way, since everything
3215 will soon be in caches, and no consing will be done at all. */
3218 parsed
= parse_modifiers (symbol
);
3219 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
3220 XCONS (parsed
)->car
);
3224 /* For handling events, we often want to produce a symbol whose name
3225 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
3226 to some base, like the name of a function key or mouse button.
3227 modify_event_symbol produces symbols of this sort.
3229 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
3230 is the name of the i'th symbol. TABLE_SIZE is the number of elements
3233 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
3234 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
3236 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
3237 persist between calls to modify_event_symbol that it can use to
3238 store a cache of the symbols it's generated for this NAME_TABLE
3239 before. The object stored there may be a vector or an alist.
3241 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
3243 MODIFIERS is a set of modifier bits (as given in struct input_events)
3244 whose prefixes should be applied to the symbol name.
3246 SYMBOL_KIND is the value to be placed in the event_kind property of
3247 the returned symbol.
3249 The symbols we create are supposed to have an
3250 `event-symbol-elements' property, which lists the modifiers present
3251 in the symbol's name. */
3254 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
3255 name_table
, symbol_table
, table_size
)
3258 Lisp_Object symbol_kind
;
3259 Lisp_Object name_alist
;
3261 Lisp_Object
*symbol_table
;
3265 Lisp_Object symbol_int
;
3267 XSET (symbol_int
, Lisp_Int
, symbol_num
);
3269 /* Is this a request for a valid symbol? */
3270 if (symbol_num
< 0 || symbol_num
>= table_size
)
3273 if (CONSP (*symbol_table
))
3274 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
3276 /* If *symbol_table doesn't seem to be initialized properly, fix that.
3277 *symbol_table should be a lisp vector TABLE_SIZE elements long,
3278 where the Nth element is the symbol for NAME_TABLE[N], or nil if
3279 we've never used that symbol before. */
3282 if (! VECTORP (*symbol_table
)
3283 || XVECTOR (*symbol_table
)->size
!= table_size
)
3287 XFASTINT (size
) = table_size
;
3288 *symbol_table
= Fmake_vector (size
, Qnil
);
3291 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
3294 /* Have we already used this symbol before? */
3297 /* No; let's create it. */
3298 if (!NILP (name_alist
))
3299 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
3300 else if (name_table
[symbol_num
])
3301 value
= intern (name_table
[symbol_num
]);
3306 sprintf (buf
, "key-%d", symbol_num
);
3307 value
= intern (buf
);
3310 if (CONSP (*symbol_table
))
3311 *symbol_table
= Fcons (value
, *symbol_table
);
3313 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
3315 /* Fill in the cache entries for this symbol; this also
3316 builds the Qevent_symbol_elements property, which the user
3318 apply_modifiers (modifiers
& click_modifier
, value
);
3319 Fput (value
, Qevent_kind
, symbol_kind
);
3322 /* Apply modifiers to that symbol. */
3323 return apply_modifiers (modifiers
, value
);
3327 /* Store into *addr a value nonzero if terminal input chars are available.
3328 Serves the purpose of ioctl (0, FIONREAD, addr)
3329 but works even if FIONREAD does not exist.
3330 (In fact, this may actually read some input.) */
3333 get_input_pending (addr
)
3336 /* First of all, have we already counted some input? */
3337 *addr
= !NILP (Vquit_flag
) || readable_events ();
3339 /* If input is being read as it arrives, and we have none, there is none. */
3340 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
3343 /* Try to read some input and see how much we get. */
3345 *addr
= !NILP (Vquit_flag
) || readable_events ();
3348 /* Interface to read_avail_input, blocking SIGIO if necessary. */
3351 gobble_input (expected
)
3356 if (interrupt_input
)
3359 mask
= sigblockx (SIGIO
);
3360 read_avail_input (expected
);
3365 read_avail_input (expected
);
3369 /* Put a buffer_switch_event in the buffer
3370 so that read_key_sequence will notice the new current buffer. */
3372 record_asynch_buffer_change ()
3374 struct input_event event
;
3375 event
.kind
= buffer_switch_event
;
3376 event
.frame_or_window
= Qnil
;
3378 /* Make sure no interrupt happens while storing the event. */
3380 if (interrupt_input
)
3383 mask
= sigblockx (SIGIO
);
3384 kbd_buffer_store_event (&event
);
3391 kbd_buffer_store_event (&event
);
3398 /* Read any terminal input already buffered up by the system
3399 into the kbd_buffer, but do not wait.
3401 EXPECTED should be nonzero if the caller knows there is some input.
3403 Except on VMS, all input is read by this function.
3404 If interrupt_input is nonzero, this function MUST be called
3405 only when SIGIO is blocked.
3407 Returns the number of keyboard chars read, or -1 meaning
3408 this is a bad time to try to read input. */
3411 read_avail_input (expected
)
3414 struct input_event buf
[KBD_BUFFER_SIZE
];
3418 if (read_socket_hook
)
3419 /* No need for FIONREAD or fcntl; just say don't wait. */
3420 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
3423 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
3424 the kbd_buffer can really hold. That may prevent loss
3425 of characters on some systems when input is stuffed at us. */
3426 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
3429 /* Determine how many characters we should *try* to read. */
3431 n_to_read
= dos_keysns ();
3434 #else /* not MSDOS */
3436 /* Find out how much input is available. */
3437 if (ioctl (0, FIONREAD
, &n_to_read
) < 0)
3438 /* Formerly simply reported no input, but that sometimes led to
3439 a failure of Emacs to terminate.
3440 SIGHUP seems appropriate if we can't reach the terminal. */
3441 /* ??? Is it really right to send the signal just to this process
3442 rather than to the whole process group?
3443 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3444 kill (getpid (), SIGHUP
);
3447 if (n_to_read
> sizeof cbuf
)
3448 n_to_read
= sizeof cbuf
;
3449 #else /* no FIONREAD */
3450 #if defined(USG) || defined(DGUX)
3451 /* Read some input if available, but don't wait. */
3452 n_to_read
= sizeof cbuf
;
3453 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
3458 #endif /* not MSDOS */
3460 /* Now read; for one reason or another, this will not block.
3461 NREAD is set to the number of chars read. */
3465 cbuf
[0] = dos_keyread();
3468 nread
= read (fileno (stdin
), cbuf
, n_to_read
);
3470 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
3471 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3472 This looks incorrect, but it isn't, because _BSD causes
3473 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3474 and that causes a value other than 0 when there is no input. */
3480 /* We used to retry the read if it was interrupted.
3481 But this does the wrong thing when O_NDELAY causes
3482 an EAGAIN error. Does anybody know of a situation
3483 where a retry is actually needed? */
3485 nread
< 0 && (errno
== EAGAIN
3499 #if defined (USG) || defined (DGUX)
3500 fcntl (fileno (stdin
), F_SETFL
, 0);
3501 #endif /* USG or DGUX */
3502 #endif /* no FIONREAD */
3503 for (i
= 0; i
< nread
; i
++)
3505 buf
[i
].kind
= ascii_keystroke
;
3506 buf
[i
].modifiers
= 0;
3507 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3508 buf
[i
].modifiers
= meta_modifier
;
3512 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
3514 XSET (buf
[i
].frame_or_window
, Lisp_Frame
, selected_frame
);
3516 buf
[i
].frame_or_window
= Qnil
;
3521 /* Scan the chars for C-g and store them in kbd_buffer. */
3522 for (i
= 0; i
< nread
; i
++)
3524 kbd_buffer_store_event (&buf
[i
]);
3525 /* Don't look at input that follows a C-g too closely.
3526 This reduces lossage due to autorepeat on C-g. */
3527 if (buf
[i
].kind
== ascii_keystroke
3528 && XINT(buf
[i
].code
) == quit_char
)
3534 #endif /* not VMS */
3536 #ifdef SIGIO /* for entire page */
3537 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3540 input_available_signal (signo
)
3543 /* Must preserve main program's value of errno. */
3544 int old_errno
= errno
;
3546 extern int select_alarmed
;
3550 /* USG systems forget handlers when they are used;
3551 must reestablish each time */
3552 signal (signo
, input_available_signal
);
3559 if (input_available_clear_time
)
3560 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3565 nread
= read_avail_input (1);
3566 /* -1 means it's not ok to read the input now.
3567 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3568 0 means there was no keyboard input available. */
3573 select_alarmed
= 1; /* Force the select emulator back to life */
3584 /* Send ourselves a SIGIO.
3586 This function exists so that the UNBLOCK_INPUT macro in
3587 blockinput.h can have some way to take care of input we put off
3588 dealing with, without assuming that every file which uses
3589 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3591 reinvoke_input_signal ()
3600 /* Return the prompt-string of a sparse keymap.
3601 This is the first element which is a string.
3602 Return nil if there is none. */
3610 register Lisp_Object tem
;
3612 if (XTYPE (tem
) == Lisp_String
)
3619 static void menu_bar_item ();
3620 static void menu_bar_one_keymap ();
3622 /* These variables hold the vector under construction within
3623 menu_bar_items and its subroutines, and the current index
3624 for storing into that vector. */
3625 static Lisp_Object menu_bar_items_vector
;
3626 static Lisp_Object menu_bar_items_index
;
3628 /* Return a vector of menu items for a menu bar, appropriate
3629 to the current buffer. Each item has three elements in the vector:
3632 OLD is an old vector we can optionally reuse, or nil. */
3635 menu_bar_items (old
)
3638 /* The number of keymaps we're scanning right now, and the number of
3639 keymaps we have allocated space for. */
3642 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3643 in the current keymaps, or nil where it is not a prefix. */
3646 Lisp_Object def
, tem
, tail
;
3655 struct gcpro gcpro1
;
3657 /* In order to build the menus, we need to call the keymap
3658 accessors. They all call QUIT. But this function is called
3659 during redisplay, during which a quit is fatal. So inhibit
3660 quitting while building the menus.
3661 We do this instead of specbind because (1) errors will clear it anyway
3662 and (2) this avoids risk of specpdl overflow. */
3663 oquit
= Vinhibit_quit
;
3667 menu_bar_items_vector
= old
;
3669 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
3670 menu_bar_items_index
= 0;
3672 GCPRO1 (menu_bar_items_vector
);
3674 /* Build our list of keymaps.
3675 If we recognize a function key and replace its escape sequence in
3676 keybuf with its symbol, or if the sequence starts with a mouse
3677 click and we need to switch buffers, we jump back here to rebuild
3678 the initial keymaps from the current buffer. */
3682 if (!NILP (Voverriding_local_map
))
3685 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3686 maps
[0] = Voverriding_local_map
;
3690 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3691 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3692 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3693 #ifdef USE_TEXT_PROPERTIES
3694 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3696 maps
[nmaps
-2] = current_buffer
->keymap
;
3699 maps
[nmaps
-1] = current_global_map
;
3702 /* Look up in each map the dummy prefix key `menu-bar'. */
3706 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3708 if (! NILP (maps
[mapno
]))
3709 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3713 tem
= Fkeymapp (def
);
3715 menu_bar_one_keymap (def
);
3718 /* Move to the end those items that should be at the end. */
3720 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3723 int end
= menu_bar_items_index
;
3725 for (i
= 0; i
< end
; i
+= 3)
3726 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3728 Lisp_Object tem0
, tem1
, tem2
;
3729 /* Move the item at index I to the end,
3730 shifting all the others forward. */
3731 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
3732 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
3733 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
3735 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
3736 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
3737 (end
- i
- 3) * sizeof (Lisp_Object
));
3738 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem0
;
3739 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem1
;
3740 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem2
;
3745 /* Add nil, nil, nil at the end. */
3746 i
= menu_bar_items_index
;
3747 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
3750 int newsize
= 2 * i
;
3751 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
3752 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
3753 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
3754 menu_bar_items_vector
= tem
;
3756 /* Add this item. */
3757 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3758 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3759 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3760 menu_bar_items_index
= i
;
3762 Vinhibit_quit
= oquit
;
3764 return menu_bar_items_vector
;
3767 /* Scan one map KEYMAP, accumulating any menu items it defines
3768 in menu_bar_items_vector. */
3771 menu_bar_one_keymap (keymap
)
3774 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3776 /* Loop over all keymap entries that have menu strings. */
3777 for (tail
= keymap
; XTYPE (tail
) == Lisp_Cons
; tail
= XCONS (tail
)->cdr
)
3779 item
= XCONS (tail
)->car
;
3780 if (XTYPE (item
) == Lisp_Cons
)
3782 key
= XCONS (item
)->car
;
3783 binding
= XCONS (item
)->cdr
;
3784 if (XTYPE (binding
) == Lisp_Cons
)
3786 item_string
= XCONS (binding
)->car
;
3787 if (XTYPE (item_string
) == Lisp_String
)
3788 menu_bar_item (key
, item_string
, Fcdr (binding
));
3790 else if (EQ (binding
, Qundefined
))
3791 menu_bar_item (key
, Qnil
, binding
);
3793 else if (XTYPE (item
) == Lisp_Vector
)
3795 /* Loop over the char values represented in the vector. */
3796 int len
= XVECTOR (item
)->size
;
3798 for (c
= 0; c
< len
; c
++)
3800 Lisp_Object character
;
3801 XFASTINT (character
) = c
;
3802 binding
= XVECTOR (item
)->contents
[c
];
3803 if (XTYPE (binding
) == Lisp_Cons
)
3805 item_string
= XCONS (binding
)->car
;
3806 if (XTYPE (item_string
) == Lisp_String
)
3807 menu_bar_item (key
, item_string
, Fcdr (binding
));
3809 else if (EQ (binding
, Qundefined
))
3810 menu_bar_item (key
, Qnil
, binding
);
3816 /* This is used as the handler when calling internal_condition_case_1. */
3819 menu_bar_item_1 (arg
)
3825 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
3826 If there's already an item for KEY, add this DEF to it. */
3829 menu_bar_item (key
, item_string
, def
)
3830 Lisp_Object key
, item_string
, def
;
3833 Lisp_Object enabled
;
3836 if (EQ (def
, Qundefined
))
3838 /* If a map has an explicit `undefined' as definition,
3839 discard any previously made menu bar item. */
3841 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
3842 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3844 if (menu_bar_items_index
> i
+ 3)
3845 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
3846 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
3847 (menu_bar_items_index
- i
- 3) * sizeof (Lisp_Object
));
3848 menu_bar_items_index
-= 3;
3852 /* If there's no definition for this key yet,
3853 just ignore `undefined'. */
3857 /* See if this entry is enabled. */
3860 if (XTYPE (def
) == Lisp_Symbol
)
3862 /* No property, or nil, means enable.
3863 Otherwise, enable if value is not nil. */
3864 tem
= Fget (def
, Qmenu_enable
);
3866 /* (condition-case nil (eval tem)
3868 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
3872 /* Ignore this item if it's not enabled. */
3876 /* Find any existing item for this KEY. */
3877 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
3878 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3881 /* If we did not find this KEY, add it at the end. */
3882 if (i
== menu_bar_items_index
)
3884 /* If vector is too small, get a bigger one. */
3885 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
3888 int newsize
= 2 * i
;
3889 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
3890 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
3891 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
3892 menu_bar_items_vector
= tem
;
3894 /* Add this item. */
3895 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
3896 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
3897 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (def
, Qnil
);
3898 menu_bar_items_index
= i
;
3900 /* We did find an item for this KEY. Add DEF to its list of maps. */
3904 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
3905 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (def
, old
);
3909 /* Read a character using menus based on maps in the array MAPS.
3910 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
3911 Return t if we displayed a menu but the user rejected it.
3913 PREV_EVENT is the previous input event, or nil if we are reading
3914 the first event of a key sequence.
3916 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3917 if we used a mouse menu to read the input, or zero otherwise. If
3918 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
3920 The prompting is done based on the prompt-string of the map
3921 and the strings associated with various map elements.
3923 This can be done with X menus or with menus put in the minibuf.
3924 These are done in different ways, depending on how the input will be read.
3925 Menus using X are done after auto-saving in read-char, getting the input
3926 event from Fx_popup_menu; menus using the minibuf use read_char recursively
3927 and do auto-saving in the inner call of read_char. */
3930 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
3933 Lisp_Object prev_event
;
3934 int *used_mouse_menu
;
3937 register Lisp_Object name
;
3938 Lisp_Object rest
, vector
;
3940 if (used_mouse_menu
)
3941 *used_mouse_menu
= 0;
3943 /* Use local over global Menu maps */
3945 if (! menu_prompting
)
3948 /* Get the menu name from the first map that has one (a prompt string). */
3949 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3951 name
= map_prompt (maps
[mapno
]);
3956 /* If we don't have any menus, just read a character normally. */
3960 #ifdef HAVE_X_WINDOWS
3962 /* If we got to this point via a mouse click,
3963 use a real menu for mouse selection. */
3964 if (EVENT_HAS_PARAMETERS (prev_event
))
3966 /* Display the menu and get the selection. */
3967 Lisp_Object
*realmaps
3968 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
3972 /* Use the maps that are not nil. */
3973 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3974 if (!NILP (maps
[mapno
]))
3975 realmaps
[nmaps1
++] = maps
[mapno
];
3977 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
3980 /* If we got more than one event, put all but the first
3981 onto this list to be read later.
3982 Return just the first event now. */
3983 Vunread_command_events
3984 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
3985 value
= XCONS (value
)->car
;
3987 else if (NILP (value
))
3989 if (used_mouse_menu
)
3990 *used_mouse_menu
= 1;
3993 #endif /* HAVE_X_MENU */
3994 #endif /* HAVE_X_WINDOWS */
3999 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
4005 register Lisp_Object name
;
4007 int width
= FRAME_WIDTH (selected_frame
) - 4;
4008 char *menu
= (char *) alloca (width
+ 4);
4011 Lisp_Object rest
, vector
;
4013 if (! menu_prompting
)
4016 /* Get the menu name from the first map that has one (a prompt string). */
4017 for (mapno
= 0; mapno
< nmaps
; mapno
++)
4019 name
= map_prompt (maps
[mapno
]);
4024 /* If we don't have any menus, just read a character normally. */
4028 /* Prompt string always starts with map's prompt, and a space. */
4029 strcpy (menu
, XSTRING (name
)->data
);
4030 nlength
= XSTRING (name
)->size
;
4031 menu
[nlength
++] = ':';
4032 menu
[nlength
++] = ' ';
4035 /* Start prompting at start of first map. */
4039 /* Present the documented bindings, a line at a time. */
4046 int orig_defn_macro
;
4048 /* Loop over elements of map. */
4053 /* If reached end of map, start at beginning of next map. */
4057 /* At end of last map, wrap around to first map if just starting,
4058 or end this line if already have something on it. */
4062 if (notfirst
|| nobindings
) break;
4067 /* Look at the next element of the map. */
4069 elt
= XVECTOR (vector
)->contents
[idx
];
4071 elt
= Fcar_safe (rest
);
4073 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
4075 /* If we found a dense table in the keymap,
4076 advanced past it, but start scanning its contents. */
4077 rest
= Fcdr_safe (rest
);
4083 /* An ordinary element. */
4085 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
4087 s
= Fcar_safe(elt
); /* vector */
4088 if (XTYPE (s
) != Lisp_String
)
4089 /* Ignore the element if it has no prompt string. */
4091 /* If we have room for the prompt string, add it to this line.
4092 If this is the first on the line, always add it. */
4093 else if (XSTRING (s
)->size
+ i
+ 2 < width
4098 /* Punctuate between strings. */
4101 strcpy (menu
+ i
, ", ");
4107 /* Add as much of string as fits. */
4108 thiswidth
= XSTRING (s
)->size
;
4109 if (thiswidth
+ i
> width
)
4110 thiswidth
= width
- i
;
4111 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
4117 /* If this element does not fit, end the line now,
4118 and save the element for the next line. */
4119 strcpy (menu
+ i
, "...");
4123 /* Move past this element. */
4124 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
4125 /* Handle reaching end of dense table. */
4130 rest
= Fcdr_safe (rest
);
4134 /* Prompt with that and read response. */
4137 /* Make believe its not a keyboard macro in case the help char
4138 is pressed. Help characters are not recorded because menu prompting
4139 is not used on replay.
4141 orig_defn_macro
= defining_kbd_macro
;
4142 defining_kbd_macro
= 0 ;
4144 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
4145 while (XTYPE (obj
) == Lisp_Buffer
);
4146 defining_kbd_macro
= orig_defn_macro
;
4148 if (XTYPE (obj
) != Lisp_Int
)
4153 if (! EQ (obj
, menu_prompt_more_char
)
4154 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
4155 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
4157 if ( defining_kbd_macro
)
4158 store_kbd_macro_char(obj
) ;
4161 /* Help char - go round again */
4165 /* Reading key sequences. */
4167 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
4168 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
4169 keymap, or nil otherwise. Return the index of the first keymap in
4170 which KEY has any binding, or NMAPS if no map has a binding.
4172 If KEY is a meta ASCII character, treat it like meta-prefix-char
4173 followed by the corresponding non-meta character. Keymaps in
4174 CURRENT with non-prefix bindings for meta-prefix-char become nil in
4177 When KEY is not defined in any of the keymaps, if it is an upper
4178 case letter and there are bindings for the corresponding lower-case
4179 letter, return the bindings for the lower-case letter.
4180 We store 1 in *CASE_CONVERTED in this case.
4181 Otherwise, we don't change *CASE_CONVERTED.
4183 If KEY has no bindings in any of the CURRENT maps, NEXT is left
4186 NEXT may == CURRENT. */
4189 follow_key (key
, nmaps
, current
, defs
, next
, case_converted
)
4191 Lisp_Object
*current
, *defs
, *next
;
4193 int *case_converted
;
4195 int i
, first_binding
;
4197 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
4198 followed by the corresponding non-meta character. */
4199 if (XTYPE (key
) == Lisp_Int
&& (XINT (key
) & CHAR_META
))
4201 for (i
= 0; i
< nmaps
; i
++)
4202 if (! NILP (current
[i
]))
4205 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
4207 /* Note that since we pass the resulting bindings through
4208 get_keymap_1, non-prefix bindings for meta-prefix-char
4210 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
4216 XSET (key
, Lisp_Int
, XFASTINT (key
) & ~CHAR_META
);
4219 first_binding
= nmaps
;
4220 for (i
= nmaps
- 1; i
>= 0; i
--)
4222 if (! NILP (current
[i
]))
4224 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
4225 if (! NILP (defs
[i
]))
4232 /* When KEY is not defined in any of the keymaps, if it is an upper
4233 case letter and there are bindings for the corresponding
4234 lower-case letter, return the bindings for the lower-case letter. */
4235 if (first_binding
== nmaps
4236 && XTYPE (key
) == Lisp_Int
4237 && ((((XINT (key
) & 0x3ffff)
4238 < XSTRING (current_buffer
->downcase_table
)->size
)
4239 && UPPERCASEP (XINT (key
) & 0x3ffff))
4240 || (XINT (key
) & shift_modifier
)))
4242 if (XINT (key
) & shift_modifier
)
4243 XSETINT (key
, XINT (key
) & ~shift_modifier
);
4245 XSETINT (key
, (DOWNCASE (XINT (key
) & 0x3ffff)
4246 | (XINT (key
) & ~0x3ffff)));
4248 first_binding
= nmaps
;
4249 for (i
= nmaps
- 1; i
>= 0; i
--)
4251 if (! NILP (current
[i
]))
4253 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
4254 if (! NILP (defs
[i
]))
4260 if (first_binding
!= nmaps
)
4261 *case_converted
= 1;
4264 /* Given the set of bindings we've found, produce the next set of maps. */
4265 if (first_binding
< nmaps
)
4266 for (i
= 0; i
< nmaps
; i
++)
4267 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
4269 return first_binding
;
4272 /* Read a sequence of keys that ends with a non prefix character,
4273 storing it in KEYBUF, a buffer of size BUFSIZE.
4275 Return the length of the key sequence stored.
4276 Return -1 if the user rejected a command menu.
4278 Echo starting immediately unless `prompt' is 0.
4280 Where a key sequence ends depends on the currently active keymaps.
4281 These include any minor mode keymaps active in the current buffer,
4282 the current buffer's local map, and the global map.
4284 If a key sequence has no other bindings, we check Vfunction_key_map
4285 to see if some trailing subsequence might be the beginning of a
4286 function key's sequence. If so, we try to read the whole function
4287 key, and substitute its symbolic name into the key sequence.
4289 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
4290 `double-' events into similar click events, if that would make them
4291 bound. We try to turn `triple-' events first into `double-' events,
4294 If we get a mouse click in a mode line, vertical divider, or other
4295 non-text area, we treat the click as if it were prefixed by the
4296 symbol denoting that area - `mode-line', `vertical-line', or
4299 If the sequence starts with a mouse click, we read the key sequence
4300 with respect to the buffer clicked on, not the current buffer.
4302 If the user switches frames in the midst of a key sequence, we put
4303 off the switch-frame event until later; the next call to
4304 read_char will return it. */
4307 read_key_sequence (keybuf
, bufsize
, prompt
)
4308 Lisp_Object
*keybuf
;
4312 int count
= specpdl_ptr
- specpdl
;
4314 /* How many keys there are in the current key sequence. */
4317 /* The length of the echo buffer when we started reading, and
4318 the length of this_command_keys when we started reading. */
4322 /* The number of keymaps we're scanning right now, and the number of
4323 keymaps we have allocated space for. */
4325 int nmaps_allocated
= 0;
4327 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
4328 the current keymaps. */
4331 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
4332 in the current keymaps, or nil where it is not a prefix. */
4333 Lisp_Object
*submaps
;
4335 /* The index in defs[] of the first keymap that has a binding for
4336 this key sequence. In other words, the lowest i such that
4337 defs[i] is non-nil. */
4340 /* If t < mock_input, then KEYBUF[t] should be read as the next
4343 We use this to recover after recognizing a function key. Once we
4344 realize that a suffix of the current key sequence is actually a
4345 function key's escape sequence, we replace the suffix with the
4346 function key's binding from Vfunction_key_map. Now keybuf
4347 contains a new and different key sequence, so the echo area,
4348 this_command_keys, and the submaps and defs arrays are wrong. In
4349 this situation, we set mock_input to t, set t to 0, and jump to
4350 restart_sequence; the loop will read keys from keybuf up until
4351 mock_input, thus rebuilding the state; and then it will resume
4352 reading characters from the keyboard. */
4355 /* If the sequence is unbound in submaps[], then
4356 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
4357 and fkey_map is its binding.
4359 These might be > t, indicating that all function key scanning
4360 should hold off until t reaches them. We do this when we've just
4361 recognized a function key, to avoid searching for the function
4362 key's again in Vfunction_key_map. */
4363 int fkey_start
= 0, fkey_end
= 0;
4364 Lisp_Object fkey_map
;
4366 /* Likewise, for key_translation_map. */
4367 int keytran_start
= 0, keytran_end
= 0;
4368 Lisp_Object keytran_map
;
4370 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
4371 we put it off for later. While we're reading, we keep the event here. */
4372 Lisp_Object delayed_switch_frame
;
4374 /* See the comment below... */
4375 #if defined (GOBBLE_FIRST_EVENT)
4376 Lisp_Object first_event
;
4379 struct buffer
*starting_buffer
;
4381 /* Nonzero if we found the binding for one of the chars
4382 in this key sequence by downcasing it. */
4383 int case_converted
= 0;
4385 /* Nonzero if we seem to have got the beginning of a binding
4386 in function_key_map. */
4387 int function_key_possible
= 0;
4391 last_nonmenu_event
= Qnil
;
4393 delayed_switch_frame
= Qnil
;
4394 fkey_map
= Vfunction_key_map
;
4395 keytran_map
= Vkey_translation_map
;
4397 /* If there is no function-key-map, turn off function key scanning. */
4398 if (NILP (Fkeymapp (Vfunction_key_map
)))
4399 fkey_start
= fkey_end
= bufsize
+ 1;
4401 /* If there is no key-translation-map, turn off scanning. */
4402 if (NILP (Fkeymapp (Vkey_translation_map
)))
4403 keytran_start
= keytran_end
= bufsize
+ 1;
4408 echo_prompt (XSTRING (prompt
)->data
);
4409 else if (cursor_in_echo_area
)
4410 /* This doesn't put in a dash if the echo buffer is empty, so
4411 you don't always see a dash hanging out in the minibuffer. */
4415 /* Record the initial state of the echo area and this_command_keys;
4416 we will need to restore them if we replay a key sequence. */
4418 echo_start
= echo_length ();
4419 keys_start
= this_command_key_count
;
4421 #if defined (GOBBLE_FIRST_EVENT)
4422 /* This doesn't quite work, because some of the things that read_char
4423 does cannot safely be bypassed. It seems too risky to try to make
4426 /* Read the first char of the sequence specially, before setting
4427 up any keymaps, in case a filter runs and switches buffers on us. */
4428 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
4430 #endif /* GOBBLE_FIRST_EVENT */
4432 /* We jump here when the key sequence has been thoroughly changed, and
4433 we need to rescan it starting from the beginning. When we jump here,
4434 keybuf[0..mock_input] holds the sequence we should reread. */
4437 starting_buffer
= current_buffer
;
4439 function_key_possible
= 0;
4441 /* Build our list of keymaps.
4442 If we recognize a function key and replace its escape sequence in
4443 keybuf with its symbol, or if the sequence starts with a mouse
4444 click and we need to switch buffers, we jump back here to rebuild
4445 the initial keymaps from the current buffer. */
4449 if (!NILP (Voverriding_local_map
))
4452 if (nmaps
> nmaps_allocated
)
4454 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4455 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4456 nmaps_allocated
= nmaps
;
4458 submaps
[0] = Voverriding_local_map
;
4462 nmaps
= current_minor_maps (0, &maps
) + 2;
4463 if (nmaps
> nmaps_allocated
)
4465 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4466 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4467 nmaps_allocated
= nmaps
;
4469 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
4470 #ifdef USE_TEXT_PROPERTIES
4471 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
4473 submaps
[nmaps
-2] = current_buffer
->keymap
;
4476 submaps
[nmaps
-1] = current_global_map
;
4479 /* Find an accurate initial value for first_binding. */
4480 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
4481 if (! NILP (submaps
[first_binding
]))
4484 /* Start from the beginning in keybuf. */
4487 /* These are no-ops the first time through, but if we restart, they
4488 revert the echo area and this_command_keys to their original state. */
4489 this_command_key_count
= keys_start
;
4490 if (INTERACTIVE
&& t
< mock_input
)
4491 echo_truncate (echo_start
);
4493 /* If the best binding for the current key sequence is a keymap, or
4494 we may be looking at a function key's escape sequence, keep on
4496 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
4497 || (first_binding
>= nmaps
4499 /* mock input is never part of a function key's sequence. */
4500 && mock_input
<= fkey_start
)
4501 || (first_binding
>= nmaps
4502 && keytran_start
< t
4503 /* mock input is never part of a function key's sequence. */
4504 && mock_input
<= keytran_start
)
4505 /* Don't return in the middle of a possible function key sequence,
4506 if the only bindings we found were via case conversion.
4507 Thus, if ESC O a has a function-key-map translation
4508 and ESC o has a binding, don't return after ESC O,
4509 so that we can translate ESC O plus the next character. */
4510 || (function_key_possible
&& case_converted
))
4513 int used_mouse_menu
= 0;
4515 /* Where the last real key started. If we need to throw away a
4516 key that has expanded into more than one element of keybuf
4517 (say, a mouse click on the mode line which is being treated
4518 as [mode-line (mouse-...)], then we backtrack to this point
4520 int last_real_key_start
;
4522 /* These variables are analogous to echo_start and keys_start;
4523 while those allow us to restart the entire key sequence,
4524 echo_local_start and keys_local_start allow us to throw away
4526 int echo_local_start
, keys_local_start
, local_first_binding
;
4529 error ("key sequence too long");
4532 echo_local_start
= echo_length ();
4533 keys_local_start
= this_command_key_count
;
4534 local_first_binding
= first_binding
;
4537 /* These are no-ops, unless we throw away a keystroke below and
4538 jumped back up to replay_key; in that case, these restore the
4539 variables to their original state, allowing us to replay the
4541 if (INTERACTIVE
&& t
< mock_input
)
4542 echo_truncate (echo_local_start
);
4543 this_command_key_count
= keys_local_start
;
4544 first_binding
= local_first_binding
;
4546 /* By default, assume each event is "real". */
4547 last_real_key_start
= t
;
4549 /* Does mock_input indicate that we are re-reading a key sequence? */
4553 add_command_key (key
);
4557 /* If not, we should actually read a character. */
4560 struct buffer
*buf
= current_buffer
;
4562 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
4565 /* read_char returns t when it shows a menu and the user rejects it.
4570 /* read_char returns -1 at the end of a macro.
4571 Emacs 18 handles this by returning immediately with a
4572 zero, so that's what we'll do. */
4573 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) == -1)
4579 /* If the current buffer has been changed from under us, the
4580 keymap may have changed, so replay the sequence. */
4581 if (XTYPE (key
) == Lisp_Buffer
)
4584 goto replay_sequence
;
4587 /* If we have a quit that was typed in another frame, and
4588 quit_throw_to_read_char switched buffers,
4589 replay to get the right keymap. */
4590 if (EQ (key
, quit_char
) && current_buffer
!= starting_buffer
)
4595 goto replay_sequence
;
4601 /* Clicks in non-text areas get prefixed by the symbol
4602 in their CHAR-ADDRESS field. For example, a click on
4603 the mode line is prefixed by the symbol `mode-line'.
4605 Furthermore, key sequences beginning with mouse clicks
4606 are read using the keymaps of the buffer clicked on, not
4607 the current buffer. So we may have to switch the buffer
4610 When we turn one event into two events, we must make sure
4611 that neither of the two looks like the original--so that,
4612 if we replay the events, they won't be expanded again.
4613 If not for this, such reexpansion could happen either here
4614 or when user programs play with this-command-keys. */
4615 if (EVENT_HAS_PARAMETERS (key
))
4619 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
4620 if (EQ (kind
, Qmouse_click
))
4622 Lisp_Object window
, posn
;
4624 window
= POSN_WINDOW (EVENT_START (key
));
4625 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4626 if (XTYPE (posn
) == Lisp_Cons
)
4628 /* We're looking at the second event of a
4629 sequence which we expanded before. Set
4630 last_real_key_start appropriately. */
4632 last_real_key_start
= t
- 1;
4635 /* Key sequences beginning with mouse clicks are
4636 read using the keymaps in the buffer clicked on,
4637 not the current buffer. If we're at the
4638 beginning of a key sequence, switch buffers. */
4639 if (last_real_key_start
== 0
4640 && XTYPE (window
) == Lisp_Window
4641 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
4642 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
4647 /* Arrange to go back to the original buffer once we're
4648 done reading the key sequence. Note that we can't
4649 use save_excursion_{save,restore} here, because they
4650 save point as well as the current buffer; we don't
4651 want to save point, because redisplay may change it,
4652 to accommodate a Fset_window_start or something. We
4653 don't want to do this at the top of the function,
4654 because we may get input from a subprocess which
4655 wants to change the selected window and stuff (say,
4657 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
4659 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
4660 goto replay_sequence
;
4662 else if (XTYPE (posn
) == Lisp_Symbol
)
4664 /* Expand mode-line and scroll-bar events into two events:
4665 use posn as a fake prefix key. */
4667 if (t
+ 1 >= bufsize
)
4668 error ("key sequence too long");
4673 /* Zap the position in key, so we know that we've
4674 expanded it, and don't try to do so again. */
4675 POSN_BUFFER_POSN (EVENT_START (key
))
4676 = Fcons (posn
, Qnil
);
4680 else if (EQ (kind
, Qswitch_frame
))
4682 /* If we're at the beginning of a key sequence, go
4683 ahead and return this event. If we're in the
4684 midst of a key sequence, delay it until the end. */
4687 delayed_switch_frame
= key
;
4691 else if (CONSP (XCONS (key
)->cdr
)
4692 && CONSP (EVENT_START (key
))
4693 && CONSP (XCONS (EVENT_START (key
))->cdr
))
4697 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4698 /* Handle menu-bar events:
4699 insert the dummy prefix event `menu-bar'. */
4700 if (EQ (posn
, Qmenu_bar
))
4702 if (t
+ 1 >= bufsize
)
4703 error ("key sequence too long");
4704 /* Run the Lucid hook. */
4705 if (!NILP (Vrun_hooks
))
4706 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4707 /* If it has changed current-menubar from previous value,
4708 really recompute the menubar from the value. */
4709 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4710 call0 (Qrecompute_lucid_menubar
);
4714 /* Zap the position in key, so we know that we've
4715 expanded it, and don't try to do so again. */
4716 POSN_BUFFER_POSN (EVENT_START (key
))
4717 = Fcons (posn
, Qnil
);
4720 goto replay_sequence
;
4722 else if (XTYPE (posn
) == Lisp_Cons
)
4724 /* We're looking at the second event of a
4725 sequence which we expanded before. Set
4726 last_real_key_start appropriately. */
4727 if (last_real_key_start
== t
&& t
> 0)
4728 last_real_key_start
= t
- 1;
4733 /* We have finally decided that KEY is something we might want
4735 first_binding
= (follow_key (key
,
4736 nmaps
- first_binding
,
4737 submaps
+ first_binding
,
4738 defs
+ first_binding
,
4739 submaps
+ first_binding
,
4743 /* If KEY wasn't bound, we'll try some fallbacks. */
4744 if (first_binding
>= nmaps
)
4748 head
= EVENT_HEAD (key
);
4749 if (EQ (head
, Vhelp_char
))
4751 read_key_sequence_cmd
= Vprefix_help_command
;
4753 last_nonmenu_event
= key
;
4757 if (XTYPE (head
) == Lisp_Symbol
)
4759 Lisp_Object breakdown
;
4762 breakdown
= parse_modifiers (head
);
4763 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4764 /* Attempt to reduce an unbound mouse event to a simpler
4765 event that is bound:
4766 Drags reduce to clicks.
4767 Double-clicks reduce to clicks.
4768 Triple-clicks reduce to double-clicks, then to clicks.
4769 Down-clicks are eliminated.
4770 Double-downs reduce to downs, then are eliminated.
4771 Triple-downs reduce to double-downs, then to downs,
4772 then are eliminated. */
4773 if (modifiers
& (down_modifier
| drag_modifier
4774 | double_modifier
| triple_modifier
))
4776 while (modifiers
& (down_modifier
| drag_modifier
4777 | double_modifier
| triple_modifier
))
4779 Lisp_Object new_head
, new_click
;
4780 if (modifiers
& triple_modifier
)
4781 modifiers
^= (double_modifier
| triple_modifier
);
4782 else if (modifiers
& (drag_modifier
| double_modifier
))
4783 modifiers
&= ~(drag_modifier
| double_modifier
);
4786 /* Dispose of this `down' event by simply jumping
4787 back to replay_key, to get another event.
4789 Note that if this event came from mock input,
4790 then just jumping back to replay_key will just
4791 hand it to us again. So we have to wipe out any
4794 We could delete keybuf[t] and shift everything
4795 after that to the left by one spot, but we'd also
4796 have to fix up any variable that points into
4797 keybuf, and shifting isn't really necessary
4800 Adding prefixes for non-textual mouse clicks
4801 creates two characters of mock input, and both
4802 must be thrown away. If we're only looking at
4803 the prefix now, we can just jump back to
4804 replay_key. On the other hand, if we've already
4805 processed the prefix, and now the actual click
4806 itself is giving us trouble, then we've lost the
4807 state of the keymaps we want to backtrack to, and
4808 we need to replay the whole sequence to rebuild
4811 Beyond that, only function key expansion could
4812 create more than two keys, but that should never
4813 generate mouse events, so it's okay to zero
4814 mock_input in that case too.
4816 Isn't this just the most wonderful code ever? */
4817 if (t
== last_real_key_start
)
4824 mock_input
= last_real_key_start
;
4825 goto replay_sequence
;
4830 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
4832 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
4834 /* Look for a binding for this new key. follow_key
4835 promises that it didn't munge submaps the
4836 last time we called it, since key was unbound. */
4838 = (follow_key (new_click
,
4839 nmaps
- local_first_binding
,
4840 submaps
+ local_first_binding
,
4841 defs
+ local_first_binding
,
4842 submaps
+ local_first_binding
,
4844 + local_first_binding
);
4846 /* If that click is bound, go for it. */
4847 if (first_binding
< nmaps
)
4852 /* Otherwise, we'll leave key set to the drag event. */
4859 /* Normally, last_nonmenu_event gets the previous key we read.
4860 But when a mouse popup menu is being used,
4861 we don't update last_nonmenu_event; it continues to hold the mouse
4862 event that preceded the first level of menu. */
4863 if (!used_mouse_menu
)
4864 last_nonmenu_event
= key
;
4866 /* If the sequence is unbound, see if we can hang a function key
4867 off the end of it. We only want to scan real keyboard input
4868 for function key sequences, so if mock_input says that we're
4869 re-reading old events, don't examine it. */
4870 if ((first_binding
>= nmaps
|| case_converted
)
4873 Lisp_Object fkey_next
;
4875 /* Continue scan from fkey_end until we find a bound suffix.
4876 If we fail, increment fkey_start
4877 and start fkey_end from there. */
4878 while (fkey_end
< t
)
4882 key
= keybuf
[fkey_end
++];
4883 /* Look up meta-characters by prefixing them
4884 with meta_prefix_char. I hate this. */
4885 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4890 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
4892 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4895 fkey_next
= fkey_map
;
4898 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
4900 #if 0 /* I didn't turn this on, because it might cause trouble
4901 for the mapping of return into C-m and tab into C-i. */
4902 /* Optionally don't map function keys into other things.
4903 This enables the user to redefine kp- keys easily. */
4904 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
4908 /* If the function key map gives a function, not an
4909 array, then call the function with no args and use
4910 its value instead. */
4911 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
4914 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4918 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4919 fkey_next
= call1 (fkey_next
, prompt
);
4921 /* If the function returned something invalid,
4922 barf--don't ignore it.
4923 (To ignore it safely, we would need to gcpro a bunch of
4924 other variables.) */
4925 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
4926 error ("Function in function-key-map returns invalid key sequence");
4929 function_key_possible
= ! NILP (fkey_next
);
4931 /* If keybuf[fkey_start..fkey_end] is bound in the
4932 function key map and it's a suffix of the current
4933 sequence (i.e. fkey_end == t), replace it with
4934 the binding and restart with fkey_start at the end. */
4935 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
4938 int len
= XFASTINT (Flength (fkey_next
));
4940 t
= fkey_start
+ len
;
4942 error ("key sequence too long");
4944 if (VECTORP (fkey_next
))
4945 bcopy (XVECTOR (fkey_next
)->contents
,
4946 keybuf
+ fkey_start
,
4947 (t
- fkey_start
) * sizeof (keybuf
[0]));
4948 else if (STRINGP (fkey_next
))
4952 for (i
= 0; i
< len
; i
++)
4953 XFASTINT (keybuf
[fkey_start
+ i
])
4954 = XSTRING (fkey_next
)->data
[i
];
4958 fkey_start
= fkey_end
= t
;
4959 fkey_map
= Vfunction_key_map
;
4961 goto replay_sequence
;
4964 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
4966 /* If we no longer have a bound suffix, try a new positions for
4968 if (NILP (fkey_map
))
4970 fkey_end
= ++fkey_start
;
4971 fkey_map
= Vfunction_key_map
;
4972 function_key_possible
= 0;
4977 /* Look for this sequence in key-translation-map. */
4979 Lisp_Object keytran_next
;
4981 /* Scan from keytran_end until we find a bound suffix. */
4982 while (keytran_end
< t
)
4986 key
= keybuf
[keytran_end
++];
4987 /* Look up meta-characters by prefixing them
4988 with meta_prefix_char. I hate this. */
4989 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4994 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
4996 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4999 keytran_next
= keytran_map
;
5002 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
5004 /* If the key translation map gives a function, not an
5005 array, then call the function with no args and use
5006 its value instead. */
5007 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
5008 && keytran_end
== t
)
5010 struct gcpro gcpro1
, gcpro2
, gcpro3
;
5014 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
5015 keytran_next
= call1 (keytran_next
, prompt
);
5017 /* If the function returned something invalid,
5018 barf--don't ignore it.
5019 (To ignore it safely, we would need to gcpro a bunch of
5020 other variables.) */
5021 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
5022 error ("Function in key-translation-map returns invalid key sequence");
5025 /* If keybuf[keytran_start..keytran_end] is bound in the
5026 key translation map and it's a suffix of the current
5027 sequence (i.e. keytran_end == t), replace it with
5028 the binding and restart with keytran_start at the end. */
5029 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
5030 && keytran_end
== t
)
5032 int len
= XFASTINT (Flength (keytran_next
));
5034 t
= keytran_start
+ len
;
5036 error ("key sequence too long");
5038 if (VECTORP (keytran_next
))
5039 bcopy (XVECTOR (keytran_next
)->contents
,
5040 keybuf
+ keytran_start
,
5041 (t
- keytran_start
) * sizeof (keybuf
[0]));
5042 else if (STRINGP (keytran_next
))
5046 for (i
= 0; i
< len
; i
++)
5047 XFASTINT (keybuf
[keytran_start
+ i
])
5048 = XSTRING (keytran_next
)->data
[i
];
5052 keytran_start
= keytran_end
= t
;
5053 keytran_map
= Vkey_translation_map
;
5055 goto replay_sequence
;
5058 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
5060 /* If we no longer have a bound suffix, try a new positions for
5062 if (NILP (keytran_map
))
5064 keytran_end
= ++keytran_start
;
5065 keytran_map
= Vkey_translation_map
;
5071 read_key_sequence_cmd
= (first_binding
< nmaps
5072 ? defs
[first_binding
]
5076 unread_switch_frame
= delayed_switch_frame
;
5077 unbind_to (count
, Qnil
);
5079 /* Occasionally we fabricate events, perhaps by expanding something
5080 according to function-key-map, or by adding a prefix symbol to a
5081 mouse click in the scroll bar or modeline. In this cases, return
5082 the entire generated key sequence, even if we hit an unbound
5083 prefix or a definition before the end. This means that you will
5084 be able to push back the event properly, and also means that
5085 read-key-sequence will always return a logical unit.
5088 for (; t
< mock_input
; t
++)
5090 echo_char (keybuf
[t
]);
5091 add_command_key (keybuf
[t
]);
5097 #if 0 /* This doc string is too long for some compilers.
5098 This commented-out definition serves for DOC. */
5099 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
5100 "Read a sequence of keystrokes and return as a string or vector.\n\
5101 The sequence is sufficient to specify a non-prefix command in the\n\
5102 current local and global maps.\n\
5104 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
5105 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
5106 as a continuation of the previous key.\n\
5108 A C-g typed while in this function is treated like any other character,\n\
5109 and `quit-flag' is not set.\n\
5111 If the key sequence starts with a mouse click, then the sequence is read\n\
5112 using the keymaps of the buffer of the window clicked in, not the buffer\n\
5113 of the selected window as normal.\n\
5115 `read-key-sequence' drops unbound button-down events, since you normally\n\
5116 only care about the click or drag events which follow them. If a drag\n\
5117 or multi-click event is unbound, but the corresponding click event would\n\
5118 be bound, `read-key-sequence' turns the event into a click event at the\n\
5119 drag's starting position. This means that you don't have to distinguish\n\
5120 between click and drag, double, or triple events unless you want to.\n\
5122 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
5123 lines separating windows, and scroll bars with imaginary keys\n\
5124 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
5126 If the user switches frames in the middle of a key sequence, the\n\
5127 frame-switch event is put off until after the current key sequence.\n\
5129 `read-key-sequence' checks `function-key-map' for function key\n\
5130 sequences, where they wouldn't conflict with ordinary bindings. See\n\
5131 `function-key-map' for more details.")
5132 (prompt
, continue_echo
)
5135 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
5137 (prompt
, continue_echo
)
5138 Lisp_Object prompt
, continue_echo
;
5140 Lisp_Object keybuf
[30];
5142 struct gcpro gcpro1
, gcpro2
;
5145 CHECK_STRING (prompt
, 0);
5148 bzero (keybuf
, sizeof keybuf
);
5150 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
5152 if (NILP (continue_echo
))
5153 this_command_key_count
= 0;
5155 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])), prompt
);
5163 return make_event_array (i
, keybuf
);
5166 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
5167 "Execute CMD as an editor command.\n\
5168 CMD must be a symbol that satisfies the `commandp' predicate.\n\
5169 Optional second arg RECORD-FLAG non-nil\n\
5170 means unconditionally put this command in `command-history'.\n\
5171 Otherwise, that is done only if an arg is read using the minibuffer.")
5173 Lisp_Object cmd
, record
;
5175 register Lisp_Object final
;
5176 register Lisp_Object tem
;
5177 Lisp_Object prefixarg
;
5178 struct backtrace backtrace
;
5179 extern int debug_on_next_call
;
5181 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
5182 Vcurrent_prefix_arg
= prefixarg
;
5183 debug_on_next_call
= 0;
5185 if (XTYPE (cmd
) == Lisp_Symbol
)
5187 tem
= Fget (cmd
, Qdisabled
);
5188 if (!NILP (tem
) && !NILP (Vrun_hooks
))
5189 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
5194 final
= Findirect_function (cmd
);
5196 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
5197 do_autoload (final
, cmd
);
5202 if (XTYPE (final
) == Lisp_String
5203 || XTYPE (final
) == Lisp_Vector
)
5205 /* If requested, place the macro in the command history. For
5206 other sorts of commands, call-interactively takes care of
5210 = Fcons (Fcons (Qexecute_kbd_macro
,
5211 Fcons (final
, Fcons (prefixarg
, Qnil
))),
5214 return Fexecute_kbd_macro (final
, prefixarg
);
5216 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
5217 || XTYPE (final
) == Lisp_Compiled
)
5219 backtrace
.next
= backtrace_list
;
5220 backtrace_list
= &backtrace
;
5221 backtrace
.function
= &Qcall_interactively
;
5222 backtrace
.args
= &cmd
;
5223 backtrace
.nargs
= 1;
5224 backtrace
.evalargs
= 0;
5226 tem
= Fcall_interactively (cmd
, record
);
5228 backtrace_list
= backtrace
.next
;
5234 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
5236 "Read function name, then read its arguments and call it.")
5238 Lisp_Object prefixarg
;
5240 Lisp_Object function
;
5242 Lisp_Object saved_keys
;
5243 struct gcpro gcpro1
;
5245 saved_keys
= Fvector (this_command_key_count
,
5246 XVECTOR (this_command_keys
)->contents
);
5248 GCPRO1 (saved_keys
);
5250 if (EQ (prefixarg
, Qminus
))
5252 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
5253 strcpy (buf
, "C-u ");
5254 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
5255 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
5256 else if (XTYPE (prefixarg
) == Lisp_Int
)
5257 sprintf (buf
, "%d ", XINT (prefixarg
));
5259 /* This isn't strictly correct if execute-extended-command
5260 is bound to anything else. Perhaps it should use
5261 this_command_keys? */
5262 strcat (buf
, "M-x ");
5264 /* Prompt with buf, and then read a string, completing from and
5265 restricting to the set of all defined commands. Don't provide
5266 any initial input. Save the command read on the extended-command
5268 function
= Fcompleting_read (build_string (buf
),
5269 Vobarray
, Qcommandp
,
5270 Qt
, Qnil
, Qextended_command_history
);
5272 /* Set this_command_keys to the concatenation of saved_keys and
5273 function, followed by a RET. */
5275 struct Lisp_String
*str
;
5280 this_command_key_count
= 0;
5282 keys
= XVECTOR (saved_keys
)->contents
;
5283 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
5284 add_command_key (keys
[i
]);
5286 str
= XSTRING (function
);
5287 for (i
= 0; i
< str
->size
; i
++)
5289 XFASTINT (tem
) = str
->data
[i
];
5290 add_command_key (tem
);
5293 XFASTINT (tem
) = '\015';
5294 add_command_key (tem
);
5299 function
= Fintern (function
, Qnil
);
5300 Vprefix_arg
= prefixarg
;
5301 this_command
= function
;
5303 return Fcommand_execute (function
, Qt
);
5307 detect_input_pending ()
5310 get_input_pending (&input_pending
);
5312 return input_pending
;
5315 /* This is called in some cases before a possible quit.
5316 It cases the next call to detect_input_pending to recompute input_pending.
5317 So calling this function unnecessarily can't do any harm. */
5318 clear_input_pending ()
5323 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
5324 "T if command input is currently available with no waiting.\n\
5325 Actually, the value is nil only if we can be sure that no input is available.")
5328 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
5331 return detect_input_pending () ? Qt
: Qnil
;
5334 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
5335 "Return vector of last 100 events, not counting those from keyboard macros.")
5338 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
5341 if (total_keys
< NUM_RECENT_KEYS
)
5342 return Fvector (total_keys
, keys
);
5345 val
= Fvector (NUM_RECENT_KEYS
, keys
);
5346 bcopy (keys
+ recent_keys_index
,
5347 XVECTOR (val
)->contents
,
5348 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
5350 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
5351 recent_keys_index
* sizeof (Lisp_Object
));
5356 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
5357 "Return the key sequence that invoked this command.\n\
5358 The value is a string or a vector.")
5361 return make_event_array (this_command_key_count
,
5362 XVECTOR (this_command_keys
)->contents
);
5365 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
5366 "Return the current depth in recursive edits.")
5370 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
5374 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
5375 "FOpen dribble file: ",
5376 "Start writing all keyboard characters to a dribble file called FILE.\n\
5377 If FILE is nil, close any open dribble file.")
5388 file
= Fexpand_file_name (file
, Qnil
);
5389 dribble
= fopen (XSTRING (file
)->data
, "w");
5394 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
5395 "Discard the contents of the terminal input buffer.\n\
5396 Also cancel any kbd macro being defined.")
5399 defining_kbd_macro
= 0;
5400 update_mode_lines
++;
5402 Vunread_command_events
= Qnil
;
5403 unread_command_char
= -1;
5405 discard_tty_input ();
5407 /* Without the cast, GCC complains that this assignment loses the
5408 volatile qualifier of kbd_store_ptr. Is there anything wrong
5410 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
5411 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5417 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
5418 "Stop Emacs and return to superior process. You can resume later.\n\
5419 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
5420 control, run a subshell instead.\n\n\
5421 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
5422 to be read as terminal input by Emacs's parent, after suspension.\n\
5424 Before suspending, call the functions in `suspend-hook' with no args.\n\
5425 If any of them returns nil, don't call the rest and don't suspend.\n\
5426 Otherwise, suspend normally and after resumption run the normal hook\n\
5427 `suspend-resume-hook' if that is bound and non-nil.\n\
5429 Some operating systems cannot stop the Emacs process and resume it later.\n\
5430 On such systems, Emacs starts a subshell instead of suspending.")
5432 Lisp_Object stuffstring
;
5435 int count
= specpdl_ptr
- specpdl
;
5436 int old_height
, old_width
;
5438 struct gcpro gcpro1
, gcpro2
;
5439 extern init_sys_modes ();
5441 if (!NILP (stuffstring
))
5442 CHECK_STRING (stuffstring
, 0);
5444 /* Run the functions in suspend-hook. */
5445 if (!NILP (Vrun_hooks
))
5446 call1 (Vrun_hooks
, intern ("suspend-hook"));
5448 GCPRO1 (stuffstring
);
5449 get_frame_size (&old_width
, &old_height
);
5451 /* sys_suspend can get an error if it tries to fork a subshell
5452 and the system resources aren't available for that. */
5453 record_unwind_protect (init_sys_modes
, 0);
5454 stuff_buffered_input (stuffstring
);
5459 unbind_to (count
, Qnil
);
5461 /* Check if terminal/window size has changed.
5462 Note that this is not useful when we are running directly
5463 with a window system; but suspend should be disabled in that case. */
5464 get_frame_size (&width
, &height
);
5465 if (width
!= old_width
|| height
!= old_height
)
5466 change_frame_size (selected_frame
, height
, width
, 0, 0);
5468 /* Run suspend-resume-hook. */
5469 if (!NILP (Vrun_hooks
))
5470 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
5476 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
5477 Then in any case stuff anything Emacs has read ahead and not used. */
5479 stuff_buffered_input (stuffstring
)
5480 Lisp_Object stuffstring
;
5482 register unsigned char *p
;
5484 /* stuff_char works only in BSD, versions 4.2 and up. */
5487 if (XTYPE (stuffstring
) == Lisp_String
)
5491 p
= XSTRING (stuffstring
)->data
;
5492 count
= XSTRING (stuffstring
)->size
;
5497 /* Anything we have read ahead, put back for the shell to read. */
5498 while (kbd_fetch_ptr
!= kbd_store_ptr
)
5500 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
5501 kbd_fetch_ptr
= kbd_buffer
;
5502 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
5503 stuff_char (kbd_fetch_ptr
->code
);
5504 kbd_fetch_ptr
->kind
= no_event
;
5505 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
5512 #endif /* BSD and not BSD4_1 */
5515 set_waiting_for_input (time_to_clear
)
5516 EMACS_TIME
*time_to_clear
;
5518 input_available_clear_time
= time_to_clear
;
5520 /* Tell interrupt_signal to throw back to read_char, */
5521 waiting_for_input
= 1;
5523 /* If interrupt_signal was called before and buffered a C-g,
5524 make it run again now, to avoid timing error. */
5525 if (!NILP (Vquit_flag
))
5526 quit_throw_to_read_char ();
5529 clear_waiting_for_input ()
5531 /* Tell interrupt_signal not to throw back to read_char, */
5532 waiting_for_input
= 0;
5533 input_available_clear_time
= 0;
5536 /* This routine is called at interrupt level in response to C-G.
5537 If interrupt_input, this is the handler for SIGINT.
5538 Otherwise, it is called from kbd_buffer_store_event,
5539 in handling SIGIO or SIGTINT.
5541 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
5542 immediately throw back to read_char.
5544 Otherwise it sets the Lisp variable quit-flag not-nil.
5545 This causes eval to throw, when it gets a chance.
5546 If quit-flag is already non-nil, it stops the job right away. */
5552 /* Must preserve main program's value of errno. */
5553 int old_errno
= errno
;
5556 if (!read_socket_hook
&& NILP (Vwindow_system
))
5558 /* USG systems forget handlers when they are used;
5559 must reestablish each time */
5560 signal (SIGINT
, interrupt_signal
);
5561 signal (SIGQUIT
, interrupt_signal
);
5567 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
5572 #ifdef SIGTSTP /* Support possible in later USG versions */
5574 * On systems which can suspend the current process and return to the original
5575 * shell, this command causes the user to end up back at the shell.
5576 * The "Auto-save" and "Abort" questions are not asked until
5577 * the user elects to return to emacs, at which point he can save the current
5578 * job and either dump core or continue.
5583 if (sys_suspend () == -1)
5585 printf ("Not running as a subprocess;\n");
5586 printf ("you can continue or abort.\n");
5589 /* Perhaps should really fork an inferior shell?
5590 But that would not provide any way to get back
5591 to the original shell, ever. */
5592 printf ("No support for stopping a process on this operating system;\n");
5593 printf ("you can continue or abort.\n");
5594 #endif /* not VMS */
5595 #endif /* not SIGTSTP */
5597 /* We must remain inside the screen area when the internal terminal
5598 is used. Note that [Enter] is not echoed by dos. */
5601 printf ("Auto-save? (y or n) ");
5603 if (((c
= getchar ()) & ~040) == 'Y')
5605 Fdo_auto_save (Qt
, Qnil
);
5607 printf ("\r\nAuto-save done");
5608 #else /* not MSDOS */
5609 printf ("Auto-save done\n");
5610 #endif /* not MSDOS */
5612 while (c
!= '\n') c
= getchar ();
5614 printf ("\r\nAbort? (y or n) ");
5615 #else /* not MSDOS */
5617 printf ("Abort (and enter debugger)? (y or n) ");
5619 printf ("Abort (and dump core)? (y or n) ");
5620 #endif /* not VMS */
5621 #endif /* not MSDOS */
5623 if (((c
= getchar ()) & ~040) == 'Y')
5625 while (c
!= '\n') c
= getchar ();
5627 printf ("\r\nContinuing...\r\n");
5628 #else /* not MSDOS */
5629 printf ("Continuing...\n");
5630 #endif /* not MSDOS */
5636 /* If executing a function that wants to be interrupted out of
5637 and the user has not deferred quitting by binding `inhibit-quit'
5638 then quit right away. */
5639 if (immediate_quit
&& NILP (Vinhibit_quit
))
5643 Fsignal (Qquit
, Qnil
);
5646 /* Else request quit when it's safe */
5650 if (waiting_for_input
&& !echoing
)
5651 quit_throw_to_read_char ();
5656 /* Handle a C-g by making read_char return C-g. */
5658 quit_throw_to_read_char ()
5660 quit_error_check ();
5662 /* Prevent another signal from doing this before we finish. */
5663 clear_waiting_for_input ();
5666 Vunread_command_events
= Qnil
;
5667 unread_command_char
= -1;
5669 #ifdef POLL_FOR_INPUT
5670 /* May be > 1 if in recursive minibuffer. */
5671 if (poll_suppress_count
== 0)
5675 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
5676 && XFRAME (internal_last_event_frame
) != selected_frame
)
5677 Fhandle_switch_frame (make_lispy_switch_frame (internal_last_event_frame
));
5680 _longjmp (getcjmp
, 1);
5683 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
5684 "Set mode of reading keyboard input.\n\
5685 First arg INTERRUPT non-nil means use input interrupts;\n\
5686 nil means use CBREAK mode.\n\
5687 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
5688 (no effect except in CBREAK mode).\n\
5689 Third arg META t means accept 8-bit input (for a Meta key).\n\
5690 META nil means ignore the top bit, on the assumption it is parity.\n\
5691 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
5692 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
5693 See also `current-input-mode'.")
5694 (interrupt
, flow
, meta
, quit
)
5695 Lisp_Object interrupt
, flow
, meta
, quit
;
5698 && (XTYPE (quit
) != Lisp_Int
5699 || XINT (quit
) < 0 || XINT (quit
) > 0400))
5700 error ("set-input-mode: QUIT must be an ASCII character");
5702 #ifdef POLL_FOR_INPUT
5708 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5709 #ifdef NO_SOCK_SIGIO
5710 if (read_socket_hook
)
5711 interrupt_input
= 0; /* No interrupts if reading from a socket. */
5713 #endif /* NO_SOCK_SIGIO */
5714 interrupt_input
= !NILP (interrupt
);
5715 #else /* not SIGIO */
5716 interrupt_input
= 0;
5717 #endif /* not SIGIO */
5718 /* Our VMS input only works by interrupts, as of now. */
5720 interrupt_input
= 1;
5722 flow_control
= !NILP (flow
);
5725 else if (EQ (meta
, Qt
))
5730 /* Don't let this value be out of range. */
5731 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
5735 #ifdef POLL_FOR_INPUT
5736 poll_suppress_count
= 1;
5742 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
5743 "Return information about the way Emacs currently reads keyboard input.\n\
5744 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
5745 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
5746 nil, Emacs is using CBREAK mode.\n\
5747 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
5748 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
5749 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
5750 META nil means ignoring the top bit, on the assumption it is parity.\n\
5751 META is neither t nor nil if accepting 8-bit input and using\n\
5752 all 8 bits as the character code.\n\
5753 QUIT is the character Emacs currently uses to quit.\n\
5754 The elements of this list correspond to the arguments of\n\
5760 val
[0] = interrupt_input
? Qt
: Qnil
;
5761 val
[1] = flow_control
? Qt
: Qnil
;
5762 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
5763 XFASTINT (val
[3]) = quit_char
;
5765 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
5771 /* This is correct before outermost invocation of the editor loop */
5772 command_loop_level
= -1;
5774 quit_char
= Ctl ('g');
5775 Vunread_command_events
= Qnil
;
5776 unread_command_char
= -1;
5778 recent_keys_index
= 0;
5779 kbd_fetch_ptr
= kbd_buffer
;
5780 kbd_store_ptr
= kbd_buffer
;
5781 do_mouse_tracking
= 0;
5785 /* This means that command_loop_1 won't try to select anything the first
5787 internal_last_event_frame
= Qnil
;
5788 Vlast_event_frame
= internal_last_event_frame
;
5791 /* If we're running a dumped Emacs, we need to clear out
5792 kbd_buffer_frame_or_window, in case some events got into it
5795 If we're running an undumped Emacs, it hasn't been initialized by
5796 syms_of_keyboard yet. */
5798 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5800 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
5802 signal (SIGINT
, interrupt_signal
);
5803 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
5804 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
5805 SIGQUIT and we can't tell which one it will give us. */
5806 signal (SIGQUIT
, interrupt_signal
);
5807 #endif /* HAVE_TERMIO */
5809 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5811 if (!noninteractive
)
5812 signal (SIGIO
, input_available_signal
);
5815 /* Use interrupt input by default, if it works and noninterrupt input
5816 has deficiencies. */
5818 #ifdef INTERRUPT_INPUT
5819 interrupt_input
= 1;
5821 interrupt_input
= 0;
5824 /* Our VMS input only works by interrupts, as of now. */
5826 interrupt_input
= 1;
5832 if (keyboard_init_hook
)
5833 (*keyboard_init_hook
) ();
5835 #ifdef POLL_FOR_INPUT
5836 poll_suppress_count
= 1;
5841 /* This type's only use is in syms_of_keyboard, to initialize the
5842 event header symbols and put properties on them. */
5849 struct event_head head_table
[] = {
5850 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
5851 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
5852 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
5857 Qdisabled_command_hook
= intern ("disabled-command-hook");
5858 staticpro (&Qdisabled_command_hook
);
5860 Qself_insert_command
= intern ("self-insert-command");
5861 staticpro (&Qself_insert_command
);
5863 Qforward_char
= intern ("forward-char");
5864 staticpro (&Qforward_char
);
5866 Qbackward_char
= intern ("backward-char");
5867 staticpro (&Qbackward_char
);
5869 Qdisabled
= intern ("disabled");
5870 staticpro (&Qdisabled
);
5872 Qundefined
= intern ("undefined");
5873 staticpro (&Qundefined
);
5875 Qpre_command_hook
= intern ("pre-command-hook");
5876 staticpro (&Qpre_command_hook
);
5878 Qpost_command_hook
= intern ("post-command-hook");
5879 staticpro (&Qpost_command_hook
);
5881 Qcommand_hook_internal
= intern ("command-hook-internal");
5882 staticpro (&Qcommand_hook_internal
);
5884 Qfunction_key
= intern ("function-key");
5885 staticpro (&Qfunction_key
);
5886 Qmouse_click
= intern ("mouse-click");
5887 staticpro (&Qmouse_click
);
5889 Qmenu_enable
= intern ("menu-enable");
5890 staticpro (&Qmenu_enable
);
5892 Qmode_line
= intern ("mode-line");
5893 staticpro (&Qmode_line
);
5894 Qvertical_line
= intern ("vertical-line");
5895 staticpro (&Qvertical_line
);
5896 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
5897 staticpro (&Qvertical_scroll_bar
);
5898 Qmenu_bar
= intern ("menu-bar");
5899 staticpro (&Qmenu_bar
);
5901 Qabove_handle
= intern ("above-handle");
5902 staticpro (&Qabove_handle
);
5903 Qhandle
= intern ("handle");
5904 staticpro (&Qhandle
);
5905 Qbelow_handle
= intern ("below-handle");
5906 staticpro (&Qbelow_handle
);
5908 Qevent_kind
= intern ("event-kind");
5909 staticpro (&Qevent_kind
);
5910 Qevent_symbol_elements
= intern ("event-symbol-elements");
5911 staticpro (&Qevent_symbol_elements
);
5912 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
5913 staticpro (&Qevent_symbol_element_mask
);
5914 Qmodifier_cache
= intern ("modifier-cache");
5915 staticpro (&Qmodifier_cache
);
5917 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
5918 staticpro (&Qrecompute_lucid_menubar
);
5919 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
5920 staticpro (&Qactivate_menubar_hook
);
5922 Qpolling_period
= intern ("polling-period");
5923 staticpro (&Qpolling_period
);
5926 struct event_head
*p
;
5928 for (p
= head_table
;
5929 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
5932 *p
->var
= intern (p
->name
);
5934 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
5935 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
5939 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
5940 staticpro (&button_down_location
);
5944 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
5946 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
5947 for (i
= 0; i
< len
; i
++)
5948 if (modifier_names
[i
])
5949 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
5950 staticpro (&modifier_symbols
);
5953 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
5954 staticpro (&recent_keys
);
5956 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
5957 staticpro (&this_command_keys
);
5959 Qextended_command_history
= intern ("extended-command-history");
5960 Fset (Qextended_command_history
, Qnil
);
5961 staticpro (&Qextended_command_history
);
5963 kbd_buffer_frame_or_window
5964 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
5965 staticpro (&kbd_buffer_frame_or_window
);
5967 accent_key_syms
= Qnil
;
5968 staticpro (&accent_key_syms
);
5970 func_key_syms
= Qnil
;
5971 staticpro (&func_key_syms
);
5973 system_key_syms
= Qnil
;
5974 staticpro (&system_key_syms
);
5977 staticpro (&mouse_syms
);
5979 unread_switch_frame
= Qnil
;
5980 staticpro (&unread_switch_frame
);
5982 defsubr (&Sread_key_sequence
);
5983 defsubr (&Srecursive_edit
);
5984 defsubr (&Strack_mouse
);
5985 defsubr (&Sinput_pending_p
);
5986 defsubr (&Scommand_execute
);
5987 defsubr (&Srecent_keys
);
5988 defsubr (&Sthis_command_keys
);
5989 defsubr (&Ssuspend_emacs
);
5990 defsubr (&Sabort_recursive_edit
);
5991 defsubr (&Sexit_recursive_edit
);
5992 defsubr (&Srecursion_depth
);
5993 defsubr (&Stop_level
);
5994 defsubr (&Sdiscard_input
);
5995 defsubr (&Sopen_dribble_file
);
5996 defsubr (&Sset_input_mode
);
5997 defsubr (&Scurrent_input_mode
);
5998 defsubr (&Sexecute_extended_command
);
6000 DEFVAR_LISP ("last-command-char", &last_command_char
,
6001 "Last input event that was part of a command.");
6003 DEFVAR_LISP ("last-command-event", &last_command_char
,
6004 "Last input event that was part of a command.");
6006 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
6007 "Last input event in a command, except for mouse menu events.\n\
6008 Mouse menus give back keys that don't look like mouse events;\n\
6009 this variable holds the actual mouse event that led to the menu,\n\
6010 so that you can determine whether the command was run by mouse or not.");
6012 DEFVAR_LISP ("last-input-char", &last_input_char
,
6013 "Last input event.");
6015 DEFVAR_LISP ("last-input-event", &last_input_char
,
6016 "Last input event.");
6018 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
6019 "List of objects to be read as next command input events.");
6021 DEFVAR_INT ("unread-command-char", &unread_command_char
,
6022 "If not -1, an object to be read as next command input event.");
6024 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
6025 "Meta-prefix character code. Meta-foo as command input\n\
6026 turns into this character followed by foo.");
6027 XSET (meta_prefix_char
, Lisp_Int
, 033);
6029 DEFVAR_LISP ("last-command", &last_command
,
6030 "The last command executed. Normally a symbol with a function definition,\n\
6031 but can be whatever was found in the keymap, or whatever the variable\n\
6032 `this-command' was set to by that command.");
6033 last_command
= Qnil
;
6035 DEFVAR_LISP ("this-command", &this_command
,
6036 "The command now being executed.\n\
6037 The command can set this variable; whatever is put here\n\
6038 will be in `last-command' during the following command.");
6039 this_command
= Qnil
;
6041 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
6042 "*Number of keyboard input characters between auto-saves.\n\
6043 Zero means disable autosaving due to number of characters typed.");
6044 auto_save_interval
= 300;
6046 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
6047 "*Number of seconds idle time before auto-save.\n\
6048 Zero or nil means disable auto-saving due to idleness.\n\
6049 After auto-saving due to this many seconds of idle time,\n\
6050 Emacs also does a garbage collection if that seems to be warranted.");
6051 XFASTINT (Vauto_save_timeout
) = 30;
6053 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
6054 "*Nonzero means echo unfinished commands after this many seconds of pause.");
6055 echo_keystrokes
= 1;
6057 DEFVAR_INT ("polling-period", &polling_period
,
6058 "*Interval between polling for input during Lisp execution.\n\
6059 The reason for polling is to make C-g work to stop a running program.\n\
6060 Polling is needed only when using X windows and SIGIO does not work.\n\
6061 Polling is automatically disabled in all other cases.");
6064 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
6065 "*Maximum time between mouse clicks to make a double-click.\n\
6066 Measured in milliseconds. nil means disable double-click recognition;\n\
6067 t means double-clicks have no time limit and are detected\n\
6068 by position only.");
6069 Vdouble_click_time
= make_number (500);
6071 DEFVAR_INT ("num-input-keys", &num_input_keys
,
6072 "*Number of complete keys read from the keyboard so far.");
6075 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
6076 "*The frame in which the most recently read event occurred.\n\
6077 If the last event came from a keyboard macro, this is set to `macro'.");
6078 Vlast_event_frame
= Qnil
;
6080 DEFVAR_LISP ("help-char", &Vhelp_char
,
6081 "Character to recognize as meaning Help.\n\
6082 When it is read, do `(eval help-form)', and display result if it's a string.\n\
6083 If the value of `help-form' is nil, this char can be read normally.");
6084 XSET (Vhelp_char
, Lisp_Int
, Ctl ('H'));
6086 DEFVAR_LISP ("help-form", &Vhelp_form
,
6087 "Form to execute when character `help-char' is read.\n\
6088 If the form returns a string, that string is displayed.\n\
6089 If `help-form' is nil, the help char is not recognized.");
6092 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
6093 "Command to run when `help-char' character follows a prefix key.\n\
6094 This command is used only when there is no actual binding\n\
6095 for that character after that prefix key.");
6096 Vprefix_help_command
= Qnil
;
6098 DEFVAR_LISP ("top-level", &Vtop_level
,
6099 "Form to evaluate when Emacs starts up.\n\
6100 Useful to set before you dump a modified Emacs.");
6103 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
6104 "String used as translate table for keyboard input, or nil.\n\
6105 Each character is looked up in this string and the contents used instead.\n\
6106 If string is of length N, character codes N and up are untranslated.");
6107 Vkeyboard_translate_table
= Qnil
;
6109 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
6110 "Keymap of key translations that can override keymaps.\n\
6111 This keymap works like `function-key-map', but comes after that,\n\
6112 and applies even for keys that have ordinary bindings.");
6113 Vkey_translation_map
= Qnil
;
6115 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
6116 "Non-nil means to always spawn a subshell instead of suspending,\n\
6117 even if the operating system has support for stopping a process.");
6120 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
6121 "Non-nil means prompt with menus when appropriate.\n\
6122 This is done when reading from a keymap that has a prompt string,\n\
6123 for elements that have prompt strings.\n\
6124 The menu is displayed on the screen\n\
6125 if X menus were enabled at configuration\n\
6126 time and the previous event was a mouse click prefix key.\n\
6127 Otherwise, menu prompting uses the echo area.");
6130 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
6131 "Character to see next line of menu prompt.\n\
6132 Type this character while in a menu prompt to rotate around the lines of it.");
6133 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
6135 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
6136 "A mask of additional modifier keys to use with every keyboard character.\n\
6137 Emacs applies the modifiers of the character stored here to each keyboard\n\
6138 character it reads. For example, after evaluating the expression\n\
6139 (setq extra-keyboard-modifiers ?\C-x)\n\
6140 all input characters will have the control modifier applied to them.\n\
6142 Note that the character ?\C-@, equivalent to the integer zero, does\n\
6143 not count as a control character; rather, it counts as a character\n\
6144 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
6145 cancels any modification.");
6146 extra_keyboard_modifiers
= 0;
6148 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
6149 "If an editing command sets this to t, deactivate the mark afterward.\n\
6150 The command loop sets this to nil before each command,\n\
6151 and tests the value when the command returns.\n\
6152 Buffer modification stores t in this variable.");
6153 Vdeactivate_mark
= Qnil
;
6155 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
6156 "Temporary storage of pre-command-hook or post-command-hook.");
6157 Vcommand_hook_internal
= Qnil
;
6159 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
6160 "Normal hook run before each command is executed.\n\
6161 While the hook is run, its value is temporarily set to nil\n\
6162 to avoid an unbreakable infinite loop if a hook function gets an error.\n\
6163 As a result, a hook function cannot straightforwardly alter the value of\n\
6164 `pre-command-hook'. See the Emacs Lisp manual for a way of\n\
6165 implementing hook functions that alter the set of hook functions.");
6166 Vpre_command_hook
= Qnil
;
6168 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
6169 "Normal hook run after each command is executed.\n\
6170 While the hook is run, its value is temporarily set to nil\n\
6171 to avoid an unbreakable infinite loop if a hook function gets an error.\n\
6172 As a result, a hook function cannot straightforwardly alter the value of\n\
6173 `post-command-hook'. See the Emacs Lisp manual for a way of\n\
6174 implementing hook functions that alter the set of hook functions.");
6175 Vpost_command_hook
= Qnil
;
6177 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
6178 "t means menu bar, specified Lucid style, needs to be recomputed.");
6179 Vlucid_menu_bar_dirty_flag
= Qnil
;
6181 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
6182 "List of menu bar items to move to the end of the menu bar.\n\
6183 The elements of the list are event types that may have menu bar bindings.");
6184 Vmenu_bar_final_items
= Qnil
;
6186 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
6187 "Keymap that overrides all other local keymaps.\n\
6188 If this variable is non-nil, it is used as a keymap instead of the\n\
6189 buffer's local map, and the minor mode keymaps and text property keymaps.");
6190 Voverriding_local_map
= Qnil
;
6192 DEFVAR_BOOL ("track-mouse", &do_mouse_tracking
,
6193 "*Non-nil means generate motion events for mouse motion.");
6195 DEFVAR_LISP ("system-key-alist", &Vsystem_key_alist
,
6196 "Alist of system-specific X windows key symbols.\n\
6197 Each element should have the form (N . SYMBOL) where N is the\n\
6198 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
6199 and SYMBOL is its name.");
6200 Vsystem_key_alist
= Qnil
;
6205 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
6206 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
6207 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
6208 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
6209 initial_define_key (meta_map
, 'x', "execute-extended-command");