SFML/test/TestUtilities/SystemUtil.hpp

// Header for SFML unit tests.
//
// For a new system module test case, include this header.
// This ensures that string conversions are visible and can be used by doctest for debug output.

#ifndef SFML_TESTUTILITIES_SYSTEM_HPP
#define SFML_TESTUTILITIES_SYSTEM_HPP

#include <SFML/System/Vector2.hpp>
#include <SFML/System/Vector3.hpp>

#include <iomanip>
#include <ostream>
#include <sstream>
#include <string>

// String conversions for doctest framework
namespace sf
{
    class Angle;
    class String;
    class Time;

    std::ostream& operator <<(std::ostream& os, const sf::Angle& angle);
    std::ostream& operator <<(std::ostream& os, const sf::String& string);
    std::ostream& operator <<(std::ostream& os, sf::Time time);

    template <typename T>
    std::ostream& operator <<(std::ostream& os, const sf::Vector2<T>& vector)
    {
        os << std::fixed << std::setprecision(std::numeric_limits<T>::max_digits10);
        os << "(" << vector.x << ", " << vector.y << ")";
        return os;
    }

    template <typename T>
    std::ostream& operator <<(std::ostream& os, const sf::Vector3<T>& vector)
    {
        os << "(" << vector.x << ", " << vector.y << ", " << vector.z << ")";
        return os;
    }
}

////////////////////////////////////////////////////////////
/// Class template for creating custom approximate comparisons.
/// To register a new type, simply implement a custom operator==
/// overload for that type.
////////////////////////////////////////////////////////////
template <typename T>
struct Approx
{
    explicit Approx(const T& t) : value(t) {}
    const T& value;
};

bool operator==(const float& lhs, const Approx<float>& rhs);
bool operator==(const sf::Vector2f& lhs, const Approx<sf::Vector2f>& rhs);
bool operator==(const sf::Vector3f& lhs, const Approx<sf::Vector3f>& rhs);
bool operator==(const sf::Angle& lhs, const Approx<sf::Angle>& rhs);

template <typename T>
std::ostream& operator <<(std::ostream& os, const Approx<T>& approx)
{
    return os << approx.value;
}

namespace sf::Testing
{
    class TemporaryFile
    {
    private:
        std::string m_path;

    public:
        // Create a temporary file with a randomly generated path, containing 'contents'.
        TemporaryFile(const std::string& contents);

        // Close and delete the generated file.
        ~TemporaryFile();

        // Prevent copies.
        TemporaryFile(const TemporaryFile&) = delete;
        TemporaryFile& operator=(const TemporaryFile&) = delete;

        // Return the randomly generated path.
        const std::string& getPath() const;
    };
}

#endif // SFML_TESTUTILITIES_SYSTEM_HPP