ICU-64260.0.1.tar.gz

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

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

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

-*   Copyright (C) 2010-2012, International Business Machines
+*   Copyright (C) 2010-2012,2014, International Business Machines

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

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

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


@@ -18,9 +20,16 @@
 #include "unicode/utypes.h"
 #include "unicode/uobject.h"
 
 #include "unicode/utypes.h"
 #include "unicode/uobject.h"
 

+/**
+ * \file
+ * \brief C++ API: Builder API for trie builders
+ */
+

 // Forward declaration.
 // Forward declaration.

+/// \cond

 struct UHashtable;
 typedef struct UHashtable UHashtable;
 struct UHashtable;
 typedef struct UHashtable UHashtable;

+/// \endcond

 
 /**
  * Build options for BytesTrieBuilder and CharsTrieBuilder.
 
 /**
  * Build options for BytesTrieBuilder and CharsTrieBuilder.


@@ -45,6 +54,7 @@ enum UStringTrieBuildOption {
     USTRINGTRIE_BUILD_SMALL
 };
 
     USTRINGTRIE_BUILD_SMALL
 };
 

+#if U_SHOW_CPLUSPLUS_API

 U_NAMESPACE_BEGIN
 
 /**
 U_NAMESPACE_BEGIN
 
 /**


@@ -57,7 +67,7 @@ class U_COMMON_API StringTrieBuilder : public UObject {
 public:
 #ifndef U_HIDE_INTERNAL_API
     /** @internal */
 public:
 #ifndef U_HIDE_INTERNAL_API
     /** @internal */

-    static UBool hashNode(const void *node);
+    static int32_t hashNode(const void *node);

     /** @internal */
     static UBool equalNodes(const void *left, const void *right);
 #endif  /* U_HIDE_INTERNAL_API */
     /** @internal */
     static UBool equalNodes(const void *left, const void *right);
 #endif  /* U_HIDE_INTERNAL_API */


@@ -98,7 +108,7 @@ protected:
     /** @internal */
     virtual int32_t getElementStringLength(int32_t i) const = 0;
     /** @internal */
     /** @internal */
     virtual int32_t getElementStringLength(int32_t i) const = 0;
     /** @internal */

-    virtual UChar getElementUnit(int32_t i, int32_t unitIndex) const = 0;
+    virtual char16_t getElementUnit(int32_t i, int32_t unitIndex) const = 0;

     /** @internal */
     virtual int32_t getElementValue(int32_t i) const = 0;
 
     /** @internal */
     virtual int32_t getElementValue(int32_t i) const = 0;
 


@@ -113,7 +123,7 @@ protected:
     /** @internal */
     virtual int32_t skipElementsBySomeUnits(int32_t i, int32_t unitIndex, int32_t count) const = 0;
     /** @internal */
     /** @internal */
     virtual int32_t skipElementsBySomeUnits(int32_t i, int32_t unitIndex, int32_t count) const = 0;
     /** @internal */

-    virtual int32_t indexOfElementWithNextUnit(int32_t i, int32_t unitIndex, UChar unit) const = 0;
+    virtual int32_t indexOfElementWithNextUnit(int32_t i, int32_t unitIndex, char16_t unit) const = 0;

 
     /** @internal */
     virtual UBool matchNodesCanHaveValues() const = 0;
 
     /** @internal */
     virtual UBool matchNodesCanHaveValues() const = 0;


@@ -130,7 +140,7 @@ protected:
     /** @internal */
     static const int32_t kMaxBranchLinearSubNodeLength=5;
 
     /** @internal */
     static const int32_t kMaxBranchLinearSubNodeLength=5;
 

-    // Maximum number of nested split-branch levels for a branch on all 2^16 possible UChar units.
+    // Maximum number of nested split-branch levels for a branch on all 2^16 possible char16_t units.

     // log2(2^16/kMaxBranchLinearSubNodeLength) rounded up.
     /** @internal */
     static const int32_t kMaxSplitBranchLevels=14;
     // log2(2^16/kMaxBranchLinearSubNodeLength) rounded up.
     /** @internal */
     static const int32_t kMaxSplitBranchLevels=14;


@@ -157,6 +167,7 @@ protected:
      * @internal
      */
     Node *registerFinalValue(int32_t value, UErrorCode &errorCode);
      * @internal
      */
     Node *registerFinalValue(int32_t value, UErrorCode &errorCode);

+#endif  /* U_HIDE_INTERNAL_API */

 
     /*
      * C++ note:
 
     /*
      * C++ note:


@@ -178,7 +189,12 @@ protected:
     /** @internal */
     UHashtable *nodes;
 
     /** @internal */
     UHashtable *nodes;
 

-    /** @internal */
+    // Do not conditionalize the following with #ifndef U_HIDE_INTERNAL_API,
+    // it is needed for layout of other objects.
+    /**
+     * @internal
+     * \cond
+     */

     class Node : public UObject {
     public:
         Node(int32_t initialHash) : hash(initialHash), offset(0) {}
     class Node : public UObject {
     public:
         Node(int32_t initialHash) : hash(initialHash), offset(0) {}


@@ -234,11 +250,9 @@ protected:
     protected:
         int32_t hash;
         int32_t offset;
     protected:
         int32_t hash;
         int32_t offset;

-    private:
-        // No ICU "poor man's RTTI" for this class nor its subclasses.
-        virtual UClassID getDynamicClassID() const;

     };
 
     };
 

+#ifndef U_HIDE_INTERNAL_API

     // This class should not be overridden because
     // registerFinalValue() compares a stack-allocated FinalValueNode
     // (stack-allocated so that we don't unnecessarily create lots of duplicate nodes)
     // This class should not be overridden because
     // registerFinalValue() compares a stack-allocated FinalValueNode
     // (stack-allocated so that we don't unnecessarily create lots of duplicate nodes)


@@ -248,14 +262,19 @@ protected:
     /** @internal */
     class FinalValueNode : public Node {
     public:
     /** @internal */
     class FinalValueNode : public Node {
     public:

-        FinalValueNode(int32_t v) : Node(0x111111*37+v), value(v) {}
+        FinalValueNode(int32_t v) : Node(0x111111u*37u+v), value(v) {}

         virtual UBool operator==(const Node &other) const;
         virtual void write(StringTrieBuilder &builder);
     protected:
         int32_t value;
     };
         virtual UBool operator==(const Node &other) const;
         virtual void write(StringTrieBuilder &builder);
     protected:
         int32_t value;
     };

+#endif  /* U_HIDE_INTERNAL_API */

 
 

-    /** @internal */
+    // Do not conditionalize the following with #ifndef U_HIDE_INTERNAL_API,
+    // it is needed for layout of other objects.
+    /**
+     * @internal 
+     */

     class ValueNode : public Node {
     public:
         ValueNode(int32_t initialHash) : Node(initialHash), hasValue(FALSE), value(0) {}
     class ValueNode : public Node {
     public:
         ValueNode(int32_t initialHash) : Node(initialHash), hasValue(FALSE), value(0) {}


@@ -263,30 +282,38 @@ protected:
         void setValue(int32_t v) {
             hasValue=TRUE;
             value=v;
         void setValue(int32_t v) {
             hasValue=TRUE;
             value=v;

-            hash=hash*37+v;
+            hash=hash*37u+v;

         }
     protected:
         UBool hasValue;
         int32_t value;
     };
 
         }
     protected:
         UBool hasValue;
         int32_t value;
     };
 

-    /** @internal */
+#ifndef U_HIDE_INTERNAL_API
+    /** 
+     * @internal 
+     */

     class IntermediateValueNode : public ValueNode {
     public:
         IntermediateValueNode(int32_t v, Node *nextNode)
     class IntermediateValueNode : public ValueNode {
     public:
         IntermediateValueNode(int32_t v, Node *nextNode)

-                : ValueNode(0x222222*37+hashCode(nextNode)), next(nextNode) { setValue(v); }
+                : ValueNode(0x222222u*37u+hashCode(nextNode)), next(nextNode) { setValue(v); }

         virtual UBool operator==(const Node &other) const;
         virtual int32_t markRightEdgesFirst(int32_t edgeNumber);
         virtual void write(StringTrieBuilder &builder);
     protected:
         Node *next;
     };
         virtual UBool operator==(const Node &other) const;
         virtual int32_t markRightEdgesFirst(int32_t edgeNumber);
         virtual void write(StringTrieBuilder &builder);
     protected:
         Node *next;
     };

+#endif  /* U_HIDE_INTERNAL_API */

 
 

-    /** @internal */
+    // Do not conditionalize the following with #ifndef U_HIDE_INTERNAL_API,
+    // it is needed for layout of other objects.
+    /**
+     * @internal 
+     */

     class LinearMatchNode : public ValueNode {
     public:
         LinearMatchNode(int32_t len, Node *nextNode)
     class LinearMatchNode : public ValueNode {
     public:
         LinearMatchNode(int32_t len, Node *nextNode)

-                : ValueNode((0x333333*37+len)*37+hashCode(nextNode)),
+                : ValueNode((0x333333u*37u+len)*37u+hashCode(nextNode)),

                   length(len), next(nextNode) {}
         virtual UBool operator==(const Node &other) const;
         virtual int32_t markRightEdgesFirst(int32_t edgeNumber);
                   length(len), next(nextNode) {}
         virtual UBool operator==(const Node &other) const;
         virtual int32_t markRightEdgesFirst(int32_t edgeNumber);


@@ -295,7 +322,10 @@ protected:
         Node *next;
     };
 
         Node *next;
     };
 

-    /** @internal */
+#ifndef U_HIDE_INTERNAL_API
+    /**
+     * @internal 
+     */

     class BranchNode : public Node {
     public:
         BranchNode(int32_t initialHash) : Node(initialHash) {}
     class BranchNode : public Node {
     public:
         BranchNode(int32_t initialHash) : Node(initialHash) {}


@@ -303,7 +333,9 @@ protected:
         int32_t firstEdgeNumber;
     };
 
         int32_t firstEdgeNumber;
     };
 

-    /** @internal */
+    /**
+     * @internal 
+     */

     class ListBranchNode : public BranchNode {
     public:
         ListBranchNode() : BranchNode(0x444444), length(0) {}
     class ListBranchNode : public BranchNode {
     public:
         ListBranchNode() : BranchNode(0x444444), length(0) {}


@@ -312,39 +344,41 @@ protected:
         virtual void write(StringTrieBuilder &builder);
         // Adds a unit with a final value.
         void add(int32_t c, int32_t value) {
         virtual void write(StringTrieBuilder &builder);
         // Adds a unit with a final value.
         void add(int32_t c, int32_t value) {

-            units[length]=(UChar)c;
+            units[length]=(char16_t)c;

             equal[length]=NULL;
             values[length]=value;
             ++length;
             equal[length]=NULL;
             values[length]=value;
             ++length;

-            hash=(hash*37+c)*37+value;
+            hash=(hash*37u+c)*37u+value;

         }
         // Adds a unit which leads to another match node.
         void add(int32_t c, Node *node) {
         }
         // Adds a unit which leads to another match node.
         void add(int32_t c, Node *node) {

-            units[length]=(UChar)c;
+            units[length]=(char16_t)c;

             equal[length]=node;
             values[length]=0;
             ++length;
             equal[length]=node;
             values[length]=0;
             ++length;

-            hash=(hash*37+c)*37+hashCode(node);
+            hash=(hash*37u+c)*37u+hashCode(node);

         }
     protected:
         Node *equal[kMaxBranchLinearSubNodeLength];  // NULL means "has final value".
         int32_t length;
         int32_t values[kMaxBranchLinearSubNodeLength];
         }
     protected:
         Node *equal[kMaxBranchLinearSubNodeLength];  // NULL means "has final value".
         int32_t length;
         int32_t values[kMaxBranchLinearSubNodeLength];

-        UChar units[kMaxBranchLinearSubNodeLength];
+        char16_t units[kMaxBranchLinearSubNodeLength];

     };
 
     };
 

-    /** @internal */
+    /**
+     * @internal 
+     */

     class SplitBranchNode : public BranchNode {
     public:
     class SplitBranchNode : public BranchNode {
     public:

-        SplitBranchNode(UChar middleUnit, Node *lessThanNode, Node *greaterOrEqualNode)
-                : BranchNode(((0x555555*37+middleUnit)*37+
-                              hashCode(lessThanNode))*37+hashCode(greaterOrEqualNode)),
+        SplitBranchNode(char16_t middleUnit, Node *lessThanNode, Node *greaterOrEqualNode)
+                : BranchNode(((0x555555u*37u+middleUnit)*37u+
+                              hashCode(lessThanNode))*37u+hashCode(greaterOrEqualNode)),

                   unit(middleUnit), lessThan(lessThanNode), greaterOrEqual(greaterOrEqualNode) {}
         virtual UBool operator==(const Node &other) const;
         virtual int32_t markRightEdgesFirst(int32_t edgeNumber);
         virtual void write(StringTrieBuilder &builder);
     protected:
                   unit(middleUnit), lessThan(lessThanNode), greaterOrEqual(greaterOrEqualNode) {}
         virtual UBool operator==(const Node &other) const;
         virtual int32_t markRightEdgesFirst(int32_t edgeNumber);
         virtual void write(StringTrieBuilder &builder);
     protected:

-        UChar unit;
+        char16_t unit;

         Node *lessThan;
         Node *greaterOrEqual;
     };
         Node *lessThan;
         Node *greaterOrEqual;
     };


@@ -354,7 +388,7 @@ protected:
     class BranchHeadNode : public ValueNode {
     public:
         BranchHeadNode(int32_t len, Node *subNode)
     class BranchHeadNode : public ValueNode {
     public:
         BranchHeadNode(int32_t len, Node *subNode)

-                : ValueNode((0x666666*37+len)*37+hashCode(subNode)),
+                : ValueNode((0x666666u*37u+len)*37u+hashCode(subNode)),

                   length(len), next(subNode) {}
         virtual UBool operator==(const Node &other) const;
         virtual int32_t markRightEdgesFirst(int32_t edgeNumber);
                   length(len), next(subNode) {}
         virtual UBool operator==(const Node &other) const;
         virtual int32_t markRightEdgesFirst(int32_t edgeNumber);


@@ -363,7 +397,9 @@ protected:
         int32_t length;
         Node *next;  // A branch sub-node.
     };
         int32_t length;
         Node *next;  // A branch sub-node.
     };

+

 #endif  /* U_HIDE_INTERNAL_API */
 #endif  /* U_HIDE_INTERNAL_API */

+    /// \endcond

 
     /** @internal */
     virtual Node *createLinearMatchNode(int32_t i, int32_t unitIndex, int32_t length,
 
     /** @internal */
     virtual Node *createLinearMatchNode(int32_t i, int32_t unitIndex, int32_t length,


@@ -379,12 +415,9 @@ protected:
     virtual int32_t writeValueAndType(UBool hasValue, int32_t value, int32_t node) = 0;
     /** @internal */
     virtual int32_t writeDeltaTo(int32_t jumpTarget) = 0;
     virtual int32_t writeValueAndType(UBool hasValue, int32_t value, int32_t node) = 0;
     /** @internal */
     virtual int32_t writeDeltaTo(int32_t jumpTarget) = 0;

-
-private:
-    // No ICU "poor man's RTTI" for this class nor its subclasses.
-    virtual UClassID getDynamicClassID() const;

 };
 
 U_NAMESPACE_END
 };
 
 U_NAMESPACE_END

+#endif // U_SHOW_CPLUSPLUS_API

 
 #endif  // __STRINGTRIEBUILDER_H__
 
 #endif  // __STRINGTRIEBUILDER_H__