Pike Module Reference:

selects nodes based on an XPath query and returns the result.

sets the xslt loader function. this is global for the process.

the callout should have the following signature:

Node f(string uri, int options, int type)

where: uri is the URI of the document to load options are a set of xmlParserOption the xsltLoadType indicating the kind of loading required

clears the system wide docloader callout, if one was set.

sets parser options.

a bitwise or of Public.Parser.XML2.Constants options where valid options start with PARSE_.

sets whether the parser should automatically convert input to the parser to and from UTF-8. libxml2 requires input (aside from data to be parsed, which may be encoded differently) to be UTF-8 encoded. This module will automatically convert all string input to and from UTF-8. Calling this function with an argument of zero (0) will turn this feature off. In this case, you will be responsible for ensuring that any input is properly encoded (if necessary).

a boolean value: 0 disables auto conversion, 1 enables.

sets parser options.

a bitwise or of Public.Parser.XML2.Constants options where valid options start with PARSE_.

gets the list of available character encoders.

an array of available encoder identifiers.

Renders a node tree as an XML string. The entire document tree will be rendered. To render a portion of a tree, use Node.render_xml.

a Node object for a given XML document.

Renders a node tree as an HTML string. The entire document tree will be rendered. To render a portion of a tree, use Node.render_html.

a Node object for a given HTML document.

Parse an string containing XML, even if it is not Well Formed.

String containing XML data to parse.

a Node object containing the root of the tree.

Parse an string containing XML.

String containing XML data to parse.

String containing name/URI of file.

a Node object containing the root of the tree.

Parse an string containing HTML.

String containing HTML data to parse.

String containing name/URI of file.

a Node object containing the root of the tree.

Create a new XML document with a root node.

the version of XML to create

the name of the root node

a Node object containing the root of the tree.

Parse a string containing an RelaxNG schema.

String containing name/URI of file.

a RelaxNG object containing the parsed schema.

the line number the node is present on

sets the content for a node

appends the content for a node

gets the contents of a text node, or the contents and children of an element, or the value of an attribute node.

returns an XPath/XQuery based path for this Node.

returns the default name space uri for the element

gets a list of all known namespaces for this element.

a mapping of "short" prefixes to namespace uris.

returns all attributes, irrespective of namespace

a mapping of attribute name to attribute value.

returns all attributes not present in a namespace

a mapping of attribute name to attribute value.

given a namespace uri, return all elements for that namespace present in the element.

a mapping of attribute names to attribute values.

get all children of this node

an array of all elements with are a direct child of this element.

get the Node which is the parent of this Node.

replace this node with a different node. if the new node was already inserted into a document, it is first unlinked from its original document.

the old node

copy a node

if 1 do a recursive copy (properties, namespaces and children when applicable) if 2 copy properties and namespaces (when applicable)

the newly copied node.

recursively copy a node list

the newly copied node.

unlink a node from its current context. the node not freed. to unlink and destroy the node, use delete.

the unlinked node.

unlink a node and remove it (and its children) from memory

get the Node which is the root of this tree.

set this Node to be the root of this tree.

the old root of the tree, if any existed.

returns an unlinked CDATA block.

returns an unlinked Processing Instruction node.

the namespace prefix

sets a new attribute, overwriting any existing value. if value is zero, the attribute will be removed from the node.

the name of the attribute to delete

the prefix of the namespace containing the attribute to be deleted

returns an unlinked character reference node.

returns an unlinked comment node.

returns an unlinked character reference node.

add a new child element, added to end of children for this node.

the prefix of the namespace for the node (optional)

new_text_child

add a new child element, added to end of children for this node. differs from new_child in that XML reserved entities present in content (such as amersand, greater-than and less-than) will be automatically replaced by their XML escaped entity representations.

the prefix of the namespace for the node (optional)

new_child

add a node to end of children for this node.

add a node to end of siblings for this node.

add a sibling node after this node.

add a sibling node after this node.

get the Node which is the last child of this Node.

get the next sibling of this Node.

the next node which is a sibling of this node.

get the previous sibling of this Node.

the previous node which is a sibling of this node.

is this node empty?

is this a text node?

get the type of node.

the integer node type. Node type constants are defined in Public.Parser.XML2.Constants.

gets the name of this node, if it has one.

sets the name of this node.

sets the language of this node.

sets the base URI of this node.

renders the node and all children as xml (which will be encoded as UTF-8 by default).

the indentation level to use

should the xml be formated for ease of human reading. this setting only takes effect if Public.Parser.XML2.xmlKeepBlanksDefault(0) has been called.

renders the node and all children as html (which will be encoded as UTF-8 by default).

a Relax-NG validator.

Validates an XML document.

0 if the document is valid, a positive error code number otherwise and -1 in case of internal or API error.

a SAX v1 parser featuring both pull and push (chunked) parsing.

sets a SAX handler callback function.

the id of the type of handler you wish to set. this should be one of the Public.Parser.XML2.Constants.SAX_CB_* members.

the function to call when the selected parsing event occurs. prototypes for each event function are found in Public.Parser.XML2.SAXHandlers.

extra data to supply to the callback function. these will be passed as extra parameters after any provided by the parser.

void serror_cb(mapping(string:mixed) error, mixed ... extra_args); mapping elements: domain, code, message, level, line, column

void entitydecl_cb(string name, int type, string publicId, string systemId, string content, mixed ... extra_args);

void elementdecl_cb(string name, int type, mixed ... extra_args);

void unparsedentitydecl_cb(string name, string publicId, string systemId, string notationName, mixed ... extra_args);

void attributedecl_cb(string elem, string fullname, int type, int def, string defaultValue, mixed ... extra_args);

void notationdecl_cb(string name, string publicId, string systemId, mixed ... extra_args);

void internalsubset_cb(string name, string ExternalId, string SystemId, mixed ... extra_args);

void externalsubset_cb(string name, string ExternalId, string SystemId, mixed ... extra_args);

void processinginstruction_cb(string target, string data, mixed ... extra_args);

void endelement_cb(string name, mixed ... extra_args);

void cdatablock_cb(string chars, mixed ... extra_args);

void ignorablewhitespace(string chars, mixed ... extra_args);

void characters_cb(string chars, mixed ... extra_args);

void reference_cb(string name, mixed ... extra_args);

void comment_cb(string value, mixed ... extra_args);

void startelement_cb(string name, mapping(string:string) attributes, mixed ... extra_args);

int isstandalone_cb(mixed ... extra_args);

void startdocument_cb(mixed ... extra_args);

void enddocument_cb(mixed ... extra_args);

int hasinternalsubset(mixed ... extra_args);

int hasexternalsubset(mixed ... extra_args);

string resolveentity(string publicId, string systemId, mixed ... extra_args);

clears a SAX handler callback.

the id of the type of handler you wish to set. this should be one of the Public.Parser.XML2.Constants.SAX_CB_* members.

1 if the handler existed, 0 otherwise.

feed some XML data to the parser. feed may be called multiple times to pass an entire XML document to the parser. The document will be processed as data is fed to the parser.

some XML data to be parsed. need not be a complete XML document.

the number of bytes processed.

end parsing of a document and prepare for the next document.

resets the document parsing context and prepares for the next document. end should be called after the last chunk of data in an XML document has been passed to feed.

feed a complete XML document to the parser. data from the document will be processed and any registered SAX handler callbacks will be called as SAX events occur. this method contains an implicit call to end, so that the context is prepared to receive a new document after this function returns.

you may call this method with an (ending) fragment of an XML document, as long as any previous data needed to produce a valid XML document has already been fed to the parser using feed.

some XML data to be parsed. need not be a complete XML document.

the number of bytes processed.

apply the stylesheet object to an xml file.

a Node object from the parsed XML document to apply. Any node from the XML document may be used.

a Node object for the transformed document.

render the applied stylesheet Node to a string.

the transformed xml object

an optional encoding for the string. if not supplied, defaults to ISO-8859-1 (ISO Latin 1). Valid options are found in Public.XML2.Constants, XML_CHAR_ENCODING*.

the string representation of the transformed XML.

set attributes for use by the stylesheet transformation

Currently, the input to this function is assumed to be UTF-8 encoded. We should probably do that automagically.

A simplified parser for XML documents. Similar to the C# XMLReader class.

reads the next node of the document and loads its data.

returns 1 if a node was read, 0 if no additional nodes are available, and throws an error if a parse error occurred.

returns the type of the current node. Types are described here: http://dotgnu.org/pnetlib-doc/System/Xml/XmlNodeType.html

returns the depth of the current node within the tree.

Does the node have attributes?

returns the number of attributes associated with the current node.

the property to get

the property to set

the value to set

note that xml is expected to be encoded according to the encoding directive in the xml file, or as UTF-8. All other strings may be in Pike standard string format.