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

Home

Readme
Installation
Build

API Docs
Samples
Programming
Migration
FAQs

Releases
Feedback
Bug-Todo

Download
CVS Repository
Mail Archive

API Docs for SAX and DOM
 

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

BinMemInputStream.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: BinMemInputStream.hpp,v $

00059  * Revision 1.3  2000/02/24 20:05:24  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:07  twl

00066  * Initial checkin

00067  *
00068  * Revision 1.3  1999/11/08 20:45:04  rahul

00069  * Swat for adding in Product name and CVS comment log variable.

00070  *
00071  */
00072 
00073 #if !defined(BINMEMINPUTSTREAM_HPP)
00074 #define BINMEMINPUTSTREAM_HPP
00075 
00076 #include <util/BinInputStream.hpp>
00077 
00078 
00079 class  BinMemInputStream : public BinInputStream
00080 {
00081 public :
00082     // -----------------------------------------------------------------------
00083     //  Class specific types
00084     // -----------------------------------------------------------------------
00085     enum BufOpts
00086     {
00087         BufOpt_Adopt
00088         , BufOpt_Copy
00089         , BufOpt_Reference
00090     };
00091 
00092 
00093     // -----------------------------------------------------------------------
00094     //  Constructors and Destructor
00095     // -----------------------------------------------------------------------
00096     BinMemInputStream
00097     (
00098         const   XMLByte* const  initData
00099         , const unsigned int    capacity
00100         , const BufOpts         bufOpt = BufOpt_Copy
00101     );
00102     virtual ~BinMemInputStream();
00103 
00104 
00105     // -----------------------------------------------------------------------
00106     //  Stream management methods
00107     // -----------------------------------------------------------------------
00108     void reset();
00109 
00110 
00111     // -----------------------------------------------------------------------
00112     //  Implementation of the input stream interface
00113     // -----------------------------------------------------------------------
00114     virtual unsigned int curPos() const;
00115     virtual unsigned int readBytes
00116     (
00117                 XMLByte* const  toFill
00118         , const unsigned int    maxToRead
00119     );
00120 
00121 
00122 private :
00123     // -----------------------------------------------------------------------
00124     //  Private data members
00125     //
00126     //  fBuffer
00127     //      The buffer of bytes that we are streaming.
00128     //
00129     //  fBufOpt
00130     //      Indicates the ownership status of the buffer. The caller can have
00131     //      us adopt it (we delete it), reference it, or just make our own
00132     //      copy of it.
00133     //
00134     //  fCapacity
00135     //      The size of the buffer being streamed.
00136     //
00137     //  fCurIndex
00138     //      The current index where the next byte will be read from. When it
00139     //      hits fCapacity, we are done.
00140     // -----------------------------------------------------------------------
00141     const XMLByte*  fBuffer;
00142     BufOpts         fBufOpt;
00143     unsigned int    fCapacity;
00144     unsigned int    fCurIndex;
00145 };
00146 
00147 
00148 // ---------------------------------------------------------------------------
00149 //  BinMemInputStream: Stream management methods
00150 // ---------------------------------------------------------------------------
00151 inline void BinMemInputStream::reset()

00152 {
00153     fCurIndex = 0;
00154 }
00155 
00156 
00157 // ---------------------------------------------------------------------------
00158 //  BinMemInputStream: Implementation of the input stream interface
00159 // ---------------------------------------------------------------------------
00160 inline unsigned int BinMemInputStream::curPos() const

00161 {
00162     return fCurIndex;
00163 }
00164 
00165 #endif


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