idna.h

Go to the documentation of this file.

// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
*******************************************************************************
*   Copyright (C) 2010-2012, International Business Machines
*   Corporation and others.  All Rights Reserved.
*******************************************************************************
*   file name:  idna.h
*   encoding:   UTF-8
*   tab size:   8 (not used)
*   indentation:4
*
*   created on: 2010mar05
*   created by: Markus W. Scherer
*/
 
#ifndef __IDNA_H__
#define __IDNA_H__

 
#include "unicode/utypes.h"
 
#if U_SHOW_CPLUSPLUS_API
 
#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;

class U_COMMON_API IDNA : public UObject {
public:
    ~IDNA();

    static IDNA *
    createUTS46Instance(uint32_t options, UErrorCode &errorCode);

    virtual UnicodeString&
    labelToASCII(const UnicodeString& label,
                 UnicodeString& dest U_LIFETIME_BOUND,
                 IDNAInfo& info,
                 UErrorCode& errorCode) const = 0;

    virtual UnicodeString&
    labelToUnicode(const UnicodeString& label,
                   UnicodeString& dest U_LIFETIME_BOUND,
                   IDNAInfo& info,
                   UErrorCode& errorCode) const = 0;

    virtual UnicodeString&
    nameToASCII(const UnicodeString& name,
                UnicodeString& dest U_LIFETIME_BOUND,
                IDNAInfo& info,
                UErrorCode& errorCode) const = 0;

    virtual UnicodeString&
    nameToUnicode(const UnicodeString& name,
                  UnicodeString& dest U_LIFETIME_BOUND,
                  IDNAInfo& info,
                  UErrorCode& errorCode) const = 0;
 
    // UTF-8 versions of the processing methods ---------------------------- ***

    virtual void
    labelToASCII_UTF8(StringPiece label, ByteSink &dest,
                      IDNAInfo &info, UErrorCode &errorCode) const;

    virtual void
    labelToUnicodeUTF8(StringPiece label, ByteSink &dest,
                       IDNAInfo &info, UErrorCode &errorCode) const;

    virtual void
    nameToASCII_UTF8(StringPiece name, ByteSink &dest,
                     IDNAInfo &info, UErrorCode &errorCode) const;

    virtual void
    nameToUnicodeUTF8(StringPiece name, ByteSink &dest,
                      IDNAInfo &info, UErrorCode &errorCode) const;
};
 
class UTS46;

class U_COMMON_API IDNAInfo : public UMemory {
public:
    IDNAInfo() : errors(0), labelErrors(0), isTransDiff(false), isBiDi(false), isOkBiDi(true) {}
    UBool hasErrors() const { return errors!=0; }
    uint32_t getErrors() const { return errors; }
    UBool isTransitionalDifferent() const { return isTransDiff; }
 
private:
    friend class UTS46;
 
    IDNAInfo(const IDNAInfo &other) = delete;  // no copying
    IDNAInfo &operator=(const IDNAInfo &other) = delete;  // 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 /* U_SHOW_CPLUSPLUS_API */
 
#endif  // __IDNA_H__