callint.c 29.8 KB
Newer Older
Michael I. Bushnell's avatar
Michael I. Bushnell committed
1
/* Call a Lisp function interactively.
2
   Copyright (C) 1985, 86, 93, 94, 95, 1997, 2000, 02, 03, 2004
3
   Free Software Foundation, Inc.
Michael I. Bushnell's avatar
Michael I. Bushnell committed
4 5 6 7 8

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
Jim Blandy's avatar
Jim Blandy committed
9
the Free Software Foundation; either version 2, or (at your option)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
10 11 12 13 14 15 16 17 18
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
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
21 22


23
#include <config.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

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

43
extern Lisp_Object Vhistory_length;
44
extern Lisp_Object Vthis_original_command, real_this_command;
45

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

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

53 54
Lisp_Object Vmouse_leave_buffer_hook, Qmouse_leave_buffer_hook;

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

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

61 62 63 64 65
/* Buffer for the prompt text used in Fcall_interactively.  */
static char *callint_message;

/* Allocated length of that buffer.  */
static int callint_message_size;
66

Michael I. Bushnell's avatar
Michael I. Bushnell committed
67 68
/* ARGSUSED */
DEFUN ("interactive", Finteractive, Sinteractive, 0, UNEVALLED, 0,
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 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
       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.
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.
N -- Raw prefix arg, or if none, do like code `n'.
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.
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 175
  if (!NILP (Vtransient_mark_mode) && NILP (Vmark_even_if_inactive)
      && NILP (current_buffer->mark_active))
    Fsignal (Qmark_inactive, Qnil);
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 258
       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.
Optional third arg KEYS, if given, specifies the sequence of events to
259 260
supply if the command inquires which events were used to invoke it.
If KEYS is omitted or nil, the return value of `this-command-keys' is used.  */)
261
     (function, record_flag, keys)
262
     Lisp_Object function, record_flag, keys;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
263 264 265 266 267 268
{
  Lisp_Object *args, *visargs;
  unsigned char **argstrings;
  Lisp_Object fun;
  Lisp_Object funcar;
  Lisp_Object specs;
269
  Lisp_Object filter_specs;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
270
  Lisp_Object teml;
Richard M. Stallman's avatar
Richard M. Stallman committed
271
  Lisp_Object enable;
Juanma Barranquero's avatar
Juanma Barranquero committed
272
  int speccount = SPECPDL_INDEX ();
Michael I. Bushnell's avatar
Michael I. Bushnell committed
273

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

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

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
315
 retry:
Michael I. Bushnell's avatar
Michael I. Bushnell committed
316

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

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

  specs = Qnil;
  string = 0;
326 327 328 329
  /* 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
330 331 332 333 334

  /* Decode the kind of function.  Either handle it and return,
     or go to `lose' if not interactive, or go to `retry'
     to specify a different function, or set either STRING or SPECS.  */

335
  if (SUBRP (fun))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
336 337 338 339 340
    {
      string = (unsigned char *) XSUBR (fun)->prompt;
      if (!string)
	{
	lose:
341
	  function = wrong_type_argument (Qcommandp, function);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
342 343 344
	  goto retry;
	}
    }
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;
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
	      && (event = XCDR (event), CONSP (event))
	      && (event = XCAR (event), CONSP (event))
	      && (event = XCAR (event), WINDOWP (event)))
458
	    {
Karl Heuer's avatar
Karl Heuer committed
459
	      if (MINI_WINDOW_P (XWINDOW (event))
460
		  && ! (minibuf_level > 0 && EQ (event, 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 (event, 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 501 502 503 504 505

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

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

  GCPRO4 (prefix_arg, function, *args, *visargs);
  gcpro3.nvars = (count + 1);
  gcpro4.nvars = (count + 1);

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
509
  tem = string;
510
  for (i = 1; *tem; i++)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
511 512 513
    {
      strncpy (prompt1, tem + 1, sizeof prompt1 - 1);
      prompt1[sizeof prompt1 - 1] = 0;
514
      tem1 = (char *) index (prompt1, '\n');
Michael I. Bushnell's avatar
Michael I. Bushnell committed
515 516 517 518 519
      if (tem1) *tem1 = 0;
      /* Fill argstrings with a vector of C strings
	 corresponding to the Lisp strings in visargs.  */
      for (j = 1; j < i; j++)
	argstrings[j]
520 521
	  = (EQ (visargs[j], Qnil)
	     ? (unsigned char *) ""
522
	     : SDATA (visargs[j]));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
523

524 525 526 527 528 529 530 531
      /* Process the format-string in prompt1, putting the output
	 into callint_message.  Make callint_message bigger if necessary.
	 We don't use a buffer on the stack, because the contents
	 need to stay stable for a while.  */
      while (1)
	{
	  int nchars = doprnt (callint_message, callint_message_size,
			       prompt1, (char *)0,
532
			       j - 1, (char **) argstrings + 1);
533
	  if (nchars < callint_message_size - 1)
534 535 536 537 538
	    break;
	  callint_message_size *= 2;
	  callint_message
	    = (char *) xrealloc (callint_message, callint_message_size);
	}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
539 540 541 542

      switch (*tem)
	{
	case 'a':		/* Symbol defined as a function */
543
	  visargs[i] = Fcompleting_read (build_string (callint_message),
544
					 Vobarray, Qfboundp, Qt,
545
					 Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
546 547 548 549 550 551 552 553
	  /* 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))
554
	    args[i] = Fother_buffer (args[i], Qnil, Qnil);
555
	  args[i] = Fread_buffer (build_string (callint_message), args[i], Qt);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
556 557 558
	  break;

	case 'B':		/* Name of buffer, possibly nonexistent */
559
	  args[i] = Fread_buffer (build_string (callint_message),
560
				  Fother_buffer (Fcurrent_buffer (), Qnil, Qnil),
561
				  Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
562 563 564
	  break;

        case 'c':		/* Character */
565
	  args[i] = Fread_char (build_string (callint_message), Qnil);
566
	  message1_nolog ((char *) 0);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
567 568 569 570 571 572
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = args[i];
	  visargs[i] = Fchar_to_string (teml);
	  break;

	case 'C':		/* Command: symbol with interactive function */
573
	  visargs[i] = Fcompleting_read (build_string (callint_message),
574
					 Vobarray, Qcommandp,
575
					 Qt, Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
576 577 578 579 580 581
	  /* 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.  */
582
	  set_marker_both (point_marker, Qnil, PT, PT_BYTE);
583
	  args[i] = point_marker;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
584 585 586 587 588
	  /* visargs[i] = Qnil; */
	  varies[i] = 1;
	  break;

	case 'D':		/* Directory name. */
589
	  args[i] = Fread_file_name (build_string (callint_message), Qnil,
590 591
				     current_buffer->directory, Qlambda, Qnil,
				     Qfile_directory_p);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
592 593 594
	  break;

	case 'f':		/* Existing file name. */
595
	  args[i] = Fread_file_name (build_string (callint_message),
596
				     Qnil, Qnil, Qlambda, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
597 598 599
	  break;

	case 'F':		/* Possibly nonexistent file name. */
600
	  args[i] = Fread_file_name (build_string (callint_message),
601
				     Qnil, Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
602 603
	  break;

604 605 606 607
	case 'i':		/* Ignore an argument -- Does not do I/O */
	  varies[i] = -1;
	  break;

608
	case 'k':		/* Key sequence. */
609
	  {
Juanma Barranquero's avatar
Juanma Barranquero committed
610
	    int speccount1 = SPECPDL_INDEX ();
611 612
	    specbind (Qcursor_in_echo_area, Qt);
	    args[i] = Fread_key_sequence (build_string (callint_message),
613
					  Qnil, Qnil, Qnil, Qnil);
614 615
	    unbind_to (speccount1, Qnil);
	    teml = args[i];
616
	    visargs[i] = Fkey_description (teml, Qnil);
617 618 619 620 621

	    /* 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))
622
	      teml = XCAR (teml);
623 624 625 626 627
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

		teml = Fget (teml, intern ("event-symbol-elements"));
628 629
		/* Ignore first element, which is the base key.  */
		tem2 = Fmemq (intern ("down"), Fcdr (teml));
630
		if (! NILP (tem2))
631
		  Fread_event (Qnil, Qnil);
632
	      }
633
	  }
634 635 636
	  break;

	case 'K':		/* Key sequence to be defined. */
637
	  {
Juanma Barranquero's avatar
Juanma Barranquero committed
638
	    int speccount1 = SPECPDL_INDEX ();
639 640
	    specbind (Qcursor_in_echo_area, Qt);
	    args[i] = Fread_key_sequence (build_string (callint_message),
641
					  Qnil, Qt, Qnil, Qnil);
642
	    teml = args[i];
643
	    visargs[i] = Fkey_description (teml, Qnil);
644
	    unbind_to (speccount1, Qnil);
645 646 647 648 649

	    /* 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))
650
	      teml = XCAR (teml);
651 652 653 654 655
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

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

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

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

Jim Blandy's avatar
Jim Blandy committed
679 680
	  break;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  QUIT;

  args[0] = function;

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

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

849 850 851
  if (record_then_fail)
    Fbarf_if_buffer_read_only ();

852 853 854 855 856
  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;

857
  single_kboard_state ();
858

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

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

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

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

  return val;
}

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

899 900 901 902 903 904 905 906
  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);
907 908
  Qlet = intern ("let");
  staticpro (&Qlet);
909 910 911 912
  Qif = intern ("if");
  staticpro (&Qif);
  Qwhen = intern ("when");
  staticpro (&Qwhen);
913 914 915 916
  Qletx = intern ("let*");
  staticpro (&Qletx);
  Qsave_excursion = intern ("save-excursion");
  staticpro (&Qsave_excursion);
917 918
  Qprogn = intern ("progn");
  staticpro (&Qprogn);
919

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

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
926 927 928 929 930 931
  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
932 933 934
  Qenable_recursive_minibuffers = intern ("enable-recursive-minibuffers");
  staticpro (&Qenable_recursive_minibuffers);

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

938 939 940 941
  callint_message_size = 100;
  callint_message = (char *) xmalloc (callint_message_size);


942
  DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
943 944 945 946 947 948 949 950 951
		 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").  */);
952

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

957
  DEFVAR_LISP ("current-prefix-arg", &Vcurrent_prefix_arg,
958 959 960 961 962
	       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.  */);
963 964
  Vcurrent_prefix_arg = Qnil;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
965
  DEFVAR_LISP ("command-history", &Vcommand_history,
966 967
	       doc: /* List of recent commands that read arguments from terminal.
Each command is represented as a form to evaluate.  */);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
968 969 970
  Vcommand_history = Qnil;

  DEFVAR_LISP ("command-debug-status", &Vcommand_debug_status,
971 972 973
	       doc: /* Debugging status of current interactive command.
Bound each time `call-interactively' is called;
may be set by the debugger as a reminder for itself.  */);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
974 975
  Vcommand_debug_status = Qnil;

976
  DEFVAR_LISP ("mark-even-if-inactive", &Vmark_even_if_inactive,
977 978 979 980 981
	       doc: /* *Non-nil means you can use the mark even when inactive.
This option makes a difference in Transient Mark mode.
When the option is non-nil, deactivation of the mark
turns off region highlighting, but commands that use the mark
behave as if the mark were still active.  */);
982 983
  Vmark_even_if_inactive = Qnil;

984
  DEFVAR_LISP ("mouse-leave-buffer-hook", &Vmouse_leave_buffer_hook,
985 986 987
	       doc: /* Hook to run when about to switch windows with a mouse command.
Its purpose is to give temporary modes such as Isearch mode
a way to turn themselves off when a mouse command switches windows.  */);
988 989
  Vmouse_leave_buffer_hook = Qnil;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
990 991 992 993
  defsubr (&Sinteractive);
  defsubr (&Scall_interactively);
  defsubr (&Sprefix_numeric_value);
}
Miles Bader's avatar
Miles Bader committed
994 995 996

/* arch-tag: a3a7cad7-bcac-42ce-916e-1bd2546ebf37
   (do not change this comment) */