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, 2010
Glenn Morris's avatar
Glenn Morris committed
4
                 Free Software Foundation, Inc.
Michael I. Bushnell's avatar
Michael I. Bushnell committed
5 6 7

This file is part of GNU Emacs.

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

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

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


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

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

32
extern Lisp_Object Qcursor_in_echo_area;
33
extern Lisp_Object Qfile_directory_p;
34
extern Lisp_Object Qonly;
35

36
Lisp_Object Vcurrent_prefix_arg, Qminus, Qplus;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
37 38 39
Lisp_Object Qcall_interactively;
Lisp_Object Vcommand_history;

40
extern Lisp_Object Vhistory_length;
41
extern Lisp_Object Vthis_original_command, real_this_command;
42
extern int history_delete_duplicates;
43

Michael I. Bushnell's avatar
Michael I. Bushnell committed
44
Lisp_Object Vcommand_debug_status, Qcommand_debug_status;
Richard M. Stallman's avatar
Richard M. Stallman committed
45
Lisp_Object Qenable_recursive_minibuffers;
46
extern Lisp_Object Qface, Qminibuffer_prompt;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
47

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

52
Lisp_Object Qhandle_shift_selection;
Chong Yidong's avatar
Chong Yidong committed
53

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
       doc: /* Specify a way of parsing arguments for interactive use of a function.
For example, write
69 70 71
 (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.
72 73 74 75 76
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.

77 78 79 80 81
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
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
 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.
100
G -- Possibly nonexistent file name, defaulting to just directory name.
101 102 103 104 105 106
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
107
N -- Numeric prefix arg, or if none, do like code `n'.
108 109 110 111 112
p -- Prefix arg converted to number.  Does not do I/O.
P -- Prefix arg in raw form.  Does not do I/O.
r -- Region: point and mark as 2 numeric args, smallest first.  Does no I/O.
s -- Any string.  Does not inherit the current input method.
S -- Any symbol.
113
U -- Mouse up event discarded by a previous k or K argument.
114 115 116 117 118
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
119 120 121 122 123 124 125

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,
126
 Emacs first calls the function `handle-shift-selection'.
Chong Yidong's avatar
Chong Yidong committed
127 128
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
129
usage: (interactive &optional ARGS)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
130
  (Lisp_Object args)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
131 132 133 134 135 136 137
{
  return Qnil;
}

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

  return exp;
}

/* Modify EXP by quotifying each element (except the first).  */
Lisp_Object
149
quotify_args (Lisp_Object exp)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
150 151
{
  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
check_mark (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
static void
186
fix_command (Lisp_Object input, Lisp_Object values)
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
{
  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
210
	       intail = Fcdr (intail), valtail = XCDR (valtail))
211 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
	    {
	      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
244

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

257
Optional third arg KEYS, if given, specifies the sequence of events to
258 259 260
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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
261
  (Lisp_Object function, Lisp_Object record_flag, Lisp_Object keys)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
262 263 264
{
  Lisp_Object *args, *visargs;
  Lisp_Object specs;
265
  Lisp_Object filter_specs;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
266
  Lisp_Object teml;
267
  Lisp_Object up_event;
Richard M. Stallman's avatar
Richard M. Stallman committed
268
  Lisp_Object enable;
Juanma Barranquero's avatar
Juanma Barranquero committed
269
  int speccount = SPECPDL_INDEX ();
Michael I. Bushnell's avatar
Michael I. Bushnell committed
270

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
275 276 277
  Lisp_Object prefix_arg;
  unsigned char *string;
  unsigned char *tem;
Jim Blandy's avatar
Jim Blandy committed
278 279 280 281

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

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

293 294 295 296 297 298 299 300
  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;

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

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

312
  if (SYMBOLP (function))
313
    enable = Fget (function, Qenable_recursive_minibuffers);
314 315
  else
    enable = Qnil;
Richard M. Stallman's avatar
Richard M. Stallman committed
316

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

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

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

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

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

      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;

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

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

Jim Blandy's avatar
Jim Blandy committed
390
  /* Set next_event to point to the first event with parameters.  */
391
  for (next_event = 0; next_event < key_count; next_event++)
392
    if (EVENT_HAS_PARAMETERS (AREF (keys, next_event)))
Jim Blandy's avatar
Jim Blandy committed
393
      break;
394

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

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

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

445
	      Fselect_window (tem, Qnil);
446
	    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
447 448
	  string++;
	}
Chong Yidong's avatar
Chong Yidong committed
449 450
      else if (*string == '^')
	{
451
	  call0 (Qhandle_shift_selection);
Chong Yidong's avatar
Chong Yidong committed
452 453
	  string++;
	}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
454 455 456 457 458 459
      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++;
468
      tem = (unsigned char *) strchr (tem, '\n');
Michael I. Bushnell's avatar
Michael I. Bushnell committed
469
      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 = strchr (prompt1, '\n');
Michael I. Bushnell's avatar
Michael I. Bushnell committed
500
      if (tem1) *tem1 = 0;
501 502

      visargs[0] = build_string (prompt1);
503
      if (strchr (prompt1, '%'))
504 505 506
	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
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = visargs[i];
	  args[i] = Fintern (teml, Qnil);
	  break;

	case 'b':   		/* Name of existing buffer */
520 521 522 523 524 525
	  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
526
	case 'B':		/* Name of buffer, possibly nonexistent */
527 528 529
	  args[i] = Fread_buffer (callint_message,
				  Fother_buffer (Fcurrent_buffer (), Qnil, Qnil),
				  Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
530 531 532
	  break;

        case 'c':		/* Character */
533 534 535 536
	  /* Prompt in `minibuffer-prompt' face.  */
	  Fput_text_property (make_number (0),
			      make_number (SCHARS (callint_message)),
			      Qface, Qminibuffer_prompt, callint_message);
537
	  args[i] = Fread_char (callint_message, Qnil, Qnil);
538
	  message1_nolog ((char *) 0);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
539 540 541 542 543 544
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = args[i];
	  visargs[i] = Fchar_to_string (teml);
	  break;

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

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

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

	case 'F':		/* Possibly nonexistent file name. */
572
	  args[i] = Fread_file_name (callint_message,
573
				     Qnil, Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
574 575
	  break;

576 577
	case 'G':		/* Possibly nonexistent file name,
				   default to directory alone. */
578
	  args[i] = Fread_file_name (callint_message,
579
				     Qnil, Qnil, Qnil, empty_unibyte_string, Qnil);
580 581
	  break;

582 583 584 585
	case 'i':		/* Ignore an argument -- Does not do I/O */
	  varies[i] = -1;
	  break;

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

	    /* 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))
604
	      teml = XCAR (teml);
605 606 607 608 609
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

		teml = Fget (teml, intern ("event-symbol-elements"));
610 611
		/* Ignore first element, which is the base key.  */
		tem2 = Fmemq (intern ("down"), Fcdr (teml));
612
		if (! NILP (tem2))
Chong Yidong's avatar
Chong Yidong committed
613
		  up_event = Fread_event (Qnil, Qnil, Qnil);
614
	      }
615
	  }
616 617 618
	  break;

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

	    /* 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))
636
	      teml = XCAR (teml);
637 638 639 640 641
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

		teml = Fget (teml, intern ("event-symbol-elements"));
642 643
		/* Ignore first element, which is the base key.  */
		tem2 = Fmemq (intern ("down"), Fcdr (teml));
644
		if (! NILP (tem2))
Chong Yidong's avatar
Chong Yidong committed
645
		  up_event = Fread_event (Qnil, Qnil, Qnil);
646
	      }
647
	  }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
648 649
	  break;

650 651 652 653 654 655 656 657 658 659
	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;

660
	case 'e':		/* The invoking event.  */
661
	  if (next_event >= key_count)
662
	    error ("%s must be bound to an event with parameters",
663
		   (SYMBOLP (function)
664
		    ? (char *) SDATA (SYMBOL_NAME (function))
665
		    : "command"));
666 667
	  args[i] = AREF (keys, next_event);
	  next_event++;
Jim Blandy's avatar
Jim Blandy committed
668
	  varies[i] = -1;
Jim Blandy's avatar
Jim Blandy committed
669 670

	  /* Find the next parameterized event.  */
671
	  while (next_event < key_count
672
		 && !(EVENT_HAS_PARAMETERS (AREF (keys, next_event))))
Jim Blandy's avatar
Jim Blandy committed
673 674
	    next_event++;

Jim Blandy's avatar
Jim Blandy committed
675 676
	  break;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
677
	case 'm':		/* Value of mark.  Does not do I/O.  */
678
	  check_mark (0);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
679
	  /* visargs[i] = Qnil; */
680
	  args[i] = current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
681 682 683
	  varies[i] = 2;
	  break;

684 685
	case 'M':		/* String read via minibuffer with
				   inheriting the current input method.  */
686
	  args[i] = Fread_string (callint_message,
687 688 689
				  Qnil, Qnil, Qnil, Qt);
	  break;

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

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

	case 'r':		/* Region, point and mark as 2 args. */
733
	  check_mark (1);
734
	  set_marker_both (point_marker, Qnil, PT, PT_BYTE);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
735 736 737
	  /* visargs[i+1] = Qnil; */
	  foo = marker_position (current_buffer->mark);
	  /* visargs[i] = Qnil; */
738
	  args[i] = PT < foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
739
	  varies[i] = 3;
740
	  args[++i] = PT > foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
741 742 743
	  varies[i] = 4;
	  break;

744 745
	case 's':		/* String read via minibuffer without
				   inheriting the current input method.  */
746
	  args[i] = Fread_string (callint_message,
747
				  Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
748 749 750
	  break;

	case 'S':		/* Any symbol.  */
751
	  visargs[i] = Fread_string (callint_message,
752
				     Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
753 754 755 756 757 758 759
	  /* 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. */
760
	  args[i] = Fread_variable (callint_message, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
761 762 763 764
	  visargs[i] = last_minibuf_string;
	  break;

	case 'x':		/* Lisp expression read but not evaluated */
765
	  args[i] = Fread_minibuffer (callint_message, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
766 767 768 769
	  visargs[i] = last_minibuf_string;
	  break;

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

774 775 776 777 778 779 780
	case 'Z':		/* Coding-system symbol, or ignore the
				   argument if no prefix */
	  if (NILP (prefix_arg))
	    {
	      args[i] = Qnil;
	      varies[i] = -1;
	    }
781
	  else
782 783
	    {
	      args[i]
784
		= Fread_non_nil_coding_system (callint_message);
785 786 787 788 789
	      visargs[i] = last_minibuf_string;
	    }
	  break;

	case 'z':		/* Coding-system symbol or nil */
790
	  args[i] = Fread_coding_system (callint_message, Qnil);
791 792 793
	  visargs[i] = last_minibuf_string;
	  break;

794 795 796
	  /* 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
797
	default:
798
	  error ("Invalid control letter `%c' (%03o) in interactive calling string",
Michael I. Bushnell's avatar
Michael I. Bushnell committed
799 800 801 802 803 804
		 *tem, *tem);
	}

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

805
      if (NILP (visargs[i]) && STRINGP (args[i]))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
806 807
	visargs[i] = args[i];

808
      tem = (unsigned char *) strchr (tem, '\n');
Michael I. Bushnell's avatar
Michael I. Bushnell committed
809 810 811
      if (tem) tem++;
      else tem = (unsigned char *) "";
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
812
  unbind_to (speccount, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
813 814 815 816 817

  QUIT;

  args[0] = function;

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

839 840
  /* If we used a marker to hold point, mark, or an end of the region,
     temporarily, convert it to an integer now.  */
841
  for (i = 1; i <= count; i++)
842 843 844
    if (varies[i] >= 1 && varies[i] <= 4)
      XSETINT (args[i], marker_position (args[i]));

845 846 847
  if (record_then_fail)
    Fbarf_if_buffer_read_only ();

848 849 850 851 852
  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
853 854 855 856
  {
    Lisp_Object val;
    specbind (Qcommand_debug_status, Qnil);

857
    temporarily_switch_to_single_kboard (NULL);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
858 859 860 861
    val = Ffuncall (count + 1, args);
    UNGCPRO;
    return unbind_to (speccount, val);
  }
862
}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
863 864

DEFUN ("prefix-numeric-value", Fprefix_numeric_value, Sprefix_numeric_value,
865 866 867 868
       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")'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
869
  (Lisp_Object raw)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
870 871
{
  Lisp_Object val;
872

Jim Blandy's avatar
Jim Blandy committed
873
  if (NILP (raw))
874
    XSETFASTINT (val, 1);
875
  else if (EQ (raw, Qminus))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
876
    XSETINT (val, -1);
877 878
  else if (CONSP (raw) && INTEGERP (XCAR (raw)))
    XSETINT (val, XINT (XCAR (raw)));
879
  else if (INTEGERP (raw))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
880 881
    val = raw;
  else
882
    XSETFASTINT (val, 1);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
883 884 885 886

  return val;
}

Andreas Schwab's avatar
Andreas Schwab committed
887
void
888
syms_of_callint (void)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
889
{
890 891 892
  point_marker = Fmake_marker ();
  staticpro (&point_marker);

893 894 895
  callint_message = Qnil;
  staticpro (&callint_message);

Dan Nicolaescu's avatar
Dan Nicolaescu committed
896 897 898 899
  preserved_fns = pure_cons (intern_c_string ("region-beginning"),
			 pure_cons (intern_c_string ("region-end"),
				pure_cons (intern_c_string ("point"),
				       pure_cons (intern_c_string ("mark"), Qnil))));
900

Dan Nicolaescu's avatar
Dan Nicolaescu committed
901
  Qlist = intern_c_string ("list");
902
  staticpro (&Qlist);
Dan Nicolaescu's avatar
Dan Nicolaescu committed
903
  Qlet = intern_c_string ("let");
904
  staticpro (&Qlet);
Dan Nicolaescu's avatar
Dan Nicolaescu committed
905
  Qif = intern_c_string ("if");
906
  staticpro (&Qif);
Dan Nicolaescu's avatar
Dan Nicolaescu committed
907
  Qwhen = intern_c_string ("when");
908
  staticpro (&Qwhen);
Dan Nicolaescu's avatar
Dan Nicolaescu committed
909
  Qletx = intern_c_string ("let*");
910
  staticpro (&Qletx);
Dan Nicolaescu's avatar
Dan Nicolaescu committed
911
  Qsave_excursion = intern_c_string ("save-excursion");
912
  staticpro (&Qsave_excursion);
Dan Nicolaescu's avatar
Dan Nicolaescu committed
913
  Qprogn = intern_c_string ("progn");
914
  staticpro (&Qprogn);
915

Dan Nicolaescu's avatar
Dan Nicolaescu committed
916
  Qminus = intern_c_string ("-");
Michael I. Bushnell's avatar
Michael I. Bushnell committed
917 918
  staticpro (&Qminus);

Dan Nicolaescu's avatar
Dan Nicolaescu committed
919
  Qplus = intern_c_string ("+");
Richard M. Stallman's avatar
Richard M. Stallman committed
920 921
  staticpro (&Qplus);

Dan Nicolaescu's avatar
Dan Nicolaescu committed
922
  Qhandle_shift_selection = intern_c_string ("handle-shift-selection");
Chong Yidong's avatar
Chong Yidong committed
923 924
  staticpro (&Qhandle_shift_selection);

Dan Nicolaescu's avatar
Dan Nicolaescu committed
925
  Qcall_interactively = intern_c_string ("call-interactively");
Michael I. Bushnell's avatar
Michael I. Bushnell committed
926 927
  staticpro (&Qcall_interactively);

Dan Nicolaescu's avatar
Dan Nicolaescu committed
928
  Qcommand_debug_status = intern_c_string ("command-debug-status");
Michael I. Bushnell's avatar
Michael I. Bushnell committed
929 930
  staticpro (&Qcommand_debug_status);

Dan Nicolaescu's avatar
Dan Nicolaescu committed
931
  Qenable_recursive_minibuffers = intern_c_string ("enable-recursive-minibuffers");
Richard M. Stallman's avatar