Package org.eclipse.cdt.core.build
Interface ICBuildConfiguration
- All Superinterfaces:
org.eclipse.core.runtime.IAdaptable
,IScannerInfoProvider
- All Known Implementing Classes:
CBuildConfiguration
,ErrorBuildConfiguration
,StandardBuildConfiguration
public interface ICBuildConfiguration
extends org.eclipse.core.runtime.IAdaptable, IScannerInfoProvider
This is the root interface for "new style" CDT build configurations. Adapting
IBuildConfiguration to this interface will get you one of these. From here,
adapt to the specific interface that you need and the configuration will
provide one.
- Since:
- 6.0
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionorg.eclipse.core.resources.IProject[]
build
(int kind, Map<String, String> args, IConsole console, org.eclipse.core.runtime.IProgressMonitor monitor) Perform the build.void
Perform clean.Ids for the Binary Parsers to use when checking whether a file is a binary that can be launched.org.eclipse.core.resources.IBuildConfiguration
Returns the resources build configuration that this CDT build configuration is associated with.default IBinary[]
The binaries produced by the build.Returns the default values for the properties.default String
Return the launch mode associated with this build configuration.Return the properties for this build configuration.default String
getProperty
(String name) Return the named property.Build Configurations are configurations for a given toolchain.getVariable
(String name) Return a build environment variable with a given name.Return all of the build environment variables for this configuration.default void
removeProperty
(String name) Remove the named property.default void
setBuildEnvironment
(Map<String, String> env) Set the environment for the builds.default boolean
setProperties
(Map<String, String> properties) Set the properties for this build configuration.default void
setProperty
(String name, String value) Set a property to the given value.default boolean
supportsProperties
(Map<String, String> properties) Returns whether this build configuration supports the given build properties.Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
Methods inherited from interface org.eclipse.cdt.core.parser.IScannerInfoProvider
getScannerInformation, subscribe, unsubscribe
-
Field Details
-
DEFAULT_NAME
CDT doesn't like that the Platform default config name is an empty string. It needs a real name for the name of the build directory, for example.- See Also:
-
TOOLCHAIN_TYPE
- Since:
- 6.4
- See Also:
-
TOOLCHAIN_ID
- Since:
- 6.4
- See Also:
-
-
Method Details
-
getBuildConfiguration
org.eclipse.core.resources.IBuildConfiguration getBuildConfiguration() throws org.eclipse.core.runtime.CoreExceptionReturns the resources build configuration that this CDT build configuration is associated with.- Returns:
- resources build configuration
- Throws:
org.eclipse.core.runtime.CoreException
-
getToolChain
Build Configurations are configurations for a given toolchain.- Returns:
- the toolchain for this build configuration
- Throws:
org.eclipse.core.runtime.CoreException
-
getLaunchMode
Return the launch mode associated with this build configuration.- Since:
- 6.4
-
getBinaryParserIds
Ids for the Binary Parsers to use when checking whether a file is a binary that can be launched.- Returns:
- binary parser ids
- Throws:
org.eclipse.core.runtime.CoreException
- Since:
- 8.0
-
getVariable
Return a build environment variable with a given name.- Parameters:
name
- build environment variable name- Returns:
- value of the build environment variable.
- Throws:
org.eclipse.core.runtime.CoreException
-
getVariables
Return all of the build environment variables for this configuration.- Returns:
- environment variables
- Throws:
org.eclipse.core.runtime.CoreException
-
build
org.eclipse.core.resources.IProject[] build(int kind, Map<String, String> args, IConsole console, org.eclipse.core.runtime.IProgressMonitor monitor) throws org.eclipse.core.runtime.CoreExceptionPerform the build.- Parameters:
kind
- build typeargs
- build argumentsconsole
- console to show build outputmonitor
- progress monitor- Returns:
- the list of projects for which this builder would like deltas the
next time it is run or
null
if none - Throws:
org.eclipse.core.runtime.CoreException
-
clean
void clean(IConsole console, org.eclipse.core.runtime.IProgressMonitor monitor) throws org.eclipse.core.runtime.CoreException Perform clean.- Parameters:
console
- console to show clean outputmonitor
- progress monitor- Throws:
org.eclipse.core.runtime.CoreException
-
getBuildOutput
The binaries produced by the build.- Returns:
- binaries produced by the build.
- Throws:
org.eclipse.core.runtime.CoreException
- Since:
- 6.1
-
setBuildEnvironment
Set the environment for the builds. Generally the environment from a ProcessBuilder would be passed here.- Parameters:
env
- build environment- Since:
- 6.1
-
setProperties
Set the properties for this build configuration. These will often come from launch configurations which have build settings as attributes.- Parameters:
properties
- build properties- Returns:
- whether the properties have changed
- Since:
- 6.2
-
getProperties
Return the properties for this build configuration.- Returns:
- default properties
- Since:
- 6.2
-
getDefaultProperties
Returns the default values for the properties.- Since:
- 6.2
-
setProperty
Set a property to the given value.- Parameters:
name
- the name of the propertyvalue
- the new value for the property- Since:
- 6.4
-
removeProperty
Remove the named property.- Parameters:
name
- name of the property- Since:
- 6.4
-
getProperty
Return the named property.- Parameters:
name
- the name of the property- Since:
- 6.4
-
supportsProperties
Returns whether this build configuration supports the given build properties.- Parameters:
properties
- build properties- Returns:
- whether this build configuration supports those properties
- Since:
- 6.2
-