Something went wrong. Try again.
OpenMW is an open implementation of the Morrowind engine
Something went wrong. Try again.
15 kB · 399 lines
C++
at master
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400#include "element.hpp"
#include <MyGUI_Gui.h>
#include "components/settings/values.hpp"#include "content.hpp"#include "util.hpp"#include "widget.hpp"
namespace LuaUi{ namespace { namespace LayoutKeys { 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"; constexpr std::string_view userData = "userData";
const std::vector<std::string_view> allKeys = { type, name, layer, templateLayout, props, events, content, external, userData }; }
const std::string defaultWidgetType = "LuaWidget";
constexpr uint64_t maxDepth = 250;
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) { 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 = std::move(templateType); } return type; }
void destroyWidget(WidgetExtension* ext) { ext->deinitialize(); MyGUI::Gui::getInstancePtr()->destroyWidget(ext->widget()); }
void detachElements(WidgetExtension* ext) { auto predicate = [](WidgetExtension* child) { if (child->isRoot()) return true; detachElements(child); return false; }; ext->detachChildrenIf(predicate); ext->detachTemplateChildrenIf(predicate); }
void destroyChild(WidgetExtension* ext) { if (!ext->isRoot()) { detachElements(ext); destroyWidget(ext); } else ext->detachFromParent(); }
void destroyRoot(WidgetExtension* ext) { detachElements(ext); destroyWidget(ext); }
void updateRootCoord(WidgetExtension* ext) { WidgetExtension* root = ext; while (root->getParent()) root = root->getParent(); root->updateCoord(); }
WidgetExtension* pluckElementRoot(const sol::object& child, uint64_t depth) { std::shared_ptr<Element> element = child.as<std::shared_ptr<Element>>(); if (element->mState == Element::Destroyed || element->mState == Element::Destroy) throw std::logic_error("Using a destroyed element as a layout child"); // child Element was created in the same frame and its action hasn't been processed yet if (element->mState == Element::New) element->create(depth + 1); WidgetExtension* root = element->mRoot; assert(root); return root; }
WidgetExtension* createWidget(const sol::table& layout, bool isRoot, 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) destroyChild(w); return result; } ContentView content(LuaUtil::cast<sol::table>(contentObj)); result.resize(content.size()); size_t minSize = std::min(children.size(), content.size()); std::vector<WidgetExtension*> toDestroy; for (size_t i = 0; i < minSize; i++) { WidgetExtension* ext = children[i]; sol::object child = content.at(i); if (child.is<Element>()) { WidgetExtension* root = pluckElementRoot(child, depth); if (ext != root) toDestroy.emplace_back(ext); result[i] = root; } else { sol::table newLayout = child.as<sol::table>(); if (ext->widget()->getTypeName() == widgetType(newLayout)) { updateWidget(ext, newLayout, depth); } else { toDestroy.emplace_back(ext); ext = createWidget(newLayout, false, depth); } result[i] = ext; } } for (size_t i = minSize; i < content.size(); i++) { sol::object child = content.at(i); if (child.is<Element>()) result[i] = pluckElementRoot(child, depth); else result[i] = createWidget(child.as<sol::table>(), false, depth); } // Don't destroy anything until element creation has had a chance to throw for (size_t i = minSize; i < children.size(); i++) destroyChild(children[i]); for (WidgetExtension* ext : toDestroy) destroyChild(ext); return result; }
void setTemplate(WidgetExtension* ext, const sol::object& templateLayout, uint64_t depth) { ++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)); }
void setEventCallbacks(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) { if (name.is<std::string>() && LuaUtil::Callback::isLuaCallback(callback)) ext->setCallback(name.as<std::string>(), LuaUtil::Callback::fromLua(callback)); else if (!name.is<std::string>()) Log(Debug::Warning) << "UI event key must be a string"; else Log(Debug::Warning) << "UI event handler for key \"" << name.as<std::string>() << "\" must be an openmw.async.callback"; }); }
WidgetExtension* createWidget(const sol::table& layout, bool isRoot, 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::Align::Default, {}, name);
WidgetExtension* ext = dynamic_cast<WidgetExtension*>(widget); if (!ext) throw std::runtime_error("Invalid widget!"); ext->initialize(layout.lua_state(), widget, isRoot);
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_view currentLayer; if (layerNode) currentLayer = layerNode->getName(); 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; } }
std::map<Element*, std::shared_ptr<Element>> Element::sMenuElements; std::map<Element*, std::shared_ptr<Element>> Element::sGameElements;
Element::Element(sol::table layout, sol::optional<sol::table> options) : mRoot(nullptr) , mLayout(std::move(layout)) , mLayer() , mState(Element::New) { if (options.has_value()) { mNoWarnUnused = options->get_or("noWarnUnused", false); } }
std::shared_ptr<Element> Element::make(sol::table layout, bool menu, sol::optional<sol::table> options) { std::shared_ptr<Element> ptr(new Element(std::move(layout), std::move(options))); auto& container = menu ? sMenuElements : sGameElements; container[ptr.get()] = ptr; return ptr; }
void Element::erase(Element* element) { element->destroy(); sMenuElements.erase(element); sGameElements.erase(element); }
const std::vector<std::string_view>& Element::allLayoutProperties() { return LayoutKeys::allKeys; }
void Element::create(uint64_t depth) { if (mState == New) { assert(!mRoot); mRoot = createWidget(layout(), true, depth); mLayer = setLayer(mRoot, layout()); updateRootCoord(mRoot); WidgetExtension::refreshCursor(); mState = Created; checkWarnings(); } }
void Element::update() { if (mState == Update) { assert(mRoot); if (mRoot->widget()->getTypeName() != widgetType(layout())) { // A root element can either be attached to another UI element or directly to a layer. Keep the // parent information before destroying the old widget: mRoot is no longer valid afterwards. WidgetExtension* oldRoot = mRoot; WidgetExtension* parent = oldRoot->getParent(); if (parent == nullptr) { destroyRoot(oldRoot); try { mRoot = createWidget(layout(), true, 0); } catch (...) { mRoot = nullptr; mState = New; throw; } } else { auto children = parent->children(); auto it = std::find(children.begin(), children.end(), oldRoot); assert(it != children.end());
destroyRoot(oldRoot); try { mRoot = createWidget(layout(), true, 0); *it = mRoot; } catch (...) { // Remove the old root from its parent's children even if we couldn't replace it. children.erase(it); parent->setChildren(children); mRoot = nullptr; mState = New; throw; } parent->setChildren(children); } } else { updateWidget(mRoot, layout(), 0); } mLayer = setLayer(mRoot, layout()); updateRootCoord(mRoot); WidgetExtension::refreshCursor(); mState = Created; checkWarnings(); } }
void Element::destroy() { if (mState != Destroyed) { if (mRoot != nullptr) { // If someone decided to destroy an element used as another element's content, we need to detach it // first so the parent doesn't end up holding a stale pointer if (WidgetExtension* parent = mRoot->getParent()) parent->detachChildrenIf([&](WidgetExtension* child) { return child == mRoot; }); destroyRoot(mRoot); mRoot = nullptr; } mLayout.reset(); } mState = Destroyed; }
void Element::checkWarnings() { if (mNoWarnUnused) // Currently unused warnings are our only warnings so we can just early out here. return;
if (Settings::lua().mLuaDebug) { assert(mRoot); WidgetExtension::Warnings warnings; mRoot->collectWarnings(warnings, 0, true); for (const auto& warning : warnings) Log(Debug::Warning) << warning; } else if (!mWarnedOnce) { mWarnedOnce = true; WidgetExtension::Warnings dummy; if (mRoot->collectWarnings(dummy, 0, false)) { Log(Debug::Warning) << "Warning generated while parsing layouts of a(n) " + mRoot->diagnosticName() + ". Set 'lua " "debug=true' in the [Lua] section of settings.cfg to enable detailed warnings."; } } }}