String.hpp

 
//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2023 Laurent Gomila (laurent@sfml-dev.org)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef SFML_STRING_HPP
#define SFML_STRING_HPP
 
// Headers
#include <SFML/System/Export.hpp>
#include <SFML/System/Utf.hpp>
#include <iterator>
#include <locale>
#include <string>
 
 
namespace sf
{
class SFML_SYSTEM_API String
{
public:
 
    // Types
    typedef std::basic_string<Uint32>::iterator       Iterator;      
    typedef std::basic_string<Uint32>::const_iterator ConstIterator; 
 
    // Static member data
    static const std::size_t InvalidPos; 
 
    String();
 
    String(char ansiChar, const std::locale& locale = std::locale());
 
    String(wchar_t wideChar);
 
    String(Uint32 utf32Char);
 
    String(const char* ansiString, const std::locale& locale = std::locale());
 
    String(const std::string& ansiString, const std::locale& locale = std::locale());
 
    String(const wchar_t* wideString);
 
    String(const std::wstring& wideString);
 
    String(const Uint32* utf32String);
 
    String(const std::basic_string<Uint32>& utf32String);
 
    String(const String& copy);
 
    template <typename T>
    static String fromUtf8(T begin, T end);
 
    template <typename T>
    static String fromUtf16(T begin, T end);
 
    template <typename T>
    static String fromUtf32(T begin, T end);
 
    operator std::string() const;
 
    operator std::wstring() const;
 
    std::string toAnsiString(const std::locale& locale = std::locale()) const;
 
    std::wstring toWideString() const;
 
    std::basic_string<Uint8> toUtf8() const;
 
    std::basic_string<Uint16> toUtf16() const;
 
    std::basic_string<Uint32> toUtf32() const;
 
    String& operator =(const String& right);
 
    String& operator +=(const String& right);
 
    Uint32 operator [](std::size_t index) const;
 
    Uint32& operator [](std::size_t index);
 
    void clear();
 
    std::size_t getSize() const;
 
    bool isEmpty() const;
 
    void erase(std::size_t position, std::size_t count = 1);
 
    void insert(std::size_t position, const String& str);
 
    std::size_t find(const String& str, std::size_t start = 0) const;
 
    void replace(std::size_t position, std::size_t length, const String& replaceWith);
 
    void replace(const String& searchFor, const String& replaceWith);
 
    String substring(std::size_t position, std::size_t length = InvalidPos) const;
 
    const Uint32* getData() const;
 
    Iterator begin();
 
    ConstIterator begin() const;
 
    Iterator end();
 
    ConstIterator end() const;
 
private:
 
    friend SFML_SYSTEM_API bool operator ==(const String& left, const String& right);
    friend SFML_SYSTEM_API bool operator <(const String& left, const String& right);
 
    // Member data
    std::basic_string<Uint32> m_string; 
};
 
SFML_SYSTEM_API bool operator ==(const String& left, const String& right);
 
SFML_SYSTEM_API bool operator !=(const String& left, const String& right);
 
SFML_SYSTEM_API bool operator <(const String& left, const String& right);
 
SFML_SYSTEM_API bool operator >(const String& left, const String& right);
 
SFML_SYSTEM_API bool operator <=(const String& left, const String& right);
 
SFML_SYSTEM_API bool operator >=(const String& left, const String& right);
 
SFML_SYSTEM_API String operator +(const String& left, const String& right);
 
#include <SFML/System/String.inl>
 
} // namespace sf
 
 
#endif // SFML_STRING_HPP