Home | History | Annotate | Download | only in xmlserializer
      1 /*
      2  * Copyright (c) 2011-2014, Intel Corporation
      3  * All rights reserved.
      4  *
      5  * Redistribution and use in source and binary forms, with or without modification,
      6  * are permitted provided that the following conditions are met:
      7  *
      8  * 1. Redistributions of source code must retain the above copyright notice, this
      9  * list of conditions and the following disclaimer.
     10  *
     11  * 2. Redistributions in binary form must reproduce the above copyright notice,
     12  * this list of conditions and the following disclaimer in the documentation and/or
     13  * other materials provided with the distribution.
     14  *
     15  * 3. Neither the name of the copyright holder nor the names of its contributors
     16  * may be used to endorse or promote products derived from this software without
     17  * specific prior written permission.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
     20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     22  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
     23  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
     26  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     28  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 #pragma once
     31 
     32 #include <stdint.h>
     33 #include <string>
     34 
     35 struct _xmlNode;
     36 struct _xmlDoc;
     37 
     38 class CXmlElement
     39 {
     40     friend class CChildIterator;
     41 public:
     42     CXmlElement(_xmlNode* pXmlElement);
     43     CXmlElement();
     44 
     45     // Xml element
     46     void setXmlElement(_xmlNode* pXmlElement);
     47 
     48     // Getters
     49     std::string getType() const;
     50     std::string getPath() const;
     51     std::string getNameAttribute() const;
     52     bool hasAttribute(const std::string& strAttributeName) const;
     53     bool getAttributeBoolean(const std::string& strAttributeName, const std::string& strTrueValue) const;
     54     bool getAttributeBoolean(const std::string& strAttributeName) const;
     55     std::string getAttributeString(const std::string& strAttributeName) const;
     56     uint32_t getAttributeInteger(const std::string& strAttributeName) const;
     57     int32_t getAttributeSignedInteger(const std::string& strAttributeName) const;
     58     double getAttributeDouble(const std::string& strAttributeName) const;
     59     std::string getTextContent() const;
     60 
     61     // Navigation
     62     bool getChildElement(const std::string& strType, CXmlElement& childElement) const;
     63     bool getChildElement(const std::string& strType, const std::string& strNameAttribute, CXmlElement& childElement) const;
     64     size_t getNbChildElements() const;
     65     bool getParentElement(CXmlElement& parentElement) const;
     66 
     67     // Setters
     68     void setAttributeBoolean(const std::string& strAttributeName, bool bValue);
     69     void setAttributeString(const std::string& strAttributeName, const std::string& strValue);
     70     void setNameAttribute(const std::string& strValue);
     71     void setTextContent(const std::string& strContent);
     72     void setAttributeInteger(const std::string& strAttributeName, uint32_t uiValue);
     73     /**
     74       * Set attribute with signed integer
     75       *
     76       * @param[in] strAttributeName The attribute name
     77       * @param[in] iValue The attribute value
     78       *
     79       */
     80     void setAttributeSignedInteger(const std::string& strAttributeName, int32_t iValue);
     81 
     82     // Child creation
     83     void createChild(CXmlElement& childElement, const std::string& strType);
     84 
     85 public:
     86     // Child iteration
     87     class CChildIterator
     88     {
     89     public:
     90         CChildIterator(const CXmlElement& xmlElement);
     91 
     92         bool next(CXmlElement& xmlChildElement);
     93     private:
     94         _xmlNode* _pCurNode;
     95     };
     96 
     97 private:
     98     _xmlNode* _pXmlElement;
     99 };
    100 
    101