rtxDiag.h

Go to the documentation of this file.

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

#include <stdarg.h>
#include "rtxsrc/rtxContext.h"

#ifdef __cplusplus
extern "C" {
#endif

/* Diagnostic trace functions */
#ifdef _TRACE
#define RTDIAG1(pctxt,msg)              rtxDiagPrint(pctxt,msg)
#define RTDIAG2(pctxt,msg,a)            rtxDiagPrint(pctxt,msg,a)
#define RTDIAG3(pctxt,msg,a,b)          rtxDiagPrint(pctxt,msg,a,b)
#define RTDIAG4(pctxt,msg,a,b,c)        rtxDiagPrint(pctxt,msg,a,b,c)
#define RTDIAG5(pctxt,msg,a,b,c,d)      rtxDiagPrint(pctxt,msg,a,b,c,d)
#define RTHEXDUMP(pctxt,buffer,numocts) rtxDiagHexDump(pctxt,buffer,numocts)
#define RTDIAGCHARS(pctxt,buf,nchars)   rtxDiagPrintChars(pctxt,buf,nchars)

#ifndef _NO_STREAM

#define RTDIAGSTRM2(pctxt,msg)          rtxDiagStream(pctxt,msg)
#define RTDIAGSTRM3(pctxt,msg,a)        rtxDiagStream(pctxt,msg,a)
#define RTDIAGSTRM4(pctxt,msg,a,b)      rtxDiagStream(pctxt,msg,a,b)
#define RTDIAGSTRM5(pctxt,msg,a,b,c)    rtxDiagStream(pctxt,msg,a,b,c)
#define RTHEXDUMPSTRM(pctxt,buffer,numocts) \
rtxDiagStreamHexDump(pctxt,buffer,numocts)
#define RTDIAGSCHARS(pctxt,buf,nchars) \
rtxDiagStreamPrintChars(pctxt,buf,nchars)

#else /* _NO_STREAM */

#define RTDIAGSTRM2(pctxt,msg)          rtxDiagPrint(pctxt,msg)
#define RTDIAGSTRM3(pctxt,msg,a)        rtxDiagPrint(pctxt,msg,a)
#define RTDIAGSTRM4(pctxt,msg,a,b)      rtxDiagPrint(pctxt,msg,a,b)
#define RTDIAGSTRM5(pctxt,msg,a,b,c)    rtxDiagPrint(pctxt,msg,a,b,c)
#define RTHEXDUMPSTRM(pctxt,buffer,numocts) rtxDiagHexDump(pctxt,buffer,numocts)
#define RTDIAGSCHARS(pctxt,buf,nchars)  rtxDiagPrintChars(pctxt,buf,nchars)

#endif /* _NO_STREAM */

#else /* _TRACE */

#define RTDIAG1(pctxt,msg)
#define RTDIAG2(pctxt,msg,a)
#define RTDIAG3(pctxt,msg,a,b)
#define RTDIAG4(pctxt,msg,a,b,c)
#define RTDIAG5(pctxt,msg,a,b,c,d)
#define RTDIAGU(pctxt,ucstr)
#define RTHEXDUMP(pctxt,buffer,numocts)
#define RTDIAGCHARS(pctxt,buf,nchars)

#define RTDIAGSTRM2(pctxt,msg)
#define RTDIAGSTRM3(pctxt,msg,a)
#define RTDIAGSTRM4(pctxt,msg,a,b)
#define RTDIAGSTRM5(pctxt,msg,a,b,c)
#define RTHEXDUMPSTRM(pctxt,buffer,numocts)
#define RTDIAGSCHARS(pctxt,buf,nchars)

#endif /* _TRACE */

typedef enum {
   OSRTDiagError,
   OSRTDiagWarning,
   OSRTDiagInfo,
   OSRTDiagDebug
} OSRTDiagTraceLevel;

EXTERNRT OSBOOL rtxDiagEnabled (OSCTXT* pctxt);

EXTERNRT OSBOOL rtxSetDiag (OSCTXT* pctxt, OSBOOL value);

#ifndef __SYMBIAN32__

EXTERNRT OSBOOL rtxSetGlobalDiag (OSBOOL value);
#endif

EXTERNRT void rtxDiagPrint (OSCTXT* pctxt, const char* fmtspec, ...);

#ifndef _NO_STREAM

EXTERNRT void rtxDiagStream (OSCTXT* pctxt, const char* fmtspec, ...);
#endif /* _NO_STREAM */

EXTERNRT void rtxDiagHexDump
(OSCTXT* pctxt, const OSOCTET* data, size_t numocts);

#ifndef _NO_STREAM

EXTERNRT void rtxDiagStreamHexDump
(OSCTXT* pctxt, const OSOCTET* data, size_t numocts);
#endif /* _NO_STREAM */

EXTERNRT void rtxDiagPrintChars
(OSCTXT* pctxt, const char* data, size_t nchars);

#ifndef _NO_STREAM

EXTERNRT void rtxDiagStreamPrintChars
(OSCTXT* pctxt, const char* data, size_t nchars);

EXTERNRT void rtxDiagStreamPrintBits
(OSCTXT* pctxt, const char* descr, const OSOCTET* data,
 size_t bitIndex, size_t nbits);
#endif /* _NO_STREAM */

EXTERNRT void rtxDiagSetTraceLevel (OSCTXT* pctxt, OSRTDiagTraceLevel level);

EXTERNRT OSBOOL rtxDiagTraceLevelEnabled
(OSCTXT* pctxt, OSRTDiagTraceLevel level);

#ifdef __cplusplus
}
#endif

#endif