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
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */
69

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

164
struct kboard *echo_kboard;
165

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

169
Lisp_Object echo_message_buffer;
170

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

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

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

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

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

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

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

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

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

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

223 224 225 226 227 228 229
/* 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
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 274 275

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

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

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

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

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

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

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

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

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

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

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

373
static Lisp_Object Qpolling_period;
374

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

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

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

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

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

static EMACS_TIME timer_idleness_start_time;

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

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

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

Paul Eggert's avatar
Paul Eggert committed
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
/* 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;
}

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

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

528
      echo_string = KVAR (current_kboard, echo_string);
Juanma Barranquero's avatar
Juanma Barranquero committed
529

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

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

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

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

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

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

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

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

	  idx = make_number (SCHARS (echo_string) - 2);
	  prev_char = Faref (echo_string, idx);
581 582 583 584

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

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

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

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

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

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

613 614 615
  if (this_command_key_count == 0)
    return;

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

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
640 641
  /* 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
642 643 644
  kset_echo_string
    (current_kboard,
     concat2 (KVAR (current_kboard, echo_string), build_string ("-")));
645
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
646 647 648 649 650
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

755
  if (this_command_key_count >= ASIZE (this_command_keys))
756
    this_command_keys = larger_vector (this_command_keys, 1, -1);
757

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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