org.eclipse.cdt.managedbuilder.core
Interface ITool

All Superinterfaces:
IBuildObject, IHoldsOptions
All Known Subinterfaces:
IToolReference
All Known Implementing Classes:
Tool, ToolReference

public interface ITool
extends IBuildObject, IHoldsOptions

This interface represents a utility of some sort that is used in the build process. A tool will generally process one or more resources to produce output resources. Most tools have a set of options that can be used to modify the behavior of the tool.


Field Summary
static java.lang.String ADVANCED_INPUT_CATEGORY
           
static java.lang.String ANNOUNCEMENT
           
static java.lang.String COMMAND
           
static java.lang.String COMMAND_LINE_GENERATOR
           
static java.lang.String COMMAND_LINE_PATTERN
           
static java.lang.String CONVERT_TO_ID
           
static java.lang.String CUSTOM_BUILD_STEP
           
static java.lang.String DEP_CALC_ID
           
static java.lang.String EMPTY_STRING
           
static int FILTER_BOTH
           
static int FILTER_C
           
static int FILTER_CC
           
static java.lang.String INPUT_TYPE
           
static java.lang.String INTERFACE_EXTS
           
static java.lang.String IS_SYSTEM
           
static java.lang.String NATURE
           
static java.lang.String OPTIONPATHCONVERTER
           
static java.lang.String OUTPUT_FLAG
           
static java.lang.String OUTPUT_PREFIX
           
static java.lang.String OUTPUT_TYPE
           
static java.lang.String OUTPUTS
           
static java.lang.String SOURCES
           
static java.lang.String SUPPORTS_MANAGED_BUILD
           
static java.lang.String TOOL_ELEMENT_NAME
           
static java.lang.String VERSIONS_SUPPORTED
           
static java.lang.String WHITE_SPACE
           
 
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.IHoldsOptions
OPTION, OPTION_CAT, OPTION_REF
 
Method Summary
 boolean buildsFileType(java.lang.String extension)
          Return true if the receiver builds files with the specified extension, else false.
 IInputType createInputType(IInputType superClass, java.lang.String Id, java.lang.String name, boolean isExtensionElement)
          Creates a child InputType for this tool.
 IOutputType createOutputType(IOutputType superClass, java.lang.String Id, java.lang.String name, boolean isExtensionElement)
          Creates a child OutputType for this tool.
 org.eclipse.core.runtime.IPath[] getAdditionalDependencies()
          Returns all of the additional dependency resources of all InputType children.
 org.eclipse.core.runtime.IPath[] getAdditionalResources()
          Returns all of the additional input resources of all InputType children.
 boolean getAdvancedInputCategory()
          Returns true if the Tool wants the MBS to display the Advanced Input category that allows the user to specify additional input resources and dependencies, else false.
 java.lang.String[] getAllDependencyExtensions()
          Returns the array of all valid dependency extensions for this tool's inputs.
 java.lang.String[] getAllInputExtensions()
          Returns the array of all valid source extensions this tool knows how to build.
 java.lang.String[] getAllOutputExtensions()
          Returns the array of all valid output extensions this tool can create.
 java.lang.String getAnnouncement()
          Returns the announcement string for this tool
 org.eclipse.cdt.core.settings.model.extension.CLanguageData getCLanguageData(IInputType type)
           
 org.eclipse.cdt.core.settings.model.extension.CLanguageData[] getCLanguageDatas()
           
 java.lang.String[] getCommandFlags()
          Deprecated. - use getToolCommandFlags instead
 IManagedCommandLineGenerator getCommandLineGenerator()
          Returns the command line generator specified for this tool
 org.eclipse.core.runtime.IConfigurationElement getCommandLineGeneratorElement()
          Deprecated. - use getCommandLineGenerator
 java.lang.String getCommandLinePattern()
          Returns command line pattern for this tool
 java.lang.String getConvertToId()
          Returns the 'convertToId' of this tool
 boolean getCustomBuildStep()
          Returns true if the Tool represents a user-define custom build step, else false.
 java.lang.String getDefaultInputExtension()
          Returns the default input extension for the primary input of the tool
 IManagedDependencyGenerator getDependencyGenerator()
          Deprecated. - use getDependencyGeneratorForExtension or IInputType method
 org.eclipse.core.runtime.IConfigurationElement getDependencyGeneratorElement()
          Deprecated. - use getDependencyGeneratorForExtension or IInputType#getDependencyGenerator method
 IManagedDependencyGeneratorType getDependencyGeneratorForExtension(java.lang.String sourceExt)
          Returns a class instance that implements an interface to generate source-level dependencies for the tool specified in the argument.
 IInputType getEdtableInputType(IInputType base)
           
 IOutputType getEdtableOutputType(IOutputType base)
           
 IEnvVarBuildPath[] getEnvVarBuildPaths()
          Returns an array of the Environment Build Path variable descriptors
 java.lang.String getErrorParserIds()
          Returns the semicolon separated list of unique IDs of the error parsers associated with the tool.
 java.lang.String[] getErrorParserList()
          Returns the ordered list of unique IDs of the error parsers associated with the tool.
 java.util.List getInputExtensions()
          Deprecated. - use getPrimaryInputExtensions or getAllInputExtensions
 IInputType getInputType(java.lang.String inputExtension)
          Returns the IInputType in the tool that uses the specified extension.
 IInputType getInputTypeById(java.lang.String id)
          Returns the IInputType in the tool with the specified ID.
 IInputType getInputTypeForCLanguageData(org.eclipse.cdt.core.settings.model.extension.CLanguageData data)
           
 IInputType[] getInputTypes()
          Returns the complete list of input types that are available for this tool.
 java.util.List getInterfaceExtensions()
          Deprecated. - use getDependency* methods
 int getNatureFilter()
          Answers a constant corresponding to the project nature the tool should be used for.
 IOptionPathConverter getOptionPathConverter()
          Returns an IOptionPathConverter implementation for this tool or null, if no conversion is required
 java.lang.String getOutputExtension(java.lang.String inputExtension)
          Answer the output extension the receiver will create from the input, or null if the tool does not understand that extension.
 java.lang.String[] getOutputExtensions()
          Deprecated. - use getAllOutputExtensions
 java.lang.String getOutputFlag()
          Answers the argument that must be passed to a specific tool in order to control the name of the output artifact.
 java.lang.String getOutputPrefix()
          Answers the prefix that the tool should prepend to the name of the build artifact.
 java.lang.String[] getOutputsAttribute()
          Answers all of the output extensions that the receiver can build, from the value of the outputs attribute
 IOutputType getOutputType(java.lang.String outputExtension)
          Returns the IOutputType in the tool that creates the specified extension.
 IOutputType getOutputTypeById(java.lang.String id)
          Get the IOutputType in the receiver with the specified ID.
 IOutputType[] getOutputTypes()
          Returns the complete list of output types that are available for this tool.
 IBuildObject getParent()
          Returns the tool-chain or resource configuration that is the parent of this tool.
 IResourceInfo getParentResourceInfo()
           
 java.lang.String[] getPrimaryInputExtensions()
          Returns the array of valid primary source extensions this tool knows how to build.
 IInputType getPrimaryInputType()
          Returns the primary IInputType in this tool If the receiver has no InputTypes, the method returns null.
 IOutputType getPrimaryOutputType()
          Returns the primary IOutputType in this tool If the receiver has no OutputTypes, the method returns null.
 ITool getSuperClass()
          Returns the ITool that is the superclass of this tool, or null if the attribute was not specified.
 java.lang.String getToolCommand()
          Answers the command-line invocation defined for the receiver.
 java.lang.String[] getToolCommandFlags(org.eclipse.core.runtime.IPath inputFileLocation, org.eclipse.core.runtime.IPath outputFileLocation)
          Returns an array of command line arguments that have been specified for the tool.
 java.lang.String getToolCommandFlagsString(org.eclipse.core.runtime.IPath inputFileLocation, org.eclipse.core.runtime.IPath outputFileLocation)
          Returns the command line arguments that have been specified for the tool.
 java.lang.String getToolFlags()
          Deprecated. - use getToolCommandFlagsString instead
 IOptionCategory getTopOptionCategory()
          Options are organized into categories for UI purposes.
 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 tool
 boolean isAbstract()
          Returns whether this element is abstract.
 boolean isDirty()
          Returns true if this tool has changes that need to be saved in the project file, else false.
 boolean isEnabled()
           
 boolean isExtensionElement()
          Returns true if this tool was loaded from a manifest file, and false if it was loaded from a project (.cdtbuild) file.
 boolean isHeaderFile(java.lang.String ext)
          Answers true if the tool considers the file extension to be one associated with a header file.
 boolean isInputFileType(java.lang.String extension)
          Return true if the receiver uses files with the specified extension as input, else false.
 boolean isSystemObject()
           
 boolean matches(ITool tool)
           
 boolean producesFileType(java.lang.String outputExtension)
          Answers true if the receiver builds a file with the extension specified in the argument, else false.
 void removeInputType(IInputType type)
          Removes an InputType from the tool's list.
 void removeOutputType(IOutputType type)
          Removes an OutputType from the tool's list.
 void setAdvancedInputCategory(boolean display)
          Sets whether the Tool wants the MBS to display the Advanced Input category that allows the user to specify additional input resources and dependencies.
 void setAnnouncement(java.lang.String announcement)
          Sets the announcement string for this tool
 void setCommandLineGeneratorElement(org.eclipse.core.runtime.IConfigurationElement element)
          Deprecated.  
 void setCommandLinePattern(java.lang.String pattern)
          Sets the command line pattern for this tool
 void setConvertToId(java.lang.String convertToId)
          Sets the 'convertToId' attribute of the tool.
 void setCustomBuildStep(boolean customBuildStep)
          Sets whether the Tool represents a user-define custom build step.
 void setDependencyGeneratorElement(org.eclipse.core.runtime.IConfigurationElement element)
          Deprecated.  
 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 tool-chain.
 void setOutputFlag(java.lang.String flag)
          Sets the argument that must be passed to a specific tool in order to control the name of the output artifact.
 void setOutputPrefix(java.lang.String prefix)
          Sets the prefix that the tool should prepend to the name of the build artifact.
 void setOutputPrefixForPrimaryOutput(java.lang.String prefix)
           
 void setOutputsAttribute(java.lang.String extensions)
          Sets all of the output extensions that the receiver can build, into the outputs attribute.
 boolean setToolCommand(java.lang.String command)
          Sets the command-line invocation command defined for this tool.
 void setVersionsSupported(java.lang.String versionsSupported)
          Sets the 'versionsSupported' attribute of the tool.
 boolean supportsBuild(boolean managed)
           
 
Methods inherited from interface org.eclipse.cdt.managedbuilder.core.IHoldsOptions
addOptionCategory, createOption, createOptions, getChildCategories, getOption, getOptionById, getOptionBySuperClassId, getOptionCategory, getOptions, getOptionToSet, needsRebuild, removeOption, setRebuildState
 

Field Detail

COMMAND

static final java.lang.String COMMAND
See Also:
Constant Field Values

COMMAND_LINE_PATTERN

static final java.lang.String COMMAND_LINE_PATTERN
See Also:
Constant Field Values

COMMAND_LINE_GENERATOR

static final java.lang.String COMMAND_LINE_GENERATOR
See Also:
Constant Field Values

DEP_CALC_ID

static final java.lang.String DEP_CALC_ID
See Also:
Constant Field Values

INTERFACE_EXTS

static final java.lang.String INTERFACE_EXTS
See Also:
Constant Field Values

NATURE

static final java.lang.String NATURE
See Also:
Constant Field Values

OUTPUT_FLAG

static final java.lang.String OUTPUT_FLAG
See Also:
Constant Field Values

INPUT_TYPE

static final java.lang.String INPUT_TYPE
See Also:
Constant Field Values

OUTPUT_TYPE

static final java.lang.String OUTPUT_TYPE
See Also:
Constant Field Values

OUTPUT_PREFIX

static final java.lang.String OUTPUT_PREFIX
See Also:
Constant Field Values

OUTPUTS

static final java.lang.String OUTPUTS
See Also:
Constant Field Values

SOURCES

static final java.lang.String SOURCES
See Also:
Constant Field Values

ADVANCED_INPUT_CATEGORY

static final java.lang.String ADVANCED_INPUT_CATEGORY
See Also:
Constant Field Values

CUSTOM_BUILD_STEP

static final java.lang.String CUSTOM_BUILD_STEP
See Also:
Constant Field Values

ANNOUNCEMENT

static final java.lang.String ANNOUNCEMENT
See Also:
Constant Field Values

TOOL_ELEMENT_NAME

static final java.lang.String TOOL_ELEMENT_NAME
See Also:
Constant Field Values

WHITE_SPACE

static final java.lang.String WHITE_SPACE
See Also:
Constant Field Values

EMPTY_STRING

static final java.lang.String EMPTY_STRING
See Also:
Constant Field Values

IS_SYSTEM

static final java.lang.String IS_SYSTEM
See Also:
Constant Field Values

VERSIONS_SUPPORTED

static final java.lang.String VERSIONS_SUPPORTED
See Also:
Constant Field Values

CONVERT_TO_ID

static final java.lang.String CONVERT_TO_ID
See Also:
Constant Field Values

OPTIONPATHCONVERTER

static final java.lang.String OPTIONPATHCONVERTER
See Also:
Constant Field Values

SUPPORTS_MANAGED_BUILD

static final java.lang.String SUPPORTS_MANAGED_BUILD
See Also:
Constant Field Values

FILTER_C

static final int FILTER_C
See Also:
Constant Field Values

FILTER_CC

static final int FILTER_CC
See Also:
Constant Field Values

FILTER_BOTH

static final int FILTER_BOTH
See Also:
Constant Field Values
Method Detail

getParent

IBuildObject getParent()
Returns the tool-chain or resource configuration that is the parent of this tool.

Returns:
IBuildObject

createInputType

IInputType createInputType(IInputType superClass,
                           java.lang.String Id,
                           java.lang.String name,
                           boolean isExtensionElement)
Creates a child InputType for this tool.

Parameters:
InputType - The superClass, if any
String - The id for the new InputType
String - The name for the new InputType
boolean - Indicates whether this is an extension element or a managed project element
Returns:
IInputType
Since:
3.0

removeInputType

void removeInputType(IInputType type)
Removes an InputType from the tool's list.

Parameters:
type -
Since:
3.0

getInputTypes

IInputType[] getInputTypes()
Returns the complete list of input types that are available for this tool. The list is a merging of the input types specified for this tool with the input types of its superclasses. The lowest input type instance in the hierarchy takes precedence.

Returns:
IInputType[]
Since:
3.0

getInputTypeById

IInputType getInputTypeById(java.lang.String id)
Returns the IInputType in the tool with the specified ID. This is an efficient search in the receiver.

If the receiver does not have an InputType with that ID, the method returns null. It is the responsibility of the caller to verify the return value.

Parameters:
id - unique identifier of the InputType to search for
Returns:
IInputType
Since:
3.0

getInputType

IInputType getInputType(java.lang.String inputExtension)
Returns the IInputType in the tool that uses the specified extension.

If the receiver does not have an InputType that uses the extension, the method returns null. It is the responsibility of the caller to verify the return value.

Parameters:
inputExtension - File extension
Returns:
IInputType
Since:
3.0

getPrimaryInputType

IInputType getPrimaryInputType()
Returns the primary IInputType in this tool

If the receiver has no InputTypes, the method returns null. It is the responsibility of the caller to verify the return value.

Returns:
IInputType
Since:
3.0

getAdditionalResources

org.eclipse.core.runtime.IPath[] getAdditionalResources()
Returns all of the additional input resources of all InputType children. Note: This does not include the primary InputType and does not include additional dependencies.

Returns:
IPath[]

getAdditionalDependencies

org.eclipse.core.runtime.IPath[] getAdditionalDependencies()
Returns all of the additional dependency resources of all InputType children. Note: This does not include the primary InputType and does not include additional inputs.

Returns:
IPath[]

createOutputType

IOutputType createOutputType(IOutputType superClass,
                             java.lang.String Id,
                             java.lang.String name,
                             boolean isExtensionElement)
Creates a child OutputType for this tool.

Parameters:
OutputType - The superClass, if any
String - The id for the new OutputType
String - The name for the new OutputType
boolean - Indicates whether this is an extension element or a managed project element
Returns:
IOutputType
Since:
3.0

removeOutputType

void removeOutputType(IOutputType type)
Removes an OutputType from the tool's list.

Parameters:
type -
Since:
3.0

getOutputTypes

IOutputType[] getOutputTypes()
Returns the complete list of output types that are available for this tool. The list is a merging of the output types specified for this tool with the output types of its superclasses. The lowest output type instance in the hierarchy takes precedence.

Returns:
IOutputType[]
Since:
3.0

getOutputTypeById

IOutputType getOutputTypeById(java.lang.String id)
Get the IOutputType in the receiver with the specified ID. This is an efficient search in the receiver.

If the receiver does not have an OutputType with that ID, the method returns null. It is the responsibility of the caller to verify the return value.

Parameters:
id - unique identifier of the OutputType to search for
Returns:
IOutputType
Since:
3.0

getOutputType

IOutputType getOutputType(java.lang.String outputExtension)
Returns the IOutputType in the tool that creates the specified extension.

If the receiver does not have an OutputType that creates the extension, the method returns null. It is the responsibility of the caller to verify the return value.

Parameters:
outputExtension - File extension
Returns:
IOutputType
Since:
3.0

getPrimaryOutputType

IOutputType getPrimaryOutputType()
Returns the primary IOutputType in this tool

If the receiver has no OutputTypes, the method returns null. It is the responsibility of the caller to verify the return value.

Returns:
IOutputType
Since:
3.0

getSuperClass

ITool getSuperClass()
Returns the ITool that is the superclass of this tool, or null if the attribute was not specified.

Returns:
ITool

isAbstract

boolean isAbstract()
Returns whether this element is abstract. Returns false if the attribute was not specified.

Returns:
boolean

setIsAbstract

void setIsAbstract(boolean b)
Sets the isAbstract attribute of the tool-chain.

Parameters:
b -

getUnusedChildren

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. Returns an empty string if the attribute was not specified.

Returns:
String

getErrorParserIds

java.lang.String getErrorParserIds()
Returns the semicolon separated list of unique IDs of the error parsers associated with the tool.

Returns:
String

getErrorParserList

java.lang.String[] getErrorParserList()
Returns the ordered list of unique IDs of the error parsers associated with the tool.

Returns:
String[]

setErrorParserIds

void setErrorParserIds(java.lang.String ids)
Sets the semicolon separated list of error parser ids

Parameters:
ids -

getInputExtensions

java.util.List getInputExtensions()
Deprecated. - use getPrimaryInputExtensions or getAllInputExtensions

Returns the list of valid source extensions this tool knows how to build. The list may be empty but will never be null.

Returns:
List

getPrimaryInputExtensions

java.lang.String[] getPrimaryInputExtensions()
Returns the array of valid primary source extensions this tool knows how to build. The array may be empty but will never be null.

Returns:
String[]

getAllInputExtensions

java.lang.String[] getAllInputExtensions()
Returns the array of all valid source extensions this tool knows how to build. The array may be empty but will never be null.

Returns:
String[]

getDefaultInputExtension

java.lang.String getDefaultInputExtension()
Returns the default input extension for the primary input of the tool

Returns:
String

getAllDependencyExtensions

java.lang.String[] getAllDependencyExtensions()
Returns the array of all valid dependency extensions for this tool's inputs. The array may be empty but will never be null.

Returns:
String[]

getInterfaceExtensions

java.util.List getInterfaceExtensions()
Deprecated. - use getDependency* methods

Returns the list of valid header extensions for this tool. Returns the value of the headerExtensions attribute The list may be empty but will never be null.

Returns:
List

getNatureFilter

int getNatureFilter()
Answers a constant corresponding to the project nature the tool should be used for. Possible answers are:
ITool.FILTER_C
The tool should only be displayed for C projects. Notes: even though a C++ project has a C nature, this flag will mask the tool for C++ projects.
ITool.FILTER_CC
The tool should only be displayed for C++ projects.
ITool.FILTER_BOTH
The tool should be displayed for projects with both natures.

Returns:
int

getAllOutputExtensions

java.lang.String[] getAllOutputExtensions()
Returns the array of all valid output extensions this tool can create. The array may be empty but will never be null.

Returns:
String[]

getOutputExtensions

java.lang.String[] getOutputExtensions()
Deprecated. - use getAllOutputExtensions

Answers all of the output extensions that the receiver can build. This routine returns the value if the outputs attribute.

Returns:
String[] of extensions

getOutputsAttribute

java.lang.String[] getOutputsAttribute()
Answers all of the output extensions that the receiver can build, from the value of the outputs attribute

Returns:
String[] of extensions

getOutputExtension

java.lang.String getOutputExtension(java.lang.String inputExtension)
Answer the output extension the receiver will create from the input, or null if the tool does not understand that extension.

Parameters:
inputExtension - The extension of the source file.
Returns:
String

setOutputsAttribute

void setOutputsAttribute(java.lang.String extensions)
Sets all of the output extensions that the receiver can build, into the outputs attribute. Note that the outputs attribute is ignored when one or more outputTypes are specified.

Parameters:
String -

getOutputFlag

java.lang.String getOutputFlag()
Answers the argument that must be passed to a specific tool in order to control the name of the output artifact. For example, the GCC compile and linker use '-o', while the archiver does not.

Returns:
String

setOutputFlag

void setOutputFlag(java.lang.String flag)
Sets the argument that must be passed to a specific tool in order to control the name of the output artifact. For example, the GCC compile and linker use '-o', while the archiver does not.

Parameters:
String -

getOutputPrefix

java.lang.String getOutputPrefix()
Answers the prefix that the tool should prepend to the name of the build artifact. For example, a librarian usually prepends 'lib' to the target.a

Returns:
String

setOutputPrefix

void setOutputPrefix(java.lang.String prefix)
Sets the prefix that the tool should prepend to the name of the build artifact. For example, a librarian usually prepends 'lib' to the target.a

Parameters:
String -
See Also:
#setOutputPrefixForPrimaryOutput(String)}

setOutputPrefixForPrimaryOutput

void setOutputPrefixForPrimaryOutput(java.lang.String prefix)

getAdvancedInputCategory

boolean getAdvancedInputCategory()
Returns true if the Tool wants the MBS to display the Advanced Input category that allows the user to specify additional input resources and dependencies, else false.

Returns:
boolean

setAdvancedInputCategory

void setAdvancedInputCategory(boolean display)
Sets whether the Tool wants the MBS to display the Advanced Input category that allows the user to specify additional input resources and dependencies.

Parameters:
display -

getCustomBuildStep

boolean getCustomBuildStep()
Returns true if the Tool represents a user-define custom build step, else false.

Returns:
boolean

setCustomBuildStep

void setCustomBuildStep(boolean customBuildStep)
Sets whether the Tool represents a user-define custom build step.

Parameters:
customBuildStep -

getAnnouncement

java.lang.String getAnnouncement()
Returns the announcement string for this tool

Returns:
String

setAnnouncement

void setAnnouncement(java.lang.String announcement)
Sets the announcement string for this tool

Parameters:
announcement -

getToolCommand

java.lang.String getToolCommand()
Answers the command-line invocation defined for the receiver.

Returns:
String

setToolCommand

boolean setToolCommand(java.lang.String command)
Sets the command-line invocation command defined for this tool.

Parameters:
String -
Returns:
boolean if true, then the tool command was modified

getCommandLinePattern

java.lang.String getCommandLinePattern()
Returns command line pattern for this tool

Returns:
String

setCommandLinePattern

void setCommandLinePattern(java.lang.String pattern)
Sets the command line pattern for this tool

Parameters:
String -

getCommandLineGeneratorElement

org.eclipse.core.runtime.IConfigurationElement getCommandLineGeneratorElement()
Deprecated. - use getCommandLineGenerator

Returns the plugin.xml element of the commandLineGenerator extension or null if none.

Returns:
IConfigurationElement

setCommandLineGeneratorElement

void setCommandLineGeneratorElement(org.eclipse.core.runtime.IConfigurationElement element)
Deprecated. 

Sets the CommandLineGenerator plugin.xml element

Parameters:
element -

getCommandLineGenerator

IManagedCommandLineGenerator getCommandLineGenerator()
Returns the command line generator specified for this tool

Returns:
IManagedCommandLineGenerator

getDependencyGeneratorElement

org.eclipse.core.runtime.IConfigurationElement getDependencyGeneratorElement()
Deprecated. - use getDependencyGeneratorForExtension or IInputType#getDependencyGenerator method

Returns the plugin.xml element of the dependencyGenerator extension or null if none.

Returns:
IConfigurationElement

setDependencyGeneratorElement

void setDependencyGeneratorElement(org.eclipse.core.runtime.IConfigurationElement element)
Deprecated. 

Sets the DependencyGenerator plugin.xml element

Parameters:
element -

getDependencyGenerator

IManagedDependencyGenerator getDependencyGenerator()
Deprecated. - use getDependencyGeneratorForExtension or IInputType method

Returns a class instance that implements an interface to generate source-level dependencies for the tool specified in the argument. This method may return null in which case, the receiver should assume that the tool does not require dependency information when the project is built.

Returns:
IManagedDependencyGenerator

getDependencyGeneratorForExtension

IManagedDependencyGeneratorType getDependencyGeneratorForExtension(java.lang.String sourceExt)
Returns a class instance that implements an interface to generate source-level dependencies for the tool specified in the argument. This method may return null in which case, the receiver should assume that the tool does not require dependency information when the project is built.

Parameters:
sourceExt - source file extension
Returns:
IManagedDependencyGeneratorType

getCommandFlags

java.lang.String[] getCommandFlags()
                                   throws BuildException
Deprecated. - use getToolCommandFlags instead

Returns an array of command line arguments that have been specified for the tool. The flags contain build macros resolved to the makefile format. That is if a user has chosen to expand all macros in the buildfile, the flags contain all macro references resolved, otherwise, if a user has chosen to keep the environment build macros unresolved, the flags contain the environment macro references converted to the buildfile variable format, all other macro references are resolved

Returns:
String[]
Throws:
BuildException

getToolFlags

java.lang.String getToolFlags()
                              throws BuildException
Deprecated. - use getToolCommandFlagsString instead

Returns the command line arguments that have been specified for the tool. 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

Returns:
String
Throws:
BuildException

getToolCommandFlags

java.lang.String[] getToolCommandFlags(org.eclipse.core.runtime.IPath inputFileLocation,
                                       org.eclipse.core.runtime.IPath outputFileLocation)
                                       throws BuildException
Returns an array of command line arguments that have been specified for the tool. The flags contain build macros resolved to the makefile format. That is if a user has chosen to expand all macros in the buildfile, the flags contain all macro references resolved, otherwise, if a user has chosen to keep the environment build macros unresolved, the flags contain the environment macro references converted to the buildfile variable format, all other macro references are resolved

Parameters:
inputFileLocation -
outputFileLocation -
Returns:
Throws:
BuildException

getToolCommandFlagsString

java.lang.String getToolCommandFlagsString(org.eclipse.core.runtime.IPath inputFileLocation,
                                           org.eclipse.core.runtime.IPath outputFileLocation)
                                           throws BuildException
Returns the command line arguments that have been specified for the tool. 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

Parameters:
inputFileLocation -
outputFileLocation -
Returns:
Throws:
BuildException

getTopOptionCategory

IOptionCategory getTopOptionCategory()
Options are organized into categories for UI purposes. These categories are organized into a tree. This is the root of that tree.

Returns:
IOptionCategory

buildsFileType

boolean buildsFileType(java.lang.String extension)
Return true if the receiver builds files with the specified extension, else false.

Parameters:
extension - file extension of the source
Returns:
boolean

isInputFileType

boolean isInputFileType(java.lang.String extension)
Return true if the receiver uses files with the specified extension as input, else false. This returns true for a superset of the extensions that buildFileType returns true for - it includes secondary inputs.

Parameters:
extension - file extension of the source
Returns:
boolean

isHeaderFile

boolean isHeaderFile(java.lang.String ext)
Answers true if the tool considers the file extension to be one associated with a header file.

Parameters:
ext - file extension of the source
Returns:
boolean

producesFileType

boolean producesFileType(java.lang.String outputExtension)
Answers true if the receiver builds a file with the extension specified in the argument, else false.

Parameters:
outputExtension - extension of the file being produced by a tool
Returns:
boolean

isDirty

boolean isDirty()
Returns true if this tool has changes that need to be saved in the project file, else false.

Returns:
boolean

setDirty

void setDirty(boolean isDirty)
Sets the element's "dirty" (have I been modified?) flag.

Parameters:
isDirty -

isExtensionElement

boolean isExtensionElement()
Returns true if this tool was loaded from a manifest file, and false if it was loaded from a project (.cdtbuild) file.

Returns:
boolean

getVersionsSupported

java.lang.String getVersionsSupported()
Returns the 'versionsSupported' of this tool

Returns:
String

getConvertToId

java.lang.String getConvertToId()
Returns the 'convertToId' of this tool

Returns:
String

setVersionsSupported

void setVersionsSupported(java.lang.String versionsSupported)
Sets the 'versionsSupported' attribute of the tool.

Parameters:
versionsSupported -

setConvertToId

void setConvertToId(java.lang.String convertToId)
Sets the 'convertToId' attribute of the tool.

Parameters:
convertToId -

getEnvVarBuildPaths

IEnvVarBuildPath[] getEnvVarBuildPaths()
Returns an array of the Environment Build Path variable descriptors

Returns:
IEnvVarBuildPath[]

getOptionPathConverter

IOptionPathConverter getOptionPathConverter()
Returns an IOptionPathConverter implementation for this tool or null, if no conversion is required


getCLanguageData

org.eclipse.cdt.core.settings.model.extension.CLanguageData getCLanguageData(IInputType type)

getCLanguageDatas

org.eclipse.cdt.core.settings.model.extension.CLanguageData[] getCLanguageDatas()

getInputTypeForCLanguageData

IInputType getInputTypeForCLanguageData(org.eclipse.cdt.core.settings.model.extension.CLanguageData data)

getParentResourceInfo

IResourceInfo getParentResourceInfo()

getEdtableInputType

IInputType getEdtableInputType(IInputType base)

getEdtableOutputType

IOutputType getEdtableOutputType(IOutputType base)

isEnabled

boolean isEnabled()

supportsBuild

boolean supportsBuild(boolean managed)

matches

boolean matches(ITool tool)

isSystemObject

boolean isSystemObject()

getUniqueRealName

java.lang.String getUniqueRealName()