summaryrefslogtreecommitdiff
path: root/src/components/include/utils/custom_string.h
blob: 7b21e7a64dd30c135d6fe0a79c508f05d8b16ca6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
/*
 * Copyright (c) 2015, Ford Motor Company
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided with the
 * distribution.
 *
 * Neither the name of the Ford Motor Company nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef SRC_COMPONENTS_INCLUDE_UTILS_CUSTOM_STRING_H_
#define SRC_COMPONENTS_INCLUDE_UTILS_CUSTOM_STRING_H_

#include <string>

namespace utils {
namespace custom_string {
/* UTF8 formats:
 * UTF8 1 byte consists from one-byte sequence
 * bit representation of one character: 0xxxxxxx
 * UTF8 2 bytes consists from two-byte sequence
 * bit representation of one character: 110xxxxx 10xxxxxx
 * UTF8 3 bytes consists from three-byte sequence
 * bit representation of one character: 1110xxxx 10xxxxxx 10xxxxxx
 * UTF8 4 bytes consists from four-byte sequence
 * bit representation of one character: 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
 */
enum UTFFormat {
  kByteOfUTF8 = 0x80,             // 10xxxxxx
  kHigestByteOfUTF8Byte2 = 0xc0,  // 110xxxxx
  kHigestByteOfUTF8Byte3 = 0xe0,  // 1110xxxx
  kHigestByteOfUTF8Byte4 = 0xf0   // 11110xxx
};

class CustomString {
 public:
  /**
   * @brief Constructs empty object.
   */
  CustomString();

  /**
   * @brief Constructs object with copy of str.
   * @param Contains string for new object.
   */
  explicit CustomString(const std::string& str);

  /**
   * @brief Constructs object with copy of str.
   * @param Contains pointer to string for new object.
   */
  explicit CustomString(const char* str);

  /**
   * @brief Constructs object with n consecutive copies of character c.
   * @param Contains amount of copies of character for new object.
   * @param Contains character for new object.
   */
  CustomString(size_t n, char c);

  /**
  * @brief Returns the length of the string, in terms of characters.
  */
  size_t size() const;

  /**
   * @brief Returns the length of the string, in terms of characters.
   */
  size_t length() const;

  /**
   * @brief Returns the length of the string, in terms of bytes.
   */
  size_t length_bytes() const;

  /**
   * @brief Returns TRUE if CustomString contains ASCII string
   * otherwise returns FALSE.
   */
  bool is_ascii_string() const;

  /**
   * @brief Returns TRUE if CustomString contains empty string
   * otherwise returns FALSE.
   */
  bool empty() const;

  /**
   * @brief Compares the value of the string (case sensitive).
   * @param Contains string for comparing
   * @return Returns TRUE if strings is equal otherwise returns FALSE.
   */
  bool operator==(const CustomString& str) const;

  /**
   * @brief Compares the value of the string (case sensitive).
   * @param Contains string for comparing
   * @return Returns TRUE if strings is equal otherwise returns FALSE.
   */
  bool operator==(const std::string& str) const;

  /**
   * @brief Assigns a new value to the string
   * @param Contains string for assignment
   * @return Returns result of assignment
   */
  CustomString& operator=(const char* str);

  /**
   * @brief Concatenates string from CustomString with string from argument.
   * @param Contains string for concatenation.
   * @return Returns result of concatenation.
   */
  CustomString operator+(const CustomString& str) const;

  /**
   * @brief Concatenates string from CustomString with string from argument.
   * @param Contains string for concatenation.
   * @return Returns result of concatenation.
   */
  CustomString operator+(const std::string& str) const;

  /**
   * @brief Returns the character at position pos in the string.
   * Need to use with ASCII string.
   * @param pos value with the position of a character within the string.
   */
  char at(size_t pos) const;

  /**
   * @brief Compares the value of the string (case sensitive).
   * @param Contains string for comparing
   * @return Returns 0 if strings is equal otherwise
   * returns "<0" or ">0".
   */
  int compare(const char* str) const;

  /**
   * @brief Compares the value of the string (case sensitive).
   * @param Contains string for comparing
   * @return Returns 0 if strings is equal otherwise
   * returns "<0" or ">0".
   */
  int compare(const std::string& str) const;

  /**
   * @brief Compares the value of the string (case insensitive).
   * @param Contains string for comparing
   * @return Returns TRUE if strings is equal otherwise returns FALSE.
   */
  bool CompareIgnoreCase(const CustomString& str) const;

  /**
   * @brief Compares the value of the string (case insensitive).
   * @param Contains string for comparing
   * @return Returns TRUE if strings is equal otherwise returns FALSE.
   */
  bool CompareIgnoreCase(const char* str) const;

  /**
   * @brief Returns a pointer to string from CustomString.
   */
  const char* c_str() const;

  /**
   * @brief Converts string to unicode string.
   * @return Returns unicode string.
   */
  std::wstring ToWString() const;

  /**
   * @brief Returns copy of string as multibyte string.
   */
  std::string AsMBString() const;

  /**
   * @brief Converts string to lower case unicode string.
   * @return Returns unicode string.
   */
  std::wstring ToWStringLowerCase() const;

 private:
  /**
   * @brief Initiates members of CustomString
   */
  void InitData();

  std::string mb_string_;
  size_t amount_characters_;
  bool is_ascii_string_;
};

}  // namespace custom_string
}  // namespace utils

#endif  // SRC_COMPONENTS_INCLUDE_UTILS_CUSTOM_STRING_H_