trait SourceFragment extends SourceCursor
Represents any source cursor other than the root cursor and it is mandated by some APIs that solely deal with recursive parsing where the root input will never be used as the source for the parser.
- Alphabetic
- By Inheritance
- SourceFragment
- SourceCursor
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
abstract
type
Self <: SourceFragment
- Definition Classes
- SourceFragment → SourceCursor
Abstract Value Members
-
abstract
def
atEnd: Boolean
Indicates whether this contexts offset is behind the last character of the input string
Indicates whether this contexts offset is behind the last character of the input string
- Definition Classes
- SourceCursor
-
abstract
def
capture(numChars: Int): String
Captures a string containing the specified number of characters from the current offset.
Captures a string containing the specified number of characters from the current offset. If the number of remaining characters is less than the specified number, all remaining characters will be returned.
- Definition Classes
- SourceCursor
-
abstract
def
consume(numChars: Int): Self
Consumes the specified number of characters, returning a new
SourceCursorwith the new offset.Consumes the specified number of characters, returning a new
SourceCursorwith the new offset.- Definition Classes
- SourceCursor
-
abstract
def
input: String
The full input string, containing the string portions before and after the current offset.
The full input string, containing the string portions before and after the current offset.
- Definition Classes
- SourceCursor
-
abstract
def
nestLevel: Int
The nest level of this cursor in case of recursive parsing.
The nest level of this cursor in case of recursive parsing.
- Definition Classes
- SourceCursor
-
abstract
def
nextNestLevel: Self
Create a new instance of this cursor with the nestLevel incremented.
Create a new instance of this cursor with the nestLevel incremented.
- Definition Classes
- SourceCursor
-
abstract
def
offset: Int
The offset of this cursor from the start of the source.
The offset of this cursor from the start of the source.
- Definition Classes
- SourceCursor
-
abstract
def
position: Position
The current position in the input string.
The current position in the input string.
- Definition Classes
- SourceCursor
-
abstract
def
remaining: Int
Indicates the number of characters remaining in the input string after the current offset.
Indicates the number of characters remaining in the input string after the current offset.
- Definition Classes
- SourceCursor
-
abstract
def
reverse: Self
Returns a new
SourceCursorwith the input string being reversed, but pointing to the same character as this context.Returns a new
SourceCursorwith the input string being reversed, but pointing to the same character as this context.This is a low-level optimization for parsers that look for strings like email addresses where the first character is not significant, so that parsing backwards from any
@encountered in the input provided better performance.- Definition Classes
- SourceCursor
-
abstract
def
root: RootSource
The source for the root input, positioned to match the offset of this (potentially nested) source.
The source for the root input, positioned to match the offset of this (potentially nested) source.
- Definition Classes
- SourceCursor
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
canConsume(maxChars: Int): Int
- Attributes
- protected
- Definition Classes
- SourceCursor
-
def
char: Char
The character at the current offset.
The character at the current offset.
- Definition Classes
- SourceCursor
-
def
charAt(relativeOffset: Int): Char
The character at the specified offset, relative from the current offset.
The character at the specified offset, relative from the current offset.
- Definition Classes
- SourceCursor
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
length: Int
The length of the input of this cursor.
The length of the input of this cursor.
- Definition Classes
- SourceCursor
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
path: Option[Path]
The (virtual) path of the document this input originates from; may be empty in case of generated sources.
The (virtual) path of the document this input originates from; may be empty in case of generated sources.
- Definition Classes
- SourceCursor
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated