Safe Haskell	Safe-Inferred
Language	Haskell2010

Text.XML.DOM.Parser.Types

Contents

Element matching
Name matching
Parser internals
Auxiliary

Synopsis

data ElemMatcher = ElemMatcher {
- _emMatch :: Element -> Bool
- _emShow :: Text
}
emMatch :: Lens' ElemMatcher (Element -> Bool)
emShow :: Lens' ElemMatcher Text
matchElemName :: NameMatcher -> ElemMatcher
elMatch :: ElemMatcher -> Traversal' Element Element
data NameMatcher = NameMatcher {
- _nmMatch :: Name -> Bool
- _nmShow :: Text
}
nmMatch :: Lens' NameMatcher (Name -> Bool)
nmShow :: Lens' NameMatcher Text
matchName :: Name -> NameMatcher
matchLocalName :: Text -> NameMatcher
matchCILocalName :: Text -> NameMatcher
newtype DomPath = DomPath {
- unDomPath :: [Text]
}
data ParserError
- = PENotFound {
  - _pePath :: DomPath
  }
- | PEAttributeNotFound {
  - _peAttributeName :: NameMatcher
  - _pePath :: DomPath
  }
- | PEAttributeWrongFormat {
  - _peAttributeName :: NameMatcher
  - _peDetails :: Text
  - _pePath :: DomPath
  }
- | PEContentNotFound {
  - _pePath :: DomPath
  }
- | PEContentWrongFormat {
  - _peDetails :: Text
  - _pePath :: DomPath
  }
- | PEOther {
  - _peDetails :: Text
  - _pePath :: DomPath
  }
pePath :: Lens' ParserError DomPath
peDetails :: Traversal' ParserError Text
peAttributeName :: Traversal' ParserError NameMatcher
newtype ParserErrors = ParserErrors {
- unParserErrors :: [ParserError]
}
_ParserErrors :: Iso' ParserErrors [ParserError]
data ParserData f = ParserData {
- _pdElements :: f Element
- _pdPath :: DomPath
}
pdElements :: forall f f. Lens (ParserData f) (ParserData f) (f Element) (f Element)
pdPath :: forall f. Lens' (ParserData f) DomPath
type DomParserT f m = ReaderT (ParserData f) (ExceptT ParserErrors m)
type DomParser f = DomParserT f Identity
runDomParserT :: Monad m => Document -> DomParserT Identity m a -> m (Either ParserErrors a)
runDomParser :: Document -> DomParser Identity a -> Either ParserErrors a
throwParserError :: (MonadError ParserErrors m, MonadReader (ParserData f) m) => (DomPath -> ParserError) -> m a

Element matching

data ElemMatcher Source #

Arbitrary element matcher

Since: 2.0.0

Constructors

ElemMatcher
Fields _emMatch :: Element -> Bool _emShow :: Text Field for `Show` instance and bulding usefull errors

Instances

Instances details

IsString ElemMatcher Source #	Instance using instance of `NameMatcher`
Instance details Defined in Text.XML.DOM.Parser.Types Methods fromString :: String -> ElemMatcher #
Show ElemMatcher Source #
Instance details Defined in Text.XML.DOM.Parser.Types Methods showsPrec :: Int -> ElemMatcher -> ShowS # show :: ElemMatcher -> String # showList :: [ElemMatcher] -> ShowS #

emMatch :: Lens' ElemMatcher (Element -> Bool) Source #

emShow :: Lens' ElemMatcher Text Source #

matchElemName :: NameMatcher -> ElemMatcher Source #

Match element by name

Since: 2.0.0

elMatch :: ElemMatcher -> Traversal' Element Element Source #

Match over elements

Since: 2.0.0

Name matching

data NameMatcher Source #

Arbitrary name matcher. Match name any way you want, but considered to be used as comparator with some name with some rules

Since: 2.0.0

Constructors

NameMatcher
Fields _nmMatch :: Name -> Bool Name matching function, usually should be simple comparsion function takin in account only local name or other components of `Name` _nmShow :: Text Field for `Show` instance and bulding usefull errors

Instances

Instances details

IsString NameMatcher Source #	Instance use `matchCILocalName` as most general and liberal matching strategy (while XML is often malformed). Since: 2.0.0
Instance details Defined in Text.XML.DOM.Parser.Types Methods fromString :: String -> NameMatcher #
Show NameMatcher Source #
Instance details Defined in Text.XML.DOM.Parser.Types Methods showsPrec :: Int -> NameMatcher -> ShowS # show :: NameMatcher -> String # showList :: [NameMatcher] -> ShowS #

nmMatch :: Lens' NameMatcher (Name -> Bool) Source #

nmShow :: Lens' NameMatcher Text Source #

matchName :: Name -> NameMatcher Source #

Makes matcher which match name by Eq with given

Since: 2.0.0

matchLocalName :: Text -> NameMatcher Source #

Makes matcher which matches only local part of name igoring namespace and prefix. Local name matching is case sensitive.

Since: 2.0.0

matchCILocalName :: Text -> NameMatcher Source #

Makes matcher which matches only local part of name igoring namespace and prefix. Local name matching is case insensitive. This is the most common case.

Since: 2.0.0

Parser internals

newtype DomPath Source #

Path some element should be found at. Path starts from the root element of the document. Errors are much more usefull with path.

Constructors

DomPath
Fields unDomPath :: [Text]

Instances

Instances details

Monoid DomPath Source #
Instance details Defined in Text.XML.DOM.Parser.Types Methods mempty :: DomPath # mappend :: DomPath -> DomPath -> DomPath # mconcat :: [DomPath] -> DomPath #
Semigroup DomPath Source #
Instance details Defined in Text.XML.DOM.Parser.Types Methods (<>) :: DomPath -> DomPath -> DomPath # sconcat :: NonEmpty DomPath -> DomPath # stimes :: Integral b => b -> DomPath -> DomPath #
Show DomPath Source #
Instance details Defined in Text.XML.DOM.Parser.Types Methods showsPrec :: Int -> DomPath -> ShowS # show :: DomPath -> String # showList :: [DomPath] -> ShowS #
Eq DomPath Source #
Instance details Defined in Text.XML.DOM.Parser.Types Methods (==) :: DomPath -> DomPath -> Bool # (/=) :: DomPath -> DomPath -> Bool #
Ord DomPath Source #
Instance details Defined in Text.XML.DOM.Parser.Types Methods compare :: DomPath -> DomPath -> Ordering # (<) :: DomPath -> DomPath -> Bool # (<=) :: DomPath -> DomPath -> Bool # (>) :: DomPath -> DomPath -> Bool # (>=) :: DomPath -> DomPath -> Bool # max :: DomPath -> DomPath -> DomPath # min :: DomPath -> DomPath -> DomPath #

data ParserError Source #

DOM parser error description.

Constructors

PENotFound	Tag not found which should be.
Fields _pePath :: DomPath Path of element error occured in
PEAttributeNotFound	Expected attribute but not found Since: 1.0.0
Fields _peAttributeName :: NameMatcher _pePath :: DomPath Path of element error occured in
PEAttributeWrongFormat	Could not parse attribute Since: 1.0.0
Fields _peAttributeName :: NameMatcher _peDetails :: Text _pePath :: DomPath Path of element error occured in
PEContentNotFound	Node should have text content, but it does not.
Fields _pePath :: DomPath Path of element error occured in
PEContentWrongFormat	Tag contents has wrong format, (could not read text to value)
Fields _peDetails :: Text _pePath :: DomPath Path of element error occured in
PEOther	Some other error
Fields _peDetails :: Text _pePath :: DomPath Path of element error occured in

Instances

Instances details

Exception ParserError Source #
Instance details Defined in Text.XML.DOM.Parser.Types Methods toException :: ParserError -> SomeException # fromException :: SomeException -> Maybe ParserError # displayException :: ParserError -> String #
Generic ParserError Source #
Instance details Defined in Text.XML.DOM.Parser.Types Associated Types type Rep ParserError :: Type -> Type # Methods from :: ParserError -> Rep ParserError x # to :: Rep ParserError x -> ParserError #
Show ParserError Source #
Instance details Defined in Text.XML.DOM.Parser.Types Methods showsPrec :: Int -> ParserError -> ShowS # show :: ParserError -> String # showList :: [ParserError] -> ShowS #
type Rep ParserError Source #
Instance details Defined in Text.XML.DOM.Parser.Types type Rep ParserError = D1 ('MetaData "ParserError" "Text.XML.DOM.Parser.Types" "dom-parser-3.2.0-IGvKALn5GGL30CFrMXvJrq" 'False) ((C1 ('MetaCons "PENotFound" 'PrefixI 'True) (S1 ('MetaSel ('Just "_pePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DomPath)) :+: (C1 ('MetaCons "PEAttributeNotFound" 'PrefixI 'True) (S1 ('MetaSel ('Just "_peAttributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NameMatcher) :: S1 ('MetaSel ('Just "_pePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DomPath)) :+: C1 ('MetaCons "PEAttributeWrongFormat" 'PrefixI 'True) (S1 ('MetaSel ('Just "_peAttributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NameMatcher) :: (S1 ('MetaSel ('Just "_peDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "_pePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DomPath))))) :+: (C1 ('MetaCons "PEContentNotFound" 'PrefixI 'True) (S1 ('MetaSel ('Just "_pePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DomPath)) :+: (C1 ('MetaCons "PEContentWrongFormat" 'PrefixI 'True) (S1 ('MetaSel ('Just "_peDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "_pePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DomPath)) :+: C1 ('MetaCons "PEOther" 'PrefixI 'True) (S1 ('MetaSel ('Just "_peDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "_pePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DomPath)))))

pePath :: Lens' ParserError DomPath Source #

peDetails :: Traversal' ParserError Text Source #

peAttributeName :: Traversal' ParserError NameMatcher Source #

newtype ParserErrors Source #

Constructors

ParserErrors
Fields unParserErrors :: [ParserError]

Instances

Instances details

Monoid ParserErrors Source #
Instance details Defined in Text.XML.DOM.Parser.Types Methods mempty :: ParserErrors # mappend :: ParserErrors -> ParserErrors -> ParserErrors # mconcat :: [ParserErrors] -> ParserErrors #
Semigroup ParserErrors Source #
Instance details Defined in Text.XML.DOM.Parser.Types Methods (<>) :: ParserErrors -> ParserErrors -> ParserErrors # sconcat :: NonEmpty ParserErrors -> ParserErrors # stimes :: Integral b => b -> ParserErrors -> ParserErrors #
Exception ParserErrors Source #
Instance details Defined in Text.XML.DOM.Parser.Types Methods toException :: ParserErrors -> SomeException # fromException :: SomeException -> Maybe ParserErrors # displayException :: ParserErrors -> String #
Generic ParserErrors Source #
Instance details Defined in Text.XML.DOM.Parser.Types Associated Types type Rep ParserErrors :: Type -> Type # Methods from :: ParserErrors -> Rep ParserErrors x # to :: Rep ParserErrors x -> ParserErrors #
Show ParserErrors Source #
Instance details Defined in Text.XML.DOM.Parser.Types Methods showsPrec :: Int -> ParserErrors -> ShowS # show :: ParserErrors -> String # showList :: [ParserErrors] -> ShowS #
type Rep ParserErrors Source #
Instance details Defined in Text.XML.DOM.Parser.Types type Rep ParserErrors = D1 ('MetaData "ParserErrors" "Text.XML.DOM.Parser.Types" "dom-parser-3.2.0-IGvKALn5GGL30CFrMXvJrq" 'True) (C1 ('MetaCons "ParserErrors" 'PrefixI 'True) (S1 ('MetaSel ('Just "unParserErrors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ParserError])))

_ParserErrors :: Iso' ParserErrors [ParserError] Source #

data ParserData f Source #

Parser scope.

Functor argument is usually Identity or [].

If functor is Identity then parser expects exactly ONE current element. This is common behavior for content parsers, or parsers expecting strict XML structure.

If functor is [] then parser expects arbitrary current elements count. This is the case when you use combinators divePath or diveElem (posible other variants of similar combinators). This kind of combinators performs search for elements somewhere in descendants and result have arbitrary length in common case.

Constructors

ParserData
Fields _pdElements :: f Element Current element(s). Functor is intended to be either `Identity` or `[]` _pdPath :: DomPath Path for error reporting

pdElements :: forall f f. Lens (ParserData f) (ParserData f) (f Element) (f Element) Source #

pdPath :: forall f. Lens' (ParserData f) DomPath Source #

type DomParserT f m = ReaderT (ParserData f) (ExceptT ParserErrors m) Source #

type DomParser f = DomParserT f Identity Source #

runDomParserT :: Monad m => Document -> DomParserT Identity m a -> m (Either ParserErrors a) Source #

Run parser on root element of Document.

runDomParser :: Document -> DomParser Identity a -> Either ParserErrors a Source #

Auxiliary

throwParserError :: (MonadError ParserErrors m, MonadReader (ParserData f) m) => (DomPath -> ParserError) -> m a Source #