diff options
author | Kaz Kylheku <kaz@kylheku.com> | 2021-05-28 23:32:09 -0700 |
---|---|---|
committer | Kaz Kylheku <kaz@kylheku.com> | 2021-05-28 23:32:09 -0700 |
commit | f05f004356e91f110f5297bdb61827a7c4436d2f (patch) | |
tree | 9e8ffafdafc71fb0c5863d9ea49e15910b139254 /txr.1 | |
parent | 5d42362d611c9103a07f768d8d2bcc1911e0f41b (diff) | |
download | txr-f05f004356e91f110f5297bdb61827a7c4436d2f.tar.gz txr-f05f004356e91f110f5297bdb61827a7c4436d2f.tar.bz2 txr-f05f004356e91f110f5297bdb61827a7c4436d2f.zip |
parser: provide parse-errors function.
* parser.c (parse_errors): New function.
* parser.h (parse_errors): Declared.
* txr.1: Documented.
* share/txr/stdlib/doc-syms.tl: Updated.
Diffstat (limited to 'txr.1')
-rw-r--r-- | txr.1 | 42 |
1 files changed, 42 insertions, 0 deletions
@@ -56632,6 +56632,48 @@ it may be useful to set true in order to obtain better diagnostics. However, source location recording incurs a performance and storage penalty. +.coNP Function @ parse-errors +.synb +.mets (parse-errors << stream ) +.syne +.desc +The +.code parse-errors +function retrieves information, from a +.metn stream , +pertaining to the status of the most recent parsing operation performed +on that stream: namely, a previous call to +.codn read , +.code iread +or +.codn get-json . + +If the +.meta stream +object has not been used for parsing, or else the most recent +parsing operation did not encounter errors, then +.code parse-errors +returns +.codn nil . + +If the most recent parsing operation on +.meta stream +encountered errors, then +.code parse-errors +function returns a positive integer value indicating the error count. +Otherwise it returns +.codn nil . + +If a parse error operation encounters a syntax error before obtaining any token +from the stream, then the error count is zero and +.code parse-errors +returns +.codn nil . +Consequently, +.code parse-errors +may be used after a failed parse operation to distinguish a true +syntax error from an end-of-stream condition. + .coNP Function @ record-adapter .synb .mets (record-adapter < regex >> [ stream <> [ include-match ]]) |