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

Home

Readme
Release Info

Installation
Download
Build

FAQs
Samples
API Docs

DOM C++ Binding
Programming
Migration Guide

Feedback
Bug-Reporting
PDF Document

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.2  2002/11/04 15:22:03  tng
00060  * C++ Namespace Support.
00061  *
00062  * Revision 1.1.1.1  2002/02/01 22:22:10  peiyongz
00063  * sane_include
00064  *
00065  * Revision 1.3  2000/02/24 20:05:24  abagchi
00066  * Swat for removing Log from API docs
00067  *
00068  * Revision 1.2  2000/02/06 07:48:01  rahulj
00069  * Year 2K copyright swat.
00070  *
00071  * Revision 1.1.1.1  1999/11/09 01:04:07  twl
00072  * Initial checkin
00073  *
00074  * Revision 1.3  1999/11/08 20:45:04  rahul
00075  * Swat for adding in Product name and CVS comment log variable.
00076  *
00077  */
00078 
00079 #if !defined(BINMEMINPUTSTREAM_HPP)
00080 #define BINMEMINPUTSTREAM_HPP
00081 
00082 #include <xercesc/util/BinInputStream.hpp>
00083 
00084 XERCES_CPP_NAMESPACE_BEGIN
00085 
00086 class  BinMemInputStream : public BinInputStream
00087 {
00088 public :
00089     // -----------------------------------------------------------------------
00090     //  Class specific types
00091     // -----------------------------------------------------------------------
00092     enum BufOpts
00093     {
00094         BufOpt_Adopt
00095         , BufOpt_Copy
00096         , BufOpt_Reference
00097     };
00098 
00099 
00100     // -----------------------------------------------------------------------
00101     //  Constructors and Destructor
00102     // -----------------------------------------------------------------------
00103     BinMemInputStream
00104     (
00105         const   XMLByte* const  initData
00106         , const unsigned int    capacity
00107         , const BufOpts         bufOpt = BufOpt_Copy
00108     );
00109     virtual ~BinMemInputStream();
00110 
00111 
00112     // -----------------------------------------------------------------------
00113     //  Stream management methods
00114     // -----------------------------------------------------------------------
00115     void reset();
00116 
00117 
00118     // -----------------------------------------------------------------------
00119     //  Implementation of the input stream interface
00120     // -----------------------------------------------------------------------
00121     virtual unsigned int curPos() const;
00122     virtual unsigned int readBytes
00123     (
00124                 XMLByte* const  toFill
00125         , const unsigned int    maxToRead
00126     );
00127 
00128 
00129 private :
00130     // -----------------------------------------------------------------------
00131     //  Private data members
00132     //
00133     //  fBuffer
00134     //      The buffer of bytes that we are streaming.
00135     //
00136     //  fBufOpt
00137     //      Indicates the ownership status of the buffer. The caller can have
00138     //      us adopt it (we delete it), reference it, or just make our own
00139     //      copy of it.
00140     //
00141     //  fCapacity
00142     //      The size of the buffer being streamed.
00143     //
00144     //  fCurIndex
00145     //      The current index where the next byte will be read from. When it
00146     //      hits fCapacity, we are done.
00147     // -----------------------------------------------------------------------
00148     const XMLByte*  fBuffer;
00149     BufOpts         fBufOpt;
00150     unsigned int    fCapacity;
00151     unsigned int    fCurIndex;
00152 };
00153 
00154 
00155 // ---------------------------------------------------------------------------
00156 //  BinMemInputStream: Stream management methods
00157 // ---------------------------------------------------------------------------
00158 inline void BinMemInputStream::reset()
00159 {
00160     fCurIndex = 0;
00161 }
00162 
00163 
00164 // ---------------------------------------------------------------------------
00165 //  BinMemInputStream: Implementation of the input stream interface
00166 // ---------------------------------------------------------------------------
00167 inline unsigned int BinMemInputStream::curPos() const
00168 {
00169     return fCurIndex;
00170 }
00171 
00172 XERCES_CPP_NAMESPACE_END
00173 
00174 #endif


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