// Copyright 2017 PDFium Authors. All rights reserved. // 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_BYTESTRING_H_ #define CORE_FXCRT_BYTESTRING_H_ #include <functional> #include <iterator> #include <sstream> #include <utility> #include "core/fxcrt/fx_system.h" #include "core/fxcrt/retain_ptr.h" #include "core/fxcrt/string_data_template.h" #include "core/fxcrt/string_view_template.h" #include "third_party/base/optional.h" namespace fxcrt { class ByteString_Concat_Test; class StringPool_ByteString_Test; class WideString; // A mutable string with shared buffers using copy-on-write semantics that // avoids the cost of std::string's iterator stability guarantees. class ByteString { public: using CharType = char; using const_iterator = const CharType*; using const_reverse_iterator = std::reverse_iterator<const_iterator>; static ByteString FormatInteger(int i) WARN_UNUSED_RESULT; static ByteString FormatFloat(float f) WARN_UNUSED_RESULT; static ByteString Format(const char* lpszFormat, ...) WARN_UNUSED_RESULT; static ByteString FormatV(const char* lpszFormat, va_list argList) WARN_UNUSED_RESULT; ByteString(); ByteString(const ByteString& other); ByteString(ByteString&& other) noexcept; // Deliberately implicit to avoid calling on every string literal. // NOLINTNEXTLINE(runtime/explicit) ByteString(char ch); // NOLINTNEXTLINE(runtime/explicit) ByteString(const char* ptr); // No implicit conversions from wide strings. // NOLINTNEXTLINE(runtime/explicit) ByteString(wchar_t) = delete; ByteString(const char* ptr, size_t len); ByteString(const uint8_t* ptr, size_t len); explicit ByteString(const ByteStringView& bstrc); ByteString(const ByteStringView& bstrc1, const ByteStringView& bstrc2); ByteString(const std::initializer_list<ByteStringView>& list); explicit ByteString(const std::ostringstream& outStream); ~ByteString(); void clear() { m_pData.Reset(); } static ByteString FromUnicode(const WideString& str) WARN_UNUSED_RESULT; // Explicit conversion to C-style string. // Note: Any subsequent modification of |this| will invalidate the result. const char* c_str() const { return m_pData ? m_pData->m_String : ""; } // Explicit conversion to uint8_t*. // Note: Any subsequent modification of |this| will invalidate the result. const uint8_t* raw_str() const { return m_pData ? reinterpret_cast<const uint8_t*>(m_pData->m_String) : nullptr; } // Explicit conversion to ByteStringView. // Note: Any subsequent modification of |this| will invalidate the result. ByteStringView AsStringView() const { return ByteStringView(raw_str(), 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()); } size_t GetLength() const { return m_pData ? m_pData->m_nDataLength : 0; } size_t GetStringLength() const { return m_pData ? strlen(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(); } int Compare(const ByteStringView& str) const; bool EqualNoCase(const ByteStringView& str) const; bool operator==(const char* ptr) const; bool operator==(const ByteStringView& str) const; bool operator==(const ByteString& other) const; bool operator!=(const char* ptr) const { return !(*this == ptr); } bool operator!=(const ByteStringView& str) const { return !(*this == str); } bool operator!=(const ByteString& other) const { return !(*this == other); } bool operator<(const char* ptr) const; bool operator<(const ByteStringView& str) const; bool operator<(const ByteString& other) const; const ByteString& operator=(const char* str); const ByteString& operator=(const ByteStringView& bstrc); const ByteString& operator=(const ByteString& stringSrc); const ByteString& operator+=(char ch); const ByteString& operator+=(const char* str); const ByteString& operator+=(const ByteString& str); const ByteString& operator+=(const ByteStringView& bstrc); CharType operator[](const size_t index) const { ASSERT(IsValidIndex(index)); return m_pData ? m_pData->m_String[index] : 0; } CharType First() const { return GetLength() ? (*this)[0] : 0; } CharType Last() const { return GetLength() ? (*this)[GetLength() - 1] : 0; } void SetAt(size_t index, char c); size_t Insert(size_t index, char ch); size_t InsertAtFront(char ch) { return Insert(0, ch); } size_t InsertAtBack(char ch) { return Insert(GetLength(), ch); } size_t Delete(size_t index, size_t count = 1); void Reserve(size_t len); char* GetBuffer(size_t len); void ReleaseBuffer(size_t len); ByteString Mid(size_t first, size_t count) const; ByteString Left(size_t count) const; ByteString Right(size_t count) const; pdfium::Optional<size_t> Find(const ByteStringView& lpszSub, size_t start = 0) const; pdfium::Optional<size_t> Find(char ch, size_t start = 0) const; pdfium::Optional<size_t> ReverseFind(char ch) const; bool Contains(const ByteStringView& 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(); } void MakeLower(); void MakeUpper(); void Trim(); void Trim(char target); void Trim(const ByteStringView& targets); void TrimLeft(); void TrimLeft(char target); void TrimLeft(const ByteStringView& targets); void TrimRight(); void TrimRight(char target); void TrimRight(const ByteStringView& targets); size_t Replace(const ByteStringView& lpszOld, const ByteStringView& lpszNew); size_t Remove(char ch); WideString UTF8Decode() const; uint32_t GetID() const { return AsStringView().GetID(); } protected: using StringData = StringDataTemplate<char>; void ReallocBeforeWrite(size_t nNewLen); void AllocBeforeWrite(size_t nNewLen); void AllocCopy(ByteString& dest, size_t nCopyLen, size_t nCopyIndex) const; void AssignCopy(const char* pSrcData, size_t nSrcLen); void Concat(const char* lpszSrcData, size_t nSrcLen); RetainPtr<StringData> m_pData; friend ByteString_Concat_Test; friend class StringPool_ByteString_Test; }; inline bool operator==(const char* lhs, const ByteString& rhs) { return rhs == lhs; } inline bool operator==(const ByteStringView& lhs, const ByteString& rhs) { return rhs == lhs; } inline bool operator!=(const char* lhs, const ByteString& rhs) { return rhs != lhs; } inline bool operator!=(const ByteStringView& lhs, const ByteString& rhs) { return rhs != lhs; } inline bool operator<(const char* lhs, const ByteString& rhs) { return rhs.Compare(lhs) > 0; } inline ByteString operator+(const ByteStringView& str1, const ByteStringView& str2) { return ByteString(str1, str2); } inline ByteString operator+(const ByteStringView& str1, const char* str2) { return ByteString(str1, str2); } inline ByteString operator+(const char* str1, const ByteStringView& str2) { return ByteString(str1, str2); } inline ByteString operator+(const ByteStringView& str1, char ch) { return ByteString(str1, ByteStringView(ch)); } inline ByteString operator+(char ch, const ByteStringView& str2) { return ByteString(ch, str2); } inline ByteString operator+(const ByteString& str1, const ByteString& str2) { return ByteString(str1.AsStringView(), str2.AsStringView()); } inline ByteString operator+(const ByteString& str1, char ch) { return ByteString(str1.AsStringView(), ByteStringView(ch)); } inline ByteString operator+(char ch, const ByteString& str2) { return ByteString(ch, str2.AsStringView()); } inline ByteString operator+(const ByteString& str1, const char* str2) { return ByteString(str1.AsStringView(), str2); } inline ByteString operator+(const char* str1, const ByteString& str2) { return ByteString(str1, str2.AsStringView()); } inline ByteString operator+(const ByteString& str1, const ByteStringView& str2) { return ByteString(str1.AsStringView(), str2); } inline ByteString operator+(const ByteStringView& str1, const ByteString& str2) { return ByteString(str1, str2.AsStringView()); } std::ostream& operator<<(std::ostream& os, const ByteString& str); std::ostream& operator<<(std::ostream& os, const ByteStringView& str); } // namespace fxcrt using ByteString = fxcrt::ByteString; uint32_t FX_HashCode_GetA(const ByteStringView& str, bool bIgnoreCase); namespace std { template <> struct hash<ByteString> { std::size_t operator()(const ByteString& str) const { return FX_HashCode_GetA(str.AsStringView(), false); } }; } // namespace std extern template struct std::hash<ByteString>; #endif // CORE_FXCRT_BYTESTRING_H_