|
PTLib
Version 2.14.3
|
|
PTLib
Version 2.14.3
|
This is a dictionary collection class of PString objects, keyed by another string.
More...
#include <pstring.h>
Classes | |
| struct | Initialiser |
| Structure for static array initialiser for class. More... | |
Public Member Functions | |
| char ** | ToCharArray (bool withEqualSign, PCharArray *storage=NULL) const |
| Create an array of C strings. More... | |
| void | FromString (const PString &str) |
| Set dictionary from string. More... | |
Construction | |
| PStringToString (PINDEX count, const Initialiser *init, PBoolean caselessKeys=false, PBoolean caselessValues=false) | |
| Initialise the string dictionary of strings from the static array. More... | |
| PStringToString (const PString &str) | |
| Initialise the string dictionary from the string. More... | |
Overrides from class PObject | |
| virtual void | ReadFrom (istream &strm) |
| Input the contents of the object from the stream. More... | |
 Public Member Functions inherited from PStringDictionary< K > | |
| PStringDictionary () | |
| Create a new, empty, dictionary. More... | |
| virtual PObject * | Clone () const |
| Make a complete duplicate of the dictionary. More... | |
| PString | operator() (const K &key, const char *dflt=NULL) const |
Get the string contained in the dictionary at the key position. More... | |
| virtual PBoolean | SetAt (const K &key, const PString &str) |
| Add a new object to the collection. More... | |
| Public Member Functions inherited from PDictionary< K, PString > | |
| PDictionary () | |
| Create a new, empty, dictionary. More... | |
| const PString & | operator[] (const K &key) const |
Get the object contained in the dictionary at the key position. More... | |
| PString & | operator[] (const K &key) |
| PBoolean | Contains (const K &key) const |
| Determine if the value of the object is contained in the hash table. More... | |
| virtual PString * | RemoveAt (const K &key) |
Remove an object at the specified key. More... | |
| virtual PBoolean | SetAt (const K &key, PString *obj) |
| Add a new object to the collection. More... | |
| virtual PString * | GetAt (const K &key) const |
| Get the object at the specified key position. More... | |
| const K & | GetKeyAt (PINDEX index) const |
| Get the key in the dictionary at the ordinal index position. More... | |
| PString & | GetDataAt (PINDEX index) const |
| Get the data in the dictionary at the ordinal index position. More... | |
| PArray< K > | GetKeys () const |
| Get an array containing all the keys for the dictionary. More... | |
| iterator | begin () |
| const_iterator | begin () const |
| iterator | end () |
| const_iterator | end () const |
| iterator | find (const K &key) |
| const_iterator | find (const K &k) const |
| void | erase (const iterator &it) |
| void | erase (const const_iterator &it) |
| Public Member Functions inherited from PAbstractDictionary | |
| PINLINE | PAbstractDictionary () |
| Create a new, empty, dictionary. More... | |
| virtual void | PrintOn (ostream &strm) const |
| Output the contents of the object to the stream. More... | |
| virtual PINDEX | Insert (const PObject &key, PObject *obj) |
| Insert a new object into the dictionary. More... | |
| virtual PINDEX | InsertAt (PINDEX index, PObject *obj) |
| Insert a new object at the specified index. More... | |
| virtual PObject * | RemoveAt (PINDEX index) |
| Remove an object at the specified index. More... | |
| virtual PBoolean | SetAt (PINDEX index, PObject *val) |
| Set the object at the specified index to the new value. More... | |
| virtual PObject * | GetAt (PINDEX index) const |
| Get the object at the specified index position. More... | |
| virtual PINDEX | GetObjectsIndex (const PObject *obj) const |
| Search the collection for the specific instance of the object. More... | |
| virtual PINDEX | GetValuesIndex (const PObject &obj) const |
| Search the collection for the specified value of the object. More... | |
| virtual P_DEPRECATED PBoolean | SetDataAt (PINDEX index, PObject *obj) |
| Set the data at the specified ordinal index position in the dictionary. More... | |
| virtual PObject * | AbstractSetAt (const PObject &key, PObject *obj) |
| Add a new object to the collection. More... | |
| virtual PObject & | GetRefAt (const PObject &key) const |
| Get the object at the specified key position. More... | |
| virtual PObject * | AbstractGetAt (const PObject &key) const |
| Get the object at the specified key position. More... | |
| virtual void | AbstractGetKeys (PArrayObjects &keys) const |
| Get an array containing all the keys for the dictionary. More... | |
| Public Member Functions inherited from PHashTable | |
| PHashTable () | |
| Create a new, empty, hash table. More... | |
| virtual Comparison | Compare (const PObject &obj) const |
| Get the relative rank of the two hash tables. More... | |
| virtual PBoolean | SetSize (PINDEX newSize) |
| This function is meaningless for hash table. More... | |
| PINLINE PBoolean | AbstractContains (const PObject &key) const |
| Determine if the value of the object is contained in the hash table. More... | |
| virtual const PObject & | AbstractGetKeyAt (PINDEX index) const |
| Get the key in the hash table at the ordinal index position. More... | |
| virtual PObject & | AbstractGetDataAt (PINDEX index) const |
| Get the data in the hash table at the ordinal index position. More... | |
| Public Member Functions inherited from PCollection | |
| PCollection (PINDEX initialSize=0) | |
| Create a new collection. More... | |
| virtual void | PrintOn (ostream &strm) const |
| Print the collection on the stream. More... | |
| __inline void | remove (const PObject *obj) |
| virtual void | RemoveAll () |
| Remove all of the elements in the collection. More... | |
| __inline void | clear () |
| PINLINE void | AllowDeleteObjects (PBoolean yes=true) |
| Allow or disallow the deletion of the objects contained in the collection. More... | |
| void | DisallowDeleteObjects () |
| Disallow the deletion of the objects contained in the collection. More... | |
| Public Member Functions inherited from PContainer | |
| PContainer (PINDEX initialSize=0) | |
| Create a new unique container. More... | |
| PContainer (const PContainer &cont) | |
| Create a new refernce to container. More... | |
| PContainer & | operator= (const PContainer &cont) |
| Assign one container reference to another. More... | |
| virtual | ~PContainer () |
| Destroy the container class. More... | |
| virtual PINDEX | GetSize () const |
| Get the current size of the container. More... | |
| __inline size_t | size () const |
| PBoolean | SetMinSize (PINDEX minSize) |
| Set the minimum size of container. More... | |
| virtual PBoolean | IsEmpty () const |
| Determine if the container is empty. More... | |
| __inline bool | empty () const |
| PBoolean | IsUnique () const |
| Determine if container is unique reference. More... | |
| virtual PBoolean | MakeUnique () |
| Make this instance to be the one and only reference to the container contents. More... | |
| Public Member Functions inherited from PObject | |
| unsigned | GetTraceContextIdentifier () const |
| Get PTRACE context identifier. More... | |
| void | SetTraceContextIdentifier (unsigned id) |
| void | GetTraceContextIdentifier (PObject &obj) |
| void | GetTraceContextIdentifier (PObject *obj) |
| void | SetTraceContextIdentifier (const PObject &obj) |
| void | SetTraceContextIdentifier (const PObject *obj) |
| virtual | ~PObject () |
| template<class CLS > | |
| CLS * | CloneAs () const |
| As for Clone() but converts to specified type. More... | |
| virtual PINDEX | HashFunction () const |
This function yields a hash value required by the PDictionary class. More... | |
| virtual const char * | GetClass (unsigned ancestor=0) const |
| Get the current dynamic type of the object instance. More... | |
| PBoolean | IsClass (const char *cls) const |
| virtual PBoolean | InternalIsDescendant (const char *clsName) const |
| Determine if the dynamic type of the current instance is a descendent of the specified class. More... | |
| __inline const PObject * | PTraceObjectInstance () const |
| virtual Comparison | CompareObjectMemoryDirect (const PObject &obj) const |
| Determine the byte wise comparison of two objects. More... | |
| bool | operator== (const PObject &obj) const |
| Compare the two objects. More... | |
| bool | operator!= (const PObject &obj) const |
| Compare the two objects. More... | |
| bool | operator< (const PObject &obj) const |
| Compare the two objects. More... | |
| bool | operator> (const PObject &obj) const |
| Compare the two objects. More... | |
| bool | operator<= (const PObject &obj) const |
| Compare the two objects. More... | |
| bool | operator>= (const PObject &obj) const |
| Compare the two objects. More... | |
| virtual void | ReadFrom (istream &strm) |
| Input the contents of the object from the stream. More... | |
Additional Inherited Members | |
| Public Types inherited from PDictionary< K, PString > | |
| typedef K | key_type |
| typedef PString | data_type |
| typedef PDictionary< K, PString > | dict_type |
| Static Public Member Functions inherited from PObject | |
| static const char * | Class () |
| Get the name of the class as a C string. More... | |
| static __inline const PObject * | PTraceObjectInstance (const char *) |
| static __inline const PObject * | PTraceObjectInstance (const PObject *obj) |
| static Comparison | InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size) |
| Internal function caled from CompareObjectMemoryDirect() More... | |
| Public Attributes inherited from PHashTable | |
| PHashTableInfo * | hashTable |
| Protected Member Functions inherited from PStringDictionary< K > | |
| PStringDictionary (int dummy, const PStringDictionary *c) | |
| Protected Attributes inherited from PContainer | |
| PContainerReference * | reference |
| Friends inherited from PObject | |
This is a dictionary collection class of PString objects, keyed by another string.
It has all the usual functions for a collection, with the object types set to PString pointers.
In addition some addition functions are added that take a const PString reference instead of a pointer as most standard collection functions do. This is more convenient for when string expressions are used as parameters to function in the collection.
See the PAbstractDictionary and PStringDictionary classes and PDECLARE_DICTIONARY and PDECLARE_STRING_DICTIONARY macros for more information.
| PStringToString::PStringToString | ( | PINDEX | count, |
| const Initialiser * | init, | ||
| PBoolean | caselessKeys = false, |
||
| PBoolean | caselessValues = false |
||
| ) |
Initialise the string dictionary of strings from the static array.
| count | Count of strings in initialiser array |
| init | Array of Initialiser structures |
| caselessKeys | New keys are to be PCaselessStrings |
| caselessValues | New values are to be PCaselessStrings |
|
inline |
Initialise the string dictionary from the string.
The string is expected to be of the form "key=value\\nkey=value".
| str | String to read dictionary from |
References FromString().
| void PStringToString::FromString | ( | const PString & | str | ) |
Set dictionary from string.
The string is expected to be of the form "key=value\\nkey=value".
| str | String to read dictionary from |
Referenced by PStringToString().
|
virtual |
Input the contents of the object from the stream.
This is primarily used by the standard operator>> function.
The default behaviour reads input of the form "key=value\\nkey=value" until !strm.good().
Reimplemented in PMIMEInfo.
| char** PStringToString::ToCharArray | ( | bool | withEqualSign, |
| PCharArray * | storage = NULL |
||
| ) | const |
Create an array of C strings.
If withEqualSign is true then array is GetSize()+1 strings of the form key=value. If false then the array is GetSize()*2+1 strings where consecutive pointers are the key and option respecitively of each entry in the dictionary.
If storage is NULL then this returns a single pointer that must be disposed of using free(). Note that each of the strings are part of the same memory allocation so only one free() is required.
If storage is not null then that is used to allocate the memory.
1.8.3.1 
