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.7  2003/12/01 23:23:26  neilg
00060  * fix for bug 25118; thanks to Jeroen Witmond
00061  *
00062  * Revision 1.6  2003/05/30 16:11:44  gareth
00063  * Fixes so we compile under VC7.1. Patch by Alberto Massari.
00064  *
00065  * Revision 1.5  2002/11/04 14:56:25  tng
00066  * C++ Namespace Support.
00067  *
00068  * Revision 1.4  2002/07/16 18:15:00  tng
00069  * [Bug 6070] warning unused variable in HandlerBase.hpp
00070  *
00071  * Revision 1.3  2002/06/06 20:39:16  tng
00072  * Document Fix: document that the returned object from resolveEntity is owned by the parser
00073  *
00074  * Revision 1.2  2002/02/20 18:17:01  tng
00075  * [Bug 5977] Warnings on generating apiDocs.
00076  *
00077  * Revision 1.1.1.1  2002/02/01 22:22:08  peiyongz
00078  * sane_include
00079  *
00080  * Revision 1.6  2000/03/02 19:54:35  roddey
00081  * This checkin includes many changes done while waiting for the
00082  * 1.1.0 code to be finished. I can't list them all here, but a list is
00083  * available elsewhere.
00084  *
00085  * Revision 1.5  2000/02/24 20:12:55  abagchi
00086  * Swat for removing Log from API docs
00087  *
00088  * Revision 1.4  2000/02/12 03:31:55  rahulj
00089  * Removed duplicate CVS Log entries.
00090  *
00091  * Revision 1.3  2000/02/12 01:27:19  aruna1
00092  * Documentation updated
00093  *
00094  * Revision 1.2  2000/02/06 07:47:57  rahulj
00095  * Year 2K copyright swat.
00096  *
00097  * Revision 1.1.1.1  1999/11/09 01:07:45  twl
00098  * Initial checkin
00099  *
00100  * Revision 1.2  1999/11/08 20:45:00  rahul
00101  * Swat for adding in Product name and CVS comment log variable.
00102  *
00103  */
00104 
00105 
00106 #ifndef HANDLERBASE_HPP
00107 #define HANDLERBASE_HPP
00108 
00109 #include <xercesc/sax/DocumentHandler.hpp>
00110 #include <xercesc/sax/DTDHandler.hpp>
00111 #include <xercesc/sax/EntityResolver.hpp>
00112 #include <xercesc/sax/ErrorHandler.hpp>
00113 #include <xercesc/sax/SAXParseException.hpp>
00114 
00115 XERCES_CPP_NAMESPACE_BEGIN
00116 
00117 class Locator;
00118 class AttributeList;
00119 
00140 class  HandlerBase :
00141 
00142     public EntityResolver, public DTDHandler, public DocumentHandler
00143     , public ErrorHandler
00144 {
00145 public:
00163     virtual void characters
00164     (
00165         const   XMLCh* const    chars
00166         , const unsigned int    length
00167     );
00168 
00181     virtual void endDocument();
00182 
00196     virtual void endElement(const XMLCh* const name);
00197 
00213     virtual void ignorableWhitespace
00214     (
00215         const   XMLCh* const    chars
00216         , const unsigned int    length
00217     );
00218 
00234     virtual void processingInstruction
00235     (
00236         const   XMLCh* const    target
00237         , const XMLCh* const    data
00238     );
00239 
00245     virtual void resetDocument();
00247 
00262     virtual void setDocumentLocator(const Locator* const locator);
00263 
00276     virtual void startDocument();
00277 
00292     virtual void startElement
00293     (
00294         const   XMLCh* const    name
00295         ,       AttributeList&  attributes
00296     );
00297 
00299 
00324     virtual InputSource* resolveEntity
00325     (
00326         const   XMLCh* const    publicId
00327         , const XMLCh* const    systemId
00328     );
00329 
00331 
00348     virtual void error(const SAXParseException& exc);
00349 
00367     virtual void fatalError(const SAXParseException& exc);
00368 
00383     virtual void warning(const SAXParseException& exc);
00384 
00390     virtual void resetErrors();
00391 
00393 
00394 
00397 
00411     virtual void notationDecl
00412     (
00413         const   XMLCh* const    name
00414         , const XMLCh* const    publicId
00415         , const XMLCh* const    systemId
00416     );
00417 
00423     virtual void resetDocType();
00424 
00439     virtual void unparsedEntityDecl
00440     (
00441         const   XMLCh* const    name
00442         , const XMLCh* const    publicId
00443         , const XMLCh* const    systemId
00444         , const XMLCh* const    notationName
00445     );
00447 };
00448 
00449 
00450 // ---------------------------------------------------------------------------
00451 //  HandlerBase: Inline default implementations
00452 // ---------------------------------------------------------------------------
00453 inline void HandlerBase::characters(const   XMLCh* const
00454                                     , const unsigned int)
00455 {
00456 }
00457 
00458 inline void HandlerBase::endDocument()
00459 {
00460 }
00461 
00462 inline void HandlerBase::endElement(const XMLCh* const)
00463 {
00464 }
00465 
00466 inline void HandlerBase::error(const SAXParseException&)
00467 {
00468 }
00469 
00470 inline void HandlerBase::fatalError(const SAXParseException& exc)
00471 {
00472     throw exc;
00473 }
00474 
00475 inline void
00476 HandlerBase::ignorableWhitespace(   const   XMLCh* const
00477                                     , const unsigned int)
00478 {
00479 }
00480 
00481 inline void HandlerBase::notationDecl(  const   XMLCh* const
00482                                         , const XMLCh* const
00483                                         , const XMLCh* const)
00484 {
00485 }
00486 
00487 inline void
00488 HandlerBase::processingInstruction( const   XMLCh* const
00489                                     , const XMLCh* const)
00490 {
00491 }
00492 
00493 inline void HandlerBase::resetErrors()
00494 {
00495 }
00496 
00497 inline void HandlerBase::resetDocument()
00498 {
00499 }
00500 
00501 inline void HandlerBase::resetDocType()
00502 {
00503 }
00504 
00505 inline InputSource*
00506 HandlerBase::resolveEntity( const   XMLCh* const
00507                             , const XMLCh* const)
00508 {
00509     return 0;
00510 }
00511 
00512 inline void
00513 HandlerBase::unparsedEntityDecl(const   XMLCh* const
00514                                 , const XMLCh* const
00515                                 , const XMLCh* const
00516                                 , const XMLCh* const)
00517 {
00518 }
00519 
00520 inline void HandlerBase::setDocumentLocator(const Locator* const)
00521 {
00522 }
00523 
00524 inline void HandlerBase::startDocument()
00525 {
00526 }
00527 
00528 inline void
00529 HandlerBase::startElement(  const   XMLCh* const
00530                             ,       AttributeList&)
00531 {
00532 }
00533 
00534 inline void HandlerBase::warning(const SAXParseException&)
00535 {
00536 }
00537 
00538 XERCES_CPP_NAMESPACE_END
00539 
00540 #endif