/usr/include/unicode/idna.h is in libicu-dev 57.1-6+deb9u2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 | /*
*******************************************************************************
* Copyright (C) 2010-2012, International Business Machines
* Corporation and others. All Rights Reserved.
*******************************************************************************
* file name: idna.h
* encoding: US-ASCII
* tab size: 8 (not used)
* indentation:4
*
* created on: 2010mar05
* created by: Markus W. Scherer
*/
#ifndef __IDNA_H__
#define __IDNA_H__
/**
* \file
* \brief C++ API: Internationalizing Domain Names in Applications (IDNA)
*/
#include "unicode/utypes.h"
#if !UCONFIG_NO_IDNA
#include "unicode/bytestream.h"
#include "unicode/stringpiece.h"
#include "unicode/uidna.h"
#include "unicode/unistr.h"
U_NAMESPACE_BEGIN
class IDNAInfo;
/**
* Abstract base class for IDNA processing.
* See http://www.unicode.org/reports/tr46/
* and http://www.ietf.org/rfc/rfc3490.txt
*
* The IDNA class is not intended for public subclassing.
*
* This C++ API currently only implements UTS #46.
* The uidna.h C API implements both UTS #46 (functions using UIDNA service object)
* and IDNA2003 (functions that do not use a service object).
* @stable ICU 4.6
*/
class U_COMMON_API IDNA : public UObject {
public:
/**
* Destructor.
* @stable ICU 4.6
*/
~IDNA();
/**
* Returns an IDNA instance which implements UTS #46.
* Returns an unmodifiable instance, owned by the caller.
* Cache it for multiple operations, and delete it when done.
* The instance is thread-safe, that is, it can be used concurrently.
*
* UTS #46 defines Unicode IDNA Compatibility Processing,
* updated to the latest version of Unicode and compatible with both
* IDNA2003 and IDNA2008.
*
* The worker functions use transitional processing, including deviation mappings,
* unless UIDNA_NONTRANSITIONAL_TO_ASCII or UIDNA_NONTRANSITIONAL_TO_UNICODE
* is used in which case the deviation characters are passed through without change.
*
* Disallowed characters are mapped to U+FFFD.
*
* For available options see the uidna.h header.
* Operations with the UTS #46 instance do not support the
* UIDNA_ALLOW_UNASSIGNED option.
*
* By default, the UTS #46 implementation allows all ASCII characters (as valid or mapped).
* When the UIDNA_USE_STD3_RULES option is used, ASCII characters other than
* letters, digits, hyphen (LDH) and dot/full stop are disallowed and mapped to U+FFFD.
*
* @param options Bit set to modify the processing and error checking.
* See option bit set values in uidna.h.
* @param errorCode Standard ICU error code. Its input value must
* pass the U_SUCCESS() test, or else the function returns
* immediately. Check for U_FAILURE() on output or use with
* function chaining. (See User Guide for details.)
* @return the UTS #46 IDNA instance, if successful
* @stable ICU 4.6
*/
static IDNA *
createUTS46Instance(uint32_t options, UErrorCode &errorCode);
/**
* Converts a single domain name label into its ASCII form for DNS lookup.
* If any processing step fails, then info.hasErrors() will be TRUE and
* the result might not be an ASCII string.
* The label might be modified according to the types of errors.
* Labels with severe errors will be left in (or turned into) their Unicode form.
*
* The UErrorCode indicates an error only in exceptional cases,
* such as a U_MEMORY_ALLOCATION_ERROR.
*
* @param label Input domain name label
* @param dest Destination string object
* @param info Output container of IDNA processing details.
* @param errorCode Standard ICU error code. Its input value must
* pass the U_SUCCESS() test, or else the function returns
* immediately. Check for U_FAILURE() on output or use with
* function chaining. (See User Guide for details.)
* @return dest
* @stable ICU 4.6
*/
virtual UnicodeString &
labelToASCII(const UnicodeString &label, UnicodeString &dest,
IDNAInfo &info, UErrorCode &errorCode) const = 0;
/**
* Converts a single domain name label into its Unicode form for human-readable display.
* If any processing step fails, then info.hasErrors() will be TRUE.
* The label might be modified according to the types of errors.
*
* The UErrorCode indicates an error only in exceptional cases,
* such as a U_MEMORY_ALLOCATION_ERROR.
*
* @param label Input domain name label
* @param dest Destination string object
* @param info Output container of IDNA processing details.
* @param errorCode Standard ICU error code. Its input value must
* pass the U_SUCCESS() test, or else the function returns
* immediately. Check for U_FAILURE() on output or use with
* function chaining. (See User Guide for details.)
* @return dest
* @stable ICU 4.6
*/
virtual UnicodeString &
labelToUnicode(const UnicodeString &label, UnicodeString &dest,
IDNAInfo &info, UErrorCode &errorCode) const = 0;
/**
* Converts a whole domain name into its ASCII form for DNS lookup.
* If any processing step fails, then info.hasErrors() will be TRUE and
* the result might not be an ASCII string.
* The domain name might be modified according to the types of errors.
* Labels with severe errors will be left in (or turned into) their Unicode form.
*
* The UErrorCode indicates an error only in exceptional cases,
* such as a U_MEMORY_ALLOCATION_ERROR.
*
* @param name Input domain name
* @param dest Destination string object
* @param info Output container of IDNA processing details.
* @param errorCode Standard ICU error code. Its input value must
* pass the U_SUCCESS() test, or else the function returns
* immediately. Check for U_FAILURE() on output or use with
* function chaining. (See User Guide for details.)
* @return dest
* @stable ICU 4.6
*/
virtual UnicodeString &
nameToASCII(const UnicodeString &name, UnicodeString &dest,
IDNAInfo &info, UErrorCode &errorCode) const = 0;
/**
* Converts a whole domain name into its Unicode form for human-readable display.
* If any processing step fails, then info.hasErrors() will be TRUE.
* The domain name might be modified according to the types of errors.
*
* The UErrorCode indicates an error only in exceptional cases,
* such as a U_MEMORY_ALLOCATION_ERROR.
*
* @param name Input domain name
* @param dest Destination string object
* @param info Output container of IDNA processing details.
* @param errorCode Standard ICU error code. Its input value must
* pass the U_SUCCESS() test, or else the function returns
* immediately. Check for U_FAILURE() on output or use with
* function chaining. (See User Guide for details.)
* @return dest
* @stable ICU 4.6
*/
virtual UnicodeString &
nameToUnicode(const UnicodeString &name, UnicodeString &dest,
IDNAInfo &info, UErrorCode &errorCode) const = 0;
// UTF-8 versions of the processing methods ---------------------------- ***
/**
* Converts a single domain name label into its ASCII form for DNS lookup.
* UTF-8 version of labelToASCII(), same behavior.
*
* @param label Input domain name label
* @param dest Destination byte sink; Flush()ed if successful
* @param info Output container of IDNA processing details.
* @param errorCode Standard ICU error code. Its input value must
* pass the U_SUCCESS() test, or else the function returns
* immediately. Check for U_FAILURE() on output or use with
* function chaining. (See User Guide for details.)
* @return dest
* @stable ICU 4.6
*/
virtual void
labelToASCII_UTF8(const StringPiece &label, ByteSink &dest,
IDNAInfo &info, UErrorCode &errorCode) const;
/**
* Converts a single domain name label into its Unicode form for human-readable display.
* UTF-8 version of labelToUnicode(), same behavior.
*
* @param label Input domain name label
* @param dest Destination byte sink; Flush()ed if successful
* @param info Output container of IDNA processing details.
* @param errorCode Standard ICU error code. Its input value must
* pass the U_SUCCESS() test, or else the function returns
* immediately. Check for U_FAILURE() on output or use with
* function chaining. (See User Guide for details.)
* @return dest
* @stable ICU 4.6
*/
virtual void
labelToUnicodeUTF8(const StringPiece &label, ByteSink &dest,
IDNAInfo &info, UErrorCode &errorCode) const;
/**
* Converts a whole domain name into its ASCII form for DNS lookup.
* UTF-8 version of nameToASCII(), same behavior.
*
* @param name Input domain name
* @param dest Destination byte sink; Flush()ed if successful
* @param info Output container of IDNA processing details.
* @param errorCode Standard ICU error code. Its input value must
* pass the U_SUCCESS() test, or else the function returns
* immediately. Check for U_FAILURE() on output or use with
* function chaining. (See User Guide for details.)
* @return dest
* @stable ICU 4.6
*/
virtual void
nameToASCII_UTF8(const StringPiece &name, ByteSink &dest,
IDNAInfo &info, UErrorCode &errorCode) const;
/**
* Converts a whole domain name into its Unicode form for human-readable display.
* UTF-8 version of nameToUnicode(), same behavior.
*
* @param name Input domain name
* @param dest Destination byte sink; Flush()ed if successful
* @param info Output container of IDNA processing details.
* @param errorCode Standard ICU error code. Its input value must
* pass the U_SUCCESS() test, or else the function returns
* immediately. Check for U_FAILURE() on output or use with
* function chaining. (See User Guide for details.)
* @return dest
* @stable ICU 4.6
*/
virtual void
nameToUnicodeUTF8(const StringPiece &name, ByteSink &dest,
IDNAInfo &info, UErrorCode &errorCode) const;
};
class UTS46;
/**
* Output container for IDNA processing errors.
* The IDNAInfo class is not suitable for subclassing.
* @stable ICU 4.6
*/
class U_COMMON_API IDNAInfo : public UMemory {
public:
/**
* Constructor for stack allocation.
* @stable ICU 4.6
*/
IDNAInfo() : errors(0), labelErrors(0), isTransDiff(FALSE), isBiDi(FALSE), isOkBiDi(TRUE) {}
/**
* Were there IDNA processing errors?
* @return TRUE if there were processing errors
* @stable ICU 4.6
*/
UBool hasErrors() const { return errors!=0; }
/**
* Returns a bit set indicating IDNA processing errors.
* See UIDNA_ERROR_... constants in uidna.h.
* @return bit set of processing errors
* @stable ICU 4.6
*/
uint32_t getErrors() const { return errors; }
/**
* Returns TRUE if transitional and nontransitional processing produce different results.
* This is the case when the input label or domain name contains
* one or more deviation characters outside a Punycode label (see UTS #46).
* <ul>
* <li>With nontransitional processing, such characters are
* copied to the destination string.
* <li>With transitional processing, such characters are
* mapped (sharp s/sigma) or removed (joiner/nonjoiner).
* </ul>
* @return TRUE if transitional and nontransitional processing produce different results
* @stable ICU 4.6
*/
UBool isTransitionalDifferent() const { return isTransDiff; }
private:
friend class UTS46;
IDNAInfo(const IDNAInfo &other); // no copying
IDNAInfo &operator=(const IDNAInfo &other); // no copying
void reset() {
errors=labelErrors=0;
isTransDiff=FALSE;
isBiDi=FALSE;
isOkBiDi=TRUE;
}
uint32_t errors, labelErrors;
UBool isTransDiff;
UBool isBiDi;
UBool isOkBiDi;
};
U_NAMESPACE_END
#endif // UCONFIG_NO_IDNA
#endif // __IDNA_H__
|