keyboard.c 371 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-2012  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>
Paul Eggert's avatar
Paul Eggert committed
21 22 23

#define KEYBOARD_INLINE EXTERN_INLINE

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

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

Jim Blandy's avatar
Jim Blandy committed
59 60
#include "syssignal.h"

61 62
#include <sys/types.h>
#include <unistd.h>
63 64
#include <fcntl.h>

65 66 67
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */
68

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

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

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

Chong Yidong's avatar
Chong Yidong committed
78 79 80 81 82
/* 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.  */
83
#ifdef SYNC_INPUT
Chong Yidong's avatar
Chong Yidong committed
84
int pending_signals;
85
#endif
Chong Yidong's avatar
Chong Yidong committed
86

87
#define KBD_BUFFER_SIZE 4096
Jim Blandy's avatar
Jim Blandy committed
88

89 90 91
KBOARD *initial_kboard;
KBOARD *current_kboard;
KBOARD *all_kboards;
92 93 94

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

Jim Blandy's avatar
Jim Blandy committed
96
/* Non-nil disable property on a command means
97
   do not execute it; call disabled-command-function's value instead.  */
98 99
Lisp_Object Qdisabled;
static Lisp_Object Qdisabled_command_function;
Jim Blandy's avatar
Jim Blandy committed
100

101
#define NUM_RECENT_KEYS (300)
102 103 104 105 106 107 108 109 110

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

112 113 114 115 116 117
/* 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;
118
ptrdiff_t this_command_key_count;
Jim Blandy's avatar
Jim Blandy committed
119

120 121
/* 1 after calling Freset_this_command_lengths.
   Usually it is 0.  */
122
static int this_command_key_count_reset;
123

124 125
/* This vector is used as a buffer to record the events that were actually read
   by read_key_sequence.  */
126 127
static Lisp_Object raw_keybuf;
static int raw_keybuf_count;
128 129

#define GROW_RAW_KEYBUF							\
130
 if (raw_keybuf_count == ASIZE (raw_keybuf))				\
131
   raw_keybuf = larger_vector (raw_keybuf, 1, -1)
132

133 134
/* Number of elements of this_command_keys
   that precede this key sequence.  */
135
static ptrdiff_t this_single_command_key_start;
136

137 138
/* Record values of this_command_key_count and echo_length ()
   before this command was read.  */
139 140
static ptrdiff_t before_command_key_count;
static ptrdiff_t before_command_echo_length;
141

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

Jim Blandy's avatar
Jim Blandy committed
144 145 146 147 148 149
static jmp_buf getcjmp;

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

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

151
static int echoing;
Jim Blandy's avatar
Jim Blandy committed
152

153 154 155 156 157
/* 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;

158 159 160 161
/* 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.  */
162

163
struct kboard *echo_kboard;
164

165 166 167
/* The buffer used for echoing.  Set in echo_now, reset in
   cancel_echoing.  */

168
Lisp_Object echo_message_buffer;
169

170
/* Nonzero means C-g should cause immediate error-signal.  */
Jim Blandy's avatar
Jim Blandy committed
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
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.  */
192
EMACS_INT command_loop_level;
Jim Blandy's avatar
Jim Blandy committed
193

194 195
/* 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
196
   next command input, after any unread_command_events.
197 198 199 200 201

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

Jim Blandy's avatar
Jim Blandy committed
203
/* Last size recorded for a current buffer which is not a minibuffer.  */
204
static ptrdiff_t last_non_minibuf_size;
Jim Blandy's avatar
Jim Blandy committed
205

206 207
/* Total number of times read_char has returned, modulo UINTMAX_MAX + 1.  */
uintmax_t num_input_events;
Jim Blandy's avatar
Jim Blandy committed
208

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

211
static EMACS_INT last_auto_save;
Jim Blandy's avatar
Jim Blandy committed
212

213
/* The value of point when the last command was started.  */
214
static ptrdiff_t last_point_position;
215

216
/* The buffer that was current when the last command was started.  */
217
static Lisp_Object last_point_position_buffer;
218

219
/* The window that was selected when the last command was started.  */
220
static Lisp_Object last_point_position_window;
221

222 223 224 225 226 227 228
/* 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
229 230
/* The timestamp of the last input event we received from the X server.
   X Windows wants this for selection ownership.  */
231
Time last_event_timestamp;
Jim Blandy's avatar
Jim Blandy committed
232

233
static Lisp_Object Qx_set_selection, Qhandle_switch_frame;
234
static Lisp_Object Qhandle_select_window;
235
Lisp_Object QPRIMARY;
236

237 238 239
static Lisp_Object Qself_insert_command;
static Lisp_Object Qforward_char;
static Lisp_Object Qbackward_char;
240
Lisp_Object Qundefined;
241
static Lisp_Object Qtimer_event_handler;
Jim Blandy's avatar
Jim Blandy committed
242 243 244

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

248
static Lisp_Object Qinput_method_function;
249

250
static Lisp_Object Qdeactivate_mark;
251

252 253
Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

254
static Lisp_Object Qecho_area_clear_hook;
255

256
/* Hooks to run before and after each command.  */
257 258
static Lisp_Object Qpre_command_hook;
static Lisp_Object Qpost_command_hook;
259

260
static Lisp_Object Qdeferred_action_function;
261

262 263
static Lisp_Object Qdelayed_warnings_hook;

264 265
static Lisp_Object Qinput_method_exit_on_first_char;
static Lisp_Object Qinput_method_use_echo_area;
266

267
static Lisp_Object Qhelp_form_show;
268

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

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

275
/* Circular buffer for pre-read keyboard input.  */
276

277 278 279 280
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.
281
   This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
282 283 284 285 286 287
   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].  */
288
static struct input_event * volatile kbd_store_ptr;
289 290 291 292

/* 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
293
   there is input available if the two pointers are not equal.
294 295 296 297 298

   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
299
/* Symbols to head events.  */
300 301
static Lisp_Object Qmouse_movement;
static Lisp_Object Qscroll_bar_movement;
302
Lisp_Object Qswitch_frame;
303 304 305 306
static Lisp_Object Qdelete_frame;
static Lisp_Object Qiconify_frame;
static Lisp_Object Qmake_frame_visible;
static Lisp_Object Qselect_window;
307
Lisp_Object Qhelp_echo;
308

Nick Roberts's avatar
Nick Roberts committed
309
#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
310
static Lisp_Object Qmouse_fixup_help_message;
311 312
#endif

Jim Blandy's avatar
Jim Blandy committed
313
/* Symbols to denote kinds of events.  */
314
static Lisp_Object Qfunction_key;
Jim Blandy's avatar
Jim Blandy committed
315
Lisp_Object Qmouse_click;
316
#if defined (WINDOWSNT)
317
Lisp_Object Qlanguage_change;
318
#endif
319 320
static Lisp_Object Qdrag_n_drop;
static Lisp_Object Qsave_session;
321
#ifdef HAVE_DBUS
322
static Lisp_Object Qdbus_event;
323
#endif
324
static Lisp_Object Qconfig_changed_event;
325

Jim Blandy's avatar
Jim Blandy committed
326 327 328 329
/* Lisp_Object Qmouse_movement; - also an event header */

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

332
/* Menu and tool bar item parts.  */
333 334 335 336 337 338 339 340 341 342
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;
343

344 345 346 347 348 349 350 351 352 353 354
/* 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.  */
355
static Lisp_Object Qmodifier_cache;
356

357
/* Symbols to use for parts of windows.  */
Jim Blandy's avatar
Jim Blandy committed
358
Lisp_Object Qmode_line;
Jim Blandy's avatar
Jim Blandy committed
359
Lisp_Object Qvertical_line;
360
static Lisp_Object Qvertical_scroll_bar;
361 362
Lisp_Object Qmenu_bar;

363 364
static Lisp_Object recursive_edit_unwind (Lisp_Object buffer);
static Lisp_Object command_loop (void);
365
static Lisp_Object Qextended_command_history;
366
EMACS_TIME timer_check (void);
Jim Blandy's avatar
Jim Blandy committed
367

368
static void record_menu_key (Lisp_Object c);
369
static void echo_now (void);
370
static ptrdiff_t echo_length (void);
371

372
static Lisp_Object Qpolling_period;
373

374 375 376
/* Incremented whenever a timer is run.  */
int timers_run;

Jim Blandy's avatar
Jim Blandy committed
377 378 379
/* 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
380 381 382 383 384 385 386 387

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

Glenn Morris's avatar
Glenn Morris committed
388
/* Allow configure to inhibit use of FIONREAD.  */
Jim Blandy's avatar
Jim Blandy committed
389 390 391 392 393 394
#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
395
#if !defined (FIONREAD)
Jim Blandy's avatar
Jim Blandy committed
396 397 398 399 400
#ifdef SIGIO
#undef SIGIO
#endif
#endif

401
/* If we support a window system, turn on the code to poll periodically
402
   to detect C-g.  It isn't actually used when doing interrupt input.  */
Juanma Barranquero's avatar
Juanma Barranquero committed
403
#if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_ASYNC_EVENTS)
Jim Blandy's avatar
Jim Blandy committed
404 405
#define POLL_FOR_INPUT
#endif
406

407 408 409 410
/* The time when Emacs started being idle.  */

static EMACS_TIME timer_idleness_start_time;

411 412 413 414 415
/* 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
416 417 418

/* Global variable declarations.  */

419 420 421 422 423
/* 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
424
/* Function for init_keyboard to call with no args (if nonzero).  */
425
static void (*keyboard_init_hook) (void);
Jim Blandy's avatar
Jim Blandy committed
426

427 428 429
static int read_avail_input (int);
static void get_input_pending (int *, int);
static int readable_events (int);
430
static Lisp_Object read_char_x_menu_prompt (ptrdiff_t, Lisp_Object *,
431
                                            Lisp_Object, int *);
432
static Lisp_Object read_char_minibuf_menu_prompt (int, ptrdiff_t,
433 434
                                                  Lisp_Object *);
static Lisp_Object make_lispy_event (struct input_event *);
Nick Roberts's avatar
Nick Roberts committed
435
#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
436 437 438
static Lisp_Object make_lispy_movement (struct frame *, Lisp_Object,
                                        enum scroll_bar_part,
                                        Lisp_Object, Lisp_Object,
439
					Time);
440
#endif
441
static Lisp_Object modify_event_symbol (ptrdiff_t, int, Lisp_Object,
442
                                        Lisp_Object, const char *const *,
443
                                        Lisp_Object *, ptrdiff_t);
444
static Lisp_Object make_lispy_switch_frame (Lisp_Object);
445
static int help_char_p (Lisp_Object);
446 447 448 449 450
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);
451
#ifdef SIGIO
452
static void deliver_input_available_signal (int signo);
453
#endif
454
static void handle_interrupt (void);
455
static _Noreturn void quit_throw_to_read_char (int);
456
static void process_special_events (void);
457 458 459
static void timer_start_idle (void);
static void timer_stop_idle (void);
static void timer_resume_idle (void);
460
static void deliver_user_signal (int);
461 462
static char *find_user_signal_name (int);
static int store_user_signal_events (void);
Jim Blandy's avatar
Jim Blandy committed
463

Paul Eggert's avatar
Paul Eggert committed
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
/* These setters are used only in this file, so they can be private.  */
static inline void
kset_echo_string (struct kboard *kb, Lisp_Object val)
{
  kb->INTERNAL_FIELD (echo_string) = val;
}
static inline void
kset_kbd_queue (struct kboard *kb, Lisp_Object val)
{
  kb->INTERNAL_FIELD (kbd_queue) = val;
}
static inline void
kset_keyboard_translate_table (struct kboard *kb, Lisp_Object val)
{
  kb->INTERNAL_FIELD (Vkeyboard_translate_table) = val;
}
static inline void
kset_last_prefix_arg (struct kboard *kb, Lisp_Object val)
{
  kb->INTERNAL_FIELD (Vlast_prefix_arg) = val;
}
static inline void
kset_last_repeatable_command (struct kboard *kb, Lisp_Object val)
{
  kb->INTERNAL_FIELD (Vlast_repeatable_command) = val;
}
static inline void
kset_local_function_key_map (struct kboard *kb, Lisp_Object val)
{
  kb->INTERNAL_FIELD (Vlocal_function_key_map) = val;
}
static inline void
kset_overriding_terminal_local_map (struct kboard *kb, Lisp_Object val)
{
  kb->INTERNAL_FIELD (Voverriding_terminal_local_map) = val;
}
static inline void
kset_real_last_command (struct kboard *kb, Lisp_Object val)
{
  kb->INTERNAL_FIELD (Vreal_last_command) = val;
}
static inline void
kset_system_key_syms (struct kboard *kb, Lisp_Object val)
{
  kb->INTERNAL_FIELD (system_key_syms) = val;
}

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

516
static void
517
echo_char (Lisp_Object c)
Jim Blandy's avatar
Jim Blandy committed
518
{
519
  if (current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
520
    {
521
      int size = KEY_DESCRIPTION_SIZE + 100;
522
      char *buffer = alloca (size);
523 524
      char *ptr = buffer;
      Lisp_Object echo_string;
Jim Blandy's avatar
Jim Blandy committed
525

526
      echo_string = KVAR (current_kboard, echo_string);
Juanma Barranquero's avatar
Juanma Barranquero committed
527

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

531
      if (INTEGERP (c))
Jim Blandy's avatar
Jim Blandy committed
532
	{
533
	  ptr = push_key_description (XINT (c), ptr, 1);
Jim Blandy's avatar
Jim Blandy committed
534
	}
535
      else if (SYMBOLP (c))
Jim Blandy's avatar
Jim Blandy committed
536
	{
537 538
	  Lisp_Object name = SYMBOL_NAME (c);
	  int nbytes = SBYTES (name);
Juanma Barranquero's avatar
Juanma Barranquero committed
539

540
	  if (size - (ptr - buffer) < nbytes)
541 542
	    {
	      int offset = ptr - buffer;
543
	      size = max (2 * size, size + nbytes);
544
	      buffer = alloca (size);
545 546 547
	      ptr = buffer + offset;
	    }

548
	  ptr += copy_text (SDATA (name), (unsigned char *) ptr, nbytes,
549
			    STRING_MULTIBYTE (name), 1);
Jim Blandy's avatar
Jim Blandy committed
550 551
	}

552
      if ((NILP (echo_string) || SCHARS (echo_string) == 0)
Karl Heuer's avatar
Karl Heuer committed
553
	  && help_char_p (c))
Jim Blandy's avatar
Jim Blandy committed
554
	{
555 556
	  const char *text = " (Type ? for further options)";
	  int len = strlen (text);
Juanma Barranquero's avatar
Juanma Barranquero committed
557

558 559 560 561
	  if (size - (ptr - buffer) < len)
	    {
	      int offset = ptr - buffer;
	      size += len;
562
	      buffer = alloca (size);
563 564 565
	      ptr = buffer + offset;
	    }

566
	  memcpy (ptr, text, len);
567
	  ptr += len;
Jim Blandy's avatar
Jim Blandy committed
568 569
	}

570 571
      /* Replace a dash from echo_dash with a space, otherwise
	 add a space at the end as a separator between keys.  */
572
      if (STRINGP (echo_string)
573
	  && SCHARS (echo_string) > 1)
574
	{
575 576 577 578
	  Lisp_Object last_char, prev_char, idx;

	  idx = make_number (SCHARS (echo_string) - 2);
	  prev_char = Faref (echo_string, idx);
579 580 581 582

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

583 584 585
	  /* We test PREV_CHAR to make sure this isn't the echoing
	     of a minus-sign.  */
	  if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
586 587 588 589
	    Faset (echo_string, idx, make_number (' '));
	  else
	    echo_string = concat2 (echo_string, build_string (" "));
	}
590 591
      else if (STRINGP (echo_string))
	echo_string = concat2 (echo_string, build_string (" "));
592

Paul Eggert's avatar
Paul Eggert committed
593 594 595
      kset_echo_string
	(current_kboard,
	 concat2 (echo_string, make_string (buffer, ptr - buffer)));
Jim Blandy's avatar
Jim Blandy committed
596

597
      echo_now ();
Jim Blandy's avatar
Jim Blandy committed
598 599 600 601 602 603
    }
}

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

604
static void
605
echo_dash (void)
Jim Blandy's avatar
Jim Blandy committed
606
{
607
  /* Do nothing if not echoing at all.  */
608
  if (NILP (KVAR (current_kboard, echo_string)))
609 610
    return;

611 612 613
  if (this_command_key_count == 0)
    return;

614
  if (!current_kboard->immediate_echo
615
      && SCHARS (KVAR (current_kboard, echo_string)) == 0)
Jim Blandy's avatar
Jim Blandy committed
616
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
617

618
  /* Do nothing if we just printed a prompt.  */
619
  if (current_kboard->echo_after_prompt
620
      == SCHARS (KVAR (current_kboard, echo_string)))
621
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
622

623
  /* Do nothing if we have already put a dash at the end.  */
624
  if (SCHARS (KVAR (current_kboard, echo_string)) > 1)
625
    {
626
      Lisp_Object last_char, prev_char, idx;
627

628 629
      idx = make_number (SCHARS (KVAR (current_kboard, echo_string)) - 2);
      prev_char = Faref (KVAR (current_kboard, echo_string), idx);
630

631 632
      idx = make_number (SCHARS (KVAR (current_kboard, echo_string)) - 1);
      last_char = Faref (KVAR (current_kboard, echo_string), idx);
633

634 635
      if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
	return;
636 637
    }

Jim Blandy's avatar
Jim Blandy committed
638 639
  /* Put a dash at the end of the buffer temporarily,
     but make it go away when the next character is added.  */
Paul Eggert's avatar
Paul Eggert committed
640 641 642
  kset_echo_string
    (current_kboard,
     concat2 (KVAR (current_kboard, echo_string), build_string ("-")));
643
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
644 645 646 647 648
}

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

649
static void
650
echo_now (void)
Jim Blandy's avatar
Jim Blandy committed
651
{
652
  if (!current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
653
    {
654
      ptrdiff_t i;
655
      current_kboard->immediate_echo = 1;
Jim Blandy's avatar
Jim Blandy committed
656 657

      for (i = 0; i < this_command_key_count; i++)
658 659
	{
	  Lisp_Object c;
660 661 662 663 664 665 666

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

667
	  c = AREF (this_command_keys, i);
668 669 670 671
	  if (! (EVENT_HAS_PARAMETERS (c)
		 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
	    echo_char (c);
	}
672 673 674 675 676 677 678 679

      /* 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
680 681 682 683
      echo_dash ();
    }

  echoing = 1;
684 685 686
  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
687 688
  echoing = 0;

689 690 691 692
  /* 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
693
  if (waiting_for_input && !NILP (Vquit_flag))
694
    quit_throw_to_read_char (0);
Jim Blandy's avatar
Jim Blandy committed
695 696 697 698
}

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

Andreas Schwab's avatar
Andreas Schwab committed
699
void
700
cancel_echoing (void)
Jim Blandy's avatar
Jim Blandy committed
701
{
702 703
  current_kboard->immediate_echo = 0;
  current_kboard->echo_after_prompt = -1;
Paul Eggert's avatar
Paul Eggert committed
704
  kset_echo_string (current_kboard, Qnil);
705 706 707
  ok_to_echo_at_next_pause = NULL;
  echo_kboard = NULL;
  echo_message_buffer = Qnil;
Jim Blandy's avatar
Jim Blandy committed
708 709 710 711
}

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

712
static ptrdiff_t
713
echo_length (void)
Jim Blandy's avatar
Jim Blandy committed
714
{
715 716
  return (STRINGP (KVAR (current_kboard, echo_string))
	  ? SCHARS (KVAR (current_kboard, echo_string))
717
	  : 0);
Jim Blandy's avatar
Jim Blandy committed
718 719 720 721
}

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

static void
725
echo_truncate (ptrdiff_t nchars)
726
{
727
  if (STRINGP (KVAR (current_kboard, echo_string)))
Paul Eggert's avatar
Paul Eggert committed
728 729 730
    kset_echo_string (current_kboard,
		      Fsubstring (KVAR (current_kboard, echo_string),
				  make_number (0), make_number (nchars)));
731
  truncate_echo_area (nchars);
Jim Blandy's avatar
Jim Blandy committed
732 733 734 735 736
}


/* Functions for manipulating this_command_keys.  */
static void
737
add_command_key (Lisp_Object key)
Jim Blandy's avatar
Jim Blandy committed
738
{
739 740
#if 0 /* Not needed after we made Freset_this_command_lengths
	 do the job immediately.  */
741 742 743 744 745
  /* 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;
746 747
      if (this_command_key_count < this_single_command_key_start)
	this_single_command_key_start = this_command_key_count;
748 749 750
      echo_truncate (before_command_echo_length_1);
      before_command_restore_flag = 0;
    }
751
#endif
752

753
  if (this_command_key_count >= ASIZE (this_command_keys))
754
    this_command_keys = larger_vector (this_command_keys, 1, -1);
755

756
  ASET (this_command_keys, this_command_key_count, key);
757
  ++this_command_key_count;
Jim Blandy's avatar
Jim Blandy committed
758
}
759

Jim Blandy's avatar
Jim Blandy committed
760 761

Lisp_Object
762
recursive_edit_1 (void)
Jim Blandy's avatar
Jim Blandy committed
763
{
764
  ptrdiff_t count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
765 766 767 768 769 770 771 772
  Lisp_Object val;

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

773
#ifdef HAVE_WINDOW_SYSTEM
774
  /* The command loop has started an hourglass timer, so we have to
775
     cancel it here, otherwise it will fire because the recursive edit
776 777
     can take some time.  Do not check for display_hourglass_p here,
     because it could already be nil.  */
778
    cancel_hourglass ();
779 780
#endif

781 782 783 784 785 786 787 788 789 790 791 792
  /* 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
793 794 795
  val = command_loop ();
  if (EQ (val, Qt))
    Fsignal (Qquit, Qnil);
796 797 798
  /* Handle throw from read_minibuf when using minibuffer
     while it's active but we're in another window.  */
  if (STRINGP (val))
799
    xsignal1 (Qerror, val);
Jim Blandy's avatar
Jim Blandy committed
800

801
  return unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
802 803 804
}

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

806
void
807
record_auto_save (void)
Jim Blandy's avatar
Jim Blandy committed
808
{
809
  last_auto_save = num_nonmacro_input_events;
Jim Blandy's avatar
Jim Blandy committed
810
}
811 812 813

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

814
#ifdef SIGDANGER
Andreas Schwab's avatar
Andreas Schwab committed
815
void
816
force_auto_save_soon (void)
817 818
{
  last_auto_save = - auto_save_interval - 1;
819 820

  record_asynch_buffer_change ();
821
}
822
#endif
Jim Blandy's avatar
Jim Blandy committed
823

Paul Eggert's avatar
Paul Eggert committed
824
DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
825 826 827
       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.
828
Alternatively, `(throw 'exit t)' makes this function signal an error.
829
This function is called by the editor initialization to begin editing.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
830
  (void)
Jim Blandy's avatar
Jim Blandy committed
831
{
832
  ptrdiff_t count = SPECPDL_INDEX ();
833
  Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
834

835 836 837 838 839
  /* 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
840 841 842
  command_loop_level++;
  update_mode_lines = 1;

843
  if (command_loop_level
844
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
845 846 847 848 849 850 851 852
    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.  */
853 854
  if (command_loop_level > 0)
    temporarily_switch_to_single_kboard (SELECTED_FRAME ());
855
  record_unwind_protect (recursive_edit_unwind, buffer);
856

Jim Blandy's avatar
Jim Blandy committed
857 858 859 860 861
  recursive_edit_1 ();
  return unbind_to (count, Qnil);
}

Lisp_Object
862
recursive_edit_unwind (Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
863
{
864 865
  if (BUFFERP (buffer))
    Fset_buffer (buffer);
Juanma Barranquero's avatar
Juanma Barranquero committed
866

Jim Blandy's avatar
Jim Blandy committed
867 868 869 870
  command_loop_level--;
  update_mode_lines = 1;
  return Qnil;
}
871

Jim Blandy's avatar
Jim Blandy committed
872

873
#if 0  /* These two functions are now replaced with
874
          temporarily_switch_to_single_kboard.  */
Karl Heuer's avatar
Karl Heuer committed
875
static void
876
any_kboard_state ()
Karl Heuer's avatar
Karl Heuer committed
877
{
878 879 880 881
#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
882
  if (CONSP (Vunread_command_events))
883
    {
884 885 886
      current_kboard->kbd_queue
	= nconc2 (Vunread_command_events, current_kboard->kbd_queue);
      current_kboard->kbd_queue_has_data = 1;
887
    }
Karl Heuer's avatar
Karl Heuer committed
888
  Vunread_command_events = Qnil;
889 890
#endif
  single_kboard = 0;
Karl Heuer's avatar
Karl Heuer committed
891
}