Packages

class BlockSource extends SourceFragment

A block source represents the source for a block level element where each individual line might have a different x-offset to the root source.

This type of source is essential to preserve position tracking in recursive block parsing. For block level markup the first passes have to identify the type of block and remove their markup decoration. The remaining inline markup is then passed to inline parsers, but the input to those parsers is no longer a consecutive substring of the root input, making it hard to provide exact positions in error messages.

This type of source cursor solves this issue by providing a view to parsers that looks like a consecutive string of inline markup without the stripped decoration, while maintaining the x- and y-offsets of each line in relation to the root source.

Such a source will be used in multi-pass parsers, where the root parser might strip some markup decoration from each line and then pass the result down to the next recursion. In such a case each line might have a different x-offset from the root input. The use of this instance ensures that the correct position can still be tracked.

Linear Supertypes
SourceFragment, SourceCursor, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BlockSource
  2. SourceFragment
  3. SourceCursor
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BlockSource(inputRef: InputString, lines: NonEmptyChain[LineSource], offset: Int, nestLevel: Int)

Type Members

  1. type Self = BlockSource
    Definition Classes
    BlockSource → SourceFragment → SourceCursor

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. 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
    BlockSource → SourceCursor
  6. def canConsume(maxChars: Int): Int
    Attributes
    protected
    Definition Classes
    SourceCursor
  7. 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
    BlockSource → SourceCursor
  8. def char: Char

    The character at the current offset.

    The character at the current offset.

    Definition Classes
    SourceCursor
  9. 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
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  11. def consume(numChars: Int): BlockSource

    Consumes the specified number of characters, returning a new SourceCursor with the new offset.

    Consumes the specified number of characters, returning a new SourceCursor with the new offset.

    Definition Classes
    BlockSource → SourceCursor
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(obj: Any): Boolean
    Definition Classes
    BlockSource → AnyRef → Any
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def hashCode(): Int
    Definition Classes
    BlockSource → AnyRef → Any
  16. lazy val 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
    BlockSource → SourceCursor
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def length: Int

    The length of the input of this cursor.

    The length of the input of this cursor.

    Definition Classes
    SourceCursor
  19. val lines: NonEmptyChain[LineSource]
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. val 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
    BlockSource → SourceCursor
  22. def nextNestLevel: BlockSource

    Create a new instance of this cursor with the nestLevel incremented.

    Create a new instance of this cursor with the nestLevel incremented.

    Definition Classes
    BlockSource → SourceCursor
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. val 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
    BlockSource → SourceCursor
  26. 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
  27. lazy val position: Position

    The current position in the input string.

    The current position in the input string.

    Definition Classes
    BlockSource → SourceCursor
  28. 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
    BlockSource → SourceCursor
  29. def reverse: BlockSource

    Returns a new SourceCursor with the input string being reversed, but pointing to the same character as this context.

    Returns a new SourceCursor with 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
    BlockSource → SourceCursor
  30. lazy val 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
    BlockSource → SourceCursor
  31. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  32. def toString(): String
    Definition Classes
    BlockSource → AnyRef → Any
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from SourceFragment

Inherited from SourceCursor

Inherited from AnyRef

Inherited from Any

Ungrouped