deps/src/libxml2-2.9.1/doc/devhelp/libxml2-xmlstring.html
| | | | | libxml2 Reference Manual |
xmlstring - set of routines to process strings
type and interfaces needed for the internal string handling of the library, especially UTF8 processing.
Author(s): Daniel Veillard
#define[BAD\_CAST](#BAD_CAST);
typedef unsigned char[xmlChar](#xmlChar);
int[xmlStrcmp](#xmlStrcmp)(const[xmlChar](libxml2-xmlstring.html#xmlChar)* str1,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* str2);[xmlChar](libxml2-xmlstring.html#xmlChar)*[xmlCharStrndup](#xmlCharStrndup)(const char * cur,
int len);
const[xmlChar](libxml2-xmlstring.html#xmlChar)*[xmlStrcasestr](#xmlStrcasestr)(const[xmlChar](libxml2-xmlstring.html#xmlChar)* str,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* val);[xmlChar](libxml2-xmlstring.html#xmlChar)*[xmlStrcat](#xmlStrcat)([xmlChar](libxml2-xmlstring.html#xmlChar)* cur,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* add);
int[xmlStrPrintf](#xmlStrPrintf)([xmlChar](libxml2-xmlstring.html#xmlChar)* buf,
int len,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* msg,
... ...);
const[xmlChar](libxml2-xmlstring.html#xmlChar)*[xmlStrstr](#xmlStrstr)(const[xmlChar](libxml2-xmlstring.html#xmlChar)* str,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* val);
int[xmlUTF8Size](#xmlUTF8Size)(const[xmlChar](libxml2-xmlstring.html#xmlChar)* utf);
int[xmlStrQEqual](#xmlStrQEqual)(const[xmlChar](libxml2-xmlstring.html#xmlChar)* pref,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* name,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* str);[xmlChar](libxml2-xmlstring.html#xmlChar)*[xmlStrncatNew](#xmlStrncatNew)(const[xmlChar](libxml2-xmlstring.html#xmlChar)* str1,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* str2,
int len);
const[xmlChar](libxml2-xmlstring.html#xmlChar)*[xmlUTF8Strpos](#xmlUTF8Strpos)(const[xmlChar](libxml2-xmlstring.html#xmlChar)* utf,
int pos);[xmlChar](libxml2-xmlstring.html#xmlChar)*[xmlStrdup](#xmlStrdup)(const[xmlChar](libxml2-xmlstring.html#xmlChar)* cur);[xmlChar](libxml2-xmlstring.html#xmlChar)*[xmlCharStrdup](#xmlCharStrdup)(const char * cur);
const[xmlChar](libxml2-xmlstring.html#xmlChar)*[xmlStrchr](#xmlStrchr)(const[xmlChar](libxml2-xmlstring.html#xmlChar)* str,
[xmlChar](libxml2-xmlstring.html#xmlChar)val);
int[xmlStrlen](#xmlStrlen)(const[xmlChar](libxml2-xmlstring.html#xmlChar)* str);
int[xmlStrncmp](#xmlStrncmp)(const[xmlChar](libxml2-xmlstring.html#xmlChar)* str1,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* str2,
int len);[xmlChar](libxml2-xmlstring.html#xmlChar)*[xmlStrsub](#xmlStrsub)(const[xmlChar](libxml2-xmlstring.html#xmlChar)* str,
int start,
int len);[xmlChar](libxml2-xmlstring.html#xmlChar)*[xmlStrncat](#xmlStrncat)([xmlChar](libxml2-xmlstring.html#xmlChar)* cur,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* add,
int len);
int[xmlGetUTF8Char](#xmlGetUTF8Char)(const unsigned char * utf,
int * len);
int[xmlStrcasecmp](#xmlStrcasecmp)(const[xmlChar](libxml2-xmlstring.html#xmlChar)* str1,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* str2);[xmlChar](libxml2-xmlstring.html#xmlChar)*[xmlStrndup](#xmlStrndup)(const[xmlChar](libxml2-xmlstring.html#xmlChar)* cur,
int len);
int[xmlStrVPrintf](#xmlStrVPrintf)([xmlChar](libxml2-xmlstring.html#xmlChar)* buf,
int len,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* msg,
va_list ap);
int[xmlUTF8Strsize](#xmlUTF8Strsize)(const[xmlChar](libxml2-xmlstring.html#xmlChar)* utf,
int len);
int[xmlCheckUTF8](#xmlCheckUTF8)(const unsigned char * utf);
int[xmlStrncasecmp](#xmlStrncasecmp)(const[xmlChar](libxml2-xmlstring.html#xmlChar)* str1,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* str2,
int len);
int[xmlUTF8Strlen](#xmlUTF8Strlen)(const[xmlChar](libxml2-xmlstring.html#xmlChar)* utf);[xmlChar](libxml2-xmlstring.html#xmlChar)*[xmlUTF8Strsub](#xmlUTF8Strsub)(const[xmlChar](libxml2-xmlstring.html#xmlChar)* utf,
int start,
int len);
int[xmlStrEqual](#xmlStrEqual)(const[xmlChar](libxml2-xmlstring.html#xmlChar)* str1,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* str2);
int[xmlUTF8Charcmp](#xmlUTF8Charcmp)(const[xmlChar](libxml2-xmlstring.html#xmlChar)* utf1,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* utf2);[xmlChar](libxml2-xmlstring.html#xmlChar)*[xmlUTF8Strndup](#xmlUTF8Strndup)(const[xmlChar](libxml2-xmlstring.html#xmlChar)* utf,
int len);
int[xmlUTF8Strloc](#xmlUTF8Strloc)(const[xmlChar](libxml2-xmlstring.html#xmlChar)* utf,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* utfchar);
#define[BAD\_CAST](#BAD_CAST);
Macro to cast a string to an xmlChar * when one know its safe.
unsigned char 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).
[xmlChar](libxml2-xmlstring.html#xmlChar)* xmlCharStrdup (const char * cur)
a strdup for char's to xmlChar's
| cur: | the input char * | | Returns: | a new xmlChar * or NULL |
[xmlChar](libxml2-xmlstring.html#xmlChar)* xmlCharStrndup (const char * cur,
int len)
a strndup for char's to xmlChar's
| cur: | the input char * | | len: | the len of @cur | | Returns: | a new xmlChar * or NULL |
int xmlCheckUTF8 (const unsigned char * utf)
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.
| utf: | Pointer to putative UTF-8 encoded string. | | Returns: | value: true if @utf is valid. |
int xmlGetUTF8Char (const unsigned char * utf,
int * len)
Read the first UTF8 character from @utf
| utf: | a sequence of UTF-8 encoded bytes | | len: | a pointer to the minimum number of bytes present in the sequence. This is used to assure the next character is completely contained within the sequence. | | Returns: | the char value or -1 in case of error, and sets *len to the actual number of bytes consumed (0 in case of error) |
int xmlStrEqual (const[xmlChar](libxml2-xmlstring.html#xmlChar)* str1,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* str2)
Check if both strings are equal of have same content. Should be a bit more readable and faster than xmlStrcmp()
| str1: | the first xmlChar * | | str2: | the second xmlChar * | | Returns: | 1 if they are equal, 0 if they are different |
int xmlStrPrintf ([xmlChar](libxml2-xmlstring.html#xmlChar)* buf,
int len,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* msg,
... ...)
Formats @msg and places result into @buf.
| buf: | the result buffer. | | len: | the result buffer length. | | msg: | the message with printf formatting. | | ...: | extra parameters for the message. | | Returns: | the number of characters written to @buf or -1 if an error occurs. |
int xmlStrQEqual (const[xmlChar](libxml2-xmlstring.html#xmlChar)* pref,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* name,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* str)
Check if a QName is Equal to a given string
| pref: | the prefix of the QName | | name: | the localname of the QName | | str: | the second xmlChar * | | Returns: | 1 if they are equal, 0 if they are different |
int xmlStrVPrintf ([xmlChar](libxml2-xmlstring.html#xmlChar)* buf,
int len,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* msg,
va_list ap)
Formats @msg and places result into @buf.
| buf: | the result buffer. | | len: | the result buffer length. | | msg: | the message with printf formatting. | | ap: | extra parameters for the message. | | Returns: | the number of characters written to @buf or -1 if an error occurs. |
int xmlStrcasecmp (const[xmlChar](libxml2-xmlstring.html#xmlChar)* str1,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* str2)
a strcasecmp for xmlChar's
| str1: | the first xmlChar * | | str2: | the second xmlChar * | | Returns: | the integer result of the comparison |
const[xmlChar](libxml2-xmlstring.html#xmlChar)* xmlStrcasestr (const[xmlChar](libxml2-xmlstring.html#xmlChar)* str,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* val)
a case-ignoring strstr for xmlChar's
| str: | the xmlChar * array (haystack) | | val: | the xmlChar to search (needle) | | Returns: | the xmlChar * for the first occurrence or NULL. |
[xmlChar](libxml2-xmlstring.html#xmlChar)* xmlStrcat ([xmlChar](libxml2-xmlstring.html#xmlChar)* cur,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* add)
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'.
| cur: | the original xmlChar * array | | add: | the xmlChar * array added | | Returns: | a new xmlChar * containing the concatenated string. |
const[xmlChar](libxml2-xmlstring.html#xmlChar)* xmlStrchr (const[xmlChar](libxml2-xmlstring.html#xmlChar)* str,
[xmlChar](libxml2-xmlstring.html#xmlChar)val)
a strchr for xmlChar's
| str: | the xmlChar * array | | val: | the xmlChar to search | | Returns: | the xmlChar * for the first occurrence or NULL. |
int xmlStrcmp (const[xmlChar](libxml2-xmlstring.html#xmlChar)* str1,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* str2)
a strcmp for xmlChar's
| str1: | the first xmlChar * | | str2: | the second xmlChar * | | Returns: | the integer result of the comparison |
[xmlChar](libxml2-xmlstring.html#xmlChar)* xmlStrdup (const[xmlChar](libxml2-xmlstring.html#xmlChar)* cur)
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'.
| cur: | the input xmlChar * | | Returns: | a new xmlChar * or NULL |
int xmlStrlen (const[xmlChar](libxml2-xmlstring.html#xmlChar)* str)
length of a xmlChar's string
| str: | the xmlChar * array | | Returns: | the number of xmlChar contained in the ARRAY. |
int xmlStrncasecmp (const[xmlChar](libxml2-xmlstring.html#xmlChar)* str1,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* str2,
int len)
a strncasecmp for xmlChar's
| str1: | the first xmlChar * | | str2: | the second xmlChar * | | len: | the max comparison length | | Returns: | the integer result of the comparison |
[xmlChar](libxml2-xmlstring.html#xmlChar)* xmlStrncat ([xmlChar](libxml2-xmlstring.html#xmlChar)* cur,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* add,
int len)
a strncat for array of xmlChar's, it will extend @cur with the len first bytes of @add. Note that if @len < 0 then this is an API error and NULL will be returned.
| cur: | the original xmlChar * array | | add: | the xmlChar * array added | | len: | the length of @add | | Returns: | a new xmlChar *, the original @cur is reallocated if needed and should not be freed |
[xmlChar](libxml2-xmlstring.html#xmlChar)* xmlStrncatNew (const[xmlChar](libxml2-xmlstring.html#xmlChar)* str1,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* str2,
int len)
same as xmlStrncat, but creates a new string. The original two strings are not freed. If @len is < 0 then the length will be calculated automatically.
| str1: | first xmlChar string | | str2: | second xmlChar string | | len: | the len of @str2 or < 0 | | Returns: | a new xmlChar * or NULL |
int xmlStrncmp (const[xmlChar](libxml2-xmlstring.html#xmlChar)* str1,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* str2,
int len)
a strncmp for xmlChar's
| str1: | the first xmlChar * | | str2: | the second xmlChar * | | len: | the max comparison length | | Returns: | the integer result of the comparison |
[xmlChar](libxml2-xmlstring.html#xmlChar)* xmlStrndup (const[xmlChar](libxml2-xmlstring.html#xmlChar)* cur,
int len)
a strndup for array of xmlChar's
| cur: | the input xmlChar * | | len: | the len of @cur | | Returns: | a new xmlChar * or NULL |
const[xmlChar](libxml2-xmlstring.html#xmlChar)* xmlStrstr (const[xmlChar](libxml2-xmlstring.html#xmlChar)* str,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* val)
a strstr for xmlChar's
| str: | the xmlChar * array (haystack) | | val: | the xmlChar to search (needle) | | Returns: | the xmlChar * for the first occurrence or NULL. |
[xmlChar](libxml2-xmlstring.html#xmlChar)* xmlStrsub (const[xmlChar](libxml2-xmlstring.html#xmlChar)* str,
int start,
int len)
Extract a substring of a given string
| str: | the xmlChar * array (haystack) | | start: | the index of the first char (zero based) | | len: | the length of the substring | | Returns: | the xmlChar * for the first occurrence or NULL. |
int xmlUTF8Charcmp (const[xmlChar](libxml2-xmlstring.html#xmlChar)* utf1,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* utf2)
compares the two UCS4 values
| utf1: | pointer to first UTF8 char | | utf2: | pointer to second UTF8 char | | Returns: | result of the compare as with xmlStrncmp |
int xmlUTF8Size (const[xmlChar](libxml2-xmlstring.html#xmlChar)* utf)
calculates the internal size of a UTF8 character
| utf: | pointer to the UTF8 character | | Returns: | the numbers of bytes in the character, -1 on format error |
int xmlUTF8Strlen (const[xmlChar](libxml2-xmlstring.html#xmlChar)* utf)
compute the length of an UTF8 string, it doesn't do a full UTF8 checking of the content of the string.
| utf: | a sequence of UTF-8 encoded bytes | | Returns: | the number of characters in the string or -1 in case of error |
int xmlUTF8Strloc (const[xmlChar](libxml2-xmlstring.html#xmlChar)* utf,
const[xmlChar](libxml2-xmlstring.html#xmlChar)* utfchar)
a function to provide the relative location of a UTF8 char
| utf: | the input UTF8 * | | utfchar: | the UTF8 character to be found | | Returns: | the relative character position of the desired char or -1 if not found |
[xmlChar](libxml2-xmlstring.html#xmlChar)* xmlUTF8Strndup (const[xmlChar](libxml2-xmlstring.html#xmlChar)* utf,
int len)
a strndup for array of UTF8's
| utf: | the input UTF8 * | | len: | the len of @utf (in chars) | | Returns: | a new UTF8 * or NULL |
const[xmlChar](libxml2-xmlstring.html#xmlChar)* xmlUTF8Strpos (const[xmlChar](libxml2-xmlstring.html#xmlChar)* utf,
int pos)
a function to provide the equivalent of fetching a character from a string array
| utf: | the input UTF8 * | | pos: | the position of the desired UTF8 char (in chars) | | Returns: | a pointer to the UTF8 character or NULL |
int xmlUTF8Strsize (const[xmlChar](libxml2-xmlstring.html#xmlChar)* utf,
int len)
storage size of an UTF8 string the behaviour is not garanteed if the input string is not UTF-8
| utf: | a sequence of UTF-8 encoded bytes | | len: | the number of characters in the array | | Returns: | the storage size of the first 'len' characters of ARRAY |
[xmlChar](libxml2-xmlstring.html#xmlChar)* xmlUTF8Strsub (const[xmlChar](libxml2-xmlstring.html#xmlChar)* utf,
int start,
int len)
Create a substring from a given UTF-8 string Note: positions are given in units of UTF-8 chars
| utf: | a sequence of UTF-8 encoded bytes | | start: | relative pos of first char | | len: | total number to copy | | Returns: | a pointer to a newly created string or NULL if any problem |