tests/auto/xmlpatternssdk/TestResultHandler.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_TestResultHandler_H
  43 #define PatternistSDK_TestResultHandler_H
  44
  45 #include <QHash>
  46 #include <QString>
  47 #include <QtXml/QXmlDefaultHandler>
  48
  49 #include "TestResult.h"
  50
  51 QT_BEGIN_HEADER
  52
  53 QT_BEGIN_NAMESPACE
  54
  55 namespace QPatternistSDK
  56 {
  57     /**
  58      * @short Reads XML in the @c XQTSResult.xsd format, and provides access to
  59      * the reported results.
  60      *
  61      * @author Frans Englich <frans.englich@nokia.com>
  62      * @ingroup PatternistSDK
  63      */
  64     class Q_PATTERNISTSDK_EXPORT TestResultHandler : public QXmlDefaultHandler
  65     {
  66     public:
  67         /**
  68          * A hash where the key is the class's name, that is <tt>test-case/@@name</tt>,
  69          * and the value the test's result status.
  70          */
  71         typedef QHash<QString, TestResult::Status> Hash;
  72
  73         /**
  74          * A hash mapping test-case names to their' comments.
  75          */
  76         typedef QHash<QString, QString> CommentHash;
  77
  78         /**
  79          * Creates a TestResultHandler that will read @p file when run() is called.
  80          */
  81         TestResultHandler();
  82
  83         /**
  84          * Performs finalization.
  85          */
  86         virtual bool endDocument();
  87
  88         /**
  89          * Reads the <tt>test-case</tt> element and its attributes, everything else is ignored.
  90          */
  91         virtual bool startElement(const QString &namespaceURI,
  92                                   const QString &localName,
  93                                   const QString &qName,
  94                                   const QXmlAttributes &atts);
  95         /**
  96          * @note Do not reimplement this function.
  97          * @returns the result obtained from reading the XML file.
  98          */
  99         Hash result() const;
 100
 101         CommentHash comments() const;
 102
 103     private:
 104         Q_DISABLE_COPY(TestResultHandler)
 105         Hash        m_result;
 106         CommentHash m_comments;
 107     };
 108 }
 109
 110 QT_END_NAMESPACE
 111
 112 QT_END_HEADER
 113
 114 #endif
 115 // vim: et:ts=4:sw=4:sts=4