ACE/ACEXML/examples/SAXPrint/SAXPrint_Handler.h

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