ICU 74.2: common/unicode/stringpiece.h Source File

ICU 74.2 74.2

stringpiece.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// Copyright (C) 2009-2013, International Business Machines
4// Corporation and others. All Rights Reserved.
5//
6// Copyright 2001 and onwards Google Inc.
7// Author: Sanjay Ghemawat
8
9// This code is a contribution of Google code, and the style used here is
10// a compromise between the original Google code and the ICU coding guidelines.
11// For example, data types are ICU-ified (size_t,int->int32_t),
12// and API comments doxygen-ified, but function names and behavior are
13// as in the original, if possible.
14// Assertion-style error handling, not available in ICU, was changed to
15// parameter "pinning" similar to UnicodeString.
16//
17// In addition, this is only a partial port of the original Google code,
18// limited to what was needed so far. The (nearly) complete original code
19// is in the ICU svn repository at icuhtml/trunk/design/strings/contrib
20// (see ICU ticket 6765, r25517).
21
22#ifndef __STRINGPIECE_H__
23#define __STRINGPIECE_H__
24
30#include "unicode/utypes.h"
31
32#if U_SHOW_CPLUSPLUS_API
33
34#include <cstddef>
35#include <type_traits>
36
37#include "unicode/uobject.h"
38#include "unicode/std_string.h"
39
40// Arghh! I wish C++ literals were "string".
41
42U_NAMESPACE_BEGIN
43
60 class U_COMMON_API StringPiece : public UMemory {
61 private:
62 const char* ptr_;
63 int32_t length_;
64
65 public:
70 StringPiece() : ptr_(nullptr), length_(0) { }
71
77 StringPiece(const char* str);
78#if defined(__cpp_char8_t) || defined(U_IN_DOXYGEN)
84 StringPiece(const char8_t* str) : StringPiece(reinterpret_cast<const char*>(str)) {}
85#endif
92 StringPiece(std::nullptr_t p) : ptr_(p), length_(0) {}
93
98 StringPiece(const std::string& str)
99 : ptr_(str.data()), length_(static_cast<int32_t>(str.size())) { }
100#if defined(__cpp_lib_char8_t) || defined(U_IN_DOXYGEN)
105 StringPiece(const std::u8string& str)
106 : ptr_(reinterpret_cast<const char*>(str.data())),
107 length_(static_cast<int32_t>(str.size())) { }
108#endif
109
132 template <typename T,
133 typename = typename std::enable_if<
134 (std::is_same<decltype(T().data()), const char*>::value
135#if defined(__cpp_char8_t)
136 || std::is_same<decltype(T().data()), const char8_t*>::value
137#endif
138 ) &&
139 std::is_same<decltype(T().size()), size_t>::value>::type>
140 StringPiece(T str)
141 : ptr_(reinterpret_cast<const char*>(str.data())),
142 length_(static_cast<int32_t>(str.size())) {}
143
150 StringPiece(const char* offset, int32_t len) : ptr_(offset), length_(len) { }
151#if defined(__cpp_char8_t) || defined(U_IN_DOXYGEN)
158 StringPiece(const char8_t* str, int32_t len) :
159 StringPiece(reinterpret_cast<const char*>(str), len) {}
160#endif
161
168 StringPiece(const StringPiece& x, int32_t pos);
177 StringPiece(const StringPiece& x, int32_t pos, int32_t len);
178
189 const char* data() const { return ptr_; }
195 int32_t size() const { return length_; }
201 int32_t length() const { return length_; }
207 UBool empty() const { return length_ == 0; }
208
213 void clear() { ptr_ = nullptr; length_ = 0; }
214
221 void set(const char* xdata, int32_t len) { ptr_ = xdata; length_ = len; }
222
228 void set(const char* str);
229
230#if defined(__cpp_char8_t) || defined(U_IN_DOXYGEN)
237 inline void set(const char8_t* xdata, int32_t len) {
238 set(reinterpret_cast<const char*>(xdata), len);
239 }
240
246 inline void set(const char8_t* str) {
247 set(reinterpret_cast<const char*>(str));
248 }
249#endif
250
256 void remove_prefix(int32_t n) {
257 if (n >= 0) {
258 if (n > length_) {
259 n = length_;
260 }
261 ptr_ += n;
262 length_ -= n;
263 }
264 }
265
271 void remove_suffix(int32_t n) {
272 if (n >= 0) {
273 if (n <= length_) {
274 length_ -= n;
275 } else {
276 length_ = 0;
277 }
278 }
279 }
280
288 int32_t find(StringPiece needle, int32_t offset);
289
297 int32_t compare(StringPiece other);
298
303 static const int32_t npos; // = 0x7fffffff;
304
313 StringPiece substr(int32_t pos, int32_t len = npos) const {
314 return StringPiece(*this, pos, len);
315 }
316};
317
325 U_EXPORT UBool U_EXPORT2
326operator==(const StringPiece& x, const StringPiece& y);
327
335 inline bool operator!=(const StringPiece& x, const StringPiece& y) {
336 return !(x == y);
337}
338
339U_NAMESPACE_END
340
341#endif /* U_SHOW_CPLUSPLUS_API */
342
343#endif // __STRINGPIECE_H__
icu::StringPiece
A string-like object that points to a sized piece of memory.
Definition stringpiece.h:60
icu::StringPiece::substr
StringPiece substr(int32_t pos, int32_t len=npos) const
Returns a substring of this StringPiece.
Definition stringpiece.h:313
icu::StringPiece::empty
UBool empty() const
Returns whether the string is empty.
Definition stringpiece.h:207
icu::StringPiece::StringPiece
StringPiece(const char *str)
Constructs from a NUL-terminated const char * pointer.
icu::StringPiece::set
void set(const char *str)
Reset the stringpiece to refer to new data.
icu::StringPiece::StringPiece
StringPiece(const StringPiece &x, int32_t pos, int32_t len)
Substring of another StringPiece.
icu::StringPiece::StringPiece
StringPiece(T str)
Constructs from some other implementation of a string piece class, from any C++ record type that has ...
Definition stringpiece.h:140
icu::StringPiece::StringPiece
StringPiece(const char8_t *str)
Constructs from a NUL-terminated const char8_t * pointer.
Definition stringpiece.h:84
icu::StringPiece::StringPiece
StringPiece(const std::u8string &str)
Constructs from a std::u8string.
Definition stringpiece.h:105
icu::StringPiece::find
int32_t find(StringPiece needle, int32_t offset)
Searches the StringPiece for the given search string (needle);.
icu::StringPiece::npos
static const int32_t npos
Maximum integer, used as a default value for substring methods.
Definition stringpiece.h:303
icu::StringPiece::clear
void clear()
Sets to an empty string.
Definition stringpiece.h:213
icu::StringPiece::set
void set(const char8_t *xdata, int32_t len)
Resets the stringpiece to refer to new data.
Definition stringpiece.h:237
icu::StringPiece::data
const char * data() const
Returns the string pointer.
Definition stringpiece.h:189
icu::StringPiece::StringPiece
StringPiece()
Default constructor, creates an empty StringPiece.
Definition stringpiece.h:70
icu::StringPiece::StringPiece
StringPiece(std::nullptr_t p)
Constructs an empty StringPiece.
Definition stringpiece.h:92
icu::StringPiece::set
void set(const char8_t *str)
Resets the stringpiece to refer to new data.
Definition stringpiece.h:246
icu::StringPiece::set
void set(const char *xdata, int32_t len)
Reset the stringpiece to refer to new data.
Definition stringpiece.h:221
icu::StringPiece::size
int32_t size() const
Returns the string length.
Definition stringpiece.h:195
icu::StringPiece::remove_prefix
void remove_prefix(int32_t n)
Removes the first n string units.
Definition stringpiece.h:256
icu::StringPiece::compare
int32_t compare(StringPiece other)
Compares this StringPiece with the other StringPiece, with semantics similar to std::string::compare(...
icu::StringPiece::remove_suffix
void remove_suffix(int32_t n)
Removes the last n string units.
Definition stringpiece.h:271
icu::StringPiece::StringPiece
StringPiece(const char8_t *str, int32_t len)
Constructs from a const char8_t * pointer and a specified length.
Definition stringpiece.h:158
icu::StringPiece::length
int32_t length() const
Returns the string length.
Definition stringpiece.h:201
icu::StringPiece::StringPiece
StringPiece(const StringPiece &x, int32_t pos)
Substring of another StringPiece.
icu::StringPiece::StringPiece
StringPiece(const std::string &str)
Constructs from a std::string.
Definition stringpiece.h:98
icu::StringPiece::StringPiece
StringPiece(const char *offset, int32_t len)
Constructs from a const char * pointer and a specified length.
Definition stringpiece.h:150
icu::UMemory
UMemory is the common ICU base class.
Definition uobject.h:115
icu::operator==
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
icu::operator!=
bool operator!=(const StringPiece &x, const StringPiece &y)
Global operator != for StringPiece.
Definition stringpiece.h:335
U_EXPORT
#define U_EXPORT
Definition platform.h:809
std_string.h
C++ API: Central ICU header for including the C++ standard <string> header and for related definition...
UBool
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition umachine.h:247
uobject.h
C++ API: Common ICU base class UObject.
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
U_COMMON_API
#define U_COMMON_API
Set to export library symbols from inside the common library, and to import them from outside.
Definition utypes.h:300