src/plugins/projectexplorer/buildstep.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  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 **
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33
  34 #ifndef BUILDSTEP_H
  35 #define BUILDSTEP_H
  36
  37 #include "projectconfiguration.h"
  38 #include "projectexplorer_export.h"
  39 #include "task.h"
  40
  41 #include <QtCore/QFutureInterface>
  42 #include <QtGui/QWidget>
  43
  44 namespace ProjectExplorer {
  45
  46 class BuildConfiguration;
  47 class BuildStepList;
  48 class Target;
  49
  50 /*
  51 // BuildSteps are the primary way plugin developers can customize
  52 // how their projects (or projects from other plugins) are build.
  53 //
  54 // Building a project, is done by taking the list of buildsteps
  55 // from the project and calling first init() than run() on them.
  56 //
  57 // That means to change the way your project is build, reimplemnt
  58 // this class and add your Step to the buildStep list of the project.
  59 //
  60 // Note: The projects own the buildstep, do not delete them yourself.
  61 //
  62 // init() is called in the GUI thread and can be used to query the
  63 // project for any information you need.
  64 //
  65 // run() is run via QtConccurrent in a own thread, if you need an
  66 // eventloop you need to create it yourself!
  67 //
  68 */
  69
  70 class BuildStepConfigWidget;
  71
  72 class PROJECTEXPLORER_EXPORT BuildStep : public ProjectConfiguration
  73 {
  74     Q_OBJECT
  75
  76 protected:
  77     BuildStep(BuildStepList *bsl, const QString &id);
  78     BuildStep(BuildStepList *bsl, BuildStep *bs);
  79
  80 public:
  81     virtual ~BuildStep();
  82
  83     // This function is run in the gui thread,
  84     // use it to retrieve any information that you need in run()
  85     virtual bool init() = 0;
  86
  87     // Reimplement this. This function is called when the target is build.
  88     // This function is NOT run in the gui thread. It runs in its own thread
  89     // If you need an event loop, you need to create one.
  90     // The absolute minimal implementation is:
  91     // fi.reportResult(true);
  92     virtual void run(QFutureInterface<bool> &fi) = 0;
  93
  94     // the Widget shown in the target settings dialog for this buildStep
  95     // ownership is transferred to the caller
  96     virtual BuildStepConfigWidget *createConfigWidget() = 0;
  97
  98     // if this function returns true, the user can't delete this BuildStep for this target
  99     // and the user is prevented from changing the order immutable steps are run
 100     // the default implementation returns false
 101     virtual bool immutable() const;
 102
 103     BuildConfiguration *buildConfiguration() const;
 104     Target *target() const;
 105
 106     enum OutputFormat { NormalOutput, ErrorOutput, MessageOutput, ErrorMessageOutput };
 107
 108 signals:
 109     // Add a task.
 110     void addTask(const ProjectExplorer::Task &task);
 111     // The string is added to the generated output, usually in the output
 112     // window.
 113     // It should be in plain text, with the format in the parameter
 114     void addOutput(const QString &string, ProjectExplorer::BuildStep::OutputFormat format);
 115 };
 116
 117 class PROJECTEXPLORER_EXPORT IBuildStepFactory :
 118     public QObject
 119 {
 120     Q_OBJECT
 121
 122 public:
 123     explicit IBuildStepFactory(QObject *parent = 0);
 124     virtual ~IBuildStepFactory();
 125
 126     // used to show the list of possible additons to a target, returns a list of types
 127     virtual QStringList availableCreationIds(BuildStepList *parent) const = 0;
 128     // used to translate the types to names to display to the user
 129     virtual QString displayNameForId(const QString &id) const = 0;
 130
 131     virtual bool canCreate(BuildStepList *parent, const QString &id) const = 0;
 132     virtual BuildStep *create(BuildStepList *parent, const QString &id) = 0;
 133     // used to recreate the runConfigurations when restoring settings
 134     virtual bool canRestore(BuildStepList *parent, const QVariantMap &map) const = 0;
 135     virtual BuildStep *restore(BuildStepList *parent, const QVariantMap &map) = 0;
 136     virtual bool canClone(BuildStepList *parent, BuildStep *product) const = 0;
 137     virtual BuildStep *clone(BuildStepList *parent, BuildStep *product) = 0;
 138 };
 139
 140 class PROJECTEXPLORER_EXPORT BuildConfigWidget
 141     : public QWidget
 142 {
 143     Q_OBJECT
 144 public:
 145     BuildConfigWidget()
 146         :QWidget(0)
 147         {}
 148
 149     virtual QString displayName() const = 0;
 150
 151     // This is called to set up the config widget before showing it
 152     virtual void init(BuildConfiguration *bc) = 0;
 153
 154 signals:
 155     void displayNameChanged(const QString &);
 156 };
 157
 158 class PROJECTEXPLORER_EXPORT BuildStepConfigWidget
 159     : public QWidget
 160 {
 161     Q_OBJECT
 162 public:
 163     BuildStepConfigWidget()
 164         : QWidget()
 165         {}
 166     virtual void init() = 0;
 167     virtual QString summaryText() const = 0;
 168     virtual QString displayName() const = 0;
 169 signals:
 170     void updateSummary();
 171 };
 172
 173 } // namespace ProjectExplorer
 174
 175 Q_DECLARE_METATYPE(ProjectExplorer::BuildStep::OutputFormat)
 176
 177 #endif // BUILDSTEP_H