Gray C++ Libraries  0.0.2
A set of C++ libraries for MSVC, GNU on Windows, WinCE, Linux
Gray::cIniMap Class Reference

#include <cIniMap.h>

Inheritance diagram for Gray::cIniMap:
Gray::IIniBaseSetter Gray::IIniBaseGetter Gray::IIniBaseEnumerator Gray::cArraySortStructHash< cIniKeyValue > Gray::cArraySorted< TYPE, TYPE_ARG, TYPE_KEY > Gray::cArrayTyped< TYPE, TYPE_ARG > Gray::CArray< TYPE, ARG_TYPE > Gray::CObject

Public Member Functions

 cIniMap ()
 
virtual ~cIniMap ()
 
ITERATE_t Find (const IniChar_t *pszPropTag) const
 
const IniChar_tGetVal (const IniChar_t *pszPropTag) const
 
HRESULT SetVal (const IniChar_t *pszPropTag, cStringI sValue)
 
virtual HRESULT PropSet (const IniChar_t *pszPropTag, const IniChar_t *pszValue) override
 
virtual HRESULT PropGet (const IniChar_t *pszPropTag, OUT cStringI &rsValue) const override
 
virtual HRESULT PropEnum (IPROPIDX_t ePropIdx, OUT cStringI &rsValue, cStringI *psKey=nullptr) const override
 
void SetCopy (const cIniMap &rAttribs)
 
HRESULT GetValInt (const IniChar_t *pszPropTag, int *piValue) const
 
HRESULT GetValDouble (const IniChar_t *pszPropTag, double *pdValue) const
 
HRESULT SetValInt (const IniChar_t *pszPropTag, int iVal)
 
- Public Member Functions inherited from Gray::cArraySortStructHash< cIniKeyValue >
virtual ~cArraySortStructHash ()
 
const cIniKeyValueFindArgForKey (KEY_t key1) const
 
- Public Member Functions inherited from Gray::cArraySorted< TYPE, TYPE_ARG, TYPE_KEY >
virtual ~cArraySorted ()
 
ITERATE_t FindINear (REF_t pNew, COMPARE_t &iCompareRes) const
 
ITERATE_t FindINearKey (KEY_t key, COMPARE_t &iCompareRes) const
 
ITERATE_t FindIForKey (KEY_t key) const
 
ITERATE_t FindIFirstForKey (TYPE_KEY nKey) const
 
ITERATE_t FindILastForKey (TYPE_KEY nKey) const
 
ITERATE_t AddPresorted (ITERATE_t index, COMPARE_t iCompareRes, TYPE_ARG pNew)
 
bool RemoveKey (TYPE_KEY key)
 
ITERATE_t Add (TYPE_ARG pNew)
 
void AddArray (const SUPER_t &a)
 
- Public Member Functions inherited from Gray::cArrayTyped< TYPE, TYPE_ARG >
void QSort ()
 
 cArrayTyped () noexcept
 
 cArrayTyped (const THIS_t &rArray)
 
 cArrayTyped (ITERATE_t iSize)
 
virtual ~cArrayTyped ()
 
bool isValidCheck () const noexcept
 < memory allocation and structure definitions are valid. More...
 
bool IsValidIndex (ITERATE_t i) const noexcept
 
ITERATE_t ClampValidIndex (ITERATE_t i) const noexcept
 
size_t GetHeapStats (OUT ITERATE_t &iAllocCount) const noexcept
 
void AssertValidIndex (ITERATE_t nIndex) const
 
const TYPEGetAtSecure (ITERATE_t nIndex) const
 
TYPEElementAtSecure (ITERATE_t nIndex)
 
REF_t ConstElementAt (ITERATE_t nIndex) const
 
TYPEoperator[] (ITERATE_t nIndex)
 
const TYPEoperator[] (ITERATE_t nIndex) const
 
TYPEHead ()
 
TYPETail ()
 
TYPEElementAtHead ()
 
TYPEElementAtTail ()
 
REF_t ConstHead () const
 
REF_t ConstTail () const
 
REF_t GetAtTail ()
 
void UnLinkIndex (ITERATE_t nIndex)
 
void Swap (ITERATE_t i, ITERATE_t j)
 
void SetCopy (const cArrayTyped< TYPE, TYPE_ARG > &aValues)
 
const cArrayTyped< TYPE, TYPE_ARG > & operator= (const cArrayTyped< TYPE, TYPE_ARG > &aValues)
 
ITERATE_t FindIFor (TYPE_ARG arg) const
 
bool HasArg (TYPE_ARG arg) const
 
void RemoveLast ()
 
ELEM_t PopHead ()
 
ELEM_t PopTail ()
 
bool RemoveArg (TYPE_ARG arg)
 
void UnLinkArg (TYPE_ARG arg)
 
ITERATE_t AddTail (TYPE_ARG newElement)
 
ITERATE_t PushTail (TYPE_ARG newElement)
 
void AddHead (TYPE_ARG newElement)
 
TYPEget_DataWork () const
 
void AddArray (const SUPER_t &src)
 
bool IsEqualArray (const SUPER_t &aValues) const
 
bool isArraySorted () const
 
bool isArraySortedND () const
 
- Public Member Functions inherited from Gray::CArray< TYPE, ARG_TYPE >
 CArray () noexcept
 
 CArray (THIS_t &&ref) noexcept
 
virtual ~CArray ()
 
bool IsValidMallocSize () const noexcept
 
ITERATE_t GetSize () const noexcept
 
ITERATE_t GetUpperBound () const noexcept
 
bool IsEmpty () const noexcept
 
void SetSize (ITERATE_t nNewSize)
 
ITERATE_t GetMallocSize () const noexcept
 
void RemoveAll ()
 Clean up. More...
 
const TYPEGetAt (ITERATE_t nIndex) const
 
TYPEElementAt (ITERATE_t nIndex)
 
void SetAt (ITERATE_t nIndex, ARG_TYPE newElement)
 
const TYPEGetData () const
 
TYPEGetData ()
 
void SetDataArrayPtr (TYPE *pData, ITERATE_t nSize)
 
void SetAtGrow (ITERATE_t nIndex, ARG_TYPE newElement)
 
ITERATE_t Add (ARG_TYPE newElement)
 
void Copy (const CArray &src)
 
TYPEoperator[] (ITERATE_t nIndex)
 
const TYPEoperator[] (ITERATE_t nIndex) const
 
void InsertAt (ITERATE_t nIndex, ARG_TYPE newElement)
 
void RemoveAt (ITERATE_t nIndex)
 
void RemoveAt (ITERATE_t nIndex, ITERATE_t iQty)
 
void MoveElement (ITERATE_t iFrom, ITERATE_t iTo)
 
- Public Member Functions inherited from Gray::CObject
virtual ~CObject ()
 
virtual void AssertValid () const
 < memory allocation and structure definitions are valid. More...
 
virtual void Serialize (cArchive &a)
 

Additional Inherited Members

- Public Types inherited from Gray::cArraySortStructHash< cIniKeyValue >
typedef cArraySorted< cIniKeyValue, const cIniKeyValue &, HASHCODE_tSUPER_t
 
typedef SUPER_t::REF_t REF_t
 
typedef SUPER_t::KEY_t KEY_t
 
- Public Types inherited from Gray::cArraySorted< TYPE, TYPE_ARG, TYPE_KEY >
typedef cArrayTyped< TYPE, TYPE_ARG > SUPER_t
 
typedef TYPE_KEY KEY_t
 
typedef SUPER_t::REF_t REF_t
 
- Public Types inherited from Gray::cArrayTyped< TYPE, TYPE_ARG >
typedef CArray< TYPE, TYPE_ARG > SUPER_t
 
typedef cArrayTyped< TYPE, TYPE_ARG > THIS_t
 
typedef ITERATE_t iterator
 
typedef ITERATE_t const_iterator
 
typedef TYPE ELEM_t
 What type is stored. More...
 
typedef TYPE_ARG REF_t
 How to refer to this? value or ref or pointer? More...
 
- Protected Member Functions inherited from Gray::cArraySortStructHash< cIniKeyValue >
virtual COMPARE_t CompareData (REF_t Data1, REF_t Data2) const noexcept override
 
virtual COMPARE_t CompareKey (KEY_t key1, REF_t Data2) const override
 
- Protected Member Functions inherited from Gray::cArraySorted< TYPE, TYPE_ARG, TYPE_KEY >
virtual COMPARE_t CompareKey (KEY_t key1, REF_t Data2) const
 
bool RemoveArgKey (REF_t pObj, KEY_t key)
 
- Protected Member Functions inherited from Gray::cArrayTyped< TYPE, TYPE_ARG >
ITERATE_t QSortPartition (ITERATE_t iLeft, ITERATE_t iRight)
 
void QSort (ITERATE_t iLeft, ITERATE_t iRight)
 
- Protected Member Functions inherited from Gray::CArray< TYPE, ARG_TYPE >
bool IsValidIndex (ITERATE_t i) const noexcept
 
- Protected Attributes inherited from Gray::CArray< TYPE, ARG_TYPE >
TYPEm_pData
 the actual array of data More...
 
ITERATE_t m_nSize
 Number of elements (upperBound - 1) More...
 

Detailed Description

A bag of tuples. A collection of key/value pairs stored as strings. Can be used for HTTP cookie sets, cXmlAttributeSet, JSON objects. ASSUME NO duplicated keys. Similar to cIniObject but props are NOT known/predefined.

Constructor & Destructor Documentation

◆ cIniMap()

Gray::cIniMap::cIniMap ( )
inline

◆ ~cIniMap()

virtual Gray::cIniMap::~cIniMap ( )
inlinevirtual

Member Function Documentation

◆ Find()

ITERATE_t Gray::cIniMap::Find ( const IniChar_t pszPropTag) const

◆ GetVal()

const IniChar_t * Gray::cIniMap::GetVal ( const IniChar_t pszPropTag) const

get the value of a named attribute.

◆ GetValDouble()

HRESULT Gray::cIniMap::GetValDouble ( const IniChar_t pszPropTag,
double *  pdValue 
) const

error as if using scanf("%lf")

◆ GetValInt()

HRESULT Gray::cIniMap::GetValInt ( const IniChar_t pszPropTag,
int *  piValue 
) const

error as if using scanf("%d")

◆ PropEnum()

HRESULT Gray::cIniMap::PropEnum ( IPROPIDX_t  ePropIdx,
OUT cStringI rsValue,
cStringI psKey = nullptr 
) const
overridevirtual

IIniBaseEnumerator Enum the values and keys of the map.

  • = optionally return psKey. nullptr = don't care.

Implements Gray::IIniBaseEnumerator.

◆ PropGet()

HRESULT Gray::cIniMap::PropGet ( const IniChar_t pszPropTag,
OUT cStringI rsValue 
) const
overridevirtual

◆ PropSet()

HRESULT Gray::cIniMap::PropSet ( const IniChar_t pszPropTag,
const IniChar_t pszValue 
)
overridevirtual

IIniBaseSetter will replace if existing key.

Returns
E_INVALIDARG, HRESULT_WIN32_C(ERROR_UNKNOWN_PROPERTY)

Implements Gray::IIniBaseSetter.

◆ SetCopy()

void Gray::cIniMap::SetCopy ( const cIniMap rAttribs)

Copy the attributes from rAttribs to this.

◆ SetVal()

HRESULT Gray::cIniMap::SetVal ( const IniChar_t pszPropTag,
cStringI  sValue 
)

will replace if existing key.

Returns
E_INVALIDARG, HRESULT_WIN32_C(ERROR_UNKNOWN_PROPERTY)

◆ SetValInt()

HRESULT Gray::cIniMap::SetValInt ( const IniChar_t pszPropTag,
int  iVal 
)

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