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 "inventory.h"
29 #include "inventorymanager.h"
30 #include "modalMenu.h"
32 #include "network/networkprotocol.h"
33 #include "client/joystick_controller.h"
34 #include "util/string.h"
35 #include "util/enriched_string.h"
37 class InventoryManager;
38 class ISimpleTextureSource;
59 virtual ~TextDest() {};
60 // This is deprecated I guess? -celeron55
61 virtual void gotText(std::wstring text){}
62 virtual void gotText(const StringMap &fields) = 0;
63 virtual void setFormName(std::string formname)
64 { m_formname = formname;};
66 std::string m_formname;
72 virtual ~IFormSource(){}
73 virtual std::string getForm() = 0;
74 // Fill in variables in field text
75 virtual std::string resolveText(std::string str){ return str; }
78 class GUIFormSpecMenu : public GUIModalMenu
86 ItemSpec(const InventoryLocation &a_inventoryloc,
87 const std::string &a_listname,
90 inventoryloc = a_inventoryloc;
91 listname = a_listname;
99 InventoryLocation inventoryloc;
100 std::string listname;
109 ListDrawSpec(const InventoryLocation &a_inventoryloc,
110 const std::string &a_listname,
111 v2s32 a_pos, v2s32 a_geom, s32 a_start_item_i):
112 inventoryloc(a_inventoryloc),
113 listname(a_listname),
116 start_item_i(a_start_item_i)
120 InventoryLocation inventoryloc;
121 std::string listname;
132 ListRingSpec(const InventoryLocation &a_inventoryloc,
133 const std::string &a_listname):
134 inventoryloc(a_inventoryloc),
139 InventoryLocation inventoryloc;
140 std::string listname;
150 ImageDrawSpec(const std::string &a_name,
151 const std::string &a_item_name,
152 gui::IGUIButton *a_parent_button,
153 const v2s32 &a_pos, const v2s32 &a_geom):
155 item_name(a_item_name),
156 parent_button(a_parent_button),
163 ImageDrawSpec(const std::string &a_name,
164 const std::string &a_item_name,
165 const v2s32 &a_pos, const v2s32 &a_geom):
167 item_name(a_item_name),
175 ImageDrawSpec(const std::string &a_name,
176 const v2s32 &a_pos, const v2s32 &a_geom, bool clip=false):
185 ImageDrawSpec(const std::string &a_name,
195 std::string item_name;
196 gui::IGUIButton *parent_button;
208 FieldSpec(const std::string &name, const std::wstring &label,
209 const std::wstring &default_text, int id) :
217 //flabel = unescape_enriched(label);
218 fdefault = unescape_enriched(default_text);
222 std::wstring fdefault;
225 FormspecFieldType ftype;
227 core::rect<s32> rect;
231 BoxDrawSpec(v2s32 a_pos, v2s32 a_geom,irr::video::SColor a_color):
239 irr::video::SColor color;
246 TooltipSpec(std::string a_tooltip, irr::video::SColor a_bgcolor,
247 irr::video::SColor a_color):
251 //tooltip = unescape_enriched(utf8_to_wide(a_tooltip));
252 tooltip = utf8_to_wide(a_tooltip);
254 std::wstring tooltip;
255 irr::video::SColor bgcolor;
256 irr::video::SColor color;
259 struct StaticTextSpec {
264 StaticTextSpec(const std::wstring &a_text,
265 const core::rect<s32> &a_rect):
269 //text = unescape_enriched(a_text);
272 StaticTextSpec(const std::wstring &a_text,
273 const core::rect<s32> &a_rect,
274 gui::IGUIButton *a_parent_button):
276 parent_button(a_parent_button)
278 //text = unescape_enriched(a_text);
282 core::rect<s32> rect;
283 gui::IGUIButton *parent_button;
287 GUIFormSpecMenu(irr::IrrlichtDevice* dev,
288 JoystickController *joystick,
289 gui::IGUIElement* parent, s32 id,
290 IMenuManager *menumgr,
292 ISimpleTextureSource *tsrc,
295 bool remap_dbl_click = true);
299 void setFormSpec(const std::string &formspec_string,
300 InventoryLocation current_inventory_location)
302 m_formspec_string = formspec_string;
303 m_current_inventory_location = current_inventory_location;
304 regenerateGui(m_screensize_old);
307 // form_src is deleted by this GUIFormSpecMenu
308 void setFormSource(IFormSource *form_src)
310 if (m_form_src != NULL) {
313 m_form_src = form_src;
316 // text_dst is deleted by this GUIFormSpecMenu
317 void setTextDest(TextDest *text_dst)
319 if (m_text_dst != NULL) {
322 m_text_dst = text_dst;
325 void allowClose(bool value)
327 m_allowclose = value;
330 void lockSize(bool lock,v2u32 basescreensize=v2u32(0,0))
333 m_lockscreensize = basescreensize;
336 void removeChildren();
337 void setInitialFocus();
339 void setFocus(std::string &elementname)
341 m_focused_element = elementname;
345 Remove and re-add (or reposition) stuff
347 void regenerateGui(v2u32 screensize);
349 ItemSpec getItemAtPos(v2s32 p) const;
350 void drawList(const ListDrawSpec &s, int phase, bool &item_hovered);
351 void drawSelectedItem();
353 void updateSelectedItem();
354 ItemStack verifySelectedItem();
356 void acceptInput(FormspecQuitMode quitmode);
357 bool preprocessEvent(const SEvent& event);
358 bool OnEvent(const SEvent& event);
360 bool pausesGame() { return doPause; }
362 GUITable* getTable(const std::string &tablename);
363 std::vector<std::string>* getDropDownValues(const std::string &name);
366 bool getAndroidUIInput();
370 v2s32 getBasePos() const
372 return padding + offset + AbsoluteRect.UpperLeftCorner;
380 std::stack<v2s32> container_stack;
382 irr::IrrlichtDevice* m_device;
383 InventoryManager *m_invmgr;
384 ISimpleTextureSource *m_tsrc;
387 std::string m_formspec_string;
388 InventoryLocation m_current_inventory_location;
391 std::vector<ListDrawSpec> m_inventorylists;
392 std::vector<ListRingSpec> m_inventory_rings;
393 std::vector<ImageDrawSpec> m_backgrounds;
394 std::vector<ImageDrawSpec> m_images;
395 std::vector<ImageDrawSpec> m_itemimages;
396 std::vector<BoxDrawSpec> m_boxes;
397 UNORDERED_MAP<std::string, bool> field_close_on_enter;
398 std::vector<FieldSpec> m_fields;
399 std::vector<StaticTextSpec> m_static_texts;
400 std::vector<std::pair<FieldSpec,GUITable*> > m_tables;
401 std::vector<std::pair<FieldSpec,gui::IGUICheckBox*> > m_checkboxes;
402 std::map<std::string, TooltipSpec> m_tooltips;
403 std::vector<std::pair<FieldSpec,gui::IGUIScrollBar*> > m_scrollbars;
404 std::vector<std::pair<FieldSpec, std::vector<std::string> > > m_dropdowns;
406 ItemSpec *m_selected_item;
407 u32 m_selected_amount;
408 bool m_selected_dragging;
410 // WARNING: BLACK MAGIC
411 // Used to guess and keep up with some special things the server can do.
412 // If name is "", no guess exists.
413 ItemStack m_selected_content_guess;
414 InventoryLocation m_selected_content_guess_inventory;
417 v2s32 m_old_pointer; // Mouse position after previous mouse event
418 gui::IGUIStaticText *m_tooltip_element;
420 u32 m_tooltip_show_delay;
422 s32 m_old_tooltip_id;
423 std::wstring m_old_tooltip;
425 bool m_rmouse_auto_place;
429 v2u32 m_lockscreensize;
433 video::SColor m_bgcolor;
434 video::SColor m_slotbg_n;
435 video::SColor m_slotbg_h;
436 video::SColor m_slotbordercolor;
437 video::SColor m_default_tooltip_bgcolor;
438 video::SColor m_default_tooltip_color;
441 IFormSource *m_form_src;
442 TextDest *m_text_dst;
443 unsigned int m_formspec_version;
444 std::string m_focused_element;
445 JoystickController *m_joystick;
451 core::rect<s32> rect;
454 std::string focused_fieldname;
455 GUITable::TableOptions table_options;
456 GUITable::TableColumns table_columns;
457 // used to restore table selection/scroll/treeview state
458 UNORDERED_MAP<std::string, GUITable::DynamicData> table_dyndata;
468 fs_key_pendig current_keys_pending;
469 std::string current_field_enter_pending;
471 void parseElement(parserData* data, std::string element);
473 void parseSize(parserData* data, std::string element);
474 void parseContainer(parserData* data, std::string element);
475 void parseContainerEnd(parserData* data);
476 void parseList(parserData* data, std::string element);
477 void parseListRing(parserData* data, std::string element);
478 void parseCheckbox(parserData* data, std::string element);
479 void parseImage(parserData* data, std::string element);
480 void parseItemImage(parserData* data,std::string element);
481 void parseButton(parserData* data,std::string element,std::string typ);
482 void parseBackground(parserData* data,std::string element);
483 void parseTableOptions(parserData* data,std::string element);
484 void parseTableColumns(parserData* data,std::string element);
485 void parseTable(parserData* data,std::string element);
486 void parseTextList(parserData* data,std::string element);
487 void parseDropDown(parserData* data,std::string element);
488 void parseFieldCloseOnEnter(parserData *data, const std::string &element);
489 void parsePwdField(parserData* data,std::string element);
490 void parseField(parserData* data,std::string element,std::string type);
491 void parseSimpleField(parserData* data,std::vector<std::string> &parts);
492 void parseTextArea(parserData* data,std::vector<std::string>& parts,
494 void parseLabel(parserData* data,std::string element);
495 void parseVertLabel(parserData* data,std::string element);
496 void parseImageButton(parserData* data,std::string element,std::string type);
497 void parseItemImageButton(parserData* data,std::string element);
498 void parseTabHeader(parserData* data,std::string element);
499 void parseBox(parserData* data,std::string element);
500 void parseBackgroundColor(parserData* data,std::string element);
501 void parseListColors(parserData* data,std::string element);
502 void parseTooltip(parserData* data,std::string element);
503 bool parseVersionDirect(std::string data);
504 bool parseSizeDirect(parserData* data, std::string element);
505 void parseScrollBar(parserData* data, std::string element);
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
514 bool DoubleClickDetection(const SEvent event);
521 clickpos m_doubleclickdetect[2];
524 gui::IGUIFont *m_font;
526 std::wstring getLabelByID(s32 id);
527 std::string getNameByID(s32 id);
530 std::string m_JavaDialogFieldName;
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.
536 * This value can (currently) only be set by the class constructor
537 * and the default value for the setting is true.
539 bool m_remap_dbl_click;
543 class FormspecFormSource: public IFormSource
546 FormspecFormSource(std::string formspec)
548 m_formspec = formspec;
551 ~FormspecFormSource()
554 void setForm(std::string formspec) {
555 m_formspec = FORMSPEC_VERSION_STRING + formspec;
558 std::string getForm()
563 std::string m_formspec;