Diaglib: Add helper functions for analyzing non-Latin strings.

Add a functions to dump out texts character by character and
as code.

Task-number: QTBUG-43191
Change-Id: I1ac17f2485563f909b71bb1fbd1fd595d1d94223
Reviewed-by: Andy Shaw <andy.shaw@digia.com>
Reviewed-by: Shawn Rutledge <shawn.rutledge@digia.com>
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@theqtcompany.com>

4 files changed, 512 insertions, 0 deletions

diff --git a/tests/manual/diaglib/README.txt b/tests/manual/diaglib/README.txt
index 13387f5a2a..0fb226c750 100644
--- a/tests/manual/diaglib/README.txt
+++ b/tests/manual/diaglib/README.txt
@@ -12,6 +12,17 @@ code can be enlosed within #ifdef to work without it as well.
 
 All functions and classes are in the QtDiag namespace.
 
+function dumpText() (textdump.h)
+  Returns a string containing the input text split up in characters
+  listing category, script, direction etc.
+  Useful for analyzing non-Latin text.
+
+function  dumpTextAsCode() (textdump.h)
+   Returns a string containing a code snippet creating a QString
+   by appending the unicode value of character of the input.
+   This is useful for constructing non-Latin strings with purely ASCII
+   source code.
+
 class EventFilter (eventfilter.h):
   An event filter that logs Qt events to qDebug() depending on
   configured categories (for example mouse, keyboard, etc).
diff --git a/tests/manual/diaglib/diaglib.pri b/tests/manual/diaglib/diaglib.pri
index e162d5f105..a1f1893f52 100644
--- a/tests/manual/diaglib/diaglib.pri
+++ b/tests/manual/diaglib/diaglib.pri
@@ -1,9 +1,11 @@
 INCLUDEPATH += $$PWD
 SOURCES += \
+    $$PWD/textdump.cpp \
     $$PWD/eventfilter.cpp \
     $$PWD/qwindowdump.cpp \
 
 HEADERS += \
+    $$PWD/textdump.h \
     $$PWD/eventfilter.h \
     $$PWD/qwindowdump.h \
     $$PWD/nativewindowdump.h
diff --git a/tests/manual/diaglib/textdump.cpp b/tests/manual/diaglib/textdump.cpp
new file mode 100644
index 0000000000..7f08350874
--- /dev/null
+++ b/tests/manual/diaglib/textdump.cpp
@@ -0,0 +1,451 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the test suite of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL21$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** 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 or version 3 as published by the Free
+** Software Foundation and appearing in the file LICENSE.LGPLv21 and
+** LICENSE.LGPLv3 included in the packaging of this file. Please review the
+** following information to ensure the GNU Lesser General Public License
+** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights. These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "textdump.h"
+
+#include <QTextStream>
+#include <QString>
+
+namespace QtDiag {
+
+struct EnumLookup {
+    int value;
+    const char *description;
+};
+
+static const EnumLookup specialCharactersEnumLookup[] =
+{
+    {QChar::Null, "Null"},
+#if QT_VERSION >= 0x050000
+    {QChar::Tabulation, "Tabulation"},
+    {QChar::LineFeed, "LineFeed"},
+    {QChar::CarriageReturn, "CarriageReturn"},
+    {QChar::Space, "Space"},
+#endif
+    {QChar::Nbsp, "Nbsp"},
+#if QT_VERSION >= 0x050000
+    {QChar::SoftHyphen, "SoftHyphen"},
+#endif
+    {QChar::ReplacementCharacter, "ReplacementCharacter"},
+    {QChar::ObjectReplacementCharacter, "ObjectReplacementCharacter"},
+    {QChar::ByteOrderMark, "ByteOrderMark"},
+    {QChar::ByteOrderSwapped, "ByteOrderSwapped"},
+    {QChar::ParagraphSeparator, "ParagraphSeparator"},
+    {QChar::LineSeparator, "LineSeparator"},
+#if QT_VERSION >= 0x050000
+    {QChar::LastValidCodePoint, "LastValidCodePoint"}
+#endif
+};
+
+static const EnumLookup categoryEnumLookup[] =
+{
+    {QChar::Mark_NonSpacing, "Mark_NonSpacing"},
+    {QChar::Mark_SpacingCombining, "Mark_SpacingCombining"},
+    {QChar::Mark_Enclosing, "Mark_Enclosing"},
+
+    {QChar::Number_DecimalDigit, "Number_DecimalDigit"},
+    {QChar::Number_Letter, "Number_Letter"},
+    {QChar::Number_Other, "Number_Other"},
+
+    {QChar::Separator_Space, "Separator_Space"},
+    {QChar::Separator_Line, "Separator_Line"},
+    {QChar::Separator_Paragraph, "Separator_Paragraph"},
+
+    {QChar::Other_Control, "Other_Control"},
+    {QChar::Other_Format, "Other_Format"},
+    {QChar::Other_Surrogate, "Other_Surrogate"},
+    {QChar::Other_PrivateUse, "Other_PrivateUse"},
+    {QChar::Other_NotAssigned, "Other_NotAssigned"},
+
+    {QChar::Letter_Uppercase, "Letter_Uppercase"},
+    {QChar::Letter_Lowercase, "Letter_Lowercase"},
+    {QChar::Letter_Titlecase, "Letter_Titlecase"},
+    {QChar::Letter_Modifier, "Letter_Modifier"},
+    {QChar::Letter_Other, "Letter_Other"},
+
+    {QChar::Punctuation_Connector, "Punctuation_Connector"},
+    {QChar::Punctuation_Dash, "Punctuation_Dash"},
+    {QChar::Punctuation_Open, "Punctuation_Open"},
+    {QChar::Punctuation_Close, "Punctuation_Close"},
+    {QChar::Punctuation_InitialQuote, "Punctuation_InitialQuote"},
+    {QChar::Punctuation_FinalQuote, "Punctuation_FinalQuote"},
+    {QChar::Punctuation_Other, "Punctuation_Other"},
+
+    {QChar::Symbol_Math, "Symbol_Math"},
+    {QChar::Symbol_Currency, "Symbol_Currency"},
+    {QChar::Symbol_Modifier, "Symbol_Modifier"},
+    {QChar::Symbol_Other, "Symbol_Other"},
+};
+
+#if QT_VERSION >= 0x050100
+
+static const EnumLookup scriptEnumLookup[] =
+{
+    {QChar::Script_Unknown, "Script_Unknown"},
+    {QChar::Script_Inherited, "Script_Inherited"},
+    {QChar::Script_Common, "Script_Common"},
+
+    {QChar::Script_Latin, "Script_Latin"},
+    {QChar::Script_Greek, "Script_Greek"},
+    {QChar::Script_Cyrillic, "Script_Cyrillic"},
+    {QChar::Script_Armenian, "Script_Armenian"},
+    {QChar::Script_Hebrew, "Script_Hebrew"},
+    {QChar::Script_Arabic, "Script_Arabic"},
+    {QChar::Script_Syriac, "Script_Syriac"},
+    {QChar::Script_Thaana, "Script_Thaana"},
+    {QChar::Script_Devanagari, "Script_Devanagari"},
+    {QChar::Script_Bengali, "Script_Bengali"},
+    {QChar::Script_Gurmukhi, "Script_Gurmukhi"},
+    {QChar::Script_Gujarati, "Script_Gujarati"},
+    {QChar::Script_Oriya, "Script_Oriya"},
+    {QChar::Script_Tamil, "Script_Tamil"},
+    {QChar::Script_Telugu, "Script_Telugu"},
+    {QChar::Script_Kannada, "Script_Kannada"},
+    {QChar::Script_Malayalam, "Script_Malayalam"},
+    {QChar::Script_Sinhala, "Script_Sinhala"},
+    {QChar::Script_Thai, "Script_Thai"},
+    {QChar::Script_Lao, "Script_Lao"},
+    {QChar::Script_Tibetan, "Script_Tibetan"},
+    {QChar::Script_Myanmar, "Script_Myanmar"},
+    {QChar::Script_Georgian, "Script_Georgian"},
+    {QChar::Script_Hangul, "Script_Hangul"},
+    {QChar::Script_Ethiopic, "Script_Ethiopic"},
+    {QChar::Script_Cherokee, "Script_Cherokee"},
+    {QChar::Script_CanadianAboriginal, "Script_CanadianAboriginal"},
+    {QChar::Script_Ogham, "Script_Ogham"},
+    {QChar::Script_Runic, "Script_Runic"},
+    {QChar::Script_Khmer, "Script_Khmer"},
+    {QChar::Script_Mongolian, "Script_Mongolian"},
+    {QChar::Script_Hiragana, "Script_Hiragana"},
+    {QChar::Script_Katakana, "Script_Katakana"},
+    {QChar::Script_Bopomofo, "Script_Bopomofo"},
+    {QChar::Script_Han, "Script_Han"},
+    {QChar::Script_Yi, "Script_Yi"},
+    {QChar::Script_OldItalic, "Script_OldItalic"},
+    {QChar::Script_Gothic, "Script_Gothic"},
+    {QChar::Script_Deseret, "Script_Deseret"},
+    {QChar::Script_Tagalog, "Script_Tagalog"},
+    {QChar::Script_Hanunoo, "Script_Hanunoo"},
+    {QChar::Script_Buhid, "Script_Buhid"},
+    {QChar::Script_Tagbanwa, "Script_Tagbanwa"},
+    {QChar::Script_Coptic, "Script_Coptic"},
+
+    {QChar::Script_Limbu, "Script_Limbu"},
+    {QChar::Script_TaiLe, "Script_TaiLe"},
+    {QChar::Script_LinearB, "Script_LinearB"},
+    {QChar::Script_Ugaritic, "Script_Ugaritic"},
+    {QChar::Script_Shavian, "Script_Shavian"},
+    {QChar::Script_Osmanya, "Script_Osmanya"},
+    {QChar::Script_Cypriot, "Script_Cypriot"},
+    {QChar::Script_Braille, "Script_Braille"},
+
+    {QChar::Script_Buginese, "Script_Buginese"},
+    {QChar::Script_NewTaiLue, "Script_NewTaiLue"},
+    {QChar::Script_Glagolitic, "Script_Glagolitic"},
+    {QChar::Script_Tifinagh, "Script_Tifinagh"},
+    {QChar::Script_SylotiNagri, "Script_SylotiNagri"},
+    {QChar::Script_OldPersian, "Script_OldPersian"},
+    {QChar::Script_Kharoshthi, "Script_Kharoshthi"},
+
+    {QChar::Script_Balinese, "Script_Balinese"},
+    {QChar::Script_Cuneiform, "Script_Cuneiform"},
+    {QChar::Script_Phoenician, "Script_Phoenician"},
+    {QChar::Script_PhagsPa, "Script_PhagsPa"},
+    {QChar::Script_Nko, "Script_Nko"},
+
+    {QChar::Script_Sundanese, "Script_Sundanese"},
+    {QChar::Script_Lepcha, "Script_Lepcha"},
+    {QChar::Script_OlChiki, "Script_OlChiki"},
+    {QChar::Script_Vai, "Script_Vai"},
+    {QChar::Script_Saurashtra, "Script_Saurashtra"},
+    {QChar::Script_KayahLi, "Script_KayahLi"},
+    {QChar::Script_Rejang, "Script_Rejang"},
+    {QChar::Script_Lycian, "Script_Lycian"},
+    {QChar::Script_Carian, "Script_Carian"},
+    {QChar::Script_Lydian, "Script_Lydian"},
+    {QChar::Script_Cham, "Script_Cham"},
+
+    {QChar::Script_TaiTham, "Script_TaiTham"},
+    {QChar::Script_TaiViet, "Script_TaiViet"},
+    {QChar::Script_Avestan, "Script_Avestan"},
+    {QChar::Script_EgyptianHieroglyphs, "Script_EgyptianHieroglyphs"},
+    {QChar::Script_Samaritan, "Script_Samaritan"},
+    {QChar::Script_Lisu, "Script_Lisu"},
+    {QChar::Script_Bamum, "Script_Bamum"},
+    {QChar::Script_Javanese, "Script_Javanese"},
+    {QChar::Script_MeeteiMayek, "Script_MeeteiMayek"},
+    {QChar::Script_ImperialAramaic, "Script_ImperialAramaic"},
+    {QChar::Script_OldSouthArabian, "Script_OldSouthArabian"},
+    {QChar::Script_InscriptionalParthian, "Script_InscriptionalParthian"},
+    {QChar::Script_InscriptionalPahlavi, "Script_InscriptionalPahlavi"},
+    {QChar::Script_OldTurkic, "Script_OldTurkic"},
+    {QChar::Script_Kaithi, "Script_Kaithi"},
+
+    {QChar::Script_Batak, "Script_Batak"},
+    {QChar::Script_Brahmi, "Script_Brahmi"},
+    {QChar::Script_Mandaic, "Script_Mandaic"},
+
+    {QChar::Script_Chakma, "Script_Chakma"},
+    {QChar::Script_MeroiticCursive, "Script_MeroiticCursive"},
+    {QChar::Script_MeroiticHieroglyphs, "Script_MeroiticHieroglyphs"},
+    {QChar::Script_Miao, "Script_Miao"},
+    {QChar::Script_Sharada, "Script_Sharada"},
+    {QChar::Script_SoraSompeng, "Script_SoraSompeng"},
+    {QChar::Script_Takri, "Script_Takri"},
+};
+
+#endif // Qt 5.1
+
+static const EnumLookup directionEnumLookup[] =
+{
+    {QChar::DirL, "DirL"},
+    {QChar::DirR, "DirR"},
+    {QChar::DirEN, "DirEN"},
+    {QChar::DirES, "DirES"},
+    {QChar::DirET, "DirET"},
+    {QChar::DirAN, "DirAN"},
+    {QChar::DirCS, "DirCS"},
+    {QChar::DirB, "DirB"},
+    {QChar::DirS, "DirS"},
+    {QChar::DirWS, "DirWS"},
+    {QChar::DirON, "DirON"},
+    {QChar::DirLRE, "DirLRE"},
+    {QChar::DirLRO, "DirLRO"},
+    {QChar::DirAL, "DirAL"},
+    {QChar::DirRLE, "DirRLE"},
+    {QChar::DirRLO, "DirRLO"},
+    {QChar::DirPDF, "DirPDF"},
+    {QChar::DirNSM, "DirNSM"},
+    {QChar::DirBN, "DirBN"},
+#if QT_VERSION >= 0x050000
+    {QChar::DirLRI, "DirLRI"},
+    {QChar::DirRLI, "DirRLI"},
+    {QChar::DirFSI, "DirFSI"},
+    {QChar::DirPDI, "DirPDI"},
+#endif
+};
+
+static const EnumLookup decompositionEnumLookup[] =
+{
+    {QChar::NoDecomposition, "NoDecomposition"},
+    {QChar::Canonical, "Canonical"},
+    {QChar::Font, "Font"},
+    {QChar::NoBreak, "NoBreak"},
+    {QChar::Initial, "Initial"},
+    {QChar::Medial, "Medial"},
+    {QChar::Final, "Final"},
+    {QChar::Isolated, "Isolated"},
+    {QChar::Circle, "Circle"},
+    {QChar::Super, "Super"},
+    {QChar::Sub, "Sub"},
+    {QChar::Vertical, "Vertical"},
+    {QChar::Wide, "Wide"},
+    {QChar::Narrow, "Narrow"},
+    {QChar::Small, "Small"},
+    {QChar::Square, "Square"},
+    {QChar::Compat, "Compat"},
+    {QChar::Fraction, "Fraction"},
+};
+
+#if QT_VERSION >= 0x050000
+
+static const EnumLookup joiningTypeEnumLookup[] =
+{
+    {QChar::Joining_None, "Joining_None"},
+    {QChar::Joining_Causing, "Joining_Causing"},
+    {QChar::Joining_Dual, "Joining_Dual"},
+    {QChar::Joining_Right, "Joining_Right"},
+    {QChar::Joining_Left, "Joining_Left"},
+    {QChar::Joining_Transparent, "Joining_Transparent"}
+};
+
+#endif // Qt 5
+
+static const EnumLookup combiningClassEnumLookup[] =
+{
+    {QChar::Combining_BelowLeftAttached, "Combining_BelowLeftAttached"},
+    {QChar::Combining_BelowAttached, "Combining_BelowAttached"},
+    {QChar::Combining_BelowRightAttached, "Combining_BelowRightAttached"},
+    {QChar::Combining_LeftAttached, "Combining_LeftAttached"},
+    {QChar::Combining_RightAttached, "Combining_RightAttached"},
+    {QChar::Combining_AboveLeftAttached, "Combining_AboveLeftAttached"},
+    {QChar::Combining_AboveAttached, "Combining_AboveAttached"},
+    {QChar::Combining_AboveRightAttached, "Combining_AboveRightAttached"},
+
+    {QChar::Combining_BelowLeft, "Combining_BelowLeft"},
+    {QChar::Combining_Below, "Combining_Below"},
+    {QChar::Combining_BelowRight, "Combining_BelowRight"},
+    {QChar::Combining_Left, "Combining_Left"},
+    {QChar::Combining_Right, "Combining_Right"},
+    {QChar::Combining_AboveLeft, "Combining_AboveLeft"},
+    {QChar::Combining_Above, "Combining_Above"},
+    {QChar::Combining_AboveRight, "Combining_AboveRight"},
+
+    {QChar::Combining_DoubleBelow, "Combining_DoubleBelow"},
+    {QChar::Combining_DoubleAbove, "Combining_DoubleAbove"},
+    {QChar::Combining_IotaSubscript, "Combining_IotaSubscript"},
+};
+
+static const EnumLookup unicodeVersionEnumLookup[] =
+{
+    {QChar::Unicode_Unassigned, "Unicode_Unassigned"},
+    {QChar::Unicode_1_1, "Unicode_1_1"},
+    {QChar::Unicode_2_0, "Unicode_2_0"},
+    {QChar::Unicode_2_1_2, "Unicode_2_1_2"},
+    {QChar::Unicode_3_0, "Unicode_3_0"},
+    {QChar::Unicode_3_1, "Unicode_3_1"},
+    {QChar::Unicode_3_2, "Unicode_3_2"},
+    {QChar::Unicode_4_0, "Unicode_4_0"},
+    {QChar::Unicode_4_1, "Unicode_4_1"},
+    {QChar::Unicode_5_0, "Unicode_5_0"},
+#if QT_VERSION >= 0x050000
+    {QChar::Unicode_5_1, "Unicode_5_1"},
+    {QChar::Unicode_5_2, "Unicode_5_2"},
+    {QChar::Unicode_6_0, "Unicode_6_0"},
+    {QChar::Unicode_6_1, "Unicode_6_1"},
+    {QChar::Unicode_6_2, "Unicode_6_2"},
+    {QChar::Unicode_6_3, "Unicode_6_3"},
+#endif // Qt 5
+};
+
+static const EnumLookup *enumLookup(int v, const EnumLookup *array, size_t size)
+{
+    const EnumLookup *end = array + size;
+    for (const EnumLookup *p = array; p < end; ++p) {
+        if (p->value == v)
+            return p;
+    }
+    return 0;
+}
+
+static const char *enumName(int v, const EnumLookup *array, size_t size)
+{
+    const EnumLookup *e = enumLookup(v, array, size);
+    return e ? e->description : "<unknown>";
+}
+
+// Context struct storing the parameters of the last character, only the parameters
+// that change will be output.
+struct FormattingContext
+{
+    FormattingContext() : category(-1), direction(-1), joiningType(-1)
+      , decompositionTag(-1), script(-1), unicodeVersion(-1) {}
+
+    int category;
+    int direction;
+    int joiningType;
+    int decompositionTag;
+    int script;
+    int unicodeVersion;
+};
+
+static void formatCharacter(QTextStream &str, const QChar &qc, FormattingContext &context)
+{
+    const ushort unicode = qc.unicode();
+    str << "U+" << qSetFieldWidth(4) << qSetPadChar('0') << uppercasedigits << hex << unicode
+        << dec << qSetFieldWidth(0) << ' ';
+
+    const EnumLookup *specialChar = enumLookup(unicode, specialCharactersEnumLookup, sizeof(specialCharactersEnumLookup) / sizeof(EnumLookup));
+    if (specialChar)
+        str << specialChar->description;
+    else
+        str << "'" << qc << '\'';
+
+    const int category = qc.category();
+    if (category != context.category) {
+        str << " category="
+            << enumName(category, categoryEnumLookup, sizeof(categoryEnumLookup) / sizeof(EnumLookup));
+        context.category = category;
+    }
+#if QT_VERSION >= 0x050100
+    const int script = qc.script();
+    if (script != context.script) {
+        str << " script="
+            << enumName(script, scriptEnumLookup, sizeof(scriptEnumLookup) / sizeof(EnumLookup))
+            << '(' << script << ')';
+        context.script = script;
+    }
+#endif // Qt 5
+    const int direction = qc.direction();
+    if (direction != context.direction) {
+        str << " direction="
+            << enumName(direction, directionEnumLookup, sizeof(directionEnumLookup) / sizeof(EnumLookup));
+        context.direction = direction;
+    }
+#if QT_VERSION >= 0x050000
+    const int joiningType = qc.joiningType();
+    if (joiningType != context.joiningType) {
+        str << " joiningType="
+            << enumName(joiningType, joiningTypeEnumLookup, sizeof(joiningTypeEnumLookup) / sizeof(EnumLookup));
+        context.joiningType = joiningType;
+    }
+#endif // Qt 5QWidget
+    const int decompositionTag = qc.decompositionTag();
+    if (decompositionTag != context.decompositionTag) {
+        str << " decomposition="
+            << enumName(decompositionTag, decompositionEnumLookup, sizeof(decompositionEnumLookup) / sizeof(EnumLookup));
+        context.decompositionTag = decompositionTag;
+    }
+    const int unicodeVersion = qc.unicodeVersion();
+    if (unicodeVersion != context.unicodeVersion) {
+        str << " version="
+        << enumName(unicodeVersion, unicodeVersionEnumLookup, sizeof(unicodeVersionEnumLookup) / sizeof(EnumLookup));
+        context.unicodeVersion = unicodeVersion;
+    }
+}
+
+QString dumpText(const QString &text)
+{
+    QString result;
+    QTextStream str(&result);
+    FormattingContext context;
+    for (int i = 0; i < text.size(); ++i) {
+        str << '#' << (i + 1) << ' ';
+        formatCharacter(str, text.at(i), context);
+        str << '\n';
+    }
+    return result;
+}
+
+QString dumpTextAsCode(const QString &text)
+{
+    QString result;
+    QTextStream str(&result);
+    str << "    QString result;\n" << hex << showbase;
+    for (int i = 0; i < text.size(); ++i)
+        str << "    result += QChar(" << text.at(i).unicode() << ");\n";
+    str << '\n';
+    return result;
+}
+
+} // namespace QtDiag
diff --git a/tests/manual/diaglib/textdump.h b/tests/manual/diaglib/textdump.h
new file mode 100644
index 0000000000..596c57de50
--- /dev/null
+++ b/tests/manual/diaglib/textdump.h
@@ -0,0 +1,48 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the test suite of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL21$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** 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 or version 3 as published by the Free
+** Software Foundation and appearing in the file LICENSE.LGPLv21 and
+** LICENSE.LGPLv3 included in the packaging of this file. Please review the
+** following information to ensure the GNU Lesser General Public License
+** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights. These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef TEXTDUMP_H
+#define TEXTDUMP_H
+
+#include <QtCore/QtGlobal>
+
+QT_FORWARD_DECLARE_CLASS(QString)
+
+namespace QtDiag {
+
+QString dumpText(const QString &text);
+QString dumpTextAsCode(const QString &text);
+
+} // namespace QtDiag
+
+#endif // TEXTDUMP_H