keyboard.c 320 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, 2001
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 25 26 27 28 29
#include <stdio.h>
#include "termchar.h"
#include "termopts.h"
#include "lisp.h"
#include "termhooks.h"
#include "macros.h"
30
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
31
#include "frame.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
#include "syssignal.h"
58
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
59

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

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

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

74 75 76 77
#ifdef macintosh
#include "macterm.h"
#endif

78 79 80
/* Include systime.h after xterm.h to avoid double inclusion of time.h. */
#include "systime.h"

81
#ifndef USE_CRT_DLL
Jim Blandy's avatar
Jim Blandy committed
82
extern int errno;
83
#endif
Jim Blandy's avatar
Jim Blandy committed
84

85 86 87
/* Variables for blockinput.h: */

/* Non-zero if interrupt input is blocked right now.  */
88
int interrupt_input_blocked;
89 90 91

/* Nonzero means an input interrupt has arrived
   during the current critical section.  */
92
int interrupt_input_pending;
93 94


95 96
/* File descriptor to use for input.  */
extern int input_fd;
Jim Blandy's avatar
Jim Blandy committed
97

98
#ifdef HAVE_WINDOW_SYSTEM
Jim Blandy's avatar
Jim Blandy committed
99
/* Make all keyboard buffers much bigger when using X windows.  */
100
#ifdef macintosh
101
/* But not too big (local data > 32K error) if on macintosh.  */
102 103
#define KBD_BUFFER_SIZE 512
#else
Jim Blandy's avatar
Jim Blandy committed
104
#define KBD_BUFFER_SIZE 4096
105
#endif
Jim Blandy's avatar
Jim Blandy committed
106
#else	/* No X-windows, character input */
107
#define KBD_BUFFER_SIZE 4096
Jim Blandy's avatar
Jim Blandy committed
108 109
#endif	/* No X-windows */

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

Jim Blandy's avatar
Jim Blandy committed
112 113 114 115 116 117 118 119 120 121 122 123 124
/* 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;
  };

125 126 127 128
#ifdef MULTI_KBOARD
KBOARD *initial_kboard;
KBOARD *current_kboard;
KBOARD *all_kboards;
129
int single_kboard;
130
#else
131
KBOARD the_only_kboard;
132
#endif
133

Jim Blandy's avatar
Jim Blandy committed
134 135
/* Non-nil disable property on a command means
   do not execute it; call disabled-command-hook's value instead.  */
136
Lisp_Object Qdisabled, Qdisabled_command_hook;
Jim Blandy's avatar
Jim Blandy committed
137 138 139 140

#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 */
141
Lisp_Object recent_keys; /* A vector, holding the last 100 keystrokes */
Jim Blandy's avatar
Jim Blandy committed
142

143 144 145 146 147 148 149
/* 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
150

151 152 153 154 155 156
/* 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							\
157
 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size)			\
158 159 160 161 162 163 164 165 166
  {									\
    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;							\
  }

167 168 169 170
/* Number of elements of this_command_keys
   that precede this key sequence.  */
int this_single_command_key_start;

171 172 173 174 175 176 177 178 179 180 181 182
/* 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;
/* Values of before_command_key_count and before_command_echo_length
   saved by reset-this-command-lengths.  */
static int before_command_key_count_1;
static int before_command_echo_length_1;
/* Flag set by reset-this-command-lengths,
   saying to reset the lengths when add_command_key is called.  */
static int before_command_restore_flag;

Jim Blandy's avatar
Jim Blandy committed
183 184
extern int minbuf_level;

185 186
extern int message_enable_multibyte;

Jim Blandy's avatar
Jim Blandy committed
187 188
extern struct backtrace *backtrace_list;

189 190 191 192 193
/* 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;

194 195 196 197 198
/* 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
199
/* Nonzero means do menu prompting.  */
200

Jim Blandy's avatar
Jim Blandy committed
201 202 203
static int menu_prompting;

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

Jim Blandy's avatar
Jim Blandy committed
205 206 207
static Lisp_Object menu_prompt_more_char;

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

Jim Blandy's avatar
Jim Blandy committed
209 210 211 212 213 214
static jmp_buf getcjmp;

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

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

216
int echoing;
Jim Blandy's avatar
Jim Blandy committed
217

218 219 220 221 222
/* 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;

223 224 225 226
/* 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.  */
227

228
struct kboard *echo_kboard;
229

230 231 232
/* The buffer used for echoing.  Set in echo_now, reset in
   cancel_echoing.  */

233
Lisp_Object echo_message_buffer;
234

235 236 237
/* Nonzero means disregard local maps for the menu bar.  */
static int inhibit_local_menu_bar_menus;

238
/* Nonzero means C-g should cause immediate error-signal.  */
Jim Blandy's avatar
Jim Blandy committed
239 240
int immediate_quit;

241 242 243
/* The user's ERASE setting.  */
Lisp_Object Vtty_erase_char;

Jim Blandy's avatar
Jim Blandy committed
244
/* Character to recognize as the help char.  */
245
Lisp_Object Vhelp_char;
Jim Blandy's avatar
Jim Blandy committed
246

Karl Heuer's avatar
Karl Heuer committed
247 248 249
/* List of other event types to recognize as meaning "help".  */
Lisp_Object Vhelp_event_list;

Jim Blandy's avatar
Jim Blandy committed
250 251 252
/* Form to execute when help char is typed.  */
Lisp_Object Vhelp_form;

253 254 255
/* Command to run when the help character follows a prefix key.  */
Lisp_Object Vprefix_help_command;

256 257
/* List of items that should move to the end of the menu bar.  */
Lisp_Object Vmenu_bar_final_items;
258

259 260 261 262 263 264
/* 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;

265 266 267 268
/* 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
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
/* 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;

290 291 292
/* If non-nil, this is a map that overrides all other local maps.  */
Lisp_Object Voverriding_local_map;

293 294 295
/* If non-nil, Voverriding_local_map applies to the menu bar.  */
Lisp_Object Voverriding_local_map_menu_flag;

296 297 298 299
/* 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
300 301 302 303 304 305 306 307 308
/* Current depth in recursive edits.  */
int command_loop_level;

/* Total number of times command_loop has read a key sequence.  */
int num_input_keys;

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

309 310 311 312
/* 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
313 314 315
/* Last input character read for any purpose.  */
Lisp_Object last_input_char;

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

319 320 321 322 323 324 325 326
/* 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;

327 328 329
/* If not -1, an event to be read as subsequent command input.  */
int unread_command_char;

330 331
/* 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
332
   next command input, after any unread_command_events.
333 334 335 336 337

   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;
338

339 340 341
/* A mask of extra modifier bits to put into every keyboard char.  */
int extra_keyboard_modifiers;

Jim Blandy's avatar
Jim Blandy committed
342 343 344 345 346 347 348 349
/* 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;

350
/* Number of idle seconds before an auto-save and garbage collection.  */
Jim Blandy's avatar
Jim Blandy committed
351 352 353
static Lisp_Object Vauto_save_timeout;

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

356
/* Total number of times read_char has returned, outside of macros.  */
357
int num_nonmacro_input_events;
358

Jim Blandy's avatar
Jim Blandy committed
359 360 361 362 363
/* Auto-save automatically when this many characters have been typed
   since the last time.  */

static int auto_save_interval;

364
/* Value of num_nonmacro_input_events as of last auto save.  */
Jim Blandy's avatar
Jim Blandy committed
365 366 367 368

int last_auto_save;

/* The command being executed by the command loop.
369 370
   Commands may set this, and the value set will be copied into
   current_kboard->Vlast_command instead of the actual command.  */
371 372 373 374
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
375

376 377 378
/* The value of point when the last command was executed.  */
int last_point_position;

379 380 381
/* The buffer that was current when the last command was started.  */
Lisp_Object last_point_position_buffer;

382 383 384 385 386 387 388 389 390 391 392 393
/* 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
394 395
/* 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
396 397 398 399 400
unsigned long last_event_timestamp;

Lisp_Object Qself_insert_command;
Lisp_Object Qforward_char;
Lisp_Object Qbackward_char;
401
Lisp_Object Qundefined;
402
Lisp_Object Qtimer_event_handler;
Jim Blandy's avatar
Jim Blandy committed
403 404 405 406 407

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

408 409 410
/* Echo unfinished commands after this many seconds of pause.  */
Lisp_Object Vecho_keystrokes;

Jim Blandy's avatar
Jim Blandy committed
411 412 413 414 415 416 417 418 419
/* Form to evaluate (if non-nil) when Emacs is started.  */
Lisp_Object Vtop_level;

/* User-supplied string to translate input characters through.  */
Lisp_Object Vkeyboard_translate_table;

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

420 421 422
/* Another keymap that maps key sequences into key sequences.
   This one takes precedence over ordinary definitions.  */
extern Lisp_Object Vkey_translation_map;
423

424 425 426 427
/* If non-nil, this implements the current input method.  */
Lisp_Object Vinput_method_function;
Lisp_Object Qinput_method_function;

428 429 430 431
/* When we call Vinput_method_function,
   this holds the echo area message that was just erased.  */
Lisp_Object Vinput_method_previous_message;

432 433 434
/* Non-nil means deactivate the mark at end of this command.  */
Lisp_Object Vdeactivate_mark;

435 436 437 438 439
/* Menu bar specified in Lucid Emacs fashion.  */

Lisp_Object Vlucid_menu_bar_dirty_flag;
Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

440
Lisp_Object Qecho_area_clear_hook;
441

442
/* Hooks to run before and after each command.  */
443 444
Lisp_Object Qpre_command_hook, Vpre_command_hook;
Lisp_Object Qpost_command_hook, Vpost_command_hook;
445
Lisp_Object Qcommand_hook_internal, Vcommand_hook_internal;
446 447 448 449 450
/* 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.  */
int post_command_idle_delay;
451

452 453 454 455 456 457
/* 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;
458
Lisp_Object Qdeferred_action_function;
459

460 461 462
Lisp_Object Qinput_method_exit_on_first_char;
Lisp_Object Qinput_method_use_echo_area;

Jim Blandy's avatar
Jim Blandy committed
463 464 465 466 467 468
/* File in which we write all commands we read.  */
FILE *dribble;

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

469 470 471
/* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
   keep 0200 bit in input chars.  0 to ignore the 0200 bit.  */

Jim Blandy's avatar
Jim Blandy committed
472 473
int meta_key;

474 475 476 477
/* Non-zero means force key bindings update in parse_menu_item.  */

int update_menu_bindings;

Jim Blandy's avatar
Jim Blandy committed
478 479
extern char *pending_malloc_warning;

480
/* Circular buffer for pre-read keyboard input.  */
481

482 483
static struct input_event kbd_buffer[KBD_BUFFER_SIZE];

484
/* Vector to GCPRO the Lisp objects referenced from kbd_buffer.
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502

   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.

503 504 505
   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.
506 507

   If kbd_buffer[i].kind != no_event, then
508 509 510 511 512

   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;
513 514 515

/* Pointer to next available character in kbd_buffer.
   If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
516
   This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
517 518 519 520 521 522
   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].  */
523
static struct input_event * volatile kbd_store_ptr;
524 525 526 527 528 529 530 531 532 533

/* 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
534
/* If this flag is non-nil, we check mouse_moved to see when the
535 536
   mouse moves, and motion events will appear in the input stream.
   Otherwise, mouse motion is ignored.  */
537
Lisp_Object do_mouse_tracking;
Jim Blandy's avatar
Jim Blandy committed
538 539 540

/* Symbols to head events.  */
Lisp_Object Qmouse_movement;
541
Lisp_Object Qscroll_bar_movement;
542
Lisp_Object Qswitch_frame;
543
Lisp_Object Qdelete_frame;
544 545
Lisp_Object Qiconify_frame;
Lisp_Object Qmake_frame_visible;
546
Lisp_Object Qhelp_echo;
547

Jim Blandy's avatar
Jim Blandy committed
548 549 550
/* Symbols to denote kinds of events.  */
Lisp_Object Qfunction_key;
Lisp_Object Qmouse_click;
551 552
#ifdef WINDOWSNT
Lisp_Object Qmouse_wheel;
553
Lisp_Object Qlanguage_change;
554
#endif
555
Lisp_Object Qdrag_n_drop;
Jim Blandy's avatar
Jim Blandy committed
556 557 558 559
/* Lisp_Object Qmouse_movement; - also an event header */

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

562 563
/* menu item parts */
Lisp_Object Qmenu_alias;
564
Lisp_Object Qmenu_enable;
565 566
Lisp_Object QCenable, QCvisible, QChelp, QCfilter, QCkeys, QCkey_sequence;
Lisp_Object QCbutton, QCtoggle, QCradio;
567 568
extern Lisp_Object Vdefine_key_rebound_commands;
extern Lisp_Object Qmenu_item;
569

570 571 572 573 574 575 576 577 578 579 580 581 582
/* 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;

583
/* Symbols to use for parts of windows.  */
Jim Blandy's avatar
Jim Blandy committed
584
Lisp_Object Qmode_line;
Jim Blandy's avatar
Jim Blandy committed
585
Lisp_Object Qvertical_line;
586
Lisp_Object Qvertical_scroll_bar;
587 588
Lisp_Object Qmenu_bar;

589 590
Lisp_Object recursive_edit_unwind (), command_loop ();
Lisp_Object Fthis_command_keys ();
591
Lisp_Object Qextended_command_history;
592
EMACS_TIME timer_check ();
Jim Blandy's avatar
Jim Blandy committed
593

594 595
extern Lisp_Object Vhistory_length;

596 597
extern char *x_get_keysym_name ();

598 599
static void record_menu_key ();

600 601
Lisp_Object Qpolling_period;

602
/* List of absolute timers.  Appears in order of next scheduled event.  */
603 604
Lisp_Object Vtimer_list;

605 606 607
/* List of idle time timers.  Appears in order of next scheduled event.  */
Lisp_Object Vtimer_idle_list;

608 609 610
/* Incremented whenever a timer is run.  */
int timers_run;

611 612
extern Lisp_Object Vprint_level, Vprint_length;

Jim Blandy's avatar
Jim Blandy committed
613 614 615
/* 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
616 617 618 619 620 621 622 623

/* 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;

624
/* Nonzero means use ^S/^Q for flow control.  */
Jim Blandy's avatar
Jim Blandy committed
625 626 627 628 629 630 631 632 633 634 635 636 637 638 639
int flow_control;

/* 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

640
/* If we support a window system, turn on the code to poll periodically
641
   to detect C-g.  It isn't actually used when doing interrupt input.  */
642
#ifdef HAVE_WINDOW_SYSTEM
Jim Blandy's avatar
Jim Blandy committed
643 644
#define POLL_FOR_INPUT
#endif
645 646 647 648 649 650

/* 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
   valiable to non-nil, we suppress this point adjustment.  This
   variable is set to nil before reading a command.  */
651

652 653 654
Lisp_Object Vdisable_point_adjustment;

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

656 657
Lisp_Object Vglobal_disable_point_adjustment;

658 659 660 661
/* The time when Emacs started being idle.  */

static EMACS_TIME timer_idleness_start_time;

Jim Blandy's avatar
Jim Blandy committed
662 663 664 665 666 667

/* Global variable declarations.  */

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

668 669 670 671 672
static int read_avail_input P_ ((int));
static void get_input_pending P_ ((int *, int));
static int readable_events P_ ((int));
static Lisp_Object read_char_x_menu_prompt P_ ((int, Lisp_Object *,
						Lisp_Object, int *));
673
static Lisp_Object read_char_x_menu_prompt ();
674 675 676
static Lisp_Object read_char_minibuf_menu_prompt P_ ((int, int,
						      Lisp_Object *));
static Lisp_Object make_lispy_event P_ ((struct input_event *));
677
#ifdef HAVE_MOUSE
678 679 680 681
static Lisp_Object make_lispy_movement P_ ((struct frame *, Lisp_Object,
					    enum scroll_bar_part,
					    Lisp_Object, Lisp_Object,
					    unsigned long));
682
#endif
683 684 685 686 687
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));
688
static int parse_solitary_modifier ();
689
static void save_getcjmp P_ ((jmp_buf));
Andreas Schwab's avatar
Andreas Schwab committed
690
static void save_getcjmp ();
691
static void restore_getcjmp P_ ((jmp_buf));
692
static Lisp_Object apply_modifiers P_ ((int, Lisp_Object));
693
static void clear_event P_ ((struct input_event *));
694
static void any_kboard_state P_ ((void));
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
  int nbytes = STRING_BYTES (XSTRING (str));
709
  int multibyte_p = STRING_MULTIBYTE (str);
710

711
  if (nbytes > ECHOBUFSIZE - 4)
712 713 714
    {
      if (multibyte_p)
	{
715 716 717
	  /* Have to find the last character that fit's into the 
	     echo buffer.  */
	  unsigned char *p = XSTRING (str)->data;
718
	  unsigned char *pend = p + ECHOBUFSIZE - 4;
719
	  int char_len;
720

721
	  do
722
	    {
723 724
	      PARSE_MULTIBYTE_SEQ (p, pend - p, char_len);
	      p += char_len;
725
	    }
726 727 728
	  while (p < pend);

	  nbytes = p - XSTRING (str)->data - char_len;
729 730
	}
      else
731
	nbytes = ECHOBUFSIZE - 4;
732 733
    }

734 735 736
  nbytes = copy_text (XSTRING (str)->data, current_kboard->echobuf, nbytes,
		      STRING_MULTIBYTE (str), 1);
  current_kboard->echoptr = current_kboard->echobuf + nbytes;
737
  *current_kboard->echoptr = '\0';
738
  current_kboard->echo_after_prompt = nbytes;
739

740
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
741 742
}

743
/* Add C to the echo string, if echoing is going on.
Jim Blandy's avatar
Jim Blandy committed
744 745 746
   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
747
void
Jim Blandy's avatar
Jim Blandy committed
748 749 750
echo_char (c)
     Lisp_Object c;
{
751
  if (current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
752
    {
753
      char *ptr = current_kboard->echoptr;
754

755
      if (ptr != current_kboard->echobuf)
Jim Blandy's avatar
Jim Blandy committed
756 757 758
	*ptr++ = ' ';

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

761
      if (INTEGERP (c))
Jim Blandy's avatar
Jim Blandy committed
762
	{
763 764
	  int ch = XINT (c);

765 766
	  if (ptr - current_kboard->echobuf
	      > ECHOBUFSIZE - KEY_DESCRIPTION_SIZE)
Jim Blandy's avatar
Jim Blandy committed
767 768
	    return;

769
	  ptr = push_key_description (ch, ptr, 1);
Jim Blandy's avatar
Jim Blandy committed
770
	}
771
      else if (SYMBOLP (c))
Jim Blandy's avatar
Jim Blandy committed
772 773
	{
	  struct Lisp_String *name = XSYMBOL (c)->name;
774
	  if ((ptr - current_kboard->echobuf) + STRING_BYTES (name) + 4
775
	      > ECHOBUFSIZE)
Jim Blandy's avatar
Jim Blandy committed
776
	    return;
777 778
	  ptr += copy_text (name->data, ptr, STRING_BYTES (name),
			    name->size_byte >= 0, 1);
Jim Blandy's avatar
Jim Blandy committed
779 780
	}

781
      if (current_kboard->echoptr == current_kboard->echobuf
Karl Heuer's avatar
Karl Heuer committed
782
	  && help_char_p (c))
Jim Blandy's avatar
Jim Blandy committed
783 784 785 786 787 788
	{
	  strcpy (ptr, " (Type ? for further options)");
	  ptr += strlen (ptr);
	}

      *ptr = 0;
789
      current_kboard->echoptr = ptr;
Jim Blandy's avatar
Jim Blandy committed
790

791
      echo_now ();
Jim Blandy's avatar
Jim Blandy committed
792 793 794 795 796 797
    }
}

/* 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
798
void
Jim Blandy's avatar
Jim Blandy committed
799 800
echo_dash ()
{
801 802
  if (!current_kboard->immediate_echo
      && current_kboard->echoptr == current_kboard->echobuf)
Jim Blandy's avatar
Jim Blandy committed
803
    return;
804
  /* Do nothing if we just printed a prompt.  */
805 806
  if (current_kboard->echo_after_prompt
      == current_kboard->echoptr - current_kboard->echobuf)
807
    return;
808
  /* Do nothing if not echoing at all.  */
809
  if (current_kboard->echoptr == 0)
810
    return;
Jim Blandy's avatar
Jim Blandy committed
811 812 813

  /* Put a dash at the end of the buffer temporarily,
     but make it go away when the next character is added.  */
814 815
  current_kboard->echoptr[0] = '-';
  current_kboard->echoptr[1] = 0;
Jim Blandy's avatar
Jim Blandy committed
816

817
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
818 819 820 821 822
}

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

823
void
824
echo_now ()
Jim Blandy's avatar
Jim Blandy committed
825
{
826
  if (!current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
827 828
    {
      int i;
829
      current_kboard->immediate_echo = 1;
Jim Blandy's avatar
Jim Blandy committed
830 831

      for (i = 0; i < this_command_key_count; i++)
832 833 834 835 836 837 838
	{
	  Lisp_Object c;
	  c = XVECTOR (this_command_keys)->contents[i];
	  if (! (EVENT_HAS_PARAMETERS (c)
		 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
	    echo_char (c);
	}
Jim Blandy's avatar
Jim Blandy committed
839 840 841 842
      echo_dash ();
    }

  echoing = 1;
843
  message2_nolog (current_kboard->echobuf, strlen (current_kboard->echobuf),
844
		  1);
Jim Blandy's avatar
Jim Blandy committed
845 846
  echoing = 0;

847 848 849 850
  /* 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
851 852 853 854 855 856
  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
857
void
Jim Blandy's avatar
Jim Blandy committed
858 859
cancel_echoing ()
{
860 861 862
  current_kboard->immediate_echo = 0;
  current_kboard->echoptr = current_kboard->echobuf;
  current_kboard->echo_after_prompt = -1;
863 864 865
  ok_to_echo_at_next_pause = NULL;
  echo_kboard = NULL;
  echo_message_buffer = Qnil;
Jim Blandy's avatar
Jim Blandy committed
866 867 868 869 870 871 872
}

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

static int
echo_length ()
{
873
  return current_kboard->echoptr - current_kboard->echobuf;
Jim Blandy's avatar
Jim Blandy committed
874 875 876 877
}

/* 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
878
   switches frames while entering a key sequence.  */
Jim Blandy's avatar
Jim Blandy committed
879 880 881 882 883

static void
echo_truncate (len)
     int len;
{
884 885
  current_kboard->echobuf[len] = '\0';
  current_kboard->echoptr = current_kboard->echobuf + len;
886
  truncate_echo_area (len);
Jim Blandy's avatar
Jim Blandy committed
887 888 889 890 891 892 893 894
}


/* Functions for manipulating this_command_keys.  */
static void
add_command_key (key)
     Lisp_Object key;
{
895 896 897 898 899
  /* 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;
900 901
      if (this_command_key_count < this_single_command_key_start)
	this_single_command_key_start = this_command_key_count;
902 903 904 905
      echo_truncate (before_command_echo_length_1);
      before_command_restore_flag = 0;
    }

906 907 908 909
  if (this_command_key_count >= ASIZE (this_command_keys))
    this_command_keys = larger_vector (this_command_keys,
				       2 * ASIZE (this_command_keys),
				       Qnil);
910

911 912
  AREF (this_command_keys, this_command_key_count) = key;
  ++this_command_key_count;
Jim Blandy's avatar
Jim Blandy committed
913
}
914

Jim Blandy's avatar
Jim Blandy committed
915 916 917 918 919 920 921 922 923 924 925 926 927

Lisp_Object
recursive_edit_1 ()
{
  int count = specpdl_ptr - specpdl;
  Lisp_Object val;

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

928
#ifdef HAVE_X_WINDOWS
929
  /* The command loop has started an hourglass timer, so we have to
930
     cancel it here, otherwise it will fire because the recursive edit
931 932
     can take some time.  Do not check for display_hourglass_p here,
     because it could already be nil.  */
933
    cancel_hourglass ();
934 935
#endif

936 937 938 939 940 941 942 943 944 945 946 947
  /* 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
948 949 950
  val = command_loop ();
  if (EQ (val, Qt))
    Fsignal (Qquit, Qnil);
951 952 953 954
  /* 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
955

956
  return unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
957 958 959
}

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

961
void
Jim Blandy's avatar
Jim Blandy committed
962 963
record_auto_save ()
{
964
  last_auto_save = num_nonmacro_input_events;
Jim Blandy's avatar
Jim Blandy committed
965
}
966 967 968

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

Andreas Schwab's avatar
Andreas Schwab committed
969
void
970 971 972
force_auto_save_soon ()
{
  last_auto_save = - auto_save_interval - 1;
973 974

  record_asynch_buffer_change ();
975
}
Jim Blandy's avatar
Jim Blandy committed
976 977

DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
978 979 980 981 982 983
       doc: /* Invoke the editor command loop recursively.
To get out of the recursive edit, a command can do `(throw 'exit nil)';
that tells this function to return.
Alternately, `(throw 'exit t)' makes this function signal an error.
This function is called by the editor initialization to begin editing.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
984 985
{
  int count = specpdl_ptr - specpdl;
986
  Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
987 988 989 990

  command_loop_level++;
  update_mode_lines = 1;

991 992 993 994 995 996 997 998 999 1000
  if (command_loop_level
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
    buffer = Fcurrent_buffer ();
  else
    buffer = Qnil;

  /* If we leave recursive_edit_1 below with a `throw' for instance,
     like it is done in the splash screen display, we have to
     make sure that we restore single_kboard as command_loop_1
     would have done if it were left normally.  */
Jim Blandy's avatar
Jim Blandy committed
1001
  record_unwind_protect (recursive_edit_unwind,
1002 1003
			 Fcons (buffer, single_kboard ? Qt : Qnil));

Jim Blandy's avatar
Jim Blandy committed
1004 1005 1006 1007 1008
  recursive_edit_1 ();
  return unbind_to (count, Qnil);
}

Lisp_Object
1009 1010
recursive_edit_unwind (info)
     Lisp_Object info;
Jim Blandy's avatar
Jim Blandy committed
1011
{
1012 1013 1014 1015 1016 1017 1018 1019
  if (BUFFERP (XCAR (info)))
    Fset_buffer (XCAR (info));
  
  if (NILP (XCDR (info)))
    any_kboard_state ();
  else
    single_kboard_state ();
      
Jim Blandy's avatar
Jim Blandy committed
1020 1021 1022 1023
  command_loop_level--;
  update_mode_lines = 1;
  return Qnil;
}
1024

Jim Blandy's avatar
Jim Blandy committed
1025

Karl Heuer's avatar
Karl Heuer committed
1026
static void
1027
any_kboard_state ()
Karl Heuer's avatar
Karl Heuer committed
1028
{
1029 1030 1031 1032 1033
#ifdef MULTI_KBOARD
#if 0 /* Theory: if there's anything in Vunread_command_events,
	 it will right away be read by read_key_sequence,
	 and then if we do switch KBOARDS, it will go into the side
	 queue then.  So we don't need to do anything special here -- rms.  */
Karl Heuer's avatar
Karl Heuer committed
1034
  if (CONSP (Vunread_command_events))
1035
    {
1036 1037 1038
      current_kboard->kbd_queue
	= nconc2 (Vunread_command_events, current_kboard->kbd_queue);
      current_kboard->kbd_queue_has_data = 1;