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.
25 #include "irrlichttypes_extrabloated.h"
26 #include "inventorymanager.h"
27 #include "modalMenu.h"
29 #include "network/networkprotocol.h"
30 #include "client/joystick_controller.h"
31 #include "util/string.h"
32 #include "util/enriched_string.h"
34 class InventoryManager;
35 class ISimpleTextureSource;
56 virtual ~TextDest() = default;
58 // This is deprecated I guess? -celeron55
59 virtual void gotText(const std::wstring &text) {}
60 virtual void gotText(const StringMap &fields) = 0;
62 std::string m_formname;
68 virtual ~IFormSource() = default;
69 virtual const std::string &getForm() const = 0;
70 // Fill in variables in field text
71 virtual std::string resolveText(const std::string &str) { return str; }
74 class GUIFormSpecMenu : public GUIModalMenu
80 ItemSpec(const InventoryLocation &a_inventoryloc,
81 const std::string &a_listname,
83 inventoryloc(a_inventoryloc),
89 bool isValid() const { return i != -1; }
91 InventoryLocation inventoryloc;
98 ListDrawSpec() = default;
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),
107 start_item_i(a_start_item_i)
111 InventoryLocation inventoryloc;
112 std::string listname;
120 ListRingSpec() = default;
122 ListRingSpec(const InventoryLocation &a_inventoryloc,
123 const std::string &a_listname):
124 inventoryloc(a_inventoryloc),
129 InventoryLocation inventoryloc;
130 std::string listname;
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):
146 item_name(a_item_name),
147 parent_button(a_parent_button),
155 ImageDrawSpec(const std::string &a_name,
156 const std::string &a_item_name,
157 const v2s32 &a_pos, const v2s32 &a_geom):
159 item_name(a_item_name),
168 ImageDrawSpec(const std::string &a_name,
169 const v2s32 &a_pos, const v2s32 &a_geom, bool clip=false):
179 ImageDrawSpec(const std::string &a_name,
190 std::string item_name;
191 gui::IGUIButton *parent_button;
200 FieldSpec() = default;
202 FieldSpec(const std::string &name, const std::wstring &label,
203 const std::wstring &default_text, int id) :
206 fdefault(unescape_enriched(translate_string(default_text))),
216 std::wstring fdefault;
219 FormspecFieldType ftype;
221 core::rect<s32> rect;
226 BoxDrawSpec(v2s32 a_pos, v2s32 a_geom,irr::video::SColor a_color):
234 irr::video::SColor color;
239 TooltipSpec() = default;
240 TooltipSpec(const std::wstring &a_tooltip, irr::video::SColor a_bgcolor,
241 irr::video::SColor a_color):
242 tooltip(translate_string(a_tooltip)),
248 std::wstring tooltip;
249 irr::video::SColor bgcolor;
250 irr::video::SColor color;
253 struct StaticTextSpec
260 StaticTextSpec(const std::wstring &a_text,
261 const core::rect<s32> &a_rect):
268 StaticTextSpec(const std::wstring &a_text,
269 const core::rect<s32> &a_rect,
270 gui::IGUIButton *a_parent_button):
273 parent_button(a_parent_button)
278 core::rect<s32> rect;
279 gui::IGUIButton *parent_button;
283 GUIFormSpecMenu(JoystickController *joystick,
284 gui::IGUIElement* parent, s32 id,
285 IMenuManager *menumgr,
287 ISimpleTextureSource *tsrc,
290 bool remap_dbl_click = true);
294 void setFormSpec(const std::string &formspec_string,
295 const InventoryLocation ¤t_inventory_location)
297 m_formspec_string = formspec_string;
298 m_current_inventory_location = current_inventory_location;
299 regenerateGui(m_screensize_old);
302 // form_src is deleted by this GUIFormSpecMenu
303 void setFormSource(IFormSource *form_src)
306 m_form_src = form_src;
309 // text_dst is deleted by this GUIFormSpecMenu
310 void setTextDest(TextDest *text_dst)
313 m_text_dst = text_dst;
316 void allowClose(bool value)
318 m_allowclose = value;
321 void lockSize(bool lock,v2u32 basescreensize=v2u32(0,0))
324 m_lockscreensize = basescreensize;
327 void removeChildren();
328 void setInitialFocus();
330 void setFocus(const std::string &elementname)
332 m_focused_element = elementname;
336 Remove and re-add (or reposition) stuff
338 void regenerateGui(v2u32 screensize);
340 ItemSpec getItemAtPos(v2s32 p) const;
341 void drawList(const ListDrawSpec &s, int phase, bool &item_hovered);
342 void drawSelectedItem();
344 void updateSelectedItem();
345 ItemStack verifySelectedItem();
347 void acceptInput(FormspecQuitMode quitmode);
348 bool preprocessEvent(const SEvent& event);
349 bool OnEvent(const SEvent& event);
351 bool pausesGame() { return doPause; }
353 GUITable* getTable(const std::string &tablename);
354 std::vector<std::string>* getDropDownValues(const std::string &name);
357 bool getAndroidUIInput();
361 v2s32 getBasePos() const
363 return padding + offset + AbsoluteRect.UpperLeftCorner;
371 std::stack<v2s32> container_stack;
373 InventoryManager *m_invmgr;
374 ISimpleTextureSource *m_tsrc;
377 std::string m_formspec_string;
378 InventoryLocation m_current_inventory_location;
380 std::vector<ListDrawSpec> m_inventorylists;
381 std::vector<ListRingSpec> m_inventory_rings;
382 std::vector<ImageDrawSpec> m_backgrounds;
383 std::vector<ImageDrawSpec> m_images;
384 std::vector<ImageDrawSpec> m_itemimages;
385 std::vector<BoxDrawSpec> m_boxes;
386 std::unordered_map<std::string, bool> field_close_on_enter;
387 std::vector<FieldSpec> m_fields;
388 std::vector<StaticTextSpec> m_static_texts;
389 std::vector<std::pair<FieldSpec,GUITable*> > m_tables;
390 std::vector<std::pair<FieldSpec,gui::IGUICheckBox*> > m_checkboxes;
391 std::map<std::string, TooltipSpec> m_tooltips;
392 std::vector<std::pair<FieldSpec,gui::IGUIScrollBar*> > m_scrollbars;
393 std::vector<std::pair<FieldSpec, std::vector<std::string> > > m_dropdowns;
395 ItemSpec *m_selected_item = nullptr;
396 u32 m_selected_amount = 0;
397 bool m_selected_dragging = false;
399 // WARNING: BLACK MAGIC
400 // Used to guess and keep up with some special things the server can do.
401 // If name is "", no guess exists.
402 ItemStack m_selected_content_guess;
403 InventoryLocation m_selected_content_guess_inventory;
406 v2s32 m_old_pointer; // Mouse position after previous mouse event
407 gui::IGUIStaticText *m_tooltip_element = nullptr;
409 u64 m_tooltip_show_delay;
410 bool m_tooltip_append_itemname;
411 u64 m_hovered_time = 0;
412 s32 m_old_tooltip_id = -1;
414 bool m_auto_place = false;
416 bool m_allowclose = true;
418 v2u32 m_lockscreensize;
422 video::SColor m_bgcolor;
423 video::SColor m_fullscreen_bgcolor;
424 video::SColor m_slotbg_n;
425 video::SColor m_slotbg_h;
426 video::SColor m_slotbordercolor;
427 video::SColor m_default_tooltip_bgcolor;
428 video::SColor m_default_tooltip_color;
431 IFormSource *m_form_src;
432 TextDest *m_text_dst;
433 u32 m_formspec_version = 0;
434 std::string m_focused_element = "";
435 JoystickController *m_joystick;
443 core::rect<s32> rect;
446 std::string focused_fieldname;
447 GUITable::TableOptions table_options;
448 GUITable::TableColumns table_columns;
449 // used to restore table selection/scroll/treeview state
450 std::unordered_map<std::string, GUITable::DynamicData> table_dyndata;
460 fs_key_pendig current_keys_pending;
461 std::string current_field_enter_pending = "";
463 void parseElement(parserData* data, const std::string &element);
465 void parseSize(parserData* data, const std::string &element);
466 void parseContainer(parserData* data, const std::string &element);
467 void parseContainerEnd(parserData* data);
468 void parseList(parserData* data, const std::string &element);
469 void parseListRing(parserData* data, const std::string &element);
470 void parseCheckbox(parserData* data, const std::string &element);
471 void parseImage(parserData* data, const std::string &element);
472 void parseItemImage(parserData* data, const std::string &element);
473 void parseButton(parserData* data, const std::string &element,
474 const std::string &typ);
475 void parseBackground(parserData* data, const std::string &element);
476 void parseTableOptions(parserData* data, const std::string &element);
477 void parseTableColumns(parserData* data, const std::string &element);
478 void parseTable(parserData* data, const std::string &element);
479 void parseTextList(parserData* data, const std::string &element);
480 void parseDropDown(parserData* data, const std::string &element);
481 void parseFieldCloseOnEnter(parserData *data, const std::string &element);
482 void parsePwdField(parserData* data, const std::string &element);
483 void parseField(parserData* data, const std::string &element, const std::string &type);
484 void parseSimpleField(parserData* data,std::vector<std::string> &parts);
485 void parseTextArea(parserData* data,std::vector<std::string>& parts,
486 const std::string &type);
487 void parseLabel(parserData* data, const std::string &element);
488 void parseVertLabel(parserData* data, const std::string &element);
489 void parseImageButton(parserData* data, const std::string &element,
490 const std::string &type);
491 void parseItemImageButton(parserData* data, const std::string &element);
492 void parseTabHeader(parserData* data, const std::string &element);
493 void parseBox(parserData* data, const std::string &element);
494 void parseBackgroundColor(parserData* data, const std::string &element);
495 void parseListColors(parserData* data, const std::string &element);
496 void parseTooltip(parserData* data, const std::string &element);
497 bool parseVersionDirect(const std::string &data);
498 bool parseSizeDirect(parserData* data, const std::string &element);
499 void parseScrollBar(parserData* data, const std::string &element);
500 bool parsePositionDirect(parserData *data, const std::string &element);
501 void parsePosition(parserData *data, const std::string &element);
502 bool parseAnchorDirect(parserData *data, const std::string &element);
503 void parseAnchor(parserData *data, const std::string &element);
507 void showTooltip(const std::wstring &text, const irr::video::SColor &color,
508 const irr::video::SColor &bgcolor);
511 * check if event is part of a double click
512 * @param event event to evaluate
513 * @return true/false if a doubleclick was detected
515 bool DoubleClickDetection(const SEvent event);
522 clickpos m_doubleclickdetect[2];
525 gui::IGUIFont *m_font = nullptr;
527 std::wstring getLabelByID(s32 id);
528 std::string getNameByID(s32 id);
531 std::string m_JavaDialogFieldName;
534 /* If true, remap a double-click (or double-tap) action to ESC. This is so
535 * that, for example, Android users can double-tap to close a formspec.
537 * This value can (currently) only be set by the class constructor
538 * and the default value for the setting is true.
540 bool m_remap_dbl_click;
544 class FormspecFormSource: public IFormSource
547 FormspecFormSource(const std::string &formspec):
552 ~FormspecFormSource() = default;
554 void setForm(const std::string &formspec)
556 m_formspec = FORMSPEC_VERSION_STRING + formspec;
559 const std::string &getForm() const
564 std::string m_formspec;