fxdefs.h

/********************************************************************************
*                                                                               *
*                     FOX Definitions, Types, and Macros                        *
*                                                                               *
*********************************************************************************
* Copyright (C) 1997,2024 by Jeroen van der Zijp.   All Rights Reserved.        *
*********************************************************************************
* This library is free software; you can redistribute it and/or modify          *
* it under the terms of the GNU Lesser General Public License as published by   *
* the Free Software Foundation; either version 3 of the License, or             *
* (at your option) any later version.                                           *
*                                                                               *
* This library is distributed in the hope that it will be useful,               *
* but WITHOUT ANY WARRANTY; without even the implied warranty of                *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                 *
* GNU Lesser General Public License for more details.                           *
*                                                                               *
* You should have received a copy of the GNU Lesser General Public License      *
* along with this program.  If not, see <http://www.gnu.org/licenses/>          *
********************************************************************************/
#ifndef FXDEFS_H
#define FXDEFS_H



/********************************  Definitions  ********************************/

// Placement new
#include <new>


// Path separator
#ifdef WIN32
#define PATHSEP '\\'
#define PATHSEPSTRING "\\"
#define PATHLISTSEP ';'
#define PATHLISTSEPSTRING ";"
#define ISPATHSEP(c) ((c)=='\\' || (c)=='/')
#else
#define PATHSEP '/'
#define PATHSEPSTRING "/"
#define PATHLISTSEP ':'
#define PATHLISTSEPSTRING ":"
#define ISPATHSEP(c) ((c)=='/')
#endif


// End Of Line
#ifdef WIN32
#define ENDLINE "\r\n"
#else
#define ENDLINE "\n"
#endif


// FOX_BIGENDIAN is byte order 
#if defined(__BYTE_ORDER__) && defined(__ORDER_LITTLE_ENDIAN__) && (__BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__)
#define FOX_BIGENDIAN 0
#elif defined(__BYTE_ORDER__) && defined(__ORDER_BIG_ENDIAN__) && (__BYTE_ORDER__ == __ORDER_BIG_ENDIAN__)
#define FOX_BIGENDIAN 1
#elif defined(__BYTE_ORDER__) && defined(__ORDER_PDP_ENDIAN__) && (__BYTE_ORDER__ == __ORDER_PDP_ENDIAN__)
#error "FOX_BIGENDIAN: does not support PDP endianness!"
#elif defined(__LITTLE_ENDIAN__) || defined(__LITTLE_ENDIAN)
#define FOX_BIGENDIAN 0
#elif defined(__BIG_ENDIAN__) || defined(__BIG_ENDIAN)
#define FOX_BIGENDIAN 1
#elif defined(_MSC_VER) || defined(__i386__) || defined(__x86_64__)
#define FOX_BIGENDIAN 0
#else
#error "FOX_BIGENDIAN: endianness could not be determined!"
#endif


// Shared library support
#ifdef WIN32
#if defined(__GNUC__)
#define FXLOCAL
#define FXEXPORT __attribute__ ((dllexport))
#define FXIMPORT __attribute__ ((dllimport))
#else
#define FXLOCAL
#define FXEXPORT __declspec(dllexport)
#define FXIMPORT __declspec(dllimport)
#endif
#else
#if defined(__GNUC__) && (__GNUC__ >= 4)
#define FXLOCAL  __attribute__((visibility("hidden")))
#define FXEXPORT __attribute__((visibility("default")))
#define FXIMPORT __attribute__((visibility("default")))
#else
#define FXLOCAL
#define FXEXPORT
#define FXIMPORT
#endif
#endif


// Define FXAPI for DLL builds
#ifdef FOXDLL
#ifdef FOXDLL_EXPORTS
#define FXAPI FXEXPORT
#define FXTEMPLATE_EXTERN
#else
#define FXAPI FXIMPORT
#define FXTEMPLATE_EXTERN extern
#endif
#else
#define FXAPI
#define FXTEMPLATE_EXTERN
#endif

// Flag old API as deprecated
#if defined(_MSC_VER) && defined(_WIN32)
#define FXDEPRECATED __declspec(deprecated)
#elif defined(__GNUC__)
#define FXDEPRECATED __attribute__((deprecated))
#else
#define FXDEPRECATED
#endif

// Data alignment attribute
#if defined(__GNUC__)
#define __align(x)    __attribute__((aligned(x)))
#elif defined(_MSC_VER)
#define __align(x)    __declspec(align(x))
#else
#define __align(x)
#endif

// Get alignment of pointer p to b=2^n bytes, returning 0..b-1
#define __alignment(p,b)   (((FXival)(p))&((b)-1))

// Check if pointer p is aligned to b=2^n bytes
#define __isaligned(p,b)   (__alignment(p,b)==0)

// Align pointer to b=2^n bytes
#define __alignto(p,b)     ((void*)((((FXival)(p))+((FXival)((b)-1)))&~((FXival)((b)-1))))


// Thread-local storage attribute
#if defined(__GNUC__)
#define __threadlocal   __thread
#elif defined(_MSC_VER)
#define __threadlocal   __declspec(thread)
#else
#define __threadlocal
#endif

// Non-returning function
#if defined(__GNUC__)
#define __noreturn      __attribute__((__noreturn__))
#elif (_MSC_VER >= 1400)
#define __noreturn      __declspec(noreturn)
#else
#define __noreturn
#endif

// Branch prediction optimization
#if (__GNUC__ >= 3)
#define __likely(cond)    __builtin_expect(!!(cond),1)
#define __unlikely(cond)  __builtin_expect(!!(cond),0)
#else
#define __likely(cond)    (!!(cond))
#define __unlikely(cond)  (!!(cond))
#endif

// An assumption that compiler may use to optimize
#if (__GNUC__ >= 13)
#define __assume(expr)  __attribute__((__assume__(expr)))
#elif (__clang__ >= 14)
#define __assume(expr)  __builtin_assume(expr)
#elif !defined(_MSC_VER)
#define __assume(expr)
#endif

// An unreachable part of code may be optimized away
#if (__GNUC__ >= 4)
#define __unreachable()    __builtin_unreachable()
#elif defined(_MSC_VER)
#define __unreachable()    __assume(false)
#else
#define __unreachable()
#endif

// Define parameters not-aliased hint
#if defined(__GNUC__)
#define __restrict  __restrict__
#elif !defined(_MSC_VER)
#define __restrict
#endif

// Prefetch address
#if (__GNUC__ >= 4) && (defined(__i386__) || defined(__x86_64__))
#define __prefetch(addr)   __builtin_prefetch((addr),0)
#define __prefetchw(addr)  __builtin_prefetch((addr),1)
#else
#define __prefetch(addr)
#define __prefetchw(addr)
#endif

// Standard call calling sequence
#ifdef WIN32
#ifndef CALLBACK
#define CALLBACK __stdcall
#endif
#endif

// C Language calling sequence
#ifdef WIN32
#ifndef CDECL
#define CDECL __cdecl
#endif
#else
#ifndef CDECL
#define CDECL
#endif
#endif

// Suppress unused parameter warnings
#define FXUNUSED(prm) (void)(prm)

// Checking printf and scanf format strings
#if defined(_CC_GNU_) || defined(__GNUG__) || defined(__GNUC__)
#define FX_PRINTF(fmt,arg) __attribute__((format(printf,fmt,arg)))
#define FX_SCANF(fmt,arg)  __attribute__((format(scanf,fmt,arg)))
#define FX_FORMAT(arg) __attribute__((format_arg(arg)))
#else
#define FX_PRINTF(fmt,arg)
#define FX_SCANF(fmt,arg)
#define FX_FORMAT(arg)
#endif

// Word size issues
#if defined(_MSC_VER) || defined(__MINGW32__) // Windows
#if defined(_WIN64)
#define LLP64  1                // Long longs and pointers are 64 bit
#else
#define ILP32  1                // Ints, longs, and pointers are 32 bit
#endif
#elif defined(__LP64__) || defined(_LP64) || (_MIPS_SZLONG == 64) || (__WORDSIZE == 64)
#define LP64   1                // Longs and pointers are 64 bit
#else
#define ILP32  1                // Longs, integers, and pointers are 32 bit
#endif

// Suffixes for 64-bit constants
#if defined(LP64)
#define FXLONG(c)  c ## L       // Long suffix for 64 bit
#define FXULONG(c) c ## UL
#elif defined(_MSC_VER) && (_MSC_VER < 1900)
#define FXLONG(c)  c ## i64     // Special suffix for 64 bit
#define FXULONG(c) c ## ui64
#else
#define FXLONG(c)  c ## LL      // Long long suffix for 64 bit
#define FXULONG(c) c ## ULL
#endif


// Raw event type
#ifdef WIN32
struct tagMSG;
#else
union _XEvent;
#endif


namespace FX {


/*********************************  Typedefs  **********************************/

// Forward declarations
class   FXObject;
class   FXStream;
class   FXString;


// Streamable types; these are fixed size!
typedef char                    FXchar;
typedef signed char             FXschar;
typedef unsigned char           FXuchar;
typedef bool                    FXbool;
typedef unsigned short          FXushort;
typedef short                   FXshort;
typedef unsigned int            FXuint;
typedef int                     FXint;
typedef float                   FXfloat;
typedef double                  FXdouble;
#if defined(WIN32)
typedef unsigned int            FXwchar;
#if defined(_MSC_VER) && !defined(_NATIVE_WCHAR_T_DEFINED)
typedef unsigned short          FXnchar;
#elif defined(__WATCOMC__) && !defined(_WCHAR_T_DEFINED)
typedef long char               FXnchar;
#else
typedef wchar_t                 FXnchar;
#endif
#else
typedef wchar_t                 FXwchar;
typedef unsigned short          FXnchar;
#endif
#if defined(LP64)
typedef long                    FXlong;
typedef unsigned long           FXulong;
#elif defined(_MSC_VER) && (_MSC_VER < 1900)
typedef __int64                 FXlong;
typedef unsigned __int64        FXulong;
#else
typedef long long               FXlong;
typedef unsigned long long      FXulong;
#endif

// Integral types large enough to hold value of a pointer
#if defined(LP64) || defined(ILP32)     // Long for LP64 and ILP32 models
typedef long                    FXival;
typedef unsigned long           FXuval;
#elif defined(LLP64)                    // Long long for LLP64 models
#if defined(_MSC_VER) && (_MSC_VER < 1900)
typedef __int64                 FXival;
typedef unsigned __int64        FXuval;
#else
typedef long long               FXival;
typedef unsigned long long      FXuval;
#endif
#endif

// Generic void pointer
typedef void*                   FXptr;


// Handle to something in server
#ifdef WIN32
typedef void*                   FXID;
#else
typedef unsigned long           FXID;
#endif

// Time since January 1, 1970 (UTC)
typedef FXlong                  FXTime;

// Pixel type (could be color index)
typedef unsigned long           FXPixel;

// RGBA pixel value
typedef FXuint                  FXColor;

// Hot key
typedef FXuint                  FXHotKey;

// Input source handle type
#ifdef WIN32
typedef void*                   FXInputHandle;
#else
typedef FXint                   FXInputHandle;
#endif

// Process handle
#if defined(WIN32)
typedef void*                   FXProcessID;
#else
typedef int                     FXProcessID;
#endif

// Thread ID type
#if defined(WIN32)
typedef void*                   FXThreadID;
#else
typedef unsigned long           FXThreadID;
#endif

// Thread-local storage key
typedef FXuval                  FXThreadStorageKey;

// Raw event type
#ifdef WIN32
typedef tagMSG                  FXRawEvent;
#else
typedef _XEvent                 FXRawEvent;
#endif


// Drag and drop data type
#ifdef WIN32
typedef FXushort                FXDragType;
#else
typedef FXID                    FXDragType;
#endif


// Third logic state: unknown/indeterminate
enum { maybe=2 };

// A time in the far, far future
const FXTime forever=FXLONG(9223372036854775807);

// Search modes for search/replace dialogs
enum {
  SEARCH_BACKWARD   = 1,        
  SEARCH_FORWARD    = 2,        
  SEARCH_NOWRAP     = 0,        
  SEARCH_WRAP       = 4,        
  SEARCH_EXACT      = 0,        
  SEARCH_IGNORECASE = 8,        
  SEARCH_REGEX      = 16,       
  SEARCH_PREFIX     = 32,       
  SEARCH_SUFFIX     = 64,       
  SEARCH_WORDS      = 128       
  };

/**********************************  Macros  ***********************************/

#define FXBIT(val,b)       (((val)>>(b))&1)

#define FXABS(val)         (((val)>=0)?(val):-(val))

#define FXSGN(val)         (((val)<0)?-1:1)

#define FXSGNZ(val)        ((val)<0?-1:(val)>0?1:0)

#define FXSGNX(x,b)        (((FXint)((x)<<(32-(b))))>>(32-(b)))

#define FXMAX(a,b)         (((a)>(b))?(a):(b))

#define FXMIN(a,b)         (((a)>(b))?(b):(a))

#define FXMIN3(x,y,z)      ((x)<(y)?FXMIN(x,z):FXMIN(y,z))

#define FXMAX3(x,y,z)      ((x)>(y)?FXMAX(x,z):FXMAX(y,z))

#define FXMIN4(x,y,z,w)    (FXMIN(FXMIN(x,y),FXMIN(z,w)))

#define FXMAX4(x,y,z,w)    (FXMAX(FXMAX(x,y),FXMAX(z,w)))

#define FXMINMAX(lo,hi,a,b) ((a)<(b)?((lo)=(a),(hi)=(b)):((lo)=(b),(hi)=(a)))

#define FXCLAMP(lo,x,hi)   ((x)<(lo)?(lo):((x)>(hi)?(hi):(x)))

#define FXSWAP(a,b,t)      ((t)=(a),(a)=(b),(b)=(t))

#define FXLERP(a,b,f)      ((a)+((b)-(a))*(f))

#define ARRAYNUMBER(array) (sizeof(array)/sizeof(array[0]))

// Offset of member in a structure
#define STRUCTOFFSET(str,member) ((FXival)&(((str *)0)->member))

// Container class of a member class
#define CONTAINER(ptr,str,mem) ((str*)(((FXival)(ptr))-STRUCTOFFSET(str,mem)))

#define MKUINT(l,h)        ((((FX::FXuint)(l))&0xffff) | (((FX::FXuint)(h))<<16))

#define FXSEL(type,id)     ((((FX::FXuint)(id))&0xffff) | (((FX::FXuint)(type))<<16))

#define FXSELTYPE(s)       ((FX::FXushort)(((s)>>16)&0xffff))

#define FXSELID(s)         ((FX::FXushort)((s)&0xffff))

#define FXAVGCOLOR(ca,cb)  (((ca)&(cb))+((((ca)^(cb))&0xFEFEFEFE)>>1))


// Definitions for big-endian machines
#if (FOX_BIGENDIAN == 1)

#define FXRGBA(r,g,b,a)    (((FX::FXuint)(FX::FXuchar)(a)) | ((FX::FXuint)(FX::FXuchar)(r)<<8) | ((FX::FXuint)(FX::FXuchar)(g)<<16) | ((FX::FXuint)(FX::FXuchar)(b)<<24))

#define FXRGB(r,g,b)       (((FX::FXuint)(FX::FXuchar)(r)<<8) | ((FX::FXuint)(FX::FXuchar)(g)<<16) | ((FX::FXuint)(FX::FXuchar)(b)<<24) | 0x000000ff)

#define FXREDVAL(rgba)     ((FX::FXuchar)(((rgba)>>8)&0xff))

#define FXGREENVAL(rgba)   ((FX::FXuchar)(((rgba)>>16)&0xff))

#define FXBLUEVAL(rgba)    ((FX::FXuchar)(((rgba)>>24)&0xff))

#define FXALPHAVAL(rgba)   ((FX::FXuchar)((rgba)&0xff))

#define FXRGBACOMPVAL(rgba,comp) ((FX::FXuchar)(((rgba)>>((comp)<<3))&0xff))

#define FXCOLORREF2RGB(ref) (FX::FXuint)((((ref)<<8)&0xff000000) | (((ref)<<8)&0xff0000) | (((ref)<<8)&0xff00) | 0x000000ff)

#define FXRGB2COLORREF(rgb) (FX::FXuint)((((rgb)>>8)&0xff0000) | (((rgb)>>8)&0xff00) | (((rgb)>>8)&0xff))

#endif


// Definitions for little-endian machines
#if (FOX_BIGENDIAN == 0)

#define FXRGBA(r,g,b,a)    (((FX::FXuint)(FX::FXuchar)(a)<<24) | ((FX::FXuint)(FX::FXuchar)(r)<<16) | ((FX::FXuint)(FX::FXuchar)(g)<<8) | ((FX::FXuint)(FX::FXuchar)(b)))

#define FXRGB(r,g,b)       (((FX::FXuint)(FX::FXuchar)(r)<<16) | ((FX::FXuint)(FX::FXuchar)(g)<<8) | ((FX::FXuint)(FX::FXuchar)(b)) | 0xff000000)

#define FXREDVAL(rgba)     ((FX::FXuchar)(((rgba)>>16)&0xff))

#define FXGREENVAL(rgba)   ((FX::FXuchar)(((rgba)>>8)&0xff))

#define FXBLUEVAL(rgba)    ((FX::FXuchar)((rgba)&0xff))

#define FXALPHAVAL(rgba)   ((FX::FXuchar)(((rgba)>>24)&0xff))

#define FXRGBACOMPVAL(rgba,comp) ((FX::FXuchar)(((rgba)>>((3-(comp))<<3))&0xff))

#define FXCOLORREF2RGB(ref) (FX::FXuint)((((ref)>>16)&0xff) | ((ref)&0xff00) | (((ref)<<16)&0xff0000) | 0xff000000)

#define FXRGB2COLORREF(rgb) (FX::FXuint)((((rgb)<<16)&0xff0000) | ((rgb)&0xff00) | (((rgb)>>16)&0xff))

#endif

#ifndef NDEBUG
#define FXASSERT(exp) (__likely(exp)?((void)0):(void)FX::fxassert(#exp,__FILE__,__LINE__))
#else
#define FXASSERT(exp) ((void)0)
#endif


#ifndef NDEBUG
#define FXVERIFY(exp) (__likely(exp)?((void)0):(void)FX::fxverify(#exp,__FILE__,__LINE__))
#else
#define FXVERIFY(exp) ((void)(exp))
#endif


#if (defined(__cplusplus) && (__cplusplus >= 201103L)) || (defined(_MSC_VER) && (_MSC_VER >= 1600))
#define FXASSERT_STATIC(expr) static_assert(expr,#expr)
#else
#define FXASSERT_STATIC(expr) FXASSERT(expr)
#endif


#define VA_NUM_ARGS(...) VA_NUM_ARGS_IMPL(__VA_ARGS__,32,31,30,29,28,27,26,25,24,23,22,21,20,19,18,17,16,15,14,13,12,11,10,9,8,7,6,5,4,3,2,1)
#define VA_NUM_ARGS_IMPL(_0,_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,_11,_12,_13,_14,_15,_16,_17,_18,_19,_20_21,_22,_23,_24,_25,_26,_27,_28,_29,_30,_31,_32,N,...) N


#ifndef NDEBUG
#define FXTRACE(arguments) FX::fxtrace arguments
#else
#define FXTRACE(arguments) ((void)0)
#endif

#define FXMALLOC(ptr,type,no)     (FX::fxmalloc((void **)(ptr),sizeof(type)*(no)))

#define FXCALLOC(ptr,type,no)     (FX::fxcalloc((void **)(ptr),sizeof(type)*(no)))

#define FXRESIZE(ptr,type,no)     (FX::fxresize((void **)(ptr),sizeof(type)*(no)))

#define FXMEMDUP(ptr,src,type,no) (FX::fxmemdup((void **)(ptr),(const void*)(src),sizeof(type)*(no)))

#define FXFREE(ptr)               (FX::fxfree((void **)(ptr)))

/**********************************  Globals  **********************************/

template <typename to_type>
static inline to_type* alias_cast(void* ptr){
  union UNI { to_type dst[1]; };
  return reinterpret_cast<UNI*>(ptr)->dst;
  }

template <typename to_type>
static inline const to_type* alias_cast(const void* ptr){
  union UNI { to_type dst[1]; };
  return reinterpret_cast<const UNI*>(ptr)->dst;
  }

extern FXAPI FXbool fxmalloc(void** ptr,FXuval size);

extern FXAPI FXbool fxcalloc(void** ptr,FXuval size);

extern FXAPI FXbool fxresize(void** ptr,FXuval size);

extern FXAPI void fxfree(void** ptr);

extern FXAPI FXbool fxmemdup(void** ptr,const void* src,FXuval size);

extern FXAPI __noreturn void fxerror(const FXchar* format,...) FX_PRINTF(1,2) ;

extern FXAPI void fxwarning(const FXchar* format,...) FX_PRINTF(1,2) ;

extern FXAPI void fxmessage(const FXchar* format,...) FX_PRINTF(1,2) ;

extern FXAPI void fxassert(const FXchar* expression,const FXchar* filename,unsigned int lineno);

extern FXAPI void fxverify(const FXchar* expression,const FXchar* filename,unsigned int lineno);

extern FXAPI void fxtrace(FXuint level,const FXchar* format,...) FX_PRINTF(2,3) ;

extern FXAPI FXbool fxtoDOS(FXchar*& string,FXint& len);

extern FXAPI FXbool fxfromDOS(FXchar*& string,FXint& len);

extern FXAPI FXchar *fxstrdup(const FXchar* str);

extern FXAPI FXuint fxstrhash(const FXchar* str);

extern FXAPI FXival fxstrlcpy(FXchar* dst,const FXchar* src,FXival len);

extern FXAPI FXival fxstrlcat(FXchar* dst,const FXchar* src,FXival len);

extern FXAPI FXchar* fxstrstr(const FXchar *haystack,const FXchar *needle);

extern FXAPI FXchar* fxstrcasestr(const FXchar *haystack,const FXchar *needle);

extern FXAPI void fxrgb_to_hsv(FXfloat& h,FXfloat& s,FXfloat& v,FXfloat r,FXfloat g,FXfloat b);

extern FXAPI void fxhsv_to_rgb(FXfloat& r,FXfloat& g,FXfloat& b,FXfloat h,FXfloat s,FXfloat v);

extern FXAPI void fxrgb_to_hsl(FXfloat& h,FXfloat& s,FXfloat& l,FXfloat r,FXfloat g,FXfloat b);

extern FXAPI void fxhsl_to_rgb(FXfloat& r,FXfloat& g,FXfloat& b,FXfloat h,FXfloat s,FXfloat l);

extern FXchar* fxencode64(FXchar* dst,FXchar* dstend,const FXchar* src,const FXchar* srcend);

extern FXchar* fxdecode64(FXchar* dst,FXchar* dstend,const FXchar* src,const FXchar* srcend);

extern FXchar* fxencode85(FXchar* dst,FXchar* dstend,const FXchar* src,const FXchar* srcend);

extern FXchar* fxdecode85(FXchar* dst,FXchar* dstend,const FXchar* src,const FXchar* srcend);

extern FXAPI FXwchar fxkeysym2ucs(FXwchar sym);

extern FXAPI FXwchar fxucs2keysym(FXwchar ucs);

extern FXAPI FXint fxparsegeometry(const FXchar *string,FXint& x,FXint& y,FXint& w,FXint& h);

extern FXAPI FXbool fxisconsole(const FXchar *path);

extern FXAPI const FXuchar fxversion[3];

extern FXAPI FXbool getTraceTopic(FXuint topic);

extern FXAPI void setTraceTopic(FXuint topic,FXbool flag=true);

extern FXAPI void setTraceLevel(FXuint level,FXbool flag=true);

extern FXAPI FXbool setTraceTopics(const FXchar* topics,FXbool flag=true);

extern FXAPI FXival fxosversion(FXchar version[],FXival len);

}

#endif