nmLibUtils.c File Reference

NetMsgs library utilities. More...

#include <stdio.h>
#include <stdlib.h>
#include "rnr/rnrconfig.h"
#include "rnr/log.h"
#include "rnr/netmsgs.h"
#include "nmLibInternal.h"

Go to the source code of this file.

Functions
const char *	nmStrError (int ecode)
	Get the error string describing the BotSense error code. More...
void	nmPrintBuf (FILE *fp, const char *sPreface, byte_t buf[], size_t uCount, size_t uNLFreq, uint_t uCol)
	Pretty print buffer to opened file stream. More...
void	nmPrintBits (FILE *fp, const char *sPreface, ulonglong_t uVal, uint_t uMsb, uint_t uCnt)
	Pretty print bits in value. More...
size_t	nmGetFieldValSize (NMFType_T eFType)
	Get the field value byte size. More...
const NMFieldDef_T *	nmFindFieldDef (const NMMsgDef_T *pMsgDef, byte_t byFId)
	Find the field definition in the message definition, given the field id. More...

Variables
static const char *	nmEcodeStrTbl []
	NetMsgs Error Code String Table. More...
static size_t	NMFValLenLookupTbl []

Detailed Description

NetMsgs library utilities.

LastChangedDate

2010-07-31 08:48:56 -0600 (Sat, 31 Jul 2010)

Rev

521

Author

Robin Knight (robin.nosp@m..kni.nosp@m.ght@r.nosp@m.oadn.nosp@m.arrow.nosp@m.s.co.nosp@m.m)

Copyright

© 2010-2017. RoadNarrows LLC.
http://www.roadnarrows.com
All Rights Reserved

Definition in file nmLibUtils.c.

Function Documentation

const NMFieldDef_T* nmFindFieldDef	(	const NMMsgDef_T *	pMsgDef,
		byte_t	byFId
	)

Find the field definition in the message definition, given the field id.

Parameters

pMsgDef	Pointer to message definition.
byFId	Field Id.

Returns

If the field definition is found, then the pointer to the field definition is returned. Else NULL is return.

Definition at line 235 of file nmLibUtils.c.

References _nm_field_def_struct::m_eFId, _nm_msg_def_struct::m_pFields, and _nm_msg_def_struct::m_uCount.

Referenced by nmUnpackITVStream().

{
  size_t  i;

  for(i=0; i<pMsgDef->m_uCount; ++i)
  { 
    if( pMsgDef->m_pFields[i].m_eFId == byFId )
    {
      return &(pMsgDef->m_pFields[i]);
    }
  }

  return NULL;
}

size_t nmGetFieldValSize

(

NMFType_T

eFType

)

Get the field value byte size.

Parameters

eFType

Field type.

Returns

Returns field value byte size. Returns 0 if field type is unknown or is variable in length.

Definition at line 209 of file nmLibUtils.c.

References NMFValLenLookupTbl, NMHashFType(), and NMHashNoIdx.

{
  int idx;
 
  idx = NMHashFType(eFType);

  if( (idx != NMHashNoIdx) && (idx < arraysize(NMFValLenLookupTbl)) )
  {
    return NMFValLenLookupTbl[idx];
  }
  else
  {
    return (size_t)0;
  }
}

void nmPrintBits	(	FILE *	fp,
		const char *	sPreface,
		ulonglong_t	uVal,
		uint_t	uMsb,
		uint_t	uCnt
	)

Pretty print bits in value.

Parameters

fp	File pointer.
sPreface	Optional bit preface string (set to NULL for no preface).
uVal	Bits to print.
uMsb	Starting most significant bit.
uCnt	Number of bits.

Definition at line 174 of file nmLibUtils.c.

{
  uint_t i;

  if( sPreface && *sPreface )
  {
    fprintf(fp, "%s:", sPreface);
  }

  for(i=0; i<uCnt; ++i)
  {
    if( (uMsb % 8) == 7 )
    {
      if( i != 0 )
      {
        printf(" ");
      }
    }
    (uVal >> uMsb) & 0x01?  printf("1"): printf("0");
    --uMsb;
  }
}

void nmPrintBuf	(	FILE *	fp,
		const char *	sPreface,
		byte_t	buf[],
		size_t	uCount,
		size_t	uNLFreq,
		uint_t	uCol
	)

Pretty print buffer to opened file stream.

Parameters

fp	File pointer.
sPreface	Optional buffer preface string (set to NULL for no preface).
buf	Buffer to print.
uCount	Number of bytes to print.
uNLFreq	Newline frequency (set to 0 for no newlines).
uCol	Column alignment number.

Definition at line 138 of file nmLibUtils.c.

Referenced by nmPackFlatMsgDebug(), nmPackITVMsgDebug(), nmTraceField(), nmUnpackFlatMsgDebug(), and nmUnpackITVMsgDebug().

{
  size_t  i;

  if( sPreface && *sPreface )
  {
    fprintf(fp, "%s:", sPreface);
  }

  for(i=0; i<uCount; ++i)
  {
    if( (uNLFreq > 0) && ((i % uNLFreq) == 0) )
    {
      if( i != 0 )
      {
        fprintf(fp, "\n%*s", uCol, "");
      }
    }
    fprintf(fp, " 0x%02x", buf[i]);
  }
}

const char* nmStrError

(

int

ecode

)

Get the error string describing the BotSense error code.

The absolute value of the error code is taken prior retrieving the string. An unknown or out-of-range error code will be mapped to NM_ECODE_BADEC.

Parameters

ecode

BotSense error code.

Returns

Returns the appropriate error code string.

Definition at line 114 of file nmLibUtils.c.

References NM_ECODE_BADEC, and nmEcodeStrTbl.

{
  if( ecode < 0 )
  {
    ecode = -ecode;
  }

  if( ecode >= arraysize(nmEcodeStrTbl) )
  {
    ecode = NM_ECODE_BADEC;
  }
  return nmEcodeStrTbl[ecode];
}

Variable Documentation

const char* nmEcodeStrTbl[]

static

Initial value:

=
{
  "Ok",                                     

  "Error",                                  
  "Insufficient memory available",          
  "Machine architecture not supported",     
  "Value out-of-range",                     
  "Unknown field type",                     
  "Bad message format",                     
  "Unknown message id",                     
  "Internal error",                         
  "Invalid error code",                     

  NULL, 0
}

NetMsgs Error Code String Table.

Table is indexed by NetMsgs error codes (see NetMsgs Error Codes). Keep in sync.

Definition at line 69 of file nmLibUtils.c.

Referenced by nmStrError().

size_t NMFValLenLookupTbl[]

static

Initial value:

=
{
  NMFVAL_LEN_BOOL,  NMFVAL_LEN_U8,    NMFVAL_LEN_F64,   NMFVAL_LEN_U16,
  NMFVAL_LEN_U32,   NMFVAL_LEN_P64,   NMFVAL_LEN_U64,   NMFVAL_LEN_VECTOR,
  NMFVAL_LEN_S8,    NMFVAL_LEN_CHAR,  NMFVAL_LEN_F32,   NMFVAL_LEN_S16,
  NMFVAL_LEN_S32,   NMFVAL_LEN_P32,   NMFVAL_LEN_S64,   NMFVAL_LEN_STRING,
  NMFVAL_LEN_STRUCT
}

Field Value Byte Size Lookup Table

Warning

Keep in asending order by ftype.

Definition at line 90 of file nmLibUtils.c.

Referenced by nmGetFieldValSize().