]> git.lizzy.rs Git - minetest.git/blobdiff - src/guiFormSpecMenu.h
Remove superfluous pointer null checks
[minetest.git] / src / guiFormSpecMenu.h
index 15bc628d17296f869b40145111cf9b7f30e03346..d08bb4ab59cdbdebed78c896365a7ea2423c3810 100644 (file)
@@ -22,17 +22,20 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #define GUIINVENTORYMENU_HEADER
 
 #include <utility>
+#include <stack>
 
 #include "irrlichttypes_extrabloated.h"
-#include "inventory.h"
 #include "inventorymanager.h"
 #include "modalMenu.h"
 #include "guiTable.h"
-#include "clientserver.h"
+#include "network/networkprotocol.h"
+#include "client/joystick_controller.h"
+#include "util/string.h"
+#include "util/enriched_string.h"
 
-class IGameDef;
 class InventoryManager;
 class ISimpleTextureSource;
+class Client;
 
 typedef enum {
        f_Button,
@@ -52,12 +55,10 @@ typedef enum {
 
 struct TextDest
 {
-       virtual ~TextDest() {};
+       virtual ~TextDest() {}
        // This is deprecated I guess? -celeron55
-       virtual void gotText(std::wstring text){}
-       virtual void gotText(std::map<std::string, std::string> fields) = 0;
-       virtual void setFormName(std::string formname)
-       { m_formname = formname;};
+       virtual void gotText(const std::wstring &text) {}
+       virtual void gotText(const StringMap &fields) = 0;
 
        std::string m_formname;
 };
@@ -68,30 +69,29 @@ class IFormSource
        virtual ~IFormSource(){}
        virtual std::string getForm() = 0;
        // Fill in variables in field text
-       virtual std::string resolveText(std::string str){ return str; }
+       virtual std::string resolveText(const std::string &str) { return str; }
 };
 
 class GUIFormSpecMenu : public GUIModalMenu
 {
        struct ItemSpec
        {
-               ItemSpec()
+               ItemSpec() :
+                       i(-1)
                {
-                       i = -1;
                }
+
                ItemSpec(const InventoryLocation &a_inventoryloc,
                                const std::string &a_listname,
-                               s32 a_i)
-               {
-                       inventoryloc = a_inventoryloc;
-                       listname = a_listname;
-                       i = a_i;
-               }
-               bool isValid() const
+                               s32 a_i) :
+                       inventoryloc(a_inventoryloc),
+                       listname(a_listname),
+                       i(a_i)
                {
-                       return i != -1;
                }
 
+               bool isValid() const { return i != -1; }
+
                InventoryLocation inventoryloc;
                std::string listname;
                s32 i;
@@ -120,30 +120,85 @@ class GUIFormSpecMenu : public GUIModalMenu
                s32 start_item_i;
        };
 
+       struct ListRingSpec
+       {
+               ListRingSpec()
+               {
+               }
+               ListRingSpec(const InventoryLocation &a_inventoryloc,
+                               const std::string &a_listname):
+                       inventoryloc(a_inventoryloc),
+                       listname(a_listname)
+               {
+               }
+
+               InventoryLocation inventoryloc;
+               std::string listname;
+       };
+
        struct ImageDrawSpec
        {
-               ImageDrawSpec()
+               ImageDrawSpec():
+                       parent_button(NULL),
+                       clip(false)
                {
                }
+
                ImageDrawSpec(const std::string &a_name,
-                               v2s32 a_pos, v2s32 a_geom):
+                               const std::string &a_item_name,
+                               gui::IGUIButton *a_parent_button,
+                               const v2s32 &a_pos, const v2s32 &a_geom):
                        name(a_name),
+                       item_name(a_item_name),
+                       parent_button(a_parent_button),
                        pos(a_pos),
-                       geom(a_geom)
+                       geom(a_geom),
+                       scale(true),
+                       clip(false)
                {
-                       scale = true;
                }
+
+               ImageDrawSpec(const std::string &a_name,
+                               const std::string &a_item_name,
+                               const v2s32 &a_pos, const v2s32 &a_geom):
+                       name(a_name),
+                       item_name(a_item_name),
+                       parent_button(NULL),
+                       pos(a_pos),
+                       geom(a_geom),
+                       scale(true),
+                       clip(false)
+               {
+               }
+
+               ImageDrawSpec(const std::string &a_name,
+                               const v2s32 &a_pos, const v2s32 &a_geom, bool clip=false):
+                       name(a_name),
+                       parent_button(NULL),
+                       pos(a_pos),
+                       geom(a_geom),
+                       scale(true),
+                       clip(clip)
+               {
+               }
+
                ImageDrawSpec(const std::string &a_name,
-                               v2s32 a_pos):
+                               const v2s32 &a_pos):
                        name(a_name),
-                       pos(a_pos)
+                       parent_button(NULL),
+                       pos(a_pos),
+                       scale(false),
+                       clip(false)
                {
-                       scale = false;
                }
+
                std::string name;
+               std::string item_name;
+               gui::IGUIButton *parent_button;
                v2s32 pos;
                v2s32 geom;
                bool scale;
+               bool clip;
        };
 
        struct FieldSpec
@@ -151,18 +206,19 @@ class GUIFormSpecMenu : public GUIModalMenu
                FieldSpec()
                {
                }
-               FieldSpec(const std::wstring &name, const std::wstring &label,
-                               const std::wstring &fdeflt, int id) :
+               FieldSpec(const std::string &name, const std::wstring &label,
+                               const std::wstring &default_text, int id) :
                        fname(name),
                        flabel(label),
-                       fdefault(fdeflt),
-                       fid(id)
+                       fdefault(unescape_enriched(default_text)),
+                       fid(id),
+                       send(false),
+                       ftype(f_Unknown),
+                       is_exit(false)
                {
-                       send = false;
-                       ftype = f_Unknown;
-                       is_exit = false;
                }
-               std::wstring fname;
+
+               std::string fname;
                std::wstring flabel;
                std::wstring fdefault;
                int fid;
@@ -172,7 +228,8 @@ class GUIFormSpecMenu : public GUIModalMenu
                core::rect<s32> rect;
        };
 
-       struct BoxDrawSpec {
+       struct BoxDrawSpec
+       {
                BoxDrawSpec(v2s32 a_pos, v2s32 a_geom,irr::video::SColor a_color):
                        pos(a_pos),
                        geom(a_geom),
@@ -184,38 +241,66 @@ class GUIFormSpecMenu : public GUIModalMenu
                irr::video::SColor color;
        };
 
-       struct TooltipSpec {
-               TooltipSpec()
-               {
-               }
-               TooltipSpec(std::string a_tooltip, irr::video::SColor a_bgcolor,
+       struct TooltipSpec
+       {
+               TooltipSpec() {}
+               TooltipSpec(const std::string &a_tooltip, irr::video::SColor a_bgcolor,
                                irr::video::SColor a_color):
-                       tooltip(a_tooltip),
+                       tooltip(utf8_to_wide(a_tooltip)),
                        bgcolor(a_bgcolor),
                        color(a_color)
                {
                }
-               std::string tooltip;
+
+               std::wstring tooltip;
                irr::video::SColor bgcolor;
                irr::video::SColor color;
        };
 
+       struct StaticTextSpec
+       {
+               StaticTextSpec():
+                       parent_button(NULL)
+               {
+               }
+
+               StaticTextSpec(const std::wstring &a_text,
+                               const core::rect<s32> &a_rect):
+                       text(a_text),
+                       rect(a_rect),
+                       parent_button(NULL)
+               {
+               }
+
+               StaticTextSpec(const std::wstring &a_text,
+                               const core::rect<s32> &a_rect,
+                               gui::IGUIButton *a_parent_button):
+                       text(a_text),
+                       rect(a_rect),
+                       parent_button(a_parent_button)
+               {
+               }
+
+               std::wstring text;
+               core::rect<s32> rect;
+               gui::IGUIButton *parent_button;
+       };
+
 public:
        GUIFormSpecMenu(irr::IrrlichtDevice* dev,
+                       JoystickController *joystick,
                        gui::IGUIElement* parent, s32 id,
                        IMenuManager *menumgr,
-                       InventoryManager *invmgr,
-                       IGameDef *gamedef,
+                       Client *client,
                        ISimpleTextureSource *tsrc,
                        IFormSource* fs_src,
                        TextDest* txt_dst,
-                       GUIFormSpecMenu** ext_ptr
-                       );
+                       bool remap_dbl_click = true);
 
        ~GUIFormSpecMenu();
 
        void setFormSpec(const std::string &formspec_string,
-                       InventoryLocation current_inventory_location)
+                       const InventoryLocation &current_inventory_location)
        {
                m_formspec_string = formspec_string;
                m_current_inventory_location = current_inventory_location;
@@ -225,18 +310,14 @@ class GUIFormSpecMenu : public GUIModalMenu
        // form_src is deleted by this GUIFormSpecMenu
        void setFormSource(IFormSource *form_src)
        {
-               if (m_form_src != NULL) {
-                       delete m_form_src;
-               }
+               delete m_form_src;
                m_form_src = form_src;
        }
 
        // text_dst is deleted by this GUIFormSpecMenu
        void setTextDest(TextDest *text_dst)
        {
-               if (m_text_dst != NULL) {
-                       delete m_text_dst;
-               }
+               delete m_text_dst;
                m_text_dst = text_dst;
        }
 
@@ -245,20 +326,27 @@ class GUIFormSpecMenu : public GUIModalMenu
                m_allowclose = value;
        }
 
-       void lockSize(bool lock,v2u32 basescreensize=v2u32(0,0)) {
+       void lockSize(bool lock,v2u32 basescreensize=v2u32(0,0))
+       {
                m_lock = lock;
                m_lockscreensize = basescreensize;
        }
 
        void removeChildren();
        void setInitialFocus();
+
+       void setFocus(const std::string &elementname)
+       {
+               m_focused_element = elementname;
+       }
+
        /*
                Remove and re-add (or reposition) stuff
        */
        void regenerateGui(v2u32 screensize);
 
        ItemSpec getItemAtPos(v2s32 p) const;
-       void drawList(const ListDrawSpec &s, int phase);
+       void drawList(const ListDrawSpec &s, int phase, bool &item_hovered);
        void drawSelectedItem();
        void drawMenu();
        void updateSelectedItem();
@@ -270,10 +358,8 @@ class GUIFormSpecMenu : public GUIModalMenu
        bool doPause;
        bool pausesGame() { return doPause; }
 
-       GUITable* getTable(std::wstring tablename);
-
-       static bool parseColor(const std::string &value,
-                       video::SColor &color, bool quiet);
+       GUITable* getTable(const std::string &tablename);
+       std::vector<std::string>* getDropDownValues(const std::string &name);
 
 #ifdef __ANDROID__
        bool getAndroidUIInput();
@@ -289,25 +375,32 @@ class GUIFormSpecMenu : public GUIModalMenu
        v2s32 spacing;
        v2s32 imgsize;
        v2s32 offset;
+       v2s32 pos_offset;
+       std::stack<v2s32> container_stack;
 
        irr::IrrlichtDevice* m_device;
        InventoryManager *m_invmgr;
-       IGameDef *m_gamedef;
        ISimpleTextureSource *m_tsrc;
+       Client *m_client;
 
        std::string m_formspec_string;
        InventoryLocation m_current_inventory_location;
 
+
        std::vector<ListDrawSpec> m_inventorylists;
+       std::vector<ListRingSpec> m_inventory_rings;
        std::vector<ImageDrawSpec> m_backgrounds;
        std::vector<ImageDrawSpec> m_images;
        std::vector<ImageDrawSpec> m_itemimages;
        std::vector<BoxDrawSpec> m_boxes;
+       std::unordered_map<std::string, bool> field_close_on_enter;
        std::vector<FieldSpec> m_fields;
+       std::vector<StaticTextSpec> m_static_texts;
        std::vector<std::pair<FieldSpec,GUITable*> > m_tables;
        std::vector<std::pair<FieldSpec,gui::IGUICheckBox*> > m_checkboxes;
-       std::map<std::wstring, TooltipSpec> m_tooltips;
+       std::map<std::string, TooltipSpec> m_tooltips;
        std::vector<std::pair<FieldSpec,gui::IGUIScrollBar*> > m_scrollbars;
+       std::vector<std::pair<FieldSpec, std::vector<std::string> > > m_dropdowns;
 
        ItemSpec *m_selected_item;
        u32 m_selected_amount;
@@ -320,12 +413,15 @@ class GUIFormSpecMenu : public GUIModalMenu
        InventoryLocation m_selected_content_guess_inventory;
 
        v2s32 m_pointer;
+       v2s32 m_old_pointer;  // Mouse position after previous mouse event
        gui::IGUIStaticText *m_tooltip_element;
 
-       u32 m_tooltip_show_delay;
-       s32 m_hoovered_time;
+       u64 m_tooltip_show_delay;
+       u64 m_hovered_time;
        s32 m_old_tooltip_id;
-       std::string m_old_tooltip;
+       std::wstring m_old_tooltip;
+
+       bool m_rmouse_auto_place;
 
        bool m_allowclose;
        bool m_lock;
@@ -333,7 +429,6 @@ class GUIFormSpecMenu : public GUIModalMenu
 
        bool m_bgfullscreen;
        bool m_slotborder;
-       bool m_clipbackground;
        video::SColor m_bgcolor;
        video::SColor m_slotbg_n;
        video::SColor m_slotbg_h;
@@ -342,23 +437,26 @@ class GUIFormSpecMenu : public GUIModalMenu
        video::SColor m_default_tooltip_color;
 
 private:
-       IFormSource      *m_form_src;
-       TextDest         *m_text_dst;
-       GUIFormSpecMenu **m_ext_ptr;
-       gui::IGUIFont    *m_font;
-       unsigned int      m_formspec_version;
+       IFormSource        *m_form_src;
+       TextDest           *m_text_dst;
+       unsigned int        m_formspec_version;
+       std::string         m_focused_element;
+       JoystickController *m_joystick;
 
        typedef struct {
+               bool explicit_size;
+               v2f invsize;
                v2s32 size;
+               v2f32 offset;
+               v2f32 anchor;
                core::rect<s32> rect;
                v2s32 basepos;
-               int bp_set;
                v2u32 screensize;
-               std::wstring focused_fieldname;
+               std::string focused_fieldname;
                GUITable::TableOptions table_options;
                GUITable::TableColumns table_columns;
                // used to restore table selection/scroll/treeview state
-               std::map<std::wstring,GUITable::DynamicData> table_dyndata;
+               std::unordered_map<std::string, GUITable::DynamicData> table_dyndata;
        } parserData;
 
        typedef struct {
@@ -369,37 +467,54 @@ class GUIFormSpecMenu : public GUIModalMenu
        } fs_key_pendig;
 
        fs_key_pendig current_keys_pending;
-
-       void parseElement(parserData* data,std::string element);
-
-       void parseSize(parserData* data,std::string element);
-       void parseList(parserData* data,std::string element);
-       void parseCheckbox(parserData* data,std::string element);
-       void parseImage(parserData* data,std::string element);
-       void parseItemImage(parserData* data,std::string element);
-       void parseButton(parserData* data,std::string element,std::string typ);
-       void parseBackground(parserData* data,std::string element);
-       void parseTableOptions(parserData* data,std::string element);
-       void parseTableColumns(parserData* data,std::string element);
-       void parseTable(parserData* data,std::string element);
-       void parseTextList(parserData* data,std::string element);
-       void parseDropDown(parserData* data,std::string element);
-       void parsePwdField(parserData* data,std::string element);
-       void parseField(parserData* data,std::string element,std::string type);
+       std::string current_field_enter_pending;
+
+       void parseElement(parserData* data, const std::string &element);
+
+       void parseSize(parserData* data, const std::string &element);
+       void parseContainer(parserData* data, const std::string &element);
+       void parseContainerEnd(parserData* data);
+       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 parseItemImage(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 parseTableOptions(parserData* data, const std::string &element);
+       void parseTableColumns(parserData* data, const std::string &element);
+       void parseTable(parserData* data, const std::string &element);
+       void parseTextList(parserData* data, const std::string &element);
+       void parseDropDown(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 parseSimpleField(parserData* data,std::vector<std::string> &parts);
        void parseTextArea(parserData* data,std::vector<std::string>& parts,
-                       std::string type);
-       void parseLabel(parserData* data,std::string element);
-       void parseVertLabel(parserData* data,std::string element);
-       void parseImageButton(parserData* data,std::string element,std::string type);
-       void parseItemImageButton(parserData* data,std::string element);
-       void parseTabHeader(parserData* data,std::string element);
-       void parseBox(parserData* data,std::string element);
-       void parseBackgroundColor(parserData* data,std::string element);
-       void parseListColors(parserData* data,std::string element);
-       void parseTooltip(parserData* data,std::string element);
-       bool parseVersionDirect(std::string data);
-       void parseScrollBar(parserData* data, std::string element);
+                       const std::string &type);
+       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 parseItemImageButton(parserData* data, const std::string &element);
+       void parseTabHeader(parserData* data, const std::string &element);
+       void parseBox(parserData* data, const std::string &element);
+       void parseBackgroundColor(parserData* data, const std::string &element);
+       void parseListColors(parserData* data, const std::string &element);
+       void parseTooltip(parserData* data, const std::string &element);
+       bool parseVersionDirect(const std::string &data);
+       bool parseSizeDirect(parserData* data, const std::string &element);
+       void parseScrollBar(parserData* data, const std::string &element);
+       bool parsePositionDirect(parserData *data, const std::string &element);
+       void parsePosition(parserData *data, const std::string &element);
+       bool parseAnchorDirect(parserData *data, const std::string &element);
+       void parseAnchor(parserData *data, const std::string &element);
+
+       void tryClose();
+
+       void showTooltip(const std::wstring &text, const irr::video::SColor &color,
+               const irr::video::SColor &bgcolor);
 
        /**
         * check if event is part of a double click
@@ -411,43 +526,50 @@ class GUIFormSpecMenu : public GUIModalMenu
        struct clickpos
        {
                v2s32 pos;
-               s32 time;
+               s64 time;
        };
        clickpos m_doubleclickdetect[2];
 
        int m_btn_height;
+       gui::IGUIFont *m_font;
 
        std::wstring getLabelByID(s32 id);
-       std::wstring getNameByID(s32 id);
+       std::string getNameByID(s32 id);
 #ifdef __ANDROID__
        v2s32 m_down_pos;
-       std::wstring m_JavaDialogFieldName;
+       std::string m_JavaDialogFieldName;
 #endif
 
+       /* If true, remap a double-click (or double-tap) action to ESC. This is so
+        * that, for example, Android users can double-tap to close a formspec.
+       *
+        * This value can (currently) only be set by the class constructor
+        * and the default value for the setting is true.
+        */
+       bool m_remap_dbl_click;
+
 };
 
 class FormspecFormSource: public IFormSource
 {
 public:
-       FormspecFormSource(std::string formspec)
+       FormspecFormSource(const std::string &formspec):
+               m_formspec(formspec)
        {
-               m_formspec = formspec;
        }
 
        ~FormspecFormSource()
-       {}
-
-       void setForm(std::string formspec) {
-               m_formspec = FORMSPEC_VERSION_STRING + formspec;
+       {
        }
 
-       std::string getForm()
+       void setForm(const std::string &formspec)
        {
-               return m_formspec;
+               m_formspec = FORMSPEC_VERSION_STRING + formspec;
        }
 
+       std::string getForm() { return m_formspec; }
+
        std::string m_formspec;
 };
 
 #endif
-