QXmlSerializerPrivate Class Reference

#include <qxmlserializer_p.h>

Inheritance diagram for QXmlSerializerPrivate:

Public Functions
	QXmlSerializerPrivate (const QXmlQuery &q, QIODevice *outputDevice)
void	write (const char c)
Public Functions inherited from QAbstractXmlReceiverPrivate
virtual	~QAbstractXmlReceiverPrivate ()

Public Variables
const QTextCodec *	codec
QTextCodec::ConverterState	converterState
QIODevice *	device
QStack< QPair< QXmlName, bool > >	hasClosedElement
bool	isPreviousAtomic
QHash< QXmlName::Code, QByteArray >	nameCache
QStack< QVector< QXmlName > >	namespaces
const QPatternist::NamePool::Ptr	np
const QXmlQuery	query
QXmlSerializer::State	state

Private Types
enum	Constants { EstimatedTreeDepth = 10, EstimatedNameCount = 60 }

Detailed Description

Definition at line 69 of file qxmlserializer_p.h.

Enumerations

Constants

enum QXmlSerializerPrivate::Constants

private

Enumerator
EstimatedTreeDepth
EstimatedNameCount	We use a high count to avoid rehashing. We can afford it since we only allocate one hash for this.

Definition at line 111 of file qxmlserializer_p.h.

    {
        EstimatedTreeDepth = 10,

        EstimatedNameCount = 60
    };

Constructors and Destructors

QXmlSerializerPrivate()

QXmlSerializerPrivate::QXmlSerializerPrivate	(	const QXmlQuery &	q,
		QIODevice *	outputDevice
	)

Definition at line 53 of file qxmlserializer.cpp.

    : isPreviousAtomic(false),
      state(QXmlSerializer::BeforeDocumentElement),
      np(query.namePool().d),
      device(outputDevice),
      codec(QTextCodec::codecForMib(106)), /* UTF-8 */
      query(query)
{
    hasClosedElement.reserve(EstimatedTreeDepth);
    namespaces.reserve(EstimatedTreeDepth);
    nameCache.reserve(EstimatedNameCount);

    hasClosedElement.push(qMakePair(QXmlName(), true));

    /*
      We push the empty namespace such that first of all
      namespaceBinding() won't assert on an empty QStack,
      and such that the empty namespace is in-scope and
      that the code doesn't attempt to declare it.

      We push the XML namespace. Although we won't receive
      declarations for it, we may output attributes by that
      name.
    */
    QVector<QXmlName> defNss;
    defNss.resize(2);
    defNss[0] = QXmlName(StandardNamespaces::empty,
                         StandardLocalNames::empty,
                         StandardPrefixes::empty);
    defNss[1] = QXmlName(StandardNamespaces::xml,
                         StandardLocalNames::empty,
                         StandardPrefixes::xml);

    namespaces.push(defNss);

    /* If we don't set this flag, QTextCodec will generate a BOM. */
    converterState.flags = QTextCodec::IgnoreHeader;
}

Functions

write()

void QXmlSerializerPrivate::write ( const char  c )

inline

Definition at line 123 of file qxmlserializer_p.h.

{
    device->putChar(c);
}

Properties

codec

const QTextCodec* QXmlSerializerPrivate::codec

Definition at line 90 of file qxmlserializer_p.h.

converterState

QTextCodec::ConverterState QXmlSerializerPrivate::converterState

Definition at line 91 of file qxmlserializer_p.h.

Referenced by QXmlSerializerPrivate().

device

QIODevice* QXmlSerializerPrivate::device

Definition at line 89 of file qxmlserializer_p.h.

Referenced by write().

hasClosedElement

QStack<QPair<QXmlName, bool> > QXmlSerializerPrivate::hasClosedElement

Definition at line 75 of file qxmlserializer_p.h.

Referenced by QXmlSerializerPrivate().

isPreviousAtomic

bool QXmlSerializerPrivate::isPreviousAtomic

Definition at line 76 of file qxmlserializer_p.h.

nameCache

QHash<QXmlName::Code, QByteArray> QXmlSerializerPrivate::nameCache

Name cache. Since encoding QStrings are rather expensive operations to do, and we on top of that would have to do it each time a name appears, we here map names to their encoded equivalents.

This means that when writing out large documents, the serialization of names after a while is reduced to a hash lookup and passing an existing byte array.

We use QXmlName::Code as key as opposed to merely QName, because the prefix is of significance.

Definition at line 105 of file qxmlserializer_p.h.

Referenced by QXmlSerializerPrivate().

namespaces

QStack<QVector<QXmlName> > QXmlSerializerPrivate::namespaces

This member worries me a bit. We never use it but nevertheless it is pushed and pops linear to startElement() and endElement(). An optimization would be to at least merge it with hasClosedElement, but even better to push it on demand. That is, namespaceBinding() pushes it up to the tree depth first when it is needed.

Definition at line 87 of file qxmlserializer_p.h.

Referenced by QXmlSerializerPrivate().

np

const QPatternist::NamePool::Ptr QXmlSerializerPrivate::np

Definition at line 78 of file qxmlserializer_p.h.

query

const QXmlQuery QXmlSerializerPrivate::query

Definition at line 106 of file qxmlserializer_p.h.

state

QXmlSerializer::State QXmlSerializerPrivate::state

Definition at line 77 of file qxmlserializer_p.h.

---

The documentation for this class was generated from the following files:

• /src/xmlpatterns/api/qxmlserializer_p.h
• /src/xmlpatterns/api/qxmlserializer.cpp