Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

XMLParser

Inherits: RefCounted < Object

Provides a low-level interface for creating parsers for XML files.

Description

Provides a low-level interface for creating parsers for XML files. This class can serve as base to make custom XML parsers.

To parse XML, you must open a file with the open method or a buffer with the open_buffer method. Then, the read method must be called to parse the next nodes. Most of the methods take into consideration the currently parsed node.

Here is an example of using XMLParser to parse a SVG file (which is based on XML), printing each element and its attributes as a dictionary:

var parser = XMLParser.new()
parser.open("path/to/file.svg")
while parser.read() != ERR_FILE_EOF:
    if parser.get_node_type() == XMLParser.NODE_ELEMENT:
        var node_name = parser.get_node_name()
        var attributes_dict = {}
        for idx in range(parser.get_attribute_count()):
            attributes_dict[parser.get_attribute_name(idx)] = parser.get_attribute_value(idx)
        print("The ", node_name, " element has the following attributes: ", attributes_dict)

Methods

int

get_attribute_count ( ) const

String

get_attribute_name ( int idx ) const

String

get_attribute_value ( int idx ) const

int

get_current_line ( ) const

String

get_named_attribute_value ( String name ) const

String

get_named_attribute_value_safe ( String name ) const

String

get_node_data ( ) const

String

get_node_name ( ) const

int

get_node_offset ( ) const

NodeType

get_node_type ( )

bool

has_attribute ( String name ) const

bool

is_empty ( ) const

Error

open ( String file )

Error

open_buffer ( PackedByteArray buffer )

Error

read ( )

Error

seek ( int position )

void

skip_section ( )


Enumerations

enum NodeType:

NodeType NODE_NONE = 0

There's no node (no file or buffer opened).

NodeType NODE_ELEMENT = 1

An element node type, also known as a tag, e.g. <title>.

NodeType NODE_ELEMENT_END = 2

An end of element node type, e.g. </title>.

NodeType NODE_TEXT = 3

A text node type, i.e. text that is not inside an element. This includes whitespace.

NodeType NODE_COMMENT = 4

A comment node type, e.g. <!--A comment-->.

NodeType NODE_CDATA = 5

A node type for CDATA (Character Data) sections, e.g. <![CDATA[CDATA section]]>.

NodeType NODE_UNKNOWN = 6

An unknown node type.


Method Descriptions

int get_attribute_count ( ) const

Returns the number of attributes in the currently parsed element.

Note: If this method is used while the currently parsed node is not NODE_ELEMENT or NODE_ELEMENT_END, this count will not be updated and will still reflect the last element.


String get_attribute_name ( int idx ) const

Returns the name of an attribute of the currently parsed element, specified by the idx index.


String get_attribute_value ( int idx ) const

Returns the value of an attribute of the currently parsed element, specified by the idx index.


int get_current_line ( ) const

Returns the current line in the parsed file, counting from 0.


String get_named_attribute_value ( String name ) const

Returns the value of an attribute of the currently parsed element, specified by its name. This method will raise an error if the element has no such attribute.


String get_named_attribute_value_safe ( String name ) const

Returns the value of an attribute of the currently parsed element, specified by its name. This method will return an empty string if the element has no such attribute.


String get_node_data ( ) const

Returns the contents of a text node. This method will raise an error if the current parsed node is of any other type.


String get_node_name ( ) const

Returns the name of an element node. This method will raise an error if the currently parsed node is not of NODE_ELEMENT or NODE_ELEMENT_END type.


int get_node_offset ( ) const

Returns the byte offset of the currently parsed node since the beginning of the file or buffer. This is usually equivalent to the number of characters before the read position.


NodeType get_node_type ( )

Returns the type of the current node. Compare with NodeType constants.


bool has_attribute ( String name ) const

Returns true if the currently parsed element has an attribute with the name.


bool is_empty ( ) const

Returns true if the currently parsed element is empty, e.g. <element />.


Error open ( String file )

Opens an XML file for parsing. This method returns an error code.


Error open_buffer ( PackedByteArray buffer )

Opens an XML raw buffer for parsing. This method returns an error code.


Error read ( )

Parses the next node in the file. This method returns an error code.


Error seek ( int position )

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


void skip_section (