XMLParser

    Category: Core

    Low-level class for creating parsers for XML files.

    enum NodeType:

    • NODE_NONE = 0 — There’s no node (no file or buffer opened)
    • NODE_ELEMENT = 1 — Element (tag)
    • NODE_ELEMENT_END = 2 — End of element
    • NODE_TEXT = 3 — Text node
    • NODE_CDATA = 5 — CDATA content
    • NODE_UNKNOWN = 6 — Unknown node

    This class can serve as base to make custom XML parsers. Since XML is a very flexible standard, this interface is low level so it can be applied to any possible schema.

    • get_attribute_count ( ) const

    Get the amount of attributes in the current element.

    • String get_attribute_name ( idx ) const

    Get the name of the attribute specified by the index in argument.

    • String get_attribute_value ( idx ) const
    • int get_current_line ( ) const

    Get the current line in the parsed file (currently not implemented).

    • get_named_attribute_value ( String name ) const

    Get the value of a certain attribute of the current element by name. This will raise an error if the element has no such attribute.

    • get_named_attribute_value_safe ( String name ) const

    Get the value of a certain attribute of the current element by name. This will return an empty if the attribute is not found.

    • String get_node_data ( ) const

    Get the contents of a text node. This will raise an error in any other type of node.

    Get the name of the current element node. This will raise an error if the current node type is not nor NODE_ELEMENT_END

    • get_node_offset ( ) const

    Get the byte offset of the current node since the beginning of the file or buffer.

    • has_attribute ( String name ) const

    Check whether or not the current element has a certain attribute.

    • is_empty ( ) const

    Check whether the current element is empty (this only works for completely empty tags, e.g. <element \>).

    Open a XML file for parsing. This returns an error code.

    • Error open_buffer ( buffer )

    Open a XML raw buffer for parsing. This returns an error code.

    Read the next node of the file. This returns an error code.

    • seek ( int position )

    Move the buffer cursor to a certain offset (since the beginning) and read the next node there. This returns an error code.

    • void skip_section ( )