summaryrefslogtreecommitdiff
path: root/indra/llxml/llxmltree.h
blob: 5d15c4c7f5daade2e60403bdf233ea9f4b5ee2d0 (plain)
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
/** 
 * @file llxmltree.h
 * @author Aaron Yonas, Richard Nelson
 * @brief LLXmlTree class definition
 *
 * $LicenseInfo:firstyear=2001&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 * 
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#ifndef LL_LLXMLTREE_H
#define LL_LLXMLTREE_H

#include <map>
#include <list>
#include "llstring.h"
#include "llxmlparser.h"
#include "llstringtable.h"

class LLColor4;
class LLColor4U;
class LLQuaternion;
class LLUUID;
class LLVector3;
class LLVector3d;
class LLXmlTreeNode;
class LLXmlTreeParser;

//////////////////////////////////////////////////////////////
// LLXmlTree

class LLXmlTree
{
	friend class LLXmlTreeNode;
	
public:
	LLXmlTree();
	virtual ~LLXmlTree();
	void cleanup();

	virtual bool	parseFile(const std::string &path, bool keep_contents = true);

	LLXmlTreeNode*	getRoot() { return mRoot; }

	void			dump();
	void			dumpNode( LLXmlTreeNode* node, const std::string& prefix );

	static LLStdStringHandle addAttributeString( const std::string& name)
	{
		return sAttributeKeys.addString( name );
	}
	
public:
	// global
	static LLStdStringTable sAttributeKeys;
	
protected:
	LLXmlTreeNode* mRoot;

	// local
	LLStdStringTable mNodeNames;	
};

//////////////////////////////////////////////////////////////
// LLXmlTreeNode

class LLXmlTreeNode
{
	friend class LLXmlTree;
	friend class LLXmlTreeParser;

protected:
	// Protected since nodes are only created and destroyed by friend classes and other LLXmlTreeNodes
	LLXmlTreeNode( const std::string& name, LLXmlTreeNode* parent, LLXmlTree* tree );
	
public:
	virtual ~LLXmlTreeNode();

	const std::string&	getName()
	{
		return mName;
	}
	bool hasName( const std::string& name )
	{
		return mName == name;
	}

	bool hasAttribute( const std::string& name );

	// Fast versions use cannonical_name handlee to entru in LLXmlTree::sAttributeKeys string table
	bool			getFastAttributeBOOL(		LLStdStringHandle cannonical_name, bool& value );
	bool			getFastAttributeU8(			LLStdStringHandle cannonical_name, U8& value );
	bool			getFastAttributeS8(			LLStdStringHandle cannonical_name, S8& value );
	bool			getFastAttributeU16(		LLStdStringHandle cannonical_name, U16& value );
	bool			getFastAttributeS16(		LLStdStringHandle cannonical_name, S16& value );
	bool			getFastAttributeU32(		LLStdStringHandle cannonical_name, U32& value );
	bool			getFastAttributeS32(		LLStdStringHandle cannonical_name, S32& value );
	bool			getFastAttributeF32(		LLStdStringHandle cannonical_name, F32& value );
	bool			getFastAttributeF64(		LLStdStringHandle cannonical_name, F64& value );
	bool			getFastAttributeColor(		LLStdStringHandle cannonical_name, LLColor4& value );
	bool			getFastAttributeColor4(		LLStdStringHandle cannonical_name, LLColor4& value );
	bool			getFastAttributeColor4U(	LLStdStringHandle cannonical_name, LLColor4U& value );
	bool			getFastAttributeVector3(	LLStdStringHandle cannonical_name, LLVector3& value );
	bool			getFastAttributeVector3d(	LLStdStringHandle cannonical_name, LLVector3d& value );
	bool			getFastAttributeQuat(		LLStdStringHandle cannonical_name, LLQuaternion& value );
	bool			getFastAttributeUUID(		LLStdStringHandle cannonical_name, LLUUID& value );
	bool			getFastAttributeString(		LLStdStringHandle cannonical_name, std::string& value );

	// Normal versions find 'name' in LLXmlTree::sAttributeKeys then call fast versions
	virtual bool		getAttributeBOOL(		const std::string& name, bool& value );
	virtual bool		getAttributeU8(			const std::string& name, U8& value );
	virtual bool		getAttributeS8(			const std::string& name, S8& value );
	virtual bool		getAttributeU16(		const std::string& name, U16& value );
	virtual bool		getAttributeS16(		const std::string& name, S16& value );
	virtual bool		getAttributeU32(		const std::string& name, U32& value );
	virtual bool		getAttributeS32(		const std::string& name, S32& value );
	virtual bool		getAttributeF32(		const std::string& name, F32& value );
	virtual bool		getAttributeF64(		const std::string& name, F64& value );
	virtual bool		getAttributeColor(		const std::string& name, LLColor4& value );
	virtual bool		getAttributeColor4(		const std::string& name, LLColor4& value );
	virtual bool		getAttributeColor4U(	const std::string& name, LLColor4U& value );
	virtual bool		getAttributeVector3(	const std::string& name, LLVector3& value );
	virtual bool		getAttributeVector3d(	const std::string& name, LLVector3d& value );
	virtual bool		getAttributeQuat(		const std::string& name, LLQuaternion& value );
	virtual bool		getAttributeUUID(		const std::string& name, LLUUID& value );
	virtual bool		getAttributeString(		const std::string& name, std::string& value );

	const std::string& getContents()
	{
		return mContents;
	}
	std::string getTextContents();

	LLXmlTreeNode*	getParent()							{ return mParent; }
	LLXmlTreeNode*	getFirstChild();
	LLXmlTreeNode*	getNextChild();
	S32				getChildCount()						{ return (S32)mChildren.size(); }
	LLXmlTreeNode*  getChildByName( const std::string& name );	// returns first child with name, NULL if none
	LLXmlTreeNode*  getNextNamedChild();				// returns next child with name, NULL if none

protected:
	const std::string* getAttribute( LLStdStringHandle name)
	{
		attribute_map_t::iterator iter = mAttributes.find(name);
		return (iter == mAttributes.end()) ? 0 : iter->second;
	}

private:
	void			addAttribute( const std::string& name, const std::string& value );
	void			appendContents( const std::string& str );
	void			addChild( LLXmlTreeNode* child );

	void			dump( const std::string& prefix );

protected:
	typedef std::map<LLStdStringHandle, const std::string*> attribute_map_t;
	attribute_map_t						mAttributes;

private:
	std::string							mName;
	std::string							mContents;
	
	typedef std::vector<class LLXmlTreeNode *> children_t;
	children_t                          mChildren;
	children_t::iterator				mChildrenIter;
	
	typedef std::multimap<LLStdStringHandle, LLXmlTreeNode *> child_map_t;
	child_map_t							mChildMap;		// for fast name lookups
	child_map_t::iterator				mChildMapIter;
	child_map_t::iterator				mChildMapEndIter;

	LLXmlTreeNode*						mParent;
	LLXmlTree*							mTree;
};

//////////////////////////////////////////////////////////////
// LLXmlTreeParser

class LLXmlTreeParser : public LLXmlParser
{
public:
	LLXmlTreeParser(LLXmlTree* tree);
	virtual ~LLXmlTreeParser();

	bool parseFile(const std::string &path, LLXmlTreeNode** root, bool keep_contents );

protected:
	const std::string& tabs();

	// Overrides from LLXmlParser
	virtual void	startElement(const char *name, const char **attributes); 
	virtual void	endElement(const char *name);
	virtual void	characterData(const char *s, int len);
	virtual void	processingInstruction(const char *target, const char *data);
	virtual void	comment(const char *data);
	virtual void	startCdataSection();
	virtual void	endCdataSection();
	virtual void	defaultData(const char *s, int len);
	virtual void	unparsedEntityDecl(
		const char* entity_name,
		const char* base,
		const char* system_id,
		const char* public_id,
		const char* notation_name);

	//template method pattern
	virtual LLXmlTreeNode* CreateXmlTreeNode(const std::string& name, LLXmlTreeNode* parent);

protected:
	LLXmlTree*		mTree;
	LLXmlTreeNode*	mRoot;
	LLXmlTreeNode*  mCurrent;
	bool			mDump;	// Dump parse tree to LL_INFOS() as it is read.
	bool			mKeepContents;
};

#endif  // LL_LLXMLTREE_H