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  

LocalFileFormatTarget.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 2002 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  * $Id: LocalFileFormatTarget.hpp,v 1.4 2003/01/24 20:20:22 tng Exp $
00059  * $Log: LocalFileFormatTarget.hpp,v $
00060  * Revision 1.4  2003/01/24 20:20:22  tng
00061  * Add method flush to XMLFormatTarget
00062  *
00063  * Revision 1.3  2002/11/27 18:09:25  tng
00064  * [Bug 13447] Performance: Using LocalFileFormatTarget with DOMWriter is very slow.
00065  *
00066  * Revision 1.2  2002/11/04 15:00:21  tng
00067  * C++ Namespace Support.
00068  *
00069  * Revision 1.1  2002/06/19 21:59:26  peiyongz
00070  * DOM3:DOMSave Interface support: LocalFileFormatTarget
00071  *
00072  *
00073  */
00074 
00075 #ifndef LocalFileFormatTarget_HEADER_GUARD_
00076 #define LocalFileFormatTarget_HEADER_GUARD_
00077 
00078 #include <xercesc/framework/XMLFormatter.hpp>
00079 
00080 XERCES_CPP_NAMESPACE_BEGIN
00081 
00082 class  LocalFileFormatTarget : public XMLFormatTarget {
00083 public:
00084 
00087     LocalFileFormatTarget(const XMLCh* const);
00088 
00089     LocalFileFormatTarget(const char* const);
00090 
00091     ~LocalFileFormatTarget();
00093 
00094     // -----------------------------------------------------------------------
00095     //  Implementations of the format target interface
00096     // -----------------------------------------------------------------------
00097     virtual void writeChars(const XMLByte* const toWrite
00098                           , const unsigned int   count
00099                           , XMLFormatter* const  formatter);
00100 
00101     virtual void flush();
00102 
00103 private:
00104     // -----------------------------------------------------------------------
00105     //  Unimplemented methods.
00106     // -----------------------------------------------------------------------
00107     LocalFileFormatTarget(const LocalFileFormatTarget&);
00108     LocalFileFormatTarget& operator=(const LocalFileFormatTarget&);
00109 
00110     // -----------------------------------------------------------------------
00111     //  Private helpers
00112     // -----------------------------------------------------------------------
00113     void flushBuffer();
00114     void insureCapacity(const unsigned int extraNeeded);
00115 
00116     // -----------------------------------------------------------------------
00117     //  Private data members
00118     //
00119     //  fSource
00120     //      The source file that we represent. The FileHandle type is defined
00121     //      per platform.
00122     //
00123     //  fDataBuf
00124     //      The pointer to the buffer data. Its always
00125     //      one larger than fCapacity, to leave room for the null terminator.
00126     //
00127     //  fIndex
00128     //      The current index into the buffer, as characters are appended
00129     //      to it. If its zero, then the buffer is empty.
00130     //
00131     //  fCapacity
00132     //      The current capacity of the buffer. Its actually always one
00133     //      larger, to leave room for the null terminator.
00134     // -----------------------------------------------------------------------
00135     FileHandle      fSource;
00136     XMLByte*        fDataBuf;
00137     unsigned int    fIndex;
00138     unsigned int    fCapacity;
00139 
00140 };
00141 
00142 
00143 XERCES_CPP_NAMESPACE_END
00144 
00145 #endif
00146 


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