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

24
#include <signal.h>
Jim Blandy's avatar
Jim Blandy committed
25
#include <stdio.h>
26
#include <setjmp.h>
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

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

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

66 67 68 69 70
/* This is to get the definitions of the XK_ symbols.  */
#ifdef HAVE_X_WINDOWS
#include "xterm.h"
#endif

71 72 73 74
#ifdef HAVE_NTGUI
#include "w32term.h"
#endif /* HAVE_NTGUI */

75 76 77 78
#ifdef HAVE_NS
#include "nsterm.h"
#endif

79
/* Variables for blockinput.h:  */
80 81

/* Non-zero if interrupt input is blocked right now.  */
82
volatile int interrupt_input_blocked;
83 84 85

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

Chong Yidong's avatar
Chong Yidong committed
88 89 90 91 92
/* 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.  */
93
#ifdef SYNC_INPUT
Chong Yidong's avatar
Chong Yidong committed
94
int pending_signals;
95
#endif
Chong Yidong's avatar
Chong Yidong committed
96

97
#define KBD_BUFFER_SIZE 4096
Jim Blandy's avatar
Jim Blandy committed
98

99 100 101
KBOARD *initial_kboard;
KBOARD *current_kboard;
KBOARD *all_kboards;
102 103 104

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

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

111
#define NUM_RECENT_KEYS (300)
112 113 114 115 116 117 118 119 120

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

122 123 124 125 126 127
/* 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;
128
ptrdiff_t this_command_key_count;
Jim Blandy's avatar
Jim Blandy committed
129

130 131
/* 1 after calling Freset_this_command_lengths.
   Usually it is 0.  */
132
static int this_command_key_count_reset;
133

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

#define GROW_RAW_KEYBUF							\
140
 if (raw_keybuf_count == ASIZE (raw_keybuf))				\
141
   raw_keybuf = larger_vector (raw_keybuf, 1, -1)
142

143 144
/* Number of elements of this_command_keys
   that precede this key sequence.  */
145
static ptrdiff_t this_single_command_key_start;
146

147 148
/* Record values of this_command_key_count and echo_length ()
   before this command was read.  */
149 150
static ptrdiff_t before_command_key_count;
static ptrdiff_t before_command_echo_length;
151

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

Jim Blandy's avatar
Jim Blandy committed
154 155 156 157 158 159
static jmp_buf getcjmp;

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

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

161
static int echoing;
Jim Blandy's avatar
Jim Blandy committed
162

163 164 165 166 167
/* 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;

168 169 170 171
/* 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.  */
172

173
struct kboard *echo_kboard;
174

175 176 177
/* The buffer used for echoing.  Set in echo_now, reset in
   cancel_echoing.  */

178
Lisp_Object echo_message_buffer;
179

180
/* Nonzero means C-g should cause immediate error-signal.  */
Jim Blandy's avatar
Jim Blandy committed
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
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.  */
202
EMACS_INT command_loop_level;
Jim Blandy's avatar
Jim Blandy committed
203

204 205
/* 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
206
   next command input, after any unread_command_events.
207 208 209 210 211

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

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

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

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

221
static EMACS_INT last_auto_save;
Jim Blandy's avatar
Jim Blandy committed
222

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

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

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

232 233 234 235 236 237 238
/* The frame in which the last input event occurred, or Qmacro if the
   last event came from a macro.  We use this to determine when to
   generate switch-frame events.  This may be cleared by functions
   like Fselect_frame, to make sure that a switch-frame event is
   generated by the next character.  */
Lisp_Object internal_last_event_frame;

Jim Blandy's avatar
Jim Blandy committed
239 240
/* The timestamp of the last input event we received from the X server.
   X Windows wants this for selection ownership.  */
241
Time last_event_timestamp;
Jim Blandy's avatar
Jim Blandy committed
242

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

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

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

258
static Lisp_Object Qinput_method_function;
259

260
static Lisp_Object Qdeactivate_mark;
261

262 263
Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

264
static Lisp_Object Qecho_area_clear_hook;
265

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

270
static Lisp_Object Qdeferred_action_function;
271

272 273
static Lisp_Object Qdelayed_warnings_hook;

274 275
static Lisp_Object Qinput_method_exit_on_first_char;
static Lisp_Object Qinput_method_use_echo_area;
276

277
static Lisp_Object Qhelp_form_show;
278

Jim Blandy's avatar
Jim Blandy committed
279
/* File in which we write all commands we read.  */
280
static FILE *dribble;
Jim Blandy's avatar
Jim Blandy committed
281 282 283 284

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

285
/* Circular buffer for pre-read keyboard input.  */
286

287 288 289 290
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.
291
   This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
292 293 294 295 296 297
   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].  */
298
static struct input_event * volatile kbd_store_ptr;
299 300 301 302

/* 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
303
   there is input available if the two pointers are not equal.
304 305 306 307 308

   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
309
/* Symbols to head events.  */
310 311
static Lisp_Object Qmouse_movement;
static Lisp_Object Qscroll_bar_movement;
312
Lisp_Object Qswitch_frame;
313 314 315 316
static Lisp_Object Qdelete_frame;
static Lisp_Object Qiconify_frame;
static Lisp_Object Qmake_frame_visible;
static Lisp_Object Qselect_window;
317
Lisp_Object Qhelp_echo;
318

Nick Roberts's avatar
Nick Roberts committed
319
#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
320
static Lisp_Object Qmouse_fixup_help_message;
321 322
#endif

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

Jim Blandy's avatar
Jim Blandy committed
336 337 338 339
/* Lisp_Object Qmouse_movement; - also an event header */

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

342
/* Menu and tool bar item parts.  */
343 344 345 346 347 348 349 350 351 352
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;
353

354 355 356 357 358 359 360 361 362 363 364
/* 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.  */
365
static Lisp_Object Qmodifier_cache;
366

367
/* Symbols to use for parts of windows.  */
Jim Blandy's avatar
Jim Blandy committed
368
Lisp_Object Qmode_line;
Jim Blandy's avatar
Jim Blandy committed
369
Lisp_Object Qvertical_line;
370
static Lisp_Object Qvertical_scroll_bar;
371 372
Lisp_Object Qmenu_bar;

373 374
static Lisp_Object recursive_edit_unwind (Lisp_Object buffer);
static Lisp_Object command_loop (void);
375
static Lisp_Object Qextended_command_history;
376
EMACS_TIME timer_check (void);
Jim Blandy's avatar
Jim Blandy committed
377

378
static void record_menu_key (Lisp_Object c);
379
static void echo_now (void);
380
static ptrdiff_t echo_length (void);
381

382
static Lisp_Object Qpolling_period;
383

384 385 386
/* Incremented whenever a timer is run.  */
int timers_run;

Jim Blandy's avatar
Jim Blandy committed
387 388 389
/* 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
390 391 392 393 394 395 396 397

/* 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
398
/* Allow configure to inhibit use of FIONREAD.  */
Jim Blandy's avatar
Jim Blandy committed
399 400 401 402 403 404
#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
405
#if !defined (FIONREAD)
Jim Blandy's avatar
Jim Blandy committed
406 407 408 409 410
#ifdef SIGIO
#undef SIGIO
#endif
#endif

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

417 418 419 420
/* The time when Emacs started being idle.  */

static EMACS_TIME timer_idleness_start_time;

421 422 423 424 425
/* 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
426 427 428

/* Global variable declarations.  */

429 430 431 432 433
/* 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
434
/* Function for init_keyboard to call with no args (if nonzero).  */
435
static void (*keyboard_init_hook) (void);
Jim Blandy's avatar
Jim Blandy committed
436

437 438 439
static int read_avail_input (int);
static void get_input_pending (int *, int);
static int readable_events (int);
440
static Lisp_Object read_char_x_menu_prompt (ptrdiff_t, Lisp_Object *,
441
                                            Lisp_Object, int *);
442
static Lisp_Object read_char_minibuf_menu_prompt (int, ptrdiff_t,
443 444
                                                  Lisp_Object *);
static Lisp_Object make_lispy_event (struct input_event *);
Nick Roberts's avatar
Nick Roberts committed
445
#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
446 447 448
static Lisp_Object make_lispy_movement (struct frame *, Lisp_Object,
                                        enum scroll_bar_part,
                                        Lisp_Object, Lisp_Object,
449
					Time);
450
#endif
451
static Lisp_Object modify_event_symbol (ptrdiff_t, int, Lisp_Object,
452
                                        Lisp_Object, const char *const *,
453
                                        Lisp_Object *, ptrdiff_t);
454
static Lisp_Object make_lispy_switch_frame (Lisp_Object);
455
static int help_char_p (Lisp_Object);
456 457 458 459 460
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);
461
static void interrupt_signal (int signalnum);
462
#ifdef SIGIO
463
static void input_available_signal (int signo);
464
#endif
465
static void handle_interrupt (void);
466
static _Noreturn void quit_throw_to_read_char (int);
467
static void process_special_events (void);
468 469 470
static void timer_start_idle (void);
static void timer_stop_idle (void);
static void timer_resume_idle (void);
471
static void handle_user_signal (int);
472 473
static char *find_user_signal_name (int);
static int store_user_signal_events (void);
Jim Blandy's avatar
Jim Blandy committed
474

Paul Eggert's avatar
Paul Eggert committed
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 511 512 513 514 515 516 517 518 519 520 521
/* 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;
}

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

527
static void
528
echo_char (Lisp_Object c)
Jim Blandy's avatar
Jim Blandy committed
529
{
530
  if (current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
531
    {
532
      int size = KEY_DESCRIPTION_SIZE + 100;
533
      char *buffer = alloca (size);
534 535
      char *ptr = buffer;
      Lisp_Object echo_string;
Jim Blandy's avatar
Jim Blandy committed
536

537
      echo_string = KVAR (current_kboard, echo_string);
Juanma Barranquero's avatar
Juanma Barranquero committed
538

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

542
      if (INTEGERP (c))
Jim Blandy's avatar
Jim Blandy committed
543
	{
544
	  ptr = push_key_description (XINT (c), ptr, 1);
Jim Blandy's avatar
Jim Blandy committed
545
	}
546
      else if (SYMBOLP (c))
Jim Blandy's avatar
Jim Blandy committed
547
	{
548 549
	  Lisp_Object name = SYMBOL_NAME (c);
	  int nbytes = SBYTES (name);
Juanma Barranquero's avatar
Juanma Barranquero committed
550

551
	  if (size - (ptr - buffer) < nbytes)
552 553
	    {
	      int offset = ptr - buffer;
554
	      size = max (2 * size, size + nbytes);
555
	      buffer = alloca (size);
556 557 558
	      ptr = buffer + offset;
	    }

559
	  ptr += copy_text (SDATA (name), (unsigned char *) ptr, nbytes,
560
			    STRING_MULTIBYTE (name), 1);
Jim Blandy's avatar
Jim Blandy committed
561 562
	}

563
      if ((NILP (echo_string) || SCHARS (echo_string) == 0)
Karl Heuer's avatar
Karl Heuer committed
564
	  && help_char_p (c))
Jim Blandy's avatar
Jim Blandy committed
565
	{
566 567
	  const char *text = " (Type ? for further options)";
	  int len = strlen (text);
Juanma Barranquero's avatar
Juanma Barranquero committed
568

569 570 571 572
	  if (size - (ptr - buffer) < len)
	    {
	      int offset = ptr - buffer;
	      size += len;
573
	      buffer = alloca (size);
574 575 576
	      ptr = buffer + offset;
	    }

577
	  memcpy (ptr, text, len);
578
	  ptr += len;
Jim Blandy's avatar
Jim Blandy committed
579 580
	}

581 582
      /* Replace a dash from echo_dash with a space, otherwise
	 add a space at the end as a separator between keys.  */
583
      if (STRINGP (echo_string)
584
	  && SCHARS (echo_string) > 1)
585
	{
586 587 588 589
	  Lisp_Object last_char, prev_char, idx;

	  idx = make_number (SCHARS (echo_string) - 2);
	  prev_char = Faref (echo_string, idx);
590 591 592 593

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

594 595 596
	  /* We test PREV_CHAR to make sure this isn't the echoing
	     of a minus-sign.  */
	  if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
597 598 599 600
	    Faset (echo_string, idx, make_number (' '));
	  else
	    echo_string = concat2 (echo_string, build_string (" "));
	}
601 602
      else if (STRINGP (echo_string))
	echo_string = concat2 (echo_string, build_string (" "));
603

Paul Eggert's avatar
Paul Eggert committed
604 605 606
      kset_echo_string
	(current_kboard,
	 concat2 (echo_string, make_string (buffer, ptr - buffer)));
Jim Blandy's avatar
Jim Blandy committed
607

608
      echo_now ();
Jim Blandy's avatar
Jim Blandy committed
609 610 611 612 613 614
    }
}

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

615
static void
616
echo_dash (void)
Jim Blandy's avatar
Jim Blandy committed
617
{
618
  /* Do nothing if not echoing at all.  */
619
  if (NILP (KVAR (current_kboard, echo_string)))
620 621
    return;

622 623 624
  if (this_command_key_count == 0)
    return;

625
  if (!current_kboard->immediate_echo
626
      && SCHARS (KVAR (current_kboard, echo_string)) == 0)
Jim Blandy's avatar
Jim Blandy committed
627
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
628

629
  /* Do nothing if we just printed a prompt.  */
630
  if (current_kboard->echo_after_prompt
631
      == SCHARS (KVAR (current_kboard, echo_string)))
632
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
633

634
  /* Do nothing if we have already put a dash at the end.  */
635
  if (SCHARS (KVAR (current_kboard, echo_string)) > 1)
636
    {
637
      Lisp_Object last_char, prev_char, idx;
638

639 640
      idx = make_number (SCHARS (KVAR (current_kboard, echo_string)) - 2);
      prev_char = Faref (KVAR (current_kboard, echo_string), idx);
641

642 643
      idx = make_number (SCHARS (KVAR (current_kboard, echo_string)) - 1);
      last_char = Faref (KVAR (current_kboard, echo_string), idx);
644

645 646
      if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
	return;
647 648
    }

Jim Blandy's avatar
Jim Blandy committed
649 650
  /* 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
651 652 653
  kset_echo_string
    (current_kboard,
     concat2 (KVAR (current_kboard, echo_string), build_string ("-")));
654
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
655 656 657 658 659
}

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

660
static void
661
echo_now (void)
Jim Blandy's avatar
Jim Blandy committed
662
{
663
  if (!current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
664
    {
665
      ptrdiff_t i;
666
      current_kboard->immediate_echo = 1;
Jim Blandy's avatar
Jim Blandy committed
667 668

      for (i = 0; i < this_command_key_count; i++)
669 670
	{
	  Lisp_Object c;
671 672 673 674 675 676 677

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

678
	  c = AREF (this_command_keys, i);
679 680 681 682
	  if (! (EVENT_HAS_PARAMETERS (c)
		 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
	    echo_char (c);
	}
683 684 685 686 687 688 689 690

      /* 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
691 692 693 694
      echo_dash ();
    }

  echoing = 1;
695 696 697
  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
698 699
  echoing = 0;

700 701 702 703
  /* 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
704
  if (waiting_for_input && !NILP (Vquit_flag))
705
    quit_throw_to_read_char (0);
Jim Blandy's avatar
Jim Blandy committed
706 707 708 709
}

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

Andreas Schwab's avatar
Andreas Schwab committed
710
void
711
cancel_echoing (void)
Jim Blandy's avatar
Jim Blandy committed
712
{
713 714
  current_kboard->immediate_echo = 0;
  current_kboard->echo_after_prompt = -1;
Paul Eggert's avatar
Paul Eggert committed
715
  kset_echo_string (current_kboard, Qnil);
716 717 718
  ok_to_echo_at_next_pause = NULL;
  echo_kboard = NULL;
  echo_message_buffer = Qnil;
Jim Blandy's avatar
Jim Blandy committed
719 720 721 722
}

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

723
static ptrdiff_t
724
echo_length (void)
Jim Blandy's avatar
Jim Blandy committed
725
{
726 727
  return (STRINGP (KVAR (current_kboard, echo_string))
	  ? SCHARS (KVAR (current_kboard, echo_string))
728
	  : 0);
Jim Blandy's avatar
Jim Blandy committed
729 730 731 732
}

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

static void
736
echo_truncate (ptrdiff_t nchars)
737
{
738
  if (STRINGP (KVAR (current_kboard, echo_string)))
Paul Eggert's avatar
Paul Eggert committed
739 740 741
    kset_echo_string (current_kboard,
		      Fsubstring (KVAR (current_kboard, echo_string),
				  make_number (0), make_number (nchars)));
742
  truncate_echo_area (nchars);
Jim Blandy's avatar
Jim Blandy committed
743 744 745 746 747
}


/* Functions for manipulating this_command_keys.  */
static void
748
add_command_key (Lisp_Object key)
Jim Blandy's avatar
Jim Blandy committed
749
{
750 751
#if 0 /* Not needed after we made Freset_this_command_lengths
	 do the job immediately.  */
752 753 754 755 756
  /* 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;
757 758
      if (this_command_key_count < this_single_command_key_start)
	this_single_command_key_start = this_command_key_count;
759 760 761
      echo_truncate (before_command_echo_length_1);
      before_command_restore_flag = 0;
    }
762
#endif
763

764
  if (this_command_key_count >= ASIZE (this_command_keys))
765
    this_command_keys = larger_vector (this_command_keys, 1, -1);
766

767
  ASET (this_command_keys, this_command_key_count, key);
768
  ++this_command_key_count;
Jim Blandy's avatar
Jim Blandy committed
769
}
770

Jim Blandy's avatar
Jim Blandy committed
771 772

Lisp_Object
773
recursive_edit_1 (void)
Jim Blandy's avatar
Jim Blandy committed
774
{
775
  ptrdiff_t count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
776 777 778 779 780 781 782 783
  Lisp_Object val;

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

784
#ifdef HAVE_WINDOW_SYSTEM
785
  /* The command loop has started an hourglass timer, so we have to
786
     cancel it here, otherwise it will fire because the recursive edit
787 788
     can take some time.  Do not check for display_hourglass_p here,
     because it could already be nil.  */
789
    cancel_hourglass ();
790 791
#endif

792 793 794 795 796 797 798 799 800 801 802 803
  /* 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
804 805 806
  val = command_loop ();
  if (EQ (val, Qt))
    Fsignal (Qquit, Qnil);
807 808 809
  /* Handle throw from read_minibuf when using minibuffer
     while it's active but we're in another window.  */
  if (STRINGP (val))
810
    xsignal1 (Qerror, val);
Jim Blandy's avatar
Jim Blandy committed
811

812
  return unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
813 814 815
}

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

817
void
818
record_auto_save (void)
Jim Blandy's avatar
Jim Blandy committed
819
{
820
  last_auto_save = num_nonmacro_input_events;
Jim Blandy's avatar
Jim Blandy committed
821
}
822 823 824

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

825
#ifdef SIGDANGER
Andreas Schwab's avatar
Andreas Schwab committed
826
void
827
force_auto_save_soon (void)
828 829
{
  last_auto_save = - auto_save_interval - 1;
830 831

  record_asynch_buffer_change ();
832
}
833
#endif
Jim Blandy's avatar
Jim Blandy committed
834

Paul Eggert's avatar
Paul Eggert committed
835
DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
836 837 838
       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.
839
Alternatively, `(throw 'exit t)' makes this function signal an error.
840
This function is called by the editor initialization to begin editing.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
841
  (void)
Jim Blandy's avatar
Jim Blandy committed
842
{
843
  ptrdiff_t count = SPECPDL_INDEX ();
844
  Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
845

846 847 848 849 850
  /* 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
851 852 853
  command_loop_level++;
  update_mode_lines = 1;

854
  if (command_loop_level
855
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
856 857 858 859 860 861 862 863
    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.  */
864 865
  if (command_loop_level > 0)
    temporarily_switch_to_single_kboard (SELECTED_FRAME ());
866
  record_unwind_protect (recursive_edit_unwind, buffer);
867

Jim Blandy's avatar
Jim Blandy committed
868 869 870 871 872
  recursive_edit_1 ();
  return unbind_to (count, Qnil);
}

Lisp_Object
873
recursive_edit_unwind (Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
874
{
875 876
  if (BUFFERP (buffer))
    Fset_buffer (buffer);
Juanma Barranquero's avatar
Juanma Barranquero committed
877

Jim Blandy's avatar
Jim Blandy committed
878 879 880 881
  command_loop_level--;
  update_mode_lines = 1;
  return Qnil;
}
882

Jim Blandy's avatar
Jim Blandy committed
883

884
#if 0  /* These two functions are now replaced with
885
          temporarily_switch_to_single_kboard.  */
Karl Heuer's avatar
Karl Heuer committed
886
static void
887
any_kboard_state ()
Karl Heuer's avatar
Karl Heuer committed
888
{
889 890 891 892
#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
893
  if (CONSP (Vunread_command_events))
894
    {
895 896 897
      current_kboard->kbd_queue
	= nconc2 (Vunread_command_events, current_kboard->kbd_queue);
      current_kboard->kbd_queue_has_data = 1;