BinInputStream.hpp Source File

00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 1999-2003 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: BinInputStream.hpp,v $
00059  * Revision 1.4  2003/05/15 19:04:35  knoaman
00060  * Partial implementation of the configurable memory manager.
00061  *
00062  * Revision 1.3  2003/03/07 18:11:54  tng
00063  * Return a reference instead of void for operator=
00064  *
00065  * Revision 1.2  2002/11/04 15:22:03  tng
00066  * C++ Namespace Support.
00067  *
00068  * Revision 1.1.1.1  2002/02/01 22:22:10  peiyongz
00069  * sane_include
00070  *
00071  * Revision 1.4  2000/03/02 19:54:38  roddey
00072  * This checkin includes many changes done while waiting for the
00073  * 1.1.0 code to be finished. I can't list them all here, but a list is
00074  * available elsewhere.
00075  *
00076  * Revision 1.3  2000/02/24 20:05:23  abagchi
00077  * Swat for removing Log from API docs
00078  *
00079  * Revision 1.2  2000/02/06 07:48:01  rahulj
00080  * Year 2K copyright swat.
00081  *
00082  * Revision 1.1.1.1  1999/11/09 01:04:03  twl
00083  * Initial checkin
00084  *
00085  * Revision 1.3  1999/11/08 20:45:04  rahul
00086  * Swat for adding in Product name and CVS comment log variable.
00087  *
00088  */
00089 
00090 #if !defined(BININPUTSTREAM_HPP)
00091 #define BININPUTSTREAM_HPP
00092 
00093 #include <xercesc/util/XMemory.hpp>
00094 
00095 XERCES_CPP_NAMESPACE_BEGIN
00096 
00097 class  BinInputStream : public XMemory
00098 {
00099 public :
00100     // -----------------------------------------------------------------------
00101     //  Virtual destructor for derived classes
00102     // -----------------------------------------------------------------------
00103     virtual ~BinInputStream();
00104 
00105 
00106     // -----------------------------------------------------------------------
00107     //  The virtual input stream interface
00108     // -----------------------------------------------------------------------
00109     virtual unsigned int curPos() const = 0;
00110 
00111     virtual unsigned int readBytes
00112     (
00113                 XMLByte* const      toFill
00114         , const unsigned int        maxToRead
00115     ) = 0;
00116 
00117 
00118 protected :
00119     // -----------------------------------------------------------------------
00120     //  Hidden Constructors
00121     // -----------------------------------------------------------------------
00122     BinInputStream();
00123 
00124 
00125 private :
00126     // -----------------------------------------------------------------------
00127     //  Unimplemented Constructors
00128     // -----------------------------------------------------------------------
00129     BinInputStream(const BinInputStream&);
00130     BinInputStream& operator=(const BinInputStream&);
00131 };
00132 
00133 XERCES_CPP_NAMESPACE_END
00134 
00135 #endif