Characters (CHAR)


Defines

#define CHARnibbles(src)   (7)
 The size of a CHAR in nibbles.

Functions

bool isCHAR (SatAddr src)
 is object a CHAR?
bool CHARdecode (SatAddr src, char *dst)
 Convert CHAR to C character.
SatAddr CHARencode (unsigned char ch, SatAddr dst)
 Convert a C char to an CHAR object.
SatAddr makeCHAR ()
 Create a new CHAR in tempOb. It's value is undefined.

Detailed Description

A CHAR is a single ASCII character

Define Documentation

#define CHARnibbles ( src   )     (7)

The size of a CHAR in nibbles.

Parameters:
src Saturn address of the CHAR. Although unnecessary, the parameter is included for consistency
Returns:
Always returns 7


Function Documentation

bool CHARdecode ( SatAddr  src,
char *  dst 
)

Convert CHAR to C character.

Parameters:
src The CHAR to decode
dst Where to store the CHAR's value
Returns:
true on success, false if src doesn't contain a CHAR

SatAddr CHARencode ( unsigned char  ch,
SatAddr  dst 
)

Convert a C char to an CHAR object.

Parameters:
src The ASCII character to convert.
dst Where to store the CHAR. If zero then a new CHAR is created.
Returns:
The CHAR's Saturn address.

bool isCHAR ( SatAddr  src  ) 

is object a CHAR?

Parameters:
src Saturn address of an object
Returns:
true if the object at src is a CHAR


Generated on Sat Apr 3 16:38:31 2010 for HPObjects by  doxygen 1.5.0