Global.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2026 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_GLOBAL_HPP
#define TGUI_GLOBAL_HPP

 
#include <TGUI/Config.hpp>
 
#include <TGUI/Duration.hpp>
#include <TGUI/Exception.hpp>
#include <TGUI/Filesystem.hpp>
#include <TGUI/Font.hpp>
#include <TGUI/String.hpp>
 
#include <cstdint>
#include <memory>


namespace tgui
{
#if defined(__cpp_lib_smart_ptr_for_overwrite) && (__cpp_lib_smart_ptr_for_overwrite >= 202002L)
    template <typename T>
    const auto MakeUniqueForOverwrite = std::make_unique_for_overwrite<T>;
#else
    template <typename T>
    [[nodiscard]] std::unique_ptr<T> MakeUniqueForOverwrite(const std::size_t size)
    {
        return std::unique_ptr<T>(new typename std::remove_extent_t<T>[size]);
    }
#endif
 
    template <typename T>
    TGUI_DEPRECATED("Use std::clamp instead")
    [[nodiscard]] constexpr const T& clamp(const T& v, const T& lo, const T& hi)
    {
        return std::clamp(v, lo, hi);
    }

    TGUI_API void setTextInputUsesTextCursorByDefault(bool useIBeam);

    [[nodiscard]] TGUI_API bool getTextInputUsesTextCursorByDefault();

    TGUI_API void setGlobalTextSize(unsigned int textSize);

    [[nodiscard]] TGUI_API unsigned int getGlobalTextSize();

    TGUI_API void setDoubleClickTime(Duration duration);

    [[nodiscard]] TGUI_API Duration getDoubleClickTime();

    TGUI_API void setResourcePath(const Filesystem::Path& path);

    TGUI_API void setResourcePath(const String& path);

    [[nodiscard]] TGUI_API const Filesystem::Path& getResourcePath();

    TGUI_API void setEditCursorBlinkRate(Duration blinkRate);

    [[nodiscard]] TGUI_API Duration getEditCursorBlinkRate();

    [[nodiscard]] TGUI_API std::unique_ptr<std::uint8_t[]> readFileToMemory(const String& filename, std::size_t& fileSize);

    TGUI_API bool writeFile(const String& filename, const std::stringstream& textToWrite);

    TGUI_API bool writeFile(const String& filename, CharStringView textToWrite);

    template <typename To, typename From>
    To downcast(From& base)
    {
        TGUI_ASSERT(dynamic_cast<std::remove_reference_t<To>*>(&base), "Downcasting to wrong type");
        return static_cast<To>(base);
    }

    template <typename To, typename From>
    To downcast(From* base)
    {
        TGUI_ASSERT(dynamic_cast<To>(base), "Downcasting to wrong type");
        return static_cast<To>(base);
    }

    template <typename To, typename From>
    std::shared_ptr<To> downcast(std::shared_ptr<From> base)
    {
        TGUI_ASSERT(std::dynamic_pointer_cast<To>(base), "Downcasting to wrong type");
        return std::static_pointer_cast<To>(base);
    }

} // namespace tgui

 
#endif // TGUI_GLOBAL_HPP