callint.c 30.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
                 2003, 2004, 2005, 2006, 2007, 2008, 2009
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

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

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

35
extern Lisp_Object Qcursor_in_echo_area;
36
extern Lisp_Object Qfile_directory_p;
37
extern Lisp_Object Qonly;
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
extern int history_delete_duplicates;
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;
49
extern Lisp_Object Qface, Qminibuffer_prompt;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
50

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

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

57 58
Lisp_Object Vmouse_leave_buffer_hook, Qmouse_leave_buffer_hook;

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

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

65 66
/* String for the prompt text used in Fcall_interactively.  */
static Lisp_Object callint_message;
Richard M. Stallman's avatar
Richard M. Stallman committed
67

Michael I. Bushnell's avatar
Michael I. Bushnell committed
68 69
/* ARGSUSED */
DEFUN ("interactive", Finteractive, Sinteractive, 0, UNEVALLED, 0,
70 71
       doc: /* Specify a way of parsing arguments for interactive use of a function.
For example, write
72 73 74
 (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.
75 76 77 78 79
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.

80 81 82 83 84
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
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
 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.
103
G -- Possibly nonexistent file name, defaulting to just directory name.
104 105 106 107 108 109
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
110
N -- Numeric prefix arg, or if none, do like code `n'.
111 112 113 114 115
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.
116
U -- Mouse up event discarded by a previous k or K argument.
117 118 119 120 121
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
122 123 124 125 126 127 128 129 130 131

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,
 Emacs first calls the function `handle-shift-select'.
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
132
usage: (interactive &optional ARGS)  */)
133
     (args)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
134 135 136 137 138 139 140 141 142 143 144
     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;
{
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 154 155 156 157
    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;
158 159
  Lisp_Object next;
  for (tail = exp; CONSP (tail); tail = next)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
160
    {
161
      next = XCDR (tail);
162
      XSETCAR (tail, quotify_arg (XCAR (tail)));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
163 164 165 166 167 168 169 170
    }
  return exp;
}

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

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

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

192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
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
218
	       intail = Fcdr (intail), valtail = XCDR (valtail))
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 249 250 251
	    {
	      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
252

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

265
Optional third arg KEYS, if given, specifies the sequence of events to
266 267 268
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.  */)
269
     (function, record_flag, keys)
270
     Lisp_Object function, record_flag, keys;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
271 272 273
{
  Lisp_Object *args, *visargs;
  Lisp_Object specs;
274
  Lisp_Object filter_specs;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
275
  Lisp_Object teml;
276
  Lisp_Object up_event;
Richard M. Stallman's avatar
Richard M. Stallman committed
277
  Lisp_Object enable;
Juanma Barranquero's avatar
Juanma Barranquero committed
278
  int speccount = SPECPDL_INDEX ();
Michael I. Bushnell's avatar
Michael I. Bushnell committed
279

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
284 285 286
  Lisp_Object prefix_arg;
  unsigned char *string;
  unsigned char *tem;
Jim Blandy's avatar
Jim Blandy committed
287 288 289 290

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

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

302 303 304 305 306 307 308 309
  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;

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

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

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

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

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

336
  /* Set SPECS to the interactive form, or barf if not interactive.  */
337 338 339 340 341 342 343 344 345 346
  {
    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
347

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

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

      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;

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

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

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

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

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

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

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

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

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
501 502 503
  if (!NILP (enable))
    specbind (Qenable_recursive_minibuffers, Qt);

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

      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
517 518 519 520

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

	case 'b':   		/* Name of existing buffer */
530 531 532 533 534 535
	  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
536
	case 'B':		/* Name of buffer, possibly nonexistent */
537 538 539
	  args[i] = Fread_buffer (callint_message,
				  Fother_buffer (Fcurrent_buffer (), Qnil, Qnil),
				  Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
540 541 542
	  break;

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

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

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

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

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

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

592 593 594 595
	case 'i':		/* Ignore an argument -- Does not do I/O */
	  varies[i] = -1;
	  break;

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

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

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

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

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

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

660 661 662 663 664 665 666 667 668 669
	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;

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

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

Jim Blandy's avatar
Jim Blandy committed
685 686
	  break;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  QUIT;

  args[0] = function;

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

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

855 856 857
  if (record_then_fail)
    Fbarf_if_buffer_read_only ();

858 859 860 861 862
  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
863 864 865 866
  {
    Lisp_Object val;
    specbind (Qcommand_debug_status, Qnil);

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

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

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

  return val;
}

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

904 905 906
  callint_message = Qnil;
  staticpro (&callint_message);

907 908 909 910 911 912 913 914
  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);
915 916
  Qlet = intern ("let");
  staticpro (&Qlet);
917 918 919 920
  Qif = intern ("if");
  staticpro (&Qif);
  Qwhen = intern ("when");
  staticpro (&Qwhen);
921 922 923 924
  Qletx = intern ("let*");
  staticpro (&Qletx);
  Qsave_excursion = intern ("save-excursion");
  staticpro (&Qsave_excursion);
925 926
  Qprogn = intern ("progn");
  staticpro (&Qprogn);
927

Michael I. Bushnell's avatar
Michael I. Bushnell committed
928 929 930
  Qminus = intern ("-");
  staticpro (&Qminus);

Richard M. Stallman's avatar
Richard M. Stallman committed
931 932 933
  Qplus = intern ("+");
  staticpro (&Qplus);

Chong Yidong's avatar
Chong Yidong committed
934 935 936
  Qhandle_shift_selection = intern ("handle-shift-selection");
  staticpro (&Qhandle_shift_selection);

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

946 947 948
  Qmouse_leave_buffer_hook = intern ("mouse-leave-buffer-hook");
  staticpro (&Qmouse_leave_buffer_hook);

949
  DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
950 951 952 953 954 955 956 957 958
		 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").  */);
959

960
  DEFVAR_KBOARD ("last-prefix-arg", Vlast_prefix_arg,
961 962
		 doc: /* The value of the prefix argument for the previous editing command.
See `prefix-arg' for the meaning of the value.  */);
963

964
  DEFVAR_LISP ("current-prefix-arg", &Vcurrent_prefix_arg,
965 966 967 968 969
	       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.  */);
970 971
  Vcurrent_prefix_arg = Qnil;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
972
  DEFVAR_LISP ("command-history", &Vcommand_history,
973
	       doc: /* List of recent commands that read arguments from terminal.
974 975 976 977
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
978 979 980
  Vcommand_history = Qnil;

  DEFVAR_LISP ("command-debug-status", &Vcommand_debug_status,
981 982 983
	       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
984