From 7befa0bdf70800f6b8f1a8c78a14dc37fa78ddb7 Mon Sep 17 00:00:00 2001 From: Loic Blot Date: Fri, 28 Jun 2024 21:48:47 +0200 Subject: [PATCH] refacto: rework the GUI element handler function 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 --- src/gui/guiFormSpecMenu.cpp | 291 +++++++++++------------------------- src/gui/guiFormSpecMenu.h | 21 +-- 2 files changed, 97 insertions(+), 215 deletions(-) diff --git a/src/gui/guiFormSpecMenu.cpp b/src/gui/guiFormSpecMenu.cpp index 98974c6f65557..b72535794bbfb 100644 --- a/src/gui/guiFormSpecMenu.cpp +++ b/src/gui/guiFormSpecMenu.cpp @@ -342,7 +342,7 @@ void GUIFormSpecMenu::parseContainer(parserData* data, const std::string &elemen 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()) { 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; } -void GUIFormSpecMenu::parseScrollContainerEnd(parserData *data) +void GUIFormSpecMenu::parseScrollContainerEnd(parserData *data, const std::string &) { if (data->current_parent == this || data->current_parent->getParent() == this || container_stack.empty()) { @@ -641,6 +641,11 @@ void GUIFormSpecMenu::parseCheckbox(parserData* data, const std::string &element 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) { std::vector parts; @@ -973,10 +978,9 @@ void GUIFormSpecMenu::parseItemImage(parserData* data, const std::string &elemen m_fields.push_back(spec); } -void GUIFormSpecMenu::parseButton(parserData* data, const std::string &element, - const std::string &type) +void GUIFormSpecMenu::parseButton(parserData* data, const std::string &element) { - int expected_parts = (type == "button_url" || type == "button_url_exit") ? 5 : 4; + int expected_parts = (data->parser_type == "button_url" || data->parser_type == "button_url_exit") ? 5 : 4; std::vector parts; if (!precheckElement("button", element, expected_parts, expected_parts, parts)) return; @@ -986,7 +990,7 @@ void GUIFormSpecMenu::parseButton(parserData* data, const std::string &element, std::string name = parts[2]; std::string label = parts[3]; std::string url; - if (type == "button_url" || type == "button_url_exit") + if (data->parser_type == "button_url" || data->parser_type == "button_url_exit") url = parts[4]; MY_CHECKPOS("button",0); @@ -1022,15 +1026,15 @@ void GUIFormSpecMenu::parseButton(parserData* data, const std::string &element, 258 + m_fields.size() ); spec.ftype = f_Button; - if (type == "button_exit" || type == "button_url_exit") + if (data->parser_type == "button_exit" || data->parser_type == "button_url_exit") spec.is_exit = true; - if (type == "button_url" || type == "button_url_exit") + if (data->parser_type == "button_url" || data->parser_type == "button_url_exit") spec.url = url; GUIButton *e = GUIButton::addButton(Environment, rect, m_tsrc, data->current_parent, spec.fid, spec.flabel.c_str()); - auto style = getStyleForElement(type, name, (type != "button") ? "button" : ""); + auto style = getStyleForElement(data->parser_type, name, (data->parser_type != "button") ? "button" : ""); spec.sound = style[StyleSpec::STATE_DEFAULT].get(StyleSpec::Property::SOUND, ""); @@ -1686,11 +1690,10 @@ void GUIFormSpecMenu::parseTextArea(parserData* data, std::vector& m_fields.push_back(spec); } -void GUIFormSpecMenu::parseField(parserData* data, const std::string &element, - const std::string &type) +void GUIFormSpecMenu::parseField(parserData* data, const std::string &element) { std::vector parts; - if (!precheckElement(type, element, 3, 5, parts)) + if (!precheckElement(data->parser_type, element, 3, 5, parts)) return; if (parts.size() == 3 || parts.size() == 4) { @@ -1699,7 +1702,7 @@ void GUIFormSpecMenu::parseField(parserData* data, const std::string &element, } // Else: >= 5 arguments in "parts" - parseTextArea(data, parts, type); + parseTextArea(data, parts, data->parser_type); } void GUIFormSpecMenu::parseHyperText(parserData *data, const std::string &element) @@ -1922,8 +1925,7 @@ void GUIFormSpecMenu::parseVertLabel(parserData* data, const std::string &elemen m_clickthrough_elements.push_back(e); } -void GUIFormSpecMenu::parseImageButton(parserData* data, const std::string &element, - const std::string &type) +void GUIFormSpecMenu::parseImageButton(parserData* data, const std::string &element) { std::vector parts; if (!precheckElement("image_button", element, 5, 8, parts)) @@ -1980,7 +1982,8 @@ void GUIFormSpecMenu::parseImageButton(parserData* data, const std::string &elem 258 + m_fields.size() ); spec.ftype = f_Button; - if (type == "image_button_exit") + + if (data->parser_type == "image_button_exit") spec.is_exit = true; GUIButtonImage *e = GUIButtonImage::addButton(Environment, rect, m_tsrc, @@ -2580,14 +2583,21 @@ void GUIFormSpecMenu::parsePadding(parserData *data, const std::string &element) << "'" << 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->parser_type != "data->parser_type" && data->parser_type != "style_type") { + errorstream << "Invalid style element type: '" << data->parser_type << "'" << std::endl; + return; + } + + bool style_type = (data->parser_type == "style_type"); + std::vector parts = split(element, ';'); if (parts.size() < 2) { errorstream << "Invalid style element (" << parts.size() << "): '" << element << "'" << std::endl; - return false; + return; } StyleSpec spec; @@ -2598,7 +2608,7 @@ bool GUIFormSpecMenu::parseStyle(parserData *data, const std::string &element, b if (equal_pos == std::string::npos) { errorstream << "Invalid style element (Property missing value): '" << element << "'" << std::endl; - return false; + return; } std::string propname = trim(parts[i].substr(0, equal_pos)); @@ -2713,10 +2723,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 parts; if (!precheckElement("set_focus", element, 1, 2, parts)) @@ -2842,6 +2852,55 @@ void GUIFormSpecMenu::removeAll() scroll_container_it.second->drop(); } +const std::unordered_map> 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) { //some prechecks @@ -2858,195 +2917,15 @@ void GUIFormSpecMenu::parseElement(parserData* data, const std::string &element) std::string type = trim(element.substr(0, pos)); std::string description = element.substr(pos+1); - if (type == "container") { - parseContainer(data, description); - 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; - } + // They remain here due to bool flags, for now + data->parser_type = type; - if (type == "textlist"){ - parseTextList(data,description); + auto it = element_parsers.find(type); + if (it != element_parsers.end()) { + it->second(this, 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 infostream << "Unknown DrawSpec: type=" << type << ", data=\"" << description << "\"" diff --git a/src/gui/guiFormSpecMenu.h b/src/gui/guiFormSpecMenu.h index 9ded4c7a8bf98..1c9697a771ee9 100644 --- a/src/gui/guiFormSpecMenu.h +++ b/src/gui/guiFormSpecMenu.h @@ -23,6 +23,7 @@ with this program; if not, write to the Free Software Foundation, Inc., #include #include #include +#include #include "irrlichttypes_extrabloated.h" #include "irr_ptr.h" @@ -423,8 +424,11 @@ class GUIFormSpecMenu : public GUIModalMenu // used to restore table selection/scroll/treeview state std::unordered_map table_dyndata; + std::string parser_type = ""; }; + static const std::unordered_map> element_parsers; + struct fs_key_pending { bool key_up; bool key_down; @@ -442,17 +446,16 @@ class GUIFormSpecMenu : public GUIModalMenu void parseSize(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 parseScrollContainerEnd(parserData *data); + void parseScrollContainerEnd(parserData *data, const std::string &element); void parseList(parserData* data, const std::string &element); void parseListRing(parserData* data, const std::string &element); void parseCheckbox(parserData* data, const std::string &element); void parseImage(parserData* data, const std::string &element); void parseAnimatedImage(parserData *data, const std::string &element); void parseItemImage(parserData* data, const std::string &element); - void parseButton(parserData* data, const std::string &element, - const std::string &typ); + void parseButton(parserData* data, const std::string &element); void parseBackground(parserData* data, const std::string &element); void parseTableOptions(parserData* data, const std::string &element); void parseTableColumns(parserData* data, const std::string &element); @@ -462,7 +465,7 @@ class GUIFormSpecMenu : public GUIModalMenu void parseFieldEnterAfterEdit(parserData *data, const std::string &element); void parseFieldCloseOnEnter(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, core::rect &rect, bool is_multiline); void parseSimpleField(parserData* data,std::vector &parts); @@ -471,8 +474,7 @@ class GUIFormSpecMenu : public GUIModalMenu void parseHyperText(parserData *data, const std::string &element); void parseLabel(parserData* data, const std::string &element); void parseVertLabel(parserData* data, const std::string &element); - void parseImageButton(parserData* data, const std::string &element, - const std::string &type); + void parseImageButton(parserData* data, const std::string &element); void parseItemImageButton(parserData* data, const std::string &element); void parseTabHeader(parserData* data, const std::string &element); void parseBox(parserData* data, const std::string &element); @@ -481,6 +483,7 @@ class GUIFormSpecMenu : public GUIModalMenu void parseTooltip(parserData* data, const std::string &element); bool parseVersionDirect(const std::string &data); 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 parseScrollBarOptions(parserData *data, const std::string &element); bool parsePositionDirect(parserData *data, const std::string &element); @@ -489,8 +492,8 @@ class GUIFormSpecMenu : public GUIModalMenu void parseAnchor(parserData *data, const std::string &element); bool parsePaddingDirect(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 parseSetFocus(const std::string &element); + void parseStyle(parserData *data, const std::string &element); + void parseSetFocus(parserData *, const std::string &element); void parseModel(parserData *data, const std::string &element); bool parseMiddleRect(const std::string &value, core::rect *parsed_rect);