keyboard.c 370 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Keyboard and mouse input; editor command loop.
2 3

Copyright (C) 1985-1989, 1993-1997, 1999-2011  Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6

This file is part of GNU Emacs.

7
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
8
it under the terms of the GNU General Public License as published by
9 10
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17

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
18
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
19

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

47 48 49
#ifdef HAVE_GTK_AND_PTHREAD
#include <pthread.h>
#endif
50 51 52 53
#ifdef MSDOS
#include "msdos.h"
#include <time.h>
#else /* not MSDOS */
Jim Blandy's avatar
Jim Blandy committed
54
#include <sys/ioctl.h>
55
#endif /* not MSDOS */
Jim Blandy's avatar
Jim Blandy committed
56

Jim Blandy's avatar
Jim Blandy committed
57 58
#include "syssignal.h"

59 60
#include <sys/types.h>
#include <unistd.h>
61 62
#include <fcntl.h>

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

68 69 70 71
#ifdef HAVE_NTGUI
#include "w32term.h"
#endif /* HAVE_NTGUI */

72 73 74 75
#ifdef HAVE_NS
#include "nsterm.h"
#endif

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

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

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

Chong Yidong's avatar
Chong Yidong committed
85 86 87 88 89
/* This var should be (interrupt_input_pending || pending_atimers).
   The QUIT macro checks this instead of interrupt_input_pending and
   pending_atimers separately, to reduce code size.  So, any code that
   changes interrupt_input_pending or pending_atimers should update
   this too.  */
90
#ifdef SYNC_INPUT
Chong Yidong's avatar
Chong Yidong committed
91
int pending_signals;
92
#endif
Chong Yidong's avatar
Chong Yidong committed
93

94
#define KBD_BUFFER_SIZE 4096
Jim Blandy's avatar
Jim Blandy committed
95

96 97 98
KBOARD *initial_kboard;
KBOARD *current_kboard;
KBOARD *all_kboards;
99 100 101

/* Nonzero in the single-kboard state, 0 in the any-kboard state.  */
static int single_kboard;
102

Jim Blandy's avatar
Jim Blandy committed
103
/* Non-nil disable property on a command means
104
   do not execute it; call disabled-command-function's value instead.  */
105 106
Lisp_Object Qdisabled;
static Lisp_Object Qdisabled_command_function;
Jim Blandy's avatar
Jim Blandy committed
107

108
#define NUM_RECENT_KEYS (300)
109 110 111 112 113 114 115 116 117

/* Index for storing next element into recent_keys.  */
static int recent_keys_index;

/* Total number of elements stored into recent_keys.  */
static int total_keys;

/* This vector holds the last NUM_RECENT_KEYS keystrokes.  */
static Lisp_Object recent_keys;
Jim Blandy's avatar
Jim Blandy committed
118

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

127 128
/* 1 after calling Freset_this_command_lengths.
   Usually it is 0.  */
129
static int this_command_key_count_reset;
130

131 132
/* This vector is used as a buffer to record the events that were actually read
   by read_key_sequence.  */
133 134
static Lisp_Object raw_keybuf;
static int raw_keybuf_count;
135 136

#define GROW_RAW_KEYBUF							\
137
 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size)			\
138
   raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil)  \
139

140 141
/* Number of elements of this_command_keys
   that precede this key sequence.  */
142
static int this_single_command_key_start;
143

144 145 146 147 148
/* 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;

Jim Blandy's avatar
Jim Blandy committed
149
/* For longjmp to where kbd input is being done.  */
150

Jim Blandy's avatar
Jim Blandy committed
151 152 153 154 155 156
static jmp_buf getcjmp;

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

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

158
static int echoing;
Jim Blandy's avatar
Jim Blandy committed
159

160 161 162 163 164
/* Non-null means we can start echoing at the next input pause even
   though there is something in the echo area.  */

static struct kboard *ok_to_echo_at_next_pause;

165 166 167 168
/* The kboard last echoing, or null for none.  Reset to 0 in
   cancel_echoing.  If non-null, and a current echo area message
   exists, and echo_message_buffer is eq to the current message
   buffer, we know that the message comes from echo_kboard.  */
169

170
struct kboard *echo_kboard;
171

172 173 174
/* The buffer used for echoing.  Set in echo_now, reset in
   cancel_echoing.  */

175
Lisp_Object echo_message_buffer;
176

177
/* Nonzero means C-g should cause immediate error-signal.  */
Jim Blandy's avatar
Jim Blandy committed
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
int immediate_quit;

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

/* Current depth in recursive edits.  */
int command_loop_level;

201 202
/* 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
203
   next command input, after any unread_command_events.
204 205 206 207 208

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

Jim Blandy's avatar
Jim Blandy committed
210
/* Last size recorded for a current buffer which is not a minibuffer.  */
211
static EMACS_INT last_non_minibuf_size;
Jim Blandy's avatar
Jim Blandy committed
212

213 214
/* Total number of times read_char has returned, modulo SIZE_MAX + 1.  */
size_t num_input_events;
Jim Blandy's avatar
Jim Blandy committed
215

216
/* Value of num_nonmacro_input_events as of last auto save.  */
Jim Blandy's avatar
Jim Blandy committed
217

218
static int last_auto_save;
Jim Blandy's avatar
Jim Blandy committed
219

220 221
/* This is like Vthis_command, except that commands never set it.  */
Lisp_Object real_this_command;
Jim Blandy's avatar
Jim Blandy committed
222

223
/* The value of point when the last command was started.  */
224
static EMACS_INT last_point_position;
225

226
/* The buffer that was current when the last command was started.  */
227
static Lisp_Object last_point_position_buffer;
228

229
/* The window that was selected when the last command was started.  */
230
static Lisp_Object last_point_position_window;
231

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

Jim Blandy's avatar
Jim Blandy committed
239 240
/* 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
241 242
unsigned long last_event_timestamp;

243 244
static Lisp_Object Qx_set_selection, Qhandle_switch_frame;
Lisp_Object QPRIMARY;
245

246 247 248 249 250
static Lisp_Object Qself_insert_command;
static Lisp_Object Qforward_char;
static Lisp_Object Qbackward_char;
static Lisp_Object Qundefined;
static Lisp_Object Qtimer_event_handler;
Jim Blandy's avatar
Jim Blandy committed
251 252 253

/* read_key_sequence stores here the command definition of the
   key sequence that it reads.  */
254
static Lisp_Object read_key_sequence_cmd;
Jim Blandy's avatar
Jim Blandy committed
255

256
static Lisp_Object Qinput_method_function;
257

258
static Lisp_Object Qdeactivate_mark;
259

260 261
Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

262
static Lisp_Object Qecho_area_clear_hook;
263

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

268
static Lisp_Object Qdeferred_action_function;
269

270 271
static Lisp_Object Qinput_method_exit_on_first_char;
static Lisp_Object Qinput_method_use_echo_area;
272

273
static Lisp_Object Qhelp_form_show;
274

Jim Blandy's avatar
Jim Blandy committed
275
/* File in which we write all commands we read.  */
276
static FILE *dribble;
Jim Blandy's avatar
Jim Blandy committed
277 278 279 280

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

281
/* Circular buffer for pre-read keyboard input.  */
282

283 284 285 286
static struct input_event kbd_buffer[KBD_BUFFER_SIZE];

/* Pointer to next available character in kbd_buffer.
   If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
287
   This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
288 289 290 291 292 293
   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].  */
294
static struct input_event * volatile kbd_store_ptr;
295 296 297 298

/* 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
Glenn Morris's avatar
Glenn Morris committed
299
   there is input available if the two pointers are not equal.
300 301 302 303 304

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

Jim Blandy's avatar
Jim Blandy committed
305
/* Symbols to head events.  */
306 307
static Lisp_Object Qmouse_movement;
static Lisp_Object Qscroll_bar_movement;
308
Lisp_Object Qswitch_frame;
309 310 311 312
static Lisp_Object Qdelete_frame;
static Lisp_Object Qiconify_frame;
static Lisp_Object Qmake_frame_visible;
static Lisp_Object Qselect_window;
313
Lisp_Object Qhelp_echo;
314

Nick Roberts's avatar
Nick Roberts committed
315
#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
316
static Lisp_Object Qmouse_fixup_help_message;
317 318
#endif

Jim Blandy's avatar
Jim Blandy committed
319
/* Symbols to denote kinds of events.  */
320
static Lisp_Object Qfunction_key;
Jim Blandy's avatar
Jim Blandy committed
321
Lisp_Object Qmouse_click;
322
#if defined (WINDOWSNT)
323
Lisp_Object Qlanguage_change;
324
#endif
325 326
static Lisp_Object Qdrag_n_drop;
static Lisp_Object Qsave_session;
327
#ifdef HAVE_DBUS
328
static Lisp_Object Qdbus_event;
329
#endif
330
static Lisp_Object Qconfig_changed_event;
331

Jim Blandy's avatar
Jim Blandy committed
332 333 334 335
/* Lisp_Object Qmouse_movement; - also an event header */

/* Properties of event headers.  */
Lisp_Object Qevent_kind;
336
static Lisp_Object Qevent_symbol_elements;
Jim Blandy's avatar
Jim Blandy committed
337

338
/* menu and tool bar item parts */
339 340 341 342 343 344 345 346 347 348
static Lisp_Object Qmenu_enable;
static Lisp_Object QCenable, QCvisible, QChelp, QCkeys, QCkey_sequence;
Lisp_Object QCfilter;

/* Non-nil disable property on a command means
   do not execute it; call disabled-command-function's value instead.  */
Lisp_Object QCtoggle, QCradio;
static Lisp_Object QCbutton, QClabel;

static Lisp_Object QCvert_only;
349

350 351 352 353 354 355 356 357 358 359 360
/* 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.  */
361
static Lisp_Object Qmodifier_cache;
362

363
/* Symbols to use for parts of windows.  */
Jim Blandy's avatar
Jim Blandy committed
364
Lisp_Object Qmode_line;
Jim Blandy's avatar
Jim Blandy committed
365
Lisp_Object Qvertical_line;
366
static Lisp_Object Qvertical_scroll_bar;
367 368
Lisp_Object Qmenu_bar;

369 370
static Lisp_Object recursive_edit_unwind (Lisp_Object buffer);
static Lisp_Object command_loop (void);
371
static Lisp_Object Qextended_command_history;
372
EMACS_TIME timer_check (void);
Jim Blandy's avatar
Jim Blandy committed
373

374
static void record_menu_key (Lisp_Object c);
375
static void echo_now (void);
376
static int echo_length (void);
377

378
static Lisp_Object Qpolling_period;
379

380 381 382
/* Incremented whenever a timer is run.  */
int timers_run;

Jim Blandy's avatar
Jim Blandy committed
383 384 385
/* 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
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400

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

/* 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.  */
Steven Tamm's avatar
Steven Tamm committed
401
#if !defined (FIONREAD)
Jim Blandy's avatar
Jim Blandy committed
402 403 404 405 406
#ifdef SIGIO
#undef SIGIO
#endif
#endif

407
/* If we support a window system, turn on the code to poll periodically
408
   to detect C-g.  It isn't actually used when doing interrupt input.  */
Andrew Choi's avatar
In src:  
Andrew Choi committed
409
#if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
Jim Blandy's avatar
Jim Blandy committed
410 411
#define POLL_FOR_INPUT
#endif
412

413 414 415 416
/* The time when Emacs started being idle.  */

static EMACS_TIME timer_idleness_start_time;

417 418 419 420 421
/* After Emacs stops being idle, this saves the last value
   of timer_idleness_start_time from when it was idle.  */

static EMACS_TIME timer_last_idleness_start_time;

Jim Blandy's avatar
Jim Blandy committed
422 423 424

/* Global variable declarations.  */

425 426 427 428 429
/* Flags for readable_events.  */
#define READABLE_EVENTS_DO_TIMERS_NOW		(1 << 0)
#define READABLE_EVENTS_FILTER_EVENTS		(1 << 1)
#define READABLE_EVENTS_IGNORE_SQUEEZABLES	(1 << 2)

Jim Blandy's avatar
Jim Blandy committed
430
/* Function for init_keyboard to call with no args (if nonzero).  */
431
static void (*keyboard_init_hook) (void);
Jim Blandy's avatar
Jim Blandy committed
432

433 434 435 436 437 438 439 440
static int read_avail_input (int);
static void get_input_pending (int *, int);
static int readable_events (int);
static Lisp_Object read_char_x_menu_prompt (int, Lisp_Object *,
                                            Lisp_Object, int *);
static Lisp_Object read_char_minibuf_menu_prompt (int, int,
                                                  Lisp_Object *);
static Lisp_Object make_lispy_event (struct input_event *);
Nick Roberts's avatar
Nick Roberts committed
441
#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
442 443 444 445
static Lisp_Object make_lispy_movement (struct frame *, Lisp_Object,
                                        enum scroll_bar_part,
                                        Lisp_Object, Lisp_Object,
                                        unsigned long);
446
#endif
447
static Lisp_Object modify_event_symbol (EMACS_INT, unsigned, Lisp_Object,
448
                                        Lisp_Object, const char *const *,
449 450
                                        Lisp_Object *, unsigned);
static Lisp_Object make_lispy_switch_frame (Lisp_Object);
451
static int help_char_p (Lisp_Object);
452 453 454 455 456
static void save_getcjmp (jmp_buf);
static void restore_getcjmp (jmp_buf);
static Lisp_Object apply_modifiers (int, Lisp_Object);
static void clear_event (struct input_event *);
static Lisp_Object restore_kboard_configuration (Lisp_Object);
457
static void interrupt_signal (int signalnum);
458
#ifdef SIGIO
459
static void input_available_signal (int signo);
460
#endif
461 462
static Lisp_Object (Fcommand_execute) (Lisp_Object, Lisp_Object, Lisp_Object,
				       Lisp_Object);
463
static void handle_interrupt (void);
464
static void quit_throw_to_read_char (void) NO_RETURN;
465 466 467
static void timer_start_idle (void);
static void timer_stop_idle (void);
static void timer_resume_idle (void);
468
static void handle_user_signal (int);
469 470
static char *find_user_signal_name (int);
static int store_user_signal_events (void);
Jim Blandy's avatar
Jim Blandy committed
471

472

473
/* Add C to the echo string, if echoing is going on.
Jim Blandy's avatar
Jim Blandy committed
474 475 476
   C can be a character, which is printed prettily ("M-C-x" and all that
   jazz), or a symbol, whose name is printed.  */

477
static void
478
echo_char (Lisp_Object c)
Jim Blandy's avatar
Jim Blandy committed
479
{
480
  if (current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
481
    {
482 483 484 485
      int size = KEY_DESCRIPTION_SIZE + 100;
      char *buffer = (char *) alloca (size);
      char *ptr = buffer;
      Lisp_Object echo_string;
Jim Blandy's avatar
Jim Blandy committed
486

487
      echo_string = KVAR (current_kboard, echo_string);
Juanma Barranquero's avatar
Juanma Barranquero committed
488

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

492
      if (INTEGERP (c))
Jim Blandy's avatar
Jim Blandy committed
493
	{
494
	  ptr = push_key_description (XINT (c), ptr, 1);
Jim Blandy's avatar
Jim Blandy committed
495
	}
496
      else if (SYMBOLP (c))
Jim Blandy's avatar
Jim Blandy committed
497
	{
498 499
	  Lisp_Object name = SYMBOL_NAME (c);
	  int nbytes = SBYTES (name);
Juanma Barranquero's avatar
Juanma Barranquero committed
500

501
	  if (size - (ptr - buffer) < nbytes)
502 503
	    {
	      int offset = ptr - buffer;
504
	      size = max (2 * size, size + nbytes);
505 506 507 508
	      buffer = (char *) alloca (size);
	      ptr = buffer + offset;
	    }

509
	  ptr += copy_text (SDATA (name), (unsigned char *) ptr, nbytes,
510
			    STRING_MULTIBYTE (name), 1);
Jim Blandy's avatar
Jim Blandy committed
511 512
	}

513
      if ((NILP (echo_string) || SCHARS (echo_string) == 0)
Karl Heuer's avatar
Karl Heuer committed
514
	  && help_char_p (c))
Jim Blandy's avatar
Jim Blandy committed
515
	{
516 517
	  const char *text = " (Type ? for further options)";
	  int len = strlen (text);
Juanma Barranquero's avatar
Juanma Barranquero committed
518

519 520 521 522 523 524 525 526
	  if (size - (ptr - buffer) < len)
	    {
	      int offset = ptr - buffer;
	      size += len;
	      buffer = (char *) alloca (size);
	      ptr = buffer + offset;
	    }

527
	  memcpy (ptr, text, len);
528
	  ptr += len;
Jim Blandy's avatar
Jim Blandy committed
529 530
	}

531 532
      /* Replace a dash from echo_dash with a space, otherwise
	 add a space at the end as a separator between keys.  */
533
      if (STRINGP (echo_string)
534
	  && SCHARS (echo_string) > 1)
535
	{
536 537 538 539
	  Lisp_Object last_char, prev_char, idx;

	  idx = make_number (SCHARS (echo_string) - 2);
	  prev_char = Faref (echo_string, idx);
540 541 542 543

	  idx = make_number (SCHARS (echo_string) - 1);
	  last_char = Faref (echo_string, idx);

544 545 546
	  /* We test PREV_CHAR to make sure this isn't the echoing
	     of a minus-sign.  */
	  if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
547 548 549 550
	    Faset (echo_string, idx, make_number (' '));
	  else
	    echo_string = concat2 (echo_string, build_string (" "));
	}
551 552
      else if (STRINGP (echo_string))
	echo_string = concat2 (echo_string, build_string (" "));
553

554
      KVAR (current_kboard, echo_string)
555
	= concat2 (echo_string, make_string (buffer, ptr - buffer));
Jim Blandy's avatar
Jim Blandy committed
556

557
      echo_now ();
Jim Blandy's avatar
Jim Blandy committed
558 559 560 561 562 563
    }
}

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

564
static void
565
echo_dash (void)
Jim Blandy's avatar
Jim Blandy committed
566
{
567
  /* Do nothing if not echoing at all.  */
568
  if (NILP (KVAR (current_kboard, echo_string)))
569 570
    return;

571 572 573
  if (this_command_key_count == 0)
    return;

574
  if (!current_kboard->immediate_echo
575
      && SCHARS (KVAR (current_kboard, echo_string)) == 0)
Jim Blandy's avatar
Jim Blandy committed
576
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
577

578
  /* Do nothing if we just printed a prompt.  */
579
  if (current_kboard->echo_after_prompt
580
      == SCHARS (KVAR (current_kboard, echo_string)))
581
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
582

583
  /* Do nothing if we have already put a dash at the end.  */
584
  if (SCHARS (KVAR (current_kboard, echo_string)) > 1)
585
    {
586
      Lisp_Object last_char, prev_char, idx;
587

588 589
      idx = make_number (SCHARS (KVAR (current_kboard, echo_string)) - 2);
      prev_char = Faref (KVAR (current_kboard, echo_string), idx);
590

591 592
      idx = make_number (SCHARS (KVAR (current_kboard, echo_string)) - 1);
      last_char = Faref (KVAR (current_kboard, echo_string), idx);
593

594 595
      if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
	return;
596 597
    }

Jim Blandy's avatar
Jim Blandy committed
598 599
  /* Put a dash at the end of the buffer temporarily,
     but make it go away when the next character is added.  */
600
  KVAR (current_kboard, echo_string) = concat2 (KVAR (current_kboard, echo_string),
601
					 build_string ("-"));
602
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
603 604 605 606 607
}

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

608
static void
609
echo_now (void)
Jim Blandy's avatar
Jim Blandy committed
610
{
611
  if (!current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
612 613
    {
      int i;
614
      current_kboard->immediate_echo = 1;
Jim Blandy's avatar
Jim Blandy committed
615 616

      for (i = 0; i < this_command_key_count; i++)
617 618
	{
	  Lisp_Object c;
619 620 621 622 623 624 625

	  /* Set before_command_echo_length to the value that would
	     have been saved before the start of this subcommand in
	     command_loop_1, if we had already been echoing then.  */
	  if (i == this_single_command_key_start)
	    before_command_echo_length = echo_length ();

626 627 628 629 630
	  c = XVECTOR (this_command_keys)->contents[i];
	  if (! (EVENT_HAS_PARAMETERS (c)
		 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
	    echo_char (c);
	}
631 632 633 634 635 636 637 638

      /* Set before_command_echo_length to the value that would
	 have been saved before the start of this subcommand in
	 command_loop_1, if we had already been echoing then.  */
      if (this_command_key_count == this_single_command_key_start)
	before_command_echo_length = echo_length ();

      /* Put a dash at the end to invite the user to type more.  */
Jim Blandy's avatar
Jim Blandy committed
639 640 641 642
      echo_dash ();
    }

  echoing = 1;
643 644 645
  message3_nolog (KVAR (current_kboard, echo_string),
		  SBYTES (KVAR (current_kboard, echo_string)),
		  STRING_MULTIBYTE (KVAR (current_kboard, echo_string)));
Jim Blandy's avatar
Jim Blandy committed
646 647
  echoing = 0;

648 649 650 651
  /* Record in what buffer we echoed, and from which kboard.  */
  echo_message_buffer = echo_area_buffer[0];
  echo_kboard = current_kboard;

Jim Blandy's avatar
Jim Blandy committed
652 653 654 655 656 657
  if (waiting_for_input && !NILP (Vquit_flag))
    quit_throw_to_read_char ();
}

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

Andreas Schwab's avatar
Andreas Schwab committed
658
void
659
cancel_echoing (void)
Jim Blandy's avatar
Jim Blandy committed
660
{
661 662
  current_kboard->immediate_echo = 0;
  current_kboard->echo_after_prompt = -1;
663
  KVAR (current_kboard, echo_string) = Qnil;
664 665 666
  ok_to_echo_at_next_pause = NULL;
  echo_kboard = NULL;
  echo_message_buffer = Qnil;
Jim Blandy's avatar
Jim Blandy committed
667 668 669 670 671
}

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

static int
672
echo_length (void)
Jim Blandy's avatar
Jim Blandy committed
673
{
674 675
  return (STRINGP (KVAR (current_kboard, echo_string))
	  ? SCHARS (KVAR (current_kboard, echo_string))
676
	  : 0);
Jim Blandy's avatar
Jim Blandy committed
677 678 679 680
}

/* 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
681
   switches frames while entering a key sequence.  */
Jim Blandy's avatar
Jim Blandy committed
682 683

static void
684
echo_truncate (EMACS_INT nchars)
685
{
686 687 688
  if (STRINGP (KVAR (current_kboard, echo_string)))
    KVAR (current_kboard, echo_string)
      = Fsubstring (KVAR (current_kboard, echo_string),
689 690
		    make_number (0), make_number (nchars));
  truncate_echo_area (nchars);
Jim Blandy's avatar
Jim Blandy committed
691 692 693 694 695
}


/* Functions for manipulating this_command_keys.  */
static void
696
add_command_key (Lisp_Object key)
Jim Blandy's avatar
Jim Blandy committed
697
{
698 699
#if 0 /* Not needed after we made Freset_this_command_lengths
	 do the job immediately.  */
700 701 702 703 704
  /* 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;
705 706
      if (this_command_key_count < this_single_command_key_start)
	this_single_command_key_start = this_command_key_count;
707 708 709
      echo_truncate (before_command_echo_length_1);
      before_command_restore_flag = 0;
    }
710
#endif
711

712 713 714 715
  if (this_command_key_count >= ASIZE (this_command_keys))
    this_command_keys = larger_vector (this_command_keys,
				       2 * ASIZE (this_command_keys),
				       Qnil);
716

717
  ASET (this_command_keys, this_command_key_count, key);
718
  ++this_command_key_count;
Jim Blandy's avatar
Jim Blandy committed
719
}
720

Jim Blandy's avatar
Jim Blandy committed
721 722

Lisp_Object
723
recursive_edit_1 (void)
Jim Blandy's avatar
Jim Blandy committed
724
{
Juanma Barranquero's avatar
Juanma Barranquero committed
725
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
726 727 728 729 730 731 732 733
  Lisp_Object val;

  if (command_loop_level > 0)
    {
      specbind (Qstandard_output, Qt);
      specbind (Qstandard_input, Qt);
    }

734
#ifdef HAVE_WINDOW_SYSTEM
735
  /* The command loop has started an hourglass timer, so we have to
736
     cancel it here, otherwise it will fire because the recursive edit
737 738
     can take some time.  Do not check for display_hourglass_p here,
     because it could already be nil.  */
739
    cancel_hourglass ();
740 741
#endif

742 743 744 745 746 747 748 749 750 751 752 753
  /* This function may have been called from a debugger called from
     within redisplay, for instance by Edebugging a function called
     from fontification-functions.  We want to allow redisplay in
     the debugging session.

     The recursive edit is left with a `(throw exit ...)'.  The `exit'
     tag is not caught anywhere in redisplay, i.e. when we leave the
     recursive edit, the original redisplay leading to the recursive
     edit will be unwound.  The outcome should therefore be safe.  */
  specbind (Qinhibit_redisplay, Qnil);
  redisplaying_p = 0;

Jim Blandy's avatar
Jim Blandy committed
754 755 756
  val = command_loop ();
  if (EQ (val, Qt))
    Fsignal (Qquit, Qnil);
757 758 759
  /* Handle throw from read_minibuf when using minibuffer
     while it's active but we're in another window.  */
  if (STRINGP (val))
760
    xsignal1 (Qerror, val);
Jim Blandy's avatar
Jim Blandy committed
761

762
  return unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
763 764 765
}

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

767
void
768
record_auto_save (void)
Jim Blandy's avatar
Jim Blandy committed
769
{
770
  last_auto_save = num_nonmacro_input_events;
Jim Blandy's avatar
Jim Blandy committed
771
}
772 773 774

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

775
#ifdef SIGDANGER
Andreas Schwab's avatar
Andreas Schwab committed
776
void
777
force_auto_save_soon (void)
778 779
{
  last_auto_save = - auto_save_interval - 1;
780 781

  record_asynch_buffer_change ();
782
}
783
#endif
Jim Blandy's avatar
Jim Blandy committed
784

Paul Eggert's avatar
Paul Eggert committed
785
DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
786 787 788
       doc: /* Invoke the editor command loop recursively.
To get out of the recursive edit, a command can do `(throw 'exit nil)';
that tells this function to return.
789
Alternatively, `(throw 'exit t)' makes this function signal an error.
790
This function is called by the editor initialization to begin editing.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
791
  (void)
Jim Blandy's avatar
Jim Blandy committed
792
{
Juanma Barranquero's avatar
Juanma Barranquero committed
793
  int count = SPECPDL_INDEX ();
794
  Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
795

796 797 798 799 800
  /* If we enter while input is blocked, don't lock up here.
     This may happen through the debugger during redisplay.  */
  if (INPUT_BLOCKED_P)
    return Qnil;

Jim Blandy's avatar
Jim Blandy committed
801 802 803
  command_loop_level++;
  update_mode_lines = 1;

804 805 806 807 808 809 810 811 812 813
  if (command_loop_level
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
    buffer = Fcurrent_buffer ();
  else
    buffer = Qnil;

  /* If we leave recursive_edit_1 below with a `throw' for instance,
     like it is done in the splash screen display, we have to
     make sure that we restore single_kboard as command_loop_1
     would have done if it were left normally.  */
814 815
  if (command_loop_level > 0)
    temporarily_switch_to_single_kboard (SELECTED_FRAME ());
816
  record_unwind_protect (recursive_edit_unwind, buffer);
817

Jim Blandy's avatar
Jim Blandy committed
818 819 820 821 822
  recursive_edit_1 ();
  return unbind_to (count, Qnil);
}

Lisp_Object
823
recursive_edit_unwind (Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
824
{
825 826
  if (BUFFERP (buffer))
    Fset_buffer (buffer);
Juanma Barranquero's avatar
Juanma Barranquero committed
827

Jim Blandy's avatar
Jim Blandy committed
828 829 830 831
  command_loop_level--;
  update_mode_lines = 1;
  return Qnil;
}
832

Jim Blandy's avatar
Jim Blandy committed
833

834 835
#if 0  /* These two functions are now replaced with
          temporarily_switch_to_single_kboard. */
Karl Heuer's avatar
Karl Heuer committed
836
static void
837
any_kboard_state ()
Karl Heuer's avatar
Karl Heuer committed
838
{
839 840 841 842
#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
843
  if (CONSP (Vunread_command_events))
844
    {
845 846 847
      current_kboard->kbd_queue
	= nconc2 (Vunread_command_events, current_kboard->kbd_queue);
      current_kboard->kbd_queue_has_data = 1;
848
    }
Karl Heuer's avatar
Karl Heuer committed
849
  Vunread_command_events = Qnil;
850 851
#endif
  single_kboard = 0;
Karl Heuer's avatar
Karl Heuer committed
852
}
853 854 855 856 857 858 859 860 861

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

void
single_kboard_state ()
{
  single_kboard = 1;
}
862
#endif
863

864 865 866 867
/* If we're in single_kboard state for kboard KBOARD,
   get out of it.  */

void
868
not_single_kboard_state (KBOARD *kboard)
869 870 871 872 873
{
  if (kboard == current_kboard)
    single_kboard = 0;
}

874 875 876 877 878 879 880 881 882 883 884 885 886
/* 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
887
push_kboard (struct kboard *k)
888 889 890 891 892 893 894 895
{
  struct kboard_stack *p
    = (struct kboard_stack *) xmalloc (sizeof (struct kboard_stack));

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

896
  current_kboard = k;
897 898 899
}

void
900
pop_kboard (void)
901
{
902
  struct terminal *t;
903
  struct kboard_stack *p = kboard_stack;
904
  int found = 0;
905
  for (t = terminal_list; t; t = t->next_terminal)
906
    {
907
      if (t->kboard == p->kboard)
908 909
        {
          current_kboard = p->kboard;
910
          found = 1;
911 912 913
          break;
        }
    }
914
  if (!found)
915
    {
916
      /* The terminal we remembered has been deleted.  */
917
      current_kboard = FRAME_KBOARD (SELECTED_FRAME ());
918
      single_kboard = 0;
919
    }
Richard M. Stallman's avatar