NetMsgs.NetMsgsBase Namespace Reference

NetMsgs Base Data Module. More...

Classes
class	NetMsgsError

Functions
def	StrError (ecode)
def	IsIdentifier (token)
def	PrettyPrintCols (fp, cursor, args, kwargs)
def	PrintBuf (buf, count=None, preface='', nlfreq=None, indent=0, col=0, fp=sys.stderr)
def	PrintBits (val, msbit, count=None, preface='', fp=sys.stderr)
def	PrettyPrintAssignExpr (name, val, col=0, indent=0, fp=sys.stderr)
def	PrettyPrintVal (val, col=0, indent=0, fp=sys.stderr)
def	PrettyPrintDict (d, col=0, indent=0, fp=sys.stderr)
def	PrettyPrintList (l, col=0, indent=0, fp=sys.stderr)

Variables
list	NMEncoding = ['flat', 'itv']
	Message Encoding Type Enumeration.
list	NMEndian = ['big', 'little', 'native']
	Message Byte Ordering Type Enumeration.
dictionary	NMBuiltInFieldTypes
	Built-In message field types, keyed by XML field type name. More...
	NMFCode = lambdaxmlftype:NMBuiltInFieldTypes[xmlftype]['code']
	Get NetMsgs field type code given the XML field type. More...
dictionary	NMAliasMap
	The full set of XML ftype values. More...
string	NMKeyOrder = '>'
	Special DB dictionary order key.
string	NMKeyPad = '#'
	Special DB pad field key.
string	NMVectorSuffix = '[]'
	XML ftype attribute vector suffix string.
list	NMFTypeSimple
	List of simple field types by XML ftype. More...
list	NMFTypeCodeSimple
	List of simple field types by field type code. More...
list	NMFTypeCompound = [ 'string', 'struct', 'vector' ]
	List of compound field types by XML ftype.
list	NMFTypeCodeCompound = [NMFCode('string'), NMFCode('struct'), NMFCode('vector')]
	List of compound field types by field type code.
list	NMFTypeNumber
	List of number field types by XML ftype. More...
dictionary	NMFTypeCode2Xml
	Field type code to XML file type map. More...
dictionary	NMFHdrLen
	Field Header Lengths keyed by message encoding. More...
	NMFIdNone = NMFID_NONE
	No field id value.
int	NMPadDftCount = 1
	Default pad count.
	NMPadFVal = NMFTypePadTr
	Pad field value.
	NMStringMaxCount = NMFVAL_LEN_MAX_STRING
	Maximum and default string maximum length.
	NMVectorMaxCount = NMFVAL_LEN_MAX_VECTOR
	Maximum and default vector maximum item count.
string	space = lambdaindent:"%*s"
	space quickie

Detailed Description

NetMsgs Base Data Module.

LastChangedDate

2012-07-23 14:06:10 -0600 (Mon, 23 Jul 2012)

Rev

2098

See also

PyDoc Generated Documentation

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

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

Function Documentation

def NetMsgs.NetMsgsBase.IsIdentifier

(

token

)

Returns True if token is a valid identifier, else False.

    Parameters:
      token   - Parsed token.

Definition at line 364 of file NetMsgsBase.py.

def IsIdentifier(token):
  """ Returns True if token is a valid identifier, else False.

      Parameters:
        token   - Parsed token.
  """
  if not token:
    return False
  c = token[0]
  if not c.isalpha() and c != "_":
    return False
  for c in token[1:]:
    if not c.isalnum() and c != "_":
      return False
  return True

def NetMsgs.NetMsgsBase.PrettyPrintAssignExpr	(		name,
			val,
			col = 0,
			indent = 0,
			fp = sys.stderr
	)

Pretty print name = value.

    Parameters:
      nam     - Variable name
      val     - Variable value.
      col     - Current column position.
      indent  - Indentation.
      fp      - Opened file pointer.

Definition at line 496 of file NetMsgsBase.py.

References NetMsgs.NetMsgsBase.PrettyPrintVal(), and NetMsgs.NetMsgsBase.space.

def PrettyPrintAssignExpr(name, val, col=0, indent=0, fp=sys.stderr):
  """ Pretty print name = value.

      Parameters:
        nam     - Variable name
        val     - Variable value.
        col     - Current column position.
        indent  - Indentation.
        fp      - Opened file pointer.
  """
  sp = _nspaces(col, indent)
  lhs = "%s%s = " % (space(sp), name)
  fp.write(lhs)
  PrettyPrintVal(val, col=len(lhs), indent=indent, fp=fp)
  fp.write('\n')

def NetMsgs.NetMsgsBase.PrettyPrintCols	(		fp,
			cursor,
			args,
			kwargs
	)

Pretty print argument strings aligned to column.

    Parameters:
      cursor    - Current column cursor position.
      args      - List of argument (pos, s) 2-tuples.
      kwargs    - Print control keywords.

Definition at line 382 of file NetMsgsBase.py.

References NetMsgs.NetMsgsBase.PrintBuf(), and NetMsgs.NetMsgsBase.space.

def PrettyPrintCols(fp, cursor, *args, **kwargs):
  """ Pretty print argument strings aligned to column.

      Parameters:
        cursor    - Current column cursor position.
        args      - List of argument (pos, s) 2-tuples.
        kwargs    - Print control keywords.
  """
  while len(args) >= 2: 
    linecont = kwargs.get('linecont', '')
    force    = kwargs.get('force', False)
    pos = args[0]
    s   = args[1]
    args = args[2:]
    if (pos <= cursor) and (cursor > 0):
      if not force or cursor > 78:
        fp.write("%s\n" % (linecont))
        cursor = 0
      else:
        fp.write(" ")
        cursor += 1
    if pos > cursor:
      fp.write(space(pos-cursor))
      cursor = pos
    fp.write("%s" % (s))
    cursor += len(s)
  return cursor

def NetMsgs.NetMsgsBase.PrettyPrintDict	(		d,
			col = 0,
			indent = 0,
			fp = sys.stderr
	)

Pretty print dictionary in sorted, indented clarity.

    Parameters:
      d       - The dictionary.
      col     - Current column position.
      indent  - Indentation.
      fp      - Opened file pointer.

    Return:
      New column position

Definition at line 538 of file NetMsgsBase.py.

References NetMsgs.NetMsgsBase.PrettyPrintVal(), and NetMsgs.NetMsgsBase.space.

Referenced by NetMsgs.NetMsgsBase.PrettyPrintVal().

def PrettyPrintDict(d, col=0, indent=0, fp=sys.stderr):
  """ Pretty print dictionary in sorted, indented clarity.

      Parameters:
        d       - The dictionary.
        col     - Current column position.
        indent  - Indentation.
        fp      - Opened file pointer.

      Return:
        New column position
  """
  sp = _nspaces(col, indent)
  s = repr(d)
  if col + sp + len(s) < 80:
    fp.write('%s{' % space(sp))
    col = col + sp + 1
    keys = d.keys()
    keys.sort()
    for k in keys:
      key = _atval(k)
      fp.write("%s:" % key)
      col += len(key) + 1
      col = PrettyPrintVal(d[k], col=col, indent=indent, fp=fp)
      fp.write(', ')
      col += 2
    fp.write("}")
    return col + 1
  else:
    fp.write('%s{\n' % space(sp))
    col = 0
    indent += 2
    keys = d.keys()
    keys.sort()
    for k in keys:
      key = _atval(k)
      key = "%s%s: " % (space(indent), key)
      fp.write(key)
      PrettyPrintVal(d[k], col=len(key), indent=indent, fp=fp)
      fp.write(',\n')
    indent -= 2
    fp.write("%s}" % (space(indent)))
    return indent + 1

def NetMsgs.NetMsgsBase.PrettyPrintList	(		l,
			col = 0,
			indent = 0,
			fp = sys.stderr
	)

Pretty print list.

    Parameters:
      l       - The list.
      col     - Current column position.
      indent  - Indentation.
      fp      - Opened file pointer.

    Return:
      New column position

Definition at line 584 of file NetMsgsBase.py.

References NetMsgs.NetMsgsBase.PrettyPrintVal(), and NetMsgs.NetMsgsBase.space.

Referenced by NetMsgs.NetMsgsBase.PrettyPrintVal().

def PrettyPrintList(l, col=0, indent=0, fp=sys.stderr):
  """ Pretty print list.

      Parameters:
        l       - The list.
        col     - Current column position.
        indent  - Indentation.
        fp      - Opened file pointer.

      Return:
        New column position
  """
  sp = _nspaces(col, indent)
  issimple = True
  for v in l:
    if (type(v) == dict) or (type(v) == list):
      issimple = False
      break
  if issimple:
    fp.write('%s[ ' % space(sp))
    col = col + sp + 2
    for v in l:
      if col > 60:  # heuristiccally 'safe'
        fp.write('\n%s  ' % space(indent))
        col = col + sp + 2
      col = PrettyPrintVal(v, col=col, indent=indent, fp=fp)
      fp.write(', ')
      col += 2
    fp.write(' ]')
    return col + 2
  else:
    fp.write('%s[\n' % space(sp))
    col = 0
    indent += 2
    for v in l:
      PrettyPrintVal(v, col=col, indent=indent, fp=fp)
      fp.write(',\n')
    indent -= 2
    fp.write("%s]" % (space(indent)))
    return indent + 1

def NetMsgs.NetMsgsBase.PrettyPrintVal	(		val,
			col = 0,
			indent = 0,
			fp = sys.stderr
	)

Pretty print value.

    Parameters:
      val     - Variable value.
      col     - Current column position.
      indent  - Indentation.
      fp      - Opened file pointer.

    Return:
      New column position

Definition at line 514 of file NetMsgsBase.py.

References NetMsgs.NetMsgsBase.PrettyPrintDict(), NetMsgs.NetMsgsBase.PrettyPrintList(), and NetMsgs.NetMsgsBase.space.

Referenced by NetMsgs.NetMsgsBase.PrettyPrintAssignExpr(), NetMsgs.NetMsgsBase.PrettyPrintDict(), and NetMsgs.NetMsgsBase.PrettyPrintList().

def PrettyPrintVal(val, col=0, indent=0, fp=sys.stderr):
  """ Pretty print value.

      Parameters:
        val     - Variable value.
        col     - Current column position.
        indent  - Indentation.
        fp      - Opened file pointer.

      Return:
        New column position
  """
  if type(val) == dict:
    return PrettyPrintDict(val, col=col, indent=indent, fp=fp)
  elif type(val) == list:
    return PrettyPrintList(val, col=col, indent=indent, fp=fp)
  else:
    sp = _nspaces(col, indent)
    v = _atval(val)
    fp.write("%s%s" % (space(sp), v))
    return col + sp + len(v)

def NetMsgs.NetMsgsBase.PrintBits	(		val,
			msbit,
			count = None,
			preface = '',
			fp = sys.stderr
	)

Pretty print bits in value to opened file stream. 

    Parameters:
      val     - Bits to print.
      msbit   - Starting most significant bit, zero based.
      count   - Number of bits to print (None = msbit+1).
      preface - Optional buffer preface string.
      fp      - Output file pointer.

Definition at line 446 of file NetMsgsBase.py.

def PrintBits(val, msbit, count=None, preface='', fp=sys.stderr):
  """ Pretty print bits in value to opened file stream. 

      Parameters:
        val     - Bits to print.
        msbit   - Starting most significant bit, zero based.
        count   - Number of bits to print (None = msbit+1).
        preface - Optional buffer preface string.
        fp      - Output file pointer.
  """
  if preface:
    s = "%s: " % (preface)
    fp.write(s)
  if count is None:
    count = msbit + 1
  i = 0
  while i < count:
    if ((msbit % 8) == 7) and (i > 0):
      fp.write(' ')
    if (val >> msbit) & 0x01:
      fp.write('1')
    else:
      fp.write('0')
    msbit -= 1
    i     += 1

def NetMsgs.NetMsgsBase.PrintBuf	(		buf,
			count = None,
			preface = '',
			nlfreq = None,
			indent = 0,
			col = 0,
			fp = sys.stderr
	)

Pretty print binary buffer to opened file stream.

    Parameters:
      buf     - Buffer to print.
      count   - Number of bytes to print.
      preface - Optional buffer preface string.
      nlfreq  - Newline frequency (None for no newlines).
      ident   - Indentation column alignment.
      col     - Current column position.
      fp      - Output file pointer.

Definition at line 413 of file NetMsgsBase.py.

References NetMsgs.NetMsgsBase.space.

Referenced by NetMsgs.NetMsgsBase.PrettyPrintCols().

                        fp=sys.stderr):
  """ Pretty print binary buffer to opened file stream.

      Parameters:
        buf     - Buffer to print.
        count   - Number of bytes to print.
        preface - Optional buffer preface string.
        nlfreq  - Newline frequency (None for no newlines).
        ident   - Indentation column alignment.
        col     - Current column position.
        fp      - Output file pointer.
  """
  if preface:
    s = "%s: " % (preface)
    col += len(s)
    fp.write(s)
  if count is None:
    count = len(buf)
  if (count > 0) and (col < indent):
    fp.write(space(indent-col))
  i = 0
  while i < count:
    c = buf[i]
    if nlfreq and ((i % nlfreq) == 0) and (i > 0):

      fp.write("\n%s" % space(indent))
      col = indent
    fp.write("0x%02x " % (ord(c)))
    i += 1
  fp.write('\n')

def NetMsgs.NetMsgsBase.StrError

(

ecode

)

Get the error string describing the NetMsgs 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     - NetMsgs error code.

    Return:
      The appropriate error code string.

Definition at line 323 of file NetMsgsBase.py.

def StrError(ecode):
  """ Get the error string describing the NetMsgs 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     - NetMsgs error code.

      Return:
        The appropriate error code string.
  """
  sErr = nmStrError(ecode)
  if not sErr:
    sErr = 'Error'
  return sErr

Variable Documentation

dictionary NetMsgs.NetMsgsBase.NMAliasMap

Initial value:

= {
    'byte': 'u8', 'schar': 's8', 'ushort': 'u16', 'short': 'u16',
    'uint': 'u32', 'int': 's32', 'ulonglong': 'u64', 'longlong': 's64',
    'pointer': 'p32', 'longpointer': 'p64', 'float': 'f32', 'double': 'f64',
}

The full set of XML ftype values.

Definition at line 246 of file NetMsgsBase.py.

dictionary NetMsgs.NetMsgsBase.NMBuiltInFieldTypes

Built-In message field types, keyed by XML field type name.

code - message field type byte code desc - short description flen - packed message field length (bytes) comp - complexity. one of: simple compound na T - C/C++ type specifier pre - member name prefix (quasi-Hungarian)

Definition at line 78 of file NetMsgsBase.py.

NetMsgs.NetMsgsBase.NMFCode = lambdaxmlftype:NMBuiltInFieldTypes[xmlftype]['code']

Get NetMsgs field type code given the XML field type.

Definition at line 243 of file NetMsgsBase.py.

dictionary NetMsgs.NetMsgsBase.NMFHdrLen

Initial value:

= {
    'flat': {'simple': 0, 'string': 0, 'struct': 0, 'vector': 0},
    'itv':  {
      'simple': NMITV_FHDR_SIZE_SIMPLE, 'string': NMITV_FHDR_SIZE_STRING,
      'struct': NMITV_FHDR_SIZE_STRUCT, 'vector': NMITV_FHDR_SIZE_VECTOR},
}

Field Header Lengths keyed by message encoding.

Definition at line 297 of file NetMsgsBase.py.

dictionary NetMsgs.NetMsgsBase.NMFTypeCode2Xml

Initial value:

= {
    NMFCode('bool'): 'bool',      NMFCode('char'): 'char',
    NMFCode('u8'): 'u8',          NMFCode('s8'): 's8',
    NMFCode('u16'): 'u16',        NMFCode('s16'): 's16',
    NMFCode('u32'): 'u32',        NMFCode('s32'): 's32',
    NMFCode('u64'): 'u64',        NMFCode('s64'): 's64',
    NMFCode('f32'): 'f32',        NMFCode('f64'): 'f64',
    NMFCode('p32'): 'p32',        NMFCode('p64'): 'p64',
    NMFCode('string'): 'string',  NMFCode('pad'): 'pad',  
    NMFCode('struct'): 'struct',  NMFCode('vector'): 'vector'
}

Field type code to XML file type map.

Definition at line 284 of file NetMsgsBase.py.

list NetMsgs.NetMsgsBase.NMFTypeCodeSimple

Initial value:

= [
    NMFCode('char'),  NMFCode('u8'),    NMFCode('s8'),    NMFCode('bool'),
    NMFCode('u16'),   NMFCode('s16'),   NMFCode('u32'),   NMFCode('s32'),
    NMFCode('u64'),   NMFCode('s64'),   NMFCode('f32'),   NMFCode('f64'),
    NMFCode('p32'),   NMFCode('p64') ]

List of simple field types by field type code.

Definition at line 267 of file NetMsgsBase.py.

list NetMsgs.NetMsgsBase.NMFTypeNumber

Initial value:

= [
      'u8', 's8', 'u16', 's16', 'u32', 's32', 'u64', 's64', 'f32', 'f64' ]

List of number field types by XML ftype.

Definition at line 280 of file NetMsgsBase.py.

list NetMsgs.NetMsgsBase.NMFTypeSimple

Initial value:

= [
    'char', 'u8', 's8', 'bool', 'u16', 's16', 'u32', 's32', 'u64',
    's64', 'f32', 'f64', 'p32', 'p64', ]

List of simple field types by XML ftype.

Definition at line 262 of file NetMsgsBase.py.