ACE/ACEXML/parser/debug_validator/Element_Tree.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    Element_Tree.h
   6  *
   7  *  @author Nanbor Wang <nanbor@cs.wustl.edu>
   8  */
   9 //=============================================================================
  10 #ifndef _ACEXML_ELEMENT_TREE_H_
  11 #define _ACEXML_ELEMENT_TREE_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/XML_Types.h"
  21
  22 /**
  23  * @class ACEXML_Element_Tree_Node Element_Tree.h "parser/debug_validator/Element_Tree.h"
  24  *
  25  * @brief An abstract base class for describing DTD child element definition.
  26  *
  27  * @sa ACEXML_Element_Tree_Name_Node, ACEXML_Element_Tree_List_Node
  28  */
  29 class ACEXML_DEBUG_DTD_MANAGER_Export ACEXML_Element_Tree_Node
  30 {
  31 public:
  32   /// Default constructor.
  33   ACEXML_Element_Tree_Node ();
  34
  35   /// Destructor
  36   virtual ~ACEXML_Element_Tree_Node ();
  37
  38   /// Accessor for next element in chain
  39   ACEXML_Element_Tree_Node *next ();
  40   void next (ACEXML_Element_Tree_Node *n);
  41
  42   /// Displaying the content.
  43   virtual void dump () = 0;
  44
  45   ACE_ALLOC_HOOK_DECLARE;
  46
  47 protected:
  48   ACEXML_Element_Tree_Node *next_;
  49 };
  50
  51 /**
  52  * @class ACEXML_Element_Tree_Name_Node Element_Tree.h "parser/debug_validator/Element_Tree.h"
  53  *
  54  * @brief An abstract base class for describing a name node in a DTD child
  55  * element definition.
  56  *
  57  * @sa ACEXML_Element_Tree_Node, ACEXML_Element_Tree_List_Node
  58  */
  59 class ACEXML_DEBUG_DTD_MANAGER_Export ACEXML_Element_Tree_Name_Node
  60   : public ACEXML_Element_Tree_Node
  61 {
  62 public:
  63   /// Constructor.
  64   ACEXML_Element_Tree_Name_Node (const ACEXML_Char *name,
  65                                  int release = 1);
  66
  67   /// Change the name of this node.
  68   void set (const ACEXML_Char *name,
  69             int release = 1);
  70
  71   virtual void dump ();
  72
  73   ACE_ALLOC_HOOK_DECLARE;
  74 protected:
  75   ACEXML_String name_;
  76 };
  77
  78 class ACEXML_Element_Tree_List_Stack;
  79
  80 /**
  81  * @class ACEXML_Element_Tree_List_Node Element_Tree.h "parser/debug_validator/Element_Tree.h"
  82  *
  83  * @brief An abstract base class for describing a node list in a DTD child
  84  * element definition.
  85  *
  86  * @sa ACEXML_Element_Tree_Node, ACEXML_Element_Tree_Name_Node
  87  */
  88 class ACEXML_DEBUG_DTD_MANAGER_Export ACEXML_Element_Tree_List_Node
  89   : public ACEXML_Element_Tree_Node
  90 {
  91 public:
  92   friend class ACEXML_Element_Tree_List_Stack;
  93
  94   typedef enum {
  95     SEQUENCE,
  96     CHOICE
  97   } LIST_TYPE;
  98
  99   /// Default constructor.
 100   ACEXML_Element_Tree_List_Node ();
 101
 102   /// Destructor.
 103   virtual ~ACEXML_Element_Tree_List_Node ();
 104
 105   /// Insert a new ACEXML_Element_Tree_Node into the list.
 106   int insert (ACEXML_Element_Tree_Node *node);
 107
 108   /// Get/set the type of list.
 109   LIST_TYPE get ();
 110   int set (LIST_TYPE type);
 111
 112   virtual void dump ();
 113
 114   ACE_ALLOC_HOOK_DECLARE;
 115 protected:
 116   LIST_TYPE type_;
 117
 118   ACEXML_Element_Tree_Node *head_;
 119
 120   ACEXML_Element_Tree_Node *tail_;
 121
 122   ACEXML_Element_Tree_List_Node *pop_next_;
 123 };
 124
 125 /**
 126  * @class ACEXML_Element_Tree_List_Stack Element_Tree.h "parser/debug_validator/Element_Tree.h"
 127  *
 128  * @brief A class for managing a stack of ACEXML_Element_Tree_List_Node's.
 129  *
 130  * @sa ACEXML_Element_Tree_List_Node
 131  */
 132 class ACEXML_DEBUG_DTD_MANAGER_Export ACEXML_Element_Tree_List_Stack
 133 {
 134 public:
 135   ACEXML_Element_Tree_List_Stack ();
 136
 137   void push (ACEXML_Element_Tree_List_Node *n);
 138
 139   ACEXML_Element_Tree_List_Node *pop ();
 140
 141   ACEXML_Element_Tree_List_Node *top ();
 142
 143   int empty ();
 144
 145   ACE_ALLOC_HOOK_DECLARE;
 146
 147 protected:
 148   ACEXML_Element_Tree_List_Node *top_;
 149 };
 150
 151 #if defined (__ACEXML_INLINE__)
 152 # include "ACEXML/parser/debug_validator/Element_Tree.inl"
 153 #endif /* __ACEXML_INLINE__ */
 154
 155 #include /**/ "ace/post.h"
 156
 157 #endif /* _ACEXML_ELEMENT_TREE_H_ */