keyboard.c 225 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 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 22 23

/* Allow config.h to undefine symbols found here.  */
#include <signal.h>

24
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
25 26 27 28 29 30
#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
31
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
32 33 34 35
#include "window.h"
#include "commands.h"
#include "buffer.h"
#include "disptab.h"
36
#include "dispextern.h"
Jim Blandy's avatar
Jim Blandy committed
37
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
38
#include "intervals.h"
39
#include "blockinput.h"
Jim Blandy's avatar
Jim Blandy committed
40 41 42
#include <setjmp.h>
#include <errno.h>

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

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

55 56 57 58 59
/* This is to get the definitions of the XK_ symbols.  */
#ifdef HAVE_X_WINDOWS
#include "xterm.h"
#endif

60 61 62 63
#ifdef HAVE_NTGUI
#include "w32term.h"
#endif /* HAVE_NTGUI */

64 65 66
/* Include systime.h after xterm.h to avoid double inclusion of time.h. */
#include "systime.h"

Jim Blandy's avatar
Jim Blandy committed
67 68
extern int errno;

69 70 71
/* Variables for blockinput.h: */

/* Non-zero if interrupt input is blocked right now.  */
72
int interrupt_input_blocked;
73 74 75

/* Nonzero means an input interrupt has arrived
   during the current critical section.  */
76
int interrupt_input_pending;
77 78


79 80
/* File descriptor to use for input.  */
extern int input_fd;
Jim Blandy's avatar
Jim Blandy committed
81

82
#ifdef HAVE_WINDOW_SYSTEM
Jim Blandy's avatar
Jim Blandy committed
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
/* Make all keyboard buffers much bigger when using X windows.  */
#define KBD_BUFFER_SIZE 4096
#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;
  };

102 103 104 105
#ifdef MULTI_KBOARD
KBOARD *initial_kboard;
KBOARD *current_kboard;
KBOARD *all_kboards;
106
int single_kboard;
107
#else
108
KBOARD the_only_kboard;
109
#endif
110

Jim Blandy's avatar
Jim Blandy committed
111 112
/* Non-nil disable property on a command means
   do not execute it; call disabled-command-hook's value instead.  */
113
Lisp_Object Qdisabled, Qdisabled_command_hook;
Jim Blandy's avatar
Jim Blandy committed
114 115 116 117

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

120 121 122 123 124 125 126
/* 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
127

128 129 130 131 132 133 134 135 136 137 138 139
/* 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
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
extern int minbuf_level;

extern struct backtrace *backtrace_list;

/* 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.  */
static int echoing;

159 160
/* True means we can start echoing at the next input pause
   even though there is something in the echo area.  */
161
static char *ok_to_echo_at_next_pause;
162

163 164 165
/* Nonzero means disregard local maps for the menu bar.  */
static int inhibit_local_menu_bar_menus;

166
/* Nonzero means C-g should cause immediate error-signal.  */
Jim Blandy's avatar
Jim Blandy committed
167 168 169
int immediate_quit;

/* Character to recognize as the help char.  */
170
Lisp_Object Vhelp_char;
Jim Blandy's avatar
Jim Blandy committed
171

Karl Heuer's avatar
Karl Heuer committed
172 173 174
/* List of other event types to recognize as meaning "help".  */
Lisp_Object Vhelp_event_list;

Jim Blandy's avatar
Jim Blandy committed
175 176 177
/* Form to execute when help char is typed.  */
Lisp_Object Vhelp_form;

178 179 180
/* Command to run when the help character follows a prefix key.  */
Lisp_Object Vprefix_help_command;

181 182
/* List of items that should move to the end of the menu bar.  */
Lisp_Object Vmenu_bar_final_items;
183

184 185 186 187 188 189
/* 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
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
/* 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;

211 212 213
/* If non-nil, this is a map that overrides all other local maps.  */
Lisp_Object Voverriding_local_map;

214 215 216
/* If non-nil, Voverriding_local_map applies to the menu bar.  */
Lisp_Object Voverriding_local_map_menu_flag;

217 218 219 220
/* 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
221 222 223 224 225 226 227 228 229
/* 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;

230 231 232 233
/* 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
234 235 236
/* Last input character read for any purpose.  */
Lisp_Object last_input_char;

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

240 241 242
/* If not -1, an event to be read as subsequent command input.  */
int unread_command_char;

243 244
/* 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
245
   next command input, after any unread_command_events.
246 247 248 249 250

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

252 253 254
/* A mask of extra modifier bits to put into every keyboard char.  */
int extra_keyboard_modifiers;

Jim Blandy's avatar
Jim Blandy committed
255 256 257 258 259 260 261 262
/* 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;

263
/* Number of idle seconds before an auto-save and garbage collection.  */
Jim Blandy's avatar
Jim Blandy committed
264 265 266 267 268
static Lisp_Object Vauto_save_timeout;

/* Total number of times read_char has returned.  */
int num_input_chars;

269 270 271
/* Total number of times read_char has returned, outside of macros.  */
int num_nonmacro_input_chars;

Jim Blandy's avatar
Jim Blandy committed
272 273 274 275 276
/* Auto-save automatically when this many characters have been typed
   since the last time.  */

static int auto_save_interval;

277
/* Value of num_nonmacro_input_chars as of last auto save.  */
Jim Blandy's avatar
Jim Blandy committed
278 279 280 281

int last_auto_save;

/* The command being executed by the command loop.
282 283
   Commands may set this, and the value set will be copied into
   current_kboard->Vlast_command instead of the actual command.  */
Jim Blandy's avatar
Jim Blandy committed
284 285
Lisp_Object this_command;

286 287 288
/* The value of point when the last command was executed.  */
int last_point_position;

289 290 291
/* The buffer that was current when the last command was started.  */
Lisp_Object last_point_position_buffer;

292 293 294 295 296 297 298 299 300 301 302 303 304 305
#ifdef MULTI_FRAME
/* 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;
#endif

/* 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
306 307
/* 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
308 309 310 311 312
unsigned long last_event_timestamp;

Lisp_Object Qself_insert_command;
Lisp_Object Qforward_char;
Lisp_Object Qbackward_char;
313
Lisp_Object Qundefined;
Jim Blandy's avatar
Jim Blandy committed
314 315 316 317 318 319 320 321 322 323 324 325 326 327

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

328 329 330
/* Another keymap that maps key sequences into key sequences.
   This one takes precedence over ordinary definitions.  */
extern Lisp_Object Vkey_translation_map;
331

332 333 334
/* Non-nil means deactivate the mark at end of this command.  */
Lisp_Object Vdeactivate_mark;

335 336 337 338 339
/* Menu bar specified in Lucid Emacs fashion.  */

Lisp_Object Vlucid_menu_bar_dirty_flag;
Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

340
/* Hooks to run before and after each command.  */
341 342
Lisp_Object Qpre_command_hook, Vpre_command_hook;
Lisp_Object Qpost_command_hook, Vpost_command_hook;
343
Lisp_Object Qcommand_hook_internal, Vcommand_hook_internal;
344 345 346 347 348
/* 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;
349

350 351 352 353 354 355
/* 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;
356
Lisp_Object Qdeferred_action_function;
357

Jim Blandy's avatar
Jim Blandy committed
358 359 360 361 362 363
/* File in which we write all commands we read.  */
FILE *dribble;

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

364 365 366
/* 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
367 368 369 370
int meta_key;

extern char *pending_malloc_warning;

371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
/* 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].  */
static volatile struct input_event *kbd_store_ptr;

/* 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
422
/* If this flag is non-nil, we check mouse_moved to see when the
423 424 425
   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
426 427 428

/* Symbols to head events.  */
Lisp_Object Qmouse_movement;
429
Lisp_Object Qscroll_bar_movement;
430
Lisp_Object Qswitch_frame;
431
Lisp_Object Qdelete_frame;
432 433
Lisp_Object Qiconify_frame;
Lisp_Object Qmake_frame_visible;
434

Jim Blandy's avatar
Jim Blandy committed
435 436 437
/* Symbols to denote kinds of events.  */
Lisp_Object Qfunction_key;
Lisp_Object Qmouse_click;
438
Lisp_Object Qtimer_event;
Jim Blandy's avatar
Jim Blandy committed
439 440 441 442
/* Lisp_Object Qmouse_movement; - also an event header */

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

445 446
Lisp_Object Qmenu_enable;

447 448 449 450 451 452 453 454 455 456 457 458 459
/* 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;

460
/* Symbols to use for parts of windows.  */
Jim Blandy's avatar
Jim Blandy committed
461
Lisp_Object Qmode_line;
Jim Blandy's avatar
Jim Blandy committed
462
Lisp_Object Qvertical_line;
463
Lisp_Object Qvertical_scroll_bar;
464 465 466
Lisp_Object Qmenu_bar;

extern Lisp_Object Qmenu_enable;
Jim Blandy's avatar
Jim Blandy committed
467

468 469
Lisp_Object recursive_edit_unwind (), command_loop ();
Lisp_Object Fthis_command_keys ();
470
Lisp_Object Qextended_command_history;
471
EMACS_TIME timer_check ();
Jim Blandy's avatar
Jim Blandy committed
472

473 474
extern char *x_get_keysym_name ();

475 476
Lisp_Object Qpolling_period;

477 478 479
/* List of active timers.  Appears in order of next scheduled event.  */
Lisp_Object Vtimer_list;

480 481
extern Lisp_Object Vprint_level, Vprint_length;

Jim Blandy's avatar
Jim Blandy committed
482 483 484
/* 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
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508

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

/* nonzero means use ^S/^Q for flow control.  */
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

509
/* If we support a window system, turn on the code to poll periodically
510
   to detect C-g.  It isn't actually used when doing interrupt input.  */
511
#ifdef HAVE_WINDOW_SYSTEM
Jim Blandy's avatar
Jim Blandy committed
512 513
#define POLL_FOR_INPUT
#endif
514 515 516

/* Non-nil enables Column Number mode.  */
Lisp_Object Vcolumn_number_mode;
Jim Blandy's avatar
Jim Blandy committed
517 518 519 520 521 522 523 524

/* 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 ();
525
static int readable_events ();
526 527
static Lisp_Object read_char_x_menu_prompt ();
static Lisp_Object read_char_minibuf_menu_prompt ();
528
static Lisp_Object make_lispy_event ();
529
#ifdef HAVE_MOUSE
530
static Lisp_Object make_lispy_movement ();
531
#endif
532 533
static Lisp_Object modify_event_symbol ();
static Lisp_Object make_lispy_switch_frame ();
534
static int parse_solitary_modifier ();
Jim Blandy's avatar
Jim Blandy committed
535 536 537 538

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

539 540 541 542
/* 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
543 544 545 546 547 548 549 550 551 552 553
#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.  */

echo_prompt (str)
     char *str;
{
  int len = strlen (str);
554

555 556
  if (len > ECHOBUFSIZE - 4)
    len = ECHOBUFSIZE - 4;
557 558 559
  bcopy (str, current_kboard->echobuf, len);
  current_kboard->echoptr = current_kboard->echobuf + len;
  *current_kboard->echoptr = '\0';
Jim Blandy's avatar
Jim Blandy committed
560

561
  current_kboard->echo_after_prompt = len;
562

563
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
564 565
}

566
/* Add C to the echo string, if echoing is going on.
Jim Blandy's avatar
Jim Blandy committed
567 568 569 570 571 572 573 574
   C can be a character, which is printed prettily ("M-C-x" and all that
   jazz), or a symbol, whose name is printed.  */

echo_char (c)
     Lisp_Object c;
{
  extern char *push_key_description ();

575
  if (current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
576
    {
577
      char *ptr = current_kboard->echoptr;
578

579
      if (ptr != current_kboard->echobuf)
Jim Blandy's avatar
Jim Blandy committed
580 581 582
	*ptr++ = ' ';

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

585
      if (INTEGERP (c))
Jim Blandy's avatar
Jim Blandy committed
586
	{
587
	  if (ptr - current_kboard->echobuf > ECHOBUFSIZE - 6)
Jim Blandy's avatar
Jim Blandy committed
588 589
	    return;

590
	  ptr = push_key_description (XINT (c), ptr);
Jim Blandy's avatar
Jim Blandy committed
591
	}
592
      else if (SYMBOLP (c))
Jim Blandy's avatar
Jim Blandy committed
593 594
	{
	  struct Lisp_String *name = XSYMBOL (c)->name;
595
	  if ((ptr - current_kboard->echobuf) + name->size + 4 > ECHOBUFSIZE)
Jim Blandy's avatar
Jim Blandy committed
596 597 598 599 600
	    return;
	  bcopy (name->data, ptr, name->size);
	  ptr += name->size;
	}

601
      if (current_kboard->echoptr == current_kboard->echobuf
Karl Heuer's avatar
Karl Heuer committed
602
	  && help_char_p (c))
Jim Blandy's avatar
Jim Blandy committed
603 604 605 606 607 608
	{
	  strcpy (ptr, " (Type ? for further options)");
	  ptr += strlen (ptr);
	}

      *ptr = 0;
609
      current_kboard->echoptr = ptr;
Jim Blandy's avatar
Jim Blandy committed
610

611
      echo_now ();
Jim Blandy's avatar
Jim Blandy committed
612 613 614 615 616 617 618 619
    }
}

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

echo_dash ()
{
620 621
  if (!current_kboard->immediate_echo
      && current_kboard->echoptr == current_kboard->echobuf)
Jim Blandy's avatar
Jim Blandy committed
622
    return;
623
  /* Do nothing if we just printed a prompt.  */
624 625
  if (current_kboard->echo_after_prompt
      == current_kboard->echoptr - current_kboard->echobuf)
626
    return;
627
  /* Do nothing if not echoing at all.  */
628
  if (current_kboard->echoptr == 0)
629
    return;
Jim Blandy's avatar
Jim Blandy committed
630 631 632

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

636
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
637 638 639 640 641
}

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

642
echo_now ()
Jim Blandy's avatar
Jim Blandy committed
643
{
644
  if (!current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
645 646
    {
      int i;
647
      current_kboard->immediate_echo = 1;
Jim Blandy's avatar
Jim Blandy committed
648 649

      for (i = 0; i < this_command_key_count; i++)
650 651 652 653 654 655 656
	{
	  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
657 658 659 660
      echo_dash ();
    }

  echoing = 1;
661
  message1_nolog (current_kboard->echobuf);
Jim Blandy's avatar
Jim Blandy committed
662 663 664 665 666 667 668 669 670 671
  echoing = 0;

  if (waiting_for_input && !NILP (Vquit_flag))
    quit_throw_to_read_char ();
}

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

cancel_echoing ()
{
672 673 674
  current_kboard->immediate_echo = 0;
  current_kboard->echoptr = current_kboard->echobuf;
  current_kboard->echo_after_prompt = -1;
675
  ok_to_echo_at_next_pause = 0;
Jim Blandy's avatar
Jim Blandy committed
676 677 678 679 680 681 682
}

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

static int
echo_length ()
{
683
  return current_kboard->echoptr - current_kboard->echobuf;
Jim Blandy's avatar
Jim Blandy committed
684 685 686 687
}

/* 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
688
   switches frames while entering a key sequence.  */
Jim Blandy's avatar
Jim Blandy committed
689 690 691 692 693

static void
echo_truncate (len)
     int len;
{
694 695
  current_kboard->echobuf[len] = '\0';
  current_kboard->echoptr = current_kboard->echobuf + len;
696
  truncate_echo_area (len);
Jim Blandy's avatar
Jim Blandy committed
697 698 699 700 701 702 703 704
}

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

707 708 709 710 711 712 713 714 715
  /* 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;
      echo_truncate (before_command_echo_length_1);
      before_command_restore_flag = 0;
    }

716
  if (this_command_key_count >= size)
Jim Blandy's avatar
Jim Blandy committed
717
    {
718
      Lisp_Object new_keys;
719

720
      new_keys = Fmake_vector (make_number (size * 2), Qnil);
721 722
      bcopy (XVECTOR (this_command_keys)->contents,
	     XVECTOR (new_keys)->contents,
723
	     size * sizeof (Lisp_Object));
724 725

      this_command_keys = new_keys;
Jim Blandy's avatar
Jim Blandy committed
726
    }
727 728

  XVECTOR (this_command_keys)->contents[this_command_key_count++] = key;
Jim Blandy's avatar
Jim Blandy committed
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746
}

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);

747
  return unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
748 749 750
}

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

Jim Blandy's avatar
Jim Blandy committed
752 753
record_auto_save ()
{
754
  last_auto_save = num_nonmacro_input_chars;
Jim Blandy's avatar
Jim Blandy committed
755
}
756 757 758 759 760 761

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

force_auto_save_soon ()
{
  last_auto_save = - auto_save_interval - 1;
762 763

  record_asynch_buffer_change ();
764
}
Jim Blandy's avatar
Jim Blandy committed
765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800

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;
  Lisp_Object val;

  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
801
static void
802
any_kboard_state ()
Karl Heuer's avatar
Karl Heuer committed
803
{
804 805 806 807 808
#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
809
  if (CONSP (Vunread_command_events))
810
    {
811 812 813
      current_kboard->kbd_queue
	= nconc2 (Vunread_command_events, current_kboard->kbd_queue);
      current_kboard->kbd_queue_has_data = 1;
814
    }
Karl Heuer's avatar
Karl Heuer committed
815
  Vunread_command_events = Qnil;
816 817 818
#endif
  single_kboard = 0;
#endif
Karl Heuer's avatar
Karl Heuer committed
819
}
820 821 822 823 824 825 826 827 828

/* 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
829
#endif
830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
}

/* 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;
{
848
#ifdef MULTI_KBOARD
849 850 851 852 853 854 855 856
  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);
857
#endif
858 859 860 861 862
}

void
pop_frame_kboard ()
{
863
#ifdef MULTI_KBOARD
864 865 866 867
  struct kboard_stack *p = kboard_stack;
  current_kboard = p->kboard;
  kboard_stack = p->next;
  xfree (p);
868
#endif
869 870 871 872
}

/* 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
873

Jim Blandy's avatar
Jim Blandy committed
874 875 876
Lisp_Object
cmd_error (data)
     Lisp_Object data;
877
{
878 879
  Lisp_Object old_level, old_length;

880 881 882
  Vstandard_output = Qt;
  Vstandard_input = Qt;
  Vexecuting_macro = Qnil;
883
  current_kboard->Vprefix_arg = Qnil;
884
  cancel_echoing ();
885 886 887 888

  /* Avoid unquittable loop if data contains a circular list.  */
  old_level = Vprint_level;
  old_length = Vprint_length;
889 890
  XSETFASTINT (Vprint_level, 10);
  XSETFASTINT (Vprint_length, 10);
891
  cmd_error_internal (data, NULL);
892 893
  Vprint_level = old_level;
  Vprint_length = old_length;
894 895 896 897

  Vquit_flag = Qnil;

  Vinhibit_quit = Qnil;
898
#ifdef MULTI_KBOARD
899
  any_kboard_state ();
900
#endif
901 902 903 904 905 906 907

  return make_number (0);
}

cmd_error_internal (data, context)
     Lisp_Object data;
     char *context;
Jim Blandy's avatar
Jim Blandy committed
908 909 910 911 912 913 914
{
  Lisp_Object stream;

  Vquit_flag = Qnil;
  Vinhibit_quit = Qt;
  echo_area_glyphs = 0;

Jim Blandy's avatar
Jim Blandy committed
915
  /* If the window system or terminal frame hasn't been initialized
Jim Blandy's avatar
Jim Blandy committed
916 917
     yet, or we're not interactive, it's best to dump this message out
     to stderr and exit.  */
Jim Blandy's avatar
Jim Blandy committed
918
  if (! FRAME_MESSAGE_BUF (selected_frame)
Jim Blandy's avatar
Jim Blandy committed
919 920 921 922 923 924 925 926 927
      || noninteractive)
    stream = Qexternal_debugging_output;
  else
    {
      Fdiscard_input ();
      bitch_at_user ();
      stream = Qt;
    }

928 929 930
  if (context != 0)
    write_string_1 (context, -1, stream);

931
  print_error_message (data, stream);
Jim Blandy's avatar
Jim Blandy committed
932

Jim Blandy's avatar
Jim Blandy committed
933
  /* If the window system or terminal frame hasn't been initialized
Jim Blandy's avatar
Jim Blandy committed
934
     yet, or we're in -batch mode, this error should cause Emacs to exit.  */
Jim Blandy's avatar
Jim Blandy committed
935
  if (! FRAME_MESSAGE_BUF (selected_frame)
Jim Blandy's avatar
Jim Blandy committed
936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962
      || noninteractive)
    {
      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)
    {
      return internal_catch (Qexit, command_loop_2, Qnil);
    }
  else
    while (1)
      {
	internal_catch (Qtop_level, top_level_1, Qnil);
	internal_catch (Qtop_level, command_loop_2, Qnil);
963

Jim Blandy's avatar
Jim Blandy committed
964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
	/* End of file in -batch run causes exit here.  */
	if (noninteractive)
	  Fkill_emacs (Qt);
      }
}

/* Here we catch errors in execution of commands within the
   editing loop, and reenter the editing loop.
   When there is an error, cmd_error runs and returns a non-nil
   value to us.  A value of nil means that cmd_loop_1 itself
   returned due to end of file (or end of kbd macro).  */

Lisp_Object
command_loop_2 ()
{
  register Lisp_Object val;

  do
    val = internal_condition_case (command_loop_1, Qerror, cmd_error);
  while (!NILP (val));

  return Qnil;
}

Lisp_Object
top_level_2 ()
{
  return Feval (Vtop_level);
}

Lisp_Object
top_level_1 ()
{
  /* On entry to the outer level, run the startup file */
  if (!NILP (Vtop_level))
    internal_condition_case (top_level_2, Qerror, cmd_error);
  else if (!NILP (Vpurify_flag))
    message ("Bare impure Emacs (standard Lisp code not loaded)");
  else
    message ("Bare Emacs (standard Lisp code not loaded)");
  return Qnil;
}

DEFUN ("top-level", Ftop_level, Stop_level, 0, 0, "",
  "Exit all recursive editing levels.")
  ()
{
  Fthrow (Qtop_level, Qnil);
}

DEFUN ("exit-recursive-edit", Fexit_recursive_edit, Sexit_recursive_edit, 0, 0, "",
  "Exit from the innermost recursive edit or minibuffer.")
  ()
{
  if (command_loop_level > 0 || minibuf_level > 0)
    Fthrow (Qexit, Qnil);

  error ("No recursive edit is in progress");
}

DEFUN ("abort-recursive-edit", Fabort_recursive_edit, Sabort_recursive_edit, 0, 0, "",
  "Abort the command that requested this recursive edit or minibuffer input.")
  ()
{
  if (command_loop_level > 0 || minibuf_level > 0)
    Fthrow (Qexit, Qt);

  error ("No recursive edit is in progress");
}

/* This is the actual command reading loop,
   sans error-handling encapsulation.  */

Lisp_Object Fcommand_execute ();
static int read_key_sequence ();
1039
void safe_run_hooks ();
Jim Blandy's avatar
Jim Blandy committed
1040 1041 1042 1043

Lisp_Object
command_loop_1 ()
{
1044
  Lisp_Object cmd, tem;
Jim Blandy's avatar
Jim Blandy committed
1045 1046 1047 1048 1049 1050
  int lose;
  int nonundocount;
  Lisp_Object keybuf[30];
  int i;
  int no_redisplay;
  int no_direct;
1051 1052
  int prev_modiff;
  struct buffer *prev_buffer;
1053
#ifdef MULTI_KBOARD
1054
  int was_locked = single_kboard;
1055
#endif
Jim Blandy's avatar
Jim Blandy committed
1056

1057
  current_kboard->Vprefix_arg = Qnil;
1058
  Vdeactivate_mark = Qnil;
Jim Blandy's avatar
Jim Blandy committed
1059
  waiting_for_input = 0;
1060
  cancel_echoing ();
Jim Blandy's avatar
Jim Blandy committed
1061 1062 1063 1064 1065

  nonundocount = 0;
  no_redisplay = 0;
  this_command_key_count = 0;

1066 1067
  /* Make sure this hook runs after commands that get errors and
     throw to top level.  */
1068 1069
  /* Note that the value cell will never directly contain nil
     if the symbol is a local variable.  */
1070
  if (!NILP (Vpost_command_hook) && !NILP (Vrun_hooks))
1071
    safe_run_hooks (Qpost_command_hook);
1072

1073 1074 1075
  if (!NILP (Vdeferred_action_list))
    call0 (Vdeferred_action_function);

1076
  if (!NILP (Vpost_command_idle_hook) && !NILP (Vrun_hooks))
1077 1078 1079 1080 1081 1082 1083
    {
      if (NILP (Vunread_command_events)
	  && NILP (Vexecuting_macro)
	  && !NILP (sit_for (0, post_command_idle_delay, 0, 1)))
	safe_run_hooks (Qpost_command_idle_hook);
    }

1084
  /* Do this after running Vpost_command_hook, for consistency.  */
1085
  current_kboard->Vlast_command = this_command;
1086

Jim Blandy's avatar
Jim Blandy committed
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
  while (1)
    {
      /* Make sure the current window's buffer is selected.  */
      if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
	set_buffer_internal (XBUFFER (XWINDOW (selected_window)->buffer));

      /* Display any malloc warning that just came out.  Use while because
	 displaying one warning can cause another.  */

      while (pending_malloc_warning)
	display_malloc_warning ();

      no_direct = 0;

1101 1102
      Vdeactivate_mark = Qnil;

Jim Blandy's avatar
Jim Blandy committed
1103
      /* If minibuffer on and echo area in use,
1104
	 wait 2 sec and redraw minibuffer.  */
Jim Blandy's avatar
Jim Blandy committed
1105

1106 1107
      if (minibuf_level && echo_area_glyphs
	  && EQ (minibuf_window, echo_area_window))
Jim Blandy's avatar
Jim Blandy committed
1108
	{
1109 1110 1111 1112
	  /* Bind inhibit-quit to t so that C-g gets read in
	     rather than quitting back to the minibuffer.  */
	  int count = specpdl_ptr - specpdl;
	  specbind (Qinhibit_quit, Qt);
Jim Blandy's avatar
Jim Blandy committed
1113
	  Fsit_for (make_number (2), Qnil, Qnil);
1114
	  unbind_to (count, Qnil);
1115

Jim Blandy's avatar
Jim Blandy committed
1116 1117 1118 1119 1120
	  echo_area_glyphs = 0;
	  no_direct = 1;
	  if (!NILP (Vquit_flag))
	    {
	      Vquit_flag = Qnil;
1121
	      Vunread_command_events = Fcons (make_number (quit_char), Qnil);
Jim Blandy's avatar
Jim Blandy committed
1122 1123 1124 1125
	    }
	}

#ifdef C_ALLOCA
1126
      alloca (0);		/* Cause a garbage collection now */
Jim Blandy's avatar
Jim Blandy committed
1127 1128 1129
				/* Since we can free the most stuff here.  */
#endif /* C_ALLOCA */

1130
#if 0
Jim Blandy's avatar
Jim Blandy committed
1131
#ifdef MULTI_FRAME
1132 1133 1134 1135
      /* Select the frame that the last event came from.  Usually,
	 switch-frame events will take care of this, but if some lisp
	 code swallows a switch-frame event, we'll fix things up here.
	 Is this a good idea?  */
1136
      if (FRAMEP (internal_last_event_frame)
1137 1138
	  && XFRAME (internal_last_event_frame) != selected_frame)
	Fselect_frame (internal_last_event_frame, Qnil);
1139
#endif
Jim Blandy's avatar
Jim Blandy committed
1140
#endif
1141