**
** This file is part of Qt Creator
**
-** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
-** Contact: Nokia Corporation (qt-info@nokia.com)
+** Contact: Nokia Corporation (info@qt.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.
+** 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.
+**
+** Other Usage
**
-** If you are unsure which license is appropriate for your use, please
-** contact the sales department at http://qt.nokia.com/contact.
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at info@qt.nokia.com.
**
**************************************************************************/
#ifndef BUILDSTEP_H
#define BUILDSTEP_H
+#include "projectconfiguration.h"
#include "projectexplorer_export.h"
-#include "taskwindow.h"
#include <QtCore/QFutureInterface>
#include <QtGui/QWidget>
namespace ProjectExplorer {
+class Task;
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 BuildStepList;
+class DeployConfiguration;
+class Target;
class BuildStepConfigWidget;
-class PROJECTEXPLORER_EXPORT BuildStep : public QObject
+// Documentation inside.
+class PROJECTEXPLORER_EXPORT BuildStep : public ProjectConfiguration
{
Q_OBJECT
+
protected:
- BuildStep(BuildConfiguration *bc);
- BuildStep(BuildStep *bs, BuildConfiguration *bc);
+ BuildStep(BuildStepList *bsl, const QString &id);
+ BuildStep(BuildStepList *bsl, BuildStep *bs);
public:
virtual ~BuildStep();
- // This function is run in the gui thread,
- // use it to retrieve any information that you need in run()
virtual bool init() = 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;
-
- // 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;
-
- // TODO remove after 2.0
- virtual void restoreFromGlobalMap(const QMap<QString, QVariant> &map);
-
- virtual void restoreFromLocalMap(const QMap<QString, QVariant> &map);
- virtual void storeIntoLocalMap(QMap<QString, QVariant> &map);
+ virtual bool runInGuiThread() const;
+ virtual void cancel();
BuildConfiguration *buildConfiguration() const;
+ DeployConfiguration *deployConfiguration() const;
+ Target *target() const;
+ enum OutputFormat { NormalOutput, ErrorOutput, MessageOutput, ErrorMessageOutput };
+ enum OutputNewlineSetting { DoAppendNewline, DontAppendNewline };
+
+ Project *project() const;
signals:
- // Add a task.
- void addTask(const ProjectExplorer::TaskWindow::Task &task);
- // The string is added to the generated output, usually in the output
- // window.
- // It should be in html format, that is properly escaped
- void addOutput(const QString &string);
-
-private:
- BuildConfiguration *m_buildConfiguration;
+ void addTask(const ProjectExplorer::Task &task);
+
+ void addOutput(const QString &string, ProjectExplorer::BuildStep::OutputFormat format,
+ ProjectExplorer::BuildStep::OutputNewlineSetting newlineSetting = DoAppendNewline) const;
+
+ void finished();
};
-class PROJECTEXPLORER_EXPORT IBuildStepFactory
- : public QObject
+class PROJECTEXPLORER_EXPORT IBuildStepFactory :
+ public QObject
{
Q_OBJECT
public:
- IBuildStepFactory();
+ explicit IBuildStepFactory(QObject *parent = 0);
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(BuildConfiguration *bc, const QString &name) const = 0;
- /// Called 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 canCreateForBuildConfiguration(BuildConfiguration *bc) const = 0;
- /// Called to convert an internal name to a displayName
-
- /// Called to clone a BuildStep
- virtual BuildStep *clone(BuildStep *bs, BuildConfiguration *bc) const = 0;
- virtual QString displayNameForName(const QString &name) const = 0;
+
+ // used to show the list of possible additons to a target, returns a list of types
+ virtual QStringList availableCreationIds(BuildStepList *parent) const = 0;
+ // used to translate the types to names to display to the user
+ virtual QString displayNameForId(const QString &id) const = 0;
+
+ virtual bool canCreate(BuildStepList *parent, const QString &id) const = 0;
+ virtual BuildStep *create(BuildStepList *parent, const QString &id) = 0;
+ // used to recreate the runConfigurations when restoring settings
+ virtual bool canRestore(BuildStepList *parent, const QVariantMap &map) const = 0;
+ virtual BuildStep *restore(BuildStepList *parent, const QVariantMap &map) = 0;
+ virtual bool canClone(BuildStepList *parent, BuildStep *product) const = 0;
+ virtual BuildStep *clone(BuildStepList *parent, BuildStep *product) = 0;
};
class PROJECTEXPLORER_EXPORT BuildConfigWidget
// This is called to set up the config widget before showing it
virtual void init(BuildConfiguration *bc) = 0;
+
+signals:
+ void displayNameChanged(const QString &);
};
class PROJECTEXPLORER_EXPORT BuildStepConfigWidget
BuildStepConfigWidget()
: QWidget()
{}
- virtual void init() = 0;
virtual QString summaryText() const = 0;
+ virtual QString additionalSummaryText() const { return QString(); }
virtual QString displayName() const = 0;
+
signals:
void updateSummary();
+ void updateAdditionalSummary();
};
} // namespace ProjectExplorer
+Q_DECLARE_METATYPE(ProjectExplorer::BuildStep::OutputFormat)
+Q_DECLARE_METATYPE(ProjectExplorer::BuildStep::OutputNewlineSetting)
+
#endif // BUILDSTEP_H
OSDN Git Service
