3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
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.
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.
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.
21 #ifndef GUIINVENTORYMENU_HEADER
22 #define GUIINVENTORYMENU_HEADER
27 #include "irrlichttypes_extrabloated.h"
28 #include "inventorymanager.h"
29 #include "modalMenu.h"
31 #include "network/networkprotocol.h"
32 #include "client/joystick_controller.h"
33 #include "util/string.h"
34 #include "util/enriched_string.h"
36 class InventoryManager;
37 class ISimpleTextureSource;
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;
63 std::string m_formname;
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; }
75 class GUIFormSpecMenu : public GUIModalMenu
84 ItemSpec(const InventoryLocation &a_inventoryloc,
85 const std::string &a_listname,
87 inventoryloc(a_inventoryloc),
93 bool isValid() const { return i != -1; }
95 InventoryLocation inventoryloc;
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),
112 start_item_i(a_start_item_i)
116 InventoryLocation inventoryloc;
117 std::string listname;
128 ListRingSpec(const InventoryLocation &a_inventoryloc,
129 const std::string &a_listname):
130 inventoryloc(a_inventoryloc),
135 InventoryLocation inventoryloc;
136 std::string listname;
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):
152 item_name(a_item_name),
153 parent_button(a_parent_button),
161 ImageDrawSpec(const std::string &a_name,
162 const std::string &a_item_name,
163 const v2s32 &a_pos, const v2s32 &a_geom):
165 item_name(a_item_name),
174 ImageDrawSpec(const std::string &a_name,
175 const v2s32 &a_pos, const v2s32 &a_geom, bool clip=false):
185 ImageDrawSpec(const std::string &a_name,
196 std::string item_name;
197 gui::IGUIButton *parent_button;
209 FieldSpec(const std::string &name, const std::wstring &label,
210 const std::wstring &default_text, int id) :
213 fdefault(unescape_enriched(default_text)),
223 std::wstring fdefault;
226 FormspecFieldType ftype;
228 core::rect<s32> rect;
233 BoxDrawSpec(v2s32 a_pos, v2s32 a_geom,irr::video::SColor a_color):
241 irr::video::SColor color;
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)),
255 std::wstring tooltip;
256 irr::video::SColor bgcolor;
257 irr::video::SColor color;
260 struct StaticTextSpec
267 StaticTextSpec(const std::wstring &a_text,
268 const core::rect<s32> &a_rect):
275 StaticTextSpec(const std::wstring &a_text,
276 const core::rect<s32> &a_rect,
277 gui::IGUIButton *a_parent_button):
280 parent_button(a_parent_button)
285 core::rect<s32> rect;
286 gui::IGUIButton *parent_button;
290 GUIFormSpecMenu(irr::IrrlichtDevice* dev,
291 JoystickController *joystick,
292 gui::IGUIElement* parent, s32 id,
293 IMenuManager *menumgr,
295 ISimpleTextureSource *tsrc,
298 bool remap_dbl_click = true);
302 void setFormSpec(const std::string &formspec_string,
303 const InventoryLocation ¤t_inventory_location)
305 m_formspec_string = formspec_string;
306 m_current_inventory_location = current_inventory_location;
307 regenerateGui(m_screensize_old);
310 // form_src is deleted by this GUIFormSpecMenu
311 void setFormSource(IFormSource *form_src)
313 if (m_form_src != NULL) {
316 m_form_src = form_src;
319 // text_dst is deleted by this GUIFormSpecMenu
320 void setTextDest(TextDest *text_dst)
322 if (m_text_dst != NULL) {
325 m_text_dst = text_dst;
328 void allowClose(bool value)
330 m_allowclose = value;
333 void lockSize(bool lock,v2u32 basescreensize=v2u32(0,0))
336 m_lockscreensize = basescreensize;
339 void removeChildren();
340 void setInitialFocus();
342 void setFocus(const std::string &elementname)
344 m_focused_element = elementname;
348 Remove and re-add (or reposition) stuff
350 void regenerateGui(v2u32 screensize);
352 ItemSpec getItemAtPos(v2s32 p) const;
353 void drawList(const ListDrawSpec &s, int phase, bool &item_hovered);
354 void drawSelectedItem();
356 void updateSelectedItem();
357 ItemStack verifySelectedItem();
359 void acceptInput(FormspecQuitMode quitmode);
360 bool preprocessEvent(const SEvent& event);
361 bool OnEvent(const SEvent& event);
363 bool pausesGame() { return doPause; }
365 GUITable* getTable(const std::string &tablename);
366 std::vector<std::string>* getDropDownValues(const std::string &name);
369 bool getAndroidUIInput();
373 v2s32 getBasePos() const
375 return padding + offset + AbsoluteRect.UpperLeftCorner;
383 std::stack<v2s32> container_stack;
385 irr::IrrlichtDevice* m_device;
386 InventoryManager *m_invmgr;
387 ISimpleTextureSource *m_tsrc;
390 std::string m_formspec_string;
391 InventoryLocation m_current_inventory_location;
394 std::vector<ListDrawSpec> m_inventorylists;
395 std::vector<ListRingSpec> m_inventory_rings;
396 std::vector<ImageDrawSpec> m_backgrounds;
397 std::vector<ImageDrawSpec> m_images;
398 std::vector<ImageDrawSpec> m_itemimages;
399 std::vector<BoxDrawSpec> m_boxes;
400 UNORDERED_MAP<std::string, bool> field_close_on_enter;
401 std::vector<FieldSpec> m_fields;
402 std::vector<StaticTextSpec> m_static_texts;
403 std::vector<std::pair<FieldSpec,GUITable*> > m_tables;
404 std::vector<std::pair<FieldSpec,gui::IGUICheckBox*> > m_checkboxes;
405 std::map<std::string, TooltipSpec> m_tooltips;
406 std::vector<std::pair<FieldSpec,gui::IGUIScrollBar*> > m_scrollbars;
407 std::vector<std::pair<FieldSpec, std::vector<std::string> > > m_dropdowns;
409 ItemSpec *m_selected_item;
410 u32 m_selected_amount;
411 bool m_selected_dragging;
413 // WARNING: BLACK MAGIC
414 // Used to guess and keep up with some special things the server can do.
415 // If name is "", no guess exists.
416 ItemStack m_selected_content_guess;
417 InventoryLocation m_selected_content_guess_inventory;
420 v2s32 m_old_pointer; // Mouse position after previous mouse event
421 gui::IGUIStaticText *m_tooltip_element;
423 u32 m_tooltip_show_delay;
425 s32 m_old_tooltip_id;
426 std::wstring m_old_tooltip;
428 bool m_rmouse_auto_place;
432 v2u32 m_lockscreensize;
436 video::SColor m_bgcolor;
437 video::SColor m_slotbg_n;
438 video::SColor m_slotbg_h;
439 video::SColor m_slotbordercolor;
440 video::SColor m_default_tooltip_bgcolor;
441 video::SColor m_default_tooltip_color;
444 IFormSource *m_form_src;
445 TextDest *m_text_dst;
446 unsigned int m_formspec_version;
447 std::string m_focused_element;
448 JoystickController *m_joystick;
456 core::rect<s32> rect;
459 std::string focused_fieldname;
460 GUITable::TableOptions table_options;
461 GUITable::TableColumns table_columns;
462 // used to restore table selection/scroll/treeview state
463 UNORDERED_MAP<std::string, GUITable::DynamicData> table_dyndata;
473 fs_key_pendig current_keys_pending;
474 std::string current_field_enter_pending;
476 void parseElement(parserData* data, const std::string &element);
478 void parseSize(parserData* data, const std::string &element);
479 void parseContainer(parserData* data, const std::string &element);
480 void parseContainerEnd(parserData* data);
481 void parseList(parserData* data, const std::string &element);
482 void parseListRing(parserData* data, const std::string &element);
483 void parseCheckbox(parserData* data, const std::string &element);
484 void parseImage(parserData* data, const std::string &element);
485 void parseItemImage(parserData* data, const std::string &element);
486 void parseButton(parserData* data, const std::string &element,
487 const std::string &typ);
488 void parseBackground(parserData* data, const std::string &element);
489 void parseTableOptions(parserData* data, const std::string &element);
490 void parseTableColumns(parserData* data, const std::string &element);
491 void parseTable(parserData* data, const std::string &element);
492 void parseTextList(parserData* data, const std::string &element);
493 void parseDropDown(parserData* data, const std::string &element);
494 void parseFieldCloseOnEnter(parserData *data, const std::string &element);
495 void parsePwdField(parserData* data, const std::string &element);
496 void parseField(parserData* data, const std::string &element, const std::string &type);
497 void parseSimpleField(parserData* data,std::vector<std::string> &parts);
498 void parseTextArea(parserData* data,std::vector<std::string>& parts,
499 const std::string &type);
500 void parseLabel(parserData* data, const std::string &element);
501 void parseVertLabel(parserData* data, const std::string &element);
502 void parseImageButton(parserData* data, const std::string &element,
503 const std::string &type);
504 void parseItemImageButton(parserData* data, const std::string &element);
505 void parseTabHeader(parserData* data, const std::string &element);
506 void parseBox(parserData* data, const std::string &element);
507 void parseBackgroundColor(parserData* data, const std::string &element);
508 void parseListColors(parserData* data, const std::string &element);
509 void parseTooltip(parserData* data, const std::string &element);
510 bool parseVersionDirect(const std::string &data);
511 bool parseSizeDirect(parserData* data, const std::string &element);
512 void parseScrollBar(parserData* data, const std::string &element);
513 bool parsePositionDirect(parserData *data, const std::string &element);
514 void parsePosition(parserData *data, const std::string &element);
515 bool parseAnchorDirect(parserData *data, const std::string &element);
516 void parseAnchor(parserData *data, const std::string &element);
521 * check if event is part of a double click
522 * @param event event to evaluate
523 * @return true/false if a doubleclick was detected
525 bool DoubleClickDetection(const SEvent event);
532 clickpos m_doubleclickdetect[2];
535 gui::IGUIFont *m_font;
537 std::wstring getLabelByID(s32 id);
538 std::string getNameByID(s32 id);
541 std::string m_JavaDialogFieldName;
544 /* If true, remap a double-click (or double-tap) action to ESC. This is so
545 * that, for example, Android users can double-tap to close a formspec.
547 * This value can (currently) only be set by the class constructor
548 * and the default value for the setting is true.
550 bool m_remap_dbl_click;
554 class FormspecFormSource: public IFormSource
557 FormspecFormSource(const std::string &formspec):
562 ~FormspecFormSource()
566 void setForm(const std::string &formspec)
568 m_formspec = FORMSPEC_VERSION_STRING + formspec;
571 std::string getForm() { return m_formspec; }
573 std::string m_formspec;