libxml2_xmlstring.h File Reference

Typedef xmlChar

typedef unsigned char

xmlChar

xmlChar:

This is a basic byte in an UTF-8 encoded string. It's unsigned allowing to pinpoint case where char * are assigned to xmlChar * (possibly making serialization back impossible).

BAD_CAST

BAD_CAST:

Macro to cast a string to an xmlChar * when one know its safe.

xmlStrdup ( const xmlChar * )

XMLPUBFUN xmlChar *XMLCALL

xmlStrdup

(

const xmlChar *

cur

)

xmlStrdup: a strdup for array of xmlChar's. Since they are supposed to be encoded in UTF-8 or an encoding with 8bit based chars, we assume a termination mark of '0'.

Returns a new xmlChar * or NULL

OOM: possible --> returns NULL for cur!=NULL and sets OOM flag

Parameters
cur	the input xmlChar *

xmlStrndup ( const xmlChar *, int )

XMLPUBFUN xmlChar *XMLCALL	xmlStrndup	(	const xmlChar *	cur,
			int	len
		)

xmlStrndup: a strndup for array of xmlChar's

Returns a new xmlChar* or NULL

OOM: possible --> returns NULL for (cup!=NULL && len>=0) and sets OOM flag

Parameters
cur	the input xmlChar*
len	the len of cur

xmlCharStrndup ( const char *, int )

XMLPUBFUN xmlChar *XMLCALL	xmlCharStrndup	(	const char *	cur,
			int	len
		)

xmlCharStrndup: a strndup for char's to xmlChar's

Returns a new xmlChar * or NULL

Parameters
cur	the input char *
len	the len of cur

xmlCharStrdup ( const char * )

XMLPUBFUN xmlChar *XMLCALL

xmlCharStrdup

(

const char *

cur

)

xmlCharStrdup: a strdup for char's to xmlChar's

Returns a new xmlChar * or NULL

Parameters
cur	the input char *

xmlStrsub ( const xmlChar *, int, int )

XMLPUBFUN xmlChar *XMLCALL	xmlStrsub	(	const xmlChar *	str,
			int	start,
			int	len
		)

xmlStrsub: Extract a substring of a given string

Returns the xmlChar * for the first occurrence or NULL.

Parameters
str	the xmlChar * array (haystack)
start	the index of the first char (zero based)
len	the length of the substring

xmlStrchr ( const xmlChar *, xmlChar )

XMLPUBFUN const xmlChar *XMLCALL	xmlStrchr	(	const xmlChar *	str,
			xmlChar	val
		)

xmlStrchr: a strchr for xmlChar's

Returns the xmlChar* for the first occurrence or NULL.

Parameters
str	the xmlChar * array
val	the xmlChar to search

xmlStrstr ( const xmlChar , const xmlChar )

XMLPUBFUN const xmlChar *XMLCALL	xmlStrstr	(	const xmlChar *	str,
			const xmlChar *	val
		)

xmlStrstr: a strstr for xmlChar's

Returns the xmlChar * for the first occurrence or NULL.

OOM: never

Parameters
str	the xmlChar * array (haystack)
val	the xmlChar to search (needle)

xmlStrcasestr ( const xmlChar , xmlChar )

XMLPUBFUN const xmlChar *XMLCALL	xmlStrcasestr	(	const xmlChar *	str,
			xmlChar *	val
		)

xmlStrcasestr: a case-ignoring strstr for xmlChar's

Returns the xmlChar * for the first occurrence or NULL.

Parameters
str	the xmlChar * array (haystack)
val	the xmlChar to search (needle)

xmlStrcmp ( const xmlChar , const xmlChar )

XMLPUBFUN int XMLCALL	xmlStrcmp	(	const xmlChar *	str1,
			const xmlChar *	str2
		)

xmlStrcmp: a strcmp for xmlChar's

Returns the integer result of the comparison

Parameters
str1	the first xmlChar *
str2	the second xmlChar *

xmlStrncmp ( const xmlChar , const xmlChar , int )

XMLPUBFUN int XMLCALL	xmlStrncmp	(	const xmlChar *	str1,
			const xmlChar *	str2,
			int	len
		)

xmlStrncmp: a strncmp for xmlChar's

Returns the integer result of the comparison

OOM: never

Parameters
str1	the first xmlChar *
str2	the second xmlChar *
len	the max comparison length

xmlStrcasecmp ( const xmlChar , const xmlChar )

XMLPUBFUN int XMLCALL	xmlStrcasecmp	(	const xmlChar *	str1,
			const xmlChar *	str2
		)

xmlStrcasecmp: a strcasecmp for xmlChar's

Returns the integer result of the comparison

Parameters
str1	the first xmlChar *
str2	the second xmlChar *

xmlStrncasecmp ( const xmlChar , const xmlChar , int )

XMLPUBFUN int XMLCALL	xmlStrncasecmp	(	const xmlChar *	str1,
			const xmlChar *	str2,
			int	len
		)

xmlStrncasecmp: a strncasecmp for xmlChar's

Returns the integer result of the comparison

Parameters
str1	the first xmlChar *
str2	the second xmlChar *
len	the max comparison length

xmlStrEqual ( const xmlChar , const xmlChar )

XMLPUBFUN int XMLCALL	xmlStrEqual	(	const xmlChar *	str1,
			const xmlChar *	str2
		)

xmlStrEqual: Check if both string are equal of have same content Should be a bit more readable and faster than xmlStrEqual()

Returns 1 if they are equal, 0 if they are different

OOM: never

Parameters
str1	the first xmlChar *
str2	the second xmlChar *

xmlStrQEqual ( const xmlChar , const xmlChar , const xmlChar * )

XMLPUBFUN int XMLCALL	xmlStrQEqual	(	const xmlChar *	pref,
			const xmlChar *	name,
			const xmlChar *	str
		)

xmlStrQEqual: Check if a QName is Equal to a given string

Returns 1 if they are equal, 0 if they are different

Parameters
pref	the prefix of the QName
name	the localname of the QName
str	the second xmlChar *

xmlStrlen ( const xmlChar * )

XMLPUBFUN int XMLCALL

xmlStrlen

(

const xmlChar *

str

)

xmlStrlen: length of a xmlChar's string

Returns the number of xmlChar contained in the ARRAY.

Parameters
str	the xmlChar * array

xmlStrcat ( xmlChar , const xmlChar )

XMLPUBFUN xmlChar *XMLCALL	xmlStrcat	(	xmlChar *	cur,
			const xmlChar *	add
		)

xmlStrcat: a strcat for array of xmlChar's. Since they are supposed to be encoded in UTF-8 or an encoding with 8bit based chars, we assume a termination mark of '0'.

Returns a new xmlChar* containing the concatenated string.

OOM: possible --> OOM flag is set

Parameters
cur	the original xmlChar* array
add	the xmlChar* array added

xmlStrncat ( xmlChar , const xmlChar , int )

XMLPUBFUN xmlChar *XMLCALL	xmlStrncat	(	xmlChar *	cur,
			const xmlChar *	add,
			int	len
		)

xmlStrncat: a strncat for array of xmlChar's, it will extend cur with the len first bytes of add.

Returns a new xmlChar*, the original cur is reallocated if needed and should not be freed

OOM: possible --> OOM flag is set

Parameters
cur	the original xmlChar* array
add	the xmlChar* array added
len	the length of add

xmlStrncatNew ( const xmlChar , const xmlChar , int )

XMLPUBFUN xmlChar *XMLCALL	xmlStrncatNew	(	const xmlChar *	str1,
			const xmlChar *	str2,
			int	len
		)

xmlStrncatNew: same as xmlStrncat, but creates a new string. The original two strings are not freed.

Returns a new xmlChar* or NULL

OOM: possible --> returns NULL, sets OOM flag

Parameters
str1	first xmlChar string
str2	second xmlChar string
len	the len of str2

xmlStrPrintf ( xmlChar , int, const xmlChar , ... )

XMLPUBFUN int XMLCALL	xmlStrPrintf	(	xmlChar *	buf,
			int	len,
			const xmlChar *	msg,
			...
		)

xmlStrPrintf: Formats msg and places result into buf.

Returns the number of characters written to buf or -1 if an error occurs.

Parameters
buf	the result buffer.
len	the result buffer length.
msg	the message with printf formatting.
	extra parameters for the message.

xmlStrVPrintf ( xmlChar , int, const xmlChar , va_list )

XMLPUBFUN int XMLCALL	xmlStrVPrintf	(	xmlChar *	buf,
			int	len,
			const xmlChar *	msg,
			va_list	ap
		)

xmlStrVPrintf: Formats msg and places result into buf.

Returns the number of characters written to buf or -1 if an error occurs.

Parameters
buf	the result buffer.
len	the result buffer length.
msg	the message with printf formatting.
ap	extra parameters for the message.

xmlGetUTF8Char ( const unsigned char , int )

XMLPUBFUN int XMLCALL	xmlGetUTF8Char	(	const unsigned char *	utf,
			int *	len
		)

xmlGetUTF8Char: Read one UTF8 Char from utf

Returns the char value or -1 in case of error, and updates *len with the number of bytes consumed

Parameters
utf	a sequence of UTF-8 encoded bytes
len	a pointer to bytes len

xmlCheckUTF8 ( const unsigned char * )

XMLPUBFUN int XMLCALL

xmlCheckUTF8

(

const unsigned char *

utf

)

xmlCheckUTF8: Checks utf for being valid UTF-8. utf is assumed to be null-terminated. This function is not super-strict, as it will allow longer UTF-8 sequences than necessary. Note that Java is capable of producing these sequences if provoked. Also note, this routine checks for the 4-byte maximum size, but does not check for 0x10ffff maximum value.

Return value: true if utf is valid.

Parameters
utf	Pointer to putative UTF-8 encoded string.

xmlUTF8Strsize ( const xmlChar *, int )

XMLPUBFUN int XMLCALL	xmlUTF8Strsize	(	const xmlChar *	utf,
			int	len
		)

xmlUTF8Strsize: storage size of an UTF8 string

Returns the storage size of the first 'len' characters of ARRAY

Parameters
utf	a sequence of UTF-8 encoded bytes
len	the number of characters in the array

xmlUTF8Strndup ( const xmlChar *, int )

XMLPUBFUN xmlChar *XMLCALL	xmlUTF8Strndup	(	const xmlChar *	utf,
			int	len
		)

xmlUTF8Strndup: a strndup for array of UTF8's

Returns a new UTF8 * or NULL

Parameters
utf	the input UTF8 *
len	the len of utf (in chars)

xmlUTF8Strpos ( const xmlChar *, int )

XMLPUBFUN xmlChar *XMLCALL	xmlUTF8Strpos	(	const xmlChar *	utf,
			int	pos
		)

xmlUTF8Strpos: a function to provide the equivalent of fetching a character from a string array

Returns a pointer to the UTF8 character or NULL

Parameters
utf	the input UTF8 *
pos	the position of the desired UTF8 char (in chars)

xmlUTF8Strloc ( const xmlChar , const xmlChar )

XMLPUBFUN int XMLCALL	xmlUTF8Strloc	(	const xmlChar *	utf,
			const xmlChar *	utfchar
		)

xmlUTF8Strloc: a function to provide the relative location of a UTF8 char

Returns the relative character position of the desired char or -1 if not found

Parameters
utf	the input UTF8 *
utfchar	the UTF8 character to be found

xmlUTF8Strsub ( const xmlChar *, int, int )

XMLPUBFUN xmlChar *XMLCALL	xmlUTF8Strsub	(	const xmlChar *	utf,
			int	start,
			int	len
		)

xmlUTF8Strsub: Create a substring from a given UTF-8 string Note: positions are given in units of UTF-8 chars

Returns a pointer to a newly created string or NULL if any problem

Parameters
utf	a sequence of UTF-8 encoded bytes
start	relative pos of first char
len	total number to copy

xmlUTF8Strlen ( const xmlChar * )

XMLPUBFUN int XMLCALL

xmlUTF8Strlen

(

const xmlChar *

utf

)

xmlUTF8Strlen: compute the length of an UTF8 string, it doesn't do a full UTF8 checking of the content of the string.

Returns the number of characters in the string or -1 in case of error

OOM: never

Parameters
utf	a sequence of UTF-8 encoded bytes

xmlUTF8Size ( const xmlChar * )

XMLPUBFUN int XMLCALL

xmlUTF8Size

(

const xmlChar *

utf

)

xmlUTF8Size: calculates the internal size of a UTF8 character

returns the numbers of bytes in the character, -1 on format error

Parameters
utf	pointer to the UTF8 character

xmlUTF8Charcmp ( const xmlChar , const xmlChar )

XMLPUBFUN int XMLCALL	xmlUTF8Charcmp	(	const xmlChar *	utf1,
			const xmlChar *	utf2
		)

xmlUTF8Charcmp: compares the two UCS4 values

returns result of the compare as with xmlStrncmp

Parameters
utf1	pointer to first UTF8 char
utf2	pointer to second UTF8 char

libxml2_xmlstring.h File Reference

Typedef xmlChar

BAD_CAST

xmlStrdup ( const xmlChar * )

xmlStrndup ( const xmlChar *, int )

xmlCharStrndup ( const char *, int )

xmlCharStrdup ( const char * )

xmlStrsub ( const xmlChar *, int, int )

xmlStrchr ( const xmlChar *, xmlChar )

xmlStrstr ( const xmlChar *, const xmlChar * )

xmlStrcasestr ( const xmlChar *, xmlChar * )

xmlStrcmp ( const xmlChar *, const xmlChar * )

xmlStrncmp ( const xmlChar *, const xmlChar *, int )

xmlStrcasecmp ( const xmlChar *, const xmlChar * )

xmlStrncasecmp ( const xmlChar *, const xmlChar *, int )

xmlStrEqual ( const xmlChar *, const xmlChar * )

xmlStrQEqual ( const xmlChar *, const xmlChar *, const xmlChar * )

xmlStrlen ( const xmlChar * )

xmlStrcat ( xmlChar *, const xmlChar * )

xmlStrncat ( xmlChar *, const xmlChar *, int )

xmlStrncatNew ( const xmlChar *, const xmlChar *, int )

xmlStrPrintf ( xmlChar *, int, const xmlChar *, ... )

xmlStrVPrintf ( xmlChar *, int, const xmlChar *, va_list )

xmlGetUTF8Char ( const unsigned char *, int * )

xmlCheckUTF8 ( const unsigned char * )

xmlUTF8Strsize ( const xmlChar *, int )

xmlUTF8Strndup ( const xmlChar *, int )

xmlUTF8Strpos ( const xmlChar *, int )

xmlUTF8Strloc ( const xmlChar *, const xmlChar * )

xmlUTF8Strsub ( const xmlChar *, int, int )

xmlUTF8Strlen ( const xmlChar * )

xmlUTF8Size ( const xmlChar * )

xmlUTF8Charcmp ( const xmlChar *, const xmlChar * )

xmlStrstr ( const xmlChar , const xmlChar )

xmlStrcasestr ( const xmlChar , xmlChar )

xmlStrcmp ( const xmlChar , const xmlChar )

xmlStrncmp ( const xmlChar , const xmlChar , int )

xmlStrcasecmp ( const xmlChar , const xmlChar )

xmlStrncasecmp ( const xmlChar , const xmlChar , int )

xmlStrEqual ( const xmlChar , const xmlChar )

xmlStrQEqual ( const xmlChar , const xmlChar , const xmlChar * )

xmlStrcat ( xmlChar , const xmlChar )

xmlStrncat ( xmlChar , const xmlChar , int )

xmlStrncatNew ( const xmlChar , const xmlChar , int )

xmlStrPrintf ( xmlChar , int, const xmlChar , ... )

xmlStrVPrintf ( xmlChar , int, const xmlChar , va_list )

xmlGetUTF8Char ( const unsigned char , int )

xmlUTF8Strloc ( const xmlChar , const xmlChar )

xmlUTF8Charcmp ( const xmlChar , const xmlChar )