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

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

This file is part of GNU Emacs.

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

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

21
#include <config.h>
Paul Eggert's avatar
Paul Eggert committed
22

23
#define BLOCKINPUT_INLINE EXTERN_INLINE
Paul Eggert's avatar
Paul Eggert committed
24 25
#define KEYBOARD_INLINE EXTERN_INLINE

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

160
struct kboard *echo_kboard;
161

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

165
Lisp_Object echo_message_buffer;
166

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

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

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

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

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

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

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

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

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

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

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

219 220 221 222
/* 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
223 224 225 226 227
   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.  */
228 229
Lisp_Object internal_last_event_frame;

Jim Blandy's avatar
Jim Blandy committed
230 231
/* The timestamp of the last input event we received from the X server.
   X Windows wants this for selection ownership.  */
232
Time last_event_timestamp;
Jim Blandy's avatar
Jim Blandy committed
233

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

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

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

249
static Lisp_Object Qinput_method_function;
250

251
static Lisp_Object Qdeactivate_mark;
252

253 254
Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

255
static Lisp_Object Qecho_area_clear_hook;
256

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

261
static Lisp_Object Qdeferred_action_function;
262

263 264
static Lisp_Object Qdelayed_warnings_hook;

265 266
static Lisp_Object Qinput_method_exit_on_first_char;
static Lisp_Object Qinput_method_use_echo_area;
267

268
static Lisp_Object Qhelp_form_show;
269

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

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

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

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

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

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

310
static Lisp_Object Qmouse_fixup_help_message;
311

Jim Blandy's avatar
Jim Blandy committed
312
/* Symbols to denote kinds of events.  */
313
static Lisp_Object Qfunction_key;
Jim Blandy's avatar
Jim Blandy committed
314
Lisp_Object Qmouse_click;
315
#ifdef HAVE_NTGUI
316
Lisp_Object Qlanguage_change;
317
#ifdef WINDOWSNT
318
Lisp_Object Qfile_w32notify;
319
#endif
320
#endif
321 322
static Lisp_Object Qdrag_n_drop;
static Lisp_Object Qsave_session;
323
#ifdef HAVE_DBUS
324
static Lisp_Object Qdbus_event;
325
#endif
326 327 328
#ifdef HAVE_INOTIFY
static Lisp_Object Qfile_inotify;
#endif /* HAVE_INOTIFY */
329
static Lisp_Object Qconfig_changed_event;
330

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

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

337
/* Menu and tool bar item parts.  */
338 339 340 341 342 343 344 345 346 347
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;
348

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

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

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

373
static void echo_now (void);
374
static ptrdiff_t echo_length (void);
375

376
static Lisp_Object Qpolling_period;
377

378
/* Incremented whenever a timer is run.  */
379
unsigned timers_run;
380

Jim Blandy's avatar
Jim Blandy committed
381 382 383
/* 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
384

385 386 387
/* 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
388 389

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

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

398 399 400 401
/* The time when Emacs started being idle.  */

static EMACS_TIME timer_idleness_start_time;

402 403 404 405 406
/* 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
407 408 409

/* Global variable declarations.  */

410 411 412 413 414
/* 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
415
/* Function for init_keyboard to call with no args (if nonzero).  */
416
static void (*keyboard_init_hook) (void);
Jim Blandy's avatar
Jim Blandy committed
417

418 419
static bool get_input_pending (int);
static bool readable_events (int);
420
static Lisp_Object read_char_x_menu_prompt (ptrdiff_t, Lisp_Object *,
421
                                            Lisp_Object, bool *);
422
static Lisp_Object read_char_minibuf_menu_prompt (int, ptrdiff_t,
423 424 425 426 427
                                                  Lisp_Object *);
static Lisp_Object make_lispy_event (struct input_event *);
static Lisp_Object make_lispy_movement (struct frame *, Lisp_Object,
                                        enum scroll_bar_part,
                                        Lisp_Object, Lisp_Object,
428
					Time);
429
static Lisp_Object modify_event_symbol (ptrdiff_t, int, Lisp_Object,
430
                                        Lisp_Object, const char *const *,
431
                                        Lisp_Object *, ptrdiff_t);
432
static Lisp_Object make_lispy_switch_frame (Lisp_Object);
433
static bool help_char_p (Lisp_Object);
434 435
static void save_getcjmp (sys_jmp_buf);
static void restore_getcjmp (sys_jmp_buf);
436 437 438
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
439
#ifdef USABLE_SIGIO
440
static void deliver_input_available_signal (int signo);
441
#endif
442
static void handle_interrupt (bool);
443
static _Noreturn void quit_throw_to_read_char (bool);
444
static void process_special_events (void);
445 446 447
static void timer_start_idle (void);
static void timer_stop_idle (void);
static void timer_resume_idle (void);
448
static void deliver_user_signal (int);
449
static char *find_user_signal_name (int);
450
static void store_user_signal_events (void);
Jim Blandy's avatar
Jim Blandy committed
451

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

499

Chong Yidong's avatar
Chong Yidong committed
500 501 502
/* Add C to the echo string, without echoing it immediately.  C can be
   a character, which is pretty-printed, or a symbol, whose name is
   printed.  */
Jim Blandy's avatar
Jim Blandy committed
503

504
static void
505
echo_add_key (Lisp_Object c)
Jim Blandy's avatar
Jim Blandy committed
506
{
Chong Yidong's avatar
Chong Yidong committed
507 508 509 510
  int size = KEY_DESCRIPTION_SIZE + 100;
  char *buffer = alloca (size);
  char *ptr = buffer;
  Lisp_Object echo_string;
Jim Blandy's avatar
Jim Blandy committed
511

Chong Yidong's avatar
Chong Yidong committed
512
  echo_string = KVAR (current_kboard, echo_string);
Juanma Barranquero's avatar
Juanma Barranquero committed
513

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

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

      if (size - (ptr - buffer) < nbytes)
Jim Blandy's avatar
Jim Blandy committed
525
	{
Chong Yidong's avatar
Chong Yidong committed
526 527 528 529
	  int offset = ptr - buffer;
	  size = max (2 * size, size + nbytes);
	  buffer = alloca (size);
	  ptr = buffer + offset;
Jim Blandy's avatar
Jim Blandy committed
530
	}
Juanma Barranquero's avatar
Juanma Barranquero committed
531

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

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

Chong Yidong's avatar
Chong Yidong committed
542
      if (size - (ptr - buffer) < len)
Jim Blandy's avatar
Jim Blandy committed
543
	{
Chong Yidong's avatar
Chong Yidong committed
544 545 546 547
	  int offset = ptr - buffer;
	  size += len;
	  buffer = alloca (size);
	  ptr = buffer + offset;
Jim Blandy's avatar
Jim Blandy committed
548 549
	}

Chong Yidong's avatar
Chong Yidong committed
550 551 552
      memcpy (ptr, text, len);
      ptr += len;
    }
553

Chong Yidong's avatar
Chong Yidong committed
554 555 556 557 558
  /* Replace a dash from echo_dash with a space, otherwise add a space
     at the end as a separator between keys.  */
  if (STRINGP (echo_string) && SCHARS (echo_string) > 1)
    {
      Lisp_Object last_char, prev_char, idx;
559

Chong Yidong's avatar
Chong Yidong committed
560 561
      idx = make_number (SCHARS (echo_string) - 2);
      prev_char = Faref (echo_string, idx);
562

Chong Yidong's avatar
Chong Yidong committed
563 564 565 566 567 568 569 570
      idx = make_number (SCHARS (echo_string) - 1);
      last_char = Faref (echo_string, idx);

      /* We test PREV_CHAR to make sure this isn't the echoing of a
	 minus-sign.  */
      if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
	Faset (echo_string, idx, make_number (' '));
      else
571
	echo_string = concat2 (echo_string, build_string (" "));
Chong Yidong's avatar
Chong Yidong committed
572 573 574
    }
  else if (STRINGP (echo_string) && SCHARS (echo_string) > 0)
    echo_string = concat2 (echo_string, build_string (" "));
575

Chong Yidong's avatar
Chong Yidong committed
576 577 578 579 580 581 582
  kset_echo_string
    (current_kboard,
     concat2 (echo_string, make_string (buffer, ptr - buffer)));
}

/* Add C to the echo string, if echoing is going on.  C can be a
   character or a symbol.  */
Jim Blandy's avatar
Jim Blandy committed
583

Chong Yidong's avatar
Chong Yidong committed
584 585 586 587 588
static void
echo_char (Lisp_Object c)
{
  if (current_kboard->immediate_echo)
    {
589
      echo_add_key (c);
590
      echo_now ();
Jim Blandy's avatar
Jim Blandy committed
591 592 593 594
    }
}

/* Temporarily add a dash to the end of the echo string if it's not
Chong Yidong's avatar
Chong Yidong committed
595 596
   empty, so that it serves as a mini-prompt for the very next
   character.  */
Jim Blandy's avatar
Jim Blandy committed
597

598
static void
599
echo_dash (void)
Jim Blandy's avatar
Jim Blandy committed
600
{
601
  /* Do nothing if not echoing at all.  */
602
  if (NILP (KVAR (current_kboard, echo_string)))
603 604
    return;

605 606 607
  if (this_command_key_count == 0)
    return;

608
  if (!current_kboard->immediate_echo
609
      && SCHARS (KVAR (current_kboard, echo_string)) == 0)
Jim Blandy's avatar
Jim Blandy committed
610
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
611

612
  /* Do nothing if we just printed a prompt.  */
613
  if (current_kboard->echo_after_prompt
614
      == SCHARS (KVAR (current_kboard, echo_string)))
615
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
616

617
  /* Do nothing if we have already put a dash at the end.  */
618
  if (SCHARS (KVAR (current_kboard, echo_string)) > 1)
619
    {
620
      Lisp_Object last_char, prev_char, idx;
621

622 623
      idx = make_number (SCHARS (KVAR (current_kboard, echo_string)) - 2);
      prev_char = Faref (KVAR (current_kboard, echo_string), idx);
624

625 626
      idx = make_number (SCHARS (KVAR (current_kboard, echo_string)) - 1);
      last_char = Faref (KVAR (current_kboard, echo_string), idx);
627

628 629
      if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
	return;
630 631
    }

Jim Blandy's avatar
Jim Blandy committed
632 633
  /* 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
634 635 636
  kset_echo_string
    (current_kboard,
     concat2 (KVAR (current_kboard, echo_string), build_string ("-")));
637
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
638 639 640 641 642
}

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

643
static void
644
echo_now (void)
Jim Blandy's avatar
Jim Blandy committed
645
{
646
  if (!current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
647
    {
648
      ptrdiff_t i;
649
      current_kboard->immediate_echo = 1;
Jim Blandy's avatar
Jim Blandy committed
650 651

      for (i = 0; i < this_command_key_count; i++)
652 653
	{
	  Lisp_Object c;
654 655 656 657 658 659 660

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

661
	  c = AREF (this_command_keys, i);
662 663 664 665
	  if (! (EVENT_HAS_PARAMETERS (c)
		 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
	    echo_char (c);
	}
666 667 668 669 670 671 672 673

      /* 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
674 675 676 677
      echo_dash ();
    }

  echoing = 1;
678 679 680
  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
681 682
  echoing = 0;

683 684 685 686
  /* 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
687
  if (waiting_for_input && !NILP (Vquit_flag))
688
    quit_throw_to_read_char (0);
Jim Blandy's avatar
Jim Blandy committed
689 690 691 692
}

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

Andreas Schwab's avatar
Andreas Schwab committed
693
void
694
cancel_echoing (void)
Jim Blandy's avatar
Jim Blandy committed
695
{
696 697
  current_kboard->immediate_echo = 0;
  current_kboard->echo_after_prompt = -1;
Paul Eggert's avatar
Paul Eggert committed
698
  kset_echo_string (current_kboard, Qnil);
699 700 701
  ok_to_echo_at_next_pause = NULL;
  echo_kboard = NULL;
  echo_message_buffer = Qnil;
Jim Blandy's avatar
Jim Blandy committed
702 703 704 705
}

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

706
static ptrdiff_t
707
echo_length (void)
Jim Blandy's avatar
Jim Blandy committed
708
{
709 710
  return (STRINGP (KVAR (current_kboard, echo_string))
	  ? SCHARS (KVAR (current_kboard, echo_string))
711
	  : 0);
Jim Blandy's avatar
Jim Blandy committed
712 713 714 715
}

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

static void
719
echo_truncate (ptrdiff_t nchars)
720
{
721
  if (STRINGP (KVAR (current_kboard, echo_string)))
Paul Eggert's avatar
Paul Eggert committed
722 723 724
    kset_echo_string (current_kboard,
		      Fsubstring (KVAR (current_kboard, echo_string),
				  make_number (0), make_number (nchars)));
725
  truncate_echo_area (nchars);
Jim Blandy's avatar
Jim Blandy committed
726 727 728 729 730
}

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

747
  if (this_command_key_count >= ASIZE (this_command_keys))
748
    this_command_keys = larger_vector (this_command_keys, 1, -1);
749

750
  ASET (this_command_keys, this_command_key_count, key);
751
  ++this_command_key_count;
Jim Blandy's avatar
Jim Blandy committed
752
}
753

Jim Blandy's avatar
Jim Blandy committed
754 755

Lisp_Object
756
recursive_edit_1 (void)
Jim Blandy's avatar
Jim Blandy committed
757
{
758
  ptrdiff_t count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
759 760 761 762 763 764 765 766
  Lisp_Object val;

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

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

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

795
  return unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
796 797 798
}

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

800
void
801
record_auto_save (void)
Jim Blandy's avatar
Jim Blandy committed
802
{
803
  last_auto_save = num_nonmacro_input_events;
Jim Blandy's avatar
Jim Blandy committed
804
}
805 806 807

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

808
#ifdef SIGDANGER
Andreas Schwab's avatar
Andreas Schwab committed
809
void
810
force_auto_save_soon (void)
811 812
{
  last_auto_save = - auto_save_interval - 1;
813 814

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

829 830
  /* If we enter while input is blocked, don't lock up here.
     This may happen through the debugger during redisplay.  */
831
  if (input_blocked_p ())
832 833
    return Qnil;

Jim Blandy's avatar
Jim Blandy committed
834 835 836
  command_loop_level++;
  update_mode_lines = 1;

837
  if (command_loop_level
838
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
839 840 841 842 843 844 845 846
    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.  */
847 848
  if (command_loop_level > 0)
    temporarily_switch_to_single_kboard (SELECTED_FRAME ());
849
  record_unwind_protect (recursive_edit_unwind, buffer);
850

Jim Blandy's avatar
Jim Blandy committed
851 852 853 854 855
  recursive_edit_1 ();
  return unbind_to (count, Qnil);
}

Lisp_Object
856
recursive_edit_unwind (Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
857
{
858 859
  if (BUFFERP (buffer))
    Fset_buffer (buffer);
Juanma Barranquero's avatar
Juanma Barranquero committed
860

Jim Blandy's avatar
Jim Blandy committed
861 862 863 864
  command_loop_level--;
  update_mode_lines = 1;
  return Qnil;
}
865

Jim Blandy's avatar
Jim Blandy committed
866

867
#if 0  /* These two functions are now replaced with
868
          temporarily_switch_to_single_kboard.  */
Karl Heuer's avatar
Karl Heuer committed
869
static void
Richard M. Stallman's avatar