1 /* Call a Lisp function interactively.
2 Copyright (C) 1985, 1986, 1993, 1994, 1995, 1997, 2000, 2001, 2002,
3 2003, 2004, 2005, 2006, 2007, 2008, 2009
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
32 extern char *index
P_ ((const char *, int));
35 extern Lisp_Object Qcursor_in_echo_area
;
36 extern Lisp_Object Qfile_directory_p
;
37 extern Lisp_Object Qonly
;
39 Lisp_Object Vcurrent_prefix_arg
, Qminus
, Qplus
;
40 Lisp_Object Qcall_interactively
;
41 Lisp_Object Vcommand_history
;
43 extern Lisp_Object Vhistory_length
;
44 extern Lisp_Object Vthis_original_command
, real_this_command
;
46 Lisp_Object Vcommand_debug_status
, Qcommand_debug_status
;
47 Lisp_Object Qenable_recursive_minibuffers
;
48 extern Lisp_Object Qface
, Qminibuffer_prompt
;
50 /* Non-nil means treat the mark as active
51 even if mark_active is 0. */
52 Lisp_Object Vmark_even_if_inactive
;
54 Lisp_Object Vshift_select_mode
, Qhandle_shift_selection
;
56 Lisp_Object Vmouse_leave_buffer_hook
, Qmouse_leave_buffer_hook
;
58 Lisp_Object Qlist
, Qlet
, Qletx
, Qsave_excursion
, Qprogn
, Qif
, Qwhen
;
59 static Lisp_Object preserved_fns
;
61 /* Marker used within call-interactively to refer to point. */
62 static Lisp_Object point_marker
;
64 /* String for the prompt text used in Fcall_interactively. */
65 static Lisp_Object callint_message
;
68 DEFUN ("interactive", Finteractive
, Sinteractive
, 0, UNEVALLED
, 0,
69 doc
: /* Specify a way of parsing arguments for interactive use of a function.
71 (defun foo (arg buf) "Doc string" (interactive "P\\nbbuffer: ") .... )
72 to make ARG be the raw prefix argument, and set BUF to an existing buffer,
73 when `foo' is called as a command.
74 The "call" to `interactive' is actually a declaration rather than a function;
75 it tells `call-interactively' how to read arguments
76 to pass to the function.
77 When actually called, `interactive' just returns nil.
79 Usually the argument of `interactive' is a string containing a code letter
80 followed optionally by a prompt. (Some code letters do not use I/O to get
81 the argument and do not use prompts.) To get several arguments, concatenate
82 the individual strings, separating them by newline characters.
83 Prompts are passed to format, and may use % escapes to print the
84 arguments that have already been read.
85 If the argument is not a string, it is evaluated to get a list of
86 arguments to pass to the function.
87 Just `(interactive)' means pass no args when calling interactively.
89 Code letters available are:
90 a -- Function name: symbol with a function definition.
91 b -- Name of existing buffer.
92 B -- Name of buffer, possibly nonexistent.
93 c -- Character (no input method is used).
94 C -- Command name: symbol with interactive function definition.
95 d -- Value of point as number. Does not do I/O.
97 e -- Parametrized event (i.e., one that's a list) that invoked this command.
98 If used more than once, the Nth `e' returns the Nth parameterized event.
99 This skips events that are integers or symbols.
100 f -- Existing file name.
101 F -- Possibly nonexistent file name.
102 G -- Possibly nonexistent file name, defaulting to just directory name.
103 i -- Ignored, i.e. always nil. Does not do I/O.
104 k -- Key sequence (downcase the last event if needed to get a definition).
105 K -- Key sequence to be redefined (do not downcase the last event).
106 m -- Value of mark as number. Does not do I/O.
107 M -- Any string. Inherits the current input method.
108 n -- Number read using minibuffer.
109 N -- Numeric prefix arg, or if none, do like code `n'.
110 p -- Prefix arg converted to number. Does not do I/O.
111 P -- Prefix arg in raw form. Does not do I/O.
112 r -- Region: point and mark as 2 numeric args, smallest first. Does no I/O.
113 s -- Any string. Does not inherit the current input method.
115 U -- Mouse up event discarded by a previous k or K argument.
116 v -- Variable name: symbol that is user-variable-p.
117 x -- Lisp expression read but not evaluated.
118 X -- Lisp expression read and evaluated.
120 Z -- Coding system, nil if no prefix arg.
122 In addition, if the string begins with `*', an error is signaled if
123 the buffer is read-only.
124 If the string begins with `@', Emacs searches the key sequence which
125 invoked the command for its first mouse click (or any other event
126 which specifies a window).
127 If the string begins with `^' and `shift-select-mode' is non-nil,
128 Emacs first calls the function `handle-shift-select'.
129 You may use `@', `*', and `^' together. They are processed in the
130 order that they appear, before reading any arguments.
131 usage: (interactive &optional ARGS) */)
138 /* Quotify EXP: if EXP is constant, return it.
139 If EXP is not constant, return (quote EXP). */
142 register Lisp_Object exp
;
144 if (!INTEGERP (exp
) && !STRINGP (exp
)
145 && !NILP (exp
) && !EQ (exp
, Qt
))
146 return Fcons (Qquote
, Fcons (exp
, Qnil
));
151 /* Modify EXP by quotifying each element (except the first). */
156 register Lisp_Object tail
;
158 for (tail
= exp
; CONSP (tail
); tail
= next
)
161 XSETCAR (tail
, quotify_arg (XCAR (tail
)));
166 char *callint_argfuns
[]
167 = {"", "point", "mark", "region-beginning", "region-end"};
170 check_mark (for_region
)
174 tem
= Fmarker_buffer (current_buffer
->mark
);
175 if (NILP (tem
) || (XBUFFER (tem
) != current_buffer
))
176 error (for_region
? "The mark is not set now, so there is no region"
177 : "The mark is not set now");
178 if (!NILP (Vtransient_mark_mode
) && NILP (Vmark_even_if_inactive
)
179 && NILP (current_buffer
->mark_active
))
180 xsignal0 (Qmark_inactive
);
183 /* If the list of args INPUT was produced with an explicit call to
184 `list', look for elements that were computed with
185 (region-beginning) or (region-end), and put those expressions into
186 VALUES instead of the present values.
188 This function doesn't return a value because it modifies elements
189 of VALUES to do its job. */
192 fix_command (input
, values
)
193 Lisp_Object input
, values
;
200 /* Skip through certain special forms. */
201 while (EQ (car
, Qlet
) || EQ (car
, Qletx
)
202 || EQ (car
, Qsave_excursion
)
205 while (CONSP (XCDR (input
)))
206 input
= XCDR (input
);
207 input
= XCAR (input
);
214 Lisp_Object intail
, valtail
;
215 for (intail
= Fcdr (input
), valtail
= values
;
217 intail
= Fcdr (intail
), valtail
= XCDR (valtail
))
223 Lisp_Object presflag
, carelt
;
225 /* If it is (if X Y), look at Y. */
227 && EQ (Fnthcdr (make_number (3), elt
), Qnil
))
228 elt
= Fnth (make_number (2), elt
);
229 /* If it is (when ... Y), look at Y. */
230 else if (EQ (carelt
, Qwhen
))
232 while (CONSP (XCDR (elt
)))
237 /* If the function call we're looking at
238 is a special preserved one, copy the
239 whole expression for this argument. */
242 presflag
= Fmemq (Fcar (elt
), preserved_fns
);
243 if (!NILP (presflag
))
244 Fsetcar (valtail
, Fcar (intail
));
252 DEFUN ("call-interactively", Fcall_interactively
, Scall_interactively
, 1, 3, 0,
253 doc
: /* Call FUNCTION, reading args according to its interactive calling specs.
254 Return the value FUNCTION returns.
255 The function contains a specification of how to do the argument reading.
256 In the case of user-defined functions, this is specified by placing a call
257 to the function `interactive' at the top level of the function body.
260 Optional second arg RECORD-FLAG non-nil
261 means unconditionally put this command in the command-history.
262 Otherwise, this is done only if an arg is read using the minibuffer.
264 Optional third arg KEYS, if given, specifies the sequence of events to
265 supply, as a vector, if the command inquires which events were used to
266 invoke it. If KEYS is omitted or nil, the return value of
267 `this-command-keys-vector' is used. */)
268 (function
, record_flag
, keys
)
269 Lisp_Object function
, record_flag
, keys
;
271 Lisp_Object
*args
, *visargs
;
273 Lisp_Object filter_specs
;
275 Lisp_Object up_event
;
277 int speccount
= SPECPDL_INDEX ();
279 /* The index of the next element of this_command_keys to examine for
280 the 'e' interactive code. */
283 Lisp_Object prefix_arg
;
284 unsigned char *string
;
287 /* If varies[i] > 0, the i'th argument shouldn't just have its value
288 in this call quoted in the command history. It should be
289 recorded as a call to the function named callint_argfuns[varies[i]]. */
296 int arg_from_tty
= 0;
297 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
299 int record_then_fail
= 0;
301 Lisp_Object save_this_command
, save_last_command
;
302 Lisp_Object save_this_original_command
, save_real_this_command
;
304 save_this_command
= Vthis_command
;
305 save_this_original_command
= Vthis_original_command
;
306 save_real_this_command
= real_this_command
;
307 save_last_command
= current_kboard
->Vlast_command
;
310 keys
= this_command_keys
, key_count
= this_command_key_count
;
314 key_count
= XVECTOR (keys
)->size
;
317 /* Save this now, since use of minibuffer will clobber it. */
318 prefix_arg
= Vcurrent_prefix_arg
;
320 if (SYMBOLP (function
))
321 enable
= Fget (function
, Qenable_recursive_minibuffers
);
327 /* The idea of FILTER_SPECS is to provide away to
328 specify how to represent the arguments in command history.
329 The feature is not fully implemented. */
332 /* If k or K discard an up-event, save it here so it can be retrieved with U */
335 /* Set SPECS to the interactive form, or barf if not interactive. */
338 GCPRO2 (function
, prefix_arg
);
339 form
= Finteractive_form (function
);
342 specs
= filter_specs
= Fcar (XCDR (form
));
344 wrong_type_argument (Qcommandp
, function
);
347 /* If SPECS is set to a string, use it as an interactive prompt. */
350 /* Make a copy of string so that if a GC relocates specs,
351 `string' will still be valid. */
352 string
= (unsigned char *) alloca (SBYTES (specs
) + 1);
353 bcopy (SDATA (specs
), string
,
359 i
= num_input_events
;
361 /* Compute the arg values using the user's expression. */
362 GCPRO2 (input
, filter_specs
);
363 specs
= Feval (specs
);
365 if (i
!= num_input_events
|| !NILP (record_flag
))
367 /* We should record this command on the command history. */
369 /* Make a copy of the list of values, for the command history,
370 and turn them into things we can eval. */
371 values
= quotify_args (Fcopy_sequence (specs
));
372 fix_command (input
, values
);
374 = Fcons (Fcons (function
, values
), Vcommand_history
);
376 /* Don't keep command history around forever. */
377 if (INTEGERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
379 teml
= Fnthcdr (Vhistory_length
, Vcommand_history
);
381 XSETCDR (teml
, Qnil
);
385 Vthis_command
= save_this_command
;
386 Vthis_original_command
= save_this_original_command
;
387 real_this_command
= save_real_this_command
;
388 current_kboard
->Vlast_command
= save_last_command
;
390 temporarily_switch_to_single_kboard (NULL
);
391 return unbind_to (speccount
, apply1 (function
, specs
));
394 /* Here if function specifies a string to control parsing the defaults */
396 /* Set next_event to point to the first event with parameters. */
397 for (next_event
= 0; next_event
< key_count
; next_event
++)
398 if (EVENT_HAS_PARAMETERS (AREF (keys
, next_event
)))
401 /* Handle special starting chars `*' and `@'. Also `-'. */
402 /* Note that `+' is reserved for user extensions. */
406 error ("`+' is not used in `interactive' for ordinary commands");
407 else if (*string
== '*')
410 if (!NILP (current_buffer
->read_only
))
412 if (!NILP (record_flag
))
414 unsigned char *p
= string
;
417 if (! (*p
== 'r' || *p
== 'p' || *p
== 'P'
419 Fbarf_if_buffer_read_only ();
422 record_then_fail
= 1;
425 Fbarf_if_buffer_read_only ();
428 /* Ignore this for semi-compatibility with Lucid. */
429 else if (*string
== '-')
431 else if (*string
== '@')
433 Lisp_Object event
, tem
;
435 event
= (next_event
< key_count
436 ? AREF (keys
, next_event
)
438 if (EVENT_HAS_PARAMETERS (event
)
439 && (tem
= XCDR (event
), CONSP (tem
))
440 && (tem
= XCAR (tem
), CONSP (tem
))
441 && (tem
= XCAR (tem
), WINDOWP (tem
)))
443 if (MINI_WINDOW_P (XWINDOW (tem
))
444 && ! (minibuf_level
> 0 && EQ (tem
, minibuf_window
)))
445 error ("Attempt to select inactive minibuffer window");
447 /* If the current buffer wants to clean up, let it. */
448 if (!NILP (Vmouse_leave_buffer_hook
))
449 call1 (Vrun_hooks
, Qmouse_leave_buffer_hook
);
451 Fselect_window (tem
, Qnil
);
455 else if (*string
== '^')
457 if (! NILP (Vshift_select_mode
))
458 call1 (Qhandle_shift_selection
, Qnil
);
459 /* Even if shift-select-mode is off, temporarily active
460 regions could be set using the mouse, and should be
462 else if (CONSP (Vtransient_mark_mode
)
463 && EQ (XCAR (Vtransient_mark_mode
), Qonly
))
464 call1 (Qhandle_shift_selection
, Qt
);
470 /* Count the number of arguments the interactive spec would have
471 us give to the function. */
475 /* 'r' specifications ("point and mark as 2 numeric args")
476 produce *two* arguments. */
481 tem
= (unsigned char *) index (tem
, '\n');
489 args
= (Lisp_Object
*) alloca ((count
+ 1) * sizeof (Lisp_Object
));
490 visargs
= (Lisp_Object
*) alloca ((count
+ 1) * sizeof (Lisp_Object
));
491 varies
= (int *) alloca ((count
+ 1) * sizeof (int));
493 for (i
= 0; i
< (count
+ 1); i
++)
500 GCPRO5 (prefix_arg
, function
, *args
, *visargs
, up_event
);
501 gcpro3
.nvars
= (count
+ 1);
502 gcpro4
.nvars
= (count
+ 1);
505 specbind (Qenable_recursive_minibuffers
, Qt
);
508 for (i
= 1; *tem
; i
++)
510 strncpy (prompt1
, tem
+ 1, sizeof prompt1
- 1);
511 prompt1
[sizeof prompt1
- 1] = 0;
512 tem1
= (char *) index (prompt1
, '\n');
515 visargs
[0] = build_string (prompt1
);
516 if (index (prompt1
, '%'))
517 callint_message
= Fformat (i
, visargs
);
519 callint_message
= visargs
[0];
523 case 'a': /* Symbol defined as a function */
524 visargs
[i
] = Fcompleting_read (callint_message
,
525 Vobarray
, Qfboundp
, Qt
,
526 Qnil
, Qnil
, Qnil
, Qnil
);
527 /* Passing args[i] directly stimulates compiler bug */
529 args
[i
] = Fintern (teml
, Qnil
);
532 case 'b': /* Name of existing buffer */
533 args
[i
] = Fcurrent_buffer ();
534 if (EQ (selected_window
, minibuf_window
))
535 args
[i
] = Fother_buffer (args
[i
], Qnil
, Qnil
);
536 args
[i
] = Fread_buffer (callint_message
, args
[i
], Qt
);
539 case 'B': /* Name of buffer, possibly nonexistent */
540 args
[i
] = Fread_buffer (callint_message
,
541 Fother_buffer (Fcurrent_buffer (), Qnil
, Qnil
),
545 case 'c': /* Character */
546 /* Prompt in `minibuffer-prompt' face. */
547 Fput_text_property (make_number (0),
548 make_number (SCHARS (callint_message
)),
549 Qface
, Qminibuffer_prompt
, callint_message
);
550 args
[i
] = Fread_char (callint_message
, Qnil
, Qnil
);
551 message1_nolog ((char *) 0);
552 /* Passing args[i] directly stimulates compiler bug */
554 visargs
[i
] = Fchar_to_string (teml
);
557 case 'C': /* Command: symbol with interactive function */
558 visargs
[i
] = Fcompleting_read (callint_message
,
560 Qt
, Qnil
, Qnil
, Qnil
, Qnil
);
561 /* Passing args[i] directly stimulates compiler bug */
563 args
[i
] = Fintern (teml
, Qnil
);
566 case 'd': /* Value of point. Does not do I/O. */
567 set_marker_both (point_marker
, Qnil
, PT
, PT_BYTE
);
568 args
[i
] = point_marker
;
569 /* visargs[i] = Qnil; */
573 case 'D': /* Directory name. */
574 args
[i
] = Fread_file_name (callint_message
, Qnil
,
575 current_buffer
->directory
, Qlambda
, Qnil
,
579 case 'f': /* Existing file name. */
580 args
[i
] = Fread_file_name (callint_message
,
581 Qnil
, Qnil
, Qlambda
, Qnil
, Qnil
);
584 case 'F': /* Possibly nonexistent file name. */
585 args
[i
] = Fread_file_name (callint_message
,
586 Qnil
, Qnil
, Qnil
, Qnil
, Qnil
);
589 case 'G': /* Possibly nonexistent file name,
590 default to directory alone. */
591 args
[i
] = Fread_file_name (callint_message
,
592 Qnil
, Qnil
, Qnil
, empty_unibyte_string
, Qnil
);
595 case 'i': /* Ignore an argument -- Does not do I/O */
599 case 'k': /* Key sequence. */
601 int speccount1
= SPECPDL_INDEX ();
602 specbind (Qcursor_in_echo_area
, Qt
);
603 /* Prompt in `minibuffer-prompt' face. */
604 Fput_text_property (make_number (0),
605 make_number (SCHARS (callint_message
)),
606 Qface
, Qminibuffer_prompt
, callint_message
);
607 args
[i
] = Fread_key_sequence (callint_message
,
608 Qnil
, Qnil
, Qnil
, Qnil
);
609 unbind_to (speccount1
, Qnil
);
611 visargs
[i
] = Fkey_description (teml
, Qnil
);
613 /* If the key sequence ends with a down-event,
614 discard the following up-event. */
615 teml
= Faref (args
[i
], make_number (XINT (Flength (args
[i
])) - 1));
622 teml
= Fget (teml
, intern ("event-symbol-elements"));
623 /* Ignore first element, which is the base key. */
624 tem2
= Fmemq (intern ("down"), Fcdr (teml
));
626 up_event
= Fread_event (Qnil
, Qnil
, Qnil
);
631 case 'K': /* Key sequence to be defined. */
633 int speccount1
= SPECPDL_INDEX ();
634 specbind (Qcursor_in_echo_area
, Qt
);
635 /* Prompt in `minibuffer-prompt' face. */
636 Fput_text_property (make_number (0),
637 make_number (SCHARS (callint_message
)),
638 Qface
, Qminibuffer_prompt
, callint_message
);
639 args
[i
] = Fread_key_sequence (callint_message
,
640 Qnil
, Qt
, Qnil
, Qnil
);
642 visargs
[i
] = Fkey_description (teml
, Qnil
);
643 unbind_to (speccount1
, Qnil
);
645 /* If the key sequence ends with a down-event,
646 discard the following up-event. */
647 teml
= Faref (args
[i
], make_number (XINT (Flength (args
[i
])) - 1));
654 teml
= Fget (teml
, intern ("event-symbol-elements"));
655 /* Ignore first element, which is the base key. */
656 tem2
= Fmemq (intern ("down"), Fcdr (teml
));
658 up_event
= Fread_event (Qnil
, Qnil
, Qnil
);
663 case 'U': /* Up event from last k or K */
664 if (!NILP (up_event
))
666 args
[i
] = Fmake_vector (make_number (1), up_event
);
669 visargs
[i
] = Fkey_description (teml
, Qnil
);
673 case 'e': /* The invoking event. */
674 if (next_event
>= key_count
)
675 error ("%s must be bound to an event with parameters",
677 ? (char *) SDATA (SYMBOL_NAME (function
))
679 args
[i
] = AREF (keys
, next_event
);
683 /* Find the next parameterized event. */
684 while (next_event
< key_count
685 && !(EVENT_HAS_PARAMETERS (AREF (keys
, next_event
))))
690 case 'm': /* Value of mark. Does not do I/O. */
692 /* visargs[i] = Qnil; */
693 args
[i
] = current_buffer
->mark
;
697 case 'M': /* String read via minibuffer with
698 inheriting the current input method. */
699 args
[i
] = Fread_string (callint_message
,
700 Qnil
, Qnil
, Qnil
, Qt
);
703 case 'N': /* Prefix arg as number, else number from minibuffer */
704 if (!NILP (prefix_arg
))
705 goto have_prefix_arg
;
706 case 'n': /* Read number from minibuffer. */
714 message ("Please enter a number.");
715 sit_for (make_number (1), 0, 0);
719 tem
= Fread_from_minibuffer (callint_message
,
720 Qnil
, Qnil
, Qnil
, Qnil
, Qnil
,
722 if (! STRINGP (tem
) || SCHARS (tem
) == 0)
725 args
[i
] = Fread (tem
);
727 while (! NUMBERP (args
[i
]));
729 visargs
[i
] = args
[i
];
732 case 'P': /* Prefix arg in raw form. Does no I/O. */
733 args
[i
] = prefix_arg
;
734 /* visargs[i] = Qnil; */
738 case 'p': /* Prefix arg converted to number. No I/O. */
740 args
[i
] = Fprefix_numeric_value (prefix_arg
);
741 /* visargs[i] = Qnil; */
745 case 'r': /* Region, point and mark as 2 args. */
747 set_marker_both (point_marker
, Qnil
, PT
, PT_BYTE
);
748 /* visargs[i+1] = Qnil; */
749 foo
= marker_position (current_buffer
->mark
);
750 /* visargs[i] = Qnil; */
751 args
[i
] = PT
< foo
? point_marker
: current_buffer
->mark
;
753 args
[++i
] = PT
> foo
? point_marker
: current_buffer
->mark
;
757 case 's': /* String read via minibuffer without
758 inheriting the current input method. */
759 args
[i
] = Fread_string (callint_message
,
760 Qnil
, Qnil
, Qnil
, Qnil
);
763 case 'S': /* Any symbol. */
764 visargs
[i
] = Fread_string (callint_message
,
765 Qnil
, Qnil
, Qnil
, Qnil
);
766 /* Passing args[i] directly stimulates compiler bug */
768 args
[i
] = Fintern (teml
, Qnil
);
771 case 'v': /* Variable name: symbol that is
773 args
[i
] = Fread_variable (callint_message
, Qnil
);
774 visargs
[i
] = last_minibuf_string
;
777 case 'x': /* Lisp expression read but not evaluated */
778 args
[i
] = Fread_minibuffer (callint_message
, Qnil
);
779 visargs
[i
] = last_minibuf_string
;
782 case 'X': /* Lisp expression read and evaluated */
783 args
[i
] = Feval_minibuffer (callint_message
, Qnil
);
784 visargs
[i
] = last_minibuf_string
;
787 case 'Z': /* Coding-system symbol, or ignore the
788 argument if no prefix */
789 if (NILP (prefix_arg
))
797 = Fread_non_nil_coding_system (callint_message
);
798 visargs
[i
] = last_minibuf_string
;
802 case 'z': /* Coding-system symbol or nil */
803 args
[i
] = Fread_coding_system (callint_message
, Qnil
);
804 visargs
[i
] = last_minibuf_string
;
807 /* We have a case for `+' so we get an error
808 if anyone tries to define one here. */
811 error ("Invalid control letter `%c' (%03o) in interactive calling string",
818 if (NILP (visargs
[i
]) && STRINGP (args
[i
]))
819 visargs
[i
] = args
[i
];
821 tem
= (unsigned char *) index (tem
, '\n');
823 else tem
= (unsigned char *) "";
825 unbind_to (speccount
, Qnil
);
831 if (arg_from_tty
|| !NILP (record_flag
))
833 visargs
[0] = function
;
834 for (i
= 1; i
< count
+ 1; i
++)
837 visargs
[i
] = Fcons (intern (callint_argfuns
[varies
[i
]]), Qnil
);
839 visargs
[i
] = quotify_arg (args
[i
]);
841 Vcommand_history
= Fcons (Flist (count
+ 1, visargs
),
843 /* Don't keep command history around forever. */
844 if (INTEGERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
846 teml
= Fnthcdr (Vhistory_length
, Vcommand_history
);
848 XSETCDR (teml
, Qnil
);
852 /* If we used a marker to hold point, mark, or an end of the region,
853 temporarily, convert it to an integer now. */
854 for (i
= 1; i
<= count
; i
++)
855 if (varies
[i
] >= 1 && varies
[i
] <= 4)
856 XSETINT (args
[i
], marker_position (args
[i
]));
858 if (record_then_fail
)
859 Fbarf_if_buffer_read_only ();
861 Vthis_command
= save_this_command
;
862 Vthis_original_command
= save_this_original_command
;
863 real_this_command
= save_real_this_command
;
864 current_kboard
->Vlast_command
= save_last_command
;
868 specbind (Qcommand_debug_status
, Qnil
);
870 temporarily_switch_to_single_kboard (NULL
);
871 val
= Ffuncall (count
+ 1, args
);
873 return unbind_to (speccount
, val
);
877 DEFUN ("prefix-numeric-value", Fprefix_numeric_value
, Sprefix_numeric_value
,
879 doc
: /* Return numeric meaning of raw prefix argument RAW.
880 A raw prefix argument is what you get from `(interactive "P")'.
881 Its numeric meaning is what you would get from `(interactive "p")'. */)
888 XSETFASTINT (val
, 1);
889 else if (EQ (raw
, Qminus
))
891 else if (CONSP (raw
) && INTEGERP (XCAR (raw
)))
892 XSETINT (val
, XINT (XCAR (raw
)));
893 else if (INTEGERP (raw
))
896 XSETFASTINT (val
, 1);
904 point_marker
= Fmake_marker ();
905 staticpro (&point_marker
);
907 callint_message
= Qnil
;
908 staticpro (&callint_message
);
910 preserved_fns
= Fcons (intern ("region-beginning"),
911 Fcons (intern ("region-end"),
912 Fcons (intern ("point"),
913 Fcons (intern ("mark"), Qnil
))));
914 staticpro (&preserved_fns
);
916 Qlist
= intern ("list");
918 Qlet
= intern ("let");
922 Qwhen
= intern ("when");
924 Qletx
= intern ("let*");
926 Qsave_excursion
= intern ("save-excursion");
927 staticpro (&Qsave_excursion
);
928 Qprogn
= intern ("progn");
931 Qminus
= intern ("-");
934 Qplus
= intern ("+");
937 Qhandle_shift_selection
= intern ("handle-shift-selection");
938 staticpro (&Qhandle_shift_selection
);
940 Qcall_interactively
= intern ("call-interactively");
941 staticpro (&Qcall_interactively
);
943 Qcommand_debug_status
= intern ("command-debug-status");
944 staticpro (&Qcommand_debug_status
);
946 Qenable_recursive_minibuffers
= intern ("enable-recursive-minibuffers");
947 staticpro (&Qenable_recursive_minibuffers
);
949 Qmouse_leave_buffer_hook
= intern ("mouse-leave-buffer-hook");
950 staticpro (&Qmouse_leave_buffer_hook
);
952 DEFVAR_KBOARD ("prefix-arg", Vprefix_arg
,
953 doc
: /* The value of the prefix argument for the next 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.
958 You cannot examine this variable to find the argument for this command
959 since it has been set to nil by the time you can look.
960 Instead, you should use the variable `current-prefix-arg', although
961 normally commands can get this prefix argument with (interactive "P"). */);
963 DEFVAR_KBOARD ("last-prefix-arg", Vlast_prefix_arg
,
964 doc
: /* The value of the prefix argument for the previous editing command.
965 See `prefix-arg' for the meaning of the value. */);
967 DEFVAR_LISP ("current-prefix-arg", &Vcurrent_prefix_arg
,
968 doc
: /* The value of the prefix argument for this editing command.
969 It may be a number, or the symbol `-' for just a minus sign as arg,
970 or a list whose car is a number for just one or more C-u's
971 or nil if no argument has been specified.
972 This is what `(interactive \"P\")' returns. */);
973 Vcurrent_prefix_arg
= Qnil
;
975 DEFVAR_LISP ("command-history", &Vcommand_history
,
976 doc
: /* List of recent commands that read arguments from terminal.
977 Each command is represented as a form to evaluate.
979 Maximum length of the history list is determined by the value
980 of `history-length', which see. */);
981 Vcommand_history
= Qnil
;
983 DEFVAR_LISP ("command-debug-status", &Vcommand_debug_status
,
984 doc
: /* Debugging status of current interactive command.
985 Bound each time `call-interactively' is called;
986 may be set by the debugger as a reminder for itself. */);
987 Vcommand_debug_status
= Qnil
;
989 DEFVAR_LISP ("mark-even-if-inactive", &Vmark_even_if_inactive
,
990 doc
: /* *Non-nil means you can use the mark even when inactive.
991 This option makes a difference in Transient Mark mode.
992 When the option is non-nil, deactivation of the mark
993 turns off region highlighting, but commands that use the mark
994 behave as if the mark were still active. */);
995 Vmark_even_if_inactive
= Qt
;
997 DEFVAR_LISP ("shift-select-mode", &Vshift_select_mode
,
998 doc
: /* When non-nil, shifted motion keys activate the mark momentarily.
1000 While the mark is activated in this way, any shift-translated point
1001 motion key extends the region, and if Transient Mark mode was off, it
1002 is temporarily turned on. Furthermore, the mark will be deactivated
1003 by any subsequent point motion key that was not shift-translated, or
1004 by any action that normally deactivates the mark in Transient Mark
1007 See `this-command-keys-shift-translated' for the meaning of
1008 shift-translation. */);
1009 Vshift_select_mode
= Qt
;
1011 DEFVAR_LISP ("mouse-leave-buffer-hook", &Vmouse_leave_buffer_hook
,
1012 doc
: /* Hook to run when about to switch windows with a mouse command.
1013 Its purpose is to give temporary modes such as Isearch mode
1014 a way to turn themselves off when a mouse command switches windows. */);
1015 Vmouse_leave_buffer_hook
= Qnil
;
1017 defsubr (&Sinteractive
);
1018 defsubr (&Scall_interactively
);
1019 defsubr (&Sprefix_numeric_value
);
1022 /* arch-tag: a3a7cad7-bcac-42ce-916e-1bd2546ebf37
1023 (do not change this comment) */