ACE/ace/XML_Utils/XML_Helper.h

   1 //============================================================
   2 /**
   3  * @file XML_Helper.h
   4  *
   5  * @brief Some helper functions for XML
   6  *
   7  * @author Bala Natarajan <bala@dre.vanderbilt.edu>
   8  * @author William R. Otte <wotte@dre.vanderbilt.edu>
   9  */
  10 //============================================================
  11 #ifndef ACE_XML_HELPER_H
  12 #define ACE_XML_HELPER_H
  13 #include /**/ "ace/pre.h"
  14
  15 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  16 # pragma once
  17 #endif /* ACE_LACKS_PRAGMA_ONCE */
  18
  19 #include "XML_Error_Handler.h"
  20 #include "XML_Schema_Resolver.h"
  21
  22 #include "xercesc/util/XercesDefs.hpp"
  23 #include "xercesc/parsers/XercesDOMParser.hpp"
  24
  25 #include <memory>
  26
  27 namespace XERCES_CPP_NAMESPACE
  28 {
  29   class DOMDocument;
  30   class DOMWriter;
  31   class DOMImplementation;
  32   class DOMDocumentType;
  33 }
  34
  35 namespace XML
  36 {
  37   /**
  38     * @class XML_Helper
  39     *
  40     * @brief Helper class for some routine XML stuff.
  41     */
  42   template <typename Resolver = XML_Schema_Resolver <>,
  43             typename Error_Handler = XML_Error_Handler>
  44   class XML_Helper
  45   {
  46   public:
  47     XML_Helper (Resolver *resolver = nullptr, Error_Handler *eh = nullptr);
  48
  49     ~XML_Helper ();
  50
  51     /// Create a DOM tree
  52     XERCES_CPP_NAMESPACE::DOMDocument *
  53     create_dom (const ACE_TCHAR *uri) const;
  54
  55     XERCES_CPP_NAMESPACE::DOMDocument *
  56     create_dom (const ACE_TCHAR *root,
  57                 const ACE_TCHAR *ns,
  58                 XERCES_CPP_NAMESPACE::DOMDocumentType * doctype = 0) const;
  59
  60     XERCES_CPP_NAMESPACE::DOMDocumentType *
  61     create_doctype (const ACE_TCHAR *qn,
  62                     const ACE_TCHAR *pid,
  63                     const ACE_TCHAR *sid) const;
  64
  65     /// Writes out a DOMDocument to an XML file
  66     bool write_DOM (XERCES_CPP_NAMESPACE::DOMDocument *doc,
  67                     const ACE_TCHAR *file) const;
  68
  69     bool is_initialized () const;
  70
  71     /// Terminate the parser
  72     void terminate_parser ();
  73
  74     Resolver &get_resolver ();
  75
  76     Error_Handler &get_error_handler ();
  77
  78   protected:
  79     /// Initialize the parser
  80     void init_parser ();
  81
  82   private:
  83     bool initialized_ { false };
  84     XERCES_CPP_NAMESPACE::DOMImplementation *impl_ {};
  85     mutable std::unique_ptr<XERCES_CPP_NAMESPACE::XercesDOMParser> parser_;
  86
  87     Resolver *resolver_;
  88     bool release_resolver_ { false };
  89     Error_Handler *e_handler_;
  90     bool release_e_handler_ { false };
  91   };
  92 }
  93
  94 #include "XML_Helper.tpp"
  95
  96 #include /**/ "ace/post.h"
  97 #endif/*ACE_XML_HELPER_H*/