00001 /* punycode.h --- Declarations for punycode functions. 00002 * Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Simon Josefsson 00003 * 00004 * This file is part of GNU Libidn. 00005 * 00006 * GNU Libidn is free software; you can redistribute it and/or 00007 * modify it under the terms of the GNU Lesser General Public 00008 * License as published by the Free Software Foundation; either 00009 * version 2.1 of the License, or (at your option) any later version. 00010 * 00011 * GNU Libidn is distributed in the hope that it will be useful, 00012 * but WITHOUT ANY WARRANTY; without even the implied warranty of 00013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00014 * Lesser General Public License for more details. 00015 * 00016 * You should have received a copy of the GNU Lesser General Public 00017 * License along with GNU Libidn; if not, write to the Free Software 00018 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA 00019 * 00020 */ 00021 00022 /* 00023 * This file is derived from RFC 3492bis written by Adam M. Costello. 00024 * 00025 * Disclaimer and license: Regarding this entire document or any 00026 * portion of it (including the pseudocode and C code), the author 00027 * makes no guarantees and is not responsible for any damage resulting 00028 * from its use. The author grants irrevocable permission to anyone 00029 * to use, modify, and distribute it in any way that does not diminish 00030 * the rights of anyone else to use, modify, and distribute it, 00031 * provided that redistributed derivative works do not contain 00032 * misleading author or version information. Derivative works need 00033 * not be licensed under similar terms. 00034 * 00035 * Copyright (C) The Internet Society (2003). All Rights Reserved. 00036 * 00037 * This document and translations of it may be copied and furnished to 00038 * others, and derivative works that comment on or otherwise explain it 00039 * or assist in its implementation may be prepared, copied, published 00040 * and distributed, in whole or in part, without restriction of any 00041 * kind, provided that the above copyright notice and this paragraph are 00042 * included on all such copies and derivative works. However, this 00043 * document itself may not be modified in any way, such as by removing 00044 * the copyright notice or references to the Internet Society or other 00045 * Internet organizations, except as needed for the purpose of 00046 * developing Internet standards in which case the procedures for 00047 * copyrights defined in the Internet Standards process must be 00048 * followed, or as required to translate it into languages other than 00049 * English. 00050 * 00051 * The limited permissions granted above are perpetual and will not be 00052 * revoked by the Internet Society or its successors or assigns. 00053 * 00054 * This document and the information contained herein is provided on an 00055 * "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING 00056 * TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING 00057 * BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION 00058 * HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 00059 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 00060 */ 00061 00062 #ifndef PUNYCODE_H 00063 # define PUNYCODE_H 00064 00065 # ifndef IDNAPI 00066 # if defined LIBIDN_BUILDING && defined HAVE_VISIBILITY && HAVE_VISIBILITY 00067 # define IDNAPI __attribute__((__visibility__("default"))) 00068 # elif defined LIBIDN_BUILDING && defined _MSC_VER && ! defined LIBIDN_STATIC 00069 # define IDNAPI __declspec(dllexport) 00070 # elif defined _MSC_VER && ! defined LIBIDN_STATIC 00071 # define IDNAPI __declspec(dllimport) 00072 # else 00073 # define IDNAPI 00074 # endif 00075 # endif 00076 00077 #ifdef __cplusplus 00078 extern "C" 00079 { 00080 #endif 00081 00082 #include <stddef.h> /* size_t */ 00083 #include <idn-int.h> /* uint32_t */ 00084 00085 enum punycode_status 00086 { 00087 punycode_success = 0, 00088 punycode_bad_input = 1, /* Input is invalid. */ 00089 punycode_big_output = 2, /* Output would exceed the space provided. */ 00090 punycode_overflow = 3 /* Wider integers needed to process input. */ 00091 }; 00092 00093 typedef enum 00094 { 00095 PUNYCODE_SUCCESS = punycode_success, 00096 PUNYCODE_BAD_INPUT = punycode_bad_input, 00097 PUNYCODE_BIG_OUTPUT = punycode_big_output, 00098 PUNYCODE_OVERFLOW = punycode_overflow 00099 } Punycode_status; 00100 00101 extern IDNAPI const char *punycode_strerror (Punycode_status rc); 00102 00103 /* punycode_uint needs to be unsigned and needs to be */ 00104 /* at least 26 bits wide. */ 00105 00106 typedef uint32_t punycode_uint; 00107 00108 extern IDNAPI int punycode_encode (size_t input_length, 00109 const punycode_uint input[], 00110 const unsigned char case_flags[], 00111 size_t * output_length, char output[]); 00112 00113 /* 00114 punycode_encode() converts a sequence of code points (presumed to be 00115 Unicode code points) to Punycode. 00116 00117 Input arguments (to be supplied by the caller): 00118 00119 input_length 00120 The number of code points in the input array and the number 00121 of flags in the case_flags array. 00122 00123 input 00124 An array of code points. They are presumed to be Unicode 00125 code points, but that is not strictly REQUIRED. The 00126 array contains code points, not code units. UTF-16 uses 00127 code units D800 through DFFF to refer to code points 00128 10000..10FFFF. The code points D800..DFFF do not occur in 00129 any valid Unicode string. The code points that can occur in 00130 Unicode strings (0..D7FF and E000..10FFFF) are also called 00131 Unicode scalar values. 00132 00133 case_flags 00134 A null pointer or an array of boolean values parallel to 00135 the input array. Nonzero (true, flagged) suggests that the 00136 corresponding Unicode character be forced to uppercase after 00137 being decoded (if possible), and zero (false, unflagged) 00138 suggests that it be forced to lowercase (if possible). 00139 ASCII code points (0..7F) are encoded literally, except that 00140 ASCII letters are forced to uppercase or lowercase according 00141 to the corresponding case flags. If case_flags is a null 00142 pointer then ASCII letters are left as they are, and other 00143 code points are treated as unflagged. 00144 00145 Output arguments (to be filled in by the function): 00146 00147 output 00148 An array of ASCII code points. It is *not* null-terminated; 00149 it will contain zeros if and only if the input contains 00150 zeros. (Of course the caller can leave room for a 00151 terminator and add one if needed.) 00152 00153 Input/output arguments (to be supplied by the caller and overwritten 00154 by the function): 00155 00156 output_length 00157 The caller passes in the maximum number of ASCII code points 00158 that it can receive. On successful return it will contain 00159 the number of ASCII code points actually output. 00160 00161 Return value: 00162 00163 Can be any of the punycode_status values defined above except 00164 punycode_bad_input. If not punycode_success, then output_size 00165 and output might contain garbage. 00166 */ 00167 00168 extern IDNAPI int punycode_decode (size_t input_length, 00169 const char input[], 00170 size_t * output_length, 00171 punycode_uint output[], 00172 unsigned char case_flags[]); 00173 00174 /* 00175 punycode_decode() converts Punycode to a sequence of code points 00176 (presumed to be Unicode code points). 00177 00178 Input arguments (to be supplied by the caller): 00179 00180 input_length 00181 The number of ASCII code points in the input array. 00182 00183 input 00184 An array of ASCII code points (0..7F). 00185 00186 Output arguments (to be filled in by the function): 00187 00188 output 00189 An array of code points like the input argument of 00190 punycode_encode() (see above). 00191 00192 case_flags 00193 A null pointer (if the flags are not needed by the caller) 00194 or an array of boolean values parallel to the output array. 00195 Nonzero (true, flagged) suggests that the corresponding 00196 Unicode character be forced to uppercase by the caller (if 00197 possible), and zero (false, unflagged) suggests that it 00198 be forced to lowercase (if possible). ASCII code points 00199 (0..7F) are output already in the proper case, but their 00200 flags will be set appropriately so that applying the flags 00201 would be harmless. 00202 00203 Input/output arguments (to be supplied by the caller and overwritten 00204 by the function): 00205 00206 output_length 00207 The caller passes in the maximum number of code points 00208 that it can receive into the output array (which is also 00209 the maximum number of flags that it can receive into the 00210 case_flags array, if case_flags is not a null pointer). On 00211 successful return it will contain the number of code points 00212 actually output (which is also the number of flags actually 00213 output, if case_flags is not a null pointer). The decoder 00214 will never need to output more code points than the number 00215 of ASCII code points in the input, because of the way the 00216 encoding is defined. The number of code points output 00217 cannot exceed the maximum possible value of a punycode_uint, 00218 even if the supplied output_length is greater than that. 00219 00220 Return value: 00221 00222 Can be any of the punycode_status values defined above. If not 00223 punycode_success, then output_length, output, and case_flags 00224 might contain garbage. 00225 */ 00226 00227 #ifdef __cplusplus 00228 } 00229 #endif 00230 #endif /* PUNYCODE_H */