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, 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
       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.
113
U -- Mouse up event discarded by a previous k or K argument.
114 115 116 117 118 119 120 121 122 123 124 125
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
126 127
 processed in the order that they appear.
usage: (interactive ARGS)  */)
128
     (args)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
129 130 131 132 133 134 135 136 137 138 139
     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;
{
140
  if (!INTEGERP (exp) && !STRINGP (exp)
Jim Blandy's avatar
Jim Blandy committed
141
      && !NILP (exp) && !EQ (exp, Qt))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
142 143 144 145 146 147 148 149 150 151 152
    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;
153 154
  Lisp_Object next;
  for (tail = exp; CONSP (tail); tail = next)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
155
    {
156
      next = XCDR (tail);
157
      XSETCAR (tail, quotify_arg (XCAR (tail)));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
158 159 160 161 162 163 164 165
    }
  return exp;
}

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

static void
166 167
check_mark (for_region)
     int for_region;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
168
{
169 170
  Lisp_Object tem;
  tem = Fmarker_buffer (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
171
  if (NILP (tem) || (XBUFFER (tem) != current_buffer))
172 173
    error (for_region ? "The mark is not set now, so there is no region"
	   : "The mark is not set now");
174 175 176
  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
177 178
}

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

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 212
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
213
	       intail = Fcdr (intail), valtail = XCDR (valtail))
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 246
	    {
	      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
247

248
DEFUN ("call-interactively", Fcall_interactively, Scall_interactively, 1, 3, 0,
249 250 251 252 253 254 255 256 257 258 259
       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
260 261
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.  */)
262
     (function, record_flag, keys)
263
     Lisp_Object function, record_flag, keys;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
264 265 266 267 268 269
{
  Lisp_Object *args, *visargs;
  unsigned char **argstrings;
  Lisp_Object fun;
  Lisp_Object funcar;
  Lisp_Object specs;
270
  Lisp_Object filter_specs;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
271
  Lisp_Object teml;
272
  Lisp_Object up_event;
Richard M. Stallman's avatar
Richard M. Stallman committed
273
  Lisp_Object enable;
Juanma Barranquero's avatar
Juanma Barranquero committed
274
  int speccount = SPECPDL_INDEX ();
Michael I. Bushnell's avatar
Michael I. Bushnell committed
275

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

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

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
317
 retry:
Michael I. Bushnell's avatar
Michael I. Bushnell committed
318

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

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

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

333 334 335
  /* 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
336 337 338 339
  /* 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.  */

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

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

	  /* Don't keep command history around forever.  */
398
	  if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
399 400 401
	    {
	      teml = Fnthcdr (Vhistory_length, Vcommand_history);
	      if (CONSP (teml))
402
		XSETCDR (teml, Qnil);
403
	    }
404
	}
405 406 407 408 409 410

      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;

411
      single_kboard_state ();
Michael I. Bushnell's avatar
Michael I. Bushnell committed
412 413 414 415 416
      return apply1 (function, specs);
    }

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

Jim Blandy's avatar
Jim Blandy committed
417
  /* Set next_event to point to the first event with parameters.  */
418 419
  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
420
      break;
421

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

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

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

472
	      Fselect_window (event, Qnil);
473
	    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
	  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 *) "";
    }
493
  count = j;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
494 495 496 497 498 499 500 501 502 503 504 505 506

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

507
  GCPRO5 (prefix_arg, function, *args, *visargs, up_event);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
508 509 510
  gcpro3.nvars = (count + 1);
  gcpro4.nvars = (count + 1);

Richard M. Stallman's avatar
Richard M. Stallman committed
511 512 513
  if (!NILP (enable))
    specbind (Qenable_recursive_minibuffers, Qt);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
514
  tem = string;
515
  for (i = 1; *tem; i++)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
516 517 518
    {
      strncpy (prompt1, tem + 1, sizeof prompt1 - 1);
      prompt1[sizeof prompt1 - 1] = 0;
519
      tem1 = (char *) index (prompt1, '\n');
Michael I. Bushnell's avatar
Michael I. Bushnell committed
520 521 522 523 524
      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]
525 526
	  = (EQ (visargs[j], Qnil)
	     ? (unsigned char *) ""
527
	     : SDATA (visargs[j]));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
528

529 530 531 532 533 534 535 536
      /* 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,
537
			       j - 1, (char **) argstrings + 1);
538
	  if (nchars < callint_message_size - 1)
539 540 541 542 543
	    break;
	  callint_message_size *= 2;
	  callint_message
	    = (char *) xrealloc (callint_message, callint_message_size);
	}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
544 545 546 547

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

	case 'B':		/* Name of buffer, possibly nonexistent */
564
	  args[i] = Fread_buffer (build_string (callint_message),
565
				  Fother_buffer (Fcurrent_buffer (), Qnil, Qnil),
566
				  Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
567 568 569
	  break;

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

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

	case 'D':		/* Directory name. */
594
	  args[i] = Fread_file_name (build_string (callint_message), Qnil,
595 596
				     current_buffer->directory, Qlambda, Qnil,
				     Qfile_directory_p);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
597 598 599
	  break;

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

	case 'F':		/* Possibly nonexistent file name. */
605
	  args[i] = Fread_file_name (build_string (callint_message),
606
				     Qnil, Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
607 608
	  break;

609 610 611 612
	case 'i':		/* Ignore an argument -- Does not do I/O */
	  varies[i] = -1;
	  break;

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

	    /* 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))
627
	      teml = XCAR (teml);
628 629 630 631 632
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

		teml = Fget (teml, intern ("event-symbol-elements"));
633 634
		/* Ignore first element, which is the base key.  */
		tem2 = Fmemq (intern ("down"), Fcdr (teml));
635
		if (! NILP (tem2))
636
		  up_event = Fread_event (Qnil, Qnil);
637
	      }
638
	  }
639 640 641
	  break;

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

	    /* 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))
655
	      teml = XCAR (teml);
656 657 658 659 660
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

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

669 670 671 672 673 674 675 676 677 678
	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;

679
	case 'e':		/* The invoking event.  */
680
	  if (next_event >= key_count)
681
	    error ("%s must be bound to an event with parameters",
682
		   (SYMBOLP (function)
683
		    ? (char *) SDATA (SYMBOL_NAME (function))
684
		    : "command"));
685
	  args[i] = XVECTOR (keys)->contents[next_event++];
Jim Blandy's avatar
Jim Blandy committed
686
	  varies[i] = -1;
Jim Blandy's avatar
Jim Blandy committed
687 688

	  /* Find the next parameterized event.  */
689
	  while (next_event < key_count
Jim Blandy's avatar
Jim Blandy committed
690
		 && ! (EVENT_HAS_PARAMETERS
691
		       (XVECTOR (keys)->contents[next_event])))
Jim Blandy's avatar
Jim Blandy committed
692 693
	    next_event++;

Jim Blandy's avatar
Jim Blandy committed
694 695
	  break;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
696
	case 'm':		/* Value of mark.  Does not do I/O.  */
697
	  check_mark (0);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
698
	  /* visargs[i] = Qnil; */
699
	  args[i] = current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
700 701 702
	  varies[i] = 2;
	  break;

703 704 705 706 707 708
	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
709
	case 'N':		/* Prefix arg, else number from minibuffer */
Jim Blandy's avatar
Jim Blandy committed
710
	  if (!NILP (prefix_arg))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
711 712
	    goto have_prefix_arg;
	case 'n':		/* Read number from minibuffer.  */
713 714 715 716 717 718 719 720
	  {
	    int first = 1;
	    do
	      {
		Lisp_Object tem;
		if (!  first)
		  {
		    message ("Please enter a number.");
721
		    sit_for (1, 0, 0, 0, 0);
722 723 724 725
		  }
		first = 0;

		tem = Fread_from_minibuffer (build_string (callint_message),
726 727
					     Qnil, Qnil, Qnil, Qnil, Qnil,
					     Qnil);
728
		if (! STRINGP (tem) || SCHARS (tem) == 0)
729 730 731 732 733 734
		  args[i] = Qnil;
		else
		  args[i] = Fread (tem);
	      }
	    while (! NUMBERP (args[i]));
	  }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
735 736 737 738 739 740 741 742 743 744
	  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. */
745
	have_prefix_arg:
Michael I. Bushnell's avatar
Michael I. Bushnell committed
746 747 748 749 750 751
	  args[i] = Fprefix_numeric_value (prefix_arg);
	  /* visargs[i] = Qnil; */
	  varies[i] = -1;
	  break;

	case 'r':		/* Region, point and mark as 2 args. */
752
	  check_mark (1);
753
	  set_marker_both (point_marker, Qnil, PT, PT_BYTE);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
754 755 756
	  /* visargs[i+1] = Qnil; */
	  foo = marker_position (current_buffer->mark);
	  /* visargs[i] = Qnil; */
757
	  args[i] = PT < foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
758
	  varies[i] = 3;
759
	  args[++i] = PT > foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
760 761 762
	  varies[i] = 4;
	  break;

763 764
	case 's':		/* String read via minibuffer without
				   inheriting the current input method.  */
765
	  args[i] = Fread_string (build_string (callint_message),
766
				  Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
767 768 769
	  break;

	case 'S':		/* Any symbol.  */
770
	  visargs[i] = Fread_string (build_string (callint_message),
771
				     Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
772 773 774 775 776 777 778
	  /* 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. */
779
	  args[i] = Fread_variable (build_string (callint_message), Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
780 781 782 783
	  visargs[i] = last_minibuf_string;
	  break;

	case 'x':		/* Lisp expression read but not evaluated */
784
	  args[i] = Fread_minibuffer (build_string (callint_message), Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
785 786 787 788
	  visargs[i] = last_minibuf_string;
	  break;

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

793 794 795 796 797 798 799
	case 'Z':		/* Coding-system symbol, or ignore the
				   argument if no prefix */
	  if (NILP (prefix_arg))
	    {
	      args[i] = Qnil;
	      varies[i] = -1;
	    }
800
	  else
801 802 803 804 805 806 807 808
	    {
	      args[i]
		= Fread_non_nil_coding_system (build_string (callint_message));
	      visargs[i] = last_minibuf_string;
	    }
	  break;

	case 'z':		/* Coding-system symbol or nil */
809
	  args[i] = Fread_coding_system (build_string (callint_message), Qnil);
810 811 812
	  visargs[i] = last_minibuf_string;
	  break;

813 814 815
	  /* 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
816
	default:
817
	  error ("Invalid control letter `%c' (%03o) in interactive calling string",
Michael I. Bushnell's avatar
Michael I. Bushnell committed
818 819 820 821 822 823
		 *tem, *tem);
	}

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

824
      if (NILP (visargs[i]) && STRINGP (args[i]))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
825 826 827 828 829 830
	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
831
  unbind_to (speccount, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
832 833 834 835 836

  QUIT;

  args[0] = function;

837
  if (arg_from_tty || !NILP (record_flag))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
838 839
    {
      visargs[0] = function;
Jim Blandy's avatar
Jim Blandy committed
840
      for (i = 1; i < count + 1; i++)
841 842 843 844 845 846
	{
	  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
847 848
      Vcommand_history = Fcons (Flist (count + 1, visargs),
				Vcommand_history);
849
      /* Don't keep command history around forever.  */
850
      if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
851 852 853
	{
	  teml = Fnthcdr (Vhistory_length, Vcommand_history);
	  if (CONSP (teml))
854
	    XSETCDR (teml, Qnil);
855
	}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
856 857
    }

858 859
  /* If we used a marker to hold point, mark, or an end of the region,
     temporarily, convert it to an integer now.  */
860
  for (i = 1; i <= count; i++)
861 862 863
    if (varies[i] >= 1 && varies[i] <= 4)
      XSETINT (args[i], marker_position (args[i]));

864 865 866
  if (record_then_fail)
    Fbarf_if_buffer_read_only ();

867 868 869 870 871
  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;

872
  single_kboard_state ();
873

Michael I. Bushnell's avatar
Michael I. Bushnell committed
874 875 876 877 878 879 880 881
  {
    Lisp_Object val;
    specbind (Qcommand_debug_status, Qnil);

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

DEFUN ("prefix-numeric-value", Fprefix_numeric_value, Sprefix_numeric_value,
885 886 887 888 889
       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
890 891 892
     Lisp_Object raw;
{
  Lisp_Object val;
893

Jim Blandy's avatar
Jim Blandy committed
894
  if (NILP (raw))
895
    XSETFASTINT (val, 1);
896
  else if (EQ (raw, Qminus))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
897
    XSETINT (val, -1);
898 899
  else if (CONSP (raw) && INTEGERP (XCAR (raw)))
    XSETINT (val, XINT (XCAR (raw)));
900
  else if (INTEGERP (raw))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
901 902
    val = raw;
  else
903
    XSETFASTINT (val, 1);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
904 905 906 907

  return val;
}

Andreas Schwab's avatar
Andreas Schwab committed
908
void
Michael I. Bushnell's avatar
Michael I. Bushnell committed
909 910
syms_of_callint ()
{
911 912 913
  point_marker = Fmake_marker ();
  staticpro (&point_marker);

914 915 916 917 918 919 920 921
  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);
922 923
  Qlet = intern ("let");
  staticpro (&Qlet);
924 925 926 927
  Qif = intern ("if");
  staticpro (&Qif);
  Qwhen = intern ("when");
  staticpro (&Qwhen);
928 929 930 931
  Qletx = intern ("let*");
  staticpro (&Qletx);
  Qsave_excursion = intern ("save-excursion");
  staticpro (&Qsave_excursion);
932 933
  Qprogn = intern ("progn");
  staticpro (&Qprogn);
934

Michael I. Bushnell's avatar
Michael I. Bushnell committed
935 936 937
  Qminus = intern ("-");
  staticpro (&Qminus);

Richard M. Stallman's avatar
Richard M. Stallman committed
938 939 940
  Qplus = intern ("+");
  staticpro (&Qplus);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
941 942 943 944 945 946
  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
947 948 949
  Qenable_recursive_minibuffers = intern ("enable-recursive-minibuffers");
  staticpro (&Qenable_recursive_minibuffers);

950 951 952
  Qmouse_leave_buffer_hook = intern ("mouse-leave-buffer-hook");
  staticpro (&Qmouse_leave_buffer_hook);

953 954 955 956
  callint_message_size = 100;
  callint_message = (char *) xmalloc (callint_message_size);


Karl Heuer's avatar