| API Docs for SAX and DOM |

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

# BinFileInputStream.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: BinFileInputStream.hpp,v $
    00059  * Revision 1.6  2004/01/29 11:48:46  cargilld
    00060  * Code cleanup changes to get rid of various compiler diagnostic messages.
    00061  *
    00062  * Revision 1.5  2003/12/17 13:58:02  cargilld
    00063  * Platform update for memory management so that the static memory manager (one
    00064  * used to call Initialize) is only for static data.
    00065  *
    00066  * Revision 1.4  2003/06/03 18:12:29  knoaman
    00067  * Add default value for memory manager argument.
    00068  *
    00069  * Revision 1.3  2003/05/16 03:11:22  knoaman
    00070  * Partial implementation of the configurable memory manager.
    00071  *
    00072  * Revision 1.2  2002/11/04 15:22:03  tng
    00073  * C++ Namespace Support.
    00074  *
    00075  * Revision 1.1.1.1  2002/02/01 22:22:09  peiyongz
    00076  * sane_include
    00077  *
    00078  * Revision 1.3  2000/02/24 20:05:23  abagchi
    00079  * Swat for removing Log from API docs
    00080  *
    00081  * Revision 1.2  2000/02/06 07:48:01  rahulj
    00082  * Year 2K copyright swat.
    00083  *
    00084  * Revision 1.1.1.1  1999/11/09 01:04:00  twl
    00085  * Initial checkin
    00086  *
    00087  * Revision 1.3  1999/11/08 20:45:03  rahul
    00088  * Swat for adding in Product name and CVS comment log variable.
    00089  *
    00090  */
    00091
    00092 #if !defined(BINFILEINPUTSTREAM_HPP)
    00093 #define BINFILEINPUTSTREAM_HPP
    00094
    00095 #include <xercesc/util/BinInputStream.hpp>
    00096 #include <xercesc/util/PlatformUtils.hpp>
    00097
    00098 XERCES_CPP_NAMESPACE_BEGIN
    00099
    00100 class  BinFileInputStream : public BinInputStream
    00101 {
    00102 public :
    00103     // -----------------------------------------------------------------------
    00104     //  Constructors and Destructor
    00105     // -----------------------------------------------------------------------
    00106     BinFileInputStream
    00107     (
    00108         const   XMLCh* const    fileName
    00109         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
    00110     );
    00111
    00112     BinFileInputStream
    00113     (
    00114         const   char* const     fileName
    00115         , MemoryManager* const  manager = XMLPlatformUtils::fgMemoryManager
    00116     );
    00117
    00118     BinFileInputStream
    00119     (
    00120         const   FileHandle      toUse
    00121         , MemoryManager* const  manager = XMLPlatformUtils::fgMemoryManager
    00122     );
    00123
    00124     virtual ~BinFileInputStream();
    00125
    00126
    00127     // -----------------------------------------------------------------------
    00128     //  Getter methods
    00129     // -----------------------------------------------------------------------
    00130     bool getIsOpen() const;
    00131     unsigned int getSize() const;
    00132     void reset();
    00133
    00134
    00135     // -----------------------------------------------------------------------
    00136     //  Implementation of the input stream interface
    00137     // -----------------------------------------------------------------------
    00138     virtual unsigned int curPos() const;
    00139
    00140     virtual unsigned int readBytes
    00141     (
    00142                 XMLByte* const      toFill
    00143         , const unsigned int        maxToRead
    00144     );
    00145
    00146
    00147 private :
    00148     // -----------------------------------------------------------------------
    00149     //  Unimplemented constructors and operators
    00150     // -----------------------------------------------------------------------
    00151     BinFileInputStream(const BinFileInputStream&);
    00152     BinFileInputStream& operator=(const BinFileInputStream&);
    00153
    00154     // -----------------------------------------------------------------------
    00155     //  Private data members
    00156     //
    00157     //  fSource
    00158     //      The source file that we represent. The FileHandle type is defined
    00159     //      per platform.
    00160     // -----------------------------------------------------------------------
    00161     FileHandle              fSource;
    00162     MemoryManager* const    fMemoryManager;
    00163 };
    00164
    00165
    00166 // ---------------------------------------------------------------------------
    00167 //  BinFileInputStream: Getter methods
    00168 // ---------------------------------------------------------------------------
    00169 inline bool BinFileInputStream::getIsOpen() const
    00170 {
    00171     return (fSource != 0);
    00172 }
    00173
    00174 XERCES_CPP_NAMESPACE_END
    00175
    00176 #endif

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