BuildStep Class
(Debugger::ProjectExplorer::BuildStep)The BuildStep class provides build steps for projects. More...
Header: | #include <BuildStep> |
Public Types
enum | OutputFormat { Stdout, Stderr, NormalMessage, ErrorMessage } |
enum | OutputNewlineSetting { DoAppendNewline, DontAppendNewline } |
Public Functions
void | addOutput(const Debugger::QString &string, ProjectExplorer::BuildStep::OutputFormat format, ProjectExplorer::BuildStep::OutputNewlineSetting newlineSetting = DoAppendNewline) |
Debugger::ProjectExplorer::BuildConfiguration * | buildConfiguration() const |
virtual void | cancel() |
virtual Debugger::ProjectExplorer::BuildStepConfigWidget * | createConfigWidget() = 0 |
Debugger::ProjectExplorer::DeployConfiguration * | deployConfiguration() const |
bool | enabled() const |
void | enabledChanged() |
bool | fromMap(const int &map) override |
virtual bool | immutable() const |
virtual bool | init(QList<const Debugger::ProjectExplorer::BuildStep *> &earlierSteps) = 0 |
bool | isActive() const |
Debugger::ProjectExplorer::Project * | project() const |
Debugger::ProjectExplorer::ProjectConfiguration * | projectConfiguration() const |
virtual void | run(int &fi) = 0 |
virtual bool | runInGuiThread() const |
void | setEnabled(bool b) |
Debugger::ProjectExplorer::Target * | target() const |
int | toMap() const override |
Static Public Members
void | reportRunResult(int &fi, bool success) |
Detailed Description
The BuildStep class provides build steps for projects.
Build steps are the primary way plugin developers can customize how their projects (or projects from other plugins) are built.
Projects are built by taking the list of build steps from the project and calling first init()
and then run()
on them.
To change the way your project is built, reimplement this class and add your build step to the build step list of the project.
Note: The projects own the build step. 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 Utils::runAsync in a separate thread. If you need an event loop, you need to create it yourself.
Member Function Documentation
void BuildStep::addOutput(const Debugger::QString &string, ProjectExplorer::BuildStep::OutputFormat format, ProjectExplorer::BuildStep::OutputNewlineSetting newlineSetting = DoAppendNewline)
Debugger::ProjectExplorer::BuildConfiguration *BuildStep::buildConfiguration() const
[virtual]
void BuildStep::cancel()
[pure virtual]
Debugger::ProjectExplorer::BuildStepConfigWidget *BuildStep::createConfigWidget()
Debugger::ProjectExplorer::DeployConfiguration *BuildStep::deployConfiguration() const
bool BuildStep::enabled() const
See also setEnabled().
void BuildStep::enabledChanged()
bool BuildStep::fromMap(const int &map)
[virtual]
bool BuildStep::immutable() const
[pure virtual]
bool BuildStep::init(QList<const Debugger::ProjectExplorer::BuildStep *> &earlierSteps)
bool BuildStep::isActive() const
Debugger::ProjectExplorer::Project *BuildStep::project() const
Debugger::ProjectExplorer::ProjectConfiguration *BuildStep::projectConfiguration() const
[static]
void BuildStep::reportRunResult(int &fi, bool success)
[pure virtual]
void BuildStep::run(int &fi)
[virtual]
bool BuildStep::runInGuiThread() const
void BuildStep::setEnabled(bool b)
See also enabled().