XML_File_Intf.h

Go to the documentation of this file.

//==============================================================
/**
 *  @file  XML_File_Intf.h
 *
 *
 *  @author Marcel Smit (msmit@remedy.nl)
 *  @author Danilo C. Zanella (dczanella@gmail.com)
 */
//================================================================

#ifndef OPENDDS_DCPS_QOS_XML_HANDLER_XML_FILE_INTF_H
#define OPENDDS_DCPS_QOS_XML_HANDLER_XML_FILE_INTF_H
#include /**/ "ace/pre.h"

#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */

#include "dds_qos.hpp"
#include "XML_Intf.h"
#include "dds/DdsDcpsInfrastructureC.h"
#include "ace/XML_Utils/XML_Helper.h"
#include "OpenDDS_XML_QOS_Handler_Export.h"

namespace XML
{
  struct Environment_Resolver;
  template <typename Resolver>
  class XML_Schema_Resolver;
  class XML_Error_Handler;
}

OPENDDS_BEGIN_VERSIONED_NAMESPACE_DECL

namespace OpenDDS {
namespace DCPS {

  class OpenDDS_XML_QOS_Handler_Export QOS_XML_File_Handler :
    public QOS_XML_Handler
  {
  public:
    /// Pass an optional @error_handler which is called back when
    /// there are any errors parsing the input XML. The QOS_XML_File_Handler
    /// will assume ownership when a pointer is passed
    explicit QOS_XML_File_Handler(XML::XML_Error_Handler* error_handler = 0);

    ~QOS_XML_File_Handler();

    /**
     * The init method will open the file and will validate
     * it against the schema. It returns RETCODE_ERROR
     * when any error occurs during parsing
     */
    DDS::ReturnCode_t init(const ACE_TCHAR * file);

    /**
     * add_search_path will add a relative path to the XML
     * parsing library. The XML parsing library will use
     * this path to search for the schema
     */
    void
    add_search_path(const ACE_TCHAR *environment,
                    const ACE_TCHAR *relpath);

  private:
    typedef XML::XML_Schema_Resolver<XML::Environment_Resolver> XML_RESOLVER;
    typedef XML::XML_Helper<XML_RESOLVER, XML::XML_Error_Handler> XML_HELPER;

    /// Schema resolver
    XML_RESOLVER *res_;

    /// Error handler
    XML::XML_Error_Handler *eh_;

    /// XML Helper
    XML_HELPER helper_;
  };
}
}

OPENDDS_END_VERSIONED_NAMESPACE_DECL

#include /**/ "ace/post.h"

#endif /* DCPS_CONFIG_XML_FILE_INTF_H */