Mercurial > hg > xemacs-beta
comparison man/lispref/eval.texi @ 5547:a46c5c8d6564
Avoid calling various macros "special operators" in the manuals.
2011-08-09 Aidan Kehoe <kehoea@parhasard.net>
* cl.texi (Argument Lists):
* cl.texi (Time of Evaluation):
* cl.texi (Type Predicates):
* cl.texi (Assignment):
* cl.texi (Basic Setf):
* cl.texi (Modify Macros):
* cl.texi (Customizing Setf):
* cl.texi (Dynamic Bindings):
* cl.texi (Lexical Bindings):
* cl.texi (Function Bindings):
* cl.texi (Macro Bindings):
* cl.texi (Conditionals):
* cl.texi (Blocks and Exits):
* cl.texi (Iteration):
* cl.texi (Loop Basics):
* cl.texi (Macros):
* cl.texi (Declarations):
* cl.texi (Property Lists):
* cl.texi (Structures):
* cl.texi (Assertions):
* cl.texi (Efficiency Concerns):
* lispref/compile.texi (Eval During Compile):
* lispref/compile.texi (Compiled-Function Objects):
* lispref/eval.texi (Multiple values):
* lispref/frames.texi (Input Focus):
* lispref/internationalization.texi (Level 3 Primitives):
* lispref/positions.texi (Excursions):
* lispref/positions.texi (Narrowing):
* lispref/searching.texi (Saving Match Data):
* lispref/specifiers.texi (Adding Specifications):
* lispref/windows.texi:
Correct the manuals to avoid using the term "special operator" when
#'special-operator-p would give nil.
| author | Aidan Kehoe <kehoea@parhasard.net> |
|---|---|
| date | Tue, 09 Aug 2011 17:17:44 +0100 |
| parents | 62b9ef1ed4ac |
| children | 9fae6227ede5 |
comparison
equal
deleted
inserted
replaced
| 5546:d54278e74d71 | 5547:a46c5c8d6564 |
|---|---|
| 741 @defun values-list argument | 741 @defun values-list argument |
| 742 This function returns the elements of the lst @var{argument} as multiple | 742 This function returns the elements of the lst @var{argument} as multiple |
| 743 values. | 743 values. |
| 744 @end defun | 744 @end defun |
| 745 | 745 |
| 746 @deffn {Special Operator} multiple-value-bind (var@dots{}) values-form forms@dots{} | 746 @defmac multiple-value-bind (var@dots{}) values-form forms@dots{} |
| 747 This special operator evaluates @var{values-form}, which may return | 747 This macro evaluates @var{values-form}, which may return |
| 748 multiple values. It then binds the @var{var}s to these respective values, | 748 multiple values. It then binds the @var{var}s to these respective values, |
| 749 as if by @code{let}, and then executes the body @var{forms}. | 749 as if by @code{let}, and then executes the body @var{forms}. |
| 750 If there are more @var{var}s than values, the extra @var{var}s | 750 If there are more @var{var}s than values, the extra @var{var}s |
| 751 are bound to @code{nil}. If there are fewer @var{var}s than | 751 are bound to @code{nil}. If there are fewer @var{var}s than |
| 752 values, the excess values are ignored. | 752 values, the excess values are ignored. |
| 753 @end deffn | 753 @end defmac |
| 754 | 754 |
| 755 @deffn {Special Operator} multiple-value-setq (var@dots{}) form | 755 @defmac multiple-value-setq (var@dots{}) form |
| 756 This special operator evaluates @var{form}, which may return multiple | 756 This macro evaluates @var{form}, which may return multiple |
| 757 values. It then sets the @var{var}s to these respective values, as if by | 757 values. It then sets the @var{var}s to these respective values, as if by |
| 758 @code{setq}. Extra @var{var}s or values are treated the same as | 758 @code{setq}. Extra @var{var}s or values are treated the same as |
| 759 in @code{multiple-value-bind}. | 759 in @code{multiple-value-bind}. |
| 760 @end deffn | 760 @end defmac |
| 761 | 761 |
| 762 @deffn {Special Operator} multiple-value-call function forms@dots{} | 762 @deffn {Special Operator} multiple-value-call function forms@dots{} |
| 763 This special operator evaluates function, discarding any multiple | 763 This special operator evaluates function, discarding any multiple |
| 764 values. It then evaluates @var{forms}, preserving any multiple values, | 764 values. It then evaluates @var{forms}, preserving any multiple values, |
| 765 and calls @var{function} as a function with the results. Conceptually, this | 765 and calls @var{function} as a function with the results. Conceptually, this |
| 766 function is a version of @code{apply'}that by-passes the multiple values | 766 function is a version of @code{apply'}that by-passes the multiple values |
| 767 infrastructure, treating multiple values as intercalated lists. | 767 infrastructure, treating multiple values as intercalated lists. |
| 768 @end deffn | 768 @end deffn |
| 769 | 769 |
| 770 @deffn {Special Operator} multiple-value-list form | 770 @defmac multiple-value-list form |
| 771 This special operator evaluates @var{form} and returns a list of the | 771 This macro evaluates @var{form} and returns a list of the |
| 772 multiple values given by it. | 772 multiple values given by it. |
| 773 @end deffn | 773 @end defmac |
| 774 | 774 |
| 775 @deffn {Special Operator} multiple-value-prog1 first body@dots{} | 775 @deffn {Special Operator} multiple-value-prog1 first body@dots{} |
| 776 This special operator evaluates the form @var{first}, then the | 776 This special operator evaluates the form @var{first}, then the |
| 777 forms @var{body}. It returns the value given by @var{first}, preserving | 777 forms @var{body}. It returns the value given by @var{first}, preserving |
| 778 any multiple values. This is identical to @code{prog1}, except that | 778 any multiple values. This is identical to @code{prog1}, except that |
| 779 @code{prog1} always discards multiple values. | 779 @code{prog1} always discards multiple values. |
| 780 @end deffn | 780 @end deffn |
| 781 | 781 |
| 782 @deffn {Special Operator} nth-value n form | 782 @defmac nth-value n form |
| 783 This special operator evaluates @var{form} and returns the @var{n}th | 783 This macro evaluates @var{form} and returns the @var{n}th |
| 784 value it gave. @var{n} must be an integer of value zero or more. | 784 value it gave. @var{n} must be an integer of value zero or more. |
| 785 If @var{form} gave insufficient multiple values, @code{nth-value} | 785 If @var{form} gave insufficient multiple values, @code{nth-value} |
| 786 returns @code{nil}. | 786 returns @code{nil}. |
| 787 @end deffn | 787 @end defmac |
| 788 | 788 |
| 789 @defvar multiple-values-limit | 789 @defvar multiple-values-limit |
| 790 This constant describes the exclusive upper bound on the number of | 790 This constant describes the exclusive upper bound on the number of |
| 791 multiple values that @code{values} accepts and that | 791 multiple values that @code{values} accepts and that |
| 792 @code{multiple-value-bind}, etc. will consume. | 792 @code{multiple-value-bind}, etc. will consume. |