Symantic.XML.Tree.Read

Documentation

readTree :: FilePath -> IO (Either String FileSourcedTrees)

runReadTree :: FilePath -> Text -> Either (ParseErrorBundle Text Error) FileSourcedTrees

Type ErrorRead

data ErrorRead

Constructors

ErrorRead_IO IOError

ErrorRead_Unicode UnicodeException

Instances

Show ErrorRead

Defined in Symantic.XML.Tree.Read

Methods

showsPrec :: Int -> ErrorRead -> ShowS

show :: ErrorRead -> String

showList :: [ErrorRead] -> ShowS

readUtf8 :: FilePath -> IO (Either ErrorRead Text)

Type ReadTree

type ReadTree e s a = ReadTreeConstraints e s a => ReaderT ReadTreeInh (Parsec e s) a

Convenient alias.

Type ReadTreeConstraints

type ReadTreeConstraints e s a = (Stream s, Token s ~ Char, Ord e, IsString (Tokens s), ShowErrorComponent e)

Type ReadTreeInh

data ReadTreeInh

Constructors

ReadTreeInh

Fields

• readTreeInh_source :: FileSource Offset
• readTreeInh_ns_scope :: HashMap NCName Namespace
• readTreeInh_ns_default :: Namespace

Instances

Show ReadTreeInh

Defined in Symantic.XML.Tree.Read

Methods

showsPrec :: Int -> ReadTreeInh -> ShowS

show :: ReadTreeInh -> String

showList :: [ReadTreeInh] -> ShowS

defaultReadTreeInh :: ReadTreeInh

p_Offset :: ReadTree e s Offset

p_Sourced :: ReadTree e s a -> ReadTree e s (Sourced (FileSource Offset) a)

setSource :: FileRange pos -> FileSource pos -> FileSource pos

p_SourcedBegin :: ReadTree e s a -> ReadTree e s a

Like p_Sourced but uncoupled (through the use of p_SourcedEnd) for more flexibility.

p_SourcedEnd :: ReadTree e s (a -> Sourced (FileSource Offset) a)

WARNING: only to be used within a p_SourcedBegin.

Type Error

data Error

Constructors

Error_CharRef_invalid Integer

Well-formedness constraint: Legal Character.

Characters referred to using character references MUST match the production for Char.

Error_EntityRef_unknown NCName

Well-formedness constraint: Entity Declared

In a document without any DTD, a document with only an internal DTD subset which contains no parameter entity references, or a document with " standalone=yes ", for an entity reference that does not occur within the external subset or a parameter entity, the Name given in the entity reference MUST match that in an entity declaration that does not occur within the external subset or a parameter entity, except that well-formed documents need not declare any of the following entities: amp, lt, gt, apos, quot. The declaration of a general entity MUST precede any reference to it which appears in a default value in an attribute-list declaration.

Note that non-validating processors are not obligated to read and process entity declarations occurring in parameter entities or in the external subset; for such documents, the define that an entity must be declared is a well-formedness constraint only if standalone=yes.

Error_Closing_tag_unexpected QName QName

Well-formedness constraint: Element Type Match.

The Name in an element's end-tag MUST match the element type in the start-tag.

Error_Attribute_collision QName

Well-formedness constraint: Unique Att Spec.

An attribute name MUST NOT appear more than once in the same start-tag or empty-element tag.

Error_PI_reserved PName

The target names " XML ", " xml ", and so on are reserved for standardization.

Error_Namespace_prefix_unknown NCName

Namespace constraint: Prefix Declared

The namespace prefix, unless it is xml or xmlns, MUST have been declared in a namespace declaration attribute in either the start-tag of the element where the prefix is used or in an ancestor element (i.e., an element in whose content the prefixed markup occurs).

Error_Namespace_empty NCName

Namespace constraint: No Prefix Undeclaring

In a namespace declaration for a prefix (i.e., where the NSAttName is a PrefixedAttName), the attribute value MUST NOT be empty.

Error_Namespace_reserved Namespace

Error_Namespace_reserved_prefix NCName

Namespace constraint: Reserved Prefixes and Namespace Names

The prefix xml is by definition bound to the namespace name http://www.w3.org/XML/1998/namespace. It MAY, but need not, be declared, and MUST NOT be bound to any other namespace name. Other prefixes MUST NOT be bound to this namespace name, and it MUST NOT be declared as the default namespace.

The prefix xmlns is used only to declare namespace bindings and is by definition bound to the namespace name http://www.w3.org/2000/xmlns/. It MUST NOT be declared . Other prefixes MUST NOT be bound to this namespace name, and it MUST NOT be declared as the default namespace. Element names MUST NOT have the prefix xmlns.

All other prefixes beginning with the three-letter sequence x, m, l, in any case combination, are reserved. This means that:

• users SHOULD NOT use them except as defined by later specifications
• processors MUST NOT treat them as fatal errors.

Instances

Eq Error

Defined in Symantic.XML.Tree.Read

Methods

(==) :: Error -> Error -> Bool

(/=) :: Error -> Error -> Bool

Ord Error

Defined in Symantic.XML.Tree.Read

Methods

compare :: Error -> Error -> Ordering

(<) :: Error -> Error -> Bool

(<=) :: Error -> Error -> Bool

(>) :: Error -> Error -> Bool

(>=) :: Error -> Error -> Bool

max :: Error -> Error -> Error

min :: Error -> Error -> Error

Show Error

Defined in Symantic.XML.Tree.Read

Methods

showsPrec :: Int -> Error -> ShowS

show :: Error -> String

showList :: [Error] -> ShowS

ShowErrorComponent Error

Defined in Symantic.XML.Tree.Read

Methods

showErrorComponent :: Error -> String

errorComponentLen :: Error -> Int

Helpers

p_error :: e -> ReadTree e s a

p_quoted :: Tokens s ~ Text => (Char -> ReadTree e s a) -> ReadTree e s a

p_until :: Tokens s ~ Text => (Char -> Bool) -> (Char, Text) -> ReadTree e s Text

p_until1 :: Tokens s ~ Text => (Char -> Bool) -> (Char, Text) -> ReadTree e s Text

Document

p_document :: Tokens s ~ Text => ReadTree Error s FileSourcedTrees

Prolog

p_prolog :: Tokens s ~ Text => ReadTree Error s FileSourcedTrees

Misc

p_Miscs :: Tokens s ~ Text => ReadTree Error s FileSourcedTrees

XMLDecl

p_XMLDecl :: Tokens s ~ Text => ReadTree Error s FileSourcedTree

p_VersionInfo :: Tokens s ~ Text => ReadTree Error s FileSourcedTree

p_EncodingDecl :: Tokens s ~ Text => ReadTree Error s FileSourcedTree

p_EncName :: Tokens s ~ Text => ReadTree Error s Text

SDDecl

p_SDDecl :: Tokens s ~ Text => ReadTree Error s FileSourcedTree

CharData

p_CharData :: Tokens s ~ Text => ReadTree e s EscapedText

Comment

p_Comment :: Tokens s ~ Text => ReadTree Error s FileSourcedTree

p_Comment_ :: Tokens s ~ Text => ReadTree Error s FileSourcedTree

p_Comment__ :: Tokens s ~ Text => ReadTree Error s FileSourcedTree

CDATA

p_CDSect :: Tokens s ~ Text => ReadTree Error s FileSourcedTree

p_CDSect_ :: Tokens s ~ Text => ReadTree Error s FileSourcedTree

p_CDSect__ :: Tokens s ~ Text => ReadTree Error s FileSourcedTree

PI

p_PI :: Tokens s ~ Text => ReadTree Error s FileSourcedTree

p_PI_ :: Tokens s ~ Text => ReadTree Error s FileSourcedTree

p_PI__ :: Tokens s ~ Text => ReadTree Error s FileSourcedTree

p_PITarget :: Tokens s ~ Text => ReadTree Error s PName

Element

p_Element :: Tokens s ~ Text => ReadTree Error s FileSourcedTree

p_Element_ :: Tokens s ~ Text => ReadTree Error s FileSourcedTree

STag

p_STag :: Tokens s ~ Text => ReadTree Error s FileSourcedTree

Attribute

p_Attribute :: Tokens s ~ Text => ReadTree Error s (PName, FileSourced EscapedAttr)

Note: despite the type, the returned FileSource encompasses also the attribute PName. It is pushed in the attribute value to fit the insertion of the attribute into a HashMap.

p_AttrValue :: Tokens s ~ Text => ReadTree Error s EscapedAttr

p_AttrValueText :: Tokens s ~ Text => Char -> ReadTree Error s EscapedAttr

content

p_content :: Tokens s ~ Text => ReadTree Error s FileSourcedTrees

ETag

p_ETag :: Tokens s ~ Text => QName -> ReadTree Error s ()

PName

p_PName :: Tokens s ~ Text => ReadTree e s PName

QName

p_QName :: Tokens s ~ Text => ReadTree Error s QName

NCName

p_NCName :: Tokens s ~ Text => ReadTree e s NCName

Reference

p_Reference :: Tokens s ~ Text => ReadTree Error s Escaped

EntityRef

p_EntityRef :: Tokens s ~ Text => ReadTree Error s EntityRef

CharRef

p_CharRef :: Tokens s ~ Text => ReadTree Error s CharRef

readInt :: Integer -> String -> Integer

readDecimal :: String -> Integer

readHexadecimal :: String -> Integer

Char

p_Char :: Tokens s ~ Text => ReadTree e s Char

Space

p_CRLF :: Tokens s ~ Text => ReadTree e s Char

Map '\r' and '\r\n' to '\n'. See: https://www.w3.org/TR/xml/#sec-line-ends

p_Space :: Tokens s ~ Text => ReadTree e s Char

p_Spaces :: Tokens s ~ Text => ReadTree e s ()

p_Spaces1 :: Tokens s ~ Text => ReadTree e s ()

Eq

p_separator :: Tokens s ~ Text => Char -> ReadTree e s ()

p_Eq :: Tokens s ~ Text => ReadTree e s ()