keyboard.c 186 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 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 18 19 20 21 22
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
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */

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

23
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
24 25 26 27 28 29 30
#include <stdio.h>
#undef NULL
#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
/* Include systime.h after xterm.h to avoid double inclusion of time.h. */
#include "systime.h"

Jim Blandy's avatar
Jim Blandy committed
63 64
extern int errno;

65 66 67
/* Variables for blockinput.h: */

/* Non-zero if interrupt input is blocked right now.  */
68
int interrupt_input_blocked;
69 70 71

/* Nonzero means an input interrupt has arrived
   during the current critical section.  */
72
int interrupt_input_pending;
73 74


75 76
/* File descriptor to use for input.  */
extern int input_fd;
Jim Blandy's avatar
Jim Blandy committed
77

78
#ifdef HAVE_X_WINDOWS
Jim Blandy's avatar
Jim Blandy committed
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
/* 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;
  };

98 99
#ifdef MULTI_PERDISPLAY
PERDISPLAY *current_perdisplay;
100
PERDISPLAY *all_perdisplays;
101
#else
102
PERDISPLAY the_only_perdisplay;
103
#endif
104

Jim Blandy's avatar
Jim Blandy committed
105 106
/* Non-nil disable property on a command means
   do not execute it; call disabled-command-hook's value instead.  */
107
Lisp_Object Qdisabled, Qdisabled_command_hook;
Jim Blandy's avatar
Jim Blandy committed
108 109 110 111

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

114 115 116 117 118 119 120
/* 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
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140

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;

141 142 143
/* Nonzero means disregard local maps for the menu bar.  */
static int inhibit_local_menu_bar_menus;

144
/* Nonzero means C-g should cause immediate error-signal.  */
Jim Blandy's avatar
Jim Blandy committed
145 146 147
int immediate_quit;

/* Character to recognize as the help char.  */
148
Lisp_Object Vhelp_char;
Jim Blandy's avatar
Jim Blandy committed
149 150 151 152

/* Form to execute when help char is typed.  */
Lisp_Object Vhelp_form;

153 154 155
/* Command to run when the help character follows a prefix key.  */
Lisp_Object Vprefix_help_command;

156 157
/* List of items that should move to the end of the menu bar.  */
Lisp_Object Vmenu_bar_final_items;
158

Jim Blandy's avatar
Jim Blandy committed
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
/* 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;

180 181 182
/* If non-nil, this is a map that overrides all other local maps.  */
Lisp_Object Voverriding_local_map;

183 184 185
/* If non-nil, Voverriding_local_map applies to the menu bar.  */
Lisp_Object Voverriding_local_map_menu_flag;

Jim Blandy's avatar
Jim Blandy committed
186 187 188 189 190 191 192 193 194
/* 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;

195 196 197 198
/* 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
199 200 201
/* Last input character read for any purpose.  */
Lisp_Object last_input_char;

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

205 206 207
/* If not -1, an event to be read as subsequent command input.  */
int unread_command_char;

208 209
/* 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
210
   next command input, after any unread_command_events.
211 212 213 214 215

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

217 218 219
/* A mask of extra modifier bits to put into every keyboard char.  */
int extra_keyboard_modifiers;

Jim Blandy's avatar
Jim Blandy committed
220 221 222 223 224 225 226 227
/* 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;

228
/* Number of idle seconds before an auto-save and garbage collection.  */
Jim Blandy's avatar
Jim Blandy committed
229 230 231 232 233
static Lisp_Object Vauto_save_timeout;

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

234 235 236
/* Total number of times read_char has returned, outside of macros.  */
int num_nonmacro_input_chars;

Jim Blandy's avatar
Jim Blandy committed
237 238 239 240 241
/* Auto-save automatically when this many characters have been typed
   since the last time.  */

static int auto_save_interval;

242
/* Value of num_nonmacro_input_chars as of last auto save.  */
Jim Blandy's avatar
Jim Blandy committed
243 244 245 246 247 248 249 250 251 252 253 254 255

int last_auto_save;

/* Last command executed by the editor command loop, not counting
   commands that set the prefix argument.  */

Lisp_Object last_command;

/* The command being executed by the command loop.
   Commands may set this, and the value set will be copied into last_command
   instead of the actual command.  */
Lisp_Object this_command;

256 257 258
/* The value of point when the last command was executed.  */
int last_point_position;

259 260 261
/* The buffer that was current when the last command was started.  */
Lisp_Object last_point_position_buffer;

262
#ifdef MULTI_FRAME
263
/* The frame in which the last input event occurred, or Qmacro if the
264 265 266 267 268
   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;
269
#endif
270 271 272 273

/* 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).  */
Jim Blandy's avatar
Jim Blandy committed
274
Lisp_Object Vlast_event_frame;
Jim Blandy's avatar
Jim Blandy committed
275

Jim Blandy's avatar
Jim Blandy committed
276 277
/* 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
278 279 280 281 282
unsigned long last_event_timestamp;

Lisp_Object Qself_insert_command;
Lisp_Object Qforward_char;
Lisp_Object Qbackward_char;
283
Lisp_Object Qundefined;
Jim Blandy's avatar
Jim Blandy committed
284 285 286 287 288 289 290 291 292 293 294 295 296 297

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

298 299 300
/* Keymap mapping ASCII function key sequences onto their preferred forms.  */
Lisp_Object Vkey_translation_map;

301 302 303
/* Non-nil means deactivate the mark at end of this command.  */
Lisp_Object Vdeactivate_mark;

304 305 306 307 308
/* Menu bar specified in Lucid Emacs fashion.  */

Lisp_Object Vlucid_menu_bar_dirty_flag;
Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

309 310 311
/* Hooks to run before and after each command.  */
Lisp_Object Qpre_command_hook, Qpost_command_hook;
Lisp_Object Vpre_command_hook, Vpost_command_hook;
312
Lisp_Object Qcommand_hook_internal, Vcommand_hook_internal;
313

314 315 316 317 318 319
/* 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;
320
Lisp_Object Qdeferred_action_function;
321

Jim Blandy's avatar
Jim Blandy committed
322 323 324 325 326 327
/* File in which we write all commands we read.  */
FILE *dribble;

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

328 329 330
/* 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
331 332 333 334
int meta_key;

extern char *pending_malloc_warning;

335
#ifdef HAVE_MOUSE
336 337 338 339
/* If this flag is a frame, we check mouse_moved to see when the
   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
340 341 342 343 344 345 346 347

/* The window system handling code should set this if the mouse has
   moved since the last call to the mouse_position_hook.  Calling that
   hook should clear this.  Code assumes that if this is set, it can
   call mouse_position_hook to get the promised position, so don't set
   it unless you're prepared to substantiate the claim!  */
int mouse_moved;

348
#define MOUSE_ACTIVITY_AVAILABLE (FRAMEP (do_mouse_tracking) && mouse_moved)
349
#else /* Not HAVE_MOUSE.  */
350
#define MOUSE_ACTIVITY_AVAILABLE 0
351
#endif /* HAVE_MOUSE.  */
Jim Blandy's avatar
Jim Blandy committed
352 353 354

/* Symbols to head events.  */
Lisp_Object Qmouse_movement;
355
Lisp_Object Qscroll_bar_movement;
356
Lisp_Object Qswitch_frame;
357
Lisp_Object Qdelete_frame;
358 359
Lisp_Object Qiconify_frame;
Lisp_Object Qmake_frame_visible;
360

Jim Blandy's avatar
Jim Blandy committed
361 362 363 364 365 366 367
/* Symbols to denote kinds of events.  */
Lisp_Object Qfunction_key;
Lisp_Object Qmouse_click;
/* Lisp_Object Qmouse_movement; - also an event header */

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

370 371
Lisp_Object Qmenu_enable;

372 373 374 375 376 377 378 379 380 381 382 383 384
/* 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;

385
/* Symbols to use for parts of windows.  */
Jim Blandy's avatar
Jim Blandy committed
386
Lisp_Object Qmode_line;
Jim Blandy's avatar
Jim Blandy committed
387
Lisp_Object Qvertical_line;
388
Lisp_Object Qvertical_scroll_bar;
389 390 391
Lisp_Object Qmenu_bar;

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

393 394
Lisp_Object recursive_edit_unwind (), command_loop ();
Lisp_Object Fthis_command_keys ();
395
Lisp_Object Qextended_command_history;
Jim Blandy's avatar
Jim Blandy committed
396

397 398
Lisp_Object Qpolling_period;

Jim Blandy's avatar
Jim Blandy committed
399 400 401
/* 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
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425

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

426 427
/* If we support X Windows, turn on the code to poll periodically
   to detect C-g.  It isn't actually used when doing interrupt input.  */
Jim Blandy's avatar
Jim Blandy committed
428 429 430 431 432 433 434 435 436 437 438
#ifdef HAVE_X_WINDOWS
#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 ();
439
static int readable_events ();
440 441
static Lisp_Object read_char_x_menu_prompt ();
static Lisp_Object read_char_minibuf_menu_prompt ();
442 443 444 445
static Lisp_Object make_lispy_event ();
static Lisp_Object make_lispy_movement ();
static Lisp_Object modify_event_symbol ();
static Lisp_Object make_lispy_switch_frame ();
Jim Blandy's avatar
Jim Blandy committed
446 447 448 449

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

450 451 452 453
/* 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
454 455 456 457 458 459 460 461 462 463 464
#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);
465

466 467
  if (len > ECHOBUFSIZE - 4)
    len = ECHOBUFSIZE - 4;
468 469 470
  bcopy (str, current_perdisplay->echobuf, len);
  current_perdisplay->echoptr = current_perdisplay->echobuf + len;
  *current_perdisplay->echoptr = '\0';
Jim Blandy's avatar
Jim Blandy committed
471

472
  current_perdisplay->echo_after_prompt = len;
473

Jim Blandy's avatar
Jim Blandy committed
474 475 476 477 478 479 480 481 482 483 484 485
  echo ();
}

/* Add C to the echo string, if echoing is going on.  
   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 ();

486
  if (current_perdisplay->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
487
    {
488
      char *ptr = current_perdisplay->echoptr;
Jim Blandy's avatar
Jim Blandy committed
489
      
490
      if (ptr != current_perdisplay->echobuf)
Jim Blandy's avatar
Jim Blandy committed
491 492 493
	*ptr++ = ' ';

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

496
      if (INTEGERP (c))
Jim Blandy's avatar
Jim Blandy committed
497
	{
498
	  if (ptr - current_perdisplay->echobuf > ECHOBUFSIZE - 6)
Jim Blandy's avatar
Jim Blandy committed
499 500
	    return;

501
	  ptr = push_key_description (XINT (c), ptr);
Jim Blandy's avatar
Jim Blandy committed
502
	}
503
      else if (SYMBOLP (c))
Jim Blandy's avatar
Jim Blandy committed
504 505
	{
	  struct Lisp_String *name = XSYMBOL (c)->name;
506 507
	  if (((ptr - current_perdisplay->echobuf) + name->size + 4)
	      > ECHOBUFSIZE)
Jim Blandy's avatar
Jim Blandy committed
508 509 510 511 512
	    return;
	  bcopy (name->data, ptr, name->size);
	  ptr += name->size;
	}

513 514
      if (current_perdisplay->echoptr == current_perdisplay->echobuf
	  && EQ (c, Vhelp_char))
Jim Blandy's avatar
Jim Blandy committed
515 516 517 518 519 520
	{
	  strcpy (ptr, " (Type ? for further options)");
	  ptr += strlen (ptr);
	}

      *ptr = 0;
521
      current_perdisplay->echoptr = ptr;
Jim Blandy's avatar
Jim Blandy committed
522 523 524 525 526 527 528 529 530 531

      echo ();
    }
}

/* 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 ()
{
532 533
  if (!current_perdisplay->immediate_echo
      && current_perdisplay->echoptr == current_perdisplay->echobuf)
Jim Blandy's avatar
Jim Blandy committed
534
    return;
535
  /* Do nothing if we just printed a prompt.  */
536 537
  if (current_perdisplay->echo_after_prompt
      == current_perdisplay->echoptr - current_perdisplay->echobuf)
538
    return;
539
  /* Do nothing if not echoing at all.  */
540
  if (current_perdisplay->echoptr == 0)
541
    return;
Jim Blandy's avatar
Jim Blandy committed
542 543 544

  /* Put a dash at the end of the buffer temporarily,
     but make it go away when the next character is added.  */
545 546
  current_perdisplay->echoptr[0] = '-';
  current_perdisplay->echoptr[1] = 0;
Jim Blandy's avatar
Jim Blandy committed
547 548 549 550 551 552 553 554 555

  echo ();
}

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

echo ()
{
556
  if (!current_perdisplay->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
557 558
    {
      int i;
559
      current_perdisplay->immediate_echo = 1;
Jim Blandy's avatar
Jim Blandy committed
560 561

      for (i = 0; i < this_command_key_count; i++)
562 563 564 565 566 567 568
	{
	  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
569 570 571 572
      echo_dash ();
    }

  echoing = 1;
573
  message1_nolog (current_perdisplay->echobuf);
Jim Blandy's avatar
Jim Blandy committed
574 575 576 577 578 579 580 581 582 583
  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 ()
{
584 585 586
  current_perdisplay->immediate_echo = 0;
  current_perdisplay->echoptr = current_perdisplay->echobuf;
  current_perdisplay->echo_after_prompt = -1;
Jim Blandy's avatar
Jim Blandy committed
587 588 589 590 591 592 593
}

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

static int
echo_length ()
{
594
  return current_perdisplay->echoptr - current_perdisplay->echobuf;
Jim Blandy's avatar
Jim Blandy committed
595 596 597 598
}

/* 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
599
   switches frames while entering a key sequence.  */
Jim Blandy's avatar
Jim Blandy committed
600 601 602 603 604

static void
echo_truncate (len)
     int len;
{
605 606
  current_perdisplay->echobuf[len] = '\0';
  current_perdisplay->echoptr = current_perdisplay->echobuf + len;
607
  truncate_echo_area (len);
Jim Blandy's avatar
Jim Blandy committed
608 609 610 611 612 613 614 615
}

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

  if (this_command_key_count >= size)
Jim Blandy's avatar
Jim Blandy committed
619
    {
620
      Lisp_Object new_keys;
621

622
      new_keys = Fmake_vector (make_number (size * 2), Qnil);
623 624
      bcopy (XVECTOR (this_command_keys)->contents,
	     XVECTOR (new_keys)->contents,
625
	     size * sizeof (Lisp_Object));
626 627

      this_command_keys = new_keys;
Jim Blandy's avatar
Jim Blandy committed
628
    }
629 630

  XVECTOR (this_command_keys)->contents[this_command_key_count++] = key;
Jim Blandy's avatar
Jim Blandy committed
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
}

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);

649
  return unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
650 651 652
}

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

Jim Blandy's avatar
Jim Blandy committed
654 655
record_auto_save ()
{
656
  last_auto_save = num_nonmacro_input_chars;
Jim Blandy's avatar
Jim Blandy committed
657
}
658 659 660 661 662 663

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

force_auto_save_soon ()
{
  last_auto_save = - auto_save_interval - 1;
664 665

  record_asynch_buffer_change ();
666
}
Jim Blandy's avatar
Jim Blandy committed
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705

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;
}

Lisp_Object
cmd_error (data)
     Lisp_Object data;
706 707 708 709
{
  Vstandard_output = Qt;
  Vstandard_input = Qt;
  Vexecuting_macro = Qnil;
710 711 712
  if (!current_perdisplay)
    abort ();
  current_perdisplay->Vprefix_arg = Qnil;
713 714 715 716 717
  cmd_error_internal (data, 0);

  Vquit_flag = Qnil;

  Vinhibit_quit = Qnil;
718 719 720
#ifdef MULTI_PERDISPLAY
  current_perdisplay = 0;
#endif
721 722 723 724 725 726 727

  return make_number (0);
}

cmd_error_internal (data, context)
     Lisp_Object data;
     char *context;
Jim Blandy's avatar
Jim Blandy committed
728 729 730 731 732 733 734 735 736 737
{
  Lisp_Object errmsg, tail, errname, file_error;
  Lisp_Object stream;
  struct gcpro gcpro1;
  int i;

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

Jim Blandy's avatar
Jim Blandy committed
738
  /* If the window system or terminal frame hasn't been initialized
Jim Blandy's avatar
Jim Blandy committed
739 740
     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
741
  if (! FRAME_MESSAGE_BUF (selected_frame)
Jim Blandy's avatar
Jim Blandy committed
742 743 744 745 746 747 748 749 750
      || noninteractive)
    stream = Qexternal_debugging_output;
  else
    {
      Fdiscard_input ();
      bitch_at_user ();
      stream = Qt;
    }

751 752 753
  if (context != 0)
    write_string_1 (context, -1, stream);

Jim Blandy's avatar
Jim Blandy committed
754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782
  errname = Fcar (data);

  if (EQ (errname, Qerror))
    {
      data = Fcdr (data);
      if (!CONSP (data)) data = Qnil;
      errmsg = Fcar (data);
      file_error = Qnil;
    }
  else
    {
      errmsg = Fget (errname, Qerror_message);
      file_error = Fmemq (Qfile_error,
			  Fget (errname, Qerror_conditions));
    }

  /* Print an error message including the data items.
     This is done by printing it into a scratch buffer
     and then making a copy of the text in the buffer. */

  if (!CONSP (data)) data = Qnil;
  tail = Fcdr (data);
  GCPRO1 (tail);

  /* For file-error, make error message by concatenating
     all the data items.  They are all strings.  */
  if (!NILP (file_error) && !NILP (tail))
    errmsg = XCONS (tail)->car, tail = XCONS (tail)->cdr;

783
  if (STRINGP (errmsg))
Jim Blandy's avatar
Jim Blandy committed
784 785 786 787 788 789 790 791 792 793 794 795 796 797
    Fprinc (errmsg, stream);
  else
    write_string_1 ("peculiar error", -1, stream);

  for (i = 0; CONSP (tail); tail = Fcdr (tail), i++)
    {
      write_string_1 (i ? ", " : ": ", 2, stream);
      if (!NILP (file_error))
	Fprinc (Fcar (tail), stream);
      else
	Fprin1 (Fcar (tail), stream);
    }
  UNGCPRO;

Jim Blandy's avatar
Jim Blandy committed
798
  /* If the window system or terminal frame hasn't been initialized
Jim Blandy's avatar
Jim Blandy committed
799
     yet, or we're in -batch mode, this error should cause Emacs to exit.  */
Jim Blandy's avatar
Jim Blandy committed
800
  if (! FRAME_MESSAGE_BUF (selected_frame)
Jim Blandy's avatar
Jim Blandy committed
801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 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
      || 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);
	
	/* 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 ();
904
static void safe_run_hooks ();
Jim Blandy's avatar
Jim Blandy committed
905 906 907 908

Lisp_Object
command_loop_1 ()
{
909
  Lisp_Object cmd, tem;
Jim Blandy's avatar
Jim Blandy committed
910 911 912 913 914 915
  int lose;
  int nonundocount;
  Lisp_Object keybuf[30];
  int i;
  int no_redisplay;
  int no_direct;
916 917
  int prev_modiff;
  struct buffer *prev_buffer;
918
  PERDISPLAY *global_perdisplay = current_perdisplay;
Jim Blandy's avatar
Jim Blandy committed
919

920
  Vdeactivate_mark = Qnil;
Jim Blandy's avatar
Jim Blandy committed
921 922 923 924 925 926 927
  waiting_for_input = 0;
  cancel_echoing ();

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

928 929
  /* Make sure this hook runs after commands that get errors and
     throw to top level.  */
930 931 932 933
  /* Note that the value cell will never directly contain nil
     if the symbol is a local variable.  */
  if (!NILP (XSYMBOL (Qpost_command_hook)->value) && !NILP (Vrun_hooks))
    safe_run_hooks (Qpost_command_hook);
934

935 936 937
  if (!NILP (Vdeferred_action_list))
    call0 (Vdeferred_action_function);

938 939 940
  /* Do this after running Vpost_command_hook, for consistency.  */
  last_command = this_command;

Jim Blandy's avatar
Jim Blandy committed
941 942 943 944 945 946 947 948 949 950 951 952 953 954
  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;

955 956
      Vdeactivate_mark = Qnil;

Jim Blandy's avatar
Jim Blandy committed
957
      /* If minibuffer on and echo area in use,
958
	 wait 2 sec and redraw minibuffer.  */
Jim Blandy's avatar
Jim Blandy committed
959 960 961

      if (minibuf_level && echo_area_glyphs)
	{
962 963 964 965
	  /* 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
966
	  Fsit_for (make_number (2), Qnil, Qnil);
967
	  unbind_to (count, Qnil);
968

Jim Blandy's avatar
Jim Blandy committed
969 970 971 972 973
	  echo_area_glyphs = 0;
	  no_direct = 1;
	  if (!NILP (Vquit_flag))
	    {
	      Vquit_flag = Qnil;
974
	      Vunread_command_events = Fcons (make_number (quit_char), Qnil);
Jim Blandy's avatar
Jim Blandy committed
975 976 977 978
	    }
	}

#ifdef C_ALLOCA
979
      alloca (0);		/* Cause a garbage collection now */
Jim Blandy's avatar
Jim Blandy committed
980 981 982
				/* Since we can free the most stuff here.  */
#endif /* C_ALLOCA */

983
#if 0
Jim Blandy's avatar
Jim Blandy committed
984
#ifdef MULTI_FRAME
985 986 987 988
      /* 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?  */
989
      if (FRAMEP (internal_last_event_frame)
990 991
	  && XFRAME (internal_last_event_frame) != selected_frame)
	Fselect_frame (internal_last_event_frame, Qnil);
992
#endif
Jim Blandy's avatar
Jim Blandy committed
993
#endif
994 995
      /* If it has changed current-menubar from previous value,
	 really recompute the menubar from the value.  */
996 997
      if (! NILP (Vlucid_menu_bar_dirty_flag)
	  && !NILP (Ffboundp (Qrecompute_lucid_menubar)))
998 999
	call0 (Qrecompute_lucid_menubar);

1000
      /* Read next key sequence; i gets its length.  */
1001
      i = read_key_sequence (keybuf, sizeof keybuf / sizeof keybuf[0], Qnil, 0);
1002 1003 1004

      ++num_input_keys;

Jim Blandy's avatar
Jim Blandy committed
1005 1006 1007 1008 1009
      /* Now we have read a key sequence of length I,
	 or else I is 0 and we found end of file.  */

      if (i == 0)		/* End of file -- happens only in */
	return Qnil;		/* a kbd macro, at the end.  */
1010 1011 1012 1013 1014 1015
      /* -1 means read_key_sequence got a menu that was rejected.
	 Just loop around and read another command.  */
      if (i == -1)
	{
	  cancel_echoing ();
	  this_command_key_count = 0;
1016
	  goto finalize;
1017
	}
Jim Blandy's avatar
Jim Blandy committed
1018 1019 1020

      last_command_char = keybuf[i - 1];

1021 1022 1023 1024 1025
      /* If the previous command tried to force a specific window-start,
	 forget about that, in case this command moves point far away
	 from that position.  */
      XWINDOW (selected_window)->force_start = Qnil;

Jim Blandy's avatar
Jim Blandy committed
1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
      cmd = read_key_sequence_cmd;
      if (!NILP (Vexecuting_macro))
	{
	  if (!NILP (Vquit_flag))
	    {
	      Vexecuting_macro = Qt;
	      QUIT;		/* Make some noise. */
				/* Will return since macro now empty. */
	    }
	}

      /* Do redisplay processing after this command except in special
1038 1039 1040 1041
	 cases identified below that set no_redisplay to 1.
	 (actually, there's currently no way to prevent the redisplay,
	 and no_redisplay is ignored.
	 Perhaps someday we will really implement it.  */
Jim Blandy's avatar
Jim Blandy committed
1042 1043
      no_redisplay = 0;

1044 1045
      prev_buffer = current_buffer;
      prev_modiff = MODIFF;
1046
      last_point_position = PT;
1047
      XSETBUFFER (last_point_position_buffer, prev_buffer);
1048

Jim Blandy's avatar
Jim Blandy committed
1049 1050
      /* Execute the command.  */

1051
      this_command = cmd;
1052 1053 1054 1055
      /* Note that the value cell will never directly contain nil
	 if the symbol is a local variable.  */
      if (!NILP (XSYMBOL (Qpre_command_hook)->value) && !NILP (Vrun_hooks))
	safe_run_hooks (Qpre_command_hook);
1056

1057
      if (NILP (this_command))
Jim Blandy's avatar
Jim Blandy committed
1058 1059 1060 1061 1062
	{
	  /* nil means key is undefined.  */
	  bitch_at_user ();
	  defining_kbd_macro = 0;
	  update_mode_lines = 1;
1063
	  current_perdisplay->Vprefix_arg = Qnil;
1064

Jim Blandy's avatar
Jim Blandy committed
1065 1066 1067
	}
      else
	{
1068
	  if (NILP (current_perdisplay->Vprefix_arg) && ! no_direct)
Jim Blandy's avatar
Jim Blandy committed
1069 1070 1071
	    {
	      /* Recognize some common commands in common situations and
		 do them directly.  */
Karl Heuer's avatar
Karl Heuer committed
1072
	      if (EQ (this_command, Qforward_char) && PT < ZV)
Jim Blandy's avatar
Jim Blandy committed
1073 1074 1075
		{
                  struct Lisp_Vector *dp
		    = window_display_table (XWINDOW (selected_window));
Karl Heuer's avatar
Karl Heuer committed
1076 1077
		  lose = FETCH_CHAR (PT);
		  SET_PT (PT + 1);
1078
		  if ((dp
1079
		       ? (VECTORP (DISP_CHAR_VECTOR (dp, lose))
1080 1081 1082
			  ? XVECTOR (DISP_CHAR_VECTOR (dp, lose))->size == 1
                          : (NILP (DISP_CHAR_VECTOR (dp, lose))
                             && (lose >= 0x20 && lose < 0x7f)))
1083
		       : (lose >= 0x20 && lose < 0x7f))
Jim Blandy's avatar
Jim Blandy committed
1084 1085 1086
		      && (XFASTINT (XWINDOW (selected_window)->last_modified)
			  >= MODIFF)
		      && (XFASTINT (XWINDOW (selected_window)->last_point)
Karl Heuer's avatar
Karl Heuer committed
1087
			  == PT - 1)
Jim Blandy's avatar
Jim Blandy committed
1088 1089 1090 1091 1092 1093 1094
		      && !windows_or_buffers_changed
		      && EQ (current_buffer->selective_display, Qnil)
		      && !detect_input_pending ()
		      && NILP (Vexecuting_macro))
		    no_redisplay = direct_output_forward_char (1);
		  goto directly_done;
		}
Karl Heuer's avatar
Karl Heuer committed
1095
	      else if (EQ (this_command, Qbackward_char) && PT > BEGV)
Jim Blandy's avatar
Jim Blandy committed
1096 1097 1098
		{
                  struct Lisp_Vector *dp
		    = window_display_table (XWINDOW (selected_window));
Karl Heuer's avatar
Karl Heuer committed
1099 1100
		  SET_PT (PT - 1);
		  lose = FETCH_CHAR (PT);
1101
		  if ((dp
1102
		       ? (VECTORP (DISP_CHAR_VECTOR (dp, lose))
1103 1104 1105
			  ? XVECTOR (DISP_CHAR_VECTOR (dp, lose))->size == 1
                          : (NILP (DISP_CHAR_VECTOR (dp, lose))
                             && (lose >= 0x20 && lose < 0x7f)))
1106
		       : (lose >= 0x20 && lose < 0x7f))
Jim Blandy's avatar
Jim Blandy committed
1107 1108 1109
		      && (XFASTINT (XWINDOW (selected_window)->last_modified)
			  >= MODIFF)
		      && (XFASTINT (XWINDOW (selected_window)->last_point)
Karl Heuer's avatar
Karl Heuer committed
1110
			  == PT + 1)
Jim Blandy's avatar
Jim Blandy committed
1111 1112 1113 1114 1115 1116 1117
		      && !windows_or_buffers_changed
		      && EQ (current_buffer->selective_display, Qnil)
		      && !detect_input_pending ()
		      && NILP (Vexecuting_macro))
		    no_redisplay = direct_output_forward_char (-1);
		  goto directly_done;
		}
1118
	      else if (EQ (this_command, Qself_insert_command)
Jim Blandy's avatar
Jim Blandy committed
1119
		       /* Try this optimization only on ascii keystrokes.  */
1120
		       && INTEGERP (last_command_char))
Jim Blandy's avatar
Jim Blandy committed
1121 1122
		{
		  unsigned char c = XINT (last_command_char);
1123
		  int value;
Jim Blandy's avatar
Jim Blandy committed
1124

1125 1126
		  if (NILP (Vexecuting_macro)
		      && !EQ (minibuf_window, selected_window))
Jim Blandy's avatar
Jim Blandy committed
1127 1128 1129 1130 1131 1132 1133 1134
		    {
		      if (!nonundocount || nonundocount >= 20)
			{
			  Fundo_boundary ();
			  nonundocount = 0;
			}
		      nonundocount++;
		    }
1135 1136 1137 1138
		  lose = ((XFASTINT (XWINDOW (selected_window)->last_modified)
			   < MODIFF)
			  || (XFASTINT (XWINDOW (selected_window)->last_point)
			      != PT)
1139
			  || MODIFF <= SAVE_MODIFF
1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
			  || windows_or_buffers_changed
			  || !EQ (current_buffer->selective_display, Qnil)
			  || detect_input_pending ()
			  || !NILP (Vexecuting_macro));
		  value = internal_self_insert (c, 0);
		  if (value)
		    lose = 1;
		  if (value == 2)
		    nonundocount = 0;

		  if (!lose
		      && (PT == ZV || FETCH_CHAR (PT) == '\n'))
Jim Blandy's avatar
Jim Blandy committed
1152 1153 1154
		    {
		      struct Lisp_Vector *dp
			= window_display_table (XWINDOW (selected_window));
1155
		      int lose = c;
Jim Blandy's avatar
Jim Blandy committed
1156

1157 1158
		      if (dp)
			{
1159
			  Lisp_Object obj;
1160