1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
20 /* Allow config.h to undefine symbols found here. */
29 #include "termhooks.h"
36 #include "dispextern.h"
38 #include "intervals.h"
39 #include "blockinput.h"
48 #include <sys/ioctl.h>
50 #endif /* not MSDOS */
52 #include "syssignal.h"
55 /* This is to get the definitions of the XK_ symbols. */
60 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
65 /* Variables for blockinput.h: */
67 /* Non-zero if interrupt input is blocked right now. */
68 int interrupt_input_blocked
;
70 /* Nonzero means an input interrupt has arrived
71 during the current critical section. */
72 int interrupt_input_pending
;
76 /* 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
;
314 /* File in which we write all commands we read. */
317 /* Nonzero if input is available. */
320 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
321 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
325 extern char *pending_malloc_warning
;
327 /* Circular buffer for pre-read keyboard input. */
328 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
330 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
332 The interrupt-level event handlers will never enqueue an event on a
333 frame which is not in Vframe_list, and once an event is dequeued,
334 internal_last_event_frame or the event itself points to the frame.
337 But while the event is sitting in the queue, it's completely
338 unprotected. Suppose the user types one command which will run for
339 a while and then delete a frame, and then types another event at
340 the frame that will be deleted, before the command gets around to
341 it. Suppose there are no references to this frame elsewhere in
342 Emacs, and a GC occurs before the second event is dequeued. Now we
343 have an event referring to a freed frame, which will crash Emacs
346 Similar things happen when an event on a scroll bar is enqueued; the
347 window may be deleted while the event is in the queue.
349 So, we use this vector to protect the frame_or_window field in the
350 event queue. That way, they'll be dequeued as dead frames or
351 windows, but still valid lisp objects.
353 If kbd_buffer[i].kind != no_event, then
354 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
355 == kbd_buffer[i].frame_or_window. */
356 static Lisp_Object kbd_buffer_frame_or_window
;
358 /* Pointer to next available character in kbd_buffer.
359 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
360 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
361 next available char is in kbd_buffer[0]. */
362 static struct input_event
*kbd_fetch_ptr
;
364 /* Pointer to next place to store character in kbd_buffer. This
365 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
366 character should go in kbd_buffer[0]. */
367 static volatile struct input_event
*kbd_store_ptr
;
369 /* The above pair of variables forms a "queue empty" flag. When we
370 enqueue a non-hook event, we increment kbd_write_count. When we
371 dequeue a non-hook event, we increment kbd_read_count. We say that
372 there is input available iff the two counters are not equal.
374 Why not just have a flag set and cleared by the enqueuing and
375 dequeuing functions? Such a flag could be screwed up by interrupts
376 at inopportune times. */
378 /* If this flag is a frame, we check mouse_moved to see when the
379 mouse moves, and motion events will appear in the input stream.
380 Otherwise, mouse motion is ignored. */
381 static Lisp_Object do_mouse_tracking
;
383 /* The window system handling code should set this if the mouse has
384 moved since the last call to the mouse_position_hook. Calling that
385 hook should clear this. Code assumes that if this is set, it can
386 call mouse_position_hook to get the promised position, so don't set
387 it unless you're prepared to substantiate the claim! */
390 /* True iff there is an event in kbd_buffer, or if mouse tracking is
391 enabled and there is a new mouse position in the mouse movement
392 buffer. Note that if this is false, that doesn't mean that there
393 is readable input; all the events in the queue might be button-up
394 events, and do_mouse_tracking might be off. */
395 #define EVENT_QUEUES_EMPTY \
396 ((kbd_fetch_ptr == kbd_store_ptr) \
397 && (! FRAMEP (do_mouse_tracking) || !mouse_moved))
400 /* Symbols to head events. */
401 Lisp_Object Qmouse_movement
;
402 Lisp_Object Qscroll_bar_movement
;
403 Lisp_Object Qswitch_frame
;
404 Lisp_Object Qdelete_frame
;
406 /* Symbols to denote kinds of events. */
407 Lisp_Object Qfunction_key
;
408 Lisp_Object Qmouse_click
;
409 /* Lisp_Object Qmouse_movement; - also an event header */
411 /* Properties of event headers. */
412 Lisp_Object Qevent_kind
;
413 Lisp_Object Qevent_symbol_elements
;
415 Lisp_Object Qmenu_enable
;
417 /* An event header symbol HEAD may have a property named
418 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
419 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
420 mask of modifiers applied to it. If present, this is used to help
421 speed up parse_modifiers. */
422 Lisp_Object Qevent_symbol_element_mask
;
424 /* An unmodified event header BASE may have a property named
425 Qmodifier_cache, which is an alist mapping modifier masks onto
426 modified versions of BASE. If present, this helps speed up
428 Lisp_Object Qmodifier_cache
;
430 /* Symbols to use for parts of windows. */
431 Lisp_Object Qmode_line
;
432 Lisp_Object Qvertical_line
;
433 Lisp_Object Qvertical_scroll_bar
;
434 Lisp_Object Qmenu_bar
;
436 extern Lisp_Object Qmenu_enable
;
438 Lisp_Object
recursive_edit_unwind (), command_loop ();
439 Lisp_Object
Fthis_command_keys ();
440 Lisp_Object Qextended_command_history
;
442 Lisp_Object Qpolling_period
;
444 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
446 EMACS_TIME
*input_available_clear_time
;
448 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
449 Default is 1 if INTERRUPT_INPUT is defined. */
452 /* Nonzero while interrupts are temporarily deferred during redisplay. */
453 int interrupts_deferred
;
455 /* nonzero means use ^S/^Q for flow control. */
458 /* Allow m- file to inhibit use of FIONREAD. */
459 #ifdef BROKEN_FIONREAD
463 /* We are unable to use interrupts if FIONREAD is not available,
464 so flush SIGIO so we won't try. */
471 /* If we support X Windows, turn on the code to poll periodically
472 to detect C-g. It isn't actually used when doing interrupt input. */
473 #ifdef HAVE_X_WINDOWS
474 #define POLL_FOR_INPUT
477 /* Global variable declarations. */
479 /* Function for init_keyboard to call with no args (if nonzero). */
480 void (*keyboard_init_hook
) ();
482 static int read_avail_input ();
483 static void get_input_pending ();
484 static int readable_events ();
485 static Lisp_Object
read_char_x_menu_prompt ();
486 static Lisp_Object
read_char_minibuf_menu_prompt ();
487 static Lisp_Object
make_lispy_event ();
488 static Lisp_Object
make_lispy_movement ();
489 static Lisp_Object
modify_event_symbol ();
490 static Lisp_Object
make_lispy_switch_frame ();
492 /* > 0 if we are to echo keystrokes. */
493 static int echo_keystrokes
;
495 /* Nonzero means echo each character as typed. */
496 static int immediate_echo
;
498 /* The text we're echoing in the modeline - partial key sequences,
499 usually. '\0'-terminated. This really shouldn't have a fixed size. */
500 static char echobuf
[300];
502 /* Where to append more text to echobuf if we want to. */
503 static char *echoptr
;
505 /* If we have echoed a prompt string specified by the user,
506 this is its length. Otherwise this is -1. */
507 static int echo_after_prompt
;
509 /* Nonzero means don't try to suspend even if the operating system seems
511 static int cannot_suspend
;
513 #define min(a,b) ((a)<(b)?(a):(b))
514 #define max(a,b) ((a)>(b)?(a):(b))
516 /* Install the string STR as the beginning of the string of echoing,
517 so that it serves as a prompt for the next character.
518 Also start echoing. */
523 int len
= strlen (str
);
525 if (len
> sizeof echobuf
- 4)
526 len
= sizeof echobuf
- 4;
527 bcopy (str
, echobuf
, len
);
528 echoptr
= echobuf
+ len
;
531 echo_after_prompt
= len
;
536 /* Add C to the echo string, if echoing is going on.
537 C can be a character, which is printed prettily ("M-C-x" and all that
538 jazz), or a symbol, whose name is printed. */
543 extern char *push_key_description ();
552 /* If someone has passed us a composite event, use its head symbol. */
557 if (ptr
- echobuf
> sizeof echobuf
- 6)
560 ptr
= push_key_description (XINT (c
), ptr
);
562 else if (SYMBOLP (c
))
564 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
565 if (((ptr
- echobuf
) + name
->size
+ 4) > sizeof echobuf
)
567 bcopy (name
->data
, ptr
, name
->size
);
571 if (echoptr
== echobuf
&& EQ (c
, Vhelp_char
))
573 strcpy (ptr
, " (Type ? for further options)");
584 /* Temporarily add a dash to the end of the echo string if it's not
585 empty, so that it serves as a mini-prompt for the very next character. */
589 if (!immediate_echo
&& echoptr
== echobuf
)
591 /* Do nothing if we just printed a prompt. */
592 if (echo_after_prompt
== echoptr
- echobuf
)
594 /* Do nothing if not echoing at all. */
598 /* Put a dash at the end of the buffer temporarily,
599 but make it go away when the next character is added. */
606 /* Display the current echo string, and begin echoing if not already
616 for (i
= 0; i
< this_command_key_count
; i
++)
619 c
= XVECTOR (this_command_keys
)->contents
[i
];
620 if (! (EVENT_HAS_PARAMETERS (c
)
621 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
631 if (waiting_for_input
&& !NILP (Vquit_flag
))
632 quit_throw_to_read_char ();
635 /* Turn off echoing, for the start of a new command. */
641 echo_after_prompt
= -1;
644 /* Return the length of the current echo string. */
649 return echoptr
- echobuf
;
652 /* Truncate the current echo message to its first LEN chars.
653 This and echo_char get used by read_key_sequence when the user
654 switches frames while entering a key sequence. */
661 echoptr
= echobuf
+ len
;
662 truncate_echo_area (len
);
666 /* Functions for manipulating this_command_keys. */
668 add_command_key (key
)
671 int size
= XVECTOR (this_command_keys
)->size
;
673 if (this_command_key_count
>= size
)
675 Lisp_Object new_keys
;
677 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
678 bcopy (XVECTOR (this_command_keys
)->contents
,
679 XVECTOR (new_keys
)->contents
,
680 size
* sizeof (Lisp_Object
));
682 this_command_keys
= new_keys
;
685 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
691 int count
= specpdl_ptr
- specpdl
;
694 if (command_loop_level
> 0)
696 specbind (Qstandard_output
, Qt
);
697 specbind (Qstandard_input
, Qt
);
700 val
= command_loop ();
702 Fsignal (Qquit
, Qnil
);
704 return unbind_to (count
, Qnil
);
707 /* When an auto-save happens, record the "time", and don't do again soon. */
711 last_auto_save
= num_nonmacro_input_chars
;
714 /* Make an auto save happen as soon as possible at command level. */
716 force_auto_save_soon ()
718 last_auto_save
= - auto_save_interval
- 1;
720 record_asynch_buffer_change ();
723 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
724 "Invoke the editor command loop recursively.\n\
725 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
726 that tells this function to return.\n\
727 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
728 This function is called by the editor initialization to begin editing.")
731 int count
= specpdl_ptr
- specpdl
;
734 command_loop_level
++;
735 update_mode_lines
= 1;
737 record_unwind_protect (recursive_edit_unwind
,
739 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
743 return unbind_to (count
, Qnil
);
747 recursive_edit_unwind (buffer
)
751 Fset_buffer (buffer
);
753 command_loop_level
--;
754 update_mode_lines
= 1;
762 Vstandard_output
= Qt
;
763 Vstandard_input
= Qt
;
764 Vexecuting_macro
= Qnil
;
765 cmd_error_internal (data
, 0);
769 Vinhibit_quit
= Qnil
;
771 return make_number (0);
774 cmd_error_internal (data
, context
)
778 Lisp_Object errmsg
, tail
, errname
, file_error
;
785 echo_area_glyphs
= 0;
787 /* If the window system or terminal frame hasn't been initialized
788 yet, or we're not interactive, it's best to dump this message out
789 to stderr and exit. */
790 if (! FRAME_MESSAGE_BUF (selected_frame
)
792 stream
= Qexternal_debugging_output
;
801 write_string_1 (context
, -1, stream
);
803 errname
= Fcar (data
);
805 if (EQ (errname
, Qerror
))
808 if (!CONSP (data
)) data
= Qnil
;
809 errmsg
= Fcar (data
);
814 errmsg
= Fget (errname
, Qerror_message
);
815 file_error
= Fmemq (Qfile_error
,
816 Fget (errname
, Qerror_conditions
));
819 /* Print an error message including the data items.
820 This is done by printing it into a scratch buffer
821 and then making a copy of the text in the buffer. */
823 if (!CONSP (data
)) data
= Qnil
;
827 /* For file-error, make error message by concatenating
828 all the data items. They are all strings. */
829 if (!NILP (file_error
) && !NILP (tail
))
830 errmsg
= XCONS (tail
)->car
, tail
= XCONS (tail
)->cdr
;
832 if (STRINGP (errmsg
))
833 Fprinc (errmsg
, stream
);
835 write_string_1 ("peculiar error", -1, stream
);
837 for (i
= 0; CONSP (tail
); tail
= Fcdr (tail
), i
++)
839 write_string_1 (i
? ", " : ": ", 2, stream
);
840 if (!NILP (file_error
))
841 Fprinc (Fcar (tail
), stream
);
843 Fprin1 (Fcar (tail
), stream
);
847 /* If the window system or terminal frame hasn't been initialized
848 yet, or we're in -batch mode, this error should cause Emacs to exit. */
849 if (! FRAME_MESSAGE_BUF (selected_frame
)
853 Fkill_emacs (make_number (-1));
857 Lisp_Object
command_loop_1 ();
858 Lisp_Object
command_loop_2 ();
859 Lisp_Object
top_level_1 ();
861 /* Entry to editor-command-loop.
862 This level has the catches for exiting/returning to editor command loop.
863 It returns nil to exit recursive edit, t to abort it. */
868 if (command_loop_level
> 0 || minibuf_level
> 0)
870 return internal_catch (Qexit
, command_loop_2
, Qnil
);
875 internal_catch (Qtop_level
, top_level_1
, Qnil
);
876 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
878 /* End of file in -batch run causes exit here. */
884 /* Here we catch errors in execution of commands within the
885 editing loop, and reenter the editing loop.
886 When there is an error, cmd_error runs and returns a non-nil
887 value to us. A value of nil means that cmd_loop_1 itself
888 returned due to end of file (or end of kbd macro). */
893 register Lisp_Object val
;
896 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
905 return Feval (Vtop_level
);
911 /* On entry to the outer level, run the startup file */
912 if (!NILP (Vtop_level
))
913 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
914 else if (!NILP (Vpurify_flag
))
915 message ("Bare impure Emacs (standard Lisp code not loaded)");
917 message ("Bare Emacs (standard Lisp code not loaded)");
921 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
922 "Exit all recursive editing levels.")
925 Fthrow (Qtop_level
, Qnil
);
928 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
929 "Exit from the innermost recursive edit or minibuffer.")
932 if (command_loop_level
> 0 || minibuf_level
> 0)
933 Fthrow (Qexit
, Qnil
);
935 error ("No recursive edit is in progress");
938 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
939 "Abort the command that requested this recursive edit or minibuffer input.")
942 if (command_loop_level
> 0 || minibuf_level
> 0)
945 error ("No recursive edit is in progress");
948 /* This is the actual command reading loop,
949 sans error-handling encapsulation. */
951 Lisp_Object
Fcommand_execute ();
952 static int read_key_sequence ();
953 static void safe_run_hooks ();
958 Lisp_Object cmd
, tem
;
961 Lisp_Object keybuf
[30];
966 struct buffer
*prev_buffer
;
969 Vdeactivate_mark
= Qnil
;
970 waiting_for_input
= 0;
975 this_command_key_count
= 0;
977 /* Make sure this hook runs after commands that get errors and
978 throw to top level. */
979 /* Note that the value cell will never directly contain nil
980 if the symbol is a local variable. */
981 if (!NILP (XSYMBOL (Qpost_command_hook
)->value
) && !NILP (Vrun_hooks
))
982 safe_run_hooks (Qpost_command_hook
);
984 if (!NILP (Vdeferred_action_list
))
985 call0 (Vdeferred_action_function
);
987 /* Do this after running Vpost_command_hook, for consistency. */
988 last_command
= this_command
;
992 /* Install chars successfully executed in kbd macro. */
994 if (defining_kbd_macro
&& NILP (Vprefix_arg
))
995 finalize_kbd_macro_chars ();
997 /* Make sure the current window's buffer is selected. */
998 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
999 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1001 /* Display any malloc warning that just came out. Use while because
1002 displaying one warning can cause another. */
1004 while (pending_malloc_warning
)
1005 display_malloc_warning ();
1009 Vdeactivate_mark
= Qnil
;
1011 /* If minibuffer on and echo area in use,
1012 wait 2 sec and redraw minibuffer. */
1014 if (minibuf_level
&& echo_area_glyphs
)
1016 /* Bind inhibit-quit to t so that C-g gets read in
1017 rather than quitting back to the minibuffer. */
1018 int count
= specpdl_ptr
- specpdl
;
1019 specbind (Qinhibit_quit
, Qt
);
1020 Fsit_for (make_number (2), Qnil
, Qnil
);
1021 unbind_to (count
, Qnil
);
1023 echo_area_glyphs
= 0;
1025 if (!NILP (Vquit_flag
))
1028 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1033 alloca (0); /* Cause a garbage collection now */
1034 /* Since we can free the most stuff here. */
1035 #endif /* C_ALLOCA */
1039 /* Select the frame that the last event came from. Usually,
1040 switch-frame events will take care of this, but if some lisp
1041 code swallows a switch-frame event, we'll fix things up here.
1042 Is this a good idea? */
1043 if (FRAMEP (internal_last_event_frame
)
1044 && XFRAME (internal_last_event_frame
) != selected_frame
)
1045 Fselect_frame (internal_last_event_frame
, Qnil
);
1048 /* If it has changed current-menubar from previous value,
1049 really recompute the menubar from the value. */
1050 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1051 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1052 call0 (Qrecompute_lucid_menubar
);
1054 /* Read next key sequence; i gets its length. */
1055 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), Qnil
);
1059 /* Now we have read a key sequence of length I,
1060 or else I is 0 and we found end of file. */
1062 if (i
== 0) /* End of file -- happens only in */
1063 return Qnil
; /* a kbd macro, at the end. */
1064 /* -1 means read_key_sequence got a menu that was rejected.
1065 Just loop around and read another command. */
1069 this_command_key_count
= 0;
1073 last_command_char
= keybuf
[i
- 1];
1075 /* If the previous command tried to force a specific window-start,
1076 forget about that, in case this command moves point far away
1077 from that position. */
1078 XWINDOW (selected_window
)->force_start
= Qnil
;
1080 cmd
= read_key_sequence_cmd
;
1081 if (!NILP (Vexecuting_macro
))
1083 if (!NILP (Vquit_flag
))
1085 Vexecuting_macro
= Qt
;
1086 QUIT
; /* Make some noise. */
1087 /* Will return since macro now empty. */
1091 /* Do redisplay processing after this command except in special
1092 cases identified below that set no_redisplay to 1.
1093 (actually, there's currently no way to prevent the redisplay,
1094 and no_redisplay is ignored.
1095 Perhaps someday we will really implement it. */
1098 prev_buffer
= current_buffer
;
1099 prev_modiff
= MODIFF
;
1100 last_point_position
= PT
;
1101 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1103 /* Execute the command. */
1106 /* Note that the value cell will never directly contain nil
1107 if the symbol is a local variable. */
1108 if (!NILP (XSYMBOL (Qpre_command_hook
)->value
) && !NILP (Vrun_hooks
))
1109 safe_run_hooks (Qpre_command_hook
);
1111 if (NILP (this_command
))
1113 /* nil means key is undefined. */
1115 defining_kbd_macro
= 0;
1116 update_mode_lines
= 1;
1122 if (NILP (Vprefix_arg
) && ! no_direct
)
1124 /* Recognize some common commands in common situations and
1125 do them directly. */
1126 if (EQ (this_command
, Qforward_char
) && PT
< ZV
)
1128 struct Lisp_Vector
*dp
1129 = window_display_table (XWINDOW (selected_window
));
1130 lose
= FETCH_CHAR (PT
);
1133 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1134 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1135 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1136 && (lose
>= 0x20 && lose
< 0x7f)))
1137 : (lose
>= 0x20 && lose
< 0x7f))
1138 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1140 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1142 && !windows_or_buffers_changed
1143 && EQ (current_buffer
->selective_display
, Qnil
)
1144 && !detect_input_pending ()
1145 && NILP (Vexecuting_macro
))
1146 no_redisplay
= direct_output_forward_char (1);
1149 else if (EQ (this_command
, Qbackward_char
) && PT
> BEGV
)
1151 struct Lisp_Vector
*dp
1152 = window_display_table (XWINDOW (selected_window
));
1154 lose
= FETCH_CHAR (PT
);
1156 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1157 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1158 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1159 && (lose
>= 0x20 && lose
< 0x7f)))
1160 : (lose
>= 0x20 && lose
< 0x7f))
1161 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1163 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1165 && !windows_or_buffers_changed
1166 && EQ (current_buffer
->selective_display
, Qnil
)
1167 && !detect_input_pending ()
1168 && NILP (Vexecuting_macro
))
1169 no_redisplay
= direct_output_forward_char (-1);
1172 else if (EQ (this_command
, Qself_insert_command
)
1173 /* Try this optimization only on ascii keystrokes. */
1174 && INTEGERP (last_command_char
))
1176 unsigned char c
= XINT (last_command_char
);
1179 if (NILP (Vexecuting_macro
)
1180 && !EQ (minibuf_window
, selected_window
))
1182 if (!nonundocount
|| nonundocount
>= 20)
1189 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1191 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1193 || MODIFF
<= current_buffer
->save_modified
1194 || windows_or_buffers_changed
1195 || !EQ (current_buffer
->selective_display
, Qnil
)
1196 || detect_input_pending ()
1197 || !NILP (Vexecuting_macro
));
1198 value
= internal_self_insert (c
, 0);
1205 && (PT
== ZV
|| FETCH_CHAR (PT
) == '\n'))
1207 struct Lisp_Vector
*dp
1208 = window_display_table (XWINDOW (selected_window
));
1215 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1218 /* Do it only for char codes
1219 that by default display as themselves. */
1220 if (lose
>= 0x20 && lose
<= 0x7e)
1221 no_redisplay
= direct_output_for_insert (lose
);
1223 else if (VECTORP (obj
)
1224 && XVECTOR (obj
)->size
== 1
1225 && (obj
= XVECTOR (obj
)->contents
[0],
1227 /* Insist face not specified in glyph. */
1228 && (XINT (obj
) & ((-1) << 8)) == 0)
1230 = direct_output_for_insert (XINT (obj
));
1234 if (lose
>= 0x20 && lose
<= 0x7e)
1235 no_redisplay
= direct_output_for_insert (lose
);
1242 /* Here for a command that isn't executed directly */
1245 if (NILP (Vprefix_arg
))
1247 Fcommand_execute (this_command
, Qnil
);
1252 /* Note that the value cell will never directly contain nil
1253 if the symbol is a local variable. */
1254 if (!NILP (XSYMBOL (Qpost_command_hook
)->value
) && !NILP (Vrun_hooks
))
1255 safe_run_hooks (Qpost_command_hook
);
1257 if (!NILP (Vdeferred_action_list
))
1258 call0 (Vdeferred_action_function
);
1260 /* If there is a prefix argument,
1261 1) We don't want last_command to be ``universal-argument''
1262 (that would be dumb), so don't set last_command,
1263 2) we want to leave echoing on so that the prefix will be
1264 echoed as part of this key sequence, so don't call
1266 3) we want to leave this_command_key_count non-zero, so that
1267 read_char will realize that it is re-reading a character, and
1268 not echo it a second time. */
1269 if (NILP (Vprefix_arg
))
1271 last_command
= this_command
;
1273 this_command_key_count
= 0;
1276 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1278 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1280 current_buffer
->mark_active
= Qnil
;
1281 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1283 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1284 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1289 /* If we get an error while running the hook, cause the hook variable
1290 to be nil. Also inhibit quits, so that C-g won't cause the hook
1291 to mysteriously evaporate. */
1293 safe_run_hooks (hook
)
1297 int count
= specpdl_ptr
- specpdl
;
1298 specbind (Qinhibit_quit
, Qt
);
1300 /* We read and set the variable with functions,
1301 in case it's buffer-local. */
1302 value
= Vcommand_hook_internal
= Fsymbol_value (hook
);
1304 call1 (Vrun_hooks
, Qcommand_hook_internal
);
1307 unbind_to (count
, Qnil
);
1310 /* Number of seconds between polling for input. */
1313 /* Nonzero means polling for input is temporarily suppressed. */
1314 int poll_suppress_count
;
1316 /* Nonzero if polling_for_input is actually being used. */
1317 int polling_for_input
;
1319 #ifdef POLL_FOR_INPUT
1321 /* Handle an alarm once each second and read pending input
1322 so as to handle a C-g if it comces in. */
1325 input_poll_signal ()
1327 if (interrupt_input_blocked
== 0
1328 && !waiting_for_input
)
1329 read_avail_input (0);
1330 signal (SIGALRM
, input_poll_signal
);
1331 alarm (polling_period
);
1336 /* Begin signals to poll for input, if they are appropriate.
1337 This function is called unconditionally from various places. */
1341 #ifdef POLL_FOR_INPUT
1342 if (read_socket_hook
&& !interrupt_input
)
1344 poll_suppress_count
--;
1345 if (poll_suppress_count
== 0)
1347 signal (SIGALRM
, input_poll_signal
);
1348 polling_for_input
= 1;
1349 alarm (polling_period
);
1355 /* Nonzero if we are using polling to handle input asynchronously. */
1358 input_polling_used ()
1360 #ifdef POLL_FOR_INPUT
1361 return read_socket_hook
&& !interrupt_input
;
1367 /* Turn off polling. */
1371 #ifdef POLL_FOR_INPUT
1372 if (read_socket_hook
&& !interrupt_input
)
1374 if (poll_suppress_count
== 0)
1376 polling_for_input
= 0;
1379 poll_suppress_count
++;
1384 /* Set the value of poll_suppress_count to COUNT
1385 and start or stop polling accordingly. */
1388 set_poll_suppress_count (count
)
1391 #ifdef POLL_FOR_INPUT
1392 if (count
== 0 && poll_suppress_count
!= 0)
1394 poll_suppress_count
= 1;
1397 else if (count
!= 0 && poll_suppress_count
== 0)
1401 poll_suppress_count
= count
;
1405 /* Bind polling_period to a value at least N.
1406 But don't decrease it. */
1408 bind_polling_period (n
)
1411 #ifdef POLL_FOR_INPUT
1412 int new = polling_period
;
1418 specbind (Qpolling_period
, make_number (new));
1419 /* Start a new alarm with the new period. */
1424 /* Applying the control modifier to CHARACTER. */
1429 /* Save the upper bits here. */
1430 int upper
= c
& ~0177;
1434 /* Everything in the columns containing the upper-case letters
1435 denotes a control character. */
1436 if (c
>= 0100 && c
< 0140)
1440 /* Set the shift modifier for a control char
1441 made from a shifted letter. But only for letters! */
1442 if (oc
>= 'A' && oc
<= 'Z')
1443 c
|= shift_modifier
;
1446 /* The lower-case letters denote control characters too. */
1447 else if (c
>= 'a' && c
<= 'z')
1450 /* Include the bits for control and shift
1451 only if the basic ASCII code can't indicate them. */
1455 /* Replace the high bits. */
1456 c
|= (upper
& ~ctrl_modifier
);
1463 /* Input of single characters from keyboard */
1465 Lisp_Object
print_help ();
1466 static Lisp_Object
kbd_buffer_get_event ();
1467 static void record_char ();
1469 /* read a character from the keyboard; call the redisplay if needed */
1470 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1471 -1 means do not do redisplay, but do do autosaving.
1474 /* The arguments MAPS and NMAPS are for menu prompting.
1475 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1477 PREV_EVENT is the previous input event, or nil if we are reading
1478 the first event of a key sequence.
1480 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1481 if we used a mouse menu to read the input, or zero otherwise. If
1482 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
1484 Value is t if we showed a menu and the user rejected it. */
1487 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1491 Lisp_Object prev_event
;
1492 int *used_mouse_menu
;
1494 register Lisp_Object c
;
1497 int key_already_recorded
= 0;
1498 Lisp_Object also_record
;
1501 if (CONSP (Vunread_command_events
))
1503 c
= XCONS (Vunread_command_events
)->car
;
1504 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1506 if (this_command_key_count
== 0)
1512 if (unread_command_char
!= -1)
1514 XSETINT (c
, unread_command_char
);
1515 unread_command_char
= -1;
1517 if (this_command_key_count
== 0)
1523 if (!NILP (Vexecuting_macro
))
1526 /* We set this to Qmacro; since that's not a frame, nobody will
1527 try to switch frames on us, and the selected window will
1530 Since this event came from a macro, it would be misleading to
1531 leave internal_last_event_frame set to wherever the last
1532 real event came from. Normally, a switch-frame event selects
1533 internal_last_event_frame after each command is read, but
1534 events read from a macro should never cause a new frame to be
1536 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1539 /* Exit the macro if we are at the end.
1540 Also, some things replace the macro with t
1541 to force an early exit. */
1542 if (EQ (Vexecuting_macro
, Qt
)
1543 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1549 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1550 if (STRINGP (Vexecuting_macro
)
1551 && (XINT (c
) & 0x80))
1552 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
1554 executing_macro_index
++;
1559 if (!NILP (unread_switch_frame
))
1561 c
= unread_switch_frame
;
1562 unread_switch_frame
= Qnil
;
1564 /* This event should make it into this_command_keys, and get echoed
1565 again, so we go to reread_first, rather than reread. */
1569 /* Don't bother updating menu bars while doing mouse tracking.
1570 We get events very rapidly then, and the menu bar won't be changing.
1571 We do update the menu bar once on entry to Ftrack_mouse. */
1572 if (commandflag
> 0 && !input_pending
&& !detect_input_pending ())
1573 prepare_menu_bars ();
1575 /* Save outer setjmp data, in case called recursively. */
1576 save_getcjmp (save_jump
);
1580 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1583 if (_setjmp (getcjmp
))
1585 XSETINT (c
, quit_char
);
1587 XSETFRAME (internal_last_event_frame
, selected_frame
);
1588 Vlast_event_frame
= internal_last_event_frame
;
1590 /* If we report the quit char as an event,
1591 don't do so more than once. */
1592 if (!NILP (Vinhibit_quit
))
1598 /* Message turns off echoing unless more keystrokes turn it on again. */
1599 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1602 /* If already echoing, continue. */
1605 /* Try reading a character via menu prompting in the minibuf.
1606 Try this before the sit-for, because the sit-for
1607 would do the wrong thing if we are supposed to do
1608 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1609 after a mouse event so don't try a minibuf menu. */
1611 if (nmaps
> 0 && INTERACTIVE
1612 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1613 /* Don't bring up a menu if we already have another event. */
1614 && NILP (Vunread_command_events
)
1615 && unread_command_char
< 0
1616 && !detect_input_pending ())
1618 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1621 key_already_recorded
= 1;
1626 /* If in middle of key sequence and minibuffer not active,
1627 start echoing if enough time elapses. */
1628 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1630 && echo_keystrokes
> 0
1631 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1635 /* After a mouse event, start echoing right away.
1636 This is because we are probably about to display a menu,
1637 and we don't want to delay before doing so. */
1638 if (EVENT_HAS_PARAMETERS (prev_event
))
1642 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1648 /* Maybe auto save due to number of keystrokes or idle time. */
1650 if (commandflag
!= 0
1651 && auto_save_interval
> 0
1652 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1653 && !detect_input_pending ())
1656 save_getcjmp (temp
);
1657 Fdo_auto_save (Qnil
, Qnil
);
1658 restore_getcjmp (temp
);
1661 /* Try reading using an X menu.
1662 This is never confused with reading using the minibuf
1663 because the recursive call of read_char in read_char_minibuf_menu_prompt
1664 does not pass on any keymaps. */
1665 if (nmaps
> 0 && INTERACTIVE
1666 && !NILP (prev_event
) && EVENT_HAS_PARAMETERS (prev_event
)
1667 /* Don't bring up a menu if we already have another event. */
1668 && NILP (Vunread_command_events
)
1669 && unread_command_char
< 0)
1670 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1672 /* Slow down auto saves logarithmically in size of current buffer,
1673 and garbage collect while we're at it. */
1674 if (INTERACTIVE
&& NILP (c
))
1676 int delay_level
, buffer_size
;
1678 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1679 last_non_minibuf_size
= Z
- BEG
;
1680 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1682 while (buffer_size
> 64)
1683 delay_level
++, buffer_size
-= buffer_size
>> 2;
1684 if (delay_level
< 4) delay_level
= 4;
1685 /* delay_level is 4 for files under around 50k, 7 at 100k,
1686 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1688 /* Auto save if enough time goes by without input. */
1689 if (commandflag
!= 0
1690 && num_nonmacro_input_chars
> last_auto_save
1691 && INTEGERP (Vauto_save_timeout
)
1692 && XINT (Vauto_save_timeout
) > 0)
1695 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1696 tem0
= sit_for (delay
, 0, 1, 1);
1700 save_getcjmp (temp
);
1701 Fdo_auto_save (Qnil
, Qnil
);
1702 restore_getcjmp (temp
);
1704 /* If we have auto-saved and there is still no input
1705 available, garbage collect if there has been enough
1706 consing going on to make it worthwhile. */
1707 if (!detect_input_pending ()
1708 && consing_since_gc
> gc_cons_threshold
/ 2)
1710 Fgarbage_collect ();
1711 /* prepare_menu_bars isn't safe here, but it should
1712 also be unnecessary. */
1719 /* Actually read a character, waiting if necessary. */
1722 c
= kbd_buffer_get_event ();
1725 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1727 prepare_menu_bars ();
1732 /* Terminate Emacs in batch mode if at eof. */
1733 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
1734 Fkill_emacs (make_number (1));
1738 /* Add in any extra modifiers, where appropriate. */
1739 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1740 || ((extra_keyboard_modifiers
& 0177) < ' '
1741 && (extra_keyboard_modifiers
& 0177) != 0))
1742 XSETINT (c
, make_ctrl_char (XINT (c
)));
1744 /* Transfer any other modifier bits directly from
1745 extra_keyboard_modifiers to c. Ignore the actual character code
1746 in the low 16 bits of extra_keyboard_modifiers. */
1747 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
1752 restore_getcjmp (save_jump
);
1756 /* Buffer switch events are only for internal wakeups
1757 so don't show them to the user. */
1761 if (key_already_recorded
)
1764 /* Wipe the echo area. */
1765 echo_area_glyphs
= 0;
1767 /* Handle things that only apply to characters. */
1770 /* If kbd_buffer_get_event gave us an EOF, return that. */
1774 if (STRINGP (Vkeyboard_translate_table
)
1775 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1776 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1779 /* If this event is a mouse click in the menu bar,
1780 return just menu-bar for now. Modify the mouse click event
1781 so we won't do this twice, then queue it up. */
1782 if (EVENT_HAS_PARAMETERS (c
)
1783 && CONSP (XCONS (c
)->cdr
)
1784 && CONSP (EVENT_START (c
))
1785 && CONSP (XCONS (EVENT_START (c
))->cdr
))
1789 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
1790 /* Handle menu-bar events:
1791 insert the dummy prefix event `menu-bar'. */
1792 if (EQ (posn
, Qmenu_bar
))
1794 /* Change menu-bar to (menu-bar) as the event "position". */
1795 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
1798 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
1804 if (! NILP (also_record
))
1805 record_char (also_record
);
1810 /* Don't echo mouse motion events. */
1811 if (! (EVENT_HAS_PARAMETERS (c
)
1812 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1815 if (! NILP (also_record
))
1816 echo_char (also_record
);
1819 /* Record this character as part of the current key. */
1820 add_command_key (c
);
1821 if (! NILP (also_record
))
1822 add_command_key (also_record
);
1824 /* Re-reading in the middle of a command */
1826 last_input_char
= c
;
1829 /* Process the help character specially if enabled */
1830 if (EQ (c
, Vhelp_char
) && !NILP (Vhelp_form
))
1833 count
= specpdl_ptr
- specpdl
;
1835 record_unwind_protect (Fset_window_configuration
,
1836 Fcurrent_window_configuration (Qnil
));
1838 tem0
= Feval (Vhelp_form
);
1840 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1844 c
= read_char (0, 0, 0, Qnil
, 0);
1845 while (BUFFERP (c
));
1846 /* Remove the help from the frame */
1847 unbind_to (count
, Qnil
);
1848 prepare_menu_bars ();
1850 if (EQ (c
, make_number (040)))
1854 c
= read_char (0, 0, 0, Qnil
, 0);
1855 while (BUFFERP (c
));
1862 /* Record the input event C in various ways. */
1869 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1870 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1871 recent_keys_index
= 0;
1873 /* Write c to the dribble file. If c is a lispy event, write
1874 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1875 If you, dear reader, have a better idea, you've got the source. :-) */
1880 if (XUINT (c
) < 0x100)
1881 putc (XINT (c
), dribble
);
1883 fprintf (dribble
, " 0x%x", XUINT (c
));
1887 Lisp_Object dribblee
;
1889 /* If it's a structured event, take the event header. */
1890 dribblee
= EVENT_HEAD (c
);
1892 if (SYMBOLP (dribblee
))
1894 putc ('<', dribble
);
1895 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1896 XSYMBOL (dribblee
)->name
->size
,
1898 putc ('>', dribble
);
1905 store_kbd_macro_char (c
);
1907 num_nonmacro_input_chars
++;
1914 Fprinc (object
, Qnil
);
1918 /* Copy out or in the info on where C-g should throw to.
1919 This is used when running Lisp code from within get_char,
1920 in case get_char is called recursively.
1921 See read_process_output. */
1926 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1929 restore_getcjmp (temp
)
1932 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1936 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1937 of this function. */
1940 tracking_off (old_value
)
1941 Lisp_Object old_value
;
1943 if (! XFASTINT (old_value
))
1945 do_mouse_tracking
= Qnil
;
1947 /* Redisplay may have been preempted because there was input
1948 available, and it assumes it will be called again after the
1949 input has been processed. If the only input available was
1950 the sort that we have just disabled, then we need to call
1952 if (!readable_events ())
1954 prepare_menu_bars ();
1955 redisplay_preserve_echo_area ();
1956 get_input_pending (&input_pending
);
1961 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1962 "Evaluate BODY with mouse movement events enabled.\n\
1963 Within a `track-mouse' form, mouse motion generates input events that\n\
1964 you can read with `read-event'.\n\
1965 Normally, mouse motion is ignored.")
1969 int count
= specpdl_ptr
- specpdl
;
1972 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1974 if (!input_pending
&& !detect_input_pending ())
1975 prepare_menu_bars ();
1977 XSETFRAME (do_mouse_tracking
, selected_frame
);
1979 val
= Fprogn (args
);
1980 return unbind_to (count
, val
);
1983 /* Low level keyboard/mouse input.
1984 kbd_buffer_store_event places events in kbd_buffer, and
1985 kbd_buffer_get_event retrieves them.
1986 mouse_moved indicates when the mouse has moved again, and
1987 *mouse_position_hook provides the mouse position. */
1989 /* Return true iff there are any events in the queue that read-char
1990 would return. If this returns false, a read-char would block. */
1994 return ! EVENT_QUEUES_EMPTY
;
1997 /* Set this for debugging, to have a way to get out */
2000 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
2003 kbd_buffer_store_event (event
)
2004 register struct input_event
*event
;
2006 if (event
->kind
== no_event
)
2009 if (event
->kind
== ascii_keystroke
)
2011 register int c
= event
->code
& 0377;
2013 if (event
->modifiers
& ctrl_modifier
)
2014 c
= make_ctrl_char (c
);
2016 c
|= (event
->modifiers
2017 & (meta_modifier
| alt_modifier
2018 | hyper_modifier
| super_modifier
));
2022 extern SIGTYPE
interrupt_signal ();
2025 /* If this results in a quit_char being returned to Emacs as
2026 input, set Vlast_event_frame properly. If this doesn't
2027 get returned to Emacs as an event, the next event read
2028 will set Vlast_event_frame again, so this is safe to do. */
2032 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
2034 internal_last_event_frame
= event
->frame_or_window
;
2036 internal_last_event_frame
= focus
;
2037 Vlast_event_frame
= internal_last_event_frame
;
2041 last_event_timestamp
= event
->timestamp
;
2042 interrupt_signal ();
2046 if (c
&& c
== stop_character
)
2053 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
2054 kbd_store_ptr
= kbd_buffer
;
2056 /* Don't let the very last slot in the buffer become full,
2057 since that would make the two pointers equal,
2058 and that is indistinguishable from an empty buffer.
2059 Discard the event if it would fill the last slot. */
2060 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
2062 kbd_store_ptr
->kind
= event
->kind
;
2063 if (event
->kind
== selection_request_event
)
2065 /* We must not use the ordinary copying code for this case,
2066 since `part' is an enum and copying it might not copy enough
2068 bcopy (event
, kbd_store_ptr
, sizeof (*event
));
2072 kbd_store_ptr
->code
= event
->code
;
2073 kbd_store_ptr
->part
= event
->part
;
2074 kbd_store_ptr
->frame_or_window
= event
->frame_or_window
;
2075 kbd_store_ptr
->modifiers
= event
->modifiers
;
2076 kbd_store_ptr
->x
= event
->x
;
2077 kbd_store_ptr
->y
= event
->y
;
2078 kbd_store_ptr
->timestamp
= event
->timestamp
;
2080 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
2082 = event
->frame_or_window
);
2088 /* Read one event from the event buffer, waiting if necessary.
2089 The value is a Lisp object representing the event.
2090 The value is nil for an event that should be ignored,
2091 or that was handled here.
2092 We always read and discard one event. */
2095 kbd_buffer_get_event ()
2107 /* Wait until there is input available. */
2110 if (!EVENT_QUEUES_EMPTY
)
2113 /* If the quit flag is set, then read_char will return
2114 quit_char, so that counts as "available input." */
2115 if (!NILP (Vquit_flag
))
2116 quit_throw_to_read_char ();
2118 /* One way or another, wait until input is available; then, if
2119 interrupt handlers have not read it, read it now. */
2122 wait_for_kbd_input ();
2124 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2128 if (EVENT_QUEUES_EMPTY
)
2130 Lisp_Object minus_one
;
2132 XSETINT (minus_one
, -1);
2133 wait_reading_process_input (0, 0, minus_one
, 1);
2135 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
2136 /* Pass 1 for EXPECT since we just waited to have input. */
2137 read_avail_input (1);
2139 #endif /* not VMS */
2142 /* At this point, we know that there is a readable event available
2143 somewhere. If the event queue is empty, then there must be a
2144 mouse movement enabled and available. */
2145 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2147 struct input_event
*event
;
2149 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2153 last_event_timestamp
= event
->timestamp
;
2157 /* These two kinds of events get special handling
2158 and don't actually appear to the command loop.
2159 We return nil for them. */
2160 if (event
->kind
== selection_request_event
)
2163 x_handle_selection_request (event
);
2164 kbd_fetch_ptr
= event
+ 1;
2166 /* We're getting selection request events, but we don't have
2172 else if (event
->kind
== selection_clear_event
)
2175 x_handle_selection_clear (event
);
2176 kbd_fetch_ptr
= event
+ 1;
2178 /* We're getting selection request events, but we don't have
2184 else if (event
->kind
== delete_window_event
)
2186 /* Make an event (delete-frame (FRAME)). */
2187 obj
= Fcons (event
->frame_or_window
, Qnil
);
2188 obj
= Fcons (intern ("delete-frame"), Fcons (obj
, Qnil
));
2189 kbd_fetch_ptr
= event
+ 1;
2192 else if (event
->kind
== menu_bar_event
)
2194 /* The event value is in the frame_or_window slot. */
2195 obj
= event
->frame_or_window
;
2196 kbd_fetch_ptr
= event
+ 1;
2198 else if (event
->kind
== buffer_switch_event
)
2200 /* The value doesn't matter here; only the type is tested. */
2201 XSETBUFFER (obj
, current_buffer
);
2202 kbd_fetch_ptr
= event
+ 1;
2204 /* Just discard these, by returning nil.
2205 (They shouldn't be found in the buffer,
2206 but on some machines it appears they do show up.) */
2207 else if (event
->kind
== no_event
)
2208 kbd_fetch_ptr
= event
+ 1;
2210 /* If this event is on a different frame, return a switch-frame this
2211 time, and leave the event in the queue for next time. */
2218 frame
= event
->frame_or_window
;
2219 if (WINDOWP (frame
))
2220 frame
= WINDOW_FRAME (XWINDOW (frame
));
2222 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2226 if (! EQ (frame
, internal_last_event_frame
)
2227 && XFRAME (frame
) != selected_frame
)
2228 obj
= make_lispy_switch_frame (frame
);
2229 internal_last_event_frame
= frame
;
2230 #endif /* MULTI_FRAME */
2232 /* If we didn't decide to make a switch-frame event, go ahead
2233 and build a real event from the queue entry. */
2237 obj
= make_lispy_event (event
);
2239 /* Wipe out this event, to catch bugs. */
2240 event
->kind
= no_event
;
2241 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
2244 kbd_fetch_ptr
= event
+ 1;
2248 /* Try generating a mouse motion event. */
2249 else if (FRAMEP (do_mouse_tracking
) && mouse_moved
)
2251 FRAME_PTR f
= XFRAME (do_mouse_tracking
);
2252 Lisp_Object bar_window
;
2253 enum scroll_bar_part part
;
2257 /* Note that this uses F to determine which display to look at.
2258 If there is no valid info, it does not store anything
2259 so x remains nil. */
2261 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
2266 /* Decide if we should generate a switch-frame event. Don't
2267 generate switch-frame events for motion outside of all Emacs
2273 frame
= FRAME_FOCUS_FRAME (f
);
2275 XSETFRAME (frame
, f
);
2277 if (! EQ (frame
, internal_last_event_frame
)
2278 && XFRAME (frame
) != selected_frame
)
2279 obj
= make_lispy_switch_frame (frame
);
2280 internal_last_event_frame
= frame
;
2284 #if defined (MULTI_FRAME) || defined (HAVE_MOUSE)
2285 /* If we didn't decide to make a switch-frame event, go ahead and
2286 return a mouse-motion event. */
2287 if (!NILP (x
) && NILP (obj
))
2288 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2292 /* We were promised by the above while loop that there was
2293 something for us to read! */
2296 input_pending
= readable_events ();
2299 Vlast_event_frame
= internal_last_event_frame
;
2305 /* Process any events that are not user-visible,
2306 then return, without reading any user-visible events. */
2311 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2313 struct input_event
*event
;
2315 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2319 last_event_timestamp
= event
->timestamp
;
2321 /* These two kinds of events get special handling
2322 and don't actually appear to the command loop. */
2323 if (event
->kind
== selection_request_event
)
2326 x_handle_selection_request (event
);
2327 kbd_fetch_ptr
= event
+ 1;
2329 /* We're getting selection request events, but we don't have
2335 else if (event
->kind
== selection_clear_event
)
2338 x_handle_selection_clear (event
);
2339 kbd_fetch_ptr
= event
+ 1;
2341 /* We're getting selection request events, but we don't have
2350 get_input_pending (&input_pending
);
2353 /* Caches for modify_event_symbol. */
2354 static Lisp_Object accent_key_syms
;
2355 static Lisp_Object system_key_syms
;
2356 static Lisp_Object func_key_syms
;
2357 static Lisp_Object mouse_syms
;
2359 Lisp_Object Vsystem_key_alist
;
2361 /* This is a list of keysym codes for special "accent" characters.
2362 It parallels lispy_accent_keys. */
2364 static int lispy_accent_codes
[] =
2366 #ifdef XK_dead_circumflex
2371 #ifdef XK_dead_grave
2376 #ifdef XK_dead_tilde
2381 #ifdef XK_dead_diaeresis
2386 #ifdef XK_dead_macron
2391 #ifdef XK_dead_degree
2396 #ifdef XK_dead_acute
2401 #ifdef XK_dead_cedilla
2406 #ifdef XK_dead_breve
2411 #ifdef XK_dead_ogonek
2416 #ifdef XK_dead_caron
2421 #ifdef XK_dead_doubleacute
2422 XK_dead_doubleacute
,
2426 #ifdef XK_dead_abovedot
2433 /* This is a list of Lisp names for special "accent" characters.
2434 It parallels lispy_accent_codes. */
2436 static char *lispy_accent_keys
[] =
2453 /* You'll notice that this table is arranged to be conveniently
2454 indexed by X Windows keysym values. */
2455 static char *lispy_function_keys
[] =
2457 /* X Keysym value */
2459 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2467 0, 0, 0, /* 0xff10 */
2469 0, 0, 0, 0, 0, 0, 0,
2472 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2473 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2474 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2476 "home", /* 0xff50 */ /* IsCursorKey */
2487 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2498 "break", /* 0xff6b */
2500 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
2502 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2503 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2504 0, 0, 0, 0, 0, 0, 0, 0,
2505 "kp-tab", /* 0xff89 */
2507 "kp-enter", /* 0xff8d */
2509 "kp-f1", /* 0xff91 */
2513 "kp-home", /* 0xff95 */
2518 "kp-prior", /* kp-page-up */
2519 "kp-next", /* kp-page-down */
2525 0, 0, 0, 0, 0, 0, 0, 0, 0,
2526 "kp-multiply", /* 0xffaa */
2531 "kp-divide", /* 0xffaf */
2532 "kp-0", /* 0xffb0 */
2533 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2536 "kp-equal", /* 0xffbd */
2537 "f1", /* 0xffbe */ /* IsFunctionKey */
2539 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2540 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2541 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2542 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2543 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2544 0, 0, 0, 0, 0, 0, 0, 0,
2545 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2546 0, 0, 0, 0, 0, 0, 0, "delete"
2549 static char *lispy_mouse_names
[] =
2551 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2554 /* Scroll bar parts. */
2555 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2557 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2558 Lisp_Object
*scroll_bar_parts
[] = {
2559 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2563 /* A vector, indexed by button number, giving the down-going location
2564 of currently depressed buttons, both scroll bar and non-scroll bar.
2566 The elements have the form
2567 (BUTTON-NUMBER MODIFIER-MASK . REST)
2568 where REST is the cdr of a position as it would be reported in the event.
2570 The make_lispy_event function stores positions here to tell the
2571 difference between click and drag events, and to store the starting
2572 location to be included in drag events. */
2574 static Lisp_Object button_down_location
;
2576 /* Information about the most recent up-going button event: Which
2577 button, what location, and what time. */
2579 static int last_mouse_button
;
2580 static int last_mouse_x
;
2581 static int last_mouse_y
;
2582 static unsigned long button_down_time
;
2584 /* The maximum time between clicks to make a double-click,
2585 or Qnil to disable double-click detection,
2586 or Qt for no time limit. */
2587 Lisp_Object Vdouble_click_time
;
2589 /* The number of clicks in this multiple-click. */
2591 int double_click_count
;
2593 #ifdef USE_X_TOOLKIT
2594 extern Lisp_Object
map_event_to_object ();
2595 #endif /* USE_X_TOOLKIT */
2597 /* Given a struct input_event, build the lisp event which represents
2598 it. If EVENT is 0, build a mouse movement event from the mouse
2599 movement buffer, which should have a movement event in it.
2601 Note that events must be passed to this function in the order they
2602 are received; this function stores the location of button presses
2603 in order to build drag events when the button is released. */
2606 make_lispy_event (event
)
2607 struct input_event
*event
;
2611 #ifdef SWITCH_ENUM_BUG
2612 switch ((int) event
->kind
)
2614 switch (event
->kind
)
2617 /* A simple keystroke. */
2618 case ascii_keystroke
:
2620 Lisp_Object lispy_c
;
2621 int c
= event
->code
& 0377;
2622 /* Turn ASCII characters into control characters
2624 if (event
->modifiers
& ctrl_modifier
)
2625 c
= make_ctrl_char (c
);
2627 /* Add in the other modifier bits. We took care of ctrl_modifier
2628 just above, and the shift key was taken care of by the X code,
2629 and applied to control characters by make_ctrl_char. */
2630 c
|= (event
->modifiers
2631 & (meta_modifier
| alt_modifier
2632 | hyper_modifier
| super_modifier
));
2633 button_down_time
= 0;
2634 XSETFASTINT (lispy_c
, c
);
2638 /* A function key. The symbol may need to have modifier prefixes
2640 case non_ascii_keystroke
:
2641 button_down_time
= 0;
2643 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
2644 if (event
->code
== lispy_accent_codes
[i
])
2645 return modify_event_symbol (i
,
2647 Qfunction_key
, Qnil
,
2648 lispy_accent_keys
, &accent_key_syms
,
2649 (sizeof (lispy_accent_keys
)
2650 / sizeof (lispy_accent_keys
[0])));
2652 /* Handle system-specific keysyms. */
2653 if (event
->code
& (1 << 28))
2655 /* We need to use an alist rather than a vector as the cache
2656 since we can't make a vector long enuf. */
2657 if (NILP (system_key_syms
))
2658 system_key_syms
= Fcons (Qnil
, Qnil
);
2659 return modify_event_symbol (event
->code
& 0xffffff,
2661 Qfunction_key
, Vsystem_key_alist
,
2662 0, &system_key_syms
, 0xffffff);
2665 return modify_event_symbol (event
->code
- 0xff00,
2667 Qfunction_key
, Qnil
,
2668 lispy_function_keys
, &func_key_syms
,
2669 (sizeof (lispy_function_keys
)
2670 / sizeof (lispy_function_keys
[0])));
2673 #if defined (MULTI_FRAME) || defined (HAVE_MOUSE)
2674 /* A mouse click. Figure out where it is, decide whether it's
2675 a press, click or drag, and build the appropriate structure. */
2677 case scroll_bar_click
:
2679 int button
= event
->code
;
2681 Lisp_Object position
;
2682 Lisp_Object
*start_pos_ptr
;
2683 Lisp_Object start_pos
;
2685 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2688 /* Build the position as appropriate for this mouse click. */
2689 if (event
->kind
== mouse_click
)
2692 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2697 /* Ignore mouse events that were made on frame that
2698 have been deleted. */
2699 if (! FRAME_LIVE_P (f
))
2702 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
2703 &column
, &row
, 0, 0);
2705 #ifdef USE_X_TOOLKIT
2706 if (FRAME_EXTERNAL_MENU_BAR (f
) && XINT (event
->y
) == -1)
2708 if (row
< FRAME_MENU_BAR_LINES (f
))
2711 Lisp_Object items
, item
;
2715 /* Activate the menu bar on the down event. If the
2716 up event comes in before the menu code can deal with it,
2718 if (! (event
->modifiers
& down_modifier
))
2721 #ifndef USE_X_TOOLKIT
2723 items
= FRAME_MENU_BAR_ITEMS (f
);
2724 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 3)
2726 Lisp_Object pos
, string
;
2727 string
= XVECTOR (items
)->contents
[i
+ 1];
2728 pos
= XVECTOR (items
)->contents
[i
+ 2];
2731 if (column
>= XINT (pos
)
2732 && column
< XINT (pos
) + XSTRING (string
)->size
)
2734 item
= XVECTOR (items
)->contents
[i
];
2738 #endif /* not USE_X_TOOLKIT */
2741 = Fcons (event
->frame_or_window
,
2743 Fcons (Fcons (event
->x
, event
->y
),
2744 Fcons (make_number (event
->timestamp
),
2747 return Fcons (item
, Fcons (position
, Qnil
));
2750 window
= window_from_coordinates (f
, column
, row
, &part
);
2752 if (!WINDOWP (window
))
2754 window
= event
->frame_or_window
;
2759 int pixcolumn
, pixrow
;
2760 column
-= XINT (XWINDOW (window
)->left
);
2761 row
-= XINT (XWINDOW (window
)->top
);
2762 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
2763 XSETINT (event
->x
, pixcolumn
);
2764 XSETINT (event
->y
, pixrow
);
2769 posn
= Qvertical_line
;
2772 buffer_posn_from_coords (XWINDOW (window
),
2779 Fcons (Fcons (event
->x
, event
->y
),
2780 Fcons (make_number (event
->timestamp
),
2786 Lisp_Object portion_whole
;
2789 window
= event
->frame_or_window
;
2790 portion_whole
= Fcons (event
->x
, event
->y
);
2791 part
= *scroll_bar_parts
[(int) event
->part
];
2795 Fcons (Qvertical_scroll_bar
,
2796 Fcons (portion_whole
,
2797 Fcons (make_number (event
->timestamp
),
2798 Fcons (part
, Qnil
)))));
2801 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2803 start_pos
= *start_pos_ptr
;
2804 *start_pos_ptr
= Qnil
;
2806 is_double
= (button
== last_mouse_button
2807 && XINT (event
->x
) == last_mouse_x
2808 && XINT (event
->y
) == last_mouse_y
2809 && button_down_time
!= 0
2810 && (EQ (Vdouble_click_time
, Qt
)
2811 || (INTEGERP (Vdouble_click_time
)
2812 && ((int)(event
->timestamp
- button_down_time
)
2813 < XINT (Vdouble_click_time
)))));
2814 last_mouse_button
= button
;
2815 last_mouse_x
= XINT (event
->x
);
2816 last_mouse_y
= XINT (event
->y
);
2818 /* If this is a button press, squirrel away the location, so
2819 we can decide later whether it was a click or a drag. */
2820 if (event
->modifiers
& down_modifier
)
2824 double_click_count
++;
2825 event
->modifiers
|= ((double_click_count
> 2)
2830 double_click_count
= 1;
2831 button_down_time
= event
->timestamp
;
2832 *start_pos_ptr
= Fcopy_alist (position
);
2835 /* Now we're releasing a button - check the co-ordinates to
2836 see if this was a click or a drag. */
2837 else if (event
->modifiers
& up_modifier
)
2839 /* If we did not see a down before this up,
2840 ignore the up. Probably this happened because
2841 the down event chose a menu item.
2842 It would be an annoyance to treat the release
2843 of the button that chose the menu item
2844 as a separate event. */
2846 if (!CONSP (start_pos
))
2849 event
->modifiers
&= ~up_modifier
;
2850 #if 0 /* Formerly we treated an up with no down as a click event. */
2851 if (!CONSP (start_pos
))
2852 event
->modifiers
|= click_modifier
;
2856 /* The third element of every position should be the (x,y)
2860 down
= Fnth (make_number (2), start_pos
);
2861 if (EQ (event
->x
, XCONS (down
)->car
)
2862 && EQ (event
->y
, XCONS (down
)->cdr
))
2864 if (is_double
&& double_click_count
> 1)
2865 event
->modifiers
|= ((double_click_count
> 2)
2869 event
->modifiers
|= click_modifier
;
2873 button_down_time
= 0;
2874 event
->modifiers
|= drag_modifier
;
2879 /* Every mouse event should either have the down_modifier or
2880 the up_modifier set. */
2884 /* Get the symbol we should use for the mouse click. */
2887 head
= modify_event_symbol (button
,
2890 lispy_mouse_names
, &mouse_syms
,
2891 (sizeof (lispy_mouse_names
)
2892 / sizeof (lispy_mouse_names
[0])));
2893 if (event
->modifiers
& drag_modifier
)
2898 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2901 Fcons (make_number (double_click_count
),
2909 #endif /* MULTI_FRAME or HAVE_MOUSE */
2911 /* The 'kind' field of the event is something we don't recognize. */
2917 #if defined (MULTI_FRAME) || defined (HAVE_MOUSE)
2920 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2922 Lisp_Object bar_window
;
2923 enum scroll_bar_part part
;
2928 /* Is it a scroll bar movement? */
2929 if (frame
&& ! NILP (bar_window
))
2931 Lisp_Object part_sym
;
2933 part_sym
= *scroll_bar_parts
[(int) part
];
2934 return Fcons (Qscroll_bar_movement
,
2935 (Fcons (Fcons (bar_window
,
2936 Fcons (Qvertical_scroll_bar
,
2937 Fcons (Fcons (x
, y
),
2938 Fcons (make_number (time
),
2944 /* Or is it an ordinary mouse movement? */
2946 #endif /* MULTI_FRAME */
2959 /* It's in a frame; which window on that frame? */
2960 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
, 0, 1);
2961 window
= window_from_coordinates (frame
, column
, row
, &area
);
2966 if (WINDOWP (window
))
2968 int pixcolumn
, pixrow
;
2969 column
-= XINT (XWINDOW (window
)->left
);
2970 row
-= XINT (XWINDOW (window
)->top
);
2971 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
2972 XSETINT (x
, pixcolumn
);
2973 XSETINT (y
, pixrow
);
2978 posn
= Qvertical_line
;
2981 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
2984 else if (frame
!= 0)
2986 XSETFRAME (window
, frame
);
2998 return Fcons (Qmouse_movement
,
2999 Fcons (Fcons (window
,
3001 Fcons (Fcons (x
, y
),
3002 Fcons (make_number (time
),
3008 #endif /* neither MULTI_FRAME nor HAVE_MOUSE */
3010 /* Construct a switch frame event. */
3012 make_lispy_switch_frame (frame
)
3015 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
3018 /* Manipulating modifiers. */
3020 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
3022 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
3023 SYMBOL's name of the end of the modifiers; the string from this
3024 position is the unmodified symbol name.
3026 This doesn't use any caches. */
3028 parse_modifiers_uncached (symbol
, modifier_end
)
3032 struct Lisp_String
*name
;
3036 CHECK_SYMBOL (symbol
, 1);
3039 name
= XSYMBOL (symbol
)->name
;
3042 for (i
= 0; i
+2 <= name
->size
; )
3043 switch (name
->data
[i
])
3045 #define SINGLE_LETTER_MOD(bit) \
3046 if (name->data[i+1] != '-') \
3047 goto no_more_modifiers; \
3052 SINGLE_LETTER_MOD (alt_modifier
);
3056 SINGLE_LETTER_MOD (ctrl_modifier
);
3060 SINGLE_LETTER_MOD (hyper_modifier
);
3064 SINGLE_LETTER_MOD (meta_modifier
);
3068 SINGLE_LETTER_MOD (shift_modifier
);
3072 SINGLE_LETTER_MOD (super_modifier
);
3076 if (i
+ 5 > name
->size
)
3077 goto no_more_modifiers
;
3078 if (! strncmp (name
->data
+ i
, "drag-", 5))
3080 modifiers
|= drag_modifier
;
3083 else if (! strncmp (name
->data
+ i
, "down-", 5))
3085 modifiers
|= down_modifier
;
3088 else if (i
+ 7 <= name
->size
3089 && ! strncmp (name
->data
+ i
, "double-", 7))
3091 modifiers
|= double_modifier
;
3095 goto no_more_modifiers
;
3099 if (i
+ 7 > name
->size
)
3100 goto no_more_modifiers
;
3101 if (! strncmp (name
->data
+ i
, "triple-", 7))
3103 modifiers
|= triple_modifier
;
3107 goto no_more_modifiers
;
3111 goto no_more_modifiers
;
3113 #undef SINGLE_LETTER_MOD
3117 /* Should we include the `click' modifier? */
3118 if (! (modifiers
& (down_modifier
| drag_modifier
3119 | double_modifier
| triple_modifier
))
3120 && i
+ 7 == name
->size
3121 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
3122 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
3123 modifiers
|= click_modifier
;
3132 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
3133 prepended to the string BASE[0..BASE_LEN-1].
3134 This doesn't use any caches. */
3136 apply_modifiers_uncached (modifiers
, base
, base_len
)
3141 /* Since BASE could contain nulls, we can't use intern here; we have
3142 to use Fintern, which expects a genuine Lisp_String, and keeps a
3145 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
3151 /* Only the event queue may use the `up' modifier; it should always
3152 be turned into a click or drag event before presented to lisp code. */
3153 if (modifiers
& up_modifier
)
3156 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
3157 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
3158 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
3159 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
3160 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
3161 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
3162 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
3163 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
3164 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
3165 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
3166 /* The click modifier is denoted by the absence of other modifiers. */
3170 mod_len
= p
- new_mods
;
3174 Lisp_Object new_name
;
3176 new_name
= make_uninit_string (mod_len
+ base_len
);
3177 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
3178 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
3180 return Fintern (new_name
, Qnil
);
3185 static char *modifier_names
[] =
3187 "up", "down", "drag", "click", "double", "triple", 0, 0,
3188 0, 0, 0, 0, 0, 0, 0, 0,
3189 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
3191 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
3193 static Lisp_Object modifier_symbols
;
3195 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
3197 lispy_modifier_list (modifiers
)
3200 Lisp_Object modifier_list
;
3203 modifier_list
= Qnil
;
3204 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
3205 if (modifiers
& (1<<i
))
3206 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
3209 return modifier_list
;
3213 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
3214 where UNMODIFIED is the unmodified form of SYMBOL,
3215 MASK is the set of modifiers present in SYMBOL's name.
3216 This is similar to parse_modifiers_uncached, but uses the cache in
3217 SYMBOL's Qevent_symbol_element_mask property, and maintains the
3218 Qevent_symbol_elements property. */
3220 parse_modifiers (symbol
)
3223 Lisp_Object elements
;
3225 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
3226 if (CONSP (elements
))
3231 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
3232 Lisp_Object unmodified
;
3235 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
3236 XSYMBOL (symbol
)->name
->size
- end
),
3239 if (modifiers
& ~((1<<VALBITS
) - 1))
3241 XSETFASTINT (mask
, modifiers
);
3242 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
3244 /* Cache the parsing results on SYMBOL. */
3245 Fput (symbol
, Qevent_symbol_element_mask
,
3247 Fput (symbol
, Qevent_symbol_elements
,
3248 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
3250 /* Since we know that SYMBOL is modifiers applied to unmodified,
3251 it would be nice to put that in unmodified's cache.
3252 But we can't, since we're not sure that parse_modifiers is
3259 /* Apply the modifiers MODIFIERS to the symbol BASE.
3260 BASE must be unmodified.
3262 This is like apply_modifiers_uncached, but uses BASE's
3263 Qmodifier_cache property, if present. It also builds
3264 Qevent_symbol_elements properties, since it has that info anyway.
3266 apply_modifiers copies the value of BASE's Qevent_kind property to
3267 the modified symbol. */
3269 apply_modifiers (modifiers
, base
)
3273 Lisp_Object cache
, index
, entry
, new_symbol
;
3275 /* Mask out upper bits. We don't know where this value's been. */
3276 modifiers
&= (1<<VALBITS
) - 1;
3278 /* The click modifier never figures into cache indices. */
3279 cache
= Fget (base
, Qmodifier_cache
);
3280 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
3281 entry
= assq_no_quit (index
, cache
);
3284 new_symbol
= XCONS (entry
)->cdr
;
3287 /* We have to create the symbol ourselves. */
3288 new_symbol
= apply_modifiers_uncached (modifiers
,
3289 XSYMBOL (base
)->name
->data
,
3290 XSYMBOL (base
)->name
->size
);
3292 /* Add the new symbol to the base's cache. */
3293 entry
= Fcons (index
, new_symbol
);
3294 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
3296 /* We have the parsing info now for free, so add it to the caches. */
3297 XSETFASTINT (index
, modifiers
);
3298 Fput (new_symbol
, Qevent_symbol_element_mask
,
3299 Fcons (base
, Fcons (index
, Qnil
)));
3300 Fput (new_symbol
, Qevent_symbol_elements
,
3301 Fcons (base
, lispy_modifier_list (modifiers
)));
3304 /* Make sure this symbol is of the same kind as BASE.
3306 You'd think we could just set this once and for all when we
3307 intern the symbol above, but reorder_modifiers may call us when
3308 BASE's property isn't set right; we can't assume that just
3309 because it has a Qmodifier_cache property it must have its
3310 Qevent_kind set right as well. */
3311 if (NILP (Fget (new_symbol
, Qevent_kind
)))
3315 kind
= Fget (base
, Qevent_kind
);
3317 Fput (new_symbol
, Qevent_kind
, kind
);
3324 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
3325 return a symbol with the modifiers placed in the canonical order.
3326 Canonical order is alphabetical, except for down and drag, which
3327 always come last. The 'click' modifier is never written out.
3329 Fdefine_key calls this to make sure that (for example) C-M-foo
3330 and M-C-foo end up being equivalent in the keymap. */
3333 reorder_modifiers (symbol
)
3336 /* It's hopefully okay to write the code this way, since everything
3337 will soon be in caches, and no consing will be done at all. */
3340 parsed
= parse_modifiers (symbol
);
3341 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
3342 XCONS (parsed
)->car
);
3346 /* For handling events, we often want to produce a symbol whose name
3347 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
3348 to some base, like the name of a function key or mouse button.
3349 modify_event_symbol produces symbols of this sort.
3351 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
3352 is the name of the i'th symbol. TABLE_SIZE is the number of elements
3355 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
3356 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
3358 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
3359 persist between calls to modify_event_symbol that it can use to
3360 store a cache of the symbols it's generated for this NAME_TABLE
3361 before. The object stored there may be a vector or an alist.
3363 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
3365 MODIFIERS is a set of modifier bits (as given in struct input_events)
3366 whose prefixes should be applied to the symbol name.
3368 SYMBOL_KIND is the value to be placed in the event_kind property of
3369 the returned symbol.
3371 The symbols we create are supposed to have an
3372 `event-symbol-elements' property, which lists the modifiers present
3373 in the symbol's name. */
3376 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
3377 name_table
, symbol_table
, table_size
)
3380 Lisp_Object symbol_kind
;
3381 Lisp_Object name_alist
;
3383 Lisp_Object
*symbol_table
;
3387 Lisp_Object symbol_int
;
3389 XSETINT (symbol_int
, symbol_num
);
3391 /* Is this a request for a valid symbol? */
3392 if (symbol_num
< 0 || symbol_num
>= table_size
)
3395 if (CONSP (*symbol_table
))
3396 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
3398 /* If *symbol_table doesn't seem to be initialized properly, fix that.
3399 *symbol_table should be a lisp vector TABLE_SIZE elements long,
3400 where the Nth element is the symbol for NAME_TABLE[N], or nil if
3401 we've never used that symbol before. */
3404 if (! VECTORP (*symbol_table
)
3405 || XVECTOR (*symbol_table
)->size
!= table_size
)
3409 XSETFASTINT (size
, table_size
);
3410 *symbol_table
= Fmake_vector (size
, Qnil
);
3413 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
3416 /* Have we already used this symbol before? */
3419 /* No; let's create it. */
3420 if (!NILP (name_alist
))
3421 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
3422 else if (name_table
[symbol_num
])
3423 value
= intern (name_table
[symbol_num
]);
3428 sprintf (buf
, "key-%d", symbol_num
);
3429 value
= intern (buf
);
3432 if (CONSP (*symbol_table
))
3433 *symbol_table
= Fcons (value
, *symbol_table
);
3435 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
3437 /* Fill in the cache entries for this symbol; this also
3438 builds the Qevent_symbol_elements property, which the user
3440 apply_modifiers (modifiers
& click_modifier
, value
);
3441 Fput (value
, Qevent_kind
, symbol_kind
);
3444 /* Apply modifiers to that symbol. */
3445 return apply_modifiers (modifiers
, value
);
3449 /* Store into *addr a value nonzero if terminal input chars are available.
3450 Serves the purpose of ioctl (0, FIONREAD, addr)
3451 but works even if FIONREAD does not exist.
3452 (In fact, this may actually read some input.) */
3455 get_input_pending (addr
)
3458 /* First of all, have we already counted some input? */
3459 *addr
= !NILP (Vquit_flag
) || readable_events ();
3461 /* If input is being read as it arrives, and we have none, there is none. */
3462 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
3465 /* Try to read some input and see how much we get. */
3467 *addr
= !NILP (Vquit_flag
) || readable_events ();
3470 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
3473 gobble_input (expected
)
3478 if (interrupt_input
)
3481 mask
= sigblockx (SIGIO
);
3482 read_avail_input (expected
);
3486 #ifdef POLL_FOR_INPUT
3487 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
3490 mask
= sigblockx (SIGALRM
);
3491 read_avail_input (expected
);
3497 read_avail_input (expected
);
3501 /* Put a buffer_switch_event in the buffer
3502 so that read_key_sequence will notice the new current buffer. */
3504 record_asynch_buffer_change ()
3506 struct input_event event
;
3509 event
.kind
= buffer_switch_event
;
3510 event
.frame_or_window
= Qnil
;
3513 /* We don't need a buffer-switch event unless Emacs is waiting for input.
3514 The purpose of the event is to make read_key_sequence look up the
3515 keymaps again. If we aren't in read_key_sequence, we don't need one,
3516 and the event could cause trouble by messing up (input-pending-p). */
3517 tem
= Fwaiting_for_user_input_p ();
3521 /* We never need these events if we have no asynchronous subprocesses. */
3525 /* Make sure no interrupt happens while storing the event. */
3527 if (interrupt_input
)
3530 mask
= sigblockx (SIGIO
);
3531 kbd_buffer_store_event (&event
);
3538 kbd_buffer_store_event (&event
);
3545 /* Read any terminal input already buffered up by the system
3546 into the kbd_buffer, but do not wait.
3548 EXPECTED should be nonzero if the caller knows there is some input.
3550 Except on VMS, all input is read by this function.
3551 If interrupt_input is nonzero, this function MUST be called
3552 only when SIGIO is blocked.
3554 Returns the number of keyboard chars read, or -1 meaning
3555 this is a bad time to try to read input. */
3558 read_avail_input (expected
)
3561 struct input_event buf
[KBD_BUFFER_SIZE
];
3565 if (read_socket_hook
)
3566 /* No need for FIONREAD or fcntl; just say don't wait. */
3567 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
,
3568 expected
, expected
);
3571 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
3572 the kbd_buffer can really hold. That may prevent loss
3573 of characters on some systems when input is stuffed at us. */
3574 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
3577 /* Determine how many characters we should *try* to read. */
3579 n_to_read
= dos_keysns ();
3582 #else /* not MSDOS */
3584 /* Find out how much input is available. */
3585 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
3586 /* Formerly simply reported no input, but that sometimes led to
3587 a failure of Emacs to terminate.
3588 SIGHUP seems appropriate if we can't reach the terminal. */
3589 /* ??? Is it really right to send the signal just to this process
3590 rather than to the whole process group?
3591 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3592 kill (getpid (), SIGHUP
);
3595 if (n_to_read
> sizeof cbuf
)
3596 n_to_read
= sizeof cbuf
;
3597 #else /* no FIONREAD */
3598 #if defined(USG) || defined(DGUX)
3599 /* Read some input if available, but don't wait. */
3600 n_to_read
= sizeof cbuf
;
3601 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
3606 #endif /* not MSDOS */
3608 /* Now read; for one reason or another, this will not block.
3609 NREAD is set to the number of chars read. */
3613 cbuf
[0] = dos_keyread();
3616 nread
= read (input_fd
, cbuf
, n_to_read
);
3618 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
3619 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3620 This looks incorrect, but it isn't, because _BSD causes
3621 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3622 and that causes a value other than 0 when there is no input. */
3628 /* We used to retry the read if it was interrupted.
3629 But this does the wrong thing when O_NDELAY causes
3630 an EAGAIN error. Does anybody know of a situation
3631 where a retry is actually needed? */
3633 nread
< 0 && (errno
== EAGAIN
3647 #if defined (USG) || defined (DGUX)
3648 fcntl (input_fd
, F_SETFL
, 0);
3649 #endif /* USG or DGUX */
3650 #endif /* no FIONREAD */
3651 for (i
= 0; i
< nread
; i
++)
3653 buf
[i
].kind
= ascii_keystroke
;
3654 buf
[i
].modifiers
= 0;
3655 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3656 buf
[i
].modifiers
= meta_modifier
;
3660 XSETINT (buf
[i
].code
, cbuf
[i
]);
3662 XSETFRAME (buf
[i
].frame_or_window
, selected_frame
);
3664 buf
[i
].frame_or_window
= Qnil
;
3669 /* Scan the chars for C-g and store them in kbd_buffer. */
3670 for (i
= 0; i
< nread
; i
++)
3672 kbd_buffer_store_event (&buf
[i
]);
3673 /* Don't look at input that follows a C-g too closely.
3674 This reduces lossage due to autorepeat on C-g. */
3675 if (buf
[i
].kind
== ascii_keystroke
3676 && buf
[i
].code
== quit_char
)
3682 #endif /* not VMS */
3684 #ifdef SIGIO /* for entire page */
3685 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3688 input_available_signal (signo
)
3691 /* Must preserve main program's value of errno. */
3692 int old_errno
= errno
;
3694 extern int select_alarmed
;
3698 /* USG systems forget handlers when they are used;
3699 must reestablish each time */
3700 signal (signo
, input_available_signal
);
3707 if (input_available_clear_time
)
3708 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3713 nread
= read_avail_input (1);
3714 /* -1 means it's not ok to read the input now.
3715 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3716 0 means there was no keyboard input available. */
3721 select_alarmed
= 1; /* Force the select emulator back to life */
3732 /* Send ourselves a SIGIO.
3734 This function exists so that the UNBLOCK_INPUT macro in
3735 blockinput.h can have some way to take care of input we put off
3736 dealing with, without assuming that every file which uses
3737 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3739 reinvoke_input_signal ()
3748 /* Return the prompt-string of a sparse keymap.
3749 This is the first element which is a string.
3750 Return nil if there is none. */
3758 register Lisp_Object tem
;
3767 static void menu_bar_item ();
3768 static void menu_bar_one_keymap ();
3770 /* These variables hold the vector under construction within
3771 menu_bar_items and its subroutines, and the current index
3772 for storing into that vector. */
3773 static Lisp_Object menu_bar_items_vector
;
3774 static int menu_bar_items_index
;
3776 /* Return a vector of menu items for a menu bar, appropriate
3777 to the current buffer. Each item has three elements in the vector:
3780 OLD is an old vector we can optionally reuse, or nil. */
3783 menu_bar_items (old
)
3786 /* The number of keymaps we're scanning right now, and the number of
3787 keymaps we have allocated space for. */
3790 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3791 in the current keymaps, or nil where it is not a prefix. */
3794 Lisp_Object def
, tem
, tail
;
3803 struct gcpro gcpro1
;
3805 /* In order to build the menus, we need to call the keymap
3806 accessors. They all call QUIT. But this function is called
3807 during redisplay, during which a quit is fatal. So inhibit
3808 quitting while building the menus.
3809 We do this instead of specbind because (1) errors will clear it anyway
3810 and (2) this avoids risk of specpdl overflow. */
3811 oquit
= Vinhibit_quit
;
3815 menu_bar_items_vector
= old
;
3817 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
3818 menu_bar_items_index
= 0;
3820 GCPRO1 (menu_bar_items_vector
);
3822 /* Build our list of keymaps.
3823 If we recognize a function key and replace its escape sequence in
3824 keybuf with its symbol, or if the sequence starts with a mouse
3825 click and we need to switch buffers, we jump back here to rebuild
3826 the initial keymaps from the current buffer. */
3830 /* Should overriding-local-map apply, here? */
3831 if (!NILP (Voverriding_local_map_menu_flag
))
3833 if (NILP (Voverriding_local_map
))
3835 /* Yes, and it is nil. Use just global map. */
3837 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3841 /* Yes, and it is non-nil. Use it and the global map. */
3843 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3844 maps
[0] = Voverriding_local_map
;
3849 /* No, so use major and minor mode keymaps. */
3850 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3851 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3852 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3853 #ifdef USE_TEXT_PROPERTIES
3854 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3856 maps
[nmaps
-2] = current_buffer
->keymap
;
3859 maps
[nmaps
-1] = current_global_map
;
3862 /* Look up in each map the dummy prefix key `menu-bar'. */
3866 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3868 if (! NILP (maps
[mapno
]))
3869 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3873 tem
= Fkeymapp (def
);
3875 menu_bar_one_keymap (def
);
3878 /* Move to the end those items that should be at the end. */
3880 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3883 int end
= menu_bar_items_index
;
3885 for (i
= 0; i
< end
; i
+= 3)
3886 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
3888 Lisp_Object tem0
, tem1
, tem2
;
3889 /* Move the item at index I to the end,
3890 shifting all the others forward. */
3891 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
3892 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
3893 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
3895 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
3896 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
3897 (end
- i
- 3) * sizeof (Lisp_Object
));
3898 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem0
;
3899 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem1
;
3900 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem2
;
3905 /* Add nil, nil, nil at the end. */
3906 i
= menu_bar_items_index
;
3907 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
3910 int newsize
= 2 * i
;
3911 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
3912 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
3913 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
3914 menu_bar_items_vector
= tem
;
3916 /* Add this item. */
3917 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3918 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3919 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
3920 menu_bar_items_index
= i
;
3922 Vinhibit_quit
= oquit
;
3924 return menu_bar_items_vector
;
3927 /* Scan one map KEYMAP, accumulating any menu items it defines
3928 in menu_bar_items_vector. */
3931 menu_bar_one_keymap (keymap
)
3934 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3936 /* Loop over all keymap entries that have menu strings. */
3937 for (tail
= keymap
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3939 item
= XCONS (tail
)->car
;
3942 key
= XCONS (item
)->car
;
3943 binding
= XCONS (item
)->cdr
;
3944 if (CONSP (binding
))
3946 item_string
= XCONS (binding
)->car
;
3947 if (STRINGP (item_string
))
3948 menu_bar_item (key
, item_string
, Fcdr (binding
));
3950 else if (EQ (binding
, Qundefined
))
3951 menu_bar_item (key
, Qnil
, binding
);
3953 else if (VECTORP (item
))
3955 /* Loop over the char values represented in the vector. */
3956 int len
= XVECTOR (item
)->size
;
3958 for (c
= 0; c
< len
; c
++)
3960 Lisp_Object character
;
3961 XSETFASTINT (character
, c
);
3962 binding
= XVECTOR (item
)->contents
[c
];
3963 if (CONSP (binding
))
3965 item_string
= XCONS (binding
)->car
;
3966 if (STRINGP (item_string
))
3967 menu_bar_item (key
, item_string
, Fcdr (binding
));
3969 else if (EQ (binding
, Qundefined
))
3970 menu_bar_item (key
, Qnil
, binding
);
3976 /* This is used as the handler when calling internal_condition_case_1. */
3979 menu_bar_item_1 (arg
)
3985 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
3986 If there's already an item for KEY, add this DEF to it. */
3989 menu_bar_item (key
, item_string
, def
)
3990 Lisp_Object key
, item_string
, def
;
3993 Lisp_Object enabled
;
3996 if (EQ (def
, Qundefined
))
3998 /* If a map has an explicit `undefined' as definition,
3999 discard any previously made menu bar item. */
4001 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
4002 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
4004 if (menu_bar_items_index
> i
+ 3)
4005 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
4006 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
4007 (menu_bar_items_index
- i
- 3) * sizeof (Lisp_Object
));
4008 menu_bar_items_index
-= 3;
4012 /* If there's no definition for this key yet,
4013 just ignore `undefined'. */
4017 /* See if this entry is enabled. */
4022 /* No property, or nil, means enable.
4023 Otherwise, enable if value is not nil. */
4024 tem
= Fget (def
, Qmenu_enable
);
4026 /* (condition-case nil (eval tem)
4028 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
4032 /* Ignore this item if it's not enabled. */
4036 /* Find any existing item for this KEY. */
4037 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
4038 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
4041 /* If we did not find this KEY, add it at the end. */
4042 if (i
== menu_bar_items_index
)
4044 /* If vector is too small, get a bigger one. */
4045 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
4048 int newsize
= 2 * i
;
4049 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
4050 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
4051 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
4052 menu_bar_items_vector
= tem
;
4054 /* Add this item. */
4055 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
4056 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
4057 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (def
, Qnil
);
4058 menu_bar_items_index
= i
;
4060 /* We did find an item for this KEY. Add DEF to its list of maps. */
4064 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
4065 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (def
, old
);
4069 /* Read a character using menus based on maps in the array MAPS.
4070 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
4071 Return t if we displayed a menu but the user rejected it.
4073 PREV_EVENT is the previous input event, or nil if we are reading
4074 the first event of a key sequence.
4076 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
4077 if we used a mouse menu to read the input, or zero otherwise. If
4078 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
4080 The prompting is done based on the prompt-string of the map
4081 and the strings associated with various map elements.
4083 This can be done with X menus or with menus put in the minibuf.
4084 These are done in different ways, depending on how the input will be read.
4085 Menus using X are done after auto-saving in read-char, getting the input
4086 event from Fx_popup_menu; menus using the minibuf use read_char recursively
4087 and do auto-saving in the inner call of read_char. */
4090 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
4093 Lisp_Object prev_event
;
4094 int *used_mouse_menu
;
4097 register Lisp_Object name
;
4098 Lisp_Object rest
, vector
;
4100 if (used_mouse_menu
)
4101 *used_mouse_menu
= 0;
4103 /* Use local over global Menu maps */
4105 if (! menu_prompting
)
4108 /* Optionally disregard all but the global map. */
4109 if (inhibit_local_menu_bar_menus
)
4111 maps
+= (nmaps
- 1);
4115 /* Get the menu name from the first map that has one (a prompt string). */
4116 for (mapno
= 0; mapno
< nmaps
; mapno
++)
4118 name
= map_prompt (maps
[mapno
]);
4123 /* If we don't have any menus, just read a character normally. */
4127 #if (defined (HAVE_X_WINDOWS) && defined (HAVE_X_MENU)) || defined (MSDOS)
4128 /* If we got to this point via a mouse click,
4129 use a real menu for mouse selection. */
4130 if (EVENT_HAS_PARAMETERS (prev_event
))
4132 /* Display the menu and get the selection. */
4133 Lisp_Object
*realmaps
4134 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
4138 /* Use the maps that are not nil. */
4139 for (mapno
= 0; mapno
< nmaps
; mapno
++)
4140 if (!NILP (maps
[mapno
]))
4141 realmaps
[nmaps1
++] = maps
[mapno
];
4143 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
4146 /* If we got more than one event, put all but the first
4147 onto this list to be read later.
4148 Return just the first event now. */
4149 Vunread_command_events
4150 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
4151 value
= XCONS (value
)->car
;
4153 else if (NILP (value
))
4155 if (used_mouse_menu
)
4156 *used_mouse_menu
= 1;
4159 #endif /* (HAVE_X_WINDOWS && HAVE_X_MENU) || MSDOS */
4164 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
4170 register Lisp_Object name
;
4172 int width
= FRAME_WIDTH (selected_frame
) - 4;
4173 char *menu
= (char *) alloca (width
+ 4);
4176 Lisp_Object rest
, vector
;
4178 if (! menu_prompting
)
4181 /* Get the menu name from the first map that has one (a prompt string). */
4182 for (mapno
= 0; mapno
< nmaps
; mapno
++)
4184 name
= map_prompt (maps
[mapno
]);
4189 /* If we don't have any menus, just read a character normally. */
4193 /* Prompt string always starts with map's prompt, and a space. */
4194 strcpy (menu
, XSTRING (name
)->data
);
4195 nlength
= XSTRING (name
)->size
;
4196 menu
[nlength
++] = ':';
4197 menu
[nlength
++] = ' ';
4200 /* Start prompting at start of first map. */
4204 /* Present the documented bindings, a line at a time. */
4211 int orig_defn_macro
;
4213 /* Loop over elements of map. */
4218 /* If reached end of map, start at beginning of next map. */
4222 /* At end of last map, wrap around to first map if just starting,
4223 or end this line if already have something on it. */
4227 if (notfirst
|| nobindings
) break;
4232 /* Look at the next element of the map. */
4234 elt
= XVECTOR (vector
)->contents
[idx
];
4236 elt
= Fcar_safe (rest
);
4238 if (idx
< 0 && VECTORP (elt
))
4240 /* If we found a dense table in the keymap,
4241 advanced past it, but start scanning its contents. */
4242 rest
= Fcdr_safe (rest
);
4248 /* An ordinary element. */
4250 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
4252 s
= Fcar_safe(elt
); /* vector */
4254 /* Ignore the element if it has no prompt string. */
4256 /* If we have room for the prompt string, add it to this line.
4257 If this is the first on the line, always add it. */
4258 else if (XSTRING (s
)->size
+ i
+ 2 < width
4263 /* Punctuate between strings. */
4266 strcpy (menu
+ i
, ", ");
4272 /* Add as much of string as fits. */
4273 thiswidth
= XSTRING (s
)->size
;
4274 if (thiswidth
+ i
> width
)
4275 thiswidth
= width
- i
;
4276 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
4282 /* If this element does not fit, end the line now,
4283 and save the element for the next line. */
4284 strcpy (menu
+ i
, "...");
4288 /* Move past this element. */
4289 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
4290 /* Handle reaching end of dense table. */
4295 rest
= Fcdr_safe (rest
);
4299 /* Prompt with that and read response. */
4302 /* Make believe its not a keyboard macro in case the help char
4303 is pressed. Help characters are not recorded because menu prompting
4304 is not used on replay.
4306 orig_defn_macro
= defining_kbd_macro
;
4307 defining_kbd_macro
= 0 ;
4309 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
4310 while (BUFFERP (obj
));
4311 defining_kbd_macro
= orig_defn_macro
;
4313 if (!INTEGERP (obj
))
4318 if (! EQ (obj
, menu_prompt_more_char
)
4319 && (!INTEGERP (menu_prompt_more_char
)
4320 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
4322 if ( defining_kbd_macro
)
4323 store_kbd_macro_char(obj
) ;
4326 /* Help char - go round again */
4330 /* Reading key sequences. */
4332 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
4333 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
4334 keymap, or nil otherwise. Return the index of the first keymap in
4335 which KEY has any binding, or NMAPS if no map has a binding.
4337 If KEY is a meta ASCII character, treat it like meta-prefix-char
4338 followed by the corresponding non-meta character. Keymaps in
4339 CURRENT with non-prefix bindings for meta-prefix-char become nil in
4342 If KEY has no bindings in any of the CURRENT maps, NEXT is left
4345 NEXT may == CURRENT. */
4348 follow_key (key
, nmaps
, current
, defs
, next
)
4350 Lisp_Object
*current
, *defs
, *next
;
4353 int i
, first_binding
;
4355 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
4356 followed by the corresponding non-meta character. */
4357 if (INTEGERP (key
) && (XINT (key
) & CHAR_META
))
4359 for (i
= 0; i
< nmaps
; i
++)
4360 if (! NILP (current
[i
]))
4363 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
4365 /* Note that since we pass the resulting bindings through
4366 get_keymap_1, non-prefix bindings for meta-prefix-char
4368 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
4374 XSETINT (key
, XFASTINT (key
) & ~CHAR_META
);
4377 first_binding
= nmaps
;
4378 for (i
= nmaps
- 1; i
>= 0; i
--)
4380 if (! NILP (current
[i
]))
4382 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
4383 if (! NILP (defs
[i
]))
4390 /* Given the set of bindings we've found, produce the next set of maps. */
4391 if (first_binding
< nmaps
)
4392 for (i
= 0; i
< nmaps
; i
++)
4393 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
4395 return first_binding
;
4398 /* Read a sequence of keys that ends with a non prefix character,
4399 storing it in KEYBUF, a buffer of size BUFSIZE.
4401 Return the length of the key sequence stored.
4402 Return -1 if the user rejected a command menu.
4404 Echo starting immediately unless `prompt' is 0.
4406 Where a key sequence ends depends on the currently active keymaps.
4407 These include any minor mode keymaps active in the current buffer,
4408 the current buffer's local map, and the global map.
4410 If a key sequence has no other bindings, we check Vfunction_key_map
4411 to see if some trailing subsequence might be the beginning of a
4412 function key's sequence. If so, we try to read the whole function
4413 key, and substitute its symbolic name into the key sequence.
4415 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
4416 `double-' events into similar click events, if that would make them
4417 bound. We try to turn `triple-' events first into `double-' events,
4420 If we get a mouse click in a mode line, vertical divider, or other
4421 non-text area, we treat the click as if it were prefixed by the
4422 symbol denoting that area - `mode-line', `vertical-line', or
4425 If the sequence starts with a mouse click, we read the key sequence
4426 with respect to the buffer clicked on, not the current buffer.
4428 If the user switches frames in the midst of a key sequence, we put
4429 off the switch-frame event until later; the next call to
4430 read_char will return it. */
4433 read_key_sequence (keybuf
, bufsize
, prompt
)
4434 Lisp_Object
*keybuf
;
4438 int count
= specpdl_ptr
- specpdl
;
4440 /* How many keys there are in the current key sequence. */
4443 /* The length of the echo buffer when we started reading, and
4444 the length of this_command_keys when we started reading. */
4448 /* The number of keymaps we're scanning right now, and the number of
4449 keymaps we have allocated space for. */
4451 int nmaps_allocated
= 0;
4453 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
4454 the current keymaps. */
4457 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
4458 in the current keymaps, or nil where it is not a prefix. */
4459 Lisp_Object
*submaps
;
4461 /* The index in defs[] of the first keymap that has a binding for
4462 this key sequence. In other words, the lowest i such that
4463 defs[i] is non-nil. */
4466 /* If t < mock_input, then KEYBUF[t] should be read as the next
4469 We use this to recover after recognizing a function key. Once we
4470 realize that a suffix of the current key sequence is actually a
4471 function key's escape sequence, we replace the suffix with the
4472 function key's binding from Vfunction_key_map. Now keybuf
4473 contains a new and different key sequence, so the echo area,
4474 this_command_keys, and the submaps and defs arrays are wrong. In
4475 this situation, we set mock_input to t, set t to 0, and jump to
4476 restart_sequence; the loop will read keys from keybuf up until
4477 mock_input, thus rebuilding the state; and then it will resume
4478 reading characters from the keyboard. */
4481 /* If the sequence is unbound in submaps[], then
4482 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
4483 and fkey_map is its binding.
4485 These might be > t, indicating that all function key scanning
4486 should hold off until t reaches them. We do this when we've just
4487 recognized a function key, to avoid searching for the function
4488 key's again in Vfunction_key_map. */
4489 int fkey_start
= 0, fkey_end
= 0;
4490 Lisp_Object fkey_map
;
4492 /* Likewise, for key_translation_map. */
4493 int keytran_start
= 0, keytran_end
= 0;
4494 Lisp_Object keytran_map
;
4496 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
4497 we put it off for later. While we're reading, we keep the event here. */
4498 Lisp_Object delayed_switch_frame
;
4500 /* See the comment below... */
4501 #if defined (GOBBLE_FIRST_EVENT)
4502 Lisp_Object first_event
;
4505 struct buffer
*starting_buffer
;
4507 /* Nonzero if we seem to have got the beginning of a binding
4508 in function_key_map. */
4509 int function_key_possible
= 0;
4510 int key_translation_possible
= 0;
4514 last_nonmenu_event
= Qnil
;
4516 delayed_switch_frame
= Qnil
;
4517 fkey_map
= Vfunction_key_map
;
4518 keytran_map
= Vkey_translation_map
;
4520 /* If there is no function-key-map, turn off function key scanning. */
4521 if (NILP (Fkeymapp (Vfunction_key_map
)))
4522 fkey_start
= fkey_end
= bufsize
+ 1;
4524 /* If there is no key-translation-map, turn off scanning. */
4525 if (NILP (Fkeymapp (Vkey_translation_map
)))
4526 keytran_start
= keytran_end
= bufsize
+ 1;
4531 echo_prompt (XSTRING (prompt
)->data
);
4532 else if (cursor_in_echo_area
&& echo_keystrokes
)
4533 /* This doesn't put in a dash if the echo buffer is empty, so
4534 you don't always see a dash hanging out in the minibuffer. */
4538 /* Record the initial state of the echo area and this_command_keys;
4539 we will need to restore them if we replay a key sequence. */
4541 echo_start
= echo_length ();
4542 keys_start
= this_command_key_count
;
4544 #if defined (GOBBLE_FIRST_EVENT)
4545 /* This doesn't quite work, because some of the things that read_char
4546 does cannot safely be bypassed. It seems too risky to try to make
4549 /* Read the first char of the sequence specially, before setting
4550 up any keymaps, in case a filter runs and switches buffers on us. */
4551 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
4553 #endif /* GOBBLE_FIRST_EVENT */
4555 /* We jump here when the key sequence has been thoroughly changed, and
4556 we need to rescan it starting from the beginning. When we jump here,
4557 keybuf[0..mock_input] holds the sequence we should reread. */
4560 starting_buffer
= current_buffer
;
4561 function_key_possible
= 0;
4562 key_translation_possible
= 0;
4564 /* Build our list of keymaps.
4565 If we recognize a function key and replace its escape sequence in
4566 keybuf with its symbol, or if the sequence starts with a mouse
4567 click and we need to switch buffers, we jump back here to rebuild
4568 the initial keymaps from the current buffer. */
4572 if (!NILP (Voverriding_local_map
))
4575 if (nmaps
> nmaps_allocated
)
4577 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4578 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4579 nmaps_allocated
= nmaps
;
4581 submaps
[0] = Voverriding_local_map
;
4585 nmaps
= current_minor_maps (0, &maps
) + 2;
4586 if (nmaps
> nmaps_allocated
)
4588 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4589 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4590 nmaps_allocated
= nmaps
;
4592 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
4593 #ifdef USE_TEXT_PROPERTIES
4594 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
4596 submaps
[nmaps
-2] = current_buffer
->keymap
;
4599 submaps
[nmaps
-1] = current_global_map
;
4602 /* Find an accurate initial value for first_binding. */
4603 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
4604 if (! NILP (submaps
[first_binding
]))
4607 /* Start from the beginning in keybuf. */
4610 /* These are no-ops the first time through, but if we restart, they
4611 revert the echo area and this_command_keys to their original state. */
4612 this_command_key_count
= keys_start
;
4613 if (INTERACTIVE
&& t
< mock_input
)
4614 echo_truncate (echo_start
);
4616 /* If the best binding for the current key sequence is a keymap, or
4617 we may be looking at a function key's escape sequence, keep on
4619 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
4620 || (first_binding
>= nmaps
4622 /* mock input is never part of a function key's sequence. */
4623 && mock_input
<= fkey_start
)
4624 || (keytran_start
< t
&& key_translation_possible
)
4625 /* Don't return in the middle of a possible function key sequence,
4626 if the only bindings we found were via case conversion.
4627 Thus, if ESC O a has a function-key-map translation
4628 and ESC o has a binding, don't return after ESC O,
4629 so that we can translate ESC O plus the next character. */
4633 int used_mouse_menu
= 0;
4635 /* Where the last real key started. If we need to throw away a
4636 key that has expanded into more than one element of keybuf
4637 (say, a mouse click on the mode line which is being treated
4638 as [mode-line (mouse-...)], then we backtrack to this point
4640 int last_real_key_start
;
4642 /* These variables are analogous to echo_start and keys_start;
4643 while those allow us to restart the entire key sequence,
4644 echo_local_start and keys_local_start allow us to throw away
4646 int echo_local_start
, keys_local_start
, local_first_binding
;
4649 error ("key sequence too long");
4652 echo_local_start
= echo_length ();
4653 keys_local_start
= this_command_key_count
;
4654 local_first_binding
= first_binding
;
4657 /* These are no-ops, unless we throw away a keystroke below and
4658 jumped back up to replay_key; in that case, these restore the
4659 variables to their original state, allowing us to replay the
4661 if (INTERACTIVE
&& t
< mock_input
)
4662 echo_truncate (echo_local_start
);
4663 this_command_key_count
= keys_local_start
;
4664 first_binding
= local_first_binding
;
4666 /* By default, assume each event is "real". */
4667 last_real_key_start
= t
;
4669 /* Does mock_input indicate that we are re-reading a key sequence? */
4673 add_command_key (key
);
4674 if (echo_keystrokes
)
4678 /* If not, we should actually read a character. */
4681 struct buffer
*buf
= current_buffer
;
4683 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
4686 /* read_char returns t when it shows a menu and the user rejects it.
4691 /* read_char returns -1 at the end of a macro.
4692 Emacs 18 handles this by returning immediately with a
4693 zero, so that's what we'll do. */
4694 if (INTEGERP (key
) && XINT (key
) == -1)
4700 /* If the current buffer has been changed from under us, the
4701 keymap may have changed, so replay the sequence. */
4705 goto replay_sequence
;
4708 /* If we have a quit that was typed in another frame, and
4709 quit_throw_to_read_char switched buffers,
4710 replay to get the right keymap. */
4711 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
4716 goto replay_sequence
;
4722 /* Clicks in non-text areas get prefixed by the symbol
4723 in their CHAR-ADDRESS field. For example, a click on
4724 the mode line is prefixed by the symbol `mode-line'.
4726 Furthermore, key sequences beginning with mouse clicks
4727 are read using the keymaps of the buffer clicked on, not
4728 the current buffer. So we may have to switch the buffer
4731 When we turn one event into two events, we must make sure
4732 that neither of the two looks like the original--so that,
4733 if we replay the events, they won't be expanded again.
4734 If not for this, such reexpansion could happen either here
4735 or when user programs play with this-command-keys. */
4736 if (EVENT_HAS_PARAMETERS (key
))
4740 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
4741 if (EQ (kind
, Qmouse_click
))
4743 Lisp_Object window
, posn
;
4745 window
= POSN_WINDOW (EVENT_START (key
));
4746 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4749 /* We're looking at the second event of a
4750 sequence which we expanded before. Set
4751 last_real_key_start appropriately. */
4753 last_real_key_start
= t
- 1;
4756 /* Key sequences beginning with mouse clicks are
4757 read using the keymaps in the buffer clicked on,
4758 not the current buffer. If we're at the
4759 beginning of a key sequence, switch buffers. */
4760 if (last_real_key_start
== 0
4762 && BUFFERP (XWINDOW (window
)->buffer
)
4763 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
4768 /* Arrange to go back to the original buffer once we're
4769 done reading the key sequence. Note that we can't
4770 use save_excursion_{save,restore} here, because they
4771 save point as well as the current buffer; we don't
4772 want to save point, because redisplay may change it,
4773 to accommodate a Fset_window_start or something. We
4774 don't want to do this at the top of the function,
4775 because we may get input from a subprocess which
4776 wants to change the selected window and stuff (say,
4778 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
4780 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
4781 goto replay_sequence
;
4783 else if (SYMBOLP (posn
))
4785 /* Expand mode-line and scroll-bar events into two events:
4786 use posn as a fake prefix key. */
4788 if (t
+ 1 >= bufsize
)
4789 error ("key sequence too long");
4794 /* Zap the position in key, so we know that we've
4795 expanded it, and don't try to do so again. */
4796 POSN_BUFFER_POSN (EVENT_START (key
))
4797 = Fcons (posn
, Qnil
);
4801 else if (EQ (kind
, Qswitch_frame
))
4803 /* If we're at the beginning of a key sequence, go
4804 ahead and return this event. If we're in the
4805 midst of a key sequence, delay it until the end. */
4808 delayed_switch_frame
= key
;
4812 else if (CONSP (XCONS (key
)->cdr
)
4813 && CONSP (EVENT_START (key
))
4814 && CONSP (XCONS (EVENT_START (key
))->cdr
))
4818 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4819 /* Handle menu-bar events:
4820 insert the dummy prefix event `menu-bar'. */
4821 if (EQ (posn
, Qmenu_bar
))
4823 if (t
+ 1 >= bufsize
)
4824 error ("key sequence too long");
4825 /* Run the Lucid hook. */
4826 if (!NILP (Vrun_hooks
))
4827 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4828 /* If it has changed current-menubar from previous value,
4829 really recompute the menubar from the value. */
4830 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4831 call0 (Qrecompute_lucid_menubar
);
4835 /* Zap the position in key, so we know that we've
4836 expanded it, and don't try to do so again. */
4837 POSN_BUFFER_POSN (EVENT_START (key
))
4838 = Fcons (posn
, Qnil
);
4841 goto replay_sequence
;
4843 else if (CONSP (posn
))
4845 /* We're looking at the second event of a
4846 sequence which we expanded before. Set
4847 last_real_key_start appropriately. */
4848 if (last_real_key_start
== t
&& t
> 0)
4849 last_real_key_start
= t
- 1;
4854 /* We have finally decided that KEY is something we might want
4856 first_binding
= (follow_key (key
,
4857 nmaps
- first_binding
,
4858 submaps
+ first_binding
,
4859 defs
+ first_binding
,
4860 submaps
+ first_binding
)
4863 /* If KEY wasn't bound, we'll try some fallbacks. */
4864 if (first_binding
>= nmaps
)
4868 head
= EVENT_HEAD (key
);
4869 if (EQ (head
, Vhelp_char
))
4871 read_key_sequence_cmd
= Vprefix_help_command
;
4873 last_nonmenu_event
= key
;
4879 Lisp_Object breakdown
;
4882 breakdown
= parse_modifiers (head
);
4883 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4884 /* Attempt to reduce an unbound mouse event to a simpler
4885 event that is bound:
4886 Drags reduce to clicks.
4887 Double-clicks reduce to clicks.
4888 Triple-clicks reduce to double-clicks, then to clicks.
4889 Down-clicks are eliminated.
4890 Double-downs reduce to downs, then are eliminated.
4891 Triple-downs reduce to double-downs, then to downs,
4892 then are eliminated. */
4893 if (modifiers
& (down_modifier
| drag_modifier
4894 | double_modifier
| triple_modifier
))
4896 while (modifiers
& (down_modifier
| drag_modifier
4897 | double_modifier
| triple_modifier
))
4899 Lisp_Object new_head
, new_click
;
4900 if (modifiers
& triple_modifier
)
4901 modifiers
^= (double_modifier
| triple_modifier
);
4902 else if (modifiers
& (drag_modifier
| double_modifier
))
4903 modifiers
&= ~(drag_modifier
| double_modifier
);
4906 /* Dispose of this `down' event by simply jumping
4907 back to replay_key, to get another event.
4909 Note that if this event came from mock input,
4910 then just jumping back to replay_key will just
4911 hand it to us again. So we have to wipe out any
4914 We could delete keybuf[t] and shift everything
4915 after that to the left by one spot, but we'd also
4916 have to fix up any variable that points into
4917 keybuf, and shifting isn't really necessary
4920 Adding prefixes for non-textual mouse clicks
4921 creates two characters of mock input, and both
4922 must be thrown away. If we're only looking at
4923 the prefix now, we can just jump back to
4924 replay_key. On the other hand, if we've already
4925 processed the prefix, and now the actual click
4926 itself is giving us trouble, then we've lost the
4927 state of the keymaps we want to backtrack to, and
4928 we need to replay the whole sequence to rebuild
4931 Beyond that, only function key expansion could
4932 create more than two keys, but that should never
4933 generate mouse events, so it's okay to zero
4934 mock_input in that case too.
4936 Isn't this just the most wonderful code ever? */
4937 if (t
== last_real_key_start
)
4944 mock_input
= last_real_key_start
;
4945 goto replay_sequence
;
4950 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
4952 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
4954 /* Look for a binding for this new key. follow_key
4955 promises that it didn't munge submaps the
4956 last time we called it, since key was unbound. */
4958 = (follow_key (new_click
,
4959 nmaps
- local_first_binding
,
4960 submaps
+ local_first_binding
,
4961 defs
+ local_first_binding
,
4962 submaps
+ local_first_binding
)
4963 + local_first_binding
);
4965 /* If that click is bound, go for it. */
4966 if (first_binding
< nmaps
)
4971 /* Otherwise, we'll leave key set to the drag event. */
4978 /* Normally, last_nonmenu_event gets the previous key we read.
4979 But when a mouse popup menu is being used,
4980 we don't update last_nonmenu_event; it continues to hold the mouse
4981 event that preceded the first level of menu. */
4982 if (!used_mouse_menu
)
4983 last_nonmenu_event
= key
;
4985 /* If the sequence is unbound, see if we can hang a function key
4986 off the end of it. We only want to scan real keyboard input
4987 for function key sequences, so if mock_input says that we're
4988 re-reading old events, don't examine it. */
4989 if (first_binding
>= nmaps
4992 Lisp_Object fkey_next
;
4994 /* Continue scan from fkey_end until we find a bound suffix.
4995 If we fail, increment fkey_start
4996 and start fkey_end from there. */
4997 while (fkey_end
< t
)
5001 key
= keybuf
[fkey_end
++];
5002 /* Look up meta-characters by prefixing them
5003 with meta_prefix_char. I hate this. */
5004 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
5009 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
5011 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
5014 fkey_next
= fkey_map
;
5017 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
5019 #if 0 /* I didn't turn this on, because it might cause trouble
5020 for the mapping of return into C-m and tab into C-i. */
5021 /* Optionally don't map function keys into other things.
5022 This enables the user to redefine kp- keys easily. */
5023 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
5027 /* If the function key map gives a function, not an
5028 array, then call the function with no args and use
5029 its value instead. */
5030 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
5033 struct gcpro gcpro1
, gcpro2
, gcpro3
;
5037 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
5038 fkey_next
= call1 (fkey_next
, prompt
);
5040 /* If the function returned something invalid,
5041 barf--don't ignore it.
5042 (To ignore it safely, we would need to gcpro a bunch of
5043 other variables.) */
5044 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
5045 error ("Function in function-key-map returns invalid key sequence");
5048 function_key_possible
= ! NILP (fkey_next
);
5050 /* If keybuf[fkey_start..fkey_end] is bound in the
5051 function key map and it's a suffix of the current
5052 sequence (i.e. fkey_end == t), replace it with
5053 the binding and restart with fkey_start at the end. */
5054 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
5057 int len
= XFASTINT (Flength (fkey_next
));
5059 t
= fkey_start
+ len
;
5061 error ("key sequence too long");
5063 if (VECTORP (fkey_next
))
5064 bcopy (XVECTOR (fkey_next
)->contents
,
5065 keybuf
+ fkey_start
,
5066 (t
- fkey_start
) * sizeof (keybuf
[0]));
5067 else if (STRINGP (fkey_next
))
5071 for (i
= 0; i
< len
; i
++)
5072 XSETFASTINT (keybuf
[fkey_start
+ i
],
5073 XSTRING (fkey_next
)->data
[i
]);
5077 fkey_start
= fkey_end
= t
;
5078 fkey_map
= Vfunction_key_map
;
5080 /* Do pass the results through key-translation-map. */
5081 keytran_start
= keytran_end
= 0;
5082 keytran_map
= Vkey_translation_map
;
5084 goto replay_sequence
;
5087 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
5089 /* If we no longer have a bound suffix, try a new positions for
5091 if (NILP (fkey_map
))
5093 fkey_end
= ++fkey_start
;
5094 fkey_map
= Vfunction_key_map
;
5095 function_key_possible
= 0;
5100 /* Look for this sequence in key-translation-map. */
5102 Lisp_Object keytran_next
;
5104 /* Scan from keytran_end until we find a bound suffix. */
5105 while (keytran_end
< t
)
5109 key
= keybuf
[keytran_end
++];
5110 /* Look up meta-characters by prefixing them
5111 with meta_prefix_char. I hate this. */
5112 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
5117 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
5119 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
5122 keytran_next
= keytran_map
;
5125 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
5127 /* If the key translation map gives a function, not an
5128 array, then call the function with no args and use
5129 its value instead. */
5130 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
5131 && keytran_end
== t
)
5133 struct gcpro gcpro1
, gcpro2
, gcpro3
;
5137 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
5138 keytran_next
= call1 (keytran_next
, prompt
);
5140 /* If the function returned something invalid,
5141 barf--don't ignore it.
5142 (To ignore it safely, we would need to gcpro a bunch of
5143 other variables.) */
5144 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
5145 error ("Function in key-translation-map returns invalid key sequence");
5148 key_translation_possible
= ! NILP (keytran_next
);
5150 /* If keybuf[keytran_start..keytran_end] is bound in the
5151 key translation map and it's a suffix of the current
5152 sequence (i.e. keytran_end == t), replace it with
5153 the binding and restart with keytran_start at the end. */
5154 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
5155 && keytran_end
== t
)
5157 int len
= XFASTINT (Flength (keytran_next
));
5159 t
= keytran_start
+ len
;
5161 error ("key sequence too long");
5163 if (VECTORP (keytran_next
))
5164 bcopy (XVECTOR (keytran_next
)->contents
,
5165 keybuf
+ keytran_start
,
5166 (t
- keytran_start
) * sizeof (keybuf
[0]));
5167 else if (STRINGP (keytran_next
))
5171 for (i
= 0; i
< len
; i
++)
5172 XSETFASTINT (keybuf
[keytran_start
+ i
],
5173 XSTRING (keytran_next
)->data
[i
]);
5177 keytran_start
= keytran_end
= t
;
5178 keytran_map
= Vkey_translation_map
;
5180 /* Don't pass the results of key-translation-map
5181 through function-key-map. */
5182 fkey_start
= fkey_end
= t
;
5183 fkey_map
= Vkey_translation_map
;
5185 goto replay_sequence
;
5188 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
5190 /* If we no longer have a bound suffix, try a new positions for
5192 if (NILP (keytran_map
))
5194 keytran_end
= ++keytran_start
;
5195 keytran_map
= Vkey_translation_map
;
5196 key_translation_possible
= 0;
5201 /* If KEY is not defined in any of the keymaps,
5202 and cannot be part of a function key or translation,
5203 and is an upper case letter
5204 use the corresponding lower-case letter instead. */
5205 if (first_binding
== nmaps
&& ! function_key_possible
5206 && ! key_translation_possible
5208 && ((((XINT (key
) & 0x3ffff)
5209 < XSTRING (current_buffer
->downcase_table
)->size
)
5210 && UPPERCASEP (XINT (key
) & 0x3ffff))
5211 || (XINT (key
) & shift_modifier
)))
5213 if (XINT (key
) & shift_modifier
)
5214 XSETINT (key
, XINT (key
) & ~shift_modifier
);
5216 XSETINT (key
, (DOWNCASE (XINT (key
) & 0x3ffff)
5217 | (XINT (key
) & ~0x3ffff)));
5219 keybuf
[t
- 1] = key
;
5221 goto replay_sequence
;
5225 read_key_sequence_cmd
= (first_binding
< nmaps
5226 ? defs
[first_binding
]
5230 unread_switch_frame
= delayed_switch_frame
;
5231 unbind_to (count
, Qnil
);
5233 /* Occasionally we fabricate events, perhaps by expanding something
5234 according to function-key-map, or by adding a prefix symbol to a
5235 mouse click in the scroll bar or modeline. In this cases, return
5236 the entire generated key sequence, even if we hit an unbound
5237 prefix or a definition before the end. This means that you will
5238 be able to push back the event properly, and also means that
5239 read-key-sequence will always return a logical unit.
5242 for (; t
< mock_input
; t
++)
5244 if (echo_keystrokes
)
5245 echo_char (keybuf
[t
]);
5246 add_command_key (keybuf
[t
]);
5252 #if 0 /* This doc string is too long for some compilers.
5253 This commented-out definition serves for DOC. */
5254 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
5255 "Read a sequence of keystrokes and return as a string or vector.\n\
5256 The sequence is sufficient to specify a non-prefix command in the\n\
5257 current local and global maps.\n\
5259 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
5260 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
5261 as a continuation of the previous key.\n\
5263 A C-g typed while in this function is treated like any other character,\n\
5264 and `quit-flag' is not set.\n\
5266 If the key sequence starts with a mouse click, then the sequence is read\n\
5267 using the keymaps of the buffer of the window clicked in, not the buffer\n\
5268 of the selected window as normal.\n\
5270 `read-key-sequence' drops unbound button-down events, since you normally\n\
5271 only care about the click or drag events which follow them. If a drag\n\
5272 or multi-click event is unbound, but the corresponding click event would\n\
5273 be bound, `read-key-sequence' turns the event into a click event at the\n\
5274 drag's starting position. This means that you don't have to distinguish\n\
5275 between click and drag, double, or triple events unless you want to.\n\
5277 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
5278 lines separating windows, and scroll bars with imaginary keys\n\
5279 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
5281 If the user switches frames in the middle of a key sequence, the\n\
5282 frame-switch event is put off until after the current key sequence.\n\
5284 `read-key-sequence' checks `function-key-map' for function key\n\
5285 sequences, where they wouldn't conflict with ordinary bindings. See\n\
5286 `function-key-map' for more details.")
5287 (prompt
, continue_echo
)
5290 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
5292 (prompt
, continue_echo
)
5293 Lisp_Object prompt
, continue_echo
;
5295 Lisp_Object keybuf
[30];
5297 struct gcpro gcpro1
, gcpro2
;
5300 CHECK_STRING (prompt
, 0);
5303 bzero (keybuf
, sizeof keybuf
);
5305 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
5307 if (NILP (continue_echo
))
5308 this_command_key_count
= 0;
5310 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])), prompt
);
5318 return make_event_array (i
, keybuf
);
5321 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
5322 "Execute CMD as an editor command.\n\
5323 CMD must be a symbol that satisfies the `commandp' predicate.\n\
5324 Optional second arg RECORD-FLAG non-nil\n\
5325 means unconditionally put this command in `command-history'.\n\
5326 Otherwise, that is done only if an arg is read using the minibuffer.")
5328 Lisp_Object cmd
, record
;
5330 register Lisp_Object final
;
5331 register Lisp_Object tem
;
5332 Lisp_Object prefixarg
;
5333 struct backtrace backtrace
;
5334 extern int debug_on_next_call
;
5336 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
5337 Vcurrent_prefix_arg
= prefixarg
;
5338 debug_on_next_call
= 0;
5342 tem
= Fget (cmd
, Qdisabled
);
5343 if (!NILP (tem
) && !NILP (Vrun_hooks
))
5344 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
5349 final
= Findirect_function (cmd
);
5351 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
5352 do_autoload (final
, cmd
);
5357 if (STRINGP (final
) || VECTORP (final
))
5359 /* If requested, place the macro in the command history. For
5360 other sorts of commands, call-interactively takes care of
5364 = Fcons (Fcons (Qexecute_kbd_macro
,
5365 Fcons (final
, Fcons (prefixarg
, Qnil
))),
5368 return Fexecute_kbd_macro (final
, prefixarg
);
5370 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
5372 backtrace
.next
= backtrace_list
;
5373 backtrace_list
= &backtrace
;
5374 backtrace
.function
= &Qcall_interactively
;
5375 backtrace
.args
= &cmd
;
5376 backtrace
.nargs
= 1;
5377 backtrace
.evalargs
= 0;
5379 tem
= Fcall_interactively (cmd
, record
);
5381 backtrace_list
= backtrace
.next
;
5387 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
5389 "Read function name, then read its arguments and call it.")
5391 Lisp_Object prefixarg
;
5393 Lisp_Object function
;
5395 Lisp_Object saved_keys
;
5396 struct gcpro gcpro1
;
5398 saved_keys
= Fvector (this_command_key_count
,
5399 XVECTOR (this_command_keys
)->contents
);
5401 GCPRO1 (saved_keys
);
5403 if (EQ (prefixarg
, Qminus
))
5405 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
5406 strcpy (buf
, "C-u ");
5407 else if (CONSP (prefixarg
) && INTEGERP (XCONS (prefixarg
)->car
))
5408 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
5409 else if (INTEGERP (prefixarg
))
5410 sprintf (buf
, "%d ", XINT (prefixarg
));
5412 /* This isn't strictly correct if execute-extended-command
5413 is bound to anything else. Perhaps it should use
5414 this_command_keys? */
5415 strcat (buf
, "M-x ");
5417 /* Prompt with buf, and then read a string, completing from and
5418 restricting to the set of all defined commands. Don't provide
5419 any initial input. Save the command read on the extended-command
5421 function
= Fcompleting_read (build_string (buf
),
5422 Vobarray
, Qcommandp
,
5423 Qt
, Qnil
, Qextended_command_history
);
5425 /* Set this_command_keys to the concatenation of saved_keys and
5426 function, followed by a RET. */
5428 struct Lisp_String
*str
;
5433 this_command_key_count
= 0;
5435 keys
= XVECTOR (saved_keys
)->contents
;
5436 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
5437 add_command_key (keys
[i
]);
5439 str
= XSTRING (function
);
5440 for (i
= 0; i
< str
->size
; i
++)
5442 XSETFASTINT (tem
, str
->data
[i
]);
5443 add_command_key (tem
);
5446 XSETFASTINT (tem
, '\015');
5447 add_command_key (tem
);
5452 function
= Fintern (function
, Qnil
);
5453 Vprefix_arg
= prefixarg
;
5454 this_command
= function
;
5456 return Fcommand_execute (function
, Qt
);
5460 detect_input_pending ()
5463 get_input_pending (&input_pending
);
5465 return input_pending
;
5468 /* This is called in some cases before a possible quit.
5469 It cases the next call to detect_input_pending to recompute input_pending.
5470 So calling this function unnecessarily can't do any harm. */
5471 clear_input_pending ()
5476 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
5477 "T if command input is currently available with no waiting.\n\
5478 Actually, the value is nil only if we can be sure that no input is available.")
5481 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
5484 return detect_input_pending () ? Qt
: Qnil
;
5487 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
5488 "Return vector of last 100 events, not counting those from keyboard macros.")
5491 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
5494 if (total_keys
< NUM_RECENT_KEYS
)
5495 return Fvector (total_keys
, keys
);
5498 val
= Fvector (NUM_RECENT_KEYS
, keys
);
5499 bcopy (keys
+ recent_keys_index
,
5500 XVECTOR (val
)->contents
,
5501 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
5503 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
5504 recent_keys_index
* sizeof (Lisp_Object
));
5509 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
5510 "Return the key sequence that invoked this command.\n\
5511 The value is a string or a vector.")
5514 return make_event_array (this_command_key_count
,
5515 XVECTOR (this_command_keys
)->contents
);
5518 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
5519 "Return the current depth in recursive edits.")
5523 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
5527 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
5528 "FOpen dribble file: ",
5529 "Start writing all keyboard characters to a dribble file called FILE.\n\
5530 If FILE is nil, close any open dribble file.")
5541 file
= Fexpand_file_name (file
, Qnil
);
5542 dribble
= fopen (XSTRING (file
)->data
, "w");
5547 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
5548 "Discard the contents of the terminal input buffer.\n\
5549 Also cancel any kbd macro being defined.")
5552 defining_kbd_macro
= 0;
5553 update_mode_lines
++;
5555 Vunread_command_events
= Qnil
;
5556 unread_command_char
= -1;
5558 discard_tty_input ();
5560 /* Without the cast, GCC complains that this assignment loses the
5561 volatile qualifier of kbd_store_ptr. Is there anything wrong
5563 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
5564 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5570 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
5571 "Stop Emacs and return to superior process. You can resume later.\n\
5572 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
5573 control, run a subshell instead.\n\n\
5574 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
5575 to be read as terminal input by Emacs's parent, after suspension.\n\
5577 Before suspending, run the normal hook `suspend-hook'.\n\
5578 After resumption run the normal hook `suspend-resume-hook'.\n\
5580 Some operating systems cannot stop the Emacs process and resume it later.\n\
5581 On such systems, Emacs starts a subshell instead of suspending.")
5583 Lisp_Object stuffstring
;
5586 int count
= specpdl_ptr
- specpdl
;
5587 int old_height
, old_width
;
5589 struct gcpro gcpro1
, gcpro2
;
5590 extern init_sys_modes ();
5592 if (!NILP (stuffstring
))
5593 CHECK_STRING (stuffstring
, 0);
5595 /* Run the functions in suspend-hook. */
5596 if (!NILP (Vrun_hooks
))
5597 call1 (Vrun_hooks
, intern ("suspend-hook"));
5599 GCPRO1 (stuffstring
);
5600 get_frame_size (&old_width
, &old_height
);
5602 /* sys_suspend can get an error if it tries to fork a subshell
5603 and the system resources aren't available for that. */
5604 record_unwind_protect (init_sys_modes
, 0);
5605 stuff_buffered_input (stuffstring
);
5610 unbind_to (count
, Qnil
);
5612 /* Check if terminal/window size has changed.
5613 Note that this is not useful when we are running directly
5614 with a window system; but suspend should be disabled in that case. */
5615 get_frame_size (&width
, &height
);
5616 if (width
!= old_width
|| height
!= old_height
)
5617 change_frame_size (selected_frame
, height
, width
, 0, 0);
5619 /* Run suspend-resume-hook. */
5620 if (!NILP (Vrun_hooks
))
5621 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
5627 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
5628 Then in any case stuff anything Emacs has read ahead and not used. */
5630 stuff_buffered_input (stuffstring
)
5631 Lisp_Object stuffstring
;
5633 register unsigned char *p
;
5635 /* stuff_char works only in BSD, versions 4.2 and up. */
5638 if (STRINGP (stuffstring
))
5642 p
= XSTRING (stuffstring
)->data
;
5643 count
= XSTRING (stuffstring
)->size
;
5648 /* Anything we have read ahead, put back for the shell to read. */
5649 while (kbd_fetch_ptr
!= kbd_store_ptr
)
5651 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
5652 kbd_fetch_ptr
= kbd_buffer
;
5653 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
5654 stuff_char (kbd_fetch_ptr
->code
);
5655 kbd_fetch_ptr
->kind
= no_event
;
5656 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
5663 #endif /* BSD and not BSD4_1 */
5666 set_waiting_for_input (time_to_clear
)
5667 EMACS_TIME
*time_to_clear
;
5669 input_available_clear_time
= time_to_clear
;
5671 /* Tell interrupt_signal to throw back to read_char, */
5672 waiting_for_input
= 1;
5674 /* If interrupt_signal was called before and buffered a C-g,
5675 make it run again now, to avoid timing error. */
5676 if (!NILP (Vquit_flag
))
5677 quit_throw_to_read_char ();
5680 clear_waiting_for_input ()
5682 /* Tell interrupt_signal not to throw back to read_char, */
5683 waiting_for_input
= 0;
5684 input_available_clear_time
= 0;
5687 /* This routine is called at interrupt level in response to C-G.
5688 If interrupt_input, this is the handler for SIGINT.
5689 Otherwise, it is called from kbd_buffer_store_event,
5690 in handling SIGIO or SIGTINT.
5692 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
5693 immediately throw back to read_char.
5695 Otherwise it sets the Lisp variable quit-flag not-nil.
5696 This causes eval to throw, when it gets a chance.
5697 If quit-flag is already non-nil, it stops the job right away. */
5703 /* Must preserve main program's value of errno. */
5704 int old_errno
= errno
;
5707 if (!read_socket_hook
&& NILP (Vwindow_system
))
5709 /* USG systems forget handlers when they are used;
5710 must reestablish each time */
5711 signal (SIGINT
, interrupt_signal
);
5712 signal (SIGQUIT
, interrupt_signal
);
5718 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
5723 #ifdef SIGTSTP /* Support possible in later USG versions */
5725 * On systems which can suspend the current process and return to the original
5726 * shell, this command causes the user to end up back at the shell.
5727 * The "Auto-save" and "Abort" questions are not asked until
5728 * the user elects to return to emacs, at which point he can save the current
5729 * job and either dump core or continue.
5734 if (sys_suspend () == -1)
5736 printf ("Not running as a subprocess;\n");
5737 printf ("you can continue or abort.\n");
5740 /* Perhaps should really fork an inferior shell?
5741 But that would not provide any way to get back
5742 to the original shell, ever. */
5743 printf ("No support for stopping a process on this operating system;\n");
5744 printf ("you can continue or abort.\n");
5745 #endif /* not VMS */
5746 #endif /* not SIGTSTP */
5748 /* We must remain inside the screen area when the internal terminal
5749 is used. Note that [Enter] is not echoed by dos. */
5752 printf ("Auto-save? (y or n) ");
5754 if (((c
= getchar ()) & ~040) == 'Y')
5756 Fdo_auto_save (Qt
, Qnil
);
5758 printf ("\r\nAuto-save done");
5759 #else /* not MSDOS */
5760 printf ("Auto-save done\n");
5761 #endif /* not MSDOS */
5763 while (c
!= '\n') c
= getchar ();
5765 printf ("\r\nAbort? (y or n) ");
5766 #else /* not MSDOS */
5768 printf ("Abort (and enter debugger)? (y or n) ");
5770 printf ("Abort (and dump core)? (y or n) ");
5771 #endif /* not VMS */
5772 #endif /* not MSDOS */
5774 if (((c
= getchar ()) & ~040) == 'Y')
5776 while (c
!= '\n') c
= getchar ();
5778 printf ("\r\nContinuing...\r\n");
5779 #else /* not MSDOS */
5780 printf ("Continuing...\n");
5781 #endif /* not MSDOS */
5787 /* If executing a function that wants to be interrupted out of
5788 and the user has not deferred quitting by binding `inhibit-quit'
5789 then quit right away. */
5790 if (immediate_quit
&& NILP (Vinhibit_quit
))
5794 Fsignal (Qquit
, Qnil
);
5797 /* Else request quit when it's safe */
5801 if (waiting_for_input
&& !echoing
)
5802 quit_throw_to_read_char ();
5807 /* Handle a C-g by making read_char return C-g. */
5809 quit_throw_to_read_char ()
5811 quit_error_check ();
5813 /* Prevent another signal from doing this before we finish. */
5814 clear_waiting_for_input ();
5817 Vunread_command_events
= Qnil
;
5818 unread_command_char
= -1;
5820 #ifdef POLL_FOR_INPUT
5821 /* May be > 1 if in recursive minibuffer. */
5822 if (poll_suppress_count
== 0)
5826 if (FRAMEP (internal_last_event_frame
)
5827 && XFRAME (internal_last_event_frame
) != selected_frame
)
5828 Fhandle_switch_frame (make_lispy_switch_frame (internal_last_event_frame
));
5831 _longjmp (getcjmp
, 1);
5834 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
5835 "Set mode of reading keyboard input.\n\
5836 First arg INTERRUPT non-nil means use input interrupts;\n\
5837 nil means use CBREAK mode.\n\
5838 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
5839 (no effect except in CBREAK mode).\n\
5840 Third arg META t means accept 8-bit input (for a Meta key).\n\
5841 META nil means ignore the top bit, on the assumption it is parity.\n\
5842 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
5843 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
5844 See also `current-input-mode'.")
5845 (interrupt
, flow
, meta
, quit
)
5846 Lisp_Object interrupt
, flow
, meta
, quit
;
5849 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
5850 error ("set-input-mode: QUIT must be an ASCII character");
5852 #ifdef POLL_FOR_INPUT
5858 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5859 #ifdef NO_SOCK_SIGIO
5860 if (read_socket_hook
)
5861 interrupt_input
= 0; /* No interrupts if reading from a socket. */
5863 #endif /* NO_SOCK_SIGIO */
5864 interrupt_input
= !NILP (interrupt
);
5865 #else /* not SIGIO */
5866 interrupt_input
= 0;
5867 #endif /* not SIGIO */
5868 /* Our VMS input only works by interrupts, as of now. */
5870 interrupt_input
= 1;
5872 flow_control
= !NILP (flow
);
5875 else if (EQ (meta
, Qt
))
5880 /* Don't let this value be out of range. */
5881 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
5885 #ifdef POLL_FOR_INPUT
5886 poll_suppress_count
= 1;
5892 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
5893 "Return information about the way Emacs currently reads keyboard input.\n\
5894 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
5895 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
5896 nil, Emacs is using CBREAK mode.\n\
5897 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
5898 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
5899 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
5900 META nil means ignoring the top bit, on the assumption it is parity.\n\
5901 META is neither t nor nil if accepting 8-bit input and using\n\
5902 all 8 bits as the character code.\n\
5903 QUIT is the character Emacs currently uses to quit.\n\
5904 The elements of this list correspond to the arguments of\n\
5910 val
[0] = interrupt_input
? Qt
: Qnil
;
5911 val
[1] = flow_control
? Qt
: Qnil
;
5912 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
5913 XSETFASTINT (val
[3], quit_char
);
5915 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
5921 /* This is correct before outermost invocation of the editor loop */
5922 command_loop_level
= -1;
5924 quit_char
= Ctl ('g');
5925 Vunread_command_events
= Qnil
;
5926 unread_command_char
= -1;
5928 recent_keys_index
= 0;
5929 kbd_fetch_ptr
= kbd_buffer
;
5930 kbd_store_ptr
= kbd_buffer
;
5931 do_mouse_tracking
= Qnil
;
5935 /* This means that command_loop_1 won't try to select anything the first
5937 internal_last_event_frame
= Qnil
;
5938 Vlast_event_frame
= internal_last_event_frame
;
5941 /* If we're running a dumped Emacs, we need to clear out
5942 kbd_buffer_frame_or_window, in case some events got into it
5945 If we're running an undumped Emacs, it hasn't been initialized by
5946 syms_of_keyboard yet. */
5948 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5950 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
5952 signal (SIGINT
, interrupt_signal
);
5953 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
5954 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
5955 SIGQUIT and we can't tell which one it will give us. */
5956 signal (SIGQUIT
, interrupt_signal
);
5957 #endif /* HAVE_TERMIO */
5959 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5961 if (!noninteractive
)
5962 signal (SIGIO
, input_available_signal
);
5965 /* Use interrupt input by default, if it works and noninterrupt input
5966 has deficiencies. */
5968 #ifdef INTERRUPT_INPUT
5969 interrupt_input
= 1;
5971 interrupt_input
= 0;
5974 /* Our VMS input only works by interrupts, as of now. */
5976 interrupt_input
= 1;
5982 if (keyboard_init_hook
)
5983 (*keyboard_init_hook
) ();
5985 #ifdef POLL_FOR_INPUT
5986 poll_suppress_count
= 1;
5991 /* This type's only use is in syms_of_keyboard, to initialize the
5992 event header symbols and put properties on them. */
5999 struct event_head head_table
[] = {
6000 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
6001 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
6002 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
6003 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
6008 Qdisabled_command_hook
= intern ("disabled-command-hook");
6009 staticpro (&Qdisabled_command_hook
);
6011 Qself_insert_command
= intern ("self-insert-command");
6012 staticpro (&Qself_insert_command
);
6014 Qforward_char
= intern ("forward-char");
6015 staticpro (&Qforward_char
);
6017 Qbackward_char
= intern ("backward-char");
6018 staticpro (&Qbackward_char
);
6020 Qdisabled
= intern ("disabled");
6021 staticpro (&Qdisabled
);
6023 Qundefined
= intern ("undefined");
6024 staticpro (&Qundefined
);
6026 Qpre_command_hook
= intern ("pre-command-hook");
6027 staticpro (&Qpre_command_hook
);
6029 Qpost_command_hook
= intern ("post-command-hook");
6030 staticpro (&Qpost_command_hook
);
6032 Qcommand_hook_internal
= intern ("command-hook-internal");
6033 staticpro (&Qcommand_hook_internal
);
6035 Qfunction_key
= intern ("function-key");
6036 staticpro (&Qfunction_key
);
6037 Qmouse_click
= intern ("mouse-click");
6038 staticpro (&Qmouse_click
);
6040 Qmenu_enable
= intern ("menu-enable");
6041 staticpro (&Qmenu_enable
);
6043 Qmode_line
= intern ("mode-line");
6044 staticpro (&Qmode_line
);
6045 Qvertical_line
= intern ("vertical-line");
6046 staticpro (&Qvertical_line
);
6047 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
6048 staticpro (&Qvertical_scroll_bar
);
6049 Qmenu_bar
= intern ("menu-bar");
6050 staticpro (&Qmenu_bar
);
6052 Qabove_handle
= intern ("above-handle");
6053 staticpro (&Qabove_handle
);
6054 Qhandle
= intern ("handle");
6055 staticpro (&Qhandle
);
6056 Qbelow_handle
= intern ("below-handle");
6057 staticpro (&Qbelow_handle
);
6059 Qevent_kind
= intern ("event-kind");
6060 staticpro (&Qevent_kind
);
6061 Qevent_symbol_elements
= intern ("event-symbol-elements");
6062 staticpro (&Qevent_symbol_elements
);
6063 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
6064 staticpro (&Qevent_symbol_element_mask
);
6065 Qmodifier_cache
= intern ("modifier-cache");
6066 staticpro (&Qmodifier_cache
);
6068 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
6069 staticpro (&Qrecompute_lucid_menubar
);
6070 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
6071 staticpro (&Qactivate_menubar_hook
);
6073 Qpolling_period
= intern ("polling-period");
6074 staticpro (&Qpolling_period
);
6077 struct event_head
*p
;
6079 for (p
= head_table
;
6080 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
6083 *p
->var
= intern (p
->name
);
6085 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
6086 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
6090 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
6091 staticpro (&button_down_location
);
6095 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
6097 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
6098 for (i
= 0; i
< len
; i
++)
6099 if (modifier_names
[i
])
6100 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
6101 staticpro (&modifier_symbols
);
6104 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
6105 staticpro (&recent_keys
);
6107 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
6108 staticpro (&this_command_keys
);
6110 Qextended_command_history
= intern ("extended-command-history");
6111 Fset (Qextended_command_history
, Qnil
);
6112 staticpro (&Qextended_command_history
);
6114 kbd_buffer_frame_or_window
6115 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
6116 staticpro (&kbd_buffer_frame_or_window
);
6118 accent_key_syms
= Qnil
;
6119 staticpro (&accent_key_syms
);
6121 func_key_syms
= Qnil
;
6122 staticpro (&func_key_syms
);
6124 system_key_syms
= Qnil
;
6125 staticpro (&system_key_syms
);
6128 staticpro (&mouse_syms
);
6130 unread_switch_frame
= Qnil
;
6131 staticpro (&unread_switch_frame
);
6133 defsubr (&Sread_key_sequence
);
6134 defsubr (&Srecursive_edit
);
6135 defsubr (&Strack_mouse
);
6136 defsubr (&Sinput_pending_p
);
6137 defsubr (&Scommand_execute
);
6138 defsubr (&Srecent_keys
);
6139 defsubr (&Sthis_command_keys
);
6140 defsubr (&Ssuspend_emacs
);
6141 defsubr (&Sabort_recursive_edit
);
6142 defsubr (&Sexit_recursive_edit
);
6143 defsubr (&Srecursion_depth
);
6144 defsubr (&Stop_level
);
6145 defsubr (&Sdiscard_input
);
6146 defsubr (&Sopen_dribble_file
);
6147 defsubr (&Sset_input_mode
);
6148 defsubr (&Scurrent_input_mode
);
6149 defsubr (&Sexecute_extended_command
);
6151 DEFVAR_LISP ("last-command-char", &last_command_char
,
6152 "Last input event that was part of a command.");
6154 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
6155 "Last input event that was part of a command.");
6157 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
6158 "Last input event in a command, except for mouse menu events.\n\
6159 Mouse menus give back keys that don't look like mouse events;\n\
6160 this variable holds the actual mouse event that led to the menu,\n\
6161 so that you can determine whether the command was run by mouse or not.");
6163 DEFVAR_LISP ("last-input-char", &last_input_char
,
6164 "Last input event.");
6166 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
6167 "Last input event.");
6169 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
6170 "List of objects to be read as next command input events.");
6172 DEFVAR_INT ("unread-command-char", &unread_command_char
,
6173 "If not -1, an object to be read as next command input event.");
6175 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
6176 "Meta-prefix character code. Meta-foo as command input\n\
6177 turns into this character followed by foo.");
6178 XSETINT (meta_prefix_char
, 033);
6180 DEFVAR_LISP ("last-command", &last_command
,
6181 "The last command executed. Normally a symbol with a function definition,\n\
6182 but can be whatever was found in the keymap, or whatever the variable\n\
6183 `this-command' was set to by that command.");
6184 last_command
= Qnil
;
6186 DEFVAR_LISP ("this-command", &this_command
,
6187 "The command now being executed.\n\
6188 The command can set this variable; whatever is put here\n\
6189 will be in `last-command' during the following command.");
6190 this_command
= Qnil
;
6192 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
6193 "*Number of keyboard input characters between auto-saves.\n\
6194 Zero means disable autosaving due to number of characters typed.");
6195 auto_save_interval
= 300;
6197 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
6198 "*Number of seconds idle time before auto-save.\n\
6199 Zero or nil means disable auto-saving due to idleness.\n\
6200 After auto-saving due to this many seconds of idle time,\n\
6201 Emacs also does a garbage collection if that seems to be warranted.");
6202 XSETFASTINT (Vauto_save_timeout
, 30);
6204 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
6205 "*Nonzero means echo unfinished commands after this many seconds of pause.");
6206 echo_keystrokes
= 1;
6208 DEFVAR_INT ("polling-period", &polling_period
,
6209 "*Interval between polling for input during Lisp execution.\n\
6210 The reason for polling is to make C-g work to stop a running program.\n\
6211 Polling is needed only when using X windows and SIGIO does not work.\n\
6212 Polling is automatically disabled in all other cases.");
6215 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
6216 "*Maximum time between mouse clicks to make a double-click.\n\
6217 Measured in milliseconds. nil means disable double-click recognition;\n\
6218 t means double-clicks have no time limit and are detected\n\
6219 by position only.");
6220 Vdouble_click_time
= make_number (500);
6222 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
6223 "*Non-nil means inhibit local map menu bar menus.");
6224 inhibit_local_menu_bar_menus
= 0;
6226 DEFVAR_INT ("num-input-keys", &num_input_keys
,
6227 "*Number of complete keys read from the keyboard so far.");
6230 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
6231 "*The frame in which the most recently read event occurred.\n\
6232 If the last event came from a keyboard macro, this is set to `macro'.");
6233 Vlast_event_frame
= Qnil
;
6235 DEFVAR_LISP ("help-char", &Vhelp_char
,
6236 "Character to recognize as meaning Help.\n\
6237 When it is read, do `(eval help-form)', and display result if it's a string.\n\
6238 If the value of `help-form' is nil, this char can be read normally.");
6239 XSETINT (Vhelp_char
, Ctl ('H'));
6241 DEFVAR_LISP ("help-form", &Vhelp_form
,
6242 "Form to execute when character `help-char' is read.\n\
6243 If the form returns a string, that string is displayed.\n\
6244 If `help-form' is nil, the help char is not recognized.");
6247 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
6248 "Command to run when `help-char' character follows a prefix key.\n\
6249 This command is used only when there is no actual binding\n\
6250 for that character after that prefix key.");
6251 Vprefix_help_command
= Qnil
;
6253 DEFVAR_LISP ("top-level", &Vtop_level
,
6254 "Form to evaluate when Emacs starts up.\n\
6255 Useful to set before you dump a modified Emacs.");
6258 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
6259 "String used as translate table for keyboard input, or nil.\n\
6260 Each character is looked up in this string and the contents used instead.\n\
6261 If string is of length N, character codes N and up are untranslated.");
6262 Vkeyboard_translate_table
= Qnil
;
6264 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
6265 "Keymap of key translations that can override keymaps.\n\
6266 This keymap works like `function-key-map', but comes after that,\n\
6267 and applies even for keys that have ordinary bindings.");
6268 Vkey_translation_map
= Qnil
;
6270 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
6271 "Non-nil means to always spawn a subshell instead of suspending,\n\
6272 even if the operating system has support for stopping a process.");
6275 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
6276 "Non-nil means prompt with menus when appropriate.\n\
6277 This is done when reading from a keymap that has a prompt string,\n\
6278 for elements that have prompt strings.\n\
6279 The menu is displayed on the screen\n\
6280 if X menus were enabled at configuration\n\
6281 time and the previous event was a mouse click prefix key.\n\
6282 Otherwise, menu prompting uses the echo area.");
6285 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
6286 "Character to see next line of menu prompt.\n\
6287 Type this character while in a menu prompt to rotate around the lines of it.");
6288 XSETINT (menu_prompt_more_char
, ' ');
6290 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
6291 "A mask of additional modifier keys to use with every keyboard character.\n\
6292 Emacs applies the modifiers of the character stored here to each keyboard\n\
6293 character it reads. For example, after evaluating the expression\n\
6294 (setq extra-keyboard-modifiers ?\C-x)\n\
6295 all input characters will have the control modifier applied to them.\n\
6297 Note that the character ?\C-@, equivalent to the integer zero, does\n\
6298 not count as a control character; rather, it counts as a character\n\
6299 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
6300 cancels any modification.");
6301 extra_keyboard_modifiers
= 0;
6303 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
6304 "If an editing command sets this to t, deactivate the mark afterward.\n\
6305 The command loop sets this to nil before each command,\n\
6306 and tests the value when the command returns.\n\
6307 Buffer modification stores t in this variable.");
6308 Vdeactivate_mark
= Qnil
;
6310 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
6311 "Temporary storage of pre-command-hook or post-command-hook.");
6312 Vcommand_hook_internal
= Qnil
;
6314 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
6315 "Normal hook run before each command is executed.\n\
6316 While the hook is run, its value is temporarily set to nil\n\
6317 to avoid an unbreakable infinite loop if a hook function gets an error.\n\
6318 As a result, a hook function cannot straightforwardly alter the value of\n\
6319 `pre-command-hook'. See the Emacs Lisp manual for a way of\n\
6320 implementing hook functions that alter the set of hook functions.");
6321 Vpre_command_hook
= Qnil
;
6323 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
6324 "Normal hook run after each command is executed.\n\
6325 While the hook is run, its value is temporarily set to nil\n\
6326 to avoid an unbreakable infinite loop if a hook function gets an error.\n\
6327 As a result, a hook function cannot straightforwardly alter the value of\n\
6328 `post-command-hook'. See the Emacs Lisp manual for a way of\n\
6329 implementing hook functions that alter the set of hook functions.");
6330 Vpost_command_hook
= Qnil
;
6332 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
6333 "t means menu bar, specified Lucid style, needs to be recomputed.");
6334 Vlucid_menu_bar_dirty_flag
= Qnil
;
6336 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
6337 "List of menu bar items to move to the end of the menu bar.\n\
6338 The elements of the list are event types that may have menu bar bindings.");
6339 Vmenu_bar_final_items
= Qnil
;
6341 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
6342 "Keymap that overrides all other local keymaps.\n\
6343 If this variable is non-nil, it is used as a keymap instead of the\n\
6344 buffer's local map, and the minor mode keymaps and text property keymaps.");
6345 Voverriding_local_map
= Qnil
;
6347 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
6348 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
6349 Otherwise, the menu bar continues to reflect the buffer's local map\n\
6350 and the minor mode maps regardless of `overriding-local-map'.");
6351 Voverriding_local_map_menu_flag
= Qnil
;
6353 DEFVAR_BOOL ("track-mouse", &do_mouse_tracking
,
6354 "*Non-nil means generate motion events for mouse motion.");
6356 DEFVAR_LISP ("system-key-alist", &Vsystem_key_alist
,
6357 "Alist of system-specific X windows key symbols.\n\
6358 Each element should have the form (N . SYMBOL) where N is the\n\
6359 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
6360 and SYMBOL is its name.");
6361 Vsystem_key_alist
= Qnil
;
6363 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
6364 "List of deferred actions to be performed at a later time.\n\
6365 The precise format isn't relevant here; we just check whether it is nil.");
6366 Vdeferred_action_list
= Qnil
;
6368 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
6369 "Function to call to handle deferred actions, after each command.\n\
6370 This function is called with no arguments after each command\n\
6371 whenever `deferred-action-list' is non-nil.");
6372 Vdeferred_action_function
= Qnil
;
6377 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
6378 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
6379 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
6380 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
6381 initial_define_key (meta_map
, 'x', "execute-extended-command");