The Battle for Wesnoth Wiki - User contributions [en]

SummerOfCodeProposal res

2009-03-27T13:56:18Z

Res: /* Current status */

SummerOfCodeProposal res

2009-03-23T16:46:04Z

Res: /* Next (technically, first) Steps */

SummerOfCodeProposal res

2009-03-23T14:19:37Z

Res:

SummerOfCodeProposal res

2009-03-22T17:37:22Z

Res:

= A bit about me =

My name is Frank Richter, currently studying Computer Sciences at the University of Jena (that's in Germany).

As far as C++ is concerned, I program in it since at least seven years now. In my spare time I also develop for Crystal Space, an open source 3D engine. While I did a lot in the topics of realtime 3D, OpenGL, shaders and such, I also did (and do) 'low-level' things like cross-platform services and, last, but in this context here now certainly not least, matters of ''memory optimization''.

= Current status =

* Upon reading the blog post linked in the idea proposal my first thought was to use a proxy class for operator[]. Below a patch that implements it.

== Proxy class patch ==

This builds and, I believe, works, but has a number of not-so-nice issues:
* Some places store return values in <tt>t_string&</tt>. The idea is to change these to <tt>config::proxy_string</tt>, as that type should ideally behave like <tt>t_string&</tt>.
* <tt>config::proxy_string</tt> can cast to both <tt>std::string</tt> and <tt>t_string</tt>.
The first is necessary as <tt>t_string</tt> can cast to it as well; the second is necessary to
support use of a <tt>config::proxy_string</tt> where a <tt>const t_string&</tt> is expected.
Unfortunately, this introduces an ambiguity in cases where a <tt>config::proxy_string</tt> is passed to methods that can take either of <tt>std::string</tt> or <tt>t_string</tt>. The ambiguity was solved in some places by using <tt>.str()</tt>. It would also go away when <tt>proxy_string operator[]</tt> is removed.
* the <tt>variables_set</tt> class has a member (<tt>get_variable_const()</tt>) that returns a <tt>t_string&</tt>. <tt>game_state</tt> descends from this class; it's <tt>get_variable_const()</tt> implementation supposedly returns a value from a <tt>config</tt>. To ensure the ref is valid, the value as a <tt>t_string</tt> is stored in a map. This is clearly not ideal.

<pre>
Index: src/config.cpp
===================================================================
--- src/config.cpp (revision 33970)
+++ src/config.cpp (working copy)
@@ -293,10 +293,12 @@
delete res;
}

+/*
t_string& config::operator[](const std::string& key)
{
return values[key];
}
+*/

const t_string& config::operator[](const std::string& key) const
{
Index: src/font.cpp
===================================================================
--- src/font.cpp (revision 33970)
+++ src/font.cpp (working copy)
@@ -1278,7 +1278,7 @@
known_fonts.insert(font["name"]);
}

- font_order = (*fonts_config)["order"];
+ font_order = (*fonts_config)["order"].t_str();
const std::vector<std::string> font_order = utils::split((*fonts_config)["order"]);
std::vector<font::subset_descriptor> fontlist;
std::vector<std::string>::const_iterator font;
Index: src/playsingle_controller.cpp
===================================================================
--- src/playsingle_controller.cpp (revision 33970)
+++ src/playsingle_controller.cpp (working copy)
@@ -281,7 +281,7 @@
// Log before prestart events: they do weird things.
if (first_human_team_ != -1) {
log.start(gamestate_, teams_[first_human_team_], first_human_team_ + 1, units_,
- loading_game_ ? gamestate_.get_variable("turn_number") : "", status_.number_of_turns());
+ loading_game_ ? gamestate_.get_variable("turn_number").c_str() : "", status_.number_of_turns());
}

fire_prestart(!loading_game_);
Index: src/gamestatus.cpp
===================================================================
--- src/gamestatus.cpp (revision 33970)
+++ src/gamestatus.cpp (working copy)
@@ -1166,7 +1166,7 @@
}
}

-t_string& game_state::get_variable(const std::string& key)
+config::proxy_string game_state::get_variable(const std::string& key)
{
return variable_info(key, true, variable_info::TYPE_SCALAR).as_scalar();
}
@@ -1174,8 +1174,9 @@
const t_string& game_state::get_variable_const(const std::string& key) const
{
variable_info to_get(key, false, variable_info::TYPE_SCALAR);
- if(!to_get.is_valid) return temporaries[key];
- return to_get.as_scalar();
+ config::proxy_string val ((!to_get.is_valid) ? temporaries[key] : to_get.as_scalar());
+ save_t_string[key] = val.t_str();
+ return save_t_string[key];
}

config& game_state::get_variable_cfg(const std::string& key)
Index: src/theme.cpp
===================================================================
--- src/theme.cpp (revision 33970)
+++ src/theme.cpp (working copy)
@@ -169,13 +169,13 @@
// follow the inheritance hierarchy and push all the nodes on the stack
std::vector<const config*> parent_stack(1, (*i));
const config* parent;
- const t_string* parent_id = &((**i)["inherits"]);
- while((parent = top_cfg.find_child("resolution", "id", (*parent_id))) == NULL) {
- parent = top_cfg.find_child("partialresolution", "id", (*parent_id));
+ t_string parent_id = ((**i)["inherits"]);
+ while((parent = top_cfg.find_child("resolution", "id", parent_id)) == NULL) {
+ parent = top_cfg.find_child("partialresolution", "id", parent_id);
if(parent == NULL)
- throw config::error("[partialresolution] refers to non-existant [resolution] " + (*parent_id).str());
+ throw config::error("[partialresolution] refers to non-existant [resolution] " + parent_id.str());
parent_stack.push_back(parent);
- parent_id = &((*parent)["inherits"]);
+ parent_id = ((*parent)["inherits"]);
}

// Add the parent resolution and apply all the modifications of its children
Index: src/variable.hpp
===================================================================
--- src/variable.hpp (revision 33970)
+++ src/variable.hpp (working copy)
@@ -206,7 +206,7 @@
* Results: after deciding the desired type, these methods can retrieve the result
* Note: first you should force_valid or check is_valid, otherwise these may fail
*/
- t_string& as_scalar();
+ config::proxy_string as_scalar();
config& as_container();
array_range as_array(); //range may be empty
};
Index: src/game_config.cpp
===================================================================
--- src/game_config.cpp (revision 33970)
+++ src/game_config.cpp (working copy)
@@ -239,7 +239,7 @@
std::string id = (**teamC)["id"];
std::vector<Uint32> temp = string2rgb((**teamC)["rgb"]);
team_rgb_range.insert(std::make_pair(id,color_range(temp)));
- team_rgb_name[id] = (**teamC)["name"];
+ team_rgb_name[id] = (**teamC)["name"].t_str();
//generate palette of same name;
std::vector<Uint32> tp = palette(team_rgb_range[id]);
if(tp.size()){
Index: src/config.hpp
===================================================================
--- src/config.hpp (revision 33970)
+++ src/config.hpp (working copy)
@@ -150,6 +150,43 @@
private:
Itor i_;
};
+
+ class proxy_string
+ {
+ config& owner;
+ const std::string& key;
+
+ t_string& real_str() { return owner.values[key]; }
+ const t_string& real_str() const { return owner.values[key]; }
+ public:
+ proxy_string (config& owner, const std::string& key) : owner (owner), key (key) {}
+
+ proxy_string& operator= (const proxy_string& other)
+ { return this->operator= (other.real_str()); }
+
+ proxy_string& operator= (const char* str)
+ { real_str() = str; return *this; }
+ proxy_string& operator= (const t_string& str)
+ { real_str() = str; return *this; }
+ proxy_string& operator= (const std::string& str)
+ { real_str() = str; return *this; }
+
+ proxy_string& operator+= (const std::string& str)
+ { real_str() += str; return *this; }
+
+ // t_string 'emulation' methods
+ bool empty() const { return real_str().empty(); }
+ const char* c_str() const { return real_str().c_str(); }
+ std::string to_serialized() const { return real_str().to_serialized(); }
+
+ const std::string& str() const { return real_str().str(); }
+ const t_string& t_str() const { return real_str(); }
+ operator std::string () const { return real_str().str(); }
+ operator t_string() const { return real_str(); }
+
+ inline friend std::ostream& operator<<(std::ostream& os, const proxy_string& str)
+ { return os << str.real_str(); }
+ };

typedef std::pair<const_attribute_iterator,const_attribute_iterator> const_attr_itors;

@@ -167,7 +204,10 @@
config& add_child(const std::string& key);
config& add_child(const std::string& key, const config& val);
config& add_child_at(const std::string& key, const config& val, size_t index);
- t_string& operator[](const std::string& key);
+
+ //t_string& operator[](const std::string& key);
+ proxy_string operator[](const std::string& key)
+ { return proxy_string (*this, key); }
const t_string& operator[](const std::string& key) const;

const t_string& get_attribute(const std::string& key) const;
Index: src/game_events.cpp
===================================================================
--- src/game_events.cpp (revision 33970)
+++ src/game_events.cpp (working copy)
@@ -88,10 +88,10 @@
class pump_manager {
public:
pump_manager() :
- x1_(state_of_game->get_variable("x1")),
- x2_(state_of_game->get_variable("x2")),
- y1_(state_of_game->get_variable("y1")),
- y2_(state_of_game->get_variable("y2"))
+ x1_(state_of_game->get_variable("x1").str()),
+ x2_(state_of_game->get_variable("x2").str()),
+ y1_(state_of_game->get_variable("y1").str()),
+ y2_(state_of_game->get_variable("y2").str())
{
++instance_count;
}
@@ -856,7 +856,7 @@

static void store_gold_side(bool store_side, const vconfig& cfg)
{
- t_string *gold_store;
+ config::proxy_string *gold_store = 0;
std::string side = cfg["side"];
std::string var_name = cfg["variable"];
if(var_name.empty()) {
@@ -882,11 +882,12 @@
state_of_game->get_variable(var_name+".user_team_name") = (*teams)[team_index].user_team_name();
state_of_game->get_variable(var_name+".colour") = (*teams)[team_index].map_colour_to();

- gold_store = &state_of_game->get_variable(var_name+".gold");
+ gold_store = new config::proxy_string (state_of_game->get_variable(var_name+".gold"));
} else {
- gold_store = &state_of_game->get_variable(var_name);
+ gold_store = new config::proxy_string (state_of_game->get_variable(var_name));
}
*gold_store = lexical_cast_default<std::string>((*teams)[team_index].gold(),"");
+ delete gold_store;
}
}

@@ -1158,7 +1159,7 @@
assert(state_of_game != NULL);

const std::string name = cfg["name"];
- t_string& var = state_of_game->get_variable(name);
+ config::proxy_string var = state_of_game->get_variable(name);

const t_string& literal = cfg.get_attribute("literal"); // no $var substitution
if(literal.empty() == false) {
@@ -1191,7 +1192,7 @@

const std::string multiply = cfg["multiply"];
if(multiply.empty() == false) {
- if(isint(var) && isint(multiply)) {
+ if(isint(var.str()) && isint(multiply)) {
var = str_cast( std::atoi(var.c_str()) * std::atoi(multiply.c_str()) );
} else {
var = str_cast( std::atof(var.c_str()) * std::atof(multiply.c_str()) );
@@ -1204,7 +1205,7 @@
ERR_NG << "division by zero on variable " << name << "\n";
return;
}
- if(isint(var) && isint(divide)) {
+ if(isint(var.str()) && isint(divide)) {
var = str_cast( std::atoi(var.c_str()) / std::atoi(divide.c_str()) );
} else {
var = str_cast( std::atof(var.c_str()) / std::atof(divide.c_str()) );
@@ -1217,7 +1218,7 @@
ERR_NG << "division by zero on variable " << name << "\n";
return;
}
- if(isint(var) && isint(modulo)) {
+ if(isint(var.str()) && isint(modulo)) {
var = str_cast( std::atoi(var.c_str()) % std::atoi(modulo.c_str()) );
} else {
double value = std::fmod( std::atof(var.c_str()), std::atof(modulo.c_str()) );
Index: src/gui/dialogs/addon_list.cpp
===================================================================
--- src/gui/dialogs/addon_list.cpp (revision 33970)
+++ src/gui/dialogs/addon_list.cpp (working copy)
@@ -74,10 +74,10 @@
item["label"] = tmp;
data.insert(std::make_pair("author", item));

- item["label"] = (**itor)["downloads"];
+ item["label"] = (**itor)["downloads"].t_str();
data.insert(std::make_pair("downloads", item));

- item["label"] = (**itor)["size"];
+ item["label"] = (**itor)["size"].t_str();
data.insert(std::make_pair("size", item));

list->add_row(data);
Index: src/unit_types.cpp
===================================================================
--- src/unit_types.cpp (revision 33970)
+++ src/unit_types.cpp (working copy)
@@ -791,8 +791,8 @@
build_created(cfg, mv_types, races, traits);
}

- type_name_ = cfg_["name"];
- description_ = cfg_["description"];
+ type_name_ = cfg_["name"].t_str();
+ description_ = cfg_["description"].t_str();
hitpoints_ = lexical_cast_default<int>(cfg["hitpoints"], 1);
level_ = lexical_cast_default<int>(cfg["level"], 0);
movement_ = lexical_cast_default<int>(cfg["movement"], 1);
Index: src/gamestatus.hpp
===================================================================
--- src/gamestatus.hpp (revision 33970)
+++ src/gamestatus.hpp (working copy)
@@ -120,7 +120,7 @@

// Variable access

- t_string& get_variable(const std::string& varname);
+ config::proxy_string get_variable(const std::string& varname);
virtual const t_string& get_variable_const(const std::string& varname) const;
config& get_variable_cfg(const std::string& varname);
variable_info::array_range get_variable_cfgs(const std::string& varname);
@@ -165,6 +165,7 @@
rand_rng::simple_rng rng_ ;
config variables;
mutable config temporaries; // lengths of arrays, etc.
+ mutable string_map save_t_string;
const rand_rng::set_random_generator generator_setter; /**< Make sure that rng is initialized first */
friend struct variable_info;
};
Index: src/variable.cpp
===================================================================
--- src/variable.cpp (revision 33970)
+++ src/variable.cpp (working copy)
@@ -713,7 +713,7 @@
}
}

-t_string& variable_info::as_scalar() {
+config::proxy_string variable_info::as_scalar() {
assert(is_valid);
return (*vars)[key];
}
Index: src/multiplayer_connect.cpp
===================================================================
--- src/multiplayer_connect.cpp (revision 33970)
+++ src/multiplayer_connect.cpp (working copy)
@@ -1439,8 +1439,8 @@
int side_num = 1;
foreach (config &side, sides)
{
- t_string &team_name = side["team_name"];
- t_string &user_team_name = side["user_team_name"];
+ config::proxy_string team_name = side["team_name"];
+ config::proxy_string user_team_name = side["user_team_name"];

if(team_name.empty())
team_name = lexical_cast<std::string>(side_num);
@@ -1465,7 +1465,7 @@
foreach (config &side, sides)
{
const std::string side_num = lexical_cast<std::string>(_side_num);
- t_string &team_name = side["team_name"];
+ config::proxy_string team_name = side["team_name"];

if(team_name.empty())
team_name = side_num;
</pre>

= Next (technically, first) Steps =

* Get rid of <tt>t_string& operator[]</tt> - could be a proxy class, as above, or like in the initial blog post, a setter function. A way in-between could be to have the proxy class for convenient migration, but mark is a deprecated; instead, promote the usage of the setter. Cases where the proxy class actually introduces ugliness should be fixed manually.
* Determine the "variation" in strings in configs. E.g. if only very few distinct strings occur during a run of the game string deleting could be ignored and storage one-way (thus simpler). However, while I expect that there is a set of strings which occur often (keywords), there would also be lots of arbitrary strings that need proper deletion lest to introduce a leak.

SummerOfCodeProposal res

2009-03-22T15:25:52Z

Res:

= A bit about me =

My name is Frank Richter, currently studying Computer Sciences at the University of Jena (that's in Germany).

As far as C++ is concerned, I program in it since at least seven years now. In my spare time I also develop for Crystal Space, an open source 3D engine. While I did a lot in the topics of realtime 3D, OpenGL, shaders and such, I also did (and do) 'low-level' things like cross-platform services and, last, but in this context here now certainly not least, matters of ''memory optimization''.

= Current status =

* Upon reading the blog post linked in the idea proposal my first thought was to use a proxy class for operator[]. Below a patch that implements it.

== Proxy class patch ==

This builds and, I believe, works, but has a number of not-so-nice issues:
* Some places store return values in <tt>t_string&</tt>. The idea is to change these to <tt>config::proxy_string</tt>, as that type should ideally behave like <tt>t_string&</tt>.
* <tt>config::proxy_string</tt> can cast to both <tt>std::string</tt> and <tt>t_string</tt>.
The first is necessary as <tt>t_string</tt> can cast to it as well; the second is necessary to
support use of a <tt>config::proxy_string</tt> where a <tt>const t_string&</tt> is expected.
Unfortunately, this introduces an ambiguity in cases where a <tt>config::proxy_string</tt> is passed to methods that can take either of <tt>std::string</tt> or <tt>t_string</tt>.
* the <tt>variables_set</tt> class has a member (<tt>get_variable_const()</tt>) that returns a <tt>t_string&</tt>. <tt>game_state</tt> descends from this class; it's <tt>get_variable_const()</tt> implementation supposedly returns a value from a <tt>config</tt>. To ensure the ref is valid, the value as a <tt>t_string</tt> is stored in a map. This is clearly not ideal.

<pre>
Index: src/config.cpp
===================================================================
--- src/config.cpp (revision 33970)
+++ src/config.cpp (working copy)
@@ -293,10 +293,12 @@
delete res;
}

+/*
t_string& config::operator[](const std::string& key)
{
return values[key];
}
+*/

const t_string& config::operator[](const std::string& key) const
{
Index: src/font.cpp
===================================================================
--- src/font.cpp (revision 33970)
+++ src/font.cpp (working copy)
@@ -1278,7 +1278,7 @@
known_fonts.insert(font["name"]);
}

- font_order = (*fonts_config)["order"];
+ font_order = (*fonts_config)["order"].t_str();
const std::vector<std::string> font_order = utils::split((*fonts_config)["order"]);
std::vector<font::subset_descriptor> fontlist;
std::vector<std::string>::const_iterator font;
Index: src/playsingle_controller.cpp
===================================================================
--- src/playsingle_controller.cpp (revision 33970)
+++ src/playsingle_controller.cpp (working copy)
@@ -281,7 +281,7 @@
// Log before prestart events: they do weird things.
if (first_human_team_ != -1) {
log.start(gamestate_, teams_[first_human_team_], first_human_team_ + 1, units_,
- loading_game_ ? gamestate_.get_variable("turn_number") : "", status_.number_of_turns());
+ loading_game_ ? gamestate_.get_variable("turn_number").c_str() : "", status_.number_of_turns());
}

fire_prestart(!loading_game_);
Index: src/gamestatus.cpp
===================================================================
--- src/gamestatus.cpp (revision 33970)
+++ src/gamestatus.cpp (working copy)
@@ -1166,7 +1166,7 @@
}
}

-t_string& game_state::get_variable(const std::string& key)
+config::proxy_string game_state::get_variable(const std::string& key)
{
return variable_info(key, true, variable_info::TYPE_SCALAR).as_scalar();
}
@@ -1174,8 +1174,9 @@
const t_string& game_state::get_variable_const(const std::string& key) const
{
variable_info to_get(key, false, variable_info::TYPE_SCALAR);
- if(!to_get.is_valid) return temporaries[key];
- return to_get.as_scalar();
+ config::proxy_string val ((!to_get.is_valid) ? temporaries[key] : to_get.as_scalar());
+ save_t_string[key] = val.t_str();
+ return save_t_string[key];
}

config& game_state::get_variable_cfg(const std::string& key)
Index: src/theme.cpp
===================================================================
--- src/theme.cpp (revision 33970)
+++ src/theme.cpp (working copy)
@@ -169,13 +169,13 @@
// follow the inheritance hierarchy and push all the nodes on the stack
std::vector<const config*> parent_stack(1, (*i));
const config* parent;
- const t_string* parent_id = &((**i)["inherits"]);
- while((parent = top_cfg.find_child("resolution", "id", (*parent_id))) == NULL) {
- parent = top_cfg.find_child("partialresolution", "id", (*parent_id));
+ t_string parent_id = ((**i)["inherits"]);
+ while((parent = top_cfg.find_child("resolution", "id", parent_id)) == NULL) {
+ parent = top_cfg.find_child("partialresolution", "id", parent_id);
if(parent == NULL)
- throw config::error("[partialresolution] refers to non-existant [resolution] " + (*parent_id).str());
+ throw config::error("[partialresolution] refers to non-existant [resolution] " + parent_id.str());
parent_stack.push_back(parent);
- parent_id = &((*parent)["inherits"]);
+ parent_id = ((*parent)["inherits"]);
}

// Add the parent resolution and apply all the modifications of its children
Index: src/variable.hpp
===================================================================
--- src/variable.hpp (revision 33970)
+++ src/variable.hpp (working copy)
@@ -206,7 +206,7 @@
* Results: after deciding the desired type, these methods can retrieve the result
* Note: first you should force_valid or check is_valid, otherwise these may fail
*/
- t_string& as_scalar();
+ config::proxy_string as_scalar();
config& as_container();
array_range as_array(); //range may be empty
};
Index: src/game_config.cpp
===================================================================
--- src/game_config.cpp (revision 33970)
+++ src/game_config.cpp (working copy)
@@ -239,7 +239,7 @@
std::string id = (**teamC)["id"];
std::vector<Uint32> temp = string2rgb((**teamC)["rgb"]);
team_rgb_range.insert(std::make_pair(id,color_range(temp)));
- team_rgb_name[id] = (**teamC)["name"];
+ team_rgb_name[id] = (**teamC)["name"].t_str();
//generate palette of same name;
std::vector<Uint32> tp = palette(team_rgb_range[id]);
if(tp.size()){
Index: src/config.hpp
===================================================================
--- src/config.hpp (revision 33970)
+++ src/config.hpp (working copy)
@@ -150,6 +150,43 @@
private:
Itor i_;
};
+
+ class proxy_string
+ {
+ config& owner;
+ const std::string& key;
+
+ t_string& real_str() { return owner.values[key]; }
+ const t_string& real_str() const { return owner.values[key]; }
+ public:
+ proxy_string (config& owner, const std::string& key) : owner (owner), key (key) {}
+
+ proxy_string& operator= (const proxy_string& other)
+ { return this->operator= (other.real_str()); }
+
+ proxy_string& operator= (const char* str)
+ { real_str() = str; return *this; }
+ proxy_string& operator= (const t_string& str)
+ { real_str() = str; return *this; }
+ proxy_string& operator= (const std::string& str)
+ { real_str() = str; return *this; }
+
+ proxy_string& operator+= (const std::string& str)
+ { real_str() += str; return *this; }
+
+ // t_string 'emulation' methods
+ bool empty() const { return real_str().empty(); }
+ const char* c_str() const { return real_str().c_str(); }
+ std::string to_serialized() const { return real_str().to_serialized(); }
+
+ const std::string& str() const { return real_str().str(); }
+ const t_string& t_str() const { return real_str(); }
+ operator std::string () const { return real_str().str(); }
+ operator t_string() const { return real_str(); }
+
+ inline friend std::ostream& operator<<(std::ostream& os, const proxy_string& str)
+ { return os << str.real_str(); }
+ };

typedef std::pair<const_attribute_iterator,const_attribute_iterator> const_attr_itors;

@@ -167,7 +204,10 @@
config& add_child(const std::string& key);
config& add_child(const std::string& key, const config& val);
config& add_child_at(const std::string& key, const config& val, size_t index);
- t_string& operator[](const std::string& key);
+
+ //t_string& operator[](const std::string& key);
+ proxy_string operator[](const std::string& key)
+ { return proxy_string (*this, key); }
const t_string& operator[](const std::string& key) const;

const t_string& get_attribute(const std::string& key) const;
Index: src/game_events.cpp
===================================================================
--- src/game_events.cpp (revision 33970)
+++ src/game_events.cpp (working copy)
@@ -88,10 +88,10 @@
class pump_manager {
public:
pump_manager() :
- x1_(state_of_game->get_variable("x1")),
- x2_(state_of_game->get_variable("x2")),
- y1_(state_of_game->get_variable("y1")),
- y2_(state_of_game->get_variable("y2"))
+ x1_(state_of_game->get_variable("x1").str()),
+ x2_(state_of_game->get_variable("x2").str()),
+ y1_(state_of_game->get_variable("y1").str()),
+ y2_(state_of_game->get_variable("y2").str())
{
++instance_count;
}
@@ -856,7 +856,7 @@

static void store_gold_side(bool store_side, const vconfig& cfg)
{
- t_string *gold_store;
+ config::proxy_string *gold_store = 0;
std::string side = cfg["side"];
std::string var_name = cfg["variable"];
if(var_name.empty()) {
@@ -882,11 +882,12 @@
state_of_game->get_variable(var_name+".user_team_name") = (*teams)[team_index].user_team_name();
state_of_game->get_variable(var_name+".colour") = (*teams)[team_index].map_colour_to();

- gold_store = &state_of_game->get_variable(var_name+".gold");
+ gold_store = new config::proxy_string (state_of_game->get_variable(var_name+".gold"));
} else {
- gold_store = &state_of_game->get_variable(var_name);
+ gold_store = new config::proxy_string (state_of_game->get_variable(var_name));
}
*gold_store = lexical_cast_default<std::string>((*teams)[team_index].gold(),"");
+ delete gold_store;
}
}

@@ -1158,7 +1159,7 @@
assert(state_of_game != NULL);

const std::string name = cfg["name"];
- t_string& var = state_of_game->get_variable(name);
+ config::proxy_string var = state_of_game->get_variable(name);

const t_string& literal = cfg.get_attribute("literal"); // no $var substitution
if(literal.empty() == false) {
@@ -1191,7 +1192,7 @@

const std::string multiply = cfg["multiply"];
if(multiply.empty() == false) {
- if(isint(var) && isint(multiply)) {
+ if(isint(var.str()) && isint(multiply)) {
var = str_cast( std::atoi(var.c_str()) * std::atoi(multiply.c_str()) );
} else {
var = str_cast( std::atof(var.c_str()) * std::atof(multiply.c_str()) );
@@ -1204,7 +1205,7 @@
ERR_NG << "division by zero on variable " << name << "\n";
return;
}
- if(isint(var) && isint(divide)) {
+ if(isint(var.str()) && isint(divide)) {
var = str_cast( std::atoi(var.c_str()) / std::atoi(divide.c_str()) );
} else {
var = str_cast( std::atof(var.c_str()) / std::atof(divide.c_str()) );
@@ -1217,7 +1218,7 @@
ERR_NG << "division by zero on variable " << name << "\n";
return;
}
- if(isint(var) && isint(modulo)) {
+ if(isint(var.str()) && isint(modulo)) {
var = str_cast( std::atoi(var.c_str()) % std::atoi(modulo.c_str()) );
} else {
double value = std::fmod( std::atof(var.c_str()), std::atof(modulo.c_str()) );
Index: src/gui/dialogs/addon_list.cpp
===================================================================
--- src/gui/dialogs/addon_list.cpp (revision 33970)
+++ src/gui/dialogs/addon_list.cpp (working copy)
@@ -74,10 +74,10 @@
item["label"] = tmp;
data.insert(std::make_pair("author", item));

- item["label"] = (**itor)["downloads"];
+ item["label"] = (**itor)["downloads"].t_str();
data.insert(std::make_pair("downloads", item));

- item["label"] = (**itor)["size"];
+ item["label"] = (**itor)["size"].t_str();
data.insert(std::make_pair("size", item));

list->add_row(data);
Index: src/unit_types.cpp
===================================================================
--- src/unit_types.cpp (revision 33970)
+++ src/unit_types.cpp (working copy)
@@ -791,8 +791,8 @@
build_created(cfg, mv_types, races, traits);
}

- type_name_ = cfg_["name"];
- description_ = cfg_["description"];
+ type_name_ = cfg_["name"].t_str();
+ description_ = cfg_["description"].t_str();
hitpoints_ = lexical_cast_default<int>(cfg["hitpoints"], 1);
level_ = lexical_cast_default<int>(cfg["level"], 0);
movement_ = lexical_cast_default<int>(cfg["movement"], 1);
Index: src/gamestatus.hpp
===================================================================
--- src/gamestatus.hpp (revision 33970)
+++ src/gamestatus.hpp (working copy)
@@ -120,7 +120,7 @@

// Variable access

- t_string& get_variable(const std::string& varname);
+ config::proxy_string get_variable(const std::string& varname);
virtual const t_string& get_variable_const(const std::string& varname) const;
config& get_variable_cfg(const std::string& varname);
variable_info::array_range get_variable_cfgs(const std::string& varname);
@@ -165,6 +165,7 @@
rand_rng::simple_rng rng_ ;
config variables;
mutable config temporaries; // lengths of arrays, etc.
+ mutable string_map save_t_string;
const rand_rng::set_random_generator generator_setter; /**< Make sure that rng is initialized first */
friend struct variable_info;
};
Index: src/variable.cpp
===================================================================
--- src/variable.cpp (revision 33970)
+++ src/variable.cpp (working copy)
@@ -713,7 +713,7 @@
}
}

-t_string& variable_info::as_scalar() {
+config::proxy_string variable_info::as_scalar() {
assert(is_valid);
return (*vars)[key];
}
Index: src/multiplayer_connect.cpp
===================================================================
--- src/multiplayer_connect.cpp (revision 33970)
+++ src/multiplayer_connect.cpp (working copy)
@@ -1439,8 +1439,8 @@
int side_num = 1;
foreach (config &side, sides)
{
- t_string &team_name = side["team_name"];
- t_string &user_team_name = side["user_team_name"];
+ config::proxy_string team_name = side["team_name"];
+ config::proxy_string user_team_name = side["user_team_name"];

if(team_name.empty())
team_name = lexical_cast<std::string>(side_num);
@@ -1465,7 +1465,7 @@
foreach (config &side, sides)
{
const std::string side_num = lexical_cast<std::string>(_side_num);
- t_string &team_name = side["team_name"];
+ config::proxy_string team_name = side["team_name"];

if(team_name.empty())
team_name = side_num;
</pre>

= Next (technically, first) Steps =

* Get rid of <tt>t_string& operator[]</tt> - could be a proxy class, as above, or like in the initial blog post, a setter function. A way in-between could be to have the proxy class for convenient migration, but mark is a deprecated; instead, promote the usage of the setter. Cases where the proxy class actually introduces ugliness should be fixed manually.
* Determine the "variation" in strings in configs. E.g. if only very few distinct strings occur during a run of the game string deleting could be ignored and storage one-way (thus simpler). However, while I expect that there is a set of strings which occur often (keywords), there would also be lots of arbitrary strings that need proper deletion lest to introduce a leak.

SummerOfCodeProposal res

2009-03-22T15:18:45Z

Res: /* Current status */

= A bit about me =

My name is Frank Richter, currently studying Computer Sciences at the University of Jena (that's in Germany).

As far as C++ is concerned, I program in it since at least seven years now. In my spare time I also develop for Crystal Space, an open source 3D engine. While I did a lot in the topics of realtime 3D, OpenGL, shaders and such, I also did (and do) 'low-level' things like cross-platform services and, last, but in this context here now certainly not least, matters of ''memory optimization''.

= Current status =

* Upon reading the blog post linked in the idea proposal my first thought was to use a proxy class for operator[]. Below a patch that implements it.

== Proxy class patch ==

This builds and, I believe, works, but has a number of not-so-nice issues:
* Some places store return values in <tt>t_string&</tt>. The idea is to change these to <tt>config::proxy_string</tt>, as that type should ideally behave like <tt>t_string&</tt>.
* <tt>config::proxy_string</tt> can cast to both <tt>std::string</tt> and <tt>t_string</tt>.
The first is necessary as <tt>t_string</tt> can cast to it as well; the second is necessary to
support use of a <tt>config::proxy_string</tt> where a <tt>const t_string&</tt> is expected.
Unfortunately, this introduces an ambiguity in cases where a <tt>config::proxy_string</tt> is passed to methods that can take either of <tt>std::string</tt> or <tt>t_string</tt>.
* the <tt>variables_set</tt> class has a member (<tt>get_variable_const()</tt>) that returns a <tt>t_string&</tt>. <tt>game_state</tt> descends from this class; it's <tt>get_variable_const()</tt> implementation supposedly returns a value from a <tt>config</tt>. To ensure the ref is valid, the value as a <tt>t_string</tt> is stored in a map. This is clearly not ideal.

<pre>
Index: src/config.cpp
===================================================================
--- src/config.cpp (revision 33970)
+++ src/config.cpp (working copy)
@@ -293,10 +293,12 @@
delete res;
}

+/*
t_string& config::operator[](const std::string& key)
{
return values[key];
}
+*/

const t_string& config::operator[](const std::string& key) const
{
Index: src/font.cpp
===================================================================
--- src/font.cpp (revision 33970)
+++ src/font.cpp (working copy)
@@ -1278,7 +1278,7 @@
known_fonts.insert(font["name"]);
}

- font_order = (*fonts_config)["order"];
+ font_order = (*fonts_config)["order"].t_str();
const std::vector<std::string> font_order = utils::split((*fonts_config)["order"]);
std::vector<font::subset_descriptor> fontlist;
std::vector<std::string>::const_iterator font;
Index: src/playsingle_controller.cpp
===================================================================
--- src/playsingle_controller.cpp (revision 33970)
+++ src/playsingle_controller.cpp (working copy)
@@ -281,7 +281,7 @@
// Log before prestart events: they do weird things.
if (first_human_team_ != -1) {
log.start(gamestate_, teams_[first_human_team_], first_human_team_ + 1, units_,
- loading_game_ ? gamestate_.get_variable("turn_number") : "", status_.number_of_turns());
+ loading_game_ ? gamestate_.get_variable("turn_number").c_str() : "", status_.number_of_turns());
}

fire_prestart(!loading_game_);
Index: src/gamestatus.cpp
===================================================================
--- src/gamestatus.cpp (revision 33970)
+++ src/gamestatus.cpp (working copy)
@@ -1166,7 +1166,7 @@
}
}

-t_string& game_state::get_variable(const std::string& key)
+config::proxy_string game_state::get_variable(const std::string& key)
{
return variable_info(key, true, variable_info::TYPE_SCALAR).as_scalar();
}
@@ -1174,8 +1174,9 @@
const t_string& game_state::get_variable_const(const std::string& key) const
{
variable_info to_get(key, false, variable_info::TYPE_SCALAR);
- if(!to_get.is_valid) return temporaries[key];
- return to_get.as_scalar();
+ config::proxy_string val ((!to_get.is_valid) ? temporaries[key] : to_get.as_scalar());
+ save_t_string[key] = val.t_str();
+ return save_t_string[key];
}

config& game_state::get_variable_cfg(const std::string& key)
Index: src/theme.cpp
===================================================================
--- src/theme.cpp (revision 33970)
+++ src/theme.cpp (working copy)
@@ -169,13 +169,13 @@
// follow the inheritance hierarchy and push all the nodes on the stack
std::vector<const config*> parent_stack(1, (*i));
const config* parent;
- const t_string* parent_id = &((**i)["inherits"]);
- while((parent = top_cfg.find_child("resolution", "id", (*parent_id))) == NULL) {
- parent = top_cfg.find_child("partialresolution", "id", (*parent_id));
+ t_string parent_id = ((**i)["inherits"]);
+ while((parent = top_cfg.find_child("resolution", "id", parent_id)) == NULL) {
+ parent = top_cfg.find_child("partialresolution", "id", parent_id);
if(parent == NULL)
- throw config::error("[partialresolution] refers to non-existant [resolution] " + (*parent_id).str());
+ throw config::error("[partialresolution] refers to non-existant [resolution] " + parent_id.str());
parent_stack.push_back(parent);
- parent_id = &((*parent)["inherits"]);
+ parent_id = ((*parent)["inherits"]);
}

// Add the parent resolution and apply all the modifications of its children
Index: src/variable.hpp
===================================================================
--- src/variable.hpp (revision 33970)
+++ src/variable.hpp (working copy)
@@ -206,7 +206,7 @@
* Results: after deciding the desired type, these methods can retrieve the result
* Note: first you should force_valid or check is_valid, otherwise these may fail
*/
- t_string& as_scalar();
+ config::proxy_string as_scalar();
config& as_container();
array_range as_array(); //range may be empty
};
Index: src/game_config.cpp
===================================================================
--- src/game_config.cpp (revision 33970)
+++ src/game_config.cpp (working copy)
@@ -239,7 +239,7 @@
std::string id = (**teamC)["id"];
std::vector<Uint32> temp = string2rgb((**teamC)["rgb"]);
team_rgb_range.insert(std::make_pair(id,color_range(temp)));
- team_rgb_name[id] = (**teamC)["name"];
+ team_rgb_name[id] = (**teamC)["name"].t_str();
//generate palette of same name;
std::vector<Uint32> tp = palette(team_rgb_range[id]);
if(tp.size()){
Index: src/config.hpp
===================================================================
--- src/config.hpp (revision 33970)
+++ src/config.hpp (working copy)
@@ -150,6 +150,43 @@
private:
Itor i_;
};
+
+ class proxy_string
+ {
+ config& owner;
+ const std::string& key;
+
+ t_string& real_str() { return owner.values[key]; }
+ const t_string& real_str() const { return owner.values[key]; }
+ public:
+ proxy_string (config& owner, const std::string& key) : owner (owner), key (key) {}
+
+ proxy_string& operator= (const proxy_string& other)
+ { return this->operator= (other.real_str()); }
+
+ proxy_string& operator= (const char* str)
+ { real_str() = str; return *this; }
+ proxy_string& operator= (const t_string& str)
+ { real_str() = str; return *this; }
+ proxy_string& operator= (const std::string& str)
+ { real_str() = str; return *this; }
+
+ proxy_string& operator+= (const std::string& str)
+ { real_str() += str; return *this; }
+
+ // t_string 'emulation' methods
+ bool empty() const { return real_str().empty(); }
+ const char* c_str() const { return real_str().c_str(); }
+ std::string to_serialized() const { return real_str().to_serialized(); }
+
+ const std::string& str() const { return real_str().str(); }
+ const t_string& t_str() const { return real_str(); }
+ operator std::string () const { return real_str().str(); }
+ operator t_string() const { return real_str(); }
+
+ inline friend std::ostream& operator<<(std::ostream& os, const proxy_string& str)
+ { return os << str.real_str(); }
+ };

typedef std::pair<const_attribute_iterator,const_attribute_iterator> const_attr_itors;

@@ -167,7 +204,10 @@
config& add_child(const std::string& key);
config& add_child(const std::string& key, const config& val);
config& add_child_at(const std::string& key, const config& val, size_t index);
- t_string& operator[](const std::string& key);
+
+ //t_string& operator[](const std::string& key);
+ proxy_string operator[](const std::string& key)
+ { return proxy_string (*this, key); }
const t_string& operator[](const std::string& key) const;

const t_string& get_attribute(const std::string& key) const;
Index: src/game_events.cpp
===================================================================
--- src/game_events.cpp (revision 33970)
+++ src/game_events.cpp (working copy)
@@ -88,10 +88,10 @@
class pump_manager {
public:
pump_manager() :
- x1_(state_of_game->get_variable("x1")),
- x2_(state_of_game->get_variable("x2")),
- y1_(state_of_game->get_variable("y1")),
- y2_(state_of_game->get_variable("y2"))
+ x1_(state_of_game->get_variable("x1").str()),
+ x2_(state_of_game->get_variable("x2").str()),
+ y1_(state_of_game->get_variable("y1").str()),
+ y2_(state_of_game->get_variable("y2").str())
{
++instance_count;
}
@@ -856,7 +856,7 @@

static void store_gold_side(bool store_side, const vconfig& cfg)
{
- t_string *gold_store;
+ config::proxy_string *gold_store = 0;
std::string side = cfg["side"];
std::string var_name = cfg["variable"];
if(var_name.empty()) {
@@ -882,11 +882,12 @@
state_of_game->get_variable(var_name+".user_team_name") = (*teams)[team_index].user_team_name();
state_of_game->get_variable(var_name+".colour") = (*teams)[team_index].map_colour_to();

- gold_store = &state_of_game->get_variable(var_name+".gold");
+ gold_store = new config::proxy_string (state_of_game->get_variable(var_name+".gold"));
} else {
- gold_store = &state_of_game->get_variable(var_name);
+ gold_store = new config::proxy_string (state_of_game->get_variable(var_name));
}
*gold_store = lexical_cast_default<std::string>((*teams)[team_index].gold(),"");
+ delete gold_store;
}
}

@@ -1158,7 +1159,7 @@
assert(state_of_game != NULL);

const std::string name = cfg["name"];
- t_string& var = state_of_game->get_variable(name);
+ config::proxy_string var = state_of_game->get_variable(name);

const t_string& literal = cfg.get_attribute("literal"); // no $var substitution
if(literal.empty() == false) {
@@ -1191,7 +1192,7 @@

const std::string multiply = cfg["multiply"];
if(multiply.empty() == false) {
- if(isint(var) && isint(multiply)) {
+ if(isint(var.str()) && isint(multiply)) {
var = str_cast( std::atoi(var.c_str()) * std::atoi(multiply.c_str()) );
} else {
var = str_cast( std::atof(var.c_str()) * std::atof(multiply.c_str()) );
@@ -1204,7 +1205,7 @@
ERR_NG << "division by zero on variable " << name << "\n";
return;
}
- if(isint(var) && isint(divide)) {
+ if(isint(var.str()) && isint(divide)) {
var = str_cast( std::atoi(var.c_str()) / std::atoi(divide.c_str()) );
} else {
var = str_cast( std::atof(var.c_str()) / std::atof(divide.c_str()) );
@@ -1217,7 +1218,7 @@
ERR_NG << "division by zero on variable " << name << "\n";
return;
}
- if(isint(var) && isint(modulo)) {
+ if(isint(var.str()) && isint(modulo)) {
var = str_cast( std::atoi(var.c_str()) % std::atoi(modulo.c_str()) );
} else {
double value = std::fmod( std::atof(var.c_str()), std::atof(modulo.c_str()) );
Index: src/gui/dialogs/addon_list.cpp
===================================================================
--- src/gui/dialogs/addon_list.cpp (revision 33970)
+++ src/gui/dialogs/addon_list.cpp (working copy)
@@ -74,10 +74,10 @@
item["label"] = tmp;
data.insert(std::make_pair("author", item));

- item["label"] = (**itor)["downloads"];
+ item["label"] = (**itor)["downloads"].t_str();
data.insert(std::make_pair("downloads", item));

- item["label"] = (**itor)["size"];
+ item["label"] = (**itor)["size"].t_str();
data.insert(std::make_pair("size", item));

list->add_row(data);
Index: src/unit_types.cpp
===================================================================
--- src/unit_types.cpp (revision 33970)
+++ src/unit_types.cpp (working copy)
@@ -791,8 +791,8 @@
build_created(cfg, mv_types, races, traits);
}

- type_name_ = cfg_["name"];
- description_ = cfg_["description"];
+ type_name_ = cfg_["name"].t_str();
+ description_ = cfg_["description"].t_str();
hitpoints_ = lexical_cast_default<int>(cfg["hitpoints"], 1);
level_ = lexical_cast_default<int>(cfg["level"], 0);
movement_ = lexical_cast_default<int>(cfg["movement"], 1);
Index: src/gamestatus.hpp
===================================================================
--- src/gamestatus.hpp (revision 33970)
+++ src/gamestatus.hpp (working copy)
@@ -120,7 +120,7 @@

// Variable access

- t_string& get_variable(const std::string& varname);
+ config::proxy_string get_variable(const std::string& varname);
virtual const t_string& get_variable_const(const std::string& varname) const;
config& get_variable_cfg(const std::string& varname);
variable_info::array_range get_variable_cfgs(const std::string& varname);
@@ -165,6 +165,7 @@
rand_rng::simple_rng rng_ ;
config variables;
mutable config temporaries; // lengths of arrays, etc.
+ mutable string_map save_t_string;
const rand_rng::set_random_generator generator_setter; /**< Make sure that rng is initialized first */
friend struct variable_info;
};
Index: src/variable.cpp
===================================================================
--- src/variable.cpp (revision 33970)
+++ src/variable.cpp (working copy)
@@ -713,7 +713,7 @@
}
}

-t_string& variable_info::as_scalar() {
+config::proxy_string variable_info::as_scalar() {
assert(is_valid);
return (*vars)[key];
}
Index: src/multiplayer_connect.cpp
===================================================================
--- src/multiplayer_connect.cpp (revision 33970)
+++ src/multiplayer_connect.cpp (working copy)
@@ -1439,8 +1439,8 @@
int side_num = 1;
foreach (config &side, sides)
{
- t_string &team_name = side["team_name"];
- t_string &user_team_name = side["user_team_name"];
+ config::proxy_string team_name = side["team_name"];
+ config::proxy_string user_team_name = side["user_team_name"];

if(team_name.empty())
team_name = lexical_cast<std::string>(side_num);
@@ -1465,7 +1465,7 @@
foreach (config &side, sides)
{
const std::string side_num = lexical_cast<std::string>(_side_num);
- t_string &team_name = side["team_name"];
+ config::proxy_string team_name = side["team_name"];

if(team_name.empty())
team_name = side_num;
</pre>

SummerOfCodeProposal res

2009-03-22T15:13:37Z

Res: New page: = A bit about me = My name is Frank Richter, currently studying Computer Sciences at the University of Jena (that's in Germany). As far as C++ is concerned, I program in it since at leas...

= A bit about me =

My name is Frank Richter, currently studying Computer Sciences at the University of Jena (that's in Germany).

As far as C++ is concerned, I program in it since at least seven years now. In my spare time I also develop for Crystal Space, an open source 3D engine. While I did a lot in the topics of realtime 3D, OpenGL, shaders and such, I also did (and do) 'low-level' things like cross-platform services and, last, but in this context here now certainly not least, matters of ''memory optimization''.

= Current status =

* Upon reading the blog post linked in the idea proposal my first thought was to use a proxy class for operator[]. Below a patch that implements it.

== Proxy class patch ==

This builds and, I believe, works, but has a number of not-so-nice issues:
* Some places store return values in <pre>t_string&</pre>. The idea is to change these to <pre>config::proxy_string</pre>, as that type should ideally behave like <pre>t_string&</pre>.
* <pre>config::proxy_string</pre> can cast to both <pre>std::string</pre> and <pre>t_string</pre>.
The first is necessary as <pre>t_string</pre> can cast to it as well; the second is necessary to
support use of a <pre>config::proxy_string</pre> where a <pre>const t_string&</pre> is expected.
Unfortunately, this introduces an ambiguity in cases where a <pre>config::proxy_string</pre> is passed to methods that can take either of <pre>std::string</pre> or <pre>t_string</pre>.
* the <pre>variables_set</pre> class has a member (<pre>get_variable_const()</pre>) that returns a <pre>t_string&</pre>. <pre>game_state</pre> descends from this class; it's <pre>get_variable_const()</pre> implementation supposedly returns a value from a <pre>config</pre>. To ensure the ref is valid, the value as a <pre>t_string</pre> is stored in a map. This is clearly not ideal.

<pre>
Index: src/config.cpp
===================================================================
--- src/config.cpp (revision 33970)
+++ src/config.cpp (working copy)
@@ -293,10 +293,12 @@
delete res;
}

+/*
t_string& config::operator[](const std::string& key)
{
return values[key];
}
+*/

const t_string& config::operator[](const std::string& key) const
{
Index: src/font.cpp
===================================================================
--- src/font.cpp (revision 33970)
+++ src/font.cpp (working copy)
@@ -1278,7 +1278,7 @@
known_fonts.insert(font["name"]);
}

- font_order = (*fonts_config)["order"];
+ font_order = (*fonts_config)["order"].t_str();
const std::vector<std::string> font_order = utils::split((*fonts_config)["order"]);
std::vector<font::subset_descriptor> fontlist;
std::vector<std::string>::const_iterator font;
Index: src/playsingle_controller.cpp
===================================================================
--- src/playsingle_controller.cpp (revision 33970)
+++ src/playsingle_controller.cpp (working copy)
@@ -281,7 +281,7 @@
// Log before prestart events: they do weird things.
if (first_human_team_ != -1) {
log.start(gamestate_, teams_[first_human_team_], first_human_team_ + 1, units_,
- loading_game_ ? gamestate_.get_variable("turn_number") : "", status_.number_of_turns());
+ loading_game_ ? gamestate_.get_variable("turn_number").c_str() : "", status_.number_of_turns());
}

fire_prestart(!loading_game_);
Index: src/gamestatus.cpp
===================================================================
--- src/gamestatus.cpp (revision 33970)
+++ src/gamestatus.cpp (working copy)
@@ -1166,7 +1166,7 @@
}
}

-t_string& game_state::get_variable(const std::string& key)
+config::proxy_string game_state::get_variable(const std::string& key)
{
return variable_info(key, true, variable_info::TYPE_SCALAR).as_scalar();
}
@@ -1174,8 +1174,9 @@
const t_string& game_state::get_variable_const(const std::string& key) const
{
variable_info to_get(key, false, variable_info::TYPE_SCALAR);
- if(!to_get.is_valid) return temporaries[key];
- return to_get.as_scalar();
+ config::proxy_string val ((!to_get.is_valid) ? temporaries[key] : to_get.as_scalar());
+ save_t_string[key] = val.t_str();
+ return save_t_string[key];
}

config& game_state::get_variable_cfg(const std::string& key)
Index: src/theme.cpp
===================================================================
--- src/theme.cpp (revision 33970)
+++ src/theme.cpp (working copy)
@@ -169,13 +169,13 @@
// follow the inheritance hierarchy and push all the nodes on the stack
std::vector<const config*> parent_stack(1, (*i));
const config* parent;
- const t_string* parent_id = &((**i)["inherits"]);
- while((parent = top_cfg.find_child("resolution", "id", (*parent_id))) == NULL) {
- parent = top_cfg.find_child("partialresolution", "id", (*parent_id));
+ t_string parent_id = ((**i)["inherits"]);
+ while((parent = top_cfg.find_child("resolution", "id", parent_id)) == NULL) {
+ parent = top_cfg.find_child("partialresolution", "id", parent_id);
if(parent == NULL)
- throw config::error("[partialresolution] refers to non-existant [resolution] " + (*parent_id).str());
+ throw config::error("[partialresolution] refers to non-existant [resolution] " + parent_id.str());
parent_stack.push_back(parent);
- parent_id = &((*parent)["inherits"]);
+ parent_id = ((*parent)["inherits"]);
}

// Add the parent resolution and apply all the modifications of its children
Index: src/variable.hpp
===================================================================
--- src/variable.hpp (revision 33970)
+++ src/variable.hpp (working copy)
@@ -206,7 +206,7 @@
* Results: after deciding the desired type, these methods can retrieve the result
* Note: first you should force_valid or check is_valid, otherwise these may fail
*/
- t_string& as_scalar();
+ config::proxy_string as_scalar();
config& as_container();
array_range as_array(); //range may be empty
};
Index: src/game_config.cpp
===================================================================
--- src/game_config.cpp (revision 33970)
+++ src/game_config.cpp (working copy)
@@ -239,7 +239,7 @@
std::string id = (**teamC)["id"];
std::vector<Uint32> temp = string2rgb((**teamC)["rgb"]);
team_rgb_range.insert(std::make_pair(id,color_range(temp)));
- team_rgb_name[id] = (**teamC)["name"];
+ team_rgb_name[id] = (**teamC)["name"].t_str();
//generate palette of same name;
std::vector<Uint32> tp = palette(team_rgb_range[id]);
if(tp.size()){
Index: src/config.hpp
===================================================================
--- src/config.hpp (revision 33970)
+++ src/config.hpp (working copy)
@@ -150,6 +150,43 @@
private:
Itor i_;
};
+
+ class proxy_string
+ {
+ config& owner;
+ const std::string& key;
+
+ t_string& real_str() { return owner.values[key]; }
+ const t_string& real_str() const { return owner.values[key]; }
+ public:
+ proxy_string (config& owner, const std::string& key) : owner (owner), key (key) {}
+
+ proxy_string& operator= (const proxy_string& other)
+ { return this->operator= (other.real_str()); }
+
+ proxy_string& operator= (const char* str)
+ { real_str() = str; return *this; }
+ proxy_string& operator= (const t_string& str)
+ { real_str() = str; return *this; }
+ proxy_string& operator= (const std::string& str)
+ { real_str() = str; return *this; }
+
+ proxy_string& operator+= (const std::string& str)
+ { real_str() += str; return *this; }
+
+ // t_string 'emulation' methods
+ bool empty() const { return real_str().empty(); }
+ const char* c_str() const { return real_str().c_str(); }
+ std::string to_serialized() const { return real_str().to_serialized(); }
+
+ const std::string& str() const { return real_str().str(); }
+ const t_string& t_str() const { return real_str(); }
+ operator std::string () const { return real_str().str(); }
+ operator t_string() const { return real_str(); }
+
+ inline friend std::ostream& operator<<(std::ostream& os, const proxy_string& str)
+ { return os << str.real_str(); }
+ };

typedef std::pair<const_attribute_iterator,const_attribute_iterator> const_attr_itors;

@@ -167,7 +204,10 @@
config& add_child(const std::string& key);
config& add_child(const std::string& key, const config& val);
config& add_child_at(const std::string& key, const config& val, size_t index);
- t_string& operator[](const std::string& key);
+
+ //t_string& operator[](const std::string& key);
+ proxy_string operator[](const std::string& key)
+ { return proxy_string (*this, key); }
const t_string& operator[](const std::string& key) const;

const t_string& get_attribute(const std::string& key) const;
Index: src/game_events.cpp
===================================================================
--- src/game_events.cpp (revision 33970)
+++ src/game_events.cpp (working copy)
@@ -88,10 +88,10 @@
class pump_manager {
public:
pump_manager() :
- x1_(state_of_game->get_variable("x1")),
- x2_(state_of_game->get_variable("x2")),
- y1_(state_of_game->get_variable("y1")),
- y2_(state_of_game->get_variable("y2"))
+ x1_(state_of_game->get_variable("x1").str()),
+ x2_(state_of_game->get_variable("x2").str()),
+ y1_(state_of_game->get_variable("y1").str()),
+ y2_(state_of_game->get_variable("y2").str())
{
++instance_count;
}
@@ -856,7 +856,7 @@

static void store_gold_side(bool store_side, const vconfig& cfg)
{
- t_string *gold_store;
+ config::proxy_string *gold_store = 0;
std::string side = cfg["side"];
std::string var_name = cfg["variable"];
if(var_name.empty()) {
@@ -882,11 +882,12 @@
state_of_game->get_variable(var_name+".user_team_name") = (*teams)[team_index].user_team_name();
state_of_game->get_variable(var_name+".colour") = (*teams)[team_index].map_colour_to();

- gold_store = &state_of_game->get_variable(var_name+".gold");
+ gold_store = new config::proxy_string (state_of_game->get_variable(var_name+".gold"));
} else {
- gold_store = &state_of_game->get_variable(var_name);
+ gold_store = new config::proxy_string (state_of_game->get_variable(var_name));
}
*gold_store = lexical_cast_default<std::string>((*teams)[team_index].gold(),"");
+ delete gold_store;
}
}

@@ -1158,7 +1159,7 @@
assert(state_of_game != NULL);

const std::string name = cfg["name"];
- t_string& var = state_of_game->get_variable(name);
+ config::proxy_string var = state_of_game->get_variable(name);

const t_string& literal = cfg.get_attribute("literal"); // no $var substitution
if(literal.empty() == false) {
@@ -1191,7 +1192,7 @@

const std::string multiply = cfg["multiply"];
if(multiply.empty() == false) {
- if(isint(var) && isint(multiply)) {
+ if(isint(var.str()) && isint(multiply)) {
var = str_cast( std::atoi(var.c_str()) * std::atoi(multiply.c_str()) );
} else {
var = str_cast( std::atof(var.c_str()) * std::atof(multiply.c_str()) );
@@ -1204,7 +1205,7 @@
ERR_NG << "division by zero on variable " << name << "\n";
return;
}
- if(isint(var) && isint(divide)) {
+ if(isint(var.str()) && isint(divide)) {
var = str_cast( std::atoi(var.c_str()) / std::atoi(divide.c_str()) );
} else {
var = str_cast( std::atof(var.c_str()) / std::atof(divide.c_str()) );
@@ -1217,7 +1218,7 @@
ERR_NG << "division by zero on variable " << name << "\n";
return;
}
- if(isint(var) && isint(modulo)) {
+ if(isint(var.str()) && isint(modulo)) {
var = str_cast( std::atoi(var.c_str()) % std::atoi(modulo.c_str()) );
} else {
double value = std::fmod( std::atof(var.c_str()), std::atof(modulo.c_str()) );
Index: src/gui/dialogs/addon_list.cpp
===================================================================
--- src/gui/dialogs/addon_list.cpp (revision 33970)
+++ src/gui/dialogs/addon_list.cpp (working copy)
@@ -74,10 +74,10 @@
item["label"] = tmp;
data.insert(std::make_pair("author", item));

- item["label"] = (**itor)["downloads"];
+ item["label"] = (**itor)["downloads"].t_str();
data.insert(std::make_pair("downloads", item));

- item["label"] = (**itor)["size"];
+ item["label"] = (**itor)["size"].t_str();
data.insert(std::make_pair("size", item));

list->add_row(data);
Index: src/unit_types.cpp
===================================================================
--- src/unit_types.cpp (revision 33970)
+++ src/unit_types.cpp (working copy)
@@ -791,8 +791,8 @@
build_created(cfg, mv_types, races, traits);
}

- type_name_ = cfg_["name"];
- description_ = cfg_["description"];
+ type_name_ = cfg_["name"].t_str();
+ description_ = cfg_["description"].t_str();
hitpoints_ = lexical_cast_default<int>(cfg["hitpoints"], 1);
level_ = lexical_cast_default<int>(cfg["level"], 0);
movement_ = lexical_cast_default<int>(cfg["movement"], 1);
Index: src/gamestatus.hpp
===================================================================
--- src/gamestatus.hpp (revision 33970)
+++ src/gamestatus.hpp (working copy)
@@ -120,7 +120,7 @@

// Variable access

- t_string& get_variable(const std::string& varname);
+ config::proxy_string get_variable(const std::string& varname);
virtual const t_string& get_variable_const(const std::string& varname) const;
config& get_variable_cfg(const std::string& varname);
variable_info::array_range get_variable_cfgs(const std::string& varname);
@@ -165,6 +165,7 @@
rand_rng::simple_rng rng_ ;
config variables;
mutable config temporaries; // lengths of arrays, etc.
+ mutable string_map save_t_string;
const rand_rng::set_random_generator generator_setter; /**< Make sure that rng is initialized first */
friend struct variable_info;
};
Index: src/variable.cpp
===================================================================
--- src/variable.cpp (revision 33970)
+++ src/variable.cpp (working copy)
@@ -713,7 +713,7 @@
}
}

-t_string& variable_info::as_scalar() {
+config::proxy_string variable_info::as_scalar() {
assert(is_valid);
return (*vars)[key];
}
Index: src/multiplayer_connect.cpp
===================================================================
--- src/multiplayer_connect.cpp (revision 33970)
+++ src/multiplayer_connect.cpp (working copy)
@@ -1439,8 +1439,8 @@
int side_num = 1;
foreach (config &side, sides)
{
- t_string &team_name = side["team_name"];
- t_string &user_team_name = side["user_team_name"];
+ config::proxy_string team_name = side["team_name"];
+ config::proxy_string user_team_name = side["user_team_name"];

if(team_name.empty())
team_name = lexical_cast<std::string>(side_num);
@@ -1465,7 +1465,7 @@
foreach (config &side, sides)
{
const std::string side_num = lexical_cast<std::string>(_side_num);
- t_string &team_name = side["team_name"];
+ config::proxy_string team_name = side["team_name"];

if(team_name.empty())
team_name = side_num;
</pre>

SummerOfCodeIdeas

2009-03-22T14:56:58Z

Res: /* GSoC Student pages */

This is a compilation of ideas from ML. Needs to be refined (more detailed description, deliverables, workload estimation?):

== I want to be one of your Google Summer of Code students, what should I do... ==

Here is a quick list of things to do to get you started
* Create an account on gna.org
* Create an account on the wesnoth forum, and tell an admin on the IRC channel to mark is as a GSoC Student account (Admins are boucman, Ivanovic, mordante, Shadow_Master, Sirp and Turuk)
* Join the irc channel (#wesnoth-dev on irc.freenode.net) and introduce yourself. We will not give formal interviews, but we will clearly favor people we have learned to know during the selection process (basically communication via IRC is mandatory for our project! it is the main way of "every day communication" for Wesnoth. For the same reason, it's also a good idea to regularly read the [http://wesnoth.debian.net/?C=M;O=A IRC logs].).

* Start a wiki page about your idea, add a link on the bottom of this page and add this information on it:
** List your account names (gna, forum, irc nick) so that we can recognize you
** Fill the questionnaire on this page: [[SoC_Information_for_Google#Does_your_organization_have_an_application_template_you_would_like_to_see_students_use.3F_If_so.2C_please_provide_it_now.| List of questions to answer]]
** Detail your idea as much as possible, look at other students pages, and please give milestones and studies you've done
** Add a link to the page at the bottom of this page

* Though not mandatory, it is highly advisable to go to the [[EasyCoding]] and [[NotSoEasyCoding]] pages and implement one of these ideas (or any idea of similar scope) so we have an idea how you work. Be sure to use your gna account when submitting these patches so we know who it is coming from. You can also implement some features from our feature request database at gna. When you implement something, also list it on your own page with a reference to the patch.

* For working on Wesnoth you have to be able to compile trunk. To do so you should have a look at the [[WesnothSVN|page about svn]] and afterwards [[CompilingWesnoth|compile Wesnoth svn]].

* Once you have everything done here and think your idea is okay, go to [http://groups.google.com/group/google-summer-of-code-announce/web/guide-to-the-gsoc-web-app-for-student-applicants page at google] to submit your application. You have to submit it before '''Date to be supplied later''' or you have no chance to get in!

== List of Ideas for the Project (Suggestions from the wesnoth developers) ==

Here is only a short description of possible Ideas we have, each has a page of its own with a more detailed version on it.

=== Optimize implementation of WML for memory usage ===

Based on this idea: [http://dave.wesnoth.org/?p=9] optimize WML to minimize its memory usage. High memory usage has been a problem for Wesnoth, and this project will aim to reduce it.

=== Implement campaign statistics reports on stats.wesnoth.org ===

Wesnoth has an infrastructure which records details of campaigns that players play into a centralized MySQL database. However, we only have rudimentary reports based on this MySQL database available at this time, at [http://stats.wesnoth.org].

This project would involve writing a stats reporting web site which would take the data from the MySQL database and produce reports in chart and table form. Campaign designers would be able to use these reports to gather feedback on their campaigns and get ideas for improvements.

A student could largely make their choice of infrastructure for creating the Website -- whether they prefer Python, Perl, Ruby, PHP, etc. This is a great opportunity for someone who doesn't want to dive into hardcore C++ to make a valuable contribution to Wesnoth.

[[SoC Ideas Stats Server]] - Full Version of the idea, with detailed information

=== Extending the Multiplayer server ===

Our multiplayer community is generally strong and healthy, but we believe its growth is limited by some problems in the interface of the multiplayer lobby.

[[SoC Ideas Multiplayer server]] - Full version of the idea, with detailed information

=== Addon server ===
Wesnoth has an addon server which offers users to upload user
made content (UMC). This allows all other users of Wesnoth
to easily download and install this content. The server was
originally written for user-made campaigns but contains a lot
more types of addons nowadays. Both the server side and the
client side need to be improved.

[[SoC Ideas Addon Server]] - Full version of the idea, with detailed information

=== WML validation schemes ===
Wesnoth uses WML as basic data structure. Over the years
this language has evolved and got more complex. At the
moment the WML is validated at runtime and in case of a
problem the engine stops. With schemes these problems can
be validated when loading the WML, making it easier to find
problems before running into them.

[[SoC Ideas Schemes]] - Full version of the idea, with detailed information

=== Write a primitive library for Formula AI ===

Wesnoth has always had a simple C++ based AI. David (our lead developer) has been working on a simple language to write AI in Wesnoth: [[FormulaAI]]

The Wesnoth AI is used as an opponent in most campaigns, and as such is an important piece of code for the Wesnoth project. Unfortunately, because the skills required to understand and modify it are rather arcane, it is also one of the most neglected parts of the Wesnoth code. This is a place where a lot of research and useful work could be done. But keep in mind that [[WhyWritingAWesnothAIIsHard|writing an AI for Wesnoth is difficult]].

Writing a whole AI is so complicated that we believe it can't be done in a single Summer of code. All proposals should keep that in mind and try to identify an interesting subset that would be workable in the limited time of a summer of code

[[SoC Ideas FormulaAI]] - Full version of the idea, with detailed information

=== Savegame reorganization ===
The savegame formats of Wesnoth for single player campaigns
and multiplayer differ from each other. And they are processed
differently as well. Now there is an additional request coming
up: Multiplayer campaigns. The task will be to unify the savegames
for all types of scenarios in order to provide a maintainable code
again.

[[SoC Ideas Savegame]] - Full version of the idea, with detailed information

=== Other possible ideas to be fleshed out ===
A MapGenerator rewrite - better scalable for outdoor maps, plus the possibility to define areas (similar to the caverns in the cave generator) etc.

=== Make your own ideas ===
If you have your own idea the best thing is to join IRC wesnoth-dev at irc.freenode.net and discuss the idea with the developers there. If the developers think your idea is interesting and like the feature you can start to turn it into a full proposal. Once done discuss it again on IRC so the developers can accept your idea.

== Information about our Project ==
The information we provided google with about our project can be looked up at the site [[SoC Information for Google]].

Also see the [[DeveloperResources]] link (from the [[Project]] page).

== People to bug on IRC ==
We have prepared a list of people with their "area of competence". This is to give you an idea on which areas those people can be of help for you. Of course you should always just ask in the IRC chan, but those are the most likely ones to answer questions in the respective area. And here is the list:

[[SoC People to bug on IRC]]

== GSoC Student pages ==

Please add a link to your wiki page below

[[SummerOfCodeProposal_Velory| Velory - SoC Proposal]]

[[SummerOfCodeProposal_AI_Improvement_Crab| Crab - SoC Proposal - AI Improvement]]

[[SummerOfCodeProposal_Sparksteel | Sparksteel - Improving the AI engine design]]

[[SummerOfCodeProposal_Euschn | Euschn - Savegame reorganization]]

[[SummerOfCodeProposal_rubend | rubend - Extending the Multiplayer server]]

[[SummerOfCodeProposal_Ryochan7| Ryochan7 - Addon server]]

[[SummerOfCodeProposal_iyonius| iyonius - Addon server]]

[[SummerOfCodeProposal_res| res - Optimize implementation of WML for memory usage ]]

[[Category:Summer of Code|*]]