Gsf.XMLInDoc¶

Fields¶

None

Methods¶

class	`new` (nodes, ns)
	`add_nodes` (nodes)
	`free` ()
	`parse` (input, user_state)
	`set_unknown_handler` (handler)

Details¶

class Gsf.XMLInDoc¶

classmethod new(nodes, ns)¶

Parameters:	nodes ([`Gsf.XMLInNode`]) – an array of node descriptors ns ([`Gsf.XMLInNS`]) – an array of namespace identifiers
Returns:	a `Gsf.XMLInDoc`
Return type:	`Gsf.XMLInDoc` or `None`

Combine the nodes in the None terminated array starting at nodes with the name spaces in the None terminated array starting at ns. Prepare the data structures necessary to validate a doument based on that description.

add_nodes(nodes)¶

Parameters:	nodes ([`Gsf.XMLInNode`]) – `None` terminated array of `Gsf.XMLInNode`

Adds additional nodes to the structure of self

free()¶: Free up resources

parse(input, user_state)¶

Parameters:	input (`Gsf.Input`) – `Gsf.Input` user_state (`object` or `None`) – arbitrary content stored in the parser
Returns:	`False` on error
Return type:	`bool`

Read an xml document from input and parse based on the the descriptor in self

set_unknown_handler(handler)¶

Parameters:	handler (`Gsf.XMLInUnknownFunc`) – The function to call

Call the function handler when an unexpected child node is found