* lisp/emacs-lisp/bytecomp.el (byte-compile): Fix handling of closures.
[emacs.git] / src / callint.c
blobc4c087e83d7992563d46969c783a674b3ccceca9
1 /* Call a Lisp function interactively.
2 Copyright (C) 1985-1986, 1993-1995, 1997, 2000-2012
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
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.
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.
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/>. */
21 #include <config.h>
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"
31 Lisp_Object Qminus, Qplus;
32 Lisp_Object Qcall_interactively;
33 static Lisp_Object Qcommand_debug_status;
34 static Lisp_Object Qenable_recursive_minibuffers;
36 static Lisp_Object Qhandle_shift_selection;
38 Lisp_Object Qmouse_leave_buffer_hook;
40 static Lisp_Object Qlist, Qlet, Qletx, Qsave_excursion, Qprogn, Qif;
41 Lisp_Object Qwhen;
42 static Lisp_Object preserved_fns;
44 /* Marker used within call-interactively to refer to point. */
45 static Lisp_Object point_marker;
47 /* String for the prompt text used in Fcall_interactively. */
48 static Lisp_Object callint_message;
50 /* ARGSUSED */
51 DEFUN ("interactive", Finteractive, Sinteractive, 0, UNEVALLED, 0,
52 doc: /* Specify a way of parsing arguments for interactive use of a function.
53 For example, write
54 (defun foo (arg buf) "Doc string" (interactive "P\\nbbuffer: ") .... )
55 to make ARG be the raw prefix argument, and set BUF to an existing buffer,
56 when `foo' is called as a command.
57 The "call" to `interactive' is actually a declaration rather than a function;
58 it tells `call-interactively' how to read arguments
59 to pass to the function.
60 When actually called, `interactive' just returns nil.
62 Usually the argument of `interactive' is a string containing a code letter
63 followed optionally by a prompt. (Some code letters do not use I/O to get
64 the argument and do not use prompts.) To get several arguments, concatenate
65 the individual strings, separating them by newline characters.
66 Prompts are passed to format, and may use % escapes to print the
67 arguments that have already been read.
68 If the argument is not a string, it is evaluated to get a list of
69 arguments to pass to the function.
70 Just `(interactive)' means pass no args when calling interactively.
72 Code letters available are:
73 a -- Function name: symbol with a function definition.
74 b -- Name of existing buffer.
75 B -- Name of buffer, possibly nonexistent.
76 c -- Character (no input method is used).
77 C -- Command name: symbol with interactive function definition.
78 d -- Value of point as number. Does not do I/O.
79 D -- Directory name.
80 e -- Parameterized event (i.e., one that's a list) that invoked this command.
81 If used more than once, the Nth `e' returns the Nth parameterized event.
82 This skips events that are integers or symbols.
83 f -- Existing file name.
84 F -- Possibly nonexistent file name.
85 G -- Possibly nonexistent file name, defaulting to just directory name.
86 i -- Ignored, i.e. always nil. Does not do I/O.
87 k -- Key sequence (downcase the last event if needed to get a definition).
88 K -- Key sequence to be redefined (do not downcase the last event).
89 m -- Value of mark as number. Does not do I/O.
90 M -- Any string. Inherits the current input method.
91 n -- Number read using minibuffer.
92 N -- Numeric prefix arg, or if none, do like code `n'.
93 p -- Prefix arg converted to number. Does not do I/O.
94 P -- Prefix arg in raw form. Does not do I/O.
95 r -- Region: point and mark as 2 numeric args, smallest first. Does no I/O.
96 s -- Any string. Does not inherit the current input method.
97 S -- Any symbol.
98 U -- Mouse up event discarded by a previous k or K argument.
99 v -- Variable name: symbol that is `custom-variable-p'.
100 x -- Lisp expression read but not evaluated.
101 X -- Lisp expression read and evaluated.
102 z -- Coding system.
103 Z -- Coding system, nil if no prefix arg.
105 In addition, if the string begins with `*', an error is signaled if
106 the buffer is read-only.
107 If `@' appears at the beginning of the string, and if the key sequence
108 used to invoke the command includes any mouse events, then the window
109 associated with the first of those events is selected before the
110 command is run.
111 If the string begins with `^' and `shift-select-mode' is non-nil,
112 Emacs first calls the function `handle-shift-selection'.
113 You may use `@', `*', and `^' together. They are processed in the
114 order that they appear, before reading any arguments.
115 usage: (interactive &optional ARGS) */)
116 (Lisp_Object args)
118 return Qnil;
121 /* Quotify EXP: if EXP is constant, return it.
122 If EXP is not constant, return (quote EXP). */
123 static Lisp_Object
124 quotify_arg (register Lisp_Object exp)
126 if (CONSP (exp)
127 || (SYMBOLP (exp)
128 && !NILP (exp) && !EQ (exp, Qt)))
129 return Fcons (Qquote, Fcons (exp, Qnil));
131 return exp;
134 /* Modify EXP by quotifying each element (except the first). */
135 static Lisp_Object
136 quotify_args (Lisp_Object exp)
138 register Lisp_Object tail;
139 Lisp_Object next;
140 for (tail = exp; CONSP (tail); tail = next)
142 next = XCDR (tail);
143 XSETCAR (tail, quotify_arg (XCAR (tail)));
145 return exp;
148 static const char *callint_argfuns[]
149 = {"", "point", "mark", "region-beginning", "region-end"};
151 static void
152 check_mark (bool for_region)
154 Lisp_Object tem;
155 tem = Fmarker_buffer (BVAR (current_buffer, mark));
156 if (NILP (tem) || (XBUFFER (tem) != current_buffer))
157 error (for_region ? "The mark is not set now, so there is no region"
158 : "The mark is not set now");
159 if (!NILP (Vtransient_mark_mode) && NILP (Vmark_even_if_inactive)
160 && NILP (BVAR (current_buffer, mark_active)))
161 xsignal0 (Qmark_inactive);
164 /* If the list of args INPUT was produced with an explicit call to
165 `list', look for elements that were computed with
166 (region-beginning) or (region-end), and put those expressions into
167 VALUES instead of the present values.
169 This function doesn't return a value because it modifies elements
170 of VALUES to do its job. */
172 static void
173 fix_command (Lisp_Object input, Lisp_Object values)
175 /* FIXME: Instead of this ugly hack, we should provide a way for an
176 interactive spec to return an expression/function that will re-build the
177 args without user intervention. */
178 if (CONSP (input))
180 Lisp_Object car;
182 car = XCAR (input);
183 /* Skip through certain special forms. */
184 while (EQ (car, Qlet) || EQ (car, Qletx)
185 || EQ (car, Qsave_excursion)
186 || EQ (car, Qprogn))
188 while (CONSP (XCDR (input)))
189 input = XCDR (input);
190 input = XCAR (input);
191 if (!CONSP (input))
192 break;
193 car = XCAR (input);
195 if (EQ (car, Qlist))
197 Lisp_Object intail, valtail;
198 for (intail = Fcdr (input), valtail = values;
199 CONSP (valtail);
200 intail = Fcdr (intail), valtail = XCDR (valtail))
202 Lisp_Object elt;
203 elt = Fcar (intail);
204 if (CONSP (elt))
206 Lisp_Object presflag, carelt;
207 carelt = XCAR (elt);
208 /* If it is (if X Y), look at Y. */
209 if (EQ (carelt, Qif)
210 && EQ (Fnthcdr (make_number (3), elt), Qnil))
211 elt = Fnth (make_number (2), elt);
212 /* If it is (when ... Y), look at Y. */
213 else if (EQ (carelt, Qwhen))
215 while (CONSP (XCDR (elt)))
216 elt = XCDR (elt);
217 elt = Fcar (elt);
220 /* If the function call we're looking at
221 is a special preserved one, copy the
222 whole expression for this argument. */
223 if (CONSP (elt))
225 presflag = Fmemq (Fcar (elt), preserved_fns);
226 if (!NILP (presflag))
227 Fsetcar (valtail, Fcar (intail));
235 DEFUN ("call-interactively", Fcall_interactively, Scall_interactively, 1, 3, 0,
236 doc: /* Call FUNCTION, providing args according to its interactive calling specs.
237 Return the value FUNCTION returns.
238 The function contains a specification of how to do the argument reading.
239 In the case of user-defined functions, this is specified by placing a call
240 to the function `interactive' at the top level of the function body.
241 See `interactive'.
243 Optional second arg RECORD-FLAG non-nil
244 means unconditionally put this command in the command-history.
245 Otherwise, this is done only if an arg is read using the minibuffer.
247 Optional third arg KEYS, if given, specifies the sequence of events to
248 supply, as a vector, if the command inquires which events were used to
249 invoke it. If KEYS is omitted or nil, the return value of
250 `this-command-keys-vector' is used. */)
251 (Lisp_Object function, Lisp_Object record_flag, Lisp_Object keys)
253 Lisp_Object *args, *visargs;
254 Lisp_Object specs;
255 Lisp_Object filter_specs;
256 Lisp_Object teml;
257 Lisp_Object up_event;
258 Lisp_Object enable;
259 ptrdiff_t speccount = SPECPDL_INDEX ();
261 /* The index of the next element of this_command_keys to examine for
262 the 'e' interactive code. */
263 ptrdiff_t next_event;
265 Lisp_Object prefix_arg;
266 char *string;
267 const char *tem;
269 /* If varies[i] > 0, the i'th argument shouldn't just have its value
270 in this call quoted in the command history. It should be
271 recorded as a call to the function named callint_argfuns[varies[i]]. */
272 signed char *varies;
274 ptrdiff_t i, nargs;
275 ptrdiff_t mark;
276 bool arg_from_tty = 0;
277 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
278 ptrdiff_t key_count;
279 bool record_then_fail = 0;
281 Lisp_Object save_this_command, save_last_command;
282 Lisp_Object save_this_original_command, save_real_this_command;
284 save_this_command = Vthis_command;
285 save_this_original_command = Vthis_original_command;
286 save_real_this_command = Vreal_this_command;
287 save_last_command = KVAR (current_kboard, Vlast_command);
289 if (NILP (keys))
290 keys = this_command_keys, key_count = this_command_key_count;
291 else
293 CHECK_VECTOR (keys);
294 key_count = ASIZE (keys);
297 /* Save this now, since use of minibuffer will clobber it. */
298 prefix_arg = Vcurrent_prefix_arg;
300 if (SYMBOLP (function))
301 enable = Fget (function, Qenable_recursive_minibuffers);
302 else
303 enable = Qnil;
305 specs = Qnil;
306 string = 0;
307 /* The idea of FILTER_SPECS is to provide away to
308 specify how to represent the arguments in command history.
309 The feature is not fully implemented. */
310 filter_specs = Qnil;
312 /* If k or K discard an up-event, save it here so it can be retrieved with
313 U. */
314 up_event = Qnil;
316 /* Set SPECS to the interactive form, or barf if not interactive. */
318 Lisp_Object form;
319 GCPRO2 (function, prefix_arg);
320 form = Finteractive_form (function);
321 UNGCPRO;
322 if (CONSP (form))
323 specs = filter_specs = Fcar (XCDR (form));
324 else
325 wrong_type_argument (Qcommandp, function);
328 /* If SPECS is set to a string, use it as an interactive prompt. */
329 if (STRINGP (specs))
331 /* Make a copy of string so that if a GC relocates specs,
332 `string' will still be valid. */
333 string = alloca (SBYTES (specs) + 1);
334 memcpy (string, SSDATA (specs), SBYTES (specs) + 1);
336 else
338 Lisp_Object input;
339 Lisp_Object funval = Findirect_function (function, Qt);
340 uintmax_t events = num_input_events;
341 input = specs;
342 /* Compute the arg values using the user's expression. */
343 GCPRO2 (input, filter_specs);
344 specs = Feval (specs,
345 CONSP (funval) && EQ (Qclosure, XCAR (funval))
346 ? Qt : Qnil);
347 UNGCPRO;
348 if (events != num_input_events || !NILP (record_flag))
350 /* We should record this command on the command history. */
351 Lisp_Object values;
352 Lisp_Object this_cmd;
353 /* Make a copy of the list of values, for the command history,
354 and turn them into things we can eval. */
355 values = quotify_args (Fcopy_sequence (specs));
356 fix_command (input, values);
357 this_cmd = Fcons (function, values);
358 if (history_delete_duplicates)
359 Vcommand_history = Fdelete (this_cmd, Vcommand_history);
360 Vcommand_history = Fcons (this_cmd, Vcommand_history);
362 /* Don't keep command history around forever. */
363 if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
365 teml = Fnthcdr (Vhistory_length, Vcommand_history);
366 if (CONSP (teml))
367 XSETCDR (teml, Qnil);
371 Vthis_command = save_this_command;
372 Vthis_original_command = save_this_original_command;
373 Vreal_this_command = save_real_this_command;
374 kset_last_command (current_kboard, save_last_command);
376 temporarily_switch_to_single_kboard (NULL);
377 return unbind_to (speccount, apply1 (function, specs));
380 /* Here if function specifies a string to control parsing the defaults. */
382 /* Set next_event to point to the first event with parameters. */
383 for (next_event = 0; next_event < key_count; next_event++)
384 if (EVENT_HAS_PARAMETERS (AREF (keys, next_event)))
385 break;
387 /* Handle special starting chars `*' and `@'. Also `-'. */
388 /* Note that `+' is reserved for user extensions. */
389 while (1)
391 if (*string == '+')
392 error ("`+' is not used in `interactive' for ordinary commands");
393 else if (*string == '*')
395 string++;
396 if (!NILP (BVAR (current_buffer, read_only)))
398 if (!NILP (record_flag))
400 char *p = string;
401 while (*p)
403 if (! (*p == 'r' || *p == 'p' || *p == 'P'
404 || *p == '\n'))
405 Fbarf_if_buffer_read_only ();
406 p++;
408 record_then_fail = 1;
410 else
411 Fbarf_if_buffer_read_only ();
414 /* Ignore this for semi-compatibility with Lucid. */
415 else if (*string == '-')
416 string++;
417 else if (*string == '@')
419 Lisp_Object event, w;
421 event = (next_event < key_count
422 ? AREF (keys, next_event)
423 : Qnil);
424 if (EVENT_HAS_PARAMETERS (event)
425 && (w = XCDR (event), CONSP (w))
426 && (w = XCAR (w), CONSP (w))
427 && (w = XCAR (w), WINDOWP (w)))
429 if (MINI_WINDOW_P (XWINDOW (w))
430 && ! (minibuf_level > 0 && EQ (w, minibuf_window)))
431 error ("Attempt to select inactive minibuffer window");
433 /* If the current buffer wants to clean up, let it. */
434 Frun_hooks (1, &Qmouse_leave_buffer_hook);
436 Fselect_window (w, Qnil);
438 string++;
440 else if (*string == '^')
442 call0 (Qhandle_shift_selection);
443 string++;
445 else break;
448 /* Count the number of arguments, which is one plus the number of arguments
449 the interactive spec would have us give to the function. */
450 tem = string;
451 for (nargs = 1; *tem; )
453 /* 'r' specifications ("point and mark as 2 numeric args")
454 produce *two* arguments. */
455 if (*tem == 'r')
456 nargs += 2;
457 else
458 nargs++;
459 tem = strchr (tem, '\n');
460 if (tem)
461 ++tem;
462 else
463 break;
466 if (min (MOST_POSITIVE_FIXNUM,
467 min (PTRDIFF_MAX, SIZE_MAX) / word_size)
468 < nargs)
469 memory_full (SIZE_MAX);
471 args = alloca (nargs * sizeof *args);
472 visargs = alloca (nargs * sizeof *visargs);
473 varies = alloca (nargs * sizeof *varies);
475 for (i = 0; i < nargs; i++)
477 args[i] = Qnil;
478 visargs[i] = Qnil;
479 varies[i] = 0;
482 GCPRO5 (prefix_arg, function, *args, *visargs, up_event);
483 gcpro3.nvars = nargs;
484 gcpro4.nvars = nargs;
486 if (!NILP (enable))
487 specbind (Qenable_recursive_minibuffers, Qt);
489 tem = string;
490 for (i = 1; *tem; i++)
492 visargs[0] = make_string (tem + 1, strcspn (tem + 1, "\n"));
493 if (strchr (SSDATA (visargs[0]), '%'))
494 callint_message = Fformat (i, visargs);
495 else
496 callint_message = visargs[0];
498 switch (*tem)
500 case 'a': /* Symbol defined as a function */
501 visargs[i] = Fcompleting_read (callint_message,
502 Vobarray, Qfboundp, Qt,
503 Qnil, Qnil, Qnil, Qnil);
504 /* Passing args[i] directly stimulates compiler bug */
505 teml = visargs[i];
506 args[i] = Fintern (teml, Qnil);
507 break;
509 case 'b': /* Name of existing buffer */
510 args[i] = Fcurrent_buffer ();
511 if (EQ (selected_window, minibuf_window))
512 args[i] = Fother_buffer (args[i], Qnil, Qnil);
513 args[i] = Fread_buffer (callint_message, args[i], Qt);
514 break;
516 case 'B': /* Name of buffer, possibly nonexistent */
517 args[i] = Fread_buffer (callint_message,
518 Fother_buffer (Fcurrent_buffer (), Qnil, Qnil),
519 Qnil);
520 break;
522 case 'c': /* Character */
523 /* Prompt in `minibuffer-prompt' face. */
524 Fput_text_property (make_number (0),
525 make_number (SCHARS (callint_message)),
526 Qface, Qminibuffer_prompt, callint_message);
527 args[i] = Fread_char (callint_message, Qnil, Qnil);
528 message1_nolog ((char *) 0);
529 /* Passing args[i] directly stimulates compiler bug */
530 teml = args[i];
531 /* See bug#8479. */
532 if (! CHARACTERP (teml)) error ("Non-character input-event");
533 visargs[i] = Fchar_to_string (teml);
534 break;
536 case 'C': /* Command: symbol with interactive function */
537 visargs[i] = Fcompleting_read (callint_message,
538 Vobarray, Qcommandp,
539 Qt, Qnil, Qnil, Qnil, Qnil);
540 /* Passing args[i] directly stimulates compiler bug */
541 teml = visargs[i];
542 args[i] = Fintern (teml, Qnil);
543 break;
545 case 'd': /* Value of point. Does not do I/O. */
546 set_marker_both (point_marker, Qnil, PT, PT_BYTE);
547 args[i] = point_marker;
548 /* visargs[i] = Qnil; */
549 varies[i] = 1;
550 break;
552 case 'D': /* Directory name. */
553 args[i] = Fread_file_name (callint_message, Qnil,
554 BVAR (current_buffer, directory), Qlambda, Qnil,
555 Qfile_directory_p);
556 break;
558 case 'f': /* Existing file name. */
559 args[i] = Fread_file_name (callint_message,
560 Qnil, Qnil, Qlambda, Qnil, Qnil);
561 break;
563 case 'F': /* Possibly nonexistent file name. */
564 args[i] = Fread_file_name (callint_message,
565 Qnil, Qnil, Qnil, Qnil, Qnil);
566 break;
568 case 'G': /* Possibly nonexistent file name,
569 default to directory alone. */
570 args[i] = Fread_file_name (callint_message,
571 Qnil, Qnil, Qnil, empty_unibyte_string, Qnil);
572 break;
574 case 'i': /* Ignore an argument -- Does not do I/O */
575 varies[i] = -1;
576 break;
578 case 'k': /* Key sequence. */
580 ptrdiff_t speccount1 = SPECPDL_INDEX ();
581 specbind (Qcursor_in_echo_area, Qt);
582 /* Prompt in `minibuffer-prompt' face. */
583 Fput_text_property (make_number (0),
584 make_number (SCHARS (callint_message)),
585 Qface, Qminibuffer_prompt, callint_message);
586 args[i] = Fread_key_sequence (callint_message,
587 Qnil, Qnil, Qnil, Qnil);
588 unbind_to (speccount1, Qnil);
589 teml = args[i];
590 visargs[i] = Fkey_description (teml, Qnil);
592 /* If the key sequence ends with a down-event,
593 discard the following up-event. */
594 teml = Faref (args[i], make_number (XINT (Flength (args[i])) - 1));
595 if (CONSP (teml))
596 teml = XCAR (teml);
597 if (SYMBOLP (teml))
599 Lisp_Object tem2;
601 teml = Fget (teml, intern ("event-symbol-elements"));
602 /* Ignore first element, which is the base key. */
603 tem2 = Fmemq (intern ("down"), Fcdr (teml));
604 if (! NILP (tem2))
605 up_event = Fread_event (Qnil, Qnil, Qnil);
608 break;
610 case 'K': /* Key sequence to be defined. */
612 ptrdiff_t speccount1 = SPECPDL_INDEX ();
613 specbind (Qcursor_in_echo_area, Qt);
614 /* Prompt in `minibuffer-prompt' face. */
615 Fput_text_property (make_number (0),
616 make_number (SCHARS (callint_message)),
617 Qface, Qminibuffer_prompt, callint_message);
618 args[i] = Fread_key_sequence (callint_message,
619 Qnil, Qt, Qnil, Qnil);
620 teml = args[i];
621 visargs[i] = Fkey_description (teml, Qnil);
622 unbind_to (speccount1, Qnil);
624 /* If the key sequence ends with a down-event,
625 discard the following up-event. */
626 teml = Faref (args[i], make_number (XINT (Flength (args[i])) - 1));
627 if (CONSP (teml))
628 teml = XCAR (teml);
629 if (SYMBOLP (teml))
631 Lisp_Object tem2;
633 teml = Fget (teml, intern ("event-symbol-elements"));
634 /* Ignore first element, which is the base key. */
635 tem2 = Fmemq (intern ("down"), Fcdr (teml));
636 if (! NILP (tem2))
637 up_event = Fread_event (Qnil, Qnil, Qnil);
640 break;
642 case 'U': /* Up event from last k or K */
643 if (!NILP (up_event))
645 args[i] = Fmake_vector (make_number (1), up_event);
646 up_event = Qnil;
647 teml = args[i];
648 visargs[i] = Fkey_description (teml, Qnil);
650 break;
652 case 'e': /* The invoking event. */
653 if (next_event >= key_count)
654 error ("%s must be bound to an event with parameters",
655 (SYMBOLP (function)
656 ? SSDATA (SYMBOL_NAME (function))
657 : "command"));
658 args[i] = AREF (keys, next_event);
659 next_event++;
660 varies[i] = -1;
662 /* Find the next parameterized event. */
663 while (next_event < key_count
664 && !(EVENT_HAS_PARAMETERS (AREF (keys, next_event))))
665 next_event++;
667 break;
669 case 'm': /* Value of mark. Does not do I/O. */
670 check_mark (0);
671 /* visargs[i] = Qnil; */
672 args[i] = BVAR (current_buffer, mark);
673 varies[i] = 2;
674 break;
676 case 'M': /* String read via minibuffer with
677 inheriting the current input method. */
678 args[i] = Fread_string (callint_message,
679 Qnil, Qnil, Qnil, Qt);
680 break;
682 case 'N': /* Prefix arg as number, else number from minibuffer */
683 if (!NILP (prefix_arg))
684 goto have_prefix_arg;
685 case 'n': /* Read number from minibuffer. */
687 bool first = 1;
690 Lisp_Object str;
691 if (! first)
693 message ("Please enter a number.");
694 sit_for (make_number (1), 0, 0);
696 first = 0;
698 str = Fread_from_minibuffer (callint_message,
699 Qnil, Qnil, Qnil, Qnil, Qnil,
700 Qnil);
701 if (! STRINGP (str) || SCHARS (str) == 0)
702 args[i] = Qnil;
703 else
704 args[i] = Fread (str);
706 while (! NUMBERP (args[i]));
708 visargs[i] = args[i];
709 break;
711 case 'P': /* Prefix arg in raw form. Does no I/O. */
712 args[i] = prefix_arg;
713 /* visargs[i] = Qnil; */
714 varies[i] = -1;
715 break;
717 case 'p': /* Prefix arg converted to number. No I/O. */
718 have_prefix_arg:
719 args[i] = Fprefix_numeric_value (prefix_arg);
720 /* visargs[i] = Qnil; */
721 varies[i] = -1;
722 break;
724 case 'r': /* Region, point and mark as 2 args. */
725 check_mark (1);
726 set_marker_both (point_marker, Qnil, PT, PT_BYTE);
727 /* visargs[i+1] = Qnil; */
728 mark = marker_position (BVAR (current_buffer, mark));
729 /* visargs[i] = Qnil; */
730 args[i] = PT < mark ? point_marker : BVAR (current_buffer, mark);
731 varies[i] = 3;
732 args[++i] = PT > mark ? point_marker : BVAR (current_buffer, mark);
733 varies[i] = 4;
734 break;
736 case 's': /* String read via minibuffer without
737 inheriting the current input method. */
738 args[i] = Fread_string (callint_message,
739 Qnil, Qnil, Qnil, Qnil);
740 break;
742 case 'S': /* Any symbol. */
743 visargs[i] = Fread_string (callint_message,
744 Qnil, Qnil, Qnil, Qnil);
745 /* Passing args[i] directly stimulates compiler bug */
746 teml = visargs[i];
747 args[i] = Fintern (teml, Qnil);
748 break;
750 case 'v': /* Variable name: symbol that is
751 custom-variable-p. */
752 args[i] = Fread_variable (callint_message, Qnil);
753 visargs[i] = last_minibuf_string;
754 break;
756 case 'x': /* Lisp expression read but not evaluated */
757 args[i] = Fread_minibuffer (callint_message, Qnil);
758 visargs[i] = last_minibuf_string;
759 break;
761 case 'X': /* Lisp expression read and evaluated */
762 args[i] = Feval_minibuffer (callint_message, Qnil);
763 visargs[i] = last_minibuf_string;
764 break;
766 case 'Z': /* Coding-system symbol, or ignore the
767 argument if no prefix */
768 if (NILP (prefix_arg))
770 args[i] = Qnil;
771 varies[i] = -1;
773 else
775 args[i]
776 = Fread_non_nil_coding_system (callint_message);
777 visargs[i] = last_minibuf_string;
779 break;
781 case 'z': /* Coding-system symbol or nil */
782 args[i] = Fread_coding_system (callint_message, Qnil);
783 visargs[i] = last_minibuf_string;
784 break;
786 /* We have a case for `+' so we get an error
787 if anyone tries to define one here. */
788 case '+':
789 default:
790 error ("Invalid control letter `%c' (#o%03o, #x%04x) in interactive calling string",
791 STRING_CHAR ((unsigned char *) tem),
792 (unsigned) STRING_CHAR ((unsigned char *) tem),
793 (unsigned) STRING_CHAR ((unsigned char *) tem));
796 if (varies[i] == 0)
797 arg_from_tty = 1;
799 if (NILP (visargs[i]) && STRINGP (args[i]))
800 visargs[i] = args[i];
802 tem = strchr (tem, '\n');
803 if (tem) tem++;
804 else tem = "";
806 unbind_to (speccount, Qnil);
808 QUIT;
810 args[0] = function;
812 if (arg_from_tty || !NILP (record_flag))
814 visargs[0] = function;
815 for (i = 1; i < nargs; i++)
817 if (varies[i] > 0)
818 visargs[i] = Fcons (intern (callint_argfuns[varies[i]]), Qnil);
819 else
820 visargs[i] = quotify_arg (args[i]);
822 Vcommand_history = Fcons (Flist (nargs, visargs),
823 Vcommand_history);
824 /* Don't keep command history around forever. */
825 if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
827 teml = Fnthcdr (Vhistory_length, Vcommand_history);
828 if (CONSP (teml))
829 XSETCDR (teml, Qnil);
833 /* If we used a marker to hold point, mark, or an end of the region,
834 temporarily, convert it to an integer now. */
835 for (i = 1; i < nargs; i++)
836 if (varies[i] >= 1 && varies[i] <= 4)
837 XSETINT (args[i], marker_position (args[i]));
839 if (record_then_fail)
840 Fbarf_if_buffer_read_only ();
842 Vthis_command = save_this_command;
843 Vthis_original_command = save_this_original_command;
844 Vreal_this_command = save_real_this_command;
845 kset_last_command (current_kboard, save_last_command);
848 Lisp_Object val;
849 specbind (Qcommand_debug_status, Qnil);
851 temporarily_switch_to_single_kboard (NULL);
852 val = Ffuncall (nargs, args);
853 UNGCPRO;
854 return unbind_to (speccount, val);
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)
865 Lisp_Object val;
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);
878 return val;
881 void
882 syms_of_callint (void)
884 point_marker = Fmake_marker ();
885 staticpro (&point_marker);
887 callint_message = Qnil;
888 staticpro (&callint_message);
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"));
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 (Qcall_interactively, "call-interactively");
907 DEFSYM (Qcommand_debug_status, "command-debug-status");
908 DEFSYM (Qenable_recursive_minibuffers, "enable-recursive-minibuffers");
909 DEFSYM (Qmouse_leave_buffer_hook, "mouse-leave-buffer-hook");
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.
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"). */);
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. */);
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;
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.
938 Maximum length of the history list is determined by the value
939 of `history-length', which see. */);
940 Vcommand_history = Qnil;
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;
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;
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;
962 defsubr (&Sinteractive);
963 defsubr (&Scall_interactively);
964 defsubr (&Sprefix_numeric_value);