qt-creator/src/plugins/projectexplorer/buildstep.h

/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** 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.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/

#ifndef BUILDSTEP_H
#define BUILDSTEP_H

#include "ibuildparser.h"
#include "projectexplorer_export.h"

#include <QtGui/QWidget>
#include <QtCore/QFutureInterface>

namespace ProjectExplorer {

class Project;
class BuildConfiguration;

/*
// BuildSteps are the primary way plugin developers can customize
// how their projects (or projects from other plugins) are build.
//
// Building a project, is done by taking the list of buildsteps
// from the project and calling first init() than run() on them.
//
// That means to change the way your project is build, reimplemnt
// this class and add your Step to the buildStep list of the project.
//
// Note: The projects own the buildstep, do not delete them yourself.
//
// init() is called in the GUI thread and can be used to query the
// project for any information you need.
//
// run() is run via QtConccurrent in a own thread, if you need an
// eventloop you need to create it yourself!
//
// You can use setValue() to store settings which a specific
// to your buildstep. (You can set settings to apply only
// to one buildconfiguration.
// And later retrieve the same information with value()

*/

class BuildStepConfigWidget;

class PROJECTEXPLORER_EXPORT BuildStep : public QObject
{
    Q_OBJECT
    friend class Project; //for managing BuildConfigurations
public:
    BuildStep(Project *p);
    virtual ~BuildStep();

    // This function is run in the gui thread,
    // use it to retrieve any information that you need in run()
    virtual bool init(const QString &buildConfiguration) = 0;

    // Reimplement this. This function is called when the project is build.
    // This function is NOT run in the gui thread. It runs in its own thread
    // If you need an event loop, you need to create one.
    // The absolute minimal implementation is:
    // fi.reportResult(true);
    virtual void run(QFutureInterface<bool> &fi) = 0;

    // The internal name
    virtual QString name() = 0;
    // The name shown to the user
    virtual QString displayName() = 0;

    // sets a value, which can be retrieved with value()
    // these values are automatically saved and restored when qt creator is quit and restarted
    void setValue(const QString &name, const QVariant &value);
    // sets a value specific to a buildConfiguration
    void setValue(const QString &buildConfiguration, const QString &name, const QVariant &value);

    // retrieves a value
    QVariant value(const QString &name) const;
    // retrieves a value specific to a buildConfiguration
    QVariant value(const QString &buildConfiguration, const QString & name) const;

    // the Widget shown in the project settings dialog for this buildStep
    // ownership is transfered to the caller
    virtual BuildStepConfigWidget *createConfigWidget() = 0;

    // if this function returns true, the user can't delete this BuildStep for this project
    // and the user is prevented from changing the order immutable steps are run
    // the default implementation returns false
    virtual bool immutable() const;

    Project *project() const;

protected:
    // internal function for restoring the configuration
    void setValuesFromMap(const QMap<QString, QVariant> &values);
    // internal function for restoring the configuration
    void setValuesFromMap(const QString &buildConfiguration, const QMap<QString, QVariant> &values);

    // internal function for storing the configuration
    QMap<QString, QVariant> valuesToMap();
    // internal function for storing the configuration
    QMap<QString, QVariant> valuesToMap(const QString & buildConfiguration);

Q_SIGNALS:
    void addToTaskWindow(const ProjectExplorer::TaskWindow::Task &task);
    // The string is added to the output window
    // It should be in html format, that is properly escaped
    void addToOutputWindow(const QString &string);

private:
    void addBuildConfiguration(const QString & name);
    void removeBuildConfiguration(const QString & name);
    BuildConfiguration *getBuildConfiguration(const QString & name) const;
    void copyBuildConfiguration(const QString &source, const QString &dest);

    QList<BuildConfiguration *> m_buildConfigurations;
    BuildConfiguration *m_configuration;
    Project *m_project;
};

class PROJECTEXPLORER_EXPORT IBuildStepFactory
    : public QObject
{
    Q_OBJECT

public:
    IBuildStepFactory();
    virtual ~IBuildStepFactory();
    // Called to check wheter this factory can restore the named BuildStep
    virtual bool canCreate(const QString &name) const = 0;
    // Called to restore a buildstep
    virtual BuildStep *create(Project *pro, const QString &name) const = 0;
    // Caleld by the add BuildStep action to check which BuildSteps could be added
    // to the project by this factory, should return a list of names
    virtual QStringList canCreateForProject(Project *pro) const = 0;
    // Called to convert an internal name to a displayName
    virtual QString displayNameForName(const QString &name) const = 0;
};

class PROJECTEXPLORER_EXPORT BuildConfigWidget
    : public QWidget
{
    Q_OBJECT
public:
    BuildConfigWidget()
        :QWidget(0)
        {}

    virtual QString displayName() const = 0;

    // This is called to set up the config widget before showing it
    virtual void init(const QString &buildConfiguration) = 0;
};

class PROJECTEXPLORER_EXPORT BuildStepConfigWidget
    : public BuildConfigWidget
{
    Q_OBJECT
public:
    BuildStepConfigWidget()
        : BuildConfigWidget()
        {}
    virtual QString summaryText() const = 0;
signals:
    void updateSummary();
};

} // namespace ProjectExplorer

#endif // BUILDSTEP_H