d95794ec8a
As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
129 lines
4.3 KiB
C++
129 lines
4.3 KiB
C++
/**************************************************************************/
|
|
/* xml_parser.h */
|
|
/**************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/**************************************************************************/
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
/* */
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
/* a copy of this software and associated documentation files (the */
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
/* the following conditions: */
|
|
/* */
|
|
/* The above copyright notice and this permission notice shall be */
|
|
/* included in all copies or substantial portions of the Software. */
|
|
/* */
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
/**************************************************************************/
|
|
|
|
#ifndef XML_PARSER_H
|
|
#define XML_PARSER_H
|
|
|
|
#include "core/io/file_access.h"
|
|
#include "core/object/ref_counted.h"
|
|
#include "core/string/ustring.h"
|
|
#include "core/templates/vector.h"
|
|
|
|
/*
|
|
Based on irrXML (see their zlib license). Added mainly for compatibility with their Collada loader.
|
|
*/
|
|
|
|
class XMLParser : public RefCounted {
|
|
GDCLASS(XMLParser, RefCounted);
|
|
|
|
public:
|
|
//! Enumeration of all supported source text file formats
|
|
enum SourceFormat {
|
|
SOURCE_ASCII,
|
|
SOURCE_UTF8,
|
|
SOURCE_UTF16_BE,
|
|
SOURCE_UTF16_LE,
|
|
SOURCE_UTF32_BE,
|
|
SOURCE_UTF32_LE
|
|
};
|
|
|
|
enum NodeType {
|
|
NODE_NONE,
|
|
NODE_ELEMENT,
|
|
NODE_ELEMENT_END,
|
|
NODE_TEXT,
|
|
NODE_COMMENT,
|
|
NODE_CDATA,
|
|
NODE_UNKNOWN
|
|
};
|
|
|
|
private:
|
|
char *data_copy = nullptr;
|
|
const char *data = nullptr;
|
|
const char *P = nullptr;
|
|
uint64_t length = 0;
|
|
uint64_t current_line = 0;
|
|
String node_name;
|
|
bool node_empty = false;
|
|
NodeType node_type = NODE_NONE;
|
|
uint64_t node_offset = 0;
|
|
|
|
struct Attribute {
|
|
String name;
|
|
String value;
|
|
};
|
|
|
|
Vector<Attribute> attributes;
|
|
|
|
bool _set_text(const char *start, const char *end);
|
|
void _parse_closing_xml_element();
|
|
void _ignore_definition();
|
|
bool _parse_cdata();
|
|
void _parse_comment();
|
|
void _parse_opening_xml_element();
|
|
void _parse_current_node();
|
|
|
|
_FORCE_INLINE_ void next_char() {
|
|
if (*P == '\n') {
|
|
current_line++;
|
|
}
|
|
P++;
|
|
}
|
|
|
|
static void _bind_methods();
|
|
|
|
public:
|
|
Error read();
|
|
NodeType get_node_type();
|
|
String get_node_name() const;
|
|
String get_node_data() const;
|
|
uint64_t get_node_offset() const;
|
|
int get_attribute_count() const;
|
|
String get_attribute_name(int p_idx) const;
|
|
String get_attribute_value(int p_idx) const;
|
|
bool has_attribute(const String &p_name) const;
|
|
String get_attribute_value(const String &p_name) const;
|
|
String get_attribute_value_safe(const String &p_name) const; // do not print error if doesn't exist
|
|
bool is_empty() const;
|
|
int get_current_line() const;
|
|
|
|
void skip_section();
|
|
Error seek(uint64_t p_pos);
|
|
|
|
Error open(const String &p_path);
|
|
Error open_buffer(const Vector<uint8_t> &p_buffer);
|
|
Error _open_buffer(const uint8_t *p_buffer, size_t p_size);
|
|
|
|
void close();
|
|
|
|
~XMLParser();
|
|
};
|
|
|
|
#endif // XML_PARSER_H
|