Magic_Game/src/kiwano/render/TextLayout.h

// Copyright (c) 2016-2018 Kiwano - Nomango
//
// 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.

#pragma once
#include <kiwano/math/Math.h>
#include <kiwano/render/NativeObject.h>
#include <kiwano/render/TextStyle.hpp>

namespace kiwano
{

KGE_DECLARE_SMART_PTR(TextLayout);

/**
 * \addtogroup Render
 * @{
 */

/// \~chinese
/// @brief <20>ı<EFBFBD><C4B1><EFBFBD><EFBFBD><EFBFBD>
class KGE_API TextLayout : public NativeObject
{
public:
    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>ı<EFBFBD><C4B1><EFBFBD><EFBFBD><EFBFBD>
    static TextLayoutPtr Create();

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>ı<EFBFBD><C4B1><EFBFBD><EFBFBD><EFBFBD>
    /// @param content <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param style <20>ı<EFBFBD><C4B1><EFBFBD>ʽ
    static TextLayoutPtr Create(const String& content, const TextStyle& style);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>յ<EFBFBD><D5B5>ı<EFBFBD><C4B1><EFBFBD><EFBFBD><EFBFBD>
    TextLayout();

    /// \~chinese
    /// @brief <20>ı<EFBFBD><C4B1><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ƿ<EFBFBD><C7B7>¾<EFBFBD>
    bool IsDirty() const;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>ı<EFBFBD><C4B1><EFBFBD><EFBFBD><EFBFBD>
    void Clear();

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>ı<EFBFBD><C4B1><EFBFBD><EFBFBD><EFBFBD>
    /// @param style <20>ı<EFBFBD><C4B1><EFBFBD>ʽ
    void Reset(const TextStyle& style);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>ı<EFBFBD><C4B1><EFBFBD><EFBFBD><EFBFBD>
    /// @param content <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param style <20>ı<EFBFBD><C4B1><EFBFBD>ʽ
    void Reset(const String& content, const TextStyle& style);

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    String GetContent() const;

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ݵij<DDB5><C4B3><EFBFBD>
    uint32_t GetContentLength() const;

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD>ı<EFBFBD><C4B1><EFBFBD><EFBFBD>ִ<EFBFBD>С
    Size GetSize() const;

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD>ı<EFBFBD><C4B1><EFBFBD><EFBFBD><EFBFBD>
    uint32_t GetLineCount() const;

    /// \~chinese
    /// @brief <20><>ȡĬ<C8A1><C4AC><EFBFBD><EFBFBD><EFBFBD>仭ˢ
    BrushPtr GetDefaultFillBrush() const;

    /// \~chinese
    /// @brief <20><>ȡĬ<C8A1><C4AC><EFBFBD><EFBFBD><EFBFBD>߻<EFBFBD>ˢ
    BrushPtr GetDefaultOutlineBrush() const;

    /// \~chinese
    /// @brief <20><>ȡĬ<C8A1><C4AC><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʽ
    StrokeStylePtr GetDefaultOutlineStrokeStyle() const;

    /// \~chinese
    /// @brief <20><><EFBFBD>ַ<EFBFBD>Χ
    struct TextRange
    {
        uint32_t start;   ///< <20><>ʼλ<CABC><CEBB>
        uint32_t length;  ///< <20><><EFBFBD><EFBFBD>
    };

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param font <20><><EFBFBD><EFBFBD>
    /// @param range <20><><EFBFBD>ַ<EFBFBD>Χ
    void SetFont(FontPtr font, TextRange range);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param family <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param range <20><><EFBFBD>ַ<EFBFBD>Χ
    void SetFontFamily(const String& family, TextRange range);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>ֺţ<D6BA>Ĭ<EFBFBD><C4AC>ֵΪ 18<31><38>
    /// @param size <20>ֺ<EFBFBD>
    /// @param range <20><><EFBFBD>ַ<EFBFBD>Χ
    void SetFontSize(float size, TextRange range);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ϸֵ<CFB8><D6B5>Ĭ<EFBFBD><C4AC>ֵΪ FontWeight::Normal<61><6C>
    /// @param weight <20><>ϸֵ
    /// @param range <20><><EFBFBD>ַ<EFBFBD>Χ
    void SetFontWeight(uint32_t weight, TextRange range);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>б<EFBFBD>壨Ĭ<E5A3A8><C4AC>ֵΪ false<73><65>
    /// @param italic <20>Ƿ<EFBFBD><C7B7><EFBFBD>б<EFBFBD><D0B1>
    /// @param range <20><><EFBFBD>ַ<EFBFBD>Χ
    void SetItalic(bool italic, TextRange range);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>»<EFBFBD><C2BB><EFBFBD>
    /// @param enable <20>Ƿ<EFBFBD><C7B7><EFBFBD>ʾ<EFBFBD>»<EFBFBD><C2BB><EFBFBD>
    /// @param range <20><><EFBFBD>ַ<EFBFBD>Χ
    void SetUnderline(bool enable, TextRange range);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>ɾ<EFBFBD><C9BE><EFBFBD><EFBFBD>
    /// @param enable <20>Ƿ<EFBFBD><C7B7><EFBFBD>ʾɾ<CABE><C9BE><EFBFBD><EFBFBD>
    /// @param range <20><><EFBFBD>ַ<EFBFBD>Χ
    void SetStrikethrough(bool enable, TextRange range);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>仭ˢ<E4BBAD><CBA2><EFBFBD><EFBFBD><EFBFBD>߻<EFBFBD>ˢ<EFBFBD><CBA2><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>߿<EFBFBD>
    /// @param brush <20><>ˢ
    /// @param range <20><><EFBFBD>ַ<EFBFBD>Χ
    void SetFillBrush(BrushPtr brush, TextRange range);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>߻<EFBFBD>ˢ
    /// @param brush <20><>ˢ
    /// @param range <20><><EFBFBD>ַ<EFBFBD>Χ
    void SetOutlineBrush(BrushPtr brush, TextRange range);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʽ
    /// @param stroke <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʽ
    /// @param range <20><><EFBFBD>ַ<EFBFBD>Χ
    void SetOutlineStrokeStyle(StrokeStylePtr stroke, TextRange range);

    /// \~chinese
    /// @brief <20><><EFBFBD>ö<EFBFBD><C3B6>뷽ʽ
    /// @param align <20><><EFBFBD>뷽ʽ
    void SetAlignment(TextAlign align);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>ı<EFBFBD><C4B1>Զ<EFBFBD><D4B6><EFBFBD><EFBFBD>еĿ<D0B5><C4BF><EFBFBD>
    void SetWrapWidth(float wrap_width);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>м<EFBFBD><D0BC>ࣨĬ<E0A3A8><C4AC>Ϊ 0<><30>
    void SetLineSpacing(float line_spacing);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>Ĭ<EFBFBD><C4AC><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>仭ˢ
    /// @param brush <20><>ˢ
    void SetDefaultFillBrush(BrushPtr brush);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>Ĭ<EFBFBD><C4AC><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>߻<EFBFBD>ˢ
    /// @param brush <20><>ˢ
    void SetDefaultOutlineBrush(BrushPtr brush);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>Ĭ<EFBFBD><C4AC><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʽ
    /// @param stroke <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʽ
    void SetDefaultOutlineStrokeStyle(StrokeStylePtr stroke);

    /// \~chinese
    /// @brief <20>಼<EFBFBD>ֱ<EFBFBD>־
    enum class DirtyFlag : uint8_t
    {
        Clean = 0,      ///< <20>ɾ<EFBFBD><C9BE><EFBFBD><EFBFBD><EFBFBD>
        Dirty = 1 << 0  ///< <20>಼<EFBFBD><E0B2BC>
    };

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD>಼<EFBFBD>ֱ<EFBFBD>־
    DirtyFlag GetDirtyFlag() const;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>಼<EFBFBD>ֱ<EFBFBD>־
    void SetDirtyFlag(DirtyFlag flag);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>಼<EFBFBD><E0B2BC>
    /// @return <20>Ƿ<EFBFBD><C7B7><EFBFBD>Ҫ<EFBFBD><D2AA><EFBFBD><EFBFBD>
    bool UpdateWhenDirty();

private:
    DirtyFlag      dirty_flag_;
    uint32_t       line_count_;
    Size           size_;
    BrushPtr       default_fill_brush_;
    BrushPtr       default_outline_brush_;
    StrokeStylePtr default_outline_stroke_;
    String         content_;
};

/** @} */

inline bool TextLayout::IsDirty() const
{
    return dirty_flag_ != DirtyFlag::Clean;
}

inline void TextLayout::Clear()
{
    ResetNativePointer();
}

inline void TextLayout::Reset(const TextStyle& style)
{
    this->Reset(content_, style);
}

inline String TextLayout::GetContent() const
{
    return content_;
}

inline uint32_t TextLayout::GetContentLength() const
{
    return uint32_t(content_.size());
}

inline TextLayout::DirtyFlag TextLayout::GetDirtyFlag() const
{
    return dirty_flag_;
}

inline void TextLayout::SetDirtyFlag(TextLayout::DirtyFlag flag)
{
    dirty_flag_ = flag;
}

inline BrushPtr TextLayout::GetDefaultFillBrush() const
{
    return default_fill_brush_;
}

inline BrushPtr TextLayout::GetDefaultOutlineBrush() const
{
    return default_outline_brush_;
}

inline StrokeStylePtr TextLayout::GetDefaultOutlineStrokeStyle() const
{
    return default_outline_stroke_;
}

inline void TextLayout::SetDefaultFillBrush(BrushPtr brush)
{
    default_fill_brush_ = brush;
}

inline void TextLayout::SetDefaultOutlineBrush(BrushPtr brush)
{
    default_outline_brush_ = brush;
}

inline void TextLayout::SetDefaultOutlineStrokeStyle(StrokeStylePtr stroke)
{
    default_outline_stroke_ = stroke;
}

}  // namespace kiwano