Catch::StringRef Class Reference

#include <catch_stringref.h>

Public Types
using	size_type = std::size_t

Public Member Functions
	StringRef () noexcept
	StringRef (StringRef const &other) noexcept
	StringRef (StringRef &&other) noexcept
	StringRef (char const *rawChars) noexcept
	StringRef (char const *rawChars, size_type size) noexcept
	StringRef (std::string const &stdString) noexcept
	~StringRef () noexcept
auto	operator= (StringRef const &other) noexcept -> StringRef &
	operator std::string () const
void	swap (StringRef &other) noexcept
auto	operator== (StringRef const &other) const noexcept -> bool
auto	operator!= (StringRef const &other) const noexcept -> bool
auto	operator[] (size_type index) const noexcept -> char
auto	empty () const noexcept -> bool
auto	size () const noexcept -> size_type
auto	numberOfCharacters () const noexcept -> size_type
auto	c_str () const -> char const *
auto	substr (size_type start, size_type size) const noexcept -> StringRef
auto	currentData () const noexcept -> char const *
	StringRef () noexcept
	StringRef (StringRef const &other) noexcept
	StringRef (StringRef &&other) noexcept
	StringRef (char const *rawChars) noexcept
	StringRef (char const *rawChars, size_type size) noexcept
	StringRef (std::string const &stdString) noexcept
	~StringRef () noexcept
auto	operator= (StringRef const &other) noexcept -> StringRef &
	operator std::string () const
void	swap (StringRef &other) noexcept
auto	operator== (StringRef const &other) const noexcept -> bool
auto	operator!= (StringRef const &other) const noexcept -> bool
auto	operator[] (size_type index) const noexcept -> char
auto	empty () const noexcept -> bool
auto	size () const noexcept -> size_type
auto	numberOfCharacters () const noexcept -> size_type
auto	c_str () const -> char const *
auto	substr (size_type start, size_type size) const noexcept -> StringRef
auto	currentData () const noexcept -> char const *

Friends
struct	StringRefTestAccess

Detailed Description

A non-owning string class (similar to the forthcoming std::string_view) Note that, because a StringRef may be a substring of another string, it may not be null terminated. c_str() must return a null terminated string, however, and so the StringRef will internally take ownership (taking a copy), if necessary. In theory this ownership is not externally visible - but it does mean (substring) StringRefs should not be shared between threads.

Definition at line 522 of file catch.hpp.

Member Typedef Documentation

size_type

typedef std::size_t Catch::StringRef::size_type = std::size_t

Definition at line 25 of file catch_stringref.h.

Constructor & Destructor Documentation

StringRef() [1/12]

Catch::StringRef::StringRef ( )

inlinenoexcept

Definition at line 40 of file catch_stringref.h.

        :   StringRef( s_empty, 0 )
        {}

Here is the caller graph for this function:

StringRef() [2/12]

Catch::StringRef::StringRef ( StringRef const & other )

inlinenoexcept

Definition at line 44 of file catch_stringref.h.

        :   m_start( other.m_start ),
            m_size( other.m_size )
        {}

StringRef() [3/12]

Catch::StringRef::StringRef ( StringRef && other )

inlinenoexcept

Definition at line 49 of file catch_stringref.h.

        :   m_start( other.m_start ),
            m_size( other.m_size ),
            m_data( other.m_data )
        {
            other.m_data = nullptr;
        }

StringRef() [4/12]

Catch::StringRef::StringRef ( char const * rawChars )

noexcept

Definition at line 27 of file catch_stringref.cpp.

    : StringRef( rawChars, static_cast<StringRef::size_type>(std::strlen(rawChars) ) )
    {}

StringRef() [5/12]

Catch::StringRef::StringRef ( char const * rawChars, size_type size )

inlinenoexcept

Definition at line 59 of file catch_stringref.h.

        :   m_start( rawChars ),
            m_size( size )
        {}

StringRef() [6/12]

Catch::StringRef::StringRef ( std::string const & stdString )

inlinenoexcept

Definition at line 64 of file catch_stringref.h.

        :   m_start( stdString.c_str() ),
            m_size( stdString.size() )
        {}

~StringRef() [1/2]

Catch::StringRef::~StringRef ( )

inlinenoexcept

Definition at line 69 of file catch_stringref.h.

                              {
            delete[] m_data;
        }

StringRef() [7/12]

Catch::StringRef::StringRef ( )

inlinenoexcept

Definition at line 539 of file catch.hpp.

        :   StringRef( s_empty, 0 )
        {}

StringRef() [8/12]

Catch::StringRef::StringRef ( StringRef const & other )

inlinenoexcept

Definition at line 543 of file catch.hpp.

        :   m_start( other.m_start ),
            m_size( other.m_size )
        {}

StringRef() [9/12]

Catch::StringRef::StringRef ( StringRef && other )

inlinenoexcept

Definition at line 548 of file catch.hpp.

        :   m_start( other.m_start ),
            m_size( other.m_size ),
            m_data( other.m_data )
        {
            other.m_data = nullptr;
        }

StringRef() [10/12]

Catch::StringRef::StringRef ( char const * rawChars )

noexcept

StringRef() [11/12]

Catch::StringRef::StringRef ( char const * rawChars, size_type size )

inlinenoexcept

Definition at line 558 of file catch.hpp.

        :   m_start( rawChars ),
            m_size( size )
        {}

StringRef() [12/12]

Catch::StringRef::StringRef ( std::string const & stdString )

inlinenoexcept

Definition at line 563 of file catch.hpp.

        :   m_start( stdString.c_str() ),
            m_size( stdString.size() )
        {}

~StringRef() [2/2]

Catch::StringRef::~StringRef ( )

inlinenoexcept

Definition at line 568 of file catch.hpp.

                              {
            delete[] m_data;
        }

Member Function Documentation

c_str() [1/2]

auto Catch::StringRef::c_str

(

)

const -> char const*

Definition at line 41 of file catch_stringref.cpp.

                                               {
        if( isSubstring() )
           const_cast<StringRef*>( this )->takeOwnership();
        return m_start;
    }

c_str() [2/2]

auto Catch::StringRef::c_str

(

)

const -> char const *

currentData() [1/2]

auto Catch::StringRef::currentData ( ) const -> char const*

noexcept

Definition at line 46 of file catch_stringref.cpp.

                                                              {
        return m_start;
    }

currentData() [2/2]

auto Catch::StringRef::currentData ( ) const -> char const *

noexcept

Here is the call graph for this function:

empty() [1/2]

auto Catch::StringRef::empty ( ) const -> bool

inlinenoexcept

Definition at line 92 of file catch_stringref.h.

                                            {
            return m_size == 0;
        }

empty() [2/2]

auto Catch::StringRef::empty ( ) const -> bool

inlinenoexcept

Definition at line 591 of file catch.hpp.

                                            {
            return m_size == 0;
        }

numberOfCharacters() [1/2]

auto Catch::StringRef::numberOfCharacters ( ) const -> size_type

noexcept

Definition at line 84 of file catch_stringref.cpp.

                                                                   {
        size_type noChars = m_size;
        // Make adjustments for uft encodings
        for( size_type i=0; i < m_size; ++i ) {
            char c = m_start[i];
            if( ( c & byte_2_lead ) == byte_2_lead ) {
                noChars--;
                if (( c & byte_3_lead ) == byte_3_lead )
                    noChars--;
                if( ( c & byte_4_lead ) == byte_4_lead )
                    noChars--;
            }
        }
        return noChars;
    }

numberOfCharacters() [2/2]

auto Catch::StringRef::numberOfCharacters ( ) const -> size_type

noexcept

operator std::string() [1/2]

Catch::StringRef::operator std::string

(

)

const

Definition at line 31 of file catch_stringref.cpp.

                                        {
        return std::string( m_start, m_size );
    }

operator std::string() [2/2]

Catch::StringRef::operator std::string

(

)

const

operator!=() [1/2]

auto Catch::StringRef::operator!= ( StringRef const & other ) const -> bool

noexcept

Definition at line 76 of file catch_stringref.cpp.

                                                                                {
        return !operator==( other );
    }

Here is the call graph for this function:

operator!=() [2/2]

auto Catch::StringRef::operator!= ( StringRef const & other ) const -> bool

noexcept

operator=() [1/2]

auto Catch::StringRef::operator= ( StringRef const & other ) -> StringRef&

inlinenoexcept

Definition at line 73 of file catch_stringref.h.

                                                                          {
            delete[] m_data;
            m_data = nullptr;
            m_start = other.m_start;
            m_size = other.m_size;
            return *this;
        }

operator=() [2/2]

auto Catch::StringRef::operator= ( StringRef const & other ) -> StringRef&

inlinenoexcept

Definition at line 572 of file catch.hpp.

                                                                          {
            delete[] m_data;
            m_data = nullptr;
            m_start = other.m_start;
            m_size = other.m_size;
            return *this;
        }

operator==() [1/2]

auto Catch::StringRef::operator== ( StringRef const & other ) const -> bool

noexcept

Definition at line 71 of file catch_stringref.cpp.

                                                                                {
        return
            size() == other.size() &&
            (std::strncmp( m_start, other.m_start, size() ) == 0);
    }

operator==() [2/2]

auto Catch::StringRef::operator== ( StringRef const & other ) const -> bool

noexcept

operator[]() [1/2]

auto Catch::StringRef::operator[] ( size_type index ) const -> char

noexcept

Definition at line 80 of file catch_stringref.cpp.

                                                                     {
        return m_start[index];
    }

operator[]() [2/2]

auto Catch::StringRef::operator[] ( size_type index ) const -> char

noexcept

size() [1/2]

auto Catch::StringRef::size ( ) const -> size_type

inlinenoexcept

Definition at line 95 of file catch_stringref.h.

                                                {
            return m_size;
        }

Here is the caller graph for this function:

size() [2/2]

auto Catch::StringRef::size ( ) const -> size_type

inlinenoexcept

Definition at line 594 of file catch.hpp.

                                                {
            return m_size;
        }

substr() [1/2]

auto Catch::StringRef::substr ( size_type start, size_type size ) const -> StringRef

noexcept

Definition at line 65 of file catch_stringref.cpp.

                                                                                        {
        if( start < m_size )
            return StringRef( m_start+start, size );
        else
            return StringRef();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

substr() [2/2]

auto Catch::StringRef::substr ( size_type start, size_type size ) const -> StringRef

noexcept

swap() [1/2]

void Catch::StringRef::swap ( StringRef & other )

noexcept

Definition at line 35 of file catch_stringref.cpp.

                                                    {
        std::swap( m_start, other.m_start );
        std::swap( m_size, other.m_size );
        std::swap( m_data, other.m_data );
    }

Here is the call graph for this function:

swap() [2/2]

void Catch::StringRef::swap ( StringRef & other )

noexcept

Friends And Related Symbol Documentation

StringRefTestAccess

StringRefTestAccess

friend

Definition at line 28 of file catch_stringref.h.

---

The documentation for this class was generated from the following files:

• libraries/sys-vm/external/Catch2/include/internal/catch_stringref.h
• libraries/sys-vm/external/Catch2/single_include/catch2/catch.hpp
• libraries/sys-vm/external/Catch2/include/internal/catch_stringref.cpp