documentation/3.1.0/String_8hpp_source

//

// SFML - Simple and Fast Multimedia Library

// Copyright (C) 2007-2026 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.

//


#pragma once


// Headers

#include <SFML/System/Export.hpp>


#include <SFML/System/Utf.hpp>


#include <locale>

#include <optional>

#include <string>

#include <string_view>


#include <cstddef>

#include <cstdint>


namespace sf

{


struct SFML_SYSTEM_API U8StringCharTraits

{

    // NOLINTBEGIN(readability-identifier-naming)

    using char_type  = std::uint8_t;

    using int_type   = std::char_traits<char>::int_type;

    using off_type   = std::char_traits<char>::off_type;

    using pos_type   = std::char_traits<char>::pos_type;

    using state_type = std::char_traits<char>::state_type;


    static void             assign(char_type& c1, char_type c2) noexcept;

    static char_type*       assign(char_type* s, std::size_t n, char_type c);

    static bool             eq(char_type c1, char_type c2) noexcept;

    static bool             lt(char_type c1, char_type c2) noexcept;

    static char_type*       move(char_type* s1, const char_type* s2, std::size_t n);

    static char_type*       copy(char_type* s1, const char_type* s2, std::size_t n);

    static int              compare(const char_type* s1, const char_type* s2, std::size_t n);

    static std::size_t      length(const char_type* s);

    static const char_type* find(const char_type* s, std::size_t n, const char_type& c);

    static char_type        to_char_type(int_type i) noexcept;

    static int_type         to_int_type(char_type c) noexcept;

    static bool             eq_int_type(int_type i1, int_type i2) noexcept;

    static int_type         eof() noexcept;

    static int_type         not_eof(int_type i) noexcept;

    // NOLINTEND(readability-identifier-naming)

};


using U8String = std::basic_string<std::uint8_t, U8StringCharTraits>;


class SFML_SYSTEM_API String

{

public:

    // Types

    using Iterator      = std::u32string::iterator;

    using ConstIterator = std::u32string::const_iterator;


    // Static member data

    // NOLINTBEGIN(readability-identifier-naming)

    static inline const std::size_t InvalidPos{std::u32string::npos};

    // NOLINTEND(readability-identifier-naming)


    String() = default;


    String(std::nullptr_t, const std::locale& = {}) = delete;


    String(char ansiChar, const std::locale& locale = {});


    String(wchar_t wideChar);


    String(char32_t utf32Char);


    String(const char* ansiString, const std::locale& locale = {});


    String(const std::string& ansiString, const std::locale& locale = {});


    String(std::string_view ansiString, const std::locale& locale = {});


    String(const wchar_t* wideString);


    String(const std::wstring& wideString);


    String(std::wstring_view wideString);


    String(const char32_t* utf32String);


    String(std::u32string utf32String);


    String(std::u32string_view utf32String);


    template <typename T>

    [[nodiscard]] static String fromUtf8(T begin, T end, std::optional<char32_t> replacement = std::nullopt);


    template <typename T>

    [[nodiscard]] static String fromUtf16(T begin, T end, std::optional<char32_t> replacement = std::nullopt);


    template <typename T>

    [[nodiscard]] static String fromUtf32(T begin, T end);


    [[deprecated("Use toAnsiString() instead")]] operator std::string() const;


    [[deprecated("Use toWideString() instead")]] operator std::wstring() const;


    [[nodiscard]] std::string toAnsiString(const std::locale&  locale      = {},

                                           std::optional<char> replacement = std::nullopt) const;


    [[nodiscard]] std::wstring toWideString(std::optional<wchar_t> replacement = std::nullopt) const;


    [[nodiscard]] sf::U8String toUtf8(std::optional<std::uint8_t> replacement = std::nullopt) const;


    [[nodiscard]] std::u16string toUtf16(std::optional<std::uint16_t> replacement = std::nullopt) const;


    [[nodiscard]] std::u32string toUtf32() const;


    String& operator+=(const String& right);


    [[nodiscard]] char32_t operator[](std::size_t index) const;


    [[nodiscard]] char32_t& operator[](std::size_t index);


    void clear();


    [[nodiscard]] std::size_t getSize() const;


    [[nodiscard]] bool isEmpty() const;


    void erase(std::size_t position, std::size_t count = 1);


    void insert(std::size_t position, const String& str);


    [[nodiscard]] 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);


    [[nodiscard]] String substring(std::size_t position, std::size_t length = InvalidPos) const;


    [[nodiscard]] const char32_t* getData() const;


    [[nodiscard]] Iterator begin();


    [[nodiscard]] ConstIterator begin() const;


    [[nodiscard]] Iterator end();


    [[nodiscard]] ConstIterator end() const;


    [[nodiscard]] bool isGraphemeBoundary(std::size_t position) const;


    [[nodiscard]] bool isWordBoundary(std::size_t position) const;


    [[nodiscard]] bool isSentenceBoundary(std::size_t position) const;


private:

#if defined(SFML_SYSTEM_WINDOWS)

    friend SFML_SYSTEM_API bool operator==(const String& left, const String& right);

    friend SFML_SYSTEM_API bool operator<(const String& left, const String& right);

#else

    friend bool operator==(const String& left, const String& right);

    friend bool operator<(const String& left, const String& right);

#endif


    // Member data

    std::u32string m_string;

};


[[nodiscard]] SFML_SYSTEM_API bool operator==(const String& left, const String& right);


[[nodiscard]] SFML_SYSTEM_API bool operator!=(const String& left, const String& right);


[[nodiscard]] SFML_SYSTEM_API bool operator<(const String& left, const String& right);


[[nodiscard]] SFML_SYSTEM_API bool operator>(const String& left, const String& right);


[[nodiscard]] SFML_SYSTEM_API bool operator<=(const String& left, const String& right);


[[nodiscard]] SFML_SYSTEM_API bool operator>=(const String& left, const String& right);


[[nodiscard]] SFML_SYSTEM_API String operator+(const String& left, const String& right);


} // namespace sf


#include <SFML/System/String.inl>


Export.hpp

SFML_SYSTEM_API
#define SFML_SYSTEM_API
Definition System/Export.hpp:42

Utf.hpp

sf::String::fromUtf16
static String fromUtf16(T begin, T end, std::optional< char32_t > replacement=std::nullopt)
Create a new sf::String from a UTF-16 encoded string.

sf::String::toUtf8
sf::U8String toUtf8(std::optional< std::uint8_t > replacement=std::nullopt) const
Convert the Unicode string to a UTF-8 string.

sf::String::begin
ConstIterator begin() const
Return an iterator to the beginning of the string.

sf::String::getData
const char32_t * getData() const
Get a pointer to the C-style array of characters.

sf::String::String
String(const std::string &ansiString, const std::locale &locale={})
Construct from an ANSI string and a locale.

sf::String::operator>=
bool operator>=(const String &left, const String &right)
Overload of operator>= to compare two UTF-32 strings.

sf::String::String
String()=default
Default constructor.

sf::String::String
String(std::string_view ansiString, const std::locale &locale={})
Construct from an ANSI string view and a locale.

sf::String::toAnsiString
std::string toAnsiString(const std::locale &locale={}, std::optional< char > replacement=std::nullopt) const
Convert the Unicode string to an ANSI string.

sf::String::isEmpty
bool isEmpty() const
Check whether the string is empty or not.

sf::String::String
String(std::wstring_view wideString)
Construct from a wide string view.

sf::String::String
String(std::u32string utf32String)
Construct from an UTF-32 string.

sf::String::clear
void clear()
Clear the string.

sf::String::operator!=
bool operator!=(const String &left, const String &right)
Overload of operator!= to compare two UTF-32 strings.

sf::String::operator==
friend bool operator==(const String &left, const String &right)

sf::String::substring
String substring(std::size_t position, std::size_t length=InvalidPos) const
Return a part of the string.

sf::String::String
String(char ansiChar, const std::locale &locale={})
Construct from a single ANSI character and a locale.

sf::String::toWideString
std::wstring toWideString(std::optional< wchar_t > replacement=std::nullopt) const
Convert the Unicode string to a wide string.

sf::String::operator<
friend bool operator<(const String &left, const String &right)

sf::String::String
String(const wchar_t *wideString)
Construct from null-terminated C-style wide string.

sf::String::toUtf32
std::u32string toUtf32() const
Convert the Unicode string to a UTF-32 string.

sf::String::String
String(const std::wstring &wideString)
Construct from a wide string.

sf::String::operator[]
char32_t operator[](std::size_t index) const
Overload of operator[] to access a character by its position.

sf::String::isSentenceBoundary
bool isSentenceBoundary(std::size_t position) const
Check if the position before a character is a sentence boundary.

sf::String::String
String(const char *ansiString, const std::locale &locale={})
Construct from a null-terminated C-style ANSI string and a locale.

sf::String::replace
void replace(const String &searchFor, const String &replaceWith)
Replace all occurrences of a substring with a replacement string.

sf::String::begin
Iterator begin()
Return an iterator to the beginning of the string.

sf::String::toUtf16
std::u16string toUtf16(std::optional< std::uint16_t > replacement=std::nullopt) const
Convert the Unicode string to a UTF-16 string.

sf::String::find
std::size_t find(const String &str, std::size_t start=0) const
Find a sequence of one or more characters in the string.

sf::String::erase
void erase(std::size_t position, std::size_t count=1)
Erase one or more characters from the string.

sf::String::String
String(char32_t utf32Char)
Construct from single UTF-32 character.

sf::String::fromUtf32
static String fromUtf32(T begin, T end)
Create a new sf::String from a UTF-32 encoded string.

sf::String::InvalidPos
static const std::size_t InvalidPos
Represents an invalid position in the string.
Definition String.hpp:104

sf::String::operator<=
bool operator<=(const String &left, const String &right)
Overload of operator<= to compare two UTF-32 strings.

sf::String::operator[]
char32_t & operator[](std::size_t index)
Overload of operator[] to access a character by its position.

sf::String::ConstIterator
std::u32string::const_iterator ConstIterator
Read-only iterator type.
Definition String.hpp:97

sf::String::end
Iterator end()
Return an iterator to the end of the string.

sf::String::operator>
bool operator>(const String &left, const String &right)
Overload of operator> to compare two UTF-32 strings.

sf::String::String
String(const char32_t *utf32String)
Construct from a null-terminated C-style UTF-32 string.

sf::String::isGraphemeBoundary
bool isGraphemeBoundary(std::size_t position) const
Check if the position before a character is a grapheme boundary.

sf::String::insert
void insert(std::size_t position, const String &str)
Insert one or more characters into the string.

sf::String::isWordBoundary
bool isWordBoundary(std::size_t position) const
Check if the position before a character is a word boundary.

sf::String::String
String(std::u32string_view utf32String)
Construct from an UTF-32 string view.

sf::String::replace
void replace(std::size_t position, std::size_t length, const String &replaceWith)
Replace a substring with another string.

sf::String::fromUtf8
static String fromUtf8(T begin, T end, std::optional< char32_t > replacement=std::nullopt)
Create a new sf::String from a UTF-8 encoded string.

sf::String::getSize
std::size_t getSize() const
Get the size of the string.

sf::String::Iterator
std::u32string::iterator Iterator
Iterator type.
Definition String.hpp:96

sf::String::String
String(wchar_t wideChar)
Construct from single wide character.

sf::String::operator+
String operator+(const String &left, const String &right)
Overload of binary operator+ to concatenate two strings.

sf::String::end
ConstIterator end() const
Return an iterator to the end of the string.

sf::String::String
String(std::nullptr_t, const std::locale &={})=delete
Deleted std::nullptr_t constructor.

sf::String::operator+=
String & operator+=(const String &right)
Overload of operator+= to append an UTF-32 string.

sf
Definition AudioResource.hpp:36

sf::U8String
std::basic_string< std::uint8_t, U8StringCharTraits > U8String
Portable replacement for std::basic_string<std::uint8_t>.
Definition String.hpp:83

sf::U8StringCharTraits
Character traits for std::uint8_t.
Definition String.hpp:50

sf::U8StringCharTraits::eq_int_type
static bool eq_int_type(int_type i1, int_type i2) noexcept

sf::U8StringCharTraits::assign
static void assign(char_type &c1, char_type c2) noexcept

sf::U8StringCharTraits::copy
static char_type * copy(char_type *s1, const char_type *s2, std::size_t n)

sf::U8StringCharTraits::eq
static bool eq(char_type c1, char_type c2) noexcept

sf::U8StringCharTraits::to_int_type
static int_type to_int_type(char_type c) noexcept

sf::U8StringCharTraits::eof
static int_type eof() noexcept

sf::U8StringCharTraits::move
static char_type * move(char_type *s1, const char_type *s2, std::size_t n)

sf::U8StringCharTraits::int_type
std::char_traits< char >::int_type int_type
Definition String.hpp:53

sf::U8StringCharTraits::compare
static int compare(const char_type *s1, const char_type *s2, std::size_t n)

sf::U8StringCharTraits::length
static std::size_t length(const char_type *s)

sf::U8StringCharTraits::state_type
std::char_traits< char >::state_type state_type
Definition String.hpp:56

sf::U8StringCharTraits::lt
static bool lt(char_type c1, char_type c2) noexcept

sf::U8StringCharTraits::not_eof
static int_type not_eof(int_type i) noexcept

sf::U8StringCharTraits::pos_type
std::char_traits< char >::pos_type pos_type
Definition String.hpp:55

sf::U8StringCharTraits::find
static const char_type * find(const char_type *s, std::size_t n, const char_type &c)

sf::U8StringCharTraits::to_char_type
static char_type to_char_type(int_type i) noexcept

sf::U8StringCharTraits::off_type
std::char_traits< char >::off_type off_type
Definition String.hpp:54

sf::U8StringCharTraits::assign
static char_type * assign(char_type *s, std::size_t n, char_type c)

sf::U8StringCharTraits::char_type
std::uint8_t char_type
Definition String.hpp:52