Flash Pointer (FLASHP)


Defines

#define FLASHPnibbles(src)   (12)
 The size of a FLASHP in nibbles.

Functions

bool isFLASHP (SatAddr src)
 is object a FLASHP?
bool FLASHPdecode (SatAddr src, int *a, int *b)
 Decode FLASHP into it's components.
SatAddr FLASHPencode (int a, int b, SatAddr dst)
 Convert two C integers into an HP FLASHP object.
SatAddr makeFLASHP ()
 Create a new FLASHP in tempOb. It's value is undefined.

Detailed Description

A Flash Pointer contains two binary numbers, a 12 bit "Pointer to table A" and a 16 bit "pointer to table B."

Define Documentation

#define FLASHPnibbles ( src   )     (12)

The size of a FLASHP in nibbles.

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


Function Documentation

bool FLASHPdecode ( SatAddr  src,
int *  a,
int *  b 
)

Decode FLASHP into it's components.

Parameters:
src The FLASHP to decode
a If non-null, the pointer to table A will be stored here
b If non-null, the pointer to table B will be stored here
Returns:
true on success, false if src doesn't contain a FLASHP

SatAddr FLASHPencode ( int  a,
int  b,
SatAddr  dst 
)

Convert two C integers into an HP FLASHP object.

Parameters:
a The pointer to table A. This must be between 0x0 and 0xfff
b The pointer to table B. This must be between 0x0 and 0xffff
dst Where to store the FLASHP. If zero, then a new FLASHP is created in tempOb.
Returns:
The FLASHP's Saturn address, or zero if a or b is out of range, or if it can't allocate a new FLASHP

bool isFLASHP ( SatAddr  src  ) 

is object a FLASHP?

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


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