mirror of https://github.com/minetest/minetest.git
606 lines
15 KiB
C++
606 lines
15 KiB
C++
/*
|
|
Minetest
|
|
Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU Lesser General Public License as published by
|
|
the Free Software Foundation; either version 2.1 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public License along
|
|
with this program; if not, write to the Free Software Foundation, Inc.,
|
|
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <utility>
|
|
#include <stack>
|
|
#include <unordered_set>
|
|
|
|
#include "irrlichttypes_extrabloated.h"
|
|
#include "inventorymanager.h"
|
|
#include "modalMenu.h"
|
|
#include "guiTable.h"
|
|
#include "network/networkprotocol.h"
|
|
#include "client/joystick_controller.h"
|
|
#include "util/string.h"
|
|
#include "util/enriched_string.h"
|
|
#include "StyleSpec.h"
|
|
|
|
class InventoryManager;
|
|
class ISimpleTextureSource;
|
|
class Client;
|
|
|
|
typedef enum {
|
|
f_Button,
|
|
f_Table,
|
|
f_TabHeader,
|
|
f_CheckBox,
|
|
f_DropDown,
|
|
f_ScrollBar,
|
|
f_Unknown
|
|
} FormspecFieldType;
|
|
|
|
typedef enum {
|
|
quit_mode_no,
|
|
quit_mode_accept,
|
|
quit_mode_cancel
|
|
} FormspecQuitMode;
|
|
|
|
struct TextDest
|
|
{
|
|
virtual ~TextDest() = default;
|
|
|
|
// This is deprecated I guess? -celeron55
|
|
virtual void gotText(const std::wstring &text) {}
|
|
virtual void gotText(const StringMap &fields) = 0;
|
|
|
|
std::string m_formname;
|
|
};
|
|
|
|
class IFormSource
|
|
{
|
|
public:
|
|
virtual ~IFormSource() = default;
|
|
virtual const std::string &getForm() const = 0;
|
|
// Fill in variables in field text
|
|
virtual std::string resolveText(const std::string &str) { return str; }
|
|
};
|
|
|
|
class GUIFormSpecMenu : public GUIModalMenu
|
|
{
|
|
struct ItemSpec
|
|
{
|
|
ItemSpec() = default;
|
|
|
|
ItemSpec(const InventoryLocation &a_inventoryloc,
|
|
const std::string &a_listname,
|
|
s32 a_i) :
|
|
inventoryloc(a_inventoryloc),
|
|
listname(a_listname),
|
|
i(a_i)
|
|
{
|
|
}
|
|
|
|
bool isValid() const { return i != -1; }
|
|
|
|
InventoryLocation inventoryloc;
|
|
std::string listname;
|
|
s32 i = -1;
|
|
};
|
|
|
|
struct ListDrawSpec
|
|
{
|
|
ListDrawSpec() = default;
|
|
|
|
ListDrawSpec(const InventoryLocation &a_inventoryloc,
|
|
const std::string &a_listname,
|
|
v2s32 a_pos, v2s32 a_geom, s32 a_start_item_i,
|
|
bool a_real_coordinates):
|
|
inventoryloc(a_inventoryloc),
|
|
listname(a_listname),
|
|
pos(a_pos),
|
|
geom(a_geom),
|
|
start_item_i(a_start_item_i),
|
|
real_coordinates(a_real_coordinates)
|
|
{
|
|
}
|
|
|
|
InventoryLocation inventoryloc;
|
|
std::string listname;
|
|
v2s32 pos;
|
|
v2s32 geom;
|
|
s32 start_item_i;
|
|
bool real_coordinates;
|
|
};
|
|
|
|
struct ListRingSpec
|
|
{
|
|
ListRingSpec() = default;
|
|
|
|
ListRingSpec(const InventoryLocation &a_inventoryloc,
|
|
const std::string &a_listname):
|
|
inventoryloc(a_inventoryloc),
|
|
listname(a_listname)
|
|
{
|
|
}
|
|
|
|
InventoryLocation inventoryloc;
|
|
std::string listname;
|
|
};
|
|
|
|
struct ImageDrawSpec
|
|
{
|
|
ImageDrawSpec():
|
|
parent_button(NULL),
|
|
clip(false)
|
|
{
|
|
}
|
|
|
|
ImageDrawSpec(const std::string &a_name,
|
|
const std::string &a_item_name,
|
|
gui::IGUIButton *a_parent_button,
|
|
const v2s32 &a_pos, const v2s32 &a_geom):
|
|
name(a_name),
|
|
item_name(a_item_name),
|
|
parent_button(a_parent_button),
|
|
pos(a_pos),
|
|
geom(a_geom),
|
|
scale(true),
|
|
clip(false)
|
|
{
|
|
}
|
|
|
|
ImageDrawSpec(const std::string &a_name,
|
|
const std::string &a_item_name,
|
|
const v2s32 &a_pos, const v2s32 &a_geom):
|
|
name(a_name),
|
|
item_name(a_item_name),
|
|
parent_button(NULL),
|
|
pos(a_pos),
|
|
geom(a_geom),
|
|
scale(true),
|
|
clip(false)
|
|
{
|
|
}
|
|
|
|
ImageDrawSpec(const std::string &a_name,
|
|
const v2s32 &a_pos, const v2s32 &a_geom, bool clip=false):
|
|
name(a_name),
|
|
parent_button(NULL),
|
|
pos(a_pos),
|
|
geom(a_geom),
|
|
scale(true),
|
|
clip(clip)
|
|
{
|
|
}
|
|
|
|
ImageDrawSpec(const std::string &a_name,
|
|
const v2s32 &a_pos, const v2s32 &a_geom, const core::rect<s32> &middle, bool clip=false):
|
|
name(a_name),
|
|
parent_button(NULL),
|
|
pos(a_pos),
|
|
geom(a_geom),
|
|
middle(middle),
|
|
scale(true),
|
|
clip(clip)
|
|
{
|
|
}
|
|
|
|
ImageDrawSpec(const std::string &a_name,
|
|
const v2s32 &a_pos):
|
|
name(a_name),
|
|
parent_button(NULL),
|
|
pos(a_pos),
|
|
scale(false),
|
|
clip(false)
|
|
{
|
|
}
|
|
|
|
std::string name;
|
|
std::string item_name;
|
|
gui::IGUIButton *parent_button;
|
|
v2s32 pos;
|
|
v2s32 geom;
|
|
core::rect<s32> middle;
|
|
bool scale;
|
|
bool clip;
|
|
};
|
|
|
|
struct FieldSpec
|
|
{
|
|
FieldSpec() = default;
|
|
|
|
FieldSpec(const std::string &name, const std::wstring &label,
|
|
const std::wstring &default_text, int id) :
|
|
fname(name),
|
|
flabel(label),
|
|
fdefault(unescape_enriched(translate_string(default_text))),
|
|
fid(id),
|
|
send(false),
|
|
ftype(f_Unknown),
|
|
is_exit(false)
|
|
{
|
|
}
|
|
|
|
std::string fname;
|
|
std::wstring flabel;
|
|
std::wstring fdefault;
|
|
int fid;
|
|
bool send;
|
|
FormspecFieldType ftype;
|
|
bool is_exit;
|
|
core::rect<s32> rect;
|
|
};
|
|
|
|
struct BoxDrawSpec
|
|
{
|
|
BoxDrawSpec(v2s32 a_pos, v2s32 a_geom, irr::video::SColor a_color):
|
|
pos(a_pos),
|
|
geom(a_geom),
|
|
color(a_color)
|
|
{
|
|
}
|
|
v2s32 pos;
|
|
v2s32 geom;
|
|
irr::video::SColor color;
|
|
};
|
|
|
|
struct TooltipSpec
|
|
{
|
|
TooltipSpec() = default;
|
|
TooltipSpec(const std::wstring &a_tooltip, irr::video::SColor a_bgcolor,
|
|
irr::video::SColor a_color):
|
|
tooltip(translate_string(a_tooltip)),
|
|
bgcolor(a_bgcolor),
|
|
color(a_color)
|
|
{
|
|
}
|
|
|
|
std::wstring tooltip;
|
|
irr::video::SColor bgcolor;
|
|
irr::video::SColor color;
|
|
};
|
|
|
|
struct StaticTextSpec
|
|
{
|
|
StaticTextSpec():
|
|
parent_button(NULL)
|
|
{
|
|
}
|
|
|
|
StaticTextSpec(const std::wstring &a_text,
|
|
const core::rect<s32> &a_rect):
|
|
text(a_text),
|
|
rect(a_rect),
|
|
parent_button(NULL)
|
|
{
|
|
}
|
|
|
|
StaticTextSpec(const std::wstring &a_text,
|
|
const core::rect<s32> &a_rect,
|
|
gui::IGUIButton *a_parent_button):
|
|
text(a_text),
|
|
rect(a_rect),
|
|
parent_button(a_parent_button)
|
|
{
|
|
}
|
|
|
|
std::wstring text;
|
|
core::rect<s32> rect;
|
|
gui::IGUIButton *parent_button;
|
|
};
|
|
|
|
public:
|
|
GUIFormSpecMenu(JoystickController *joystick,
|
|
gui::IGUIElement* parent, s32 id,
|
|
IMenuManager *menumgr,
|
|
Client *client,
|
|
ISimpleTextureSource *tsrc,
|
|
IFormSource* fs_src,
|
|
TextDest* txt_dst,
|
|
const std::string &formspecPrepend,
|
|
bool remap_dbl_click = true);
|
|
|
|
~GUIFormSpecMenu();
|
|
|
|
static void create(GUIFormSpecMenu *&cur_formspec, Client *client,
|
|
JoystickController *joystick, IFormSource *fs_src, TextDest *txt_dest,
|
|
const std::string &formspecPrepend);
|
|
|
|
void setFormSpec(const std::string &formspec_string,
|
|
const InventoryLocation ¤t_inventory_location)
|
|
{
|
|
m_formspec_string = formspec_string;
|
|
m_current_inventory_location = current_inventory_location;
|
|
regenerateGui(m_screensize_old);
|
|
}
|
|
|
|
const InventoryLocation &getFormspecLocation()
|
|
{
|
|
return m_current_inventory_location;
|
|
}
|
|
|
|
void setFormspecPrepend(const std::string &formspecPrepend)
|
|
{
|
|
m_formspec_prepend = formspecPrepend;
|
|
}
|
|
|
|
// form_src is deleted by this GUIFormSpecMenu
|
|
void setFormSource(IFormSource *form_src)
|
|
{
|
|
delete m_form_src;
|
|
m_form_src = form_src;
|
|
}
|
|
|
|
// text_dst is deleted by this GUIFormSpecMenu
|
|
void setTextDest(TextDest *text_dst)
|
|
{
|
|
delete m_text_dst;
|
|
m_text_dst = text_dst;
|
|
}
|
|
|
|
void allowClose(bool value)
|
|
{
|
|
m_allowclose = value;
|
|
}
|
|
|
|
void lockSize(bool lock,v2u32 basescreensize=v2u32(0,0))
|
|
{
|
|
m_lock = lock;
|
|
m_lockscreensize = basescreensize;
|
|
}
|
|
|
|
void removeChildren();
|
|
void setInitialFocus();
|
|
|
|
void setFocus(const std::string &elementname)
|
|
{
|
|
m_focused_element = elementname;
|
|
}
|
|
|
|
/*
|
|
Remove and re-add (or reposition) stuff
|
|
*/
|
|
void regenerateGui(v2u32 screensize);
|
|
|
|
ItemSpec getItemAtPos(v2s32 p) const;
|
|
void drawList(const ListDrawSpec &s, int layer, bool &item_hovered);
|
|
void drawSelectedItem();
|
|
void drawMenu();
|
|
void updateSelectedItem();
|
|
ItemStack verifySelectedItem();
|
|
|
|
void acceptInput(FormspecQuitMode quitmode);
|
|
bool preprocessEvent(const SEvent& event);
|
|
bool OnEvent(const SEvent& event);
|
|
bool doPause;
|
|
bool pausesGame() { return doPause; }
|
|
|
|
GUITable* getTable(const std::string &tablename);
|
|
std::vector<std::string>* getDropDownValues(const std::string &name);
|
|
|
|
#ifdef __ANDROID__
|
|
bool getAndroidUIInput();
|
|
#endif
|
|
|
|
protected:
|
|
v2s32 getBasePos() const
|
|
{
|
|
return padding + offset + AbsoluteRect.UpperLeftCorner;
|
|
}
|
|
std::wstring getLabelByID(s32 id);
|
|
std::string getNameByID(s32 id);
|
|
v2s32 getElementBasePos(bool absolute,
|
|
const std::vector<std::string> *v_pos);
|
|
v2s32 getRealCoordinateBasePos(bool absolute,
|
|
const std::vector<std::string> &v_pos);
|
|
v2s32 getRealCoordinateGeometry(const std::vector<std::string> &v_geom);
|
|
|
|
std::unordered_map<std::string, StyleSpec> theme_by_type;
|
|
std::unordered_map<std::string, StyleSpec> theme_by_name;
|
|
std::unordered_set<std::string> property_warned;
|
|
|
|
StyleSpec getStyleForElement(const std::string &type,
|
|
const std::string &name="", const std::string &parent_type="");
|
|
|
|
v2s32 padding;
|
|
v2f32 spacing;
|
|
v2s32 imgsize;
|
|
v2s32 offset;
|
|
v2f32 pos_offset;
|
|
std::stack<v2f32> container_stack;
|
|
|
|
InventoryManager *m_invmgr;
|
|
ISimpleTextureSource *m_tsrc;
|
|
Client *m_client;
|
|
|
|
std::string m_formspec_string;
|
|
std::string m_formspec_prepend;
|
|
InventoryLocation m_current_inventory_location;
|
|
|
|
std::vector<ListDrawSpec> m_inventorylists;
|
|
std::vector<ListRingSpec> m_inventory_rings;
|
|
std::vector<ImageDrawSpec> m_backgrounds;
|
|
std::vector<ImageDrawSpec> m_images;
|
|
std::vector<ImageDrawSpec> m_itemimages;
|
|
std::vector<BoxDrawSpec> m_boxes;
|
|
std::unordered_map<std::string, bool> field_close_on_enter;
|
|
std::vector<FieldSpec> m_fields;
|
|
std::vector<StaticTextSpec> m_static_texts;
|
|
std::vector<std::pair<FieldSpec,GUITable*> > m_tables;
|
|
std::vector<std::pair<FieldSpec,gui::IGUICheckBox*> > m_checkboxes;
|
|
std::map<std::string, TooltipSpec> m_tooltips;
|
|
std::vector<std::pair<irr::core::rect<s32>, TooltipSpec>> m_tooltip_rects;
|
|
std::vector<std::pair<FieldSpec,gui::IGUIScrollBar*> > m_scrollbars;
|
|
std::vector<std::pair<FieldSpec, std::vector<std::string> > > m_dropdowns;
|
|
|
|
ItemSpec *m_selected_item = nullptr;
|
|
u16 m_selected_amount = 0;
|
|
bool m_selected_dragging = false;
|
|
ItemStack m_selected_swap;
|
|
|
|
gui::IGUIStaticText *m_tooltip_element = nullptr;
|
|
|
|
u64 m_tooltip_show_delay;
|
|
bool m_tooltip_append_itemname;
|
|
u64 m_hovered_time = 0;
|
|
s32 m_old_tooltip_id = -1;
|
|
|
|
bool m_auto_place = false;
|
|
|
|
bool m_allowclose = true;
|
|
bool m_lock = false;
|
|
v2u32 m_lockscreensize;
|
|
|
|
bool m_bgfullscreen;
|
|
bool m_slotborder;
|
|
video::SColor m_bgcolor;
|
|
video::SColor m_fullscreen_bgcolor;
|
|
video::SColor m_slotbg_n;
|
|
video::SColor m_slotbg_h;
|
|
video::SColor m_slotbordercolor;
|
|
video::SColor m_default_tooltip_bgcolor;
|
|
video::SColor m_default_tooltip_color;
|
|
|
|
|
|
private:
|
|
IFormSource *m_form_src;
|
|
TextDest *m_text_dst;
|
|
u16 m_formspec_version = 1;
|
|
std::string m_focused_element = "";
|
|
JoystickController *m_joystick;
|
|
|
|
typedef struct {
|
|
bool explicit_size;
|
|
bool real_coordinates;
|
|
v2f invsize;
|
|
v2s32 size;
|
|
v2f32 offset;
|
|
v2f32 anchor;
|
|
core::rect<s32> rect;
|
|
v2s32 basepos;
|
|
v2u32 screensize;
|
|
std::string focused_fieldname;
|
|
GUITable::TableOptions table_options;
|
|
GUITable::TableColumns table_columns;
|
|
// used to restore table selection/scroll/treeview state
|
|
std::unordered_map<std::string, GUITable::DynamicData> table_dyndata;
|
|
} parserData;
|
|
|
|
typedef struct {
|
|
bool key_up;
|
|
bool key_down;
|
|
bool key_enter;
|
|
bool key_escape;
|
|
} fs_key_pendig;
|
|
|
|
fs_key_pendig current_keys_pending;
|
|
std::string current_field_enter_pending = "";
|
|
|
|
void parseElement(parserData* data, const std::string &element);
|
|
|
|
void parseSize(parserData* data, const std::string &element);
|
|
void parseContainer(parserData* data, const std::string &element);
|
|
void parseContainerEnd(parserData* data);
|
|
void parseList(parserData* data, const std::string &element);
|
|
void parseListRing(parserData* data, const std::string &element);
|
|
void parseCheckbox(parserData* data, const std::string &element);
|
|
void parseImage(parserData* data, const std::string &element);
|
|
void parseItemImage(parserData* data, const std::string &element);
|
|
void parseButton(parserData* data, const std::string &element,
|
|
const std::string &typ);
|
|
void parseBackground(parserData* data, const std::string &element);
|
|
void parseTableOptions(parserData* data, const std::string &element);
|
|
void parseTableColumns(parserData* data, const std::string &element);
|
|
void parseTable(parserData* data, const std::string &element);
|
|
void parseTextList(parserData* data, const std::string &element);
|
|
void parseDropDown(parserData* data, const std::string &element);
|
|
void parseFieldCloseOnEnter(parserData *data, const std::string &element);
|
|
void parsePwdField(parserData* data, const std::string &element);
|
|
void parseField(parserData* data, const std::string &element, const std::string &type);
|
|
void createTextField(parserData *data, FieldSpec &spec,
|
|
core::rect<s32> &rect, bool is_multiline);
|
|
void parseSimpleField(parserData* data,std::vector<std::string> &parts);
|
|
void parseTextArea(parserData* data,std::vector<std::string>& parts,
|
|
const std::string &type);
|
|
void parseHyperText(parserData *data, const std::string &element);
|
|
void parseLabel(parserData* data, const std::string &element);
|
|
void parseVertLabel(parserData* data, const std::string &element);
|
|
void parseImageButton(parserData* data, const std::string &element,
|
|
const std::string &type);
|
|
void parseItemImageButton(parserData* data, const std::string &element);
|
|
void parseTabHeader(parserData* data, const std::string &element);
|
|
void parseBox(parserData* data, const std::string &element);
|
|
void parseBackgroundColor(parserData* data, const std::string &element);
|
|
void parseListColors(parserData* data, const std::string &element);
|
|
void parseTooltip(parserData* data, const std::string &element);
|
|
bool parseVersionDirect(const std::string &data);
|
|
bool parseSizeDirect(parserData* data, const std::string &element);
|
|
void parseScrollBar(parserData* data, const std::string &element);
|
|
bool parsePositionDirect(parserData *data, const std::string &element);
|
|
void parsePosition(parserData *data, const std::string &element);
|
|
bool parseAnchorDirect(parserData *data, const std::string &element);
|
|
void parseAnchor(parserData *data, const std::string &element);
|
|
bool parseStyle(parserData *data, const std::string &element, bool style_type);
|
|
|
|
void tryClose();
|
|
|
|
void showTooltip(const std::wstring &text, const irr::video::SColor &color,
|
|
const irr::video::SColor &bgcolor);
|
|
|
|
/**
|
|
* check if event is part of a double click
|
|
* @param event event to evaluate
|
|
* @return true/false if a doubleclick was detected
|
|
*/
|
|
bool DoubleClickDetection(const SEvent event);
|
|
|
|
struct clickpos
|
|
{
|
|
v2s32 pos;
|
|
s64 time;
|
|
};
|
|
clickpos m_doubleclickdetect[2];
|
|
|
|
int m_btn_height;
|
|
gui::IGUIFont *m_font = nullptr;
|
|
|
|
/* If true, remap a double-click (or double-tap) action to ESC. This is so
|
|
* that, for example, Android users can double-tap to close a formspec.
|
|
*
|
|
* This value can (currently) only be set by the class constructor
|
|
* and the default value for the setting is true.
|
|
*/
|
|
bool m_remap_dbl_click;
|
|
};
|
|
|
|
class FormspecFormSource: public IFormSource
|
|
{
|
|
public:
|
|
FormspecFormSource(const std::string &formspec):
|
|
m_formspec(formspec)
|
|
{
|
|
}
|
|
|
|
~FormspecFormSource() = default;
|
|
|
|
void setForm(const std::string &formspec)
|
|
{
|
|
m_formspec = formspec;
|
|
}
|
|
|
|
const std::string &getForm() const
|
|
{
|
|
return m_formspec;
|
|
}
|
|
|
|
std::string m_formspec;
|
|
};
|