keyboard.c 367 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
#define BLOCKINPUT_INLINE EXTERN_INLINE
Paul Eggert's avatar
Paul Eggert committed
23 24
#define KEYBOARD_INLINE EXTERN_INLINE

Jim Blandy's avatar
Jim Blandy committed
25
#include <stdio.h>
26

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

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

Paul Eggert's avatar
Paul Eggert committed
60 61 62 63
#if defined USABLE_FIONREAD && defined USG5_4
# include <sys/filio.h>
#endif

Jim Blandy's avatar
Jim Blandy committed
64 65
#include "syssignal.h"

66 67
#include <sys/types.h>
#include <unistd.h>
68 69
#include <fcntl.h>

70 71 72
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */
73

74
/* Variables for blockinput.h: */
75

76
/* Positive if interrupt input is blocked right now.  */
77
volatile int interrupt_input_blocked;
78

79
/* True means an input interrupt or alarm signal has arrived.
80
   The QUIT macro checks this.  */
81
volatile bool pending_signals;
Chong Yidong's avatar
Chong Yidong committed
82

83
#define KBD_BUFFER_SIZE 4096
Jim Blandy's avatar
Jim Blandy committed
84

85 86 87
KBOARD *initial_kboard;
KBOARD *current_kboard;
KBOARD *all_kboards;
88

89 90
/* True in the single-kboard state, false in the any-kboard state.  */
static bool single_kboard;
91

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

97
#define NUM_RECENT_KEYS (300)
98 99 100 101 102 103 104 105 106

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

108 109 110 111 112 113
/* 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;
114
ptrdiff_t this_command_key_count;
Jim Blandy's avatar
Jim Blandy committed
115

116 117 118
/* True after calling Freset_this_command_lengths.
   Usually it is false.  */
static bool this_command_key_count_reset;
119

120 121
/* This vector is used as a buffer to record the events that were actually read
   by read_key_sequence.  */
122 123
static Lisp_Object raw_keybuf;
static int raw_keybuf_count;
124 125

#define GROW_RAW_KEYBUF							\
126
 if (raw_keybuf_count == ASIZE (raw_keybuf))				\
127
   raw_keybuf = larger_vector (raw_keybuf, 1, -1)
128

129 130
/* Number of elements of this_command_keys
   that precede this key sequence.  */
131
static ptrdiff_t this_single_command_key_start;
132

133 134
/* Record values of this_command_key_count and echo_length ()
   before this command was read.  */
135 136
static ptrdiff_t before_command_key_count;
static ptrdiff_t before_command_echo_length;
137

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

140
static sys_jmp_buf getcjmp;
Jim Blandy's avatar
Jim Blandy committed
141 142

/* True while doing kbd input.  */
143
bool waiting_for_input;
Jim Blandy's avatar
Jim Blandy committed
144 145

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

147
static bool echoing;
Jim Blandy's avatar
Jim Blandy committed
148

149 150 151 152 153
/* 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;

154 155 156 157
/* 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.  */
158

159
struct kboard *echo_kboard;
160

161 162 163
/* The buffer used for echoing.  Set in echo_now, reset in
   cancel_echoing.  */

164
Lisp_Object echo_message_buffer;
165

166 167
/* True means C-g should cause immediate error-signal.  */
bool immediate_quit;
Jim Blandy's avatar
Jim Blandy committed
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187

/* 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.  */
188
EMACS_INT command_loop_level;
Jim Blandy's avatar
Jim Blandy committed
189

190 191
/* 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
192
   next command input, after any unread_command_events.
193 194 195 196 197

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

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

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

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

207
static EMACS_INT last_auto_save;
Jim Blandy's avatar
Jim Blandy committed
208

209
/* The value of point when the last command was started.  */
210
static ptrdiff_t last_point_position;
211

212
/* The buffer that was current when the last command was started.  */
213
static Lisp_Object last_point_position_buffer;
214

215
/* The window that was selected when the last command was started.  */
216
static Lisp_Object last_point_position_window;
217

218 219 220 221
/* 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
222 223 224 225 226
   generated by the next character.

   FIXME: This is modified by a signal handler so it should be volatile.
   It's exported to Lisp, though, so it can't simply be marked
   'volatile' here.  */
227 228
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

/* Nonzero if input is available.  */
273
bool input_pending;
Jim Blandy's avatar
Jim Blandy committed
274

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
#ifdef HAVE_NTGUI
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 echo_now (void);
369
static ptrdiff_t echo_length (void);
370

371
static Lisp_Object Qpolling_period;
372

373
/* Incremented whenever a timer is run.  */
374
unsigned timers_run;
375

Jim Blandy's avatar
Jim Blandy committed
376 377 378
/* 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
379

380 381 382
/* True means use SIGIO interrupts; false means use CBREAK mode.
   Default is true if INTERRUPT_INPUT is defined.  */
bool interrupt_input;
Jim Blandy's avatar
Jim Blandy committed
383 384

/* Nonzero while interrupts are temporarily deferred during redisplay.  */
385
bool interrupts_deferred;
Jim Blandy's avatar
Jim Blandy committed
386

387
/* If we support a window system, turn on the code to poll periodically
388
   to detect C-g.  It isn't actually used when doing interrupt input.  */
389
#ifdef HAVE_WINDOW_SYSTEM
Jim Blandy's avatar
Jim Blandy committed
390 391
#define POLL_FOR_INPUT
#endif
392

393 394 395 396
/* The time when Emacs started being idle.  */

static EMACS_TIME timer_idleness_start_time;

397 398 399 400 401
/* 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
402 403 404

/* Global variable declarations.  */

405 406 407 408 409
/* 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
410
/* Function for init_keyboard to call with no args (if nonzero).  */
411
static void (*keyboard_init_hook) (void);
Jim Blandy's avatar
Jim Blandy committed
412

413 414
static bool get_input_pending (int);
static bool readable_events (int);
415
static Lisp_Object read_char_x_menu_prompt (ptrdiff_t, Lisp_Object *,
416
                                            Lisp_Object, bool *);
417
static Lisp_Object read_char_minibuf_menu_prompt (int, ptrdiff_t,
418 419
                                                  Lisp_Object *);
static Lisp_Object make_lispy_event (struct input_event *);
Nick Roberts's avatar
Nick Roberts committed
420
#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
421 422 423
static Lisp_Object make_lispy_movement (struct frame *, Lisp_Object,
                                        enum scroll_bar_part,
                                        Lisp_Object, Lisp_Object,
424
					Time);
425
#endif
426
static Lisp_Object modify_event_symbol (ptrdiff_t, int, Lisp_Object,
427
                                        Lisp_Object, const char *const *,
428
                                        Lisp_Object *, ptrdiff_t);
429
static Lisp_Object make_lispy_switch_frame (Lisp_Object);
430
static bool help_char_p (Lisp_Object);
431 432
static void save_getcjmp (sys_jmp_buf);
static void restore_getcjmp (sys_jmp_buf);
433 434 435
static Lisp_Object apply_modifiers (int, Lisp_Object);
static void clear_event (struct input_event *);
static Lisp_Object restore_kboard_configuration (Lisp_Object);
Paul Eggert's avatar
Paul Eggert committed
436
#ifdef USABLE_SIGIO
437
static void deliver_input_available_signal (int signo);
438
#endif
439
static void handle_interrupt (bool);
440
static _Noreturn void quit_throw_to_read_char (bool);
441
static void process_special_events (void);
442 443 444
static void timer_start_idle (void);
static void timer_stop_idle (void);
static void timer_resume_idle (void);
445
static void deliver_user_signal (int);
446
static char *find_user_signal_name (int);
447
static void store_user_signal_events (void);
Jim Blandy's avatar
Jim Blandy committed
448

Paul Eggert's avatar
Paul Eggert committed
449
/* These setters are used only in this file, so they can be private.  */
450
static void
Paul Eggert's avatar
Paul Eggert committed
451 452 453 454
kset_echo_string (struct kboard *kb, Lisp_Object val)
{
  kb->INTERNAL_FIELD (echo_string) = val;
}
455
static void
Paul Eggert's avatar
Paul Eggert committed
456 457 458 459
kset_kbd_queue (struct kboard *kb, Lisp_Object val)
{
  kb->INTERNAL_FIELD (kbd_queue) = val;
}
460
static void
Paul Eggert's avatar
Paul Eggert committed
461 462 463 464
kset_keyboard_translate_table (struct kboard *kb, Lisp_Object val)
{
  kb->INTERNAL_FIELD (Vkeyboard_translate_table) = val;
}
465
static void
Paul Eggert's avatar
Paul Eggert committed
466 467 468 469
kset_last_prefix_arg (struct kboard *kb, Lisp_Object val)
{
  kb->INTERNAL_FIELD (Vlast_prefix_arg) = val;
}
470
static void
Paul Eggert's avatar
Paul Eggert committed
471 472 473 474
kset_last_repeatable_command (struct kboard *kb, Lisp_Object val)
{
  kb->INTERNAL_FIELD (Vlast_repeatable_command) = val;
}
475
static void
Paul Eggert's avatar
Paul Eggert committed
476 477 478 479
kset_local_function_key_map (struct kboard *kb, Lisp_Object val)
{
  kb->INTERNAL_FIELD (Vlocal_function_key_map) = val;
}
480
static void
Paul Eggert's avatar
Paul Eggert committed
481 482 483 484
kset_overriding_terminal_local_map (struct kboard *kb, Lisp_Object val)
{
  kb->INTERNAL_FIELD (Voverriding_terminal_local_map) = val;
}
485
static void
Paul Eggert's avatar
Paul Eggert committed
486 487 488 489
kset_real_last_command (struct kboard *kb, Lisp_Object val)
{
  kb->INTERNAL_FIELD (Vreal_last_command) = val;
}
490
static void
Paul Eggert's avatar
Paul Eggert committed
491 492 493 494 495
kset_system_key_syms (struct kboard *kb, Lisp_Object val)
{
  kb->INTERNAL_FIELD (system_key_syms) = val;
}

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

501
static void
502
echo_char (Lisp_Object c)
Jim Blandy's avatar
Jim Blandy committed
503
{
504
  if (current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
505
    {
506
      int size = KEY_DESCRIPTION_SIZE + 100;
507
      char *buffer = alloca (size);
508 509
      char *ptr = buffer;
      Lisp_Object echo_string;
Jim Blandy's avatar
Jim Blandy committed
510

511
      echo_string = KVAR (current_kboard, echo_string);
Juanma Barranquero's avatar
Juanma Barranquero committed
512

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

516
      if (INTEGERP (c))
Jim Blandy's avatar
Jim Blandy committed
517
	{
518
	  ptr = push_key_description (XINT (c), ptr);
Jim Blandy's avatar
Jim Blandy committed
519
	}
520
      else if (SYMBOLP (c))
Jim Blandy's avatar
Jim Blandy committed
521
	{
522 523
	  Lisp_Object name = SYMBOL_NAME (c);
	  int nbytes = SBYTES (name);
Juanma Barranquero's avatar
Juanma Barranquero committed
524

525
	  if (size - (ptr - buffer) < nbytes)
526 527
	    {
	      int offset = ptr - buffer;
528
	      size = max (2 * size, size + nbytes);
529
	      buffer = alloca (size);
530 531 532
	      ptr = buffer + offset;
	    }

533
	  ptr += copy_text (SDATA (name), (unsigned char *) ptr, nbytes,
534
			    STRING_MULTIBYTE (name), 1);
Jim Blandy's avatar
Jim Blandy committed
535 536
	}

537
      if ((NILP (echo_string) || SCHARS (echo_string) == 0)
Karl Heuer's avatar
Karl Heuer committed
538
	  && help_char_p (c))
Jim Blandy's avatar
Jim Blandy committed
539
	{
540 541
	  const char *text = " (Type ? for further options)";
	  int len = strlen (text);
Juanma Barranquero's avatar
Juanma Barranquero committed
542

543 544 545 546
	  if (size - (ptr - buffer) < len)
	    {
	      int offset = ptr - buffer;
	      size += len;
547
	      buffer = alloca (size);
548 549 550
	      ptr = buffer + offset;
	    }

551
	  memcpy (ptr, text, len);
552
	  ptr += len;
Jim Blandy's avatar
Jim Blandy committed
553 554
	}

555 556
      /* Replace a dash from echo_dash with a space, otherwise
	 add a space at the end as a separator between keys.  */
557
      if (STRINGP (echo_string)
558
	  && SCHARS (echo_string) > 1)
559
	{
560 561 562 563
	  Lisp_Object last_char, prev_char, idx;

	  idx = make_number (SCHARS (echo_string) - 2);
	  prev_char = Faref (echo_string, idx);
564 565 566 567

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

568 569 570
	  /* We test PREV_CHAR to make sure this isn't the echoing
	     of a minus-sign.  */
	  if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
571 572 573 574
	    Faset (echo_string, idx, make_number (' '));
	  else
	    echo_string = concat2 (echo_string, build_string (" "));
	}
575 576
      else if (STRINGP (echo_string))
	echo_string = concat2 (echo_string, build_string (" "));
577

Paul Eggert's avatar
Paul Eggert committed
578 579 580
      kset_echo_string
	(current_kboard,
	 concat2 (echo_string, make_string (buffer, ptr - buffer)));
Jim Blandy's avatar
Jim Blandy committed
581

582
      echo_now ();
Jim Blandy's avatar
Jim Blandy committed
583 584 585 586 587 588
    }
}

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

589
static void
590
echo_dash (void)
Jim Blandy's avatar
Jim Blandy committed
591
{
592
  /* Do nothing if not echoing at all.  */
593
  if (NILP (KVAR (current_kboard, echo_string)))
594 595
    return;

596 597 598
  if (this_command_key_count == 0)
    return;

599
  if (!current_kboard->immediate_echo
600
      && SCHARS (KVAR (current_kboard, echo_string)) == 0)
Jim Blandy's avatar
Jim Blandy committed
601
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
602

603
  /* Do nothing if we just printed a prompt.  */
604
  if (current_kboard->echo_after_prompt
605
      == SCHARS (KVAR (current_kboard, echo_string)))
606
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
607

608
  /* Do nothing if we have already put a dash at the end.  */
609
  if (SCHARS (KVAR (current_kboard, echo_string)) > 1)
610
    {
611
      Lisp_Object last_char, prev_char, idx;
612

613 614
      idx = make_number (SCHARS (KVAR (current_kboard, echo_string)) - 2);
      prev_char = Faref (KVAR (current_kboard, echo_string), idx);
615

616 617
      idx = make_number (SCHARS (KVAR (current_kboard, echo_string)) - 1);
      last_char = Faref (KVAR (current_kboard, echo_string), idx);
618

619 620
      if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
	return;
621 622
    }

Jim Blandy's avatar
Jim Blandy committed
623 624
  /* 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
625 626 627
  kset_echo_string
    (current_kboard,
     concat2 (KVAR (current_kboard, echo_string), build_string ("-")));
628
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
629 630 631 632 633
}

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

634
static void
635
echo_now (void)
Jim Blandy's avatar
Jim Blandy committed
636
{
637
  if (!current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
638
    {
639
      ptrdiff_t i;
640
      current_kboard->immediate_echo = 1;
Jim Blandy's avatar
Jim Blandy committed
641 642

      for (i = 0; i < this_command_key_count; i++)
643 644
	{
	  Lisp_Object c;
645 646 647 648 649 650 651

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

652
	  c = AREF (this_command_keys, i);
653 654 655 656
	  if (! (EVENT_HAS_PARAMETERS (c)
		 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
	    echo_char (c);
	}
657 658 659 660 661 662 663 664

      /* 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
665 666 667 668
      echo_dash ();
    }

  echoing = 1;
669 670 671
  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
672 673
  echoing = 0;

674 675 676 677
  /* 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
678
  if (waiting_for_input && !NILP (Vquit_flag))
679
    quit_throw_to_read_char (0);
Jim Blandy's avatar
Jim Blandy committed
680 681 682 683
}

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

Andreas Schwab's avatar
Andreas Schwab committed
684
void
685
cancel_echoing (void)
Jim Blandy's avatar
Jim Blandy committed
686
{
687 688
  current_kboard->immediate_echo = 0;
  current_kboard->echo_after_prompt = -1;
Paul Eggert's avatar
Paul Eggert committed
689
  kset_echo_string (current_kboard, Qnil);
690 691 692
  ok_to_echo_at_next_pause = NULL;
  echo_kboard = NULL;
  echo_message_buffer = Qnil;
Jim Blandy's avatar
Jim Blandy committed
693 694 695 696
}

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

697
static ptrdiff_t
698
echo_length (void)
Jim Blandy's avatar
Jim Blandy committed
699
{
700 701
  return (STRINGP (KVAR (current_kboard, echo_string))
	  ? SCHARS (KVAR (current_kboard, echo_string))
702
	  : 0);
Jim Blandy's avatar
Jim Blandy committed
703 704 705 706
}

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

static void
710
echo_truncate (ptrdiff_t nchars)
711
{
712
  if (STRINGP (KVAR (current_kboard, echo_string)))
Paul Eggert's avatar
Paul Eggert committed
713 714 715
    kset_echo_string (current_kboard,
		      Fsubstring (KVAR (current_kboard, echo_string),
				  make_number (0), make_number (nchars)));
716
  truncate_echo_area (nchars);
Jim Blandy's avatar
Jim Blandy committed
717 718 719 720 721
}


/* Functions for manipulating this_command_keys.  */
static void
722
add_command_key (Lisp_Object key)
Jim Blandy's avatar
Jim Blandy committed
723
{
724 725
#if 0 /* Not needed after we made Freset_this_command_lengths
	 do the job immediately.  */
726 727 728 729 730
  /* 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;
731 732
      if (this_command_key_count < this_single_command_key_start)
	this_single_command_key_start = this_command_key_count;
733 734 735
      echo_truncate (before_command_echo_length_1);
      before_command_restore_flag = 0;
    }
736
#endif
737

738
  if (this_command_key_count >= ASIZE (this_command_keys))
739
    this_command_keys = larger_vector (this_command_keys, 1, -1);
740

741
  ASET (this_command_keys, this_command_key_count, key);
742
  ++this_command_key_count;
Jim Blandy's avatar
Jim Blandy committed
743
}
744

Jim Blandy's avatar
Jim Blandy committed
745 746

Lisp_Object
747
recursive_edit_1 (void)
Jim Blandy's avatar
Jim Blandy committed
748
{
749
  ptrdiff_t count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
750 751 752 753 754 755 756 757
  Lisp_Object val;

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

758
#ifdef HAVE_WINDOW_SYSTEM
759
  /* The command loop has started an hourglass timer, so we have to
760
     cancel it here, otherwise it will fire because the recursive edit
761 762
     can take some time.  Do not check for display_hourglass_p here,
     because it could already be nil.  */
763
    cancel_hourglass ();
764 765
#endif

766 767 768 769 770 771 772 773 774 775 776 777
  /* 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
778 779 780
  val = command_loop ();
  if (EQ (val, Qt))
    Fsignal (Qquit, Qnil);
781 782 783
  /* Handle throw from read_minibuf when using minibuffer
     while it's active but we're in another window.  */
  if (STRINGP (val))
784
    xsignal1 (Qerror, val);
Jim Blandy's avatar
Jim Blandy committed
785

786
  return unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
787 788 789
}

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

791
void
792
record_auto_save (void)
Jim Blandy's avatar
Jim Blandy committed
793
{
794
  last_auto_save = num_nonmacro_input_events;
Jim Blandy's avatar
Jim Blandy committed
795
}
796 797 798

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

799
#ifdef SIGDANGER
Andreas Schwab's avatar
Andreas Schwab committed
800
void
801
force_auto_save_soon (void)
802 803
{
  last_auto_save = - auto_save_interval - 1;
804 805

  record_asynch_buffer_change ();
806
}
807
#endif
Jim Blandy's avatar
Jim Blandy committed
808

Paul Eggert's avatar
Paul Eggert committed
809
DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
810 811 812
       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.
813
Alternatively, `(throw 'exit t)' makes this function signal an error.
814
This function is called by the editor initialization to begin editing.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
815
  (void)
Jim Blandy's avatar
Jim Blandy committed
816
{
817
  ptrdiff_t count = SPECPDL_INDEX ();
818
  Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
819

820 821
  /* If we enter while input is blocked, don't lock up here.
     This may happen through the debugger during redisplay.  */
822
  if (input_blocked_p ())
823 824
    return Qnil;

Jim Blandy's avatar
Jim Blandy committed
825 826 827
  command_loop_level++;
  update_mode_lines = 1;

828
  if (command_loop_level
829
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
830 831 832 833 834 835 836 837
    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.  */
838 839
  if (command_loop_level > 0)
    temporarily_switch_to_single_kboard (SELECTED_FRAME ());
840
  record_unwind_protect (recursive_edit_unwind, buffer);
841

Jim Blandy's avatar
Jim Blandy committed
842 843 844 845 846