|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IManagedBuildInfo
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_CONFIGURATION
|
static java.lang.String |
DEFAULT_TARGET
|
Method Summary | |
---|---|
void |
addTarget(ITarget target)
Add a new target to the build information for the receiver |
boolean |
buildsFileType(java.lang.String srcExt)
Answers true if the build system knows how to
build a file with the extension passed in the argument. |
IManagedCommandLineInfo |
generateCommandLineInfo(java.lang.String sourceExtension,
java.lang.String[] flags,
java.lang.String outputFlag,
java.lang.String outputPrefix,
java.lang.String outputName,
java.lang.String[] inputResources)
Deprecated. - use generateToolCommandLineInfo instead |
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)
Returns IManagedCommandLineInfo for source with extension
The command line info contains values with
build macros resolved to the makefile format. |
java.lang.String |
getBuildArguments()
Answers a String containing the arguments to be passed to make. |
java.lang.String |
getBuildArtifactExtension()
Answers the file extension for the receivers build goal without a separator. |
java.lang.String |
getBuildArtifactName()
Returns the name of the artifact to build for the receiver. |
java.lang.String |
getBuildCommand()
Answers a String containing the make command invocation
for the default configuration. |
java.lang.String |
getCleanCommand()
Answers the command needed to remove files on the build machine |
java.lang.String |
getConfigurationName()
Answers the name of the default configuration, for example Debug
or Release . |
java.lang.String[] |
getConfigurationNames()
Answers a String array containing the names of all the configurations
defined for the project. |
IConfiguration |
getDefaultConfiguration()
Get the default configuration associated with the receiver |
IManagedDependencyGeneratorType |
getDependencyGenerator(java.lang.String sourceExtension)
|
java.lang.String |
getFlagsForConfiguration(java.lang.String extension)
Deprecated. - use getToolFlagsForConfiguration |
java.lang.String |
getFlagsForSource(java.lang.String extension)
Deprecated. - use getToolFlagsForSource |
java.lang.String[] |
getLibsForConfiguration(java.lang.String extension)
Answers the libraries the project links in. |
IManagedProject |
getManagedProject()
Returns the ManagedProject associated with this build info |
java.lang.String |
getOutputExtension(java.lang.String resourceExtension)
Answers the extension that will be built by the current configuration for the extension passed in the argument or null . |
java.lang.String |
getOutputFlag(java.lang.String outputExt)
Answers the flag to be passed to the build tool to produce a specific output or an empty String if there is no special flag. |
java.lang.String |
getOutputPrefix(java.lang.String outputExtension)
Answers the prefix that should be prepended to the name of the build artifact. |
java.lang.String |
getPostannouncebuildStep()
Answers the display string associated with the postbuild step for the default configuration |
java.lang.String |
getPostbuildStep()
Answers the postbuild step for the default configuration |
java.lang.String |
getPreannouncebuildStep()
Answers the display string associated with the prebuild step for the default configuration |
java.lang.String |
getPrebuildStep()
Answers the prebuild step for the default configuration |
IConfiguration |
getSelectedConfiguration()
Returns the currently selected configuration. |
ITarget |
getTarget(java.lang.String id)
Get the target specified in the argument. |
java.util.List |
getTargets()
Get all of the targets associated with the receiver. |
java.lang.String |
getToolFlagsForConfiguration(java.lang.String extension,
org.eclipse.core.runtime.IPath inputLocation,
org.eclipse.core.runtime.IPath outputLocation)
Returns a String containing the flags, including
those overridden by the user, for the tool in the configuration
defined by the argument. |
java.lang.String |
getToolFlagsForSource(java.lang.String extension,
org.eclipse.core.runtime.IPath inputLocation,
org.eclipse.core.runtime.IPath outputLocation)
Returns a String containing the flags, including
those overridden by the user, for the tool that handles the
type of source file defined by the argument. |
java.lang.String |
getToolForConfiguration(java.lang.String extension)
Returns a String containing the command-line invocation
for the tool associated with the output extension. |
java.lang.String |
getToolForSource(java.lang.String sourceExtension)
Returns a String containing the command-line invocation
for the tool associated with the source extension. |
ITool |
getToolFromInputExtension(java.lang.String extension)
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. |
java.lang.String[] |
getUserObjectsForConfiguration(java.lang.String extension)
Answers a String array containing the contents of the
user objects option, if one is defined for the target. |
java.lang.String |
getVersion()
Answers the version of the build information in the format |
boolean |
isDirty()
Answers true if the build model has been changed by the user. |
boolean |
isHeaderFile(java.lang.String ext)
Answers true if the extension matches one of the special
file extensions the tools for the configuration consider to be a header file. |
boolean |
isReadOnly()
Gets the read only status of Managed Build Info |
boolean |
isValid()
Gets the "valid" status of Managed Build Info. |
boolean |
needsRebuild()
Answers whether the receiver has been changed and requires the project to be rebuilt. |
void |
removeTarget(java.lang.String id)
|
void |
setDefaultConfiguration(IConfiguration configuration)
Set the primary configuration for the receiver. |
boolean |
setDefaultConfiguration(java.lang.String configName)
|
void |
setDirty(boolean isDirty)
Sets the dirty flag for the build model to the value of the argument. |
void |
setManagedProject(IManagedProject project)
Sets the ManagedProject associated with this build info |
void |
setReadOnly(boolean readOnly)
sets the read only status of Managed Build Info |
void |
setRebuildState(boolean rebuild)
Sets the rebuild state in the receiver to the value of the argument. |
void |
setSelectedConfiguration(IConfiguration configuration)
Sets the currently selected configuration. |
void |
setValid(boolean isValid)
Sets the valid flag for the build model to the value of the argument. |
Field Detail |
---|
static final java.lang.String DEFAULT_CONFIGURATION
static final java.lang.String DEFAULT_TARGET
Method Detail |
---|
void addTarget(ITarget target)
target
- boolean buildsFileType(java.lang.String srcExt)
true
if the build system knows how to
build a file with the extension passed in the argument.
srcExt
-
IManagedCommandLineInfo generateCommandLineInfo(java.lang.String sourceExtension, java.lang.String[] flags, java.lang.String outputFlag, java.lang.String outputPrefix, java.lang.String outputName, java.lang.String[] inputResources)
IManagedCommandLineInfo
for source with extension
The command line info contains values with
build macros resolved to the makefile format.
That is if a user has chosen to expand all macros in the buildfile,
command line info contains values contain all macro references resolved, otherwise, if a user has
chosen to keep the environment build macros unresolved, the command line info contains values contain
the environment macro references converted to the buildfile variable format,
all other macro references are resolved
sourceExtension
- - source extensionflags
- - build flagsoutputFlag
- - output flag for build tooloutputPrefix
- outputName
- inputResources
-
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)
IManagedCommandLineInfo
for source with extension
The command line info contains values with
build macros resolved to the makefile format.
That is if a user has chosen to expand all macros in the buildfile,
command line info contains values contain all macro references resolved, otherwise, if a user has
chosen to keep the environment build macros unresolved, the command line info contains values contain
the environment macro references converted to the buildfile variable format,
all other macro references are resolved
sourceExtension
- flags
- outputFlag
- outputPrefix
- outputName
- inputResources
- inputLocation
- outputLocation
-
java.lang.String getBuildArguments()
String
containing the arguments to be passed to make.
For example, if the user has selected a build that keeps going on error, the
answer would contain {"-k"}.
java.lang.String getBuildArtifactExtension()
java.lang.String getBuildArtifactName()
java.lang.String getBuildCommand()
String
containing the make command invocation
for the default configuration.
java.lang.String getPrebuildStep()
java.lang.String getPostbuildStep()
java.lang.String getPreannouncebuildStep()
java.lang.String getPostannouncebuildStep()
java.lang.String getCleanCommand()
java.lang.String getConfigurationName()
Debug
or Release
.
java.lang.String[] getConfigurationNames()
String
array containing the names of all the configurations
defined for the project.
IConfiguration getDefaultConfiguration()
IManagedDependencyGeneratorType getDependencyGenerator(java.lang.String sourceExtension)
sourceExtension
-
java.lang.String getFlagsForConfiguration(java.lang.String extension)
String
containing the flags, including
those overridden by the user, for the tool in the configuration
defined by the argument.
The string contains build macros resolved to the makefile format.
That is if a user has chosen to expand all macros in the buildfile,
the string contains all macro references resolved, otherwise, if a user has
chosen to keep the environment build macros unresolved, the string contains
the environment macro references converted to the buildfile variable format,
all other macro references are resolved
extension
-
java.lang.String getToolFlagsForConfiguration(java.lang.String extension, org.eclipse.core.runtime.IPath inputLocation, org.eclipse.core.runtime.IPath outputLocation)
String
containing the flags, including
those overridden by the user, for the tool in the configuration
defined by the argument.
The string contains build macros resolved to the makefile format.
That is if a user has chosen to expand all macros in the buildfile,
the string contains all macro references resolved, otherwise, if a user has
chosen to keep the environment build macros unresolved, the string contains
the environment macro references converted to the buildfile variable format,
all other macro references are resolved
extension
- inputLocation
- outputLocation
-
java.lang.String getFlagsForSource(java.lang.String extension)
String
containing the flags, including
those overridden by the user, for the tool that handles the
type of source file defined by the argument.
The string contains build macros resolved to the makefile format.
That is if a user has chosen to expand all macros in the buildfile,
the string contains all macro references resolved, otherwise, if a user has
chosen to keep the environment build macros unresolved, the string contains
the environment macro references converted to the buildfile variable format,
all other macro references are resolved
extension
-
java.lang.String getToolFlagsForSource(java.lang.String extension, org.eclipse.core.runtime.IPath inputLocation, org.eclipse.core.runtime.IPath outputLocation)
String
containing the flags, including
those overridden by the user, for the tool that handles the
type of source file defined by the argument.
The string contains build macros resolved to the makefile format.
That is if a user has chosen to expand all macros in the buildfile,
the string contains all macro references resolved, otherwise, if a user has
chosen to keep the environment build macros unresolved, the string contains
the environment macro references converted to the buildfile variable format,
all other macro references are resolved
extension
- inputLocation
- outputLocation
-
java.lang.String[] getLibsForConfiguration(java.lang.String extension)
extension
-
IManagedProject getManagedProject()
java.lang.String getOutputExtension(java.lang.String resourceExtension)
null
.
resourceName
-
java.lang.String getOutputFlag(java.lang.String outputExt)
String
if there is no special flag. For example, the
GCC tools use the '-o' flag to produce a named output, for example
gcc -c foo.c -o foo.o
outputExt
-
java.lang.String getOutputPrefix(java.lang.String outputExtension)
extension
-
IConfiguration getSelectedConfiguration()
ITarget getTarget(java.lang.String id)
id
-
java.util.List getTargets()
java.lang.String getToolForConfiguration(java.lang.String extension)
String
containing the command-line invocation
for the tool associated with the output extension.
extension
- the file extension of the output file
java.lang.String getToolForSource(java.lang.String sourceExtension)
String
containing the command-line invocation
for the tool associated with the source extension.
sourceExtension
- the file extension of the file to be built
ITool getToolFromInputExtension(java.lang.String extension)
ITool
for the tool associated with the
input extension.
extension
- the file extension of the input file
ITool getToolFromOutputExtension(java.lang.String extension)
ITool
for the tool associated with the
output extension.
extension
- the file extension of the output file
java.lang.String[] getUserObjectsForConfiguration(java.lang.String extension)
String
array containing the contents of the
user objects option, if one is defined for the target.
extension
- the file ecxtension of the build target
java.lang.String getVersion()
String
containing the build information
versionboolean isDirty()
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 isReadOnly()
true
if Managed Build Info is read only
otherwise returns false
boolean isValid()
true
if Managed Build Info is valid,
otherwise returns false
boolean needsRebuild()
Clients can reset the state to force or clear the rebuild status
using setRebuildState()
true
if the resource managed by the
receiver needs to be rebuiltManagedBuildInfo#setRebuildState(boolean)
void removeTarget(java.lang.String id)
void setDefaultConfiguration(IConfiguration configuration)
configuration
- The IConfiguration
that will be used as the default
for all building.boolean setDefaultConfiguration(java.lang.String configName)
configuration
-
void setDirty(boolean isDirty)
isDirty
- void setValid(boolean isValid)
isValid
- void setManagedProject(IManagedProject project)
project
- void setReadOnly(boolean readOnly)
readOnly
- void setRebuildState(boolean rebuild)
true
- will force a rebuild the next time the project buildsvoid setSelectedConfiguration(IConfiguration configuration)
configuration
- the user selection
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |