minetest/src/gui/guiFormSpecMenu.h

574 lines
14 KiB
C
Raw Normal View History

2010-12-22 02:34:21 +01:00
/*
2013-02-24 18:40:43 +01:00
Minetest
2013-02-24 19:38:45 +01:00
Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
2010-12-22 02:34:21 +01:00
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
2010-12-22 02:34:21 +01:00
(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.
2010-12-22 02:34:21 +01:00
You should have received a copy of the GNU Lesser General Public License along
2010-12-22 02:34:21 +01:00
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#pragma once
2010-12-22 02:34:21 +01:00
#include <utility>
#include <stack>
2012-06-17 03:00:31 +02:00
#include "irrlichttypes_extrabloated.h"
#include "inventorymanager.h"
2010-12-23 14:31:50 +01:00
#include "modalMenu.h"
2013-08-23 12:24:11 +02:00
#include "guiTable.h"
#include "network/networkprotocol.h"
#include "client/joystick_controller.h"
#include "util/string.h"
#include "util/enriched_string.h"
2010-12-22 02:34:21 +01:00
class InventoryManager;
class ISimpleTextureSource;
class Client;
typedef enum {
f_Button,
2013-08-23 12:24:11 +02:00
f_Table,
f_TabHeader,
f_CheckBox,
f_DropDown,
2014-06-19 18:17:35 +02:00
f_ScrollBar,
f_Unknown
} FormspecFieldType;
typedef enum {
quit_mode_no,
quit_mode_accept,
quit_mode_cancel
} FormspecQuitMode;
2012-07-15 18:19:38 +02:00
struct TextDest
{
virtual ~TextDest() = default;
2012-07-15 18:19:38 +02:00
// This is deprecated I guess? -celeron55
virtual void gotText(const std::wstring &text) {}
virtual void gotText(const StringMap &fields) = 0;
std::string m_formname;
2012-07-15 18:19:38 +02:00
};
class IFormSource
{
public:
virtual ~IFormSource() = default;
virtual const std::string &getForm() const = 0;
2012-07-15 18:19:38 +02:00
// Fill in variables in field text
virtual std::string resolveText(const std::string &str) { return str; }
};
2012-07-15 18:19:38 +02:00
class GUIFormSpecMenu : public GUIModalMenu
2010-12-22 02:34:21 +01:00
{
2010-12-22 15:30:23 +01:00
struct ItemSpec
2010-12-22 02:34:21 +01:00
{
ItemSpec() = default;
ItemSpec(const InventoryLocation &a_inventoryloc,
2011-04-04 14:13:19 +02:00
const std::string &a_listname,
s32 a_i) :
inventoryloc(a_inventoryloc),
listname(a_listname),
i(a_i)
{
}
bool isValid() const { return i != -1; }
2010-12-22 15:30:23 +01:00
InventoryLocation inventoryloc;
2010-12-22 15:30:23 +01:00
std::string listname;
s32 i = -1;
2010-12-22 15:30:23 +01:00
};
struct ListDrawSpec
{
ListDrawSpec() = default;
ListDrawSpec(const InventoryLocation &a_inventoryloc,
2011-04-04 14:13:19 +02:00
const std::string &a_listname,
2012-07-24 19:57:17 +02:00
v2s32 a_pos, v2s32 a_geom, s32 a_start_item_i):
inventoryloc(a_inventoryloc),
listname(a_listname),
pos(a_pos),
2012-07-24 19:57:17 +02:00
geom(a_geom),
start_item_i(a_start_item_i)
2010-12-22 15:30:23 +01:00
{
}
InventoryLocation inventoryloc;
2010-12-22 15:30:23 +01:00
std::string listname;
v2s32 pos;
v2s32 geom;
2012-07-24 19:57:17 +02:00
s32 start_item_i;
2010-12-22 15:30:23 +01:00
};
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,
2016-01-24 14:19:17 +01:00
const std::string &a_item_name,
gui::IGUIButton *a_parent_button,
2016-01-24 14:19:17 +01:00
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,
2016-01-24 14:19:17 +01:00
const v2s32 &a_pos, const v2s32 &a_geom):
name(a_name),
item_name(a_item_name),
parent_button(NULL),
2016-01-24 14:19:17 +01:00
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)
{
}
2016-01-24 14:19:17 +01:00
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;
2016-01-24 14:19:17 +01:00
std::string item_name;
gui::IGUIButton *parent_button;
v2s32 pos;
v2s32 geom;
bool scale;
bool clip;
};
2012-07-15 18:19:38 +02:00
struct FieldSpec
{
FieldSpec() = default;
2015-06-10 01:54:33 +02:00
FieldSpec(const std::string &name, const std::wstring &label,
const std::wstring &default_text, int id) :
2012-07-15 18:19:38 +02:00
fname(name),
flabel(label),
2017-01-31 18:05:03 +01:00
fdefault(unescape_enriched(translate_string(default_text))),
fid(id),
send(false),
ftype(f_Unknown),
is_exit(false)
{
}
2015-06-10 01:54:33 +02:00
std::string fname;
2012-07-15 18:19:38 +02:00
std::wstring flabel;
std::wstring fdefault;
int fid;
bool send;
FormspecFieldType ftype;
bool is_exit;
core::rect<s32> rect;
2012-07-15 18:19:38 +02:00
};
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;
2017-01-31 18:05:03 +01:00
TooltipSpec(const std::wstring &a_tooltip, irr::video::SColor a_bgcolor,
irr::video::SColor a_color):
2017-01-31 18:05:03 +01:00
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;
};
2010-12-22 02:34:21 +01:00
public:
GUIFormSpecMenu(JoystickController *joystick,
2010-12-22 02:34:21 +01:00
gui::IGUIElement* parent, s32 id,
2011-04-04 14:13:19 +02:00
IMenuManager *menumgr,
Client *client,
ISimpleTextureSource *tsrc,
IFormSource* fs_src,
TextDest* txt_dst,
std::string formspecPrepend,
bool remap_dbl_click = true);
2012-07-15 18:19:38 +02:00
~GUIFormSpecMenu();
2010-12-22 02:34:21 +01:00
static void create(GUIFormSpecMenu *&cur_formspec, Client *client,
JoystickController *joystick, IFormSource *fs_src, TextDest *txt_dest,
const std::string &formspecPrepend);
2012-06-03 15:03:19 +02:00
void setFormSpec(const std::string &formspec_string,
const InventoryLocation &current_inventory_location)
{
2012-06-03 15:03:19 +02:00
m_formspec_string = formspec_string;
m_current_inventory_location = current_inventory_location;
regenerateGui(m_screensize_old);
}
void setFormspecPrepend(const std::string &formspecPrepend)
{
m_formspec_prepend = formspecPrepend;
}
2012-07-15 18:19:38 +02:00
// form_src is deleted by this GUIFormSpecMenu
void setFormSource(IFormSource *form_src)
{
2017-06-05 01:52:55 +02:00
delete m_form_src;
m_form_src = form_src;
}
2012-07-15 18:19:38 +02:00
// text_dst is deleted by this GUIFormSpecMenu
void setTextDest(TextDest *text_dst)
{
2017-06-05 01:52:55 +02:00
delete m_text_dst;
2012-07-15 18:19:38 +02:00
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;
}
2010-12-25 15:04:51 +01:00
void removeChildren();
2013-08-19 11:26:51 +02:00
void setInitialFocus();
void setFocus(const std::string &elementname)
{
m_focused_element = elementname;
}
2010-12-22 02:34:21 +01:00
/*
Remove and re-add (or reposition) stuff
*/
2010-12-23 14:31:50 +01:00
void regenerateGui(v2u32 screensize);
2010-12-22 15:30:23 +01:00
ItemSpec getItemAtPos(v2s32 p) const;
void drawList(const ListDrawSpec &s, int layer, bool &item_hovered);
void drawSelectedItem();
2010-12-23 14:31:50 +01:00
void drawMenu();
void updateSelectedItem();
ItemStack verifySelectedItem();
2010-12-22 02:34:21 +01:00
void acceptInput(FormspecQuitMode quitmode);
2013-08-19 11:26:51 +02:00
bool preprocessEvent(const SEvent& event);
2010-12-22 02:34:21 +01:00
bool OnEvent(const SEvent& event);
2014-03-13 14:06:18 +01:00
bool doPause;
bool pausesGame() { return doPause; }
2015-06-10 01:54:33 +02:00
GUITable* getTable(const std::string &tablename);
std::vector<std::string>* getDropDownValues(const std::string &name);
2013-08-23 12:24:11 +02:00
#ifdef __ANDROID__
bool getAndroidUIInput();
#endif
protected:
2010-12-22 15:30:23 +01:00
v2s32 getBasePos() const
{
return padding + offset + AbsoluteRect.UpperLeftCorner;
2010-12-22 15:30:23 +01:00
}
v2s32 padding;
v2s32 spacing;
v2s32 imgsize;
v2s32 offset;
v2s32 pos_offset;
std::stack<v2s32> container_stack;
2011-04-04 14:13:19 +02:00
InventoryManager *m_invmgr;
ISimpleTextureSource *m_tsrc;
Client *m_client;
2010-12-22 15:30:23 +01:00
2012-06-03 15:03:19 +02:00
std::string m_formspec_string;
std::string m_formspec_prepend;
2012-06-03 15:03:19 +02:00
InventoryLocation m_current_inventory_location;
2012-12-20 18:19:49 +01:00
std::vector<ListDrawSpec> m_inventorylists;
std::vector<ListRingSpec> m_inventory_rings;
2012-12-20 18:19:49 +01:00
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;
2012-12-20 18:19:49 +01:00
std::vector<FieldSpec> m_fields;
std::vector<StaticTextSpec> m_static_texts;
2013-08-23 12:24:11 +02:00
std::vector<std::pair<FieldSpec,GUITable*> > m_tables;
std::vector<std::pair<FieldSpec,gui::IGUICheckBox*> > m_checkboxes;
2015-06-10 01:54:33 +02:00
std::map<std::string, TooltipSpec> m_tooltips;
2014-06-19 18:17:35 +02:00
std::vector<std::pair<FieldSpec,gui::IGUIScrollBar*> > m_scrollbars;
std::vector<std::pair<FieldSpec, std::vector<std::string> > > m_dropdowns;
2014-06-19 18:17:35 +02:00
ItemSpec *m_selected_item = nullptr;
u16 m_selected_amount = 0;
bool m_selected_dragging = false;
ItemStack m_selected_swap;
2011-12-01 10:25:55 +01:00
v2s32 m_pointer;
v2s32 m_old_pointer; // Mouse position after previous mouse event
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;
2017-10-17 21:50:58 +02:00
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;
u32 m_formspec_version = 0;
std::string m_focused_element = "";
JoystickController *m_joystick;
typedef struct {
Scale form elements consistently The ratios between the sizes of form elements, including text, is now fixed, aside from variations caused by rounding. This makes form layout almost fully predictable, and particularly independent of player's screen size. The proportions of non-text elements are the traditional proportions. For compatibility, the way in which element positions and sizes are specified remains unchanged, in all its baroqueness, with one exception. The exception is that the position of a label[] element is now defined in terms of the vertically center of the first line of the label, rather than the bottom of the first line of the label. This change allows a label to be precisely aligned with button text or an edit box, which are positioned in a centering manner. Label positioning remains consistent with the previous system, just more precisely defined. Make multi-line label[] elements work properly. Previously the code set a bounding rectangle assuming that there would be only a single line, and as a result a multi-line label would be cut somewhere in the middle of the second line. Now multi-line labels not only work, but have guaranteed line spacing relative to inventory slots, to aid alignment. Incidentally fix tabheader[] elements which were being constrained to the wrong width. Given an unusually large form, in variable-size mode, the form rendering system now chooses a scale that will fit the entire form on the screen, if that doesn't make elements too small. Fixed-size forms, including the main menu, are have their sizes fixed in inch terms. The fixed size for fixed-size forms and the preferred and minimum sizes for variable-size forms all scale according to the gui_scaling parameter.
2014-08-21 00:42:27 +02:00
bool explicit_size;
v2f invsize;
v2s32 size;
v2f32 offset;
v2f32 anchor;
core::rect<s32> rect;
v2s32 basepos;
v2u32 screensize;
2015-06-10 01:54:33 +02:00
std::string focused_fieldname;
2013-08-23 12:24:11 +02:00
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;
2013-07-07 21:53:40 +02:00
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 = "";
2013-07-07 21:53:40 +02:00
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 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);
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;
std::wstring getLabelByID(s32 id);
2015-06-10 01:54:33 +02:00
std::string getNameByID(s32 id);
#ifdef __ANDROID__
v2s32 m_down_pos;
2015-06-10 01:54:33 +02:00
std::string m_JavaDialogFieldName;
#endif
/* 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)
{
2014-06-25 19:04:47 +02:00
m_formspec = FORMSPEC_VERSION_STRING + formspec;
}
const std::string &getForm() const
{
return m_formspec;
}
std::string m_formspec;
2010-12-22 02:34:21 +01:00
};