1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993 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"
58 /* Variables for blockinput.h: */
60 /* Non-zero if interrupt input is blocked right now. */
61 int interrupt_input_blocked
;
63 /* Nonzero means an input interrupt has arrived
64 during the current critical section. */
65 int interrupt_input_pending
;
69 extern Lisp_Object Vmouse_grabbed
;
71 /* Make all keyboard buffers much bigger when using X windows. */
72 #define KBD_BUFFER_SIZE 4096
73 #else /* No X-windows, character input */
74 #define KBD_BUFFER_SIZE 256
75 #endif /* No X-windows */
77 /* Following definition copied from eval.c */
81 struct backtrace
*next
;
82 Lisp_Object
*function
;
83 Lisp_Object
*args
; /* Points to vector of args. */
84 int nargs
; /* length of vector. If nargs is UNEVALLED,
85 args points to slot holding list of
90 /* Non-nil disable property on a command means
91 do not execute it; call disabled-command-hook's value instead. */
92 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
94 #define NUM_RECENT_KEYS (100)
95 int recent_keys_index
; /* Index for storing next element into recent_keys */
96 int total_keys
; /* Total number of elements stored into recent_keys */
97 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
99 /* Vector holding the key sequence that invoked the current command.
100 It is reused for each command, and it may be longer than the current
101 sequence; this_command_key_count indicates how many elements
102 actually mean something.
103 It's easier to staticpro a single Lisp_Object than an array. */
104 Lisp_Object this_command_keys
;
105 int this_command_key_count
;
107 extern int minbuf_level
;
109 extern struct backtrace
*backtrace_list
;
111 /* Nonzero means do menu prompting. */
112 static int menu_prompting
;
114 /* Character to see next line of menu prompt. */
115 static Lisp_Object menu_prompt_more_char
;
117 /* For longjmp to where kbd input is being done. */
118 static jmp_buf getcjmp
;
120 /* True while doing kbd input. */
121 int waiting_for_input
;
123 /* True while displaying for echoing. Delays C-g throwing. */
126 /* Nonzero means C-g should cause immediate error-signal. */
129 /* Character to recognize as the help char. */
130 Lisp_Object Vhelp_char
;
132 /* Form to execute when help char is typed. */
133 Lisp_Object Vhelp_form
;
135 /* Command to run when the help character follows a prefix key. */
136 Lisp_Object Vprefix_help_command
;
138 /* List of items that should move to the end of the menu bar. */
139 Lisp_Object Vmenu_bar_final_items
;
141 /* Character that causes a quit. Normally C-g.
143 If we are running on an ordinary terminal, this must be an ordinary
144 ASCII char, since we want to make it our interrupt character.
146 If we are not running on an ordinary terminal, it still needs to be
147 an ordinary ASCII char. This character needs to be recognized in
148 the input interrupt handler. At this point, the keystroke is
149 represented as a struct input_event, while the desired quit
150 character is specified as a lispy event. The mapping from struct
151 input_events to lispy events cannot run in an interrupt handler,
152 and the reverse mapping is difficult for anything but ASCII
155 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
159 extern Lisp_Object current_global_map
;
160 extern int minibuf_level
;
162 /* Current depth in recursive edits. */
163 int command_loop_level
;
165 /* Total number of times command_loop has read a key sequence. */
168 /* Last input character read as a command. */
169 Lisp_Object last_command_char
;
171 /* Last input character read as a command, not counting menus
172 reached by the mouse. */
173 Lisp_Object last_nonmenu_event
;
175 /* Last input character read for any purpose. */
176 Lisp_Object last_input_char
;
178 /* If not Qnil, a list of objects to be read as subsequent command input. */
179 Lisp_Object unread_command_events
;
181 /* If not -1, an event to be read as subsequent command input. */
182 int unread_command_char
;
184 /* If not Qnil, this is a switch-frame event which we decided to put
185 off until the end of a key sequence. This should be read as the
186 next command input, after any unread_command_events.
188 read_key_sequence uses this to delay switch-frame events until the
189 end of the key sequence; Fread_char uses it to put off switch-frame
190 events until a non-ASCII event is acceptable as input. */
191 Lisp_Object unread_switch_frame
;
193 /* A mask of extra modifier bits to put into every keyboard char. */
194 int extra_keyboard_modifiers
;
196 /* Char to use as prefix when a meta character is typed in.
197 This is bound on entry to minibuffer in case ESC is changed there. */
199 Lisp_Object meta_prefix_char
;
201 /* Last size recorded for a current buffer which is not a minibuffer. */
202 static int last_non_minibuf_size
;
204 /* Number of idle seconds before an auto-save and garbage collection. */
205 static Lisp_Object Vauto_save_timeout
;
207 /* Total number of times read_char has returned. */
210 /* Total number of times read_char has returned, outside of macros. */
211 int num_nonmacro_input_chars
;
213 /* Auto-save automatically when this many characters have been typed
214 since the last time. */
216 static int auto_save_interval
;
218 /* Value of num_nonmacro_input_chars as of last auto save. */
222 /* Last command executed by the editor command loop, not counting
223 commands that set the prefix argument. */
225 Lisp_Object last_command
;
227 /* The command being executed by the command loop.
228 Commands may set this, and the value set will be copied into last_command
229 instead of the actual command. */
230 Lisp_Object this_command
;
233 /* The frame in which the last input event occurred, or Qmacro if the
234 last event came from a macro. We use this to determine when to
235 generate switch-frame events. This may be cleared by functions
236 like Fselect_frame, to make sure that a switch-frame event is
237 generated by the next character. */
238 Lisp_Object internal_last_event_frame
;
240 /* A user-visible version of the above, intended to allow users to
241 figure out where the last event came from, if the event doesn't
242 carry that information itself (i.e. if it was a character). */
243 Lisp_Object Vlast_event_frame
;
246 /* The timestamp of the last input event we received from the X server.
247 X Windows wants this for selection ownership. */
248 unsigned long last_event_timestamp
;
250 Lisp_Object Qself_insert_command
;
251 Lisp_Object Qforward_char
;
252 Lisp_Object Qbackward_char
;
253 Lisp_Object Qundefined
;
255 /* read_key_sequence stores here the command definition of the
256 key sequence that it reads. */
257 Lisp_Object read_key_sequence_cmd
;
259 /* Form to evaluate (if non-nil) when Emacs is started. */
260 Lisp_Object Vtop_level
;
262 /* User-supplied string to translate input characters through. */
263 Lisp_Object Vkeyboard_translate_table
;
265 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
266 extern Lisp_Object Vfunction_key_map
;
268 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
269 Lisp_Object Vkey_translation_map
;
271 /* Non-nil means deactivate the mark at end of this command. */
272 Lisp_Object Vdeactivate_mark
;
274 /* Menu bar specified in Lucid Emacs fashion. */
276 Lisp_Object Vlucid_menu_bar_dirty_flag
;
277 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
279 /* Hooks to run before and after each command. */
280 Lisp_Object Qpre_command_hook
, Qpost_command_hook
;
281 Lisp_Object Vpre_command_hook
, Vpost_command_hook
;
283 /* File in which we write all commands we read. */
286 /* Nonzero if input is available. */
289 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
290 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
294 extern char *pending_malloc_warning
;
296 /* Circular buffer for pre-read keyboard input. */
297 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
299 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
301 The interrupt-level event handlers will never enqueue an event on a
302 frame which is not in Vframe_list, and once an event is dequeued,
303 internal_last_event_frame or the event itself points to the frame.
306 But while the event is sitting in the queue, it's completely
307 unprotected. Suppose the user types one command which will run for
308 a while and then delete a frame, and then types another event at
309 the frame that will be deleted, before the command gets around to
310 it. Suppose there are no references to this frame elsewhere in
311 Emacs, and a GC occurs before the second event is dequeued. Now we
312 have an event referring to a freed frame, which will crash Emacs
315 Similar things happen when an event on a scroll bar is enqueued; the
316 window may be deleted while the event is in the queue.
318 So, we use this vector to protect the frame_or_window field in the
319 event queue. That way, they'll be dequeued as dead frames or
320 windows, but still valid lisp objects.
322 If kbd_buffer[i].kind != no_event, then
323 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
324 == kbd_buffer[i].frame_or_window. */
325 static Lisp_Object kbd_buffer_frame_or_window
;
327 /* Pointer to next available character in kbd_buffer.
328 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
329 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
330 next available char is in kbd_buffer[0]. */
331 static struct input_event
*kbd_fetch_ptr
;
333 /* Pointer to next place to store character in kbd_buffer. This
334 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
335 character should go in kbd_buffer[0]. */
339 static struct input_event
*kbd_store_ptr
;
341 /* The above pair of variables forms a "queue empty" flag. When we
342 enqueue a non-hook event, we increment kbd_write_count. When we
343 dequeue a non-hook event, we increment kbd_read_count. We say that
344 there is input available iff the two counters are not equal.
346 Why not just have a flag set and cleared by the enqueuing and
347 dequeuing functions? Such a flag could be screwed up by interrupts
348 at inopportune times. */
350 /* If this flag is non-zero, we check mouse_moved to see when the
351 mouse moves, and motion events will appear in the input stream. If
352 it is zero, mouse motion is ignored. */
353 static int do_mouse_tracking
;
355 /* The window system handling code should set this if the mouse has
356 moved since the last call to the mouse_position_hook. Calling that
357 hook should clear this. Code assumes that if this is set, it can
358 call mouse_position_hook to get the promised position, so don't set
359 it unless you're prepared to substantiate the claim! */
362 /* True iff there is an event in kbd_buffer, or if mouse tracking is
363 enabled and there is a new mouse position in the mouse movement
364 buffer. Note that if this is false, that doesn't mean that there
365 is readable input; all the events in the queue might be button-up
366 events, and do_mouse_tracking might be off. */
367 #define EVENT_QUEUES_EMPTY \
368 ((kbd_fetch_ptr == kbd_store_ptr) && (!do_mouse_tracking || !mouse_moved))
371 /* Symbols to head events. */
372 Lisp_Object Qmouse_movement
;
373 Lisp_Object Qscroll_bar_movement
;
374 Lisp_Object Qswitch_frame
;
376 /* Symbols to denote kinds of events. */
377 Lisp_Object Qfunction_key
;
378 Lisp_Object Qmouse_click
;
379 /* Lisp_Object Qmouse_movement; - also an event header */
381 /* Properties of event headers. */
382 Lisp_Object Qevent_kind
;
383 Lisp_Object Qevent_symbol_elements
;
385 Lisp_Object Qmenu_enable
;
387 /* An event header symbol HEAD may have a property named
388 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
389 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
390 mask of modifiers applied to it. If present, this is used to help
391 speed up parse_modifiers. */
392 Lisp_Object Qevent_symbol_element_mask
;
394 /* An unmodified event header BASE may have a property named
395 Qmodifier_cache, which is an alist mapping modifier masks onto
396 modified versions of BASE. If present, this helps speed up
398 Lisp_Object Qmodifier_cache
;
400 /* Symbols to use for parts of windows. */
401 Lisp_Object Qmode_line
;
402 Lisp_Object Qvertical_line
;
403 Lisp_Object Qvertical_scroll_bar
;
404 Lisp_Object Qmenu_bar
;
406 extern Lisp_Object Qmenu_enable
;
408 Lisp_Object
recursive_edit_unwind (), command_loop ();
409 Lisp_Object
Fthis_command_keys ();
410 Lisp_Object Qextended_command_history
;
412 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
414 EMACS_TIME
*input_available_clear_time
;
416 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
417 Default is 1 if INTERRUPT_INPUT is defined. */
420 /* Nonzero while interrupts are temporarily deferred during redisplay. */
421 int interrupts_deferred
;
423 /* nonzero means use ^S/^Q for flow control. */
426 /* Allow m- file to inhibit use of FIONREAD. */
427 #ifdef BROKEN_FIONREAD
431 /* We are unable to use interrupts if FIONREAD is not available,
432 so flush SIGIO so we won't try. */
439 /* If we support X Windows, turn on the code to poll periodically
440 to detect C-g. It isn't actually used when doing interrupt input. */
441 #ifdef HAVE_X_WINDOWS
442 #define POLL_FOR_INPUT
445 /* Global variable declarations. */
447 /* Function for init_keyboard to call with no args (if nonzero). */
448 void (*keyboard_init_hook
) ();
450 static int read_avail_input ();
451 static void get_input_pending ();
452 static int readable_events ();
453 static Lisp_Object
read_char_menu_prompt ();
454 static Lisp_Object
make_lispy_event ();
455 static Lisp_Object
make_lispy_movement ();
456 static Lisp_Object
modify_event_symbol ();
457 static Lisp_Object
make_lispy_switch_frame ();
459 /* > 0 if we are to echo keystrokes. */
460 static int echo_keystrokes
;
462 /* Nonzero means echo each character as typed. */
463 static int immediate_echo
;
465 /* The text we're echoing in the modeline - partial key sequences,
466 usually. '\0'-terminated. This really shouldn't have a fixed size. */
467 static char echobuf
[300];
469 /* Where to append more text to echobuf if we want to. */
470 static char *echoptr
;
472 #define min(a,b) ((a)<(b)?(a):(b))
473 #define max(a,b) ((a)>(b)?(a):(b))
475 /* Install the string STR as the beginning of the string of echoing,
476 so that it serves as a prompt for the next character.
477 Also start echoing. */
482 int len
= strlen (str
);
483 if (len
> sizeof echobuf
- 4)
484 len
= sizeof echobuf
- 4;
485 bcopy (str
, echobuf
, len
);
486 echoptr
= echobuf
+ len
;
492 /* Add C to the echo string, if echoing is going on.
493 C can be a character, which is printed prettily ("M-C-x" and all that
494 jazz), or a symbol, whose name is printed. */
499 extern char *push_key_description ();
508 /* If someone has passed us a composite event, use its head symbol. */
511 if (XTYPE (c
) == Lisp_Int
)
513 if (ptr
- echobuf
> sizeof echobuf
- 6)
516 ptr
= push_key_description (XINT (c
), ptr
);
518 else if (XTYPE (c
) == Lisp_Symbol
)
520 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
521 if (((ptr
- echobuf
) + name
->size
+ 4) > sizeof echobuf
)
523 bcopy (name
->data
, ptr
, name
->size
);
527 if (echoptr
== echobuf
&& EQ (c
, Vhelp_char
))
529 strcpy (ptr
, " (Type ? for further options)");
540 /* Temporarily add a dash to the end of the echo string if it's not
541 empty, so that it serves as a mini-prompt for the very next character. */
545 if (!immediate_echo
&& echoptr
== echobuf
)
547 /* Do nothing if not echoing at all. */
551 /* Put a dash at the end of the buffer temporarily,
552 but make it go away when the next character is added. */
559 /* Display the current echo string, and begin echoing if not already
569 for (i
= 0; i
< this_command_key_count
; i
++)
570 echo_char (XVECTOR (this_command_keys
)->contents
[i
]);
578 if (waiting_for_input
&& !NILP (Vquit_flag
))
579 quit_throw_to_read_char ();
582 /* Turn off echoing, for the start of a new command. */
590 /* Return the length of the current echo string. */
595 return echoptr
- echobuf
;
598 /* Truncate the current echo message to its first LEN chars.
599 This and echo_char get used by read_key_sequence when the user
600 switches frames while entering a key sequence. */
607 echoptr
= echobuf
+ len
;
611 /* Functions for manipulating this_command_keys. */
613 add_command_key (key
)
616 int size
= XVECTOR (this_command_keys
)->size
;
618 if (this_command_key_count
>= size
)
620 Lisp_Object new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
622 bcopy (XVECTOR (this_command_keys
)->contents
,
623 XVECTOR (new_keys
)->contents
,
624 size
* sizeof (Lisp_Object
));
626 this_command_keys
= new_keys
;
629 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
635 int count
= specpdl_ptr
- specpdl
;
638 if (command_loop_level
> 0)
640 specbind (Qstandard_output
, Qt
);
641 specbind (Qstandard_input
, Qt
);
644 val
= command_loop ();
646 Fsignal (Qquit
, Qnil
);
648 return unbind_to (count
, Qnil
);
651 /* When an auto-save happens, record the "time", and don't do again soon. */
654 last_auto_save
= num_nonmacro_input_chars
;
657 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
658 "Invoke the editor command loop recursively.\n\
659 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
660 that tells this function to return.\n\
661 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
662 This function is called by the editor initialization to begin editing.")
665 int count
= specpdl_ptr
- specpdl
;
668 command_loop_level
++;
669 update_mode_lines
= 1;
671 record_unwind_protect (recursive_edit_unwind
,
673 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
677 return unbind_to (count
, Qnil
);
681 recursive_edit_unwind (buffer
)
685 Fset_buffer (buffer
);
687 command_loop_level
--;
688 update_mode_lines
= 1;
696 Lisp_Object errmsg
, tail
, errname
, file_error
;
703 Vstandard_output
= Qt
;
704 Vstandard_input
= Qt
;
705 Vexecuting_macro
= Qnil
;
706 echo_area_glyphs
= 0;
708 /* If the window system or terminal frame hasn't been initialized
709 yet, or we're not interactive, it's best to dump this message out
710 to stderr and exit. */
711 if (! FRAME_MESSAGE_BUF (selected_frame
)
713 stream
= Qexternal_debugging_output
;
721 errname
= Fcar (data
);
723 if (EQ (errname
, Qerror
))
726 if (!CONSP (data
)) data
= Qnil
;
727 errmsg
= Fcar (data
);
732 errmsg
= Fget (errname
, Qerror_message
);
733 file_error
= Fmemq (Qfile_error
,
734 Fget (errname
, Qerror_conditions
));
737 /* Print an error message including the data items.
738 This is done by printing it into a scratch buffer
739 and then making a copy of the text in the buffer. */
741 if (!CONSP (data
)) data
= Qnil
;
745 /* For file-error, make error message by concatenating
746 all the data items. They are all strings. */
747 if (!NILP (file_error
) && !NILP (tail
))
748 errmsg
= XCONS (tail
)->car
, tail
= XCONS (tail
)->cdr
;
750 if (XTYPE (errmsg
) == Lisp_String
)
751 Fprinc (errmsg
, stream
);
753 write_string_1 ("peculiar error", -1, stream
);
755 for (i
= 0; CONSP (tail
); tail
= Fcdr (tail
), i
++)
757 write_string_1 (i
? ", " : ": ", 2, stream
);
758 if (!NILP (file_error
))
759 Fprinc (Fcar (tail
), stream
);
761 Fprin1 (Fcar (tail
), stream
);
765 /* If the window system or terminal frame hasn't been initialized
766 yet, or we're in -batch mode, this error should cause Emacs to exit. */
767 if (! FRAME_MESSAGE_BUF (selected_frame
)
771 Fkill_emacs (make_number (-1));
776 Vinhibit_quit
= Qnil
;
777 return make_number (0);
780 Lisp_Object
command_loop_1 ();
781 Lisp_Object
command_loop_2 ();
782 Lisp_Object
top_level_1 ();
784 /* Entry to editor-command-loop.
785 This level has the catches for exiting/returning to editor command loop.
786 It returns nil to exit recursive edit, t to abort it. */
791 if (command_loop_level
> 0 || minibuf_level
> 0)
793 return internal_catch (Qexit
, command_loop_2
, Qnil
);
798 internal_catch (Qtop_level
, top_level_1
, Qnil
);
799 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
801 /* End of file in -batch run causes exit here. */
807 /* Here we catch errors in execution of commands within the
808 editing loop, and reenter the editing loop.
809 When there is an error, cmd_error runs and returns a non-nil
810 value to us. A value of nil means that cmd_loop_1 itself
811 returned due to end of file (or end of kbd macro). */
816 register Lisp_Object val
;
819 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
828 return Feval (Vtop_level
);
834 /* On entry to the outer level, run the startup file */
835 if (!NILP (Vtop_level
))
836 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
837 else if (!NILP (Vpurify_flag
))
838 message ("Bare impure Emacs (standard Lisp code not loaded)");
840 message ("Bare Emacs (standard Lisp code not loaded)");
844 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
845 "Exit all recursive editing levels.")
848 Fthrow (Qtop_level
, Qnil
);
851 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
852 "Exit from the innermost recursive edit or minibuffer.")
855 if (command_loop_level
> 0 || minibuf_level
> 0)
856 Fthrow (Qexit
, Qnil
);
858 error ("No recursive edit is in progress");
861 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
862 "Abort the command that requested this recursive edit or minibuffer input.")
865 if (command_loop_level
> 0 || minibuf_level
> 0)
868 error ("No recursive edit is in progress");
871 /* This is the actual command reading loop,
872 sans error-handling encapsulation. */
874 Lisp_Object
Fcommand_execute ();
875 static int read_key_sequence ();
880 Lisp_Object cmd
, tem
;
883 Lisp_Object keybuf
[30];
888 struct buffer
*prev_buffer
;
891 Vdeactivate_mark
= Qnil
;
892 waiting_for_input
= 0;
895 /* Don't clear out last_command at the beginning of a macro. */
896 if (XTYPE (Vexecuting_macro
) != Lisp_String
)
901 this_command_key_count
= 0;
903 /* Make sure this hook runs after commands that get errors and
904 throw to top level. */
905 if (!NILP (Vpost_command_hook
))
906 call1 (Vrun_hooks
, Qpost_command_hook
);
910 /* Install chars successfully executed in kbd macro. */
912 if (defining_kbd_macro
&& NILP (Vprefix_arg
))
913 finalize_kbd_macro_chars ();
915 /* Make sure the current window's buffer is selected. */
916 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
917 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
919 /* Display any malloc warning that just came out. Use while because
920 displaying one warning can cause another. */
922 while (pending_malloc_warning
)
923 display_malloc_warning ();
927 Vdeactivate_mark
= Qnil
;
929 /* If minibuffer on and echo area in use,
930 wait 2 sec and redraw minibuffer. */
932 if (minibuf_level
&& echo_area_glyphs
)
934 /* Bind inhibit-quit to t so that C-g gets read in
935 rather than quitting back to the minibuffer. */
936 int count
= specpdl_ptr
- specpdl
;
937 specbind (Qinhibit_quit
, Qt
);
938 Fsit_for (make_number (2), Qnil
, Qnil
);
939 unbind_to (count
, Qnil
);
941 echo_area_glyphs
= 0;
943 if (!NILP (Vquit_flag
))
946 unread_command_events
= Fcons (make_number (quit_char
), Qnil
);
951 alloca (0); /* Cause a garbage collection now */
952 /* Since we can free the most stuff here. */
953 #endif /* C_ALLOCA */
957 /* Select the frame that the last event came from. Usually,
958 switch-frame events will take care of this, but if some lisp
959 code swallows a switch-frame event, we'll fix things up here.
960 Is this a good idea? */
961 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
962 && XFRAME (internal_last_event_frame
) != selected_frame
)
963 Fselect_frame (internal_last_event_frame
, Qnil
);
966 /* If it has changed current-menubar from previous value,
967 really recompute the menubar from the value. */
968 if (! NILP (Vlucid_menu_bar_dirty_flag
)
969 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
970 call0 (Qrecompute_lucid_menubar
);
972 #if 0 /* This is done in xdisp.c now. */
974 for (tem
= Vframe_list
; CONSP (tem
); tem
= XCONS (tem
)->cdr
)
976 struct frame
*f
= XFRAME (XCONS (tem
)->car
);
977 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
979 /* If the user has switched buffers or windows, we need to
980 recompute to reflect the new bindings. But we'll
981 recompute when update_mode_lines is set too; that means
982 that people can use force-mode-line-update to request
983 that the menu bar be recomputed. The adverse effect on
984 the rest of the redisplay algorithm is about the same as
985 windows_or_buffers_changed anyway. */
986 if (windows_or_buffers_changed
988 || (XFASTINT (w
->last_modified
) < MODIFF
989 && (XFASTINT (w
->last_modified
)
990 <= XBUFFER (w
->buffer
)->save_modified
)))
992 struct buffer
*prev
= current_buffer
;
993 current_buffer
= XBUFFER (w
->buffer
);
994 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items ();
995 current_buffer
= prev
;
998 #endif /* MULTI_FRAME */
1001 /* Read next key sequence; i gets its length. */
1002 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), Qnil
);
1006 /* Now we have read a key sequence of length I,
1007 or else I is 0 and we found end of file. */
1009 if (i
== 0) /* End of file -- happens only in */
1010 return Qnil
; /* a kbd macro, at the end. */
1011 /* -1 means read_key_sequence got a menu that was rejected.
1012 Just loop around and read another command. */
1016 this_command_key_count
= 0;
1020 last_command_char
= keybuf
[i
- 1];
1022 /* If the previous command tried to force a specific window-start,
1023 forget about that, in case this command moves point far away
1024 from that position. */
1025 XWINDOW (selected_window
)->force_start
= Qnil
;
1027 cmd
= read_key_sequence_cmd
;
1028 if (!NILP (Vexecuting_macro
))
1030 if (!NILP (Vquit_flag
))
1032 Vexecuting_macro
= Qt
;
1033 QUIT
; /* Make some noise. */
1034 /* Will return since macro now empty. */
1038 /* Do redisplay processing after this command except in special
1039 cases identified below that set no_redisplay to 1. */
1042 prev_buffer
= current_buffer
;
1043 prev_modiff
= MODIFF
;
1045 /* Execute the command. */
1048 if (!NILP (Vpre_command_hook
))
1049 call1 (Vrun_hooks
, Qpre_command_hook
);
1051 if (NILP (this_command
))
1053 /* nil means key is undefined. */
1055 defining_kbd_macro
= 0;
1056 update_mode_lines
= 1;
1062 if (NILP (Vprefix_arg
) && ! no_direct
)
1064 /* Recognize some common commands in common situations and
1065 do them directly. */
1066 if (EQ (this_command
, Qforward_char
) && point
< ZV
)
1068 struct Lisp_Vector
*dp
1069 = window_display_table (XWINDOW (selected_window
));
1070 lose
= FETCH_CHAR (point
);
1073 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1074 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1075 : (lose
>= 0x20 && lose
< 0x7f))
1076 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1078 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1080 && !windows_or_buffers_changed
1081 && EQ (current_buffer
->selective_display
, Qnil
)
1082 && !detect_input_pending ()
1083 && NILP (Vexecuting_macro
))
1084 no_redisplay
= direct_output_forward_char (1);
1087 else if (EQ (this_command
, Qbackward_char
) && point
> BEGV
)
1089 struct Lisp_Vector
*dp
1090 = window_display_table (XWINDOW (selected_window
));
1092 lose
= FETCH_CHAR (point
);
1094 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1095 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1096 : (lose
>= 0x20 && lose
< 0x7f))
1097 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1099 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1101 && !windows_or_buffers_changed
1102 && EQ (current_buffer
->selective_display
, Qnil
)
1103 && !detect_input_pending ()
1104 && NILP (Vexecuting_macro
))
1105 no_redisplay
= direct_output_forward_char (-1);
1108 else if (EQ (this_command
, Qself_insert_command
)
1109 /* Try this optimization only on ascii keystrokes. */
1110 && XTYPE (last_command_char
) == Lisp_Int
)
1112 unsigned char c
= XINT (last_command_char
);
1114 if (NILP (Vexecuting_macro
) &&
1115 !EQ (minibuf_window
, selected_window
))
1117 if (!nonundocount
|| nonundocount
>= 20)
1124 lose
= (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1126 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1128 || MODIFF
<= current_buffer
->save_modified
1129 || windows_or_buffers_changed
1130 || !EQ (current_buffer
->selective_display
, Qnil
)
1131 || detect_input_pending ()
1132 || !NILP (Vexecuting_macro
);
1133 if (internal_self_insert (c
, 0))
1139 (point
== ZV
|| FETCH_CHAR (point
) == '\n'))
1141 struct Lisp_Vector
*dp
1142 = window_display_table (XWINDOW (selected_window
));
1147 Lisp_Object obj
= DISP_CHAR_VECTOR (dp
, lose
);
1149 if (XTYPE (obj
) == Lisp_Vector
1150 && XVECTOR (obj
)->size
== 1
1151 && (XTYPE (obj
= XVECTOR (obj
)->contents
[0])
1154 direct_output_for_insert (XINT (obj
));
1158 if (lose
>= 0x20 && lose
<= 0x7e)
1159 no_redisplay
= direct_output_for_insert (lose
);
1166 /* Here for a command that isn't executed directly */
1169 if (NILP (Vprefix_arg
))
1171 Fcommand_execute (this_command
, Qnil
);
1176 if (!NILP (Vpost_command_hook
))
1177 call1 (Vrun_hooks
, Qpost_command_hook
);
1179 /* If there is a prefix argument,
1180 1) We don't want last_command to be ``universal-argument''
1181 (that would be dumb), so don't set last_command,
1182 2) we want to leave echoing on so that the prefix will be
1183 echoed as part of this key sequence, so don't call
1185 3) we want to leave this_command_key_count non-zero, so that
1186 read_char will realize that it is re-reading a character, and
1187 not echo it a second time. */
1188 if (NILP (Vprefix_arg
))
1190 last_command
= this_command
;
1192 this_command_key_count
= 0;
1195 if (!NILP (current_buffer
->mark_active
))
1197 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1199 current_buffer
->mark_active
= Qnil
;
1200 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1202 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1203 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1208 /* Number of seconds between polling for input. */
1211 /* Nonzero means polling for input is temporarily suppressed. */
1212 int poll_suppress_count
;
1214 #ifdef POLL_FOR_INPUT
1215 int polling_for_input
;
1217 /* Handle an alarm once each second and read pending input
1218 so as to handle a C-g if it comces in. */
1221 input_poll_signal ()
1223 if (interrupt_input_blocked
== 0
1224 && !waiting_for_input
)
1225 read_avail_input (0);
1226 signal (SIGALRM
, input_poll_signal
);
1227 alarm (polling_period
);
1232 /* Begin signals to poll for input, if they are appropriate.
1233 This function is called unconditionally from various places. */
1237 #ifdef POLL_FOR_INPUT
1238 if (read_socket_hook
&& !interrupt_input
)
1240 poll_suppress_count
--;
1241 if (poll_suppress_count
== 0)
1243 signal (SIGALRM
, input_poll_signal
);
1244 polling_for_input
= 1;
1245 alarm (polling_period
);
1251 /* Turn off polling. */
1255 #ifdef POLL_FOR_INPUT
1256 if (read_socket_hook
&& !interrupt_input
)
1258 if (poll_suppress_count
== 0)
1260 polling_for_input
= 0;
1263 poll_suppress_count
++;
1268 /* Set the value of poll_suppress_count to COUNT
1269 and start or stop polling accordingly. */
1272 set_poll_suppress_count (count
)
1275 #ifdef POLL_FOR_INPUT
1276 if (count
== 0 && poll_suppress_count
!= 0)
1278 poll_suppress_count
= 1;
1281 else if (count
!= 0 && poll_suppress_count
== 0)
1285 poll_suppress_count
= count
;
1289 /* Applying the control modifier to CHARACTER. */
1294 /* Save the upper bits here. */
1295 int upper
= c
& ~0177;
1299 /* Everything in the columns containing the upper-case letters
1300 denotes a control character. */
1301 if (c
>= 0100 && c
< 0140)
1305 /* Set the shift modifier for a control char
1306 made from a shifted letter. But only for letters! */
1307 if (oc
>= 'A' && oc
<= 'Z')
1308 c
|= shift_modifier
;
1311 /* The lower-case letters denote control characters too. */
1312 else if (c
>= 'a' && c
<= 'z')
1315 /* Include the bits for control and shift
1316 only if the basic ASCII code can't indicate them. */
1320 /* Replace the high bits. */
1321 c
|= (upper
& ~ctrl_modifier
);
1328 /* Input of single characters from keyboard */
1330 Lisp_Object
print_help ();
1331 static Lisp_Object
kbd_buffer_get_event ();
1333 /* read a character from the keyboard; call the redisplay if needed */
1334 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1335 -1 means do not do redisplay, but do do autosaving.
1338 /* The arguments MAPS and NMAPS are for menu prompting.
1339 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1341 PREV_EVENT is the previous input event, or nil if we are reading
1342 the first event of a key sequence.
1344 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1345 if we used a mouse menu to read the input, or zero otherwise. If
1346 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
1348 Value is t if we showed a menu and the user rejected it. */
1351 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1355 Lisp_Object prev_event
;
1356 int *used_mouse_menu
;
1358 register Lisp_Object c
;
1362 if (CONSP (unread_command_events
))
1364 c
= XCONS (unread_command_events
)->car
;
1365 unread_command_events
= XCONS (unread_command_events
)->cdr
;
1367 if (this_command_key_count
== 0)
1373 if (unread_command_char
!= -1)
1375 XSET (c
, Lisp_Int
, unread_command_char
);
1376 unread_command_char
= -1;
1378 if (this_command_key_count
== 0)
1384 if (!NILP (Vexecuting_macro
))
1387 /* We set this to Qmacro; since that's not a frame, nobody will
1388 try to switch frames on us, and the selected window will
1391 Since this event came from a macro, it would be misleading to
1392 leave internal_last_event_frame set to wherever the last
1393 real event came from. Normally, a switch-frame event selects
1394 internal_last_event_frame after each command is read, but
1395 events read from a macro should never cause a new frame to be
1397 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1400 /* Exit the macro if we are at the end.
1401 Also, some things replace the macro with t
1402 to force an early exit. */
1403 if (EQ (Vexecuting_macro
, Qt
)
1404 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1406 XSET (c
, Lisp_Int
, -1);
1410 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1411 if (XTYPE (Vexecuting_macro
) == Lisp_String
1412 && (XINT (c
) & 0x80))
1413 XFASTINT (c
) = CHAR_META
| (XINT (c
) & ~0x80);
1415 executing_macro_index
++;
1420 if (!NILP (unread_switch_frame
))
1422 c
= unread_switch_frame
;
1423 unread_switch_frame
= Qnil
;
1425 /* This event should make it into this_command_keys, and get echoed
1426 again, so we go to reread_first, rather than reread. */
1430 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1431 prepare_menu_bars ();
1433 /* Save outer setjmp data, in case called recursively. */
1434 save_getcjmp (save_jump
);
1438 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1441 if (_setjmp (getcjmp
))
1443 XSET (c
, Lisp_Int
, quit_char
);
1445 XSET (internal_last_event_frame
, Lisp_Frame
, selected_frame
);
1446 Vlast_event_frame
= internal_last_event_frame
;
1448 /* If we report the quit char as an event,
1449 don't do so more than once. */
1450 if (!NILP (Vinhibit_quit
))
1456 /* Message turns off echoing unless more keystrokes turn it on again. */
1457 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1460 /* If already echoing, continue. */
1463 /* If in middle of key sequence and minibuffer not active,
1464 start echoing if enough time elapses. */
1465 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1467 && echo_keystrokes
> 0
1468 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1472 /* After a mouse event, start echoing right away.
1473 This is because we are probably about to display a menu,
1474 and we don't want to delay before doing so. */
1475 if (EVENT_HAS_PARAMETERS (prev_event
))
1479 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1485 /* Maybe auto save due to number of keystrokes or idle time. */
1487 if (commandflag
!= 0
1488 && auto_save_interval
> 0
1489 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1490 && !detect_input_pending ())
1493 save_getcjmp (temp
);
1494 Fdo_auto_save (Qnil
, Qnil
);
1495 restore_getcjmp (temp
);
1498 /* Try reading a character via menu prompting.
1499 Try this before the sit-for, because the sit-for
1500 would do the wrong thing if we are supposed to do
1503 if (INTERACTIVE
&& !NILP (prev_event
))
1504 c
= read_char_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1506 /* Slow down auto saves logarithmically in size of current buffer,
1507 and garbage collect while we're at it. */
1508 if (INTERACTIVE
&& NILP (c
))
1510 int delay_level
, buffer_size
;
1512 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1513 last_non_minibuf_size
= Z
- BEG
;
1514 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1516 while (buffer_size
> 64)
1517 delay_level
++, buffer_size
-= buffer_size
>> 2;
1518 if (delay_level
< 4) delay_level
= 4;
1519 /* delay_level is 4 for files under around 50k, 7 at 100k,
1520 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1522 /* Auto save if enough time goes by without input. */
1523 if (commandflag
!= 0
1524 && num_nonmacro_input_chars
> last_auto_save
1525 && XTYPE (Vauto_save_timeout
) == Lisp_Int
1526 && XINT (Vauto_save_timeout
) > 0)
1529 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1530 tem0
= sit_for (delay
, 0, 1, 1);
1534 save_getcjmp (temp
);
1535 Fdo_auto_save (Qnil
, Qnil
);
1536 restore_getcjmp (temp
);
1538 /* If we have auto-saved and there is still no input
1539 available, garbage collect if there has been enough
1540 consing going on to make it worthwhile. */
1541 if (!detect_input_pending ()
1542 && consing_since_gc
> gc_cons_threshold
/ 2)
1544 Fgarbage_collect ();
1545 /* prepare_menu_bars isn't safe here, but it should
1546 also be unnecessary. */
1553 /* Actually read a character, waiting if necessary. */
1556 c
= kbd_buffer_get_event ();
1559 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1563 /* Terminate Emacs in batch mode if at eof. */
1564 if (noninteractive
&& XTYPE (c
) == Lisp_Int
&& XINT (c
) < 0)
1565 Fkill_emacs (make_number (1));
1567 if (XTYPE (c
) == Lisp_Int
)
1569 /* Add in any extra modifiers, where appropriate. */
1570 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1571 || ((extra_keyboard_modifiers
& 0177) < ' '
1572 && (extra_keyboard_modifiers
& 0177) != 0))
1573 XSETINT (c
, make_ctrl_char (XINT (c
)));
1575 /* Transfer any other modifier bits directly from
1576 extra_keyboard_modifiers to c. Ignore the actual character code
1577 in the low 16 bits of extra_keyboard_modifiers. */
1578 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
1583 restore_getcjmp (save_jump
);
1587 echo_area_glyphs
= 0;
1589 /* Handle things that only apply to characters. */
1590 if (XTYPE (c
) == Lisp_Int
)
1592 /* If kbd_buffer_get_event gave us an EOF, return that. */
1596 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
1597 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1598 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1602 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1603 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1604 recent_keys_index
= 0;
1606 /* Write c to the dribble file. If c is a lispy event, write
1607 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1608 If you, dear reader, have a better idea, you've got the source. :-) */
1611 if (XTYPE (c
) == Lisp_Int
)
1612 putc (XINT (c
), dribble
);
1615 Lisp_Object dribblee
= c
;
1617 /* If it's a structured event, take the event header. */
1618 dribblee
= EVENT_HEAD (dribblee
);
1620 if (XTYPE (dribblee
) == Lisp_Symbol
)
1622 putc ('<', dribble
);
1623 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1624 XSYMBOL (dribblee
)->name
->size
,
1626 putc ('>', dribble
);
1633 store_kbd_macro_char (c
);
1635 num_nonmacro_input_chars
++;
1640 /* Record this character as part of the current key.
1641 Don't record mouse motion; it should never matter. */
1642 if (! (EVENT_HAS_PARAMETERS (c
)
1643 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1646 add_command_key (c
);
1649 /* Re-reading in the middle of a command */
1651 last_input_char
= c
;
1654 /* Process the help character specially if enabled */
1655 if (EQ (c
, Vhelp_char
) && !NILP (Vhelp_form
))
1658 count
= specpdl_ptr
- specpdl
;
1660 record_unwind_protect (Fset_window_configuration
,
1661 Fcurrent_window_configuration (Qnil
));
1663 tem0
= Feval (Vhelp_form
);
1664 if (XTYPE (tem0
) == Lisp_String
)
1665 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1668 c
= read_char (0, 0, 0, Qnil
, 0);
1669 /* Remove the help from the frame */
1670 unbind_to (count
, Qnil
);
1671 prepare_menu_bars ();
1673 if (EQ (c
, make_number (040)))
1676 c
= read_char (0, 0, 0, Qnil
, 0);
1687 Fprinc (object
, Qnil
);
1691 /* Copy out or in the info on where C-g should throw to.
1692 This is used when running Lisp code from within get_char,
1693 in case get_char is called recursively.
1694 See read_process_output. */
1699 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1702 restore_getcjmp (temp
)
1705 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1709 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1710 of this function. */
1712 tracking_off (old_value
)
1713 Lisp_Object old_value
;
1715 if (! XFASTINT (old_value
))
1717 do_mouse_tracking
= 0;
1719 /* Redisplay may have been preempted because there was input
1720 available, and it assumes it will be called again after the
1721 input has been processed. If the only input available was
1722 the sort that we have just disabled, then we need to call
1724 if (!readable_events ())
1726 prepare_menu_bars ();
1727 redisplay_preserve_echo_area ();
1728 get_input_pending (&input_pending
);
1733 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1734 "Evaluate BODY with mouse movement events enabled.\n\
1735 Within a `track-mouse' form, mouse motion generates input events that\n\
1736 you can read with `read-event'.\n\
1737 Normally, mouse motion is ignored.")
1741 int count
= specpdl_ptr
- specpdl
;
1744 XSET (val
, Lisp_Int
, do_mouse_tracking
);
1745 record_unwind_protect (tracking_off
, val
);
1747 do_mouse_tracking
= 1;
1749 val
= Fprogn (args
);
1750 return unbind_to (count
, val
);
1753 /* Low level keyboard/mouse input.
1754 kbd_buffer_store_event places events in kbd_buffer, and
1755 kbd_buffer_get_event retrieves them.
1756 mouse_moved indicates when the mouse has moved again, and
1757 *mouse_position_hook provides the mouse position. */
1759 /* Return true iff there are any events in the queue that read-char
1760 would return. If this returns false, a read-char would block. */
1764 return ! EVENT_QUEUES_EMPTY
;
1767 /* Set this for debugging, to have a way to get out */
1770 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
1773 kbd_buffer_store_event (event
)
1774 register struct input_event
*event
;
1776 if (event
->kind
== no_event
)
1779 if (event
->kind
== ascii_keystroke
)
1781 register int c
= event
->code
& 0377;
1783 if (event
->modifiers
& ctrl_modifier
)
1784 c
= make_ctrl_char (c
);
1786 c
|= (event
->modifiers
1787 & (meta_modifier
| alt_modifier
1788 | hyper_modifier
| super_modifier
));
1792 extern SIGTYPE
interrupt_signal ();
1795 /* If this results in a quit_char being returned to Emacs as
1796 input, set Vlast_event_frame properly. If this doesn't
1797 get returned to Emacs as an event, the next event read
1798 will set Vlast_event_frame again, so this is safe to do. */
1801 = FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
1804 internal_last_event_frame
= event
->frame_or_window
;
1806 internal_last_event_frame
= focus
;
1807 Vlast_event_frame
= internal_last_event_frame
;
1811 last_event_timestamp
= event
->timestamp
;
1812 interrupt_signal ();
1816 if (c
&& c
== stop_character
)
1823 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
1824 kbd_store_ptr
= kbd_buffer
;
1826 /* Don't let the very last slot in the buffer become full,
1827 since that would make the two pointers equal,
1828 and that is indistinguishable from an empty buffer.
1829 Discard the event if it would fill the last slot. */
1830 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
1832 kbd_store_ptr
->kind
= event
->kind
;
1833 if (event
->kind
== selection_request_event
)
1835 /* We must not use the ordinary copying code for this case,
1836 since `part' is an enum and copying it might not copy enough
1838 bcopy (event
, kbd_store_ptr
, sizeof (*event
));
1842 kbd_store_ptr
->code
= event
->code
;
1843 kbd_store_ptr
->part
= event
->part
;
1844 kbd_store_ptr
->frame_or_window
= event
->frame_or_window
;
1845 kbd_store_ptr
->modifiers
= event
->modifiers
;
1846 kbd_store_ptr
->x
= event
->x
;
1847 kbd_store_ptr
->y
= event
->y
;
1848 kbd_store_ptr
->timestamp
= event
->timestamp
;
1850 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
1852 = event
->frame_or_window
);
1858 /* Read one event from the event buffer, waiting if necessary.
1859 The value is a Lisp object representing the event.
1860 The value is nil for an event that should be ignored,
1861 or that was handled here.
1862 We always read and discard one event. */
1865 kbd_buffer_get_event ()
1873 XSET (obj
, Lisp_Int
, c
);
1877 /* Wait until there is input available. */
1880 if (!EVENT_QUEUES_EMPTY
)
1883 /* If the quit flag is set, then read_char will return
1884 quit_char, so that counts as "available input." */
1885 if (!NILP (Vquit_flag
))
1886 quit_throw_to_read_char ();
1888 /* One way or another, wait until input is available; then, if
1889 interrupt handlers have not read it, read it now. */
1892 wait_for_kbd_input ();
1894 /* Note SIGIO has been undef'd if FIONREAD is missing. */
1898 if (EVENT_QUEUES_EMPTY
)
1900 Lisp_Object minus_one
;
1902 XSET (minus_one
, Lisp_Int
, -1);
1903 wait_reading_process_input (0, 0, minus_one
, 1);
1905 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
1907 read_avail_input (0);
1910 #endif /* not VMS */
1913 /* At this point, we know that there is a readable event available
1914 somewhere. If the event queue is empty, then there must be a
1915 mouse movement enabled and available. */
1916 if (kbd_fetch_ptr
!= kbd_store_ptr
)
1918 struct input_event
*event
;
1920 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
1924 last_event_timestamp
= event
->timestamp
;
1928 /* These two kinds of events get special handling
1929 and don't actually appear to the command loop.
1930 We return nil for them. */
1931 if (event
->kind
== selection_request_event
)
1934 x_handle_selection_request (event
);
1935 kbd_fetch_ptr
= event
+ 1;
1937 /* We're getting selection request events, but we don't have
1943 else if (event
->kind
== selection_clear_event
)
1946 x_handle_selection_clear (event
);
1947 kbd_fetch_ptr
= event
+ 1;
1949 /* We're getting selection request events, but we don't have
1955 else if (event
->kind
== delete_window_event
)
1957 Lisp_Object tail
, frame
;
1960 /* If the user destroys the only frame, Emacs should exit.
1961 Count visible frames and iconified frames. */
1962 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
1964 frame
= XCONS (tail
)->car
;
1965 if (XTYPE (frame
) != Lisp_Frame
|| EQ (frame
, event
->frame_or_window
))
1968 if (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
))
1975 Fdelete_frame (event
->frame_or_window
, Qt
);
1976 kbd_fetch_ptr
= event
+ 1;
1979 /* Just discard these, by returning nil.
1980 (They shouldn't be found in the buffer,
1981 but on some machines it appears they do show up.) */
1982 else if (event
->kind
== no_event
)
1983 kbd_fetch_ptr
= event
+ 1;
1985 /* If this event is on a different frame, return a switch-frame this
1986 time, and leave the event in the queue for next time. */
1990 Lisp_Object frame
= event
->frame_or_window
;
1993 if (XTYPE (frame
) == Lisp_Window
)
1994 frame
= WINDOW_FRAME (XWINDOW (frame
));
1996 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2000 if (! EQ (frame
, internal_last_event_frame
)
2001 && XFRAME (frame
) != selected_frame
)
2002 obj
= make_lispy_switch_frame (frame
);
2003 internal_last_event_frame
= frame
;
2004 #endif /* MULTI_FRAME */
2006 /* If we didn't decide to make a switch-frame event, go ahead
2007 and build a real event from the queue entry. */
2011 obj
= make_lispy_event (event
);
2013 /* Wipe out this event, to catch bugs. */
2014 event
->kind
= no_event
;
2015 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
2018 kbd_fetch_ptr
= event
+ 1;
2022 /* Try generating a mouse motion event. */
2023 else if (do_mouse_tracking
&& mouse_moved
)
2026 Lisp_Object bar_window
;
2027 enum scroll_bar_part part
;
2031 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
2036 /* Decide if we should generate a switch-frame event. Don't
2037 generate switch-frame events for motion outside of all Emacs
2041 Lisp_Object frame
= FRAME_FOCUS_FRAME (f
);
2044 XSET (frame
, Lisp_Frame
, f
);
2046 if (! EQ (frame
, internal_last_event_frame
)
2047 && XFRAME (frame
) != selected_frame
)
2048 obj
= make_lispy_switch_frame (frame
);
2049 internal_last_event_frame
= frame
;
2053 /* If we didn't decide to make a switch-frame event, go ahead and
2054 return a mouse-motion event. */
2056 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2059 /* We were promised by the above while loop that there was
2060 something for us to read! */
2063 input_pending
= readable_events ();
2066 Vlast_event_frame
= internal_last_event_frame
;
2072 /* Process any events that are not user-visible,
2073 then return, without reading any user-visible events. */
2078 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2080 struct input_event
*event
;
2082 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2086 last_event_timestamp
= event
->timestamp
;
2088 /* These two kinds of events get special handling
2089 and don't actually appear to the command loop. */
2090 if (event
->kind
== selection_request_event
)
2093 x_handle_selection_request (event
);
2094 kbd_fetch_ptr
= event
+ 1;
2096 /* We're getting selection request events, but we don't have
2102 else if (event
->kind
== selection_clear_event
)
2105 x_handle_selection_clear (event
);
2106 kbd_fetch_ptr
= event
+ 1;
2108 /* We're getting selection request events, but we don't have
2117 get_input_pending (&input_pending
);
2120 /* Caches for modify_event_symbol. */
2121 static Lisp_Object accent_key_syms
;
2122 static Lisp_Object vendor_key_syms
;
2123 static Lisp_Object func_key_syms
;
2124 static Lisp_Object mouse_syms
;
2126 Lisp_Object Vvendor_key_alist
;
2128 /* This is a list of keysym codes for special "accent" characters.
2129 It parallels lispy_accent_keys. */
2131 static int lispy_accent_codes
[] =
2133 #ifdef XK_dead_circumflex
2138 #ifdef XK_dead_grave
2143 #ifdef XK_dead_tilde
2148 #ifdef XK_dead_diaeresis
2153 #ifdef XK_dead_macron
2158 #ifdef XK_dead_degree
2163 #ifdef XK_dead_acute
2168 #ifdef XK_dead_cedilla
2173 #ifdef XK_dead_breve
2178 #ifdef XK_dead_ogonek
2183 #ifdef XK_dead_caron
2188 #ifdef XK_dead_doubleacute
2189 XK_dead_doubleacute
,
2193 #ifdef XK_dead_abovedot
2200 /* This is a list of Lisp names for special "accent" characters.
2201 It parallels lispy_accent_codes. */
2203 static char *lispy_accent_keys
[] =
2220 /* You'll notice that this table is arranged to be conveniently
2221 indexed by X Windows keysym values. */
2222 static char *lispy_function_keys
[] =
2224 /* X Keysym value */
2226 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2234 0, 0, 0, /* 0xff10 */
2236 0, 0, 0, 0, 0, 0, 0,
2239 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2240 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2241 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2243 "home", /* 0xff50 */ /* IsCursorKey */
2254 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2265 "break", /* 0xff6b */
2267 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2269 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2270 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2271 0, 0, 0, 0, 0, 0, 0, 0,
2272 "kp-tab", /* 0xff89 */
2274 "kp-enter", /* 0xff8d */
2276 "kp-f1", /* 0xff91 */
2281 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2282 "kp-multiply", /* 0xffaa */
2287 "kp-divide", /* 0xffaf */
2288 "kp-0", /* 0xffb0 */
2289 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2292 "kp-equal", /* 0xffbd */
2293 "f1", /* 0xffbe */ /* IsFunctionKey */
2295 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2296 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2297 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2298 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2299 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2300 0, 0, 0, 0, 0, 0, 0, 0,
2301 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2302 0, 0, 0, 0, 0, 0, 0, "delete"
2305 static char *lispy_mouse_names
[] =
2307 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2310 /* Scroll bar parts. */
2311 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2313 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2314 Lisp_Object
*scroll_bar_parts
[] = {
2315 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2319 /* A vector, indexed by button number, giving the down-going location
2320 of currently depressed buttons, both scroll bar and non-scroll bar.
2322 The elements have the form
2323 (BUTTON-NUMBER MODIFIER-MASK . REST)
2324 where REST is the cdr of a position as it would be reported in the event.
2326 The make_lispy_event function stores positions here to tell the
2327 difference between click and drag events, and to store the starting
2328 location to be included in drag events. */
2330 static Lisp_Object button_down_location
;
2332 /* Information about the most recent up-going button event: Which
2333 button, what location, and what time. */
2335 static int last_mouse_button
;
2336 static int last_mouse_x
;
2337 static int last_mouse_y
;
2338 static unsigned long button_down_time
;
2340 /* The maximum time between clicks to make a double-click,
2341 or Qnil to disable double-click detection,
2342 or Qt for no time limit. */
2343 Lisp_Object Vdouble_click_time
;
2345 /* The number of clicks in this multiple-click. */
2347 int double_click_count
;
2349 /* Given a struct input_event, build the lisp event which represents
2350 it. If EVENT is 0, build a mouse movement event from the mouse
2351 movement buffer, which should have a movement event in it.
2353 Note that events must be passed to this function in the order they
2354 are received; this function stores the location of button presses
2355 in order to build drag events when the button is released. */
2358 make_lispy_event (event
)
2359 struct input_event
*event
;
2363 #ifdef SWITCH_ENUM_BUG
2364 switch ((int) event
->kind
)
2366 switch (event
->kind
)
2369 /* A simple keystroke. */
2370 case ascii_keystroke
:
2372 int c
= event
->code
& 0377;
2373 /* Turn ASCII characters into control characters
2375 if (event
->modifiers
& ctrl_modifier
)
2376 c
= make_ctrl_char (c
);
2378 /* Add in the other modifier bits. We took care of ctrl_modifier
2379 just above, and the shift key was taken care of by the X code,
2380 and applied to control characters by make_ctrl_char. */
2381 c
|= (event
->modifiers
2382 & (meta_modifier
| alt_modifier
2383 | hyper_modifier
| super_modifier
));
2384 button_down_time
= 0;
2388 /* A function key. The symbol may need to have modifier prefixes
2390 case non_ascii_keystroke
:
2391 button_down_time
= 0;
2393 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
2394 if (event
->code
== lispy_accent_codes
[i
])
2395 return modify_event_symbol (i
,
2397 Qfunction_key
, Qnil
,
2398 lispy_accent_keys
, &accent_key_syms
,
2399 (sizeof (lispy_accent_keys
)
2400 / sizeof (lispy_accent_keys
[0])));
2402 /* Handle vendor-specific keysyms. */
2403 if (event
->code
& (1 << 28))
2405 /* We need to use an alist rather than a vector as the cache
2406 since we can't make a vector long enuf. */
2407 if (NILP (vendor_key_syms
))
2408 vendor_key_syms
= Fcons (Qnil
, Qnil
);
2409 return modify_event_symbol (event
->code
& 0xffffff,
2411 Qfunction_key
, Vvendor_key_alist
,
2412 0, &vendor_key_syms
, 0xffffff);
2415 return modify_event_symbol (event
->code
- 0xff00,
2417 Qfunction_key
, Qnil
,
2418 lispy_function_keys
, &func_key_syms
,
2419 (sizeof (lispy_function_keys
)
2420 / sizeof (lispy_function_keys
[0])));
2423 /* A mouse click. Figure out where it is, decide whether it's
2424 a press, click or drag, and build the appropriate structure. */
2426 case scroll_bar_click
:
2428 int button
= event
->code
;
2430 Lisp_Object position
;
2431 Lisp_Object
*start_pos_ptr
;
2432 Lisp_Object start_pos
;
2434 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2437 /* Build the position as appropriate for this mouse click. */
2438 if (event
->kind
== mouse_click
)
2441 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2443 = window_from_coordinates (f
, XINT (event
->x
), XINT (event
->y
),
2447 if (XINT (event
->y
) < FRAME_MENU_BAR_LINES (f
))
2451 items
= FRAME_MENU_BAR_ITEMS (f
);
2452 for (; CONSP (items
); items
= XCONS (items
)->cdr
)
2454 Lisp_Object pos
, string
;
2455 pos
= Fcdr (Fcdr (Fcar (items
)));
2456 string
= Fcar (Fcdr (Fcar (items
)));
2457 if (XINT (event
->x
) >= XINT (pos
)
2458 && XINT (event
->x
) < XINT (pos
) + XSTRING (string
)->size
)
2462 = Fcons (event
->frame_or_window
,
2464 Fcons (Fcons (event
->x
, event
->y
),
2465 Fcons (make_number (event
->timestamp
),
2469 return Fcons (Fcar (Fcar (items
)),
2470 Fcons (position
, Qnil
));
2472 return Fcons (Qnil
, Fcons (position
, Qnil
));
2474 else if (XTYPE (window
) != Lisp_Window
)
2479 (XINT (event
->x
) - XINT (XWINDOW (window
)->left
)));
2481 (XINT (event
->y
) - XINT (XWINDOW (window
)->top
)));
2486 posn
= Qvertical_line
;
2488 XSET (posn
, Lisp_Int
,
2489 buffer_posn_from_coords (XWINDOW (window
),
2497 Fcons (Fcons (event
->x
, event
->y
),
2498 Fcons (make_number (event
->timestamp
),
2503 Lisp_Object window
= event
->frame_or_window
;
2504 Lisp_Object portion_whole
= Fcons (event
->x
, event
->y
);
2505 Lisp_Object part
= *scroll_bar_parts
[(int) event
->part
];
2509 Fcons (Qvertical_scroll_bar
,
2510 Fcons (portion_whole
,
2511 Fcons (make_number (event
->timestamp
),
2516 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2518 start_pos
= *start_pos_ptr
;
2519 *start_pos_ptr
= Qnil
;
2521 is_double
= (button
== last_mouse_button
2522 && XINT (event
->x
) == last_mouse_x
2523 && XINT (event
->y
) == last_mouse_y
2524 && button_down_time
!= 0
2525 && (EQ (Vdouble_click_time
, Qt
)
2526 || (INTEGERP (Vdouble_click_time
)
2527 && ((int)(event
->timestamp
- button_down_time
)
2528 < XINT (Vdouble_click_time
)))));
2529 last_mouse_button
= button
;
2530 last_mouse_x
= XINT (event
->x
);
2531 last_mouse_y
= XINT (event
->y
);
2533 /* If this is a button press, squirrel away the location, so
2534 we can decide later whether it was a click or a drag. */
2535 if (event
->modifiers
& down_modifier
)
2539 double_click_count
++;
2540 event
->modifiers
|= ((double_click_count
> 2)
2545 double_click_count
= 1;
2546 button_down_time
= event
->timestamp
;
2547 *start_pos_ptr
= Fcopy_alist (position
);
2550 /* Now we're releasing a button - check the co-ordinates to
2551 see if this was a click or a drag. */
2552 else if (event
->modifiers
& up_modifier
)
2554 /* If we did not see a down before this up,
2555 ignore the up. Probably this happened because
2556 the down event chose a menu item.
2557 It would be an annoyance to treat the release
2558 of the button that chose the menu item
2559 as a separate event. */
2561 if (XTYPE (start_pos
) != Lisp_Cons
)
2564 event
->modifiers
&= ~up_modifier
;
2565 #if 0 /* Formerly we treated an up with no down as a click event. */
2566 if (XTYPE (start_pos
) != Lisp_Cons
)
2567 event
->modifiers
|= click_modifier
;
2571 /* The third element of every position should be the (x,y)
2573 Lisp_Object down
= Fnth (make_number (2), start_pos
);
2575 if (EQ (event
->x
, XCONS (down
)->car
)
2576 && EQ (event
->y
, XCONS (down
)->cdr
))
2578 if (is_double
&& double_click_count
> 1)
2579 event
->modifiers
|= ((double_click_count
> 2)
2583 event
->modifiers
|= click_modifier
;
2587 button_down_time
= 0;
2588 event
->modifiers
|= drag_modifier
;
2593 /* Every mouse event should either have the down_modifier or
2594 the up_modifier set. */
2598 /* Get the symbol we should use for the mouse click. */
2600 = modify_event_symbol (button
,
2603 lispy_mouse_names
, &mouse_syms
,
2604 (sizeof (lispy_mouse_names
)
2605 / sizeof (lispy_mouse_names
[0])));
2607 if (event
->modifiers
& drag_modifier
)
2612 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2615 Fcons (make_number (double_click_count
),
2624 /* The 'kind' field of the event is something we don't recognize. */
2631 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2633 Lisp_Object bar_window
;
2634 enum scroll_bar_part part
;
2638 /* Is it a scroll bar movement? */
2639 if (frame
&& ! NILP (bar_window
))
2641 Lisp_Object part_sym
= *scroll_bar_parts
[(int) part
];
2643 return Fcons (Qscroll_bar_movement
,
2644 (Fcons (Fcons (bar_window
,
2645 Fcons (Qvertical_scroll_bar
,
2646 Fcons (Fcons (x
, y
),
2647 Fcons (make_number (time
),
2653 /* Or is it an ordinary mouse movement? */
2657 Lisp_Object window
=
2659 ? window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
)
2663 if (XTYPE (window
) == Lisp_Window
)
2665 XSETINT (x
, XINT (x
) - XINT (XWINDOW (window
)->left
));
2666 XSETINT (y
, XINT (y
) - XINT (XWINDOW (window
)->top
));
2671 posn
= Qvertical_line
;
2673 XSET (posn
, Lisp_Int
,
2674 buffer_posn_from_coords (XWINDOW (window
),
2675 XINT (x
), XINT (y
)));
2677 else if (frame
!= 0)
2679 XSET (window
, Lisp_Frame
, frame
);
2690 return Fcons (Qmouse_movement
,
2691 Fcons (Fcons (window
,
2693 Fcons (Fcons (x
, y
),
2694 Fcons (make_number (time
),
2700 /* Construct a switch frame event. */
2702 make_lispy_switch_frame (frame
)
2705 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
2708 /* Manipulating modifiers. */
2710 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
2712 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2713 SYMBOL's name of the end of the modifiers; the string from this
2714 position is the unmodified symbol name.
2716 This doesn't use any caches. */
2718 parse_modifiers_uncached (symbol
, modifier_end
)
2722 struct Lisp_String
*name
;
2726 CHECK_SYMBOL (symbol
, 1);
2729 name
= XSYMBOL (symbol
)->name
;
2732 for (i
= 0; i
+2 <= name
->size
; )
2733 switch (name
->data
[i
])
2735 #define SINGLE_LETTER_MOD(bit) \
2736 if (name->data[i+1] != '-') \
2737 goto no_more_modifiers; \
2742 SINGLE_LETTER_MOD (alt_modifier
);
2746 SINGLE_LETTER_MOD (ctrl_modifier
);
2750 SINGLE_LETTER_MOD (hyper_modifier
);
2754 SINGLE_LETTER_MOD (meta_modifier
);
2758 SINGLE_LETTER_MOD (shift_modifier
);
2762 SINGLE_LETTER_MOD (super_modifier
);
2766 if (i
+ 5 > name
->size
)
2767 goto no_more_modifiers
;
2768 if (! strncmp (name
->data
+ i
, "drag-", 5))
2770 modifiers
|= drag_modifier
;
2773 else if (! strncmp (name
->data
+ i
, "down-", 5))
2775 modifiers
|= down_modifier
;
2778 else if (i
+ 7 <= name
->size
2779 && ! strncmp (name
->data
+ i
, "double-", 7))
2781 modifiers
|= double_modifier
;
2785 goto no_more_modifiers
;
2789 if (i
+ 7 > name
->size
)
2790 goto no_more_modifiers
;
2791 if (! strncmp (name
->data
+ i
, "triple-", 7))
2793 modifiers
|= triple_modifier
;
2797 goto no_more_modifiers
;
2801 goto no_more_modifiers
;
2803 #undef SINGLE_LETTER_MOD
2807 /* Should we include the `click' modifier? */
2808 if (! (modifiers
& (down_modifier
| drag_modifier
2809 | double_modifier
| triple_modifier
))
2810 && i
+ 7 == name
->size
2811 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
2812 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
2813 modifiers
|= click_modifier
;
2822 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
2823 prepended to the string BASE[0..BASE_LEN-1].
2824 This doesn't use any caches. */
2826 apply_modifiers_uncached (modifiers
, base
, base_len
)
2831 /* Since BASE could contain nulls, we can't use intern here; we have
2832 to use Fintern, which expects a genuine Lisp_String, and keeps a
2835 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
2841 /* Only the event queue may use the `up' modifier; it should always
2842 be turned into a click or drag event before presented to lisp code. */
2843 if (modifiers
& up_modifier
)
2846 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
2847 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
2848 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
2849 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
2850 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
2851 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
2852 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
2853 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
2854 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
2855 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
2856 /* The click modifier is denoted by the absence of other modifiers. */
2860 mod_len
= p
- new_mods
;
2864 Lisp_Object new_name
= make_uninit_string (mod_len
+ base_len
);
2866 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
2867 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
2869 return Fintern (new_name
, Qnil
);
2874 static char *modifier_names
[] =
2876 "up", "down", "drag", "click", "double", "triple", 0, 0,
2877 0, 0, 0, 0, 0, 0, 0, 0,
2878 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
2880 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
2882 static Lisp_Object modifier_symbols
;
2884 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
2886 lispy_modifier_list (modifiers
)
2889 Lisp_Object modifier_list
;
2892 modifier_list
= Qnil
;
2893 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
2894 if (modifiers
& (1<<i
))
2895 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
2898 return modifier_list
;
2902 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
2903 where UNMODIFIED is the unmodified form of SYMBOL,
2904 MASK is the set of modifiers present in SYMBOL's name.
2905 This is similar to parse_modifiers_uncached, but uses the cache in
2906 SYMBOL's Qevent_symbol_element_mask property, and maintains the
2907 Qevent_symbol_elements property. */
2909 parse_modifiers (symbol
)
2912 Lisp_Object elements
= Fget (symbol
, Qevent_symbol_element_mask
);
2914 if (CONSP (elements
))
2919 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
2920 Lisp_Object unmodified
2921 = Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
2922 XSYMBOL (symbol
)->name
->size
- end
),
2926 if (modifiers
& ~((1<<VALBITS
) - 1))
2928 XFASTINT (mask
) = modifiers
;
2929 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
2931 /* Cache the parsing results on SYMBOL. */
2932 Fput (symbol
, Qevent_symbol_element_mask
,
2934 Fput (symbol
, Qevent_symbol_elements
,
2935 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
2937 /* Since we know that SYMBOL is modifiers applied to unmodified,
2938 it would be nice to put that in unmodified's cache.
2939 But we can't, since we're not sure that parse_modifiers is
2946 /* Apply the modifiers MODIFIERS to the symbol BASE.
2947 BASE must be unmodified.
2949 This is like apply_modifiers_uncached, but uses BASE's
2950 Qmodifier_cache property, if present. It also builds
2951 Qevent_symbol_elements properties, since it has that info anyway.
2953 apply_modifiers copies the value of BASE's Qevent_kind property to
2954 the modified symbol. */
2956 apply_modifiers (modifiers
, base
)
2960 Lisp_Object cache
, index
, entry
, new_symbol
;
2962 /* Mask out upper bits. We don't know where this value's been. */
2963 modifiers
&= (1<<VALBITS
) - 1;
2965 /* The click modifier never figures into cache indices. */
2966 cache
= Fget (base
, Qmodifier_cache
);
2967 XFASTINT (index
) = (modifiers
& ~click_modifier
);
2968 entry
= Fassq (index
, cache
);
2971 new_symbol
= XCONS (entry
)->cdr
;
2974 /* We have to create the symbol ourselves. */
2975 new_symbol
= apply_modifiers_uncached (modifiers
,
2976 XSYMBOL (base
)->name
->data
,
2977 XSYMBOL (base
)->name
->size
);
2979 /* Add the new symbol to the base's cache. */
2980 entry
= Fcons (index
, new_symbol
);
2981 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
2983 /* We have the parsing info now for free, so add it to the caches. */
2984 XFASTINT (index
) = modifiers
;
2985 Fput (new_symbol
, Qevent_symbol_element_mask
,
2986 Fcons (base
, Fcons (index
, Qnil
)));
2987 Fput (new_symbol
, Qevent_symbol_elements
,
2988 Fcons (base
, lispy_modifier_list (modifiers
)));
2991 /* Make sure this symbol is of the same kind as BASE.
2993 You'd think we could just set this once and for all when we
2994 intern the symbol above, but reorder_modifiers may call us when
2995 BASE's property isn't set right; we can't assume that just
2996 because it has a Qmodifier_cache property it must have its
2997 Qevent_kind set right as well. */
2998 if (NILP (Fget (new_symbol
, Qevent_kind
)))
3000 Lisp_Object kind
= Fget (base
, Qevent_kind
);
3003 Fput (new_symbol
, Qevent_kind
, kind
);
3010 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
3011 return a symbol with the modifiers placed in the canonical order.
3012 Canonical order is alphabetical, except for down and drag, which
3013 always come last. The 'click' modifier is never written out.
3015 Fdefine_key calls this to make sure that (for example) C-M-foo
3016 and M-C-foo end up being equivalent in the keymap. */
3019 reorder_modifiers (symbol
)
3022 /* It's hopefully okay to write the code this way, since everything
3023 will soon be in caches, and no consing will be done at all. */
3024 Lisp_Object parsed
= parse_modifiers (symbol
);
3026 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
3027 XCONS (parsed
)->car
);
3031 /* For handling events, we often want to produce a symbol whose name
3032 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
3033 to some base, like the name of a function key or mouse button.
3034 modify_event_symbol produces symbols of this sort.
3036 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
3037 is the name of the i'th symbol. TABLE_SIZE is the number of elements
3040 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
3041 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
3043 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
3044 persist between calls to modify_event_symbol that it can use to
3045 store a cache of the symbols it's generated for this NAME_TABLE
3046 before. The object stored there may be a vector or an alist.
3048 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
3050 MODIFIERS is a set of modifier bits (as given in struct input_events)
3051 whose prefixes should be applied to the symbol name.
3053 SYMBOL_KIND is the value to be placed in the event_kind property of
3054 the returned symbol.
3056 The symbols we create are supposed to have an
3057 `event-symbol-elements' property, which lists the modifiers present
3058 in the symbol's name. */
3061 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
3062 name_table
, symbol_table
, table_size
)
3065 Lisp_Object symbol_kind
;
3066 Lisp_Object name_alist
;
3068 Lisp_Object
*symbol_table
;
3072 Lisp_Object symbol_int
;
3074 XSET (symbol_int
, Lisp_Int
, symbol_num
);
3076 /* Is this a request for a valid symbol? */
3077 if (symbol_num
< 0 || symbol_num
>= table_size
)
3080 if (CONSP (*symbol_table
))
3081 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
3083 /* If *symbol_table doesn't seem to be initialized properly, fix that.
3084 *symbol_table should be a lisp vector TABLE_SIZE elements long,
3085 where the Nth element is the symbol for NAME_TABLE[N], or nil if
3086 we've never used that symbol before. */
3089 if (! VECTORP (*symbol_table
)
3090 || XVECTOR (*symbol_table
)->size
!= table_size
)
3094 XFASTINT (size
) = table_size
;
3095 *symbol_table
= Fmake_vector (size
, Qnil
);
3098 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
3101 /* Have we already used this symbol before? */
3104 /* No; let's create it. */
3105 if (!NILP (name_alist
))
3106 value
= Fassq (symbol_int
, name_alist
);
3107 else if (name_table
[symbol_num
])
3108 value
= intern (name_table
[symbol_num
]);
3112 sprintf (buf
, "key-%d", symbol_num
);
3113 value
= intern (buf
);
3116 if (CONSP (*symbol_table
))
3117 *symbol_table
= Fcons (value
, *symbol_table
);
3119 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
3121 /* Fill in the cache entries for this symbol; this also
3122 builds the Qevent_symbol_elements property, which the user
3124 apply_modifiers (modifiers
& click_modifier
, value
);
3125 Fput (value
, Qevent_kind
, symbol_kind
);
3128 /* Apply modifiers to that symbol. */
3129 return apply_modifiers (modifiers
, value
);
3133 /* Store into *addr a value nonzero if terminal input chars are available.
3134 Serves the purpose of ioctl (0, FIONREAD, addr)
3135 but works even if FIONREAD does not exist.
3136 (In fact, this may actually read some input.) */
3139 get_input_pending (addr
)
3142 /* First of all, have we already counted some input? */
3143 *addr
= !NILP (Vquit_flag
) || readable_events ();
3145 /* If input is being read as it arrives, and we have none, there is none. */
3146 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
3149 /* Try to read some input and see how much we get. */
3151 *addr
= !NILP (Vquit_flag
) || readable_events ();
3154 /* Interface to read_avail_input, blocking SIGIO if necessary. */
3157 gobble_input (expected
)
3162 if (interrupt_input
)
3165 mask
= sigblockx (SIGIO
);
3166 read_avail_input (expected
);
3171 read_avail_input (expected
);
3177 /* Read any terminal input already buffered up by the system
3178 into the kbd_buffer, but do not wait.
3180 EXPECTED should be nonzero if the caller knows there is some input.
3182 Except on VMS, all input is read by this function.
3183 If interrupt_input is nonzero, this function MUST be called
3184 only when SIGIO is blocked.
3186 Returns the number of keyboard chars read, or -1 meaning
3187 this is a bad time to try to read input. */
3190 read_avail_input (expected
)
3193 struct input_event buf
[KBD_BUFFER_SIZE
];
3197 if (read_socket_hook
)
3198 /* No need for FIONREAD or fcntl; just say don't wait. */
3199 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
3202 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
3203 the kbd_buffer can really hold. That may prevent loss
3204 of characters on some systems when input is stuffed at us. */
3205 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
3208 nread
= dos_keysns ();
3209 if (nread
== 0) return 0;
3210 #else */ not MSDOS */
3212 /* Find out how much input is available. */
3213 if (ioctl (0, FIONREAD
, &nread
) < 0)
3214 /* Formerly simply reported no input, but that sometimes led to
3215 a failure of Emacs to terminate.
3216 SIGHUP seems appropriate if we can't reach the terminal. */
3217 /* ??? Is it really right to send the signal just to this process
3218 rather than to the whole process group?
3219 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3220 kill (getpid (), SIGHUP
);
3223 if (nread
> sizeof cbuf
)
3224 nread
= sizeof cbuf
;
3225 #else /* no FIONREAD */
3226 #if defined(USG) || defined(DGUX)
3227 /* Read some input if available, but don't wait. */
3228 nread
= sizeof cbuf
;
3229 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
3234 #endif /* not MSDOS */
3236 /* Now read; for one reason or another, this will not block. */
3240 cbuf
[0] = dos_keyread();
3243 nread
= read (fileno (stdin
), cbuf
, nread
);
3246 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3247 This looks incorrect, but it isn't, because _BSD causes
3248 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3249 and that causes a value other than 0 when there is no input. */
3253 /* This code is wrong, but at least it gets the right results.
3254 Fix it for 19.23. */
3255 /* Retry the read if it is interrupted. */
3258 || ! (errno
== EAGAIN
|| errno
== EFAULT
3260 || ! (errno
== EAGAIN
3270 #if defined (USG) || defined (DGUX)
3271 fcntl (fileno (stdin
), F_SETFL
, 0);
3272 #endif /* USG or DGUX */
3273 #endif /* no FIONREAD */
3274 for (i
= 0; i
< nread
; i
++)
3276 buf
[i
].kind
= ascii_keystroke
;
3277 buf
[i
].modifiers
= 0;
3278 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3279 buf
[i
].modifiers
= meta_modifier
;
3283 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
3285 XSET (buf
[i
].frame_or_window
, Lisp_Frame
, selected_frame
);
3287 buf
[i
].frame_or_window
= Qnil
;
3292 /* Scan the chars for C-g and store them in kbd_buffer. */
3293 for (i
= 0; i
< nread
; i
++)
3295 kbd_buffer_store_event (&buf
[i
]);
3296 /* Don't look at input that follows a C-g too closely.
3297 This reduces lossage due to autorepeat on C-g. */
3298 if (buf
[i
].kind
== ascii_keystroke
3299 && XINT(buf
[i
].code
) == quit_char
)
3305 #endif /* not VMS */
3307 #ifdef SIGIO /* for entire page */
3308 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3311 input_available_signal (signo
)
3314 /* Must preserve main program's value of errno. */
3315 int old_errno
= errno
;
3317 extern int select_alarmed
;
3321 /* USG systems forget handlers when they are used;
3322 must reestablish each time */
3323 signal (signo
, input_available_signal
);
3330 if (input_available_clear_time
)
3331 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3336 nread
= read_avail_input (1);
3337 /* -1 means it's not ok to read the input now.
3338 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3339 0 means there was no keyboard input available. */
3344 select_alarmed
= 1; /* Force the select emulator back to life */
3355 /* Send ourselves a SIGIO.
3357 This function exists so that the UNBLOCK_INPUT macro in
3358 blockinput.h can have some way to take care of input we put off
3359 dealing with, without assuming that every file which uses
3360 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3362 reinvoke_input_signal ()
3371 /* Return the prompt-string of a sparse keymap.
3372 This is the first element which is a string.
3373 Return nil if there is none. */
3381 register Lisp_Object tem
;
3383 if (XTYPE (tem
) == Lisp_String
)
3390 static Lisp_Object
menu_bar_item ();
3391 static Lisp_Object
menu_bar_one_keymap ();
3393 /* Return a list of menu items for a menu bar, appropriate
3394 to the current buffer.
3395 The elements have the form (KEY STRING . nil). */
3400 /* The number of keymaps we're scanning right now, and the number of
3401 keymaps we have allocated space for. */
3404 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3405 in the current keymaps, or nil where it is not a prefix. */
3408 Lisp_Object def
, tem
, tail
;
3415 /* In order to build the menus, we need to call the keymap
3416 accessors. They all call QUIT. But this function is called
3417 during redisplay, during which a quit is fatal. So inhibit
3418 quitting while building the menus.
3419 We do this instead of specbind because (1) errors will clear it anyway
3420 and (2) this avoids risk of specpdl overflow. */
3421 oquit
= Vinhibit_quit
;
3424 /* Build our list of keymaps.
3425 If we recognize a function key and replace its escape sequence in
3426 keybuf with its symbol, or if the sequence starts with a mouse
3427 click and we need to switch buffers, we jump back here to rebuild
3428 the initial keymaps from the current buffer. */
3432 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3433 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3434 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3435 #ifdef USE_TEXT_PROPERTIES
3436 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3438 maps
[nmaps
-2] = current_buffer
->keymap
;
3440 maps
[nmaps
-1] = current_global_map
;
3443 /* Look up in each map the dummy prefix key `menu-bar'. */
3447 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3449 if (! NILP (maps
[mapno
]))
3450 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3454 tem
= Fkeymapp (def
);
3456 result
= menu_bar_one_keymap (def
, result
);
3459 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3463 elt
= Fassq (XCONS (tail
)->car
, result
);
3465 result
= Fcons (elt
, Fdelq (elt
, result
));
3468 result
= Fnreverse (result
);
3469 Vinhibit_quit
= oquit
;
3473 /* Scan one map KEYMAP, accumulating any menu items it defines
3474 that have not yet been seen in RESULT. Return the updated RESULT. */
3477 menu_bar_one_keymap (keymap
, result
)
3478 Lisp_Object keymap
, result
;
3480 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3482 /* Loop over all keymap entries that have menu strings. */
3483 for (tail
= keymap
; XTYPE (tail
) == Lisp_Cons
; tail
= XCONS (tail
)->cdr
)
3485 item
= XCONS (tail
)->car
;
3486 if (XTYPE (item
) == Lisp_Cons
)
3488 key
= XCONS (item
)->car
;
3489 binding
= XCONS (item
)->cdr
;
3490 if (XTYPE (binding
) == Lisp_Cons
)
3492 item_string
= XCONS (binding
)->car
;
3493 if (XTYPE (item_string
) == Lisp_String
)
3494 result
= menu_bar_item (key
, item_string
,
3495 Fcdr (binding
), result
);
3497 else if (EQ (binding
, Qundefined
))
3498 result
= menu_bar_item (key
, item_string
,
3501 else if (XTYPE (item
) == Lisp_Vector
)
3503 /* Loop over the char values represented in the vector. */
3504 int len
= XVECTOR (item
)->size
;
3506 for (c
= 0; c
< len
; c
++)
3508 Lisp_Object character
;
3509 XFASTINT (character
) = c
;
3510 binding
= XVECTOR (item
)->contents
[c
];
3511 if (XTYPE (binding
) == Lisp_Cons
)
3513 item_string
= XCONS (binding
)->car
;
3514 if (XTYPE (item_string
) == Lisp_String
)
3515 result
= menu_bar_item (key
, item_string
,
3516 Fcdr (binding
), result
);
3518 else if (EQ (binding
, Qundefined
))
3519 result
= menu_bar_item (key
, item_string
,
3529 menu_bar_item (key
, item_string
, def
, result
)
3530 Lisp_Object key
, item_string
, def
, result
;
3533 Lisp_Object enabled
;
3535 if (EQ (def
, Qundefined
))
3537 /* If a map has an explicit nil as definition,
3538 discard any previously made menu bar item. */
3539 tem
= Fassq (key
, result
);
3540 return Fdelq (tem
, result
);
3543 /* See if this entry is enabled. */
3546 if (XTYPE (def
) == Lisp_Symbol
)
3548 /* No property, or nil, means enable.
3549 Otherwise, enable if value is not nil. */
3550 tem
= Fget (def
, Qmenu_enable
);
3552 enabled
= Feval (tem
);
3555 /* Add an entry for this key and string
3556 if there is none yet. */
3557 tem
= Fassq (key
, result
);
3558 if (!NILP (enabled
) && NILP (tem
))
3559 result
= Fcons (Fcons (key
, Fcons (item_string
, Qnil
)), result
);
3564 /* Read a character using menus based on maps in the array MAPS.
3565 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
3566 Return t if we displayed a menu but the user rejected it.
3568 PREV_EVENT is the previous input event, or nil if we are reading
3569 the first event of a key sequence.
3571 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3572 if we used a mouse menu to read the input, or zero otherwise. If
3573 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
3575 The prompting is done based on the prompt-string of the map
3576 and the strings associated with various map elements. */
3579 read_char_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
3582 Lisp_Object prev_event
;
3583 int *used_mouse_menu
;
3586 register Lisp_Object name
;
3588 int width
= FRAME_WIDTH (selected_frame
) - 4;
3589 char *menu
= (char *) alloca (width
+ 4);
3591 Lisp_Object rest
, vector
;
3593 if (used_mouse_menu
)
3594 *used_mouse_menu
= 0;
3596 /* Use local over global Menu maps */
3598 if (! menu_prompting
)
3601 /* Get the menu name from the first map that has one (a prompt string). */
3602 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3604 name
= map_prompt (maps
[mapno
]);
3609 /* If we don't have any menus, just read a character normally. */
3613 #ifdef HAVE_X_WINDOWS
3615 /* If we got to this point via a mouse click,
3616 use a real menu for mouse selection. */
3617 if (EVENT_HAS_PARAMETERS (prev_event
))
3619 /* Display the menu and get the selection. */
3620 Lisp_Object
*realmaps
3621 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
3625 /* Use the maps that are not nil. */
3626 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3627 if (!NILP (maps
[mapno
]))
3628 realmaps
[nmaps1
++] = maps
[mapno
];
3630 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
3633 /* If we got more than one event, put all but the first
3634 onto this list to be read later.
3635 Return just the first event now. */
3636 unread_command_events
3637 = nconc2 (XCONS (value
)->cdr
, unread_command_events
);
3638 value
= XCONS (value
)->car
;
3642 if (used_mouse_menu
)
3643 *used_mouse_menu
= 1;
3646 #endif /* HAVE_X_MENU */
3647 #endif /* HAVE_X_WINDOWS */
3649 /* Prompt string always starts with map's prompt, and a space. */
3650 strcpy (menu
, XSTRING (name
)->data
);
3651 nlength
= XSTRING (name
)->size
;
3652 menu
[nlength
++] = ':';
3653 menu
[nlength
++] = ' ';
3656 /* Start prompting at start of first map. */
3660 /* Present the documented bindings, a line at a time. */
3668 /* Loop over elements of map. */
3673 /* If reached end of map, start at beginning of next map. */
3677 /* At end of last map, wrap around to first map if just starting,
3678 or end this line if already have something on it. */
3689 /* Look at the next element of the map. */
3691 elt
= XVECTOR (vector
)->contents
[idx
];
3693 elt
= Fcar_safe (rest
);
3695 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
3697 /* If we found a dense table in the keymap,
3698 advanced past it, but start scanning its contents. */
3699 rest
= Fcdr_safe (rest
);
3705 /* An ordinary element. */
3706 s
= Fcar_safe (Fcdr_safe (elt
));
3707 if (XTYPE (s
) != Lisp_String
)
3708 /* Ignore the element if it has no prompt string. */
3710 /* If we have room for the prompt string, add it to this line.
3711 If this is the first on the line, always add it. */
3712 else if (XSTRING (s
)->size
+ i
< width
3717 /* Punctuate between strings. */
3720 strcpy (menu
+ i
, ", ");
3725 /* Add as much of string as fits. */
3726 thiswidth
= XSTRING (s
)->size
;
3727 if (thiswidth
+ i
> width
)
3728 thiswidth
= width
- i
;
3729 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
3734 /* If this element does not fit, end the line now,
3735 and save the element for the next line. */
3736 strcpy (menu
+ i
, "...");
3740 /* Move past this element. */
3741 if (idx
>= 0 && idx
+ 1 >= XVECTOR (rest
)->size
)
3742 /* Handle reaching end of dense table. */
3747 rest
= Fcdr_safe (rest
);
3751 /* Prompt with that and read response. */
3753 obj
= read_char (1, 0, 0, Qnil
, 0);
3755 if (XTYPE (obj
) != Lisp_Int
)
3760 if (! EQ (obj
, menu_prompt_more_char
)
3761 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
3762 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
3767 /* Reading key sequences. */
3769 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
3770 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
3771 keymap, or nil otherwise. Return the index of the first keymap in
3772 which KEY has any binding, or NMAPS if no map has a binding.
3774 If KEY is a meta ASCII character, treat it like meta-prefix-char
3775 followed by the corresponding non-meta character. Keymaps in
3776 CURRENT with non-prefix bindings for meta-prefix-char become nil in
3779 When KEY is not defined in any of the keymaps, if it is an upper
3780 case letter and there are bindings for the corresponding lower-case
3781 letter, return the bindings for the lower-case letter.
3782 We store 1 in *CASE_CONVERTED in this case.
3783 Otherwise, we don't change *CASE_CONVERTED.
3785 If KEY has no bindings in any of the CURRENT maps, NEXT is left
3788 NEXT may == CURRENT. */
3791 follow_key (key
, nmaps
, current
, defs
, next
, case_converted
)
3793 Lisp_Object
*current
, *defs
, *next
;
3795 int *case_converted
;
3797 int i
, first_binding
;
3799 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
3800 followed by the corresponding non-meta character. */
3801 if (XTYPE (key
) == Lisp_Int
&& (XINT (key
) & CHAR_META
))
3803 for (i
= 0; i
< nmaps
; i
++)
3804 if (! NILP (current
[i
]))
3807 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
3809 /* Note that since we pass the resulting bindings through
3810 get_keymap_1, non-prefix bindings for meta-prefix-char
3812 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
3818 XSET (key
, Lisp_Int
, XFASTINT (key
) & ~CHAR_META
);
3821 first_binding
= nmaps
;
3822 for (i
= nmaps
- 1; i
>= 0; i
--)
3824 if (! NILP (current
[i
]))
3826 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3827 if (! NILP (defs
[i
]))
3834 /* When KEY is not defined in any of the keymaps, if it is an upper
3835 case letter and there are bindings for the corresponding
3836 lower-case letter, return the bindings for the lower-case letter. */
3837 if (first_binding
== nmaps
3838 && XTYPE (key
) == Lisp_Int
3839 && ((((XINT (key
) & 0x3ffff)
3840 < XSTRING (current_buffer
->downcase_table
)->size
)
3841 && UPPERCASEP (XINT (key
) & 0x3ffff))
3842 || (XINT (key
) & shift_modifier
)))
3844 if (XINT (key
) & shift_modifier
)
3845 XSETINT (key
, XINT (key
) & ~shift_modifier
);
3847 XSETINT (key
, (DOWNCASE (XINT (key
) & 0x3ffff)
3848 | (XINT (key
) & ~0x3ffff)));
3850 first_binding
= nmaps
;
3851 for (i
= nmaps
- 1; i
>= 0; i
--)
3853 if (! NILP (current
[i
]))
3855 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3856 if (! NILP (defs
[i
]))
3862 if (first_binding
!= nmaps
)
3863 *case_converted
= 1;
3866 /* Given the set of bindings we've found, produce the next set of maps. */
3867 if (first_binding
< nmaps
)
3868 for (i
= 0; i
< nmaps
; i
++)
3869 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
3871 return first_binding
;
3874 /* Read a sequence of keys that ends with a non prefix character,
3875 storing it in KEYBUF, a buffer of size BUFSIZE.
3877 Return the length of the key sequence stored.
3878 Return -1 if the user rejected a command menu.
3880 Echo starting immediately unless `prompt' is 0.
3882 Where a key sequence ends depends on the currently active keymaps.
3883 These include any minor mode keymaps active in the current buffer,
3884 the current buffer's local map, and the global map.
3886 If a key sequence has no other bindings, we check Vfunction_key_map
3887 to see if some trailing subsequence might be the beginning of a
3888 function key's sequence. If so, we try to read the whole function
3889 key, and substitute its symbolic name into the key sequence.
3891 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
3892 `double-' events into similar click events, if that would make them
3893 bound. We try to turn `triple-' events first into `double-' events,
3896 If we get a mouse click in a mode line, vertical divider, or other
3897 non-text area, we treat the click as if it were prefixed by the
3898 symbol denoting that area - `mode-line', `vertical-line', or
3901 If the sequence starts with a mouse click, we read the key sequence
3902 with respect to the buffer clicked on, not the current buffer.
3904 If the user switches frames in the midst of a key sequence, we put
3905 off the switch-frame event until later; the next call to
3906 read_char will return it. */
3909 read_key_sequence (keybuf
, bufsize
, prompt
)
3910 Lisp_Object
*keybuf
;
3914 int count
= specpdl_ptr
- specpdl
;
3916 /* How many keys there are in the current key sequence. */
3919 /* The length of the echo buffer when we started reading, and
3920 the length of this_command_keys when we started reading. */
3924 /* The number of keymaps we're scanning right now, and the number of
3925 keymaps we have allocated space for. */
3927 int nmaps_allocated
= 0;
3929 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
3930 the current keymaps. */
3933 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3934 in the current keymaps, or nil where it is not a prefix. */
3935 Lisp_Object
*submaps
;
3937 /* The index in defs[] of the first keymap that has a binding for
3938 this key sequence. In other words, the lowest i such that
3939 defs[i] is non-nil. */
3942 /* If t < mock_input, then KEYBUF[t] should be read as the next
3945 We use this to recover after recognizing a function key. Once we
3946 realize that a suffix of the current key sequence is actually a
3947 function key's escape sequence, we replace the suffix with the
3948 function key's binding from Vfunction_key_map. Now keybuf
3949 contains a new and different key sequence, so the echo area,
3950 this_command_keys, and the submaps and defs arrays are wrong. In
3951 this situation, we set mock_input to t, set t to 0, and jump to
3952 restart_sequence; the loop will read keys from keybuf up until
3953 mock_input, thus rebuilding the state; and then it will resume
3954 reading characters from the keyboard. */
3957 /* If the sequence is unbound in submaps[], then
3958 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
3959 and fkey_map is its binding.
3961 These might be > t, indicating that all function key scanning
3962 should hold off until t reaches them. We do this when we've just
3963 recognized a function key, to avoid searching for the function
3964 key's again in Vfunction_key_map. */
3965 int fkey_start
= 0, fkey_end
= 0;
3966 Lisp_Object fkey_map
;
3968 /* Likewise, for key_translation_map. */
3969 int keytran_start
= 0, keytran_end
= 0;
3970 Lisp_Object keytran_map
;
3972 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
3973 we put it off for later. While we're reading, we keep the event here. */
3974 Lisp_Object delayed_switch_frame
;
3976 /* See the comment below... */
3977 #if defined (GOBBLE_FIRST_EVENT)
3978 Lisp_Object first_event
;
3981 struct buffer
*starting_buffer
;
3983 /* Nonzero if we found the binding for one of the chars
3984 in this key sequence by downcasing it. */
3985 int case_converted
= 0;
3987 /* Nonzero if we seem to have got the beginning of a binding
3988 in function_key_map. */
3989 int function_key_possible
= 0;
3993 last_nonmenu_event
= Qnil
;
3995 delayed_switch_frame
= Qnil
;
3996 fkey_map
= Vfunction_key_map
;
3997 keytran_map
= Vkey_translation_map
;
3999 /* If there is no function-key-map, turn off function key scanning. */
4000 if (NILP (Fkeymapp (Vfunction_key_map
)))
4001 fkey_start
= fkey_end
= bufsize
+ 1;
4003 /* If there is no key-translation-map, turn off scanning. */
4004 if (NILP (Fkeymapp (Vkey_translation_map
)))
4005 keytran_start
= keytran_end
= bufsize
+ 1;
4010 echo_prompt (XSTRING (prompt
)->data
);
4011 else if (cursor_in_echo_area
)
4012 /* This doesn't put in a dash if the echo buffer is empty, so
4013 you don't always see a dash hanging out in the minibuffer. */
4017 /* Record the initial state of the echo area and this_command_keys;
4018 we will need to restore them if we replay a key sequence. */
4020 echo_start
= echo_length ();
4021 keys_start
= this_command_key_count
;
4023 #if defined (GOBBLE_FIRST_EVENT)
4024 /* This doesn't quite work, because some of the things that read_char
4025 does cannot safely be bypassed. It seems too risky to try to make
4028 /* Read the first char of the sequence specially, before setting
4029 up any keymaps, in case a filter runs and switches buffers on us. */
4030 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
4032 #endif /* GOBBLE_FIRST_EVENT */
4034 /* We jump here when the key sequence has been thoroughly changed, and
4035 we need to rescan it starting from the beginning. When we jump here,
4036 keybuf[0..mock_input] holds the sequence we should reread. */
4039 starting_buffer
= current_buffer
;
4041 function_key_possible
= 0;
4043 /* Build our list of keymaps.
4044 If we recognize a function key and replace its escape sequence in
4045 keybuf with its symbol, or if the sequence starts with a mouse
4046 click and we need to switch buffers, we jump back here to rebuild
4047 the initial keymaps from the current buffer. */
4051 nmaps
= current_minor_maps (0, &maps
) + 2;
4052 if (nmaps
> nmaps_allocated
)
4054 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4055 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4056 nmaps_allocated
= nmaps
;
4058 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
4059 #ifdef USE_TEXT_PROPERTIES
4060 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
4062 submaps
[nmaps
-2] = current_buffer
->keymap
;
4064 submaps
[nmaps
-1] = current_global_map
;
4067 /* Find an accurate initial value for first_binding. */
4068 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
4069 if (! NILP (submaps
[first_binding
]))
4072 /* Start from the beginning in keybuf. */
4075 /* These are no-ops the first time through, but if we restart, they
4076 revert the echo area and this_command_keys to their original state. */
4077 this_command_key_count
= keys_start
;
4079 echo_truncate (echo_start
);
4081 /* If the best binding for the current key sequence is a keymap, or
4082 we may be looking at a function key's escape sequence, keep on
4084 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
4085 || (first_binding
>= nmaps
4087 /* mock input is never part of a function key's sequence. */
4088 && mock_input
<= fkey_start
)
4089 || (first_binding
>= nmaps
4090 && keytran_start
< t
4091 /* mock input is never part of a function key's sequence. */
4092 && mock_input
<= keytran_start
)
4093 /* Don't return in the middle of a possible function key sequence,
4094 if the only bindings we found were via case conversion.
4095 Thus, if ESC O a has a function-key-map translation
4096 and ESC o has a binding, don't return after ESC O,
4097 so that we can translate ESC O plus the next character. */
4098 || (function_key_possible
&& case_converted
))
4101 int used_mouse_menu
= 0;
4103 /* Where the last real key started. If we need to throw away a
4104 key that has expanded into more than one element of keybuf
4105 (say, a mouse click on the mode line which is being treated
4106 as [mode-line (mouse-...)], then we backtrack to this point
4108 int last_real_key_start
;
4110 /* These variables are analogous to echo_start and keys_start;
4111 while those allow us to restart the entire key sequence,
4112 echo_local_start and keys_local_start allow us to throw away
4114 int echo_local_start
, keys_local_start
, local_first_binding
;
4117 error ("key sequence too long");
4120 echo_local_start
= echo_length ();
4121 keys_local_start
= this_command_key_count
;
4122 local_first_binding
= first_binding
;
4125 /* These are no-ops, unless we throw away a keystroke below and
4126 jumped back up to replay_key; in that case, these restore the
4127 variables to their original state, allowing us to replay the
4130 echo_truncate (echo_local_start
);
4131 this_command_key_count
= keys_local_start
;
4132 first_binding
= local_first_binding
;
4134 /* By default, assume each event is "real". */
4135 last_real_key_start
= t
;
4137 /* Does mock_input indicate that we are re-reading a key sequence? */
4141 add_command_key (key
);
4145 /* If not, we should actually read a character. */
4148 struct buffer
*buf
= current_buffer
;
4150 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
4153 /* read_char returns t when it shows a menu and the user rejects it.
4158 /* read_char returns -1 at the end of a macro.
4159 Emacs 18 handles this by returning immediately with a
4160 zero, so that's what we'll do. */
4161 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) == -1)
4167 /* If we have a quit that was typed in another frame, and
4168 quit_throw_to_read_char switched buffers,
4169 replay to get the right keymap. */
4170 if (EQ (key
, quit_char
) && current_buffer
!= starting_buffer
)
4175 goto replay_sequence
;
4181 /* Clicks in non-text areas get prefixed by the symbol
4182 in their CHAR-ADDRESS field. For example, a click on
4183 the mode line is prefixed by the symbol `mode-line'.
4185 Furthermore, key sequences beginning with mouse clicks
4186 are read using the keymaps of the buffer clicked on, not
4187 the current buffer. So we may have to switch the buffer
4190 When we turn one event into two events, we must make sure
4191 that neither of the two looks like the original--so that,
4192 if we replay the events, they won't be expanded again.
4193 If not for this, such reexpansion could happen either here
4194 or when user programs play with this-command-keys. */
4195 if (EVENT_HAS_PARAMETERS (key
))
4197 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
4199 if (EQ (kind
, Qmouse_click
))
4201 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
4202 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4204 if (XTYPE (posn
) == Lisp_Cons
)
4206 /* We're looking at the second event of a
4207 sequence which we expanded before. Set
4208 last_real_key_start appropriately. */
4210 last_real_key_start
= t
- 1;
4213 /* Key sequences beginning with mouse clicks are
4214 read using the keymaps in the buffer clicked on,
4215 not the current buffer. If we're at the
4216 beginning of a key sequence, switch buffers. */
4217 if (last_real_key_start
== 0
4218 && XTYPE (window
) == Lisp_Window
4219 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
4220 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
4225 /* Arrange to go back to the original buffer once we're
4226 done reading the key sequence. Note that we can't
4227 use save_excursion_{save,restore} here, because they
4228 save point as well as the current buffer; we don't
4229 want to save point, because redisplay may change it,
4230 to accommodate a Fset_window_start or something. We
4231 don't want to do this at the top of the function,
4232 because we may get input from a subprocess which
4233 wants to change the selected window and stuff (say,
4235 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
4237 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
4238 goto replay_sequence
;
4240 else if (XTYPE (posn
) == Lisp_Symbol
)
4242 /* Expand mode-line and scroll-bar events into two events:
4243 use posn as a fake prefix key. */
4245 if (t
+ 1 >= bufsize
)
4246 error ("key sequence too long");
4251 /* Zap the position in key, so we know that we've
4252 expanded it, and don't try to do so again. */
4253 POSN_BUFFER_POSN (EVENT_START (key
))
4254 = Fcons (posn
, Qnil
);
4258 else if (EQ (kind
, Qswitch_frame
))
4260 /* If we're at the beginning of a key sequence, go
4261 ahead and return this event. If we're in the
4262 midst of a key sequence, delay it until the end. */
4265 delayed_switch_frame
= key
;
4271 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4273 /* Handle menu-bar events:
4274 insert the dummy prefix event `menu-bar'. */
4275 if (EQ (posn
, Qmenu_bar
))
4277 if (t
+ 1 >= bufsize
)
4278 error ("key sequence too long");
4279 /* Run the Lucid hook. */
4280 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4281 /* If it has changed current-menubar from previous value,
4282 really recompute the menubar from the value. */
4283 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4284 call0 (Qrecompute_lucid_menubar
);
4288 /* Zap the position in key, so we know that we've
4289 expanded it, and don't try to do so again. */
4290 POSN_BUFFER_POSN (EVENT_START (key
))
4291 = Fcons (posn
, Qnil
);
4294 goto replay_sequence
;
4296 else if (XTYPE (posn
) == Lisp_Cons
)
4298 /* We're looking at the second event of a
4299 sequence which we expanded before. Set
4300 last_real_key_start appropriately. */
4301 if (last_real_key_start
== t
&& t
> 0)
4302 last_real_key_start
= t
- 1;
4307 /* We have finally decided that KEY is something we might want
4309 first_binding
= (follow_key (key
,
4310 nmaps
- first_binding
,
4311 submaps
+ first_binding
,
4312 defs
+ first_binding
,
4313 submaps
+ first_binding
,
4317 /* If KEY wasn't bound, we'll try some fallbacks. */
4318 if (first_binding
>= nmaps
)
4320 Lisp_Object head
= EVENT_HEAD (key
);
4322 if (EQ (head
, Vhelp_char
))
4324 read_key_sequence_cmd
= Vprefix_help_command
;
4326 last_nonmenu_event
= key
;
4330 if (XTYPE (head
) == Lisp_Symbol
)
4332 Lisp_Object breakdown
= parse_modifiers (head
);
4333 int modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4335 /* Attempt to reduce an unbound mouse event to a simpler
4336 event that is bound:
4337 Drags reduce to clicks.
4338 Double-clicks reduce to clicks.
4339 Triple-clicks reduce to double-clicks, then to clicks.
4340 Down-clicks are eliminated.
4341 Double-downs reduce to downs, then are eliminated.
4342 Triple-downs reduce to double-downs, then to downs,
4343 then are eliminated. */
4344 if (modifiers
& (down_modifier
| drag_modifier
4345 | double_modifier
| triple_modifier
))
4347 while (modifiers
& (down_modifier
| drag_modifier
4348 | double_modifier
| triple_modifier
))
4350 Lisp_Object new_head
, new_click
;
4351 if (modifiers
& triple_modifier
)
4352 modifiers
^= (double_modifier
| triple_modifier
);
4353 else if (modifiers
& (drag_modifier
| double_modifier
))
4354 modifiers
&= ~(drag_modifier
| double_modifier
);
4357 /* Dispose of this `down' event by simply jumping
4358 back to replay_key, to get another event.
4360 Note that if this event came from mock input,
4361 then just jumping back to replay_key will just
4362 hand it to us again. So we have to wipe out any
4365 We could delete keybuf[t] and shift everything
4366 after that to the left by one spot, but we'd also
4367 have to fix up any variable that points into
4368 keybuf, and shifting isn't really necessary
4371 Adding prefixes for non-textual mouse clicks
4372 creates two characters of mock input, and both
4373 must be thrown away. If we're only looking at
4374 the prefix now, we can just jump back to
4375 replay_key. On the other hand, if we've already
4376 processed the prefix, and now the actual click
4377 itself is giving us trouble, then we've lost the
4378 state of the keymaps we want to backtrack to, and
4379 we need to replay the whole sequence to rebuild
4382 Beyond that, only function key expansion could
4383 create more than two keys, but that should never
4384 generate mouse events, so it's okay to zero
4385 mock_input in that case too.
4387 Isn't this just the most wonderful code ever? */
4388 if (t
== last_real_key_start
)
4395 mock_input
= last_real_key_start
;
4396 goto replay_sequence
;
4401 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
4403 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
4405 /* Look for a binding for this new key. follow_key
4406 promises that it didn't munge submaps the
4407 last time we called it, since key was unbound. */
4409 = (follow_key (new_click
,
4410 nmaps
- local_first_binding
,
4411 submaps
+ local_first_binding
,
4412 defs
+ local_first_binding
,
4413 submaps
+ local_first_binding
,
4415 + local_first_binding
);
4417 /* If that click is bound, go for it. */
4418 if (first_binding
< nmaps
)
4423 /* Otherwise, we'll leave key set to the drag event. */
4430 /* Normally, last_nonmenu_event gets the previous key we read.
4431 But when a mouse popup menu is being used,
4432 we don't update last_nonmenu_event; it continues to hold the mouse
4433 event that preceded the first level of menu. */
4434 if (!used_mouse_menu
)
4435 last_nonmenu_event
= key
;
4437 /* If the sequence is unbound, see if we can hang a function key
4438 off the end of it. We only want to scan real keyboard input
4439 for function key sequences, so if mock_input says that we're
4440 re-reading old events, don't examine it. */
4441 if ((first_binding
>= nmaps
|| case_converted
)
4444 Lisp_Object fkey_next
;
4446 /* Continue scan from fkey_end until we find a bound suffix.
4447 If we fail, increment fkey_start
4448 and start fkey_end from there. */
4449 while (fkey_end
< t
)
4453 key
= keybuf
[fkey_end
++];
4454 /* Look up meta-characters by prefixing them
4455 with meta_prefix_char. I hate this. */
4456 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4461 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
4463 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4466 fkey_next
= fkey_map
;
4469 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
4471 /* If the function key map gives a function, not an
4472 array, then call the function with no args and use
4473 its value instead. */
4474 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
4477 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4481 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4482 fkey_next
= call1 (fkey_next
, prompt
);
4484 /* If the function returned something invalid,
4485 barf--don't ignore it.
4486 (To ignore it safely, we would need to gcpro a bunch of
4487 other variables.) */
4488 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
4489 error ("Function in function-key-map returns invalid key sequence");
4492 function_key_possible
= ! NILP (fkey_next
);
4494 /* If keybuf[fkey_start..fkey_end] is bound in the
4495 function key map and it's a suffix of the current
4496 sequence (i.e. fkey_end == t), replace it with
4497 the binding and restart with fkey_start at the end. */
4498 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
4501 int len
= XFASTINT (Flength (fkey_next
));
4503 t
= fkey_start
+ len
;
4505 error ("key sequence too long");
4507 if (VECTORP (fkey_next
))
4508 bcopy (XVECTOR (fkey_next
)->contents
,
4509 keybuf
+ fkey_start
,
4510 (t
- fkey_start
) * sizeof (keybuf
[0]));
4511 else if (STRINGP (fkey_next
))
4515 for (i
= 0; i
< len
; i
++)
4516 XFASTINT (keybuf
[fkey_start
+ i
])
4517 = XSTRING (fkey_next
)->data
[i
];
4521 fkey_start
= fkey_end
= t
;
4522 fkey_map
= Vfunction_key_map
;
4524 goto replay_sequence
;
4527 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
4529 /* If we no longer have a bound suffix, try a new positions for
4531 if (NILP (fkey_map
))
4533 fkey_end
= ++fkey_start
;
4534 fkey_map
= Vfunction_key_map
;
4535 function_key_possible
= 0;
4540 /* Look for this sequence in key-translation-map. */
4542 Lisp_Object keytran_next
;
4544 /* Scan from keytran_end until we find a bound suffix. */
4545 while (keytran_end
< t
)
4549 key
= keybuf
[keytran_end
++];
4550 /* Look up meta-characters by prefixing them
4551 with meta_prefix_char. I hate this. */
4552 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4557 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
4559 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4562 keytran_next
= keytran_map
;
4565 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
4567 /* If the key translation map gives a function, not an
4568 array, then call the function with no args and use
4569 its value instead. */
4570 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
4571 && keytran_end
== t
)
4573 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4577 GCPRO3 (keytran_map
, keytran_map
, delayed_switch_frame
);
4578 keytran_next
= call1 (keytran_next
, prompt
);
4580 /* If the function returned something invalid,
4581 barf--don't ignore it.
4582 (To ignore it safely, we would need to gcpro a bunch of
4583 other variables.) */
4584 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
4585 error ("Function in function-key-map returns invalid key sequence");
4588 /* If keybuf[keytran_start..keytran_end] is bound in the
4589 key translation map and it's a suffix of the current
4590 sequence (i.e. keytran_end == t), replace it with
4591 the binding and restart with keytran_start at the end. */
4592 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
4593 && keytran_end
== t
)
4595 int len
= XFASTINT (Flength (keytran_next
));
4597 t
= keytran_start
+ len
;
4599 error ("key sequence too long");
4601 if (VECTORP (keytran_next
))
4602 bcopy (XVECTOR (keytran_next
)->contents
,
4603 keybuf
+ keytran_start
,
4604 (t
- keytran_start
) * sizeof (keybuf
[0]));
4605 else if (STRINGP (keytran_next
))
4609 for (i
= 0; i
< len
; i
++)
4610 XFASTINT (keybuf
[keytran_start
+ i
])
4611 = XSTRING (keytran_next
)->data
[i
];
4615 keytran_start
= keytran_end
= t
;
4616 keytran_map
= Vkey_translation_map
;
4618 goto replay_sequence
;
4621 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
4623 /* If we no longer have a bound suffix, try a new positions for
4625 if (NILP (keytran_map
))
4627 keytran_end
= ++keytran_start
;
4628 keytran_map
= Vkey_translation_map
;
4634 read_key_sequence_cmd
= (first_binding
< nmaps
4635 ? defs
[first_binding
]
4639 unread_switch_frame
= delayed_switch_frame
;
4640 unbind_to (count
, Qnil
);
4642 /* Occasionally we fabricate events, perhaps by expanding something
4643 according to function-key-map, or by adding a prefix symbol to a
4644 mouse click in the scroll bar or modeline. In this cases, return
4645 the entire generated key sequence, even if we hit an unbound
4646 prefix or a definition before the end. This means that you will
4647 be able to push back the event properly, and also means that
4648 read-key-sequence will always return a logical unit.
4651 for (; t
< mock_input
; t
++)
4653 echo_char (keybuf
[t
]);
4654 add_command_key (keybuf
[t
]);
4660 #if 0 /* This doc string is too long for some compilers.
4661 This commented-out definition serves for DOC. */
4662 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4663 "Read a sequence of keystrokes and return as a string or vector.\n\
4664 The sequence is sufficient to specify a non-prefix command in the\n\
4665 current local and global maps.\n\
4667 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
4668 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
4669 as a continuation of the previous key.\n\
4671 A C-g typed while in this function is treated like any other character,\n\
4672 and `quit-flag' is not set.\n\
4674 If the key sequence starts with a mouse click, then the sequence is read\n\
4675 using the keymaps of the buffer of the window clicked in, not the buffer\n\
4676 of the selected window as normal.\n\
4678 `read-key-sequence' drops unbound button-down events, since you normally\n\
4679 only care about the click or drag events which follow them. If a drag\n\
4680 or multi-click event is unbound, but the corresponding click event would\n\
4681 be bound, `read-key-sequence' turns the event into a click event at the\n\
4682 drag's starting position. This means that you don't have to distinguish\n\
4683 between click and drag, double, or triple events unless you want to.\n\
4685 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
4686 lines separating windows, and scroll bars with imaginary keys\n\
4687 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
4689 If the user switches frames in the middle of a key sequence, the\n\
4690 frame-switch event is put off until after the current key sequence.\n\
4692 `read-key-sequence' checks `function-key-map' for function key\n\
4693 sequences, where they wouldn't conflict with ordinary bindings. See\n\
4694 `function-key-map' for more details.")
4695 (prompt
, continue_echo
)
4698 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4700 (prompt
, continue_echo
)
4701 Lisp_Object prompt
, continue_echo
;
4703 Lisp_Object keybuf
[30];
4705 struct gcpro gcpro1
, gcpro2
;
4708 CHECK_STRING (prompt
, 0);
4711 bzero (keybuf
, sizeof keybuf
);
4713 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
4715 if (NILP (continue_echo
))
4716 this_command_key_count
= 0;
4718 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])), prompt
);
4726 return make_event_array (i
, keybuf
);
4729 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
4730 "Execute CMD as an editor command.\n\
4731 CMD must be a symbol that satisfies the `commandp' predicate.\n\
4732 Optional second arg RECORD-FLAG non-nil\n\
4733 means unconditionally put this command in `command-history'.\n\
4734 Otherwise, that is done only if an arg is read using the minibuffer.")
4736 Lisp_Object cmd
, record
;
4738 register Lisp_Object final
;
4739 register Lisp_Object tem
;
4740 Lisp_Object prefixarg
;
4741 struct backtrace backtrace
;
4742 extern int debug_on_next_call
;
4744 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
4745 Vcurrent_prefix_arg
= prefixarg
;
4746 debug_on_next_call
= 0;
4748 if (XTYPE (cmd
) == Lisp_Symbol
)
4750 tem
= Fget (cmd
, Qdisabled
);
4752 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
4757 final
= Findirect_function (cmd
);
4759 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
4760 do_autoload (final
, cmd
);
4765 if (XTYPE (final
) == Lisp_String
4766 || XTYPE (final
) == Lisp_Vector
)
4768 /* If requested, place the macro in the command history. For
4769 other sorts of commands, call-interactively takes care of
4773 = Fcons (Fcons (Qexecute_kbd_macro
,
4774 Fcons (final
, Fcons (prefixarg
, Qnil
))),
4777 return Fexecute_kbd_macro (final
, prefixarg
);
4779 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
4780 || XTYPE (final
) == Lisp_Compiled
)
4782 backtrace
.next
= backtrace_list
;
4783 backtrace_list
= &backtrace
;
4784 backtrace
.function
= &Qcall_interactively
;
4785 backtrace
.args
= &cmd
;
4786 backtrace
.nargs
= 1;
4787 backtrace
.evalargs
= 0;
4789 tem
= Fcall_interactively (cmd
, record
);
4791 backtrace_list
= backtrace
.next
;
4797 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
4799 "Read function name, then read its arguments and call it.")
4801 Lisp_Object prefixarg
;
4803 Lisp_Object function
;
4805 Lisp_Object saved_keys
;
4806 struct gcpro gcpro1
;
4808 saved_keys
= Fthis_command_keys ();
4810 GCPRO1 (saved_keys
);
4812 if (EQ (prefixarg
, Qminus
))
4814 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
4815 strcpy (buf
, "C-u ");
4816 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
4817 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
4818 else if (XTYPE (prefixarg
) == Lisp_Int
)
4819 sprintf (buf
, "%d ", XINT (prefixarg
));
4821 /* This isn't strictly correct if execute-extended-command
4822 is bound to anything else. Perhaps it should use
4823 this_command_keys? */
4824 strcat (buf
, "M-x ");
4826 /* Prompt with buf, and then read a string, completing from and
4827 restricting to the set of all defined commands. Don't provide
4828 any initial input. Save the command read on the extended-command
4830 function
= Fcompleting_read (build_string (buf
),
4831 Vobarray
, Qcommandp
,
4832 Qt
, Qnil
, Qextended_command_history
);
4834 /* Set this_command_keys to the concatenation of saved_keys and
4835 function, followed by a RET. */
4837 struct Lisp_String
*str
;
4841 this_command_key_count
= 0;
4843 str
= XSTRING (saved_keys
);
4844 for (i
= 0; i
< str
->size
; i
++)
4846 XFASTINT (tem
) = str
->data
[i
];
4847 add_command_key (tem
);
4850 str
= XSTRING (function
);
4851 for (i
= 0; i
< str
->size
; i
++)
4853 XFASTINT (tem
) = str
->data
[i
];
4854 add_command_key (tem
);
4857 XFASTINT (tem
) = '\015';
4858 add_command_key (tem
);
4863 function
= Fintern (function
, Qnil
);
4864 Vprefix_arg
= prefixarg
;
4865 this_command
= function
;
4867 return Fcommand_execute (function
, Qt
);
4871 detect_input_pending ()
4874 get_input_pending (&input_pending
);
4876 return input_pending
;
4879 /* This is called in some cases before a possible quit.
4880 It cases the next call to detect_input_pending to recompute input_pending.
4881 So calling this function unnecessarily can't do any harm. */
4882 clear_input_pending ()
4887 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
4888 "T if command input is currently available with no waiting.\n\
4889 Actually, the value is nil only if we can be sure that no input is available.")
4892 if (!NILP (unread_command_events
) || unread_command_char
!= -1)
4895 return detect_input_pending () ? Qt
: Qnil
;
4898 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
4899 "Return vector of last 100 events, not counting those from keyboard macros.")
4902 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
4905 if (total_keys
< NUM_RECENT_KEYS
)
4906 return Fvector (total_keys
, keys
);
4909 val
= Fvector (NUM_RECENT_KEYS
, keys
);
4910 bcopy (keys
+ recent_keys_index
,
4911 XVECTOR (val
)->contents
,
4912 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
4914 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
4915 recent_keys_index
* sizeof (Lisp_Object
));
4920 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
4921 "Return the key sequence that invoked this command.\n\
4922 The value is a string or a vector.")
4925 return make_event_array (this_command_key_count
,
4926 XVECTOR (this_command_keys
)->contents
);
4929 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
4930 "Return the current depth in recursive edits.")
4934 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
4938 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
4939 "FOpen dribble file: ",
4940 "Start writing all keyboard characters to a dribble file called FILE.\n\
4941 If FILE is nil, close any open dribble file.")
4952 file
= Fexpand_file_name (file
, Qnil
);
4953 dribble
= fopen (XSTRING (file
)->data
, "w");
4958 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
4959 "Discard the contents of the terminal input buffer.\n\
4960 Also cancel any kbd macro being defined.")
4963 defining_kbd_macro
= 0;
4964 update_mode_lines
++;
4966 unread_command_events
= Qnil
;
4967 unread_command_char
= -1;
4969 discard_tty_input ();
4971 /* Without the cast, GCC complains that this assignment loses the
4972 volatile qualifier of kbd_store_ptr. Is there anything wrong
4974 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
4975 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
4981 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
4982 "Stop Emacs and return to superior process. You can resume later.\n\
4983 On systems that don't have job control, run a subshell instead.\n\n\
4984 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
4985 to be read as terminal input by Emacs's parent, after suspension.\n\
4987 Before suspending, call the functions in `suspend-hook' with no args.\n\
4988 If any of them returns nil, don't call the rest and don't suspend.\n\
4989 Otherwise, suspend normally and after resumption run the normal hook\n\
4990 `suspend-resume-hook' if that is bound and non-nil.\n\
4992 Some operating systems cannot stop the Emacs process and resume it later.\n\
4993 On such systems, Emacs starts a subshell instead of suspending.")
4995 Lisp_Object stuffstring
;
4998 int count
= specpdl_ptr
- specpdl
;
4999 int old_height
, old_width
;
5001 struct gcpro gcpro1
, gcpro2
;
5002 extern init_sys_modes ();
5004 if (!NILP (stuffstring
))
5005 CHECK_STRING (stuffstring
, 0);
5007 /* Run the functions in suspend-hook. */
5008 if (!NILP (Vrun_hooks
))
5009 call1 (Vrun_hooks
, intern ("suspend-hook"));
5011 GCPRO1 (stuffstring
);
5012 get_frame_size (&old_width
, &old_height
);
5014 /* sys_suspend can get an error if it tries to fork a subshell
5015 and the system resources aren't available for that. */
5016 record_unwind_protect (init_sys_modes
, 0);
5017 stuff_buffered_input (stuffstring
);
5019 unbind_to (count
, Qnil
);
5021 /* Check if terminal/window size has changed.
5022 Note that this is not useful when we are running directly
5023 with a window system; but suspend should be disabled in that case. */
5024 get_frame_size (&width
, &height
);
5025 if (width
!= old_width
|| height
!= old_height
)
5026 change_frame_size (selected_frame
, height
, width
, 0, 0);
5028 /* Run suspend-resume-hook. */
5029 if (!NILP (Vrun_hooks
))
5030 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
5036 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
5037 Then in any case stuff anything Emacs has read ahead and not used. */
5039 stuff_buffered_input (stuffstring
)
5040 Lisp_Object stuffstring
;
5042 register unsigned char *p
;
5044 /* stuff_char works only in BSD, versions 4.2 and up. */
5047 if (XTYPE (stuffstring
) == Lisp_String
)
5051 p
= XSTRING (stuffstring
)->data
;
5052 count
= XSTRING (stuffstring
)->size
;
5057 /* Anything we have read ahead, put back for the shell to read. */
5058 while (kbd_fetch_ptr
!= kbd_store_ptr
)
5060 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
5061 kbd_fetch_ptr
= kbd_buffer
;
5062 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
5063 stuff_char (kbd_fetch_ptr
->code
);
5064 kbd_fetch_ptr
->kind
= no_event
;
5065 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
5072 #endif /* BSD and not BSD4_1 */
5075 set_waiting_for_input (time_to_clear
)
5076 EMACS_TIME
*time_to_clear
;
5078 input_available_clear_time
= time_to_clear
;
5080 /* Tell interrupt_signal to throw back to read_char, */
5081 waiting_for_input
= 1;
5083 /* If interrupt_signal was called before and buffered a C-g,
5084 make it run again now, to avoid timing error. */
5085 if (!NILP (Vquit_flag
))
5086 quit_throw_to_read_char ();
5089 clear_waiting_for_input ()
5091 /* Tell interrupt_signal not to throw back to read_char, */
5092 waiting_for_input
= 0;
5093 input_available_clear_time
= 0;
5096 /* This routine is called at interrupt level in response to C-G.
5097 If interrupt_input, this is the handler for SIGINT.
5098 Otherwise, it is called from kbd_buffer_store_event,
5099 in handling SIGIO or SIGTINT.
5101 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
5102 immediately throw back to read_char.
5104 Otherwise it sets the Lisp variable quit-flag not-nil.
5105 This causes eval to throw, when it gets a chance.
5106 If quit-flag is already non-nil, it stops the job right away. */
5112 /* Must preserve main program's value of errno. */
5113 int old_errno
= errno
;
5116 /* USG systems forget handlers when they are used;
5117 must reestablish each time */
5118 signal (SIGINT
, interrupt_signal
);
5119 signal (SIGQUIT
, interrupt_signal
);
5124 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
5129 #ifdef SIGTSTP /* Support possible in later USG versions */
5131 * On systems which can suspend the current process and return to the original
5132 * shell, this command causes the user to end up back at the shell.
5133 * The "Auto-save" and "Abort" questions are not asked until
5134 * the user elects to return to emacs, at which point he can save the current
5135 * job and either dump core or continue.
5140 if (sys_suspend () == -1)
5142 printf ("Not running as a subprocess;\n");
5143 printf ("you can continue or abort.\n");
5146 /* Perhaps should really fork an inferior shell?
5147 But that would not provide any way to get back
5148 to the original shell, ever. */
5149 printf ("No support for stopping a process on this operating system;\n");
5150 printf ("you can continue or abort.\n");
5151 #endif /* not VMS */
5152 #endif /* not SIGTSTP */
5154 /* We must remain inside the screen area when the internal terminal
5155 is used. Note that [Enter] is not echoed by dos. */
5158 printf ("Auto-save? (y or n) ");
5160 if (((c
= getchar ()) & ~040) == 'Y')
5162 Fdo_auto_save (Qt
, Qnil
);
5164 printf ("\r\nAuto-save done");
5165 #else /* not MSDOS */
5166 printf ("Auto-save done\n");
5167 #endif /* not MSDOS */
5169 while (c
!= '\n') c
= getchar ();
5171 printf ("\r\nAbort? (y or n) ");
5172 #else /* not MSDOS */
5174 printf ("Abort (and enter debugger)? (y or n) ");
5176 printf ("Abort (and dump core)? (y or n) ");
5177 #endif /* not VMS */
5178 #endif /* not MSDOS */
5180 if (((c
= getchar ()) & ~040) == 'Y')
5182 while (c
!= '\n') c
= getchar ();
5184 printf ("\r\nContinuing...\r\n");
5185 #else /* not MSDOS */
5186 printf ("Continuing...\n");
5187 #endif /* not MSDOS */
5193 /* If executing a function that wants to be interrupted out of
5194 and the user has not deferred quitting by binding `inhibit-quit'
5195 then quit right away. */
5196 if (immediate_quit
&& NILP (Vinhibit_quit
))
5200 Fsignal (Qquit
, Qnil
);
5203 /* Else request quit when it's safe */
5207 if (waiting_for_input
&& !echoing
)
5208 quit_throw_to_read_char ();
5213 /* Handle a C-g by making read_char return C-g. */
5215 quit_throw_to_read_char ()
5217 quit_error_check ();
5219 /* Prevent another signal from doing this before we finish. */
5220 clear_waiting_for_input ();
5223 unread_command_events
= Qnil
;
5224 unread_command_char
= -1;
5226 #ifdef POLL_FOR_INPUT
5227 /* May be > 1 if in recursive minibuffer. */
5228 if (poll_suppress_count
== 0)
5232 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
5233 && XFRAME (internal_last_event_frame
) != selected_frame
)
5234 Fhandle_switch_frame (make_lispy_switch_frame (internal_last_event_frame
));
5237 _longjmp (getcjmp
, 1);
5240 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
5241 "Set mode of reading keyboard input.\n\
5242 First arg INTERRUPT non-nil means use input interrupts;\n\
5243 nil means use CBREAK mode.\n\
5244 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
5245 (no effect except in CBREAK mode).\n\
5246 Third arg META t means accept 8-bit input (for a Meta key).\n\
5247 META nil means ignore the top bit, on the assumption it is parity.\n\
5248 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
5249 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
5250 See also `current-input-mode'.")
5251 (interrupt
, flow
, meta
, quit
)
5252 Lisp_Object interrupt
, flow
, meta
, quit
;
5255 && (XTYPE (quit
) != Lisp_Int
5256 || XINT (quit
) < 0 || XINT (quit
) > 0400))
5257 error ("set-input-mode: QUIT must be an ASCII character");
5259 #ifdef POLL_FOR_INPUT
5265 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5266 #ifdef NO_SOCK_SIGIO
5267 if (read_socket_hook
)
5268 interrupt_input
= 0; /* No interrupts if reading from a socket. */
5270 #endif /* NO_SOCK_SIGIO */
5271 interrupt_input
= !NILP (interrupt
);
5272 #else /* not SIGIO */
5273 interrupt_input
= 0;
5274 #endif /* not SIGIO */
5275 /* Our VMS input only works by interrupts, as of now. */
5277 interrupt_input
= 1;
5279 flow_control
= !NILP (flow
);
5282 else if (EQ (meta
, Qt
))
5287 /* Don't let this value be out of range. */
5288 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
5292 #ifdef POLL_FOR_INPUT
5293 poll_suppress_count
= 1;
5299 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
5300 "Return information about the way Emacs currently reads keyboard input.\n\
5301 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
5302 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
5303 nil, Emacs is using CBREAK mode.\n\
5304 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
5305 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
5306 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
5307 META nil means ignoring the top bit, on the assumption it is parity.\n\
5308 META is neither t nor nil if accepting 8-bit input and using\n\
5309 all 8 bits as the character code.\n\
5310 QUIT is the character Emacs currently uses to quit.\n\
5311 The elements of this list correspond to the arguments of\n\
5317 val
[0] = interrupt_input
? Qt
: Qnil
;
5318 val
[1] = flow_control
? Qt
: Qnil
;
5319 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
5320 XFASTINT (val
[3]) = quit_char
;
5322 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
5328 /* This is correct before outermost invocation of the editor loop */
5329 command_loop_level
= -1;
5331 quit_char
= Ctl ('g');
5332 unread_command_events
= Qnil
;
5333 unread_command_char
= -1;
5335 recent_keys_index
= 0;
5336 kbd_fetch_ptr
= kbd_buffer
;
5337 kbd_store_ptr
= kbd_buffer
;
5338 do_mouse_tracking
= 0;
5342 /* This means that command_loop_1 won't try to select anything the first
5344 internal_last_event_frame
= Qnil
;
5345 Vlast_event_frame
= internal_last_event_frame
;
5348 /* If we're running a dumped Emacs, we need to clear out
5349 kbd_buffer_frame_or_window, in case some events got into it
5352 If we're running an undumped Emacs, it hasn't been initialized by
5353 syms_of_keyboard yet. */
5355 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5357 if (!noninteractive
)
5359 signal (SIGINT
, interrupt_signal
);
5360 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
5361 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
5362 SIGQUIT and we can't tell which one it will give us. */
5363 signal (SIGQUIT
, interrupt_signal
);
5364 #endif /* HAVE_TERMIO */
5365 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5367 signal (SIGIO
, input_available_signal
);
5371 /* Use interrupt input by default, if it works and noninterrupt input
5372 has deficiencies. */
5374 #ifdef INTERRUPT_INPUT
5375 interrupt_input
= 1;
5377 interrupt_input
= 0;
5380 /* Our VMS input only works by interrupts, as of now. */
5382 interrupt_input
= 1;
5388 if (keyboard_init_hook
)
5389 (*keyboard_init_hook
) ();
5391 #ifdef POLL_FOR_INPUT
5392 poll_suppress_count
= 1;
5397 /* This type's only use is in syms_of_keyboard, to initialize the
5398 event header symbols and put properties on them. */
5405 struct event_head head_table
[] = {
5406 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
5407 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
5408 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
5413 Qdisabled_command_hook
= intern ("disabled-command-hook");
5414 staticpro (&Qdisabled_command_hook
);
5416 Qself_insert_command
= intern ("self-insert-command");
5417 staticpro (&Qself_insert_command
);
5419 Qforward_char
= intern ("forward-char");
5420 staticpro (&Qforward_char
);
5422 Qbackward_char
= intern ("backward-char");
5423 staticpro (&Qbackward_char
);
5425 Qdisabled
= intern ("disabled");
5426 staticpro (&Qdisabled
);
5428 Qundefined
= intern ("undefined");
5429 staticpro (&Qundefined
);
5431 Qpre_command_hook
= intern ("pre-command-hook");
5432 staticpro (&Qpre_command_hook
);
5434 Qpost_command_hook
= intern ("post-command-hook");
5435 staticpro (&Qpost_command_hook
);
5437 Qfunction_key
= intern ("function-key");
5438 staticpro (&Qfunction_key
);
5439 Qmouse_click
= intern ("mouse-click");
5440 staticpro (&Qmouse_click
);
5442 Qmenu_enable
= intern ("menu-enable");
5443 staticpro (&Qmenu_enable
);
5445 Qmode_line
= intern ("mode-line");
5446 staticpro (&Qmode_line
);
5447 Qvertical_line
= intern ("vertical-line");
5448 staticpro (&Qvertical_line
);
5449 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
5450 staticpro (&Qvertical_scroll_bar
);
5451 Qmenu_bar
= intern ("menu-bar");
5452 staticpro (&Qmenu_bar
);
5454 Qabove_handle
= intern ("above-handle");
5455 staticpro (&Qabove_handle
);
5456 Qhandle
= intern ("handle");
5457 staticpro (&Qhandle
);
5458 Qbelow_handle
= intern ("below-handle");
5459 staticpro (&Qbelow_handle
);
5461 Qevent_kind
= intern ("event-kind");
5462 staticpro (&Qevent_kind
);
5463 Qevent_symbol_elements
= intern ("event-symbol-elements");
5464 staticpro (&Qevent_symbol_elements
);
5465 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
5466 staticpro (&Qevent_symbol_element_mask
);
5467 Qmodifier_cache
= intern ("modifier-cache");
5468 staticpro (&Qmodifier_cache
);
5470 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
5471 staticpro (&Qrecompute_lucid_menubar
);
5472 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
5473 staticpro (&Qactivate_menubar_hook
);
5476 struct event_head
*p
;
5478 for (p
= head_table
;
5479 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
5482 *p
->var
= intern (p
->name
);
5484 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
5485 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
5489 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
5490 staticpro (&button_down_location
);
5494 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
5496 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
5497 for (i
= 0; i
< len
; i
++)
5498 if (modifier_names
[i
])
5499 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
5500 staticpro (&modifier_symbols
);
5503 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
5504 staticpro (&recent_keys
);
5506 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
5507 staticpro (&this_command_keys
);
5509 Qextended_command_history
= intern ("extended-command-history");
5510 Fset (Qextended_command_history
, Qnil
);
5511 staticpro (&Qextended_command_history
);
5513 kbd_buffer_frame_or_window
5514 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
5515 staticpro (&kbd_buffer_frame_or_window
);
5517 func_key_syms
= Qnil
;
5518 staticpro (&func_key_syms
);
5521 staticpro (&mouse_syms
);
5523 unread_switch_frame
= Qnil
;
5524 staticpro (&unread_switch_frame
);
5526 defsubr (&Sread_key_sequence
);
5527 defsubr (&Srecursive_edit
);
5528 defsubr (&Strack_mouse
);
5529 defsubr (&Sinput_pending_p
);
5530 defsubr (&Scommand_execute
);
5531 defsubr (&Srecent_keys
);
5532 defsubr (&Sthis_command_keys
);
5533 defsubr (&Ssuspend_emacs
);
5534 defsubr (&Sabort_recursive_edit
);
5535 defsubr (&Sexit_recursive_edit
);
5536 defsubr (&Srecursion_depth
);
5537 defsubr (&Stop_level
);
5538 defsubr (&Sdiscard_input
);
5539 defsubr (&Sopen_dribble_file
);
5540 defsubr (&Sset_input_mode
);
5541 defsubr (&Scurrent_input_mode
);
5542 defsubr (&Sexecute_extended_command
);
5544 DEFVAR_LISP ("last-command-char", &last_command_char
,
5545 "Last input event that was part of a command.");
5547 DEFVAR_LISP ("last-command-event", &last_command_char
,
5548 "Last input event that was part of a command.");
5550 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
5551 "Last input event in a command, except for mouse menu events.\n\
5552 Mouse menus give back keys that don't look like mouse events;\n\
5553 this variable holds the actual mouse event that led to the menu,\n\
5554 so that you can determine whether the command was run by mouse or not.");
5556 DEFVAR_LISP ("last-input-char", &last_input_char
,
5557 "Last input event.");
5559 DEFVAR_LISP ("last-input-event", &last_input_char
,
5560 "Last input event.");
5562 DEFVAR_LISP ("unread-command-events", &unread_command_events
,
5563 "List of objects to be read as next command input events.");
5565 DEFVAR_INT ("unread-command-char", &unread_command_char
,
5566 "If not -1, an object to be read as next command input event.");
5568 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
5569 "Meta-prefix character code. Meta-foo as command input\n\
5570 turns into this character followed by foo.");
5571 XSET (meta_prefix_char
, Lisp_Int
, 033);
5573 DEFVAR_LISP ("last-command", &last_command
,
5574 "The last command executed. Normally a symbol with a function definition,\n\
5575 but can be whatever was found in the keymap, or whatever the variable\n\
5576 `this-command' was set to by that command.");
5577 last_command
= Qnil
;
5579 DEFVAR_LISP ("this-command", &this_command
,
5580 "The command now being executed.\n\
5581 The command can set this variable; whatever is put here\n\
5582 will be in `last-command' during the following command.");
5583 this_command
= Qnil
;
5585 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
5586 "*Number of keyboard input characters between auto-saves.\n\
5587 Zero means disable autosaving due to number of characters typed.");
5588 auto_save_interval
= 300;
5590 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
5591 "*Number of seconds idle time before auto-save.\n\
5592 Zero or nil means disable auto-saving due to idleness.\n\
5593 After auto-saving due to this many seconds of idle time,\n\
5594 Emacs also does a garbage collection if that seems to be warranted.");
5595 XFASTINT (Vauto_save_timeout
) = 30;
5597 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
5598 "*Nonzero means echo unfinished commands after this many seconds of pause.");
5599 echo_keystrokes
= 1;
5601 DEFVAR_INT ("polling-period", &polling_period
,
5602 "*Interval between polling for input during Lisp execution.\n\
5603 The reason for polling is to make C-g work to stop a running program.\n\
5604 Polling is needed only when using X windows and SIGIO does not work.\n\
5605 Polling is automatically disabled in all other cases.");
5608 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
5609 "*Maximum time between mouse clicks to make a double-click.\n\
5610 Measured in milliseconds. nil means disable double-click recognition;\n\
5611 t means double-clicks have no time limit and are detected\n\
5612 by position only.");
5613 Vdouble_click_time
= make_number (500);
5615 DEFVAR_INT ("num-input-keys", &num_input_keys
,
5616 "*Number of complete keys read from the keyboard so far.");
5620 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
5621 "*The frame in which the most recently read event occurred.\n\
5622 If the last event came from a keyboard macro, this is set to `macro'.");
5623 Vlast_event_frame
= Qnil
;
5626 DEFVAR_LISP ("help-char", &Vhelp_char
,
5627 "Character to recognize as meaning Help.\n\
5628 When it is read, do `(eval help-form)', and display result if it's a string.\n\
5629 If the value of `help-form' is nil, this char can be read normally.");
5630 XSET (Vhelp_char
, Lisp_Int
, Ctl ('H'));
5632 DEFVAR_LISP ("help-form", &Vhelp_form
,
5633 "Form to execute when character `help-char' is read.\n\
5634 If the form returns a string, that string is displayed.\n\
5635 If `help-form' is nil, the help char is not recognized.");
5638 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
5639 "Command to run when `help-char' character follows a prefix key.\n\
5640 This command is used only when there is no actual binding\n\
5641 for that character after that prefix key.");
5642 Vprefix_help_command
= Qnil
;
5644 DEFVAR_LISP ("top-level", &Vtop_level
,
5645 "Form to evaluate when Emacs starts up.\n\
5646 Useful to set before you dump a modified Emacs.");
5649 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
5650 "String used as translate table for keyboard input, or nil.\n\
5651 Each character is looked up in this string and the contents used instead.\n\
5652 If string is of length N, character codes N and up are untranslated.");
5653 Vkeyboard_translate_table
= Qnil
;
5655 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
5656 "Keymap of key translations that can override keymaps.\n\
5657 This keymap works like `function-key-map', but comes after that,\n\
5658 and applies even for keys that have ordinary bindings.");
5659 Vkey_translation_map
= Qnil
;
5661 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
5662 "Non-nil means prompt with menus when appropriate.\n\
5663 This is done when reading from a keymap that has a prompt string,\n\
5664 for elements that have prompt strings.\n\
5665 The menu is displayed on the screen\n\
5666 if X menus were enabled at configuration\n\
5667 time and the previous event was a mouse click prefix key.\n\
5668 Otherwise, menu prompting uses the echo area.");
5671 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
5672 "Character to see next line of menu prompt.\n\
5673 Type this character while in a menu prompt to rotate around the lines of it.");
5674 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
5676 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
5677 "A mask of additional modifier keys to use with every keyboard character.\n\
5678 Emacs applies the modifiers of the character stored here to each keyboard\n\
5679 character it reads. For example, after evaluating the expression\n\
5680 (setq extra-keyboard-modifiers ?\C-x)\n\
5681 all input characters will have the control modifier applied to them.\n\
5683 Note that the character ?\C-@, equivalent to the integer zero, does\n\
5684 not count as a control character; rather, it counts as a character\n\
5685 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
5686 cancels any modification.");
5687 extra_keyboard_modifiers
= 0;
5689 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
5690 "If an editing command sets this to t, deactivate the mark afterward.\n\
5691 The command loop sets this to nil before each command,\n\
5692 and tests the value when the command returns.\n\
5693 Buffer modification stores t in this variable.");
5694 Vdeactivate_mark
= Qnil
;
5696 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
5697 "Normal hook run before each command is executed.");
5698 Vpre_command_hook
= Qnil
;
5700 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
5701 "Normal hook run after each command is executed.");
5702 Vpost_command_hook
= Qnil
;
5704 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
5705 "t means menu bar, specified Lucid style, needs to be recomputed.");
5706 Vlucid_menu_bar_dirty_flag
= Qnil
;
5708 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
5709 "List of menu bar items to move to the end of the menu bar.\n\
5710 The elements of the list are event types that may have menu bar bindings.");
5711 Vmenu_bar_final_items
= Qnil
;
5713 DEFVAR_BOOL ("track-mouse", &do_mouse_tracking
,
5714 "*Non-nil means generate motion events for mouse motion.");
5716 DEFVAR_LISP ("vendor-key-alist", &Vvendor_key_alist
,
5717 "Alist of vendor-specific X windows key symbols.\n\
5718 Each element should have the form (N . SYMBOL) where N is the\n\
5719 numeric keysym code (sans the \"vendor-specific\" bit 1<<28)\n\
5720 and SYMBOL is its name.");
5721 Vmenu_bar_final_items
= Qnil
;
5726 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
5727 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
5728 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
5729 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
5730 initial_define_key (meta_map
, 'x', "execute-extended-command");