callint.c 30.2 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
{
  Lisp_Object *args, *visargs;
  unsigned char **argstrings;
  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

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

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

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

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

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

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

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

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

      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;

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

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

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

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

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

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

471
	      Fselect_window (tem, Qnil);
472
	    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
	  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 *) "";
    }
492
  count = j;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
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;
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  QUIT;

  args[0] = function;

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

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

863 864 865
  if (record_then_fail)
    Fbarf_if_buffer_read_only ();

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

871
  single_kboard_state ();
872

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

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

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

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

  return val;
}

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

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

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

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

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

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

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


956
  DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
957 958 959 960 961 962 963 964 965
		 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").  */);
966

967
  DEFVAR_KBOARD ("last-prefix-arg", Vlast_prefix_arg,
968 969
		 doc: /* The value of the prefix argument for the previous editing command.
See `prefix-arg' for the meaning of the value.  */);
970

971
  DEFVAR_LISP ("current-prefix-arg", &Vcurrent_prefix_arg,
972 973 974 975 976
	       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.  */);
977 978
  Vcurrent_prefix_arg = Qnil;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
979
  DEFVAR_LISP ("command-history", &Vcommand_history,
980 981
	       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
982 983 984
  Vcommand_history = Qnil;

  DEFVAR_LISP ("command-debug-status", &Vcommand_debug_status,
985 986 987
	       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
988 989
  Vcommand_debug_status = Qnil;

990
  DEFVAR_LISP ("mark-even-if-inactive", &Vmark_even_if_inactive,
991 992 993 994 995
	       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.  */);