Revert "Make CFX_WideString::LockBuffer() completely unused."
[pdfium.git] / core / include / fxcrt / fx_string.h
index 08fb83c..1efb814 100644 (file)
@@ -1,11 +1,16 @@
 // Copyright 2014 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 _FX_STRING_H_
 #define _FX_STRING_H_
+
+#include <algorithm>
+
+#include "fx_memory.h"
+
 class CFX_ByteStringC;
 class CFX_ByteString;
 class CFX_WideStringC;
@@ -15,9 +20,13 @@ class CFX_BinaryBuf;
 typedef int FX_STRSIZE;
 class CFX_ByteStringL;
 class CFX_WideStringL;
-class CFX_ByteStringC : public CFX_Object
+
+// An immutable string with caller-provided storage which must outlive the
+// string itself.
+class CFX_ByteStringC
 {
 public:
+    typedef FX_CHAR value_type;
 
     CFX_ByteStringC()
     {
@@ -37,6 +46,13 @@ public:
         m_Length = ptr ? (FX_STRSIZE)FXSYS_strlen(ptr) : 0;
     }
 
+    // |ch| must be an lvalue that outlives the the CFX_ByteStringC. However,
+    // the use of char rvalues are not caught at compile time.  They are
+    // implicitly promoted to CFX_ByteString (see below) and then the
+    // CFX_ByteStringC is constructed from the CFX_ByteString via the alternate
+    // constructor below. The CFX_ByteString then typically goes out of scope
+    // and |m_Ptr| may be left pointing to invalid memory. Beware.
+    // TODO(tsepez): Mark single-argument string constructors as explicit.
     CFX_ByteStringC(FX_CHAR& ch)
     {
         m_Ptr = (FX_LPCBYTE)&ch;
@@ -64,7 +80,7 @@ public:
     CFX_ByteStringC& operator = (FX_LPCSTR src)
     {
         m_Ptr = (FX_LPCBYTE)src;
-        m_Length = (FX_STRSIZE)FXSYS_strlen(src);
+        m_Length = m_Ptr ? (FX_STRSIZE)FXSYS_strlen(src) : 0;
         return *this;
     }
 
@@ -86,7 +102,6 @@ public:
     {
         return         str.m_Length != m_Length || FXSYS_memcmp32(str.m_Ptr, m_Ptr, m_Length) != 0;
     }
-#define FXBSTR_ID(c1, c2, c3, c4) ((c1 << 24) | (c2 << 16) | (c3 << 8) | (c4))
 
     FX_DWORD           GetID(FX_STRSIZE start_pos = 0) const;
 
@@ -110,11 +125,6 @@ public:
         return m_Length == 0;
     }
 
-    operator           FX_LPCBYTE() const
-    {
-        return m_Ptr;
-    }
-
     FX_BYTE                    GetAt(FX_STRSIZE index) const
     {
         return m_Ptr[index];
@@ -133,13 +143,23 @@ public:
         }
         return CFX_ByteStringC(m_Ptr + index, count);
     }
-protected:
 
-    FX_LPCBYTE         m_Ptr;
+    const FX_BYTE& operator[] (size_t index) const
+    {
+        return m_Ptr[index];
+    }
+
+    bool operator< (const CFX_ByteStringC& that) const
+    {
+        int result = memcmp(m_Ptr, that.m_Ptr, std::min(m_Length, that.m_Length));
+        return result < 0 || (result == 0 && m_Length < that.m_Length);
+    }
 
+protected:
+    FX_LPCBYTE         m_Ptr;
     FX_STRSIZE         m_Length;
-private:
 
+private:
     void*                      operator new (size_t) throw()
     {
         return NULL;
@@ -147,6 +167,7 @@ private:
 };
 typedef const CFX_ByteStringC& FX_BSTR;
 #define FX_BSTRC(str) CFX_ByteStringC(str, sizeof str-1)
+#define FXBSTR_ID(c1, c2, c3, c4) ((c1 << 24) | (c2 << 16) | (c3 << 8) | (c4))
 struct CFX_StringData {
 
     long               m_nRefs;
@@ -157,9 +178,10 @@ struct CFX_StringData {
 
     FX_CHAR            m_String[1];
 };
-class CFX_ByteString : public CFX_Object
+class CFX_ByteString 
 {
 public:
+    typedef FX_CHAR value_type;
 
     CFX_ByteString()
     {
@@ -184,6 +206,13 @@ public:
 
     static CFX_ByteString      FromUnicode(const CFX_WideString& str);
 
+    // Explicit conversion to raw string
+    FX_LPCSTR c_str() const
+    {
+        return m_pData ? m_pData->m_String : "";
+    }
+
+    // Implicit conversion to C-style string -- deprecated
     operator                           FX_LPCSTR() const
     {
         return m_pData ? m_pData->m_String : "";
@@ -239,6 +268,12 @@ public:
         return !operator==(str);
     }
 
+    bool operator< (const CFX_ByteString& str) const
+    {
+        int result = FXSYS_memcmp32(c_str(), str.c_str(), std::min(GetLength(), str.GetLength()));
+        return result < 0 || (result == 0 && GetLength() < str.GetLength());
+    }
+
     void                                       Empty();
 
     const CFX_ByteString&      operator = (FX_LPCSTR str);
@@ -329,7 +364,6 @@ public:
 
     FX_DWORD                           GetID(FX_STRSIZE start_pos = 0) const;
 
-    static CFX_ByteString      LoadFromFile(FX_BSTR file_path);
 #define FXFORMAT_SIGNED                        1
 #define FXFORMAT_HEX                   2
 #define FXFORMAT_CAPITAL               4
@@ -340,7 +374,7 @@ public:
 protected:
 
     struct CFX_StringData*     m_pData;
-    void                                       AllocCopy(CFX_ByteString& dest, FX_STRSIZE nCopyLen, FX_STRSIZE nCopyIndex, FX_STRSIZE nExtraLen) const;
+    void                                       AllocCopy(CFX_ByteString& dest, FX_STRSIZE nCopyLen, FX_STRSIZE nCopyIndex) const;
     void                                       AssignCopy(FX_STRSIZE nSrcLen, FX_LPCSTR lpszSrcData);
     void                                       ConcatCopy(FX_STRSIZE nSrc1Len, FX_LPCSTR lpszSrc1Data, FX_STRSIZE nSrc2Len, FX_LPCSTR lpszSrc2Data);
     void                                       ConcatInPlace(FX_STRSIZE nSrcLen, FX_LPCSTR lpszSrcData);
@@ -407,65 +441,10 @@ inline CFX_ByteString operator + (FX_BSTR str1, const CFX_ByteString& str2)
 {
     return CFX_ByteString(str1, str2);
 }
-class CFX_StringBufBase : public CFX_Object
-{
-public:
-
-    CFX_StringBufBase(FX_STRSIZE limit)
-    {
-        m_Size = 0;
-        m_Limit = limit;
-    }
-
-    FX_CHAR*   GetPtr() const
-    {
-        return (FX_CHAR*)(this + 1);
-    }
-
-    FX_STRSIZE GetSize() const
-    {
-        return m_Size;
-    }
-
-    void               Empty()
-    {
-        m_Size = 0;
-    }
-
-    void               Copy(FX_BSTR str);
-
-    void               Append(FX_BSTR str);
-
-    void               Append(int i, FX_DWORD flags = 0);
-
-    CFX_ByteStringC            GetStringC() const
-    {
-        return CFX_ByteStringC((FX_CHAR*)(this + 1), m_Size);
-    }
-
-    CFX_ByteString             GetString() const
-    {
-        return CFX_ByteString((FX_CHAR*)(this + 1), m_Size);
-    }
-protected:
-
-    FX_STRSIZE m_Limit;
-
-    FX_STRSIZE m_Size;
-};
-template<FX_STRSIZE limit>
-class CFX_StringBufTemplate : public CFX_StringBufBase
-{
-public:
-
-    CFX_StringBufTemplate() : CFX_StringBufBase(limit) {}
-
-    FX_CHAR            m_Buffer[limit];
-};
-typedef CFX_StringBufTemplate<256> CFX_StringBuf256;
-class CFX_WideStringC : public CFX_Object
+class CFX_WideStringC
 {
 public:
+    typedef FX_WCHAR value_type;
 
     CFX_WideStringC()
     {
@@ -584,20 +563,30 @@ public:
         }
         return CFX_WideStringC(m_Ptr + m_Length - count, count);
     }
-protected:
 
-    FX_LPCWSTR         m_Ptr;
+    const FX_WCHAR& operator[] (size_t index) const
+    {
+        return m_Ptr[index];
+    }
 
+    bool operator< (const CFX_WideStringC& that) const
+    {
+        int result = wmemcmp(m_Ptr, that.m_Ptr, std::min(m_Length, that.m_Length));
+        return result < 0 || (result == 0 && m_Length < that.m_Length);
+     }
+
+protected:
+    FX_LPCWSTR         m_Ptr;
     FX_STRSIZE         m_Length;
-private:
 
+private:
     void*                      operator new (size_t) throw()
     {
         return NULL;
     }
 };
 typedef const CFX_WideStringC& FX_WSTR;
-#define FX_WSTRC(wstr) CFX_WideStringC((FX_LPCWSTR)wstr, sizeof(wstr) / sizeof(FX_WCHAR) - 1)
+#define FX_WSTRC(wstr) CFX_WideStringC(wstr, FX_ArraySize(wstr) - 1)
 struct CFX_StringDataW {
 
     long               m_nRefs;
@@ -608,9 +597,10 @@ struct CFX_StringDataW {
 
     FX_WCHAR   m_String[1];
 };
-class CFX_WideString : public CFX_Object
+class CFX_WideString 
 {
 public:
+    typedef FX_WCHAR value_type;
 
     CFX_WideString()
     {
@@ -634,13 +624,22 @@ public:
 
     static CFX_WideString      FromLocal(const char* str, FX_STRSIZE len = -1);
 
-    static CFX_WideString      FromUTF8(const char* str, FX_STRSIZE len = -1);
+    static CFX_WideString      FromUTF8(const char* str, FX_STRSIZE len);
+
+    static CFX_WideString      FromUTF16LE(const unsigned short* str, FX_STRSIZE len);
 
-    static CFX_WideString      FromUTF16LE(const unsigned short* str, FX_STRSIZE len = -1);
+    static FX_STRSIZE       WStringLength(const unsigned short* str);
 
+    // Explicit conversion to raw string
+    FX_LPCWSTR c_str() const
+    {
+        return m_pData ? m_pData->m_String : L"";
+    }
+
+    // Implicit conversion to C-style wide string -- deprecated
     operator FX_LPCWSTR() const
     {
-        return m_pData ? m_pData->m_String : (FX_WCHAR*)L"";
+        return m_pData ? m_pData->m_String : L"";
     }
 
     void                                       Empty();
@@ -670,6 +669,11 @@ public:
 
     const CFX_WideString&      operator += (const CFX_WideStringC& str);
 
+    bool operator< (const CFX_WideString& str) const {
+        int result = wmemcmp(c_str(), str.c_str(), std::min(GetLength(), str.GetLength()));
+        return result < 0 || (result == 0 && GetLength() < str.GetLength());
+    }
+
     FX_WCHAR                           GetAt(FX_STRSIZE nIndex) const
     {
         return m_pData ? m_pData->m_String[nIndex] : 0;
@@ -744,7 +748,7 @@ public:
 
     CFX_ByteString                     UTF8Encode() const;
 
-    CFX_ByteString                     UTF16LE_Encode(FX_BOOL bTerminate = TRUE) const;
+    CFX_ByteString                     UTF16LE_Encode() const;
 
     void                                       ConvertFrom(const CFX_ByteString& str, CFX_CharMap* pCharMap = NULL);
 protected:
@@ -756,16 +760,16 @@ protected:
     void                                       ConcatInPlace(FX_STRSIZE nSrcLen, FX_LPCWSTR lpszSrcData);
     void                                       ConcatCopy(FX_STRSIZE nSrc1Len, FX_LPCWSTR lpszSrc1Data, FX_STRSIZE nSrc2Len, FX_LPCWSTR lpszSrc2Data);
     void                                       AssignCopy(FX_STRSIZE nSrcLen, FX_LPCWSTR lpszSrcData);
-    void                                       AllocCopy(CFX_WideString& dest, FX_STRSIZE nCopyLen, FX_STRSIZE nCopyIndex, FX_STRSIZE nExtraLen) const;
+    void                                       AllocCopy(CFX_WideString& dest, FX_STRSIZE nCopyLen, FX_STRSIZE nCopyIndex) const;
 };
 inline CFX_WideStringC::CFX_WideStringC(const CFX_WideString& src)
 {
-    m_Ptr = (FX_LPCWSTR)src;
+    m_Ptr = src.c_str();
     m_Length = src.GetLength();
 }
 inline CFX_WideStringC& CFX_WideStringC::operator = (const CFX_WideString& src)
 {
-    m_Ptr = (FX_LPCWSTR)src;
+    m_Ptr = src.c_str();
     m_Length = src.GetLength();
     return *this;
 }
@@ -839,32 +843,6 @@ inline CFX_ByteString      FX_UTF8Encode(FX_WSTR wsStr)
 }
 inline CFX_ByteString  FX_UTF8Encode(const CFX_WideString &wsStr)
 {
-    return FX_UTF8Encode((FX_LPCWSTR)wsStr, wsStr.GetLength());
+    return FX_UTF8Encode(wsStr.c_str(), wsStr.GetLength());
 }
-class CFX_ByteStringL : public CFX_ByteStringC
-{
-public:
-    CFX_ByteStringL() : CFX_ByteStringC() {}
-    ~CFX_ByteStringL() {}
-
-    void               Empty(IFX_Allocator* pAllocator);
-    FX_LPSTR   AllocBuffer(FX_STRSIZE length, IFX_Allocator* pAllocator);
-
-    void               Set(FX_BSTR src, IFX_Allocator* pAllocator);
-};
-class CFX_WideStringL : public CFX_WideStringC
-{
-public:
-    CFX_WideStringL() : CFX_WideStringC() {}
-    ~CFX_WideStringL() {}
-
-    void               Empty(IFX_Allocator* pAllocator);
-    void               Set(FX_WSTR src, IFX_Allocator* pAllocator);
-
-    int                        GetInteger() const;
-    FX_FLOAT   GetFloat() const;
-
-    void               TrimRight(FX_LPCWSTR lpszTargets);
-};
-void   FX_UTF8Encode(FX_LPCWSTR pwsStr, FX_STRSIZE len, CFX_ByteStringL &utf8Str, IFX_Allocator* pAllocator = NULL);
 #endif