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
;
75 /* File descriptor to use for input. */
79 /* Make all keyboard buffers much bigger when using X windows. */
80 #define KBD_BUFFER_SIZE 4096
81 #else /* No X-windows, character input */
82 #define KBD_BUFFER_SIZE 256
83 #endif /* No X-windows */
85 /* Following definition copied from eval.c */
89 struct backtrace
*next
;
90 Lisp_Object
*function
;
91 Lisp_Object
*args
; /* Points to vector of args. */
92 int nargs
; /* length of vector. If nargs is UNEVALLED,
93 args points to slot holding list of
98 /* Non-nil disable property on a command means
99 do not execute it; call disabled-command-hook's value instead. */
100 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
102 #define NUM_RECENT_KEYS (100)
103 int recent_keys_index
; /* Index for storing next element into recent_keys */
104 int total_keys
; /* Total number of elements stored into recent_keys */
105 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
107 /* Vector holding the key sequence that invoked the current command.
108 It is reused for each command, and it may be longer than the current
109 sequence; this_command_key_count indicates how many elements
110 actually mean something.
111 It's easier to staticpro a single Lisp_Object than an array. */
112 Lisp_Object this_command_keys
;
113 int this_command_key_count
;
115 extern int minbuf_level
;
117 extern struct backtrace
*backtrace_list
;
119 /* Nonzero means do menu prompting. */
120 static int menu_prompting
;
122 /* Character to see next line of menu prompt. */
123 static Lisp_Object menu_prompt_more_char
;
125 /* For longjmp to where kbd input is being done. */
126 static jmp_buf getcjmp
;
128 /* True while doing kbd input. */
129 int waiting_for_input
;
131 /* True while displaying for echoing. Delays C-g throwing. */
134 /* Nonzero means disregard local maps for the menu bar. */
135 static int inhibit_local_menu_bar_menus
;
137 /* Nonzero means C-g should cause immediate error-signal. */
140 /* Character to recognize as the help char. */
141 Lisp_Object Vhelp_char
;
143 /* Form to execute when help char is typed. */
144 Lisp_Object Vhelp_form
;
146 /* Command to run when the help character follows a prefix key. */
147 Lisp_Object Vprefix_help_command
;
149 /* List of items that should move to the end of the menu bar. */
150 Lisp_Object Vmenu_bar_final_items
;
152 /* Character that causes a quit. Normally C-g.
154 If we are running on an ordinary terminal, this must be an ordinary
155 ASCII char, since we want to make it our interrupt character.
157 If we are not running on an ordinary terminal, it still needs to be
158 an ordinary ASCII char. This character needs to be recognized in
159 the input interrupt handler. At this point, the keystroke is
160 represented as a struct input_event, while the desired quit
161 character is specified as a lispy event. The mapping from struct
162 input_events to lispy events cannot run in an interrupt handler,
163 and the reverse mapping is difficult for anything but ASCII
166 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
170 extern Lisp_Object current_global_map
;
171 extern int minibuf_level
;
173 /* If non-nil, this is a map that overrides all other local maps. */
174 Lisp_Object Voverriding_local_map
;
176 /* If non-nil, Voverriding_local_map applies to the menu bar. */
177 Lisp_Object Voverriding_local_map_menu_flag
;
179 /* Current depth in recursive edits. */
180 int command_loop_level
;
182 /* Total number of times command_loop has read a key sequence. */
185 /* Last input character read as a command. */
186 Lisp_Object last_command_char
;
188 /* Last input character read as a command, not counting menus
189 reached by the mouse. */
190 Lisp_Object last_nonmenu_event
;
192 /* Last input character read for any purpose. */
193 Lisp_Object last_input_char
;
195 /* If not Qnil, a list of objects to be read as subsequent command input. */
196 Lisp_Object Vunread_command_events
;
198 /* If not -1, an event to be read as subsequent command input. */
199 int unread_command_char
;
201 /* If not Qnil, this is a switch-frame event which we decided to put
202 off until the end of a key sequence. This should be read as the
203 next command input, after any unread_command_events.
205 read_key_sequence uses this to delay switch-frame events until the
206 end of the key sequence; Fread_char uses it to put off switch-frame
207 events until a non-ASCII event is acceptable as input. */
208 Lisp_Object unread_switch_frame
;
210 /* A mask of extra modifier bits to put into every keyboard char. */
211 int extra_keyboard_modifiers
;
213 /* Char to use as prefix when a meta character is typed in.
214 This is bound on entry to minibuffer in case ESC is changed there. */
216 Lisp_Object meta_prefix_char
;
218 /* Last size recorded for a current buffer which is not a minibuffer. */
219 static int last_non_minibuf_size
;
221 /* Number of idle seconds before an auto-save and garbage collection. */
222 static Lisp_Object Vauto_save_timeout
;
224 /* Total number of times read_char has returned. */
227 /* Total number of times read_char has returned, outside of macros. */
228 int num_nonmacro_input_chars
;
230 /* Auto-save automatically when this many characters have been typed
231 since the last time. */
233 static int auto_save_interval
;
235 /* Value of num_nonmacro_input_chars as of last auto save. */
239 /* Last command executed by the editor command loop, not counting
240 commands that set the prefix argument. */
242 Lisp_Object last_command
;
244 /* The command being executed by the command loop.
245 Commands may set this, and the value set will be copied into last_command
246 instead of the actual command. */
247 Lisp_Object this_command
;
249 /* The value of point when the last command was executed. */
250 int last_point_position
;
252 /* The buffer that was current when the last command was started. */
253 Lisp_Object last_point_position_buffer
;
256 /* The frame in which the last input event occurred, or Qmacro if the
257 last event came from a macro. We use this to determine when to
258 generate switch-frame events. This may be cleared by functions
259 like Fselect_frame, to make sure that a switch-frame event is
260 generated by the next character. */
261 Lisp_Object internal_last_event_frame
;
264 /* A user-visible version of the above, intended to allow users to
265 figure out where the last event came from, if the event doesn't
266 carry that information itself (i.e. if it was a character). */
267 Lisp_Object Vlast_event_frame
;
269 /* The timestamp of the last input event we received from the X server.
270 X Windows wants this for selection ownership. */
271 unsigned long last_event_timestamp
;
273 Lisp_Object Qself_insert_command
;
274 Lisp_Object Qforward_char
;
275 Lisp_Object Qbackward_char
;
276 Lisp_Object Qundefined
;
278 /* read_key_sequence stores here the command definition of the
279 key sequence that it reads. */
280 Lisp_Object read_key_sequence_cmd
;
282 /* Form to evaluate (if non-nil) when Emacs is started. */
283 Lisp_Object Vtop_level
;
285 /* User-supplied string to translate input characters through. */
286 Lisp_Object Vkeyboard_translate_table
;
288 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
289 extern Lisp_Object Vfunction_key_map
;
291 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
292 Lisp_Object Vkey_translation_map
;
294 /* Non-nil means deactivate the mark at end of this command. */
295 Lisp_Object Vdeactivate_mark
;
297 /* Menu bar specified in Lucid Emacs fashion. */
299 Lisp_Object Vlucid_menu_bar_dirty_flag
;
300 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
302 /* Hooks to run before and after each command. */
303 Lisp_Object Qpre_command_hook
, Qpost_command_hook
;
304 Lisp_Object Vpre_command_hook
, Vpost_command_hook
;
305 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
307 /* List of deferred actions to be performed at a later time.
308 The precise format isn't relevant here; we just check whether it is nil. */
309 Lisp_Object Vdeferred_action_list
;
311 /* Function to call to handle deferred actions, when there are any. */
312 Lisp_Object Vdeferred_action_function
;
313 Lisp_Object Qdeferred_action_function
;
315 /* File in which we write all commands we read. */
318 /* Nonzero if input is available. */
321 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
322 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
326 extern char *pending_malloc_warning
;
328 /* Circular buffer for pre-read keyboard input. */
329 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
331 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
333 The interrupt-level event handlers will never enqueue an event on a
334 frame which is not in Vframe_list, and once an event is dequeued,
335 internal_last_event_frame or the event itself points to the frame.
338 But while the event is sitting in the queue, it's completely
339 unprotected. Suppose the user types one command which will run for
340 a while and then delete a frame, and then types another event at
341 the frame that will be deleted, before the command gets around to
342 it. Suppose there are no references to this frame elsewhere in
343 Emacs, and a GC occurs before the second event is dequeued. Now we
344 have an event referring to a freed frame, which will crash Emacs
347 Similar things happen when an event on a scroll bar is enqueued; the
348 window may be deleted while the event is in the queue.
350 So, we use this vector to protect the frame_or_window field in the
351 event queue. That way, they'll be dequeued as dead frames or
352 windows, but still valid lisp objects.
354 If kbd_buffer[i].kind != no_event, then
355 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
356 == kbd_buffer[i].frame_or_window. */
357 static Lisp_Object kbd_buffer_frame_or_window
;
359 /* Pointer to next available character in kbd_buffer.
360 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
361 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
362 next available char is in kbd_buffer[0]. */
363 static struct input_event
*kbd_fetch_ptr
;
365 /* Pointer to next place to store character in kbd_buffer. This
366 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
367 character should go in kbd_buffer[0]. */
368 static volatile struct input_event
*kbd_store_ptr
;
370 /* The above pair of variables forms a "queue empty" flag. When we
371 enqueue a non-hook event, we increment kbd_write_count. When we
372 dequeue a non-hook event, we increment kbd_read_count. We say that
373 there is input available iff the two counters are not equal.
375 Why not just have a flag set and cleared by the enqueuing and
376 dequeuing functions? Such a flag could be screwed up by interrupts
377 at inopportune times. */
380 /* If this flag is a frame, we check mouse_moved to see when the
381 mouse moves, and motion events will appear in the input stream.
382 Otherwise, mouse motion is ignored. */
383 static Lisp_Object do_mouse_tracking
;
385 /* The window system handling code should set this if the mouse has
386 moved since the last call to the mouse_position_hook. Calling that
387 hook should clear this. Code assumes that if this is set, it can
388 call mouse_position_hook to get the promised position, so don't set
389 it unless you're prepared to substantiate the claim! */
392 /* True iff there is an event in kbd_buffer, or if mouse tracking is
393 enabled and there is a new mouse position in the mouse movement
394 buffer. Note that if this is false, that doesn't mean that there
395 is readable input; all the events in the queue might be button-up
396 events, and do_mouse_tracking might be off. */
397 #define EVENT_QUEUES_EMPTY \
398 ((kbd_fetch_ptr == kbd_store_ptr) \
399 && (! FRAMEP (do_mouse_tracking) || !mouse_moved))
401 #else /* Not HAVE_MOUSE. */
402 #define EVENT_QUEUES_EMPTY (kbd_fetch_ptr == kbd_store_ptr)
403 #endif /* HAVE_MOUSE. */
405 /* Symbols to head events. */
406 Lisp_Object Qmouse_movement
;
407 Lisp_Object Qscroll_bar_movement
;
408 Lisp_Object Qswitch_frame
;
409 Lisp_Object Qdelete_frame
;
410 Lisp_Object Qiconify_frame
;
411 Lisp_Object Qmake_frame_visible
;
413 /* Symbols to denote kinds of events. */
414 Lisp_Object Qfunction_key
;
415 Lisp_Object Qmouse_click
;
416 /* Lisp_Object Qmouse_movement; - also an event header */
418 /* Properties of event headers. */
419 Lisp_Object Qevent_kind
;
420 Lisp_Object Qevent_symbol_elements
;
422 Lisp_Object Qmenu_enable
;
424 /* An event header symbol HEAD may have a property named
425 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
426 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
427 mask of modifiers applied to it. If present, this is used to help
428 speed up parse_modifiers. */
429 Lisp_Object Qevent_symbol_element_mask
;
431 /* An unmodified event header BASE may have a property named
432 Qmodifier_cache, which is an alist mapping modifier masks onto
433 modified versions of BASE. If present, this helps speed up
435 Lisp_Object Qmodifier_cache
;
437 /* Symbols to use for parts of windows. */
438 Lisp_Object Qmode_line
;
439 Lisp_Object Qvertical_line
;
440 Lisp_Object Qvertical_scroll_bar
;
441 Lisp_Object Qmenu_bar
;
443 extern Lisp_Object Qmenu_enable
;
445 Lisp_Object
recursive_edit_unwind (), command_loop ();
446 Lisp_Object
Fthis_command_keys ();
447 Lisp_Object Qextended_command_history
;
449 Lisp_Object Qpolling_period
;
451 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
453 EMACS_TIME
*input_available_clear_time
;
455 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
456 Default is 1 if INTERRUPT_INPUT is defined. */
459 /* Nonzero while interrupts are temporarily deferred during redisplay. */
460 int interrupts_deferred
;
462 /* nonzero means use ^S/^Q for flow control. */
465 /* Allow m- file to inhibit use of FIONREAD. */
466 #ifdef BROKEN_FIONREAD
470 /* We are unable to use interrupts if FIONREAD is not available,
471 so flush SIGIO so we won't try. */
478 /* If we support X Windows, turn on the code to poll periodically
479 to detect C-g. It isn't actually used when doing interrupt input. */
480 #ifdef HAVE_X_WINDOWS
481 #define POLL_FOR_INPUT
484 /* Global variable declarations. */
486 /* Function for init_keyboard to call with no args (if nonzero). */
487 void (*keyboard_init_hook
) ();
489 static int read_avail_input ();
490 static void get_input_pending ();
491 static int readable_events ();
492 static Lisp_Object
read_char_x_menu_prompt ();
493 static Lisp_Object
read_char_minibuf_menu_prompt ();
494 static Lisp_Object
make_lispy_event ();
495 static Lisp_Object
make_lispy_movement ();
496 static Lisp_Object
modify_event_symbol ();
497 static Lisp_Object
make_lispy_switch_frame ();
499 /* > 0 if we are to echo keystrokes. */
500 static int echo_keystrokes
;
502 /* Nonzero means echo each character as typed. */
503 static int immediate_echo
;
505 /* The text we're echoing in the modeline - partial key sequences,
506 usually. '\0'-terminated. This really shouldn't have a fixed size. */
507 static char echobuf
[300];
509 /* Where to append more text to echobuf if we want to. */
510 static char *echoptr
;
512 /* If we have echoed a prompt string specified by the user,
513 this is its length. Otherwise this is -1. */
514 static int echo_after_prompt
;
516 /* Nonzero means don't try to suspend even if the operating system seems
518 static int cannot_suspend
;
520 #define min(a,b) ((a)<(b)?(a):(b))
521 #define max(a,b) ((a)>(b)?(a):(b))
523 /* Install the string STR as the beginning of the string of echoing,
524 so that it serves as a prompt for the next character.
525 Also start echoing. */
530 int len
= strlen (str
);
532 if (len
> sizeof echobuf
- 4)
533 len
= sizeof echobuf
- 4;
534 bcopy (str
, echobuf
, len
);
535 echoptr
= echobuf
+ len
;
538 echo_after_prompt
= len
;
543 /* Add C to the echo string, if echoing is going on.
544 C can be a character, which is printed prettily ("M-C-x" and all that
545 jazz), or a symbol, whose name is printed. */
550 extern char *push_key_description ();
559 /* If someone has passed us a composite event, use its head symbol. */
564 if (ptr
- echobuf
> sizeof echobuf
- 6)
567 ptr
= push_key_description (XINT (c
), ptr
);
569 else if (SYMBOLP (c
))
571 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
572 if (((ptr
- echobuf
) + name
->size
+ 4) > sizeof echobuf
)
574 bcopy (name
->data
, ptr
, name
->size
);
578 if (echoptr
== echobuf
&& EQ (c
, Vhelp_char
))
580 strcpy (ptr
, " (Type ? for further options)");
591 /* Temporarily add a dash to the end of the echo string if it's not
592 empty, so that it serves as a mini-prompt for the very next character. */
596 if (!immediate_echo
&& echoptr
== echobuf
)
598 /* Do nothing if we just printed a prompt. */
599 if (echo_after_prompt
== echoptr
- echobuf
)
601 /* Do nothing if not echoing at all. */
605 /* Put a dash at the end of the buffer temporarily,
606 but make it go away when the next character is added. */
613 /* Display the current echo string, and begin echoing if not already
623 for (i
= 0; i
< this_command_key_count
; i
++)
626 c
= XVECTOR (this_command_keys
)->contents
[i
];
627 if (! (EVENT_HAS_PARAMETERS (c
)
628 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
638 if (waiting_for_input
&& !NILP (Vquit_flag
))
639 quit_throw_to_read_char ();
642 /* Turn off echoing, for the start of a new command. */
648 echo_after_prompt
= -1;
651 /* Return the length of the current echo string. */
656 return echoptr
- echobuf
;
659 /* Truncate the current echo message to its first LEN chars.
660 This and echo_char get used by read_key_sequence when the user
661 switches frames while entering a key sequence. */
668 echoptr
= echobuf
+ len
;
669 truncate_echo_area (len
);
673 /* Functions for manipulating this_command_keys. */
675 add_command_key (key
)
678 int size
= XVECTOR (this_command_keys
)->size
;
680 if (this_command_key_count
>= size
)
682 Lisp_Object new_keys
;
684 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
685 bcopy (XVECTOR (this_command_keys
)->contents
,
686 XVECTOR (new_keys
)->contents
,
687 size
* sizeof (Lisp_Object
));
689 this_command_keys
= new_keys
;
692 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
698 int count
= specpdl_ptr
- specpdl
;
701 if (command_loop_level
> 0)
703 specbind (Qstandard_output
, Qt
);
704 specbind (Qstandard_input
, Qt
);
707 val
= command_loop ();
709 Fsignal (Qquit
, Qnil
);
711 return unbind_to (count
, Qnil
);
714 /* When an auto-save happens, record the "time", and don't do again soon. */
718 last_auto_save
= num_nonmacro_input_chars
;
721 /* Make an auto save happen as soon as possible at command level. */
723 force_auto_save_soon ()
725 last_auto_save
= - auto_save_interval
- 1;
727 record_asynch_buffer_change ();
730 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
731 "Invoke the editor command loop recursively.\n\
732 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
733 that tells this function to return.\n\
734 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
735 This function is called by the editor initialization to begin editing.")
738 int count
= specpdl_ptr
- specpdl
;
741 command_loop_level
++;
742 update_mode_lines
= 1;
744 record_unwind_protect (recursive_edit_unwind
,
746 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
750 return unbind_to (count
, Qnil
);
754 recursive_edit_unwind (buffer
)
758 Fset_buffer (buffer
);
760 command_loop_level
--;
761 update_mode_lines
= 1;
769 Vstandard_output
= Qt
;
770 Vstandard_input
= Qt
;
771 Vexecuting_macro
= Qnil
;
772 cmd_error_internal (data
, 0);
776 Vinhibit_quit
= Qnil
;
778 return make_number (0);
781 cmd_error_internal (data
, context
)
785 Lisp_Object errmsg
, tail
, errname
, file_error
;
792 echo_area_glyphs
= 0;
794 /* If the window system or terminal frame hasn't been initialized
795 yet, or we're not interactive, it's best to dump this message out
796 to stderr and exit. */
797 if (! FRAME_MESSAGE_BUF (selected_frame
)
799 stream
= Qexternal_debugging_output
;
808 write_string_1 (context
, -1, stream
);
810 errname
= Fcar (data
);
812 if (EQ (errname
, Qerror
))
815 if (!CONSP (data
)) data
= Qnil
;
816 errmsg
= Fcar (data
);
821 errmsg
= Fget (errname
, Qerror_message
);
822 file_error
= Fmemq (Qfile_error
,
823 Fget (errname
, Qerror_conditions
));
826 /* Print an error message including the data items.
827 This is done by printing it into a scratch buffer
828 and then making a copy of the text in the buffer. */
830 if (!CONSP (data
)) data
= Qnil
;
834 /* For file-error, make error message by concatenating
835 all the data items. They are all strings. */
836 if (!NILP (file_error
) && !NILP (tail
))
837 errmsg
= XCONS (tail
)->car
, tail
= XCONS (tail
)->cdr
;
839 if (STRINGP (errmsg
))
840 Fprinc (errmsg
, stream
);
842 write_string_1 ("peculiar error", -1, stream
);
844 for (i
= 0; CONSP (tail
); tail
= Fcdr (tail
), i
++)
846 write_string_1 (i
? ", " : ": ", 2, stream
);
847 if (!NILP (file_error
))
848 Fprinc (Fcar (tail
), stream
);
850 Fprin1 (Fcar (tail
), stream
);
854 /* If the window system or terminal frame hasn't been initialized
855 yet, or we're in -batch mode, this error should cause Emacs to exit. */
856 if (! FRAME_MESSAGE_BUF (selected_frame
)
860 Fkill_emacs (make_number (-1));
864 Lisp_Object
command_loop_1 ();
865 Lisp_Object
command_loop_2 ();
866 Lisp_Object
top_level_1 ();
868 /* Entry to editor-command-loop.
869 This level has the catches for exiting/returning to editor command loop.
870 It returns nil to exit recursive edit, t to abort it. */
875 if (command_loop_level
> 0 || minibuf_level
> 0)
877 return internal_catch (Qexit
, command_loop_2
, Qnil
);
882 internal_catch (Qtop_level
, top_level_1
, Qnil
);
883 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
885 /* End of file in -batch run causes exit here. */
891 /* Here we catch errors in execution of commands within the
892 editing loop, and reenter the editing loop.
893 When there is an error, cmd_error runs and returns a non-nil
894 value to us. A value of nil means that cmd_loop_1 itself
895 returned due to end of file (or end of kbd macro). */
900 register Lisp_Object val
;
903 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
912 return Feval (Vtop_level
);
918 /* On entry to the outer level, run the startup file */
919 if (!NILP (Vtop_level
))
920 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
921 else if (!NILP (Vpurify_flag
))
922 message ("Bare impure Emacs (standard Lisp code not loaded)");
924 message ("Bare Emacs (standard Lisp code not loaded)");
928 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
929 "Exit all recursive editing levels.")
932 Fthrow (Qtop_level
, Qnil
);
935 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
936 "Exit from the innermost recursive edit or minibuffer.")
939 if (command_loop_level
> 0 || minibuf_level
> 0)
940 Fthrow (Qexit
, Qnil
);
942 error ("No recursive edit is in progress");
945 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
946 "Abort the command that requested this recursive edit or minibuffer input.")
949 if (command_loop_level
> 0 || minibuf_level
> 0)
952 error ("No recursive edit is in progress");
955 /* This is the actual command reading loop,
956 sans error-handling encapsulation. */
958 Lisp_Object
Fcommand_execute ();
959 static int read_key_sequence ();
960 static void safe_run_hooks ();
965 Lisp_Object cmd
, tem
;
968 Lisp_Object keybuf
[30];
973 struct buffer
*prev_buffer
;
976 Vdeactivate_mark
= Qnil
;
977 waiting_for_input
= 0;
982 this_command_key_count
= 0;
984 /* Make sure this hook runs after commands that get errors and
985 throw to top level. */
986 /* Note that the value cell will never directly contain nil
987 if the symbol is a local variable. */
988 if (!NILP (XSYMBOL (Qpost_command_hook
)->value
) && !NILP (Vrun_hooks
))
989 safe_run_hooks (Qpost_command_hook
);
991 if (!NILP (Vdeferred_action_list
))
992 call0 (Vdeferred_action_function
);
994 /* Do this after running Vpost_command_hook, for consistency. */
995 last_command
= this_command
;
999 /* Install chars successfully executed in kbd macro. */
1001 if (defining_kbd_macro
&& NILP (Vprefix_arg
))
1002 finalize_kbd_macro_chars ();
1004 /* Make sure the current window's buffer is selected. */
1005 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1006 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1008 /* Display any malloc warning that just came out. Use while because
1009 displaying one warning can cause another. */
1011 while (pending_malloc_warning
)
1012 display_malloc_warning ();
1016 Vdeactivate_mark
= Qnil
;
1018 /* If minibuffer on and echo area in use,
1019 wait 2 sec and redraw minibuffer. */
1021 if (minibuf_level
&& echo_area_glyphs
)
1023 /* Bind inhibit-quit to t so that C-g gets read in
1024 rather than quitting back to the minibuffer. */
1025 int count
= specpdl_ptr
- specpdl
;
1026 specbind (Qinhibit_quit
, Qt
);
1027 Fsit_for (make_number (2), Qnil
, Qnil
);
1028 unbind_to (count
, Qnil
);
1030 echo_area_glyphs
= 0;
1032 if (!NILP (Vquit_flag
))
1035 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1040 alloca (0); /* Cause a garbage collection now */
1041 /* Since we can free the most stuff here. */
1042 #endif /* C_ALLOCA */
1046 /* Select the frame that the last event came from. Usually,
1047 switch-frame events will take care of this, but if some lisp
1048 code swallows a switch-frame event, we'll fix things up here.
1049 Is this a good idea? */
1050 if (FRAMEP (internal_last_event_frame
)
1051 && XFRAME (internal_last_event_frame
) != selected_frame
)
1052 Fselect_frame (internal_last_event_frame
, Qnil
);
1055 /* If it has changed current-menubar from previous value,
1056 really recompute the menubar from the value. */
1057 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1058 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1059 call0 (Qrecompute_lucid_menubar
);
1061 /* Read next key sequence; i gets its length. */
1062 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), Qnil
);
1066 /* Now we have read a key sequence of length I,
1067 or else I is 0 and we found end of file. */
1069 if (i
== 0) /* End of file -- happens only in */
1070 return Qnil
; /* a kbd macro, at the end. */
1071 /* -1 means read_key_sequence got a menu that was rejected.
1072 Just loop around and read another command. */
1076 this_command_key_count
= 0;
1080 last_command_char
= keybuf
[i
- 1];
1082 /* If the previous command tried to force a specific window-start,
1083 forget about that, in case this command moves point far away
1084 from that position. */
1085 XWINDOW (selected_window
)->force_start
= Qnil
;
1087 cmd
= read_key_sequence_cmd
;
1088 if (!NILP (Vexecuting_macro
))
1090 if (!NILP (Vquit_flag
))
1092 Vexecuting_macro
= Qt
;
1093 QUIT
; /* Make some noise. */
1094 /* Will return since macro now empty. */
1098 /* Do redisplay processing after this command except in special
1099 cases identified below that set no_redisplay to 1.
1100 (actually, there's currently no way to prevent the redisplay,
1101 and no_redisplay is ignored.
1102 Perhaps someday we will really implement it. */
1105 prev_buffer
= current_buffer
;
1106 prev_modiff
= MODIFF
;
1107 last_point_position
= PT
;
1108 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1110 /* Execute the command. */
1113 /* Note that the value cell will never directly contain nil
1114 if the symbol is a local variable. */
1115 if (!NILP (XSYMBOL (Qpre_command_hook
)->value
) && !NILP (Vrun_hooks
))
1116 safe_run_hooks (Qpre_command_hook
);
1118 if (NILP (this_command
))
1120 /* nil means key is undefined. */
1122 defining_kbd_macro
= 0;
1123 update_mode_lines
= 1;
1129 if (NILP (Vprefix_arg
) && ! no_direct
)
1131 /* Recognize some common commands in common situations and
1132 do them directly. */
1133 if (EQ (this_command
, Qforward_char
) && PT
< ZV
)
1135 struct Lisp_Vector
*dp
1136 = window_display_table (XWINDOW (selected_window
));
1137 lose
= FETCH_CHAR (PT
);
1140 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1141 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1142 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1143 && (lose
>= 0x20 && lose
< 0x7f)))
1144 : (lose
>= 0x20 && lose
< 0x7f))
1145 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1147 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1149 && !windows_or_buffers_changed
1150 && EQ (current_buffer
->selective_display
, Qnil
)
1151 && !detect_input_pending ()
1152 && NILP (Vexecuting_macro
))
1153 no_redisplay
= direct_output_forward_char (1);
1156 else if (EQ (this_command
, Qbackward_char
) && PT
> BEGV
)
1158 struct Lisp_Vector
*dp
1159 = window_display_table (XWINDOW (selected_window
));
1161 lose
= FETCH_CHAR (PT
);
1163 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1164 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1165 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1166 && (lose
>= 0x20 && lose
< 0x7f)))
1167 : (lose
>= 0x20 && lose
< 0x7f))
1168 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1170 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1172 && !windows_or_buffers_changed
1173 && EQ (current_buffer
->selective_display
, Qnil
)
1174 && !detect_input_pending ()
1175 && NILP (Vexecuting_macro
))
1176 no_redisplay
= direct_output_forward_char (-1);
1179 else if (EQ (this_command
, Qself_insert_command
)
1180 /* Try this optimization only on ascii keystrokes. */
1181 && INTEGERP (last_command_char
))
1183 unsigned char c
= XINT (last_command_char
);
1186 if (NILP (Vexecuting_macro
)
1187 && !EQ (minibuf_window
, selected_window
))
1189 if (!nonundocount
|| nonundocount
>= 20)
1196 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1198 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1200 || MODIFF
<= SAVE_MODIFF
1201 || windows_or_buffers_changed
1202 || !EQ (current_buffer
->selective_display
, Qnil
)
1203 || detect_input_pending ()
1204 || !NILP (Vexecuting_macro
));
1205 value
= internal_self_insert (c
, 0);
1212 && (PT
== ZV
|| FETCH_CHAR (PT
) == '\n'))
1214 struct Lisp_Vector
*dp
1215 = window_display_table (XWINDOW (selected_window
));
1222 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1225 /* Do it only for char codes
1226 that by default display as themselves. */
1227 if (lose
>= 0x20 && lose
<= 0x7e)
1228 no_redisplay
= direct_output_for_insert (lose
);
1230 else if (VECTORP (obj
)
1231 && XVECTOR (obj
)->size
== 1
1232 && (obj
= XVECTOR (obj
)->contents
[0],
1234 /* Insist face not specified in glyph. */
1235 && (XINT (obj
) & ((-1) << 8)) == 0)
1237 = direct_output_for_insert (XINT (obj
));
1241 if (lose
>= 0x20 && lose
<= 0x7e)
1242 no_redisplay
= direct_output_for_insert (lose
);
1249 /* Here for a command that isn't executed directly */
1252 if (NILP (Vprefix_arg
))
1254 Fcommand_execute (this_command
, Qnil
);
1259 /* Note that the value cell will never directly contain nil
1260 if the symbol is a local variable. */
1261 if (!NILP (XSYMBOL (Qpost_command_hook
)->value
) && !NILP (Vrun_hooks
))
1262 safe_run_hooks (Qpost_command_hook
);
1264 if (!NILP (Vdeferred_action_list
))
1265 safe_run_hooks (Qdeferred_action_function
);
1267 /* If there is a prefix argument,
1268 1) We don't want last_command to be ``universal-argument''
1269 (that would be dumb), so don't set last_command,
1270 2) we want to leave echoing on so that the prefix will be
1271 echoed as part of this key sequence, so don't call
1273 3) we want to leave this_command_key_count non-zero, so that
1274 read_char will realize that it is re-reading a character, and
1275 not echo it a second time. */
1276 if (NILP (Vprefix_arg
))
1278 last_command
= this_command
;
1280 this_command_key_count
= 0;
1283 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1285 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1287 current_buffer
->mark_active
= Qnil
;
1288 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1290 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1291 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1296 /* If we get an error while running the hook, cause the hook variable
1297 to be nil. Also inhibit quits, so that C-g won't cause the hook
1298 to mysteriously evaporate. */
1300 safe_run_hooks (hook
)
1304 int count
= specpdl_ptr
- specpdl
;
1305 specbind (Qinhibit_quit
, Qt
);
1307 /* We read and set the variable with functions,
1308 in case it's buffer-local. */
1309 value
= Vcommand_hook_internal
= Fsymbol_value (hook
);
1311 call1 (Vrun_hooks
, Qcommand_hook_internal
);
1314 unbind_to (count
, Qnil
);
1317 /* Number of seconds between polling for input. */
1320 /* Nonzero means polling for input is temporarily suppressed. */
1321 int poll_suppress_count
;
1323 /* Nonzero if polling_for_input is actually being used. */
1324 int polling_for_input
;
1326 #ifdef POLL_FOR_INPUT
1328 /* Handle an alarm once each second and read pending input
1329 so as to handle a C-g if it comces in. */
1332 input_poll_signal ()
1334 if (interrupt_input_blocked
== 0
1335 && !waiting_for_input
)
1336 read_avail_input (0);
1337 signal (SIGALRM
, input_poll_signal
);
1338 alarm (polling_period
);
1343 /* Begin signals to poll for input, if they are appropriate.
1344 This function is called unconditionally from various places. */
1348 #ifdef POLL_FOR_INPUT
1349 if (read_socket_hook
&& !interrupt_input
)
1351 poll_suppress_count
--;
1352 if (poll_suppress_count
== 0)
1354 signal (SIGALRM
, input_poll_signal
);
1355 polling_for_input
= 1;
1356 alarm (polling_period
);
1362 /* Nonzero if we are using polling to handle input asynchronously. */
1365 input_polling_used ()
1367 #ifdef POLL_FOR_INPUT
1368 return read_socket_hook
&& !interrupt_input
;
1374 /* Turn off polling. */
1378 #ifdef POLL_FOR_INPUT
1379 if (read_socket_hook
&& !interrupt_input
)
1381 if (poll_suppress_count
== 0)
1383 polling_for_input
= 0;
1386 poll_suppress_count
++;
1391 /* Set the value of poll_suppress_count to COUNT
1392 and start or stop polling accordingly. */
1395 set_poll_suppress_count (count
)
1398 #ifdef POLL_FOR_INPUT
1399 if (count
== 0 && poll_suppress_count
!= 0)
1401 poll_suppress_count
= 1;
1404 else if (count
!= 0 && poll_suppress_count
== 0)
1408 poll_suppress_count
= count
;
1412 /* Bind polling_period to a value at least N.
1413 But don't decrease it. */
1415 bind_polling_period (n
)
1418 #ifdef POLL_FOR_INPUT
1419 int new = polling_period
;
1425 specbind (Qpolling_period
, make_number (new));
1426 /* Start a new alarm with the new period. */
1431 /* Applying the control modifier to CHARACTER. */
1436 /* Save the upper bits here. */
1437 int upper
= c
& ~0177;
1441 /* Everything in the columns containing the upper-case letters
1442 denotes a control character. */
1443 if (c
>= 0100 && c
< 0140)
1447 /* Set the shift modifier for a control char
1448 made from a shifted letter. But only for letters! */
1449 if (oc
>= 'A' && oc
<= 'Z')
1450 c
|= shift_modifier
;
1453 /* The lower-case letters denote control characters too. */
1454 else if (c
>= 'a' && c
<= 'z')
1457 /* Include the bits for control and shift
1458 only if the basic ASCII code can't indicate them. */
1462 /* Replace the high bits. */
1463 c
|= (upper
& ~ctrl_modifier
);
1470 /* Input of single characters from keyboard */
1472 Lisp_Object
print_help ();
1473 static Lisp_Object
kbd_buffer_get_event ();
1474 static void record_char ();
1476 /* read a character from the keyboard; call the redisplay if needed */
1477 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1478 -1 means do not do redisplay, but do do autosaving.
1481 /* The arguments MAPS and NMAPS are for menu prompting.
1482 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1484 PREV_EVENT is the previous input event, or nil if we are reading
1485 the first event of a key sequence.
1487 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1488 if we used a mouse menu to read the input, or zero otherwise. If
1489 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
1491 Value is t if we showed a menu and the user rejected it. */
1494 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1498 Lisp_Object prev_event
;
1499 int *used_mouse_menu
;
1501 register Lisp_Object c
;
1504 int key_already_recorded
= 0;
1505 Lisp_Object also_record
;
1508 if (CONSP (Vunread_command_events
))
1510 c
= XCONS (Vunread_command_events
)->car
;
1511 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1513 if (this_command_key_count
== 0)
1519 if (unread_command_char
!= -1)
1521 XSETINT (c
, unread_command_char
);
1522 unread_command_char
= -1;
1524 if (this_command_key_count
== 0)
1530 if (!NILP (Vexecuting_macro
))
1533 /* We set this to Qmacro; since that's not a frame, nobody will
1534 try to switch frames on us, and the selected window will
1537 Since this event came from a macro, it would be misleading to
1538 leave internal_last_event_frame set to wherever the last
1539 real event came from. Normally, a switch-frame event selects
1540 internal_last_event_frame after each command is read, but
1541 events read from a macro should never cause a new frame to be
1543 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1546 /* Exit the macro if we are at the end.
1547 Also, some things replace the macro with t
1548 to force an early exit. */
1549 if (EQ (Vexecuting_macro
, Qt
)
1550 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1556 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1557 if (STRINGP (Vexecuting_macro
)
1558 && (XINT (c
) & 0x80))
1559 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
1561 executing_macro_index
++;
1566 if (!NILP (unread_switch_frame
))
1568 c
= unread_switch_frame
;
1569 unread_switch_frame
= Qnil
;
1571 /* This event should make it into this_command_keys, and get echoed
1572 again, so we go to reread_first, rather than reread. */
1576 /* Don't bother updating menu bars while doing mouse tracking.
1577 We get events very rapidly then, and the menu bar won't be changing.
1578 We do update the menu bar once on entry to Ftrack_mouse. */
1579 if (commandflag
> 0 && !input_pending
&& !detect_input_pending ())
1580 prepare_menu_bars ();
1582 /* Save outer setjmp data, in case called recursively. */
1583 save_getcjmp (save_jump
);
1587 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1590 if (_setjmp (getcjmp
))
1592 XSETINT (c
, quit_char
);
1594 XSETFRAME (internal_last_event_frame
, selected_frame
);
1595 Vlast_event_frame
= internal_last_event_frame
;
1597 /* If we report the quit char as an event,
1598 don't do so more than once. */
1599 if (!NILP (Vinhibit_quit
))
1605 /* Message turns off echoing unless more keystrokes turn it on again. */
1606 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1609 /* If already echoing, continue. */
1612 /* Try reading a character via menu prompting in the minibuf.
1613 Try this before the sit-for, because the sit-for
1614 would do the wrong thing if we are supposed to do
1615 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1616 after a mouse event so don't try a minibuf menu. */
1618 if (nmaps
> 0 && INTERACTIVE
1619 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1620 /* Don't bring up a menu if we already have another event. */
1621 && NILP (Vunread_command_events
)
1622 && unread_command_char
< 0
1623 && !detect_input_pending ())
1625 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1628 key_already_recorded
= 1;
1633 /* If in middle of key sequence and minibuffer not active,
1634 start echoing if enough time elapses. */
1635 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1637 && echo_keystrokes
> 0
1638 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1642 /* After a mouse event, start echoing right away.
1643 This is because we are probably about to display a menu,
1644 and we don't want to delay before doing so. */
1645 if (EVENT_HAS_PARAMETERS (prev_event
))
1649 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1655 /* Maybe auto save due to number of keystrokes or idle time. */
1657 if (commandflag
!= 0
1658 && auto_save_interval
> 0
1659 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1660 && !detect_input_pending ())
1663 save_getcjmp (temp
);
1664 Fdo_auto_save (Qnil
, Qnil
);
1665 /* Hooks can actually change some buffers in auto save. */
1667 restore_getcjmp (temp
);
1670 /* Try reading using an X menu.
1671 This is never confused with reading using the minibuf
1672 because the recursive call of read_char in read_char_minibuf_menu_prompt
1673 does not pass on any keymaps. */
1674 if (nmaps
> 0 && INTERACTIVE
1675 && !NILP (prev_event
) && EVENT_HAS_PARAMETERS (prev_event
)
1676 /* Don't bring up a menu if we already have another event. */
1677 && NILP (Vunread_command_events
)
1678 && unread_command_char
< 0)
1679 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1681 /* Slow down auto saves logarithmically in size of current buffer,
1682 and garbage collect while we're at it. */
1683 if (INTERACTIVE
&& NILP (c
))
1685 int delay_level
, buffer_size
;
1687 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1688 last_non_minibuf_size
= Z
- BEG
;
1689 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1691 while (buffer_size
> 64)
1692 delay_level
++, buffer_size
-= buffer_size
>> 2;
1693 if (delay_level
< 4) delay_level
= 4;
1694 /* delay_level is 4 for files under around 50k, 7 at 100k,
1695 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1697 /* Auto save if enough time goes by without input. */
1698 if (commandflag
!= 0
1699 && num_nonmacro_input_chars
> last_auto_save
1700 && INTEGERP (Vauto_save_timeout
)
1701 && XINT (Vauto_save_timeout
) > 0)
1704 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1705 tem0
= sit_for (delay
, 0, 1, 1);
1709 save_getcjmp (temp
);
1710 Fdo_auto_save (Qnil
, Qnil
);
1711 restore_getcjmp (temp
);
1713 /* If we have auto-saved and there is still no input
1714 available, garbage collect if there has been enough
1715 consing going on to make it worthwhile. */
1716 if (!detect_input_pending ()
1717 && consing_since_gc
> gc_cons_threshold
/ 2)
1718 Fgarbage_collect ();
1719 /* prepare_menu_bars isn't safe here, but it should
1720 also be unnecessary. */
1726 /* Actually read a character, waiting if necessary. */
1729 c
= kbd_buffer_get_event ();
1732 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1734 prepare_menu_bars ();
1739 /* Terminate Emacs in batch mode if at eof. */
1740 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
1741 Fkill_emacs (make_number (1));
1745 /* Add in any extra modifiers, where appropriate. */
1746 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1747 || ((extra_keyboard_modifiers
& 0177) < ' '
1748 && (extra_keyboard_modifiers
& 0177) != 0))
1749 XSETINT (c
, make_ctrl_char (XINT (c
)));
1751 /* Transfer any other modifier bits directly from
1752 extra_keyboard_modifiers to c. Ignore the actual character code
1753 in the low 16 bits of extra_keyboard_modifiers. */
1754 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
1759 restore_getcjmp (save_jump
);
1763 /* Buffer switch events are only for internal wakeups
1764 so don't show them to the user. */
1768 if (key_already_recorded
)
1771 /* Wipe the echo area. */
1772 echo_area_glyphs
= 0;
1774 /* Handle things that only apply to characters. */
1777 /* If kbd_buffer_get_event gave us an EOF, return that. */
1781 if (STRINGP (Vkeyboard_translate_table
)
1782 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1783 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1786 /* If this event is a mouse click in the menu bar,
1787 return just menu-bar for now. Modify the mouse click event
1788 so we won't do this twice, then queue it up. */
1789 if (EVENT_HAS_PARAMETERS (c
)
1790 && CONSP (XCONS (c
)->cdr
)
1791 && CONSP (EVENT_START (c
))
1792 && CONSP (XCONS (EVENT_START (c
))->cdr
))
1796 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
1797 /* Handle menu-bar events:
1798 insert the dummy prefix event `menu-bar'. */
1799 if (EQ (posn
, Qmenu_bar
))
1801 /* Change menu-bar to (menu-bar) as the event "position". */
1802 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
1805 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
1811 if (! NILP (also_record
))
1812 record_char (also_record
);
1817 /* Don't echo mouse motion events. */
1819 && ! (EVENT_HAS_PARAMETERS (c
)
1820 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1823 if (! NILP (also_record
))
1824 echo_char (also_record
);
1827 /* Record this character as part of the current key. */
1828 add_command_key (c
);
1829 if (! NILP (also_record
))
1830 add_command_key (also_record
);
1832 /* Re-reading in the middle of a command */
1834 last_input_char
= c
;
1837 /* Process the help character specially if enabled */
1838 if (EQ (c
, Vhelp_char
) && !NILP (Vhelp_form
))
1841 count
= specpdl_ptr
- specpdl
;
1843 record_unwind_protect (Fset_window_configuration
,
1844 Fcurrent_window_configuration (Qnil
));
1846 tem0
= Feval (Vhelp_form
);
1848 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1852 c
= read_char (0, 0, 0, Qnil
, 0);
1853 while (BUFFERP (c
));
1854 /* Remove the help from the frame */
1855 unbind_to (count
, Qnil
);
1856 prepare_menu_bars ();
1858 if (EQ (c
, make_number (040)))
1862 c
= read_char (0, 0, 0, Qnil
, 0);
1863 while (BUFFERP (c
));
1870 /* Record the input event C in various ways. */
1877 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1878 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1879 recent_keys_index
= 0;
1881 /* Write c to the dribble file. If c is a lispy event, write
1882 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1883 If you, dear reader, have a better idea, you've got the source. :-) */
1888 if (XUINT (c
) < 0x100)
1889 putc (XINT (c
), dribble
);
1891 fprintf (dribble
, " 0x%x", XUINT (c
));
1895 Lisp_Object dribblee
;
1897 /* If it's a structured event, take the event header. */
1898 dribblee
= EVENT_HEAD (c
);
1900 if (SYMBOLP (dribblee
))
1902 putc ('<', dribble
);
1903 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1904 XSYMBOL (dribblee
)->name
->size
,
1906 putc ('>', dribble
);
1913 store_kbd_macro_char (c
);
1915 num_nonmacro_input_chars
++;
1922 struct buffer
*old
= current_buffer
;
1923 Fprinc (object
, Qnil
);
1924 set_buffer_internal (XBUFFER (Vstandard_output
));
1925 call0 (intern ("help-mode"));
1926 set_buffer_internal (old
);
1930 /* Copy out or in the info on where C-g should throw to.
1931 This is used when running Lisp code from within get_char,
1932 in case get_char is called recursively.
1933 See read_process_output. */
1938 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1941 restore_getcjmp (temp
)
1944 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1950 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1951 of this function. */
1954 tracking_off (old_value
)
1955 Lisp_Object old_value
;
1957 do_mouse_tracking
= old_value
;
1958 if (NILP (old_value
))
1960 /* Redisplay may have been preempted because there was input
1961 available, and it assumes it will be called again after the
1962 input has been processed. If the only input available was
1963 the sort that we have just disabled, then we need to call
1965 if (!readable_events ())
1967 prepare_menu_bars ();
1968 redisplay_preserve_echo_area ();
1969 get_input_pending (&input_pending
);
1974 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1975 "Evaluate BODY with mouse movement events enabled.\n\
1976 Within a `track-mouse' form, mouse motion generates input events that\n\
1977 you can read with `read-event'.\n\
1978 Normally, mouse motion is ignored.")
1982 int count
= specpdl_ptr
- specpdl
;
1985 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1987 if (!input_pending
&& !detect_input_pending ())
1988 prepare_menu_bars ();
1990 XSETFRAME (do_mouse_tracking
, selected_frame
);
1992 val
= Fprogn (args
);
1993 return unbind_to (count
, val
);
1996 #endif /* HAVE_MOUSE */
1998 /* Low level keyboard/mouse input.
1999 kbd_buffer_store_event places events in kbd_buffer, and
2000 kbd_buffer_get_event retrieves them.
2001 mouse_moved indicates when the mouse has moved again, and
2002 *mouse_position_hook provides the mouse position. */
2004 /* Return true iff there are any events in the queue that read-char
2005 would return. If this returns false, a read-char would block. */
2009 return ! EVENT_QUEUES_EMPTY
;
2012 /* Set this for debugging, to have a way to get out */
2015 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
2018 kbd_buffer_store_event (event
)
2019 register struct input_event
*event
;
2021 if (event
->kind
== no_event
)
2024 if (event
->kind
== ascii_keystroke
)
2026 register int c
= event
->code
& 0377;
2028 if (event
->modifiers
& ctrl_modifier
)
2029 c
= make_ctrl_char (c
);
2031 c
|= (event
->modifiers
2032 & (meta_modifier
| alt_modifier
2033 | hyper_modifier
| super_modifier
));
2037 extern SIGTYPE
interrupt_signal ();
2040 /* If this results in a quit_char being returned to Emacs as
2041 input, set Vlast_event_frame properly. If this doesn't
2042 get returned to Emacs as an event, the next event read
2043 will set Vlast_event_frame again, so this is safe to do. */
2047 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
2049 internal_last_event_frame
= event
->frame_or_window
;
2051 internal_last_event_frame
= focus
;
2052 Vlast_event_frame
= internal_last_event_frame
;
2056 last_event_timestamp
= event
->timestamp
;
2057 interrupt_signal ();
2061 if (c
&& c
== stop_character
)
2068 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
2069 kbd_store_ptr
= kbd_buffer
;
2071 /* Don't let the very last slot in the buffer become full,
2072 since that would make the two pointers equal,
2073 and that is indistinguishable from an empty buffer.
2074 Discard the event if it would fill the last slot. */
2075 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
2077 kbd_store_ptr
->kind
= event
->kind
;
2078 if (event
->kind
== selection_request_event
)
2080 /* We must not use the ordinary copying code for this case,
2081 since `part' is an enum and copying it might not copy enough
2083 bcopy (event
, kbd_store_ptr
, sizeof (*event
));
2087 kbd_store_ptr
->code
= event
->code
;
2088 kbd_store_ptr
->part
= event
->part
;
2089 kbd_store_ptr
->frame_or_window
= event
->frame_or_window
;
2090 kbd_store_ptr
->modifiers
= event
->modifiers
;
2091 kbd_store_ptr
->x
= event
->x
;
2092 kbd_store_ptr
->y
= event
->y
;
2093 kbd_store_ptr
->timestamp
= event
->timestamp
;
2095 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
2097 = event
->frame_or_window
);
2103 /* Read one event from the event buffer, waiting if necessary.
2104 The value is a Lisp object representing the event.
2105 The value is nil for an event that should be ignored,
2106 or that was handled here.
2107 We always read and discard one event. */
2110 kbd_buffer_get_event ()
2122 /* Wait until there is input available. */
2125 if (!EVENT_QUEUES_EMPTY
)
2128 /* If the quit flag is set, then read_char will return
2129 quit_char, so that counts as "available input." */
2130 if (!NILP (Vquit_flag
))
2131 quit_throw_to_read_char ();
2133 /* One way or another, wait until input is available; then, if
2134 interrupt handlers have not read it, read it now. */
2137 wait_for_kbd_input ();
2139 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2143 if (EVENT_QUEUES_EMPTY
)
2145 Lisp_Object minus_one
;
2147 XSETINT (minus_one
, -1);
2148 wait_reading_process_input (0, 0, minus_one
, 1);
2150 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
2151 /* Pass 1 for EXPECT since we just waited to have input. */
2152 read_avail_input (1);
2154 #endif /* not VMS */
2157 /* At this point, we know that there is a readable event available
2158 somewhere. If the event queue is empty, then there must be a
2159 mouse movement enabled and available. */
2160 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2162 struct input_event
*event
;
2164 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2168 last_event_timestamp
= event
->timestamp
;
2172 /* These two kinds of events get special handling
2173 and don't actually appear to the command loop.
2174 We return nil for them. */
2175 if (event
->kind
== selection_request_event
)
2178 x_handle_selection_request (event
);
2179 kbd_fetch_ptr
= event
+ 1;
2181 /* We're getting selection request events, but we don't have
2187 else if (event
->kind
== selection_clear_event
)
2190 x_handle_selection_clear (event
);
2191 kbd_fetch_ptr
= event
+ 1;
2193 /* We're getting selection request events, but we don't have
2199 else if (event
->kind
== delete_window_event
)
2201 /* Make an event (delete-frame (FRAME)). */
2202 obj
= Fcons (event
->frame_or_window
, Qnil
);
2203 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
2204 kbd_fetch_ptr
= event
+ 1;
2206 else if (event
->kind
== iconify_event
)
2208 /* Make an event (iconify-frame (FRAME)). */
2209 obj
= Fcons (event
->frame_or_window
, Qnil
);
2210 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
2211 kbd_fetch_ptr
= event
+ 1;
2213 else if (event
->kind
== deiconify_event
)
2215 /* Make an event (make-frame-visible (FRAME)). */
2216 obj
= Fcons (event
->frame_or_window
, Qnil
);
2217 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
2218 kbd_fetch_ptr
= event
+ 1;
2221 else if (event
->kind
== menu_bar_event
)
2223 /* The event value is in the frame_or_window slot. */
2224 obj
= event
->frame_or_window
;
2225 kbd_fetch_ptr
= event
+ 1;
2227 else if (event
->kind
== buffer_switch_event
)
2229 /* The value doesn't matter here; only the type is tested. */
2230 XSETBUFFER (obj
, current_buffer
);
2231 kbd_fetch_ptr
= event
+ 1;
2233 /* Just discard these, by returning nil.
2234 (They shouldn't be found in the buffer,
2235 but on some machines it appears they do show up.) */
2236 else if (event
->kind
== no_event
)
2237 kbd_fetch_ptr
= event
+ 1;
2239 /* If this event is on a different frame, return a switch-frame this
2240 time, and leave the event in the queue for next time. */
2247 frame
= event
->frame_or_window
;
2248 if (WINDOWP (frame
))
2249 frame
= WINDOW_FRAME (XWINDOW (frame
));
2251 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2255 if (! EQ (frame
, internal_last_event_frame
)
2256 && XFRAME (frame
) != selected_frame
)
2257 obj
= make_lispy_switch_frame (frame
);
2258 internal_last_event_frame
= frame
;
2259 #endif /* MULTI_FRAME */
2261 /* If we didn't decide to make a switch-frame event, go ahead
2262 and build a real event from the queue entry. */
2266 obj
= make_lispy_event (event
);
2268 /* Wipe out this event, to catch bugs. */
2269 event
->kind
= no_event
;
2270 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
2273 kbd_fetch_ptr
= event
+ 1;
2278 /* Try generating a mouse motion event. */
2279 else if (FRAMEP (do_mouse_tracking
) && mouse_moved
)
2281 FRAME_PTR f
= XFRAME (do_mouse_tracking
);
2282 Lisp_Object bar_window
;
2283 enum scroll_bar_part part
;
2287 /* Note that this uses F to determine which display to look at.
2288 If there is no valid info, it does not store anything
2289 so x remains nil. */
2291 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
2296 /* Decide if we should generate a switch-frame event. Don't
2297 generate switch-frame events for motion outside of all Emacs
2303 frame
= FRAME_FOCUS_FRAME (f
);
2305 XSETFRAME (frame
, f
);
2307 if (! EQ (frame
, internal_last_event_frame
)
2308 && XFRAME (frame
) != selected_frame
)
2309 obj
= make_lispy_switch_frame (frame
);
2310 internal_last_event_frame
= frame
;
2314 /* If we didn't decide to make a switch-frame event, go ahead and
2315 return a mouse-motion event. */
2316 if (!NILP (x
) && NILP (obj
))
2317 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2319 #endif /* HAVE_MOUSE */
2321 /* We were promised by the above while loop that there was
2322 something for us to read! */
2325 input_pending
= readable_events ();
2328 Vlast_event_frame
= internal_last_event_frame
;
2334 /* Process any events that are not user-visible,
2335 then return, without reading any user-visible events. */
2340 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2342 struct input_event
*event
;
2344 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2348 last_event_timestamp
= event
->timestamp
;
2350 /* These two kinds of events get special handling
2351 and don't actually appear to the command loop. */
2352 if (event
->kind
== selection_request_event
)
2355 x_handle_selection_request (event
);
2356 kbd_fetch_ptr
= event
+ 1;
2358 /* We're getting selection request events, but we don't have
2364 else if (event
->kind
== selection_clear_event
)
2367 x_handle_selection_clear (event
);
2368 kbd_fetch_ptr
= event
+ 1;
2370 /* We're getting selection request events, but we don't have
2379 get_input_pending (&input_pending
);
2382 /* Caches for modify_event_symbol. */
2383 static Lisp_Object accent_key_syms
;
2384 static Lisp_Object system_key_syms
;
2385 static Lisp_Object func_key_syms
;
2386 static Lisp_Object mouse_syms
;
2388 Lisp_Object Vsystem_key_alist
;
2390 /* This is a list of keysym codes for special "accent" characters.
2391 It parallels lispy_accent_keys. */
2393 static int lispy_accent_codes
[] =
2395 #ifdef XK_dead_circumflex
2400 #ifdef XK_dead_grave
2405 #ifdef XK_dead_tilde
2410 #ifdef XK_dead_diaeresis
2415 #ifdef XK_dead_macron
2420 #ifdef XK_dead_degree
2425 #ifdef XK_dead_acute
2430 #ifdef XK_dead_cedilla
2435 #ifdef XK_dead_breve
2440 #ifdef XK_dead_ogonek
2445 #ifdef XK_dead_caron
2450 #ifdef XK_dead_doubleacute
2451 XK_dead_doubleacute
,
2455 #ifdef XK_dead_abovedot
2462 /* This is a list of Lisp names for special "accent" characters.
2463 It parallels lispy_accent_codes. */
2465 static char *lispy_accent_keys
[] =
2482 /* You'll notice that this table is arranged to be conveniently
2483 indexed by X Windows keysym values. */
2484 static char *lispy_function_keys
[] =
2486 /* X Keysym value */
2488 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2496 0, 0, 0, /* 0xff10 */
2498 0, 0, 0, 0, 0, 0, 0,
2501 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2502 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2503 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2505 "home", /* 0xff50 */ /* IsCursorKey */
2516 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2527 "break", /* 0xff6b */
2529 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
2531 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2532 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2533 0, 0, 0, 0, 0, 0, 0, 0,
2534 "kp-tab", /* 0xff89 */
2536 "kp-enter", /* 0xff8d */
2538 "kp-f1", /* 0xff91 */
2542 "kp-home", /* 0xff95 */
2547 "kp-prior", /* kp-page-up */
2548 "kp-next", /* kp-page-down */
2554 0, 0, 0, 0, 0, 0, 0, 0, 0,
2555 "kp-multiply", /* 0xffaa */
2560 "kp-divide", /* 0xffaf */
2561 "kp-0", /* 0xffb0 */
2562 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2565 "kp-equal", /* 0xffbd */
2566 "f1", /* 0xffbe */ /* IsFunctionKey */
2568 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2569 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2570 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2571 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2572 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2573 0, 0, 0, 0, 0, 0, 0, 0,
2574 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2575 0, 0, 0, 0, 0, 0, 0, "delete"
2578 static char *lispy_mouse_names
[] =
2580 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2583 /* Scroll bar parts. */
2584 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2586 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2587 Lisp_Object
*scroll_bar_parts
[] = {
2588 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2592 /* A vector, indexed by button number, giving the down-going location
2593 of currently depressed buttons, both scroll bar and non-scroll bar.
2595 The elements have the form
2596 (BUTTON-NUMBER MODIFIER-MASK . REST)
2597 where REST is the cdr of a position as it would be reported in the event.
2599 The make_lispy_event function stores positions here to tell the
2600 difference between click and drag events, and to store the starting
2601 location to be included in drag events. */
2603 static Lisp_Object button_down_location
;
2605 /* Information about the most recent up-going button event: Which
2606 button, what location, and what time. */
2608 static int last_mouse_button
;
2609 static int last_mouse_x
;
2610 static int last_mouse_y
;
2611 static unsigned long button_down_time
;
2613 /* The maximum time between clicks to make a double-click,
2614 or Qnil to disable double-click detection,
2615 or Qt for no time limit. */
2616 Lisp_Object Vdouble_click_time
;
2618 /* The number of clicks in this multiple-click. */
2620 int double_click_count
;
2622 #ifdef USE_X_TOOLKIT
2623 extern Lisp_Object
map_event_to_object ();
2624 #endif /* USE_X_TOOLKIT */
2626 /* Given a struct input_event, build the lisp event which represents
2627 it. If EVENT is 0, build a mouse movement event from the mouse
2628 movement buffer, which should have a movement event in it.
2630 Note that events must be passed to this function in the order they
2631 are received; this function stores the location of button presses
2632 in order to build drag events when the button is released. */
2635 make_lispy_event (event
)
2636 struct input_event
*event
;
2640 #ifdef SWITCH_ENUM_BUG
2641 switch ((int) event
->kind
)
2643 switch (event
->kind
)
2646 /* A simple keystroke. */
2647 case ascii_keystroke
:
2649 Lisp_Object lispy_c
;
2650 int c
= event
->code
& 0377;
2651 /* Turn ASCII characters into control characters
2653 if (event
->modifiers
& ctrl_modifier
)
2654 c
= make_ctrl_char (c
);
2656 /* Add in the other modifier bits. We took care of ctrl_modifier
2657 just above, and the shift key was taken care of by the X code,
2658 and applied to control characters by make_ctrl_char. */
2659 c
|= (event
->modifiers
2660 & (meta_modifier
| alt_modifier
2661 | hyper_modifier
| super_modifier
));
2662 button_down_time
= 0;
2663 XSETFASTINT (lispy_c
, c
);
2667 /* A function key. The symbol may need to have modifier prefixes
2669 case non_ascii_keystroke
:
2670 button_down_time
= 0;
2672 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
2673 if (event
->code
== lispy_accent_codes
[i
])
2674 return modify_event_symbol (i
,
2676 Qfunction_key
, Qnil
,
2677 lispy_accent_keys
, &accent_key_syms
,
2678 (sizeof (lispy_accent_keys
)
2679 / sizeof (lispy_accent_keys
[0])));
2681 /* Handle system-specific keysyms. */
2682 if (event
->code
& (1 << 28))
2684 /* We need to use an alist rather than a vector as the cache
2685 since we can't make a vector long enuf. */
2686 if (NILP (system_key_syms
))
2687 system_key_syms
= Fcons (Qnil
, Qnil
);
2688 return modify_event_symbol (event
->code
& 0xffffff,
2690 Qfunction_key
, Vsystem_key_alist
,
2691 0, &system_key_syms
, 0xffffff);
2694 return modify_event_symbol (event
->code
- 0xff00,
2696 Qfunction_key
, Qnil
,
2697 lispy_function_keys
, &func_key_syms
,
2698 (sizeof (lispy_function_keys
)
2699 / sizeof (lispy_function_keys
[0])));
2702 #if defined (MULTI_FRAME) || defined (HAVE_MOUSE)
2703 /* A mouse click. Figure out where it is, decide whether it's
2704 a press, click or drag, and build the appropriate structure. */
2706 case scroll_bar_click
:
2708 int button
= event
->code
;
2710 Lisp_Object position
;
2711 Lisp_Object
*start_pos_ptr
;
2712 Lisp_Object start_pos
;
2714 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2717 /* Build the position as appropriate for this mouse click. */
2718 if (event
->kind
== mouse_click
)
2721 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2726 /* Ignore mouse events that were made on frame that
2727 have been deleted. */
2728 if (! FRAME_LIVE_P (f
))
2731 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
2732 &column
, &row
, 0, 1);
2734 #ifndef USE_X_TOOLKIT
2735 /* In the non-toolkit version, clicks on the menu bar
2736 are ordinary button events in the event buffer.
2737 Distinguish them, and invoke the menu.
2739 (In the toolkit version, the toolkit handles the menu bar
2740 and Emacs doesn't know about it until after the user
2741 makes a selection.) */
2742 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
))
2744 Lisp_Object items
, item
;
2748 /* Activate the menu bar on the down event. If the
2749 up event comes in before the menu code can deal with it,
2751 if (! (event
->modifiers
& down_modifier
))
2755 items
= FRAME_MENU_BAR_ITEMS (f
);
2756 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 3)
2758 Lisp_Object pos
, string
;
2759 string
= XVECTOR (items
)->contents
[i
+ 1];
2760 pos
= XVECTOR (items
)->contents
[i
+ 2];
2763 if (column
>= XINT (pos
)
2764 && column
< XINT (pos
) + XSTRING (string
)->size
)
2766 item
= XVECTOR (items
)->contents
[i
];
2772 = Fcons (event
->frame_or_window
,
2774 Fcons (Fcons (event
->x
, event
->y
),
2775 Fcons (make_number (event
->timestamp
),
2778 return Fcons (item
, Fcons (position
, Qnil
));
2780 #endif /* not USE_X_TOOLKIT */
2782 window
= window_from_coordinates (f
, column
, row
, &part
);
2784 if (!WINDOWP (window
))
2786 window
= event
->frame_or_window
;
2791 int pixcolumn
, pixrow
;
2792 column
-= XINT (XWINDOW (window
)->left
);
2793 row
-= XINT (XWINDOW (window
)->top
);
2794 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
2795 XSETINT (event
->x
, pixcolumn
);
2796 XSETINT (event
->y
, pixrow
);
2801 posn
= Qvertical_line
;
2804 buffer_posn_from_coords (XWINDOW (window
),
2811 Fcons (Fcons (event
->x
, event
->y
),
2812 Fcons (make_number (event
->timestamp
),
2818 Lisp_Object portion_whole
;
2821 window
= event
->frame_or_window
;
2822 portion_whole
= Fcons (event
->x
, event
->y
);
2823 part
= *scroll_bar_parts
[(int) event
->part
];
2827 Fcons (Qvertical_scroll_bar
,
2828 Fcons (portion_whole
,
2829 Fcons (make_number (event
->timestamp
),
2830 Fcons (part
, Qnil
)))));
2833 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2835 start_pos
= *start_pos_ptr
;
2836 *start_pos_ptr
= Qnil
;
2838 is_double
= (button
== last_mouse_button
2839 && XINT (event
->x
) == last_mouse_x
2840 && XINT (event
->y
) == last_mouse_y
2841 && button_down_time
!= 0
2842 && (EQ (Vdouble_click_time
, Qt
)
2843 || (INTEGERP (Vdouble_click_time
)
2844 && ((int)(event
->timestamp
- button_down_time
)
2845 < XINT (Vdouble_click_time
)))));
2846 last_mouse_button
= button
;
2847 last_mouse_x
= XINT (event
->x
);
2848 last_mouse_y
= XINT (event
->y
);
2850 /* If this is a button press, squirrel away the location, so
2851 we can decide later whether it was a click or a drag. */
2852 if (event
->modifiers
& down_modifier
)
2856 double_click_count
++;
2857 event
->modifiers
|= ((double_click_count
> 2)
2862 double_click_count
= 1;
2863 button_down_time
= event
->timestamp
;
2864 *start_pos_ptr
= Fcopy_alist (position
);
2867 /* Now we're releasing a button - check the co-ordinates to
2868 see if this was a click or a drag. */
2869 else if (event
->modifiers
& up_modifier
)
2871 /* If we did not see a down before this up,
2872 ignore the up. Probably this happened because
2873 the down event chose a menu item.
2874 It would be an annoyance to treat the release
2875 of the button that chose the menu item
2876 as a separate event. */
2878 if (!CONSP (start_pos
))
2881 event
->modifiers
&= ~up_modifier
;
2882 #if 0 /* Formerly we treated an up with no down as a click event. */
2883 if (!CONSP (start_pos
))
2884 event
->modifiers
|= click_modifier
;
2888 /* The third element of every position should be the (x,y)
2892 down
= Fnth (make_number (2), start_pos
);
2893 if (EQ (event
->x
, XCONS (down
)->car
)
2894 && EQ (event
->y
, XCONS (down
)->cdr
))
2896 event
->modifiers
|= click_modifier
;
2900 button_down_time
= 0;
2901 event
->modifiers
|= drag_modifier
;
2903 /* Don't check is_double; treat this as multiple
2904 if the down-event was multiple. */
2905 if (double_click_count
> 1)
2906 event
->modifiers
|= ((double_click_count
> 2)
2912 /* Every mouse event should either have the down_modifier or
2913 the up_modifier set. */
2917 /* Get the symbol we should use for the mouse click. */
2920 head
= modify_event_symbol (button
,
2923 lispy_mouse_names
, &mouse_syms
,
2924 (sizeof (lispy_mouse_names
)
2925 / sizeof (lispy_mouse_names
[0])));
2926 if (event
->modifiers
& drag_modifier
)
2931 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2934 Fcons (make_number (double_click_count
),
2942 #endif /* MULTI_FRAME or HAVE_MOUSE */
2944 /* The 'kind' field of the event is something we don't recognize. */
2950 #if defined (MULTI_FRAME) || defined (HAVE_MOUSE)
2953 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2955 Lisp_Object bar_window
;
2956 enum scroll_bar_part part
;
2961 /* Is it a scroll bar movement? */
2962 if (frame
&& ! NILP (bar_window
))
2964 Lisp_Object part_sym
;
2966 part_sym
= *scroll_bar_parts
[(int) part
];
2967 return Fcons (Qscroll_bar_movement
,
2968 (Fcons (Fcons (bar_window
,
2969 Fcons (Qvertical_scroll_bar
,
2970 Fcons (Fcons (x
, y
),
2971 Fcons (make_number (time
),
2977 /* Or is it an ordinary mouse movement? */
2979 #endif /* MULTI_FRAME */
2992 /* It's in a frame; which window on that frame? */
2993 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
, 0, 1);
2994 window
= window_from_coordinates (frame
, column
, row
, &area
);
2999 if (WINDOWP (window
))
3001 int pixcolumn
, pixrow
;
3002 column
-= XINT (XWINDOW (window
)->left
);
3003 row
-= XINT (XWINDOW (window
)->top
);
3004 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
3005 XSETINT (x
, pixcolumn
);
3006 XSETINT (y
, pixrow
);
3011 posn
= Qvertical_line
;
3014 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
3017 else if (frame
!= 0)
3019 XSETFRAME (window
, frame
);
3031 return Fcons (Qmouse_movement
,
3032 Fcons (Fcons (window
,
3034 Fcons (Fcons (x
, y
),
3035 Fcons (make_number (time
),
3041 #endif /* neither MULTI_FRAME nor HAVE_MOUSE */
3043 /* Construct a switch frame event. */
3045 make_lispy_switch_frame (frame
)
3048 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
3051 /* Manipulating modifiers. */
3053 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
3055 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
3056 SYMBOL's name of the end of the modifiers; the string from this
3057 position is the unmodified symbol name.
3059 This doesn't use any caches. */
3061 parse_modifiers_uncached (symbol
, modifier_end
)
3065 struct Lisp_String
*name
;
3069 CHECK_SYMBOL (symbol
, 1);
3072 name
= XSYMBOL (symbol
)->name
;
3075 for (i
= 0; i
+2 <= name
->size
; )
3076 switch (name
->data
[i
])
3078 #define SINGLE_LETTER_MOD(bit) \
3079 if (name->data[i+1] != '-') \
3080 goto no_more_modifiers; \
3085 SINGLE_LETTER_MOD (alt_modifier
);
3089 SINGLE_LETTER_MOD (ctrl_modifier
);
3093 SINGLE_LETTER_MOD (hyper_modifier
);
3097 SINGLE_LETTER_MOD (meta_modifier
);
3101 SINGLE_LETTER_MOD (shift_modifier
);
3105 SINGLE_LETTER_MOD (super_modifier
);
3109 if (i
+ 5 > name
->size
)
3110 goto no_more_modifiers
;
3111 if (! strncmp (name
->data
+ i
, "drag-", 5))
3113 modifiers
|= drag_modifier
;
3116 else if (! strncmp (name
->data
+ i
, "down-", 5))
3118 modifiers
|= down_modifier
;
3121 else if (i
+ 7 <= name
->size
3122 && ! strncmp (name
->data
+ i
, "double-", 7))
3124 modifiers
|= double_modifier
;
3128 goto no_more_modifiers
;
3132 if (i
+ 7 > name
->size
)
3133 goto no_more_modifiers
;
3134 if (! strncmp (name
->data
+ i
, "triple-", 7))
3136 modifiers
|= triple_modifier
;
3140 goto no_more_modifiers
;
3144 goto no_more_modifiers
;
3146 #undef SINGLE_LETTER_MOD
3150 /* Should we include the `click' modifier? */
3151 if (! (modifiers
& (down_modifier
| drag_modifier
3152 | double_modifier
| triple_modifier
))
3153 && i
+ 7 == name
->size
3154 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
3155 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
3156 modifiers
|= click_modifier
;
3165 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
3166 prepended to the string BASE[0..BASE_LEN-1].
3167 This doesn't use any caches. */
3169 apply_modifiers_uncached (modifiers
, base
, base_len
)
3174 /* Since BASE could contain nulls, we can't use intern here; we have
3175 to use Fintern, which expects a genuine Lisp_String, and keeps a
3178 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
3184 /* Only the event queue may use the `up' modifier; it should always
3185 be turned into a click or drag event before presented to lisp code. */
3186 if (modifiers
& up_modifier
)
3189 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
3190 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
3191 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
3192 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
3193 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
3194 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
3195 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
3196 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
3197 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
3198 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
3199 /* The click modifier is denoted by the absence of other modifiers. */
3203 mod_len
= p
- new_mods
;
3207 Lisp_Object new_name
;
3209 new_name
= make_uninit_string (mod_len
+ base_len
);
3210 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
3211 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
3213 return Fintern (new_name
, Qnil
);
3218 static char *modifier_names
[] =
3220 "up", "down", "drag", "click", "double", "triple", 0, 0,
3221 0, 0, 0, 0, 0, 0, 0, 0,
3222 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
3224 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
3226 static Lisp_Object modifier_symbols
;
3228 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
3230 lispy_modifier_list (modifiers
)
3233 Lisp_Object modifier_list
;
3236 modifier_list
= Qnil
;
3237 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
3238 if (modifiers
& (1<<i
))
3239 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
3242 return modifier_list
;
3246 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
3247 where UNMODIFIED is the unmodified form of SYMBOL,
3248 MASK is the set of modifiers present in SYMBOL's name.
3249 This is similar to parse_modifiers_uncached, but uses the cache in
3250 SYMBOL's Qevent_symbol_element_mask property, and maintains the
3251 Qevent_symbol_elements property. */
3253 parse_modifiers (symbol
)
3256 Lisp_Object elements
;
3258 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
3259 if (CONSP (elements
))
3264 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
3265 Lisp_Object unmodified
;
3268 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
3269 XSYMBOL (symbol
)->name
->size
- end
),
3272 if (modifiers
& ~((1<<VALBITS
) - 1))
3274 XSETFASTINT (mask
, modifiers
);
3275 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
3277 /* Cache the parsing results on SYMBOL. */
3278 Fput (symbol
, Qevent_symbol_element_mask
,
3280 Fput (symbol
, Qevent_symbol_elements
,
3281 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
3283 /* Since we know that SYMBOL is modifiers applied to unmodified,
3284 it would be nice to put that in unmodified's cache.
3285 But we can't, since we're not sure that parse_modifiers is
3292 /* Apply the modifiers MODIFIERS to the symbol BASE.
3293 BASE must be unmodified.
3295 This is like apply_modifiers_uncached, but uses BASE's
3296 Qmodifier_cache property, if present. It also builds
3297 Qevent_symbol_elements properties, since it has that info anyway.
3299 apply_modifiers copies the value of BASE's Qevent_kind property to
3300 the modified symbol. */
3302 apply_modifiers (modifiers
, base
)
3306 Lisp_Object cache
, index
, entry
, new_symbol
;
3308 /* Mask out upper bits. We don't know where this value's been. */
3309 modifiers
&= (1<<VALBITS
) - 1;
3311 /* The click modifier never figures into cache indices. */
3312 cache
= Fget (base
, Qmodifier_cache
);
3313 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
3314 entry
= assq_no_quit (index
, cache
);
3317 new_symbol
= XCONS (entry
)->cdr
;
3320 /* We have to create the symbol ourselves. */
3321 new_symbol
= apply_modifiers_uncached (modifiers
,
3322 XSYMBOL (base
)->name
->data
,
3323 XSYMBOL (base
)->name
->size
);
3325 /* Add the new symbol to the base's cache. */
3326 entry
= Fcons (index
, new_symbol
);
3327 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
3329 /* We have the parsing info now for free, so add it to the caches. */
3330 XSETFASTINT (index
, modifiers
);
3331 Fput (new_symbol
, Qevent_symbol_element_mask
,
3332 Fcons (base
, Fcons (index
, Qnil
)));
3333 Fput (new_symbol
, Qevent_symbol_elements
,
3334 Fcons (base
, lispy_modifier_list (modifiers
)));
3337 /* Make sure this symbol is of the same kind as BASE.
3339 You'd think we could just set this once and for all when we
3340 intern the symbol above, but reorder_modifiers may call us when
3341 BASE's property isn't set right; we can't assume that just
3342 because it has a Qmodifier_cache property it must have its
3343 Qevent_kind set right as well. */
3344 if (NILP (Fget (new_symbol
, Qevent_kind
)))
3348 kind
= Fget (base
, Qevent_kind
);
3350 Fput (new_symbol
, Qevent_kind
, kind
);
3357 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
3358 return a symbol with the modifiers placed in the canonical order.
3359 Canonical order is alphabetical, except for down and drag, which
3360 always come last. The 'click' modifier is never written out.
3362 Fdefine_key calls this to make sure that (for example) C-M-foo
3363 and M-C-foo end up being equivalent in the keymap. */
3366 reorder_modifiers (symbol
)
3369 /* It's hopefully okay to write the code this way, since everything
3370 will soon be in caches, and no consing will be done at all. */
3373 parsed
= parse_modifiers (symbol
);
3374 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
3375 XCONS (parsed
)->car
);
3379 /* For handling events, we often want to produce a symbol whose name
3380 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
3381 to some base, like the name of a function key or mouse button.
3382 modify_event_symbol produces symbols of this sort.
3384 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
3385 is the name of the i'th symbol. TABLE_SIZE is the number of elements
3388 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
3389 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
3391 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
3392 persist between calls to modify_event_symbol that it can use to
3393 store a cache of the symbols it's generated for this NAME_TABLE
3394 before. The object stored there may be a vector or an alist.
3396 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
3398 MODIFIERS is a set of modifier bits (as given in struct input_events)
3399 whose prefixes should be applied to the symbol name.
3401 SYMBOL_KIND is the value to be placed in the event_kind property of
3402 the returned symbol.
3404 The symbols we create are supposed to have an
3405 `event-symbol-elements' property, which lists the modifiers present
3406 in the symbol's name. */
3409 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
3410 name_table
, symbol_table
, table_size
)
3413 Lisp_Object symbol_kind
;
3414 Lisp_Object name_alist
;
3416 Lisp_Object
*symbol_table
;
3420 Lisp_Object symbol_int
;
3422 XSETINT (symbol_int
, symbol_num
);
3424 /* Is this a request for a valid symbol? */
3425 if (symbol_num
< 0 || symbol_num
>= table_size
)
3428 if (CONSP (*symbol_table
))
3429 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
3431 /* If *symbol_table doesn't seem to be initialized properly, fix that.
3432 *symbol_table should be a lisp vector TABLE_SIZE elements long,
3433 where the Nth element is the symbol for NAME_TABLE[N], or nil if
3434 we've never used that symbol before. */
3437 if (! VECTORP (*symbol_table
)
3438 || XVECTOR (*symbol_table
)->size
!= table_size
)
3442 XSETFASTINT (size
, table_size
);
3443 *symbol_table
= Fmake_vector (size
, Qnil
);
3446 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
3449 /* Have we already used this symbol before? */
3452 /* No; let's create it. */
3453 if (!NILP (name_alist
))
3454 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
3455 else if (name_table
[symbol_num
])
3456 value
= intern (name_table
[symbol_num
]);
3461 sprintf (buf
, "key-%d", symbol_num
);
3462 value
= intern (buf
);
3465 if (CONSP (*symbol_table
))
3466 *symbol_table
= Fcons (value
, *symbol_table
);
3468 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
3470 /* Fill in the cache entries for this symbol; this also
3471 builds the Qevent_symbol_elements property, which the user
3473 apply_modifiers (modifiers
& click_modifier
, value
);
3474 Fput (value
, Qevent_kind
, symbol_kind
);
3477 /* Apply modifiers to that symbol. */
3478 return apply_modifiers (modifiers
, value
);
3482 /* Store into *addr a value nonzero if terminal input chars are available.
3483 Serves the purpose of ioctl (0, FIONREAD, addr)
3484 but works even if FIONREAD does not exist.
3485 (In fact, this may actually read some input.) */
3488 get_input_pending (addr
)
3491 /* First of all, have we already counted some input? */
3492 *addr
= !NILP (Vquit_flag
) || readable_events ();
3494 /* If input is being read as it arrives, and we have none, there is none. */
3495 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
3498 /* Try to read some input and see how much we get. */
3500 *addr
= !NILP (Vquit_flag
) || readable_events ();
3503 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
3506 gobble_input (expected
)
3511 if (interrupt_input
)
3514 mask
= sigblockx (SIGIO
);
3515 read_avail_input (expected
);
3519 #ifdef POLL_FOR_INPUT
3520 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
3523 mask
= sigblockx (SIGALRM
);
3524 read_avail_input (expected
);
3530 read_avail_input (expected
);
3534 /* Put a buffer_switch_event in the buffer
3535 so that read_key_sequence will notice the new current buffer. */
3537 record_asynch_buffer_change ()
3539 struct input_event event
;
3542 event
.kind
= buffer_switch_event
;
3543 event
.frame_or_window
= Qnil
;
3546 /* We don't need a buffer-switch event unless Emacs is waiting for input.
3547 The purpose of the event is to make read_key_sequence look up the
3548 keymaps again. If we aren't in read_key_sequence, we don't need one,
3549 and the event could cause trouble by messing up (input-pending-p). */
3550 tem
= Fwaiting_for_user_input_p ();
3554 /* We never need these events if we have no asynchronous subprocesses. */
3558 /* Make sure no interrupt happens while storing the event. */
3560 if (interrupt_input
)
3563 mask
= sigblockx (SIGIO
);
3564 kbd_buffer_store_event (&event
);
3571 kbd_buffer_store_event (&event
);
3578 /* Read any terminal input already buffered up by the system
3579 into the kbd_buffer, but do not wait.
3581 EXPECTED should be nonzero if the caller knows there is some input.
3583 Except on VMS, all input is read by this function.
3584 If interrupt_input is nonzero, this function MUST be called
3585 only when SIGIO is blocked.
3587 Returns the number of keyboard chars read, or -1 meaning
3588 this is a bad time to try to read input. */
3591 read_avail_input (expected
)
3594 struct input_event buf
[KBD_BUFFER_SIZE
];
3598 if (read_socket_hook
)
3599 /* No need for FIONREAD or fcntl; just say don't wait. */
3600 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
,
3601 expected
, expected
);
3604 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
3605 the kbd_buffer can really hold. That may prevent loss
3606 of characters on some systems when input is stuffed at us. */
3607 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
3610 /* Determine how many characters we should *try* to read. */
3613 #else /* not WINDOWSNT */
3615 n_to_read
= dos_keysns ();
3618 #else /* not MSDOS */
3620 /* Find out how much input is available. */
3621 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
3622 /* Formerly simply reported no input, but that sometimes led to
3623 a failure of Emacs to terminate.
3624 SIGHUP seems appropriate if we can't reach the terminal. */
3625 /* ??? Is it really right to send the signal just to this process
3626 rather than to the whole process group?
3627 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3628 kill (getpid (), SIGHUP
);
3631 if (n_to_read
> sizeof cbuf
)
3632 n_to_read
= sizeof cbuf
;
3633 #else /* no FIONREAD */
3634 #if defined(USG) || defined(DGUX)
3635 /* Read some input if available, but don't wait. */
3636 n_to_read
= sizeof cbuf
;
3637 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
3642 #endif /* not MSDOS */
3643 #endif /* not WINDOWSNT */
3645 /* Now read; for one reason or another, this will not block.
3646 NREAD is set to the number of chars read. */
3650 cbuf
[0] = dos_keyread();
3653 nread
= read (input_fd
, cbuf
, n_to_read
);
3655 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
3656 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3657 This looks incorrect, but it isn't, because _BSD causes
3658 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3659 and that causes a value other than 0 when there is no input. */
3665 /* We used to retry the read if it was interrupted.
3666 But this does the wrong thing when O_NDELAY causes
3667 an EAGAIN error. Does anybody know of a situation
3668 where a retry is actually needed? */
3670 nread
< 0 && (errno
== EAGAIN
3684 #if defined (USG) || defined (DGUX)
3685 fcntl (input_fd
, F_SETFL
, 0);
3686 #endif /* USG or DGUX */
3687 #endif /* no FIONREAD */
3688 for (i
= 0; i
< nread
; i
++)
3690 buf
[i
].kind
= ascii_keystroke
;
3691 buf
[i
].modifiers
= 0;
3692 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3693 buf
[i
].modifiers
= meta_modifier
;
3697 buf
[i
].code
= cbuf
[i
];
3699 XSETFRAME (buf
[i
].frame_or_window
, selected_frame
);
3701 buf
[i
].frame_or_window
= Qnil
;
3706 /* Scan the chars for C-g and store them in kbd_buffer. */
3707 for (i
= 0; i
< nread
; i
++)
3709 kbd_buffer_store_event (&buf
[i
]);
3710 /* Don't look at input that follows a C-g too closely.
3711 This reduces lossage due to autorepeat on C-g. */
3712 if (buf
[i
].kind
== ascii_keystroke
3713 && buf
[i
].code
== quit_char
)
3719 #endif /* not VMS */
3721 #ifdef SIGIO /* for entire page */
3722 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3725 input_available_signal (signo
)
3728 /* Must preserve main program's value of errno. */
3729 int old_errno
= errno
;
3731 extern int select_alarmed
;
3735 /* USG systems forget handlers when they are used;
3736 must reestablish each time */
3737 signal (signo
, input_available_signal
);
3744 if (input_available_clear_time
)
3745 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3750 nread
= read_avail_input (1);
3751 /* -1 means it's not ok to read the input now.
3752 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3753 0 means there was no keyboard input available. */
3758 select_alarmed
= 1; /* Force the select emulator back to life */
3769 /* Send ourselves a SIGIO.
3771 This function exists so that the UNBLOCK_INPUT macro in
3772 blockinput.h can have some way to take care of input we put off
3773 dealing with, without assuming that every file which uses
3774 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3776 reinvoke_input_signal ()
3785 /* Return the prompt-string of a sparse keymap.
3786 This is the first element which is a string.
3787 Return nil if there is none. */
3795 register Lisp_Object tem
;
3804 static void menu_bar_item ();
3805 static void menu_bar_one_keymap ();
3807 /* These variables hold the vector under construction within
3808 menu_bar_items and its subroutines, and the current index
3809 for storing into that vector. */
3810 static Lisp_Object menu_bar_items_vector
;
3811 static int menu_bar_items_index
;
3813 /* Return a vector of menu items for a menu bar, appropriate
3814 to the current buffer. Each item has three elements in the vector:
3817 OLD is an old vector we can optionally reuse, or nil. */
3820 menu_bar_items (old
)
3823 /* The number of keymaps we're scanning right now, and the number of
3824 keymaps we have allocated space for. */
3827 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3828 in the current keymaps, or nil where it is not a prefix. */
3831 Lisp_Object def
, tem
, tail
;
3840 struct gcpro gcpro1
;
3842 /* In order to build the menus, we need to call the keymap
3843 accessors. They all call QUIT. But this function is called
3844 during redisplay, during which a quit is fatal. So inhibit
3845 quitting while building the menus.
3846 We do this instead of specbind because (1) errors will clear it anyway
3847 and (2) this avoids risk of specpdl overflow. */
3848 oquit
= Vinhibit_quit
;
3852 menu_bar_items_vector
= old
;
3854 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
3855 menu_bar_items_index
= 0;
3857 GCPRO1 (menu_bar_items_vector
);
3859 /* Build our list of keymaps.
3860 If we recognize a function key and replace its escape sequence in
3861 keybuf with its symbol, or if the sequence starts with a mouse
3862 click and we need to switch buffers, we jump back here to rebuild
3863 the initial keymaps from the current buffer. */
3867 /* Should overriding-local-map apply, here? */
3868 if (!NILP (Voverriding_local_map_menu_flag
))
3870 if (NILP (Voverriding_local_map
))
3872 /* Yes, and it is nil. Use just global map. */
3874 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3878 /* Yes, and it is non-nil. Use it and the global map. */
3880 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3881 maps
[0] = Voverriding_local_map
;
3886 /* No, so use major and minor mode keymaps. */
3887 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3888 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3889 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3890 #ifdef USE_TEXT_PROPERTIES
3891 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3893 maps
[nmaps
-2] = current_buffer
->keymap
;
3896 maps
[nmaps
-1] = current_global_map
;
3899 /* Look up in each map the dummy prefix key `menu-bar'. */
3903 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3905 if (! NILP (maps
[mapno
]))
3906 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3910 tem
= Fkeymapp (def
);
3912 menu_bar_one_keymap (def
);
3915 /* Move to the end those items that should be at the end. */
3917 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3920 int end
= menu_bar_items_index
;
3922 for (i
= 0; i
< end
; i
+= 3)
3923 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3925 Lisp_Object tem0
, tem1
, tem2
;
3926 /* Move the item at index I to the end,
3927 shifting all the others forward. */
3928 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
3929 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
3930 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
3932 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
3933 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
3934 (end
- i
- 3) * sizeof (Lisp_Object
));
3935 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem0
;
3936 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem1
;
3937 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem2
;
3942 /* Add nil, nil, nil at the end. */
3943 i
= menu_bar_items_index
;
3944 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
3947 int newsize
= 2 * i
;
3948 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
3949 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
3950 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
3951 menu_bar_items_vector
= tem
;
3953 /* Add this item. */
3954 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3955 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3956 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3957 menu_bar_items_index
= i
;
3959 Vinhibit_quit
= oquit
;
3961 return menu_bar_items_vector
;
3964 /* Scan one map KEYMAP, accumulating any menu items it defines
3965 in menu_bar_items_vector. */
3968 menu_bar_one_keymap (keymap
)
3971 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3973 /* Loop over all keymap entries that have menu strings. */
3974 for (tail
= keymap
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3976 item
= XCONS (tail
)->car
;
3979 key
= XCONS (item
)->car
;
3980 binding
= XCONS (item
)->cdr
;
3981 if (CONSP (binding
))
3983 item_string
= XCONS (binding
)->car
;
3984 if (STRINGP (item_string
))
3985 menu_bar_item (key
, item_string
, Fcdr (binding
));
3987 else if (EQ (binding
, Qundefined
))
3988 menu_bar_item (key
, Qnil
, binding
);
3990 else if (VECTORP (item
))
3992 /* Loop over the char values represented in the vector. */
3993 int len
= XVECTOR (item
)->size
;
3995 for (c
= 0; c
< len
; c
++)
3997 Lisp_Object character
;
3998 XSETFASTINT (character
, c
);
3999 binding
= XVECTOR (item
)->contents
[c
];
4000 if (CONSP (binding
))
4002 item_string
= XCONS (binding
)->car
;
4003 if (STRINGP (item_string
))
4004 menu_bar_item (key
, item_string
, Fcdr (binding
));
4006 else if (EQ (binding
, Qundefined
))
4007 menu_bar_item (key
, Qnil
, binding
);
4013 /* This is used as the handler when calling internal_condition_case_1. */
4016 menu_bar_item_1 (arg
)
4022 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
4023 If there's already an item for KEY, add this DEF to it. */
4026 menu_bar_item (key
, item_string
, def
)
4027 Lisp_Object key
, item_string
, def
;
4030 Lisp_Object enabled
;
4033 if (EQ (def
, Qundefined
))
4035 /* If a map has an explicit `undefined' as definition,
4036 discard any previously made menu bar item. */
4038 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
4039 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
4041 if (menu_bar_items_index
> i
+ 3)
4042 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
4043 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
4044 (menu_bar_items_index
- i
- 3) * sizeof (Lisp_Object
));
4045 menu_bar_items_index
-= 3;
4049 /* If there's no definition for this key yet,
4050 just ignore `undefined'. */
4054 /* See if this entry is enabled. */
4059 /* No property, or nil, means enable.
4060 Otherwise, enable if value is not nil. */
4061 tem
= Fget (def
, Qmenu_enable
);
4063 /* (condition-case nil (eval tem)
4065 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
4069 /* Ignore this item if it's not enabled. */
4073 /* Find any existing item for this KEY. */
4074 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
4075 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
4078 /* If we did not find this KEY, add it at the end. */
4079 if (i
== menu_bar_items_index
)
4081 /* If vector is too small, get a bigger one. */
4082 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
4085 int newsize
= 2 * i
;
4086 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
4087 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
4088 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
4089 menu_bar_items_vector
= tem
;
4091 /* Add this item. */
4092 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
4093 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
4094 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (def
, Qnil
);
4095 menu_bar_items_index
= i
;
4097 /* We did find an item for this KEY. Add DEF to its list of maps. */
4101 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
4102 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (def
, old
);
4106 /* Read a character using menus based on maps in the array MAPS.
4107 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
4108 Return t if we displayed a menu but the user rejected it.
4110 PREV_EVENT is the previous input event, or nil if we are reading
4111 the first event of a key sequence.
4113 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
4114 if we used a mouse menu to read the input, or zero otherwise. If
4115 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
4117 The prompting is done based on the prompt-string of the map
4118 and the strings associated with various map elements.
4120 This can be done with X menus or with menus put in the minibuf.
4121 These are done in different ways, depending on how the input will be read.
4122 Menus using X are done after auto-saving in read-char, getting the input
4123 event from Fx_popup_menu; menus using the minibuf use read_char recursively
4124 and do auto-saving in the inner call of read_char. */
4127 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
4130 Lisp_Object prev_event
;
4131 int *used_mouse_menu
;
4134 register Lisp_Object name
;
4135 Lisp_Object rest
, vector
;
4137 if (used_mouse_menu
)
4138 *used_mouse_menu
= 0;
4140 /* Use local over global Menu maps */
4142 if (! menu_prompting
)
4145 /* Optionally disregard all but the global map. */
4146 if (inhibit_local_menu_bar_menus
)
4148 maps
+= (nmaps
- 1);
4152 /* Get the menu name from the first map that has one (a prompt string). */
4153 for (mapno
= 0; mapno
< nmaps
; mapno
++)
4155 name
= map_prompt (maps
[mapno
]);
4160 /* If we don't have any menus, just read a character normally. */
4164 #if (defined (HAVE_X_WINDOWS) && defined (HAVE_X_MENU)) || defined (MSDOS)
4165 /* If we got to this point via a mouse click,
4166 use a real menu for mouse selection. */
4167 if (EVENT_HAS_PARAMETERS (prev_event
))
4169 /* Display the menu and get the selection. */
4170 Lisp_Object
*realmaps
4171 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
4175 /* Use the maps that are not nil. */
4176 for (mapno
= 0; mapno
< nmaps
; mapno
++)
4177 if (!NILP (maps
[mapno
]))
4178 realmaps
[nmaps1
++] = maps
[mapno
];
4180 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
4183 /* If we got more than one event, put all but the first
4184 onto this list to be read later.
4185 Return just the first event now. */
4186 Vunread_command_events
4187 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
4188 value
= XCONS (value
)->car
;
4190 else if (NILP (value
))
4192 if (used_mouse_menu
)
4193 *used_mouse_menu
= 1;
4196 #endif /* (HAVE_X_WINDOWS && HAVE_X_MENU) || MSDOS */
4201 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
4207 register Lisp_Object name
;
4209 int width
= FRAME_WIDTH (selected_frame
) - 4;
4210 char *menu
= (char *) alloca (width
+ 4);
4213 Lisp_Object rest
, vector
;
4215 if (! menu_prompting
)
4218 /* Get the menu name from the first map that has one (a prompt string). */
4219 for (mapno
= 0; mapno
< nmaps
; mapno
++)
4221 name
= map_prompt (maps
[mapno
]);
4226 /* If we don't have any menus, just read a character normally. */
4230 /* Prompt string always starts with map's prompt, and a space. */
4231 strcpy (menu
, XSTRING (name
)->data
);
4232 nlength
= XSTRING (name
)->size
;
4233 menu
[nlength
++] = ':';
4234 menu
[nlength
++] = ' ';
4237 /* Start prompting at start of first map. */
4241 /* Present the documented bindings, a line at a time. */
4248 int orig_defn_macro
;
4250 /* Loop over elements of map. */
4255 /* If reached end of map, start at beginning of next map. */
4259 /* At end of last map, wrap around to first map if just starting,
4260 or end this line if already have something on it. */
4264 if (notfirst
|| nobindings
) break;
4269 /* Look at the next element of the map. */
4271 elt
= XVECTOR (vector
)->contents
[idx
];
4273 elt
= Fcar_safe (rest
);
4275 if (idx
< 0 && VECTORP (elt
))
4277 /* If we found a dense table in the keymap,
4278 advanced past it, but start scanning its contents. */
4279 rest
= Fcdr_safe (rest
);
4285 /* An ordinary element. */
4287 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
4289 s
= Fcar_safe(elt
); /* vector */
4291 /* Ignore the element if it has no prompt string. */
4293 /* If we have room for the prompt string, add it to this line.
4294 If this is the first on the line, always add it. */
4295 else if (XSTRING (s
)->size
+ i
+ 2 < width
4300 /* Punctuate between strings. */
4303 strcpy (menu
+ i
, ", ");
4309 /* Add as much of string as fits. */
4310 thiswidth
= XSTRING (s
)->size
;
4311 if (thiswidth
+ i
> width
)
4312 thiswidth
= width
- i
;
4313 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
4319 /* If this element does not fit, end the line now,
4320 and save the element for the next line. */
4321 strcpy (menu
+ i
, "...");
4325 /* Move past this element. */
4326 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
4327 /* Handle reaching end of dense table. */
4332 rest
= Fcdr_safe (rest
);
4336 /* Prompt with that and read response. */
4339 /* Make believe its not a keyboard macro in case the help char
4340 is pressed. Help characters are not recorded because menu prompting
4341 is not used on replay.
4343 orig_defn_macro
= defining_kbd_macro
;
4344 defining_kbd_macro
= 0 ;
4346 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
4347 while (BUFFERP (obj
));
4348 defining_kbd_macro
= orig_defn_macro
;
4350 if (!INTEGERP (obj
))
4355 if (! EQ (obj
, menu_prompt_more_char
)
4356 && (!INTEGERP (menu_prompt_more_char
)
4357 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
4359 if ( defining_kbd_macro
)
4360 store_kbd_macro_char(obj
) ;
4363 /* Help char - go round again */
4367 /* Reading key sequences. */
4369 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
4370 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
4371 keymap, or nil otherwise. Return the index of the first keymap in
4372 which KEY has any binding, or NMAPS if no map has a binding.
4374 If KEY is a meta ASCII character, treat it like meta-prefix-char
4375 followed by the corresponding non-meta character. Keymaps in
4376 CURRENT with non-prefix bindings for meta-prefix-char become nil in
4379 If KEY has no bindings in any of the CURRENT maps, NEXT is left
4382 NEXT may == CURRENT. */
4385 follow_key (key
, nmaps
, current
, defs
, next
)
4387 Lisp_Object
*current
, *defs
, *next
;
4390 int i
, first_binding
;
4392 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
4393 followed by the corresponding non-meta character. */
4394 if (INTEGERP (key
) && (XINT (key
) & CHAR_META
))
4396 for (i
= 0; i
< nmaps
; i
++)
4397 if (! NILP (current
[i
]))
4400 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
4402 /* Note that since we pass the resulting bindings through
4403 get_keymap_1, non-prefix bindings for meta-prefix-char
4405 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
4411 XSETINT (key
, XFASTINT (key
) & ~CHAR_META
);
4414 first_binding
= nmaps
;
4415 for (i
= nmaps
- 1; i
>= 0; i
--)
4417 if (! NILP (current
[i
]))
4419 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
4420 if (! NILP (defs
[i
]))
4427 /* Given the set of bindings we've found, produce the next set of maps. */
4428 if (first_binding
< nmaps
)
4429 for (i
= 0; i
< nmaps
; i
++)
4430 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
4432 return first_binding
;
4435 /* Read a sequence of keys that ends with a non prefix character,
4436 storing it in KEYBUF, a buffer of size BUFSIZE.
4438 Return the length of the key sequence stored.
4439 Return -1 if the user rejected a command menu.
4441 Echo starting immediately unless `prompt' is 0.
4443 Where a key sequence ends depends on the currently active keymaps.
4444 These include any minor mode keymaps active in the current buffer,
4445 the current buffer's local map, and the global map.
4447 If a key sequence has no other bindings, we check Vfunction_key_map
4448 to see if some trailing subsequence might be the beginning of a
4449 function key's sequence. If so, we try to read the whole function
4450 key, and substitute its symbolic name into the key sequence.
4452 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
4453 `double-' events into similar click events, if that would make them
4454 bound. We try to turn `triple-' events first into `double-' events,
4457 If we get a mouse click in a mode line, vertical divider, or other
4458 non-text area, we treat the click as if it were prefixed by the
4459 symbol denoting that area - `mode-line', `vertical-line', or
4462 If the sequence starts with a mouse click, we read the key sequence
4463 with respect to the buffer clicked on, not the current buffer.
4465 If the user switches frames in the midst of a key sequence, we put
4466 off the switch-frame event until later; the next call to
4467 read_char will return it. */
4470 read_key_sequence (keybuf
, bufsize
, prompt
)
4471 Lisp_Object
*keybuf
;
4475 int count
= specpdl_ptr
- specpdl
;
4477 /* How many keys there are in the current key sequence. */
4480 /* The length of the echo buffer when we started reading, and
4481 the length of this_command_keys when we started reading. */
4485 /* The number of keymaps we're scanning right now, and the number of
4486 keymaps we have allocated space for. */
4488 int nmaps_allocated
= 0;
4490 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
4491 the current keymaps. */
4494 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
4495 in the current keymaps, or nil where it is not a prefix. */
4496 Lisp_Object
*submaps
;
4498 /* The local map to start out with at start of key sequence. */
4499 Lisp_Object orig_local_map
;
4501 /* 1 if we have already considered switching to the local-map property
4502 of the place where a mouse click occurred. */
4503 int localized_local_map
= 0;
4505 /* The index in defs[] of the first keymap that has a binding for
4506 this key sequence. In other words, the lowest i such that
4507 defs[i] is non-nil. */
4510 /* If t < mock_input, then KEYBUF[t] should be read as the next
4513 We use this to recover after recognizing a function key. Once we
4514 realize that a suffix of the current key sequence is actually a
4515 function key's escape sequence, we replace the suffix with the
4516 function key's binding from Vfunction_key_map. Now keybuf
4517 contains a new and different key sequence, so the echo area,
4518 this_command_keys, and the submaps and defs arrays are wrong. In
4519 this situation, we set mock_input to t, set t to 0, and jump to
4520 restart_sequence; the loop will read keys from keybuf up until
4521 mock_input, thus rebuilding the state; and then it will resume
4522 reading characters from the keyboard. */
4525 /* If the sequence is unbound in submaps[], then
4526 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
4527 and fkey_map is its binding.
4529 These might be > t, indicating that all function key scanning
4530 should hold off until t reaches them. We do this when we've just
4531 recognized a function key, to avoid searching for the function
4532 key's again in Vfunction_key_map. */
4533 int fkey_start
= 0, fkey_end
= 0;
4534 Lisp_Object fkey_map
;
4536 /* Likewise, for key_translation_map. */
4537 int keytran_start
= 0, keytran_end
= 0;
4538 Lisp_Object keytran_map
;
4540 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
4541 we put it off for later. While we're reading, we keep the event here. */
4542 Lisp_Object delayed_switch_frame
;
4544 /* See the comment below... */
4545 #if defined (GOBBLE_FIRST_EVENT)
4546 Lisp_Object first_event
;
4549 /* Gets around Microsoft compiler limitations. */
4552 struct buffer
*starting_buffer
;
4554 /* Nonzero if we seem to have got the beginning of a binding
4555 in function_key_map. */
4556 int function_key_possible
= 0;
4557 int key_translation_possible
= 0;
4561 last_nonmenu_event
= Qnil
;
4563 delayed_switch_frame
= Qnil
;
4564 fkey_map
= Vfunction_key_map
;
4565 keytran_map
= Vkey_translation_map
;
4567 /* If there is no function-key-map, turn off function key scanning. */
4568 if (NILP (Fkeymapp (Vfunction_key_map
)))
4569 fkey_start
= fkey_end
= bufsize
+ 1;
4571 /* If there is no key-translation-map, turn off scanning. */
4572 if (NILP (Fkeymapp (Vkey_translation_map
)))
4573 keytran_start
= keytran_end
= bufsize
+ 1;
4578 echo_prompt (XSTRING (prompt
)->data
);
4579 else if (cursor_in_echo_area
&& echo_keystrokes
)
4580 /* This doesn't put in a dash if the echo buffer is empty, so
4581 you don't always see a dash hanging out in the minibuffer. */
4585 /* Record the initial state of the echo area and this_command_keys;
4586 we will need to restore them if we replay a key sequence. */
4588 echo_start
= echo_length ();
4589 keys_start
= this_command_key_count
;
4591 #if defined (GOBBLE_FIRST_EVENT)
4592 /* This doesn't quite work, because some of the things that read_char
4593 does cannot safely be bypassed. It seems too risky to try to make
4596 /* Read the first char of the sequence specially, before setting
4597 up any keymaps, in case a filter runs and switches buffers on us. */
4598 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
4600 #endif /* GOBBLE_FIRST_EVENT */
4602 orig_local_map
= get_local_map (PT
, current_buffer
);
4604 /* We jump here when the key sequence has been thoroughly changed, and
4605 we need to rescan it starting from the beginning. When we jump here,
4606 keybuf[0..mock_input] holds the sequence we should reread. */
4609 starting_buffer
= current_buffer
;
4610 function_key_possible
= 0;
4611 key_translation_possible
= 0;
4613 /* Build our list of keymaps.
4614 If we recognize a function key and replace its escape sequence in
4615 keybuf with its symbol, or if the sequence starts with a mouse
4616 click and we need to switch buffers, we jump back here to rebuild
4617 the initial keymaps from the current buffer. */
4621 if (!NILP (Voverriding_local_map
))
4624 if (nmaps
> nmaps_allocated
)
4626 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4627 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4628 nmaps_allocated
= nmaps
;
4630 submaps
[0] = Voverriding_local_map
;
4634 nmaps
= current_minor_maps (0, &maps
) + 2;
4635 if (nmaps
> nmaps_allocated
)
4637 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4638 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4639 nmaps_allocated
= nmaps
;
4641 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
4642 #ifdef USE_TEXT_PROPERTIES
4643 submaps
[nmaps
-2] = orig_local_map
;
4645 submaps
[nmaps
-2] = current_buffer
->keymap
;
4648 submaps
[nmaps
-1] = current_global_map
;
4651 /* Find an accurate initial value for first_binding. */
4652 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
4653 if (! NILP (submaps
[first_binding
]))
4656 /* Start from the beginning in keybuf. */
4659 /* These are no-ops the first time through, but if we restart, they
4660 revert the echo area and this_command_keys to their original state. */
4661 this_command_key_count
= keys_start
;
4662 if (INTERACTIVE
&& t
< mock_input
)
4663 echo_truncate (echo_start
);
4665 /* If the best binding for the current key sequence is a keymap, or
4666 we may be looking at a function key's escape sequence, keep on
4668 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
4669 || (first_binding
>= nmaps
4671 /* mock input is never part of a function key's sequence. */
4672 && mock_input
<= fkey_start
)
4673 || (keytran_start
< t
&& key_translation_possible
)
4674 /* Don't return in the middle of a possible function key sequence,
4675 if the only bindings we found were via case conversion.
4676 Thus, if ESC O a has a function-key-map translation
4677 and ESC o has a binding, don't return after ESC O,
4678 so that we can translate ESC O plus the next character. */
4682 int used_mouse_menu
= 0;
4684 /* Where the last real key started. If we need to throw away a
4685 key that has expanded into more than one element of keybuf
4686 (say, a mouse click on the mode line which is being treated
4687 as [mode-line (mouse-...)], then we backtrack to this point
4689 int last_real_key_start
;
4691 /* These variables are analogous to echo_start and keys_start;
4692 while those allow us to restart the entire key sequence,
4693 echo_local_start and keys_local_start allow us to throw away
4695 int echo_local_start
, keys_local_start
, local_first_binding
;
4698 error ("key sequence too long");
4701 echo_local_start
= echo_length ();
4702 keys_local_start
= this_command_key_count
;
4703 local_first_binding
= first_binding
;
4706 /* These are no-ops, unless we throw away a keystroke below and
4707 jumped back up to replay_key; in that case, these restore the
4708 variables to their original state, allowing us to replay the
4710 if (INTERACTIVE
&& t
< mock_input
)
4711 echo_truncate (echo_local_start
);
4712 this_command_key_count
= keys_local_start
;
4713 first_binding
= local_first_binding
;
4715 /* By default, assume each event is "real". */
4716 last_real_key_start
= t
;
4718 /* Does mock_input indicate that we are re-reading a key sequence? */
4722 add_command_key (key
);
4723 if (echo_keystrokes
)
4727 /* If not, we should actually read a character. */
4730 struct buffer
*buf
= current_buffer
;
4732 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
4735 /* read_char returns t when it shows a menu and the user rejects it.
4740 /* read_char returns -1 at the end of a macro.
4741 Emacs 18 handles this by returning immediately with a
4742 zero, so that's what we'll do. */
4743 if (INTEGERP (key
) && XINT (key
) == -1)
4746 /* The Microsoft C compiler can't handle the goto that
4752 /* If the current buffer has been changed from under us, the
4753 keymap may have changed, so replay the sequence. */
4757 goto replay_sequence
;
4760 /* If we have a quit that was typed in another frame, and
4761 quit_throw_to_read_char switched buffers,
4762 replay to get the right keymap. */
4763 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
4768 goto replay_sequence
;
4774 /* Clicks in non-text areas get prefixed by the symbol
4775 in their CHAR-ADDRESS field. For example, a click on
4776 the mode line is prefixed by the symbol `mode-line'.
4778 Furthermore, key sequences beginning with mouse clicks
4779 are read using the keymaps of the buffer clicked on, not
4780 the current buffer. So we may have to switch the buffer
4783 When we turn one event into two events, we must make sure
4784 that neither of the two looks like the original--so that,
4785 if we replay the events, they won't be expanded again.
4786 If not for this, such reexpansion could happen either here
4787 or when user programs play with this-command-keys. */
4788 if (EVENT_HAS_PARAMETERS (key
))
4792 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
4793 if (EQ (kind
, Qmouse_click
))
4795 Lisp_Object window
, posn
;
4797 window
= POSN_WINDOW (EVENT_START (key
));
4798 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4801 /* We're looking at the second event of a
4802 sequence which we expanded before. Set
4803 last_real_key_start appropriately. */
4805 last_real_key_start
= t
- 1;
4808 /* Key sequences beginning with mouse clicks are
4809 read using the keymaps in the buffer clicked on,
4810 not the current buffer. If we're at the
4811 beginning of a key sequence, switch buffers. */
4812 if (last_real_key_start
== 0
4814 && BUFFERP (XWINDOW (window
)->buffer
)
4815 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
4820 /* Arrange to go back to the original buffer once we're
4821 done reading the key sequence. Note that we can't
4822 use save_excursion_{save,restore} here, because they
4823 save point as well as the current buffer; we don't
4824 want to save point, because redisplay may change it,
4825 to accommodate a Fset_window_start or something. We
4826 don't want to do this at the top of the function,
4827 because we may get input from a subprocess which
4828 wants to change the selected window and stuff (say,
4830 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
4832 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
4833 orig_local_map
= get_local_map (PT
, current_buffer
);
4834 goto replay_sequence
;
4836 /* For a mouse click, get the local text-property keymap
4837 of the place clicked on, rather than point. */
4838 if (last_real_key_start
== 0 && CONSP (XCONS (key
)->cdr
)
4839 && ! localized_local_map
)
4841 Lisp_Object map_here
, start
, pos
;
4843 localized_local_map
= 1;
4844 start
= EVENT_START (key
);
4845 if (CONSP (start
) && CONSP (XCONS (start
)->cdr
))
4847 pos
= POSN_BUFFER_POSN (start
);
4850 map_here
= get_local_map (XINT (pos
), current_buffer
);
4851 if (!EQ (map_here
, orig_local_map
))
4853 orig_local_map
= map_here
;
4857 goto replay_sequence
;
4863 /* Expand mode-line and scroll-bar events into two events:
4864 use posn as a fake prefix key. */
4867 if (t
+ 1 >= bufsize
)
4868 error ("key sequence too long");
4873 /* Zap the position in key, so we know that we've
4874 expanded it, and don't try to do so again. */
4875 POSN_BUFFER_POSN (EVENT_START (key
))
4876 = Fcons (posn
, Qnil
);
4880 else if (EQ (kind
, Qswitch_frame
))
4882 /* If we're at the beginning of a key sequence, go
4883 ahead and return this event. If we're in the
4884 midst of a key sequence, delay it until the end. */
4887 delayed_switch_frame
= key
;
4891 else if (CONSP (XCONS (key
)->cdr
)
4892 && CONSP (EVENT_START (key
))
4893 && CONSP (XCONS (EVENT_START (key
))->cdr
))
4897 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4898 /* Handle menu-bar events:
4899 insert the dummy prefix event `menu-bar'. */
4900 if (EQ (posn
, Qmenu_bar
))
4902 if (t
+ 1 >= bufsize
)
4903 error ("key sequence too long");
4904 /* Run the Lucid hook. */
4905 if (!NILP (Vrun_hooks
))
4906 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4907 /* If it has changed current-menubar from previous value,
4908 really recompute the menubar from the value. */
4909 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4910 call0 (Qrecompute_lucid_menubar
);
4914 /* Zap the position in key, so we know that we've
4915 expanded it, and don't try to do so again. */
4916 POSN_BUFFER_POSN (EVENT_START (key
))
4917 = Fcons (posn
, Qnil
);
4920 goto replay_sequence
;
4922 else if (CONSP (posn
))
4924 /* We're looking at the second event of a
4925 sequence which we expanded before. Set
4926 last_real_key_start appropriately. */
4927 if (last_real_key_start
== t
&& t
> 0)
4928 last_real_key_start
= t
- 1;
4933 /* We have finally decided that KEY is something we might want
4935 first_binding
= (follow_key (key
,
4936 nmaps
- first_binding
,
4937 submaps
+ first_binding
,
4938 defs
+ first_binding
,
4939 submaps
+ first_binding
)
4942 /* If KEY wasn't bound, we'll try some fallbacks. */
4943 if (first_binding
>= nmaps
)
4947 head
= EVENT_HEAD (key
);
4948 if (EQ (head
, Vhelp_char
))
4950 read_key_sequence_cmd
= Vprefix_help_command
;
4952 last_nonmenu_event
= key
;
4953 /* The Microsoft C compiler can't handle the goto that
4960 Lisp_Object breakdown
;
4963 breakdown
= parse_modifiers (head
);
4964 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4965 /* Attempt to reduce an unbound mouse event to a simpler
4966 event that is bound:
4967 Drags reduce to clicks.
4968 Double-clicks reduce to clicks.
4969 Triple-clicks reduce to double-clicks, then to clicks.
4970 Down-clicks are eliminated.
4971 Double-downs reduce to downs, then are eliminated.
4972 Triple-downs reduce to double-downs, then to downs,
4973 then are eliminated. */
4974 if (modifiers
& (down_modifier
| drag_modifier
4975 | double_modifier
| triple_modifier
))
4977 while (modifiers
& (down_modifier
| drag_modifier
4978 | double_modifier
| triple_modifier
))
4980 Lisp_Object new_head
, new_click
;
4981 if (modifiers
& triple_modifier
)
4982 modifiers
^= (double_modifier
| triple_modifier
);
4983 else if (modifiers
& double_modifier
)
4984 modifiers
&= ~double_modifier
;
4985 else if (modifiers
& drag_modifier
)
4986 modifiers
&= ~drag_modifier
;
4989 /* Dispose of this `down' event by simply jumping
4990 back to replay_key, to get another event.
4992 Note that if this event came from mock input,
4993 then just jumping back to replay_key will just
4994 hand it to us again. So we have to wipe out any
4997 We could delete keybuf[t] and shift everything
4998 after that to the left by one spot, but we'd also
4999 have to fix up any variable that points into
5000 keybuf, and shifting isn't really necessary
5003 Adding prefixes for non-textual mouse clicks
5004 creates two characters of mock input, and both
5005 must be thrown away. If we're only looking at
5006 the prefix now, we can just jump back to
5007 replay_key. On the other hand, if we've already
5008 processed the prefix, and now the actual click
5009 itself is giving us trouble, then we've lost the
5010 state of the keymaps we want to backtrack to, and
5011 we need to replay the whole sequence to rebuild
5014 Beyond that, only function key expansion could
5015 create more than two keys, but that should never
5016 generate mouse events, so it's okay to zero
5017 mock_input in that case too.
5019 Isn't this just the most wonderful code ever? */
5020 if (t
== last_real_key_start
)
5027 mock_input
= last_real_key_start
;
5028 goto replay_sequence
;
5033 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
5035 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
5037 /* Look for a binding for this new key. follow_key
5038 promises that it didn't munge submaps the
5039 last time we called it, since key was unbound. */
5041 = (follow_key (new_click
,
5042 nmaps
- local_first_binding
,
5043 submaps
+ local_first_binding
,
5044 defs
+ local_first_binding
,
5045 submaps
+ local_first_binding
)
5046 + local_first_binding
);
5048 /* If that click is bound, go for it. */
5049 if (first_binding
< nmaps
)
5054 /* Otherwise, we'll leave key set to the drag event. */
5061 /* Normally, last_nonmenu_event gets the previous key we read.
5062 But when a mouse popup menu is being used,
5063 we don't update last_nonmenu_event; it continues to hold the mouse
5064 event that preceded the first level of menu. */
5065 if (!used_mouse_menu
)
5066 last_nonmenu_event
= key
;
5068 /* If the sequence is unbound, see if we can hang a function key
5069 off the end of it. We only want to scan real keyboard input
5070 for function key sequences, so if mock_input says that we're
5071 re-reading old events, don't examine it. */
5072 if (first_binding
>= nmaps
5075 Lisp_Object fkey_next
;
5077 /* Continue scan from fkey_end until we find a bound suffix.
5078 If we fail, increment fkey_start
5079 and start fkey_end from there. */
5080 while (fkey_end
< t
)
5084 key
= keybuf
[fkey_end
++];
5085 /* Look up meta-characters by prefixing them
5086 with meta_prefix_char. I hate this. */
5087 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
5092 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
5094 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
5097 fkey_next
= fkey_map
;
5100 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
5102 #if 0 /* I didn't turn this on, because it might cause trouble
5103 for the mapping of return into C-m and tab into C-i. */
5104 /* Optionally don't map function keys into other things.
5105 This enables the user to redefine kp- keys easily. */
5106 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
5110 /* If the function key map gives a function, not an
5111 array, then call the function with no args and use
5112 its value instead. */
5113 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
5116 struct gcpro gcpro1
, gcpro2
, gcpro3
;
5120 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
5121 fkey_next
= call1 (fkey_next
, prompt
);
5123 /* If the function returned something invalid,
5124 barf--don't ignore it.
5125 (To ignore it safely, we would need to gcpro a bunch of
5126 other variables.) */
5127 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
5128 error ("Function in function-key-map returns invalid key sequence");
5131 function_key_possible
= ! NILP (fkey_next
);
5133 /* If keybuf[fkey_start..fkey_end] is bound in the
5134 function key map and it's a suffix of the current
5135 sequence (i.e. fkey_end == t), replace it with
5136 the binding and restart with fkey_start at the end. */
5137 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
5140 int len
= XFASTINT (Flength (fkey_next
));
5142 t
= fkey_start
+ len
;
5144 error ("key sequence too long");
5146 if (VECTORP (fkey_next
))
5147 bcopy (XVECTOR (fkey_next
)->contents
,
5148 keybuf
+ fkey_start
,
5149 (t
- fkey_start
) * sizeof (keybuf
[0]));
5150 else if (STRINGP (fkey_next
))
5154 for (i
= 0; i
< len
; i
++)
5155 XSETFASTINT (keybuf
[fkey_start
+ i
],
5156 XSTRING (fkey_next
)->data
[i
]);
5160 fkey_start
= fkey_end
= t
;
5161 fkey_map
= Vfunction_key_map
;
5163 /* Do pass the results through key-translation-map. */
5164 keytran_start
= keytran_end
= 0;
5165 keytran_map
= Vkey_translation_map
;
5167 goto replay_sequence
;
5170 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
5172 /* If we no longer have a bound suffix, try a new positions for
5174 if (NILP (fkey_map
))
5176 fkey_end
= ++fkey_start
;
5177 fkey_map
= Vfunction_key_map
;
5178 function_key_possible
= 0;
5183 /* Look for this sequence in key-translation-map. */
5185 Lisp_Object keytran_next
;
5187 /* Scan from keytran_end until we find a bound suffix. */
5188 while (keytran_end
< t
)
5192 key
= keybuf
[keytran_end
++];
5193 /* Look up meta-characters by prefixing them
5194 with meta_prefix_char. I hate this. */
5195 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
5200 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
5202 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
5205 keytran_next
= keytran_map
;
5208 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
5210 /* If the key translation map gives a function, not an
5211 array, then call the function with no args and use
5212 its value instead. */
5213 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
5214 && keytran_end
== t
)
5216 struct gcpro gcpro1
, gcpro2
, gcpro3
;
5220 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
5221 keytran_next
= call1 (keytran_next
, prompt
);
5223 /* If the function returned something invalid,
5224 barf--don't ignore it.
5225 (To ignore it safely, we would need to gcpro a bunch of
5226 other variables.) */
5227 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
5228 error ("Function in key-translation-map returns invalid key sequence");
5231 key_translation_possible
= ! NILP (keytran_next
);
5233 /* If keybuf[keytran_start..keytran_end] is bound in the
5234 key translation map and it's a suffix of the current
5235 sequence (i.e. keytran_end == t), replace it with
5236 the binding and restart with keytran_start at the end. */
5237 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
5238 && keytran_end
== t
)
5240 int len
= XFASTINT (Flength (keytran_next
));
5242 t
= keytran_start
+ len
;
5244 error ("key sequence too long");
5246 if (VECTORP (keytran_next
))
5247 bcopy (XVECTOR (keytran_next
)->contents
,
5248 keybuf
+ keytran_start
,
5249 (t
- keytran_start
) * sizeof (keybuf
[0]));
5250 else if (STRINGP (keytran_next
))
5254 for (i
= 0; i
< len
; i
++)
5255 XSETFASTINT (keybuf
[keytran_start
+ i
],
5256 XSTRING (keytran_next
)->data
[i
]);
5260 keytran_start
= keytran_end
= t
;
5261 keytran_map
= Vkey_translation_map
;
5263 /* Don't pass the results of key-translation-map
5264 through function-key-map. */
5265 fkey_start
= fkey_end
= t
;
5266 fkey_map
= Vkey_translation_map
;
5268 goto replay_sequence
;
5271 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
5273 /* If we no longer have a bound suffix, try a new positions for
5275 if (NILP (keytran_map
))
5277 keytran_end
= ++keytran_start
;
5278 keytran_map
= Vkey_translation_map
;
5279 key_translation_possible
= 0;
5284 /* If KEY is not defined in any of the keymaps,
5285 and cannot be part of a function key or translation,
5286 and is an upper case letter
5287 use the corresponding lower-case letter instead. */
5288 if (first_binding
== nmaps
&& ! function_key_possible
5289 && ! key_translation_possible
5291 && ((((XINT (key
) & 0x3ffff)
5292 < XSTRING (current_buffer
->downcase_table
)->size
)
5293 && UPPERCASEP (XINT (key
) & 0x3ffff))
5294 || (XINT (key
) & shift_modifier
)))
5296 if (XINT (key
) & shift_modifier
)
5297 XSETINT (key
, XINT (key
) & ~shift_modifier
);
5299 XSETINT (key
, (DOWNCASE (XINT (key
) & 0x3ffff)
5300 | (XINT (key
) & ~0x3ffff)));
5302 keybuf
[t
- 1] = key
;
5304 goto replay_sequence
;
5306 /* If KEY is not defined in any of the keymaps,
5307 and cannot be part of a function key or translation,
5308 and is a shifted function key,
5309 use the corresponding unshifted function key instead. */
5310 if (first_binding
== nmaps
&& ! function_key_possible
5311 && ! key_translation_possible
5314 Lisp_Object breakdown
;
5317 breakdown
= parse_modifiers (key
);
5318 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
5319 if (modifiers
& shift_modifier
)
5321 modifiers
&= ~shift_modifier
;
5322 key
= apply_modifiers (make_number (modifiers
),
5323 XCONS (breakdown
)->car
);
5325 keybuf
[t
- 1] = key
;
5327 goto replay_sequence
;
5333 read_key_sequence_cmd
= (first_binding
< nmaps
5334 ? defs
[first_binding
]
5337 unread_switch_frame
= delayed_switch_frame
;
5338 unbind_to (count
, Qnil
);
5340 /* Occasionally we fabricate events, perhaps by expanding something
5341 according to function-key-map, or by adding a prefix symbol to a
5342 mouse click in the scroll bar or modeline. In this cases, return
5343 the entire generated key sequence, even if we hit an unbound
5344 prefix or a definition before the end. This means that you will
5345 be able to push back the event properly, and also means that
5346 read-key-sequence will always return a logical unit.
5349 for (; t
< mock_input
; t
++)
5351 if (echo_keystrokes
)
5352 echo_char (keybuf
[t
]);
5353 add_command_key (keybuf
[t
]);
5359 #if 0 /* This doc string is too long for some compilers.
5360 This commented-out definition serves for DOC. */
5361 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
5362 "Read a sequence of keystrokes and return as a string or vector.\n\
5363 The sequence is sufficient to specify a non-prefix command in the\n\
5364 current local and global maps.\n\
5366 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
5367 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
5368 as a continuation of the previous key.\n\
5370 A C-g typed while in this function is treated like any other character,\n\
5371 and `quit-flag' is not set.\n\
5373 If the key sequence starts with a mouse click, then the sequence is read\n\
5374 using the keymaps of the buffer of the window clicked in, not the buffer\n\
5375 of the selected window as normal.\n\
5377 `read-key-sequence' drops unbound button-down events, since you normally\n\
5378 only care about the click or drag events which follow them. If a drag\n\
5379 or multi-click event is unbound, but the corresponding click event would\n\
5380 be bound, `read-key-sequence' turns the event into a click event at the\n\
5381 drag's starting position. This means that you don't have to distinguish\n\
5382 between click and drag, double, or triple events unless you want to.\n\
5384 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
5385 lines separating windows, and scroll bars with imaginary keys\n\
5386 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
5388 If the user switches frames in the middle of a key sequence, the\n\
5389 frame-switch event is put off until after the current key sequence.\n\
5391 `read-key-sequence' checks `function-key-map' for function key\n\
5392 sequences, where they wouldn't conflict with ordinary bindings. See\n\
5393 `function-key-map' for more details.")
5394 (prompt
, continue_echo
)
5397 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
5399 (prompt
, continue_echo
)
5400 Lisp_Object prompt
, continue_echo
;
5402 Lisp_Object keybuf
[30];
5404 struct gcpro gcpro1
, gcpro2
;
5407 CHECK_STRING (prompt
, 0);
5410 bzero (keybuf
, sizeof keybuf
);
5412 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
5414 if (NILP (continue_echo
))
5415 this_command_key_count
= 0;
5417 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])), prompt
);
5425 return make_event_array (i
, keybuf
);
5428 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
5429 "Execute CMD as an editor command.\n\
5430 CMD must be a symbol that satisfies the `commandp' predicate.\n\
5431 Optional second arg RECORD-FLAG non-nil\n\
5432 means unconditionally put this command in `command-history'.\n\
5433 Otherwise, that is done only if an arg is read using the minibuffer.")
5435 Lisp_Object cmd
, record
;
5437 register Lisp_Object final
;
5438 register Lisp_Object tem
;
5439 Lisp_Object prefixarg
;
5440 struct backtrace backtrace
;
5441 extern int debug_on_next_call
;
5443 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
5444 Vcurrent_prefix_arg
= prefixarg
;
5445 debug_on_next_call
= 0;
5449 tem
= Fget (cmd
, Qdisabled
);
5450 if (!NILP (tem
) && !NILP (Vrun_hooks
))
5451 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
5456 final
= Findirect_function (cmd
);
5458 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
5459 do_autoload (final
, cmd
);
5464 if (STRINGP (final
) || VECTORP (final
))
5466 /* If requested, place the macro in the command history. For
5467 other sorts of commands, call-interactively takes care of
5471 = Fcons (Fcons (Qexecute_kbd_macro
,
5472 Fcons (final
, Fcons (prefixarg
, Qnil
))),
5475 return Fexecute_kbd_macro (final
, prefixarg
);
5477 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
5479 backtrace
.next
= backtrace_list
;
5480 backtrace_list
= &backtrace
;
5481 backtrace
.function
= &Qcall_interactively
;
5482 backtrace
.args
= &cmd
;
5483 backtrace
.nargs
= 1;
5484 backtrace
.evalargs
= 0;
5486 tem
= Fcall_interactively (cmd
, record
);
5488 backtrace_list
= backtrace
.next
;
5494 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
5496 "Read function name, then read its arguments and call it.")
5498 Lisp_Object prefixarg
;
5500 Lisp_Object function
;
5502 Lisp_Object saved_keys
;
5503 struct gcpro gcpro1
;
5505 saved_keys
= Fvector (this_command_key_count
,
5506 XVECTOR (this_command_keys
)->contents
);
5508 GCPRO1 (saved_keys
);
5510 if (EQ (prefixarg
, Qminus
))
5512 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
5513 strcpy (buf
, "C-u ");
5514 else if (CONSP (prefixarg
) && INTEGERP (XCONS (prefixarg
)->car
))
5515 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
5516 else if (INTEGERP (prefixarg
))
5517 sprintf (buf
, "%d ", XINT (prefixarg
));
5519 /* This isn't strictly correct if execute-extended-command
5520 is bound to anything else. Perhaps it should use
5521 this_command_keys? */
5522 strcat (buf
, "M-x ");
5524 /* Prompt with buf, and then read a string, completing from and
5525 restricting to the set of all defined commands. Don't provide
5526 any initial input. Save the command read on the extended-command
5528 function
= Fcompleting_read (build_string (buf
),
5529 Vobarray
, Qcommandp
,
5530 Qt
, Qnil
, Qextended_command_history
);
5532 /* Set this_command_keys to the concatenation of saved_keys and
5533 function, followed by a RET. */
5535 struct Lisp_String
*str
;
5540 this_command_key_count
= 0;
5542 keys
= XVECTOR (saved_keys
)->contents
;
5543 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
5544 add_command_key (keys
[i
]);
5546 str
= XSTRING (function
);
5547 for (i
= 0; i
< str
->size
; i
++)
5549 XSETFASTINT (tem
, str
->data
[i
]);
5550 add_command_key (tem
);
5553 XSETFASTINT (tem
, '\015');
5554 add_command_key (tem
);
5559 function
= Fintern (function
, Qnil
);
5560 Vprefix_arg
= prefixarg
;
5561 this_command
= function
;
5563 return Fcommand_execute (function
, Qt
);
5567 detect_input_pending ()
5570 get_input_pending (&input_pending
);
5572 return input_pending
;
5575 /* This is called in some cases before a possible quit.
5576 It cases the next call to detect_input_pending to recompute input_pending.
5577 So calling this function unnecessarily can't do any harm. */
5578 clear_input_pending ()
5583 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
5584 "T if command input is currently available with no waiting.\n\
5585 Actually, the value is nil only if we can be sure that no input is available.")
5588 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
5591 return detect_input_pending () ? Qt
: Qnil
;
5594 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
5595 "Return vector of last 100 events, not counting those from keyboard macros.")
5598 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
5601 if (total_keys
< NUM_RECENT_KEYS
)
5602 return Fvector (total_keys
, keys
);
5605 val
= Fvector (NUM_RECENT_KEYS
, keys
);
5606 bcopy (keys
+ recent_keys_index
,
5607 XVECTOR (val
)->contents
,
5608 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
5610 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
5611 recent_keys_index
* sizeof (Lisp_Object
));
5616 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
5617 "Return the key sequence that invoked this command.\n\
5618 The value is a string or a vector.")
5621 return make_event_array (this_command_key_count
,
5622 XVECTOR (this_command_keys
)->contents
);
5625 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
5626 "Return the current depth in recursive edits.")
5630 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
5634 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
5635 "FOpen dribble file: ",
5636 "Start writing all keyboard characters to a dribble file called FILE.\n\
5637 If FILE is nil, close any open dribble file.")
5651 file
= Fexpand_file_name (file
, Qnil
);
5652 dribble
= fopen (XSTRING (file
)->data
, "w");
5657 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
5658 "Discard the contents of the terminal input buffer.\n\
5659 Also cancel any kbd macro being defined.")
5662 defining_kbd_macro
= 0;
5663 update_mode_lines
++;
5665 Vunread_command_events
= Qnil
;
5666 unread_command_char
= -1;
5668 discard_tty_input ();
5670 /* Without the cast, GCC complains that this assignment loses the
5671 volatile qualifier of kbd_store_ptr. Is there anything wrong
5673 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
5674 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5680 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
5681 "Stop Emacs and return to superior process. You can resume later.\n\
5682 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
5683 control, run a subshell instead.\n\n\
5684 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
5685 to be read as terminal input by Emacs's parent, after suspension.\n\
5687 Before suspending, run the normal hook `suspend-hook'.\n\
5688 After resumption run the normal hook `suspend-resume-hook'.\n\
5690 Some operating systems cannot stop the Emacs process and resume it later.\n\
5691 On such systems, Emacs starts a subshell instead of suspending.")
5693 Lisp_Object stuffstring
;
5696 int count
= specpdl_ptr
- specpdl
;
5697 int old_height
, old_width
;
5699 struct gcpro gcpro1
, gcpro2
;
5700 extern init_sys_modes ();
5702 if (!NILP (stuffstring
))
5703 CHECK_STRING (stuffstring
, 0);
5705 /* Run the functions in suspend-hook. */
5706 if (!NILP (Vrun_hooks
))
5707 call1 (Vrun_hooks
, intern ("suspend-hook"));
5709 GCPRO1 (stuffstring
);
5710 get_frame_size (&old_width
, &old_height
);
5712 /* sys_suspend can get an error if it tries to fork a subshell
5713 and the system resources aren't available for that. */
5714 record_unwind_protect (init_sys_modes
, 0);
5715 stuff_buffered_input (stuffstring
);
5720 unbind_to (count
, Qnil
);
5722 /* Check if terminal/window size has changed.
5723 Note that this is not useful when we are running directly
5724 with a window system; but suspend should be disabled in that case. */
5725 get_frame_size (&width
, &height
);
5726 if (width
!= old_width
|| height
!= old_height
)
5727 change_frame_size (selected_frame
, height
, width
, 0, 0);
5729 /* Run suspend-resume-hook. */
5730 if (!NILP (Vrun_hooks
))
5731 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
5737 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
5738 Then in any case stuff anything Emacs has read ahead and not used. */
5740 stuff_buffered_input (stuffstring
)
5741 Lisp_Object stuffstring
;
5743 register unsigned char *p
;
5745 /* stuff_char works only in BSD, versions 4.2 and up. */
5748 if (STRINGP (stuffstring
))
5752 p
= XSTRING (stuffstring
)->data
;
5753 count
= XSTRING (stuffstring
)->size
;
5758 /* Anything we have read ahead, put back for the shell to read. */
5759 while (kbd_fetch_ptr
!= kbd_store_ptr
)
5761 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
5762 kbd_fetch_ptr
= kbd_buffer
;
5763 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
5764 stuff_char (kbd_fetch_ptr
->code
);
5765 kbd_fetch_ptr
->kind
= no_event
;
5766 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
5773 #endif /* BSD and not BSD4_1 */
5776 set_waiting_for_input (time_to_clear
)
5777 EMACS_TIME
*time_to_clear
;
5779 input_available_clear_time
= time_to_clear
;
5781 /* Tell interrupt_signal to throw back to read_char, */
5782 waiting_for_input
= 1;
5784 /* If interrupt_signal was called before and buffered a C-g,
5785 make it run again now, to avoid timing error. */
5786 if (!NILP (Vquit_flag
))
5787 quit_throw_to_read_char ();
5790 clear_waiting_for_input ()
5792 /* Tell interrupt_signal not to throw back to read_char, */
5793 waiting_for_input
= 0;
5794 input_available_clear_time
= 0;
5797 /* This routine is called at interrupt level in response to C-G.
5798 If interrupt_input, this is the handler for SIGINT.
5799 Otherwise, it is called from kbd_buffer_store_event,
5800 in handling SIGIO or SIGTINT.
5802 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
5803 immediately throw back to read_char.
5805 Otherwise it sets the Lisp variable quit-flag not-nil.
5806 This causes eval to throw, when it gets a chance.
5807 If quit-flag is already non-nil, it stops the job right away. */
5813 /* Must preserve main program's value of errno. */
5814 int old_errno
= errno
;
5817 if (!read_socket_hook
&& NILP (Vwindow_system
))
5819 /* USG systems forget handlers when they are used;
5820 must reestablish each time */
5821 signal (SIGINT
, interrupt_signal
);
5822 signal (SIGQUIT
, interrupt_signal
);
5828 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
5833 #ifdef SIGTSTP /* Support possible in later USG versions */
5835 * On systems which can suspend the current process and return to the original
5836 * shell, this command causes the user to end up back at the shell.
5837 * The "Auto-save" and "Abort" questions are not asked until
5838 * the user elects to return to emacs, at which point he can save the current
5839 * job and either dump core or continue.
5844 if (sys_suspend () == -1)
5846 printf ("Not running as a subprocess;\n");
5847 printf ("you can continue or abort.\n");
5850 /* Perhaps should really fork an inferior shell?
5851 But that would not provide any way to get back
5852 to the original shell, ever. */
5853 printf ("No support for stopping a process on this operating system;\n");
5854 printf ("you can continue or abort.\n");
5855 #endif /* not VMS */
5856 #endif /* not SIGTSTP */
5858 /* We must remain inside the screen area when the internal terminal
5859 is used. Note that [Enter] is not echoed by dos. */
5862 printf ("Auto-save? (y or n) ");
5864 if (((c
= getchar ()) & ~040) == 'Y')
5866 Fdo_auto_save (Qt
, Qnil
);
5868 printf ("\r\nAuto-save done");
5869 #else /* not MSDOS */
5870 printf ("Auto-save done\n");
5871 #endif /* not MSDOS */
5873 while (c
!= '\n') c
= getchar ();
5875 printf ("\r\nAbort? (y or n) ");
5876 #else /* not MSDOS */
5878 printf ("Abort (and enter debugger)? (y or n) ");
5880 printf ("Abort (and dump core)? (y or n) ");
5881 #endif /* not VMS */
5882 #endif /* not MSDOS */
5884 if (((c
= getchar ()) & ~040) == 'Y')
5886 while (c
!= '\n') c
= getchar ();
5888 printf ("\r\nContinuing...\r\n");
5889 #else /* not MSDOS */
5890 printf ("Continuing...\n");
5891 #endif /* not MSDOS */
5897 /* If executing a function that wants to be interrupted out of
5898 and the user has not deferred quitting by binding `inhibit-quit'
5899 then quit right away. */
5900 if (immediate_quit
&& NILP (Vinhibit_quit
))
5904 Fsignal (Qquit
, Qnil
);
5907 /* Else request quit when it's safe */
5911 if (waiting_for_input
&& !echoing
)
5912 quit_throw_to_read_char ();
5917 /* Handle a C-g by making read_char return C-g. */
5919 quit_throw_to_read_char ()
5921 quit_error_check ();
5923 /* Prevent another signal from doing this before we finish. */
5924 clear_waiting_for_input ();
5927 Vunread_command_events
= Qnil
;
5928 unread_command_char
= -1;
5930 #ifdef POLL_FOR_INPUT
5931 /* May be > 1 if in recursive minibuffer. */
5932 if (poll_suppress_count
== 0)
5936 if (FRAMEP (internal_last_event_frame
)
5937 && XFRAME (internal_last_event_frame
) != selected_frame
)
5938 Fhandle_switch_frame (make_lispy_switch_frame (internal_last_event_frame
));
5941 _longjmp (getcjmp
, 1);
5944 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
5945 "Set mode of reading keyboard input.\n\
5946 First arg INTERRUPT non-nil means use input interrupts;\n\
5947 nil means use CBREAK mode.\n\
5948 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
5949 (no effect except in CBREAK mode).\n\
5950 Third arg META t means accept 8-bit input (for a Meta key).\n\
5951 META nil means ignore the top bit, on the assumption it is parity.\n\
5952 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
5953 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
5954 See also `current-input-mode'.")
5955 (interrupt
, flow
, meta
, quit
)
5956 Lisp_Object interrupt
, flow
, meta
, quit
;
5959 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
5960 error ("set-input-mode: QUIT must be an ASCII character");
5962 #ifdef POLL_FOR_INPUT
5968 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5969 #ifdef NO_SOCK_SIGIO
5970 if (read_socket_hook
)
5971 interrupt_input
= 0; /* No interrupts if reading from a socket. */
5973 #endif /* NO_SOCK_SIGIO */
5974 interrupt_input
= !NILP (interrupt
);
5975 #else /* not SIGIO */
5976 interrupt_input
= 0;
5977 #endif /* not SIGIO */
5978 /* Our VMS input only works by interrupts, as of now. */
5980 interrupt_input
= 1;
5982 flow_control
= !NILP (flow
);
5985 else if (EQ (meta
, Qt
))
5990 /* Don't let this value be out of range. */
5991 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
5995 #ifdef POLL_FOR_INPUT
5996 poll_suppress_count
= 1;
6002 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
6003 "Return information about the way Emacs currently reads keyboard input.\n\
6004 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
6005 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
6006 nil, Emacs is using CBREAK mode.\n\
6007 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
6008 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
6009 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
6010 META nil means ignoring the top bit, on the assumption it is parity.\n\
6011 META is neither t nor nil if accepting 8-bit input and using\n\
6012 all 8 bits as the character code.\n\
6013 QUIT is the character Emacs currently uses to quit.\n\
6014 The elements of this list correspond to the arguments of\n\
6020 val
[0] = interrupt_input
? Qt
: Qnil
;
6021 val
[1] = flow_control
? Qt
: Qnil
;
6022 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
6023 XSETFASTINT (val
[3], quit_char
);
6025 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
6031 /* This is correct before outermost invocation of the editor loop */
6032 command_loop_level
= -1;
6034 quit_char
= Ctl ('g');
6035 Vunread_command_events
= Qnil
;
6036 unread_command_char
= -1;
6038 recent_keys_index
= 0;
6039 kbd_fetch_ptr
= kbd_buffer
;
6040 kbd_store_ptr
= kbd_buffer
;
6042 do_mouse_tracking
= Qnil
;
6047 /* This means that command_loop_1 won't try to select anything the first
6049 internal_last_event_frame
= Qnil
;
6050 Vlast_event_frame
= internal_last_event_frame
;
6053 /* If we're running a dumped Emacs, we need to clear out
6054 kbd_buffer_frame_or_window, in case some events got into it
6057 If we're running an undumped Emacs, it hasn't been initialized by
6058 syms_of_keyboard yet. */
6060 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
6062 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
6064 signal (SIGINT
, interrupt_signal
);
6065 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
6066 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
6067 SIGQUIT and we can't tell which one it will give us. */
6068 signal (SIGQUIT
, interrupt_signal
);
6069 #endif /* HAVE_TERMIO */
6071 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6073 if (!noninteractive
)
6074 signal (SIGIO
, input_available_signal
);
6077 /* Use interrupt input by default, if it works and noninterrupt input
6078 has deficiencies. */
6080 #ifdef INTERRUPT_INPUT
6081 interrupt_input
= 1;
6083 interrupt_input
= 0;
6086 /* Our VMS input only works by interrupts, as of now. */
6088 interrupt_input
= 1;
6094 if (keyboard_init_hook
)
6095 (*keyboard_init_hook
) ();
6097 #ifdef POLL_FOR_INPUT
6098 poll_suppress_count
= 1;
6103 /* This type's only use is in syms_of_keyboard, to initialize the
6104 event header symbols and put properties on them. */
6111 struct event_head head_table
[] = {
6112 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
6113 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
6114 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
6115 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
6116 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
6117 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
6122 Qdisabled_command_hook
= intern ("disabled-command-hook");
6123 staticpro (&Qdisabled_command_hook
);
6125 Qself_insert_command
= intern ("self-insert-command");
6126 staticpro (&Qself_insert_command
);
6128 Qforward_char
= intern ("forward-char");
6129 staticpro (&Qforward_char
);
6131 Qbackward_char
= intern ("backward-char");
6132 staticpro (&Qbackward_char
);
6134 Qdisabled
= intern ("disabled");
6135 staticpro (&Qdisabled
);
6137 Qundefined
= intern ("undefined");
6138 staticpro (&Qundefined
);
6140 Qpre_command_hook
= intern ("pre-command-hook");
6141 staticpro (&Qpre_command_hook
);
6143 Qpost_command_hook
= intern ("post-command-hook");
6144 staticpro (&Qpost_command_hook
);
6146 Qdeferred_action_function
= intern ("deferred-action-function");
6147 staticpro (&Qdeferred_action_function
);
6149 Qcommand_hook_internal
= intern ("command-hook-internal");
6150 staticpro (&Qcommand_hook_internal
);
6152 Qfunction_key
= intern ("function-key");
6153 staticpro (&Qfunction_key
);
6154 Qmouse_click
= intern ("mouse-click");
6155 staticpro (&Qmouse_click
);
6157 Qmenu_enable
= intern ("menu-enable");
6158 staticpro (&Qmenu_enable
);
6160 Qmode_line
= intern ("mode-line");
6161 staticpro (&Qmode_line
);
6162 Qvertical_line
= intern ("vertical-line");
6163 staticpro (&Qvertical_line
);
6164 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
6165 staticpro (&Qvertical_scroll_bar
);
6166 Qmenu_bar
= intern ("menu-bar");
6167 staticpro (&Qmenu_bar
);
6169 Qabove_handle
= intern ("above-handle");
6170 staticpro (&Qabove_handle
);
6171 Qhandle
= intern ("handle");
6172 staticpro (&Qhandle
);
6173 Qbelow_handle
= intern ("below-handle");
6174 staticpro (&Qbelow_handle
);
6176 Qevent_kind
= intern ("event-kind");
6177 staticpro (&Qevent_kind
);
6178 Qevent_symbol_elements
= intern ("event-symbol-elements");
6179 staticpro (&Qevent_symbol_elements
);
6180 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
6181 staticpro (&Qevent_symbol_element_mask
);
6182 Qmodifier_cache
= intern ("modifier-cache");
6183 staticpro (&Qmodifier_cache
);
6185 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
6186 staticpro (&Qrecompute_lucid_menubar
);
6187 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
6188 staticpro (&Qactivate_menubar_hook
);
6190 Qpolling_period
= intern ("polling-period");
6191 staticpro (&Qpolling_period
);
6194 struct event_head
*p
;
6196 for (p
= head_table
;
6197 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
6200 *p
->var
= intern (p
->name
);
6202 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
6203 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
6207 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
6208 staticpro (&button_down_location
);
6212 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
6214 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
6215 for (i
= 0; i
< len
; i
++)
6216 if (modifier_names
[i
])
6217 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
6218 staticpro (&modifier_symbols
);
6221 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
6222 staticpro (&recent_keys
);
6224 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
6225 staticpro (&this_command_keys
);
6227 Qextended_command_history
= intern ("extended-command-history");
6228 Fset (Qextended_command_history
, Qnil
);
6229 staticpro (&Qextended_command_history
);
6231 kbd_buffer_frame_or_window
6232 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
6233 staticpro (&kbd_buffer_frame_or_window
);
6235 accent_key_syms
= Qnil
;
6236 staticpro (&accent_key_syms
);
6238 func_key_syms
= Qnil
;
6239 staticpro (&func_key_syms
);
6241 system_key_syms
= Qnil
;
6242 staticpro (&system_key_syms
);
6245 staticpro (&mouse_syms
);
6247 unread_switch_frame
= Qnil
;
6248 staticpro (&unread_switch_frame
);
6250 defsubr (&Sread_key_sequence
);
6251 defsubr (&Srecursive_edit
);
6253 defsubr (&Strack_mouse
);
6255 defsubr (&Sinput_pending_p
);
6256 defsubr (&Scommand_execute
);
6257 defsubr (&Srecent_keys
);
6258 defsubr (&Sthis_command_keys
);
6259 defsubr (&Ssuspend_emacs
);
6260 defsubr (&Sabort_recursive_edit
);
6261 defsubr (&Sexit_recursive_edit
);
6262 defsubr (&Srecursion_depth
);
6263 defsubr (&Stop_level
);
6264 defsubr (&Sdiscard_input
);
6265 defsubr (&Sopen_dribble_file
);
6266 defsubr (&Sset_input_mode
);
6267 defsubr (&Scurrent_input_mode
);
6268 defsubr (&Sexecute_extended_command
);
6270 DEFVAR_LISP ("last-command-char", &last_command_char
,
6271 "Last input event that was part of a command.");
6273 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
6274 "Last input event that was part of a command.");
6276 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
6277 "Last input event in a command, except for mouse menu events.\n\
6278 Mouse menus give back keys that don't look like mouse events;\n\
6279 this variable holds the actual mouse event that led to the menu,\n\
6280 so that you can determine whether the command was run by mouse or not.");
6282 DEFVAR_LISP ("last-input-char", &last_input_char
,
6283 "Last input event.");
6285 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
6286 "Last input event.");
6288 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
6289 "List of objects to be read as next command input events.");
6291 DEFVAR_INT ("unread-command-char", &unread_command_char
,
6292 "If not -1, an object to be read as next command input event.");
6294 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
6295 "Meta-prefix character code. Meta-foo as command input\n\
6296 turns into this character followed by foo.");
6297 XSETINT (meta_prefix_char
, 033);
6299 DEFVAR_LISP ("last-command", &last_command
,
6300 "The last command executed. Normally a symbol with a function definition,\n\
6301 but can be whatever was found in the keymap, or whatever the variable\n\
6302 `this-command' was set to by that command.\n\
6304 The value `mode-exit' is special; it means that the previous command\n\
6305 read an event that told it to exit, and it did so and unread that event.\n\
6306 In other words, the present command is the event that made the previous\n\
6309 The value `kill-region' is special; it means that the previous command\n\
6310 was a kill command.");
6311 last_command
= Qnil
;
6313 DEFVAR_LISP ("this-command", &this_command
,
6314 "The command now being executed.\n\
6315 The command can set this variable; whatever is put here\n\
6316 will be in `last-command' during the following command.");
6317 this_command
= Qnil
;
6319 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
6320 "*Number of keyboard input characters between auto-saves.\n\
6321 Zero means disable autosaving due to number of characters typed.");
6322 auto_save_interval
= 300;
6324 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
6325 "*Number of seconds idle time before auto-save.\n\
6326 Zero or nil means disable auto-saving due to idleness.\n\
6327 After auto-saving due to this many seconds of idle time,\n\
6328 Emacs also does a garbage collection if that seems to be warranted.");
6329 XSETFASTINT (Vauto_save_timeout
, 30);
6331 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
6332 "*Nonzero means echo unfinished commands after this many seconds of pause.");
6333 echo_keystrokes
= 1;
6335 DEFVAR_INT ("polling-period", &polling_period
,
6336 "*Interval between polling for input during Lisp execution.\n\
6337 The reason for polling is to make C-g work to stop a running program.\n\
6338 Polling is needed only when using X windows and SIGIO does not work.\n\
6339 Polling is automatically disabled in all other cases.");
6342 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
6343 "*Maximum time between mouse clicks to make a double-click.\n\
6344 Measured in milliseconds. nil means disable double-click recognition;\n\
6345 t means double-clicks have no time limit and are detected\n\
6346 by position only.");
6347 Vdouble_click_time
= make_number (500);
6349 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
6350 "*Non-nil means inhibit local map menu bar menus.");
6351 inhibit_local_menu_bar_menus
= 0;
6353 DEFVAR_INT ("num-input-keys", &num_input_keys
,
6354 "Number of complete keys read from the keyboard so far.");
6357 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
6358 "The frame in which the most recently read event occurred.\n\
6359 If the last event came from a keyboard macro, this is set to `macro'.");
6360 Vlast_event_frame
= Qnil
;
6362 DEFVAR_LISP ("help-char", &Vhelp_char
,
6363 "Character to recognize as meaning Help.\n\
6364 When it is read, do `(eval help-form)', and display result if it's a string.\n\
6365 If the value of `help-form' is nil, this char can be read normally.");
6366 XSETINT (Vhelp_char
, Ctl ('H'));
6368 DEFVAR_LISP ("help-form", &Vhelp_form
,
6369 "Form to execute when character `help-char' is read.\n\
6370 If the form returns a string, that string is displayed.\n\
6371 If `help-form' is nil, the help char is not recognized.");
6374 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
6375 "Command to run when `help-char' character follows a prefix key.\n\
6376 This command is used only when there is no actual binding\n\
6377 for that character after that prefix key.");
6378 Vprefix_help_command
= Qnil
;
6380 DEFVAR_LISP ("top-level", &Vtop_level
,
6381 "Form to evaluate when Emacs starts up.\n\
6382 Useful to set before you dump a modified Emacs.");
6385 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
6386 "String used as translate table for keyboard input, or nil.\n\
6387 Each character is looked up in this string and the contents used instead.\n\
6388 If string is of length N, character codes N and up are untranslated.");
6389 Vkeyboard_translate_table
= Qnil
;
6391 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
6392 "Keymap of key translations that can override keymaps.\n\
6393 This keymap works like `function-key-map', but comes after that,\n\
6394 and applies even for keys that have ordinary bindings.");
6395 Vkey_translation_map
= Qnil
;
6397 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
6398 "Non-nil means to always spawn a subshell instead of suspending,\n\
6399 even if the operating system has support for stopping a process.");
6402 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
6403 "Non-nil means prompt with menus when appropriate.\n\
6404 This is done when reading from a keymap that has a prompt string,\n\
6405 for elements that have prompt strings.\n\
6406 The menu is displayed on the screen\n\
6407 if X menus were enabled at configuration\n\
6408 time and the previous event was a mouse click prefix key.\n\
6409 Otherwise, menu prompting uses the echo area.");
6412 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
6413 "Character to see next line of menu prompt.\n\
6414 Type this character while in a menu prompt to rotate around the lines of it.");
6415 XSETINT (menu_prompt_more_char
, ' ');
6417 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
6418 "A mask of additional modifier keys to use with every keyboard character.\n\
6419 Emacs applies the modifiers of the character stored here to each keyboard\n\
6420 character it reads. For example, after evaluating the expression\n\
6421 (setq extra-keyboard-modifiers ?\C-x)\n\
6422 all input characters will have the control modifier applied to them.\n\
6424 Note that the character ?\C-@, equivalent to the integer zero, does\n\
6425 not count as a control character; rather, it counts as a character\n\
6426 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
6427 cancels any modification.");
6428 extra_keyboard_modifiers
= 0;
6430 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
6431 "If an editing command sets this to t, deactivate the mark afterward.\n\
6432 The command loop sets this to nil before each command,\n\
6433 and tests the value when the command returns.\n\
6434 Buffer modification stores t in this variable.");
6435 Vdeactivate_mark
= Qnil
;
6437 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
6438 "Temporary storage of pre-command-hook or post-command-hook.");
6439 Vcommand_hook_internal
= Qnil
;
6441 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
6442 "Normal hook run before each command is executed.\n\
6443 While the hook is run, its value is temporarily set to nil\n\
6444 to avoid an unbreakable infinite loop if a hook function gets an error.\n\
6445 As a result, a hook function cannot straightforwardly alter the value of\n\
6446 `pre-command-hook'. See the Emacs Lisp manual for a way of\n\
6447 implementing hook functions that alter the set of hook functions.");
6448 Vpre_command_hook
= Qnil
;
6450 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
6451 "Normal hook run after each command is executed.\n\
6452 While the hook is run, its value is temporarily set to nil\n\
6453 to avoid an unbreakable infinite loop if a hook function gets an error.\n\
6454 As a result, a hook function cannot straightforwardly alter the value of\n\
6455 `post-command-hook'. See the Emacs Lisp manual for a way of\n\
6456 implementing hook functions that alter the set of hook functions.");
6457 Vpost_command_hook
= Qnil
;
6459 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
6460 "t means menu bar, specified Lucid style, needs to be recomputed.");
6461 Vlucid_menu_bar_dirty_flag
= Qnil
;
6463 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
6464 "List of menu bar items to move to the end of the menu bar.\n\
6465 The elements of the list are event types that may have menu bar bindings.");
6466 Vmenu_bar_final_items
= Qnil
;
6468 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
6469 "Keymap that overrides all other local keymaps.\n\
6470 If this variable is non-nil, it is used as a keymap instead of the\n\
6471 buffer's local map, and the minor mode keymaps and text property keymaps.");
6472 Voverriding_local_map
= Qnil
;
6474 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
6475 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
6476 Otherwise, the menu bar continues to reflect the buffer's local map\n\
6477 and the minor mode maps regardless of `overriding-local-map'.");
6478 Voverriding_local_map_menu_flag
= Qnil
;
6481 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
6482 "*Non-nil means generate motion events for mouse motion.");
6485 DEFVAR_LISP ("system-key-alist", &Vsystem_key_alist
,
6486 "Alist of system-specific X windows key symbols.\n\
6487 Each element should have the form (N . SYMBOL) where N is the\n\
6488 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
6489 and SYMBOL is its name.");
6490 Vsystem_key_alist
= Qnil
;
6492 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
6493 "List of deferred actions to be performed at a later time.\n\
6494 The precise format isn't relevant here; we just check whether it is nil.");
6495 Vdeferred_action_list
= Qnil
;
6497 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
6498 "Function to call to handle deferred actions, after each command.\n\
6499 This function is called with no arguments after each command\n\
6500 whenever `deferred-action-list' is non-nil.");
6501 Vdeferred_action_function
= Qnil
;
6506 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
6507 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
6508 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
6509 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
6510 initial_define_key (meta_map
, 'x', "execute-extended-command");