Collaboration diagram for ginga::ParserState:

[legend]

Public Types
enum	Error { ERROR_NONE = 0 , ERROR_ELT_UNKNOWN , ERROR_ELT_MISSING_PARENT , ERROR_ELT_BAD_PARENT , ERROR_ELT_UNKNOWN_ATTRIBUTE , ERROR_ELT_MISSING_ATTRIBUTE , ERROR_ELT_BAD_ATTRIBUTE , ERROR_ELT_MUTUALLY_EXCL_ATTRIBUTES , ERROR_ELT_UNKNOWN_CHILD , ERROR_ELT_MISSING_CHILD , ERROR_ELT_BAD_CHILD , ERROR_ELT_IMPORT }
	Parser error codes. More...

Public Member Functions
	ParserState (int, int)
	Creates a new state.

	~ParserState ()
	Destroys state.

ParserState::Error	getError (string *)
	Gets last parser error.

Document *	process (xmlDoc *)
	Processes XML document.

Static Public Member Functions
static bool	pushNcl (ParserState , ParserElt )
	Starts the processing of <ncl> element.

static bool	popNcl (ParserState , ParserElt )
	Ends the processing of <ncl> element.

static bool	pushRegion (ParserState , ParserElt )
	Starts the processing of <region> element.

static bool	popRegion (ParserState , ParserElt )
	Ends the processing of <region> element.

static bool	pushDescriptorParam (ParserState , ParserElt )
	Starts the processing of <descriptorParam> element.

static bool	pushCausalConnector (ParserState , ParserElt )
	Starts the processing of <causalConnector> element.

static bool	popCausalConnector (ParserState , ParserElt )
	Ends the processing of <causalConnector> element.

static bool	pushCompoundCondition (ParserState , ParserElt )
	Starts the processing of <compoundCondition> element.

static bool	pushSimpleCondition (ParserState , ParserElt )
	Starts the processing of <simpleCondition> or <simpleAction> element.

static bool	pushCompoundStatement (ParserState , ParserElt )
	Starts the processing of <compoundStatement> element.

static bool	popCompoundStatement (ParserState , ParserElt )
	Ends the processing of <compoundStatement> element.

static bool	popAssessmentStatement (ParserState , ParserElt )
	Ends the processing of <assessmentStatement> element.

static bool	pushAttributeAssessment (ParserState , ParserElt )
	Starts the processing of <attributeAssessment> or <valueAssessment> element.

static bool	pushRule (ParserState , ParserElt )
	Starts the processing of <rule> or <compositeRule> element.

static bool	pushImportBase (ParserState , ParserElt )
	Starts the processing of <importBase> element.

static bool	pushContext (ParserState , ParserElt )
	Starts the processing of <body> or <context> element.

static bool	popContext (ParserState , ParserElt )
	Ends the processing of <body> or <context> element.

static bool	pushPort (ParserState , ParserElt )
	Starts the processing of <port> element.

static bool	pushSwitch (ParserState , ParserElt )
	Starts the processing of <switch>.

static bool	popSwitch (ParserState , ParserElt )
	Ends the processing of <switch> element.

static bool	pushSwitchPort (ParserState , ParserElt )
	Starts the processing of <switchPort>.

static bool	pushMapping (ParserState , ParserElt )

static bool	pushBindRule (ParserState , ParserElt )
	Starts the processing of <bindRule> or <defaultComponent> element.

static bool	pushMedia (ParserState , ParserElt )
	Starts the processing of <media> element.

static bool	popMedia (ParserState , ParserElt )
	Ends the processing of <media> element.

static bool	pushArea (ParserState , ParserElt )
	Starts the processing of <area> element.

static bool	pushProperty (ParserState , ParserElt )
	Starts the processing of <property> element.

static bool	pushLink (ParserState , ParserElt )
	Starts the processing of <link> element.

static bool	pushLinkParam (ParserState , ParserElt )
	Starts the processing of <linkParam> or <bindParam> element.

static bool	pushBind (ParserState , ParserElt )
	Starts the processing of <bind> element.

static bool	pushFont (ParserState , ParserElt )
	Starts the processing of <font> element.

Private Member Functions
string	genId ()
	Generates an unique id.

string	getURI ()
	Gets the URI of current loaded XML file.

bool	isInUniqueSet (const string &)
	Tests whether id is unique (hasn't been seen yet).

void	addToUniqueSet (const string &)
	Adds id to the set of known ids.

bool	getData (const string &, void **)
	Gets user data attached to parser state.

bool	setData (const string &, void *, UserDataCleanFunc fn=nullptr)
	Attaches user data to parser state.

bool	errElt (xmlNode *, ParserState::Error, const string &)
	Sets parser error code and error message.

bool	errEltUnknown (xmlNode *)
	Sets parser error to "Unknown element".

bool	errEltMissingParent (xmlNode *)
	Sets parser error to "Missing parent".

bool	errEltBadParent (xmlNode *)
	Sets parser error to "Bad parent".

bool	errEltUnknownAttribute (xmlNode *, const string &)
	Sets parser error to "Unknown attribute".

bool	errEltMissingAttribute (xmlNode *, const string &)
	Sets parser error to "Missing attribute".

bool	errEltBadAttribute (xmlNode *, const string &, const string &, const string &explain="")
	Sets parser error to "Bad value for attribute".

bool	errEltMutuallyExclAttributes (xmlNode *, const string &, const string &)
	Sets parser error to "Attributes are mutually exclusive".

bool	errEltUnknownChild (xmlNode *, const string &)
	Sets parser error to "Unknown child".

bool	errEltMissingChild (xmlNode *, const list< string > &)
	Sets parser error to "Missing child".

bool	errEltBadChild (xmlNode *, const string &, const string &explain="")
	Sets parser error to "Bad child".

bool	errEltImport (xmlNode *, const string &explain="")
	Sets parser error to "Syntax error in imported document".

bool	eltCacheIndex (xmlNode , ParserElt *)
	Indexes element cache by node.

bool	eltCacheIndexParent (xmlNode , ParserElt *)
	Indexes element cache by node parent.

bool	eltCacheIndexById (const string &, ParserElt **, const list< string > &)
	Indexes element cache by id.

size_t	eltCacheIndexByTag (const list< string > &, list< ParserElt * > *)
	Indexes element cache by tag.

bool	eltCacheAdd (ParserElt *)
	Adds element to cache.

string	aliasStackCombine ()
	Combines all aliases in alias stack.

bool	aliasStackPeek (string , string )
	Peeks at alias stack.

bool	aliasStackPop (string , string )
	Pops alias stack.

bool	aliasStackPush (const string &, const string &)
	Pushes alias and path onto alias stack.

Object *	objStackPeek ()
	Peeks at object stack.

Object *	objStackPop ()
	Pops object from stack.

void	objStackPush (Object *)
	Pushes object onto stack.

Rect	rectStackPeek ()
	Peeks at rectangle stack.

Rect	rectStackPop ()
	Pops rectangle from stack.

void	rectStackPush (Rect)
	Pushes rectangle onto stack.

bool	referMapIndex (const string &, Media **)
	Indexes refer map.

bool	referMapAdd (const string &, Media *)
	Adds entry to refer map.

bool	resolveComponent (Composition , ParserElt , Object **)
	Resolves reference to component within a context.

bool	resolveInterface (Composition , ParserElt , Event **)
	Resolves reference to an interface within a context.

string	resolveParameter (const string &, const map< string, string > , const map< string, string > , const map< string, string > *)
	Resolve reference to (bind, link, or ghost) parameter.

Predicate *	obtainPredicate (xmlNode *)
	Obtains predicate associated with a <simpleCondition> node.

Predicate *	solvePredicate (Predicate , const map< string, string > )
	Obtains predicate by solving role references in another predicate.

ParserSyntaxElt *	checkNode (xmlNode , map< string, string > , list< xmlNode * > *)
	Checks node syntax according to syntax table.

bool	processNode (xmlNode *)
	Processes node.

Private Attributes
Document *	_doc
	The resulting #Document.

xmlDoc *	_xml
	The DOM tree being processed.

int	_genid
	Last generated id.

UserData	_udata
	Attached user data.

set< string >	_unique
	Unique attributes seen so far.

ParserState::Error	_error
	Last error code.

string	_errorMsg
	Last error message.

map< xmlNode , ParserElt >	_eltCache
	Element cache.

map< string, list< ParserElt * > >	_eltCacheByTag
	Element cache by tag.

list< pair< string, string > >	_aliasStack
	Alias stack for solving imports.

list< Object * >	_objStack
	Rectangle stack for solving region hierarchy.

list< Rect >	_rectStack
	Reference map for solving the refer attribute in <media>.

map< string, Media * >	_referMap

Detailed Description

Parser state.

Parser state while it's parsing the document.

Member Enumeration Documentation

◆ Error

enum ginga::ParserState::Error

Parser error codes.

Enumerator
ERROR_NONE	No error.
ERROR_ELT_UNKNOWN	Unknown element.
ERROR_ELT_MISSING_PARENT	Missing parent element.
ERROR_ELT_BAD_PARENT	Bad parent element.
ERROR_ELT_UNKNOWN_ATTRIBUTE	Unknown attribute.
ERROR_ELT_MISSING_ATTRIBUTE	Missing attribute.
ERROR_ELT_BAD_ATTRIBUTE	Bad attribute.
ERROR_ELT_MUTUALLY_EXCL_ATTRIBUTES	Mutually exclusive attributes.
ERROR_ELT_UNKNOWN_CHILD	Unknown child element.
ERROR_ELT_MISSING_CHILD	Missing child element.
ERROR_ELT_BAD_CHILD	Bad child element.
ERROR_ELT_IMPORT	Error in imported document.

Constructor & Destructor Documentation

◆ ParserState()

ginga::ParserState::ParserState	(	int	width,
		int	height )

Creates a new state.

Parameters

width	Initial screen width (in pixels).
height	Initial screen height (in pixels).

Returns: New ParserState.

Member Function Documentation

◆ addToUniqueSet()

void ginga::ParserState::addToUniqueSet ( const string & id )

private

Adds id to the set of known ids.

Parameters

id	The id to add.

◆ aliasStackCombine()

string ginga::ParserState::aliasStackCombine ( )

private

Combines all aliases in alias stack.

Returns: The combined alias.

◆ aliasStackPeek()

bool ginga::ParserState::aliasStackPeek	(	string *	alias,
		string *	path )

private

Peeks at alias stack.

Parameters

alias	Variable to store the alias at top of stack.
path	Variable to store the path at top of stack.

Returns: true if successful, or false otherwise (alias stack is empty).

◆ aliasStackPop()

bool ginga::ParserState::aliasStackPop	(	string *	alias,
		string *	path )

private

Pops alias stack.

Parameters

alias	Variable to store the popped alias.
path	Variable to store the popped path.

Returns: true if successful, or false otherwise (alias stack is empty).

◆ aliasStackPush()

bool ginga::ParserState::aliasStackPush	(	const string &	alias,
		const string &	path )

private

Pushes alias and path onto alias stack.

Parameters

alias	The alias to push.
path	The path to push.

Returns: true if successful, or false otherwise (path already in stack).

◆ checkNode()

ParserSyntaxElt * ginga::ParserState::checkNode	(	xmlNode *	node,
		map< string, string > *	attrs,
		list< xmlNode * > *	children )

private

Checks node syntax according to syntax table.

Parameters

	node	The node to check.
[out]	attrs	Variable to store node's attributes.
[out]	children	Variable to store node's children.

Returns: Pointer to entry in syntax table if successful, otherwise returns nullptr and sets #Parser error accordingly.

◆ eltCacheAdd()

bool ginga::ParserState::eltCacheAdd ( ParserElt * elt )

private

Adds element to cache.

Parameters

elt	The element to add.

Returns: true if successful, or false otherwise (already in cache).

◆ eltCacheIndex()

bool ginga::ParserState::eltCacheIndex	(	xmlNode *	node,
		ParserElt **	elt )

private

Indexes element cache by node.

Parameters

	node	The node to be used as key.
[out]	elt	Variable to store the element associated with `node` (if any).

Returns: true if successful, or false otherwise.

◆ eltCacheIndexById()

bool ginga::ParserState::eltCacheIndexById	(	const string &	id,
		ParserElt **	elt,
		const list< string > &	tags )

private

Indexes element cache by id.

Parameters

	id	The id to be used as key.
[out]	elt	Variable to store the element associated with `id` (if any).
	tags	Accepted tags (match only elements with one of these).

Returns: true if successful, or false otherwise.

◆ eltCacheIndexByTag()

size_t ginga::ParserState::eltCacheIndexByTag	(	const list< string > &	tags,
		list< ParserElt * > *	result )

private

Indexes element cache by tag.

Parameters

	tags	The tags to be used as keys.
[out]	result	Variable to store the list of matched elements.

Returns: The number of matched elements.

◆ eltCacheIndexParent()

bool ginga::ParserState::eltCacheIndexParent	(	xmlNode *	node,
		ParserElt **	elt )

private

Indexes element cache by node parent.

Parameters

	node	The node whose parent will be used as key.
[out]	elt	Variable to store the element associated with `node` (if any).

Returns: true if successful, or false otherwise.

◆ errElt()

bool ginga::ParserState::errElt	(	xmlNode *	node,
		ParserState::Error	error,
		const string &	message )

private

Sets parser error code and error message.

Parameters

node	The node that caused the error.
error	The error code to be set.
message	The error message to be set.

Returns: false.

◆ errEltBadAttribute()

bool ginga::ParserState::errEltBadAttribute	(	xmlNode *	node,
		const string &	name,
		const string &	value,
		const string &	explain = "" )

private

Sets parser error to "Bad value for attribute".

Parameters

node	The node that caused the error.
name	The name of the attribute that caused the error.
value	The value of the attribute that caused the error.
explain	Further explanation.

Returns: false.

◆ errEltBadChild()

bool ginga::ParserState::errEltBadChild	(	xmlNode *	node,
		const string &	name,
		const string &	explain = "" )

private

Sets parser error to "Bad child".

Parameters

node	The node that caused the error.
name	The name of the child that caused the error.
explain	Further explanation.

Returns: false.

◆ errEltBadParent()

bool ginga::ParserState::errEltBadParent ( xmlNode * node )

private

Sets parser error to "Bad parent".

Parameters

node	The node that caused the error.

Returns: false.

◆ errEltImport()

bool ginga::ParserState::errEltImport	(	xmlNode *	node,
		const string &	explain = "" )

private

Sets parser error to "Syntax error in imported document".

Parameters

node	The <importBase> node that caused the error.
explain	Further explanation. return `false`

◆ errEltMissingAttribute()

bool ginga::ParserState::errEltMissingAttribute	(	xmlNode *	node,
		const string &	name )

private

Sets parser error to "Missing attribute".

Parameters

node	The node that caused the error.
name	The name of the attribute that caused the error.

Returns: false.

◆ errEltMissingChild()

bool ginga::ParserState::errEltMissingChild	(	xmlNode *	node,
		const list< string > &	children )

private

Sets parser error to "Missing child".

Parameters

node	The node that caused the error.
children	The list of names of children that caused the error.

Returns: false.

◆ errEltMissingParent()

bool ginga::ParserState::errEltMissingParent ( xmlNode * node )

private

Sets parser error to "Missing parent".

Parameters

node	The node that caused the error.

Returns: false.

◆ errEltMutuallyExclAttributes()

bool ginga::ParserState::errEltMutuallyExclAttributes	(	xmlNode *	node,
		const string &	attr1,
		const string &	attr2 )

private

Sets parser error to "Attributes are mutually exclusive".

Parameters

node	The node that caused the error.
attr1	The name of the first attribute.
attr2	The name of the second attribute.

Returns: false.

◆ errEltUnknown()

bool ginga::ParserState::errEltUnknown ( xmlNode * node )

private

Sets parser error to "Unknown element".

Parameters

node	The node that caused the error.

Returns: false.

◆ errEltUnknownAttribute()

bool ginga::ParserState::errEltUnknownAttribute	(	xmlNode *	node,
		const string &	name )

private

Sets parser error to "Unknown attribute".

Parameters

node	The node that caused the error.
name	The name of the attribute that caused the error.

Returns: false.

◆ errEltUnknownChild()

bool ginga::ParserState::errEltUnknownChild	(	xmlNode *	node,
		const string &	name )

private

Sets parser error to "Unknown child".

Parameters

node	The node that caused the error.
name	The name of the child element that caused the error.

Returns: false.

◆ genId()

string ginga::ParserState::genId ( )

private

Generates an unique id.

Returns: Unique id.

◆ getData()

bool ginga::ParserState::getData	(	const string &	key,
		void **	value )

private

Gets user data attached to parser state.

Parameters

	key	User data key.
[out]	value	Variable to store user data value (if any).

Returns: true if successful, or false otherwise.

◆ getError()

ParserState::Error ginga::ParserState::getError ( string * message )

Gets last parser error.

Parameters

[out] message Variable to store the last error message (if any).

Returns: Last error code.

◆ getURI()

string ginga::ParserState::getURI ( )

private

Gets the URI of current loaded XML file.

Returns: Directory part if there is a loaded XML file, or the empty string otherwise.

◆ isInUniqueSet()

bool ginga::ParserState::isInUniqueSet ( const string & id )

private

Tests whether id is unique (hasn't been seen yet).

Parameters

id	The id to test.

Returns: true if successful, or false otherwise.

◆ objStackPeek()

Object * ginga::ParserState::objStackPeek ( )

private

Peeks at object stack.

Returns: The top of object stack or null if stack is empty.

◆ objStackPop()

Object * ginga::ParserState::objStackPop ( )

private

Pops object from stack.

Returns: The popped object or null if the stack is empty.

◆ objStackPush()

void ginga::ParserState::objStackPush ( Object * obj )

private

Pushes object onto stack.

Parameters

obj	The object to push.

◆ obtainPredicate()

Predicate * ginga::ParserState::obtainPredicate ( xmlNode * node )

private

Obtains predicate associated with a <simpleCondition> node.

This function collects all predicates inherited by node and, if there are such predicates, combines them into a new predicate and returns it.

Parameters

node	The simple condition node.

Returns: A new predicate for node, or nullptr if node has no associated predicate.

◆ popAssessmentStatement()

bool ginga::ParserState::popAssessmentStatement	(	ParserState *	st,
		ParserElt *	elt )

static

Ends the processing of <assessmentStatement> element.

This function creates an associated atomic #Predicate for elt.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ popCausalConnector()

bool ginga::ParserState::popCausalConnector	(	ParserState *	st,
		ParserElt *	elt )

static

Ends the processing of <causalConnector> element.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ popCompoundStatement()

bool ginga::ParserState::popCompoundStatement	(	ParserState *	st,
		ParserElt *	elt )

static

Ends the processing of <compoundStatement> element.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ popContext()

bool ginga::ParserState::popContext	(	ParserState *	st,
		ParserElt *	elt )

static

Ends the processing of <body> or <context> element.

This function resolves context ports and pops the object stack.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ popMedia()

bool ginga::ParserState::popMedia	(	ParserState *	st,
		ParserElt *	elt )

static

Ends the processing of <media> element.

This function pops the object stack.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ popNcl()

bool ginga::ParserState::popNcl	(	ParserState *	st,
		ParserElt *	elt )

static

Ends the processing of <ncl> element.

This function resolves all non-local references.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ popRegion()

bool ginga::ParserState::popRegion	(	ParserState *	st,
		ParserElt *	elt )

static

Ends the processing of <region> element.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ popSwitch()

bool ginga::ParserState::popSwitch	(	ParserState *	st,
		ParserElt *	elt )

static

Ends the processing of <switch> element.

This function pops the object stack.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ process()

Document * ginga::ParserState::process ( xmlDoc * xml )

Processes XML document.

This function is a wrapper over ParserState::processNode(). It calls the later with the root node of the given XML document and, if nothing goes wrong, returns the resulting document.

Parameters

xml	The XML document to process.

Returns: The resulting #Document if successful, or null otherwise.

◆ processNode()

bool ginga::ParserState::processNode ( xmlNode * node )

private

Processes node.

After being called by ParserState::process(), starting from the root node, this function proceeds recursively, processing each node in the input document tree. For each node, it checks its syntax (according to parser_syntax_table), calls the corresponding push function (if any), processes the node's children, and calls the corresponding pop function (if any). At any moment, if something goes wrong the function sets #Parser error and returns false.

Parameters

node	The node to process.

Returns: true if successful, or false otherwise.

◆ pushArea()

bool ginga::ParserState::pushArea	(	ParserState *	st,
		ParserElt *	elt )

static

Starts the processing of <area> element.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ pushAttributeAssessment()

bool ginga::ParserState::pushAttributeAssessment	(	ParserState *	st,
		ParserElt *	elt )

static

Starts the processing of <attributeAssessment> or <valueAssessment> element.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ pushBind()

bool ginga::ParserState::pushBind	(	ParserState *	st,
		ParserElt *	elt )

static

Starts the processing of <bind> element.

This function parsers elt and stores it as a #ParserLinkBind in the list of binds of the current link.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ pushBindRule()

bool ginga::ParserState::pushBindRule	(	ParserState *	st,
		ParserElt *	elt )

static

Starts the processing of <bindRule> or <defaultComponent> element.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ pushCausalConnector()

bool ginga::ParserState::pushCausalConnector	(	ParserState *	st,
		ParserElt *	elt )

static

Starts the processing of <causalConnector> element.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ pushCompoundCondition()

bool ginga::ParserState::pushCompoundCondition	(	ParserState *	st,
		ParserElt *	elt )

static

Starts the processing of <compoundCondition> element.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ pushCompoundStatement()

bool ginga::ParserState::pushCompoundStatement	(	ParserState *	st,
		ParserElt *	elt )

static

Starts the processing of <compoundStatement> element.

This function creates an associated compound #Predicate for elt.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ pushContext()

bool ginga::ParserState::pushContext	(	ParserState *	st,
		ParserElt *	elt )

static

Starts the processing of <body> or <context> element.

This function parses elt and pushes it as a #Context onto the object stack.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ pushDescriptorParam()

bool ginga::ParserState::pushDescriptorParam	(	ParserState *	st,
		ParserElt *	elt )

static

Starts the processing of <descriptorParam> element.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ pushFont()

bool ginga::ParserState::pushFont	(	ParserState *	st,
		ParserElt *	elt )

static

Starts the processing of <font> element.

This function parses elt and loads the font using fontconfig.

Parameters

st	ParserState
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ pushImportBase()

bool ginga::ParserState::pushImportBase	(	ParserState *	st,
		ParserElt *	elt )

static

Starts the processing of <importBase> element.

This function uses the ParserState alias stack to collect and process nested imports.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

Todo: Check for circular imports.

◆ pushLink()

bool ginga::ParserState::pushLink	(	ParserState *	st,
		ParserElt *	elt )

static

Starts the processing of <link> element.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ pushLinkParam()

bool ginga::ParserState::pushLinkParam	(	ParserState *	st,
		ParserElt *	elt )

static

Starts the processing of <linkParam> or <bindParam> element.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ pushMedia()

bool ginga::ParserState::pushMedia	(	ParserState *	st,
		ParserElt *	elt )

static

Starts the processing of <media> element.

This function parsers elt and pushes it as a #Media onto the object stack.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ pushNcl()

bool ginga::ParserState::pushNcl	(	ParserState *	st,
		ParserElt *	elt )

static

Starts the processing of <ncl> element.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ pushPort()

bool ginga::ParserState::pushPort	(	ParserState *	st,
		ParserElt *	elt )

static

Starts the processing of <port> element.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ pushProperty()

bool ginga::ParserState::pushProperty	(	ParserState *	st,
		ParserElt *	elt )

static

Starts the processing of <property> element.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ pushRegion()

bool ginga::ParserState::pushRegion	(	ParserState *	st,
		ParserElt *	elt )

static

Starts the processing of <region> element.

This function uses the initial screen dimensions stored in ParserState to convert into absolute values any relative values used in <region> attributes.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ pushRule()

bool ginga::ParserState::pushRule	(	ParserState *	st,
		ParserElt *	elt )

static

Starts the processing of <rule> or <compositeRule> element.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ pushSimpleCondition()

bool ginga::ParserState::pushSimpleCondition	(	ParserState *	st,
		ParserElt *	elt )

static

Starts the processing of <simpleCondition> or <simpleAction> element.

This function parsers elt and stores it as a #ParserConnRole in the list of rules of the current connector.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ pushSwitch()

bool ginga::ParserState::pushSwitch	(	ParserState *	st,
		ParserElt *	elt )

static

Starts the processing of <switch>.

This function parsers elt and pushes it as a #Switch onto the object stack.

Parameters

st	ParserState.
elt	Element wrapper.

Returns: true if successful, or false otherwise.

◆ pushSwitchPort()

bool ginga::ParserState::pushSwitchPort	(	ParserState *	st,
		ParserElt *	elt )

static

Starts the processing of <switchPort>.

Starts the processing of <mapping>.

This function parsers elt and pushes it as a <switchPort> on the object stack.

Parameters

st
elt

Returns

This function parsers elt and pushes it component/interface attributes in the mappings list cache in the <switchPort>.

Parameters

st
elt

Returns

◆ rectStackPeek()

Rect ginga::ParserState::rectStackPeek ( )

private

Peeks at rectangle stack.

Returns: The top of rectangle stack.

This function aborts when called with the empty stack.

◆ rectStackPop()

Rect ginga::ParserState::rectStackPop ( )

private

Pops rectangle from stack.

Returns: The popped rectangle.

This function aborts when called with the empty stack.

◆ rectStackPush()

void ginga::ParserState::rectStackPush ( Rect rect )

private

Pushes rectangle onto stack.

Parameters

rect	The rectangle to push.

◆ referMapAdd()

bool ginga::ParserState::referMapAdd	(	const string &	id,
		Media *	media )

private

Adds entry to refer map.

Parameters

id	The id of the reference.
media	The referenced media.

Returns: true if successful, or false otherwise (already in map).

◆ referMapIndex()

bool ginga::ParserState::referMapIndex	(	const string &	id,
		Media **	media )

private

Indexes refer map.

Parameters

	id	The id of the reference.
[out]	media	Variable to store referenced media.

Returns: true if successful, or false otherwise.

◆ resolveComponent()

bool ginga::ParserState::resolveComponent	(	Composition *	scope,
		ParserElt *	elt,
		Object **	obj )

private

Resolves reference to component within a context.

This function assumes that elt has an attribute "component" which contains the id of the component to be resolved. In case resolution fails, the function sets #Parser error accordingly.

Parameters

	scope	The composition that determines the resolution scope.
	elt	The element to be resolved.
[out]	obj	Variable to store the resulting object (if any).

Returns: true if successful, or false otherwise.

◆ resolveInterface()

bool ginga::ParserState::resolveInterface	(	Composition *	ctx,
		ParserElt *	elt,
		Event **	evt )

private

Resolves reference to an interface within a context.

This function assumes that elt has attributes "component" and "interface" which identify the interface to be resolved. In case resolution fails, the function sets #Parser error accordingly.

Parameters

	ctx	The contexts that determines the resolution scope.
	elt	The element to be resolved.
[out]	evt	Variable to store the resulting event (if any).

Returns: true if successful, or false otherwise.

◆ resolveParameter()

string ginga::ParserState::resolveParameter	(	const string &	ref,
		const map< string, string > *	bindParams,
		const map< string, string > *	linkParams,
		const map< string, string > *	ghosts )

private

Resolve reference to (bind, link, or ghost) parameter.

The function uses the translation tables in the order they were given, and returns as soon as any of them resolves the reference.

Parameters

ref	The reference to resolve.
bindParams	The bind parameter translation table.
linkParams	The link parameter translation table.
ghosts	The ghost binds translation table.

Returns: The resolved reference or ref itself if it is not a reference.

◆ setData()

bool ginga::ParserState::setData	(	const string &	key,
		void *	value,
		UserDataCleanFunc	fn = nullptr )

private

Attaches user data to parser state.

Parameters

key	User data key.
value	User data value.
fn	Cleanup function (used to destroy data when #ParserElt is destroyed or key is overwritten).

Returns: true if key was previously unset, or false otherwise.

◆ solvePredicate()

Predicate * ginga::ParserState::solvePredicate	(	Predicate *	pred,
		const map< string, string > *	tr )

private

Obtains predicate by solving role references in another predicate.

This function does not modify predicate pred.

Parameters

pred	The predicate to solve.
tr	The role translation table mapping role references to property references.

Returns: A new predicate obtained by solving pred via table tr.

Member Data Documentation

◆ _aliasStack

list<pair<string, string> > ginga::ParserState::_aliasStack

private

Alias stack for solving imports.

#Object stack for solving object hierarchy.

The documentation for this class was generated from the following file:

/__w/ginga/ginga/lib/Parser.cpp

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Error

Constructor & Destructor Documentation

◆ ParserState()

Member Function Documentation

◆ addToUniqueSet()

◆ aliasStackCombine()

◆ aliasStackPeek()

◆ aliasStackPop()

◆ aliasStackPush()

◆ checkNode()

◆ eltCacheAdd()

◆ eltCacheIndex()

◆ eltCacheIndexById()

◆ eltCacheIndexByTag()

◆ eltCacheIndexParent()

◆ errElt()

◆ errEltBadAttribute()

◆ errEltBadChild()

◆ errEltBadParent()

◆ errEltImport()

◆ errEltMissingAttribute()

◆ errEltMissingChild()

◆ errEltMissingParent()

◆ errEltMutuallyExclAttributes()

◆ errEltUnknown()

◆ errEltUnknownAttribute()

◆ errEltUnknownChild()

◆ genId()

◆ getData()

◆ getError()

◆ getURI()

◆ isInUniqueSet()

◆ objStackPeek()

◆ objStackPop()

◆ objStackPush()

◆ obtainPredicate()

◆ popAssessmentStatement()

◆ popCausalConnector()

◆ popCompoundStatement()

◆ popContext()

◆ popMedia()

◆ popNcl()

◆ popRegion()

◆ popSwitch()

◆ process()

◆ processNode()

◆ pushArea()

◆ pushAttributeAssessment()

◆ pushBind()

◆ pushBindRule()

◆ pushCausalConnector()

◆ pushCompoundCondition()

◆ pushCompoundStatement()

◆ pushContext()

◆ pushDescriptorParam()

◆ pushFont()

◆ pushImportBase()

◆ pushLink()

◆ pushLinkParam()

◆ pushMedia()

◆ pushNcl()

◆ pushPort()

◆ pushProperty()

◆ pushRegion()

◆ pushRule()

◆ pushSimpleCondition()

◆ pushSwitch()

◆ pushSwitchPort()

◆ rectStackPeek()

◆ rectStackPop()

◆ rectStackPush()

◆ referMapAdd()

◆ referMapIndex()