o

laika.parse.markup

DocumentParser

object DocumentParser

Responsible for creating the top level parsers for text markup and template documents, by combining the parser for the root element with a parser for an (optional) configuration header.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DocumentParser
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class DocumentInput(path: Path, source: SourceCursor) extends Product with Serializable
  2. case class InvalidDocument(errors: Either[NonEmptyChain[ConfigError], NonEmptyChain[Invalid]], path: Path) extends RuntimeException with Product with Serializable
  3. case class InvalidDocuments(documents: NonEmptyChain[InvalidDocument]) extends RuntimeException with Product with Serializable
  4. case class ParserError(message: String, path: Path) extends RuntimeException with TransformationError with Product with Serializable
  5. case class RendererError(message: String, path: Path) extends RuntimeException with TransformationError with Product with Serializable
  6. sealed trait TransformationError extends RuntimeException

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def forMarkup(rootParser: Parser[RootElement], configProvider: ConfigProvider): (DocumentInput) ⇒ Either[ParserError, UnresolvedDocument]

    Combines the specified parsers for the root element and for (optional) configuration headers to create a parser function for an entire text markup document.

  9. def forMarkup(markupParser: MarkupFormat, markupExtensions: MarkupExtensions, configProvider: ConfigProvider): (DocumentInput) ⇒ Either[ParserError, UnresolvedDocument]

    Combines the specified markup parsers and extensions and the parser for (optional) configuration headers to create a parser function for an entire text markup document.

  10. def forParser[T](p: (Path) ⇒ Parser[T]): (DocumentInput) ⇒ Either[ParserError, T]

    A document parser function for the specified parser that is expected to consume all input.

    A document parser function for the specified parser that is expected to consume all input.

    The specified function is invoked for each parsed document, so that a parser dependent on the input path can be created.

  11. def forStyleSheets(parser: Parser[Set[StyleDeclaration]]): (DocumentInput) ⇒ Either[ParserError, StyleDeclarationSet]

    Builds a document parser for CSS documents based on the specified parser for style declarations.

  12. def forTemplate(rootParser: Parser[TemplateRoot], configProvider: ConfigProvider): (DocumentInput) ⇒ Either[ParserError, TemplateDocument]

    Combines the specified parsers for the root element and for (optional) configuration headers to create a parser function for an entire template document.

  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. object DocumentInput extends Serializable
  25. object InvalidDocument extends Serializable
  26. object InvalidDocuments extends Serializable
  27. object ParserError extends Serializable
  28. object RendererError extends Serializable

Deprecated Value Members

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

Inherited from AnyRef

Inherited from Any

Ungrouped