ICU 69.1  69.1
idna.h
Go to the documentation of this file.
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 *******************************************************************************
5 * Copyright (C) 2010-2012, International Business Machines
6 * Corporation and others. All Rights Reserved.
7 *******************************************************************************
8 * file name: idna.h
9 * encoding: UTF-8
10 * tab size: 8 (not used)
11 * indentation:4
12 *
13 * created on: 2010mar05
14 * created by: Markus W. Scherer
15 */
16 
17 #ifndef __IDNA_H__
18 #define __IDNA_H__
19 
25 #include "unicode/utypes.h"
26 
27 #if U_SHOW_CPLUSPLUS_API
28 
29 #if !UCONFIG_NO_IDNA
30 
31 #include "unicode/bytestream.h"
32 #include "unicode/stringpiece.h"
33 #include "unicode/uidna.h"
34 #include "unicode/unistr.h"
35 
36 U_NAMESPACE_BEGIN
37 
38 class IDNAInfo;
39 
52 class U_COMMON_API IDNA : public UObject {
53 public:
58  ~IDNA();
59 
93  static IDNA *
94  createUTS46Instance(uint32_t options, UErrorCode &errorCode);
95 
116  virtual UnicodeString &
118  IDNAInfo &info, UErrorCode &errorCode) const = 0;
119 
138  virtual UnicodeString &
140  IDNAInfo &info, UErrorCode &errorCode) const = 0;
141 
162  virtual UnicodeString &
164  IDNAInfo &info, UErrorCode &errorCode) const = 0;
165 
184  virtual UnicodeString &
186  IDNAInfo &info, UErrorCode &errorCode) const = 0;
187 
188  // UTF-8 versions of the processing methods ---------------------------- ***
189 
204  virtual void
206  IDNAInfo &info, UErrorCode &errorCode) const;
207 
222  virtual void
224  IDNAInfo &info, UErrorCode &errorCode) const;
225 
240  virtual void
242  IDNAInfo &info, UErrorCode &errorCode) const;
243 
258  virtual void
260  IDNAInfo &info, UErrorCode &errorCode) const;
261 };
262 
263 class UTS46;
264 
270 class U_COMMON_API IDNAInfo : public UMemory {
271 public:
276  IDNAInfo() : errors(0), labelErrors(0), isTransDiff(false), isBiDi(false), isOkBiDi(true) {}
282  UBool hasErrors() const { return errors!=0; }
289  uint32_t getErrors() const { return errors; }
303  UBool isTransitionalDifferent() const { return isTransDiff; }
304 
305 private:
306  friend class UTS46;
307 
308  IDNAInfo(const IDNAInfo &other); // no copying
309  IDNAInfo &operator=(const IDNAInfo &other); // no copying
310 
311  void reset() {
312  errors=labelErrors=0;
313  isTransDiff=false;
314  isBiDi=false;
315  isOkBiDi=true;
316  }
317 
318  uint32_t errors, labelErrors;
319  UBool isTransDiff;
320  UBool isBiDi;
321  UBool isOkBiDi;
322 };
323 
324 U_NAMESPACE_END
325 
326 #endif // UCONFIG_NO_IDNA
327 
328 #endif /* U_SHOW_CPLUSPLUS_API */
329 
330 #endif // __IDNA_H__
C++ API: Interface for writing bytes, and implementation classes.
A ByteSink can be filled with bytes.
Definition: bytestream.h:53
Output container for IDNA processing errors.
Definition: idna.h:270
uint32_t getErrors() const
Returns a bit set indicating IDNA processing errors.
Definition: idna.h:289
UBool hasErrors() const
Were there IDNA processing errors?
Definition: idna.h:282
UBool isTransitionalDifferent() const
Returns true if transitional and nontransitional processing produce different results.
Definition: idna.h:303
IDNAInfo()
Constructor for stack allocation.
Definition: idna.h:276
Abstract base class for IDNA processing.
Definition: idna.h:52
virtual void labelToASCII_UTF8(StringPiece label, ByteSink &dest, IDNAInfo &info, UErrorCode &errorCode) const
Converts a single domain name label into its ASCII form for DNS lookup.
virtual void nameToASCII_UTF8(StringPiece name, ByteSink &dest, IDNAInfo &info, UErrorCode &errorCode) const
Converts a whole domain name into its ASCII form for DNS lookup.
virtual UnicodeString & labelToUnicode(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.
virtual void nameToUnicodeUTF8(StringPiece name, ByteSink &dest, IDNAInfo &info, UErrorCode &errorCode) const
Converts a whole domain name into its Unicode form for human-readable display.
virtual void labelToUnicodeUTF8(StringPiece label, ByteSink &dest, IDNAInfo &info, UErrorCode &errorCode) const
Converts a single domain name label into its Unicode form for human-readable display.
virtual UnicodeString & nameToASCII(const UnicodeString &name, UnicodeString &dest, IDNAInfo &info, UErrorCode &errorCode) const =0
Converts a whole domain name into its ASCII form for DNS lookup.
static IDNA * createUTS46Instance(uint32_t options, UErrorCode &errorCode)
Returns an IDNA instance which implements UTS #46.
~IDNA()
Destructor.
virtual UnicodeString & labelToASCII(const UnicodeString &label, UnicodeString &dest, IDNAInfo &info, UErrorCode &errorCode) const =0
Converts a single domain name label into its ASCII form for DNS lookup.
virtual UnicodeString & nameToUnicode(const UnicodeString &name, UnicodeString &dest, IDNAInfo &info, UErrorCode &errorCode) const =0
Converts a whole domain name into its Unicode form for human-readable display.
A string-like object that points to a sized piece of memory.
Definition: stringpiece.h:60
UMemory is the common ICU base class.
Definition: uobject.h:115
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:223
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:296
C++ API: StringPiece: Read-only byte string wrapper class.
C API: Internationalizing Domain Names in Applications (IDNA)
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:269
C++ API: Unicode String.
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
#define U_COMMON_API
Set to export library symbols from inside the common library, and to import them from outside.
Definition: utypes.h:300