* alloc.c: Check that resized vectors' lengths fit in fixnums.
[emacs.git] / src / callint.c
blobdc5e6a4c37a1148b727b13e7d38bc6cda0c9b906
1 /* Call a Lisp function interactively.
2 Copyright (C) 1985-1986, 1993-1995, 1997, 2000-2011
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>
22 #include <setjmp.h>
24 #include "lisp.h"
25 #include "buffer.h"
26 #include "commands.h"
27 #include "keyboard.h"
28 #include "window.h"
29 #include "keymap.h"
30 #include "character.h"
32 Lisp_Object Qminus, Qplus;
33 Lisp_Object Qcall_interactively;
34 static Lisp_Object Qcommand_debug_status;
35 static Lisp_Object Qenable_recursive_minibuffers;
37 static Lisp_Object Qhandle_shift_selection;
39 Lisp_Object Qmouse_leave_buffer_hook;
41 static Lisp_Object Qlist, Qlet, Qletx, Qsave_excursion, Qprogn, Qif;
42 Lisp_Object Qwhen;
43 static Lisp_Object preserved_fns;
45 /* Marker used within call-interactively to refer to point. */
46 static Lisp_Object point_marker;
48 /* String for the prompt text used in Fcall_interactively. */
49 static Lisp_Object callint_message;
51 /* ARGSUSED */
52 DEFUN ("interactive", Finteractive, Sinteractive, 0, UNEVALLED, 0,
53 doc: /* Specify a way of parsing arguments for interactive use of a function.
54 For example, write
55 (defun foo (arg buf) "Doc string" (interactive "P\\nbbuffer: ") .... )
56 to make ARG be the raw prefix argument, and set BUF to an existing buffer,
57 when `foo' is called as a command.
58 The "call" to `interactive' is actually a declaration rather than a function;
59 it tells `call-interactively' how to read arguments
60 to pass to the function.
61 When actually called, `interactive' just returns nil.
63 Usually the argument of `interactive' is a string containing a code letter
64 followed optionally by a prompt. (Some code letters do not use I/O to get
65 the argument and do not use prompts.) To get several arguments, concatenate
66 the individual strings, separating them by newline characters.
67 Prompts are passed to format, and may use % escapes to print the
68 arguments that have already been read.
69 If the argument is not a string, it is evaluated to get a list of
70 arguments to pass to the function.
71 Just `(interactive)' means pass no args when calling interactively.
73 Code letters available are:
74 a -- Function name: symbol with a function definition.
75 b -- Name of existing buffer.
76 B -- Name of buffer, possibly nonexistent.
77 c -- Character (no input method is used).
78 C -- Command name: symbol with interactive function definition.
79 d -- Value of point as number. Does not do I/O.
80 D -- Directory name.
81 e -- Parametrized event (i.e., one that's a list) that invoked this command.
82 If used more than once, the Nth `e' returns the Nth parameterized event.
83 This skips events that are integers or symbols.
84 f -- Existing file name.
85 F -- Possibly nonexistent file name.
86 G -- Possibly nonexistent file name, defaulting to just directory name.
87 i -- Ignored, i.e. always nil. Does not do I/O.
88 k -- Key sequence (downcase the last event if needed to get a definition).
89 K -- Key sequence to be redefined (do not downcase the last event).
90 m -- Value of mark as number. Does not do I/O.
91 M -- Any string. Inherits the current input method.
92 n -- Number read using minibuffer.
93 N -- Numeric prefix arg, or if none, do like code `n'.
94 p -- Prefix arg converted to number. Does not do I/O.
95 P -- Prefix arg in raw form. Does not do I/O.
96 r -- Region: point and mark as 2 numeric args, smallest first. Does no I/O.
97 s -- Any string. Does not inherit the current input method.
98 S -- Any symbol.
99 U -- Mouse up event discarded by a previous k or K argument.
100 v -- Variable name: symbol that is user-variable-p.
101 x -- Lisp expression read but not evaluated.
102 X -- Lisp expression read and evaluated.
103 z -- Coding system.
104 Z -- Coding system, nil if no prefix arg.
106 In addition, if the string begins with `*', an error is signaled if
107 the buffer is read-only.
108 If the string begins with `@', Emacs searches the key sequence which
109 invoked the command for its first mouse click (or any other event
110 which specifies a window).
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 (int 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 = Fcar (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, reading 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 int speccount = SPECPDL_INDEX ();
261 /* The index of the next element of this_command_keys to examine for
262 the 'e' interactive code. */
263 int 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 int foo;
276 char prompt1[100];
277 char *tem1;
278 int arg_from_tty = 0;
279 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
280 int key_count;
281 int record_then_fail = 0;
283 Lisp_Object save_this_command, save_last_command;
284 Lisp_Object save_this_original_command, save_real_this_command;
286 save_this_command = Vthis_command;
287 save_this_original_command = Vthis_original_command;
288 save_real_this_command = real_this_command;
289 save_last_command = KVAR (current_kboard, Vlast_command);
291 if (NILP (keys))
292 keys = this_command_keys, key_count = this_command_key_count;
293 else
295 CHECK_VECTOR (keys);
296 key_count = ASIZE (keys);
299 /* Save this now, since use of minibuffer will clobber it. */
300 prefix_arg = Vcurrent_prefix_arg;
302 if (SYMBOLP (function))
303 enable = Fget (function, Qenable_recursive_minibuffers);
304 else
305 enable = Qnil;
307 specs = Qnil;
308 string = 0;
309 /* The idea of FILTER_SPECS is to provide away to
310 specify how to represent the arguments in command history.
311 The feature is not fully implemented. */
312 filter_specs = Qnil;
314 /* If k or K discard an up-event, save it here so it can be retrieved with U */
315 up_event = Qnil;
317 /* Set SPECS to the interactive form, or barf if not interactive. */
319 Lisp_Object form;
320 GCPRO2 (function, prefix_arg);
321 form = Finteractive_form (function);
322 UNGCPRO;
323 if (CONSP (form))
324 specs = filter_specs = Fcar (XCDR (form));
325 else
326 wrong_type_argument (Qcommandp, function);
329 /* If SPECS is set to a string, use it as an interactive prompt. */
330 if (STRINGP (specs))
332 /* Make a copy of string so that if a GC relocates specs,
333 `string' will still be valid. */
334 string = (char *) alloca (SBYTES (specs) + 1);
335 memcpy (string, SSDATA (specs), SBYTES (specs) + 1);
337 else
339 Lisp_Object input;
340 Lisp_Object funval = Findirect_function (function, Qt);
341 size_t events = num_input_events;
342 input = specs;
343 /* Compute the arg values using the user's expression. */
344 GCPRO2 (input, filter_specs);
345 specs = Feval (specs,
346 CONSP (funval) && EQ (Qclosure, XCAR (funval))
347 ? Qt : Qnil);
348 UNGCPRO;
349 if (events != num_input_events || !NILP (record_flag))
351 /* We should record this command on the command history. */
352 Lisp_Object values;
353 Lisp_Object this_cmd;
354 /* Make a copy of the list of values, for the command history,
355 and turn them into things we can eval. */
356 values = quotify_args (Fcopy_sequence (specs));
357 fix_command (input, values);
358 this_cmd = Fcons (function, values);
359 if (history_delete_duplicates)
360 Vcommand_history = Fdelete (this_cmd, Vcommand_history);
361 Vcommand_history = Fcons (this_cmd, Vcommand_history);
363 /* Don't keep command history around forever. */
364 if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
366 teml = Fnthcdr (Vhistory_length, Vcommand_history);
367 if (CONSP (teml))
368 XSETCDR (teml, Qnil);
372 Vthis_command = save_this_command;
373 Vthis_original_command = save_this_original_command;
374 real_this_command= save_real_this_command;
375 KVAR (current_kboard, Vlast_command) = save_last_command;
377 temporarily_switch_to_single_kboard (NULL);
378 return unbind_to (speccount, apply1 (function, specs));
381 /* Here if function specifies a string to control parsing the defaults */
383 /* Set next_event to point to the first event with parameters. */
384 for (next_event = 0; next_event < key_count; next_event++)
385 if (EVENT_HAS_PARAMETERS (AREF (keys, next_event)))
386 break;
388 /* Handle special starting chars `*' and `@'. Also `-'. */
389 /* Note that `+' is reserved for user extensions. */
390 while (1)
392 if (*string == '+')
393 error ("`+' is not used in `interactive' for ordinary commands");
394 else if (*string == '*')
396 string++;
397 if (!NILP (BVAR (current_buffer, read_only)))
399 if (!NILP (record_flag))
401 char *p = string;
402 while (*p)
404 if (! (*p == 'r' || *p == 'p' || *p == 'P'
405 || *p == '\n'))
406 Fbarf_if_buffer_read_only ();
407 p++;
409 record_then_fail = 1;
411 else
412 Fbarf_if_buffer_read_only ();
415 /* Ignore this for semi-compatibility with Lucid. */
416 else if (*string == '-')
417 string++;
418 else if (*string == '@')
420 Lisp_Object event, w;
422 event = (next_event < key_count
423 ? AREF (keys, next_event)
424 : Qnil);
425 if (EVENT_HAS_PARAMETERS (event)
426 && (w = XCDR (event), CONSP (w))
427 && (w = XCAR (w), CONSP (w))
428 && (w = XCAR (w), WINDOWP (w)))
430 if (MINI_WINDOW_P (XWINDOW (w))
431 && ! (minibuf_level > 0 && EQ (w, minibuf_window)))
432 error ("Attempt to select inactive minibuffer window");
434 /* If the current buffer wants to clean up, let it. */
435 Frun_hooks (1, &Qmouse_leave_buffer_hook);
437 Fselect_window (w, Qnil);
439 string++;
441 else if (*string == '^')
443 call0 (Qhandle_shift_selection);
444 string++;
446 else break;
449 /* Count the number of arguments, which is one plus the number of arguments
450 the interactive spec would have us give to the function. */
451 tem = string;
452 for (nargs = 1; *tem; )
454 /* 'r' specifications ("point and mark as 2 numeric args")
455 produce *two* arguments. */
456 if (*tem == 'r')
457 nargs += 2;
458 else
459 nargs++;
460 tem = strchr (tem, '\n');
461 if (tem)
462 ++tem;
463 else
464 break;
467 if (min (MOST_POSITIVE_FIXNUM,
468 min (PTRDIFF_MAX, SIZE_MAX) / sizeof (Lisp_Object))
469 < nargs)
470 memory_full (SIZE_MAX);
472 args = (Lisp_Object *) alloca (nargs * sizeof (Lisp_Object));
473 visargs = (Lisp_Object *) alloca (nargs * sizeof (Lisp_Object));
474 varies = (signed char *) alloca (nargs);
476 for (i = 0; i < nargs; i++)
478 args[i] = Qnil;
479 visargs[i] = Qnil;
480 varies[i] = 0;
483 GCPRO5 (prefix_arg, function, *args, *visargs, up_event);
484 gcpro3.nvars = nargs;
485 gcpro4.nvars = nargs;
487 if (!NILP (enable))
488 specbind (Qenable_recursive_minibuffers, Qt);
490 tem = string;
491 for (i = 1; *tem; i++)
493 strncpy (prompt1, tem + 1, sizeof prompt1 - 1);
494 prompt1[sizeof prompt1 - 1] = 0;
495 tem1 = strchr (prompt1, '\n');
496 if (tem1) *tem1 = 0;
498 visargs[0] = build_string (prompt1);
499 if (strchr (prompt1, '%'))
500 callint_message = Fformat (i, visargs);
501 else
502 callint_message = visargs[0];
504 switch (*tem)
506 case 'a': /* Symbol defined as a function */
507 visargs[i] = Fcompleting_read (callint_message,
508 Vobarray, Qfboundp, Qt,
509 Qnil, Qnil, Qnil, Qnil);
510 /* Passing args[i] directly stimulates compiler bug */
511 teml = visargs[i];
512 args[i] = Fintern (teml, Qnil);
513 break;
515 case 'b': /* Name of existing buffer */
516 args[i] = Fcurrent_buffer ();
517 if (EQ (selected_window, minibuf_window))
518 args[i] = Fother_buffer (args[i], Qnil, Qnil);
519 args[i] = Fread_buffer (callint_message, args[i], Qt);
520 break;
522 case 'B': /* Name of buffer, possibly nonexistent */
523 args[i] = Fread_buffer (callint_message,
524 Fother_buffer (Fcurrent_buffer (), Qnil, Qnil),
525 Qnil);
526 break;
528 case 'c': /* Character */
529 /* Prompt in `minibuffer-prompt' face. */
530 Fput_text_property (make_number (0),
531 make_number (SCHARS (callint_message)),
532 Qface, Qminibuffer_prompt, callint_message);
533 args[i] = Fread_char (callint_message, Qnil, Qnil);
534 message1_nolog ((char *) 0);
535 /* Passing args[i] directly stimulates compiler bug */
536 teml = args[i];
537 visargs[i] = Fchar_to_string (teml);
538 break;
540 case 'C': /* Command: symbol with interactive function */
541 visargs[i] = Fcompleting_read (callint_message,
542 Vobarray, Qcommandp,
543 Qt, Qnil, Qnil, Qnil, Qnil);
544 /* Passing args[i] directly stimulates compiler bug */
545 teml = visargs[i];
546 args[i] = Fintern (teml, Qnil);
547 break;
549 case 'd': /* Value of point. Does not do I/O. */
550 set_marker_both (point_marker, Qnil, PT, PT_BYTE);
551 args[i] = point_marker;
552 /* visargs[i] = Qnil; */
553 varies[i] = 1;
554 break;
556 case 'D': /* Directory name. */
557 args[i] = Fread_file_name (callint_message, Qnil,
558 BVAR (current_buffer, directory), Qlambda, Qnil,
559 Qfile_directory_p);
560 break;
562 case 'f': /* Existing file name. */
563 args[i] = Fread_file_name (callint_message,
564 Qnil, Qnil, Qlambda, Qnil, Qnil);
565 break;
567 case 'F': /* Possibly nonexistent file name. */
568 args[i] = Fread_file_name (callint_message,
569 Qnil, Qnil, Qnil, Qnil, Qnil);
570 break;
572 case 'G': /* Possibly nonexistent file name,
573 default to directory alone. */
574 args[i] = Fread_file_name (callint_message,
575 Qnil, Qnil, Qnil, empty_unibyte_string, Qnil);
576 break;
578 case 'i': /* Ignore an argument -- Does not do I/O */
579 varies[i] = -1;
580 break;
582 case 'k': /* Key sequence. */
584 int speccount1 = SPECPDL_INDEX ();
585 specbind (Qcursor_in_echo_area, Qt);
586 /* Prompt in `minibuffer-prompt' face. */
587 Fput_text_property (make_number (0),
588 make_number (SCHARS (callint_message)),
589 Qface, Qminibuffer_prompt, callint_message);
590 args[i] = Fread_key_sequence (callint_message,
591 Qnil, Qnil, Qnil, Qnil);
592 unbind_to (speccount1, Qnil);
593 teml = args[i];
594 visargs[i] = Fkey_description (teml, Qnil);
596 /* If the key sequence ends with a down-event,
597 discard the following up-event. */
598 teml = Faref (args[i], make_number (XINT (Flength (args[i])) - 1));
599 if (CONSP (teml))
600 teml = XCAR (teml);
601 if (SYMBOLP (teml))
603 Lisp_Object tem2;
605 teml = Fget (teml, intern ("event-symbol-elements"));
606 /* Ignore first element, which is the base key. */
607 tem2 = Fmemq (intern ("down"), Fcdr (teml));
608 if (! NILP (tem2))
609 up_event = Fread_event (Qnil, Qnil, Qnil);
612 break;
614 case 'K': /* Key sequence to be defined. */
616 int speccount1 = SPECPDL_INDEX ();
617 specbind (Qcursor_in_echo_area, Qt);
618 /* Prompt in `minibuffer-prompt' face. */
619 Fput_text_property (make_number (0),
620 make_number (SCHARS (callint_message)),
621 Qface, Qminibuffer_prompt, callint_message);
622 args[i] = Fread_key_sequence (callint_message,
623 Qnil, Qt, Qnil, Qnil);
624 teml = args[i];
625 visargs[i] = Fkey_description (teml, Qnil);
626 unbind_to (speccount1, Qnil);
628 /* If the key sequence ends with a down-event,
629 discard the following up-event. */
630 teml = Faref (args[i], make_number (XINT (Flength (args[i])) - 1));
631 if (CONSP (teml))
632 teml = XCAR (teml);
633 if (SYMBOLP (teml))
635 Lisp_Object tem2;
637 teml = Fget (teml, intern ("event-symbol-elements"));
638 /* Ignore first element, which is the base key. */
639 tem2 = Fmemq (intern ("down"), Fcdr (teml));
640 if (! NILP (tem2))
641 up_event = Fread_event (Qnil, Qnil, Qnil);
644 break;
646 case 'U': /* Up event from last k or K */
647 if (!NILP (up_event))
649 args[i] = Fmake_vector (make_number (1), up_event);
650 up_event = Qnil;
651 teml = args[i];
652 visargs[i] = Fkey_description (teml, Qnil);
654 break;
656 case 'e': /* The invoking event. */
657 if (next_event >= key_count)
658 error ("%s must be bound to an event with parameters",
659 (SYMBOLP (function)
660 ? SSDATA (SYMBOL_NAME (function))
661 : "command"));
662 args[i] = AREF (keys, next_event);
663 next_event++;
664 varies[i] = -1;
666 /* Find the next parameterized event. */
667 while (next_event < key_count
668 && !(EVENT_HAS_PARAMETERS (AREF (keys, next_event))))
669 next_event++;
671 break;
673 case 'm': /* Value of mark. Does not do I/O. */
674 check_mark (0);
675 /* visargs[i] = Qnil; */
676 args[i] = BVAR (current_buffer, mark);
677 varies[i] = 2;
678 break;
680 case 'M': /* String read via minibuffer with
681 inheriting the current input method. */
682 args[i] = Fread_string (callint_message,
683 Qnil, Qnil, Qnil, Qt);
684 break;
686 case 'N': /* Prefix arg as number, else number from minibuffer */
687 if (!NILP (prefix_arg))
688 goto have_prefix_arg;
689 case 'n': /* Read number from minibuffer. */
691 int first = 1;
694 Lisp_Object str;
695 if (! first)
697 message ("Please enter a number.");
698 sit_for (make_number (1), 0, 0);
700 first = 0;
702 str = Fread_from_minibuffer (callint_message,
703 Qnil, Qnil, Qnil, Qnil, Qnil,
704 Qnil);
705 if (! STRINGP (str) || SCHARS (str) == 0)
706 args[i] = Qnil;
707 else
708 args[i] = Fread (str);
710 while (! NUMBERP (args[i]));
712 visargs[i] = args[i];
713 break;
715 case 'P': /* Prefix arg in raw form. Does no I/O. */
716 args[i] = prefix_arg;
717 /* visargs[i] = Qnil; */
718 varies[i] = -1;
719 break;
721 case 'p': /* Prefix arg converted to number. No I/O. */
722 have_prefix_arg:
723 args[i] = Fprefix_numeric_value (prefix_arg);
724 /* visargs[i] = Qnil; */
725 varies[i] = -1;
726 break;
728 case 'r': /* Region, point and mark as 2 args. */
729 check_mark (1);
730 set_marker_both (point_marker, Qnil, PT, PT_BYTE);
731 /* visargs[i+1] = Qnil; */
732 foo = marker_position (BVAR (current_buffer, mark));
733 /* visargs[i] = Qnil; */
734 args[i] = PT < foo ? point_marker : BVAR (current_buffer, mark);
735 varies[i] = 3;
736 args[++i] = PT > foo ? point_marker : BVAR (current_buffer, mark);
737 varies[i] = 4;
738 break;
740 case 's': /* String read via minibuffer without
741 inheriting the current input method. */
742 args[i] = Fread_string (callint_message,
743 Qnil, Qnil, Qnil, Qnil);
744 break;
746 case 'S': /* Any symbol. */
747 visargs[i] = Fread_string (callint_message,
748 Qnil, Qnil, Qnil, Qnil);
749 /* Passing args[i] directly stimulates compiler bug */
750 teml = visargs[i];
751 args[i] = Fintern (teml, Qnil);
752 break;
754 case 'v': /* Variable name: symbol that is
755 user-variable-p. */
756 args[i] = Fread_variable (callint_message, Qnil);
757 visargs[i] = last_minibuf_string;
758 break;
760 case 'x': /* Lisp expression read but not evaluated */
761 args[i] = Fread_minibuffer (callint_message, Qnil);
762 visargs[i] = last_minibuf_string;
763 break;
765 case 'X': /* Lisp expression read and evaluated */
766 args[i] = Feval_minibuffer (callint_message, Qnil);
767 visargs[i] = last_minibuf_string;
768 break;
770 case 'Z': /* Coding-system symbol, or ignore the
771 argument if no prefix */
772 if (NILP (prefix_arg))
774 args[i] = Qnil;
775 varies[i] = -1;
777 else
779 args[i]
780 = Fread_non_nil_coding_system (callint_message);
781 visargs[i] = last_minibuf_string;
783 break;
785 case 'z': /* Coding-system symbol or nil */
786 args[i] = Fread_coding_system (callint_message, Qnil);
787 visargs[i] = last_minibuf_string;
788 break;
790 /* We have a case for `+' so we get an error
791 if anyone tries to define one here. */
792 case '+':
793 default:
794 error ("Invalid control letter `%c' (#o%03o, #x%04x) in interactive calling string",
795 STRING_CHAR ((unsigned char *) tem),
796 (unsigned) STRING_CHAR ((unsigned char *) tem),
797 (unsigned) STRING_CHAR ((unsigned char *) tem));
800 if (varies[i] == 0)
801 arg_from_tty = 1;
803 if (NILP (visargs[i]) && STRINGP (args[i]))
804 visargs[i] = args[i];
806 tem = strchr (tem, '\n');
807 if (tem) tem++;
808 else tem = "";
810 unbind_to (speccount, Qnil);
812 QUIT;
814 args[0] = function;
816 if (arg_from_tty || !NILP (record_flag))
818 visargs[0] = function;
819 for (i = 1; i < nargs; i++)
821 if (varies[i] > 0)
822 visargs[i] = Fcons (intern (callint_argfuns[varies[i]]), Qnil);
823 else
824 visargs[i] = quotify_arg (args[i]);
826 Vcommand_history = Fcons (Flist (nargs, visargs),
827 Vcommand_history);
828 /* Don't keep command history around forever. */
829 if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
831 teml = Fnthcdr (Vhistory_length, Vcommand_history);
832 if (CONSP (teml))
833 XSETCDR (teml, Qnil);
837 /* If we used a marker to hold point, mark, or an end of the region,
838 temporarily, convert it to an integer now. */
839 for (i = 1; i < nargs; i++)
840 if (varies[i] >= 1 && varies[i] <= 4)
841 XSETINT (args[i], marker_position (args[i]));
843 if (record_then_fail)
844 Fbarf_if_buffer_read_only ();
846 Vthis_command = save_this_command;
847 Vthis_original_command = save_this_original_command;
848 real_this_command= save_real_this_command;
849 KVAR (current_kboard, Vlast_command) = save_last_command;
852 Lisp_Object val;
853 specbind (Qcommand_debug_status, Qnil);
855 temporarily_switch_to_single_kboard (NULL);
856 val = Ffuncall (nargs, args);
857 UNGCPRO;
858 return unbind_to (speccount, val);
862 DEFUN ("prefix-numeric-value", Fprefix_numeric_value, Sprefix_numeric_value,
863 1, 1, 0,
864 doc: /* Return numeric meaning of raw prefix argument RAW.
865 A raw prefix argument is what you get from `(interactive "P")'.
866 Its numeric meaning is what you would get from `(interactive "p")'. */)
867 (Lisp_Object raw)
869 Lisp_Object val;
871 if (NILP (raw))
872 XSETFASTINT (val, 1);
873 else if (EQ (raw, Qminus))
874 XSETINT (val, -1);
875 else if (CONSP (raw) && INTEGERP (XCAR (raw)))
876 XSETINT (val, XINT (XCAR (raw)));
877 else if (INTEGERP (raw))
878 val = raw;
879 else
880 XSETFASTINT (val, 1);
882 return val;
885 void
886 syms_of_callint (void)
888 point_marker = Fmake_marker ();
889 staticpro (&point_marker);
891 callint_message = Qnil;
892 staticpro (&callint_message);
894 preserved_fns = pure_cons (intern_c_string ("region-beginning"),
895 pure_cons (intern_c_string ("region-end"),
896 pure_cons (intern_c_string ("point"),
897 pure_cons (intern_c_string ("mark"), Qnil))));
899 Qlist = intern_c_string ("list");
900 staticpro (&Qlist);
901 Qlet = intern_c_string ("let");
902 staticpro (&Qlet);
903 Qif = intern_c_string ("if");
904 staticpro (&Qif);
905 Qwhen = intern_c_string ("when");
906 staticpro (&Qwhen);
907 Qletx = intern_c_string ("let*");
908 staticpro (&Qletx);
909 Qsave_excursion = intern_c_string ("save-excursion");
910 staticpro (&Qsave_excursion);
911 Qprogn = intern_c_string ("progn");
912 staticpro (&Qprogn);
914 Qminus = intern_c_string ("-");
915 staticpro (&Qminus);
917 Qplus = intern_c_string ("+");
918 staticpro (&Qplus);
920 Qhandle_shift_selection = intern_c_string ("handle-shift-selection");
921 staticpro (&Qhandle_shift_selection);
923 Qcall_interactively = intern_c_string ("call-interactively");
924 staticpro (&Qcall_interactively);
926 Qcommand_debug_status = intern_c_string ("command-debug-status");
927 staticpro (&Qcommand_debug_status);
929 Qenable_recursive_minibuffers = intern_c_string ("enable-recursive-minibuffers");
930 staticpro (&Qenable_recursive_minibuffers);
932 Qmouse_leave_buffer_hook = intern_c_string ("mouse-leave-buffer-hook");
933 staticpro (&Qmouse_leave_buffer_hook);
935 DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
936 doc: /* The value of the prefix argument for the next editing command.
937 It may be a number, or the symbol `-' for just a minus sign as arg,
938 or a list whose car is a number for just one or more C-u's
939 or nil if no argument has been specified.
941 You cannot examine this variable to find the argument for this command
942 since it has been set to nil by the time you can look.
943 Instead, you should use the variable `current-prefix-arg', although
944 normally commands can get this prefix argument with (interactive "P"). */);
946 DEFVAR_KBOARD ("last-prefix-arg", Vlast_prefix_arg,
947 doc: /* The value of the prefix argument for the previous editing command.
948 See `prefix-arg' for the meaning of the value. */);
950 DEFVAR_LISP ("current-prefix-arg", Vcurrent_prefix_arg,
951 doc: /* The value of the prefix argument for this editing command.
952 It may be a number, or the symbol `-' for just a minus sign as arg,
953 or a list whose car is a number for just one or more C-u's
954 or nil if no argument has been specified.
955 This is what `(interactive \"P\")' returns. */);
956 Vcurrent_prefix_arg = Qnil;
958 DEFVAR_LISP ("command-history", Vcommand_history,
959 doc: /* List of recent commands that read arguments from terminal.
960 Each command is represented as a form to evaluate.
962 Maximum length of the history list is determined by the value
963 of `history-length', which see. */);
964 Vcommand_history = Qnil;
966 DEFVAR_LISP ("command-debug-status", Vcommand_debug_status,
967 doc: /* Debugging status of current interactive command.
968 Bound each time `call-interactively' is called;
969 may be set by the debugger as a reminder for itself. */);
970 Vcommand_debug_status = Qnil;
972 DEFVAR_LISP ("mark-even-if-inactive", Vmark_even_if_inactive,
973 doc: /* *Non-nil means you can use the mark even when inactive.
974 This option makes a difference in Transient Mark mode.
975 When the option is non-nil, deactivation of the mark
976 turns off region highlighting, but commands that use the mark
977 behave as if the mark were still active. */);
978 Vmark_even_if_inactive = Qt;
980 DEFVAR_LISP ("mouse-leave-buffer-hook", Vmouse_leave_buffer_hook,
981 doc: /* Hook to run when about to switch windows with a mouse command.
982 Its purpose is to give temporary modes such as Isearch mode
983 a way to turn themselves off when a mouse command switches windows. */);
984 Vmouse_leave_buffer_hook = Qnil;
986 defsubr (&Sinteractive);
987 defsubr (&Scall_interactively);
988 defsubr (&Sprefix_numeric_value);