|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.cdt.managedbuilder.internal.core.BuildObject
org.eclipse.cdt.managedbuilder.internal.core.HoldsOptions
org.eclipse.cdt.managedbuilder.internal.core.Tool
public class Tool
Represents a tool that can be invoked during a build. Note that this class implements IOptionCategory to represent the top category.
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_CBS_PATTERN
|
static java.lang.String |
DEFAULT_PATTERN
|
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.ITool |
---|
ADVANCED_INPUT_CATEGORY, ANNOUNCEMENT, COMMAND, COMMAND_LINE_GENERATOR, COMMAND_LINE_PATTERN, CONVERT_TO_ID, CUSTOM_BUILD_STEP, DEP_CALC_ID, FILTER_BOTH, FILTER_C, FILTER_CC, INPUT_TYPE, INTERFACE_EXTS, IS_SYSTEM, NATURE, OPTIONPATHCONVERTER, OUTPUT_FLAG, OUTPUT_PREFIX, OUTPUT_TYPE, OUTPUTS, SOURCES, SUPPORTS_MANAGED_BUILD, TOOL_ELEMENT_NAME, VERSIONS_SUPPORTED, WHITE_SPACE |
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.IHoldsOptions |
---|
OPTION, OPTION_CAT, OPTION_REF |
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.IOptionCategory |
---|
ALL, FILTER_ALL, FILTER_FILE, FILTER_PROJECT, ICON, OWNER, PROJECT |
Constructor Summary | |
---|---|
Tool(IBuildObject parent,
org.eclipse.cdt.core.settings.model.ICStorageElement element,
java.lang.String managedBuildRevision)
Create a Tool based on the specification stored in the
project file (.cdtbuild). |
|
Tool(IBuildObject parent,
IManagedConfigElement element,
java.lang.String managedBuildRevision)
Constructor to create a new tool for a tool-chain based on the information defined in the plugin.xml manifest. |
|
Tool(IBuildObject parent,
ITool toolSuperClass,
java.lang.String Id,
java.lang.String name,
Tool tool)
Create a Tool based upon an existing tool. |
|
Tool(IBuildObject parent,
java.lang.String toolSuperClassId,
java.lang.String Id,
java.lang.String name,
Tool tool)
|
|
Tool(IManagedConfigElement element,
java.lang.String managedBuildRevision)
Constructor to create a tool based on an element from the plugin manifest. |
|
Tool(ResourceConfiguration parent,
ITool superClass,
java.lang.String Id,
java.lang.String name,
boolean isExtensionElement)
This constructor is called to create a Tool whose attributes and children will be added by separate calls. |
|
Tool(ToolChain parent,
ITool superClass,
java.lang.String Id,
java.lang.String name,
boolean isExtensionElement)
This constructor is called to create a Tool whose attributes and children will be added by separate calls. |
Method Summary | |
---|---|
void |
addInputType(InputType type)
|
void |
addOutputType(OutputType type)
|
boolean |
buildsFileType(java.lang.String extension)
Return true if the receiver builds files with the
specified extension, else false . |
void |
checkForMigrationSupport()
|
void |
clearAllDiscoveredInfo()
|
void |
clearAllDiscoveredPathInfo()
|
CfgDiscoveredPathManager.PathInfoCache |
clearDiscoveredPathInfo(IInputType type)
|
int |
compareTo(java.lang.Object o)
|
java.util.Set |
contributeErrorParsers(java.util.Set set)
|
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. |
java.lang.String |
evaluateCommand(java.lang.String command,
java.lang.String values)
Look for ${VALUE} in the command string |
void |
filterValues(int type,
java.util.List values)
|
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[] |
getAllInputExtensions(org.eclipse.core.resources.IProject project)
|
IInputType |
getAllInputTypeById(java.lang.String id)
|
IInputType[] |
getAllInputTypes()
|
java.lang.String[] |
getAllOutputExtensions()
Returns the array of all valid output extensions this tool can create. |
java.lang.String[] |
getAllOutputExtensions(org.eclipse.core.resources.IProject project)
|
IOutputType |
getAllOutputTypeById(java.lang.String id)
|
IOutputType[] |
getAllOutputTypes()
|
java.lang.String |
getAnnouncement()
Returns the announcement string for this tool |
java.lang.String |
getAnnouncementAttribute()
|
BooleanExpressionApplicabilityCalculator |
getBooleanExpressionCalculator()
|
org.eclipse.cdt.core.settings.model.extension.CLanguageData |
getCLanguageData(IInputType type)
|
org.eclipse.cdt.core.settings.model.extension.CLanguageData[] |
getCLanguageDatas()
|
java.lang.String[] |
getCommandFlags()
Returns an array of command line arguments that have been specified for the tool. |
IManagedCommandLineGenerator |
getCommandLineGenerator()
Returns the command line generator specified for this tool |
org.eclipse.core.runtime.IConfigurationElement |
getCommandLineGeneratorElement()
Returns the plugin.xml element of the commandLineGenerator extension or null if none. |
java.lang.String |
getCommandLinePattern()
Returns command line pattern for this tool |
java.lang.String[] |
getContentTypeFileSpecs(org.eclipse.core.runtime.content.IContentType type)
|
java.lang.String[] |
getContentTypeFileSpecs(org.eclipse.core.runtime.content.IContentType type,
org.eclipse.core.resources.IProject project)
|
org.eclipse.core.runtime.IConfigurationElement |
getConverterModificationElement(ITool toTool)
|
java.lang.String |
getConvertToId()
Returns the 'convertToId' of this tool |
org.eclipse.core.runtime.IConfigurationElement |
getCurrentMbsVersionConversionElement()
|
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()
Returns a class instance that implements an interface to generate source-level dependencies for the tool specified in the argument. |
org.eclipse.core.runtime.IConfigurationElement |
getDependencyGeneratorElement()
Returns the plugin.xml element of the dependencyGenerator extension or null if none. |
org.eclipse.core.runtime.IConfigurationElement |
getDependencyGeneratorElementForExtension(java.lang.String sourceExt)
|
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. |
CfgDiscoveredPathManager.PathInfoCache |
getDiscoveredPathInfo(IInputType type)
|
java.lang.String |
getDiscoveryProfileId()
|
java.lang.String |
getDiscoveryProfileIdAttribute()
|
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.net.URL |
getIconPath()
Get the path name of an alternative icon for the option group. |
java.util.List |
getIdenticalList()
|
java.util.List |
getInputExtensions()
Returns the list of valid source extensions this tool knows how to build. |
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()
Returns the list of valid header extensions for this tool. |
java.lang.Object |
getMatchKey()
|
java.lang.String |
getName()
|
java.lang.String |
getNameAndVersion()
|
int |
getNatureFilter()
Answers a constant corresponding to the project nature the tool should be used for. |
IHoldsOptions |
getOptionHolder()
Returns the holder (parent) of this category. |
IOptionPathConverter |
getOptionPathConverter()
Returns an IOptionPathConverter implementation for this tool or null, if no conversion is required |
java.lang.Object[][] |
getOptions(IConfiguration configuration)
|
java.lang.Object[][] |
getOptions(IConfiguration configuration,
IHoldsOptions optionHolder)
Returns an array of ITool/IOption pairs for the options in this category for a given configuration. |
java.lang.Object[][] |
getOptions(IResourceConfiguration resConfig)
|
java.lang.Object[][] |
getOptions(IResourceInfo resConfig)
|
java.lang.Object[][] |
getOptions(IResourceInfo resInfo,
IHoldsOptions optionHolder)
Returns an array of ITool/IOption pairs for the options in this category for a given resource configuration. |
IOption[] |
getOptionsOfType(int type)
|
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()
Answers all of the output extensions that the receiver can build. |
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. |
IOptionCategory |
getOwner()
Returns the category that owns this category, or null if this is the top category for a tool. |
IBuildObject |
getParent()
Returns the tool-chain or resource configuration that is the parent of this tool. |
IResourceInfo |
getParentResourceInfo()
|
org.eclipse.core.runtime.IConfigurationElement |
getPathconverterElement()
|
org.eclipse.core.runtime.IConfigurationElement |
getPreviousMbsVersionConversionElement()
|
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 . |
org.eclipse.core.resources.IProject |
getProject()
|
java.lang.String[] |
getRequiredTypeIds()
|
ITool |
getSuperClass()
Returns the ITool that is the superclass of this
tool, or null if the attribute was not specified. |
java.lang.String[] |
getSupportedTypeIds()
|
java.lang.String[] |
getSupportedValueIds(java.lang.String typeId)
|
ITool |
getTool()
Returns the tool that ultimately owns this category. |
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[] |
getToolCommandFlags(org.eclipse.core.runtime.IPath inputFileLocation,
org.eclipse.core.runtime.IPath outputFileLocation,
org.eclipse.cdt.utils.cdtvariables.SupplierBasedCdtVariableSubstitutor macroSubstitutor,
IMacroContextInfoProvider provider)
this method used internaly by the Tool to obtain the command flags with the build macros resolved, but could be also used by other MBS components to adjust the tool flags resolution behavior by passing the method some custom macro substitutor |
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()
Returns the command line arguments that have been specified for the tool. |
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 |
hasCustomSettings(Tool tool)
|
boolean |
hasScannerConfigSettings(IInputType type)
|
boolean |
isAbstract()
Returns whether this element is abstract. |
boolean |
isDirty()
Returns true if this element has changes that need to
be saved in the project file, else false . |
boolean |
isEnabled()
|
boolean |
isEnabled(IResourceInfo rcInfo)
|
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 |
needsRebuild()
specifies whether the option holder is modified and needs rebuild |
boolean |
producesFileType(java.lang.String extension)
Answers true if the receiver builds a file with the extension specified
in the argument, else false . |
void |
propertiesChanged()
|
void |
removeInputType(IInputType type)
Removes an InputType from the tool's list. |
void |
removeOutputType(IOutputType type)
Removes an OutputType from the tool's list. |
boolean |
requiresType(java.lang.String typeId)
|
void |
resetErrorParsers()
|
void |
resolveReferences()
|
void |
serialize(org.eclipse.cdt.core.settings.model.ICStorageElement element)
Persist the tool to the project file. |
void |
setAdvancedInputCategory(boolean b)
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 newText)
Sets the announcement string for this tool |
void |
setCommandLineGeneratorElement(org.eclipse.core.runtime.IConfigurationElement element)
Sets the CommandLineGenerator plugin.xml element |
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 b)
Sets whether the Tool represents a user-define custom build step. |
void |
setDependencyGeneratorElement(org.eclipse.core.runtime.IConfigurationElement element)
Sets the DependencyGenerator plugin.xml element |
void |
setDirty(boolean isDirty)
Sets the element's "dirty" (have I been modified?) |
CfgDiscoveredPathManager.PathInfoCache |
setDiscoveredPathInfo(IInputType type,
CfgDiscoveredPathManager.PathInfoCache info)
|
void |
setErrorParserIds(java.lang.String ids)
Sets the semicolon separated list of error parser ids |
void |
setErrorParserList(java.lang.String[] ids)
|
void |
setIdenticalList(java.util.List list)
|
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 ext)
Sets all of the output extensions that the receiver can build, into the outputs attribute. |
void |
setRebuildState(boolean rebuild)
sets the holder rebuild state |
void |
setSuperClass(ITool superClass)
|
boolean |
setToolCommand(java.lang.String cmd)
Sets the command-line invocation command defined for this tool. |
void |
setToolParent(IBuildObject newParent)
|
void |
setVersionsSupported(java.lang.String versionsSupported)
Sets the 'versionsSupported' attribute of the tool. |
boolean |
supportsBuild(boolean managed)
|
boolean |
supportsLanguageSettings()
|
boolean |
supportsType(IBuildPropertyType type)
|
boolean |
supportsType(java.lang.String type)
|
boolean |
supportsValue(IBuildPropertyType type,
IBuildPropertyValue value)
|
boolean |
supportsValue(java.lang.String type,
java.lang.String value)
|
Methods inherited from class org.eclipse.cdt.managedbuilder.internal.core.HoldsOptions |
---|
addChildCategory, addOption, addOptionCategory, adjustOptions, createOption, createOptions, getChildCategories, getOption, getOptionById, getOptionBySuperClassId, getOptionCategory, getOptions, getOptionToSet, removeOption |
Methods inherited from class org.eclipse.cdt.managedbuilder.internal.core.BuildObject |
---|
getBaseId, getId, getManagedBuildRevision, getVersion, getVersionFromId, setId, setManagedBuildRevision, setName, setVersion, toString, updateManagedBuildRevision |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.eclipse.cdt.managedbuilder.core.IHoldsOptions |
---|
addOptionCategory, createOption, createOptions, getChildCategories, getOption, getOptionById, getOptionBySuperClassId, getOptionCategory, getOptions, getOptionToSet, removeOption |
Methods inherited from interface org.eclipse.cdt.managedbuilder.core.IOptionCategory |
---|
getChildCategories |
Field Detail |
---|
public static final java.lang.String DEFAULT_PATTERN
public static final java.lang.String DEFAULT_CBS_PATTERN
Constructor Detail |
---|
public Tool(IManagedConfigElement element, java.lang.String managedBuildRevision)
element
- The element containing the information about the tool.managedBuildRevision
- the fileVersion of Managed Build Systempublic Tool(IBuildObject parent, IManagedConfigElement element, java.lang.String managedBuildRevision)
parent
- The parent of this tool. This can be a ToolChain or a
ResourceConfiguration.element
- The element containing the information about the tool.managedBuildRevision
- the fileVersion of Managed Build Systempublic Tool(ToolChain parent, ITool superClass, java.lang.String Id, java.lang.String name, boolean isExtensionElement)
ToolChain
- The parent of the tool, if anyTool
- The superClass, if anyString
- The id for the new toolString
- The name for the new toolboolean
- Indicates whether this is an extension element or a managed project elementpublic Tool(ResourceConfiguration parent, ITool superClass, java.lang.String Id, java.lang.String name, boolean isExtensionElement)
ResourceConfiguration,
- The parent of the tool, if anyTool
- The superClass, if anyString
- The id for the new toolString
- The name for the new toolboolean
- Indicates whether this is an extension element or a managed project elementpublic Tool(IBuildObject parent, org.eclipse.cdt.core.settings.model.ICStorageElement element, java.lang.String managedBuildRevision)
Tool
based on the specification stored in the
project file (.cdtbuild).
parent
- The IToolChain
or IResourceConfiguration
the tool will be added to.element
- The XML element that contains the tool settings.managedBuildRevision
- the fileVersion of Managed Build Systempublic Tool(IBuildObject parent, ITool toolSuperClass, java.lang.String Id, java.lang.String name, Tool tool)
Tool
based upon an existing tool.
parent
- The IToolChain
or IResourceConfiguration
the tool will be added to.tool
- The existing tool to clone.public Tool(IBuildObject parent, java.lang.String toolSuperClassId, java.lang.String Id, java.lang.String name, Tool tool)
Method Detail |
---|
public void serialize(org.eclipse.cdt.core.settings.model.ICStorageElement element)
doc
- element
- public IBuildObject getParent()
ITool
getParent
in interface ITool
public void setToolParent(IBuildObject newParent)
public IOptionCategory getTopOptionCategory()
ITool
getTopOptionCategory
in interface ITool
public IInputType createInputType(IInputType superClass, java.lang.String Id, java.lang.String name, boolean isExtensionElement)
ITool
createInputType
in interface ITool
public void removeInputType(IInputType type)
ITool
removeInputType
in interface ITool
public IInputType[] getInputTypes()
ITool
getInputTypes
in interface ITool
public IInputType[] getAllInputTypes()
public IInputType getInputTypeById(java.lang.String id)
ITool
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.
getInputTypeById
in interface ITool
id
- unique identifier of the InputType to search for
IInputType
public IInputType getAllInputTypeById(java.lang.String id)
public IOutputType createOutputType(IOutputType superClass, java.lang.String Id, java.lang.String name, boolean isExtensionElement)
ITool
createOutputType
in interface ITool
public void removeOutputType(IOutputType type)
ITool
removeOutputType
in interface ITool
public IOutputType[] getOutputTypes()
ITool
getOutputTypes
in interface ITool
public IOutputType[] getAllOutputTypes()
public IOutputType getPrimaryOutputType()
ITool
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.
getPrimaryOutputType
in interface ITool
IOutputType
public IOutputType getOutputTypeById(java.lang.String id)
ITool
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.
getOutputTypeById
in interface ITool
id
- unique identifier of the OutputType to search for
IOutputType
public IOutputType getAllOutputTypeById(java.lang.String id)
public IOptionCategory getOwner()
IOptionCategory
getOwner
in interface IOptionCategory
public java.net.URL getIconPath()
IOptionCategory
getIconPath
in interface IOptionCategory
public java.lang.Object[][] getOptions(IConfiguration configuration, IHoldsOptions optionHolder)
IOptionCategory
getOptions
in interface IOptionCategory
public java.lang.Object[][] getOptions(IConfiguration configuration)
getOptions
in interface IOptionCategory
public java.lang.Object[][] getOptions(IResourceInfo resInfo, IHoldsOptions optionHolder)
IOptionCategory
getOptions
in interface IOptionCategory
public java.lang.Object[][] getOptions(IResourceConfiguration resConfig)
getOptions
in interface IOptionCategory
public java.lang.Object[][] getOptions(IResourceInfo resConfig)
public ITool getTool()
IOptionCategory
getTool
in interface IOptionCategory
public IHoldsOptions getOptionHolder()
IOptionCategory
getOptionHolder
in interface IOptionCategory
public void addInputType(InputType type)
type
- public void addOutputType(OutputType type)
type
- public ITool getSuperClass()
ITool
ITool
that is the superclass of this
tool, or null
if the attribute was not specified.
getSuperClass
in interface ITool
public void setSuperClass(ITool superClass)
public java.lang.String getName()
getName
in interface IBuildObject
getName
in class BuildObject
public boolean isAbstract()
ITool
false
if the attribute was not specified.
isAbstract
in interface ITool
public void setIsAbstract(boolean b)
ITool
setIsAbstract
in interface ITool
public java.lang.String getUnusedChildren()
ITool
getUnusedChildren
in interface ITool
public java.lang.String getErrorParserIds()
ITool
getErrorParserIds
in interface ITool
public java.lang.String[] getErrorParserList()
ITool
getErrorParserList
in interface ITool
public java.util.Set contributeErrorParsers(java.util.Set set)
public java.util.List getInputExtensions()
ITool
null
.
getInputExtensions
in interface ITool
public java.lang.String getDefaultInputExtension()
ITool
getDefaultInputExtension
in interface ITool
public java.lang.String[] getPrimaryInputExtensions()
ITool
null
.
getPrimaryInputExtensions
in interface ITool
public java.lang.String[] getAllInputExtensions()
ITool
null
.
getAllInputExtensions
in interface ITool
public java.lang.String[] getAllInputExtensions(org.eclipse.core.resources.IProject project)
public IInputType getPrimaryInputType()
ITool
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.
getPrimaryInputType
in interface ITool
IInputType
public IInputType getInputType(java.lang.String inputExtension)
ITool
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.
getInputType
in interface ITool
inputExtension
- File extension
IInputType
public org.eclipse.core.runtime.IPath[] getAdditionalDependencies()
ITool
getAdditionalDependencies
in interface ITool
public org.eclipse.core.runtime.IPath[] getAdditionalResources()
ITool
getAdditionalResources
in interface ITool
public java.lang.String[] getAllDependencyExtensions()
ITool
null
.
getAllDependencyExtensions
in interface ITool
public java.util.List getInterfaceExtensions()
ITool
null
.
getInterfaceExtensions
in interface ITool
public java.lang.String getOutputFlag()
ITool
getOutputFlag
in interface ITool
public java.lang.String getOutputPrefix()
ITool
getOutputPrefix
in interface ITool
public java.lang.String getToolCommand()
ITool
getToolCommand
in interface ITool
public java.lang.String getCommandLinePattern()
ITool
getCommandLinePattern
in interface ITool
public boolean getAdvancedInputCategory()
ITool
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
.
getAdvancedInputCategory
in interface ITool
public boolean getCustomBuildStep()
ITool
true
if the Tool represents a user-define custom build
step, else false
.
getCustomBuildStep
in interface ITool
public java.lang.String getAnnouncement()
ITool
getAnnouncement
in interface ITool
public java.lang.String getAnnouncementAttribute()
public org.eclipse.core.runtime.IConfigurationElement getCommandLineGeneratorElement()
ITool
null
if none.
getCommandLineGeneratorElement
in interface ITool
public void setCommandLineGeneratorElement(org.eclipse.core.runtime.IConfigurationElement element)
ITool
setCommandLineGeneratorElement
in interface ITool
public IManagedCommandLineGenerator getCommandLineGenerator()
ITool
getCommandLineGenerator
in interface ITool
public org.eclipse.core.runtime.IConfigurationElement getDependencyGeneratorElement()
ITool
null
if none.
getDependencyGeneratorElement
in interface ITool
public org.eclipse.core.runtime.IConfigurationElement getDependencyGeneratorElementForExtension(java.lang.String sourceExt)
public void setDependencyGeneratorElement(org.eclipse.core.runtime.IConfigurationElement element)
ITool
setDependencyGeneratorElement
in interface ITool
public IManagedDependencyGenerator getDependencyGenerator()
ITool
null
in which case, the receiver
should assume that the tool does not require dependency information
when the project is built.
getDependencyGenerator
in interface ITool
public IManagedDependencyGeneratorType getDependencyGeneratorForExtension(java.lang.String sourceExt)
ITool
null
in which case, the receiver
should assume that the tool does not require dependency information
when the project is built.
getDependencyGeneratorForExtension
in interface ITool
sourceExt
- source file extension
public int getNatureFilter()
ITool
getNatureFilter
in interface ITool
public java.lang.String[] getAllOutputExtensions(org.eclipse.core.resources.IProject project)
public java.lang.String[] getAllOutputExtensions()
ITool
null
.
getAllOutputExtensions
in interface ITool
public java.lang.String[] getOutputExtensions()
ITool
getOutputExtensions
in interface ITool
String[]
of extensionspublic java.lang.String[] getOutputsAttribute()
ITool
getOutputsAttribute
in interface ITool
String[]
of extensionspublic java.lang.String getOutputExtension(java.lang.String inputExtension)
ITool
null
if the tool does not understand that extension.
getOutputExtension
in interface ITool
inputExtension
- The extension of the source file.
public IOutputType getOutputType(java.lang.String outputExtension)
ITool
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.
getOutputType
in interface ITool
outputExtension
- File extension
IOutputType
public void setErrorParserIds(java.lang.String ids)
ITool
setErrorParserIds
in interface ITool
public boolean setToolCommand(java.lang.String cmd)
ITool
setToolCommand
in interface ITool
true
, then the tool command was modifiedpublic void setCommandLinePattern(java.lang.String pattern)
ITool
setCommandLinePattern
in interface ITool
public void setOutputFlag(java.lang.String flag)
ITool
setOutputFlag
in interface ITool
public void setOutputPrefix(java.lang.String prefix)
ITool
setOutputPrefix
in interface ITool
#setOutputPrefixForPrimaryOutput(String)}
public void setOutputPrefixForPrimaryOutput(java.lang.String prefix)
setOutputPrefixForPrimaryOutput
in interface ITool
public void setOutputsAttribute(java.lang.String ext)
ITool
setOutputsAttribute
in interface ITool
public void setAdvancedInputCategory(boolean b)
ITool
setAdvancedInputCategory
in interface ITool
public void setCustomBuildStep(boolean b)
ITool
setCustomBuildStep
in interface ITool
public void setAnnouncement(java.lang.String newText)
ITool
setAnnouncement
in interface ITool
public java.lang.String[] getCommandFlags() throws BuildException
ITool
getCommandFlags
in interface ITool
BuildException
public java.lang.String getToolFlags() throws BuildException
ITool
getToolFlags
in interface ITool
BuildException
public java.lang.String[] getToolCommandFlags(org.eclipse.core.runtime.IPath inputFileLocation, org.eclipse.core.runtime.IPath outputFileLocation, org.eclipse.cdt.utils.cdtvariables.SupplierBasedCdtVariableSubstitutor macroSubstitutor, IMacroContextInfoProvider provider) throws BuildException
inputFileLocation
- outputFileLocation
- macroSubstitutor
-
BuildException
public java.lang.String[] getToolCommandFlags(org.eclipse.core.runtime.IPath inputFileLocation, org.eclipse.core.runtime.IPath outputFileLocation) throws BuildException
ITool
getToolCommandFlags
in interface ITool
BuildException
public java.lang.String getToolCommandFlagsString(org.eclipse.core.runtime.IPath inputFileLocation, org.eclipse.core.runtime.IPath outputFileLocation) throws BuildException
ITool
getToolCommandFlagsString
in interface ITool
BuildException
public boolean isHeaderFile(java.lang.String ext)
ITool
true
if the tool considers the file extension to be
one associated with a header file.
isHeaderFile
in interface ITool
ext
- file extension of the source
public boolean buildsFileType(java.lang.String extension)
ITool
true
if the receiver builds files with the
specified extension, else false
.
buildsFileType
in interface ITool
extension
- file extension of the source
public boolean isInputFileType(java.lang.String extension)
ITool
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.
isInputFileType
in interface ITool
extension
- file extension of the source
public boolean producesFileType(java.lang.String extension)
ITool
true
if the receiver builds a file with the extension specified
in the argument, else false
.
producesFileType
in interface ITool
extension
- extension of the file being produced by a tool
public org.eclipse.core.runtime.IConfigurationElement getPathconverterElement()
public IOptionPathConverter getOptionPathConverter()
ITool
getOptionPathConverter
in interface ITool
public boolean isExtensionElement()
ITool
true
if this tool was loaded from a manifest file,
and false
if it was loaded from a project (.cdtbuild) file.
isExtensionElement
in interface ITool
isExtensionElement
in class HoldsOptions
public boolean isDirty()
IOptionCategory
true
if this element has changes that need to
be saved in the project file, else false
.
isDirty
in interface IOptionCategory
isDirty
in interface ITool
public void setDirty(boolean isDirty)
IOptionCategory
setDirty
in interface IOptionCategory
setDirty
in interface ITool
public void resolveReferences()
public java.lang.String evaluateCommand(java.lang.String command, java.lang.String values)
public java.lang.String getConvertToId()
ITool
getConvertToId
in interface ITool
public void setConvertToId(java.lang.String convertToId)
ITool
setConvertToId
in interface ITool
public java.lang.String getVersionsSupported()
ITool
getVersionsSupported
in interface ITool
public void setVersionsSupported(java.lang.String versionsSupported)
ITool
setVersionsSupported
in interface ITool
public IEnvVarBuildPath[] getEnvVarBuildPaths()
ITool
getEnvVarBuildPaths
in interface ITool
public void checkForMigrationSupport()
public org.eclipse.core.runtime.IConfigurationElement getPreviousMbsVersionConversionElement()
public org.eclipse.core.runtime.IConfigurationElement getCurrentMbsVersionConversionElement()
public org.eclipse.core.resources.IProject getProject()
public java.lang.String[] getContentTypeFileSpecs(org.eclipse.core.runtime.content.IContentType type)
public java.lang.String[] getContentTypeFileSpecs(org.eclipse.core.runtime.content.IContentType type, org.eclipse.core.resources.IProject project)
public boolean needsRebuild()
IHoldsOptions
needsRebuild
in interface IHoldsOptions
needsRebuild
in class HoldsOptions
public void setRebuildState(boolean rebuild)
IHoldsOptions
setRebuildState
in interface IHoldsOptions
setRebuildState
in class HoldsOptions
public org.eclipse.cdt.core.settings.model.extension.CLanguageData getCLanguageData(IInputType type)
getCLanguageData
in interface ITool
public boolean supportsLanguageSettings()
public org.eclipse.cdt.core.settings.model.extension.CLanguageData[] getCLanguageDatas()
getCLanguageDatas
in interface ITool
public IInputType getInputTypeForCLanguageData(org.eclipse.cdt.core.settings.model.extension.CLanguageData data)
getInputTypeForCLanguageData
in interface ITool
public IResourceInfo getParentResourceInfo()
getParentResourceInfo
in interface ITool
public IInputType getEdtableInputType(IInputType base)
getEdtableInputType
in interface ITool
public IOutputType getEdtableOutputType(IOutputType base)
getEdtableOutputType
in interface ITool
public boolean supportsType(IBuildPropertyType type)
supportsType
in class HoldsOptions
public boolean supportsType(java.lang.String type)
supportsType
in interface IBuildPropertiesRestriction
supportsType
in class HoldsOptions
public boolean supportsValue(java.lang.String type, java.lang.String value)
supportsValue
in interface IBuildPropertiesRestriction
supportsValue
in class HoldsOptions
public boolean supportsValue(IBuildPropertyType type, IBuildPropertyValue value)
supportsValue
in class HoldsOptions
public void propertiesChanged()
propertiesChanged
in interface IBuildPropertyChangeListener
propertiesChanged
in class HoldsOptions
public BooleanExpressionApplicabilityCalculator getBooleanExpressionCalculator()
public boolean isEnabled()
isEnabled
in interface ITool
public boolean isEnabled(IResourceInfo rcInfo)
public boolean matches(ITool tool)
matches
in interface ITool
public boolean supportsBuild(boolean managed)
supportsBuild
in interface ITool
public java.lang.Object getMatchKey()
getMatchKey
in interface IMatchKeyProvider
public void setIdenticalList(java.util.List list)
setIdenticalList
in interface IMatchKeyProvider
public java.lang.String getNameAndVersion()
public org.eclipse.core.runtime.IConfigurationElement getConverterModificationElement(ITool toTool)
public java.util.List getIdenticalList()
getIdenticalList
in interface IMatchKeyProvider
public java.lang.String[] getRequiredTypeIds()
getRequiredTypeIds
in interface IBuildPropertiesRestriction
getRequiredTypeIds
in class HoldsOptions
public java.lang.String[] getSupportedTypeIds()
getSupportedTypeIds
in interface IBuildPropertiesRestriction
getSupportedTypeIds
in class HoldsOptions
public java.lang.String[] getSupportedValueIds(java.lang.String typeId)
getSupportedValueIds
in interface IBuildPropertiesRestriction
getSupportedValueIds
in class HoldsOptions
public boolean requiresType(java.lang.String typeId)
requiresType
in interface IBuildPropertiesRestriction
requiresType
in class HoldsOptions
public void resetErrorParsers()
public void setErrorParserList(java.lang.String[] ids)
public boolean isSystemObject()
isSystemObject
in interface ITool
public java.lang.String getUniqueRealName()
getUniqueRealName
in interface ITool
public boolean hasScannerConfigSettings(IInputType type)
public CfgDiscoveredPathManager.PathInfoCache setDiscoveredPathInfo(IInputType type, CfgDiscoveredPathManager.PathInfoCache info)
public CfgDiscoveredPathManager.PathInfoCache getDiscoveredPathInfo(IInputType type)
public CfgDiscoveredPathManager.PathInfoCache clearDiscoveredPathInfo(IInputType type)
public void clearAllDiscoveredPathInfo()
public void clearAllDiscoveredInfo()
public java.lang.String getDiscoveryProfileIdAttribute()
public java.lang.String getDiscoveryProfileId()
public boolean hasCustomSettings(Tool tool)
public IOption[] getOptionsOfType(int type)
public void filterValues(int type, java.util.List values)
public int compareTo(java.lang.Object o)
compareTo
in interface java.lang.Comparable
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |