terminalpp/string_8hpp_source.html

#pragma once


#include "terminalpp/element.hpp"


#include <boost/container_hash/hash.hpp>


#include <concepts>  // IWYU pragma: keep

#include <initializer_list>

#include <string>

#include <vector>

#include <cstddef>


namespace terminalpp {


//* =========================================================================

//* =========================================================================


class TERMINALPP_EXPORT string

{

    using elements_storage = std::vector<element>;


public:

    //* =====================================================================

    //* =====================================================================

    using value_type = element;

    using reference = value_type &;

    using const_reference = value_type const &;

    using pointer = element *;

    using const_pointer = element const *;

    using iterator = elements_storage::iterator;

    using const_iterator = elements_storage::const_iterator;

    using reverse_iterator = elements_storage::reverse_iterator;

    using const_reverse_iterator = elements_storage::const_reverse_iterator;

    using difference_type = std::ptrdiff_t;

    using size_type = std::size_t;


    //* =====================================================================

    //* =====================================================================

    string() = default;


    //* =====================================================================

    //* =====================================================================

    template <std::forward_iterator ForwardIterator>


    string(ForwardIterator &&begin, ForwardIterator &&end)

      : elements_(begin, end)

    {

    }


    //* =====================================================================

    //* =====================================================================

    string(std::initializer_list<element> const &ilist);


    //* =====================================================================

    //* =====================================================================

    string(char const *text);  // NOLINT


    //* =====================================================================

    //* =====================================================================

    string(char const *text, size_type len);


    //* =====================================================================

    //* =====================================================================

    string(std::string const &text);  // NOLINT


    //* =====================================================================

    //* =====================================================================

    string(std::string const &text, terminalpp::attribute const &attr);


    //* =====================================================================

    //* =====================================================================

    string(size_type size, terminalpp::element const &elem);


    //* =====================================================================

    //* =====================================================================

    [[nodiscard]] size_type size() const;


    //* =====================================================================

    //* =====================================================================

    [[nodiscard]] iterator begin();


    //* =====================================================================

    //* =====================================================================

    [[nodiscard]] const_iterator begin() const;


    //* =====================================================================

    //* =====================================================================

    [[nodiscard]] reverse_iterator rbegin();


    //* =====================================================================

    //* =====================================================================

    [[nodiscard]] const_reverse_iterator rbegin() const;


    //* =====================================================================

    //* =====================================================================

    [[nodiscard]] iterator end();


    //* =====================================================================

    //* =====================================================================

    [[nodiscard]] const_iterator end() const;


    //* =====================================================================

    //* =====================================================================

    [[nodiscard]] reverse_iterator rend();


    //* =====================================================================

    //* =====================================================================

    [[nodiscard]] const_reverse_iterator rend() const;


    //* =====================================================================

    //* =====================================================================

    [[nodiscard]] const_iterator cbegin();


    //* =====================================================================

    //* =====================================================================

    [[nodiscard]] const_iterator cend();


    //* =====================================================================

    //* =====================================================================

    void swap(string &other) noexcept;


    //* =====================================================================

    //* =====================================================================

    [[nodiscard]] size_type max_size() const;


    //* =====================================================================

    //* =====================================================================

    [[nodiscard]] bool empty() const;


    //* =====================================================================

    //* =====================================================================

    [[nodiscard]] reference operator[](size_type index);


    //* =====================================================================

    //* =====================================================================

    [[nodiscard]] const_reference operator[](size_type index) const;


    //* =====================================================================

    //* =====================================================================

    string &operator+=(element const &elem);


    //* =====================================================================

    //* =====================================================================


    [[nodiscard]] friend string operator+(string lhs, element const &rhs)

    {

        return lhs += rhs;

    }


    //* =====================================================================

    //* =====================================================================

    string &operator+=(string const &rhs);


    //* =====================================================================

    //* =====================================================================


    [[nodiscard]] friend string operator+(string lhs, string const &rhs)

    {

        return lhs += rhs;

    }


    //* =====================================================================

    //* =====================================================================

    void insert(iterator pos, element const &elem);


    //* =====================================================================

    //* =====================================================================

    template <class InputIterator>


    void insert(

        iterator pos, InputIterator range_begin, InputIterator range_end)

    {

        elements_.insert(pos, range_begin, range_end);

    }


    //* =====================================================================

    //* =====================================================================

    void erase();


    //* =====================================================================

    //* =====================================================================

    void erase(iterator range_begin);


    //* =====================================================================

    //* =====================================================================

    void erase(iterator range_begin, iterator range_end);


    //* =====================================================================

    //* =====================================================================

    [[nodiscard]] friend auto operator<=>(

        string const &lhs, string const &rhs) noexcept = default;


    //* =====================================================================

    //* =====================================================================

    TERMINALPP_EXPORT

    friend bool operator==(string const &lhs, string const &rhs);


    //* =====================================================================

    //* =====================================================================


    [[nodiscard]] friend std::size_t hash_value(string const &str) noexcept

    {

        return boost::hash_range(str.elements_.begin(), str.elements_.end());

    }


private:

    elements_storage elements_;

};


//* =========================================================================

//* =========================================================================

TERMINALPP_EXPORT

std::ostream &operator<<(std::ostream &out, string const &text);


//* =========================================================================

//* =========================================================================

TERMINALPP_EXPORT

[[nodiscard]] ::std::string to_string(terminalpp::string const &tstr);


inline namespace literals {

inline namespace string_literals {


//* =========================================================================

//* =========================================================================

TERMINALPP_EXPORT

[[nodiscard]] ::terminalpp::string operator""_ts(

    char const *text, ::terminalpp::string::size_type length);


//* =========================================================================

//* =========================================================================

TERMINALPP_EXPORT

[[nodiscard]] ::terminalpp::string operator""_ets(

    char const *text, ::terminalpp::string::size_type length);


}  // namespace string_literals

}  // namespace literals

}  // namespace terminalpp


namespace std {


template <>

struct hash<terminalpp::string>

{

    using argument_type = terminalpp::string;

    using result_type = std::size_t;


    [[nodiscard]] result_type operator()(

        argument_type const &str) const noexcept

    {

        return hash_value(str);

    }

};


}  // namespace std

terminalpp::string
A class that represents strings of elements.
Definition string.hpp:21

terminalpp::string::insert
void insert(iterator pos, InputIterator range_begin, InputIterator range_end)
Inserts a range of elements at the iterator position.
Definition string.hpp:215

terminalpp::string::cbegin
const_iterator cbegin()
Returns an iterator to the beginning of the string.

terminalpp::string::swap
void swap(string &other) noexcept
Swaps the contents of this and another string.

terminalpp::string::operator+
friend string operator+(string lhs, element const &rhs)
Append operator.
Definition string.hpp:188

terminalpp::string::string
string(ForwardIterator &&begin, ForwardIterator &&end)
Range Constructor.
Definition string.hpp:49

terminalpp::string::operator<=>
friend auto operator<=>(string const &lhs, string const &rhs) noexcept=default
Relational operators for strings.

terminalpp::string::cend
const_iterator cend()
Returns an iterator to the end of the string.

terminalpp::string::string
string()=default
Constructor.

terminalpp::string::operator+
friend string operator+(string lhs, string const &rhs)
Append operator.
Definition string.hpp:201

terminalpp::string::hash_value
friend std::size_t hash_value(string const &str) noexcept
Hash function.
Definition string.hpp:251

terminalpp::attribute
A structure that carries around the presentation attributes of an ANSI element.
Definition attribute.hpp:17

terminalpp::effect
A structure representing an ANSI graphics effect (e.g. intensity, underlining)
Definition effect.hpp:27

terminalpp::effect::effect
constexpr effect() noexcept
Initialises the intensity to the default (normal) value.
Definition effect.hpp:31

terminalpp::element
A structure that represents the fundamental printable element of a terminal screen,...
Definition element.hpp:20