// -*- C++ -*-

//=============================================================================
/**
 *  @file    DTD_Manager.h
 *
 *  @author Nanbor Wang <nanbor@cs.wustl.edu>
 */
//=============================================================================
#ifndef _ACEXML_DTD_Manager_H_
#define _ACEXML_DTD_Manager_H_

#include /**/ "ace/pre.h"
#include "ACEXML/common/ACEXML_Export.h"

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

#include "ACEXML/common/Attributes_Def_Builder.h"
#include "ACEXML/common/Element_Def_Builder.h"
#include "ACEXML/common/Validator.h"

/**
 * @class ACEXML_DTD_Manager
 *
 * @todo Fill in the blank.
 */
class ACEXML_Export ACEXML_DTD_Manager
{
public:
  virtual ~ACEXML_DTD_Manager () = 0;

  /**
   * Acquire a pointer to an element definition builder.
   * The XML parser use this interface to acquire the
   * definition builder and use the builder to create
   * the DTD element definition.  The resulting builder
   * is then registered with the DTD Manager or destroyed
   * if error occurred when the builder encountered errors.
   *
   * @retval 0 if error occurs creating the builder.
   */
  virtual ACEXML_Element_Def_Builder *getElement_Def_Builder () = 0;

  /**
   * Insert a new element definition into the DTD Manager.
   *
   * @retval 0 if success, -1 if error.
   */
  virtual int insertElement_Definition (ACEXML_Element_Def_Builder *def) = 0;

  /**
   * Acquire a pointer to an attributes definition builder.
   *
   */
  virtual ACEXML_Attributes_Def_Builder *getAttribute_Def_Builder () = 0;

  /**
   * Insert a new attributes definition into the DTD Manager.
   *
   * @retval 0 if success, -1 otherwise.
   */
  virtual int insertAttributes_Definition (ACEXML_Attributes_Def_Builder *def) = 0;

  /**
   * Acquire an element validator to validate an XML element.
   *
   * @todo I haven't figured out what memory management scheme
   *       we should use for the acquired validator.
   */
  virtual ACEXML_Validator *getValidator (const ACEXML_Char *namespaceURI,
                                          const ACEXML_Char *localName,
                                          const ACEXML_Char *qName) = 0;
};


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

#endif /* _ACEXML_DTD_Manager_H_ */
