mirror of
https://github.com/OpenMW/openmw.git
synced 2025-02-23 06:09:42 +00:00
Merge branch 'limit_layout_depth' into 'master'
Limit maximum Lua UI layout depth to prevent stack overflow Closes #6733 See merge request OpenMW/openmw!1841
This commit is contained in:
Petr Mikheev
commit
b832ba5c83
1 changed files with 148 additions and 139 deletions
|
|
@ -8,156 +8,165 @@
|
|||
|
||||
namespace LuaUi
|
||||
{
|
||||
namespace LayoutKeys
|
||||
namespace
|
||||
{
|
||||
constexpr std::string_view type = "type";
|
||||
constexpr std::string_view name = "name";
|
||||
constexpr std::string_view layer = "layer";
|
||||
constexpr std::string_view templateLayout = "template";
|
||||
constexpr std::string_view props = "props";
|
||||
constexpr std::string_view events = "events";
|
||||
constexpr std::string_view content = "content";
|
||||
constexpr std::string_view external = "external";
|
||||
}
|
||||
|
||||
const std::string defaultWidgetType = "LuaWidget";
|
||||
|
||||
std::string widgetType(const sol::table& layout)
|
||||
{
|
||||
sol::object typeField = LuaUtil::getFieldOrNil(layout, LayoutKeys::type);
|
||||
std::string type = LuaUtil::getValueOrDefault(typeField, defaultWidgetType);
|
||||
sol::object templateTypeField = LuaUtil::getFieldOrNil(layout, LayoutKeys::templateLayout, LayoutKeys::type);
|
||||
if (templateTypeField != sol::nil)
|
||||
namespace LayoutKeys
|
||||
{
|
||||
std::string templateType = LuaUtil::getValueOrDefault(templateTypeField, defaultWidgetType);
|
||||
if (typeField != sol::nil && templateType != type)
|
||||
throw std::logic_error(std::string("Template layout type ") + type
|
||||
+ std::string(" doesn't match template type ") + templateType);
|
||||
type = templateType;
|
||||
constexpr std::string_view type = "type";
|
||||
constexpr std::string_view name = "name";
|
||||
constexpr std::string_view layer = "layer";
|
||||
constexpr std::string_view templateLayout = "template";
|
||||
constexpr std::string_view props = "props";
|
||||
constexpr std::string_view events = "events";
|
||||
constexpr std::string_view content = "content";
|
||||
constexpr std::string_view external = "external";
|
||||
}
|
||||
return type;
|
||||
}
|
||||
|
||||
void destroyWidget(LuaUi::WidgetExtension* ext)
|
||||
{
|
||||
ext->deinitialize();
|
||||
MyGUI::Gui::getInstancePtr()->destroyWidget(ext->widget());
|
||||
}
|
||||
const std::string defaultWidgetType = "LuaWidget";
|
||||
|
||||
WidgetExtension* createWidget(const sol::table& layout);
|
||||
void updateWidget(WidgetExtension* ext, const sol::table& layout);
|
||||
constexpr uint64_t maxDepth = 250;
|
||||
|
||||
std::vector<WidgetExtension*> updateContent(
|
||||
const std::vector<WidgetExtension*>& children, const sol::object& contentObj)
|
||||
{
|
||||
std::vector<WidgetExtension*> result;
|
||||
if (contentObj == sol::nil)
|
||||
std::string widgetType(const sol::table& layout)
|
||||
{
|
||||
for (WidgetExtension* w : children)
|
||||
destroyWidget(w);
|
||||
sol::object typeField = LuaUtil::getFieldOrNil(layout, LayoutKeys::type);
|
||||
std::string type = LuaUtil::getValueOrDefault(typeField, defaultWidgetType);
|
||||
sol::object templateTypeField = LuaUtil::getFieldOrNil(layout, LayoutKeys::templateLayout, LayoutKeys::type);
|
||||
if (templateTypeField != sol::nil)
|
||||
{
|
||||
std::string templateType = LuaUtil::getValueOrDefault(templateTypeField, defaultWidgetType);
|
||||
if (typeField != sol::nil && templateType != type)
|
||||
throw std::logic_error(std::string("Template layout type ") + type
|
||||
+ std::string(" doesn't match template type ") + templateType);
|
||||
type = templateType;
|
||||
}
|
||||
return type;
|
||||
}
|
||||
|
||||
void destroyWidget(LuaUi::WidgetExtension* ext)
|
||||
{
|
||||
ext->deinitialize();
|
||||
MyGUI::Gui::getInstancePtr()->destroyWidget(ext->widget());
|
||||
}
|
||||
|
||||
WidgetExtension* createWidget(const sol::table& layout, uint64_t depth);
|
||||
void updateWidget(WidgetExtension* ext, const sol::table& layout, uint64_t depth);
|
||||
|
||||
std::vector<WidgetExtension*> updateContent(
|
||||
const std::vector<WidgetExtension*>& children, const sol::object& contentObj, uint64_t depth)
|
||||
{
|
||||
++depth;
|
||||
std::vector<WidgetExtension*> result;
|
||||
if (contentObj == sol::nil)
|
||||
{
|
||||
for (WidgetExtension* w : children)
|
||||
destroyWidget(w);
|
||||
return result;
|
||||
}
|
||||
if (!contentObj.is<Content>())
|
||||
throw std::logic_error("Layout content field must be a openmw.ui.content");
|
||||
Content content = contentObj.as<Content>();
|
||||
result.resize(content.size());
|
||||
size_t minSize = std::min(children.size(), content.size());
|
||||
for (size_t i = 0; i < minSize; i++)
|
||||
{
|
||||
WidgetExtension* ext = children[i];
|
||||
sol::table newLayout = content.at(i);
|
||||
if (ext->widget()->getTypeName() == widgetType(newLayout))
|
||||
{
|
||||
updateWidget(ext, newLayout, depth);
|
||||
}
|
||||
else
|
||||
{
|
||||
destroyWidget(ext);
|
||||
ext = createWidget(newLayout, depth);
|
||||
}
|
||||
result[i] = ext;
|
||||
}
|
||||
for (size_t i = minSize; i < children.size(); i++)
|
||||
destroyWidget(children[i]);
|
||||
for (size_t i = minSize; i < content.size(); i++)
|
||||
result[i] = createWidget(content.at(i), depth);
|
||||
return result;
|
||||
}
|
||||
if (!contentObj.is<Content>())
|
||||
throw std::logic_error("Layout content field must be a openmw.ui.content");
|
||||
Content content = contentObj.as<Content>();
|
||||
result.resize(content.size());
|
||||
size_t minSize = std::min(children.size(), content.size());
|
||||
for (size_t i = 0; i < minSize; i++)
|
||||
|
||||
void setTemplate(WidgetExtension* ext, const sol::object& templateLayout, uint64_t depth)
|
||||
{
|
||||
WidgetExtension* ext = children[i];
|
||||
sol::table newLayout = content.at(i);
|
||||
if (ext->widget()->getTypeName() == widgetType(newLayout))
|
||||
{
|
||||
updateWidget(ext, newLayout);
|
||||
}
|
||||
else
|
||||
{
|
||||
destroyWidget(ext);
|
||||
ext = createWidget(newLayout);
|
||||
}
|
||||
result[i] = ext;
|
||||
++depth;
|
||||
sol::object props = LuaUtil::getFieldOrNil(templateLayout, LayoutKeys::props);
|
||||
ext->setTemplateProperties(props);
|
||||
sol::object content = LuaUtil::getFieldOrNil(templateLayout, LayoutKeys::content);
|
||||
ext->setTemplateChildren(updateContent(ext->templateChildren(), content, depth));
|
||||
}
|
||||
for (size_t i = minSize; i < children.size(); i++)
|
||||
destroyWidget(children[i]);
|
||||
for (size_t i = minSize; i < content.size(); i++)
|
||||
result[i] = createWidget(content.at(i));
|
||||
return result;
|
||||
}
|
||||
|
||||
void setTemplate(WidgetExtension* ext, const sol::object& templateLayout)
|
||||
{
|
||||
sol::object props = LuaUtil::getFieldOrNil(templateLayout, LayoutKeys::props);
|
||||
ext->setTemplateProperties(props);
|
||||
sol::object content = LuaUtil::getFieldOrNil(templateLayout, LayoutKeys::content);
|
||||
ext->setTemplateChildren(updateContent(ext->templateChildren(), content));
|
||||
}
|
||||
|
||||
void setEventCallbacks(LuaUi::WidgetExtension* ext, const sol::object& eventsObj)
|
||||
{
|
||||
ext->clearCallbacks();
|
||||
if (eventsObj == sol::nil)
|
||||
return;
|
||||
if (!eventsObj.is<sol::table>())
|
||||
throw std::logic_error("The \"events\" layout field must be a table of callbacks");
|
||||
auto events = eventsObj.as<sol::table>();
|
||||
events.for_each([ext](const sol::object& name, const sol::object& callback)
|
||||
void setEventCallbacks(LuaUi::WidgetExtension* ext, const sol::object& eventsObj)
|
||||
{
|
||||
if (name.is<std::string>() && callback.is<LuaUtil::Callback>())
|
||||
ext->setCallback(name.as<std::string>(), callback.as<LuaUtil::Callback>());
|
||||
else if (!name.is<std::string>())
|
||||
Log(Debug::Warning) << "UI event key must be a string";
|
||||
else if (!callback.is<LuaUtil::Callback>())
|
||||
Log(Debug::Warning) << "UI event handler for key \"" << name.as<std::string>()
|
||||
<< "\" must be an openmw.async.callback";
|
||||
});
|
||||
}
|
||||
|
||||
WidgetExtension* createWidget(const sol::table& layout)
|
||||
{
|
||||
static auto widgetTypeMap = widgetTypeToName();
|
||||
std::string type = widgetType(layout);
|
||||
if (widgetTypeMap.find(type) == widgetTypeMap.end())
|
||||
throw std::logic_error(std::string("Invalid widget type ") += type);
|
||||
|
||||
std::string name = layout.get_or(LayoutKeys::name, std::string());
|
||||
MyGUI::Widget* widget = MyGUI::Gui::getInstancePtr()->createWidgetT(
|
||||
type, "",
|
||||
MyGUI::IntCoord(), MyGUI::Align::Default,
|
||||
std::string(), name);
|
||||
|
||||
WidgetExtension* ext = dynamic_cast<WidgetExtension*>(widget);
|
||||
if (!ext)
|
||||
throw std::runtime_error("Invalid widget!");
|
||||
ext->initialize(layout.lua_state(), widget);
|
||||
|
||||
updateWidget(ext, layout);
|
||||
return ext;
|
||||
}
|
||||
|
||||
void updateWidget(WidgetExtension* ext, const sol::table& layout)
|
||||
{
|
||||
ext->reset();
|
||||
ext->setLayout(layout);
|
||||
ext->setExternal(layout.get<sol::object>(LayoutKeys::external));
|
||||
setTemplate(ext, layout.get<sol::object>(LayoutKeys::templateLayout));
|
||||
ext->setProperties(layout.get<sol::object>(LayoutKeys::props));
|
||||
setEventCallbacks(ext, layout.get<sol::object>(LayoutKeys::events));
|
||||
ext->setChildren(updateContent(ext->children(), layout.get<sol::object>(LayoutKeys::content)));
|
||||
ext->updateCoord();
|
||||
}
|
||||
|
||||
std::string setLayer(WidgetExtension* ext, const sol::table& layout)
|
||||
{
|
||||
MyGUI::ILayer* layerNode = ext->widget()->getLayer();
|
||||
std::string currentLayer = layerNode ? layerNode->getName() : std::string();
|
||||
std::string newLayer = layout.get_or(LayoutKeys::layer, std::string());
|
||||
if (!newLayer.empty() && !MyGUI::LayerManager::getInstance().isExist(newLayer))
|
||||
throw std::logic_error(std::string("Layer ") + newLayer + " doesn't exist");
|
||||
else if (newLayer != currentLayer)
|
||||
{
|
||||
MyGUI::LayerManager::getInstance().attachToLayerNode(newLayer, ext->widget());
|
||||
ext->clearCallbacks();
|
||||
if (eventsObj == sol::nil)
|
||||
return;
|
||||
if (!eventsObj.is<sol::table>())
|
||||
throw std::logic_error("The \"events\" layout field must be a table of callbacks");
|
||||
auto events = eventsObj.as<sol::table>();
|
||||
events.for_each([ext](const sol::object& name, const sol::object& callback)
|
||||
{
|
||||
if (name.is<std::string>() && callback.is<LuaUtil::Callback>())
|
||||
ext->setCallback(name.as<std::string>(), callback.as<LuaUtil::Callback>());
|
||||
else if (!name.is<std::string>())
|
||||
Log(Debug::Warning) << "UI event key must be a string";
|
||||
else if (!callback.is<LuaUtil::Callback>())
|
||||
Log(Debug::Warning) << "UI event handler for key \"" << name.as<std::string>()
|
||||
<< "\" must be an openmw.async.callback";
|
||||
});
|
||||
}
|
||||
|
||||
WidgetExtension* createWidget(const sol::table& layout, uint64_t depth)
|
||||
{
|
||||
static auto widgetTypeMap = widgetTypeToName();
|
||||
std::string type = widgetType(layout);
|
||||
if (widgetTypeMap.find(type) == widgetTypeMap.end())
|
||||
throw std::logic_error(std::string("Invalid widget type ") += type);
|
||||
|
||||
std::string name = layout.get_or(LayoutKeys::name, std::string());
|
||||
MyGUI::Widget* widget = MyGUI::Gui::getInstancePtr()->createWidgetT(
|
||||
type, "",
|
||||
MyGUI::IntCoord(), MyGUI::Align::Default,
|
||||
std::string(), name);
|
||||
|
||||
WidgetExtension* ext = dynamic_cast<WidgetExtension*>(widget);
|
||||
if (!ext)
|
||||
throw std::runtime_error("Invalid widget!");
|
||||
ext->initialize(layout.lua_state(), widget);
|
||||
|
||||
updateWidget(ext, layout, depth);
|
||||
return ext;
|
||||
}
|
||||
|
||||
void updateWidget(WidgetExtension* ext, const sol::table& layout, uint64_t depth)
|
||||
{
|
||||
if (depth >= maxDepth)
|
||||
throw std::runtime_error("Maximum layout depth exceeded, probably caused by a circular reference");
|
||||
ext->reset();
|
||||
ext->setLayout(layout);
|
||||
ext->setExternal(layout.get<sol::object>(LayoutKeys::external));
|
||||
setTemplate(ext, layout.get<sol::object>(LayoutKeys::templateLayout), depth);
|
||||
ext->setProperties(layout.get<sol::object>(LayoutKeys::props));
|
||||
setEventCallbacks(ext, layout.get<sol::object>(LayoutKeys::events));
|
||||
ext->setChildren(updateContent(ext->children(), layout.get<sol::object>(LayoutKeys::content), depth));
|
||||
ext->updateCoord();
|
||||
}
|
||||
|
||||
std::string setLayer(WidgetExtension* ext, const sol::table& layout)
|
||||
{
|
||||
MyGUI::ILayer* layerNode = ext->widget()->getLayer();
|
||||
std::string currentLayer = layerNode ? layerNode->getName() : std::string();
|
||||
std::string newLayer = layout.get_or(LayoutKeys::layer, std::string());
|
||||
if (!newLayer.empty() && !MyGUI::LayerManager::getInstance().isExist(newLayer))
|
||||
throw std::logic_error(std::string("Layer ") + newLayer + " doesn't exist");
|
||||
else if (newLayer != currentLayer)
|
||||
{
|
||||
MyGUI::LayerManager::getInstance().attachToLayerNode(newLayer, ext->widget());
|
||||
}
|
||||
return newLayer;
|
||||
}
|
||||
return newLayer;
|
||||
}
|
||||
|
||||
std::map<Element*, std::shared_ptr<Element>> Element::sAllElements;
|
||||
|
|
@ -184,7 +193,7 @@ namespace LuaUi
|
|||
assert(!mRoot);
|
||||
if (!mRoot)
|
||||
{
|
||||
mRoot = createWidget(mLayout);
|
||||
mRoot = createWidget(mLayout, 0);
|
||||
mLayer = setLayer(mRoot, mLayout);
|
||||
updateAttachment();
|
||||
}
|
||||
|
|
@ -197,11 +206,11 @@ namespace LuaUi
|
|||
if (mRoot->widget()->getTypeName() != widgetType(mLayout))
|
||||
{
|
||||
destroyWidget(mRoot);
|
||||
mRoot = createWidget(mLayout);
|
||||
mRoot = createWidget(mLayout, 0);
|
||||
}
|
||||
else
|
||||
{
|
||||
updateWidget(mRoot, mLayout);
|
||||
updateWidget(mRoot, mLayout, 0);
|
||||
}
|
||||
mLayer = setLayer(mRoot, mLayout);
|
||||
updateAttachment();
|
||||
|
|
|
|||
Loading…
Reference in a new issue