gbl::Quark Class Reference

#include <gimbal_quark.hpp>

Public Member Functions
	Quark (GblQuark cQuark)
	Quark (const char *pString, std::size_t length=0)
	Quark (const std::string &stdStr)
	Quark (std::string_view strv)
bool	isValid (void) const
const char *	toString (void) const
std::size_t	length (void) const
	operator GblQuark (void) const
char	operator[] (std::size_t index) const
Quark &	operator= (const Quark &rhs)=default
Quark &	operator= (GblQuark cQuark)
Quark &	operator= (const char *pString)
Quark &	operator= (const std::string &stdStr)
Quark &	operator= (std::string_view strv)

Static Public Member Functions
static Quark	fromString (const char *pString, std::size_t length=0)
static Quark	fromString (const std::string &stdStr)
static Quark	fromString (std::string_view strv)
static Quark	fromStatic (const char *pString)
static const char *	internString (const char *pString, std::size_t length=0)
static const char *	internStatic (const char *pString)

Static Public Attributes
static GblQuark	Invalid

Friends
std::ostream &	operator<< (std::ostream &os, Quark quark)

Detailed Description

OO C++ wrapper object around GblQuark.

gbl::Quark is the high-level C++ wrapper around GblQuark, which represents an interned string.

See also

GblQuark

Definition at line 33 of file gimbal_quark.hpp.

Constructor & Destructor Documentation

Quark() [1/4]

gbl::Quark::Quark ( GblQuark  cQuark )

inline

Definition at line 41 of file gimbal_quark.hpp.

                          :
        value_(cQuark) {}

Quark() [2/4]

gbl::Quark::Quark ( const char *  pString, std::size_t  length = 0  )

inline

Definition at line 44 of file gimbal_quark.hpp.

                                                  :
        Quark(GblQuark_tryString(pString, length)) {}

Quark() [3/4]

gbl::Quark::Quark ( const std::string &  stdStr )

inline

Definition at line 47 of file gimbal_quark.hpp.

                                  :
        Quark(stdStr.c_str()) {}

Quark() [4/4]

gbl::Quark::Quark ( std::string_view  strv )

inline

Definition at line 50 of file gimbal_quark.hpp.

                              :
        Quark(strv.data(), strv.length()) {}

Member Function Documentation

isValid()

bool gbl::Quark::isValid ( void  ) const

inline

Definition at line 53 of file gimbal_quark.hpp.

                             {
        return value_ != GBL_QUARK_INVALID;
    }

toString()

const char * gbl::Quark::toString ( void  ) const

inline

Definition at line 57 of file gimbal_quark.hpp.

                                     {
        return GblQuark_toString(value_);
    }

length()

std::size_t gbl::Quark::length ( void  ) const

inline

Definition at line 61 of file gimbal_quark.hpp.

                                 {
        return isValid()?
                    strlen(GblQuark_toString(value_)) :
                    0;
    }

operator GblQuark()

gbl::Quark::operator GblQuark ( void  ) const

inline

Definition at line 67 of file gimbal_quark.hpp.

                                  {
        return value_;
    }

operator[]()

char gbl::Quark::operator[] ( std::size_t  index ) const

inline

Definition at line 71 of file gimbal_quark.hpp.

                                           {
        if(index >= length())
            throw std::out_of_range("Out-of-range GblQuark access!");
 
        return toString()[index];
    }

operator=() [1/4]

Quark & gbl::Quark::operator= ( GblQuark  cQuark )

inline

Definition at line 80 of file gimbal_quark.hpp.

                                      {
        value_ = cQuark;
        return *this;
    }

operator=() [2/4]

Quark & gbl::Quark::operator= ( const char *  pString )

inline

Definition at line 85 of file gimbal_quark.hpp.

                                          {
        value_ = GblQuark_tryString(pString);
        return *this;
    }

operator=() [3/4]

Quark & gbl::Quark::operator= ( const std::string &  stdStr )

inline

Definition at line 90 of file gimbal_quark.hpp.

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

operator=() [4/4]

Quark & gbl::Quark::operator= ( std::string_view  strv )

inline

Definition at line 94 of file gimbal_quark.hpp.

                                          {
        value_ = GblQuark_tryString(strv.data(), strv.length());
        return *this;
    }

fromString() [1/3]

static Quark gbl::Quark::fromString ( const char *  pString, std::size_t  length = 0  )

inlinestatic

Definition at line 101 of file gimbal_quark.hpp.

                                                                     {
        return GblQuark_fromString(pString, length);
    }

fromString() [2/3]

static Quark gbl::Quark::fromString ( const std::string &  stdStr )

inlinestatic

Definition at line 105 of file gimbal_quark.hpp.

                                                     {
        return fromString(stdStr.c_str());
    }

fromString() [3/3]

static Quark gbl::Quark::fromString ( std::string_view  strv )

inlinestatic

Definition at line 109 of file gimbal_quark.hpp.

                                                 {
        return fromString(strv.data(), strv.length());
    }

fromStatic()

static Quark gbl::Quark::fromStatic ( const char *  pString )

inlinestatic

Definition at line 113 of file gimbal_quark.hpp.

                                                 {
        return GblQuark_fromStatic(pString);
    }

internString()

static const char * gbl::Quark::internString ( const char *  pString, std::size_t  length = 0  )

inlinestatic

Definition at line 117 of file gimbal_quark.hpp.

                                                                             {
        return GblQuark_internString(pString, length);
    }

internStatic()

static const char * gbl::Quark::internStatic ( const char *  pString )

inlinestatic

Definition at line 121 of file gimbal_quark.hpp.

                                                         {
        return GblQuark_internStatic(pString);
    }

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream &  os, Quark  quark  )

friend

Definition at line 125 of file gimbal_quark.hpp.

                                                               {
        os << quark.toString();
        return os;
    }

Field Documentation

Invalid

GblQuark gbl::Quark::Invalid

inlinestatic

Definition at line 99 of file gimbal_quark.hpp.

---

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

• gimbal_quark.hpp