strobj.c File Reference

String Object Type. More...

#include "pm.h"

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)

---

Detailed Description

String Object Type.

String object type opeartions.

---

Function Documentation

PmReturn_t string_cacheInit

(

void

)

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

Returns:

Return status

int8_t string_compare	(	pPmString_t	,
		pPmString_t
	)

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

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

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)
	Return	arg; ptr to String obj

Returns:

Return status

PmReturn_t string_getCache

(

pPmString_t **

r_ppstrcache

)

Returns a pointer to the base of the string cache

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_psting	Return arg; ptr to String obj

Returns:

Return status