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.6  2000/03/02 19:54:35  roddey

00060  * This checkin includes many changes done while waiting for the

00061  * 1.1.0 code to be finished. I can't list them all here, but a list is

00062  * available elsewhere.

00063  *
00064  * Revision 1.5  2000/02/24 20:12:55  abagchi

00065  * Swat for removing Log from API docs

00066  *
00067  * Revision 1.4  2000/02/12 03:31:55  rahulj

00068  * Removed duplicate CVS Log entries.

00069  *
00070  * Revision 1.3  2000/02/12 01:27:19  aruna1

00071  * Documentation updated

00072  *
00073  * Revision 1.2  2000/02/06 07:47:57  rahulj

00074  * Year 2K copyright swat.

00075  *
00076  * Revision 1.1.1.1  1999/11/09 01:07:45  twl

00077  * Initial checkin

00078  *
00079  * Revision 1.2  1999/11/08 20:45:00  rahul

00080  * Swat for adding in Product name and CVS comment log variable.

00081  *
00082  */
00083 
00084 
00085 #ifndef HANDLERBASE_HPP
00086 #define HANDLERBASE_HPP
00087 
00088 #include <sax/DocumentHandler.hpp>
00089 #include <sax/DTDHandler.hpp>
00090 #include <sax/EntityResolver.hpp>
00091 #include <sax/ErrorHandler.hpp>
00092 #include <sax/SAXParseException.hpp>
00093 
00094 class Locator;
00095 class AttributeList;
00096 
00116 
00117 class  HandlerBase :
00118 
00119     public EntityResolver, public DTDHandler, public DocumentHandler
00120     , public ErrorHandler
00121 {
00122 public:
00125 
00140     virtual void characters
00141     (
00142         const   XMLCh* const    chars
00143         , const unsigned int    length
00144     );
00145 
00158     virtual void endDocument();
00159 
00173     virtual void endElement(const XMLCh* const name);
00174 
00190     virtual void ignorableWhitespace
00191     (
00192         const   XMLCh* const    chars
00193         , const unsigned int    length
00194     );
00195 
00211     virtual void processingInstruction
00212     (
00213         const   XMLCh* const    target
00214         , const XMLCh* const    data
00215     );
00216 
00222     virtual void resetDocument();
00224 
00226 
00228 
00239     virtual void setDocumentLocator(const Locator* const locator);
00240 
00253     virtual void startDocument();
00254 
00269     virtual void startElement
00270     (
00271         const   XMLCh* const    name
00272         ,       AttributeList&  attributes
00273     );
00274 
00276 
00278 
00280 
00299     virtual InputSource* resolveEntity
00300     (
00301         const   XMLCh* const    publicId
00302         , const XMLCh* const    systemId
00303     );
00304 
00306 
00309 
00323     virtual void error(const SAXParseException& exception);
00324 
00342     virtual void fatalError(const SAXParseException& exception);
00343 
00358     virtual void warning(const SAXParseException& exception);
00359 
00365     virtual void resetErrors();
00366 
00368 
00369 
00372 
00386     virtual void notationDecl
00387     (
00388         const   XMLCh* const    name
00389         , const XMLCh* const    publicId
00390         , const XMLCh* const    systemId
00391     );
00392 
00398     virtual void resetDocType();
00399 
00414     virtual void unparsedEntityDecl
00415     (
00416         const   XMLCh* const    name
00417         , const XMLCh* const    publicId
00418         , const XMLCh* const    systemId
00419         , const XMLCh* const    notationName
00420     );
00422 };
00423 
00424 
00425 // ---------------------------------------------------------------------------
00426 //  HandlerBase: Inline default implementations
00427 // ---------------------------------------------------------------------------
00428 inline void HandlerBase::characters(const   XMLCh* const    chars
00429                                     , const unsigned int    length)

00430 {
00431 }
00432 
00433 inline void HandlerBase::endDocument()

00434 {
00435 }
00436 
00437 inline void HandlerBase::endElement(const XMLCh* const name)

00438 {
00439 }
00440 
00441 inline void HandlerBase::error(const SAXParseException& exception)

00442 {
00443 }
00444 
00445 inline void HandlerBase::fatalError(const SAXParseException& exception)

00446 {
00447     throw exception;
00448 }
00449 
00450 inline void
00451 HandlerBase::ignorableWhitespace(   const   XMLCh* const chars
00452                                     , const unsigned int length)

00453 {
00454 }
00455 
00456 inline void HandlerBase::notationDecl(  const   XMLCh* const name
00457                                         , const XMLCh* const publicId
00458                                         , const XMLCh* const systemId)

00459 {
00460 }
00461 
00462 inline void
00463 HandlerBase::processingInstruction( const   XMLCh* const target
00464                                     , const XMLCh* const data)

00465 {
00466 }
00467 
00468 inline void HandlerBase::resetErrors()

00469 {
00470 }
00471 
00472 inline void HandlerBase::resetDocument()

00473 {
00474 }
00475 
00476 inline void HandlerBase::resetDocType()

00477 {
00478 }
00479 
00480 inline InputSource*
00481 HandlerBase::resolveEntity( const   XMLCh* const publicId
00482                             , const XMLCh* const systemId)

00483 {
00484     return 0;
00485 }
00486 
00487 inline void
00488 HandlerBase::unparsedEntityDecl(const   XMLCh* const name
00489                                 , const XMLCh* const publicId
00490                                 , const XMLCh* const systemId
00491                                 , const XMLCh* const notationName)

00492 {
00493 }
00494 
00495 inline void HandlerBase::setDocumentLocator(const Locator* const locator)

00496 {
00497 }
00498 
00499 inline void HandlerBase::startDocument()

00500 {
00501 }
00502 
00503 inline void
00504 HandlerBase::startElement(  const   XMLCh* const    name
00505                             ,       AttributeList&  attributes)

00506 {
00507 }
00508 
00509 inline void HandlerBase::warning(const SAXParseException& exception)

00510 {
00511 }
00512 
00513 #endif