Data.GI.GIR.Parser

The Parser monad.

Documentation

type Parser a = ReaderT ParseContext (Except ParseError) a

Monad where parsers live: we carry a context around, and can throw errors that abort the parsing.

type ParseError = Text

A message describing a parsing error in human readable form.

parseError :: ParseError -> Parser a

Throw a parse error.

runParser :: Text -> Map Alias Type -> Element -> Parser a -> Either ParseError a

Run the given parser, returning either success or an error.

parseName :: Parser Name

Get the qualified name for the current element.

parseDeprecation :: Parser (Maybe DeprecationInfo)

Parse the deprecation text, if present.

parseDocumentation :: Parser Documentation

Parse the documentation info for the current node.

parseIntegral :: Integral a => Text -> Parser a

Parse a signed integral number.

parseBool :: Text -> Parser Bool

A boolean value given by a numerical constant.

parseChildrenWithLocalName :: Text -> Parser a -> Parser [a]

Parse all the introspectable subelements with the given local name.

parseAllChildrenWithLocalName :: Text -> Parser a -> Parser [a]

Parse all subelements with the given local name.

parseChildrenWithNSName :: GIRXMLNamespace -> Text -> Parser a -> Parser [a]

Parse all introspectable children with the given namespace and local name.

getAttr :: Name -> Parser Text

Return the value of an attribute for the given element. If the attribute is not present this throws an error.

getAttrWithNamespace :: GIRXMLNamespace -> Name -> Parser Text

Like getAttr, but allow for specifying the namespace.

queryAttr :: Name -> Parser (Maybe Text)

Return the value of an attribute if it is present, and Nothing otherwise.

queryAttrWithNamespace :: GIRXMLNamespace -> Name -> Parser (Maybe Text)

Like queryAttr, but allow for specifying the namespace.

optionalAttr :: Name -> a -> (Text -> Parser a) -> Parser a

Ask for an optional attribute, applying the given parser to it. If the argument does not exist return the default value provided.

currentNamespace :: Parser Text

Return the current namespace.

qualifyName :: Text -> Parser Name

Build a Name out of the (possibly qualified) supplied name. If the supplied name is unqualified we qualify with the current namespace, and otherwise we simply parse it.

resolveQualifiedTypeName :: Name -> Parser Type

Check whether there is an alias for the given name, and return the corresponding type in case it exists, and otherwise a TInterface.

data Name

Name for a symbol in the GIR file.

Constructors

Name

Fields

• namespace :: Text
• name :: Text

Instances

Eq Name

Defined in Data.GI.GIR.BasicTypes

Methods

(==) :: Name -> Name -> Bool

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

Ord Name

Defined in Data.GI.GIR.BasicTypes

Methods

compare :: Name -> Name -> Ordering

(<) :: Name -> Name -> Bool

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

(>) :: Name -> Name -> Bool

(>=) :: Name -> Name -> Bool

max :: Name -> Name -> Name

min :: Name -> Name -> Name

Show Name

Defined in Data.GI.GIR.BasicTypes

Methods

showsPrec :: Int -> Name -> ShowS

show :: Name -> String

showList :: [Name] -> ShowS

data Element

Instances

Eq Element

Defined in Text.XML

Methods

(==) :: Element -> Element -> Bool

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

Data Element

Defined in Text.XML

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Element -> c Element

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Element

toConstr :: Element -> Constr

dataTypeOf :: Element -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Element)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Element)

gmapT :: (forall b. Data b => b -> b) -> Element -> Element

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Element -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Element -> r

gmapQ :: (forall d. Data d => d -> u) -> Element -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Element -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Element -> m Element

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Element -> m Element

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Element -> m Element

Ord Element

Defined in Text.XML

Methods

compare :: Element -> Element -> Ordering

(<) :: Element -> Element -> Bool

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

(>) :: Element -> Element -> Bool

(>=) :: Element -> Element -> Bool

max :: Element -> Element -> Element

min :: Element -> Element -> Element

Show Element

Defined in Text.XML

Methods

showsPrec :: Int -> Element -> ShowS

show :: Element -> String

showList :: [Element] -> ShowS

NFData Element

Defined in Text.XML

Methods

rnf :: Element -> ()

ToMarkup Element

Note that the special element name {http:/www.snoyman.comxml2html}ie-cond with the single attribute cond is used to indicate an IE conditional comment.

Defined in Text.XML

Methods

toMarkup :: Element -> Markup

preEscapedToMarkup :: Element -> Markup

data GIRXMLNamespace

GIR namespaces we know about.

Constructors

GLibGIRNS

CGIRNS

CoreGIRNS

Instances

Show GIRXMLNamespace

Defined in Data.GI.GIR.XMLUtils

Methods

showsPrec :: Int -> GIRXMLNamespace -> ShowS

show :: GIRXMLNamespace -> String

showList :: [GIRXMLNamespace] -> ShowS

data DeprecationInfo

Deprecation information on a symbol.

Instances

Eq DeprecationInfo

Defined in Data.GI.GIR.Deprecation

Methods

(==) :: DeprecationInfo -> DeprecationInfo -> Bool

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

Show DeprecationInfo

Defined in Data.GI.GIR.Deprecation

Methods

showsPrec :: Int -> DeprecationInfo -> ShowS

show :: DeprecationInfo -> String

showList :: [DeprecationInfo] -> ShowS

data Documentation

Documentation for a given element. The documentation text is typically encoded in the gtk-doc format, see https://developer.gnome.org/gtk-doc-manual/ . This can be parsed with parseGtkDoc.

Instances

Eq Documentation

Defined in Data.GI.GIR.Documentation

Methods

(==) :: Documentation -> Documentation -> Bool

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

Ord Documentation

Defined in Data.GI.GIR.Documentation

Methods

compare :: Documentation -> Documentation -> Ordering

(<) :: Documentation -> Documentation -> Bool

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

(>) :: Documentation -> Documentation -> Bool

(>=) :: Documentation -> Documentation -> Bool

max :: Documentation -> Documentation -> Documentation

min :: Documentation -> Documentation -> Documentation

Show Documentation

Defined in Data.GI.GIR.Documentation

Methods

showsPrec :: Int -> Documentation -> ShowS

show :: Documentation -> String

showList :: [Documentation] -> ShowS