xml_node.h

Go to the documentation of this file.

/*
 *
 * Copyright (c) Microsoft Corporation.
 * All rights reserved.
 *
 * This code is licensed under the MIT License.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files(the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions :
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 */
#ifndef API_MIP_XML_NODE_H_
#define API_MIP_XML_NODE_H_
 
#include <memory>
#include <string>
#include <vector>
 
#include "mip/mip_namespace.h"
 
MIP_NAMESPACE_BEGIN
 
namespace xml {
 
struct XmlNamespace {
  std::string prefix;
  std::string uri;
};
 
enum class XmlNodeType : int {
  UNKNOWN = -1,
  NONE = 0,
  ELEMENT = 1,
  ATTRIBUTE = 2,
  TEXT = 3,
  CDATA = 4,
  ENTITY_REFERENCE = 5,
  ENTITY = 6,
  PROCESSING_INSTRUCTION = 7,
  COMMENT = 8,
  DOCUMENT = 9,
  DOCUMENT_TYPE = 10,
  DOCUMENT_FRAGMENT = 11,
  NOTATION = 12,
  WHITESPACE = 13,
  SIGNIFICANT_WHITESPACE = 14,
  END_ELEMENT = 15,
  END_ENTITY = 16,
  XML_DECLARATION = 17
};
 
/* Example XML for methods
(1) <bk:book xmlns:bk='testbook' bk:ISBN='1-861001-57-5'>
(2)   <title>
(3)     Pride And Prejudice
(4)   </title>
(5)   <author>Jane Austen</author>
(6) </bk:book>
*/
class XmlNode {
public:
  virtual std::string GetAttributeValue(const std::string& attributeName) const = 0;
  virtual std::vector<std::pair<std::string, std::string>> GetAttributes() const = 0;
  virtual std::shared_ptr<XmlNode> GetNextNode() const = 0;
  virtual std::shared_ptr<XmlNode> GetFirstChild() const = 0;
  virtual std::string GetName() const = 0;
  virtual std::string GetContent() const = 0;
  virtual std::string GetInnerText() const = 0;
  virtual XmlNamespace GetNamespace() const = 0;
  virtual XmlNodeType GetNodeType() const = 0;
  virtual bool IsNull() const = 0;
 
  virtual void AddAttribute(const std::string& attributeName, const std::string& attributeValue) = 0;
 
  virtual int RemoveAttribute(const std::string& attributeName) = 0;
  virtual std::shared_ptr<XmlNode> AddNewChild(const std::string& name) = 0;
  virtual std::shared_ptr<XmlNode> AddNewChild(const std::string& name, const std::string& namespaceName) = 0;
  virtual bool AddContent(const std::string& content) = 0;
  virtual bool RemoveNodeFromDocument() = 0;
 
  virtual ~XmlNode() {}
};
 
} // xml
 
MIP_NAMESPACE_END
 
#endif // API_MIP_XML_NODE_H_