buildstep.cpp 4.59 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
hjk's avatar
hjk committed
7
** Contact: Nokia Corporation (info@qt.nokia.com)
con's avatar
con committed
8
**
9
**
10
** GNU Lesser General Public License Usage
11
**
hjk's avatar
hjk committed
12 13 14 15 16 17
** 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.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21 22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23 24 25 26 27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28
** If you have questions regarding the use of this file, please contact
Tobias Hunger's avatar
Tobias Hunger committed
29
** Nokia at info@qt.nokia.com.
con's avatar
con committed
30
**
31
**************************************************************************/
hjk's avatar
hjk committed
32

con's avatar
con committed
33
#include "buildstep.h"
hjk's avatar
hjk committed
34

Tobias Hunger's avatar
Tobias Hunger committed
35 36
#include "buildconfiguration.h"
#include "buildsteplist.h"
37
#include "deployconfiguration.h"
Tobias Hunger's avatar
Tobias Hunger committed
38 39
#include "target.h"

40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
/*!
    \class ProjectExplorer::BuildStep

    \brief 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!
*/

/*!
    \fn bool ProjectExplorer::BuildStep::init()

    This function is run in the gui thread,
    use it to retrieve any information that you need in run()
*/

/*!
    \fn void ProjectExplorer::BuildStep::run(QFutureInterface<bool> &fi)

    Reimplement this. This function is called when the target 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:
    \code
    fi.reportResult(true);
    \endcode
*/

/*!
    \fn BuildStepConfigWidget *ProjectExplorer::BuildStep::createConfigWidget()

    Returns the Widget shown in the target settings dialog for this buildStep;
    ownership is transferred to the caller.
*/

/*!
    \fn bool ProjectExplorer::BuildStep::immutable() const

    If this function returns true, the user can't delete this BuildStep for this target
    and the user is prevented from changing the order immutable steps are run
    the default implementation returns false.
*/

/*!
    \fn  void ProjectExplorer::BuildStep::addTask(const ProjectExplorer::Task &task)
    \brief Add a task.
*/

/*!
    \fn  void addOutput(const QString &string, ProjectExplorer::BuildStep::OutputFormat format,
              ProjectExplorer::BuildStep::OutputNewlineSetting newlineSetting)

    The string is added to the generated output, usually in the output window.
    It should be in plain text, with the format in the parameter.
*/

109
using namespace ProjectExplorer;
con's avatar
con committed
110

Tobias Hunger's avatar
Tobias Hunger committed
111 112
BuildStep::BuildStep(BuildStepList *bsl, const QString &id) :
    ProjectConfiguration(bsl, id)
con's avatar
con committed
113
{
Tobias Hunger's avatar
Tobias Hunger committed
114
    Q_ASSERT(bsl);
con's avatar
con committed
115 116
}

Tobias Hunger's avatar
Tobias Hunger committed
117 118
BuildStep::BuildStep(BuildStepList *bsl, BuildStep *bs) :
    ProjectConfiguration(bsl, bs)
con's avatar
con committed
119
{
Tobias Hunger's avatar
Tobias Hunger committed
120
    Q_ASSERT(bsl);
con's avatar
con committed
121 122
}

123
BuildStep::~BuildStep()
con's avatar
con committed
124 125 126
{
}

127
BuildConfiguration *BuildStep::buildConfiguration() const
con's avatar
con committed
128
{
Tobias Hunger's avatar
Tobias Hunger committed
129 130 131 132 133 134
    BuildConfiguration *bc = qobject_cast<BuildConfiguration *>(parent()->parent());
    if (!bc)
        bc = target()->activeBuildConfiguration();
    return bc;
}

135 136 137 138 139 140 141 142
DeployConfiguration *BuildStep::deployConfiguration() const
{
    DeployConfiguration *dc = qobject_cast<DeployConfiguration *>(parent()->parent());
    if (!dc)
        dc = target()->activeDeployConfiguration();
    return dc;
}

Tobias Hunger's avatar
Tobias Hunger committed
143 144 145
Target *BuildStep::target() const
{
    return qobject_cast<Target *>(parent()->parent()->parent());
con's avatar
con committed
146 147 148 149 150 151 152
}

bool BuildStep::immutable() const
{
    return false;
}

153 154
IBuildStepFactory::IBuildStepFactory(QObject *parent) :
    QObject(parent)
Tobias Hunger's avatar
Tobias Hunger committed
155
{ }
con's avatar
con committed
156 157

IBuildStepFactory::~IBuildStepFactory()
Tobias Hunger's avatar
Tobias Hunger committed
158
{ }