String.hpp

Go to the documentation of this file.

/**************************************************************************************/
/*                                                                                    */
/*  Visualization Library                                                             */
/*  http://visualizationlibrary.org                                                   */
/*                                                                                    */
/*  Copyright (c) 2005-2020, Michele Bosi                                             */
/*  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.                                   */
/*                                                                                    */
/*  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 String_INCLUDE_ONCE
#define String_INCLUDE_ONCE

#include <vlCore/vlnamespace.hpp>
#include <vlCore/Object.hpp>
#include <vector>
#include <string.h>

#if defined(VL_PLATFORM_WINDOWS)
  #define VL_PLATFORM_DEFAULT_ENCODING SE_LATIN1
#else
  #define VL_PLATFORM_DEFAULT_ENCODING SE_UTF8
#endif

namespace vl
{
  class VirtualFile;

  class VLCORE_EXPORT String
  {
  public:
    static EStringEncoding detectEncoding(const void* str, int byte_count, EStringEncoding encoding = VL_PLATFORM_DEFAULT_ENCODING);

    static String loadText(const String& path, EStringEncoding encoding = VL_PLATFORM_DEFAULT_ENCODING);

    static String loadText(const char* path, EStringEncoding encoding = VL_PLATFORM_DEFAULT_ENCODING) { return loadText(String(path),encoding); }

    static String loadText(VirtualFile* file, EStringEncoding encoding = VL_PLATFORM_DEFAULT_ENCODING);

    static String loadText(void* data, int bytes, EStringEncoding encoding = VL_PLATFORM_DEFAULT_ENCODING);

    static unsigned short getUpperCase(unsigned short ch);

    static unsigned short getLowerCase(unsigned short ch);

    static unsigned short getTitleCase(unsigned short ch);

    static void filterStrings(std::vector<String>& strings, const String& filter);

    static wchar_t platformSlash()
    {
      #if defined(VL_PLATFORM_WINDOWS)
        return '\\';
      #else
        return '/';
      #endif
    }

    static std::string trimStdString(const std::string& text);

    String();

    String(const String& other);

    String(const wchar_t* wstr);

    String(const char* str);

    String(const std::string& str) { *this = fromStdString(str, true); }

    String(const std::wstring& str) { *this = fromStdWString(str); }

    explicit String(wchar_t ch, int count=1);

    const wchar_t* ptr() const { createData(); return &(*mString)[0]; }

    wchar_t* ptr() { acquireData(); return &(*mString)[0]; }

    int length() const { if (!mString) return 0; createData(); return (int)mString->length(); };

    bool empty() const { return length() == 0; }

    bool null() const { return !mString; }

    String& clear() { acquireData(); mString->clear(); return *this; }

    const wchar_t& operator[](int i) const { createData(); return (*mString)[i]; }

    wchar_t& operator[](int i) { acquireData(); return (*mString)[i]; }

    String& replace( wchar_t old_ch, wchar_t new_ch );

    String& replace( int start, int count, wchar_t ch );

    String& replace( int start, int count, const String& str );

    String& replace( const String& oldstr, const String& newstr, bool case_sensitive=true );

    String& remove(wchar_t ch, int start=0, int count=-1);

    String& remove(const String& str, int start=0, int count=-1);

    String& remove( int start, int count );

    String& reverse();

    String& normalizeSlashes();

    int count(wchar_t ch, int start=0) const;

    int count(const String& str, int start=0) const;

    int compare(const String& other) const;

    bool endsWith(const String& str) const;

    bool startsWith(const String& str) const;

    bool endsWith(wchar_t ch) const;

    bool startsWith(wchar_t ch) const;

    String& insert(int pos, const String& str);

    String& insert(int pos, wchar_t ch, int count=1);

    String left(int count) const;

    String right(int count) const;

    String extractPath() const;

    String extractFileName() const;

    String extractFileExtension(bool require_dot=true) const;

    String& resize(int character_count);

    String substring(int start, int count=-1) const;

    String& fill(wchar_t ch);

    String& trim(wchar_t ch);

    String& trim(const String& chars);

    String& trim();

    void split(wchar_t separator, std::vector<String>& fields, bool remove_empty_fields=false) const;

    void split(const String& separator_list, std::vector<String>& fields, bool remove_empty_fields=false) const;

    void splitLines(std::vector<String>& lines) const;

    String field(wchar_t separator, int field_index) const;

    String& append(const String& other);

    String& append(wchar_t ch, int count=1);

    String& prepend(const String& str);

    String& prepend(wchar_t ch, int count);

    int find(wchar_t ch, int start=0) const;

    int find(const String& substr, int start=0) const;

    int findInLargeText(const String& substr, int start=0) const;

    int findBackwards(wchar_t ch) const;

    int findBackwards(const String& str) const;

    bool contains(wchar_t ch) const;

    bool contains(const String& str) const;

    void squeeze();

    // transcoding routines

    static String fromPointer(const void* value);

    static String fromInt(int value);

    static String fromUInt(unsigned int value);

    static String fromLongLong(long long value);

    static String fromULongLong(unsigned long long value);

    static String fromDouble(double value, int decimals=6);

    static String fromStdString(const std::string& str, bool utf8=true);

    static String fromStdWString(const std::wstring& str);

    static String fromAscii(const char* str, int size=-1);

    static String fromUTF16BE(const unsigned short* str, int byte_count=-1);

    static String fromUTF16LE(const unsigned short* str, int byte_count=-1);

    static String fromUTF16(const unsigned short* str, int byte_count=-1);

    static String fromUTF8(const char* str, int byte_count=-1);

    static String fromLatin1(const char* str, int character_count=-1);

    int toInt(bool hex=false) const;

    double toDouble() const;

    float toFloat() const { return (float)toDouble(); }

    static String printf(const char* fmt, ...);

    std::string toStdString() const;

    std::wstring toStdWString() const;

    void toAscii(std::string& ascii, bool translate_non_ascii_chars=true) const;

    void toUTF8(std::vector<unsigned char>& utf8, bool include_utf8_signature=true) const;

    void toUTF8(std::string& utf8, bool include_utf8_signature=true) const;

    void toUTF16BE(std::vector<unsigned char>& utf16, bool include_utf16be_signature=true) const;

    void toUTF16LE(std::vector<unsigned char>& utf16, bool include_utf16le_signature=true) const;

    void toLatin1(std::vector<unsigned char>& latin1) const;

    String toLowerCase() const;

    String toUpperCase() const;

    bool operator<(const String& other) const
    {
      return compare(other) < 0;
    }

    String& operator=(const char* str)
    {
      *this = fromUTF8(str);
      return *this;
    }

    String& operator=(const std::string& str)
    {
      *this = fromUTF8(str.c_str());
      return *this;
    }

    String& operator=(const wchar_t* wstr)
    {
      acquireData();

      mString->clear();
      if (wstr)
      {
        for(int i=0; wstr[i]; ++i)
          mString->push_back(wstr[i]);
      }
      return *this;
    }

    String& operator=(const std::wstring& str)
    {
      return operator=(str.c_str());
    }

#if VL_STRING_COPY_ON_WRITE == 0
    String& operator=(const String& other)
    {
      other.acquireData();
      mString = new StringData(*other.mString);
      return *this;
    }
#else 
  String& operator=(const String& other) = default; // because copy constructor is defined, an operator= has to be too
#endif

    bool operator==(const String& other) const
    {
      if ( empty() && other.empty() )
        return true;
      if ( empty() && !other.empty() )
        return false;
      if ( !empty() && other.empty() )
        return false;

      createData();

      if (mString == other.mString)
        return true;
      else
      if ( other.length() == length() )
      {
        return memcmp( ptr(), other.ptr(), sizeof(wchar_t)*length() ) == 0;
      }
      else
        return false;
    }

    bool operator==(const std::string& other) const
    {
      createData();

      if ( (int)other.length() == length() )
      {
        for(int i=0; i<length(); ++i)
          if ((*mString)[i] != (wchar_t)other[i])
            return false;
        return true;
      }
      else
        return false;
    }

    bool operator==(const std::wstring& other) const
    {
      createData();

      if ( (int)other.length() == length() )
      {
        for(int i=0; i<length(); ++i)
          if ((*mString)[i] != other[i])
            return false;
        return true;
      }
      else
        return false;
    }

    bool operator==(const char* other) const
    {
      createData();

      int i=0;
      for(; other[i] && i<length(); ++i)
        if ( (*mString)[i] != (wchar_t)other[i] )
          return false;
      return i == length() && other[i] == 0;
    }

    bool operator==(const wchar_t* other) const
    {
      createData();

      int i=0;
      for(; other[i] && i<length(); ++i)
        if ( (*mString)[i] != other[i] )
          return false;
      return i == length() && other[i] == 0;
    }

    bool operator!=(const String& other) const
    {
      return !this->operator==(other);
    }

    bool operator!=(const std::string& other) const
    {
      return !this->operator==(other);
    }

    bool operator!=(const std::wstring& other) const
    {
      return !this->operator==(other);
    }

    bool operator!=(const char* other) const
    {
      return !this->operator==(other);
    }

    bool operator!=(const wchar_t* other) const
    {
      return !this->operator==(other);
    }

    String& operator+=(wchar_t ch)
    {
      acquireData();
      mString->push_back(ch);
      return *this;
    }

    String operator+(wchar_t ch) const
    {
      String tmp = *this;
      tmp += ch;
      return tmp;
    }

    String& operator+=(const String& other)
    {
      return append(other);
    }

    String operator+(const String& other) const
    {
      String tmp = *this;
      tmp.append(other);
      return tmp;
    }

    void acquireData() const
    {
      createData();

      if (mString->referenceCount() > 1)
        mString = new StringData(*mString);
    }

  protected:
    void createData() const { if (!mString) mString = new StringData; }

  private:
    class StringData: public Object
    {
    public:
      void clear() { mWString.clear(); }
      void push_back(wchar_t a) { mWString.push_back(a); }
      const wchar_t& operator[](int i) const { return mWString[i]; }
      wchar_t& operator[](int i) { return mWString[i]; }
      int length() const { return (int)mWString.length(); }
      void resize(int size) { mWString.resize(size); }
      void squeeze()
      {
        std::wstring new_string = mWString;
        mWString.swap( new_string );
      }
    protected:
      std::wstring mWString;
    };

    mutable ref<StringData> mString;
  };
//-----------------------------------------------------------------------------
  inline String operator+(const wchar_t* pstr, const String& str)
  {
    return String(pstr) + str;
  }
//-----------------------------------------------------------------------------
  inline String operator+(const char* pstr, const String& str)
  {
    return String(pstr) + str;
  }
//-----------------------------------------------------------------------------
  inline String operator+(wchar_t ch, const String& str)
  {
    return String(ch,1) + str;
  }
//-----------------------------------------------------------------------------
  inline String operator+(char ch, const String& str)
  {
    return String(ch,1) + str;
  }
//-----------------------------------------------------------------------------
}

#endif