ToolChain Class | Extending Qt Creator Manual

Extending Qt Creator Manual | ToolChain

Extending Qt Creator Manual 4.3.0

# ToolChain Class

(ProjectExplorer::ToolChain)

The ToolChain class represents a tool chain. More...

Header: | #include <ToolChain>

- List of all members, including inherited members

## Public Types

enum | CompilerFlag { NoFlags, StandardCxx11, StandardC99, StandardC11, ..., StandardCxx98 }
flags | CompilerFlags
enum | Detection { ManualDetection, AutoDetection, AutoDetectionFromSettings }

## Public Functions

virtual | ~ToolChain()
virtual void | addToEnvironment(Utils::Environment &env) const = 0
virtual bool | canClone() const
virtual ToolChain * | clone() const = 0
virtual Utils::FileName | compilerCommand() const = 0
virtual CompilerFlags | compilerFlags(const QStringList &cxxflags) const = 0
virtual ToolChainConfigWidget * | configurationWidget() = 0
virtual PredefinedMacrosRunner | createPredefinedMacrosRunner() const = 0
virtual SystemHeaderPathsRunner | createSystemHeaderPathsRunner() const = 0
Detection | detection() const
QString | displayName() const
QByteArray | id() const
bool | isAutoDetected() const
virtual bool | isValid() const = 0
Core::Id | language() const
virtual QString | makeCommand(const Utils::Environment &env) const = 0
virtual QString | originalTargetTriple() const
virtual IOutputParser * | outputParser() const = 0
virtual QByteArray | predefinedMacros(const QStringList &cxxflags) const = 0
void | setDisplayName(const QString &name)
void | setLanguage(Core::Id language)
virtual Utils::FileName | suggestedDebugger() const
virtual Utils::FileNameList | suggestedMkspecList() const
virtual QList<Abi> | supportedAbis() const
virtual QList<HeaderPath> | systemHeaderPaths(const QStringList &cxxflags, const Utils::FileName &sysRoot) const = 0
virtual Abi | targetAbi() const = 0
virtual QVariantMap | toMap() const
virtual QString | typeDisplayName() const = 0
Core::Id | typeId() const
virtual QList<Task> | validateKit(const Kit *k) const
virtual WarningFlags | warningFlags(const QStringList &cflags) const = 0
virtual bool | operator==(const ToolChain &) const

## Protected Functions

| ToolChain(Core::Id typeId, Detection d)
| ToolChain(const ToolChain &)
virtual bool | fromMap(const QVariantMap &data)
void | toolChainUpdated()

## Detailed Description

The ToolChain class represents a tool chain.

See also ProjectExplorer::ToolChainManager.

## Member Type Documentation

### enum ToolChain::CompilerFlag
flags ToolChain::CompilerFlags

The CompilerFlags type is a typedef for QFlags<CompilerFlag>. It stores an OR combination of CompilerFlag values.

### enum ToolChain::Detection

## Member Function Documentation

### `[protected]` ToolChain::ToolChain(Core::Id typeId, Detection d)

Default constructs an instance of ToolChain.

### `[protected]` ToolChain::ToolChain(const ToolChain &)

Copy constructor.

### `[virtual]` ToolChain::~ToolChain()

Destroys the instance of ToolChain. The destructor is virtual.

### `[pure virtual]` void ToolChain::addToEnvironment(Utils::Environment &env) const

### `[virtual]` bool ToolChain::canClone() const

### `[pure virtual]` ToolChain *ToolChain::clone() const

### `[pure virtual]` Utils::FileName ToolChain::compilerCommand() const

### `[pure virtual]` CompilerFlags ToolChain::compilerFlags(const QStringList &cxxflags) const

### `[pure virtual]` ToolChainConfigWidget *ToolChain::configurationWidget()

### `[pure virtual]` PredefinedMacrosRunner ToolChain::createPredefinedMacrosRunner() const

### `[pure virtual]` SystemHeaderPathsRunner ToolChain::createSystemHeaderPathsRunner() const

### Detection ToolChain::detection() const

### QString ToolChain::displayName() const

See also setDisplayName().

### `[virtual protected]` bool ToolChain::fromMap(const QVariantMap &data)

Used by the tool chain manager to load user-generated tool chains.

Make sure to call this function when deriving.

### QByteArray ToolChain::id() const

### bool ToolChain::isAutoDetected() const

### `[pure virtual]` bool ToolChain::isValid() const

### Core::Id ToolChain::language() const

See also setLanguage().

### `[pure virtual]` QString ToolChain::makeCommand(const Utils::Environment &env) const

### `[virtual]` QString ToolChain::originalTargetTriple() const

### `[pure virtual]` IOutputParser *ToolChain::outputParser() const

### `[pure virtual]` QByteArray ToolChain::predefinedMacros(const QStringList &cxxflags) const

### void ToolChain::setDisplayName(const QString &name)

See also displayName().

### void ToolChain::setLanguage(Core::Id language)

See also language().

### `[virtual]` Utils::FileName ToolChain::suggestedDebugger() const

### `[virtual]` Utils::FileNameList ToolChain::suggestedMkspecList() const

### `[virtual]` QList<Abi> ToolChain::supportedAbis() const

### `[pure virtual]` QList<HeaderPath> ToolChain::systemHeaderPaths(const QStringList &cxxflags, const Utils::FileName &sysRoot) const

### `[pure virtual]` Abi ToolChain::targetAbi() const

### `[virtual]` QVariantMap ToolChain::toMap() const

Used by the tool chain manager to save user-generated tool chains.

Make sure to call this function when deriving.

### `[protected]` void ToolChain::toolChainUpdated()

### `[pure virtual]` QString ToolChain::typeDisplayName() const

### Core::Id ToolChain::typeId() const

### `[virtual]` QList<Task> ToolChain::validateKit(const Kit *k) const

Used by the tool chain kit information to validate the kit.

### `[pure virtual]` WarningFlags ToolChain::warningFlags(const QStringList &cflags) const

### `[virtual]` bool ToolChain::operator==(const ToolChain &) const