keyboard.c 293 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 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

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
8
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
9 10 11 12 13 14 15 16 17
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
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
20

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

44 45 46 47
#ifdef MSDOS
#include "msdos.h"
#include <time.h>
#else /* not MSDOS */
Jim Blandy's avatar
Jim Blandy committed
48 49 50
#ifndef VMS
#include <sys/ioctl.h>
#endif
51
#endif /* not MSDOS */
Jim Blandy's avatar
Jim Blandy committed
52

Jim Blandy's avatar
Jim Blandy committed
53
#include "syssignal.h"
54
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
55

56 57 58 59 60
#include <sys/types.h>
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

61 62 63 64 65
/* This is to get the definitions of the XK_ symbols.  */
#ifdef HAVE_X_WINDOWS
#include "xterm.h"
#endif

66 67 68 69
#ifdef HAVE_NTGUI
#include "w32term.h"
#endif /* HAVE_NTGUI */

70 71 72
/* Include systime.h after xterm.h to avoid double inclusion of time.h. */
#include "systime.h"

Jim Blandy's avatar
Jim Blandy committed
73 74
extern int errno;

75 76 77
/* Variables for blockinput.h: */

/* Non-zero if interrupt input is blocked right now.  */
78
int interrupt_input_blocked;
79 80 81

/* Nonzero means an input interrupt has arrived
   during the current critical section.  */
82
int interrupt_input_pending;
83 84


85 86
/* File descriptor to use for input.  */
extern int input_fd;
Jim Blandy's avatar
Jim Blandy committed
87

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

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

113 114 115 116
#ifdef MULTI_KBOARD
KBOARD *initial_kboard;
KBOARD *current_kboard;
KBOARD *all_kboards;
117
int single_kboard;
118
#else
119
KBOARD the_only_kboard;
120
#endif
121

Jim Blandy's avatar
Jim Blandy committed
122 123
/* Non-nil disable property on a command means
   do not execute it; call disabled-command-hook's value instead.  */
124
Lisp_Object Qdisabled, Qdisabled_command_hook;
Jim Blandy's avatar
Jim Blandy committed
125 126 127 128

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

131 132 133 134 135 136 137
/* 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
138

139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
/* 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							\
if (raw_keybuf_count == XVECTOR (raw_keybuf)->size)			\
  {									\
    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;							\
  }

155 156 157 158
/* Number of elements of this_command_keys
   that precede this key sequence.  */
int this_single_command_key_start;

159 160 161 162 163 164 165 166 167 168 169 170
/* 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
171 172
extern int minbuf_level;

173 174
extern int message_enable_multibyte;

Jim Blandy's avatar
Jim Blandy committed
175 176
extern struct backtrace *backtrace_list;

177 178 179 180 181
/* 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;

Jim Blandy's avatar
Jim Blandy committed
182 183 184 185 186 187 188 189 190 191 192 193 194
/* Nonzero means do menu prompting.  */
static int menu_prompting;

/* Character to see next line of menu prompt.  */
static Lisp_Object menu_prompt_more_char;

/* For longjmp to where kbd input is being done.  */
static jmp_buf getcjmp;

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

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

Jim Blandy's avatar
Jim Blandy committed
196 197
static int echoing;

198 199 200 201 202 203 204 205 206 207 208
/* 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;

/* The kboard currently echoing, or null for none.  Set in echo_now to
   the kboard echoing.  Reset to 0 in cancel_echoing.  If non-null,
   and a current echo area message exists, we know that it comes from
   echoing.  */

static struct kboard *echo_kboard;
209

210 211 212
/* Nonzero means disregard local maps for the menu bar.  */
static int inhibit_local_menu_bar_menus;

213
/* Nonzero means C-g should cause immediate error-signal.  */
Jim Blandy's avatar
Jim Blandy committed
214 215
int immediate_quit;

216 217 218
/* The user's ERASE setting.  */
Lisp_Object Vtty_erase_char;

Jim Blandy's avatar
Jim Blandy committed
219
/* Character to recognize as the help char.  */
220
Lisp_Object Vhelp_char;
Jim Blandy's avatar
Jim Blandy committed
221

Karl Heuer's avatar
Karl Heuer committed
222 223 224
/* List of other event types to recognize as meaning "help".  */
Lisp_Object Vhelp_event_list;

Jim Blandy's avatar
Jim Blandy committed
225 226 227
/* Form to execute when help char is typed.  */
Lisp_Object Vhelp_form;

228 229 230
/* Command to run when the help character follows a prefix key.  */
Lisp_Object Vprefix_help_command;

231 232
/* List of items that should move to the end of the menu bar.  */
Lisp_Object Vmenu_bar_final_items;
233

234 235 236 237 238 239
/* 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;

Jim Blandy's avatar
Jim Blandy committed
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
/* 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;

261 262 263
/* If non-nil, this is a map that overrides all other local maps.  */
Lisp_Object Voverriding_local_map;

264 265 266
/* If non-nil, Voverriding_local_map applies to the menu bar.  */
Lisp_Object Voverriding_local_map_menu_flag;

267 268 269 270
/* 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
271 272 273 274 275 276 277 278 279
/* 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;

280 281 282 283
/* 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
284 285 286
/* Last input character read for any purpose.  */
Lisp_Object last_input_char;

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

290 291 292 293 294 295 296 297
/* 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;

298 299 300
/* If not -1, an event to be read as subsequent command input.  */
int unread_command_char;

301 302
/* 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
303
   next command input, after any unread_command_events.
304 305 306 307 308

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

310 311 312
/* A mask of extra modifier bits to put into every keyboard char.  */
int extra_keyboard_modifiers;

Jim Blandy's avatar
Jim Blandy committed
313 314 315 316 317 318 319 320
/* 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;

321
/* Number of idle seconds before an auto-save and garbage collection.  */
Jim Blandy's avatar
Jim Blandy committed
322 323 324
static Lisp_Object Vauto_save_timeout;

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

327
/* Total number of times read_char has returned, outside of macros.  */
328
int num_nonmacro_input_events;
329

Jim Blandy's avatar
Jim Blandy committed
330 331 332 333 334
/* Auto-save automatically when this many characters have been typed
   since the last time.  */

static int auto_save_interval;

335
/* Value of num_nonmacro_input_events as of last auto save.  */
Jim Blandy's avatar
Jim Blandy committed
336 337 338 339

int last_auto_save;

/* The command being executed by the command loop.
340 341
   Commands may set this, and the value set will be copied into
   current_kboard->Vlast_command instead of the actual command.  */
342 343 344 345
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
346

347 348 349
/* The value of point when the last command was executed.  */
int last_point_position;

350 351 352
/* The buffer that was current when the last command was started.  */
Lisp_Object last_point_position_buffer;

353 354 355 356 357 358 359 360 361 362 363 364
/* 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
365 366
/* 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
367 368 369 370 371
unsigned long last_event_timestamp;

Lisp_Object Qself_insert_command;
Lisp_Object Qforward_char;
Lisp_Object Qbackward_char;
372
Lisp_Object Qundefined;
373
Lisp_Object Qtimer_event_handler;
Jim Blandy's avatar
Jim Blandy committed
374 375 376 377 378 379 380 381 382 383 384 385 386 387

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

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

388 389 390
/* Another keymap that maps key sequences into key sequences.
   This one takes precedence over ordinary definitions.  */
extern Lisp_Object Vkey_translation_map;
391

392 393 394 395
/* If non-nil, this implements the current input method.  */
Lisp_Object Vinput_method_function;
Lisp_Object Qinput_method_function;

396 397 398 399
/* When we call Vinput_method_function,
   this holds the echo area message that was just erased.  */
Lisp_Object Vinput_method_previous_message;

400 401 402
/* Non-nil means deactivate the mark at end of this command.  */
Lisp_Object Vdeactivate_mark;

403 404 405 406 407
/* Menu bar specified in Lucid Emacs fashion.  */

Lisp_Object Vlucid_menu_bar_dirty_flag;
Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

408 409
Lisp_Object Qecho_area_clear_hook;

410
/* Hooks to run before and after each command.  */
411 412
Lisp_Object Qpre_command_hook, Vpre_command_hook;
Lisp_Object Qpost_command_hook, Vpost_command_hook;
413
Lisp_Object Qcommand_hook_internal, Vcommand_hook_internal;
414 415 416 417 418
/* 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;
419

420 421 422 423 424 425
/* 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;
426
Lisp_Object Qdeferred_action_function;
427

428 429 430
Lisp_Object Qinput_method_exit_on_first_char;
Lisp_Object Qinput_method_use_echo_area;

Jim Blandy's avatar
Jim Blandy committed
431 432 433 434 435 436
/* File in which we write all commands we read.  */
FILE *dribble;

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

437 438 439
/* 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
440 441 442 443
int meta_key;

extern char *pending_malloc_warning;

444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
/* Circular buffer for pre-read keyboard input.  */
static struct input_event kbd_buffer[KBD_BUFFER_SIZE];

/* Vector to GCPRO the frames and windows mentioned in kbd_buffer.

   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.

   So, we use this vector to protect the frame_or_window field in the
   event queue.  That way, they'll be dequeued as dead frames or
   windows, but still valid lisp objects.

   If kbd_buffer[i].kind != no_event, then
     (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
      == kbd_buffer[i].frame_or_window.  */
static Lisp_Object kbd_buffer_frame_or_window;

/* Pointer to next available character in kbd_buffer.
   If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
   This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
   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].  */
484
static struct input_event * volatile kbd_store_ptr;
485 486 487 488 489 490 491 492 493 494

/* 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
495
/* If this flag is non-nil, we check mouse_moved to see when the
496 497 498
   mouse moves, and motion events will appear in the input stream.
   Otherwise, mouse motion is ignored.  */
static Lisp_Object do_mouse_tracking;
Jim Blandy's avatar
Jim Blandy committed
499 500 501

/* Symbols to head events.  */
Lisp_Object Qmouse_movement;
502
Lisp_Object Qscroll_bar_movement;
503
Lisp_Object Qswitch_frame;
504
Lisp_Object Qdelete_frame;
505 506
Lisp_Object Qiconify_frame;
Lisp_Object Qmake_frame_visible;
507
Lisp_Object Qhelp_echo;
508

Jim Blandy's avatar
Jim Blandy committed
509 510 511
/* Symbols to denote kinds of events.  */
Lisp_Object Qfunction_key;
Lisp_Object Qmouse_click;
512 513
#ifdef WINDOWSNT
Lisp_Object Qmouse_wheel;
514
Lisp_Object Qlanguage_change;
515
#endif
516
Lisp_Object Qdrag_n_drop;
Jim Blandy's avatar
Jim Blandy committed
517 518 519 520
/* Lisp_Object Qmouse_movement; - also an event header */

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

523 524
/* menu item parts */
Lisp_Object Qmenu_alias;
525
Lisp_Object Qmenu_enable;
526 527
Lisp_Object QCenable, QCvisible, QChelp, QCfilter, QCkeys, QCkey_sequence;
Lisp_Object QCbutton, QCtoggle, QCradio;
528 529
extern Lisp_Object Vdefine_key_rebound_commands;
extern Lisp_Object Qmenu_item;
530

531 532 533 534 535 536 537 538 539 540 541 542 543
/* 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;

544
/* Symbols to use for parts of windows.  */
Jim Blandy's avatar
Jim Blandy committed
545
Lisp_Object Qmode_line;
Jim Blandy's avatar
Jim Blandy committed
546
Lisp_Object Qvertical_line;
547
Lisp_Object Qvertical_scroll_bar;
548 549
Lisp_Object Qmenu_bar;

550 551
Lisp_Object recursive_edit_unwind (), command_loop ();
Lisp_Object Fthis_command_keys ();
552
Lisp_Object Qextended_command_history;
553
EMACS_TIME timer_check ();
Jim Blandy's avatar
Jim Blandy committed
554

555 556
extern Lisp_Object Vhistory_length;

557 558
extern char *x_get_keysym_name ();

559 560
static void record_menu_key ();

561 562
Lisp_Object Qpolling_period;

563
/* List of absolute timers.  Appears in order of next scheduled event.  */
564 565
Lisp_Object Vtimer_list;

566 567 568
/* List of idle time timers.  Appears in order of next scheduled event.  */
Lisp_Object Vtimer_idle_list;

569 570 571
/* Incremented whenever a timer is run.  */
int timers_run;

572 573
extern Lisp_Object Vprint_level, Vprint_length;

Jim Blandy's avatar
Jim Blandy committed
574 575 576
/* 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
577 578 579 580 581 582 583 584

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

585
/* Nonzero means use ^S/^Q for flow control.  */
Jim Blandy's avatar
Jim Blandy committed
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600
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

601
/* If we support a window system, turn on the code to poll periodically
602
   to detect C-g.  It isn't actually used when doing interrupt input.  */
603
#ifdef HAVE_WINDOW_SYSTEM
Jim Blandy's avatar
Jim Blandy committed
604 605 606 607 608 609 610 611 612 613
#define POLL_FOR_INPUT
#endif

/* Global variable declarations.  */

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

static int read_avail_input ();
static void get_input_pending ();
614
static int readable_events ();
615 616
static Lisp_Object read_char_x_menu_prompt ();
static Lisp_Object read_char_minibuf_menu_prompt ();
617
static Lisp_Object make_lispy_event ();
618
#ifdef HAVE_MOUSE
619
static Lisp_Object make_lispy_movement ();
620
#endif
621 622
static Lisp_Object modify_event_symbol ();
static Lisp_Object make_lispy_switch_frame ();
623
static int parse_solitary_modifier ();
Andreas Schwab's avatar
Andreas Schwab committed
624 625
static void save_getcjmp ();
static void restore_getcjmp ();
626
static Lisp_Object apply_modifiers P_ ((int, Lisp_Object));
Jim Blandy's avatar
Jim Blandy committed
627 628 629 630

/* > 0 if we are to echo keystrokes.  */
static int echo_keystrokes;

631 632 633 634
/* 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
635 636 637 638 639 640 641
#define	min(a,b)	((a)<(b)?(a):(b))
#define	max(a,b)	((a)>(b)?(a):(b))

/* 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
642
void
Jim Blandy's avatar
Jim Blandy committed
643 644 645 646
echo_prompt (str)
     char *str;
{
  int len = strlen (str);
647

648 649
  if (len > ECHOBUFSIZE - 4)
    len = ECHOBUFSIZE - 4;
650 651 652
  bcopy (str, current_kboard->echobuf, len);
  current_kboard->echoptr = current_kboard->echobuf + len;
  *current_kboard->echoptr = '\0';
Jim Blandy's avatar
Jim Blandy committed
653

654
  current_kboard->echo_after_prompt = len;
655

656
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
657 658
}

659
/* Add C to the echo string, if echoing is going on.
Jim Blandy's avatar
Jim Blandy committed
660 661 662
   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
663
void
Jim Blandy's avatar
Jim Blandy committed
664 665 666 667 668
echo_char (c)
     Lisp_Object c;
{
  extern char *push_key_description ();

669
  if (current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
670
    {
671
      char *ptr = current_kboard->echoptr;
672

673
      if (ptr != current_kboard->echobuf)
Jim Blandy's avatar
Jim Blandy committed
674 675 676
	*ptr++ = ' ';

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

679
      if (INTEGERP (c))
Jim Blandy's avatar
Jim Blandy committed
680
	{
681
	  if (ptr - current_kboard->echobuf > ECHOBUFSIZE - 6)
Jim Blandy's avatar
Jim Blandy committed
682 683
	    return;

684
	  ptr = push_key_description (XINT (c), ptr);
Jim Blandy's avatar
Jim Blandy committed
685
	}
686
      else if (SYMBOLP (c))
Jim Blandy's avatar
Jim Blandy committed
687 688
	{
	  struct Lisp_String *name = XSYMBOL (c)->name;
689
	  if ((ptr - current_kboard->echobuf) + STRING_BYTES (name) + 4
690
	      > ECHOBUFSIZE)
Jim Blandy's avatar
Jim Blandy committed
691
	    return;
692 693
	  bcopy (name->data, ptr, STRING_BYTES (name));
	  ptr += STRING_BYTES (name);
Jim Blandy's avatar
Jim Blandy committed
694 695
	}

696
      if (current_kboard->echoptr == current_kboard->echobuf
Karl Heuer's avatar
Karl Heuer committed
697
	  && help_char_p (c))
Jim Blandy's avatar
Jim Blandy committed
698 699 700 701 702 703
	{
	  strcpy (ptr, " (Type ? for further options)");
	  ptr += strlen (ptr);
	}

      *ptr = 0;
704
      current_kboard->echoptr = ptr;
Jim Blandy's avatar
Jim Blandy committed
705

706
      echo_now ();
Jim Blandy's avatar
Jim Blandy committed
707 708 709 710 711 712
    }
}

/* 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
713
void
Jim Blandy's avatar
Jim Blandy committed
714 715
echo_dash ()
{
716 717
  if (!current_kboard->immediate_echo
      && current_kboard->echoptr == current_kboard->echobuf)
Jim Blandy's avatar
Jim Blandy committed
718
    return;
719
  /* Do nothing if we just printed a prompt.  */
720 721
  if (current_kboard->echo_after_prompt
      == current_kboard->echoptr - current_kboard->echobuf)
722
    return;
723
  /* Do nothing if not echoing at all.  */
724
  if (current_kboard->echoptr == 0)
725
    return;
Jim Blandy's avatar
Jim Blandy committed
726 727 728

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

732
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
733 734 735 736 737
}

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

738
void
739
echo_now ()
Jim Blandy's avatar
Jim Blandy committed
740
{
741
  if (!current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
742 743
    {
      int i;
744
      current_kboard->immediate_echo = 1;
Jim Blandy's avatar
Jim Blandy committed
745 746

      for (i = 0; i < this_command_key_count; i++)
747 748 749 750 751 752 753
	{
	  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
754 755 756 757
      echo_dash ();
    }

  echoing = 1;
758
  echo_kboard = current_kboard;
759 760
  message2_nolog (current_kboard->echobuf, strlen (current_kboard->echobuf),
		  ! NILP (current_buffer->enable_multibyte_characters));
Jim Blandy's avatar
Jim Blandy committed
761 762 763 764 765 766 767 768
  echoing = 0;

  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
769
void
Jim Blandy's avatar
Jim Blandy committed
770 771
cancel_echoing ()
{
772 773 774
  current_kboard->immediate_echo = 0;
  current_kboard->echoptr = current_kboard->echobuf;
  current_kboard->echo_after_prompt = -1;
775
  ok_to_echo_at_next_pause = 0;
776
  echo_kboard = 0;
Jim Blandy's avatar
Jim Blandy committed
777 778 779 780 781 782 783
}

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

static int
echo_length ()
{
784
  return current_kboard->echoptr - current_kboard->echobuf;
Jim Blandy's avatar
Jim Blandy committed
785 786 787 788
}

/* 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
789
   switches frames while entering a key sequence.  */
Jim Blandy's avatar
Jim Blandy committed
790 791 792 793 794

static void
echo_truncate (len)
     int len;
{
795 796
  current_kboard->echobuf[len] = '\0';
  current_kboard->echoptr = current_kboard->echobuf + len;
797
  truncate_echo_area (len);
Jim Blandy's avatar
Jim Blandy committed
798 799 800 801 802 803 804 805
}


/* Functions for manipulating this_command_keys.  */
static void
add_command_key (key)
     Lisp_Object key;
{
806 807
  int size = XVECTOR (this_command_keys)->size;

808 809 810 811 812
  /* 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;
813 814
      if (this_command_key_count < this_single_command_key_start)
	this_single_command_key_start = this_command_key_count;
815 816 817 818
      echo_truncate (before_command_echo_length_1);
      before_command_restore_flag = 0;
    }

819
  if (this_command_key_count >= size)
Jim Blandy's avatar
Jim Blandy committed
820
    {
821
      Lisp_Object new_keys;
822

823
      new_keys = Fmake_vector (make_number (size * 2), Qnil);
824 825
      bcopy (XVECTOR (this_command_keys)->contents,
	     XVECTOR (new_keys)->contents,
826
	     size * sizeof (Lisp_Object));
827 828

      this_command_keys = new_keys;
Jim Blandy's avatar
Jim Blandy committed
829
    }
830 831

  XVECTOR (this_command_keys)->contents[this_command_key_count++] = key;
Jim Blandy's avatar
Jim Blandy committed
832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848
}

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);
    }

  val = command_loop ();
  if (EQ (val, Qt))
    Fsignal (Qquit, Qnil);
849 850 851 852
  /* 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
853

854
  return unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
855 856 857
}

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

859
void
Jim Blandy's avatar
Jim Blandy committed
860 861
record_auto_save ()
{
862
  last_auto_save = num_nonmacro_input_events;
Jim Blandy's avatar
Jim Blandy committed
863
}
864 865 866

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

Andreas Schwab's avatar
Andreas Schwab committed
867
void
868 869 870
force_auto_save_soon ()
{
  last_auto_save = - auto_save_interval - 1;
871 872

  record_asynch_buffer_change ();
873
}
Jim Blandy's avatar
Jim Blandy committed
874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908

DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
  "Invoke the editor command loop recursively.\n\
To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
that tells this function to return.\n\
Alternately, `(throw 'exit t)' makes this function signal an error.\n\
This function is called by the editor initialization to begin editing.")
  ()
{
  int count = specpdl_ptr - specpdl;

  command_loop_level++;
  update_mode_lines = 1;

  record_unwind_protect (recursive_edit_unwind,
			 (command_loop_level
			  && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
			 ? Fcurrent_buffer ()
			 : Qnil);
  recursive_edit_1 ();
  return unbind_to (count, Qnil);
}

Lisp_Object
recursive_edit_unwind (buffer)
     Lisp_Object buffer;
{
  if (!NILP (buffer))
    Fset_buffer (buffer);

  command_loop_level--;
  update_mode_lines = 1;
  return Qnil;
}

Karl Heuer's avatar
Karl Heuer committed
909
static void
910
any_kboard_state ()
Karl Heuer's avatar
Karl Heuer committed
911
{
912 913 914 915 916
#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
917
  if (CONSP (Vunread_command_events))
918
    {
919 920 921
      current_kboard->kbd_queue
	= nconc2 (Vunread_command_events, current_kboard->kbd_queue);
      current_kboard->kbd_queue_has_data = 1;
922
    }
Karl Heuer's avatar
Karl Heuer committed
923
  Vunread_command_events = Qnil;
924 925 926
#endif
  single_kboard = 0;
#endif
Karl Heuer's avatar
Karl Heuer committed
927
}
928 929 930 931 932 933 934 935 936

/* Switch to the single-kboard state, making current_kboard
   the only KBOARD from which further input is accepted.  */

void
single_kboard_state ()
{
#ifdef MULTI_KBOARD
  single_kboard = 1;
Karl Heuer's avatar
Karl Heuer committed
937
#endif
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955
}

/* Maintain a stack of kboards, so other parts of Emacs
   can switch temporarily to the kboard of a given frame
   and then revert to the previous status.  */

struct kboard_stack
{
  KBOARD *kboard;
  struct kboard_stack *next;
};

static struct kboard_stack *kboard_stack;

void
push_frame_kboard (f)
     FRAME_PTR f;
{
956
#ifdef MULTI_KBOARD
957 958 959 960 961 962 963 964
  struct kboard_stack *p
    = (struct kboard_stack *) xmalloc (sizeof (struct kboard_stack));

  p->next = kboard_stack;
  p->kboard = current_kboard;
  kboard_stack = p;

  current_kboard = FRAME_KBOARD (f);
965
#endif
966 967 968 969 970
}

void
pop_frame_kboard ()
{
971
#ifdef MULTI_KBOARD
972 973 974 975
  struct kboard_stack *p = kboard_stack;
  current_kboard = p->kboard;
  kboard_stack = p->next;
  xfree (p);
976
#endif
977 978 979 980
}

/* Handle errors that are not handled at inner levels
   by printing an error message and returning to the editor command loop.  */
Karl Heuer's avatar
Karl Heuer committed
981

Jim Blandy's avatar
Jim Blandy committed
982 983 984
Lisp_Object
cmd_error (data)
     Lisp_Object data;
985
{
986
  Lisp_Object old_level, old_length;
987 988 989 990 991 992 993 994 995 996 997 998
  char macroerror[50];

  if (!NILP (executing_macro))
    {
      if (executing_macro_iterations == 1)
	sprintf (macroerror, "After 1 kbd macro iteration: ");
      else
	sprintf (macroerror, "After %d kbd macro iterations: ",
		 executing_macro_iterations);
    }
  else
    *macroerror = 0;
999

1000 1001 1002
  Vstandard_output = Qt;
  Vstandard_input = Qt;
  Vexecuting_macro = Qnil;
1003
  executing_macro = Qnil;
1004
  current_kboard->Vprefix_arg = Qnil;
1005
  current_kboard->Vlast_prefix_arg = Qnil;
1006
  cancel_echoing ();
1007 1008 1009 1010

  /* Avoid unquittable loop if data contains a circular list.  */
  old_level = Vprint_level;
  old_length = Vprint_length;
1011 1012
  XSETFASTINT (Vprint_level, 10);
  XSETFASTINT (Vprint_length, 10);
1013
  cmd_error_internal (data, macroerror);
1014 1015
  Vprint_level = old_level;
  Vprint_length = old_length;
1016 1017 1018 1019

  Vquit_flag = Qnil;

  Vinhibit_quit = Qnil;
1020
#ifdef MULTI_KBOARD
1021
  any_kboard_state ();
1022
#endif
1023 1024 1025 1026

  return make_number (0);
}

1027 1028 1029 1030 1031 1032 1033 1034
/* Take actions on handling an error.  DATA is the data that describes
   the error.

   CONTEXT is a C-string containing ASCII characters only which
   describes the context in which the error happened.  If we need to
   generalize CONTEXT to allow multibyte characters, make it a Lisp
   string.  */

1035
void
1036 1037 1038
cmd_error_internal (data, context)
     Lisp_Object data;
     char *context;
Jim Blandy's avatar
Jim Blandy committed
1039 1040
{
  Lisp_Object stream;
1041
  int kill_emacs_p = 0;
1042
  struct frame *sf = SELECTED_FRAME ();
Jim Blandy's avatar
Jim Blandy committed
1043 1044 1045

  Vquit_flag = Qnil;
  Vinhibit_quit = Qt;
1046
  clear_message (1, 0);
Jim Blandy's avatar
Jim Blandy committed
1047

Jim Blandy's avatar
Jim Blandy committed
1048
  /* If the window system or terminal frame hasn't been initialized
Jim Blandy's avatar
Jim Blandy committed
1049 1050
     yet, or we're not interactive, it's best to dump this message out
     to stderr and exit.  */
1051
  if (!sf->glyphs_initialized_p
1052 1053 1054 1055
      /* This is the case of the frame dumped with Emacs, when we're
	 running under a window system.  */
      || (!NILP (Vwindow_system)
	  && !inhibit_window_system
1056
	  && FRAME_TERMCAP_P (sf))
Jim Blandy's avatar
Jim Blandy committed
1057
      || noninteractive)
1058 1059 1060 1061
    {
      stream = Qexternal_debugging_output;
      kill_emacs_p = 1;
    }
Jim Blandy's avatar
Jim Blandy committed
1062 1063 1064 1065 1066 1067 1068
  else
    {
      Fdiscard_input ();
      bitch_at_user ();
      stream = Qt;
    }

1069 1070 1071
  if (context != 0)
    write_string_1 (context, -1, stream);

1072
  print_error_message (data, stream);
Jim Blandy's avatar
Jim Blandy committed
1073

Jim Blandy's avatar
Jim Blandy committed
1074
  /* If the window system or terminal frame hasn't been initialized
Jim Blandy's avatar
Jim Blandy committed
1075
     yet, or we're in -batch mode, this error should cause Emacs to exit.  */
1076
  if (kill_emacs_p)
Jim Blandy's avatar
Jim Blandy committed
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
    {
      Fterpri (stream);
      Fkill_emacs (make_number (-1));
    }
}

Lisp_Object command_loop_1 ();
Lisp_Object command_loop_2 ();
Lisp_Object top_level_1 ();

/* Entry to editor-command-loop.
   This level has the catches for exiting/returning to editor command loop.
   It returns nil to exit recursive edit, t to abort it.  */

Lisp_Object
command_loop ()
{
  if (command_loop_level > 0 || minibuf_level > 0)
    {
1096 1097
      Lisp_Object val;
      val = internal_catch (Qexit, command_loop_2, Qnil);
1098 1099
      executing_macro = Qnil;
      return val;
Jim Blandy's avatar
Jim Blandy committed
1100 1101 1102 1103 1104 1105
    }
  else
    while (1)
      {
	internal_catch (Qtop_level, top_level_1, Qnil);
	internal_catch (Qtop_level, command_loop_2, Qnil);
1106
	executing_macro = Qnil;
1107

Jim Blandy's avatar
Jim Blandy committed
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162