xemacs-beta: src/eval.c comparison

comparison src/eval.c @ 4693:80cd90837ac5

Add argument information to remaining MANY or UNEVALLED C subrs. src/ChangeLog addition: 2009-09-20 Aidan Kehoe <kehoea@parhasard.net> * alloc.c (Flist): (Fvector): (Fbit_vector): (Fmake_byte_code): (Fstring): * data.c (Feqlsign): (Flss): (Fgtr): (Fleq): (Fgeq): (Fneq): (Fgtr): (Fplus): (Fminus): (Ftimes): (Fdiv): (Fquo): (Fmax): (Fmin): (Flogand): (Flogior): (Flogxor): * editfns.c (Fsave_excursion): (Fsave_current_buffer): (Fencode_time): (Finsert): (Finsert_before_markers): (Fsave_restriction): (Fformat): * elhash.c (Fmake_hash_table): * eval.c (Fdefun): (Fdefmacro): (Fcatch): (Funwind_protect): (Fcall_with_condition_handler): (Ffuncall): (Fapply): (Frun_hooks): * fns.c (Fappend): (Fconcat): (Fvconcat): (Fbvconcat): (Fnconc): * print.c (Fwith_output_to_temp_buffer): * process.c (Fstart_process_internal): * window.c (Fsave_window_excursion): * widget.c (Fwidget_apply): Add argument information, in a form understood by #'function-arglist, to all these MANY or UNEVALLED (that is to say, special-operator) built-in functions.

author	Aidan Kehoe <kehoea@parhasard.net>
date	Sun, 20 Sep 2009 21:29:00 +0100
parents	cdabd56ce1b5
children	17f7e9191c0b

comparison

equal deleted inserted replaced

-:dc3c2f298857
+:80cd90837ac5
 LOADHIST_ATTACH (Fcons (Qdefun, name));
 return name;
 }
 DEFUN ("defun", Fdefun, 2, UNEVALLED, 0, /*
-\(defun NAME ARGLIST [DOCSTRING] BODY...): define NAME as a function.
+Define NAME as a function.
 The definition is (lambda ARGLIST [DOCSTRING] BODY...).
 See also the function `interactive'.
+arguments: (NAME ARGLIST &optional DOCSTRING &rest BODY)
 */
 (args))
 {
 /* This function can GC */
 return define_function (XCAR (args),
 			  Fcons (Qlambda, XCDR (args)));
 }
 DEFUN ("defmacro", Fdefmacro, 2, UNEVALLED, 0, /*
-\(defmacro NAME ARGLIST [DOCSTRING] BODY...): define NAME as a macro.
+Define NAME as a macro.
 The definition is (macro lambda ARGLIST [DOCSTRING] BODY...).
 When the macro is called, as in (NAME ARGS...),
 the function (lambda ARGLIST BODY...) is applied to
 the list ARGS... as it appears in the expression,
 and the result should be a form to be evaluated instead of the original.
+arguments: (NAME ARGLIST &optional DOCSTRING &rest BODY)
 */
 (args))
 {
 /* This function can GC */
 return define_function (XCAR (args),
 }
 #endif /* ERROR_CHECK_TRAPPING_PROBLEMS */
 DEFUN ("catch", Fcatch, 1, UNEVALLED, 0, /*
-\(catch TAG BODY...): eval BODY allowing nonlocal exits using `throw'.
+Eval BODY allowing nonlocal exits using `throw'.
 TAG is evalled to get the tag to use.  Then the BODY is executed.
 Within BODY, (throw TAG VAL) with same (`eq') tag exits BODY and this `catch'.
 If no throw happens, `catch' returns the value of the last BODY form.
 If a throw happens, it specifies the value to return from `catch'.
+arguments: (TAG &rest BODY)
 */
 (args))
 {
 /* This function can GC */
 Lisp_Object tag  = Feval (XCAR (args));
 RETURN_NOT_REACHED (Qnil);
 }
 DEFUN ("unwind-protect", Funwind_protect, 1, UNEVALLED, 0, /*
 Do BODYFORM, protecting with UNWINDFORMS.
-Usage looks like (unwind-protect BODYFORM UNWINDFORMS...).
 If BODYFORM completes normally, its value is returned
 after executing the UNWINDFORMS.
 If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.
+arguments: (BODYFORM &rest UNWINDFORMS)
 */
 (args))
 {
 /* This function can GC */
 int speccount = specpdl_depth();
 Lisp_Object handlers = XCDR (XCDR (args));
 return condition_case_3 (bodyform, var, handlers);
 }
 DEFUN ("call-with-condition-handler", Fcall_with_condition_handler, 2, MANY, 0, /*
-Regain control when an error is signalled, without popping the stack.
+Call FUNCTION with arguments ARGS, regaining control on error.
-Usage looks like (call-with-condition-handler HANDLER FUNCTION &rest ARGS).
-This function is similar to `condition-case', but the handler is invoked
+This function is similar to `condition-case', but HANDLER is invoked
 with the same environment (Lisp stack, bindings, catches, condition-cases)
 that was current when `signal' was called, rather than when the handler
 was established.
 HANDLER should be a function of one argument, which is a cons of the args
 `signal' is called (this differs from `condition-case', which allows
 you to specify which errors are trapped).  If the handler function
 returns, `signal' continues as if the handler were never invoked.
 \(It continues to look for handlers established earlier than this one,
 and invokes the standard error-handler if none is found.)
+arguments: (HANDLER FUNCTION &rest ARGS)
 */
 (int nargs, Lisp_Object *args)) /* Note!  Args side-effected! */
 {
 /* This function can GC */
 int speccount = specpdl_depth();
 (Qgarbage_collecting, 2, args, RUN_HOOKS_TO_COMPLETION,
 INHIBIT_QUIT | NO_INHIBIT_ERRORS);
 }
 DEFUN ("funcall", Ffuncall, 1, MANY, 0, /*
-Call first argument as a function, passing the remaining arguments to it.
+Call FUNCTION as a function, passing the remaining arguments to it.
 Thus, (funcall 'cons 'x 'y) returns (x . y).
+arguments: (FUNCTION &rest ARGS)
 */
 (int nargs, Lisp_Object *args))
 {
 /* This function can GC */
 Lisp_Object fun;
 DEFUN ("apply", Fapply, 2, MANY, 0, /*
 Call FUNCTION with the remaining args, using the last arg as a list of args.
 Thus, (apply '+ 1 2 '(3 4)) returns 10.
+arguments: (FUNCTION &rest ARGS)
 */
 (int nargs, Lisp_Object *args))
 {
 /* This function can GC */
 Lisp_Object fun = args[0];
 If it is a list, the elements are called, in order, with no arguments.
 To make a hook variable buffer-local, use `make-local-hook',
 not `make-local-variable'.
-arguments: (&rest HOOKS)
+arguments: (FIRST &rest REST)
 */
 (int nargs, Lisp_Object *args))
 {
 REGISTER int i;

Mercurial > hg > xemacs-beta

comparison src/eval.c @ 4693:80cd90837ac5