Archive:Settings System - Revision history

Karellen at 20:45, 21 August 2020

2020-08-21T20:45:00Z

← Older revision		Revision as of 20:45, 21 August 2020
Line 98:		Line 98:
	TODO		TODO

	[[Category:Development]]		[[Category:Development-Archived]]

Karellen: Karellen moved page Settings System to Archive:Settings System without leaving a redirect: Outdated, incomplete content

2020-08-21T20:44:39Z

Karellen moved page Settings System to Archive:Settings System without leaving a redirect: Outdated, incomplete content

← Older revision	Revision as of 20:44, 21 August 2020
(No difference)

Ned Scott at 03:39, 14 May 2014

2014-05-14T03:39:40Z

← Older revision		Revision as of 03:39, 14 May 2014
Line 1:		Line 1:
	~~{{gotham}}~~
	With Gotham there is a new settings system in use which is more flexible, more powerful and easier extensible than the settings system used in Frodo and earlier versions.		With Gotham there is a new settings system in use which is more flexible, more powerful and easier extensible than the settings system used in Frodo and earlier versions.

NedBot: Bot: automated adding of 'enclose="div"' to syntaxhighlight

2014-03-14T06:51:45Z

Bot: automated adding of 'enclose="div"' to syntaxhighlight

← Older revision		Revision as of 06:51, 14 March 2014
Line 23:		Line 23:
	====Sections====		====Sections====
	A section is a container which can hold multiple categories. Every section has an identifier, a label and a description and is defined in a settings definition file as follows		A section is a container which can hold multiple categories. Every section has an identifier, a label and a description and is defined in a settings definition file as follows
	<syntaxhighlight lang="xml">		<syntaxhighlight lang="xml" enclose="div">
	<section id="section-identifier" label="123" description="456">		<section id="section-identifier" label="123" description="456">
	...		...
Line 31:		Line 31:
	====Categories====		====Categories====
	A category is a container within a specific section which can hold multiple groups. Every category has an identifier, a label and a description and is defined in a settings defininition file as follows		A category is a container within a specific section which can hold multiple groups. Every category has an identifier, a label and a description and is defined in a settings defininition file as follows
	<syntaxhighlight lang="xml">		<syntaxhighlight lang="xml" enclose="div">
	<section ...>		<section ...>
	<category id="category-identifier" label="123" description="456">		<category id="category-identifier" label="123" description="456">
Line 41:		Line 41:
	====Groups====		====Groups====
	A group is a container within a specific category which can hold multiple settings. Every group has an identifier and is defined in a settings definition file as follows		A group is a container within a specific category which can hold multiple settings. Every group has an identifier and is defined in a settings definition file as follows
	<syntaxhighlight lang="xml">		<syntaxhighlight lang="xml" enclose="div">
	<section ...>		<section ...>
	<category ...>		<category ...>
Line 62:		Line 62:
	=====Dynamic conditions=====		=====Dynamic conditions=====
	Dynamic conditions are static C++ methods with an identifier which are evaluated during runtime. They can be registered in the settings system using '''CSettingsManager::RegisterCondition()''' and must follow the following method signature:		Dynamic conditions are static C++ methods with an identifier which are evaluated during runtime. They can be registered in the settings system using '''CSettingsManager::RegisterCondition()''' and must follow the following method signature:
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp" enclose="div">
	static bool DynamicCondition(		static bool DynamicCondition(
	const std::string &condition,		const std::string &condition,
Line 76:		Line 76:
	====Integer option fillers====		====Integer option fillers====
	Integer option fillers can be used by integer-based settings and return a list of label-value pairs where the label is the string-representation/-description of the value and the value is an integer. The signature of an integer option filler method in C++ looks like this:		Integer option fillers can be used by integer-based settings and return a list of label-value pairs where the label is the string-representation/-description of the value and the value is an integer. The signature of an integer option filler method in C++ looks like this:
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp" enclose="div">
	static void IntegerSettingOptionFiller(		static void IntegerSettingOptionFiller(
	const CSetting *setting,		const CSetting *setting,
Line 87:		Line 87:
	====String option fillers====		====String option fillers====
	Stringoption fillers can be used by string-based settings and return a list of label-value pairs where the label is the string-representation/-description of the value and the value is a string. The signature of a string option filler method in C++ looks like this:		Stringoption fillers can be used by string-based settings and return a list of label-value pairs where the label is the string-representation/-description of the value and the value is a string. The signature of a string option filler method in C++ looks like this:
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp" enclose="div">
	static void StringSettingOptionFiller(		static void StringSettingOptionFiller(
	const CSetting *setting,		const CSetting *setting,

NedBot: Bot: Automated text replacement (-class="wikitable" +class="prettytable" & -Available Tags +Available tags & - +)

2014-03-14T06:11:05Z

Bot: Automated text replacement (-class="wikitable" +class="prettytable" & -Available Tags +Available tags & -<source +<syntaxhighlight & -</source> +</syntaxhighlight>)

← Older revision		Revision as of 06:11, 14 March 2014
Line 23:		Line 23:
	====Sections====		====Sections====
	A section is a container which can hold multiple categories. Every section has an identifier, a label and a description and is defined in a settings definition file as follows		A section is a container which can hold multiple categories. Every section has an identifier, a label and a description and is defined in a settings definition file as follows
	<~~source~~ lang="xml">		<syntaxhighlight lang="xml">
	<section id="section-identifier" label="123" description="456">		<section id="section-identifier" label="123" description="456">
	...		...
	</section>		</section>
	</~~source~~>		</syntaxhighlight>

	====Categories====		====Categories====
	A category is a container within a specific section which can hold multiple groups. Every category has an identifier, a label and a description and is defined in a settings defininition file as follows		A category is a container within a specific section which can hold multiple groups. Every category has an identifier, a label and a description and is defined in a settings defininition file as follows
	<~~source~~ lang="xml">		<syntaxhighlight lang="xml">
	<section ...>		<section ...>
	<category id="category-identifier" label="123" description="456">		<category id="category-identifier" label="123" description="456">
Line 37:		Line 37:
	</category>		</category>
	</section>		</section>
	</~~source~~>		</syntaxhighlight>

	====Groups====		====Groups====
	A group is a container within a specific category which can hold multiple settings. Every group has an identifier and is defined in a settings definition file as follows		A group is a container within a specific category which can hold multiple settings. Every group has an identifier and is defined in a settings definition file as follows
	<~~source~~ lang="xml">		<syntaxhighlight lang="xml">
	<section ...>		<section ...>
	<category ...>		<category ...>
Line 49:		Line 49:
	</category>		</category>
	</section>		</section>
	</~~source~~>		</syntaxhighlight>

	====Settings====		====Settings====
Line 62:		Line 62:
	=====Dynamic conditions=====		=====Dynamic conditions=====
	Dynamic conditions are static C++ methods with an identifier which are evaluated during runtime. They can be registered in the settings system using '''CSettingsManager::RegisterCondition()''' and must follow the following method signature:		Dynamic conditions are static C++ methods with an identifier which are evaluated during runtime. They can be registered in the settings system using '''CSettingsManager::RegisterCondition()''' and must follow the following method signature:
	<~~source~~ lang="cpp">		<syntaxhighlight lang="cpp">
	static bool DynamicCondition(		static bool DynamicCondition(
	const std::string &condition,		const std::string &condition,
Line 68:		Line 68:
	const std::string &settingId		const std::string &settingId
	);		);
	</~~source~~>		</syntaxhighlight>
	The '''condition''' parameter is the identifier of the condition (in case the same C++ method needs to handle multiple conditions). The '''value''' parameter is a value defined in the definition of the condition. The '''settingId''' parameter is the identifier of the setting which invoked the condition.		The '''condition''' parameter is the identifier of the condition (in case the same C++ method needs to handle multiple conditions). The '''value''' parameter is a value defined in the definition of the condition. The '''settingId''' parameter is the identifier of the setting which invoked the condition.

Line 76:		Line 76:
	====Integer option fillers====		====Integer option fillers====
	Integer option fillers can be used by integer-based settings and return a list of label-value pairs where the label is the string-representation/-description of the value and the value is an integer. The signature of an integer option filler method in C++ looks like this:		Integer option fillers can be used by integer-based settings and return a list of label-value pairs where the label is the string-representation/-description of the value and the value is an integer. The signature of an integer option filler method in C++ looks like this:
	<~~source~~ lang="cpp">		<syntaxhighlight lang="cpp">
	static void IntegerSettingOptionFiller(		static void IntegerSettingOptionFiller(
	const CSetting *setting,		const CSetting *setting,
Line 82:		Line 82:
	int &current		int &current
	);		);
	</~~source~~>		</syntaxhighlight>
	The '''setting''' parameter provides the CSetting object of the setting using the option filler. The '''list''' parameter needs to be filled by the option filler with the label-value pairs and the '''current''' parameter allows the option filler to specify a new value for the setting. This is necessary because with options changing during runtime it may happen that the current value of the setting is no longer a valid option and therefore the setting's value needs to be changed to a valid value.		The '''setting''' parameter provides the CSetting object of the setting using the option filler. The '''list''' parameter needs to be filled by the option filler with the label-value pairs and the '''current''' parameter allows the option filler to specify a new value for the setting. This is necessary because with options changing during runtime it may happen that the current value of the setting is no longer a valid option and therefore the setting's value needs to be changed to a valid value.

	====String option fillers====		====String option fillers====
	Stringoption fillers can be used by string-based settings and return a list of label-value pairs where the label is the string-representation/-description of the value and the value is a string. The signature of a string option filler method in C++ looks like this:		Stringoption fillers can be used by string-based settings and return a list of label-value pairs where the label is the string-representation/-description of the value and the value is a string. The signature of a string option filler method in C++ looks like this:
	<~~source~~ lang="cpp">		<syntaxhighlight lang="cpp">
	static void StringSettingOptionFiller(		static void StringSettingOptionFiller(
	const CSetting *setting,		const CSetting *setting,
Line 93:		Line 93:
	std::string &current		std::string &current
	);		);
	</~~source~~>		</syntaxhighlight>
	The '''setting''' parameter provides the CSetting object of the setting using the option filler. The '''list''' parameter needs to be filled by the option filler with the label-value pairs and the '''current''' parameter allows the option filler to specify a new value for the setting. This is necessary because with options changing during runtime it may happen that the current value of the setting is no longer a valid option and therefore the setting's value needs to be changed to a valid value.		The '''setting''' parameter provides the CSetting object of the setting using the option filler. The '''list''' parameter needs to be filled by the option filler with the label-value pairs and the '''current''' parameter allows the option filler to specify a new value for the setting. This is necessary because with options changing during runtime it may happen that the current value of the setting is no longer a valid option and therefore the setting's value needs to be changed to a valid value.

>Montellese at 11:45, 30 May 2013

2013-05-30T11:45:14Z

← Older revision		Revision as of 11:45, 30 May 2013
Line 22:		Line 22:

	====Sections====		====Sections====
	~~TODO~~		A section is a container which can hold multiple categories. Every section has an identifier, a label and a description and is defined in a settings definition file as follows
			<source lang="xml">
			<section id="section-identifier" label="123" description="456">
			...
			</section>
			</source>

	====Categories====		====Categories====
	~~TODO~~		A category is a container within a specific section which can hold multiple groups. Every category has an identifier, a label and a description and is defined in a settings defininition file as follows
			<source lang="xml">
			<section ...>
			<category id="category-identifier" label="123" description="456">
			...
			</category>
			</section>
			</source>

	====Groups====		====Groups====
	~~TODO~~		A group is a container within a specific category which can hold multiple settings. Every group has an identifier and is defined in a settings definition file as follows
			<source lang="xml">
			<section ...>
			<category ...>
			<group id="group-identifier">
			...
			</group>
			</category>
			</section>
			</source>

	====Settings====		====Settings====

Ned Scott at 11:43, 30 May 2013

2013-05-30T11:43:38Z

← Older revision		Revision as of 11:43, 30 May 2013
Line 1:		Line 1:
			{{gotham}}
	With Gotham there is a new settings system in use which is more flexible, more powerful and easier extensible than the settings system used in Frodo and earlier versions.		With Gotham there is a new settings system in use which is more flexible, more powerful and easier extensible than the settings system used in Frodo and earlier versions.

Line 76:		Line 77:
	==GUI integration==		==GUI integration==
	TODO		TODO

			[[Category:Development]]

>Montellese: Created page with "With Gotham there is a new settings system in use which is more flexible, more powerful and easier extensible than the settings system used in Frodo and earlier versions. ==Desi..."

2013-05-30T11:25:58Z

Created page with "With Gotham there is a new settings system in use which is more flexible, more powerful and easier extensible than the settings system used in Frodo and earlier versions. ==Desi..."

New page

With Gotham there is a new settings system in use which is more flexible, more powerful and easier extensible than the settings system used in Frodo and earlier versions.

==Design==
===Organisation===
The settings system is organized in '''sections''', '''categories''', '''groups''' and finally '''settings'''. Sections, categories and groups are simply containers with an identifier, a label and a description.
TODO

===Setting types===
TODO

====Custom types====

TODO

==Initialization==
TODO

===Settings definitions===
The settings system needs to be initialized with settings definition files in XML format. It is possible to use multiple settings definition files to initialize the settings system and it supports adding new settings in any of the settings definition files and overwriting setting properties specified in a previously loaded settings definition file.

====Sections====
TODO

====Categories====
TODO

====Groups====
TODO

====Settings====
TODO

===Conditions===
Conditions are checks which are defined in C++ and can be used in the XML definition of visibility, dependency et al. of categories, groups and/or settings to change their behaviour depending on certain circumstances. While in the settings definition all conditions are used the same, in C++ there is a difference between static and dynamic conditions.

=====Static conditions=====
Static conditions simply consist of an identifier. They are either registered in the settings system using'''CSettingsManager::RegisterCondition()''' or they aren't. Being registered means that the condition is met (i.e. it evaluates to '''true'''), not being registered means that the condition is not met (i.e. it evaluates to '''false''').

=====Dynamic conditions=====
Dynamic conditions are static C++ methods with an identifier which are evaluated during runtime. They can be registered in the settings system using '''CSettingsManager::RegisterCondition()''' and must follow the following method signature:
<source lang="cpp">
static bool DynamicCondition(
const std::string &condition,
const std::string &value,
const std::string &settingId
);
</source>
The '''condition''' parameter is the identifier of the condition (in case the same C++ method needs to handle multiple conditions). The '''value''' parameter is a value defined in the definition of the condition. The '''settingId''' parameter is the identifier of the setting which invoked the condition.

===Option fillers===
Option fillers are static C++ methods with an identifier which can be used by settings to define their possible values based on runtime conditions. They can be registered in the settings system using'''CSettingsManager::RegisterSettingOptionsFiller()'''.

====Integer option fillers====
Integer option fillers can be used by integer-based settings and return a list of label-value pairs where the label is the string-representation/-description of the value and the value is an integer. The signature of an integer option filler method in C++ looks like this:
<source lang="cpp">
static void IntegerSettingOptionFiller(
const CSetting *setting,
std::vector< std::pair<std::string, int> > &list,
int &current
);
</source>
The '''setting''' parameter provides the CSetting object of the setting using the option filler. The '''list''' parameter needs to be filled by the option filler with the label-value pairs and the '''current''' parameter allows the option filler to specify a new value for the setting. This is necessary because with options changing during runtime it may happen that the current value of the setting is no longer a valid option and therefore the setting's value needs to be changed to a valid value.

====String option fillers====
Stringoption fillers can be used by string-based settings and return a list of label-value pairs where the label is the string-representation/-description of the value and the value is a string. The signature of a string option filler method in C++ looks like this:
<source lang="cpp">
static void StringSettingOptionFiller(
const CSetting *setting,
std::vector< std::pair<std::string, std::string> > &list,
std::string &current
);
</source>
The '''setting''' parameter provides the CSetting object of the setting using the option filler. The '''list''' parameter needs to be filled by the option filler with the label-value pairs and the '''current''' parameter allows the option filler to specify a new value for the setting. This is necessary because with options changing during runtime it may happen that the current value of the setting is no longer a valid option and therefore the setting's value needs to be changed to a valid value.

==GUI integration==
TODO