ICU-59180.0.1.tar.gz

[apple/icu.git] / icuSources / common / unicode / utext.h

diff --git a/icuSources/common/unicode/utext.h b/icuSources/common/unicode/utext.h
index 866b850390d2fc7492846ea030e6c84853a5d23b..657ba755af6efb035536503e23fee73711100975 100644 (file)
--- a/icuSources/common/unicode/utext.h
+++ b/icuSources/common/unicode/utext.h
@@ -1,12 +1,14 @@
+// © 2016 and later: Unicode, Inc. and others.
+// License & terms of use: http://www.unicode.org/copyright.html

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

-*   Copyright (C) 2004-2008, International Business Machines
+*   Copyright (C) 2004-2012, International Business Machines

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

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

 *   tab size:   8 (not used)
 *   indentation:4
 *
 *   tab size:   8 (not used)
 *   indentation:4
 *


@@ -136,11 +138,13 @@
 
 
 #include "unicode/utypes.h"
 
 
 #include "unicode/utypes.h"

-#ifdef XP_CPLUSPLUS
+#include "unicode/uchar.h"
+#if U_SHOW_CPLUSPLUS_API
+#include "unicode/localpointer.h"

 #include "unicode/rep.h"
 #include "unicode/unistr.h"
 #include "unicode/chariter.h"
 #include "unicode/rep.h"
 #include "unicode/unistr.h"
 #include "unicode/chariter.h"

-#endif
+#endif // U_SHOW_CPLUSPLUS_API

 
 
 U_CDECL_BEGIN
 
 
 U_CDECL_BEGIN


@@ -179,6 +183,24 @@ typedef struct UText UText; /**< C typedef for struct UText. @stable ICU 3.6 */
 U_STABLE UText * U_EXPORT2
 utext_close(UText *ut);
 
 U_STABLE UText * U_EXPORT2
 utext_close(UText *ut);
 

+#if U_SHOW_CPLUSPLUS_API
+
+U_NAMESPACE_BEGIN
+
+/**
+ * \class LocalUTextPointer
+ * "Smart pointer" class, closes a UText via utext_close().
+ * For most methods see the LocalPointerBase base class.
+ *
+ * @see LocalPointerBase
+ * @see LocalPointer
+ * @stable ICU 4.4
+ */
+U_DEFINE_LOCAL_OPEN_POINTER(LocalUTextPointer, UText, utext_close);
+
+U_NAMESPACE_END
+
+#endif // U_SHOW_CPLUSPLUS_API

 
 /**
  * Open a read-only UText implementation for UTF-8 strings.
 
 /**
  * Open a read-only UText implementation for UTF-8 strings.


@@ -223,7 +245,7 @@ U_STABLE UText * U_EXPORT2
 utext_openUChars(UText *ut, const UChar *s, int64_t length, UErrorCode *status);
 
 
 utext_openUChars(UText *ut, const UChar *s, int64_t length, UErrorCode *status);
 
 

-#ifdef XP_CPLUSPLUS
+#if U_SHOW_CPLUSPLUS_API

 /**
  * Open a writable UText for a non-const UnicodeString. 
  * 
 /**
  * Open a writable UText for a non-const UnicodeString. 
  * 


@@ -237,7 +259,7 @@ utext_openUChars(UText *ut, const UChar *s, int64_t length, UErrorCode *status);
  * @stable ICU 3.4
  */
 U_STABLE UText * U_EXPORT2
  * @stable ICU 3.4
  */
 U_STABLE UText * U_EXPORT2

-utext_openUnicodeString(UText *ut, U_NAMESPACE_QUALIFIER UnicodeString *s, UErrorCode *status);
+utext_openUnicodeString(UText *ut, icu::UnicodeString *s, UErrorCode *status);

 
 
 /**
 
 
 /**


@@ -253,7 +275,7 @@ utext_openUnicodeString(UText *ut, U_NAMESPACE_QUALIFIER UnicodeString *s, UErro
  * @stable ICU 3.4
  */
 U_STABLE UText * U_EXPORT2
  * @stable ICU 3.4
  */
 U_STABLE UText * U_EXPORT2

-utext_openConstUnicodeString(UText *ut, const U_NAMESPACE_QUALIFIER UnicodeString *s, UErrorCode *status);
+utext_openConstUnicodeString(UText *ut, const icu::UnicodeString *s, UErrorCode *status);

 
 
 /**
 
 
 /**


@@ -269,7 +291,7 @@ utext_openConstUnicodeString(UText *ut, const U_NAMESPACE_QUALIFIER UnicodeStrin
  * @stable ICU 3.4
  */
 U_STABLE UText * U_EXPORT2
  * @stable ICU 3.4
  */
 U_STABLE UText * U_EXPORT2

-utext_openReplaceable(UText *ut, U_NAMESPACE_QUALIFIER Replaceable *rep, UErrorCode *status);
+utext_openReplaceable(UText *ut, icu::Replaceable *rep, UErrorCode *status);

 
 /**
  * Open a  UText implementation over an ICU CharacterIterator.
 
 /**
  * Open a  UText implementation over an ICU CharacterIterator.


@@ -284,9 +306,9 @@ utext_openReplaceable(UText *ut, U_NAMESPACE_QUALIFIER Replaceable *rep, UErrorC
  * @stable ICU 3.4
  */
 U_STABLE UText * U_EXPORT2
  * @stable ICU 3.4
  */
 U_STABLE UText * U_EXPORT2

-utext_openCharacterIterator(UText *ut, U_NAMESPACE_QUALIFIER CharacterIterator *ic, UErrorCode *status);
+utext_openCharacterIterator(UText *ut, icu::CharacterIterator *ci, UErrorCode *status);

 
 

-#endif
+#endif // U_SHOW_CPLUSPLUS_API

 
 
 /**
 
 
 /**


@@ -655,6 +677,7 @@ utext_extract(UText *ut,
              UErrorCode *status);
 
 
              UErrorCode *status);
 
 

+

 /************************************************************************************
  *
  *  #define inline versions of selected performance-critical text access functions
 /************************************************************************************
  *
  *  #define inline versions of selected performance-critical text access functions


@@ -670,6 +693,21 @@ utext_extract(UText *ut,
  *
  ************************************************************************************/
 
  *
  ************************************************************************************/
 

+#ifndef U_HIDE_INTERNAL_API
+/**
+ * inline version of utext_current32(), for performance-critical situations.
+ *
+ * Get the code point at the current iteration position of the UText.
+ * Returns U_SENTINEL (-1) if the position is at the end of the
+ * text.
+ *
+ * @internal ICU 4.4 technology preview
+ */
+#define UTEXT_CURRENT32(ut)  \
+    ((ut)->chunkOffset < (ut)->chunkLength && ((ut)->chunkContents)[(ut)->chunkOffset]<0xd800 ? \
+    ((ut)->chunkContents)[((ut)->chunkOffset)] : utext_current32(ut))
+#endif  /* U_HIDE_INTERNAL_API */
+

 /**
  * inline version of utext_next32(), for performance-critical situations.
  *
 /**
  * inline version of utext_next32(), for performance-critical situations.
  *


@@ -726,7 +764,7 @@ utext_extract(UText *ut,
   * If the index is out of range, it will be pinned to be within
   * the range of the input text.
   *
   * If the index is out of range, it will be pinned to be within
   * the range of the input text.
   *

-  * @stable ICU 4.0
+  * @stable ICU 3.8

   */
 #define UTEXT_SETNATIVEINDEX(ut, ix)                       \
     { int64_t __offset = (ix) - (ut)->chunkNativeStart; \
   */
 #define UTEXT_SETNATIVEINDEX(ut, ix)                       \
     { int64_t __offset = (ix) - (ut)->chunkNativeStart; \


@@ -1272,8 +1310,8 @@ struct UTextFuncs {
       * (private)  Spare function pointer
       * @internal
       */
       * (private)  Spare function pointer
       * @internal
       */

-

     UTextClose  *spare1;
     UTextClose  *spare1;

+    

     /**
       * (private)  Spare function pointer
       * @internal
     /**
       * (private)  Spare function pointer
       * @internal


@@ -1517,6 +1555,7 @@ struct UText {
 U_STABLE UText * U_EXPORT2
 utext_setup(UText *ut, int32_t extraSpace, UErrorCode *status);
 
 U_STABLE UText * U_EXPORT2
 utext_setup(UText *ut, int32_t extraSpace, UErrorCode *status);
 

+#ifndef U_HIDE_INTERNAL_API

 /**
   * @internal
   *  Value used to help identify correctly initialized UText structs.
 /**
   * @internal
   *  Value used to help identify correctly initialized UText structs.


@@ -1525,6 +1564,7 @@ utext_setup(UText *ut, int32_t extraSpace, UErrorCode *status);
 enum {
     UTEXT_MAGIC = 0x345ad82c
 };
 enum {
     UTEXT_MAGIC = 0x345ad82c
 };

+#endif  /* U_HIDE_INTERNAL_API */

 
 /**
  * initializer to be used with local (stack) instances of a UText
 
 /**
  * initializer to be used with local (stack) instances of a UText