MemBufFormatTarget.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_MEMBUFFORMATTARGET_HPP)
#define XERCESC_INCLUDE_GUARD_MEMBUFFORMATTARGET_HPP
#include <xercesc/framework/XMLFormatter.hpp>
XERCES_CPP_NAMESPACE_BEGIN
/*
* The MemBufFormatTarget is a derivative from XMLFormatTarget, which user code
* may plug into DOMLSSerializer to retrieve the serialized XML stream (from DOM Tree)
* in a memory buffer.
*
* The MemBufFormatTarget is initialized to have a memory buffer of 1023 upon
* construction, which grows as needed. The buffer will be deleted when
* MemBufFormatTarget is destructed; or will be reset when the reset() function
* is called.
*
* The MemBufFormatTarget returns a NULL terminated XMLByte stream upon request,
* through the method getRawBuffer(), and user should make its own copy of the
* returned buffer if it intends to keep it independent on the state of the
* MemBufFormatTarget.
*/
class XMLPARSER_EXPORT MemBufFormatTarget : public XMLFormatTarget {
public:
MemBufFormatTarget
(
XMLSize_t initCapacity = 1023
, MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
) ;
~MemBufFormatTarget();
// -----------------------------------------------------------------------
// Implementations of the format target interface
// -----------------------------------------------------------------------
virtual void writeChars(const XMLByte* const toWrite
, const XMLSize_t count
, XMLFormatter* const formatter);
// -----------------------------------------------------------------------
// Getter
// -----------------------------------------------------------------------
const XMLByte* getRawBuffer() const;
XMLSize_t getLen() const
{
return fIndex;
}
void reset();
private:
// -----------------------------------------------------------------------
// Unimplemented methods.
// -----------------------------------------------------------------------
MemBufFormatTarget(const MemBufFormatTarget&);
MemBufFormatTarget& operator=(const MemBufFormatTarget&);
// -----------------------------------------------------------------------
// Private helpers
// -----------------------------------------------------------------------
void ensureCapacity(const XMLSize_t extraNeeded);
// -----------------------------------------------------------------------
// Private data members
//
// fDataBuf
// The pointer to the buffer data. Its grown as needed. 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.
//
// -----------------------------------------------------------------------
MemoryManager* fMemoryManager;
XMLByte* fDataBuf;
XMLSize_t fIndex;
XMLSize_t fCapacity;
};
XERCES_CPP_NAMESPACE_END
#endif
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
MemBufFormatTarget
Definition: MemBufFormatTarget.hpp:45
MemBufFormatTarget::reset
void reset()
Reset the internal string buffer.
MemBufFormatTarget::~MemBufFormatTarget
~MemBufFormatTarget()
MemBufFormatTarget::getRawBuffer
const XMLByte * getRawBuffer() const
Returned the internal raw buffer.
MemBufFormatTarget::MemBufFormatTarget
MemBufFormatTarget(XMLSize_t initCapacity=1023, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)
MemBufFormatTarget::writeChars
virtual void writeChars(const XMLByte *const toWrite, const XMLSize_t count, XMLFormatter *const formatter)
MemBufFormatTarget::getLen
XMLSize_t getLen() const
Returned the length of the raw buffer.
Definition: MemBufFormatTarget.hpp:84
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