Main Page   Class Hierarchy   Compound List   File List   Compound Members  

XMLPScanToken.hpp

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

Generated on Tue Nov 19 09:36:35 2002 by doxygen1.3-rc1