DarkRadiant XMLRegistry - Revision history

Tels: categorize

2007-11-11T23:15:07Z

categorize

← Older revision		Revision as of 23:15, 11 November 2007
Line 56:		Line 56:
	The libxml2 library is capable of interpreting the XPath syntax (see [http://www.w3schools.com/xpath/xpath_syntax.asp reference]). Use the '''findXPath()''' and '''deleteXPath()''' methods to retrieve (or delete) certain paths. The findXPath() method returns an '''xml::Node''' structure which in turn provides some methods for adding children, getting attribute values and so on.		The libxml2 library is capable of interpreting the XPath syntax (see [http://www.w3schools.com/xpath/xpath_syntax.asp reference]). Use the '''findXPath()''' and '''deleteXPath()''' methods to retrieve (or delete) certain paths. The findXPath() method returns an '''xml::Node''' structure which in turn provides some methods for adding children, getting attribute values and so on.

	~~[[Category:Coding]]~~		{{darkradiant-internal\|sort=XMLRegistry}}
	~~[[Category:DarkRadiant]]~~

Greebo: /* The internal XML tree */

2007-07-05T16:53:01Z

The internal XML tree

← Older revision		Revision as of 16:53, 5 July 2007
Line 36:		Line 36:
	You of course ''can'' access the keys with absolute xpaths (/darkradiant/user/ui/showAllLightVolumes for example), but this is not recommended, as the toplevel node is maintained by the registry module only.		You of course ''can'' access the keys with absolute xpaths (/darkradiant/user/ui/showAllLightVolumes for example), but this is not recommended, as the toplevel node is maintained by the registry module only.

	Internally, the registry consists of two large subtrees under <darkradiant> and looks like ~~this:~~		Internally, the registry consists of two large subtrees under <darkradiant> and looks like the scetch below. The '''<user>''' part of the Registry is imported from the file user.xml and the '''<game>''' tree is imported from the '''doom3.game''' file in the installation folder.
	<darkradiant>		<darkradiant>
	<user>		<user>

Greebo: categorised

2007-05-12T14:08:50Z

categorised

← Older revision		Revision as of 14:08, 12 May 2007
Line 55:		Line 55:
	== XPath Lookups ==		== XPath Lookups ==
	The libxml2 library is capable of interpreting the XPath syntax (see [http://www.w3schools.com/xpath/xpath_syntax.asp reference]). Use the '''findXPath()''' and '''deleteXPath()''' methods to retrieve (or delete) certain paths. The findXPath() method returns an '''xml::Node''' structure which in turn provides some methods for adding children, getting attribute values and so on.		The libxml2 library is capable of interpreting the XPath syntax (see [http://www.w3schools.com/xpath/xpath_syntax.asp reference]). Use the '''findXPath()''' and '''deleteXPath()''' methods to retrieve (or delete) certain paths. The findXPath() method returns an '''xml::Node''' structure which in turn provides some methods for adding children, getting attribute values and so on.

			[[Category:Coding]]
			[[Category:DarkRadiant]]

Greebo: fixed a typo

2007-01-19T22:11:07Z

fixed a typo

← Older revision		Revision as of 22:11, 19 January 2007
Line 24:		Line 24:
	<user>		<user>
	<ui>		<ui>
	<~~showAllLightRadii~~ value="1" /> <!-- This value is accessed by user/ui/showAllLightVolumes -->		<showAllLightVolumes value="1" /> <!-- This value is accessed by user/ui/showAllLightVolumes -->
	</ui>		</ui>
	</user>		</user>
	Be sure to always '''omit''' the leading slash, so '''don't use''' /user/ui/... (see below).		Be sure to always '''omit''' the leading slash, so '''don't use''' /user/ui/... (see below).

	== The internal XML tree ==		== The internal XML tree ==

Greebo: fixed a typo

2007-01-19T22:10:36Z

fixed a typo

← Older revision		Revision as of 22:10, 19 January 2007
Line 32:		Line 32:
	As a valid XML document consists of exactly one global parent node, the toplevel node is called '''<darkradiant>'''. However, you don't have to specify this toplevel node, as it is added automatically by the XMLRegistry.		As a valid XML document consists of exactly one global parent node, the toplevel node is called '''<darkradiant>'''. However, you don't have to specify this toplevel node, as it is added automatically by the XMLRegistry.

	So, the key '''user/ui/showAllLightVolumes''' is automatically recognised as relative path and becomes '''/darkradiant/user/ui/~~showAllLightRadii~~''' before being passed to the libxml functions.		So, the key '''user/ui/showAllLightVolumes''' is automatically recognised as relative path and becomes '''/darkradiant/user/ui/showAllLightVolumes''' before being passed to the libxml functions.

	You of course ''can'' access the keys with absolute xpaths (/darkradiant/user/ui/~~showAllLightRadii~~ for example), but this is not recommended, as the toplevel node is maintained by the registry module only.		You of course ''can'' access the keys with absolute xpaths (/darkradiant/user/ui/showAllLightVolumes for example), but this is not recommended, as the toplevel node is maintained by the registry module only.

	Internally, the registry consists of two large subtrees under <darkradiant> and looks like this:		Internally, the registry consists of two large subtrees under <darkradiant> and looks like this:

Greebo: /* XPath Syntax */

2007-01-13T14:25:31Z

XPath Syntax

← Older revision		Revision as of 14:25, 13 January 2007
Line 53:		Line 53:
	This is practiced with the user.xml files: all the default preferences are defined in the install/user.xml file which is imported '''first'''. Then DarkRadiant searches for another user.xml copy in the user's settings folder (i.e. "C:\Documents and Settings\bla\Application Data\DarkRadiant\user.xml") and imports its contents, if the file is found. The data is inserted above the other methods, hence the search for a specific key (say "user/ui/showAllLightRadii") will point to the nodes that were imported last. (Hope this is clear, otherwise ask greebo).		This is practiced with the user.xml files: all the default preferences are defined in the install/user.xml file which is imported '''first'''. Then DarkRadiant searches for another user.xml copy in the user's settings folder (i.e. "C:\Documents and Settings\bla\Application Data\DarkRadiant\user.xml") and imports its contents, if the file is found. The data is inserted above the other methods, hence the search for a specific key (say "user/ui/showAllLightRadii") will point to the nodes that were imported last. (Hope this is clear, otherwise ask greebo).

	== XPath ~~Syntax~~ ==		== XPath Lookups ==
	The libxml2 library is capable of interpreting the XPath syntax (see [http://www.w3schools.com/xpath/xpath_syntax.asp reference]). Use the '''findXPath()''' and '''deleteXPath()''' methods to retrieve (or delete) certain paths. The findXPath() method returns an xml::Node structure which in turn provides some methods for adding children, getting attribute values and so on.		The libxml2 library is capable of interpreting the XPath syntax (see [http://www.w3schools.com/xpath/xpath_syntax.asp reference]). Use the '''findXPath()''' and '''deleteXPath()''' methods to retrieve (or delete) certain paths. The findXPath() method returns an '''xml::Node''' structure which in turn provides some methods for adding children, getting attribute values and so on.

Greebo: /* The internal XML tree */

2007-01-13T14:24:59Z

The internal XML tree

← Older revision		Revision as of 14:24, 13 January 2007
Line 39:		Line 39:
	<darkradiant>		<darkradiant>
	<user>		<user>
	<!-- User preferences go here -->		-- User preferences go here --
	</user>		</user>
	<game>		<game>
	<!-- Game-specific settings (entity key definitions, etc.) go here -->		-- Game-specific settings (entity key definitions, etc.) go here --
	</game>		</game>
	</darkradiant>		</darkradiant>

Greebo at 14:23, 13 January 2007

2007-01-13T14:23:47Z

← Older revision		Revision as of 14:23, 13 January 2007
Line 21:		Line 21:
	The following is an example of a valid key:		The following is an example of a valid key:
	user/ui/showAllLightVolumes		user/ui/showAllLightVolumes
	and refers to this ~~internal~~ node:		and refers to this node:
	<user>		<user>
	<ui>		<ui>
Line 35:		Line 35:

	You of course ''can'' access the keys with absolute xpaths (/darkradiant/user/ui/showAllLightRadii for example), but this is not recommended, as the toplevel node is maintained by the registry module only.		You of course ''can'' access the keys with absolute xpaths (/darkradiant/user/ui/showAllLightRadii for example), but this is not recommended, as the toplevel node is maintained by the registry module only.

			Internally, the registry consists of two large subtrees under <darkradiant> and looks like this:
			<darkradiant>
			<user>
			<!-- User preferences go here -->
			</user>
			<game>
			<!-- Game-specific settings (entity key definitions, etc.) go here -->
			</game>
			</darkradiant>

			== Importing XML files into the Registry ==
			Use the import methods to load a whole file into the registry. You can specify a path, which the content is appended to, but you don't have. By default, the file content is directly inserted as new child of <darkradiant>.

			Important note: New files are automatically inserted '''above all existing nodes''' in the registry. This is wanted behaviour, because this way it's possible to load all the default values into the XML tree that can be overridden by afterwardly imported nodes of the same name.

			This is practiced with the user.xml files: all the default preferences are defined in the install/user.xml file which is imported '''first'''. Then DarkRadiant searches for another user.xml copy in the user's settings folder (i.e. "C:\Documents and Settings\bla\Application Data\DarkRadiant\user.xml") and imports its contents, if the file is found. The data is inserted above the other methods, hence the search for a specific key (say "user/ui/showAllLightRadii") will point to the nodes that were imported last. (Hope this is clear, otherwise ask greebo).

	== XPath Syntax ==		== XPath Syntax ==
	The libxml2 library is capable of interpreting the XPath syntax (see [http://www.w3schools.com/xpath/xpath_syntax.asp reference]). Use the '''findXPath()''' and '''deleteXPath()''' methods to retrieve (or delete) certain paths. The findXPath() method returns an xml::Node structure which in turn provides some methods for adding children, getting attribute values and so on.		The libxml2 library is capable of interpreting the XPath syntax (see [http://www.w3schools.com/xpath/xpath_syntax.asp reference]). Use the '''findXPath()''' and '''deleteXPath()''' methods to retrieve (or delete) certain paths. The findXPath() method returns an xml::Node structure which in turn provides some methods for adding children, getting attribute values and so on.

Greebo at 14:13, 13 January 2007

2007-01-13T14:13:02Z

← Older revision		Revision as of 14:13, 13 January 2007
Line 27:		Line 27:
	</ui>		</ui>
	</user>		</user>
			Be sure to always '''omit''' the leading slash, so '''don't use''' /user/ui/... (see below).

	== The internal XML tree ==		== The internal XML tree ==
			As a valid XML document consists of exactly one global parent node, the toplevel node is called '''<darkradiant>'''. However, you don't have to specify this toplevel node, as it is added automatically by the XMLRegistry.

			So, the key '''user/ui/showAllLightVolumes''' is automatically recognised as relative path and becomes '''/darkradiant/user/ui/showAllLightRadii''' before being passed to the libxml functions.

			You of course ''can'' access the keys with absolute xpaths (/darkradiant/user/ui/showAllLightRadii for example), but this is not recommended, as the toplevel node is maintained by the registry module only.

	== XPath Syntax ==		== XPath Syntax ==
	The libxml2 library is capable of interpreting the XPath syntax (see [http://www.w3schools.com/xpath/xpath_syntax.asp reference]). Use the '''findXPath()''' and '''deleteXPath()''' methods to retrieve (or delete) certain paths. The findXPath() method returns an xml::Node structure which in turn provides some methods for adding children, getting attribute values and so on.		The libxml2 library is capable of interpreting the XPath syntax (see [http://www.w3schools.com/xpath/xpath_syntax.asp reference]). Use the '''findXPath()''' and '''deleteXPath()''' methods to retrieve (or delete) certain paths. The findXPath() method returns an xml::Node structure which in turn provides some methods for adding children, getting attribute values and so on.

Greebo at 14:08, 13 January 2007

2007-01-13T14:08:12Z

← Older revision		Revision as of 14:08, 13 January 2007
Line 2:		Line 2:

	== Accessing the Registry ==		== Accessing the Registry ==
	The XMLRegistry plugin (interface defined in iregistry.h) implements some convenient methods to retrieve and save values into the keys. Use the GlobalRegistry() method to retrieve a reference to the XMLRegistry instance.		The XMLRegistry plugin (interface defined in iregistry.h) implements some convenient methods to retrieve and save values into the keys. Use the '''GlobalRegistry()''' method to retrieve a reference to the XMLRegistry instance.

	GlobalRegistry().get(<key>) // returns a string		GlobalRegistry().get(<key>) // returns a string
Line 8:		Line 8:
	GlobalRegistry().getInt(<key>) // returns an int		GlobalRegistry().getInt(<key>) // returns an int

	The above methods try to ~~retrieve~~ the value from the registry and convert them via boost::lexical_cast, if required. If the key is not found in the specified place, an empty value is returned as default ("" or 0.0 or 0).		The above methods try to load the value from the registry and convert them via boost::lexical_cast, if required. If the key is not found in the specified place, an empty value is returned as default ("" or 0.0 or 0).

	To save values into the registry, the set methods form the counterparts to the above functions:		To '''save''' values into the registry, the set methods form the counterparts to the above functions:

	GlobalRegistry().set(<key>, <value>) // save the string into <key>		GlobalRegistry().set(<key>, <value>) // save the string into <key>
	GlobalRegistry().setFloat(<key>, <value>) // save the floating point value to <key>		GlobalRegistry().setFloat(<key>, <value>) // save the floating point value to <key>
	GlobalRegistry().setInt(<key>, <value>) // save the integer value to <key>		GlobalRegistry().setInt(<key>, <value>) // save the integer value to <key>

			If the specified key does not exist, it is created and all non-existing parent nodes are created recursively as well. So you don't have to create your key before you save a value into it.

	== Keys ==		== Keys ==
			The following is an example of a valid key:
			user/ui/showAllLightVolumes
			and refers to this internal node:
			<user>
			<ui>
			<showAllLightRadii value="1" /> <!-- This value is accessed by user/ui/showAllLightVolumes -->
			</ui>
			</user>

			== The internal XML tree ==

	== XPath Syntax ==		== XPath Syntax ==
	The libxml2 library is capable of interpreting the XPath syntax (see [http://www.w3schools.com/xpath/xpath_syntax.asp reference]). Use the '''findXPath()''' and '''deleteXPath()''' methods to retrieve (or delete) certain paths. The findXPath() method returns an xml::Node structure which in turn provides some methods for adding children, getting attribute values and so on.		The libxml2 library is capable of interpreting the XPath syntax (see [http://www.w3schools.com/xpath/xpath_syntax.asp reference]). Use the '''findXPath()''' and '''deleteXPath()''' methods to retrieve (or delete) certain paths. The findXPath() method returns an xml::Node structure which in turn provides some methods for adding children, getting attribute values and so on.