Skip to content

Commit

Permalink
Introduce a new class QStringBuilder to speed up the creation of
Browse files Browse the repository at this point in the history
QString objects from smaller chunks.

The QStringBuilder class:

QStringBuilder uses expression templates (using the '%' operator)
to postpone any actual concatenation until it is assigned to an
actual QString. At that time it knows the exact sizes of all chunks,
can compute the required space, allocates once a QString of
appriopriate size and then copies over the chunk data one-by-one.

In addition, QLatin1Literal is a drop-in replacement for QLatin1String
(which we can't change for compatibility reasons) that knows its
size, therefore saving a few cycles when computing the size of the
resulting string.

Some further saved cycles stem from inlining and reduced reference
counting logic (the QString created from a QStringBuilder has typically
ref count equal to 1, while QString::append() needs an extra test)

Minor changes to the existing QString class:

- Introduce QString constructor to create an uninitialized QString of a given size.
This particular constructor is used by QStringBuilder class.

- Introduce a QT_USE_FAST_CONCATENATION macro to disable the existing
overloads of operator+() and helps finding the places where they are used in code.

- Introduce QT_USE_FAST_OPERATOR_PLUS.  This also disables the existing
overloads of operator+() and creates a new templated operator+() with
identical implementation of operator%().  This allows code that is compilable
QT_CAST_{TO,FROM}_ASCII to use QStringBuilder almost transparently. The only
case that is not covered is creating objects like QUrl that are implicitly
constructible from a QString from a QStringBuilder result.  This needs to be
converted explicitly to a QString first, e.g. by using QUrl
url(QString(QLatin1String("http://") + hostName));

Reviewed-by: MariusSO
  • Loading branch information
hjk committed May 28, 2009
1 parent 389ca4b commit 3331605
Show file tree
Hide file tree
Showing 7 changed files with 689 additions and 3 deletions.
17 changes: 17 additions & 0 deletions src/corelib/tools/qstring.cpp
Expand Up @@ -944,6 +944,23 @@ QString::QString(int size, QChar ch)
}
}

/*!
Constructs a string of the given \a size without initializing the
characters. This is only used in \c QStringBuilder::toString().
\internal
*/

QString::QString(int size, Uninitialized)
{
d = (Data*) qMalloc(sizeof(Data)+size*sizeof(QChar));
d->ref = 1;
d->alloc = d->size = size;
d->clean = d->asciiCache = d->simpletext = d->righttoleft = d->capacity = 0;
d->data = d->array;
d->array[size] = '\0';
}

/*! \fn QString::QString(const QLatin1String &str)
Constructs a copy of the Latin-1 string \a str.
Expand Down
15 changes: 12 additions & 3 deletions src/corelib/tools/qstring.h
Expand Up @@ -579,6 +579,9 @@ class Q_CORE_EXPORT QString
bool isSimpleText() const { if (!d->clean) updateProperties(); return d->simpletext; }
bool isRightToLeft() const { if (!d->clean) updateProperties(); return d->righttoleft; }

struct Uninitialized {};
QString(int size, Uninitialized);

private:
#if defined(QT_NO_CAST_FROM_ASCII) && !defined(Q_NO_DECLARED_NOT_DEFINED)
QString &operator+=(const char *s);
Expand Down Expand Up @@ -1001,13 +1004,15 @@ inline int QByteArray::findRev(const QString &s, int from) const
# endif // QT3_SUPPORT
#endif // QT_NO_CAST_TO_ASCII

#ifndef QT_USE_FAST_OPERATOR_PLUS
# ifndef QT_USE_FAST_CONCATENATION
inline const QString operator+(const QString &s1, const QString &s2)
{ QString t(s1); t += s2; return t; }
inline const QString operator+(const QString &s1, QChar s2)
{ QString t(s1); t += s2; return t; }
inline const QString operator+(QChar s1, const QString &s2)
{ QString t(s1); t += s2; return t; }
#ifndef QT_NO_CAST_FROM_ASCII
# ifndef QT_NO_CAST_FROM_ASCII
inline QT_ASCII_CAST_WARN const QString operator+(const QString &s1, const char *s2)
{ QString t(s1); t += QString::fromAscii(s2); return t; }
inline QT_ASCII_CAST_WARN const QString operator+(const char *s1, const QString &s2)
Expand All @@ -1020,7 +1025,9 @@ inline QT_ASCII_CAST_WARN const QString operator+(const QByteArray &ba, const QS
{ QString t = QString::fromAscii(ba.constData(), qstrnlen(ba.constData(), ba.size())); t += s; return t; }
inline QT_ASCII_CAST_WARN const QString operator+(const QString &s, const QByteArray &ba)
{ QString t(s); t += QString::fromAscii(ba.constData(), qstrnlen(ba.constData(), ba.size())); return t; }
#endif
# endif // QT_NO_CAST_FROM_ASCII
# endif // QT_USE_FAST_CONCATENATION
#endif // QT_USE_FAST_OPERATOR_PLUS

#ifndef QT_NO_STL
inline std::string QString::toStdString() const
Expand Down Expand Up @@ -1229,6 +1236,8 @@ inline int QStringRef::localeAwareCompare(const QStringRef &s1, const QStringRef

QT_END_NAMESPACE

QT_END_HEADER
#ifdef QT_USE_FAST_CONCATENATION
#include <QtCore/qstringbuilder.h>
#endif

#endif // QSTRING_H
135 changes: 135 additions & 0 deletions src/corelib/tools/qstringbuilder.cpp
@@ -0,0 +1,135 @@
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Qt Software Information (qt-info@nokia.com)
**
** This file is part of the $MODULE$ of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial Usage
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain
** additional rights. These rights are described in the Nokia Qt LGPL
** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
** package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at qt-sales@nokia.com.
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qstringbuilder.h"

/*!
\class QLatin1Literal
\reentrant
\since 4.6
\brief The QLatin1Literal class provides a thin wrapper around string
literals used in source code.
\ingroup tools
\ingroup shared
\ingroup text
\mainclass
Unlike \c QLatin1String, a \c QLatin1Literal can retrieve its size
without iterating over the literal.
The main use of \c QLatin1Literal is in conjunction with \c QStringBuilder
to reduce the number of reallocations needed to build up a string from
smaller chunks.
\sa QStringBuilder, QLatin1String, QString, QStringRef
*/

/*! \fn QLatin1Literal::QLatin1Literal(const char(&string)[])
Constructs a new literal from the given \a string.
*/

/*! \fn int QLatin1Literal::size() const
Returns the number of characters in the literal \i{excluding} the trailing
NUL char.
*/

/*! \fn char *QLatin1Literal::data() const
Returns a pointer to the first character of the string literal.
The string literal is terminated by a NUL character.
*/

/*! \fn QLatin1Literal::operator QString() const
Converts the \c QLatin1Literal into a \c QString object.
*/



/*!
\class QStringBuilder
\reentrant
\since 4.6
\brief QStringBuilder is a template class that provides a facility to build
up QStrings from smaller chunks.
\ingroup tools
\ingroup shared
\ingroup text
\mainclass
When creating strings from smaller chunks, typically \c QString::operator+()
is used, resulting in \i{n - 1} reallocations when operating on \i{n} chunks.
QStringBuilder uses expression templates to collect the individual parts,
compute the total size, allocate memory for the resulting QString object,
and copy the contents of the chunks into the result.
The QStringBuilder class is not to be used explicitly in user code.
Instances of the class are created as return values of the operator%()
function, acting on objects of type \c QString, \c QLatin1String,
\c QLatin1Literal, \c \QStringRef, \c QChar,
\c QLatin1Char, and \c char.
Concatenating strings with operator%() generally yields better
performance then using \c QString::operator+() on the same chunks
if there are three or more of them, and performs equally well in other
cases.
\sa QLatin1Literal, QString
*/

/* !fn template <class A, class B> QStringBuilder<A, B> operator%(const A &a, const B &b)
Returns a \c QStringBuilder object that is converted to a QString object
when assigned to a variable of QString type or passed to a function that
takes a QString parameter.
This function is usable with arguments of type \c QString,
\c QLatin1String, \c QLatin1Literal, \c QStringRef,
\c QChar, \c QLatin1Char, and \c char.
*/

0 comments on commit 3331605

Please sign in to comment.