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

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