keyboard.c 140 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Keyboard and mouse input; editor command loop.
2
   Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993 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 23 24 25 26 27 28 29 30
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>

#include "config.h"
#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 43 44 45 46
#include <setjmp.h>
#include <errno.h>

#ifndef VMS
#include <sys/ioctl.h>
#endif

Jim Blandy's avatar
Jim Blandy committed
47
#include "syssignal.h"
48
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
49
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
50 51 52

extern int errno;

53 54 55
/* Variables for blockinput.h: */

/* Non-zero if interrupt input is blocked right now.  */
56
int interrupt_input_blocked;
57 58 59

/* Nonzero means an input interrupt has arrived
   during the current critical section.  */
60
int interrupt_input_pending;
61 62


Jim Blandy's avatar
Jim Blandy committed
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
#ifdef HAVE_X_WINDOWS
extern Lisp_Object Vmouse_grabbed;

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

/* Non-nil disable property on a command means
   do not execute it; call disabled-command-hook's value instead.  */
Lisp_Object Qdisabled, Vdisabled_command_hook;

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

94 95 96 97 98 99 100
/* 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
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159

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;

/* Nonzero means C-G should cause immediate error-signal.  */
int immediate_quit;

/* Character to recognize as the help char.  */
Lisp_Object help_char;

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

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

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

160 161 162 163
/* 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
164 165 166
/* Last input character read for any purpose.  */
Lisp_Object last_input_char;

Jim Blandy's avatar
Jim Blandy committed
167 168
/* If not Qnil, a list of objects to be read as subsequent command input.  */
Lisp_Object unread_command_events;
Jim Blandy's avatar
Jim Blandy committed
169

170 171 172
/* If not -1, an event to be read as subsequent command input.  */
int unread_command_char;

173 174
/* 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
175
   next command input, after any unread_command_events.
176 177 178 179 180

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

182 183 184
/* A mask of extra modifier bits to put into every keyboard char.  */
int extra_keyboard_modifiers;

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

193
/* Number of idle seconds before an auto-save and garbage collection.  */
Jim Blandy's avatar
Jim Blandy committed
194 195 196 197 198
static Lisp_Object Vauto_save_timeout;

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

199 200 201
/* Total number of times read_char has returned, outside of macros.  */
int num_nonmacro_input_chars;

Jim Blandy's avatar
Jim Blandy committed
202 203 204 205 206
/* Auto-save automatically when this many characters have been typed
   since the last time.  */

static int auto_save_interval;

207
/* Value of num_nonmacro_input_chars as of last auto save.  */
Jim Blandy's avatar
Jim Blandy committed
208 209 210 211 212 213 214 215 216 217 218 219 220

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;

221
#ifdef MULTI_FRAME
222
/* The frame in which the last input event occurred, or Qmacro if the
223 224 225 226 227 228 229 230 231
   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).  */
Jim Blandy's avatar
Jim Blandy committed
232
Lisp_Object Vlast_event_frame;
233
#endif
Jim Blandy's avatar
Jim Blandy committed
234

Jim Blandy's avatar
Jim Blandy committed
235 236
/* 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
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
unsigned long last_event_timestamp;

Lisp_Object Qself_insert_command;
Lisp_Object Qforward_char;
Lisp_Object Qbackward_char;

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

256 257 258
/* Non-nil means deactivate the mark at end of this command.  */
Lisp_Object Vdeactivate_mark;

259 260 261 262 263
/* Menu bar specified in Lucid Emacs fashion.  */

Lisp_Object Vlucid_menu_bar_dirty_flag;
Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

264 265 266 267
/* Hooks to run before and after each command.  */
Lisp_Object Qpre_command_hook, Qpost_command_hook;
Lisp_Object Vpre_command_hook, Vpost_command_hook;

Jim Blandy's avatar
Jim Blandy committed
268 269 270 271 272 273
/* File in which we write all commands we read.  */
FILE *dribble;

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

274 275 276
/* 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
277 278 279 280 281 282 283
int meta_key;

extern char *pending_malloc_warning;

/* Circular buffer for pre-read keyboard input.  */
static struct input_event kbd_buffer[KBD_BUFFER_SIZE];

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

286 287
   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,
288 289
   internal_last_event_frame or the event itself points to the frame.
   So that's all fine.
290 291 292 293 294 295 296 297 298 299

   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.

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

303 304 305 306 307 308 309 310
   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;
311

Jim Blandy's avatar
Jim Blandy committed
312 313 314 315 316 317 318 319 320
/* 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].  */
321 322 323
#ifdef __STDC__
volatile
#endif
Jim Blandy's avatar
Jim Blandy committed
324 325 326 327 328
static 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_write_count.  When we
   dequeue a non-hook event, we increment kbd_read_count.  We say that
329
   there is input available iff the two counters are not equal.
Jim Blandy's avatar
Jim Blandy committed
330 331 332 333 334

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

335
/* If this flag is non-zero, we check mouse_moved to see when the
336
   mouse moves, and motion events will appear in the input stream.  If
337 338
   it is zero, mouse motion is ignored.  */
static int do_mouse_tracking;
Jim Blandy's avatar
Jim Blandy committed
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357

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

/* True iff there is an event in kbd_buffer, or if mouse tracking is
   enabled and there is a new mouse position in the mouse movement
   buffer.  Note that if this is false, that doesn't mean that there
   is readable input; all the events in the queue might be button-up
   events, and do_mouse_tracking might be off.  */
#define EVENT_QUEUES_EMPTY \
  ((kbd_fetch_ptr == kbd_store_ptr) && (!do_mouse_tracking || !mouse_moved))


/* Symbols to head events.  */
Lisp_Object Qmouse_movement;
358
Lisp_Object Qscroll_bar_movement;
359 360
Lisp_Object Qswitch_frame;

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 ();
Jim Blandy's avatar
Jim Blandy committed
395

Jim Blandy's avatar
Jim Blandy committed
396 397 398
/* 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
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445

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

/* If we support X Windows, and won't get an interrupt when input
   arrives from the server, poll periodically so we can detect C-g.  */
#ifdef HAVE_X_WINDOWS
#ifndef SIGIO
#define POLL_FOR_INPUT
#endif
#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 ();

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

/* Nonzero means echo each character as typed.  */
static int immediate_echo;

/* The text we're echoing in the modeline - partial key sequences,
446 447
   usually.  '\0'-terminated.  This really shouldn't have a fixed size.  */
static char echobuf[300];
Jim Blandy's avatar
Jim Blandy committed
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464

/* Where to append more text to echobuf if we want to.  */
static char *echoptr;

#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);
  if (len > sizeof echobuf - 4)
    len = sizeof echobuf - 4;
465
  bcopy (str, echobuf, len);
Jim Blandy's avatar
Jim Blandy committed
466
  echoptr = echobuf + len;
467
  *echoptr = '\0';
Jim Blandy's avatar
Jim Blandy committed
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488

  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 ();

  if (immediate_echo)
    {
      char *ptr = echoptr;
      
      if (ptr != echobuf)
	*ptr++ = ' ';

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

      if (XTYPE (c) == Lisp_Int)
	{
	  if (ptr - echobuf > sizeof echobuf - 6)
	    return;

496
	  ptr = push_key_description (XINT (c), ptr);
Jim Blandy's avatar
Jim Blandy committed
497 498 499 500 501 502 503 504 505 506
	}
      else if (XTYPE (c) == Lisp_Symbol)
	{
	  struct Lisp_String *name = XSYMBOL (c)->name;
	  if (((ptr - echobuf) + name->size + 4) > sizeof echobuf)
	    return;
	  bcopy (name->data, ptr, name->size);
	  ptr += name->size;
	}

507
      if (echoptr == echobuf && EQ (c, help_char))
Jim Blandy's avatar
Jim Blandy committed
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
	{
	  strcpy (ptr, " (Type ? for further options)");
	  ptr += strlen (ptr);
	}

      *ptr = 0;
      echoptr = ptr;

      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 ()
{
  if (!immediate_echo && echoptr == echobuf)
    return;
527 528 529
  /* Do nothing if not echoing at all.  */
  if (echoptr == 0)
    return;
Jim Blandy's avatar
Jim Blandy committed
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549

  /* Put a dash at the end of the buffer temporarily,
     but make it go away when the next character is added.  */
  echoptr[0] = '-';
  echoptr[1] = 0;

  echo ();
}

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

echo ()
{
  if (!immediate_echo)
    {
      int i;
      immediate_echo = 1;

      for (i = 0; i < this_command_key_count; i++)
550
	echo_char (XVECTOR (this_command_keys)->contents[i]);
Jim Blandy's avatar
Jim Blandy committed
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
      echo_dash ();
    }

  echoing = 1;
  message1 (echobuf);
  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 ()
{
  immediate_echo = 0;
  echoptr = echobuf;
}

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

static int
echo_length ()
{
  return echoptr - echobuf;
}

/* 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
580
   switches frames while entering a key sequence.  */
Jim Blandy's avatar
Jim Blandy committed
581 582 583 584 585 586

static void
echo_truncate (len)
     int len;
{
  echobuf[len] = '\0';
587
  echoptr = echobuf + len;
Jim Blandy's avatar
Jim Blandy committed
588 589 590 591 592 593 594 595
}

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

  if (this_command_key_count >= size)
Jim Blandy's avatar
Jim Blandy committed
599
    {
600 601 602 603
      Lisp_Object new_keys = Fmake_vector (make_number (size * 2), Qnil);

      bcopy (XVECTOR (this_command_keys)->contents,
	     XVECTOR (new_keys)->contents,
604
	     size * sizeof (Lisp_Object));
605 606

      this_command_keys = new_keys;
Jim Blandy's avatar
Jim Blandy committed
607
    }
608 609

  XVECTOR (this_command_keys)->contents[this_command_key_count++] = key;
Jim Blandy's avatar
Jim Blandy committed
610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
}

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);

628
  return unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
629 630 631 632 633
}

/* When an auto-save happens, record the "time", and don't do again soon.  */
record_auto_save ()
{
634
  last_auto_save = num_nonmacro_input_chars;
Jim Blandy's avatar
Jim Blandy committed
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
}

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;
{
  Lisp_Object errmsg, tail, errname, file_error;
  Lisp_Object stream;
  struct gcpro gcpro1;
  int i;

  Vquit_flag = Qnil;
  Vinhibit_quit = Qt;
  Vstandard_output = Qt;
  Vstandard_input = Qt;
  Vexecuting_macro = Qnil;
  echo_area_glyphs = 0;

Jim Blandy's avatar
Jim Blandy committed
688
  /* If the window system or terminal frame hasn't been initialized
Jim Blandy's avatar
Jim Blandy committed
689 690
     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
691
  if (! FRAME_MESSAGE_BUF (selected_frame)
Jim Blandy's avatar
Jim Blandy committed
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
      || noninteractive)
    stream = Qexternal_debugging_output;
  else
    {
      Fdiscard_input ();
      bitch_at_user ();
      stream = Qt;
    }

  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;

  if (XTYPE (errmsg) == Lisp_String)
    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
745
  /* If the window system or terminal frame hasn't been initialized
Jim Blandy's avatar
Jim Blandy committed
746
     yet, or we're in -batch mode, this error should cause Emacs to exit.  */
Jim Blandy's avatar
Jim Blandy committed
747
  if (! FRAME_MESSAGE_BUF (selected_frame)
Jim Blandy's avatar
Jim Blandy committed
748 749 750 751 752 753 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 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 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
      || noninteractive)
    {
      Fterpri (stream);
      Fkill_emacs (make_number (-1));
    }

  Vquit_flag = Qnil;

  Vinhibit_quit = Qnil;
  return make_number (0);
}

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 ();

Lisp_Object
command_loop_1 ()
{
860
  Lisp_Object cmd, tem;
Jim Blandy's avatar
Jim Blandy committed
861 862 863 864 865 866
  int lose;
  int nonundocount;
  Lisp_Object keybuf[30];
  int i;
  int no_redisplay;
  int no_direct;
867 868
  int prev_modiff;
  struct buffer *prev_buffer;
Jim Blandy's avatar
Jim Blandy committed
869 870

  Vprefix_arg = Qnil;
871
  Vdeactivate_mark = Qnil;
Jim Blandy's avatar
Jim Blandy committed
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
  waiting_for_input = 0;
  cancel_echoing ();

  /* Don't clear out last_command at the beginning of a macro.  */
  if (XTYPE (Vexecuting_macro) != Lisp_String)
    last_command = Qt;

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

  while (1)
    {
      /* Install chars successfully executed in kbd macro.  */

      if (defining_kbd_macro && NILP (Vprefix_arg))
	finalize_kbd_macro_chars ();

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

902 903
      Vdeactivate_mark = Qnil;

Jim Blandy's avatar
Jim Blandy committed
904 905 906 907 908
      /* If minibuffer on and echo area in use,
	 wait 2 sec and redraw minibufer.  */

      if (minibuf_level && echo_area_glyphs)
	{
909 910 911 912
	  /* 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
913
	  Fsit_for (make_number (2), Qnil, Qnil);
914
	  unbind_to (count, Qnil);
915

Jim Blandy's avatar
Jim Blandy committed
916 917 918 919 920
	  echo_area_glyphs = 0;
	  no_direct = 1;
	  if (!NILP (Vquit_flag))
	    {
	      Vquit_flag = Qnil;
Jim Blandy's avatar
Jim Blandy committed
921
	      unread_command_events = Fcons (make_number (quit_char), Qnil);
Jim Blandy's avatar
Jim Blandy committed
922 923 924 925 926 927 928 929
	    }
	}

#ifdef C_ALLOCA
	  alloca (0);		/* Cause a garbage collection now */
				/* Since we can free the most stuff here.  */
#endif /* C_ALLOCA */

930
#if 0
Jim Blandy's avatar
Jim Blandy committed
931
#ifdef MULTI_FRAME
932 933 934 935
      /* 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?  */
936 937 938
      if (XTYPE (internal_last_event_frame) == Lisp_Frame
	  && XFRAME (internal_last_event_frame) != selected_frame)
	Fselect_frame (internal_last_event_frame, Qnil);
939
#endif
Jim Blandy's avatar
Jim Blandy committed
940
#endif
941 942 943 944 945
      /* If it has changed current-menubar from previous value,
	 really recompute the menubar from the value.  */
      if (! NILP (Vlucid_menu_bar_dirty_flag))
	call0 (Qrecompute_lucid_menubar);

946
#if 0 /* This is done in xdisp.c now.  */
947 948 949 950 951
#ifdef MULTI_FRAME
      for (tem = Vframe_list; CONSP (tem); tem = XCONS (tem)->cdr)
	{
	  struct frame *f = XFRAME (XCONS (tem)->car);
	  struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
952 953 954 955 956 957 958 959

	  /* If the user has switched buffers or windows, we need to
	     recompute to reflect the new bindings.  But we'll
	     recompute when update_mode_lines is set too; that means
	     that people can use force-mode-line-update to request
	     that the menu bar be recomputed.  The adverse effect on
	     the rest of the redisplay algorithm is about the same as
	     windows_or_buffers_changed anyway.  */
960
	  if (windows_or_buffers_changed
961
	      || update_mode_lines
962 963 964 965 966 967 968 969 970 971 972
	      || (XFASTINT (w->last_modified) < MODIFF
		  && (XFASTINT (w->last_modified)
		      <= XBUFFER (w->buffer)->save_modified)))
	    {
	      struct buffer *prev = current_buffer;
	      current_buffer = XBUFFER (w->buffer);
	      FRAME_MENU_BAR_ITEMS (f) = menu_bar_items ();
	      current_buffer = prev;
	    }
	}
#endif /* MULTI_FRAME */
973
#endif /* 0 */
Jim Blandy's avatar
Jim Blandy committed
974

975 976 977 978 979
      /* Read next key sequence; i gets its length.  */
      i = read_key_sequence (keybuf, (sizeof keybuf / sizeof (keybuf[0])), 0);

      ++num_input_keys;

Jim Blandy's avatar
Jim Blandy committed
980 981 982 983 984 985 986 987
      /* 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.  */

      last_command_char = keybuf[i - 1];

988 989 990 991 992
      /* 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
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
      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
	 cases identified below that set no_redisplay to 1.  */
      no_redisplay = 0;

1008 1009 1010
      prev_buffer = current_buffer;
      prev_modiff = MODIFF;

Jim Blandy's avatar
Jim Blandy committed
1011 1012
      /* Execute the command.  */

1013 1014 1015 1016
      this_command = cmd;
      if (!NILP (Vpre_command_hook))
	call1 (Vrun_hooks, Qpre_command_hook);

1017
      if (NILP (this_command))
Jim Blandy's avatar
Jim Blandy committed
1018 1019 1020 1021 1022 1023
	{
	  /* nil means key is undefined.  */
	  bitch_at_user ();
	  defining_kbd_macro = 0;
	  update_mode_lines = 1;
	  Vprefix_arg = Qnil;
1024

Jim Blandy's avatar
Jim Blandy committed
1025 1026 1027 1028 1029 1030 1031
	}
      else
	{
	  if (NILP (Vprefix_arg) && ! no_direct)
	    {
	      /* Recognize some common commands in common situations and
		 do them directly.  */
1032
	      if (EQ (this_command, Qforward_char) && point < ZV)
Jim Blandy's avatar
Jim Blandy committed
1033 1034 1035 1036 1037
		{
                  struct Lisp_Vector *dp
		    = window_display_table (XWINDOW (selected_window));
		  lose = FETCH_CHAR (point);
		  SET_PT (point + 1);
1038 1039
		  if ((dp
		       ? (XTYPE (DISP_CHAR_VECTOR (dp, lose)) != Lisp_Vector
1040
			  && XVECTOR (DISP_CHAR_VECTOR (dp, lose))->size == 1)
1041
		       : (lose >= 0x20 && lose < 0x7f))
Jim Blandy's avatar
Jim Blandy committed
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
		      && (XFASTINT (XWINDOW (selected_window)->last_modified)
			  >= MODIFF)
		      && (XFASTINT (XWINDOW (selected_window)->last_point)
			  == point - 1)
		      && !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;
		}
1053
	      else if (EQ (this_command, Qbackward_char) && point > BEGV)
Jim Blandy's avatar
Jim Blandy committed
1054 1055 1056 1057 1058
		{
                  struct Lisp_Vector *dp
		    = window_display_table (XWINDOW (selected_window));
		  SET_PT (point - 1);
		  lose = FETCH_CHAR (point);
1059 1060
		  if ((dp
		       ? (XTYPE (DISP_CHAR_VECTOR (dp, lose)) != Lisp_Vector
1061
			  && XVECTOR (DISP_CHAR_VECTOR (dp, lose))->size == 1)
1062
		       : (lose >= 0x20 && lose < 0x7f))
Jim Blandy's avatar
Jim Blandy committed
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
		      && (XFASTINT (XWINDOW (selected_window)->last_modified)
			  >= MODIFF)
		      && (XFASTINT (XWINDOW (selected_window)->last_point)
			  == point + 1)
		      && !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;
		}
1074
	      else if (EQ (this_command, Qself_insert_command)
Jim Blandy's avatar
Jim Blandy committed
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
		       /* Try this optimization only on ascii keystrokes.  */
		       && XTYPE (last_command_char) == Lisp_Int)
		{
		  unsigned char c = XINT (last_command_char);

		  if (NILP (Vexecuting_macro) &&
		      !EQ (minibuf_window, selected_window))
		    {
		      if (!nonundocount || nonundocount >= 20)
			{
			  Fundo_boundary ();
			  nonundocount = 0;
			}
		      nonundocount++;
		    }
		  lose = (XFASTINT (XWINDOW (selected_window)->last_modified)
			  < MODIFF)
		    || (XFASTINT (XWINDOW (selected_window)->last_point)
			  != point)
		    || MODIFF <= current_buffer->save_modified
		    || windows_or_buffers_changed
		    || !EQ (current_buffer->selective_display, Qnil)
		    || detect_input_pending ()
		    || !NILP (Vexecuting_macro);
1099
		  if (internal_self_insert (XINT (c), 0))
Jim Blandy's avatar
Jim Blandy committed
1100 1101 1102 1103 1104 1105 1106 1107 1108
		    {
		      lose = 1;
		      nonundocount = 0;
		    }
		  if (!lose &&
		      (point == ZV || FETCH_CHAR (point) == '\n'))
		    {
		      struct Lisp_Vector *dp
			= window_display_table (XWINDOW (selected_window));
1109
		      int lose = XINT (c);
Jim Blandy's avatar
Jim Blandy committed
1110

1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
		      if (dp)
			{
			  Lisp_Object obj = DISP_CHAR_VECTOR (dp, lose);

			  if (XTYPE (obj) == Lisp_Vector
			      && XVECTOR (obj)->size == 1
			      && (XTYPE (obj = XVECTOR (obj)->contents[0])
				  == Lisp_Int))
			    no_redisplay =
			      direct_output_for_insert (XINT (obj));
			}
		      else
			{
			  if (lose >= 0x20 && lose <= 0x7e)
			    no_redisplay = direct_output_for_insert (lose);
			}
Jim Blandy's avatar
Jim Blandy committed
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
		    }
		  goto directly_done;
		}
	    }

	  /* Here for a command that isn't executed directly */

	  nonundocount = 0;
	  if (NILP (Vprefix_arg))
	    Fundo_boundary ();
1137
	  Fcommand_execute (this_command, Qnil);
Jim Blandy's avatar
Jim Blandy committed
1138 1139

	}
Jim Blandy's avatar
Jim Blandy committed
1140
    directly_done: ;
Jim Blandy's avatar
Jim Blandy committed
1141

1142 1143 1144
      if (!NILP (Vpost_command_hook))
	call1 (Vrun_hooks, Qpost_command_hook);

Jim Blandy's avatar
Jim Blandy committed
1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159
      /* If there is a prefix argument,
	 1) We don't want last_command to be ``universal-argument''
	 (that would be dumb), so don't set last_command,
	 2) we want to leave echoing on so that the prefix will be
	 echoed as part of this key sequence, so don't call
	 cancel_echoing, and
	 3) we want to leave this_command_key_count non-zero, so that
	 read_char will realize that it is re-reading a character, and
	 not echo it a second time.  */
      if (NILP (Vprefix_arg))
	{
	  last_command = this_command;
	  cancel_echoing ();
	  this_command_key_count = 0;
	}
1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170

      if (!NILP (current_buffer->mark_active))
	{
	  if (!NILP (Vdeactivate_mark) && !NILP (Vtransient_mark_mode))
	    {
	      current_buffer->mark_active = Qnil;
	      call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
	    }
	  else if (current_buffer != prev_buffer || MODIFF != prev_modiff)
	    call1 (Vrun_hooks, intern ("activate-mark-hook"));
	}
Jim Blandy's avatar
Jim Blandy committed
1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188
    }
}

/* Number of seconds between polling for input.  */
int polling_period;

/* Nonzero means polling for input is temporarily suppresed.  */
int poll_suppress_count;

#ifdef POLL_FOR_INPUT
int polling_for_input;

/* Handle an alarm once each second and read pending input
   so as to handle a C-g if it comces in.  */

SIGTYPE
input_poll_signal ()
{
1189 1190 1191
  if (interrupt_input_blocked == 0
      && !waiting_for_input)
    read_avail_input (0);
Jim Blandy's avatar
Jim Blandy committed
1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243
  signal (SIGALRM, input_poll_signal);
  alarm (polling_period);
}

#endif

/* Begin signals to poll for input, if they are appropriate.
   This function is called unconditionally from various places.  */

start_polling ()
{
#ifdef POLL_FOR_INPUT
  if (read_socket_hook)
    {
      poll_suppress_count--;
      if (poll_suppress_count == 0)
	{
	  signal (SIGALRM, input_poll_signal);
	  polling_for_input = 1;
	  alarm (polling_period);
	}
    }
#endif
}

/* Turn off polling.  */

stop_polling ()
{
#ifdef POLL_FOR_INPUT
  if (read_socket_hook)
    {
      if (poll_suppress_count == 0)
	{
	  polling_for_input = 0;
	  alarm (0);
	}
      poll_suppress_count++;
    }
#endif
}

/* Input of single characters from keyboard */

Lisp_Object print_help ();
static Lisp_Object kbd_buffer_get_event ();

/* read a character from the keyboard; call the redisplay if needed */
/* commandflag 0 means do not do auto-saving, but do do redisplay.
   -1 means do not do redisplay, but do do autosaving.
   1 means do both.  */

1244 1245 1246 1247 1248 1249
/* The arguments MAPS and NMAPS are for menu prompting.
   MAPS is an array of keymaps;  NMAPS is the length of MAPS.

   PREV_EVENT is the previous input event, or nil if we are reading
   the first event of a key sequence.

1250 1251 1252
   If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
   if we used a mouse menu to read the input, or zero otherwise.  If
   USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.  */
1253

Jim Blandy's avatar
Jim Blandy committed
1254
Lisp_Object
1255
read_char (commandflag, nmaps, maps, prev_event, used_mouse_menu)
Jim Blandy's avatar
Jim Blandy committed
1256
     int commandflag;
1257 1258 1259 1260
     int nmaps;
     Lisp_Object *maps;
     Lisp_Object prev_event;
     int *used_mouse_menu;
Jim Blandy's avatar
Jim Blandy committed
1261 1262 1263 1264 1265
{
  register Lisp_Object c;
  int count;
  jmp_buf save_jump;

Jim Blandy's avatar
Jim Blandy committed
1266
  if (CONSP (unread_command_events))
Jim Blandy's avatar
Jim Blandy committed
1267
    {
Jim Blandy's avatar
Jim Blandy committed
1268 1269
      c = XCONS (unread_command_events)->car;
      unread_command_events = XCONS (unread_command_events)->cdr;
Jim Blandy's avatar
Jim Blandy committed
1270 1271 1272 1273 1274 1275 1276

      if (this_command_key_count == 0)
	goto reread_first;
      else
	goto reread;
    }

1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287
  if (unread_command_char != -1)
    {
      XSET (c, Lisp_Int, unread_command_char);
      unread_command_char = -1;

      if (this_command_key_count == 0)
	goto reread_first;
      else
	goto reread;
    }

Jim Blandy's avatar
Jim Blandy committed
1288 1289
  if (!NILP (Vexecuting_macro))
    {
1290
#ifdef MULTI_FRAME
1291 1292 1293 1294 1295
      /* We set this to Qmacro; since that's not a frame, nobody will
	 try to switch frames on us, and the selected window will
	 remain unchanged.

         Since this event came from a macro, it would be misleading to
1296 1297 1298 1299 1300 1301
	 leave internal_last_event_frame set to whereever the last
	 real event came from.  Normally, a switch-frame event selects
	 internal_last_event_frame after each command is read, but
	 events read from a macro should never cause a new frame to be
	 selected. */
      Vlast_event_frame = internal_last_event_frame = Qmacro;
1302
#endif
1303

1304 1305 1306 1307 1308
      /* Exit the macro if we are at the end.
	 Also, some things replace the macro with t
	 to force an early exit.  */
      if (EQ (Vexecuting_macro, Qt)
	  || executing_macro_index >= XFASTINT (Flength (Vexecuting_macro)))
Jim Blandy's avatar
Jim Blandy committed
1309 1310 1311 1312 1313 1314
	{
	  XSET (c, Lisp_Int, -1);
	  return c;
	}
      
      c = Faref (Vexecuting_macro, make_number (executing_macro_index));
1315 1316 1317 1318
      if (XTYPE (Vexecuting_macro) == Lisp_String
	  && (XINT (c) & 0x80))
	XFASTINT (c) = CHAR_META | (XINT (c) & ~0x80);

Jim Blandy's avatar
Jim Blandy committed
1319 1320 1321 1322 1323
      executing_macro_index++;

      goto from_macro;
    }

1324 1325 1326 1327 1328 1329
  if (!NILP (unread_switch_frame))
    {
      c = unread_switch_frame;
      unread_switch_frame = Qnil;

      /* This event should make it into this_command_keys, and get echoed
1330 1331
	 again, so we go to reread_first, rather than reread.  */
      goto reread_first;
1332 1333
    }

Jim Blandy's avatar
Jim Blandy committed
1334
  /* Save outer setjmp data, in case called recursively.  */
Jim Blandy's avatar
Jim Blandy committed
1335
  save_getcjmp (save_jump);
Jim Blandy's avatar
Jim Blandy committed
1336 1337 1338 1339 1340 1341 1342 1343 1344

  stop_polling ();

  if (commandflag >= 0 && !input_pending && !detect_input_pending ())
    redisplay ();

  if (_setjmp (getcjmp))
    {
      XSET (c, Lisp_Int, quit_char);
1345
#ifdef MULTI_FRAME
1346 1347
      XSET (internal_last_event_frame, Lisp_Frame, selected_frame);
      Vlast_event_frame = internal_last_event_frame;
1348
#endif
1349 1350 1351 1352
      /* If we report the quit char as an event,
	 don't do so more than once.  */
      if (!NILP (Vinhibit_quit))
	Vquit_flag = Qnil;
Jim Blandy's avatar
Jim Blandy committed
1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371

      goto non_reread;
    }

  /* Message turns off echoing unless more keystrokes turn it on again. */
  if (echo_area_glyphs && *echo_area_glyphs && echo_area_glyphs != echobuf)
    cancel_echoing ();
  else
    /* If already echoing, continue.  */
    echo_dash ();

  /* If in middle of key sequence and minibuffer not active,
     start echoing if enough time elapses.  */
  if (minibuf_level == 0 && !immediate_echo && this_command_key_count > 0
      && echo_keystrokes > 0
      && (echo_area_glyphs == 0 || *echo_area_glyphs == 0))
    {
      Lisp_Object tem0;

1372 1373 1374
      /* After a mouse event, start echoing right away.
	 This is because we are probably about to display a menu,
	 and we don't want to delay before doing so.  */
Jim Blandy's avatar
Jim Blandy committed
1375
      if (EVENT_HAS_PARAMETERS (prev_event))
Jim Blandy's avatar
Jim Blandy committed
1376
	echo ();
1377 1378 1379 1380 1381 1382
      else
	{
	  tem0 = sit_for (echo_keystrokes, 0, 1, 1);
	  if (EQ (tem0, Qt))
	    echo ();
	}
Jim Blandy's avatar
Jim Blandy committed
1383 1384 1385 1386 1387 1388
    }

  /* Maybe auto save due to number of keystrokes or idle time.  */

  if (commandflag != 0
      && auto_save_interval > 0
1389
      && num_nonmacro_input_chars - last_auto_save > max (auto_save_interval, 20)
Jim Blandy's avatar
Jim Blandy committed
1390 1391 1392 1393 1394 1395 1396 1397
      && !detect_input_pending ())
    {
      jmp_buf temp;
      save_getcjmp (temp);
      Fdo_auto_save (Qnil, Qnil);
      restore_getcjmp (temp);
    }

1398 1399 1400 1401 1402 1403 1404 1405
  /* Try reading a character via menu prompting.
     Try this before the sit-for, because the sit-for
     would do the wrong thing if we are supposed to do
     menu prompting.  */
  c = Qnil;
  if (INTERACTIVE && !NILP (prev_event))
    c = read_char_menu_prompt (nmaps, maps, prev_event, used_mouse_menu);

Jim Blandy's avatar
Jim Blandy committed
1406 1407
  /* Slow down auto saves logarithmically in size of current buffer,
     and garbage collect while we're at it.  */
1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423
  if (NILP (c))
    {
      int delay_level, buffer_size;

      if (! MINI_WINDOW_P (XWINDOW (selected_window)))
	last_non_minibuf_size = Z - BEG;
      buffer_size = (last_non_minibuf_size >> 8) + 1;
      delay_level = 0;
      while (buffer_size > 64)
	delay_level++, buffer_size -= buffer_size >> 2;
      if (delay_level < 4) delay_level = 4;
      /* delay_level is 4 for files under around 50k, 7 at 100k,
	 9 at 200k, 11 at 300k, and 12 at 500k.  It is 15 at 1 meg.  */

      /* Auto save if enough time goes by without input.  */
      if (commandflag != 0
1424
	  && num_nonmacro_input_chars > last_auto_save
1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446
	  && XTYPE (Vauto_save_timeout) == Lisp_Int
	  && XINT (Vauto_save_timeout) > 0)
	{
	  Lisp_Object tem0;
	  int delay = delay_level * XFASTINT (Vauto_save_timeout) / 4;
	  tem0 = sit_for (delay, 0, 1, 1);
	  if (EQ (tem0, Qt))
	    {
	      jmp_buf temp;
	      save_getcjmp (temp);
	      Fdo_auto_save (Qnil, Qnil);
	      restore_getcjmp (temp);

	      /* If we have auto-saved and there is still no input
		 available, garbage collect if there has been enough
		 consing going on to make it worthwhile.  */
	      if (!detect_input_pending ()
		  && consing_since_gc > gc_cons_threshold / 2)
		Fgarbage_collect ();
	    }
	}
    }
Jim Blandy's avatar
Jim Blandy committed
1447 1448

  /* Actually read a character, waiting if necessary.  */
1449 1450
  if (NILP (c))
    c = kbd_buffer_get_event ();
Jim Blandy's avatar
Jim Blandy committed
1451 1452 1453 1454 1455

  if (NILP (c))
    abort ();			/* Don't think this can happen. */

  /* Terminate Emacs in batch mode if at eof.  */
1456
  if (noninteractive && XTYPE (c) == Lisp_Int && XINT (c) < 0)
Jim Blandy's avatar
Jim Blandy committed
1457 1458
    Fkill_emacs (make_number (1));