1 /* Call a Lisp function interactively.
2 Copyright (C) 1985-1986, 1993-1995, 1997, 2000-2014 Free Software
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/>. */
24 #include "character.h"
31 Lisp_Object Qminus
, Qplus
;
32 static Lisp_Object Qfuncall_interactively
;
33 static Lisp_Object Qcommand_debug_status
;
34 static Lisp_Object Qenable_recursive_minibuffers
;
36 static Lisp_Object Qhandle_shift_selection
;
37 static Lisp_Object Qread_number
;
39 Lisp_Object Qmouse_leave_buffer_hook
;
41 static Lisp_Object Qlist
, Qlet
, Qletx
, Qsave_excursion
, Qif
;
42 Lisp_Object Qwhen
, Qprogn
;
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
;
52 DEFUN ("interactive", Finteractive
, Sinteractive
, 0, UNEVALLED
, 0,
53 doc
: /* Specify a way of parsing arguments for interactive use of a function.
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.
81 e -- Parameterized 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.
99 U -- Mouse up event discarded by a previous k or K argument.
100 v -- Variable name: symbol that is `custom-variable-p'.
101 x -- Lisp expression read but not evaluated.
102 X -- Lisp expression read and evaluated.
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 `@' appears at the beginning of the string, and if the key sequence
109 used to invoke the command includes any mouse events, then the window
110 associated with the first of those events is selected before the
112 If the string begins with `^' and `shift-select-mode' is non-nil,
113 Emacs first calls the function `handle-shift-selection'.
114 You may use `@', `*', and `^' together. They are processed in the
115 order that they appear, before reading any arguments.
116 usage: (interactive &optional ARGS) */)
122 /* Quotify EXP: if EXP is constant, return it.
123 If EXP is not constant, return (quote EXP). */
125 quotify_arg (register Lisp_Object exp
)
129 && !NILP (exp
) && !EQ (exp
, Qt
)))
130 return list2 (Qquote
, exp
);
135 /* Modify EXP by quotifying each element (except the first). */
137 quotify_args (Lisp_Object exp
)
139 register Lisp_Object tail
;
141 for (tail
= exp
; CONSP (tail
); tail
= next
)
144 XSETCAR (tail
, quotify_arg (XCAR (tail
)));
149 static const char *callint_argfuns
[]
150 = {"", "point", "mark", "region-beginning", "region-end"};
153 check_mark (bool for_region
)
156 tem
= Fmarker_buffer (BVAR (current_buffer
, mark
));
157 if (NILP (tem
) || (XBUFFER (tem
) != current_buffer
))
158 error (for_region
? "The mark is not set now, so there is no region"
159 : "The mark is not set now");
160 if (!NILP (Vtransient_mark_mode
) && NILP (Vmark_even_if_inactive
)
161 && NILP (BVAR (current_buffer
, mark_active
)))
162 xsignal0 (Qmark_inactive
);
165 /* If the list of args INPUT was produced with an explicit call to
166 `list', look for elements that were computed with
167 (region-beginning) or (region-end), and put those expressions into
168 VALUES instead of the present values.
170 This function doesn't return a value because it modifies elements
171 of VALUES to do its job. */
174 fix_command (Lisp_Object input
, Lisp_Object values
)
176 /* FIXME: Instead of this ugly hack, we should provide a way for an
177 interactive spec to return an expression/function that will re-build the
178 args without user intervention. */
184 /* Skip through certain special forms. */
185 while (EQ (car
, Qlet
) || EQ (car
, Qletx
)
186 || EQ (car
, Qsave_excursion
)
189 while (CONSP (XCDR (input
)))
190 input
= XCDR (input
);
191 input
= XCAR (input
);
198 Lisp_Object intail
, valtail
;
199 for (intail
= Fcdr (input
), valtail
= values
;
201 intail
= Fcdr (intail
), valtail
= XCDR (valtail
))
207 Lisp_Object presflag
, carelt
;
209 /* If it is (if X Y), look at Y. */
211 && EQ (Fnthcdr (make_number (3), elt
), Qnil
))
212 elt
= Fnth (make_number (2), elt
);
213 /* If it is (when ... Y), look at Y. */
214 else if (EQ (carelt
, Qwhen
))
216 while (CONSP (XCDR (elt
)))
221 /* If the function call we're looking at
222 is a special preserved one, copy the
223 whole expression for this argument. */
226 presflag
= Fmemq (Fcar (elt
), preserved_fns
);
227 if (!NILP (presflag
))
228 Fsetcar (valtail
, Fcar (intail
));
236 /* Helper function to call `read-file-name' from C. */
239 read_file_name (Lisp_Object default_filename
, Lisp_Object mustmatch
,
240 Lisp_Object initial
, Lisp_Object predicate
)
245 GCPRO1 (default_filename
);
246 args
[0] = intern ("read-file-name");
247 args
[1] = callint_message
;
249 args
[3] = default_filename
;
253 RETURN_UNGCPRO (Ffuncall (7, args
));
256 /* BEWARE: Calling this directly from C would defeat the purpose! */
257 DEFUN ("funcall-interactively", Ffuncall_interactively
, Sfuncall_interactively
,
258 1, MANY
, 0, doc
: /* Like `funcall' but marks the call as interactive.
259 I.e. arrange that within the called function `called-interactively-p' will
261 usage: (funcall-interactively FUNCTION &rest ARGUMENTS) */)
262 (ptrdiff_t nargs
, Lisp_Object
*args
)
264 ptrdiff_t speccount
= SPECPDL_INDEX ();
265 temporarily_switch_to_single_kboard (NULL
);
267 /* Nothing special to do here, all the work is inside
268 `called-interactively-p'. Which will look for us as a marker in the
270 return unbind_to (speccount
, Ffuncall (nargs
, args
));
273 DEFUN ("call-interactively", Fcall_interactively
, Scall_interactively
, 1, 3, 0,
274 doc
: /* Call FUNCTION, providing args according to its interactive calling specs.
275 Return the value FUNCTION returns.
276 The function contains a specification of how to do the argument reading.
277 In the case of user-defined functions, this is specified by placing a call
278 to the function `interactive' at the top level of the function body.
281 Optional second arg RECORD-FLAG non-nil
282 means unconditionally put this command in the command-history.
283 Otherwise, this is done only if an arg is read using the minibuffer.
285 Optional third arg KEYS, if given, specifies the sequence of events to
286 supply, as a vector, if the command inquires which events were used to
287 invoke it. If KEYS is omitted or nil, the return value of
288 `this-command-keys-vector' is used. */)
289 (Lisp_Object function
, Lisp_Object record_flag
, Lisp_Object keys
)
291 /* `args' will contain the array of arguments to pass to the function.
292 `visargs' will contain the same list but in a nicer form, so that if we
293 pass it to `Fformat' it will be understandable to a human. */
294 Lisp_Object
*args
, *visargs
;
296 Lisp_Object filter_specs
;
298 Lisp_Object up_event
;
302 /* The index of the next element of this_command_keys to examine for
303 the 'e' interactive code. */
304 ptrdiff_t next_event
;
306 Lisp_Object prefix_arg
;
310 /* If varies[i] > 0, the i'th argument shouldn't just have its value
311 in this call quoted in the command history. It should be
312 recorded as a call to the function named callint_argfuns[varies[i]]. */
317 bool arg_from_tty
= 0;
318 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
320 bool record_then_fail
= 0;
322 Lisp_Object save_this_command
, save_last_command
;
323 Lisp_Object save_this_original_command
, save_real_this_command
;
325 save_this_command
= Vthis_command
;
326 save_this_original_command
= Vthis_original_command
;
327 save_real_this_command
= Vreal_this_command
;
328 save_last_command
= KVAR (current_kboard
, Vlast_command
);
331 keys
= this_command_keys
, key_count
= this_command_key_count
;
335 key_count
= ASIZE (keys
);
338 /* Save this now, since use of minibuffer will clobber it. */
339 prefix_arg
= Vcurrent_prefix_arg
;
341 if (SYMBOLP (function
))
342 enable
= Fget (function
, Qenable_recursive_minibuffers
);
348 /* The idea of FILTER_SPECS is to provide a way to
349 specify how to represent the arguments in command history.
350 The feature is not fully implemented. */
353 /* If k or K discard an up-event, save it here so it can be retrieved with
357 /* Set SPECS to the interactive form, or barf if not interactive. */
360 GCPRO2 (function
, prefix_arg
);
361 form
= Finteractive_form (function
);
364 specs
= filter_specs
= Fcar (XCDR (form
));
366 wrong_type_argument (Qcommandp
, function
);
369 /* If SPECS is set to a string, use it as an interactive prompt. */
371 /* Make a copy of string so that if a GC relocates specs,
372 `string' will still be valid. */
373 string
= xlispstrdupa (specs
);
377 Lisp_Object funval
= Findirect_function (function
, Qt
);
378 uintmax_t events
= num_input_events
;
380 /* Compute the arg values using the user's expression. */
381 GCPRO2 (input
, filter_specs
);
382 specs
= Feval (specs
,
383 CONSP (funval
) && EQ (Qclosure
, XCAR (funval
))
384 ? CAR_SAFE (XCDR (funval
)) : Qnil
);
386 if (events
!= num_input_events
|| !NILP (record_flag
))
388 /* We should record this command on the command history. */
390 Lisp_Object this_cmd
;
391 /* Make a copy of the list of values, for the command history,
392 and turn them into things we can eval. */
393 values
= quotify_args (Fcopy_sequence (specs
));
394 fix_command (input
, values
);
395 this_cmd
= Fcons (function
, values
);
396 if (history_delete_duplicates
)
397 Vcommand_history
= Fdelete (this_cmd
, Vcommand_history
);
398 Vcommand_history
= Fcons (this_cmd
, Vcommand_history
);
400 /* Don't keep command history around forever. */
401 if (INTEGERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
403 teml
= Fnthcdr (Vhistory_length
, Vcommand_history
);
405 XSETCDR (teml
, Qnil
);
409 Vthis_command
= save_this_command
;
410 Vthis_original_command
= save_this_original_command
;
411 Vreal_this_command
= save_real_this_command
;
412 kset_last_command (current_kboard
, save_last_command
);
415 Lisp_Object tem0
, args
[3];
416 args
[0] = Qfuncall_interactively
;
419 tem0
= Fapply (3, args
);
425 /* Here if function specifies a string to control parsing the defaults. */
427 /* Set next_event to point to the first event with parameters. */
428 for (next_event
= 0; next_event
< key_count
; next_event
++)
429 if (EVENT_HAS_PARAMETERS (AREF (keys
, next_event
)))
432 /* Handle special starting chars `*' and `@'. Also `-'. */
433 /* Note that `+' is reserved for user extensions. */
437 error ("`+' is not used in `interactive' for ordinary commands");
438 else if (*string
== '*')
441 if (!NILP (BVAR (current_buffer
, read_only
)))
443 if (!NILP (record_flag
))
448 if (! (*p
== 'r' || *p
== 'p' || *p
== 'P'
450 Fbarf_if_buffer_read_only ();
453 record_then_fail
= 1;
456 Fbarf_if_buffer_read_only ();
459 /* Ignore this for semi-compatibility with Lucid. */
460 else if (*string
== '-')
462 else if (*string
== '@')
464 Lisp_Object event
, w
;
466 event
= (next_event
< key_count
467 ? AREF (keys
, next_event
)
469 if (EVENT_HAS_PARAMETERS (event
)
470 && (w
= XCDR (event
), CONSP (w
))
471 && (w
= XCAR (w
), CONSP (w
))
472 && (w
= XCAR (w
), WINDOWP (w
)))
474 if (MINI_WINDOW_P (XWINDOW (w
))
475 && ! (minibuf_level
> 0 && EQ (w
, minibuf_window
)))
476 error ("Attempt to select inactive minibuffer window");
478 /* If the current buffer wants to clean up, let it. */
479 Frun_hooks (1, &Qmouse_leave_buffer_hook
);
481 Fselect_window (w
, Qnil
);
485 else if (*string
== '^')
487 call0 (Qhandle_shift_selection
);
493 /* Count the number of arguments, which is two (the function itself and
494 `funcall-interactively') plus the number of arguments the interactive spec
495 would have us give to the function. */
497 for (nargs
= 2; *tem
; )
499 /* 'r' specifications ("point and mark as 2 numeric args")
500 produce *two* arguments. */
505 tem
= strchr (tem
, '\n');
512 if (min (MOST_POSITIVE_FIXNUM
,
513 min (PTRDIFF_MAX
, SIZE_MAX
) / word_size
)
515 memory_full (SIZE_MAX
);
517 args
= alloca (nargs
* sizeof *args
);
518 visargs
= alloca (nargs
* sizeof *visargs
);
519 varies
= alloca (nargs
* sizeof *varies
);
521 for (i
= 0; i
< nargs
; i
++)
528 GCPRO5 (prefix_arg
, function
, *args
, *visargs
, up_event
);
529 gcpro3
.nvars
= nargs
;
530 gcpro4
.nvars
= nargs
;
533 specbind (Qenable_recursive_minibuffers
, Qt
);
536 for (i
= 2; *tem
; i
++)
538 visargs
[1] = make_string (tem
+ 1, strcspn (tem
+ 1, "\n"));
539 if (strchr (SSDATA (visargs
[1]), '%'))
540 callint_message
= Fformat (i
- 1, visargs
+ 1);
542 callint_message
= visargs
[1];
546 case 'a': /* Symbol defined as a function. */
547 visargs
[i
] = Fcompleting_read (callint_message
,
548 Vobarray
, Qfboundp
, Qt
,
549 Qnil
, Qnil
, Qnil
, Qnil
);
550 /* Passing args[i] directly stimulates compiler bug. */
552 args
[i
] = Fintern (teml
, Qnil
);
555 case 'b': /* Name of existing buffer. */
556 args
[i
] = Fcurrent_buffer ();
557 if (EQ (selected_window
, minibuf_window
))
558 args
[i
] = Fother_buffer (args
[i
], Qnil
, Qnil
);
559 args
[i
] = Fread_buffer (callint_message
, args
[i
], Qt
);
562 case 'B': /* Name of buffer, possibly nonexistent. */
563 args
[i
] = Fread_buffer (callint_message
,
564 Fother_buffer (Fcurrent_buffer (), Qnil
, Qnil
),
568 case 'c': /* Character. */
569 /* Prompt in `minibuffer-prompt' face. */
570 Fput_text_property (make_number (0),
571 make_number (SCHARS (callint_message
)),
572 Qface
, Qminibuffer_prompt
, callint_message
);
573 args
[i
] = Fread_char (callint_message
, Qnil
, Qnil
);
575 /* Passing args[i] directly stimulates compiler bug. */
578 if (! CHARACTERP (teml
)) error ("Non-character input-event");
579 visargs
[i
] = Fchar_to_string (teml
);
582 case 'C': /* Command: symbol with interactive function. */
583 visargs
[i
] = Fcompleting_read (callint_message
,
585 Qt
, Qnil
, Qnil
, Qnil
, Qnil
);
586 /* Passing args[i] directly stimulates compiler bug. */
588 args
[i
] = Fintern (teml
, Qnil
);
591 case 'd': /* Value of point. Does not do I/O. */
592 set_marker_both (point_marker
, Qnil
, PT
, PT_BYTE
);
593 args
[i
] = point_marker
;
594 /* visargs[i] = Qnil; */
598 case 'D': /* Directory name. */
599 args
[i
] = read_file_name (BVAR (current_buffer
, directory
), Qlambda
, Qnil
,
603 case 'f': /* Existing file name. */
604 args
[i
] = read_file_name (Qnil
, Qlambda
, Qnil
, Qnil
);
607 case 'F': /* Possibly nonexistent file name. */
608 args
[i
] = read_file_name (Qnil
, Qnil
, Qnil
, Qnil
);
611 case 'G': /* Possibly nonexistent file name,
612 default to directory alone. */
613 args
[i
] = read_file_name (Qnil
, Qnil
, empty_unibyte_string
, Qnil
);
616 case 'i': /* Ignore an argument -- Does not do I/O. */
620 case 'k': /* Key sequence. */
623 specbind (Qcursor_in_echo_area
, Qt
);
624 /* Prompt in `minibuffer-prompt' face. */
625 Fput_text_property (make_number (0),
626 make_number (SCHARS (callint_message
)),
627 Qface
, Qminibuffer_prompt
, callint_message
);
628 args
[i
] = Fread_key_sequence (callint_message
,
629 Qnil
, Qnil
, Qnil
, Qnil
);
632 visargs
[i
] = Fkey_description (teml
, Qnil
);
634 /* If the key sequence ends with a down-event,
635 discard the following up-event. */
636 teml
= Faref (args
[i
], make_number (XINT (Flength (args
[i
])) - 1));
643 teml
= Fget (teml
, intern ("event-symbol-elements"));
644 /* Ignore first element, which is the base key. */
645 tem2
= Fmemq (intern ("down"), Fcdr (teml
));
647 up_event
= Fread_event (Qnil
, Qnil
, Qnil
);
652 case 'K': /* Key sequence to be defined. */
655 specbind (Qcursor_in_echo_area
, Qt
);
656 /* Prompt in `minibuffer-prompt' face. */
657 Fput_text_property (make_number (0),
658 make_number (SCHARS (callint_message
)),
659 Qface
, Qminibuffer_prompt
, callint_message
);
660 args
[i
] = Fread_key_sequence_vector (callint_message
,
661 Qnil
, Qt
, Qnil
, Qnil
);
663 visargs
[i
] = Fkey_description (teml
, Qnil
);
666 /* If the key sequence ends with a down-event,
667 discard the following up-event. */
668 teml
= Faref (args
[i
], make_number (XINT (Flength (args
[i
])) - 1));
675 teml
= Fget (teml
, intern ("event-symbol-elements"));
676 /* Ignore first element, which is the base key. */
677 tem2
= Fmemq (intern ("down"), Fcdr (teml
));
679 up_event
= Fread_event (Qnil
, Qnil
, Qnil
);
684 case 'U': /* Up event from last k or K. */
685 if (!NILP (up_event
))
687 args
[i
] = Fmake_vector (make_number (1), up_event
);
690 visargs
[i
] = Fkey_description (teml
, Qnil
);
694 case 'e': /* The invoking event. */
695 if (next_event
>= key_count
)
696 error ("%s must be bound to an event with parameters",
698 ? SSDATA (SYMBOL_NAME (function
))
700 args
[i
] = AREF (keys
, next_event
);
704 /* Find the next parameterized event. */
705 while (next_event
< key_count
706 && !(EVENT_HAS_PARAMETERS (AREF (keys
, next_event
))))
711 case 'm': /* Value of mark. Does not do I/O. */
713 /* visargs[i] = Qnil; */
714 args
[i
] = BVAR (current_buffer
, mark
);
718 case 'M': /* String read via minibuffer with
719 inheriting the current input method. */
720 args
[i
] = Fread_string (callint_message
,
721 Qnil
, Qnil
, Qnil
, Qt
);
724 case 'N': /* Prefix arg as number, else number from minibuffer. */
725 if (!NILP (prefix_arg
))
726 goto have_prefix_arg
;
727 case 'n': /* Read number from minibuffer. */
728 args
[i
] = call1 (Qread_number
, callint_message
);
729 /* Passing args[i] directly stimulates compiler bug. */
731 visargs
[i
] = Fnumber_to_string (teml
);
734 case 'P': /* Prefix arg in raw form. Does no I/O. */
735 args
[i
] = prefix_arg
;
736 /* visargs[i] = Qnil; */
740 case 'p': /* Prefix arg converted to number. No I/O. */
742 args
[i
] = Fprefix_numeric_value (prefix_arg
);
743 /* visargs[i] = Qnil; */
747 case 'r': /* Region, point and mark as 2 args. */
749 set_marker_both (point_marker
, Qnil
, PT
, PT_BYTE
);
750 /* visargs[i+1] = Qnil; */
751 mark
= marker_position (BVAR (current_buffer
, mark
));
752 /* visargs[i] = Qnil; */
753 args
[i
] = PT
< mark
? point_marker
: BVAR (current_buffer
, mark
);
755 args
[++i
] = PT
> mark
? point_marker
: BVAR (current_buffer
, mark
);
759 case 's': /* String read via minibuffer without
760 inheriting the current input method. */
761 args
[i
] = Fread_string (callint_message
,
762 Qnil
, Qnil
, Qnil
, Qnil
);
765 case 'S': /* Any symbol. */
766 visargs
[i
] = Fread_string (callint_message
,
767 Qnil
, Qnil
, Qnil
, Qnil
);
768 /* Passing args[i] directly stimulates compiler bug. */
770 args
[i
] = Fintern (teml
, Qnil
);
773 case 'v': /* Variable name: symbol that is
774 custom-variable-p. */
775 args
[i
] = Fread_variable (callint_message
, Qnil
);
776 visargs
[i
] = last_minibuf_string
;
779 case 'x': /* Lisp expression read but not evaluated. */
780 args
[i
] = call1 (intern ("read-minibuffer"), callint_message
);
781 visargs
[i
] = last_minibuf_string
;
784 case 'X': /* Lisp expression read and evaluated. */
785 args
[i
] = call1 (intern ("eval-minibuffer"), callint_message
);
786 visargs
[i
] = last_minibuf_string
;
789 case 'Z': /* Coding-system symbol, or ignore the
790 argument if no prefix. */
791 if (NILP (prefix_arg
))
799 = Fread_non_nil_coding_system (callint_message
);
800 visargs
[i
] = last_minibuf_string
;
804 case 'z': /* Coding-system symbol or nil. */
805 args
[i
] = Fread_coding_system (callint_message
, Qnil
);
806 visargs
[i
] = last_minibuf_string
;
809 /* We have a case for `+' so we get an error
810 if anyone tries to define one here. */
813 error ("Invalid control letter `%c' (#o%03o, #x%04x) in interactive calling string",
814 STRING_CHAR ((unsigned char *) tem
),
815 (unsigned) STRING_CHAR ((unsigned char *) tem
),
816 (unsigned) STRING_CHAR ((unsigned char *) tem
));
822 if (NILP (visargs
[i
]) && STRINGP (args
[i
]))
823 visargs
[i
] = args
[i
];
825 tem
= strchr (tem
, '\n');
833 args
[0] = Qfuncall_interactively
;
836 if (arg_from_tty
|| !NILP (record_flag
))
838 /* We don't need `visargs' any more, so let's recycle it since we need
839 an array of just the same size. */
840 visargs
[1] = function
;
841 for (i
= 2; i
< nargs
; i
++)
844 visargs
[i
] = list1 (intern (callint_argfuns
[varies
[i
]]));
846 visargs
[i
] = quotify_arg (args
[i
]);
848 Vcommand_history
= Fcons (Flist (nargs
- 1, visargs
+ 1),
850 /* Don't keep command history around forever. */
851 if (INTEGERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
853 teml
= Fnthcdr (Vhistory_length
, Vcommand_history
);
855 XSETCDR (teml
, Qnil
);
859 /* If we used a marker to hold point, mark, or an end of the region,
860 temporarily, convert it to an integer now. */
861 for (i
= 2; i
< nargs
; i
++)
862 if (varies
[i
] >= 1 && varies
[i
] <= 4)
863 XSETINT (args
[i
], marker_position (args
[i
]));
865 if (record_then_fail
)
866 Fbarf_if_buffer_read_only ();
868 Vthis_command
= save_this_command
;
869 Vthis_original_command
= save_this_original_command
;
870 Vreal_this_command
= save_real_this_command
;
871 kset_last_command (current_kboard
, save_last_command
);
874 Lisp_Object val
= Ffuncall (nargs
, args
);
881 DEFUN ("prefix-numeric-value", Fprefix_numeric_value
, Sprefix_numeric_value
,
883 doc
: /* Return numeric meaning of raw prefix argument RAW.
884 A raw prefix argument is what you get from `(interactive "P")'.
885 Its numeric meaning is what you would get from `(interactive "p")'. */)
891 XSETFASTINT (val
, 1);
892 else if (EQ (raw
, Qminus
))
894 else if (CONSP (raw
) && INTEGERP (XCAR (raw
)))
895 XSETINT (val
, XINT (XCAR (raw
)));
896 else if (INTEGERP (raw
))
899 XSETFASTINT (val
, 1);
905 syms_of_callint (void)
909 point_marker
= Fmake_marker ();
910 staticpro (&point_marker
);
912 callint_message
= Qnil
;
913 staticpro (&callint_message
);
915 preserved_fns
= listn (CONSTYPE_PURE
, 4,
916 intern_c_string ("region-beginning"),
917 intern_c_string ("region-end"),
918 intern_c_string ("point"),
919 intern_c_string ("mark"));
921 DEFSYM (Qlist
, "list");
922 DEFSYM (Qlet
, "let");
924 DEFSYM (Qwhen
, "when");
925 DEFSYM (Qletx
, "let*");
926 DEFSYM (Qsave_excursion
, "save-excursion");
927 DEFSYM (Qprogn
, "progn");
928 DEFSYM (Qminus
, "-");
930 DEFSYM (Qhandle_shift_selection
, "handle-shift-selection");
931 DEFSYM (Qread_number
, "read-number");
932 DEFSYM (Qfuncall_interactively
, "funcall-interactively");
933 DEFSYM (Qcommand_debug_status
, "command-debug-status");
934 DEFSYM (Qenable_recursive_minibuffers
, "enable-recursive-minibuffers");
935 DEFSYM (Qmouse_leave_buffer_hook
, "mouse-leave-buffer-hook");
937 DEFVAR_KBOARD ("prefix-arg", Vprefix_arg
,
938 doc
: /* The value of the prefix argument for the next editing command.
939 It may be a number, or the symbol `-' for just a minus sign as arg,
940 or a list whose car is a number for just one or more C-u's
941 or nil if no argument has been specified.
943 You cannot examine this variable to find the argument for this command
944 since it has been set to nil by the time you can look.
945 Instead, you should use the variable `current-prefix-arg', although
946 normally commands can get this prefix argument with (interactive "P"). */);
948 DEFVAR_KBOARD ("last-prefix-arg", Vlast_prefix_arg
,
949 doc
: /* The value of the prefix argument for the previous editing command.
950 See `prefix-arg' for the meaning of the value. */);
952 DEFVAR_LISP ("current-prefix-arg", Vcurrent_prefix_arg
,
953 doc
: /* The value of the prefix argument for this editing command.
954 It may be a number, or the symbol `-' for just a minus sign as arg,
955 or a list whose car is a number for just one or more C-u's
956 or nil if no argument has been specified.
957 This is what `(interactive \"P\")' returns. */);
958 Vcurrent_prefix_arg
= Qnil
;
960 DEFVAR_LISP ("command-history", Vcommand_history
,
961 doc
: /* List of recent commands that read arguments from terminal.
962 Each command is represented as a form to evaluate.
964 Maximum length of the history list is determined by the value
965 of `history-length', which see. */);
966 Vcommand_history
= Qnil
;
968 DEFVAR_LISP ("command-debug-status", Vcommand_debug_status
,
969 doc
: /* Debugging status of current interactive command.
970 Bound each time `call-interactively' is called;
971 may be set by the debugger as a reminder for itself. */);
972 Vcommand_debug_status
= Qnil
;
974 DEFVAR_LISP ("mark-even-if-inactive", Vmark_even_if_inactive
,
975 doc
: /* Non-nil means you can use the mark even when inactive.
976 This option makes a difference in Transient Mark mode.
977 When the option is non-nil, deactivation of the mark
978 turns off region highlighting, but commands that use the mark
979 behave as if the mark were still active. */);
980 Vmark_even_if_inactive
= Qt
;
982 DEFVAR_LISP ("mouse-leave-buffer-hook", Vmouse_leave_buffer_hook
,
983 doc
: /* Hook to run when about to switch windows with a mouse command.
984 Its purpose is to give temporary modes such as Isearch mode
985 a way to turn themselves off when a mouse command switches windows. */);
986 Vmouse_leave_buffer_hook
= Qnil
;