callint.c 30.8 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

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
46
Lisp_Object Vcommand_debug_status, Qcommand_debug_status;
Richard M. Stallman's avatar
Richard M. Stallman committed
47
Lisp_Object Qenable_recursive_minibuffers;
48
extern Lisp_Object Qface, Qminibuffer_prompt;
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;

Chong Yidong's avatar
Chong Yidong committed
54 55
Lisp_Object Vshift_select_mode, Qhandle_shift_selection;

56 57
Lisp_Object Vmouse_leave_buffer_hook, Qmouse_leave_buffer_hook;

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

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

64 65
/* String for the prompt text used in Fcall_interactively.  */
static Lisp_Object callint_message;
Richard M. Stallman's avatar
Richard M. Stallman committed
66

Michael I. Bushnell's avatar
Michael I. Bushnell committed
67 68
/* ARGSUSED */
DEFUN ("interactive", Finteractive, Sinteractive, 0, UNEVALLED, 0,
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 99 100
       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.
101
G -- Possibly nonexistent file name, defaulting to just directory name.
102 103 104 105 106 107
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
108
N -- Numeric prefix arg, or if none, do like code `n'.
109 110 111 112 113
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.
114
U -- Mouse up event discarded by a previous k or K argument.
115 116 117 118 119
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
120 121 122 123 124 125 126 127 128 129

In addition, if the string begins with `*', an error is signaled if
  the buffer is read-only.
If the string begins with `@', Emacs searches the key sequence which
 invoked the command for its first mouse click (or any other event
 which specifies a window).
If the string begins with `^' and `shift-select-mode' is non-nil,
 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.
130
usage: (interactive ARGS)  */)
131
     (args)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
132 133 134 135 136 137 138 139 140 141 142
     Lisp_Object args;
{
  return Qnil;
}

/* Quotify EXP: if EXP is constant, return it.
   If EXP is not constant, return (quote EXP).  */
Lisp_Object
quotify_arg (exp)
     register Lisp_Object exp;
{
143
  if (!INTEGERP (exp) && !STRINGP (exp)
Jim Blandy's avatar
Jim Blandy committed
144
      && !NILP (exp) && !EQ (exp, Qt))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
145 146 147 148 149 150 151 152 153 154 155
    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;
156 157
  Lisp_Object next;
  for (tail = exp; CONSP (tail); tail = next)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
158
    {
159
      next = XCDR (tail);
160
      XSETCAR (tail, quotify_arg (XCAR (tail)));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
161 162 163 164 165 166 167 168
    }
  return exp;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
324 325
  specs = Qnil;
  string = 0;
326 327 328 329
  /* 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
330

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

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

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

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

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

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

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

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

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

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

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

450
	      Fselect_window (tem, Qnil);
451
	    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
452 453
	  string++;
	}
Chong Yidong's avatar
Chong Yidong committed
454 455 456
      else if (*string == '^')
	{
	  if (! NILP (Vshift_select_mode))
457 458 459 460 461 462 463
	    call1 (Qhandle_shift_selection, Qnil);
	  /* Even if shift-select-mode is off, temporarily active
	     regions could be set using the mouse, and should be
	     deactivated.  */
	  else if (CONSP (Vtransient_mark_mode)
		   && EQ (XCAR (Vtransient_mark_mode), Qonly))
	    call1 (Qhandle_shift_selection, Qt);
Chong Yidong's avatar
Chong Yidong committed
464 465
	  string++;
	}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
466 467 468 469 470 471
      else break;
    }

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

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

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

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

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

      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
519 520 521 522

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
687 688
	  break;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  QUIT;

  args[0] = function;

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

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

857 858 859
  if (record_then_fail)
    Fbarf_if_buffer_read_only ();

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

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

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

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

  return val;
}

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

906 907 908
  callint_message = Qnil;
  staticpro (&callint_message);

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

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

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

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

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

948 949 950
  Qmouse_leave_buffer_hook = intern ("mouse-leave-buffer-hook");
  staticpro (&Qmouse_leave_buffer_hook);

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

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