(comment-search-forward, comment-search-backward): Fix typos.
[emacs.git] / src / callint.c
bloba3e4984fd16aa8f929562f73a7ae8cbb8fb9cab4
1 /* Call a Lisp function interactively.
2 Copyright (C) 1985, 86, 93, 94, 95, 1997, 2000, 02, 03, 2004
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 2, or (at your option)
10 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; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
23 #include <config.h>
25 #include "lisp.h"
26 #include "buffer.h"
27 #include "commands.h"
28 #include "keyboard.h"
29 #include "window.h"
30 #include "keymap.h"
32 #ifdef HAVE_INDEX
33 extern char *index P_ ((const char *, int));
34 #endif
36 extern Lisp_Object Qcursor_in_echo_area;
37 extern Lisp_Object Qfile_directory_p;
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;
49 /* Non-nil means treat the mark as active
50 even if mark_active is 0. */
51 Lisp_Object Vmark_even_if_inactive;
53 Lisp_Object Vmouse_leave_buffer_hook, Qmouse_leave_buffer_hook;
55 Lisp_Object Qlist, Qlet, Qletx, Qsave_excursion, Qprogn, Qif, Qwhen;
56 static Lisp_Object preserved_fns;
58 /* Marker used within call-interactively to refer to point. */
59 static Lisp_Object point_marker;
61 /* Buffer for the prompt text used in Fcall_interactively. */
62 static char *callint_message;
64 /* Allocated length of that buffer. */
65 static int callint_message_size;
67 /* ARGSUSED */
68 DEFUN ("interactive", Finteractive, Sinteractive, 0, UNEVALLED, 0,
69 doc: /* Specify a way of parsing arguments for interactive use of a function.
70 For example, write
71 (defun foo (arg) "Doc string" (interactive "p") ...use arg...)
72 to make ARG be the prefix argument when `foo' is called as a command.
73 The "call" to `interactive' is actually a declaration rather than a function;
74 it tells `call-interactively' how to read arguments
75 to pass to the function.
76 When actually called, `interactive' just returns nil.
78 The argument of `interactive' is usually a string containing a code letter
79 followed by a prompt. (Some code letters do not use I/O to get
80 the argument and do not need prompts.) To prompt for multiple arguments,
81 give a code letter, its prompt, a newline, and another code letter, etc.
82 Prompts are passed to format, and may use % escapes to print the
83 arguments that have already been read.
84 If the argument is not a string, it is evaluated to get a list of
85 arguments to pass to the function.
86 Just `(interactive)' means pass no args when calling interactively.
88 Code letters available are:
89 a -- Function name: symbol with a function definition.
90 b -- Name of existing buffer.
91 B -- Name of buffer, possibly nonexistent.
92 c -- Character (no input method is used).
93 C -- Command name: symbol with interactive function definition.
94 d -- Value of point as number. Does not do I/O.
95 D -- Directory name.
96 e -- Parametrized event (i.e., one that's a list) that invoked this command.
97 If used more than once, the Nth `e' returns the Nth parameterized event.
98 This skips events that are integers or symbols.
99 f -- Existing file name.
100 F -- Possibly nonexistent file name.
101 i -- Ignored, i.e. always nil. Does not do I/O.
102 k -- Key sequence (downcase the last event if needed to get a definition).
103 K -- Key sequence to be redefined (do not downcase the last event).
104 m -- Value of mark as number. Does not do I/O.
105 M -- Any string. Inherits the current input method.
106 n -- Number read using minibuffer.
107 N -- Raw prefix arg, or if none, do like code `n'.
108 p -- Prefix arg converted to number. Does not do I/O.
109 P -- Prefix arg in raw form. Does not do I/O.
110 r -- Region: point and mark as 2 numeric args, smallest first. Does no I/O.
111 s -- Any string. Does not inherit the current input method.
112 S -- Any symbol.
113 v -- Variable name: symbol that is user-variable-p.
114 x -- Lisp expression read but not evaluated.
115 X -- Lisp expression read and evaluated.
116 z -- Coding system.
117 Z -- Coding system, nil if no prefix arg.
118 In addition, if the string begins with `*'
119 then an error is signaled if the buffer is read-only.
120 This happens before reading any arguments.
121 If the string begins with `@', then Emacs searches the key sequence
122 which invoked the command for its first mouse click (or any other
123 event which specifies a window), and selects that window before
124 reading any arguments. You may use both `@' and `*'; they are
125 processed in the order that they appear.
126 usage: (interactive ARGS) */)
127 (args)
128 Lisp_Object args;
130 return Qnil;
133 /* Quotify EXP: if EXP is constant, return it.
134 If EXP is not constant, return (quote EXP). */
135 Lisp_Object
136 quotify_arg (exp)
137 register Lisp_Object exp;
139 if (!INTEGERP (exp) && !STRINGP (exp)
140 && !NILP (exp) && !EQ (exp, Qt))
141 return Fcons (Qquote, Fcons (exp, Qnil));
143 return exp;
146 /* Modify EXP by quotifying each element (except the first). */
147 Lisp_Object
148 quotify_args (exp)
149 Lisp_Object exp;
151 register Lisp_Object tail;
152 Lisp_Object next;
153 for (tail = exp; CONSP (tail); tail = next)
155 next = XCDR (tail);
156 XSETCAR (tail, quotify_arg (XCAR (tail)));
158 return exp;
161 char *callint_argfuns[]
162 = {"", "point", "mark", "region-beginning", "region-end"};
164 static void
165 check_mark (for_region)
166 int for_region;
168 Lisp_Object tem;
169 tem = Fmarker_buffer (current_buffer->mark);
170 if (NILP (tem) || (XBUFFER (tem) != current_buffer))
171 error (for_region ? "The mark is not set now, so there is no region"
172 : "The mark is not set now");
173 if (!NILP (Vtransient_mark_mode) && NILP (Vmark_even_if_inactive)
174 && NILP (current_buffer->mark_active))
175 Fsignal (Qmark_inactive, Qnil);
178 /* If the list of args INPUT was produced with an explicit call to
179 `list', look for elements that were computed with
180 (region-beginning) or (region-end), and put those expressions into
181 VALUES instead of the present values.
183 This function doesn't return a value because it modifies elements
184 of VALUES to do its job. */
186 static void
187 fix_command (input, values)
188 Lisp_Object input, values;
190 if (CONSP (input))
192 Lisp_Object car;
194 car = XCAR (input);
195 /* Skip through certain special forms. */
196 while (EQ (car, Qlet) || EQ (car, Qletx)
197 || EQ (car, Qsave_excursion)
198 || EQ (car, Qprogn))
200 while (CONSP (XCDR (input)))
201 input = XCDR (input);
202 input = XCAR (input);
203 if (!CONSP (input))
204 break;
205 car = XCAR (input);
207 if (EQ (car, Qlist))
209 Lisp_Object intail, valtail;
210 for (intail = Fcdr (input), valtail = values;
211 CONSP (valtail);
212 intail = Fcdr (intail), valtail = XCDR (valtail))
214 Lisp_Object elt;
215 elt = Fcar (intail);
216 if (CONSP (elt))
218 Lisp_Object presflag, carelt;
219 carelt = Fcar (elt);
220 /* If it is (if X Y), look at Y. */
221 if (EQ (carelt, Qif)
222 && EQ (Fnthcdr (make_number (3), elt), Qnil))
223 elt = Fnth (make_number (2), elt);
224 /* If it is (when ... Y), look at Y. */
225 else if (EQ (carelt, Qwhen))
227 while (CONSP (XCDR (elt)))
228 elt = XCDR (elt);
229 elt = Fcar (elt);
232 /* If the function call we're looking at
233 is a special preserved one, copy the
234 whole expression for this argument. */
235 if (CONSP (elt))
237 presflag = Fmemq (Fcar (elt), preserved_fns);
238 if (!NILP (presflag))
239 Fsetcar (valtail, Fcar (intail));
247 DEFUN ("call-interactively", Fcall_interactively, Scall_interactively, 1, 3, 0,
248 doc: /* Call FUNCTION, reading args according to its interactive calling specs.
249 Return the value FUNCTION returns.
250 The function contains a specification of how to do the argument reading.
251 In the case of user-defined functions, this is specified by placing a call
252 to the function `interactive' at the top level of the function body.
253 See `interactive'.
255 Optional second arg RECORD-FLAG non-nil
256 means unconditionally put this command in the command-history.
257 Otherwise, this is done only if an arg is read using the minibuffer.
258 Optional third arg KEYS, if given, specifies the sequence of events to
259 supply if the command inquires which events were used to invoke it. */)
260 (function, record_flag, keys)
261 Lisp_Object function, record_flag, keys;
263 Lisp_Object *args, *visargs;
264 unsigned char **argstrings;
265 Lisp_Object fun;
266 Lisp_Object funcar;
267 Lisp_Object specs;
268 Lisp_Object filter_specs;
269 Lisp_Object teml;
270 Lisp_Object enable;
271 int speccount = SPECPDL_INDEX ();
273 /* The index of the next element of this_command_keys to examine for
274 the 'e' interactive code. */
275 int next_event;
277 Lisp_Object prefix_arg;
278 unsigned char *string;
279 unsigned char *tem;
281 /* If varies[i] > 0, the i'th argument shouldn't just have its value
282 in this call quoted in the command history. It should be
283 recorded as a call to the function named callint_argfuns[varies[i]]. */
284 int *varies;
286 register int i, j;
287 int count, foo;
288 char prompt1[100];
289 char *tem1;
290 int arg_from_tty = 0;
291 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
292 int key_count;
293 int record_then_fail = 0;
295 Lisp_Object save_this_command, save_last_command;
296 Lisp_Object save_this_original_command, save_real_this_command;
298 save_this_command = Vthis_command;
299 save_this_original_command = Vthis_original_command;
300 save_real_this_command = real_this_command;
301 save_last_command = current_kboard->Vlast_command;
303 if (NILP (keys))
304 keys = this_command_keys, key_count = this_command_key_count;
305 else
307 CHECK_VECTOR (keys);
308 key_count = XVECTOR (keys)->size;
311 /* Save this now, since use of minibuffer will clobber it. */
312 prefix_arg = Vcurrent_prefix_arg;
314 retry:
316 if (SYMBOLP (function))
317 enable = Fget (function, Qenable_recursive_minibuffers);
318 else
319 enable = Qnil;
321 fun = indirect_function (function);
323 specs = Qnil;
324 string = 0;
325 /* The idea of FILTER_SPECS is to provide away to
326 specify how to represent the arguments in command history.
327 The feature is not fully implemented. */
328 filter_specs = Qnil;
330 /* Decode the kind of function. Either handle it and return,
331 or go to `lose' if not interactive, or go to `retry'
332 to specify a different function, or set either STRING or SPECS. */
334 if (SUBRP (fun))
336 string = (unsigned char *) XSUBR (fun)->prompt;
337 if (!string)
339 lose:
340 function = wrong_type_argument (Qcommandp, function);
341 goto retry;
344 else if (COMPILEDP (fun))
346 if ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) <= COMPILED_INTERACTIVE)
347 goto lose;
348 specs = XVECTOR (fun)->contents[COMPILED_INTERACTIVE];
350 else
352 Lisp_Object form;
353 GCPRO2 (function, prefix_arg);
354 form = Finteractive_form (function);
355 UNGCPRO;
356 if (CONSP (form))
357 specs = filter_specs = Fcar (XCDR (form));
358 else
359 goto lose;
362 /* If either SPECS or STRING is set to a string, use it. */
363 if (STRINGP (specs))
365 /* Make a copy of string so that if a GC relocates specs,
366 `string' will still be valid. */
367 string = (unsigned char *) alloca (SBYTES (specs) + 1);
368 bcopy (SDATA (specs), string,
369 SBYTES (specs) + 1);
371 else if (string == 0)
373 Lisp_Object input;
374 i = num_input_events;
375 input = specs;
376 /* Compute the arg values using the user's expression. */
377 GCPRO2 (input, filter_specs);
378 specs = Feval (specs);
379 UNGCPRO;
380 if (i != num_input_events || !NILP (record_flag))
382 /* We should record this command on the command history. */
383 Lisp_Object values;
384 /* Make a copy of the list of values, for the command history,
385 and turn them into things we can eval. */
386 values = quotify_args (Fcopy_sequence (specs));
387 fix_command (input, values);
388 Vcommand_history
389 = Fcons (Fcons (function, values), Vcommand_history);
391 /* Don't keep command history around forever. */
392 if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
394 teml = Fnthcdr (Vhistory_length, Vcommand_history);
395 if (CONSP (teml))
396 XSETCDR (teml, Qnil);
400 Vthis_command = save_this_command;
401 Vthis_original_command = save_this_original_command;
402 real_this_command= save_real_this_command;
403 current_kboard->Vlast_command = save_last_command;
405 single_kboard_state ();
406 return apply1 (function, specs);
409 /* Here if function specifies a string to control parsing the defaults */
411 /* Set next_event to point to the first event with parameters. */
412 for (next_event = 0; next_event < key_count; next_event++)
413 if (EVENT_HAS_PARAMETERS (XVECTOR (keys)->contents[next_event]))
414 break;
416 /* Handle special starting chars `*' and `@'. Also `-'. */
417 /* Note that `+' is reserved for user extensions. */
418 while (1)
420 if (*string == '+')
421 error ("`+' is not used in `interactive' for ordinary commands");
422 else if (*string == '*')
424 string++;
425 if (!NILP (current_buffer->read_only))
427 if (!NILP (record_flag))
429 unsigned char *p = string;
430 while (*p)
432 if (! (*p == 'r' || *p == 'p' || *p == 'P'
433 || *p == '\n'))
434 Fbarf_if_buffer_read_only ();
435 p++;
437 record_then_fail = 1;
439 else
440 Fbarf_if_buffer_read_only ();
443 /* Ignore this for semi-compatibility with Lucid. */
444 else if (*string == '-')
445 string++;
446 else if (*string == '@')
448 Lisp_Object event;
450 event = (next_event < key_count
451 ? XVECTOR (keys)->contents[next_event]
452 : Qnil);
453 if (EVENT_HAS_PARAMETERS (event)
454 && (event = XCDR (event), CONSP (event))
455 && (event = XCAR (event), CONSP (event))
456 && (event = XCAR (event), WINDOWP (event)))
458 if (MINI_WINDOW_P (XWINDOW (event))
459 && ! (minibuf_level > 0 && EQ (event, minibuf_window)))
460 error ("Attempt to select inactive minibuffer window");
462 /* If the current buffer wants to clean up, let it. */
463 if (!NILP (Vmouse_leave_buffer_hook))
464 call1 (Vrun_hooks, Qmouse_leave_buffer_hook);
466 Fselect_window (event, Qnil);
468 string++;
470 else break;
473 /* Count the number of arguments the interactive spec would have
474 us give to the function. */
475 tem = string;
476 for (j = 0; *tem; j++)
478 /* 'r' specifications ("point and mark as 2 numeric args")
479 produce *two* arguments. */
480 if (*tem == 'r') j++;
481 tem = (unsigned char *) index (tem, '\n');
482 if (tem)
483 tem++;
484 else
485 tem = (unsigned char *) "";
487 count = j;
489 args = (Lisp_Object *) alloca ((count + 1) * sizeof (Lisp_Object));
490 visargs = (Lisp_Object *) alloca ((count + 1) * sizeof (Lisp_Object));
491 argstrings = (unsigned char **) alloca ((count + 1) * sizeof (char *));
492 varies = (int *) alloca ((count + 1) * sizeof (int));
494 for (i = 0; i < (count + 1); i++)
496 args[i] = Qnil;
497 visargs[i] = Qnil;
498 varies[i] = 0;
501 GCPRO4 (prefix_arg, function, *args, *visargs);
502 gcpro3.nvars = (count + 1);
503 gcpro4.nvars = (count + 1);
505 if (!NILP (enable))
506 specbind (Qenable_recursive_minibuffers, Qt);
508 tem = string;
509 for (i = 1; *tem; i++)
511 strncpy (prompt1, tem + 1, sizeof prompt1 - 1);
512 prompt1[sizeof prompt1 - 1] = 0;
513 tem1 = (char *) index (prompt1, '\n');
514 if (tem1) *tem1 = 0;
515 /* Fill argstrings with a vector of C strings
516 corresponding to the Lisp strings in visargs. */
517 for (j = 1; j < i; j++)
518 argstrings[j]
519 = (EQ (visargs[j], Qnil)
520 ? (unsigned char *) ""
521 : SDATA (visargs[j]));
523 /* Process the format-string in prompt1, putting the output
524 into callint_message. Make callint_message bigger if necessary.
525 We don't use a buffer on the stack, because the contents
526 need to stay stable for a while. */
527 while (1)
529 int nchars = doprnt (callint_message, callint_message_size,
530 prompt1, (char *)0,
531 j - 1, (char **) argstrings + 1);
532 if (nchars < callint_message_size - 1)
533 break;
534 callint_message_size *= 2;
535 callint_message
536 = (char *) xrealloc (callint_message, callint_message_size);
539 switch (*tem)
541 case 'a': /* Symbol defined as a function */
542 visargs[i] = Fcompleting_read (build_string (callint_message),
543 Vobarray, Qfboundp, Qt,
544 Qnil, Qnil, Qnil, Qnil);
545 /* Passing args[i] directly stimulates compiler bug */
546 teml = visargs[i];
547 args[i] = Fintern (teml, Qnil);
548 break;
550 case 'b': /* Name of existing buffer */
551 args[i] = Fcurrent_buffer ();
552 if (EQ (selected_window, minibuf_window))
553 args[i] = Fother_buffer (args[i], Qnil, Qnil);
554 args[i] = Fread_buffer (build_string (callint_message), args[i], Qt);
555 break;
557 case 'B': /* Name of buffer, possibly nonexistent */
558 args[i] = Fread_buffer (build_string (callint_message),
559 Fother_buffer (Fcurrent_buffer (), Qnil, Qnil),
560 Qnil);
561 break;
563 case 'c': /* Character */
564 args[i] = Fread_char (build_string (callint_message), Qnil);
565 message1_nolog ((char *) 0);
566 /* Passing args[i] directly stimulates compiler bug */
567 teml = args[i];
568 visargs[i] = Fchar_to_string (teml);
569 break;
571 case 'C': /* Command: symbol with interactive function */
572 visargs[i] = Fcompleting_read (build_string (callint_message),
573 Vobarray, Qcommandp,
574 Qt, Qnil, Qnil, Qnil, Qnil);
575 /* Passing args[i] directly stimulates compiler bug */
576 teml = visargs[i];
577 args[i] = Fintern (teml, Qnil);
578 break;
580 case 'd': /* Value of point. Does not do I/O. */
581 set_marker_both (point_marker, Qnil, PT, PT_BYTE);
582 args[i] = point_marker;
583 /* visargs[i] = Qnil; */
584 varies[i] = 1;
585 break;
587 case 'D': /* Directory name. */
588 args[i] = Fread_file_name (build_string (callint_message), Qnil,
589 current_buffer->directory, Qlambda, Qnil,
590 Qfile_directory_p);
591 break;
593 case 'f': /* Existing file name. */
594 args[i] = Fread_file_name (build_string (callint_message),
595 Qnil, Qnil, Qlambda, Qnil, Qnil);
596 break;
598 case 'F': /* Possibly nonexistent file name. */
599 args[i] = Fread_file_name (build_string (callint_message),
600 Qnil, Qnil, Qnil, Qnil, Qnil);
601 break;
603 case 'i': /* Ignore an argument -- Does not do I/O */
604 varies[i] = -1;
605 break;
607 case 'k': /* Key sequence. */
609 int speccount1 = SPECPDL_INDEX ();
610 specbind (Qcursor_in_echo_area, Qt);
611 args[i] = Fread_key_sequence (build_string (callint_message),
612 Qnil, Qnil, Qnil, Qnil);
613 unbind_to (speccount1, Qnil);
614 teml = args[i];
615 visargs[i] = Fkey_description (teml, Qnil);
617 /* If the key sequence ends with a down-event,
618 discard the following up-event. */
619 teml = Faref (args[i], make_number (XINT (Flength (args[i])) - 1));
620 if (CONSP (teml))
621 teml = XCAR (teml);
622 if (SYMBOLP (teml))
624 Lisp_Object tem2;
626 teml = Fget (teml, intern ("event-symbol-elements"));
627 /* Ignore first element, which is the base key. */
628 tem2 = Fmemq (intern ("down"), Fcdr (teml));
629 if (! NILP (tem2))
630 Fread_event (Qnil, Qnil);
633 break;
635 case 'K': /* Key sequence to be defined. */
637 int speccount1 = SPECPDL_INDEX ();
638 specbind (Qcursor_in_echo_area, Qt);
639 args[i] = Fread_key_sequence (build_string (callint_message),
640 Qnil, Qt, Qnil, Qnil);
641 teml = args[i];
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));
648 if (CONSP (teml))
649 teml = XCAR (teml);
650 if (SYMBOLP (teml))
652 Lisp_Object tem2;
654 teml = Fget (teml, intern ("event-symbol-elements"));
655 /* Ignore first element, which is the base key. */
656 tem2 = Fmemq (intern ("down"), Fcdr (teml));
657 if (! NILP (tem2))
658 Fread_event (Qnil, Qnil);
661 break;
663 case 'e': /* The invoking event. */
664 if (next_event >= key_count)
665 error ("%s must be bound to an event with parameters",
666 (SYMBOLP (function)
667 ? (char *) SDATA (SYMBOL_NAME (function))
668 : "command"));
669 args[i] = XVECTOR (keys)->contents[next_event++];
670 varies[i] = -1;
672 /* Find the next parameterized event. */
673 while (next_event < key_count
674 && ! (EVENT_HAS_PARAMETERS
675 (XVECTOR (keys)->contents[next_event])))
676 next_event++;
678 break;
680 case 'm': /* Value of mark. Does not do I/O. */
681 check_mark (0);
682 /* visargs[i] = Qnil; */
683 args[i] = current_buffer->mark;
684 varies[i] = 2;
685 break;
687 case 'M': /* String read via minibuffer with
688 inheriting the current input method. */
689 args[i] = Fread_string (build_string (callint_message),
690 Qnil, Qnil, Qnil, Qt);
691 break;
693 case 'N': /* Prefix arg, else number from minibuffer */
694 if (!NILP (prefix_arg))
695 goto have_prefix_arg;
696 case 'n': /* Read number from minibuffer. */
698 int first = 1;
701 Lisp_Object tem;
702 if (! first)
704 message ("Please enter a number.");
705 sit_for (1, 0, 0, 0, 0);
707 first = 0;
709 tem = Fread_from_minibuffer (build_string (callint_message),
710 Qnil, Qnil, Qnil, Qnil, Qnil,
711 Qnil);
712 if (! STRINGP (tem) || SCHARS (tem) == 0)
713 args[i] = Qnil;
714 else
715 args[i] = Fread (tem);
717 while (! NUMBERP (args[i]));
719 visargs[i] = last_minibuf_string;
720 break;
722 case 'P': /* Prefix arg in raw form. Does no I/O. */
723 args[i] = prefix_arg;
724 /* visargs[i] = Qnil; */
725 varies[i] = -1;
726 break;
728 case 'p': /* Prefix arg converted to number. No I/O. */
729 have_prefix_arg:
730 args[i] = Fprefix_numeric_value (prefix_arg);
731 /* visargs[i] = Qnil; */
732 varies[i] = -1;
733 break;
735 case 'r': /* Region, point and mark as 2 args. */
736 check_mark (1);
737 set_marker_both (point_marker, Qnil, PT, PT_BYTE);
738 /* visargs[i+1] = Qnil; */
739 foo = marker_position (current_buffer->mark);
740 /* visargs[i] = Qnil; */
741 args[i] = PT < foo ? point_marker : current_buffer->mark;
742 varies[i] = 3;
743 args[++i] = PT > foo ? point_marker : current_buffer->mark;
744 varies[i] = 4;
745 break;
747 case 's': /* String read via minibuffer without
748 inheriting the current input method. */
749 args[i] = Fread_string (build_string (callint_message),
750 Qnil, Qnil, Qnil, Qnil);
751 break;
753 case 'S': /* Any symbol. */
754 visargs[i] = Fread_string (build_string (callint_message),
755 Qnil, Qnil, Qnil, Qnil);
756 /* Passing args[i] directly stimulates compiler bug */
757 teml = visargs[i];
758 args[i] = Fintern (teml, Qnil);
759 break;
761 case 'v': /* Variable name: symbol that is
762 user-variable-p. */
763 args[i] = Fread_variable (build_string (callint_message), Qnil);
764 visargs[i] = last_minibuf_string;
765 break;
767 case 'x': /* Lisp expression read but not evaluated */
768 args[i] = Fread_minibuffer (build_string (callint_message), Qnil);
769 visargs[i] = last_minibuf_string;
770 break;
772 case 'X': /* Lisp expression read and evaluated */
773 args[i] = Feval_minibuffer (build_string (callint_message), Qnil);
774 visargs[i] = last_minibuf_string;
775 break;
777 case 'Z': /* Coding-system symbol, or ignore the
778 argument if no prefix */
779 if (NILP (prefix_arg))
781 args[i] = Qnil;
782 varies[i] = -1;
784 else
786 args[i]
787 = Fread_non_nil_coding_system (build_string (callint_message));
788 visargs[i] = last_minibuf_string;
790 break;
792 case 'z': /* Coding-system symbol or nil */
793 args[i] = Fread_coding_system (build_string (callint_message), Qnil);
794 visargs[i] = last_minibuf_string;
795 break;
797 /* We have a case for `+' so we get an error
798 if anyone tries to define one here. */
799 case '+':
800 default:
801 error ("Invalid control letter `%c' (%03o) in interactive calling string",
802 *tem, *tem);
805 if (varies[i] == 0)
806 arg_from_tty = 1;
808 if (NILP (visargs[i]) && STRINGP (args[i]))
809 visargs[i] = args[i];
811 tem = (unsigned char *) index (tem, '\n');
812 if (tem) tem++;
813 else tem = (unsigned char *) "";
815 unbind_to (speccount, Qnil);
817 QUIT;
819 args[0] = function;
821 if (arg_from_tty || !NILP (record_flag))
823 visargs[0] = function;
824 for (i = 1; i < count + 1; i++)
826 if (varies[i] > 0)
827 visargs[i] = Fcons (intern (callint_argfuns[varies[i]]), Qnil);
828 else
829 visargs[i] = quotify_arg (args[i]);
831 Vcommand_history = Fcons (Flist (count + 1, visargs),
832 Vcommand_history);
833 /* Don't keep command history around forever. */
834 if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
836 teml = Fnthcdr (Vhistory_length, Vcommand_history);
837 if (CONSP (teml))
838 XSETCDR (teml, Qnil);
842 /* If we used a marker to hold point, mark, or an end of the region,
843 temporarily, convert it to an integer now. */
844 for (i = 1; i <= count; i++)
845 if (varies[i] >= 1 && varies[i] <= 4)
846 XSETINT (args[i], marker_position (args[i]));
848 if (record_then_fail)
849 Fbarf_if_buffer_read_only ();
851 Vthis_command = save_this_command;
852 Vthis_original_command = save_this_original_command;
853 real_this_command= save_real_this_command;
854 current_kboard->Vlast_command = save_last_command;
856 single_kboard_state ();
859 Lisp_Object val;
860 specbind (Qcommand_debug_status, Qnil);
862 val = Ffuncall (count + 1, args);
863 UNGCPRO;
864 return unbind_to (speccount, val);
868 DEFUN ("prefix-numeric-value", Fprefix_numeric_value, Sprefix_numeric_value,
869 1, 1, 0,
870 doc: /* Return numeric meaning of raw prefix argument RAW.
871 A raw prefix argument is what you get from `(interactive "P")'.
872 Its numeric meaning is what you would get from `(interactive "p")'. */)
873 (raw)
874 Lisp_Object raw;
876 Lisp_Object val;
878 if (NILP (raw))
879 XSETFASTINT (val, 1);
880 else if (EQ (raw, Qminus))
881 XSETINT (val, -1);
882 else if (CONSP (raw) && INTEGERP (XCAR (raw)))
883 XSETINT (val, XINT (XCAR (raw)));
884 else if (INTEGERP (raw))
885 val = raw;
886 else
887 XSETFASTINT (val, 1);
889 return val;
892 void
893 syms_of_callint ()
895 point_marker = Fmake_marker ();
896 staticpro (&point_marker);
898 preserved_fns = Fcons (intern ("region-beginning"),
899 Fcons (intern ("region-end"),
900 Fcons (intern ("point"),
901 Fcons (intern ("mark"), Qnil))));
902 staticpro (&preserved_fns);
904 Qlist = intern ("list");
905 staticpro (&Qlist);
906 Qlet = intern ("let");
907 staticpro (&Qlet);
908 Qif = intern ("if");
909 staticpro (&Qif);
910 Qwhen = intern ("when");
911 staticpro (&Qwhen);
912 Qletx = intern ("let*");
913 staticpro (&Qletx);
914 Qsave_excursion = intern ("save-excursion");
915 staticpro (&Qsave_excursion);
916 Qprogn = intern ("progn");
917 staticpro (&Qprogn);
919 Qminus = intern ("-");
920 staticpro (&Qminus);
922 Qplus = intern ("+");
923 staticpro (&Qplus);
925 Qcall_interactively = intern ("call-interactively");
926 staticpro (&Qcall_interactively);
928 Qcommand_debug_status = intern ("command-debug-status");
929 staticpro (&Qcommand_debug_status);
931 Qenable_recursive_minibuffers = intern ("enable-recursive-minibuffers");
932 staticpro (&Qenable_recursive_minibuffers);
934 Qmouse_leave_buffer_hook = intern ("mouse-leave-buffer-hook");
935 staticpro (&Qmouse_leave_buffer_hook);
937 callint_message_size = 100;
938 callint_message = (char *) xmalloc (callint_message_size);
941 DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
942 doc: /* The value of the prefix argument for the next editing command.
943 It may be a number, or the symbol `-' for just a minus sign as arg,
944 or a list whose car is a number for just one or more C-u's
945 or nil if no argument has been specified.
947 You cannot examine this variable to find the argument for this command
948 since it has been set to nil by the time you can look.
949 Instead, you should use the variable `current-prefix-arg', although
950 normally commands can get this prefix argument with (interactive "P"). */);
952 DEFVAR_KBOARD ("last-prefix-arg", Vlast_prefix_arg,
953 doc: /* The value of the prefix argument for the previous editing command.
954 See `prefix-arg' for the meaning of the value. */);
956 DEFVAR_LISP ("current-prefix-arg", &Vcurrent_prefix_arg,
957 doc: /* The value of the prefix argument for this editing command.
958 It may be a number, or the symbol `-' for just a minus sign as arg,
959 or a list whose car is a number for just one or more C-u's
960 or nil if no argument has been specified.
961 This is what `(interactive \"P\")' returns. */);
962 Vcurrent_prefix_arg = Qnil;
964 DEFVAR_LISP ("command-history", &Vcommand_history,
965 doc: /* List of recent commands that read arguments from terminal.
966 Each command is represented as a form to evaluate. */);
967 Vcommand_history = Qnil;
969 DEFVAR_LISP ("command-debug-status", &Vcommand_debug_status,
970 doc: /* Debugging status of current interactive command.
971 Bound each time `call-interactively' is called;
972 may be set by the debugger as a reminder for itself. */);
973 Vcommand_debug_status = Qnil;
975 DEFVAR_LISP ("mark-even-if-inactive", &Vmark_even_if_inactive,
976 doc: /* *Non-nil means you can use the mark even when inactive.
977 This option makes a difference in Transient Mark mode.
978 When the option is non-nil, deactivation of the mark
979 turns off region highlighting, but commands that use the mark
980 behave as if the mark were still active. */);
981 Vmark_even_if_inactive = Qnil;
983 DEFVAR_LISP ("mouse-leave-buffer-hook", &Vmouse_leave_buffer_hook,
984 doc: /* Hook to run when about to switch windows with a mouse command.
985 Its purpose is to give temporary modes such as Isearch mode
986 a way to turn themselves off when a mouse command switches windows. */);
987 Vmouse_leave_buffer_hook = Qnil;
989 defsubr (&Sinteractive);
990 defsubr (&Scall_interactively);
991 defsubr (&Sprefix_numeric_value);
994 /* arch-tag: a3a7cad7-bcac-42ce-916e-1bd2546ebf37
995 (do not change this comment) */