summaryrefslogtreecommitdiff
path: root/src/syntax.c
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2019-10-30 21:26:22 +0100
committerLars Ingebrigtsen <larsi@gnus.org>2019-10-30 21:26:22 +0100
commit77d4491391be50bb88c3b45a2dda30a0a3addd2b (patch)
tree5f415f435d3442389a252f8470f5c08a6166ffc3 /src/syntax.c
parentf7673c147c8c31564dcc19eda12d9c759acee93e (diff)
downloademacs-77d4491391be50bb88c3b45a2dda30a0a3addd2b.tar.gz
Revert "Move description of value to syntax-ppss function."
This reverts commit 305dbc7e2be05748039aacb1a3d697f6f64bed4c. Both of the functions in question are used a lot in the sources, so move it back to the more basic function.
Diffstat (limited to 'src/syntax.c')
-rw-r--r--src/syntax.c20
1 files changed, 19 insertions, 1 deletions
diff --git a/src/syntax.c b/src/syntax.c
index 850921353d6..edfdae22590 100644
--- a/src/syntax.c
+++ b/src/syntax.c
@@ -3530,7 +3530,25 @@ Parsing stops at TO or when certain criteria are met;
If fifth arg OLDSTATE is omitted or nil,
parsing assumes that FROM is the beginning of a function.
-See `syntax-ppss' for a description of the return value.
+Value is a list of elements describing final state of parsing:
+ 0. depth in parens.
+ 1. character address of start of innermost containing list; nil if none.
+ 2. character address of start of last complete sexp terminated.
+ 3. non-nil if inside a string.
+ (it is the character that will terminate the string,
+ or t if the string should be terminated by a generic string delimiter.)
+ 4. nil if outside a comment, t if inside a non-nestable comment,
+ else an integer (the current comment nesting).
+ 5. t if following a quote character.
+ 6. the minimum paren-depth encountered during this scan.
+ 7. style of comment, if any.
+ 8. character address of start of comment or string; nil if not in one.
+ 9. List of positions of currently open parens, outermost first.
+10. When the last position scanned holds the first character of a
+ (potential) two character construct, the syntax of that position,
+ otherwise nil. That construct can be a two character comment
+ delimiter or an Escaped or Char-quoted character.
+11..... Possible further internal information used by `parse-partial-sexp'.
If third arg TARGETDEPTH is non-nil, parsing stops if the depth
in parentheses becomes equal to TARGETDEPTH.