rtxError.h

Go to the documentation of this file.

/*
 * Copyright (c) 2003-2023 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 __RTXERROR_H__
#define __RTXERROR_H__

#include "rtxsrc/rtxContext.h"
#include "rtxsrc/rtxErrCodes.h"

/* errno.h is supported on both windows and UNIX, though the values in UNIX
 * systems are usually extended.  The VC++ compiler has its own thread-safe
 * version when building the DLLs, so we avoid defining errno in this case;
 * see http://cygwin.com/ml/pthreads-win32/2001/msg00047.html; also, WinCE
 * has its own version, apparently. */
#if !defined(_DLL) && !defined(_MT) && !defined(_WIN32_WCE)
#include <errno.h>
/* extern int errno;        //okay for older UNIXes but not for newer */
#endif

/* Define a cross-platform way to get the error number. */
#if defined(_WIN32) || defined(_WIN64)
#define ERRNO WSAGetLastError()
#elif !defined (_WIN32_WCE)
#define ERRNO errno
#else
#define ERRNO -1 /* must be an int */
#endif

#ifdef __cplusplus
extern "C" {
#endif

/* Error handling */

#ifndef _COMPACT

#ifndef __MODULE__
#define LOG_RTERR(pctxt,stat) \
rtxErrSetData(pctxt,stat,__FILE__,__LINE__)

#define LOG_RTERRNEW(pctxt,stat) \
rtxErrSetNewData(pctxt,stat,__FILE__,__LINE__)

#else /* Should significantly decrease use of RAM in ARM systems */
#define LOG_RTERR(pctxt,stat) \
rtxErrSetData(pctxt,stat,__MODULE__,__LINE__)

#define LOG_RTERRNEW(pctxt,stat) \
rtxErrSetNewData(pctxt,stat,__MODULE__,__LINE__)
#endif /* not defined __MODULE__ */

#define RETURN_RTERR(pctxt, stat) \
return LOG_RTERR(pctxt, stat)

#define OSRTASSERT(condition) \
if (!(condition)) { rtxErrAssertionFailed(#condition,__LINE__,__FILE__); }

#define OSRTCHECKPARAM(condition) if (condition) { /* do nothing */ }
#else
#define LOG_RTERR(pctxt,stat) \
rtxErrSetData(pctxt,stat,0,0)

#define LOG_RTERRNEW(pctxt,stat) \
rtxErrSetNewData(pctxt,stat,0,0)

#define RETURN_RTERR(pctxt, stat) return stat

#define OSRTASSERT(condition)
#define OSRTCHECKPARAM(condition)
#endif /* _COMPACT */

#define LOG_RTERR1(pctxt,stat,a) \
(a,LOG_RTERR (pctxt, stat),stat)

#define LOG_RTERRNEW1(pctxt,stat,a) \
(a,LOG_RTERRNEW (pctxt, stat),stat)

#define LOG_RTERR2(pctxt,stat,a,b) \
(a,b,LOG_RTERR (pctxt, stat),stat)

#define LOG_RTERRNEW2(pctxt,stat,a,b) \
(a,b,LOG_RTERRNEW (pctxt, stat),stat)

#define LOG_RTERR_AND_FREE_MEM(ctxt_p,stat,mem_p) \
rtxMemFreePtr ((ctxt_p),(mem_p)), LOG_RTERR(ctxt_p, stat)

typedef int (*OSErrCbFunc) (const char* ptext, void* cbArg_p);

EXTERNRT OSBOOL rtxErrAddCtxtBufParm (OSCTXT* pctxt);

EXTERNRT OSBOOL rtxErrAddDoubleParm (OSCTXT* pctxt, double errParm);

EXTERNRT OSBOOL rtxErrAddErrorTableEntry
#if !defined(_ARMTCC) && !defined(__SYMBIAN32__)
(const char* const* ppStatusText, OSINT32 minErrCode, OSINT32 maxErrCode);
#else
(OSVOIDARG);
#endif

EXTERNRT OSBOOL rtxErrAddElemNameParm (OSCTXT* pctxt);

EXTERNRT OSBOOL rtxErrAddIntParm (OSCTXT* pctxt, int errParm);

#if !defined(_NO_INT64_SUPPORT)

EXTERNRT OSBOOL rtxErrAddInt64Parm (OSCTXT* pctxt, OSINT64 errParm);
#endif /* !defined(_NO_INT64_SUPPORT) */

EXTERNRT OSBOOL rtxErrAddSizeParm (OSCTXT* pctxt, OSSIZE errParm);

EXTERNRT OSBOOL rtxErrAddStrParm (OSCTXT* pctxt, const char* pErrParm);

EXTERNRT OSBOOL rtxErrAddStrnParm
   (OSCTXT* pctxt, const char* pErrParm, OSSIZE nchars);

EXTERNRT OSBOOL rtxErrAddUIntParm (OSCTXT* pctxt, unsigned int errParm);

#if !defined(_NO_INT64_SUPPORT)

EXTERNRT OSBOOL rtxErrAddUInt64Parm (OSCTXT* pctxt, OSUINT64 errParm);
#endif /* !defined(_NO_INT64_SUPPORT) */

EXTERNRT void rtxErrAssertionFailed
(const char* conditionText, int lineNo, const char* fileName);

EXTERNRT const char* rtxErrFmtMsg
(OSRTErrInfo* pErrInfo, char* bufp, OSSIZE bufsiz);

EXTERNRT void rtxErrFreeParms (OSCTXT* pctxt);

EXTERNRT char* rtxErrGetText (OSCTXT* pctxt, char* pBuf, OSSIZE* pBufSize);

EXTERNRT char* rtxErrGetTextBuf (OSCTXT* pctxt, char* pbuf, OSSIZE bufsiz);

EXTERNRT char* rtxErrGetMsgText (OSCTXT* pctxt);

EXTERNRT char* rtxErrGetMsgTextBuf (OSCTXT* pctxt, char* pbuf, OSSIZE bufsiz);

EXTERNRT OSRTErrInfo* rtxErrNewNode (OSCTXT* pctxt);

EXTERNRT void rtxErrInit (OSVOIDARG);

EXTERNRT int rtxErrReset (OSCTXT* pctxt);

EXTERNRT int rtxErrResetErrInfo (OSCTXT* pctxt);

EXTERNRT void rtxErrLogUsingCB (OSCTXT* pctxt, OSErrCbFunc cb, void* cbArg_p);

EXTERNRT void rtxErrPrint (OSCTXT* pctxt);

EXTERNRT void rtxErrPrintElement (OSRTErrInfo* pErrInfo);

EXTERNRT int rtxErrSetData (OSCTXT* pctxt, int status,
                             const char* module, int lineno);

EXTERNRT int rtxErrSetNewData (OSCTXT* pctxt, int status,
                                const char* module, int lineno);

EXTERNRT void rtxErrSetNonFatal(OSCTXT* pctxt);

EXTERNRT int rtxErrCheckNonFatal(OSCTXT* pctxt);

EXTERNRT int rtxErrGetFirstError (const OSCTXT* pctxt);

EXTERNRT int rtxErrGetLastError (const OSCTXT* pctxt);

EXTERNRT OSSIZE rtxErrGetErrorCnt (const OSCTXT* pctxt);

EXTERNRT int rtxErrGetStatus (const OSCTXT* pctxt);

EXTERNRT int rtxErrResetLastErrors (OSCTXT* pctxt, OSSIZE errorsToReset);

EXTERNRT int rtxErrCopy (OSCTXT* pDestCtxt, const OSCTXT* pSrcCtxt);

EXTERNRT int rtxErrAppend (OSCTXT* pDestCtxt, const OSCTXT* pSrcCtxt);

EXTERNRT int rtxErrInvUIntOpt (OSCTXT* pctxt, OSUINT32 ident);

#ifdef __cplusplus
}
#endif

#endif