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, 1986, 1993, 1994, 1995, 1997, 2000, 2001, 2002,
Glenn Morris's avatar
Glenn Morris committed
3
                 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
Glenn Morris's avatar
Glenn Morris committed
4
                 Free Software Foundation, Inc.
Michael I. Bushnell's avatar
Michael I. Bushnell committed
5 6 7

This file is part of GNU Emacs.

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

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
20 21


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

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

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

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

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

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

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

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

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

58 59
Lisp_Object Vmouse_leave_buffer_hook, Qmouse_leave_buffer_hook;

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

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

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

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

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

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

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

  return exp;
}

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

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
182 183 184 185 186 187 188 189
/* 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.  */

190
static void
191
fix_command (Lisp_Object input, Lisp_Object values)
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
{
  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
215
	       intail = Fcdr (intail), valtail = XCDR (valtail))
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 247 248
	    {
	      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
249

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

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

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

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
315
  /* Save this now, since use of minibuffer will clobber it. */
316
  prefix_arg = Vcurrent_prefix_arg;
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

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

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

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

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

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

      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;

391 392
      temporarily_switch_to_single_kboard (NULL);
      return unbind_to (speccount, apply1 (function, specs));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
393 394 395 396
    }

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

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

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

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

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

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

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

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

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

494
  GCPRO5 (prefix_arg, function, *args, *visargs, up_event);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
495 496 497
  gcpro3.nvars = (count + 1);
  gcpro4.nvars = (count + 1);

Richard M. Stallman's avatar
Richard M. Stallman committed
498 499 500
  if (!NILP (enable))
    specbind (Qenable_recursive_minibuffers, Qt);

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

      visargs[0] = build_string (prompt1);
      if (index (prompt1, '%'))
	callint_message = Fformat (i, visargs);
      else
	callint_message = visargs[0];
Michael I. Bushnell's avatar
Michael I. Bushnell committed
514 515 516 517

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

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

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

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

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

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

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

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

583 584
	case 'G':		/* Possibly nonexistent file name,
				   default to directory alone. */
585
	  args[i] = Fread_file_name (callint_message,
586
				     Qnil, Qnil, Qnil, empty_unibyte_string, Qnil);
587 588
	  break;

589 590 591 592
	case 'i':		/* Ignore an argument -- Does not do I/O */
	  varies[i] = -1;
	  break;

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

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

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

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

	    /* 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))
643
	      teml = XCAR (teml);
644 645 646 647 648
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

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

657 658 659 660 661 662 663 664 665 666
	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;

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

	  /* Find the next parameterized event.  */
678
	  while (next_event < key_count
679
		 && !(EVENT_HAS_PARAMETERS (AREF (keys, next_event))))
Jim Blandy's avatar
Jim Blandy committed
680 681
	    next_event++;

Jim Blandy's avatar
Jim Blandy committed
682 683
	  break;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  QUIT;

  args[0] = function;

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

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

852 853 854
  if (record_then_fail)
    Fbarf_if_buffer_read_only ();

855 856 857 858 859
  Vthis_command = save_this_command;
  Vthis_original_command = save_this_original_command;
  real_this_command= save_real_this_command;
  current_kboard->Vlast_command = save_last_command;

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

864
    temporarily_switch_to_single_kboard (NULL);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
865 866 867 868
    val = Ffuncall (count + 1, args);
    UNGCPRO;
    return unbind_to (speccount, val);
  }
869
}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
870 871

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

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

  return val;
}

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

901 902 903
  callint_message = Qnil;
  staticpro (&callint_message);

Dan Nicolaescu's avatar
Dan Nicolaescu committed
904 905 906 907
  preserved_fns = pure_cons (intern_c_string ("region-beginning"),
			 pure_cons (intern_c_string ("region-end"),
				pure_cons (intern_c_string ("point"),
				       pure_cons (intern_c_string ("mark"), Qnil))));
908

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

Dan Nicolaescu's avatar
Dan Nicolaescu committed
924
  Qminus = intern_c_string ("-");
Michael I. Bushnell's avatar
Michael I. Bushnell committed
925 926
  staticpro (&Qminus);

Dan Nicolaescu's avatar
Dan Nicolaescu committed
927
  Qplus = intern_c_string ("+");
Richard M. Stallman's avatar
Richard M. Stallman committed
928 929
  staticpro (&Qplus);

Dan Nicolaescu's avatar
Dan Nicolaescu committed
930
  Qhandle_shift_selection = intern_c_string ("handle-shift-selection");
Chong Yidong's avatar
Chong Yidong committed
931 932
  staticpro (&Qhandle_shift_selection);

Dan Nicolaescu's avatar
Dan Nicolaescu committed
933
  Qcall_interactively = intern_c_string ("call-interactively");
Michael I. Bushnell's avatar
Michael I. Bushnell committed
934 935
  staticpro (&Qcall_interactively);

Dan Nicolaescu's avatar
Dan Nicolaescu committed
936
  Qcommand_debug_status = intern_c_string ("command-debug-status");
Michael I. Bushnell's avatar
Michael I. Bushnell committed
937 938
  staticpro (&Qcommand_debug_status);

Dan Nicolaescu's avatar
Dan Nicolaescu committed
939
  Qenable_recursive_minibuffers = intern_c_string ("enable-recursive-minibuffers");