LocalFileFormatTarget.hpp
Go to the documentation of this file.
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* $Id$
*/
#if !defined(XERCESC_INCLUDE_GUARD_LOCALFILEFORMATTARGET_HPP)
#define XERCESC_INCLUDE_GUARD_LOCALFILEFORMATTARGET_HPP
#include <xercesc/framework/XMLFormatter.hpp>
XERCES_CPP_NAMESPACE_BEGIN
class XMLPARSER_EXPORT LocalFileFormatTarget : public XMLFormatTarget {
public:
LocalFileFormatTarget
(
const XMLCh* const
, MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
);
LocalFileFormatTarget
(
const char* const
, MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
);
~LocalFileFormatTarget();
// -----------------------------------------------------------------------
// Implementations of the format target interface
// -----------------------------------------------------------------------
virtual void writeChars(const XMLByte* const toWrite
, const XMLSize_t count
, XMLFormatter* const formatter);
virtual void flush();
private:
// -----------------------------------------------------------------------
// Unimplemented methods.
// -----------------------------------------------------------------------
LocalFileFormatTarget(const LocalFileFormatTarget&);
LocalFileFormatTarget& operator=(const LocalFileFormatTarget&);
// -----------------------------------------------------------------------
// Private helpers
// -----------------------------------------------------------------------
void ensureCapacity(const XMLSize_t extraNeeded);
// -----------------------------------------------------------------------
// Private data members
//
// fSource
// The source file that we represent. The FileHandle type is defined
// per platform.
//
// fDataBuf
// The pointer to the buffer data. Its always
// one larger than fCapacity, to leave room for the null terminator.
//
// fIndex
// The current index into the buffer, as characters are appended
// to it. If its zero, then the buffer is empty.
//
// fCapacity
// The current capacity of the buffer. Its actually always one
// larger, to leave room for the null terminator.
// -----------------------------------------------------------------------
FileHandle fSource;
XMLByte* fDataBuf;
XMLSize_t fIndex;
XMLSize_t fCapacity;
MemoryManager* fMemoryManager;
};
XERCES_CPP_NAMESPACE_END
#endif
FileHandle
XERCES_CPP_NAMESPACE_BEGIN typedef void * FileHandle
Definition XMLFileMgr.hpp:30
XMLFormatter.hpp
XMLPARSER_EXPORT
#define XMLPARSER_EXPORT
Definition XercesDefs.hpp:163
XERCES_CPP_NAMESPACE_BEGIN
#define XERCES_CPP_NAMESPACE_BEGIN
Definition XercesDefs.hpp:112
XMLByte
unsigned char XMLByte
Definition XercesDefs.hpp:65
XERCES_CPP_NAMESPACE_END
#define XERCES_CPP_NAMESPACE_END
Definition XercesDefs.hpp:113
XMLSize_t
size_t XMLSize_t
Definition Xerces_autoconf_config.hpp:112
XMLCh
char16_t XMLCh
Definition Xerces_autoconf_config.hpp:120
LocalFileFormatTarget
Definition LocalFileFormatTarget.hpp:29
LocalFileFormatTarget::LocalFileFormatTarget
LocalFileFormatTarget(const XMLCh *const, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)
LocalFileFormatTarget::~LocalFileFormatTarget
~LocalFileFormatTarget()
LocalFileFormatTarget::writeChars
virtual void writeChars(const XMLByte *const toWrite, const XMLSize_t count, XMLFormatter *const formatter)
LocalFileFormatTarget::LocalFileFormatTarget
LocalFileFormatTarget(const char *const, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)
LocalFileFormatTarget::flush
virtual void flush()
MemoryManager
Configurable memory manager.
Definition MemoryManager.hpp:40
XMLFormatTarget
Definition XMLFormatter.hpp:443
XMLFormatter
This class provides the basic formatting capabilities that are required to turn the Unicode based XML...
Definition XMLFormatter.hpp:42
XMLPlatformUtils::fgMemoryManager
static MemoryManager * fgMemoryManager
The configurable memory manager.
Definition PlatformUtils.hpp:121