| typedef int(* | xmlCharEncodingInputFunc |
xmlCharEncodingInputFunc: Take a block of chars in the original encoding and try to convert it to an UTF-8 block of chars out.
Returns the number of bytes written, -1 if lack of space, or -2 if the transcoding failed. The value of inlen after return is the number of octets consumed if the return value is positive, else unpredictiable. The value of outlen after return is the number of octets consumed.
| typedef int(* | xmlCharEncodingOutputFunc |
xmlCharEncodingOutputFunc: Take a block of UTF-8 chars in and try to convert it to another encoding. Note: a first call designed to produce heading info is called with in = NULL. If stateful this should also initialize the encoder state.
Returns the number of bytes written, -1 if lack of space, or -2 if the transcoding failed. The value of inlen after return is the number of octets consumed if the return value is positive, else unpredictiable. The value of outlen after return is the number of octets produced.
| typedef struct _xmlCharEncodingHandler | xmlCharEncodingHandler |
| typedef xmlCharEncodingHandler * | xmlCharEncodingHandlerPtr |
| XMLPUBFUN void XMLCALL | xmlInitCharEncodingHandlers | ( | void | ) |
xmlInitCharEncodingHandlers:
Initialize the char encoding support, it registers the default encoding supported. NOTE: while public, this function usually doesn't need to be called in normal processing.
OOM: possible --> OOM flag is set
| XMLPUBFUN void XMLCALL | xmlCleanupCharEncodingHandlers | ( | void | ) |
xmlCleanupCharEncodingHandlers:
Cleanup the memory allocated for the char encoding support, it unregisters all the encoding handlers and the aliases.
OOM: never
| XMLPUBFUN void XMLCALL | xmlRegisterCharEncodingHandler | ( | xmlCharEncodingHandlerPtr | handler | ) |
xmlRegisterCharEncodingHandler: Register the char encoding handler, surprising, isn't it ?
OOM: never
| Parameters | |
|---|---|
| handler | the xmlCharEncodingHandlerPtr handler block |
| XMLPUBFUN xmlCharEncodingHandlerPtr XMLCALL | xmlGetCharEncodingHandler | ( | xmlCharEncoding | enc | ) |
xmlGetCharEncodingHandler: Search in the registered set the handler able to read/write that encoding.
Returns the handler, NULL if not found
OOM: possible --> OOM flag is set
| Parameters | |
|---|---|
| enc | an xmlCharEncoding value. |
| XMLPUBFUN xmlCharEncodingHandlerPtr XMLCALL | xmlFindCharEncodingHandler | ( | const char * | name | ) |
xmlFindCharEncodingHandler: Search in the registered set the handler able to read/write that encoding.
Returns the handler or NULL if not found
OOM: possible --> OOM flag is set
| Parameters | |
|---|---|
| name | a string describing the char encoding. |
| XMLPUBFUN xmlCharEncodingHandlerPtr XMLCALL | xmlNewCharEncodingHandler | ( | const char * | name, |
| xmlCharEncodingInputFunc | input, | |||
| xmlCharEncodingOutputFunc | output | |||
| ) | ||||
xmlNewCharEncodingHandler: Create and registers an xmlCharEncodingHandler.
Returns the xmlCharEncodingHandlerPtr created (or NULL in case of error).
OOM: possible --> OOM flag is set
| Parameters | |
|---|---|
| name | the encoding name, in UTF-8 format (ASCII actually) |
| input | the xmlCharEncodingInputFunc to read that encoding |
| output | the xmlCharEncodingOutputFunc to write that encoding |
| XMLPUBFUN int XMLCALL | xmlAddEncodingAlias | ( | const char * | name, |
| const char * | alias | |||
| ) | ||||
xmlAddEncodingAlias: Registers an alias alias for an encoding named name. Existing alias will be overwritten.
Returns 0 in case of success, -1 in case of error
| Parameters | |
|---|---|
| name | the encoding name as parsed, in UTF-8 format (ASCII actually) |
| alias | the alias name as parsed, in UTF-8 format (ASCII actually) |
| XMLPUBFUN int XMLCALL | xmlDelEncodingAlias | ( | const char * | alias | ) |
xmlDelEncodingAlias: Unregisters an encoding alias alias
Returns 0 in case of success, -1 in case of error
| Parameters | |
|---|---|
| alias | the alias name as parsed, in UTF-8 format (ASCII actually) |
| XMLPUBFUN const char *XMLCALL | xmlGetEncodingAlias | ( | const char * | alias | ) |
xmlGetEncodingAlias: Lookup an encoding name for the given alias.
Returns NULL if not found, otherwise the original name
OOM: never
| Parameters | |
|---|---|
| alias | the alias name as parsed, in UTF-8 format (ASCII actually) |
| XMLPUBFUN void XMLCALL | xmlCleanupEncodingAliases | ( | void | ) |
xmlCleanupEncodingAliases:
Unregisters all aliases
| XMLPUBFUN xmlCharEncoding XMLCALL | xmlParseCharEncoding | ( | const char * | name | ) |
xmlParseCharEncoding: Compare the string to the encoding schemes already known. Note that the comparison is case insensitive accordingly to the section [XML] 4.3.3 Character Encoding in Entities.
Returns one of the XML_CHAR_ENCODING_... values or XML_CHAR_ENCODING_NONE if not recognized.
OOM: never
| Parameters | |
|---|---|
| name | the encoding name as parsed, in UTF-8 format (ASCII actually) |
| XMLPUBFUN const char *XMLCALL | xmlGetCharEncodingName | ( | xmlCharEncoding | enc | ) |
xmlGetCharEncodingName: The "canonical" name for XML encoding. C.f. http://www.w3.org/TR/REC-xml#charencoding Section 4.3.3 Character Encoding in Entities
Returns the canonical name for the given encoding
| Parameters | |
|---|---|
| enc | the encoding |
| XMLPUBFUN xmlCharEncoding XMLCALL | xmlDetectCharEncoding | ( | const unsigned char * | in, |
| int | len | |||
| ) | ||||
xmlDetectCharEncoding: Guess the encoding of the entity using the first bytes of the entity content according to the non-normative appendix F of the XML-1.0 recommendation.
Returns one of the XML_CHAR_ENCODING_... values.
OOM: never
| Parameters | |
|---|---|
| in | a pointer to the first bytes of the XML entity, must be at least 2 bytes long (at least 4 if encoding is UTF4 variant). |
| len | pointer to the length of the buffer |
| XMLPUBFUN int XMLCALL | xmlCharEncOutFunc | ( | xmlCharEncodingHandler * | handler, |
| xmlBufferPtr | out, | |||
| xmlBufferPtr | in | |||
| ) | ||||
xmlCharEncOutFunc: Generic front-end for the encoding handler output function a first call with in == NULL has to be made firs to initiate the output in case of non-stateless encoding needing to initiate their state or the output (like the BOM in UTF16). In case of UTF8 sequence conversion errors for the given encoder, the content will be automatically remapped to a CharRef sequence.
Returns the number of byte written if success, or -1 general error -2 if the transcoding fails (for *in is not valid utf8 string or the result of transformation can't fit into the encoding we want), or
OOM: unknown status / function pointers are in use possible, but reporting is not guaranteed
| Parameters | |
|---|---|
| handler | char enconding transformation data structure |
| out | an xmlBuffer for the output. |
| in | an xmlBuffer for the input |
| XMLPUBFUN int XMLCALL | xmlCharEncInFunc | ( | xmlCharEncodingHandler * | handler, |
| xmlBufferPtr | out, | |||
| xmlBufferPtr | in | |||
| ) | ||||
xmlCharEncInFunc: Generic front-end for the encoding handler input function
Returns the number of byte written if success, or -1 general error -2 if the transcoding fails (for *in is not valid utf8 string or the result of transformation can't fit into the encoding we want), or
ISSUE: OOM: possible
| Parameters | |
|---|---|
| handler | char encoding transformation data structure |
| out | an xmlBuffer for the output. |
| in | an xmlBuffer for the input |
| XMLPUBFUN int XMLCALL | xmlCharEncFirstLine | ( | xmlCharEncodingHandler * | handler, |
| xmlBufferPtr | out, | |||
| xmlBufferPtr | in | |||
| ) | ||||
xmlCharEncFirstLine: Front-end for the encoding handler input function, but handle only the very first line, i.e. limit itself to 45 chars.
Returns the number of byte written if success, or -1 general error -2 if the transcoding fails (for *in is not valid utf8 string or the result of transformation can't fit into the encoding we want), or
OOM: possible --> check OOM flag
| Parameters | |
|---|---|
| handler | char enconding transformation data structure |
| out | an xmlBuffer for the output. |
| in | an xmlBuffer for the input |
| XMLPUBFUN int XMLCALL | xmlCharEncCloseFunc | ( | xmlCharEncodingHandler * | handler | ) |
xmlCharEncCloseFunc: Generic front-end for encoding handler close function
Returns 0 if success, or -1 in case of error
OOM: never / not clear (depends on ICONV support)
| Parameters | |
|---|---|
| handler | char enconding transformation data structure |
| XMLPUBFUN int XMLCALL | UTF8Toisolat1 | ( | unsigned char * | out, |
| int * | outlen, | |||
| const unsigned char * | in, | |||
| int * | inlen | |||
| ) | ||||
| XMLPUBFUN int XMLCALL | isolat1ToUTF8 | ( | unsigned char * | out, |
| int * | outlen, | |||
| const unsigned char * | in, | |||
| int * | inlen | |||
| ) | ||||
isolat1ToUTF8: Take a block of ISO Latin 1 chars in and try to convert it to an UTF-8 block of chars out. Returns 0 if success, or -1 otherwise The value of inlen after return is the number of octets consumed if the return value is positive, else unpredictable. The value of outlen after return is the number of octets consumed.
| Parameters | |
|---|---|
| out | a pointer to an array of bytes to store the result |
| outlen | the length of out |
| in | a pointer to an array of ISO Latin 1 chars |
| inlen | the length of in |