X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/7a983715c8799d68773caa7b760b89a6d584a28f..25d2f683b3e5c624f23fb395fcf96e7c3b21a03e:/src/callint.c diff --git a/src/callint.c b/src/callint.c index 59b207c3a1..6e835d51b1 100644 --- a/src/callint.c +++ b/src/callint.c @@ -1,5 +1,6 @@ /* Call a Lisp function interactively. - Copyright (C) 1985, 86, 93, 94, 95, 1997 Free Software Foundation, Inc. + Copyright (C) 1985, 86, 93, 94, 95, 1997, 2000 + Free Software Foundation, Inc. This file is part of GNU Emacs. @@ -20,14 +21,17 @@ Boston, MA 02111-1307, USA. */ #include + #include "lisp.h" #include "buffer.h" #include "commands.h" #include "keyboard.h" #include "window.h" -#include "mocklisp.h" +#include "keymap.h" -extern char *index (); +#ifdef HAVE_INDEX +extern char *index P_ ((const char *, int)); +#endif extern Lisp_Object Qcursor_in_echo_area; @@ -58,72 +62,67 @@ static char *callint_message; /* Allocated length of that buffer. */ static int callint_message_size; -/* This comment supplies the doc string for interactive, - for make-docfile to see. We cannot put this in the real DEFUN - due to limits in the Unix cpp. - -DEFUN ("interactive", Ffoo, Sfoo, 0, 0, 0, - "Specify a way of parsing arguments for interactive use of a function.\n\ -For example, write\n\ - (defun foo (arg) \"Doc string\" (interactive \"p\") ...use arg...)\n\ -to make ARG be the prefix argument when `foo' is called as a command.\n\ -The \"call\" to `interactive' is actually a declaration rather than a function;\n\ - it tells `call-interactively' how to read arguments\n\ - to pass to the function.\n\ -When actually called, `interactive' just returns nil.\n\ -\n\ -The argument of `interactive' is usually a string containing a code letter\n\ - followed by a prompt. (Some code letters do not use I/O to get\n\ - the argument and do not need prompts.) To prompt for multiple arguments,\n\ - give a code letter, its prompt, a newline, and another code letter, etc.\n\ - Prompts are passed to format, and may use % escapes to print the\n\ - arguments that have already been read.\n\ -If the argument is not a string, it is evaluated to get a list of\n\ - arguments to pass to the function.\n\ -Just `(interactive)' means pass no args when calling interactively.\n\ -\nCode letters available are:\n\ -a -- Function name: symbol with a function definition.\n\ -b -- Name of existing buffer.\n\ -B -- Name of buffer, possibly nonexistent.\n\ -c -- Character.\n\ -C -- Command name: symbol with interactive function definition.\n\ -d -- Value of point as number. Does not do I/O.\n\ -D -- Directory name.\n\ -e -- Parametrized event (i.e., one that's a list) that invoked this command.\n\ - If used more than once, the Nth `e' returns the Nth parameterized event.\n\ - This skips events that are integers or symbols.\n\ -f -- Existing file name.\n\ -F -- Possibly nonexistent file name.\n\ -i -- Ignored, i.e. always nil. Does not do I/O.\n\ -k -- Key sequence (downcase the last event if needed to get a definition).\n\ -K -- Key sequence to be redefined (do not downcase the last event).\n\ -m -- Value of mark as number. Does not do I/O.\n\ -M -- Any string. Inherits the current input method.\n\ -n -- Number read using minibuffer.\n\ -N -- Raw prefix arg, or if none, do like code `n'.\n\ -p -- Prefix arg converted to number. Does not do I/O.\n\ -P -- Prefix arg in raw form. Does not do I/O.\n\ -r -- Region: point and mark as 2 numeric args, smallest first. Does no I/O.\n\ -s -- Any string. Does not inherit the current input method.\n\ -S -- Any symbol.\n\ -v -- Variable name: symbol that is user-variable-p.\n\ -x -- Lisp expression read but not evaluated.\n\ -X -- Lisp expression read and evaluated.\n\ -z -- Coding system.\n\ -Z -- Coding system, nil if no prefix arg.\n\ -In addition, if the string begins with `*'\n\ - then an error is signaled if the buffer is read-only.\n\ - This happens before reading any arguments.\n\ -If the string begins with `@', then Emacs searches the key sequence\n\ - which invoked the command for its first mouse click (or any other\n\ - event which specifies a window), and selects that window before\n\ - reading any arguments. You may use both `@' and `*'; they are\n\ - processed in the order that they appear." */ - /* ARGSUSED */ DEFUN ("interactive", Finteractive, Sinteractive, 0, UNEVALLED, 0, - 0 /* See immediately above */) - (args) + doc: /* Specify a way of parsing arguments for interactive use of a function. +For example, write + (defun foo (arg) "Doc string" (interactive "p") ...use arg...) +to make ARG be the prefix argument when `foo' is called as a command. +The "call" to `interactive' is actually a declaration rather than a function; + it tells `call-interactively' how to read arguments + to pass to the function. +When actually called, `interactive' just returns nil. + +The argument of `interactive' is usually a string containing a code letter + followed by a prompt. (Some code letters do not use I/O to get + the argument and do not need prompts.) To prompt for multiple arguments, + give a code letter, its prompt, a newline, and another code letter, etc. + Prompts are passed to format, and may use % escapes to print the + arguments that have already been read. +If the argument is not a string, it is evaluated to get a list of + arguments to pass to the function. +Just `(interactive)' means pass no args when calling interactively. + +Code letters available are: +a -- Function name: symbol with a function definition. +b -- Name of existing buffer. +B -- Name of buffer, possibly nonexistent. +c -- Character (no input method is used). +C -- Command name: symbol with interactive function definition. +d -- Value of point as number. Does not do I/O. +D -- Directory name. +e -- Parametrized event (i.e., one that's a list) that invoked this command. + If used more than once, the Nth `e' returns the Nth parameterized event. + This skips events that are integers or symbols. +f -- Existing file name. +F -- Possibly nonexistent file name. +i -- Ignored, i.e. always nil. Does not do I/O. +k -- Key sequence (downcase the last event if needed to get a definition). +K -- Key sequence to be redefined (do not downcase the last event). +m -- Value of mark as number. Does not do I/O. +M -- Any string. Inherits the current input method. +n -- Number read using minibuffer. +N -- Raw prefix arg, or if none, do like code `n'. +p -- Prefix arg converted to number. Does not do I/O. +P -- Prefix arg in raw form. Does not do I/O. +r -- Region: point and mark as 2 numeric args, smallest first. Does no I/O. +s -- Any string. Does not inherit the current input method. +S -- Any symbol. +v -- Variable name: symbol that is user-variable-p. +x -- Lisp expression read but not evaluated. +X -- Lisp expression read and evaluated. +z -- Coding system. +Z -- Coding system, nil if no prefix arg. +In addition, if the string begins with `*' + then an error is signaled if the buffer is read-only. + This happens before reading any arguments. +If the string begins with `@', then Emacs searches the key sequence + which invoked the command for its first mouse click (or any other + event which specifies a window), and selects that window before + reading any arguments. You may use both `@' and `*'; they are + processed in the order that they appear. +usage: (interactive ARGS) */) + (args) Lisp_Object args; { return Qnil; @@ -148,11 +147,11 @@ quotify_args (exp) Lisp_Object exp; { register Lisp_Object tail; - register struct Lisp_Cons *ptr; - for (tail = exp; CONSP (tail); tail = ptr->cdr) + Lisp_Object next; + for (tail = exp; CONSP (tail); tail = next) { - ptr = XCONS (tail); - ptr->car = quotify_arg (ptr->car); + next = XCDR (tail); + XSETCAR (tail, quotify_arg (XCAR (tail))); } return exp; } @@ -174,17 +173,19 @@ check_mark () DEFUN ("call-interactively", Fcall_interactively, Scall_interactively, 1, 3, 0, - "Call FUNCTION, reading args according to its interactive calling specs.\n\ -Return the value FUNCTION returns.\n\ -The function contains a specification of how to do the argument reading.\n\ -In the case of user-defined functions, this is specified by placing a call\n\ -to the function `interactive' at the top level of the function body.\n\ -See `interactive'.\n\ -\n\ -Optional second arg RECORD-FLAG non-nil\n\ -means unconditionally put this command in the command-history.\n\ -Otherwise, this is done only if an arg is read using the minibuffer.") - (function, record_flag, keys) + doc: /* Call FUNCTION, reading args according to its interactive calling specs. +Return the value FUNCTION returns. +The function contains a specification of how to do the argument reading. +In the case of user-defined functions, this is specified by placing a call +to the function `interactive' at the top level of the function body. +See `interactive'. + +Optional second arg RECORD-FLAG non-nil +means unconditionally put this command in the command-history. +Otherwise, this is done only if an arg is read using the minibuffer. +Optional third arg KEYS, if given, specifies the sequence of events to +supply if the command inquires which events were used to invoke it. */) + (function, record_flag, keys) Lisp_Object function, record_flag, keys; { Lisp_Object *args, *visargs; @@ -221,7 +222,7 @@ Otherwise, this is done only if an arg is read using the minibuffer.") keys = this_command_keys, key_count = this_command_key_count; else { - CHECK_VECTOR (keys, 3); + CHECK_VECTOR (keys); key_count = XVECTOR (keys)->size; } @@ -232,6 +233,8 @@ Otherwise, this is done only if an arg is read using the minibuffer.") if (SYMBOLP (function)) enable = Fget (function, Qenable_recursive_minibuffers); + else + enable = Qnil; fun = indirect_function (function); @@ -251,9 +254,6 @@ Otherwise, this is done only if an arg is read using the minibuffer.") function = wrong_type_argument (Qcommandp, function); goto retry; } - if ((EMACS_INT) string == 1) - /* Let SPECS (which is nil) be used as the args. */ - string = 0; } else if (COMPILEDP (fun)) { @@ -263,7 +263,7 @@ Otherwise, this is done only if an arg is read using the minibuffer.") } else if (!CONSP (fun)) goto lose; - else if (funcar = Fcar (fun), EQ (funcar, Qautoload)) + else if (funcar = XCAR (fun), EQ (funcar, Qautoload)) { GCPRO2 (function, prefix_arg); do_autoload (fun, function); @@ -272,16 +272,11 @@ Otherwise, this is done only if an arg is read using the minibuffer.") } else if (EQ (funcar, Qlambda)) { - specs = Fassq (Qinteractive, Fcdr (Fcdr (fun))); + specs = Fassq (Qinteractive, Fcdr (XCDR (fun))); if (NILP (specs)) goto lose; specs = Fcar (Fcdr (specs)); } - else if (EQ (funcar, Qmocklisp)) - { - single_kboard_state (); - return ml_apply (fun, Qinteractive); - } else goto lose; @@ -314,17 +309,17 @@ Otherwise, this is done only if an arg is read using the minibuffer.") instead of the present values. */ if (CONSP (input)) { - car = XCONS (input)->car; + car = XCAR (input); /* Skip through certain special forms. */ while (EQ (car, Qlet) || EQ (car, Qletx) || EQ (car, Qsave_excursion)) { - while (CONSP (XCONS (input)->cdr)) - input = XCONS (input)->cdr; - input = XCONS (input)->car; + while (CONSP (XCDR (input))) + input = XCDR (input); + input = XCAR (input); if (!CONSP (input)) break; - car = XCONS (input)->car; + car = XCAR (input); } if (EQ (car, Qlist)) { @@ -353,7 +348,7 @@ Otherwise, this is done only if an arg is read using the minibuffer.") { teml = Fnthcdr (Vhistory_length, Vcommand_history); if (CONSP (teml)) - XCONS (teml)->cdr = Qnil; + XSETCDR (teml, Qnil); } } single_kboard_state (); @@ -388,9 +383,9 @@ Otherwise, this is done only if an arg is read using the minibuffer.") event = XVECTOR (keys)->contents[next_event]; if (EVENT_HAS_PARAMETERS (event) - && (event = XCONS (event)->cdr, CONSP (event)) - && (event = XCONS (event)->car, CONSP (event)) - && (event = XCONS (event)->car, WINDOWP (event))) + && (event = XCDR (event), CONSP (event)) + && (event = XCAR (event), CONSP (event)) + && (event = XCAR (event), WINDOWP (event))) { if (MINI_WINDOW_P (XWINDOW (event)) && ! (minibuf_level > 0 && EQ (event, minibuf_window))) @@ -447,7 +442,7 @@ Otherwise, this is done only if an arg is read using the minibuffer.") { strncpy (prompt1, tem + 1, sizeof prompt1 - 1); prompt1[sizeof prompt1 - 1] = 0; - tem1 = index (prompt1, '\n'); + tem1 = (char *) index (prompt1, '\n'); if (tem1) *tem1 = 0; /* Fill argstrings with a vector of C strings corresponding to the Lisp strings in visargs. */ @@ -554,13 +549,14 @@ Otherwise, this is done only if an arg is read using the minibuffer.") discard the following up-event. */ teml = Faref (args[i], make_number (XINT (Flength (args[i])) - 1)); if (CONSP (teml)) - teml = XCONS (teml)->car; + teml = XCAR (teml); if (SYMBOLP (teml)) { Lisp_Object tem2; teml = Fget (teml, intern ("event-symbol-elements")); - tem2 = Fmemq (intern ("down"), teml); + /* Ignore first element, which is the base key. */ + tem2 = Fmemq (intern ("down"), Fcdr (teml)); if (! NILP (tem2)) Fread_event (Qnil, Qnil); } @@ -581,13 +577,14 @@ Otherwise, this is done only if an arg is read using the minibuffer.") discard the following up-event. */ teml = Faref (args[i], make_number (XINT (Flength (args[i])) - 1)); if (CONSP (teml)) - teml = XCONS (teml)->car; + teml = XCAR (teml); if (SYMBOLP (teml)) { Lisp_Object tem2; teml = Fget (teml, intern ("event-symbol-elements")); - tem2 = Fmemq (intern ("down"), teml); + /* Ignore first element, which is the base key. */ + tem2 = Fmemq (intern ("down"), Fcdr (teml)); if (! NILP (tem2)) Fread_event (Qnil, Qnil); } @@ -769,7 +766,7 @@ Otherwise, this is done only if an arg is read using the minibuffer.") { teml = Fnthcdr (Vhistory_length, Vcommand_history); if (CONSP (teml)) - XCONS (teml)->cdr = Qnil; + XSETCDR (teml, Qnil); } } @@ -792,11 +789,11 @@ Otherwise, this is done only if an arg is read using the minibuffer.") } DEFUN ("prefix-numeric-value", Fprefix_numeric_value, Sprefix_numeric_value, - 1, 1, 0, - "Return numeric meaning of raw prefix argument RAW.\n\ -A raw prefix argument is what you get from `(interactive \"P\")'.\n\ -Its numeric meaning is what you would get from `(interactive \"p\")'.") - (raw) + 1, 1, 0, + doc: /* Return numeric meaning of raw prefix argument RAW. +A raw prefix argument is what you get from `(interactive "P")'. +Its numeric meaning is what you would get from `(interactive "p")'. */) + (raw) Lisp_Object raw; { Lisp_Object val; @@ -805,8 +802,8 @@ Its numeric meaning is what you would get from `(interactive \"p\")'.") XSETFASTINT (val, 1); else if (EQ (raw, Qminus)) XSETINT (val, -1); - else if (CONSP (raw) && INTEGERP (XCONS (raw)->car)) - XSETINT (val, XINT (XCONS (raw)->car)); + else if (CONSP (raw) && INTEGERP (XCAR (raw))) + XSETINT (val, XINT (XCAR (raw))); else if (INTEGERP (raw)) val = raw; else @@ -859,51 +856,51 @@ syms_of_callint () DEFVAR_KBOARD ("prefix-arg", Vprefix_arg, - "The value of the prefix argument for the next editing command.\n\ -It may be a number, or the symbol `-' for just a minus sign as arg,\n\ -or a list whose car is a number for just one or more C-U's\n\ -or nil if no argument has been specified.\n\ -\n\ -You cannot examine this variable to find the argument for this command\n\ -since it has been set to nil by the time you can look.\n\ -Instead, you should use the variable `current-prefix-arg', although\n\ -normally commands can get this prefix argument with (interactive \"P\")."); + doc: /* The value of the prefix argument for the next editing command. +It may be a number, or the symbol `-' for just a minus sign as arg, +or a list whose car is a number for just one or more C-u's +or nil if no argument has been specified. + +You cannot examine this variable to find the argument for this command +since it has been set to nil by the time you can look. +Instead, you should use the variable `current-prefix-arg', although +normally commands can get this prefix argument with (interactive "P"). */); DEFVAR_KBOARD ("last-prefix-arg", Vlast_prefix_arg, - "The value of the prefix argument for the previous editing command.\n\ -See `prefix-arg' for the meaning of the value."); + doc: /* The value of the prefix argument for the previous editing command. +See `prefix-arg' for the meaning of the value. */); DEFVAR_LISP ("current-prefix-arg", &Vcurrent_prefix_arg, - "The value of the prefix argument for this editing command.\n\ -It may be a number, or the symbol `-' for just a minus sign as arg,\n\ -or a list whose car is a number for just one or more C-U's\n\ -or nil if no argument has been specified.\n\ -This is what `(interactive \"P\")' returns."); + doc: /* The value of the prefix argument for this editing command. +It may be a number, or the symbol `-' for just a minus sign as arg, +or a list whose car is a number for just one or more C-u's +or nil if no argument has been specified. +This is what `(interactive \"P\")' returns. */); Vcurrent_prefix_arg = Qnil; DEFVAR_LISP ("command-history", &Vcommand_history, - "List of recent commands that read arguments from terminal.\n\ -Each command is represented as a form to evaluate."); + doc: /* List of recent commands that read arguments from terminal. +Each command is represented as a form to evaluate. */); Vcommand_history = Qnil; DEFVAR_LISP ("command-debug-status", &Vcommand_debug_status, - "Debugging status of current interactive command.\n\ -Bound each time `call-interactively' is called;\n\ -may be set by the debugger as a reminder for itself."); + doc: /* Debugging status of current interactive command. +Bound each time `call-interactively' is called; +may be set by the debugger as a reminder for itself. */); Vcommand_debug_status = Qnil; DEFVAR_LISP ("mark-even-if-inactive", &Vmark_even_if_inactive, - "*Non-nil means you can use the mark even when inactive.\n\ -This option makes a difference in Transient Mark mode.\n\ -When the option is non-nil, deactivation of the mark\n\ -turns off region highlighting, but commands that use the mark\n\ -behave as if the mark were still active."); + doc: /* *Non-nil means you can use the mark even when inactive. +This option makes a difference in Transient Mark mode. +When the option is non-nil, deactivation of the mark +turns off region highlighting, but commands that use the mark +behave as if the mark were still active. */); Vmark_even_if_inactive = Qnil; DEFVAR_LISP ("mouse-leave-buffer-hook", &Vmouse_leave_buffer_hook, - "Hook to run when about to switch windows with a mouse command.\n\ -Its purpose is to give temporary modes such as Isearch mode\n\ -a way to turn themselves off when a mouse command switches windows."); + doc: /* Hook to run when about to switch windows with a mouse command. +Its purpose is to give temporary modes such as Isearch mode +a way to turn themselves off when a mouse command switches windows. */); Vmouse_leave_buffer_hook = Qnil; defsubr (&Sinteractive);