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

**

** 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 tools applications 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 DRIVER_H

#define DRIVER_H

#include "option.h"

#include <QtCore/QHash>

#include <QtCore/QString>

#include <QtCore/QStringList>

#include <QtCore/QTextStream>

QT_BEGIN_NAMESPACE

class QTextStream;

class DomUI;

class DomWidget;

class DomSpacer;

class DomLayout;

class DomLayoutItem;

class DomActionGroup;

class DomAction;

class DomButtonGroup;

class Driver

{

public:

    Driver();

    virtual ~Driver();

    // tools

    bool printDependencies(const QString &fileName);

    bool uic(const QString &fileName, QTextStream *output = 0);

    bool uic(const QString &fileName, DomUI *ui, QTextStream *output = 0);

    // configuration

    inline QTextStream &output() const { return *m_output; }

    inline Option &option() { return m_option; }

    // initialization

    void reset();

    // error

    inline QStringList problems() { return m_problems; }

    inline void addProblem(const QString &problem) { m_problems.append(problem); }

    // utils

    static QString headerFileName(const QString &fileName);

    QString headerFileName() const;

    static QString normalizedName(const QString &name);

    static QString qtify(const QString &name);

    QString unique(const QString &instanceName=QString(),

                   const QString &className=QString());

    // symbol table

    QString findOrInsertWidget(DomWidget *ui_widget);

    QString findOrInsertSpacer(DomSpacer *ui_spacer);

    QString findOrInsertLayout(DomLayout *ui_layout);

    QString findOrInsertLayoutItem(DomLayoutItem *ui_layoutItem);

    QString findOrInsertName(const QString &name);

    QString findOrInsertActionGroup(DomActionGroup *ui_group);

    QString findOrInsertAction(DomAction *ui_action);

    QString findOrInsertButtonGroup(const DomButtonGroup *ui_group);

    // Find a group by its non-uniqified name

    const DomButtonGroup *findButtonGroup(const QString &attributeName) const;

    inline bool hasName(const QString &name) const

    { return m_nameRepository.contains(name); }

    DomWidget *widgetByName(const QString &name) const;

    DomSpacer *spacerByName(const QString &name) const;

    DomLayout *layoutByName(const QString &name) const;

    DomActionGroup *actionGroupByName(const QString &name) const;

    DomAction *actionByName(const QString &name) const;

    // pixmap

    void insertPixmap(const QString &pixmap);

    bool containsPixmap(const QString &pixmap) const;

private:

    Option m_option;

    QTextStream m_stdout;

    QTextStream *m_output;

    QStringList m_problems;

    // symbol tables

    QHash<DomWidget*, QString> m_widgets;

    QHash<DomSpacer*, QString> m_spacers;

    QHash<DomLayout*, QString> m_layouts;

    QHash<DomActionGroup*, QString> m_actionGroups;

    typedef QHash<const DomButtonGroup*, QString> ButtonGroupNameHash;

    ButtonGroupNameHash m_buttonGroups;

    QHash<DomAction*, QString> m_actions;

    QHash<QString, bool> m_nameRepository;

    QHash<QString, bool> m_pixmaps;

};

QT_END_NAMESPACE

#endif // DRIVER_H