VTK  9.1.20211026
vtkUnicodeString.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkUnicodeString.h
5 
6 -------------------------------------------------------------------------
7  Copyright 2008 Sandia Corporation.
8  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9  the U.S. Government retains certain rights in this software.
10 -------------------------------------------------------------------------
11 
12  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
13  All rights reserved.
14  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
15 
16  This software is distributed WITHOUT ANY WARRANTY; without even
17  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
18  PURPOSE. See the above copyright notice for more information.
19 
20 =========================================================================*/
21 
47 #ifndef vtkUnicodeString_h
48 #define vtkUnicodeString_h
49 
50 #include "vtkCommonCoreModule.h" // For export macro
51 #include "vtkDeprecation.h"
52 #include "vtkSystemIncludes.h"
53 #include <string>
54 #include <vector>
55 
56 class vtkUnicodeString;
57 
58 typedef vtkTypeUInt32 vtkUnicodeStringValueType;
59 
60 //
61 // The following should be eventually placed in vtkSetGet.h
62 //
63 
64 // This is same as extra extended template macro with an
65 // additional case for VTK_UNICODE_STRING
66 #define vtkSuperExtraExtendedTemplateMacro(call) \
67  vtkExtraExtendedTemplateMacro(call); \
68  vtkTemplateMacroCase(VTK_UNICODE_STRING, vtkUnicodeString, call)
69 
70 class vtkUnicodeString;
71 
72 VTKCOMMONCORE_EXPORT bool operator==(const vtkUnicodeString& lhs, const vtkUnicodeString& rhs);
73 VTKCOMMONCORE_EXPORT bool operator!=(const vtkUnicodeString& lhs, const vtkUnicodeString& rhs);
74 VTKCOMMONCORE_EXPORT bool operator<(const vtkUnicodeString& lhs, const vtkUnicodeString& rhs);
75 VTKCOMMONCORE_EXPORT bool operator<=(const vtkUnicodeString& lhs, const vtkUnicodeString& rhs);
76 VTKCOMMONCORE_EXPORT bool operator>=(const vtkUnicodeString& lhs, const vtkUnicodeString& rhs);
77 VTKCOMMONCORE_EXPORT bool operator>(const vtkUnicodeString& lhs, const vtkUnicodeString& rhs);
78 
79 class VTKCOMMONCORE_EXPORT vtkUnicodeString
80 {
81 public:
83  typedef std::string::size_type size_type;
84 
85  class VTKCOMMONCORE_EXPORT const_iterator
86  {
87  public:
88  typedef std::bidirectional_iterator_tag iterator_category;
90  typedef std::string::difference_type difference_type;
91  typedef value_type* pointer;
93 
95 
97  bool operator==(const const_iterator&) const;
98  bool operator!=(const const_iterator&) const;
103 
104  private:
105  const_iterator(std::string::const_iterator);
106  friend class vtkUnicodeString;
107  std::string::const_iterator Position;
108  };
109 
113  VTK_DEPRECATED_IN_9_1_0("Use std::string instead.")
118  VTK_DEPRECATED_IN_9_1_0("Use std::string instead.")
124  VTK_DEPRECATED_IN_9_1_0("Use std::string instead.")
129  VTK_DEPRECATED_IN_9_1_0("Use std::string instead.")
131 
133 
136  VTK_DEPRECATED_IN_9_1_0("Use std::string instead.")
137  static bool is_utf8(const char*);
138  VTK_DEPRECATED_IN_9_1_0("Use std::string instead.")
139  static bool is_utf8(const std::string&);
141 
143 
146  VTK_DEPRECATED_IN_9_1_0("Use std::string instead.")
147  static vtkUnicodeString from_utf8(const char*);
148  // Constructs a string from a half-open sequence of UTF-8 encoded characters.
149  VTK_DEPRECATED_IN_9_1_0("Use std::string instead.")
150  static vtkUnicodeString from_utf8(const char* begin, const char* end);
151  // Constructs a string from a sequence of UTF-8 encoded characters.
152  VTK_DEPRECATED_IN_9_1_0("Use std::string instead.")
153  static vtkUnicodeString from_utf8(const std::string&);
155 
158  VTK_DEPRECATED_IN_9_1_0("Use std::string instead.")
159  static vtkUnicodeString from_utf16(const vtkTypeUInt16*);
160 
164  vtkUnicodeString& operator=(const vtkUnicodeString&);
165 
175 
185  value_type operator[](size_type offset) const;
186 
190  const char* utf8_str() const;
195  void utf8_str(std::string& result) const;
199  std::vector<vtkTypeUInt16> utf16_str() const;
204  void utf16_str(std::vector<vtkTypeUInt16>& result) const;
205 
217  bool empty() const;
218 
222  static const size_type npos;
223 
231  vtkUnicodeString& operator+=(const vtkUnicodeString& rhs);
232 
237 
239 
243  void append(size_type count, value_type character);
246 
248 
252  void assign(size_type count, value_type character);
255 
259  void clear();
260 
270 
278  int compare(const vtkUnicodeString&) const;
279 
285 
290 
291 private:
292  std::string Storage;
293  class back_insert_iterator;
294 };
295 
296 #endif
297 
298 // VTK-HeaderTest-Exclude: vtkUnicodeString.h
const_iterator operator++(int)
std::string::difference_type difference_type
std::bidirectional_iterator_tag iterator_category
const_iterator operator--(int)
bool operator==(const const_iterator &) const
bool operator!=(const const_iterator &) const
vtkUnicodeStringValueType value_type
String class that stores Unicode text.
void swap(vtkUnicodeString &)
Swap the sequences stored by two strings.
static vtkUnicodeString from_utf16(const vtkTypeUInt16 *)
Constructs a string from a null-terminated sequence of UTF-16 encoded characters.
vtkUnicodeStringValueType value_type
bool empty() const
Returns true if the string contains an empty sequence.
vtkUnicodeString substr(size_type offset=0, size_type count=npos) const
Returns a subset of the current sequence that up-to 'count' characters in length, starting at charact...
void push_back(value_type)
Append a Unicode character to the end of the sequence.
void append(const vtkUnicodeString &value)
Append Unicode to the current sequence.
std::string::size_type size_type
void assign(const vtkUnicodeString &value)
Replace the current sequence with another.
const_iterator end() const
Returns a forward iterator that points just beyond the end of the sequence.
value_type at(size_type offset) const
Returns the Unicode character at the given character offset within the sequence, or throws std::out_o...
static vtkUnicodeString from_utf8(const char *)
Constructs a string from a null-terminated sequence of UTF-8 encoded characters.
std::vector< vtkTypeUInt16 > utf16_str() const
Returns the sequence as a collection of UTF-16 encoded characters.
int compare(const vtkUnicodeString &) const
Returns a negative value if the sequence compares less-than the operand sequence, zero if the two seq...
size_type character_count() const
Returns the number of characters (not bytes) in the sequence.
const_iterator begin() const
Returns a forward iterator that points at the first element of the sequence (or just beyond the end o...
static bool is_utf8(const char *)
Tests a sequence of bytes, returning true iff they are a valid UTF-8 sequence.
static const size_type npos
The largest representable value of size_type, used as a special-code.
vtkUnicodeString fold_case() const
Returns a copy of the current sequence, modified so that differences in case are eliminated.
size_type byte_count() const
Returns the number of bytes (not characters) in the sequence.
void clear()
Resets the string to an empty sequence.
const char * utf8_str() const
Returns the sequence as a null-terminated sequence of UTF-8 encoded characters.
@ vector
Definition: vtkX3D.h:243
@ value
Definition: vtkX3D.h:226
@ offset
Definition: vtkX3D.h:444
#define VTK_DEPRECATED_IN_9_1_0(reason)
VTKCOMMONCORE_EXPORT bool operator!=(const vtkUnicodeString &lhs, const vtkUnicodeString &rhs)
vtkTypeUInt32 vtkUnicodeStringValueType
VTKCOMMONCORE_EXPORT bool operator==(const vtkUnicodeString &lhs, const vtkUnicodeString &rhs)
VTKCOMMONCORE_EXPORT bool operator>(const vtkUnicodeString &lhs, const vtkUnicodeString &rhs)
VTKCOMMONCORE_EXPORT bool operator<(const vtkUnicodeString &lhs, const vtkUnicodeString &rhs)
VTKCOMMONCORE_EXPORT bool operator>=(const vtkUnicodeString &lhs, const vtkUnicodeString &rhs)
VTKCOMMONCORE_EXPORT bool operator<=(const vtkUnicodeString &lhs, const vtkUnicodeString &rhs)