CSharp.src.ICharStream.cs Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of antlr4-runtime-testsuite Show documentation

A collection of tests for ANTLR 4 Runtime libraries.

There is a newer version: 4.13.2

Show newest version

/* 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.
 */
using Antlr4.Runtime;
using Antlr4.Runtime.Misc;
using Antlr4.Runtime.Sharpen;

namespace Antlr4.Runtime
{
    /// A source of characters for an ANTLR lexer.
    /// A source of characters for an ANTLR lexer.
    public interface ICharStream : IIntStream
    {
        /// 
        /// This method returns the text for a range of characters within this input
        /// stream.
        /// 
        /// 
        /// This method returns the text for a range of characters within this input
        /// stream. This method is guaranteed to not throw an exception if the
        /// specified
        /// 
        /// lies entirely within a marked range. For more
        /// information about marked ranges, see
        /// 
        /// .
        /// 
        /// an interval within the stream
        /// the text of the specified interval
        /// 
        /// if
        /// 
        /// is
        /// 
        /// 
        /// 
        /// if
        /// interval.a < 0
        /// , or if
        /// interval.b < interval.a - 1
        /// , or if
        /// interval.b
        /// lies at or
        /// past the end of the stream
        /// 
        /// 
        /// if the stream does not support
        /// getting the text of the specified interval
        /// 
        [return: NotNull]
        string GetText(Interval interval);
    }
}