/****************************************************************************

**

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

** All rights reserved.

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

**

** This file is part of the qt3to4 porting application of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

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

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

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

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

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

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

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

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

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

**

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

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

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

**

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

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

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef PORTINGRULES_H

#define PORTINGRULES_H

#include "qtsimplexml.h"

#include "tokenreplacements.h"

#include <QList>

#include <QPair>

#include <QHash>

#include <QSet>

#include <QStringList>

QT_BEGIN_NAMESPACE

class RuleDescription

{

public:

    explicit RuleDescription(QtSimpleXml &replacementRule) {

        qt3 = replacementRule[QLatin1String("Qt3")].text();

        qt4 = replacementRule[QLatin1String("Qt4")].text();

        ruleType = replacementRule.attribute(QLatin1String("Type"));

    }

    QString qt3;

    QString qt4;

    QString ruleType;

    bool operator==(const RuleDescription &other) const

    {

        return (qt3 == other.qt3 && qt4 == other.qt4 && ruleType == other.ruleType);

    }

};

class PortingRules

{

public:

    static void createInstance(QString xmlFilePath);

    static PortingRules *instance();

    static void deleteInstance();

    enum QtVersion{Qt3, Qt4};

    PortingRules(QString xmlFilePath);

    QList<TokenReplacement*> getTokenReplacementRules();

    QStringList getHeaderList(QtVersion qtVersion);

    QHash<QByteArray, QByteArray> getNeededHeaders();

    QStringList getInheritsQt();

    QHash<QByteArray, QByteArray> getClassLibraryList();

    QHash<QByteArray, QByteArray> getHeaderReplacements();

private:

    static PortingRules *theInstance;

    QList<TokenReplacement*> tokenRules;

    QStringList qt3Headers;

    QStringList qt4Headers;

    QHash<QByteArray, QByteArray> neededHeaders;

    QStringList inheritsQtClass;

    QList<RuleDescription> disabledRules;

    QHash<QByteArray, QByteArray> classLibraryList;

    QHash<QByteArray, QByteArray> headerReplacements;

    void parseXml(const QString fileName);

    void checkScopeAddRule(/*const */QtSimpleXml &currentRule);

    QtSimpleXml *loadXml(const QString fileName) const ;

    QString resolveFileName(const QString currentFileName,

                            const QString includeFileName) const;

    bool isReplacementRule(const QString ruleType) const;

    void disableRule(QtSimpleXml &replacementRule);

    bool isRuleDisabled(QtSimpleXml &replacementRule) const;

    void addLogWarning(const QString text) const;

    void addLogError(const QString text) const;

};

QT_END_NAMESPACE

#endif // PORTINGRULES_H