Mercurial > hg > xemacs-beta

comparison man/lispref/positions.texi @ 4905:755ae5b97edb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Change "special form" to "special operator" in our sources. Add a compatible function alias, and the relevant manual index entries. src/ChangeLog addition: 2010-01-31 Aidan Kehoe <kehoea@parhasard.net> * symbols.c (Fspecial_operator_p, syms_of_symbols): * eval.c (print_subr, Finteractive_p, Ffuncall) (Ffunction_min_args, Ffunction_max_args, vars_of_eval): * editfns.c: * data.c (Fsubr_max_args): * doc.c (Fbuilt_in_symbol_file): Change "special form" to "special operator" in our sources. man/ChangeLog addition: 2010-01-31 Aidan Kehoe <kehoea@parhasard.net> * xemacs/programs.texi (Defuns): * lispref/variables.texi (Local Variables, Defining Variables) (Setting Variables, Default Value): * lispref/symbols.texi (Definitions): * lispref/searching.texi (Saving Match Data): * lispref/positions.texi (Excursions, Narrowing): * lispref/objects.texi (Primitive Function Type): * lispref/macros.texi (Defining Macros, Backquote): * lispref/lispref.texi (Top): * lispref/intro.texi (A Sample Function Description): * lispref/help.texi (Help Functions): * lispref/functions.texi (What Is a Function, Simple Lambda) (Defining Functions, Calling Functions, Anonymous Functions): * lispref/frames.texi (Input Focus): * lispref/eval.texi (Forms, Function Indirection) (Special Operators, Quoting): * lispref/edebug-inc.texi (Instrumenting) (Specification Examples): * lispref/debugging.texi (Internals of Debugger): * lispref/control.texi (Control Structures, Sequencing): (Conditionals, Combining Conditions, Iteration): (Catch and Throw, Handling Errors): * lispref/commands.texi (Defining Commands, Using Interactive): Terminology change; special operator -> special form. Don't attempt to change this in texinfo.texi or cl.texi, which use macros I don't understand. * lispref/macros.texi (Defining Macros): Give an anonymous macro example here. * lispref/positions.texi (Excursions): Correct some documentation that called a couple of macros special forms. * lispref/searching.texi (Saving Match Data): Drop some documentation of how to write code that works with Emacs 18. * lispref/specifiers.texi (Adding Specifications): Correct this; #'let-specifier is a macro, not a special operator. * lispref/windows.texi (Window Configurations) (Selecting Windows): Correct this, #'save-selected-window and #'save-window-excursion are macros, not special operators. lisp/ChangeLog addition: 2010-01-31 Aidan Kehoe <kehoea@parhasard.net> * obsolete.el: * loadhist.el (symbol-file): * help.el (describe-function-1): * bytecomp.el: (byte-compile-save-current-buffer): * byte-optimize.el (byte-optimize-form-code-walker): * subr.el (subr-arity): Change "special form" to "special operator" in these files, it's the more logical term. * subr.el (special-form-p): Provide this alias for #'special-operator-p.
author Aidan Kehoe <kehoea@parhasard.net>
date Sun, 31 Jan 2010 20:28:01 +0000
parents 6772ce4d982b
children 62b9ef1ed4ac
comparison
equal deleted inserted replaced
4904:e91e3e353805 4905:755ae5b97edb
756 @cindex excursion 756 @cindex excursion
757 757
758 It is often useful to move point ``temporarily'' within a localized 758 It is often useful to move point ``temporarily'' within a localized
759 portion of the program, or to switch buffers temporarily. This is 759 portion of the program, or to switch buffers temporarily. This is
760 called an @dfn{excursion}, and it is done with the @code{save-excursion} 760 called an @dfn{excursion}, and it is done with the @code{save-excursion}
761 special form. This construct saves the current buffer and its values of 761 special operator. This construct saves the current buffer and its values of
762 point and the mark so they can be restored after the completion of the 762 point and the mark so they can be restored after the completion of the
763 excursion. 763 excursion.
764 764
765 The forms for saving and restoring the configuration of windows are 765 The forms for saving and restoring the configuration of windows are
766 described elsewhere (see @ref{Window Configurations} and @pxref{Frame 766 described elsewhere (see @ref{Window Configurations} and @pxref{Frame
768 768
769 @defspec save-excursion forms@dots{} 769 @defspec save-excursion forms@dots{}
770 @cindex mark excursion 770 @cindex mark excursion
771 @cindex point excursion 771 @cindex point excursion
772 @cindex current buffer excursion 772 @cindex current buffer excursion
773 The @code{save-excursion} special form saves the identity of the current 773 The @code{save-excursion} special operator saves the identity of the current
774 buffer and the values of point and the mark in it, evaluates 774 buffer and the values of point and the mark in it, evaluates
775 @var{forms}, and finally restores the buffer and its saved values of 775 @var{forms}, and finally restores the buffer and its saved values of
776 point and the mark. All three saved values are restored even in case of 776 point and the mark. All three saved values are restored even in case of
777 an abnormal exit via @code{throw} or error (@pxref{Nonlocal Exits}). 777 an abnormal exit via @code{throw} or error (@pxref{Nonlocal Exits}).
778 778
779 The @code{save-excursion} special form is the standard way to switch 779 The @code{save-excursion} special operator is the standard way to switch
780 buffers or move point within one part of a program and avoid affecting 780 buffers or move point within one part of a program and avoid affecting
781 the rest of the program. It is used more than 500 times in the Lisp 781 the rest of the program. It is used more than 500 times in the Lisp
782 sources of XEmacs. 782 sources of XEmacs.
783 783
784 @code{save-excursion} does not save the values of point and the mark for 784 @code{save-excursion} does not save the values of point and the mark for
811 @end group 811 @end group
812 @end example 812 @end example
813 @end defspec 813 @end defspec
814 814
815 @defspec save-current-buffer forms@dots{} 815 @defspec save-current-buffer forms@dots{}
816 This special form is similar to @code{save-excursion} but it only 816 This special operator is similar to @code{save-excursion} but it only
817 saves and restores the current buffer. Beginning with XEmacs 20.3, 817 saves and restores the current buffer. Beginning with XEmacs 20.3,
818 @code{save-current-buffer} is a primitive. 818 @code{save-current-buffer} is a primitive.
819 @end defspec 819 @end defspec
820 820
821 @defspec with-current-buffer buffer forms@dots{} 821 @defspec with-current-buffer buffer forms@dots{}
822 This special form evaluates @var{forms} with @var{buffer} as the current 822 This macro evaluates @var{forms} with @var{buffer} as the current
823 buffer. It returns the value of the last form. 823 buffer. It returns the value of the last form.
824 @end defspec 824 @end defspec
825 825
826 @defspec with-temp-file filename forms@dots{} 826 @defspec with-temp-file filename forms@dots{}
827 This special form creates a new buffer, evaluates @var{forms} there, and 827 This macro creates a new buffer, evaluates @var{forms} there, and
828 writes the buffer to @var{filename}. It returns the value of the last form 828 writes the buffer to @var{filename}. It returns the value of the last form
829 evaluated. 829 evaluated.
830 @end defspec 830 @end defspec
831 831
832 @defspec save-selected-window forms@dots{} 832 @defspec save-selected-window forms@dots{}
833 This special form is similar to @code{save-excursion} but it saves and 833 This macro is similar to @code{save-excursion} but it saves and
834 restores the selected window and nothing else. 834 restores the selected window and nothing else.
835 @end defspec 835 @end defspec
836 836
837 @node Narrowing 837 @node Narrowing
838 @section Narrowing 838 @section Narrowing
892 892
893 @var{buffer} defaults to the current buffer if omitted. 893 @var{buffer} defaults to the current buffer if omitted.
894 @end deffn 894 @end deffn
895 895
896 @defspec save-restriction body@dots{} 896 @defspec save-restriction body@dots{}
897 This special form saves the current bounds of the accessible portion, 897 This special operator saves the current bounds of the accessible portion,
898 evaluates the @var{body} forms, and finally restores the saved bounds, 898 evaluates the @var{body} forms, and finally restores the saved bounds,
899 thus restoring the same state of narrowing (or absence thereof) formerly 899 thus restoring the same state of narrowing (or absence thereof) formerly
900 in effect. The state of narrowing is restored even in the event of an 900 in effect. The state of narrowing is restored even in the event of an
901 abnormal exit via @code{throw} or error (@pxref{Nonlocal Exits}). 901 abnormal exit via @code{throw} or error (@pxref{Nonlocal Exits}).
902 Therefore, this construct is a clean way to narrow a buffer temporarily. 902 Therefore, this construct is a clean way to narrow a buffer temporarily.
920 first (on the outside). Otherwise, the old point value would be 920 first (on the outside). Otherwise, the old point value would be
921 restored with temporary narrowing still in effect. If the old point 921 restored with temporary narrowing still in effect. If the old point
922 value were outside the limits of the temporary narrowing, this would 922 value were outside the limits of the temporary narrowing, this would
923 fail to restore it accurately. 923 fail to restore it accurately.
924 924
925 The @code{save-restriction} special form records the values of the 925 The @code{save-restriction} special operator records the values of the
926 beginning and end of the accessible portion as distances from the 926 beginning and end of the accessible portion as distances from the
927 beginning and end of the buffer. In other words, it records the amount 927 beginning and end of the buffer. In other words, it records the amount
928 of inaccessible text before and after the accessible portion. 928 of inaccessible text before and after the accessible portion.
929 929
930 This method yields correct results if @var{body} does further narrowing. 930 This method yields correct results if @var{body} does further narrowing.