callint.c 29.1 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 4
                 2003, 2004, 2005, 2006, 2007, 2008
                 Free Software Foundation, Inc.
Michael I. Bushnell's avatar
Michael I. Bushnell committed
5 6 7 8 9

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
10
the Free Software Foundation; either version 3, or (at your option)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
11 12 13 14 15 16 17 18 19
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
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
22 23


24
#include <config.h>
25

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

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

37
extern Lisp_Object Qcursor_in_echo_area;
38
extern Lisp_Object Qfile_directory_p;
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

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

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

54 55
Lisp_Object Vmouse_leave_buffer_hook, Qmouse_leave_buffer_hook;

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

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

62 63
/* String for the prompt text used in Fcall_interactively.  */
static Lisp_Object callint_message;
Richard M. Stallman's avatar
Richard M. Stallman committed
64

Michael I. Bushnell's avatar
Michael I. Bushnell committed
65 66
/* ARGSUSED */
DEFUN ("interactive", Finteractive, Sinteractive, 0, UNEVALLED, 0,
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 98
       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.
99
G -- Possibly nonexistent file name, defaulting to just directory name.
100 101 102 103 104 105
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
106
N -- Numeric prefix arg, or if none, do like code `n'.
107 108 109 110 111
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.
112
U -- Mouse up event discarded by a previous k or K argument.
113 114 115 116 117 118 119 120 121 122 123 124
v -- Variable name: symbol that is user-variable-p.
x -- Lisp expression read but not evaluated.
X -- Lisp expression read and evaluated.
z -- Coding system.
Z -- Coding system, nil if no prefix arg.
In addition, if the string begins with `*'
 then an error is signaled if the buffer is read-only.
 This happens before reading any arguments.
If the string begins with `@', then Emacs searches the key sequence
 which invoked the command for its first mouse click (or any other
 event which specifies a window), and selects that window before
 reading any arguments.  You may use both `@' and `*'; they are
125 126
 processed in the order that they appear.
usage: (interactive ARGS)  */)
127
     (args)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
128 129 130 131 132 133 134 135 136 137 138
     Lisp_Object args;
{
  return Qnil;
}

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

  return exp;
}

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

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
178 179 180 181 182 183 184 185
/* If the list of args INPUT was produced with an explicit call to
   `list', look for elements that were computed with
   (region-beginning) or (region-end), and put those expressions into
   VALUES instead of the present values.

   This function doesn't return a value because it modifies elements
   of VALUES to do its job.  */

186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
static void
fix_command (input, values)
     Lisp_Object input, values;
{
  if (CONSP (input))
    {
      Lisp_Object car;

      car = XCAR (input);
      /* Skip through certain special forms.  */
      while (EQ (car, Qlet) || EQ (car, Qletx)
	     || EQ (car, Qsave_excursion)
	     || EQ (car, Qprogn))
	{
	  while (CONSP (XCDR (input)))
	    input = XCDR (input);
	  input = XCAR (input);
	  if (!CONSP (input))
	    break;
	  car = XCAR (input);
	}
      if (EQ (car, Qlist))
	{
	  Lisp_Object intail, valtail;
	  for (intail = Fcdr (input), valtail = values;
	       CONSP (valtail);
Stefan Monnier's avatar
Stefan Monnier committed
212
	       intail = Fcdr (intail), valtail = XCDR (valtail))
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
	    {
	      Lisp_Object elt;
	      elt = Fcar (intail);
	      if (CONSP (elt))
		{
		  Lisp_Object presflag, carelt;
		  carelt = Fcar (elt);
		  /* If it is (if X Y), look at Y.  */
		  if (EQ (carelt, Qif)
		      && EQ (Fnthcdr (make_number (3), elt), Qnil))
		    elt = Fnth (make_number (2), elt);
		  /* If it is (when ... Y), look at Y.  */
		  else if (EQ (carelt, Qwhen))
		    {
		      while (CONSP (XCDR (elt)))
			elt = XCDR (elt);
		      elt = Fcar (elt);
		    }

		  /* If the function call we're looking at
		     is a special preserved one, copy the
		     whole expression for this argument.  */
		  if (CONSP (elt))
		    {
		      presflag = Fmemq (Fcar (elt), preserved_fns);
		      if (!NILP (presflag))
			Fsetcar (valtail, Fcar (intail));
		    }
		}
	    }
	}
    }
}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
246

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

259
Optional third arg KEYS, if given, specifies the sequence of events to
260 261 262
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.  */)
263
     (function, record_flag, keys)
264
     Lisp_Object function, record_flag, keys;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
265 266 267
{
  Lisp_Object *args, *visargs;
  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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
320 321
  specs = Qnil;
  string = 0;
322 323 324 325
  /* 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
326

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

330
  /* Set SPECS to the interactive form, or barf if not interactive.  */
331 332 333 334 335 336 337 338 339 340
  {
    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
341

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

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

      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;

385 386
      temporarily_switch_to_single_kboard (NULL);
      return unbind_to (speccount, apply1 (function, specs));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
387 388 389 390
    }

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

Jim Blandy's avatar
Jim Blandy committed
391
  /* Set next_event to point to the first event with parameters.  */
392 393
  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
394
      break;
395

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

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

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

446
	      Fselect_window (tem, Qnil);
447
	    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
448 449 450 451 452 453 454 455
	  string++;
	}
      else break;
    }

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

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

483
  GCPRO5 (prefix_arg, function, *args, *visargs, up_event);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
484 485 486
  gcpro3.nvars = (count + 1);
  gcpro4.nvars = (count + 1);

Richard M. Stallman's avatar
Richard M. Stallman committed
487 488 489
  if (!NILP (enable))
    specbind (Qenable_recursive_minibuffers, Qt);

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

      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
503 504 505 506

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

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

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

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

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

	case 'f':		/* Existing file name. */
559
	  args[i] = Fread_file_name (callint_message,
560
				     Qnil, Qnil, Qlambda, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
561 562 563
	  break;

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

568 569
	case 'G':		/* Possibly nonexistent file name,
				   default to directory alone. */
570
	  args[i] = Fread_file_name (callint_message,
571
				     Qnil, Qnil, Qnil, empty_unibyte_string, Qnil);
572 573
	  break;

574 575 576 577
	case 'i':		/* Ignore an argument -- Does not do I/O */
	  varies[i] = -1;
	  break;

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

	    /* 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))
592
	      teml = XCAR (teml);
593 594 595 596 597
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

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

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

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

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

634 635 636 637 638 639 640 641 642 643
	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;

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

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

Jim Blandy's avatar
Jim Blandy committed
659 660
	  break;

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

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

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

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

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

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

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

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

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

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

	case 'z':		/* Coding-system symbol or nil */
774
	  args[i] = Fread_coding_system (callint_message, Qnil);
775 776 777
	  visargs[i] = last_minibuf_string;
	  break;

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

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

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

  QUIT;

  args[0] = function;

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

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

829 830 831
  if (record_then_fail)
    Fbarf_if_buffer_read_only ();

832 833 834 835 836
  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
837 838 839 840
  {
    Lisp_Object val;
    specbind (Qcommand_debug_status, Qnil);

841
    temporarily_switch_to_single_kboard (NULL);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
842 843 844 845
    val = Ffuncall (count + 1, args);
    UNGCPRO;
    return unbind_to (speccount, val);
  }
846
}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
847 848

DEFUN ("prefix-numeric-value", Fprefix_numeric_value, Sprefix_numeric_value,
849 850 851 852 853
       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
854 855 856
     Lisp_Object raw;
{
  Lisp_Object val;
857

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

  return val;
}

Andreas Schwab's avatar
Andreas Schwab committed
872
void
Michael I. Bushnell's avatar
Michael I. Bushnell committed
873 874
syms_of_callint ()
{
875 876 877
  point_marker = Fmake_marker ();
  staticpro (&point_marker);

878 879 880
  callint_message = Qnil;
  staticpro (&callint_message);

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
902 903 904
  Qminus = intern ("-");
  staticpro (&Qminus);

Richard M. Stallman's avatar
Richard M. Stallman committed
905 906 907
  Qplus = intern ("+");
  staticpro (&Qplus);

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

917 918 919
  Qmouse_leave_buffer_hook = intern ("mouse-leave-buffer-hook");
  staticpro (&Qmouse_leave_buffer_hook);

920
  DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
921 922 923 924 925 926 927 928 929
		 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").  */);
930

931
  DEFVAR_KBOARD ("last-prefix-arg", Vlast_prefix_arg,
932 933
		 doc: /* The value of the prefix argument for the previous editing command.
See `prefix-arg' for the meaning of the value.  */);
934

935
  DEFVAR_LISP ("current-prefix-arg", &Vcurrent_prefix_arg,
936 937 938 939 940
	       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.  */);
941 942
  Vcurrent_prefix_arg = Qnil;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
943
  DEFVAR_LISP ("command-history", &Vcommand_history,
944
	       doc: /* List of recent commands that read arguments from terminal.
945 946 947 948
Each command is represented as a form to evaluate.

Maximum length of the history list is determined by the value
of `history-length', which see.  */);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
949 950 951
  Vcommand_history = Qnil;

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

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

965
  DEFVAR_LISP ("mouse-leave-buffer-hook", &Vmouse_leave_buffer_hook,
966 967 968
	       doc: /* Hook to run when about to switch windows with a mouse command.
Its purpose is to give temporary modes such as Isearch mode
a way to turn themselves off when a mouse command switches windows.  */);
969 970
  Vmouse_leave_buffer_hook = Qnil;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
971 972 973 974
  defsubr (&Sinteractive);
  defsubr (&Scall_interactively);
  defsubr (&Sprefix_numeric_value);
}
Miles Bader's avatar
Miles Bader committed
975 976 977

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