FormSpec: Add position and anchor elements (#5284)
[oweals/minetest.git] / src / guiFormSpecMenu.h
index 6f7de158b505572018e379fd572d41ef1afcc976..bbab9c16454b54c1a4b38ceaaa0d8a6f5a11e8ce 100644 (file)
@@ -22,16 +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 "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,
@@ -39,6 +43,7 @@ typedef enum {
        f_TabHeader,
        f_CheckBox,
        f_DropDown,
+       f_ScrollBar,
        f_Unknown
 } FormspecFieldType;
 
@@ -53,7 +58,7 @@ struct 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 gotText(const StringMap &fields) = 0;
        virtual void setFormName(std::string formname)
        { m_formname = formname;};
 
@@ -118,50 +123,100 @@ class GUIFormSpecMenu : public GUIModalMenu
                s32 start_item_i;
        };
 
-       struct ImageDrawSpec
+       struct ListRingSpec
        {
-               ImageDrawSpec()
+               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():
+                       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)
-               {
-                       scale = true;
-               }
+                       geom(a_geom),
+                       scale(true),
+                       clip(false)
+               {}
+
                ImageDrawSpec(const std::string &a_name,
-                               v2s32 a_pos):
+                               const std::string &a_item_name,
+                               const v2s32 &a_pos, const v2s32 &a_geom):
                        name(a_name),
-                       pos(a_pos)
-               {
-                       scale = false;
-               }
+                       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,
+                               const v2s32 &a_pos):
+                       name(a_name),
+                       parent_button(NULL),
+                       pos(a_pos),
+                       scale(false),
+                       clip(false)
+               {}
+
                std::string name;
+               std::string item_name;
+               gui::IGUIButton *parent_button;
                v2s32 pos;
                v2s32 geom;
                bool scale;
+               bool clip;
        };
-       
+
        struct FieldSpec
        {
                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)
+                       fid(id),
+                       send(false),
+                       ftype(f_Unknown),
+                       is_exit(false)
                {
-                       send = false;
-                       ftype = f_Unknown;
-                       is_exit = false;
-                       tooltip="";
+                       //flabel = unescape_enriched(label);
+                       fdefault = unescape_enriched(default_text);
                }
-               std::wstring fname;
+               std::string fname;
                std::wstring flabel;
                std::wstring fdefault;
                int fid;
@@ -169,7 +224,6 @@ class GUIFormSpecMenu : public GUIModalMenu
                FormspecFieldType ftype;
                bool is_exit;
                core::rect<s32> rect;
-               std::string tooltip;
        };
 
        struct BoxDrawSpec {
@@ -184,14 +238,60 @@ class GUIFormSpecMenu : public GUIModalMenu
                irr::video::SColor color;
        };
 
+       struct TooltipSpec {
+               TooltipSpec()
+               {
+               }
+               TooltipSpec(std::string a_tooltip, irr::video::SColor a_bgcolor,
+                               irr::video::SColor a_color):
+                       bgcolor(a_bgcolor),
+                       color(a_color)
+               {
+                       //tooltip = unescape_enriched(utf8_to_wide(a_tooltip));
+                       tooltip = utf8_to_wide(a_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):
+                       rect(a_rect),
+                       parent_button(NULL)
+               {
+                       //text = unescape_enriched(a_text);
+                       text = a_text;
+               }
+               StaticTextSpec(const std::wstring &a_text,
+                               const core::rect<s32> &a_rect,
+                               gui::IGUIButton *a_parent_button):
+                       rect(a_rect),
+                       parent_button(a_parent_button)
+               {
+                       //text = unescape_enriched(a_text);
+                       text = a_text;
+               }
+               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,
-                       ISimpleTextureSource *tsrc
-                       );
+                       Client *client,
+                       ISimpleTextureSource *tsrc,
+                       IFormSource* fs_src,
+                       TextDest* txt_dst,
+                       bool remap_dbl_click = true);
 
        ~GUIFormSpecMenu();
 
@@ -202,16 +302,22 @@ public:
                m_current_inventory_location = current_inventory_location;
                regenerateGui(m_screensize_old);
        }
-       
+
        // form_src is deleted by this GUIFormSpecMenu
        void setFormSource(IFormSource *form_src)
        {
+               if (m_form_src != NULL) {
+                       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;
+               }
                m_text_dst = text_dst;
        }
 
@@ -220,20 +326,27 @@ public:
                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(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();
@@ -245,10 +358,12 @@ public:
        bool doPause;
        bool pausesGame() { return doPause; }
 
-       GUITable* getTable(std::wstring tablename);
+       GUITable* getTable(const std::string &tablename);
+       std::vector<std::string>* getDropDownValues(const std::string &name);
 
-       static bool parseColor(const std::string &value,
-                       video::SColor &color, bool quiet);
+#ifdef __ANDROID__
+       bool getAndroidUIInput();
+#endif
 
 protected:
        v2s32 getBasePos() const
@@ -260,30 +375,37 @@ protected:
        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;
-       IFormSource *m_form_src;
-       TextDest *m_text_dst;
+
 
        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;
+       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::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;
        bool m_selected_dragging;
-       
+
        // WARNING: BLACK MAGIC
        // Used to guess and keep up with some special things the server can do.
        // If name is "", no guess exists.
@@ -291,32 +413,50 @@ protected:
        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_hovered_time;
+       s32 m_old_tooltip_id;
+       std::wstring m_old_tooltip;
+
+       bool m_rmouse_auto_place;
+
        bool m_allowclose;
        bool m_lock;
        v2u32 m_lockscreensize;
 
        bool m_bgfullscreen;
        bool m_slotborder;
-       bool m_clipbackground;
        video::SColor m_bgcolor;
        video::SColor m_slotbg_n;
        video::SColor m_slotbg_h;
        video::SColor m_slotbordercolor;
+       video::SColor m_default_tooltip_bgcolor;
+       video::SColor m_default_tooltip_color;
+
 private:
+       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;
-               s32 helptext_h;
+               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;
+               UNORDERED_MAP<std::string, GUITable::DynamicData> table_dyndata;
        } parserData;
 
        typedef struct {
@@ -327,13 +467,17 @@ private:
        } fs_key_pendig;
 
        fs_key_pendig current_keys_pending;
+       std::string current_field_enter_pending;
 
-       void parseElement(parserData* data,std::string element);
+       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 parseSize(parserData* data, std::string element);
+       void parseContainer(parserData* data, std::string element);
+       void parseContainerEnd(parserData* data);
+       void parseList(parserData* data, std::string element);
+       void parseListRing(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);
@@ -342,6 +486,7 @@ private:
        void parseTable(parserData* data,std::string element);
        void parseTextList(parserData* data,std::string element);
        void parseDropDown(parserData* data,std::string element);
+       void parseFieldCloseOnEnter(parserData *data, const std::string &element);
        void parsePwdField(parserData* data,std::string element);
        void parseField(parserData* data,std::string element,std::string type);
        void parseSimpleField(parserData* data,std::vector<std::string> &parts);
@@ -355,24 +500,64 @@ private:
        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);
+       bool parseSizeDirect(parserData* data, std::string element);
+       void parseScrollBar(parserData* data, 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();
+
+       /**
+        * check if event is part of a double click
+        * @param event event to evaluate
+        * @return true/false if a doubleclick was detected
+        */
+       bool DoubleClickDetection(const SEvent event);
+
+       struct clickpos
+       {
+               v2s32 pos;
+               s32 time;
+       };
+       clickpos m_doubleclickdetect[2];
+
+       int m_btn_height;
+       gui::IGUIFont *m_font;
+
+       std::wstring getLabelByID(s32 id);
+       std::string getNameByID(s32 id);
+#ifdef __ANDROID__
+       v2s32 m_down_pos;
+       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** game_formspec)
+       FormspecFormSource(std::string formspec)
        {
                m_formspec = formspec;
-               m_game_formspec = game_formspec;
        }
 
        ~FormspecFormSource()
-       {
-               *m_game_formspec = 0;
-       }
+       {}
 
        void setForm(std::string formspec) {
-               m_formspec = formspec;
+               m_formspec = FORMSPEC_VERSION_STRING + formspec;
        }
 
        std::string getForm()
@@ -381,8 +566,6 @@ public:
        }
 
        std::string m_formspec;
-       FormspecFormSource** m_game_formspec;
 };
 
 #endif
-