diff options
author | robot-piglet <robot-piglet@yandex-team.com> | 2023-12-02 01:45:21 +0300 |
---|---|---|
committer | robot-piglet <robot-piglet@yandex-team.com> | 2023-12-02 02:42:50 +0300 |
commit | 9c43d58f75cf086b744cf4fe2ae180e8f37e4a0c (patch) | |
tree | 9f88a486917d371d099cd712efd91b4c122d209d /contrib/libs/antlr4_cpp_runtime/src/TokenStream.h | |
parent | 32fb6dda1feb24f9ab69ece5df0cb9ec238ca5e6 (diff) | |
download | ydb-9c43d58f75cf086b744cf4fe2ae180e8f37e4a0c.tar.gz |
Intermediate changes
Diffstat (limited to 'contrib/libs/antlr4_cpp_runtime/src/TokenStream.h')
-rw-r--r-- | contrib/libs/antlr4_cpp_runtime/src/TokenStream.h | 137 |
1 files changed, 137 insertions, 0 deletions
diff --git a/contrib/libs/antlr4_cpp_runtime/src/TokenStream.h b/contrib/libs/antlr4_cpp_runtime/src/TokenStream.h new file mode 100644 index 0000000000..15b4f367a6 --- /dev/null +++ b/contrib/libs/antlr4_cpp_runtime/src/TokenStream.h @@ -0,0 +1,137 @@ +/* Copyright (c) 2012-2017 The ANTLR Project. All rights reserved. + * Use of this file is governed by the BSD 3-clause license that + * can be found in the LICENSE.txt file in the project root. + */ + +#pragma once + +#include "IntStream.h" + +namespace antlr4 { + + /// <summary> + /// An <seealso cref="IntStream"/> whose symbols are <seealso cref="Token"/> instances. + /// </summary> + class ANTLR4CPP_PUBLIC TokenStream : public IntStream { + /// <summary> + /// Get the <seealso cref="Token"/> instance associated with the value returned by + /// <seealso cref="#LA LA(k)"/>. This method has the same pre- and post-conditions as + /// <seealso cref="IntStream#LA"/>. In addition, when the preconditions of this method + /// are met, the return value is non-null and the value of + /// {@code LT(k).getType()==LA(k)}. + /// </summary> + /// <seealso cref= IntStream#LA </seealso> + public: + virtual ~TokenStream(); + + virtual Token* LT(ssize_t k) = 0; + + /// <summary> + /// Gets the <seealso cref="Token"/> at the specified {@code index} in the stream. When + /// the preconditions of this method are met, the return value is non-null. + /// <p/> + /// The preconditions for this method are the same as the preconditions of + /// <seealso cref="IntStream#seek"/>. If the behavior of {@code seek(index)} is + /// unspecified for the current state and given {@code index}, then the + /// behavior of this method is also unspecified. + /// <p/> + /// The symbol referred to by {@code index} differs from {@code seek()} only + /// in the case of filtering streams where {@code index} lies before the end + /// of the stream. Unlike {@code seek()}, this method does not adjust + /// {@code index} to point to a non-ignored symbol. + /// </summary> + /// <exception cref="IllegalArgumentException"> if {code index} is less than 0 </exception> + /// <exception cref="UnsupportedOperationException"> if the stream does not support + /// retrieving the token at the specified index </exception> + virtual Token* get(size_t index) const = 0; + + /// Gets the underlying TokenSource which provides tokens for this stream. + virtual TokenSource* getTokenSource() const = 0; + + /// <summary> + /// Return the text of all tokens within the specified {@code interval}. This + /// method behaves like the following code (including potential exceptions + /// for violating preconditions of <seealso cref="#get"/>, but may be optimized by the + /// specific implementation. + /// + /// <pre> + /// TokenStream stream = ...; + /// String text = ""; + /// for (int i = interval.a; i <= interval.b; i++) { + /// text += stream.get(i).getText(); + /// } + /// </pre> + /// </summary> + /// <param name="interval"> The interval of tokens within this stream to get text + /// for. </param> + /// <returns> The text of all tokens within the specified interval in this + /// stream. + /// </returns> + /// <exception cref="NullPointerException"> if {@code interval} is {@code null} </exception> + virtual std::string getText(const misc::Interval &interval) = 0; + + /// <summary> + /// Return the text of all tokens in the stream. This method behaves like the + /// following code, including potential exceptions from the calls to + /// <seealso cref="IntStream#size"/> and <seealso cref="#getText(Interval)"/>, but may be + /// optimized by the specific implementation. + /// + /// <pre> + /// TokenStream stream = ...; + /// String text = stream.getText(new Interval(0, stream.size())); + /// </pre> + /// </summary> + /// <returns> The text of all tokens in the stream. </returns> + virtual std::string getText() = 0; + + /// <summary> + /// Return the text of all tokens in the source interval of the specified + /// context. This method behaves like the following code, including potential + /// exceptions from the call to <seealso cref="#getText(Interval)"/>, but may be + /// optimized by the specific implementation. + /// </p> + /// If {@code ctx.getSourceInterval()} does not return a valid interval of + /// tokens provided by this stream, the behavior is unspecified. + /// + /// <pre> + /// TokenStream stream = ...; + /// String text = stream.getText(ctx.getSourceInterval()); + /// </pre> + /// </summary> + /// <param name="ctx"> The context providing the source interval of tokens to get + /// text for. </param> + /// <returns> The text of all tokens within the source interval of {@code ctx}. </returns> + virtual std::string getText(RuleContext *ctx) = 0; + + /// <summary> + /// Return the text of all tokens in this stream between {@code start} and + /// {@code stop} (inclusive). + /// <p/> + /// If the specified {@code start} or {@code stop} token was not provided by + /// this stream, or if the {@code stop} occurred before the {@code start} + /// token, the behavior is unspecified. + /// <p/> + /// For streams which ensure that the <seealso cref="Token#getTokenIndex"/> method is + /// accurate for all of its provided tokens, this method behaves like the + /// following code. Other streams may implement this method in other ways + /// provided the behavior is consistent with this at a high level. + /// + /// <pre> + /// TokenStream stream = ...; + /// String text = ""; + /// for (int i = start.getTokenIndex(); i <= stop.getTokenIndex(); i++) { + /// text += stream.get(i).getText(); + /// } + /// </pre> + /// </summary> + /// <param name="start"> The first token in the interval to get text for. </param> + /// <param name="stop"> The last token in the interval to get text for (inclusive). </param> + /// <returns> The text of all tokens lying between the specified {@code start} + /// and {@code stop} tokens. + /// </returns> + /// <exception cref="UnsupportedOperationException"> if this stream does not support + /// this method for the specified tokens </exception> + virtual std::string getText(Token *start, Token *stop) = 0; + }; + +} // namespace antlr4 |