upstream/wesnoth
1
0
Fork 0
mirror of https://github.com/wesnoth/wesnoth synced 2025-05-06 05:57:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactoring the settings code, first step.

Browse Source
This commit is contained in:
Mark de Wever 2008-04-17 19:38:10 +00:00
parent b42fe743c2
commit 363051dd3c
6 changed files with 102 additions and 252 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/gui/widgets/button.cpp
View File

@ -129,7 +129,7 @@ void tbutton::set_state(tstate state)
void tbutton::load_config() void tbutton::load_config()
{ {
if(!config()) { if(!config()) {
set_config(get_button(definition())); set_config(get_control("button", definition()));
assert(canvas().size() == config()->state.size()); assert(canvas().size() == config()->state.size());
for(size_t i = 0; i < canvas().size(); ++i) { for(size_t i = 0; i < canvas().size(); ++i) {

2
src/gui/widgets/label.cpp
View File

@ -50,7 +50,7 @@ void tlabel::set_state(tstate state)
void tlabel::load_config() void tlabel::load_config()
{ {
if(!config()) { if(!config()) {
set_config(get_label(definition())); set_config(get_control("label", definition()));
assert(canvas().size() == config()->state.size()); assert(canvas().size() == config()->state.size());
for(size_t i = 0; i < canvas().size(); ++i) { for(size_t i = 0; i < canvas().size(); ++i) {

265
src/gui/widgets/settings.cpp
View File

@ -17,7 +17,6 @@
#include "gui/widgets/settings.hpp" #include "gui/widgets/settings.hpp"
#include "config.hpp"
#include "filesystem.hpp" #include "filesystem.hpp"
#include "gettext.hpp" #include "gettext.hpp"
#include "gui/widgets/button.hpp" #include "gui/widgets/button.hpp"
@ -73,7 +72,6 @@ namespace {
//! Vector with all known windows, these are validated on existance on startup. //! Vector with all known windows, these are validated on existance on startup.
//! The enum twindow_type is the index of the array. //! The enum twindow_type is the index of the array.
std::vector<std::string> window_type_list(DUMMY); std::vector<std::string> window_type_list(DUMMY);
} // namespace } // namespace
static void fill_window_types() static void fill_window_types()
@ -157,53 +155,11 @@ const std::string& tgui_definition::read(const config& cfg)
VALIDATE(windows.find("default") != windows.end(), _ ("No default window defined.")); VALIDATE(windows.find("default") != windows.end(), _ ("No default window defined."));
/***** Button definitions *****/ /***** Control definitions *****/
const config::child_list& button_cfgs = cfg.get_children("button_definition"); load_definitions<tbutton_definition>("button", cfg.get_children("button_definition"));
for(std::vector<config*>::const_iterator itor = button_cfgs.begin(); load_definitions<tlabel_definition>("label", cfg.get_children("label_definition"));
itor != button_cfgs.end(); ++itor) { load_definitions<ttext_box_definition>("text_box", cfg.get_children("text_box_definition"));
load_definitions<ttooltip_definition>("tooltip", cfg.get_children("tooltip_definition"));
std::pair<std::string, tbutton_definition> child;
child.first = child.second.read(**itor);
buttons.insert(child);
}
VALIDATE(buttons.find("default") != buttons.end(), _ ("No default button defined."));
/***** Label definitions *****/
const config::child_list& label_cfgs = cfg.get_children("label_definition");
for(std::vector<config*>::const_iterator itor = label_cfgs.begin();
itor != label_cfgs.end(); ++itor) {
std::pair<std::string, tlabel_definition> child;
child.first = child.second.read(**itor);
labels.insert(child);
}
VALIDATE(labels.find("default") != labels.end(), _ ("No default label defined."));
/***** Text box definitions *****/
const config::child_list& text_box_cfg = cfg.get_children("text_box_definition");
for(std::vector<config*>::const_iterator itor = text_box_cfg.begin();
itor != text_box_cfg.end(); ++itor) {
std::pair<std::string, ttext_box_definition> child;
child.first = child.second.read(**itor);
text_boxs.insert(child);
}
VALIDATE(text_boxs.find("default") != text_boxs.end(), _ ("No default text box defined."));
/***** Tooltip definitions *****/
const config::child_list& tooltip_cfg = cfg.get_children("tooltip_definition");
for(std::vector<config*>::const_iterator itor = tooltip_cfg.begin();
itor != tooltip_cfg.end(); ++itor) {
std::pair<std::string, ttooltip_definition> child;
child.first = child.second.read(**itor);
tooltips.insert(child);
}
VALIDATE(tooltips.find("default") != tooltips.end(), _ ("No default tooltip defined."));
/***** Window types *****/ /***** Window types *****/
const config::child_list& window_instance_cfgs = cfg.get_children("window"); const config::child_list& window_instance_cfgs = cfg.get_children("window");
@ -228,25 +184,48 @@ const std::string& tgui_definition::read(const config& cfg)
return id; return id;
} }
const std::string& tbutton_definition::read(const config& cfg) template<class T>
void tgui_definition::load_definitions(const std::string& definition_type, const config::child_list& definition_list)
{
for(std::vector<config*>::const_iterator itor = definition_list.begin();
itor != definition_list.end(); ++itor) {
T* def = new T(**itor);
control_definition[definition_type].insert(std::make_pair(def->id, def));
}
// FIXME use proper control name
VALIDATE(control_definition[definition_type].find("default") != control_definition[definition_type].end(), _ ("No default button defined."));
}
tcontrol_definition::tcontrol_definition(const config& cfg) :
id(cfg["id"]),
description(cfg["description"]),
resolutions()
{ {
/*WIKI /*WIKI
* [button_definition] * The general defintion of a control.
* The definition of a normal push button.
* *
* id = (string = "") Unique id for this gui (theme). * id = (string = "") Unique id for this gui (theme).
* description = (t_string = "") Unique translatable name for this gui. * description = (t_string = "") Unique translatable name for this gui.
* *
* [resolution] The definitions of the button in various * [resolution] The definitions of the button in various
* resolutions. * resolutions.
* [/button_definition]
*/ */
id = cfg["id"];
description = cfg["description"];
VALIDATE(!id.empty(), missing_mandatory_wml_key("gui", "id")); VALIDATE(!id.empty(), missing_mandatory_wml_key("gui", "id"));
VALIDATE(!description.empty(), missing_mandatory_wml_key("gui", "description")); VALIDATE(!description.empty(), missing_mandatory_wml_key("gui", "description"));
}
tbutton_definition::tbutton_definition(const config& cfg) :
tcontrol_definition(cfg)
{
/*WIKI
* The definition of a normal push button.
* See control_definition.
*/
DBG_G_P << "Parsing button " << id << '\n'; DBG_G_P << "Parsing button " << id << '\n';
const config::child_list& cfgs = cfg.get_children("resolution"); const config::child_list& cfgs = cfg.get_children("resolution");
@ -256,8 +235,6 @@ const std::string& tbutton_definition::read(const config& cfg)
resolutions.push_back(new tresolution(**itor)); resolutions.push_back(new tresolution(**itor));
} }
return id;
} }
void tbutton_definition::tresolution::read_extra(const config& cfg) void tbutton_definition::tresolution::read_extra(const config& cfg)
@ -279,24 +256,13 @@ void tbutton_definition::tresolution::read_extra(const config& cfg)
state.push_back(tstate_definition(cfg.child("state_focussed"))); state.push_back(tstate_definition(cfg.child("state_focussed")));
} }
const std::string& tlabel_definition::read(const config& cfg) tlabel_definition::tlabel_definition(const config& cfg) :
tcontrol_definition(cfg)
{ {
/*WIKI /*WIKI
* [label_definition] * The definition of a normal label.
* The definition of a normal push label. * See control_definition.
*
* id = (string = "") Unique id for this gui (theme).
* description = (t_string = "") Unique translatable name for this gui.
*
* [resolution] The definitions of the label in various
* resolutions.
* [/label_definition]
*/ */
id = cfg["id"];
description = cfg["description"];
VALIDATE(!id.empty(), missing_mandatory_wml_key("gui", "id"));
VALIDATE(!description.empty(), missing_mandatory_wml_key("gui", "description"));
DBG_G_P << "Parsing label " << id << '\n'; DBG_G_P << "Parsing label " << id << '\n';
@ -307,8 +273,6 @@ const std::string& tlabel_definition::read(const config& cfg)
resolutions.push_back(new tresolution(**itor)); resolutions.push_back(new tresolution(**itor));
} }
return id;
} }
tstate_definition::tstate_definition(const config* cfg) : tstate_definition::tstate_definition(const config* cfg) :
@ -412,24 +376,13 @@ void tlabel_definition::tresolution::read_extra(const config& cfg)
state.push_back(tstate_definition(cfg.child("state_disabled"))); state.push_back(tstate_definition(cfg.child("state_disabled")));
} }
const std::string& ttext_box_definition::read(const config& cfg) ttext_box_definition::ttext_box_definition(const config& cfg) :
tcontrol_definition(cfg)
{ {
/*WIKI /*WIKI
* [text_box_definition]
* The definition of a normal text box. * The definition of a normal text box.
* * See control_definition.
* id = (string = "") Unique id for this gui (theme).
* description = (t_string = "") Unique translatable name for this gui.
*
* [resolution] The definitions of the text_box in various
* resolutions.
* [/text_box_definition]
*/ */
id = cfg["id"];
description = cfg["description"];
VALIDATE(!id.empty(), missing_mandatory_wml_key("gui", "id"));
VALIDATE(!description.empty(), missing_mandatory_wml_key("gui", "description"));
DBG_G_P << "Parsing text_box " << id << '\n'; DBG_G_P << "Parsing text_box " << id << '\n';
@ -440,8 +393,6 @@ const std::string& ttext_box_definition::read(const config& cfg)
resolutions.push_back(new tresolution(**itor)); resolutions.push_back(new tresolution(**itor));
} }
return id;
} }
void ttext_box_definition::tresolution::read_extra(const config& cfg) void ttext_box_definition::tresolution::read_extra(const config& cfg)
@ -461,24 +412,13 @@ void ttext_box_definition::tresolution::read_extra(const config& cfg)
state.push_back(tstate_definition(cfg.child("state_focussed"))); state.push_back(tstate_definition(cfg.child("state_focussed")));
} }
const std::string& ttooltip_definition::read(const config& cfg) ttooltip_definition::ttooltip_definition(const config& cfg) :
tcontrol_definition(cfg)
{ {
/*WIKI /*WIKI
* [tooltip_definition] * The definition of a tooltip.
* The definition of a tooltip box. * See control_definition.
*
* id = (string = "") Unique id for this gui (theme).
* description = (t_string = "") Unique translatable name for this gui.
*
* [resolution] The definitions of the tooltip in various
* resolutions.
* [/tooltip_definition]
*/ */
id = cfg["id"];
description = cfg["description"];
VALIDATE(!id.empty(), missing_mandatory_wml_key("gui", "id"));
VALIDATE(!description.empty(), missing_mandatory_wml_key("gui", "description"));
DBG_G_P << "Parsing tooltip " << id << '\n'; DBG_G_P << "Parsing tooltip " << id << '\n';
@ -489,8 +429,6 @@ const std::string& ttooltip_definition::read(const config& cfg)
resolutions.push_back(new tresolution(**itor)); resolutions.push_back(new tresolution(**itor));
} }
return id;
} }
void ttooltip_definition::tresolution::read_extra(const config& cfg) void ttooltip_definition::tresolution::read_extra(const config& cfg)
@ -585,111 +523,26 @@ twindow_definition::tresolution::tlayer::tlayer(const config* cfg) :
canvas.set_cfg(*draw); canvas.set_cfg(*draw);
} }
tresolution_definition_* get_button(const std::string& definition) tresolution_definition_* get_control(const std::string& control_type, const std::string& definition)
{ {
std::map<std::string, tbutton_definition>::const_iterator const tgui_definition::tcontrol_definition_map::const_iterator
button = current_gui->second.buttons.find(definition); control_definition = current_gui->second.control_definition.find(control_type);
if(button == current_gui->second.buttons.end()) { assert(control_definition != current_gui->second.control_definition.end());
LOG_G << "Button: definition '"
std::map<std::string, tcontrol_definition*>::const_iterator
control = control_definition->second.find(definition);
if(control == control_definition->second.end()) {
LOG_G << "Control: type '" << control_type << "' definition '"
<< definition << "' not found, falling back to 'default'.\n"; << definition << "' not found, falling back to 'default'.\n";
button = current_gui->second.buttons.find("default"); control = control_definition->second.find("default");
assert(button != current_gui->second.buttons.end()); assert(control != control_definition->second.end());
} }
for(std::vector<tresolution_definition_*>::const_iterator for(std::vector<tresolution_definition_*>::const_iterator
itor = button->second.resolutions.begin(), itor = (*control->second).resolutions.begin(),
end = button->second.resolutions.end(); end = (*control->second).resolutions.end();
itor != end;
++itor) {
if(screen_width <= (**itor).window_width &&
screen_height <= (**itor).window_height) {
return *itor;
} else if (itor == end - 1) {
return *itor;
}
}
assert(false);
}
tresolution_definition_* get_label(const std::string& definition)
{
std::map<std::string, tlabel_definition>::const_iterator
label = current_gui->second.labels.find(definition);
if(label == current_gui->second.labels.end()) {
LOG_G << "Label: definition '"
<< definition << "' not found, falling back to 'default'.\n";
label = current_gui->second.labels.find("default");
assert(label != current_gui->second.labels.end());
}
for(std::vector<tresolution_definition_*>::const_iterator
itor = label->second.resolutions.begin(),
end = label->second.resolutions.end();
itor != end;
++itor) {
if(screen_width <= (**itor).window_width &&
screen_height <= (**itor).window_height) {
return *itor;
} else if (itor == end - 1) {
return *itor;
}
}
assert(false);
}
tresolution_definition_* get_text_box(const std::string& definition)
{
std::map<std::string, ttext_box_definition>::const_iterator
text_box = current_gui->second.text_boxs.find(definition);
if(text_box == current_gui->second.text_boxs.end()) {
LOG_G << "Text_box: definition '"
<< definition << "' not found, falling back to 'default'.\n";
text_box = current_gui->second.text_boxs.find("default");
assert(text_box != current_gui->second.text_boxs.end());
}
for(std::vector<tresolution_definition_*>::const_iterator
itor = text_box->second.resolutions.begin(),
end = text_box->second.resolutions.end();
itor != end;
++itor) {
if(screen_width <= (**itor).window_width &&
screen_height <= (**itor).window_height) {
return *itor;
} else if (itor == end - 1) {
return *itor;
}
}
assert(false);
}
tresolution_definition_* get_tooltip(const std::string& definition)
{
std::map<std::string, ttooltip_definition>::const_iterator
tooltip = current_gui->second.tooltips.find(definition);
if(tooltip == current_gui->second.tooltips.end()) {
LOG_G << "Tooltip: definition '"
<< definition << "' not found, falling back to 'default'.\n";
tooltip = current_gui->second.tooltips.find("default");
assert(tooltip != current_gui->second.tooltips.end());
}
for(std::vector<tresolution_definition_*>::const_iterator
itor = tooltip->second.resolutions.begin(),
end = tooltip->second.resolutions.end();
itor != end; itor != end;
++itor) { ++itor) {

81
src/gui/widgets/settings.hpp
View File

@ -18,6 +18,7 @@
#ifndef __GUI_WIDGETS_SETTING_HPP_INCLUDED__ #ifndef __GUI_WIDGETS_SETTING_HPP_INCLUDED__
#define __GUI_WIDGETS_SETTING_HPP_INCLUDED__ #define __GUI_WIDGETS_SETTING_HPP_INCLUDED__
#include "config.hpp"
#include "gui/widgets/canvas.hpp" #include "gui/widgets/canvas.hpp"
#include "gui/widgets/window_builder.hpp" #include "gui/widgets/window_builder.hpp"
#include "tstring.hpp" #include "tstring.hpp"
@ -26,9 +27,6 @@
#include <string> #include <string>
#include <vector> #include <vector>
class config;
namespace gui2 { namespace gui2 {
enum twindow_type { enum twindow_type {
@ -56,6 +54,7 @@ public:
tcanvas canvas; tcanvas canvas;
}; };
//! Base class of a resolution, contains the common keys for a resolution. //! Base class of a resolution, contains the common keys for a resolution.
struct tresolution_definition_ : public reference_counted_object struct tresolution_definition_ : public reference_counted_object
{ {
@ -89,34 +88,24 @@ private:
virtual void read_extra(const config& cfg) = 0; virtual void read_extra(const config& cfg) = 0;
}; };
struct tbutton_definition struct tcontrol_definition : public reference_counted_object
{ {
private:
tcontrol_definition();
public:
tcontrol_definition(const config& cfg);
std::string id; std::string id;
t_string description; t_string description;
const std::string& read(const config& cfg);
struct tresolution : public tresolution_definition_
{
tresolution(const config& cfg) :
tresolution_definition_(cfg)
{ read_extra(cfg); }
private:
void read_extra(const config& cfg);
};
std::vector<tresolution_definition_*> resolutions; std::vector<tresolution_definition_*> resolutions;
}; };
struct tlabel_definition struct tbutton_definition : public tcontrol_definition
{ {
tbutton_definition(const config& cfg);
std::string id;
t_string description;
const std::string& read(const config& cfg);
struct tresolution : public tresolution_definition_ struct tresolution : public tresolution_definition_
{ {
@ -128,15 +117,12 @@ struct tlabel_definition
void read_extra(const config& cfg); void read_extra(const config& cfg);
}; };
std::vector<tresolution_definition_*> resolutions;
}; };
struct ttext_box_definition struct tlabel_definition : public tcontrol_definition
{ {
std::string id;
t_string description;
const std::string& read(const config& cfg); tlabel_definition(const config& cfg);
struct tresolution : public tresolution_definition_ struct tresolution : public tresolution_definition_
{ {
@ -147,16 +133,12 @@ struct ttext_box_definition
private: private:
void read_extra(const config& cfg); void read_extra(const config& cfg);
}; };
std::vector<tresolution_definition_*> resolutions;
}; };
struct ttooltip_definition struct ttext_box_definition : public tcontrol_definition
{ {
std::string id;
t_string description;
const std::string& read(const config& cfg); ttext_box_definition(const config& cfg);
struct tresolution : public tresolution_definition_ struct tresolution : public tresolution_definition_
{ {
@ -168,7 +150,21 @@ struct ttooltip_definition
void read_extra(const config& cfg); void read_extra(const config& cfg);
}; };
std::vector<tresolution_definition_*> resolutions; };
struct ttooltip_definition : public tcontrol_definition
{
ttooltip_definition(const config& cfg);
struct tresolution : public tresolution_definition_
{
tresolution(const config& cfg) :
tresolution_definition_(cfg)
{ read_extra(cfg); }
private:
void read_extra(const config& cfg);
};
}; };
struct twindow_definition struct twindow_definition
@ -225,19 +221,20 @@ struct tgui_definition
const std::string& read(const config& cfg); const std::string& read(const config& cfg);
std::map<std::string, tbutton_definition> buttons;
std::map<std::string, tlabel_definition> labels; typedef std::map<std::string /*control type*/, std::map<std::string /*id*/, tcontrol_definition*> > tcontrol_definition_map;
std::map<std::string, ttext_box_definition> text_boxs;
std::map<std::string, ttooltip_definition> tooltips; tcontrol_definition_map control_definition;
std::map<std::string, twindow_definition> windows; std::map<std::string, twindow_definition> windows;
std::map<std::string, twindow_builder> window_types; std::map<std::string, twindow_builder> window_types;
private:
template<class T>
void load_definitions(const std::string& definition_type, const config::child_list& definition_list);
}; };
tresolution_definition_* get_button(const std::string& definition); tresolution_definition_* get_control(const std::string& control_type, const std::string& definition);
tresolution_definition_* get_label(const std::string& definition);
tresolution_definition_* get_text_box(const std::string& definition);
tresolution_definition_* get_tooltip(const std::string& definition);
std::vector<twindow_definition::tresolution>::const_iterator get_window(const std::string& definition); std::vector<twindow_definition::tresolution>::const_iterator get_window(const std::string& definition);
std::vector<twindow_builder::tresolution>::const_iterator get_window_builder(const std::string& type); std::vector<twindow_builder::tresolution>::const_iterator get_window_builder(const std::string& type);

2
src/gui/widgets/text_box.cpp
View File

@ -441,7 +441,7 @@ void ttext_box::handle_key_clear_line(SDLMod /*modifier*/, bool& handled)
void ttext_box::load_config() void ttext_box::load_config()
{ {
if(!config()) { if(!config()) {
set_config(get_text_box(definition())); set_config(get_control("text_box", definition()));
assert(canvas().size() == config()->state.size()); assert(canvas().size() == config()->state.size());
for(size_t i = 0; i < canvas().size(); ++i) { for(size_t i = 0; i < canvas().size(); ++i) {

2
src/gui/widgets/tooltip.cpp
View File

@ -41,7 +41,7 @@ namespace gui2 {
void ttooltip::load_config() void ttooltip::load_config()
{ {
if(!config()) { if(!config()) {
set_config(get_tooltip(definition())); set_config(get_control("tooltip", definition()));
assert(canvas().size() == config()->state.size()); assert(canvas().size() == config()->state.size());
for(size_t i = 0; i < canvas().size(); ++i) { for(size_t i = 0; i < canvas().size(); ++i) {