tests/auto/xmlpatternssdk/TestResultHandler.h
branchRCL_3
changeset 7 3f74d0d4af4c
equal deleted inserted replaced
6:dee5afe5301f 7:3f74d0d4af4c
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2010 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 
       
    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