]> git.eshelyaron.com Git - emacs.git/commitdiff
(Parsing Expressions): Document syntax-ppss.
authorStefan Monnier <monnier@iro.umontreal.ca>
Fri, 10 Jun 2005 22:20:25 +0000 (22:20 +0000)
committerStefan Monnier <monnier@iro.umontreal.ca>
Fri, 10 Jun 2005 22:20:25 +0000 (22:20 +0000)
lispref/ChangeLog
lispref/syntax.texi

index e2694edd093543220316ec0e7da7fa1ce859641c..6696bf6b0b9bd90ea0e957b12703d2711bccea5d 100644 (file)
@@ -1,3 +1,7 @@
+2005-06-10  Stefan Monnier  <monnier@iro.umontreal.ca>
+
+       * syntax.texi (Parsing Expressions): Document syntax-ppss.
+
 2005-06-10  Luc Teirlinck  <teirllm@auburn.edu>
 
        * debugging.texi (Error Debugging): Minor rewording.
 
 2005-06-10  Lute Kamstra  <lute@gnu.org>
 
-       * elisp.texi: Use EMACSVER to refer to the current version of
-       Emacs.
+       * elisp.texi: Use EMACSVER to refer to the current version of Emacs.
        (Top): Give it a title.  Correct version number.  Give the
        detailed node listing a more prominent header.
-       * intro.texi: Don't set VERSION here a second time.  Mention
-       Emacs' version too.
+       * intro.texi: Don't set VERSION here a second time.
+       Mention Emacs's version too.
        * anti.texi (Antinews): Use EMACSVER to refer to the current
        version of Emacs.
 
@@ -95,8 +98,8 @@
 
 2005-05-21  Eli Zaretskii  <eliz@gnu.org>
 
-       * files.texi (Locating Files): New subsection.  Describe
-       locate-file and executable-find.
+       * files.texi (Locating Files): New subsection.
+       Describe locate-file and executable-find.
 
 2005-05-21  Kevin Ryde  <user42@zip.com.au>
 
        (Major Mode Conventions): Refer to `Auto Major Mode' in more
        appropriate place.
        (Derived Modes): Small clarifications.
-       (Minor Mode Conventions, Keymaps and Minor Modes): Replace
-       references to nodes with references to anchors.
+       (Minor Mode Conventions, Keymaps and Minor Modes):
+       Replace references to nodes with references to anchors.
        (Mode Line Data): Warn that `(:eval FORM)' should not load any files.
        Clarify description of lists whose first element is an integer.
        (Mode Line Variables): Add anchor.
        (Font Lock Basics): Say that font-lock-defaults is buffer-local
        when set and that some parts are optional.  Add cross references.
        (Search-based Fontification): Say how to specify font-lock-keywords.
-       Add cross references.  Add font-lock-multiline to index.  Move
-       font-lock-keywords-case-fold-search here from node "Other Font
+       Add cross references.  Add font-lock-multiline to index.
+       Move font-lock-keywords-case-fold-search here from node "Other Font
        Lock Variables".  Document font-lock-add-keywords and
-       font-lock-remove-keywords
+       font-lock-remove-keywords.
        (Other Font Lock Variables): Move font-lock-keywords-only,
        font-lock-syntax-table, font-lock-beginning-of-syntax-function,
        and font-lock-syntactic-face-function to node "Syntactic Font
        and font-lock-syntactic-face-function here from node "Other Font
        Lock Variables".  Move font-lock-syntactic-keywords to "Setting
        Syntax Properties".  Add cross references.
-       (Setting Syntax Properties): New node.  Move
-       font-lock-syntactic-keywords here from "Syntactic Font Lock".
+       (Setting Syntax Properties): New node.
+       Move font-lock-syntactic-keywords here from "Syntactic Font Lock".
        * syntax.texi (Syntax Properties): Add cross reference.
        * hooks.texi (Standard Hooks): Add Font-Lock hooks.
 
 
 2005-04-19  Kevin Ryde  <user42@zip.com.au>
 
-        * streams.texi (Output Functions): Fix xref.
+       * streams.texi (Output Functions): Fix xref.
        * strings.texi (String Conversion): Fix xref.
 
 2005-04-19  Kim F. Storm  <storm@cua.dk>
 
        * markers.texi (The Mark): Document temporary Transient Mark mode.
 
-       * minibuf.texi (Reading File Names): Document
-       read-file-name-completion-ignore-case.
+       * minibuf.texi (Reading File Names):
+       Document read-file-name-completion-ignore-case.
 
        * positions.texi (Screen Lines): Document nil for width argument
        to compute-motion.
        (Managing Overlays): Document remove-overlays.
        (Standard Faces): Document escape-glyph face.
 
-       * minibuf.texi (Reading File Names): Document
-       read-file-name-function.
+       * minibuf.texi (Reading File Names): Document read-file-name-function.
 
-       * modes.texi (Other Font Lock Variables): Document
-       font-lock-lines-before.
+       * modes.texi (Other Font Lock Variables):
+       Document font-lock-lines-before.
 
        * positions.texi (Skipping Characters): skip-chars-forward allows
        character classes.
        (Progress): Clarify.
        (Invisible Text): Explain that main loop moves point out.
        (Selective Display): Say "hidden", not "invisible".
-       (Managing Overlays): Moved up.  Describe relation to Undo here.
+       (Managing Overlays): Move up.  Describe relation to Undo here.
        (Overlay Properties): Clarify intro.
        (Finding Overlays): Explain return values when nothing found.
        (Width): truncate-string-to-width has added arg.
        (Displaying Faces): Clarify and update mode line face handling.
        (Face Functions): Minor cleanup.
-       (Conditional Display): Merged into Other Display Specs.
+       (Conditional Display): Merge into Other Display Specs.
        (Pixel Specification, Other Display Specs): Minor cleanups.
        (Images, Image Descriptors): Minor cleanups.
        (GIF Images): Patents have expired.
        (Showing Images): Explain default text for insert-image.
-       (Manipulating Button Types): Merged into Manipulating Buttons.
+       (Manipulating Button Types): Merge into Manipulating Buttons.
        (Making Buttons): Explain return values.
        (Button Buffer Commands): Add xref.
        (Inverse Video): Update mode-line-inverse-video.
        * commands.texi (Misc Events): Describe the help-echo event.
 
        * text.texi (Special Properties) <help-echo>: Use `pos'
-       consistently in description of the help-echo property.  Use
-       @code{nil} instead of @var{nil}.
+       consistently in description of the help-echo property.
+       Use @code{nil} instead of @var{nil}.
 
        * display.texi (Overlay Properties): Fix the index entry for
        help-echo overlay property.
index a9df79e9f57450d056c63f3a8219ac8e1b365196..28298ba0f347a589291392a348cc61e58130cc39 100644 (file)
@@ -256,7 +256,7 @@ English text has no comment characters.  In Lisp, the semicolon
 @deffn {Syntax class} @w{inherit}
 This syntax class does not specify a particular syntax.  It says to look
 in the standard syntax table to find the syntax of this character.  The
-designator for this syntax code is @samp{@@}.
+designator for this syntax class is @samp{@@}.
 @end deffn
 
 @deffn {Syntax class} @w{generic comment delimiter}
@@ -385,7 +385,7 @@ nestable.
 @samp{p} identifies an additional ``prefix character'' for Lisp syntax.
 These characters are treated as whitespace when they appear between
 expressions.  When they appear within an expression, they are handled
-according to their usual syntax codes.
+according to their usual syntax classes.
 
 The function @code{backward-prefix-chars} moves back over these
 characters, as well as over characters whose primary syntax class is
@@ -566,7 +566,7 @@ have certain syntax classes.
 
 @defun skip-syntax-forward syntaxes &optional limit
 This function moves point forward across characters having syntax
-classes mentioned in @var{syntaxes} (a string of syntax code
+classes mentioned in @var{syntaxes} (a string of syntax class
 characters).  It stops when it encounters the end of the buffer, or
 position @var{limit} (if specified), or a character it is not supposed
 to skip.
@@ -730,6 +730,16 @@ This function is most often used to compute indentation for languages
 that have nested parentheses.
 @end defun
 
+@defun syntax-ppss &optional pos
+This function returns the state that the parser would have at position
+@var{pos}, if it were started with a default start state at the
+beginning of the buffer.  Thus, it is equivalent to
+@code(parse-partial-sexp (point-min) @var{pos}), except that
+@code{syntax-ppss} uses a cache to speed up the computation.  Also,
+the 2nd value (previous complete subexpression) and 6th value (minimum
+parenthesis depth) of the returned state are not meaningful.
+@end defun
+
 @defun scan-lists from count depth
 This function scans forward @var{count} balanced parenthetical groupings
 from position @var{from}.  It returns the position where the scan stops.