ICU 59.1  59.1
ucharstriebuilder.h
Go to the documentation of this file.
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 *******************************************************************************
5 * Copyright (C) 2010-2016, International Business Machines
6 * Corporation and others. All Rights Reserved.
7 *******************************************************************************
8 * file name: ucharstriebuilder.h
9 * encoding: UTF-8
10 * tab size: 8 (not used)
11 * indentation:4
12 *
13 * created on: 2010nov14
14 * created by: Markus W. Scherer
15 */
16 
17 #ifndef __UCHARSTRIEBUILDER_H__
18 #define __UCHARSTRIEBUILDER_H__
19 
20 #include "unicode/utypes.h"
22 #include "unicode/ucharstrie.h"
23 #include "unicode/unistr.h"
24 
31 
32 class UCharsTrieElement;
33 
41 public:
47  UCharsTrieBuilder(UErrorCode &errorCode);
48 
53  virtual ~UCharsTrieBuilder();
54 
69  UCharsTrieBuilder &add(const UnicodeString &s, int32_t value, UErrorCode &errorCode);
70 
89  UCharsTrie *build(UStringTrieBuildOption buildOption, UErrorCode &errorCode);
90 
115  UnicodeString &buildUnicodeString(UStringTrieBuildOption buildOption, UnicodeString &result,
116  UErrorCode &errorCode);
117 
125  strings.remove();
126  elementsLength=0;
127  ucharsLength=0;
128  return *this;
129  }
130 
131 private:
132  UCharsTrieBuilder(const UCharsTrieBuilder &other); // no copy constructor
133  UCharsTrieBuilder &operator=(const UCharsTrieBuilder &other); // no assignment operator
134 
135  void buildUChars(UStringTrieBuildOption buildOption, UErrorCode &errorCode);
136 
137  virtual int32_t getElementStringLength(int32_t i) const;
138  virtual char16_t getElementUnit(int32_t i, int32_t unitIndex) const;
139  virtual int32_t getElementValue(int32_t i) const;
140 
141  virtual int32_t getLimitOfLinearMatch(int32_t first, int32_t last, int32_t unitIndex) const;
142 
143  virtual int32_t countElementUnits(int32_t start, int32_t limit, int32_t unitIndex) const;
144  virtual int32_t skipElementsBySomeUnits(int32_t i, int32_t unitIndex, int32_t count) const;
145  virtual int32_t indexOfElementWithNextUnit(int32_t i, int32_t unitIndex, char16_t unit) const;
146 
147  virtual UBool matchNodesCanHaveValues() const { return TRUE; }
148 
149  virtual int32_t getMaxBranchLinearSubNodeLength() const { return UCharsTrie::kMaxBranchLinearSubNodeLength; }
150  virtual int32_t getMinLinearMatch() const { return UCharsTrie::kMinLinearMatch; }
151  virtual int32_t getMaxLinearMatchLength() const { return UCharsTrie::kMaxLinearMatchLength; }
152 
153  class UCTLinearMatchNode : public LinearMatchNode {
154  public:
155  UCTLinearMatchNode(const char16_t *units, int32_t len, Node *nextNode);
156  virtual UBool operator==(const Node &other) const;
157  virtual void write(StringTrieBuilder &builder);
158  private:
159  const char16_t *s;
160  };
161 
162  virtual Node *createLinearMatchNode(int32_t i, int32_t unitIndex, int32_t length,
163  Node *nextNode) const;
164 
165  UBool ensureCapacity(int32_t length);
166  virtual int32_t write(int32_t unit);
167  int32_t write(const char16_t *s, int32_t length);
168  virtual int32_t writeElementUnits(int32_t i, int32_t unitIndex, int32_t length);
169  virtual int32_t writeValueAndFinal(int32_t i, UBool isFinal);
170  virtual int32_t writeValueAndType(UBool hasValue, int32_t value, int32_t node);
171  virtual int32_t writeDeltaTo(int32_t jumpTarget);
172 
173  UnicodeString strings;
174  UCharsTrieElement *elements;
175  int32_t elementsCapacity;
176  int32_t elementsLength;
177 
178  // char16_t serialization of the trie.
179  // Grows from the back: ucharsLength measures from the end of the buffer!
180  char16_t *uchars;
181  int32_t ucharsCapacity;
182  int32_t ucharsLength;
183 };
184 
186 
187 #endif // __UCHARSTRIEBUILDER_H__
C++ API: Builder API for trie builders.
virtual int32_t getMinLinearMatch() const =0
Base class for string trie builder classes.
virtual int32_t getMaxLinearMatchLength() const =0
UCharsTrieBuilder & clear()
Removes all (string, value) pairs.
C++ API: Unicode String.
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
virtual int32_t skipElementsBySomeUnits(int32_t i, int32_t unitIndex, int32_t count) const =0
virtual int32_t getMaxBranchLinearSubNodeLength() const =0
virtual int32_t getElementStringLength(int32_t i) const =0
virtual char16_t getElementUnit(int32_t i, int32_t unitIndex) const =0
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:131
virtual int32_t getElementValue(int32_t i) const =0
Builder class for UCharsTrie.
virtual int32_t indexOfElementWithNextUnit(int32_t i, int32_t unitIndex, char16_t unit) const =0
#define TRUE
The TRUE value of a UBool.
Definition: umachine.h:240
virtual int32_t getLimitOfLinearMatch(int32_t first, int32_t last, int32_t unitIndex) const =0
UStringTrieBuildOption
Build options for BytesTrieBuilder and CharsTrieBuilder.
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:132
void build(UStringTrieBuildOption buildOption, int32_t elementsLength, UErrorCode &errorCode)
virtual int32_t countElementUnits(int32_t start, int32_t limit, int32_t unitIndex) const =0
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:396
C++ API: Trie for mapping Unicode strings (or 16-bit-unit sequences) to integer values.
Basic definitions for ICU, for both C and C++ APIs.
#define U_COMMON_API
Set to export library symbols from inside the common library, and to import them from outside...
Definition: utypes.h:359
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:296
Light-weight, non-const reader class for a UCharsTrie.
Definition: ucharstrie.h:50
virtual UBool matchNodesCanHaveValues() const =0
int8_t UBool
The ICU boolean type.
Definition: umachine.h:236