tests/auto/xmlpatternssdk/XSLTTestSuiteHandler.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the test suite of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef PatternistSDK_XSLTTestSuiteHandler_H
  43 #define PatternistSDK_XSLTTestSuiteHandler_H
  44
  45 #include <QStack>
  46 #include <QUrl>
  47 #include <QXmlDefaultHandler>
  48
  49 #include "ExternalSourceLoader.h"
  50 #include "TestSuite.h"
  51 #include "XQTSTestCase.h"
  52
  53 QT_BEGIN_HEADER
  54
  55 QT_BEGIN_NAMESPACE
  56
  57 namespace QPatternistSDK
  58 {
  59     class TestBaseLine;
  60     class TestGroup;
  61
  62     /**
  63      * @short Creates a TestSuite from the XQuery Test Suite catalog.
  64      *
  65      * The created TestSuite can be retrieved via testSuite().
  66      *
  67      * @note XSLTTestSuiteHandler assumes the XML is valid by having been validated
  68      * against the W3C XML Schema. It has no safety checks for that the XML format
  69      * is correct but is hard coded for it. Thus, the behavior is undefined if
  70      * the XML is invalid.
  71      *
  72      * @see http://www.w3.org/XML/Group/xslt20-test/TestSuiteStagingArea/catalog.html
  73      * @see http://www.w3.org/XML/Group/xslt20-test/Documentation/XSLT2Test.htm
  74      * @ingroup PatternistSDK
  75      * @author Frans Englich <frans.englich@nokia.com>
  76      */
  77     class Q_PATTERNISTSDK_EXPORT XSLTTestSuiteHandler : public QXmlDefaultHandler
  78     {
  79     public:
  80         /**
  81          * @param catalogFile the URI for the catalog file being parsed. This
  82          * URI is used for creating absolute URIs for files mentioned in
  83          * the catalog with relative URIs.
  84          * @param useExclusionList whether excludeTestGroups.txt should be used to ignore
  85          * test groups when loading
  86          */
  87         XSLTTestSuiteHandler(const QUrl &catalogFile);
  88         virtual bool characters(const QString &ch);
  89
  90         virtual bool endElement(const QString &namespaceURI,
  91                                 const QString &localName,
  92                                 const QString &qName);
  93         virtual bool startElement(const QString &namespaceURI,
  94                                   const QString &localName,
  95                                   const QString &qName,
  96                                   const QXmlAttributes &atts);
  97
  98         virtual TestSuite *testSuite() const;
  99
 100     private:
 101         TestGroup *containerFor(const QString &name);
 102
 103         QHash<QString, TestGroup *>         m_containers;
 104
 105         TestSuite *                         m_ts;
 106         XQTSTestCase *                      m_tc;
 107         TestBaseLine *                      m_baseLine;
 108         QString                             m_ch;
 109         const QUrl                          m_catalogFile;
 110
 111         /**
 112          * The base URI for where the XQuery query files are found.
 113          * It is absolute, resolved against catalogFile.
 114          */
 115         QUrl                                m_queryOffset;
 116
 117         QUrl                                m_baselineOffset;
 118         QUrl                                m_sourceOffset;
 119         QUrl                                m_currentQueryPath;
 120         QUrl                                m_currentBaselinePath;
 121
 122         /**
 123          * In the XQTSCatalog.xml, each source file in each test is referred to
 124          * by a key, which can be fully looked up in the @c sources element. This QHash
 125          * maps the keys to absolute URIs pointing to the source files.
 126          */
 127         ExternalSourceLoader::SourceMap     m_sourceMap;
 128
 129         ExternalSourceLoader::VariableMap   m_tcSourceInputs;
 130
 131         QPatternist::ResourceLoader::Ptr    m_resourceLoader;
 132
 133         /**
 134          * The current value of <tt>input-file/\@variable</tt>.
 135          */
 136         QString                             m_currentInputVariable;
 137
 138         /**
 139          * The names of the test groups.
 140          */
 141         QStack<QString>                     m_testGroupName;
 142
 143         /**
 144          * Holds the content of the current <tt>input-URI</tt> element.
 145          */
 146         QString                             m_inputURI;
 147         QString                             m_contextItemSource;
 148         QString                             m_currentCategory;
 149         bool                                m_removeTestcase;
 150     };
 151 }
 152
 153 QT_END_NAMESPACE
 154
 155 QT_END_HEADER
 156
 157 #endif
 158 // vim: et:ts=4:sw=4:sts=4