ACE/ACEXML/common/Attributes_Def_Builder.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    Attributes_Def_Builder.h
   6  *
   7  *  @author Nanbor Wang <nanbor@cs.wustl.edu>
   8  */
   9 //=============================================================================
  10 #ifndef _ACEXML_ATTRIBUTES_DEF_BUILDER_H_
  11 #define _ACEXML_ATTRIBUTES_DEF_BUILDER_H_
  12
  13 #include /**/ "ace/pre.h"
  14 #include "ACEXML/common/ACEXML_Export.h"
  15
  16 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  17 #pragma once
  18 #endif /* ACE_LACKS_PRAGMA_ONCE */
  19
  20 #include "ACEXML/common/XML_Types.h"
  21 #include "ACEXML/common/SAXExceptions.h"
  22 #include <memory>
  23
  24 /**
  25  * @class ACEXML_Attribute_Def_Builder
  26  *
  27  * @brief An abstract virtual class defining an interface for building an
  28  *        attribute definition from DTD.
  29  *
  30  * This class should be invisible to application programmers and is only
  31  * used for validator implementors.
  32  */
  33 class ACEXML_Export ACEXML_Attribute_Def_Builder
  34 {
  35 public:
  36   typedef std::unique_ptr<ACEXML_Attribute_Def_Builder> VAR;
  37
  38   enum ATT_TYPE {
  39     CDATA,
  40     ID,
  41     IDREF,
  42     IDREFS,
  43     ENTITY,
  44     ENTITIES,
  45     NMTOKEN,
  46     NMTOKENS,
  47     NOTATION,
  48     ENUMERATION,
  49     ERROR_TYPE
  50   };
  51
  52   enum DEFAULT_DECL {
  53     REQUIRED,
  54     IMPLIED,
  55     FIXED,
  56     INVALID
  57   };
  58
  59   virtual ~ACEXML_Attribute_Def_Builder () = 0;
  60
  61   /**
  62    * Specify the name of the attribute.
  63    */
  64   virtual int setName (const ACEXML_Char *n) = 0;
  65
  66   /**
  67    * Get the name of the attribute.
  68    */
  69   virtual const ACEXML_Char *getName () = 0;
  70
  71   /**
  72    * Set the attribute type.
  73    */
  74   virtual int setAttType (const ATT_TYPE type) = 0;
  75
  76   /**
  77    * Insert an element for NOTATION or ENUMERATION type attribute.
  78    */
  79   virtual int insertList (const ACEXML_Char *Name) = 0;
  80
  81   /**
  82    * Set default attribute declaration.
  83    */
  84   virtual int setDefault (const DEFAULT_DECL def,
  85                           const ACEXML_Char *value) = 0;
  86
  87   /**
  88    * Check validity of the current attribute definition being built.
  89    *
  90    * @retval 0 if the attribute is not a valid combo.
  91    */
  92   virtual int validAttr () = 0;
  93
  94   /**
  95    * Dump the content of the attribute definition.
  96    */
  97   virtual void dump () = 0;
  98 };
  99
 100 /**
 101  * @ class ACEXML_Attributes_Def_Builder Attributes_Def_Builder.h "common/Attributes_Def_Builder.h"
 102  *
 103  * @ brief An abstract virtual class defining an interface for building
 104  *         attribute definitions from DTD.
 105  *
 106  * This class should be invisible to application programmers and
 107  * is only used for validator implementors.
 108  */
 109 class ACEXML_Export ACEXML_Attributes_Def_Builder
 110 {
 111 public:
 112   typedef std::unique_ptr<ACEXML_Attributes_Def_Builder> VAR;
 113
 114   virtual ~ACEXML_Attributes_Def_Builder () = 0;
 115
 116   /**
 117    * Set the element name that the attribute builder applies.
 118    *
 119    * @retval 0 if valid, -1 otherwise.
 120    */
 121   virtual int setElement (const ACEXML_Char *namespaceURI,
 122                           const ACEXML_Char *localName,
 123                           const ACEXML_Char *qName) = 0;
 124
 125   /**
 126    * Acquire an Attribute_Builder.
 127    */
 128   virtual ACEXML_Attribute_Def_Builder *getAttribute_Def_Builder () = 0;
 129
 130   /**
 131    * Add a definition for one attribute.
 132    */
 133   virtual int insertAttribute (ACEXML_Attribute_Def_Builder *def) = 0;
 134
 135
 136   /**
 137    * Dump the content of the attribute definition.
 138    */
 139   virtual void dump () = 0;
 140 };
 141
 142 #include /**/ "ace/post.h"
 143
 144 #endif /* _ACEXML_ATTRIBUTES_DEF_BUILDER_H_ */