CNFixedString.h File Reference

Define CNFixedString class. More...

#include "CNType.h"
#include "CNMemoryProfile.h"
#include <stdint.h>
#include <string.h>
#include <stdio.h>

Go to the source code of this file.

Classes
struct	CNFixedString
	Persistent string. There are only one object for each context of string. More...

Typedefs
typedef CNBoolean(*	CNVisitFixedStringPoolFuncRef )(const struct CNFixedString *str, void *userdata)

Functions
void	CNSetupFixedStringPool (void)
	Initialize pool for CNFixedString. More...
struct CNFixedString *	CNAllocateFixedString (size_t len, const unsigned char *str)
	Allocate CNFixedString object. More...
static size_t	CNLengthOfFixedString (const struct CNFixedString *src)
	Get length of CNFixedString. More...
static const unsigned char *	CNContentOfFixedString (const struct CNFixedString *src)
	Get content of CNFixedString. More...
static uint64_t	CNUniqueIdOfFixedString (const struct CNFixedString *src)
	Get hash value of CNFixedString. More...
static CNBoolean	CNIsSameFixedString (const struct CNFixedString *s0, const struct CNFixedString *s1)
	Check 2 string has same context or not. More...
CNBoolean	CNForeachFixedStringInFixedStringPool (CNVisitFixedStringPoolFuncRef visitfunc, void *userdata)
	Get all fixed string in fixed string pool. More...
struct CNFixedString *	CNSearchFixedStringById (uint64_t src)
	Search fixed-string in pool by the id. More...
struct CNFixedString *	CNSearchFixedStringByUTF8String (size_t srclen, const unsigned char *srcstr)
	Search fixed-string in pool by the string. More...
void	CNPrintFixedString (FILE *outfp, const struct CNFixedString *src)
	Print fixed-string. More...
struct CNMemoryProfile	CNProfileOfFixedStringPool (void)
	Get memory usage information. More...

Detailed Description

Define CNFixedString class.

Copyright

Copyright (C) 2012 Steel Wheels Project

Typedef Documentation

typedef CNBoolean(* CNVisitFixedStringPoolFuncRef)(const struct CNFixedString *str, void *userdata)

Function to visit fixed-string pool and get fixed-string from it

Function Documentation

void CNSetupFixedStringPool

(

void

)

Initialize pool for CNFixedString.

Note

You have to call this method before using CNFixedString

struct CNFixedString* CNAllocateFixedString	(	size_t	len,
		const unsigned char *	str
	)

Allocate CNFixedString object.

Returns

Allocated string

Parameters

len	Length of source string
str	Source string

static size_t CNLengthOfFixedString ( const struct CNFixedString *  src )

inlinestatic

Get length of CNFixedString.

Returns

Length of string

Parameters

src	Source string

References CNFixedString::length.

Referenced by CNPutFixedStringToText().

static const unsigned char* CNContentOfFixedString ( const struct CNFixedString *  src )

inlinestatic

Get content of CNFixedString.

Returns

Content of string

Parameters

src	Source string

References CNFixedString::content.

Referenced by CNPutFixedStringToText().

static uint64_t CNUniqueIdOfFixedString ( const struct CNFixedString *  src )

inlinestatic

Get hash value of CNFixedString.

Returns

Hash value of string

Parameters

src	Source string

References CNFixedString::uniqId.

static CNBoolean CNIsSameFixedString ( const struct CNFixedString *  s0, const struct CNFixedString *  s1  )

inlinestatic

Check 2 string has same context or not.

Return values

TRUE	They have same contexts.
FALSE	They have different contexts

Parameters

s0	Source string 0
s1	Source string 1

CNBoolean CNForeachFixedStringInFixedStringPool	(	CNVisitFixedStringPoolFuncRef	visitfunc,
		void *	userdata
	)

Get all fixed string in fixed string pool.

Return values

TRUE	Every elements are visited
FALSE	Every elements are NOT visited

Parameters

visitfunc	Function to visit each fixed string
userdata	Data pointer to be used in the visit function

struct CNFixedString* CNSearchFixedStringById

(

uint64_t

src

)

Search fixed-string in pool by the id.

Return values

str	The string which has the id
NULL	There are no string which has the id

Parameters

src	Source fixed-string id

struct CNFixedString* CNSearchFixedStringByUTF8String	(	size_t	srclen,
		const unsigned char *	srcstr
	)

Search fixed-string in pool by the string.

Return values

str	The string which has the id
NULL	There are no string which has the id

Parameters

srclen	Length of source string
srcstr	Source UTF8 string

void CNPrintFixedString	(	FILE *	outfp,
		const struct CNFixedString *	src
	)

Print fixed-string.

Parameters

outfp	Output file stream
src	Source fixed-string

struct CNMemoryProfile CNProfileOfFixedStringPool

(

void

)

Get memory usage information.

Returns

Profile of memory