rtxDiagBitTrace.h

Go to the documentation of this file.

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

#include <stdarg.h>
#include "rtxsrc/rtxMemBuf.h"
#include "rtxsrc/rtxSList.h"
#include "rtxsrc/rtxPrintToStream.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct {
   OSUINT8 lb, lbm;
   char fmtBitBuffer[40], fmtHexBuffer[10], fmtAscBuffer[10];
   int  fmtBitCharIdx, fmtHexCharIdx, fmtAscCharIdx;
} OSRTDiagBinDumpBuffer;

typedef struct OSRTDiagBitFieldList {
   OSUINT16  disabledCount;
   OSRTSList fieldList; /* list of OSRTDiagBitField */
   OSRTMEMBUF* pCaptureBuf; /* capture buffer for streams */
   OSRTDiagBinDumpBuffer printBuffer;  /* formatted text buffer */
   OSRTSListNode* pLastPrinted; /* last node in list that was printed */
} OSRTDiagBitFieldList;

typedef struct {
   const char*  elemName;
   const char*  nameSuffix;
   size_t       bitOffset;
   size_t       numbits;
   OSRTDiagBitFieldList* pOpenTypeFieldList;
} OSRTDiagBitField;

/* Macros */

#ifdef _TRACE
#define RTDIAG_INSBITFLDLEN(pctxt) \
rtxDiagInsBitFieldLen((pctxt)->pBitFldList)

#define RTDIAG_NEWBITFIELD(pctxt,suffix) \
rtxDiagNewBitField((pctxt)->pBitFldList,suffix)

#define RTDIAG_SETBITFLDOFFSET(pctxt) \
rtxDiagSetBitFldOffset((pctxt)->pBitFldList)

#define RTDIAG_SETBITFLDCOUNT(pctxt) \
rtxDiagSetBitFldCount((pctxt)->pBitFldList)
#else
#define RTDIAG_INSBITFLDLEN(pctxt)
#define RTDIAG_NEWBITFIELD(pctxt,suffix)
#define RTDIAG_SETBITFLDOFFSET(pctxt)
#define RTDIAG_SETBITFLDCOUNT(pctxt)
#endif

#define RTDIAG_GETCTXTBITOFFSET(pctxt) \
(((pctxt)->buffer.byteIndex * 8) + (8 - (pctxt)->buffer.bitOffset))

EXTERNRT int rtxDiagCtxtBitFieldListInit (OSCTXT* pctxt);

EXTERNRT void rtxDiagBitFieldListInit
(OSCTXT* pctxt, OSRTDiagBitFieldList* pBFList);

EXTERNRT void rtxDiagInsBitFieldLen (OSRTDiagBitFieldList* pBFList);

EXTERNRT OSRTDiagBitField* rtxDiagNewBitField
(OSRTDiagBitFieldList* pBFList, const char* nameSuffix);

EXTERNRT void rtxDiagSetBitFldOffset (OSRTDiagBitFieldList* pBFList);

EXTERNRT void rtxDiagSetBitFldCount (OSRTDiagBitFieldList* pBFList);

EXTERNRT void rtxDiagSetBitFldNameSuffix
(OSRTDiagBitFieldList* pBFList, const char* nameSuffix);

EXTERNRT OSBOOL rtxDiagSetBitFldDisabled
(OSRTDiagBitFieldList* pBFList, OSBOOL value);

EXTERNRT void rtxDiagBitTracePrint
(OSRTDiagBitFieldList* pBFList, const char* varname);

EXTERNRT void rtxDiagBitTracePrintHTML
(const char* filename, OSRTDiagBitFieldList* pBFList, const char* varname);

EXTERNRT void rtxDiagBitFldAppendNamePart
(OSRTDiagBitFieldList* pBFList, const char* namePart);

#ifdef __cplusplus
}
#endif

#endif