HandlerBase.hpp Source File

00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 1999-2000 The Apache Software Foundation.  All rights
00005  * reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  *
00014  * 2. Redistributions in binary form must reproduce the above copyright
00015  *    notice, this list of conditions and the following disclaimer in
00016  *    the documentation and/or other materials provided with the
00017  *    distribution.
00018  *
00019  * 3. The end-user documentation included with the redistribution,
00020  *    if any, must include the following acknowledgment:
00021  *       "This product includes software developed by the
00022  *        Apache Software Foundation (http://www.apache.org/)."
00023  *    Alternately, this acknowledgment may appear in the software itself,
00024  *    if and wherever such third-party acknowledgments normally appear.
00025  *
00026  * 4. The names "Xerces" and "Apache Software Foundation" must
00027  *    not be used to endorse or promote products derived from this
00028  *    software without prior written permission. For written
00029  *    permission, please contact apache\@apache.org.
00030  *
00031  * 5. Products derived from this software may not be called "Apache",
00032  *    nor may "Apache" appear in their name, without prior written
00033  *    permission of the Apache Software Foundation.
00034  *
00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00046  * SUCH DAMAGE.
00047  * ====================================================================
00048  *
00049  * This software consists of voluntary contributions made by many
00050  * individuals on behalf of the Apache Software Foundation, and was
00051  * originally based on software copyright (c) 1999, International
00052  * Business Machines, Inc., http://www.ibm.com .  For more information
00053  * on the Apache Software Foundation, please see
00054  * <http://www.apache.org/>.
00055  */
00056 
00057 /*
00058  * $Log: HandlerBase.hpp,v $
00059  * Revision 1.8  2004/01/29 11:46:32  cargilld
00060  * Code cleanup changes to get rid of various compiler diagnostic messages.
00061  *
00062  * Revision 1.7  2003/12/01 23:23:26  neilg
00063  * fix for bug 25118; thanks to Jeroen Witmond
00064  *
00065  * Revision 1.6  2003/05/30 16:11:44  gareth
00066  * Fixes so we compile under VC7.1. Patch by Alberto Massari.
00067  *
00068  * Revision 1.5  2002/11/04 14:56:25  tng
00069  * C++ Namespace Support.
00070  *
00071  * Revision 1.4  2002/07/16 18:15:00  tng
00072  * [Bug 6070] warning unused variable in HandlerBase.hpp
00073  *
00074  * Revision 1.3  2002/06/06 20:39:16  tng
00075  * Document Fix: document that the returned object from resolveEntity is owned by the parser
00076  *
00077  * Revision 1.2  2002/02/20 18:17:01  tng
00078  * [Bug 5977] Warnings on generating apiDocs.
00079  *
00080  * Revision 1.1.1.1  2002/02/01 22:22:08  peiyongz
00081  * sane_include
00082  *
00083  * Revision 1.6  2000/03/02 19:54:35  roddey
00084  * This checkin includes many changes done while waiting for the
00085  * 1.1.0 code to be finished. I can't list them all here, but a list is
00086  * available elsewhere.
00087  *
00088  * Revision 1.5  2000/02/24 20:12:55  abagchi
00089  * Swat for removing Log from API docs
00090  *
00091  * Revision 1.4  2000/02/12 03:31:55  rahulj
00092  * Removed duplicate CVS Log entries.
00093  *
00094  * Revision 1.3  2000/02/12 01:27:19  aruna1
00095  * Documentation updated
00096  *
00097  * Revision 1.2  2000/02/06 07:47:57  rahulj
00098  * Year 2K copyright swat.
00099  *
00100  * Revision 1.1.1.1  1999/11/09 01:07:45  twl
00101  * Initial checkin
00102  *
00103  * Revision 1.2  1999/11/08 20:45:00  rahul
00104  * Swat for adding in Product name and CVS comment log variable.
00105  *
00106  */
00107 
00108 
00109 #ifndef HANDLERBASE_HPP
00110 #define HANDLERBASE_HPP
00111 
00112 #include <xercesc/sax/DocumentHandler.hpp>
00113 #include <xercesc/sax/DTDHandler.hpp>
00114 #include <xercesc/sax/EntityResolver.hpp>
00115 #include <xercesc/sax/ErrorHandler.hpp>
00116 #include <xercesc/sax/SAXParseException.hpp>
00117 
00118 XERCES_CPP_NAMESPACE_BEGIN
00119 
00120 class Locator;
00121 class AttributeList;
00122 
00143 class  HandlerBase :
00144 
00145     public EntityResolver, public DTDHandler, public DocumentHandler
00146     , public ErrorHandler
00147 {
00148 public:
00166     virtual void characters
00167     (
00168         const   XMLCh* const    chars
00169         , const unsigned int    length
00170     );
00171 
00184     virtual void endDocument();
00185 
00199     virtual void endElement(const XMLCh* const name);
00200 
00216     virtual void ignorableWhitespace
00217     (
00218         const   XMLCh* const    chars
00219         , const unsigned int    length
00220     );
00221 
00237     virtual void processingInstruction
00238     (
00239         const   XMLCh* const    target
00240         , const XMLCh* const    data
00241     );
00242 
00248     virtual void resetDocument();
00250 
00265     virtual void setDocumentLocator(const Locator* const locator);
00266 
00279     virtual void startDocument();
00280 
00295     virtual void startElement
00296     (
00297         const   XMLCh* const    name
00298         ,       AttributeList&  attributes
00299     );
00300 
00302 
00327     virtual InputSource* resolveEntity
00328     (
00329         const   XMLCh* const    publicId
00330         , const XMLCh* const    systemId
00331     );
00332 
00334 
00351     virtual void error(const SAXParseException& exc);
00352 
00370     virtual void fatalError(const SAXParseException& exc);
00371 
00386     virtual void warning(const SAXParseException& exc);
00387 
00393     virtual void resetErrors();
00394 
00396 
00397 
00400 
00414     virtual void notationDecl
00415     (
00416         const   XMLCh* const    name
00417         , const XMLCh* const    publicId
00418         , const XMLCh* const    systemId
00419     );
00420 
00426     virtual void resetDocType();
00427 
00442     virtual void unparsedEntityDecl
00443     (
00444         const   XMLCh* const    name
00445         , const XMLCh* const    publicId
00446         , const XMLCh* const    systemId
00447         , const XMLCh* const    notationName
00448     );
00450 
00451     HandlerBase() {};
00452     virtual ~HandlerBase() {};
00453 
00454 private:
00455     // -----------------------------------------------------------------------
00456     //  Unimplemented constructors and operators
00457     // -----------------------------------------------------------------------
00458     HandlerBase(const HandlerBase&);
00459     HandlerBase& operator=(const HandlerBase&);
00460 };
00461 
00462 
00463 // ---------------------------------------------------------------------------
00464 //  HandlerBase: Inline default implementations
00465 // ---------------------------------------------------------------------------
00466 inline void HandlerBase::characters(const   XMLCh* const
00467                                     , const unsigned int)
00468 {
00469 }
00470 
00471 inline void HandlerBase::endDocument()
00472 {
00473 }
00474 
00475 inline void HandlerBase::endElement(const XMLCh* const)
00476 {
00477 }
00478 
00479 inline void HandlerBase::error(const SAXParseException&)
00480 {
00481 }
00482 
00483 inline void HandlerBase::fatalError(const SAXParseException& exc)
00484 {
00485     throw exc;
00486 }
00487 
00488 inline void
00489 HandlerBase::ignorableWhitespace(   const   XMLCh* const
00490                                     , const unsigned int)
00491 {
00492 }
00493 
00494 inline void HandlerBase::notationDecl(  const   XMLCh* const
00495                                         , const XMLCh* const
00496                                         , const XMLCh* const)
00497 {
00498 }
00499 
00500 inline void
00501 HandlerBase::processingInstruction( const   XMLCh* const
00502                                     , const XMLCh* const)
00503 {
00504 }
00505 
00506 inline void HandlerBase::resetErrors()
00507 {
00508 }
00509 
00510 inline void HandlerBase::resetDocument()
00511 {
00512 }
00513 
00514 inline void HandlerBase::resetDocType()
00515 {
00516 }
00517 
00518 inline InputSource*
00519 HandlerBase::resolveEntity( const   XMLCh* const
00520                             , const XMLCh* const)
00521 {
00522     return 0;
00523 }
00524 
00525 inline void
00526 HandlerBase::unparsedEntityDecl(const   XMLCh* const
00527                                 , const XMLCh* const
00528                                 , const XMLCh* const
00529                                 , const XMLCh* const)
00530 {
00531 }
00532 
00533 inline void HandlerBase::setDocumentLocator(const Locator* const)
00534 {
00535 }
00536 
00537 inline void HandlerBase::startDocument()
00538 {
00539 }
00540 
00541 inline void
00542 HandlerBase::startElement(  const   XMLCh* const
00543                             ,       AttributeList&)
00544 {
00545 }
00546 
00547 inline void HandlerBase::warning(const SAXParseException&)
00548 {
00549 }
00550 
00551 XERCES_CPP_NAMESPACE_END
00552 
00553 #endif