Safe Haskell	None
Language	Haskell2010

Zenacy.HTML.Internal.HTML

Description

Defines the top-level HTML types and parser functions.

Synopsis

data HTMLOptions = HTMLOptions {
- htmlOptionLogErrors :: !Bool
- htmlOptionIgnoreEntities :: !Bool
}
data HTMLResult = HTMLResult {
- htmlResultDocument :: !HTMLNode
- htmlResultErrors :: ![HTMLError]
}
data HTMLError = HTMLError {
- htmlErrorText :: !Text
}
data HTMLNode
- = HTMLDocument {
  - htmlDocumentName :: !Text
  - htmlDocumentChildren :: ![HTMLNode]
  }
- | HTMLDoctype {
  - htmlDoctypeName :: !Text
  - htmlDoctypePublicID :: !(Maybe Text)
  - htmlDoctypeSystemID :: !(Maybe Text)
  }
- | HTMLFragment {
  - htmlFragmentName :: !Text
  - htmlFragmentChildren :: ![HTMLNode]
  }
- | HTMLElement {
  - htmlElementName :: !Text
  - htmlElementNamespace :: !HTMLNamespace
  - htmlElementAttributes :: ![HTMLAttr]
  - htmlElementChildren :: ![HTMLNode]
  }
- | HTMLTemplate {
  - htmlTemplateNamespace :: !HTMLNamespace
  - htmlTemplateAttributes :: ![HTMLAttr]
  - htmlTemplateContents :: !HTMLNode
  }
- | HTMLText {
  - htmlTextData :: !Text
  }
- | HTMLComment {
  - htmlCommentData :: !Text
  }
data HTMLAttr = HTMLAttr {
- htmlAttrName :: Text
- htmlAttrVal :: Text
- htmlAttrNamespace :: HTMLAttrNamespace
}
data HTMLNamespace
- = HTMLNamespaceHTML
- | HTMLNamespaceSVG
- | HTMLNamespaceMathML
data HTMLAttrNamespace
- = HTMLAttrNamespaceNone
- | HTMLAttrNamespaceXLink
- | HTMLAttrNamespaceXML
- | HTMLAttrNamespaceXMLNS
htmlParse :: HTMLOptions -> Text -> Either HTMLError HTMLResult
htmlParseEasy :: Text -> HTMLNode
htmlFragment :: HTMLOptions -> Text -> Either HTMLError HTMLResult
htmlDefaultDocument :: HTMLNode
htmlDefaultDoctype :: HTMLNode
htmlDefaultFragment :: HTMLNode
htmlDefaultElement :: HTMLNode
htmlDefaultTemplate :: HTMLNode
htmlDefaultText :: HTMLNode
htmlDefaultComment :: HTMLNode
htmlAttr :: Text -> Text -> HTMLAttr
htmlElem :: Text -> [HTMLAttr] -> [HTMLNode] -> HTMLNode
htmlText :: Text -> HTMLNode

Documentation

data HTMLOptions Source #

Defines options for the HTML parser.

Constructors

HTMLOptions
Fields htmlOptionLogErrors :: !Bool Indicates that errors should be logged. htmlOptionIgnoreEntities :: !Bool Indicates that entities should not be decoded.

Instances

Eq HTMLOptions Source #
Instance details Defined in Zenacy.HTML.Internal.HTML Methods (==) :: HTMLOptions -> HTMLOptions -> Bool # (/=) :: HTMLOptions -> HTMLOptions -> Bool #
Ord HTMLOptions Source #
Instance details Defined in Zenacy.HTML.Internal.HTML Methods compare :: HTMLOptions -> HTMLOptions -> Ordering # (<) :: HTMLOptions -> HTMLOptions -> Bool # (<=) :: HTMLOptions -> HTMLOptions -> Bool # (>) :: HTMLOptions -> HTMLOptions -> Bool # (>=) :: HTMLOptions -> HTMLOptions -> Bool # max :: HTMLOptions -> HTMLOptions -> HTMLOptions # min :: HTMLOptions -> HTMLOptions -> HTMLOptions #
Show HTMLOptions Source #
Instance details Defined in Zenacy.HTML.Internal.HTML Methods showsPrec :: Int -> HTMLOptions -> ShowS # show :: HTMLOptions -> String # showList :: [HTMLOptions] -> ShowS #
Default HTMLOptions Source #	Defines default options.
Instance details Defined in Zenacy.HTML.Internal.HTML Methods def :: HTMLOptions #

data HTMLResult Source #

Defines an HTML parser result.

Constructors

HTMLResult
Fields htmlResultDocument :: !HTMLNode The parsed document structure. htmlResultErrors :: ![HTMLError] The errors logged while parsing if error logging was enabled.

Instances

Eq HTMLResult Source #
Instance details Defined in Zenacy.HTML.Internal.HTML Methods (==) :: HTMLResult -> HTMLResult -> Bool # (/=) :: HTMLResult -> HTMLResult -> Bool #
Ord HTMLResult Source #
Instance details Defined in Zenacy.HTML.Internal.HTML Methods compare :: HTMLResult -> HTMLResult -> Ordering # (<) :: HTMLResult -> HTMLResult -> Bool # (<=) :: HTMLResult -> HTMLResult -> Bool # (>) :: HTMLResult -> HTMLResult -> Bool # (>=) :: HTMLResult -> HTMLResult -> Bool # max :: HTMLResult -> HTMLResult -> HTMLResult # min :: HTMLResult -> HTMLResult -> HTMLResult #
Show HTMLResult Source #
Instance details Defined in Zenacy.HTML.Internal.HTML Methods showsPrec :: Int -> HTMLResult -> ShowS # show :: HTMLResult -> String # showList :: [HTMLResult] -> ShowS #
Default HTMLResult Source #	Defines a default result.
Instance details Defined in Zenacy.HTML.Internal.HTML Methods def :: HTMLResult #

data HTMLError Source #

An HTML error type.

Constructors

HTMLError
Fields htmlErrorText :: !Text The error message.

Instances

Eq HTMLError Source #
Instance details Defined in Zenacy.HTML.Internal.HTML Methods (==) :: HTMLError -> HTMLError -> Bool # (/=) :: HTMLError -> HTMLError -> Bool #
Ord HTMLError Source #
Instance details Defined in Zenacy.HTML.Internal.HTML Methods compare :: HTMLError -> HTMLError -> Ordering # (<) :: HTMLError -> HTMLError -> Bool # (<=) :: HTMLError -> HTMLError -> Bool # (>) :: HTMLError -> HTMLError -> Bool # (>=) :: HTMLError -> HTMLError -> Bool # max :: HTMLError -> HTMLError -> HTMLError # min :: HTMLError -> HTMLError -> HTMLError #
Show HTMLError Source #
Instance details Defined in Zenacy.HTML.Internal.HTML Methods showsPrec :: Int -> HTMLError -> ShowS # show :: HTMLError -> String # showList :: [HTMLError] -> ShowS #
Default HTMLError Source #	Defines a default error.
Instance details Defined in Zenacy.HTML.Internal.HTML Methods def :: HTMLError #

data HTMLNode Source #

Defines the model type for an HTML document.

Constructors

HTMLDocument
Fields htmlDocumentName :: !Text The document name. htmlDocumentChildren :: ![HTMLNode] The document children.
HTMLDoctype
Fields htmlDoctypeName :: !Text The DOCTYPE name. htmlDoctypePublicID :: !(Maybe Text) The public ID. htmlDoctypeSystemID :: !(Maybe Text) The system ID.
HTMLFragment
Fields htmlFragmentName :: !Text The fragment name. htmlFragmentChildren :: ![HTMLNode] The fragment children.
HTMLElement
Fields htmlElementName :: !Text The element name. htmlElementNamespace :: !HTMLNamespace The element namespace. htmlElementAttributes :: ![HTMLAttr] The element attributes. htmlElementChildren :: ![HTMLNode] The element children.
HTMLTemplate
Fields htmlTemplateNamespace :: !HTMLNamespace The template namespace. htmlTemplateAttributes :: ![HTMLAttr] The template attributes. htmlTemplateContents :: !HTMLNode The template contents.
HTMLText
Fields htmlTextData :: !Text The text value.
HTMLComment
Fields htmlCommentData :: !Text The comment text.

Instances

Eq HTMLNode Source #
Instance details Defined in Zenacy.HTML.Internal.HTML Methods (==) :: HTMLNode -> HTMLNode -> Bool # (/=) :: HTMLNode -> HTMLNode -> Bool #
Ord HTMLNode Source #
Instance details Defined in Zenacy.HTML.Internal.HTML Methods compare :: HTMLNode -> HTMLNode -> Ordering # (<) :: HTMLNode -> HTMLNode -> Bool # (<=) :: HTMLNode -> HTMLNode -> Bool # (>) :: HTMLNode -> HTMLNode -> Bool # (>=) :: HTMLNode -> HTMLNode -> Bool # max :: HTMLNode -> HTMLNode -> HTMLNode # min :: HTMLNode -> HTMLNode -> HTMLNode #
Show HTMLNode Source #
Instance details Defined in Zenacy.HTML.Internal.HTML Methods showsPrec :: Int -> HTMLNode -> ShowS # show :: HTMLNode -> String # showList :: [HTMLNode] -> ShowS #

data HTMLAttr Source #

An HTML element attribute type.

Constructors

HTMLAttr
Fields htmlAttrName :: Text htmlAttrVal :: Text htmlAttrNamespace :: HTMLAttrNamespace

Instances

Eq HTMLAttr Source #
Instance details Defined in Zenacy.HTML.Internal.HTML Methods (==) :: HTMLAttr -> HTMLAttr -> Bool # (/=) :: HTMLAttr -> HTMLAttr -> Bool #
Ord HTMLAttr Source #
Instance details Defined in Zenacy.HTML.Internal.HTML Methods compare :: HTMLAttr -> HTMLAttr -> Ordering # (<) :: HTMLAttr -> HTMLAttr -> Bool # (<=) :: HTMLAttr -> HTMLAttr -> Bool # (>) :: HTMLAttr -> HTMLAttr -> Bool # (>=) :: HTMLAttr -> HTMLAttr -> Bool # max :: HTMLAttr -> HTMLAttr -> HTMLAttr # min :: HTMLAttr -> HTMLAttr -> HTMLAttr #
Show HTMLAttr Source #
Instance details Defined in Zenacy.HTML.Internal.HTML Methods showsPrec :: Int -> HTMLAttr -> ShowS # show :: HTMLAttr -> String # showList :: [HTMLAttr] -> ShowS #
Default HTMLAttr Source #	Defines a default attribute.
Instance details Defined in Zenacy.HTML.Internal.HTML Methods def :: HTMLAttr #

data HTMLNamespace Source #

An HTML namespace type.

Constructors

HTMLNamespaceHTML
HTMLNamespaceSVG
HTMLNamespaceMathML

Instances

Eq HTMLNamespace Source #
Instance details Defined in Zenacy.HTML.Internal.Types Methods (==) :: HTMLNamespace -> HTMLNamespace -> Bool # (/=) :: HTMLNamespace -> HTMLNamespace -> Bool #
Ord HTMLNamespace Source #
Instance details Defined in Zenacy.HTML.Internal.Types Methods compare :: HTMLNamespace -> HTMLNamespace -> Ordering # (<) :: HTMLNamespace -> HTMLNamespace -> Bool # (<=) :: HTMLNamespace -> HTMLNamespace -> Bool # (>) :: HTMLNamespace -> HTMLNamespace -> Bool # (>=) :: HTMLNamespace -> HTMLNamespace -> Bool # max :: HTMLNamespace -> HTMLNamespace -> HTMLNamespace # min :: HTMLNamespace -> HTMLNamespace -> HTMLNamespace #
Show HTMLNamespace Source #
Instance details Defined in Zenacy.HTML.Internal.Types Methods showsPrec :: Int -> HTMLNamespace -> ShowS # show :: HTMLNamespace -> String # showList :: [HTMLNamespace] -> ShowS #
Default HTMLNamespace Source #	Defines a default namespace.
Instance details Defined in Zenacy.HTML.Internal.Types Methods def :: HTMLNamespace #

data HTMLAttrNamespace Source #

An HTML attribute namespace type.

Constructors

HTMLAttrNamespaceNone
HTMLAttrNamespaceXLink
HTMLAttrNamespaceXML
HTMLAttrNamespaceXMLNS

Instances

Eq HTMLAttrNamespace Source #
Instance details Defined in Zenacy.HTML.Internal.Types Methods (==) :: HTMLAttrNamespace -> HTMLAttrNamespace -> Bool # (/=) :: HTMLAttrNamespace -> HTMLAttrNamespace -> Bool #
Ord HTMLAttrNamespace Source #
Instance details Defined in Zenacy.HTML.Internal.Types Methods compare :: HTMLAttrNamespace -> HTMLAttrNamespace -> Ordering # (<) :: HTMLAttrNamespace -> HTMLAttrNamespace -> Bool # (<=) :: HTMLAttrNamespace -> HTMLAttrNamespace -> Bool # (>) :: HTMLAttrNamespace -> HTMLAttrNamespace -> Bool # (>=) :: HTMLAttrNamespace -> HTMLAttrNamespace -> Bool # max :: HTMLAttrNamespace -> HTMLAttrNamespace -> HTMLAttrNamespace # min :: HTMLAttrNamespace -> HTMLAttrNamespace -> HTMLAttrNamespace #
Show HTMLAttrNamespace Source #
Instance details Defined in Zenacy.HTML.Internal.Types Methods showsPrec :: Int -> HTMLAttrNamespace -> ShowS # show :: HTMLAttrNamespace -> String # showList :: [HTMLAttrNamespace] -> ShowS #
Default HTMLAttrNamespace Source #	Defines a default attribute namespace.
Instance details Defined in Zenacy.HTML.Internal.Types Methods def :: HTMLAttrNamespace #