Formspec: Create a new class for inventorylists (#9287)

1 files changed, 72 insertions, 205 deletions

diff --git a/src/gui/guiFormSpecMenu.cpp b/src/gui/guiFormSpecMenu.cpp
index d03ce4516..98f4368f4 100644
--- a/src/gui/guiFormSpecMenu.cpp
+++ b/src/gui/guiFormSpecMenu.cpp
@@ -61,6 +61,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "guiButtonImage.h"
 #include "guiButtonItemImage.h"
 #include "guiEditBoxWithScrollbar.h"
+#include "guiInventoryList.h"
 #include "guiItemImage.h"
 #include "guiScrollBar.h"
 #include "guiTable.h"
@@ -130,7 +131,7 @@ GUIFormSpecMenu::~GUIFormSpecMenu()
 	for (auto &table_it : m_tables)
 		table_it.second->drop();
 	for (auto &inventorylist_it : m_inventorylists)
-		inventorylist_it.e->drop();
+		inventorylist_it->drop();
 	for (auto &checkbox_it : m_checkboxes)
 		checkbox_it.second->drop();
 	for (auto &scrollbar_it : m_scrollbars)
@@ -347,7 +348,7 @@ void GUIFormSpecMenu::parseContainerEnd(parserData* data)
 	}
 }
 
-void GUIFormSpecMenu::parseList(parserData* data, const std::string &element)
+void GUIFormSpecMenu::parseList(parserData *data, const std::string &element)
 {
 	if (m_client == 0) {
 		warningstream<<"invalid use of 'list' with m_client==0"<<std::endl;
@@ -429,36 +430,28 @@ void GUIFormSpecMenu::parseList(parserData* data, const std::string &element)
 			3
 		);
 
-		v2s32 pos;
-		core::rect<s32> rect;
+		v2f32 slot_spacing = data->real_coordinates ?
+				v2f32(imgsize.X * 1.25f, imgsize.Y * 1.25f) : spacing;
 
-		if (data->real_coordinates) {
-			pos = getRealCoordinateBasePos(v_pos);
-			rect = core::rect<s32>(pos.X, pos.Y,
-					pos.X + (geom.X - 1) * (imgsize.X * 1.25) + imgsize.X,
-					pos.Y + (geom.Y - 1) * (imgsize.Y * 1.25) + imgsize.Y);
-		} else {
-			pos = getElementBasePos(&v_pos);
-			rect = core::rect<s32>(pos.X, pos.Y,
-					pos.X + (geom.X - 1) * spacing.X + imgsize.X,
-					pos.Y + (geom.Y - 1) * spacing.Y + imgsize.Y);
-		}
+		v2s32 pos = data->real_coordinates ? getRealCoordinateBasePos(v_pos)
+				: getElementBasePos(&v_pos);
 
-		gui::IGUIElement *e = new gui::IGUIElement(EGUIET_ELEMENT, Environment,
-				this, spec.fid, rect);
+		core::rect<s32> rect = core::rect<s32>(pos.X, pos.Y,
+				pos.X + (geom.X - 1) * slot_spacing.X + imgsize.X,
+				pos.Y + (geom.Y - 1) * slot_spacing.Y + imgsize.Y);
 
-		// the element the list is bound to should not block mouse-clicks
-		e->setVisible(false);
+		GUIInventoryList *e = new GUIInventoryList(Environment, this, spec.fid,
+				rect, m_invmgr, loc, listname, geom, start_i, imgsize, slot_spacing,
+				this, data->inventorylist_options, m_font);
 
-		m_inventorylists.emplace_back(loc, listname, e, geom, start_i,
-				data->real_coordinates);
+		m_inventorylists.push_back(e);
 		m_fields.push_back(spec);
 		return;
 	}
 	errorstream<< "Invalid list element(" << parts.size() << "): '" << element << "'"  << std::endl;
 }
 
-void GUIFormSpecMenu::parseListRing(parserData* data, const std::string &element)
+void GUIFormSpecMenu::parseListRing(parserData *data, const std::string &element)
 {
 	if (m_client == 0) {
 		errorstream << "WARNING: invalid use of 'listring' with m_client==0" << std::endl;
@@ -485,10 +478,10 @@ void GUIFormSpecMenu::parseListRing(parserData* data, const std::string &element
 	if (element.empty() && m_inventorylists.size() > 1) {
 		size_t siz = m_inventorylists.size();
 		// insert the last two inv list elements into the list ring
-		const ListDrawSpec &spa = m_inventorylists[siz - 2];
-		const ListDrawSpec &spb = m_inventorylists[siz - 1];
-		m_inventory_rings.emplace_back(spa.inventoryloc, spa.listname);
-		m_inventory_rings.emplace_back(spb.inventoryloc, spb.listname);
+		const GUIInventoryList *spa = m_inventorylists[siz - 2];
+		const GUIInventoryList *spb = m_inventorylists[siz - 1];
+		m_inventory_rings.emplace_back(spa->getInventoryloc(), spa->getListname());
+		m_inventory_rings.emplace_back(spb->getInventoryloc(), spb->getListname());
 		return;
 	}
 
@@ -2171,12 +2164,13 @@ void GUIFormSpecMenu::parseListColors(parserData* data, const std::string &eleme
 	if (((parts.size() == 2) || (parts.size() == 3) || (parts.size() == 5)) ||
 		((parts.size() > 5) && (m_formspec_version > FORMSPEC_API_VERSION)))
 	{
-		parseColorString(parts[0], m_slotbg_n, false);
-		parseColorString(parts[1], m_slotbg_h, false);
+		parseColorString(parts[0], data->inventorylist_options.slotbg_n, false);
+		parseColorString(parts[1], data->inventorylist_options.slotbg_h, false);
 
 		if (parts.size() >= 3) {
-			if (parseColorString(parts[2], m_slotbordercolor, false)) {
-				m_slotborder = true;
+			if (parseColorString(parts[2], data->inventorylist_options.slotbordercolor,
+					false)) {
+				data->inventorylist_options.slotborder = true;
 			}
 		}
 		if (parts.size() == 5) {
@@ -2187,6 +2181,14 @@ void GUIFormSpecMenu::parseListColors(parserData* data, const std::string &eleme
 			if (parseColorString(parts[4], tmp_color, false))
 				m_default_tooltip_color = tmp_color;
 		}
+
+		// update all already parsed inventorylists
+		for (GUIInventoryList *e : m_inventorylists) {
+			e->setSlotBGColors(data->inventorylist_options.slotbg_n,
+					data->inventorylist_options.slotbg_h);
+			e->setSlotBorders(data->inventorylist_options.slotborder,
+					data->inventorylist_options.slotbordercolor);
+		}
 		return;
 	}
 	errorstream<< "Invalid listcolors element(" << parts.size() << "): '" << element << "'"  << std::endl;
@@ -2673,7 +2675,7 @@ void GUIFormSpecMenu::regenerateGui(v2u32 screensize)
 	for (auto &table_it : m_tables)
 		table_it.second->drop();
 	for (auto &inventorylist_it : m_inventorylists)
-		inventorylist_it.e->drop();
+		inventorylist_it->drop();
 	for (auto &checkbox_it : m_checkboxes)
 		checkbox_it.second->drop();
 	for (auto &scrollbar_it : m_scrollbars)
@@ -2692,8 +2694,6 @@ void GUIFormSpecMenu::regenerateGui(v2u32 screensize)
 	// Base position of contents of form
 	mydata.basepos = getBasePos();
 
-	/* Convert m_init_draw_spec to m_inventorylists */
-
 	m_inventorylists.clear();
 	m_backgrounds.clear();
 	m_tables.clear();
@@ -2732,15 +2732,9 @@ void GUIFormSpecMenu::regenerateGui(v2u32 screensize)
 		);
 	}
 
-	m_slotbg_n = video::SColor(255,128,128,128);
-	m_slotbg_h = video::SColor(255,192,192,192);
-
 	m_default_tooltip_bgcolor = video::SColor(255,110,130,60);
 	m_default_tooltip_color = video::SColor(255,255,255,255);
 
-	m_slotbordercolor = video::SColor(200,0,0,0);
-	m_slotborder = false;
-
 	// Add tooltip
 	{
 		assert(!m_tooltip_element);
@@ -3073,7 +3067,7 @@ bool GUIFormSpecMenu::getAndroidUIInput()
 	std::string fieldname = m_jni_field_name;
 	m_jni_field_name.clear();
 
-	for(std::vector<FieldSpec>::iterator iter =  m_fields.begin();
+	for (std::vector<FieldSpec>::iterator iter =  m_fields.begin();
 			iter != m_fields.end(); ++iter) {
 
 		if (iter->fname != fieldname) {
@@ -3097,140 +3091,18 @@ bool GUIFormSpecMenu::getAndroidUIInput()
 }
 #endif
 
-GUIFormSpecMenu::ItemSpec GUIFormSpecMenu::getItemAtPos(v2s32 p) const
+GUIInventoryList::ItemSpec GUIFormSpecMenu::getItemAtPos(v2s32 p) const
 {
 	core::rect<s32> imgrect(0, 0, imgsize.X, imgsize.Y);
 
-	for (const GUIFormSpecMenu::ListDrawSpec &s : m_inventorylists) {
-		core::rect<s32> clipping_rect = s.e->getAbsoluteClippingRect();
-		v2s32 base_pos = s.e->getAbsolutePosition().UpperLeftCorner;
-		for(s32 i=0; i<s.geom.X*s.geom.Y; i++) {
-			s32 item_i = i + s.start_item_i;
-
-			s32 x;
-			s32 y;
-			if (s.real_coordinates) {
-				x = (i%s.geom.X) * (imgsize.X * 1.25);
-				y = (i/s.geom.X) * (imgsize.Y * 1.25);
-			} else {
-				x = (i%s.geom.X) * spacing.X;
-				y = (i/s.geom.X) * spacing.Y;
-			}
-			v2s32 p0(x,y);
-			core::rect<s32> rect = imgrect + base_pos + p0;
-			rect.clipAgainst(clipping_rect);
-			if (rect.getArea() > 0 && rect.isPointInside(p))
-				return ItemSpec(s.inventoryloc, s.listname, item_i);
-		}
-	}
-
-	return ItemSpec(InventoryLocation(), "", -1);
-}
-
-void GUIFormSpecMenu::drawList(const ListDrawSpec &s, int layer,
-		bool &item_hovered)
-{
-	video::IVideoDriver* driver = Environment->getVideoDriver();
-
-	Inventory *inv = m_invmgr->getInventory(s.inventoryloc);
-	if (!inv) {
-		warningstream<<"GUIFormSpecMenu::drawList(): "
-				<< "The inventory location "
-				<< "\"" << s.inventoryloc.dump() << "\" doesn't exist anymore"
-				<< std::endl;
-		return;
+	for (const GUIInventoryList *e : m_inventorylists) {
+		s32 item_index = e->getItemIndexAtPos(p);
+		if (item_index != -1)
+			return GUIInventoryList::ItemSpec(e->getInventoryloc(), e->getListname(),
+					item_index);
 	}
-	InventoryList *ilist = inv->getList(s.listname);
-	if (!ilist) {
-		warningstream << "GUIFormSpecMenu::drawList(): "
-				<< "The inventory list \"" << s.listname << "\" @ \""
-				<< s.inventoryloc.dump() << "\" doesn't exist anymore"
-				<< std::endl;
-		return;
-	}
-
-	core::rect<s32> imgrect(0, 0, imgsize.X, imgsize.Y);
-	core::rect<s32> clipping_rect = s.e->getAbsoluteClippingRect();
-	v2s32 base_pos = s.e->getAbsolutePosition().UpperLeftCorner;
-
-	for (s32 i = 0; i < s.geom.X * s.geom.Y; i++) {
-		s32 item_i = i + s.start_item_i;
-		if (item_i >= (s32)ilist->getSize())
-			break;
-
-		s32 x;
-		s32 y;
-		if (s.real_coordinates) {
-			x = (i%s.geom.X) * (imgsize.X * 1.25);
-			y = (i/s.geom.X) * (imgsize.Y * 1.25);
-		} else {
-			x = (i%s.geom.X) * spacing.X;
-			y = (i/s.geom.X) * spacing.Y;
-		}
-		v2s32 p(x,y);
-		core::rect<s32> rect = imgrect + base_pos + p;
-		ItemStack item = ilist->getItem(item_i);
-
-		bool selected = m_selected_item
-			&& m_invmgr->getInventory(m_selected_item->inventoryloc) == inv
-			&& m_selected_item->listname == s.listname
-			&& m_selected_item->i == item_i;
-		core::rect<s32> clipped_rect(rect);
-		clipped_rect.clipAgainst(clipping_rect);
-		bool hovering = clipped_rect.getArea() > 0 &&
-				clipped_rect.isPointInside(m_pointer);
-		ItemRotationKind rotation_kind = selected ? IT_ROT_SELECTED :
-			(hovering ? IT_ROT_HOVERED : IT_ROT_NONE);
-
-		if (layer == 0) {
-			if (hovering) {
-				item_hovered = true;
-				driver->draw2DRectangle(m_slotbg_h, rect, &clipping_rect);
-			} else {
-				driver->draw2DRectangle(m_slotbg_n, rect, &clipping_rect);
-			}
-		}
-
-		//Draw inv slot borders
-		if (m_slotborder) {
-			s32 x1 = rect.UpperLeftCorner.X;
-			s32 y1 = rect.UpperLeftCorner.Y;
-			s32 x2 = rect.LowerRightCorner.X;
-			s32 y2 = rect.LowerRightCorner.Y;
-			s32 border = 1;
-			driver->draw2DRectangle(m_slotbordercolor,
-				core::rect<s32>(v2s32(x1 - border, y1 - border),
-								v2s32(x2 + border, y1)), &clipping_rect);
-			driver->draw2DRectangle(m_slotbordercolor,
-				core::rect<s32>(v2s32(x1 - border, y2),
-								v2s32(x2 + border, y2 + border)), &clipping_rect);
-			driver->draw2DRectangle(m_slotbordercolor,
-				core::rect<s32>(v2s32(x1 - border, y1),
-								v2s32(x1, y2)), &clipping_rect);
-			driver->draw2DRectangle(m_slotbordercolor,
-				core::rect<s32>(v2s32(x2, y1),
-								v2s32(x2 + border, y2)), &clipping_rect);
-		}
 
-		if (layer == 1) {
-			if (selected)
-				item.takeItem(m_selected_amount);
-
-			if (!item.empty()) {
-				// Draw item stack
-				drawItemStack(driver, m_font, item,
-					rect, &clipping_rect, m_client, rotation_kind);
-				// Draw tooltip
-				if (hovering && !m_selected_item) {
-					std::string tooltip = item.getDescription(m_client->idef());
-					if (m_tooltip_append_itemname)
-						tooltip += "\n[" + item.name + "]";
-					showTooltip(utf8_to_wide(tooltip), m_default_tooltip_color,
-							m_default_tooltip_bgcolor);
-				}
-			}
-		}
-	}
+	return GUIInventoryList::ItemSpec(InventoryLocation(), "", -1);
 }
 
 void GUIFormSpecMenu::drawSelectedItem()
@@ -3273,6 +3145,8 @@ void GUIFormSpecMenu::drawMenu()
 	gui::IGUIFont *old_font = skin->getFont();
 	skin->setFont(m_font);
 
+	m_hovered_item_tooltips.clear();
+
 	updateSelectedItem();
 
 	video::IVideoDriver* driver = Environment->getVideoDriver();
@@ -3315,21 +3189,17 @@ void GUIFormSpecMenu::drawMenu()
 
 	/*
 		Call base class
+		(This is where all the drawing happens.)
 	*/
 	gui::IGUIElement::draw();
 
-	/*
-		Draw items
-		Layer 0: Item slot rectangles
-		Layer 1: Item images; prepare tooltip
-	*/
-	bool item_hovered = false;
-	for (int layer = 0; layer < 2; layer++) {
-		for (const GUIFormSpecMenu::ListDrawSpec &spec : m_inventorylists) {
-			drawList(spec, layer, item_hovered);
-		}
+	// Draw hovered item tooltips
+	for (const std::string &tooltip : m_hovered_item_tooltips) {
+		showTooltip(utf8_to_wide(tooltip), m_default_tooltip_color,
+				m_default_tooltip_bgcolor);
 	}
-	if (!item_hovered) {
+
+	if (m_hovered_item_tooltips.empty()) {
 		// reset rotation time
 		drawItemStack(driver, m_font, ItemStack(),
 			core::rect<s32>(v2s32(0, 0), v2s32(0, 0)),
@@ -3463,11 +3333,11 @@ void GUIFormSpecMenu::updateSelectedItem()
 
 	// If craftresult is nonempty and nothing else is selected, select it now.
 	if (!m_selected_item) {
-		for (const GUIFormSpecMenu::ListDrawSpec &s : m_inventorylists) {
-			if (s.listname != "craftpreview")
+		for (const GUIInventoryList *e : m_inventorylists) {
+			if (e->getListname() != "craftpreview")
 				continue;
 
-			Inventory *inv = m_invmgr->getInventory(s.inventoryloc);
+			Inventory *inv = m_invmgr->getInventory(e->getInventoryloc());
 			if (!inv)
 				continue;
 
@@ -3481,8 +3351,8 @@ void GUIFormSpecMenu::updateSelectedItem()
 				continue;
 
 			// Grab selected item from the crafting result list
-			m_selected_item = new ItemSpec;
-			m_selected_item->inventoryloc = s.inventoryloc;
+			m_selected_item = new GUIInventoryList::ItemSpec;
+			m_selected_item->inventoryloc = e->getInventoryloc();
 			m_selected_item->listname = "craftresult";
 			m_selected_item->i = 0;
 			m_selected_amount = item.count;
@@ -3503,16 +3373,12 @@ ItemStack GUIFormSpecMenu::verifySelectedItem()
 	// If the selected stack has become smaller, adjust m_selected_amount.
 	// Return the selected stack.
 
-	if(m_selected_item)
-	{
-		if(m_selected_item->isValid())
-		{
+	if (m_selected_item) {
+		if (m_selected_item->isValid()) {
 			Inventory *inv = m_invmgr->getInventory(m_selected_item->inventoryloc);
-			if(inv)
-			{
+			if (inv) {
 				InventoryList *list = inv->getList(m_selected_item->listname);
-				if(list && (u32) m_selected_item->i < list->getSize())
-				{
+				if (list && (u32) m_selected_item->i < list->getSize()) {
 					ItemStack stack = list->getItem(m_selected_item->i);
 					if (!m_selected_swap.empty()) {
 						if (m_selected_swap.name == stack.name &&
@@ -3530,7 +3396,7 @@ ItemStack GUIFormSpecMenu::verifySelectedItem()
 
 		// selection was not valid
 		delete m_selected_item;
-		m_selected_item = NULL;
+		m_selected_item = nullptr;
 		m_selected_amount = 0;
 		m_selected_dragging = false;
 	}
@@ -3670,9 +3536,9 @@ void GUIFormSpecMenu::acceptInput(FormspecQuitMode quitmode=quit_mode_no)
 	}
 }
 
-static bool isChild(gui::IGUIElement * tocheck, gui::IGUIElement * parent)
+static bool isChild(gui::IGUIElement *tocheck, gui::IGUIElement *parent)
 {
-	while(tocheck != NULL) {
+	while (tocheck) {
 		if (tocheck == parent) {
 			return true;
 		}
@@ -3709,8 +3575,8 @@ bool GUIFormSpecMenu::preprocessEvent(const SEvent& event)
 	}
 
 	// Fix Esc/Return key being eaten by checkboxen and tables
-	if(event.EventType==EET_KEY_INPUT_EVENT) {
-		KeyPress kp(event.KeyInput);
+	if (event.EventType == EET_KEY_INPUT_EVENT) {
+			KeyPress kp(event.KeyInput);
 		if (kp == EscapeKey || kp == CancelKey
 				|| kp == getKeySetting("keymap_inventory")
 				|| event.KeyInput.Key==KEY_RETURN) {
@@ -3749,7 +3615,7 @@ bool GUIFormSpecMenu::preprocessEvent(const SEvent& event)
 		if (event.MouseInput.Event == EMIE_LMOUSE_PRESSED_DOWN) {
 			m_old_tooltip_id = -1;
 		}
-		if (!isChild(hovered,this)) {
+		if (!isChild(hovered, this)) {
 			if (DoubleClickDetection(event)) {
 				return true;
 			}
@@ -3920,7 +3786,7 @@ bool GUIFormSpecMenu::OnEvent(const SEvent& event)
 
 		m_old_tooltip_id = -1;
 		updateSelectedItem();
-		ItemSpec s = getItemAtPos(m_pointer);
+		GUIInventoryList::ItemSpec s = getItemAtPos(m_pointer);
 
 		Inventory *inv_selected = NULL;
 		Inventory *inv_s = NULL;
@@ -4022,8 +3888,9 @@ bool GUIFormSpecMenu::OnEvent(const SEvent& event)
 		case BET_DOWN:
 			// Some mouse button has been pressed
 
-			//infostream<<"Mouse button "<<button<<" pressed at p=("
-			//	<<p.X<<","<<p.Y<<")"<<std::endl;
+			//infostream << "Mouse button " << button << " pressed at p=("
+			//	<< event.MouseInput.X << "," << event.MouseInput.Y << ")"
+			//	<< std::endl;
 
 			m_selected_dragging = false;
 
@@ -4033,7 +3900,7 @@ bool GUIFormSpecMenu::OnEvent(const SEvent& event)
 			} else if (!m_selected_item) {
 				if (s_count && button != BET_WHEEL_UP) {
 					// Non-empty stack has been clicked: select or shift-move it
-					m_selected_item = new ItemSpec(s);
+					m_selected_item = new GUIInventoryList::ItemSpec(s);
 
 					u32 count;
 					if (button == BET_RIGHT)
@@ -4261,7 +4128,7 @@ bool GUIFormSpecMenu::OnEvent(const SEvent& event)
 
 			// if there are no items selected or the selected item
 			// belongs to craftresult list, proceed with crafting
-			if (m_selected_item == NULL ||
+			if (!m_selected_item ||
 					!m_selected_item->isValid() || m_selected_item->listname == "craftresult") {
 
 				assert(inv_s);
@@ -4279,7 +4146,7 @@ bool GUIFormSpecMenu::OnEvent(const SEvent& event)
 		if (m_selected_amount == 0) {
 			m_selected_swap.clear();
 			delete m_selected_item;
-			m_selected_item = NULL;
+			m_selected_item = nullptr;
 			m_selected_amount = 0;
 			m_selected_dragging = false;
 		}