keyboard.c 338 KB
Newer Older
<
Jim Blandy's avatar
Jim Blandy committed
1
/* Keyboard and mouse input; editor command loop.
2
   Copyright (C) 1985,86,87,88,89,93,94,95,96,97,99,2000,01,02,03
3
     Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21

22
#include <config.h>
23
#include <signal.h>
Jim Blandy's avatar
Jim Blandy committed
24
#include <stdio.h>
25
#include "lisp.h"
Jim Blandy's avatar
Jim Blandy committed
26 27
#include "termchar.h"
#include "termopts.h"
28
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
29 30
#include "termhooks.h"
#include "macros.h"
31
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
32 33 34
#include "window.h"
#include "commands.h"
#include "buffer.h"
35
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
36
#include "disptab.h"
37
#include "dispextern.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
38
#include "syntax.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
39
#include "intervals.h"
Stefan Monnier's avatar
Stefan Monnier committed
40
#include "keymap.h"
41
#include "blockinput.h"
42
#include "puresize.h"
43 44
#include "systime.h"
#include "atimer.h"
Jim Blandy's avatar
Jim Blandy committed
45 46 47
#include <setjmp.h>
#include <errno.h>

48 49 50 51
#ifdef MSDOS
#include "msdos.h"
#include <time.h>
#else /* not MSDOS */
Jim Blandy's avatar
Jim Blandy committed
52 53 54
#ifndef VMS
#include <sys/ioctl.h>
#endif
55
#endif /* not MSDOS */
Jim Blandy's avatar
Jim Blandy committed
56

Jim Blandy's avatar
Jim Blandy committed
57 58
#include "syssignal.h"

59 60 61 62 63
#include <sys/types.h>
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

64 65 66 67 68
/* This is to get the definitions of the XK_ symbols.  */
#ifdef HAVE_X_WINDOWS
#include "xterm.h"
#endif

69 70 71 72
#ifdef HAVE_NTGUI
#include "w32term.h"
#endif /* HAVE_NTGUI */

73
#ifdef MAC_OS
74 75 76
#include "macterm.h"
#endif

77
#ifndef USE_CRT_DLL
Jim Blandy's avatar
Jim Blandy committed
78
extern int errno;
79
#endif
Jim Blandy's avatar
Jim Blandy committed
80

81 82 83
/* Variables for blockinput.h: */

/* Non-zero if interrupt input is blocked right now.  */
84
int interrupt_input_blocked;
85 86 87

/* Nonzero means an input interrupt has arrived
   during the current critical section.  */
88
int interrupt_input_pending;
89 90


91
#ifdef HAVE_WINDOW_SYSTEM
Jim Blandy's avatar
Jim Blandy committed
92
/* Make all keyboard buffers much bigger when using X windows.  */
93 94
#ifdef MAC_OS8
/* But not too big (local data > 32K error) if on Mac OS Classic.  */
95 96
#define KBD_BUFFER_SIZE 512
#else
Jim Blandy's avatar
Jim Blandy committed
97
#define KBD_BUFFER_SIZE 4096
98
#endif
Jim Blandy's avatar
Jim Blandy committed
99
#else	/* No X-windows, character input */
100
#define KBD_BUFFER_SIZE 4096
Jim Blandy's avatar
Jim Blandy committed
101 102
#endif	/* No X-windows */

Gerd Moellmann's avatar
Gerd Moellmann committed
103 104
#define abs(x)		((x) >= 0 ? (x) : -(x))

Jim Blandy's avatar
Jim Blandy committed
105 106 107 108 109 110 111 112 113 114 115 116 117
/* Following definition copied from eval.c */

struct backtrace
  {
    struct backtrace *next;
    Lisp_Object *function;
    Lisp_Object *args;	/* Points to vector of args. */
    int nargs;		/* length of vector.  If nargs is UNEVALLED,
			   args points to slot holding list of
			   unevalled args */
    char evalargs;
  };

118 119 120 121
#ifdef MULTI_KBOARD
KBOARD *initial_kboard;
KBOARD *current_kboard;
KBOARD *all_kboards;
122
int single_kboard;
123
#else
124
KBOARD the_only_kboard;
125
#endif
126

Jim Blandy's avatar
Jim Blandy committed
127 128
/* Non-nil disable property on a command means
   do not execute it; call disabled-command-hook's value instead.  */
129
Lisp_Object Qdisabled, Qdisabled_command_hook;
Jim Blandy's avatar
Jim Blandy committed
130 131 132 133

#define NUM_RECENT_KEYS (100)
int recent_keys_index;	/* Index for storing next element into recent_keys */
int total_keys;		/* Total number of elements stored into recent_keys */
134
Lisp_Object recent_keys; /* A vector, holding the last 100 keystrokes */
Jim Blandy's avatar
Jim Blandy committed
135

136 137 138 139 140 141 142
/* Vector holding the key sequence that invoked the current command.
   It is reused for each command, and it may be longer than the current
   sequence; this_command_key_count indicates how many elements
   actually mean something.
   It's easier to staticpro a single Lisp_Object than an array.  */
Lisp_Object this_command_keys;
int this_command_key_count;
Jim Blandy's avatar
Jim Blandy committed
143

144 145 146 147
/* 1 after calling Freset_this_command_lengths.
   Usually it is 0.  */
int this_command_key_count_reset;

148 149 150 151 152 153
/* This vector is used as a buffer to record the events that were actually read
   by read_key_sequence.  */
Lisp_Object raw_keybuf;
int raw_keybuf_count;

#define GROW_RAW_KEYBUF							\
154
 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size)			\
155 156 157 158 159 160 161 162 163
  {									\
    int newsize = 2 * XVECTOR (raw_keybuf)->size;			\
    Lisp_Object new;							\
    new = Fmake_vector (make_number (newsize), Qnil);			\
    bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents,	\
	   raw_keybuf_count * sizeof (Lisp_Object));			\
    raw_keybuf = new;							\
  }

164 165 166 167
/* Number of elements of this_command_keys
   that precede this key sequence.  */
int this_single_command_key_start;

168 169 170 171 172
/* Record values of this_command_key_count and echo_length ()
   before this command was read.  */
static int before_command_key_count;
static int before_command_echo_length;

Jim Blandy's avatar
Jim Blandy committed
173 174
extern int minbuf_level;

175 176
extern int message_enable_multibyte;

Jim Blandy's avatar
Jim Blandy committed
177 178
extern struct backtrace *backtrace_list;

179 180 181 182 183
/* If non-nil, the function that implements the display of help.
   It's called with one argument, the help string to display.  */

Lisp_Object Vshow_help_function;

184 185 186 187 188
/* If a string, the message displayed before displaying a help-echo
   in the echo area.  */

Lisp_Object Vpre_help_message;

Jim Blandy's avatar
Jim Blandy committed
189
/* Nonzero means do menu prompting.  */
190

Jim Blandy's avatar
Jim Blandy committed
191 192 193
static int menu_prompting;

/* Character to see next line of menu prompt.  */
194

Jim Blandy's avatar
Jim Blandy committed
195 196 197
static Lisp_Object menu_prompt_more_char;

/* For longjmp to where kbd input is being done.  */
198

Jim Blandy's avatar
Jim Blandy committed
199 200 201 202 203 204
static jmp_buf getcjmp;

/* True while doing kbd input.  */
int waiting_for_input;

/* True while displaying for echoing.   Delays C-g throwing.  */
205

206
int echoing;
Jim Blandy's avatar
Jim Blandy committed
207

208 209 210 211 212
/* Non-null means we can start echoing at the next input pause even
   though there is something in the echo area.  */

static struct kboard *ok_to_echo_at_next_pause;

213 214 215 216
/* The kboard last echoing, or null for none.  Reset to 0 in
   cancel_echoing.  If non-null, and a current echo area message
   exists, and echo_message_buffer is eq to the current message
   buffer, we know that the message comes from echo_kboard.  */
217

218
struct kboard *echo_kboard;
219

220 221 222
/* The buffer used for echoing.  Set in echo_now, reset in
   cancel_echoing.  */

223
Lisp_Object echo_message_buffer;
224

225 226 227
/* Nonzero means disregard local maps for the menu bar.  */
static int inhibit_local_menu_bar_menus;

228
/* Nonzero means C-g should cause immediate error-signal.  */
Jim Blandy's avatar
Jim Blandy committed
229 230
int immediate_quit;

231 232 233
/* The user's ERASE setting.  */
Lisp_Object Vtty_erase_char;

Jim Blandy's avatar
Jim Blandy committed
234
/* Character to recognize as the help char.  */
235
Lisp_Object Vhelp_char;
Jim Blandy's avatar
Jim Blandy committed
236

Karl Heuer's avatar
Karl Heuer committed
237 238 239
/* List of other event types to recognize as meaning "help".  */
Lisp_Object Vhelp_event_list;

Jim Blandy's avatar
Jim Blandy committed
240 241 242
/* Form to execute when help char is typed.  */
Lisp_Object Vhelp_form;

243 244 245
/* Command to run when the help character follows a prefix key.  */
Lisp_Object Vprefix_help_command;

246 247
/* List of items that should move to the end of the menu bar.  */
Lisp_Object Vmenu_bar_final_items;
248

249 250 251 252 253 254
/* Non-nil means show the equivalent key-binding for
   any M-x command that has one.
   The value can be a length of time to show the message for.
   If the value is non-nil and not a number, we wait 2 seconds.  */
Lisp_Object Vsuggest_key_bindings;

255 256 257 258
/* How long to display an echo-area message when the minibuffer is active.
   If the value is not a number, such messages don't time out.  */
Lisp_Object Vminibuffer_message_timeout;

Jim Blandy's avatar
Jim Blandy committed
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
/* Character that causes a quit.  Normally C-g.

   If we are running on an ordinary terminal, this must be an ordinary
   ASCII char, since we want to make it our interrupt character.

   If we are not running on an ordinary terminal, it still needs to be
   an ordinary ASCII char.  This character needs to be recognized in
   the input interrupt handler.  At this point, the keystroke is
   represented as a struct input_event, while the desired quit
   character is specified as a lispy event.  The mapping from struct
   input_events to lispy events cannot run in an interrupt handler,
   and the reverse mapping is difficult for anything but ASCII
   keystrokes.

   FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
   ASCII character.  */
int quit_char;

extern Lisp_Object current_global_map;
extern int minibuf_level;

280 281 282
/* If non-nil, this is a map that overrides all other local maps.  */
Lisp_Object Voverriding_local_map;

283 284 285
/* If non-nil, Voverriding_local_map applies to the menu bar.  */
Lisp_Object Voverriding_local_map_menu_flag;

286 287 288 289
/* Keymap that defines special misc events that should
   be processed immediately at a low level.  */
Lisp_Object Vspecial_event_map;

Jim Blandy's avatar
Jim Blandy committed
290 291 292 293
/* Current depth in recursive edits.  */
int command_loop_level;

/* Total number of times command_loop has read a key sequence.  */
294
EMACS_INT num_input_keys;
Jim Blandy's avatar
Jim Blandy committed
295 296 297 298

/* Last input character read as a command.  */
Lisp_Object last_command_char;

299 300 301 302
/* Last input character read as a command, not counting menus
   reached by the mouse.  */
Lisp_Object last_nonmenu_event;

Jim Blandy's avatar
Jim Blandy committed
303 304 305
/* Last input character read for any purpose.  */
Lisp_Object last_input_char;

Jim Blandy's avatar
Jim Blandy committed
306
/* If not Qnil, a list of objects to be read as subsequent command input.  */
307
Lisp_Object Vunread_command_events;
Jim Blandy's avatar
Jim Blandy committed
308

309 310 311 312 313 314 315 316
/* If not Qnil, a list of objects to be read as subsequent command input
   including input method processing.  */
Lisp_Object Vunread_input_method_events;

/* If not Qnil, a list of objects to be read as subsequent command input
   but NOT including input method processing.  */
Lisp_Object Vunread_post_input_method_events;

317
/* If not -1, an event to be read as subsequent command input.  */
318
EMACS_INT unread_command_char;
319

320 321
/* If not Qnil, this is a switch-frame event which we decided to put
   off until the end of a key sequence.  This should be read as the
Jim Blandy's avatar
Jim Blandy committed
322
   next command input, after any unread_command_events.
323 324 325 326 327

   read_key_sequence uses this to delay switch-frame events until the
   end of the key sequence; Fread_char uses it to put off switch-frame
   events until a non-ASCII event is acceptable as input.  */
Lisp_Object unread_switch_frame;
328

329
/* A mask of extra modifier bits to put into every keyboard char.  */
330
EMACS_INT extra_keyboard_modifiers;
331

Jim Blandy's avatar
Jim Blandy committed
332 333 334 335 336 337 338 339
/* Char to use as prefix when a meta character is typed in.
   This is bound on entry to minibuffer in case ESC is changed there.  */

Lisp_Object meta_prefix_char;

/* Last size recorded for a current buffer which is not a minibuffer.  */
static int last_non_minibuf_size;

340
/* Number of idle seconds before an auto-save and garbage collection.  */
Jim Blandy's avatar
Jim Blandy committed
341 342 343
static Lisp_Object Vauto_save_timeout;

/* Total number of times read_char has returned.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
344
int num_input_events;
Jim Blandy's avatar
Jim Blandy committed
345

346
/* Total number of times read_char has returned, outside of macros.  */
347
EMACS_INT num_nonmacro_input_events;
348

Jim Blandy's avatar
Jim Blandy committed
349 350 351
/* Auto-save automatically when this many characters have been typed
   since the last time.  */

352
static EMACS_INT auto_save_interval;
Jim Blandy's avatar
Jim Blandy committed
353

354
/* Value of num_nonmacro_input_events as of last auto save.  */
Jim Blandy's avatar
Jim Blandy committed
355 356 357 358

int last_auto_save;

/* The command being executed by the command loop.
359 360
   Commands may set this, and the value set will be copied into
   current_kboard->Vlast_command instead of the actual command.  */
361 362 363 364
Lisp_Object Vthis_command;

/* This is like Vthis_command, except that commands never set it.  */
Lisp_Object real_this_command;
Jim Blandy's avatar
Jim Blandy committed
365

366 367 368 369
/* If the lookup of the command returns a binding, the original
   command is stored in this-original-command.  It is nil otherwise.  */
Lisp_Object Vthis_original_command;

370 371 372
/* The value of point when the last command was executed.  */
int last_point_position;

373 374 375
/* The buffer that was current when the last command was started.  */
Lisp_Object last_point_position_buffer;

376 377 378 379 380 381 382 383 384 385 386 387
/* The frame in which the last input event occurred, or Qmacro if the
   last event came from a macro.  We use this to determine when to
   generate switch-frame events.  This may be cleared by functions
   like Fselect_frame, to make sure that a switch-frame event is
   generated by the next character.  */
Lisp_Object internal_last_event_frame;

/* A user-visible version of the above, intended to allow users to
   figure out where the last event came from, if the event doesn't
   carry that information itself (i.e. if it was a character).  */
Lisp_Object Vlast_event_frame;

Jim Blandy's avatar
Jim Blandy committed
388 389
/* The timestamp of the last input event we received from the X server.
   X Windows wants this for selection ownership.  */
Jim Blandy's avatar
Jim Blandy committed
390 391 392 393 394
unsigned long last_event_timestamp;

Lisp_Object Qself_insert_command;
Lisp_Object Qforward_char;
Lisp_Object Qbackward_char;
395
Lisp_Object Qundefined;
396
Lisp_Object Qtimer_event_handler;
Jim Blandy's avatar
Jim Blandy committed
397 398 399 400 401

/* read_key_sequence stores here the command definition of the
   key sequence that it reads.  */
Lisp_Object read_key_sequence_cmd;

402 403 404
/* Echo unfinished commands after this many seconds of pause.  */
Lisp_Object Vecho_keystrokes;

Jim Blandy's avatar
Jim Blandy committed
405 406 407
/* Form to evaluate (if non-nil) when Emacs is started.  */
Lisp_Object Vtop_level;

408
/* User-supplied table to translate input characters.  */
Jim Blandy's avatar
Jim Blandy committed
409 410 411 412 413
Lisp_Object Vkeyboard_translate_table;

/* Keymap mapping ASCII function key sequences onto their preferred forms.  */
extern Lisp_Object Vfunction_key_map;

414 415 416
/* Another keymap that maps key sequences into key sequences.
   This one takes precedence over ordinary definitions.  */
extern Lisp_Object Vkey_translation_map;
417

418 419 420 421
/* If non-nil, this implements the current input method.  */
Lisp_Object Vinput_method_function;
Lisp_Object Qinput_method_function;

422 423 424 425
/* When we call Vinput_method_function,
   this holds the echo area message that was just erased.  */
Lisp_Object Vinput_method_previous_message;

426 427 428
/* Non-nil means deactivate the mark at end of this command.  */
Lisp_Object Vdeactivate_mark;

429 430 431 432 433
/* Menu bar specified in Lucid Emacs fashion.  */

Lisp_Object Vlucid_menu_bar_dirty_flag;
Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

434
Lisp_Object Qecho_area_clear_hook;
435

436
/* Hooks to run before and after each command.  */
437 438
Lisp_Object Qpre_command_hook, Vpre_command_hook;
Lisp_Object Qpost_command_hook, Vpost_command_hook;
439
Lisp_Object Qcommand_hook_internal, Vcommand_hook_internal;
440 441 442 443
/* Hook run after a command if there's no more input soon.  */
Lisp_Object Qpost_command_idle_hook, Vpost_command_idle_hook;

/* Delay time in microseconds before running post-command-idle-hook.  */
444
EMACS_INT post_command_idle_delay;
445

446 447 448 449 450 451
/* List of deferred actions to be performed at a later time.
   The precise format isn't relevant here; we just check whether it is nil.  */
Lisp_Object Vdeferred_action_list;

/* Function to call to handle deferred actions, when there are any.  */
Lisp_Object Vdeferred_action_function;
452
Lisp_Object Qdeferred_action_function;
453

454 455 456
Lisp_Object Qinput_method_exit_on_first_char;
Lisp_Object Qinput_method_use_echo_area;

Jim Blandy's avatar
Jim Blandy committed
457 458 459 460 461 462
/* File in which we write all commands we read.  */
FILE *dribble;

/* Nonzero if input is available.  */
int input_pending;

463 464 465 466
/* Non-zero means force key bindings update in parse_menu_item.  */

int update_menu_bindings;

Jim Blandy's avatar
Jim Blandy committed
467 468
extern char *pending_malloc_warning;

469
/* Circular buffer for pre-read keyboard input.  */
470

471 472
static struct input_event kbd_buffer[KBD_BUFFER_SIZE];

473
/* Vector to GCPRO the Lisp objects referenced from kbd_buffer.
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491

   The interrupt-level event handlers will never enqueue an event on a
   frame which is not in Vframe_list, and once an event is dequeued,
   internal_last_event_frame or the event itself points to the frame.
   So that's all fine.

   But while the event is sitting in the queue, it's completely
   unprotected.  Suppose the user types one command which will run for
   a while and then delete a frame, and then types another event at
   the frame that will be deleted, before the command gets around to
   it.  Suppose there are no references to this frame elsewhere in
   Emacs, and a GC occurs before the second event is dequeued.  Now we
   have an event referring to a freed frame, which will crash Emacs
   when it is dequeued.

   Similar things happen when an event on a scroll bar is enqueued; the
   window may be deleted while the event is in the queue.

492 493 494
   So, we use this vector to protect the Lisp_Objects in the event
   queue.  That way, they'll be dequeued as dead frames or windows,
   but still valid Lisp objects.
495

Pavel Janík's avatar
Pavel Janík committed
496
   If kbd_buffer[i].kind != NO_EVENT, then
497 498 499 500 501

   AREF (kbd_buffer_gcpro, 2 * i) == kbd_buffer[i].frame_or_window.
   AREF (kbd_buffer_gcpro, 2 * i + 1) == kbd_buffer[i].arg.  */

static Lisp_Object kbd_buffer_gcpro;
502 503 504

/* Pointer to next available character in kbd_buffer.
   If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
505
   This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
506 507 508 509 510 511
   next available char is in kbd_buffer[0].  */
static struct input_event *kbd_fetch_ptr;

/* Pointer to next place to store character in kbd_buffer.  This
   may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
   character should go in kbd_buffer[0].  */
512
static struct input_event * volatile kbd_store_ptr;
513 514 515 516 517 518 519 520 521 522

/* The above pair of variables forms a "queue empty" flag.  When we
   enqueue a non-hook event, we increment kbd_store_ptr.  When we
   dequeue a non-hook event, we increment kbd_fetch_ptr.  We say that
   there is input available iff the two pointers are not equal.

   Why not just have a flag set and cleared by the enqueuing and
   dequeuing functions?  Such a flag could be screwed up by interrupts
   at inopportune times.  */

Karl Heuer's avatar
Karl Heuer committed
523
/* If this flag is non-nil, we check mouse_moved to see when the
524 525
   mouse moves, and motion events will appear in the input stream.
   Otherwise, mouse motion is ignored.  */
526
Lisp_Object do_mouse_tracking;
Jim Blandy's avatar
Jim Blandy committed
527 528 529

/* Symbols to head events.  */
Lisp_Object Qmouse_movement;
530
Lisp_Object Qscroll_bar_movement;
531
Lisp_Object Qswitch_frame;
532
Lisp_Object Qdelete_frame;
533 534
Lisp_Object Qiconify_frame;
Lisp_Object Qmake_frame_visible;
Pavel Janík's avatar
Pavel Janík committed
535
Lisp_Object Qselect_window;
536
Lisp_Object Qhelp_echo;
537

Jim Blandy's avatar
Jim Blandy committed
538 539 540
/* Symbols to denote kinds of events.  */
Lisp_Object Qfunction_key;
Lisp_Object Qmouse_click;
Andrew Choi's avatar
In src:  
Andrew Choi committed
541
#ifdef WINDOWSNT
542
Lisp_Object Qlanguage_change;
543
#endif
544
Lisp_Object Qdrag_n_drop;
545 546
Lisp_Object Qsave_session;

Jim Blandy's avatar
Jim Blandy committed
547 548 549 550
/* Lisp_Object Qmouse_movement; - also an event header */

/* Properties of event headers.  */
Lisp_Object Qevent_kind;
551
Lisp_Object Qevent_symbol_elements;
Jim Blandy's avatar
Jim Blandy committed
552

553 554
/* menu item parts */
Lisp_Object Qmenu_alias;
555
Lisp_Object Qmenu_enable;
556 557
Lisp_Object QCenable, QCvisible, QChelp, QCfilter, QCkeys, QCkey_sequence;
Lisp_Object QCbutton, QCtoggle, QCradio;
558 559
extern Lisp_Object Vdefine_key_rebound_commands;
extern Lisp_Object Qmenu_item;
560

561 562 563 564 565 566 567 568 569 570 571 572 573
/* An event header symbol HEAD may have a property named
   Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
   BASE is the base, unmodified version of HEAD, and MODIFIERS is the
   mask of modifiers applied to it.  If present, this is used to help
   speed up parse_modifiers.  */
Lisp_Object Qevent_symbol_element_mask;

/* An unmodified event header BASE may have a property named
   Qmodifier_cache, which is an alist mapping modifier masks onto
   modified versions of BASE.  If present, this helps speed up
   apply_modifiers.  */
Lisp_Object Qmodifier_cache;

574
/* Symbols to use for parts of windows.  */
Jim Blandy's avatar
Jim Blandy committed
575
Lisp_Object Qmode_line;
Jim Blandy's avatar
Jim Blandy committed
576
Lisp_Object Qvertical_line;
577
Lisp_Object Qvertical_scroll_bar;
578
Lisp_Object Qmenu_bar;
579
extern Lisp_Object Qleft_margin, Qright_margin;
580
extern Lisp_Object Qleft_fringe, Qright_fringe;
581
extern Lisp_Object QCmap;
582

583 584
Lisp_Object recursive_edit_unwind (), command_loop ();
Lisp_Object Fthis_command_keys ();
585
Lisp_Object Qextended_command_history;
586
EMACS_TIME timer_check ();
Jim Blandy's avatar
Jim Blandy committed
587

588
extern Lisp_Object Vhistory_length, Vtranslation_table_for_input;
589

590 591
extern char *x_get_keysym_name ();

592
static void record_menu_key ();
593
static int echo_length ();
594

595 596
Lisp_Object Qpolling_period;

597
/* List of absolute timers.  Appears in order of next scheduled event.  */
598 599
Lisp_Object Vtimer_list;

600 601 602
/* List of idle time timers.  Appears in order of next scheduled event.  */
Lisp_Object Vtimer_idle_list;

603 604 605
/* Incremented whenever a timer is run.  */
int timers_run;

606 607
extern Lisp_Object Vprint_level, Vprint_length;

Jim Blandy's avatar
Jim Blandy committed
608 609 610
/* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
   happens.  */
EMACS_TIME *input_available_clear_time;
Jim Blandy's avatar
Jim Blandy committed
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631

/* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
   Default is 1 if INTERRUPT_INPUT is defined.  */
int interrupt_input;

/* Nonzero while interrupts are temporarily deferred during redisplay.  */
int interrupts_deferred;

/* Allow m- file to inhibit use of FIONREAD.  */
#ifdef BROKEN_FIONREAD
#undef FIONREAD
#endif

/* We are unable to use interrupts if FIONREAD is not available,
   so flush SIGIO so we won't try.  */
#ifndef FIONREAD
#ifdef SIGIO
#undef SIGIO
#endif
#endif

632
/* If we support a window system, turn on the code to poll periodically
633
   to detect C-g.  It isn't actually used when doing interrupt input.  */
Andrew Choi's avatar
In src:  
Andrew Choi committed
634
#if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
Jim Blandy's avatar
Jim Blandy committed
635 636
#define POLL_FOR_INPUT
#endif
637 638 639 640

/* After a command is executed, if point is moved into a region that
   has specific properties (e.g. composition, display), we adjust
   point to the boundary of the region.  But, if a command sets this
Pavel Janík's avatar
Pavel Janík committed
641
   variable to non-nil, we suppress this point adjustment.  This
642
   variable is set to nil before reading a command.  */
643

644 645 646
Lisp_Object Vdisable_point_adjustment;

/* If non-nil, always disable point adjustment.  */
647

648 649
Lisp_Object Vglobal_disable_point_adjustment;

650 651 652 653
/* The time when Emacs started being idle.  */

static EMACS_TIME timer_idleness_start_time;

654 655 656 657 658
/* After Emacs stops being idle, this saves the last value
   of timer_idleness_start_time from when it was idle.  */

static EMACS_TIME timer_last_idleness_start_time;

Jim Blandy's avatar
Jim Blandy committed
659 660 661 662 663 664

/* Global variable declarations.  */

/* Function for init_keyboard to call with no args (if nonzero).  */
void (*keyboard_init_hook) ();

665 666
static int read_avail_input P_ ((int));
static void get_input_pending P_ ((int *, int));
667
static void get_filtered_input_pending P_ ((int *, int, int));
668
static int readable_events P_ ((int));
669
static int readable_filtered_events P_ ((int, int));
670 671
static Lisp_Object read_char_x_menu_prompt P_ ((int, Lisp_Object *,
						Lisp_Object, int *));
672
static Lisp_Object read_char_x_menu_prompt ();
673 674 675
static Lisp_Object read_char_minibuf_menu_prompt P_ ((int, int,
						      Lisp_Object *));
static Lisp_Object make_lispy_event P_ ((struct input_event *));
676
#ifdef HAVE_MOUSE
677 678 679 680
static Lisp_Object make_lispy_movement P_ ((struct frame *, Lisp_Object,
					    enum scroll_bar_part,
					    Lisp_Object, Lisp_Object,
					    unsigned long));
681
#endif
682 683 684 685 686
static Lisp_Object modify_event_symbol P_ ((int, unsigned, Lisp_Object,
					    Lisp_Object, char **,
					    Lisp_Object *, unsigned));
static Lisp_Object make_lispy_switch_frame P_ ((Lisp_Object));
static int parse_solitary_modifier P_ ((Lisp_Object));
687
static int parse_solitary_modifier ();
688
static void save_getcjmp P_ ((jmp_buf));
Andreas Schwab's avatar
Andreas Schwab committed
689
static void save_getcjmp ();
690
static void restore_getcjmp P_ ((jmp_buf));
691
static Lisp_Object apply_modifiers P_ ((int, Lisp_Object));
692
static void clear_event P_ ((struct input_event *));
693
static void any_kboard_state P_ ((void));
694
static SIGTYPE interrupt_signal P_ ((int signalnum));
Jim Blandy's avatar
Jim Blandy committed
695

696 697 698 699
/* Nonzero means don't try to suspend even if the operating system seems
   to support it.  */
static int cannot_suspend;

Jim Blandy's avatar
Jim Blandy committed
700 701 702 703
/* Install the string STR as the beginning of the string of echoing,
   so that it serves as a prompt for the next character.
   Also start echoing.  */

Andreas Schwab's avatar
Andreas Schwab committed
704
void
Jim Blandy's avatar
Jim Blandy committed
705
echo_prompt (str)
706
     Lisp_Object str;
Jim Blandy's avatar
Jim Blandy committed
707
{
708
  current_kboard->echo_string = str;
709
  current_kboard->echo_after_prompt = SCHARS (str);
710
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
711 712
}

713
/* Add C to the echo string, if echoing is going on.
Jim Blandy's avatar
Jim Blandy committed
714 715 716
   C can be a character, which is printed prettily ("M-C-x" and all that
   jazz), or a symbol, whose name is printed.  */

Andreas Schwab's avatar
Andreas Schwab committed
717
void
Jim Blandy's avatar
Jim Blandy committed
718 719 720
echo_char (c)
     Lisp_Object c;
{
721
  if (current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
722
    {
723 724 725 726
      int size = KEY_DESCRIPTION_SIZE + 100;
      char *buffer = (char *) alloca (size);
      char *ptr = buffer;
      Lisp_Object echo_string;
Jim Blandy's avatar
Jim Blandy committed
727

728
      echo_string = current_kboard->echo_string;
Juanma Barranquero's avatar
Juanma Barranquero committed
729

Jim Blandy's avatar
Jim Blandy committed
730
      /* If someone has passed us a composite event, use its head symbol.  */
731
      c = EVENT_HEAD (c);
Jim Blandy's avatar
Jim Blandy committed
732

733
      if (INTEGERP (c))
Jim Blandy's avatar
Jim Blandy committed
734
	{
735
	  ptr = push_key_description (XINT (c), ptr, 1);
Jim Blandy's avatar
Jim Blandy committed
736
	}
737
      else if (SYMBOLP (c))
Jim Blandy's avatar
Jim Blandy committed
738
	{
739 740
	  Lisp_Object name = SYMBOL_NAME (c);
	  int nbytes = SBYTES (name);
Juanma Barranquero's avatar
Juanma Barranquero committed
741

742
	  if (size - (ptr - buffer) < nbytes)
743 744
	    {
	      int offset = ptr - buffer;
745
	      size = max (2 * size, size + nbytes);
746 747 748 749
	      buffer = (char *) alloca (size);
	      ptr = buffer + offset;
	    }

750 751
	  ptr += copy_text (SDATA (name), ptr, nbytes,
			    STRING_MULTIBYTE (name), 1);
Jim Blandy's avatar
Jim Blandy committed
752 753
	}

754
      if ((NILP (echo_string) || SCHARS (echo_string) == 0)
Karl Heuer's avatar
Karl Heuer committed
755
	  && help_char_p (c))
Jim Blandy's avatar
Jim Blandy committed
756
	{
757 758
	  const char *text = " (Type ? for further options)";
	  int len = strlen (text);
Juanma Barranquero's avatar
Juanma Barranquero committed
759

760 761 762 763 764 765 766 767 768 769
	  if (size - (ptr - buffer) < len)
	    {
	      int offset = ptr - buffer;
	      size += len;
	      buffer = (char *) alloca (size);
	      ptr = buffer + offset;
	    }

	  bcopy (text, ptr, len);
	  ptr += len;
Jim Blandy's avatar
Jim Blandy committed
770 771
	}

772 773
      /* Replace a dash from echo_dash with a space, otherwise
	 add a space at the end as a separator between keys.  */
774
      if (STRINGP (echo_string)
775
	  && SCHARS (echo_string) > 1)
776
	{
777 778 779 780
	  Lisp_Object last_char, prev_char, idx;

	  idx = make_number (SCHARS (echo_string) - 2);
	  prev_char = Faref (echo_string, idx);
781 782 783 784

	  idx = make_number (SCHARS (echo_string) - 1);
	  last_char = Faref (echo_string, idx);

785 786 787
	  /* We test PREV_CHAR to make sure this isn't the echoing
	     of a minus-sign.  */
	  if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
788 789 790 791
	    Faset (echo_string, idx, make_number (' '));
	  else
	    echo_string = concat2 (echo_string, build_string (" "));
	}
792 793 794

      current_kboard->echo_string
	= concat2 (echo_string, make_string (buffer, ptr - buffer));
Jim Blandy's avatar
Jim Blandy committed
795

796
      echo_now ();
Jim Blandy's avatar
Jim Blandy committed
797 798 799 800 801 802
    }
}

/* Temporarily add a dash to the end of the echo string if it's not
   empty, so that it serves as a mini-prompt for the very next character.  */

Andreas Schwab's avatar
Andreas Schwab committed
803
void
Jim Blandy's avatar
Jim Blandy committed
804 805
echo_dash ()
{
806 807 808 809
  /* Do nothing if not echoing at all.  */
  if (NILP (current_kboard->echo_string))
    return;

810
  if (!current_kboard->immediate_echo
811
      && SCHARS (current_kboard->echo_string) == 0)
Jim Blandy's avatar
Jim Blandy committed
812
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
813

814
  /* Do nothing if we just printed a prompt.  */
815
  if (current_kboard->echo_after_prompt
816
      == SCHARS (current_kboard->echo_string))
817
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
818

Jim Blandy's avatar
Jim Blandy committed
819 820
  /* Put a dash at the end of the buffer temporarily,
     but make it go away when the next character is added.  */
821 822
  current_kboard->echo_string = concat2 (current_kboard->echo_string,
					 build_string ("-"));
823
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
824 825 826 827 828
}

/* Display the current echo string, and begin echoing if not already
   doing so.  */

829
void
830
echo_now ()
Jim Blandy's avatar
Jim Blandy committed
831
{
832
  if (!current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
833 834
    {
      int i;
835
      current_kboard->immediate_echo = 1;
Jim Blandy's avatar
Jim Blandy committed
836 837

      for (i = 0; i < this_command_key_count; i++)
838 839
	{
	  Lisp_Object c;
840 841 842 843 844 845 846

	  /* Set before_command_echo_length to the value that would
	     have been saved before the start of this subcommand in
	     command_loop_1, if we had already been echoing then.  */
	  if (i == this_single_command_key_start)
	    before_command_echo_length = echo_length ();

847 848 849 850 851
	  c = XVECTOR (this_command_keys)->contents[i];
	  if (! (EVENT_HAS_PARAMETERS (c)
		 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
	    echo_char (c);
	}
852 853 854 855 856 857 858 859

      /* Set before_command_echo_length to the value that would
	 have been saved before the start of this subcommand in
	 command_loop_1, if we had already been echoing then.  */
      if (this_command_key_count == this_single_command_key_start)
	before_command_echo_length = echo_length ();

      /* Put a dash at the end to invite the user to type more.  */
Jim Blandy's avatar
Jim Blandy committed
860 861 862 863
      echo_dash ();
    }

  echoing = 1;
864
  message3_nolog (current_kboard->echo_string,
865
		  SBYTES (current_kboard->echo_string),
866
		  STRING_MULTIBYTE (current_kboard->echo_string));
Jim Blandy's avatar
Jim Blandy committed
867 868
  echoing = 0;

869 870 871 872
  /* Record in what buffer we echoed, and from which kboard.  */
  echo_message_buffer = echo_area_buffer[0];
  echo_kboard = current_kboard;

Jim Blandy's avatar
Jim Blandy committed
873 874 875 876 877 878
  if (waiting_for_input && !NILP (Vquit_flag))
    quit_throw_to_read_char ();
}

/* Turn off echoing, for the start of a new command.  */

Andreas Schwab's avatar
Andreas Schwab committed
879
void
Jim Blandy's avatar
Jim Blandy committed
880 881
cancel_echoing ()
{
882 883
  current_kboard->immediate_echo = 0;
  current_kboard->echo_after_prompt = -1;
884
  current_kboard->echo_string = Qnil;
885 886 887
  ok_to_echo_at_next_pause = NULL;
  echo_kboard = NULL;
  echo_message_buffer = Qnil;
Jim Blandy's avatar
Jim Blandy committed
888 889 890 891 892 893 894
}

/* Return the length of the current echo string.  */

static int
echo_length ()
{
895
  return (STRINGP (current_kboard->echo_string)
896
	  ? SCHARS (current_kboard->echo_string)
897
	  : 0);
Jim Blandy's avatar
Jim Blandy committed
898 899 900 901
}

/* Truncate the current echo message to its first LEN chars.
   This and echo_char get used by read_key_sequence when the user
Jim Blandy's avatar
Jim Blandy committed
902
   switches frames while entering a key sequence.  */
Jim Blandy's avatar
Jim Blandy committed
903 904

static void
905 906 907 908 909 910 911 912
echo_truncate (nchars)
     int nchars;
{
  if (STRINGP (current_kboard->echo_string))
    current_kboard->echo_string
      = Fsubstring (current_kboard->echo_string,
		    make_number (0), make_number (nchars));
  truncate_echo_area (nchars);
Jim Blandy's avatar
Jim Blandy committed
913 914 915 916 917 918 919 920
}


/* Functions for manipulating this_command_keys.  */
static void
add_command_key (key)
     Lisp_Object key;
{
921 922
#if 0 /* Not needed after we made Freset_this_command_lengths
	 do the job immediately.  */
923 924 925 926 927
  /* If reset-this-command-length was called recently, obey it now.
     See the doc string of that function for an explanation of why.  */
  if (before_command_restore_flag)
    {
      this_command_key_count = before_command_key_count_1;
928 929
      if (this_command_key_count < this_single_command_key_start)
	this_single_command_key_start = this_command_key_count;
930 931 932
      echo_truncate (before_command_echo_length_1);
      before_command_restore_flag = 0;
    }
933
#endif
934

935 936 937 938
  if (this_command_key_count >= ASIZE (this_command_keys))
    this_command_keys = larger_vector (this_command_keys,
				       2 * ASIZE (this_command_keys),
				       Qnil);
939

940 941
  AREF (this_command_keys, this_command_key_count) = key;
  ++this_command_key_count;
Jim Blandy's avatar
Jim Blandy committed
942
}
943

Jim Blandy's avatar
Jim Blandy committed
944 945 946 947

Lisp_Object
recursive_edit_1 ()
{
Juanma Barranquero's avatar
Juanma Barranquero committed
948
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
949 950 951 952 953 954 955 956
  Lisp_Object val;

  if (command_loop_level > 0)
    {
      specbind (Qstandard_output, Qt);
      specbind (Qstandard_input, Qt);
    }

957
#ifdef HAVE_X_WINDOWS
958
  /* The command loop has started an hourglass timer, so we have to
959
     cancel it here, otherwise it will fire because the recursive edit
960 961
     can take some time.  Do not check for display_hourglass_p here,
     because it could already be nil.  */
962
    cancel_hourglass ();
963 964
#endif

965 966 967 968 969 970 971 972 973 974 975 976
  /* This function may have been called from a debugger called from
     within redisplay, for instance by Edebugging a function called
     from fontification-functions.  We want to allow redisplay in
     the debugging session.

     The recursive edit is left with a `(throw exit ...)'.  The `exit'
     tag is not caught anywhere in redisplay, i.e. when we leave the
     recursive edit, the original redisplay leading to the recursive
     edit will be unwound.  The outcome should therefore be safe.  */
  specbind (Qinhibit_redisplay, Qnil);
  redisplaying_p = 0;

Jim Blandy's avatar
Jim Blandy committed
977 978 979
  val = command_loop ();
  if (EQ (val, Qt))
    Fsignal (Qquit, Qnil);
980 981 982 983
  /* Handle throw from read_minibuf when using minibuffer
     while it's active but we're in another window.  */
  if (STRINGP (val))
    Fsignal (Qerror, Fcons (val, Qnil));
Jim Blandy's avatar
Jim Blandy committed
984

985
  return unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
986 987 988
}

/* When an auto-save happens, record the "time", and don't do again soon.  */
989

990
void
Jim Blandy's avatar
Jim Blandy committed
991 992
record_auto_save ()
{
993
  last_auto_save = num_nonmacro_input_events;
Jim Blandy's avatar
Jim Blandy committed
994
}
995 996 997

/* Make an auto save happen as soon as possible at command level.  */

Andreas Schwab's avatar
Andreas Schwab committed
998
void
999 1000 1001
force_auto_save_soon ()
{
  last_auto_save = - auto_save_interval - 1;
1002 1003

  record_asynch_buffer_change ();