String.h

Go to the documentation of this file.

#pragma once
#pragma warning(disable : 4251)

#include <Base/base_defines.h>
#include <wchar.h>
#include <wctype.h>

#include <iostream>
#include <ostream>
#include <string>
#include <xstring>



class QString;

namespace App
{
class StringTool;

}

namespace Base
{
class BASE_EXPORT String
{
public:
    friend class StringTool;
    friend class ::App::StringTool;

    //                                                       //
    // --------------------- BEGIN API --------------------- //
    //                                                       //
    // ATTENTION: DO NOT CHANGE ANY SIGNATURES IN THE API !  //
    //                                                       //

    String();
    String(const std::wstring& s);
    String(const QString& s);
    String(const wchar_t* s);
    // String::String(unsigned short const * s);
    String(const Base::String& s);

    bool operator==(const Base::String& other) const;

    bool operator!=(const Base::String& other) const;
    bool operator<(const Base::String& other) const;
    bool operator>(const Base::String& other) const;
    Base::String& operator=(const Base::String& rhs);
    Base::String operator+(const Base::String& other) const;
    Base::String& operator+=(const Base::String& other);

    inline int size() const;
    inline int lenght() const;
    inline bool empty() const;
    // Returns a newly constructed Base::String object with its value initialized to a copy of a substring of this object.
    Base::String substr(size_t pos = 0, size_t len = std::string::npos) const;

    std::wstring toWString() const;
    const wchar_t* c_str() const { return _utf16string.c_str(); }

    bool isEqual(const Base::String& other) const;

    // Refactoring, for the first, let do the compiler the work
    // inline operator std::string() const ;

    //                                                       //
    // ---------------------- END API ---------------------- //
    //                                                       //

    friend BASE_EXPORT std::ostream& operator<<(std::ostream& o, const Base::String& s);

private:
    // Remark: Using wstring on windows OS is ok, since it uses 2bytes/UTF-16 only.
    // On Unix we should consider using a different string since it uses 4bytes/UCS-4.
    std::wstring _utf16string;
};
}  // namespace Base