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

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;

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

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

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

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
131
usage: (interactive &optional ARGS)  */)
132
     (args)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
133 134 135 136 137 138 139 140 141 142 143
     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;
{
144
  if (!INTEGERP (exp) && !STRINGP (exp)
Jim Blandy's avatar
Jim Blandy committed
145
      && !NILP (exp) && !EQ (exp, Qt))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
146 147 148 149 150 151 152 153 154 155 156
    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;
157 158
  Lisp_Object next;
  for (tail = exp; CONSP (tail); tail = next)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
159
    {
160
      next = XCDR (tail);
161
      XSETCAR (tail, quotify_arg (XCAR (tail)));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
162 163 164 165 166 167 168 169
    }
  return exp;
}

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

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

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

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 216
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
217
	       intail = Fcdr (intail), valtail = XCDR (valtail))
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 250
	    {
	      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
251

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      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;

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

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

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

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

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

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

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

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

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

493
  GCPRO5 (prefix_arg, function, *args, *visargs, up_event);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
494 495 496
  gcpro3.nvars = (count + 1);
  gcpro4.nvars = (count + 1);

Richard M. Stallman's avatar
Richard M. Stallman committed
497 498 499
  if (!NILP (enable))
    specbind (Qenable_recursive_minibuffers, Qt);

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

      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
513 514 515 516

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

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

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

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

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

	case 'f':		/* Existing file name. */
573
	  args[i] = Fread_file_name (callint_message,
574
				     Qnil, Qnil, Qlambda, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
575 576 577
	  break;

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

582 583
	case 'G':		/* Possibly nonexistent file name,
				   default to directory alone. */
584
	  args[i] = Fread_file_name (callint_message,
585
				     Qnil, Qnil, Qnil, empty_unibyte_string, Qnil);
586 587
	  break;

588 589 590 591
	case 'i':		/* Ignore an argument -- Does not do I/O */
	  varies[i] = -1;
	  break;

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

	    /* 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))
610
	      teml = XCAR (teml);
611 612 613 614 615
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

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

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

	    /* 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))
642
	      teml = XCAR (teml);
643 644 645 646 647
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

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

656 657 658 659 660 661 662 663 664 665
	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;

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

	  /* Find the next parameterized event.  */
677
	  while (next_event < key_count
678
		 && !(EVENT_HAS_PARAMETERS (AREF (keys, next_event))))
Jim Blandy's avatar
Jim Blandy committed
679 680
	    next_event++;

Jim Blandy's avatar
Jim Blandy committed
681 682
	  break;

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

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

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

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

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

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

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

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

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

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

	case 'z':		/* Coding-system symbol or nil */
796
	  args[i] = Fread_coding_system (callint_message, Qnil);
797 798 799
	  visargs[i] = last_minibuf_string;
	  break;

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

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

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

  QUIT;

  args[0] = function;

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

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

851 852 853
  if (record_then_fail)
    Fbarf_if_buffer_read_only ();

854 855 856 857 858
  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
859 860 861 862
  {
    Lisp_Object val;
    specbind (Qcommand_debug_status, Qnil);

863
    temporarily_switch_to_single_kboard (NULL);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
864 865 866 867
    val = Ffuncall (count + 1, args);
    UNGCPRO;
    return unbind_to (speccount, val);
  }
868
}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
869 870

DEFUN ("prefix-numeric-value", Fprefix_numeric_value, Sprefix_numeric_value,
871 872 873 874 875
       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
876 877 878
     Lisp_Object raw;
{
  Lisp_Object val;
879

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

  return val;
}

Andreas Schwab's avatar
Andreas Schwab committed
894
void
Michael I. Bushnell's avatar
Michael I. Bushnell committed
895 896
syms_of_callint ()
{
897 898 899
  point_marker = Fmake_marker ();
  staticpro (&point_marker);

900 901 902
  callint_message = Qnil;
  staticpro (&callint_message);

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
924 925 926
  Qminus = intern ("-");
  staticpro (&Qminus);

Richard M. Stallman's avatar
Richard M. Stallman committed
927 928 929
  Qplus = intern ("+");
  staticpro (&Qplus);

Chong Yidong's avatar
Chong Yidong committed
930 931 932
  Qhandle_shift_selection = intern ("handle-shift-selection");
  staticpro (&Qhandle_shift_selection);

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

942 943 944
  Qmouse_leave_buffer_hook = intern ("mouse-leave-buffer-hook");
  staticpro (&Qmouse_leave_buffer_hook);

945
  DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
946 947 948 949 950 951 952 953 954
		 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").  */);
955

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

960
  DEFVAR_LISP ("current-prefix-arg", &Vcurrent_prefix_arg,
961 962 963 964 965
	       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.  */);
966 967
  Vcurrent_prefix_arg = Qnil;

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

  DEFVAR_LISP ("command-debug-status", &Vcommand_debug_status,
977 978 979
	       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
980 981
  Vcommand_debug_status = Qnil;

982
  DEFVAR_LISP ("mark-even-if-inactive", &Vmark_even_if_inactive,
983 984 985 986