|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IConfiguration
A tool-integrator defines default configurations as children of the project type. These provide a template for the configurations added to the user's project, which are stored in the project's .cdtbuild file.
The configuration contains one child of type tool-chain. This describes how the project's resources are transformed into the build artifact. The configuration can contain one or more children of type resourceConfiguration. These describe build settings of individual resources that are different from the configuration as a whole.
Field Summary | |
---|---|
static java.lang.String |
ARTIFACT_NAME
|
static java.lang.String |
BUILD_ARTEFACT_TYPE
|
static java.lang.String |
BUILD_PROPERTIES
|
static java.lang.String |
CLEAN_COMMAND
|
static java.lang.String |
CONFIGURATION_ELEMENT_NAME
|
static java.lang.String |
DESCRIPTION
|
static java.lang.String |
ERROR_PARSERS
|
static java.lang.String |
EXTENSION
|
static java.lang.String |
IS_SYSTEM
|
static java.lang.String |
PARENT
|
static java.lang.String |
POSTANNOUNCEBUILD_STEP
|
static java.lang.String |
POSTBUILD_STEP
|
static java.lang.String |
PREANNOUNCEBUILD_STEP
|
static java.lang.String |
PREBUILD_STEP
|
static java.lang.String |
SOURCE_ENTRIES
|
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject |
---|
ID, NAME |
Method Summary | |
---|---|
boolean |
buildsFileType(java.lang.String srcExt)
|
ITool |
calculateTargetTool()
Calculates the configuration target tool. |
void |
changeBuilder(IBuilder newBuilder,
java.lang.String id,
java.lang.String name)
|
IFileInfo |
createFileInfo(org.eclipse.core.runtime.IPath path)
|
IFileInfo |
createFileInfo(org.eclipse.core.runtime.IPath path,
IFileInfo base,
java.lang.String id,
java.lang.String name)
|
IFileInfo |
createFileInfo(org.eclipse.core.runtime.IPath path,
IFolderInfo base,
ITool baseTool,
java.lang.String id,
java.lang.String name)
|
IFileInfo |
createFileInfo(org.eclipse.core.runtime.IPath path,
java.lang.String id,
java.lang.String name)
|
IFolderInfo |
createFolderInfo(org.eclipse.core.runtime.IPath path)
|
IFolderInfo |
createFolderInfo(org.eclipse.core.runtime.IPath path,
IFolderInfo base,
java.lang.String id,
java.lang.String name)
|
IFolderInfo |
createFolderInfo(org.eclipse.core.runtime.IPath path,
java.lang.String id,
java.lang.String name)
|
IResourceConfiguration |
createResourceConfiguration(org.eclipse.core.resources.IFile file)
Creates a child resource configuration corresponding to the passed in file. |
IToolChain |
createToolChain(IToolChain superClass,
java.lang.String Id,
java.lang.String name,
boolean isExtensionElement)
Creates the IToolChain child of this configuration. |
IManagedCommandLineInfo |
generateToolCommandLineInfo(java.lang.String sourceExtension,
java.lang.String[] flags,
java.lang.String outputFlag,
java.lang.String outputPrefix,
java.lang.String outputName,
java.lang.String[] inputResources,
org.eclipse.core.runtime.IPath inputLocation,
org.eclipse.core.runtime.IPath outputLocation)
|
java.lang.String |
getArtifactExtension()
Returns the extension that should be applied to build artifacts created by this configuration. |
java.lang.String |
getArtifactName()
Returns the name of the final build artifact. |
java.lang.String |
getBuildArguments()
Returns the build arguments from this configuration's builder |
IBuildPropertyValue |
getBuildArtefactType()
|
java.lang.String |
getBuildCommand()
Returns the build command from this configuration's builder |
org.eclipse.cdt.core.settings.model.extension.CBuildData |
getBuildData()
|
IBuilder |
getBuilder()
|
IConfigurationBuildMacroSupplier |
getBuildMacroSupplier()
Returns the tool-integrator provided implementation of the configuration build macro supplier or null if none. |
java.lang.String |
getCleanCommand()
Answers the OS-specific command to remove files created by the build of this configuration. |
org.eclipse.cdt.core.settings.model.extension.CConfigurationData |
getConfigurationData()
|
java.lang.String |
getDescription()
Returns the description of the configuration. |
IBuilder |
getEditableBuilder()
|
IConfigurationEnvironmentVariableSupplier |
getEnvironmentVariableSupplier()
Returns the implementation of the IConfigurationEnvironmentVariableSupplier provided by the tool-integrator or null if none. |
java.lang.String |
getErrorParserIds()
Answers the semicolon separated list of unique IDs of the error parsers associated with this configuration. |
java.lang.String[] |
getErrorParserList()
Answers the ordered list of unique IDs of the error parsers associated with this configuration. |
ITool[] |
getFilteredTools()
Projects have C or CC natures. |
java.lang.String[] |
getLibs(java.lang.String extension)
|
IManagedProject |
getManagedProject()
Returns the managed-project parent of this configuration, if this is a project configuration. |
java.lang.String |
getOutputExtension(java.lang.String resourceExtension)
|
java.lang.String |
getOutputFlag(java.lang.String outputExt)
|
java.lang.String |
getOutputPrefix(java.lang.String outputExtension)
|
org.eclipse.core.resources.IResource |
getOwner()
Returns the Eclipse project that owns the configuration. |
IConfiguration |
getParent()
Returns the configuration that this configuration is based on. |
java.lang.String |
getPostannouncebuildStep()
Returns the display string associated with the postbuild step |
java.lang.String |
getPostbuildStep()
Returns the postbuild step command |
java.lang.String |
getPreannouncebuildStep()
Returns the display string associated with the prebuild step |
java.lang.String |
getPrebuildStep()
Returns the prebuild step command |
IProjectType |
getProjectType()
Returns the project-type parent of this configuration, if this is an extension configuration. |
IResourceConfiguration |
getResourceConfiguration(java.lang.String path)
Returns the resource configuration child of this configuration that is associated with the project resource, or null if none. |
IResourceConfiguration[] |
getResourceConfigurations()
Returns the resource configuration children of this configuration. |
IResourceInfo |
getResourceInfo(org.eclipse.core.runtime.IPath path,
boolean exactPath)
|
IResourceInfo |
getResourceInfoById(java.lang.String id)
|
IResourceInfo[] |
getResourceInfos()
|
IFolderInfo |
getRootFolderInfo()
|
org.eclipse.cdt.core.settings.model.ICSourceEntry[] |
getSourceEntries()
|
ITool |
getTargetTool()
Returns the tool in this configuration specified with the toolChain#targetTool attribute that creates the build artifact NOTE: This method returns null in case the toolChain definition does not have the targetTool attribute or if the attribute does not refer to the appropriate tool. |
ITool |
getTool(java.lang.String id)
Returns the ITool in this configuration's tool-chain with
the same id as the argument, or null . |
IToolChain |
getToolChain()
Returns the IToolChain child of this configuration. |
java.lang.String |
getToolCommand(ITool tool)
Returns the command-line invocation command for the specified tool. |
ITool |
getToolFromInputExtension(java.lang.String sourceExtension)
Returns a ITool for the tool associated with the
input extension. |
ITool |
getToolFromOutputExtension(java.lang.String extension)
Returns a ITool for the tool associated with the
output extension. |
ITool[] |
getTools()
Returns the tools that are used in this configuration's tool-chain. |
ITool[] |
getToolsBySuperClassId(java.lang.String id)
Returns the ITool in this configuration's tool-chain with
the specified ID, or the tool(s) with a superclass with this id. |
java.lang.String[] |
getUserObjects(java.lang.String extension)
|
boolean |
hasOverriddenBuildCommand()
Returns true if this configuration has overridden the default build
build command in this configuration, otherwise false . |
boolean |
isBuilderCompatible(IBuilder builder)
|
boolean |
isDirty()
Returns true if this configuration has changes that need to
be saved in the project file, else false . |
boolean |
isExtensionElement()
Returns true if this configuration was loaded from a manifest file,
and false if it was loaded from a project (.cdtbuild) file. |
boolean |
isHeaderFile(java.lang.String ext)
Returns true if the extension matches one of the special
file extensions the tools for the configuration consider to be a header file. |
boolean |
isManagedBuildOn()
|
boolean |
isSupported()
Returns true if the configuration's tool-chain is supported on the system
otherwise returns false |
boolean |
isSystemObject()
|
boolean |
isTemporary()
answers true if the configuration is temporary, otherwise - false |
boolean |
needsFullRebuild()
Returns whether this configuration requires a full rebuild |
boolean |
needsRebuild()
Returns whether this configuration has been changed and requires the project to be rebuilt. |
void |
removeResourceConfiguration(IResourceInfo resConfig)
Removes a resource configuration from the configuration's list. |
void |
removeResourceInfo(org.eclipse.core.runtime.IPath path)
|
void |
setArtifactExtension(java.lang.String extension)
Set (override) the extension that should be appended to the build artifact for the receiver. |
void |
setArtifactName(java.lang.String name)
Set the name of the artifact that will be produced when the receiver is built. |
void |
setBuildArguments(java.lang.String makeArgs)
Sets the arguments to be passed to the build utility used by the receiver to produce a build goal. |
void |
setBuildArtefactType(java.lang.String id)
|
void |
setBuildCommand(java.lang.String command)
Sets the build command for the receiver to the value in the argument. |
void |
setCleanCommand(java.lang.String command)
Sets the command used to clean the outputs of this configuration. |
void |
setDescription(java.lang.String description)
Sets the description of the receiver to the value specified in the argument |
void |
setDirty(boolean isDirty)
Sets the element's "dirty" (have I been modified?) |
void |
setErrorParserIds(java.lang.String ids)
Sets the semicolon separated list of error parser ids |
void |
setErrorParserList(java.lang.String[] ids)
|
void |
setManagedBuildOn(boolean on)
|
void |
setName(java.lang.String name)
Sets the name of the receiver to the value specified in the argument |
IOption |
setOption(IHoldsOptions parent,
IOption option,
boolean value)
Sets the value of a boolean option for this configuration. |
IOption |
setOption(IHoldsOptions parent,
IOption option,
java.lang.String value)
Sets the value of a string option for this configuration. |
IOption |
setOption(IHoldsOptions parent,
IOption option,
java.lang.String[] value)
Sets the value of a list option for this configuration. |
void |
setPostannouncebuildStep(java.lang.String announceStep)
Sets the postbuild step display string for the receiver to the value in the argument. |
void |
setPostbuildStep(java.lang.String step)
Sets the postbuild step for the receiver to the value in the argument. |
void |
setPreannouncebuildStep(java.lang.String announceStep)
Sets the prebuild step display string for the receiver to the value in the argument. |
void |
setPrebuildStep(java.lang.String step)
Sets the prebuild step for the receiver to the value in the argument. |
void |
setRebuildState(boolean rebuild)
Sets the rebuild state in this configuration. |
void |
setSourceEntries(org.eclipse.cdt.core.settings.model.ICSourceEntry[] entries)
|
void |
setToolCommand(ITool tool,
java.lang.String command)
Overrides the tool command for a tool defined in this configuration's tool-chain. |
boolean |
supportsBuild(boolean managed)
|
Methods inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject |
---|
getBaseId, getId, getManagedBuildRevision, getName, getVersion, setVersion |
Methods inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObjectPropertiesContainer |
---|
getBuildProperties |
Field Detail |
---|
static final java.lang.String ARTIFACT_NAME
static final java.lang.String CLEAN_COMMAND
static final java.lang.String PREBUILD_STEP
static final java.lang.String POSTBUILD_STEP
static final java.lang.String PREANNOUNCEBUILD_STEP
static final java.lang.String POSTANNOUNCEBUILD_STEP
static final java.lang.String CONFIGURATION_ELEMENT_NAME
static final java.lang.String ERROR_PARSERS
static final java.lang.String EXTENSION
static final java.lang.String PARENT
static final java.lang.String DESCRIPTION
static final java.lang.String BUILD_PROPERTIES
static final java.lang.String BUILD_ARTEFACT_TYPE
static final java.lang.String IS_SYSTEM
static final java.lang.String SOURCE_ENTRIES
Method Detail |
---|
java.lang.String getDescription()
void setDescription(java.lang.String description)
description
- IResourceConfiguration createResourceConfiguration(org.eclipse.core.resources.IFile file)
file
-
IToolChain createToolChain(IToolChain superClass, java.lang.String Id, java.lang.String name, boolean isExtensionElement)
IToolChain
child of this configuration.
ToolChain
- The superClass, if anyString
- The id for the new tool chainString
- The name for the new tool chain
java.lang.String getArtifactExtension()
java.lang.String getArtifactName()
java.lang.String getBuildArguments()
java.lang.String getBuildCommand()
java.lang.String getPrebuildStep()
java.lang.String getPostbuildStep()
java.lang.String getPreannouncebuildStep()
java.lang.String getPostannouncebuildStep()
java.lang.String getCleanCommand()
java.lang.String getErrorParserIds()
java.lang.String[] getErrorParserList()
ITool[] getFilteredTools()
ITools
that have compatible filters
for this configuration.IManagedProject getManagedProject()
null
.
org.eclipse.core.resources.IResource getOwner()
IConfiguration getParent()
IProjectType getProjectType()
null
.
IResourceConfiguration getResourceConfiguration(java.lang.String path)
null
if none.
IResourceConfiguration[] getResourceConfigurations()
ITool getTool(java.lang.String id)
ITool
in this configuration's tool-chain with
the same id as the argument, or null
.
id
- unique identifier to search for
ITool[] getToolsBySuperClassId(java.lang.String id)
ITool
in this configuration's tool-chain with
the specified ID, or the tool(s) with a superclass with this id.
If the tool-chain does not have a tool with that ID, the method returns an empty array. It is the responsibility of the caller to verify the return value.
id
- unique identifier of the tool to search for
ITool[]
IToolChain getToolChain()
IToolChain
child of this configuration.
java.lang.String getToolCommand(ITool tool)
tool
- The tool that will have its command retrieved.
ITool[] getTools()
ITool getTargetTool()
calculateTargetTool()
boolean hasOverriddenBuildCommand()
true
if this configuration has overridden the default build
build command in this configuration, otherwise false
.
boolean isHeaderFile(java.lang.String ext)
true
if the extension matches one of the special
file extensions the tools for the configuration consider to be a header file.
ext
- the file extension of the resource
boolean isDirty()
true
if this configuration has changes that need to
be saved in the project file, else false
.
Should not be called for an extension configuration.
boolean isExtensionElement()
true
if this configuration was loaded from a manifest file,
and false
if it was loaded from a project (.cdtbuild) file.
boolean needsRebuild()
true
if the configuration contains a change
that needs the project to be rebuilt.
Should not be called for an extension configuration.void removeResourceConfiguration(IResourceInfo resConfig)
option
- void removeResourceInfo(org.eclipse.core.runtime.IPath path)
void setArtifactExtension(java.lang.String extension)
extension
- void setArtifactName(java.lang.String name)
name
- void setBuildArguments(java.lang.String makeArgs)
makeArgs
- void setBuildCommand(java.lang.String command)
command
- void setPrebuildStep(java.lang.String step)
step
- void setPostbuildStep(java.lang.String step)
step
- void setPreannouncebuildStep(java.lang.String announceStep)
announceStep
- void setPostannouncebuildStep(java.lang.String announceStep)
announceStep
- void setCleanCommand(java.lang.String command)
name
- void setDirty(boolean isDirty)
isDirty
- void setErrorParserIds(java.lang.String ids)
ids
- void setErrorParserList(java.lang.String[] ids)
void setName(java.lang.String name)
name
- IOption setOption(IHoldsOptions parent, IOption option, boolean value) throws BuildException
parent
- The holder/parent of the option.option
- The option to change.value
- The value to apply to the option.
BuildException
IOption setOption(IHoldsOptions parent, IOption option, java.lang.String value) throws BuildException
parent
- The holder/parent of the option.option
- The option that will be effected by change.value
- The value to apply to the option.
BuildException
IOption setOption(IHoldsOptions parent, IOption option, java.lang.String[] value) throws BuildException
parent
- The holder/parent of the option.option
- The option to change.value
- The values to apply to the option.
BuildException
void setRebuildState(boolean rebuild)
rebuild
- true
will force a rebuild the next time the project buildsIManagedBuildInfo.setRebuildState(boolean)
void setToolCommand(ITool tool, java.lang.String command)
tool
- The tool that will have its command modified.command
- The commandboolean isSupported()
true
if the configuration's tool-chain is supported on the system
otherwise returns false
IConfigurationEnvironmentVariableSupplier getEnvironmentVariableSupplier()
null
if none.
IConfigurationBuildMacroSupplier getBuildMacroSupplier()
null
if none.
boolean isTemporary()
boolean needsFullRebuild()
ITool calculateTargetTool()
ITool getToolFromOutputExtension(java.lang.String extension)
ITool
for the tool associated with the
output extension.
extension
- the file extension of the output file
ITool getToolFromInputExtension(java.lang.String sourceExtension)
ITool
for the tool associated with the
input extension.
extension
- the file extension of the input file
IResourceInfo getResourceInfo(org.eclipse.core.runtime.IPath path, boolean exactPath)
IResourceInfo[] getResourceInfos()
IResourceInfo getResourceInfoById(java.lang.String id)
IFolderInfo getRootFolderInfo()
IFileInfo createFileInfo(org.eclipse.core.runtime.IPath path)
IFileInfo createFileInfo(org.eclipse.core.runtime.IPath path, java.lang.String id, java.lang.String name)
IFileInfo createFileInfo(org.eclipse.core.runtime.IPath path, IFolderInfo base, ITool baseTool, java.lang.String id, java.lang.String name)
IFileInfo createFileInfo(org.eclipse.core.runtime.IPath path, IFileInfo base, java.lang.String id, java.lang.String name)
IFolderInfo createFolderInfo(org.eclipse.core.runtime.IPath path)
IFolderInfo createFolderInfo(org.eclipse.core.runtime.IPath path, java.lang.String id, java.lang.String name)
IFolderInfo createFolderInfo(org.eclipse.core.runtime.IPath path, IFolderInfo base, java.lang.String id, java.lang.String name)
org.eclipse.cdt.core.settings.model.extension.CConfigurationData getConfigurationData()
org.eclipse.cdt.core.settings.model.ICSourceEntry[] getSourceEntries()
void setSourceEntries(org.eclipse.cdt.core.settings.model.ICSourceEntry[] entries)
org.eclipse.cdt.core.settings.model.extension.CBuildData getBuildData()
IBuilder getBuilder()
IBuilder getEditableBuilder()
java.lang.String getOutputPrefix(java.lang.String outputExtension)
boolean isSystemObject()
java.lang.String getOutputExtension(java.lang.String resourceExtension)
java.lang.String getOutputFlag(java.lang.String outputExt)
IManagedCommandLineInfo generateToolCommandLineInfo(java.lang.String sourceExtension, java.lang.String[] flags, java.lang.String outputFlag, java.lang.String outputPrefix, java.lang.String outputName, java.lang.String[] inputResources, org.eclipse.core.runtime.IPath inputLocation, org.eclipse.core.runtime.IPath outputLocation)
java.lang.String[] getUserObjects(java.lang.String extension)
java.lang.String[] getLibs(java.lang.String extension)
boolean buildsFileType(java.lang.String srcExt)
boolean supportsBuild(boolean managed)
boolean isManagedBuildOn()
void setManagedBuildOn(boolean on) throws BuildException
BuildException
boolean isBuilderCompatible(IBuilder builder)
void changeBuilder(IBuilder newBuilder, java.lang.String id, java.lang.String name)
IBuildPropertyValue getBuildArtefactType()
void setBuildArtefactType(java.lang.String id) throws BuildException
BuildException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |