ICU 56 update step 1

source/common/unicode/uidna.h

 /*
  *******************************************************************************
  *
- *   Copyright (C) 2003-2013, International Business Machines
+ *   Copyright (C) 2003-2014, International Business Machines
  *   Corporation and others.  All Rights Reserved.
  *
  *******************************************************************************
  *   file name:  uidna.h
  *   encoding:   US-ASCII
  *   tab size:   8 (not used)
  *   indentation:4
  *
  *   created on: 2003feb1
  *   created by: Ram Viswanadha
@@ skipping 10 matching lines @@
 #include "unicode/parseerr.h"
 
 /**
  * \file
  * \brief C API: Internationalizing Domain Names in Applications (IDNA)
  *
  * IDNA2008 is implemented according to UTS #46, see the IDNA C++ class in idna.h.
  *
  * The C API functions which do take a UIDNA * service object pointer
  * implement UTS #46 and IDNA2008.
+ *
+ * IDNA2003 is obsolete.
  * The C API functions which do not take a service object pointer
- * implement IDNA2003.
+ * implement IDNA2003. They are all deprecated.
  */
 
 /*
  * IDNA option bit set values.
  */
 enum {
     /**
      * Default options value: None of the other options are set.
      * For use in static worker and factory methods.
      * @stable ICU 2.6
      */
     UIDNA_DEFAULT=0,
+#ifndef U_HIDE_DEPRECATED_API
     /**
      * Option to allow unassigned code points in domain names and labels.
      * For use in static worker and factory methods.
      * <p>This option is ignored by the UTS46 implementation.
      * (UTS #46 disallows unassigned code points.)
-     * @stable ICU 2.6
+     * @deprecated ICU 55 Use UTS #46 instead via uidna_openUTS46() or class IDNA.
      */
     UIDNA_ALLOW_UNASSIGNED=1,
+#endif  /* U_HIDE_DEPRECATED_API */
     /**
      * Option to check whether the input conforms to the STD3 ASCII rules,
      * for example the restriction of labels to LDH characters
      * (ASCII Letters, Digits and Hyphen-Minus).
      * For use in static worker and factory methods.
      * @stable ICU 2.6
      */
     UIDNA_USE_STD3_RULES=2,
     /**
      * IDNA option to check for whether the input conforms to the BiDi rules.
@@ skipping 429 matching lines @@
      */
     UIDNA_ERROR_CONTEXTO_PUNCTUATION=0x2000,
     /**
      * A label does not meet the IDNA CONTEXTO requirements for digits.
      * Arabic-Indic Digits (U+066x) must not be mixed with Extended Arabic-Indic Digits (U+06Fx).
      * @stable ICU 49
      */
     UIDNA_ERROR_CONTEXTO_DIGITS=0x4000
 };
 
+#ifndef U_HIDE_DEPRECATED_API
+
 /* IDNA2003 API ------------------------------------------------------------- */
 
 /**
  * IDNA2003: This function implements the ToASCII operation as defined in the IDNA RFC.
  * This operation is done on <b>single labels</b> before sending it to something that expects
  * ASCII names. A label is an individual part of a domain name. Labels are usually
  * separated by dots; e.g. "www.example.com" is composed of 3 labels "www","example", and "com".
  *
  * IDNA2003 API Overview:
  *
@@ skipping 39 matching lines @@
  * @param parseError        Pointer to UParseError struct to receive information on position 
  *                          of error if an error is encountered. Can be NULL.
  * @param status            ICU in/out error code parameter.
  *                          U_INVALID_CHAR_FOUND if src contains
  *                          unmatched single surrogates.
  *                          U_INDEX_OUTOFBOUNDS_ERROR if src contains
  *                          too many code points.
  *                          U_BUFFER_OVERFLOW_ERROR if destCapacity is not enough
  * @return The length of the result string, if successful - or in case of a buffer overflow,
  *         in which case it will be greater than destCapacity.
- * @stable ICU 2.6
+ * @deprecated ICU 55 Use UTS #46 instead via uidna_openUTS46() or class IDNA.
  */
-U_STABLE int32_t U_EXPORT2
+U_DEPRECATED int32_t U_EXPORT2
 uidna_toASCII(const UChar* src, int32_t srcLength, 
               UChar* dest, int32_t destCapacity,
               int32_t options,
               UParseError* parseError,
               UErrorCode* status);
 
 
 /**
  * IDNA2003: This function implements the ToUnicode operation as defined in the IDNA RFC.
  * This operation is done on <b>single labels</b> before sending it to something that expects
@@ skipping 25 matching lines @@
  * @param parseError        Pointer to UParseError struct to receive information on position 
  *                          of error if an error is encountered. Can be NULL.
  * @param status            ICU in/out error code parameter.
  *                          U_INVALID_CHAR_FOUND if src contains
  *                          unmatched single surrogates.
  *                          U_INDEX_OUTOFBOUNDS_ERROR if src contains
  *                          too many code points.
  *                          U_BUFFER_OVERFLOW_ERROR if destCapacity is not enough
  * @return The length of the result string, if successful - or in case of a buffer overflow,
  *         in which case it will be greater than destCapacity.
- * @stable ICU 2.6
+ * @deprecated ICU 55 Use UTS #46 instead via uidna_openUTS46() or class IDNA.
  */
-U_STABLE int32_t U_EXPORT2
+U_DEPRECATED int32_t U_EXPORT2
 uidna_toUnicode(const UChar* src, int32_t srcLength,
                 UChar* dest, int32_t destCapacity,
                 int32_t options,
                 UParseError* parseError,
                 UErrorCode* status);
 
 
 /**
  * IDNA2003: Convenience function that implements the IDNToASCII operation as defined in the IDNA RFC.
  * This operation is done on complete domain names, e.g: "www.example.com". 
@@ skipping 28 matching lines @@
  * @param parseError        Pointer to UParseError struct to receive information on position 
  *                          of error if an error is encountered. Can be NULL.
  * @param status            ICU in/out error code parameter.
  *                          U_INVALID_CHAR_FOUND if src contains
  *                          unmatched single surrogates.
  *                          U_INDEX_OUTOFBOUNDS_ERROR if src contains
  *                          too many code points.
  *                          U_BUFFER_OVERFLOW_ERROR if destCapacity is not enough
  * @return The length of the result string, if successful - or in case of a buffer overflow,
  *         in which case it will be greater than destCapacity.
- * @stable ICU 2.6
+ * @deprecated ICU 55 Use UTS #46 instead via uidna_openUTS46() or class IDNA.
  */
-U_STABLE int32_t U_EXPORT2
+U_DEPRECATED int32_t U_EXPORT2
 uidna_IDNToASCII(  const UChar* src, int32_t srcLength,
                    UChar* dest, int32_t destCapacity,
                    int32_t options,
                    UParseError* parseError,
                    UErrorCode* status);
 
 /**
  * IDNA2003: Convenience function that implements the IDNToUnicode operation as defined in the IDNA RFC.
  * This operation is done on complete domain names, e.g: "www.example.com". 
  *
@@ skipping 24 matching lines @@
  * @param parseError        Pointer to UParseError struct to receive information on position 
  *                          of error if an error is encountered. Can be NULL.
  * @param status            ICU in/out error code parameter.
  *                          U_INVALID_CHAR_FOUND if src contains
  *                          unmatched single surrogates.
  *                          U_INDEX_OUTOFBOUNDS_ERROR if src contains
  *                          too many code points.
  *                          U_BUFFER_OVERFLOW_ERROR if destCapacity is not enough
  * @return The length of the result string, if successful - or in case of a buffer overflow,
  *         in which case it will be greater than destCapacity.
- * @stable ICU 2.6
+ * @deprecated ICU 55 Use UTS #46 instead via uidna_openUTS46() or class IDNA.
  */
-U_STABLE int32_t U_EXPORT2
+U_DEPRECATED int32_t U_EXPORT2
 uidna_IDNToUnicode(  const UChar* src, int32_t srcLength,
                      UChar* dest, int32_t destCapacity,
                      int32_t options,
                      UParseError* parseError,
                      UErrorCode* status);
 
 /**
  * IDNA2003: Compare two IDN strings for equivalence.
  * This function splits the domain names into labels and compares them.
  * According to IDN RFC, whenever two labels are compared, they are 
@@ skipping 18 matching lines @@
  *                              If this option is set, the unassigned code points are in the input 
  *                              are treated as normal Unicode code points.
  *
  *  - UIDNA_USE_STD3_RULES      Use STD3 ASCII rules for host name syntax restrictions
  *                              If this option is set and the input does not satisfy STD3 rules,  
  *                              the operation will fail with U_IDNA_STD3_ASCII_RULES_ERROR
  *
  * @param status            ICU error code in/out parameter.
  *                          Must fulfill U_SUCCESS before the function call.
  * @return <0 or 0 or >0 as usual for string comparisons
- * @stable ICU 2.6
+ * @deprecated ICU 55 Use UTS #46 instead via uidna_openUTS46() or class IDNA.
  */
-U_STABLE int32_t U_EXPORT2
+U_DEPRECATED int32_t U_EXPORT2
 uidna_compare(  const UChar *s1, int32_t length1,
                 const UChar *s2, int32_t length2,
                 int32_t options,
                 UErrorCode* status);
 
+#endif  /* U_HIDE_DEPRECATED_API */
+
 #endif /* #if !UCONFIG_NO_IDNA */
 
 #endif