gimbal::String Class Reference

Inheritance 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))
	String (const char *pCStr, Context *pCtx=nullptr, Size size=sizeof(String))
	String (const std::string_view &stringView, Context *pCtx=nullptr, Size size=sizeof(String))
	String (const String &rhs, Context *pCtx=nullptr, Size size=sizeof(String))
	String (StringView other, Context *pCtx=nullptr, Size size=sizeof(String))
	String (String &&rhs, Context *pCtx=nullptr, Size size=sizeof(String))
	String (GblStringBuffer &&rhs, Context *pCtx=nullptr, Size size=sizeof(String))
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)
const String &	operator= (const char *pCStr)
const String &	operator= (std::nullptr_t)
const String &	operator= (String &&rhs)
const String &	operator= (GblStringBuffer &&rhs)
const String &	operator+= (std::string_view view)
const String &	operator+= (StringView view)
void	reserve (Size capacity)
void	resize (Size size)
void	insert (const_iterator pos, const char *pString, GblSize count=0)
void	concat (std::string_view view)
String &	vasprintf (const char *pFmt, va_list varArgs)
String &	sprintf (const char *pFmt,...)
template<typename... Args>
String &	varArgs (Args &&... args)
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

Static Public Member Functions
static std::pair< char *, Size >	take (GblStringBuffer *pGblStr)

Friends
std::istream &	operator>> (std::istream &input, String &s)
void	swap (String &lhs, String &rhs)

Additional Inherited Members
Public Types inherited from gimbal::StringViewBase< String >
using	StringViewType = StringViewBase< String >
using	Derived = String
using	Iterable = RandomAccessIterable< StringViewType, size_t, char >
using	iterator = typename Iterable::iterator
using	const_iterator = typename Iterable::const_iterator
Data Fields inherited from GblStringBuffer
GblArrayList	data
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)
const 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/9]

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/9]

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/9]

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) {}

String() [4/9]

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

inline

Definition at line 216 of file gimbal_string.hpp.

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

String() [5/9]

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

inline

Definition at line 219 of file gimbal_string.hpp.

                                                                                              {
        Exception::checkThrow(GblStringBuffer_construct(this,
                                            GBL_STRING_VIEW(stringView.data(), stringView.length()),
                                            size,
                                            pCtx));
    }

String() [6/9]

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

inline

Definition at line 227 of file gimbal_string.hpp.

                                                                              :
        String(StringView(rhs), pCtx, size) {}

String() [7/9]

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

inline

Definition at line 230 of file gimbal_string.hpp.

                                                                             :
        String(other.toStringView(), pCtx? pCtx : other.getContext(), size) {}

String() [8/9]

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

inline

Definition at line 234 of file gimbal_string.hpp.

                                                                         :
        String(static_cast<GblStringBuffer&&>(rhs), pCtx, size) {}

String() [9/9]

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

inline

Definition at line 237 of file gimbal_string.hpp.

                                                                                  :
        String(pCtx, size)
    {
        *this = rhs;
    }

~String()

gimbal::String::~String ( void  )

inline

Definition at line 243 of file gimbal_string.hpp.

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

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]

static std::pair< char *, Size > gimbal::String::take ( GblStringBuffer *  pGblStr )

inlinestatic

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/8]

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/8]

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

inline

Definition at line 271 of file gimbal_string.hpp.

                                               {
        return *this = StringView(rhs);
    }

operator=() [3/8]

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

inline

Definition at line 275 of file gimbal_string.hpp.

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

operator=() [4/8]

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

inline

Definition at line 279 of file gimbal_string.hpp.

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

operator=() [5/8]

const String & gimbal::String::operator= ( const char *  pCStr )

inline

Definition at line 289 of file gimbal_string.hpp.

                                               {
        if(pCStr) return *this = std::string_view(pCStr);
        else return *this = nullptr;
    }

operator=() [6/8]

const String & gimbal::String::operator= ( std::nullptr_t  )

inline

Definition at line 294 of file gimbal_string.hpp.

                                          {
        clear();
        return *this;
    }

operator=() [7/8]

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

inline

Definition at line 299 of file gimbal_string.hpp.

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

operator=() [8/8]

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

inline

Definition at line 303 of file gimbal_string.hpp.

                                                   {
        StringView rhsView(rhs);
 
        if(getContext() == rhsView.getContext() && rhsView.isHeap()) {
            give(take(&rhs));
        } else { //cannot move construct!
            *this = rhsView.toStringView();
        }
 
        return *this;
    }

operator+=() [1/2]

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

inline

Definition at line 315 of file gimbal_string.hpp.

                                                  {
        concat(view);
        return *this;
    }

operator+=() [2/2]

const String & gimbal::String::operator+= ( StringView  view )

inline

Definition at line 320 of file gimbal_string.hpp.

                                              {
        return *this += view.toStringView();
    }

reserve()

void gimbal::String::reserve ( Size  capacity )

inline

Definition at line 324 of file gimbal_string.hpp.

                                {
        Exception::checkThrow(GblStringBuffer_reserve(this, capacity));
    }

resize()

void gimbal::String::resize ( Size  size )

inline

Definition at line 328 of file gimbal_string.hpp.

                           {
        Exception::checkThrow(GblStringBuffer_resize(this, size));
    }

insert()

void gimbal::String::insert ( const_iterator  pos, const char *  pString, GblSize  count = 0  )

inline

Definition at line 332 of file gimbal_string.hpp.

                                                                          {
        GBL_ASSERT(pString);
        const auto index = std::distance(cbegin(), pos);
        Exception::checkThrow(GblStringBuffer_insert(this, index, GBL_STRING_VIEW(pString, count)));
      //  return iterator(*this, index);
    }

concat()

void gimbal::String::concat ( std::string_view  view )

inline

Definition at line 339 of file gimbal_string.hpp.

                                     {
        //insert(cend(), view.data(), view.size());
        Exception::checkThrow(GblArrayList_append(&this->data, view.data(), view.size()));
    }

vasprintf()

String & gimbal::String::vasprintf ( const char *  pFmt, va_list  varArgs  )

inline

Definition at line 344 of file gimbal_string.hpp.

                                                         {
        Exception::checkThrow(GblStringBuffer_appendVPrintf(this, pFmt, varArgs));
        return *this;
    }

sprintf()

String & gimbal::String::sprintf ( const char *  pFmt,   ...  )

inline

Definition at line 350 of file gimbal_string.hpp.

                                           {
        va_list varArgs;
        va_start(varArgs, pFmt);
        vasprintf(pFmt, varArgs);
        va_end(varArgs);
        return *this;
    }

varArgs()

template<typename... Args>

String & gimbal::String::varArgs ( Args &&...  args )

inline

Definition at line 360 of file gimbal_string.hpp.

                                    {
        String temp("", getContext());
        temp.sprintf(getCString(), std::forward<Args>(args)...);
        *this = temp;
        return *this;
    }

Friends And Related Symbol Documentation

operator>>

std::istream & operator>> ( std::istream &  input, String &  s  )

friend

Definition at line 368 of file gimbal_string.hpp.

                                                                {
        std::string line;
        // Still failes gracefully, so whatever...
        //if(input.good()) {
        //    input.clear();
               std::getline(input, line);
        //     if(input.fail()) {
        //         Exception::checkThrow(Result::FileRead);
        //     }
            s = line;
        //}
        return input;
    }

swap

void swap ( String &  lhs, String &  rhs  )

friend

Definition at line 382 of file gimbal_string.hpp.

                                               {
        void* pTemp = GBL_ALLOCA(sizeof(String));
        memcpy(pTemp, &lhs, sizeof(String));
        memcpy(&lhs, &rhs, sizeof(String));
        memcpy(&rhs, pTemp, sizeof(String));
    }

---

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

• gimbal_string.hpp