ACE/ACEXML/common/XMLFilterImpl.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    XMLFilterImpl.h
   6  *
   7  *  @author Nanbor Wang <nanbor@cs.wustl.edu>
   8  */
   9 //=============================================================================
  10 #ifndef ACEXML_XMLFILTERIMPL_H
  11 #define ACEXML_XMLFILTERIMPL_H
  12 #include /**/ "ace/pre.h"
  13
  14 #include "ACEXML/common/XMLFilter.h"
  15 #include "ACEXML/common/XMLReader.h"
  16 #include "ACEXML/common/Locator.h"
  17 #include "ACEXML/common/ContentHandler.h"
  18 #include "ACEXML/common/DTDHandler.h"
  19 #include "ACEXML/common/EntityResolver.h"
  20 #include "ACEXML/common/ErrorHandler.h"
  21
  22 /**
  23  * @class ACEXML_XMLFilterImpl
  24  *
  25  * @brief ACEXML_XMLFilterImpl
  26  *
  27  * This class is designed to sit between an XMLReader and the client
  28  * application's event handlers. By default, it does nothing but pass
  29  * requests up to the reader and events on to the handlers unmodified, but
  30  * subclasses can override specific methods to modify the event stream or
  31  * the configuration requests as they pass through.
  32  */
  33 class ACEXML_Export ACEXML_XMLFilterImpl
  34   : public ACEXML_XMLFilter,
  35     public ACEXML_ContentHandler,
  36     public ACEXML_DTDHandler,
  37     public ACEXML_EntityResolver,
  38     public ACEXML_ErrorHandler
  39 {
  40 public:
  41   /**
  42    * Default constructor.  Create with no parent.
  43    */
  44   ACEXML_XMLFilterImpl ();
  45
  46   /**
  47    * Construct an XML filter with the specified parent.
  48    */
  49   ACEXML_XMLFilterImpl (ACEXML_XMLReader *parent);
  50
  51   /**
  52    * Destructor.
  53    */
  54   virtual ~ACEXML_XMLFilterImpl ();
  55
  56   /*
  57    * Look up the value of a feature.
  58    */
  59   virtual int getFeature (const ACEXML_Char *name);
  60
  61   /*
  62    * Look up the value of a property.
  63    */
  64   virtual void * getProperty (const ACEXML_Char *name);
  65
  66   /*
  67    * Parse an XML document.
  68    */
  69   virtual void parse (ACEXML_InputSource *input);
  70
  71   /*
  72    * Parse an XML document from a system identifier (URI).
  73    */
  74   virtual void parse (const ACEXML_Char *systemId);
  75
  76   /*
  77    * Set the state of a feature.
  78    */
  79   virtual void setFeature (const ACEXML_Char *name, int boolean_value);
  80
  81   /*
  82    * Set the value of a property.
  83    */
  84   virtual void setProperty (const ACEXML_Char *name, void *value);
  85
  86   /*
  87    * Get the parent reader.
  88    */
  89   virtual ACEXML_XMLReader *getParent () const;
  90
  91   /*
  92    * Set the parent reader.
  93    */
  94   virtual void setParent (ACEXML_XMLReader *parent);
  95
  96   /*
  97    * Get the current DTD event handler.
  98    */
  99   virtual ACEXML_DTDHandler *getDTDHandler () const;
 100
 101   /*
 102    * Get the current content event handler.
 103    */
 104   virtual ACEXML_ContentHandler *getContentHandler () const;
 105
 106   /*
 107    * Get the current entity resolver.
 108    */
 109   virtual ACEXML_EntityResolver *getEntityResolver () const;
 110
 111   /*
 112    * Get the current error event handler.
 113    */
 114   virtual ACEXML_ErrorHandler *getErrorHandler () const;
 115
 116   /*
 117    * Set the DTD event handler.
 118    */
 119   virtual void setDTDHandler (ACEXML_DTDHandler *handler);
 120
 121   /*
 122    * Set the content event handler.
 123    */
 124   virtual void setContentHandler (ACEXML_ContentHandler *handler);
 125
 126   /*
 127    * Set the entity resolver.
 128    */
 129   virtual void setEntityResolver (ACEXML_EntityResolver *handler);
 130
 131   /*
 132    * Set the error event handler.
 133    */
 134   virtual void setErrorHandler (ACEXML_ErrorHandler *handler);
 135
 136   /*
 137    * Receive notification of character data.
 138    */
 139   virtual void characters (const ACEXML_Char *ch,
 140                            size_t start,
 141                            size_t length);
 142
 143   /*
 144    * Receive notification of the end of a document.
 145    */
 146   virtual void endDocument ();
 147
 148   /*
 149    * Receive notification of the end of an element.
 150    */
 151   virtual void endElement (const ACEXML_Char *namespaceURI,
 152                            const ACEXML_Char *localName,
 153                            const ACEXML_Char *qName);
 154
 155   /*
 156    * End the scope of a prefix-URI mapping.
 157    */
 158   virtual void endPrefixMapping (const ACEXML_Char *prefix);
 159
 160   /*
 161    * Receive notification of ignorable whitespace in element content.
 162    */
 163   virtual void ignorableWhitespace (const ACEXML_Char *ch,
 164                                     int start,
 165                                     int length);
 166
 167   /*
 168    * Receive notification of a processing instruction.
 169    */
 170   virtual void processingInstruction (const ACEXML_Char *target,
 171                                       const ACEXML_Char *data);
 172
 173   /*
 174    * Receive an object for locating the origin of SAX document events.
 175    */
 176   virtual void setDocumentLocator (ACEXML_Locator *locator) ;
 177
 178   /*
 179    * Receive notification of a skipped entity.
 180    */
 181   virtual void skippedEntity (const ACEXML_Char *name);
 182
 183   /*
 184    * Receive notification of the beginning of a document.
 185    */
 186   virtual void startDocument ();
 187
 188   /*
 189    * Receive notification of the beginning of an element.
 190    */
 191   virtual void startElement (const ACEXML_Char *namespaceURI,
 192                              const ACEXML_Char *localName,
 193                              const ACEXML_Char *qName,
 194                              ACEXML_Attributes *atts);
 195
 196   /*
 197    * Begin the scope of a prefix-URI Namespace mapping.
 198    */
 199   virtual void startPrefixMapping (const ACEXML_Char *prefix,
 200                                    const ACEXML_Char *uri);
 201
 202   // *** Methods inherit from ACEXML_DTDHandler.
 203
 204   /*
 205    * Receive notification of a notation declaration event.
 206    */
 207   virtual void notationDecl (const ACEXML_Char *name,
 208                              const ACEXML_Char *publicId,
 209                              const ACEXML_Char *systemId);
 210
 211   /*
 212    * Receive notification of an unparsed entity declaration event.
 213    */
 214   virtual void unparsedEntityDecl (const ACEXML_Char *name,
 215                                    const ACEXML_Char *publicId,
 216                                    const ACEXML_Char *systemId,
 217                                    const ACEXML_Char *notationName);
 218
 219   // Methods inherit from ACEXML_EnitityResolver.
 220
 221   /*
 222    * Allow the application to resolve external entities.
 223    */
 224   virtual ACEXML_InputSource *resolveEntity (const ACEXML_Char *publicId,
 225                                              const ACEXML_Char *systemId);
 226
 227   // Methods inherit from ACEXML_ErrorHandler.
 228
 229   /*
 230    * Receive notification of a recoverable error.
 231    */
 232   virtual void error (ACEXML_SAXParseException &exception);
 233
 234   /*
 235    * Receive notification of a non-recoverable error.
 236    */
 237   virtual void fatalError (ACEXML_SAXParseException &exception);
 238
 239   /*
 240    * Receive notification of a warning.
 241    */
 242   virtual void warning (ACEXML_SAXParseException &exception);
 243 protected:
 244   int setupParser ();
 245   // Set up the event handlers of parent parser to this.
 246   // Returns -1 if no valid parent is set.
 247
 248 private:
 249   ACEXML_XMLReader *parent_;
 250   // ACEXML_Locator *locator_;
 251   ACEXML_EntityResolver *entityResolver_;
 252   ACEXML_DTDHandler *dtdHandler_;
 253   ACEXML_ContentHandler *contentHandler_;
 254   ACEXML_ErrorHandler *errorHandler_;
 255 };
 256
 257 #if defined (__ACEXML_INLINE__)
 258 # include "ACEXML/common/XMLFilterImpl.inl"
 259 #endif /* __ACEXML_INLINE__ */
 260
 261 #include /**/ "ace/post.h"
 262
 263 #endif /* ACEXML_XMLFILTERIMPL_H */