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