ICU-62141.0.1.tar.gz

[apple/icu.git] / icuSources / i18n / unicode / regex.h

diff --git a/icuSources/i18n/unicode/regex.h b/icuSources/i18n/unicode/regex.h
index c3c6441b6f8cb4ff632a878a73088d48a43fe574..8e3b1cb30f7cc4f8ef4dfd2ad1b9188773c2e918 100644 (file)
--- a/icuSources/i18n/unicode/regex.h
+++ b/icuSources/i18n/unicode/regex.h
@@ -1,10 +1,12 @@
+// © 2016 and later: Unicode, Inc. and others.
+// License & terms of use: http://www.unicode.org/copyright.html

 /*
 **********************************************************************
 /*
 **********************************************************************

-*   Copyright (C) 2002-2015, International Business Machines
+*   Copyright (C) 2002-2016, International Business Machines

 *   Corporation and others.  All Rights Reserved.
 **********************************************************************
 *   file name:  regex.h
 *   Corporation and others.  All Rights Reserved.
 **********************************************************************
 *   file name:  regex.h

-*   encoding:   US-ASCII
+*   encoding:   UTF-8

 *   indentation:4
 *
 *   created on: 2002oct22
 *   indentation:4
 *
 *   created on: 2002oct22


@@ -57,6 +59,7 @@
 
 struct UHashtable;
 
 
 struct UHashtable;
 

+#if U_SHOW_CPLUSPLUS_API

 U_NAMESPACE_BEGIN
 
 struct Regex8BitSet;
 U_NAMESPACE_BEGIN
 
 struct Regex8BitSet;


@@ -348,17 +351,17 @@ public:
 private:
     /**
      * Cause a compilation error if an application accidentally attempts to
 private:
     /**
      * Cause a compilation error if an application accidentally attempts to

-     *   create a matcher with a (UChar *) string as input rather than
+     *   create a matcher with a (char16_t *) string as input rather than

      *   a UnicodeString.  Avoids a dangling reference to a temporary string.
      * <p>
      *   a UnicodeString.  Avoids a dangling reference to a temporary string.
      * <p>

-     * To efficiently work with UChar *strings, wrap the data in a UnicodeString
+     * To efficiently work with char16_t *strings, wrap the data in a UnicodeString

      * using one of the aliasing constructors, such as
      * using one of the aliasing constructors, such as

-     * <code>UnicodeString(UBool isTerminated, const UChar *text, int32_t textLength);</code>
+     * <code>UnicodeString(UBool isTerminated, const char16_t *text, int32_t textLength);</code>

      * or in a UText, using
      * or in a UText, using

-     * <code>utext_openUChars(UText *ut, const UChar *text, int64_t textLength, UErrorCode *status);</code>
+     * <code>utext_openUChars(UText *ut, const char16_t *text, int64_t textLength, UErrorCode *status);</code>

      *
      */
      *
      */

-    RegexMatcher *matcher(const UChar *input,
+    RegexMatcher *matcher(const char16_t *input,

         UErrorCode          &status) const;
 public:
 
         UErrorCode          &status) const;
 public:
 


@@ -450,7 +453,7 @@ public:
      * @param  groupName   The capture group name.
      * @param  status      A UErrorCode to receive any errors.
      *
      * @param  groupName   The capture group name.
      * @param  status      A UErrorCode to receive any errors.
      *

-     * @draft ICU 55
+     * @stable ICU 55

      */
     virtual int32_t groupNumberFromName(const UnicodeString &groupName, UErrorCode &status) const;
 
      */
     virtual int32_t groupNumberFromName(const UnicodeString &groupName, UErrorCode &status) const;
 


@@ -469,7 +472,7 @@ public:
      *                     nul-terminated.
      * @param  status      A UErrorCode to receive any errors.
      *
      *                     nul-terminated.
      * @param  status      A UErrorCode to receive any errors.
      *

-     * @draft ICU 55
+     * @stable ICU 55

      */
     virtual int32_t groupNumberFromName(const char *groupName, int32_t nameLength, UErrorCode &status) const;
 
      */
     virtual int32_t groupNumberFromName(const char *groupName, int32_t nameLength, UErrorCode &status) const;
 


@@ -746,17 +749,17 @@ public:
 private:
     /**
      * Cause a compilation error if an application accidentally attempts to
 private:
     /**
      * Cause a compilation error if an application accidentally attempts to

-     *   create a matcher with a (UChar *) string as input rather than
+     *   create a matcher with a (char16_t *) string as input rather than

      *   a UnicodeString.    Avoids a dangling reference to a temporary string.
      * <p>
      *   a UnicodeString.    Avoids a dangling reference to a temporary string.
      * <p>

-     * To efficiently work with UChar *strings, wrap the data in a UnicodeString
+     * To efficiently work with char16_t *strings, wrap the data in a UnicodeString

      * using one of the aliasing constructors, such as
      * using one of the aliasing constructors, such as

-     * <code>UnicodeString(UBool isTerminated, const UChar *text, int32_t textLength);</code>
+     * <code>UnicodeString(UBool isTerminated, const char16_t *text, int32_t textLength);</code>

      * or in a UText, using
      * or in a UText, using

-     * <code>utext_openUChars(UText *ut, const UChar *text, int64_t textLength, UErrorCode *status);</code>
+     * <code>utext_openUChars(UText *ut, const char16_t *text, int64_t textLength, UErrorCode *status);</code>

      *
      */
      *
      */

-    RegexMatcher(const UnicodeString &regexp, const UChar *input,
+    RegexMatcher(const UnicodeString &regexp, const char16_t *input,

         uint32_t flags, UErrorCode &status);
 public:
 
         uint32_t flags, UErrorCode &status);
 public:
 


@@ -849,7 +852,7 @@ public:
     *     position may not be valid with the altered input string.</p>
     *  @param   status  A reference to a UErrorCode to receive any errors.
     *  @return  TRUE if a match is found.
     *     position may not be valid with the altered input string.</p>
     *  @param   status  A reference to a UErrorCode to receive any errors.
     *  @return  TRUE if a match is found.

-    *  @draft ICU 55
+    * @stable ICU 55

     */
     virtual UBool find(UErrorCode &status);
 
     */
     virtual UBool find(UErrorCode &status);
 


@@ -881,6 +884,11 @@ public:
     *    Returns a string containing the text captured by the given group
     *    during the previous match operation.  Group(0) is the entire match.
     *
     *    Returns a string containing the text captured by the given group
     *    during the previous match operation.  Group(0) is the entire match.
     *

+    *    A zero length string is returned both for capture groups that did not
+    *    participate in the match and for actual zero length matches.
+    *    To distinguish between these two cases use the function start(),
+    *    which returns -1 for non-participating groups.
+    *

     *    @param groupNum the capture group number
     *    @param   status     A reference to a UErrorCode to receive any errors.
     *                        Possible errors are  U_REGEX_INVALID_STATE if no match
     *    @param groupNum the capture group number
     *    @param   status     A reference to a UErrorCode to receive any errors.
     *                        Possible errors are  U_REGEX_INVALID_STATE if no match


@@ -919,6 +927,11 @@ public:
     *   Returns a shallow clone of the entire live input string with the UText current native index
     *   set to the beginning of the requested group.
     *
     *   Returns a shallow clone of the entire live input string with the UText current native index
     *   set to the beginning of the requested group.
     *

+    *   A group length of zero is returned both for capture groups that did not
+    *   participate in the match and for actual zero length matches.
+    *   To distinguish between these two cases use the function start(),
+    *   which returns -1 for non-participating groups.
+    *

     *   @param   groupNum   The capture group number.
     *   @param   dest        The UText into which the input should be cloned, or NULL to create a new UText.
     *   @param   group_len   A reference to receive the length of the desired capture group
     *   @param   groupNum   The capture group number.
     *   @param   dest        The UText into which the input should be cloned, or NULL to create a new UText.
     *   @param   group_len   A reference to receive the length of the desired capture group


@@ -1144,17 +1157,17 @@ public:
 private:
     /**
      * Cause a compilation error if an application accidentally attempts to
 private:
     /**
      * Cause a compilation error if an application accidentally attempts to

-     *   reset a matcher with a (UChar *) string as input rather than
+     *   reset a matcher with a (char16_t *) string as input rather than

      *   a UnicodeString.    Avoids a dangling reference to a temporary string.
      * <p>
      *   a UnicodeString.    Avoids a dangling reference to a temporary string.
      * <p>

-     * To efficiently work with UChar *strings, wrap the data in a UnicodeString
+     * To efficiently work with char16_t *strings, wrap the data in a UnicodeString

      * using one of the aliasing constructors, such as
      * using one of the aliasing constructors, such as

-     * <code>UnicodeString(UBool isTerminated, const UChar *text, int32_t textLength);</code>
+     * <code>UnicodeString(UBool isTerminated, const char16_t *text, int32_t textLength);</code>

      * or in a UText, using
      * or in a UText, using

-     * <code>utext_openUChars(UText *ut, const UChar *text, int64_t textLength, UErrorCode *status);</code>
+     * <code>utext_openUChars(UText *ut, const char16_t *text, int64_t textLength, UErrorCode *status);</code>

      *
      */
      *
      */

-    RegexMatcher &reset(const UChar *input);
+    RegexMatcher &reset(const char16_t *input);

 public:
 
    /**
 public:
 
    /**


@@ -1869,5 +1882,7 @@ private:
 };
 
 U_NAMESPACE_END
 };
 
 U_NAMESPACE_END

+#endif // U_SHOW_CPLUSPLUS_API
+

 #endif  // UCONFIG_NO_REGULAR_EXPRESSIONS
 #endif
 #endif  // UCONFIG_NO_REGULAR_EXPRESSIONS
 #endif