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 /* Nonzero if polling_for_input is actually being used. */
1300 int polling_for_input
;
1302 #ifdef POLL_FOR_INPUT
1304 /* Handle an alarm once each second and read pending input
1305 so as to handle a C-g if it comces in. */
1308 input_poll_signal ()
1310 if (interrupt_input_blocked
== 0
1311 && !waiting_for_input
)
1312 read_avail_input (0);
1313 signal (SIGALRM
, input_poll_signal
);
1314 alarm (polling_period
);
1319 /* Begin signals to poll for input, if they are appropriate.
1320 This function is called unconditionally from various places. */
1324 #ifdef POLL_FOR_INPUT
1325 if (read_socket_hook
&& !interrupt_input
)
1327 poll_suppress_count
--;
1328 if (poll_suppress_count
== 0)
1330 signal (SIGALRM
, input_poll_signal
);
1331 polling_for_input
= 1;
1332 alarm (polling_period
);
1338 /* Nonzero if we are using polling to handle input asynchronously. */
1341 input_polling_used ()
1343 #ifdef POLL_FOR_INPUT
1344 return read_socket_hook
&& !interrupt_input
;
1350 /* Turn off polling. */
1354 #ifdef POLL_FOR_INPUT
1355 if (read_socket_hook
&& !interrupt_input
)
1357 if (poll_suppress_count
== 0)
1359 polling_for_input
= 0;
1362 poll_suppress_count
++;
1367 /* Set the value of poll_suppress_count to COUNT
1368 and start or stop polling accordingly. */
1371 set_poll_suppress_count (count
)
1374 #ifdef POLL_FOR_INPUT
1375 if (count
== 0 && poll_suppress_count
!= 0)
1377 poll_suppress_count
= 1;
1380 else if (count
!= 0 && poll_suppress_count
== 0)
1384 poll_suppress_count
= count
;
1388 /* Bind polling_period to a value at least N.
1389 But don't decrease it. */
1391 bind_polling_period (n
)
1394 #ifdef POLL_FOR_INPUT
1395 int new = polling_period
;
1401 specbind (Qpolling_period
, make_number (new));
1402 /* Start a new alarm with the new period. */
1407 /* Applying the control modifier to CHARACTER. */
1412 /* Save the upper bits here. */
1413 int upper
= c
& ~0177;
1417 /* Everything in the columns containing the upper-case letters
1418 denotes a control character. */
1419 if (c
>= 0100 && c
< 0140)
1423 /* Set the shift modifier for a control char
1424 made from a shifted letter. But only for letters! */
1425 if (oc
>= 'A' && oc
<= 'Z')
1426 c
|= shift_modifier
;
1429 /* The lower-case letters denote control characters too. */
1430 else if (c
>= 'a' && c
<= 'z')
1433 /* Include the bits for control and shift
1434 only if the basic ASCII code can't indicate them. */
1438 /* Replace the high bits. */
1439 c
|= (upper
& ~ctrl_modifier
);
1446 /* Input of single characters from keyboard */
1448 Lisp_Object
print_help ();
1449 static Lisp_Object
kbd_buffer_get_event ();
1451 /* read a character from the keyboard; call the redisplay if needed */
1452 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1453 -1 means do not do redisplay, but do do autosaving.
1456 /* The arguments MAPS and NMAPS are for menu prompting.
1457 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1459 PREV_EVENT is the previous input event, or nil if we are reading
1460 the first event of a key sequence.
1462 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1463 if we used a mouse menu to read the input, or zero otherwise. If
1464 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
1466 Value is t if we showed a menu and the user rejected it. */
1469 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1473 Lisp_Object prev_event
;
1474 int *used_mouse_menu
;
1476 register Lisp_Object c
;
1480 if (CONSP (Vunread_command_events
))
1482 c
= XCONS (Vunread_command_events
)->car
;
1483 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1485 if (this_command_key_count
== 0)
1491 if (unread_command_char
!= -1)
1493 XSET (c
, Lisp_Int
, unread_command_char
);
1494 unread_command_char
= -1;
1496 if (this_command_key_count
== 0)
1502 if (!NILP (Vexecuting_macro
))
1505 /* We set this to Qmacro; since that's not a frame, nobody will
1506 try to switch frames on us, and the selected window will
1509 Since this event came from a macro, it would be misleading to
1510 leave internal_last_event_frame set to wherever the last
1511 real event came from. Normally, a switch-frame event selects
1512 internal_last_event_frame after each command is read, but
1513 events read from a macro should never cause a new frame to be
1515 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1518 /* Exit the macro if we are at the end.
1519 Also, some things replace the macro with t
1520 to force an early exit. */
1521 if (EQ (Vexecuting_macro
, Qt
)
1522 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1524 XSET (c
, Lisp_Int
, -1);
1528 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1529 if (XTYPE (Vexecuting_macro
) == Lisp_String
1530 && (XINT (c
) & 0x80))
1531 XFASTINT (c
) = CHAR_META
| (XINT (c
) & ~0x80);
1533 executing_macro_index
++;
1538 if (!NILP (unread_switch_frame
))
1540 c
= unread_switch_frame
;
1541 unread_switch_frame
= Qnil
;
1543 /* This event should make it into this_command_keys, and get echoed
1544 again, so we go to reread_first, rather than reread. */
1548 /* Don't bother updating menu bars while doing mouse tracking.
1549 We get events very rapidly then, and the menu bar won't be changing.
1550 We do update the menu bar once on entry to Ftrack_mouse. */
1551 if (commandflag
> 0 && !input_pending
&& !detect_input_pending ())
1552 prepare_menu_bars ();
1554 /* Save outer setjmp data, in case called recursively. */
1555 save_getcjmp (save_jump
);
1559 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1562 if (_setjmp (getcjmp
))
1564 XSET (c
, Lisp_Int
, quit_char
);
1566 XSET (internal_last_event_frame
, Lisp_Frame
, selected_frame
);
1567 Vlast_event_frame
= internal_last_event_frame
;
1569 /* If we report the quit char as an event,
1570 don't do so more than once. */
1571 if (!NILP (Vinhibit_quit
))
1577 /* Message turns off echoing unless more keystrokes turn it on again. */
1578 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1581 /* If already echoing, continue. */
1584 /* Try reading a character via menu prompting in the minibuf.
1585 Try this before the sit-for, because the sit-for
1586 would do the wrong thing if we are supposed to do
1587 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1588 after a mouse event so don't try a minibuf menu. */
1590 if (nmaps
> 0 && INTERACTIVE
1591 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1592 /* Don't bring up a menu if we already have another event. */
1593 && NILP (Vunread_command_events
)
1594 && unread_command_char
< 0
1595 && !detect_input_pending ())
1597 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1602 /* If in middle of key sequence and minibuffer not active,
1603 start echoing if enough time elapses. */
1604 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1606 && echo_keystrokes
> 0
1607 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1611 /* After a mouse event, start echoing right away.
1612 This is because we are probably about to display a menu,
1613 and we don't want to delay before doing so. */
1614 if (EVENT_HAS_PARAMETERS (prev_event
))
1618 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1624 /* Maybe auto save due to number of keystrokes or idle time. */
1626 if (commandflag
!= 0
1627 && auto_save_interval
> 0
1628 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1629 && !detect_input_pending ())
1632 save_getcjmp (temp
);
1633 Fdo_auto_save (Qnil
, Qnil
);
1634 restore_getcjmp (temp
);
1637 /* Try reading using an X menu.
1638 This is never confused with reading using the minibuf
1639 because the recursive call of read_char in read_char_minibuf_menu_prompt
1640 does not pass on any keymaps. */
1641 if (nmaps
> 0 && INTERACTIVE
1642 && !NILP (prev_event
) && EVENT_HAS_PARAMETERS (prev_event
)
1643 /* Don't bring up a menu if we already have another event. */
1644 && NILP (Vunread_command_events
)
1645 && unread_command_char
< 0)
1646 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1648 /* Slow down auto saves logarithmically in size of current buffer,
1649 and garbage collect while we're at it. */
1650 if (INTERACTIVE
&& NILP (c
))
1652 int delay_level
, buffer_size
;
1654 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1655 last_non_minibuf_size
= Z
- BEG
;
1656 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1658 while (buffer_size
> 64)
1659 delay_level
++, buffer_size
-= buffer_size
>> 2;
1660 if (delay_level
< 4) delay_level
= 4;
1661 /* delay_level is 4 for files under around 50k, 7 at 100k,
1662 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1664 /* Auto save if enough time goes by without input. */
1665 if (commandflag
!= 0
1666 && num_nonmacro_input_chars
> last_auto_save
1667 && XTYPE (Vauto_save_timeout
) == Lisp_Int
1668 && XINT (Vauto_save_timeout
) > 0)
1671 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1672 tem0
= sit_for (delay
, 0, 1, 1);
1676 save_getcjmp (temp
);
1677 Fdo_auto_save (Qnil
, Qnil
);
1678 restore_getcjmp (temp
);
1680 /* If we have auto-saved and there is still no input
1681 available, garbage collect if there has been enough
1682 consing going on to make it worthwhile. */
1683 if (!detect_input_pending ()
1684 && consing_since_gc
> gc_cons_threshold
/ 2)
1686 Fgarbage_collect ();
1687 /* prepare_menu_bars isn't safe here, but it should
1688 also be unnecessary. */
1695 /* Actually read a character, waiting if necessary. */
1698 c
= kbd_buffer_get_event ();
1701 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1703 prepare_menu_bars ();
1708 /* Terminate Emacs in batch mode if at eof. */
1709 if (noninteractive
&& XTYPE (c
) == Lisp_Int
&& XINT (c
) < 0)
1710 Fkill_emacs (make_number (1));
1712 if (XTYPE (c
) == Lisp_Int
)
1714 /* Add in any extra modifiers, where appropriate. */
1715 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1716 || ((extra_keyboard_modifiers
& 0177) < ' '
1717 && (extra_keyboard_modifiers
& 0177) != 0))
1718 XSETINT (c
, make_ctrl_char (XINT (c
)));
1720 /* Transfer any other modifier bits directly from
1721 extra_keyboard_modifiers to c. Ignore the actual character code
1722 in the low 16 bits of extra_keyboard_modifiers. */
1723 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
1728 restore_getcjmp (save_jump
);
1732 /* Buffer switch events are only for internal wakeups
1733 so don't show them to the user. */
1734 if (XTYPE (c
) == Lisp_Buffer
)
1737 /* Wipe the echo area. */
1738 echo_area_glyphs
= 0;
1740 /* Handle things that only apply to characters. */
1741 if (XTYPE (c
) == Lisp_Int
)
1743 /* If kbd_buffer_get_event gave us an EOF, return that. */
1747 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
1748 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1749 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1753 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1754 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1755 recent_keys_index
= 0;
1757 /* Write c to the dribble file. If c is a lispy event, write
1758 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1759 If you, dear reader, have a better idea, you've got the source. :-) */
1762 if (XTYPE (c
) == Lisp_Int
)
1764 if (XUINT (c
) < 0x100)
1765 putc (XINT (c
), dribble
);
1767 fprintf (dribble
, " 0x%x", XUINT (c
));
1771 Lisp_Object dribblee
;
1773 /* If it's a structured event, take the event header. */
1774 dribblee
= EVENT_HEAD (c
);
1776 if (XTYPE (dribblee
) == Lisp_Symbol
)
1778 putc ('<', dribble
);
1779 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1780 XSYMBOL (dribblee
)->name
->size
,
1782 putc ('>', dribble
);
1789 store_kbd_macro_char (c
);
1791 num_nonmacro_input_chars
++;
1796 /* Don't echo mouse motion events. */
1797 if (! (EVENT_HAS_PARAMETERS (c
)
1798 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1801 /* Record this character as part of the current key. */
1802 add_command_key (c
);
1804 /* Re-reading in the middle of a command */
1806 last_input_char
= c
;
1809 /* Process the help character specially if enabled */
1810 if (EQ (c
, Vhelp_char
) && !NILP (Vhelp_form
))
1813 count
= specpdl_ptr
- specpdl
;
1815 record_unwind_protect (Fset_window_configuration
,
1816 Fcurrent_window_configuration (Qnil
));
1818 tem0
= Feval (Vhelp_form
);
1819 if (XTYPE (tem0
) == Lisp_String
)
1820 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1824 c
= read_char (0, 0, 0, Qnil
, 0);
1825 while (XTYPE (c
) == Lisp_Buffer
);
1826 /* Remove the help from the frame */
1827 unbind_to (count
, Qnil
);
1828 prepare_menu_bars ();
1830 if (EQ (c
, make_number (040)))
1834 c
= read_char (0, 0, 0, Qnil
, 0);
1835 while (XTYPE (c
) == Lisp_Buffer
);
1846 Fprinc (object
, Qnil
);
1850 /* Copy out or in the info on where C-g should throw to.
1851 This is used when running Lisp code from within get_char,
1852 in case get_char is called recursively.
1853 See read_process_output. */
1858 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1861 restore_getcjmp (temp
)
1864 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1868 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1869 of this function. */
1871 tracking_off (old_value
)
1872 Lisp_Object old_value
;
1874 if (! XFASTINT (old_value
))
1876 do_mouse_tracking
= 0;
1878 /* Redisplay may have been preempted because there was input
1879 available, and it assumes it will be called again after the
1880 input has been processed. If the only input available was
1881 the sort that we have just disabled, then we need to call
1883 if (!readable_events ())
1885 prepare_menu_bars ();
1886 redisplay_preserve_echo_area ();
1887 get_input_pending (&input_pending
);
1892 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1893 "Evaluate BODY with mouse movement events enabled.\n\
1894 Within a `track-mouse' form, mouse motion generates input events that\n\
1895 you can read with `read-event'.\n\
1896 Normally, mouse motion is ignored.")
1900 int count
= specpdl_ptr
- specpdl
;
1903 XSET (val
, Lisp_Int
, do_mouse_tracking
);
1904 record_unwind_protect (tracking_off
, val
);
1906 if (!input_pending
&& !detect_input_pending ())
1907 prepare_menu_bars ();
1909 do_mouse_tracking
= 1;
1911 val
= Fprogn (args
);
1912 return unbind_to (count
, val
);
1915 /* Low level keyboard/mouse input.
1916 kbd_buffer_store_event places events in kbd_buffer, and
1917 kbd_buffer_get_event retrieves them.
1918 mouse_moved indicates when the mouse has moved again, and
1919 *mouse_position_hook provides the mouse position. */
1921 /* Return true iff there are any events in the queue that read-char
1922 would return. If this returns false, a read-char would block. */
1926 return ! EVENT_QUEUES_EMPTY
;
1929 /* Set this for debugging, to have a way to get out */
1932 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
1935 kbd_buffer_store_event (event
)
1936 register struct input_event
*event
;
1938 if (event
->kind
== no_event
)
1941 if (event
->kind
== ascii_keystroke
)
1943 register int c
= event
->code
& 0377;
1945 if (event
->modifiers
& ctrl_modifier
)
1946 c
= make_ctrl_char (c
);
1948 c
|= (event
->modifiers
1949 & (meta_modifier
| alt_modifier
1950 | hyper_modifier
| super_modifier
));
1954 extern SIGTYPE
interrupt_signal ();
1957 /* If this results in a quit_char being returned to Emacs as
1958 input, set Vlast_event_frame properly. If this doesn't
1959 get returned to Emacs as an event, the next event read
1960 will set Vlast_event_frame again, so this is safe to do. */
1964 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
1966 internal_last_event_frame
= event
->frame_or_window
;
1968 internal_last_event_frame
= focus
;
1969 Vlast_event_frame
= internal_last_event_frame
;
1973 last_event_timestamp
= event
->timestamp
;
1974 interrupt_signal ();
1978 if (c
&& c
== stop_character
)
1985 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
1986 kbd_store_ptr
= kbd_buffer
;
1988 /* Don't let the very last slot in the buffer become full,
1989 since that would make the two pointers equal,
1990 and that is indistinguishable from an empty buffer.
1991 Discard the event if it would fill the last slot. */
1992 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
1994 kbd_store_ptr
->kind
= event
->kind
;
1995 if (event
->kind
== selection_request_event
)
1997 /* We must not use the ordinary copying code for this case,
1998 since `part' is an enum and copying it might not copy enough
2000 bcopy (event
, kbd_store_ptr
, sizeof (*event
));
2004 kbd_store_ptr
->code
= event
->code
;
2005 kbd_store_ptr
->part
= event
->part
;
2006 kbd_store_ptr
->frame_or_window
= event
->frame_or_window
;
2007 kbd_store_ptr
->modifiers
= event
->modifiers
;
2008 kbd_store_ptr
->x
= event
->x
;
2009 kbd_store_ptr
->y
= event
->y
;
2010 kbd_store_ptr
->timestamp
= event
->timestamp
;
2012 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
2014 = event
->frame_or_window
);
2020 /* Read one event from the event buffer, waiting if necessary.
2021 The value is a Lisp object representing the event.
2022 The value is nil for an event that should be ignored,
2023 or that was handled here.
2024 We always read and discard one event. */
2027 kbd_buffer_get_event ()
2035 XSET (obj
, Lisp_Int
, c
);
2039 /* Wait until there is input available. */
2042 if (!EVENT_QUEUES_EMPTY
)
2045 /* If the quit flag is set, then read_char will return
2046 quit_char, so that counts as "available input." */
2047 if (!NILP (Vquit_flag
))
2048 quit_throw_to_read_char ();
2050 /* One way or another, wait until input is available; then, if
2051 interrupt handlers have not read it, read it now. */
2054 wait_for_kbd_input ();
2056 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2060 if (EVENT_QUEUES_EMPTY
)
2062 Lisp_Object minus_one
;
2064 XSET (minus_one
, Lisp_Int
, -1);
2065 wait_reading_process_input (0, 0, minus_one
, 1);
2067 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
2068 /* Pass 1 for EXPECT since we just waited to have input. */
2069 read_avail_input (1);
2071 #endif /* not VMS */
2074 /* At this point, we know that there is a readable event available
2075 somewhere. If the event queue is empty, then there must be a
2076 mouse movement enabled and available. */
2077 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2079 struct input_event
*event
;
2081 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2085 last_event_timestamp
= event
->timestamp
;
2089 /* These two kinds of events get special handling
2090 and don't actually appear to the command loop.
2091 We return nil for them. */
2092 if (event
->kind
== selection_request_event
)
2095 x_handle_selection_request (event
);
2096 kbd_fetch_ptr
= event
+ 1;
2098 /* We're getting selection request events, but we don't have
2104 else if (event
->kind
== selection_clear_event
)
2107 x_handle_selection_clear (event
);
2108 kbd_fetch_ptr
= event
+ 1;
2110 /* We're getting selection request events, but we don't have
2116 else if (event
->kind
== delete_window_event
)
2118 Lisp_Object tail
, frame
;
2121 /* If the user destroys the only frame, Emacs should exit.
2122 Count visible frames and iconified frames. */
2123 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2125 frame
= XCONS (tail
)->car
;
2126 if (XTYPE (frame
) != Lisp_Frame
|| EQ (frame
, event
->frame_or_window
))
2129 if (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
))
2136 Fdelete_frame (event
->frame_or_window
, Qt
);
2137 kbd_fetch_ptr
= event
+ 1;
2140 else if (event
->kind
== menu_bar_event
)
2142 /* The event value is in the frame_or_window slot. */
2143 obj
= event
->frame_or_window
;
2144 kbd_fetch_ptr
= event
+ 1;
2146 else if (event
->kind
== buffer_switch_event
)
2148 /* The value doesn't matter here; only the type is tested. */
2149 XSET (obj
, Lisp_Buffer
, current_buffer
);
2150 kbd_fetch_ptr
= event
+ 1;
2152 /* Just discard these, by returning nil.
2153 (They shouldn't be found in the buffer,
2154 but on some machines it appears they do show up.) */
2155 else if (event
->kind
== no_event
)
2156 kbd_fetch_ptr
= event
+ 1;
2158 /* If this event is on a different frame, return a switch-frame this
2159 time, and leave the event in the queue for next time. */
2166 frame
= event
->frame_or_window
;
2167 if (XTYPE (frame
) == Lisp_Window
)
2168 frame
= WINDOW_FRAME (XWINDOW (frame
));
2170 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2174 if (! EQ (frame
, internal_last_event_frame
)
2175 && XFRAME (frame
) != selected_frame
)
2176 obj
= make_lispy_switch_frame (frame
);
2177 internal_last_event_frame
= frame
;
2178 #endif /* MULTI_FRAME */
2180 /* If we didn't decide to make a switch-frame event, go ahead
2181 and build a real event from the queue entry. */
2185 obj
= make_lispy_event (event
);
2187 /* Wipe out this event, to catch bugs. */
2188 event
->kind
= no_event
;
2189 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
2192 kbd_fetch_ptr
= event
+ 1;
2196 /* Try generating a mouse motion event. */
2197 else if (do_mouse_tracking
&& mouse_moved
)
2200 Lisp_Object bar_window
;
2201 enum scroll_bar_part part
;
2205 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
2210 /* Decide if we should generate a switch-frame event. Don't
2211 generate switch-frame events for motion outside of all Emacs
2217 frame
= FRAME_FOCUS_FRAME (f
);
2219 XSET (frame
, Lisp_Frame
, f
);
2221 if (! EQ (frame
, internal_last_event_frame
)
2222 && XFRAME (frame
) != selected_frame
)
2223 obj
= make_lispy_switch_frame (frame
);
2224 internal_last_event_frame
= frame
;
2228 #if defined(MULTI_FRAME) || defined(HAVE_MOUSE)
2229 /* If we didn't decide to make a switch-frame event, go ahead and
2230 return a mouse-motion event. */
2232 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2236 /* We were promised by the above while loop that there was
2237 something for us to read! */
2240 input_pending
= readable_events ();
2243 Vlast_event_frame
= internal_last_event_frame
;
2249 /* Process any events that are not user-visible,
2250 then return, without reading any user-visible events. */
2255 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2257 struct input_event
*event
;
2259 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2263 last_event_timestamp
= event
->timestamp
;
2265 /* These two kinds of events get special handling
2266 and don't actually appear to the command loop. */
2267 if (event
->kind
== selection_request_event
)
2270 x_handle_selection_request (event
);
2271 kbd_fetch_ptr
= event
+ 1;
2273 /* We're getting selection request events, but we don't have
2279 else if (event
->kind
== selection_clear_event
)
2282 x_handle_selection_clear (event
);
2283 kbd_fetch_ptr
= event
+ 1;
2285 /* We're getting selection request events, but we don't have
2294 get_input_pending (&input_pending
);
2297 /* Caches for modify_event_symbol. */
2298 static Lisp_Object accent_key_syms
;
2299 static Lisp_Object system_key_syms
;
2300 static Lisp_Object func_key_syms
;
2301 static Lisp_Object mouse_syms
;
2303 Lisp_Object Vsystem_key_alist
;
2305 /* This is a list of keysym codes for special "accent" characters.
2306 It parallels lispy_accent_keys. */
2308 static int lispy_accent_codes
[] =
2310 #ifdef XK_dead_circumflex
2315 #ifdef XK_dead_grave
2320 #ifdef XK_dead_tilde
2325 #ifdef XK_dead_diaeresis
2330 #ifdef XK_dead_macron
2335 #ifdef XK_dead_degree
2340 #ifdef XK_dead_acute
2345 #ifdef XK_dead_cedilla
2350 #ifdef XK_dead_breve
2355 #ifdef XK_dead_ogonek
2360 #ifdef XK_dead_caron
2365 #ifdef XK_dead_doubleacute
2366 XK_dead_doubleacute
,
2370 #ifdef XK_dead_abovedot
2377 /* This is a list of Lisp names for special "accent" characters.
2378 It parallels lispy_accent_codes. */
2380 static char *lispy_accent_keys
[] =
2397 /* You'll notice that this table is arranged to be conveniently
2398 indexed by X Windows keysym values. */
2399 static char *lispy_function_keys
[] =
2401 /* X Keysym value */
2403 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2411 0, 0, 0, /* 0xff10 */
2413 0, 0, 0, 0, 0, 0, 0,
2416 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2417 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2418 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2420 "home", /* 0xff50 */ /* IsCursorKey */
2431 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2442 "break", /* 0xff6b */
2444 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
2446 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2447 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2448 0, 0, 0, 0, 0, 0, 0, 0,
2449 "kp-tab", /* 0xff89 */
2451 "kp-enter", /* 0xff8d */
2453 "kp-f1", /* 0xff91 */
2457 "kp-home", /* 0xff95 */
2462 "kp-prior", /* kp-page-up */
2463 "kp-next", /* kp-page-down */
2469 0, 0, 0, 0, 0, 0, 0, 0, 0,
2470 "kp-multiply", /* 0xffaa */
2475 "kp-divide", /* 0xffaf */
2476 "kp-0", /* 0xffb0 */
2477 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2480 "kp-equal", /* 0xffbd */
2481 "f1", /* 0xffbe */ /* IsFunctionKey */
2483 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2484 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2485 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2486 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2487 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2488 0, 0, 0, 0, 0, 0, 0, 0,
2489 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2490 0, 0, 0, 0, 0, 0, 0, "delete"
2493 static char *lispy_mouse_names
[] =
2495 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2498 /* Scroll bar parts. */
2499 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2501 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2502 Lisp_Object
*scroll_bar_parts
[] = {
2503 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2507 /* A vector, indexed by button number, giving the down-going location
2508 of currently depressed buttons, both scroll bar and non-scroll bar.
2510 The elements have the form
2511 (BUTTON-NUMBER MODIFIER-MASK . REST)
2512 where REST is the cdr of a position as it would be reported in the event.
2514 The make_lispy_event function stores positions here to tell the
2515 difference between click and drag events, and to store the starting
2516 location to be included in drag events. */
2518 static Lisp_Object button_down_location
;
2520 /* Information about the most recent up-going button event: Which
2521 button, what location, and what time. */
2523 static int last_mouse_button
;
2524 static int last_mouse_x
;
2525 static int last_mouse_y
;
2526 static unsigned long button_down_time
;
2528 /* The maximum time between clicks to make a double-click,
2529 or Qnil to disable double-click detection,
2530 or Qt for no time limit. */
2531 Lisp_Object Vdouble_click_time
;
2533 /* The number of clicks in this multiple-click. */
2535 int double_click_count
;
2537 #ifdef USE_X_TOOLKIT
2538 extern Lisp_Object
map_event_to_object ();
2539 #endif /* USE_X_TOOLKIT */
2541 /* Given a struct input_event, build the lisp event which represents
2542 it. If EVENT is 0, build a mouse movement event from the mouse
2543 movement buffer, which should have a movement event in it.
2545 Note that events must be passed to this function in the order they
2546 are received; this function stores the location of button presses
2547 in order to build drag events when the button is released. */
2550 make_lispy_event (event
)
2551 struct input_event
*event
;
2555 #ifdef SWITCH_ENUM_BUG
2556 switch ((int) event
->kind
)
2558 switch (event
->kind
)
2561 /* A simple keystroke. */
2562 case ascii_keystroke
:
2564 int c
= event
->code
& 0377;
2565 /* Turn ASCII characters into control characters
2567 if (event
->modifiers
& ctrl_modifier
)
2568 c
= make_ctrl_char (c
);
2570 /* Add in the other modifier bits. We took care of ctrl_modifier
2571 just above, and the shift key was taken care of by the X code,
2572 and applied to control characters by make_ctrl_char. */
2573 c
|= (event
->modifiers
2574 & (meta_modifier
| alt_modifier
2575 | hyper_modifier
| super_modifier
));
2576 button_down_time
= 0;
2580 /* A function key. The symbol may need to have modifier prefixes
2582 case non_ascii_keystroke
:
2583 button_down_time
= 0;
2585 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
2586 if (event
->code
== lispy_accent_codes
[i
])
2587 return modify_event_symbol (i
,
2589 Qfunction_key
, Qnil
,
2590 lispy_accent_keys
, &accent_key_syms
,
2591 (sizeof (lispy_accent_keys
)
2592 / sizeof (lispy_accent_keys
[0])));
2594 /* Handle system-specific keysyms. */
2595 if (event
->code
& (1 << 28))
2597 /* We need to use an alist rather than a vector as the cache
2598 since we can't make a vector long enuf. */
2599 if (NILP (system_key_syms
))
2600 system_key_syms
= Fcons (Qnil
, Qnil
);
2601 return modify_event_symbol (event
->code
& 0xffffff,
2603 Qfunction_key
, Vsystem_key_alist
,
2604 0, &system_key_syms
, 0xffffff);
2607 return modify_event_symbol (event
->code
- 0xff00,
2609 Qfunction_key
, Qnil
,
2610 lispy_function_keys
, &func_key_syms
,
2611 (sizeof (lispy_function_keys
)
2612 / sizeof (lispy_function_keys
[0])));
2615 #if defined(MULTI_FRAME) || defined(HAVE_MOUSE)
2616 /* A mouse click. Figure out where it is, decide whether it's
2617 a press, click or drag, and build the appropriate structure. */
2619 case scroll_bar_click
:
2621 int button
= event
->code
;
2623 Lisp_Object position
;
2624 Lisp_Object
*start_pos_ptr
;
2625 Lisp_Object start_pos
;
2627 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2630 /* Build the position as appropriate for this mouse click. */
2631 if (event
->kind
== mouse_click
)
2634 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2639 /* Ignore mouse events that were made on frame that
2640 have been deleted. */
2641 if (! FRAME_LIVE_P (f
))
2644 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
2645 &column
, &row
, 0, 0);
2647 #ifdef USE_X_TOOLKIT
2648 if (FRAME_EXTERNAL_MENU_BAR (f
) && XINT (event
->y
) == -1)
2650 if (row
< FRAME_MENU_BAR_LINES (f
))
2653 Lisp_Object items
, item
;
2657 /* Activate the menu bar on the down event. If the
2658 up event comes in before the menu code can deal with it,
2660 if (! (event
->modifiers
& down_modifier
))
2663 #ifdef USE_X_TOOLKIT
2664 /* The click happened in the menubar.
2665 Look for the menu item selected. */
2666 item
= map_event_to_object (event
, f
);
2668 XFASTINT (event
->y
) = 1;
2669 #else /* not USE_X_TOOLKIT */
2671 items
= FRAME_MENU_BAR_ITEMS (f
);
2672 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 3)
2674 Lisp_Object pos
, string
;
2675 string
= XVECTOR (items
)->contents
[i
+ 1];
2676 pos
= XVECTOR (items
)->contents
[i
+ 2];
2679 if (column
>= XINT (pos
)
2680 && column
< XINT (pos
) + XSTRING (string
)->size
)
2682 item
= XVECTOR (items
)->contents
[i
];
2686 #endif /* not USE_X_TOOLKIT */
2689 = Fcons (event
->frame_or_window
,
2691 Fcons (Fcons (event
->x
, event
->y
),
2692 Fcons (make_number (event
->timestamp
),
2695 return Fcons (item
, Fcons (position
, Qnil
));
2698 window
= window_from_coordinates (f
, column
, row
, &part
);
2700 if (XTYPE (window
) != Lisp_Window
)
2702 window
= event
->frame_or_window
;
2707 int pixcolumn
, pixrow
;
2708 column
-= XINT (XWINDOW (window
)->left
);
2709 row
-= XINT (XWINDOW (window
)->top
);
2710 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
2711 XSETINT (event
->x
, pixcolumn
);
2712 XSETINT (event
->y
, pixrow
);
2717 posn
= Qvertical_line
;
2719 XSET (posn
, Lisp_Int
,
2720 buffer_posn_from_coords (XWINDOW (window
),
2727 Fcons (Fcons (event
->x
, event
->y
),
2728 Fcons (make_number (event
->timestamp
),
2734 Lisp_Object portion_whole
;
2737 window
= event
->frame_or_window
;
2738 portion_whole
= Fcons (event
->x
, event
->y
);
2739 part
= *scroll_bar_parts
[(int) event
->part
];
2743 Fcons (Qvertical_scroll_bar
,
2744 Fcons (portion_whole
,
2745 Fcons (make_number (event
->timestamp
),
2746 Fcons (part
, Qnil
)))));
2749 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2751 start_pos
= *start_pos_ptr
;
2752 *start_pos_ptr
= Qnil
;
2754 is_double
= (button
== last_mouse_button
2755 && XINT (event
->x
) == last_mouse_x
2756 && XINT (event
->y
) == last_mouse_y
2757 && button_down_time
!= 0
2758 && (EQ (Vdouble_click_time
, Qt
)
2759 || (INTEGERP (Vdouble_click_time
)
2760 && ((int)(event
->timestamp
- button_down_time
)
2761 < XINT (Vdouble_click_time
)))));
2762 last_mouse_button
= button
;
2763 last_mouse_x
= XINT (event
->x
);
2764 last_mouse_y
= XINT (event
->y
);
2766 /* If this is a button press, squirrel away the location, so
2767 we can decide later whether it was a click or a drag. */
2768 if (event
->modifiers
& down_modifier
)
2772 double_click_count
++;
2773 event
->modifiers
|= ((double_click_count
> 2)
2778 double_click_count
= 1;
2779 button_down_time
= event
->timestamp
;
2780 *start_pos_ptr
= Fcopy_alist (position
);
2783 /* Now we're releasing a button - check the co-ordinates to
2784 see if this was a click or a drag. */
2785 else if (event
->modifiers
& up_modifier
)
2787 /* If we did not see a down before this up,
2788 ignore the up. Probably this happened because
2789 the down event chose a menu item.
2790 It would be an annoyance to treat the release
2791 of the button that chose the menu item
2792 as a separate event. */
2794 if (XTYPE (start_pos
) != Lisp_Cons
)
2797 event
->modifiers
&= ~up_modifier
;
2798 #if 0 /* Formerly we treated an up with no down as a click event. */
2799 if (XTYPE (start_pos
) != Lisp_Cons
)
2800 event
->modifiers
|= click_modifier
;
2804 /* The third element of every position should be the (x,y)
2808 down
= Fnth (make_number (2), start_pos
);
2809 if (EQ (event
->x
, XCONS (down
)->car
)
2810 && EQ (event
->y
, XCONS (down
)->cdr
))
2812 if (is_double
&& double_click_count
> 1)
2813 event
->modifiers
|= ((double_click_count
> 2)
2817 event
->modifiers
|= click_modifier
;
2821 button_down_time
= 0;
2822 event
->modifiers
|= drag_modifier
;
2827 /* Every mouse event should either have the down_modifier or
2828 the up_modifier set. */
2832 /* Get the symbol we should use for the mouse click. */
2835 head
= modify_event_symbol (button
,
2838 lispy_mouse_names
, &mouse_syms
,
2839 (sizeof (lispy_mouse_names
)
2840 / sizeof (lispy_mouse_names
[0])));
2841 if (event
->modifiers
& drag_modifier
)
2846 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2849 Fcons (make_number (double_click_count
),
2857 #endif /* MULTI_FRAME or HAVE_MOUSE */
2859 /* The 'kind' field of the event is something we don't recognize. */
2865 #if defined(MULTI_FRAME) || defined(HAVE_MOUSE)
2868 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2870 Lisp_Object bar_window
;
2871 enum scroll_bar_part part
;
2876 /* Is it a scroll bar movement? */
2877 if (frame
&& ! NILP (bar_window
))
2879 Lisp_Object part_sym
;
2881 part_sym
= *scroll_bar_parts
[(int) part
];
2882 return Fcons (Qscroll_bar_movement
,
2883 (Fcons (Fcons (bar_window
,
2884 Fcons (Qvertical_scroll_bar
,
2885 Fcons (Fcons (x
, y
),
2886 Fcons (make_number (time
),
2892 /* Or is it an ordinary mouse movement? */
2894 #endif /* MULTI_FRAME */
2907 /* It's in a frame; which window on that frame? */
2908 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
, 0, 1);
2909 window
= window_from_coordinates (frame
, column
, row
, &area
);
2914 if (XTYPE (window
) == Lisp_Window
)
2916 int pixcolumn
, pixrow
;
2917 column
-= XINT (XWINDOW (window
)->left
);
2918 row
-= XINT (XWINDOW (window
)->top
);
2919 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
2920 XSETINT (x
, pixcolumn
);
2921 XSETINT (y
, pixrow
);
2926 posn
= Qvertical_line
;
2928 XSET (posn
, Lisp_Int
,
2929 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
2932 else if (frame
!= 0)
2934 XSET (window
, Lisp_Frame
, frame
);
2946 return Fcons (Qmouse_movement
,
2947 Fcons (Fcons (window
,
2949 Fcons (Fcons (x
, y
),
2950 Fcons (make_number (time
),
2956 #endif /* neither MULTI_FRAME nor HAVE_MOUSE */
2958 /* Construct a switch frame event. */
2960 make_lispy_switch_frame (frame
)
2963 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
2966 /* Manipulating modifiers. */
2968 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
2970 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2971 SYMBOL's name of the end of the modifiers; the string from this
2972 position is the unmodified symbol name.
2974 This doesn't use any caches. */
2976 parse_modifiers_uncached (symbol
, modifier_end
)
2980 struct Lisp_String
*name
;
2984 CHECK_SYMBOL (symbol
, 1);
2987 name
= XSYMBOL (symbol
)->name
;
2990 for (i
= 0; i
+2 <= name
->size
; )
2991 switch (name
->data
[i
])
2993 #define SINGLE_LETTER_MOD(bit) \
2994 if (name->data[i+1] != '-') \
2995 goto no_more_modifiers; \
3000 SINGLE_LETTER_MOD (alt_modifier
);
3004 SINGLE_LETTER_MOD (ctrl_modifier
);
3008 SINGLE_LETTER_MOD (hyper_modifier
);
3012 SINGLE_LETTER_MOD (meta_modifier
);
3016 SINGLE_LETTER_MOD (shift_modifier
);
3020 SINGLE_LETTER_MOD (super_modifier
);
3024 if (i
+ 5 > name
->size
)
3025 goto no_more_modifiers
;
3026 if (! strncmp (name
->data
+ i
, "drag-", 5))
3028 modifiers
|= drag_modifier
;
3031 else if (! strncmp (name
->data
+ i
, "down-", 5))
3033 modifiers
|= down_modifier
;
3036 else if (i
+ 7 <= name
->size
3037 && ! strncmp (name
->data
+ i
, "double-", 7))
3039 modifiers
|= double_modifier
;
3043 goto no_more_modifiers
;
3047 if (i
+ 7 > name
->size
)
3048 goto no_more_modifiers
;
3049 if (! strncmp (name
->data
+ i
, "triple-", 7))
3051 modifiers
|= triple_modifier
;
3055 goto no_more_modifiers
;
3059 goto no_more_modifiers
;
3061 #undef SINGLE_LETTER_MOD
3065 /* Should we include the `click' modifier? */
3066 if (! (modifiers
& (down_modifier
| drag_modifier
3067 | double_modifier
| triple_modifier
))
3068 && i
+ 7 == name
->size
3069 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
3070 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
3071 modifiers
|= click_modifier
;
3080 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
3081 prepended to the string BASE[0..BASE_LEN-1].
3082 This doesn't use any caches. */
3084 apply_modifiers_uncached (modifiers
, base
, base_len
)
3089 /* Since BASE could contain nulls, we can't use intern here; we have
3090 to use Fintern, which expects a genuine Lisp_String, and keeps a
3093 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
3099 /* Only the event queue may use the `up' modifier; it should always
3100 be turned into a click or drag event before presented to lisp code. */
3101 if (modifiers
& up_modifier
)
3104 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
3105 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
3106 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
3107 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
3108 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
3109 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
3110 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
3111 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
3112 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
3113 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
3114 /* The click modifier is denoted by the absence of other modifiers. */
3118 mod_len
= p
- new_mods
;
3122 Lisp_Object new_name
;
3124 new_name
= make_uninit_string (mod_len
+ base_len
);
3125 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
3126 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
3128 return Fintern (new_name
, Qnil
);
3133 static char *modifier_names
[] =
3135 "up", "down", "drag", "click", "double", "triple", 0, 0,
3136 0, 0, 0, 0, 0, 0, 0, 0,
3137 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
3139 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
3141 static Lisp_Object modifier_symbols
;
3143 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
3145 lispy_modifier_list (modifiers
)
3148 Lisp_Object modifier_list
;
3151 modifier_list
= Qnil
;
3152 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
3153 if (modifiers
& (1<<i
))
3154 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
3157 return modifier_list
;
3161 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
3162 where UNMODIFIED is the unmodified form of SYMBOL,
3163 MASK is the set of modifiers present in SYMBOL's name.
3164 This is similar to parse_modifiers_uncached, but uses the cache in
3165 SYMBOL's Qevent_symbol_element_mask property, and maintains the
3166 Qevent_symbol_elements property. */
3168 parse_modifiers (symbol
)
3171 Lisp_Object elements
;
3173 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
3174 if (CONSP (elements
))
3179 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
3180 Lisp_Object unmodified
;
3183 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
3184 XSYMBOL (symbol
)->name
->size
- end
),
3187 if (modifiers
& ~((1<<VALBITS
) - 1))
3189 XFASTINT (mask
) = modifiers
;
3190 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
3192 /* Cache the parsing results on SYMBOL. */
3193 Fput (symbol
, Qevent_symbol_element_mask
,
3195 Fput (symbol
, Qevent_symbol_elements
,
3196 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
3198 /* Since we know that SYMBOL is modifiers applied to unmodified,
3199 it would be nice to put that in unmodified's cache.
3200 But we can't, since we're not sure that parse_modifiers is
3207 /* Apply the modifiers MODIFIERS to the symbol BASE.
3208 BASE must be unmodified.
3210 This is like apply_modifiers_uncached, but uses BASE's
3211 Qmodifier_cache property, if present. It also builds
3212 Qevent_symbol_elements properties, since it has that info anyway.
3214 apply_modifiers copies the value of BASE's Qevent_kind property to
3215 the modified symbol. */
3217 apply_modifiers (modifiers
, base
)
3221 Lisp_Object cache
, index
, entry
, new_symbol
;
3223 /* Mask out upper bits. We don't know where this value's been. */
3224 modifiers
&= (1<<VALBITS
) - 1;
3226 /* The click modifier never figures into cache indices. */
3227 cache
= Fget (base
, Qmodifier_cache
);
3228 XFASTINT (index
) = (modifiers
& ~click_modifier
);
3229 entry
= assq_no_quit (index
, cache
);
3232 new_symbol
= XCONS (entry
)->cdr
;
3235 /* We have to create the symbol ourselves. */
3236 new_symbol
= apply_modifiers_uncached (modifiers
,
3237 XSYMBOL (base
)->name
->data
,
3238 XSYMBOL (base
)->name
->size
);
3240 /* Add the new symbol to the base's cache. */
3241 entry
= Fcons (index
, new_symbol
);
3242 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
3244 /* We have the parsing info now for free, so add it to the caches. */
3245 XFASTINT (index
) = modifiers
;
3246 Fput (new_symbol
, Qevent_symbol_element_mask
,
3247 Fcons (base
, Fcons (index
, Qnil
)));
3248 Fput (new_symbol
, Qevent_symbol_elements
,
3249 Fcons (base
, lispy_modifier_list (modifiers
)));
3252 /* Make sure this symbol is of the same kind as BASE.
3254 You'd think we could just set this once and for all when we
3255 intern the symbol above, but reorder_modifiers may call us when
3256 BASE's property isn't set right; we can't assume that just
3257 because it has a Qmodifier_cache property it must have its
3258 Qevent_kind set right as well. */
3259 if (NILP (Fget (new_symbol
, Qevent_kind
)))
3263 kind
= Fget (base
, Qevent_kind
);
3265 Fput (new_symbol
, Qevent_kind
, kind
);
3272 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
3273 return a symbol with the modifiers placed in the canonical order.
3274 Canonical order is alphabetical, except for down and drag, which
3275 always come last. The 'click' modifier is never written out.
3277 Fdefine_key calls this to make sure that (for example) C-M-foo
3278 and M-C-foo end up being equivalent in the keymap. */
3281 reorder_modifiers (symbol
)
3284 /* It's hopefully okay to write the code this way, since everything
3285 will soon be in caches, and no consing will be done at all. */
3288 parsed
= parse_modifiers (symbol
);
3289 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
3290 XCONS (parsed
)->car
);
3294 /* For handling events, we often want to produce a symbol whose name
3295 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
3296 to some base, like the name of a function key or mouse button.
3297 modify_event_symbol produces symbols of this sort.
3299 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
3300 is the name of the i'th symbol. TABLE_SIZE is the number of elements
3303 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
3304 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
3306 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
3307 persist between calls to modify_event_symbol that it can use to
3308 store a cache of the symbols it's generated for this NAME_TABLE
3309 before. The object stored there may be a vector or an alist.
3311 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
3313 MODIFIERS is a set of modifier bits (as given in struct input_events)
3314 whose prefixes should be applied to the symbol name.
3316 SYMBOL_KIND is the value to be placed in the event_kind property of
3317 the returned symbol.
3319 The symbols we create are supposed to have an
3320 `event-symbol-elements' property, which lists the modifiers present
3321 in the symbol's name. */
3324 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
3325 name_table
, symbol_table
, table_size
)
3328 Lisp_Object symbol_kind
;
3329 Lisp_Object name_alist
;
3331 Lisp_Object
*symbol_table
;
3335 Lisp_Object symbol_int
;
3337 XSET (symbol_int
, Lisp_Int
, symbol_num
);
3339 /* Is this a request for a valid symbol? */
3340 if (symbol_num
< 0 || symbol_num
>= table_size
)
3343 if (CONSP (*symbol_table
))
3344 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
3346 /* If *symbol_table doesn't seem to be initialized properly, fix that.
3347 *symbol_table should be a lisp vector TABLE_SIZE elements long,
3348 where the Nth element is the symbol for NAME_TABLE[N], or nil if
3349 we've never used that symbol before. */
3352 if (! VECTORP (*symbol_table
)
3353 || XVECTOR (*symbol_table
)->size
!= table_size
)
3357 XFASTINT (size
) = table_size
;
3358 *symbol_table
= Fmake_vector (size
, Qnil
);
3361 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
3364 /* Have we already used this symbol before? */
3367 /* No; let's create it. */
3368 if (!NILP (name_alist
))
3369 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
3370 else if (name_table
[symbol_num
])
3371 value
= intern (name_table
[symbol_num
]);
3376 sprintf (buf
, "key-%d", symbol_num
);
3377 value
= intern (buf
);
3380 if (CONSP (*symbol_table
))
3381 *symbol_table
= Fcons (value
, *symbol_table
);
3383 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
3385 /* Fill in the cache entries for this symbol; this also
3386 builds the Qevent_symbol_elements property, which the user
3388 apply_modifiers (modifiers
& click_modifier
, value
);
3389 Fput (value
, Qevent_kind
, symbol_kind
);
3392 /* Apply modifiers to that symbol. */
3393 return apply_modifiers (modifiers
, value
);
3397 /* Store into *addr a value nonzero if terminal input chars are available.
3398 Serves the purpose of ioctl (0, FIONREAD, addr)
3399 but works even if FIONREAD does not exist.
3400 (In fact, this may actually read some input.) */
3403 get_input_pending (addr
)
3406 /* First of all, have we already counted some input? */
3407 *addr
= !NILP (Vquit_flag
) || readable_events ();
3409 /* If input is being read as it arrives, and we have none, there is none. */
3410 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
3413 /* Try to read some input and see how much we get. */
3415 *addr
= !NILP (Vquit_flag
) || readable_events ();
3418 /* Interface to read_avail_input, blocking SIGIO if necessary. */
3421 gobble_input (expected
)
3426 if (interrupt_input
)
3429 mask
= sigblockx (SIGIO
);
3430 read_avail_input (expected
);
3435 read_avail_input (expected
);
3439 /* Put a buffer_switch_event in the buffer
3440 so that read_key_sequence will notice the new current buffer. */
3442 record_asynch_buffer_change ()
3444 struct input_event event
;
3447 event
.kind
= buffer_switch_event
;
3448 event
.frame_or_window
= Qnil
;
3450 /* We don't need a buffer-switch event unless Emacs is waiting for input.
3451 The purpose of the event is to make read_key_sequence look up the
3452 keymaps again. If we aren't in read_key_sequence, we don't need one,
3453 and the event could cause trouble by messing up (input-pending-p). */
3454 tem
= Fwaiting_for_user_input_p ();
3458 /* Make sure no interrupt happens while storing the event. */
3460 if (interrupt_input
)
3463 mask
= sigblockx (SIGIO
);
3464 kbd_buffer_store_event (&event
);
3471 kbd_buffer_store_event (&event
);
3478 /* Read any terminal input already buffered up by the system
3479 into the kbd_buffer, but do not wait.
3481 EXPECTED should be nonzero if the caller knows there is some input.
3483 Except on VMS, all input is read by this function.
3484 If interrupt_input is nonzero, this function MUST be called
3485 only when SIGIO is blocked.
3487 Returns the number of keyboard chars read, or -1 meaning
3488 this is a bad time to try to read input. */
3491 read_avail_input (expected
)
3494 struct input_event buf
[KBD_BUFFER_SIZE
];
3498 if (read_socket_hook
)
3499 /* No need for FIONREAD or fcntl; just say don't wait. */
3500 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
3503 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
3504 the kbd_buffer can really hold. That may prevent loss
3505 of characters on some systems when input is stuffed at us. */
3506 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
3509 /* Determine how many characters we should *try* to read. */
3511 n_to_read
= dos_keysns ();
3514 #else /* not MSDOS */
3516 /* Find out how much input is available. */
3517 if (ioctl (0, FIONREAD
, &n_to_read
) < 0)
3518 /* Formerly simply reported no input, but that sometimes led to
3519 a failure of Emacs to terminate.
3520 SIGHUP seems appropriate if we can't reach the terminal. */
3521 /* ??? Is it really right to send the signal just to this process
3522 rather than to the whole process group?
3523 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3524 kill (getpid (), SIGHUP
);
3527 if (n_to_read
> sizeof cbuf
)
3528 n_to_read
= sizeof cbuf
;
3529 #else /* no FIONREAD */
3530 #if defined(USG) || defined(DGUX)
3531 /* Read some input if available, but don't wait. */
3532 n_to_read
= sizeof cbuf
;
3533 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
3538 #endif /* not MSDOS */
3540 /* Now read; for one reason or another, this will not block.
3541 NREAD is set to the number of chars read. */
3545 cbuf
[0] = dos_keyread();
3548 nread
= read (fileno (stdin
), cbuf
, n_to_read
);
3550 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
3551 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3552 This looks incorrect, but it isn't, because _BSD causes
3553 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3554 and that causes a value other than 0 when there is no input. */
3560 /* We used to retry the read if it was interrupted.
3561 But this does the wrong thing when O_NDELAY causes
3562 an EAGAIN error. Does anybody know of a situation
3563 where a retry is actually needed? */
3565 nread
< 0 && (errno
== EAGAIN
3579 #if defined (USG) || defined (DGUX)
3580 fcntl (fileno (stdin
), F_SETFL
, 0);
3581 #endif /* USG or DGUX */
3582 #endif /* no FIONREAD */
3583 for (i
= 0; i
< nread
; i
++)
3585 buf
[i
].kind
= ascii_keystroke
;
3586 buf
[i
].modifiers
= 0;
3587 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3588 buf
[i
].modifiers
= meta_modifier
;
3592 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
3594 XSET (buf
[i
].frame_or_window
, Lisp_Frame
, selected_frame
);
3596 buf
[i
].frame_or_window
= Qnil
;
3601 /* Scan the chars for C-g and store them in kbd_buffer. */
3602 for (i
= 0; i
< nread
; i
++)
3604 kbd_buffer_store_event (&buf
[i
]);
3605 /* Don't look at input that follows a C-g too closely.
3606 This reduces lossage due to autorepeat on C-g. */
3607 if (buf
[i
].kind
== ascii_keystroke
3608 && XINT(buf
[i
].code
) == quit_char
)
3614 #endif /* not VMS */
3616 #ifdef SIGIO /* for entire page */
3617 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3620 input_available_signal (signo
)
3623 /* Must preserve main program's value of errno. */
3624 int old_errno
= errno
;
3626 extern int select_alarmed
;
3630 /* USG systems forget handlers when they are used;
3631 must reestablish each time */
3632 signal (signo
, input_available_signal
);
3639 if (input_available_clear_time
)
3640 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3645 nread
= read_avail_input (1);
3646 /* -1 means it's not ok to read the input now.
3647 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3648 0 means there was no keyboard input available. */
3653 select_alarmed
= 1; /* Force the select emulator back to life */
3664 /* Send ourselves a SIGIO.
3666 This function exists so that the UNBLOCK_INPUT macro in
3667 blockinput.h can have some way to take care of input we put off
3668 dealing with, without assuming that every file which uses
3669 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3671 reinvoke_input_signal ()
3680 /* Return the prompt-string of a sparse keymap.
3681 This is the first element which is a string.
3682 Return nil if there is none. */
3690 register Lisp_Object tem
;
3692 if (XTYPE (tem
) == Lisp_String
)
3699 static void menu_bar_item ();
3700 static void menu_bar_one_keymap ();
3702 /* These variables hold the vector under construction within
3703 menu_bar_items and its subroutines, and the current index
3704 for storing into that vector. */
3705 static Lisp_Object menu_bar_items_vector
;
3706 static Lisp_Object menu_bar_items_index
;
3708 /* Return a vector of menu items for a menu bar, appropriate
3709 to the current buffer. Each item has three elements in the vector:
3712 OLD is an old vector we can optionally reuse, or nil. */
3715 menu_bar_items (old
)
3718 /* The number of keymaps we're scanning right now, and the number of
3719 keymaps we have allocated space for. */
3722 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3723 in the current keymaps, or nil where it is not a prefix. */
3726 Lisp_Object def
, tem
, tail
;
3735 struct gcpro gcpro1
;
3737 /* In order to build the menus, we need to call the keymap
3738 accessors. They all call QUIT. But this function is called
3739 during redisplay, during which a quit is fatal. So inhibit
3740 quitting while building the menus.
3741 We do this instead of specbind because (1) errors will clear it anyway
3742 and (2) this avoids risk of specpdl overflow. */
3743 oquit
= Vinhibit_quit
;
3747 menu_bar_items_vector
= old
;
3749 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
3750 menu_bar_items_index
= 0;
3752 GCPRO1 (menu_bar_items_vector
);
3754 /* Build our list of keymaps.
3755 If we recognize a function key and replace its escape sequence in
3756 keybuf with its symbol, or if the sequence starts with a mouse
3757 click and we need to switch buffers, we jump back here to rebuild
3758 the initial keymaps from the current buffer. */
3762 if (!NILP (Voverriding_local_map
))
3765 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3766 maps
[0] = Voverriding_local_map
;
3770 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3771 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3772 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3773 #ifdef USE_TEXT_PROPERTIES
3774 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3776 maps
[nmaps
-2] = current_buffer
->keymap
;
3779 maps
[nmaps
-1] = current_global_map
;
3782 /* Look up in each map the dummy prefix key `menu-bar'. */
3786 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3788 if (! NILP (maps
[mapno
]))
3789 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3793 tem
= Fkeymapp (def
);
3795 menu_bar_one_keymap (def
);
3798 /* Move to the end those items that should be at the end. */
3800 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3803 int end
= menu_bar_items_index
;
3805 for (i
= 0; i
< end
; i
+= 3)
3806 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3808 Lisp_Object tem0
, tem1
, tem2
;
3809 /* Move the item at index I to the end,
3810 shifting all the others forward. */
3811 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
3812 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
3813 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
3815 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
3816 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
3817 (end
- i
- 3) * sizeof (Lisp_Object
));
3818 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem0
;
3819 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem1
;
3820 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem2
;
3825 /* Add nil, nil, nil at the end. */
3826 i
= menu_bar_items_index
;
3827 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
3830 int newsize
= 2 * i
;
3831 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
3832 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
3833 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
3834 menu_bar_items_vector
= tem
;
3836 /* Add this item. */
3837 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3838 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3839 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3840 menu_bar_items_index
= i
;
3842 Vinhibit_quit
= oquit
;
3844 return menu_bar_items_vector
;
3847 /* Scan one map KEYMAP, accumulating any menu items it defines
3848 in menu_bar_items_vector. */
3851 menu_bar_one_keymap (keymap
)
3854 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3856 /* Loop over all keymap entries that have menu strings. */
3857 for (tail
= keymap
; XTYPE (tail
) == Lisp_Cons
; tail
= XCONS (tail
)->cdr
)
3859 item
= XCONS (tail
)->car
;
3860 if (XTYPE (item
) == Lisp_Cons
)
3862 key
= XCONS (item
)->car
;
3863 binding
= XCONS (item
)->cdr
;
3864 if (XTYPE (binding
) == Lisp_Cons
)
3866 item_string
= XCONS (binding
)->car
;
3867 if (XTYPE (item_string
) == Lisp_String
)
3868 menu_bar_item (key
, item_string
, Fcdr (binding
));
3870 else if (EQ (binding
, Qundefined
))
3871 menu_bar_item (key
, Qnil
, binding
);
3873 else if (XTYPE (item
) == Lisp_Vector
)
3875 /* Loop over the char values represented in the vector. */
3876 int len
= XVECTOR (item
)->size
;
3878 for (c
= 0; c
< len
; c
++)
3880 Lisp_Object character
;
3881 XFASTINT (character
) = c
;
3882 binding
= XVECTOR (item
)->contents
[c
];
3883 if (XTYPE (binding
) == Lisp_Cons
)
3885 item_string
= XCONS (binding
)->car
;
3886 if (XTYPE (item_string
) == Lisp_String
)
3887 menu_bar_item (key
, item_string
, Fcdr (binding
));
3889 else if (EQ (binding
, Qundefined
))
3890 menu_bar_item (key
, Qnil
, binding
);
3896 /* This is used as the handler when calling internal_condition_case_1. */
3899 menu_bar_item_1 (arg
)
3905 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
3906 If there's already an item for KEY, add this DEF to it. */
3909 menu_bar_item (key
, item_string
, def
)
3910 Lisp_Object key
, item_string
, def
;
3913 Lisp_Object enabled
;
3916 if (EQ (def
, Qundefined
))
3918 /* If a map has an explicit `undefined' as definition,
3919 discard any previously made menu bar item. */
3921 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
3922 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3924 if (menu_bar_items_index
> i
+ 3)
3925 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
3926 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
3927 (menu_bar_items_index
- i
- 3) * sizeof (Lisp_Object
));
3928 menu_bar_items_index
-= 3;
3932 /* If there's no definition for this key yet,
3933 just ignore `undefined'. */
3937 /* See if this entry is enabled. */
3940 if (XTYPE (def
) == Lisp_Symbol
)
3942 /* No property, or nil, means enable.
3943 Otherwise, enable if value is not nil. */
3944 tem
= Fget (def
, Qmenu_enable
);
3946 /* (condition-case nil (eval tem)
3948 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
3952 /* Ignore this item if it's not enabled. */
3956 /* Find any existing item for this KEY. */
3957 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
3958 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3961 /* If we did not find this KEY, add it at the end. */
3962 if (i
== menu_bar_items_index
)
3964 /* If vector is too small, get a bigger one. */
3965 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
3968 int newsize
= 2 * i
;
3969 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
3970 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
3971 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
3972 menu_bar_items_vector
= tem
;
3974 /* Add this item. */
3975 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
3976 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
3977 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (def
, Qnil
);
3978 menu_bar_items_index
= i
;
3980 /* We did find an item for this KEY. Add DEF to its list of maps. */
3984 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
3985 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (def
, old
);
3989 /* Read a character using menus based on maps in the array MAPS.
3990 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
3991 Return t if we displayed a menu but the user rejected it.
3993 PREV_EVENT is the previous input event, or nil if we are reading
3994 the first event of a key sequence.
3996 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3997 if we used a mouse menu to read the input, or zero otherwise. If
3998 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
4000 The prompting is done based on the prompt-string of the map
4001 and the strings associated with various map elements.
4003 This can be done with X menus or with menus put in the minibuf.
4004 These are done in different ways, depending on how the input will be read.
4005 Menus using X are done after auto-saving in read-char, getting the input
4006 event from Fx_popup_menu; menus using the minibuf use read_char recursively
4007 and do auto-saving in the inner call of read_char. */
4010 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
4013 Lisp_Object prev_event
;
4014 int *used_mouse_menu
;
4017 register Lisp_Object name
;
4018 Lisp_Object rest
, vector
;
4020 if (used_mouse_menu
)
4021 *used_mouse_menu
= 0;
4023 /* Use local over global Menu maps */
4025 if (! menu_prompting
)
4028 /* Get the menu name from the first map that has one (a prompt string). */
4029 for (mapno
= 0; mapno
< nmaps
; mapno
++)
4031 name
= map_prompt (maps
[mapno
]);
4036 /* If we don't have any menus, just read a character normally. */
4040 #ifdef HAVE_X_WINDOWS
4042 /* If we got to this point via a mouse click,
4043 use a real menu for mouse selection. */
4044 if (EVENT_HAS_PARAMETERS (prev_event
))
4046 /* Display the menu and get the selection. */
4047 Lisp_Object
*realmaps
4048 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
4052 /* Use the maps that are not nil. */
4053 for (mapno
= 0; mapno
< nmaps
; mapno
++)
4054 if (!NILP (maps
[mapno
]))
4055 realmaps
[nmaps1
++] = maps
[mapno
];
4057 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
4060 /* If we got more than one event, put all but the first
4061 onto this list to be read later.
4062 Return just the first event now. */
4063 Vunread_command_events
4064 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
4065 value
= XCONS (value
)->car
;
4067 else if (NILP (value
))
4069 if (used_mouse_menu
)
4070 *used_mouse_menu
= 1;
4073 #endif /* HAVE_X_MENU */
4074 #endif /* HAVE_X_WINDOWS */
4079 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
4085 register Lisp_Object name
;
4087 int width
= FRAME_WIDTH (selected_frame
) - 4;
4088 char *menu
= (char *) alloca (width
+ 4);
4091 Lisp_Object rest
, vector
;
4093 if (! menu_prompting
)
4096 /* Get the menu name from the first map that has one (a prompt string). */
4097 for (mapno
= 0; mapno
< nmaps
; mapno
++)
4099 name
= map_prompt (maps
[mapno
]);
4104 /* If we don't have any menus, just read a character normally. */
4108 /* Prompt string always starts with map's prompt, and a space. */
4109 strcpy (menu
, XSTRING (name
)->data
);
4110 nlength
= XSTRING (name
)->size
;
4111 menu
[nlength
++] = ':';
4112 menu
[nlength
++] = ' ';
4115 /* Start prompting at start of first map. */
4119 /* Present the documented bindings, a line at a time. */
4126 int orig_defn_macro
;
4128 /* Loop over elements of map. */
4133 /* If reached end of map, start at beginning of next map. */
4137 /* At end of last map, wrap around to first map if just starting,
4138 or end this line if already have something on it. */
4142 if (notfirst
|| nobindings
) break;
4147 /* Look at the next element of the map. */
4149 elt
= XVECTOR (vector
)->contents
[idx
];
4151 elt
= Fcar_safe (rest
);
4153 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
4155 /* If we found a dense table in the keymap,
4156 advanced past it, but start scanning its contents. */
4157 rest
= Fcdr_safe (rest
);
4163 /* An ordinary element. */
4165 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
4167 s
= Fcar_safe(elt
); /* vector */
4168 if (XTYPE (s
) != Lisp_String
)
4169 /* Ignore the element if it has no prompt string. */
4171 /* If we have room for the prompt string, add it to this line.
4172 If this is the first on the line, always add it. */
4173 else if (XSTRING (s
)->size
+ i
+ 2 < width
4178 /* Punctuate between strings. */
4181 strcpy (menu
+ i
, ", ");
4187 /* Add as much of string as fits. */
4188 thiswidth
= XSTRING (s
)->size
;
4189 if (thiswidth
+ i
> width
)
4190 thiswidth
= width
- i
;
4191 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
4197 /* If this element does not fit, end the line now,
4198 and save the element for the next line. */
4199 strcpy (menu
+ i
, "...");
4203 /* Move past this element. */
4204 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
4205 /* Handle reaching end of dense table. */
4210 rest
= Fcdr_safe (rest
);
4214 /* Prompt with that and read response. */
4217 /* Make believe its not a keyboard macro in case the help char
4218 is pressed. Help characters are not recorded because menu prompting
4219 is not used on replay.
4221 orig_defn_macro
= defining_kbd_macro
;
4222 defining_kbd_macro
= 0 ;
4224 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
4225 while (XTYPE (obj
) == Lisp_Buffer
);
4226 defining_kbd_macro
= orig_defn_macro
;
4228 if (XTYPE (obj
) != Lisp_Int
)
4233 if (! EQ (obj
, menu_prompt_more_char
)
4234 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
4235 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
4237 if ( defining_kbd_macro
)
4238 store_kbd_macro_char(obj
) ;
4241 /* Help char - go round again */
4245 /* Reading key sequences. */
4247 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
4248 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
4249 keymap, or nil otherwise. Return the index of the first keymap in
4250 which KEY has any binding, or NMAPS if no map has a binding.
4252 If KEY is a meta ASCII character, treat it like meta-prefix-char
4253 followed by the corresponding non-meta character. Keymaps in
4254 CURRENT with non-prefix bindings for meta-prefix-char become nil in
4257 If KEY has no bindings in any of the CURRENT maps, NEXT is left
4260 NEXT may == CURRENT. */
4263 follow_key (key
, nmaps
, current
, defs
, next
)
4265 Lisp_Object
*current
, *defs
, *next
;
4268 int i
, first_binding
;
4270 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
4271 followed by the corresponding non-meta character. */
4272 if (XTYPE (key
) == Lisp_Int
&& (XINT (key
) & CHAR_META
))
4274 for (i
= 0; i
< nmaps
; i
++)
4275 if (! NILP (current
[i
]))
4278 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
4280 /* Note that since we pass the resulting bindings through
4281 get_keymap_1, non-prefix bindings for meta-prefix-char
4283 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
4289 XSET (key
, Lisp_Int
, XFASTINT (key
) & ~CHAR_META
);
4292 first_binding
= nmaps
;
4293 for (i
= nmaps
- 1; i
>= 0; i
--)
4295 if (! NILP (current
[i
]))
4297 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
4298 if (! NILP (defs
[i
]))
4305 /* Given the set of bindings we've found, produce the next set of maps. */
4306 if (first_binding
< nmaps
)
4307 for (i
= 0; i
< nmaps
; i
++)
4308 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
4310 return first_binding
;
4313 /* Read a sequence of keys that ends with a non prefix character,
4314 storing it in KEYBUF, a buffer of size BUFSIZE.
4316 Return the length of the key sequence stored.
4317 Return -1 if the user rejected a command menu.
4319 Echo starting immediately unless `prompt' is 0.
4321 Where a key sequence ends depends on the currently active keymaps.
4322 These include any minor mode keymaps active in the current buffer,
4323 the current buffer's local map, and the global map.
4325 If a key sequence has no other bindings, we check Vfunction_key_map
4326 to see if some trailing subsequence might be the beginning of a
4327 function key's sequence. If so, we try to read the whole function
4328 key, and substitute its symbolic name into the key sequence.
4330 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
4331 `double-' events into similar click events, if that would make them
4332 bound. We try to turn `triple-' events first into `double-' events,
4335 If we get a mouse click in a mode line, vertical divider, or other
4336 non-text area, we treat the click as if it were prefixed by the
4337 symbol denoting that area - `mode-line', `vertical-line', or
4340 If the sequence starts with a mouse click, we read the key sequence
4341 with respect to the buffer clicked on, not the current buffer.
4343 If the user switches frames in the midst of a key sequence, we put
4344 off the switch-frame event until later; the next call to
4345 read_char will return it. */
4348 read_key_sequence (keybuf
, bufsize
, prompt
)
4349 Lisp_Object
*keybuf
;
4353 int count
= specpdl_ptr
- specpdl
;
4355 /* How many keys there are in the current key sequence. */
4358 /* The length of the echo buffer when we started reading, and
4359 the length of this_command_keys when we started reading. */
4363 /* The number of keymaps we're scanning right now, and the number of
4364 keymaps we have allocated space for. */
4366 int nmaps_allocated
= 0;
4368 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
4369 the current keymaps. */
4372 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
4373 in the current keymaps, or nil where it is not a prefix. */
4374 Lisp_Object
*submaps
;
4376 /* The index in defs[] of the first keymap that has a binding for
4377 this key sequence. In other words, the lowest i such that
4378 defs[i] is non-nil. */
4381 /* If t < mock_input, then KEYBUF[t] should be read as the next
4384 We use this to recover after recognizing a function key. Once we
4385 realize that a suffix of the current key sequence is actually a
4386 function key's escape sequence, we replace the suffix with the
4387 function key's binding from Vfunction_key_map. Now keybuf
4388 contains a new and different key sequence, so the echo area,
4389 this_command_keys, and the submaps and defs arrays are wrong. In
4390 this situation, we set mock_input to t, set t to 0, and jump to
4391 restart_sequence; the loop will read keys from keybuf up until
4392 mock_input, thus rebuilding the state; and then it will resume
4393 reading characters from the keyboard. */
4396 /* If the sequence is unbound in submaps[], then
4397 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
4398 and fkey_map is its binding.
4400 These might be > t, indicating that all function key scanning
4401 should hold off until t reaches them. We do this when we've just
4402 recognized a function key, to avoid searching for the function
4403 key's again in Vfunction_key_map. */
4404 int fkey_start
= 0, fkey_end
= 0;
4405 Lisp_Object fkey_map
;
4407 /* Likewise, for key_translation_map. */
4408 int keytran_start
= 0, keytran_end
= 0;
4409 Lisp_Object keytran_map
;
4411 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
4412 we put it off for later. While we're reading, we keep the event here. */
4413 Lisp_Object delayed_switch_frame
;
4415 /* See the comment below... */
4416 #if defined (GOBBLE_FIRST_EVENT)
4417 Lisp_Object first_event
;
4420 struct buffer
*starting_buffer
;
4422 /* Nonzero if we seem to have got the beginning of a binding
4423 in function_key_map. */
4424 int function_key_possible
= 0;
4428 last_nonmenu_event
= Qnil
;
4430 delayed_switch_frame
= Qnil
;
4431 fkey_map
= Vfunction_key_map
;
4432 keytran_map
= Vkey_translation_map
;
4434 /* If there is no function-key-map, turn off function key scanning. */
4435 if (NILP (Fkeymapp (Vfunction_key_map
)))
4436 fkey_start
= fkey_end
= bufsize
+ 1;
4438 /* If there is no key-translation-map, turn off scanning. */
4439 if (NILP (Fkeymapp (Vkey_translation_map
)))
4440 keytran_start
= keytran_end
= bufsize
+ 1;
4445 echo_prompt (XSTRING (prompt
)->data
);
4446 else if (cursor_in_echo_area
&& echo_keystrokes
)
4447 /* This doesn't put in a dash if the echo buffer is empty, so
4448 you don't always see a dash hanging out in the minibuffer. */
4452 /* Record the initial state of the echo area and this_command_keys;
4453 we will need to restore them if we replay a key sequence. */
4455 echo_start
= echo_length ();
4456 keys_start
= this_command_key_count
;
4458 #if defined (GOBBLE_FIRST_EVENT)
4459 /* This doesn't quite work, because some of the things that read_char
4460 does cannot safely be bypassed. It seems too risky to try to make
4463 /* Read the first char of the sequence specially, before setting
4464 up any keymaps, in case a filter runs and switches buffers on us. */
4465 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
4467 #endif /* GOBBLE_FIRST_EVENT */
4469 /* We jump here when the key sequence has been thoroughly changed, and
4470 we need to rescan it starting from the beginning. When we jump here,
4471 keybuf[0..mock_input] holds the sequence we should reread. */
4474 starting_buffer
= current_buffer
;
4475 function_key_possible
= 0;
4477 /* Build our list of keymaps.
4478 If we recognize a function key and replace its escape sequence in
4479 keybuf with its symbol, or if the sequence starts with a mouse
4480 click and we need to switch buffers, we jump back here to rebuild
4481 the initial keymaps from the current buffer. */
4485 if (!NILP (Voverriding_local_map
))
4488 if (nmaps
> nmaps_allocated
)
4490 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4491 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4492 nmaps_allocated
= nmaps
;
4494 submaps
[0] = Voverriding_local_map
;
4498 nmaps
= current_minor_maps (0, &maps
) + 2;
4499 if (nmaps
> nmaps_allocated
)
4501 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4502 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4503 nmaps_allocated
= nmaps
;
4505 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
4506 #ifdef USE_TEXT_PROPERTIES
4507 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
4509 submaps
[nmaps
-2] = current_buffer
->keymap
;
4512 submaps
[nmaps
-1] = current_global_map
;
4515 /* Find an accurate initial value for first_binding. */
4516 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
4517 if (! NILP (submaps
[first_binding
]))
4520 /* Start from the beginning in keybuf. */
4523 /* These are no-ops the first time through, but if we restart, they
4524 revert the echo area and this_command_keys to their original state. */
4525 this_command_key_count
= keys_start
;
4526 if (INTERACTIVE
&& t
< mock_input
)
4527 echo_truncate (echo_start
);
4529 /* If the best binding for the current key sequence is a keymap, or
4530 we may be looking at a function key's escape sequence, keep on
4532 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
4533 || (first_binding
>= nmaps
4535 /* mock input is never part of a function key's sequence. */
4536 && mock_input
<= fkey_start
)
4537 || (first_binding
>= nmaps
4538 && keytran_start
< t
4539 /* mock input is never part of a function key's sequence. */
4540 && mock_input
<= keytran_start
)
4541 /* Don't return in the middle of a possible function key sequence,
4542 if the only bindings we found were via case conversion.
4543 Thus, if ESC O a has a function-key-map translation
4544 and ESC o has a binding, don't return after ESC O,
4545 so that we can translate ESC O plus the next character. */
4549 int used_mouse_menu
= 0;
4551 /* Where the last real key started. If we need to throw away a
4552 key that has expanded into more than one element of keybuf
4553 (say, a mouse click on the mode line which is being treated
4554 as [mode-line (mouse-...)], then we backtrack to this point
4556 int last_real_key_start
;
4558 /* These variables are analogous to echo_start and keys_start;
4559 while those allow us to restart the entire key sequence,
4560 echo_local_start and keys_local_start allow us to throw away
4562 int echo_local_start
, keys_local_start
, local_first_binding
;
4565 error ("key sequence too long");
4568 echo_local_start
= echo_length ();
4569 keys_local_start
= this_command_key_count
;
4570 local_first_binding
= first_binding
;
4573 /* These are no-ops, unless we throw away a keystroke below and
4574 jumped back up to replay_key; in that case, these restore the
4575 variables to their original state, allowing us to replay the
4577 if (INTERACTIVE
&& t
< mock_input
)
4578 echo_truncate (echo_local_start
);
4579 this_command_key_count
= keys_local_start
;
4580 first_binding
= local_first_binding
;
4582 /* By default, assume each event is "real". */
4583 last_real_key_start
= t
;
4585 /* Does mock_input indicate that we are re-reading a key sequence? */
4589 add_command_key (key
);
4590 if (echo_keystrokes
)
4594 /* If not, we should actually read a character. */
4597 struct buffer
*buf
= current_buffer
;
4599 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
4602 /* read_char returns t when it shows a menu and the user rejects it.
4607 /* read_char returns -1 at the end of a macro.
4608 Emacs 18 handles this by returning immediately with a
4609 zero, so that's what we'll do. */
4610 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) == -1)
4616 /* If the current buffer has been changed from under us, the
4617 keymap may have changed, so replay the sequence. */
4618 if (XTYPE (key
) == Lisp_Buffer
)
4621 goto replay_sequence
;
4624 /* If we have a quit that was typed in another frame, and
4625 quit_throw_to_read_char switched buffers,
4626 replay to get the right keymap. */
4627 if (EQ (key
, quit_char
) && current_buffer
!= starting_buffer
)
4632 goto replay_sequence
;
4638 /* Clicks in non-text areas get prefixed by the symbol
4639 in their CHAR-ADDRESS field. For example, a click on
4640 the mode line is prefixed by the symbol `mode-line'.
4642 Furthermore, key sequences beginning with mouse clicks
4643 are read using the keymaps of the buffer clicked on, not
4644 the current buffer. So we may have to switch the buffer
4647 When we turn one event into two events, we must make sure
4648 that neither of the two looks like the original--so that,
4649 if we replay the events, they won't be expanded again.
4650 If not for this, such reexpansion could happen either here
4651 or when user programs play with this-command-keys. */
4652 if (EVENT_HAS_PARAMETERS (key
))
4656 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
4657 if (EQ (kind
, Qmouse_click
))
4659 Lisp_Object window
, posn
;
4661 window
= POSN_WINDOW (EVENT_START (key
));
4662 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4663 if (XTYPE (posn
) == Lisp_Cons
)
4665 /* We're looking at the second event of a
4666 sequence which we expanded before. Set
4667 last_real_key_start appropriately. */
4669 last_real_key_start
= t
- 1;
4672 /* Key sequences beginning with mouse clicks are
4673 read using the keymaps in the buffer clicked on,
4674 not the current buffer. If we're at the
4675 beginning of a key sequence, switch buffers. */
4676 if (last_real_key_start
== 0
4677 && XTYPE (window
) == Lisp_Window
4678 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
4679 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
4684 /* Arrange to go back to the original buffer once we're
4685 done reading the key sequence. Note that we can't
4686 use save_excursion_{save,restore} here, because they
4687 save point as well as the current buffer; we don't
4688 want to save point, because redisplay may change it,
4689 to accommodate a Fset_window_start or something. We
4690 don't want to do this at the top of the function,
4691 because we may get input from a subprocess which
4692 wants to change the selected window and stuff (say,
4694 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
4696 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
4697 goto replay_sequence
;
4699 else if (XTYPE (posn
) == Lisp_Symbol
)
4701 /* Expand mode-line and scroll-bar events into two events:
4702 use posn as a fake prefix key. */
4704 if (t
+ 1 >= bufsize
)
4705 error ("key sequence too long");
4710 /* Zap the position in key, so we know that we've
4711 expanded it, and don't try to do so again. */
4712 POSN_BUFFER_POSN (EVENT_START (key
))
4713 = Fcons (posn
, Qnil
);
4717 else if (EQ (kind
, Qswitch_frame
))
4719 /* If we're at the beginning of a key sequence, go
4720 ahead and return this event. If we're in the
4721 midst of a key sequence, delay it until the end. */
4724 delayed_switch_frame
= key
;
4728 else if (CONSP (XCONS (key
)->cdr
)
4729 && CONSP (EVENT_START (key
))
4730 && CONSP (XCONS (EVENT_START (key
))->cdr
))
4734 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4735 /* Handle menu-bar events:
4736 insert the dummy prefix event `menu-bar'. */
4737 if (EQ (posn
, Qmenu_bar
))
4739 if (t
+ 1 >= bufsize
)
4740 error ("key sequence too long");
4741 /* Run the Lucid hook. */
4742 if (!NILP (Vrun_hooks
))
4743 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4744 /* If it has changed current-menubar from previous value,
4745 really recompute the menubar from the value. */
4746 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4747 call0 (Qrecompute_lucid_menubar
);
4751 /* Zap the position in key, so we know that we've
4752 expanded it, and don't try to do so again. */
4753 POSN_BUFFER_POSN (EVENT_START (key
))
4754 = Fcons (posn
, Qnil
);
4757 goto replay_sequence
;
4759 else if (XTYPE (posn
) == Lisp_Cons
)
4761 /* We're looking at the second event of a
4762 sequence which we expanded before. Set
4763 last_real_key_start appropriately. */
4764 if (last_real_key_start
== t
&& t
> 0)
4765 last_real_key_start
= t
- 1;
4770 /* We have finally decided that KEY is something we might want
4772 first_binding
= (follow_key (key
,
4773 nmaps
- first_binding
,
4774 submaps
+ first_binding
,
4775 defs
+ first_binding
,
4776 submaps
+ first_binding
)
4779 /* If KEY wasn't bound, we'll try some fallbacks. */
4780 if (first_binding
>= nmaps
)
4784 head
= EVENT_HEAD (key
);
4785 if (EQ (head
, Vhelp_char
))
4787 read_key_sequence_cmd
= Vprefix_help_command
;
4789 last_nonmenu_event
= key
;
4793 if (XTYPE (head
) == Lisp_Symbol
)
4795 Lisp_Object breakdown
;
4798 breakdown
= parse_modifiers (head
);
4799 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4800 /* Attempt to reduce an unbound mouse event to a simpler
4801 event that is bound:
4802 Drags reduce to clicks.
4803 Double-clicks reduce to clicks.
4804 Triple-clicks reduce to double-clicks, then to clicks.
4805 Down-clicks are eliminated.
4806 Double-downs reduce to downs, then are eliminated.
4807 Triple-downs reduce to double-downs, then to downs,
4808 then are eliminated. */
4809 if (modifiers
& (down_modifier
| drag_modifier
4810 | double_modifier
| triple_modifier
))
4812 while (modifiers
& (down_modifier
| drag_modifier
4813 | double_modifier
| triple_modifier
))
4815 Lisp_Object new_head
, new_click
;
4816 if (modifiers
& triple_modifier
)
4817 modifiers
^= (double_modifier
| triple_modifier
);
4818 else if (modifiers
& (drag_modifier
| double_modifier
))
4819 modifiers
&= ~(drag_modifier
| double_modifier
);
4822 /* Dispose of this `down' event by simply jumping
4823 back to replay_key, to get another event.
4825 Note that if this event came from mock input,
4826 then just jumping back to replay_key will just
4827 hand it to us again. So we have to wipe out any
4830 We could delete keybuf[t] and shift everything
4831 after that to the left by one spot, but we'd also
4832 have to fix up any variable that points into
4833 keybuf, and shifting isn't really necessary
4836 Adding prefixes for non-textual mouse clicks
4837 creates two characters of mock input, and both
4838 must be thrown away. If we're only looking at
4839 the prefix now, we can just jump back to
4840 replay_key. On the other hand, if we've already
4841 processed the prefix, and now the actual click
4842 itself is giving us trouble, then we've lost the
4843 state of the keymaps we want to backtrack to, and
4844 we need to replay the whole sequence to rebuild
4847 Beyond that, only function key expansion could
4848 create more than two keys, but that should never
4849 generate mouse events, so it's okay to zero
4850 mock_input in that case too.
4852 Isn't this just the most wonderful code ever? */
4853 if (t
== last_real_key_start
)
4860 mock_input
= last_real_key_start
;
4861 goto replay_sequence
;
4866 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
4868 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
4870 /* Look for a binding for this new key. follow_key
4871 promises that it didn't munge submaps the
4872 last time we called it, since key was unbound. */
4874 = (follow_key (new_click
,
4875 nmaps
- local_first_binding
,
4876 submaps
+ local_first_binding
,
4877 defs
+ local_first_binding
,
4878 submaps
+ local_first_binding
)
4879 + local_first_binding
);
4881 /* If that click is bound, go for it. */
4882 if (first_binding
< nmaps
)
4887 /* Otherwise, we'll leave key set to the drag event. */
4894 /* Normally, last_nonmenu_event gets the previous key we read.
4895 But when a mouse popup menu is being used,
4896 we don't update last_nonmenu_event; it continues to hold the mouse
4897 event that preceded the first level of menu. */
4898 if (!used_mouse_menu
)
4899 last_nonmenu_event
= key
;
4901 /* If the sequence is unbound, see if we can hang a function key
4902 off the end of it. We only want to scan real keyboard input
4903 for function key sequences, so if mock_input says that we're
4904 re-reading old events, don't examine it. */
4905 if (first_binding
>= nmaps
4908 Lisp_Object fkey_next
;
4910 /* Continue scan from fkey_end until we find a bound suffix.
4911 If we fail, increment fkey_start
4912 and start fkey_end from there. */
4913 while (fkey_end
< t
)
4917 key
= keybuf
[fkey_end
++];
4918 /* Look up meta-characters by prefixing them
4919 with meta_prefix_char. I hate this. */
4920 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4925 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
4927 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4930 fkey_next
= fkey_map
;
4933 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
4935 #if 0 /* I didn't turn this on, because it might cause trouble
4936 for the mapping of return into C-m and tab into C-i. */
4937 /* Optionally don't map function keys into other things.
4938 This enables the user to redefine kp- keys easily. */
4939 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
4943 /* If the function key map gives a function, not an
4944 array, then call the function with no args and use
4945 its value instead. */
4946 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
4949 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4953 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4954 fkey_next
= call1 (fkey_next
, prompt
);
4956 /* If the function returned something invalid,
4957 barf--don't ignore it.
4958 (To ignore it safely, we would need to gcpro a bunch of
4959 other variables.) */
4960 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
4961 error ("Function in function-key-map returns invalid key sequence");
4964 function_key_possible
= ! NILP (fkey_next
);
4966 /* If keybuf[fkey_start..fkey_end] is bound in the
4967 function key map and it's a suffix of the current
4968 sequence (i.e. fkey_end == t), replace it with
4969 the binding and restart with fkey_start at the end. */
4970 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
4973 int len
= XFASTINT (Flength (fkey_next
));
4975 t
= fkey_start
+ len
;
4977 error ("key sequence too long");
4979 if (VECTORP (fkey_next
))
4980 bcopy (XVECTOR (fkey_next
)->contents
,
4981 keybuf
+ fkey_start
,
4982 (t
- fkey_start
) * sizeof (keybuf
[0]));
4983 else if (STRINGP (fkey_next
))
4987 for (i
= 0; i
< len
; i
++)
4988 XFASTINT (keybuf
[fkey_start
+ i
])
4989 = XSTRING (fkey_next
)->data
[i
];
4993 fkey_start
= fkey_end
= t
;
4994 fkey_map
= Vfunction_key_map
;
4996 goto replay_sequence
;
4999 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
5001 /* If we no longer have a bound suffix, try a new positions for
5003 if (NILP (fkey_map
))
5005 fkey_end
= ++fkey_start
;
5006 fkey_map
= Vfunction_key_map
;
5007 function_key_possible
= 0;
5012 /* Look for this sequence in key-translation-map. */
5014 Lisp_Object keytran_next
;
5016 /* Scan from keytran_end until we find a bound suffix. */
5017 while (keytran_end
< t
)
5021 key
= keybuf
[keytran_end
++];
5022 /* Look up meta-characters by prefixing them
5023 with meta_prefix_char. I hate this. */
5024 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
5029 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
5031 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
5034 keytran_next
= keytran_map
;
5037 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
5039 /* If the key translation map gives a function, not an
5040 array, then call the function with no args and use
5041 its value instead. */
5042 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
5043 && keytran_end
== t
)
5045 struct gcpro gcpro1
, gcpro2
, gcpro3
;
5049 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
5050 keytran_next
= call1 (keytran_next
, prompt
);
5052 /* If the function returned something invalid,
5053 barf--don't ignore it.
5054 (To ignore it safely, we would need to gcpro a bunch of
5055 other variables.) */
5056 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
5057 error ("Function in key-translation-map returns invalid key sequence");
5060 /* If keybuf[keytran_start..keytran_end] is bound in the
5061 key translation map and it's a suffix of the current
5062 sequence (i.e. keytran_end == t), replace it with
5063 the binding and restart with keytran_start at the end. */
5064 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
5065 && keytran_end
== t
)
5067 int len
= XFASTINT (Flength (keytran_next
));
5069 t
= keytran_start
+ len
;
5071 error ("key sequence too long");
5073 if (VECTORP (keytran_next
))
5074 bcopy (XVECTOR (keytran_next
)->contents
,
5075 keybuf
+ keytran_start
,
5076 (t
- keytran_start
) * sizeof (keybuf
[0]));
5077 else if (STRINGP (keytran_next
))
5081 for (i
= 0; i
< len
; i
++)
5082 XFASTINT (keybuf
[keytran_start
+ i
])
5083 = XSTRING (keytran_next
)->data
[i
];
5087 keytran_start
= keytran_end
= t
;
5088 keytran_map
= Vkey_translation_map
;
5090 goto replay_sequence
;
5093 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
5095 /* If we no longer have a bound suffix, try a new positions for
5097 if (NILP (keytran_map
))
5099 keytran_end
= ++keytran_start
;
5100 keytran_map
= Vkey_translation_map
;
5105 /* If KEY is not defined in any of the keymaps,
5106 and cannot be part of a function key or translation,
5107 and is an upper case letter
5108 use the corresponding lower-case letter instead. */
5109 if (first_binding
== nmaps
&& ! function_key_possible
5110 && XTYPE (key
) == Lisp_Int
5111 && ((((XINT (key
) & 0x3ffff)
5112 < XSTRING (current_buffer
->downcase_table
)->size
)
5113 && UPPERCASEP (XINT (key
) & 0x3ffff))
5114 || (XINT (key
) & shift_modifier
)))
5116 if (XINT (key
) & shift_modifier
)
5117 XSETINT (key
, XINT (key
) & ~shift_modifier
);
5119 XSETINT (key
, (DOWNCASE (XINT (key
) & 0x3ffff)
5120 | (XINT (key
) & ~0x3ffff)));
5122 keybuf
[t
- 1] = key
;
5124 goto replay_sequence
;
5128 read_key_sequence_cmd
= (first_binding
< nmaps
5129 ? defs
[first_binding
]
5133 unread_switch_frame
= delayed_switch_frame
;
5134 unbind_to (count
, Qnil
);
5136 /* Occasionally we fabricate events, perhaps by expanding something
5137 according to function-key-map, or by adding a prefix symbol to a
5138 mouse click in the scroll bar or modeline. In this cases, return
5139 the entire generated key sequence, even if we hit an unbound
5140 prefix or a definition before the end. This means that you will
5141 be able to push back the event properly, and also means that
5142 read-key-sequence will always return a logical unit.
5145 for (; t
< mock_input
; t
++)
5147 if (echo_keystrokes
)
5148 echo_char (keybuf
[t
]);
5149 add_command_key (keybuf
[t
]);
5155 #if 0 /* This doc string is too long for some compilers.
5156 This commented-out definition serves for DOC. */
5157 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
5158 "Read a sequence of keystrokes and return as a string or vector.\n\
5159 The sequence is sufficient to specify a non-prefix command in the\n\
5160 current local and global maps.\n\
5162 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
5163 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
5164 as a continuation of the previous key.\n\
5166 A C-g typed while in this function is treated like any other character,\n\
5167 and `quit-flag' is not set.\n\
5169 If the key sequence starts with a mouse click, then the sequence is read\n\
5170 using the keymaps of the buffer of the window clicked in, not the buffer\n\
5171 of the selected window as normal.\n\
5173 `read-key-sequence' drops unbound button-down events, since you normally\n\
5174 only care about the click or drag events which follow them. If a drag\n\
5175 or multi-click event is unbound, but the corresponding click event would\n\
5176 be bound, `read-key-sequence' turns the event into a click event at the\n\
5177 drag's starting position. This means that you don't have to distinguish\n\
5178 between click and drag, double, or triple events unless you want to.\n\
5180 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
5181 lines separating windows, and scroll bars with imaginary keys\n\
5182 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
5184 If the user switches frames in the middle of a key sequence, the\n\
5185 frame-switch event is put off until after the current key sequence.\n\
5187 `read-key-sequence' checks `function-key-map' for function key\n\
5188 sequences, where they wouldn't conflict with ordinary bindings. See\n\
5189 `function-key-map' for more details.")
5190 (prompt
, continue_echo
)
5193 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
5195 (prompt
, continue_echo
)
5196 Lisp_Object prompt
, continue_echo
;
5198 Lisp_Object keybuf
[30];
5200 struct gcpro gcpro1
, gcpro2
;
5203 CHECK_STRING (prompt
, 0);
5206 bzero (keybuf
, sizeof keybuf
);
5208 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
5210 if (NILP (continue_echo
))
5211 this_command_key_count
= 0;
5213 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])), prompt
);
5221 return make_event_array (i
, keybuf
);
5224 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
5225 "Execute CMD as an editor command.\n\
5226 CMD must be a symbol that satisfies the `commandp' predicate.\n\
5227 Optional second arg RECORD-FLAG non-nil\n\
5228 means unconditionally put this command in `command-history'.\n\
5229 Otherwise, that is done only if an arg is read using the minibuffer.")
5231 Lisp_Object cmd
, record
;
5233 register Lisp_Object final
;
5234 register Lisp_Object tem
;
5235 Lisp_Object prefixarg
;
5236 struct backtrace backtrace
;
5237 extern int debug_on_next_call
;
5239 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
5240 Vcurrent_prefix_arg
= prefixarg
;
5241 debug_on_next_call
= 0;
5243 if (XTYPE (cmd
) == Lisp_Symbol
)
5245 tem
= Fget (cmd
, Qdisabled
);
5246 if (!NILP (tem
) && !NILP (Vrun_hooks
))
5247 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
5252 final
= Findirect_function (cmd
);
5254 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
5255 do_autoload (final
, cmd
);
5260 if (XTYPE (final
) == Lisp_String
5261 || XTYPE (final
) == Lisp_Vector
)
5263 /* If requested, place the macro in the command history. For
5264 other sorts of commands, call-interactively takes care of
5268 = Fcons (Fcons (Qexecute_kbd_macro
,
5269 Fcons (final
, Fcons (prefixarg
, Qnil
))),
5272 return Fexecute_kbd_macro (final
, prefixarg
);
5274 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
5275 || XTYPE (final
) == Lisp_Compiled
)
5277 backtrace
.next
= backtrace_list
;
5278 backtrace_list
= &backtrace
;
5279 backtrace
.function
= &Qcall_interactively
;
5280 backtrace
.args
= &cmd
;
5281 backtrace
.nargs
= 1;
5282 backtrace
.evalargs
= 0;
5284 tem
= Fcall_interactively (cmd
, record
);
5286 backtrace_list
= backtrace
.next
;
5292 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
5294 "Read function name, then read its arguments and call it.")
5296 Lisp_Object prefixarg
;
5298 Lisp_Object function
;
5300 Lisp_Object saved_keys
;
5301 struct gcpro gcpro1
;
5303 saved_keys
= Fvector (this_command_key_count
,
5304 XVECTOR (this_command_keys
)->contents
);
5306 GCPRO1 (saved_keys
);
5308 if (EQ (prefixarg
, Qminus
))
5310 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
5311 strcpy (buf
, "C-u ");
5312 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
5313 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
5314 else if (XTYPE (prefixarg
) == Lisp_Int
)
5315 sprintf (buf
, "%d ", XINT (prefixarg
));
5317 /* This isn't strictly correct if execute-extended-command
5318 is bound to anything else. Perhaps it should use
5319 this_command_keys? */
5320 strcat (buf
, "M-x ");
5322 /* Prompt with buf, and then read a string, completing from and
5323 restricting to the set of all defined commands. Don't provide
5324 any initial input. Save the command read on the extended-command
5326 function
= Fcompleting_read (build_string (buf
),
5327 Vobarray
, Qcommandp
,
5328 Qt
, Qnil
, Qextended_command_history
);
5330 /* Set this_command_keys to the concatenation of saved_keys and
5331 function, followed by a RET. */
5333 struct Lisp_String
*str
;
5338 this_command_key_count
= 0;
5340 keys
= XVECTOR (saved_keys
)->contents
;
5341 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
5342 add_command_key (keys
[i
]);
5344 str
= XSTRING (function
);
5345 for (i
= 0; i
< str
->size
; i
++)
5347 XFASTINT (tem
) = str
->data
[i
];
5348 add_command_key (tem
);
5351 XFASTINT (tem
) = '\015';
5352 add_command_key (tem
);
5357 function
= Fintern (function
, Qnil
);
5358 Vprefix_arg
= prefixarg
;
5359 this_command
= function
;
5361 return Fcommand_execute (function
, Qt
);
5365 detect_input_pending ()
5368 get_input_pending (&input_pending
);
5370 return input_pending
;
5373 /* This is called in some cases before a possible quit.
5374 It cases the next call to detect_input_pending to recompute input_pending.
5375 So calling this function unnecessarily can't do any harm. */
5376 clear_input_pending ()
5381 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
5382 "T if command input is currently available with no waiting.\n\
5383 Actually, the value is nil only if we can be sure that no input is available.")
5386 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
5389 return detect_input_pending () ? Qt
: Qnil
;
5392 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
5393 "Return vector of last 100 events, not counting those from keyboard macros.")
5396 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
5399 if (total_keys
< NUM_RECENT_KEYS
)
5400 return Fvector (total_keys
, keys
);
5403 val
= Fvector (NUM_RECENT_KEYS
, keys
);
5404 bcopy (keys
+ recent_keys_index
,
5405 XVECTOR (val
)->contents
,
5406 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
5408 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
5409 recent_keys_index
* sizeof (Lisp_Object
));
5414 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
5415 "Return the key sequence that invoked this command.\n\
5416 The value is a string or a vector.")
5419 return make_event_array (this_command_key_count
,
5420 XVECTOR (this_command_keys
)->contents
);
5423 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
5424 "Return the current depth in recursive edits.")
5428 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
5432 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
5433 "FOpen dribble file: ",
5434 "Start writing all keyboard characters to a dribble file called FILE.\n\
5435 If FILE is nil, close any open dribble file.")
5446 file
= Fexpand_file_name (file
, Qnil
);
5447 dribble
= fopen (XSTRING (file
)->data
, "w");
5452 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
5453 "Discard the contents of the terminal input buffer.\n\
5454 Also cancel any kbd macro being defined.")
5457 defining_kbd_macro
= 0;
5458 update_mode_lines
++;
5460 Vunread_command_events
= Qnil
;
5461 unread_command_char
= -1;
5463 discard_tty_input ();
5465 /* Without the cast, GCC complains that this assignment loses the
5466 volatile qualifier of kbd_store_ptr. Is there anything wrong
5468 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
5469 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5475 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
5476 "Stop Emacs and return to superior process. You can resume later.\n\
5477 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
5478 control, run a subshell instead.\n\n\
5479 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
5480 to be read as terminal input by Emacs's parent, after suspension.\n\
5482 Before suspending, call the functions in `suspend-hook' with no args.\n\
5483 If any of them returns nil, don't call the rest and don't suspend.\n\
5484 Otherwise, suspend normally and after resumption run the normal hook\n\
5485 `suspend-resume-hook' if that is bound and non-nil.\n\
5487 Some operating systems cannot stop the Emacs process and resume it later.\n\
5488 On such systems, Emacs starts a subshell instead of suspending.")
5490 Lisp_Object stuffstring
;
5493 int count
= specpdl_ptr
- specpdl
;
5494 int old_height
, old_width
;
5496 struct gcpro gcpro1
, gcpro2
;
5497 extern init_sys_modes ();
5499 if (!NILP (stuffstring
))
5500 CHECK_STRING (stuffstring
, 0);
5502 /* Run the functions in suspend-hook. */
5503 if (!NILP (Vrun_hooks
))
5504 call1 (Vrun_hooks
, intern ("suspend-hook"));
5506 GCPRO1 (stuffstring
);
5507 get_frame_size (&old_width
, &old_height
);
5509 /* sys_suspend can get an error if it tries to fork a subshell
5510 and the system resources aren't available for that. */
5511 record_unwind_protect (init_sys_modes
, 0);
5512 stuff_buffered_input (stuffstring
);
5517 unbind_to (count
, Qnil
);
5519 /* Check if terminal/window size has changed.
5520 Note that this is not useful when we are running directly
5521 with a window system; but suspend should be disabled in that case. */
5522 get_frame_size (&width
, &height
);
5523 if (width
!= old_width
|| height
!= old_height
)
5524 change_frame_size (selected_frame
, height
, width
, 0, 0);
5526 /* Run suspend-resume-hook. */
5527 if (!NILP (Vrun_hooks
))
5528 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
5534 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
5535 Then in any case stuff anything Emacs has read ahead and not used. */
5537 stuff_buffered_input (stuffstring
)
5538 Lisp_Object stuffstring
;
5540 register unsigned char *p
;
5542 /* stuff_char works only in BSD, versions 4.2 and up. */
5545 if (XTYPE (stuffstring
) == Lisp_String
)
5549 p
= XSTRING (stuffstring
)->data
;
5550 count
= XSTRING (stuffstring
)->size
;
5555 /* Anything we have read ahead, put back for the shell to read. */
5556 while (kbd_fetch_ptr
!= kbd_store_ptr
)
5558 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
5559 kbd_fetch_ptr
= kbd_buffer
;
5560 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
5561 stuff_char (kbd_fetch_ptr
->code
);
5562 kbd_fetch_ptr
->kind
= no_event
;
5563 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
5570 #endif /* BSD and not BSD4_1 */
5573 set_waiting_for_input (time_to_clear
)
5574 EMACS_TIME
*time_to_clear
;
5576 input_available_clear_time
= time_to_clear
;
5578 /* Tell interrupt_signal to throw back to read_char, */
5579 waiting_for_input
= 1;
5581 /* If interrupt_signal was called before and buffered a C-g,
5582 make it run again now, to avoid timing error. */
5583 if (!NILP (Vquit_flag
))
5584 quit_throw_to_read_char ();
5587 clear_waiting_for_input ()
5589 /* Tell interrupt_signal not to throw back to read_char, */
5590 waiting_for_input
= 0;
5591 input_available_clear_time
= 0;
5594 /* This routine is called at interrupt level in response to C-G.
5595 If interrupt_input, this is the handler for SIGINT.
5596 Otherwise, it is called from kbd_buffer_store_event,
5597 in handling SIGIO or SIGTINT.
5599 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
5600 immediately throw back to read_char.
5602 Otherwise it sets the Lisp variable quit-flag not-nil.
5603 This causes eval to throw, when it gets a chance.
5604 If quit-flag is already non-nil, it stops the job right away. */
5610 /* Must preserve main program's value of errno. */
5611 int old_errno
= errno
;
5614 if (!read_socket_hook
&& NILP (Vwindow_system
))
5616 /* USG systems forget handlers when they are used;
5617 must reestablish each time */
5618 signal (SIGINT
, interrupt_signal
);
5619 signal (SIGQUIT
, interrupt_signal
);
5625 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
5630 #ifdef SIGTSTP /* Support possible in later USG versions */
5632 * On systems which can suspend the current process and return to the original
5633 * shell, this command causes the user to end up back at the shell.
5634 * The "Auto-save" and "Abort" questions are not asked until
5635 * the user elects to return to emacs, at which point he can save the current
5636 * job and either dump core or continue.
5641 if (sys_suspend () == -1)
5643 printf ("Not running as a subprocess;\n");
5644 printf ("you can continue or abort.\n");
5647 /* Perhaps should really fork an inferior shell?
5648 But that would not provide any way to get back
5649 to the original shell, ever. */
5650 printf ("No support for stopping a process on this operating system;\n");
5651 printf ("you can continue or abort.\n");
5652 #endif /* not VMS */
5653 #endif /* not SIGTSTP */
5655 /* We must remain inside the screen area when the internal terminal
5656 is used. Note that [Enter] is not echoed by dos. */
5659 printf ("Auto-save? (y or n) ");
5661 if (((c
= getchar ()) & ~040) == 'Y')
5663 Fdo_auto_save (Qt
, Qnil
);
5665 printf ("\r\nAuto-save done");
5666 #else /* not MSDOS */
5667 printf ("Auto-save done\n");
5668 #endif /* not MSDOS */
5670 while (c
!= '\n') c
= getchar ();
5672 printf ("\r\nAbort? (y or n) ");
5673 #else /* not MSDOS */
5675 printf ("Abort (and enter debugger)? (y or n) ");
5677 printf ("Abort (and dump core)? (y or n) ");
5678 #endif /* not VMS */
5679 #endif /* not MSDOS */
5681 if (((c
= getchar ()) & ~040) == 'Y')
5683 while (c
!= '\n') c
= getchar ();
5685 printf ("\r\nContinuing...\r\n");
5686 #else /* not MSDOS */
5687 printf ("Continuing...\n");
5688 #endif /* not MSDOS */
5694 /* If executing a function that wants to be interrupted out of
5695 and the user has not deferred quitting by binding `inhibit-quit'
5696 then quit right away. */
5697 if (immediate_quit
&& NILP (Vinhibit_quit
))
5701 Fsignal (Qquit
, Qnil
);
5704 /* Else request quit when it's safe */
5708 if (waiting_for_input
&& !echoing
)
5709 quit_throw_to_read_char ();
5714 /* Handle a C-g by making read_char return C-g. */
5716 quit_throw_to_read_char ()
5718 quit_error_check ();
5720 /* Prevent another signal from doing this before we finish. */
5721 clear_waiting_for_input ();
5724 Vunread_command_events
= Qnil
;
5725 unread_command_char
= -1;
5727 #ifdef POLL_FOR_INPUT
5728 /* May be > 1 if in recursive minibuffer. */
5729 if (poll_suppress_count
== 0)
5733 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
5734 && XFRAME (internal_last_event_frame
) != selected_frame
)
5735 Fhandle_switch_frame (make_lispy_switch_frame (internal_last_event_frame
));
5738 _longjmp (getcjmp
, 1);
5741 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
5742 "Set mode of reading keyboard input.\n\
5743 First arg INTERRUPT non-nil means use input interrupts;\n\
5744 nil means use CBREAK mode.\n\
5745 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
5746 (no effect except in CBREAK mode).\n\
5747 Third arg META t means accept 8-bit input (for a Meta key).\n\
5748 META nil means ignore the top bit, on the assumption it is parity.\n\
5749 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
5750 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
5751 See also `current-input-mode'.")
5752 (interrupt
, flow
, meta
, quit
)
5753 Lisp_Object interrupt
, flow
, meta
, quit
;
5756 && (XTYPE (quit
) != Lisp_Int
5757 || XINT (quit
) < 0 || XINT (quit
) > 0400))
5758 error ("set-input-mode: QUIT must be an ASCII character");
5760 #ifdef POLL_FOR_INPUT
5766 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5767 #ifdef NO_SOCK_SIGIO
5768 if (read_socket_hook
)
5769 interrupt_input
= 0; /* No interrupts if reading from a socket. */
5771 #endif /* NO_SOCK_SIGIO */
5772 interrupt_input
= !NILP (interrupt
);
5773 #else /* not SIGIO */
5774 interrupt_input
= 0;
5775 #endif /* not SIGIO */
5776 /* Our VMS input only works by interrupts, as of now. */
5778 interrupt_input
= 1;
5780 flow_control
= !NILP (flow
);
5783 else if (EQ (meta
, Qt
))
5788 /* Don't let this value be out of range. */
5789 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
5793 #ifdef POLL_FOR_INPUT
5794 poll_suppress_count
= 1;
5800 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
5801 "Return information about the way Emacs currently reads keyboard input.\n\
5802 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
5803 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
5804 nil, Emacs is using CBREAK mode.\n\
5805 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
5806 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
5807 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
5808 META nil means ignoring the top bit, on the assumption it is parity.\n\
5809 META is neither t nor nil if accepting 8-bit input and using\n\
5810 all 8 bits as the character code.\n\
5811 QUIT is the character Emacs currently uses to quit.\n\
5812 The elements of this list correspond to the arguments of\n\
5818 val
[0] = interrupt_input
? Qt
: Qnil
;
5819 val
[1] = flow_control
? Qt
: Qnil
;
5820 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
5821 XFASTINT (val
[3]) = quit_char
;
5823 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
5829 /* This is correct before outermost invocation of the editor loop */
5830 command_loop_level
= -1;
5832 quit_char
= Ctl ('g');
5833 Vunread_command_events
= Qnil
;
5834 unread_command_char
= -1;
5836 recent_keys_index
= 0;
5837 kbd_fetch_ptr
= kbd_buffer
;
5838 kbd_store_ptr
= kbd_buffer
;
5839 do_mouse_tracking
= 0;
5843 /* This means that command_loop_1 won't try to select anything the first
5845 internal_last_event_frame
= Qnil
;
5846 Vlast_event_frame
= internal_last_event_frame
;
5849 /* If we're running a dumped Emacs, we need to clear out
5850 kbd_buffer_frame_or_window, in case some events got into it
5853 If we're running an undumped Emacs, it hasn't been initialized by
5854 syms_of_keyboard yet. */
5856 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5858 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
5860 signal (SIGINT
, interrupt_signal
);
5861 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
5862 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
5863 SIGQUIT and we can't tell which one it will give us. */
5864 signal (SIGQUIT
, interrupt_signal
);
5865 #endif /* HAVE_TERMIO */
5867 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5869 if (!noninteractive
)
5870 signal (SIGIO
, input_available_signal
);
5873 /* Use interrupt input by default, if it works and noninterrupt input
5874 has deficiencies. */
5876 #ifdef INTERRUPT_INPUT
5877 interrupt_input
= 1;
5879 interrupt_input
= 0;
5882 /* Our VMS input only works by interrupts, as of now. */
5884 interrupt_input
= 1;
5890 if (keyboard_init_hook
)
5891 (*keyboard_init_hook
) ();
5893 #ifdef POLL_FOR_INPUT
5894 poll_suppress_count
= 1;
5899 /* This type's only use is in syms_of_keyboard, to initialize the
5900 event header symbols and put properties on them. */
5907 struct event_head head_table
[] = {
5908 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
5909 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
5910 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
5915 Qdisabled_command_hook
= intern ("disabled-command-hook");
5916 staticpro (&Qdisabled_command_hook
);
5918 Qself_insert_command
= intern ("self-insert-command");
5919 staticpro (&Qself_insert_command
);
5921 Qforward_char
= intern ("forward-char");
5922 staticpro (&Qforward_char
);
5924 Qbackward_char
= intern ("backward-char");
5925 staticpro (&Qbackward_char
);
5927 Qdisabled
= intern ("disabled");
5928 staticpro (&Qdisabled
);
5930 Qundefined
= intern ("undefined");
5931 staticpro (&Qundefined
);
5933 Qpre_command_hook
= intern ("pre-command-hook");
5934 staticpro (&Qpre_command_hook
);
5936 Qpost_command_hook
= intern ("post-command-hook");
5937 staticpro (&Qpost_command_hook
);
5939 Qcommand_hook_internal
= intern ("command-hook-internal");
5940 staticpro (&Qcommand_hook_internal
);
5942 Qfunction_key
= intern ("function-key");
5943 staticpro (&Qfunction_key
);
5944 Qmouse_click
= intern ("mouse-click");
5945 staticpro (&Qmouse_click
);
5947 Qmenu_enable
= intern ("menu-enable");
5948 staticpro (&Qmenu_enable
);
5950 Qmode_line
= intern ("mode-line");
5951 staticpro (&Qmode_line
);
5952 Qvertical_line
= intern ("vertical-line");
5953 staticpro (&Qvertical_line
);
5954 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
5955 staticpro (&Qvertical_scroll_bar
);
5956 Qmenu_bar
= intern ("menu-bar");
5957 staticpro (&Qmenu_bar
);
5959 Qabove_handle
= intern ("above-handle");
5960 staticpro (&Qabove_handle
);
5961 Qhandle
= intern ("handle");
5962 staticpro (&Qhandle
);
5963 Qbelow_handle
= intern ("below-handle");
5964 staticpro (&Qbelow_handle
);
5966 Qevent_kind
= intern ("event-kind");
5967 staticpro (&Qevent_kind
);
5968 Qevent_symbol_elements
= intern ("event-symbol-elements");
5969 staticpro (&Qevent_symbol_elements
);
5970 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
5971 staticpro (&Qevent_symbol_element_mask
);
5972 Qmodifier_cache
= intern ("modifier-cache");
5973 staticpro (&Qmodifier_cache
);
5975 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
5976 staticpro (&Qrecompute_lucid_menubar
);
5977 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
5978 staticpro (&Qactivate_menubar_hook
);
5980 Qpolling_period
= intern ("polling-period");
5981 staticpro (&Qpolling_period
);
5984 struct event_head
*p
;
5986 for (p
= head_table
;
5987 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
5990 *p
->var
= intern (p
->name
);
5992 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
5993 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
5997 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
5998 staticpro (&button_down_location
);
6002 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
6004 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
6005 for (i
= 0; i
< len
; i
++)
6006 if (modifier_names
[i
])
6007 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
6008 staticpro (&modifier_symbols
);
6011 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
6012 staticpro (&recent_keys
);
6014 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
6015 staticpro (&this_command_keys
);
6017 Qextended_command_history
= intern ("extended-command-history");
6018 Fset (Qextended_command_history
, Qnil
);
6019 staticpro (&Qextended_command_history
);
6021 kbd_buffer_frame_or_window
6022 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
6023 staticpro (&kbd_buffer_frame_or_window
);
6025 accent_key_syms
= Qnil
;
6026 staticpro (&accent_key_syms
);
6028 func_key_syms
= Qnil
;
6029 staticpro (&func_key_syms
);
6031 system_key_syms
= Qnil
;
6032 staticpro (&system_key_syms
);
6035 staticpro (&mouse_syms
);
6037 unread_switch_frame
= Qnil
;
6038 staticpro (&unread_switch_frame
);
6040 defsubr (&Sread_key_sequence
);
6041 defsubr (&Srecursive_edit
);
6042 defsubr (&Strack_mouse
);
6043 defsubr (&Sinput_pending_p
);
6044 defsubr (&Scommand_execute
);
6045 defsubr (&Srecent_keys
);
6046 defsubr (&Sthis_command_keys
);
6047 defsubr (&Ssuspend_emacs
);
6048 defsubr (&Sabort_recursive_edit
);
6049 defsubr (&Sexit_recursive_edit
);
6050 defsubr (&Srecursion_depth
);
6051 defsubr (&Stop_level
);
6052 defsubr (&Sdiscard_input
);
6053 defsubr (&Sopen_dribble_file
);
6054 defsubr (&Sset_input_mode
);
6055 defsubr (&Scurrent_input_mode
);
6056 defsubr (&Sexecute_extended_command
);
6058 DEFVAR_LISP ("last-command-char", &last_command_char
,
6059 "Last input event that was part of a command.");
6061 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
6062 "Last input event that was part of a command.");
6064 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
6065 "Last input event in a command, except for mouse menu events.\n\
6066 Mouse menus give back keys that don't look like mouse events;\n\
6067 this variable holds the actual mouse event that led to the menu,\n\
6068 so that you can determine whether the command was run by mouse or not.");
6070 DEFVAR_LISP ("last-input-char", &last_input_char
,
6071 "Last input event.");
6073 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
6074 "Last input event.");
6076 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
6077 "List of objects to be read as next command input events.");
6079 DEFVAR_INT ("unread-command-char", &unread_command_char
,
6080 "If not -1, an object to be read as next command input event.");
6082 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
6083 "Meta-prefix character code. Meta-foo as command input\n\
6084 turns into this character followed by foo.");
6085 XSET (meta_prefix_char
, Lisp_Int
, 033);
6087 DEFVAR_LISP ("last-command", &last_command
,
6088 "The last command executed. Normally a symbol with a function definition,\n\
6089 but can be whatever was found in the keymap, or whatever the variable\n\
6090 `this-command' was set to by that command.");
6091 last_command
= Qnil
;
6093 DEFVAR_LISP ("this-command", &this_command
,
6094 "The command now being executed.\n\
6095 The command can set this variable; whatever is put here\n\
6096 will be in `last-command' during the following command.");
6097 this_command
= Qnil
;
6099 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
6100 "*Number of keyboard input characters between auto-saves.\n\
6101 Zero means disable autosaving due to number of characters typed.");
6102 auto_save_interval
= 300;
6104 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
6105 "*Number of seconds idle time before auto-save.\n\
6106 Zero or nil means disable auto-saving due to idleness.\n\
6107 After auto-saving due to this many seconds of idle time,\n\
6108 Emacs also does a garbage collection if that seems to be warranted.");
6109 XFASTINT (Vauto_save_timeout
) = 30;
6111 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
6112 "*Nonzero means echo unfinished commands after this many seconds of pause.");
6113 echo_keystrokes
= 1;
6115 DEFVAR_INT ("polling-period", &polling_period
,
6116 "*Interval between polling for input during Lisp execution.\n\
6117 The reason for polling is to make C-g work to stop a running program.\n\
6118 Polling is needed only when using X windows and SIGIO does not work.\n\
6119 Polling is automatically disabled in all other cases.");
6122 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
6123 "*Maximum time between mouse clicks to make a double-click.\n\
6124 Measured in milliseconds. nil means disable double-click recognition;\n\
6125 t means double-clicks have no time limit and are detected\n\
6126 by position only.");
6127 Vdouble_click_time
= make_number (500);
6129 DEFVAR_INT ("num-input-keys", &num_input_keys
,
6130 "*Number of complete keys read from the keyboard so far.");
6133 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
6134 "*The frame in which the most recently read event occurred.\n\
6135 If the last event came from a keyboard macro, this is set to `macro'.");
6136 Vlast_event_frame
= Qnil
;
6138 DEFVAR_LISP ("help-char", &Vhelp_char
,
6139 "Character to recognize as meaning Help.\n\
6140 When it is read, do `(eval help-form)', and display result if it's a string.\n\
6141 If the value of `help-form' is nil, this char can be read normally.");
6142 XSET (Vhelp_char
, Lisp_Int
, Ctl ('H'));
6144 DEFVAR_LISP ("help-form", &Vhelp_form
,
6145 "Form to execute when character `help-char' is read.\n\
6146 If the form returns a string, that string is displayed.\n\
6147 If `help-form' is nil, the help char is not recognized.");
6150 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
6151 "Command to run when `help-char' character follows a prefix key.\n\
6152 This command is used only when there is no actual binding\n\
6153 for that character after that prefix key.");
6154 Vprefix_help_command
= Qnil
;
6156 DEFVAR_LISP ("top-level", &Vtop_level
,
6157 "Form to evaluate when Emacs starts up.\n\
6158 Useful to set before you dump a modified Emacs.");
6161 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
6162 "String used as translate table for keyboard input, or nil.\n\
6163 Each character is looked up in this string and the contents used instead.\n\
6164 If string is of length N, character codes N and up are untranslated.");
6165 Vkeyboard_translate_table
= Qnil
;
6167 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
6168 "Keymap of key translations that can override keymaps.\n\
6169 This keymap works like `function-key-map', but comes after that,\n\
6170 and applies even for keys that have ordinary bindings.");
6171 Vkey_translation_map
= Qnil
;
6173 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
6174 "Non-nil means to always spawn a subshell instead of suspending,\n\
6175 even if the operating system has support for stopping a process.");
6178 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
6179 "Non-nil means prompt with menus when appropriate.\n\
6180 This is done when reading from a keymap that has a prompt string,\n\
6181 for elements that have prompt strings.\n\
6182 The menu is displayed on the screen\n\
6183 if X menus were enabled at configuration\n\
6184 time and the previous event was a mouse click prefix key.\n\
6185 Otherwise, menu prompting uses the echo area.");
6188 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
6189 "Character to see next line of menu prompt.\n\
6190 Type this character while in a menu prompt to rotate around the lines of it.");
6191 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
6193 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
6194 "A mask of additional modifier keys to use with every keyboard character.\n\
6195 Emacs applies the modifiers of the character stored here to each keyboard\n\
6196 character it reads. For example, after evaluating the expression\n\
6197 (setq extra-keyboard-modifiers ?\C-x)\n\
6198 all input characters will have the control modifier applied to them.\n\
6200 Note that the character ?\C-@, equivalent to the integer zero, does\n\
6201 not count as a control character; rather, it counts as a character\n\
6202 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
6203 cancels any modification.");
6204 extra_keyboard_modifiers
= 0;
6206 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
6207 "If an editing command sets this to t, deactivate the mark afterward.\n\
6208 The command loop sets this to nil before each command,\n\
6209 and tests the value when the command returns.\n\
6210 Buffer modification stores t in this variable.");
6211 Vdeactivate_mark
= Qnil
;
6213 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
6214 "Temporary storage of pre-command-hook or post-command-hook.");
6215 Vcommand_hook_internal
= Qnil
;
6217 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
6218 "Normal hook run before each command is executed.\n\
6219 While the hook is run, its value is temporarily set to nil\n\
6220 to avoid an unbreakable infinite loop if a hook function gets an error.\n\
6221 As a result, a hook function cannot straightforwardly alter the value of\n\
6222 `pre-command-hook'. See the Emacs Lisp manual for a way of\n\
6223 implementing hook functions that alter the set of hook functions.");
6224 Vpre_command_hook
= Qnil
;
6226 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
6227 "Normal hook run after each command is executed.\n\
6228 While the hook is run, its value is temporarily set to nil\n\
6229 to avoid an unbreakable infinite loop if a hook function gets an error.\n\
6230 As a result, a hook function cannot straightforwardly alter the value of\n\
6231 `post-command-hook'. See the Emacs Lisp manual for a way of\n\
6232 implementing hook functions that alter the set of hook functions.");
6233 Vpost_command_hook
= Qnil
;
6235 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
6236 "t means menu bar, specified Lucid style, needs to be recomputed.");
6237 Vlucid_menu_bar_dirty_flag
= Qnil
;
6239 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
6240 "List of menu bar items to move to the end of the menu bar.\n\
6241 The elements of the list are event types that may have menu bar bindings.");
6242 Vmenu_bar_final_items
= Qnil
;
6244 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
6245 "Keymap that overrides all other local keymaps.\n\
6246 If this variable is non-nil, it is used as a keymap instead of the\n\
6247 buffer's local map, and the minor mode keymaps and text property keymaps.");
6248 Voverriding_local_map
= Qnil
;
6250 DEFVAR_BOOL ("track-mouse", &do_mouse_tracking
,
6251 "*Non-nil means generate motion events for mouse motion.");
6253 DEFVAR_LISP ("system-key-alist", &Vsystem_key_alist
,
6254 "Alist of system-specific X windows key symbols.\n\
6255 Each element should have the form (N . SYMBOL) where N is the\n\
6256 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
6257 and SYMBOL is its name.");
6258 Vsystem_key_alist
= Qnil
;
6260 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
6261 "List of deferred actions to be performed at a later time.\n\
6262 The precise format isn't relevant here; we just check whether it is nil.");
6263 Vdeferred_action_list
= Qnil
;
6265 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
6266 "Function to call to handle deferred actions, after each command.\n\
6267 This function is called with no arguments after each command\n\
6268 whenever `deferred-action-list' is non-nil.");
6269 Vdeferred_action_function
= Qnil
;
6274 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
6275 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
6276 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
6277 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
6278 initial_define_key (meta_map
, 'x', "execute-extended-command");