Changeset 561 for trunk/src/testlib/qxmltestlogger.cpp

Timestamp:

Feb 11, 2010, 11:19:06 PM (15 years ago)

Author:

Dmitry A. Kuminov

Message:

trunk: Merged in qt 4.6.1 sources.

Location:

trunk

Files:

• . (modified) (1 prop)
• src/testlib/qxmltestlogger.cpp (modified) (13 diffs)

trunk/src/testlib/qxmltestlogger.cpp

@@ -2 +2 @@
 **
 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
-** Contact: Qt Software Information (qt-info@nokia.com)
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
 **
 ** This file is part of the QtTest module of the Qt Toolkit.
@@ -21 +22 @@
 ** 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.
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
 **
 ** GNU General Public License Usage
@@ -34 +34 @@
 ** 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.
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
 ** $QT_END_LICENSE$
 **
@@ -47 +47 @@
 #include "QtTest/private/qtestresult_p.h"
 #include "QtTest/private/qbenchmark_p.h"
+#include "QtTest/qtestcase.h"
 
 QT_BEGIN_NAMESPACE
@@ -91 +92 @@
 
 
-QXmlTestLogger::QXmlTestLogger(XmlMode mode ):
-    xmlmode(mode)
+QXmlTestLogger::QXmlTestLogger(XmlMode mode )
+    :xmlmode(mode)
 {
 
@@ -99 +100 @@
 QXmlTestLogger::~QXmlTestLogger()
 {
-
-}
-
+}
 
 void QXmlTestLogger::startLogging()
 {
     QAbstractTestLogger::startLogging();
-    char buf[1024];
+    QTestCharBuffer buf;
 
     if (xmlmode == QXmlTestLogger::Complete) {
-        QTest::qt_snprintf(buf, sizeof(buf),
+        QTestCharBuffer quotedTc;
+        xmlQuote(&quotedTc, QTestResult::currentTestObjectName());
+        QTest::qt_asprintf(&buf,
                 "<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>\n"
-                "<TestCase name=\"%s\">\n", QTestResult::currentTestObjectName());
-        outputString(buf);
-    }
-
-    QTest::qt_snprintf(buf, sizeof(buf),
+                "<TestCase name=\"%s\">\n", quotedTc.constData());
+        outputString(buf.constData());
+    }
+
+    QTest::qt_asprintf(&buf,
             "<Environment>\n"
             "    <QtVersion>%s</QtVersion>\n"
             "    <QTestVersion>"QTEST_VERSION_STR"</QTestVersion>\n"
             "</Environment>\n", qVersion());
-    outputString(buf);
+    outputString(buf.constData());
 }
 
@@ -134 +135 @@
 void QXmlTestLogger::enterTestFunction(const char *function)
 {
-    char buf[1024];
-    QTest::qt_snprintf(buf, sizeof(buf), "<TestFunction name=\"%s\">\n", function);
-    outputString(buf);
+    QTestCharBuffer buf;
+    QTestCharBuffer quotedFunction;
+    xmlQuote(&quotedFunction, function);
+    QTest::qt_asprintf(&buf, "<TestFunction name=\"%s\">\n", quotedFunction.constData());
+    outputString(buf.constData());
 }
 
@@ -159 +162 @@
         else
             return "<Incident type=\"%s\" file=\"%s\" line=\"%d\">\n"
-                   "    <DataTag><![CDATA[%s%s%s%s]]></DataTag>\n"
-                   "</Incident>\n";
+                "    <DataTag><![CDATA[%s%s%s%s]]></DataTag>\n"
+                "</Incident>\n";
     } else {
         if (noTag)
             return "<Incident type=\"%s\" file=\"%s\" line=\"%d\">\n"
-                   "    <Description><![CDATA[%s%s%s%s]]></Description>\n"
-                   "</Incident>\n";
+                "    <Description><![CDATA[%s%s%s%s]]></Description>\n"
+                "</Incident>\n";
         else
             return "<Incident type=\"%s\" file=\"%s\" line=\"%d\">\n"
-                   "    <DataTag><![CDATA[%s%s%s]]></DataTag>\n"
-                   "    <Description><![CDATA[%s]]></Description>\n"
-                   "</Incident>\n";
+                "    <DataTag><![CDATA[%s%s%s]]></DataTag>\n"
+                "    <Description><![CDATA[%s]]></Description>\n"
+                "</Incident>\n";
     }
 }
@@ -186 +189 @@
         else
             return "<Message type=\"%s\" file=\"%s\" line=\"%d\">\n"
-                   "    <DataTag><![CDATA[%s%s%s%s]]></DataTag>\n"
-                   "</Message>\n";
+                "    <DataTag><![CDATA[%s%s%s%s]]></DataTag>\n"
+                "</Message>\n";
     } else {
         if (noTag)
             return "<Message type=\"%s\" file=\"%s\" line=\"%d\">\n"
-                   "    <Description><![CDATA[%s%s%s%s]]></Description>\n"
-                   "</Message>\n";
+                "    <Description><![CDATA[%s%s%s%s]]></Description>\n"
+                "</Message>\n";
         else
             return "<Message type=\"%s\" file=\"%s\" line=\"%d\">\n"
-                   "    <DataTag><![CDATA[%s%s%s]]></DataTag>\n"
-                   "    <Description><![CDATA[%s]]></Description>\n"
-                   "</Message>\n";
+                "    <DataTag><![CDATA[%s%s%s]]></DataTag>\n"
+                "    <Description><![CDATA[%s]]></Description>\n"
+                "</Message>\n";
     }
 }
@@ -204 +207 @@
 
 void QXmlTestLogger::addIncident(IncidentTypes type, const char *description,
-                                 const char *file, int line)
-{
-    char buf[1536];
+                                const char *file, int line)
+{
+    QTestCharBuffer buf;
     const char *tag = QTestResult::currentDataTag();
     const char *gtag = QTestResult::currentGlobalDataTag();
@@ -212 +215 @@
     const bool notag = QTest::isEmpty(tag) && QTest::isEmpty(gtag);
 
-    QTest::qt_snprintf(buf, sizeof(buf),
+    QTestCharBuffer quotedFile;
+    QTestCharBuffer cdataGtag;
+    QTestCharBuffer cdataTag;
+    QTestCharBuffer cdataDescription;
+
+    xmlQuote(&quotedFile, file);
+    xmlCdata(&cdataGtag, gtag);
+    xmlCdata(&cdataTag, tag);
+    xmlCdata(&cdataDescription, description);
+
+    QTest::qt_asprintf(&buf,
             QTest::incidentFormatString(QTest::isEmpty(description), notag),
             QTest::xmlIncidentType2String(type),
-            file ? file : "", line,
-            gtag ? gtag : "",
+            quotedFile.constData(), line,
+            cdataGtag.constData(),
             filler,
-            tag ? tag : "",
-            description ? description : "");
-
-    outputString(buf);
+            cdataTag.constData(),
+            cdataDescription.constData());
+
+    outputString(buf.constData());
 }
 
 void QXmlTestLogger::addBenchmarkResult(const QBenchmarkResult &result)
 {
-    char buf[1536];
-    QTest::qt_snprintf(
-        buf, sizeof(buf),
+    QTestCharBuffer buf;
+    QTestCharBuffer quotedMetric;
+    QTestCharBuffer quotedTag;
+
+    xmlQuote(&quotedMetric,
+        QBenchmarkGlobalData::current->measurer->metricText().toAscii().constData());
+    xmlQuote(&quotedTag, result.context.tag.toAscii().constData());
+
+    QTest::qt_asprintf(
+        &buf,
         QTest::benchmarkResultFormatString(),
-        QBenchmarkGlobalData::current->measurer->metricText().toAscii().data(),
-        result.context.tag.toAscii().data(),
+        quotedMetric.constData(),
+        quotedTag.constData(),
         QByteArray::number(result.value).constData(),  //no 64-bit qt_snprintf support
-        result.iterations); 
-    outputString(buf);
+        result.iterations);
+    outputString(buf.constData());
 }
 
@@ -240 +260 @@
                                 const char *file, int line)
 {
-    char buf[1536];
-    char msgbuf[1024];
+    QTestCharBuffer buf;
     const char *tag = QTestResult::currentDataTag();
     const char *gtag = QTestResult::currentGlobalDataTag();
@@ -247 +266 @@
     const bool notag = QTest::isEmpty(tag) && QTest::isEmpty(gtag);
 
-    QTest::qt_snprintf(msgbuf, sizeof(msgbuf), "%s",
-                        message ? message : "");
-
-    QTest::qt_snprintf(buf, sizeof(buf),
+    QTestCharBuffer quotedFile;
+    QTestCharBuffer cdataGtag;
+    QTestCharBuffer cdataTag;
+    QTestCharBuffer cdataDescription;
+
+    xmlQuote(&quotedFile, file);
+    xmlCdata(&cdataGtag, gtag);
+    xmlCdata(&cdataTag, tag);
+    xmlCdata(&cdataDescription, message);
+
+    QTest::qt_asprintf(&buf,
             QTest::messageFormatString(QTest::isEmpty(message), notag),
             QTest::xmlMessageType2String(type),
-            file ? file : "", line,
-            gtag ? gtag : "",
+            quotedFile.constData(), line,
+            cdataGtag.constData(),
             filler,
-            tag ? tag : "",
-            msgbuf);
-
-    outputString(buf);
+            cdataTag.constData(),
+            cdataDescription.constData());
+
+    outputString(buf.constData());
+}
+
+/*
+    Copy up to n characters from the src string into dest, escaping any special
+    XML characters as necessary so that dest is suitable for use in an XML
+    quoted attribute string.
+*/
+int QXmlTestLogger::xmlQuote(QTestCharBuffer* destBuf, char const* src, size_t n)
+{
+    if (n == 0) return 0;
+
+    char *dest = destBuf->data();
+    *dest = 0;
+    if (!src) return 0;
+
+    char* begin = dest;
+    char* end = dest + n;
+
+    while (dest < end) {
+        switch (*src) {
+
+#define MAP_ENTITY(chr, ent) \
+            case chr:                                   \
+                if (dest + sizeof(ent) < end) {         \
+                    strcpy(dest, ent);                  \
+                    dest += sizeof(ent) - 1;            \
+                }                                       \
+                else {                                  \
+                    *dest = 0;                          \
+                    return (dest+sizeof(ent)-begin);    \
+                }                                       \
+                ++src;                                  \
+                break;
+
+            MAP_ENTITY('>', "&gt;");
+            MAP_ENTITY('<', "&lt;");
+            MAP_ENTITY('\'', "&apos;");
+            MAP_ENTITY('"', "&quot;");
+            MAP_ENTITY('&', "&amp;");
+
+            // not strictly necessary, but allows handling of comments without
+            // having to explicitly look for `--'
+            MAP_ENTITY('-', "&#x002D;");
+
+#undef MAP_ENTITY
+
+            case 0:
+                *dest = 0;
+                return (dest-begin);
+
+            default:
+                *dest = *src;
+                ++dest;
+                ++src;
+                break;
+        }
+    }
+
+    // If we get here, dest was completely filled (dest == end)
+    *(dest-1) = 0;
+    return (dest-begin);
+}
+
+/*
+    Copy up to n characters from the src string into dest, escaping any
+    special strings such that dest is suitable for use in an XML CDATA section.
+*/
+int QXmlTestLogger::xmlCdata(QTestCharBuffer *destBuf, char const* src, size_t n)
+{
+    if (!n) return 0;
+
+    char *dest = destBuf->data();
+
+    if (!src || n == 1) {
+        *dest = 0;
+        return 0;
+    }
+
+    static char const CDATA_END[] = "]]>";
+    static char const CDATA_END_ESCAPED[] = "]]]><![CDATA[]>";
+
+    char* begin = dest;
+    char* end = dest + n;
+    while (dest < end) {
+        if (!*src) {
+            *dest = 0;
+            return (dest-begin);
+        }
+
+        if (!strncmp(src, CDATA_END, sizeof(CDATA_END)-1)) {
+            if (dest + sizeof(CDATA_END_ESCAPED) < end) {
+                strcpy(dest, CDATA_END_ESCAPED);
+                src += sizeof(CDATA_END)-1;
+                dest += sizeof(CDATA_END_ESCAPED) - 1;
+            }
+            else {
+                *dest = 0;
+                return (dest+sizeof(CDATA_END_ESCAPED)-begin);
+            }
+            continue;
+        }
+
+        *dest = *src;
+        ++src;
+        ++dest;
+    }
+
+    // If we get here, dest was completely filled (dest == end)
+    *(dest-1) = 0;
+    return (dest-begin);
+}
+
+typedef int (*StringFormatFunction)(QTestCharBuffer*,char const*,size_t);
+
+/*
+    A wrapper for string functions written to work with a fixed size buffer so they can be called
+    with a dynamically allocated buffer.
+*/
+int allocateStringFn(QTestCharBuffer* str, char const* src, StringFormatFunction func)
+{
+    static const int MAXSIZE = 1024*1024*2;
+
+    int size = str->size();
+
+    int res = 0;
+
+    for (;;) {
+        res = func(str, src, size);
+        str->data()[size - 1] = '\0';
+        if (res < size) {
+            // We succeeded or fatally failed
+            break;
+        }
+        // buffer wasn't big enough, try again
+        size *= 2;
+        if (size > MAXSIZE) {
+            break;
+        }
+        if (!str->reset(size))
+            break; // ran out of memory - bye
+    }
+
+    return res;
+}
+
+int QXmlTestLogger::xmlQuote(QTestCharBuffer* str, char const* src)
+{
+    return allocateStringFn(str, src, QXmlTestLogger::xmlQuote);
+}
+
+int QXmlTestLogger::xmlCdata(QTestCharBuffer* str, char const* src)
+{
+    return allocateStringFn(str, src, QXmlTestLogger::xmlCdata);
 }