http://xml.apache.org/http://www.apache.org/http://www.w3.org/

Home

Readme
Installation
Build

API Docs
Samples
Programming
Migration
FAQs

Releases
Feedback

PDF Document

Download
Dev Snapshots
CVS Repository
Mail Archive

API Docs for SAX and DOM
 

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

XMLPScanToken.hpp

Go to the documentation of this 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: XMLPScanToken.hpp,v $
00059  * Revision 1.4  2000/02/24 20:00:23  abagchi
00060  * Swat for removing Log from API docs
00061  *
00062  * Revision 1.3  2000/02/15 01:21:31  roddey
00063  * Some initial documentation improvements. More to come...
00064  *
00065  * Revision 1.2  2000/02/06 07:47:48  rahulj
00066  * Year 2K copyright swat.
00067  *
00068  * Revision 1.1.1.1  1999/11/09 01:08:36  twl
00069  * Initial checkin
00070  *
00071  * Revision 1.2  1999/11/08 20:44:39  rahul
00072  * Swat for adding in Product name and CVS comment log variable.
00073  *
00074  */
00075 
00076 
00077 #if !defined(XMLPSCANTOKEN_HPP)
00078 #define XMLPSCANTOKEN_HPP
00079 
00080 class XMLScanner;
00081 
00092 class  XMLPScanToken
00093 {
00094 public :
00095     // -----------------------------------------------------------------------
00096     //  Constructors and Destructor
00097     // -----------------------------------------------------------------------
00099     //@{
00100     XMLPScanToken();
00101     XMLPScanToken(const XMLPScanToken& toCopy);
00102     //@}
00103 
00105     //@{
00106     ~XMLPScanToken();
00107     //@}
00108 
00109 
00110     // -----------------------------------------------------------------------
00111     //  Public operators
00112     // -----------------------------------------------------------------------
00113     XMLPScanToken& operator=(const XMLPScanToken& toCopy);
00114 
00115 
00116 protected :
00117     // -----------------------------------------------------------------------
00118     //  XMLScanner is our friend, can you say friend? Sure...
00119     // -----------------------------------------------------------------------
00120     friend class XMLScanner;
00121 
00122 
00123     // -----------------------------------------------------------------------
00124     //  Hidden methods for use by XMLScanner
00125     // -----------------------------------------------------------------------
00126     void set
00127     (
00128         const   XMLUInt32   scannerId
00129         , const XMLUInt32   sequenceId
00130     );
00131 
00132 
00133 private :
00134     // -----------------------------------------------------------------------
00135     //  Private data members
00136     //
00137     //  fScannerId
00138     //      This field is set to the id of the scanner, to catch problems
00139     //      where a token is gotten from one scanner and passed to another.
00140     //      Each scanner is assigned an incrementing id.
00141     //
00142     //  fSequenceId
00143     //      In order to avoid problems such as calling scanNext() without
00144     //      a call to scanFirst() and such, this value is set when scanFirst()
00145     //      is called and matches this token to the current sequence id of
00146     //      the scanner.
00147     // -----------------------------------------------------------------------
00148     XMLUInt32   fScannerId;
00149     XMLUInt32   fSequenceId;
00150 };
00151 
00152 
00153 // ---------------------------------------------------------------------------
00154 //  XMLPScanToken: Constructors and Operators
00155 // ---------------------------------------------------------------------------
00156 inline XMLPScanToken::XMLPScanToken() :
00157 
00158     fScannerId(0)
00159     , fSequenceId(0)
00160 {
00161 }
00162 
00163 inline XMLPScanToken::XMLPScanToken(const XMLPScanToken& toCopy) :
00164 
00165     fScannerId(toCopy.fScannerId)
00166     , fSequenceId(toCopy.fSequenceId)
00167 {
00168 }
00169 
00170 inline XMLPScanToken::~XMLPScanToken()
00171 {
00172 }
00173 
00174 
00175 // ---------------------------------------------------------------------------
00176 //  XMLPScanToken: Public operators
00177 // ---------------------------------------------------------------------------
00178 inline XMLPScanToken& XMLPScanToken::operator=(const XMLPScanToken& toCopy)
00179 {
00180     if (this == &toCopy)
00181         return *this;
00182 
00183     fScannerId = toCopy.fScannerId;
00184     fSequenceId = toCopy.fSequenceId;
00185 
00186     return *this;
00187 }
00188 
00189 
00190 // ---------------------------------------------------------------------------
00191 //  XMLPScanToken: Hidden methods
00192 // ---------------------------------------------------------------------------
00193 inline void XMLPScanToken::set( const   XMLUInt32   scannerId
00194                                 , const XMLUInt32   sequenceId)
00195 {
00196     fScannerId = scannerId;
00197     fSequenceId = sequenceId;
00198 }
00199 
00200 #endif


Copyright © 2000 The Apache Software Foundation. All Rights Reserved.