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 /* List of deferred actions to be performed at a later time.
301 The precise format isn't relevant here; we just check whether it is nil. */
302 Lisp_Object Vdeferred_action_list
;
304 /* Function to call to handle deferred actions, when there are any. */
305 Lisp_Object Vdeferred_action_function
;
307 /* File in which we write all commands we read. */
310 /* Nonzero if input is available. */
313 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
314 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
318 extern char *pending_malloc_warning
;
320 /* Circular buffer for pre-read keyboard input. */
321 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
323 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
325 The interrupt-level event handlers will never enqueue an event on a
326 frame which is not in Vframe_list, and once an event is dequeued,
327 internal_last_event_frame or the event itself points to the frame.
330 But while the event is sitting in the queue, it's completely
331 unprotected. Suppose the user types one command which will run for
332 a while and then delete a frame, and then types another event at
333 the frame that will be deleted, before the command gets around to
334 it. Suppose there are no references to this frame elsewhere in
335 Emacs, and a GC occurs before the second event is dequeued. Now we
336 have an event referring to a freed frame, which will crash Emacs
339 Similar things happen when an event on a scroll bar is enqueued; the
340 window may be deleted while the event is in the queue.
342 So, we use this vector to protect the frame_or_window field in the
343 event queue. That way, they'll be dequeued as dead frames or
344 windows, but still valid lisp objects.
346 If kbd_buffer[i].kind != no_event, then
347 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
348 == kbd_buffer[i].frame_or_window. */
349 static Lisp_Object kbd_buffer_frame_or_window
;
351 /* Pointer to next available character in kbd_buffer.
352 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
353 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
354 next available char is in kbd_buffer[0]. */
355 static struct input_event
*kbd_fetch_ptr
;
357 /* Pointer to next place to store character in kbd_buffer. This
358 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
359 character should go in kbd_buffer[0]. */
363 static struct input_event
*kbd_store_ptr
;
365 /* The above pair of variables forms a "queue empty" flag. When we
366 enqueue a non-hook event, we increment kbd_write_count. When we
367 dequeue a non-hook event, we increment kbd_read_count. We say that
368 there is input available iff the two counters are not equal.
370 Why not just have a flag set and cleared by the enqueuing and
371 dequeuing functions? Such a flag could be screwed up by interrupts
372 at inopportune times. */
374 /* If this flag is non-zero, we check mouse_moved to see when the
375 mouse moves, and motion events will appear in the input stream. If
376 it is zero, mouse motion is ignored. */
377 static int do_mouse_tracking
;
379 /* The window system handling code should set this if the mouse has
380 moved since the last call to the mouse_position_hook. Calling that
381 hook should clear this. Code assumes that if this is set, it can
382 call mouse_position_hook to get the promised position, so don't set
383 it unless you're prepared to substantiate the claim! */
386 /* True iff there is an event in kbd_buffer, or if mouse tracking is
387 enabled and there is a new mouse position in the mouse movement
388 buffer. Note that if this is false, that doesn't mean that there
389 is readable input; all the events in the queue might be button-up
390 events, and do_mouse_tracking might be off. */
391 #define EVENT_QUEUES_EMPTY \
392 ((kbd_fetch_ptr == kbd_store_ptr) && (!do_mouse_tracking || !mouse_moved))
395 /* Symbols to head events. */
396 Lisp_Object Qmouse_movement
;
397 Lisp_Object Qscroll_bar_movement
;
398 Lisp_Object Qswitch_frame
;
400 /* Symbols to denote kinds of events. */
401 Lisp_Object Qfunction_key
;
402 Lisp_Object Qmouse_click
;
403 /* Lisp_Object Qmouse_movement; - also an event header */
405 /* Properties of event headers. */
406 Lisp_Object Qevent_kind
;
407 Lisp_Object Qevent_symbol_elements
;
409 Lisp_Object Qmenu_enable
;
411 /* An event header symbol HEAD may have a property named
412 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
413 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
414 mask of modifiers applied to it. If present, this is used to help
415 speed up parse_modifiers. */
416 Lisp_Object Qevent_symbol_element_mask
;
418 /* An unmodified event header BASE may have a property named
419 Qmodifier_cache, which is an alist mapping modifier masks onto
420 modified versions of BASE. If present, this helps speed up
422 Lisp_Object Qmodifier_cache
;
424 /* Symbols to use for parts of windows. */
425 Lisp_Object Qmode_line
;
426 Lisp_Object Qvertical_line
;
427 Lisp_Object Qvertical_scroll_bar
;
428 Lisp_Object Qmenu_bar
;
430 extern Lisp_Object Qmenu_enable
;
432 Lisp_Object
recursive_edit_unwind (), command_loop ();
433 Lisp_Object
Fthis_command_keys ();
434 Lisp_Object Qextended_command_history
;
436 Lisp_Object Qpolling_period
;
438 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
440 EMACS_TIME
*input_available_clear_time
;
442 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
443 Default is 1 if INTERRUPT_INPUT is defined. */
446 /* Nonzero while interrupts are temporarily deferred during redisplay. */
447 int interrupts_deferred
;
449 /* nonzero means use ^S/^Q for flow control. */
452 /* Allow m- file to inhibit use of FIONREAD. */
453 #ifdef BROKEN_FIONREAD
457 /* We are unable to use interrupts if FIONREAD is not available,
458 so flush SIGIO so we won't try. */
465 /* If we support X Windows, turn on the code to poll periodically
466 to detect C-g. It isn't actually used when doing interrupt input. */
467 #ifdef HAVE_X_WINDOWS
468 #define POLL_FOR_INPUT
471 /* Global variable declarations. */
473 /* Function for init_keyboard to call with no args (if nonzero). */
474 void (*keyboard_init_hook
) ();
476 static int read_avail_input ();
477 static void get_input_pending ();
478 static int readable_events ();
479 static Lisp_Object
read_char_x_menu_prompt ();
480 static Lisp_Object
read_char_minibuf_menu_prompt ();
481 static Lisp_Object
make_lispy_event ();
482 static Lisp_Object
make_lispy_movement ();
483 static Lisp_Object
modify_event_symbol ();
484 static Lisp_Object
make_lispy_switch_frame ();
486 /* > 0 if we are to echo keystrokes. */
487 static int echo_keystrokes
;
489 /* Nonzero means echo each character as typed. */
490 static int immediate_echo
;
492 /* The text we're echoing in the modeline - partial key sequences,
493 usually. '\0'-terminated. This really shouldn't have a fixed size. */
494 static char echobuf
[300];
496 /* Where to append more text to echobuf if we want to. */
497 static char *echoptr
;
499 /* If we have echoed a prompt string specified by the user,
500 this is its length. Otherwise this is -1. */
501 static int echo_after_prompt
;
503 /* Nonzero means don't try to suspend even if the operating system seems
505 static int cannot_suspend
;
507 #define min(a,b) ((a)<(b)?(a):(b))
508 #define max(a,b) ((a)>(b)?(a):(b))
510 /* Install the string STR as the beginning of the string of echoing,
511 so that it serves as a prompt for the next character.
512 Also start echoing. */
517 int len
= strlen (str
);
519 if (len
> sizeof echobuf
- 4)
520 len
= sizeof echobuf
- 4;
521 bcopy (str
, echobuf
, len
);
522 echoptr
= echobuf
+ len
;
525 echo_after_prompt
= len
;
530 /* Add C to the echo string, if echoing is going on.
531 C can be a character, which is printed prettily ("M-C-x" and all that
532 jazz), or a symbol, whose name is printed. */
537 extern char *push_key_description ();
546 /* If someone has passed us a composite event, use its head symbol. */
549 if (XTYPE (c
) == Lisp_Int
)
551 if (ptr
- echobuf
> sizeof echobuf
- 6)
554 ptr
= push_key_description (XINT (c
), ptr
);
556 else if (XTYPE (c
) == Lisp_Symbol
)
558 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
559 if (((ptr
- echobuf
) + name
->size
+ 4) > sizeof echobuf
)
561 bcopy (name
->data
, ptr
, name
->size
);
565 if (echoptr
== echobuf
&& EQ (c
, Vhelp_char
))
567 strcpy (ptr
, " (Type ? for further options)");
578 /* Temporarily add a dash to the end of the echo string if it's not
579 empty, so that it serves as a mini-prompt for the very next character. */
583 if (!immediate_echo
&& echoptr
== echobuf
)
585 /* Do nothing if we just printed a prompt. */
586 if (echo_after_prompt
== echoptr
- echobuf
)
588 /* Do nothing if not echoing at all. */
592 /* Put a dash at the end of the buffer temporarily,
593 but make it go away when the next character is added. */
600 /* Display the current echo string, and begin echoing if not already
610 for (i
= 0; i
< this_command_key_count
; i
++)
613 c
= XVECTOR (this_command_keys
)->contents
[i
];
614 if (! (EVENT_HAS_PARAMETERS (c
)
615 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
625 if (waiting_for_input
&& !NILP (Vquit_flag
))
626 quit_throw_to_read_char ();
629 /* Turn off echoing, for the start of a new command. */
635 echo_after_prompt
= -1;
638 /* Return the length of the current echo string. */
643 return echoptr
- echobuf
;
646 /* Truncate the current echo message to its first LEN chars.
647 This and echo_char get used by read_key_sequence when the user
648 switches frames while entering a key sequence. */
655 echoptr
= echobuf
+ len
;
656 truncate_echo_area (len
);
660 /* Functions for manipulating this_command_keys. */
662 add_command_key (key
)
665 int size
= XVECTOR (this_command_keys
)->size
;
667 if (this_command_key_count
>= size
)
669 Lisp_Object new_keys
;
671 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
672 bcopy (XVECTOR (this_command_keys
)->contents
,
673 XVECTOR (new_keys
)->contents
,
674 size
* sizeof (Lisp_Object
));
676 this_command_keys
= new_keys
;
679 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
685 int count
= specpdl_ptr
- specpdl
;
688 if (command_loop_level
> 0)
690 specbind (Qstandard_output
, Qt
);
691 specbind (Qstandard_input
, Qt
);
694 val
= command_loop ();
696 Fsignal (Qquit
, Qnil
);
698 return unbind_to (count
, Qnil
);
701 /* When an auto-save happens, record the "time", and don't do again soon. */
705 last_auto_save
= num_nonmacro_input_chars
;
708 /* Make an auto save happen as soon as possible at command level. */
710 force_auto_save_soon ()
712 last_auto_save
= - auto_save_interval
- 1;
714 record_asynch_buffer_change ();
717 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
718 "Invoke the editor command loop recursively.\n\
719 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
720 that tells this function to return.\n\
721 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
722 This function is called by the editor initialization to begin editing.")
725 int count
= specpdl_ptr
- specpdl
;
728 command_loop_level
++;
729 update_mode_lines
= 1;
731 record_unwind_protect (recursive_edit_unwind
,
733 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
737 return unbind_to (count
, Qnil
);
741 recursive_edit_unwind (buffer
)
745 Fset_buffer (buffer
);
747 command_loop_level
--;
748 update_mode_lines
= 1;
756 Lisp_Object errmsg
, tail
, errname
, file_error
;
763 Vstandard_output
= Qt
;
764 Vstandard_input
= Qt
;
765 Vexecuting_macro
= Qnil
;
766 echo_area_glyphs
= 0;
768 /* If the window system or terminal frame hasn't been initialized
769 yet, or we're not interactive, it's best to dump this message out
770 to stderr and exit. */
771 if (! FRAME_MESSAGE_BUF (selected_frame
)
773 stream
= Qexternal_debugging_output
;
781 errname
= Fcar (data
);
783 if (EQ (errname
, Qerror
))
786 if (!CONSP (data
)) data
= Qnil
;
787 errmsg
= Fcar (data
);
792 errmsg
= Fget (errname
, Qerror_message
);
793 file_error
= Fmemq (Qfile_error
,
794 Fget (errname
, Qerror_conditions
));
797 /* Print an error message including the data items.
798 This is done by printing it into a scratch buffer
799 and then making a copy of the text in the buffer. */
801 if (!CONSP (data
)) data
= Qnil
;
805 /* For file-error, make error message by concatenating
806 all the data items. They are all strings. */
807 if (!NILP (file_error
) && !NILP (tail
))
808 errmsg
= XCONS (tail
)->car
, tail
= XCONS (tail
)->cdr
;
810 if (XTYPE (errmsg
) == Lisp_String
)
811 Fprinc (errmsg
, stream
);
813 write_string_1 ("peculiar error", -1, stream
);
815 for (i
= 0; CONSP (tail
); tail
= Fcdr (tail
), i
++)
817 write_string_1 (i
? ", " : ": ", 2, stream
);
818 if (!NILP (file_error
))
819 Fprinc (Fcar (tail
), stream
);
821 Fprin1 (Fcar (tail
), stream
);
825 /* If the window system or terminal frame hasn't been initialized
826 yet, or we're in -batch mode, this error should cause Emacs to exit. */
827 if (! FRAME_MESSAGE_BUF (selected_frame
)
831 Fkill_emacs (make_number (-1));
836 Vinhibit_quit
= Qnil
;
837 return make_number (0);
840 Lisp_Object
command_loop_1 ();
841 Lisp_Object
command_loop_2 ();
842 Lisp_Object
top_level_1 ();
844 /* Entry to editor-command-loop.
845 This level has the catches for exiting/returning to editor command loop.
846 It returns nil to exit recursive edit, t to abort it. */
851 if (command_loop_level
> 0 || minibuf_level
> 0)
853 return internal_catch (Qexit
, command_loop_2
, Qnil
);
858 internal_catch (Qtop_level
, top_level_1
, Qnil
);
859 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
861 /* End of file in -batch run causes exit here. */
867 /* Here we catch errors in execution of commands within the
868 editing loop, and reenter the editing loop.
869 When there is an error, cmd_error runs and returns a non-nil
870 value to us. A value of nil means that cmd_loop_1 itself
871 returned due to end of file (or end of kbd macro). */
876 register Lisp_Object val
;
879 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
888 return Feval (Vtop_level
);
894 /* On entry to the outer level, run the startup file */
895 if (!NILP (Vtop_level
))
896 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
897 else if (!NILP (Vpurify_flag
))
898 message ("Bare impure Emacs (standard Lisp code not loaded)");
900 message ("Bare Emacs (standard Lisp code not loaded)");
904 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
905 "Exit all recursive editing levels.")
908 Fthrow (Qtop_level
, Qnil
);
911 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
912 "Exit from the innermost recursive edit or minibuffer.")
915 if (command_loop_level
> 0 || minibuf_level
> 0)
916 Fthrow (Qexit
, Qnil
);
918 error ("No recursive edit is in progress");
921 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
922 "Abort the command that requested this recursive edit or minibuffer input.")
925 if (command_loop_level
> 0 || minibuf_level
> 0)
928 error ("No recursive edit is in progress");
931 /* This is the actual command reading loop,
932 sans error-handling encapsulation. */
934 Lisp_Object
Fcommand_execute ();
935 static int read_key_sequence ();
936 static void safe_run_hooks ();
941 Lisp_Object cmd
, tem
;
944 Lisp_Object keybuf
[30];
949 struct buffer
*prev_buffer
;
952 Vdeactivate_mark
= Qnil
;
953 waiting_for_input
= 0;
958 this_command_key_count
= 0;
960 /* Make sure this hook runs after commands that get errors and
961 throw to top level. */
962 /* Note that the value cell will never directly contain nil
963 if the symbol is a local variable. */
964 if (!NILP (XSYMBOL (Qpost_command_hook
)->value
) && !NILP (Vrun_hooks
))
965 safe_run_hooks (Qpost_command_hook
);
967 if (!NILP (Vdeferred_action_list
))
968 call0 (Vdeferred_action_function
);
970 /* Do this after running Vpost_command_hook, for consistency. */
971 last_command
= this_command
;
975 /* Install chars successfully executed in kbd macro. */
977 if (defining_kbd_macro
&& NILP (Vprefix_arg
))
978 finalize_kbd_macro_chars ();
980 /* Make sure the current window's buffer is selected. */
981 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
982 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
984 /* Display any malloc warning that just came out. Use while because
985 displaying one warning can cause another. */
987 while (pending_malloc_warning
)
988 display_malloc_warning ();
992 Vdeactivate_mark
= Qnil
;
994 /* If minibuffer on and echo area in use,
995 wait 2 sec and redraw minibuffer. */
997 if (minibuf_level
&& echo_area_glyphs
)
999 /* Bind inhibit-quit to t so that C-g gets read in
1000 rather than quitting back to the minibuffer. */
1001 int count
= specpdl_ptr
- specpdl
;
1002 specbind (Qinhibit_quit
, Qt
);
1003 Fsit_for (make_number (2), Qnil
, Qnil
);
1004 unbind_to (count
, Qnil
);
1006 echo_area_glyphs
= 0;
1008 if (!NILP (Vquit_flag
))
1011 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1016 alloca (0); /* Cause a garbage collection now */
1017 /* Since we can free the most stuff here. */
1018 #endif /* C_ALLOCA */
1022 /* Select the frame that the last event came from. Usually,
1023 switch-frame events will take care of this, but if some lisp
1024 code swallows a switch-frame event, we'll fix things up here.
1025 Is this a good idea? */
1026 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
1027 && XFRAME (internal_last_event_frame
) != selected_frame
)
1028 Fselect_frame (internal_last_event_frame
, Qnil
);
1031 /* If it has changed current-menubar from previous value,
1032 really recompute the menubar from the value. */
1033 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1034 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1035 call0 (Qrecompute_lucid_menubar
);
1037 /* Read next key sequence; i gets its length. */
1038 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), Qnil
);
1042 /* Now we have read a key sequence of length I,
1043 or else I is 0 and we found end of file. */
1045 if (i
== 0) /* End of file -- happens only in */
1046 return Qnil
; /* a kbd macro, at the end. */
1047 /* -1 means read_key_sequence got a menu that was rejected.
1048 Just loop around and read another command. */
1052 this_command_key_count
= 0;
1056 last_command_char
= keybuf
[i
- 1];
1058 /* If the previous command tried to force a specific window-start,
1059 forget about that, in case this command moves point far away
1060 from that position. */
1061 XWINDOW (selected_window
)->force_start
= Qnil
;
1063 cmd
= read_key_sequence_cmd
;
1064 if (!NILP (Vexecuting_macro
))
1066 if (!NILP (Vquit_flag
))
1068 Vexecuting_macro
= Qt
;
1069 QUIT
; /* Make some noise. */
1070 /* Will return since macro now empty. */
1074 /* Do redisplay processing after this command except in special
1075 cases identified below that set no_redisplay to 1.
1076 (actually, there's currently no way to prevent the redisplay,
1077 and no_redisplay is ignored.
1078 Perhaps someday we will really implement it. */
1081 prev_buffer
= current_buffer
;
1082 prev_modiff
= MODIFF
;
1083 last_point_position
= PT
;
1084 XSET (last_point_position_buffer
, Lisp_Buffer
, prev_buffer
);
1086 /* Execute the command. */
1089 /* Note that the value cell will never directly contain nil
1090 if the symbol is a local variable. */
1091 if (!NILP (XSYMBOL (Qpre_command_hook
)->value
) && !NILP (Vrun_hooks
))
1092 safe_run_hooks (Qpre_command_hook
);
1094 if (NILP (this_command
))
1096 /* nil means key is undefined. */
1098 defining_kbd_macro
= 0;
1099 update_mode_lines
= 1;
1105 if (NILP (Vprefix_arg
) && ! no_direct
)
1107 /* Recognize some common commands in common situations and
1108 do them directly. */
1109 if (EQ (this_command
, Qforward_char
) && PT
< ZV
)
1111 struct Lisp_Vector
*dp
1112 = window_display_table (XWINDOW (selected_window
));
1113 lose
= FETCH_CHAR (PT
);
1116 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1117 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1118 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1119 && (lose
>= 0x20 && lose
< 0x7f)))
1120 : (lose
>= 0x20 && lose
< 0x7f))
1121 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1123 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1125 && !windows_or_buffers_changed
1126 && EQ (current_buffer
->selective_display
, Qnil
)
1127 && !detect_input_pending ()
1128 && NILP (Vexecuting_macro
))
1129 no_redisplay
= direct_output_forward_char (1);
1132 else if (EQ (this_command
, Qbackward_char
) && PT
> BEGV
)
1134 struct Lisp_Vector
*dp
1135 = window_display_table (XWINDOW (selected_window
));
1137 lose
= FETCH_CHAR (PT
);
1139 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1140 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1141 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1142 && (lose
>= 0x20 && lose
< 0x7f)))
1143 : (lose
>= 0x20 && lose
< 0x7f))
1144 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1146 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1148 && !windows_or_buffers_changed
1149 && EQ (current_buffer
->selective_display
, Qnil
)
1150 && !detect_input_pending ()
1151 && NILP (Vexecuting_macro
))
1152 no_redisplay
= direct_output_forward_char (-1);
1155 else if (EQ (this_command
, Qself_insert_command
)
1156 /* Try this optimization only on ascii keystrokes. */
1157 && XTYPE (last_command_char
) == Lisp_Int
)
1159 unsigned char c
= XINT (last_command_char
);
1162 if (NILP (Vexecuting_macro
)
1163 && !EQ (minibuf_window
, selected_window
))
1165 if (!nonundocount
|| nonundocount
>= 20)
1172 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1174 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1176 || MODIFF
<= current_buffer
->save_modified
1177 || windows_or_buffers_changed
1178 || !EQ (current_buffer
->selective_display
, Qnil
)
1179 || detect_input_pending ()
1180 || !NILP (Vexecuting_macro
));
1181 value
= internal_self_insert (c
, 0);
1188 && (PT
== ZV
|| FETCH_CHAR (PT
) == '\n'))
1190 struct Lisp_Vector
*dp
1191 = window_display_table (XWINDOW (selected_window
));
1198 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1201 /* Do it only for char codes
1202 that by default display as themselves. */
1203 if (lose
>= 0x20 && lose
<= 0x7e)
1204 no_redisplay
= direct_output_for_insert (lose
);
1206 else if (XTYPE (obj
) == Lisp_Vector
1207 && XVECTOR (obj
)->size
== 1
1208 && (XTYPE (obj
= XVECTOR (obj
)->contents
[0])
1210 /* Insist face not specified in glyph. */
1211 && (XINT (obj
) & ((-1) << 8)) == 0)
1213 = direct_output_for_insert (XINT (obj
));
1217 if (lose
>= 0x20 && lose
<= 0x7e)
1218 no_redisplay
= direct_output_for_insert (lose
);
1225 /* Here for a command that isn't executed directly */
1228 if (NILP (Vprefix_arg
))
1230 Fcommand_execute (this_command
, Qnil
);
1235 /* Note that the value cell will never directly contain nil
1236 if the symbol is a local variable. */
1237 if (!NILP (XSYMBOL (Qpost_command_hook
)->value
) && !NILP (Vrun_hooks
))
1238 safe_run_hooks (Qpost_command_hook
);
1240 if (!NILP (Vdeferred_action_list
))
1241 call0 (Vdeferred_action_function
);
1243 /* If there is a prefix argument,
1244 1) We don't want last_command to be ``universal-argument''
1245 (that would be dumb), so don't set last_command,
1246 2) we want to leave echoing on so that the prefix will be
1247 echoed as part of this key sequence, so don't call
1249 3) we want to leave this_command_key_count non-zero, so that
1250 read_char will realize that it is re-reading a character, and
1251 not echo it a second time. */
1252 if (NILP (Vprefix_arg
))
1254 last_command
= this_command
;
1256 this_command_key_count
= 0;
1259 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1261 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1263 current_buffer
->mark_active
= Qnil
;
1264 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1266 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1267 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1272 /* If we get an error while running the hook, cause the hook variable
1273 to be nil. Also inhibit quits, so that C-g won't cause the hook
1274 to mysteriously evaporate. */
1276 safe_run_hooks (hook
)
1280 int count
= specpdl_ptr
- specpdl
;
1281 specbind (Qinhibit_quit
, Qt
);
1283 /* We read and set the variable with functions,
1284 in case it's buffer-local. */
1285 value
= Vcommand_hook_internal
= Fsymbol_value (hook
);
1287 call1 (Vrun_hooks
, Qcommand_hook_internal
);
1290 unbind_to (count
, Qnil
);
1293 /* Number of seconds between polling for input. */
1296 /* Nonzero means polling for input is temporarily suppressed. */
1297 int poll_suppress_count
;
1299 #ifdef POLL_FOR_INPUT
1300 int polling_for_input
;
1302 /* Handle an alarm once each second and read pending input
1303 so as to handle a C-g if it comces in. */
1306 input_poll_signal ()
1308 if (interrupt_input_blocked
== 0
1309 && !waiting_for_input
)
1310 read_avail_input (0);
1311 signal (SIGALRM
, input_poll_signal
);
1312 alarm (polling_period
);
1317 /* Begin signals to poll for input, if they are appropriate.
1318 This function is called unconditionally from various places. */
1322 #ifdef POLL_FOR_INPUT
1323 if (read_socket_hook
&& !interrupt_input
)
1325 poll_suppress_count
--;
1326 if (poll_suppress_count
== 0)
1328 signal (SIGALRM
, input_poll_signal
);
1329 polling_for_input
= 1;
1330 alarm (polling_period
);
1336 /* Turn off polling. */
1340 #ifdef POLL_FOR_INPUT
1341 if (read_socket_hook
&& !interrupt_input
)
1343 if (poll_suppress_count
== 0)
1345 polling_for_input
= 0;
1348 poll_suppress_count
++;
1353 /* Set the value of poll_suppress_count to COUNT
1354 and start or stop polling accordingly. */
1357 set_poll_suppress_count (count
)
1360 #ifdef POLL_FOR_INPUT
1361 if (count
== 0 && poll_suppress_count
!= 0)
1363 poll_suppress_count
= 1;
1366 else if (count
!= 0 && poll_suppress_count
== 0)
1370 poll_suppress_count
= count
;
1374 /* Bind polling_period to a value at least N.
1375 But don't decrease it. */
1377 bind_polling_period (n
)
1380 #ifdef POLL_FOR_INPUT
1381 int new = polling_period
;
1387 specbind (Qpolling_period
, make_number (new));
1388 /* Start a new alarm with the new period. */
1393 /* Applying the control modifier to CHARACTER. */
1398 /* Save the upper bits here. */
1399 int upper
= c
& ~0177;
1403 /* Everything in the columns containing the upper-case letters
1404 denotes a control character. */
1405 if (c
>= 0100 && c
< 0140)
1409 /* Set the shift modifier for a control char
1410 made from a shifted letter. But only for letters! */
1411 if (oc
>= 'A' && oc
<= 'Z')
1412 c
|= shift_modifier
;
1415 /* The lower-case letters denote control characters too. */
1416 else if (c
>= 'a' && c
<= 'z')
1419 /* Include the bits for control and shift
1420 only if the basic ASCII code can't indicate them. */
1424 /* Replace the high bits. */
1425 c
|= (upper
& ~ctrl_modifier
);
1432 /* Input of single characters from keyboard */
1434 Lisp_Object
print_help ();
1435 static Lisp_Object
kbd_buffer_get_event ();
1437 /* read a character from the keyboard; call the redisplay if needed */
1438 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1439 -1 means do not do redisplay, but do do autosaving.
1442 /* The arguments MAPS and NMAPS are for menu prompting.
1443 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1445 PREV_EVENT is the previous input event, or nil if we are reading
1446 the first event of a key sequence.
1448 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1449 if we used a mouse menu to read the input, or zero otherwise. If
1450 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
1452 Value is t if we showed a menu and the user rejected it. */
1455 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1459 Lisp_Object prev_event
;
1460 int *used_mouse_menu
;
1462 register Lisp_Object c
;
1466 if (CONSP (Vunread_command_events
))
1468 c
= XCONS (Vunread_command_events
)->car
;
1469 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1471 if (this_command_key_count
== 0)
1477 if (unread_command_char
!= -1)
1479 XSET (c
, Lisp_Int
, unread_command_char
);
1480 unread_command_char
= -1;
1482 if (this_command_key_count
== 0)
1488 if (!NILP (Vexecuting_macro
))
1491 /* We set this to Qmacro; since that's not a frame, nobody will
1492 try to switch frames on us, and the selected window will
1495 Since this event came from a macro, it would be misleading to
1496 leave internal_last_event_frame set to wherever the last
1497 real event came from. Normally, a switch-frame event selects
1498 internal_last_event_frame after each command is read, but
1499 events read from a macro should never cause a new frame to be
1501 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1504 /* Exit the macro if we are at the end.
1505 Also, some things replace the macro with t
1506 to force an early exit. */
1507 if (EQ (Vexecuting_macro
, Qt
)
1508 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1510 XSET (c
, Lisp_Int
, -1);
1514 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1515 if (XTYPE (Vexecuting_macro
) == Lisp_String
1516 && (XINT (c
) & 0x80))
1517 XFASTINT (c
) = CHAR_META
| (XINT (c
) & ~0x80);
1519 executing_macro_index
++;
1524 if (!NILP (unread_switch_frame
))
1526 c
= unread_switch_frame
;
1527 unread_switch_frame
= Qnil
;
1529 /* This event should make it into this_command_keys, and get echoed
1530 again, so we go to reread_first, rather than reread. */
1534 /* Don't bother updating menu bars while doing mouse tracking.
1535 We get events very rapidly then, and the menu bar won't be changing.
1536 We do update the menu bar once on entry to Ftrack_mouse. */
1537 if (commandflag
> 0 && !input_pending
&& !detect_input_pending ())
1538 prepare_menu_bars ();
1540 /* Save outer setjmp data, in case called recursively. */
1541 save_getcjmp (save_jump
);
1545 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1548 if (_setjmp (getcjmp
))
1550 XSET (c
, Lisp_Int
, quit_char
);
1552 XSET (internal_last_event_frame
, Lisp_Frame
, selected_frame
);
1553 Vlast_event_frame
= internal_last_event_frame
;
1555 /* If we report the quit char as an event,
1556 don't do so more than once. */
1557 if (!NILP (Vinhibit_quit
))
1563 /* Message turns off echoing unless more keystrokes turn it on again. */
1564 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1567 /* If already echoing, continue. */
1570 /* Try reading a character via menu prompting in the minibuf.
1571 Try this before the sit-for, because the sit-for
1572 would do the wrong thing if we are supposed to do
1573 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1574 after a mouse event so don't try a minibuf menu. */
1576 if (nmaps
> 0 && INTERACTIVE
1577 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1578 /* Don't bring up a menu if we already have another event. */
1579 && NILP (Vunread_command_events
)
1580 && unread_command_char
< 0
1581 && !detect_input_pending ())
1583 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1588 /* If in middle of key sequence and minibuffer not active,
1589 start echoing if enough time elapses. */
1590 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1592 && echo_keystrokes
> 0
1593 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1597 /* After a mouse event, start echoing right away.
1598 This is because we are probably about to display a menu,
1599 and we don't want to delay before doing so. */
1600 if (EVENT_HAS_PARAMETERS (prev_event
))
1604 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1610 /* Maybe auto save due to number of keystrokes or idle time. */
1612 if (commandflag
!= 0
1613 && auto_save_interval
> 0
1614 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1615 && !detect_input_pending ())
1618 save_getcjmp (temp
);
1619 Fdo_auto_save (Qnil
, Qnil
);
1620 restore_getcjmp (temp
);
1623 /* Try reading using an X menu.
1624 This is never confused with reading using the minibuf
1625 because the recursive call of read_char in read_char_minibuf_menu_prompt
1626 does not pass on any keymaps. */
1627 if (nmaps
> 0 && INTERACTIVE
1628 && !NILP (prev_event
) && EVENT_HAS_PARAMETERS (prev_event
)
1629 /* Don't bring up a menu if we already have another event. */
1630 && NILP (Vunread_command_events
)
1631 && unread_command_char
< 0)
1632 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1634 /* Slow down auto saves logarithmically in size of current buffer,
1635 and garbage collect while we're at it. */
1636 if (INTERACTIVE
&& NILP (c
))
1638 int delay_level
, buffer_size
;
1640 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1641 last_non_minibuf_size
= Z
- BEG
;
1642 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1644 while (buffer_size
> 64)
1645 delay_level
++, buffer_size
-= buffer_size
>> 2;
1646 if (delay_level
< 4) delay_level
= 4;
1647 /* delay_level is 4 for files under around 50k, 7 at 100k,
1648 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1650 /* Auto save if enough time goes by without input. */
1651 if (commandflag
!= 0
1652 && num_nonmacro_input_chars
> last_auto_save
1653 && XTYPE (Vauto_save_timeout
) == Lisp_Int
1654 && XINT (Vauto_save_timeout
) > 0)
1657 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1658 tem0
= sit_for (delay
, 0, 1, 1);
1662 save_getcjmp (temp
);
1663 Fdo_auto_save (Qnil
, Qnil
);
1664 restore_getcjmp (temp
);
1666 /* If we have auto-saved and there is still no input
1667 available, garbage collect if there has been enough
1668 consing going on to make it worthwhile. */
1669 if (!detect_input_pending ()
1670 && consing_since_gc
> gc_cons_threshold
/ 2)
1672 Fgarbage_collect ();
1673 /* prepare_menu_bars isn't safe here, but it should
1674 also be unnecessary. */
1681 /* Actually read a character, waiting if necessary. */
1684 c
= kbd_buffer_get_event ();
1687 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1689 prepare_menu_bars ();
1694 /* Terminate Emacs in batch mode if at eof. */
1695 if (noninteractive
&& XTYPE (c
) == Lisp_Int
&& XINT (c
) < 0)
1696 Fkill_emacs (make_number (1));
1698 if (XTYPE (c
) == Lisp_Int
)
1700 /* Add in any extra modifiers, where appropriate. */
1701 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1702 || ((extra_keyboard_modifiers
& 0177) < ' '
1703 && (extra_keyboard_modifiers
& 0177) != 0))
1704 XSETINT (c
, make_ctrl_char (XINT (c
)));
1706 /* Transfer any other modifier bits directly from
1707 extra_keyboard_modifiers to c. Ignore the actual character code
1708 in the low 16 bits of extra_keyboard_modifiers. */
1709 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
1714 restore_getcjmp (save_jump
);
1718 /* Don't wipe the echo area for a trivial event. */
1719 if (XTYPE (c
) != Lisp_Buffer
)
1720 echo_area_glyphs
= 0;
1722 /* Handle things that only apply to characters. */
1723 if (XTYPE (c
) == Lisp_Int
)
1725 /* If kbd_buffer_get_event gave us an EOF, return that. */
1729 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
1730 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1731 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1735 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1736 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1737 recent_keys_index
= 0;
1739 /* Write c to the dribble file. If c is a lispy event, write
1740 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1741 If you, dear reader, have a better idea, you've got the source. :-) */
1744 if (XTYPE (c
) == Lisp_Int
)
1745 putc (XINT (c
), dribble
);
1748 Lisp_Object dribblee
;
1750 /* If it's a structured event, take the event header. */
1751 dribblee
= EVENT_HEAD (c
);
1753 if (XTYPE (dribblee
) == Lisp_Symbol
)
1755 putc ('<', dribble
);
1756 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1757 XSYMBOL (dribblee
)->name
->size
,
1759 putc ('>', dribble
);
1766 store_kbd_macro_char (c
);
1768 num_nonmacro_input_chars
++;
1773 /* Don't echo mouse motion events. */
1774 if (! (EVENT_HAS_PARAMETERS (c
)
1775 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1778 /* Record this character as part of the current key. */
1779 add_command_key (c
);
1781 /* Re-reading in the middle of a command */
1783 last_input_char
= c
;
1786 /* Process the help character specially if enabled */
1787 if (EQ (c
, Vhelp_char
) && !NILP (Vhelp_form
))
1790 count
= specpdl_ptr
- specpdl
;
1792 record_unwind_protect (Fset_window_configuration
,
1793 Fcurrent_window_configuration (Qnil
));
1795 tem0
= Feval (Vhelp_form
);
1796 if (XTYPE (tem0
) == Lisp_String
)
1797 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1801 c
= read_char (0, 0, 0, Qnil
, 0);
1802 while (XTYPE (c
) == Lisp_Buffer
);
1803 /* Remove the help from the frame */
1804 unbind_to (count
, Qnil
);
1805 prepare_menu_bars ();
1807 if (EQ (c
, make_number (040)))
1811 c
= read_char (0, 0, 0, Qnil
, 0);
1812 while (XTYPE (c
) == Lisp_Buffer
);
1823 Fprinc (object
, Qnil
);
1827 /* Copy out or in the info on where C-g should throw to.
1828 This is used when running Lisp code from within get_char,
1829 in case get_char is called recursively.
1830 See read_process_output. */
1835 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1838 restore_getcjmp (temp
)
1841 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1845 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1846 of this function. */
1848 tracking_off (old_value
)
1849 Lisp_Object old_value
;
1851 if (! XFASTINT (old_value
))
1853 do_mouse_tracking
= 0;
1855 /* Redisplay may have been preempted because there was input
1856 available, and it assumes it will be called again after the
1857 input has been processed. If the only input available was
1858 the sort that we have just disabled, then we need to call
1860 if (!readable_events ())
1862 prepare_menu_bars ();
1863 redisplay_preserve_echo_area ();
1864 get_input_pending (&input_pending
);
1869 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1870 "Evaluate BODY with mouse movement events enabled.\n\
1871 Within a `track-mouse' form, mouse motion generates input events that\n\
1872 you can read with `read-event'.\n\
1873 Normally, mouse motion is ignored.")
1877 int count
= specpdl_ptr
- specpdl
;
1880 XSET (val
, Lisp_Int
, do_mouse_tracking
);
1881 record_unwind_protect (tracking_off
, val
);
1883 if (!input_pending
&& !detect_input_pending ())
1884 prepare_menu_bars ();
1886 do_mouse_tracking
= 1;
1888 val
= Fprogn (args
);
1889 return unbind_to (count
, val
);
1892 /* Low level keyboard/mouse input.
1893 kbd_buffer_store_event places events in kbd_buffer, and
1894 kbd_buffer_get_event retrieves them.
1895 mouse_moved indicates when the mouse has moved again, and
1896 *mouse_position_hook provides the mouse position. */
1898 /* Return true iff there are any events in the queue that read-char
1899 would return. If this returns false, a read-char would block. */
1903 return ! EVENT_QUEUES_EMPTY
;
1906 /* Set this for debugging, to have a way to get out */
1909 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
1912 kbd_buffer_store_event (event
)
1913 register struct input_event
*event
;
1915 if (event
->kind
== no_event
)
1918 if (event
->kind
== ascii_keystroke
)
1920 register int c
= event
->code
& 0377;
1922 if (event
->modifiers
& ctrl_modifier
)
1923 c
= make_ctrl_char (c
);
1925 c
|= (event
->modifiers
1926 & (meta_modifier
| alt_modifier
1927 | hyper_modifier
| super_modifier
));
1931 extern SIGTYPE
interrupt_signal ();
1934 /* If this results in a quit_char being returned to Emacs as
1935 input, set Vlast_event_frame properly. If this doesn't
1936 get returned to Emacs as an event, the next event read
1937 will set Vlast_event_frame again, so this is safe to do. */
1941 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
1943 internal_last_event_frame
= event
->frame_or_window
;
1945 internal_last_event_frame
= focus
;
1946 Vlast_event_frame
= internal_last_event_frame
;
1950 last_event_timestamp
= event
->timestamp
;
1951 interrupt_signal ();
1955 if (c
&& c
== stop_character
)
1962 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
1963 kbd_store_ptr
= kbd_buffer
;
1965 /* Don't let the very last slot in the buffer become full,
1966 since that would make the two pointers equal,
1967 and that is indistinguishable from an empty buffer.
1968 Discard the event if it would fill the last slot. */
1969 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
1971 kbd_store_ptr
->kind
= event
->kind
;
1972 if (event
->kind
== selection_request_event
)
1974 /* We must not use the ordinary copying code for this case,
1975 since `part' is an enum and copying it might not copy enough
1977 bcopy (event
, kbd_store_ptr
, sizeof (*event
));
1981 kbd_store_ptr
->code
= event
->code
;
1982 kbd_store_ptr
->part
= event
->part
;
1983 kbd_store_ptr
->frame_or_window
= event
->frame_or_window
;
1984 kbd_store_ptr
->modifiers
= event
->modifiers
;
1985 kbd_store_ptr
->x
= event
->x
;
1986 kbd_store_ptr
->y
= event
->y
;
1987 kbd_store_ptr
->timestamp
= event
->timestamp
;
1989 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
1991 = event
->frame_or_window
);
1997 /* Read one event from the event buffer, waiting if necessary.
1998 The value is a Lisp object representing the event.
1999 The value is nil for an event that should be ignored,
2000 or that was handled here.
2001 We always read and discard one event. */
2004 kbd_buffer_get_event ()
2012 XSET (obj
, Lisp_Int
, c
);
2016 /* Wait until there is input available. */
2019 if (!EVENT_QUEUES_EMPTY
)
2022 /* If the quit flag is set, then read_char will return
2023 quit_char, so that counts as "available input." */
2024 if (!NILP (Vquit_flag
))
2025 quit_throw_to_read_char ();
2027 /* One way or another, wait until input is available; then, if
2028 interrupt handlers have not read it, read it now. */
2031 wait_for_kbd_input ();
2033 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2037 if (EVENT_QUEUES_EMPTY
)
2039 Lisp_Object minus_one
;
2041 XSET (minus_one
, Lisp_Int
, -1);
2042 wait_reading_process_input (0, 0, minus_one
, 1);
2044 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
2045 /* Pass 1 for EXPECT since we just waited to have input. */
2046 read_avail_input (1);
2048 #endif /* not VMS */
2051 /* At this point, we know that there is a readable event available
2052 somewhere. If the event queue is empty, then there must be a
2053 mouse movement enabled and available. */
2054 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2056 struct input_event
*event
;
2058 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2062 last_event_timestamp
= event
->timestamp
;
2066 /* These two kinds of events get special handling
2067 and don't actually appear to the command loop.
2068 We return nil for them. */
2069 if (event
->kind
== selection_request_event
)
2072 x_handle_selection_request (event
);
2073 kbd_fetch_ptr
= event
+ 1;
2075 /* We're getting selection request events, but we don't have
2081 else if (event
->kind
== selection_clear_event
)
2084 x_handle_selection_clear (event
);
2085 kbd_fetch_ptr
= event
+ 1;
2087 /* We're getting selection request events, but we don't have
2093 else if (event
->kind
== delete_window_event
)
2095 Lisp_Object tail
, frame
;
2098 /* If the user destroys the only frame, Emacs should exit.
2099 Count visible frames and iconified frames. */
2100 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2102 frame
= XCONS (tail
)->car
;
2103 if (XTYPE (frame
) != Lisp_Frame
|| EQ (frame
, event
->frame_or_window
))
2106 if (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
))
2113 Fdelete_frame (event
->frame_or_window
, Qt
);
2114 kbd_fetch_ptr
= event
+ 1;
2117 else if (event
->kind
== menu_bar_event
)
2119 /* The event value is in the frame_or_window slot. */
2120 obj
= event
->frame_or_window
;
2121 kbd_fetch_ptr
= event
+ 1;
2123 else if (event
->kind
== buffer_switch_event
)
2125 /* The value doesn't matter here; only the type is tested. */
2126 XSET (obj
, Lisp_Buffer
, current_buffer
);
2127 kbd_fetch_ptr
= event
+ 1;
2129 /* Just discard these, by returning nil.
2130 (They shouldn't be found in the buffer,
2131 but on some machines it appears they do show up.) */
2132 else if (event
->kind
== no_event
)
2133 kbd_fetch_ptr
= event
+ 1;
2135 /* If this event is on a different frame, return a switch-frame this
2136 time, and leave the event in the queue for next time. */
2143 frame
= event
->frame_or_window
;
2144 if (XTYPE (frame
) == Lisp_Window
)
2145 frame
= WINDOW_FRAME (XWINDOW (frame
));
2147 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2151 if (! EQ (frame
, internal_last_event_frame
)
2152 && XFRAME (frame
) != selected_frame
)
2153 obj
= make_lispy_switch_frame (frame
);
2154 internal_last_event_frame
= frame
;
2155 #endif /* MULTI_FRAME */
2157 /* If we didn't decide to make a switch-frame event, go ahead
2158 and build a real event from the queue entry. */
2162 obj
= make_lispy_event (event
);
2164 /* Wipe out this event, to catch bugs. */
2165 event
->kind
= no_event
;
2166 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
2169 kbd_fetch_ptr
= event
+ 1;
2173 /* Try generating a mouse motion event. */
2174 else if (do_mouse_tracking
&& mouse_moved
)
2177 Lisp_Object bar_window
;
2178 enum scroll_bar_part part
;
2182 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
2187 /* Decide if we should generate a switch-frame event. Don't
2188 generate switch-frame events for motion outside of all Emacs
2194 frame
= FRAME_FOCUS_FRAME (f
);
2196 XSET (frame
, Lisp_Frame
, f
);
2198 if (! EQ (frame
, internal_last_event_frame
)
2199 && XFRAME (frame
) != selected_frame
)
2200 obj
= make_lispy_switch_frame (frame
);
2201 internal_last_event_frame
= frame
;
2205 #if defined(MULTI_FRAME) || defined(HAVE_MOUSE)
2206 /* If we didn't decide to make a switch-frame event, go ahead and
2207 return a mouse-motion event. */
2209 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2213 /* We were promised by the above while loop that there was
2214 something for us to read! */
2217 input_pending
= readable_events ();
2220 Vlast_event_frame
= internal_last_event_frame
;
2226 /* Process any events that are not user-visible,
2227 then return, without reading any user-visible events. */
2232 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2234 struct input_event
*event
;
2236 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2240 last_event_timestamp
= event
->timestamp
;
2242 /* These two kinds of events get special handling
2243 and don't actually appear to the command loop. */
2244 if (event
->kind
== selection_request_event
)
2247 x_handle_selection_request (event
);
2248 kbd_fetch_ptr
= event
+ 1;
2250 /* We're getting selection request events, but we don't have
2256 else if (event
->kind
== selection_clear_event
)
2259 x_handle_selection_clear (event
);
2260 kbd_fetch_ptr
= event
+ 1;
2262 /* We're getting selection request events, but we don't have
2271 get_input_pending (&input_pending
);
2274 /* Caches for modify_event_symbol. */
2275 static Lisp_Object accent_key_syms
;
2276 static Lisp_Object system_key_syms
;
2277 static Lisp_Object func_key_syms
;
2278 static Lisp_Object mouse_syms
;
2280 Lisp_Object Vsystem_key_alist
;
2282 /* This is a list of keysym codes for special "accent" characters.
2283 It parallels lispy_accent_keys. */
2285 static int lispy_accent_codes
[] =
2287 #ifdef XK_dead_circumflex
2292 #ifdef XK_dead_grave
2297 #ifdef XK_dead_tilde
2302 #ifdef XK_dead_diaeresis
2307 #ifdef XK_dead_macron
2312 #ifdef XK_dead_degree
2317 #ifdef XK_dead_acute
2322 #ifdef XK_dead_cedilla
2327 #ifdef XK_dead_breve
2332 #ifdef XK_dead_ogonek
2337 #ifdef XK_dead_caron
2342 #ifdef XK_dead_doubleacute
2343 XK_dead_doubleacute
,
2347 #ifdef XK_dead_abovedot
2354 /* This is a list of Lisp names for special "accent" characters.
2355 It parallels lispy_accent_codes. */
2357 static char *lispy_accent_keys
[] =
2374 /* You'll notice that this table is arranged to be conveniently
2375 indexed by X Windows keysym values. */
2376 static char *lispy_function_keys
[] =
2378 /* X Keysym value */
2380 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2388 0, 0, 0, /* 0xff10 */
2390 0, 0, 0, 0, 0, 0, 0,
2393 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2394 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2395 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2397 "home", /* 0xff50 */ /* IsCursorKey */
2408 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2419 "break", /* 0xff6b */
2421 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
2423 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2424 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2425 0, 0, 0, 0, 0, 0, 0, 0,
2426 "kp-tab", /* 0xff89 */
2428 "kp-enter", /* 0xff8d */
2430 "kp-f1", /* 0xff91 */
2434 "kp-home", /* 0xff95 */
2439 "kp-prior", /* kp-page-up */
2440 "kp-next", /* kp-page-down */
2446 0, 0, 0, 0, 0, 0, 0, 0, 0,
2447 "kp-multiply", /* 0xffaa */
2452 "kp-divide", /* 0xffaf */
2453 "kp-0", /* 0xffb0 */
2454 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2457 "kp-equal", /* 0xffbd */
2458 "f1", /* 0xffbe */ /* IsFunctionKey */
2460 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2461 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2462 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2463 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2464 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2465 0, 0, 0, 0, 0, 0, 0, 0,
2466 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2467 0, 0, 0, 0, 0, 0, 0, "delete"
2470 static char *lispy_mouse_names
[] =
2472 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2475 /* Scroll bar parts. */
2476 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2478 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2479 Lisp_Object
*scroll_bar_parts
[] = {
2480 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2484 /* A vector, indexed by button number, giving the down-going location
2485 of currently depressed buttons, both scroll bar and non-scroll bar.
2487 The elements have the form
2488 (BUTTON-NUMBER MODIFIER-MASK . REST)
2489 where REST is the cdr of a position as it would be reported in the event.
2491 The make_lispy_event function stores positions here to tell the
2492 difference between click and drag events, and to store the starting
2493 location to be included in drag events. */
2495 static Lisp_Object button_down_location
;
2497 /* Information about the most recent up-going button event: Which
2498 button, what location, and what time. */
2500 static int last_mouse_button
;
2501 static int last_mouse_x
;
2502 static int last_mouse_y
;
2503 static unsigned long button_down_time
;
2505 /* The maximum time between clicks to make a double-click,
2506 or Qnil to disable double-click detection,
2507 or Qt for no time limit. */
2508 Lisp_Object Vdouble_click_time
;
2510 /* The number of clicks in this multiple-click. */
2512 int double_click_count
;
2514 #ifdef USE_X_TOOLKIT
2515 extern Lisp_Object
map_event_to_object ();
2516 #endif /* USE_X_TOOLKIT */
2518 /* Given a struct input_event, build the lisp event which represents
2519 it. If EVENT is 0, build a mouse movement event from the mouse
2520 movement buffer, which should have a movement event in it.
2522 Note that events must be passed to this function in the order they
2523 are received; this function stores the location of button presses
2524 in order to build drag events when the button is released. */
2527 make_lispy_event (event
)
2528 struct input_event
*event
;
2532 #ifdef SWITCH_ENUM_BUG
2533 switch ((int) event
->kind
)
2535 switch (event
->kind
)
2538 /* A simple keystroke. */
2539 case ascii_keystroke
:
2541 int c
= event
->code
& 0377;
2542 /* Turn ASCII characters into control characters
2544 if (event
->modifiers
& ctrl_modifier
)
2545 c
= make_ctrl_char (c
);
2547 /* Add in the other modifier bits. We took care of ctrl_modifier
2548 just above, and the shift key was taken care of by the X code,
2549 and applied to control characters by make_ctrl_char. */
2550 c
|= (event
->modifiers
2551 & (meta_modifier
| alt_modifier
2552 | hyper_modifier
| super_modifier
));
2553 button_down_time
= 0;
2557 /* A function key. The symbol may need to have modifier prefixes
2559 case non_ascii_keystroke
:
2560 button_down_time
= 0;
2562 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
2563 if (event
->code
== lispy_accent_codes
[i
])
2564 return modify_event_symbol (i
,
2566 Qfunction_key
, Qnil
,
2567 lispy_accent_keys
, &accent_key_syms
,
2568 (sizeof (lispy_accent_keys
)
2569 / sizeof (lispy_accent_keys
[0])));
2571 /* Handle system-specific keysyms. */
2572 if (event
->code
& (1 << 28))
2574 /* We need to use an alist rather than a vector as the cache
2575 since we can't make a vector long enuf. */
2576 if (NILP (system_key_syms
))
2577 system_key_syms
= Fcons (Qnil
, Qnil
);
2578 return modify_event_symbol (event
->code
& 0xffffff,
2580 Qfunction_key
, Vsystem_key_alist
,
2581 0, &system_key_syms
, 0xffffff);
2584 return modify_event_symbol (event
->code
- 0xff00,
2586 Qfunction_key
, Qnil
,
2587 lispy_function_keys
, &func_key_syms
,
2588 (sizeof (lispy_function_keys
)
2589 / sizeof (lispy_function_keys
[0])));
2592 #if defined(MULTI_FRAME) || defined(HAVE_MOUSE)
2593 /* A mouse click. Figure out where it is, decide whether it's
2594 a press, click or drag, and build the appropriate structure. */
2596 case scroll_bar_click
:
2598 int button
= event
->code
;
2600 Lisp_Object position
;
2601 Lisp_Object
*start_pos_ptr
;
2602 Lisp_Object start_pos
;
2604 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2607 /* Build the position as appropriate for this mouse click. */
2608 if (event
->kind
== mouse_click
)
2611 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2616 /* Ignore mouse events that were made on frame that
2617 have been deleted. */
2618 if (! FRAME_LIVE_P (f
))
2621 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
2622 &column
, &row
, 0, 0);
2624 #ifdef USE_X_TOOLKIT
2625 if (FRAME_EXTERNAL_MENU_BAR (f
) && XINT (event
->y
) == -1)
2627 if (row
< FRAME_MENU_BAR_LINES (f
))
2630 Lisp_Object items
, item
;
2634 /* Activate the menu bar on the down event. If the
2635 up event comes in before the menu code can deal with it,
2637 if (! (event
->modifiers
& down_modifier
))
2640 #ifdef USE_X_TOOLKIT
2641 /* The click happened in the menubar.
2642 Look for the menu item selected. */
2643 item
= map_event_to_object (event
, f
);
2645 XFASTINT (event
->y
) = 1;
2646 #else /* not USE_X_TOOLKIT */
2648 items
= FRAME_MENU_BAR_ITEMS (f
);
2649 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 3)
2651 Lisp_Object pos
, string
;
2652 string
= XVECTOR (items
)->contents
[i
+ 1];
2653 pos
= XVECTOR (items
)->contents
[i
+ 2];
2656 if (column
>= XINT (pos
)
2657 && column
< XINT (pos
) + XSTRING (string
)->size
)
2659 item
= XVECTOR (items
)->contents
[i
];
2663 #endif /* not USE_X_TOOLKIT */
2666 = Fcons (event
->frame_or_window
,
2668 Fcons (Fcons (event
->x
, event
->y
),
2669 Fcons (make_number (event
->timestamp
),
2672 return Fcons (item
, Fcons (position
, Qnil
));
2675 window
= window_from_coordinates (f
, column
, row
, &part
);
2677 if (XTYPE (window
) != Lisp_Window
)
2679 window
= event
->frame_or_window
;
2684 int pixcolumn
, pixrow
;
2685 column
-= XINT (XWINDOW (window
)->left
);
2686 row
-= XINT (XWINDOW (window
)->top
);
2687 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
2688 XSETINT (event
->x
, pixcolumn
);
2689 XSETINT (event
->y
, pixrow
);
2694 posn
= Qvertical_line
;
2696 XSET (posn
, Lisp_Int
,
2697 buffer_posn_from_coords (XWINDOW (window
),
2704 Fcons (Fcons (event
->x
, event
->y
),
2705 Fcons (make_number (event
->timestamp
),
2711 Lisp_Object portion_whole
;
2714 window
= event
->frame_or_window
;
2715 portion_whole
= Fcons (event
->x
, event
->y
);
2716 part
= *scroll_bar_parts
[(int) event
->part
];
2720 Fcons (Qvertical_scroll_bar
,
2721 Fcons (portion_whole
,
2722 Fcons (make_number (event
->timestamp
),
2723 Fcons (part
, Qnil
)))));
2726 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2728 start_pos
= *start_pos_ptr
;
2729 *start_pos_ptr
= Qnil
;
2731 is_double
= (button
== last_mouse_button
2732 && XINT (event
->x
) == last_mouse_x
2733 && XINT (event
->y
) == last_mouse_y
2734 && button_down_time
!= 0
2735 && (EQ (Vdouble_click_time
, Qt
)
2736 || (INTEGERP (Vdouble_click_time
)
2737 && ((int)(event
->timestamp
- button_down_time
)
2738 < XINT (Vdouble_click_time
)))));
2739 last_mouse_button
= button
;
2740 last_mouse_x
= XINT (event
->x
);
2741 last_mouse_y
= XINT (event
->y
);
2743 /* If this is a button press, squirrel away the location, so
2744 we can decide later whether it was a click or a drag. */
2745 if (event
->modifiers
& down_modifier
)
2749 double_click_count
++;
2750 event
->modifiers
|= ((double_click_count
> 2)
2755 double_click_count
= 1;
2756 button_down_time
= event
->timestamp
;
2757 *start_pos_ptr
= Fcopy_alist (position
);
2760 /* Now we're releasing a button - check the co-ordinates to
2761 see if this was a click or a drag. */
2762 else if (event
->modifiers
& up_modifier
)
2764 /* If we did not see a down before this up,
2765 ignore the up. Probably this happened because
2766 the down event chose a menu item.
2767 It would be an annoyance to treat the release
2768 of the button that chose the menu item
2769 as a separate event. */
2771 if (XTYPE (start_pos
) != Lisp_Cons
)
2774 event
->modifiers
&= ~up_modifier
;
2775 #if 0 /* Formerly we treated an up with no down as a click event. */
2776 if (XTYPE (start_pos
) != Lisp_Cons
)
2777 event
->modifiers
|= click_modifier
;
2781 /* The third element of every position should be the (x,y)
2785 down
= Fnth (make_number (2), start_pos
);
2786 if (EQ (event
->x
, XCONS (down
)->car
)
2787 && EQ (event
->y
, XCONS (down
)->cdr
))
2789 if (is_double
&& double_click_count
> 1)
2790 event
->modifiers
|= ((double_click_count
> 2)
2794 event
->modifiers
|= click_modifier
;
2798 button_down_time
= 0;
2799 event
->modifiers
|= drag_modifier
;
2804 /* Every mouse event should either have the down_modifier or
2805 the up_modifier set. */
2809 /* Get the symbol we should use for the mouse click. */
2812 head
= modify_event_symbol (button
,
2815 lispy_mouse_names
, &mouse_syms
,
2816 (sizeof (lispy_mouse_names
)
2817 / sizeof (lispy_mouse_names
[0])));
2818 if (event
->modifiers
& drag_modifier
)
2823 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2826 Fcons (make_number (double_click_count
),
2834 #endif /* MULTI_FRAME or HAVE_MOUSE */
2836 /* The 'kind' field of the event is something we don't recognize. */
2842 #if defined(MULTI_FRAME) || defined(HAVE_MOUSE)
2845 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2847 Lisp_Object bar_window
;
2848 enum scroll_bar_part part
;
2853 /* Is it a scroll bar movement? */
2854 if (frame
&& ! NILP (bar_window
))
2856 Lisp_Object part_sym
;
2858 part_sym
= *scroll_bar_parts
[(int) part
];
2859 return Fcons (Qscroll_bar_movement
,
2860 (Fcons (Fcons (bar_window
,
2861 Fcons (Qvertical_scroll_bar
,
2862 Fcons (Fcons (x
, y
),
2863 Fcons (make_number (time
),
2869 /* Or is it an ordinary mouse movement? */
2871 #endif /* MULTI_FRAME */
2884 /* It's in a frame; which window on that frame? */
2885 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
, 0, 1);
2886 window
= window_from_coordinates (frame
, column
, row
, &area
);
2891 if (XTYPE (window
) == Lisp_Window
)
2893 int pixcolumn
, pixrow
;
2894 column
-= XINT (XWINDOW (window
)->left
);
2895 row
-= XINT (XWINDOW (window
)->top
);
2896 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
2897 XSETINT (x
, pixcolumn
);
2898 XSETINT (y
, pixrow
);
2903 posn
= Qvertical_line
;
2905 XSET (posn
, Lisp_Int
,
2906 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
2909 else if (frame
!= 0)
2911 XSET (window
, Lisp_Frame
, frame
);
2923 return Fcons (Qmouse_movement
,
2924 Fcons (Fcons (window
,
2926 Fcons (Fcons (x
, y
),
2927 Fcons (make_number (time
),
2933 #endif /* neither MULTI_FRAME nor HAVE_MOUSE */
2935 /* Construct a switch frame event. */
2937 make_lispy_switch_frame (frame
)
2940 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
2943 /* Manipulating modifiers. */
2945 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
2947 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2948 SYMBOL's name of the end of the modifiers; the string from this
2949 position is the unmodified symbol name.
2951 This doesn't use any caches. */
2953 parse_modifiers_uncached (symbol
, modifier_end
)
2957 struct Lisp_String
*name
;
2961 CHECK_SYMBOL (symbol
, 1);
2964 name
= XSYMBOL (symbol
)->name
;
2967 for (i
= 0; i
+2 <= name
->size
; )
2968 switch (name
->data
[i
])
2970 #define SINGLE_LETTER_MOD(bit) \
2971 if (name->data[i+1] != '-') \
2972 goto no_more_modifiers; \
2977 SINGLE_LETTER_MOD (alt_modifier
);
2981 SINGLE_LETTER_MOD (ctrl_modifier
);
2985 SINGLE_LETTER_MOD (hyper_modifier
);
2989 SINGLE_LETTER_MOD (meta_modifier
);
2993 SINGLE_LETTER_MOD (shift_modifier
);
2997 SINGLE_LETTER_MOD (super_modifier
);
3001 if (i
+ 5 > name
->size
)
3002 goto no_more_modifiers
;
3003 if (! strncmp (name
->data
+ i
, "drag-", 5))
3005 modifiers
|= drag_modifier
;
3008 else if (! strncmp (name
->data
+ i
, "down-", 5))
3010 modifiers
|= down_modifier
;
3013 else if (i
+ 7 <= name
->size
3014 && ! strncmp (name
->data
+ i
, "double-", 7))
3016 modifiers
|= double_modifier
;
3020 goto no_more_modifiers
;
3024 if (i
+ 7 > name
->size
)
3025 goto no_more_modifiers
;
3026 if (! strncmp (name
->data
+ i
, "triple-", 7))
3028 modifiers
|= triple_modifier
;
3032 goto no_more_modifiers
;
3036 goto no_more_modifiers
;
3038 #undef SINGLE_LETTER_MOD
3042 /* Should we include the `click' modifier? */
3043 if (! (modifiers
& (down_modifier
| drag_modifier
3044 | double_modifier
| triple_modifier
))
3045 && i
+ 7 == name
->size
3046 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
3047 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
3048 modifiers
|= click_modifier
;
3057 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
3058 prepended to the string BASE[0..BASE_LEN-1].
3059 This doesn't use any caches. */
3061 apply_modifiers_uncached (modifiers
, base
, base_len
)
3066 /* Since BASE could contain nulls, we can't use intern here; we have
3067 to use Fintern, which expects a genuine Lisp_String, and keeps a
3070 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
3076 /* Only the event queue may use the `up' modifier; it should always
3077 be turned into a click or drag event before presented to lisp code. */
3078 if (modifiers
& up_modifier
)
3081 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
3082 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
3083 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
3084 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
3085 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
3086 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
3087 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
3088 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
3089 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
3090 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
3091 /* The click modifier is denoted by the absence of other modifiers. */
3095 mod_len
= p
- new_mods
;
3099 Lisp_Object new_name
;
3101 new_name
= make_uninit_string (mod_len
+ base_len
);
3102 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
3103 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
3105 return Fintern (new_name
, Qnil
);
3110 static char *modifier_names
[] =
3112 "up", "down", "drag", "click", "double", "triple", 0, 0,
3113 0, 0, 0, 0, 0, 0, 0, 0,
3114 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
3116 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
3118 static Lisp_Object modifier_symbols
;
3120 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
3122 lispy_modifier_list (modifiers
)
3125 Lisp_Object modifier_list
;
3128 modifier_list
= Qnil
;
3129 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
3130 if (modifiers
& (1<<i
))
3131 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
3134 return modifier_list
;
3138 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
3139 where UNMODIFIED is the unmodified form of SYMBOL,
3140 MASK is the set of modifiers present in SYMBOL's name.
3141 This is similar to parse_modifiers_uncached, but uses the cache in
3142 SYMBOL's Qevent_symbol_element_mask property, and maintains the
3143 Qevent_symbol_elements property. */
3145 parse_modifiers (symbol
)
3148 Lisp_Object elements
;
3150 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
3151 if (CONSP (elements
))
3156 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
3157 Lisp_Object unmodified
;
3160 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
3161 XSYMBOL (symbol
)->name
->size
- end
),
3164 if (modifiers
& ~((1<<VALBITS
) - 1))
3166 XFASTINT (mask
) = modifiers
;
3167 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
3169 /* Cache the parsing results on SYMBOL. */
3170 Fput (symbol
, Qevent_symbol_element_mask
,
3172 Fput (symbol
, Qevent_symbol_elements
,
3173 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
3175 /* Since we know that SYMBOL is modifiers applied to unmodified,
3176 it would be nice to put that in unmodified's cache.
3177 But we can't, since we're not sure that parse_modifiers is
3184 /* Apply the modifiers MODIFIERS to the symbol BASE.
3185 BASE must be unmodified.
3187 This is like apply_modifiers_uncached, but uses BASE's
3188 Qmodifier_cache property, if present. It also builds
3189 Qevent_symbol_elements properties, since it has that info anyway.
3191 apply_modifiers copies the value of BASE's Qevent_kind property to
3192 the modified symbol. */
3194 apply_modifiers (modifiers
, base
)
3198 Lisp_Object cache
, index
, entry
, new_symbol
;
3200 /* Mask out upper bits. We don't know where this value's been. */
3201 modifiers
&= (1<<VALBITS
) - 1;
3203 /* The click modifier never figures into cache indices. */
3204 cache
= Fget (base
, Qmodifier_cache
);
3205 XFASTINT (index
) = (modifiers
& ~click_modifier
);
3206 entry
= assq_no_quit (index
, cache
);
3209 new_symbol
= XCONS (entry
)->cdr
;
3212 /* We have to create the symbol ourselves. */
3213 new_symbol
= apply_modifiers_uncached (modifiers
,
3214 XSYMBOL (base
)->name
->data
,
3215 XSYMBOL (base
)->name
->size
);
3217 /* Add the new symbol to the base's cache. */
3218 entry
= Fcons (index
, new_symbol
);
3219 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
3221 /* We have the parsing info now for free, so add it to the caches. */
3222 XFASTINT (index
) = modifiers
;
3223 Fput (new_symbol
, Qevent_symbol_element_mask
,
3224 Fcons (base
, Fcons (index
, Qnil
)));
3225 Fput (new_symbol
, Qevent_symbol_elements
,
3226 Fcons (base
, lispy_modifier_list (modifiers
)));
3229 /* Make sure this symbol is of the same kind as BASE.
3231 You'd think we could just set this once and for all when we
3232 intern the symbol above, but reorder_modifiers may call us when
3233 BASE's property isn't set right; we can't assume that just
3234 because it has a Qmodifier_cache property it must have its
3235 Qevent_kind set right as well. */
3236 if (NILP (Fget (new_symbol
, Qevent_kind
)))
3240 kind
= Fget (base
, Qevent_kind
);
3242 Fput (new_symbol
, Qevent_kind
, kind
);
3249 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
3250 return a symbol with the modifiers placed in the canonical order.
3251 Canonical order is alphabetical, except for down and drag, which
3252 always come last. The 'click' modifier is never written out.
3254 Fdefine_key calls this to make sure that (for example) C-M-foo
3255 and M-C-foo end up being equivalent in the keymap. */
3258 reorder_modifiers (symbol
)
3261 /* It's hopefully okay to write the code this way, since everything
3262 will soon be in caches, and no consing will be done at all. */
3265 parsed
= parse_modifiers (symbol
);
3266 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
3267 XCONS (parsed
)->car
);
3271 /* For handling events, we often want to produce a symbol whose name
3272 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
3273 to some base, like the name of a function key or mouse button.
3274 modify_event_symbol produces symbols of this sort.
3276 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
3277 is the name of the i'th symbol. TABLE_SIZE is the number of elements
3280 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
3281 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
3283 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
3284 persist between calls to modify_event_symbol that it can use to
3285 store a cache of the symbols it's generated for this NAME_TABLE
3286 before. The object stored there may be a vector or an alist.
3288 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
3290 MODIFIERS is a set of modifier bits (as given in struct input_events)
3291 whose prefixes should be applied to the symbol name.
3293 SYMBOL_KIND is the value to be placed in the event_kind property of
3294 the returned symbol.
3296 The symbols we create are supposed to have an
3297 `event-symbol-elements' property, which lists the modifiers present
3298 in the symbol's name. */
3301 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
3302 name_table
, symbol_table
, table_size
)
3305 Lisp_Object symbol_kind
;
3306 Lisp_Object name_alist
;
3308 Lisp_Object
*symbol_table
;
3312 Lisp_Object symbol_int
;
3314 XSET (symbol_int
, Lisp_Int
, symbol_num
);
3316 /* Is this a request for a valid symbol? */
3317 if (symbol_num
< 0 || symbol_num
>= table_size
)
3320 if (CONSP (*symbol_table
))
3321 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
3323 /* If *symbol_table doesn't seem to be initialized properly, fix that.
3324 *symbol_table should be a lisp vector TABLE_SIZE elements long,
3325 where the Nth element is the symbol for NAME_TABLE[N], or nil if
3326 we've never used that symbol before. */
3329 if (! VECTORP (*symbol_table
)
3330 || XVECTOR (*symbol_table
)->size
!= table_size
)
3334 XFASTINT (size
) = table_size
;
3335 *symbol_table
= Fmake_vector (size
, Qnil
);
3338 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
3341 /* Have we already used this symbol before? */
3344 /* No; let's create it. */
3345 if (!NILP (name_alist
))
3346 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
3347 else if (name_table
[symbol_num
])
3348 value
= intern (name_table
[symbol_num
]);
3353 sprintf (buf
, "key-%d", symbol_num
);
3354 value
= intern (buf
);
3357 if (CONSP (*symbol_table
))
3358 *symbol_table
= Fcons (value
, *symbol_table
);
3360 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
3362 /* Fill in the cache entries for this symbol; this also
3363 builds the Qevent_symbol_elements property, which the user
3365 apply_modifiers (modifiers
& click_modifier
, value
);
3366 Fput (value
, Qevent_kind
, symbol_kind
);
3369 /* Apply modifiers to that symbol. */
3370 return apply_modifiers (modifiers
, value
);
3374 /* Store into *addr a value nonzero if terminal input chars are available.
3375 Serves the purpose of ioctl (0, FIONREAD, addr)
3376 but works even if FIONREAD does not exist.
3377 (In fact, this may actually read some input.) */
3380 get_input_pending (addr
)
3383 /* First of all, have we already counted some input? */
3384 *addr
= !NILP (Vquit_flag
) || readable_events ();
3386 /* If input is being read as it arrives, and we have none, there is none. */
3387 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
3390 /* Try to read some input and see how much we get. */
3392 *addr
= !NILP (Vquit_flag
) || readable_events ();
3395 /* Interface to read_avail_input, blocking SIGIO if necessary. */
3398 gobble_input (expected
)
3403 if (interrupt_input
)
3406 mask
= sigblockx (SIGIO
);
3407 read_avail_input (expected
);
3412 read_avail_input (expected
);
3416 /* Put a buffer_switch_event in the buffer
3417 so that read_key_sequence will notice the new current buffer. */
3419 record_asynch_buffer_change ()
3421 struct input_event event
;
3424 event
.kind
= buffer_switch_event
;
3425 event
.frame_or_window
= Qnil
;
3427 /* We don't need a buffer-switch event unless Emacs is waiting for input.
3428 The purpose of the event is to make read_key_sequence look up the
3429 keymaps again. If we aren't in read_key_sequence, we don't need one,
3430 and the event could cause trouble by messing up (input-pending-p). */
3431 tem
= Fwaiting_for_user_input_p ();
3435 /* Make sure no interrupt happens while storing the event. */
3437 if (interrupt_input
)
3440 mask
= sigblockx (SIGIO
);
3441 kbd_buffer_store_event (&event
);
3448 kbd_buffer_store_event (&event
);
3455 /* Read any terminal input already buffered up by the system
3456 into the kbd_buffer, but do not wait.
3458 EXPECTED should be nonzero if the caller knows there is some input.
3460 Except on VMS, all input is read by this function.
3461 If interrupt_input is nonzero, this function MUST be called
3462 only when SIGIO is blocked.
3464 Returns the number of keyboard chars read, or -1 meaning
3465 this is a bad time to try to read input. */
3468 read_avail_input (expected
)
3471 struct input_event buf
[KBD_BUFFER_SIZE
];
3475 if (read_socket_hook
)
3476 /* No need for FIONREAD or fcntl; just say don't wait. */
3477 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
3480 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
3481 the kbd_buffer can really hold. That may prevent loss
3482 of characters on some systems when input is stuffed at us. */
3483 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
3486 /* Determine how many characters we should *try* to read. */
3488 n_to_read
= dos_keysns ();
3491 #else /* not MSDOS */
3493 /* Find out how much input is available. */
3494 if (ioctl (0, FIONREAD
, &n_to_read
) < 0)
3495 /* Formerly simply reported no input, but that sometimes led to
3496 a failure of Emacs to terminate.
3497 SIGHUP seems appropriate if we can't reach the terminal. */
3498 /* ??? Is it really right to send the signal just to this process
3499 rather than to the whole process group?
3500 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3501 kill (getpid (), SIGHUP
);
3504 if (n_to_read
> sizeof cbuf
)
3505 n_to_read
= sizeof cbuf
;
3506 #else /* no FIONREAD */
3507 #if defined(USG) || defined(DGUX)
3508 /* Read some input if available, but don't wait. */
3509 n_to_read
= sizeof cbuf
;
3510 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
3515 #endif /* not MSDOS */
3517 /* Now read; for one reason or another, this will not block.
3518 NREAD is set to the number of chars read. */
3522 cbuf
[0] = dos_keyread();
3525 nread
= read (fileno (stdin
), cbuf
, n_to_read
);
3527 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
3528 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3529 This looks incorrect, but it isn't, because _BSD causes
3530 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3531 and that causes a value other than 0 when there is no input. */
3537 /* We used to retry the read if it was interrupted.
3538 But this does the wrong thing when O_NDELAY causes
3539 an EAGAIN error. Does anybody know of a situation
3540 where a retry is actually needed? */
3542 nread
< 0 && (errno
== EAGAIN
3556 #if defined (USG) || defined (DGUX)
3557 fcntl (fileno (stdin
), F_SETFL
, 0);
3558 #endif /* USG or DGUX */
3559 #endif /* no FIONREAD */
3560 for (i
= 0; i
< nread
; i
++)
3562 buf
[i
].kind
= ascii_keystroke
;
3563 buf
[i
].modifiers
= 0;
3564 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3565 buf
[i
].modifiers
= meta_modifier
;
3569 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
3571 XSET (buf
[i
].frame_or_window
, Lisp_Frame
, selected_frame
);
3573 buf
[i
].frame_or_window
= Qnil
;
3578 /* Scan the chars for C-g and store them in kbd_buffer. */
3579 for (i
= 0; i
< nread
; i
++)
3581 kbd_buffer_store_event (&buf
[i
]);
3582 /* Don't look at input that follows a C-g too closely.
3583 This reduces lossage due to autorepeat on C-g. */
3584 if (buf
[i
].kind
== ascii_keystroke
3585 && XINT(buf
[i
].code
) == quit_char
)
3591 #endif /* not VMS */
3593 #ifdef SIGIO /* for entire page */
3594 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3597 input_available_signal (signo
)
3600 /* Must preserve main program's value of errno. */
3601 int old_errno
= errno
;
3603 extern int select_alarmed
;
3607 /* USG systems forget handlers when they are used;
3608 must reestablish each time */
3609 signal (signo
, input_available_signal
);
3616 if (input_available_clear_time
)
3617 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3622 nread
= read_avail_input (1);
3623 /* -1 means it's not ok to read the input now.
3624 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3625 0 means there was no keyboard input available. */
3630 select_alarmed
= 1; /* Force the select emulator back to life */
3641 /* Send ourselves a SIGIO.
3643 This function exists so that the UNBLOCK_INPUT macro in
3644 blockinput.h can have some way to take care of input we put off
3645 dealing with, without assuming that every file which uses
3646 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3648 reinvoke_input_signal ()
3657 /* Return the prompt-string of a sparse keymap.
3658 This is the first element which is a string.
3659 Return nil if there is none. */
3667 register Lisp_Object tem
;
3669 if (XTYPE (tem
) == Lisp_String
)
3676 static void menu_bar_item ();
3677 static void menu_bar_one_keymap ();
3679 /* These variables hold the vector under construction within
3680 menu_bar_items and its subroutines, and the current index
3681 for storing into that vector. */
3682 static Lisp_Object menu_bar_items_vector
;
3683 static Lisp_Object menu_bar_items_index
;
3685 /* Return a vector of menu items for a menu bar, appropriate
3686 to the current buffer. Each item has three elements in the vector:
3689 OLD is an old vector we can optionally reuse, or nil. */
3692 menu_bar_items (old
)
3695 /* The number of keymaps we're scanning right now, and the number of
3696 keymaps we have allocated space for. */
3699 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3700 in the current keymaps, or nil where it is not a prefix. */
3703 Lisp_Object def
, tem
, tail
;
3712 struct gcpro gcpro1
;
3714 /* In order to build the menus, we need to call the keymap
3715 accessors. They all call QUIT. But this function is called
3716 during redisplay, during which a quit is fatal. So inhibit
3717 quitting while building the menus.
3718 We do this instead of specbind because (1) errors will clear it anyway
3719 and (2) this avoids risk of specpdl overflow. */
3720 oquit
= Vinhibit_quit
;
3724 menu_bar_items_vector
= old
;
3726 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
3727 menu_bar_items_index
= 0;
3729 GCPRO1 (menu_bar_items_vector
);
3731 /* Build our list of keymaps.
3732 If we recognize a function key and replace its escape sequence in
3733 keybuf with its symbol, or if the sequence starts with a mouse
3734 click and we need to switch buffers, we jump back here to rebuild
3735 the initial keymaps from the current buffer. */
3739 if (!NILP (Voverriding_local_map
))
3742 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3743 maps
[0] = Voverriding_local_map
;
3747 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3748 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3749 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3750 #ifdef USE_TEXT_PROPERTIES
3751 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3753 maps
[nmaps
-2] = current_buffer
->keymap
;
3756 maps
[nmaps
-1] = current_global_map
;
3759 /* Look up in each map the dummy prefix key `menu-bar'. */
3763 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3765 if (! NILP (maps
[mapno
]))
3766 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3770 tem
= Fkeymapp (def
);
3772 menu_bar_one_keymap (def
);
3775 /* Move to the end those items that should be at the end. */
3777 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3780 int end
= menu_bar_items_index
;
3782 for (i
= 0; i
< end
; i
+= 3)
3783 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3785 Lisp_Object tem0
, tem1
, tem2
;
3786 /* Move the item at index I to the end,
3787 shifting all the others forward. */
3788 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
3789 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
3790 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
3792 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
3793 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
3794 (end
- i
- 3) * sizeof (Lisp_Object
));
3795 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem0
;
3796 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem1
;
3797 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem2
;
3802 /* Add nil, nil, nil at the end. */
3803 i
= menu_bar_items_index
;
3804 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
3807 int newsize
= 2 * i
;
3808 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
3809 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
3810 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
3811 menu_bar_items_vector
= tem
;
3813 /* Add this item. */
3814 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3815 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3816 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3817 menu_bar_items_index
= i
;
3819 Vinhibit_quit
= oquit
;
3821 return menu_bar_items_vector
;
3824 /* Scan one map KEYMAP, accumulating any menu items it defines
3825 in menu_bar_items_vector. */
3828 menu_bar_one_keymap (keymap
)
3831 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3833 /* Loop over all keymap entries that have menu strings. */
3834 for (tail
= keymap
; XTYPE (tail
) == Lisp_Cons
; tail
= XCONS (tail
)->cdr
)
3836 item
= XCONS (tail
)->car
;
3837 if (XTYPE (item
) == Lisp_Cons
)
3839 key
= XCONS (item
)->car
;
3840 binding
= XCONS (item
)->cdr
;
3841 if (XTYPE (binding
) == Lisp_Cons
)
3843 item_string
= XCONS (binding
)->car
;
3844 if (XTYPE (item_string
) == Lisp_String
)
3845 menu_bar_item (key
, item_string
, Fcdr (binding
));
3847 else if (EQ (binding
, Qundefined
))
3848 menu_bar_item (key
, Qnil
, binding
);
3850 else if (XTYPE (item
) == Lisp_Vector
)
3852 /* Loop over the char values represented in the vector. */
3853 int len
= XVECTOR (item
)->size
;
3855 for (c
= 0; c
< len
; c
++)
3857 Lisp_Object character
;
3858 XFASTINT (character
) = c
;
3859 binding
= XVECTOR (item
)->contents
[c
];
3860 if (XTYPE (binding
) == Lisp_Cons
)
3862 item_string
= XCONS (binding
)->car
;
3863 if (XTYPE (item_string
) == Lisp_String
)
3864 menu_bar_item (key
, item_string
, Fcdr (binding
));
3866 else if (EQ (binding
, Qundefined
))
3867 menu_bar_item (key
, Qnil
, binding
);
3873 /* This is used as the handler when calling internal_condition_case_1. */
3876 menu_bar_item_1 (arg
)
3882 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
3883 If there's already an item for KEY, add this DEF to it. */
3886 menu_bar_item (key
, item_string
, def
)
3887 Lisp_Object key
, item_string
, def
;
3890 Lisp_Object enabled
;
3893 if (EQ (def
, Qundefined
))
3895 /* If a map has an explicit `undefined' as definition,
3896 discard any previously made menu bar item. */
3898 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
3899 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3901 if (menu_bar_items_index
> i
+ 3)
3902 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
3903 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
3904 (menu_bar_items_index
- i
- 3) * sizeof (Lisp_Object
));
3905 menu_bar_items_index
-= 3;
3909 /* If there's no definition for this key yet,
3910 just ignore `undefined'. */
3914 /* See if this entry is enabled. */
3917 if (XTYPE (def
) == Lisp_Symbol
)
3919 /* No property, or nil, means enable.
3920 Otherwise, enable if value is not nil. */
3921 tem
= Fget (def
, Qmenu_enable
);
3923 /* (condition-case nil (eval tem)
3925 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
3929 /* Ignore this item if it's not enabled. */
3933 /* Find any existing item for this KEY. */
3934 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
3935 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3938 /* If we did not find this KEY, add it at the end. */
3939 if (i
== menu_bar_items_index
)
3941 /* If vector is too small, get a bigger one. */
3942 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
3945 int newsize
= 2 * i
;
3946 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
3947 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
3948 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
3949 menu_bar_items_vector
= tem
;
3951 /* Add this item. */
3952 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
3953 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
3954 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (def
, Qnil
);
3955 menu_bar_items_index
= i
;
3957 /* We did find an item for this KEY. Add DEF to its list of maps. */
3961 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
3962 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (def
, old
);
3966 /* Read a character using menus based on maps in the array MAPS.
3967 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
3968 Return t if we displayed a menu but the user rejected it.
3970 PREV_EVENT is the previous input event, or nil if we are reading
3971 the first event of a key sequence.
3973 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3974 if we used a mouse menu to read the input, or zero otherwise. If
3975 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
3977 The prompting is done based on the prompt-string of the map
3978 and the strings associated with various map elements.
3980 This can be done with X menus or with menus put in the minibuf.
3981 These are done in different ways, depending on how the input will be read.
3982 Menus using X are done after auto-saving in read-char, getting the input
3983 event from Fx_popup_menu; menus using the minibuf use read_char recursively
3984 and do auto-saving in the inner call of read_char. */
3987 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
3990 Lisp_Object prev_event
;
3991 int *used_mouse_menu
;
3994 register Lisp_Object name
;
3995 Lisp_Object rest
, vector
;
3997 if (used_mouse_menu
)
3998 *used_mouse_menu
= 0;
4000 /* Use local over global Menu maps */
4002 if (! menu_prompting
)
4005 /* Get the menu name from the first map that has one (a prompt string). */
4006 for (mapno
= 0; mapno
< nmaps
; mapno
++)
4008 name
= map_prompt (maps
[mapno
]);
4013 /* If we don't have any menus, just read a character normally. */
4017 #ifdef HAVE_X_WINDOWS
4019 /* If we got to this point via a mouse click,
4020 use a real menu for mouse selection. */
4021 if (EVENT_HAS_PARAMETERS (prev_event
))
4023 /* Display the menu and get the selection. */
4024 Lisp_Object
*realmaps
4025 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
4029 /* Use the maps that are not nil. */
4030 for (mapno
= 0; mapno
< nmaps
; mapno
++)
4031 if (!NILP (maps
[mapno
]))
4032 realmaps
[nmaps1
++] = maps
[mapno
];
4034 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
4037 /* If we got more than one event, put all but the first
4038 onto this list to be read later.
4039 Return just the first event now. */
4040 Vunread_command_events
4041 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
4042 value
= XCONS (value
)->car
;
4044 else if (NILP (value
))
4046 if (used_mouse_menu
)
4047 *used_mouse_menu
= 1;
4050 #endif /* HAVE_X_MENU */
4051 #endif /* HAVE_X_WINDOWS */
4056 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
4062 register Lisp_Object name
;
4064 int width
= FRAME_WIDTH (selected_frame
) - 4;
4065 char *menu
= (char *) alloca (width
+ 4);
4068 Lisp_Object rest
, vector
;
4070 if (! menu_prompting
)
4073 /* Get the menu name from the first map that has one (a prompt string). */
4074 for (mapno
= 0; mapno
< nmaps
; mapno
++)
4076 name
= map_prompt (maps
[mapno
]);
4081 /* If we don't have any menus, just read a character normally. */
4085 /* Prompt string always starts with map's prompt, and a space. */
4086 strcpy (menu
, XSTRING (name
)->data
);
4087 nlength
= XSTRING (name
)->size
;
4088 menu
[nlength
++] = ':';
4089 menu
[nlength
++] = ' ';
4092 /* Start prompting at start of first map. */
4096 /* Present the documented bindings, a line at a time. */
4103 int orig_defn_macro
;
4105 /* Loop over elements of map. */
4110 /* If reached end of map, start at beginning of next map. */
4114 /* At end of last map, wrap around to first map if just starting,
4115 or end this line if already have something on it. */
4119 if (notfirst
|| nobindings
) break;
4124 /* Look at the next element of the map. */
4126 elt
= XVECTOR (vector
)->contents
[idx
];
4128 elt
= Fcar_safe (rest
);
4130 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
4132 /* If we found a dense table in the keymap,
4133 advanced past it, but start scanning its contents. */
4134 rest
= Fcdr_safe (rest
);
4140 /* An ordinary element. */
4142 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
4144 s
= Fcar_safe(elt
); /* vector */
4145 if (XTYPE (s
) != Lisp_String
)
4146 /* Ignore the element if it has no prompt string. */
4148 /* If we have room for the prompt string, add it to this line.
4149 If this is the first on the line, always add it. */
4150 else if (XSTRING (s
)->size
+ i
+ 2 < width
4155 /* Punctuate between strings. */
4158 strcpy (menu
+ i
, ", ");
4164 /* Add as much of string as fits. */
4165 thiswidth
= XSTRING (s
)->size
;
4166 if (thiswidth
+ i
> width
)
4167 thiswidth
= width
- i
;
4168 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
4174 /* If this element does not fit, end the line now,
4175 and save the element for the next line. */
4176 strcpy (menu
+ i
, "...");
4180 /* Move past this element. */
4181 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
4182 /* Handle reaching end of dense table. */
4187 rest
= Fcdr_safe (rest
);
4191 /* Prompt with that and read response. */
4194 /* Make believe its not a keyboard macro in case the help char
4195 is pressed. Help characters are not recorded because menu prompting
4196 is not used on replay.
4198 orig_defn_macro
= defining_kbd_macro
;
4199 defining_kbd_macro
= 0 ;
4201 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
4202 while (XTYPE (obj
) == Lisp_Buffer
);
4203 defining_kbd_macro
= orig_defn_macro
;
4205 if (XTYPE (obj
) != Lisp_Int
)
4210 if (! EQ (obj
, menu_prompt_more_char
)
4211 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
4212 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
4214 if ( defining_kbd_macro
)
4215 store_kbd_macro_char(obj
) ;
4218 /* Help char - go round again */
4222 /* Reading key sequences. */
4224 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
4225 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
4226 keymap, or nil otherwise. Return the index of the first keymap in
4227 which KEY has any binding, or NMAPS if no map has a binding.
4229 If KEY is a meta ASCII character, treat it like meta-prefix-char
4230 followed by the corresponding non-meta character. Keymaps in
4231 CURRENT with non-prefix bindings for meta-prefix-char become nil in
4234 If KEY has no bindings in any of the CURRENT maps, NEXT is left
4237 NEXT may == CURRENT. */
4240 follow_key (key
, nmaps
, current
, defs
, next
)
4242 Lisp_Object
*current
, *defs
, *next
;
4245 int i
, first_binding
;
4247 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
4248 followed by the corresponding non-meta character. */
4249 if (XTYPE (key
) == Lisp_Int
&& (XINT (key
) & CHAR_META
))
4251 for (i
= 0; i
< nmaps
; i
++)
4252 if (! NILP (current
[i
]))
4255 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
4257 /* Note that since we pass the resulting bindings through
4258 get_keymap_1, non-prefix bindings for meta-prefix-char
4260 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
4266 XSET (key
, Lisp_Int
, XFASTINT (key
) & ~CHAR_META
);
4269 first_binding
= nmaps
;
4270 for (i
= nmaps
- 1; i
>= 0; i
--)
4272 if (! NILP (current
[i
]))
4274 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
4275 if (! NILP (defs
[i
]))
4282 /* Given the set of bindings we've found, produce the next set of maps. */
4283 if (first_binding
< nmaps
)
4284 for (i
= 0; i
< nmaps
; i
++)
4285 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
4287 return first_binding
;
4290 /* Read a sequence of keys that ends with a non prefix character,
4291 storing it in KEYBUF, a buffer of size BUFSIZE.
4293 Return the length of the key sequence stored.
4294 Return -1 if the user rejected a command menu.
4296 Echo starting immediately unless `prompt' is 0.
4298 Where a key sequence ends depends on the currently active keymaps.
4299 These include any minor mode keymaps active in the current buffer,
4300 the current buffer's local map, and the global map.
4302 If a key sequence has no other bindings, we check Vfunction_key_map
4303 to see if some trailing subsequence might be the beginning of a
4304 function key's sequence. If so, we try to read the whole function
4305 key, and substitute its symbolic name into the key sequence.
4307 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
4308 `double-' events into similar click events, if that would make them
4309 bound. We try to turn `triple-' events first into `double-' events,
4312 If we get a mouse click in a mode line, vertical divider, or other
4313 non-text area, we treat the click as if it were prefixed by the
4314 symbol denoting that area - `mode-line', `vertical-line', or
4317 If the sequence starts with a mouse click, we read the key sequence
4318 with respect to the buffer clicked on, not the current buffer.
4320 If the user switches frames in the midst of a key sequence, we put
4321 off the switch-frame event until later; the next call to
4322 read_char will return it. */
4325 read_key_sequence (keybuf
, bufsize
, prompt
)
4326 Lisp_Object
*keybuf
;
4330 int count
= specpdl_ptr
- specpdl
;
4332 /* How many keys there are in the current key sequence. */
4335 /* The length of the echo buffer when we started reading, and
4336 the length of this_command_keys when we started reading. */
4340 /* The number of keymaps we're scanning right now, and the number of
4341 keymaps we have allocated space for. */
4343 int nmaps_allocated
= 0;
4345 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
4346 the current keymaps. */
4349 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
4350 in the current keymaps, or nil where it is not a prefix. */
4351 Lisp_Object
*submaps
;
4353 /* The index in defs[] of the first keymap that has a binding for
4354 this key sequence. In other words, the lowest i such that
4355 defs[i] is non-nil. */
4358 /* If t < mock_input, then KEYBUF[t] should be read as the next
4361 We use this to recover after recognizing a function key. Once we
4362 realize that a suffix of the current key sequence is actually a
4363 function key's escape sequence, we replace the suffix with the
4364 function key's binding from Vfunction_key_map. Now keybuf
4365 contains a new and different key sequence, so the echo area,
4366 this_command_keys, and the submaps and defs arrays are wrong. In
4367 this situation, we set mock_input to t, set t to 0, and jump to
4368 restart_sequence; the loop will read keys from keybuf up until
4369 mock_input, thus rebuilding the state; and then it will resume
4370 reading characters from the keyboard. */
4373 /* If the sequence is unbound in submaps[], then
4374 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
4375 and fkey_map is its binding.
4377 These might be > t, indicating that all function key scanning
4378 should hold off until t reaches them. We do this when we've just
4379 recognized a function key, to avoid searching for the function
4380 key's again in Vfunction_key_map. */
4381 int fkey_start
= 0, fkey_end
= 0;
4382 Lisp_Object fkey_map
;
4384 /* Likewise, for key_translation_map. */
4385 int keytran_start
= 0, keytran_end
= 0;
4386 Lisp_Object keytran_map
;
4388 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
4389 we put it off for later. While we're reading, we keep the event here. */
4390 Lisp_Object delayed_switch_frame
;
4392 /* See the comment below... */
4393 #if defined (GOBBLE_FIRST_EVENT)
4394 Lisp_Object first_event
;
4397 struct buffer
*starting_buffer
;
4399 /* Nonzero if we seem to have got the beginning of a binding
4400 in function_key_map. */
4401 int function_key_possible
= 0;
4405 last_nonmenu_event
= Qnil
;
4407 delayed_switch_frame
= Qnil
;
4408 fkey_map
= Vfunction_key_map
;
4409 keytran_map
= Vkey_translation_map
;
4411 /* If there is no function-key-map, turn off function key scanning. */
4412 if (NILP (Fkeymapp (Vfunction_key_map
)))
4413 fkey_start
= fkey_end
= bufsize
+ 1;
4415 /* If there is no key-translation-map, turn off scanning. */
4416 if (NILP (Fkeymapp (Vkey_translation_map
)))
4417 keytran_start
= keytran_end
= bufsize
+ 1;
4422 echo_prompt (XSTRING (prompt
)->data
);
4423 else if (cursor_in_echo_area
&& echo_keystrokes
)
4424 /* This doesn't put in a dash if the echo buffer is empty, so
4425 you don't always see a dash hanging out in the minibuffer. */
4429 /* Record the initial state of the echo area and this_command_keys;
4430 we will need to restore them if we replay a key sequence. */
4432 echo_start
= echo_length ();
4433 keys_start
= this_command_key_count
;
4435 #if defined (GOBBLE_FIRST_EVENT)
4436 /* This doesn't quite work, because some of the things that read_char
4437 does cannot safely be bypassed. It seems too risky to try to make
4440 /* Read the first char of the sequence specially, before setting
4441 up any keymaps, in case a filter runs and switches buffers on us. */
4442 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
4444 #endif /* GOBBLE_FIRST_EVENT */
4446 /* We jump here when the key sequence has been thoroughly changed, and
4447 we need to rescan it starting from the beginning. When we jump here,
4448 keybuf[0..mock_input] holds the sequence we should reread. */
4451 starting_buffer
= current_buffer
;
4452 function_key_possible
= 0;
4454 /* Build our list of keymaps.
4455 If we recognize a function key and replace its escape sequence in
4456 keybuf with its symbol, or if the sequence starts with a mouse
4457 click and we need to switch buffers, we jump back here to rebuild
4458 the initial keymaps from the current buffer. */
4462 if (!NILP (Voverriding_local_map
))
4465 if (nmaps
> nmaps_allocated
)
4467 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4468 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4469 nmaps_allocated
= nmaps
;
4471 submaps
[0] = Voverriding_local_map
;
4475 nmaps
= current_minor_maps (0, &maps
) + 2;
4476 if (nmaps
> nmaps_allocated
)
4478 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4479 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4480 nmaps_allocated
= nmaps
;
4482 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
4483 #ifdef USE_TEXT_PROPERTIES
4484 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
4486 submaps
[nmaps
-2] = current_buffer
->keymap
;
4489 submaps
[nmaps
-1] = current_global_map
;
4492 /* Find an accurate initial value for first_binding. */
4493 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
4494 if (! NILP (submaps
[first_binding
]))
4497 /* Start from the beginning in keybuf. */
4500 /* These are no-ops the first time through, but if we restart, they
4501 revert the echo area and this_command_keys to their original state. */
4502 this_command_key_count
= keys_start
;
4503 if (INTERACTIVE
&& t
< mock_input
)
4504 echo_truncate (echo_start
);
4506 /* If the best binding for the current key sequence is a keymap, or
4507 we may be looking at a function key's escape sequence, keep on
4509 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
4510 || (first_binding
>= nmaps
4512 /* mock input is never part of a function key's sequence. */
4513 && mock_input
<= fkey_start
)
4514 || (first_binding
>= nmaps
4515 && keytran_start
< t
4516 /* mock input is never part of a function key's sequence. */
4517 && mock_input
<= keytran_start
)
4518 /* Don't return in the middle of a possible function key sequence,
4519 if the only bindings we found were via case conversion.
4520 Thus, if ESC O a has a function-key-map translation
4521 and ESC o has a binding, don't return after ESC O,
4522 so that we can translate ESC O plus the next character. */
4526 int used_mouse_menu
= 0;
4528 /* Where the last real key started. If we need to throw away a
4529 key that has expanded into more than one element of keybuf
4530 (say, a mouse click on the mode line which is being treated
4531 as [mode-line (mouse-...)], then we backtrack to this point
4533 int last_real_key_start
;
4535 /* These variables are analogous to echo_start and keys_start;
4536 while those allow us to restart the entire key sequence,
4537 echo_local_start and keys_local_start allow us to throw away
4539 int echo_local_start
, keys_local_start
, local_first_binding
;
4542 error ("key sequence too long");
4545 echo_local_start
= echo_length ();
4546 keys_local_start
= this_command_key_count
;
4547 local_first_binding
= first_binding
;
4550 /* These are no-ops, unless we throw away a keystroke below and
4551 jumped back up to replay_key; in that case, these restore the
4552 variables to their original state, allowing us to replay the
4554 if (INTERACTIVE
&& t
< mock_input
)
4555 echo_truncate (echo_local_start
);
4556 this_command_key_count
= keys_local_start
;
4557 first_binding
= local_first_binding
;
4559 /* By default, assume each event is "real". */
4560 last_real_key_start
= t
;
4562 /* Does mock_input indicate that we are re-reading a key sequence? */
4566 add_command_key (key
);
4567 if (echo_keystrokes
)
4571 /* If not, we should actually read a character. */
4574 struct buffer
*buf
= current_buffer
;
4576 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
4579 /* read_char returns t when it shows a menu and the user rejects it.
4584 /* read_char returns -1 at the end of a macro.
4585 Emacs 18 handles this by returning immediately with a
4586 zero, so that's what we'll do. */
4587 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) == -1)
4593 /* If the current buffer has been changed from under us, the
4594 keymap may have changed, so replay the sequence. */
4595 if (XTYPE (key
) == Lisp_Buffer
)
4598 goto replay_sequence
;
4601 /* If we have a quit that was typed in another frame, and
4602 quit_throw_to_read_char switched buffers,
4603 replay to get the right keymap. */
4604 if (EQ (key
, quit_char
) && current_buffer
!= starting_buffer
)
4609 goto replay_sequence
;
4615 /* Clicks in non-text areas get prefixed by the symbol
4616 in their CHAR-ADDRESS field. For example, a click on
4617 the mode line is prefixed by the symbol `mode-line'.
4619 Furthermore, key sequences beginning with mouse clicks
4620 are read using the keymaps of the buffer clicked on, not
4621 the current buffer. So we may have to switch the buffer
4624 When we turn one event into two events, we must make sure
4625 that neither of the two looks like the original--so that,
4626 if we replay the events, they won't be expanded again.
4627 If not for this, such reexpansion could happen either here
4628 or when user programs play with this-command-keys. */
4629 if (EVENT_HAS_PARAMETERS (key
))
4633 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
4634 if (EQ (kind
, Qmouse_click
))
4636 Lisp_Object window
, posn
;
4638 window
= POSN_WINDOW (EVENT_START (key
));
4639 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4640 if (XTYPE (posn
) == Lisp_Cons
)
4642 /* We're looking at the second event of a
4643 sequence which we expanded before. Set
4644 last_real_key_start appropriately. */
4646 last_real_key_start
= t
- 1;
4649 /* Key sequences beginning with mouse clicks are
4650 read using the keymaps in the buffer clicked on,
4651 not the current buffer. If we're at the
4652 beginning of a key sequence, switch buffers. */
4653 if (last_real_key_start
== 0
4654 && XTYPE (window
) == Lisp_Window
4655 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
4656 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
4661 /* Arrange to go back to the original buffer once we're
4662 done reading the key sequence. Note that we can't
4663 use save_excursion_{save,restore} here, because they
4664 save point as well as the current buffer; we don't
4665 want to save point, because redisplay may change it,
4666 to accommodate a Fset_window_start or something. We
4667 don't want to do this at the top of the function,
4668 because we may get input from a subprocess which
4669 wants to change the selected window and stuff (say,
4671 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
4673 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
4674 goto replay_sequence
;
4676 else if (XTYPE (posn
) == Lisp_Symbol
)
4678 /* Expand mode-line and scroll-bar events into two events:
4679 use posn as a fake prefix key. */
4681 if (t
+ 1 >= bufsize
)
4682 error ("key sequence too long");
4687 /* Zap the position in key, so we know that we've
4688 expanded it, and don't try to do so again. */
4689 POSN_BUFFER_POSN (EVENT_START (key
))
4690 = Fcons (posn
, Qnil
);
4694 else if (EQ (kind
, Qswitch_frame
))
4696 /* If we're at the beginning of a key sequence, go
4697 ahead and return this event. If we're in the
4698 midst of a key sequence, delay it until the end. */
4701 delayed_switch_frame
= key
;
4705 else if (CONSP (XCONS (key
)->cdr
)
4706 && CONSP (EVENT_START (key
))
4707 && CONSP (XCONS (EVENT_START (key
))->cdr
))
4711 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4712 /* Handle menu-bar events:
4713 insert the dummy prefix event `menu-bar'. */
4714 if (EQ (posn
, Qmenu_bar
))
4716 if (t
+ 1 >= bufsize
)
4717 error ("key sequence too long");
4718 /* Run the Lucid hook. */
4719 if (!NILP (Vrun_hooks
))
4720 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4721 /* If it has changed current-menubar from previous value,
4722 really recompute the menubar from the value. */
4723 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4724 call0 (Qrecompute_lucid_menubar
);
4728 /* Zap the position in key, so we know that we've
4729 expanded it, and don't try to do so again. */
4730 POSN_BUFFER_POSN (EVENT_START (key
))
4731 = Fcons (posn
, Qnil
);
4734 goto replay_sequence
;
4736 else if (XTYPE (posn
) == Lisp_Cons
)
4738 /* We're looking at the second event of a
4739 sequence which we expanded before. Set
4740 last_real_key_start appropriately. */
4741 if (last_real_key_start
== t
&& t
> 0)
4742 last_real_key_start
= t
- 1;
4747 /* We have finally decided that KEY is something we might want
4749 first_binding
= (follow_key (key
,
4750 nmaps
- first_binding
,
4751 submaps
+ first_binding
,
4752 defs
+ first_binding
,
4753 submaps
+ first_binding
)
4756 /* If KEY wasn't bound, we'll try some fallbacks. */
4757 if (first_binding
>= nmaps
)
4761 head
= EVENT_HEAD (key
);
4762 if (EQ (head
, Vhelp_char
))
4764 read_key_sequence_cmd
= Vprefix_help_command
;
4766 last_nonmenu_event
= key
;
4770 if (XTYPE (head
) == Lisp_Symbol
)
4772 Lisp_Object breakdown
;
4775 breakdown
= parse_modifiers (head
);
4776 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4777 /* Attempt to reduce an unbound mouse event to a simpler
4778 event that is bound:
4779 Drags reduce to clicks.
4780 Double-clicks reduce to clicks.
4781 Triple-clicks reduce to double-clicks, then to clicks.
4782 Down-clicks are eliminated.
4783 Double-downs reduce to downs, then are eliminated.
4784 Triple-downs reduce to double-downs, then to downs,
4785 then are eliminated. */
4786 if (modifiers
& (down_modifier
| drag_modifier
4787 | double_modifier
| triple_modifier
))
4789 while (modifiers
& (down_modifier
| drag_modifier
4790 | double_modifier
| triple_modifier
))
4792 Lisp_Object new_head
, new_click
;
4793 if (modifiers
& triple_modifier
)
4794 modifiers
^= (double_modifier
| triple_modifier
);
4795 else if (modifiers
& (drag_modifier
| double_modifier
))
4796 modifiers
&= ~(drag_modifier
| double_modifier
);
4799 /* Dispose of this `down' event by simply jumping
4800 back to replay_key, to get another event.
4802 Note that if this event came from mock input,
4803 then just jumping back to replay_key will just
4804 hand it to us again. So we have to wipe out any
4807 We could delete keybuf[t] and shift everything
4808 after that to the left by one spot, but we'd also
4809 have to fix up any variable that points into
4810 keybuf, and shifting isn't really necessary
4813 Adding prefixes for non-textual mouse clicks
4814 creates two characters of mock input, and both
4815 must be thrown away. If we're only looking at
4816 the prefix now, we can just jump back to
4817 replay_key. On the other hand, if we've already
4818 processed the prefix, and now the actual click
4819 itself is giving us trouble, then we've lost the
4820 state of the keymaps we want to backtrack to, and
4821 we need to replay the whole sequence to rebuild
4824 Beyond that, only function key expansion could
4825 create more than two keys, but that should never
4826 generate mouse events, so it's okay to zero
4827 mock_input in that case too.
4829 Isn't this just the most wonderful code ever? */
4830 if (t
== last_real_key_start
)
4837 mock_input
= last_real_key_start
;
4838 goto replay_sequence
;
4843 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
4845 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
4847 /* Look for a binding for this new key. follow_key
4848 promises that it didn't munge submaps the
4849 last time we called it, since key was unbound. */
4851 = (follow_key (new_click
,
4852 nmaps
- local_first_binding
,
4853 submaps
+ local_first_binding
,
4854 defs
+ local_first_binding
,
4855 submaps
+ local_first_binding
)
4856 + local_first_binding
);
4858 /* If that click is bound, go for it. */
4859 if (first_binding
< nmaps
)
4864 /* Otherwise, we'll leave key set to the drag event. */
4871 /* Normally, last_nonmenu_event gets the previous key we read.
4872 But when a mouse popup menu is being used,
4873 we don't update last_nonmenu_event; it continues to hold the mouse
4874 event that preceded the first level of menu. */
4875 if (!used_mouse_menu
)
4876 last_nonmenu_event
= key
;
4878 /* If the sequence is unbound, see if we can hang a function key
4879 off the end of it. We only want to scan real keyboard input
4880 for function key sequences, so if mock_input says that we're
4881 re-reading old events, don't examine it. */
4882 if (first_binding
>= nmaps
4885 Lisp_Object fkey_next
;
4887 /* Continue scan from fkey_end until we find a bound suffix.
4888 If we fail, increment fkey_start
4889 and start fkey_end from there. */
4890 while (fkey_end
< t
)
4894 key
= keybuf
[fkey_end
++];
4895 /* Look up meta-characters by prefixing them
4896 with meta_prefix_char. I hate this. */
4897 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4902 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
4904 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4907 fkey_next
= fkey_map
;
4910 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
4912 #if 0 /* I didn't turn this on, because it might cause trouble
4913 for the mapping of return into C-m and tab into C-i. */
4914 /* Optionally don't map function keys into other things.
4915 This enables the user to redefine kp- keys easily. */
4916 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
4920 /* If the function key map gives a function, not an
4921 array, then call the function with no args and use
4922 its value instead. */
4923 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
4926 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4930 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4931 fkey_next
= call1 (fkey_next
, prompt
);
4933 /* If the function returned something invalid,
4934 barf--don't ignore it.
4935 (To ignore it safely, we would need to gcpro a bunch of
4936 other variables.) */
4937 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
4938 error ("Function in function-key-map returns invalid key sequence");
4941 function_key_possible
= ! NILP (fkey_next
);
4943 /* If keybuf[fkey_start..fkey_end] is bound in the
4944 function key map and it's a suffix of the current
4945 sequence (i.e. fkey_end == t), replace it with
4946 the binding and restart with fkey_start at the end. */
4947 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
4950 int len
= XFASTINT (Flength (fkey_next
));
4952 t
= fkey_start
+ len
;
4954 error ("key sequence too long");
4956 if (VECTORP (fkey_next
))
4957 bcopy (XVECTOR (fkey_next
)->contents
,
4958 keybuf
+ fkey_start
,
4959 (t
- fkey_start
) * sizeof (keybuf
[0]));
4960 else if (STRINGP (fkey_next
))
4964 for (i
= 0; i
< len
; i
++)
4965 XFASTINT (keybuf
[fkey_start
+ i
])
4966 = XSTRING (fkey_next
)->data
[i
];
4970 fkey_start
= fkey_end
= t
;
4971 fkey_map
= Vfunction_key_map
;
4973 goto replay_sequence
;
4976 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
4978 /* If we no longer have a bound suffix, try a new positions for
4980 if (NILP (fkey_map
))
4982 fkey_end
= ++fkey_start
;
4983 fkey_map
= Vfunction_key_map
;
4984 function_key_possible
= 0;
4989 /* Look for this sequence in key-translation-map. */
4991 Lisp_Object keytran_next
;
4993 /* Scan from keytran_end until we find a bound suffix. */
4994 while (keytran_end
< t
)
4998 key
= keybuf
[keytran_end
++];
4999 /* Look up meta-characters by prefixing them
5000 with meta_prefix_char. I hate this. */
5001 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
5006 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
5008 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
5011 keytran_next
= keytran_map
;
5014 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
5016 /* If the key translation map gives a function, not an
5017 array, then call the function with no args and use
5018 its value instead. */
5019 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
5020 && keytran_end
== t
)
5022 struct gcpro gcpro1
, gcpro2
, gcpro3
;
5026 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
5027 keytran_next
= call1 (keytran_next
, prompt
);
5029 /* If the function returned something invalid,
5030 barf--don't ignore it.
5031 (To ignore it safely, we would need to gcpro a bunch of
5032 other variables.) */
5033 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
5034 error ("Function in key-translation-map returns invalid key sequence");
5037 /* If keybuf[keytran_start..keytran_end] is bound in the
5038 key translation map and it's a suffix of the current
5039 sequence (i.e. keytran_end == t), replace it with
5040 the binding and restart with keytran_start at the end. */
5041 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
5042 && keytran_end
== t
)
5044 int len
= XFASTINT (Flength (keytran_next
));
5046 t
= keytran_start
+ len
;
5048 error ("key sequence too long");
5050 if (VECTORP (keytran_next
))
5051 bcopy (XVECTOR (keytran_next
)->contents
,
5052 keybuf
+ keytran_start
,
5053 (t
- keytran_start
) * sizeof (keybuf
[0]));
5054 else if (STRINGP (keytran_next
))
5058 for (i
= 0; i
< len
; i
++)
5059 XFASTINT (keybuf
[keytran_start
+ i
])
5060 = XSTRING (keytran_next
)->data
[i
];
5064 keytran_start
= keytran_end
= t
;
5065 keytran_map
= Vkey_translation_map
;
5067 goto replay_sequence
;
5070 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
5072 /* If we no longer have a bound suffix, try a new positions for
5074 if (NILP (keytran_map
))
5076 keytran_end
= ++keytran_start
;
5077 keytran_map
= Vkey_translation_map
;
5082 /* If KEY is not defined in any of the keymaps,
5083 and cannot be part of a function key or translation,
5084 and is an upper case letter
5085 use the corresponding lower-case letter instead. */
5086 if (first_binding
== nmaps
&& ! function_key_possible
5087 && XTYPE (key
) == Lisp_Int
5088 && ((((XINT (key
) & 0x3ffff)
5089 < XSTRING (current_buffer
->downcase_table
)->size
)
5090 && UPPERCASEP (XINT (key
) & 0x3ffff))
5091 || (XINT (key
) & shift_modifier
)))
5093 if (XINT (key
) & shift_modifier
)
5094 XSETINT (key
, XINT (key
) & ~shift_modifier
);
5096 XSETINT (key
, (DOWNCASE (XINT (key
) & 0x3ffff)
5097 | (XINT (key
) & ~0x3ffff)));
5099 keybuf
[t
- 1] = key
;
5101 goto replay_sequence
;
5105 read_key_sequence_cmd
= (first_binding
< nmaps
5106 ? defs
[first_binding
]
5110 unread_switch_frame
= delayed_switch_frame
;
5111 unbind_to (count
, Qnil
);
5113 /* Occasionally we fabricate events, perhaps by expanding something
5114 according to function-key-map, or by adding a prefix symbol to a
5115 mouse click in the scroll bar or modeline. In this cases, return
5116 the entire generated key sequence, even if we hit an unbound
5117 prefix or a definition before the end. This means that you will
5118 be able to push back the event properly, and also means that
5119 read-key-sequence will always return a logical unit.
5122 for (; t
< mock_input
; t
++)
5124 if (echo_keystrokes
)
5125 echo_char (keybuf
[t
]);
5126 add_command_key (keybuf
[t
]);
5132 #if 0 /* This doc string is too long for some compilers.
5133 This commented-out definition serves for DOC. */
5134 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
5135 "Read a sequence of keystrokes and return as a string or vector.\n\
5136 The sequence is sufficient to specify a non-prefix command in the\n\
5137 current local and global maps.\n\
5139 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
5140 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
5141 as a continuation of the previous key.\n\
5143 A C-g typed while in this function is treated like any other character,\n\
5144 and `quit-flag' is not set.\n\
5146 If the key sequence starts with a mouse click, then the sequence is read\n\
5147 using the keymaps of the buffer of the window clicked in, not the buffer\n\
5148 of the selected window as normal.\n\
5150 `read-key-sequence' drops unbound button-down events, since you normally\n\
5151 only care about the click or drag events which follow them. If a drag\n\
5152 or multi-click event is unbound, but the corresponding click event would\n\
5153 be bound, `read-key-sequence' turns the event into a click event at the\n\
5154 drag's starting position. This means that you don't have to distinguish\n\
5155 between click and drag, double, or triple events unless you want to.\n\
5157 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
5158 lines separating windows, and scroll bars with imaginary keys\n\
5159 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
5161 If the user switches frames in the middle of a key sequence, the\n\
5162 frame-switch event is put off until after the current key sequence.\n\
5164 `read-key-sequence' checks `function-key-map' for function key\n\
5165 sequences, where they wouldn't conflict with ordinary bindings. See\n\
5166 `function-key-map' for more details.")
5167 (prompt
, continue_echo
)
5170 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
5172 (prompt
, continue_echo
)
5173 Lisp_Object prompt
, continue_echo
;
5175 Lisp_Object keybuf
[30];
5177 struct gcpro gcpro1
, gcpro2
;
5180 CHECK_STRING (prompt
, 0);
5183 bzero (keybuf
, sizeof keybuf
);
5185 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
5187 if (NILP (continue_echo
))
5188 this_command_key_count
= 0;
5190 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])), prompt
);
5198 return make_event_array (i
, keybuf
);
5201 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
5202 "Execute CMD as an editor command.\n\
5203 CMD must be a symbol that satisfies the `commandp' predicate.\n\
5204 Optional second arg RECORD-FLAG non-nil\n\
5205 means unconditionally put this command in `command-history'.\n\
5206 Otherwise, that is done only if an arg is read using the minibuffer.")
5208 Lisp_Object cmd
, record
;
5210 register Lisp_Object final
;
5211 register Lisp_Object tem
;
5212 Lisp_Object prefixarg
;
5213 struct backtrace backtrace
;
5214 extern int debug_on_next_call
;
5216 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
5217 Vcurrent_prefix_arg
= prefixarg
;
5218 debug_on_next_call
= 0;
5220 if (XTYPE (cmd
) == Lisp_Symbol
)
5222 tem
= Fget (cmd
, Qdisabled
);
5223 if (!NILP (tem
) && !NILP (Vrun_hooks
))
5224 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
5229 final
= Findirect_function (cmd
);
5231 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
5232 do_autoload (final
, cmd
);
5237 if (XTYPE (final
) == Lisp_String
5238 || XTYPE (final
) == Lisp_Vector
)
5240 /* If requested, place the macro in the command history. For
5241 other sorts of commands, call-interactively takes care of
5245 = Fcons (Fcons (Qexecute_kbd_macro
,
5246 Fcons (final
, Fcons (prefixarg
, Qnil
))),
5249 return Fexecute_kbd_macro (final
, prefixarg
);
5251 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
5252 || XTYPE (final
) == Lisp_Compiled
)
5254 backtrace
.next
= backtrace_list
;
5255 backtrace_list
= &backtrace
;
5256 backtrace
.function
= &Qcall_interactively
;
5257 backtrace
.args
= &cmd
;
5258 backtrace
.nargs
= 1;
5259 backtrace
.evalargs
= 0;
5261 tem
= Fcall_interactively (cmd
, record
);
5263 backtrace_list
= backtrace
.next
;
5269 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
5271 "Read function name, then read its arguments and call it.")
5273 Lisp_Object prefixarg
;
5275 Lisp_Object function
;
5277 Lisp_Object saved_keys
;
5278 struct gcpro gcpro1
;
5280 saved_keys
= Fvector (this_command_key_count
,
5281 XVECTOR (this_command_keys
)->contents
);
5283 GCPRO1 (saved_keys
);
5285 if (EQ (prefixarg
, Qminus
))
5287 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
5288 strcpy (buf
, "C-u ");
5289 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
5290 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
5291 else if (XTYPE (prefixarg
) == Lisp_Int
)
5292 sprintf (buf
, "%d ", XINT (prefixarg
));
5294 /* This isn't strictly correct if execute-extended-command
5295 is bound to anything else. Perhaps it should use
5296 this_command_keys? */
5297 strcat (buf
, "M-x ");
5299 /* Prompt with buf, and then read a string, completing from and
5300 restricting to the set of all defined commands. Don't provide
5301 any initial input. Save the command read on the extended-command
5303 function
= Fcompleting_read (build_string (buf
),
5304 Vobarray
, Qcommandp
,
5305 Qt
, Qnil
, Qextended_command_history
);
5307 /* Set this_command_keys to the concatenation of saved_keys and
5308 function, followed by a RET. */
5310 struct Lisp_String
*str
;
5315 this_command_key_count
= 0;
5317 keys
= XVECTOR (saved_keys
)->contents
;
5318 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
5319 add_command_key (keys
[i
]);
5321 str
= XSTRING (function
);
5322 for (i
= 0; i
< str
->size
; i
++)
5324 XFASTINT (tem
) = str
->data
[i
];
5325 add_command_key (tem
);
5328 XFASTINT (tem
) = '\015';
5329 add_command_key (tem
);
5334 function
= Fintern (function
, Qnil
);
5335 Vprefix_arg
= prefixarg
;
5336 this_command
= function
;
5338 return Fcommand_execute (function
, Qt
);
5342 detect_input_pending ()
5345 get_input_pending (&input_pending
);
5347 return input_pending
;
5350 /* This is called in some cases before a possible quit.
5351 It cases the next call to detect_input_pending to recompute input_pending.
5352 So calling this function unnecessarily can't do any harm. */
5353 clear_input_pending ()
5358 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
5359 "T if command input is currently available with no waiting.\n\
5360 Actually, the value is nil only if we can be sure that no input is available.")
5363 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
5366 return detect_input_pending () ? Qt
: Qnil
;
5369 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
5370 "Return vector of last 100 events, not counting those from keyboard macros.")
5373 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
5376 if (total_keys
< NUM_RECENT_KEYS
)
5377 return Fvector (total_keys
, keys
);
5380 val
= Fvector (NUM_RECENT_KEYS
, keys
);
5381 bcopy (keys
+ recent_keys_index
,
5382 XVECTOR (val
)->contents
,
5383 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
5385 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
5386 recent_keys_index
* sizeof (Lisp_Object
));
5391 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
5392 "Return the key sequence that invoked this command.\n\
5393 The value is a string or a vector.")
5396 return make_event_array (this_command_key_count
,
5397 XVECTOR (this_command_keys
)->contents
);
5400 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
5401 "Return the current depth in recursive edits.")
5405 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
5409 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
5410 "FOpen dribble file: ",
5411 "Start writing all keyboard characters to a dribble file called FILE.\n\
5412 If FILE is nil, close any open dribble file.")
5423 file
= Fexpand_file_name (file
, Qnil
);
5424 dribble
= fopen (XSTRING (file
)->data
, "w");
5429 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
5430 "Discard the contents of the terminal input buffer.\n\
5431 Also cancel any kbd macro being defined.")
5434 defining_kbd_macro
= 0;
5435 update_mode_lines
++;
5437 Vunread_command_events
= Qnil
;
5438 unread_command_char
= -1;
5440 discard_tty_input ();
5442 /* Without the cast, GCC complains that this assignment loses the
5443 volatile qualifier of kbd_store_ptr. Is there anything wrong
5445 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
5446 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5452 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
5453 "Stop Emacs and return to superior process. You can resume later.\n\
5454 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
5455 control, run a subshell instead.\n\n\
5456 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
5457 to be read as terminal input by Emacs's parent, after suspension.\n\
5459 Before suspending, call the functions in `suspend-hook' with no args.\n\
5460 If any of them returns nil, don't call the rest and don't suspend.\n\
5461 Otherwise, suspend normally and after resumption run the normal hook\n\
5462 `suspend-resume-hook' if that is bound and non-nil.\n\
5464 Some operating systems cannot stop the Emacs process and resume it later.\n\
5465 On such systems, Emacs starts a subshell instead of suspending.")
5467 Lisp_Object stuffstring
;
5470 int count
= specpdl_ptr
- specpdl
;
5471 int old_height
, old_width
;
5473 struct gcpro gcpro1
, gcpro2
;
5474 extern init_sys_modes ();
5476 if (!NILP (stuffstring
))
5477 CHECK_STRING (stuffstring
, 0);
5479 /* Run the functions in suspend-hook. */
5480 if (!NILP (Vrun_hooks
))
5481 call1 (Vrun_hooks
, intern ("suspend-hook"));
5483 GCPRO1 (stuffstring
);
5484 get_frame_size (&old_width
, &old_height
);
5486 /* sys_suspend can get an error if it tries to fork a subshell
5487 and the system resources aren't available for that. */
5488 record_unwind_protect (init_sys_modes
, 0);
5489 stuff_buffered_input (stuffstring
);
5494 unbind_to (count
, Qnil
);
5496 /* Check if terminal/window size has changed.
5497 Note that this is not useful when we are running directly
5498 with a window system; but suspend should be disabled in that case. */
5499 get_frame_size (&width
, &height
);
5500 if (width
!= old_width
|| height
!= old_height
)
5501 change_frame_size (selected_frame
, height
, width
, 0, 0);
5503 /* Run suspend-resume-hook. */
5504 if (!NILP (Vrun_hooks
))
5505 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
5511 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
5512 Then in any case stuff anything Emacs has read ahead and not used. */
5514 stuff_buffered_input (stuffstring
)
5515 Lisp_Object stuffstring
;
5517 register unsigned char *p
;
5519 /* stuff_char works only in BSD, versions 4.2 and up. */
5522 if (XTYPE (stuffstring
) == Lisp_String
)
5526 p
= XSTRING (stuffstring
)->data
;
5527 count
= XSTRING (stuffstring
)->size
;
5532 /* Anything we have read ahead, put back for the shell to read. */
5533 while (kbd_fetch_ptr
!= kbd_store_ptr
)
5535 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
5536 kbd_fetch_ptr
= kbd_buffer
;
5537 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
5538 stuff_char (kbd_fetch_ptr
->code
);
5539 kbd_fetch_ptr
->kind
= no_event
;
5540 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
5547 #endif /* BSD and not BSD4_1 */
5550 set_waiting_for_input (time_to_clear
)
5551 EMACS_TIME
*time_to_clear
;
5553 input_available_clear_time
= time_to_clear
;
5555 /* Tell interrupt_signal to throw back to read_char, */
5556 waiting_for_input
= 1;
5558 /* If interrupt_signal was called before and buffered a C-g,
5559 make it run again now, to avoid timing error. */
5560 if (!NILP (Vquit_flag
))
5561 quit_throw_to_read_char ();
5564 clear_waiting_for_input ()
5566 /* Tell interrupt_signal not to throw back to read_char, */
5567 waiting_for_input
= 0;
5568 input_available_clear_time
= 0;
5571 /* This routine is called at interrupt level in response to C-G.
5572 If interrupt_input, this is the handler for SIGINT.
5573 Otherwise, it is called from kbd_buffer_store_event,
5574 in handling SIGIO or SIGTINT.
5576 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
5577 immediately throw back to read_char.
5579 Otherwise it sets the Lisp variable quit-flag not-nil.
5580 This causes eval to throw, when it gets a chance.
5581 If quit-flag is already non-nil, it stops the job right away. */
5587 /* Must preserve main program's value of errno. */
5588 int old_errno
= errno
;
5591 if (!read_socket_hook
&& NILP (Vwindow_system
))
5593 /* USG systems forget handlers when they are used;
5594 must reestablish each time */
5595 signal (SIGINT
, interrupt_signal
);
5596 signal (SIGQUIT
, interrupt_signal
);
5602 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
5607 #ifdef SIGTSTP /* Support possible in later USG versions */
5609 * On systems which can suspend the current process and return to the original
5610 * shell, this command causes the user to end up back at the shell.
5611 * The "Auto-save" and "Abort" questions are not asked until
5612 * the user elects to return to emacs, at which point he can save the current
5613 * job and either dump core or continue.
5618 if (sys_suspend () == -1)
5620 printf ("Not running as a subprocess;\n");
5621 printf ("you can continue or abort.\n");
5624 /* Perhaps should really fork an inferior shell?
5625 But that would not provide any way to get back
5626 to the original shell, ever. */
5627 printf ("No support for stopping a process on this operating system;\n");
5628 printf ("you can continue or abort.\n");
5629 #endif /* not VMS */
5630 #endif /* not SIGTSTP */
5632 /* We must remain inside the screen area when the internal terminal
5633 is used. Note that [Enter] is not echoed by dos. */
5636 printf ("Auto-save? (y or n) ");
5638 if (((c
= getchar ()) & ~040) == 'Y')
5640 Fdo_auto_save (Qt
, Qnil
);
5642 printf ("\r\nAuto-save done");
5643 #else /* not MSDOS */
5644 printf ("Auto-save done\n");
5645 #endif /* not MSDOS */
5647 while (c
!= '\n') c
= getchar ();
5649 printf ("\r\nAbort? (y or n) ");
5650 #else /* not MSDOS */
5652 printf ("Abort (and enter debugger)? (y or n) ");
5654 printf ("Abort (and dump core)? (y or n) ");
5655 #endif /* not VMS */
5656 #endif /* not MSDOS */
5658 if (((c
= getchar ()) & ~040) == 'Y')
5660 while (c
!= '\n') c
= getchar ();
5662 printf ("\r\nContinuing...\r\n");
5663 #else /* not MSDOS */
5664 printf ("Continuing...\n");
5665 #endif /* not MSDOS */
5671 /* If executing a function that wants to be interrupted out of
5672 and the user has not deferred quitting by binding `inhibit-quit'
5673 then quit right away. */
5674 if (immediate_quit
&& NILP (Vinhibit_quit
))
5678 Fsignal (Qquit
, Qnil
);
5681 /* Else request quit when it's safe */
5685 if (waiting_for_input
&& !echoing
)
5686 quit_throw_to_read_char ();
5691 /* Handle a C-g by making read_char return C-g. */
5693 quit_throw_to_read_char ()
5695 quit_error_check ();
5697 /* Prevent another signal from doing this before we finish. */
5698 clear_waiting_for_input ();
5701 Vunread_command_events
= Qnil
;
5702 unread_command_char
= -1;
5704 #ifdef POLL_FOR_INPUT
5705 /* May be > 1 if in recursive minibuffer. */
5706 if (poll_suppress_count
== 0)
5710 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
5711 && XFRAME (internal_last_event_frame
) != selected_frame
)
5712 Fhandle_switch_frame (make_lispy_switch_frame (internal_last_event_frame
));
5715 _longjmp (getcjmp
, 1);
5718 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
5719 "Set mode of reading keyboard input.\n\
5720 First arg INTERRUPT non-nil means use input interrupts;\n\
5721 nil means use CBREAK mode.\n\
5722 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
5723 (no effect except in CBREAK mode).\n\
5724 Third arg META t means accept 8-bit input (for a Meta key).\n\
5725 META nil means ignore the top bit, on the assumption it is parity.\n\
5726 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
5727 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
5728 See also `current-input-mode'.")
5729 (interrupt
, flow
, meta
, quit
)
5730 Lisp_Object interrupt
, flow
, meta
, quit
;
5733 && (XTYPE (quit
) != Lisp_Int
5734 || XINT (quit
) < 0 || XINT (quit
) > 0400))
5735 error ("set-input-mode: QUIT must be an ASCII character");
5737 #ifdef POLL_FOR_INPUT
5743 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5744 #ifdef NO_SOCK_SIGIO
5745 if (read_socket_hook
)
5746 interrupt_input
= 0; /* No interrupts if reading from a socket. */
5748 #endif /* NO_SOCK_SIGIO */
5749 interrupt_input
= !NILP (interrupt
);
5750 #else /* not SIGIO */
5751 interrupt_input
= 0;
5752 #endif /* not SIGIO */
5753 /* Our VMS input only works by interrupts, as of now. */
5755 interrupt_input
= 1;
5757 flow_control
= !NILP (flow
);
5760 else if (EQ (meta
, Qt
))
5765 /* Don't let this value be out of range. */
5766 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
5770 #ifdef POLL_FOR_INPUT
5771 poll_suppress_count
= 1;
5777 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
5778 "Return information about the way Emacs currently reads keyboard input.\n\
5779 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
5780 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
5781 nil, Emacs is using CBREAK mode.\n\
5782 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
5783 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
5784 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
5785 META nil means ignoring the top bit, on the assumption it is parity.\n\
5786 META is neither t nor nil if accepting 8-bit input and using\n\
5787 all 8 bits as the character code.\n\
5788 QUIT is the character Emacs currently uses to quit.\n\
5789 The elements of this list correspond to the arguments of\n\
5795 val
[0] = interrupt_input
? Qt
: Qnil
;
5796 val
[1] = flow_control
? Qt
: Qnil
;
5797 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
5798 XFASTINT (val
[3]) = quit_char
;
5800 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
5806 /* This is correct before outermost invocation of the editor loop */
5807 command_loop_level
= -1;
5809 quit_char
= Ctl ('g');
5810 Vunread_command_events
= Qnil
;
5811 unread_command_char
= -1;
5813 recent_keys_index
= 0;
5814 kbd_fetch_ptr
= kbd_buffer
;
5815 kbd_store_ptr
= kbd_buffer
;
5816 do_mouse_tracking
= 0;
5820 /* This means that command_loop_1 won't try to select anything the first
5822 internal_last_event_frame
= Qnil
;
5823 Vlast_event_frame
= internal_last_event_frame
;
5826 /* If we're running a dumped Emacs, we need to clear out
5827 kbd_buffer_frame_or_window, in case some events got into it
5830 If we're running an undumped Emacs, it hasn't been initialized by
5831 syms_of_keyboard yet. */
5833 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5835 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
5837 signal (SIGINT
, interrupt_signal
);
5838 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
5839 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
5840 SIGQUIT and we can't tell which one it will give us. */
5841 signal (SIGQUIT
, interrupt_signal
);
5842 #endif /* HAVE_TERMIO */
5844 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5846 if (!noninteractive
)
5847 signal (SIGIO
, input_available_signal
);
5850 /* Use interrupt input by default, if it works and noninterrupt input
5851 has deficiencies. */
5853 #ifdef INTERRUPT_INPUT
5854 interrupt_input
= 1;
5856 interrupt_input
= 0;
5859 /* Our VMS input only works by interrupts, as of now. */
5861 interrupt_input
= 1;
5867 if (keyboard_init_hook
)
5868 (*keyboard_init_hook
) ();
5870 #ifdef POLL_FOR_INPUT
5871 poll_suppress_count
= 1;
5876 /* This type's only use is in syms_of_keyboard, to initialize the
5877 event header symbols and put properties on them. */
5884 struct event_head head_table
[] = {
5885 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
5886 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
5887 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
5892 Qdisabled_command_hook
= intern ("disabled-command-hook");
5893 staticpro (&Qdisabled_command_hook
);
5895 Qself_insert_command
= intern ("self-insert-command");
5896 staticpro (&Qself_insert_command
);
5898 Qforward_char
= intern ("forward-char");
5899 staticpro (&Qforward_char
);
5901 Qbackward_char
= intern ("backward-char");
5902 staticpro (&Qbackward_char
);
5904 Qdisabled
= intern ("disabled");
5905 staticpro (&Qdisabled
);
5907 Qundefined
= intern ("undefined");
5908 staticpro (&Qundefined
);
5910 Qpre_command_hook
= intern ("pre-command-hook");
5911 staticpro (&Qpre_command_hook
);
5913 Qpost_command_hook
= intern ("post-command-hook");
5914 staticpro (&Qpost_command_hook
);
5916 Qcommand_hook_internal
= intern ("command-hook-internal");
5917 staticpro (&Qcommand_hook_internal
);
5919 Qfunction_key
= intern ("function-key");
5920 staticpro (&Qfunction_key
);
5921 Qmouse_click
= intern ("mouse-click");
5922 staticpro (&Qmouse_click
);
5924 Qmenu_enable
= intern ("menu-enable");
5925 staticpro (&Qmenu_enable
);
5927 Qmode_line
= intern ("mode-line");
5928 staticpro (&Qmode_line
);
5929 Qvertical_line
= intern ("vertical-line");
5930 staticpro (&Qvertical_line
);
5931 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
5932 staticpro (&Qvertical_scroll_bar
);
5933 Qmenu_bar
= intern ("menu-bar");
5934 staticpro (&Qmenu_bar
);
5936 Qabove_handle
= intern ("above-handle");
5937 staticpro (&Qabove_handle
);
5938 Qhandle
= intern ("handle");
5939 staticpro (&Qhandle
);
5940 Qbelow_handle
= intern ("below-handle");
5941 staticpro (&Qbelow_handle
);
5943 Qevent_kind
= intern ("event-kind");
5944 staticpro (&Qevent_kind
);
5945 Qevent_symbol_elements
= intern ("event-symbol-elements");
5946 staticpro (&Qevent_symbol_elements
);
5947 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
5948 staticpro (&Qevent_symbol_element_mask
);
5949 Qmodifier_cache
= intern ("modifier-cache");
5950 staticpro (&Qmodifier_cache
);
5952 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
5953 staticpro (&Qrecompute_lucid_menubar
);
5954 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
5955 staticpro (&Qactivate_menubar_hook
);
5957 Qpolling_period
= intern ("polling-period");
5958 staticpro (&Qpolling_period
);
5961 struct event_head
*p
;
5963 for (p
= head_table
;
5964 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
5967 *p
->var
= intern (p
->name
);
5969 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
5970 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
5974 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
5975 staticpro (&button_down_location
);
5979 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
5981 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
5982 for (i
= 0; i
< len
; i
++)
5983 if (modifier_names
[i
])
5984 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
5985 staticpro (&modifier_symbols
);
5988 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
5989 staticpro (&recent_keys
);
5991 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
5992 staticpro (&this_command_keys
);
5994 Qextended_command_history
= intern ("extended-command-history");
5995 Fset (Qextended_command_history
, Qnil
);
5996 staticpro (&Qextended_command_history
);
5998 kbd_buffer_frame_or_window
5999 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
6000 staticpro (&kbd_buffer_frame_or_window
);
6002 accent_key_syms
= Qnil
;
6003 staticpro (&accent_key_syms
);
6005 func_key_syms
= Qnil
;
6006 staticpro (&func_key_syms
);
6008 system_key_syms
= Qnil
;
6009 staticpro (&system_key_syms
);
6012 staticpro (&mouse_syms
);
6014 unread_switch_frame
= Qnil
;
6015 staticpro (&unread_switch_frame
);
6017 defsubr (&Sread_key_sequence
);
6018 defsubr (&Srecursive_edit
);
6019 defsubr (&Strack_mouse
);
6020 defsubr (&Sinput_pending_p
);
6021 defsubr (&Scommand_execute
);
6022 defsubr (&Srecent_keys
);
6023 defsubr (&Sthis_command_keys
);
6024 defsubr (&Ssuspend_emacs
);
6025 defsubr (&Sabort_recursive_edit
);
6026 defsubr (&Sexit_recursive_edit
);
6027 defsubr (&Srecursion_depth
);
6028 defsubr (&Stop_level
);
6029 defsubr (&Sdiscard_input
);
6030 defsubr (&Sopen_dribble_file
);
6031 defsubr (&Sset_input_mode
);
6032 defsubr (&Scurrent_input_mode
);
6033 defsubr (&Sexecute_extended_command
);
6035 DEFVAR_LISP ("last-command-char", &last_command_char
,
6036 "Last input event that was part of a command.");
6038 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
6039 "Last input event that was part of a command.");
6041 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
6042 "Last input event in a command, except for mouse menu events.\n\
6043 Mouse menus give back keys that don't look like mouse events;\n\
6044 this variable holds the actual mouse event that led to the menu,\n\
6045 so that you can determine whether the command was run by mouse or not.");
6047 DEFVAR_LISP ("last-input-char", &last_input_char
,
6048 "Last input event.");
6050 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
6051 "Last input event.");
6053 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
6054 "List of objects to be read as next command input events.");
6056 DEFVAR_INT ("unread-command-char", &unread_command_char
,
6057 "If not -1, an object to be read as next command input event.");
6059 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
6060 "Meta-prefix character code. Meta-foo as command input\n\
6061 turns into this character followed by foo.");
6062 XSET (meta_prefix_char
, Lisp_Int
, 033);
6064 DEFVAR_LISP ("last-command", &last_command
,
6065 "The last command executed. Normally a symbol with a function definition,\n\
6066 but can be whatever was found in the keymap, or whatever the variable\n\
6067 `this-command' was set to by that command.");
6068 last_command
= Qnil
;
6070 DEFVAR_LISP ("this-command", &this_command
,
6071 "The command now being executed.\n\
6072 The command can set this variable; whatever is put here\n\
6073 will be in `last-command' during the following command.");
6074 this_command
= Qnil
;
6076 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
6077 "*Number of keyboard input characters between auto-saves.\n\
6078 Zero means disable autosaving due to number of characters typed.");
6079 auto_save_interval
= 300;
6081 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
6082 "*Number of seconds idle time before auto-save.\n\
6083 Zero or nil means disable auto-saving due to idleness.\n\
6084 After auto-saving due to this many seconds of idle time,\n\
6085 Emacs also does a garbage collection if that seems to be warranted.");
6086 XFASTINT (Vauto_save_timeout
) = 30;
6088 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
6089 "*Nonzero means echo unfinished commands after this many seconds of pause.");
6090 echo_keystrokes
= 1;
6092 DEFVAR_INT ("polling-period", &polling_period
,
6093 "*Interval between polling for input during Lisp execution.\n\
6094 The reason for polling is to make C-g work to stop a running program.\n\
6095 Polling is needed only when using X windows and SIGIO does not work.\n\
6096 Polling is automatically disabled in all other cases.");
6099 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
6100 "*Maximum time between mouse clicks to make a double-click.\n\
6101 Measured in milliseconds. nil means disable double-click recognition;\n\
6102 t means double-clicks have no time limit and are detected\n\
6103 by position only.");
6104 Vdouble_click_time
= make_number (500);
6106 DEFVAR_INT ("num-input-keys", &num_input_keys
,
6107 "*Number of complete keys read from the keyboard so far.");
6110 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
6111 "*The frame in which the most recently read event occurred.\n\
6112 If the last event came from a keyboard macro, this is set to `macro'.");
6113 Vlast_event_frame
= Qnil
;
6115 DEFVAR_LISP ("help-char", &Vhelp_char
,
6116 "Character to recognize as meaning Help.\n\
6117 When it is read, do `(eval help-form)', and display result if it's a string.\n\
6118 If the value of `help-form' is nil, this char can be read normally.");
6119 XSET (Vhelp_char
, Lisp_Int
, Ctl ('H'));
6121 DEFVAR_LISP ("help-form", &Vhelp_form
,
6122 "Form to execute when character `help-char' is read.\n\
6123 If the form returns a string, that string is displayed.\n\
6124 If `help-form' is nil, the help char is not recognized.");
6127 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
6128 "Command to run when `help-char' character follows a prefix key.\n\
6129 This command is used only when there is no actual binding\n\
6130 for that character after that prefix key.");
6131 Vprefix_help_command
= Qnil
;
6133 DEFVAR_LISP ("top-level", &Vtop_level
,
6134 "Form to evaluate when Emacs starts up.\n\
6135 Useful to set before you dump a modified Emacs.");
6138 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
6139 "String used as translate table for keyboard input, or nil.\n\
6140 Each character is looked up in this string and the contents used instead.\n\
6141 If string is of length N, character codes N and up are untranslated.");
6142 Vkeyboard_translate_table
= Qnil
;
6144 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
6145 "Keymap of key translations that can override keymaps.\n\
6146 This keymap works like `function-key-map', but comes after that,\n\
6147 and applies even for keys that have ordinary bindings.");
6148 Vkey_translation_map
= Qnil
;
6150 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
6151 "Non-nil means to always spawn a subshell instead of suspending,\n\
6152 even if the operating system has support for stopping a process.");
6155 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
6156 "Non-nil means prompt with menus when appropriate.\n\
6157 This is done when reading from a keymap that has a prompt string,\n\
6158 for elements that have prompt strings.\n\
6159 The menu is displayed on the screen\n\
6160 if X menus were enabled at configuration\n\
6161 time and the previous event was a mouse click prefix key.\n\
6162 Otherwise, menu prompting uses the echo area.");
6165 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
6166 "Character to see next line of menu prompt.\n\
6167 Type this character while in a menu prompt to rotate around the lines of it.");
6168 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
6170 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
6171 "A mask of additional modifier keys to use with every keyboard character.\n\
6172 Emacs applies the modifiers of the character stored here to each keyboard\n\
6173 character it reads. For example, after evaluating the expression\n\
6174 (setq extra-keyboard-modifiers ?\C-x)\n\
6175 all input characters will have the control modifier applied to them.\n\
6177 Note that the character ?\C-@, equivalent to the integer zero, does\n\
6178 not count as a control character; rather, it counts as a character\n\
6179 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
6180 cancels any modification.");
6181 extra_keyboard_modifiers
= 0;
6183 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
6184 "If an editing command sets this to t, deactivate the mark afterward.\n\
6185 The command loop sets this to nil before each command,\n\
6186 and tests the value when the command returns.\n\
6187 Buffer modification stores t in this variable.");
6188 Vdeactivate_mark
= Qnil
;
6190 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
6191 "Temporary storage of pre-command-hook or post-command-hook.");
6192 Vcommand_hook_internal
= Qnil
;
6194 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
6195 "Normal hook run before each command is executed.\n\
6196 While the hook is run, its value is temporarily set to nil\n\
6197 to avoid an unbreakable infinite loop if a hook function gets an error.\n\
6198 As a result, a hook function cannot straightforwardly alter the value of\n\
6199 `pre-command-hook'. See the Emacs Lisp manual for a way of\n\
6200 implementing hook functions that alter the set of hook functions.");
6201 Vpre_command_hook
= Qnil
;
6203 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
6204 "Normal hook run after each command is executed.\n\
6205 While the hook is run, its value is temporarily set to nil\n\
6206 to avoid an unbreakable infinite loop if a hook function gets an error.\n\
6207 As a result, a hook function cannot straightforwardly alter the value of\n\
6208 `post-command-hook'. See the Emacs Lisp manual for a way of\n\
6209 implementing hook functions that alter the set of hook functions.");
6210 Vpost_command_hook
= Qnil
;
6212 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
6213 "t means menu bar, specified Lucid style, needs to be recomputed.");
6214 Vlucid_menu_bar_dirty_flag
= Qnil
;
6216 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
6217 "List of menu bar items to move to the end of the menu bar.\n\
6218 The elements of the list are event types that may have menu bar bindings.");
6219 Vmenu_bar_final_items
= Qnil
;
6221 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
6222 "Keymap that overrides all other local keymaps.\n\
6223 If this variable is non-nil, it is used as a keymap instead of the\n\
6224 buffer's local map, and the minor mode keymaps and text property keymaps.");
6225 Voverriding_local_map
= Qnil
;
6227 DEFVAR_BOOL ("track-mouse", &do_mouse_tracking
,
6228 "*Non-nil means generate motion events for mouse motion.");
6230 DEFVAR_LISP ("system-key-alist", &Vsystem_key_alist
,
6231 "Alist of system-specific X windows key symbols.\n\
6232 Each element should have the form (N . SYMBOL) where N is the\n\
6233 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
6234 and SYMBOL is its name.");
6235 Vsystem_key_alist
= Qnil
;
6237 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
6238 "List of deferred actions to be performed at a later time.\n\
6239 The precise format isn't relevant here; we just check whether it is nil.");
6240 Vdeferred_action_list
= Qnil
;
6242 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
6243 "Function to call to handle deferred actions, after each command.\n\
6244 This function is called with no arguments after each command\n\
6245 whenever `deferred-action-list' is non-nil.");
6246 Vdeferred_action_function
= Qnil
;
6251 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
6252 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
6253 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
6254 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
6255 initial_define_key (meta_map
, 'x', "execute-extended-command");