BinFileInputStream.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: BinFileInputStream.hpp,v $
00059  * Revision 1.3  2000/02/24 20:05:23  abagchi
00060  * Swat for removing Log from API docs
00061  *
00062  * Revision 1.2  2000/02/06 07:48:01  rahulj
00063  * Year 2K copyright swat.
00064  *
00065  * Revision 1.1.1.1  1999/11/09 01:04:00  twl
00066  * Initial checkin
00067  *
00068  * Revision 1.3  1999/11/08 20:45:03  rahul
00069  * Swat for adding in Product name and CVS comment log variable.
00070  *
00071  */
00072 
00073 #if !defined(BINFILEINPUTSTREAM_HPP)
00074 #define BINFILEINPUTSTREAM_HPP
00075 
00076 #include <util/BinInputStream.hpp>
00077 
00078 
00079 class  BinFileInputStream : public BinInputStream
00080 {
00081 public :
00082     // -----------------------------------------------------------------------
00083     //  Constructors and Destructor
00084     // -----------------------------------------------------------------------
00085     BinFileInputStream
00086     (
00087         const   XMLCh* const    fileName
00088     );
00089 
00090     BinFileInputStream
00091     (
00092         const   char* const     fileName
00093     );
00094 
00095     BinFileInputStream
00096     (
00097         const   FileHandle      toUse
00098     );
00099 
00100     virtual ~BinFileInputStream();
00101 
00102 
00103     // -----------------------------------------------------------------------
00104     //  Getter methods
00105     // -----------------------------------------------------------------------
00106     bool getIsOpen() const;
00107     unsigned int getSize() const;
00108     void reset();
00109 
00110 
00111     // -----------------------------------------------------------------------
00112     //  Implementation of the input stream interface
00113     // -----------------------------------------------------------------------
00114     virtual unsigned int curPos() const;
00115 
00116     virtual unsigned int readBytes
00117     (
00118                 XMLByte* const      toFill
00119         , const unsigned int        maxToRead
00120     );
00121 
00122 
00123 private :
00124     // -----------------------------------------------------------------------
00125     //  Private data members
00126     //
00127     //  fSource
00128     //      The source file that we represent. The FileHandle type is defined
00129     //      per platform.
00130     // -----------------------------------------------------------------------
00131     FileHandle      fSource;
00132 };
00133 
00134 
00135 // ---------------------------------------------------------------------------
00136 //  BinFileInputStream: Getter methods
00137 // ---------------------------------------------------------------------------
00138 inline bool BinFileInputStream::getIsOpen() const
00139 {
00140     return (fSource != 0);
00141 }
00142 
00143 #endif