|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IBuilder
This class represents the utility that drives the build process (typically, but not necessarily, a variant of "make"). It defines the command needed to invoke the build utility in the command attribute. Any special flags that need to be passed to the builder are defined in the arguments attribute. The builder can specify the error parser(s) to be used to parse its output. The builder also specifies a Java class that generates the build file.
Field Summary | |
---|---|
static java.lang.String |
ARGUMENTS
|
static java.lang.String |
ATTRIBUTE_APPEND_ENVIRONMENT
|
static java.lang.String |
ATTRIBUTE_AUTO_ENABLED
|
static java.lang.String |
ATTRIBUTE_BUILD_PATH
|
static java.lang.String |
ATTRIBUTE_CLEAN_ENABLED
|
static java.lang.String |
ATTRIBUTE_CUSTOM_PROPS
|
static java.lang.String |
ATTRIBUTE_CUSTOMIZED_ERROR_PARSERS
|
static java.lang.String |
ATTRIBUTE_ENVIRONMENT
|
static java.lang.String |
ATTRIBUTE_IGNORE_ERR_CMD
|
static java.lang.String |
ATTRIBUTE_INCREMENTAL_ENABLED
|
static java.lang.String |
ATTRIBUTE_KEEP_ENV
|
static java.lang.String |
ATTRIBUTE_MANAGED_BUILD_ON
|
static java.lang.String |
ATTRIBUTE_PARALLEL_BUILD_CMD
|
static java.lang.String |
ATTRIBUTE_PARALLEL_BUILD_ON
|
static java.lang.String |
ATTRIBUTE_PARALLELIZATION_NUMBER
|
static java.lang.String |
ATTRIBUTE_STOP_ON_ERR
|
static java.lang.String |
ATTRIBUTE_SUPORTS_MANAGED_BUILD
|
static java.lang.String |
ATTRIBUTE_TARGET_AUTO
|
static java.lang.String |
ATTRIBUTE_TARGET_CLEAN
|
static java.lang.String |
ATTRIBUTE_TARGET_INCREMENTAL
|
static java.lang.String |
BUILDER_ELEMENT_NAME
|
static java.lang.String |
BUILDFILEGEN_ID
|
static java.lang.String |
COMMAND
|
static java.lang.String |
CONVERT_TO_ID
|
static java.lang.String |
DEFAULT_TARGET_AUTO
|
static java.lang.String |
DEFAULT_TARGET_CLEAN
|
static java.lang.String |
DEFAULT_TARGET_INCREMENTAL
|
static java.lang.String |
IS_SYSTEM
|
static java.lang.String |
IS_VARIABLE_CASE_SENSITIVE
|
static java.lang.String |
OUTPUT_ENTRIES
|
static java.lang.String |
PARALLEL_PATTERN_NUM
|
static java.lang.String |
PARALLEL_PATTERN_NUM_END
|
static java.lang.String |
PARALLEL_PATTERN_NUM_START
|
static java.lang.String |
RESERVED_MACRO_NAME_SUPPLIER
|
static java.lang.String |
RESERVED_MACRO_NAMES
|
static java.lang.String |
VARIABLE_FORMAT
|
static java.lang.String |
VERSIONS_SUPPORTED
|
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject |
---|
ID, NAME |
Fields inherited from interface org.eclipse.cdt.newmake.core.IMakeBuilderInfo |
---|
BUILD_TARGET_AUTO, BUILD_TARGET_CLEAN, BUILD_TARGET_FULL, BUILD_TARGET_INCREAMENTAL, BUILD_TARGET_INCREMENTAL |
Fields inherited from interface org.eclipse.cdt.newmake.core.IMakeCommonBuildInfo |
---|
ARGS_PREFIX, BUILD_ARGUMENTS, BUILD_COMMAND, BUILD_LOCATION |
Method Summary | |
---|---|
boolean |
canKeepEnvironmentVariablesInBuildfile()
|
java.lang.String |
getArguments()
Returns the command line arguments to pass to the build/make utility used to build a configuration. |
org.eclipse.cdt.core.settings.model.extension.CBuildData |
getBuildData()
|
java.lang.String |
getBuilderVariablePattern()
Returns String representing the build variable pattern to be used while makefile generation |
IManagedBuilderMakefileGenerator |
getBuildFileGenerator()
Returns the BuildfileGenerator used to generate buildfiles for this builder |
org.eclipse.core.runtime.IConfigurationElement |
getBuildFileGeneratorElement()
Deprecated. - use getBuildFileGenerator() instead |
java.lang.String |
getBuildPath()
|
java.lang.String |
getCommand()
Returns the name of the build/make utility for the configuration. |
java.lang.String |
getConvertToId()
Returns the 'convertToId' of this builder |
java.lang.String |
getErrorParserIds()
Returns the semicolon separated list of unique IDs of the error parsers associated with the builder. |
java.lang.String[] |
getErrorParserList()
Returns the ordered list of unique IDs of the error parsers associated with the builder. |
IFileContextBuildMacroValues |
getFileContextBuildMacroValues()
Returns the IFileContextBuildMacroValues interface reference that specifies the file-context macro-values provided by the tool-integrator |
IToolChain |
getParent()
Returns the tool-chain that is the parent of this builder. |
java.lang.String[] |
getReservedMacroNames()
Returns an array of Strings representing the patterns of the builder/buildfile-generator reserved variables |
IReservedMacroNameSupplier |
getReservedMacroNameSupplier()
Returns the tool-integrator defined implementation of the IReservedMacroNameSupplier to be used for detecting the builder/buildfile-generator reserved variables |
IBuilder |
getSuperClass()
Returns the IBuilder that is the superclass of this
target platform, or null if the attribute was not specified. |
java.lang.String |
getUniqueRealName()
|
java.lang.String |
getUnusedChildren()
Returns a semi-colon delimited list of child Ids of the superclass' children that should not be automatically inherited by this element. |
java.lang.String |
getVersionsSupported()
Returns the 'versionsSupported' of this builder |
boolean |
isAbstract()
Returns whether this element is abstract. |
boolean |
isCustomBuilder()
|
boolean |
isDirty()
Returns true if this element has changes that need to
be saved in the project file, else false . |
boolean |
isExtensionElement()
Returns true if this builder was loaded from a manifest file,
and false if it was loaded from a project (.cdtbuild) file. |
boolean |
isInternalBuilder()
|
boolean |
isSystemObject()
|
boolean |
isVariableCaseSensitive()
Returns whether the builder supports case sensitive variables or not |
boolean |
keepEnvironmentVariablesInBuildfile()
|
boolean |
matches(IBuilder builder)
|
void |
setArguments(java.lang.String makeArgs)
Sets the arguments to be passed to the build utility used by the receiver to produce a build goal. |
void |
setBuildFileGeneratorElement(org.eclipse.core.runtime.IConfigurationElement element)
Deprecated. |
void |
setBuildPath(java.lang.String path)
|
void |
setCommand(java.lang.String command)
Sets the build command for the receiver to the value in the argument. |
void |
setConvertToId(java.lang.String convertToId)
Sets the 'convertToId' attribute of the builder. |
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 |
setIsAbstract(boolean b)
Sets the isAbstract attribute of the builder. |
void |
setKeepEnvironmentVariablesInBuildfile(boolean keep)
|
void |
setVersionsSupported(java.lang.String versionsSupported)
Sets the 'versionsSupported' attribute of the builder. |
boolean |
supportsCustomizedBuild()
|
Methods inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject |
---|
getBaseId, getId, getManagedBuildRevision, getName, getVersion, setVersion |
Methods inherited from interface org.eclipse.cdt.newmake.core.IMakeBuilderInfo |
---|
getAutoBuildTarget, getCleanBuildTarget, getFullBuildTarget, getIncrementalBuildTarget, isAutoBuildEnable, isCleanBuildEnabled, isFullBuildEnabled, isIncrementalBuildEnabled, setAutoBuildEnable, setAutoBuildTarget, setCleanBuildEnable, setCleanBuildTarget, setFullBuildEnable, setFullBuildTarget, setIncrementalBuildEnable, setIncrementalBuildTarget |
Field Detail |
---|
static final java.lang.String ARGUMENTS
static final java.lang.String BUILDER_ELEMENT_NAME
static final java.lang.String BUILDFILEGEN_ID
static final java.lang.String COMMAND
static final java.lang.String VERSIONS_SUPPORTED
static final java.lang.String CONVERT_TO_ID
static final java.lang.String VARIABLE_FORMAT
static final java.lang.String IS_VARIABLE_CASE_SENSITIVE
static final java.lang.String RESERVED_MACRO_NAMES
static final java.lang.String RESERVED_MACRO_NAME_SUPPLIER
static final java.lang.String IS_SYSTEM
static final java.lang.String ATTRIBUTE_BUILD_PATH
static final java.lang.String ATTRIBUTE_TARGET_AUTO
static final java.lang.String ATTRIBUTE_TARGET_INCREMENTAL
static final java.lang.String ATTRIBUTE_TARGET_CLEAN
static final java.lang.String ATTRIBUTE_CLEAN_ENABLED
static final java.lang.String ATTRIBUTE_INCREMENTAL_ENABLED
static final java.lang.String ATTRIBUTE_AUTO_ENABLED
static final java.lang.String ATTRIBUTE_ENVIRONMENT
static final java.lang.String ATTRIBUTE_APPEND_ENVIRONMENT
static final java.lang.String ATTRIBUTE_MANAGED_BUILD_ON
static final java.lang.String ATTRIBUTE_KEEP_ENV
static final java.lang.String ATTRIBUTE_SUPORTS_MANAGED_BUILD
static final java.lang.String ATTRIBUTE_CUSTOMIZED_ERROR_PARSERS
static final java.lang.String ATTRIBUTE_CUSTOM_PROPS
static final java.lang.String ATTRIBUTE_IGNORE_ERR_CMD
static final java.lang.String ATTRIBUTE_STOP_ON_ERR
static final java.lang.String ATTRIBUTE_PARALLEL_BUILD_CMD
static final java.lang.String ATTRIBUTE_PARALLELIZATION_NUMBER
static final java.lang.String ATTRIBUTE_PARALLEL_BUILD_ON
static final java.lang.String PARALLEL_PATTERN_NUM
static final java.lang.String PARALLEL_PATTERN_NUM_START
static final java.lang.String PARALLEL_PATTERN_NUM_END
static final java.lang.String OUTPUT_ENTRIES
static final java.lang.String DEFAULT_TARGET_INCREMENTAL
static final java.lang.String DEFAULT_TARGET_CLEAN
static final java.lang.String DEFAULT_TARGET_AUTO
Method Detail |
---|
java.lang.String getArguments()
org.eclipse.core.runtime.IConfigurationElement getBuildFileGeneratorElement()
null
if none.
IManagedBuilderMakefileGenerator getBuildFileGenerator()
java.lang.String getCommand()
java.lang.String getErrorParserIds()
java.lang.String[] getErrorParserList()
IToolChain getParent()
IBuilder getSuperClass()
IBuilder
that is the superclass of this
target platform, or null
if the attribute was not specified.
java.lang.String getUnusedChildren()
boolean isAbstract()
false
if the attribute was not specified.
boolean isDirty()
true
if this element has changes that need to
be saved in the project file, else false
.
boolean isExtensionElement()
true
if this builder was loaded from a manifest file,
and false
if it was loaded from a project (.cdtbuild) file.
void setArguments(java.lang.String makeArgs)
makeArgs
- void setBuildFileGeneratorElement(org.eclipse.core.runtime.IConfigurationElement element)
element
- void setCommand(java.lang.String command)
command
- void setDirty(boolean isDirty)
isDirty
- void setErrorParserIds(java.lang.String ids)
ids
- void setIsAbstract(boolean b)
b
- java.lang.String getVersionsSupported()
java.lang.String getConvertToId()
void setVersionsSupported(java.lang.String versionsSupported)
versionsSupported
- void setConvertToId(java.lang.String convertToId)
convertToId
- IFileContextBuildMacroValues getFileContextBuildMacroValues()
java.lang.String getBuilderVariablePattern()
boolean isVariableCaseSensitive()
java.lang.String[] getReservedMacroNames()
IReservedMacroNameSupplier getReservedMacroNameSupplier()
org.eclipse.cdt.core.settings.model.extension.CBuildData getBuildData()
boolean isCustomBuilder()
boolean supportsCustomizedBuild()
boolean keepEnvironmentVariablesInBuildfile()
void setKeepEnvironmentVariablesInBuildfile(boolean keep)
boolean canKeepEnvironmentVariablesInBuildfile()
void setBuildPath(java.lang.String path)
java.lang.String getBuildPath()
boolean isInternalBuilder()
boolean matches(IBuilder builder)
boolean isSystemObject()
java.lang.String getUniqueRealName()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |