blob: ff291f87e46a8870f905fc5070bccadb1f1d82cf [file] [log] [blame] [edit]
// Copyright 2017 The PDFium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
#ifndef CORE_FXCRT_WIDESTRING_H_
#define CORE_FXCRT_WIDESTRING_H_
#include <stdarg.h>
#include <stddef.h>
#include <stdint.h>
#include <wchar.h>
#include <functional>
#include <iosfwd>
#include <iterator>
#include <utility>
#include "core/fxcrt/retain_ptr.h"
#include "core/fxcrt/string_data_template.h"
#include "core/fxcrt/string_view_template.h"
#include "third_party/abseil-cpp/absl/types/optional.h"
#include "third_party/base/check.h"
#include "third_party/base/span.h"
namespace fxcrt {
class ByteString;
// A mutable string with shared buffers using copy-on-write semantics that
// avoids the cost of std::string's iterator stability guarantees.
class WideString {
public:
// TODO(crbug.com/pdfium/2031): Consider switching to `char16_t` instead.
using CharType = wchar_t;
using const_iterator = const CharType*;
using const_reverse_iterator = std::reverse_iterator<const_iterator>;
[[nodiscard]] static WideString FormatInteger(int i);
[[nodiscard]] static WideString Format(const wchar_t* pFormat, ...);
[[nodiscard]] static WideString FormatV(const wchar_t* lpszFormat,
va_list argList);
WideString();
WideString(const WideString& other);
// Move-construct a WideString. After construction, |other| is empty.
WideString(WideString&& other) noexcept;
// Make a one-character string from one wide char.
explicit WideString(wchar_t ch);
// Deliberately implicit to avoid calling on every string literal.
// NOLINTNEXTLINE(runtime/explicit)
WideString(const wchar_t* ptr);
// No implicit conversions from byte strings.
// NOLINTNEXTLINE(runtime/explicit)
WideString(char) = delete;
WideString(const wchar_t* pStr, size_t len);
explicit WideString(WideStringView str);
WideString(WideStringView str1, WideStringView str2);
WideString(const std::initializer_list<WideStringView>& list);
~WideString();
[[nodiscard]] static WideString FromASCII(ByteStringView str);
[[nodiscard]] static WideString FromLatin1(ByteStringView str);
[[nodiscard]] static WideString FromDefANSI(ByteStringView str);
[[nodiscard]] static WideString FromUTF8(ByteStringView str);
[[nodiscard]] static WideString FromUTF16LE(const unsigned short* str,
size_t len);
[[nodiscard]] static WideString FromUTF16BE(const unsigned short* wstr,
size_t wlen);
[[nodiscard]] static size_t WStringLength(const unsigned short* str);
// Explicit conversion to C-style wide string.
// Note: Any subsequent modification of |this| will invalidate the result.
const wchar_t* c_str() const { return m_pData ? m_pData->m_String : L""; }
// Explicit conversion to WideStringView.
// Note: Any subsequent modification of |this| will invalidate the result.
WideStringView AsStringView() const {
return WideStringView(c_str(), GetLength());
}
// Explicit conversion to span.
// Note: Any subsequent modification of |this| will invalidate the result.
pdfium::span<const wchar_t> span() const {
return pdfium::make_span(m_pData ? m_pData->m_String : nullptr,
GetLength());
}
// Note: Any subsequent modification of |this| will invalidate iterators.
const_iterator begin() const { return m_pData ? m_pData->m_String : nullptr; }
const_iterator end() const {
return m_pData ? m_pData->m_String + m_pData->m_nDataLength : nullptr;
}
// Note: Any subsequent modification of |this| will invalidate iterators.
const_reverse_iterator rbegin() const {
return const_reverse_iterator(end());
}
const_reverse_iterator rend() const {
return const_reverse_iterator(begin());
}
// Holds on to buffer if possible for later re-use. Assign WideString()
// to force immediate release if desired.
void clear();
size_t GetLength() const { return m_pData ? m_pData->m_nDataLength : 0; }
size_t GetStringLength() const {
return m_pData ? wcslen(m_pData->m_String) : 0;
}
bool IsEmpty() const { return !GetLength(); }
bool IsValidIndex(size_t index) const { return index < GetLength(); }
bool IsValidLength(size_t length) const { return length <= GetLength(); }
WideString& operator=(const wchar_t* str);
WideString& operator=(WideStringView str);
WideString& operator=(const WideString& that);
// Move-assign a WideString. After assignment, |that| is empty.
WideString& operator=(WideString&& that) noexcept;
WideString& operator+=(const wchar_t* str);
WideString& operator+=(wchar_t ch);
WideString& operator+=(const WideString& str);
WideString& operator+=(WideStringView str);
bool operator==(const wchar_t* ptr) const;
bool operator==(WideStringView str) const;
bool operator==(const WideString& other) const;
bool operator!=(const wchar_t* ptr) const { return !(*this == ptr); }
bool operator!=(WideStringView str) const { return !(*this == str); }
bool operator!=(const WideString& other) const { return !(*this == other); }
bool operator<(const wchar_t* ptr) const;
bool operator<(WideStringView str) const;
bool operator<(const WideString& other) const;
CharType operator[](const size_t index) const {
CHECK(IsValidIndex(index));
return m_pData->m_String[index];
}
CharType Front() const { return GetLength() ? (*this)[0] : 0; }
CharType Back() const { return GetLength() ? (*this)[GetLength() - 1] : 0; }
void SetAt(size_t index, wchar_t c);
int Compare(const wchar_t* str) const;
int Compare(const WideString& str) const;
int CompareNoCase(const wchar_t* str) const;
WideString Substr(size_t offset) const;
WideString Substr(size_t first, size_t count) const;
WideString First(size_t count) const;
WideString Last(size_t count) const;
size_t Insert(size_t index, wchar_t ch);
size_t InsertAtFront(wchar_t ch) { return Insert(0, ch); }
size_t InsertAtBack(wchar_t ch) { return Insert(GetLength(), ch); }
size_t Delete(size_t index, size_t count = 1);
void MakeLower();
void MakeUpper();
void Trim();
void Trim(wchar_t target);
void Trim(WideStringView targets);
void TrimLeft();
void TrimLeft(wchar_t target);
void TrimLeft(WideStringView targets);
void TrimRight();
void TrimRight(wchar_t target);
void TrimRight(WideStringView targets);
void Reserve(size_t len);
// Note: any modification of the string (including ReleaseBuffer()) may
// invalidate the span, which must not outlive its buffer.
pdfium::span<wchar_t> GetBuffer(size_t nMinBufLength);
void ReleaseBuffer(size_t nNewLength);
int GetInteger() const;
absl::optional<size_t> Find(WideStringView subStr, size_t start = 0) const;
absl::optional<size_t> Find(wchar_t ch, size_t start = 0) const;
absl::optional<size_t> ReverseFind(wchar_t ch) const;
bool Contains(WideStringView lpszSub, size_t start = 0) const {
return Find(lpszSub, start).has_value();
}
bool Contains(char ch, size_t start = 0) const {
return Find(ch, start).has_value();
}
size_t Replace(WideStringView pOld, WideStringView pNew);
size_t Remove(wchar_t ch);
bool IsASCII() const { return AsStringView().IsASCII(); }
bool EqualsASCII(ByteStringView that) const {
return AsStringView().EqualsASCII(that);
}
bool EqualsASCIINoCase(ByteStringView that) const {
return AsStringView().EqualsASCIINoCase(that);
}
ByteString ToASCII() const;
ByteString ToLatin1() const;
ByteString ToDefANSI() const;
ByteString ToUTF8() const;
// This method will add \0\0 to the end of the string to represent the
// wide string terminator. These values are in the string, not just the data,
// so GetLength() will include them.
ByteString ToUTF16LE() const;
// Replace the characters &<>'" with HTML entities.
WideString EncodeEntities() const;
protected:
using StringData = StringDataTemplate<wchar_t>;
void ReallocBeforeWrite(size_t nNewLength);
void AllocBeforeWrite(size_t nNewLength);
void AllocCopy(WideString& dest, size_t nCopyLen, size_t nCopyIndex) const;
void AssignCopy(const wchar_t* pSrcData, size_t nSrcLen);
void Concat(const wchar_t* pSrcData, size_t nSrcLen);
intptr_t ReferenceCountForTesting() const;
RetainPtr<StringData> m_pData;
friend class WideString_Assign_Test;
friend class WideString_ConcatInPlace_Test;
friend class WideString_Construct_Test;
friend class StringPool_WideString_Test;
};
inline WideString operator+(WideStringView str1, WideStringView str2) {
return WideString(str1, str2);
}
inline WideString operator+(WideStringView str1, const wchar_t* str2) {
return WideString(str1, str2);
}
inline WideString operator+(const wchar_t* str1, WideStringView str2) {
return WideString(str1, str2);
}
inline WideString operator+(WideStringView str1, wchar_t ch) {
return WideString(str1, WideStringView(ch));
}
inline WideString operator+(wchar_t ch, WideStringView str2) {
return WideString(WideStringView(ch), str2);
}
inline WideString operator+(const WideString& str1, const WideString& str2) {
return WideString(str1.AsStringView(), str2.AsStringView());
}
inline WideString operator+(const WideString& str1, wchar_t ch) {
return WideString(str1.AsStringView(), WideStringView(ch));
}
inline WideString operator+(wchar_t ch, const WideString& str2) {
return WideString(WideStringView(ch), str2.AsStringView());
}
inline WideString operator+(const WideString& str1, const wchar_t* str2) {
return WideString(str1.AsStringView(), str2);
}
inline WideString operator+(const wchar_t* str1, const WideString& str2) {
return WideString(str1, str2.AsStringView());
}
inline WideString operator+(const WideString& str1, WideStringView str2) {
return WideString(str1.AsStringView(), str2);
}
inline WideString operator+(WideStringView str1, const WideString& str2) {
return WideString(str1, str2.AsStringView());
}
inline bool operator==(const wchar_t* lhs, const WideString& rhs) {
return rhs == lhs;
}
inline bool operator==(WideStringView lhs, const WideString& rhs) {
return rhs == lhs;
}
inline bool operator!=(const wchar_t* lhs, const WideString& rhs) {
return rhs != lhs;
}
inline bool operator!=(WideStringView lhs, const WideString& rhs) {
return rhs != lhs;
}
inline bool operator<(const wchar_t* lhs, const WideString& rhs) {
return rhs.Compare(lhs) > 0;
}
std::wostream& operator<<(std::wostream& os, const WideString& str);
std::ostream& operator<<(std::ostream& os, const WideString& str);
std::wostream& operator<<(std::wostream& os, WideStringView str);
std::ostream& operator<<(std::ostream& os, WideStringView str);
// This is declared here for use in gtest-based tests but is defined in a test
// support target. This should not be used in production code. Just use
// operator<< from above instead.
// In some cases, gtest will automatically use operator<< as well, but in this
// case, it needs PrintTo() because WideString looks like a container to gtest.
void PrintTo(const WideString& str, std::ostream* os);
} // namespace fxcrt
using WideString = fxcrt::WideString;
uint32_t FX_HashCode_GetW(WideStringView str);
uint32_t FX_HashCode_GetLoweredW(WideStringView str);
namespace std {
template <>
struct hash<WideString> {
size_t operator()(const WideString& str) const {
return FX_HashCode_GetW(str.AsStringView());
}
};
} // namespace std
extern template struct std::hash<WideString>;
#endif // CORE_FXCRT_WIDESTRING_H_