callint.c 29.5 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 4
                 2003, 2004, 2005, 2006, 2007, 2008
                 Free Software Foundation, Inc.
Michael I. Bushnell's avatar
Michael I. Bushnell committed
5 6 7 8 9

This file is part of GNU Emacs.

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

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
along with GNU Emacs; see the file COPYING.  If not, write to
Lute Kamstra's avatar
Lute Kamstra committed
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
22 23


24
#include <config.h>
25

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

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

37
extern Lisp_Object Qcursor_in_echo_area;
38
extern Lisp_Object Qfile_directory_p;
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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
47
Lisp_Object Vcommand_debug_status, Qcommand_debug_status;
Richard M. Stallman's avatar
Richard M. Stallman committed
48
Lisp_Object Qenable_recursive_minibuffers;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
49

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

54 55
Lisp_Object Vmouse_leave_buffer_hook, Qmouse_leave_buffer_hook;

56
Lisp_Object Qlist, Qlet, Qletx, Qsave_excursion, Qprogn, Qif, Qwhen;
57 58 59 60
static Lisp_Object preserved_fns;

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

62 63
/* String for the prompt text used in Fcall_interactively.  */
static Lisp_Object callint_message;
Richard M. Stallman's avatar
Richard M. Stallman committed
64

Michael I. Bushnell's avatar
Michael I. Bushnell committed
65 66
/* ARGSUSED */
DEFUN ("interactive", Finteractive, Sinteractive, 0, UNEVALLED, 0,
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
       doc: /* Specify a way of parsing arguments for interactive use of a function.
For example, write
  (defun foo (arg) "Doc string" (interactive "p") ...use arg...)
to make ARG be the prefix argument when `foo' is called as a command.
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.

The argument of `interactive' is usually a string containing a code letter
 followed by a prompt.  (Some code letters do not use I/O to get
 the argument and do not need prompts.)  To prompt for multiple arguments,
 give a code letter, its prompt, a newline, and another code letter, etc.
 Prompts are passed to format, and may use % escapes to print the
 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.
99
G -- Possibly nonexistent file name, defaulting to just directory name.
100 101 102 103 104 105
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
106
N -- Numeric prefix arg, or if none, do like code `n'.
107 108 109 110 111
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.
112
U -- Mouse up event discarded by a previous k or K argument.
113 114 115 116 117 118 119 120 121 122 123 124
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.
In addition, if the string begins with `*'
 then an error is signaled if the buffer is read-only.
 This happens before reading any arguments.
If the string begins with `@', then Emacs searches the key sequence
 which invoked the command for its first mouse click (or any other
 event which specifies a window), and selects that window before
 reading any arguments.  You may use both `@' and `*'; they are
125 126
 processed in the order that they appear.
usage: (interactive ARGS)  */)
127
     (args)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
128 129 130 131 132 133 134 135 136 137 138
     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;
{
139
  if (!INTEGERP (exp) && !STRINGP (exp)
Jim Blandy's avatar
Jim Blandy committed
140
      && !NILP (exp) && !EQ (exp, Qt))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
141 142 143 144 145 146 147 148 149 150 151
    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;
152 153
  Lisp_Object next;
  for (tail = exp; CONSP (tail); tail = next)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
154
    {
155
      next = XCDR (tail);
156
      XSETCAR (tail, quotify_arg (XCAR (tail)));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
157 158 159 160 161 162 163 164
    }
  return exp;
}

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
178 179 180 181 182 183 184 185
/* 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.  */

186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
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
212
	       intail = Fcdr (intail), valtail = XCDR (valtail))
213 214 215 216 217 218 219 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
	    {
	      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
246

247
DEFUN ("call-interactively", Fcall_interactively, Scall_interactively, 1, 3, 0,
248 249 250 251 252 253 254 255 256 257
       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.
258

259
Optional third arg KEYS, if given, specifies the sequence of events to
260 261 262
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.  */)
263
     (function, record_flag, keys)
264
     Lisp_Object function, record_flag, keys;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
265 266 267 268
{
  Lisp_Object *args, *visargs;
  Lisp_Object fun;
  Lisp_Object specs;
269
  Lisp_Object filter_specs;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
270
  Lisp_Object teml;
271
  Lisp_Object up_event;
Richard M. Stallman's avatar
Richard M. Stallman committed
272
  Lisp_Object enable;
Juanma Barranquero's avatar
Juanma Barranquero committed
273
  int speccount = SPECPDL_INDEX ();
Michael I. Bushnell's avatar
Michael I. Bushnell committed
274

275 276
  /* The index of the next element of this_command_keys to examine for
     the 'e' interactive code.  */
Jim Blandy's avatar
Jim Blandy committed
277
  int next_event;
278

Michael I. Bushnell's avatar
Michael I. Bushnell committed
279 280 281
  Lisp_Object prefix_arg;
  unsigned char *string;
  unsigned char *tem;
Jim Blandy's avatar
Jim Blandy committed
282 283 284 285

  /* 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
286
  int *varies;
Jim Blandy's avatar
Jim Blandy committed
287

Michael I. Bushnell's avatar
Michael I. Bushnell committed
288 289 290 291 292
  register int i, j;
  int count, foo;
  char prompt1[100];
  char *tem1;
  int arg_from_tty = 0;
293
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
294
  int key_count;
295
  int record_then_fail = 0;
296

297 298 299 300 301 302 303 304
  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;

305 306 307 308
  if (NILP (keys))
    keys = this_command_keys, key_count = this_command_key_count;
  else
    {
309
      CHECK_VECTOR (keys);
310 311
      key_count = XVECTOR (keys)->size;
    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
312

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

316
  if (SYMBOLP (function))
317
    enable = Fget (function, Qenable_recursive_minibuffers);
318 319
  else
    enable = Qnil;
Richard M. Stallman's avatar
Richard M. Stallman committed
320

Jim Blandy's avatar
Jim Blandy committed
321
  fun = indirect_function (function);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
322 323 324

  specs = Qnil;
  string = 0;
325 326 327 328
  /* 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
329

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
333
  /* Decode the kind of function.  Either handle it and return,
334
     or go to `lose' if not interactive, or set either STRING or SPECS.  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
335

336
  if (SUBRP (fun))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
337 338 339 340 341
    {
      string = (unsigned char *) XSUBR (fun)->prompt;
      if (!string)
	{
	lose:
342
	  wrong_type_argument (Qcommandp, function);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
343 344
	}
    }
345
  else if (COMPILEDP (fun))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
346
    {
Roland McGrath's avatar
Roland McGrath committed
347
      if ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) <= COMPILED_INTERACTIVE)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
348 349 350
	goto lose;
      specs = XVECTOR (fun)->contents[COMPILED_INTERACTIVE];
    }
351
  else
Michael I. Bushnell's avatar
Michael I. Bushnell committed
352
    {
353
      Lisp_Object form;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
354
      GCPRO2 (function, prefix_arg);
355
      form = Finteractive_form (function);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
356
      UNGCPRO;
357 358 359
      if (CONSP (form))
	specs = filter_specs = Fcar (XCDR (form));
      else
Michael I. Bushnell's avatar
Michael I. Bushnell committed
360 361 362
	goto lose;
    }

363
  /* If either SPECS or STRING is set to a string, use it.  */
364
  if (STRINGP (specs))
Jim Blandy's avatar
Jim Blandy committed
365 366 367
    {
      /* Make a copy of string so that if a GC relocates specs,
	 `string' will still be valid.  */
368 369 370
      string = (unsigned char *) alloca (SBYTES (specs) + 1);
      bcopy (SDATA (specs), string,
	     SBYTES (specs) + 1);
Jim Blandy's avatar
Jim Blandy committed
371
    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
372 373
  else if (string == 0)
    {
374
      Lisp_Object input;
375
      i = num_input_events;
376 377
      input = specs;
      /* Compute the arg values using the user's expression.  */
378
      GCPRO2 (input, filter_specs);
379
      specs = Feval (specs);
380
      UNGCPRO;
381
      if (i != num_input_events || !NILP (record_flag))
382 383
	{
	  /* We should record this command on the command history.  */
384
	  Lisp_Object values;
385 386 387
	  /* 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));
388
	  fix_command (input, values);
389 390
	  Vcommand_history
	    = Fcons (Fcons (function, values), Vcommand_history);
391 392

	  /* Don't keep command history around forever.  */
393
	  if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
394 395 396
	    {
	      teml = Fnthcdr (Vhistory_length, Vcommand_history);
	      if (CONSP (teml))
397
		XSETCDR (teml, Qnil);
398
	    }
399
	}
400 401 402 403 404 405

      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;

406
      single_kboard_state ();
Michael I. Bushnell's avatar
Michael I. Bushnell committed
407 408 409 410 411
      return apply1 (function, specs);
    }

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

Jim Blandy's avatar
Jim Blandy committed
412
  /* Set next_event to point to the first event with parameters.  */
413 414
  for (next_event = 0; next_event < key_count; next_event++)
    if (EVENT_HAS_PARAMETERS (XVECTOR (keys)->contents[next_event]))
Jim Blandy's avatar
Jim Blandy committed
415
      break;
416

417
  /* Handle special starting chars `*' and `@'.  Also `-'.  */
418
  /* Note that `+' is reserved for user extensions.  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
419 420
  while (1)
    {
421
      if (*string == '+')
422 423
	error ("`+' is not used in `interactive' for ordinary commands");
      else if (*string == '*')
Michael I. Bushnell's avatar
Michael I. Bushnell committed
424 425
	{
	  string++;
Jim Blandy's avatar
Jim Blandy committed
426
	  if (!NILP (current_buffer->read_only))
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
	    {
	      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
443
	}
444 445 446
      /* Ignore this for semi-compatibility with Lucid.  */
      else if (*string == '-')
	string++;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
447 448
      else if (*string == '@')
	{
449
	  Lisp_Object event, tem;
Jim Blandy's avatar
Jim Blandy committed
450

451 452 453
	  event = (next_event < key_count
		   ? XVECTOR (keys)->contents[next_event]
		   : Qnil);
Jim Blandy's avatar
Jim Blandy committed
454
	  if (EVENT_HAS_PARAMETERS (event)
455 456 457
	      && (tem = XCDR (event), CONSP (tem))
	      && (tem = XCAR (tem), CONSP (tem))
	      && (tem = XCAR (tem), WINDOWP (tem)))
458
	    {
459 460
	      if (MINI_WINDOW_P (XWINDOW (tem))
		  && ! (minibuf_level > 0 && EQ (tem, minibuf_window)))
461
		error ("Attempt to select inactive minibuffer window");
462 463 464 465 466

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

467
	      Fselect_window (tem, Qnil);
468
	    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
	  string++;
	}
      else break;
    }

  /* Count the number of arguments the interactive spec would have
     us give to the function.  */
  tem = string;
  for (j = 0; *tem; j++)
    {
      /* 'r' specifications ("point and mark as 2 numeric args")
	 produce *two* arguments.  */
      if (*tem == 'r') j++;
      tem = (unsigned char *) index (tem, '\n');
      if (tem)
	tem++;
      else
	tem = (unsigned char *) "";
    }
488
  count = j;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
489 490 491 492 493 494 495 496 497 498 499 500

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
505 506 507
  if (!NILP (enable))
    specbind (Qenable_recursive_minibuffers, Qt);

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

      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
521 522 523 524

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

	case 'b':   		/* Name of existing buffer */
	  args[i] = Fcurrent_buffer ();
	  if (EQ (selected_window, minibuf_window))
536
	    args[i] = Fother_buffer (args[i], Qnil, Qnil);
537
	  args[i] = Fread_buffer (callint_message, args[i], Qt);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
538 539 540
	  break;

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

        case 'c':		/* Character */
547
	  args[i] = Fread_char (callint_message, Qnil, Qnil);
548
	  message1_nolog ((char *) 0);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
549 550 551 552 553 554
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = args[i];
	  visargs[i] = Fchar_to_string (teml);
	  break;

	case 'C':		/* Command: symbol with interactive function */
555
	  visargs[i] = Fcompleting_read (callint_message,
556
					 Vobarray, Qcommandp,
557
					 Qt, Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
558 559 560 561 562 563
	  /* 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.  */
564
	  set_marker_both (point_marker, Qnil, PT, PT_BYTE);
565
	  args[i] = point_marker;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
566 567 568 569 570
	  /* visargs[i] = Qnil; */
	  varies[i] = 1;
	  break;

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

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

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

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

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

596
	case 'k':		/* Key sequence. */
597
	  {
Juanma Barranquero's avatar
Juanma Barranquero committed
598
	    int speccount1 = SPECPDL_INDEX ();
599
	    specbind (Qcursor_in_echo_area, Qt);
600
	    args[i] = Fread_key_sequence (callint_message,
601
					  Qnil, Qnil, Qnil, Qnil);
602 603
	    unbind_to (speccount1, Qnil);
	    teml = args[i];
604
	    visargs[i] = Fkey_description (teml, Qnil);
605 606 607 608 609

	    /* 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))
610
	      teml = XCAR (teml);
611 612 613 614 615
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

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

	case 'K':		/* Key sequence to be defined. */
625
	  {
Juanma Barranquero's avatar
Juanma Barranquero committed
626
	    int speccount1 = SPECPDL_INDEX ();
627
	    specbind (Qcursor_in_echo_area, Qt);
628
	    args[i] = Fread_key_sequence (callint_message,
629
					  Qnil, Qt, Qnil, Qnil);
630
	    teml = args[i];
631
	    visargs[i] = Fkey_description (teml, Qnil);
632
	    unbind_to (speccount1, Qnil);
633 634 635 636 637

	    /* 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))
638
	      teml = XCAR (teml);
639 640 641 642 643
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

		teml = Fget (teml, intern ("event-symbol-elements"));
644 645
		/* Ignore first element, which is the base key.  */
		tem2 = Fmemq (intern ("down"), Fcdr (teml));
646
		if (! NILP (tem2))
Chong Yidong's avatar
Chong Yidong committed
647
		  up_event = Fread_event (Qnil, Qnil, Qnil);
648
	      }
649
	  }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
650 651
	  break;

652 653 654 655 656 657 658 659 660 661
	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;

662
	case 'e':		/* The invoking event.  */
663
	  if (next_event >= key_count)
664
	    error ("%s must be bound to an event with parameters",
665
		   (SYMBOLP (function)
666
		    ? (char *) SDATA (SYMBOL_NAME (function))
667
		    : "command"));
668
	  args[i] = XVECTOR (keys)->contents[next_event++];
Jim Blandy's avatar
Jim Blandy committed
669
	  varies[i] = -1;
Jim Blandy's avatar
Jim Blandy committed
670 671

	  /* Find the next parameterized event.  */
672
	  while (next_event < key_count
Jim Blandy's avatar
Jim Blandy committed
673
		 && ! (EVENT_HAS_PARAMETERS
674
		       (XVECTOR (keys)->contents[next_event])))
Jim Blandy's avatar
Jim Blandy committed
675 676
	    next_event++;

Jim Blandy's avatar
Jim Blandy committed
677 678
	  break;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
679
	case 'm':		/* Value of mark.  Does not do I/O.  */
680
	  check_mark (0);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
681
	  /* visargs[i] = Qnil; */
682
	  args[i] = current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
683 684 685
	  varies[i] = 2;
	  break;

686 687
	case 'M':		/* String read via minibuffer with
				   inheriting the current input method.  */
688
	  args[i] = Fread_string (callint_message,
689 690 691
				  Qnil, Qnil, Qnil, Qt);
	  break;

Richard M. Stallman's avatar
Richard M. Stallman committed
692
	case 'N':		/* Prefix arg as number, else number from minibuffer */
Jim Blandy's avatar
Jim Blandy committed
693
	  if (!NILP (prefix_arg))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
694 695
	    goto have_prefix_arg;
	case 'n':		/* Read number from minibuffer.  */
696 697 698 699 700
	  {
	    int first = 1;
	    do
	      {
		Lisp_Object tem;
701
		if (! first)
702 703
		  {
		    message ("Please enter a number.");
704
		    sit_for (make_number (1), 0, 0);
705 706 707
		  }
		first = 0;

708
		tem = Fread_from_minibuffer (callint_message,
709
					     Qnil, Qnil, Qnil, Qnil, Qnil,
710
					     Qnil);
711
		if (! STRINGP (tem) || SCHARS (tem) == 0)
712 713 714 715 716 717
		  args[i] = Qnil;
		else
		  args[i] = Fread (tem);
	      }
	    while (! NUMBERP (args[i]));
	  }
718
	  visargs[i] = args[i];
Michael I. Bushnell's avatar
Michael I. Bushnell committed
719 720 721 722 723 724 725 726 727
	  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. */
728
	have_prefix_arg:
Michael I. Bushnell's avatar
Michael I. Bushnell committed
729 730 731 732 733 734
	  args[i] = Fprefix_numeric_value (prefix_arg);
	  /* visargs[i] = Qnil; */
	  varies[i] = -1;
	  break;

	case 'r':		/* Region, point and mark as 2 args. */
735
	  check_mark (1);
736
	  set_marker_both (point_marker, Qnil, PT, PT_BYTE);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
737 738 739
	  /* visargs[i+1] = Qnil; */
	  foo = marker_position (current_buffer->mark);
	  /* visargs[i] = Qnil; */
740
	  args[i] = PT < foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
741
	  varies[i] = 3;
742
	  args[++i] = PT > foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
743 744 745
	  varies[i] = 4;
	  break;

746 747
	case 's':		/* String read via minibuffer without
				   inheriting the current input method.  */
748
	  args[i] = Fread_string (callint_message,
749
				  Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
750 751 752
	  break;

	case 'S':		/* Any symbol.  */
753
	  visargs[i] = Fread_string (callint_message,
754
				     Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
755 756 757 758 759 760 761
	  /* 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. */
762
	  args[i] = Fread_variable (callint_message, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
763 764 765 766
	  visargs[i] = last_minibuf_string;
	  break;

	case 'x':		/* Lisp expression read but not evaluated */
767
	  args[i] = Fread_minibuffer (callint_message, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
768 769 770 771
	  visargs[i] = last_minibuf_string;
	  break;

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

776 777 778 779 780 781 782
	case 'Z':		/* Coding-system symbol, or ignore the
				   argument if no prefix */
	  if (NILP (prefix_arg))
	    {
	      args[i] = Qnil;
	      varies[i] = -1;
	    }
783
	  else
784 785
	    {
	      args[i]
786
		= Fread_non_nil_coding_system (callint_message);
787 788 789 790 791
	      visargs[i] = last_minibuf_string;
	    }
	  break;

	case 'z':		/* Coding-system symbol or nil */
792
	  args[i] = Fread_coding_system (callint_message, Qnil);
793 794 795
	  visargs[i] = last_minibuf_string;
	  break;

796 797 798
	  /* 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
799
	default:
800
	  error ("Invalid control letter `%c' (%03o) in interactive calling string",
Michael I. Bushnell's avatar
Michael I. Bushnell committed
801 802 803 804 805 806
		 *tem, *tem);
	}

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

807
      if (NILP (visargs[i]) && STRINGP (args[i]))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
808 809 810 811 812 813
	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
814
  unbind_to (speccount, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
815 816 817 818 819

  QUIT;

  args[0] = function;

820
  if (arg_from_tty || !NILP (record_flag))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
821 822
    {
      visargs[0] = function;
Jim Blandy's avatar
Jim Blandy committed
823
      for (i = 1; i < count + 1; i++)
824 825 826 827 828 829
	{
	  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
830 831
      Vcommand_history = Fcons (Flist (count + 1, visargs),
				Vcommand_history);
832
      /* Don't keep command history around forever.  */
833
      if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
834 835 836
	{
	  teml = Fnthcdr (Vhistory_length, Vcommand_history);
	  if (CONSP (teml))
837
	    XSETCDR (teml, Qnil);
838
	}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
839 840
    }

841 842
  /* If we used a marker to hold point, mark, or an end of the region,
     temporarily, convert it to an integer now.  */
843
  for (i = 1; i <= count; i++)
844 845 846
    if (varies[i] >= 1 && varies[i] <= 4)
      XSETINT (args[i], marker_position (args[i]));

847 848 849
  if (record_then_fail)
    Fbarf_if_buffer_read_only ();

850 851 852 853 854
  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;

855
  single_kboard_state ();
856

Michael I. Bushnell's avatar
Michael I. Bushnell committed
857 858 859 860 861 862 863 864
  {
    Lisp_Object val;
    specbind (Qcommand_debug_status, Qnil);

    val = Ffuncall (count + 1, args);
    UNGCPRO;
    return unbind_to (speccount, val);
  }
865
}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
866 867

DEFUN ("prefix-numeric-value", Fprefix_numeric_value, Sprefix_numeric_value,
868 869 870 871 872
       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
873 874 875
     Lisp_Object raw;
{
  Lisp_Object val;
876

Jim Blandy's avatar
Jim Blandy committed
877
  if (NILP (raw))
878
    XSETFASTINT (val, 1);
879
  else if (EQ (raw, Qminus))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
880
    XSETINT (val, -1);
881 882
  else if (CONSP (raw) && INTEGERP (XCAR (raw)))
    XSETINT (val, XINT (XCAR (raw)));
883
  else if (INTEGERP (raw))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
884 885
    val = raw;
  else
886
    XSETFASTINT (val, 1);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
887 888 889 890

  return val;
}

Andreas Schwab's avatar
Andreas Schwab committed
891
void
Michael I. Bushnell's avatar
Michael I. Bushnell committed
892 893
syms_of_callint ()
{
894 895 896
  point_marker = Fmake_marker ();
  staticpro (&point_marker);

897 898 899
  callint_message = Qnil;
  staticpro (&callint_message);

900 901 902 903 904 905 906 907
  preserved_fns = Fcons (intern ("region-beginning"),
			 Fcons (intern ("region-end"),
				Fcons (intern ("point"),
				       Fcons (intern ("mark"), Qnil))));
  staticpro (&preserved_fns);

  Qlist = intern ("list");
  staticpro (&Qlist);
908 909
  Qlet = intern ("let");
  staticpro (&Qlet);
910 911 912 913
  Qif = intern ("if");
  staticpro (&Qif);
  Qwhen = intern ("when");
  staticpro (&Qwhen);
914 915 916 917
  Qletx = intern ("let*");
  staticpro (&Qletx);
  Qsave_excursion = intern ("save-excursion");
  staticpro (&Qsave_excursion);
918 919
  Qprogn = intern ("progn");
  staticpro (&Qprogn);
920

Michael I. Bushnell's avatar
Michael I. Bushnell committed
921 922 923
  Qminus = intern ("-");
  staticpro (&Qminus);

Richard M. Stallman's avatar
Richard M. Stallman committed
924 925 926
  Qplus = intern ("+");
  staticpro (&Qplus);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
927 928 929 930 931 932
  Qcall_interactively = intern ("call-interactively");
  staticpro (&Qcall_interactively);

  Qcommand_debug_status = intern ("command-debug-status");
  staticpro (&Qcommand_debug_status);

Richard M. Stallman's avatar
Richard M. Stallman committed
933 934 935
  Qenable_recursive_minibuffers = intern ("enable-recursive-minibuffers");
  staticpro (&Qenable_recursive_minibuffers);

936 937 938
  Qmouse_leave_buffer_hook = intern ("mouse-leave-buffer-hook");
  staticpro (&Qmouse_leave_buffer_hook);

939
  DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
940 941 942 943 944 945 946 947 948
		 doc: /* The value of the prefix argument for the next editing command.
It may be a number, or the symbol `-' for just a minus sign as arg,
or a list whose car is a number for just one or more C-u's
or nil if no argument has been specified.

You cannot examine this variable to find the argument for this command
since it has been set to nil by the time you can look.
Instead, you should use the variable `current-prefix-arg', although
normally commands can get this prefix argument with (interactive "P").  */);
949

950
  DEFVAR_KBOARD ("last-prefix-arg", Vlast_prefix_arg,
951 952
		 doc: /* The value of the prefix argument for the previous editing command.
See `prefix-arg' for the meaning of the value.  */);
953

954
  DEFVAR_LISP ("current-prefix-arg", &Vcurrent_prefix_arg,
955 956 957 958 959
	       doc: /* The value of the prefix argument for this editing command.
It may be a number, or the symbol `-' for just a minus sign as arg,
or a list whose car is a number for just one or more C-u's
or nil if no argument has been specified.
This is what `(interactive \"P\")' returns.  */);
960 961
  Vcurrent_prefix_arg = Qnil;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
962
  DEFVAR_LISP ("command-history", &Vcommand_history,
963
	       doc: /* List of recent commands that read arguments from terminal.