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
)
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 Lisp_Object tem
= Ffuncall (nargs
, args
);
275 DEFUN ("call-interactively", Fcall_interactively
, Scall_interactively
, 1, 3, 0,
276 doc
: /* Call FUNCTION, providing args according to its interactive calling specs.
277 Return the value FUNCTION returns.
278 The function contains a specification of how to do the argument reading.
279 In the case of user-defined functions, this is specified by placing a call
280 to the function `interactive' at the top level of the function body.
283 Optional second arg RECORD-FLAG non-nil
284 means unconditionally put this command in the command-history.
285 Otherwise, this is done only if an arg is read using the minibuffer.
287 Optional third arg KEYS, if given, specifies the sequence of events to
288 supply, as a vector, if the command inquires which events were used to
289 invoke it. If KEYS is omitted or nil, the return value of
290 `this-command-keys-vector' is used. */)
291 (Lisp_Object function
, Lisp_Object record_flag
, Lisp_Object keys
)
293 /* `args' will contain the array of arguments to pass to the function.
294 `visargs' will contain the same list but in a nicer form, so that if we
295 pass it to `Fformat' it will be understandable to a human. */
296 Lisp_Object
*args
, *visargs
;
298 Lisp_Object filter_specs
;
300 Lisp_Object up_event
;
304 /* The index of the next element of this_command_keys to examine for
305 the 'e' interactive code. */
306 ptrdiff_t next_event
;
308 Lisp_Object prefix_arg
;
312 /* If varies[i] > 0, the i'th argument shouldn't just have its value
313 in this call quoted in the command history. It should be
314 recorded as a call to the function named callint_argfuns[varies[i]]. */
319 bool arg_from_tty
= 0;
320 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
322 bool record_then_fail
= 0;
324 Lisp_Object save_this_command
, save_last_command
;
325 Lisp_Object save_this_original_command
, save_real_this_command
;
327 save_this_command
= Vthis_command
;
328 save_this_original_command
= Vthis_original_command
;
329 save_real_this_command
= Vreal_this_command
;
330 save_last_command
= KVAR (current_kboard
, Vlast_command
);
333 keys
= this_command_keys
, key_count
= this_command_key_count
;
337 key_count
= ASIZE (keys
);
340 /* Save this now, since use of minibuffer will clobber it. */
341 prefix_arg
= Vcurrent_prefix_arg
;
343 if (SYMBOLP (function
))
344 enable
= Fget (function
, Qenable_recursive_minibuffers
);
350 /* The idea of FILTER_SPECS is to provide a way to
351 specify how to represent the arguments in command history.
352 The feature is not fully implemented. */
355 /* If k or K discard an up-event, save it here so it can be retrieved with
359 /* Set SPECS to the interactive form, or barf if not interactive. */
362 GCPRO2 (function
, prefix_arg
);
363 form
= Finteractive_form (function
);
366 specs
= filter_specs
= Fcar (XCDR (form
));
368 wrong_type_argument (Qcommandp
, function
);
371 /* If SPECS is set to a string, use it as an interactive prompt. */
373 /* Make a copy of string so that if a GC relocates specs,
374 `string' will still be valid. */
375 string
= xlispstrdupa (specs
);
379 Lisp_Object funval
= Findirect_function (function
, Qt
);
380 uintmax_t events
= num_input_events
;
382 /* Compute the arg values using the user's expression. */
383 GCPRO2 (input
, filter_specs
);
384 specs
= Feval (specs
,
385 CONSP (funval
) && EQ (Qclosure
, XCAR (funval
))
386 ? CAR_SAFE (XCDR (funval
)) : Qnil
);
388 if (events
!= num_input_events
|| !NILP (record_flag
))
390 /* We should record this command on the command history. */
392 Lisp_Object this_cmd
;
393 /* Make a copy of the list of values, for the command history,
394 and turn them into things we can eval. */
395 values
= quotify_args (Fcopy_sequence (specs
));
396 fix_command (input
, values
);
397 this_cmd
= Fcons (function
, values
);
398 if (history_delete_duplicates
)
399 Vcommand_history
= Fdelete (this_cmd
, Vcommand_history
);
400 Vcommand_history
= Fcons (this_cmd
, Vcommand_history
);
402 /* Don't keep command history around forever. */
403 if (INTEGERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
405 teml
= Fnthcdr (Vhistory_length
, Vcommand_history
);
407 XSETCDR (teml
, Qnil
);
411 Vthis_command
= save_this_command
;
412 Vthis_original_command
= save_this_original_command
;
413 Vreal_this_command
= save_real_this_command
;
414 kset_last_command (current_kboard
, save_last_command
);
417 Lisp_Object tem0
, args
[3];
418 args
[0] = Qfuncall_interactively
;
421 tem0
= Fapply (3, args
);
427 /* Here if function specifies a string to control parsing the defaults. */
429 /* Set next_event to point to the first event with parameters. */
430 for (next_event
= 0; next_event
< key_count
; next_event
++)
431 if (EVENT_HAS_PARAMETERS (AREF (keys
, next_event
)))
434 /* Handle special starting chars `*' and `@'. Also `-'. */
435 /* Note that `+' is reserved for user extensions. */
439 error ("`+' is not used in `interactive' for ordinary commands");
440 else if (*string
== '*')
443 if (!NILP (BVAR (current_buffer
, read_only
)))
445 if (!NILP (record_flag
))
450 if (! (*p
== 'r' || *p
== 'p' || *p
== 'P'
452 Fbarf_if_buffer_read_only ();
455 record_then_fail
= 1;
458 Fbarf_if_buffer_read_only ();
461 /* Ignore this for semi-compatibility with Lucid. */
462 else if (*string
== '-')
464 else if (*string
== '@')
466 Lisp_Object event
, w
;
468 event
= (next_event
< key_count
469 ? AREF (keys
, next_event
)
471 if (EVENT_HAS_PARAMETERS (event
)
472 && (w
= XCDR (event
), CONSP (w
))
473 && (w
= XCAR (w
), CONSP (w
))
474 && (w
= XCAR (w
), WINDOWP (w
)))
476 if (MINI_WINDOW_P (XWINDOW (w
))
477 && ! (minibuf_level
> 0 && EQ (w
, minibuf_window
)))
478 error ("Attempt to select inactive minibuffer window");
480 /* If the current buffer wants to clean up, let it. */
481 Frun_hooks (1, &Qmouse_leave_buffer_hook
);
483 Fselect_window (w
, Qnil
);
487 else if (*string
== '^')
489 call0 (Qhandle_shift_selection
);
495 /* Count the number of arguments, which is two (the function itself and
496 `funcall-interactively') plus the number of arguments the interactive spec
497 would have us give to the function. */
499 for (nargs
= 2; *tem
; )
501 /* 'r' specifications ("point and mark as 2 numeric args")
502 produce *two* arguments. */
507 tem
= strchr (tem
, '\n');
514 if (min (MOST_POSITIVE_FIXNUM
,
515 min (PTRDIFF_MAX
, SIZE_MAX
) / word_size
)
517 memory_full (SIZE_MAX
);
519 args
= alloca (nargs
* sizeof *args
);
520 visargs
= alloca (nargs
* sizeof *visargs
);
521 varies
= alloca (nargs
* sizeof *varies
);
523 for (i
= 0; i
< nargs
; i
++)
530 GCPRO5 (prefix_arg
, function
, *args
, *visargs
, up_event
);
531 gcpro3
.nvars
= nargs
;
532 gcpro4
.nvars
= nargs
;
535 specbind (Qenable_recursive_minibuffers
, Qt
);
538 for (i
= 2; *tem
; i
++)
540 visargs
[1] = make_string (tem
+ 1, strcspn (tem
+ 1, "\n"));
541 if (strchr (SSDATA (visargs
[1]), '%'))
542 callint_message
= Fformat (i
- 1, visargs
+ 1);
544 callint_message
= visargs
[1];
548 case 'a': /* Symbol defined as a function. */
549 visargs
[i
] = Fcompleting_read (callint_message
,
550 Vobarray
, Qfboundp
, Qt
,
551 Qnil
, Qnil
, Qnil
, Qnil
);
552 /* Passing args[i] directly stimulates compiler bug. */
554 args
[i
] = Fintern (teml
, Qnil
);
557 case 'b': /* Name of existing buffer. */
558 args
[i
] = Fcurrent_buffer ();
559 if (EQ (selected_window
, minibuf_window
))
560 args
[i
] = Fother_buffer (args
[i
], Qnil
, Qnil
);
561 args
[i
] = Fread_buffer (callint_message
, args
[i
], Qt
);
564 case 'B': /* Name of buffer, possibly nonexistent. */
565 args
[i
] = Fread_buffer (callint_message
,
566 Fother_buffer (Fcurrent_buffer (), Qnil
, Qnil
),
570 case 'c': /* Character. */
571 /* Prompt in `minibuffer-prompt' face. */
572 Fput_text_property (make_number (0),
573 make_number (SCHARS (callint_message
)),
574 Qface
, Qminibuffer_prompt
, callint_message
);
575 args
[i
] = Fread_char (callint_message
, Qnil
, Qnil
);
577 /* Passing args[i] directly stimulates compiler bug. */
580 if (! CHARACTERP (teml
)) error ("Non-character input-event");
581 visargs
[i
] = Fchar_to_string (teml
);
584 case 'C': /* Command: symbol with interactive function. */
585 visargs
[i
] = Fcompleting_read (callint_message
,
587 Qt
, Qnil
, Qnil
, Qnil
, Qnil
);
588 /* Passing args[i] directly stimulates compiler bug. */
590 args
[i
] = Fintern (teml
, Qnil
);
593 case 'd': /* Value of point. Does not do I/O. */
594 set_marker_both (point_marker
, Qnil
, PT
, PT_BYTE
);
595 args
[i
] = point_marker
;
596 /* visargs[i] = Qnil; */
600 case 'D': /* Directory name. */
601 args
[i
] = read_file_name (BVAR (current_buffer
, directory
), Qlambda
, Qnil
,
605 case 'f': /* Existing file name. */
606 args
[i
] = read_file_name (Qnil
, Qlambda
, Qnil
, Qnil
);
609 case 'F': /* Possibly nonexistent file name. */
610 args
[i
] = read_file_name (Qnil
, Qnil
, Qnil
, Qnil
);
613 case 'G': /* Possibly nonexistent file name,
614 default to directory alone. */
615 args
[i
] = read_file_name (Qnil
, Qnil
, empty_unibyte_string
, Qnil
);
618 case 'i': /* Ignore an argument -- Does not do I/O. */
622 case 'k': /* Key sequence. */
625 specbind (Qcursor_in_echo_area
, Qt
);
626 /* Prompt in `minibuffer-prompt' face. */
627 Fput_text_property (make_number (0),
628 make_number (SCHARS (callint_message
)),
629 Qface
, Qminibuffer_prompt
, callint_message
);
630 args
[i
] = Fread_key_sequence (callint_message
,
631 Qnil
, Qnil
, Qnil
, Qnil
);
634 visargs
[i
] = Fkey_description (teml
, Qnil
);
636 /* If the key sequence ends with a down-event,
637 discard the following up-event. */
638 teml
= Faref (args
[i
], make_number (XINT (Flength (args
[i
])) - 1));
645 teml
= Fget (teml
, intern ("event-symbol-elements"));
646 /* Ignore first element, which is the base key. */
647 tem2
= Fmemq (intern ("down"), Fcdr (teml
));
649 up_event
= Fread_event (Qnil
, Qnil
, Qnil
);
654 case 'K': /* Key sequence to be defined. */
657 specbind (Qcursor_in_echo_area
, Qt
);
658 /* Prompt in `minibuffer-prompt' face. */
659 Fput_text_property (make_number (0),
660 make_number (SCHARS (callint_message
)),
661 Qface
, Qminibuffer_prompt
, callint_message
);
662 args
[i
] = Fread_key_sequence_vector (callint_message
,
663 Qnil
, Qt
, Qnil
, Qnil
);
665 visargs
[i
] = Fkey_description (teml
, Qnil
);
668 /* If the key sequence ends with a down-event,
669 discard the following up-event. */
670 teml
= Faref (args
[i
], make_number (XINT (Flength (args
[i
])) - 1));
677 teml
= Fget (teml
, intern ("event-symbol-elements"));
678 /* Ignore first element, which is the base key. */
679 tem2
= Fmemq (intern ("down"), Fcdr (teml
));
681 up_event
= Fread_event (Qnil
, Qnil
, Qnil
);
686 case 'U': /* Up event from last k or K. */
687 if (!NILP (up_event
))
689 args
[i
] = Fmake_vector (make_number (1), up_event
);
692 visargs
[i
] = Fkey_description (teml
, Qnil
);
696 case 'e': /* The invoking event. */
697 if (next_event
>= key_count
)
698 error ("%s must be bound to an event with parameters",
700 ? SSDATA (SYMBOL_NAME (function
))
702 args
[i
] = AREF (keys
, next_event
);
706 /* Find the next parameterized event. */
707 while (next_event
< key_count
708 && !(EVENT_HAS_PARAMETERS (AREF (keys
, next_event
))))
713 case 'm': /* Value of mark. Does not do I/O. */
715 /* visargs[i] = Qnil; */
716 args
[i
] = BVAR (current_buffer
, mark
);
720 case 'M': /* String read via minibuffer with
721 inheriting the current input method. */
722 args
[i
] = Fread_string (callint_message
,
723 Qnil
, Qnil
, Qnil
, Qt
);
726 case 'N': /* Prefix arg as number, else number from minibuffer. */
727 if (!NILP (prefix_arg
))
728 goto have_prefix_arg
;
729 case 'n': /* Read number from minibuffer. */
730 args
[i
] = call1 (Qread_number
, callint_message
);
731 /* Passing args[i] directly stimulates compiler bug. */
733 visargs
[i
] = Fnumber_to_string (teml
);
736 case 'P': /* Prefix arg in raw form. Does no I/O. */
737 args
[i
] = prefix_arg
;
738 /* visargs[i] = Qnil; */
742 case 'p': /* Prefix arg converted to number. No I/O. */
744 args
[i
] = Fprefix_numeric_value (prefix_arg
);
745 /* visargs[i] = Qnil; */
749 case 'r': /* Region, point and mark as 2 args. */
751 set_marker_both (point_marker
, Qnil
, PT
, PT_BYTE
);
752 /* visargs[i+1] = Qnil; */
753 mark
= marker_position (BVAR (current_buffer
, mark
));
754 /* visargs[i] = Qnil; */
755 args
[i
] = PT
< mark
? point_marker
: BVAR (current_buffer
, mark
);
757 args
[++i
] = PT
> mark
? point_marker
: BVAR (current_buffer
, mark
);
761 case 's': /* String read via minibuffer without
762 inheriting the current input method. */
763 args
[i
] = Fread_string (callint_message
,
764 Qnil
, Qnil
, Qnil
, Qnil
);
767 case 'S': /* Any symbol. */
768 visargs
[i
] = Fread_string (callint_message
,
769 Qnil
, Qnil
, Qnil
, Qnil
);
770 /* Passing args[i] directly stimulates compiler bug. */
772 args
[i
] = Fintern (teml
, Qnil
);
775 case 'v': /* Variable name: symbol that is
776 custom-variable-p. */
777 args
[i
] = Fread_variable (callint_message
, Qnil
);
778 visargs
[i
] = last_minibuf_string
;
781 case 'x': /* Lisp expression read but not evaluated. */
782 args
[i
] = call1 (intern ("read-minibuffer"), callint_message
);
783 visargs
[i
] = last_minibuf_string
;
786 case 'X': /* Lisp expression read and evaluated. */
787 args
[i
] = call1 (intern ("eval-minibuffer"), callint_message
);
788 visargs
[i
] = last_minibuf_string
;
791 case 'Z': /* Coding-system symbol, or ignore the
792 argument if no prefix. */
793 if (NILP (prefix_arg
))
801 = Fread_non_nil_coding_system (callint_message
);
802 visargs
[i
] = last_minibuf_string
;
806 case 'z': /* Coding-system symbol or nil. */
807 args
[i
] = Fread_coding_system (callint_message
, Qnil
);
808 visargs
[i
] = last_minibuf_string
;
811 /* We have a case for `+' so we get an error
812 if anyone tries to define one here. */
815 error ("Invalid control letter `%c' (#o%03o, #x%04x) in interactive calling string",
816 STRING_CHAR ((unsigned char *) tem
),
817 (unsigned) STRING_CHAR ((unsigned char *) tem
),
818 (unsigned) STRING_CHAR ((unsigned char *) tem
));
824 if (NILP (visargs
[i
]) && STRINGP (args
[i
]))
825 visargs
[i
] = args
[i
];
827 tem
= strchr (tem
, '\n');
836 args
[0] = Qfuncall_interactively
;
839 if (arg_from_tty
|| !NILP (record_flag
))
841 /* We don't need `visargs' any more, so let's recycle it since we need
842 an array of just the same size. */
843 visargs
[1] = function
;
844 for (i
= 2; i
< nargs
; i
++)
847 visargs
[i
] = list1 (intern (callint_argfuns
[varies
[i
]]));
849 visargs
[i
] = quotify_arg (args
[i
]);
851 Vcommand_history
= Fcons (Flist (nargs
- 1, visargs
+ 1),
853 /* Don't keep command history around forever. */
854 if (INTEGERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
856 teml
= Fnthcdr (Vhistory_length
, Vcommand_history
);
858 XSETCDR (teml
, Qnil
);
862 /* If we used a marker to hold point, mark, or an end of the region,
863 temporarily, convert it to an integer now. */
864 for (i
= 2; i
< nargs
; i
++)
865 if (varies
[i
] >= 1 && varies
[i
] <= 4)
866 XSETINT (args
[i
], marker_position (args
[i
]));
868 if (record_then_fail
)
869 Fbarf_if_buffer_read_only ();
871 Vthis_command
= save_this_command
;
872 Vthis_original_command
= save_this_original_command
;
873 Vreal_this_command
= save_real_this_command
;
874 kset_last_command (current_kboard
, save_last_command
);
877 Lisp_Object val
= Ffuncall (nargs
, args
);
884 DEFUN ("prefix-numeric-value", Fprefix_numeric_value
, Sprefix_numeric_value
,
886 doc
: /* Return numeric meaning of raw prefix argument RAW.
887 A raw prefix argument is what you get from `(interactive "P")'.
888 Its numeric meaning is what you would get from `(interactive "p")'. */)
894 XSETFASTINT (val
, 1);
895 else if (EQ (raw
, Qminus
))
897 else if (CONSP (raw
) && INTEGERP (XCAR (raw
)))
898 XSETINT (val
, XINT (XCAR (raw
)));
899 else if (INTEGERP (raw
))
902 XSETFASTINT (val
, 1);
908 syms_of_callint (void)
912 point_marker
= Fmake_marker ();
913 staticpro (&point_marker
);
915 callint_message
= Qnil
;
916 staticpro (&callint_message
);
918 preserved_fns
= listn (CONSTYPE_PURE
, 4,
919 intern_c_string ("region-beginning"),
920 intern_c_string ("region-end"),
921 intern_c_string ("point"),
922 intern_c_string ("mark"));
924 DEFSYM (Qlist
, "list");
925 DEFSYM (Qlet
, "let");
927 DEFSYM (Qwhen
, "when");
928 DEFSYM (Qletx
, "let*");
929 DEFSYM (Qsave_excursion
, "save-excursion");
930 DEFSYM (Qprogn
, "progn");
931 DEFSYM (Qminus
, "-");
933 DEFSYM (Qhandle_shift_selection
, "handle-shift-selection");
934 DEFSYM (Qread_number
, "read-number");
935 DEFSYM (Qfuncall_interactively
, "funcall-interactively");
936 DEFSYM (Qcommand_debug_status
, "command-debug-status");
937 DEFSYM (Qenable_recursive_minibuffers
, "enable-recursive-minibuffers");
938 DEFSYM (Qmouse_leave_buffer_hook
, "mouse-leave-buffer-hook");
940 DEFVAR_KBOARD ("prefix-arg", Vprefix_arg
,
941 doc
: /* The value of the prefix argument for the next editing command.
942 It may be a number, or the symbol `-' for just a minus sign as arg,
943 or a list whose car is a number for just one or more C-u's
944 or nil if no argument has been specified.
946 You cannot examine this variable to find the argument for this command
947 since it has been set to nil by the time you can look.
948 Instead, you should use the variable `current-prefix-arg', although
949 normally commands can get this prefix argument with (interactive "P"). */);
951 DEFVAR_KBOARD ("last-prefix-arg", Vlast_prefix_arg
,
952 doc
: /* The value of the prefix argument for the previous editing command.
953 See `prefix-arg' for the meaning of the value. */);
955 DEFVAR_LISP ("current-prefix-arg", Vcurrent_prefix_arg
,
956 doc
: /* The value of the prefix argument for this editing command.
957 It may be a number, or the symbol `-' for just a minus sign as arg,
958 or a list whose car is a number for just one or more C-u's
959 or nil if no argument has been specified.
960 This is what `(interactive \"P\")' returns. */);
961 Vcurrent_prefix_arg
= Qnil
;
963 DEFVAR_LISP ("command-history", Vcommand_history
,
964 doc
: /* List of recent commands that read arguments from terminal.
965 Each command is represented as a form to evaluate.
967 Maximum length of the history list is determined by the value
968 of `history-length', which see. */);
969 Vcommand_history
= Qnil
;
971 DEFVAR_LISP ("command-debug-status", Vcommand_debug_status
,
972 doc
: /* Debugging status of current interactive command.
973 Bound each time `call-interactively' is called;
974 may be set by the debugger as a reminder for itself. */);
975 Vcommand_debug_status
= Qnil
;
977 DEFVAR_LISP ("mark-even-if-inactive", Vmark_even_if_inactive
,
978 doc
: /* Non-nil means you can use the mark even when inactive.
979 This option makes a difference in Transient Mark mode.
980 When the option is non-nil, deactivation of the mark
981 turns off region highlighting, but commands that use the mark
982 behave as if the mark were still active. */);
983 Vmark_even_if_inactive
= Qt
;
985 DEFVAR_LISP ("mouse-leave-buffer-hook", Vmouse_leave_buffer_hook
,
986 doc
: /* Hook to run when about to switch windows with a mouse command.
987 Its purpose is to give temporary modes such as Isearch mode
988 a way to turn themselves off when a mouse command switches windows. */);
989 Vmouse_leave_buffer_hook
= Qnil
;