osSysTypes.h

/*
 * Copyright (c) 1997-2022 Objective Systems, Inc.
 *
 * This software is furnished under a license and may be used and copied
 * only in accordance with the terms of such license and with the
 * inclusion of the above copyright notice. This software or any other
 * copies thereof may not be provided or otherwise made available to any
 * other person. No title to and ownership of the software is hereby
 * transferred.
 *
 * The information in this software is subject to change without notice
 * and should not be construed as a commitment by Objective Systems, Inc.
 *
 * PROPRIETARY NOTICE
 *
 * This software is an unpublished work subject to a confidentiality agreement
 * and is protected by copyright and trade secret law.  Unauthorized copying,
 * redistribution or other use of this work is prohibited.
 *
 * The above notice of copyright on this source code product does not indicate
 * any actual or intended publication of such source code.
 *
 *****************************************************************************/

#ifndef _OSSYSTYPES_H_
#define _OSSYSTYPES_H_

/* Ensure that the appropriate limits are active. */
#ifndef __STDC_LIMIT_MACROS
#define __STDC_LIMIT_MACROS
#endif
#ifndef __STDC_CONSTANT_MACROS
#define __STDC_CONSTANT_MACROS
#endif
#ifndef __STDC_FORMAT_MACROS
#define __STDC_FORMAT_MACROS
#endif

#if defined(__sun) || defined(NOCPP11)
#define nullptr NULL
#endif

#if (!defined(BREW_MODULE) && !defined(FLAT_BREW))
#include <stdlib.h>
#else
/* Special include for Qualcomm BREW environment */
/* #include "AEEStdLib.h" */
#endif

#if !defined(_MSC_VER) && !defined(__BORLANDC__) && !defined(__WATCOMC__) \
   && !defined(__vxworks) && !defined(__SYMBIAN32__) && !defined(NIOS2)
#include <inttypes.h> /* does not exist in windows; use builtins instead */
#endif /* not windows */

#include <limits.h>

#include <float.h>

#ifndef FALSE
#define FALSE   0
#define TRUE    1
#endif

#define NumberOf(x)     (sizeof(x)/sizeof(x[0]))

/* This macro is for prototypes of argumentless functions.  For actual
   variables of type void, use OSVoid, defined below.  This OSVOIDARG
   macro can be #ifdef'd for compilers that don't like seeing "void"
   in prototypes.  */
#define OSVOIDARG void

typedef void            OSVoid;
typedef void*           OSVoidPtr;
typedef unsigned char   OSBOOL;
typedef signed char     OSINT8;
typedef unsigned char   OSUINT8;
typedef short           OSINT16;
typedef unsigned short  OSUINT16;
typedef OSUINT8         OSOCTET;
typedef OSUINT8         OSUTF8CHAR;
typedef OSUINT16        OSUNICHAR;
typedef double          OSREAL;
typedef double          OSDOUBLE;
typedef float           OSFLOAT;
#ifdef _16BIT
typedef long            OSINT32;
typedef unsigned long   OSUINT32;
#define OSINTCONST(val)  val##L
#define OSUINTCONST(val) val##UL
#define OSUINT32_MAX    ULONG_MAX
#else
typedef int             OSINT32;
typedef unsigned int    OSUINT32;
#define OSINTCONST(val)  val
#define OSUINTCONST(val) val##u
#define OSUINT32_MAX    UINT_MAX
#endif /* _16BIT */
typedef OSUINT32        OS32BITCHAR;
typedef size_t          OSSIZE;

#define OSINT32_MAX     ((OSINT32)2147483647L)
#define OSINT32_MIN     ((OSINT32)(-OSINT32_MAX-1))

#define OSUINT16_MAX    ((OSUINT16)65535UL)
#define OSINT16_MAX     ((OSINT16)32767L)
#define OSINT16_MIN     ((OSINT16)(-OSINT16_MAX-1))

#define OSUINT8_MAX     ((OSUINT8)255U)
#define OSINT8_MAX      ((OSINT8)127L)
#define OSINT8_MIN      ((OSINT8)(-OSINT8_MAX-1))

#define OSREALMAX       ((OSREAL)DBL_MAX)
#define OSREALMIN       ((OSREAL)-DBL_MAX)

#define OSU32NULLIDX    OSUINT32_MAX
#define OSNULLINDEX     ((OSSIZE)-1)

/* Note: OSSIZE_MAX as defined here should NOT be used in preprocessor
   conditional expressions (e.g. #if).

   C99 says that conditional expressions in preprocessor diretives shall not
   contain casts, which it does (but evidently Visual Studio ignores this).
   C99 also says that the preprocessor treats signed/unsigned integer values as
   intmax_t/uintmax_t, which means the preprocessor sees 64-bit values and sees
   OSSIZE_MAX == 0xFFFFFFFFFFFFFFFFULL.
*/
#define OSSIZE_MAX      OSNULLINDEX

#if SIZE_MAX == 0xFFFFFFFFUL
   #define OSSIZE_IS_32BITS
#elif SIZE_MAX == 0xFFFFFFFFFFFFFFFFULL
   #define OSSIZE_IS_64BITS
#endif


typedef struct OSNumDateTime {
   OSINT32      year;
   OSUINT8      mon;            /* 1 <=  mon    <= 12   */
   OSUINT8      day;            /* 1 <=  day    <= 31   */
   OSUINT8      hour;           /* 0 <=  hour   <= 23   */
   OSUINT8      min;            /* 0 <=  min    <= 59   */
   OSREAL       sec;
   OSBOOL       tz_flag;        /* is tzo explicitely set? */
   OSINT32      tzo;            /* -840 <= tzo <= 840 */
} OSNumDateTime;

/* Size type print format string */

#if defined(_MSC_VER)
#if _MSC_VER < 1300
//Visual C++ 6.0 is 32 bit only. No size specifier required.
#define OSSIZEFMT "%u"
#else
//Visual Studio 2003+ supports I for size_t
#define OSSIZEFMT "%Iu"
#endif
#elif defined(__hpux) || defined(VMS) || defined(_VMS)
//HP-UX and VMS use %u for size_t.
#define OSSIZEFMT "%u"
#else
//GNU compilers support z for size_t. It is C99 standard.
#define OSSIZEFMT "%zu"
#endif

/* 64-bit long integer type */

#ifndef OSINT64_
#if !defined(_NO_INT64_SUPPORT)
#if defined(_MSC_VER) || defined(__BORLANDC__) || defined(__WATCOMC__)
#define OSINT64_
typedef __int64 OSINT64;
typedef unsigned __int64 OSUINT64;

/* OSINT64FMT_TS is the type specifier for 64-bit (signed) integers. */
#define OSINT64FMT_TS  "I64d"
#define OSINT64FMT  "%I64d"
#define OSUINT64FMT "%I64u"
#define OSINT64FMTX "%I64x"
#define OSINT64MAX  _I64_MAX
#define OSUINT64MAX _UI64_MAX
#define OSINT64MIN  _I64_MIN
#define OSI64CONST(val)  val##i64
#define OSUI64CONST(val) val##ui64

#elif defined(INT64_MAX) /* assume have ISO C99 standard types */
#define OSINT64_
typedef int64_t OSINT64;
typedef uint64_t OSUINT64;
#ifdef PRId64 /* have C99 format macros */
/* C++ 2011 requires spaces here */
#define OSINT64FMT_TS PRId64
#define OSINT64FMT  "%" PRId64
#define OSUINT64FMT "%" PRIu64
#define OSINT64FMTX "%" PRIx64
#else /* have C99 types but not format macros, assume long long format */
#define OSINT64FMT_TS  "lld"
#define OSINT64FMT  "%lld"
#define OSUINT64FMT "%llu"
#define OSINT64FMTX "%llx"
#endif /* PRId64 */
#define OSINT64MAX  INT64_MAX
#define OSUINT64MAX UINT64_MAX
#define OSINT64MIN  INT64_MIN
#define OSI64CONST(val)  INT64_C(val)
#define OSUI64CONST(val) UINT64_C(val)

#else /* ?? __WORDSIZE != 64 */
#define OSINT64_
typedef long long OSINT64;
typedef unsigned long long OSUINT64;
#define OSINT64FMT_TS  "lld"
#define OSINT64FMT  "%lld"
#define OSUINT64FMT "%llu"
#define OSINT64FMTX "%llx"
#define OSI64CONST(val)  val##LL
#define OSUI64CONST(val) val##ULL

/* May throw an error if __STDC_LIMIT_MACROS is not defined */
#ifdef LLONG_MAX
#define OSINT64MAX  LLONG_MAX
#define OSUINT64MAX ULLONG_MAX
#define OSINT64MIN  LLONG_MIN
#elif defined LONG_LONG_MAX /* special code for gcc 3.3.3 */
#define OSINT64MAX  LONG_LONG_MAX
#define OSUINT64MAX ULONG_LONG_MAX
#define OSINT64MIN  LONG_LONG_MIN
#elif defined __INT64_MAX /* VMS */
#define OSINT64MAX  __INT64_MAX
#define OSUINT64MAX __UINT64_MAX
#define OSINT64MIN  __INT64_MIN
#else
#warning "Using LONG_MAX for 64-bit maximum."
#define OSINT64MAX LONG_MAX
#define OSUINT64MAX ULONG_MAX
#define OSINT64MIN LONG_MIN
#endif

#endif /* _MSC_VER ... */
#endif /* !defined(_NO_INT64_SUPPORT) */

#ifndef OSINT64_
/* if OSINT64 is still not defined - define it as long/unsigned long */
#define OSINT64_
typedef long OSINT64;
typedef unsigned long OSUINT64;
#define OSINT64FMT_TS  "ld"
#define OSINT64FMT  "%ld"
#define OSUINT64FMT "%lu"
#define OSINT64FMTX "%lx"
#define OSINT64MAX  LONG_MAX
#define OSUINT64MAX ULONG_MAX
#define OSINT64MIN  LONG_MIN
#define OSI64CONST(val)  val##L
#define OSUI64CONST(val) val##UL
#endif /* OSINT64 ... */

#define OSU64NULLIDX    OSUINT64MAX

#endif /* OSINT64 */

typedef struct OSDynOctStr {
   OSUINT32 numocts;
   const OSOCTET* data;
} OSDynOctStr;

typedef struct OSDynOctStr64 {
   OSSIZE numocts;
   OSOCTET* data;
} OSDynOctStr64;

typedef OSDynOctStr OSOpenType;

typedef OSDynOctStr64 OSOpenType64;

/* UTF-8 name/value pair */

typedef struct OSUTF8NVP {
   const OSUTF8CHAR* name;
   const OSUTF8CHAR* value;
} OSUTF8NVP;

typedef OSUTF8NVP OSAnyAttr;
typedef OSUTF8NVP OSAnyElement;

/* XML string */

typedef struct OSXMLSTRING {
   OSBOOL cdata;                /* encode as a CDATA section */
   const OSUTF8CHAR* value;
} OSXMLSTRING;

typedef OSNumDateTime OSXSDDateTime;

typedef struct OSBitMapItem {
   const OSUTF8CHAR* name;
   OSUINT16          bitno;
   OSUINT16          namelen;
} OSBitMapItem;

typedef struct OSUTF8NameAndLen {
   const OSUTF8CHAR* name;
   OSSIZE len;
} OSUTF8NameAndLen;


typedef struct OSDecimalFmt {
   OSINT8 totalDigits;        /* total significiant digits */
   OSINT8 fractionDigits;     /* maximum signficiant digits in fraction,
                                 precision */
   OSINT8 fractionMinDigits;  /* minimum digits in fraction, if
                                 fraction digits less than this value
                                 trailing zeros will be added. */
   OSINT8 integerMaxDigits;   /* Maximum digits in integer part; if it is 0
                                 and integer part is 0 then integer part
                                 will be omitted, like .3, or -.3 */
   OSINT8 integerMinDigits;   /* Minimum digits in integer part, leading zeros
                                 will be added if necessary. */
   OSBOOL signPresent;        /* Indicates, sign must present, even if value
                                 is positive. */
   OSBOOL pointPresent;       /* Indicates, decimal point must present, even
                                 if value's fraction is 0 */
   OSUINT8 nPatterns;         /* number of patterns stored in 'patterns' */
   const char* const* patterns; /* patterns, used to verify value format is
                                 correct */
} OSDecimalFmt;



typedef struct OSDoubleFmt {
   OSINT8 totalDigits;        /* total significiant digits */
   OSINT8 fractionDigits;     /* maximum signficiant digits in fraction,
                                 precision */
   OSINT8 fractionMinDigits;  /* minimum digits in fraction, if
                                 fraction digits less than this value
                                 trailing zeros will be added. */
   OSINT8 integerMaxDigits;   /* Maximum digits in integer part; if it is 0
                                 and integer part is 0 then integer part
                                 will be omitted, like .3, or -.3 */
   OSINT8 integerMinDigits;   /* Minimum digits in integer part, leading zeros
                                 will be added if necessary. */
   OSINT8 expSymbol;          /* 'E' or 'e' only; 0 if no exp is expected,
                                 -1 - default ('E') */
   OSINT16 expMinValue;       /* Minimum exponent value. By default - -infinity */
   OSINT16 expMaxValue;       /* Maximum exponent value. By default - infinity */
   OSINT8 expDigits;          /* Total digits in exponent part; if exponent's
                                 value is not enough, trailing zeros will be
                                 added */
   OSBOOL signPresent;        /* Indicates, sign must present, even if value
                                 is positive. */
   OSBOOL pointPresent;       /* Indicates, decimal point must present, even
                                 if value's fraction is 0 */
   OSBOOL expPresent;         /* Indicates, exponent must present, even
                                 if its value is 0 */
   OSBOOL expSignPresent;     /* Indicates, exponent sign must present, even
                                 if its value is > 0 */
} OSDoubleFmt;

#if defined(_MSC_VER)
/*  this disables 'unreferenced formal parameter' warning */
#pragma warning(disable: 4100)
/*  this disables 'assignment operator could not be generated' warning */
#pragma warning(disable: 4512)
#endif

#endif