[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
master 52178a3: Elisp manual: mention parse-partial-sexp as the source o
From: |
Alan Mackenzie |
Subject: |
master 52178a3: Elisp manual: mention parse-partial-sexp as the source of a parser state, etc |
Date: |
Fri, 20 Dec 2019 15:02:17 -0500 (EST) |
branch: master
commit 52178a312d34512f7db53ae34ea7f815b5a13323
Author: Alan Mackenzie <address@hidden>
Commit: Alan Mackenzie <address@hidden>
Elisp manual: mention parse-partial-sexp as the source of a parser state,
etc
* doc/lispref/syntax.texi (Parser State): mention parse-partial-sexp as a
function returning a parser state, and the function to which one supplies a
parser state as an argument for continued parsing.
Refine the documentation of syntax-ppss-context, and correct the text
introducing it and another function.
---
doc/lispref/syntax.texi | 19 ++++++++++---------
1 file changed, 10 insertions(+), 9 deletions(-)
diff --git a/doc/lispref/syntax.texi b/doc/lispref/syntax.texi
index 63d534d..364180b 100644
--- a/doc/lispref/syntax.texi
+++ b/doc/lispref/syntax.texi
@@ -797,12 +797,13 @@ Hooks}).
A @dfn{parser state} is a list of (currently) eleven elements
describing the state of the syntactic parser, after it parses the text
between a specified starting point and a specified end point in the
-buffer. Parsing functions such as @code{syntax-ppss}
+buffer using @code{parse-partial-sexp} (@pxref{Low-Level Parsing}).
+Parsing functions such as @code{syntax-ppss}
@ifnottex
(@pxref{Position Parse})
@end ifnottex
-return a parser state as the value. Some parsing functions accept a
-parser state as an argument, for resuming parsing.
+also return a parser state as the value. @code{parse-partial-sexp}
+can accept a parser state as an argument, for resuming parsing.
Here are the meanings of the elements of the parser state:
@@ -866,11 +867,11 @@ escaped/char-quoted character pair), the @var{syntax-code}
@end enumerate
Elements 1, 2, and 6 are ignored in a state which you pass as an
-argument to continue parsing. Elements 9 and 10 are mainly used
-internally by the parser code.
+argument to @code{parse-partial-sexp} to continue parsing. Elements 9
+and 10 are mainly used internally by the parser code.
- One additional piece of useful information is available from a
-parser state using this function:
+ Some additional useful information is available from a parser state
+using these functions:
@defun syntax-ppss-toplevel-pos state
This function extracts, from parser state @var{state}, the last
@@ -883,8 +884,8 @@ arrived at a top level position.
@end defun
@defun syntax-ppss-context state
-Return @code{string} if @var{state} is a string and @code{comment} if
-it's a comment.
+Return @code{string} if the end position of the scan returning
+@var{state} is in a string, and @code{comment} if it's in a comment.
@end defun
@node Low-Level Parsing
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- master 52178a3: Elisp manual: mention parse-partial-sexp as the source of a parser state, etc,
Alan Mackenzie <=