src/guiFormSpecMenu.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20
  21 #ifndef GUIINVENTORYMENU_HEADER
  22 #define GUIINVENTORYMENU_HEADER
  23
  24 #include <utility>
  25 #include <stack>
  26
  27 #include "irrlichttypes_extrabloated.h"
  28 #include "inventorymanager.h"
  29 #include "modalMenu.h"
  30 #include "guiTable.h"
  31 #include "network/networkprotocol.h"
  32 #include "client/joystick_controller.h"
  33 #include "util/string.h"
  34 #include "util/enriched_string.h"
  35
  36 class InventoryManager;
  37 class ISimpleTextureSource;
  38 class Client;
  39
  40 typedef enum {
  41         f_Button,
  42         f_Table,
  43         f_TabHeader,
  44         f_CheckBox,
  45         f_DropDown,
  46         f_ScrollBar,
  47         f_Unknown
  48 } FormspecFieldType;
  49
  50 typedef enum {
  51         quit_mode_no,
  52         quit_mode_accept,
  53         quit_mode_cancel
  54 } FormspecQuitMode;
  55
  56 struct TextDest
  57 {
  58         virtual ~TextDest() {}
  59         // This is deprecated I guess? -celeron55
  60         virtual void gotText(const std::wstring &text) {}
  61         virtual void gotText(const StringMap &fields) = 0;
  62
  63         std::string m_formname;
  64 };
  65
  66 class IFormSource
  67 {
  68 public:
  69         virtual ~IFormSource(){}
  70         virtual std::string getForm() = 0;
  71         // Fill in variables in field text
  72         virtual std::string resolveText(const std::string &str) { return str; }
  73 };
  74
  75 class GUIFormSpecMenu : public GUIModalMenu
  76 {
  77         struct ItemSpec
  78         {
  79                 ItemSpec() :
  80                         i(-1)
  81                 {
  82                 }
  83
  84                 ItemSpec(const InventoryLocation &a_inventoryloc,
  85                                 const std::string &a_listname,
  86                                 s32 a_i) :
  87                         inventoryloc(a_inventoryloc),
  88                         listname(a_listname),
  89                         i(a_i)
  90                 {
  91                 }
  92
  93                 bool isValid() const { return i != -1; }
  94
  95                 InventoryLocation inventoryloc;
  96                 std::string listname;
  97                 s32 i;
  98         };
  99
 100         struct ListDrawSpec
 101         {
 102                 ListDrawSpec()
 103                 {
 104                 }
 105                 ListDrawSpec(const InventoryLocation &a_inventoryloc,
 106                                 const std::string &a_listname,
 107                                 v2s32 a_pos, v2s32 a_geom, s32 a_start_item_i):
 108                         inventoryloc(a_inventoryloc),
 109                         listname(a_listname),
 110                         pos(a_pos),
 111                         geom(a_geom),
 112                         start_item_i(a_start_item_i)
 113                 {
 114                 }
 115
 116                 InventoryLocation inventoryloc;
 117                 std::string listname;
 118                 v2s32 pos;
 119                 v2s32 geom;
 120                 s32 start_item_i;
 121         };
 122
 123         struct ListRingSpec
 124         {
 125                 ListRingSpec()
 126                 {
 127                 }
 128                 ListRingSpec(const InventoryLocation &a_inventoryloc,
 129                                 const std::string &a_listname):
 130                         inventoryloc(a_inventoryloc),
 131                         listname(a_listname)
 132                 {
 133                 }
 134
 135                 InventoryLocation inventoryloc;
 136                 std::string listname;
 137         };
 138
 139         struct ImageDrawSpec
 140         {
 141                 ImageDrawSpec():
 142                         parent_button(NULL),
 143                         clip(false)
 144                 {
 145                 }
 146
 147                 ImageDrawSpec(const std::string &a_name,
 148                                 const std::string &a_item_name,
 149                                 gui::IGUIButton *a_parent_button,
 150                                 const v2s32 &a_pos, const v2s32 &a_geom):
 151                         name(a_name),
 152                         item_name(a_item_name),
 153                         parent_button(a_parent_button),
 154                         pos(a_pos),
 155                         geom(a_geom),
 156                         scale(true),
 157                         clip(false)
 158                 {
 159                 }
 160
 161                 ImageDrawSpec(const std::string &a_name,
 162                                 const std::string &a_item_name,
 163                                 const v2s32 &a_pos, const v2s32 &a_geom):
 164                         name(a_name),
 165                         item_name(a_item_name),
 166                         parent_button(NULL),
 167                         pos(a_pos),
 168                         geom(a_geom),
 169                         scale(true),
 170                         clip(false)
 171                 {
 172                 }
 173
 174                 ImageDrawSpec(const std::string &a_name,
 175                                 const v2s32 &a_pos, const v2s32 &a_geom, bool clip=false):
 176                         name(a_name),
 177                         parent_button(NULL),
 178                         pos(a_pos),
 179                         geom(a_geom),
 180                         scale(true),
 181                         clip(clip)
 182                 {
 183                 }
 184
 185                 ImageDrawSpec(const std::string &a_name,
 186                                 const v2s32 &a_pos):
 187                         name(a_name),
 188                         parent_button(NULL),
 189                         pos(a_pos),
 190                         scale(false),
 191                         clip(false)
 192                 {
 193                 }
 194
 195                 std::string name;
 196                 std::string item_name;
 197                 gui::IGUIButton *parent_button;
 198                 v2s32 pos;
 199                 v2s32 geom;
 200                 bool scale;
 201                 bool clip;
 202         };
 203
 204         struct FieldSpec
 205         {
 206                 FieldSpec()
 207                 {
 208                 }
 209                 FieldSpec(const std::string &name, const std::wstring &label,
 210                                 const std::wstring &default_text, int id) :
 211                         fname(name),
 212                         flabel(label),
 213                         fdefault(unescape_enriched(default_text)),
 214                         fid(id),
 215                         send(false),
 216                         ftype(f_Unknown),
 217                         is_exit(false)
 218                 {
 219                 }
 220
 221                 std::string fname;
 222                 std::wstring flabel;
 223                 std::wstring fdefault;
 224                 int fid;
 225                 bool send;
 226                 FormspecFieldType ftype;
 227                 bool is_exit;
 228                 core::rect<s32> rect;
 229         };
 230
 231         struct BoxDrawSpec
 232         {
 233                 BoxDrawSpec(v2s32 a_pos, v2s32 a_geom,irr::video::SColor a_color):
 234                         pos(a_pos),
 235                         geom(a_geom),
 236                         color(a_color)
 237                 {
 238                 }
 239                 v2s32 pos;
 240                 v2s32 geom;
 241                 irr::video::SColor color;
 242         };
 243
 244         struct TooltipSpec
 245         {
 246                 TooltipSpec() {}
 247                 TooltipSpec(const std::string &a_tooltip, irr::video::SColor a_bgcolor,
 248                                 irr::video::SColor a_color):
 249                         tooltip(utf8_to_wide(a_tooltip)),
 250                         bgcolor(a_bgcolor),
 251                         color(a_color)
 252                 {
 253                 }
 254
 255                 std::wstring tooltip;
 256                 irr::video::SColor bgcolor;
 257                 irr::video::SColor color;
 258         };
 259
 260         struct StaticTextSpec
 261         {
 262                 StaticTextSpec():
 263                         parent_button(NULL)
 264                 {
 265                 }
 266
 267                 StaticTextSpec(const std::wstring &a_text,
 268                                 const core::rect<s32> &a_rect):
 269                         text(a_text),
 270                         rect(a_rect),
 271                         parent_button(NULL)
 272                 {
 273                 }
 274
 275                 StaticTextSpec(const std::wstring &a_text,
 276                                 const core::rect<s32> &a_rect,
 277                                 gui::IGUIButton *a_parent_button):
 278                         text(a_text),
 279                         rect(a_rect),
 280                         parent_button(a_parent_button)
 281                 {
 282                 }
 283
 284                 std::wstring text;
 285                 core::rect<s32> rect;
 286                 gui::IGUIButton *parent_button;
 287         };
 288
 289 public:
 290         GUIFormSpecMenu(irr::IrrlichtDevice* dev,
 291                         JoystickController *joystick,
 292                         gui::IGUIElement* parent, s32 id,
 293                         IMenuManager *menumgr,
 294                         Client *client,
 295                         ISimpleTextureSource *tsrc,
 296                         IFormSource* fs_src,
 297                         TextDest* txt_dst,
 298                         bool remap_dbl_click = true);
 299
 300         ~GUIFormSpecMenu();
 301
 302         void setFormSpec(const std::string &formspec_string,
 303                         const InventoryLocation &current_inventory_location)
 304         {
 305                 m_formspec_string = formspec_string;
 306                 m_current_inventory_location = current_inventory_location;
 307                 regenerateGui(m_screensize_old);
 308         }
 309
 310         // form_src is deleted by this GUIFormSpecMenu
 311         void setFormSource(IFormSource *form_src)
 312         {
 313                 delete m_form_src;
 314                 m_form_src = form_src;
 315         }
 316
 317         // text_dst is deleted by this GUIFormSpecMenu
 318         void setTextDest(TextDest *text_dst)
 319         {
 320                 delete m_text_dst;
 321                 m_text_dst = text_dst;
 322         }
 323
 324         void allowClose(bool value)
 325         {
 326                 m_allowclose = value;
 327         }
 328
 329         void lockSize(bool lock,v2u32 basescreensize=v2u32(0,0))
 330         {
 331                 m_lock = lock;
 332                 m_lockscreensize = basescreensize;
 333         }
 334
 335         void removeChildren();
 336         void setInitialFocus();
 337
 338         void setFocus(const std::string &elementname)
 339         {
 340                 m_focused_element = elementname;
 341         }
 342
 343         /*
 344                 Remove and re-add (or reposition) stuff
 345         */
 346         void regenerateGui(v2u32 screensize);
 347
 348         ItemSpec getItemAtPos(v2s32 p) const;
 349         void drawList(const ListDrawSpec &s, int phase, bool &item_hovered);
 350         void drawSelectedItem();
 351         void drawMenu();
 352         void updateSelectedItem();
 353         ItemStack verifySelectedItem();
 354
 355         void acceptInput(FormspecQuitMode quitmode);
 356         bool preprocessEvent(const SEvent& event);
 357         bool OnEvent(const SEvent& event);
 358         bool doPause;
 359         bool pausesGame() { return doPause; }
 360
 361         GUITable* getTable(const std::string &tablename);
 362         std::vector<std::string>* getDropDownValues(const std::string &name);
 363
 364 #ifdef __ANDROID__
 365         bool getAndroidUIInput();
 366 #endif
 367
 368 protected:
 369         v2s32 getBasePos() const
 370         {
 371                         return padding + offset + AbsoluteRect.UpperLeftCorner;
 372         }
 373
 374         v2s32 padding;
 375         v2s32 spacing;
 376         v2s32 imgsize;
 377         v2s32 offset;
 378         v2s32 pos_offset;
 379         std::stack<v2s32> container_stack;
 380
 381         irr::IrrlichtDevice* m_device;
 382         InventoryManager *m_invmgr;
 383         ISimpleTextureSource *m_tsrc;
 384         Client *m_client;
 385
 386         std::string m_formspec_string;
 387         InventoryLocation m_current_inventory_location;
 388
 389
 390         std::vector<ListDrawSpec> m_inventorylists;
 391         std::vector<ListRingSpec> m_inventory_rings;
 392         std::vector<ImageDrawSpec> m_backgrounds;
 393         std::vector<ImageDrawSpec> m_images;
 394         std::vector<ImageDrawSpec> m_itemimages;
 395         std::vector<BoxDrawSpec> m_boxes;
 396         std::unordered_map<std::string, bool> field_close_on_enter;
 397         std::vector<FieldSpec> m_fields;
 398         std::vector<StaticTextSpec> m_static_texts;
 399         std::vector<std::pair<FieldSpec,GUITable*> > m_tables;
 400         std::vector<std::pair<FieldSpec,gui::IGUICheckBox*> > m_checkboxes;
 401         std::map<std::string, TooltipSpec> m_tooltips;
 402         std::vector<std::pair<FieldSpec,gui::IGUIScrollBar*> > m_scrollbars;
 403         std::vector<std::pair<FieldSpec, std::vector<std::string> > > m_dropdowns;
 404
 405         ItemSpec *m_selected_item;
 406         u32 m_selected_amount;
 407         bool m_selected_dragging;
 408
 409         // WARNING: BLACK MAGIC
 410         // Used to guess and keep up with some special things the server can do.
 411         // If name is "", no guess exists.
 412         ItemStack m_selected_content_guess;
 413         InventoryLocation m_selected_content_guess_inventory;
 414
 415         v2s32 m_pointer;
 416         v2s32 m_old_pointer;  // Mouse position after previous mouse event
 417         gui::IGUIStaticText *m_tooltip_element;
 418
 419         u64 m_tooltip_show_delay;
 420         u64 m_hovered_time;
 421         s32 m_old_tooltip_id;
 422         std::wstring m_old_tooltip;
 423
 424         bool m_rmouse_auto_place;
 425
 426         bool m_allowclose;
 427         bool m_lock;
 428         v2u32 m_lockscreensize;
 429
 430         bool m_bgfullscreen;
 431         bool m_slotborder;
 432         video::SColor m_bgcolor;
 433         video::SColor m_slotbg_n;
 434         video::SColor m_slotbg_h;
 435         video::SColor m_slotbordercolor;
 436         video::SColor m_default_tooltip_bgcolor;
 437         video::SColor m_default_tooltip_color;
 438
 439 private:
 440         IFormSource        *m_form_src;
 441         TextDest           *m_text_dst;
 442         unsigned int        m_formspec_version;
 443         std::string         m_focused_element;
 444         JoystickController *m_joystick;
 445
 446         typedef struct {
 447                 bool explicit_size;
 448                 v2f invsize;
 449                 v2s32 size;
 450                 v2f32 offset;
 451                 v2f32 anchor;
 452                 core::rect<s32> rect;
 453                 v2s32 basepos;
 454                 v2u32 screensize;
 455                 std::string focused_fieldname;
 456                 GUITable::TableOptions table_options;
 457                 GUITable::TableColumns table_columns;
 458                 // used to restore table selection/scroll/treeview state
 459                 std::unordered_map<std::string, GUITable::DynamicData> table_dyndata;
 460         } parserData;
 461
 462         typedef struct {
 463                 bool key_up;
 464                 bool key_down;
 465                 bool key_enter;
 466                 bool key_escape;
 467         } fs_key_pendig;
 468
 469         fs_key_pendig current_keys_pending;
 470         std::string current_field_enter_pending;
 471
 472         void parseElement(parserData* data, const std::string &element);
 473
 474         void parseSize(parserData* data, const std::string &element);
 475         void parseContainer(parserData* data, const std::string &element);
 476         void parseContainerEnd(parserData* data);
 477         void parseList(parserData* data, const std::string &element);
 478         void parseListRing(parserData* data, const std::string &element);
 479         void parseCheckbox(parserData* data, const std::string &element);
 480         void parseImage(parserData* data, const std::string &element);
 481         void parseItemImage(parserData* data, const std::string &element);
 482         void parseButton(parserData* data, const std::string &element,
 483                         const std::string &typ);
 484         void parseBackground(parserData* data, const std::string &element);
 485         void parseTableOptions(parserData* data, const std::string &element);
 486         void parseTableColumns(parserData* data, const std::string &element);
 487         void parseTable(parserData* data, const std::string &element);
 488         void parseTextList(parserData* data, const std::string &element);
 489         void parseDropDown(parserData* data, const std::string &element);
 490         void parseFieldCloseOnEnter(parserData *data, const std::string &element);
 491         void parsePwdField(parserData* data, const std::string &element);
 492         void parseField(parserData* data, const std::string &element, const std::string &type);
 493         void parseSimpleField(parserData* data,std::vector<std::string> &parts);
 494         void parseTextArea(parserData* data,std::vector<std::string>& parts,
 495                         const std::string &type);
 496         void parseLabel(parserData* data, const std::string &element);
 497         void parseVertLabel(parserData* data, const std::string &element);
 498         void parseImageButton(parserData* data, const std::string &element,
 499                         const std::string &type);
 500         void parseItemImageButton(parserData* data, const std::string &element);
 501         void parseTabHeader(parserData* data, const std::string &element);
 502         void parseBox(parserData* data, const std::string &element);
 503         void parseBackgroundColor(parserData* data, const std::string &element);
 504         void parseListColors(parserData* data, const std::string &element);
 505         void parseTooltip(parserData* data, const std::string &element);
 506         bool parseVersionDirect(const std::string &data);
 507         bool parseSizeDirect(parserData* data, const std::string &element);
 508         void parseScrollBar(parserData* data, const std::string &element);
 509         bool parsePositionDirect(parserData *data, const std::string &element);
 510         void parsePosition(parserData *data, const std::string &element);
 511         bool parseAnchorDirect(parserData *data, const std::string &element);
 512         void parseAnchor(parserData *data, const std::string &element);
 513
 514         void tryClose();
 515
 516         void showTooltip(const std::wstring &text, const irr::video::SColor &color,
 517                 const irr::video::SColor &bgcolor);
 518
 519         /**
 520          * check if event is part of a double click
 521          * @param event event to evaluate
 522          * @return true/false if a doubleclick was detected
 523          */
 524         bool DoubleClickDetection(const SEvent event);
 525
 526         struct clickpos
 527         {
 528                 v2s32 pos;
 529                 s64 time;
 530         };
 531         clickpos m_doubleclickdetect[2];
 532
 533         int m_btn_height;
 534         gui::IGUIFont *m_font;
 535
 536         std::wstring getLabelByID(s32 id);
 537         std::string getNameByID(s32 id);
 538 #ifdef __ANDROID__
 539         v2s32 m_down_pos;
 540         std::string m_JavaDialogFieldName;
 541 #endif
 542
 543         /* If true, remap a double-click (or double-tap) action to ESC. This is so
 544          * that, for example, Android users can double-tap to close a formspec.
 545         *
 546          * This value can (currently) only be set by the class constructor
 547          * and the default value for the setting is true.
 548          */
 549         bool m_remap_dbl_click;
 550
 551 };
 552
 553 class FormspecFormSource: public IFormSource
 554 {
 555 public:
 556         FormspecFormSource(const std::string &formspec):
 557                 m_formspec(formspec)
 558         {
 559         }
 560
 561         ~FormspecFormSource()
 562         {
 563         }
 564
 565         void setForm(const std::string &formspec)
 566         {
 567                 m_formspec = FORMSPEC_VERSION_STRING + formspec;
 568         }
 569
 570         std::string getForm() { return m_formspec; }
 571
 572         std::string m_formspec;
 573 };
 574
 575 #endif