diff options
author | Kaz Kylheku <kaz@kylheku.com> | 2019-10-16 15:45:28 -0700 |
---|---|---|
committer | Kaz Kylheku <kaz@kylheku.com> | 2019-10-16 15:45:28 -0700 |
commit | e327bc964cc81e8da899b35cb4ab9f660066e918 (patch) | |
tree | 343ad64d629d1c82136ca57612eb9b3276d2bd87 | |
parent | dda2602873812a9668c3c89f1655225fac9b5b7e (diff) | |
download | txr-e327bc964cc81e8da899b35cb4ab9f660066e918.tar.gz txr-e327bc964cc81e8da899b35cb4ab9f660066e918.tar.bz2 txr-e327bc964cc81e8da899b35cb4ab9f660066e918.zip |
doc: read-until-match effect on stream position.
* txr.1: Document athat the read-until-match, scan-until-match
and count-until-match functions leave the stream position in
an unspecified state, since the position returned by
seek-stream doesn't take into account push-back characters.
-rw-r--r-- | txr.1 | 23 |
1 files changed, 23 insertions, 0 deletions
@@ -43449,6 +43449,16 @@ removed from the stream. If .meta include-match is true, that matching text is included in the returned string. Otherwise, it is discarded. +The next available character in the stream is the first +non-matching character following the matched text. +However, the next available character, as well as some number of +subsequent characters, may originate from the stream's push-back buffer, +rather than from the underlying operating system object, +due to this function's internal use of the +.code unget-char +function. Therefore, the stream position, as would be reported by +.codn seek-stream , +is unspecified. .coNP Functions @ scan-until-match and @ count-until-match .synb @@ -43493,6 +43503,19 @@ and whose .code cdr holds a character string that comprises the text matched by .metn regex . +The text matched by +.meta regex +is as long as possible, and is removed from the stream. +The next available character in the stream is the first +non-matching character following the matched text. +However, the next available character, as well as some number of +subsequent characters, may originate from the stream's push-back buffer, +rather than from the underlying operating system object, +due to these functions' internal use of the +.code unget-char +function. Therefore, the stream position, as would be reported by +.codn seek-stream , +is unspecified. .coNP Functions @, m^$ @ m^ and @ m$ .synb |