.
[glibc/history.git] / libidn / idna.h
blobe6e1fe675b521ce542cd2e35d00796a80b4db148
1 /* idna.h Declarations for IDNA.
2 * Copyright (C) 2002, 2003, 2004 Simon Josefsson
4 * This file is part of GNU Libidn.
6 * GNU Libidn is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * GNU Libidn is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with GNU Libidn; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #ifndef _IDNA_H
23 #define _IDNA_H
25 #ifdef __cplusplus
26 extern "C"
28 #endif
30 #include <stddef.h> /* size_t */
31 #include <stdint.h> /* uint32_t */
33 /* Error codes. */
34 typedef enum
36 IDNA_SUCCESS = 0,
37 IDNA_STRINGPREP_ERROR = 1,
38 IDNA_PUNYCODE_ERROR = 2,
39 IDNA_CONTAINS_NON_LDH = 3,
40 /* Workaround typo in earlier versions. */
41 IDNA_CONTAINS_LDH = IDNA_CONTAINS_NON_LDH,
42 IDNA_CONTAINS_MINUS = 4,
43 IDNA_INVALID_LENGTH = 5,
44 IDNA_NO_ACE_PREFIX = 6,
45 IDNA_ROUNDTRIP_VERIFY_ERROR = 7,
46 IDNA_CONTAINS_ACE_PREFIX = 8,
47 IDNA_ICONV_ERROR = 9,
48 /* Internal errors. */
49 IDNA_MALLOC_ERROR = 201,
50 IDNA_DLOPEN_ERROR = 202
51 } Idna_rc;
53 /* IDNA flags */
54 typedef enum
56 IDNA_ALLOW_UNASSIGNED = 0x0001,
57 IDNA_USE_STD3_ASCII_RULES = 0x0002
58 } Idna_flags;
60 #ifndef IDNA_ACE_PREFIX
61 #define IDNA_ACE_PREFIX "xn--"
62 #endif
64 /* Core functions */
65 extern int idna_to_ascii_4i (const uint32_t * in, size_t inlen,
66 char *out, int flags);
67 extern int idna_to_unicode_44i (const uint32_t * in, size_t inlen,
68 uint32_t * out, size_t * outlen, int flags);
70 /* Wrappers that handle several labels */
72 extern int idna_to_ascii_4z (const uint32_t * input,
73 char **output, int flags);
75 extern int idna_to_ascii_8z (const char *input, char **output, int flags);
77 extern int idna_to_ascii_lz (const char *input, char **output, int flags);
80 extern int idna_to_unicode_4z4z (const uint32_t * input,
81 uint32_t ** output, int flags);
83 extern int idna_to_unicode_8z4z (const char *input,
84 uint32_t ** output, int flags);
86 extern int idna_to_unicode_8z8z (const char *input,
87 char **output, int flags);
89 extern int idna_to_unicode_8zlz (const char *input,
90 char **output, int flags);
92 extern int idna_to_unicode_lzlz (const char *input,
93 char **output, int flags);
95 #ifdef __cplusplus
97 #endif
98 #endif /* _PUNYCODE_H */