src/callint.c

   1 /* Call a Lisp function interactively.
   2    Copyright (C) 1985-1986, 1993-1995, 1997, 2000-2015 Free Software
   3    Foundation, Inc.
   4
   5 This file is part of GNU Emacs.
   6
   7 GNU Emacs is free software: you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation, either version 3 of the License, or
  10 (at your option) any later version.
  11
  12 GNU Emacs is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20
  21 #include <config.h>
  22
  23 #include "lisp.h"
  24 #include "character.h"
  25 #include "buffer.h"
  26 #include "commands.h"
  27 #include "keyboard.h"
  28 #include "window.h"
  29 #include "keymap.h"
  30
  31 static Lisp_Object preserved_fns;
  32
  33 /* Marker used within call-interactively to refer to point.  */
  34 static Lisp_Object point_marker;
  35
  36 /* String for the prompt text used in Fcall_interactively.  */
  37 static Lisp_Object callint_message;
  38 \f
  39 /* ARGSUSED */
  40 DEFUN ("interactive", Finteractive, Sinteractive, 0, UNEVALLED, 0,
  41        doc: /* Specify a way of parsing arguments for interactive use of a function.
  42 For example, write
  43  (defun foo (arg buf) "Doc string" (interactive "P\\nbbuffer: ") .... )
  44  to make ARG be the raw prefix argument, and set BUF to an existing buffer,
  45  when `foo' is called as a command.
  46 The "call" to `interactive' is actually a declaration rather than a function;
  47  it tells `call-interactively' how to read arguments
  48  to pass to the function.
  49 When actually called, `interactive' just returns nil.
  50
  51 Usually the argument of `interactive' is a string containing a code letter
  52  followed optionally by a prompt.  (Some code letters do not use I/O to get
  53  the argument and do not use prompts.)  To get several arguments, concatenate
  54  the individual strings, separating them by newline characters.
  55 Prompts are passed to format, and may use % escapes to print the
  56  arguments that have already been read.
  57 If the argument is not a string, it is evaluated to get a list of
  58  arguments to pass to the function.
  59 Just `(interactive)' means pass no args when calling interactively.
  60
  61 Code letters available are:
  62 a -- Function name: symbol with a function definition.
  63 b -- Name of existing buffer.
  64 B -- Name of buffer, possibly nonexistent.
  65 c -- Character (no input method is used).
  66 C -- Command name: symbol with interactive function definition.
  67 d -- Value of point as number.  Does not do I/O.
  68 D -- Directory name.
  69 e -- Parameterized event (i.e., one that's a list) that invoked this command.
  70      If used more than once, the Nth `e' returns the Nth parameterized event.
  71      This skips events that are integers or symbols.
  72 f -- Existing file name.
  73 F -- Possibly nonexistent file name.
  74 G -- Possibly nonexistent file name, defaulting to just directory name.
  75 i -- Ignored, i.e. always nil.  Does not do I/O.
  76 k -- Key sequence (downcase the last event if needed to get a definition).
  77 K -- Key sequence to be redefined (do not downcase the last event).
  78 m -- Value of mark as number.  Does not do I/O.
  79 M -- Any string.  Inherits the current input method.
  80 n -- Number read using minibuffer.
  81 N -- Numeric prefix arg, or if none, do like code `n'.
  82 p -- Prefix arg converted to number.  Does not do I/O.
  83 P -- Prefix arg in raw form.  Does not do I/O.
  84 r -- Region: point and mark as 2 numeric args, smallest first.  Does no I/O.
  85 s -- Any string.  Does not inherit the current input method.
  86 S -- Any symbol.
  87 U -- Mouse up event discarded by a previous k or K argument.
  88 v -- Variable name: symbol that is `custom-variable-p'.
  89 x -- Lisp expression read but not evaluated.
  90 X -- Lisp expression read and evaluated.
  91 z -- Coding system.
  92 Z -- Coding system, nil if no prefix arg.
  93
  94 In addition, if the string begins with `*', an error is signaled if
  95   the buffer is read-only.
  96 If `@' appears at the beginning of the string, and if the key sequence
  97  used to invoke the command includes any mouse events, then the window
  98  associated with the first of those events is selected before the
  99  command is run.
 100 If the string begins with `^' and `shift-select-mode' is non-nil,
 101  Emacs first calls the function `handle-shift-selection'.
 102 You may use `@', `*', and `^' together.  They are processed in the
 103  order that they appear, before reading any arguments.
 104 usage: (interactive &optional ARGS)  */
 105        attributes: const)
 106   (Lisp_Object args)
 107 {
 108   return Qnil;
 109 }
 110
 111 /* Quotify EXP: if EXP is constant, return it.
 112    If EXP is not constant, return (quote EXP).  */
 113 static Lisp_Object
 114 quotify_arg (register Lisp_Object exp)
 115 {
 116   if (CONSP (exp)
 117       || (SYMBOLP (exp)
 118           && !NILP (exp) && !EQ (exp, Qt)))
 119     return list2 (Qquote, exp);
 120
 121   return exp;
 122 }
 123
 124 /* Modify EXP by quotifying each element (except the first).  */
 125 static Lisp_Object
 126 quotify_args (Lisp_Object exp)
 127 {
 128   register Lisp_Object tail;
 129   Lisp_Object next;
 130   for (tail = exp; CONSP (tail); tail = next)
 131     {
 132       next = XCDR (tail);
 133       XSETCAR (tail, quotify_arg (XCAR (tail)));
 134     }
 135   return exp;
 136 }
 137
 138 static const char *callint_argfuns[]
 139     = {"", "point", "mark", "region-beginning", "region-end"};
 140
 141 static void
 142 check_mark (bool for_region)
 143 {
 144   Lisp_Object tem;
 145   tem = Fmarker_buffer (BVAR (current_buffer, mark));
 146   if (NILP (tem) || (XBUFFER (tem) != current_buffer))
 147     error (for_region ? "The mark is not set now, so there is no region"
 148            : "The mark is not set now");
 149   if (!NILP (Vtransient_mark_mode) && NILP (Vmark_even_if_inactive)
 150       && NILP (BVAR (current_buffer, mark_active)))
 151     xsignal0 (Qmark_inactive);
 152 }
 153
 154 /* If the list of args INPUT was produced with an explicit call to
 155    `list', look for elements that were computed with
 156    (region-beginning) or (region-end), and put those expressions into
 157    VALUES instead of the present values.
 158
 159    This function doesn't return a value because it modifies elements
 160    of VALUES to do its job.  */
 161
 162 static void
 163 fix_command (Lisp_Object input, Lisp_Object values)
 164 {
 165   /* FIXME: Instead of this ugly hack, we should provide a way for an
 166      interactive spec to return an expression/function that will re-build the
 167      args without user intervention.  */
 168   if (CONSP (input))
 169     {
 170       Lisp_Object car;
 171
 172       car = XCAR (input);
 173       /* Skip through certain special forms.  */
 174       while (EQ (car, Qlet) || EQ (car, Qletx)
 175              || EQ (car, Qsave_excursion)
 176              || EQ (car, Qprogn))
 177         {
 178           while (CONSP (XCDR (input)))
 179             input = XCDR (input);
 180           input = XCAR (input);
 181           if (!CONSP (input))
 182             break;
 183           car = XCAR (input);
 184         }
 185       if (EQ (car, Qlist))
 186         {
 187           Lisp_Object intail, valtail;
 188           for (intail = Fcdr (input), valtail = values;
 189                CONSP (valtail);
 190                intail = Fcdr (intail), valtail = XCDR (valtail))
 191             {
 192               Lisp_Object elt;
 193               elt = Fcar (intail);
 194               if (CONSP (elt))
 195                 {
 196                   Lisp_Object presflag, carelt;
 197                   carelt = XCAR (elt);
 198                   /* If it is (if X Y), look at Y.  */
 199                   if (EQ (carelt, Qif)
 200                       && EQ (Fnthcdr (make_number (3), elt), Qnil))
 201                     elt = Fnth (make_number (2), elt);
 202                   /* If it is (when ... Y), look at Y.  */
 203                   else if (EQ (carelt, Qwhen))
 204                     {
 205                       while (CONSP (XCDR (elt)))
 206                         elt = XCDR (elt);
 207                       elt = Fcar (elt);
 208                     }
 209
 210                   /* If the function call we're looking at
 211                      is a special preserved one, copy the
 212                      whole expression for this argument.  */
 213                   if (CONSP (elt))
 214                     {
 215                       presflag = Fmemq (Fcar (elt), preserved_fns);
 216                       if (!NILP (presflag))
 217                         Fsetcar (valtail, Fcar (intail));
 218                     }
 219                 }
 220             }
 221         }
 222     }
 223 }
 224
 225 /* Helper function to call `read-file-name' from C.  */
 226
 227 static Lisp_Object
 228 read_file_name (Lisp_Object default_filename, Lisp_Object mustmatch,
 229                 Lisp_Object initial, Lisp_Object predicate)
 230 {
 231   struct gcpro gcpro1;
 232   GCPRO1 (default_filename);
 233   RETURN_UNGCPRO (CALLN (Ffuncall, intern ("read-file-name"),
 234                          callint_message, Qnil, default_filename,
 235                          mustmatch, initial, predicate));
 236 }
 237
 238 /* BEWARE: Calling this directly from C would defeat the purpose!  */
 239 DEFUN ("funcall-interactively", Ffuncall_interactively, Sfuncall_interactively,
 240        1, MANY, 0, doc: /* Like `funcall' but marks the call as interactive.
 241 I.e. arrange that within the called function `called-interactively-p' will
 242 return non-nil.
 243 usage: (funcall-interactively FUNCTION &rest ARGUMENTS)  */)
 244      (ptrdiff_t nargs, Lisp_Object *args)
 245 {
 246   ptrdiff_t speccount = SPECPDL_INDEX ();
 247   temporarily_switch_to_single_kboard (NULL);
 248
 249   /* Nothing special to do here, all the work is inside
 250      `called-interactively-p'.  Which will look for us as a marker in the
 251      backtrace.  */
 252   return unbind_to (speccount, Ffuncall (nargs, args));
 253 }
 254
 255 DEFUN ("call-interactively", Fcall_interactively, Scall_interactively, 1, 3, 0,
 256        doc: /* Call FUNCTION, providing args according to its interactive calling specs.
 257 Return the value FUNCTION returns.
 258 The function contains a specification of how to do the argument reading.
 259 In the case of user-defined functions, this is specified by placing a call
 260 to the function `interactive' at the top level of the function body.
 261 See `interactive'.
 262
 263 Optional second arg RECORD-FLAG non-nil
 264 means unconditionally put this command in the command-history.
 265 Otherwise, this is done only if an arg is read using the minibuffer.
 266
 267 Optional third arg KEYS, if given, specifies the sequence of events to
 268 supply, as a vector, if the command inquires which events were used to
 269 invoke it.  If KEYS is omitted or nil, the return value of
 270 `this-command-keys-vector' is used.  */)
 271   (Lisp_Object function, Lisp_Object record_flag, Lisp_Object keys)
 272 {
 273   /* `args' will contain the array of arguments to pass to the function.
 274      `visargs' will contain the same list but in a nicer form, so that if we
 275      pass it to `Fformat' it will be understandable to a human.  */
 276   Lisp_Object *args, *visargs;
 277   Lisp_Object specs;
 278   Lisp_Object filter_specs;
 279   Lisp_Object teml;
 280   Lisp_Object up_event;
 281   Lisp_Object enable;
 282   USE_SAFE_ALLOCA;
 283   ptrdiff_t speccount = SPECPDL_INDEX ();
 284
 285   /* The index of the next element of this_command_keys to examine for
 286      the 'e' interactive code.  */
 287   ptrdiff_t next_event;
 288
 289   Lisp_Object prefix_arg;
 290   char *string;
 291   const char *tem;
 292
 293   /* If varies[i] > 0, the i'th argument shouldn't just have its value
 294      in this call quoted in the command history.  It should be
 295      recorded as a call to the function named callint_argfuns[varies[i]].  */
 296   signed char *varies;
 297
 298   ptrdiff_t i, nargs;
 299   ptrdiff_t mark;
 300   bool arg_from_tty = 0;
 301   struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
 302   ptrdiff_t key_count;
 303   bool record_then_fail = 0;
 304
 305   Lisp_Object save_this_command, save_last_command;
 306   Lisp_Object save_this_original_command, save_real_this_command;
 307
 308   save_this_command = Vthis_command;
 309   save_this_original_command = Vthis_original_command;
 310   save_real_this_command = Vreal_this_command;
 311   save_last_command = KVAR (current_kboard, Vlast_command);
 312
 313   if (NILP (keys))
 314     keys = this_command_keys, key_count = this_command_key_count;
 315   else
 316     {
 317       CHECK_VECTOR (keys);
 318       key_count = ASIZE (keys);
 319     }
 320
 321   /* Save this now, since use of minibuffer will clobber it.  */
 322   prefix_arg = Vcurrent_prefix_arg;
 323
 324   if (SYMBOLP (function))
 325     enable = Fget (function, Qenable_recursive_minibuffers);
 326   else
 327     enable = Qnil;
 328
 329   specs = Qnil;
 330   string = 0;
 331   /* The idea of FILTER_SPECS is to provide a way to
 332      specify how to represent the arguments in command history.
 333      The feature is not fully implemented.  */
 334   filter_specs = Qnil;
 335
 336   /* If k or K discard an up-event, save it here so it can be retrieved with
 337      U.  */
 338   up_event = Qnil;
 339
 340   /* Set SPECS to the interactive form, or barf if not interactive.  */
 341   {
 342     Lisp_Object form;
 343     GCPRO2 (function, prefix_arg);
 344     form = Finteractive_form (function);
 345     UNGCPRO;
 346     if (CONSP (form))
 347       specs = filter_specs = Fcar (XCDR (form));
 348     else
 349       wrong_type_argument (Qcommandp, function);
 350   }
 351
 352   /* If SPECS is not a string, invent one.  */
 353   if (! STRINGP (specs))
 354     {
 355       Lisp_Object input;
 356       Lisp_Object funval = Findirect_function (function, Qt);
 357       uintmax_t events = num_input_events;
 358       input = specs;
 359       /* Compute the arg values using the user's expression.  */
 360       GCPRO2 (input, filter_specs);
 361       specs = Feval (specs,
 362                      CONSP (funval) && EQ (Qclosure, XCAR (funval))
 363                      ? CAR_SAFE (XCDR (funval)) : Qnil);
 364       UNGCPRO;
 365       if (events != num_input_events || !NILP (record_flag))
 366         {
 367           /* We should record this command on the command history.  */
 368           Lisp_Object values;
 369           Lisp_Object this_cmd;
 370           /* Make a copy of the list of values, for the command history,
 371              and turn them into things we can eval.  */
 372           values = quotify_args (Fcopy_sequence (specs));
 373           fix_command (input, values);
 374           this_cmd = Fcons (function, values);
 375           if (history_delete_duplicates)
 376             Vcommand_history = Fdelete (this_cmd, Vcommand_history);
 377           Vcommand_history = Fcons (this_cmd, Vcommand_history);
 378
 379           /* Don't keep command history around forever.  */
 380           if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
 381             {
 382               teml = Fnthcdr (Vhistory_length, Vcommand_history);
 383               if (CONSP (teml))
 384                 XSETCDR (teml, Qnil);
 385             }
 386         }
 387
 388       Vthis_command = save_this_command;
 389       Vthis_original_command = save_this_original_command;
 390       Vreal_this_command = save_real_this_command;
 391       kset_last_command (current_kboard, save_last_command);
 392
 393       Lisp_Object result
 394         = unbind_to (speccount, CALLN (Fapply, Qfuncall_interactively,
 395                                        function, specs));
 396       SAFE_FREE ();
 397       return result;
 398     }
 399
 400   /* SPECS is set to a string; use it as an interactive prompt.
 401      Copy it so that STRING will be valid even if a GC relocates SPECS.  */
 402   SAFE_ALLOCA_STRING (string, specs);
 403
 404   /* Here if function specifies a string to control parsing the defaults.  */
 405
 406   /* Set next_event to point to the first event with parameters.  */
 407   for (next_event = 0; next_event < key_count; next_event++)
 408     if (EVENT_HAS_PARAMETERS (AREF (keys, next_event)))
 409       break;
 410
 411   /* Handle special starting chars `*' and `@'.  Also `-'.  */
 412   /* Note that `+' is reserved for user extensions.  */
 413   while (1)
 414     {
 415       if (*string == '+')
 416         error ("`+' is not used in `interactive' for ordinary commands");
 417       else if (*string == '*')
 418         {
 419           string++;
 420           if (!NILP (BVAR (current_buffer, read_only)))
 421             {
 422               if (!NILP (record_flag))
 423                 {
 424                   char *p = string;
 425                   while (*p)
 426                     {
 427                       if (! (*p == 'r' || *p == 'p' || *p == 'P'
 428                              || *p == '\n'))
 429                         Fbarf_if_buffer_read_only (Qnil);
 430                       p++;
 431                     }
 432                   record_then_fail = 1;
 433                 }
 434               else
 435                 Fbarf_if_buffer_read_only (Qnil);
 436             }
 437         }
 438       /* Ignore this for semi-compatibility with Lucid.  */
 439       else if (*string == '-')
 440         string++;
 441       else if (*string == '@')
 442         {
 443           Lisp_Object event, w;
 444
 445           event = (next_event < key_count
 446                    ? AREF (keys, next_event)
 447                    : Qnil);
 448           if (EVENT_HAS_PARAMETERS (event)
 449               && (w = XCDR (event), CONSP (w))
 450               && (w = XCAR (w), CONSP (w))
 451               && (w = XCAR (w), WINDOWP (w)))
 452             {
 453               if (MINI_WINDOW_P (XWINDOW (w))
 454                   && ! (minibuf_level > 0 && EQ (w, minibuf_window)))
 455                 error ("Attempt to select inactive minibuffer window");
 456
 457               /* If the current buffer wants to clean up, let it.  */
 458               run_hook (Qmouse_leave_buffer_hook);
 459
 460               Fselect_window (w, Qnil);
 461             }
 462           string++;
 463         }
 464       else if (*string == '^')
 465         {
 466           call0 (Qhandle_shift_selection);
 467           string++;
 468         }
 469       else break;
 470     }
 471
 472   /* Count the number of arguments, which is two (the function itself and
 473      `funcall-interactively') plus the number of arguments the interactive spec
 474      would have us give to the function.  */
 475   tem = string;
 476   for (nargs = 2; *tem; )
 477     {
 478       /* 'r' specifications ("point and mark as 2 numeric args")
 479          produce *two* arguments.  */
 480       if (*tem == 'r')
 481         nargs += 2;
 482       else
 483         nargs++;
 484       tem = strchr (tem, '\n');
 485       if (tem)
 486         ++tem;
 487       else
 488         break;
 489     }
 490
 491   if (MOST_POSITIVE_FIXNUM < min (PTRDIFF_MAX, SIZE_MAX) / word_size
 492       && MOST_POSITIVE_FIXNUM < nargs)
 493     memory_full (SIZE_MAX);
 494
 495   /* Allocate them all at one go.  This wastes a bit of memory, but
 496      it's OK to trade space for speed.  */
 497   SAFE_NALLOCA (args, 3, nargs);
 498   visargs = args + nargs;
 499   varies = (signed char *) (visargs + nargs);
 500
 501   memclear (args, nargs * (2 * word_size + 1));
 502
 503   GCPRO5 (prefix_arg, function, *args, *visargs, up_event);
 504   gcpro3.nvars = nargs;
 505   gcpro4.nvars = nargs;
 506
 507   if (!NILP (enable))
 508     specbind (Qenable_recursive_minibuffers, Qt);
 509
 510   tem = string;
 511   for (i = 2; *tem; i++)
 512     {
 513       visargs[1] = make_string (tem + 1, strcspn (tem + 1, "\n"));
 514       visargs[1] = Finternal__text_restyle (visargs[1]);
 515       if (strchr (SSDATA (visargs[1]), '%'))
 516         callint_message = Fformat (i - 1, visargs + 1);
 517       else
 518         callint_message = visargs[1];
 519
 520       switch (*tem)
 521         {
 522         case 'a':               /* Symbol defined as a function.  */
 523           visargs[i] = Fcompleting_read (callint_message,
 524                                          Vobarray, Qfboundp, Qt,
 525                                          Qnil, Qnil, Qnil, Qnil);
 526           /* Passing args[i] directly stimulates compiler bug.  */
 527           teml = visargs[i];
 528           args[i] = Fintern (teml, Qnil);
 529           break;
 530
 531         case 'b':               /* Name of existing buffer.  */
 532           args[i] = Fcurrent_buffer ();
 533           if (EQ (selected_window, minibuf_window))
 534             args[i] = Fother_buffer (args[i], Qnil, Qnil);
 535           args[i] = Fread_buffer (callint_message, args[i], Qt, Qnil);
 536           break;
 537
 538         case 'B':               /* Name of buffer, possibly nonexistent.  */
 539           args[i] = Fread_buffer (callint_message,
 540                                   Fother_buffer (Fcurrent_buffer (), Qnil, Qnil),
 541                                   Qnil, Qnil);
 542           break;
 543
 544         case 'c':               /* Character.  */
 545           /* Prompt in `minibuffer-prompt' face.  */
 546           Fput_text_property (make_number (0),
 547                               make_number (SCHARS (callint_message)),
 548                               Qface, Qminibuffer_prompt, callint_message);
 549           args[i] = Fread_char (callint_message, Qnil, Qnil);
 550           message1_nolog (0);
 551           /* Passing args[i] directly stimulates compiler bug.  */
 552           teml = args[i];
 553           /* See bug#8479.  */
 554           if (! CHARACTERP (teml)) error ("Non-character input-event");
 555           visargs[i] = Fchar_to_string (teml);
 556           break;
 557
 558         case 'C':             /* Command: symbol with interactive function.  */
 559           visargs[i] = Fcompleting_read (callint_message,
 560                                          Vobarray, Qcommandp,
 561                                          Qt, Qnil, Qnil, Qnil, Qnil);
 562           /* Passing args[i] directly stimulates compiler bug.  */
 563           teml = visargs[i];
 564           args[i] = Fintern (teml, Qnil);
 565           break;
 566
 567         case 'd':               /* Value of point.  Does not do I/O.  */
 568           set_marker_both (point_marker, Qnil, PT, PT_BYTE);
 569           args[i] = point_marker;
 570           /* visargs[i] = Qnil; */
 571           varies[i] = 1;
 572           break;
 573
 574         case 'D':               /* Directory name.  */
 575           args[i] = read_file_name (BVAR (current_buffer, directory), Qlambda, Qnil,
 576                                     Qfile_directory_p);
 577           break;
 578
 579         case 'f':               /* Existing file name.  */
 580           args[i] = read_file_name (Qnil, Qlambda, Qnil, Qnil);
 581           break;
 582
 583         case 'F':               /* Possibly nonexistent file name.  */
 584           args[i] = read_file_name (Qnil, Qnil, Qnil, Qnil);
 585           break;
 586
 587         case 'G':               /* Possibly nonexistent file name,
 588                                    default to directory alone.  */
 589           args[i] = read_file_name (Qnil, Qnil, empty_unibyte_string, Qnil);
 590           break;
 591
 592         case 'i':               /* Ignore an argument -- Does not do I/O.  */
 593           varies[i] = -1;
 594           break;
 595
 596         case 'k':               /* Key sequence.  */
 597           {
 598             ptrdiff_t speccount1 = SPECPDL_INDEX ();
 599             specbind (Qcursor_in_echo_area, Qt);
 600             /* Prompt in `minibuffer-prompt' face.  */
 601             Fput_text_property (make_number (0),
 602                                 make_number (SCHARS (callint_message)),
 603                                 Qface, Qminibuffer_prompt, callint_message);
 604             args[i] = Fread_key_sequence (callint_message,
 605                                           Qnil, Qnil, Qnil, Qnil);
 606             unbind_to (speccount1, Qnil);
 607             teml = args[i];
 608             visargs[i] = Fkey_description (teml, Qnil);
 609
 610             /* If the key sequence ends with a down-event,
 611                discard the following up-event.  */
 612             teml = Faref (args[i], make_number (XINT (Flength (args[i])) - 1));
 613             if (CONSP (teml))
 614               teml = XCAR (teml);
 615             if (SYMBOLP (teml))
 616               {
 617                 Lisp_Object tem2;
 618
 619                 teml = Fget (teml, Qevent_symbol_elements);
 620                 /* Ignore first element, which is the base key.  */
 621                 tem2 = Fmemq (Qdown, Fcdr (teml));
 622                 if (! NILP (tem2))
 623                   up_event = Fread_event (Qnil, Qnil, Qnil);
 624               }
 625           }
 626           break;
 627
 628         case 'K':               /* Key sequence to be defined.  */
 629           {
 630             ptrdiff_t speccount1 = SPECPDL_INDEX ();
 631             specbind (Qcursor_in_echo_area, Qt);
 632             /* Prompt in `minibuffer-prompt' face.  */
 633             Fput_text_property (make_number (0),
 634                                 make_number (SCHARS (callint_message)),
 635                                 Qface, Qminibuffer_prompt, callint_message);
 636             args[i] = Fread_key_sequence_vector (callint_message,
 637                                                  Qnil, Qt, Qnil, Qnil);
 638             teml = args[i];
 639             visargs[i] = Fkey_description (teml, Qnil);
 640             unbind_to (speccount1, Qnil);
 641
 642             /* If the key sequence ends with a down-event,
 643                discard the following up-event.  */
 644             teml = Faref (args[i], make_number (XINT (Flength (args[i])) - 1));
 645             if (CONSP (teml))
 646               teml = XCAR (teml);
 647             if (SYMBOLP (teml))
 648               {
 649                 Lisp_Object tem2;
 650
 651                 teml = Fget (teml, Qevent_symbol_elements);
 652                 /* Ignore first element, which is the base key.  */
 653                 tem2 = Fmemq (Qdown, Fcdr (teml));
 654                 if (! NILP (tem2))
 655                   up_event = Fread_event (Qnil, Qnil, Qnil);
 656               }
 657           }
 658           break;
 659
 660         case 'U':               /* Up event from last k or K.  */
 661           if (!NILP (up_event))
 662             {
 663               args[i] = Fmake_vector (make_number (1), up_event);
 664               up_event = Qnil;
 665               teml = args[i];
 666               visargs[i] = Fkey_description (teml, Qnil);
 667             }
 668           break;
 669
 670         case 'e':               /* The invoking event.  */
 671           if (next_event >= key_count)
 672             error ("%s must be bound to an event with parameters",
 673                    (SYMBOLP (function)
 674                     ? SSDATA (SYMBOL_NAME (function))
 675                     : "command"));
 676           args[i] = AREF (keys, next_event);
 677           next_event++;
 678           varies[i] = -1;
 679
 680           /* Find the next parameterized event.  */
 681           while (next_event < key_count
 682                  && !(EVENT_HAS_PARAMETERS (AREF (keys, next_event))))
 683             next_event++;
 684
 685           break;
 686
 687         case 'm':               /* Value of mark.  Does not do I/O.  */
 688           check_mark (0);
 689           /* visargs[i] = Qnil; */
 690           args[i] = BVAR (current_buffer, mark);
 691           varies[i] = 2;
 692           break;
 693
 694         case 'M':               /* String read via minibuffer with
 695                                    inheriting the current input method.  */
 696           args[i] = Fread_string (callint_message,
 697                                   Qnil, Qnil, Qnil, Qt);
 698           break;
 699
 700         case 'N':     /* Prefix arg as number, else number from minibuffer.  */
 701           if (!NILP (prefix_arg))
 702             goto have_prefix_arg;
 703         case 'n':               /* Read number from minibuffer.  */
 704           args[i] = call1 (Qread_number, callint_message);
 705           /* Passing args[i] directly stimulates compiler bug.  */
 706           teml = args[i];
 707           visargs[i] = Fnumber_to_string (teml);
 708           break;
 709
 710         case 'P':               /* Prefix arg in raw form.  Does no I/O.  */
 711           args[i] = prefix_arg;
 712           /* visargs[i] = Qnil; */
 713           varies[i] = -1;
 714           break;
 715
 716         case 'p':               /* Prefix arg converted to number.  No I/O.  */
 717         have_prefix_arg:
 718           args[i] = Fprefix_numeric_value (prefix_arg);
 719           /* visargs[i] = Qnil; */
 720           varies[i] = -1;
 721           break;
 722
 723         case 'r':               /* Region, point and mark as 2 args.  */
 724           check_mark (1);
 725           set_marker_both (point_marker, Qnil, PT, PT_BYTE);
 726           /* visargs[i+1] = Qnil; */
 727           mark = marker_position (BVAR (current_buffer, mark));
 728           /* visargs[i] = Qnil; */
 729           args[i] = PT < mark ? point_marker : BVAR (current_buffer, mark);
 730           varies[i] = 3;
 731           args[++i] = PT > mark ? point_marker : BVAR (current_buffer, mark);
 732           varies[i] = 4;
 733           break;
 734
 735         case 's':               /* String read via minibuffer without
 736                                    inheriting the current input method.  */
 737           args[i] = Fread_string (callint_message,
 738                                   Qnil, Qnil, Qnil, Qnil);
 739           break;
 740
 741         case 'S':               /* Any symbol.  */
 742           visargs[i] = Fread_string (callint_message,
 743                                      Qnil, Qnil, Qnil, Qnil);
 744           /* Passing args[i] directly stimulates compiler bug.  */
 745           teml = visargs[i];
 746           args[i] = Fintern (teml, Qnil);
 747           break;
 748
 749         case 'v':               /* Variable name: symbol that is
 750                                    custom-variable-p.  */
 751           args[i] = Fread_variable (callint_message, Qnil);
 752           visargs[i] = last_minibuf_string;
 753           break;
 754
 755         case 'x':               /* Lisp expression read but not evaluated.  */
 756           args[i] = call1 (intern ("read-minibuffer"), callint_message);
 757           visargs[i] = last_minibuf_string;
 758           break;
 759
 760         case 'X':               /* Lisp expression read and evaluated.  */
 761           args[i] = call1 (intern ("eval-minibuffer"), callint_message);
 762           visargs[i] = last_minibuf_string;
 763           break;
 764
 765         case 'Z':               /* Coding-system symbol, or ignore the
 766                                    argument if no prefix.  */
 767           if (NILP (prefix_arg))
 768             {
 769               /* args[i] = Qnil; */
 770               varies[i] = -1;
 771             }
 772           else
 773             {
 774               args[i]
 775                 = Fread_non_nil_coding_system (callint_message);
 776               visargs[i] = last_minibuf_string;
 777             }
 778           break;
 779
 780         case 'z':               /* Coding-system symbol or nil.  */
 781           args[i] = Fread_coding_system (callint_message, Qnil);
 782           visargs[i] = last_minibuf_string;
 783           break;
 784
 785           /* We have a case for `+' so we get an error
 786              if anyone tries to define one here.  */
 787         case '+':
 788         default:
 789           error ("Invalid control letter `%c' (#o%03o, #x%04x) in interactive calling string",
 790                  STRING_CHAR ((unsigned char *) tem),
 791                  (unsigned) STRING_CHAR ((unsigned char *) tem),
 792                  (unsigned) STRING_CHAR ((unsigned char *) tem));
 793         }
 794
 795       if (varies[i] == 0)
 796         arg_from_tty = 1;
 797
 798       if (NILP (visargs[i]) && STRINGP (args[i]))
 799         visargs[i] = args[i];
 800
 801       tem = strchr (tem, '\n');
 802       if (tem) tem++;
 803       else tem = "";
 804     }
 805   unbind_to (speccount, Qnil);
 806
 807   QUIT;
 808
 809   args[0] = Qfuncall_interactively;
 810   args[1] = function;
 811
 812   if (arg_from_tty || !NILP (record_flag))
 813     {
 814       /* We don't need `visargs' any more, so let's recycle it since we need
 815          an array of just the same size.  */
 816       visargs[1] = function;
 817       for (i = 2; i < nargs; i++)
 818         {
 819           if (varies[i] > 0)
 820             visargs[i] = list1 (intern (callint_argfuns[varies[i]]));
 821           else
 822             visargs[i] = quotify_arg (args[i]);
 823         }
 824       Vcommand_history = Fcons (Flist (nargs - 1, visargs + 1),
 825                                 Vcommand_history);
 826       /* Don't keep command history around forever.  */
 827       if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
 828         {
 829           teml = Fnthcdr (Vhistory_length, Vcommand_history);
 830           if (CONSP (teml))
 831             XSETCDR (teml, Qnil);
 832         }
 833     }
 834
 835   /* If we used a marker to hold point, mark, or an end of the region,
 836      temporarily, convert it to an integer now.  */
 837   for (i = 2; i < nargs; i++)
 838     if (varies[i] >= 1 && varies[i] <= 4)
 839       XSETINT (args[i], marker_position (args[i]));
 840
 841   if (record_then_fail)
 842     Fbarf_if_buffer_read_only (Qnil);
 843
 844   Vthis_command = save_this_command;
 845   Vthis_original_command = save_this_original_command;
 846   Vreal_this_command = save_real_this_command;
 847   kset_last_command (current_kboard, save_last_command);
 848
 849   {
 850     Lisp_Object val = Ffuncall (nargs, args);
 851     UNGCPRO;
 852     val = unbind_to (speccount, val);
 853     SAFE_FREE ();
 854     return val;
 855   }
 856 }
 857
 858 DEFUN ("prefix-numeric-value", Fprefix_numeric_value, Sprefix_numeric_value,
 859        1, 1, 0,
 860        doc: /* Return numeric meaning of raw prefix argument RAW.
 861 A raw prefix argument is what you get from `(interactive "P")'.
 862 Its numeric meaning is what you would get from `(interactive "p")'.  */)
 863   (Lisp_Object raw)
 864 {
 865   Lisp_Object val;
 866
 867   if (NILP (raw))
 868     XSETFASTINT (val, 1);
 869   else if (EQ (raw, Qminus))
 870     XSETINT (val, -1);
 871   else if (CONSP (raw) && INTEGERP (XCAR (raw)))
 872     XSETINT (val, XINT (XCAR (raw)));
 873   else if (INTEGERP (raw))
 874     val = raw;
 875   else
 876     XSETFASTINT (val, 1);
 877
 878   return val;
 879 }
 880
 881 void
 882 syms_of_callint (void)
 883 {
 884   point_marker = Fmake_marker ();
 885   staticpro (&point_marker);
 886
 887   callint_message = Qnil;
 888   staticpro (&callint_message);
 889
 890   preserved_fns = listn (CONSTYPE_PURE, 4,
 891                          intern_c_string ("region-beginning"),
 892                          intern_c_string ("region-end"),
 893                          intern_c_string ("point"),
 894                          intern_c_string ("mark"));
 895
 896   DEFSYM (Qlist, "list");
 897   DEFSYM (Qlet, "let");
 898   DEFSYM (Qif, "if");
 899   DEFSYM (Qwhen, "when");
 900   DEFSYM (Qletx, "let*");
 901   DEFSYM (Qsave_excursion, "save-excursion");
 902   DEFSYM (Qprogn, "progn");
 903   DEFSYM (Qminus, "-");
 904   DEFSYM (Qplus, "+");
 905   DEFSYM (Qhandle_shift_selection, "handle-shift-selection");
 906   DEFSYM (Qread_number, "read-number");
 907   DEFSYM (Qfuncall_interactively, "funcall-interactively");
 908   DEFSYM (Qenable_recursive_minibuffers, "enable-recursive-minibuffers");
 909   DEFSYM (Qmouse_leave_buffer_hook, "mouse-leave-buffer-hook");
 910
 911   DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
 912                  doc: /* The value of the prefix argument for the next editing command.
 913 It may be a number, or the symbol `-' for just a minus sign as arg,
 914 or a list whose car is a number for just one or more C-u's
 915 or nil if no argument has been specified.
 916
 917 You cannot examine this variable to find the argument for this command
 918 since it has been set to nil by the time you can look.
 919 Instead, you should use the variable `current-prefix-arg', although
 920 normally commands can get this prefix argument with (interactive "P").  */);
 921
 922   DEFVAR_KBOARD ("last-prefix-arg", Vlast_prefix_arg,
 923                  doc: /* The value of the prefix argument for the previous editing command.
 924 See `prefix-arg' for the meaning of the value.  */);
 925
 926   DEFVAR_LISP ("current-prefix-arg", Vcurrent_prefix_arg,
 927                doc: /* The value of the prefix argument for this editing command.
 928 It may be a number, or the symbol `-' for just a minus sign as arg,
 929 or a list whose car is a number for just one or more C-u's
 930 or nil if no argument has been specified.
 931 This is what `(interactive \"P\")' returns.  */);
 932   Vcurrent_prefix_arg = Qnil;
 933
 934   DEFVAR_LISP ("command-history", Vcommand_history,
 935                doc: /* List of recent commands that read arguments from terminal.
 936 Each command is represented as a form to evaluate.
 937
 938 Maximum length of the history list is determined by the value
 939 of `history-length', which see.  */);
 940   Vcommand_history = Qnil;
 941
 942   DEFVAR_LISP ("command-debug-status", Vcommand_debug_status,
 943                doc: /* Debugging status of current interactive command.
 944 Bound each time `call-interactively' is called;
 945 may be set by the debugger as a reminder for itself.  */);
 946   Vcommand_debug_status = Qnil;
 947
 948   DEFVAR_LISP ("mark-even-if-inactive", Vmark_even_if_inactive,
 949                doc: /* Non-nil means you can use the mark even when inactive.
 950 This option makes a difference in Transient Mark mode.
 951 When the option is non-nil, deactivation of the mark
 952 turns off region highlighting, but commands that use the mark
 953 behave as if the mark were still active.  */);
 954   Vmark_even_if_inactive = Qt;
 955
 956   DEFVAR_LISP ("mouse-leave-buffer-hook", Vmouse_leave_buffer_hook,
 957                doc: /* Hook to run when about to switch windows with a mouse command.
 958 Its purpose is to give temporary modes such as Isearch mode
 959 a way to turn themselves off when a mouse command switches windows.  */);
 960   Vmouse_leave_buffer_hook = Qnil;
 961
 962   defsubr (&Sinteractive);
 963   defsubr (&Scall_interactively);
 964   defsubr (&Sfuncall_interactively);
 965   defsubr (&Sprefix_numeric_value);
 966 }