xosoperation.h

//
//  xosoperation.h
//  general os dependent operations
//
//  Created by Mootools on 20/05/2016.
//  Copyright © 2016 Mootools. All rights reserved.
//
 
#ifndef xosoperation_h
#define xosoperation_h
 
BEGIN_MOOTOOLS_NAMESPACE
 
// thread
#ifdef __WINDOWS__
typedef HANDLE xThreadHandle;
typedef longuint xThreadID;
#elif defined(__APPLE__)
typedef pthread_t xThreadHandle;
typedef longuint xThreadID;
#elif defined(__LINUX__)
typedef pthread_t xThreadHandle;
typedef pthread_t xThreadID; // Same things than xThreadHandle
#endif
 
typedef bool (*XTHREADPROC)(void *);
 
#define XTHREAD_UNDEFINED_ID 0
 
typedef enum
{
    XTHREAD_DEFAULT = 0,
    XTHREAD_SUSPENDED = 0x01, // Thread should be started manually
    XTHREAD_PREVENT_AUTODELETE = 0x02, // The thread object is not destroyed, unless it fails to init. This can be used when thread is embedded in a C++ object
 
    // Private flags,
    XTHREAD_RUNNING_HANDLE = 0x100, // Set when thread handle is running. If not set, the thread is considered as finished and is in exiting phase
} xThreadFlags;
 
typedef enum
{
    XTHREAD_PRIORITY_UNKNOWN = 0,
    XTHREAD_PRIORITY_LOWEST,
    XTHREAD_PRIORITY_LOW,
    XTHREAD_PRIORITY_NORMAL,
    XTHREAD_PRIORITY_HIGH,
    XTHREAD_PRIORITY_HIGHEST,
} xThreadPriority;
 
typedef struct xThreadContext
{
    xThreadHandle handle;
    unsigned int flags;
    xThreadPriority priority;
    xThreadID id;
} xThreadContext;
 
xThreadID xThreadGetCurrentID();
void xThreadSleepCurrentThread(unsigned int milliSeconds);
bool xThreadOpen(xThreadContext& threadCtxt, XTHREADPROC threadCallback, void *threadData, xThreadPriority priority, unsigned int flags, SIZET stacksize);
bool xThreadClose(xThreadContext& threadCtxt);
bool xThreadIsValid(const xThreadContext& threadCtxt);
bool xThreadIsSuspended(const xThreadContext& threadCtxt);
bool xThreadResume(xThreadContext& threadCtxt);
bool xThreadSuspend(xThreadContext& threadCtxt);
bool xThreadSetPriority(xThreadContext& threadCtxt, xThreadPriority priority);
bool xThreadTerminate(xThreadID threadID); // Terminates hardly the thread. Return false if not possible, true if possible and succeed
bool xThreadTerminate(xThreadHandle threadHandle); // Terminates hardly the thread. Return false if not possible, true if possible and succeed
#ifdef _DEBUG
DLL_TOOLSFUNCTION void xThreadSetName(xThreadID threadID, const char* threadName); // Set a thread name, if possible for debugging purpose
#endif
 
// Critical section & locks
bool xInitCriticalSection(xCriticalSection& section);
bool xDeleteCriticalSection(xCriticalSection& section);
bool xLockCriticalSection(xCriticalSection& section);
bool xUnlockCriticalSection(xCriticalSection& section);
 
bool xGetLastOSErrorString(CXString& errorMessage); // return true if OS can provide a textual information on the last error, and then errorMessage is filled with that error. false if the feature is not supported by the OS
 
#ifdef _DEBUG
// Debug
void xDebugOutputString(const CXString& string);
void xDebugBreakSignal();
#endif
 
END_MOOTOOLS_NAMESPACE
 
#endif /* xosoperation_h */