ACE/ACEXML/examples/SAXPrint/Print_Handler.h

   1 //=============================================================================
   2 /**
   3  *  @file    Print_Handler.h
   4  *
   5  *  @author Nanbor Wang <nanbor@cs.wustl.edu>
   6  */
   7 //=============================================================================
   8
   9 #ifndef ACEXML_PRINT_HANDLER_H
  10 #define ACEXML_PRINT_HANDLER_H
  11
  12 #include "ACEXML/common/DefaultHandler.h"
  13
  14 /**
  15  * @class ACEXML_Print_Handler
  16  *
  17  * @brief ACEXML_Print_Handler is an example SAX event handler.
  18  *
  19  * This SAX event handler prints out a detailed event report
  20  * on every event it receives.
  21  */
  22 class ACEXML_Print_Handler : public ACEXML_DefaultHandler
  23 {
  24 public:
  25   /*
  26    * Default constructor.
  27    */
  28   ACEXML_Print_Handler (ACEXML_Char* fileName);
  29
  30   /*
  31    * Default destructor.
  32    */
  33   virtual ~ACEXML_Print_Handler ();
  34
  35   // Methods inherited from ACEXML_ContentHandler.
  36
  37   /*
  38    * Receive notification of character data.
  39    */
  40   virtual void characters (const ACEXML_Char *ch,
  41                            size_t start,
  42                            size_t length);
  43
  44   /*
  45    * Receive notification of the end of a document.
  46    */
  47   virtual void endDocument ();
  48
  49   /*
  50    * Receive notification of the end of an element.
  51    */
  52   virtual void endElement (const ACEXML_Char *namespaceURI,
  53                            const ACEXML_Char *localName,
  54                            const ACEXML_Char *qName);
  55
  56   /*
  57    * End the scope of a prefix-URI mapping.
  58    */
  59   virtual void endPrefixMapping (const ACEXML_Char *prefix);
  60
  61   /*
  62    * Receive notification of ignorable whitespace in element content.
  63    */
  64   virtual void ignorableWhitespace (const ACEXML_Char *ch,
  65                                     int start,
  66                                     int length);
  67
  68   /*
  69    * Receive notification of a processing instruction.
  70    */
  71   virtual void processingInstruction (const ACEXML_Char *target,
  72                                       const ACEXML_Char *data);
  73
  74   /*
  75    * Receive an object for locating the origin of SAX document events.
  76    */
  77   virtual void setDocumentLocator (ACEXML_Locator *locator) ;
  78
  79   /*
  80    * Receive notification of a skipped entity.
  81    */
  82   virtual void skippedEntity (const ACEXML_Char *name);
  83
  84   /*
  85    * Receive notification of the beginning of a document.
  86    */
  87   virtual void startDocument ();
  88
  89   /*
  90    * Receive notification of the beginning of an element.
  91    */
  92   virtual void startElement (const ACEXML_Char *namespaceURI,
  93                              const ACEXML_Char *localName,
  94                              const ACEXML_Char *qName,
  95                              ACEXML_Attributes *atts);
  96
  97   /*
  98    * Begin the scope of a prefix-URI Namespace mapping.
  99    */
 100   virtual void startPrefixMapping (const ACEXML_Char *prefix,
 101                                    const ACEXML_Char *uri);
 102
 103   // *** Methods inherit from ACEXML_DTDHandler.
 104
 105   /*
 106    * Receive notification of a notation declaration event.
 107    */
 108   virtual void notationDecl (const ACEXML_Char *name,
 109                              const ACEXML_Char *publicId,
 110                              const ACEXML_Char *systemId);
 111
 112   /*
 113    * Receive notification of an unparsed entity declaration event.
 114    */
 115   virtual void unparsedEntityDecl (const ACEXML_Char *name,
 116                                    const ACEXML_Char *publicId,
 117                                    const ACEXML_Char *systemId,
 118                                    const ACEXML_Char *notationName);
 119
 120   // Methods inherit from ACEXML_EnitityResolver.
 121
 122   /*
 123    * Allow the application to resolve external entities.
 124    */
 125   virtual ACEXML_InputSource *resolveEntity (const ACEXML_Char *publicId,
 126                                              const ACEXML_Char *systemId);
 127
 128   // Methods inherit from ACEXML_ErrorHandler.
 129
 130   /*
 131    * Receive notification of a recoverable error.
 132    */
 133   virtual void error (ACEXML_SAXParseException &exception);
 134
 135   /*
 136    * Receive notification of a non-recoverable error.
 137    */
 138   virtual void fatalError (ACEXML_SAXParseException &exception);
 139
 140   /*
 141    * Receive notification of a warning.
 142    */
 143   virtual void warning (ACEXML_SAXParseException &exception);
 144 private:
 145   ACEXML_Char* fileName_;
 146   ACEXML_Locator* locator_;
 147 };
 148
 149 #endif /* ACEXML_PRINT_HANDLER_H */