ACE/ACEXML/parser/debug_validator/Debug_Attributes_Builder.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file   Debug_Attributes_Builder.h
   6  *
   7  *  @author Nanbor Wang <nanbor@cs.wustl.edu>
   8  */
   9 //=============================================================================
  10 #ifndef _ACEXML_DEBUG_ATTRIBUTES_BUILDER_H_
  11 #define _ACEXML_DEBUG_ATTRIBUTES_BUILDER_H_
  12
  13 #include /**/ "ace/pre.h"
  14 #include "ACEXML/parser/debug_validator/Debug_DTD_Manager_Export.h"
  15
  16 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  17 #pragma once
  18 #endif /* ACE_LACKS_PRAGMA_ONCE */
  19
  20 #include "ACEXML/common/Attributes_Def_Builder.h"
  21 #include "ace/Hash_Map_Manager.h"
  22 #include "ace/Unbounded_Queue.h"
  23
  24 typedef ACE_Unbounded_Queue<ACEXML_String> ACEXML_STRING_QUEUE;
  25 typedef ACE_Unbounded_Queue_Iterator<ACEXML_String> ACEXML_STRING_QUEUE_ITERATOR;
  26
  27 /**
  28  * @class ACEXML_Debug_Attribute_Builder Debug_Attributes_Builder.h "parser/debug_validator/Debug_Attributes_Builder.h"
  29  *
  30  * This class prints out the Attribute definition for debugging purpose.
  31  */
  32 class ACEXML_DEBUG_DTD_MANAGER_Export ACEXML_Debug_Attribute_Builder
  33   : public ACEXML_Attribute_Def_Builder
  34 {
  35 public:
  36   ACEXML_Debug_Attribute_Builder ();
  37
  38   ACEXML_Debug_Attribute_Builder (const ACEXML_Debug_Attribute_Builder &rhs);
  39
  40   virtual ~ACEXML_Debug_Attribute_Builder ();
  41
  42   /**
  43    * Specify the name of the attribute.
  44    */
  45   virtual int setName (const ACEXML_Char *n);
  46   virtual const ACEXML_Char *getName ();
  47
  48   /**
  49    * Set the attribute type.
  50    */
  51   virtual int setAttType (const ATT_TYPE type);
  52
  53   /**
  54    * Insert an element for NOTATION or ENUMERATION type attribute.
  55    */
  56   virtual int insertList (const ACEXML_Char *Name);
  57
  58   /**
  59    * Set default attribute declaration.
  60    */
  61   virtual int setDefault (const DEFAULT_DECL def, const ACEXML_Char *value);
  62
  63   /**
  64    * Check validity of the current attribute definition being built.
  65    *
  66    * @retval 0 if the attribute is not a valid combo.
  67    */
  68   virtual int validAttr ();
  69
  70
  71   /**
  72    * Dump the content of the attribute definition.
  73    */
  74   virtual void dump ();
  75 private:
  76   /// Attribute name.
  77   ACEXML_String name_;
  78
  79   /// Type of attribute.
  80   ATT_TYPE type_;
  81
  82   /// Default value type.
  83   DEFAULT_DECL default_decl_;
  84
  85   /// Default attribute value.
  86   ACEXML_String default_value_;
  87
  88   /// Holds a queue of enumerated attribute values.
  89   ACEXML_STRING_QUEUE att_value_queue_;
  90 };
  91
  92 typedef ACE_Hash_Map_Entry<ACEXML_String,
  93                            ACEXML_Debug_Attribute_Builder> ACEXML_ATT_MAP_ENTRY;
  94
  95 typedef ACE_Hash_Map_Manager_Ex <ACEXML_String,
  96                                  ACEXML_Debug_Attribute_Builder,
  97                                  ACE_Hash<ACEXML_String>,
  98                                  ACE_Equal_To<ACEXML_String>,
  99                                  ACE_Null_Mutex> ACEXML_ATT_MAP;
 100
 101 typedef ACE_Hash_Map_Iterator_Ex<ACEXML_String,
 102                                  ACEXML_Debug_Attribute_Builder,
 103                                  ACE_Hash<ACEXML_String>,
 104                                  ACE_Equal_To<ACEXML_String>,
 105                                  ACE_Null_Mutex> ACEXML_ATT_MAP_ITER;
 106
 107 typedef ACE_Hash_Map_Reverse_Iterator_Ex<ACEXML_String,
 108                                          ACEXML_Debug_Attribute_Builder,
 109                                          ACE_Hash<ACEXML_String>,
 110                                          ACE_Equal_To<ACEXML_String>,
 111                                          ACE_Null_Mutex> ACEXML_ATT_MAP_REVERSE_ITER;
 112
 113 /**
 114  * @class ACEXML_Debug_Attributes_Builder Debug_Attributes_Builder.h "parser/debug_validator/Debug_Attributes_Builder.h"
 115  *
 116  * This class prints out Attribute definitions for debugging purpose.
 117  */
 118 class ACEXML_DEBUG_DTD_MANAGER_Export ACEXML_Debug_Attributes_Builder
 119   : public ACEXML_Attributes_Def_Builder
 120 {
 121 public:
 122   ACEXML_Debug_Attributes_Builder ();
 123
 124   virtual ~ACEXML_Debug_Attributes_Builder ();
 125
 126   /**
 127    * Set the element name that the attribute builder applies.
 128    *
 129    * @retval 0 if valid, -1 otherwise.
 130    */
 131   virtual int setElement (const ACEXML_Char *namespaceURI,
 132                           const ACEXML_Char *localName,
 133                           const ACEXML_Char *qName ACEXML_ENV_ARG_DECL)
 134     ;
 135
 136   /**
 137    * Acquire an Attribute_Builder.
 138    */
 139   virtual ACEXML_Attribute_Def_Builder *getAttribute_Def_Builder ();
 140
 141   /**
 142    * Add a definition for one attribute.
 143    */
 144   virtual int insertAttribute (ACEXML_Attribute_Def_Builder *def ACEXML_ENV_ARG_DECL);
 145
 146
 147   /**
 148    * Dump the content of the attribute definition.
 149    */
 150   virtual void dump ();
 151 protected:
 152   /// The name of the element type these attributes applied.
 153   ACEXML_String element_name_;
 154
 155   /// Collection of attributes.
 156   ACEXML_ATT_MAP attributes_;
 157 };
 158
 159
 160 #include /**/ "ace/post.h"
 161
 162 #endif /* _ACEXML_DEBUG_ATTRIBUTES_BUILDER_H_ */