strobj.c File Reference

String Object Type. More...

#include "pm.h"

Go to the source code of this file.

Defines

#define __FILE_ID__   0x12

Functions

PmReturn_t string_create (PmMemSpace_t memspace, uint8_t const **paddr, int16_t len, int16_t n, pPmObj_t *r_pstring)
PmReturn_t string_newFromChar (uint8_t const c, pPmObj_t *r_pstring)
int8_t string_compare (pPmString_t pstr1, pPmString_t pstr2)
PmReturn_t string_cacheInit (void)
PmReturn_t string_getCache (pPmString_t **r_ppstrcache)
PmReturn_t string_concat (pPmString_t pstr1, pPmString_t pstr2, pPmObj_t *r_pstring)

Variables

static pPmString_t pstrcache = C_NULL


Detailed Description

String Object Type.

String object type opeartions.

Definition in file strobj.c.


Function Documentation

PmReturn_t string_cacheInit ( void   ) 

Clears the string cache if one exists. Called by heap_init()

Returns:
Return status

Definition at line 243 of file strobj.c.

int8_t string_compare ( pPmString_t  pstr1,
pPmString_t  pstr2 
)

Compares two String objects for equality.

Parameters:
pstr1 Ptr to first string
pstr2 Ptr to second string
Returns:
C_SAME if the strings are equivalent, C_DIFFER otherwise

Definition at line 146 of file strobj.c.

PmReturn_t string_concat ( pPmString_t  pstr1,
pPmString_t  pstr2,
pPmObj_t r_pstring 
)

Returns a new string object that is the concatenation of the two given strings.

Parameters:
pstr1 First source string
pstr2 Second source string
r_pstring Return arg; ptr to new string object
Returns:
Return status

Definition at line 265 of file strobj.c.

PmReturn_t string_create ( PmMemSpace_t  memspace,
uint8_t const **  paddr,
int16_t  len,
int16_t  n,
pPmObj_t r_pstring 
)

Creates a new String obj. If len is less than zero, load from a String image. If len is zero, copy from a C string (which has a null terminator) If len is positive, copy as many chars as given in the len argument A string image has the following structure: -type: int8 - OBJ_TYPE_STRING -length: uint16 - number of bytes in the string -val: uint8[] - array of chars with null term

Returns by reference a ptr to String obj.

Obtain space for String from the heap. Copy string from memspace. Leave contents of paddr pointing one byte past end of str.

THE PROGRAMMER SHOULD NOT CALL THIS FUNCTION DIRECTLY. Instead, use one of the two macros string_loadFromImg() or string_new().

Parameters:
memspace memory space where *paddr points
paddr ptr to ptr to null term character array or image.
len length of the C character array (use -1 for string images, 0 for C strings)
n Number of times to replicate the given string argument
r_pstring Return by reference; ptr to String obj
Returns:
Return status

Definition at line 43 of file strobj.c.

PmReturn_t string_getCache ( pPmString_t **  r_ppstrcache  ) 

Returns a pointer to the base of the string cache

Definition at line 253 of file strobj.c.

PmReturn_t string_newFromChar ( uint8_t const   c,
pPmObj_t r_pstring 
)

Creates a new String object from a single character.

Parameters:
c The character to become the string
r_pstring Return by reference; ptr to String obj
Returns:
Return status

Definition at line 123 of file strobj.c.


Variable Documentation

pPmString_t pstrcache = C_NULL [static]

String obj cachche: a list of all string objects.

Definition at line 32 of file strobj.c.


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