Mirrorlandia_minetest/minetest
1
0
Fork 1
mirror of https://github.com/minetest/minetest.git synced 2024-11-27 01:53:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

refacto: rework the GUI element handler function (#14793)

Browse Source 
We have a very very old way to perform this handling.
With this new method, we have a more proper and flexible way to extend our UI with comprehensible handlers with common interface parameters

In terms of performance, it took very few more more memory and scraping is more faster, using the unordered_map benefits
This commit is contained in:
Loïc Blot 2024-08-12 18:52:33 +02:00 committed by GitHub
parent 98e51a0159
commit cb0bbea2a5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 97 additions and 216 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

293
src/gui/guiFormSpecMenu.cpp
View File

@ -342,7 +342,7 @@ void GUIFormSpecMenu::parseContainer(parserData* data, const std::string &elemen
errorstream<< "Invalid container start element (" << parts.size() << "): '" << element << "'" << std::endl; errorstream<< "Invalid container start element (" << parts.size() << "): '" << element << "'" << std::endl;
} }
void GUIFormSpecMenu::parseContainerEnd(parserData* data) void GUIFormSpecMenu::parseContainerEnd(parserData* data, const std::string &)
{ {
if (container_stack.empty()) { if (container_stack.empty()) {
errorstream<< "Invalid container end element, no matching container start element" << std::endl; errorstream<< "Invalid container end element, no matching container start element" << std::endl;
@ -419,7 +419,7 @@ void GUIFormSpecMenu::parseScrollContainer(parserData *data, const std::string &
pos_offset.Y = 0.0f; pos_offset.Y = 0.0f;
} }
void GUIFormSpecMenu::parseScrollContainerEnd(parserData *data) void GUIFormSpecMenu::parseScrollContainerEnd(parserData *data, const std::string &)
{ {
if (data->current_parent == this || data->current_parent->getParent() == this || if (data->current_parent == this || data->current_parent->getParent() == this ||
container_stack.empty()) { container_stack.empty()) {
@ -641,6 +641,11 @@ void GUIFormSpecMenu::parseCheckbox(parserData* data, const std::string &element
m_fields.push_back(spec); m_fields.push_back(spec);
} }
void GUIFormSpecMenu::parseRealCoordinates(parserData* data, const std::string &element)
{
data->real_coordinates = is_yes(element);
}
void GUIFormSpecMenu::parseScrollBar(parserData* data, const std::string &element) void GUIFormSpecMenu::parseScrollBar(parserData* data, const std::string &element)
{ {
std::vector<std::string> parts; std::vector<std::string> parts;
@ -973,10 +978,9 @@ void GUIFormSpecMenu::parseItemImage(parserData* data, const std::string &elemen
m_fields.push_back(spec); m_fields.push_back(spec);
} }
void GUIFormSpecMenu::parseButton(parserData* data, const std::string &element, void GUIFormSpecMenu::parseButton(parserData* data, const std::string &element)
const std::string &type)
{ {
int expected_parts = (type == "button_url" || type == "button_url_exit") ? 5 : 4; int expected_parts = (data->type == "button_url" || data->type == "button_url_exit") ? 5 : 4;
std::vector<std::string> parts; std::vector<std::string> parts;
if (!precheckElement("button", element, expected_parts, expected_parts, parts)) if (!precheckElement("button", element, expected_parts, expected_parts, parts))
return; return;
@ -986,7 +990,7 @@ void GUIFormSpecMenu::parseButton(parserData* data, const std::string &element,
std::string name = parts[2]; std::string name = parts[2];
std::string label = parts[3]; std::string label = parts[3];
std::string url; std::string url;
if (type == "button_url" || type == "button_url_exit") if (data->type == "button_url" || data->type == "button_url_exit")
url = parts[4]; url = parts[4];
MY_CHECKPOS("button",0); MY_CHECKPOS("button",0);
@ -1022,15 +1026,15 @@ void GUIFormSpecMenu::parseButton(parserData* data, const std::string &element,
258 + m_fields.size() 258 + m_fields.size()
); );
spec.ftype = f_Button; spec.ftype = f_Button;
if (type == "button_exit" || type == "button_url_exit") if (data->type == "button_exit" || data->type == "button_url_exit")
spec.is_exit = true; spec.is_exit = true;
if (type == "button_url" || type == "button_url_exit") if (data->type == "button_url" || data->type == "button_url_exit")
spec.url = url; spec.url = url;
GUIButton *e = GUIButton::addButton(Environment, rect, m_tsrc, GUIButton *e = GUIButton::addButton(Environment, rect, m_tsrc,
data->current_parent, spec.fid, spec.flabel.c_str()); data->current_parent, spec.fid, spec.flabel.c_str());
auto style = getStyleForElement(type, name, (type != "button") ? "button" : ""); auto style = getStyleForElement(data->type, name, (data->type != "button") ? "button" : "");
spec.sound = style[StyleSpec::STATE_DEFAULT].get(StyleSpec::Property::SOUND, ""); spec.sound = style[StyleSpec::STATE_DEFAULT].get(StyleSpec::Property::SOUND, "");
@ -1690,11 +1694,10 @@ void GUIFormSpecMenu::parseTextArea(parserData* data, std::vector<std::string>&
m_fields.push_back(spec); m_fields.push_back(spec);
} }
void GUIFormSpecMenu::parseField(parserData* data, const std::string &element, void GUIFormSpecMenu::parseField(parserData* data, const std::string &element)
const std::string &type)
{ {
std::vector<std::string> parts; std::vector<std::string> parts;
if (!precheckElement(type, element, 3, 5, parts)) if (!precheckElement(data->type, element, 3, 5, parts))
return; return;
if (parts.size() == 3 || parts.size() == 4) { if (parts.size() == 3 || parts.size() == 4) {
@ -1703,7 +1706,7 @@ void GUIFormSpecMenu::parseField(parserData* data, const std::string &element,
} }
// Else: >= 5 arguments in "parts" // Else: >= 5 arguments in "parts"
parseTextArea(data, parts, type); parseTextArea(data, parts, data->type);
} }
void GUIFormSpecMenu::parseHyperText(parserData *data, const std::string &element) void GUIFormSpecMenu::parseHyperText(parserData *data, const std::string &element)
@ -1926,8 +1929,7 @@ void GUIFormSpecMenu::parseVertLabel(parserData* data, const std::string &elemen
m_clickthrough_elements.push_back(e); m_clickthrough_elements.push_back(e);
} }
void GUIFormSpecMenu::parseImageButton(parserData* data, const std::string &element, void GUIFormSpecMenu::parseImageButton(parserData* data, const std::string &element)
const std::string &type)
{ {
std::vector<std::string> parts; std::vector<std::string> parts;
if (!precheckElement("image_button", element, 5, 8, parts)) if (!precheckElement("image_button", element, 5, 8, parts))
@ -1984,7 +1986,8 @@ void GUIFormSpecMenu::parseImageButton(parserData* data, const std::string &elem
258 + m_fields.size() 258 + m_fields.size()
); );
spec.ftype = f_Button; spec.ftype = f_Button;
if (type == "image_button_exit")
if (data->type == "image_button_exit")
spec.is_exit = true; spec.is_exit = true;
GUIButtonImage *e = GUIButtonImage::addButton(Environment, rect, m_tsrc, GUIButtonImage *e = GUIButtonImage::addButton(Environment, rect, m_tsrc,
@ -2584,14 +2587,21 @@ void GUIFormSpecMenu::parsePadding(parserData *data, const std::string &element)
<< "'" << std::endl; << "'" << std::endl;
} }
bool GUIFormSpecMenu::parseStyle(parserData *data, const std::string &element, bool style_type) void GUIFormSpecMenu::parseStyle(parserData *data, const std::string &element)
{ {
if (data->type != "style" && data->type != "style_type") {
errorstream << "Invalid style element type: '" << data->type << "'" << std::endl;
return;
}
bool style_type = (data->type == "style_type");
std::vector<std::string> parts = split(element, ';'); std::vector<std::string> parts = split(element, ';');
if (parts.size() < 2) { if (parts.size() < 2) {
errorstream << "Invalid style element (" << parts.size() << "): '" << element errorstream << "Invalid style element (" << parts.size() << "): '" << element
<< "'" << std::endl; << "'" << std::endl;
return false; return;
} }
StyleSpec spec; StyleSpec spec;
@ -2602,7 +2612,7 @@ bool GUIFormSpecMenu::parseStyle(parserData *data, const std::string &element, b
if (equal_pos == std::string::npos) { if (equal_pos == std::string::npos) {
errorstream << "Invalid style element (Property missing value): '" << element errorstream << "Invalid style element (Property missing value): '" << element
<< "'" << std::endl; << "'" << std::endl;
return false; return;
} }
std::string propname = trim(parts[i].substr(0, equal_pos)); std::string propname = trim(parts[i].substr(0, equal_pos));
@ -2717,10 +2727,10 @@ bool GUIFormSpecMenu::parseStyle(parserData *data, const std::string &element, b
} }
} }
return true; return;
} }
void GUIFormSpecMenu::parseSetFocus(const std::string &element) void GUIFormSpecMenu::parseSetFocus(parserData*, const std::string &element)
{ {
std::vector<std::string> parts; std::vector<std::string> parts;
if (!precheckElement("set_focus", element, 1, 2, parts)) if (!precheckElement("set_focus", element, 1, 2, parts))
@ -2846,6 +2856,55 @@ void GUIFormSpecMenu::removeAll()
scroll_container_it.second->drop(); scroll_container_it.second->drop();
} }
const std::unordered_map<std::string, std::function<void(GUIFormSpecMenu*, GUIFormSpecMenu::parserData *data,
const std::string &description)>> GUIFormSpecMenu::element_parsers = {
{"container", &GUIFormSpecMenu::parseContainer},
{"container_end", &GUIFormSpecMenu::parseContainerEnd},
{"list", &GUIFormSpecMenu::parseList},
{"listring", &GUIFormSpecMenu::parseListRing},
{"checkbox", &GUIFormSpecMenu::parseCheckbox},
{"image", &GUIFormSpecMenu::parseImage},
{"animated_image", &GUIFormSpecMenu::parseAnimatedImage},
{"item_image", &GUIFormSpecMenu::parseItemImage},
{"button", &GUIFormSpecMenu::parseButton},
{"button_exit", &GUIFormSpecMenu::parseButton},
{"button_url", &GUIFormSpecMenu::parseButton},
{"button_url_exit", &GUIFormSpecMenu::parseButton},
{"background", &GUIFormSpecMenu::parseBackground},
{"background9", &GUIFormSpecMenu::parseBackground},
{"tableoptions", &GUIFormSpecMenu::parseTableOptions},
{"tablecolumns", &GUIFormSpecMenu::parseTableColumns},
{"table", &GUIFormSpecMenu::parseTable},
{"textlist", &GUIFormSpecMenu::parseTextList},
{"dropdown", &GUIFormSpecMenu::parseDropDown},
{"field_enter_after_edit", &GUIFormSpecMenu::parseFieldEnterAfterEdit},
{"field_close_on_enter", &GUIFormSpecMenu::parseFieldCloseOnEnter},
{"pwdfield", &GUIFormSpecMenu::parsePwdField},
{"field", &GUIFormSpecMenu::parseField},
{"textarea", &GUIFormSpecMenu::parseField},
{"hypertext", &GUIFormSpecMenu::parseHyperText},
{"label", &GUIFormSpecMenu::parseLabel},
{"vertlabel", &GUIFormSpecMenu::parseVertLabel},
{"item_image_button", &GUIFormSpecMenu::parseItemImageButton},
{"image_button", &GUIFormSpecMenu::parseImageButton},
{"image_button_exit", &GUIFormSpecMenu::parseImageButton},
{"tabheader", &GUIFormSpecMenu::parseTabHeader},
{"box", &GUIFormSpecMenu::parseBox},
{"bgcolor", &GUIFormSpecMenu::parseBackgroundColor},
{"listcolors", &GUIFormSpecMenu::parseListColors},
{"tooltip", &GUIFormSpecMenu::parseTooltip},
{"scrollbar", &GUIFormSpecMenu::parseScrollBar},
{"real_coordinates", &GUIFormSpecMenu::parseRealCoordinates},
{"style", &GUIFormSpecMenu::parseStyle},
{"style_type", &GUIFormSpecMenu::parseStyle},
{"scrollbaroptions", &GUIFormSpecMenu::parseScrollBarOptions},
{"scroll_container", &GUIFormSpecMenu::parseScrollContainer},
{"scroll_container_end", &GUIFormSpecMenu::parseScrollContainerEnd},
{"set_focus", &GUIFormSpecMenu::parseSetFocus},
{"model", &GUIFormSpecMenu::parseModel},
};
void GUIFormSpecMenu::parseElement(parserData* data, const std::string &element) void GUIFormSpecMenu::parseElement(parserData* data, const std::string &element)
{ {
//some prechecks //some prechecks
@ -2862,195 +2921,15 @@ void GUIFormSpecMenu::parseElement(parserData* data, const std::string &element)
std::string type = trim(element.substr(0, pos)); std::string type = trim(element.substr(0, pos));
std::string description = element.substr(pos+1); std::string description = element.substr(pos+1);
if (type == "container") { // They remain here due to bool flags, for now
parseContainer(data, description); data->type = type;
auto it = element_parsers.find(type);
if (it != element_parsers.end()) {
it->second(this, data, description);
return; return;
} }
if (type == "container_end") {
parseContainerEnd(data);
return;
}
if (type == "list") {
parseList(data, description);
return;
}
if (type == "listring") {
parseListRing(data, description);
return;
}
if (type == "checkbox") {
parseCheckbox(data, description);
return;
}
if (type == "image") {
parseImage(data, description);
return;
}
if (type == "animated_image") {
parseAnimatedImage(data, description);
return;
}
if (type == "item_image") {
parseItemImage(data, description);
return;
}
if (type == "button" || type == "button_exit" || type == "button_url" || type == "button_url_exit") {
parseButton(data, description, type);
return;
}
if (type == "background" || type == "background9") {
parseBackground(data, description);
return;
}
if (type == "tableoptions"){
parseTableOptions(data,description);
return;
}
if (type == "tablecolumns"){
parseTableColumns(data,description);
return;
}
if (type == "table"){
parseTable(data,description);
return;
}
if (type == "textlist"){
parseTextList(data,description);
return;
}
if (type == "dropdown"){
parseDropDown(data,description);
return;
}
if (type == "field_enter_after_edit") {
parseFieldEnterAfterEdit(data, description);
return;
}
if (type == "field_close_on_enter") {
parseFieldCloseOnEnter(data, description);
return;
}
if (type == "pwdfield") {
parsePwdField(data,description);
return;
}
if ((type == "field") || (type == "textarea")){
parseField(data,description,type);
return;
}
if (type == "hypertext") {
parseHyperText(data,description);
return;
}
if (type == "label") {
parseLabel(data,description);
return;
}
if (type == "vertlabel") {
parseVertLabel(data,description);
return;
}
if (type == "item_image_button") {
parseItemImageButton(data,description);
return;
}
if ((type == "image_button") || (type == "image_button_exit")) {
parseImageButton(data,description,type);
return;
}
if (type == "tabheader") {
parseTabHeader(data,description);
return;
}
if (type == "box") {
parseBox(data,description);
return;
}
if (type == "bgcolor") {
parseBackgroundColor(data,description);
return;
}
if (type == "listcolors") {
parseListColors(data,description);
return;
}
if (type == "tooltip") {
parseTooltip(data,description);
return;
}
if (type == "scrollbar") {
parseScrollBar(data, description);
return;
}
if (type == "real_coordinates") {
data->real_coordinates = is_yes(description);
return;
}
if (type == "style") {
parseStyle(data, description, false);
return;
}
if (type == "style_type") {
parseStyle(data, description, true);
return;
}
if (type == "scrollbaroptions") {
parseScrollBarOptions(data, description);
return;
}
if (type == "scroll_container") {
parseScrollContainer(data, description);
return;
}
if (type == "scroll_container_end") {
parseScrollContainerEnd(data);
return;
}
if (type == "set_focus") {
parseSetFocus(description);
return;
}
if (type == "model") {
parseModel(data, description);
return;
}
// Ignore others // Ignore others
infostream << "Unknown DrawSpec: type=" << type << ", data=\"" << description << "\"" infostream << "Unknown DrawSpec: type=" << type << ", data=\"" << description << "\""

20
src/gui/guiFormSpecMenu.h
View File

@ -423,8 +423,11 @@ private:
// used to restore table selection/scroll/treeview state // used to restore table selection/scroll/treeview state
std::unordered_map<std::string, GUITable::DynamicData> table_dyndata; std::unordered_map<std::string, GUITable::DynamicData> table_dyndata;
std::string type;
}; };
static const std::unordered_map<std::string, std::function<void(GUIFormSpecMenu*, GUIFormSpecMenu::parserData *data, const std::string &description)>> element_parsers;
struct fs_key_pending { struct fs_key_pending {
bool key_up; bool key_up;
bool key_down; bool key_down;
@ -442,17 +445,16 @@ private:
void parseSize(parserData* data, const std::string &element); void parseSize(parserData* data, const std::string &element);
void parseContainer(parserData* data, const std::string &element); void parseContainer(parserData* data, const std::string &element);
void parseContainerEnd(parserData* data); void parseContainerEnd(parserData* data, const std::string &element);
void parseScrollContainer(parserData *data, const std::string &element); void parseScrollContainer(parserData *data, const std::string &element);
void parseScrollContainerEnd(parserData *data); void parseScrollContainerEnd(parserData *data, const std::string &element);
void parseList(parserData* data, const std::string &element); void parseList(parserData* data, const std::string &element);
void parseListRing(parserData* data, const std::string &element); void parseListRing(parserData* data, const std::string &element);
void parseCheckbox(parserData* data, const std::string &element); void parseCheckbox(parserData* data, const std::string &element);
void parseImage(parserData* data, const std::string &element); void parseImage(parserData* data, const std::string &element);
void parseAnimatedImage(parserData *data, const std::string &element); void parseAnimatedImage(parserData *data, const std::string &element);
void parseItemImage(parserData* data, const std::string &element); void parseItemImage(parserData* data, const std::string &element);
void parseButton(parserData* data, const std::string &element, void parseButton(parserData* data, const std::string &element);
const std::string &typ);
void parseBackground(parserData* data, const std::string &element); void parseBackground(parserData* data, const std::string &element);
void parseTableOptions(parserData* data, const std::string &element); void parseTableOptions(parserData* data, const std::string &element);
void parseTableColumns(parserData* data, const std::string &element); void parseTableColumns(parserData* data, const std::string &element);
@ -462,7 +464,7 @@ private:
void parseFieldEnterAfterEdit(parserData *data, const std::string &element); void parseFieldEnterAfterEdit(parserData *data, const std::string &element);
void parseFieldCloseOnEnter(parserData *data, const std::string &element); void parseFieldCloseOnEnter(parserData *data, const std::string &element);
void parsePwdField(parserData* data, const std::string &element); void parsePwdField(parserData* data, const std::string &element);
void parseField(parserData* data, const std::string &element, const std::string &type); void parseField(parserData* data, const std::string &element);
void createTextField(parserData *data, FieldSpec &spec, void createTextField(parserData *data, FieldSpec &spec,
core::rect<s32> &rect, bool is_multiline); core::rect<s32> &rect, bool is_multiline);
void parseSimpleField(parserData* data,std::vector<std::string> &parts); void parseSimpleField(parserData* data,std::vector<std::string> &parts);
@ -471,8 +473,7 @@ private:
void parseHyperText(parserData *data, const std::string &element); void parseHyperText(parserData *data, const std::string &element);
void parseLabel(parserData* data, const std::string &element); void parseLabel(parserData* data, const std::string &element);
void parseVertLabel(parserData* data, const std::string &element); void parseVertLabel(parserData* data, const std::string &element);
void parseImageButton(parserData* data, const std::string &element, void parseImageButton(parserData* data, const std::string &element);
const std::string &type);
void parseItemImageButton(parserData* data, const std::string &element); void parseItemImageButton(parserData* data, const std::string &element);
void parseTabHeader(parserData* data, const std::string &element); void parseTabHeader(parserData* data, const std::string &element);
void parseBox(parserData* data, const std::string &element); void parseBox(parserData* data, const std::string &element);
@ -481,6 +482,7 @@ private:
void parseTooltip(parserData* data, const std::string &element); void parseTooltip(parserData* data, const std::string &element);
bool parseVersionDirect(const std::string &data); bool parseVersionDirect(const std::string &data);
bool parseSizeDirect(parserData* data, const std::string &element); bool parseSizeDirect(parserData* data, const std::string &element);
void parseRealCoordinates(parserData* data, const std::string &element);
void parseScrollBar(parserData* data, const std::string &element); void parseScrollBar(parserData* data, const std::string &element);
void parseScrollBarOptions(parserData *data, const std::string &element); void parseScrollBarOptions(parserData *data, const std::string &element);
bool parsePositionDirect(parserData *data, const std::string &element); bool parsePositionDirect(parserData *data, const std::string &element);
@ -489,8 +491,8 @@ private:
void parseAnchor(parserData *data, const std::string &element); void parseAnchor(parserData *data, const std::string &element);
bool parsePaddingDirect(parserData *data, const std::string &element); bool parsePaddingDirect(parserData *data, const std::string &element);
void parsePadding(parserData *data, const std::string &element); void parsePadding(parserData *data, const std::string &element);
bool parseStyle(parserData *data, const std::string &element, bool style_type); void parseStyle(parserData *data, const std::string &element);
void parseSetFocus(const std::string &element); void parseSetFocus(parserData *, const std::string &element);
void parseModel(parserData *data, const std::string &element); void parseModel(parserData *data, const std::string &element);
bool parseMiddleRect(const std::string &value, core::rect<s32> *parsed_rect); bool parseMiddleRect(const std::string &value, core::rect<s32> *parsed_rect);