tuple.c File Reference

Tuple Object Type. More...

#include "pm.h"

Go to the source code of this file.

Defines

#define __FILE_ID__   0x13
#define MAX_TUPLE_LEN   253

Functions

PmReturn_t tuple_loadFromImg (PmMemSpace_t memspace, uint8_t const **paddr, pPmObj_t *r_ptuple)
PmReturn_t tuple_new (uint16_t n, pPmObj_t *r_ptuple)
PmReturn_t tuple_replicate (pPmObj_t ptup, int16_t n, pPmObj_t *r_ptuple)
PmReturn_t tuple_getItem (pPmObj_t ptup, int16_t index, pPmObj_t *r_pobj)


Detailed Description

Tuple Object Type.

Tuple object type operations.

Definition in file tuple.c.


Function Documentation

PmReturn_t tuple_getItem ( pPmObj_t  ptup,
int16_t  index,
pPmObj_t r_pobj 
)

Gets the object in the tuple at the index.

Parameters:
ptup Ptr to tuple obj
index Index into tuple
r_pobj Return by reference; ptr to item
Returns:
Return status

Definition at line 137 of file tuple.c.

PmReturn_t tuple_loadFromImg ( PmMemSpace_t  memspace,
uint8_t const **  paddr,
pPmObj_t r_ptuple 
)

Creates a Tuple by loading a tuple image from memory.

Obtain space for tuple from the heap. Load all objs within the tuple img. Leave contents of paddr pointing one byte past end of last obj in tuple.

The tuple image has the following structure: -type: S8 - OBJ_TYPE_TUPLE -length U8 - N number of objects in the tuple. N objects follow in the stream.

Parameters:
memspace Memory space.
paddr Ptr to ptr to tuple in memspace
r_ptuple Return by reference; new filled tuple
Returns:
Return status

Definition at line 36 of file tuple.c.

PmReturn_t tuple_new ( uint16_t  n,
pPmObj_t r_ptuple 
)

Allocates space for a new Tuple. Returns a pointer to the tuple.

Parameters:
n the number of elements the tuple will contain
r_ptuple Return by ref, ptr to new tuple
Returns:
Return status

Definition at line 73 of file tuple.c.

PmReturn_t tuple_replicate ( pPmObj_t  ptup,
int16_t  n,
pPmObj_t r_ptuple 
)

Replicates a tuple, n number of times to create a new tuple

Copies the pointers (not the objects).

Parameters:
ptup Ptr to source tuple.
n Number of times to replicate the tuple.
r_ptuple Return arg; Ptr to new tuple.
Returns:
Return status

Definition at line 102 of file tuple.c.


Generated on Mon Oct 18 07:40:49 2010 for Python-on-a-chip by  doxygen 1.5.9