tibia-client/src/framework/ui/uiloader.cpp

/* The MIT License
 *
 * Copyright (c) 2010 OTClient, https://github.com/edubart/otclient
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */


#include <global.h>
#include <core/resources.h>
#include <ui/ui.h>
#include <ui/uiloader.h>
#include <script/luascript.h>
#include <script/luafunctions.h>
#include <otml/otml.h>
#include <ui/uianchorlayout.h>
#include <util/translator.h>

#include <boost/algorithm/string.hpp>

UILoader g_uiLoader;

UIElementPtr UILoader::createElementFromId(const std::string& id)
{
    UIElementPtr element;

    std::vector<std::string> split;
    boost::split(split, id, boost::is_any_of(std::string("#")));
    if(split.size() != 2)
        return element;

    std::string elementType = split[0].substr(1);
    std::string elementId = split[1];

    if(elementType == "panel")
        element = UIElementPtr(new UIContainer(UI::Panel));
    else if(elementType == "button")
        element = UIElementPtr(new UIButton);
    else if(elementType == "label")
        element = UIElementPtr(new UILabel);
    else if(elementType == "window")
        element = UIElementPtr(new UIWindow);
    else if(elementType == "textEdit")
        element = UIElementPtr(new UITextEdit);
    else if(elementType == "lineDecoration")
        element = UIElementPtr(new UIElement(UI::LineDecoration));
    else if(elementType == "checkBox")
        element = UIElementPtr(new UICheckBox);

    if(element)
        element->setId(elementId);

    return element;
}

UIElementPtr UILoader::loadFromFile(std::string filePath, const UIContainerPtr& parent)
{
    std::stringstream fin;
    if(!g_resources.loadFile(filePath, fin)) {
        error("ERROR: Could not load ui ", filePath);
        return UIElementPtr();
    }

    try {
        OTMLParser parser(fin, filePath);
        OTMLNode* doc = parser.getDocument();

        // get element id
        std::string elementId = doc->front()->tag();

        // first we should populate all elements
        // only after that we can load anchors

        // create element interpreting it's id
        UIElementPtr element = createElementFromId(elementId);
        if(!element) {
            error(doc->front()->generateErrorMessage("invalid root element type"));
            return element;
        }
        parent->addChild(element);

        // populete it
        if(element->asUIContainer())
            populateContainer(element->asUIContainer(), doc->front());

        // now do the real load
        loadElements(element, doc->front());

        // report onLoad events
        element->onLoad();
        return element;
    } catch(OTMLException e) {
        error("ERROR: Failed to load ui ",filePath,": ", e.what());
    }

    return UIElementPtr();
}

void UILoader::populateContainer(const UIContainerPtr& parent, OTMLNode* node)
{
    // populate ordered elements
    foreach(OTMLNode* cnode, *node) {
        std::string id = cnode->tag();
        if(id[0] == '%') {
            UIElementPtr element = createElementFromId(id);
            if(!element) {
                error(cnode->generateErrorMessage("invalid element type"));
                continue;
            }
            parent->addChild(element);

            // also populate this element if it's a parent
            if(element->asUIContainer())
                populateContainer(element->asUIContainer(), cnode);
        }
    }
}

void UILoader::loadElements(const UIElementPtr& parent, OTMLNode* node)
{
    loadElement(parent, node);

    if(UIContainerPtr container = parent->asUIContainer()) {
        foreach(const UIElementPtr& element, container->getChildren()) {
            foreach(OTMLNode* cnode, *node) {
                // node found, load it
                if(boost::ends_with(cnode->tag(), "#" + element->getId())) {
                    loadElements(element, cnode);
                    break;
                }
            }
        }
    }
}

void UILoader::loadElement(const UIElementPtr& element, OTMLNode* node)
{
    // set element skin
    if(OTMLNode* cnode = node->at("skin")) {
        if(cnode->hasValue()) {
            element->setSkin(g_uiSkins.getElementSkin(element->getElementType(), cnode->value()));
        } else {
            UIElementSkinPtr skin = UIElementSkinPtr(new UIElementSkin());
            skin->load(cnode);
            element->setSkin(skin);
        }
    } else // apply default skin
        element->setSkin(g_uiSkins.getElementSkin(element->getElementType(), "default"));

    // load elements common proprieties
    if(node->hasNode("size"))
        element->setSize(node->readAt<Size>("size"));

    // load margins
    element->setMarginLeft(node->readAtPath("margin/left", 0));
    element->setMarginRight(node->readAtPath("margin/right", 0));
    element->setMarginTop(node->readAtPath("margin/top", 0));
    element->setMarginBottom(node->readAtPath("margin/bottom", 0));

    // load anchors
    loadElementAnchor(element, UI::AnchorLeft, node->atPath("anchors/left"));
    loadElementAnchor(element, UI::AnchorRight, node->atPath("anchors/right"));
    loadElementAnchor(element, UI::AnchorTop, node->atPath("anchors/top"));
    loadElementAnchor(element, UI::AnchorBottom, node->atPath("anchors/bottom"));
    loadElementAnchor(element, UI::AnchorHorizontalCenter, node->atPath("anchors/horizontalCenter"));
    loadElementAnchor(element, UI::AnchorVerticalCenter, node->atPath("anchors/verticalCenter"));

    // load basic element events
    loadElementScriptFunction(element, node->at("onLoad"));
    loadElementScriptFunction(element, node->at("onDestroy"));

    // load specific element type
    switch(element->getElementType()) {
        case UI::Button:
            loadButton(boost::static_pointer_cast<UIButton>(element), node);
            break;
        case UI::Window:
            loadWindow(boost::static_pointer_cast<UIWindow>(element), node);
            break;
        case UI::Label:
            loadLabel(boost::static_pointer_cast<UILabel>(element), node);
            break;
        default:
            break;
     }
}

void UILoader::loadElementAnchor(const UIElementPtr& anchoredElement, UI::AnchorPoint anchoredEdge, OTMLNode* node)
{
    if(!node)
        return;

    std::string anchorDescription = node->value();
    if(anchorDescription.empty()) {
        error(node->generateErrorMessage("anchor is empty, did you forget to fill it?"));
        return;
    }

    UIAnchorLayoutPtr layout = boost::dynamic_pointer_cast<UIAnchorLayout>(anchoredElement->getLayout());
    if(!layout) {
        error(node->generateErrorMessage("could not add anchor, because this element does not participate of an anchor layout"));
        return;
    }

    std::vector<std::string> split;
    boost::split(split, anchorDescription, boost::is_any_of(std::string(".")));
    if(split.size() != 2) {
        error(node->generateErrorMessage("invalid anchor"));
        return;
    }

    std::string anchorLineElementId = split[0];
    UI::AnchorPoint anchorLineEdge = UIAnchorLayout::parseAnchorPoint(split[1]);

    if(anchorLineEdge == UI::AnchorNone) {
        error(node->generateErrorMessage("invalid anchor type"));
        return;
    }

    if(!layout->addAnchor(anchoredElement, anchoredEdge, AnchorLine(anchorLineElementId, anchorLineEdge)))
        error(node->generateErrorMessage("anchoring failed"));
}

void UILoader::loadElementScriptFunction(const UIElementPtr& element, OTMLNode* node)
{
    if(!node)
        return;

    std::string functionDesc;
    functionDesc += g_resources.resolvePath(node->what()) + ":" + element->getId();
    functionDesc += "[" + node->tag() + "]";

    if(g_lua.loadBufferAsFunction(node->value(), functionDesc))
        g_lua.setScriptableField(element, node->tag());
    else
        error(node->generateErrorMessage("failed to parse inline lua script"));
}

void UILoader::loadButton(const UIButtonPtr& button, OTMLNode* node)
{
    button->setText(node->valueAt("text"));
    loadElementScriptFunction(button, node->at("onClick"));
}

void UILoader::loadWindow(const UIWindowPtr& window, OTMLNode* node)
{
    window->setTitle(node->readAt("title", std::string()));
}

void UILoader::loadLabel(const UILabelPtr& label, OTMLNode* node)
{
    label->setText(node->readAt("text", std::string()));
    label->setAlign(parseAlignment(node->readAt("align", std::string("left"))));
}