builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/std/dom.h

Go to the documentation of this file.

 
#ifndef _DOM_CLASS_HEADER_
#define _DOM_CLASS_HEADER_
 
namespace A_UTILS_NS
{
 
class cDOM;
class cDOMElement;
 
typedef cDOMElement*                cDOMElementRef;
typedef std::list<cDOMElement>      cDOMElementList;
typedef std::list<cDOMElement*>     cDOMElementRefList;
 
typedef cDOMElementList::iterator           cDOMElementItor;
typedef cDOMElementList::const_iterator     cDOMElementItorConst;
typedef cDOMElementRefList::iterator        cDOMElementRefItor;
typedef cDOMElementRefList::const_iterator  cDOMElementRefItorConst;
 
struct xml_string_compare_func
{
    bool operator()(const cString& str1, const cString& str2) const
    {
        return ((str1.Compare(str2)) < 0);
    }
};
typedef std::map<cString, cString, xml_string_compare_func> cDOMAttributes;
 
class cDOMElement
{
    A_UTILS_D(cDOMElement)
 
    protected:
        cDOM*               m_pDocument;        
        cDOMElement*        m_pParent;          
        cDOMElementList     m_lstChildren;      
        cString             m_strName;          
        cString             m_strPath;          
        cString             m_strData;          
        cDOMAttributes      m_mapAttributes;    
 
        static cString      m_strEmptyValue;    
        static cDOMElement  m_oNullElement;     
 
    public:
        A_UTILS_DEPRECATED(cDOMElement)();
 
        A_UTILS_DEPRECATED(cDOMElement)(const cDOMElement& oElement);
 
        virtual ~cDOMElement();
 
        cDOMElement& operator=(const cDOMElement& oElement);
 
        tResult Free();
        const cString& GetName() const;
 
        tVoid SetName(const cString& strName);
 
        cDOMElement& GetParent();
 
        const cDOMElement& GetParent() const;
 
        cDOM& GetDocument();
 
        const cDOM& GetDocument() const;
 
        cDOMElementList& GetChildren();
 
        const cDOMElementList& GetChildren() const;
 
        const cString& GetData() const;
 
        tVoid SetData(const cString& strData);
 
        cDOMAttributes& GetAttributes();
 
        const cDOMAttributes& GetAttributes() const;
 
        tBool Exists(const cString& strName) const;
 
        cString GetAttribute(const cString& strName, const cString& strDefault = cString()) const;
 
 
        tInt GetAttributeInt(const cString& strName, tInt nDefault = 0) const;
 
        tUInt32 GetAttributeUInt32(const cString& strName, tUInt32 nDefault = 0) const;
 
        tBool GetAttributeBool(const cString& strName, tBool bDefault = tFalse) const;
 
        tFloat64 GetAttributeFloat64(const cString& strName, tFloat64 fDefault = 0.0) const;
 
        tVoid SetAttribute(const cString& strName, const cString& strValue);
 
        tVoid EraseAttribute(const cString& strName);
 
        const cString& GetPath() const;
 
        tResult FindNode(const tChar* strQuery, cDOMElement*& poElement);
 
        tResult FindNodes(const tChar* strQuery, cDOMElementRefList& lstElements, tInt32 ui32Flags = 0);
 
        tResult FromString(const tChar* strXML);
 
        cString ToString() const;
 
        tResult CreateChild(const cString& strName, cDOMElement*& poChild);
 
        tResult InsertChild(const cDOMElement& oChild);
 
        tResult InsertBefore(const cDOMElement& oChild, cDOMElement* pBefore);
 
        cDOMElement* GetChild(const cString& strName);
 
        const cDOMElement* GetChild(const cString& strName) const;
 
        tResult Delete();
 
    protected:
        tResult Create(const tChar*& ptr, cDOMElement* pParent, cDOM* pDocument, const tChar* pStart = nullptr);
 
        tVoid CreateChild(const std::list<cString>& lstComment, const tInt& nFlag = 0);
 
        tResult ReadAttributes(const tChar*& ptr, const tChar* pStart = nullptr);
 
        tResult ReadData(const tChar*& ptr, const tChar* pStart = nullptr);
 
        tBool MatchQuery(const tChar *ptr, tUInt32 &o_nOffset);
 
        tBool MatchAttributes(const tChar *pString);
 
        tResult FindNodesImpl(const tChar* strQuery, cDOMElementRefList& lstElements,
                              tBool& bFinished, tUInt32 ui32Flags);
 
    protected:
        cString ToStringImpl(tUInt32 ui32Flags, tInt nIndentLevel=0) const;
 
    private:
        tResult MergeIncludeNode(cDOMElement& oIncludeNode);
        tVoid Copy(const cDOMElement& oFromElement, cDOMElement* pParent, cDOM* pDocument, const cString& strPath);
 
 
    friend class cDOM;
};
 
class cDOM
{
    A_UTILS_D(cDOM)
 
    friend class cDOMElement;
 
    protected:
        cFilename               m_strFilePath;          
        cDOMElement             m_oRoot;                
        cDOMElementList         m_lstPreRootSibling;    
        cDOMElementList         m_lstPostRootSibling;   
        cStringList             m_lstIncludedFile;      
        tBool                   m_bIgnoreIncludesEnabled; 
 
        cString                 m_strLastErrorDescription; 
        static const tSize      m_nTABSIZE = 1;     
 
 
    public:
        A_UTILS_DEPRECATED(cDOM)();
 
        virtual ~cDOM();
 
        A_UTILS_DEPRECATED(cDOM)(const cDOM& oDOM);
 
        cDOM& operator=(const cDOM& oDOM);
 
        tResult Load(const tChar* strFilename,
                     const tBool& bIgnoreIncludes=tFalse,
                     const tUInt32& ui32OpenMode=cFile::OM_Read|cFile::OM_SharedRead|cFile::OM_SequentialAccess);
 
        tResult Save(const tChar* strFilename, const tBool& bKeepIncludes=tFalse) const;
 
        tResult FromString(const tChar* ptrXML, const tBool& bIgnoreIncludes=tFalse);
 
        cString ToString() const;
 
        tResult Free();
 
        cDOMElement& GetRoot();
 
        const cDOMElement& GetRoot() const;
 
 
        tVoid SetRoot(const cDOMElement& oNewRoot);
 
        tVoid AddPreRootSibling(const cDOMElement& oChild);
 
        tVoid AddPostRootSibling(const cDOMElement& oChild);
 
        const cDOMElementList& GetPreRootSibling() const;
 
        const cDOMElementList& GetPostRootSibling() const;
 
        tResult FindNode(const tChar* strQuery, cDOMElement*& poElement);
 
        tResult FindNodes(const tChar* strQuery, cDOMElementRefList& lstElements);
 
        cString GetFilePath();
        cStringList GetIncludedFiles();
        tVoid AddIncludedFile(const cString& strIncludedFile);
 
    public:
        static tResult SkipComment(cDOM* pDom, const tChar*& ptr, std::list<cString>& lstComment, const tChar* pStart = nullptr);
 
 
        cString GetLastDOMError();
 
 
    private:
        tResult DropIncludes(cDOMElement* pElement = nullptr);
        static tVoid DOMError(cDOM* pDom,
                              const tChar * pStart,
                              const tChar * pCur,
                              const tChar * pMsg);
        tVoid        SetDOMError(cString& strError);
        tBool   IsIgnoreIncludesEnabled();
};
 
} // namespace
 
#endif // _DOM_CLASS_HEADER_