Define CNString class. More...

#include "CNObject.h"
#include "CNList.h"
#include <stdint.h>
#include <string.h>
#include <stdio.h>

Classes
struct	CNStringMethods
	Methods for CNString. More...

struct	CNString
	Fixed size string class. More...

Typedefs
typedef void(*	CNVisitStringElementFuncRef )(size_t elmlen, const unsigned char elmstr, void info)

Functions
struct CNString *	CNAllocateStringWithCString (size_t len, const unsigned char str, struct CNResource resource)
	Allocate CNString object. More...

struct CNString *	CNAllocateEmptyString (struct CNResource *resource)
	Allocate empty string. More...

static void	CNRetainString (struct CNString *dst)
	Retain CNString object. More...

static void	CNReleaseString (struct CNString *dst)
	Release CNString object. More...

static size_t	CNLengthOfString (const struct CNString *src)
	Get length of the string. More...

static uint64_t	CNHashValueOfString (const struct CNString *src)
	Get hash value of source string. More...

static struct CNObject *	CNObjectOfString (struct CNString *src)
	Get super class of CNString. More...

struct CNString *	CNCopyString (struct CNString *src)
	Allocate the copy of string. More...

void	CNAppendStringToString (struct CNString dst, struct CNString src)
	Append context of source string into destination. More...

void	CNAppendCStringToString (struct CNString dst, size_t len, const unsigned char src)
	Append C-String to String. More...

static struct CNString *	CNAddStrings (struct CNString src0, struct CNString src1)
	Allocate added string. More...

void	CNMoveStringToString (struct CNString dst, struct CNString src)
	Move context of source string into destination. More...

struct CNString *	CNPrintToString (struct CNResource resource, const char format,...)
	Allocate string with printf format. More...

void	CNPutStringToCString (unsigned char dst, const struct CNString src)
	Put context of string into buffer. More...

void	CNPrintString (FILE fp, const struct CNString src)
	Put context of string into file stream. More...

CNBoolean	CNIsSameStrings (const struct CNString src0, const struct CNString src1)
	Compare CNStrings. More...

CNBoolean	CNIsSameStringAndCString (const struct CNString src0, size_t len1, const unsigned char src1)
	Compare CNString and C-String. More...

void	CNVisitStringElements (const struct CNString src, CNVisitStringElementFuncRef func, void info)
	Visit all elements in the string. More...

struct CNMemoryProfile	CNProfileOfString (const struct CNString *src)
	Get memory profile of string. More...

Detailed Description

Define CNString class.

Copyright: Copyright (C) 2012 Steel Wheels Project

Typedef Documentation

typedef void(* CNVisitStringElementFuncRef)(size_t elmlen, const unsigned char *elmstr, void *info)

Function to visit all elements in CNString

Function Documentation

struct CNString* CNAllocateStringWithCString	(	size_t	len,
		const unsigned char *	str,
		struct CNResource *	resource
	)

Allocate CNString object.

Return values

str	Allocated string
NULL	Allocation failed

Parameters

len	Length of source string
str	Source string
resource	Resource to allocate the string object.

Note: If you passed 0 length string, the context will be NULL.

struct CNString* CNAllocateEmptyString ( struct CNResource * resource )

Allocate empty string.

Return values

str	Allocated string
NULL	Allocation failed

Parameters

resource Resource to allocate the string object

static void CNRetainString ( struct CNString * dst )

inlinestatic

Retain CNString object.

Parameters

dst	Destination string object

References CNRetainObject(), and CNString::superClass.

static void CNReleaseString ( struct CNString * dst )

inlinestatic

Release CNString object.

Parameters

dst	Destination string object

References CNReleaseObject(), and CNString::superClass.

static size_t CNLengthOfString ( const struct CNString * src )

inlinestatic

Get length of the string.

Returns: Length of the string

Parameters

src	Source string

References CNString::length.

static uint64_t CNHashValueOfString ( const struct CNString * src )

inlinestatic

Get hash value of source string.

Returns: Hash value

Parameters

src	Source string

References CNString::hashValue.

static struct CNObject* CNObjectOfString ( struct CNString * src )

static

Get super class of CNString.

Returns: Super class

Parameters

src	Source string

References CNString::superClass.

struct CNString* CNCopyString ( struct CNString * src )

Allocate the copy of string.

Returns: Copied string

Parameters

src	Source string

Referenced by CNAddStrings().

void CNAppendStringToString	(	struct CNString *	dst,
		struct CNString *	src
	)

Append context of source string into destination.

Parameters

dst	Destination string
src	Source string

Referenced by CNAddStrings().

void CNAppendCStringToString	(	struct CNString *	dst,
		size_t	len,
		const unsigned char *	src
	)

Append C-String to String.

Parameters

dst	Destination string
len	Length of source string
src	Source string

static struct CNString* CNAddStrings	(	struct CNString *	src0,
		struct CNString *	src1
	)

static

Allocate added string.

Returns: Allocated string

Parameters

src0	Source string 0
src1	Source string 1

References CNAppendStringToString(), and CNCopyString().

void CNMoveStringToString	(	struct CNString *	dst,
		struct CNString *	src
	)

Move context of source string into destination.

Parameters

dst	Destination string
src	Source string

Note: Source string will be empty after call this function

struct CNString* CNPrintToString	(	struct CNResource *	resource,
		const char *	format,
			...
	)

Allocate string with printf format.

Returns: Allocated string

Parameters

resource	Resource to allocate the string
format	Print format

void CNPutStringToCString	(	unsigned char *	dst,
		const struct CNString *	src
	)

Put context of string into buffer.

Parameters

dst	Destination buffer
src	Source string

Warning: The size of buffer must be bigger than the length of source string which is given by CNLengthOfString() + 1.

void CNPrintString	(	FILE *	fp,
		const struct CNString *	src
	)

Put context of string into file stream.

Parameters

fp	Destination file stream
src	Source string

CNBoolean CNIsSameStrings	(	const struct CNString *	src0,
		const struct CNString *	src1
	)

Compare CNStrings.

Return values

TRUE	They have same context
FALSE	They have different context

Parameters

src0	Source string 0
src1	Source string 1

CNBoolean CNIsSameStringAndCString	(	const struct CNString *	src0,
		size_t	len1,
		const unsigned char *	src1
	)

Compare CNString and C-String.

Return values

TRUE	They have same context
FALSE	They have different context

Parameters

src0	Source string 0
len1	Length of source string 1
src1	Source string 1

void CNVisitStringElements	(	const struct CNString *	src,
		CNVisitStringElementFuncRef	func,
		void *	info
	)

Visit all elements in the string.

Parameters

src	Source string
func	Visit function for each elements
info	User defined parameter, this is passed to the visit function

struct CNMemoryProfile CNProfileOfString ( const struct CNString * src )

Get memory profile of string.

Returns: Profile of source string

Parameters

src	Source string

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

Function Documentation