system.h

/* Copyright (c) 2024 Julian Benda
 *
 * This file is part of inkCPP which is released under MIT license.
 * See file LICENSE.txt or go to
 * https://github.com/JBenda/inkcpp for full license details.
 */
#pragma once
 
#include "config.h"
 
#ifdef INK_ENABLE_UNREAL
#   include "Misc/AssertionMacros.h"
#   include "Misc/CString.h"
#   include "HAL/UnrealMemory.h"
#   include "Hash/CityHash.h"
#endif
#ifdef INK_ENABLE_STL
#   ifdef INK_ENABLE_EXCEPTIONS
#       include <exception>
#   endif
#   include <stdexcept>
#   include <optional>
#   include <cctype>
#   include <cstdint>
#endif
#ifdef INK_ENABLE_CSTD
#   include <cstdio>
#   include <cstdlib>
#   include <ctype.h>
#   include <cassert>
#endif
 
// Platform specific defines //
 
#ifdef INK_ENABLE_UNREAL
#   define inkZeroMemory(buff, len) FMemory::Memset(buff, 0, len)
#   define FORMAT_STRING_STR        "%hs"
#else
#   define inkZeroMemory     ink::internal::zero_memory
#   define FORMAT_STRING_STR "%s"
#endif

 
#ifdef INK_ENABLE_UNREAL
#   define inkAssert(condition, text, ...) checkf(condition, TEXT(text), ##__VA_ARGS__)
#   define inkFail(text, ...)              checkf(false, TEXT(text), ##__VA_ARGS__)
#else
#   define inkAssert(...) ink::ink_assert(__VA_ARGS__)
#   define inkFail(...)   ink::ink_assert(false, __VA_ARGS__)
#endif
 
 
namespace ink
{
typedef unsigned int uint32_t;
 
#ifndef INK_ENABLE_STL

typedef int   int32_t;
typedef short int16_t;

typedef unsigned long long uint64_t;
typedef unsigned short     uint16_t;
#endif // ndef INK_ENABLE_STL

typedef uint32_t hash_t;

const hash_t InvalidHash = 0;
 

typedef unsigned char byte_t;

typedef decltype(static_cast<int*>(nullptr) - static_cast<int*>(nullptr)) ptrdiff_t;

static_assert(sizeof(byte_t) == 1);
static_assert(sizeof(uint16_t) == 2);
static_assert(sizeof(int16_t) == 2);
static_assert(sizeof(uint32_t) == 4);
static_assert(sizeof(int32_t) == 4);
static_assert(sizeof(uint64_t) == 8);
static_assert(sizeof(ptrdiff_t) == sizeof(void*));

typedef uint32_t offset_t;

typedef const unsigned char* ip_t;

typedef unsigned int size_t;

typedef uint32_t container_t;

typedef uint32_t thread_t;

struct list_flag {
    int16_t list_id;
    int16_t flag;
 
    bool operator==(const list_flag& o) const { return list_id == o.list_id && flag == o.flag; }
 
    bool operator!=(const list_flag& o) const { return ! (*this == o); }
};

constexpr list_flag null_flag{-1, -1};
constexpr list_flag empty_flag{-1, 0};
 
#ifdef INK_ENABLE_UNREAL
inline hash_t hash_string(const char* string)
{
    return CityHash32(string, FCStringAnsi::Strlen(string));
}

inline hash_t hash_data(const unsigned char* data, size_t len)
{
    return CityHash32(reinterpret_cast<const char*>(data), len);
}
#else
hash_t hash_string(const char* string);
hash_t hash_data(const unsigned char* data, size_t len);
#endif
 
namespace internal
{
#ifdef __GNUC__
#else
#   pragma warning(push)
// functions are defined in header file, they do not need to be used.
#   pragma warning(disable : 4514)
#endif
    static inline constexpr bool starts_with(const char* string, const char* prefix)
    {
        while (*prefix) {
            if (*string != *prefix) {
                return false;
            }
            string++;
            prefix++;
        }
        return true;
    }

    static inline constexpr bool is_whitespace(const char* string, bool includeNewline = true)
    {
        // Iterate string
        while (true) {
            switch (*(string++)) {
                case 0: return true;
                case '\f': [[fallthrough]];
                case '\r': [[fallthrough]];
                case '\n':
                    if (! includeNewline)
                        return false;
                    [[fallthrough]];
                case '\t': [[fallthrough]];
                case '\v': [[fallthrough]];
                case ' ': continue;
                default: return false;
            }
        }
    }
 
    inline bool is_part_of_word(char character) { return isalpha(character) || isdigit(character); }
 
    static inline constexpr bool is_whitespace(char character, bool includeNewline = true)
    {
        switch (character) {
            case '\n':
                if (! includeNewline)
                    return false;
            case '\t': [[fallthrough]];
            case ' ': return true;
            default: return false;
        }
    }
 
#ifndef INK_ENABLE_UNREAL
    void zero_memory(void* buffer, size_t length);
#endif
#ifdef __GNUC__
#else
#   pragma warning(pop)
#endif
} // namespace internal
 
#ifdef INK_ENABLE_STL
using ink_exception = std::runtime_error;
#else
// Non-STL exception class
class ink_exception
{
public:
    ink_exception(const char* msg)
        : _msg(msg)
    {
    }
 
    inline const char* message() const { return _msg; }
 
private:
    const char* _msg;
};
#endif
 
#ifdef __GNUC__
#   pragma GCC diagnostic push
#   pragma GCC diagnostic ignored "-Wunused-parameter"
#else
#   pragma warning(push)
// dependend on rtti, exception and stl support not all arguments are needed
#   pragma warning(disable : 4100)
#endif
template<typename... Args>
void ink_assert(bool condition, const char* msg = nullptr, Args... args)
{
    static const char* EMPTY = "";
    if (msg == nullptr) {
        msg = EMPTY;
    }
    if (! condition) {
#if defined(INK_ENABLE_STL) || defined(INK_ENABLE_CSTD)
        if constexpr (sizeof...(args) > 0) {
            size_t size    = snprintf(nullptr, 0, msg, args...) + 1;
            char*  message = static_cast<char*>(malloc(size));
            snprintf(message, size, msg, args...);
            msg = message;
        }
#endif
#ifdef INK_ENABLE_EXCEPTIONS
        throw ink_exception(msg);
#elif defined(INK_ENABLE_CSTD)
        fprintf(stderr, "Ink Assert: %s\n", msg);
        abort();
#elif defined(INK_ENABLE_UNREAL)
        // TODO: implement UE exception handling
#else
#   warning no assertion handling this could lead to invalid code paths
#endif
    }
}
#ifdef __GNUC__
#   pragma GCC diagnostic pop
#else
#   pragma warning(pop)
#endif

template<typename... Args>
[[noreturn]] inline void ink_assert(const char* msg = nullptr, Args... args)
{
    ink_assert(false, msg, args...);
#ifdef INK_ENABLE_CSTD
    exit(EXIT_FAILURE);
#endif
}
 
namespace runtime::internal
{
    constexpr unsigned abs(int i) { return static_cast<unsigned>(i < 0 ? -i : i); }
 
    template<typename T>
    struct always_false {
        static constexpr bool value = false;
    };
 
    template<bool Con, typename T1, typename T2>
    struct if_type {
        using type = T1;
    };
 
    template<typename T1, typename T2>
    struct if_type<false, T1, T2> {
        using type = T2;
    };
 
    template<bool Con, typename T1, typename T2>
    using if_t = typename if_type<Con, T1, T2>::type;
 
    template<bool Enable, typename T = void>
    struct enable_if {
    };
 
    template<typename T>
    struct enable_if<true, T> {
        using type = T;
    };
 
    template<bool Enable, typename T = void>
    using enable_if_t = typename enable_if<Enable, T>::type;
} // namespace runtime::internal
 
 
#ifdef INK_ENABLE_STL
template<typename T>
using optional                   = std::optional<T>;
constexpr std::nullopt_t nullopt = std::nullopt;
#else
struct nullopt_t {
};
 
constexpr nullopt_t nullopt;
 
template<typename T>
class optional
{
public:
    optional() {}
 
    optional(nullopt_t) {}
 
    optional(T&& val)
        : _has_value{true}
        , _value{val}
    {
    }
 
    optional(const T& val)
        : _has_value{true}
        , _value{val}
    {
    }
 
    const T& operator*() const { return value(); }
 
    T& operator*() { return value(); }
 
    const T* operator->() const { return &value(); }
 
    T* operator->() { return &value(); }
 
    constexpr bool has_value() const { return _has_value; }
 
    constexpr T& value()
    {
        test_value();
        return _value;
    }
 
    constexpr const T& value() const
    {
        test_value();
        return _value;
    }
 
    constexpr operator bool() const { return has_value(); }
 
    template<typename U>
    constexpr T value_or(U&& u) const
    {
        return _has_value ? _value : static_cast<T>(u);
    }
 
    template<typename... Args>
    T& emplace(Args... args)
    {
        if (_has_value)
            _value.~T();
 
        new (&_value) T(args...);
        _has_value = true;
        return _value;
    }
 
private:
    void test_value() const
    {
        if (! _has_value) {
            inkFail("Can't access empty optional!");
        }
    }
 
    bool _has_value = false;
    T    _value;
};
#endif
} // namespace ink