SDL3pp_thread.h

#ifndef SDL3PP_THREAD_H_
#define SDL3PP_THREAD_H_
 
#include <SDL3/SDL_thread.h>
#include "SDL3pp_atomic.h"
#include "SDL3pp_properties.h"
#include "SDL3pp_stdinc.h"
 
namespace SDL {

 
// Forward decl
struct Thread;

using ThreadRaw = SDL_Thread*;

using ThreadRef = ResourceRef<Thread>;

using ThreadPriority = SDL_ThreadPriority;
 
constexpr ThreadPriority THREAD_PRIORITY_LOW = SDL_THREAD_PRIORITY_LOW; 
 
constexpr ThreadPriority THREAD_PRIORITY_NORMAL =
  SDL_THREAD_PRIORITY_NORMAL; 
 
constexpr ThreadPriority THREAD_PRIORITY_HIGH =
  SDL_THREAD_PRIORITY_HIGH; 
 
constexpr ThreadPriority THREAD_PRIORITY_TIME_CRITICAL =
  SDL_THREAD_PRIORITY_TIME_CRITICAL; 

using ThreadState = SDL_ThreadState;
 
constexpr ThreadState THREAD_UNKNOWN =
  SDL_THREAD_UNKNOWN; 
 
constexpr ThreadState THREAD_ALIVE =
  SDL_THREAD_ALIVE; 
 
constexpr ThreadState THREAD_DETACHED =
  SDL_THREAD_DETACHED; 

constexpr ThreadState THREAD_COMPLETE = SDL_THREAD_COMPLETE;

using ThreadID = SDL_ThreadID;

using ThreadFunction = int(SDLCALL*)(void* data);

using ThreadCB = std::function<int()>;

using TLSDestructorCallback = void(SDLCALL*)(void* value);

struct Thread : ResourceBase<ThreadRaw>
{
  using ResourceBase::ResourceBase;

  constexpr explicit Thread(ThreadRaw resource) noexcept
    : ResourceBase(resource)
  {
  }

  constexpr Thread(const Thread& other) = delete;

  constexpr Thread(Thread&& other) noexcept
    : Thread(other.release())
  {
  }
 
  constexpr Thread(const ThreadRef& other) = delete;
 
  constexpr Thread(ThreadRef&& other) = delete;

  Thread(ThreadFunction fn, StringParam name, void* data);

  Thread(ThreadCB fn, StringParam name);

  Thread(PropertiesRef props);

  ~Thread() { SDL_DetachThread(get()); }

  constexpr Thread& operator=(Thread&& other) noexcept
  {
    swap(*this, other);
    return *this;
  }

  Thread& operator=(const Thread& other) = delete;

  void Detach();

  const char* GetName() const;

  ThreadID GetID() const;

  static void SetCurrentPriority(ThreadPriority priority);

  void Wait(int* status);

  ThreadState GetState() const;
};

using TLSID = AtomicInt;

inline Thread CreateThread(ThreadFunction fn, StringParam name, void* data)
{
  return Thread(fn, std::move(name), data);
}

inline Thread CreateThread(ThreadCB fn, StringParam name)
{
  return Thread(std::move(fn), std::move(name));
}
 
inline Thread::Thread(ThreadFunction fn, StringParam name, void* data)
  : Thread(CheckError(SDL_CreateThread(fn, name, data)))
{
}
 
inline Thread::Thread(ThreadCB fn, StringParam name)
  : Thread(&CallbackWrapper<ThreadCB>::CallOnce,
           std::move(name),
           CallbackWrapper<ThreadCB>::Wrap(std::move(fn)))
{
}
 
inline Thread::Thread(PropertiesRef props)
  : Thread(CheckError(SDL_CreateThreadWithProperties(props)))
{
}

inline Thread CreateThreadWithProperties(PropertiesRef props)
{
  return Thread(props);
}

namespace prop::thread {
 
constexpr auto CREATE_ENTRY_FUNCTION_POINTER =
  SDL_PROP_THREAD_CREATE_ENTRY_FUNCTION_POINTER;
 
constexpr auto CREATE_NAME_STRING = SDL_PROP_THREAD_CREATE_NAME_STRING;
 
constexpr auto CREATE_USERDATA_POINTER =
  SDL_PROP_THREAD_CREATE_USERDATA_POINTER;
 
constexpr auto CREATE_STACKSIZE_NUMBER =
  SDL_PROP_THREAD_CREATE_STACKSIZE_NUMBER;
 
} // namespace prop::thread

inline const char* GetThreadName(ThreadRef thread)
{
  return SDL_GetThreadName(thread);
}
 
inline const char* Thread::GetName() const { return SDL::GetThreadName(get()); }

inline ThreadID GetCurrentThreadID() { return SDL_GetCurrentThreadID(); }

inline ThreadID GetThreadID(ThreadRef thread)
{
  return SDL_GetThreadID(thread);
}
 
inline ThreadID Thread::GetID() const { return SDL::GetThreadID(get()); }

inline void SetCurrentThreadPriority(ThreadPriority priority)
{
  CheckError(SDL_SetCurrentThreadPriority(priority));
}
 
inline void Thread::SetCurrentPriority(ThreadPriority priority)
{
  SDL::SetCurrentThreadPriority(priority);
}

inline void WaitThread(ThreadRef thread, int* status)
{
  SDL_WaitThread(thread, status);
}
 
inline void Thread::Wait(int* status) { SDL::WaitThread(get(), status); }

inline ThreadState GetThreadState(ThreadRef thread)
{
  return SDL_GetThreadState(thread);
}
 
inline ThreadState Thread::GetState() const
{
  return SDL::GetThreadState(get());
}

inline void DetachThread(ThreadRaw thread) { SDL_DetachThread(thread); }
 
inline void Thread::Detach() { DetachThread(release()); }

inline void* GetTLS(TLSID* id) { return SDL_GetTLS(id); }

inline void SetTLS(TLSID* id,
                   const void* value,
                   TLSDestructorCallback destructor)
{
  CheckError(SDL_SetTLS(id, value, destructor));
}

inline void CleanupTLS() { SDL_CleanupTLS(); }

 
} // namespace SDL
 
#endif /* SDL3PP_THREAD_H_ */