gimbal::String Class Reference

Inheritance diagram for gimbal::String:

Collaboration diagram for gimbal::String:

Public Member Functions
const GblStringBuffer *	getString_ (void) const
GblStringBuffer *	getString_ (void)
	String (std::nullptr_t, Size size=sizeof(String))
	String (Context *pCtx=nullptr, Size size=sizeof(String))
	String (const std::string &stdString, Context *pCtx=nullptr, Size size=sizeof(String))
	GBL_PMR_STRING_ONLY_ (String(const std::pmr::string &stdPmrString, Context *pCtx=nullptr, Size size=sizeof(String)):String(std::string_view{stdPmrString.c_str()}, pCtx, size) {}) String(const char *pCStr
Context Size Size	take (GblStringBuffer *pGblStr)
auto	take (void)
void	give (std::pair< char *, Size > data)
void	clear (void)
const String &	operator= (std::string_view view)
const String &	operator= (const String &rhs)
const String &	operator= (StringView string)
const String &	operator= (const std::string &stdString)
Public Member Functions inherited from gimbal::StringViewBase< String >
	operator const GblStringBuffer * () const
const char &	getElement_ (size_t index) const
char &	getElement_ (size_t index)
void	setElement_ (size_t index, char value)
size_t	getElementCount_ (void) const
Size	getStackBytes (void) const
constexpr Size	getLength (void) const
constexpr Size	getCapacity (void) const
Context *	getContext (void) const
constexpr bool	isEmpty (void) const
constexpr bool	isStack (void) const
constexpr bool	isHeap (void) const
const char *	getCString (void) const
char *	getCString (void)
std::string	toStdString (void) const
constexpr std::string_view	toStringView (void) const

Data Fields
Context *	pCtx
Context Size	size
Data Fields inherited from GblStringBuffer
GblArrayList	data

Additional Inherited Members
Public Types inherited from gimbal::StringViewBase< String >
using	StringViewType
using	Derived
using	Iterable
using	iterator
using	const_iterator
Protected Member Functions inherited from gimbal::StringViewBase< String >
decltype(auto)	str_ (void) const
decltype(auto)	str_ (void)
Related Symbols inherited from GblStringBuffer
GBL_RESULT	GblStringBuffer_construct (GblStringBuffer *pSelf, const char *pString, size_t length, size_t structSize, GblContext *pCtx)
GBL_RESULT	GblStringBuffer_destruct (GblStringBuffer *pSelf)
GBL_RESULT	GblStringBuffer_acquire (GblStringBuffer *pSelf, char *pData, size_t capacity)
GBL_RESULT	GblStringBuffer_release (GblStringBuffer *pSelf, char **ppStrPtr, size_t *pCapacity)
char *	GblStringBuffer_data (GblStringBuffer *pSelf)
size_t	GblStringBuffer_length (const GblStringBuffer *pSelf)
size_t	GblStringBuffer_capacity (const GblStringBuffer *pSelf)
size_t	GblStringBuffer_stackBytes (const GblStringBuffer *pSelf)
char *	GblStringBuffer_stackBuffer (const GblStringBuffer *pSelf)
GblContext *	GblStringBuffer_context (const GblStringBuffer *pSelf)
GblBool	GblStringBuffer_empty (const GblStringBuffer *pSelf)
GblBool	GblStringBuffer_valid (const GblStringBuffer *pSelf)
GblBool	GblStringBuffer_blank (const GblStringBuffer *pSelf)
GblBool	GblStringBuffer_stack (const GblStringBuffer *pSelf)
GblStringRef *	GblStringBuffer_createRef (const GblStringBuffer *pSelf)
const char *	GblStringBuffer_cString (const GblStringBuffer *pSelf)
const char *	GblStringBuffer_intern (const GblStringBuffer *pSelf)
GblQuark	GblStringBuffer_quark (const GblStringBuffer *pSelf)
GblQuark	GblStringBuffer_tryQuark (const GblStringBuffer *pSelf)
GblStringView	GblStringBuffer_view (const GblStringBuffer *pSelf, size_t offset, size_t len)
char	GblStringBuffer_at (const GblStringBuffer *pSelf, size_t index)
GBL_RESULT	GblStringBuffer_setChar (const GblStringBuffer *pSelf, size_t index, char value)
const char *	GblStringBuffer_set (GblStringBuffer *pSelf, const char *pStr, size_t len)
const char *	GblStringBuffer_printf (GblStringBuffer *pSelf, const char *pFmt,...)
const char *	GblStringBuffer_vPrintf (GblStringBuffer *pSelf, const char *pFmt, va_list varArgs)
GBL_RESULT	GblStringBuffer_prepend (GblStringBuffer *pSelf, const char *pStr, size_t len)
GBL_RESULT	GblStringBuffer_prependPadding (GblStringBuffer *pSelf, char value, size_t count)
GBL_RESULT	GblStringBuffer_append (GblStringBuffer *pSelf, const char *pStr, size_t len)
GBL_RESULT	GblStringBuffer_appendPrintf (GblStringBuffer *pSelf, const char *pFmt,...)
GBL_RESULT	GblStringBuffer_appendVPrintf (GblStringBuffer *pSelf, const char *pFmt, va_list varArgs)
GBL_RESULT	GblStringBuffer_appendPadding (GblStringBuffer *pSelf, char value, size_t count)
GBL_RESULT	GblStringBuffer_appendNil (GblStringBuffer *pSelf)
GBL_RESULT	GblStringBuffer_appendBool (GblStringBuffer *pSelf, GblBool value)
GBL_RESULT	GblStringBuffer_appendInt (GblStringBuffer *pSelf, int value)
GBL_RESULT	GblStringBuffer_appendUint (GblStringBuffer *pSelf, unsigned value)
GBL_RESULT	GblStringBuffer_appendFloat (GblStringBuffer *pSelf, float value)
GBL_RESULT	GblStringBuffer_appendDouble (GblStringBuffer *pSelf, double value)
GBL_RESULT	GblStringBuffer_appendPointer (GblStringBuffer *pSelf, const void *pPtr)
GBL_RESULT	GblStringBuffer_insert (GblStringBuffer *pSelf, size_t index, const char *pString, size_t length)
GBL_RESULT	GblStringBuffer_overwrite (GblStringBuffer *pSelf, size_t index, const char *pString, size_t length)
size_t	GblStringBuffer_replace (GblStringBuffer *pSelf, const char *pSubstr, const char *pReplacement, size_t limit, size_t substrLen, size_t replLen)
GBL_RESULT	GblStringBuffer_erase (GblStringBuffer *pSelf, size_t offset, size_t len)
GBL_RESULT	GblStringBuffer_clear (GblStringBuffer *pSelf)
size_t	GblStringBuffer_remove (GblStringBuffer *pSelf, const char *pStr, size_t len)
GBL_RESULT	GblStringBuffer_chop (GblStringBuffer *pSelf)
GBL_RESULT	GblStringBuffer_chomp (GblStringBuffer *pSelf)
GBL_RESULT	GblStringBuffer_trimStart (GblStringBuffer *pSelf, char value)
GBL_RESULT	GblStringBuffer_trimEnd (GblStringBuffer *pSelf, char value)
GBL_RESULT	GblStringBuffer_lower (GblStringBuffer *pSelf)
GBL_RESULT	GblStringBuffer_upper (GblStringBuffer *pSelf)
GBL_RESULT	GblStringBuffer_reverse (GblStringBuffer *pSelf)
GBL_RESULT	GblStringBuffer_reserve (GblStringBuffer *pSelf, size_t capacity)
GBL_RESULT	GblStringBuffer_resize (GblStringBuffer *pSelf, size_t size)
GBL_RESULT	GblStringBuffer_grow (GblStringBuffer *pSelf, size_t delta)
GBL_RESULT	GblStringBuffer_shrink (GblStringBuffer *pSelf, size_t delta)
GBL_RESULT	GblStringBuffer_shrinkToFit (GblStringBuffer *pSelf)

Detailed Description

Definition at line 184 of file gimbal_string.hpp.

Constructor & Destructor Documentation

String() [1/3]

gimbal::String::String ( std::nullptr_t , Size size = sizeof(String) )

inline

Definition at line 201 of file gimbal_string.hpp.

                                                  :
        String(static_cast<Context*>(nullptr), size) {}

String() [2/3]

gimbal::String::String ( Context * pCtx = nullptr, Size size = sizeof(String) )

inline

Definition at line 204 of file gimbal_string.hpp.

                                                           :
        String(std::string_view{}, pCtx, size) {}

String() [3/3]

gimbal::String::String ( const std::string & stdString, Context * pCtx = nullptr, Size size = sizeof(String) )

inline

Definition at line 208 of file gimbal_string.hpp.

                                                                                       :
        String(std::string_view{stdString.c_str()}, pCtx, size) {}

Member Function Documentation

getString_() [1/2]

const GblStringBuffer * gimbal::String::getString_ ( void ) const

inline

Definition at line 190 of file gimbal_string.hpp.

                                                  {
        return static_cast<const GblStringBuffer*>(this);
    }

getString_() [2/2]

GblStringBuffer * gimbal::String::getString_ ( void )

inline

Definition at line 194 of file gimbal_string.hpp.

                                      {
        return static_cast<GblStringBuffer*>(this);
    }

take() [1/2]

Context Size Size gimbal::String::take ( GblStringBuffer * pGblStr )

inline

Definition at line 247 of file gimbal_string.hpp.

                                                               {
        char* pCStr = nullptr;
        Size capacity = 0;
        Exception::checkThrow(GblStringBuffer_release(pGblStr, &pCStr, &capacity));
        return { pCStr, capacity };
    }

take() [2/2]

auto gimbal::String::take ( void )

inline

Definition at line 254 of file gimbal_string.hpp.

                    {
        return take(this);
    }

give()

void gimbal::String::give ( std::pair< char *, Size > data )

inline

Definition at line 258 of file gimbal_string.hpp.

                                         {
        Exception::checkThrow(GblStringBuffer_acquire(this, data.first, data.second));
    }

clear()

void gimbal::String::clear ( void )

inline

Definition at line 262 of file gimbal_string.hpp.

                     {
        Exception::checkThrow(GblStringBuffer_clear(this));
    }

operator=() [1/4]

const String & gimbal::String::operator= ( std::string_view view )

inline

Definition at line 266 of file gimbal_string.hpp.

                                                 {
        Exception::checkThrow(GblStringBuffer_set(this, GBL_STRING_VIEW(view.data(), view.size())));
        return *this;
    }

operator=() [2/4]

const String & gimbal::String::operator= ( const String & rhs )

inline

Definition at line 271 of file gimbal_string.hpp.

                                               {
        return *this = StringView(rhs);
    }

operator=() [3/4]

const String & gimbal::String::operator= ( StringView string )

inline

Definition at line 275 of file gimbal_string.hpp.

                                               {
        return *this = string.toStringView();
    }

operator=() [4/4]

const String & gimbal::String::operator= ( const std::string & stdString )

inline

Definition at line 279 of file gimbal_string.hpp.

                                                        {
        return *this = stdString.c_str();
    }

Field Documentation

pCtx

Context* gimbal::String::pCtx

Definition at line 216 of file gimbal_string.hpp.

size

Context Size gimbal::String::size

Definition at line 216 of file gimbal_string.hpp.

                                                                              :
        String(pCStr? std::string_view{pCStr} : std::string_view{}, pCtx, size) {}
 
    String(const std::string_view& stringView, Context* pCtx=nullptr, Size size=sizeof(String)) {
        Exception::checkThrow(GblStringBuffer_construct(this,
                                            GBL_STRING_VIEW(stringView.data(), stringView.length()),
                                            size,
                                            pCtx));
    }
 
    // Copy Ctor
    String(const String& rhs, Context* pCtx=nullptr, Size size=sizeof(String)):
        String(StringView(rhs), pCtx, size) {}
 
    String(StringView other, Context* pCtx=nullptr, Size size=sizeof(String)):
        String(other.toStringView(), pCtx? pCtx : other.getContext(), size) {}
 
    // Move Ctor
    String(String&& rhs, Context* pCtx=nullptr, Size size=sizeof(String)):
        String(static_cast<GblStringBuffer&&>(rhs), pCtx, size) {}
 
    String(GblStringBuffer&& rhs, Context* pCtx=nullptr, Size size=sizeof(String)):
        String(pCtx, size)
    {
        *this = rhs;
    }
 
    ~String(void) {
        Exception::checkThrow(GblStringBuffer_destruct(this));
    }

---

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

• gimbal_string.hpp