File: xml_node.h

package info (click to toggle)
scummvm 2.9.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 450,580 kB
  • sloc: cpp: 4,299,825; asm: 28,322; python: 12,901; sh: 11,302; java: 9,289; xml: 7,895; perl: 2,639; ansic: 2,465; yacc: 1,670; javascript: 1,020; makefile: 933; lex: 578; awk: 275; objc: 82; sed: 11; php: 1
file content (166 lines) | stat: -rw-r--r-- 4,799 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef SHARED_CONF_XML_NODE_H
#define SHARED_CONF_XML_NODE_H

#include "common/array.h"
#include "common/hash-str.h"
#include "common/path.h"
#include "common/str.h"
#include "common/util.h"

namespace Ultima {
namespace Shared {

class XMLTree;

class XMLNode {
private:
	XMLTree *_tree;
	XMLNode *_parent;
	Common::String _id;
	Common::String _text;
	Common::Array<XMLNode *> _nodeList;
	Common::StringMap _attributes;
	bool _noClose;
	Common::String _emptyString;
private:
	static void parseDocTypeElement(const Common::String &s, size_t &nn);

	void parseNodeText(const Common::String &nodeText);

	/**
	 * Trim down any whitespaces in the passed text
	 */
	static void trim(Common::String &s);

	/**
	 * Parses a specified file and returns the root node for it
	 */
	static XMLNode *xmlParseFile(XMLTree *tree, const Common::Path &fname);

	static Common::String closeTag(const Common::String &s);
	static Common::String encodeEntity(const Common::String &s);
public:
	XMLNode(XMLTree *tree, XMLNode *parent = nullptr) : _tree(tree), _parent(parent), _noClose(false) {}
	XMLNode(const XMLNode &n) : _tree(n._tree), _parent(n._parent), _id(n._id),
		_text(n._text), _nodeList(n._nodeList), _noClose(false) {}
	~XMLNode();

	XMLNode &operator=(const XMLNode &n) {
		_id = n._id;
		_text = n._text;
		_nodeList = n._nodeList;
		_noClose = n._noClose;
		return *this;
	}

	const Common::String &reference(const Common::String &, bool &);
	const XMLNode *subtree(const Common::String &) const;

	const Common::String &id() const {
		return _id;
	}
	const Common::String &text(void) const {
		return _text;
	}
	bool nodeIsText() const {
		return !_text.empty();
	}
	XMLNode *getParent() const {
		return _parent;
	}
	bool hasChildren() const {
		return !_nodeList.empty();
	}
	XMLNode *firstChild() const {
		return _nodeList.empty() ? nullptr : _nodeList[0];
	}
	const Common::StringMap &attributes() const {
		return _attributes;
	}
	bool hasProperty(const Common::String &attrName) const {
		return _attributes.contains(attrName);
	}
	Common::String getProperty(const Common::String &attrName) const {
		return _attributes.contains(attrName) ? _attributes[attrName] : "";
	}
	int getPropertyInt(const Common::String &attrName) const {
		return _attributes.contains(attrName) ? atol(_attributes[attrName].c_str()) : 0;
	}
	bool getPropertyBool(const Common::String &attrName) const {
		if (_attributes.contains(attrName)) {
			Common::String str = _attributes[attrName];
			return toupper(str[0]) == 'T' || str == "1";
		} else {
			return false;
		}
	}
	Common::String operator[](const Common::String &attrName) const {
		return getProperty(attrName);
	}

	const Common::Array<XMLNode *> &children() const {
		return _nodeList;
	}

	typedef Common::Pair<Common::String, Common::String> KeyType;
	typedef Common::Array<KeyType> KeyTypeList;

	/**
	 * Returns a list of key->value pairs that are found under the provided 'basekey'.
	 * Ignores comments (<!-- ... --> and doesn't return them.
	 * Returns true if search is 'finished'
	 */
	bool searchPairs(KeyTypeList &ktl, const Common::String &basekey,
		const Common::String currkey, const unsigned int pos);
	void selectPairs(KeyTypeList &ktl, const Common::String currkey);

	Common::String dump(int depth = 0);

	void xmlAssign(const Common::String &key, const Common::String &value);
	static XMLNode *xmlParseDoc(XMLTree *tree, const Common::String &s);
	static XMLNode *xmlParse(XMLTree *tree, const Common::String &s, size_t &pos);

	void listKeys(const Common::String &, Common::Array<Common::String> &,
		bool longformat = true) const;

	/**
	 * Deletes the entire tree this node belongs to, including itself
	 */
	void freeDoc();

	/**
	 * Gets the prior sibling to this one
	 */
	XMLNode *getPrior() const;

	/**
	 * Gets the following sibling to this one
	 */
	XMLNode *getNext() const;
};

} // End of namespace Shared
} // End of namespace Ultima

#endif