public interface IToolChain
extends org.eclipse.core.runtime.IAdaptable
Modifier and Type | Field and Description |
---|---|
static String |
ATTR_ARCH
Property: The CPU architecture the toolchain supports.
|
static String |
ATTR_OS
Property: The OS the toolchain builds for.
|
static String |
ATTR_PACKAGE
Property: A package ID to reflect different version/package line up of
the platform this toolchain supports.
|
Modifier and Type | Method and Description |
---|---|
String |
getBinaryParserId()
Returns the IDs for the binary parsers that can parse the build output of
the toolchain.
|
default String |
getBuildConfigNameFragment()
Return a toolchain specific part of the build configuration name.
|
Path |
getCommandPath(Path command)
Returns the absolute path of the tool represented by the command
|
String[] |
getCompileCommands()
Returns the list of compiler tools.
|
default String[] |
getCompileCommands(ILanguage language)
Returns the list of compiler tools for a given language.
|
default IExtendedScannerInfo |
getDefaultScannerInfo(org.eclipse.core.resources.IBuildConfiguration buildConfig,
IExtendedScannerInfo baseScannerInfo,
ILanguage language,
URI buildDirectoryURI)
Return the default scanner info for this toolchain.
|
String[] |
getErrorParserIds()
Returns the error parser IDs use to create error markers for builds with
this toolchain.
|
String |
getId()
The ID of the toolchain
|
String |
getName()
The user friendly name for the toolchain
|
String |
getProperty(String key)
Returns an property of the toolchain.
|
IToolChainProvider |
getProvider()
The provider of the toolchain.
|
default org.eclipse.core.resources.IResource[] |
getResourcesFromCommand(List<String> command,
URI buildDirectoryURI)
Returns the list of resources referenced in a compile command.
|
default org.eclipse.core.resources.IResource[] |
getResourcesFromCommand(String[] command,
URI buildDirectoryURI)
Deprecated.
|
default IExtendedScannerInfo |
getScannerInfo(org.eclipse.core.resources.IBuildConfiguration buildConfig,
List<String> command,
IExtendedScannerInfo baseScannerInfo,
org.eclipse.core.resources.IResource resource,
URI buildDirectoryURI)
Get the scanner info for a given build config, command, base scanner
info, resource and build directory.
|
default IExtendedScannerInfo |
getScannerInfo(org.eclipse.core.resources.IBuildConfiguration buildConfig,
Path command,
String[] args,
IExtendedScannerInfo baseScannerInfo,
org.eclipse.core.resources.IResource resource,
URI buildDirectoryURI)
Deprecated.
|
default String |
getTypeId()
The type id for the toolchain.
|
IEnvironmentVariable |
getVariable(String name)
Return the environment variable of the given name used when invoking the
toolchain.
|
IEnvironmentVariable[] |
getVariables()
Return the environment variables to be set when invoking the tools in the
toolchain.
|
String |
getVersion()
Deprecated.
the version doesn't matter. id's for a given type must be unique.
|
default boolean |
matches(Map<String,String> properties)
Determine if this toolchain supports targets with the given set of properties.
|
void |
setProperty(String key,
String value)
Set a property on the toolchain.
|
default List<String> |
stripCommand(List<String> command,
org.eclipse.core.resources.IResource[] resources)
Strips the resources from the compile command.
|
static final String ATTR_OS
static final String ATTR_ARCH
static final String ATTR_PACKAGE
IToolChainProvider getProvider()
String getId()
@Deprecated String getVersion()
String getName()
default String getBuildConfigNameFragment()
default String getTypeId()
String getProperty(String key)
key
- key of the propertyvoid setProperty(String key, String value)
key
- key of the propertyvalue
- value of the propertyIEnvironmentVariable[] getVariables()
IEnvironmentVariable getVariable(String name)
name
- environment variable nameString[] getErrorParserIds()
String getBinaryParserId()
default IExtendedScannerInfo getScannerInfo(org.eclipse.core.resources.IBuildConfiguration buildConfig, List<String> command, IExtendedScannerInfo baseScannerInfo, org.eclipse.core.resources.IResource resource, URI buildDirectoryURI)
buildConfig
- the build configuration this scanner info applies tocommand
- the compile command that is used to build the resourcebaseScannerInfo
- base scanner info that this scanner info extends/replacesresource
- the resource this scanner info applies to, usually a source
filebuildDirectoryURI
- where the build command is run to build this resource@Deprecated default IExtendedScannerInfo getScannerInfo(org.eclipse.core.resources.IBuildConfiguration buildConfig, Path command, String[] args, IExtendedScannerInfo baseScannerInfo, org.eclipse.core.resources.IResource resource, URI buildDirectoryURI)
default IExtendedScannerInfo getDefaultScannerInfo(org.eclipse.core.resources.IBuildConfiguration buildConfig, IExtendedScannerInfo baseScannerInfo, ILanguage language, URI buildDirectoryURI)
buildConfig
- the build configuration this scanner info applies tobaseScannerInfo
- base scanner info that this scanner info extends/replaceslanguage
- the source language that selects the tool to provide scanner
info forbuildDirectoryURI
- the build directory that would be used to run commandsPath getCommandPath(Path command)
command
- the command as it usually appears on the command lineString[] getCompileCommands()
default String[] getCompileCommands(ILanguage language)
language
- the language for the commandsdefault org.eclipse.core.resources.IResource[] getResourcesFromCommand(List<String> command, URI buildDirectoryURI)
command
- the compile commandbuildDirectoryURI
- the directory the compile command runs in@Deprecated default org.eclipse.core.resources.IResource[] getResourcesFromCommand(String[] command, URI buildDirectoryURI)
default List<String> stripCommand(List<String> command, org.eclipse.core.resources.IResource[] resources)
command
- the original compile commandresources
- the resources this command compiles for usually returned by
getResourcesFromCommand()Copyright (c) IBM Corp. and others 2004, 2020. All Rights Reserved.