keyboard.c 213 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
#include <stdio.h>
#include "termchar.h"
#include "termopts.h"
#include "lisp.h"
#include "termhooks.h"
#include "macros.h"
Jim Blandy's avatar
Jim Blandy committed
30
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
31 32 33 34
#include "window.h"
#include "commands.h"
#include "buffer.h"
#include "disptab.h"
35
#include "dispextern.h"
Jim Blandy's avatar
Jim Blandy committed
36
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
37
#include "intervals.h"
38
#include "blockinput.h"
Jim Blandy's avatar
Jim Blandy committed
39 40 41
#include <setjmp.h>
#include <errno.h>

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

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

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

59 60 61
/* Include systime.h after xterm.h to avoid double inclusion of time.h. */
#include "systime.h"

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

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

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

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


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

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

97 98 99 100
#ifdef MULTI_KBOARD
KBOARD *initial_kboard;
KBOARD *current_kboard;
KBOARD *all_kboards;
101
int single_kboard;
102
#else
103
KBOARD the_only_kboard;
104
#endif
105

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

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

115 116 117 118 119 120 121
/* 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
122

123 124 125 126 127 128 129 130 131 132 133 134
/* Record values of this_command_key_count and echo_length ()
   before this command was read.  */
static int before_command_key_count;
static int before_command_echo_length;
/* Values of before_command_key_count and before_command_echo_length
   saved by reset-this-command-lengths.  */
static int before_command_key_count_1;
static int before_command_echo_length_1;
/* Flag set by reset-this-command-lengths,
   saying to reset the lengths when add_command_key is called.  */
static int before_command_restore_flag;

Jim Blandy's avatar
Jim Blandy committed
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
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;

154 155 156
/* Nonzero means disregard local maps for the menu bar.  */
static int inhibit_local_menu_bar_menus;

157
/* Nonzero means C-g should cause immediate error-signal.  */
Jim Blandy's avatar
Jim Blandy committed
158 159 160
int immediate_quit;

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

Karl Heuer's avatar
Karl Heuer committed
163 164 165
/* List of other event types to recognize as meaning "help".  */
Lisp_Object Vhelp_event_list;

Jim Blandy's avatar
Jim Blandy committed
166 167 168
/* Form to execute when help char is typed.  */
Lisp_Object Vhelp_form;

169 170 171
/* Command to run when the help character follows a prefix key.  */
Lisp_Object Vprefix_help_command;

172 173
/* List of items that should move to the end of the menu bar.  */
Lisp_Object Vmenu_bar_final_items;
174

175 176 177 178 179 180
/* Non-nil means show the equivalent key-binding for
   any M-x command that has one.
   The value can be a length of time to show the message for.
   If the value is non-nil and not a number, we wait 2 seconds.  */
Lisp_Object Vsuggest_key_bindings;

Jim Blandy's avatar
Jim Blandy committed
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
/* 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;

202 203 204
/* If non-nil, this is a map that overrides all other local maps.  */
Lisp_Object Voverriding_local_map;

205 206 207
/* If non-nil, Voverriding_local_map applies to the menu bar.  */
Lisp_Object Voverriding_local_map_menu_flag;

208 209 210 211
/* Keymap that defines special misc events that should
   be processed immediately at a low level.  */
Lisp_Object Vspecial_event_map;

Jim Blandy's avatar
Jim Blandy committed
212 213 214 215 216 217 218 219 220
/* 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;

221 222 223 224
/* 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
225 226 227
/* Last input character read for any purpose.  */
Lisp_Object last_input_char;

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

231 232 233
/* If not -1, an event to be read as subsequent command input.  */
int unread_command_char;

234 235
/* 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
236
   next command input, after any unread_command_events.
237 238 239 240 241

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

243 244 245
/* A mask of extra modifier bits to put into every keyboard char.  */
int extra_keyboard_modifiers;

Jim Blandy's avatar
Jim Blandy committed
246 247 248 249 250 251 252 253
/* 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;

254
/* Number of idle seconds before an auto-save and garbage collection.  */
Jim Blandy's avatar
Jim Blandy committed
255 256 257 258 259
static Lisp_Object Vauto_save_timeout;

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

260 261 262
/* Total number of times read_char has returned, outside of macros.  */
int num_nonmacro_input_chars;

Jim Blandy's avatar
Jim Blandy committed
263 264 265 266 267
/* Auto-save automatically when this many characters have been typed
   since the last time.  */

static int auto_save_interval;

268
/* Value of num_nonmacro_input_chars as of last auto save.  */
Jim Blandy's avatar
Jim Blandy committed
269 270 271 272

int last_auto_save;

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

277 278 279
/* The value of point when the last command was executed.  */
int last_point_position;

280 281 282
/* The buffer that was current when the last command was started.  */
Lisp_Object last_point_position_buffer;

283 284 285 286 287 288 289 290 291 292 293 294 295 296
#ifdef MULTI_FRAME
/* The frame in which the last input event occurred, or Qmacro if the
   last event came from a macro.  We use this to determine when to
   generate switch-frame events.  This may be cleared by functions
   like Fselect_frame, to make sure that a switch-frame event is
   generated by the next character.  */
Lisp_Object internal_last_event_frame;
#endif

/* A user-visible version of the above, intended to allow users to
   figure out where the last event came from, if the event doesn't
   carry that information itself (i.e. if it was a character).  */
Lisp_Object Vlast_event_frame;

Jim Blandy's avatar
Jim Blandy committed
297 298
/* 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
299 300 301 302 303
unsigned long last_event_timestamp;

Lisp_Object Qself_insert_command;
Lisp_Object Qforward_char;
Lisp_Object Qbackward_char;
304
Lisp_Object Qundefined;
Jim Blandy's avatar
Jim Blandy committed
305 306 307 308 309 310 311 312 313 314 315 316 317 318

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

319 320 321
/* Another keymap that maps key sequences into key sequences.
   This one takes precedence over ordinary definitions.  */
extern Lisp_Object Vkey_translation_map;
322

323 324 325
/* Non-nil means deactivate the mark at end of this command.  */
Lisp_Object Vdeactivate_mark;

326 327 328 329 330
/* Menu bar specified in Lucid Emacs fashion.  */

Lisp_Object Vlucid_menu_bar_dirty_flag;
Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

331
/* Hooks to run before and after each command.  */
332 333
Lisp_Object Qpre_command_hook, Vpre_command_hook;
Lisp_Object Qpost_command_hook, Vpost_command_hook;
334
Lisp_Object Qcommand_hook_internal, Vcommand_hook_internal;
335 336 337 338 339
/* Hook run after a command if there's no more input soon.  */
Lisp_Object Qpost_command_idle_hook, Vpost_command_idle_hook;

/* Delay time in microseconds before running post-command-idle-hook.  */
int post_command_idle_delay;
340

341 342 343 344 345 346
/* 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;
347
Lisp_Object Qdeferred_action_function;
348

Jim Blandy's avatar
Jim Blandy committed
349 350 351 352 353 354
/* File in which we write all commands we read.  */
FILE *dribble;

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

355 356 357
/* 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
358 359 360 361
int meta_key;

extern char *pending_malloc_warning;

362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
/* Circular buffer for pre-read keyboard input.  */
static struct input_event kbd_buffer[KBD_BUFFER_SIZE];

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

   The interrupt-level event handlers will never enqueue an event on a
   frame which is not in Vframe_list, and once an event is dequeued,
   internal_last_event_frame or the event itself points to the frame.
   So that's all fine.

   But while the event is sitting in the queue, it's completely
   unprotected.  Suppose the user types one command which will run for
   a while and then delete a frame, and then types another event at
   the frame that will be deleted, before the command gets around to
   it.  Suppose there are no references to this frame elsewhere in
   Emacs, and a GC occurs before the second event is dequeued.  Now we
   have an event referring to a freed frame, which will crash Emacs
   when it is dequeued.

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

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

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

/* Pointer to next available character in kbd_buffer.
   If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
   This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
   next available char is in kbd_buffer[0].  */
static struct input_event *kbd_fetch_ptr;

/* Pointer to next place to store character in kbd_buffer.  This
   may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
   character should go in kbd_buffer[0].  */
static volatile struct input_event *kbd_store_ptr;

/* The above pair of variables forms a "queue empty" flag.  When we
   enqueue a non-hook event, we increment kbd_store_ptr.  When we
   dequeue a non-hook event, we increment kbd_fetch_ptr.  We say that
   there is input available iff the two pointers are not equal.

   Why not just have a flag set and cleared by the enqueuing and
   dequeuing functions?  Such a flag could be screwed up by interrupts
   at inopportune times.  */

Karl Heuer's avatar
Karl Heuer committed
413
/* If this flag is non-nil, we check mouse_moved to see when the
414 415 416
   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
417 418 419

/* Symbols to head events.  */
Lisp_Object Qmouse_movement;
420
Lisp_Object Qscroll_bar_movement;
421
Lisp_Object Qswitch_frame;
422
Lisp_Object Qdelete_frame;
423 424
Lisp_Object Qiconify_frame;
Lisp_Object Qmake_frame_visible;
425

Jim Blandy's avatar
Jim Blandy committed
426 427 428 429 430 431 432
/* 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;
433
Lisp_Object Qevent_symbol_elements;
Jim Blandy's avatar
Jim Blandy committed
434

435 436
Lisp_Object Qmenu_enable;

437 438 439 440 441 442 443 444 445 446 447 448 449
/* 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;

450
/* Symbols to use for parts of windows.  */
Jim Blandy's avatar
Jim Blandy committed
451
Lisp_Object Qmode_line;
Jim Blandy's avatar
Jim Blandy committed
452
Lisp_Object Qvertical_line;
453
Lisp_Object Qvertical_scroll_bar;
454 455 456
Lisp_Object Qmenu_bar;

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

458 459
Lisp_Object recursive_edit_unwind (), command_loop ();
Lisp_Object Fthis_command_keys ();
460
Lisp_Object Qextended_command_history;
Jim Blandy's avatar
Jim Blandy committed
461

462 463
extern char *x_get_keysym_name ();

464 465
Lisp_Object Qpolling_period;

466 467
extern Lisp_Object Vprint_level, Vprint_length;

Jim Blandy's avatar
Jim Blandy committed
468 469 470
/* 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
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494

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

495 496
/* 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
497 498 499 500 501 502 503 504 505 506 507
#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 ();
508
static int readable_events ();
509 510
static Lisp_Object read_char_x_menu_prompt ();
static Lisp_Object read_char_minibuf_menu_prompt ();
511
static Lisp_Object make_lispy_event ();
512
#ifdef HAVE_MOUSE
513
static Lisp_Object make_lispy_movement ();
514
#endif
515 516
static Lisp_Object modify_event_symbol ();
static Lisp_Object make_lispy_switch_frame ();
517
static int parse_solitary_modifier ();
Jim Blandy's avatar
Jim Blandy committed
518 519 520 521

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

522 523 524 525
/* 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
526 527 528 529 530 531 532 533 534 535 536
#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);
537

538 539
  if (len > ECHOBUFSIZE - 4)
    len = ECHOBUFSIZE - 4;
540 541 542
  bcopy (str, current_kboard->echobuf, len);
  current_kboard->echoptr = current_kboard->echobuf + len;
  *current_kboard->echoptr = '\0';
Jim Blandy's avatar
Jim Blandy committed
543

544
  current_kboard->echo_after_prompt = len;
545

Jim Blandy's avatar
Jim Blandy committed
546 547 548
  echo ();
}

549
/* Add C to the echo string, if echoing is going on.
Jim Blandy's avatar
Jim Blandy committed
550 551 552 553 554 555 556 557
   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 ();

558
  if (current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
559
    {
560
      char *ptr = current_kboard->echoptr;
561

562
      if (ptr != current_kboard->echobuf)
Jim Blandy's avatar
Jim Blandy committed
563 564 565
	*ptr++ = ' ';

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

568
      if (INTEGERP (c))
Jim Blandy's avatar
Jim Blandy committed
569
	{
570
	  if (ptr - current_kboard->echobuf > ECHOBUFSIZE - 6)
Jim Blandy's avatar
Jim Blandy committed
571 572
	    return;

573
	  ptr = push_key_description (XINT (c), ptr);
Jim Blandy's avatar
Jim Blandy committed
574
	}
575
      else if (SYMBOLP (c))
Jim Blandy's avatar
Jim Blandy committed
576 577
	{
	  struct Lisp_String *name = XSYMBOL (c)->name;
578
	  if ((ptr - current_kboard->echobuf) + name->size + 4 > ECHOBUFSIZE)
Jim Blandy's avatar
Jim Blandy committed
579 580 581 582 583
	    return;
	  bcopy (name->data, ptr, name->size);
	  ptr += name->size;
	}

584
      if (current_kboard->echoptr == current_kboard->echobuf
Karl Heuer's avatar
Karl Heuer committed
585
	  && help_char_p (c))
Jim Blandy's avatar
Jim Blandy committed
586 587 588 589 590 591
	{
	  strcpy (ptr, " (Type ? for further options)");
	  ptr += strlen (ptr);
	}

      *ptr = 0;
592
      current_kboard->echoptr = ptr;
Jim Blandy's avatar
Jim Blandy committed
593 594 595 596 597 598 599 600 601 602

      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 ()
{
603 604
  if (!current_kboard->immediate_echo
      && current_kboard->echoptr == current_kboard->echobuf)
Jim Blandy's avatar
Jim Blandy committed
605
    return;
606
  /* Do nothing if we just printed a prompt.  */
607 608
  if (current_kboard->echo_after_prompt
      == current_kboard->echoptr - current_kboard->echobuf)
609
    return;
610
  /* Do nothing if not echoing at all.  */
611
  if (current_kboard->echoptr == 0)
612
    return;
Jim Blandy's avatar
Jim Blandy committed
613 614 615

  /* Put a dash at the end of the buffer temporarily,
     but make it go away when the next character is added.  */
616 617
  current_kboard->echoptr[0] = '-';
  current_kboard->echoptr[1] = 0;
Jim Blandy's avatar
Jim Blandy committed
618 619 620 621 622 623 624 625 626

  echo ();
}

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

echo ()
{
627
  if (!current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
628 629
    {
      int i;
630
      current_kboard->immediate_echo = 1;
Jim Blandy's avatar
Jim Blandy committed
631 632

      for (i = 0; i < this_command_key_count; i++)
633 634 635 636 637 638 639
	{
	  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
640 641 642 643
      echo_dash ();
    }

  echoing = 1;
644
  message1_nolog (current_kboard->echobuf);
Jim Blandy's avatar
Jim Blandy committed
645 646 647 648 649 650 651 652 653 654
  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 ()
{
655 656 657
  current_kboard->immediate_echo = 0;
  current_kboard->echoptr = current_kboard->echobuf;
  current_kboard->echo_after_prompt = -1;
Jim Blandy's avatar
Jim Blandy committed
658 659 660 661 662 663 664
}

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

static int
echo_length ()
{
665
  return current_kboard->echoptr - current_kboard->echobuf;
Jim Blandy's avatar
Jim Blandy committed
666 667 668 669
}

/* 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
670
   switches frames while entering a key sequence.  */
Jim Blandy's avatar
Jim Blandy committed
671 672 673 674 675

static void
echo_truncate (len)
     int len;
{
676 677
  current_kboard->echobuf[len] = '\0';
  current_kboard->echoptr = current_kboard->echobuf + len;
678
  truncate_echo_area (len);
Jim Blandy's avatar
Jim Blandy committed
679 680 681 682 683 684 685 686
}

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

689 690 691 692 693 694 695 696 697
  /* If reset-this-command-length was called recently, obey it now.
     See the doc string of that function for an explanation of why.  */
  if (before_command_restore_flag)
    {
      this_command_key_count = before_command_key_count_1;
      echo_truncate (before_command_echo_length_1);
      before_command_restore_flag = 0;
    }

698
  if (this_command_key_count >= size)
Jim Blandy's avatar
Jim Blandy committed
699
    {
700
      Lisp_Object new_keys;
701

702
      new_keys = Fmake_vector (make_number (size * 2), Qnil);
703 704
      bcopy (XVECTOR (this_command_keys)->contents,
	     XVECTOR (new_keys)->contents,
705
	     size * sizeof (Lisp_Object));
706 707

      this_command_keys = new_keys;
Jim Blandy's avatar
Jim Blandy committed
708
    }
709 710

  XVECTOR (this_command_keys)->contents[this_command_key_count++] = key;
Jim Blandy's avatar
Jim Blandy committed
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728
}

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);

729
  return unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
730 731 732
}

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

Jim Blandy's avatar
Jim Blandy committed
734 735
record_auto_save ()
{
736
  last_auto_save = num_nonmacro_input_chars;
Jim Blandy's avatar
Jim Blandy committed
737
}
738 739 740 741 742 743

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

force_auto_save_soon ()
{
  last_auto_save = - auto_save_interval - 1;
744 745

  record_asynch_buffer_change ();
746
}
Jim Blandy's avatar
Jim Blandy committed
747 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

DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
  "Invoke the editor command loop recursively.\n\
To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
that tells this function to return.\n\
Alternately, `(throw 'exit t)' makes this function signal an error.\n\
This function is called by the editor initialization to begin editing.")
  ()
{
  int count = specpdl_ptr - specpdl;
  Lisp_Object val;

  command_loop_level++;
  update_mode_lines = 1;

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

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

  command_loop_level--;
  update_mode_lines = 1;
  return Qnil;
}

Karl Heuer's avatar
Karl Heuer committed
783
static void
784
any_kboard_state ()
Karl Heuer's avatar
Karl Heuer committed
785
{
786 787 788 789 790
#ifdef MULTI_KBOARD
#if 0 /* Theory: if there's anything in Vunread_command_events,
	 it will right away be read by read_key_sequence,
	 and then if we do switch KBOARDS, it will go into the side
	 queue then.  So we don't need to do anything special here -- rms.  */
Karl Heuer's avatar
Karl Heuer committed
791
  if (CONSP (Vunread_command_events))
792
    {
793 794 795
      current_kboard->kbd_queue
	= nconc2 (Vunread_command_events, current_kboard->kbd_queue);
      current_kboard->kbd_queue_has_data = 1;
796
    }
Karl Heuer's avatar
Karl Heuer committed
797
  Vunread_command_events = Qnil;
798 799 800
#endif
  single_kboard = 0;
#endif
Karl Heuer's avatar
Karl Heuer committed
801
}
802 803 804 805 806 807 808 809 810

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

void
single_kboard_state ()
{
#ifdef MULTI_KBOARD
  single_kboard = 1;
Karl Heuer's avatar
Karl Heuer committed
811
#endif
812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829
}

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

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

static struct kboard_stack *kboard_stack;

void
push_frame_kboard (f)
     FRAME_PTR f;
{
830
#ifdef MULTI_KBOARD
831 832 833 834 835 836 837 838
  struct kboard_stack *p
    = (struct kboard_stack *) xmalloc (sizeof (struct kboard_stack));

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

  current_kboard = FRAME_KBOARD (f);
839
#endif
840 841 842 843 844
}

void
pop_frame_kboard ()
{
845
#ifdef MULTI_KBOARD
846 847 848 849
  struct kboard_stack *p = kboard_stack;
  current_kboard = p->kboard;
  kboard_stack = p->next;
  xfree (p);
850
#endif
851 852 853 854
}

/* Handle errors that are not handled at inner levels
   by printing an error message and returning to the editor command loop.  */
Karl Heuer's avatar
Karl Heuer committed
855

Jim Blandy's avatar
Jim Blandy committed
856 857 858
Lisp_Object
cmd_error (data)
     Lisp_Object data;
859
{
860 861
  Lisp_Object old_level, old_length;

862 863 864
  Vstandard_output = Qt;
  Vstandard_input = Qt;
  Vexecuting_macro = Qnil;
865
  current_kboard->Vprefix_arg = Qnil;
866
  cancel_echoing ();
867 868 869 870 871 872

  /* Avoid unquittable loop if data contains a circular list.  */
  old_level = Vprint_level;
  old_length = Vprint_length;
  XSETFASTINT(Vprint_level, 10);
  XSETFASTINT(Vprint_length, 10);
873
  cmd_error_internal (data, NULL);
874 875
  Vprint_level = old_level;
  Vprint_length = old_length;
876 877 878 879

  Vquit_flag = Qnil;

  Vinhibit_quit = Qnil;
880
#ifdef MULTI_KBOARD
881
  any_kboard_state ();
882
#endif
883 884 885 886 887 888 889

  return make_number (0);
}

cmd_error_internal (data, context)
     Lisp_Object data;
     char *context;
Jim Blandy's avatar
Jim Blandy committed
890 891 892 893 894 895 896 897 898 899
{
  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
900
  /* If the window system or terminal frame hasn't been initialized
Jim Blandy's avatar
Jim Blandy committed
901 902
     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
903
  if (! FRAME_MESSAGE_BUF (selected_frame)
Jim Blandy's avatar
Jim Blandy committed
904 905 906 907 908 909 910 911 912
      || noninteractive)
    stream = Qexternal_debugging_output;
  else
    {
      Fdiscard_input ();
      bitch_at_user ();
      stream = Qt;
    }

913 914 915
  if (context != 0)
    write_string_1 (context, -1, stream);

Jim Blandy's avatar
Jim Blandy committed
916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944
  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;

945
  if (STRINGP (errmsg))
Jim Blandy's avatar
Jim Blandy committed
946 947 948 949 950 951 952 953 954 955 956 957 958 959
    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
960
  /* If the window system or terminal frame hasn't been initialized
Jim Blandy's avatar
Jim Blandy committed
961
     yet, or we're in -batch mode, this error should cause Emacs to exit.  */
Jim Blandy's avatar
Jim Blandy committed
962
  if (! FRAME_MESSAGE_BUF (selected_frame)
Jim Blandy's avatar
Jim Blandy committed
963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989
      || 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);
990

Jim Blandy's avatar
Jim Blandy committed
991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
	/* 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 ();
1066
void safe_run_hooks ();
Jim Blandy's avatar
Jim Blandy committed
1067 1068 1069 1070

Lisp_Object
command_loop_1 ()
{
1071
  Lisp_Object cmd, tem;
Jim Blandy's avatar
Jim Blandy committed
1072 1073 1074 1075 1076 1077
  int lose;
  int nonundocount;
  Lisp_Object keybuf[30];
  int i;
  int no_redisplay;
  int no_direct;
1078 1079
  int prev_modiff;
  struct buffer *prev_buffer;
1080
#ifdef MULTI_KBOARD
1081
  int was_locked = single_kboard;
1082
#endif
Jim Blandy's avatar
Jim Blandy committed
1083

1084
  current_kboard->Vprefix_arg = Qnil;
1085
  Vdeactivate_mark = Qnil;
Jim Blandy's avatar
Jim Blandy committed
1086
  waiting_for_input = 0;
1087
  cancel_echoing ();
Jim Blandy's avatar
Jim Blandy committed
1088 1089 1090 1091 1092

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

1093 1094
  /* Make sure this hook runs after commands that get errors and
     throw to top level.  */
1095 1096 1097 1098
  /* 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);
1099

1100 1101 1102
  if (!NILP (Vdeferred_action_list))
    call0 (Vdeferred_action_function);

1103 1104 1105 1106 1107 1108 1109 1110
  if (!NILP (XSYMBOL (Qpost_command_idle_hook)->value) && !NILP (Vrun_hooks))
    {
      if (NILP (Vunread_command_events)
	  && NILP (Vexecuting_macro)
	  && !NILP (sit_for (0, post_command_idle_delay, 0, 1)))
	safe_run_hooks (Qpost_command_idle_hook);
    }

1111
  /* Do this after running Vpost_command_hook, for consistency.  */
1112
  current_kboard->Vlast_command = this_command;
1113

Jim Blandy's avatar
Jim Blandy committed
1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127
  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;

1128 1129
      Vdeactivate_mark = Qnil;

Jim Blandy's avatar
Jim Blandy committed
1130
      /* If minibuffer on and echo area in use,
1131
	 wait 2 sec and redraw minibuffer.  */
Jim Blandy's avatar
Jim Blandy committed
1132

1133 1134
      if (minibuf_level && echo_area_glyphs
	  && EQ (minibuf_window, echo_area_window))
Jim Blandy's avatar
Jim Blandy committed
1135
	{
1136 1137 1138 1139
	  /* 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
1140
	  Fsit_for (make_number (2), Qnil, Qnil);
1141
	  unbind_to (count, Qnil);
1142

Jim Blandy's avatar
Jim Blandy committed
1143 1144 1145 1146 1147
	  echo_area_glyphs = 0;
	  no_direct = 1;
	  if (!NILP (Vquit_flag))
	    {
	      Vquit_flag = Qnil;
1148
	      Vunread_command_events = Fcons (make_number (quit_char), Qnil);
Jim Blandy's avatar
Jim Blandy committed
1149 1150 1151 1152
	    }
	}

#ifdef C_ALLOCA
1153
      alloca (0);		/* Cause a garbage collection now */
Jim Blandy's avatar
Jim Blandy committed
1154 1155 1156
				/* Since we can free the most stuff here.  */
#endif /* C_ALLOCA */

1157
#if 0
Jim Blandy's avatar
Jim Blandy committed
1158
#ifdef MULTI_FRAME
1159 1160 1161 1162
      /* 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?  */
1163
      if (FRAMEP (internal_last_event_frame)
1164 1165
	  && XFRAME (internal_last_event_frame) != selected_frame)
	Fselect_frame (internal_last_event_frame, Qnil);
1166
#endif
Jim Blandy's avatar
Jim Blandy committed
1167
#endif
1168 1169
      /* If it has changed current-menubar from previous value,
	 really recompute the menubar from the value.  */
1170 1171
      if (! NILP (Vlucid_menu_bar_dirty_flag)
	  && !NILP (Ffboundp (Qrecompute_lucid_menubar)))
1172 1173
	call0 (Qrecompute_lucid_menubar);

1174 1175 1176
      before_command_key_count = this_command_key_count;
      before_command_echo_length = echo_length ();

1177 1178
      this_command = Qnil;

1179
      /* Read next key sequence; i gets its length.  */
1180 1181
      i = read_key_sequence (keybuf, sizeof keybuf / sizeof keybuf[0],
			     Qnil, 0, 1);
1182 1183 1184

      ++num_input_keys;

Jim Blandy's avatar
Jim Blandy committed
1185 1186 1187 1188 1189
      /* 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.  */
Richard M. Stallman's avatar