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_x_menu_prompt ();
454 static Lisp_Object
read_char_minibuf_menu_prompt ();
455 static Lisp_Object
make_lispy_event ();
456 static Lisp_Object
make_lispy_movement ();
457 static Lisp_Object
modify_event_symbol ();
458 static Lisp_Object
make_lispy_switch_frame ();
460 /* > 0 if we are to echo keystrokes. */
461 static int echo_keystrokes
;
463 /* Nonzero means echo each character as typed. */
464 static int immediate_echo
;
466 /* The text we're echoing in the modeline - partial key sequences,
467 usually. '\0'-terminated. This really shouldn't have a fixed size. */
468 static char echobuf
[300];
470 /* Where to append more text to echobuf if we want to. */
471 static char *echoptr
;
473 #define min(a,b) ((a)<(b)?(a):(b))
474 #define max(a,b) ((a)>(b)?(a):(b))
476 /* Install the string STR as the beginning of the string of echoing,
477 so that it serves as a prompt for the next character.
478 Also start echoing. */
483 int len
= strlen (str
);
484 if (len
> sizeof echobuf
- 4)
485 len
= sizeof echobuf
- 4;
486 bcopy (str
, echobuf
, len
);
487 echoptr
= echobuf
+ len
;
493 /* Add C to the echo string, if echoing is going on.
494 C can be a character, which is printed prettily ("M-C-x" and all that
495 jazz), or a symbol, whose name is printed. */
500 extern char *push_key_description ();
509 /* If someone has passed us a composite event, use its head symbol. */
512 if (XTYPE (c
) == Lisp_Int
)
514 if (ptr
- echobuf
> sizeof echobuf
- 6)
517 ptr
= push_key_description (XINT (c
), ptr
);
519 else if (XTYPE (c
) == Lisp_Symbol
)
521 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
522 if (((ptr
- echobuf
) + name
->size
+ 4) > sizeof echobuf
)
524 bcopy (name
->data
, ptr
, name
->size
);
528 if (echoptr
== echobuf
&& EQ (c
, Vhelp_char
))
530 strcpy (ptr
, " (Type ? for further options)");
541 /* Temporarily add a dash to the end of the echo string if it's not
542 empty, so that it serves as a mini-prompt for the very next character. */
546 if (!immediate_echo
&& echoptr
== echobuf
)
548 /* Do nothing if not echoing at all. */
552 /* Put a dash at the end of the buffer temporarily,
553 but make it go away when the next character is added. */
560 /* Display the current echo string, and begin echoing if not already
570 for (i
= 0; i
< this_command_key_count
; i
++)
571 echo_char (XVECTOR (this_command_keys
)->contents
[i
]);
579 if (waiting_for_input
&& !NILP (Vquit_flag
))
580 quit_throw_to_read_char ();
583 /* Turn off echoing, for the start of a new command. */
591 /* Return the length of the current echo string. */
596 return echoptr
- echobuf
;
599 /* Truncate the current echo message to its first LEN chars.
600 This and echo_char get used by read_key_sequence when the user
601 switches frames while entering a key sequence. */
608 echoptr
= echobuf
+ len
;
612 /* Functions for manipulating this_command_keys. */
614 add_command_key (key
)
617 int size
= XVECTOR (this_command_keys
)->size
;
619 if (this_command_key_count
>= size
)
621 Lisp_Object new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
623 bcopy (XVECTOR (this_command_keys
)->contents
,
624 XVECTOR (new_keys
)->contents
,
625 size
* sizeof (Lisp_Object
));
627 this_command_keys
= new_keys
;
630 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
636 int count
= specpdl_ptr
- specpdl
;
639 if (command_loop_level
> 0)
641 specbind (Qstandard_output
, Qt
);
642 specbind (Qstandard_input
, Qt
);
645 val
= command_loop ();
647 Fsignal (Qquit
, Qnil
);
649 return unbind_to (count
, Qnil
);
652 /* When an auto-save happens, record the "time", and don't do again soon. */
655 last_auto_save
= num_nonmacro_input_chars
;
658 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
659 "Invoke the editor command loop recursively.\n\
660 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
661 that tells this function to return.\n\
662 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
663 This function is called by the editor initialization to begin editing.")
666 int count
= specpdl_ptr
- specpdl
;
669 command_loop_level
++;
670 update_mode_lines
= 1;
672 record_unwind_protect (recursive_edit_unwind
,
674 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
678 return unbind_to (count
, Qnil
);
682 recursive_edit_unwind (buffer
)
686 Fset_buffer (buffer
);
688 command_loop_level
--;
689 update_mode_lines
= 1;
697 Lisp_Object errmsg
, tail
, errname
, file_error
;
704 Vstandard_output
= Qt
;
705 Vstandard_input
= Qt
;
706 Vexecuting_macro
= Qnil
;
707 echo_area_glyphs
= 0;
709 /* If the window system or terminal frame hasn't been initialized
710 yet, or we're not interactive, it's best to dump this message out
711 to stderr and exit. */
712 if (! FRAME_MESSAGE_BUF (selected_frame
)
714 stream
= Qexternal_debugging_output
;
722 errname
= Fcar (data
);
724 if (EQ (errname
, Qerror
))
727 if (!CONSP (data
)) data
= Qnil
;
728 errmsg
= Fcar (data
);
733 errmsg
= Fget (errname
, Qerror_message
);
734 file_error
= Fmemq (Qfile_error
,
735 Fget (errname
, Qerror_conditions
));
738 /* Print an error message including the data items.
739 This is done by printing it into a scratch buffer
740 and then making a copy of the text in the buffer. */
742 if (!CONSP (data
)) data
= Qnil
;
746 /* For file-error, make error message by concatenating
747 all the data items. They are all strings. */
748 if (!NILP (file_error
) && !NILP (tail
))
749 errmsg
= XCONS (tail
)->car
, tail
= XCONS (tail
)->cdr
;
751 if (XTYPE (errmsg
) == Lisp_String
)
752 Fprinc (errmsg
, stream
);
754 write_string_1 ("peculiar error", -1, stream
);
756 for (i
= 0; CONSP (tail
); tail
= Fcdr (tail
), i
++)
758 write_string_1 (i
? ", " : ": ", 2, stream
);
759 if (!NILP (file_error
))
760 Fprinc (Fcar (tail
), stream
);
762 Fprin1 (Fcar (tail
), stream
);
766 /* If the window system or terminal frame hasn't been initialized
767 yet, or we're in -batch mode, this error should cause Emacs to exit. */
768 if (! FRAME_MESSAGE_BUF (selected_frame
)
772 Fkill_emacs (make_number (-1));
777 Vinhibit_quit
= Qnil
;
778 return make_number (0);
781 Lisp_Object
command_loop_1 ();
782 Lisp_Object
command_loop_2 ();
783 Lisp_Object
top_level_1 ();
785 /* Entry to editor-command-loop.
786 This level has the catches for exiting/returning to editor command loop.
787 It returns nil to exit recursive edit, t to abort it. */
792 if (command_loop_level
> 0 || minibuf_level
> 0)
794 return internal_catch (Qexit
, command_loop_2
, Qnil
);
799 internal_catch (Qtop_level
, top_level_1
, Qnil
);
800 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
802 /* End of file in -batch run causes exit here. */
808 /* Here we catch errors in execution of commands within the
809 editing loop, and reenter the editing loop.
810 When there is an error, cmd_error runs and returns a non-nil
811 value to us. A value of nil means that cmd_loop_1 itself
812 returned due to end of file (or end of kbd macro). */
817 register Lisp_Object val
;
820 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
829 return Feval (Vtop_level
);
835 /* On entry to the outer level, run the startup file */
836 if (!NILP (Vtop_level
))
837 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
838 else if (!NILP (Vpurify_flag
))
839 message ("Bare impure Emacs (standard Lisp code not loaded)");
841 message ("Bare Emacs (standard Lisp code not loaded)");
845 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
846 "Exit all recursive editing levels.")
849 Fthrow (Qtop_level
, Qnil
);
852 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
853 "Exit from the innermost recursive edit or minibuffer.")
856 if (command_loop_level
> 0 || minibuf_level
> 0)
857 Fthrow (Qexit
, Qnil
);
859 error ("No recursive edit is in progress");
862 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
863 "Abort the command that requested this recursive edit or minibuffer input.")
866 if (command_loop_level
> 0 || minibuf_level
> 0)
869 error ("No recursive edit is in progress");
872 /* This is the actual command reading loop,
873 sans error-handling encapsulation. */
875 Lisp_Object
Fcommand_execute ();
876 static int read_key_sequence ();
881 Lisp_Object cmd
, tem
;
884 Lisp_Object keybuf
[30];
889 struct buffer
*prev_buffer
;
892 Vdeactivate_mark
= Qnil
;
893 waiting_for_input
= 0;
896 /* Don't clear out last_command at the beginning of a macro. */
897 if (XTYPE (Vexecuting_macro
) != Lisp_String
)
902 this_command_key_count
= 0;
904 /* Make sure this hook runs after commands that get errors and
905 throw to top level. */
906 if (!NILP (Vpost_command_hook
))
907 call1 (Vrun_hooks
, Qpost_command_hook
);
911 /* Install chars successfully executed in kbd macro. */
913 if (defining_kbd_macro
&& NILP (Vprefix_arg
))
914 finalize_kbd_macro_chars ();
916 /* Make sure the current window's buffer is selected. */
917 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
918 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
920 /* Display any malloc warning that just came out. Use while because
921 displaying one warning can cause another. */
923 while (pending_malloc_warning
)
924 display_malloc_warning ();
928 Vdeactivate_mark
= Qnil
;
930 /* If minibuffer on and echo area in use,
931 wait 2 sec and redraw minibuffer. */
933 if (minibuf_level
&& echo_area_glyphs
)
935 /* Bind inhibit-quit to t so that C-g gets read in
936 rather than quitting back to the minibuffer. */
937 int count
= specpdl_ptr
- specpdl
;
938 specbind (Qinhibit_quit
, Qt
);
939 Fsit_for (make_number (2), Qnil
, Qnil
);
940 unbind_to (count
, Qnil
);
942 echo_area_glyphs
= 0;
944 if (!NILP (Vquit_flag
))
947 unread_command_events
= Fcons (make_number (quit_char
), Qnil
);
952 alloca (0); /* Cause a garbage collection now */
953 /* Since we can free the most stuff here. */
954 #endif /* C_ALLOCA */
958 /* Select the frame that the last event came from. Usually,
959 switch-frame events will take care of this, but if some lisp
960 code swallows a switch-frame event, we'll fix things up here.
961 Is this a good idea? */
962 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
963 && XFRAME (internal_last_event_frame
) != selected_frame
)
964 Fselect_frame (internal_last_event_frame
, Qnil
);
967 /* If it has changed current-menubar from previous value,
968 really recompute the menubar from the value. */
969 if (! NILP (Vlucid_menu_bar_dirty_flag
)
970 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
971 call0 (Qrecompute_lucid_menubar
);
973 #if 0 /* This is done in xdisp.c now. */
975 for (tem
= Vframe_list
; CONSP (tem
); tem
= XCONS (tem
)->cdr
)
977 struct frame
*f
= XFRAME (XCONS (tem
)->car
);
978 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
980 /* If the user has switched buffers or windows, we need to
981 recompute to reflect the new bindings. But we'll
982 recompute when update_mode_lines is set too; that means
983 that people can use force-mode-line-update to request
984 that the menu bar be recomputed. The adverse effect on
985 the rest of the redisplay algorithm is about the same as
986 windows_or_buffers_changed anyway. */
987 if (windows_or_buffers_changed
989 || (XFASTINT (w
->last_modified
) < MODIFF
990 && (XFASTINT (w
->last_modified
)
991 <= XBUFFER (w
->buffer
)->save_modified
)))
993 struct buffer
*prev
= current_buffer
;
994 current_buffer
= XBUFFER (w
->buffer
);
995 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items ();
996 current_buffer
= prev
;
999 #endif /* MULTI_FRAME */
1002 /* Read next key sequence; i gets its length. */
1003 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), Qnil
);
1007 /* Now we have read a key sequence of length I,
1008 or else I is 0 and we found end of file. */
1010 if (i
== 0) /* End of file -- happens only in */
1011 return Qnil
; /* a kbd macro, at the end. */
1012 /* -1 means read_key_sequence got a menu that was rejected.
1013 Just loop around and read another command. */
1017 this_command_key_count
= 0;
1021 last_command_char
= keybuf
[i
- 1];
1023 /* If the previous command tried to force a specific window-start,
1024 forget about that, in case this command moves point far away
1025 from that position. */
1026 XWINDOW (selected_window
)->force_start
= Qnil
;
1028 cmd
= read_key_sequence_cmd
;
1029 if (!NILP (Vexecuting_macro
))
1031 if (!NILP (Vquit_flag
))
1033 Vexecuting_macro
= Qt
;
1034 QUIT
; /* Make some noise. */
1035 /* Will return since macro now empty. */
1039 /* Do redisplay processing after this command except in special
1040 cases identified below that set no_redisplay to 1. */
1043 prev_buffer
= current_buffer
;
1044 prev_modiff
= MODIFF
;
1046 /* Execute the command. */
1049 if (!NILP (Vpre_command_hook
))
1050 call1 (Vrun_hooks
, Qpre_command_hook
);
1052 if (NILP (this_command
))
1054 /* nil means key is undefined. */
1056 defining_kbd_macro
= 0;
1057 update_mode_lines
= 1;
1063 if (NILP (Vprefix_arg
) && ! no_direct
)
1065 /* Recognize some common commands in common situations and
1066 do them directly. */
1067 if (EQ (this_command
, Qforward_char
) && point
< ZV
)
1069 struct Lisp_Vector
*dp
1070 = window_display_table (XWINDOW (selected_window
));
1071 lose
= FETCH_CHAR (point
);
1074 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1075 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1076 : (lose
>= 0x20 && lose
< 0x7f))
1077 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1079 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1081 && !windows_or_buffers_changed
1082 && EQ (current_buffer
->selective_display
, Qnil
)
1083 && !detect_input_pending ()
1084 && NILP (Vexecuting_macro
))
1085 no_redisplay
= direct_output_forward_char (1);
1088 else if (EQ (this_command
, Qbackward_char
) && point
> BEGV
)
1090 struct Lisp_Vector
*dp
1091 = window_display_table (XWINDOW (selected_window
));
1093 lose
= FETCH_CHAR (point
);
1095 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1096 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1097 : (lose
>= 0x20 && lose
< 0x7f))
1098 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1100 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1102 && !windows_or_buffers_changed
1103 && EQ (current_buffer
->selective_display
, Qnil
)
1104 && !detect_input_pending ()
1105 && NILP (Vexecuting_macro
))
1106 no_redisplay
= direct_output_forward_char (-1);
1109 else if (EQ (this_command
, Qself_insert_command
)
1110 /* Try this optimization only on ascii keystrokes. */
1111 && XTYPE (last_command_char
) == Lisp_Int
)
1113 unsigned char c
= XINT (last_command_char
);
1115 if (NILP (Vexecuting_macro
) &&
1116 !EQ (minibuf_window
, selected_window
))
1118 if (!nonundocount
|| nonundocount
>= 20)
1125 lose
= (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1127 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1129 || MODIFF
<= current_buffer
->save_modified
1130 || windows_or_buffers_changed
1131 || !EQ (current_buffer
->selective_display
, Qnil
)
1132 || detect_input_pending ()
1133 || !NILP (Vexecuting_macro
);
1134 if (internal_self_insert (c
, 0))
1140 (point
== ZV
|| FETCH_CHAR (point
) == '\n'))
1142 struct Lisp_Vector
*dp
1143 = window_display_table (XWINDOW (selected_window
));
1148 Lisp_Object obj
= DISP_CHAR_VECTOR (dp
, lose
);
1150 if (XTYPE (obj
) == Lisp_Vector
1151 && XVECTOR (obj
)->size
== 1
1152 && (XTYPE (obj
= XVECTOR (obj
)->contents
[0])
1155 direct_output_for_insert (XINT (obj
));
1159 if (lose
>= 0x20 && lose
<= 0x7e)
1160 no_redisplay
= direct_output_for_insert (lose
);
1167 /* Here for a command that isn't executed directly */
1170 if (NILP (Vprefix_arg
))
1172 Fcommand_execute (this_command
, Qnil
);
1177 if (!NILP (Vpost_command_hook
))
1178 call1 (Vrun_hooks
, Qpost_command_hook
);
1180 /* If there is a prefix argument,
1181 1) We don't want last_command to be ``universal-argument''
1182 (that would be dumb), so don't set last_command,
1183 2) we want to leave echoing on so that the prefix will be
1184 echoed as part of this key sequence, so don't call
1186 3) we want to leave this_command_key_count non-zero, so that
1187 read_char will realize that it is re-reading a character, and
1188 not echo it a second time. */
1189 if (NILP (Vprefix_arg
))
1191 last_command
= this_command
;
1193 this_command_key_count
= 0;
1196 if (!NILP (current_buffer
->mark_active
))
1198 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1200 current_buffer
->mark_active
= Qnil
;
1201 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1203 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1204 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1209 /* Number of seconds between polling for input. */
1212 /* Nonzero means polling for input is temporarily suppressed. */
1213 int poll_suppress_count
;
1215 #ifdef POLL_FOR_INPUT
1216 int polling_for_input
;
1218 /* Handle an alarm once each second and read pending input
1219 so as to handle a C-g if it comces in. */
1222 input_poll_signal ()
1224 if (interrupt_input_blocked
== 0
1225 && !waiting_for_input
)
1226 read_avail_input (0);
1227 signal (SIGALRM
, input_poll_signal
);
1228 alarm (polling_period
);
1233 /* Begin signals to poll for input, if they are appropriate.
1234 This function is called unconditionally from various places. */
1238 #ifdef POLL_FOR_INPUT
1239 if (read_socket_hook
&& !interrupt_input
)
1241 poll_suppress_count
--;
1242 if (poll_suppress_count
== 0)
1244 signal (SIGALRM
, input_poll_signal
);
1245 polling_for_input
= 1;
1246 alarm (polling_period
);
1252 /* Turn off polling. */
1256 #ifdef POLL_FOR_INPUT
1257 if (read_socket_hook
&& !interrupt_input
)
1259 if (poll_suppress_count
== 0)
1261 polling_for_input
= 0;
1264 poll_suppress_count
++;
1269 /* Set the value of poll_suppress_count to COUNT
1270 and start or stop polling accordingly. */
1273 set_poll_suppress_count (count
)
1276 #ifdef POLL_FOR_INPUT
1277 if (count
== 0 && poll_suppress_count
!= 0)
1279 poll_suppress_count
= 1;
1282 else if (count
!= 0 && poll_suppress_count
== 0)
1286 poll_suppress_count
= count
;
1290 /* Applying the control modifier to CHARACTER. */
1295 /* Save the upper bits here. */
1296 int upper
= c
& ~0177;
1300 /* Everything in the columns containing the upper-case letters
1301 denotes a control character. */
1302 if (c
>= 0100 && c
< 0140)
1306 /* Set the shift modifier for a control char
1307 made from a shifted letter. But only for letters! */
1308 if (oc
>= 'A' && oc
<= 'Z')
1309 c
|= shift_modifier
;
1312 /* The lower-case letters denote control characters too. */
1313 else if (c
>= 'a' && c
<= 'z')
1316 /* Include the bits for control and shift
1317 only if the basic ASCII code can't indicate them. */
1321 /* Replace the high bits. */
1322 c
|= (upper
& ~ctrl_modifier
);
1329 /* Input of single characters from keyboard */
1331 Lisp_Object
print_help ();
1332 static Lisp_Object
kbd_buffer_get_event ();
1334 /* read a character from the keyboard; call the redisplay if needed */
1335 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1336 -1 means do not do redisplay, but do do autosaving.
1339 /* The arguments MAPS and NMAPS are for menu prompting.
1340 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1342 PREV_EVENT is the previous input event, or nil if we are reading
1343 the first event of a key sequence.
1345 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1346 if we used a mouse menu to read the input, or zero otherwise. If
1347 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
1349 Value is t if we showed a menu and the user rejected it. */
1352 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1356 Lisp_Object prev_event
;
1357 int *used_mouse_menu
;
1359 register Lisp_Object c
;
1363 if (CONSP (unread_command_events
))
1365 c
= XCONS (unread_command_events
)->car
;
1366 unread_command_events
= XCONS (unread_command_events
)->cdr
;
1368 if (this_command_key_count
== 0)
1374 if (unread_command_char
!= -1)
1376 XSET (c
, Lisp_Int
, unread_command_char
);
1377 unread_command_char
= -1;
1379 if (this_command_key_count
== 0)
1385 if (!NILP (Vexecuting_macro
))
1388 /* We set this to Qmacro; since that's not a frame, nobody will
1389 try to switch frames on us, and the selected window will
1392 Since this event came from a macro, it would be misleading to
1393 leave internal_last_event_frame set to wherever the last
1394 real event came from. Normally, a switch-frame event selects
1395 internal_last_event_frame after each command is read, but
1396 events read from a macro should never cause a new frame to be
1398 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1401 /* Exit the macro if we are at the end.
1402 Also, some things replace the macro with t
1403 to force an early exit. */
1404 if (EQ (Vexecuting_macro
, Qt
)
1405 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1407 XSET (c
, Lisp_Int
, -1);
1411 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1412 if (XTYPE (Vexecuting_macro
) == Lisp_String
1413 && (XINT (c
) & 0x80))
1414 XFASTINT (c
) = CHAR_META
| (XINT (c
) & ~0x80);
1416 executing_macro_index
++;
1421 if (!NILP (unread_switch_frame
))
1423 c
= unread_switch_frame
;
1424 unread_switch_frame
= Qnil
;
1426 /* This event should make it into this_command_keys, and get echoed
1427 again, so we go to reread_first, rather than reread. */
1431 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1432 prepare_menu_bars ();
1434 /* Save outer setjmp data, in case called recursively. */
1435 save_getcjmp (save_jump
);
1439 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1442 if (_setjmp (getcjmp
))
1444 XSET (c
, Lisp_Int
, quit_char
);
1446 XSET (internal_last_event_frame
, Lisp_Frame
, selected_frame
);
1447 Vlast_event_frame
= internal_last_event_frame
;
1449 /* If we report the quit char as an event,
1450 don't do so more than once. */
1451 if (!NILP (Vinhibit_quit
))
1457 /* Message turns off echoing unless more keystrokes turn it on again. */
1458 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1461 /* If already echoing, continue. */
1464 /* Try reading a character via menu prompting in the minibuf.
1465 Try this before the sit-for, because the sit-for
1466 would do the wrong thing if we are supposed to do
1467 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1468 after a mouse event so don't try a minibuf menu. */
1470 if (nmaps
> 0 && INTERACTIVE
&&
1471 !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
))
1473 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1474 if ( ! NILP(c
) ) return c
;
1477 /* If in middle of key sequence and minibuffer not active,
1478 start echoing if enough time elapses. */
1479 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1481 && echo_keystrokes
> 0
1482 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1486 /* After a mouse event, start echoing right away.
1487 This is because we are probably about to display a menu,
1488 and we don't want to delay before doing so. */
1489 if (EVENT_HAS_PARAMETERS (prev_event
))
1493 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1499 /* Maybe auto save due to number of keystrokes or idle time. */
1501 if (commandflag
!= 0
1502 && auto_save_interval
> 0
1503 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1504 && !detect_input_pending ())
1507 save_getcjmp (temp
);
1508 Fdo_auto_save (Qnil
, Qnil
);
1509 restore_getcjmp (temp
);
1512 /* Try reading using an X menu.
1513 This is never confused with reading using the minibuf because the recursive
1514 call of read_char in read_char_minibuf_menu_prompt does not pass on
1516 if (nmaps
> 0 && INTERACTIVE
&&
1517 !NILP (prev_event
) && EVENT_HAS_PARAMETERS (prev_event
))
1518 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1520 /* Slow down auto saves logarithmically in size of current buffer,
1521 and garbage collect while we're at it. */
1522 if (INTERACTIVE
&& NILP (c
))
1524 int delay_level
, buffer_size
;
1526 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1527 last_non_minibuf_size
= Z
- BEG
;
1528 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1530 while (buffer_size
> 64)
1531 delay_level
++, buffer_size
-= buffer_size
>> 2;
1532 if (delay_level
< 4) delay_level
= 4;
1533 /* delay_level is 4 for files under around 50k, 7 at 100k,
1534 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1536 /* Auto save if enough time goes by without input. */
1537 if (commandflag
!= 0
1538 && num_nonmacro_input_chars
> last_auto_save
1539 && XTYPE (Vauto_save_timeout
) == Lisp_Int
1540 && XINT (Vauto_save_timeout
) > 0)
1543 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1544 tem0
= sit_for (delay
, 0, 1, 1);
1548 save_getcjmp (temp
);
1549 Fdo_auto_save (Qnil
, Qnil
);
1550 restore_getcjmp (temp
);
1552 /* If we have auto-saved and there is still no input
1553 available, garbage collect if there has been enough
1554 consing going on to make it worthwhile. */
1555 if (!detect_input_pending ()
1556 && consing_since_gc
> gc_cons_threshold
/ 2)
1558 Fgarbage_collect ();
1559 /* prepare_menu_bars isn't safe here, but it should
1560 also be unnecessary. */
1567 /* Actually read a character, waiting if necessary. */
1570 c
= kbd_buffer_get_event ();
1573 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1577 /* Terminate Emacs in batch mode if at eof. */
1578 if (noninteractive
&& XTYPE (c
) == Lisp_Int
&& XINT (c
) < 0)
1579 Fkill_emacs (make_number (1));
1581 if (XTYPE (c
) == Lisp_Int
)
1583 /* Add in any extra modifiers, where appropriate. */
1584 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1585 || ((extra_keyboard_modifiers
& 0177) < ' '
1586 && (extra_keyboard_modifiers
& 0177) != 0))
1587 XSETINT (c
, make_ctrl_char (XINT (c
)));
1589 /* Transfer any other modifier bits directly from
1590 extra_keyboard_modifiers to c. Ignore the actual character code
1591 in the low 16 bits of extra_keyboard_modifiers. */
1592 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
1597 restore_getcjmp (save_jump
);
1601 echo_area_glyphs
= 0;
1603 /* Handle things that only apply to characters. */
1604 if (XTYPE (c
) == Lisp_Int
)
1606 /* If kbd_buffer_get_event gave us an EOF, return that. */
1610 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
1611 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1612 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1616 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1617 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1618 recent_keys_index
= 0;
1620 /* Write c to the dribble file. If c is a lispy event, write
1621 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1622 If you, dear reader, have a better idea, you've got the source. :-) */
1625 if (XTYPE (c
) == Lisp_Int
)
1626 putc (XINT (c
), dribble
);
1629 Lisp_Object dribblee
= c
;
1631 /* If it's a structured event, take the event header. */
1632 dribblee
= EVENT_HEAD (dribblee
);
1634 if (XTYPE (dribblee
) == Lisp_Symbol
)
1636 putc ('<', dribble
);
1637 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1638 XSYMBOL (dribblee
)->name
->size
,
1640 putc ('>', dribble
);
1647 store_kbd_macro_char (c
);
1649 num_nonmacro_input_chars
++;
1654 /* Record this character as part of the current key.
1655 Don't record mouse motion; it should never matter. */
1656 if (! (EVENT_HAS_PARAMETERS (c
)
1657 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1660 add_command_key (c
);
1663 /* Re-reading in the middle of a command */
1665 last_input_char
= c
;
1668 /* Process the help character specially if enabled */
1669 if (EQ (c
, Vhelp_char
) && !NILP (Vhelp_form
))
1672 count
= specpdl_ptr
- specpdl
;
1674 record_unwind_protect (Fset_window_configuration
,
1675 Fcurrent_window_configuration (Qnil
));
1677 tem0
= Feval (Vhelp_form
);
1678 if (XTYPE (tem0
) == Lisp_String
)
1679 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1682 c
= read_char (0, 0, 0, Qnil
, 0);
1683 /* Remove the help from the frame */
1684 unbind_to (count
, Qnil
);
1685 prepare_menu_bars ();
1687 if (EQ (c
, make_number (040)))
1690 c
= read_char (0, 0, 0, Qnil
, 0);
1701 Fprinc (object
, Qnil
);
1705 /* Copy out or in the info on where C-g should throw to.
1706 This is used when running Lisp code from within get_char,
1707 in case get_char is called recursively.
1708 See read_process_output. */
1713 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1716 restore_getcjmp (temp
)
1719 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1723 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1724 of this function. */
1726 tracking_off (old_value
)
1727 Lisp_Object old_value
;
1729 if (! XFASTINT (old_value
))
1731 do_mouse_tracking
= 0;
1733 /* Redisplay may have been preempted because there was input
1734 available, and it assumes it will be called again after the
1735 input has been processed. If the only input available was
1736 the sort that we have just disabled, then we need to call
1738 if (!readable_events ())
1740 prepare_menu_bars ();
1741 redisplay_preserve_echo_area ();
1742 get_input_pending (&input_pending
);
1747 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1748 "Evaluate BODY with mouse movement events enabled.\n\
1749 Within a `track-mouse' form, mouse motion generates input events that\n\
1750 you can read with `read-event'.\n\
1751 Normally, mouse motion is ignored.")
1755 int count
= specpdl_ptr
- specpdl
;
1758 XSET (val
, Lisp_Int
, do_mouse_tracking
);
1759 record_unwind_protect (tracking_off
, val
);
1761 do_mouse_tracking
= 1;
1763 val
= Fprogn (args
);
1764 return unbind_to (count
, val
);
1767 /* Low level keyboard/mouse input.
1768 kbd_buffer_store_event places events in kbd_buffer, and
1769 kbd_buffer_get_event retrieves them.
1770 mouse_moved indicates when the mouse has moved again, and
1771 *mouse_position_hook provides the mouse position. */
1773 /* Return true iff there are any events in the queue that read-char
1774 would return. If this returns false, a read-char would block. */
1778 return ! EVENT_QUEUES_EMPTY
;
1781 /* Set this for debugging, to have a way to get out */
1784 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
1787 kbd_buffer_store_event (event
)
1788 register struct input_event
*event
;
1790 if (event
->kind
== no_event
)
1793 if (event
->kind
== ascii_keystroke
)
1795 register int c
= event
->code
& 0377;
1797 if (event
->modifiers
& ctrl_modifier
)
1798 c
= make_ctrl_char (c
);
1800 c
|= (event
->modifiers
1801 & (meta_modifier
| alt_modifier
1802 | hyper_modifier
| super_modifier
));
1806 extern SIGTYPE
interrupt_signal ();
1809 /* If this results in a quit_char being returned to Emacs as
1810 input, set Vlast_event_frame properly. If this doesn't
1811 get returned to Emacs as an event, the next event read
1812 will set Vlast_event_frame again, so this is safe to do. */
1815 = FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
1818 internal_last_event_frame
= event
->frame_or_window
;
1820 internal_last_event_frame
= focus
;
1821 Vlast_event_frame
= internal_last_event_frame
;
1825 last_event_timestamp
= event
->timestamp
;
1826 interrupt_signal ();
1830 if (c
&& c
== stop_character
)
1837 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
1838 kbd_store_ptr
= kbd_buffer
;
1840 /* Don't let the very last slot in the buffer become full,
1841 since that would make the two pointers equal,
1842 and that is indistinguishable from an empty buffer.
1843 Discard the event if it would fill the last slot. */
1844 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
1846 kbd_store_ptr
->kind
= event
->kind
;
1847 if (event
->kind
== selection_request_event
)
1849 /* We must not use the ordinary copying code for this case,
1850 since `part' is an enum and copying it might not copy enough
1852 bcopy (event
, kbd_store_ptr
, sizeof (*event
));
1856 kbd_store_ptr
->code
= event
->code
;
1857 kbd_store_ptr
->part
= event
->part
;
1858 kbd_store_ptr
->frame_or_window
= event
->frame_or_window
;
1859 kbd_store_ptr
->modifiers
= event
->modifiers
;
1860 kbd_store_ptr
->x
= event
->x
;
1861 kbd_store_ptr
->y
= event
->y
;
1862 kbd_store_ptr
->timestamp
= event
->timestamp
;
1864 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
1866 = event
->frame_or_window
);
1872 /* Read one event from the event buffer, waiting if necessary.
1873 The value is a Lisp object representing the event.
1874 The value is nil for an event that should be ignored,
1875 or that was handled here.
1876 We always read and discard one event. */
1879 kbd_buffer_get_event ()
1887 XSET (obj
, Lisp_Int
, c
);
1891 /* Wait until there is input available. */
1894 if (!EVENT_QUEUES_EMPTY
)
1897 /* If the quit flag is set, then read_char will return
1898 quit_char, so that counts as "available input." */
1899 if (!NILP (Vquit_flag
))
1900 quit_throw_to_read_char ();
1902 /* One way or another, wait until input is available; then, if
1903 interrupt handlers have not read it, read it now. */
1906 wait_for_kbd_input ();
1908 /* Note SIGIO has been undef'd if FIONREAD is missing. */
1912 if (EVENT_QUEUES_EMPTY
)
1914 Lisp_Object minus_one
;
1916 XSET (minus_one
, Lisp_Int
, -1);
1917 wait_reading_process_input (0, 0, minus_one
, 1);
1919 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
1921 read_avail_input (0);
1924 #endif /* not VMS */
1927 /* At this point, we know that there is a readable event available
1928 somewhere. If the event queue is empty, then there must be a
1929 mouse movement enabled and available. */
1930 if (kbd_fetch_ptr
!= kbd_store_ptr
)
1932 struct input_event
*event
;
1934 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
1938 last_event_timestamp
= event
->timestamp
;
1942 /* These two kinds of events get special handling
1943 and don't actually appear to the command loop.
1944 We return nil for them. */
1945 if (event
->kind
== selection_request_event
)
1948 x_handle_selection_request (event
);
1949 kbd_fetch_ptr
= event
+ 1;
1951 /* We're getting selection request events, but we don't have
1957 else if (event
->kind
== selection_clear_event
)
1960 x_handle_selection_clear (event
);
1961 kbd_fetch_ptr
= event
+ 1;
1963 /* We're getting selection request events, but we don't have
1969 else if (event
->kind
== delete_window_event
)
1971 Lisp_Object tail
, frame
;
1974 /* If the user destroys the only frame, Emacs should exit.
1975 Count visible frames and iconified frames. */
1976 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
1978 frame
= XCONS (tail
)->car
;
1979 if (XTYPE (frame
) != Lisp_Frame
|| EQ (frame
, event
->frame_or_window
))
1982 if (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
))
1989 Fdelete_frame (event
->frame_or_window
, Qt
);
1990 kbd_fetch_ptr
= event
+ 1;
1993 /* Just discard these, by returning nil.
1994 (They shouldn't be found in the buffer,
1995 but on some machines it appears they do show up.) */
1996 else if (event
->kind
== no_event
)
1997 kbd_fetch_ptr
= event
+ 1;
1999 /* If this event is on a different frame, return a switch-frame this
2000 time, and leave the event in the queue for next time. */
2004 Lisp_Object frame
= event
->frame_or_window
;
2007 if (XTYPE (frame
) == Lisp_Window
)
2008 frame
= WINDOW_FRAME (XWINDOW (frame
));
2010 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2014 if (! EQ (frame
, internal_last_event_frame
)
2015 && XFRAME (frame
) != selected_frame
)
2016 obj
= make_lispy_switch_frame (frame
);
2017 internal_last_event_frame
= frame
;
2018 #endif /* MULTI_FRAME */
2020 /* If we didn't decide to make a switch-frame event, go ahead
2021 and build a real event from the queue entry. */
2025 obj
= make_lispy_event (event
);
2027 /* Wipe out this event, to catch bugs. */
2028 event
->kind
= no_event
;
2029 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
2032 kbd_fetch_ptr
= event
+ 1;
2036 /* Try generating a mouse motion event. */
2037 else if (do_mouse_tracking
&& mouse_moved
)
2040 Lisp_Object bar_window
;
2041 enum scroll_bar_part part
;
2045 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
2050 /* Decide if we should generate a switch-frame event. Don't
2051 generate switch-frame events for motion outside of all Emacs
2055 Lisp_Object frame
= FRAME_FOCUS_FRAME (f
);
2058 XSET (frame
, Lisp_Frame
, f
);
2060 if (! EQ (frame
, internal_last_event_frame
)
2061 && XFRAME (frame
) != selected_frame
)
2062 obj
= make_lispy_switch_frame (frame
);
2063 internal_last_event_frame
= frame
;
2067 /* If we didn't decide to make a switch-frame event, go ahead and
2068 return a mouse-motion event. */
2070 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2073 /* We were promised by the above while loop that there was
2074 something for us to read! */
2077 input_pending
= readable_events ();
2080 Vlast_event_frame
= internal_last_event_frame
;
2086 /* Process any events that are not user-visible,
2087 then return, without reading any user-visible events. */
2092 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2094 struct input_event
*event
;
2096 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2100 last_event_timestamp
= event
->timestamp
;
2102 /* These two kinds of events get special handling
2103 and don't actually appear to the command loop. */
2104 if (event
->kind
== selection_request_event
)
2107 x_handle_selection_request (event
);
2108 kbd_fetch_ptr
= event
+ 1;
2110 /* We're getting selection request events, but we don't have
2116 else if (event
->kind
== selection_clear_event
)
2119 x_handle_selection_clear (event
);
2120 kbd_fetch_ptr
= event
+ 1;
2122 /* We're getting selection request events, but we don't have
2131 get_input_pending (&input_pending
);
2134 /* Caches for modify_event_symbol. */
2135 static Lisp_Object accent_key_syms
;
2136 static Lisp_Object vendor_key_syms
;
2137 static Lisp_Object func_key_syms
;
2138 static Lisp_Object mouse_syms
;
2140 Lisp_Object Vvendor_key_alist
;
2142 /* This is a list of keysym codes for special "accent" characters.
2143 It parallels lispy_accent_keys. */
2145 static int lispy_accent_codes
[] =
2147 #ifdef XK_dead_circumflex
2152 #ifdef XK_dead_grave
2157 #ifdef XK_dead_tilde
2162 #ifdef XK_dead_diaeresis
2167 #ifdef XK_dead_macron
2172 #ifdef XK_dead_degree
2177 #ifdef XK_dead_acute
2182 #ifdef XK_dead_cedilla
2187 #ifdef XK_dead_breve
2192 #ifdef XK_dead_ogonek
2197 #ifdef XK_dead_caron
2202 #ifdef XK_dead_doubleacute
2203 XK_dead_doubleacute
,
2207 #ifdef XK_dead_abovedot
2214 /* This is a list of Lisp names for special "accent" characters.
2215 It parallels lispy_accent_codes. */
2217 static char *lispy_accent_keys
[] =
2234 /* You'll notice that this table is arranged to be conveniently
2235 indexed by X Windows keysym values. */
2236 static char *lispy_function_keys
[] =
2238 /* X Keysym value */
2240 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2248 0, 0, 0, /* 0xff10 */
2250 0, 0, 0, 0, 0, 0, 0,
2253 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2254 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2255 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2257 "home", /* 0xff50 */ /* IsCursorKey */
2268 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2279 "break", /* 0xff6b */
2281 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2283 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2284 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2285 0, 0, 0, 0, 0, 0, 0, 0,
2286 "kp-tab", /* 0xff89 */
2288 "kp-enter", /* 0xff8d */
2290 "kp-f1", /* 0xff91 */
2295 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2296 "kp-multiply", /* 0xffaa */
2301 "kp-divide", /* 0xffaf */
2302 "kp-0", /* 0xffb0 */
2303 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2306 "kp-equal", /* 0xffbd */
2307 "f1", /* 0xffbe */ /* IsFunctionKey */
2309 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2310 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2311 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2312 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2313 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2314 0, 0, 0, 0, 0, 0, 0, 0,
2315 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2316 0, 0, 0, 0, 0, 0, 0, "delete"
2319 static char *lispy_mouse_names
[] =
2321 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2324 /* Scroll bar parts. */
2325 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2327 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2328 Lisp_Object
*scroll_bar_parts
[] = {
2329 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2333 /* A vector, indexed by button number, giving the down-going location
2334 of currently depressed buttons, both scroll bar and non-scroll bar.
2336 The elements have the form
2337 (BUTTON-NUMBER MODIFIER-MASK . REST)
2338 where REST is the cdr of a position as it would be reported in the event.
2340 The make_lispy_event function stores positions here to tell the
2341 difference between click and drag events, and to store the starting
2342 location to be included in drag events. */
2344 static Lisp_Object button_down_location
;
2346 /* Information about the most recent up-going button event: Which
2347 button, what location, and what time. */
2349 static int last_mouse_button
;
2350 static int last_mouse_x
;
2351 static int last_mouse_y
;
2352 static unsigned long button_down_time
;
2354 /* The maximum time between clicks to make a double-click,
2355 or Qnil to disable double-click detection,
2356 or Qt for no time limit. */
2357 Lisp_Object Vdouble_click_time
;
2359 /* The number of clicks in this multiple-click. */
2361 int double_click_count
;
2363 /* Given a struct input_event, build the lisp event which represents
2364 it. If EVENT is 0, build a mouse movement event from the mouse
2365 movement buffer, which should have a movement event in it.
2367 Note that events must be passed to this function in the order they
2368 are received; this function stores the location of button presses
2369 in order to build drag events when the button is released. */
2372 make_lispy_event (event
)
2373 struct input_event
*event
;
2377 #ifdef SWITCH_ENUM_BUG
2378 switch ((int) event
->kind
)
2380 switch (event
->kind
)
2383 /* A simple keystroke. */
2384 case ascii_keystroke
:
2386 int c
= event
->code
& 0377;
2387 /* Turn ASCII characters into control characters
2389 if (event
->modifiers
& ctrl_modifier
)
2390 c
= make_ctrl_char (c
);
2392 /* Add in the other modifier bits. We took care of ctrl_modifier
2393 just above, and the shift key was taken care of by the X code,
2394 and applied to control characters by make_ctrl_char. */
2395 c
|= (event
->modifiers
2396 & (meta_modifier
| alt_modifier
2397 | hyper_modifier
| super_modifier
));
2398 button_down_time
= 0;
2402 /* A function key. The symbol may need to have modifier prefixes
2404 case non_ascii_keystroke
:
2405 button_down_time
= 0;
2407 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
2408 if (event
->code
== lispy_accent_codes
[i
])
2409 return modify_event_symbol (i
,
2411 Qfunction_key
, Qnil
,
2412 lispy_accent_keys
, &accent_key_syms
,
2413 (sizeof (lispy_accent_keys
)
2414 / sizeof (lispy_accent_keys
[0])));
2416 /* Handle vendor-specific keysyms. */
2417 if (event
->code
& (1 << 28))
2419 /* We need to use an alist rather than a vector as the cache
2420 since we can't make a vector long enuf. */
2421 if (NILP (vendor_key_syms
))
2422 vendor_key_syms
= Fcons (Qnil
, Qnil
);
2423 return modify_event_symbol (event
->code
& 0xffffff,
2425 Qfunction_key
, Vvendor_key_alist
,
2426 0, &vendor_key_syms
, 0xffffff);
2429 return modify_event_symbol (event
->code
- 0xff00,
2431 Qfunction_key
, Qnil
,
2432 lispy_function_keys
, &func_key_syms
,
2433 (sizeof (lispy_function_keys
)
2434 / sizeof (lispy_function_keys
[0])));
2437 /* A mouse click. Figure out where it is, decide whether it's
2438 a press, click or drag, and build the appropriate structure. */
2440 case scroll_bar_click
:
2442 int button
= event
->code
;
2444 Lisp_Object position
;
2445 Lisp_Object
*start_pos_ptr
;
2446 Lisp_Object start_pos
;
2448 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2451 /* Build the position as appropriate for this mouse click. */
2452 if (event
->kind
== mouse_click
)
2455 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2457 = window_from_coordinates (f
, XINT (event
->x
), XINT (event
->y
),
2461 if (XINT (event
->y
) < FRAME_MENU_BAR_LINES (f
))
2465 items
= FRAME_MENU_BAR_ITEMS (f
);
2466 for (; CONSP (items
); items
= XCONS (items
)->cdr
)
2468 Lisp_Object pos
, string
;
2469 pos
= Fcdr (Fcdr (Fcar (items
)));
2470 string
= Fcar (Fcdr (Fcar (items
)));
2471 if (XINT (event
->x
) >= XINT (pos
)
2472 && XINT (event
->x
) < XINT (pos
) + XSTRING (string
)->size
)
2476 = Fcons (event
->frame_or_window
,
2478 Fcons (Fcons (event
->x
, event
->y
),
2479 Fcons (make_number (event
->timestamp
),
2483 return Fcons (Fcar (Fcar (items
)),
2484 Fcons (position
, Qnil
));
2486 return Fcons (Qnil
, Fcons (position
, Qnil
));
2488 else if (XTYPE (window
) != Lisp_Window
)
2493 (XINT (event
->x
) - XINT (XWINDOW (window
)->left
)));
2495 (XINT (event
->y
) - XINT (XWINDOW (window
)->top
)));
2500 posn
= Qvertical_line
;
2502 XSET (posn
, Lisp_Int
,
2503 buffer_posn_from_coords (XWINDOW (window
),
2511 Fcons (Fcons (event
->x
, event
->y
),
2512 Fcons (make_number (event
->timestamp
),
2517 Lisp_Object window
= event
->frame_or_window
;
2518 Lisp_Object portion_whole
= Fcons (event
->x
, event
->y
);
2519 Lisp_Object part
= *scroll_bar_parts
[(int) event
->part
];
2523 Fcons (Qvertical_scroll_bar
,
2524 Fcons (portion_whole
,
2525 Fcons (make_number (event
->timestamp
),
2530 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2532 start_pos
= *start_pos_ptr
;
2533 *start_pos_ptr
= Qnil
;
2535 is_double
= (button
== last_mouse_button
2536 && XINT (event
->x
) == last_mouse_x
2537 && XINT (event
->y
) == last_mouse_y
2538 && button_down_time
!= 0
2539 && (EQ (Vdouble_click_time
, Qt
)
2540 || (INTEGERP (Vdouble_click_time
)
2541 && ((int)(event
->timestamp
- button_down_time
)
2542 < XINT (Vdouble_click_time
)))));
2543 last_mouse_button
= button
;
2544 last_mouse_x
= XINT (event
->x
);
2545 last_mouse_y
= XINT (event
->y
);
2547 /* If this is a button press, squirrel away the location, so
2548 we can decide later whether it was a click or a drag. */
2549 if (event
->modifiers
& down_modifier
)
2553 double_click_count
++;
2554 event
->modifiers
|= ((double_click_count
> 2)
2559 double_click_count
= 1;
2560 button_down_time
= event
->timestamp
;
2561 *start_pos_ptr
= Fcopy_alist (position
);
2564 /* Now we're releasing a button - check the co-ordinates to
2565 see if this was a click or a drag. */
2566 else if (event
->modifiers
& up_modifier
)
2568 /* If we did not see a down before this up,
2569 ignore the up. Probably this happened because
2570 the down event chose a menu item.
2571 It would be an annoyance to treat the release
2572 of the button that chose the menu item
2573 as a separate event. */
2575 if (XTYPE (start_pos
) != Lisp_Cons
)
2578 event
->modifiers
&= ~up_modifier
;
2579 #if 0 /* Formerly we treated an up with no down as a click event. */
2580 if (XTYPE (start_pos
) != Lisp_Cons
)
2581 event
->modifiers
|= click_modifier
;
2585 /* The third element of every position should be the (x,y)
2587 Lisp_Object down
= Fnth (make_number (2), start_pos
);
2589 if (EQ (event
->x
, XCONS (down
)->car
)
2590 && EQ (event
->y
, XCONS (down
)->cdr
))
2592 if (is_double
&& double_click_count
> 1)
2593 event
->modifiers
|= ((double_click_count
> 2)
2597 event
->modifiers
|= click_modifier
;
2601 button_down_time
= 0;
2602 event
->modifiers
|= drag_modifier
;
2607 /* Every mouse event should either have the down_modifier or
2608 the up_modifier set. */
2612 /* Get the symbol we should use for the mouse click. */
2614 = modify_event_symbol (button
,
2617 lispy_mouse_names
, &mouse_syms
,
2618 (sizeof (lispy_mouse_names
)
2619 / sizeof (lispy_mouse_names
[0])));
2621 if (event
->modifiers
& drag_modifier
)
2626 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2629 Fcons (make_number (double_click_count
),
2638 /* The 'kind' field of the event is something we don't recognize. */
2645 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2647 Lisp_Object bar_window
;
2648 enum scroll_bar_part part
;
2652 /* Is it a scroll bar movement? */
2653 if (frame
&& ! NILP (bar_window
))
2655 Lisp_Object part_sym
= *scroll_bar_parts
[(int) part
];
2657 return Fcons (Qscroll_bar_movement
,
2658 (Fcons (Fcons (bar_window
,
2659 Fcons (Qvertical_scroll_bar
,
2660 Fcons (Fcons (x
, y
),
2661 Fcons (make_number (time
),
2667 /* Or is it an ordinary mouse movement? */
2671 Lisp_Object window
=
2673 ? window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
)
2677 if (XTYPE (window
) == Lisp_Window
)
2679 XSETINT (x
, XINT (x
) - XINT (XWINDOW (window
)->left
));
2680 XSETINT (y
, XINT (y
) - XINT (XWINDOW (window
)->top
));
2685 posn
= Qvertical_line
;
2687 XSET (posn
, Lisp_Int
,
2688 buffer_posn_from_coords (XWINDOW (window
),
2689 XINT (x
), XINT (y
)));
2691 else if (frame
!= 0)
2693 XSET (window
, Lisp_Frame
, frame
);
2704 return Fcons (Qmouse_movement
,
2705 Fcons (Fcons (window
,
2707 Fcons (Fcons (x
, y
),
2708 Fcons (make_number (time
),
2714 /* Construct a switch frame event. */
2716 make_lispy_switch_frame (frame
)
2719 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
2722 /* Manipulating modifiers. */
2724 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
2726 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2727 SYMBOL's name of the end of the modifiers; the string from this
2728 position is the unmodified symbol name.
2730 This doesn't use any caches. */
2732 parse_modifiers_uncached (symbol
, modifier_end
)
2736 struct Lisp_String
*name
;
2740 CHECK_SYMBOL (symbol
, 1);
2743 name
= XSYMBOL (symbol
)->name
;
2746 for (i
= 0; i
+2 <= name
->size
; )
2747 switch (name
->data
[i
])
2749 #define SINGLE_LETTER_MOD(bit) \
2750 if (name->data[i+1] != '-') \
2751 goto no_more_modifiers; \
2756 SINGLE_LETTER_MOD (alt_modifier
);
2760 SINGLE_LETTER_MOD (ctrl_modifier
);
2764 SINGLE_LETTER_MOD (hyper_modifier
);
2768 SINGLE_LETTER_MOD (meta_modifier
);
2772 SINGLE_LETTER_MOD (shift_modifier
);
2776 SINGLE_LETTER_MOD (super_modifier
);
2780 if (i
+ 5 > name
->size
)
2781 goto no_more_modifiers
;
2782 if (! strncmp (name
->data
+ i
, "drag-", 5))
2784 modifiers
|= drag_modifier
;
2787 else if (! strncmp (name
->data
+ i
, "down-", 5))
2789 modifiers
|= down_modifier
;
2792 else if (i
+ 7 <= name
->size
2793 && ! strncmp (name
->data
+ i
, "double-", 7))
2795 modifiers
|= double_modifier
;
2799 goto no_more_modifiers
;
2803 if (i
+ 7 > name
->size
)
2804 goto no_more_modifiers
;
2805 if (! strncmp (name
->data
+ i
, "triple-", 7))
2807 modifiers
|= triple_modifier
;
2811 goto no_more_modifiers
;
2815 goto no_more_modifiers
;
2817 #undef SINGLE_LETTER_MOD
2821 /* Should we include the `click' modifier? */
2822 if (! (modifiers
& (down_modifier
| drag_modifier
2823 | double_modifier
| triple_modifier
))
2824 && i
+ 7 == name
->size
2825 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
2826 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
2827 modifiers
|= click_modifier
;
2836 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
2837 prepended to the string BASE[0..BASE_LEN-1].
2838 This doesn't use any caches. */
2840 apply_modifiers_uncached (modifiers
, base
, base_len
)
2845 /* Since BASE could contain nulls, we can't use intern here; we have
2846 to use Fintern, which expects a genuine Lisp_String, and keeps a
2849 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
2855 /* Only the event queue may use the `up' modifier; it should always
2856 be turned into a click or drag event before presented to lisp code. */
2857 if (modifiers
& up_modifier
)
2860 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
2861 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
2862 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
2863 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
2864 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
2865 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
2866 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
2867 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
2868 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
2869 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
2870 /* The click modifier is denoted by the absence of other modifiers. */
2874 mod_len
= p
- new_mods
;
2878 Lisp_Object new_name
= make_uninit_string (mod_len
+ base_len
);
2880 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
2881 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
2883 return Fintern (new_name
, Qnil
);
2888 static char *modifier_names
[] =
2890 "up", "down", "drag", "click", "double", "triple", 0, 0,
2891 0, 0, 0, 0, 0, 0, 0, 0,
2892 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
2894 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
2896 static Lisp_Object modifier_symbols
;
2898 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
2900 lispy_modifier_list (modifiers
)
2903 Lisp_Object modifier_list
;
2906 modifier_list
= Qnil
;
2907 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
2908 if (modifiers
& (1<<i
))
2909 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
2912 return modifier_list
;
2916 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
2917 where UNMODIFIED is the unmodified form of SYMBOL,
2918 MASK is the set of modifiers present in SYMBOL's name.
2919 This is similar to parse_modifiers_uncached, but uses the cache in
2920 SYMBOL's Qevent_symbol_element_mask property, and maintains the
2921 Qevent_symbol_elements property. */
2923 parse_modifiers (symbol
)
2926 Lisp_Object elements
= Fget (symbol
, Qevent_symbol_element_mask
);
2928 if (CONSP (elements
))
2933 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
2934 Lisp_Object unmodified
2935 = Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
2936 XSYMBOL (symbol
)->name
->size
- end
),
2940 if (modifiers
& ~((1<<VALBITS
) - 1))
2942 XFASTINT (mask
) = modifiers
;
2943 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
2945 /* Cache the parsing results on SYMBOL. */
2946 Fput (symbol
, Qevent_symbol_element_mask
,
2948 Fput (symbol
, Qevent_symbol_elements
,
2949 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
2951 /* Since we know that SYMBOL is modifiers applied to unmodified,
2952 it would be nice to put that in unmodified's cache.
2953 But we can't, since we're not sure that parse_modifiers is
2960 /* Apply the modifiers MODIFIERS to the symbol BASE.
2961 BASE must be unmodified.
2963 This is like apply_modifiers_uncached, but uses BASE's
2964 Qmodifier_cache property, if present. It also builds
2965 Qevent_symbol_elements properties, since it has that info anyway.
2967 apply_modifiers copies the value of BASE's Qevent_kind property to
2968 the modified symbol. */
2970 apply_modifiers (modifiers
, base
)
2974 Lisp_Object cache
, index
, entry
, new_symbol
;
2976 /* Mask out upper bits. We don't know where this value's been. */
2977 modifiers
&= (1<<VALBITS
) - 1;
2979 /* The click modifier never figures into cache indices. */
2980 cache
= Fget (base
, Qmodifier_cache
);
2981 XFASTINT (index
) = (modifiers
& ~click_modifier
);
2982 entry
= Fassq (index
, cache
);
2985 new_symbol
= XCONS (entry
)->cdr
;
2988 /* We have to create the symbol ourselves. */
2989 new_symbol
= apply_modifiers_uncached (modifiers
,
2990 XSYMBOL (base
)->name
->data
,
2991 XSYMBOL (base
)->name
->size
);
2993 /* Add the new symbol to the base's cache. */
2994 entry
= Fcons (index
, new_symbol
);
2995 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
2997 /* We have the parsing info now for free, so add it to the caches. */
2998 XFASTINT (index
) = modifiers
;
2999 Fput (new_symbol
, Qevent_symbol_element_mask
,
3000 Fcons (base
, Fcons (index
, Qnil
)));
3001 Fput (new_symbol
, Qevent_symbol_elements
,
3002 Fcons (base
, lispy_modifier_list (modifiers
)));
3005 /* Make sure this symbol is of the same kind as BASE.
3007 You'd think we could just set this once and for all when we
3008 intern the symbol above, but reorder_modifiers may call us when
3009 BASE's property isn't set right; we can't assume that just
3010 because it has a Qmodifier_cache property it must have its
3011 Qevent_kind set right as well. */
3012 if (NILP (Fget (new_symbol
, Qevent_kind
)))
3014 Lisp_Object kind
= Fget (base
, Qevent_kind
);
3017 Fput (new_symbol
, Qevent_kind
, kind
);
3024 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
3025 return a symbol with the modifiers placed in the canonical order.
3026 Canonical order is alphabetical, except for down and drag, which
3027 always come last. The 'click' modifier is never written out.
3029 Fdefine_key calls this to make sure that (for example) C-M-foo
3030 and M-C-foo end up being equivalent in the keymap. */
3033 reorder_modifiers (symbol
)
3036 /* It's hopefully okay to write the code this way, since everything
3037 will soon be in caches, and no consing will be done at all. */
3038 Lisp_Object parsed
= parse_modifiers (symbol
);
3040 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
3041 XCONS (parsed
)->car
);
3045 /* For handling events, we often want to produce a symbol whose name
3046 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
3047 to some base, like the name of a function key or mouse button.
3048 modify_event_symbol produces symbols of this sort.
3050 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
3051 is the name of the i'th symbol. TABLE_SIZE is the number of elements
3054 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
3055 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
3057 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
3058 persist between calls to modify_event_symbol that it can use to
3059 store a cache of the symbols it's generated for this NAME_TABLE
3060 before. The object stored there may be a vector or an alist.
3062 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
3064 MODIFIERS is a set of modifier bits (as given in struct input_events)
3065 whose prefixes should be applied to the symbol name.
3067 SYMBOL_KIND is the value to be placed in the event_kind property of
3068 the returned symbol.
3070 The symbols we create are supposed to have an
3071 `event-symbol-elements' property, which lists the modifiers present
3072 in the symbol's name. */
3075 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
3076 name_table
, symbol_table
, table_size
)
3079 Lisp_Object symbol_kind
;
3080 Lisp_Object name_alist
;
3082 Lisp_Object
*symbol_table
;
3086 Lisp_Object symbol_int
;
3088 XSET (symbol_int
, Lisp_Int
, symbol_num
);
3090 /* Is this a request for a valid symbol? */
3091 if (symbol_num
< 0 || symbol_num
>= table_size
)
3094 if (CONSP (*symbol_table
))
3095 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
3097 /* If *symbol_table doesn't seem to be initialized properly, fix that.
3098 *symbol_table should be a lisp vector TABLE_SIZE elements long,
3099 where the Nth element is the symbol for NAME_TABLE[N], or nil if
3100 we've never used that symbol before. */
3103 if (! VECTORP (*symbol_table
)
3104 || XVECTOR (*symbol_table
)->size
!= table_size
)
3108 XFASTINT (size
) = table_size
;
3109 *symbol_table
= Fmake_vector (size
, Qnil
);
3112 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
3115 /* Have we already used this symbol before? */
3118 /* No; let's create it. */
3119 if (!NILP (name_alist
))
3120 value
= Fassq (symbol_int
, name_alist
);
3121 else if (name_table
[symbol_num
])
3122 value
= intern (name_table
[symbol_num
]);
3126 sprintf (buf
, "key-%d", symbol_num
);
3127 value
= intern (buf
);
3130 if (CONSP (*symbol_table
))
3131 *symbol_table
= Fcons (value
, *symbol_table
);
3133 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
3135 /* Fill in the cache entries for this symbol; this also
3136 builds the Qevent_symbol_elements property, which the user
3138 apply_modifiers (modifiers
& click_modifier
, value
);
3139 Fput (value
, Qevent_kind
, symbol_kind
);
3142 /* Apply modifiers to that symbol. */
3143 return apply_modifiers (modifiers
, value
);
3147 /* Store into *addr a value nonzero if terminal input chars are available.
3148 Serves the purpose of ioctl (0, FIONREAD, addr)
3149 but works even if FIONREAD does not exist.
3150 (In fact, this may actually read some input.) */
3153 get_input_pending (addr
)
3156 /* First of all, have we already counted some input? */
3157 *addr
= !NILP (Vquit_flag
) || readable_events ();
3159 /* If input is being read as it arrives, and we have none, there is none. */
3160 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
3163 /* Try to read some input and see how much we get. */
3165 *addr
= !NILP (Vquit_flag
) || readable_events ();
3168 /* Interface to read_avail_input, blocking SIGIO if necessary. */
3171 gobble_input (expected
)
3176 if (interrupt_input
)
3179 mask
= sigblockx (SIGIO
);
3180 read_avail_input (expected
);
3185 read_avail_input (expected
);
3191 /* Read any terminal input already buffered up by the system
3192 into the kbd_buffer, but do not wait.
3194 EXPECTED should be nonzero if the caller knows there is some input.
3196 Except on VMS, all input is read by this function.
3197 If interrupt_input is nonzero, this function MUST be called
3198 only when SIGIO is blocked.
3200 Returns the number of keyboard chars read, or -1 meaning
3201 this is a bad time to try to read input. */
3204 read_avail_input (expected
)
3207 struct input_event buf
[KBD_BUFFER_SIZE
];
3211 if (read_socket_hook
)
3212 /* No need for FIONREAD or fcntl; just say don't wait. */
3213 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
3216 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
3217 the kbd_buffer can really hold. That may prevent loss
3218 of characters on some systems when input is stuffed at us. */
3219 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
3222 nread
= dos_keysns ();
3223 if (nread
== 0) return 0;
3224 #else */ not MSDOS */
3226 /* Find out how much input is available. */
3227 if (ioctl (0, FIONREAD
, &nread
) < 0)
3228 /* Formerly simply reported no input, but that sometimes led to
3229 a failure of Emacs to terminate.
3230 SIGHUP seems appropriate if we can't reach the terminal. */
3231 /* ??? Is it really right to send the signal just to this process
3232 rather than to the whole process group?
3233 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3234 kill (getpid (), SIGHUP
);
3237 if (nread
> sizeof cbuf
)
3238 nread
= sizeof cbuf
;
3239 #else /* no FIONREAD */
3240 #if defined(USG) || defined(DGUX)
3241 /* Read some input if available, but don't wait. */
3242 nread
= sizeof cbuf
;
3243 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
3248 #endif /* not MSDOS */
3250 /* Now read; for one reason or another, this will not block. */
3254 cbuf
[0] = dos_keyread();
3257 nread
= read (fileno (stdin
), cbuf
, nread
);
3260 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3261 This looks incorrect, but it isn't, because _BSD causes
3262 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3263 and that causes a value other than 0 when there is no input. */
3267 /* This code is wrong, but at least it gets the right results.
3268 Fix it for 19.23. */
3269 /* Retry the read if it is interrupted. */
3272 || ! (errno
== EAGAIN
|| errno
== EFAULT
3274 || ! (errno
== EAGAIN
3284 #if defined (USG) || defined (DGUX)
3285 fcntl (fileno (stdin
), F_SETFL
, 0);
3286 #endif /* USG or DGUX */
3287 #endif /* no FIONREAD */
3288 for (i
= 0; i
< nread
; i
++)
3290 buf
[i
].kind
= ascii_keystroke
;
3291 buf
[i
].modifiers
= 0;
3292 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3293 buf
[i
].modifiers
= meta_modifier
;
3297 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
3299 XSET (buf
[i
].frame_or_window
, Lisp_Frame
, selected_frame
);
3301 buf
[i
].frame_or_window
= Qnil
;
3306 /* Scan the chars for C-g and store them in kbd_buffer. */
3307 for (i
= 0; i
< nread
; i
++)
3309 kbd_buffer_store_event (&buf
[i
]);
3310 /* Don't look at input that follows a C-g too closely.
3311 This reduces lossage due to autorepeat on C-g. */
3312 if (buf
[i
].kind
== ascii_keystroke
3313 && XINT(buf
[i
].code
) == quit_char
)
3319 #endif /* not VMS */
3321 #ifdef SIGIO /* for entire page */
3322 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3325 input_available_signal (signo
)
3328 /* Must preserve main program's value of errno. */
3329 int old_errno
= errno
;
3331 extern int select_alarmed
;
3335 /* USG systems forget handlers when they are used;
3336 must reestablish each time */
3337 signal (signo
, input_available_signal
);
3344 if (input_available_clear_time
)
3345 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3350 nread
= read_avail_input (1);
3351 /* -1 means it's not ok to read the input now.
3352 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3353 0 means there was no keyboard input available. */
3358 select_alarmed
= 1; /* Force the select emulator back to life */
3369 /* Send ourselves a SIGIO.
3371 This function exists so that the UNBLOCK_INPUT macro in
3372 blockinput.h can have some way to take care of input we put off
3373 dealing with, without assuming that every file which uses
3374 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3376 reinvoke_input_signal ()
3385 /* Return the prompt-string of a sparse keymap.
3386 This is the first element which is a string.
3387 Return nil if there is none. */
3395 register Lisp_Object tem
;
3397 if (XTYPE (tem
) == Lisp_String
)
3404 static Lisp_Object
menu_bar_item ();
3405 static Lisp_Object
menu_bar_one_keymap ();
3407 /* Return a list of menu items for a menu bar, appropriate
3408 to the current buffer.
3409 The elements have the form (KEY STRING . nil). */
3414 /* The number of keymaps we're scanning right now, and the number of
3415 keymaps we have allocated space for. */
3418 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3419 in the current keymaps, or nil where it is not a prefix. */
3422 Lisp_Object def
, tem
, tail
;
3429 /* In order to build the menus, we need to call the keymap
3430 accessors. They all call QUIT. But this function is called
3431 during redisplay, during which a quit is fatal. So inhibit
3432 quitting while building the menus.
3433 We do this instead of specbind because (1) errors will clear it anyway
3434 and (2) this avoids risk of specpdl overflow. */
3435 oquit
= Vinhibit_quit
;
3438 /* Build our list of keymaps.
3439 If we recognize a function key and replace its escape sequence in
3440 keybuf with its symbol, or if the sequence starts with a mouse
3441 click and we need to switch buffers, we jump back here to rebuild
3442 the initial keymaps from the current buffer. */
3446 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3447 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3448 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3449 #ifdef USE_TEXT_PROPERTIES
3450 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3452 maps
[nmaps
-2] = current_buffer
->keymap
;
3454 maps
[nmaps
-1] = current_global_map
;
3457 /* Look up in each map the dummy prefix key `menu-bar'. */
3461 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3463 if (! NILP (maps
[mapno
]))
3464 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3468 tem
= Fkeymapp (def
);
3470 result
= menu_bar_one_keymap (def
, result
);
3473 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3477 elt
= Fassq (XCONS (tail
)->car
, result
);
3479 result
= Fcons (elt
, Fdelq (elt
, result
));
3482 result
= Fnreverse (result
);
3483 Vinhibit_quit
= oquit
;
3487 /* Scan one map KEYMAP, accumulating any menu items it defines
3488 that have not yet been seen in RESULT. Return the updated RESULT. */
3491 menu_bar_one_keymap (keymap
, result
)
3492 Lisp_Object keymap
, result
;
3494 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3496 /* Loop over all keymap entries that have menu strings. */
3497 for (tail
= keymap
; XTYPE (tail
) == Lisp_Cons
; tail
= XCONS (tail
)->cdr
)
3499 item
= XCONS (tail
)->car
;
3500 if (XTYPE (item
) == Lisp_Cons
)
3502 key
= XCONS (item
)->car
;
3503 binding
= XCONS (item
)->cdr
;
3504 if (XTYPE (binding
) == Lisp_Cons
)
3506 item_string
= XCONS (binding
)->car
;
3507 if (XTYPE (item_string
) == Lisp_String
)
3508 result
= menu_bar_item (key
, item_string
,
3509 Fcdr (binding
), result
);
3511 else if (EQ (binding
, Qundefined
))
3512 result
= menu_bar_item (key
, item_string
,
3515 else if (XTYPE (item
) == Lisp_Vector
)
3517 /* Loop over the char values represented in the vector. */
3518 int len
= XVECTOR (item
)->size
;
3520 for (c
= 0; c
< len
; c
++)
3522 Lisp_Object character
;
3523 XFASTINT (character
) = c
;
3524 binding
= XVECTOR (item
)->contents
[c
];
3525 if (XTYPE (binding
) == Lisp_Cons
)
3527 item_string
= XCONS (binding
)->car
;
3528 if (XTYPE (item_string
) == Lisp_String
)
3529 result
= menu_bar_item (key
, item_string
,
3530 Fcdr (binding
), result
);
3532 else if (EQ (binding
, Qundefined
))
3533 result
= menu_bar_item (key
, item_string
,
3543 menu_bar_item (key
, item_string
, def
, result
)
3544 Lisp_Object key
, item_string
, def
, result
;
3547 Lisp_Object enabled
;
3549 if (EQ (def
, Qundefined
))
3551 /* If a map has an explicit nil as definition,
3552 discard any previously made menu bar item. */
3553 tem
= Fassq (key
, result
);
3554 return Fdelq (tem
, result
);
3557 /* See if this entry is enabled. */
3560 if (XTYPE (def
) == Lisp_Symbol
)
3562 /* No property, or nil, means enable.
3563 Otherwise, enable if value is not nil. */
3564 tem
= Fget (def
, Qmenu_enable
);
3566 enabled
= Feval (tem
);
3569 /* Add an entry for this key and string
3570 if there is none yet. */
3571 tem
= Fassq (key
, result
);
3572 if (!NILP (enabled
) && NILP (tem
))
3573 result
= Fcons (Fcons (key
, Fcons (item_string
, Qnil
)), result
);
3578 /* Read a character using menus based on maps in the array MAPS.
3579 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
3580 Return t if we displayed a menu but the user rejected it.
3582 PREV_EVENT is the previous input event, or nil if we are reading
3583 the first event of a key sequence.
3585 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3586 if we used a mouse menu to read the input, or zero otherwise. If
3587 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
3589 The prompting is done based on the prompt-string of the map
3590 and the strings associated with various map elements.
3592 This can be done with X menus or with menus put in the minibuf.
3593 These are done in different ways, depending on how the input will be read.
3594 Menus using X are done after auto-saving in read-char, getting the input
3595 event from Fx_popup_menu; menus using the minibuf use read_char recursively
3596 and do auto-saving in the inner call of read_char. */
3599 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
3602 Lisp_Object prev_event
;
3603 int *used_mouse_menu
;
3606 register Lisp_Object name
;
3607 Lisp_Object rest
, vector
;
3609 if (used_mouse_menu
)
3610 *used_mouse_menu
= 0;
3612 /* Use local over global Menu maps */
3614 if (! menu_prompting
)
3617 /* Get the menu name from the first map that has one (a prompt string). */
3618 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3620 name
= map_prompt (maps
[mapno
]);
3625 /* If we don't have any menus, just read a character normally. */
3629 #ifdef HAVE_X_WINDOWS
3631 /* If we got to this point via a mouse click,
3632 use a real menu for mouse selection. */
3633 if (EVENT_HAS_PARAMETERS (prev_event
))
3635 /* Display the menu and get the selection. */
3636 Lisp_Object
*realmaps
3637 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
3641 /* Use the maps that are not nil. */
3642 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3643 if (!NILP (maps
[mapno
]))
3644 realmaps
[nmaps1
++] = maps
[mapno
];
3646 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
3649 /* If we got more than one event, put all but the first
3650 onto this list to be read later.
3651 Return just the first event now. */
3652 unread_command_events
3653 = nconc2 (XCONS (value
)->cdr
, unread_command_events
);
3654 value
= XCONS (value
)->car
;
3658 if (used_mouse_menu
)
3659 *used_mouse_menu
= 1;
3662 #endif /* HAVE_X_MENU */
3663 #endif /* HAVE_X_WINDOWS */
3668 read_char_minibuf_menu_prompt(commandflag
, nmaps
, maps
)
3674 register Lisp_Object name
;
3676 int width
= FRAME_WIDTH (selected_frame
) - 4;
3677 char *menu
= (char *) alloca (width
+ 4);
3680 Lisp_Object rest
, vector
;
3682 if (! menu_prompting
)
3685 /* Get the menu name from the first map that has one (a prompt string). */
3686 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3688 name
= map_prompt (maps
[mapno
]);
3693 /* If we don't have any menus, just read a character normally. */
3697 /* Prompt string always starts with map's prompt, and a space. */
3698 strcpy (menu
, XSTRING (name
)->data
);
3699 nlength
= XSTRING (name
)->size
;
3700 menu
[nlength
++] = ':';
3701 menu
[nlength
++] = ' ';
3704 /* Start prompting at start of first map. */
3708 /* Present the documented bindings, a line at a time. */
3715 int orig_defn_macro
;
3717 /* Loop over elements of map. */
3722 /* If reached end of map, start at beginning of next map. */
3726 /* At end of last map, wrap around to first map if just starting,
3727 or end this line if already have something on it. */
3731 if ( notfirst
|| nobindings
) break;
3736 /* Look at the next element of the map. */
3738 elt
= XVECTOR (vector
)->contents
[idx
];
3740 elt
= Fcar_safe (rest
);
3742 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
3744 /* If we found a dense table in the keymap,
3745 advanced past it, but start scanning its contents. */
3746 rest
= Fcdr_safe (rest
);
3752 /* An ordinary element. */
3754 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
3756 s
= Fcar_safe(elt
); /* vector */
3757 if (XTYPE (s
) != Lisp_String
)
3758 /* Ignore the element if it has no prompt string. */
3760 /* If we have room for the prompt string, add it to this line.
3761 If this is the first on the line, always add it. */
3762 else if (XSTRING (s
)->size
+ i
+ 2 < width
3767 /* Punctuate between strings. */
3770 strcpy (menu
+ i
, ", ");
3776 /* Add as much of string as fits. */
3777 thiswidth
= XSTRING (s
)->size
;
3778 if (thiswidth
+ i
> width
)
3779 thiswidth
= width
- i
;
3780 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
3786 /* If this element does not fit, end the line now,
3787 and save the element for the next line. */
3788 strcpy (menu
+ i
, "...");
3792 /* Move past this element. */
3793 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
3794 /* Handle reaching end of dense table. */
3799 rest
= Fcdr_safe (rest
);
3803 /* Prompt with that and read response. */
3806 /* Make believe its not a keyboard macro in case the help char
3807 is pressed. Help characters are not recorded because menu prompting
3808 is not used on replay.
3810 orig_defn_macro
= defining_kbd_macro
;
3811 defining_kbd_macro
= 0 ;
3812 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
3813 defining_kbd_macro
= orig_defn_macro
;
3815 if (XTYPE (obj
) != Lisp_Int
)
3820 if (! EQ (obj
, menu_prompt_more_char
)
3821 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
3822 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
3824 if ( defining_kbd_macro
)
3825 store_kbd_macro_char(obj
) ;
3828 /* Help char - go round again */
3832 /* Reading key sequences. */
3834 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
3835 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
3836 keymap, or nil otherwise. Return the index of the first keymap in
3837 which KEY has any binding, or NMAPS if no map has a binding.
3839 If KEY is a meta ASCII character, treat it like meta-prefix-char
3840 followed by the corresponding non-meta character. Keymaps in
3841 CURRENT with non-prefix bindings for meta-prefix-char become nil in
3844 When KEY is not defined in any of the keymaps, if it is an upper
3845 case letter and there are bindings for the corresponding lower-case
3846 letter, return the bindings for the lower-case letter.
3847 We store 1 in *CASE_CONVERTED in this case.
3848 Otherwise, we don't change *CASE_CONVERTED.
3850 If KEY has no bindings in any of the CURRENT maps, NEXT is left
3853 NEXT may == CURRENT. */
3856 follow_key (key
, nmaps
, current
, defs
, next
, case_converted
)
3858 Lisp_Object
*current
, *defs
, *next
;
3860 int *case_converted
;
3862 int i
, first_binding
;
3864 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
3865 followed by the corresponding non-meta character. */
3866 if (XTYPE (key
) == Lisp_Int
&& (XINT (key
) & CHAR_META
))
3868 for (i
= 0; i
< nmaps
; i
++)
3869 if (! NILP (current
[i
]))
3872 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
3874 /* Note that since we pass the resulting bindings through
3875 get_keymap_1, non-prefix bindings for meta-prefix-char
3877 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
3883 XSET (key
, Lisp_Int
, XFASTINT (key
) & ~CHAR_META
);
3886 first_binding
= nmaps
;
3887 for (i
= nmaps
- 1; i
>= 0; i
--)
3889 if (! NILP (current
[i
]))
3891 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3892 if (! NILP (defs
[i
]))
3899 /* When KEY is not defined in any of the keymaps, if it is an upper
3900 case letter and there are bindings for the corresponding
3901 lower-case letter, return the bindings for the lower-case letter. */
3902 if (first_binding
== nmaps
3903 && XTYPE (key
) == Lisp_Int
3904 && ((((XINT (key
) & 0x3ffff)
3905 < XSTRING (current_buffer
->downcase_table
)->size
)
3906 && UPPERCASEP (XINT (key
) & 0x3ffff))
3907 || (XINT (key
) & shift_modifier
)))
3909 if (XINT (key
) & shift_modifier
)
3910 XSETINT (key
, XINT (key
) & ~shift_modifier
);
3912 XSETINT (key
, (DOWNCASE (XINT (key
) & 0x3ffff)
3913 | (XINT (key
) & ~0x3ffff)));
3915 first_binding
= nmaps
;
3916 for (i
= nmaps
- 1; i
>= 0; i
--)
3918 if (! NILP (current
[i
]))
3920 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3921 if (! NILP (defs
[i
]))
3927 if (first_binding
!= nmaps
)
3928 *case_converted
= 1;
3931 /* Given the set of bindings we've found, produce the next set of maps. */
3932 if (first_binding
< nmaps
)
3933 for (i
= 0; i
< nmaps
; i
++)
3934 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
3936 return first_binding
;
3939 /* Read a sequence of keys that ends with a non prefix character,
3940 storing it in KEYBUF, a buffer of size BUFSIZE.
3942 Return the length of the key sequence stored.
3943 Return -1 if the user rejected a command menu.
3945 Echo starting immediately unless `prompt' is 0.
3947 Where a key sequence ends depends on the currently active keymaps.
3948 These include any minor mode keymaps active in the current buffer,
3949 the current buffer's local map, and the global map.
3951 If a key sequence has no other bindings, we check Vfunction_key_map
3952 to see if some trailing subsequence might be the beginning of a
3953 function key's sequence. If so, we try to read the whole function
3954 key, and substitute its symbolic name into the key sequence.
3956 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
3957 `double-' events into similar click events, if that would make them
3958 bound. We try to turn `triple-' events first into `double-' events,
3961 If we get a mouse click in a mode line, vertical divider, or other
3962 non-text area, we treat the click as if it were prefixed by the
3963 symbol denoting that area - `mode-line', `vertical-line', or
3966 If the sequence starts with a mouse click, we read the key sequence
3967 with respect to the buffer clicked on, not the current buffer.
3969 If the user switches frames in the midst of a key sequence, we put
3970 off the switch-frame event until later; the next call to
3971 read_char will return it. */
3974 read_key_sequence (keybuf
, bufsize
, prompt
)
3975 Lisp_Object
*keybuf
;
3979 int count
= specpdl_ptr
- specpdl
;
3981 /* How many keys there are in the current key sequence. */
3984 /* The length of the echo buffer when we started reading, and
3985 the length of this_command_keys when we started reading. */
3989 /* The number of keymaps we're scanning right now, and the number of
3990 keymaps we have allocated space for. */
3992 int nmaps_allocated
= 0;
3994 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
3995 the current keymaps. */
3998 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3999 in the current keymaps, or nil where it is not a prefix. */
4000 Lisp_Object
*submaps
;
4002 /* The index in defs[] of the first keymap that has a binding for
4003 this key sequence. In other words, the lowest i such that
4004 defs[i] is non-nil. */
4007 /* If t < mock_input, then KEYBUF[t] should be read as the next
4010 We use this to recover after recognizing a function key. Once we
4011 realize that a suffix of the current key sequence is actually a
4012 function key's escape sequence, we replace the suffix with the
4013 function key's binding from Vfunction_key_map. Now keybuf
4014 contains a new and different key sequence, so the echo area,
4015 this_command_keys, and the submaps and defs arrays are wrong. In
4016 this situation, we set mock_input to t, set t to 0, and jump to
4017 restart_sequence; the loop will read keys from keybuf up until
4018 mock_input, thus rebuilding the state; and then it will resume
4019 reading characters from the keyboard. */
4022 /* If the sequence is unbound in submaps[], then
4023 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
4024 and fkey_map is its binding.
4026 These might be > t, indicating that all function key scanning
4027 should hold off until t reaches them. We do this when we've just
4028 recognized a function key, to avoid searching for the function
4029 key's again in Vfunction_key_map. */
4030 int fkey_start
= 0, fkey_end
= 0;
4031 Lisp_Object fkey_map
;
4033 /* Likewise, for key_translation_map. */
4034 int keytran_start
= 0, keytran_end
= 0;
4035 Lisp_Object keytran_map
;
4037 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
4038 we put it off for later. While we're reading, we keep the event here. */
4039 Lisp_Object delayed_switch_frame
;
4041 /* See the comment below... */
4042 #if defined (GOBBLE_FIRST_EVENT)
4043 Lisp_Object first_event
;
4046 struct buffer
*starting_buffer
;
4048 /* Nonzero if we found the binding for one of the chars
4049 in this key sequence by downcasing it. */
4050 int case_converted
= 0;
4052 /* Nonzero if we seem to have got the beginning of a binding
4053 in function_key_map. */
4054 int function_key_possible
= 0;
4058 last_nonmenu_event
= Qnil
;
4060 delayed_switch_frame
= Qnil
;
4061 fkey_map
= Vfunction_key_map
;
4062 keytran_map
= Vkey_translation_map
;
4064 /* If there is no function-key-map, turn off function key scanning. */
4065 if (NILP (Fkeymapp (Vfunction_key_map
)))
4066 fkey_start
= fkey_end
= bufsize
+ 1;
4068 /* If there is no key-translation-map, turn off scanning. */
4069 if (NILP (Fkeymapp (Vkey_translation_map
)))
4070 keytran_start
= keytran_end
= bufsize
+ 1;
4075 echo_prompt (XSTRING (prompt
)->data
);
4076 else if (cursor_in_echo_area
)
4077 /* This doesn't put in a dash if the echo buffer is empty, so
4078 you don't always see a dash hanging out in the minibuffer. */
4082 /* Record the initial state of the echo area and this_command_keys;
4083 we will need to restore them if we replay a key sequence. */
4085 echo_start
= echo_length ();
4086 keys_start
= this_command_key_count
;
4088 #if defined (GOBBLE_FIRST_EVENT)
4089 /* This doesn't quite work, because some of the things that read_char
4090 does cannot safely be bypassed. It seems too risky to try to make
4093 /* Read the first char of the sequence specially, before setting
4094 up any keymaps, in case a filter runs and switches buffers on us. */
4095 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
4097 #endif /* GOBBLE_FIRST_EVENT */
4099 /* We jump here when the key sequence has been thoroughly changed, and
4100 we need to rescan it starting from the beginning. When we jump here,
4101 keybuf[0..mock_input] holds the sequence we should reread. */
4104 starting_buffer
= current_buffer
;
4106 function_key_possible
= 0;
4108 /* Build our list of keymaps.
4109 If we recognize a function key and replace its escape sequence in
4110 keybuf with its symbol, or if the sequence starts with a mouse
4111 click and we need to switch buffers, we jump back here to rebuild
4112 the initial keymaps from the current buffer. */
4116 nmaps
= current_minor_maps (0, &maps
) + 2;
4117 if (nmaps
> nmaps_allocated
)
4119 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
4120 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
4121 nmaps_allocated
= nmaps
;
4123 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
4124 #ifdef USE_TEXT_PROPERTIES
4125 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
4127 submaps
[nmaps
-2] = current_buffer
->keymap
;
4129 submaps
[nmaps
-1] = current_global_map
;
4132 /* Find an accurate initial value for first_binding. */
4133 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
4134 if (! NILP (submaps
[first_binding
]))
4137 /* Start from the beginning in keybuf. */
4140 /* These are no-ops the first time through, but if we restart, they
4141 revert the echo area and this_command_keys to their original state. */
4142 this_command_key_count
= keys_start
;
4144 echo_truncate (echo_start
);
4146 /* If the best binding for the current key sequence is a keymap, or
4147 we may be looking at a function key's escape sequence, keep on
4149 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
4150 || (first_binding
>= nmaps
4152 /* mock input is never part of a function key's sequence. */
4153 && mock_input
<= fkey_start
)
4154 || (first_binding
>= nmaps
4155 && keytran_start
< t
4156 /* mock input is never part of a function key's sequence. */
4157 && mock_input
<= keytran_start
)
4158 /* Don't return in the middle of a possible function key sequence,
4159 if the only bindings we found were via case conversion.
4160 Thus, if ESC O a has a function-key-map translation
4161 and ESC o has a binding, don't return after ESC O,
4162 so that we can translate ESC O plus the next character. */
4163 || (function_key_possible
&& case_converted
))
4166 int used_mouse_menu
= 0;
4168 /* Where the last real key started. If we need to throw away a
4169 key that has expanded into more than one element of keybuf
4170 (say, a mouse click on the mode line which is being treated
4171 as [mode-line (mouse-...)], then we backtrack to this point
4173 int last_real_key_start
;
4175 /* These variables are analogous to echo_start and keys_start;
4176 while those allow us to restart the entire key sequence,
4177 echo_local_start and keys_local_start allow us to throw away
4179 int echo_local_start
, keys_local_start
, local_first_binding
;
4182 error ("key sequence too long");
4185 echo_local_start
= echo_length ();
4186 keys_local_start
= this_command_key_count
;
4187 local_first_binding
= first_binding
;
4190 /* These are no-ops, unless we throw away a keystroke below and
4191 jumped back up to replay_key; in that case, these restore the
4192 variables to their original state, allowing us to replay the
4195 echo_truncate (echo_local_start
);
4196 this_command_key_count
= keys_local_start
;
4197 first_binding
= local_first_binding
;
4199 /* By default, assume each event is "real". */
4200 last_real_key_start
= t
;
4202 /* Does mock_input indicate that we are re-reading a key sequence? */
4206 add_command_key (key
);
4210 /* If not, we should actually read a character. */
4213 struct buffer
*buf
= current_buffer
;
4215 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
4218 /* read_char returns t when it shows a menu and the user rejects it.
4223 /* read_char returns -1 at the end of a macro.
4224 Emacs 18 handles this by returning immediately with a
4225 zero, so that's what we'll do. */
4226 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) == -1)
4232 /* If we have a quit that was typed in another frame, and
4233 quit_throw_to_read_char switched buffers,
4234 replay to get the right keymap. */
4235 if (EQ (key
, quit_char
) && current_buffer
!= starting_buffer
)
4240 goto replay_sequence
;
4246 /* Clicks in non-text areas get prefixed by the symbol
4247 in their CHAR-ADDRESS field. For example, a click on
4248 the mode line is prefixed by the symbol `mode-line'.
4250 Furthermore, key sequences beginning with mouse clicks
4251 are read using the keymaps of the buffer clicked on, not
4252 the current buffer. So we may have to switch the buffer
4255 When we turn one event into two events, we must make sure
4256 that neither of the two looks like the original--so that,
4257 if we replay the events, they won't be expanded again.
4258 If not for this, such reexpansion could happen either here
4259 or when user programs play with this-command-keys. */
4260 if (EVENT_HAS_PARAMETERS (key
))
4262 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
4264 if (EQ (kind
, Qmouse_click
))
4266 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
4267 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4269 if (XTYPE (posn
) == Lisp_Cons
)
4271 /* We're looking at the second event of a
4272 sequence which we expanded before. Set
4273 last_real_key_start appropriately. */
4275 last_real_key_start
= t
- 1;
4278 /* Key sequences beginning with mouse clicks are
4279 read using the keymaps in the buffer clicked on,
4280 not the current buffer. If we're at the
4281 beginning of a key sequence, switch buffers. */
4282 if (last_real_key_start
== 0
4283 && XTYPE (window
) == Lisp_Window
4284 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
4285 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
4290 /* Arrange to go back to the original buffer once we're
4291 done reading the key sequence. Note that we can't
4292 use save_excursion_{save,restore} here, because they
4293 save point as well as the current buffer; we don't
4294 want to save point, because redisplay may change it,
4295 to accommodate a Fset_window_start or something. We
4296 don't want to do this at the top of the function,
4297 because we may get input from a subprocess which
4298 wants to change the selected window and stuff (say,
4300 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
4302 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
4303 goto replay_sequence
;
4305 else if (XTYPE (posn
) == Lisp_Symbol
)
4307 /* Expand mode-line and scroll-bar events into two events:
4308 use posn as a fake prefix key. */
4310 if (t
+ 1 >= bufsize
)
4311 error ("key sequence too long");
4316 /* Zap the position in key, so we know that we've
4317 expanded it, and don't try to do so again. */
4318 POSN_BUFFER_POSN (EVENT_START (key
))
4319 = Fcons (posn
, Qnil
);
4323 else if (EQ (kind
, Qswitch_frame
))
4325 /* If we're at the beginning of a key sequence, go
4326 ahead and return this event. If we're in the
4327 midst of a key sequence, delay it until the end. */
4330 delayed_switch_frame
= key
;
4336 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4338 /* Handle menu-bar events:
4339 insert the dummy prefix event `menu-bar'. */
4340 if (EQ (posn
, Qmenu_bar
))
4342 if (t
+ 1 >= bufsize
)
4343 error ("key sequence too long");
4344 /* Run the Lucid hook. */
4345 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4346 /* If it has changed current-menubar from previous value,
4347 really recompute the menubar from the value. */
4348 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4349 call0 (Qrecompute_lucid_menubar
);
4353 /* Zap the position in key, so we know that we've
4354 expanded it, and don't try to do so again. */
4355 POSN_BUFFER_POSN (EVENT_START (key
))
4356 = Fcons (posn
, Qnil
);
4359 goto replay_sequence
;
4361 else if (XTYPE (posn
) == Lisp_Cons
)
4363 /* We're looking at the second event of a
4364 sequence which we expanded before. Set
4365 last_real_key_start appropriately. */
4366 if (last_real_key_start
== t
&& t
> 0)
4367 last_real_key_start
= t
- 1;
4372 /* We have finally decided that KEY is something we might want
4374 first_binding
= (follow_key (key
,
4375 nmaps
- first_binding
,
4376 submaps
+ first_binding
,
4377 defs
+ first_binding
,
4378 submaps
+ first_binding
,
4382 /* If KEY wasn't bound, we'll try some fallbacks. */
4383 if (first_binding
>= nmaps
)
4385 Lisp_Object head
= EVENT_HEAD (key
);
4387 if (EQ (head
, Vhelp_char
))
4389 read_key_sequence_cmd
= Vprefix_help_command
;
4391 last_nonmenu_event
= key
;
4395 if (XTYPE (head
) == Lisp_Symbol
)
4397 Lisp_Object breakdown
= parse_modifiers (head
);
4398 int modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4400 /* Attempt to reduce an unbound mouse event to a simpler
4401 event that is bound:
4402 Drags reduce to clicks.
4403 Double-clicks reduce to clicks.
4404 Triple-clicks reduce to double-clicks, then to clicks.
4405 Down-clicks are eliminated.
4406 Double-downs reduce to downs, then are eliminated.
4407 Triple-downs reduce to double-downs, then to downs,
4408 then are eliminated. */
4409 if (modifiers
& (down_modifier
| drag_modifier
4410 | double_modifier
| triple_modifier
))
4412 while (modifiers
& (down_modifier
| drag_modifier
4413 | double_modifier
| triple_modifier
))
4415 Lisp_Object new_head
, new_click
;
4416 if (modifiers
& triple_modifier
)
4417 modifiers
^= (double_modifier
| triple_modifier
);
4418 else if (modifiers
& (drag_modifier
| double_modifier
))
4419 modifiers
&= ~(drag_modifier
| double_modifier
);
4422 /* Dispose of this `down' event by simply jumping
4423 back to replay_key, to get another event.
4425 Note that if this event came from mock input,
4426 then just jumping back to replay_key will just
4427 hand it to us again. So we have to wipe out any
4430 We could delete keybuf[t] and shift everything
4431 after that to the left by one spot, but we'd also
4432 have to fix up any variable that points into
4433 keybuf, and shifting isn't really necessary
4436 Adding prefixes for non-textual mouse clicks
4437 creates two characters of mock input, and both
4438 must be thrown away. If we're only looking at
4439 the prefix now, we can just jump back to
4440 replay_key. On the other hand, if we've already
4441 processed the prefix, and now the actual click
4442 itself is giving us trouble, then we've lost the
4443 state of the keymaps we want to backtrack to, and
4444 we need to replay the whole sequence to rebuild
4447 Beyond that, only function key expansion could
4448 create more than two keys, but that should never
4449 generate mouse events, so it's okay to zero
4450 mock_input in that case too.
4452 Isn't this just the most wonderful code ever? */
4453 if (t
== last_real_key_start
)
4460 mock_input
= last_real_key_start
;
4461 goto replay_sequence
;
4466 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
4468 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
4470 /* Look for a binding for this new key. follow_key
4471 promises that it didn't munge submaps the
4472 last time we called it, since key was unbound. */
4474 = (follow_key (new_click
,
4475 nmaps
- local_first_binding
,
4476 submaps
+ local_first_binding
,
4477 defs
+ local_first_binding
,
4478 submaps
+ local_first_binding
,
4480 + local_first_binding
);
4482 /* If that click is bound, go for it. */
4483 if (first_binding
< nmaps
)
4488 /* Otherwise, we'll leave key set to the drag event. */
4495 /* Normally, last_nonmenu_event gets the previous key we read.
4496 But when a mouse popup menu is being used,
4497 we don't update last_nonmenu_event; it continues to hold the mouse
4498 event that preceded the first level of menu. */
4499 if (!used_mouse_menu
)
4500 last_nonmenu_event
= key
;
4502 /* If the sequence is unbound, see if we can hang a function key
4503 off the end of it. We only want to scan real keyboard input
4504 for function key sequences, so if mock_input says that we're
4505 re-reading old events, don't examine it. */
4506 if ((first_binding
>= nmaps
|| case_converted
)
4509 Lisp_Object fkey_next
;
4511 /* Continue scan from fkey_end until we find a bound suffix.
4512 If we fail, increment fkey_start
4513 and start fkey_end from there. */
4514 while (fkey_end
< t
)
4518 key
= keybuf
[fkey_end
++];
4519 /* Look up meta-characters by prefixing them
4520 with meta_prefix_char. I hate this. */
4521 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4526 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
4528 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4531 fkey_next
= fkey_map
;
4534 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
4536 /* If the function key map gives a function, not an
4537 array, then call the function with no args and use
4538 its value instead. */
4539 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
4542 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4546 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4547 fkey_next
= call1 (fkey_next
, prompt
);
4549 /* If the function returned something invalid,
4550 barf--don't ignore it.
4551 (To ignore it safely, we would need to gcpro a bunch of
4552 other variables.) */
4553 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
4554 error ("Function in function-key-map returns invalid key sequence");
4557 function_key_possible
= ! NILP (fkey_next
);
4559 /* If keybuf[fkey_start..fkey_end] is bound in the
4560 function key map and it's a suffix of the current
4561 sequence (i.e. fkey_end == t), replace it with
4562 the binding and restart with fkey_start at the end. */
4563 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
4566 int len
= XFASTINT (Flength (fkey_next
));
4568 t
= fkey_start
+ len
;
4570 error ("key sequence too long");
4572 if (VECTORP (fkey_next
))
4573 bcopy (XVECTOR (fkey_next
)->contents
,
4574 keybuf
+ fkey_start
,
4575 (t
- fkey_start
) * sizeof (keybuf
[0]));
4576 else if (STRINGP (fkey_next
))
4580 for (i
= 0; i
< len
; i
++)
4581 XFASTINT (keybuf
[fkey_start
+ i
])
4582 = XSTRING (fkey_next
)->data
[i
];
4586 fkey_start
= fkey_end
= t
;
4587 fkey_map
= Vfunction_key_map
;
4589 goto replay_sequence
;
4592 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
4594 /* If we no longer have a bound suffix, try a new positions for
4596 if (NILP (fkey_map
))
4598 fkey_end
= ++fkey_start
;
4599 fkey_map
= Vfunction_key_map
;
4600 function_key_possible
= 0;
4605 /* Look for this sequence in key-translation-map. */
4607 Lisp_Object keytran_next
;
4609 /* Scan from keytran_end until we find a bound suffix. */
4610 while (keytran_end
< t
)
4614 key
= keybuf
[keytran_end
++];
4615 /* Look up meta-characters by prefixing them
4616 with meta_prefix_char. I hate this. */
4617 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4622 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
4624 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4627 keytran_next
= keytran_map
;
4630 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
4632 /* If the key translation map gives a function, not an
4633 array, then call the function with no args and use
4634 its value instead. */
4635 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
4636 && keytran_end
== t
)
4638 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4642 GCPRO3 (keytran_map
, keytran_map
, delayed_switch_frame
);
4643 keytran_next
= call1 (keytran_next
, prompt
);
4645 /* If the function returned something invalid,
4646 barf--don't ignore it.
4647 (To ignore it safely, we would need to gcpro a bunch of
4648 other variables.) */
4649 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
4650 error ("Function in function-key-map returns invalid key sequence");
4653 /* If keybuf[keytran_start..keytran_end] is bound in the
4654 key translation map and it's a suffix of the current
4655 sequence (i.e. keytran_end == t), replace it with
4656 the binding and restart with keytran_start at the end. */
4657 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
4658 && keytran_end
== t
)
4660 int len
= XFASTINT (Flength (keytran_next
));
4662 t
= keytran_start
+ len
;
4664 error ("key sequence too long");
4666 if (VECTORP (keytran_next
))
4667 bcopy (XVECTOR (keytran_next
)->contents
,
4668 keybuf
+ keytran_start
,
4669 (t
- keytran_start
) * sizeof (keybuf
[0]));
4670 else if (STRINGP (keytran_next
))
4674 for (i
= 0; i
< len
; i
++)
4675 XFASTINT (keybuf
[keytran_start
+ i
])
4676 = XSTRING (keytran_next
)->data
[i
];
4680 keytran_start
= keytran_end
= t
;
4681 keytran_map
= Vkey_translation_map
;
4683 goto replay_sequence
;
4686 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
4688 /* If we no longer have a bound suffix, try a new positions for
4690 if (NILP (keytran_map
))
4692 keytran_end
= ++keytran_start
;
4693 keytran_map
= Vkey_translation_map
;
4699 read_key_sequence_cmd
= (first_binding
< nmaps
4700 ? defs
[first_binding
]
4704 unread_switch_frame
= delayed_switch_frame
;
4705 unbind_to (count
, Qnil
);
4707 /* Occasionally we fabricate events, perhaps by expanding something
4708 according to function-key-map, or by adding a prefix symbol to a
4709 mouse click in the scroll bar or modeline. In this cases, return
4710 the entire generated key sequence, even if we hit an unbound
4711 prefix or a definition before the end. This means that you will
4712 be able to push back the event properly, and also means that
4713 read-key-sequence will always return a logical unit.
4716 for (; t
< mock_input
; t
++)
4718 echo_char (keybuf
[t
]);
4719 add_command_key (keybuf
[t
]);
4725 #if 0 /* This doc string is too long for some compilers.
4726 This commented-out definition serves for DOC. */
4727 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4728 "Read a sequence of keystrokes and return as a string or vector.\n\
4729 The sequence is sufficient to specify a non-prefix command in the\n\
4730 current local and global maps.\n\
4732 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
4733 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
4734 as a continuation of the previous key.\n\
4736 A C-g typed while in this function is treated like any other character,\n\
4737 and `quit-flag' is not set.\n\
4739 If the key sequence starts with a mouse click, then the sequence is read\n\
4740 using the keymaps of the buffer of the window clicked in, not the buffer\n\
4741 of the selected window as normal.\n\
4743 `read-key-sequence' drops unbound button-down events, since you normally\n\
4744 only care about the click or drag events which follow them. If a drag\n\
4745 or multi-click event is unbound, but the corresponding click event would\n\
4746 be bound, `read-key-sequence' turns the event into a click event at the\n\
4747 drag's starting position. This means that you don't have to distinguish\n\
4748 between click and drag, double, or triple events unless you want to.\n\
4750 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
4751 lines separating windows, and scroll bars with imaginary keys\n\
4752 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
4754 If the user switches frames in the middle of a key sequence, the\n\
4755 frame-switch event is put off until after the current key sequence.\n\
4757 `read-key-sequence' checks `function-key-map' for function key\n\
4758 sequences, where they wouldn't conflict with ordinary bindings. See\n\
4759 `function-key-map' for more details.")
4760 (prompt
, continue_echo
)
4763 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4765 (prompt
, continue_echo
)
4766 Lisp_Object prompt
, continue_echo
;
4768 Lisp_Object keybuf
[30];
4770 struct gcpro gcpro1
, gcpro2
;
4773 CHECK_STRING (prompt
, 0);
4776 bzero (keybuf
, sizeof keybuf
);
4778 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
4780 if (NILP (continue_echo
))
4781 this_command_key_count
= 0;
4783 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])), prompt
);
4791 return make_event_array (i
, keybuf
);
4794 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
4795 "Execute CMD as an editor command.\n\
4796 CMD must be a symbol that satisfies the `commandp' predicate.\n\
4797 Optional second arg RECORD-FLAG non-nil\n\
4798 means unconditionally put this command in `command-history'.\n\
4799 Otherwise, that is done only if an arg is read using the minibuffer.")
4801 Lisp_Object cmd
, record
;
4803 register Lisp_Object final
;
4804 register Lisp_Object tem
;
4805 Lisp_Object prefixarg
;
4806 struct backtrace backtrace
;
4807 extern int debug_on_next_call
;
4809 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
4810 Vcurrent_prefix_arg
= prefixarg
;
4811 debug_on_next_call
= 0;
4813 if (XTYPE (cmd
) == Lisp_Symbol
)
4815 tem
= Fget (cmd
, Qdisabled
);
4817 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
4822 final
= Findirect_function (cmd
);
4824 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
4825 do_autoload (final
, cmd
);
4830 if (XTYPE (final
) == Lisp_String
4831 || XTYPE (final
) == Lisp_Vector
)
4833 /* If requested, place the macro in the command history. For
4834 other sorts of commands, call-interactively takes care of
4838 = Fcons (Fcons (Qexecute_kbd_macro
,
4839 Fcons (final
, Fcons (prefixarg
, Qnil
))),
4842 return Fexecute_kbd_macro (final
, prefixarg
);
4844 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
4845 || XTYPE (final
) == Lisp_Compiled
)
4847 backtrace
.next
= backtrace_list
;
4848 backtrace_list
= &backtrace
;
4849 backtrace
.function
= &Qcall_interactively
;
4850 backtrace
.args
= &cmd
;
4851 backtrace
.nargs
= 1;
4852 backtrace
.evalargs
= 0;
4854 tem
= Fcall_interactively (cmd
, record
);
4856 backtrace_list
= backtrace
.next
;
4862 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
4864 "Read function name, then read its arguments and call it.")
4866 Lisp_Object prefixarg
;
4868 Lisp_Object function
;
4870 Lisp_Object saved_keys
;
4871 struct gcpro gcpro1
;
4873 saved_keys
= Fthis_command_keys ();
4875 GCPRO1 (saved_keys
);
4877 if (EQ (prefixarg
, Qminus
))
4879 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
4880 strcpy (buf
, "C-u ");
4881 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
4882 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
4883 else if (XTYPE (prefixarg
) == Lisp_Int
)
4884 sprintf (buf
, "%d ", XINT (prefixarg
));
4886 /* This isn't strictly correct if execute-extended-command
4887 is bound to anything else. Perhaps it should use
4888 this_command_keys? */
4889 strcat (buf
, "M-x ");
4891 /* Prompt with buf, and then read a string, completing from and
4892 restricting to the set of all defined commands. Don't provide
4893 any initial input. Save the command read on the extended-command
4895 function
= Fcompleting_read (build_string (buf
),
4896 Vobarray
, Qcommandp
,
4897 Qt
, Qnil
, Qextended_command_history
);
4899 /* Set this_command_keys to the concatenation of saved_keys and
4900 function, followed by a RET. */
4902 struct Lisp_String
*str
;
4906 this_command_key_count
= 0;
4908 str
= XSTRING (saved_keys
);
4909 for (i
= 0; i
< str
->size
; i
++)
4911 XFASTINT (tem
) = str
->data
[i
];
4912 add_command_key (tem
);
4915 str
= XSTRING (function
);
4916 for (i
= 0; i
< str
->size
; i
++)
4918 XFASTINT (tem
) = str
->data
[i
];
4919 add_command_key (tem
);
4922 XFASTINT (tem
) = '\015';
4923 add_command_key (tem
);
4928 function
= Fintern (function
, Qnil
);
4929 Vprefix_arg
= prefixarg
;
4930 this_command
= function
;
4932 return Fcommand_execute (function
, Qt
);
4936 detect_input_pending ()
4939 get_input_pending (&input_pending
);
4941 return input_pending
;
4944 /* This is called in some cases before a possible quit.
4945 It cases the next call to detect_input_pending to recompute input_pending.
4946 So calling this function unnecessarily can't do any harm. */
4947 clear_input_pending ()
4952 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
4953 "T if command input is currently available with no waiting.\n\
4954 Actually, the value is nil only if we can be sure that no input is available.")
4957 if (!NILP (unread_command_events
) || unread_command_char
!= -1)
4960 return detect_input_pending () ? Qt
: Qnil
;
4963 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
4964 "Return vector of last 100 events, not counting those from keyboard macros.")
4967 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
4970 if (total_keys
< NUM_RECENT_KEYS
)
4971 return Fvector (total_keys
, keys
);
4974 val
= Fvector (NUM_RECENT_KEYS
, keys
);
4975 bcopy (keys
+ recent_keys_index
,
4976 XVECTOR (val
)->contents
,
4977 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
4979 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
4980 recent_keys_index
* sizeof (Lisp_Object
));
4985 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
4986 "Return the key sequence that invoked this command.\n\
4987 The value is a string or a vector.")
4990 return make_event_array (this_command_key_count
,
4991 XVECTOR (this_command_keys
)->contents
);
4994 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
4995 "Return the current depth in recursive edits.")
4999 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
5003 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
5004 "FOpen dribble file: ",
5005 "Start writing all keyboard characters to a dribble file called FILE.\n\
5006 If FILE is nil, close any open dribble file.")
5017 file
= Fexpand_file_name (file
, Qnil
);
5018 dribble
= fopen (XSTRING (file
)->data
, "w");
5023 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
5024 "Discard the contents of the terminal input buffer.\n\
5025 Also cancel any kbd macro being defined.")
5028 defining_kbd_macro
= 0;
5029 update_mode_lines
++;
5031 unread_command_events
= Qnil
;
5032 unread_command_char
= -1;
5034 discard_tty_input ();
5036 /* Without the cast, GCC complains that this assignment loses the
5037 volatile qualifier of kbd_store_ptr. Is there anything wrong
5039 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
5040 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5046 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
5047 "Stop Emacs and return to superior process. You can resume later.\n\
5048 On systems that don't have job control, run a subshell instead.\n\n\
5049 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
5050 to be read as terminal input by Emacs's parent, after suspension.\n\
5052 Before suspending, call the functions in `suspend-hook' with no args.\n\
5053 If any of them returns nil, don't call the rest and don't suspend.\n\
5054 Otherwise, suspend normally and after resumption run the normal hook\n\
5055 `suspend-resume-hook' if that is bound and non-nil.\n\
5057 Some operating systems cannot stop the Emacs process and resume it later.\n\
5058 On such systems, Emacs starts a subshell instead of suspending.")
5060 Lisp_Object stuffstring
;
5063 int count
= specpdl_ptr
- specpdl
;
5064 int old_height
, old_width
;
5066 struct gcpro gcpro1
, gcpro2
;
5067 extern init_sys_modes ();
5069 if (!NILP (stuffstring
))
5070 CHECK_STRING (stuffstring
, 0);
5072 /* Run the functions in suspend-hook. */
5073 if (!NILP (Vrun_hooks
))
5074 call1 (Vrun_hooks
, intern ("suspend-hook"));
5076 GCPRO1 (stuffstring
);
5077 get_frame_size (&old_width
, &old_height
);
5079 /* sys_suspend can get an error if it tries to fork a subshell
5080 and the system resources aren't available for that. */
5081 record_unwind_protect (init_sys_modes
, 0);
5082 stuff_buffered_input (stuffstring
);
5084 unbind_to (count
, Qnil
);
5086 /* Check if terminal/window size has changed.
5087 Note that this is not useful when we are running directly
5088 with a window system; but suspend should be disabled in that case. */
5089 get_frame_size (&width
, &height
);
5090 if (width
!= old_width
|| height
!= old_height
)
5091 change_frame_size (selected_frame
, height
, width
, 0, 0);
5093 /* Run suspend-resume-hook. */
5094 if (!NILP (Vrun_hooks
))
5095 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
5101 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
5102 Then in any case stuff anything Emacs has read ahead and not used. */
5104 stuff_buffered_input (stuffstring
)
5105 Lisp_Object stuffstring
;
5107 register unsigned char *p
;
5109 /* stuff_char works only in BSD, versions 4.2 and up. */
5112 if (XTYPE (stuffstring
) == Lisp_String
)
5116 p
= XSTRING (stuffstring
)->data
;
5117 count
= XSTRING (stuffstring
)->size
;
5122 /* Anything we have read ahead, put back for the shell to read. */
5123 while (kbd_fetch_ptr
!= kbd_store_ptr
)
5125 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
5126 kbd_fetch_ptr
= kbd_buffer
;
5127 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
5128 stuff_char (kbd_fetch_ptr
->code
);
5129 kbd_fetch_ptr
->kind
= no_event
;
5130 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
5137 #endif /* BSD and not BSD4_1 */
5140 set_waiting_for_input (time_to_clear
)
5141 EMACS_TIME
*time_to_clear
;
5143 input_available_clear_time
= time_to_clear
;
5145 /* Tell interrupt_signal to throw back to read_char, */
5146 waiting_for_input
= 1;
5148 /* If interrupt_signal was called before and buffered a C-g,
5149 make it run again now, to avoid timing error. */
5150 if (!NILP (Vquit_flag
))
5151 quit_throw_to_read_char ();
5154 clear_waiting_for_input ()
5156 /* Tell interrupt_signal not to throw back to read_char, */
5157 waiting_for_input
= 0;
5158 input_available_clear_time
= 0;
5161 /* This routine is called at interrupt level in response to C-G.
5162 If interrupt_input, this is the handler for SIGINT.
5163 Otherwise, it is called from kbd_buffer_store_event,
5164 in handling SIGIO or SIGTINT.
5166 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
5167 immediately throw back to read_char.
5169 Otherwise it sets the Lisp variable quit-flag not-nil.
5170 This causes eval to throw, when it gets a chance.
5171 If quit-flag is already non-nil, it stops the job right away. */
5177 /* Must preserve main program's value of errno. */
5178 int old_errno
= errno
;
5181 /* USG systems forget handlers when they are used;
5182 must reestablish each time */
5183 signal (SIGINT
, interrupt_signal
);
5184 signal (SIGQUIT
, interrupt_signal
);
5189 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
5194 #ifdef SIGTSTP /* Support possible in later USG versions */
5196 * On systems which can suspend the current process and return to the original
5197 * shell, this command causes the user to end up back at the shell.
5198 * The "Auto-save" and "Abort" questions are not asked until
5199 * the user elects to return to emacs, at which point he can save the current
5200 * job and either dump core or continue.
5205 if (sys_suspend () == -1)
5207 printf ("Not running as a subprocess;\n");
5208 printf ("you can continue or abort.\n");
5211 /* Perhaps should really fork an inferior shell?
5212 But that would not provide any way to get back
5213 to the original shell, ever. */
5214 printf ("No support for stopping a process on this operating system;\n");
5215 printf ("you can continue or abort.\n");
5216 #endif /* not VMS */
5217 #endif /* not SIGTSTP */
5219 /* We must remain inside the screen area when the internal terminal
5220 is used. Note that [Enter] is not echoed by dos. */
5223 printf ("Auto-save? (y or n) ");
5225 if (((c
= getchar ()) & ~040) == 'Y')
5227 Fdo_auto_save (Qt
, Qnil
);
5229 printf ("\r\nAuto-save done");
5230 #else /* not MSDOS */
5231 printf ("Auto-save done\n");
5232 #endif /* not MSDOS */
5234 while (c
!= '\n') c
= getchar ();
5236 printf ("\r\nAbort? (y or n) ");
5237 #else /* not MSDOS */
5239 printf ("Abort (and enter debugger)? (y or n) ");
5241 printf ("Abort (and dump core)? (y or n) ");
5242 #endif /* not VMS */
5243 #endif /* not MSDOS */
5245 if (((c
= getchar ()) & ~040) == 'Y')
5247 while (c
!= '\n') c
= getchar ();
5249 printf ("\r\nContinuing...\r\n");
5250 #else /* not MSDOS */
5251 printf ("Continuing...\n");
5252 #endif /* not MSDOS */
5258 /* If executing a function that wants to be interrupted out of
5259 and the user has not deferred quitting by binding `inhibit-quit'
5260 then quit right away. */
5261 if (immediate_quit
&& NILP (Vinhibit_quit
))
5265 Fsignal (Qquit
, Qnil
);
5268 /* Else request quit when it's safe */
5272 if (waiting_for_input
&& !echoing
)
5273 quit_throw_to_read_char ();
5278 /* Handle a C-g by making read_char return C-g. */
5280 quit_throw_to_read_char ()
5282 quit_error_check ();
5284 /* Prevent another signal from doing this before we finish. */
5285 clear_waiting_for_input ();
5288 unread_command_events
= Qnil
;
5289 unread_command_char
= -1;
5291 #ifdef POLL_FOR_INPUT
5292 /* May be > 1 if in recursive minibuffer. */
5293 if (poll_suppress_count
== 0)
5297 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
5298 && XFRAME (internal_last_event_frame
) != selected_frame
)
5299 Fhandle_switch_frame (make_lispy_switch_frame (internal_last_event_frame
));
5302 _longjmp (getcjmp
, 1);
5305 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
5306 "Set mode of reading keyboard input.\n\
5307 First arg INTERRUPT non-nil means use input interrupts;\n\
5308 nil means use CBREAK mode.\n\
5309 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
5310 (no effect except in CBREAK mode).\n\
5311 Third arg META t means accept 8-bit input (for a Meta key).\n\
5312 META nil means ignore the top bit, on the assumption it is parity.\n\
5313 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
5314 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
5315 See also `current-input-mode'.")
5316 (interrupt
, flow
, meta
, quit
)
5317 Lisp_Object interrupt
, flow
, meta
, quit
;
5320 && (XTYPE (quit
) != Lisp_Int
5321 || XINT (quit
) < 0 || XINT (quit
) > 0400))
5322 error ("set-input-mode: QUIT must be an ASCII character");
5324 #ifdef POLL_FOR_INPUT
5330 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5331 #ifdef NO_SOCK_SIGIO
5332 if (read_socket_hook
)
5333 interrupt_input
= 0; /* No interrupts if reading from a socket. */
5335 #endif /* NO_SOCK_SIGIO */
5336 interrupt_input
= !NILP (interrupt
);
5337 #else /* not SIGIO */
5338 interrupt_input
= 0;
5339 #endif /* not SIGIO */
5340 /* Our VMS input only works by interrupts, as of now. */
5342 interrupt_input
= 1;
5344 flow_control
= !NILP (flow
);
5347 else if (EQ (meta
, Qt
))
5352 /* Don't let this value be out of range. */
5353 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
5357 #ifdef POLL_FOR_INPUT
5358 poll_suppress_count
= 1;
5364 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
5365 "Return information about the way Emacs currently reads keyboard input.\n\
5366 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
5367 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
5368 nil, Emacs is using CBREAK mode.\n\
5369 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
5370 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
5371 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
5372 META nil means ignoring the top bit, on the assumption it is parity.\n\
5373 META is neither t nor nil if accepting 8-bit input and using\n\
5374 all 8 bits as the character code.\n\
5375 QUIT is the character Emacs currently uses to quit.\n\
5376 The elements of this list correspond to the arguments of\n\
5382 val
[0] = interrupt_input
? Qt
: Qnil
;
5383 val
[1] = flow_control
? Qt
: Qnil
;
5384 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
5385 XFASTINT (val
[3]) = quit_char
;
5387 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
5393 /* This is correct before outermost invocation of the editor loop */
5394 command_loop_level
= -1;
5396 quit_char
= Ctl ('g');
5397 unread_command_events
= Qnil
;
5398 unread_command_char
= -1;
5400 recent_keys_index
= 0;
5401 kbd_fetch_ptr
= kbd_buffer
;
5402 kbd_store_ptr
= kbd_buffer
;
5403 do_mouse_tracking
= 0;
5407 /* This means that command_loop_1 won't try to select anything the first
5409 internal_last_event_frame
= Qnil
;
5410 Vlast_event_frame
= internal_last_event_frame
;
5413 /* If we're running a dumped Emacs, we need to clear out
5414 kbd_buffer_frame_or_window, in case some events got into it
5417 If we're running an undumped Emacs, it hasn't been initialized by
5418 syms_of_keyboard yet. */
5420 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5422 if (!noninteractive
)
5424 signal (SIGINT
, interrupt_signal
);
5425 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
5426 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
5427 SIGQUIT and we can't tell which one it will give us. */
5428 signal (SIGQUIT
, interrupt_signal
);
5429 #endif /* HAVE_TERMIO */
5430 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5432 signal (SIGIO
, input_available_signal
);
5436 /* Use interrupt input by default, if it works and noninterrupt input
5437 has deficiencies. */
5439 #ifdef INTERRUPT_INPUT
5440 interrupt_input
= 1;
5442 interrupt_input
= 0;
5445 /* Our VMS input only works by interrupts, as of now. */
5447 interrupt_input
= 1;
5453 if (keyboard_init_hook
)
5454 (*keyboard_init_hook
) ();
5456 #ifdef POLL_FOR_INPUT
5457 poll_suppress_count
= 1;
5462 /* This type's only use is in syms_of_keyboard, to initialize the
5463 event header symbols and put properties on them. */
5470 struct event_head head_table
[] = {
5471 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
5472 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
5473 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
5478 Qdisabled_command_hook
= intern ("disabled-command-hook");
5479 staticpro (&Qdisabled_command_hook
);
5481 Qself_insert_command
= intern ("self-insert-command");
5482 staticpro (&Qself_insert_command
);
5484 Qforward_char
= intern ("forward-char");
5485 staticpro (&Qforward_char
);
5487 Qbackward_char
= intern ("backward-char");
5488 staticpro (&Qbackward_char
);
5490 Qdisabled
= intern ("disabled");
5491 staticpro (&Qdisabled
);
5493 Qundefined
= intern ("undefined");
5494 staticpro (&Qundefined
);
5496 Qpre_command_hook
= intern ("pre-command-hook");
5497 staticpro (&Qpre_command_hook
);
5499 Qpost_command_hook
= intern ("post-command-hook");
5500 staticpro (&Qpost_command_hook
);
5502 Qfunction_key
= intern ("function-key");
5503 staticpro (&Qfunction_key
);
5504 Qmouse_click
= intern ("mouse-click");
5505 staticpro (&Qmouse_click
);
5507 Qmenu_enable
= intern ("menu-enable");
5508 staticpro (&Qmenu_enable
);
5510 Qmode_line
= intern ("mode-line");
5511 staticpro (&Qmode_line
);
5512 Qvertical_line
= intern ("vertical-line");
5513 staticpro (&Qvertical_line
);
5514 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
5515 staticpro (&Qvertical_scroll_bar
);
5516 Qmenu_bar
= intern ("menu-bar");
5517 staticpro (&Qmenu_bar
);
5519 Qabove_handle
= intern ("above-handle");
5520 staticpro (&Qabove_handle
);
5521 Qhandle
= intern ("handle");
5522 staticpro (&Qhandle
);
5523 Qbelow_handle
= intern ("below-handle");
5524 staticpro (&Qbelow_handle
);
5526 Qevent_kind
= intern ("event-kind");
5527 staticpro (&Qevent_kind
);
5528 Qevent_symbol_elements
= intern ("event-symbol-elements");
5529 staticpro (&Qevent_symbol_elements
);
5530 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
5531 staticpro (&Qevent_symbol_element_mask
);
5532 Qmodifier_cache
= intern ("modifier-cache");
5533 staticpro (&Qmodifier_cache
);
5535 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
5536 staticpro (&Qrecompute_lucid_menubar
);
5537 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
5538 staticpro (&Qactivate_menubar_hook
);
5541 struct event_head
*p
;
5543 for (p
= head_table
;
5544 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
5547 *p
->var
= intern (p
->name
);
5549 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
5550 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
5554 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
5555 staticpro (&button_down_location
);
5559 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
5561 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
5562 for (i
= 0; i
< len
; i
++)
5563 if (modifier_names
[i
])
5564 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
5565 staticpro (&modifier_symbols
);
5568 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
5569 staticpro (&recent_keys
);
5571 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
5572 staticpro (&this_command_keys
);
5574 Qextended_command_history
= intern ("extended-command-history");
5575 Fset (Qextended_command_history
, Qnil
);
5576 staticpro (&Qextended_command_history
);
5578 kbd_buffer_frame_or_window
5579 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
5580 staticpro (&kbd_buffer_frame_or_window
);
5582 func_key_syms
= Qnil
;
5583 staticpro (&func_key_syms
);
5586 staticpro (&mouse_syms
);
5588 unread_switch_frame
= Qnil
;
5589 staticpro (&unread_switch_frame
);
5591 defsubr (&Sread_key_sequence
);
5592 defsubr (&Srecursive_edit
);
5593 defsubr (&Strack_mouse
);
5594 defsubr (&Sinput_pending_p
);
5595 defsubr (&Scommand_execute
);
5596 defsubr (&Srecent_keys
);
5597 defsubr (&Sthis_command_keys
);
5598 defsubr (&Ssuspend_emacs
);
5599 defsubr (&Sabort_recursive_edit
);
5600 defsubr (&Sexit_recursive_edit
);
5601 defsubr (&Srecursion_depth
);
5602 defsubr (&Stop_level
);
5603 defsubr (&Sdiscard_input
);
5604 defsubr (&Sopen_dribble_file
);
5605 defsubr (&Sset_input_mode
);
5606 defsubr (&Scurrent_input_mode
);
5607 defsubr (&Sexecute_extended_command
);
5609 DEFVAR_LISP ("last-command-char", &last_command_char
,
5610 "Last input event that was part of a command.");
5612 DEFVAR_LISP ("last-command-event", &last_command_char
,
5613 "Last input event that was part of a command.");
5615 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
5616 "Last input event in a command, except for mouse menu events.\n\
5617 Mouse menus give back keys that don't look like mouse events;\n\
5618 this variable holds the actual mouse event that led to the menu,\n\
5619 so that you can determine whether the command was run by mouse or not.");
5621 DEFVAR_LISP ("last-input-char", &last_input_char
,
5622 "Last input event.");
5624 DEFVAR_LISP ("last-input-event", &last_input_char
,
5625 "Last input event.");
5627 DEFVAR_LISP ("unread-command-events", &unread_command_events
,
5628 "List of objects to be read as next command input events.");
5630 DEFVAR_INT ("unread-command-char", &unread_command_char
,
5631 "If not -1, an object to be read as next command input event.");
5633 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
5634 "Meta-prefix character code. Meta-foo as command input\n\
5635 turns into this character followed by foo.");
5636 XSET (meta_prefix_char
, Lisp_Int
, 033);
5638 DEFVAR_LISP ("last-command", &last_command
,
5639 "The last command executed. Normally a symbol with a function definition,\n\
5640 but can be whatever was found in the keymap, or whatever the variable\n\
5641 `this-command' was set to by that command.");
5642 last_command
= Qnil
;
5644 DEFVAR_LISP ("this-command", &this_command
,
5645 "The command now being executed.\n\
5646 The command can set this variable; whatever is put here\n\
5647 will be in `last-command' during the following command.");
5648 this_command
= Qnil
;
5650 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
5651 "*Number of keyboard input characters between auto-saves.\n\
5652 Zero means disable autosaving due to number of characters typed.");
5653 auto_save_interval
= 300;
5655 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
5656 "*Number of seconds idle time before auto-save.\n\
5657 Zero or nil means disable auto-saving due to idleness.\n\
5658 After auto-saving due to this many seconds of idle time,\n\
5659 Emacs also does a garbage collection if that seems to be warranted.");
5660 XFASTINT (Vauto_save_timeout
) = 30;
5662 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
5663 "*Nonzero means echo unfinished commands after this many seconds of pause.");
5664 echo_keystrokes
= 1;
5666 DEFVAR_INT ("polling-period", &polling_period
,
5667 "*Interval between polling for input during Lisp execution.\n\
5668 The reason for polling is to make C-g work to stop a running program.\n\
5669 Polling is needed only when using X windows and SIGIO does not work.\n\
5670 Polling is automatically disabled in all other cases.");
5673 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
5674 "*Maximum time between mouse clicks to make a double-click.\n\
5675 Measured in milliseconds. nil means disable double-click recognition;\n\
5676 t means double-clicks have no time limit and are detected\n\
5677 by position only.");
5678 Vdouble_click_time
= make_number (500);
5680 DEFVAR_INT ("num-input-keys", &num_input_keys
,
5681 "*Number of complete keys read from the keyboard so far.");
5685 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
5686 "*The frame in which the most recently read event occurred.\n\
5687 If the last event came from a keyboard macro, this is set to `macro'.");
5688 Vlast_event_frame
= Qnil
;
5691 DEFVAR_LISP ("help-char", &Vhelp_char
,
5692 "Character to recognize as meaning Help.\n\
5693 When it is read, do `(eval help-form)', and display result if it's a string.\n\
5694 If the value of `help-form' is nil, this char can be read normally.");
5695 XSET (Vhelp_char
, Lisp_Int
, Ctl ('H'));
5697 DEFVAR_LISP ("help-form", &Vhelp_form
,
5698 "Form to execute when character `help-char' is read.\n\
5699 If the form returns a string, that string is displayed.\n\
5700 If `help-form' is nil, the help char is not recognized.");
5703 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
5704 "Command to run when `help-char' character follows a prefix key.\n\
5705 This command is used only when there is no actual binding\n\
5706 for that character after that prefix key.");
5707 Vprefix_help_command
= Qnil
;
5709 DEFVAR_LISP ("top-level", &Vtop_level
,
5710 "Form to evaluate when Emacs starts up.\n\
5711 Useful to set before you dump a modified Emacs.");
5714 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
5715 "String used as translate table for keyboard input, or nil.\n\
5716 Each character is looked up in this string and the contents used instead.\n\
5717 If string is of length N, character codes N and up are untranslated.");
5718 Vkeyboard_translate_table
= Qnil
;
5720 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
5721 "Keymap of key translations that can override keymaps.\n\
5722 This keymap works like `function-key-map', but comes after that,\n\
5723 and applies even for keys that have ordinary bindings.");
5724 Vkey_translation_map
= Qnil
;
5726 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
5727 "Non-nil means prompt with menus when appropriate.\n\
5728 This is done when reading from a keymap that has a prompt string,\n\
5729 for elements that have prompt strings.\n\
5730 The menu is displayed on the screen\n\
5731 if X menus were enabled at configuration\n\
5732 time and the previous event was a mouse click prefix key.\n\
5733 Otherwise, menu prompting uses the echo area.");
5736 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
5737 "Character to see next line of menu prompt.\n\
5738 Type this character while in a menu prompt to rotate around the lines of it.");
5739 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
5741 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
5742 "A mask of additional modifier keys to use with every keyboard character.\n\
5743 Emacs applies the modifiers of the character stored here to each keyboard\n\
5744 character it reads. For example, after evaluating the expression\n\
5745 (setq extra-keyboard-modifiers ?\C-x)\n\
5746 all input characters will have the control modifier applied to them.\n\
5748 Note that the character ?\C-@, equivalent to the integer zero, does\n\
5749 not count as a control character; rather, it counts as a character\n\
5750 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
5751 cancels any modification.");
5752 extra_keyboard_modifiers
= 0;
5754 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
5755 "If an editing command sets this to t, deactivate the mark afterward.\n\
5756 The command loop sets this to nil before each command,\n\
5757 and tests the value when the command returns.\n\
5758 Buffer modification stores t in this variable.");
5759 Vdeactivate_mark
= Qnil
;
5761 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
5762 "Normal hook run before each command is executed.");
5763 Vpre_command_hook
= Qnil
;
5765 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
5766 "Normal hook run after each command is executed.");
5767 Vpost_command_hook
= Qnil
;
5769 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
5770 "t means menu bar, specified Lucid style, needs to be recomputed.");
5771 Vlucid_menu_bar_dirty_flag
= Qnil
;
5773 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
5774 "List of menu bar items to move to the end of the menu bar.\n\
5775 The elements of the list are event types that may have menu bar bindings.");
5776 Vmenu_bar_final_items
= Qnil
;
5778 DEFVAR_BOOL ("track-mouse", &do_mouse_tracking
,
5779 "*Non-nil means generate motion events for mouse motion.");
5781 DEFVAR_LISP ("vendor-key-alist", &Vvendor_key_alist
,
5782 "Alist of vendor-specific X windows key symbols.\n\
5783 Each element should have the form (N . SYMBOL) where N is the\n\
5784 numeric keysym code (sans the \"vendor-specific\" bit 1<<28)\n\
5785 and SYMBOL is its name.");
5786 Vmenu_bar_final_items
= Qnil
;
5791 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
5792 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
5793 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
5794 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
5795 initial_define_key (meta_map
, 'x', "execute-extended-command");