Yate
Public Member Functions | Protected Member Functions | List of all members
NamedPointer Class Reference

A named pointer class. More...

#include <yateclass.h>

Inheritance diagram for NamedPointer:
NamedString String GenObject

Public Member Functions

 NamedPointer (const char *name, GenObject *data=0, const char *value=0)
 
virtual ~NamedPointer ()
 
GenObject * userData () const
 
GenObject * takeData ()
 
void userData (GenObject *data)
 
void * userObject (const String &name) const
 
NamedPointer & operator= (const char *value)
 
virtual void * getObject (const String &name) const
 
- Public Member Functions inherited from NamedString
 NamedString (const char *name, const char *value=0)
 
const String & name () const
 
virtual const String & toString () const
 
NamedString & operator= (const char *value)
 
- Public Member Functions inherited from String
 String ()
 
 String (const char *value, int len=-1)
 
 String (char value, unsigned int repeat=1)
 
 String (int32_t value)
 
 String (uint32_t value)
 
 String (int64_t value)
 
 String (uint64_t value)
 
 String (bool value)
 
 String (double value)
 
 String (const String &value)
 
 String (const String *value)
 
virtual ~String ()
 
const char * c_str () const
 
const char * safe () const
 
const char * safe (const char *defStr) const
 
unsigned int length () const
 
bool null () const
 
int lenUtf8 (uint32_t maxChar=0x10ffff, bool overlong=false) const
 
int fixUtf8 (const char *replace=0, uint32_t maxChar=0x10ffff, bool overlong=false)
 
bool checkBOM () const
 
bool stripBOM ()
 
unsigned int hash () const
 
void clear ()
 
char at (int index) const
 
String substr (int offs, int len=-1) const
 
String & trimBlanks ()
 
String & trimSpaces ()
 
int toInteger (int defvalue=0, int base=0, int minvalue=INT_MIN, int maxvalue=INT_MAX, bool clamp=true) const
 
int toInteger (const TokenDict *tokens, int defvalue=0, int base=0) const
 
long int toLong (long int defvalue=0, int base=0, long int minvalue=LONG_MIN, long int maxvalue=LONG_MAX, bool clamp=true) const
 
int64_t toInt64 (int64_t defvalue=0, int base=0, int64_t minvalue=LLONG_MIN, int64_t maxvalue=LLONG_MAX, bool clamp=true) const
 
double toDouble (double defvalue=0.0) const
 
bool toBoolean (bool defvalue=false) const
 
bool isBoolean () const
 
String & toUpper ()
 
String & toLower ()
 
char operator[] (signed int index) const
 
char operator[] (unsigned int index) const
 
 operator const char * () const
 
String & assign (const char *value, int len=-1)
 
String & assign (char value, unsigned int repeat=1)
 
String & hexify (void *data, unsigned int len, char sep=0, bool upCase=false)
 
String & operator= (const String &value)
 
String & operator= (const String *value)
 
String & operator= (const char *value)
 
String & operator= (char value)
 
String & operator= (int32_t value)
 
String & operator= (uint32_t value)
 
String & operator= (int64_t value)
 
String & operator= (uint64_t value)
 
String & operator= (bool value)
 
String & operator= (double value)
 
String & operator+= (const char *value)
 
String & operator+= (char value)
 
String & operator+= (int32_t value)
 
String & operator+= (uint32_t value)
 
String & operator+= (int64_t value)
 
String & operator+= (uint64_t value)
 
String & operator+= (bool value)
 
String & operator+= (double value)
 
bool operator== (const char *value) const
 
bool operator!= (const char *value) const
 
bool operator== (const String &value) const
 
bool operator!= (const String &value) const
 
bool operator&= (const char *value) const
 
bool operator|= (const char *value) const
 
String & operator<< (const char *value)
 
String & operator<< (char value)
 
String & operator<< (int32_t value)
 
String & operator<< (uint32_t value)
 
String & operator<< (int64_t value)
 
String & operator<< (uint64_t value)
 
String & operator<< (bool value)
 
String & operator<< (double value)
 
String & operator>> (const char *skip)
 
String & operator>> (char &store)
 
String & operator>> (UChar &store)
 
String & operator>> (int &store)
 
String & operator>> (unsigned int &store)
 
String & operator>> (bool &store)
 
String & append (const char *value, int len)
 
String & append (const char *value, const char *separator=0, bool force=false)
 
String & append (const ObjList *list, const char *separator=0, bool force=false)
 
String & append (const ObjList &list, const char *separator=0, bool force=false)
 
String & append (double value, unsigned int decimals=3)
 
String & printf (const char *format,...)
 
String & printf (unsigned int length, const char *format,...)
 
String & appendFixed (unsigned int fixedLength, const char *str, unsigned int len=-1, char fill= ' ', int align=Left)
 
String & appendFixed (unsigned int fixedLength, const String &str, char fill= ' ', int align=Left)
 
int find (char what, unsigned int offs=0) const
 
int find (const char *what, unsigned int offs=0) const
 
int rfind (char what) const
 
int rfind (const char *what) const
 
bool startsWith (const char *what, bool wordBreak=false, bool caseInsensitive=false) const
 
bool endsWith (const char *what, bool wordBreak=false, bool caseInsensitive=false) const
 
bool startSkip (const char *what, bool wordBreak=true, bool caseInsensitive=false)
 
String & extractTo (const char *sep, String &store)
 
String & extractTo (const char *sep, bool &store)
 
String & extractTo (const char *sep, int &store, int base=0)
 
String & extractTo (const char *sep, int &store, const TokenDict *tokens, int base=0)
 
String & extractTo (const char *sep, double &store)
 
virtual bool matches (const String &value) const
 
bool matches (const Regexp &rexp)
 
int matchOffset (int index=0) const
 
int matchLength (int index=0) const
 
String matchString (int index=0) const
 
String replaceMatches (const String &templ) const
 
int matchCount () const
 
ObjList * split (char separator, bool emptyOK=true) const
 
String msgEscape (char extraEsc=0) const
 
String msgUnescape (int *errptr=0, char extraEsc=0) const
 
String sqlEscape (char extraEsc=0) const
 
String uriEscape (char extraEsc=0, const char *noEsc=0) const
 
String uriUnescape (int *errptr=0) const
 
- Public Member Functions inherited from GenObject
 GenObject ()
 
virtual ~GenObject ()
 
virtual bool alive () const
 
virtual void destruct ()
 
NamedCounter * getObjCounter () const
 
NamedCounter * setObjCounter (NamedCounter *counter)
 

Protected Member Functions

virtual void changed ()
 

Additional Inherited Members

- Public Types inherited from String
enum  Align { Left = 0, Center, Right }
 
- Static Public Member Functions inherited from String
static const String & empty ()
 
static const char * boolText (bool value)
 
static int lenUtf8 (const char *value, uint32_t maxChar=0x10ffff, bool overlong=false)
 
static bool checkBOM (const char *str)
 
static bool stripBOM (const char *&str)
 
static bool stripBOM (char *&str)
 
static unsigned int hash (const char *value, unsigned int h=0)
 
static String msgEscape (const char *str, char extraEsc=0)
 
static String msgUnescape (const char *str, int *errptr=0, char extraEsc=0)
 
static String sqlEscape (const char *str, char extraEsc=0)
 
static String uriEscape (const char *str, char extraEsc=0, const char *noEsc=0)
 
static String uriEscape (const char *str, const char *extraEsc, const char *noEsc=0)
 
static String uriUnescape (const char *str, int *errptr=0)
 
static const String * atom (const String *&str, const char *val)
 
- Static Public Member Functions inherited from GenObject
static void * getObject (const String &name, const GenObject *obj)
 
static bool getObjCounting ()
 
static void setObjCounting (bool enable)
 
static NamedCounter * getObjCounter (const String &name, bool create=true)
 
static ObjList & getObjCounters ()
 

Detailed Description

A named pointer class.

A named string holding a pointer to arbitrary data. The pointer is owned by the object: it will be released when the object is destroyed or the string value changed

Constructor & Destructor Documentation

NamedPointer ( const char *  name,
GenObject *  data = 0,
const char *  value = 0 
)
explicit

Creates a new named pointer

Parameters
nameName of this pointer
dataInitial pointer value. The pointer will be owned by this object
valueInitial string value
virtual ~NamedPointer ( )
virtual

Destructor. Release the pointer

Member Function Documentation

virtual void changed ( )
protectedvirtual

Called whenever the string value changed. Release the pointer

Reimplemented from String.

virtual void* getObject ( const String &  name) const
virtual

Get a pointer to a derived class given that class name

Parameters
nameName of the class we are asking for
Returns
Pointer to the requested class or NULL if this object doesn't implement it

Reimplemented from NamedString.

NamedPointer& operator= ( const char *  value)
inline

String value assignment operator

References NamedString::operator=().

GenObject* takeData ( )

Retrieve the pointer carried by this object and release ownership. The caller will own the returned pointer

Returns
Pointer to arbitrary user GenObject
GenObject* userData ( ) const
inline

Retrieve the pointer carried by this object

Returns
Pointer to arbitrary user GenObject
void userData ( GenObject *  data)

Set obscure data carried by this object. Note that a RefObject's reference counter should be increased before adding it to this named pointer

Parameters
dataPointer to arbitrary user data
void* userObject ( const String &  name) const
inline

Get a pointer to a derived class of user data given that class name

Parameters
nameName of the class we are asking for
Returns
Pointer to the requested class or NULL if user object id NULL or doesn't implement it

References GenObject::getObject().

The documentation for this class was generated from the following file:
Generated on Fri Sep 8 2017 13:30:43 for Yate by   doxygen 1.8.8