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


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