Layout.hpp

 
//
// TGUI - Texus's Graphical User Interface
// Copyright (C) 2012-2017 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
 
#ifndef TGUI_LAYOUT_HPP
#define TGUI_LAYOUT_HPP
 
#include <SFML/System/Vector2.hpp>
#include <TGUI/Config.hpp>
#include <functional>
#include <memory>
#include <vector>
#include <set>
 
 
namespace tgui
{
    class Gui;
    class Widget;
    class Layout;
 
    class TGUI_API LayoutImpl : public std::enable_shared_from_this<LayoutImpl>
    {
    public:
 
        enum class Operation
        {
            Value,
            String,
            Plus,
            Minus,
            Multiplies,
            Divides,
            Modulus,
            And,
            Or,
            LessThan,
            LessOrEqual,
            GreaterThan,
            GreaterOrEqual,
            Equal,
            NotEqual,
            Minimum,
            Maximum,
            Conditional
        };
 
 
    public:
 
        ~LayoutImpl();
 
        void recalculate();
 
 
    private:
 
        // Calculate the value of a layout defined by a string
        float parseLayoutString(std::string expression);
 
        // Parse references to widgets from the layout strings
        float parseWidgetName(const std::string& expression, Widget* widget, const std::string& alreadyParsedPart = "");
 
 
    public:
        float value = 0; 
        std::set<Layout*> attachedLayouts; 
        std::set<LayoutImpl*> parents; 
 
        Operation operation = Operation::Value; 
        std::vector<std::shared_ptr<LayoutImpl>> operands; 
 
        // These members are only used when operation == Operation::String
        std::string stringExpression; 
        Widget* parentWidget = nullptr; 
 
    private:
        std::set<std::string> boundCallbacks;
    };
 
 
    class TGUI_API Layout
    {
    public:
 
        Layout();
 
 
        template <typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value, T>::type>
        Layout(T constant)
        {
            m_impl->value = static_cast<float>(constant);
        }
 
 
        Layout(const char* expression);
 
 
        Layout(const std::string& expression);
 
 
        Layout(const Layout& copy);
 
 
        Layout& operator=(const Layout& right);
 
 
        float getValue() const;
 
 
        void connectUpdateCallback(const std::function<void()>& callbackFunction);
 
 
        void update() const;
 
 
        std::shared_ptr<LayoutImpl> getImpl() const;
 
 
        Layout operator+();
 
        Layout operator-();
 
        Layout operator+=(Layout right);
 
        Layout operator-=(Layout right);
 
        Layout operator*=(Layout right);
 
        Layout operator/=(Layout right);
 
        Layout operator%=(Layout right);
 
 
    private:
        std::shared_ptr<LayoutImpl> m_impl = std::make_shared<LayoutImpl>();
        std::function<void()> m_callbackFunction;
    };
 
 
    class TGUI_API Layout2d
    {
    public:
 
        Layout2d(sf::Vector2f constant = {0, 0});
 
 
        Layout2d(Layout layoutX, Layout layoutY);
 
 
        Layout2d(const char* expression);
 
 
        Layout2d(const std::string& expression);
 
 
        sf::Vector2f getValue() const;
 
 
        Layout2d operator+();
 
        Layout2d operator-();
 
        Layout2d operator+=(Layout2d right);
 
        Layout2d operator-=(Layout2d right);
 
        Layout2d operator*=(Layout right);
 
        Layout2d operator/=(Layout right);
 
        Layout2d operator%=(Layout right);
 
    public:
        Layout x; 
        Layout y; 
    };
 
 
    TGUI_API Layout operator<(Layout left, Layout right);
 
    TGUI_API Layout operator<=(Layout left, Layout right);
 
    TGUI_API Layout operator>(Layout left, Layout right);
 
    TGUI_API Layout operator>=(Layout left, Layout right);
 
    TGUI_API Layout operator==(Layout left, Layout right);
 
    TGUI_API Layout operator!=(Layout left, Layout right);
 
    TGUI_API Layout operator+(Layout left, Layout right);
 
    TGUI_API Layout operator-(Layout left, Layout right);
 
    TGUI_API Layout operator*(Layout left, Layout right);
 
    TGUI_API Layout operator/(Layout left, Layout right);
 
    TGUI_API Layout operator%(Layout left, Layout right);
 
    TGUI_API Layout operator&&(Layout left, Layout right);
 
    TGUI_API Layout operator||(Layout left, Layout right);
 
    TGUI_API Layout operator==(Layout2d left, Layout2d right);
 
    TGUI_API Layout operator!=(Layout2d left, Layout2d right);
 
    TGUI_API Layout2d operator+(Layout2d left, Layout2d right);
 
    TGUI_API Layout2d operator-(Layout2d left, Layout2d right);
 
    TGUI_API Layout2d operator*(Layout2d left, Layout right);
 
    TGUI_API Layout2d operator/(Layout2d left, Layout right);
 
    TGUI_API Layout2d operator%(Layout2d left, Layout right);
 
    TGUI_API Layout2d operator*(Layout left, Layout2d right);
 
    TGUI_API Layout bindLeft(std::shared_ptr<Widget> widget);
 
    TGUI_API Layout bindTop(std::shared_ptr<Widget> widget);
 
    TGUI_API Layout bindWidth(std::shared_ptr<Widget> widget);
 
    TGUI_API Layout bindHeight(std::shared_ptr<Widget> widget);
 
    TGUI_API Layout bindRight(std::shared_ptr<Widget> widget);
 
    TGUI_API Layout bindBottom(std::shared_ptr<Widget> widget);
 
    TGUI_API Layout2d bindPosition(std::shared_ptr<Widget> widget);
 
    TGUI_API Layout2d bindSize(std::shared_ptr<Widget> widget);
 
    TGUI_API Layout bindLeft(Gui& gui);
 
    TGUI_API Layout bindTop(Gui& gui);
 
    TGUI_API Layout bindWidth(Gui& gui);
 
    TGUI_API Layout bindHeight(Gui& gui);
 
    TGUI_API Layout bindRight(Gui& gui);
 
    TGUI_API Layout bindBottom(Gui& gui);
 
    TGUI_API Layout2d bindPosition(Gui& gui);
 
    TGUI_API Layout2d bindSize(Gui& gui);
 
    TGUI_API Layout bindMin(Layout value1, Layout value2);
 
    TGUI_API Layout bindMax(Layout value1, Layout value2);
 
    TGUI_API Layout bindRange(Layout minimum, Layout maximum, Layout value);
 
    TGUI_API Layout bindIf(Layout condition, Layout trueExpr, Layout falseExpr);
 
    TGUI_API Layout2d bindIf(Layout condition, Layout2d trueExpr, Layout2d falseExpr);
 
    TGUI_API Layout bindStr(const std::string& expression);
 
    TGUI_API Layout bindStr(const char* expression);
 
    TGUI_API Layout2d bindStr2d(const std::string& expression);
 
    TGUI_API Layout2d bindStr2d(const char* expression);
 
    // Put TGUI_IMPORT_LAYOUT_BIND_FUNCTIONS somewhere in your code to no longer have to put "tgui::" in front of the bind functions
    // without having to import everything from tgui in your namespace or writing all these using statements yourself.
    #define TGUI_IMPORT_LAYOUT_BIND_FUNCTIONS \
        using tgui::bindLeft; \
        using tgui::bindTop; \
        using tgui::bindWidth; \
        using tgui::bindHeight; \
        using tgui::bindRight; \
        using tgui::bindBottom; \
        using tgui::bindPosition; \
        using tgui::bindSize; \
        using tgui::bindMin; \
        using tgui::bindMax; \
        using tgui::bindRange; \
        using tgui::bindIf; \
        using tgui::bindStr; \
        using tgui::bindStr2d;
 
}
 
 
#endif // TGUI_LAYOUT_HPP