1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
28 #include "termhooks.h"
34 #include "character.h"
36 #include "dispextern.h"
38 #include "intervals.h"
40 #include "blockinput.h"
54 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
59 #include <sys/types.h>
63 /* This is to get the definitions of the XK_ symbols. */
70 #endif /* HAVE_NTGUI */
76 /* Variables for blockinput.h: */
78 /* Non-zero if interrupt input is blocked right now. */
79 volatile int interrupt_input_blocked
;
81 /* Nonzero means an input interrupt has arrived
82 during the current critical section. */
83 int interrupt_input_pending
;
85 /* This var should be (interrupt_input_pending || pending_atimers).
86 The QUIT macro checks this instead of interrupt_input_pending and
87 pending_atimers separately, to reduce code size. So, any code that
88 changes interrupt_input_pending or pending_atimers should update
94 #define KBD_BUFFER_SIZE 4096
96 KBOARD
*initial_kboard
;
97 KBOARD
*current_kboard
;
100 /* Nonzero in the single-kboard state, 0 in the any-kboard state. */
101 static int single_kboard
;
103 /* Non-nil disable property on a command means
104 do not execute it; call disabled-command-function's value instead. */
105 Lisp_Object Qdisabled
;
106 static Lisp_Object Qdisabled_command_function
;
108 #define NUM_RECENT_KEYS (300)
110 /* Index for storing next element into recent_keys. */
111 static int recent_keys_index
;
113 /* Total number of elements stored into recent_keys. */
114 static int total_keys
;
116 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
117 static Lisp_Object recent_keys
;
119 /* Vector holding the key sequence that invoked the current command.
120 It is reused for each command, and it may be longer than the current
121 sequence; this_command_key_count indicates how many elements
122 actually mean something.
123 It's easier to staticpro a single Lisp_Object than an array. */
124 Lisp_Object this_command_keys
;
125 ptrdiff_t this_command_key_count
;
127 /* 1 after calling Freset_this_command_lengths.
129 static int this_command_key_count_reset
;
131 /* This vector is used as a buffer to record the events that were actually read
132 by read_key_sequence. */
133 static Lisp_Object raw_keybuf
;
134 static int raw_keybuf_count
;
136 #define GROW_RAW_KEYBUF \
137 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
138 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
140 /* Number of elements of this_command_keys
141 that precede this key sequence. */
142 static ptrdiff_t this_single_command_key_start
;
144 /* Record values of this_command_key_count and echo_length ()
145 before this command was read. */
146 static ptrdiff_t before_command_key_count
;
147 static ptrdiff_t before_command_echo_length
;
149 /* For longjmp to where kbd input is being done. */
151 static jmp_buf getcjmp
;
153 /* True while doing kbd input. */
154 int waiting_for_input
;
156 /* True while displaying for echoing. Delays C-g throwing. */
160 /* Non-null means we can start echoing at the next input pause even
161 though there is something in the echo area. */
163 static struct kboard
*ok_to_echo_at_next_pause
;
165 /* The kboard last echoing, or null for none. Reset to 0 in
166 cancel_echoing. If non-null, and a current echo area message
167 exists, and echo_message_buffer is eq to the current message
168 buffer, we know that the message comes from echo_kboard. */
170 struct kboard
*echo_kboard
;
172 /* The buffer used for echoing. Set in echo_now, reset in
175 Lisp_Object echo_message_buffer
;
177 /* Nonzero means C-g should cause immediate error-signal. */
180 /* Character that causes a quit. Normally C-g.
182 If we are running on an ordinary terminal, this must be an ordinary
183 ASCII char, since we want to make it our interrupt character.
185 If we are not running on an ordinary terminal, it still needs to be
186 an ordinary ASCII char. This character needs to be recognized in
187 the input interrupt handler. At this point, the keystroke is
188 represented as a struct input_event, while the desired quit
189 character is specified as a lispy event. The mapping from struct
190 input_events to lispy events cannot run in an interrupt handler,
191 and the reverse mapping is difficult for anything but ASCII
194 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
198 /* Current depth in recursive edits. */
199 EMACS_INT command_loop_level
;
201 /* If not Qnil, this is a switch-frame event which we decided to put
202 off until the end of a key sequence. This should be read as the
203 next command input, after any unread_command_events.
205 read_key_sequence uses this to delay switch-frame events until the
206 end of the key sequence; Fread_char uses it to put off switch-frame
207 events until a non-ASCII event is acceptable as input. */
208 Lisp_Object unread_switch_frame
;
210 /* Last size recorded for a current buffer which is not a minibuffer. */
211 static ptrdiff_t last_non_minibuf_size
;
213 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
214 uintmax_t num_input_events
;
216 /* Value of num_nonmacro_input_events as of last auto save. */
218 static EMACS_INT last_auto_save
;
220 /* This is like Vthis_command, except that commands never set it. */
221 Lisp_Object real_this_command
;
223 /* The value of point when the last command was started. */
224 static ptrdiff_t last_point_position
;
226 /* The buffer that was current when the last command was started. */
227 static Lisp_Object last_point_position_buffer
;
229 /* The window that was selected when the last command was started. */
230 static Lisp_Object last_point_position_window
;
232 /* The frame in which the last input event occurred, or Qmacro if the
233 last event came from a macro. We use this to determine when to
234 generate switch-frame events. This may be cleared by functions
235 like Fselect_frame, to make sure that a switch-frame event is
236 generated by the next character. */
237 Lisp_Object internal_last_event_frame
;
239 /* The timestamp of the last input event we received from the X server.
240 X Windows wants this for selection ownership. */
241 Time last_event_timestamp
;
243 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
244 Lisp_Object QPRIMARY
;
246 static Lisp_Object Qself_insert_command
;
247 static Lisp_Object Qforward_char
;
248 static Lisp_Object Qbackward_char
;
249 Lisp_Object Qundefined
;
250 static Lisp_Object Qtimer_event_handler
;
252 /* read_key_sequence stores here the command definition of the
253 key sequence that it reads. */
254 static Lisp_Object read_key_sequence_cmd
;
255 static Lisp_Object read_key_sequence_remapped
;
257 static Lisp_Object Qinput_method_function
;
259 static Lisp_Object Qdeactivate_mark
;
261 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
263 static Lisp_Object Qecho_area_clear_hook
;
265 /* Hooks to run before and after each command. */
266 static Lisp_Object Qpre_command_hook
;
267 static Lisp_Object Qpost_command_hook
;
269 static Lisp_Object Qdeferred_action_function
;
271 static Lisp_Object Qdelayed_warnings_hook
;
273 static Lisp_Object Qinput_method_exit_on_first_char
;
274 static Lisp_Object Qinput_method_use_echo_area
;
276 static Lisp_Object Qhelp_form_show
;
278 /* File in which we write all commands we read. */
279 static FILE *dribble
;
281 /* Nonzero if input is available. */
284 /* Circular buffer for pre-read keyboard input. */
286 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
288 /* Pointer to next available character in kbd_buffer.
289 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
290 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
291 next available char is in kbd_buffer[0]. */
292 static struct input_event
*kbd_fetch_ptr
;
294 /* Pointer to next place to store character in kbd_buffer. This
295 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
296 character should go in kbd_buffer[0]. */
297 static struct input_event
* volatile kbd_store_ptr
;
299 /* The above pair of variables forms a "queue empty" flag. When we
300 enqueue a non-hook event, we increment kbd_store_ptr. When we
301 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
302 there is input available if the two pointers are not equal.
304 Why not just have a flag set and cleared by the enqueuing and
305 dequeuing functions? Such a flag could be screwed up by interrupts
306 at inopportune times. */
308 /* Symbols to head events. */
309 static Lisp_Object Qmouse_movement
;
310 static Lisp_Object Qscroll_bar_movement
;
311 Lisp_Object Qswitch_frame
;
312 static Lisp_Object Qdelete_frame
;
313 static Lisp_Object Qiconify_frame
;
314 static Lisp_Object Qmake_frame_visible
;
315 static Lisp_Object Qselect_window
;
316 Lisp_Object Qhelp_echo
;
318 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
319 static Lisp_Object Qmouse_fixup_help_message
;
322 /* Symbols to denote kinds of events. */
323 static Lisp_Object Qfunction_key
;
324 Lisp_Object Qmouse_click
;
325 #if defined (WINDOWSNT)
326 Lisp_Object Qlanguage_change
;
328 static Lisp_Object Qdrag_n_drop
;
329 static Lisp_Object Qsave_session
;
331 static Lisp_Object Qdbus_event
;
333 static Lisp_Object Qconfig_changed_event
;
335 /* Lisp_Object Qmouse_movement; - also an event header */
337 /* Properties of event headers. */
338 Lisp_Object Qevent_kind
;
339 static Lisp_Object Qevent_symbol_elements
;
341 /* Menu and tool bar item parts. */
342 static Lisp_Object Qmenu_enable
;
343 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
344 Lisp_Object QCfilter
;
346 /* Non-nil disable property on a command means
347 do not execute it; call disabled-command-function's value instead. */
348 Lisp_Object QCtoggle
, QCradio
;
349 static Lisp_Object QCbutton
, QClabel
;
351 static Lisp_Object QCvert_only
;
353 /* An event header symbol HEAD may have a property named
354 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
355 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
356 mask of modifiers applied to it. If present, this is used to help
357 speed up parse_modifiers. */
358 Lisp_Object Qevent_symbol_element_mask
;
360 /* An unmodified event header BASE may have a property named
361 Qmodifier_cache, which is an alist mapping modifier masks onto
362 modified versions of BASE. If present, this helps speed up
364 static Lisp_Object Qmodifier_cache
;
366 /* Symbols to use for parts of windows. */
367 Lisp_Object Qmode_line
;
368 Lisp_Object Qvertical_line
;
369 static Lisp_Object Qvertical_scroll_bar
;
370 Lisp_Object Qmenu_bar
;
372 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
373 static Lisp_Object
command_loop (void);
374 static Lisp_Object Qextended_command_history
;
375 EMACS_TIME
timer_check (void);
377 static void record_menu_key (Lisp_Object c
);
378 static void echo_now (void);
379 static ptrdiff_t echo_length (void);
381 static Lisp_Object Qpolling_period
;
383 /* Incremented whenever a timer is run. */
386 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
388 EMACS_TIME
*input_available_clear_time
;
390 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
391 Default is 1 if INTERRUPT_INPUT is defined. */
394 /* Nonzero while interrupts are temporarily deferred during redisplay. */
395 int interrupts_deferred
;
397 /* Allow m- file to inhibit use of FIONREAD. */
398 #ifdef BROKEN_FIONREAD
402 /* We are unable to use interrupts if FIONREAD is not available,
403 so flush SIGIO so we won't try. */
404 #if !defined (FIONREAD)
410 /* If we support a window system, turn on the code to poll periodically
411 to detect C-g. It isn't actually used when doing interrupt input. */
412 #if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_ASYNC_EVENTS)
413 #define POLL_FOR_INPUT
416 /* The time when Emacs started being idle. */
418 static EMACS_TIME timer_idleness_start_time
;
420 /* After Emacs stops being idle, this saves the last value
421 of timer_idleness_start_time from when it was idle. */
423 static EMACS_TIME timer_last_idleness_start_time
;
426 /* Global variable declarations. */
428 /* Flags for readable_events. */
429 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
430 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
431 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
433 /* Function for init_keyboard to call with no args (if nonzero). */
434 static void (*keyboard_init_hook
) (void);
436 static int read_avail_input (int);
437 static void get_input_pending (int *, int);
438 static int readable_events (int);
439 static Lisp_Object
read_char_x_menu_prompt (ptrdiff_t, Lisp_Object
*,
441 static Lisp_Object
read_char_minibuf_menu_prompt (int, ptrdiff_t,
443 static Lisp_Object
make_lispy_event (struct input_event
*);
444 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
445 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
446 enum scroll_bar_part
,
447 Lisp_Object
, Lisp_Object
,
450 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
451 Lisp_Object
, const char *const *,
452 Lisp_Object
*, ptrdiff_t);
453 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
454 static int help_char_p (Lisp_Object
);
455 static void save_getcjmp (jmp_buf);
456 static void restore_getcjmp (jmp_buf);
457 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
458 static void clear_event (struct input_event
*);
459 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
460 static void interrupt_signal (int signalnum
);
462 static void input_available_signal (int signo
);
464 static Lisp_Object (Fcommand_execute
) (Lisp_Object
, Lisp_Object
, Lisp_Object
,
466 static void handle_interrupt (void);
467 static void quit_throw_to_read_char (int) NO_RETURN
;
468 static void process_special_events (void);
469 static void timer_start_idle (void);
470 static void timer_stop_idle (void);
471 static void timer_resume_idle (void);
472 static void handle_user_signal (int);
473 static char *find_user_signal_name (int);
474 static int store_user_signal_events (void);
477 /* Add C to the echo string, if echoing is going on.
478 C can be a character, which is printed prettily ("M-C-x" and all that
479 jazz), or a symbol, whose name is printed. */
482 echo_char (Lisp_Object c
)
484 if (current_kboard
->immediate_echo
)
486 int size
= KEY_DESCRIPTION_SIZE
+ 100;
487 char *buffer
= (char *) alloca (size
);
489 Lisp_Object echo_string
;
491 echo_string
= KVAR (current_kboard
, echo_string
);
493 /* If someone has passed us a composite event, use its head symbol. */
498 ptr
= push_key_description (XINT (c
), ptr
, 1);
500 else if (SYMBOLP (c
))
502 Lisp_Object name
= SYMBOL_NAME (c
);
503 int nbytes
= SBYTES (name
);
505 if (size
- (ptr
- buffer
) < nbytes
)
507 int offset
= ptr
- buffer
;
508 size
= max (2 * size
, size
+ nbytes
);
509 buffer
= (char *) alloca (size
);
510 ptr
= buffer
+ offset
;
513 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
514 STRING_MULTIBYTE (name
), 1);
517 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
520 const char *text
= " (Type ? for further options)";
521 int len
= strlen (text
);
523 if (size
- (ptr
- buffer
) < len
)
525 int offset
= ptr
- buffer
;
527 buffer
= (char *) alloca (size
);
528 ptr
= buffer
+ offset
;
531 memcpy (ptr
, text
, len
);
535 /* Replace a dash from echo_dash with a space, otherwise
536 add a space at the end as a separator between keys. */
537 if (STRINGP (echo_string
)
538 && SCHARS (echo_string
) > 1)
540 Lisp_Object last_char
, prev_char
, idx
;
542 idx
= make_number (SCHARS (echo_string
) - 2);
543 prev_char
= Faref (echo_string
, idx
);
545 idx
= make_number (SCHARS (echo_string
) - 1);
546 last_char
= Faref (echo_string
, idx
);
548 /* We test PREV_CHAR to make sure this isn't the echoing
550 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
551 Faset (echo_string
, idx
, make_number (' '));
553 echo_string
= concat2 (echo_string
, build_string (" "));
555 else if (STRINGP (echo_string
))
556 echo_string
= concat2 (echo_string
, build_string (" "));
558 KVAR (current_kboard
, echo_string
)
559 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
565 /* Temporarily add a dash to the end of the echo string if it's not
566 empty, so that it serves as a mini-prompt for the very next character. */
571 /* Do nothing if not echoing at all. */
572 if (NILP (KVAR (current_kboard
, echo_string
)))
575 if (this_command_key_count
== 0)
578 if (!current_kboard
->immediate_echo
579 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
582 /* Do nothing if we just printed a prompt. */
583 if (current_kboard
->echo_after_prompt
584 == SCHARS (KVAR (current_kboard
, echo_string
)))
587 /* Do nothing if we have already put a dash at the end. */
588 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
590 Lisp_Object last_char
, prev_char
, idx
;
592 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
593 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
595 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
596 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
598 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
602 /* Put a dash at the end of the buffer temporarily,
603 but make it go away when the next character is added. */
604 KVAR (current_kboard
, echo_string
) = concat2 (KVAR (current_kboard
, echo_string
),
609 /* Display the current echo string, and begin echoing if not already
615 if (!current_kboard
->immediate_echo
)
618 current_kboard
->immediate_echo
= 1;
620 for (i
= 0; i
< this_command_key_count
; i
++)
624 /* Set before_command_echo_length to the value that would
625 have been saved before the start of this subcommand in
626 command_loop_1, if we had already been echoing then. */
627 if (i
== this_single_command_key_start
)
628 before_command_echo_length
= echo_length ();
630 c
= XVECTOR (this_command_keys
)->contents
[i
];
631 if (! (EVENT_HAS_PARAMETERS (c
)
632 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
636 /* Set before_command_echo_length to the value that would
637 have been saved before the start of this subcommand in
638 command_loop_1, if we had already been echoing then. */
639 if (this_command_key_count
== this_single_command_key_start
)
640 before_command_echo_length
= echo_length ();
642 /* Put a dash at the end to invite the user to type more. */
647 message3_nolog (KVAR (current_kboard
, echo_string
),
648 SBYTES (KVAR (current_kboard
, echo_string
)),
649 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
652 /* Record in what buffer we echoed, and from which kboard. */
653 echo_message_buffer
= echo_area_buffer
[0];
654 echo_kboard
= current_kboard
;
656 if (waiting_for_input
&& !NILP (Vquit_flag
))
657 quit_throw_to_read_char (0);
660 /* Turn off echoing, for the start of a new command. */
663 cancel_echoing (void)
665 current_kboard
->immediate_echo
= 0;
666 current_kboard
->echo_after_prompt
= -1;
667 KVAR (current_kboard
, echo_string
) = Qnil
;
668 ok_to_echo_at_next_pause
= NULL
;
670 echo_message_buffer
= Qnil
;
673 /* Return the length of the current echo string. */
678 return (STRINGP (KVAR (current_kboard
, echo_string
))
679 ? SCHARS (KVAR (current_kboard
, echo_string
))
683 /* Truncate the current echo message to its first LEN chars.
684 This and echo_char get used by read_key_sequence when the user
685 switches frames while entering a key sequence. */
688 echo_truncate (ptrdiff_t nchars
)
690 if (STRINGP (KVAR (current_kboard
, echo_string
)))
691 KVAR (current_kboard
, echo_string
)
692 = Fsubstring (KVAR (current_kboard
, echo_string
),
693 make_number (0), make_number (nchars
));
694 truncate_echo_area (nchars
);
698 /* Functions for manipulating this_command_keys. */
700 add_command_key (Lisp_Object key
)
702 #if 0 /* Not needed after we made Freset_this_command_lengths
703 do the job immediately. */
704 /* If reset-this-command-length was called recently, obey it now.
705 See the doc string of that function for an explanation of why. */
706 if (before_command_restore_flag
)
708 this_command_key_count
= before_command_key_count_1
;
709 if (this_command_key_count
< this_single_command_key_start
)
710 this_single_command_key_start
= this_command_key_count
;
711 echo_truncate (before_command_echo_length_1
);
712 before_command_restore_flag
= 0;
716 if (this_command_key_count
>= ASIZE (this_command_keys
))
717 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
719 ASET (this_command_keys
, this_command_key_count
, key
);
720 ++this_command_key_count
;
725 recursive_edit_1 (void)
727 ptrdiff_t count
= SPECPDL_INDEX ();
730 if (command_loop_level
> 0)
732 specbind (Qstandard_output
, Qt
);
733 specbind (Qstandard_input
, Qt
);
736 #ifdef HAVE_WINDOW_SYSTEM
737 /* The command loop has started an hourglass timer, so we have to
738 cancel it here, otherwise it will fire because the recursive edit
739 can take some time. Do not check for display_hourglass_p here,
740 because it could already be nil. */
744 /* This function may have been called from a debugger called from
745 within redisplay, for instance by Edebugging a function called
746 from fontification-functions. We want to allow redisplay in
747 the debugging session.
749 The recursive edit is left with a `(throw exit ...)'. The `exit'
750 tag is not caught anywhere in redisplay, i.e. when we leave the
751 recursive edit, the original redisplay leading to the recursive
752 edit will be unwound. The outcome should therefore be safe. */
753 specbind (Qinhibit_redisplay
, Qnil
);
756 val
= command_loop ();
758 Fsignal (Qquit
, Qnil
);
759 /* Handle throw from read_minibuf when using minibuffer
760 while it's active but we're in another window. */
762 xsignal1 (Qerror
, val
);
764 return unbind_to (count
, Qnil
);
767 /* When an auto-save happens, record the "time", and don't do again soon. */
770 record_auto_save (void)
772 last_auto_save
= num_nonmacro_input_events
;
775 /* Make an auto save happen as soon as possible at command level. */
779 force_auto_save_soon (void)
781 last_auto_save
= - auto_save_interval
- 1;
783 record_asynch_buffer_change ();
787 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
788 doc
: /* Invoke the editor command loop recursively.
789 To get out of the recursive edit, a command can do `(throw 'exit nil)';
790 that tells this function to return.
791 Alternatively, `(throw 'exit t)' makes this function signal an error.
792 This function is called by the editor initialization to begin editing. */)
795 ptrdiff_t count
= SPECPDL_INDEX ();
798 /* If we enter while input is blocked, don't lock up here.
799 This may happen through the debugger during redisplay. */
803 command_loop_level
++;
804 update_mode_lines
= 1;
806 if (command_loop_level
807 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
808 buffer
= Fcurrent_buffer ();
812 /* If we leave recursive_edit_1 below with a `throw' for instance,
813 like it is done in the splash screen display, we have to
814 make sure that we restore single_kboard as command_loop_1
815 would have done if it were left normally. */
816 if (command_loop_level
> 0)
817 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
818 record_unwind_protect (recursive_edit_unwind
, buffer
);
821 return unbind_to (count
, Qnil
);
825 recursive_edit_unwind (Lisp_Object buffer
)
827 if (BUFFERP (buffer
))
828 Fset_buffer (buffer
);
830 command_loop_level
--;
831 update_mode_lines
= 1;
836 #if 0 /* These two functions are now replaced with
837 temporarily_switch_to_single_kboard. */
841 #if 0 /* Theory: if there's anything in Vunread_command_events,
842 it will right away be read by read_key_sequence,
843 and then if we do switch KBOARDS, it will go into the side
844 queue then. So we don't need to do anything special here -- rms. */
845 if (CONSP (Vunread_command_events
))
847 current_kboard
->kbd_queue
848 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
849 current_kboard
->kbd_queue_has_data
= 1;
851 Vunread_command_events
= Qnil
;
856 /* Switch to the single-kboard state, making current_kboard
857 the only KBOARD from which further input is accepted. */
860 single_kboard_state ()
866 /* If we're in single_kboard state for kboard KBOARD,
870 not_single_kboard_state (KBOARD
*kboard
)
872 if (kboard
== current_kboard
)
876 /* Maintain a stack of kboards, so other parts of Emacs
877 can switch temporarily to the kboard of a given frame
878 and then revert to the previous status. */
883 struct kboard_stack
*next
;
886 static struct kboard_stack
*kboard_stack
;
889 push_kboard (struct kboard
*k
)
891 struct kboard_stack
*p
892 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
894 p
->next
= kboard_stack
;
895 p
->kboard
= current_kboard
;
905 struct kboard_stack
*p
= kboard_stack
;
907 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
909 if (t
->kboard
== p
->kboard
)
911 current_kboard
= p
->kboard
;
918 /* The terminal we remembered has been deleted. */
919 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
922 kboard_stack
= p
->next
;
926 /* Switch to single_kboard mode, making current_kboard the only KBOARD
927 from which further input is accepted. If F is non-nil, set its
928 KBOARD as the current keyboard.
930 This function uses record_unwind_protect to return to the previous
933 If Emacs is already in single_kboard mode, and F's keyboard is
934 locked, then this function will throw an error. */
937 temporarily_switch_to_single_kboard (struct frame
*f
)
939 int was_locked
= single_kboard
;
942 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
943 /* We can not switch keyboards while in single_kboard mode.
944 In rare cases, Lisp code may call `recursive-edit' (or
945 `read-minibuffer' or `y-or-n-p') after it switched to a
946 locked frame. For example, this is likely to happen
947 when server.el connects to a new terminal while Emacs is in
948 single_kboard mode. It is best to throw an error instead
949 of presenting the user with a frozen screen. */
950 error ("Terminal %d is locked, cannot read from it",
951 FRAME_TERMINAL (f
)->id
);
953 /* This call is unnecessary, but helps
954 `restore_kboard_configuration' discover if somebody changed
955 `current_kboard' behind our back. */
956 push_kboard (current_kboard
);
959 current_kboard
= FRAME_KBOARD (f
);
961 record_unwind_protect (restore_kboard_configuration
,
962 (was_locked
? Qt
: Qnil
));
965 #if 0 /* This function is not needed anymore. */
967 record_single_kboard_state ()
970 push_kboard (current_kboard
);
971 record_unwind_protect (restore_kboard_configuration
,
972 (single_kboard
? Qt
: Qnil
));
977 restore_kboard_configuration (Lisp_Object was_locked
)
979 if (NILP (was_locked
))
983 struct kboard
*prev
= current_kboard
;
986 /* The pop should not change the kboard. */
987 if (single_kboard
&& current_kboard
!= prev
)
994 /* Handle errors that are not handled at inner levels
995 by printing an error message and returning to the editor command loop. */
998 cmd_error (Lisp_Object data
)
1000 Lisp_Object old_level
, old_length
;
1001 char macroerror
[sizeof "After..kbd macro iterations: "
1002 + INT_STRLEN_BOUND (EMACS_INT
)];
1004 #ifdef HAVE_WINDOW_SYSTEM
1005 if (display_hourglass_p
)
1006 cancel_hourglass ();
1009 if (!NILP (executing_kbd_macro
))
1011 if (executing_kbd_macro_iterations
== 1)
1012 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1014 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1015 executing_kbd_macro_iterations
);
1020 Vstandard_output
= Qt
;
1021 Vstandard_input
= Qt
;
1022 Vexecuting_kbd_macro
= Qnil
;
1023 executing_kbd_macro
= Qnil
;
1024 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1025 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1028 /* Avoid unquittable loop if data contains a circular list. */
1029 old_level
= Vprint_level
;
1030 old_length
= Vprint_length
;
1031 XSETFASTINT (Vprint_level
, 10);
1032 XSETFASTINT (Vprint_length
, 10);
1033 cmd_error_internal (data
, macroerror
);
1034 Vprint_level
= old_level
;
1035 Vprint_length
= old_length
;
1039 Vinhibit_quit
= Qnil
;
1040 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1041 if (command_loop_level
== 0 && minibuf_level
== 0)
1042 any_kboard_state ();
1045 return make_number (0);
1048 /* Take actions on handling an error. DATA is the data that describes
1051 CONTEXT is a C-string containing ASCII characters only which
1052 describes the context in which the error happened. If we need to
1053 generalize CONTEXT to allow multibyte characters, make it a Lisp
1057 cmd_error_internal (Lisp_Object data
, const char *context
)
1059 struct frame
*sf
= SELECTED_FRAME ();
1061 /* The immediate context is not interesting for Quits,
1062 since they are asynchronous. */
1063 if (EQ (XCAR (data
), Qquit
))
1064 Vsignaling_function
= Qnil
;
1069 /* Use user's specified output function if any. */
1070 if (!NILP (Vcommand_error_function
))
1071 call3 (Vcommand_error_function
, data
,
1072 context
? build_string (context
) : empty_unibyte_string
,
1073 Vsignaling_function
);
1074 /* If the window system or terminal frame hasn't been initialized
1075 yet, or we're not interactive, write the message to stderr and exit. */
1076 else if (!sf
->glyphs_initialized_p
1077 /* The initial frame is a special non-displaying frame. It
1078 will be current in daemon mode when there are no frames
1079 to display, and in non-daemon mode before the real frame
1080 has finished initializing. If an error is thrown in the
1081 latter case while creating the frame, then the frame
1082 will never be displayed, so the safest thing to do is
1083 write to stderr and quit. In daemon mode, there are
1084 many other potential errors that do not prevent frames
1085 from being created, so continuing as normal is better in
1087 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1090 print_error_message (data
, Qexternal_debugging_output
,
1091 context
, Vsignaling_function
);
1092 Fterpri (Qexternal_debugging_output
);
1093 Fkill_emacs (make_number (-1));
1097 clear_message (1, 0);
1099 message_log_maybe_newline ();
1102 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1105 Vsignaling_function
= Qnil
;
1108 Lisp_Object
command_loop_1 (void);
1109 static Lisp_Object
command_loop_2 (Lisp_Object
);
1110 static Lisp_Object
top_level_1 (Lisp_Object
);
1112 /* Entry to editor-command-loop.
1113 This level has the catches for exiting/returning to editor command loop.
1114 It returns nil to exit recursive edit, t to abort it. */
1119 if (command_loop_level
> 0 || minibuf_level
> 0)
1122 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1123 executing_kbd_macro
= Qnil
;
1129 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1130 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1131 /* Reset single_kboard in case top-level set it while
1132 evaluating an -f option, or we are stuck there for some
1134 any_kboard_state ();
1136 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1137 executing_kbd_macro
= Qnil
;
1139 /* End of file in -batch run causes exit here. */
1145 /* Here we catch errors in execution of commands within the
1146 editing loop, and reenter the editing loop.
1147 When there is an error, cmd_error runs and returns a non-nil
1148 value to us. A value of nil means that command_loop_1 itself
1149 returned due to end of file (or end of kbd macro). */
1152 command_loop_2 (Lisp_Object ignore
)
1154 register Lisp_Object val
;
1157 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1158 while (!NILP (val
));
1166 return Feval (Vtop_level
, Qnil
);
1170 top_level_1 (Lisp_Object ignore
)
1172 /* On entry to the outer level, run the startup file */
1173 if (!NILP (Vtop_level
))
1174 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1175 else if (!NILP (Vpurify_flag
))
1176 message ("Bare impure Emacs (standard Lisp code not loaded)");
1178 message ("Bare Emacs (standard Lisp code not loaded)");
1182 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1183 doc
: /* Exit all recursive editing levels.
1184 This also exits all active minibuffers. */)
1187 #ifdef HAVE_WINDOW_SYSTEM
1188 if (display_hourglass_p
)
1189 cancel_hourglass ();
1192 /* Unblock input if we enter with input blocked. This may happen if
1193 redisplay traps e.g. during tool-bar update with input blocked. */
1194 while (INPUT_BLOCKED_P
)
1197 Fthrow (Qtop_level
, Qnil
);
1200 static Lisp_Object
Fexit_recursive_edit (void) NO_RETURN
;
1201 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1202 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1205 if (command_loop_level
> 0 || minibuf_level
> 0)
1206 Fthrow (Qexit
, Qnil
);
1208 error ("No recursive edit is in progress");
1211 static Lisp_Object
Fabort_recursive_edit (void) NO_RETURN
;
1212 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1213 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1216 if (command_loop_level
> 0 || minibuf_level
> 0)
1219 error ("No recursive edit is in progress");
1222 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1224 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1225 of this function. */
1228 tracking_off (Lisp_Object old_value
)
1230 do_mouse_tracking
= old_value
;
1231 if (NILP (old_value
))
1233 /* Redisplay may have been preempted because there was input
1234 available, and it assumes it will be called again after the
1235 input has been processed. If the only input available was
1236 the sort that we have just disabled, then we need to call
1238 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1240 redisplay_preserve_echo_area (6);
1241 get_input_pending (&input_pending
,
1242 READABLE_EVENTS_DO_TIMERS_NOW
);
1248 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1249 doc
: /* Evaluate BODY with mouse movement events enabled.
1250 Within a `track-mouse' form, mouse motion generates input events that
1251 you can read with `read-event'.
1252 Normally, mouse motion is ignored.
1253 usage: (track-mouse BODY...) */)
1256 ptrdiff_t count
= SPECPDL_INDEX ();
1259 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1261 do_mouse_tracking
= Qt
;
1263 val
= Fprogn (args
);
1264 return unbind_to (count
, val
);
1267 /* If mouse has moved on some frame, return one of those frames.
1271 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1272 after resizing the tool-bar window. */
1274 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1277 int ignore_mouse_drag_p
;
1280 some_mouse_moved (void)
1282 Lisp_Object tail
, frame
;
1284 if (ignore_mouse_drag_p
)
1286 /* ignore_mouse_drag_p = 0; */
1290 FOR_EACH_FRAME (tail
, frame
)
1292 if (XFRAME (frame
)->mouse_moved
)
1293 return XFRAME (frame
);
1299 #endif /* HAVE_MOUSE || HAVE_GPM */
1301 /* This is the actual command reading loop,
1302 sans error-handling encapsulation. */
1304 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1306 void safe_run_hooks (Lisp_Object
);
1307 static void adjust_point_for_property (ptrdiff_t, int);
1309 /* Cancel hourglass from protect_unwind.
1311 #ifdef HAVE_WINDOW_SYSTEM
1313 cancel_hourglass_unwind (Lisp_Object arg
)
1315 cancel_hourglass ();
1320 /* FIXME: This is wrong rather than test window-system, we should call
1321 a new set-selection, which will then dispatch to x-set-selection, or
1322 tty-set-selection, or w32-set-selection, ... */
1323 EXFUN (Fwindow_system
, 1);
1326 command_loop_1 (void)
1329 Lisp_Object keybuf
[30];
1331 EMACS_INT prev_modiff
= 0;
1332 struct buffer
*prev_buffer
= NULL
;
1333 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1334 int was_locked
= single_kboard
;
1336 int already_adjusted
= 0;
1338 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1339 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1340 Vdeactivate_mark
= Qnil
;
1341 waiting_for_input
= 0;
1344 this_command_key_count
= 0;
1345 this_command_key_count_reset
= 0;
1346 this_single_command_key_start
= 0;
1348 if (NILP (Vmemory_full
))
1350 /* Make sure this hook runs after commands that get errors and
1351 throw to top level. */
1352 /* Note that the value cell will never directly contain nil
1353 if the symbol is a local variable. */
1354 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1355 safe_run_hooks (Qpost_command_hook
);
1357 /* If displaying a message, resize the echo area window to fit
1358 that message's size exactly. */
1359 if (!NILP (echo_area_buffer
[0]))
1360 resize_echo_area_exactly ();
1362 /* If there are warnings waiting, process them. */
1363 if (!NILP (Vdelayed_warnings_list
))
1364 safe_run_hooks (Qdelayed_warnings_hook
);
1366 if (!NILP (Vdeferred_action_list
))
1367 safe_run_hooks (Qdeferred_action_function
);
1370 /* Do this after running Vpost_command_hook, for consistency. */
1371 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1372 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1373 if (!CONSP (last_command_event
))
1374 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1378 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1381 /* Make sure the current window's buffer is selected. */
1382 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1383 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1385 /* Display any malloc warning that just came out. Use while because
1386 displaying one warning can cause another. */
1388 while (pending_malloc_warning
)
1389 display_malloc_warning ();
1391 Vdeactivate_mark
= Qnil
;
1393 /* If minibuffer on and echo area in use,
1394 wait a short time and redraw minibuffer. */
1397 && !NILP (echo_area_buffer
[0])
1398 && EQ (minibuf_window
, echo_area_window
)
1399 && NUMBERP (Vminibuffer_message_timeout
))
1401 /* Bind inhibit-quit to t so that C-g gets read in
1402 rather than quitting back to the minibuffer. */
1403 ptrdiff_t count
= SPECPDL_INDEX ();
1404 specbind (Qinhibit_quit
, Qt
);
1406 sit_for (Vminibuffer_message_timeout
, 0, 2);
1408 /* Clear the echo area. */
1410 safe_run_hooks (Qecho_area_clear_hook
);
1412 unbind_to (count
, Qnil
);
1414 /* If a C-g came in before, treat it as input now. */
1415 if (!NILP (Vquit_flag
))
1418 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1423 /* Select the frame that the last event came from. Usually,
1424 switch-frame events will take care of this, but if some lisp
1425 code swallows a switch-frame event, we'll fix things up here.
1426 Is this a good idea? */
1427 if (FRAMEP (internal_last_event_frame
)
1428 && !EQ (internal_last_event_frame
, selected_frame
))
1429 Fselect_frame (internal_last_event_frame
, Qnil
);
1431 /* If it has changed current-menubar from previous value,
1432 really recompute the menubar from the value. */
1433 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1434 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1435 call0 (Qrecompute_lucid_menubar
);
1437 before_command_key_count
= this_command_key_count
;
1438 before_command_echo_length
= echo_length ();
1440 Vthis_command
= Qnil
;
1441 real_this_command
= Qnil
;
1442 Vthis_original_command
= Qnil
;
1443 Vthis_command_keys_shift_translated
= Qnil
;
1445 /* Read next key sequence; i gets its length. */
1446 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1449 /* A filter may have run while we were reading the input. */
1450 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1452 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1453 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1457 /* Now we have read a key sequence of length I,
1458 or else I is 0 and we found end of file. */
1460 if (i
== 0) /* End of file -- happens only in */
1461 return Qnil
; /* a kbd macro, at the end. */
1462 /* -1 means read_key_sequence got a menu that was rejected.
1463 Just loop around and read another command. */
1467 this_command_key_count
= 0;
1468 this_command_key_count_reset
= 0;
1469 this_single_command_key_start
= 0;
1473 last_command_event
= keybuf
[i
- 1];
1475 /* If the previous command tried to force a specific window-start,
1476 forget about that, in case this command moves point far away
1477 from that position. But also throw away beg_unchanged and
1478 end_unchanged information in that case, so that redisplay will
1479 update the whole window properly. */
1480 if (!NILP (XWINDOW (selected_window
)->force_start
))
1483 XWINDOW (selected_window
)->force_start
= Qnil
;
1484 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1485 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1488 cmd
= read_key_sequence_cmd
;
1489 if (!NILP (Vexecuting_kbd_macro
))
1491 if (!NILP (Vquit_flag
))
1493 Vexecuting_kbd_macro
= Qt
;
1494 QUIT
; /* Make some noise. */
1495 /* Will return since macro now empty. */
1499 /* Do redisplay processing after this command except in special
1500 cases identified below. */
1501 prev_buffer
= current_buffer
;
1502 prev_modiff
= MODIFF
;
1503 last_point_position
= PT
;
1504 last_point_position_window
= selected_window
;
1505 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1507 /* By default, we adjust point to a boundary of a region that
1508 has such a property that should be treated intangible
1509 (e.g. composition, display). But, some commands will set
1510 this variable differently. */
1511 Vdisable_point_adjustment
= Qnil
;
1513 /* Process filters and timers may have messed with deactivate-mark.
1514 reset it before we execute the command. */
1515 Vdeactivate_mark
= Qnil
;
1517 /* Remap command through active keymaps. */
1518 Vthis_original_command
= cmd
;
1519 if (!NILP (read_key_sequence_remapped
))
1520 cmd
= read_key_sequence_remapped
;
1522 /* Execute the command. */
1524 Vthis_command
= cmd
;
1525 real_this_command
= cmd
;
1526 safe_run_hooks (Qpre_command_hook
);
1528 already_adjusted
= 0;
1530 if (NILP (Vthis_command
))
1532 /* nil means key is undefined. */
1533 Lisp_Object keys
= Fvector (i
, keybuf
);
1534 keys
= Fkey_description (keys
, Qnil
);
1536 message_with_string ("%s is undefined", keys
, 0);
1537 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
1538 update_mode_lines
= 1;
1539 /* If this is a down-mouse event, don't reset prefix-arg;
1540 pass it to the command run by the up event. */
1541 if (EVENT_HAS_PARAMETERS (last_command_event
))
1543 Lisp_Object breakdown
1544 = parse_modifiers (EVENT_HEAD (last_command_event
));
1545 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1546 if (!(modifiers
& down_modifier
))
1547 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1550 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1554 /* Here for a command that isn't executed directly. */
1556 #ifdef HAVE_WINDOW_SYSTEM
1557 ptrdiff_t scount
= SPECPDL_INDEX ();
1559 if (display_hourglass_p
1560 && NILP (Vexecuting_kbd_macro
))
1562 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1567 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1569 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1571 #ifdef HAVE_WINDOW_SYSTEM
1572 /* Do not check display_hourglass_p here, because
1573 Fcommand_execute could change it, but we should cancel
1574 hourglass cursor anyway.
1575 But don't cancel the hourglass within a macro
1576 just because a command in the macro finishes. */
1577 if (NILP (Vexecuting_kbd_macro
))
1578 unbind_to (scount
, Qnil
);
1581 KVAR (current_kboard
, Vlast_prefix_arg
) = Vcurrent_prefix_arg
;
1583 safe_run_hooks (Qpost_command_hook
);
1585 /* If displaying a message, resize the echo area window to fit
1586 that message's size exactly. */
1587 if (!NILP (echo_area_buffer
[0]))
1588 resize_echo_area_exactly ();
1590 /* If there are warnings waiting, process them. */
1591 if (!NILP (Vdelayed_warnings_list
))
1592 safe_run_hooks (Qdelayed_warnings_hook
);
1594 safe_run_hooks (Qdeferred_action_function
);
1596 /* If there is a prefix argument,
1597 1) We don't want Vlast_command to be ``universal-argument''
1598 (that would be dumb), so don't set Vlast_command,
1599 2) we want to leave echoing on so that the prefix will be
1600 echoed as part of this key sequence, so don't call
1602 3) we want to leave this_command_key_count non-zero, so that
1603 read_char will realize that it is re-reading a character, and
1604 not echo it a second time.
1606 If the command didn't actually create a prefix arg,
1607 but is merely a frame event that is transparent to prefix args,
1608 then the above doesn't apply. */
1609 if (NILP (KVAR (current_kboard
, Vprefix_arg
)) || CONSP (last_command_event
))
1611 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1612 KVAR (current_kboard
, Vreal_last_command
) = real_this_command
;
1613 if (!CONSP (last_command_event
))
1614 KVAR (current_kboard
, Vlast_repeatable_command
) = real_this_command
;
1616 this_command_key_count
= 0;
1617 this_command_key_count_reset
= 0;
1618 this_single_command_key_start
= 0;
1621 if (!NILP (BVAR (current_buffer
, mark_active
))
1622 && !NILP (Vrun_hooks
))
1624 /* In Emacs 22, setting transient-mark-mode to `only' was a
1625 way of turning it on for just one command. This usage is
1626 obsolete, but support it anyway. */
1627 if (EQ (Vtransient_mark_mode
, Qidentity
))
1628 Vtransient_mark_mode
= Qnil
;
1629 else if (EQ (Vtransient_mark_mode
, Qonly
))
1630 Vtransient_mark_mode
= Qidentity
;
1632 if (!NILP (Vdeactivate_mark
))
1633 /* If `select-active-regions' is non-nil, this call to
1634 `deactivate-mark' also sets the PRIMARY selection. */
1635 call0 (Qdeactivate_mark
);
1638 /* Even if not deactivating the mark, set PRIMARY if
1639 `select-active-regions' is non-nil. */
1640 if (!NILP (Fwindow_system (Qnil
))
1641 /* Even if mark_active is non-nil, the actual buffer
1642 marker may not have been set yet (Bug#7044). */
1643 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1644 && (EQ (Vselect_active_regions
, Qonly
)
1645 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1646 : (!NILP (Vselect_active_regions
)
1647 && !NILP (Vtransient_mark_mode
)))
1648 && !EQ (Vthis_command
, Qhandle_switch_frame
))
1651 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1654 call2 (Qx_set_selection
, QPRIMARY
,
1655 make_buffer_string (beg
, end
, 0));
1657 call2 (Qx_set_selection
, QPRIMARY
,
1658 make_buffer_string (end
, beg
, 0));
1659 /* Don't set empty selections. */
1662 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1664 Lisp_Object hook
= intern ("activate-mark-hook");
1665 Frun_hooks (1, &hook
);
1669 Vsaved_region_selection
= Qnil
;
1674 if (current_buffer
== prev_buffer
1675 && last_point_position
!= PT
1676 && NILP (Vdisable_point_adjustment
)
1677 && NILP (Vglobal_disable_point_adjustment
))
1679 if (last_point_position
> BEGV
1680 && last_point_position
< ZV
1681 && (composition_adjust_point (last_point_position
,
1682 last_point_position
)
1683 != last_point_position
))
1684 /* The last point was temporarily set within a grapheme
1685 cluster to prevent automatic composition. To recover
1686 the automatic composition, we must update the
1688 windows_or_buffers_changed
++;
1689 if (!already_adjusted
)
1690 adjust_point_for_property (last_point_position
,
1691 MODIFF
!= prev_modiff
);
1694 /* Install chars successfully executed in kbd macro. */
1696 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1697 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1698 finalize_kbd_macro_chars ();
1699 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1701 any_kboard_state ();
1706 /* Adjust point to a boundary of a region that has such a property
1707 that should be treated intangible. For the moment, we check
1708 `composition', `display' and `invisible' properties.
1709 LAST_PT is the last position of point. */
1712 adjust_point_for_property (ptrdiff_t last_pt
, int modified
)
1715 Lisp_Object val
, overlay
, tmp
;
1716 /* When called after buffer modification, we should temporarily
1717 suppress the point adjustment for automatic composition so that a
1718 user can keep inserting another character at point or keep
1719 deleting characters around point. */
1720 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1721 ptrdiff_t orig_pt
= PT
;
1723 /* FIXME: cycling is probably not necessary because these properties
1724 can't be usefully combined anyway. */
1725 while (check_composition
|| check_display
|| check_invisible
)
1727 /* FIXME: check `intangible'. */
1728 if (check_composition
1729 && PT
> BEGV
&& PT
< ZV
1730 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1733 check_display
= check_invisible
= 1;
1735 check_composition
= 0;
1737 && PT
> BEGV
&& PT
< ZV
1738 && !NILP (val
= get_char_property_and_overlay
1739 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1740 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1741 && (!OVERLAYP (overlay
)
1742 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1743 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1744 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1745 && (beg
< PT
/* && end > PT <- It's always the case. */
1746 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1749 SET_PT (PT
< last_pt
1750 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1752 check_composition
= check_invisible
= 1;
1755 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1757 int inv
, ellipsis
= 0;
1760 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1763 /* FIXME: We should stop if we find a spot between
1764 two runs of `invisible' where inserted text would
1765 be visible. This is important when we have two
1766 invisible boundaries that enclose an area: if the
1767 area is empty, we need this test in order to make
1768 it possible to place point in the middle rather
1769 than skip both boundaries. However, this code
1770 also stops anywhere in a non-sticky text-property,
1771 which breaks (e.g.) Org mode. */
1772 && (val
= get_pos_property (make_number (end
),
1774 TEXT_PROP_MEANS_INVISIBLE (val
))
1776 && !NILP (val
= get_char_property_and_overlay
1777 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1778 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1780 ellipsis
= ellipsis
|| inv
> 1
1781 || (OVERLAYP (overlay
)
1782 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1783 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1784 tmp
= Fnext_single_char_property_change
1785 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1786 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1790 && (val
= get_pos_property (make_number (beg
),
1792 TEXT_PROP_MEANS_INVISIBLE (val
))
1794 && !NILP (val
= get_char_property_and_overlay
1795 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1796 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1798 ellipsis
= ellipsis
|| inv
> 1
1799 || (OVERLAYP (overlay
)
1800 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1801 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1802 tmp
= Fprevious_single_char_property_change
1803 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1804 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1807 /* Move away from the inside area. */
1808 if (beg
< PT
&& end
> PT
)
1810 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1811 /* We haven't moved yet (so we don't need to fear
1812 infinite-looping) and we were outside the range
1813 before (so either end of the range still corresponds
1814 to a move in the right direction): pretend we moved
1815 less than we actually did, so that we still have
1816 more freedom below in choosing which end of the range
1818 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1819 /* We either have moved already or the last point
1820 was already in the range: we don't get to choose
1821 which end of the range we have to go to. */
1822 : (PT
< last_pt
? beg
: end
));
1823 check_composition
= check_display
= 1;
1825 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1826 the point to something other than its argument, due to
1827 point-motion hooks, intangibility, etc. */
1828 xassert (PT
== beg
|| PT
== end
);
1831 /* Pretend the area doesn't exist if the buffer is not
1833 if (!modified
&& !ellipsis
&& beg
< end
)
1835 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1836 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1837 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1838 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1839 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1840 /* We've already moved as far as we can. Trying to go
1841 to the other end would mean moving backwards and thus
1842 could lead to an infinite loop. */
1844 else if (val
= get_pos_property (make_number (PT
),
1846 TEXT_PROP_MEANS_INVISIBLE (val
)
1847 && (val
= get_pos_property
1848 (make_number (PT
== beg
? end
: beg
),
1850 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1851 (check_composition
= check_display
= 1,
1852 SET_PT (PT
== beg
? end
: beg
));
1855 check_invisible
= 0;
1859 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1862 safe_run_hooks_1 (void)
1864 eassert (CONSP (Vinhibit_quit
));
1865 return call0 (XCDR (Vinhibit_quit
));
1868 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1872 safe_run_hooks_error (Lisp_Object error_data
)
1875 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1876 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1877 Lisp_Object args
[4];
1878 args
[0] = build_string ("Error in %s (%s): %s");
1881 args
[3] = error_data
;
1887 Lisp_Object newval
= Qnil
;
1888 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1889 if (EQ (fun
, XCAR (val
)))
1892 newval
= Fcons (XCAR (val
), newval
);
1894 return Fset (hook
, Fnreverse (newval
));
1895 /* Not found in the local part of the hook. Let's look at the global
1898 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1899 : Fdefault_value (hook
));
1900 CONSP (val
); val
= XCDR (val
))
1901 if (EQ (fun
, XCAR (val
)))
1904 newval
= Fcons (XCAR (val
), newval
);
1906 return Fset_default (hook
, Fnreverse (newval
));
1912 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1914 eassert (nargs
== 1);
1915 if (CONSP (Vinhibit_quit
))
1916 XSETCDR (Vinhibit_quit
, args
[0]);
1918 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1920 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1924 /* If we get an error while running the hook, cause the hook variable
1925 to be nil. Also inhibit quits, so that C-g won't cause the hook
1926 to mysteriously evaporate. */
1929 safe_run_hooks (Lisp_Object hook
)
1931 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1932 to its body or to its handlers other than via globals such as
1933 dynamically-bound variables ;-) */
1934 ptrdiff_t count
= SPECPDL_INDEX ();
1935 specbind (Qinhibit_quit
, hook
);
1937 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1939 unbind_to (count
, Qnil
);
1943 /* Nonzero means polling for input is temporarily suppressed. */
1945 int poll_suppress_count
;
1947 /* Asynchronous timer for polling. */
1949 static struct atimer
*poll_timer
;
1952 #ifdef POLL_FOR_INPUT
1954 /* Poll for input, so that we catch a C-g if it comes in. This
1955 function is called from x_make_frame_visible, see comment
1959 poll_for_input_1 (void)
1961 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
1962 doing anything dangerous. */
1966 if (interrupt_input_blocked
== 0
1967 && !waiting_for_input
)
1968 read_avail_input (0);
1974 /* Timer callback function for poll_timer. TIMER is equal to
1978 poll_for_input (struct atimer
*timer
)
1980 if (poll_suppress_count
== 0)
1983 interrupt_input_pending
= 1;
1984 pending_signals
= 1;
1986 poll_for_input_1 ();
1991 #endif /* POLL_FOR_INPUT */
1993 /* Begin signals to poll for input, if they are appropriate.
1994 This function is called unconditionally from various places. */
1997 start_polling (void)
1999 #ifdef POLL_FOR_INPUT
2000 /* XXX This condition was (read_socket_hook && !interrupt_input),
2001 but read_socket_hook is not global anymore. Let's pretend that
2003 if (!interrupt_input
)
2005 /* Turn alarm handling on unconditionally. It might have
2006 been turned off in process.c. */
2007 turn_on_atimers (1);
2009 /* If poll timer doesn't exist, are we need one with
2010 a different interval, start a new one. */
2011 if (poll_timer
== NULL
2012 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2014 EMACS_TIME interval
;
2017 cancel_atimer (poll_timer
);
2019 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2020 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2021 poll_for_input
, NULL
);
2024 /* Let the timer's callback function poll for input
2025 if this becomes zero. */
2026 --poll_suppress_count
;
2031 /* Nonzero if we are using polling to handle input asynchronously. */
2034 input_polling_used (void)
2036 #ifdef POLL_FOR_INPUT
2037 /* XXX This condition was (read_socket_hook && !interrupt_input),
2038 but read_socket_hook is not global anymore. Let's pretend that
2040 return !interrupt_input
;
2046 /* Turn off polling. */
2051 #ifdef POLL_FOR_INPUT
2052 /* XXX This condition was (read_socket_hook && !interrupt_input),
2053 but read_socket_hook is not global anymore. Let's pretend that
2055 if (!interrupt_input
)
2056 ++poll_suppress_count
;
2060 /* Set the value of poll_suppress_count to COUNT
2061 and start or stop polling accordingly. */
2064 set_poll_suppress_count (int count
)
2066 #ifdef POLL_FOR_INPUT
2067 if (count
== 0 && poll_suppress_count
!= 0)
2069 poll_suppress_count
= 1;
2072 else if (count
!= 0 && poll_suppress_count
== 0)
2076 poll_suppress_count
= count
;
2080 /* Bind polling_period to a value at least N.
2081 But don't decrease it. */
2084 bind_polling_period (int n
)
2086 #ifdef POLL_FOR_INPUT
2087 int new = polling_period
;
2092 stop_other_atimers (poll_timer
);
2094 specbind (Qpolling_period
, make_number (new));
2095 /* Start a new alarm with the new period. */
2100 /* Apply the control modifier to CHARACTER. */
2103 make_ctrl_char (int c
)
2105 /* Save the upper bits here. */
2106 int upper
= c
& ~0177;
2108 if (! ASCII_BYTE_P (c
))
2109 return c
|= ctrl_modifier
;
2113 /* Everything in the columns containing the upper-case letters
2114 denotes a control character. */
2115 if (c
>= 0100 && c
< 0140)
2119 /* Set the shift modifier for a control char
2120 made from a shifted letter. But only for letters! */
2121 if (oc
>= 'A' && oc
<= 'Z')
2122 c
|= shift_modifier
;
2125 /* The lower-case letters denote control characters too. */
2126 else if (c
>= 'a' && c
<= 'z')
2129 /* Include the bits for control and shift
2130 only if the basic ASCII code can't indicate them. */
2134 /* Replace the high bits. */
2135 c
|= (upper
& ~ctrl_modifier
);
2140 /* Display the help-echo property of the character after the mouse pointer.
2141 Either show it in the echo area, or call show-help-function to display
2142 it by other means (maybe in a tooltip).
2144 If HELP is nil, that means clear the previous help echo.
2146 If HELP is a string, display that string. If HELP is a function,
2147 call it with OBJECT and POS as arguments; the function should
2148 return a help string or nil for none. For all other types of HELP,
2149 evaluate it to obtain a string.
2151 WINDOW is the window in which the help was generated, if any.
2152 It is nil if not in a window.
2154 If OBJECT is a buffer, POS is the position in the buffer where the
2155 `help-echo' text property was found.
2157 If OBJECT is an overlay, that overlay has a `help-echo' property,
2158 and POS is the position in the overlay's buffer under the mouse.
2160 If OBJECT is a string (an overlay string or a string displayed with
2161 the `display' property). POS is the position in that string under
2164 Note: this function may only be called with HELP nil or a string
2165 from X code running asynchronously. */
2168 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2171 if (!NILP (help
) && !STRINGP (help
))
2173 if (FUNCTIONP (help
))
2175 Lisp_Object args
[4];
2180 help
= safe_call (4, args
);
2183 help
= safe_eval (help
);
2185 if (!STRINGP (help
))
2189 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2190 if (!noninteractive
&& STRINGP (help
))
2192 /* The mouse-fixup-help-message Lisp function can call
2193 mouse_position_hook, which resets the mouse_moved flags.
2194 This causes trouble if we are trying to read a mouse motion
2195 event (i.e., if we are inside a `track-mouse' form), so we
2196 restore the mouse_moved flag. */
2197 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2198 help
= call1 (Qmouse_fixup_help_message
, help
);
2204 if (STRINGP (help
) || NILP (help
))
2206 if (!NILP (Vshow_help_function
))
2207 call1 (Vshow_help_function
, help
);
2208 help_echo_showing_p
= STRINGP (help
);
2214 /* Input of single characters from keyboard */
2216 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2217 struct timeval
*end_time
);
2218 static void record_char (Lisp_Object c
);
2220 static Lisp_Object help_form_saved_window_configs
;
2222 read_char_help_form_unwind (Lisp_Object arg
)
2224 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2225 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2226 if (!NILP (window_config
))
2227 Fset_window_configuration (window_config
);
2231 #define STOP_POLLING \
2232 do { if (! polling_stopped_here) stop_polling (); \
2233 polling_stopped_here = 1; } while (0)
2235 #define RESUME_POLLING \
2236 do { if (polling_stopped_here) start_polling (); \
2237 polling_stopped_here = 0; } while (0)
2239 /* read a character from the keyboard; call the redisplay if needed */
2240 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2241 -1 means do not do redisplay, but do do autosaving.
2244 /* The arguments MAPS and NMAPS are for menu prompting.
2245 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2247 PREV_EVENT is the previous input event, or nil if we are reading
2248 the first event of a key sequence (or not reading a key sequence).
2249 If PREV_EVENT is t, that is a "magic" value that says
2250 not to run input methods, but in other respects to act as if
2251 not reading a key sequence.
2253 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2254 if we used a mouse menu to read the input, or zero otherwise. If
2255 USED_MOUSE_MENU is null, we don't dereference it.
2257 Value is -2 when we find input on another keyboard. A second call
2258 to read_char will read it.
2260 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2261 specifying the maximum time to wait until. If no input arrives by
2262 that time, stop waiting and return nil.
2264 Value is t if we showed a menu and the user rejected it. */
2267 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2268 Lisp_Object prev_event
,
2269 int *used_mouse_menu
, struct timeval
*end_time
)
2271 volatile Lisp_Object c
;
2273 jmp_buf local_getcjmp
;
2275 volatile int key_already_recorded
= 0;
2276 Lisp_Object tem
, save
;
2277 volatile Lisp_Object previous_echo_area_message
;
2278 volatile Lisp_Object also_record
;
2279 volatile int reread
;
2280 struct gcpro gcpro1
, gcpro2
;
2281 int volatile polling_stopped_here
= 0;
2282 struct kboard
*orig_kboard
= current_kboard
;
2286 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2287 before_command_key_count
= this_command_key_count
;
2288 before_command_echo_length
= echo_length ();
2291 previous_echo_area_message
= Qnil
;
2293 GCPRO2 (c
, previous_echo_area_message
);
2298 if (CONSP (Vunread_post_input_method_events
))
2300 c
= XCAR (Vunread_post_input_method_events
);
2301 Vunread_post_input_method_events
2302 = XCDR (Vunread_post_input_method_events
);
2304 /* Undo what read_char_x_menu_prompt did when it unread
2305 additional keys returned by Fx_popup_menu. */
2307 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2315 if (unread_command_char
!= -1)
2317 XSETINT (c
, unread_command_char
);
2318 unread_command_char
= -1;
2324 if (CONSP (Vunread_command_events
))
2326 int was_disabled
= 0;
2328 c
= XCAR (Vunread_command_events
);
2329 Vunread_command_events
= XCDR (Vunread_command_events
);
2333 /* Undo what sit-for did when it unread additional keys
2334 inside universal-argument. */
2337 && EQ (XCAR (c
), Qt
))
2343 /* Undo what read_char_x_menu_prompt did when it unread
2344 additional keys returned by Fx_popup_menu. */
2346 && EQ (XCDR (c
), Qdisabled
)
2347 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2353 /* If the queued event is something that used the mouse,
2354 set used_mouse_menu accordingly. */
2356 /* Also check was_disabled so last-nonmenu-event won't return
2357 a bad value when submenus are involved. (Bug#447) */
2358 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2359 *used_mouse_menu
= 1;
2361 goto reread_for_input_method
;
2364 if (CONSP (Vunread_input_method_events
))
2366 c
= XCAR (Vunread_input_method_events
);
2367 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2369 /* Undo what read_char_x_menu_prompt did when it unread
2370 additional keys returned by Fx_popup_menu. */
2372 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2376 goto reread_for_input_method
;
2379 this_command_key_count_reset
= 0;
2381 if (!NILP (Vexecuting_kbd_macro
))
2383 /* We set this to Qmacro; since that's not a frame, nobody will
2384 try to switch frames on us, and the selected window will
2387 Since this event came from a macro, it would be misleading to
2388 leave internal_last_event_frame set to wherever the last
2389 real event came from. Normally, a switch-frame event selects
2390 internal_last_event_frame after each command is read, but
2391 events read from a macro should never cause a new frame to be
2393 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2395 /* Exit the macro if we are at the end.
2396 Also, some things replace the macro with t
2397 to force an early exit. */
2398 if (EQ (Vexecuting_kbd_macro
, Qt
)
2399 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2405 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2406 if (STRINGP (Vexecuting_kbd_macro
)
2407 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2408 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2410 executing_kbd_macro_index
++;
2415 if (!NILP (unread_switch_frame
))
2417 c
= unread_switch_frame
;
2418 unread_switch_frame
= Qnil
;
2420 /* This event should make it into this_command_keys, and get echoed
2421 again, so we do not set `reread'. */
2425 /* if redisplay was requested */
2426 if (commandflag
>= 0)
2428 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2430 /* If there is pending input, process any events which are not
2431 user-visible, such as X selection_request events. */
2433 || detect_input_pending_run_timers (0))
2434 swallow_events (0); /* may clear input_pending */
2436 /* Redisplay if no pending input. */
2437 while (!input_pending
)
2439 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2440 redisplay_preserve_echo_area (5);
2445 /* Normal case: no input arrived during redisplay. */
2448 /* Input arrived and pre-empted redisplay.
2449 Process any events which are not user-visible. */
2451 /* If that cleared input_pending, try again to redisplay. */
2454 /* Prevent the redisplay we just did
2455 from messing up echoing of the input after the prompt. */
2456 if (commandflag
== 0 && echo_current
)
2457 echo_message_buffer
= echo_area_buffer
[0];
2461 /* Message turns off echoing unless more keystrokes turn it on again.
2463 The code in 20.x for the condition was
2465 1. echo_area_glyphs && *echo_area_glyphs
2466 2. && echo_area_glyphs != current_kboard->echobuf
2467 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2469 (1) means there's a current message displayed
2471 (2) means it's not the message from echoing from the current
2474 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2475 is set to a non-null value. This is done in read_char and it is
2476 set to echo_area_glyphs after a call to echo_char. That means
2477 ok_to_echo_at_next_pause is either null or
2478 current_kboard->echobuf with the appropriate current_kboard at
2481 So, condition (3) means in clear text ok_to_echo_at_next_pause
2482 must be either null, or the current message isn't from echoing at
2483 all, or it's from echoing from a different kboard than the
2486 if (/* There currently is something in the echo area. */
2487 !NILP (echo_area_buffer
[0])
2488 && (/* And it's either not from echoing. */
2489 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2490 /* Or it's an echo from a different kboard. */
2491 || echo_kboard
!= current_kboard
2492 /* Or we explicitly allow overwriting whatever there is. */
2493 || ok_to_echo_at_next_pause
== NULL
))
2498 /* Try reading a character via menu prompting in the minibuf.
2499 Try this before the sit-for, because the sit-for
2500 would do the wrong thing if we are supposed to do
2501 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2502 after a mouse event so don't try a minibuf menu. */
2504 if (nmaps
> 0 && INTERACTIVE
2505 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2506 /* Don't bring up a menu if we already have another event. */
2507 && NILP (Vunread_command_events
)
2508 && unread_command_char
< 0
2509 && !detect_input_pending_run_timers (0))
2511 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2513 if (INTEGERP (c
) && XINT (c
) == -2)
2514 return c
; /* wrong_kboard_jmpbuf */
2518 key_already_recorded
= 1;
2523 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2524 We will do that below, temporarily for short sections of code,
2525 when appropriate. local_getcjmp must be in effect
2526 around any call to sit_for or kbd_buffer_get_event;
2527 it *must not* be in effect when we call redisplay. */
2529 jmpcount
= SPECPDL_INDEX ();
2530 if (_setjmp (local_getcjmp
))
2532 /* Handle quits while reading the keyboard. */
2533 /* We must have saved the outer value of getcjmp here,
2534 so restore it now. */
2535 restore_getcjmp (save_jump
);
2536 unbind_to (jmpcount
, Qnil
);
2537 XSETINT (c
, quit_char
);
2538 internal_last_event_frame
= selected_frame
;
2539 Vlast_event_frame
= internal_last_event_frame
;
2540 /* If we report the quit char as an event,
2541 don't do so more than once. */
2542 if (!NILP (Vinhibit_quit
))
2546 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2547 if (kb
!= current_kboard
)
2549 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2550 /* We shouldn't get here if we were in single-kboard mode! */
2555 while (CONSP (XCDR (last
)))
2557 if (!NILP (XCDR (last
)))
2561 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2563 XSETCDR (last
, Fcons (c
, Qnil
));
2564 kb
->kbd_queue_has_data
= 1;
2565 current_kboard
= kb
;
2566 /* This is going to exit from read_char
2567 so we had better get rid of this frame's stuff. */
2569 return make_number (-2); /* wrong_kboard_jmpbuf */
2575 /* Start idle timers if no time limit is supplied. We don't do it
2576 if a time limit is supplied to avoid an infinite recursion in the
2577 situation where an idle timer calls `sit-for'. */
2580 timer_start_idle ();
2582 /* If in middle of key sequence and minibuffer not active,
2583 start echoing if enough time elapses. */
2585 if (minibuf_level
== 0
2587 && !current_kboard
->immediate_echo
2588 && this_command_key_count
> 0
2590 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2591 && NILP (Fzerop (Vecho_keystrokes
))
2592 && (/* No message. */
2593 NILP (echo_area_buffer
[0])
2594 /* Or empty message. */
2595 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2596 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2597 /* Or already echoing from same kboard. */
2598 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2599 /* Or not echoing before and echoing allowed. */
2600 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2602 /* After a mouse event, start echoing right away.
2603 This is because we are probably about to display a menu,
2604 and we don't want to delay before doing so. */
2605 if (EVENT_HAS_PARAMETERS (prev_event
))
2611 save_getcjmp (save_jump
);
2612 restore_getcjmp (local_getcjmp
);
2613 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2614 restore_getcjmp (save_jump
);
2616 && ! CONSP (Vunread_command_events
))
2621 /* Maybe auto save due to number of keystrokes. */
2623 if (commandflag
!= 0
2624 && auto_save_interval
> 0
2625 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2626 && !detect_input_pending_run_timers (0))
2628 Fdo_auto_save (Qnil
, Qnil
);
2629 /* Hooks can actually change some buffers in auto save. */
2633 /* Try reading using an X menu.
2634 This is never confused with reading using the minibuf
2635 because the recursive call of read_char in read_char_minibuf_menu_prompt
2636 does not pass on any keymaps. */
2638 if (nmaps
> 0 && INTERACTIVE
2639 && !NILP (prev_event
)
2640 && EVENT_HAS_PARAMETERS (prev_event
)
2641 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2642 && !EQ (XCAR (prev_event
), Qtool_bar
)
2643 /* Don't bring up a menu if we already have another event. */
2644 && NILP (Vunread_command_events
)
2645 && unread_command_char
< 0)
2647 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2649 /* Now that we have read an event, Emacs is not idle. */
2656 /* Maybe autosave and/or garbage collect due to idleness. */
2658 if (INTERACTIVE
&& NILP (c
))
2661 ptrdiff_t buffer_size
;
2663 /* Slow down auto saves logarithmically in size of current buffer,
2664 and garbage collect while we're at it. */
2665 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2666 last_non_minibuf_size
= Z
- BEG
;
2667 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2669 while (buffer_size
> 64)
2670 delay_level
++, buffer_size
-= buffer_size
>> 2;
2671 if (delay_level
< 4) delay_level
= 4;
2672 /* delay_level is 4 for files under around 50k, 7 at 100k,
2673 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2675 /* Auto save if enough time goes by without input. */
2676 if (commandflag
!= 0
2677 && num_nonmacro_input_events
> last_auto_save
2678 && INTEGERP (Vauto_save_timeout
)
2679 && XINT (Vauto_save_timeout
) > 0)
2682 EMACS_INT timeout
= (delay_level
2683 * min (XFASTINT (Vauto_save_timeout
) / 4,
2684 MOST_POSITIVE_FIXNUM
/ delay_level
));
2685 save_getcjmp (save_jump
);
2686 restore_getcjmp (local_getcjmp
);
2687 tem0
= sit_for (make_number (timeout
), 1, 1);
2688 restore_getcjmp (save_jump
);
2691 && ! CONSP (Vunread_command_events
))
2693 Fdo_auto_save (Qnil
, Qnil
);
2695 /* If we have auto-saved and there is still no input
2696 available, garbage collect if there has been enough
2697 consing going on to make it worthwhile. */
2698 if (!detect_input_pending_run_timers (0)
2699 && consing_since_gc
> gc_cons_threshold
/ 2)
2700 Fgarbage_collect ();
2707 /* Notify the caller if an autosave hook, or a timer, sentinel or
2708 filter in the sit_for calls above have changed the current
2709 kboard. This could happen if they use the minibuffer or start a
2710 recursive edit, like the fancy splash screen in server.el's
2711 filter. If this longjmp wasn't here, read_key_sequence would
2712 interpret the next key sequence using the wrong translation
2713 tables and function keymaps. */
2714 if (NILP (c
) && current_kboard
!= orig_kboard
)
2717 return make_number (-2); /* wrong_kboard_jmpbuf */
2720 /* If this has become non-nil here, it has been set by a timer
2721 or sentinel or filter. */
2722 if (CONSP (Vunread_command_events
))
2724 c
= XCAR (Vunread_command_events
);
2725 Vunread_command_events
= XCDR (Vunread_command_events
);
2728 /* Read something from current KBOARD's side queue, if possible. */
2732 if (current_kboard
->kbd_queue_has_data
)
2734 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2736 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2737 KVAR (current_kboard
, kbd_queue
)
2738 = XCDR (KVAR (current_kboard
, kbd_queue
));
2739 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2740 current_kboard
->kbd_queue_has_data
= 0;
2741 input_pending
= readable_events (0);
2742 if (EVENT_HAS_PARAMETERS (c
)
2743 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2744 internal_last_event_frame
= XCAR (XCDR (c
));
2745 Vlast_event_frame
= internal_last_event_frame
;
2749 /* If current_kboard's side queue is empty check the other kboards.
2750 If one of them has data that we have not yet seen here,
2751 switch to it and process the data waiting for it.
2753 Note: if the events queued up for another kboard
2754 have already been seen here, and therefore are not a complete command,
2755 the kbd_queue_has_data field is 0, so we skip that kboard here.
2756 That's to avoid an infinite loop switching between kboards here. */
2757 if (NILP (c
) && !single_kboard
)
2760 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2761 if (kb
->kbd_queue_has_data
)
2763 current_kboard
= kb
;
2764 /* This is going to exit from read_char
2765 so we had better get rid of this frame's stuff. */
2767 return make_number (-2); /* wrong_kboard_jmpbuf */
2775 /* Finally, we read from the main queue,
2776 and if that gives us something we can't use yet, we put it on the
2777 appropriate side queue and try again. */
2781 KBOARD
*kb
IF_LINT (= NULL
);
2786 EMACS_GET_TIME (now
);
2787 if (EMACS_TIME_GE (now
, *end_time
))
2791 /* Actually read a character, waiting if necessary. */
2792 save_getcjmp (save_jump
);
2793 restore_getcjmp (local_getcjmp
);
2795 timer_start_idle ();
2796 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2797 restore_getcjmp (save_jump
);
2799 if (! NILP (c
) && (kb
!= current_kboard
))
2801 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2804 while (CONSP (XCDR (last
)))
2806 if (!NILP (XCDR (last
)))
2810 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2812 XSETCDR (last
, Fcons (c
, Qnil
));
2813 kb
->kbd_queue_has_data
= 1;
2817 current_kboard
= kb
;
2818 /* This is going to exit from read_char
2819 so we had better get rid of this frame's stuff. */
2821 return make_number (-2);
2825 /* Terminate Emacs in batch mode if at eof. */
2826 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2827 Fkill_emacs (make_number (1));
2831 /* Add in any extra modifiers, where appropriate. */
2832 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2833 || ((extra_keyboard_modifiers
& 0177) < ' '
2834 && (extra_keyboard_modifiers
& 0177) != 0))
2835 XSETINT (c
, make_ctrl_char (XINT (c
)));
2837 /* Transfer any other modifier bits directly from
2838 extra_keyboard_modifiers to c. Ignore the actual character code
2839 in the low 16 bits of extra_keyboard_modifiers. */
2840 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2851 if (commandflag
>= 0
2852 && !input_pending
&& !detect_input_pending_run_timers (0))
2860 /* Buffer switch events are only for internal wakeups
2861 so don't show them to the user.
2862 Also, don't record a key if we already did. */
2863 if (BUFFERP (c
) || key_already_recorded
)
2866 /* Process special events within read_char
2867 and loop around to read another event. */
2870 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2875 struct buffer
*prev_buffer
= current_buffer
;
2876 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2877 int was_locked
= single_kboard
;
2878 ptrdiff_t count
= SPECPDL_INDEX ();
2879 record_single_kboard_state ();
2882 last_input_event
= c
;
2883 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2885 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2886 /* We stopped being idle for this event; undo that. This
2887 prevents automatic window selection (under
2888 mouse_autoselect_window from acting as a real input event, for
2889 example banishing the mouse under mouse-avoidance-mode. */
2890 timer_resume_idle ();
2892 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2893 /* Resume allowing input from any kboard, if that was true before. */
2895 any_kboard_state ();
2896 unbind_to (count
, Qnil
);
2899 if (current_buffer
!= prev_buffer
)
2901 /* The command may have changed the keymaps. Pretend there
2902 is input in another keyboard and return. This will
2903 recalculate keymaps. */
2904 c
= make_number (-2);
2911 /* Handle things that only apply to characters. */
2914 /* If kbd_buffer_get_event gave us an EOF, return that. */
2918 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2919 && UNSIGNED_CMP (XFASTINT (c
), <,
2920 SCHARS (KVAR (current_kboard
,
2921 Vkeyboard_translate_table
))))
2922 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2923 && UNSIGNED_CMP (XFASTINT (c
), <,
2924 ASIZE (KVAR (current_kboard
,
2925 Vkeyboard_translate_table
))))
2926 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2930 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2931 /* nil in keyboard-translate-table means no translation. */
2937 /* If this event is a mouse click in the menu bar,
2938 return just menu-bar for now. Modify the mouse click event
2939 so we won't do this twice, then queue it up. */
2940 if (EVENT_HAS_PARAMETERS (c
)
2942 && CONSP (EVENT_START (c
))
2943 && CONSP (XCDR (EVENT_START (c
))))
2947 posn
= POSN_POSN (EVENT_START (c
));
2948 /* Handle menu-bar events:
2949 insert the dummy prefix event `menu-bar'. */
2950 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2952 /* Change menu-bar to (menu-bar) as the event "position". */
2953 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2956 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2961 /* Store these characters into recent_keys, the dribble file if any,
2962 and the keyboard macro being defined, if any. */
2964 if (! NILP (also_record
))
2965 record_char (also_record
);
2967 /* Wipe the echo area.
2968 But first, if we are about to use an input method,
2969 save the echo area contents for it to refer to. */
2971 && ! NILP (Vinput_method_function
)
2972 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2974 previous_echo_area_message
= Fcurrent_message ();
2975 Vinput_method_previous_message
= previous_echo_area_message
;
2978 /* Now wipe the echo area, except for help events which do their
2979 own stuff with the echo area. */
2981 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2982 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2984 if (!NILP (echo_area_buffer
[0]))
2985 safe_run_hooks (Qecho_area_clear_hook
);
2986 clear_message (1, 0);
2989 reread_for_input_method
:
2991 /* Pass this to the input method, if appropriate. */
2993 && ! NILP (Vinput_method_function
)
2994 /* Don't run the input method within a key sequence,
2995 after the first event of the key sequence. */
2996 && NILP (prev_event
)
2997 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3000 ptrdiff_t key_count
;
3001 int key_count_reset
;
3002 struct gcpro gcpro1
;
3003 ptrdiff_t count
= SPECPDL_INDEX ();
3005 /* Save the echo status. */
3006 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3007 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3008 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3009 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3012 if (before_command_restore_flag
)
3014 this_command_key_count
= before_command_key_count_1
;
3015 if (this_command_key_count
< this_single_command_key_start
)
3016 this_single_command_key_start
= this_command_key_count
;
3017 echo_truncate (before_command_echo_length_1
);
3018 before_command_restore_flag
= 0;
3022 /* Save the this_command_keys status. */
3023 key_count
= this_command_key_count
;
3024 key_count_reset
= this_command_key_count_reset
;
3027 keys
= Fcopy_sequence (this_command_keys
);
3032 /* Clear out this_command_keys. */
3033 this_command_key_count
= 0;
3034 this_command_key_count_reset
= 0;
3036 /* Now wipe the echo area. */
3037 if (!NILP (echo_area_buffer
[0]))
3038 safe_run_hooks (Qecho_area_clear_hook
);
3039 clear_message (1, 0);
3042 /* If we are not reading a key sequence,
3043 never use the echo area. */
3046 specbind (Qinput_method_use_echo_area
, Qt
);
3049 /* Call the input method. */
3050 tem
= call1 (Vinput_method_function
, c
);
3052 tem
= unbind_to (count
, tem
);
3054 /* Restore the saved echoing state
3055 and this_command_keys state. */
3056 this_command_key_count
= key_count
;
3057 this_command_key_count_reset
= key_count_reset
;
3059 this_command_keys
= keys
;
3062 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3063 KVAR (current_kboard
, echo_string
) = saved_echo_string
;
3064 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3065 if (saved_immediate_echo
)
3070 /* The input method can return no events. */
3073 /* Bring back the previous message, if any. */
3074 if (! NILP (previous_echo_area_message
))
3075 message_with_string ("%s", previous_echo_area_message
, 0);
3078 /* It returned one event or more. */
3080 Vunread_post_input_method_events
3081 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3086 /* Display help if not echoing. */
3087 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3089 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3090 Lisp_Object help
, object
, position
, window
, htem
;
3092 htem
= Fcdr (XCDR (c
));
3095 window
= Fcar (htem
);
3097 object
= Fcar (htem
);
3099 position
= Fcar (htem
);
3101 show_help_echo (help
, window
, object
, position
);
3103 /* We stopped being idle for this event; undo that. */
3105 timer_resume_idle ();
3109 if ((! reread
|| this_command_key_count
== 0
3110 || this_command_key_count_reset
)
3114 /* Don't echo mouse motion events. */
3115 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3116 && NILP (Fzerop (Vecho_keystrokes
))
3117 && ! (EVENT_HAS_PARAMETERS (c
)
3118 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3121 if (! NILP (also_record
))
3122 echo_char (also_record
);
3123 /* Once we reread a character, echoing can happen
3124 the next time we pause to read a new one. */
3125 ok_to_echo_at_next_pause
= current_kboard
;
3128 /* Record this character as part of the current key. */
3129 add_command_key (c
);
3130 if (! NILP (also_record
))
3131 add_command_key (also_record
);
3134 last_input_event
= c
;
3137 /* Process the help character specially if enabled */
3138 if (!NILP (Vhelp_form
) && help_char_p (c
))
3140 ptrdiff_t count
= SPECPDL_INDEX ();
3142 help_form_saved_window_configs
3143 = Fcons (Fcurrent_window_configuration (Qnil
),
3144 help_form_saved_window_configs
);
3145 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3146 call0 (Qhelp_form_show
);
3151 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3152 if (EVENT_HAS_PARAMETERS (c
)
3153 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3154 XSETCAR (help_form_saved_window_configs
, Qnil
);
3156 while (BUFFERP (c
));
3157 /* Remove the help from the frame */
3158 unbind_to (count
, Qnil
);
3161 if (EQ (c
, make_number (040)))
3165 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3166 while (BUFFERP (c
));
3175 /* Record a key that came from a mouse menu.
3176 Record it for echoing, for this-command-keys, and so on. */
3179 record_menu_key (Lisp_Object c
)
3181 /* Wipe the echo area. */
3182 clear_message (1, 0);
3187 before_command_key_count
= this_command_key_count
;
3188 before_command_echo_length
= echo_length ();
3191 /* Don't echo mouse motion events. */
3192 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3193 && NILP (Fzerop (Vecho_keystrokes
)))
3197 /* Once we reread a character, echoing can happen
3198 the next time we pause to read a new one. */
3199 ok_to_echo_at_next_pause
= 0;
3202 /* Record this character as part of the current key. */
3203 add_command_key (c
);
3205 /* Re-reading in the middle of a command */
3206 last_input_event
= c
;
3210 /* Return 1 if should recognize C as "the help character". */
3213 help_char_p (Lisp_Object c
)
3217 if (EQ (c
, Vhelp_char
))
3219 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3220 if (EQ (c
, XCAR (tail
)))
3225 /* Record the input event C in various ways. */
3228 record_char (Lisp_Object c
)
3232 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3234 /* To avoid filling recent_keys with help-echo and mouse-movement
3235 events, we filter out repeated help-echo events, only store the
3236 first and last in a series of mouse-movement events, and don't
3237 store repeated help-echo events which are only separated by
3238 mouse-movement events. */
3240 Lisp_Object ev1
, ev2
, ev3
;
3243 if ((ix1
= recent_keys_index
- 1) < 0)
3244 ix1
= NUM_RECENT_KEYS
- 1;
3245 ev1
= AREF (recent_keys
, ix1
);
3247 if ((ix2
= ix1
- 1) < 0)
3248 ix2
= NUM_RECENT_KEYS
- 1;
3249 ev2
= AREF (recent_keys
, ix2
);
3251 if ((ix3
= ix2
- 1) < 0)
3252 ix3
= NUM_RECENT_KEYS
- 1;
3253 ev3
= AREF (recent_keys
, ix3
);
3255 if (EQ (XCAR (c
), Qhelp_echo
))
3257 /* Don't record `help-echo' in recent_keys unless it shows some help
3258 message, and a different help than the previously recorded
3260 Lisp_Object help
, last_help
;
3262 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3263 if (!STRINGP (help
))
3265 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3266 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3268 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3269 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3270 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3272 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3273 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3274 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3275 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3278 else if (EQ (XCAR (c
), Qmouse_movement
))
3280 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3281 So additional mouse movement events replace the last element. */
3282 Lisp_Object last_window
, window
;
3284 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3285 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3286 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3287 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3288 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3290 ASET (recent_keys
, ix1
, c
);
3296 store_kbd_macro_char (c
);
3300 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3301 ASET (recent_keys
, recent_keys_index
, c
);
3302 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3303 recent_keys_index
= 0;
3305 else if (recorded
< 0)
3307 /* We need to remove one or two events from recent_keys.
3308 To do this, we simply put nil at those events and move the
3309 recent_keys_index backwards over those events. Usually,
3310 users will never see those nil events, as they will be
3311 overwritten by the command keys entered to see recent_keys
3314 while (recorded
++ < 0 && total_keys
> 0)
3316 if (total_keys
< NUM_RECENT_KEYS
)
3318 if (--recent_keys_index
< 0)
3319 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3320 ASET (recent_keys
, recent_keys_index
, Qnil
);
3324 num_nonmacro_input_events
++;
3326 /* Write c to the dribble file. If c is a lispy event, write
3327 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3328 If you, dear reader, have a better idea, you've got the source. :-) */
3334 if (XUINT (c
) < 0x100)
3335 putc (XUINT (c
), dribble
);
3337 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3341 Lisp_Object dribblee
;
3343 /* If it's a structured event, take the event header. */
3344 dribblee
= EVENT_HEAD (c
);
3346 if (SYMBOLP (dribblee
))
3348 putc ('<', dribble
);
3349 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3350 SBYTES (SYMBOL_NAME (dribblee
)),
3352 putc ('>', dribble
);
3361 /* Copy out or in the info on where C-g should throw to.
3362 This is used when running Lisp code from within get_char,
3363 in case get_char is called recursively.
3364 See read_process_output. */
3367 save_getcjmp (jmp_buf temp
)
3369 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3373 restore_getcjmp (jmp_buf temp
)
3375 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3378 /* Low level keyboard/mouse input.
3379 kbd_buffer_store_event places events in kbd_buffer, and
3380 kbd_buffer_get_event retrieves them. */
3382 /* Return true if there are any events in the queue that read-char
3383 would return. If this returns false, a read-char would block. */
3385 readable_events (int flags
)
3387 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3390 /* If the buffer contains only FOCUS_IN_EVENT events, and
3391 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3392 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3394 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3395 #ifdef USE_TOOLKIT_SCROLL_BARS
3396 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3400 struct input_event
*event
;
3402 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3409 #ifdef USE_TOOLKIT_SCROLL_BARS
3410 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3412 event
->kind
== FOCUS_IN_EVENT
)
3413 #ifdef USE_TOOLKIT_SCROLL_BARS
3414 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3415 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3416 && event
->part
== scroll_bar_handle
3417 && event
->modifiers
== 0)
3422 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3425 while (event
!= kbd_store_ptr
);
3431 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3432 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3433 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3438 if (current_kboard
->kbd_queue_has_data
)
3444 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3445 if (kb
->kbd_queue_has_data
)
3451 /* Set this for debugging, to have a way to get out */
3452 int stop_character EXTERNALLY_VISIBLE
;
3455 event_to_kboard (struct input_event
*event
)
3458 frame
= event
->frame_or_window
;
3460 frame
= XCAR (frame
);
3461 else if (WINDOWP (frame
))
3462 frame
= WINDOW_FRAME (XWINDOW (frame
));
3464 /* There are still some events that don't set this field.
3465 For now, just ignore the problem.
3466 Also ignore dead frames here. */
3467 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3470 return FRAME_KBOARD (XFRAME (frame
));
3474 /* Return the number of slots occupied in kbd_buffer. */
3477 kbd_buffer_nr_stored (void)
3479 return kbd_fetch_ptr
== kbd_store_ptr
3481 : (kbd_fetch_ptr
< kbd_store_ptr
3482 ? kbd_store_ptr
- kbd_fetch_ptr
3483 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3484 + (kbd_store_ptr
- kbd_buffer
)));
3486 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3489 kbd_buffer_store_event (register struct input_event
*event
)
3491 kbd_buffer_store_event_hold (event
, 0);
3494 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3496 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3497 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3498 Else, if EVENT is a quit event, store the quit event
3499 in HOLD_QUIT, and return (thus ignoring further events).
3501 This is used in read_avail_input to postpone the processing
3502 of the quit event until all subsequent input events have been
3503 parsed (and discarded).
3507 kbd_buffer_store_event_hold (register struct input_event
*event
,
3508 struct input_event
*hold_quit
)
3510 if (event
->kind
== NO_EVENT
)
3513 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3516 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3518 register int c
= event
->code
& 0377;
3520 if (event
->modifiers
& ctrl_modifier
)
3521 c
= make_ctrl_char (c
);
3523 c
|= (event
->modifiers
3524 & (meta_modifier
| alt_modifier
3525 | hyper_modifier
| super_modifier
));
3529 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3530 struct input_event
*sp
;
3532 if (single_kboard
&& kb
!= current_kboard
)
3534 KVAR (kb
, kbd_queue
)
3535 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3536 Fcons (make_number (c
), Qnil
));
3537 kb
->kbd_queue_has_data
= 1;
3538 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3540 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3543 if (event_to_kboard (sp
) == kb
)
3545 sp
->kind
= NO_EVENT
;
3546 sp
->frame_or_window
= Qnil
;
3555 memcpy (hold_quit
, event
, sizeof (*event
));
3559 /* If this results in a quit_char being returned to Emacs as
3560 input, set Vlast_event_frame properly. If this doesn't
3561 get returned to Emacs as an event, the next event read
3562 will set Vlast_event_frame again, so this is safe to do. */
3566 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3568 focus
= event
->frame_or_window
;
3569 internal_last_event_frame
= focus
;
3570 Vlast_event_frame
= focus
;
3573 last_event_timestamp
= event
->timestamp
;
3574 handle_interrupt ();
3578 if (c
&& c
== stop_character
)
3584 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3585 Just ignore the second one. */
3586 else if (event
->kind
== BUFFER_SWITCH_EVENT
3587 && kbd_fetch_ptr
!= kbd_store_ptr
3588 && ((kbd_store_ptr
== kbd_buffer
3589 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3590 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3593 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3594 kbd_store_ptr
= kbd_buffer
;
3596 /* Don't let the very last slot in the buffer become full,
3597 since that would make the two pointers equal,
3598 and that is indistinguishable from an empty buffer.
3599 Discard the event if it would fill the last slot. */
3600 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3602 *kbd_store_ptr
= *event
;
3605 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3607 /* Don't read keyboard input until we have processed kbd_buffer.
3608 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3609 hold_keyboard_input ();
3611 if (!noninteractive
)
3612 signal (SIGIO
, SIG_IGN
);
3616 #endif /* subprocesses */
3619 /* If we're inside while-no-input, and this event qualifies
3620 as input, set quit-flag to cause an interrupt. */
3621 if (!NILP (Vthrow_on_input
)
3622 && event
->kind
!= FOCUS_IN_EVENT
3623 && event
->kind
!= HELP_EVENT
3624 && event
->kind
!= DEICONIFY_EVENT
)
3626 Vquit_flag
= Vthrow_on_input
;
3627 /* If we're inside a function that wants immediate quits,
3629 if (immediate_quit
&& NILP (Vinhibit_quit
))
3639 /* Put an input event back in the head of the event queue. */
3642 kbd_buffer_unget_event (register struct input_event
*event
)
3644 if (kbd_fetch_ptr
== kbd_buffer
)
3645 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3647 /* Don't let the very last slot in the buffer become full, */
3648 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3651 *kbd_fetch_ptr
= *event
;
3656 /* Generate a HELP_EVENT input_event and store it in the keyboard
3659 HELP is the help form.
3661 FRAME and WINDOW are the frame and window where the help is
3662 generated. OBJECT is the Lisp object where the help was found (a
3663 buffer, a string, an overlay, or nil if neither from a string nor
3664 from a buffer). POS is the position within OBJECT where the help
3668 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3669 Lisp_Object object
, ptrdiff_t pos
)
3671 struct input_event event
;
3675 event
.kind
= HELP_EVENT
;
3676 event
.frame_or_window
= frame
;
3678 event
.x
= WINDOWP (window
) ? window
: frame
;
3681 kbd_buffer_store_event (&event
);
3685 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3688 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3690 struct input_event event
;
3692 event
.kind
= HELP_EVENT
;
3693 event
.frame_or_window
= frame
;
3698 kbd_buffer_store_event (&event
);
3702 /* Discard any mouse events in the event buffer by setting them to
3705 discard_mouse_events (void)
3707 struct input_event
*sp
;
3708 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3710 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3713 if (sp
->kind
== MOUSE_CLICK_EVENT
3714 || sp
->kind
== WHEEL_EVENT
3715 || sp
->kind
== HORIZ_WHEEL_EVENT
3717 || sp
->kind
== GPM_CLICK_EVENT
3719 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3721 sp
->kind
= NO_EVENT
;
3727 /* Return non-zero if there are any real events waiting in the event
3728 buffer, not counting `NO_EVENT's.
3730 If DISCARD is non-zero, discard NO_EVENT events at the front of
3731 the input queue, possibly leaving the input queue empty if there
3732 are no real input events. */
3735 kbd_buffer_events_waiting (int discard
)
3737 struct input_event
*sp
;
3739 for (sp
= kbd_fetch_ptr
;
3740 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3743 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3750 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3754 /* Clear input event EVENT. */
3757 clear_event (struct input_event
*event
)
3759 event
->kind
= NO_EVENT
;
3763 /* Read one event from the event buffer, waiting if necessary.
3764 The value is a Lisp object representing the event.
3765 The value is nil for an event that should be ignored,
3766 or that was handled here.
3767 We always read and discard one event. */
3770 kbd_buffer_get_event (KBOARD
**kbp
,
3771 int *used_mouse_menu
,
3772 struct timeval
*end_time
)
3778 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3780 /* Start reading input again, we have processed enough so we can
3781 accept new events again. */
3782 unhold_keyboard_input ();
3784 if (!noninteractive
)
3785 signal (SIGIO
, input_available_signal
);
3789 #endif /* subprocesses */
3792 /* In case we are running as a daemon, only do this before
3793 detaching from the terminal. */
3794 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3798 *kbp
= current_kboard
;
3802 /* Wait until there is input available. */
3805 /* Break loop if there's an unread command event. Needed in
3806 moused window autoselection which uses a timer to insert such
3808 if (CONSP (Vunread_command_events
))
3811 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3813 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3814 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3818 /* If the quit flag is set, then read_char will return
3819 quit_char, so that counts as "available input." */
3820 if (!NILP (Vquit_flag
))
3821 quit_throw_to_read_char (0);
3823 /* One way or another, wait until input is available; then, if
3824 interrupt handlers have not read it, read it now. */
3826 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3830 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3832 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3833 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3838 EMACS_TIME duration
;
3839 EMACS_GET_TIME (duration
);
3840 if (EMACS_TIME_GE (duration
, *end_time
))
3841 return Qnil
; /* finished waiting */
3844 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3845 wait_reading_process_output (EMACS_SECS (duration
),
3846 EMACS_USECS (duration
),
3847 -1, 1, Qnil
, NULL
, 0);
3851 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3853 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3854 /* Pass 1 for EXPECT since we just waited to have input. */
3855 read_avail_input (1);
3858 if (CONSP (Vunread_command_events
))
3861 first
= XCAR (Vunread_command_events
);
3862 Vunread_command_events
= XCDR (Vunread_command_events
);
3863 *kbp
= current_kboard
;
3867 /* At this point, we know that there is a readable event available
3868 somewhere. If the event queue is empty, then there must be a
3869 mouse movement enabled and available. */
3870 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3872 struct input_event
*event
;
3874 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3878 last_event_timestamp
= event
->timestamp
;
3880 *kbp
= event_to_kboard (event
);
3882 *kbp
= current_kboard
; /* Better than returning null ptr? */
3886 /* These two kinds of events get special handling
3887 and don't actually appear to the command loop.
3888 We return nil for them. */
3889 if (event
->kind
== SELECTION_REQUEST_EVENT
3890 || event
->kind
== SELECTION_CLEAR_EVENT
)
3893 struct input_event copy
;
3895 /* Remove it from the buffer before processing it,
3896 since otherwise swallow_events will see it
3897 and process it again. */
3899 kbd_fetch_ptr
= event
+ 1;
3900 input_pending
= readable_events (0);
3901 x_handle_selection_event (©
);
3903 /* We're getting selection request events, but we don't have
3909 #if defined (HAVE_NS)
3910 else if (event
->kind
== NS_TEXT_EVENT
)
3912 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3913 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3915 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3916 kbd_fetch_ptr
= event
+ 1;
3917 if (used_mouse_menu
)
3918 *used_mouse_menu
= 1;
3922 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3923 || defined (HAVE_NS)
3924 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3926 /* Make an event (delete-frame (FRAME)). */
3927 obj
= Fcons (event
->frame_or_window
, Qnil
);
3928 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3929 kbd_fetch_ptr
= event
+ 1;
3932 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3933 || defined (HAVE_NS)
3934 else if (event
->kind
== ICONIFY_EVENT
)
3936 /* Make an event (iconify-frame (FRAME)). */
3937 obj
= Fcons (event
->frame_or_window
, Qnil
);
3938 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3939 kbd_fetch_ptr
= event
+ 1;
3941 else if (event
->kind
== DEICONIFY_EVENT
)
3943 /* Make an event (make-frame-visible (FRAME)). */
3944 obj
= Fcons (event
->frame_or_window
, Qnil
);
3945 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3946 kbd_fetch_ptr
= event
+ 1;
3949 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3951 /* The value doesn't matter here; only the type is tested. */
3952 XSETBUFFER (obj
, current_buffer
);
3953 kbd_fetch_ptr
= event
+ 1;
3955 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3956 || defined (HAVE_NS) || defined (USE_GTK)
3957 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3959 kbd_fetch_ptr
= event
+ 1;
3960 input_pending
= readable_events (0);
3961 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3962 x_activate_menubar (XFRAME (event
->frame_or_window
));
3965 #if defined (WINDOWSNT)
3966 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3968 /* Make an event (language-change (FRAME CHARSET LCID)). */
3969 obj
= Fcons (event
->frame_or_window
, Qnil
);
3970 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3971 kbd_fetch_ptr
= event
+ 1;
3974 else if (event
->kind
== SAVE_SESSION_EVENT
)
3976 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3977 kbd_fetch_ptr
= event
+ 1;
3979 /* Just discard these, by returning nil.
3980 With MULTI_KBOARD, these events are used as placeholders
3981 when we need to randomly delete events from the queue.
3982 (They shouldn't otherwise be found in the buffer,
3983 but on some machines it appears they do show up
3984 even without MULTI_KBOARD.) */
3985 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3986 mouse events during a popup-menu call. */
3987 else if (event
->kind
== NO_EVENT
)
3988 kbd_fetch_ptr
= event
+ 1;
3989 else if (event
->kind
== HELP_EVENT
)
3991 Lisp_Object object
, position
, help
, frame
, window
;
3993 frame
= event
->frame_or_window
;
3994 object
= event
->arg
;
3995 position
= make_number (event
->code
);
3998 clear_event (event
);
4000 kbd_fetch_ptr
= event
+ 1;
4001 if (!WINDOWP (window
))
4003 obj
= Fcons (Qhelp_echo
,
4004 list5 (frame
, help
, window
, object
, position
));
4006 else if (event
->kind
== FOCUS_IN_EVENT
)
4008 /* Notification of a FocusIn event. The frame receiving the
4009 focus is in event->frame_or_window. Generate a
4010 switch-frame event if necessary. */
4011 Lisp_Object frame
, focus
;
4013 frame
= event
->frame_or_window
;
4014 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4018 if (!EQ (frame
, internal_last_event_frame
)
4019 && !EQ (frame
, selected_frame
))
4020 obj
= make_lispy_switch_frame (frame
);
4021 internal_last_event_frame
= frame
;
4022 kbd_fetch_ptr
= event
+ 1;
4025 else if (event
->kind
== DBUS_EVENT
)
4027 obj
= make_lispy_event (event
);
4028 kbd_fetch_ptr
= event
+ 1;
4031 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4033 obj
= make_lispy_event (event
);
4034 kbd_fetch_ptr
= event
+ 1;
4038 /* If this event is on a different frame, return a switch-frame this
4039 time, and leave the event in the queue for next time. */
4043 frame
= event
->frame_or_window
;
4045 frame
= XCAR (frame
);
4046 else if (WINDOWP (frame
))
4047 frame
= WINDOW_FRAME (XWINDOW (frame
));
4049 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4053 if (! EQ (frame
, internal_last_event_frame
)
4054 && !EQ (frame
, selected_frame
))
4055 obj
= make_lispy_switch_frame (frame
);
4056 internal_last_event_frame
= frame
;
4058 /* If we didn't decide to make a switch-frame event, go ahead
4059 and build a real event from the queue entry. */
4063 obj
= make_lispy_event (event
);
4065 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4066 || defined (HAVE_NS) || defined (USE_GTK)
4067 /* If this was a menu selection, then set the flag to inhibit
4068 writing to last_nonmenu_event. Don't do this if the event
4069 we're returning is (menu-bar), though; that indicates the
4070 beginning of the menu sequence, and we might as well leave
4071 that as the `event with parameters' for this selection. */
4073 && !EQ (event
->frame_or_window
, event
->arg
)
4074 && (event
->kind
== MENU_BAR_EVENT
4075 || event
->kind
== TOOL_BAR_EVENT
))
4076 *used_mouse_menu
= 1;
4079 /* certain system events are non-key events */
4081 && event
->kind
== NS_NONKEY_EVENT
)
4082 *used_mouse_menu
= 1;
4085 /* Wipe out this event, to catch bugs. */
4086 clear_event (event
);
4087 kbd_fetch_ptr
= event
+ 1;
4091 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4092 /* Try generating a mouse motion event. */
4093 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4095 FRAME_PTR f
= some_mouse_moved ();
4096 Lisp_Object bar_window
;
4097 enum scroll_bar_part part
;
4101 *kbp
= current_kboard
;
4102 /* Note that this uses F to determine which terminal to look at.
4103 If there is no valid info, it does not store anything
4104 so x remains nil. */
4107 /* XXX Can f or mouse_position_hook be NULL here? */
4108 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4109 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4114 /* Decide if we should generate a switch-frame event. Don't
4115 generate switch-frame events for motion outside of all Emacs
4121 frame
= FRAME_FOCUS_FRAME (f
);
4123 XSETFRAME (frame
, f
);
4125 if (! EQ (frame
, internal_last_event_frame
)
4126 && !EQ (frame
, selected_frame
))
4127 obj
= make_lispy_switch_frame (frame
);
4128 internal_last_event_frame
= frame
;
4131 /* If we didn't decide to make a switch-frame event, go ahead and
4132 return a mouse-motion event. */
4133 if (!NILP (x
) && NILP (obj
))
4134 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4136 #endif /* HAVE_MOUSE || HAVE GPM */
4138 /* We were promised by the above while loop that there was
4139 something for us to read! */
4142 input_pending
= readable_events (0);
4144 Vlast_event_frame
= internal_last_event_frame
;
4149 /* Process any non-user-visible events (currently X selection events),
4150 without reading any user-visible events. */
4153 process_special_events (void)
4155 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4157 struct input_event
*event
;
4159 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4163 last_event_timestamp
= event
->timestamp
;
4165 /* These two kinds of events get special handling
4166 and don't actually appear to the command loop. */
4167 if (event
->kind
== SELECTION_REQUEST_EVENT
4168 || event
->kind
== SELECTION_CLEAR_EVENT
)
4171 struct input_event copy
;
4173 /* Remove it from the buffer before processing it,
4174 since otherwise swallow_events called recursively could see it
4175 and process it again. */
4177 kbd_fetch_ptr
= event
+ 1;
4178 input_pending
= readable_events (0);
4179 x_handle_selection_event (©
);
4181 /* We're getting selection request events, but we don't have
4191 /* Process any events that are not user-visible, run timer events that
4192 are ripe, and return, without reading any user-visible events. */
4195 swallow_events (int do_display
)
4199 process_special_events ();
4201 old_timers_run
= timers_run
;
4202 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4204 if (timers_run
!= old_timers_run
&& do_display
)
4205 redisplay_preserve_echo_area (7);
4208 /* Record the start of when Emacs is idle,
4209 for the sake of running idle-time timers. */
4212 timer_start_idle (void)
4216 /* If we are already in the idle state, do nothing. */
4217 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4220 EMACS_GET_TIME (timer_idleness_start_time
);
4222 timer_last_idleness_start_time
= timer_idleness_start_time
;
4224 /* Mark all idle-time timers as once again candidates for running. */
4225 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4229 timer
= XCAR (timers
);
4231 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4233 XVECTOR (timer
)->contents
[0] = Qnil
;
4237 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4240 timer_stop_idle (void)
4242 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4245 /* Resume idle timer from last idle start time. */
4248 timer_resume_idle (void)
4250 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4253 timer_idleness_start_time
= timer_last_idleness_start_time
;
4256 /* This is only for debugging. */
4257 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4259 /* List of elisp functions to call, delayed because they were generated in
4260 a context where Elisp could not be safely run (e.g. redisplay, signal,
4261 ...). Each element has the form (FUN . ARGS). */
4262 Lisp_Object pending_funcalls
;
4264 /* Check whether a timer has fired. To prevent larger problems we simply
4265 disregard elements that are not proper timers. Do not make a circular
4266 timer list for the time being.
4268 Returns the time to wait until the next timer fires. If a
4269 timer is triggering now, return zero.
4270 If no timer is active, return -1.
4272 If a timer is ripe, we run it, with quitting turned off.
4273 In that case we return 0 to indicate that a new timer_check_2 call
4277 timer_check_2 (void)
4279 EMACS_TIME nexttime
;
4281 EMACS_TIME idleness_now
IF_LINT (= {0});
4282 Lisp_Object timers
, idle_timers
, chosen_timer
;
4283 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4285 EMACS_SET_SECS (nexttime
, -1);
4286 EMACS_SET_USECS (nexttime
, -1);
4288 /* Always consider the ordinary timers. */
4289 timers
= Vtimer_list
;
4290 /* Consider the idle timers only if Emacs is idle. */
4291 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4292 idle_timers
= Vtimer_idle_list
;
4295 chosen_timer
= Qnil
;
4296 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4298 /* First run the code that was delayed. */
4299 while (CONSP (pending_funcalls
))
4301 Lisp_Object funcall
= XCAR (pending_funcalls
);
4302 pending_funcalls
= XCDR (pending_funcalls
);
4303 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4306 if (CONSP (timers
) || CONSP (idle_timers
))
4308 EMACS_GET_TIME (now
);
4309 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4310 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4313 while (CONSP (timers
) || CONSP (idle_timers
))
4315 Lisp_Object
*vector
;
4316 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4317 EMACS_TIME timer_time
, idle_timer_time
;
4318 EMACS_TIME difference
;
4319 EMACS_TIME timer_difference
IF_LINT (= {0});
4320 EMACS_TIME idle_timer_difference
IF_LINT (= {0});
4322 /* Skip past invalid timers and timers already handled. */
4325 timer
= XCAR (timers
);
4326 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4328 timers
= XCDR (timers
);
4331 vector
= XVECTOR (timer
)->contents
;
4333 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4334 || !INTEGERP (vector
[3])
4335 || ! NILP (vector
[0]))
4337 timers
= XCDR (timers
);
4341 if (CONSP (idle_timers
))
4343 timer
= XCAR (idle_timers
);
4344 if (!VECTORP (timer
) || ASIZE (timer
) != 8)
4346 idle_timers
= XCDR (idle_timers
);
4349 vector
= XVECTOR (timer
)->contents
;
4351 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4352 || !INTEGERP (vector
[3])
4353 || ! NILP (vector
[0]))
4355 idle_timers
= XCDR (idle_timers
);
4360 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4361 based on the next ordinary timer.
4362 TIMER_DIFFERENCE is the distance in time from NOW to when
4363 this timer becomes ripe (negative if it's already ripe). */
4366 timer
= XCAR (timers
);
4367 vector
= XVECTOR (timer
)->contents
;
4368 EMACS_SET_SECS (timer_time
,
4369 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4370 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4371 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4374 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4375 based on the next idle timer. */
4376 if (CONSP (idle_timers
))
4378 idle_timer
= XCAR (idle_timers
);
4379 vector
= XVECTOR (idle_timer
)->contents
;
4380 EMACS_SET_SECS (idle_timer_time
,
4381 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4382 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4383 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4386 /* Decide which timer is the next timer,
4387 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4388 Also step down the list where we found that timer. */
4390 if (CONSP (timers
) && CONSP (idle_timers
))
4393 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4394 if (EMACS_TIME_NEG_P (temp
))
4396 chosen_timer
= timer
;
4397 timers
= XCDR (timers
);
4398 difference
= timer_difference
;
4402 chosen_timer
= idle_timer
;
4403 idle_timers
= XCDR (idle_timers
);
4404 difference
= idle_timer_difference
;
4407 else if (CONSP (timers
))
4409 chosen_timer
= timer
;
4410 timers
= XCDR (timers
);
4411 difference
= timer_difference
;
4415 chosen_timer
= idle_timer
;
4416 idle_timers
= XCDR (idle_timers
);
4417 difference
= idle_timer_difference
;
4419 vector
= XVECTOR (chosen_timer
)->contents
;
4421 /* If timer is ripe, run it if it hasn't been run. */
4422 if (EMACS_TIME_NEG_P (difference
)
4423 || (EMACS_SECS (difference
) == 0
4424 && EMACS_USECS (difference
) == 0))
4426 if (NILP (vector
[0]))
4428 ptrdiff_t count
= SPECPDL_INDEX ();
4429 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4431 /* Mark the timer as triggered to prevent problems if the lisp
4432 code fails to reschedule it right. */
4435 specbind (Qinhibit_quit
, Qt
);
4437 call1 (Qtimer_event_handler
, chosen_timer
);
4438 Vdeactivate_mark
= old_deactivate_mark
;
4440 unbind_to (count
, Qnil
);
4442 /* Since we have handled the event,
4443 we don't need to tell the caller to wake up and do it. */
4444 /* But the caller must still wait for the next timer, so
4445 return 0 to indicate that. */
4448 EMACS_SET_SECS (nexttime
, 0);
4449 EMACS_SET_USECS (nexttime
, 0);
4452 /* When we encounter a timer that is still waiting,
4453 return the amount of time to wait before it is ripe. */
4460 /* No timers are pending in the future. */
4461 /* Return 0 if we generated an event, and -1 if not. */
4467 /* Check whether a timer has fired. To prevent larger problems we simply
4468 disregard elements that are not proper timers. Do not make a circular
4469 timer list for the time being.
4471 Returns the time to wait until the next timer fires.
4472 If no timer is active, return -1.
4474 As long as any timer is ripe, we run it. */
4479 EMACS_TIME nexttime
;
4483 nexttime
= timer_check_2 ();
4485 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4490 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4491 doc
: /* Return the current length of Emacs idleness, or nil.
4492 The value when Emacs is idle is a list of three integers. The first has
4493 the most significant 16 bits of the seconds, while the second has the least
4494 significant 16 bits. The third integer gives the microsecond count.
4496 The value when Emacs is not idle is nil.
4498 The microsecond count is zero on systems that do not provide
4499 resolution finer than a second. */)
4502 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4504 EMACS_TIME now
, idleness_now
;
4506 EMACS_GET_TIME (now
);
4507 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4509 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4510 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4511 make_number (EMACS_USECS (idleness_now
)));
4517 /* Caches for modify_event_symbol. */
4518 static Lisp_Object accent_key_syms
;
4519 static Lisp_Object func_key_syms
;
4520 static Lisp_Object mouse_syms
;
4521 static Lisp_Object wheel_syms
;
4522 static Lisp_Object drag_n_drop_syms
;
4524 /* This is a list of keysym codes for special "accent" characters.
4525 It parallels lispy_accent_keys. */
4527 static const int lispy_accent_codes
[] =
4529 #ifdef XK_dead_circumflex
4534 #ifdef XK_dead_grave
4539 #ifdef XK_dead_tilde
4544 #ifdef XK_dead_diaeresis
4549 #ifdef XK_dead_macron
4554 #ifdef XK_dead_degree
4559 #ifdef XK_dead_acute
4564 #ifdef XK_dead_cedilla
4569 #ifdef XK_dead_breve
4574 #ifdef XK_dead_ogonek
4579 #ifdef XK_dead_caron
4584 #ifdef XK_dead_doubleacute
4585 XK_dead_doubleacute
,
4589 #ifdef XK_dead_abovedot
4594 #ifdef XK_dead_abovering
4604 #ifdef XK_dead_belowdot
4609 #ifdef XK_dead_voiced_sound
4610 XK_dead_voiced_sound
,
4614 #ifdef XK_dead_semivoiced_sound
4615 XK_dead_semivoiced_sound
,
4631 /* This is a list of Lisp names for special "accent" characters.
4632 It parallels lispy_accent_codes. */
4634 static const char *const lispy_accent_keys
[] =
4652 "dead-voiced-sound",
4653 "dead-semivoiced-sound",
4659 #define FUNCTION_KEY_OFFSET 0x0
4661 const char *const lispy_function_keys
[] =
4665 0, /* VK_LBUTTON 0x01 */
4666 0, /* VK_RBUTTON 0x02 */
4667 "cancel", /* VK_CANCEL 0x03 */
4668 0, /* VK_MBUTTON 0x04 */
4670 0, 0, 0, /* 0x05 .. 0x07 */
4672 "backspace", /* VK_BACK 0x08 */
4673 "tab", /* VK_TAB 0x09 */
4675 0, 0, /* 0x0A .. 0x0B */
4677 "clear", /* VK_CLEAR 0x0C */
4678 "return", /* VK_RETURN 0x0D */
4680 0, 0, /* 0x0E .. 0x0F */
4682 0, /* VK_SHIFT 0x10 */
4683 0, /* VK_CONTROL 0x11 */
4684 0, /* VK_MENU 0x12 */
4685 "pause", /* VK_PAUSE 0x13 */
4686 "capslock", /* VK_CAPITAL 0x14 */
4687 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4689 "junja", /* VK_JUNJA 0x17 */
4690 "final", /* VK_FINAL 0x18 */
4691 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4693 "escape", /* VK_ESCAPE 0x1B */
4694 "convert", /* VK_CONVERT 0x1C */
4695 "non-convert", /* VK_NONCONVERT 0x1D */
4696 "accept", /* VK_ACCEPT 0x1E */
4697 "mode-change", /* VK_MODECHANGE 0x1F */
4698 0, /* VK_SPACE 0x20 */
4699 "prior", /* VK_PRIOR 0x21 */
4700 "next", /* VK_NEXT 0x22 */
4701 "end", /* VK_END 0x23 */
4702 "home", /* VK_HOME 0x24 */
4703 "left", /* VK_LEFT 0x25 */
4704 "up", /* VK_UP 0x26 */
4705 "right", /* VK_RIGHT 0x27 */
4706 "down", /* VK_DOWN 0x28 */
4707 "select", /* VK_SELECT 0x29 */
4708 "print", /* VK_PRINT 0x2A */
4709 "execute", /* VK_EXECUTE 0x2B */
4710 "snapshot", /* VK_SNAPSHOT 0x2C */
4711 "insert", /* VK_INSERT 0x2D */
4712 "delete", /* VK_DELETE 0x2E */
4713 "help", /* VK_HELP 0x2F */
4715 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4717 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4719 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4721 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4723 0, 0, 0, 0, 0, 0, 0, 0, 0,
4724 0, 0, 0, 0, 0, 0, 0, 0, 0,
4725 0, 0, 0, 0, 0, 0, 0, 0,
4727 "lwindow", /* VK_LWIN 0x5B */
4728 "rwindow", /* VK_RWIN 0x5C */
4729 "apps", /* VK_APPS 0x5D */
4732 "kp-0", /* VK_NUMPAD0 0x60 */
4733 "kp-1", /* VK_NUMPAD1 0x61 */
4734 "kp-2", /* VK_NUMPAD2 0x62 */
4735 "kp-3", /* VK_NUMPAD3 0x63 */
4736 "kp-4", /* VK_NUMPAD4 0x64 */
4737 "kp-5", /* VK_NUMPAD5 0x65 */
4738 "kp-6", /* VK_NUMPAD6 0x66 */
4739 "kp-7", /* VK_NUMPAD7 0x67 */
4740 "kp-8", /* VK_NUMPAD8 0x68 */
4741 "kp-9", /* VK_NUMPAD9 0x69 */
4742 "kp-multiply", /* VK_MULTIPLY 0x6A */
4743 "kp-add", /* VK_ADD 0x6B */
4744 "kp-separator", /* VK_SEPARATOR 0x6C */
4745 "kp-subtract", /* VK_SUBTRACT 0x6D */
4746 "kp-decimal", /* VK_DECIMAL 0x6E */
4747 "kp-divide", /* VK_DIVIDE 0x6F */
4748 "f1", /* VK_F1 0x70 */
4749 "f2", /* VK_F2 0x71 */
4750 "f3", /* VK_F3 0x72 */
4751 "f4", /* VK_F4 0x73 */
4752 "f5", /* VK_F5 0x74 */
4753 "f6", /* VK_F6 0x75 */
4754 "f7", /* VK_F7 0x76 */
4755 "f8", /* VK_F8 0x77 */
4756 "f9", /* VK_F9 0x78 */
4757 "f10", /* VK_F10 0x79 */
4758 "f11", /* VK_F11 0x7A */
4759 "f12", /* VK_F12 0x7B */
4760 "f13", /* VK_F13 0x7C */
4761 "f14", /* VK_F14 0x7D */
4762 "f15", /* VK_F15 0x7E */
4763 "f16", /* VK_F16 0x7F */
4764 "f17", /* VK_F17 0x80 */
4765 "f18", /* VK_F18 0x81 */
4766 "f19", /* VK_F19 0x82 */
4767 "f20", /* VK_F20 0x83 */
4768 "f21", /* VK_F21 0x84 */
4769 "f22", /* VK_F22 0x85 */
4770 "f23", /* VK_F23 0x86 */
4771 "f24", /* VK_F24 0x87 */
4773 0, 0, 0, 0, /* 0x88 .. 0x8B */
4774 0, 0, 0, 0, /* 0x8C .. 0x8F */
4776 "kp-numlock", /* VK_NUMLOCK 0x90 */
4777 "scroll", /* VK_SCROLL 0x91 */
4778 /* Not sure where the following block comes from.
4779 Windows headers have NEC and Fujitsu specific keys in
4780 this block, but nothing generic. */
4781 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4782 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4783 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4784 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4785 "kp-end", /* VK_NUMPAD_END 0x96 */
4786 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4787 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4788 "kp-up", /* VK_NUMPAD_UP 0x99 */
4789 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4790 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4791 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4792 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4794 0, 0, /* 0x9E .. 0x9F */
4797 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4798 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4799 * No other API or message will distinguish left and right keys this way.
4804 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4805 to enable them selectively, and gives access to a few more functions.
4806 See lispy_multimedia_keys below. */
4807 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4808 0, 0, 0, /* 0xAD .. 0xAF Volume */
4809 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4810 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4812 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4813 0, 0, 0, 0, 0, 0, 0, 0, 0,
4815 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4816 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4817 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4820 "ax", /* VK_OEM_AX 0xE1 */
4821 0, /* VK_OEM_102 0xE2 */
4822 "ico-help", /* VK_ICO_HELP 0xE3 */
4823 "ico-00", /* VK_ICO_00 0xE4 */
4824 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4825 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4826 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4828 "reset", /* VK_OEM_RESET 0xE9 */
4829 "jump", /* VK_OEM_JUMP 0xEA */
4830 "oem-pa1", /* VK_OEM_PA1 0xEB */
4831 "oem-pa2", /* VK_OEM_PA2 0xEC */
4832 "oem-pa3", /* VK_OEM_PA3 0xED */
4833 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4834 "cusel", /* VK_OEM_CUSEL 0xEF */
4835 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4836 "finish", /* VK_OEM_FINISH 0xF1 */
4837 "copy", /* VK_OEM_COPY 0xF2 */
4838 "auto", /* VK_OEM_AUTO 0xF3 */
4839 "enlw", /* VK_OEM_ENLW 0xF4 */
4840 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4841 "attn", /* VK_ATTN 0xF6 */
4842 "crsel", /* VK_CRSEL 0xF7 */
4843 "exsel", /* VK_EXSEL 0xF8 */
4844 "ereof", /* VK_EREOF 0xF9 */
4845 "play", /* VK_PLAY 0xFA */
4846 "zoom", /* VK_ZOOM 0xFB */
4847 "noname", /* VK_NONAME 0xFC */
4848 "pa1", /* VK_PA1 0xFD */
4849 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4853 /* Some of these duplicate the "Media keys" on newer keyboards,
4854 but they are delivered to the application in a different way. */
4855 static const char *const lispy_multimedia_keys
[] =
4863 "browser-favorites",
4900 "toggle-dictate-command",
4906 "media-fast-forward",
4909 "media-channel-down"
4912 #else /* not HAVE_NTGUI */
4914 /* This should be dealt with in XTread_socket now, and that doesn't
4915 depend on the client system having the Kana syms defined. See also
4916 the XK_kana_A case below. */
4919 static const char *const lispy_kana_keys
[] =
4921 /* X Keysym value */
4922 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4923 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4924 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4925 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4926 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4927 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4928 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4929 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4930 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4931 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4932 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4933 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4934 "kana-i", "kana-u", "kana-e", "kana-o",
4935 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4936 "prolongedsound", "kana-A", "kana-I", "kana-U",
4937 "kana-E", "kana-O", "kana-KA", "kana-KI",
4938 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4939 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4940 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4941 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4942 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4943 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4944 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4945 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4946 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4947 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4948 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4949 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4951 #endif /* XK_kana_A */
4954 #define FUNCTION_KEY_OFFSET 0xff00
4956 /* You'll notice that this table is arranged to be conveniently
4957 indexed by X Windows keysym values. */
4958 static const char *const lispy_function_keys
[] =
4960 /* X Keysym value */
4962 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4963 "backspace", "tab", "linefeed", "clear",
4965 0, 0, 0, "pause", /* 0xff10...1f */
4966 0, 0, 0, 0, 0, 0, 0, "escape",
4968 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4969 "romaji", "hiragana", "katakana", "hiragana-katakana",
4970 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4971 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4972 "eisu-toggle", /* 0xff30...3f */
4973 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4974 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4976 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4977 "down", "prior", "next", "end",
4978 "begin", 0, 0, 0, 0, 0, 0, 0,
4979 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4990 "break", /* 0xff6b */
4993 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4994 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4995 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4996 0, 0, 0, 0, 0, 0, 0, 0,
4997 "kp-tab", /* 0xff89 */
4999 "kp-enter", /* 0xff8d */
5001 "kp-f1", /* 0xff91 */
5005 "kp-home", /* 0xff95 */
5010 "kp-prior", /* kp-page-up */
5011 "kp-next", /* kp-page-down */
5017 0, 0, 0, 0, 0, 0, 0, 0, 0,
5018 "kp-multiply", /* 0xffaa */
5023 "kp-divide", /* 0xffaf */
5024 "kp-0", /* 0xffb0 */
5025 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5028 "kp-equal", /* 0xffbd */
5029 "f1", /* 0xffbe */ /* IsFunctionKey */
5031 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5032 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5033 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5034 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5035 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5036 0, 0, 0, 0, 0, 0, 0, 0,
5037 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5038 0, 0, 0, 0, 0, 0, 0, "delete"
5041 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5042 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5044 static const char *const iso_lispy_function_keys
[] =
5046 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5047 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5048 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5049 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5050 "iso-lefttab", /* 0xfe20 */
5051 "iso-move-line-up", "iso-move-line-down",
5052 "iso-partial-line-up", "iso-partial-line-down",
5053 "iso-partial-space-left", "iso-partial-space-right",
5054 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5055 "iso-release-margin-left", "iso-release-margin-right",
5056 "iso-release-both-margins",
5057 "iso-fast-cursor-left", "iso-fast-cursor-right",
5058 "iso-fast-cursor-up", "iso-fast-cursor-down",
5059 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5060 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5063 #endif /* not HAVE_NTGUI */
5065 static Lisp_Object Vlispy_mouse_stem
;
5067 static const char *const lispy_wheel_names
[] =
5069 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5072 /* drag-n-drop events are generated when a set of selected files are
5073 dragged from another application and dropped onto an Emacs window. */
5074 static const char *const lispy_drag_n_drop_names
[] =
5079 /* Scroll bar parts. */
5080 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5081 Lisp_Object Qup
, Qdown
, Qbottom
;
5082 static Lisp_Object Qend_scroll
;
5084 static Lisp_Object Qratio
;
5086 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5087 static Lisp_Object
*const scroll_bar_parts
[] = {
5088 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5089 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5092 /* A vector, indexed by button number, giving the down-going location
5093 of currently depressed buttons, both scroll bar and non-scroll bar.
5095 The elements have the form
5096 (BUTTON-NUMBER MODIFIER-MASK . REST)
5097 where REST is the cdr of a position as it would be reported in the event.
5099 The make_lispy_event function stores positions here to tell the
5100 difference between click and drag events, and to store the starting
5101 location to be included in drag events. */
5103 static Lisp_Object button_down_location
;
5105 /* Information about the most recent up-going button event: Which
5106 button, what location, and what time. */
5108 static int last_mouse_button
;
5109 static int last_mouse_x
;
5110 static int last_mouse_y
;
5111 static Time button_down_time
;
5113 /* The number of clicks in this multiple-click. */
5115 static int double_click_count
;
5117 /* X and Y are frame-relative coordinates for a click or wheel event.
5118 Return a Lisp-style event list. */
5121 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5124 enum window_part part
;
5125 Lisp_Object posn
= Qnil
;
5126 Lisp_Object extra_info
= Qnil
;
5127 /* Coordinate pixel positions to return. */
5128 int xret
= 0, yret
= 0;
5129 /* The window under frame pixel coordinates (x,y) */
5130 Lisp_Object window
= f
5131 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5134 if (WINDOWP (window
))
5136 /* It's a click in window window at frame coordinates (x,y) */
5137 struct window
*w
= XWINDOW (window
);
5138 Lisp_Object string_info
= Qnil
;
5139 ptrdiff_t textpos
= -1;
5140 int col
= -1, row
= -1;
5141 int dx
= -1, dy
= -1;
5142 int width
= -1, height
= -1;
5143 Lisp_Object object
= Qnil
;
5145 /* Pixel coordinates relative to the window corner. */
5146 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5147 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5149 /* For text area clicks, return X, Y relative to the corner of
5150 this text area. Note that dX, dY etc are set below, by
5151 buffer_posn_from_coords. */
5152 if (part
== ON_TEXT
)
5154 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5155 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5157 /* For mode line and header line clicks, return X, Y relative to
5158 the left window edge. Use mode_line_string to look for a
5159 string on the click position. */
5160 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5165 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5166 /* Note that mode_line_string takes COL, ROW as pixels and
5167 converts them to characters. */
5170 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5171 &object
, &dx
, &dy
, &width
, &height
);
5172 if (STRINGP (string
))
5173 string_info
= Fcons (string
, make_number (charpos
));
5174 textpos
= (w
== XWINDOW (selected_window
)
5175 && current_buffer
== XBUFFER (w
->buffer
))
5176 ? PT
: XMARKER (w
->pointm
)->charpos
;
5181 /* For fringes and margins, Y is relative to the area's (and the
5182 window's) top edge, while X is meaningless. */
5183 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5188 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5191 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5192 &object
, &dx
, &dy
, &width
, &height
);
5193 if (STRINGP (string
))
5194 string_info
= Fcons (string
, make_number (charpos
));
5195 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5197 else if (part
== ON_LEFT_FRINGE
)
5199 posn
= Qleft_fringe
;
5202 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5203 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5204 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5206 else if (part
== ON_RIGHT_FRINGE
)
5208 posn
= Qright_fringe
;
5211 - window_box_width (w
, LEFT_MARGIN_AREA
)
5212 - window_box_width (w
, TEXT_AREA
)
5213 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5214 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5216 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5218 else if (part
== ON_VERTICAL_BORDER
)
5220 posn
= Qvertical_line
;
5225 /* Nothing special for part == ON_SCROLL_BAR. */
5227 /* For clicks in the text area, fringes, or margins, call
5228 buffer_posn_from_coords to extract TEXTPOS, the buffer
5229 position nearest to the click. */
5232 Lisp_Object string2
, object2
= Qnil
;
5233 struct display_pos p
;
5235 int width2
, height2
;
5236 /* The pixel X coordinate passed to buffer_posn_from_coords
5237 is the X coordinate relative to the text area for
5238 text-area and right-margin clicks, zero otherwise. */
5240 = (part
== ON_TEXT
) ? xret
5241 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5242 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5246 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5247 &object2
, &dx2
, &dy2
,
5249 textpos
= CHARPOS (p
.pos
);
5250 if (col
< 0) col
= x2
;
5251 if (row
< 0) row
= y2
;
5252 if (dx
< 0) dx
= dx2
;
5253 if (dy
< 0) dy
= dy2
;
5254 if (width
< 0) width
= width2
;
5255 if (height
< 0) height
= height2
;
5259 posn
= make_number (textpos
);
5260 if (STRINGP (string2
))
5261 string_info
= Fcons (string2
,
5262 make_number (CHARPOS (p
.string_pos
)));
5268 #ifdef HAVE_WINDOW_SYSTEM
5269 if (IMAGEP (object
))
5271 Lisp_Object image_map
, hotspot
;
5272 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5274 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5276 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5277 posn
= XCAR (hotspot
);
5284 Fcons (make_number (dx
), make_number (dy
)),
5285 Fcons (make_number (width
), make_number (height
)));
5288 extra_info
= Fcons (string_info
,
5289 Fcons (make_number (textpos
),
5290 Fcons (Fcons (make_number (col
),
5295 XSETFRAME (window
, f
);
5299 return Fcons (window
,
5301 Fcons (Fcons (make_number (xret
),
5302 make_number (yret
)),
5303 Fcons (make_number (t
),
5307 /* Given a struct input_event, build the lisp event which represents
5308 it. If EVENT is 0, build a mouse movement event from the mouse
5309 movement buffer, which should have a movement event in it.
5311 Note that events must be passed to this function in the order they
5312 are received; this function stores the location of button presses
5313 in order to build drag events when the button is released. */
5316 make_lispy_event (struct input_event
*event
)
5320 switch (SWITCH_ENUM_CAST (event
->kind
))
5322 /* A simple keystroke. */
5323 case ASCII_KEYSTROKE_EVENT
:
5324 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5326 Lisp_Object lispy_c
;
5327 EMACS_INT c
= event
->code
;
5328 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5331 eassert (c
== event
->code
);
5332 /* Turn ASCII characters into control characters
5334 if (event
->modifiers
& ctrl_modifier
)
5336 c
= make_ctrl_char (c
);
5337 event
->modifiers
&= ~ctrl_modifier
;
5341 /* Add in the other modifier bits. The shift key was taken care
5342 of by the X code. */
5343 c
|= (event
->modifiers
5344 & (meta_modifier
| alt_modifier
5345 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5346 /* Distinguish Shift-SPC from SPC. */
5347 if ((event
->code
) == 040
5348 && event
->modifiers
& shift_modifier
)
5349 c
|= shift_modifier
;
5350 button_down_time
= 0;
5351 XSETFASTINT (lispy_c
, c
);
5356 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5357 except that they are non-key events (last-nonmenu-event is nil). */
5358 case NS_NONKEY_EVENT
:
5361 /* A function key. The symbol may need to have modifier prefixes
5363 case NON_ASCII_KEYSTROKE_EVENT
:
5364 button_down_time
= 0;
5366 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5367 if (event
->code
== lispy_accent_codes
[i
])
5368 return modify_event_symbol (i
,
5370 Qfunction_key
, Qnil
,
5371 lispy_accent_keys
, &accent_key_syms
,
5372 (sizeof (lispy_accent_keys
)
5373 / sizeof (lispy_accent_keys
[0])));
5377 if (event
->code
>= 0x400 && event
->code
< 0x500)
5378 return modify_event_symbol (event
->code
- 0x400,
5379 event
->modifiers
& ~shift_modifier
,
5380 Qfunction_key
, Qnil
,
5381 lispy_kana_keys
, &func_key_syms
,
5382 (sizeof (lispy_kana_keys
)
5383 / sizeof (lispy_kana_keys
[0])));
5384 #endif /* XK_kana_A */
5387 #ifdef ISO_FUNCTION_KEY_OFFSET
5388 if (event
->code
< FUNCTION_KEY_OFFSET
5389 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5390 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5392 Qfunction_key
, Qnil
,
5393 iso_lispy_function_keys
, &func_key_syms
,
5394 (sizeof (iso_lispy_function_keys
)
5395 / sizeof (iso_lispy_function_keys
[0])));
5398 /* Handle system-specific or unknown keysyms. */
5399 if (event
->code
& (1 << 28)
5400 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5401 || (event
->code
- FUNCTION_KEY_OFFSET
5402 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5403 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5405 /* We need to use an alist rather than a vector as the cache
5406 since we can't make a vector long enough. */
5407 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5408 KVAR (current_kboard
, system_key_syms
) = Fcons (Qnil
, Qnil
);
5409 return modify_event_symbol (event
->code
,
5412 KVAR (current_kboard
, Vsystem_key_alist
),
5413 0, &KVAR (current_kboard
, system_key_syms
),
5417 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5419 Qfunction_key
, Qnil
,
5420 lispy_function_keys
, &func_key_syms
,
5421 (sizeof (lispy_function_keys
)
5422 / sizeof (lispy_function_keys
[0])));
5425 case MULTIMEDIA_KEY_EVENT
:
5426 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5427 / sizeof (lispy_multimedia_keys
[0]))
5428 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5430 return modify_event_symbol (event
->code
, event
->modifiers
,
5431 Qfunction_key
, Qnil
,
5432 lispy_multimedia_keys
, &func_key_syms
,
5433 (sizeof (lispy_multimedia_keys
)
5434 / sizeof (lispy_multimedia_keys
[0])));
5440 /* A mouse click. Figure out where it is, decide whether it's
5441 a press, click or drag, and build the appropriate structure. */
5442 case MOUSE_CLICK_EVENT
:
5443 #ifndef USE_TOOLKIT_SCROLL_BARS
5444 case SCROLL_BAR_CLICK_EVENT
:
5447 int button
= event
->code
;
5449 Lisp_Object position
;
5450 Lisp_Object
*start_pos_ptr
;
5451 Lisp_Object start_pos
;
5455 /* Build the position as appropriate for this mouse click. */
5456 if (event
->kind
== MOUSE_CLICK_EVENT
)
5458 struct frame
*f
= XFRAME (event
->frame_or_window
);
5459 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5463 /* Ignore mouse events that were made on frame that
5464 have been deleted. */
5465 if (! FRAME_LIVE_P (f
))
5468 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5469 /* EVENT->x and EVENT->y are frame-relative pixel
5470 coordinates at this place. Under old redisplay, COLUMN
5471 and ROW are set to frame relative glyph coordinates
5472 which are then used to determine whether this click is
5473 in a menu (non-toolkit version). */
5474 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5475 &column
, &row
, NULL
, 1);
5477 /* In the non-toolkit version, clicks on the menu bar
5478 are ordinary button events in the event buffer.
5479 Distinguish them, and invoke the menu.
5481 (In the toolkit version, the toolkit handles the menu bar
5482 and Emacs doesn't know about it until after the user
5483 makes a selection.) */
5484 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5485 && (event
->modifiers
& down_modifier
))
5487 Lisp_Object items
, item
;
5489 /* Find the menu bar item under `column'. */
5491 items
= FRAME_MENU_BAR_ITEMS (f
);
5492 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5494 Lisp_Object pos
, string
;
5495 string
= AREF (items
, i
+ 1);
5496 pos
= AREF (items
, i
+ 3);
5499 if (column
>= XINT (pos
)
5500 && column
< XINT (pos
) + SCHARS (string
))
5502 item
= AREF (items
, i
);
5507 /* ELisp manual 2.4b says (x y) are window relative but
5508 code says they are frame-relative. */
5510 = Fcons (event
->frame_or_window
,
5512 Fcons (Fcons (event
->x
, event
->y
),
5513 Fcons (make_number (event
->timestamp
),
5516 return Fcons (item
, Fcons (position
, Qnil
));
5518 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5520 position
= make_lispy_position (f
, event
->x
, event
->y
,
5523 #ifndef USE_TOOLKIT_SCROLL_BARS
5526 /* It's a scrollbar click. */
5528 Lisp_Object portion_whole
;
5531 window
= event
->frame_or_window
;
5532 portion_whole
= Fcons (event
->x
, event
->y
);
5533 part
= *scroll_bar_parts
[(int) event
->part
];
5537 Fcons (Qvertical_scroll_bar
,
5538 Fcons (portion_whole
,
5539 Fcons (make_number (event
->timestamp
),
5540 Fcons (part
, Qnil
)))));
5542 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5544 if (button
>= ASIZE (button_down_location
))
5546 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5547 button_down_location
= larger_vector (button_down_location
,
5549 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5552 start_pos_ptr
= &AREF (button_down_location
, button
);
5553 start_pos
= *start_pos_ptr
;
5554 *start_pos_ptr
= Qnil
;
5557 /* On window-system frames, use the value of
5558 double-click-fuzz as is. On other frames, interpret it
5559 as a multiple of 1/8 characters. */
5563 if (WINDOWP (event
->frame_or_window
))
5564 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5565 else if (FRAMEP (event
->frame_or_window
))
5566 f
= XFRAME (event
->frame_or_window
);
5570 if (FRAME_WINDOW_P (f
))
5571 fuzz
= double_click_fuzz
;
5573 fuzz
= double_click_fuzz
/ 8;
5575 is_double
= (button
== last_mouse_button
5576 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5577 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5578 && button_down_time
!= 0
5579 && (EQ (Vdouble_click_time
, Qt
)
5580 || (NATNUMP (Vdouble_click_time
)
5581 && (event
->timestamp
- button_down_time
5582 < XFASTINT (Vdouble_click_time
)))));
5585 last_mouse_button
= button
;
5586 last_mouse_x
= XINT (event
->x
);
5587 last_mouse_y
= XINT (event
->y
);
5589 /* If this is a button press, squirrel away the location, so
5590 we can decide later whether it was a click or a drag. */
5591 if (event
->modifiers
& down_modifier
)
5595 double_click_count
++;
5596 event
->modifiers
|= ((double_click_count
> 2)
5601 double_click_count
= 1;
5602 button_down_time
= event
->timestamp
;
5603 *start_pos_ptr
= Fcopy_alist (position
);
5604 ignore_mouse_drag_p
= 0;
5607 /* Now we're releasing a button - check the co-ordinates to
5608 see if this was a click or a drag. */
5609 else if (event
->modifiers
& up_modifier
)
5611 /* If we did not see a down before this up, ignore the up.
5612 Probably this happened because the down event chose a
5613 menu item. It would be an annoyance to treat the
5614 release of the button that chose the menu item as a
5617 if (!CONSP (start_pos
))
5620 event
->modifiers
&= ~up_modifier
;
5623 Lisp_Object new_down
, down
;
5624 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5626 /* The third element of every position
5627 should be the (x,y) pair. */
5628 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5629 new_down
= Fcar (Fcdr (Fcdr (position
)));
5632 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5634 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5635 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5638 if (ignore_mouse_drag_p
)
5640 event
->modifiers
|= click_modifier
;
5641 ignore_mouse_drag_p
= 0;
5643 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5644 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5645 /* Maybe the mouse has moved a lot, caused scrolling, and
5646 eventually ended up at the same screen position (but
5647 not buffer position) in which case it is a drag, not
5649 /* FIXME: OTOH if the buffer position has changed
5650 because of a timer or process filter rather than
5651 because of mouse movement, it should be considered as
5652 a click. But mouse-drag-region completely ignores
5653 this case and it hasn't caused any real problem, so
5654 it's probably OK to ignore it as well. */
5655 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5656 /* Mouse hasn't moved (much). */
5657 event
->modifiers
|= click_modifier
;
5660 button_down_time
= 0;
5661 event
->modifiers
|= drag_modifier
;
5664 /* Don't check is_double; treat this as multiple
5665 if the down-event was multiple. */
5666 if (double_click_count
> 1)
5667 event
->modifiers
|= ((double_click_count
> 2)
5673 /* Every mouse event should either have the down_modifier or
5674 the up_modifier set. */
5678 /* Get the symbol we should use for the mouse click. */
5681 head
= modify_event_symbol (button
,
5683 Qmouse_click
, Vlispy_mouse_stem
,
5686 ASIZE (mouse_syms
));
5687 if (event
->modifiers
& drag_modifier
)
5692 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5695 Fcons (make_number (double_click_count
),
5705 case HORIZ_WHEEL_EVENT
:
5707 Lisp_Object position
;
5710 /* Build the position as appropriate for this mouse click. */
5711 struct frame
*f
= XFRAME (event
->frame_or_window
);
5713 /* Ignore wheel events that were made on frame that have been
5715 if (! FRAME_LIVE_P (f
))
5718 position
= make_lispy_position (f
, event
->x
, event
->y
,
5721 /* Set double or triple modifiers to indicate the wheel speed. */
5723 /* On window-system frames, use the value of
5724 double-click-fuzz as is. On other frames, interpret it
5725 as a multiple of 1/8 characters. */
5731 if (WINDOWP (event
->frame_or_window
))
5732 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5733 else if (FRAMEP (event
->frame_or_window
))
5734 fr
= XFRAME (event
->frame_or_window
);
5738 fuzz
= FRAME_WINDOW_P (fr
)
5739 ? double_click_fuzz
: double_click_fuzz
/ 8;
5741 if (event
->modifiers
& up_modifier
)
5743 /* Emit a wheel-up event. */
5744 event
->modifiers
&= ~up_modifier
;
5747 else if (event
->modifiers
& down_modifier
)
5749 /* Emit a wheel-down event. */
5750 event
->modifiers
&= ~down_modifier
;
5754 /* Every wheel event should either have the down_modifier or
5755 the up_modifier set. */
5758 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5761 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5762 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5763 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5764 && button_down_time
!= 0
5765 && (EQ (Vdouble_click_time
, Qt
)
5766 || (NATNUMP (Vdouble_click_time
)
5767 && (event
->timestamp
- button_down_time
5768 < XFASTINT (Vdouble_click_time
)))));
5771 double_click_count
++;
5772 event
->modifiers
|= ((double_click_count
> 2)
5778 double_click_count
= 1;
5779 event
->modifiers
|= click_modifier
;
5782 button_down_time
= event
->timestamp
;
5783 /* Use a negative value to distinguish wheel from mouse button. */
5784 last_mouse_button
= - (1 + symbol_num
);
5785 last_mouse_x
= XINT (event
->x
);
5786 last_mouse_y
= XINT (event
->y
);
5788 /* Get the symbol we should use for the wheel event. */
5789 head
= modify_event_symbol (symbol_num
,
5795 ASIZE (wheel_syms
));
5798 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5801 Fcons (make_number (double_click_count
),
5810 #ifdef USE_TOOLKIT_SCROLL_BARS
5812 /* We don't have down and up events if using toolkit scroll bars,
5813 so make this always a click event. Store in the `part' of
5814 the Lisp event a symbol which maps to the following actions:
5816 `above_handle' page up
5817 `below_handle' page down
5821 `bottom' bottom of buffer
5822 `handle' thumb has been dragged.
5823 `end-scroll' end of interaction with scroll bar
5825 The incoming input_event contains in its `part' member an
5826 index of type `enum scroll_bar_part' which we can use as an
5827 index in scroll_bar_parts to get the appropriate symbol. */
5829 case SCROLL_BAR_CLICK_EVENT
:
5831 Lisp_Object position
, head
, window
, portion_whole
, part
;
5833 window
= event
->frame_or_window
;
5834 portion_whole
= Fcons (event
->x
, event
->y
);
5835 part
= *scroll_bar_parts
[(int) event
->part
];
5839 Fcons (Qvertical_scroll_bar
,
5840 Fcons (portion_whole
,
5841 Fcons (make_number (event
->timestamp
),
5842 Fcons (part
, Qnil
)))));
5844 /* Always treat scroll bar events as clicks. */
5845 event
->modifiers
|= click_modifier
;
5846 event
->modifiers
&= ~up_modifier
;
5848 if (event
->code
>= ASIZE (mouse_syms
))
5849 mouse_syms
= larger_vector (mouse_syms
,
5850 event
->code
- ASIZE (mouse_syms
) + 1,
5853 /* Get the symbol we should use for the mouse click. */
5854 head
= modify_event_symbol (event
->code
,
5859 ASIZE (mouse_syms
));
5860 return Fcons (head
, Fcons (position
, Qnil
));
5863 #endif /* USE_TOOLKIT_SCROLL_BARS */
5865 case DRAG_N_DROP_EVENT
:
5868 Lisp_Object head
, position
;
5871 f
= XFRAME (event
->frame_or_window
);
5874 /* Ignore mouse events that were made on frames that
5875 have been deleted. */
5876 if (! FRAME_LIVE_P (f
))
5879 position
= make_lispy_position (f
, event
->x
, event
->y
,
5882 head
= modify_event_symbol (0, event
->modifiers
,
5884 lispy_drag_n_drop_names
,
5885 &drag_n_drop_syms
, 1);
5891 #endif /* HAVE_MOUSE */
5893 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5894 || defined (HAVE_NS) || defined (USE_GTK)
5895 case MENU_BAR_EVENT
:
5896 if (EQ (event
->arg
, event
->frame_or_window
))
5897 /* This is the prefix key. We translate this to
5898 `(menu_bar)' because the code in keyboard.c for menu
5899 events, which we use, relies on this. */
5900 return Fcons (Qmenu_bar
, Qnil
);
5904 case SELECT_WINDOW_EVENT
:
5905 /* Make an event (select-window (WINDOW)). */
5906 return Fcons (Qselect_window
,
5907 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5910 case TOOL_BAR_EVENT
:
5911 if (EQ (event
->arg
, event
->frame_or_window
))
5912 /* This is the prefix key. We translate this to
5913 `(tool_bar)' because the code in keyboard.c for tool bar
5914 events, which we use, relies on this. */
5915 return Fcons (Qtool_bar
, Qnil
);
5916 else if (SYMBOLP (event
->arg
))
5917 return apply_modifiers (event
->modifiers
, event
->arg
);
5920 case USER_SIGNAL_EVENT
:
5921 /* A user signal. */
5923 char *name
= find_user_signal_name (event
->code
);
5926 return intern (name
);
5929 case SAVE_SESSION_EVENT
:
5930 return Qsave_session
;
5935 return Fcons (Qdbus_event
, event
->arg
);
5937 #endif /* HAVE_DBUS */
5939 case CONFIG_CHANGED_EVENT
:
5940 return Fcons (Qconfig_changed_event
,
5942 Fcons (event
->frame_or_window
, Qnil
)));
5944 case GPM_CLICK_EVENT
:
5946 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5947 Lisp_Object head
, position
;
5948 Lisp_Object
*start_pos_ptr
;
5949 Lisp_Object start_pos
;
5950 int button
= event
->code
;
5952 if (button
>= ASIZE (button_down_location
))
5954 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5955 button_down_location
= larger_vector (button_down_location
,
5957 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5960 start_pos_ptr
= &AREF (button_down_location
, button
);
5961 start_pos
= *start_pos_ptr
;
5963 position
= make_lispy_position (f
, event
->x
, event
->y
,
5966 if (event
->modifiers
& down_modifier
)
5967 *start_pos_ptr
= Fcopy_alist (position
);
5968 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5970 if (!CONSP (start_pos
))
5972 event
->modifiers
&= ~up_modifier
;
5975 head
= modify_event_symbol (button
,
5977 Qmouse_click
, Vlispy_mouse_stem
,
5980 ASIZE (mouse_syms
));
5982 if (event
->modifiers
& drag_modifier
)
5987 else if (event
->modifiers
& double_modifier
)
5990 Fcons (make_number (2),
5992 else if (event
->modifiers
& triple_modifier
)
5995 Fcons (make_number (3),
6002 #endif /* HAVE_GPM */
6004 /* The 'kind' field of the event is something we don't recognize. */
6010 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
6013 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6014 Lisp_Object x
, Lisp_Object y
, Time t
)
6016 /* Is it a scroll bar movement? */
6017 if (frame
&& ! NILP (bar_window
))
6019 Lisp_Object part_sym
;
6021 part_sym
= *scroll_bar_parts
[(int) part
];
6022 return Fcons (Qscroll_bar_movement
,
6023 Fcons (list5 (bar_window
,
6024 Qvertical_scroll_bar
,
6030 /* Or is it an ordinary mouse movement? */
6033 Lisp_Object position
;
6034 position
= make_lispy_position (frame
, x
, y
, t
);
6035 return list2 (Qmouse_movement
, position
);
6039 #endif /* HAVE_MOUSE || HAVE GPM */
6041 /* Construct a switch frame event. */
6043 make_lispy_switch_frame (Lisp_Object frame
)
6045 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6048 /* Manipulating modifiers. */
6050 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6052 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6053 SYMBOL's name of the end of the modifiers; the string from this
6054 position is the unmodified symbol name.
6056 This doesn't use any caches. */
6059 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6065 CHECK_SYMBOL (symbol
);
6068 name
= SYMBOL_NAME (symbol
);
6070 for (i
= 0; i
< SBYTES (name
) - 1; )
6072 ptrdiff_t this_mod_end
= 0;
6075 /* See if the name continues with a modifier word.
6076 Check that the word appears, but don't check what follows it.
6077 Set this_mod and this_mod_end to record what we find. */
6079 switch (SREF (name
, i
))
6081 #define SINGLE_LETTER_MOD(BIT) \
6082 (this_mod_end = i + 1, this_mod = BIT)
6085 SINGLE_LETTER_MOD (alt_modifier
);
6089 SINGLE_LETTER_MOD (ctrl_modifier
);
6093 SINGLE_LETTER_MOD (hyper_modifier
);
6097 SINGLE_LETTER_MOD (meta_modifier
);
6101 SINGLE_LETTER_MOD (shift_modifier
);
6105 SINGLE_LETTER_MOD (super_modifier
);
6108 #undef SINGLE_LETTER_MOD
6110 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6111 if (i + LEN + 1 <= SBYTES (name) \
6112 && ! strncmp (SSDATA (name) + i, NAME, LEN)) \
6114 this_mod_end = i + LEN; \
6119 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6120 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6121 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6125 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6127 #undef MULTI_LETTER_MOD
6131 /* If we found no modifier, stop looking for them. */
6132 if (this_mod_end
== 0)
6135 /* Check there is a dash after the modifier, so that it
6136 really is a modifier. */
6137 if (this_mod_end
>= SBYTES (name
)
6138 || SREF (name
, this_mod_end
) != '-')
6141 /* This modifier is real; look for another. */
6142 modifiers
|= this_mod
;
6143 i
= this_mod_end
+ 1;
6146 /* Should we include the `click' modifier? */
6147 if (! (modifiers
& (down_modifier
| drag_modifier
6148 | double_modifier
| triple_modifier
))
6149 && i
+ 7 == SBYTES (name
)
6150 && strncmp (SSDATA (name
) + i
, "mouse-", 6) == 0
6151 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6152 modifiers
|= click_modifier
;
6154 if (! (modifiers
& (double_modifier
| triple_modifier
))
6155 && i
+ 6 < SBYTES (name
)
6156 && strncmp (SSDATA (name
) + i
, "wheel-", 6) == 0)
6157 modifiers
|= click_modifier
;
6165 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6166 prepended to the string BASE[0..BASE_LEN-1].
6167 This doesn't use any caches. */
6169 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6171 /* Since BASE could contain nulls, we can't use intern here; we have
6172 to use Fintern, which expects a genuine Lisp_String, and keeps a
6175 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6181 /* Only the event queue may use the `up' modifier; it should always
6182 be turned into a click or drag event before presented to lisp code. */
6183 if (modifiers
& up_modifier
)
6186 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6187 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6188 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6189 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6190 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6191 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6192 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6193 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6194 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6195 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6196 /* The click modifier is denoted by the absence of other modifiers. */
6200 mod_len
= p
- new_mods
;
6204 Lisp_Object new_name
;
6206 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6207 mod_len
+ base_len_byte
);
6208 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6209 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6211 return Fintern (new_name
, Qnil
);
6216 static const char *const modifier_names
[] =
6218 "up", "down", "drag", "click", "double", "triple", 0, 0,
6219 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6220 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6222 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6224 static Lisp_Object modifier_symbols
;
6226 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6228 lispy_modifier_list (int modifiers
)
6230 Lisp_Object modifier_list
;
6233 modifier_list
= Qnil
;
6234 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6235 if (modifiers
& (1<<i
))
6236 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6239 return modifier_list
;
6243 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6244 where UNMODIFIED is the unmodified form of SYMBOL,
6245 MASK is the set of modifiers present in SYMBOL's name.
6246 This is similar to parse_modifiers_uncached, but uses the cache in
6247 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6248 Qevent_symbol_elements property. */
6250 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6253 parse_modifiers (Lisp_Object symbol
)
6255 Lisp_Object elements
;
6257 if (INTEGERP (symbol
))
6258 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6259 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6261 else if (!SYMBOLP (symbol
))
6264 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6265 if (CONSP (elements
))
6270 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6271 Lisp_Object unmodified
;
6274 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6275 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6278 if (modifiers
& ~INTMASK
)
6280 XSETFASTINT (mask
, modifiers
);
6281 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6283 /* Cache the parsing results on SYMBOL. */
6284 Fput (symbol
, Qevent_symbol_element_mask
,
6286 Fput (symbol
, Qevent_symbol_elements
,
6287 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6289 /* Since we know that SYMBOL is modifiers applied to unmodified,
6290 it would be nice to put that in unmodified's cache.
6291 But we can't, since we're not sure that parse_modifiers is
6298 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6299 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6300 doc
: /* Parse the event symbol. For internal use. */)
6301 (Lisp_Object symbol
)
6303 /* Fill the cache if needed. */
6304 parse_modifiers (symbol
);
6305 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6306 and use the Lispier representation stored on Qevent_symbol_elements
6308 return Fget (symbol
, Qevent_symbol_elements
);
6311 /* Apply the modifiers MODIFIERS to the symbol BASE.
6312 BASE must be unmodified.
6314 This is like apply_modifiers_uncached, but uses BASE's
6315 Qmodifier_cache property, if present. It also builds
6316 Qevent_symbol_elements properties, since it has that info anyway.
6318 apply_modifiers copies the value of BASE's Qevent_kind property to
6319 the modified symbol. */
6321 apply_modifiers (int modifiers
, Lisp_Object base
)
6323 Lisp_Object cache
, idx
, entry
, new_symbol
;
6325 /* Mask out upper bits. We don't know where this value's been. */
6326 modifiers
&= INTMASK
;
6328 if (INTEGERP (base
))
6329 return make_number (XINT (base
) | modifiers
);
6331 /* The click modifier never figures into cache indices. */
6332 cache
= Fget (base
, Qmodifier_cache
);
6333 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6334 entry
= assq_no_quit (idx
, cache
);
6337 new_symbol
= XCDR (entry
);
6340 /* We have to create the symbol ourselves. */
6341 new_symbol
= apply_modifiers_uncached (modifiers
,
6342 SSDATA (SYMBOL_NAME (base
)),
6343 SCHARS (SYMBOL_NAME (base
)),
6344 SBYTES (SYMBOL_NAME (base
)));
6346 /* Add the new symbol to the base's cache. */
6347 entry
= Fcons (idx
, new_symbol
);
6348 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6350 /* We have the parsing info now for free, so we could add it to
6352 XSETFASTINT (idx, modifiers);
6353 Fput (new_symbol, Qevent_symbol_element_mask,
6354 Fcons (base, Fcons (idx, Qnil)));
6355 Fput (new_symbol, Qevent_symbol_elements,
6356 Fcons (base, lispy_modifier_list (modifiers)));
6357 Sadly, this is only correct if `base' is indeed a base event,
6358 which is not necessarily the case. -stef */
6361 /* Make sure this symbol is of the same kind as BASE.
6363 You'd think we could just set this once and for all when we
6364 intern the symbol above, but reorder_modifiers may call us when
6365 BASE's property isn't set right; we can't assume that just
6366 because it has a Qmodifier_cache property it must have its
6367 Qevent_kind set right as well. */
6368 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6372 kind
= Fget (base
, Qevent_kind
);
6374 Fput (new_symbol
, Qevent_kind
, kind
);
6381 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6382 return a symbol with the modifiers placed in the canonical order.
6383 Canonical order is alphabetical, except for down and drag, which
6384 always come last. The 'click' modifier is never written out.
6386 Fdefine_key calls this to make sure that (for example) C-M-foo
6387 and M-C-foo end up being equivalent in the keymap. */
6390 reorder_modifiers (Lisp_Object symbol
)
6392 /* It's hopefully okay to write the code this way, since everything
6393 will soon be in caches, and no consing will be done at all. */
6396 parsed
= parse_modifiers (symbol
);
6397 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6402 /* For handling events, we often want to produce a symbol whose name
6403 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6404 to some base, like the name of a function key or mouse button.
6405 modify_event_symbol produces symbols of this sort.
6407 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6408 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6411 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6412 into symbol names, or a string specifying a name stem used to
6413 construct a symbol name or the form `STEM-N', where N is the decimal
6414 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6415 non-nil; otherwise NAME_TABLE is used.
6417 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6418 persist between calls to modify_event_symbol that it can use to
6419 store a cache of the symbols it's generated for this NAME_TABLE
6420 before. The object stored there may be a vector or an alist.
6422 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6424 MODIFIERS is a set of modifier bits (as given in struct input_events)
6425 whose prefixes should be applied to the symbol name.
6427 SYMBOL_KIND is the value to be placed in the event_kind property of
6428 the returned symbol.
6430 The symbols we create are supposed to have an
6431 `event-symbol-elements' property, which lists the modifiers present
6432 in the symbol's name. */
6435 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6436 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6437 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6440 Lisp_Object symbol_int
;
6442 /* Get rid of the "vendor-specific" bit here. */
6443 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6445 /* Is this a request for a valid symbol? */
6446 if (symbol_num
< 0 || symbol_num
>= table_size
)
6449 if (CONSP (*symbol_table
))
6450 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6452 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6453 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6454 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6455 we've never used that symbol before. */
6458 if (! VECTORP (*symbol_table
)
6459 || ASIZE (*symbol_table
) != table_size
)
6463 XSETFASTINT (size
, table_size
);
6464 *symbol_table
= Fmake_vector (size
, Qnil
);
6467 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6470 /* Have we already used this symbol before? */
6473 /* No; let's create it. */
6474 if (CONSP (name_alist_or_stem
))
6475 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6476 else if (STRINGP (name_alist_or_stem
))
6479 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6480 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6482 SAFE_ALLOCA (buf
, char *, len
);
6483 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6484 XINT (symbol_int
) + 1);
6485 value
= intern (buf
);
6488 else if (name_table
!= 0 && name_table
[symbol_num
])
6489 value
= intern (name_table
[symbol_num
]);
6491 #ifdef HAVE_WINDOW_SYSTEM
6494 char *name
= x_get_keysym_name (symbol_num
);
6496 value
= intern (name
);
6502 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6503 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6504 value
= intern (buf
);
6507 if (CONSP (*symbol_table
))
6508 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6510 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6512 /* Fill in the cache entries for this symbol; this also
6513 builds the Qevent_symbol_elements property, which the user
6515 apply_modifiers (modifiers
& click_modifier
, value
);
6516 Fput (value
, Qevent_kind
, symbol_kind
);
6519 /* Apply modifiers to that symbol. */
6520 return apply_modifiers (modifiers
, value
);
6523 /* Convert a list that represents an event type,
6524 such as (ctrl meta backspace), into the usual representation of that
6525 event type as a number or a symbol. */
6527 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6528 doc
: /* Convert the event description list EVENT-DESC to an event type.
6529 EVENT-DESC should contain one base event type (a character or symbol)
6530 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6531 drag, down, double or triple). The base must be last.
6532 The return value is an event type (a character or symbol) which
6533 has the same base event type and all the specified modifiers. */)
6534 (Lisp_Object event_desc
)
6542 while (CONSP (rest
))
6550 /* Given a symbol, see if it is a modifier name. */
6551 if (SYMBOLP (elt
) && CONSP (rest
))
6552 this = parse_solitary_modifier (elt
);
6556 else if (!NILP (base
))
6557 error ("Two bases given in one event");
6563 /* Let the symbol A refer to the character A. */
6564 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6565 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6567 if (INTEGERP (base
))
6569 /* Turn (shift a) into A. */
6570 if ((modifiers
& shift_modifier
) != 0
6571 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6573 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6574 modifiers
&= ~shift_modifier
;
6577 /* Turn (control a) into C-a. */
6578 if (modifiers
& ctrl_modifier
)
6579 return make_number ((modifiers
& ~ctrl_modifier
)
6580 | make_ctrl_char (XINT (base
)));
6582 return make_number (modifiers
| XINT (base
));
6584 else if (SYMBOLP (base
))
6585 return apply_modifiers (modifiers
, base
);
6588 error ("Invalid base event");
6593 /* Try to recognize SYMBOL as a modifier name.
6594 Return the modifier flag bit, or 0 if not recognized. */
6597 parse_solitary_modifier (Lisp_Object symbol
)
6599 Lisp_Object name
= SYMBOL_NAME (symbol
);
6601 switch (SREF (name
, 0))
6603 #define SINGLE_LETTER_MOD(BIT) \
6604 if (SBYTES (name) == 1) \
6607 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6608 if (LEN == SBYTES (name) \
6609 && ! strncmp (SSDATA (name), NAME, LEN)) \
6613 SINGLE_LETTER_MOD (alt_modifier
);
6617 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6621 SINGLE_LETTER_MOD (ctrl_modifier
);
6625 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6626 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6630 SINGLE_LETTER_MOD (hyper_modifier
);
6634 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6638 SINGLE_LETTER_MOD (meta_modifier
);
6642 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6646 SINGLE_LETTER_MOD (shift_modifier
);
6650 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6651 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6652 SINGLE_LETTER_MOD (super_modifier
);
6656 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6657 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6658 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6662 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6665 #undef SINGLE_LETTER_MOD
6666 #undef MULTI_LETTER_MOD
6672 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6673 Such a list is not valid as an event,
6674 but it can be a Lucid-style event type list. */
6677 lucid_event_type_list_p (Lisp_Object object
)
6681 if (! CONSP (object
))
6684 if (EQ (XCAR (object
), Qhelp_echo
)
6685 || EQ (XCAR (object
), Qvertical_line
)
6686 || EQ (XCAR (object
), Qmode_line
)
6687 || EQ (XCAR (object
), Qheader_line
))
6690 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6694 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6701 /* Store into *addr a value nonzero if terminal input chars are available.
6702 Serves the purpose of ioctl (0, FIONREAD, addr)
6703 but works even if FIONREAD does not exist.
6704 (In fact, this may actually read some input.)
6706 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6707 timer events that are ripe.
6708 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6709 events (FOCUS_IN_EVENT).
6710 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6711 movements and toolkit scroll bar thumb drags. */
6714 get_input_pending (int *addr
, int flags
)
6716 /* First of all, have we already counted some input? */
6717 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6719 /* If input is being read as it arrives, and we have none, there is none. */
6720 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6723 /* Try to read some input and see how much we get. */
6725 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6728 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6731 gobble_input (int expected
)
6734 if (interrupt_input
)
6737 mask
= sigblock (sigmask (SIGIO
));
6738 read_avail_input (expected
);
6742 #ifdef POLL_FOR_INPUT
6743 /* XXX This condition was (read_socket_hook && !interrupt_input),
6744 but read_socket_hook is not global anymore. Let's pretend that
6746 if (!interrupt_input
&& poll_suppress_count
== 0)
6749 mask
= sigblock (sigmask (SIGALRM
));
6750 read_avail_input (expected
);
6756 read_avail_input (expected
);
6759 /* Put a BUFFER_SWITCH_EVENT in the buffer
6760 so that read_key_sequence will notice the new current buffer. */
6763 record_asynch_buffer_change (void)
6765 struct input_event event
;
6769 event
.kind
= BUFFER_SWITCH_EVENT
;
6770 event
.frame_or_window
= Qnil
;
6773 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6774 The purpose of the event is to make read_key_sequence look up the
6775 keymaps again. If we aren't in read_key_sequence, we don't need one,
6776 and the event could cause trouble by messing up (input-pending-p).
6777 Note: Fwaiting_for_user_input_p always returns nil when async
6778 subprocesses aren't supported. */
6779 tem
= Fwaiting_for_user_input_p ();
6783 /* Make sure no interrupt happens while storing the event. */
6785 if (interrupt_input
)
6788 mask
= sigblock (sigmask (SIGIO
));
6789 kbd_buffer_store_event (&event
);
6796 kbd_buffer_store_event (&event
);
6801 /* Read any terminal input already buffered up by the system
6802 into the kbd_buffer, but do not wait.
6804 EXPECTED should be nonzero if the caller knows there is some input.
6806 Returns the number of keyboard chars read, or -1 meaning
6807 this is a bad time to try to read input. */
6810 read_avail_input (int expected
)
6816 /* Store pending user signal events, if any. */
6817 if (store_user_signal_events ())
6820 /* Loop through the available terminals, and call their input hooks. */
6824 struct terminal
*next
= t
->next_terminal
;
6826 if (t
->read_socket_hook
)
6829 struct input_event hold_quit
;
6831 EVENT_INIT (hold_quit
);
6832 hold_quit
.kind
= NO_EVENT
;
6834 /* No need for FIONREAD or fcntl; just say don't wait. */
6835 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6841 if (nr
== -1) /* Not OK to read input now. */
6845 else if (nr
== -2) /* Non-transient error. */
6847 /* The terminal device terminated; it should be closed. */
6849 /* Kill Emacs if this was our last terminal. */
6850 if (!terminal_list
->next_terminal
)
6851 /* Formerly simply reported no input, but that
6852 sometimes led to a failure of Emacs to terminate.
6853 SIGHUP seems appropriate if we can't reach the
6855 /* ??? Is it really right to send the signal just to
6856 this process rather than to the whole process
6857 group? Perhaps on systems with FIONREAD Emacs is
6858 alone in its group. */
6859 kill (getpid (), SIGHUP
);
6861 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6864 XSETTERMINAL (tmp
, t
);
6865 Fdelete_terminal (tmp
, Qnoelisp
);
6869 if (hold_quit
.kind
!= NO_EVENT
)
6870 kbd_buffer_store_event (&hold_quit
);
6879 frame_make_pointer_visible ();
6885 decode_keyboard_code (struct tty_display_info
*tty
,
6886 struct coding_system
*coding
,
6887 unsigned char *buf
, int nbytes
)
6889 unsigned char *src
= buf
;
6890 const unsigned char *p
;
6895 if (tty
->meta_key
!= 2)
6896 for (i
= 0; i
< nbytes
; i
++)
6898 if (coding
->carryover_bytes
> 0)
6900 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6901 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6902 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6903 nbytes
+= coding
->carryover_bytes
;
6905 coding
->destination
= alloca (nbytes
* 4);
6906 coding
->dst_bytes
= nbytes
* 4;
6907 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6908 if (coding
->produced_char
== 0)
6910 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6912 struct input_event event_buf
;
6914 EVENT_INIT (event_buf
);
6915 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6917 (ASCII_CHAR_P (event_buf
.code
)
6918 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6919 /* See the comment in tty_read_avail_input. */
6920 event_buf
.frame_or_window
= tty
->top_frame
;
6921 event_buf
.arg
= Qnil
;
6922 kbd_buffer_store_event (&event_buf
);
6926 /* This is the tty way of reading available input.
6928 Note that each terminal device has its own `struct terminal' object,
6929 and so this function is called once for each individual termcap
6930 terminal. The first parameter indicates which terminal to read from. */
6933 tty_read_avail_input (struct terminal
*terminal
,
6935 struct input_event
*hold_quit
)
6937 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6938 the kbd_buffer can really hold. That may prevent loss
6939 of characters on some systems when input is stuffed at us. */
6940 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6942 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6945 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6947 if (kbd_on_hold_p () || buffer_free
<= 0)
6949 #endif /* subprocesses */
6951 if (!terminal
->name
) /* Don't read from a dead terminal. */
6954 if (terminal
->type
!= output_termcap
6955 && terminal
->type
!= output_msdos_raw
)
6958 /* XXX I think the following code should be moved to separate hook
6959 functions in system-dependent files. */
6962 #else /* not WINDOWSNT */
6963 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6967 return 0; /* The terminal is suspended. */
6970 n_to_read
= dos_keysns ();
6974 cbuf
[0] = dos_keyread ();
6977 #else /* not MSDOS */
6982 struct input_event gpm_hold_quit
;
6983 int gpm
, fd
= gpm_fd
;
6985 EVENT_INIT (gpm_hold_quit
);
6986 gpm_hold_quit
.kind
= NO_EVENT
;
6988 /* gpm==1 if event received.
6989 gpm==0 if the GPM daemon has closed the connection, in which case
6990 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6991 we save it in `fd' so close_gpm can remove it from the
6993 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6994 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6995 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6998 /* Presumably the GPM daemon has closed the connection. */
7000 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7001 kbd_buffer_store_event (&gpm_hold_quit
);
7005 #endif /* HAVE_GPM */
7007 /* Determine how many characters we should *try* to read. */
7009 /* Find out how much input is available. */
7010 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7012 if (! noninteractive
)
7013 return -2; /* Close this terminal. */
7019 if (n_to_read
> sizeof cbuf
)
7020 n_to_read
= sizeof cbuf
;
7021 #else /* no FIONREAD */
7022 #if defined (USG) || defined (CYGWIN)
7023 /* Read some input if available, but don't wait. */
7024 n_to_read
= sizeof cbuf
;
7025 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7032 /* Don't read more than we can store. */
7033 if (n_to_read
> buffer_free
)
7034 n_to_read
= buffer_free
;
7035 #endif /* subprocesses */
7037 /* Now read; for one reason or another, this will not block.
7038 NREAD is set to the number of chars read. */
7041 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7042 /* POSIX infers that processes which are not in the session leader's
7043 process group won't get SIGHUP's at logout time. BSDI adheres to
7044 this part standard and returns -1 from read (0) with errno==EIO
7045 when the control tty is taken away.
7046 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7047 if (nread
== -1 && errno
== EIO
)
7048 return -2; /* Close this terminal. */
7049 #if defined (AIX) && defined (_BSD)
7050 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7051 This looks incorrect, but it isn't, because _BSD causes
7052 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7053 and that causes a value other than 0 when there is no input. */
7055 return -2; /* Close this terminal. */
7059 /* We used to retry the read if it was interrupted.
7060 But this does the wrong thing when O_NDELAY causes
7061 an EAGAIN error. Does anybody know of a situation
7062 where a retry is actually needed? */
7064 nread
< 0 && (errno
== EAGAIN
7078 #if defined (USG) || defined (CYGWIN)
7079 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7080 #endif /* USG or CYGWIN */
7081 #endif /* no FIONREAD */
7086 #endif /* not MSDOS */
7087 #endif /* not WINDOWSNT */
7089 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7090 & CODING_REQUIRE_DECODING_MASK
)
7092 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7095 /* Decode the key sequence except for those with meta
7097 for (i
= from
= 0; ; i
++)
7098 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7100 struct input_event buf
;
7102 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7107 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7108 buf
.modifiers
= meta_modifier
;
7109 buf
.code
= cbuf
[i
] & ~0x80;
7110 /* See the comment below. */
7111 buf
.frame_or_window
= tty
->top_frame
;
7113 kbd_buffer_store_event (&buf
);
7119 for (i
= 0; i
< nread
; i
++)
7121 struct input_event buf
;
7123 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7125 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7126 buf
.modifiers
= meta_modifier
;
7127 if (tty
->meta_key
!= 2)
7131 /* Set the frame corresponding to the active tty. Note that the
7132 value of selected_frame is not reliable here, redisplay tends
7133 to temporarily change it. */
7134 buf
.frame_or_window
= tty
->top_frame
;
7137 kbd_buffer_store_event (&buf
);
7138 /* Don't look at input that follows a C-g too closely.
7139 This reduces lossage due to autorepeat on C-g. */
7140 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7141 && buf
.code
== quit_char
)
7149 handle_async_input (void)
7151 interrupt_input_pending
= 0;
7153 pending_signals
= pending_atimers
;
7155 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7156 doing anything dangerous. */
7163 nread
= read_avail_input (1);
7164 /* -1 means it's not ok to read the input now.
7165 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7166 0 means there was no keyboard input available. */
7176 process_pending_signals (void)
7178 if (interrupt_input_pending
)
7179 handle_async_input ();
7180 do_pending_atimers ();
7183 #ifdef SIGIO /* for entire page */
7184 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7187 input_available_signal (int signo
)
7189 /* Must preserve main program's value of errno. */
7190 int old_errno
= errno
;
7191 SIGNAL_THREAD_CHECK (signo
);
7194 interrupt_input_pending
= 1;
7195 pending_signals
= 1;
7198 if (input_available_clear_time
)
7199 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7202 handle_async_input ();
7209 /* Send ourselves a SIGIO.
7211 This function exists so that the UNBLOCK_INPUT macro in
7212 blockinput.h can have some way to take care of input we put off
7213 dealing with, without assuming that every file which uses
7214 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7216 reinvoke_input_signal (void)
7219 handle_async_input ();
7225 /* User signal events. */
7227 struct user_signal_info
7229 /* Signal number. */
7232 /* Name of the signal. */
7235 /* Number of pending signals. */
7238 struct user_signal_info
*next
;
7241 /* List of user signals. */
7242 static struct user_signal_info
*user_signals
= NULL
;
7245 add_user_signal (int sig
, const char *name
)
7247 struct user_signal_info
*p
;
7249 for (p
= user_signals
; p
; p
= p
->next
)
7251 /* Already added. */
7254 p
= xmalloc (sizeof (struct user_signal_info
));
7256 p
->name
= xstrdup (name
);
7258 p
->next
= user_signals
;
7261 signal (sig
, handle_user_signal
);
7265 handle_user_signal (int sig
)
7267 int old_errno
= errno
;
7268 struct user_signal_info
*p
;
7269 const char *special_event_name
= NULL
;
7271 SIGNAL_THREAD_CHECK (sig
);
7273 if (SYMBOLP (Vdebug_on_event
))
7274 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7276 for (p
= user_signals
; p
; p
= p
->next
)
7279 if (special_event_name
&&
7280 strcmp (special_event_name
, p
->name
) == 0)
7282 /* Enter the debugger in many ways. */
7283 debug_on_next_call
= 1;
7286 Vinhibit_quit
= Qnil
;
7288 /* Eat the event. */
7294 if (interrupt_input
)
7295 kill (getpid (), SIGIO
);
7299 /* Tell wait_reading_process_output that it needs to wake
7300 up and look around. */
7301 if (input_available_clear_time
)
7302 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7311 find_user_signal_name (int sig
)
7313 struct user_signal_info
*p
;
7315 for (p
= user_signals
; p
; p
= p
->next
)
7323 store_user_signal_events (void)
7325 struct user_signal_info
*p
;
7326 struct input_event buf
;
7329 for (p
= user_signals
; p
; p
= p
->next
)
7330 if (p
->npending
> 0)
7336 memset (&buf
, 0, sizeof buf
);
7337 buf
.kind
= USER_SIGNAL_EVENT
;
7338 buf
.frame_or_window
= selected_frame
;
7340 nstored
+= p
->npending
;
7342 mask
= sigblock (sigmask (p
->sig
));
7346 kbd_buffer_store_event (&buf
);
7349 while (p
->npending
> 0);
7357 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7358 static Lisp_Object menu_bar_one_keymap_changed_items
;
7360 /* These variables hold the vector under construction within
7361 menu_bar_items and its subroutines, and the current index
7362 for storing into that vector. */
7363 static Lisp_Object menu_bar_items_vector
;
7364 static int menu_bar_items_index
;
7367 static const char* separator_names
[] = {
7372 "single-dashed-line",
7373 "double-dashed-line",
7375 "shadow-etched-out",
7376 "shadow-etched-in-dash",
7377 "shadow-etched-out-dash",
7378 "shadow-double-etched-in",
7379 "shadow-double-etched-out",
7380 "shadow-double-etched-in-dash",
7381 "shadow-double-etched-out-dash",
7385 /* Return non-zero if LABEL specifies a separator. */
7388 menu_separator_name_p (const char *label
)
7392 else if (strlen (label
) > 3
7393 && strncmp (label
, "--", 2) == 0
7398 for (i
= 0; separator_names
[i
]; ++i
)
7399 if (strcmp (label
, separator_names
[i
]) == 0)
7404 /* It's a separator if it contains only dashes. */
7405 while (*label
== '-')
7407 return (*label
== 0);
7414 /* Return a vector of menu items for a menu bar, appropriate
7415 to the current buffer. Each item has three elements in the vector:
7418 OLD is an old vector we can optionally reuse, or nil. */
7421 menu_bar_items (Lisp_Object old
)
7423 /* The number of keymaps we're scanning right now, and the number of
7424 keymaps we have allocated space for. */
7427 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7428 in the current keymaps, or nil where it is not a prefix. */
7431 Lisp_Object def
, tail
;
7436 /* In order to build the menus, we need to call the keymap
7437 accessors. They all call QUIT. But this function is called
7438 during redisplay, during which a quit is fatal. So inhibit
7439 quitting while building the menus.
7440 We do this instead of specbind because (1) errors will clear it anyway
7441 and (2) this avoids risk of specpdl overflow. */
7442 oquit
= Vinhibit_quit
;
7446 menu_bar_items_vector
= old
;
7448 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7449 menu_bar_items_index
= 0;
7451 /* Build our list of keymaps.
7452 If we recognize a function key and replace its escape sequence in
7453 keybuf with its symbol, or if the sequence starts with a mouse
7454 click and we need to switch buffers, we jump back here to rebuild
7455 the initial keymaps from the current buffer. */
7459 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7460 if (!NILP (Voverriding_local_map_menu_flag
))
7462 /* Yes, use them (if non-nil) as well as the global map. */
7463 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7465 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7466 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7467 if (!NILP (Voverriding_local_map
))
7468 maps
[nmaps
++] = Voverriding_local_map
;
7472 /* No, so use major and minor mode keymaps and keymap property.
7473 Note that menu-bar bindings in the local-map and keymap
7474 properties may not work reliable, as they are only
7475 recognized when the menu-bar (or mode-line) is updated,
7476 which does not normally happen after every command. */
7479 nminor
= current_minor_maps (NULL
, &tmaps
);
7480 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7482 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7483 maps
[nmaps
++] = tem
;
7484 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7486 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7488 maps
[nmaps
++] = current_global_map
;
7491 /* Look up in each map the dummy prefix key `menu-bar'. */
7493 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7494 if (!NILP (maps
[mapno
]))
7496 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7500 menu_bar_one_keymap_changed_items
= Qnil
;
7501 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7505 /* Move to the end those items that should be at the end. */
7507 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7510 int end
= menu_bar_items_index
;
7512 for (i
= 0; i
< end
; i
+= 4)
7513 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7515 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7516 /* Move the item at index I to the end,
7517 shifting all the others forward. */
7518 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7519 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7520 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7521 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7523 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7524 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7525 (end
- i
- 4) * sizeof (Lisp_Object
));
7526 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7527 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7528 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7529 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7534 /* Add nil, nil, nil, nil at the end. */
7536 int i
= menu_bar_items_index
;
7537 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7538 menu_bar_items_vector
=
7539 larger_vector (menu_bar_items_vector
, 4, -1);
7540 /* Add this item. */
7541 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7542 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7543 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7544 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7545 menu_bar_items_index
= i
;
7548 Vinhibit_quit
= oquit
;
7549 return menu_bar_items_vector
;
7552 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7553 If there's already an item for KEY, add this DEF to it. */
7555 Lisp_Object item_properties
;
7558 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7560 struct gcpro gcpro1
;
7564 if (EQ (item
, Qundefined
))
7566 /* If a map has an explicit `undefined' as definition,
7567 discard any previously made menu bar item. */
7569 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7570 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7572 if (menu_bar_items_index
> i
+ 4)
7573 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7574 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7575 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7576 menu_bar_items_index
-= 4;
7580 /* If this keymap has already contributed to this KEY,
7581 don't contribute to it a second time. */
7582 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7583 if (!NILP (tem
) || NILP (item
))
7586 menu_bar_one_keymap_changed_items
7587 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7589 /* We add to menu_bar_one_keymap_changed_items before doing the
7590 parse_menu_item, so that if it turns out it wasn't a menu item,
7591 it still correctly hides any further menu item. */
7593 i
= parse_menu_item (item
, 1);
7598 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7600 /* Find any existing item for this KEY. */
7601 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7602 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7605 /* If we did not find this KEY, add it at the end. */
7606 if (i
== menu_bar_items_index
)
7608 /* If vector is too small, get a bigger one. */
7609 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7610 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7611 /* Add this item. */
7612 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7613 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7614 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7615 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7616 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7617 menu_bar_items_index
= i
;
7619 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7623 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7624 /* If the new and the old items are not both keymaps,
7625 the lookup will only find `item'. */
7626 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7627 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7631 /* This is used as the handler when calling menu_item_eval_property. */
7633 menu_item_eval_property_1 (Lisp_Object arg
)
7635 /* If we got a quit from within the menu computation,
7636 quit all the way out of it. This takes care of C-] in the debugger. */
7637 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7638 Fsignal (Qquit
, Qnil
);
7644 eval_dyn (Lisp_Object form
)
7646 return Feval (form
, Qnil
);
7649 /* Evaluate an expression and return the result (or nil if something
7650 went wrong). Used to evaluate dynamic parts of menu items. */
7652 menu_item_eval_property (Lisp_Object sexpr
)
7654 ptrdiff_t count
= SPECPDL_INDEX ();
7656 specbind (Qinhibit_redisplay
, Qt
);
7657 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7658 menu_item_eval_property_1
);
7659 return unbind_to (count
, val
);
7662 /* This function parses a menu item and leaves the result in the
7663 vector item_properties.
7664 ITEM is a key binding, a possible menu item.
7665 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7667 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7668 parse_menu_item returns true if the item is a menu item and false
7672 parse_menu_item (Lisp_Object item
, int inmenubar
)
7674 Lisp_Object def
, tem
, item_string
, start
;
7676 Lisp_Object keyhint
;
7685 /* Create item_properties vector if necessary. */
7686 if (NILP (item_properties
))
7688 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7690 /* Initialize optional entries. */
7691 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7692 ASET (item_properties
, i
, Qnil
);
7693 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7695 /* Save the item here to protect it from GC. */
7696 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7698 item_string
= XCAR (item
);
7702 if (STRINGP (item_string
))
7704 /* Old format menu item. */
7705 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7707 /* Maybe help string. */
7708 if (CONSP (item
) && STRINGP (XCAR (item
)))
7710 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7715 /* Maybe an obsolete key binding cache. */
7716 if (CONSP (item
) && CONSP (XCAR (item
))
7717 && (NILP (XCAR (XCAR (item
)))
7718 || VECTORP (XCAR (XCAR (item
)))))
7721 /* This is the real definition--the function to run. */
7722 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7724 /* Get enable property, if any. */
7727 tem
= Fget (item
, Qmenu_enable
);
7728 if (!NILP (Venable_disabled_menus_and_buttons
))
7729 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7730 else if (!NILP (tem
))
7731 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7734 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7736 /* New format menu item. */
7737 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7738 start
= XCDR (item
);
7741 /* We have a real binding. */
7742 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7744 item
= XCDR (start
);
7745 /* Is there an obsolete cache list with key equivalences. */
7746 if (CONSP (item
) && CONSP (XCAR (item
)))
7749 /* Parse properties. */
7750 while (CONSP (item
) && CONSP (XCDR (item
)))
7755 if (EQ (tem
, QCenable
))
7757 if (!NILP (Venable_disabled_menus_and_buttons
))
7758 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7760 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7762 else if (EQ (tem
, QCvisible
))
7764 /* If got a visible property and that evaluates to nil
7765 then ignore this item. */
7766 tem
= menu_item_eval_property (XCAR (item
));
7770 else if (EQ (tem
, QChelp
))
7771 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7772 else if (EQ (tem
, QCfilter
))
7774 else if (EQ (tem
, QCkey_sequence
))
7777 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7778 /* Be GC protected. Set keyhint to item instead of tem. */
7781 else if (EQ (tem
, QCkeys
))
7784 if (CONSP (tem
) || STRINGP (tem
))
7785 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7787 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7792 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7794 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7796 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7802 else if (inmenubar
|| !NILP (start
))
7806 return 0; /* not a menu item */
7808 /* If item string is not a string, evaluate it to get string.
7809 If we don't get a string, skip this item. */
7810 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7811 if (!(STRINGP (item_string
)))
7813 item_string
= menu_item_eval_property (item_string
);
7814 if (!STRINGP (item_string
))
7816 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7819 /* If got a filter apply it on definition. */
7820 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7823 def
= menu_item_eval_property (list2 (XCAR (filter
),
7824 list2 (Qquote
, def
)));
7826 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7829 /* Enable or disable selection of item. */
7830 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7833 tem
= menu_item_eval_property (tem
);
7834 if (inmenubar
&& NILP (tem
))
7835 return 0; /* Ignore disabled items in menu bar. */
7836 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7839 /* If we got no definition, this item is just unselectable text which
7840 is OK in a submenu but not in the menubar. */
7842 return (!inmenubar
);
7844 /* See if this is a separate pane or a submenu. */
7845 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7846 tem
= get_keymap (def
, 0, 1);
7847 /* For a subkeymap, just record its details and exit. */
7850 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7851 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7855 /* At the top level in the menu bar, do likewise for commands also.
7856 The menu bar does not display equivalent key bindings anyway.
7857 ITEM_PROPERTY_DEF is already set up properly. */
7861 { /* This is a command. See if there is an equivalent key binding. */
7862 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7864 /* The previous code preferred :key-sequence to :keys, so we
7865 preserve this behavior. */
7866 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7867 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7870 Lisp_Object prefix
= keyeq
;
7871 Lisp_Object keys
= Qnil
;
7875 def
= XCAR (prefix
);
7876 prefix
= XCDR (prefix
);
7879 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7881 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7883 keys
= XCAR (keyhint
);
7884 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7886 /* We have a suggested key. Is it bound to the command? */
7889 /* If the command is an alias for another
7890 (such as lmenu.el set it up), check if the
7891 original command matches the cached command. */
7892 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7897 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7901 tem
= Fkey_description (keys
, Qnil
);
7904 if (STRINGP (XCAR (prefix
)))
7905 tem
= concat2 (XCAR (prefix
), tem
);
7906 if (STRINGP (XCDR (prefix
)))
7907 tem
= concat2 (tem
, XCDR (prefix
));
7909 keyeq
= concat2 (build_string (" "), tem
);
7910 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7916 /* If we have an equivalent key binding, use that. */
7917 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7920 /* Include this when menu help is implemented.
7921 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7922 if (!(NILP (tem) || STRINGP (tem)))
7924 tem = menu_item_eval_property (tem);
7927 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7931 /* Handle radio buttons or toggle boxes. */
7932 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7934 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7935 menu_item_eval_property (tem
));
7942 /***********************************************************************
7944 ***********************************************************************/
7946 /* A vector holding tool bar items while they are parsed in function
7947 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7950 static Lisp_Object tool_bar_items_vector
;
7952 /* A vector holding the result of parse_tool_bar_item. Layout is like
7953 the one for a single item in tool_bar_items_vector. */
7955 static Lisp_Object tool_bar_item_properties
;
7957 /* Next free index in tool_bar_items_vector. */
7959 static int ntool_bar_items
;
7961 /* The symbols `:image' and `:rtl'. */
7963 static Lisp_Object QCimage
;
7964 static Lisp_Object QCrtl
;
7966 /* Function prototypes. */
7968 static void init_tool_bar_items (Lisp_Object
);
7969 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7970 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7971 static void append_tool_bar_item (void);
7974 /* Return a vector of tool bar items for keymaps currently in effect.
7975 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7976 tool bar items found. */
7979 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7988 /* In order to build the menus, we need to call the keymap
7989 accessors. They all call QUIT. But this function is called
7990 during redisplay, during which a quit is fatal. So inhibit
7991 quitting while building the menus. We do this instead of
7992 specbind because (1) errors will clear it anyway and (2) this
7993 avoids risk of specpdl overflow. */
7994 oquit
= Vinhibit_quit
;
7997 /* Initialize tool_bar_items_vector and protect it from GC. */
7998 init_tool_bar_items (reuse
);
8000 /* Build list of keymaps in maps. Set nmaps to the number of maps
8003 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8004 if (!NILP (Voverriding_local_map_menu_flag
))
8006 /* Yes, use them (if non-nil) as well as the global map. */
8007 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8009 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8010 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8011 if (!NILP (Voverriding_local_map
))
8012 maps
[nmaps
++] = Voverriding_local_map
;
8016 /* No, so use major and minor mode keymaps and keymap property.
8017 Note that tool-bar bindings in the local-map and keymap
8018 properties may not work reliable, as they are only
8019 recognized when the tool-bar (or mode-line) is updated,
8020 which does not normally happen after every command. */
8023 nminor
= current_minor_maps (NULL
, &tmaps
);
8024 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8026 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8027 maps
[nmaps
++] = tem
;
8028 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8030 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8033 /* Add global keymap at the end. */
8034 maps
[nmaps
++] = current_global_map
;
8036 /* Process maps in reverse order and look up in each map the prefix
8038 for (i
= nmaps
- 1; i
>= 0; --i
)
8039 if (!NILP (maps
[i
]))
8043 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8045 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8048 Vinhibit_quit
= oquit
;
8049 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8050 return tool_bar_items_vector
;
8054 /* Process the definition of KEY which is DEF. */
8057 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8060 struct gcpro gcpro1
, gcpro2
;
8062 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8066 if (EQ (def
, Qundefined
))
8068 /* If a map has an explicit `undefined' as definition,
8069 discard any previously made item. */
8070 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8072 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8074 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8076 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8077 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8078 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8079 * sizeof (Lisp_Object
)));
8080 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8085 else if (parse_tool_bar_item (key
, def
))
8086 /* Append a new tool bar item to tool_bar_items_vector. Accept
8087 more than one definition for the same key. */
8088 append_tool_bar_item ();
8094 /* Parse a tool bar item specification ITEM for key KEY and return the
8095 result in tool_bar_item_properties. Value is zero if ITEM is
8098 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8100 CAPTION is the caption of the item, If it's not a string, it is
8101 evaluated to get a string.
8103 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8104 as binding are currently ignored.
8106 The following properties are recognized:
8110 FORM is evaluated and specifies whether the tool bar item is
8111 enabled or disabled.
8115 FORM is evaluated and specifies whether the tool bar item is visible.
8117 - `:filter FUNCTION'
8119 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8120 result is stored as the new binding.
8122 - `:button (TYPE SELECTED)'
8124 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8125 and specifies whether the button is selected (pressed) or not.
8129 IMAGES is either a single image specification or a vector of four
8130 image specifications. See enum tool_bar_item_images.
8132 - `:help HELP-STRING'.
8134 Gives a help string to display for the tool bar item.
8136 - `:label LABEL-STRING'.
8138 A text label to show with the tool bar button if labels are enabled. */
8141 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8143 /* Access slot with index IDX of vector tool_bar_item_properties. */
8144 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8146 Lisp_Object filter
= Qnil
;
8147 Lisp_Object caption
;
8148 int i
, have_label
= 0;
8150 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8151 Rule out items that aren't lists, don't start with
8152 `menu-item' or whose rest following `tool-bar-item' is not a
8157 /* As an exception, allow old-style menu separators. */
8158 if (STRINGP (XCAR (item
)))
8159 item
= Fcons (XCAR (item
), Qnil
);
8160 else if (!EQ (XCAR (item
), Qmenu_item
)
8161 || (item
= XCDR (item
), !CONSP (item
)))
8164 /* Create tool_bar_item_properties vector if necessary. Reset it to
8166 if (VECTORP (tool_bar_item_properties
))
8168 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8172 tool_bar_item_properties
8173 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8176 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8177 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8179 /* Get the caption of the item. If the caption is not a string,
8180 evaluate it to get a string. If we don't get a string, skip this
8182 caption
= XCAR (item
);
8183 if (!STRINGP (caption
))
8185 caption
= menu_item_eval_property (caption
);
8186 if (!STRINGP (caption
))
8189 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8191 /* If the rest following the caption is not a list, the menu item is
8192 either a separator, or invalid. */
8196 if (menu_separator_name_p (SSDATA (caption
)))
8198 PROP (TOOL_BAR_ITEM_TYPE
) = Qt
;
8199 #if !defined (USE_GTK) && !defined (HAVE_NS)
8200 /* If we use build_desired_tool_bar_string to render the
8201 tool bar, the separator is rendered as an image. */
8202 PROP (TOOL_BAR_ITEM_IMAGES
)
8203 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8204 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8205 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8206 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8213 /* Store the binding. */
8214 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8217 /* Ignore cached key binding, if any. */
8218 if (CONSP (item
) && CONSP (XCAR (item
)))
8221 /* Process the rest of the properties. */
8222 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8224 Lisp_Object ikey
, value
;
8227 value
= XCAR (XCDR (item
));
8229 if (EQ (ikey
, QCenable
))
8231 /* `:enable FORM'. */
8232 if (!NILP (Venable_disabled_menus_and_buttons
))
8233 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8235 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8237 else if (EQ (ikey
, QCvisible
))
8239 /* `:visible FORM'. If got a visible property and that
8240 evaluates to nil then ignore this item. */
8241 if (NILP (menu_item_eval_property (value
)))
8244 else if (EQ (ikey
, QChelp
))
8245 /* `:help HELP-STRING'. */
8246 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8247 else if (EQ (ikey
, QCvert_only
))
8248 /* `:vert-only t/nil'. */
8249 PROP (TOOL_BAR_ITEM_VERT_ONLY
) = value
;
8250 else if (EQ (ikey
, QClabel
))
8252 const char *bad_label
= "!!?GARBLED ITEM?!!";
8253 /* `:label LABEL-STRING'. */
8254 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8256 : build_string (bad_label
);
8259 else if (EQ (ikey
, QCfilter
))
8260 /* ':filter FORM'. */
8262 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8264 /* `:button (TYPE . SELECTED)'. */
8265 Lisp_Object type
, selected
;
8267 type
= XCAR (value
);
8268 selected
= XCDR (value
);
8269 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8271 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8272 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8275 else if (EQ (ikey
, QCimage
)
8277 || (VECTORP (value
) && ASIZE (value
) == 4)))
8278 /* Value is either a single image specification or a vector
8279 of 4 such specifications for the different button states. */
8280 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8281 else if (EQ (ikey
, QCrtl
))
8283 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8289 /* Try to make one from caption and key. */
8290 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8291 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8292 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8293 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8295 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8296 char *buf
= (char *) xmalloc (max_lbl
+ 1);
8297 Lisp_Object new_lbl
;
8298 ptrdiff_t caption_len
= strlen (capt
);
8300 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8303 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8305 buf
[caption_len
] = '\0';
8309 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8313 strcpy (buf
, label
);
8315 for (j
= 0; buf
[j
] != '\0'; ++j
)
8323 new_lbl
= Fupcase_initials (build_string (label
));
8324 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8325 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8327 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8331 /* If got a filter apply it on binding. */
8333 PROP (TOOL_BAR_ITEM_BINDING
)
8334 = menu_item_eval_property (list2 (filter
,
8336 PROP (TOOL_BAR_ITEM_BINDING
))));
8338 /* See if the binding is a keymap. Give up if it is. */
8339 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8342 /* Enable or disable selection of item. */
8343 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8344 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8345 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8347 /* Handle radio buttons or toggle boxes. */
8348 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8349 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8350 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8358 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8359 that can be reused. */
8362 init_tool_bar_items (Lisp_Object reuse
)
8364 if (VECTORP (reuse
))
8365 tool_bar_items_vector
= reuse
;
8367 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8368 ntool_bar_items
= 0;
8372 /* Append parsed tool bar item properties from
8373 tool_bar_item_properties */
8376 append_tool_bar_item (void)
8378 Lisp_Object
*to
, *from
;
8381 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8383 /* Enlarge tool_bar_items_vector if necessary. */
8385 tool_bar_items_vector
8386 = larger_vector (tool_bar_items_vector
, incr
, -1);
8388 /* Append entries from tool_bar_item_properties to the end of
8389 tool_bar_items_vector. */
8390 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8391 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8392 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8393 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8400 /* Read a character using menus based on maps in the array MAPS.
8401 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8402 Return t if we displayed a menu but the user rejected it.
8404 PREV_EVENT is the previous input event, or nil if we are reading
8405 the first event of a key sequence.
8407 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8408 if we used a mouse menu to read the input, or zero otherwise. If
8409 USED_MOUSE_MENU is null, we don't dereference it.
8411 The prompting is done based on the prompt-string of the map
8412 and the strings associated with various map elements.
8414 This can be done with X menus or with menus put in the minibuf.
8415 These are done in different ways, depending on how the input will be read.
8416 Menus using X are done after auto-saving in read-char, getting the input
8417 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8418 and do auto-saving in the inner call of read_char. */
8421 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8422 Lisp_Object prev_event
, int *used_mouse_menu
)
8426 if (used_mouse_menu
)
8427 *used_mouse_menu
= 0;
8429 /* Use local over global Menu maps */
8431 if (! menu_prompting
)
8434 /* Optionally disregard all but the global map. */
8435 if (inhibit_local_menu_bar_menus
)
8437 maps
+= (nmaps
- 1);
8442 /* If we got to this point via a mouse click,
8443 use a real menu for mouse selection. */
8444 if (EVENT_HAS_PARAMETERS (prev_event
)
8445 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8446 && !EQ (XCAR (prev_event
), Qtool_bar
))
8448 /* Display the menu and get the selection. */
8449 Lisp_Object
*realmaps
8450 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8452 ptrdiff_t nmaps1
= 0;
8454 /* Use the maps that are not nil. */
8455 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8456 if (!NILP (maps
[mapno
]))
8457 realmaps
[nmaps1
++] = maps
[mapno
];
8459 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8464 record_menu_key (XCAR (value
));
8466 /* If we got multiple events, unread all but
8468 There is no way to prevent those unread events
8469 from showing up later in last_nonmenu_event.
8470 So turn symbol and integer events into lists,
8471 to indicate that they came from a mouse menu,
8472 so that when present in last_nonmenu_event
8473 they won't confuse things. */
8474 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8476 record_menu_key (XCAR (tem
));
8477 if (SYMBOLP (XCAR (tem
))
8478 || INTEGERP (XCAR (tem
)))
8479 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8482 /* If we got more than one event, put all but the first
8483 onto this list to be read later.
8484 Return just the first event now. */
8485 Vunread_command_events
8486 = nconc2 (XCDR (value
), Vunread_command_events
);
8487 value
= XCAR (value
);
8489 else if (NILP (value
))
8491 if (used_mouse_menu
)
8492 *used_mouse_menu
= 1;
8495 #endif /* HAVE_MENUS */
8499 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8500 We make this bigger when necessary, and never free it. */
8501 static char *read_char_minibuf_menu_text
;
8502 /* Size of that buffer. */
8503 static ptrdiff_t read_char_minibuf_menu_width
;
8506 read_char_minibuf_menu_prompt (int commandflag
,
8507 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8510 register Lisp_Object name
;
8512 /* FIXME: Use the minibuffer's frame width. */
8513 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8516 Lisp_Object rest
, vector
;
8522 if (! menu_prompting
)
8525 /* Get the menu name from the first map that has one (a prompt string). */
8526 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8528 name
= Fkeymap_prompt (maps
[mapno
]);
8533 /* If we don't have any menus, just read a character normally. */
8534 if (!STRINGP (name
))
8537 /* Make sure we have a big enough buffer for the menu text. */
8538 width
= max (width
, SBYTES (name
));
8539 if (STRING_BYTES_BOUND
- 4 < width
)
8540 memory_full (SIZE_MAX
);
8541 if (width
+ 4 > read_char_minibuf_menu_width
)
8543 read_char_minibuf_menu_text
8544 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8545 read_char_minibuf_menu_width
= width
+ 4;
8547 menu
= read_char_minibuf_menu_text
;
8549 /* Prompt string always starts with map's prompt, and a space. */
8550 strcpy (menu
, SSDATA (name
));
8551 nlength
= SBYTES (name
);
8552 menu
[nlength
++] = ':';
8553 menu
[nlength
++] = ' ';
8556 /* Start prompting at start of first map. */
8560 /* Present the documented bindings, a line at a time. */
8564 ptrdiff_t i
= nlength
;
8566 Lisp_Object orig_defn_macro
;
8568 /* Loop over elements of map. */
8573 /* If reached end of map, start at beginning of next map. */
8577 /* At end of last map, wrap around to first map if just starting,
8578 or end this line if already have something on it. */
8582 if (notfirst
|| nobindings
) break;
8587 /* Look at the next element of the map. */
8589 elt
= XVECTOR (vector
)->contents
[idx
];
8591 elt
= Fcar_safe (rest
);
8593 if (idx
< 0 && VECTORP (elt
))
8595 /* If we found a dense table in the keymap,
8596 advanced past it, but start scanning its contents. */
8597 rest
= Fcdr_safe (rest
);
8603 /* An ordinary element. */
8604 Lisp_Object event
, tem
;
8608 event
= Fcar_safe (elt
); /* alist */
8609 elt
= Fcdr_safe (elt
);
8613 XSETINT (event
, idx
); /* vector */
8616 /* Ignore the element if it has no prompt string. */
8617 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8619 /* 1 if the char to type matches the string. */
8621 Lisp_Object upcased_event
, downcased_event
;
8622 Lisp_Object desc
= Qnil
;
8624 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8626 upcased_event
= Fupcase (event
);
8627 downcased_event
= Fdowncase (event
);
8628 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8629 || XINT (downcased_event
) == SREF (s
, 0));
8631 desc
= Fsingle_key_description (event
, Qnil
);
8633 #if 0 /* It is redundant to list the equivalent key bindings because
8634 the prefix is what the user has already typed. */
8636 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8638 /* Insert equivalent keybinding. */
8639 s
= concat2 (s
, tem
);
8642 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8643 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8645 /* Insert button prefix. */
8646 Lisp_Object selected
8647 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8648 if (EQ (tem
, QCradio
))
8649 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8651 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8652 s
= concat2 (tem
, s
);
8656 /* If we have room for the prompt string, add it to this line.
8657 If this is the first on the line, always add it. */
8658 if ((SCHARS (s
) + i
+ 2
8659 + (char_matches
? 0 : SCHARS (desc
) + 3))
8663 ptrdiff_t thiswidth
;
8665 /* Punctuate between strings. */
8668 strcpy (menu
+ i
, ", ");
8674 /* If the char to type doesn't match the string's
8675 first char, explicitly show what char to type. */
8678 /* Add as much of string as fits. */
8679 thiswidth
= min (SCHARS (desc
), width
- i
);
8680 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8682 strcpy (menu
+ i
, " = ");
8686 /* Add as much of string as fits. */
8687 thiswidth
= min (SCHARS (s
), width
- i
);
8688 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8694 /* If this element does not fit, end the line now,
8695 and save the element for the next line. */
8696 strcpy (menu
+ i
, "...");
8701 /* Move past this element. */
8702 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8703 /* Handle reaching end of dense table. */
8708 rest
= Fcdr_safe (rest
);
8712 /* Prompt with that and read response. */
8713 message2_nolog (menu
, strlen (menu
),
8714 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8716 /* Make believe its not a keyboard macro in case the help char
8717 is pressed. Help characters are not recorded because menu prompting
8718 is not used on replay.
8720 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8721 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
8723 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8724 while (BUFFERP (obj
));
8725 KVAR (current_kboard
, defining_kbd_macro
) = orig_defn_macro
;
8727 if (!INTEGERP (obj
))
8729 else if (XINT (obj
) == -2)
8732 if (! EQ (obj
, menu_prompt_more_char
)
8733 && (!INTEGERP (menu_prompt_more_char
)
8734 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8736 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8737 store_kbd_macro_char (obj
);
8740 /* Help char - go round again */
8744 /* Reading key sequences. */
8746 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8747 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8748 keymap, or nil otherwise. Return the index of the first keymap in
8749 which KEY has any binding, or NMAPS if no map has a binding.
8751 If KEY is a meta ASCII character, treat it like meta-prefix-char
8752 followed by the corresponding non-meta character. Keymaps in
8753 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8756 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8759 NEXT may be the same array as CURRENT. */
8762 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8763 Lisp_Object
*defs
, Lisp_Object
*next
)
8765 ptrdiff_t i
, first_binding
;
8767 first_binding
= nmaps
;
8768 for (i
= nmaps
- 1; i
>= 0; i
--)
8770 if (! NILP (current
[i
]))
8772 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8773 if (! NILP (defs
[i
]))
8780 /* Given the set of bindings we've found, produce the next set of maps. */
8781 if (first_binding
< nmaps
)
8782 for (i
= 0; i
< nmaps
; i
++)
8783 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8785 return first_binding
;
8788 /* Structure used to keep track of partial application of key remapping
8789 such as Vfunction_key_map and Vkey_translation_map. */
8790 typedef struct keyremap
8792 /* This is the map originally specified for this use. */
8794 /* This is a submap reached by looking up, in PARENT,
8795 the events from START to END. */
8797 /* Positions [START, END) in the key sequence buffer
8798 are the key that we have scanned so far.
8799 Those events are the ones that we will replace
8800 if PARENT maps them into a key sequence. */
8804 /* Lookup KEY in MAP.
8805 MAP is a keymap mapping keys to key vectors or functions.
8806 If the mapping is a function and DO_FUNCTION is non-zero, then
8807 the function is called with PROMPT as parameter and its return
8808 value is used as the return value of this function (after checking
8809 that it is indeed a vector). */
8812 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8817 next
= access_keymap (map
, key
, 1, 0, 1);
8819 /* Handle symbol with autoload definition. */
8820 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8821 && CONSP (XSYMBOL (next
)->function
)
8822 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8823 do_autoload (XSYMBOL (next
)->function
, next
);
8825 /* Handle a symbol whose function definition is a keymap
8827 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8828 && (ARRAYP (XSYMBOL (next
)->function
)
8829 || KEYMAPP (XSYMBOL (next
)->function
)))
8830 next
= XSYMBOL (next
)->function
;
8832 /* If the keymap gives a function, not an
8833 array, then call the function with one arg and use
8834 its value instead. */
8835 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8840 next
= call1 (next
, prompt
);
8841 /* If the function returned something invalid,
8842 barf--don't ignore it.
8843 (To ignore it safely, we would need to gcpro a bunch of
8844 other variables.) */
8845 if (! (VECTORP (next
) || STRINGP (next
)))
8846 error ("Function %s returns invalid key sequence",
8847 SSDATA (SYMBOL_NAME (tem
)));
8852 /* Do one step of the key remapping used for function-key-map and
8853 key-translation-map:
8854 KEYBUF is the buffer holding the input events.
8855 BUFSIZE is its maximum size.
8856 FKEY is a pointer to the keyremap structure to use.
8857 INPUT is the index of the last element in KEYBUF.
8858 DOIT if non-zero says that the remapping can actually take place.
8859 DIFF is used to return the number of keys added/removed by the remapping.
8860 PARENT is the root of the keymap.
8861 PROMPT is the prompt to use if the remapping happens through a function.
8862 The return value is non-zero if the remapping actually took place. */
8865 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8866 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8868 Lisp_Object next
, key
;
8870 key
= keybuf
[fkey
->end
++];
8872 if (KEYMAPP (fkey
->parent
))
8873 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8877 /* If keybuf[fkey->start..fkey->end] is bound in the
8878 map and we're in a position to do the key remapping, replace it with
8879 the binding and restart with fkey->start at the end. */
8880 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8882 int len
= XFASTINT (Flength (next
));
8885 *diff
= len
- (fkey
->end
- fkey
->start
);
8887 if (bufsize
- input
<= *diff
)
8888 error ("Key sequence too long");
8890 /* Shift the keys that follow fkey->end. */
8892 for (i
= fkey
->end
; i
< input
; i
++)
8893 keybuf
[i
+ *diff
] = keybuf
[i
];
8895 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8896 keybuf
[i
+ *diff
] = keybuf
[i
];
8897 /* Overwrite the old keys with the new ones. */
8898 for (i
= 0; i
< len
; i
++)
8899 keybuf
[fkey
->start
+ i
]
8900 = Faref (next
, make_number (i
));
8902 fkey
->start
= fkey
->end
+= *diff
;
8903 fkey
->map
= fkey
->parent
;
8908 fkey
->map
= get_keymap (next
, 0, 1);
8910 /* If we no longer have a bound suffix, try a new position for
8912 if (!CONSP (fkey
->map
))
8914 fkey
->end
= ++fkey
->start
;
8915 fkey
->map
= fkey
->parent
;
8921 test_undefined (Lisp_Object binding
)
8923 return (EQ (binding
, Qundefined
)
8924 || (!NILP (binding
) && SYMBOLP (binding
)
8925 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8928 /* Read a sequence of keys that ends with a non prefix character,
8929 storing it in KEYBUF, a buffer of size BUFSIZE.
8931 Return the length of the key sequence stored.
8932 Return -1 if the user rejected a command menu.
8934 Echo starting immediately unless `prompt' is 0.
8936 Where a key sequence ends depends on the currently active keymaps.
8937 These include any minor mode keymaps active in the current buffer,
8938 the current buffer's local map, and the global map.
8940 If a key sequence has no other bindings, we check Vfunction_key_map
8941 to see if some trailing subsequence might be the beginning of a
8942 function key's sequence. If so, we try to read the whole function
8943 key, and substitute its symbolic name into the key sequence.
8945 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8946 `double-' events into similar click events, if that would make them
8947 bound. We try to turn `triple-' events first into `double-' events,
8950 If we get a mouse click in a mode line, vertical divider, or other
8951 non-text area, we treat the click as if it were prefixed by the
8952 symbol denoting that area - `mode-line', `vertical-line', or
8955 If the sequence starts with a mouse click, we read the key sequence
8956 with respect to the buffer clicked on, not the current buffer.
8958 If the user switches frames in the midst of a key sequence, we put
8959 off the switch-frame event until later; the next call to
8960 read_char will return it.
8962 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8963 from the selected window's buffer. */
8966 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8967 int dont_downcase_last
, int can_return_switch_frame
,
8968 int fix_current_buffer
)
8970 Lisp_Object from_string
;
8971 ptrdiff_t count
= SPECPDL_INDEX ();
8973 /* How many keys there are in the current key sequence. */
8976 /* The length of the echo buffer when we started reading, and
8977 the length of this_command_keys when we started reading. */
8978 ptrdiff_t echo_start
IF_LINT (= 0);
8979 ptrdiff_t keys_start
;
8981 /* The number of keymaps we're scanning right now, and the number of
8982 keymaps we have allocated space for. */
8984 ptrdiff_t nmaps_allocated
= 0;
8986 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8987 the current keymaps. */
8988 Lisp_Object
*defs
= NULL
;
8990 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8991 in the current keymaps, or nil where it is not a prefix. */
8992 Lisp_Object
*submaps
= NULL
;
8994 /* The local map to start out with at start of key sequence. */
8995 Lisp_Object orig_local_map
;
8997 /* The map from the `keymap' property to start out with at start of
8999 Lisp_Object orig_keymap
;
9001 /* 1 if we have already considered switching to the local-map property
9002 of the place where a mouse click occurred. */
9003 int localized_local_map
= 0;
9005 /* The index in submaps[] of the first keymap that has a binding for
9006 this key sequence. In other words, the lowest i such that
9007 submaps[i] is non-nil. */
9008 ptrdiff_t first_binding
;
9009 /* Index of the first key that has no binding.
9010 It is useless to try fkey.start larger than that. */
9013 /* If t < mock_input, then KEYBUF[t] should be read as the next
9016 We use this to recover after recognizing a function key. Once we
9017 realize that a suffix of the current key sequence is actually a
9018 function key's escape sequence, we replace the suffix with the
9019 function key's binding from Vfunction_key_map. Now keybuf
9020 contains a new and different key sequence, so the echo area,
9021 this_command_keys, and the submaps and defs arrays are wrong. In
9022 this situation, we set mock_input to t, set t to 0, and jump to
9023 restart_sequence; the loop will read keys from keybuf up until
9024 mock_input, thus rebuilding the state; and then it will resume
9025 reading characters from the keyboard. */
9028 /* If the sequence is unbound in submaps[], then
9029 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9030 and fkey.map is its binding.
9032 These might be > t, indicating that all function key scanning
9033 should hold off until t reaches them. We do this when we've just
9034 recognized a function key, to avoid searching for the function
9035 key's again in Vfunction_key_map. */
9038 /* Likewise, for key_translation_map and input-decode-map. */
9039 keyremap keytran
, indec
;
9041 /* Non-zero if we are trying to map a key by changing an upper-case
9042 letter to lower case, or a shifted function key to an unshifted
9044 int shift_translated
= 0;
9046 /* If we receive a `switch-frame' or `select-window' event in the middle of
9047 a key sequence, we put it off for later.
9048 While we're reading, we keep the event here. */
9049 Lisp_Object delayed_switch_frame
;
9051 /* See the comment below... */
9052 #if defined (GOBBLE_FIRST_EVENT)
9053 Lisp_Object first_event
;
9056 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
9057 int original_uppercase_position
= -1;
9059 /* Gets around Microsoft compiler limitations. */
9062 struct buffer
*starting_buffer
;
9064 /* List of events for which a fake prefix key has been generated. */
9065 Lisp_Object fake_prefixed_keys
= Qnil
;
9067 #if defined (GOBBLE_FIRST_EVENT)
9071 struct gcpro gcpro1
;
9073 GCPRO1 (fake_prefixed_keys
);
9074 raw_keybuf_count
= 0;
9076 last_nonmenu_event
= Qnil
;
9078 delayed_switch_frame
= Qnil
;
9084 /* Install the string STR as the beginning of the string of
9085 echoing, so that it serves as a prompt for the next
9087 KVAR (current_kboard
, echo_string
) = prompt
;
9088 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9091 else if (cursor_in_echo_area
9092 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9093 && NILP (Fzerop (Vecho_keystrokes
)))
9094 /* This doesn't put in a dash if the echo buffer is empty, so
9095 you don't always see a dash hanging out in the minibuffer. */
9099 /* Record the initial state of the echo area and this_command_keys;
9100 we will need to restore them if we replay a key sequence. */
9102 echo_start
= echo_length ();
9103 keys_start
= this_command_key_count
;
9104 this_single_command_key_start
= keys_start
;
9106 #if defined (GOBBLE_FIRST_EVENT)
9107 /* This doesn't quite work, because some of the things that read_char
9108 does cannot safely be bypassed. It seems too risky to try to make
9111 /* Read the first char of the sequence specially, before setting
9112 up any keymaps, in case a filter runs and switches buffers on us. */
9113 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9115 #endif /* GOBBLE_FIRST_EVENT */
9117 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9118 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9121 /* We jump here when we need to reinitialize fkey and keytran; this
9122 happens if we switch keyboards between rescans. */
9123 replay_entire_sequence
:
9125 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9126 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9127 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9128 indec
.start
= indec
.end
= 0;
9129 fkey
.start
= fkey
.end
= 0;
9130 keytran
.start
= keytran
.end
= 0;
9132 /* We jump here when the key sequence has been thoroughly changed, and
9133 we need to rescan it starting from the beginning. When we jump here,
9134 keybuf[0..mock_input] holds the sequence we should reread. */
9137 starting_buffer
= current_buffer
;
9138 first_unbound
= bufsize
+ 1;
9140 /* Build our list of keymaps.
9141 If we recognize a function key and replace its escape sequence in
9142 keybuf with its symbol, or if the sequence starts with a mouse
9143 click and we need to switch buffers, we jump back here to rebuild
9144 the initial keymaps from the current buffer. */
9147 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9149 if (2 > nmaps_allocated
)
9151 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9152 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9153 nmaps_allocated
= 2;
9155 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9157 else if (!NILP (Voverriding_local_map
))
9159 if (2 > nmaps_allocated
)
9161 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9162 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9163 nmaps_allocated
= 2;
9165 submaps
[nmaps
++] = Voverriding_local_map
;
9173 nminor
= current_minor_maps (0, &maps
);
9174 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9176 if (total
> nmaps_allocated
)
9178 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9179 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9180 nmaps_allocated
= total
;
9183 if (!NILP (orig_keymap
))
9184 submaps
[nmaps
++] = orig_keymap
;
9186 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9190 submaps
[nmaps
++] = orig_local_map
;
9192 submaps
[nmaps
++] = current_global_map
;
9194 /* Find an accurate initial value for first_binding. */
9195 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9196 if (! NILP (submaps
[first_binding
]))
9199 /* Start from the beginning in keybuf. */
9202 /* These are no-ops the first time through, but if we restart, they
9203 revert the echo area and this_command_keys to their original state. */
9204 this_command_key_count
= keys_start
;
9205 if (INTERACTIVE
&& t
< mock_input
)
9206 echo_truncate (echo_start
);
9208 /* If the best binding for the current key sequence is a keymap, or
9209 we may be looking at a function key's escape sequence, keep on
9211 while (first_binding
< nmaps
9212 /* Keep reading as long as there's a prefix binding. */
9213 ? !NILP (submaps
[first_binding
])
9214 /* Don't return in the middle of a possible function key sequence,
9215 if the only bindings we found were via case conversion.
9216 Thus, if ESC O a has a function-key-map translation
9217 and ESC o has a binding, don't return after ESC O,
9218 so that we can translate ESC O plus the next character. */
9219 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9222 int used_mouse_menu
= 0;
9224 /* Where the last real key started. If we need to throw away a
9225 key that has expanded into more than one element of keybuf
9226 (say, a mouse click on the mode line which is being treated
9227 as [mode-line (mouse-...)], then we backtrack to this point
9229 int last_real_key_start
;
9231 /* These variables are analogous to echo_start and keys_start;
9232 while those allow us to restart the entire key sequence,
9233 echo_local_start and keys_local_start allow us to throw away
9235 ptrdiff_t echo_local_start
IF_LINT (= 0);
9236 int keys_local_start
;
9237 ptrdiff_t local_first_binding
;
9239 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9240 eassert (indec
.start
<= indec
.end
);
9241 eassert (fkey
.start
<= fkey
.end
);
9242 eassert (keytran
.start
<= keytran
.end
);
9243 /* key-translation-map is applied *after* function-key-map
9244 which is itself applied *after* input-decode-map. */
9245 eassert (fkey
.end
<= indec
.start
);
9246 eassert (keytran
.end
<= fkey
.start
);
9248 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9249 first_unbound
< keytran
.start
)
9250 { /* The prefix upto first_unbound has no binding and has
9251 no translation left to do either, so we know it's unbound.
9252 If we don't stop now, we risk staying here indefinitely
9253 (if the user keeps entering fkey or keytran prefixes
9254 like C-c ESC ESC ESC ESC ...) */
9256 for (i
= first_unbound
+ 1; i
< t
; i
++)
9257 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9258 mock_input
= t
- first_unbound
- 1;
9259 indec
.end
= indec
.start
-= first_unbound
+ 1;
9260 indec
.map
= indec
.parent
;
9261 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9262 fkey
.map
= fkey
.parent
;
9263 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9264 keytran
.map
= keytran
.parent
;
9265 goto replay_sequence
;
9269 error ("Key sequence too long");
9272 echo_local_start
= echo_length ();
9273 keys_local_start
= this_command_key_count
;
9274 local_first_binding
= first_binding
;
9277 /* These are no-ops, unless we throw away a keystroke below and
9278 jumped back up to replay_key; in that case, these restore the
9279 variables to their original state, allowing us to replay the
9281 if (INTERACTIVE
&& t
< mock_input
)
9282 echo_truncate (echo_local_start
);
9283 this_command_key_count
= keys_local_start
;
9284 first_binding
= local_first_binding
;
9286 /* By default, assume each event is "real". */
9287 last_real_key_start
= t
;
9289 /* Does mock_input indicate that we are re-reading a key sequence? */
9293 add_command_key (key
);
9294 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9295 && NILP (Fzerop (Vecho_keystrokes
)))
9299 /* If not, we should actually read a character. */
9303 KBOARD
*interrupted_kboard
= current_kboard
;
9304 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9305 key
= read_char (NILP (prompt
), nmaps
,
9306 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9307 &used_mouse_menu
, NULL
);
9308 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9309 /* When switching to a new tty (with a new keyboard),
9310 read_char returns the new buffer, rather than -2
9311 (Bug#5095). This is because `terminal-init-xterm'
9312 calls read-char, which eats the wrong_kboard_jmpbuf
9313 return. Any better way to fix this? -- cyd */
9314 || (interrupted_kboard
!= current_kboard
))
9319 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9320 if (k
== interrupted_kboard
)
9325 /* Don't touch interrupted_kboard when it's been
9327 delayed_switch_frame
= Qnil
;
9328 goto replay_entire_sequence
;
9331 if (!NILP (delayed_switch_frame
))
9333 KVAR (interrupted_kboard
, kbd_queue
)
9334 = Fcons (delayed_switch_frame
,
9335 KVAR (interrupted_kboard
, kbd_queue
));
9336 delayed_switch_frame
= Qnil
;
9340 KVAR (interrupted_kboard
, kbd_queue
)
9341 = Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
));
9343 /* If the side queue is non-empty, ensure it begins with a
9344 switch-frame, so we'll replay it in the right context. */
9345 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9346 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9347 !(EVENT_HAS_PARAMETERS (key
)
9348 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9352 XSETFRAME (frame
, interrupted_frame
);
9353 KVAR (interrupted_kboard
, kbd_queue
)
9354 = Fcons (make_lispy_switch_frame (frame
),
9355 KVAR (interrupted_kboard
, kbd_queue
));
9358 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9359 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9360 goto replay_entire_sequence
;
9364 /* read_char returns t when it shows a menu and the user rejects it.
9368 unbind_to (count
, Qnil
);
9373 /* read_char returns -1 at the end of a macro.
9374 Emacs 18 handles this by returning immediately with a
9375 zero, so that's what we'll do. */
9376 if (INTEGERP (key
) && XINT (key
) == -1)
9379 /* The Microsoft C compiler can't handle the goto that
9385 /* If the current buffer has been changed from under us, the
9386 keymap may have changed, so replay the sequence. */
9389 timer_resume_idle ();
9392 /* Reset the current buffer from the selected window
9393 in case something changed the former and not the latter.
9394 This is to be more consistent with the behavior
9395 of the command_loop_1. */
9396 if (fix_current_buffer
)
9398 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9400 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9401 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9404 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9405 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9406 goto replay_sequence
;
9409 /* If we have a quit that was typed in another frame, and
9410 quit_throw_to_read_char switched buffers,
9411 replay to get the right keymap. */
9413 && XINT (key
) == quit_char
9414 && current_buffer
!= starting_buffer
)
9417 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9421 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9422 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9423 goto replay_sequence
;
9428 if (EVENT_HAS_PARAMETERS (key
)
9429 /* Either a `switch-frame' or a `select-window' event. */
9430 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9432 /* If we're at the beginning of a key sequence, and the caller
9433 says it's okay, go ahead and return this event. If we're
9434 in the midst of a key sequence, delay it until the end. */
9435 if (t
> 0 || !can_return_switch_frame
)
9437 delayed_switch_frame
= key
;
9443 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9447 /* Clicks in non-text areas get prefixed by the symbol
9448 in their CHAR-ADDRESS field. For example, a click on
9449 the mode line is prefixed by the symbol `mode-line'.
9451 Furthermore, key sequences beginning with mouse clicks
9452 are read using the keymaps of the buffer clicked on, not
9453 the current buffer. So we may have to switch the buffer
9456 When we turn one event into two events, we must make sure
9457 that neither of the two looks like the original--so that,
9458 if we replay the events, they won't be expanded again.
9459 If not for this, such reexpansion could happen either here
9460 or when user programs play with this-command-keys. */
9461 if (EVENT_HAS_PARAMETERS (key
))
9466 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9467 if (EQ (kind
, Qmouse_click
))
9469 Lisp_Object window
, posn
;
9471 window
= POSN_WINDOW (EVENT_START (key
));
9472 posn
= POSN_POSN (EVENT_START (key
));
9475 || (!NILP (fake_prefixed_keys
)
9476 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9478 /* We're looking a second time at an event for which
9479 we generated a fake prefix key. Set
9480 last_real_key_start appropriately. */
9482 last_real_key_start
= t
- 1;
9485 if (last_real_key_start
== 0)
9487 /* Key sequences beginning with mouse clicks are
9488 read using the keymaps in the buffer clicked on,
9489 not the current buffer. If we're at the
9490 beginning of a key sequence, switch buffers. */
9491 if (WINDOWP (window
)
9492 && BUFFERP (XWINDOW (window
)->buffer
)
9493 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9495 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9499 /* Arrange to go back to the original buffer once we're
9500 done reading the key sequence. Note that we can't
9501 use save_excursion_{save,restore} here, because they
9502 save point as well as the current buffer; we don't
9503 want to save point, because redisplay may change it,
9504 to accommodate a Fset_window_start or something. We
9505 don't want to do this at the top of the function,
9506 because we may get input from a subprocess which
9507 wants to change the selected window and stuff (say,
9509 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9511 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9513 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9514 orig_local_map
= get_local_map (PT
, current_buffer
,
9516 orig_keymap
= get_local_map (PT
, current_buffer
,
9518 goto replay_sequence
;
9521 /* For a mouse click, get the local text-property keymap
9522 of the place clicked on, rather than point. */
9523 if (CONSP (XCDR (key
))
9524 && ! localized_local_map
)
9526 Lisp_Object map_here
, start
, pos
;
9528 localized_local_map
= 1;
9529 start
= EVENT_START (key
);
9531 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9533 pos
= POSN_BUFFER_POSN (start
);
9535 && XINT (pos
) >= BEGV
9536 && XINT (pos
) <= ZV
)
9538 map_here
= get_local_map (XINT (pos
),
9541 if (!EQ (map_here
, orig_local_map
))
9543 orig_local_map
= map_here
;
9544 ++localized_local_map
;
9547 map_here
= get_local_map (XINT (pos
),
9550 if (!EQ (map_here
, orig_keymap
))
9552 orig_keymap
= map_here
;
9553 ++localized_local_map
;
9556 if (localized_local_map
> 1)
9561 goto replay_sequence
;
9568 /* Expand mode-line and scroll-bar events into two events:
9569 use posn as a fake prefix key. */
9571 && (NILP (fake_prefixed_keys
)
9572 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9574 if (bufsize
- t
<= 1)
9575 error ("Key sequence too long");
9578 keybuf
[t
+ 1] = key
;
9581 /* Record that a fake prefix key has been generated
9582 for KEY. Don't modify the event; this would
9583 prevent proper action when the event is pushed
9584 back into unread-command-events. */
9585 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9587 /* If on a mode line string with a local keymap,
9588 reconsider the key sequence with that keymap. */
9589 if (string
= POSN_STRING (EVENT_START (key
)),
9590 (CONSP (string
) && STRINGP (XCAR (string
))))
9592 Lisp_Object pos
, map
, map2
;
9594 pos
= XCDR (string
);
9595 string
= XCAR (string
);
9597 && XINT (pos
) < SCHARS (string
))
9599 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9601 orig_local_map
= map
;
9602 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9605 if (!NILP (map
) || !NILP (map2
))
9606 goto replay_sequence
;
9612 else if (NILP (from_string
)
9613 && (string
= POSN_STRING (EVENT_START (key
)),
9614 (CONSP (string
) && STRINGP (XCAR (string
)))))
9616 /* For a click on a string, i.e. overlay string or a
9617 string displayed via the `display' property,
9618 consider `local-map' and `keymap' properties of
9620 Lisp_Object pos
, map
, map2
;
9622 pos
= XCDR (string
);
9623 string
= XCAR (string
);
9625 && XINT (pos
) < SCHARS (string
))
9627 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9629 orig_local_map
= map
;
9630 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9634 if (!NILP (map
) || !NILP (map2
))
9636 from_string
= string
;
9639 goto replay_sequence
;
9644 else if (CONSP (XCDR (key
))
9645 && CONSP (EVENT_START (key
))
9646 && CONSP (XCDR (EVENT_START (key
))))
9650 posn
= POSN_POSN (EVENT_START (key
));
9651 /* Handle menu-bar events:
9652 insert the dummy prefix event `menu-bar'. */
9653 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9655 if (bufsize
- t
<= 1)
9656 error ("Key sequence too long");
9660 /* Zap the position in key, so we know that we've
9661 expanded it, and don't try to do so again. */
9662 POSN_SET_POSN (EVENT_START (key
),
9663 Fcons (posn
, Qnil
));
9666 goto replay_sequence
;
9668 else if (CONSP (posn
))
9670 /* We're looking at the second event of a
9671 sequence which we expanded before. Set
9672 last_real_key_start appropriately. */
9673 if (last_real_key_start
== t
&& t
> 0)
9674 last_real_key_start
= t
- 1;
9679 /* We have finally decided that KEY is something we might want
9681 first_binding
= (follow_key (key
,
9682 nmaps
- first_binding
,
9683 submaps
+ first_binding
,
9684 defs
+ first_binding
,
9685 submaps
+ first_binding
)
9688 /* If KEY wasn't bound, we'll try some fallbacks. */
9689 if (first_binding
< nmaps
)
9690 /* This is needed for the following scenario:
9691 event 0: a down-event that gets dropped by calling replay_key.
9692 event 1: some normal prefix like C-h.
9693 After event 0, first_unbound is 0, after event 1 indec.start,
9694 fkey.start, and keytran.start are all 1, so when we see that
9695 C-h is bound, we need to update first_unbound. */
9696 first_unbound
= max (t
+ 1, first_unbound
);
9701 /* Remember the position to put an upper bound on indec.start. */
9702 first_unbound
= min (t
, first_unbound
);
9704 head
= EVENT_HEAD (key
);
9705 if (help_char_p (head
) && t
> 0)
9707 read_key_sequence_cmd
= Vprefix_help_command
;
9709 last_nonmenu_event
= key
;
9710 /* The Microsoft C compiler can't handle the goto that
9718 Lisp_Object breakdown
;
9721 breakdown
= parse_modifiers (head
);
9722 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9723 /* Attempt to reduce an unbound mouse event to a simpler
9724 event that is bound:
9725 Drags reduce to clicks.
9726 Double-clicks reduce to clicks.
9727 Triple-clicks reduce to double-clicks, then to clicks.
9728 Down-clicks are eliminated.
9729 Double-downs reduce to downs, then are eliminated.
9730 Triple-downs reduce to double-downs, then to downs,
9731 then are eliminated. */
9732 if (modifiers
& (down_modifier
| drag_modifier
9733 | double_modifier
| triple_modifier
))
9735 while (modifiers
& (down_modifier
| drag_modifier
9736 | double_modifier
| triple_modifier
))
9738 Lisp_Object new_head
, new_click
;
9739 if (modifiers
& triple_modifier
)
9740 modifiers
^= (double_modifier
| triple_modifier
);
9741 else if (modifiers
& double_modifier
)
9742 modifiers
&= ~double_modifier
;
9743 else if (modifiers
& drag_modifier
)
9744 modifiers
&= ~drag_modifier
;
9747 /* Dispose of this `down' event by simply jumping
9748 back to replay_key, to get another event.
9750 Note that if this event came from mock input,
9751 then just jumping back to replay_key will just
9752 hand it to us again. So we have to wipe out any
9755 We could delete keybuf[t] and shift everything
9756 after that to the left by one spot, but we'd also
9757 have to fix up any variable that points into
9758 keybuf, and shifting isn't really necessary
9761 Adding prefixes for non-textual mouse clicks
9762 creates two characters of mock input, and both
9763 must be thrown away. If we're only looking at
9764 the prefix now, we can just jump back to
9765 replay_key. On the other hand, if we've already
9766 processed the prefix, and now the actual click
9767 itself is giving us trouble, then we've lost the
9768 state of the keymaps we want to backtrack to, and
9769 we need to replay the whole sequence to rebuild
9772 Beyond that, only function key expansion could
9773 create more than two keys, but that should never
9774 generate mouse events, so it's okay to zero
9775 mock_input in that case too.
9777 FIXME: The above paragraph seems just plain
9778 wrong, if you consider things like
9779 xterm-mouse-mode. -stef
9781 Isn't this just the most wonderful code ever? */
9783 /* If mock_input > t + 1, the above simplification
9784 will actually end up dropping keys on the floor.
9785 This is probably OK for now, but even
9786 if mock_input <= t + 1, we need to adjust indec,
9788 Typical case [header-line down-mouse-N]:
9789 mock_input = 2, t = 1, fkey.end = 1,
9790 last_real_key_start = 0. */
9791 if (indec
.end
> last_real_key_start
)
9793 indec
.end
= indec
.start
9794 = min (last_real_key_start
, indec
.start
);
9795 indec
.map
= indec
.parent
;
9796 if (fkey
.end
> last_real_key_start
)
9798 fkey
.end
= fkey
.start
9799 = min (last_real_key_start
, fkey
.start
);
9800 fkey
.map
= fkey
.parent
;
9801 if (keytran
.end
> last_real_key_start
)
9803 keytran
.end
= keytran
.start
9804 = min (last_real_key_start
, keytran
.start
);
9805 keytran
.map
= keytran
.parent
;
9809 if (t
== last_real_key_start
)
9816 mock_input
= last_real_key_start
;
9817 goto replay_sequence
;
9822 = apply_modifiers (modifiers
, XCAR (breakdown
));
9824 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9826 /* Look for a binding for this new key. follow_key
9827 promises that it didn't munge submaps the
9828 last time we called it, since key was unbound. */
9830 = (follow_key (new_click
,
9831 nmaps
- local_first_binding
,
9832 submaps
+ local_first_binding
,
9833 defs
+ local_first_binding
,
9834 submaps
+ local_first_binding
)
9835 + local_first_binding
);
9837 /* If that click is bound, go for it. */
9838 if (first_binding
< nmaps
)
9843 /* Otherwise, we'll leave key set to the drag event. */
9850 /* Normally, last_nonmenu_event gets the previous key we read.
9851 But when a mouse popup menu is being used,
9852 we don't update last_nonmenu_event; it continues to hold the mouse
9853 event that preceded the first level of menu. */
9854 if (!used_mouse_menu
)
9855 last_nonmenu_event
= key
;
9857 /* Record what part of this_command_keys is the current key sequence. */
9858 this_single_command_key_start
= this_command_key_count
- t
;
9860 /* Look for this sequence in input-decode-map.
9861 Scan from indec.end until we find a bound suffix. */
9862 while (indec
.end
< t
)
9864 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9867 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9868 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9873 mock_input
= diff
+ max (t
, mock_input
);
9874 goto replay_sequence
;
9878 if (first_binding
< nmaps
9879 && NILP (submaps
[first_binding
])
9880 && !test_undefined (defs
[first_binding
])
9881 && indec
.start
>= t
)
9882 /* There is a binding and it's not a prefix.
9883 (and it doesn't have any input-decode-map translation pending).
9884 There is thus no function-key in this sequence.
9885 Moving fkey.start is important in this case to allow keytran.start
9886 to go over the sequence before we return (since we keep the
9887 invariant that keytran.end <= fkey.start). */
9890 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9893 /* If the sequence is unbound, see if we can hang a function key
9894 off the end of it. */
9895 /* Continue scan from fkey.end until we find a bound suffix. */
9896 while (fkey
.end
< indec
.start
)
9898 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9901 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9902 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9903 max (t
, mock_input
),
9904 /* If there's a binding (i.e.
9905 first_binding >= nmaps) we don't want
9906 to apply this function-key-mapping. */
9908 && (first_binding
>= nmaps
9909 || test_undefined (defs
[first_binding
])),
9914 mock_input
= diff
+ max (t
, mock_input
);
9915 /* Adjust the input-decode-map counters. */
9917 indec
.start
+= diff
;
9919 goto replay_sequence
;
9923 /* Look for this sequence in key-translation-map.
9924 Scan from keytran.end until we find a bound suffix. */
9925 while (keytran
.end
< fkey
.start
)
9927 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9930 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9931 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9936 mock_input
= diff
+ max (t
, mock_input
);
9937 /* Adjust the function-key-map and input-decode-map counters. */
9939 indec
.start
+= diff
;
9943 goto replay_sequence
;
9947 /* If KEY is not defined in any of the keymaps,
9948 and cannot be part of a function key or translation,
9949 and is an upper case letter
9950 use the corresponding lower-case letter instead. */
9951 if (first_binding
>= nmaps
9952 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9954 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9955 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9956 || (XINT (key
) & shift_modifier
)))
9958 Lisp_Object new_key
;
9960 original_uppercase
= key
;
9961 original_uppercase_position
= t
- 1;
9963 if (XINT (key
) & shift_modifier
)
9964 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9966 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9967 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9969 /* We have to do this unconditionally, regardless of whether
9970 the lower-case char is defined in the keymaps, because they
9971 might get translated through function-key-map. */
9972 keybuf
[t
- 1] = new_key
;
9973 mock_input
= max (t
, mock_input
);
9974 shift_translated
= 1;
9976 goto replay_sequence
;
9978 /* If KEY is not defined in any of the keymaps,
9979 and cannot be part of a function key or translation,
9980 and is a shifted function key,
9981 use the corresponding unshifted function key instead. */
9982 if (first_binding
>= nmaps
9983 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9985 Lisp_Object breakdown
= parse_modifiers (key
);
9987 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9989 if (modifiers
& shift_modifier
9990 /* Treat uppercase keys as shifted. */
9992 && (KEY_TO_CHAR (key
)
9993 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9994 && uppercasep (KEY_TO_CHAR (key
))))
9997 = (modifiers
& shift_modifier
9998 ? apply_modifiers (modifiers
& ~shift_modifier
,
10000 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
10002 original_uppercase
= key
;
10003 original_uppercase_position
= t
- 1;
10005 /* We have to do this unconditionally, regardless of whether
10006 the lower-case char is defined in the keymaps, because they
10007 might get translated through function-key-map. */
10008 keybuf
[t
- 1] = new_key
;
10009 mock_input
= max (t
, mock_input
);
10010 /* Reset fkey (and consequently keytran) to apply
10011 function-key-map on the result, so that S-backspace is
10012 correctly mapped to DEL (via backspace). OTOH,
10013 input-decode-map doesn't need to go through it again. */
10014 fkey
.start
= fkey
.end
= 0;
10015 keytran
.start
= keytran
.end
= 0;
10016 shift_translated
= 1;
10018 goto replay_sequence
;
10023 read_key_sequence_cmd
= (first_binding
< nmaps
10024 ? defs
[first_binding
]
10026 read_key_sequence_remapped
10027 /* Remap command through active keymaps.
10028 Do the remapping here, before the unbind_to so it uses the keymaps
10029 of the appropriate buffer. */
10030 = SYMBOLP (read_key_sequence_cmd
)
10031 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
10034 unread_switch_frame
= delayed_switch_frame
;
10035 unbind_to (count
, Qnil
);
10037 /* Don't downcase the last character if the caller says don't.
10038 Don't downcase it if the result is undefined, either. */
10039 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10041 && t
- 1 == original_uppercase_position
)
10043 keybuf
[t
- 1] = original_uppercase
;
10044 shift_translated
= 0;
10047 if (shift_translated
)
10048 Vthis_command_keys_shift_translated
= Qt
;
10050 /* Occasionally we fabricate events, perhaps by expanding something
10051 according to function-key-map, or by adding a prefix symbol to a
10052 mouse click in the scroll bar or modeline. In this cases, return
10053 the entire generated key sequence, even if we hit an unbound
10054 prefix or a definition before the end. This means that you will
10055 be able to push back the event properly, and also means that
10056 read-key-sequence will always return a logical unit.
10059 for (; t
< mock_input
; t
++)
10061 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10062 && NILP (Fzerop (Vecho_keystrokes
)))
10063 echo_char (keybuf
[t
]);
10064 add_command_key (keybuf
[t
]);
10071 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10072 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10073 The sequence is sufficient to specify a non-prefix command in the
10074 current local and global maps.
10076 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10077 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10078 as a continuation of the previous key.
10080 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10081 convert the last event to lower case. (Normally any upper case event
10082 is converted to lower case if the original event is undefined and the lower
10083 case equivalent is defined.) A non-nil value is appropriate for reading
10084 a key sequence to be defined.
10086 A C-g typed while in this function is treated like any other character,
10087 and `quit-flag' is not set.
10089 If the key sequence starts with a mouse click, then the sequence is read
10090 using the keymaps of the buffer of the window clicked in, not the buffer
10091 of the selected window as normal.
10093 `read-key-sequence' drops unbound button-down events, since you normally
10094 only care about the click or drag events which follow them. If a drag
10095 or multi-click event is unbound, but the corresponding click event would
10096 be bound, `read-key-sequence' turns the event into a click event at the
10097 drag's starting position. This means that you don't have to distinguish
10098 between click and drag, double, or triple events unless you want to.
10100 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10101 lines separating windows, and scroll bars with imaginary keys
10102 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10104 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10105 function will process a switch-frame event if the user switches frames
10106 before typing anything. If the user switches frames in the middle of a
10107 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10108 is nil, then the event will be put off until after the current key sequence.
10110 `read-key-sequence' checks `function-key-map' for function key
10111 sequences, where they wouldn't conflict with ordinary bindings. See
10112 `function-key-map' for more details.
10114 The optional fifth argument CMD-LOOP, if non-nil, means
10115 that this key sequence is being read by something that will
10116 read commands one after another. It should be nil if the caller
10117 will read just one key sequence. */)
10118 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10120 Lisp_Object keybuf
[30];
10122 struct gcpro gcpro1
;
10123 ptrdiff_t count
= SPECPDL_INDEX ();
10125 if (!NILP (prompt
))
10126 CHECK_STRING (prompt
);
10129 specbind (Qinput_method_exit_on_first_char
,
10130 (NILP (cmd_loop
) ? Qt
: Qnil
));
10131 specbind (Qinput_method_use_echo_area
,
10132 (NILP (cmd_loop
) ? Qt
: Qnil
));
10134 memset (keybuf
, 0, sizeof keybuf
);
10135 GCPRO1 (keybuf
[0]);
10136 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10138 if (NILP (continue_echo
))
10140 this_command_key_count
= 0;
10141 this_command_key_count_reset
= 0;
10142 this_single_command_key_start
= 0;
10145 #ifdef HAVE_WINDOW_SYSTEM
10146 if (display_hourglass_p
)
10147 cancel_hourglass ();
10150 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10151 prompt
, ! NILP (dont_downcase_last
),
10152 ! NILP (can_return_switch_frame
), 0);
10154 #if 0 /* The following is fine for code reading a key sequence and
10155 then proceeding with a lengthy computation, but it's not good
10156 for code reading keys in a loop, like an input method. */
10157 #ifdef HAVE_WINDOW_SYSTEM
10158 if (display_hourglass_p
)
10159 start_hourglass ();
10169 return unbind_to (count
, make_event_array (i
, keybuf
));
10172 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10173 Sread_key_sequence_vector
, 1, 5, 0,
10174 doc
: /* Like `read-key-sequence' but always return a vector. */)
10175 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10177 Lisp_Object keybuf
[30];
10179 struct gcpro gcpro1
;
10180 ptrdiff_t count
= SPECPDL_INDEX ();
10182 if (!NILP (prompt
))
10183 CHECK_STRING (prompt
);
10186 specbind (Qinput_method_exit_on_first_char
,
10187 (NILP (cmd_loop
) ? Qt
: Qnil
));
10188 specbind (Qinput_method_use_echo_area
,
10189 (NILP (cmd_loop
) ? Qt
: Qnil
));
10191 memset (keybuf
, 0, sizeof keybuf
);
10192 GCPRO1 (keybuf
[0]);
10193 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10195 if (NILP (continue_echo
))
10197 this_command_key_count
= 0;
10198 this_command_key_count_reset
= 0;
10199 this_single_command_key_start
= 0;
10202 #ifdef HAVE_WINDOW_SYSTEM
10203 if (display_hourglass_p
)
10204 cancel_hourglass ();
10207 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10208 prompt
, ! NILP (dont_downcase_last
),
10209 ! NILP (can_return_switch_frame
), 0);
10211 #ifdef HAVE_WINDOW_SYSTEM
10212 if (display_hourglass_p
)
10213 start_hourglass ();
10222 return unbind_to (count
, Fvector (i
, keybuf
));
10225 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10226 doc
: /* Execute CMD as an editor command.
10227 CMD must be a symbol that satisfies the `commandp' predicate.
10228 Optional second arg RECORD-FLAG non-nil
10229 means unconditionally put this command in `command-history'.
10230 Otherwise, that is done only if an arg is read using the minibuffer.
10231 The argument KEYS specifies the value to use instead of (this-command-keys)
10232 when reading the arguments; if it is nil, (this-command-keys) is used.
10233 The argument SPECIAL, if non-nil, means that this command is executing
10234 a special event, so ignore the prefix argument and don't clear it. */)
10235 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10237 register Lisp_Object final
;
10238 register Lisp_Object tem
;
10239 Lisp_Object prefixarg
;
10241 debug_on_next_call
= 0;
10243 if (NILP (special
))
10245 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10246 Vcurrent_prefix_arg
= prefixarg
;
10247 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
10254 tem
= Fget (cmd
, Qdisabled
);
10257 tem
= Fsymbol_value (Qdisabled_command_function
);
10259 return Frun_hooks (1, &Qdisabled_command_function
);
10265 final
= Findirect_function (cmd
, Qnil
);
10267 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10269 struct gcpro gcpro1
, gcpro2
;
10271 GCPRO2 (cmd
, prefixarg
);
10272 do_autoload (final
, cmd
);
10279 if (STRINGP (final
) || VECTORP (final
))
10281 /* If requested, place the macro in the command history. For
10282 other sorts of commands, call-interactively takes care of
10284 if (!NILP (record_flag
))
10287 = Fcons (Fcons (Qexecute_kbd_macro
,
10288 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10291 /* Don't keep command history around forever. */
10292 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10294 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10296 XSETCDR (tem
, Qnil
);
10300 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10303 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10304 /* Don't call Fcall_interactively directly because we want to make
10305 sure the backtrace has an entry for `call-interactively'.
10306 For the same reason, pass `cmd' rather than `final'. */
10307 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10314 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10316 doc
: /* Read function name, then read its arguments and call it.
10318 To pass a numeric argument to the command you are invoking with, specify
10319 the numeric argument to this command.
10321 Noninteractively, the argument PREFIXARG is the prefix argument to
10322 give to the command you invoke, if it asks for an argument. */)
10323 (Lisp_Object prefixarg
)
10325 Lisp_Object function
;
10326 ptrdiff_t saved_last_point_position
;
10327 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10328 Lisp_Object bindings
, value
;
10329 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10330 #ifdef HAVE_WINDOW_SYSTEM
10331 /* The call to Fcompleting_read will start and cancel the hourglass,
10332 but if the hourglass was already scheduled, this means that no
10333 hourglass will be shown for the actual M-x command itself.
10334 So we restart it if it is already scheduled. Note that checking
10335 hourglass_shown_p is not enough, normally the hourglass is not shown,
10336 just scheduled to be shown. */
10337 int hstarted
= hourglass_started ();
10340 saved_keys
= Fvector (this_command_key_count
,
10341 XVECTOR (this_command_keys
)->contents
);
10342 saved_last_point_position_buffer
= last_point_position_buffer
;
10343 saved_last_point_position
= last_point_position
;
10344 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10346 function
= call0 (intern ("read-extended-command"));
10348 #ifdef HAVE_WINDOW_SYSTEM
10349 if (hstarted
) start_hourglass ();
10352 if (STRINGP (function
) && SCHARS (function
) == 0)
10353 error ("No command name given");
10355 /* Set this_command_keys to the concatenation of saved_keys and
10356 function, followed by a RET. */
10361 this_command_key_count
= 0;
10362 this_command_key_count_reset
= 0;
10363 this_single_command_key_start
= 0;
10365 keys
= XVECTOR (saved_keys
)->contents
;
10366 for (i
= 0; i
< ASIZE (saved_keys
); i
++)
10367 add_command_key (keys
[i
]);
10369 for (i
= 0; i
< SCHARS (function
); i
++)
10370 add_command_key (Faref (function
, make_number (i
)));
10372 add_command_key (make_number ('\015'));
10375 last_point_position
= saved_last_point_position
;
10376 last_point_position_buffer
= saved_last_point_position_buffer
;
10380 function
= Fintern (function
, Qnil
);
10381 KVAR (current_kboard
, Vprefix_arg
) = prefixarg
;
10382 Vthis_command
= function
;
10383 real_this_command
= function
;
10385 /* If enabled, show which key runs this command. */
10386 if (!NILP (Vsuggest_key_bindings
)
10387 && NILP (Vexecuting_kbd_macro
)
10388 && SYMBOLP (function
))
10389 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10395 GCPRO3 (bindings
, value
, function
);
10396 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10398 /* If the command has a key binding, print it now. */
10399 if (!NILP (bindings
)
10400 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10403 /* But first wait, and skip the message if there is input. */
10404 Lisp_Object waited
;
10406 /* If this command displayed something in the echo area;
10407 wait a few seconds, then display our suggestion message. */
10408 if (NILP (echo_area_buffer
[0]))
10409 waited
= sit_for (make_number (0), 0, 2);
10410 else if (NUMBERP (Vsuggest_key_bindings
))
10411 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10413 waited
= sit_for (make_number (2), 0, 2);
10415 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10417 Lisp_Object binding
;
10419 int message_p
= push_message ();
10420 ptrdiff_t count
= SPECPDL_INDEX ();
10421 ptrdiff_t newmessage_len
, newmessage_alloc
;
10424 record_unwind_protect (pop_message_unwind
, Qnil
);
10425 binding
= Fkey_description (bindings
, Qnil
);
10427 (sizeof "You can run the command `' with "
10428 + SBYTES (SYMBOL_NAME (function
)) + SBYTES (binding
));
10429 SAFE_ALLOCA (newmessage
, char *, newmessage_alloc
);
10431 esprintf (newmessage
, "You can run the command `%s' with %s",
10432 SDATA (SYMBOL_NAME (function
)),
10434 message2 (newmessage
,
10436 STRING_MULTIBYTE (binding
));
10437 if (NUMBERP (Vsuggest_key_bindings
))
10438 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10440 waited
= sit_for (make_number (2), 0, 2);
10442 if (!NILP (waited
) && message_p
)
10443 restore_message ();
10446 unbind_to (count
, Qnil
);
10450 RETURN_UNGCPRO (value
);
10454 /* Return nonzero if input events are pending. */
10457 detect_input_pending (void)
10459 if (!input_pending
)
10460 get_input_pending (&input_pending
, 0);
10462 return input_pending
;
10465 /* Return nonzero if input events other than mouse movements are
10469 detect_input_pending_ignore_squeezables (void)
10471 if (!input_pending
)
10472 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10474 return input_pending
;
10477 /* Return nonzero if input events are pending, and run any pending timers. */
10480 detect_input_pending_run_timers (int do_display
)
10482 int old_timers_run
= timers_run
;
10484 if (!input_pending
)
10485 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10487 if (old_timers_run
!= timers_run
&& do_display
)
10489 redisplay_preserve_echo_area (8);
10490 /* The following fixes a bug when using lazy-lock with
10491 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10492 from an idle timer function. The symptom of the bug is that
10493 the cursor sometimes doesn't become visible until the next X
10494 event is processed. --gerd. */
10496 Lisp_Object tail
, frame
;
10497 FOR_EACH_FRAME (tail
, frame
)
10498 if (FRAME_RIF (XFRAME (frame
)))
10499 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10503 return input_pending
;
10506 /* This is called in some cases before a possible quit.
10507 It cases the next call to detect_input_pending to recompute input_pending.
10508 So calling this function unnecessarily can't do any harm. */
10511 clear_input_pending (void)
10516 /* Return nonzero if there are pending requeued events.
10517 This isn't used yet. The hope is to make wait_reading_process_output
10518 call it, and return if it runs Lisp code that unreads something.
10519 The problem is, kbd_buffer_get_event needs to be fixed to know what
10520 to do in that case. It isn't trivial. */
10523 requeued_events_pending_p (void)
10525 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10529 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10530 doc
: /* Return t if command input is currently available with no wait.
10531 Actually, the value is nil only if we can be sure that no input is available;
10532 if there is a doubt, the value is t. */)
10535 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10536 || !NILP (Vunread_post_input_method_events
)
10537 || !NILP (Vunread_input_method_events
))
10540 /* Process non-user-visible events (Bug#10195). */
10541 process_special_events ();
10543 get_input_pending (&input_pending
,
10544 READABLE_EVENTS_DO_TIMERS_NOW
10545 | READABLE_EVENTS_FILTER_EVENTS
);
10546 return input_pending
> 0 ? Qt
: Qnil
;
10549 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10550 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10553 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10556 if (total_keys
< NUM_RECENT_KEYS
)
10557 return Fvector (total_keys
, keys
);
10560 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10561 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10562 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10563 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10564 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10569 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10570 doc
: /* Return the key sequence that invoked this command.
10571 However, if the command has called `read-key-sequence', it returns
10572 the last key sequence that has been read.
10573 The value is a string or a vector.
10575 See also `this-command-keys-vector'. */)
10578 return make_event_array (this_command_key_count
,
10579 XVECTOR (this_command_keys
)->contents
);
10582 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10583 doc
: /* Return the key sequence that invoked this command, as a vector.
10584 However, if the command has called `read-key-sequence', it returns
10585 the last key sequence that has been read.
10587 See also `this-command-keys'. */)
10590 return Fvector (this_command_key_count
,
10591 XVECTOR (this_command_keys
)->contents
);
10594 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10595 Sthis_single_command_keys
, 0, 0, 0,
10596 doc
: /* Return the key sequence that invoked this command.
10597 More generally, it returns the last key sequence read, either by
10598 the command loop or by `read-key-sequence'.
10599 Unlike `this-command-keys', this function's value
10600 does not include prefix arguments.
10601 The value is always a vector. */)
10604 return Fvector (this_command_key_count
10605 - this_single_command_key_start
,
10606 (XVECTOR (this_command_keys
)->contents
10607 + this_single_command_key_start
));
10610 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10611 Sthis_single_command_raw_keys
, 0, 0, 0,
10612 doc
: /* Return the raw events that were read for this command.
10613 More generally, it returns the last key sequence read, either by
10614 the command loop or by `read-key-sequence'.
10615 Unlike `this-single-command-keys', this function's value
10616 shows the events before all translations (except for input methods).
10617 The value is always a vector. */)
10620 return Fvector (raw_keybuf_count
,
10621 (XVECTOR (raw_keybuf
)->contents
));
10624 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10625 Sreset_this_command_lengths
, 0, 0, 0,
10626 doc
: /* Make the unread events replace the last command and echo.
10627 Used in `universal-argument-other-key'.
10629 `universal-argument-other-key' rereads the event just typed.
10630 It then gets translated through `function-key-map'.
10631 The translated event has to replace the real events,
10632 both in the value of (this-command-keys) and in echoing.
10633 To achieve this, `universal-argument-other-key' calls
10634 `reset-this-command-lengths', which discards the record of reading
10635 these events the first time. */)
10638 this_command_key_count
= before_command_key_count
;
10639 if (this_command_key_count
< this_single_command_key_start
)
10640 this_single_command_key_start
= this_command_key_count
;
10642 echo_truncate (before_command_echo_length
);
10644 /* Cause whatever we put into unread-command-events
10645 to echo as if it were being freshly read from the keyboard. */
10646 this_command_key_count_reset
= 1;
10651 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10652 Sclear_this_command_keys
, 0, 1, 0,
10653 doc
: /* Clear out the vector that `this-command-keys' returns.
10654 Also clear the record of the last 100 events, unless optional arg
10655 KEEP-RECORD is non-nil. */)
10656 (Lisp_Object keep_record
)
10660 this_command_key_count
= 0;
10661 this_command_key_count_reset
= 0;
10663 if (NILP (keep_record
))
10665 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10666 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10668 recent_keys_index
= 0;
10673 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10674 doc
: /* Return the current depth in recursive edits. */)
10678 /* Wrap around reliably on integer overflow. */
10679 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10680 XSETINT (temp
, sum
);
10684 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10685 "FOpen dribble file: ",
10686 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10687 If FILE is nil, close any open dribble file.
10688 The file will be closed when Emacs exits. */)
10700 file
= Fexpand_file_name (file
, Qnil
);
10701 dribble
= fopen (SSDATA (file
), "w");
10703 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10708 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10709 doc
: /* Discard the contents of the terminal input buffer.
10710 Also end any kbd macro being defined. */)
10713 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10715 /* Discard the last command from the macro. */
10716 Fcancel_kbd_macro_events ();
10720 update_mode_lines
++;
10722 Vunread_command_events
= Qnil
;
10723 unread_command_char
= -1;
10725 discard_tty_input ();
10727 kbd_fetch_ptr
= kbd_store_ptr
;
10733 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10734 doc
: /* Stop Emacs and return to superior process. You can resume later.
10735 If `cannot-suspend' is non-nil, or if the system doesn't support job
10736 control, run a subshell instead.
10738 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10739 to be read as terminal input by Emacs's parent, after suspension.
10741 Before suspending, run the normal hook `suspend-hook'.
10742 After resumption run the normal hook `suspend-resume-hook'.
10744 Some operating systems cannot stop the Emacs process and resume it later.
10745 On such systems, Emacs starts a subshell instead of suspending. */)
10746 (Lisp_Object stuffstring
)
10748 ptrdiff_t count
= SPECPDL_INDEX ();
10749 int old_height
, old_width
;
10751 struct gcpro gcpro1
;
10754 if (tty_list
&& tty_list
->next
)
10755 error ("There are other tty frames open; close them before suspending Emacs");
10757 if (!NILP (stuffstring
))
10758 CHECK_STRING (stuffstring
);
10760 /* Run the functions in suspend-hook. */
10761 hook
= intern ("suspend-hook");
10762 Frun_hooks (1, &hook
);
10764 GCPRO1 (stuffstring
);
10765 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10766 reset_all_sys_modes ();
10767 /* sys_suspend can get an error if it tries to fork a subshell
10768 and the system resources aren't available for that. */
10769 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10771 stuff_buffered_input (stuffstring
);
10772 if (cannot_suspend
)
10776 unbind_to (count
, Qnil
);
10778 /* Check if terminal/window size has changed.
10779 Note that this is not useful when we are running directly
10780 with a window system; but suspend should be disabled in that case. */
10781 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10782 if (width
!= old_width
|| height
!= old_height
)
10783 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10785 /* Run suspend-resume-hook. */
10786 hook
= intern ("suspend-resume-hook");
10787 Frun_hooks (1, &hook
);
10793 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10794 Then in any case stuff anything Emacs has read ahead and not used. */
10797 stuff_buffered_input (Lisp_Object stuffstring
)
10799 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10800 register unsigned char *p
;
10802 if (STRINGP (stuffstring
))
10804 register ptrdiff_t count
;
10806 p
= SDATA (stuffstring
);
10807 count
= SBYTES (stuffstring
);
10808 while (count
-- > 0)
10813 /* Anything we have read ahead, put back for the shell to read. */
10814 /* ?? What should this do when we have multiple keyboards??
10815 Should we ignore anything that was typed in at the "wrong" kboard?
10817 rms: we should stuff everything back into the kboard
10819 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10822 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10823 kbd_fetch_ptr
= kbd_buffer
;
10824 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10825 stuff_char (kbd_fetch_ptr
->code
);
10827 clear_event (kbd_fetch_ptr
);
10831 #endif /* SIGTSTP */
10835 set_waiting_for_input (struct timeval
*time_to_clear
)
10837 input_available_clear_time
= time_to_clear
;
10839 /* Tell handle_interrupt to throw back to read_char, */
10840 waiting_for_input
= 1;
10842 /* If handle_interrupt was called before and buffered a C-g,
10843 make it run again now, to avoid timing error. */
10844 if (!NILP (Vquit_flag
))
10845 quit_throw_to_read_char (0);
10849 clear_waiting_for_input (void)
10851 /* Tell handle_interrupt not to throw back to read_char, */
10852 waiting_for_input
= 0;
10853 input_available_clear_time
= 0;
10856 /* The SIGINT handler.
10858 If we have a frame on the controlling tty, we assume that the
10859 SIGINT was generated by C-g, so we call handle_interrupt.
10860 Otherwise, tell QUIT to kill Emacs. */
10863 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10864 /* compilers complain in signal calls. */
10866 /* Must preserve main program's value of errno. */
10867 int old_errno
= errno
;
10868 struct terminal
*terminal
;
10870 SIGNAL_THREAD_CHECK (signalnum
);
10872 /* See if we have an active terminal on our controlling tty. */
10873 terminal
= get_named_tty ("/dev/tty");
10876 /* If there are no frames there, let's pretend that we are a
10877 well-behaving UN*X program and quit. We must not call Lisp
10878 in a signal handler, so tell QUIT to exit when it is
10880 Vquit_flag
= Qkill_emacs
;
10884 /* Otherwise, the SIGINT was probably generated by C-g. */
10886 /* Set internal_last_event_frame to the top frame of the
10887 controlling tty, if we have a frame there. We disable the
10888 interrupt key on secondary ttys, so the SIGINT must have come
10889 from the controlling tty. */
10890 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10892 handle_interrupt ();
10898 /* This routine is called at interrupt level in response to C-g.
10900 It is called from the SIGINT handler or kbd_buffer_store_event.
10902 If `waiting_for_input' is non zero, then unless `echoing' is
10903 nonzero, immediately throw back to read_char.
10905 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10906 eval to throw, when it gets a chance. If quit-flag is already
10907 non-nil, it stops the job right away. */
10910 handle_interrupt (void)
10916 /* XXX This code needs to be revised for multi-tty support. */
10917 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10919 /* If SIGINT isn't blocked, don't let us be interrupted by
10920 another SIGINT, it might be harmful due to non-reentrancy
10921 in I/O functions. */
10922 sigblock (sigmask (SIGINT
));
10925 reset_all_sys_modes ();
10927 #ifdef SIGTSTP /* Support possible in later USG versions */
10929 * On systems which can suspend the current process and return to the original
10930 * shell, this command causes the user to end up back at the shell.
10931 * The "Auto-save" and "Abort" questions are not asked until
10932 * the user elects to return to emacs, at which point he can save the current
10933 * job and either dump core or continue.
10937 /* Perhaps should really fork an inferior shell?
10938 But that would not provide any way to get back
10939 to the original shell, ever. */
10940 printf ("No support for stopping a process on this operating system;\n");
10941 printf ("you can continue or abort.\n");
10942 #endif /* not SIGTSTP */
10944 /* We must remain inside the screen area when the internal terminal
10945 is used. Note that [Enter] is not echoed by dos. */
10946 cursor_to (SELECTED_FRAME (), 0, 0);
10948 /* It doesn't work to autosave while GC is in progress;
10949 the code used for auto-saving doesn't cope with the mark bit. */
10950 if (!gc_in_progress
)
10952 printf ("Auto-save? (y or n) ");
10954 if (((c
= getchar ()) & ~040) == 'Y')
10956 Fdo_auto_save (Qt
, Qnil
);
10958 printf ("\r\nAuto-save done");
10959 #else /* not MSDOS */
10960 printf ("Auto-save done\n");
10961 #endif /* not MSDOS */
10963 while (c
!= '\n') c
= getchar ();
10967 /* During GC, it must be safe to reenable quitting again. */
10968 Vinhibit_quit
= Qnil
;
10971 #endif /* not MSDOS */
10972 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10973 printf ("but will instead do a real quit after garbage collection ends\r\n");
10978 printf ("\r\nAbort? (y or n) ");
10979 #else /* not MSDOS */
10980 printf ("Abort (and dump core)? (y or n) ");
10981 #endif /* not MSDOS */
10983 if (((c
= getchar ()) & ~040) == 'Y')
10985 while (c
!= '\n') c
= getchar ();
10987 printf ("\r\nContinuing...\r\n");
10988 #else /* not MSDOS */
10989 printf ("Continuing...\n");
10990 #endif /* not MSDOS */
10992 init_all_sys_modes ();
10997 /* If executing a function that wants to be interrupted out of
10998 and the user has not deferred quitting by binding `inhibit-quit'
10999 then quit right away. */
11000 if (immediate_quit
&& NILP (Vinhibit_quit
))
11002 struct gl_state_s saved
;
11003 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11005 immediate_quit
= 0;
11008 GCPRO4 (saved
.object
, saved
.global_code
,
11009 saved
.current_syntax_table
, saved
.old_prop
);
11010 Fsignal (Qquit
, Qnil
);
11011 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
11016 /* Else request quit when it's safe */
11020 /* TODO: The longjmp in this call throws the NS event loop integration off,
11021 and it seems to do fine without this. Probably some attention
11022 needs to be paid to the setting of waiting_for_input in
11023 wait_reading_process_output() under HAVE_NS because of the call
11024 to ns_select there (needed because otherwise events aren't picked up
11025 outside of polling since we don't get SIGIO like X and we don't have a
11026 separate event loop thread like W32. */
11028 if (waiting_for_input
&& !echoing
)
11029 quit_throw_to_read_char (1);
11033 /* Handle a C-g by making read_char return C-g. */
11036 quit_throw_to_read_char (int from_signal
)
11038 /* When not called from a signal handler it is safe to call
11040 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
11041 Fkill_emacs (Qnil
);
11044 /* Prevent another signal from doing this before we finish. */
11045 clear_waiting_for_input ();
11048 Vunread_command_events
= Qnil
;
11049 unread_command_char
= -1;
11051 #if 0 /* Currently, sit_for is called from read_char without turning
11052 off polling. And that can call set_waiting_for_input.
11053 It seems to be harmless. */
11054 #ifdef POLL_FOR_INPUT
11055 /* May be > 1 if in recursive minibuffer. */
11056 if (poll_suppress_count
== 0)
11060 if (FRAMEP (internal_last_event_frame
)
11061 && !EQ (internal_last_event_frame
, selected_frame
))
11062 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11065 _longjmp (getcjmp
, 1);
11068 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
11069 Sset_input_interrupt_mode
, 1, 1, 0,
11070 doc
: /* Set interrupt mode of reading keyboard input.
11071 If INTERRUPT is non-nil, Emacs will use input interrupts;
11072 otherwise Emacs uses CBREAK mode.
11074 See also `current-input-mode'. */)
11075 (Lisp_Object interrupt
)
11077 int new_interrupt_input
;
11079 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11080 #ifdef HAVE_X_WINDOWS
11081 if (x_display_list
!= NULL
)
11083 /* When using X, don't give the user a real choice,
11084 because we haven't implemented the mechanisms to support it. */
11085 new_interrupt_input
= 1;
11088 #endif /* HAVE_X_WINDOWS */
11089 new_interrupt_input
= !NILP (interrupt
);
11090 #else /* not SIGIO */
11091 new_interrupt_input
= 0;
11092 #endif /* not SIGIO */
11094 if (new_interrupt_input
!= interrupt_input
)
11096 #ifdef POLL_FOR_INPUT
11100 /* this causes startup screen to be restored and messes with the mouse */
11101 reset_all_sys_modes ();
11102 interrupt_input
= new_interrupt_input
;
11103 init_all_sys_modes ();
11105 interrupt_input
= new_interrupt_input
;
11108 #ifdef POLL_FOR_INPUT
11109 poll_suppress_count
= 1;
11116 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11117 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11118 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11119 C-q in key sequences.
11121 This setting only has an effect on tty terminals and only when
11122 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11124 See also `current-input-mode'. */)
11125 (Lisp_Object flow
, Lisp_Object terminal
)
11127 struct terminal
*t
= get_terminal (terminal
, 1);
11128 struct tty_display_info
*tty
;
11129 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11131 tty
= t
->display_info
.tty
;
11133 if (tty
->flow_control
!= !NILP (flow
))
11136 /* this causes startup screen to be restored and messes with the mouse */
11137 reset_sys_modes (tty
);
11140 tty
->flow_control
= !NILP (flow
);
11143 init_sys_modes (tty
);
11149 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11150 doc
: /* Enable or disable 8-bit input on TERMINAL.
11151 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11152 bit as the Meta modifier.
11154 If META is nil, Emacs will ignore the top bit, on the assumption it is
11157 Otherwise, Emacs will accept and pass through 8-bit input without
11158 specially interpreting the top bit.
11160 This setting only has an effect on tty terminal devices.
11162 Optional parameter TERMINAL specifies the tty terminal device to use.
11163 It may be a terminal object, a frame, or nil for the terminal used by
11164 the currently selected frame.
11166 See also `current-input-mode'. */)
11167 (Lisp_Object meta
, Lisp_Object terminal
)
11169 struct terminal
*t
= get_terminal (terminal
, 1);
11170 struct tty_display_info
*tty
;
11173 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11175 tty
= t
->display_info
.tty
;
11179 else if (EQ (meta
, Qt
))
11184 if (tty
->meta_key
!= new_meta
)
11187 /* this causes startup screen to be restored and messes with the mouse */
11188 reset_sys_modes (tty
);
11191 tty
->meta_key
= new_meta
;
11194 init_sys_modes (tty
);
11200 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11201 doc
: /* Specify character used for quitting.
11202 QUIT must be an ASCII character.
11204 This function only has an effect on the controlling tty of the Emacs
11207 See also `current-input-mode'. */)
11210 struct terminal
*t
= get_named_tty ("/dev/tty");
11211 struct tty_display_info
*tty
;
11212 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11214 tty
= t
->display_info
.tty
;
11216 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11217 error ("QUIT must be an ASCII character");
11220 /* this causes startup screen to be restored and messes with the mouse */
11221 reset_sys_modes (tty
);
11224 /* Don't let this value be out of range. */
11225 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11228 init_sys_modes (tty
);
11234 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11235 doc
: /* Set mode of reading keyboard input.
11236 First arg INTERRUPT non-nil means use input interrupts;
11237 nil means use CBREAK mode.
11238 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11239 (no effect except in CBREAK mode).
11240 Third arg META t means accept 8-bit input (for a Meta key).
11241 META nil means ignore the top bit, on the assumption it is parity.
11242 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11243 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11244 See also `current-input-mode'. */)
11245 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11247 Fset_input_interrupt_mode (interrupt
);
11248 Fset_output_flow_control (flow
, Qnil
);
11249 Fset_input_meta_mode (meta
, Qnil
);
11251 Fset_quit_char (quit
);
11255 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11256 doc
: /* Return information about the way Emacs currently reads keyboard input.
11257 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11258 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11259 nil, Emacs is using CBREAK mode.
11260 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11261 terminal; this does not apply if Emacs uses interrupt-driven input.
11262 META is t if accepting 8-bit input with 8th bit as Meta flag.
11263 META nil means ignoring the top bit, on the assumption it is parity.
11264 META is neither t nor nil if accepting 8-bit input and using
11265 all 8 bits as the character code.
11266 QUIT is the character Emacs currently uses to quit.
11267 The elements of this list correspond to the arguments of
11268 `set-input-mode'. */)
11271 Lisp_Object val
[4];
11272 struct frame
*sf
= XFRAME (selected_frame
);
11274 val
[0] = interrupt_input
? Qt
: Qnil
;
11275 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11277 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11278 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11280 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11287 XSETFASTINT (val
[3], quit_char
);
11289 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11292 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11293 doc
: /* Return position information for pixel coordinates X and Y.
11294 By default, X and Y are relative to text area of the selected window.
11295 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11296 If optional fourth arg WHOLE is non-nil, X is relative to the left
11297 edge of the window.
11299 The return value is similar to a mouse click position:
11300 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11301 IMAGE (DX . DY) (WIDTH . HEIGHT))
11302 The `posn-' functions access elements of such lists. */)
11303 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11308 if (NILP (frame_or_window
))
11309 frame_or_window
= selected_window
;
11311 if (WINDOWP (frame_or_window
))
11315 CHECK_LIVE_WINDOW (frame_or_window
);
11317 w
= XWINDOW (frame_or_window
);
11318 XSETINT (x
, (XINT (x
)
11319 + WINDOW_LEFT_EDGE_X (w
)
11321 ? window_box_left_offset (w
, TEXT_AREA
)
11323 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11324 frame_or_window
= w
->frame
;
11327 CHECK_LIVE_FRAME (frame_or_window
);
11329 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11332 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11333 doc
: /* Return position information for buffer POS in WINDOW.
11334 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11336 Return nil if position is not visible in window. Otherwise,
11337 the return value is similar to that returned by `event-start' for
11338 a mouse click at the upper left corner of the glyph corresponding
11339 to the given buffer position:
11340 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11341 IMAGE (DX . DY) (WIDTH . HEIGHT))
11342 The `posn-' functions access elements of such lists. */)
11343 (Lisp_Object pos
, Lisp_Object window
)
11348 window
= selected_window
;
11350 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11353 Lisp_Object x
= XCAR (tem
);
11354 Lisp_Object y
= XCAR (XCDR (tem
));
11356 /* Point invisible due to hscrolling? */
11359 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11367 * Set up a new kboard object with reasonable initial values.
11370 init_kboard (KBOARD
*kb
)
11372 KVAR (kb
, Voverriding_terminal_local_map
) = Qnil
;
11373 KVAR (kb
, Vlast_command
) = Qnil
;
11374 KVAR (kb
, Vreal_last_command
) = Qnil
;
11375 KVAR (kb
, Vkeyboard_translate_table
) = Qnil
;
11376 KVAR (kb
, Vlast_repeatable_command
) = Qnil
;
11377 KVAR (kb
, Vprefix_arg
) = Qnil
;
11378 KVAR (kb
, Vlast_prefix_arg
) = Qnil
;
11379 KVAR (kb
, kbd_queue
) = Qnil
;
11380 kb
->kbd_queue_has_data
= 0;
11381 kb
->immediate_echo
= 0;
11382 KVAR (kb
, echo_string
) = Qnil
;
11383 kb
->echo_after_prompt
= -1;
11384 kb
->kbd_macro_buffer
= 0;
11385 kb
->kbd_macro_bufsize
= 0;
11386 KVAR (kb
, defining_kbd_macro
) = Qnil
;
11387 KVAR (kb
, Vlast_kbd_macro
) = Qnil
;
11388 kb
->reference_count
= 0;
11389 KVAR (kb
, Vsystem_key_alist
) = Qnil
;
11390 KVAR (kb
, system_key_syms
) = Qnil
;
11391 KVAR (kb
, Vwindow_system
) = Qt
; /* Unset. */
11392 KVAR (kb
, Vinput_decode_map
) = Fmake_sparse_keymap (Qnil
);
11393 KVAR (kb
, Vlocal_function_key_map
) = Fmake_sparse_keymap (Qnil
);
11394 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11395 KVAR (kb
, Vdefault_minibuffer_frame
) = Qnil
;
11399 * Destroy the contents of a kboard object, but not the object itself.
11400 * We use this just before deleting it, or if we're going to initialize
11401 * it a second time.
11404 wipe_kboard (KBOARD
*kb
)
11406 xfree (kb
->kbd_macro_buffer
);
11409 /* Free KB and memory referenced from it. */
11412 delete_kboard (KBOARD
*kb
)
11416 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11419 *kbp
= kb
->next_kboard
;
11421 /* Prevent a dangling reference to KB. */
11422 if (kb
== current_kboard
11423 && FRAMEP (selected_frame
)
11424 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11426 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11428 if (current_kboard
== kb
)
11437 init_keyboard (void)
11439 /* This is correct before outermost invocation of the editor loop */
11440 command_loop_level
= -1;
11441 immediate_quit
= 0;
11442 quit_char
= Ctl ('g');
11443 Vunread_command_events
= Qnil
;
11444 unread_command_char
= -1;
11445 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11447 recent_keys_index
= 0;
11448 kbd_fetch_ptr
= kbd_buffer
;
11449 kbd_store_ptr
= kbd_buffer
;
11450 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11451 do_mouse_tracking
= Qnil
;
11454 interrupt_input_blocked
= 0;
11455 interrupt_input_pending
= 0;
11457 pending_signals
= 0;
11460 /* This means that command_loop_1 won't try to select anything the first
11462 internal_last_event_frame
= Qnil
;
11463 Vlast_event_frame
= internal_last_event_frame
;
11465 current_kboard
= initial_kboard
;
11466 /* Re-initialize the keyboard again. */
11467 wipe_kboard (current_kboard
);
11468 init_kboard (current_kboard
);
11469 /* A value of nil for Vwindow_system normally means a tty, but we also use
11470 it for the initial terminal since there is no window system there. */
11471 KVAR (current_kboard
, Vwindow_system
) = Qnil
;
11473 if (!noninteractive
)
11475 /* Before multi-tty support, these handlers used to be installed
11476 only if the current session was a tty session. Now an Emacs
11477 session may have multiple display types, so we always handle
11478 SIGINT. There is special code in interrupt_signal to exit
11479 Emacs on SIGINT when there are no termcap frames on the
11480 controlling terminal. */
11481 signal (SIGINT
, interrupt_signal
);
11483 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11484 SIGQUIT and we can't tell which one it will give us. */
11485 signal (SIGQUIT
, interrupt_signal
);
11486 #endif /* not DOS_NT */
11488 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11490 if (!noninteractive
)
11491 signal (SIGIO
, input_available_signal
);
11494 /* Use interrupt input by default, if it works and noninterrupt input
11495 has deficiencies. */
11497 #ifdef INTERRUPT_INPUT
11498 interrupt_input
= 1;
11500 interrupt_input
= 0;
11506 if (keyboard_init_hook
)
11507 (*keyboard_init_hook
) ();
11509 #ifdef POLL_FOR_INPUT
11511 poll_suppress_count
= 1;
11516 /* This type's only use is in syms_of_keyboard, to initialize the
11517 event header symbols and put properties on them. */
11518 struct event_head
{
11524 static const struct event_head head_table
[] = {
11525 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11526 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11527 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11528 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11529 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11530 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11531 /* `select-window' should be handled just like `switch-frame'
11532 in read_key_sequence. */
11533 {&Qselect_window
, "select-window", &Qswitch_frame
}
11537 syms_of_keyboard (void)
11539 pending_funcalls
= Qnil
;
11540 staticpro (&pending_funcalls
);
11542 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11543 staticpro (&Vlispy_mouse_stem
);
11546 DEFSYM (QCimage
, ":image");
11547 DEFSYM (Qhelp_echo
, "help-echo");
11548 DEFSYM (QCrtl
, ":rtl");
11550 staticpro (&item_properties
);
11551 item_properties
= Qnil
;
11553 staticpro (&tool_bar_item_properties
);
11554 tool_bar_item_properties
= Qnil
;
11555 staticpro (&tool_bar_items_vector
);
11556 tool_bar_items_vector
= Qnil
;
11558 staticpro (&real_this_command
);
11559 real_this_command
= Qnil
;
11561 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11562 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11563 DEFSYM (Qself_insert_command
, "self-insert-command");
11564 DEFSYM (Qforward_char
, "forward-char");
11565 DEFSYM (Qbackward_char
, "backward-char");
11566 DEFSYM (Qdisabled
, "disabled");
11567 DEFSYM (Qundefined
, "undefined");
11568 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11569 DEFSYM (Qpost_command_hook
, "post-command-hook");
11570 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11571 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11572 DEFSYM (Qfunction_key
, "function-key");
11573 DEFSYM (Qmouse_click
, "mouse-click");
11574 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11575 DEFSYM (Qsave_session
, "save-session");
11576 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11577 DEFSYM (Qmenu_enable
, "menu-enable");
11579 #if defined (WINDOWSNT)
11580 DEFSYM (Qlanguage_change
, "language-change");
11584 DEFSYM (Qdbus_event
, "dbus-event");
11587 DEFSYM (QCenable
, ":enable");
11588 DEFSYM (QCvisible
, ":visible");
11589 DEFSYM (QChelp
, ":help");
11590 DEFSYM (QCfilter
, ":filter");
11591 DEFSYM (QCbutton
, ":button");
11592 DEFSYM (QCkeys
, ":keys");
11593 DEFSYM (QCkey_sequence
, ":key-sequence");
11594 DEFSYM (QCtoggle
, ":toggle");
11595 DEFSYM (QCradio
, ":radio");
11596 DEFSYM (QClabel
, ":label");
11597 DEFSYM (QCvert_only
, ":vert-only");
11599 DEFSYM (Qmode_line
, "mode-line");
11600 DEFSYM (Qvertical_line
, "vertical-line");
11601 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11602 DEFSYM (Qmenu_bar
, "menu-bar");
11604 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11605 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11608 DEFSYM (Qabove_handle
, "above-handle");
11609 DEFSYM (Qhandle
, "handle");
11610 DEFSYM (Qbelow_handle
, "below-handle");
11611 DEFSYM (Qup
, "up");
11612 DEFSYM (Qdown
, "down");
11613 DEFSYM (Qtop
, "top");
11614 DEFSYM (Qbottom
, "bottom");
11615 DEFSYM (Qend_scroll
, "end-scroll");
11616 DEFSYM (Qratio
, "ratio");
11618 DEFSYM (Qevent_kind
, "event-kind");
11619 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11620 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11621 DEFSYM (Qmodifier_cache
, "modifier-cache");
11623 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11624 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11626 DEFSYM (Qpolling_period
, "polling-period");
11628 DEFSYM (Qx_set_selection
, "x-set-selection");
11629 DEFSYM (QPRIMARY
, "PRIMARY");
11630 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11632 DEFSYM (Qinput_method_function
, "input-method-function");
11633 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11634 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11636 DEFSYM (Qhelp_form_show
, "help-form-show");
11638 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11639 Fset (Qinput_method_use_echo_area
, Qnil
);
11641 last_point_position_buffer
= Qnil
;
11642 last_point_position_window
= Qnil
;
11646 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11648 for (i
= 0; i
< len
; i
++)
11650 const struct event_head
*p
= &head_table
[i
];
11651 *p
->var
= intern_c_string (p
->name
);
11652 staticpro (p
->var
);
11653 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11654 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11658 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11659 staticpro (&button_down_location
);
11660 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11661 staticpro (&mouse_syms
);
11662 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11663 / sizeof (lispy_wheel_names
[0])),
11665 staticpro (&wheel_syms
);
11669 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11671 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11672 for (i
= 0; i
< len
; i
++)
11673 if (modifier_names
[i
])
11674 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11675 staticpro (&modifier_symbols
);
11678 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11679 staticpro (&recent_keys
);
11681 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11682 staticpro (&this_command_keys
);
11684 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11685 staticpro (&raw_keybuf
);
11687 DEFSYM (Qextended_command_history
, "extended-command-history");
11688 Fset (Qextended_command_history
, Qnil
);
11690 accent_key_syms
= Qnil
;
11691 staticpro (&accent_key_syms
);
11693 func_key_syms
= Qnil
;
11694 staticpro (&func_key_syms
);
11696 drag_n_drop_syms
= Qnil
;
11697 staticpro (&drag_n_drop_syms
);
11699 unread_switch_frame
= Qnil
;
11700 staticpro (&unread_switch_frame
);
11702 internal_last_event_frame
= Qnil
;
11703 staticpro (&internal_last_event_frame
);
11705 read_key_sequence_cmd
= Qnil
;
11706 staticpro (&read_key_sequence_cmd
);
11707 read_key_sequence_remapped
= Qnil
;
11708 staticpro (&read_key_sequence_remapped
);
11710 menu_bar_one_keymap_changed_items
= Qnil
;
11711 staticpro (&menu_bar_one_keymap_changed_items
);
11713 menu_bar_items_vector
= Qnil
;
11714 staticpro (&menu_bar_items_vector
);
11716 help_form_saved_window_configs
= Qnil
;
11717 staticpro (&help_form_saved_window_configs
);
11719 defsubr (&Scurrent_idle_time
);
11720 defsubr (&Sevent_symbol_parse_modifiers
);
11721 defsubr (&Sevent_convert_list
);
11722 defsubr (&Sread_key_sequence
);
11723 defsubr (&Sread_key_sequence_vector
);
11724 defsubr (&Srecursive_edit
);
11725 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11726 defsubr (&Strack_mouse
);
11728 defsubr (&Sinput_pending_p
);
11729 defsubr (&Scommand_execute
);
11730 defsubr (&Srecent_keys
);
11731 defsubr (&Sthis_command_keys
);
11732 defsubr (&Sthis_command_keys_vector
);
11733 defsubr (&Sthis_single_command_keys
);
11734 defsubr (&Sthis_single_command_raw_keys
);
11735 defsubr (&Sreset_this_command_lengths
);
11736 defsubr (&Sclear_this_command_keys
);
11737 defsubr (&Ssuspend_emacs
);
11738 defsubr (&Sabort_recursive_edit
);
11739 defsubr (&Sexit_recursive_edit
);
11740 defsubr (&Srecursion_depth
);
11741 defsubr (&Stop_level
);
11742 defsubr (&Sdiscard_input
);
11743 defsubr (&Sopen_dribble_file
);
11744 defsubr (&Sset_input_interrupt_mode
);
11745 defsubr (&Sset_output_flow_control
);
11746 defsubr (&Sset_input_meta_mode
);
11747 defsubr (&Sset_quit_char
);
11748 defsubr (&Sset_input_mode
);
11749 defsubr (&Scurrent_input_mode
);
11750 defsubr (&Sexecute_extended_command
);
11751 defsubr (&Sposn_at_point
);
11752 defsubr (&Sposn_at_x_y
);
11754 DEFVAR_LISP ("last-command-event", last_command_event
,
11755 doc
: /* Last input event that was part of a command. */);
11757 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11758 doc
: /* Last input event in a command, except for mouse menu events.
11759 Mouse menus give back keys that don't look like mouse events;
11760 this variable holds the actual mouse event that led to the menu,
11761 so that you can determine whether the command was run by mouse or not. */);
11763 DEFVAR_LISP ("last-input-event", last_input_event
,
11764 doc
: /* Last input event. */);
11766 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11767 doc
: /* List of events to be read as the command input.
11768 These events are processed first, before actual keyboard input.
11769 Events read from this list are not normally added to `this-command-keys',
11770 as they will already have been added once as they were read for the first time.
11771 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11772 Vunread_command_events
= Qnil
;
11774 DEFVAR_INT ("unread-command-char", unread_command_char
,
11775 doc
: /* If not -1, an object to be read as next command input event. */);
11777 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11778 doc
: /* List of events to be processed as input by input methods.
11779 These events are processed before `unread-command-events'
11780 and actual keyboard input, but are not given to `input-method-function'. */);
11781 Vunread_post_input_method_events
= Qnil
;
11783 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11784 doc
: /* List of events to be processed as input by input methods.
11785 These events are processed after `unread-command-events', but
11786 before actual keyboard input.
11787 If there's an active input method, the events are given to
11788 `input-method-function'. */);
11789 Vunread_input_method_events
= Qnil
;
11791 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11792 doc
: /* Meta-prefix character code.
11793 Meta-foo as command input turns into this character followed by foo. */);
11794 XSETINT (meta_prefix_char
, 033);
11796 DEFVAR_KBOARD ("last-command", Vlast_command
,
11797 doc
: /* The last command executed.
11798 Normally a symbol with a function definition, but can be whatever was found
11799 in the keymap, or whatever the variable `this-command' was set to by that
11802 The value `mode-exit' is special; it means that the previous command
11803 read an event that told it to exit, and it did so and unread that event.
11804 In other words, the present command is the event that made the previous
11807 The value `kill-region' is special; it means that the previous command
11808 was a kill command.
11810 `last-command' has a separate binding for each terminal device.
11811 See Info node `(elisp)Multiple Terminals'. */);
11813 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11814 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11816 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11817 doc
: /* Last command that may be repeated.
11818 The last command executed that was not bound to an input event.
11819 This is the command `repeat' will try to repeat. */);
11821 DEFVAR_LISP ("this-command", Vthis_command
,
11822 doc
: /* The command now being executed.
11823 The command can set this variable; whatever is put here
11824 will be in `last-command' during the following command. */);
11825 Vthis_command
= Qnil
;
11827 DEFVAR_LISP ("this-command-keys-shift-translated",
11828 Vthis_command_keys_shift_translated
,
11829 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11830 Shift-translation occurs when there is no binding for the key sequence
11831 as entered, but a binding was found by changing an upper-case letter
11832 to lower-case, or a shifted function key to an unshifted one. */);
11833 Vthis_command_keys_shift_translated
= Qnil
;
11835 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11836 doc
: /* The command bound to the current key sequence before remapping.
11837 It equals `this-command' if the original command was not remapped through
11838 any of the active keymaps. Otherwise, the value of `this-command' is the
11839 result of looking up the original command in the active keymaps. */);
11840 Vthis_original_command
= Qnil
;
11842 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11843 doc
: /* *Number of input events between auto-saves.
11844 Zero means disable autosaving due to number of characters typed. */);
11845 auto_save_interval
= 300;
11847 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11848 doc
: /* *Number of seconds idle time before auto-save.
11849 Zero or nil means disable auto-saving due to idleness.
11850 After auto-saving due to this many seconds of idle time,
11851 Emacs also does a garbage collection if that seems to be warranted. */);
11852 XSETFASTINT (Vauto_save_timeout
, 30);
11854 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11855 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11856 The value may be integer or floating point. */);
11857 Vecho_keystrokes
= make_number (1);
11859 DEFVAR_INT ("polling-period", polling_period
,
11860 doc
: /* *Interval between polling for input during Lisp execution.
11861 The reason for polling is to make C-g work to stop a running program.
11862 Polling is needed only when using X windows and SIGIO does not work.
11863 Polling is automatically disabled in all other cases. */);
11864 polling_period
= 2;
11866 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11867 doc
: /* *Maximum time between mouse clicks to make a double-click.
11868 Measured in milliseconds. The value nil means disable double-click
11869 recognition; t means double-clicks have no time limit and are detected
11870 by position only. */);
11871 Vdouble_click_time
= make_number (500);
11873 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11874 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11875 On window-system frames, value is the number of pixels the mouse may have
11876 moved horizontally or vertically between two clicks to make a double-click.
11877 On non window-system frames, value is interpreted in units of 1/8 characters
11880 This variable is also the threshold for motion of the mouse
11881 to count as a drag. */);
11882 double_click_fuzz
= 3;
11884 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11885 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11886 inhibit_local_menu_bar_menus
= 0;
11888 DEFVAR_INT ("num-input-keys", num_input_keys
,
11889 doc
: /* Number of complete key sequences read as input so far.
11890 This includes key sequences read from keyboard macros.
11891 The number is effectively the number of interactive command invocations. */);
11892 num_input_keys
= 0;
11894 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11895 doc
: /* Number of input events read from the keyboard so far.
11896 This does not include events generated by keyboard macros. */);
11897 num_nonmacro_input_events
= 0;
11899 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11900 doc
: /* The frame in which the most recently read event occurred.
11901 If the last event came from a keyboard macro, this is set to `macro'. */);
11902 Vlast_event_frame
= Qnil
;
11904 /* This variable is set up in sysdep.c. */
11905 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11906 doc
: /* The ERASE character as set by the user with stty. */);
11908 DEFVAR_LISP ("help-char", Vhelp_char
,
11909 doc
: /* Character to recognize as meaning Help.
11910 When it is read, do `(eval help-form)', and display result if it's a string.
11911 If the value of `help-form' is nil, this char can be read normally. */);
11912 XSETINT (Vhelp_char
, Ctl ('H'));
11914 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11915 doc
: /* List of input events to recognize as meaning Help.
11916 These work just like the value of `help-char' (see that). */);
11917 Vhelp_event_list
= Qnil
;
11919 DEFVAR_LISP ("help-form", Vhelp_form
,
11920 doc
: /* Form to execute when character `help-char' is read.
11921 If the form returns a string, that string is displayed.
11922 If `help-form' is nil, the help char is not recognized. */);
11925 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11926 doc
: /* Command to run when `help-char' character follows a prefix key.
11927 This command is used only when there is no actual binding
11928 for that character after that prefix key. */);
11929 Vprefix_help_command
= Qnil
;
11931 DEFVAR_LISP ("top-level", Vtop_level
,
11932 doc
: /* Form to evaluate when Emacs starts up.
11933 Useful to set before you dump a modified Emacs. */);
11936 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11937 doc
: /* Translate table for local keyboard input, or nil.
11938 If non-nil, the value should be a char-table. Each character read
11939 from the keyboard is looked up in this char-table. If the value found
11940 there is non-nil, then it is used instead of the actual input character.
11942 The value can also be a string or vector, but this is considered obsolete.
11943 If it is a string or vector of length N, character codes N and up are left
11944 untranslated. In a vector, an element which is nil means "no translation".
11946 This is applied to the characters supplied to input methods, not their
11947 output. See also `translation-table-for-input'.
11949 This variable has a separate binding for each terminal.
11950 See Info node `(elisp)Multiple Terminals'. */);
11952 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11953 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11954 \(Even if the operating system has support for stopping a process.\) */);
11955 cannot_suspend
= 0;
11957 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11958 doc
: /* Non-nil means prompt with menus when appropriate.
11959 This is done when reading from a keymap that has a prompt string,
11960 for elements that have prompt strings.
11961 The menu is displayed on the screen
11962 if X menus were enabled at configuration
11963 time and the previous event was a mouse click prefix key.
11964 Otherwise, menu prompting uses the echo area. */);
11965 menu_prompting
= 1;
11967 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11968 doc
: /* Character to see next line of menu prompt.
11969 Type this character while in a menu prompt to rotate around the lines of it. */);
11970 XSETINT (menu_prompt_more_char
, ' ');
11972 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11973 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11974 Emacs applies the modifiers of the character stored here to each keyboard
11975 character it reads. For example, after evaluating the expression
11976 (setq extra-keyboard-modifiers ?\\C-x)
11977 all input characters will have the control modifier applied to them.
11979 Note that the character ?\\C-@, equivalent to the integer zero, does
11980 not count as a control character; rather, it counts as a character
11981 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11982 cancels any modification. */);
11983 extra_keyboard_modifiers
= 0;
11985 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11986 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11987 The command loop sets this to nil before each command,
11988 and tests the value when the command returns.
11989 Buffer modification stores t in this variable. */);
11990 Vdeactivate_mark
= Qnil
;
11991 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11993 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11994 doc
: /* Normal hook run before each command is executed.
11995 If an unhandled error happens in running this hook,
11996 the function in which the error occurred is unconditionally removed, since
11997 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11998 Vpre_command_hook
= Qnil
;
12000 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
12001 doc
: /* Normal hook run after each command is executed.
12002 If an unhandled error happens in running this hook,
12003 the function in which the error occurred is unconditionally removed, since
12004 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
12005 Vpost_command_hook
= Qnil
;
12008 DEFVAR_LISP ("echo-area-clear-hook", ...,
12009 doc
: /* Normal hook run when clearing the echo area. */);
12011 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
12012 Fset (Qecho_area_clear_hook
, Qnil
);
12014 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
12015 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12016 Vlucid_menu_bar_dirty_flag
= Qnil
;
12018 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
12019 doc
: /* List of menu bar items to move to the end of the menu bar.
12020 The elements of the list are event types that may have menu bar bindings. */);
12021 Vmenu_bar_final_items
= Qnil
;
12023 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
12024 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
12025 This is used internally by graphical displays that do not render
12026 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
12027 Vtool_bar_separator_image_expression
= Qnil
;
12029 DEFVAR_KBOARD ("overriding-terminal-local-map",
12030 Voverriding_terminal_local_map
,
12031 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12032 If this variable is non-nil, it is used as a keymap instead of the
12033 buffer's local map, and the minor mode keymaps and text property keymaps.
12034 It also replaces `overriding-local-map'.
12036 This variable is intended to let commands such as `universal-argument'
12037 set up a different keymap for reading the next command.
12039 `overriding-terminal-local-map' has a separate binding for each
12041 See Info node `(elisp)Multiple Terminals'. */);
12043 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
12044 doc
: /* Keymap that overrides all other local keymaps.
12045 If this variable is non-nil, it is used as a keymap--replacing the
12046 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12047 Voverriding_local_map
= Qnil
;
12049 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
12050 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12051 Otherwise, the menu bar continues to reflect the buffer's local map
12052 and the minor mode maps regardless of `overriding-local-map'. */);
12053 Voverriding_local_map_menu_flag
= Qnil
;
12055 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
12056 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12057 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
12059 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
12060 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12062 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12063 doc
: /* Alist of system-specific X windows key symbols.
12064 Each element should have the form (N . SYMBOL) where N is the
12065 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12066 and SYMBOL is its name.
12068 `system-key-alist' has a separate binding for each terminal device.
12069 See Info node `(elisp)Multiple Terminals'. */);
12071 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12072 doc
: /* Keymap that translates key sequences to key sequences during input.
12073 This is used mainly for mapping key sequences into some preferred
12074 key events (symbols).
12076 The `read-key-sequence' function replaces any subsequence bound by
12077 `local-function-key-map' with its binding. More precisely, when the
12078 active keymaps have no binding for the current key sequence but
12079 `local-function-key-map' binds a suffix of the sequence to a vector or
12080 string, `read-key-sequence' replaces the matching suffix with its
12081 binding, and continues with the new sequence.
12083 If the binding is a function, it is called with one argument (the prompt)
12084 and its return value (a key sequence) is used.
12086 The events that come from bindings in `local-function-key-map' are not
12087 themselves looked up in `local-function-key-map'.
12089 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12090 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12091 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12092 typing `ESC O P x' would return [f1 x].
12094 `local-function-key-map' has a separate binding for each terminal
12095 device. See Info node `(elisp)Multiple Terminals'. If you need to
12096 define a binding on all terminals, change `function-key-map'
12097 instead. Initially, `local-function-key-map' is an empty keymap that
12098 has `function-key-map' as its parent on all terminal devices. */);
12100 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12101 doc
: /* Keymap that decodes input escape sequences.
12102 This is used mainly for mapping ASCII function key sequences into
12103 real Emacs function key events (symbols).
12105 The `read-key-sequence' function replaces any subsequence bound by
12106 `input-decode-map' with its binding. Contrary to `function-key-map',
12107 this map applies its rebinding regardless of the presence of an ordinary
12108 binding. So it is more like `key-translation-map' except that it applies
12109 before `function-key-map' rather than after.
12111 If the binding is a function, it is called with one argument (the prompt)
12112 and its return value (a key sequence) is used.
12114 The events that come from bindings in `input-decode-map' are not
12115 themselves looked up in `input-decode-map'.
12117 This variable is keyboard-local. */);
12119 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12120 doc
: /* The parent keymap of all `local-function-key-map' instances.
12121 Function key definitions that apply to all terminal devices should go
12122 here. If a mapping is defined in both the current
12123 `local-function-key-map' binding and this variable, then the local
12124 definition will take precedence. */);
12125 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12127 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12128 doc
: /* Keymap of key translations that can override keymaps.
12129 This keymap works like `function-key-map', but comes after that,
12130 and its non-prefix bindings override ordinary bindings.
12131 Another difference is that it is global rather than keyboard-local. */);
12132 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12134 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12135 doc
: /* List of deferred actions to be performed at a later time.
12136 The precise format isn't relevant here; we just check whether it is nil. */);
12137 Vdeferred_action_list
= Qnil
;
12139 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12140 doc
: /* Function to call to handle deferred actions, after each command.
12141 This function is called with no arguments after each command
12142 whenever `deferred-action-list' is non-nil. */);
12143 Vdeferred_action_function
= Qnil
;
12145 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
12146 doc
: /* List of warnings to be displayed as soon as possible.
12147 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
12148 as per the args of `display-warning' (which see).
12149 If this variable is non-nil, `delayed-warnings-hook' will be run
12150 immediately after running `post-command-hook'. */);
12151 Vdelayed_warnings_list
= Qnil
;
12153 DEFVAR_LISP ("suggest-key-bindings", Vsuggest_key_bindings
,
12154 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12155 The value can be a length of time to show the message for.
12156 If the value is non-nil and not a number, we wait 2 seconds. */);
12157 Vsuggest_key_bindings
= Qt
;
12159 DEFVAR_LISP ("timer-list", Vtimer_list
,
12160 doc
: /* List of active absolute time timers in order of increasing time. */);
12161 Vtimer_list
= Qnil
;
12163 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12164 doc
: /* List of active idle-time timers in order of increasing time. */);
12165 Vtimer_idle_list
= Qnil
;
12167 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12168 doc
: /* If non-nil, the function that implements the current input method.
12169 It's called with one argument, a printing character that was just read.
12170 \(That means a character with code 040...0176.)
12171 Typically this function uses `read-event' to read additional events.
12172 When it does so, it should first bind `input-method-function' to nil
12173 so it will not be called recursively.
12175 The function should return a list of zero or more events
12176 to be used as input. If it wants to put back some events
12177 to be reconsidered, separately, by the input method,
12178 it can add them to the beginning of `unread-command-events'.
12180 The input method function can find in `input-method-previous-message'
12181 the previous echo area message.
12183 The input method function should refer to the variables
12184 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12185 for guidance on what to do. */);
12186 Vinput_method_function
= Qnil
;
12188 DEFVAR_LISP ("input-method-previous-message",
12189 Vinput_method_previous_message
,
12190 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12191 This variable exists because `read-event' clears the echo area
12192 before running the input method. It is nil if there was no message. */);
12193 Vinput_method_previous_message
= Qnil
;
12195 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12196 doc
: /* If non-nil, the function that implements the display of help.
12197 It's called with one argument, the help string to display. */);
12198 Vshow_help_function
= Qnil
;
12200 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12201 doc
: /* If non-nil, suppress point adjustment after executing a command.
12203 After a command is executed, if point is moved into a region that has
12204 special properties (e.g. composition, display), we adjust point to
12205 the boundary of the region. But, when a command sets this variable to
12206 non-nil, we suppress the point adjustment.
12208 This variable is set to nil before reading a command, and is checked
12209 just after executing the command. */);
12210 Vdisable_point_adjustment
= Qnil
;
12212 DEFVAR_LISP ("global-disable-point-adjustment",
12213 Vglobal_disable_point_adjustment
,
12214 doc
: /* *If non-nil, always suppress point adjustment.
12216 The default value is nil, in which case, point adjustment are
12217 suppressed only after special commands that set
12218 `disable-point-adjustment' (which see) to non-nil. */);
12219 Vglobal_disable_point_adjustment
= Qnil
;
12221 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12222 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12223 If the value is not a number, such messages don't time out. */);
12224 Vminibuffer_message_timeout
= make_number (2);
12226 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12227 doc
: /* If non-nil, any keyboard input throws to this symbol.
12228 The value of that variable is passed to `quit-flag' and later causes a
12229 peculiar kind of quitting. */);
12230 Vthrow_on_input
= Qnil
;
12232 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12233 doc
: /* If non-nil, function to output error messages.
12234 The arguments are the error data, a list of the form
12235 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12236 such as just as `condition-case' would bind its variable to,
12237 the context (a string which normally goes at the start of the message),
12238 and the Lisp function within which the error was signaled. */);
12239 Vcommand_error_function
= Qnil
;
12241 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12242 Venable_disabled_menus_and_buttons
,
12243 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12245 Help functions bind this to allow help on disabled menu items
12246 and tool-bar buttons. */);
12247 Venable_disabled_menus_and_buttons
= Qnil
;
12249 DEFVAR_LISP ("select-active-regions",
12250 Vselect_active_regions
,
12251 doc
: /* If non-nil, an active region automatically sets the primary selection.
12252 If the value is `only', only temporarily active regions (usually made
12253 by mouse-dragging or shift-selection) set the window selection.
12255 This takes effect only when Transient Mark mode is enabled. */);
12256 Vselect_active_regions
= Qt
;
12258 DEFVAR_LISP ("saved-region-selection",
12259 Vsaved_region_selection
,
12260 doc
: /* Contents of active region prior to buffer modification.
12261 If `select-active-regions' is non-nil, Emacs sets this to the
12262 text in the region before modifying the buffer. The next
12263 `deactivate-mark' call uses this to set the window selection. */);
12264 Vsaved_region_selection
= Qnil
;
12266 DEFVAR_LISP ("debug-on-event",
12268 doc
: /* Enter debugger on this event. When Emacs
12269 receives the special event specified by this variable, it will try to
12270 break into the debugger as soon as possible instead of processing the
12271 event normally through `special-event-map'.
12273 Currently, the only supported values for this
12274 variable are `sigusr1' and `sigusr2'. */);
12275 Vdebug_on_event
= intern_c_string ("sigusr2");
12277 /* Create the initial keyboard. */
12278 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12279 init_kboard (initial_kboard
);
12280 /* Vwindow_system is left at t for now. */
12281 initial_kboard
->next_kboard
= all_kboards
;
12282 all_kboards
= initial_kboard
;
12286 keys_of_keyboard (void)
12288 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12289 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12290 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12291 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12292 initial_define_key (meta_map
, 'x', "execute-extended-command");
12294 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12295 "handle-delete-frame");
12296 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12297 "ns-put-working-text");
12298 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12299 "ns-unput-working-text");
12300 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12301 current-prefix-arg, as is done in `handle-switch-frame'.
12302 But `handle-switch-frame is not run from the special-map.
12303 Commands from that map are run in a special way that automatically
12304 preserves the prefix-arg. Restoring the prefix arg here is not just
12305 redundant but harmful:
12307 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12308 - after the first prompt, the exit-minibuffer-hook is run which may
12309 iconify a frame and thus push a `iconify-frame' event.
12310 - after running exit-minibuffer-hook, current-prefix-arg is
12311 restored to the non-nil value it had before the prompt.
12312 - we enter the second prompt.
12313 current-prefix-arg is non-nil, prefix-arg is nil.
12314 - before running the first real event, we run the special iconify-frame
12315 event, but we pass the `special' arg to execute-command so
12316 current-prefix-arg and prefix-arg are left untouched.
12317 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12318 - the next key event will have a spuriously non-nil current-prefix-arg. */
12319 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12321 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12323 /* Handling it at such a low-level causes read_key_sequence to get
12324 * confused because it doesn't realize that the current_buffer was
12325 * changed by read_char.
12327 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12328 * "handle-select-window"); */
12329 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12330 "handle-save-session");
12333 /* Define a special event which is raised for dbus callback
12335 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12336 "dbus-handle-event");
12339 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12343 /* Mark the pointers in the kboard objects.
12344 Called by the Fgarbage_collector. */
12346 mark_kboards (void)
12350 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12352 if (kb
->kbd_macro_buffer
)
12353 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12355 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12356 mark_object (KVAR (kb
, Vlast_command
));
12357 mark_object (KVAR (kb
, Vreal_last_command
));
12358 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12359 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12360 mark_object (KVAR (kb
, Vprefix_arg
));
12361 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12362 mark_object (KVAR (kb
, kbd_queue
));
12363 mark_object (KVAR (kb
, defining_kbd_macro
));
12364 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12365 mark_object (KVAR (kb
, Vsystem_key_alist
));
12366 mark_object (KVAR (kb
, system_key_syms
));
12367 mark_object (KVAR (kb
, Vwindow_system
));
12368 mark_object (KVAR (kb
, Vinput_decode_map
));
12369 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12370 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12371 mark_object (KVAR (kb
, echo_string
));
12374 struct input_event
*event
;
12375 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12377 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12378 event
= kbd_buffer
;
12379 if (event
->kind
!= SELECTION_REQUEST_EVENT
12380 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12382 mark_object (event
->x
);
12383 mark_object (event
->y
);
12385 mark_object (event
->frame_or_window
);
12386 mark_object (event
->arg
);