SFML/test/Graphics/Text.test.cpp

#include <SFML/Graphics/Text.hpp>

// Other 1st party headers
#include <SFML/Graphics/Font.hpp>

#include <catch2/catch_test_macros.hpp>

#include <GraphicsUtil.hpp>
#include <type_traits>

TEST_CASE("[Graphics] sf::Text", runDisplayTests())
{
    SECTION("Type traits")
    {
        STATIC_CHECK(!std::is_constructible_v<sf::Text, sf::Font&&, sf::String, unsigned int>);
        STATIC_CHECK(std::is_copy_constructible_v<sf::Text>);
        STATIC_CHECK(std::is_copy_assignable_v<sf::Text>);
        STATIC_CHECK(std::is_nothrow_move_constructible_v<sf::Text>);
        STATIC_CHECK(std::is_nothrow_move_assignable_v<sf::Text>);
    }

    const auto fontPtr = std::make_shared<const sf::Font>();
    sf::Font   font;
    REQUIRE(font.loadFromFile("Graphics/tuffy.ttf"));

    SECTION("Construction")
    {
        SECTION("Font constructor with empty font")
        {
            const sf::Font emptyFont;
            const sf::Text text(emptyFont);
            CHECK(text.getString() == "");
            CHECK(&text.getFont() == &emptyFont);
            CHECK(text.getCharacterSize() == 30);
            CHECK(text.getLetterSpacing() == 1.f);
            CHECK(text.getLineSpacing() == 1.f);
            CHECK(text.getStyle() == sf::Text::Regular);
            CHECK(text.getFillColor() == sf::Color::White);
            CHECK(text.getOutlineColor() == sf::Color::Black);
            CHECK(text.getOutlineThickness() == 0);
            CHECK(text.findCharacterPos(0) == sf::Vector2f());
            CHECK(text.getLocalBounds() == sf::FloatRect());
            CHECK(text.getGlobalBounds() == sf::FloatRect());
        }

        SECTION("Font constructor")
        {
            const sf::Text text(font);
            CHECK(text.getString() == "");
            CHECK(&text.getFont() == &font);
            CHECK(text.getCharacterSize() == 30);
            CHECK(text.getLetterSpacing() == 1.f);
            CHECK(text.getLineSpacing() == 1.f);
            CHECK(text.getStyle() == sf::Text::Regular);
            CHECK(text.getFillColor() == sf::Color::White);
            CHECK(text.getOutlineColor() == sf::Color::Black);
            CHECK(text.getOutlineThickness() == 0);
            CHECK(text.findCharacterPos(0) == sf::Vector2f());
            CHECK(text.getLocalBounds() == sf::FloatRect());
            CHECK(text.getGlobalBounds() == sf::FloatRect());
        }

        SECTION("Font and string constructor")
        {
            const sf::Text text(font, "abcdefghijklmnopqrstuvwxyz");
            CHECK(text.getString() == "abcdefghijklmnopqrstuvwxyz");
            CHECK(&text.getFont() == &font);
            CHECK(text.getCharacterSize() == 30);
            CHECK(text.getLetterSpacing() == 1.f);
            CHECK(text.getLineSpacing() == 1.f);
            CHECK(text.getStyle() == sf::Text::Regular);
            CHECK(text.getFillColor() == sf::Color::White);
            CHECK(text.getOutlineColor() == sf::Color::Black);
            CHECK(text.getOutlineThickness() == 0);
            CHECK(text.findCharacterPos(0) == sf::Vector2f());
            CHECK(text.getLocalBounds() == sf::FloatRect({1, 8}, {357, 28}));
            CHECK(text.getGlobalBounds() == sf::FloatRect({1, 8}, {357, 28}));
        }

        SECTION("Font, string, and character size constructor")
        {
            SECTION("const Font&")
            {
                const sf::Text text(font, "abcdefghijklmnopqrstuvwxyz", 24);
                CHECK(text.getString() == "abcdefghijklmnopqrstuvwxyz");
                CHECK(&text.getFont() == &font);
                CHECK(text.getCharacterSize() == 24);
                CHECK(text.getLetterSpacing() == 1.f);
                CHECK(text.getLineSpacing() == 1.f);
                CHECK(text.getStyle() == sf::Text::Regular);
                CHECK(text.getFillColor() == sf::Color::White);
                CHECK(text.getOutlineColor() == sf::Color::Black);
                CHECK(text.getOutlineThickness() == 0);
                CHECK(text.findCharacterPos(0) == sf::Vector2f());
                CHECK(text.getLocalBounds() == sf::FloatRect({1, 7}, {290, 22}));
                CHECK(text.getGlobalBounds() == sf::FloatRect({1, 7}, {290, 22}));
            }

            SECTION("std::shared_ptr<const Font>")
            {
                const sf::Text text(fontPtr, "abcdefghijklmnopqrstuvwxyz", 24);
                CHECK(text.getString() == "abcdefghijklmnopqrstuvwxyz");
                CHECK(&text.getFont() == fontPtr.get());
                CHECK(text.getCharacterSize() == 24);
                CHECK(text.getLetterSpacing() == 1.f);
                CHECK(text.getLineSpacing() == 1.f);
                CHECK(text.getStyle() == sf::Text::Regular);
                CHECK(text.getFillColor() == sf::Color::White);
                CHECK(text.getOutlineColor() == sf::Color::Black);
                CHECK(text.getOutlineThickness() == 0);
                CHECK(text.findCharacterPos(0) == sf::Vector2f());
                CHECK(text.getLocalBounds() == sf::FloatRect({0, 24}, {0, 0}));
                CHECK(text.getGlobalBounds() == sf::FloatRect({0, 24}, {0, 0}));
            }
        }
    }

    SECTION("Set/get string")
    {
        sf::Text text(font);
        text.setString("abcdefghijklmnopqrstuvwxyz");
        CHECK(text.getString() == "abcdefghijklmnopqrstuvwxyz");
    }

    SECTION("Set/get font")
    {
        SECTION("const Font&")
        {
            sf::Text text(fontPtr);
            text.setFont(font);
            CHECK(&text.getFont() == &font);
        }

        SECTION("std::shared_ptr<const Font>")
        {
            sf::Text text(font);
            text.setFont(fontPtr);
            CHECK(&text.getFont() == fontPtr.get());
        }
    }

    SECTION("Set/get character size")
    {
        sf::Text text(font);
        text.setCharacterSize(48);
        CHECK(text.getCharacterSize() == 48);
    }

    SECTION("Set/get line spacing")
    {
        sf::Text text(font);
        text.setLineSpacing(42);
        CHECK(text.getLineSpacing() == 42);
    }

    SECTION("Set/get letter spacing")
    {
        sf::Text text(font);
        text.setLetterSpacing(15);
        CHECK(text.getLetterSpacing() == 15);
    }

    SECTION("Set/get style")
    {
        sf::Text text(font);
        text.setStyle(sf::Text::Bold | sf::Text::Italic);
        CHECK(text.getStyle() == (sf::Text::Bold | sf::Text::Italic));
    }

    SECTION("Set/get fill color")
    {
        sf::Text text(font, "Fill color");
        text.setFillColor(sf::Color::Red);
        CHECK(text.getFillColor() == sf::Color::Red);
    }

    SECTION("Set/get outline color")
    {
        sf::Text text(font, "Outline color");
        text.setOutlineColor(sf::Color::Green);
        CHECK(text.getOutlineColor() == sf::Color::Green);
    }

    SECTION("Set/get outline thickness")
    {
        sf::Text text(font);
        text.setOutlineThickness(3.14f);
        CHECK(text.getOutlineThickness() == 3.14f);
    }

    SECTION("findCharacterPos()")
    {
        sf::Text text(font, "\tabcdefghijklmnopqrstuvwxyz \n");
        text.setPosition({120, 240});
        CHECK(text.findCharacterPos(0) == sf::Vector2f(120, 240));
        CHECK(text.findCharacterPos(1) == sf::Vector2f(156, 240));
        CHECK(text.findCharacterPos(2) == sf::Vector2f(170, 240));
        CHECK(text.findCharacterPos(3) == sf::Vector2f(185, 240));
        CHECK(text.findCharacterPos(4) == sf::Vector2f(198, 240));

        // Indices that are too large are capped at maximum valid index
        CHECK(text.findCharacterPos(1'000) == sf::Vector2f(120, 277));
    }

    SECTION("Get bounds")
    {
        sf::Text text(font, "Test", 18);
        text.setPosition({100, 200});
        CHECK(text.getLocalBounds() == sf::FloatRect({1, 5}, {33, 13}));
        CHECK(text.getGlobalBounds() == sf::FloatRect({101, 205}, {33, 13}));

        SECTION("Add underline")
        {
            text.setStyle(sf::Text::Underlined);
            CHECK(text.getLocalBounds() == sf::FloatRect({1, 5}, {33, 13}));
            CHECK(text.getGlobalBounds() == sf::FloatRect({101, 205}, {33, 13}));
        }

        SECTION("Add strikethrough")
        {
            text.setStyle(sf::Text::StrikeThrough);
            CHECK(text.getLocalBounds() == sf::FloatRect({1, 5}, {33, 13}));
            CHECK(text.getGlobalBounds() == sf::FloatRect({101, 205}, {33, 13}));
        }

        SECTION("Change rotation")
        {
            text.setRotation(sf::degrees(180));
            CHECK(text.getLocalBounds() == sf::FloatRect({1, 5}, {33, 13}));
            CHECK(text.getGlobalBounds() == Approx(sf::FloatRect({66, 182}, {33, 13})));
        }
    }
}