callint.c 29.1 KB
Newer Older
Michael I. Bushnell's avatar
Michael I. Bushnell committed
1
/* Call a Lisp function interactively.
2 3
   Copyright (C) 1985, 1986, 1993, 1994, 1995, 1997, 2000, 2001, 2002,
                 2003, 2004, 2005, 2006, 2007  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
9
the Free Software Foundation; either version 3, 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
Lute Kamstra's avatar
Lute Kamstra committed
19 20
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, 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
/* String for the prompt text used in Fcall_interactively.  */
static Lisp_Object callint_message;
Richard M. Stallman's avatar
Richard M. Stallman committed
63

Michael I. Bushnell's avatar
Michael I. Bushnell committed
64 65
/* ARGSUSED */
DEFUN ("interactive", Finteractive, Sinteractive, 0, UNEVALLED, 0,
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
       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.
98
G -- Possibly nonexistent file name, defaulting to just directory name.
99 100 101 102 103 104
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
105
N -- Numeric prefix arg, or if none, do like code `n'.
106 107 108 109 110
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.
111
U -- Mouse up event discarded by a previous k or K argument.
112 113 114 115 116 117 118 119 120 121 122 123
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
124 125
 processed in the order that they appear.
usage: (interactive ARGS)  */)
126
     (args)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
127 128 129 130 131 132 133 134 135 136 137
     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;
{
138
  if (!INTEGERP (exp) && !STRINGP (exp)
Jim Blandy's avatar
Jim Blandy committed
139
      && !NILP (exp) && !EQ (exp, Qt))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
140 141 142 143 144 145 146 147 148 149 150
    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;
151 152
  Lisp_Object next;
  for (tail = exp; CONSP (tail); tail = next)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
153
    {
154
      next = XCDR (tail);
155
      XSETCAR (tail, quotify_arg (XCAR (tail)));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
156 157 158 159 160 161 162 163
    }
  return exp;
}

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

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

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

185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
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
211
	       intail = Fcdr (intail), valtail = XCDR (valtail))
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
	    {
	      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
245

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

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

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

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

  /* If varies[i] > 0, the i'th argument shouldn't just have its value
     in this call quoted in the command history.  It should be
     recorded as a call to the function named callint_argfuns[varies[i]].  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
285
  int *varies;
Jim Blandy's avatar
Jim Blandy committed
286

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

296 297 298 299 300 301 302 303
  Lisp_Object save_this_command, save_last_command;
  Lisp_Object save_this_original_command, save_real_this_command;

  save_this_command = Vthis_command;
  save_this_original_command = Vthis_original_command;
  save_real_this_command = real_this_command;
  save_last_command = current_kboard->Vlast_command;

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

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

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

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

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

329 330 331
  /* 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
332
  /* Decode the kind of function.  Either handle it and return,
333
     or go to `lose' if not interactive, or set either STRING or SPECS.  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
334

335 336 337 338 339 340 341 342 343 344
  {
    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
345

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

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

      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;

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

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

Jim Blandy's avatar
Jim Blandy committed
395
  /* Set next_event to point to the first event with parameters.  */
396 397
  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
398
      break;
399

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

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

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

450
	      Fselect_window (tem, Qnil);
451
	    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
452 453 454 455 456 457 458 459
	  string++;
	}
      else break;
    }

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

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

487
  GCPRO5 (prefix_arg, function, *args, *visargs, up_event);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
488 489 490
  gcpro3.nvars = (count + 1);
  gcpro4.nvars = (count + 1);

Richard M. Stallman's avatar
Richard M. Stallman committed
491 492 493
  if (!NILP (enable))
    specbind (Qenable_recursive_minibuffers, Qt);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
494
  tem = string;
495
  for (i = 1; *tem; i++)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
496 497 498
    {
      strncpy (prompt1, tem + 1, sizeof prompt1 - 1);
      prompt1[sizeof prompt1 - 1] = 0;
499
      tem1 = (char *) index (prompt1, '\n');
Michael I. Bushnell's avatar
Michael I. Bushnell committed
500
      if (tem1) *tem1 = 0;
501 502 503 504 505 506

      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
507 508 509 510

      switch (*tem)
	{
	case 'a':		/* Symbol defined as a function */
511
	  visargs[i] = Fcompleting_read (callint_message,
512
					 Vobarray, Qfboundp, Qt,
513
					 Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
514 515 516 517 518 519 520 521
	  /* 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))
522
	    args[i] = Fother_buffer (args[i], Qnil, Qnil);
523
	  args[i] = Fread_buffer (callint_message, args[i], Qt);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
524 525 526
	  break;

	case 'B':		/* Name of buffer, possibly nonexistent */
527
	  args[i] = Fread_buffer (callint_message,
528
				  Fother_buffer (Fcurrent_buffer (), Qnil, Qnil),
529
				  Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
530 531 532
	  break;

        case 'c':		/* Character */
533
	  args[i] = Fread_char (callint_message, Qnil, Qnil);
534
	  message1_nolog ((char *) 0);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
535 536 537 538 539 540
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = args[i];
	  visargs[i] = Fchar_to_string (teml);
	  break;

	case 'C':		/* Command: symbol with interactive function */
541
	  visargs[i] = Fcompleting_read (callint_message,
542
					 Vobarray, Qcommandp,
543
					 Qt, Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
544 545 546 547 548 549
	  /* 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.  */
550
	  set_marker_both (point_marker, Qnil, PT, PT_BYTE);
551
	  args[i] = point_marker;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
552 553 554 555 556
	  /* visargs[i] = Qnil; */
	  varies[i] = 1;
	  break;

	case 'D':		/* Directory name. */
557
	  args[i] = Fread_file_name (callint_message, Qnil,
558 559
				     current_buffer->directory, Qlambda, Qnil,
				     Qfile_directory_p);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
560 561 562
	  break;

	case 'f':		/* Existing file name. */
563
	  args[i] = Fread_file_name (callint_message,
564
				     Qnil, Qnil, Qlambda, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
565 566 567
	  break;

	case 'F':		/* Possibly nonexistent file name. */
568
	  args[i] = Fread_file_name (callint_message,
569
				     Qnil, Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
570 571
	  break;

572 573
	case 'G':		/* Possibly nonexistent file name,
				   default to directory alone. */
574
	  args[i] = Fread_file_name (callint_message,
575
				     Qnil, Qnil, Qnil, empty_unibyte_string, Qnil);
576 577
	  break;

578 579 580 581
	case 'i':		/* Ignore an argument -- Does not do I/O */
	  varies[i] = -1;
	  break;

582
	case 'k':		/* Key sequence. */
583
	  {
Juanma Barranquero's avatar
Juanma Barranquero committed
584
	    int speccount1 = SPECPDL_INDEX ();
585
	    specbind (Qcursor_in_echo_area, Qt);
586
	    args[i] = Fread_key_sequence (callint_message,
587
					  Qnil, Qnil, Qnil, Qnil);
588 589
	    unbind_to (speccount1, Qnil);
	    teml = args[i];
590
	    visargs[i] = Fkey_description (teml, Qnil);
591 592 593 594 595

	    /* 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))
596
	      teml = XCAR (teml);
597 598 599 600 601
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

		teml = Fget (teml, intern ("event-symbol-elements"));
602 603
		/* Ignore first element, which is the base key.  */
		tem2 = Fmemq (intern ("down"), Fcdr (teml));
604
		if (! NILP (tem2))
Chong Yidong's avatar
Chong Yidong committed
605
		  up_event = Fread_event (Qnil, Qnil, Qnil);
606
	      }
607
	  }
608 609 610
	  break;

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

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

		teml = Fget (teml, intern ("event-symbol-elements"));
630 631
		/* Ignore first element, which is the base key.  */
		tem2 = Fmemq (intern ("down"), Fcdr (teml));
632
		if (! NILP (tem2))
Chong Yidong's avatar
Chong Yidong committed
633
		  up_event = Fread_event (Qnil, Qnil, Qnil);
634
	      }
635
	  }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
636 637
	  break;

638 639 640 641 642 643 644 645 646 647
	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;

648
	case 'e':		/* The invoking event.  */
649
	  if (next_event >= key_count)
650
	    error ("%s must be bound to an event with parameters",
651
		   (SYMBOLP (function)
652
		    ? (char *) SDATA (SYMBOL_NAME (function))
653
		    : "command"));
654
	  args[i] = XVECTOR (keys)->contents[next_event++];
Jim Blandy's avatar
Jim Blandy committed
655
	  varies[i] = -1;
Jim Blandy's avatar
Jim Blandy committed
656 657

	  /* Find the next parameterized event.  */
658
	  while (next_event < key_count
Jim Blandy's avatar
Jim Blandy committed
659
		 && ! (EVENT_HAS_PARAMETERS
660
		       (XVECTOR (keys)->contents[next_event])))
Jim Blandy's avatar
Jim Blandy committed
661 662
	    next_event++;

Jim Blandy's avatar
Jim Blandy committed
663 664
	  break;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
665
	case 'm':		/* Value of mark.  Does not do I/O.  */
666
	  check_mark (0);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
667
	  /* visargs[i] = Qnil; */
668
	  args[i] = current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
669 670 671
	  varies[i] = 2;
	  break;

672 673
	case 'M':		/* String read via minibuffer with
				   inheriting the current input method.  */
674
	  args[i] = Fread_string (callint_message,
675 676 677
				  Qnil, Qnil, Qnil, Qt);
	  break;

Richard M. Stallman's avatar
Richard M. Stallman committed
678
	case 'N':		/* Prefix arg as number, else number from minibuffer */
Jim Blandy's avatar
Jim Blandy committed
679
	  if (!NILP (prefix_arg))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
680 681
	    goto have_prefix_arg;
	case 'n':		/* Read number from minibuffer.  */
682 683 684 685 686
	  {
	    int first = 1;
	    do
	      {
		Lisp_Object tem;
687
		if (! first)
688 689
		  {
		    message ("Please enter a number.");
690
		    sit_for (make_number (1), 0, 0);
691 692 693
		  }
		first = 0;

694
		tem = Fread_from_minibuffer (callint_message,
695
					     Qnil, Qnil, Qnil, Qnil, Qnil,
696
					     Qnil);
697
		if (! STRINGP (tem) || SCHARS (tem) == 0)
698 699 700 701 702 703
		  args[i] = Qnil;
		else
		  args[i] = Fread (tem);
	      }
	    while (! NUMBERP (args[i]));
	  }
704
	  visargs[i] = args[i];
Michael I. Bushnell's avatar
Michael I. Bushnell committed
705 706 707 708 709 710 711 712 713
	  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. */
714
	have_prefix_arg:
Michael I. Bushnell's avatar
Michael I. Bushnell committed
715 716 717 718 719 720
	  args[i] = Fprefix_numeric_value (prefix_arg);
	  /* visargs[i] = Qnil; */
	  varies[i] = -1;
	  break;

	case 'r':		/* Region, point and mark as 2 args. */
721
	  check_mark (1);
722
	  set_marker_both (point_marker, Qnil, PT, PT_BYTE);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
723 724 725
	  /* visargs[i+1] = Qnil; */
	  foo = marker_position (current_buffer->mark);
	  /* visargs[i] = Qnil; */
726
	  args[i] = PT < foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
727
	  varies[i] = 3;
728
	  args[++i] = PT > foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
729 730 731
	  varies[i] = 4;
	  break;

732 733
	case 's':		/* String read via minibuffer without
				   inheriting the current input method.  */
734
	  args[i] = Fread_string (callint_message,
735
				  Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
736 737 738
	  break;

	case 'S':		/* Any symbol.  */
739
	  visargs[i] = Fread_string (callint_message,
740
				     Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
741 742 743 744 745 746 747
	  /* 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. */
748
	  args[i] = Fread_variable (callint_message, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
749 750 751 752
	  visargs[i] = last_minibuf_string;
	  break;

	case 'x':		/* Lisp expression read but not evaluated */
753
	  args[i] = Fread_minibuffer (callint_message, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
754 755 756 757
	  visargs[i] = last_minibuf_string;
	  break;

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

762 763 764 765 766 767 768
	case 'Z':		/* Coding-system symbol, or ignore the
				   argument if no prefix */
	  if (NILP (prefix_arg))
	    {
	      args[i] = Qnil;
	      varies[i] = -1;
	    }
769
	  else
770 771
	    {
	      args[i]
772
		= Fread_non_nil_coding_system (callint_message);
773 774 775 776 777
	      visargs[i] = last_minibuf_string;
	    }
	  break;

	case 'z':		/* Coding-system symbol or nil */
778
	  args[i] = Fread_coding_system (callint_message, Qnil);
779 780 781
	  visargs[i] = last_minibuf_string;
	  break;

782 783 784
	  /* 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
785
	default:
786
	  error ("Invalid control letter `%c' (%03o) in interactive calling string",
Michael I. Bushnell's avatar
Michael I. Bushnell committed
787 788 789 790 791 792
		 *tem, *tem);
	}

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

793
      if (NILP (visargs[i]) && STRINGP (args[i]))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
794 795 796 797 798 799
	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
800
  unbind_to (speccount, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
801 802 803 804 805

  QUIT;

  args[0] = function;

806
  if (arg_from_tty || !NILP (record_flag))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
807 808
    {
      visargs[0] = function;
Jim Blandy's avatar
Jim Blandy committed
809
      for (i = 1; i < count + 1; i++)
810 811 812 813 814 815
	{
	  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
816 817
      Vcommand_history = Fcons (Flist (count + 1, visargs),
				Vcommand_history);
818
      /* Don't keep command history around forever.  */
819
      if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
820 821 822
	{
	  teml = Fnthcdr (Vhistory_length, Vcommand_history);
	  if (CONSP (teml))
823
	    XSETCDR (teml, Qnil);
824
	}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
825 826
    }

827 828
  /* If we used a marker to hold point, mark, or an end of the region,
     temporarily, convert it to an integer now.  */
829
  for (i = 1; i <= count; i++)
830 831 832
    if (varies[i] >= 1 && varies[i] <= 4)
      XSETINT (args[i], marker_position (args[i]));

833 834 835
  if (record_then_fail)
    Fbarf_if_buffer_read_only ();

836 837 838 839 840
  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
841 842 843 844
  {
    Lisp_Object val;
    specbind (Qcommand_debug_status, Qnil);

845
    temporarily_switch_to_single_kboard (NULL);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
846 847 848 849
    val = Ffuncall (count + 1, args);
    UNGCPRO;
    return unbind_to (speccount, val);
  }
850
}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
851 852

DEFUN ("prefix-numeric-value", Fprefix_numeric_value, Sprefix_numeric_value,
853 854 855 856 857
       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
858 859 860
     Lisp_Object raw;
{
  Lisp_Object val;
861

Jim Blandy's avatar
Jim Blandy committed
862
  if (NILP (raw))
863
    XSETFASTINT (val, 1);
864
  else if (EQ (raw, Qminus))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
865
    XSETINT (val, -1);
866 867
  else if (CONSP (raw) && INTEGERP (XCAR (raw)))
    XSETINT (val, XINT (XCAR (raw)));
868
  else if (INTEGERP (raw))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
869 870
    val = raw;
  else
871
    XSETFASTINT (val, 1);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
872 873 874 875

  return val;
}

Andreas Schwab's avatar
Andreas Schwab committed
876
void
Michael I. Bushnell's avatar
Michael I. Bushnell committed
877 878
syms_of_callint ()
{
879 880 881
  point_marker = Fmake_marker ();
  staticpro (&point_marker);

882 883 884
  callint_message = Qnil;
  staticpro (&callint_message);

885 886 887 888 889 890 891 892
  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);
893 894
  Qlet = intern ("let");
  staticpro (&Qlet);
895 896 897 898
  Qif = intern ("if");
  staticpro (&Qif);
  Qwhen = intern ("when");
  staticpro (&Qwhen);
899 900 901 902
  Qletx = intern ("let*");
  staticpro (&Qletx);
  Qsave_excursion = intern ("save-excursion");
  staticpro (&Qsave_excursion);
903 904
  Qprogn = intern ("progn");
  staticpro (&Qprogn);
905

Michael I. Bushnell's avatar
Michael I. Bushnell committed
906 907 908
  Qminus = intern ("-");
  staticpro (&Qminus);

Richard M. Stallman's avatar
Richard M. Stallman committed
909 910 911
  Qplus = intern ("+");
  staticpro (&Qplus);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
912 913 914 915 916 917
  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
918 919 920
  Qenable_recursive_minibuffers = intern ("enable-recursive-minibuffers");
  staticpro (&Qenable_recursive_minibuffers);

921 922 923
  Qmouse_leave_buffer_hook = intern ("mouse-leave-buffer-hook");
  staticpro (&Qmouse_leave_buffer_hook);

924
  DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
925 926 927 928 929 930 931 932 933
		 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").  */);
934

935
  DEFVAR_KBOARD ("last-prefix-arg", Vlast_prefix_arg,
936 937
		 doc: /* The value of the prefix argument for the previous editing command.
See `prefix-arg' for the meaning of the value.  */);
938

939
  DEFVAR_LISP ("current-prefix-arg", &Vcurrent_prefix_arg,
940 941 942 943 944
	       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.  */);
945 946
  Vcurrent_prefix_arg = Qnil;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
947
  DEFVAR_LISP ("command-history", &Vcommand_history,
948 949
	       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
950 951 952
  Vcommand_history = Qnil;

  DEFVAR_LISP ("command-debug-status", &Vcommand_debug_status,
953 954 955
	       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
956 957
  Vcommand_debug_status = Qnil;

958
  DEFVAR_LISP ("mark-even-if-inactive", &Vmark_even_if_inactive,
959 960 961 962 963
	       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.  */);
964 965
  Vmark_even_if_inactive = Qnil;