1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the test suite of the Qt Toolkit.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    36 **

    37 **

    38 ** $QT_END_LICENSE$

    39 **

    40 ****************************************************************************/

    41 #ifndef HTMLGENERATOR_H

    42 #define HTMLGENERATOR_H

    43 

    44 #include "xmldata.h"

    45 

    46 #include <QTextStream>

    47 #include <QList>

    48 #include <QString>

    49 

    50 QT_FORWARD_DECLARE_CLASS(QStringList)

    51 QT_FORWARD_DECLARE_CLASS(QSettings)

    52 

    53 struct HTMLImage

    54 {

    55 public:

    56     QString        file;

    57     QString        generatorName;

    58     GeneratorFlags flags;

    59     QString        details;

    60 };

    61 

    62 struct HTMLRow

    63 {

    64 public:

    65     QString testcase;

    66     QList<HTMLImage> referenceImages;

    67     QList<HTMLImage> foreignImages;

    68     QList<HTMLImage> images;

    69 };

    70 

    71 struct HTMLSuite

    72 {

    73 public:

    74     QString name;

    75     QMap<QString, HTMLRow*> rows;

    76 };

    77 

    78 class HTMLGenerator

    79 {

    80 public:

    81     HTMLGenerator();

    82 

    83     void startSuite(const QString &name);

    84     void startRow(const QString &testcase);

    85     void addImage(const QString &generator, const QString &image,

    86                   const QString &details, GeneratorFlags flags);

    87     void endRow();

    88     void endSuite();

    89 

    90     void generateIndex(const QString &file);

    91     void generatePages();

    92 

    93     void run(int argc, char **argv);

    94 

    95 private:

    96     void generateSuite(const HTMLSuite &suite);

    97 

    98     void generateReferencePage(const HTMLSuite &suite);

    99     void generateHistoryPages(const HTMLSuite &suite);

   100     void generateHistoryForEngine(const HTMLSuite &suite, const QString &engine);

   101     void generateQtComparisonPage(const HTMLSuite &suite);

   102 

   103     void generateHeader(QTextStream &out, const QString &name,

   104                         const QStringList &generators);

   105     void startGenerateRow(QTextStream &out, const QString &name);

   106     void generateImages(QTextStream &out,

   107                         const QList<HTMLImage> &images);

   108     void generateHistoryImages(QTextStream &out,

   109                                const QList<HTMLImage> &images);

   110     void finishGenerateRow(QTextStream &out, const QString &name);

   111     void generateFooter(QTextStream &out);

   112 

   113     void processArguments(int argc, char **argv);

   114     void convertToHtml();

   115     void createPerformance();

   116 private:

   117     QMap<QString, HTMLSuite*> suites;

   118     QMap<QString, XMLEngine*> engines;

   119 

   120     QSettings *settings;

   121     QString outputDirName;

   122     QString baseDataDir;

   123     QString htmlOutputDir;

   124 };

   125 

   126 #endif