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
  26 #include "irrlichttypes_extrabloated.h"
  27 #include "inventory.h"
  28 #include "inventorymanager.h"
  29 #include "modalMenu.h"
  30 #include "guiTable.h"
  31 #include "clientserver.h"
  32
  33 class IGameDef;
  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() {};
  57         // This is deprecated I guess? -celeron55
  58         virtual void gotText(std::wstring text){}
  59         virtual void gotText(std::map<std::string, std::string> fields) = 0;
  60         virtual void setFormName(std::string formname)
  61         { m_formname = formname;};
  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(std::string str){ return str; }
  73 };
  74
  75 class GUIFormSpecMenu : public GUIModalMenu
  76 {
  77         struct ItemSpec
  78         {
  79                 ItemSpec()
  80                 {
  81                         i = -1;
  82                 }
  83                 ItemSpec(const InventoryLocation &a_inventoryloc,
  84                                 const std::string &a_listname,
  85                                 s32 a_i)
  86                 {
  87                         inventoryloc = a_inventoryloc;
  88                         listname = a_listname;
  89                         i = a_i;
  90                 }
  91                 bool isValid() const
  92                 {
  93                         return i != -1;
  94                 }
  95
  96                 InventoryLocation inventoryloc;
  97                 std::string listname;
  98                 s32 i;
  99         };
 100
 101         struct ListDrawSpec
 102         {
 103                 ListDrawSpec()
 104                 {
 105                 }
 106                 ListDrawSpec(const InventoryLocation &a_inventoryloc,
 107                                 const std::string &a_listname,
 108                                 v2s32 a_pos, v2s32 a_geom, s32 a_start_item_i):
 109                         inventoryloc(a_inventoryloc),
 110                         listname(a_listname),
 111                         pos(a_pos),
 112                         geom(a_geom),
 113                         start_item_i(a_start_item_i)
 114                 {
 115                 }
 116
 117                 InventoryLocation inventoryloc;
 118                 std::string listname;
 119                 v2s32 pos;
 120                 v2s32 geom;
 121                 s32 start_item_i;
 122         };
 123
 124         struct ImageDrawSpec
 125         {
 126                 ImageDrawSpec()
 127                 {
 128                 }
 129                 ImageDrawSpec(const std::string &a_name,
 130                                 v2s32 a_pos, v2s32 a_geom):
 131                         name(a_name),
 132                         pos(a_pos),
 133                         geom(a_geom)
 134                 {
 135                         scale = true;
 136                 }
 137                 ImageDrawSpec(const std::string &a_name,
 138                                 v2s32 a_pos):
 139                         name(a_name),
 140                         pos(a_pos)
 141                 {
 142                         scale = false;
 143                 }
 144                 std::string name;
 145                 v2s32 pos;
 146                 v2s32 geom;
 147                 bool scale;
 148         };
 149
 150         struct FieldSpec
 151         {
 152                 FieldSpec()
 153                 {
 154                 }
 155                 FieldSpec(const std::wstring &name, const std::wstring &label,
 156                                 const std::wstring &fdeflt, int id) :
 157                         fname(name),
 158                         flabel(label),
 159                         fdefault(fdeflt),
 160                         fid(id)
 161                 {
 162                         send = false;
 163                         ftype = f_Unknown;
 164                         is_exit = false;
 165                 }
 166                 std::wstring fname;
 167                 std::wstring flabel;
 168                 std::wstring fdefault;
 169                 int fid;
 170                 bool send;
 171                 FormspecFieldType ftype;
 172                 bool is_exit;
 173                 core::rect<s32> rect;
 174         };
 175
 176         struct BoxDrawSpec {
 177                 BoxDrawSpec(v2s32 a_pos, v2s32 a_geom,irr::video::SColor a_color):
 178                         pos(a_pos),
 179                         geom(a_geom),
 180                         color(a_color)
 181                 {
 182                 }
 183                 v2s32 pos;
 184                 v2s32 geom;
 185                 irr::video::SColor color;
 186         };
 187
 188         struct TooltipSpec {
 189                 TooltipSpec()
 190                 {
 191                 }
 192                 TooltipSpec(std::string a_tooltip, irr::video::SColor a_bgcolor,
 193                                 irr::video::SColor a_color):
 194                         tooltip(a_tooltip),
 195                         bgcolor(a_bgcolor),
 196                         color(a_color)
 197                 {
 198                 }
 199                 std::string tooltip;
 200                 irr::video::SColor bgcolor;
 201                 irr::video::SColor color;
 202         };
 203
 204 public:
 205         GUIFormSpecMenu(irr::IrrlichtDevice* dev,
 206                         gui::IGUIElement* parent, s32 id,
 207                         IMenuManager *menumgr,
 208                         InventoryManager *invmgr,
 209                         IGameDef *gamedef,
 210                         ISimpleTextureSource *tsrc,
 211                         IFormSource* fs_src,
 212                         TextDest* txt_dst,
 213                         Client* client
 214                         );
 215
 216         ~GUIFormSpecMenu();
 217
 218         void setFormSpec(const std::string &formspec_string,
 219                         InventoryLocation current_inventory_location)
 220         {
 221                 m_formspec_string = formspec_string;
 222                 m_current_inventory_location = current_inventory_location;
 223                 regenerateGui(m_screensize_old);
 224         }
 225
 226         // form_src is deleted by this GUIFormSpecMenu
 227         void setFormSource(IFormSource *form_src)
 228         {
 229                 if (m_form_src != NULL) {
 230                         delete m_form_src;
 231                 }
 232                 m_form_src = form_src;
 233         }
 234
 235         // text_dst is deleted by this GUIFormSpecMenu
 236         void setTextDest(TextDest *text_dst)
 237         {
 238                 if (m_text_dst != NULL) {
 239                         delete m_text_dst;
 240                 }
 241                 m_text_dst = text_dst;
 242         }
 243
 244         void allowClose(bool value)
 245         {
 246                 m_allowclose = value;
 247         }
 248
 249         void lockSize(bool lock,v2u32 basescreensize=v2u32(0,0)) {
 250                 m_lock = lock;
 251                 m_lockscreensize = basescreensize;
 252         }
 253
 254         void removeChildren();
 255         void setInitialFocus();
 256         /*
 257                 Remove and re-add (or reposition) stuff
 258         */
 259         void regenerateGui(v2u32 screensize);
 260
 261         ItemSpec getItemAtPos(v2s32 p) const;
 262         void drawList(const ListDrawSpec &s, int phase);
 263         void drawSelectedItem();
 264         void drawMenu();
 265         void updateSelectedItem();
 266         ItemStack verifySelectedItem();
 267
 268         void acceptInput(FormspecQuitMode quitmode);
 269         bool preprocessEvent(const SEvent& event);
 270         bool OnEvent(const SEvent& event);
 271         bool doPause;
 272         bool pausesGame() { return doPause; }
 273
 274         GUITable* getTable(std::wstring tablename);
 275
 276 #ifdef __ANDROID__
 277         bool getAndroidUIInput();
 278 #endif
 279
 280 protected:
 281         v2s32 getBasePos() const
 282         {
 283                         return padding + offset + AbsoluteRect.UpperLeftCorner;
 284         }
 285
 286         v2s32 padding;
 287         v2s32 spacing;
 288         v2s32 imgsize;
 289         v2s32 offset;
 290
 291         irr::IrrlichtDevice* m_device;
 292         InventoryManager *m_invmgr;
 293         IGameDef *m_gamedef;
 294         ISimpleTextureSource *m_tsrc;
 295         Client *m_client;
 296
 297         std::string m_formspec_string;
 298         InventoryLocation m_current_inventory_location;
 299
 300
 301         std::vector<ListDrawSpec> m_inventorylists;
 302         std::vector<ImageDrawSpec> m_backgrounds;
 303         std::vector<ImageDrawSpec> m_images;
 304         std::vector<ImageDrawSpec> m_itemimages;
 305         std::vector<BoxDrawSpec> m_boxes;
 306         std::vector<FieldSpec> m_fields;
 307         std::vector<std::pair<FieldSpec,GUITable*> > m_tables;
 308         std::vector<std::pair<FieldSpec,gui::IGUICheckBox*> > m_checkboxes;
 309         std::map<std::wstring, TooltipSpec> m_tooltips;
 310         std::vector<std::pair<FieldSpec,gui::IGUIScrollBar*> > m_scrollbars;
 311
 312         ItemSpec *m_selected_item;
 313         u32 m_selected_amount;
 314         bool m_selected_dragging;
 315
 316         // WARNING: BLACK MAGIC
 317         // Used to guess and keep up with some special things the server can do.
 318         // If name is "", no guess exists.
 319         ItemStack m_selected_content_guess;
 320         InventoryLocation m_selected_content_guess_inventory;
 321
 322         v2s32 m_pointer;
 323         v2s32 m_old_pointer;  // Mouse position after previous mouse event
 324         gui::IGUIStaticText *m_tooltip_element;
 325
 326         u32 m_tooltip_show_delay;
 327         s32 m_hovered_time;
 328         s32 m_old_tooltip_id;
 329         std::string m_old_tooltip;
 330
 331         bool m_allowclose;
 332         bool m_lock;
 333         v2u32 m_lockscreensize;
 334
 335         bool m_bgfullscreen;
 336         bool m_slotborder;
 337         bool m_clipbackground;
 338         video::SColor m_bgcolor;
 339         video::SColor m_slotbg_n;
 340         video::SColor m_slotbg_h;
 341         video::SColor m_slotbordercolor;
 342         video::SColor m_default_tooltip_bgcolor;
 343         video::SColor m_default_tooltip_color;
 344
 345 private:
 346         IFormSource      *m_form_src;
 347         TextDest         *m_text_dst;
 348         gui::IGUIFont    *m_font;
 349         unsigned int      m_formspec_version;
 350
 351         typedef struct {
 352                 v2s32 size;
 353                 core::rect<s32> rect;
 354                 v2s32 basepos;
 355                 int bp_set;
 356                 v2u32 screensize;
 357                 std::wstring focused_fieldname;
 358                 GUITable::TableOptions table_options;
 359                 GUITable::TableColumns table_columns;
 360                 // used to restore table selection/scroll/treeview state
 361                 std::map<std::wstring,GUITable::DynamicData> table_dyndata;
 362         } parserData;
 363
 364         typedef struct {
 365                 bool key_up;
 366                 bool key_down;
 367                 bool key_enter;
 368                 bool key_escape;
 369         } fs_key_pendig;
 370
 371         fs_key_pendig current_keys_pending;
 372
 373         void parseElement(parserData* data,std::string element);
 374
 375         void parseSize(parserData* data,std::string element);
 376         void parseList(parserData* data,std::string element);
 377         void parseCheckbox(parserData* data,std::string element);
 378         void parseImage(parserData* data,std::string element);
 379         void parseItemImage(parserData* data,std::string element);
 380         void parseButton(parserData* data,std::string element,std::string typ);
 381         void parseBackground(parserData* data,std::string element);
 382         void parseTableOptions(parserData* data,std::string element);
 383         void parseTableColumns(parserData* data,std::string element);
 384         void parseTable(parserData* data,std::string element);
 385         void parseTextList(parserData* data,std::string element);
 386         void parseDropDown(parserData* data,std::string element);
 387         void parsePwdField(parserData* data,std::string element);
 388         void parseField(parserData* data,std::string element,std::string type);
 389         void parseSimpleField(parserData* data,std::vector<std::string> &parts);
 390         void parseTextArea(parserData* data,std::vector<std::string>& parts,
 391                         std::string type);
 392         void parseLabel(parserData* data,std::string element);
 393         void parseVertLabel(parserData* data,std::string element);
 394         void parseImageButton(parserData* data,std::string element,std::string type);
 395         void parseItemImageButton(parserData* data,std::string element);
 396         void parseTabHeader(parserData* data,std::string element);
 397         void parseBox(parserData* data,std::string element);
 398         void parseBackgroundColor(parserData* data,std::string element);
 399         void parseListColors(parserData* data,std::string element);
 400         void parseTooltip(parserData* data,std::string element);
 401         bool parseVersionDirect(std::string data);
 402         void parseScrollBar(parserData* data, std::string element);
 403
 404         /**
 405          * check if event is part of a double click
 406          * @param event event to evaluate
 407          * @return true/false if a doubleclick was detected
 408          */
 409         bool DoubleClickDetection(const SEvent event);
 410
 411         struct clickpos
 412         {
 413                 v2s32 pos;
 414                 s32 time;
 415         };
 416         clickpos m_doubleclickdetect[2];
 417
 418         int m_btn_height;
 419
 420         std::wstring getLabelByID(s32 id);
 421         std::wstring getNameByID(s32 id);
 422 #ifdef __ANDROID__
 423         v2s32 m_down_pos;
 424         std::wstring m_JavaDialogFieldName;
 425 #endif
 426
 427 };
 428
 429 class FormspecFormSource: public IFormSource
 430 {
 431 public:
 432         FormspecFormSource(std::string formspec)
 433         {
 434                 m_formspec = formspec;
 435         }
 436
 437         ~FormspecFormSource()
 438         {}
 439
 440         void setForm(std::string formspec) {
 441                 m_formspec = FORMSPEC_VERSION_STRING + formspec;
 442         }
 443
 444         std::string getForm()
 445         {
 446                 return m_formspec;
 447         }
 448
 449         std::string m_formspec;
 450 };
 451
 452 #endif
 453