lib/idna.h

   1 /* idna.h       Declarations for IDNA.
   2  * Copyright (C) 2002, 2003  Simon Josefsson
   3  *
   4  * This file is part of GNU Libidn.
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  20  */
  21
  22 #ifndef _IDNA_H
  23 #define _IDNA_H
  24
  25 #ifdef __cplusplus
  26 extern "C"
  27 {
  28 #endif
  29
  30 #include <stddef.h>             /* size_t */
  31 #include <idn-int.h>            /* uint32_t */
  32
  33   /* Error codes. */
  34   enum Idna_rc
  35   {
  36     IDNA_SUCCESS = 0,
  37     IDNA_STRINGPREP_ERROR = 1,
  38     IDNA_PUNYCODE_ERROR = 2,
  39     IDNA_CONTAINS_LDH = 3,
  40     IDNA_CONTAINS_MINUS = 4,
  41     IDNA_INVALID_LENGTH = 5,
  42     IDNA_NO_ACE_PREFIX = 6,
  43     IDNA_ROUNDTRIP_VERIFY_ERROR = 7,
  44     IDNA_CONTAINS_ACE_PREFIX = 8,
  45     IDNA_ICONV_ERROR = 9,
  46     /* Internal errors. */
  47     IDNA_MALLOC_ERROR = 201
  48   };
  49
  50   /* IDNA flags */
  51   enum Idna_flags
  52   {
  53     IDNA_ALLOW_UNASSIGNED = 0x0001,
  54     IDNA_USE_STD3_ASCII_RULES = 0x0002
  55   };
  56
  57 #ifndef IDNA_ACE_PREFIX
  58 #define IDNA_ACE_PREFIX "xn--"
  59 #endif
  60
  61   /* Core functions */
  62   extern enum Idna_rc idna_to_ascii_4i (const uint32_t * in, size_t inlen,
  63                                         char *out, enum Idna_flags flags);
  64   extern enum Idna_rc idna_to_unicode_44i (const uint32_t * in, size_t inlen,
  65                                            uint32_t * out, size_t * outlen,
  66                                            enum Idna_flags flags);
  67
  68   /* Wrappers that handle several labels */
  69
  70   extern enum Idna_rc idna_to_ascii_4z (const uint32_t * input, char **output,
  71                                         enum Idna_flags flags);
  72
  73   extern enum Idna_rc idna_to_ascii_8z (const char *input, char **output,
  74                                         enum Idna_flags flags);
  75
  76   extern enum Idna_rc idna_to_ascii_lz (const char *input, char **output,
  77                                         enum Idna_flags flags);
  78
  79
  80   extern enum Idna_rc idna_to_unicode_4z4z (const uint32_t * input,
  81                                             uint32_t ** output,
  82                                             enum Idna_flags flags);
  83
  84   extern enum Idna_rc idna_to_unicode_8z4z (const char *input,
  85                                             uint32_t ** output,
  86                                             enum Idna_flags flags);
  87
  88   extern enum Idna_rc idna_to_unicode_8z8z (const char *input, char **output,
  89                                             enum Idna_flags flags);
  90
  91   extern enum Idna_rc idna_to_unicode_8zlz (const char *input, char **output,
  92                                             enum Idna_flags flags);
  93
  94   extern enum Idna_rc idna_to_unicode_lzlz (const char *input, char **output,
  95                                             enum Idna_flags flags);
  96
  97   /* Deprecated interfaces */
  98
  99   extern enum Idna_rc
 100     idna_to_ascii (const unsigned long *in,
 101                    size_t inlen,
 102                    char *out, int allowunassigned, int usestd3asciirules);
 103
 104   extern enum Idna_rc
 105     idna_to_ascii_from_ucs4 (const unsigned long *input,
 106                              char **output,
 107                              int allowunassigned, int usestd3asciirules);
 108
 109   extern enum Idna_rc
 110     idna_to_ascii_from_utf8 (const char *input,
 111                              char **output,
 112                              int allowunassigned, int usestd3asciirules);
 113
 114   extern enum Idna_rc
 115     idna_to_ascii_from_locale (const char *input,
 116                                char **output,
 117                                int allowunassigned, int usestd3asciirules);
 118
 119   extern enum Idna_rc
 120     idna_to_unicode (const unsigned long *in,
 121                      size_t inlen,
 122                      unsigned long *out,
 123                      size_t * outlen,
 124                      int allowunassigned, int usestd3asciirules);
 125
 126   extern enum Idna_rc
 127     idna_to_unicode_ucs4_from_ucs4 (const unsigned long
 128                                     *input,
 129                                     unsigned long **output,
 130                                     int allowunassigned,
 131                                     int usestd3asciirules);
 132
 133   extern enum Idna_rc
 134     idna_to_unicode_ucs4_from_utf8 (const char *input,
 135                                     unsigned long **output,
 136                                     int allowunassigned,
 137                                     int usestd3asciirules);
 138
 139   extern enum Idna_rc
 140     idna_to_unicode_utf8_from_utf8 (const char *input,
 141                                     char **output,
 142                                     int allowunassigned,
 143                                     int usestd3asciirules);
 144
 145   extern enum Idna_rc
 146     idna_to_unicode_locale_from_utf8 (const char *input,
 147                                       char **output,
 148                                       int allowunassigned,
 149                                       int usestd3asciirules);
 150
 151   extern enum Idna_rc
 152     idna_to_unicode_locale_from_locale (const char *input,
 153                                         char **output,
 154                                         int allowunassigned,
 155                                         int usestd3asciirules);
 156
 157   /* Deprecated interfaces (even older) */
 158
 159   extern enum Idna_rc idna_ucs4_to_ace (const unsigned long *input,
 160                                         char **output);
 161   extern enum Idna_rc idna_utf8_to_ace (const char *input, char **output);
 162   extern enum Idna_rc idna_locale_to_ace (const char *input, char **output);
 163
 164   extern enum Idna_rc idna_ucs4ace_to_ucs4 (const unsigned long *input,
 165                                             unsigned long **output);
 166   extern enum Idna_rc idna_utf8ace_to_ucs4 (const char *input,
 167                                             unsigned long **output);
 168   extern enum Idna_rc idna_utf8ace_to_utf8 (const char *input, char **output);
 169   extern enum Idna_rc idna_utf8ace_to_locale (const char *input,
 170                                               char **output);
 171   extern enum Idna_rc idna_localeace_to_locale (const char *input,
 172                                                 char **output);
 173
 174 #ifdef __cplusplus
 175 }
 176 #endif
 177 #endif                          /* _PUNYCODE_H */