callint.c 30.3 KB
Newer Older
Michael I. Bushnell's avatar
Michael I. Bushnell committed
1
/* Call a Lisp function interactively.
2
   Copyright (C) 1985, 1986, 1993, 1994, 1995, 1997, 2000, 2001, 2002,
Glenn Morris's avatar
Glenn Morris committed
3
                 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
Glenn Morris's avatar
Glenn Morris committed
4
                 Free Software Foundation, Inc.
Michael I. Bushnell's avatar
Michael I. Bushnell committed
5 6 7

This file is part of GNU Emacs.

8
GNU Emacs is free software: you can redistribute it and/or modify
Michael I. Bushnell's avatar
Michael I. Bushnell 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.
Michael I. Bushnell's avatar
Michael I. Bushnell 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/>.  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
20 21


22
#include <config.h>
23
#include <setjmp.h>
24

Michael I. Bushnell's avatar
Michael I. Bushnell committed
25 26 27
#include "lisp.h"
#include "buffer.h"
#include "commands.h"
Jim Blandy's avatar
Jim Blandy committed
28
#include "keyboard.h"
Michael I. Bushnell's avatar
Michael I. Bushnell committed
29
#include "window.h"
Stefan Monnier's avatar
Stefan Monnier committed
30
#include "keymap.h"
Michael I. Bushnell's avatar
Michael I. Bushnell committed
31

Gerd Moellmann's avatar
Gerd Moellmann committed
32 33
#ifdef HAVE_INDEX
extern char *index P_ ((const char *, int));
34
#endif
Michael I. Bushnell's avatar
Michael I. Bushnell committed
35

36
extern Lisp_Object Qcursor_in_echo_area;
37
extern Lisp_Object Qfile_directory_p;
38
extern Lisp_Object Qonly;
39

40
Lisp_Object Vcurrent_prefix_arg, Qminus, Qplus;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
41 42 43
Lisp_Object Qcall_interactively;
Lisp_Object Vcommand_history;

44
extern Lisp_Object Vhistory_length;
45
extern Lisp_Object Vthis_original_command, real_this_command;
46
extern int history_delete_duplicates;
47

Michael I. Bushnell's avatar
Michael I. Bushnell committed
48
Lisp_Object Vcommand_debug_status, Qcommand_debug_status;
Richard M. Stallman's avatar
Richard M. Stallman committed
49
Lisp_Object Qenable_recursive_minibuffers;
50
extern Lisp_Object Qface, Qminibuffer_prompt;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
51

52 53 54 55
/* Non-nil means treat the mark as active
   even if mark_active is 0.  */
Lisp_Object Vmark_even_if_inactive;

56
Lisp_Object Qhandle_shift_selection;
Chong Yidong's avatar
Chong Yidong committed
57

58 59
Lisp_Object Vmouse_leave_buffer_hook, Qmouse_leave_buffer_hook;

60
Lisp_Object Qlist, Qlet, Qletx, Qsave_excursion, Qprogn, Qif, Qwhen;
61 62 63 64
static Lisp_Object preserved_fns;

/* Marker used within call-interactively to refer to point.  */
static Lisp_Object point_marker;
65

66 67
/* String for the prompt text used in Fcall_interactively.  */
static Lisp_Object callint_message;
Richard M. Stallman's avatar
Richard M. Stallman committed
68

Michael I. Bushnell's avatar
Michael I. Bushnell committed
69 70
/* ARGSUSED */
DEFUN ("interactive", Finteractive, Sinteractive, 0, UNEVALLED, 0,
71 72
       doc: /* Specify a way of parsing arguments for interactive use of a function.
For example, write
73 74 75
 (defun foo (arg buf) "Doc string" (interactive "P\\nbbuffer: ") .... )
 to make ARG be the raw prefix argument, and set BUF to an existing buffer,
 when `foo' is called as a command.
76 77 78 79 80
The "call" to `interactive' is actually a declaration rather than a function;
 it tells `call-interactively' how to read arguments
 to pass to the function.
When actually called, `interactive' just returns nil.

81 82 83 84 85
Usually the argument of `interactive' is a string containing a code letter
 followed optionally by a prompt.  (Some code letters do not use I/O to get
 the argument and do not use prompts.)  To get several arguments, concatenate
 the individual strings, separating them by newline characters.
Prompts are passed to format, and may use % escapes to print the
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
 arguments that have already been read.
If the argument is not a string, it is evaluated to get a list of
 arguments to pass to the function.
Just `(interactive)' means pass no args when calling interactively.

Code letters available are:
a -- Function name: symbol with a function definition.
b -- Name of existing buffer.
B -- Name of buffer, possibly nonexistent.
c -- Character (no input method is used).
C -- Command name: symbol with interactive function definition.
d -- Value of point as number.  Does not do I/O.
D -- Directory name.
e -- Parametrized event (i.e., one that's a list) that invoked this command.
     If used more than once, the Nth `e' returns the Nth parameterized event.
     This skips events that are integers or symbols.
f -- Existing file name.
F -- Possibly nonexistent file name.
104
G -- Possibly nonexistent file name, defaulting to just directory name.
105 106 107 108 109 110
i -- Ignored, i.e. always nil.  Does not do I/O.
k -- Key sequence (downcase the last event if needed to get a definition).
K -- Key sequence to be redefined (do not downcase the last event).
m -- Value of mark as number.  Does not do I/O.
M -- Any string.  Inherits the current input method.
n -- Number read using minibuffer.
Richard M. Stallman's avatar
Richard M. Stallman committed
111
N -- Numeric prefix arg, or if none, do like code `n'.
112 113 114 115 116
p -- Prefix arg converted to number.  Does not do I/O.
P -- Prefix arg in raw form.  Does not do I/O.
r -- Region: point and mark as 2 numeric args, smallest first.  Does no I/O.
s -- Any string.  Does not inherit the current input method.
S -- Any symbol.
117
U -- Mouse up event discarded by a previous k or K argument.
118 119 120 121 122
v -- Variable name: symbol that is user-variable-p.
x -- Lisp expression read but not evaluated.
X -- Lisp expression read and evaluated.
z -- Coding system.
Z -- Coding system, nil if no prefix arg.
Chong Yidong's avatar
Chong Yidong committed
123 124 125 126 127 128 129 130 131 132

In addition, if the string begins with `*', an error is signaled if
  the buffer is read-only.
If the string begins with `@', Emacs searches the key sequence which
 invoked the command for its first mouse click (or any other event
 which specifies a window).
If the string begins with `^' and `shift-select-mode' is non-nil,
 Emacs first calls the function `handle-shift-select'.
You may use `@', `*', and `^' together.  They are processed in the
 order that they appear, before reading any arguments.
Glenn Morris's avatar
Glenn Morris committed
133
usage: (interactive &optional ARGS)  */)
134
     (args)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
135 136 137 138 139 140 141 142 143 144 145
     Lisp_Object args;
{
  return Qnil;
}

/* Quotify EXP: if EXP is constant, return it.
   If EXP is not constant, return (quote EXP).  */
Lisp_Object
quotify_arg (exp)
     register Lisp_Object exp;
{
146
  if (!INTEGERP (exp) && !STRINGP (exp)
Jim Blandy's avatar
Jim Blandy committed
147
      && !NILP (exp) && !EQ (exp, Qt))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
148 149 150 151 152 153 154 155 156 157 158
    return Fcons (Qquote, Fcons (exp, Qnil));

  return exp;
}

/* Modify EXP by quotifying each element (except the first).  */
Lisp_Object
quotify_args (exp)
     Lisp_Object exp;
{
  register Lisp_Object tail;
159 160
  Lisp_Object next;
  for (tail = exp; CONSP (tail); tail = next)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
161
    {
162
      next = XCDR (tail);
163
      XSETCAR (tail, quotify_arg (XCAR (tail)));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
164 165 166 167 168 169 170 171
    }
  return exp;
}

char *callint_argfuns[]
    = {"", "point", "mark", "region-beginning", "region-end"};

static void
172 173
check_mark (for_region)
     int for_region;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
174
{
175 176
  Lisp_Object tem;
  tem = Fmarker_buffer (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
177
  if (NILP (tem) || (XBUFFER (tem) != current_buffer))
178 179
    error (for_region ? "The mark is not set now, so there is no region"
	   : "The mark is not set now");
180 181
  if (!NILP (Vtransient_mark_mode) && NILP (Vmark_even_if_inactive)
      && NILP (current_buffer->mark_active))
Kim F. Storm's avatar
Kim F. Storm committed
182
    xsignal0 (Qmark_inactive);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
183 184
}

Richard M. Stallman's avatar
Richard M. Stallman committed
185 186 187 188 189 190 191 192
/* If the list of args INPUT was produced with an explicit call to
   `list', look for elements that were computed with
   (region-beginning) or (region-end), and put those expressions into
   VALUES instead of the present values.

   This function doesn't return a value because it modifies elements
   of VALUES to do its job.  */

193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
static void
fix_command (input, values)
     Lisp_Object input, values;
{
  if (CONSP (input))
    {
      Lisp_Object car;

      car = XCAR (input);
      /* Skip through certain special forms.  */
      while (EQ (car, Qlet) || EQ (car, Qletx)
	     || EQ (car, Qsave_excursion)
	     || EQ (car, Qprogn))
	{
	  while (CONSP (XCDR (input)))
	    input = XCDR (input);
	  input = XCAR (input);
	  if (!CONSP (input))
	    break;
	  car = XCAR (input);
	}
      if (EQ (car, Qlist))
	{
	  Lisp_Object intail, valtail;
	  for (intail = Fcdr (input), valtail = values;
	       CONSP (valtail);
Stefan Monnier's avatar
Stefan Monnier committed
219
	       intail = Fcdr (intail), valtail = XCDR (valtail))
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
	    {
	      Lisp_Object elt;
	      elt = Fcar (intail);
	      if (CONSP (elt))
		{
		  Lisp_Object presflag, carelt;
		  carelt = Fcar (elt);
		  /* If it is (if X Y), look at Y.  */
		  if (EQ (carelt, Qif)
		      && EQ (Fnthcdr (make_number (3), elt), Qnil))
		    elt = Fnth (make_number (2), elt);
		  /* If it is (when ... Y), look at Y.  */
		  else if (EQ (carelt, Qwhen))
		    {
		      while (CONSP (XCDR (elt)))
			elt = XCDR (elt);
		      elt = Fcar (elt);
		    }

		  /* If the function call we're looking at
		     is a special preserved one, copy the
		     whole expression for this argument.  */
		  if (CONSP (elt))
		    {
		      presflag = Fmemq (Fcar (elt), preserved_fns);
		      if (!NILP (presflag))
			Fsetcar (valtail, Fcar (intail));
		    }
		}
	    }
	}
    }
}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
253

254
DEFUN ("call-interactively", Fcall_interactively, Scall_interactively, 1, 3, 0,
255 256 257 258 259 260 261 262 263 264
       doc: /* Call FUNCTION, reading args according to its interactive calling specs.
Return the value FUNCTION returns.
The function contains a specification of how to do the argument reading.
In the case of user-defined functions, this is specified by placing a call
to the function `interactive' at the top level of the function body.
See `interactive'.

Optional second arg RECORD-FLAG non-nil
means unconditionally put this command in the command-history.
Otherwise, this is done only if an arg is read using the minibuffer.
265

266
Optional third arg KEYS, if given, specifies the sequence of events to
267 268 269
supply, as a vector, if the command inquires which events were used to
invoke it.  If KEYS is omitted or nil, the return value of
`this-command-keys-vector' is used.  */)
270
     (function, record_flag, keys)
271
     Lisp_Object function, record_flag, keys;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
272 273 274
{
  Lisp_Object *args, *visargs;
  Lisp_Object specs;
275
  Lisp_Object filter_specs;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
276
  Lisp_Object teml;
277
  Lisp_Object up_event;
Richard M. Stallman's avatar
Richard M. Stallman committed
278
  Lisp_Object enable;
Juanma Barranquero's avatar
Juanma Barranquero committed
279
  int speccount = SPECPDL_INDEX ();
Michael I. Bushnell's avatar
Michael I. Bushnell committed
280

281 282
  /* The index of the next element of this_command_keys to examine for
     the 'e' interactive code.  */
Jim Blandy's avatar
Jim Blandy committed
283
  int next_event;
284

Michael I. Bushnell's avatar
Michael I. Bushnell committed
285 286 287
  Lisp_Object prefix_arg;
  unsigned char *string;
  unsigned char *tem;
Jim Blandy's avatar
Jim Blandy committed
288 289 290 291

  /* If varies[i] > 0, the i'th argument shouldn't just have its value
     in this call quoted in the command history.  It should be
     recorded as a call to the function named callint_argfuns[varies[i]].  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
292
  int *varies;
Jim Blandy's avatar
Jim Blandy committed
293

Michael I. Bushnell's avatar
Michael I. Bushnell committed
294 295 296 297 298
  register int i, j;
  int count, foo;
  char prompt1[100];
  char *tem1;
  int arg_from_tty = 0;
299
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
300
  int key_count;
301
  int record_then_fail = 0;
302

303 304 305 306 307 308 309 310
  Lisp_Object save_this_command, save_last_command;
  Lisp_Object save_this_original_command, save_real_this_command;

  save_this_command = Vthis_command;
  save_this_original_command = Vthis_original_command;
  save_real_this_command = real_this_command;
  save_last_command = current_kboard->Vlast_command;

311 312 313 314
  if (NILP (keys))
    keys = this_command_keys, key_count = this_command_key_count;
  else
    {
315
      CHECK_VECTOR (keys);
316 317
      key_count = XVECTOR (keys)->size;
    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
318

Jim Blandy's avatar
Jim Blandy committed
319
  /* Save this now, since use of minibuffer will clobber it. */
320
  prefix_arg = Vcurrent_prefix_arg;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
321

322
  if (SYMBOLP (function))
323
    enable = Fget (function, Qenable_recursive_minibuffers);
324 325
  else
    enable = Qnil;
Richard M. Stallman's avatar
Richard M. Stallman committed
326

Michael I. Bushnell's avatar
Michael I. Bushnell committed
327 328
  specs = Qnil;
  string = 0;
329 330 331 332
  /* The idea of FILTER_SPECS is to provide away to
     specify how to represent the arguments in command history.
     The feature is not fully implemented.  */
  filter_specs = Qnil;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
333

334 335 336
  /* If k or K discard an up-event, save it here so it can be retrieved with U */
  up_event = Qnil;

337
  /* Set SPECS to the interactive form, or barf if not interactive.  */
338 339 340 341 342 343 344 345 346 347
  {
    Lisp_Object form;
    GCPRO2 (function, prefix_arg);
    form = Finteractive_form (function);
    UNGCPRO;
    if (CONSP (form))
      specs = filter_specs = Fcar (XCDR (form));
    else
      wrong_type_argument (Qcommandp, function);
  }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
348

349
  /* If SPECS is set to a string, use it as an interactive prompt.  */
350
  if (STRINGP (specs))
Jim Blandy's avatar
Jim Blandy committed
351 352 353
    {
      /* Make a copy of string so that if a GC relocates specs,
	 `string' will still be valid.  */
354 355 356
      string = (unsigned char *) alloca (SBYTES (specs) + 1);
      bcopy (SDATA (specs), string,
	     SBYTES (specs) + 1);
Jim Blandy's avatar
Jim Blandy committed
357
    }
358
  else
Michael I. Bushnell's avatar
Michael I. Bushnell committed
359
    {
360
      Lisp_Object input;
361
      i = num_input_events;
362 363
      input = specs;
      /* Compute the arg values using the user's expression.  */
364
      GCPRO2 (input, filter_specs);
365
      specs = Feval (specs);
366
      UNGCPRO;
367
      if (i != num_input_events || !NILP (record_flag))
368 369
	{
	  /* We should record this command on the command history.  */
370
	  Lisp_Object values;
371
	  Lisp_Object this_cmd;
372 373 374
	  /* Make a copy of the list of values, for the command history,
	     and turn them into things we can eval.  */
	  values = quotify_args (Fcopy_sequence (specs));
375
	  fix_command (input, values);
376 377 378 379
	  this_cmd = Fcons (function, values);
	  if (history_delete_duplicates)
	    Vcommand_history = Fdelete (this_cmd, Vcommand_history);
	  Vcommand_history = Fcons (this_cmd, Vcommand_history);
380 381

	  /* Don't keep command history around forever.  */
382
	  if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
383 384 385
	    {
	      teml = Fnthcdr (Vhistory_length, Vcommand_history);
	      if (CONSP (teml))
386
		XSETCDR (teml, Qnil);
387
	    }
388
	}
389 390 391 392 393 394

      Vthis_command = save_this_command;
      Vthis_original_command = save_this_original_command;
      real_this_command= save_real_this_command;
      current_kboard->Vlast_command = save_last_command;

395 396
      temporarily_switch_to_single_kboard (NULL);
      return unbind_to (speccount, apply1 (function, specs));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
397 398 399 400
    }

  /* Here if function specifies a string to control parsing the defaults */

Jim Blandy's avatar
Jim Blandy committed
401
  /* Set next_event to point to the first event with parameters.  */
402
  for (next_event = 0; next_event < key_count; next_event++)
403
    if (EVENT_HAS_PARAMETERS (AREF (keys, next_event)))
Jim Blandy's avatar
Jim Blandy committed
404
      break;
405

406
  /* Handle special starting chars `*' and `@'.  Also `-'.  */
407
  /* Note that `+' is reserved for user extensions.  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
408 409
  while (1)
    {
410
      if (*string == '+')
411 412
	error ("`+' is not used in `interactive' for ordinary commands");
      else if (*string == '*')
Michael I. Bushnell's avatar
Michael I. Bushnell committed
413 414
	{
	  string++;
Jim Blandy's avatar
Jim Blandy committed
415
	  if (!NILP (current_buffer->read_only))
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
	    {
	      if (!NILP (record_flag))
		{
		  unsigned char *p = string;
		  while (*p)
		    {
		      if (! (*p == 'r' || *p == 'p' || *p == 'P'
			     || *p == '\n'))
			Fbarf_if_buffer_read_only ();
		      p++;
		    }
		  record_then_fail = 1;
		}
	      else
		Fbarf_if_buffer_read_only ();
	    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
432
	}
433 434 435
      /* Ignore this for semi-compatibility with Lucid.  */
      else if (*string == '-')
	string++;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
436 437
      else if (*string == '@')
	{
438
	  Lisp_Object event, tem;
Jim Blandy's avatar
Jim Blandy committed
439

440
	  event = (next_event < key_count
441
		   ? AREF (keys, next_event)
442
		   : Qnil);
Jim Blandy's avatar
Jim Blandy committed
443
	  if (EVENT_HAS_PARAMETERS (event)
444 445 446
	      && (tem = XCDR (event), CONSP (tem))
	      && (tem = XCAR (tem), CONSP (tem))
	      && (tem = XCAR (tem), WINDOWP (tem)))
447
	    {
448 449
	      if (MINI_WINDOW_P (XWINDOW (tem))
		  && ! (minibuf_level > 0 && EQ (tem, minibuf_window)))
450
		error ("Attempt to select inactive minibuffer window");
451 452 453 454 455

	      /* If the current buffer wants to clean up, let it.  */
	      if (!NILP (Vmouse_leave_buffer_hook))
		call1 (Vrun_hooks, Qmouse_leave_buffer_hook);

456
	      Fselect_window (tem, Qnil);
457
	    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
458 459
	  string++;
	}
Chong Yidong's avatar
Chong Yidong committed
460 461
      else if (*string == '^')
	{
462
	  call0 (Qhandle_shift_selection);
Chong Yidong's avatar
Chong Yidong committed
463 464
	  string++;
	}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
465 466 467 468 469 470
      else break;
    }

  /* Count the number of arguments the interactive spec would have
     us give to the function.  */
  tem = string;
471
  for (j = 0; *tem;)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
472 473 474
    {
      /* 'r' specifications ("point and mark as 2 numeric args")
	 produce *two* arguments.  */
475 476 477 478
      if (*tem == 'r')
	j += 2;
      else
	j++;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
479 480
      tem = (unsigned char *) index (tem, '\n');
      if (tem)
481
	++tem;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
482
      else
483
	break;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
484
    }
485
  count = j;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
486 487 488 489 490 491 492 493 494 495 496 497

  args = (Lisp_Object *) alloca ((count + 1) * sizeof (Lisp_Object));
  visargs = (Lisp_Object *) alloca ((count + 1) * sizeof (Lisp_Object));
  varies = (int *) alloca ((count + 1) * sizeof (int));

  for (i = 0; i < (count + 1); i++)
    {
      args[i] = Qnil;
      visargs[i] = Qnil;
      varies[i] = 0;
    }

498
  GCPRO5 (prefix_arg, function, *args, *visargs, up_event);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
499 500 501
  gcpro3.nvars = (count + 1);
  gcpro4.nvars = (count + 1);

Richard M. Stallman's avatar
Richard M. Stallman committed
502 503 504
  if (!NILP (enable))
    specbind (Qenable_recursive_minibuffers, Qt);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
505
  tem = string;
506
  for (i = 1; *tem; i++)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
507 508 509
    {
      strncpy (prompt1, tem + 1, sizeof prompt1 - 1);
      prompt1[sizeof prompt1 - 1] = 0;
510
      tem1 = (char *) index (prompt1, '\n');
Michael I. Bushnell's avatar
Michael I. Bushnell committed
511
      if (tem1) *tem1 = 0;
512 513 514 515 516 517

      visargs[0] = build_string (prompt1);
      if (index (prompt1, '%'))
	callint_message = Fformat (i, visargs);
      else
	callint_message = visargs[0];
Michael I. Bushnell's avatar
Michael I. Bushnell committed
518 519 520 521

      switch (*tem)
	{
	case 'a':		/* Symbol defined as a function */
522
	  visargs[i] = Fcompleting_read (callint_message,
523
					 Vobarray, Qfboundp, Qt,
524
					 Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
525 526 527 528 529 530
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = visargs[i];
	  args[i] = Fintern (teml, Qnil);
	  break;

	case 'b':   		/* Name of existing buffer */
531 532 533 534 535 536
	  args[i] = Fcurrent_buffer ();
	  if (EQ (selected_window, minibuf_window))
	    args[i] = Fother_buffer (args[i], Qnil, Qnil);
	  args[i] = Fread_buffer (callint_message, args[i], Qt);
	  break;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
537
	case 'B':		/* Name of buffer, possibly nonexistent */
538 539 540
	  args[i] = Fread_buffer (callint_message,
				  Fother_buffer (Fcurrent_buffer (), Qnil, Qnil),
				  Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
541 542 543
	  break;

        case 'c':		/* Character */
544 545 546 547
	  /* Prompt in `minibuffer-prompt' face.  */
	  Fput_text_property (make_number (0),
			      make_number (SCHARS (callint_message)),
			      Qface, Qminibuffer_prompt, callint_message);
548
	  args[i] = Fread_char (callint_message, Qnil, Qnil);
549
	  message1_nolog ((char *) 0);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
550 551 552 553 554 555
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = args[i];
	  visargs[i] = Fchar_to_string (teml);
	  break;

	case 'C':		/* Command: symbol with interactive function */
556
	  visargs[i] = Fcompleting_read (callint_message,
557
					 Vobarray, Qcommandp,
558
					 Qt, Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
559 560 561 562 563 564
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = visargs[i];
	  args[i] = Fintern (teml, Qnil);
	  break;

	case 'd':		/* Value of point.  Does not do I/O.  */
565
	  set_marker_both (point_marker, Qnil, PT, PT_BYTE);
566
	  args[i] = point_marker;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
567 568 569 570 571
	  /* visargs[i] = Qnil; */
	  varies[i] = 1;
	  break;

	case 'D':		/* Directory name. */
572
	  args[i] = Fread_file_name (callint_message, Qnil,
573 574
				     current_buffer->directory, Qlambda, Qnil,
				     Qfile_directory_p);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
575 576 577
	  break;

	case 'f':		/* Existing file name. */
578
	  args[i] = Fread_file_name (callint_message,
579
				     Qnil, Qnil, Qlambda, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
580 581 582
	  break;

	case 'F':		/* Possibly nonexistent file name. */
583
	  args[i] = Fread_file_name (callint_message,
584
				     Qnil, Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
585 586
	  break;

587 588
	case 'G':		/* Possibly nonexistent file name,
				   default to directory alone. */
589
	  args[i] = Fread_file_name (callint_message,
590
				     Qnil, Qnil, Qnil, empty_unibyte_string, Qnil);
591 592
	  break;

593 594 595 596
	case 'i':		/* Ignore an argument -- Does not do I/O */
	  varies[i] = -1;
	  break;

597
	case 'k':		/* Key sequence. */
598
	  {
Juanma Barranquero's avatar
Juanma Barranquero committed
599
	    int speccount1 = SPECPDL_INDEX ();
600
	    specbind (Qcursor_in_echo_area, Qt);
601 602 603 604
	    /* Prompt in `minibuffer-prompt' face.  */
	    Fput_text_property (make_number (0),
				make_number (SCHARS (callint_message)),
				Qface, Qminibuffer_prompt, callint_message);
605
	    args[i] = Fread_key_sequence (callint_message,
606
					  Qnil, Qnil, Qnil, Qnil);
607 608
	    unbind_to (speccount1, Qnil);
	    teml = args[i];
609
	    visargs[i] = Fkey_description (teml, Qnil);
610 611 612 613 614

	    /* If the key sequence ends with a down-event,
	       discard the following up-event.  */
	    teml = Faref (args[i], make_number (XINT (Flength (args[i])) - 1));
	    if (CONSP (teml))
615
	      teml = XCAR (teml);
616 617 618 619 620
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

		teml = Fget (teml, intern ("event-symbol-elements"));
621 622
		/* Ignore first element, which is the base key.  */
		tem2 = Fmemq (intern ("down"), Fcdr (teml));
623
		if (! NILP (tem2))
Chong Yidong's avatar
Chong Yidong committed
624
		  up_event = Fread_event (Qnil, Qnil, Qnil);
625
	      }
626
	  }
627 628 629
	  break;

	case 'K':		/* Key sequence to be defined. */
630
	  {
Juanma Barranquero's avatar
Juanma Barranquero committed
631
	    int speccount1 = SPECPDL_INDEX ();
632
	    specbind (Qcursor_in_echo_area, Qt);
633 634 635 636
	    /* Prompt in `minibuffer-prompt' face.  */
	    Fput_text_property (make_number (0),
				make_number (SCHARS (callint_message)),
				Qface, Qminibuffer_prompt, callint_message);
637
	    args[i] = Fread_key_sequence (callint_message,
638
					  Qnil, Qt, Qnil, Qnil);
639
	    teml = args[i];
640
	    visargs[i] = Fkey_description (teml, Qnil);
641
	    unbind_to (speccount1, Qnil);
642 643 644 645 646

	    /* If the key sequence ends with a down-event,
	       discard the following up-event.  */
	    teml = Faref (args[i], make_number (XINT (Flength (args[i])) - 1));
	    if (CONSP (teml))
647
	      teml = XCAR (teml);
648 649 650 651 652
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

		teml = Fget (teml, intern ("event-symbol-elements"));
653 654
		/* Ignore first element, which is the base key.  */
		tem2 = Fmemq (intern ("down"), Fcdr (teml));
655
		if (! NILP (tem2))
Chong Yidong's avatar
Chong Yidong committed
656
		  up_event = Fread_event (Qnil, Qnil, Qnil);
657
	      }
658
	  }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
659 660
	  break;

661 662 663 664 665 666 667 668 669 670
	case 'U':		/* Up event from last k or K */
	  if (!NILP (up_event))
	    {
	      args[i] = Fmake_vector (make_number (1), up_event);
	      up_event = Qnil;
	      teml = args[i];
	      visargs[i] = Fkey_description (teml, Qnil);
	    }
	  break;

671
	case 'e':		/* The invoking event.  */
672
	  if (next_event >= key_count)
673
	    error ("%s must be bound to an event with parameters",
674
		   (SYMBOLP (function)
675
		    ? (char *) SDATA (SYMBOL_NAME (function))
676
		    : "command"));
677 678
	  args[i] = AREF (keys, next_event);
	  next_event++;
Jim Blandy's avatar
Jim Blandy committed
679
	  varies[i] = -1;
Jim Blandy's avatar
Jim Blandy committed
680 681

	  /* Find the next parameterized event.  */
682
	  while (next_event < key_count
683
		 && !(EVENT_HAS_PARAMETERS (AREF (keys, next_event))))
Jim Blandy's avatar
Jim Blandy committed
684 685
	    next_event++;

Jim Blandy's avatar
Jim Blandy committed
686 687
	  break;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
688
	case 'm':		/* Value of mark.  Does not do I/O.  */
689
	  check_mark (0);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
690
	  /* visargs[i] = Qnil; */
691
	  args[i] = current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
692 693 694
	  varies[i] = 2;
	  break;

695 696
	case 'M':		/* String read via minibuffer with
				   inheriting the current input method.  */
697
	  args[i] = Fread_string (callint_message,
698 699 700
				  Qnil, Qnil, Qnil, Qt);
	  break;

Richard M. Stallman's avatar
Richard M. Stallman committed
701
	case 'N':		/* Prefix arg as number, else number from minibuffer */
Jim Blandy's avatar
Jim Blandy committed
702
	  if (!NILP (prefix_arg))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
703 704
	    goto have_prefix_arg;
	case 'n':		/* Read number from minibuffer.  */
705 706 707 708 709
	  {
	    int first = 1;
	    do
	      {
		Lisp_Object tem;
710
		if (! first)
711 712
		  {
		    message ("Please enter a number.");
713
		    sit_for (make_number (1), 0, 0);
714 715 716
		  }
		first = 0;

717
		tem = Fread_from_minibuffer (callint_message,
718
					     Qnil, Qnil, Qnil, Qnil, Qnil,
719
					     Qnil);
720
		if (! STRINGP (tem) || SCHARS (tem) == 0)
721 722 723 724 725 726
		  args[i] = Qnil;
		else
		  args[i] = Fread (tem);
	      }
	    while (! NUMBERP (args[i]));
	  }
727
	  visargs[i] = args[i];
Michael I. Bushnell's avatar
Michael I. Bushnell committed
728 729 730 731 732 733 734 735 736
	  break;

	case 'P':		/* Prefix arg in raw form.  Does no I/O.  */
	  args[i] = prefix_arg;
	  /* visargs[i] = Qnil; */
	  varies[i] = -1;
	  break;

	case 'p':		/* Prefix arg converted to number.  No I/O. */
737
	have_prefix_arg:
Michael I. Bushnell's avatar
Michael I. Bushnell committed
738 739 740 741 742 743
	  args[i] = Fprefix_numeric_value (prefix_arg);
	  /* visargs[i] = Qnil; */
	  varies[i] = -1;
	  break;

	case 'r':		/* Region, point and mark as 2 args. */
744
	  check_mark (1);
745
	  set_marker_both (point_marker, Qnil, PT, PT_BYTE);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
746 747 748
	  /* visargs[i+1] = Qnil; */
	  foo = marker_position (current_buffer->mark);
	  /* visargs[i] = Qnil; */
749
	  args[i] = PT < foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
750
	  varies[i] = 3;
751
	  args[++i] = PT > foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
752 753 754
	  varies[i] = 4;
	  break;

755 756
	case 's':		/* String read via minibuffer without
				   inheriting the current input method.  */
757
	  args[i] = Fread_string (callint_message,
758
				  Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
759 760 761
	  break;

	case 'S':		/* Any symbol.  */
762
	  visargs[i] = Fread_string (callint_message,
763
				     Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
764 765 766 767 768 769 770
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = visargs[i];
	  args[i] = Fintern (teml, Qnil);
	  break;

	case 'v':		/* Variable name: symbol that is
				   user-variable-p. */
771
	  args[i] = Fread_variable (callint_message, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
772 773 774 775
	  visargs[i] = last_minibuf_string;
	  break;

	case 'x':		/* Lisp expression read but not evaluated */
776
	  args[i] = Fread_minibuffer (callint_message, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
777 778 779 780
	  visargs[i] = last_minibuf_string;
	  break;

	case 'X':		/* Lisp expression read and evaluated */
781
	  args[i] = Feval_minibuffer (callint_message, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
782 783 784
	  visargs[i] = last_minibuf_string;
 	  break;

785 786 787 788 789 790 791
	case 'Z':		/* Coding-system symbol, or ignore the
				   argument if no prefix */
	  if (NILP (prefix_arg))
	    {
	      args[i] = Qnil;
	      varies[i] = -1;
	    }
792
	  else
793 794
	    {
	      args[i]
795
		= Fread_non_nil_coding_system (callint_message);
796 797 798 799 800
	      visargs[i] = last_minibuf_string;
	    }
	  break;

	case 'z':		/* Coding-system symbol or nil */
801
	  args[i] = Fread_coding_system (callint_message, Qnil);
802 803 804
	  visargs[i] = last_minibuf_string;
	  break;

805 806 807
	  /* We have a case for `+' so we get an error
	     if anyone tries to define one here.  */
	case '+':
Michael I. Bushnell's avatar
Michael I. Bushnell committed
808
	default:
809
	  error ("Invalid control letter `%c' (%03o) in interactive calling string",
Michael I. Bushnell's avatar
Michael I. Bushnell committed
810 811 812 813 814 815
		 *tem, *tem);
	}

      if (varies[i] == 0)
	arg_from_tty = 1;

816
      if (NILP (visargs[i]) && STRINGP (args[i]))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
817 818 819 820 821 822
	visargs[i] = args[i];

      tem = (unsigned char *) index (tem, '\n');
      if (tem) tem++;
      else tem = (unsigned char *) "";
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
823
  unbind_to (speccount, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
824 825 826 827 828

  QUIT;

  args[0] = function;

829
  if (arg_from_tty || !NILP (record_flag))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
830 831
    {
      visargs[0] = function;
Jim Blandy's avatar
Jim Blandy committed
832
      for (i = 1; i < count + 1; i++)
833 834 835 836 837 838
	{
	  if (varies[i] > 0)
	    visargs[i] = Fcons (intern (callint_argfuns[varies[i]]), Qnil);
	  else
	    visargs[i] = quotify_arg (args[i]);
	}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
839 840
      Vcommand_history = Fcons (Flist (count + 1, visargs),
				Vcommand_history);
841
      /* Don't keep command history around forever.  */
842
      if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
843 844 845
	{
	  teml = Fnthcdr (Vhistory_length, Vcommand_history);
	  if (CONSP (teml))
846
	    XSETCDR (teml, Qnil);
847
	}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
848 849
    }

850 851
  /* If we used a marker to hold point, mark, or an end of the region,
     temporarily, convert it to an integer now.  */
852
  for (i = 1; i <= count; i++)
853 854 855
    if (varies[i] >= 1 && varies[i] <= 4)
      XSETINT (args[i], marker_position (args[i]));

856 857 858
  if (record_then_fail)
    Fbarf_if_buffer_read_only ();

859 860 861 862 863
  Vthis_command = save_this_command;
  Vthis_original_command = save_this_original_command;
  real_this_command= save_real_this_command;
  current_kboard->Vlast_command = save_last_command;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
864 865 866 867
  {
    Lisp_Object val;
    specbind (Qcommand_debug_status, Qnil);

868
    temporarily_switch_to_single_kboard (NULL);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
869 870 871 872
    val = Ffuncall (count + 1, args);
    UNGCPRO;
    return unbind_to (speccount, val);
  }
873
}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
874 875

DEFUN ("prefix-numeric-value", Fprefix_numeric_value, Sprefix_numeric_value,
876 877 878 879 880
       1, 1, 0,
       doc: /* Return numeric meaning of raw prefix argument RAW.
A raw prefix argument is what you get from `(interactive "P")'.
Its numeric meaning is what you would get from `(interactive "p")'.  */)
     (raw)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
881 882 883
     Lisp_Object raw;
{
  Lisp_Object val;
884

Jim Blandy's avatar
Jim Blandy committed
885
  if (NILP (raw))
886
    XSETFASTINT (val, 1);
887
  else if (EQ (raw, Qminus))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
888
    XSETINT (val, -1);
889 890
  else if (CONSP (raw) && INTEGERP (XCAR (raw)))
    XSETINT (val, XINT (XCAR (raw)));
891
  else if (INTEGERP (raw))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
892 893
    val = raw;
  else
894
    XSETFASTINT (val, 1);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
895 896 897 898

  return val;
}

Andreas Schwab's avatar
Andreas Schwab committed
899
void
Michael I. Bushnell's avatar
Michael I. Bushnell committed
900 901
syms_of_callint ()
{
902 903 904
  point_marker = Fmake_marker ();
  staticpro (&point_marker);

905 906 907
  callint_message = Qnil;
  staticpro (&callint_message);

Dan Nicolaescu's avatar
Dan Nicolaescu committed
908 909 910 911
  preserved_fns = pure_cons (intern_c_string ("region-beginning"),
			 pure_cons (intern_c_string ("region-end"),
				pure_cons (intern_c_string ("point"),
				       pure_cons (intern_c_string ("mark"), Qnil))));
912

Dan Nicolaescu's avatar
Dan Nicolaescu committed
913
  Qlist = intern_c_string ("list");
914
  staticpro (&Qlist);
Dan Nicolaescu's avatar
Dan Nicolaescu committed
915
  Qlet = intern_c_string ("let");
916
  staticpro (&Qlet);
Dan Nicolaescu's avatar
Dan Nicolaescu committed
917
  Qif = intern_c_string ("if");
918
  staticpro (&Qif);
Dan Nicolaescu's avatar
Dan Nicolaescu committed
919
  Qwhen = intern_c_string ("when");
920
  staticpro (&Qwhen);
Dan Nicolaescu's avatar
Dan Nicolaescu committed
921
  Qletx = intern_c_string ("let*");
922
  staticpro (&Qletx);
Dan Nicolaescu's avatar
Dan Nicolaescu committed
923
  Qsave_excursion = intern_c_string ("save-excursion");
924
  staticpro (&Qsave_excursion);
Dan Nicolaescu's avatar
Dan Nicolaescu committed
925
  Qprogn = intern_c_string ("progn");
926
  staticpro (&Qprogn);
927

Dan Nicolaescu's avatar
Dan Nicolaescu committed