Update licenseheader text in source files for qtxmlpatterns Qt module
[profile/ivi/qtxmlpatterns.git] / tests / auto / xmlpatternssdk / TestSuiteHandler.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2011 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 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 **
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 **
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
29 **
30 ** Other Usage
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
33 **
34 **
35 **
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #ifndef PatternistSDK_TestSuiteHandler_H
43 #define PatternistSDK_TestSuiteHandler_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
61     /**
62      * @short Creates a TestSuite from the XQuery Test Suite catalog,
63      * represented as a SAX stream.
64      *
65      * The created TestSuite can be retrieved via testSuite().
66      *
67      * @note TestSuiteHandler assumes the XML is valid by having been validated
68      * against the W3C XML Schema. It have 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      * @ingroup PatternistSDK
73      * @author Frans Englich <frans.englich@nokia.com>
74      */
75     class Q_PATTERNISTSDK_EXPORT TestSuiteHandler : public QXmlDefaultHandler
76     {
77     public:
78         /**
79          * @param catalogFile the URI for the catalog file being parsed. This
80          * URI is used for creating absolute URIs for files mentioned in
81          * the catalog with relative URIs.
82          * @param useExclusionList whether excludeTestGroups.txt should be used to ignore
83          * test groups when loading
84          */
85         TestSuiteHandler(const QUrl &catalogFile,
86                          const bool useExclusionList);
87         virtual bool characters(const QString &ch);
88
89         virtual bool endElement(const QString &namespaceURI,
90                                 const QString &localName,
91                                 const QString &qName);
92         virtual bool startElement(const QString &namespaceURI,
93                                   const QString &localName,
94                                   const QString &qName,
95                                   const QXmlAttributes &atts);
96
97         virtual TestSuite *testSuite() const;
98
99     private:
100         QStringList readExclusionList(const bool useExclusionList) const;
101
102         TestSuite *                         m_ts;
103         TestContainer *                     m_container;
104         XQTSTestCase *                      m_tc;
105         TestBaseLine *                      m_baseLine;
106         QString                             m_ch;
107         const QUrl                          m_catalogFile;
108
109         /**
110          * The extension of XQuery files. For example, ".xq"
111          */
112         QString                             m_xqueryFileExtension;
113
114         /**
115          * The base URI for where the XQuery query files are found.
116          * It is absolute, resolved against catalogFile.
117          */
118         QUrl                                m_queryOffset;
119
120         QUrl                                m_baselineOffset;
121         QUrl                                m_sourceOffset;
122         QUrl                                m_currentQueryPath;
123         QUrl                                m_currentBaselinePath;
124
125         /**
126          * In the XQTSCatalog.xml, each source file in each test is referred to
127          * by a key, which can be fully looked up in the @c sources element. This QHash
128          * maps the keys to absolute URIs pointing to the source files.
129          */
130         ExternalSourceLoader::SourceMap     m_sourceMap;
131
132         ExternalSourceLoader::VariableMap   m_tcSourceInputs;
133
134         QPatternist::ResourceLoader::Ptr     m_resourceLoader;
135
136         /**
137          * The current value of <tt>input-file/\@variable/</tt>.
138          */
139         QString                             m_currentInputVariable;
140
141         /**
142          * The names of the test groups we're excluding.
143          */
144         const QStringList                   m_exclusionList;
145
146         /**
147          * This is set when we're inside a test-group that we're excluding.
148          */
149         bool                                m_isExcluding;
150
151         /**
152          * The names of the test groups.
153          */
154         QStack<QString>                     m_testGroupName;
155
156         /**
157          * Holds the content of the current <tt>input-URI</tt> element.
158          */
159         QString                             m_inputURI;
160         QString                             m_contextItemSource;
161     };
162 }
163
164 QT_END_NAMESPACE
165
166 QT_END_HEADER
167
168 #endif
169 // vim: et:ts=4:sw=4:sts=4