diff options
| author | Pavel Janík | 2001-10-31 15:09:35 +0000 |
|---|---|---|
| committer | Pavel Janík | 2001-10-31 15:09:35 +0000 |
| commit | 9dbc908170e8df01173b4a6dad51b7d6d9d4a0d4 (patch) | |
| tree | 8d9ddf4d6e4ed0c01bc02af8faacf1f77dd7dbb6 /src | |
| parent | 4e10df5997b4f146a3c89da92cf7889d09e74b9f (diff) | |
| download | emacs-9dbc908170e8df01173b4a6dad51b7d6d9d4a0d4.tar.gz emacs-9dbc908170e8df01173b4a6dad51b7d6d9d4a0d4.zip | |
(Fcommandp): Doc fix.
Change doc-string comments to `new style' [w/`doc:' keyword].
Diffstat (limited to 'src')
| -rw-r--r-- | src/ChangeLog | 3 | ||||
| -rw-r--r-- | src/eval.c | 692 |
2 files changed, 351 insertions, 344 deletions
diff --git a/src/ChangeLog b/src/ChangeLog index ff4c00548cc..bd88c1cd765 100644 --- a/src/ChangeLog +++ b/src/ChangeLog | |||
| @@ -1,5 +1,8 @@ | |||
| 1 | 2001-10-31 Pavel Jan,Bm(Bk <Pavel@Janik.cz> | 1 | 2001-10-31 Pavel Jan,Bm(Bk <Pavel@Janik.cz> |
| 2 | 2 | ||
| 3 | * eval.c (Fcommandp): Doc fix. | ||
| 4 | Change doc-string comments to `new style' [w/`doc:' keyword]. | ||
| 5 | |||
| 3 | * frame.c (Fframe_live_p): Doc fix. | 6 | * frame.c (Fframe_live_p): Doc fix. |
| 4 | 7 | ||
| 5 | * buffer.c (selective-display-ellipses): Doc fix. | 8 | * buffer.c (selective-display-ellipses): Doc fix. |
diff --git a/src/eval.c b/src/eval.c index 2f87d5fc22c..4390a23a5d5 100644 --- a/src/eval.c +++ b/src/eval.c | |||
| @@ -286,11 +286,11 @@ do_debug_on_call (code) | |||
| 286 | The definition of `For' shows what you have to do. */ | 286 | The definition of `For' shows what you have to do. */ |
| 287 | 287 | ||
| 288 | DEFUN ("or", For, Sor, 0, UNEVALLED, 0, | 288 | DEFUN ("or", For, Sor, 0, UNEVALLED, 0, |
| 289 | "Eval args until one of them yields non-nil, then return that value.\n\ | 289 | doc: /* Eval args until one of them yields non-nil, then return that value. |
| 290 | The remaining args are not evalled at all.\n\ | 290 | The remaining args are not evalled at all. |
| 291 | If all args return nil, return nil.\n\ | 291 | If all args return nil, return nil. |
| 292 | usage: (or CONDITIONS ...)") | 292 | usage: (or CONDITIONS ...) */) |
| 293 | (args) | 293 | (args) |
| 294 | Lisp_Object args; | 294 | Lisp_Object args; |
| 295 | { | 295 | { |
| 296 | register Lisp_Object val; | 296 | register Lisp_Object val; |
| @@ -317,11 +317,11 @@ usage: (or CONDITIONS ...)") | |||
| 317 | } | 317 | } |
| 318 | 318 | ||
| 319 | DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0, | 319 | DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0, |
| 320 | "Eval args until one of them yields nil, then return nil.\n\ | 320 | doc: /* Eval args until one of them yields nil, then return nil. |
| 321 | The remaining args are not evalled at all.\n\ | 321 | The remaining args are not evalled at all. |
| 322 | If no arg yields nil, return the last arg's value.\n\ | 322 | If no arg yields nil, return the last arg's value. |
| 323 | usage: (and CONDITIONS ...)") | 323 | usage: (and CONDITIONS ...) */) |
| 324 | (args) | 324 | (args) |
| 325 | Lisp_Object args; | 325 | Lisp_Object args; |
| 326 | { | 326 | { |
| 327 | register Lisp_Object val; | 327 | register Lisp_Object val; |
| @@ -348,12 +348,12 @@ usage: (and CONDITIONS ...)") | |||
| 348 | } | 348 | } |
| 349 | 349 | ||
| 350 | DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0, | 350 | DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0, |
| 351 | "If COND yields non-nil, do THEN, else do ELSE...\n\ | 351 | doc: /* If COND yields non-nil, do THEN, else do ELSE... |
| 352 | Returns the value of THEN or the value of the last of the ELSE's.\n\ | 352 | Returns the value of THEN or the value of the last of the ELSE's. |
| 353 | THEN must be one expression, but ELSE... can be zero or more expressions.\n\ | 353 | THEN must be one expression, but ELSE... can be zero or more expressions. |
| 354 | If COND yields nil, and there are no ELSE's, the value is nil.\n\ | 354 | If COND yields nil, and there are no ELSE's, the value is nil. |
| 355 | usage: (if COND THEN ELSE...)") | 355 | usage: (if COND THEN ELSE...) */) |
| 356 | (args) | 356 | (args) |
| 357 | Lisp_Object args; | 357 | Lisp_Object args; |
| 358 | { | 358 | { |
| 359 | register Lisp_Object cond; | 359 | register Lisp_Object cond; |
| @@ -369,16 +369,16 @@ usage: (if COND THEN ELSE...)") | |||
| 369 | } | 369 | } |
| 370 | 370 | ||
| 371 | DEFUN ("cond", Fcond, Scond, 0, UNEVALLED, 0, | 371 | DEFUN ("cond", Fcond, Scond, 0, UNEVALLED, 0, |
| 372 | "Try each clause until one succeeds.\n\ | 372 | doc: /* Try each clause until one succeeds. |
| 373 | Each clause looks like (CONDITION BODY...). CONDITION is evaluated\n\ | 373 | Each clause looks like (CONDITION BODY...). CONDITION is evaluated |
| 374 | and, if the value is non-nil, this clause succeeds:\n\ | 374 | and, if the value is non-nil, this clause succeeds: |
| 375 | then the expressions in BODY are evaluated and the last one's\n\ | 375 | then the expressions in BODY are evaluated and the last one's |
| 376 | value is the value of the cond-form.\n\ | 376 | value is the value of the cond-form. |
| 377 | If no clause succeeds, cond returns nil.\n\ | 377 | If no clause succeeds, cond returns nil. |
| 378 | If a clause has one element, as in (CONDITION),\n\ | 378 | If a clause has one element, as in (CONDITION), |
| 379 | CONDITION's value if non-nil is returned from the cond-form.\n\ | 379 | CONDITION's value if non-nil is returned from the cond-form. |
| 380 | usage: (cond CLAUSES...)") | 380 | usage: (cond CLAUSES...) */) |
| 381 | (args) | 381 | (args) |
| 382 | Lisp_Object args; | 382 | Lisp_Object args; |
| 383 | { | 383 | { |
| 384 | register Lisp_Object clause, val; | 384 | register Lisp_Object clause, val; |
| @@ -404,9 +404,9 @@ usage: (cond CLAUSES...)") | |||
| 404 | } | 404 | } |
| 405 | 405 | ||
| 406 | DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0, | 406 | DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0, |
| 407 | "Eval BODY forms sequentially and return value of last one.\n\ | 407 | doc: /* Eval BODY forms sequentially and return value of last one. |
| 408 | usage: (progn BODY ...)") | 408 | usage: (progn BODY ...) */) |
| 409 | (args) | 409 | (args) |
| 410 | Lisp_Object args; | 410 | Lisp_Object args; |
| 411 | { | 411 | { |
| 412 | register Lisp_Object val, tem; | 412 | register Lisp_Object val, tem; |
| @@ -443,11 +443,11 @@ usage: (progn BODY ...)") | |||
| 443 | } | 443 | } |
| 444 | 444 | ||
| 445 | DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0, | 445 | DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0, |
| 446 | "Eval FIRST and BODY sequentially; value from FIRST.\n\ | 446 | doc: /* Eval FIRST and BODY sequentially; value from FIRST. |
| 447 | The value of FIRST is saved during the evaluation of the remaining args,\n\ | 447 | The value of FIRST is saved during the evaluation of the remaining args, |
| 448 | whose values are discarded.\n\ | 448 | whose values are discarded. |
| 449 | usage: (prog1 FIRST BODY...)") | 449 | usage: (prog1 FIRST BODY...) */) |
| 450 | (args) | 450 | (args) |
| 451 | Lisp_Object args; | 451 | Lisp_Object args; |
| 452 | { | 452 | { |
| 453 | Lisp_Object val; | 453 | Lisp_Object val; |
| @@ -477,11 +477,11 @@ usage: (prog1 FIRST BODY...)") | |||
| 477 | } | 477 | } |
| 478 | 478 | ||
| 479 | DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0, | 479 | DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0, |
| 480 | "Eval X, Y and BODY sequentially; value from Y.\n\ | 480 | doc: /* Eval X, Y and BODY sequentially; value from Y. |
| 481 | The value of Y is saved during the evaluation of the remaining args,\n\ | 481 | The value of Y is saved during the evaluation of the remaining args, |
| 482 | whose values are discarded.\n\ | 482 | whose values are discarded. |
| 483 | usage: (prog2 X Y BODY...)") | 483 | usage: (prog2 X Y BODY...) */) |
| 484 | (args) | 484 | (args) |
| 485 | Lisp_Object args; | 485 | Lisp_Object args; |
| 486 | { | 486 | { |
| 487 | Lisp_Object val; | 487 | Lisp_Object val; |
| @@ -513,15 +513,15 @@ usage: (prog2 X Y BODY...)") | |||
| 513 | } | 513 | } |
| 514 | 514 | ||
| 515 | DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0, | 515 | DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0, |
| 516 | "Set each SYM to the value of its VAL.\n\ | 516 | doc: /* Set each SYM to the value of its VAL. |
| 517 | The symbols SYM are variables; they are literal (not evaluated).\n\ | 517 | The symbols SYM are variables; they are literal (not evaluated). |
| 518 | The values VAL are expressions; they are evaluated.\n\ | 518 | The values VAL are expressions; they are evaluated. |
| 519 | Thus, (setq x (1+ y)) sets `x' to the value of `(1+ y)'.\n\ | 519 | Thus, (setq x (1+ y)) sets `x' to the value of `(1+ y)'. |
| 520 | The second VAL is not computed until after the first SYM is set, and so on;\n\ | 520 | The second VAL is not computed until after the first SYM is set, and so on; |
| 521 | each VAL can use the new value of variables set earlier in the `setq'.\n\ | 521 | each VAL can use the new value of variables set earlier in the `setq'. |
| 522 | The return value of the `setq' form is the value of the last VAL.\n\ | 522 | The return value of the `setq' form is the value of the last VAL. |
| 523 | usage: (setq SYM VAL SYM VAL ...)") | 523 | usage: (setq SYM VAL SYM VAL ...) */) |
| 524 | (args) | 524 | (args) |
| 525 | Lisp_Object args; | 525 | Lisp_Object args; |
| 526 | { | 526 | { |
| 527 | register Lisp_Object args_left; | 527 | register Lisp_Object args_left; |
| @@ -548,20 +548,20 @@ usage: (setq SYM VAL SYM VAL ...)") | |||
| 548 | } | 548 | } |
| 549 | 549 | ||
| 550 | DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0, | 550 | DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0, |
| 551 | "Return the argument, without evaluating it. `(quote x)' yields `x'.\n\ | 551 | doc: /* Return the argument, without evaluating it. `(quote x)' yields `x'. |
| 552 | usage: (quote ARG)") | 552 | usage: (quote ARG) */) |
| 553 | (args) | 553 | (args) |
| 554 | Lisp_Object args; | 554 | Lisp_Object args; |
| 555 | { | 555 | { |
| 556 | return Fcar (args); | 556 | return Fcar (args); |
| 557 | } | 557 | } |
| 558 | 558 | ||
| 559 | DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0, | 559 | DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0, |
| 560 | "Like `quote', but preferred for objects which are functions.\n\ | 560 | doc: /* Like `quote', but preferred for objects which are functions. |
| 561 | In byte compilation, `function' causes its argument to be compiled.\n\ | 561 | In byte compilation, `function' causes its argument to be compiled. |
| 562 | `quote' cannot do that.\n\ | 562 | `quote' cannot do that. |
| 563 | usage: (function ARG)") | 563 | usage: (function ARG) */) |
| 564 | (args) | 564 | (args) |
| 565 | Lisp_Object args; | 565 | Lisp_Object args; |
| 566 | { | 566 | { |
| 567 | return Fcar (args); | 567 | return Fcar (args); |
| @@ -569,11 +569,11 @@ usage: (function ARG)") | |||
| 569 | 569 | ||
| 570 | 570 | ||
| 571 | DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0, | 571 | DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0, |
| 572 | "Return t if function in which this appears was called interactively.\n\ | 572 | doc: /* Return t if function in which this appears was called interactively. |
| 573 | This means that the function was called with call-interactively (which\n\ | 573 | This means that the function was called with call-interactively (which |
| 574 | includes being called as the binding of a key)\n\ | 574 | includes being called as the binding of a key) |
| 575 | and input is currently coming from the keyboard (not in keyboard macro).") | 575 | and input is currently coming from the keyboard (not in keyboard macro). */) |
| 576 | () | 576 | () |
| 577 | { | 577 | { |
| 578 | return interactive_p (1) ? Qt : Qnil; | 578 | return interactive_p (1) ? Qt : Qnil; |
| 579 | } | 579 | } |
| @@ -637,11 +637,11 @@ interactive_p (exclude_subrs_p) | |||
| 637 | 637 | ||
| 638 | 638 | ||
| 639 | DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0, | 639 | DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0, |
| 640 | "Define NAME as a function.\n\ | 640 | doc: /* Define NAME as a function. |
| 641 | The definition is (lambda ARGLIST [DOCSTRING] BODY...).\n\ | 641 | The definition is (lambda ARGLIST [DOCSTRING] BODY...). |
| 642 | See also the function `interactive'.\n\ | 642 | See also the function `interactive'. |
| 643 | usage: (defun NAME ARGLIST [DOCSTRING] BODY...)") | 643 | usage: (defun NAME ARGLIST [DOCSTRING] BODY...) */) |
| 644 | (args) | 644 | (args) |
| 645 | Lisp_Object args; | 645 | Lisp_Object args; |
| 646 | { | 646 | { |
| 647 | register Lisp_Object fn_name; | 647 | register Lisp_Object fn_name; |
| @@ -657,14 +657,14 @@ usage: (defun NAME ARGLIST [DOCSTRING] BODY...)") | |||
| 657 | } | 657 | } |
| 658 | 658 | ||
| 659 | DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0, | 659 | DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0, |
| 660 | "Define NAME as a macro.\n\ | 660 | doc: /* Define NAME as a macro. |
| 661 | The definition is (macro lambda ARGLIST [DOCSTRING] BODY...).\n\ | 661 | The definition is (macro lambda ARGLIST [DOCSTRING] BODY...). |
| 662 | When the macro is called, as in (NAME ARGS...),\n\ | 662 | When the macro is called, as in (NAME ARGS...), |
| 663 | the function (lambda ARGLIST BODY...) is applied to\n\ | 663 | the function (lambda ARGLIST BODY...) is applied to |
| 664 | the list ARGS... as it appears in the expression,\n\ | 664 | the list ARGS... as it appears in the expression, |
| 665 | and the result should be a form to be evaluated instead of the original.\n\ | 665 | and the result should be a form to be evaluated instead of the original. |
| 666 | usage: (defmacro NAME ARGLIST [DOCSTRING] BODY...)") | 666 | usage: (defmacro NAME ARGLIST [DOCSTRING] BODY...) */) |
| 667 | (args) | 667 | (args) |
| 668 | Lisp_Object args; | 668 | Lisp_Object args; |
| 669 | { | 669 | { |
| 670 | register Lisp_Object fn_name; | 670 | register Lisp_Object fn_name; |
| @@ -681,11 +681,11 @@ usage: (defmacro NAME ARGLIST [DOCSTRING] BODY...)") | |||
| 681 | 681 | ||
| 682 | 682 | ||
| 683 | DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 2, 0, | 683 | DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 2, 0, |
| 684 | "Make SYMBOL a variable alias for symbol ALIASED.\n\ | 684 | doc: /* Make SYMBOL a variable alias for symbol ALIASED. |
| 685 | Setting the value of SYMBOL will subsequently set the value of ALIASED,\n\ | 685 | Setting the value of SYMBOL will subsequently set the value of ALIASED, |
| 686 | and getting the value of SYMBOL will return the value ALIASED has.\n\ | 686 | and getting the value of SYMBOL will return the value ALIASED has. |
| 687 | ALIASED nil means remove the alias; SYMBOL is unbound after that.") | 687 | ALIASED nil means remove the alias; SYMBOL is unbound after that. */) |
| 688 | (symbol, aliased) | 688 | (symbol, aliased) |
| 689 | Lisp_Object symbol, aliased; | 689 | Lisp_Object symbol, aliased; |
| 690 | { | 690 | { |
| 691 | struct Lisp_Symbol *sym; | 691 | struct Lisp_Symbol *sym; |
| @@ -707,20 +707,21 @@ ALIASED nil means remove the alias; SYMBOL is unbound after that.") | |||
| 707 | 707 | ||
| 708 | 708 | ||
| 709 | DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0, | 709 | DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0, |
| 710 | "Define SYMBOL as a variable.\n\ | 710 | doc: /* Define SYMBOL as a variable. |
| 711 | You are not required to define a variable in order to use it,\n\ | 711 | You are not required to define a variable in order to use it, |
| 712 | but the definition can supply documentation and an initial value\n\ | 712 | but the definition can supply documentation and an initial value |
| 713 | in a way that tags can recognize.\n\n\ | 713 | in a way that tags can recognize. |
| 714 | INITVALUE is evaluated, and used to set SYMBOL, only if SYMBOL's value is void.\n\ | 714 | |
| 715 | If SYMBOL is buffer-local, its default value is what is set;\n\ | 715 | INITVALUE is evaluated, and used to set SYMBOL, only if SYMBOL's value is void. |
| 716 | buffer-local values are not affected.\n\ | 716 | If SYMBOL is buffer-local, its default value is what is set; |
| 717 | INITVALUE and DOCSTRING are optional.\n\ | 717 | buffer-local values are not affected. |
| 718 | If DOCSTRING starts with *, this variable is identified as a user option.\n\ | 718 | INITVALUE and DOCSTRING are optional. |
| 719 | This means that M-x set-variable recognizes it.\n\ | 719 | If DOCSTRING starts with *, this variable is identified as a user option. |
| 720 | See also `user-variable-p'.\n\ | 720 | This means that M-x set-variable recognizes it. |
| 721 | If INITVALUE is missing, SYMBOL's value is not set.\n\ | 721 | See also `user-variable-p'. |
| 722 | usage: (defvar SYMBOL [INITVALUE DOCSTRING])") | 722 | If INITVALUE is missing, SYMBOL's value is not set. |
| 723 | (args) | 723 | usage: (defvar SYMBOL [INITVALUE DOCSTRING]) */) |
| 724 | (args) | ||
| 724 | Lisp_Object args; | 725 | Lisp_Object args; |
| 725 | { | 726 | { |
| 726 | register Lisp_Object sym, tem, tail; | 727 | register Lisp_Object sym, tem, tail; |
| @@ -756,14 +757,14 @@ usage: (defvar SYMBOL [INITVALUE DOCSTRING])") | |||
| 756 | } | 757 | } |
| 757 | 758 | ||
| 758 | DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0, | 759 | DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0, |
| 759 | "Define SYMBOL as a constant variable.\n\ | 760 | doc: /* Define SYMBOL as a constant variable. |
| 760 | The intent is that neither programs nor users should ever change this value.\n\ | 761 | The intent is that neither programs nor users should ever change this value. |
| 761 | Always sets the value of SYMBOL to the result of evalling INITVALUE.\n\ | 762 | Always sets the value of SYMBOL to the result of evalling INITVALUE. |
| 762 | If SYMBOL is buffer-local, its default value is what is set;\n\ | 763 | If SYMBOL is buffer-local, its default value is what is set; |
| 763 | buffer-local values are not affected.\n\ | 764 | buffer-local values are not affected. |
| 764 | DOCSTRING is optional.\n\ | 765 | DOCSTRING is optional. |
| 765 | usage: (defconst SYMBOL INITVALUE [DOCSTRING])") | 766 | usage: (defconst SYMBOL INITVALUE [DOCSTRING]) */) |
| 766 | (args) | 767 | (args) |
| 767 | Lisp_Object args; | 768 | Lisp_Object args; |
| 768 | { | 769 | { |
| 769 | register Lisp_Object sym, tem; | 770 | register Lisp_Object sym, tem; |
| @@ -788,13 +789,13 @@ usage: (defconst SYMBOL INITVALUE [DOCSTRING])") | |||
| 788 | } | 789 | } |
| 789 | 790 | ||
| 790 | DEFUN ("user-variable-p", Fuser_variable_p, Suser_variable_p, 1, 1, 0, | 791 | DEFUN ("user-variable-p", Fuser_variable_p, Suser_variable_p, 1, 1, 0, |
| 791 | "Returns t if VARIABLE is intended to be set and modified by users.\n\ | 792 | doc: /* Returns t if VARIABLE is intended to be set and modified by users. |
| 792 | \(The alternative is a variable used internally in a Lisp program.)\n\ | 793 | \(The alternative is a variable used internally in a Lisp program.) |
| 793 | Determined by whether the first character of the documentation\n\ | 794 | Determined by whether the first character of the documentation |
| 794 | for the variable is `*' or if the variable is customizable (has a non-nil\n\ | 795 | for the variable is `*' or if the variable is customizable (has a non-nil |
| 795 | value of any of `custom-type', `custom-loads' or `standard-value'\n\ | 796 | value of any of `custom-type', `custom-loads' or `standard-value' |
| 796 | on its property list).") | 797 | on its property list). */) |
| 797 | (variable) | 798 | (variable) |
| 798 | Lisp_Object variable; | 799 | Lisp_Object variable; |
| 799 | { | 800 | { |
| 800 | Lisp_Object documentation; | 801 | Lisp_Object documentation; |
| @@ -823,13 +824,13 @@ on its property list).") | |||
| 823 | } | 824 | } |
| 824 | 825 | ||
| 825 | DEFUN ("let*", FletX, SletX, 1, UNEVALLED, 0, | 826 | DEFUN ("let*", FletX, SletX, 1, UNEVALLED, 0, |
| 826 | "Bind variables according to VARLIST then eval BODY.\n\ | 827 | doc: /* Bind variables according to VARLIST then eval BODY. |
| 827 | The value of the last form in BODY is returned.\n\ | 828 | The value of the last form in BODY is returned. |
| 828 | Each element of VARLIST is a symbol (which is bound to nil)\n\ | 829 | Each element of VARLIST is a symbol (which is bound to nil) |
| 829 | or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).\n\ | 830 | or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM). |
| 830 | Each VALUEFORM can refer to the symbols already bound by this VARLIST.\n\ | 831 | Each VALUEFORM can refer to the symbols already bound by this VARLIST. |
| 831 | usage: (let* VARLIST BODY...)") | 832 | usage: (let* VARLIST BODY...) */) |
| 832 | (args) | 833 | (args) |
| 833 | Lisp_Object args; | 834 | Lisp_Object args; |
| 834 | { | 835 | { |
| 835 | Lisp_Object varlist, val, elt; | 836 | Lisp_Object varlist, val, elt; |
| @@ -862,13 +863,13 @@ usage: (let* VARLIST BODY...)") | |||
| 862 | } | 863 | } |
| 863 | 864 | ||
| 864 | DEFUN ("let", Flet, Slet, 1, UNEVALLED, 0, | 865 | DEFUN ("let", Flet, Slet, 1, UNEVALLED, 0, |
| 865 | "Bind variables according to VARLIST then eval BODY.\n\ | 866 | doc: /* Bind variables according to VARLIST then eval BODY. |
| 866 | The value of the last form in BODY is returned.\n\ | 867 | The value of the last form in BODY is returned. |
| 867 | Each element of VARLIST is a symbol (which is bound to nil)\n\ | 868 | Each element of VARLIST is a symbol (which is bound to nil) |
| 868 | or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).\n\ | 869 | or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM). |
| 869 | All the VALUEFORMs are evalled before any symbols are bound.\n\ | 870 | All the VALUEFORMs are evalled before any symbols are bound. |
| 870 | usage: (let VARLIST BODY...)") | 871 | usage: (let VARLIST BODY...) */) |
| 871 | (args) | 872 | (args) |
| 872 | Lisp_Object args; | 873 | Lisp_Object args; |
| 873 | { | 874 | { |
| 874 | Lisp_Object *temps, tem; | 875 | Lisp_Object *temps, tem; |
| @@ -920,11 +921,11 @@ usage: (let VARLIST BODY...)") | |||
| 920 | } | 921 | } |
| 921 | 922 | ||
| 922 | DEFUN ("while", Fwhile, Swhile, 1, UNEVALLED, 0, | 923 | DEFUN ("while", Fwhile, Swhile, 1, UNEVALLED, 0, |
| 923 | "If TEST yields non-nil, eval BODY... and repeat.\n\ | 924 | doc: /* If TEST yields non-nil, eval BODY... and repeat. |
| 924 | The order of execution is thus TEST, BODY, TEST, BODY and so on\n\ | 925 | The order of execution is thus TEST, BODY, TEST, BODY and so on |
| 925 | until TEST returns nil.\n\ | 926 | until TEST returns nil. |
| 926 | usage: (while TEST BODY...)") | 927 | usage: (while TEST BODY...) */) |
| 927 | (args) | 928 | (args) |
| 928 | Lisp_Object args; | 929 | Lisp_Object args; |
| 929 | { | 930 | { |
| 930 | Lisp_Object test, body, tem; | 931 | Lisp_Object test, body, tem; |
| @@ -946,13 +947,14 @@ usage: (while TEST BODY...)") | |||
| 946 | } | 947 | } |
| 947 | 948 | ||
| 948 | DEFUN ("macroexpand", Fmacroexpand, Smacroexpand, 1, 2, 0, | 949 | DEFUN ("macroexpand", Fmacroexpand, Smacroexpand, 1, 2, 0, |
| 949 | "Return result of expanding macros at top level of FORM.\n\ | 950 | doc: /* Return result of expanding macros at top level of FORM. |
| 950 | If FORM is not a macro call, it is returned unchanged.\n\ | 951 | If FORM is not a macro call, it is returned unchanged. |
| 951 | Otherwise, the macro is expanded and the expansion is considered\n\ | 952 | Otherwise, the macro is expanded and the expansion is considered |
| 952 | in place of FORM. When a non-macro-call results, it is returned.\n\n\ | 953 | in place of FORM. When a non-macro-call results, it is returned. |
| 953 | The second optional arg ENVIRONMENT specifies an environment of macro\n\ | 954 | |
| 954 | definitions to shadow the loaded ones for use in file byte-compilation.") | 955 | The second optional arg ENVIRONMENT specifies an environment of macro |
| 955 | (form, environment) | 956 | definitions to shadow the loaded ones for use in file byte-compilation. */) |
| 957 | (form, environment) | ||
| 956 | Lisp_Object form; | 958 | Lisp_Object form; |
| 957 | Lisp_Object environment; | 959 | Lisp_Object environment; |
| 958 | { | 960 | { |
| @@ -1024,15 +1026,15 @@ definitions to shadow the loaded ones for use in file byte-compilation.") | |||
| 1024 | } | 1026 | } |
| 1025 | 1027 | ||
| 1026 | DEFUN ("catch", Fcatch, Scatch, 1, UNEVALLED, 0, | 1028 | DEFUN ("catch", Fcatch, Scatch, 1, UNEVALLED, 0, |
| 1027 | "Eval BODY allowing nonlocal exits using `throw'.\n\ | 1029 | doc: /* Eval BODY allowing nonlocal exits using `throw'. |
| 1028 | TAG is evalled to get the tag to use; it must not be nil.\n\ | 1030 | TAG is evalled to get the tag to use; it must not be nil. |
| 1029 | \n\ | 1031 | |
| 1030 | Then the BODY is executed.\n\ | 1032 | Then the BODY is executed. |
| 1031 | Within BODY, (throw TAG) with same tag exits BODY and exits this `catch'.\n\ | 1033 | Within BODY, (throw TAG) with same tag exits BODY and exits this `catch'. |
| 1032 | If no throw happens, `catch' returns the value of the last BODY form.\n\ | 1034 | If no throw happens, `catch' returns the value of the last BODY form. |
| 1033 | If a throw happens, it specifies the value to return from `catch'.\n\ | 1035 | If a throw happens, it specifies the value to return from `catch'. |
| 1034 | usage: (catch TAG BODY...)") | 1036 | usage: (catch TAG BODY...) */) |
| 1035 | (args) | 1037 | (args) |
| 1036 | Lisp_Object args; | 1038 | Lisp_Object args; |
| 1037 | { | 1039 | { |
| 1038 | register Lisp_Object tag; | 1040 | register Lisp_Object tag; |
| @@ -1135,9 +1137,9 @@ unwind_to_catch (catch, value) | |||
| 1135 | } | 1137 | } |
| 1136 | 1138 | ||
| 1137 | DEFUN ("throw", Fthrow, Sthrow, 2, 2, 0, | 1139 | DEFUN ("throw", Fthrow, Sthrow, 2, 2, 0, |
| 1138 | "Throw to the catch for TAG and return VALUE from it.\n\ | 1140 | doc: /* Throw to the catch for TAG and return VALUE from it. |
| 1139 | Both TAG and VALUE are evalled.") | 1141 | Both TAG and VALUE are evalled. */) |
| 1140 | (tag, value) | 1142 | (tag, value) |
| 1141 | register Lisp_Object tag, value; | 1143 | register Lisp_Object tag, value; |
| 1142 | { | 1144 | { |
| 1143 | register struct catchtag *c; | 1145 | register struct catchtag *c; |
| @@ -1156,12 +1158,12 @@ Both TAG and VALUE are evalled.") | |||
| 1156 | 1158 | ||
| 1157 | 1159 | ||
| 1158 | DEFUN ("unwind-protect", Funwind_protect, Sunwind_protect, 1, UNEVALLED, 0, | 1160 | DEFUN ("unwind-protect", Funwind_protect, Sunwind_protect, 1, UNEVALLED, 0, |
| 1159 | "Do BODYFORM, protecting with UNWINDFORMS.\n\ | 1161 | doc: /* Do BODYFORM, protecting with UNWINDFORMS. |
| 1160 | If BODYFORM completes normally, its value is returned\n\ | 1162 | If BODYFORM completes normally, its value is returned |
| 1161 | after executing the UNWINDFORMS.\n\ | 1163 | after executing the UNWINDFORMS. |
| 1162 | If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.\n\ | 1164 | If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway. |
| 1163 | usage: (unwind-protect BODYFORM UNWINDFORMS...)") | 1165 | usage: (unwind-protect BODYFORM UNWINDFORMS...) */) |
| 1164 | (args) | 1166 | (args) |
| 1165 | Lisp_Object args; | 1167 | Lisp_Object args; |
| 1166 | { | 1168 | { |
| 1167 | Lisp_Object val; | 1169 | Lisp_Object val; |
| @@ -1181,26 +1183,27 @@ usage: (unwind-protect BODYFORM UNWINDFORMS...)") | |||
| 1181 | struct handler *handlerlist; | 1183 | struct handler *handlerlist; |
| 1182 | 1184 | ||
| 1183 | DEFUN ("condition-case", Fcondition_case, Scondition_case, 2, UNEVALLED, 0, | 1185 | DEFUN ("condition-case", Fcondition_case, Scondition_case, 2, UNEVALLED, 0, |
| 1184 | "Regain control when an error is signaled.\n\ | 1186 | doc: /* Regain control when an error is signaled. |
| 1185 | executes BODYFORM and returns its value if no error happens.\n\ | 1187 | executes BODYFORM and returns its value if no error happens. |
| 1186 | Each element of HANDLERS looks like (CONDITION-NAME BODY...)\n\ | 1188 | Each element of HANDLERS looks like (CONDITION-NAME BODY...) |
| 1187 | where the BODY is made of Lisp expressions.\n\n\ | 1189 | where the BODY is made of Lisp expressions. |
| 1188 | A handler is applicable to an error\n\ | 1190 | |
| 1189 | if CONDITION-NAME is one of the error's condition names.\n\ | 1191 | A handler is applicable to an error |
| 1190 | If an error happens, the first applicable handler is run.\n\ | 1192 | if CONDITION-NAME is one of the error's condition names. |
| 1191 | \n\ | 1193 | If an error happens, the first applicable handler is run. |
| 1192 | The car of a handler may be a list of condition names\n\ | 1194 | |
| 1193 | instead of a single condition name.\n\ | 1195 | The car of a handler may be a list of condition names |
| 1194 | \n\ | 1196 | instead of a single condition name. |
| 1195 | When a handler handles an error,\n\ | 1197 | |
| 1196 | control returns to the condition-case and the handler BODY... is executed\n\ | 1198 | When a handler handles an error, |
| 1197 | with VAR bound to (SIGNALED-CONDITIONS . SIGNAL-DATA).\n\ | 1199 | control returns to the condition-case and the handler BODY... is executed |
| 1198 | VAR may be nil; then you do not get access to the signal information.\n\ | 1200 | with VAR bound to (SIGNALED-CONDITIONS . SIGNAL-DATA). |
| 1199 | \n\ | 1201 | VAR may be nil; then you do not get access to the signal information. |
| 1200 | The value of the last BODY form is returned from the condition-case.\n\ | 1202 | |
| 1201 | See also the function `signal' for more info.\n\ | 1203 | The value of the last BODY form is returned from the condition-case. |
| 1202 | usage: (condition-case VAR BODYFORM HANDLERS...)") | 1204 | See also the function `signal' for more info. |
| 1203 | (args) | 1205 | usage: (condition-case VAR BODYFORM HANDLERS...) */) |
| 1206 | (args) | ||
| 1204 | Lisp_Object args; | 1207 | Lisp_Object args; |
| 1205 | { | 1208 | { |
| 1206 | Lisp_Object val; | 1209 | Lisp_Object val; |
| @@ -1404,17 +1407,18 @@ internal_condition_case_2 (bfun, nargs, args, handlers, hfun) | |||
| 1404 | static Lisp_Object find_handler_clause (); | 1407 | static Lisp_Object find_handler_clause (); |
| 1405 | 1408 | ||
| 1406 | DEFUN ("signal", Fsignal, Ssignal, 2, 2, 0, | 1409 | DEFUN ("signal", Fsignal, Ssignal, 2, 2, 0, |
| 1407 | "Signal an error. Args are ERROR-SYMBOL and associated DATA.\n\ | 1410 | doc: /* Signal an error. Args are ERROR-SYMBOL and associated DATA. |
| 1408 | This function does not return.\n\n\ | 1411 | This function does not return. |
| 1409 | An error symbol is a symbol with an `error-conditions' property\n\ | 1412 | |
| 1410 | that is a list of condition names.\n\ | 1413 | An error symbol is a symbol with an `error-conditions' property |
| 1411 | A handler for any of those names will get to handle this signal.\n\ | 1414 | that is a list of condition names. |
| 1412 | The symbol `error' should normally be one of them.\n\ | 1415 | A handler for any of those names will get to handle this signal. |
| 1413 | \n\ | 1416 | The symbol `error' should normally be one of them. |
| 1414 | DATA should be a list. Its elements are printed as part of the error message.\n\ | 1417 | |
| 1415 | If the signal is handled, DATA is made available to the handler.\n\ | 1418 | DATA should be a list. Its elements are printed as part of the error message. |
| 1416 | See also the function `condition-case'.") | 1419 | If the signal is handled, DATA is made available to the handler. |
| 1417 | (error_symbol, data) | 1420 | See also the function `condition-case'. */) |
| 1421 | (error_symbol, data) | ||
| 1418 | Lisp_Object error_symbol, data; | 1422 | Lisp_Object error_symbol, data; |
| 1419 | { | 1423 | { |
| 1420 | /* When memory is full, ERROR-SYMBOL is nil, | 1424 | /* When memory is full, ERROR-SYMBOL is nil, |
| @@ -1740,18 +1744,18 @@ error (m, a1, a2, a3) | |||
| 1740 | } | 1744 | } |
| 1741 | 1745 | ||
| 1742 | DEFUN ("commandp", Fcommandp, Scommandp, 1, 1, 0, | 1746 | DEFUN ("commandp", Fcommandp, Scommandp, 1, 1, 0, |
| 1743 | "T if FUNCTION makes provisions for interactive calling.\n\ | 1747 | doc: /* Non-nil if FUNCTION makes provisions for interactive calling. |
| 1744 | This means it contains a description for how to read arguments to give it.\n\ | 1748 | This means it contains a description for how to read arguments to give it. |
| 1745 | The value is nil for an invalid function or a symbol with no function\n\ | 1749 | The value is nil for an invalid function or a symbol with no function |
| 1746 | definition.\n\ | 1750 | definition. |
| 1747 | \n\ | 1751 | |
| 1748 | Interactively callable functions include strings and vectors (treated\n\ | 1752 | Interactively callable functions include strings and vectors (treated |
| 1749 | as keyboard macros), lambda-expressions that contain a top-level call\n\ | 1753 | as keyboard macros), lambda-expressions that contain a top-level call |
| 1750 | to `interactive', autoload definitions made by `autoload' with non-nil\n\ | 1754 | to `interactive', autoload definitions made by `autoload' with non-nil |
| 1751 | fourth argument, and some of the built-in functions of Lisp.\n\ | 1755 | fourth argument, and some of the built-in functions of Lisp. |
| 1752 | \n\ | 1756 | |
| 1753 | Also, a symbol satisfies `commandp' if its function definition does so.") | 1757 | Also, a symbol satisfies `commandp' if its function definition does so. */) |
| 1754 | (function) | 1758 | (function) |
| 1755 | Lisp_Object function; | 1759 | Lisp_Object function; |
| 1756 | { | 1760 | { |
| 1757 | register Lisp_Object fun; | 1761 | register Lisp_Object fun; |
| @@ -1802,19 +1806,19 @@ Also, a symbol satisfies `commandp' if its function definition does so.") | |||
| 1802 | 1806 | ||
| 1803 | /* ARGSUSED */ | 1807 | /* ARGSUSED */ |
| 1804 | DEFUN ("autoload", Fautoload, Sautoload, 2, 5, 0, | 1808 | DEFUN ("autoload", Fautoload, Sautoload, 2, 5, 0, |
| 1805 | "Define FUNCTION to autoload from FILE.\n\ | 1809 | doc: /* Define FUNCTION to autoload from FILE. |
| 1806 | FUNCTION is a symbol; FILE is a file name string to pass to `load'.\n\ | 1810 | FUNCTION is a symbol; FILE is a file name string to pass to `load'. |
| 1807 | Third arg DOCSTRING is documentation for the function.\n\ | 1811 | Third arg DOCSTRING is documentation for the function. |
| 1808 | Fourth arg INTERACTIVE if non-nil says function can be called interactively.\n\ | 1812 | Fourth arg INTERACTIVE if non-nil says function can be called interactively. |
| 1809 | Fifth arg TYPE indicates the type of the object:\n\ | 1813 | Fifth arg TYPE indicates the type of the object: |
| 1810 | nil or omitted says FUNCTION is a function,\n\ | 1814 | nil or omitted says FUNCTION is a function, |
| 1811 | `keymap' says FUNCTION is really a keymap, and\n\ | 1815 | `keymap' says FUNCTION is really a keymap, and |
| 1812 | `macro' or t says FUNCTION is really a macro.\n\ | 1816 | `macro' or t says FUNCTION is really a macro. |
| 1813 | Third through fifth args give info about the real definition.\n\ | 1817 | Third through fifth args give info about the real definition. |
| 1814 | They default to nil.\n\ | 1818 | They default to nil. |
| 1815 | If FUNCTION is already defined other than as an autoload,\n\ | 1819 | If FUNCTION is already defined other than as an autoload, |
| 1816 | this does nothing and returns nil.") | 1820 | this does nothing and returns nil. */) |
| 1817 | (function, file, docstring, interactive, type) | 1821 | (function, file, docstring, interactive, type) |
| 1818 | Lisp_Object function, file, docstring, interactive, type; | 1822 | Lisp_Object function, file, docstring, interactive, type; |
| 1819 | { | 1823 | { |
| 1820 | #ifdef NO_ARG_ARRAY | 1824 | #ifdef NO_ARG_ARRAY |
| @@ -1926,8 +1930,8 @@ do_autoload (fundef, funname) | |||
| 1926 | 1930 | ||
| 1927 | 1931 | ||
| 1928 | DEFUN ("eval", Feval, Seval, 1, 1, 0, | 1932 | DEFUN ("eval", Feval, Seval, 1, 1, 0, |
| 1929 | "Evaluate FORM and return its value.") | 1933 | doc: /* Evaluate FORM and return its value. */) |
| 1930 | (form) | 1934 | (form) |
| 1931 | Lisp_Object form; | 1935 | Lisp_Object form; |
| 1932 | { | 1936 | { |
| 1933 | Lisp_Object fun, val, original_fun, original_args; | 1937 | Lisp_Object fun, val, original_fun, original_args; |
| @@ -2137,11 +2141,11 @@ DEFUN ("eval", Feval, Seval, 1, 1, 0, | |||
| 2137 | } | 2141 | } |
| 2138 | 2142 | ||
| 2139 | DEFUN ("apply", Fapply, Sapply, 2, MANY, 0, | 2143 | DEFUN ("apply", Fapply, Sapply, 2, MANY, 0, |
| 2140 | "Call FUNCTION with our remaining args, using our last arg as list of args.\n\ | 2144 | doc: /* Call FUNCTION with our remaining args, using our last arg as list of args. |
| 2141 | Then return the value FUNCTION returns.\n\ | 2145 | Then return the value FUNCTION returns. |
| 2142 | Thus, (apply '+ 1 2 '(3 4)) returns 10.\n\ | 2146 | Thus, (apply '+ 1 2 '(3 4)) returns 10. |
| 2143 | usage: (apply FUNCTION &rest ARGUMENTS)") | 2147 | usage: (apply FUNCTION &rest ARGUMENTS) */) |
| 2144 | (nargs, args) | 2148 | (nargs, args) |
| 2145 | int nargs; | 2149 | int nargs; |
| 2146 | Lisp_Object *args; | 2150 | Lisp_Object *args; |
| 2147 | { | 2151 | { |
| @@ -2222,18 +2226,18 @@ usage: (apply FUNCTION &rest ARGUMENTS)") | |||
| 2222 | enum run_hooks_condition {to_completion, until_success, until_failure}; | 2226 | enum run_hooks_condition {to_completion, until_success, until_failure}; |
| 2223 | 2227 | ||
| 2224 | DEFUN ("run-hooks", Frun_hooks, Srun_hooks, 0, MANY, 0, | 2228 | DEFUN ("run-hooks", Frun_hooks, Srun_hooks, 0, MANY, 0, |
| 2225 | "Run each hook in HOOKS. Major mode functions use this.\n\ | 2229 | doc: /* Run each hook in HOOKS. Major mode functions use this. |
| 2226 | Each argument should be a symbol, a hook variable.\n\ | 2230 | Each argument should be a symbol, a hook variable. |
| 2227 | These symbols are processed in the order specified.\n\ | 2231 | These symbols are processed in the order specified. |
| 2228 | If a hook symbol has a non-nil value, that value may be a function\n\ | 2232 | If a hook symbol has a non-nil value, that value may be a function |
| 2229 | or a list of functions to be called to run the hook.\n\ | 2233 | or a list of functions to be called to run the hook. |
| 2230 | If the value is a function, it is called with no arguments.\n\ | 2234 | If the value is a function, it is called with no arguments. |
| 2231 | If it is a list, the elements are called, in order, with no arguments.\n\ | 2235 | If it is a list, the elements are called, in order, with no arguments. |
| 2232 | \n\ | 2236 | |
| 2233 | To make a hook variable buffer-local, use `make-local-hook',\n\ | 2237 | To make a hook variable buffer-local, use `make-local-hook', |
| 2234 | not `make-local-variable'.\n\ | 2238 | not `make-local-variable'. |
| 2235 | usage: (run-hooks &rest HOOKS)") | 2239 | usage: (run-hooks &rest HOOKS) */) |
| 2236 | (nargs, args) | 2240 | (nargs, args) |
| 2237 | int nargs; | 2241 | int nargs; |
| 2238 | Lisp_Object *args; | 2242 | Lisp_Object *args; |
| 2239 | { | 2243 | { |
| @@ -2250,21 +2254,21 @@ usage: (run-hooks &rest HOOKS)") | |||
| 2250 | } | 2254 | } |
| 2251 | 2255 | ||
| 2252 | DEFUN ("run-hook-with-args", Frun_hook_with_args, | 2256 | DEFUN ("run-hook-with-args", Frun_hook_with_args, |
| 2253 | Srun_hook_with_args, 1, MANY, 0, | 2257 | Srun_hook_with_args, 1, MANY, 0, |
| 2254 | "Run HOOK with the specified arguments ARGS.\n\ | 2258 | doc: /* Run HOOK with the specified arguments ARGS. |
| 2255 | HOOK should be a symbol, a hook variable. If HOOK has a non-nil\n\ | 2259 | HOOK should be a symbol, a hook variable. If HOOK has a non-nil |
| 2256 | value, that value may be a function or a list of functions to be\n\ | 2260 | value, that value may be a function or a list of functions to be |
| 2257 | called to run the hook. If the value is a function, it is called with\n\ | 2261 | called to run the hook. If the value is a function, it is called with |
| 2258 | the given arguments and its return value is returned. If it is a list\n\ | 2262 | the given arguments and its return value is returned. If it is a list |
| 2259 | of functions, those functions are called, in order,\n\ | 2263 | of functions, those functions are called, in order, |
| 2260 | with the given arguments ARGS.\n\ | 2264 | with the given arguments ARGS. |
| 2261 | It is best not to depend on the value return by `run-hook-with-args',\n\ | 2265 | It is best not to depend on the value return by `run-hook-with-args', |
| 2262 | as that may change.\n\ | 2266 | as that may change. |
| 2263 | \n\ | 2267 | |
| 2264 | To make a hook variable buffer-local, use `make-local-hook',\n\ | 2268 | To make a hook variable buffer-local, use `make-local-hook', |
| 2265 | not `make-local-variable'.\n\ | 2269 | not `make-local-variable'. |
| 2266 | usage: (run-hook-with-args HOOK &rest ARGS)") | 2270 | usage: (run-hook-with-args HOOK &rest ARGS) */) |
| 2267 | (nargs, args) | 2271 | (nargs, args) |
| 2268 | int nargs; | 2272 | int nargs; |
| 2269 | Lisp_Object *args; | 2273 | Lisp_Object *args; |
| 2270 | { | 2274 | { |
| @@ -2272,18 +2276,18 @@ usage: (run-hook-with-args HOOK &rest ARGS)") | |||
| 2272 | } | 2276 | } |
| 2273 | 2277 | ||
| 2274 | DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success, | 2278 | DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success, |
| 2275 | Srun_hook_with_args_until_success, 1, MANY, 0, | 2279 | Srun_hook_with_args_until_success, 1, MANY, 0, |
| 2276 | "Run HOOK with the specified arguments ARGS.\n\ | 2280 | doc: /* Run HOOK with the specified arguments ARGS. |
| 2277 | HOOK should be a symbol, a hook variable. Its value should\n\ | 2281 | HOOK should be a symbol, a hook variable. Its value should |
| 2278 | be a list of functions. We call those functions, one by one,\n\ | 2282 | be a list of functions. We call those functions, one by one, |
| 2279 | passing arguments ARGS to each of them, until one of them\n\ | 2283 | passing arguments ARGS to each of them, until one of them |
| 2280 | returns a non-nil value. Then we return that value.\n\ | 2284 | returns a non-nil value. Then we return that value. |
| 2281 | If all the functions return nil, we return nil.\n\ | 2285 | If all the functions return nil, we return nil. |
| 2282 | \n\ | 2286 | |
| 2283 | To make a hook variable buffer-local, use `make-local-hook',\n\ | 2287 | To make a hook variable buffer-local, use `make-local-hook', |
| 2284 | not `make-local-variable'.\n\ | 2288 | not `make-local-variable'. |
| 2285 | usage: (run-hook-with-args-until-success HOOK &rest ARGS)") | 2289 | usage: (run-hook-with-args-until-success HOOK &rest ARGS) */) |
| 2286 | (nargs, args) | 2290 | (nargs, args) |
| 2287 | int nargs; | 2291 | int nargs; |
| 2288 | Lisp_Object *args; | 2292 | Lisp_Object *args; |
| 2289 | { | 2293 | { |
| @@ -2291,18 +2295,18 @@ usage: (run-hook-with-args-until-success HOOK &rest ARGS)") | |||
| 2291 | } | 2295 | } |
| 2292 | 2296 | ||
| 2293 | DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure, | 2297 | DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure, |
| 2294 | Srun_hook_with_args_until_failure, 1, MANY, 0, | 2298 | Srun_hook_with_args_until_failure, 1, MANY, 0, |
| 2295 | "Run HOOK with the specified arguments ARGS.\n\ | 2299 | doc: /* Run HOOK with the specified arguments ARGS. |
| 2296 | HOOK should be a symbol, a hook variable. Its value should\n\ | 2300 | HOOK should be a symbol, a hook variable. Its value should |
| 2297 | be a list of functions. We call those functions, one by one,\n\ | 2301 | be a list of functions. We call those functions, one by one, |
| 2298 | passing arguments ARGS to each of them, until one of them\n\ | 2302 | passing arguments ARGS to each of them, until one of them |
| 2299 | returns nil. Then we return nil.\n\ | 2303 | returns nil. Then we return nil. |
| 2300 | If all the functions return non-nil, we return non-nil.\n\ | 2304 | If all the functions return non-nil, we return non-nil. |
| 2301 | \n\ | 2305 | |
| 2302 | To make a hook variable buffer-local, use `make-local-hook',\n\ | 2306 | To make a hook variable buffer-local, use `make-local-hook', |
| 2303 | not `make-local-variable'.\n\ | 2307 | not `make-local-variable'. |
| 2304 | usage: (run-hook-with-args-until-failure HOOK &rest ARGS)") | 2308 | usage: (run-hook-with-args-until-failure HOOK &rest ARGS) */) |
| 2305 | (nargs, args) | 2309 | (nargs, args) |
| 2306 | int nargs; | 2310 | int nargs; |
| 2307 | Lisp_Object *args; | 2311 | Lisp_Object *args; |
| 2308 | { | 2312 | { |
| @@ -2626,11 +2630,11 @@ call6 (fn, arg1, arg2, arg3, arg4, arg5, arg6) | |||
| 2626 | } | 2630 | } |
| 2627 | 2631 | ||
| 2628 | DEFUN ("funcall", Ffuncall, Sfuncall, 1, MANY, 0, | 2632 | DEFUN ("funcall", Ffuncall, Sfuncall, 1, MANY, 0, |
| 2629 | "Call first argument as a function, passing remaining arguments to it.\n\ | 2633 | doc: /* Call first argument as a function, passing remaining arguments to it. |
| 2630 | Return the value that function returns.\n\ | 2634 | Return the value that function returns. |
| 2631 | Thus, (funcall 'cons 'x 'y) returns (x . y).\n\ | 2635 | Thus, (funcall 'cons 'x 'y) returns (x . y). |
| 2632 | usage: (funcall FUNCTION &rest ARGUMENTS)") | 2636 | usage: (funcall FUNCTION &rest ARGUMENTS) */) |
| 2633 | (nargs, args) | 2637 | (nargs, args) |
| 2634 | int nargs; | 2638 | int nargs; |
| 2635 | Lisp_Object *args; | 2639 | Lisp_Object *args; |
| 2636 | { | 2640 | { |
| @@ -2906,9 +2910,9 @@ funcall_lambda (fun, nargs, arg_vector) | |||
| 2906 | } | 2910 | } |
| 2907 | 2911 | ||
| 2908 | DEFUN ("fetch-bytecode", Ffetch_bytecode, Sfetch_bytecode, | 2912 | DEFUN ("fetch-bytecode", Ffetch_bytecode, Sfetch_bytecode, |
| 2909 | 1, 1, 0, | 2913 | 1, 1, 0, |
| 2910 | "If byte-compiled OBJECT is lazy-loaded, fetch it now.") | 2914 | doc: /* If byte-compiled OBJECT is lazy-loaded, fetch it now. */) |
| 2911 | (object) | 2915 | (object) |
| 2912 | Lisp_Object object; | 2916 | Lisp_Object object; |
| 2913 | { | 2917 | { |
| 2914 | Lisp_Object tem; | 2918 | Lisp_Object tem; |
| @@ -3143,9 +3147,9 @@ top_level_set (symbol, newval) | |||
| 3143 | #endif /* 0 */ | 3147 | #endif /* 0 */ |
| 3144 | 3148 | ||
| 3145 | DEFUN ("backtrace-debug", Fbacktrace_debug, Sbacktrace_debug, 2, 2, 0, | 3149 | DEFUN ("backtrace-debug", Fbacktrace_debug, Sbacktrace_debug, 2, 2, 0, |
| 3146 | "Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.\n\ | 3150 | doc: /* Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG. |
| 3147 | The debugger is entered when that frame exits, if the flag is non-nil.") | 3151 | The debugger is entered when that frame exits, if the flag is non-nil. */) |
| 3148 | (level, flag) | 3152 | (level, flag) |
| 3149 | Lisp_Object level, flag; | 3153 | Lisp_Object level, flag; |
| 3150 | { | 3154 | { |
| 3151 | register struct backtrace *backlist = backtrace_list; | 3155 | register struct backtrace *backlist = backtrace_list; |
| @@ -3165,9 +3169,9 @@ The debugger is entered when that frame exits, if the flag is non-nil.") | |||
| 3165 | } | 3169 | } |
| 3166 | 3170 | ||
| 3167 | DEFUN ("backtrace", Fbacktrace, Sbacktrace, 0, 0, "", | 3171 | DEFUN ("backtrace", Fbacktrace, Sbacktrace, 0, 0, "", |
| 3168 | "Print a trace of Lisp function calls currently active.\n\ | 3172 | doc: /* Print a trace of Lisp function calls currently active. |
| 3169 | Output stream used is value of `standard-output'.") | 3173 | Output stream used is value of `standard-output'. */) |
| 3170 | () | 3174 | () |
| 3171 | { | 3175 | { |
| 3172 | register struct backtrace *backlist = backtrace_list; | 3176 | register struct backtrace *backlist = backtrace_list; |
| 3173 | register int i; | 3177 | register int i; |
| @@ -3223,16 +3227,16 @@ Output stream used is value of `standard-output'.") | |||
| 3223 | } | 3227 | } |
| 3224 | 3228 | ||
| 3225 | DEFUN ("backtrace-frame", Fbacktrace_frame, Sbacktrace_frame, 1, 1, NULL, | 3229 | DEFUN ("backtrace-frame", Fbacktrace_frame, Sbacktrace_frame, 1, 1, NULL, |
| 3226 | "Return the function and arguments NFRAMES up from current execution point.\n\ | 3230 | doc: /* Return the function and arguments NFRAMES up from current execution point. |
| 3227 | If that frame has not evaluated the arguments yet (or is a special form),\n\ | 3231 | If that frame has not evaluated the arguments yet (or is a special form), |
| 3228 | the value is (nil FUNCTION ARG-FORMS...).\n\ | 3232 | the value is (nil FUNCTION ARG-FORMS...). |
| 3229 | If that frame has evaluated its arguments and called its function already,\n\ | 3233 | If that frame has evaluated its arguments and called its function already, |
| 3230 | the value is (t FUNCTION ARG-VALUES...).\n\ | 3234 | the value is (t FUNCTION ARG-VALUES...). |
| 3231 | A &rest arg is represented as the tail of the list ARG-VALUES.\n\ | 3235 | A &rest arg is represented as the tail of the list ARG-VALUES. |
| 3232 | FUNCTION is whatever was supplied as car of evaluated list,\n\ | 3236 | FUNCTION is whatever was supplied as car of evaluated list, |
| 3233 | or a lambda expression for macro calls.\n\ | 3237 | or a lambda expression for macro calls. |
| 3234 | If NFRAMES is more than the number of frames, the value is nil.") | 3238 | If NFRAMES is more than the number of frames, the value is nil. */) |
| 3235 | (nframes) | 3239 | (nframes) |
| 3236 | Lisp_Object nframes; | 3240 | Lisp_Object nframes; |
| 3237 | { | 3241 | { |
| 3238 | register struct backtrace *backlist = backtrace_list; | 3242 | register struct backtrace *backlist = backtrace_list; |
| @@ -3265,28 +3269,28 @@ void | |||
| 3265 | syms_of_eval () | 3269 | syms_of_eval () |
| 3266 | { | 3270 | { |
| 3267 | DEFVAR_INT ("max-specpdl-size", &max_specpdl_size, | 3271 | DEFVAR_INT ("max-specpdl-size", &max_specpdl_size, |
| 3268 | "*Limit on number of Lisp variable bindings & unwind-protects.\n\ | 3272 | doc: /* *Limit on number of Lisp variable bindings & unwind-protects. |
| 3269 | If Lisp code tries to make more than this many at once,\n\ | 3273 | If Lisp code tries to make more than this many at once, |
| 3270 | an error is signaled."); | 3274 | an error is signaled. */); |
| 3271 | 3275 | ||
| 3272 | DEFVAR_INT ("max-lisp-eval-depth", &max_lisp_eval_depth, | 3276 | DEFVAR_INT ("max-lisp-eval-depth", &max_lisp_eval_depth, |
| 3273 | "*Limit on depth in `eval', `apply' and `funcall' before error.\n\ | 3277 | doc: /* *Limit on depth in `eval', `apply' and `funcall' before error. |
| 3274 | This limit is to catch infinite recursions for you before they cause\n\ | 3278 | This limit is to catch infinite recursions for you before they cause |
| 3275 | actual stack overflow in C, which would be fatal for Emacs.\n\ | 3279 | actual stack overflow in C, which would be fatal for Emacs. |
| 3276 | You can safely make it considerably larger than its default value,\n\ | 3280 | You can safely make it considerably larger than its default value, |
| 3277 | if that proves inconveniently small."); | 3281 | if that proves inconveniently small. */); |
| 3278 | 3282 | ||
| 3279 | DEFVAR_LISP ("quit-flag", &Vquit_flag, | 3283 | DEFVAR_LISP ("quit-flag", &Vquit_flag, |
| 3280 | "Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.\n\ | 3284 | doc: /* Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil. |
| 3281 | Typing C-g sets `quit-flag' non-nil, regardless of `inhibit-quit'."); | 3285 | Typing C-g sets `quit-flag' non-nil, regardless of `inhibit-quit'. */); |
| 3282 | Vquit_flag = Qnil; | 3286 | Vquit_flag = Qnil; |
| 3283 | 3287 | ||
| 3284 | DEFVAR_LISP ("inhibit-quit", &Vinhibit_quit, | 3288 | DEFVAR_LISP ("inhibit-quit", &Vinhibit_quit, |
| 3285 | "Non-nil inhibits C-g quitting from happening immediately.\n\ | 3289 | doc: /* Non-nil inhibits C-g quitting from happening immediately. |
| 3286 | Note that `quit-flag' will still be set by typing C-g,\n\ | 3290 | Note that `quit-flag' will still be set by typing C-g, |
| 3287 | so a quit will be signaled as soon as `inhibit-quit' is nil.\n\ | 3291 | so a quit will be signaled as soon as `inhibit-quit' is nil. |
| 3288 | To prevent this happening, set `quit-flag' to nil\n\ | 3292 | To prevent this happening, set `quit-flag' to nil |
| 3289 | before making `inhibit-quit' nil."); | 3293 | before making `inhibit-quit' nil. */); |
| 3290 | Vinhibit_quit = Qnil; | 3294 | Vinhibit_quit = Qnil; |
| 3291 | 3295 | ||
| 3292 | Qinhibit_quit = intern ("inhibit-quit"); | 3296 | Qinhibit_quit = intern ("inhibit-quit"); |
| @@ -3322,73 +3326,73 @@ before making `inhibit-quit' nil."); | |||
| 3322 | staticpro (&Qand_optional); | 3326 | staticpro (&Qand_optional); |
| 3323 | 3327 | ||
| 3324 | DEFVAR_LISP ("stack-trace-on-error", &Vstack_trace_on_error, | 3328 | DEFVAR_LISP ("stack-trace-on-error", &Vstack_trace_on_error, |
| 3325 | "*Non-nil means automatically display a backtrace buffer\n\ | 3329 | doc: /* *Non-nil means automatically display a backtrace buffer |
| 3326 | after any error that is handled by the editor command loop.\n\ | 3330 | after any error that is handled by the editor command loop. |
| 3327 | If the value is a list, an error only means to display a backtrace\n\ | 3331 | If the value is a list, an error only means to display a backtrace |
| 3328 | if one of its condition symbols appears in the list."); | 3332 | if one of its condition symbols appears in the list. */); |
| 3329 | Vstack_trace_on_error = Qnil; | 3333 | Vstack_trace_on_error = Qnil; |
| 3330 | 3334 | ||
| 3331 | DEFVAR_LISP ("debug-on-error", &Vdebug_on_error, | 3335 | DEFVAR_LISP ("debug-on-error", &Vdebug_on_error, |
| 3332 | "*Non-nil means enter debugger if an error is signaled.\n\ | 3336 | doc: /* *Non-nil means enter debugger if an error is signaled. |
| 3333 | Does not apply to errors handled by `condition-case' or those\n\ | 3337 | Does not apply to errors handled by `condition-case' or those |
| 3334 | matched by `debug-ignored-errors'.\n\ | 3338 | matched by `debug-ignored-errors'. |
| 3335 | If the value is a list, an error only means to enter the debugger\n\ | 3339 | If the value is a list, an error only means to enter the debugger |
| 3336 | if one of its condition symbols appears in the list.\n\ | 3340 | if one of its condition symbols appears in the list. |
| 3337 | When you evaluate an expression interactively, this variable\n\ | 3341 | When you evaluate an expression interactively, this variable |
| 3338 | is temporarily non-nil if `eval-expression-debug-on-error' is non-nil.\n\ | 3342 | is temporarily non-nil if `eval-expression-debug-on-error' is non-nil. |
| 3339 | See also variable `debug-on-quit'."); | 3343 | See also variable `debug-on-quit'. */); |
| 3340 | Vdebug_on_error = Qnil; | 3344 | Vdebug_on_error = Qnil; |
| 3341 | 3345 | ||
| 3342 | DEFVAR_LISP ("debug-ignored-errors", &Vdebug_ignored_errors, | 3346 | DEFVAR_LISP ("debug-ignored-errors", &Vdebug_ignored_errors, |
| 3343 | "*List of errors for which the debugger should not be called.\n\ | 3347 | doc: /* *List of errors for which the debugger should not be called. |
| 3344 | Each element may be a condition-name or a regexp that matches error messages.\n\ | 3348 | Each element may be a condition-name or a regexp that matches error messages. |
| 3345 | If any element applies to a given error, that error skips the debugger\n\ | 3349 | If any element applies to a given error, that error skips the debugger |
| 3346 | and just returns to top level.\n\ | 3350 | and just returns to top level. |
| 3347 | This overrides the variable `debug-on-error'.\n\ | 3351 | This overrides the variable `debug-on-error'. |
| 3348 | It does not apply to errors handled by `condition-case'."); | 3352 | It does not apply to errors handled by `condition-case'. */); |
| 3349 | Vdebug_ignored_errors = Qnil; | 3353 | Vdebug_ignored_errors = Qnil; |
| 3350 | 3354 | ||
| 3351 | DEFVAR_BOOL ("debug-on-quit", &debug_on_quit, | 3355 | DEFVAR_BOOL ("debug-on-quit", &debug_on_quit, |
| 3352 | "*Non-nil means enter debugger if quit is signaled (C-g, for example).\n\ | 3356 | doc: /* *Non-nil means enter debugger if quit is signaled (C-g, for example). |
| 3353 | Does not apply if quit is handled by a `condition-case'.\n\ | 3357 | Does not apply if quit is handled by a `condition-case'. |
| 3354 | When you evaluate an expression interactively, this variable\n\ | 3358 | When you evaluate an expression interactively, this variable |
| 3355 | is temporarily non-nil if `eval-expression-debug-on-quit' is non-nil."); | 3359 | is temporarily non-nil if `eval-expression-debug-on-quit' is non-nil. */); |
| 3356 | debug_on_quit = 0; | 3360 | debug_on_quit = 0; |
| 3357 | 3361 | ||
| 3358 | DEFVAR_BOOL ("debug-on-next-call", &debug_on_next_call, | 3362 | DEFVAR_BOOL ("debug-on-next-call", &debug_on_next_call, |
| 3359 | "Non-nil means enter debugger before next `eval', `apply' or `funcall'."); | 3363 | doc: /* Non-nil means enter debugger before next `eval', `apply' or `funcall'. */); |
| 3360 | 3364 | ||
| 3361 | DEFVAR_BOOL ("debugger-may-continue", &debugger_may_continue, | 3365 | DEFVAR_BOOL ("debugger-may-continue", &debugger_may_continue, |
| 3362 | "Non-nil means debugger may continue execution.\n\ | 3366 | doc: /* Non-nil means debugger may continue execution. |
| 3363 | This is nil when the debugger is called under circumstances where it\n\ | 3367 | This is nil when the debugger is called under circumstances where it |
| 3364 | might not be safe to continue."); | 3368 | might not be safe to continue. */); |
| 3365 | debugger_may_continue = 1; | 3369 | debugger_may_continue = 1; |
| 3366 | 3370 | ||
| 3367 | DEFVAR_LISP ("debugger", &Vdebugger, | 3371 | DEFVAR_LISP ("debugger", &Vdebugger, |
| 3368 | "Function to call to invoke debugger.\n\ | 3372 | doc: /* Function to call to invoke debugger. |
| 3369 | If due to frame exit, args are `exit' and the value being returned;\n\ | 3373 | If due to frame exit, args are `exit' and the value being returned; |
| 3370 | this function's value will be returned instead of that.\n\ | 3374 | this function's value will be returned instead of that. |
| 3371 | If due to error, args are `error' and a list of the args to `signal'.\n\ | 3375 | If due to error, args are `error' and a list of the args to `signal'. |
| 3372 | If due to `apply' or `funcall' entry, one arg, `lambda'.\n\ | 3376 | If due to `apply' or `funcall' entry, one arg, `lambda'. |
| 3373 | If due to `eval' entry, one arg, t."); | 3377 | If due to `eval' entry, one arg, t. */); |
| 3374 | Vdebugger = Qnil; | 3378 | Vdebugger = Qnil; |
| 3375 | 3379 | ||
| 3376 | DEFVAR_LISP ("signal-hook-function", &Vsignal_hook_function, | 3380 | DEFVAR_LISP ("signal-hook-function", &Vsignal_hook_function, |
| 3377 | "If non-nil, this is a function for `signal' to call.\n\ | 3381 | doc: /* If non-nil, this is a function for `signal' to call. |
| 3378 | It receives the same arguments that `signal' was given.\n\ | 3382 | It receives the same arguments that `signal' was given. |
| 3379 | The Edebug package uses this to regain control."); | 3383 | The Edebug package uses this to regain control. */); |
| 3380 | Vsignal_hook_function = Qnil; | 3384 | Vsignal_hook_function = Qnil; |
| 3381 | 3385 | ||
| 3382 | Qmocklisp_arguments = intern ("mocklisp-arguments"); | 3386 | Qmocklisp_arguments = intern ("mocklisp-arguments"); |
| 3383 | staticpro (&Qmocklisp_arguments); | 3387 | staticpro (&Qmocklisp_arguments); |
| 3384 | DEFVAR_LISP ("mocklisp-arguments", &Vmocklisp_arguments, | 3388 | DEFVAR_LISP ("mocklisp-arguments", &Vmocklisp_arguments, |
| 3385 | "While in a mocklisp function, the list of its unevaluated args."); | 3389 | doc: /* While in a mocklisp function, the list of its unevaluated args. */); |
| 3386 | Vmocklisp_arguments = Qt; | 3390 | Vmocklisp_arguments = Qt; |
| 3387 | 3391 | ||
| 3388 | DEFVAR_LISP ("debug-on-signal", &Vdebug_on_signal, | 3392 | DEFVAR_LISP ("debug-on-signal", &Vdebug_on_signal, |
| 3389 | "*Non-nil means call the debugger regardless of condition handlers.\n\ | 3393 | doc: /* *Non-nil means call the debugger regardless of condition handlers. |
| 3390 | Note that `debug-on-error', `debug-on-quit' and friends\n\ | 3394 | Note that `debug-on-error', `debug-on-quit' and friends |
| 3391 | still determine whether to handle the particular condition."); | 3395 | still determine whether to handle the particular condition. */); |
| 3392 | Vdebug_on_signal = Qnil; | 3396 | Vdebug_on_signal = Qnil; |
| 3393 | 3397 | ||
| 3394 | Vrun_hooks = intern ("run-hooks"); | 3398 | Vrun_hooks = intern ("run-hooks"); |