sgsString [class]

class sgsString

This is the string interface and handling class.

Variables

• sgs_iStr* str - the string data pointer
• SGS_CTX (sgs_Context* C) - associated context

Constructors

• sgsString() - initializes a NULL handle
• sgsString( const sgsString& h ) - initializes a handle from another handle
• sgsString( sgs_Context* c, sgs_iStr* s ) - initializes a handle from string data pointer
• sgsString( sgs_Context* c, sgs_StkIdx item ) - initializes a handle from stack index if it has the right interface, otherwise handle is initialized to NULL
• sgsString( sgs_Context* c, sgs_Variable* var ) - initializes a handle from variable pointer if it has the right interface, otherwise handle is initialized to NULL
• sgsString( sgs_Context* c, const char* s, size_t sz ) - creates a new string buffer and sets the handle to it
• sgsString( sgs_Context* c, const char* s ) - creates a new 0-terminated string and sets the handle to it

Methods

• const char* c_str() - returns C string pointer or NULL for NULL handles
• size_t size() - returns string buffer size or 0 for NULL handles
• bool get_string( std::string& out ) - creates a std::string for valid handles, returns if handle is valid (available only with SGS_CPPBC_WITH_STD_STRING defined)
• int compare( const sgsString& s ) const - compare this string with another one (strcmp return rules)
• bool same_as( const sgsString& s ) const - returns if this string is exactly the same as the other string
• bool equals( const char* s ) const - returns if the specified C string is equal to this string
• bool equals( const char* s, size_t sz ) const - returns if the specified buffer is equal to this string
• void push( sgs_Context* c = NULL ) const - push the handle on the stack as string/null
• bool not_null() - returns if string handle points to a string
• sgsVariable get_variable() - returns this string as sgsVariable
• void _acquire() - increment reference count on variable
• void _release() - decrement reference count on variable, remove it from the class

Operators

• const sgsString& operator = ( const sgsString& h ) - string assignment
• bool operator <, bool operator ==, bool operator != - comparison operators