Context Navigation

XMLPort.h @ 7189

Last change on this file since 7189 was 7189, checked in by landauf, 14 years ago

changed passing of the returnvalue in the command execution pipeline:

Functor: operator() directly returns the returnvalue of the executed function (if any, otherwise a MultiType whose null() function evaluates to true). The returnvalue is no longer stored in the Functor.
Executor: The same behavior of operator() like in Functor. Additionally the parse() function returns the returnvalue of the executed function instead of a boolean status. The status can be retrieved by passing a pointer to a bool to the function.
CommandExecutor: execute() works like before (returns only a boolean status), but added a new function query() which returns the returnvalue of the executed command. The status of query() can be retrieved by optionally passing an pointer to a bool.
CommandEvaluation: same as for CommandExecutor: execute() like before, added query()
TclBind::eval() returns the returnvalue of the evaluated tcl command. The status can also be retrieved by passing a pointer to a bool.
The Shell prints the returnvalue (if available) of an executed command

added a constructor to MultiType to directly create it from an mbool. The mbool will be converted to a bool, so it loses it's internal state.

Property svn:eol-style set to native

File size: 33.4 KB

Line
1	/*
2	* ORXONOX - the hottest 3D action shooter ever to exist
3	* > www.orxonox.net <
4	*
5	*
6	* License notice:
7	*
8	* This program is free software; you can redistribute it and/or
9	* modify it under the terms of the GNU General Public License
10	* as published by the Free Software Foundation; either version 2
11	* of the License, or (at your option) any later version.
12	*
13	* This program is distributed in the hope that it will be useful,
14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16	* GNU General Public License for more details.
17	*
18	* You should have received a copy of the GNU General Public License
19	* along with this program; if not, write to the Free Software
20	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21	*
22	* Author:
23	* Fabian 'x3n' Landau
24	* Co-authors:
25	* ...
26	*
27	*/
28
29	/**
30	@file
31	@brief Declaration of the XMLPort helper classes and macros.
32
33	XMLPort is a virtual function of every BaseObject. Every object can change this function.
34	The XMLPort function gets called with an XMLElement, containing all attributes and
35	subclasses the object gets from the levelfile.
36
37	This file declares classes and macros to simplify XML-parsing.
38	*/
39
40	#ifndef _XMLPort_H__
41	#define _XMLPort_H__
42
43	#include "CorePrereqs.h"
44
45	#include <cassert>
46	#include <string>
47	#include <tinyxml/ticpp.h>
48
49	#include "util/Debug.h"
50	#include "util/Exception.h"
51	#include "util/MultiType.h"
52	#include "util/OrxAssert.h"
53	#include "util/StringUtils.h"
54	#include "Identifier.h"
55	#include "Executor.h"
56	#include "BaseObject.h"
57
58	// ------------
59	// XMLPortParam
60
61	/**
62	@brief Declares an XML attribute with a name, which will be set through load- and savefunctions.
63	@param classname The name of the class owning this param
64	@param paramname The name of the attribute
65	@param loadfunction A function to set the param in the object with a given value (~a set-function)
66	@param savefunction A function to get the value of the param from the object (~a get-function)
67	@param xmlelement The XMLElement, you get this from the XMLPort function
68	@param mode The mode (load or save), you get this from the XMLPort function
69
70	In the XML file, a param or attribute will be set like this:
71	<classname paramname="value" />
72
73	The macro will then call loadfunction(value) to set the given value (or call savefunction() to
74	write an existing value to an XML file).
75	*/
76	#define XMLPortParam(classname, paramname, loadfunction, savefunction, xmlelement, mode) \
77	static ExecutorMember<classname>* xmlcontainer##loadfunction##savefunction##loadexecutor = orxonox::createExecutor(orxonox::createFunctor(&classname::loadfunction), std::string( #classname ) + "::" + #loadfunction); \
78	static ExecutorMember<classname>* xmlcontainer##loadfunction##savefunction##saveexecutor = orxonox::createExecutor(orxonox::createFunctor(&classname::savefunction), std::string( #classname ) + "::" + #savefunction); \
79	XMLPortParamGeneric(xmlcontainer##loadfunction##savefunction, classname, classname, this, paramname, xmlcontainer##loadfunction##savefunction##loadexecutor, xmlcontainer##loadfunction##savefunction##saveexecutor, xmlelement, mode)
80
81	/**
82	@brief Declares an XML attribute with a name, which will be set through a variable.
83	@param classname The name of the class owning this param
84	@param paramname The name of the attribute
85	@param variable Name of the variable used to save and load the value
86	@param xmlelement The XMLElement, you get this from the XMLPort function
87	@param mode The mode (load or save), you get this from the XMLPort function
88
89	In the XML file, a param or attribute will be set like this:
90	<classname paramname="value" />
91
92	The macro will then store "value" in the variable or read it when saving.
93	*/
94	#define XMLPortParamVariable(classname, paramname, variable, xmlelement, mode) \
95	XMLPortVariableHelperClass xmlcontainer##variable##dummy(static_cast<void*>(&variable)); \
96	static ExecutorMember<orxonox::XMLPortVariableHelperClass>* xmlcontainer##variable##loadexecutor = static_cast<ExecutorMember<orxonox::XMLPortVariableHelperClass>*>(orxonox::createExecutor(orxonox::createFunctor(orxonox::XMLPortVariableHelperClass::getLoader(variable)), std::string( #classname ) + "::" + #variable + "loader")); \
97	static ExecutorMember<orxonox::XMLPortVariableHelperClass>* xmlcontainer##variable##saveexecutor = static_cast<ExecutorMember<orxonox::XMLPortVariableHelperClass>*>(orxonox::createExecutor(orxonox::createFunctor(orxonox::XMLPortVariableHelperClass::getSaver (variable)), std::string( #classname ) + "::" + #variable + "saver" )); \
98	XMLPortParamGeneric(xmlcontainer##variable, classname, orxonox::XMLPortVariableHelperClass, &xmlcontainer##variable##dummy, paramname, xmlcontainer##variable##loadexecutor, xmlcontainer##variable##saveexecutor, xmlelement, mode)
99
100	/**
101	@brief This is the same as XMLPortParam, but you can set the template arguments needed to store the loadfunction.
102
103	Sometimes the name of the loadfunction is ambiguous (example: setPosition(Vector3) or
104	setPosition(float, float, float)). In this case, you can choose the right function by
105	telling the types of the functionparams. In our example, this would be either
106	> XMLPortParamTemplate(classname, paramname, loadfunction, savefunction, xmlelement, mode, Vector3);
107	or
108	> XMLPortParamTemplate(classname, paramname, loadfunction, savefunction, xmlelement, mode, float, float, float);
109	You don't have to use this, if there exist only one function with the given name.
110	*/
111	#define XMLPortParamTemplate(classname, paramname, loadfunction, savefunction, xmlelement, mode, ...) \
112	static ExecutorMember<classname>* xmlcontainer##loadfunction##savefunction##loadexecutor = orxonox::createExecutor(orxonox::createFunctor<classname, __VA_ARGS__ >(&classname::loadfunction), std::string( #classname ) + "::" + #loadfunction); \
113	static ExecutorMember<classname>* xmlcontainer##loadfunction##savefunction##saveexecutor = orxonox::createExecutor(orxonox::createFunctor(&classname::savefunction), std::string( #classname ) + "::" + #savefunction); \
114	XMLPortParamGeneric(xmlcontainer##loadfunction##savefunction, classname, classname, this, paramname, xmlcontainer##loadfunction##savefunction##loadexecutor, xmlcontainer##loadfunction##savefunction##saveexecutor, xmlelement, mode)
115
116	// --------------------
117	// XMLPortParamLoadOnly
118
119	/**
120	@brief Declares an XML attribute with a name, which can be set through a loadfunction.
121
122	This is the same as XMLPortParam, but you don't need a savefunction (get-function). Therefore,
123	this param won't be saved in an XML file, but you can add the attribute manually an it will be
124	loaded.
125
126	This might be helpful in cases, when you have several options to set a value, for example the
127	rotation. You can set the rotation with a quaternion, but you could also use three angles.
128	When saving the object, only one of both options has to be saved; this is, where this macro helps.
129	*/
130	#define XMLPortParamLoadOnly(classname, paramname, loadfunction, xmlelement, mode) \
131	static ExecutorMember<classname>* xmlcontainer##loadfunction##0##loadexecutor = orxonox::createExecutor(orxonox::createFunctor(&classname::loadfunction), std::string( #classname ) + "::" + #loadfunction); \
132	XMLPortParamGeneric(xmlcontainer##loadfunction##0, classname, classname, this, paramname, xmlcontainer##loadfunction##0##loadexecutor, 0, xmlelement, mode)
133	/**
134	@brief This is the same as XMLPortParamTemplate, but for load-only attributes (see XMLPortParamLoadOnly).
135	*/
136	#define XMLPortParamLoadOnlyTemplate(classname, paramname, loadfunction, xmlelement, mode, ...) \
137	static ExecutorMember<classname>* xmlcontainer##loadfunction##0##loadexecutor = orxonox::createExecutor(orxonox::createFunctor<classname, __VA_ARGS__ >(&classname::loadfunction), std::string( #classname ) + "::" + #loadfunction); \
138	XMLPortParamGeneric(xmlcontainer##loadfunction##0, classname, classname, this, paramname, xmlcontainer##loadfunction##0##loadexecutor, 0, xmlelement, mode)
139
140	// ------------------
141	// XMLPortParamExtern
142
143	/**
144	@brief This is the same as XMLPortParam, but for attributes in an extern class.
145	@param classname The name of the class owning the object owning the attribute
146	@param externclass The name of the extern class (the objects class)
147	@param object The name of the object of the extern class (a member of the main class)
148	@param paramname The name of the attribute
149	@param loadfunction The function to set the attribute inside of the member object.
150	@param loadfunction The function to get the attribute from the member object
151
152	Sometimes you'll have a member object in your class, which has it's own load- and savefunctions.
153	With this macro, you can simply use them instead of writing your own functions.
154
155	@example
156	Your class is called SpaceShip and this class has an object (myPilot_) of class Pilot. Pilot has a name
157	and two functions, setName(name) and getName(). Now you want an attribute "pilotname" in your
158	SpaceShip class. Instead of writing wrapper functions, you can simply use the XMLPortParamExtern
159	macro:
160	> XMLPortParamExtern(SpaceShip, Pilot, myPilot_, "pilotname", setName, getName, xmlelement, mode);
161	*/
162	#define XMLPortParamExtern(classname, externclass, object, paramname, loadfunction, savefunction, xmlelement, mode) \
163	static ExecutorMember<externclass>* xmlcontainer##loadfunction##savefunction##loadexecutor = orxonox::createExecutor(orxonox::createFunctor(&externclass::loadfunction), std::string( #externclass ) + "::" + #loadfunction); \
164	static ExecutorMember<externclass>* xmlcontainer##loadfunction##savefunction##saveexecutor = orxonox::createExecutor(orxonox::createFunctor(&externclass::savefunction), std::string( #externclass ) + "::" + #savefunction); \
165	XMLPortParamGeneric(xmlcontainer##loadfunction##savefunction, classname, externclass, object, paramname, xmlcontainer##loadfunction##savefunction##loadexecutor, xmlcontainer##loadfunction##savefunction##saveexecutor, xmlelement, mode);
166	/**
167	@brief This is the same as XMLPortParamTemplate, but for extern attributes (see XMLPortParamExtern).
168	*/
169	#define XMLPortParamExternTemplate(classname, externclass, object, paramname, loadfunction, savefunction, xmlelement, mode, ...) \
170	static ExecutorMember<externclass>* xmlcontainer##loadfunction##savefunction##loadexecutor = orxonox::createExecutor(orxonox::createFunctor<externclass, __VA_ARGS__ >(&externclass::loadfunction), std::string( #externclass ) + "::" + #loadfunction); \
171	static ExecutorMember<externclass>* xmlcontainer##loadfunction##savefunction##saveexecutor = orxonox::createExecutor(orxonox::createFunctor(&externclass::savefunction), std::string( #externclass ) + "::" + #savefunction); \
172	XMLPortParamGeneric(xmlcontainer##loadfunction##savefunction, classname, externclass, object, paramname, xmlcontainer##loadfunction##savefunction##loadexecutor, xmlcontainer##loadfunction##savefunction##saveexecutor, xmlelement, mode);
173
174	// -------------------
175	// XMLPortParamGeneric
176
177	/**
178	@brief This is the generic XMLPort param macro, which is used by all six specialized macros above.
179	*/
180	#define XMLPortParamGeneric(containername, classname, objectclass, object, paramname, loadexecutor, saveexecutor, xmlelement, mode) \
181	orxonox::XMLPortClassParamContainer<objectclass>* containername = static_cast<orxonox::XMLPortClassParamContainer<objectclass>*>(ClassIdentifier<classname>::getIdentifier()->getXMLPortParamContainer(paramname)); \
182	if (!containername) \
183	{ \
184	containername = new orxonox::XMLPortClassParamContainer<objectclass>(std::string(paramname), ClassIdentifier<classname>::getIdentifier(), loadexecutor, saveexecutor); \
185	ClassIdentifier<classname>::getIdentifier()->addXMLPortParamContainer(paramname, containername); \
186	} \
187	containername->port(dynamic_cast<BaseObject*>(this), object, xmlelement, mode)
188
189	// --------------------
190	// XMLPortObjectExtended
191
192	/**
193	@brief Declares a possible sub-object that can be added in the XML file.
194	@param classname The name of the class that uses this macro
195	@param objectclass The baseclass of objects that can be added
196	@param sectionname The name of the subsection in the XML file that encloses the sub-objects ("" means no subsection)
197	@param loadfunction The function to add a new object to the class
198	@param loadfunction The function to get all added objects from the class
199	@param xmlelement The XMLElement (received through the XMLPort function)
200	@param mode The mode (load/save) (received through the XMLPort function)
201	@param bApplyLoaderMask If this is true, an added sub-object gets loaded only if it's class is included in the Loaders ClassTreeMask (this is usually false)
202	@param bLoadBefore If this is true, the sub-object gets loaded (through XMLPort) BEFORE it gets added to the main class (this is usually true)
203
204	bApplyLoaderMask is usually false for the following reason:
205	If the loaders mask says, for example, "load only SpaceShips" and you added weapons to the
206	SpaceShips, then the Weapons will still be loaded (which is most probably what you want).
207	Of course, if there are "standalone" weapons in the level, they wont be loaded.
208
209	If bLoadBefore is true, an added object already has all attributes set (like it's name). This is most
210	likely the best option, so this is usually true.
211
212	@note
213	The load- and savefunctions have to follow an exactly defined protocol.
214	Loadfunction:
215	The loadfunction gets a pointer to the object.
216	> void loadfunction(objectclass* pointer);
217
218	Savefunction:
219	The savefunction gets an index, starting with 0. For every returnvalue != 0, the savefunction
220	gets called again, but with index + 1. It's the functions responsibility to do something smart
221	with the index and to return 0 if all objects were returned.
222	> objectclass* savefunction(unsigned int index) const;
223
224	Possible implementation:
225	objectclass* savefunction(unsigned int index) const
226	{
227	if (index < number_of_added_objects_)
228	return my_added_objects[index];
229	else
230	return 0;
231	}
232
233	@example
234	Possible usage of the macro:
235	> XMLPortObject(SpaceShip, Weapon, "weapons", addWeapon, getWeapon, xmlelement, mode, false, true);
236
237	Now you can add weapons through the XML file:
238	<SpaceShip someattribute="..." ...>
239	<weapons>
240	<Weapon someattribute="..." ... />
241	<Weapon someattribute="..." ... />
242	<Weapon someattribute="..." ... />
243	</weapons>
244	</SpaceShip>
245
246	Note that "weapons" is the subsection. This allows you to add more types of sub-objects. In our example,
247	you could add pilots, blinking lights or other stuff. If you don't want a subsection, just use "" (an
248	empty string). Then you can add sub-objects directly into the mainclass.
249	*/
250	#define XMLPortObjectExtended(classname, objectclass, sectionname, loadfunction, savefunction, xmlelement, mode, bApplyLoaderMask, bLoadBefore) \
251	static ExecutorMember<classname>* xmlcontainer##loadfunction##savefunction##loadexecutor = orxonox::createExecutor(orxonox::createFunctor(&classname::loadfunction), std::string( #classname ) + "::" + #loadfunction); \
252	static ExecutorMember<classname>* xmlcontainer##loadfunction##savefunction##saveexecutor = orxonox::createExecutor(orxonox::createFunctor(&classname::savefunction), std::string( #classname ) + "::" + #savefunction); \
253	XMLPortObjectGeneric(xmlcontainer##loadfunction##savefunction, classname, objectclass, sectionname, xmlcontainer##loadfunction##savefunction##loadexecutor, xmlcontainer##loadfunction##savefunction##saveexecutor, xmlelement, mode, bApplyLoaderMask, bLoadBefore)
254	/**
255	@brief This is the same as XMLPortObjectExtended, but you can specify the loadfunction by adding the param types. See XMLPortParamTemplate for more details about the types.
256	*/
257	#define XMLPortObjectExtendedTemplate(classname, objectclass, sectionname, loadfunction, savefunction, xmlelement, mode, bApplyLoaderMask, bLoadBefore, ...) \
258	static ExecutorMember<classname>* xmlcontainer##loadfunction##savefunction##loadexecutor = orxonox::createExecutor(orxonox::createFunctor<classname, __VA_ARGS__ >(&classname::loadfunction), std::string( #classname ) + "::" + #loadfunction); \
259	static ExecutorMember<classname>* xmlcontainer##loadfunction##savefunction##saveexecutor = orxonox::createExecutor(orxonox::createFunctor(&classname::savefunction), std::string( #classname ) + "::" + #savefunction); \
260	XMLPortObjectGeneric(xmlcontainer##loadfunction##savefunction, classname, objectclass, sectionname, xmlcontainer##loadfunction##savefunction##loadexecutor, xmlcontainer##loadfunction##savefunction##saveexecutor, xmlelement, mode, bApplyLoaderMask, bLoadBefore)
261
262	// -------------
263	// XMLPortObject
264
265	/**
266	@brief This is the same as XMLPortObjectExtended, but bApplyLoaderMask is false and bLoadBefore is true by default.
267	*/
268	#define XMLPortObject(classname, objectclass, sectionname, loadfunction, savefunction, xmlelement, mode) \
269	static ExecutorMember<classname>* xmlcontainer##loadfunction##savefunction##loadexecutor = orxonox::createExecutor(orxonox::createFunctor(&classname::loadfunction), std::string( #classname ) + "::" + #loadfunction); \
270	static ExecutorMember<classname>* xmlcontainer##loadfunction##savefunction##saveexecutor = orxonox::createExecutor(orxonox::createFunctor(&classname::savefunction), std::string( #classname ) + "::" + #savefunction); \
271	XMLPortObjectGeneric(xmlcontainer##loadfunction##savefunction, classname, objectclass, sectionname, xmlcontainer##loadfunction##savefunction##loadexecutor, xmlcontainer##loadfunction##savefunction##saveexecutor, xmlelement, mode, false, true)
272	/**
273	@brief This is the same as XMLPortObject, but you can specify the loadfunction by adding the param types. See XMLPortParamTemplate for more details about the types.
274	*/
275	#define XMLPortObjectTemplate(classname, objectclass, sectionname, loadfunction, savefunction, xmlelement, mode, ...) \
276	static ExecutorMember<classname>* xmlcontainer##loadfunction##savefunction##loadexecutor = orxonox::createExecutor(orxonox::createFunctor<classname, __VA_ARGS__ >(&classname::loadfunction), std::string( #classname ) + "::" + #loadfunction); \
277	static ExecutorMember<classname>* xmlcontainer##loadfunction##savefunction##saveexecutor = orxonox::createExecutor(orxonox::createFunctor(&classname::savefunction), std::string( #classname ) + "::" + #savefunction); \
278	XMLPortObjectGeneric(xmlcontainer##loadfunction##savefunction, classname, objectclass, sectionname, xmlcontainer##loadfunction##savefunction##loadexecutor, xmlcontainer##loadfunction##savefunction##saveexecutor, xmlelement, mode, false, true)
279
280	// --------------------
281	// XMLPortObjectGeneric
282
283	/**
284	@brief Generic XMLPortObject macro, that gets called by all other XMLPortObject macros above.
285	*/
286	#define XMLPortObjectGeneric(containername, classname, objectclass, sectionname, loadexecutor, saveexecutor, xmlelement, mode, bApplyLoaderMask, bLoadBefore) \
287	orxonox::XMLPortClassObjectContainer<classname, objectclass>* containername = (orxonox::XMLPortClassObjectContainer<classname, objectclass>*)(ClassIdentifier<classname>::getIdentifier()->getXMLPortObjectContainer(sectionname)); \
288	if (!containername) \
289	{ \
290	containername = new orxonox::XMLPortClassObjectContainer<classname, objectclass>(std::string(sectionname), ClassIdentifier<classname>::getIdentifier(), loadexecutor, saveexecutor, bApplyLoaderMask, bLoadBefore); \
291	ClassIdentifier<classname>::getIdentifier()->addXMLPortObjectContainer(sectionname, containername); \
292	} \
293	containername->port(this, xmlelement, mode)
294
295
296	namespace orxonox
297	{
298	// ###############################
299	// ### XMLPortParamContainer ###
300	// ###############################
301	class _CoreExport XMLPortParamContainer
302	{
303	public:
304	enum ParseResult
305	{
306	PR_not_started,
307	PR_finished,
308	PR_waiting_for_default_values
309	};
310
311	public:
312	XMLPortParamContainer()
313	{ this->parseResult_ = PR_not_started; }
314	virtual ~XMLPortParamContainer() {}
315
316	inline const std::string& getName() const
317	{ return this->paramname_; }
318
319	inline XMLPortParamContainer& description(const std::string& description)
320	{ this->description_ = description; return *this; }
321	inline const std::string& getDescription() const
322	{ return this->description_; }
323
324	virtual XMLPortParamContainer& defaultValue(unsigned int index, const MultiType& param) = 0;
325	virtual XMLPortParamContainer& defaultValues(const MultiType& param1) = 0;
326	virtual XMLPortParamContainer& defaultValues(const MultiType& param1, const MultiType& param2) = 0;
327	virtual XMLPortParamContainer& defaultValues(const MultiType& param1, const MultiType& param2, const MultiType& param3) = 0;
328	virtual XMLPortParamContainer& defaultValues(const MultiType& param1, const MultiType& param2, const MultiType& param3, const MultiType& param4) = 0;
329	virtual XMLPortParamContainer& defaultValues(const MultiType& param1, const MultiType& param2, const MultiType& param3, const MultiType& param4, const MultiType& param5) = 0;
330
331	protected:
332	std::string paramname_;
333	ParseResult parseResult_;
334	Identifier* identifier_;
335	BaseObject* owner_;
336	std::string description_;
337	};
338
339	template <class T>
340	class XMLPortClassParamContainer : public XMLPortParamContainer
341	{
342	struct ParseParams
343	{
344	T* object;
345	Element* xmlelement;
346	XMLPort::Mode mode;
347	};
348
349	public:
350	XMLPortClassParamContainer(const std::string& paramname, Identifier* identifier, ExecutorMember<T>* loadexecutor, ExecutorMember<T>* saveexecutor)
351	{
352	this->paramname_ = paramname;
353	this->identifier_ = identifier;
354	this->loadexecutor_ = loadexecutor;
355	this->saveexecutor_ = saveexecutor;
356	}
357
358	~XMLPortClassParamContainer()
359	{
360	assert(this->loadexecutor_);
361	delete this->loadexecutor_;
362	if (this->saveexecutor_)
363	delete this->saveexecutor_;
364	}
365
366	XMLPortParamContainer& port(BaseObject* owner, T* object, Element& xmlelement, XMLPort::Mode mode)
367	{
368	OrxAssert(owner, "XMLPortParamContainer must have a BaseObject as owner.");
369	this->owner_ = owner;
370	this->parseParams_.object = object;
371	this->parseParams_.xmlelement = &xmlelement;
372	this->parseParams_.mode = mode;
373
374	if ((mode == XMLPort::LoadObject) \|\| (mode == XMLPort::ExpandObject))
375	{
376	try
377	{
378	if (this->owner_->lastLoadedXMLElement_ != &xmlelement)
379	{
380	this->owner_->xmlAttributes_.clear();
381	// Iterate through the attributes manually in order to make them case insensitive
382	ticpp::Attribute* attribute = xmlelement.FirstAttribute(false);
383	while (attribute != 0)
384	{
385	this->owner_->xmlAttributes_[getLowercase(attribute->Name())] = attribute->Value();
386	attribute = attribute->Next(false);
387	}
388	this->owner_->lastLoadedXMLElement_ = &xmlelement;
389	}
390	std::map<std::string, std::string>::const_iterator it = this->owner_->xmlAttributes_.find(getLowercase(this->paramname_));
391	std::string attributeValue;
392	if (it != this->owner_->xmlAttributes_.end())
393	attributeValue = it->second;
394
395	// TODO: Checking the iterator would be better since then we can have strings with value "" as well.
396	// Unfortunately this does not seem to work with the Executor parser yet.
397	if ((!attributeValue.empty()) \|\| ((mode != XMLPort::ExpandObject) && this->loadexecutor_->allDefaultValuesSet()))
398	{
399	COUT(5) << this->owner_->getLoaderIndentation() << "Loading parameter " << this->paramname_ << " in " << this->identifier_->getName() << " (objectname " << this->owner_->getName() << ")." << std::endl << this->owner_->getLoaderIndentation();
400	bool success;
401	this->loadexecutor_->parse(object, attributeValue, &success, ",");
402	if (success \|\| (mode == XMLPort::ExpandObject))
403	this->parseResult_ = PR_finished;
404	else
405	this->parseResult_ = PR_waiting_for_default_values;
406	}
407	else if (mode == XMLPort::ExpandObject)
408	this->parseResult_ = PR_finished;
409	else
410	this->parseResult_ = PR_waiting_for_default_values;
411	}
412	catch (ticpp::Exception& ex)
413	{
414	COUT(1) << std::endl;
415	COUT(1) << "An error occurred in XMLPort.h while loading attribute '" << this->paramname_ << "' of '" << this->identifier_->getName() << "' (objectname: " << this->owner_->getName() << ") in " << this->owner_->getFilename() << ':' << std::endl;
416	COUT(1) << ex.what() << std::endl;
417	}
418	}
419	else if (mode == XMLPort::SaveObject)
420	{
421	if (this->saveexecutor_)
422	{
423	// xmlelement.SetAttribute(this->paramname_, "...");
424	}
425	}
426
427	return (*this);
428	}
429
430	XMLPortParamContainer& port(BaseObject* owner, const ParseParams& parseParams)
431	{
432	return this->port(owner, parseParams.object, *parseParams.xmlelement, parseParams.mode);
433	}
434
435	XMLPortParamContainer& portIfWaitingForDefaultValues(const ParseResult& result, const ParseParams& params)
436	{
437	if (result == PR_waiting_for_default_values)
438	return this->port(this->owner_, params);
439	else
440	return (*this);
441	}
442
443	virtual XMLPortParamContainer& defaultValue(unsigned int index, const MultiType& param)
444	{
445	if (!this->loadexecutor_->defaultValueSet(index))
446	this->loadexecutor_->setDefaultValue(index, param);
447	return this->portIfWaitingForDefaultValues(this->parseResult_, this->parseParams_);
448	}
449	virtual XMLPortParamContainer& defaultValues(const MultiType& param1)
450	{
451	if (!this->loadexecutor_->defaultValueSet(0))
452	this->loadexecutor_->setDefaultValues(param1);
453	return this->portIfWaitingForDefaultValues(this->parseResult_, this->parseParams_);
454	}
455	virtual XMLPortParamContainer& defaultValues(const MultiType& param1, const MultiType& param2)
456	{
457	if ((!this->loadexecutor_->defaultValueSet(0)) \|\| (!this->loadexecutor_->defaultValueSet(1)))
458	this->loadexecutor_->setDefaultValues(param1, param2);
459	return this->portIfWaitingForDefaultValues(this->parseResult_, this->parseParams_);
460	}
461	virtual XMLPortParamContainer& defaultValues(const MultiType& param1, const MultiType& param2, const MultiType& param3)
462	{
463	if ((!this->loadexecutor_->defaultValueSet(0)) \|\| (!this->loadexecutor_->defaultValueSet(1)) \|\| (!this->loadexecutor_->defaultValueSet(2)))
464	this->loadexecutor_->setDefaultValues(param1, param2, param3);
465	return this->portIfWaitingForDefaultValues(this->parseResult_, this->parseParams_);
466	}
467	virtual XMLPortParamContainer& defaultValues(const MultiType& param1, const MultiType& param2, const MultiType& param3, const MultiType& param4)
468	{
469	if ((!this->loadexecutor_->defaultValueSet(0)) \|\| (!this->loadexecutor_->defaultValueSet(1)) \|\| (!this->loadexecutor_->defaultValueSet(2)) \|\| (!this->loadexecutor_->defaultValueSet(3)))
470	this->loadexecutor_->setDefaultValues(param1, param2, param3, param4);
471	return this->portIfWaitingForDefaultValues(this->parseResult_, this->parseParams_);
472	}
473	virtual XMLPortParamContainer& defaultValues(const MultiType& param1, const MultiType& param2, const MultiType& param3, const MultiType& param4, const MultiType& param5)
474	{
475	if ((!this->loadexecutor_->defaultValueSet(0)) \|\| (!this->loadexecutor_->defaultValueSet(1)) \|\| (!this->loadexecutor_->defaultValueSet(2)) \|\| (!this->loadexecutor_->defaultValueSet(3)) \|\| (!this->loadexecutor_->defaultValueSet(4)))
476	this->loadexecutor_->setDefaultValues(param1, param2, param3, param4, param5);
477	return this->portIfWaitingForDefaultValues(this->parseResult_, this->parseParams_);
478	}
479
480	private:
481	ExecutorMember<T>* loadexecutor_;
482	ExecutorMember<T>* saveexecutor_;
483	ParseParams parseParams_;
484	};
485
486
487	// ################################
488	// ### XMLPortObjectContainer ###
489	// ################################
490	class _CoreExport XMLPortObjectContainer
491	{
492	public:
493	XMLPortObjectContainer()
494	{ this->bApplyLoaderMask_ = false; }
495	virtual ~XMLPortObjectContainer() {}
496
497	XMLPortObjectContainer& port(BaseObject* object, Element& xmlelement, XMLPort::Mode mode);
498
499	virtual void callLoadExecutor(BaseObject* object, BaseObject* newObject) = 0;
500
501	inline const std::string& getName() const
502	{ return this->sectionname_; }
503
504	inline XMLPortObjectContainer& description(const std::string& description)
505	{ this->description_ = description; return *this; }
506	const std::string& getDescription() const
507	{ return this->description_; }
508
509	bool identifierIsIncludedInLoaderMask(const Identifier* identifier);
510
511	protected:
512	std::string sectionname_;
513	bool bApplyLoaderMask_;
514	bool bLoadBefore_;
515	Identifier* identifier_;
516	Identifier* objectIdentifier_;
517	std::string description_;
518	};
519
520	template <class T, class O>
521	class XMLPortClassObjectContainer : public XMLPortObjectContainer
522	{
523	public:
524	XMLPortClassObjectContainer(const std::string& sectionname, Identifier* identifier, ExecutorMember<T>* loadexecutor, ExecutorMember<T>* saveexecutor, bool bApplyLoaderMask, bool bLoadBefore)
525	{
526	this->sectionname_ = sectionname;
527	this->identifier_ = identifier;
528	assert(identifier->isA(ClassIdentifier<T>::getIdentifier()));
529	this->objectIdentifier_ = ClassIdentifier<O>::getIdentifier();
530	this->loadexecutor_ = loadexecutor;
531	this->saveexecutor_ = saveexecutor;
532	this->bApplyLoaderMask_ = bApplyLoaderMask;
533	this->bLoadBefore_ = bLoadBefore;
534	}
535
536	~XMLPortClassObjectContainer()
537	{
538	assert(this->loadexecutor_);
539	delete this->loadexecutor_;
540	if (this->saveexecutor_)
541	delete this->saveexecutor_;
542	}
543
544	void callLoadExecutor(BaseObject* object, BaseObject* newObject)
545	{
546	T* castedObject = orxonox_cast<T*>(object);
547	assert(castedObject);
548	O* castedNewObject = orxonox_cast<O*>(newObject);
549	assert(castedNewObject);
550
551	(*this->loadexecutor_)(castedObject, castedNewObject);
552	}
553
554	private:
555	ExecutorMember<T>* loadexecutor_;
556	ExecutorMember<T>* saveexecutor_;
557	};
558
559
560	// ####################################
561	// ### XMLPortVariableHelperClass ###
562	// ####################################
563	/**
564	@brief
565	Helper class to load and save simple variables with XMLPort.
566
567	getLoader and getSaver were necessary to get the type T with
568	the help of template function type deduction (const T& is unused).
569	These functions return the adress of save<T> or load<T>.
570	*/
571	class XMLPortVariableHelperClass
572	{
573	public:
574	XMLPortVariableHelperClass(void* var)
575	: variable_(var)
576	{ }
577
578	template <class T>
579	void load(const T& value)
580	{ static_cast<T>(this->variable_) = value; }
581
582	template <class T>
583	const T& save()
584	{ return static_cast<T>(this->variable_); }
585
586	template <class T>
587	static void (XMLPortVariableHelperClass::*getLoader(const T& var))(const T& value)
588	{ return &XMLPortVariableHelperClass::load<T>; }
589
590	template <class T>
591	static const T& (XMLPortVariableHelperClass::*getSaver(const T& var))()
592	{ return &XMLPortVariableHelperClass::save<T>; }
593
594	private:
595	void* variable_;
596	};
597	}
598
599	#endif /* _XMLPort_H__ */

Note: See TracBrowser for help on using the repository browser.

Context Navigation

source: code/branches/consolecommands3/src/libraries/core/XMLPort.h @ 7189

Download in other formats: