#include <stddef.h>
#include <idn-int.h>
Go to the source code of this file.
Defines | |
#define | IDNAPI |
#define | IDNA_ACE_PREFIX "xn--" |
Enumerations | |
enum | Idna_rc { IDNA_SUCCESS = 0, IDNA_STRINGPREP_ERROR = 1, IDNA_PUNYCODE_ERROR = 2, IDNA_CONTAINS_NON_LDH = 3, IDNA_CONTAINS_LDH = IDNA_CONTAINS_NON_LDH, IDNA_CONTAINS_MINUS = 4, IDNA_INVALID_LENGTH = 5, IDNA_NO_ACE_PREFIX = 6, IDNA_ROUNDTRIP_VERIFY_ERROR = 7, IDNA_CONTAINS_ACE_PREFIX = 8, IDNA_ICONV_ERROR = 9, IDNA_MALLOC_ERROR = 201, IDNA_DLOPEN_ERROR = 202 } |
enum | Idna_flags { IDNA_ALLOW_UNASSIGNED = 0x0001, IDNA_USE_STD3_ASCII_RULES = 0x0002 } |
Functions | |
IDNAPI const char * | idna_strerror (Idna_rc rc) |
IDNAPI int | idna_to_ascii_4i (const uint32_t *in, size_t inlen, char *out, int flags) |
IDNAPI int | idna_to_unicode_44i (const uint32_t *in, size_t inlen, uint32_t *out, size_t *outlen, int flags) |
IDNAPI int | idna_to_ascii_4z (const uint32_t *input, char **output, int flags) |
IDNAPI int | idna_to_ascii_8z (const char *input, char **output, int flags) |
IDNAPI int | idna_to_ascii_lz (const char *input, char **output, int flags) |
IDNAPI int | idna_to_unicode_4z4z (const uint32_t *input, uint32_t **output, int flags) |
IDNAPI int | idna_to_unicode_8z4z (const char *input, uint32_t **output, int flags) |
IDNAPI int | idna_to_unicode_8z8z (const char *input, char **output, int flags) |
IDNAPI int | idna_to_unicode_8zlz (const char *input, char **output, int flags) |
IDNAPI int | idna_to_unicode_lzlz (const char *input, char **output, int flags) |
enum Idna_flags |
enum Idna_rc |
IDNAPI const char* idna_strerror | ( | Idna_rc | rc | ) |
idna_strerror - return string describing idna error code
rc | an Idna_rc return code. |
IDNA_SUCCESS: Successful operation. This value is guaranteed to always be zero, the remaining ones are only guaranteed to hold non-zero values, for logical comparison purposes. IDNA_STRINGPREP_ERROR: Error during string preparation. IDNA_PUNYCODE_ERROR: Error during punycode operation. IDNA_CONTAINS_NON_LDH: For IDNA_USE_STD3_ASCII_RULES, indicate that the string contains non-LDH ASCII characters. IDNA_CONTAINS_MINUS: For IDNA_USE_STD3_ASCII_RULES, indicate that the string contains a leading or trailing hyphen-minus (U+002D). IDNA_INVALID_LENGTH: The final output string is not within the (inclusive) range 1 to 63 characters. IDNA_NO_ACE_PREFIX: The string does not contain the ACE prefix (for ToUnicode). IDNA_ROUNDTRIP_VERIFY_ERROR: The ToASCII operation on output string does not equal the input. IDNA_CONTAINS_ACE_PREFIX: The input contains the ACE prefix (for ToASCII). IDNA_ICONV_ERROR: Could not convert string in locale encoding. IDNA_MALLOC_ERROR: Could not allocate buffer (this is typically a fatal error). IDNA_DLOPEN_ERROR: Could not dlopen the libcidn DSO (only used internally in libc).
Return value: Returns a pointer to a statically allocated string containing a description of the error with the return code .
Definition at line 65 of file strerror-idna.c.
IDNAPI int idna_to_ascii_4i | ( | const uint32_t * | in, | |
size_t | inlen, | |||
char * | out, | |||
int | flags | |||
) |
idna_to_ascii_4i - convert Unicode domain name label to text
in | input array with unicode code points. | |
inlen | length of input array with unicode code points. | |
out | output zero terminated string that must have room for at least 63 characters plus the terminating zero. | |
flags | an Idna_flags value, e.g., IDNA_ALLOW_UNASSIGNED or IDNA_USE_STD3_ASCII_RULES. |
It is important to note that the ToASCII operation can fail. ToASCII fails if any step of it fails. If any step of the ToASCII operation fails on any label in a domain name, that domain name MUST NOT be used as an internationalized domain name. The method for deadling with this failure is application-specific.
The inputs to ToASCII are a sequence of code points, the AllowUnassigned flag, and the UseSTD3ASCIIRules flag. The output of ToASCII is either a sequence of ASCII code points or a failure condition.
ToASCII never alters a sequence of code points that are all in the ASCII range to begin with (although it could fail). Applying the ToASCII operation multiple times has exactly the same effect as applying it just once.
Return value: Returns 0 on success, or an Idna_rc error code.
IDNAPI int idna_to_ascii_4z | ( | const uint32_t * | input, | |
char ** | output, | |||
int | flags | |||
) |
idna_to_ascii_4z - convert Unicode domain name to text
input | zero terminated input Unicode string. | |
output | pointer to newly allocated output string. | |
flags | an Idna_flags value, e.g., IDNA_ALLOW_UNASSIGNED or IDNA_USE_STD3_ASCII_RULES. |
Return value: Returns IDNA_SUCCESS on success, or error code.
IDNAPI int idna_to_ascii_8z | ( | const char * | input, | |
char ** | output, | |||
int | flags | |||
) |
idna_to_ascii_8z - convert Unicode domain name to text
input | zero terminated input UTF-8 string. | |
output | pointer to newly allocated output string. | |
flags | an Idna_flags value, e.g., IDNA_ALLOW_UNASSIGNED or IDNA_USE_STD3_ASCII_RULES. |
Return value: Returns IDNA_SUCCESS on success, or error code.
IDNAPI int idna_to_ascii_lz | ( | const char * | input, | |
char ** | output, | |||
int | flags | |||
) |
idna_to_ascii_lz - convert Unicode domain name to text
input | zero terminated input string encoded in the current locale's character set. | |
output | pointer to newly allocated output string. | |
flags | an Idna_flags value, e.g., IDNA_ALLOW_UNASSIGNED or IDNA_USE_STD3_ASCII_RULES. |
Return value: Returns IDNA_SUCCESS on success, or error code.
IDNAPI int idna_to_unicode_44i | ( | const uint32_t * | in, | |
size_t | inlen, | |||
uint32_t * | out, | |||
size_t * | outlen, | |||
int | flags | |||
) |
idna_to_unicode_44i - convert domain name label to Unicode
in | input array with unicode code points. | |
inlen | length of input array with unicode code points. | |
out | output array with unicode code points. | |
outlen | on input, maximum size of output array with unicode code points, on exit, actual size of output array with unicode code points. | |
flags | an Idna_flags value, e.g., IDNA_ALLOW_UNASSIGNED or IDNA_USE_STD3_ASCII_RULES. |
ToUnicode never fails. If any step fails, then the original input sequence is returned immediately in that step.
The Punycode decoder can never output more code points than it inputs, but Nameprep can, and therefore ToUnicode can. Note that the number of octets needed to represent a sequence of code points depends on the particular character encoding used.
The inputs to ToUnicode are a sequence of code points, the AllowUnassigned flag, and the UseSTD3ASCIIRules flag. The output of ToUnicode is always a sequence of Unicode code points.
Return value: Returns Idna_rc error condition, but it must only be used for debugging purposes. The output buffer is always guaranteed to contain the correct data according to the specification (sans malloc induced errors). NB! This means that you normally ignore the return code from this function, as checking it means breaking the standard.
IDNAPI int idna_to_unicode_4z4z | ( | const uint32_t * | input, | |
uint32_t ** | output, | |||
int | flags | |||
) |
idna_to_unicode_4z4z - convert domain name to Unicode
input | zero-terminated Unicode string. | |
output | pointer to newly allocated output Unicode string. | |
flags | an Idna_flags value, e.g., IDNA_ALLOW_UNASSIGNED or IDNA_USE_STD3_ASCII_RULES. |
Return value: Returns IDNA_SUCCESS on success, or error code.
IDNAPI int idna_to_unicode_8z4z | ( | const char * | input, | |
uint32_t ** | output, | |||
int | flags | |||
) |
idna_to_unicode_8z4z - convert domain name to Unicode
input | zero-terminated UTF-8 string. | |
output | pointer to newly allocated output Unicode string. | |
flags | an Idna_flags value, e.g., IDNA_ALLOW_UNASSIGNED or IDNA_USE_STD3_ASCII_RULES. |
Return value: Returns IDNA_SUCCESS on success, or error code.
IDNAPI int idna_to_unicode_8z8z | ( | const char * | input, | |
char ** | output, | |||
int | flags | |||
) |
idna_to_unicode_8z8z - convert domain name to Unicode
input | zero-terminated UTF-8 string. | |
output | pointer to newly allocated output UTF-8 string. | |
flags | an Idna_flags value, e.g., IDNA_ALLOW_UNASSIGNED or IDNA_USE_STD3_ASCII_RULES. |
Return value: Returns IDNA_SUCCESS on success, or error code.
IDNAPI int idna_to_unicode_8zlz | ( | const char * | input, | |
char ** | output, | |||
int | flags | |||
) |
idna_to_unicode_8zlz - convert domain name to Unicode
input | zero-terminated UTF-8 string. | |
output | pointer to newly allocated output string encoded in the current locale's character set. | |
flags | an Idna_flags value, e.g., IDNA_ALLOW_UNASSIGNED or IDNA_USE_STD3_ASCII_RULES. |
Return value: Returns IDNA_SUCCESS on success, or error code.
IDNAPI int idna_to_unicode_lzlz | ( | const char * | input, | |
char ** | output, | |||
int | flags | |||
) |
idna_to_unicode_lzlz - convert domain name to Unicode
input | zero-terminated string encoded in the current locale's character set. | |
output | pointer to newly allocated output string encoded in the current locale's character set. | |
flags | an Idna_flags value, e.g., IDNA_ALLOW_UNASSIGNED or IDNA_USE_STD3_ASCII_RULES. |
Return value: Returns IDNA_SUCCESS on success, or error code.