Managed Build Definitions

Identifier:

Since:

Description:

Configuration Markup:

<!ELEMENT extension (projectType* , configuration* , toolChain* , tool* , targetPlatform* , builder* , dynamicElementProvider* , managedBuildRevision? , buildDefinitionStartup*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>

<!ELEMENT projectType (configuration*)>

<!ATTLIST projectType

id                         CDATA #REQUIRED

name                       CDATA #IMPLIED

superClass                 CDATA #IMPLIED

isAbstract                 (true | false) "false"

unusedChildren             CDATA #IMPLIED

isTest                     (true | false)

projectEnvironmentSupplier CDATA #IMPLIED

projectMacroSupplier       CDATA #IMPLIED

configurationNameProvider  CDATA #IMPLIED

convertToId                CDATA #IMPLIED

buildProperties            CDATA #IMPLIED

buildArtefactType          CDATA #IMPLIED>

Represents a class of project which acts as a template for the projects that the user will create, for example, a Linux static library. A project type contains a sequence of configurations. Project types are arranged in an inheritance hierarchy where a project type inherits the list of configurations from it's parent and can add to or override configurations in this list.

• id - Used by the build model to uniquely identify the project type.
• name - A human-readable project type name, such as 'Executable'. This will be the name the user sees displayed in the UI.
• superClass - The id of a projectType that this projectType is derived from.
• isAbstract - An optional field that flags a project type as abstract. If true, the project type will not appear in the UI. The project type is used by other project types as their "superclass". The default value is false.
• unusedChildren - A semi-colon separated list of child IDs of the superclass' children that should not be automatically inherited by this element. Note: This attribute is not yet implemented.
• isTest - An optional field that flags a project type as test-only. If true, the project type will not appear in the UI. The project type can be manipulated programmatically in JUnit tests, for example. The default value is false.
• projectEnvironmentSupplier - Specifies the name of the class that implements IProjectEnvironmentVariableSupplier in order to provide project level environment variables.
• projectMacroSupplier - Specifies the name of the class that implements IProjectBuildMacroSupplier in order to provide project level build macros.
• configurationNameProvider - Contains the name of a class that implements an interface with a method for returning a default name for a configuration. The configuration names in a user's project must be unique. A projectType can contain configuration children with the same name. In this case, a configurationNameProvider must be specified to make the names unique before they are displayed to the user in the New Project and New Configuration dialog boxes.
• convertToId - The identifier of a projectType, that project types loaded using this definition should be converted to. MBS will invoke a proper converter.
• buildProperties - Specifies the comma-separated list of build property type - value pairs to be applied for all configurations of this project type. property type-value pairs are specified in the type_id=value_id format.
• buildArtefactType - the attribute specified the Build Artefact Type. can contain the value id of the "org.eclipse.cdt.build.core.buildArtefactType" build property. Default values contributed with the build system are "org.eclipse.cdt.build.core.buildArtefactType.exe" - represents executable, "org.eclipse.cdt.build.core.buildArtefactType.staticLib" - represents static library, "org.eclipse.cdt.build.core.buildArtefactType.sharedLib" - represents dynamic library Custom values can be contributed via the "org.eclipse.cdt.managedbuilder.core.buildProperties" extension point. See the description of that extension point for more detail. Specifying this attribute is fully equivalent to specifying the "org.eclipse.cdt.build.core.buildArtefactType" via tne buildProperties attribute. The buildArtefactType attribute, the "buildArtefactType" attribute value takes precedence over the artefact type specified via the "buildProperties" attribute

<!ELEMENT project (configuration+)>

<!ATTLIST project

name        CDATA #REQUIRED

projectType CDATA #REQUIRED>

The project element is an instance of a projectType element. It appears in the .cdtbuild file, not in an extension definition.

• name - The name of the project that the user sees displayed in the UI. This is the name that the user entered in the New Project wizard.
• projectType - The id of the projectType that this project is an instance of.

<!ELEMENT configuration (toolChain? , resourceConfiguration* , enablement* , folderInfo* , fileInfo*)>

<!ATTLIST configuration

id                        CDATA #REQUIRED

name                      CDATA #IMPLIED

parent                    CDATA #IMPLIED

artifactName              CDATA #IMPLIED

artifactExtension         CDATA #IMPLIED

cleanCommand              CDATA #IMPLIED

errorParsers              CDATA #IMPLIED

languageSettingsProviders CDATA #IMPLIED

prebuildStep              CDATA #IMPLIED

postbuildStep             CDATA #IMPLIED

preannouncebuildStep      CDATA #IMPLIED

postannouncebuildStep     CDATA #IMPLIED

description               CDATA #IMPLIED

buildProperties           CDATA #IMPLIED

buildArtefactType         CDATA #IMPLIED>

A configuration is used to gather together certain default tools and options to build project a certain way. For example, a "Debug" configuration might supply tools with the options set to build with debugging symbols, whereas a "Release" configuration would supply tools with options set to create the best performance.

• id - Unique identifier for the configuration.
• name - A descriptive name for the configuration to be used in the UI.
• parent - The configuration that this configuration was cloned from.
• artifactName - This is the name of the final build artifact associated with the configuration. The user will specify this is the UI, so there is no need to supply a default value.
• artifactExtension - This is the extension that will be applied (if necessary) to any build artifact created by the configuration.
• cleanCommand - This attribute maintains the command that removes the intermediate and output files for a particular configuration. For example, on POSIX platforms like Linuc, Solaris, or Cygwin, the command would be rm -rf whereas on Win32 platforms it would be del /F /S /Q
• errorParsers - The semi-colon separated list of the default error parsers to be used with this configuration. The list is ordered with the first error parser on the list invoked first, the second error parser second, and so on. The list may contain the error parsers defined by CDT and/or other installed error parser extensions. The list of error parsers to be used may be changed by the user on a per-configuration basis. When specified, this overrides the tool-chain errorParsers attribute.
• languageSettingsProviders - Semicolon-separated list of providers ID implementing ILanguageSettingProvider interface. This field could be amended with toolchain-level providers list by using ${Toolchain} keyword. Provider ID can be prefixed with "-" which will cause id to be removed from the preceeding list including providers defined with ${Toolchain} keyword. If this field is not specified, "org.eclipse.cdt.managedbuilder.core.MBSLanguageSettingsProvider" (MBS Language Settings Provider) is used by default.
• prebuildStep - Specifies the pre-build command, which runs prior to the standard MBS build.
• postbuildStep - Specifies the post-build command, which runs after the standard MBS build.
• preannouncebuildStep - Specifies the string to be displayed when the pre-build command step is run.
• postannouncebuildStep - Specifies the string to be displayed when the post-build command step is run.
• description - Specifies the description of the configuration that will be displayed to the user while creating a project and managing configurations. The description is only displayed in the UI - it is not considered to be part of the configuration name.
• buildProperties - Specifies the comma-separated list of build property type - value pairs defined for this configuration. property type-value pairs are specified in the type_id=value_id format.
• buildArtefactType - the attribute specified the Build Artefact Type. can contain the value id of the "org.eclipse.cdt.build.core.buildArtefactType" build property. Default values contributed with the build system are "org.eclipse.cdt.build.core.buildArtefactType.exe" - represents executable, "org.eclipse.cdt.build.core.buildArtefactType.staticLib" - represents static library, "org.eclipse.cdt.build.core.buildArtefactType.sharedLib" - represents dynamic library Custom values can be contributed via the "org.eclipse.cdt.managedbuilder.core.buildProperties" extension point. See the description of that extension point for more detail. Specifying this attribute is fully equivalent to specifying the "org.eclipse.cdt.build.core.buildArtefactType" via tne buildProperties attribute. The buildArtefactType attribute, the "buildArtefactType" attribute value takes precedence over the artefact type specified via the "buildProperties" attribute

<!ELEMENT toolChain (tool* , targetPlatform? , builder? , optionCategory* , option* , supportedProperties?)>

<!ATTLIST toolChain

id                               CDATA #REQUIRED

name                             CDATA #IMPLIED

superClass                       CDATA #IMPLIED

isAbstract                       (true | false) "false"

unusedChildren                   CDATA #IMPLIED

osList                           CDATA #IMPLIED

archList                         CDATA #IMPLIED

errorParsers                     CDATA #IMPLIED

languageSettingsProviders        CDATA #IMPLIED

scannerConfigDiscoveryProfileId  CDATA #IMPLIED

targetTool                       CDATA #IMPLIED

secondaryOutputs                 CDATA #IMPLIED

isToolChainSupported             CDATA #IMPLIED

configurationEnvironmentSupplier CDATA #IMPLIED

configurationMacroSupplier       CDATA #IMPLIED

versionsSupported                CDATA #IMPLIED

convertToId                      CDATA #IMPLIED

optionPathConverter              CDATA #IMPLIED

supportsManagedBuild             (true | false)

isSystem                         (true | false) >

A tool-integrator-defined, ordered set of tools that tranform the project's resources into the project's outputs. A tool-chain can be defined as part of a configuration, or as an independent specification that is referenced from a separate configuration via the tool-chain superClass attribute.

• id - Unique identifier for the tool-chain.
• name - A descriptive name for the tool-chain to be used in the UI.
• superClass - The id of a toolChain that this toolChain is derived from.
• isAbstract - An optional field that flags a tool-chain as abstract. An abstract tool-chain must be defined as a top level object in the model definition and cannot be selected by the user in the UI, but tool-chains derived from this tool-chain will inherit its attributes and children. The default is false.
• unusedChildren - A semi-colon separated list of child IDs of the superclass' children that should not be automatically inherited by this element. Note: This attribute is not yet implemented.
• osList - This field lists the host operating systems on which the tool-chain runs and is used by the managed build system to decide when the tool-chain is applicable. The value should be a comma-separated list. Valid values are the strings returned by the Eclipse API Platform.getOS() and include strings like "win32", "linux", "solaris", "hpux", "aix". Do not specify this attribute or specify "all" to allow all host operating systems.
• archList - This field lists the host architectures on which the tool-chain runs and is used by the managed build system to decide when the tool-chain is applicable. The value should be a comma-separated list. Valid values are the strings returned by the Eclipse API Platform.getOSArch() and include strings like "ia32". Do not specify this attribute or specify "all" to allow all host architectures.
• errorParsers - The semi-colon separated list of the default error parsers to be used with this tool-chain. The list is ordered with the first error parser on the list invoked first, the second error parser second, and so on. The list may contain the error parsers defined by CDT and/or other installed error parser extensions. When specified, this overrides the tool errorParsers attributes of the tool children of the tool-chain and the builder child of the tool-chain.
• languageSettingsProviders - Semicolon-separated list of providers ID implementing ILanguageSettingProvider interface. This list could be adjusted on configuration level in the corresponding attribute.
• scannerConfigDiscoveryProfileId - Specifies an id of scanner configuration discovery profile for gathering the built-in compiler settings for a toolchain.
• targetTool - Specifies a semi-colon separated list of the Tool(s) that can create the final build artifact (the end target of the build). The first tool found in the configuration is used. A list is needed, for example, when a tool-chain has different tools for different project natures.
• secondaryOutputs - A semi-colon separated list of IDs of other outputTypes, besides the primary outputType of the targetTool, that are also considered to be build artifacts. The build file generator will ensure that the outputs get built.
• isToolChainSupported - Specifies the name of the class that implements IManagedIsToolChainSupported. This provides a method to be called to determine if support for the tool-chain is currently installed on the system. MBS uses this information in order to filter the choices presented to the CDT user and to inform the user when support needed by their project is not installed. If the isToolChainSupported callback is not provided by the tool-chain definition, the tool-chain is treated as supported. If all configurations defined for the given project type are not supported the project type is treated as unsupported.
• configurationEnvironmentSupplier - Specifies the name of the class that implements IConfigurationEnvironmentVariableSupplier in order to provide configuration level environment variables.
• configurationMacroSupplier - Specifies the name of the class that implements IConfigurationBuildMacroSupplier in order to provide configuration level build macros.
• versionsSupported - Specifies a comma delimited list of versions of this tool-chain that can be loaded without invoking a converter.
• convertToId - The identifier of a tool-chain, that tool-chains loaded using this definition should be converted to. MBS will invoke a proper converter.
• optionPathConverter - Toolchains like Cygwin based Gnu tools can accept paths which are not valid for the OS platform. E.g. "/usr/include" is well difined for a Cygwin gcc compiler while it is not a meaningful path for a java.io.File. Therefore toolchains can specify a pathConverter which will be applied to include and library paths configured in the Managed Build System. The pathConverter of a toolchain applies for all tools of the toolchain except if a tool defines it's own pathConverter. In this case the pathConverter supplied by the toolchain is ignored.
• supportsManagedBuild - Specifies whether or not the tool-chain supports managed build. Default value is true.
• isSystem - the system elements are used by the system for specific needs and are not displayed in UI

<!ELEMENT resourceConfiguration (tool+)>

<!ATTLIST resourceConfiguration

resourcePath      CDATA #REQUIRED

exclude           (true | false)

rcbsApplicability (before|after|override|disable)

toolsToInvoke     CDATA #IMPLIED>

A place to store build attributes of individual resources that are different from the configuration as a whole.

• resourcePath - The path of the project resource to which this element applies.
• exclude - Specifies whether the resource is excluded from building in the parent configuration. The default is false. The resourceConfiguration element retains its tool children, if any exist, even when excluded from the build.
• rcbsApplicability - Identifies how the user desires to apply a resource custom build step: 1. Apply rcbs tool before any other tools defined for the resource. 2. Apply rcbs tool after any other tools defined for the resource. 3. Apply rcbs tool overriding any other tools defined for the resource. 4. Disable (don't apply) the rcbs tool.
• toolsToInvoke - Identifies which tools to invoke by a semicolon separated list of child tool ids. Applies as follows: 1. Defaults to all tools in the order found 2. Use specified ordered list of children to invoke 3. If empty string, treat as if no resource configuration existed, i.e., use project level tool.

<!ELEMENT tool (option* , optionCategory* , inputType* , outputType* , envVarBuildPath* , enablement* , supportedProperties?)>

<!ATTLIST tool

id                    CDATA #REQUIRED

name                  CDATA #IMPLIED

superClass            CDATA #IMPLIED

isAbstract            (true | false) "false"

unusedChildren        CDATA #IMPLIED

sources               CDATA #IMPLIED

headerExtensions      CDATA #IMPLIED

outputs               CDATA #IMPLIED

outputFlag            CDATA #IMPLIED

outputPrefix          CDATA #IMPLIED

natureFilter          (cnature|ccnature|both)

command               CDATA #IMPLIED

commandLinePattern    CDATA #IMPLIED

commandLineGenerator  CDATA #IMPLIED

dependencyCalculator  CDATA #IMPLIED

errorParsers          CDATA #IMPLIED

advancedInputCategory (true | false)

customBuildStep       (true | false)

announcement          CDATA #IMPLIED

icon                  CDATA #IMPLIED

versionsSupported     CDATA #IMPLIED

convertToId           CDATA #IMPLIED

optionPathConverter   CDATA #IMPLIED

supportsManagedBuild  (true | false)

isSystem              (true | false)

isHidden              (true | false) >

Defines a tool used in the build process.

• id - A unique identifier for the tool that will be used by the build model.
• name - Human-readable name for the tool to be used in the UI.
• superClass - The id of a tool that this tool is derived from.
• isAbstract - An optional field that flags a tool as abstract. An abstract tool must be defined as a top level object in the model definition and cannot be selected by the user in the UI, but tools derived from this tool will inherit its attributes and children. The default is false.
• unusedChildren - A semi-colon separated list of child IDs of the superclass' children that should not be automatically inherited by this element. Note: This attribute is not yet implemented.
• Deprecated sources - Deprecated - use the InputType element.
• Deprecated headerExtensions - Deprecated - use the InputType element.
• Deprecated outputs - Deprecated - use the OutputType element.
• outputFlag - An optional flag for tools that allow users to specify a name for the artifact of the tool. For example, the GCC compiler and linker tools typically allow the user to specify the name of the output with the '-o' flag, whereas the archiver that creates libraries does not.
• Deprecated outputPrefix - Deprecated - use the OutputType element.
• natureFilter - Filters the display (and use) of the tool by the nature of the project. Selecting a value of 'cnature' insures that the tool will be displayed IFF there is a cnature associated with the project. A ccnature will filter this tool out. If 'ccnature' is selected, the tool will only be available for C++ projects. If 'both' is selected, the tool will be displayed when either nature is present. This attribute is required if it is not inherited from its superClass. The default value is "both".
• command - The command that invokes the tool. For example, gcc for the Gnu C compiler, or g++ for the Gnu C++ compiler. This attribute supports MBS file context macros.
• commandLinePattern - Specifies the command "pattern" that indicates how the parts of the command line are used to create the entire command line. The pattern consists of the replaceable variables COMMAND, FLAGS, OUTPUT_FLAG, OUTPUT_PREFIX, OUTPUT and INPUTS. The default command line pattern is ${COMMAND} ${FLAGS} ${OUTPUT_FLAG}${OUTPUT_PREFIX}${OUTPUT} ${INPUTS}, except when customBuildStep is true, where the default is $(COMMAND). White space and other characters are significant and are copied to the generated command. This attribute supports MBS file context macros.
• commandLineGenerator - Specifies the name of the class that implements IManagedCommandLineGenerator in order to provide custom command line generation logic.
• Deprecated dependencyCalculator - Deprecated - use the InputType element.
• errorParsers - Specifies the default list of error parsers used by the tool. Error parsers specified by the tool are added to this list specified by the tool-chain when a project resource is defined to use the tool. It is automatically removed when there are no more project resources using the tool. It is an ordered, semi-colon separated list of parser IDs. The order specifies the order in which the error parsers are invoked during a build.
• advancedInputCategory - Specifies whether the Tool wants the MBS to display the Advanced Input category with the Tool's property categories. This allows the user to specify input order and additional inputs. The default is false. Note: This attribute is not yet implemented
• customBuildStep - Specifies whether this Tool represents a user-define custom build step. The default is false. When True, the default value of the commandLinePattern attribute changes to "$(command)".
• announcement - Specifies a string that is written to the build output prior to each invocation of the tool. The default value is "Invoking tool-name (tool-id)..."
• icon - Path to a 16x16 pixel big icon that is to be displayed instead of the default icon. The path is relative to the plug-in directory which defines .buildDefinitions.
• versionsSupported - Specifies a comma delimited list of versions of this tool that can be loaded without invoking a converter.
• convertToId - The identifier of a tool, that tools loaded using this definition should be converted to. MBS will invoke a proper converter.
• optionPathConverter - Tools like Cygwin based Gnu tools can accept paths which are not valid for the OS platform. E.g. "/usr/include" is well difined for a Cygwin gcc compiler while it is not a meaningful path for a java.io.File. Therefore tools can specify a pathConverter which will be applied to include and library paths configured in the Managed Build System.
• supportsManagedBuild - Specifies whether or not the tool supports managed build. Default value is true.
• isSystem - the system elements are used by the system for specific needs and are not displayed in UI
• isHidden - Specifies whether or not the tool is hidden within the setting tab of the user interface. This attribute should be set to true when a tool is internal to the toolchain and options cannot be changed by the user. Default value is false.

<!ELEMENT inputType (inputOrder* , additionalInput* , enablement*)>

<!ATTLIST inputType

id                              CDATA #REQUIRED

name                            CDATA #IMPLIED

superClass                      CDATA #IMPLIED

sourceContentType               CDATA #IMPLIED

sources                         CDATA #IMPLIED

dependencyContentType           CDATA #IMPLIED

dependencyExtensions            CDATA #IMPLIED

option                          CDATA #IMPLIED

assignToOption                  CDATA #IMPLIED

multipleOfType                  (true | false)

primaryInput                    (true | false)

dependencyCalculator            CDATA #IMPLIED

buildVariable                   CDATA #IMPLIED

scannerConfigDiscoveryProfileId CDATA #IMPLIED

languageId                      CDATA #IMPLIED

languageInfoCalculator          CDATA #IMPLIED>

Defines a type of input for the tool. Note that the calculated dependencies of an input type are not described by a separate input type, but are described by attributes of this element.

• id - A unique identifier for the input-type that will be used by the build model.
• name - The name of the input type that is displayed to the user in the UI.
• superClass - The id of an input-type that this input-type is derived from.
• sourceContentType - The id of an Eclipse content type that describes this type of input. Either this attribute or the sources attribute must be specified by this element or a superclass. If both are specified, and the content type specified here is defined by Eclipse, the sources attribute is not used.
• sources - A comma-separated list of file extensions that identify files of this input type. Note that the user will not be able to modify the set of file extensions as they can when sourceContentType is specified.
• dependencyContentType - The id of an Eclipse content type that describes the calculated dependencies for this type of input. If dependencyExtensions is also specified, and the content type specified here is defined by Eclipse, the dependencyExtensions attribute is not used.
• dependencyExtensions - A comma-separated list of file extensions that are used for calculated dependencies of this input-type. Note that the user will not be able to modify the set of file extensions as they can when dependencyContentType is specified.
• option - The id of an Option element that is used on the command line to identify inputs of this type. If specified, the name(s) of the input files for this input type are taken from the value specified for the option.
• assignToOption - The id of an Option element whose value is to be assigned to the file(s) calculated for this input type. The default is not to assign the input file(s) to a command line option but to assign the files to the ${Inputs} part of the command line. Note that the option value is only updated during build file generation and therefore could be out of sync with the project until build file generation occurs.
• multipleOfType - Specifies whether all inputs of this type are used in one invocation of the tool. The inputs can be project resources, and the outputs of other Tools in the Tool-chain. The default is false.
• primaryInput - Specifies whether this is considered the primary input of the tool. The default is false.
• dependencyCalculator - Specifies the class that provides the source file dependency calculation for this input-type. You can replace the default calculator with a class that implements the IManagedDependencyGenerator interface.
• buildVariable - A variable used in the build file to represent the input files. The same variable name can be used in an outputType element to identify a set of output files that contribute to this tool's input. This attribute is ignored when multipleOfType is false and this is the primary input of the tool. The default name is chosen by MBS.
• scannerConfigDiscoveryProfileId - Specifies an id of scanner configuration discovery profile for gathering the built-in compiler settings for resource type presented with this input type.
• languageId - Represents the language id, i.e. the id of language defined via the org.eclipse.cdt.core.language extension point The value of this attribute is used only in case languageInfoCalculator is not specified
• languageInfoCalculator - Specifies the name of the class that implements org.eclipse.cdt.managedbuilder.core.ILanguageInfoCalculator for dinamic providing the language id info. Overrides language id specified with the languageId attribute.

<!ELEMENT inputOrder EMPTY>

<!ATTLIST inputOrder

path     CDATA #REQUIRED

order    CDATA #IMPLIED

excluded (true | false) >

Describes optional, ordering, information regarding the inputs of an inputType. Note: This element is not yet implemented

• path - Defines the relative or absolute path of the resource to which this element applies. The resource must be a member of the project, or the output from another tool in the tool-chain.
• order - A comma-separated list of integer values that specify the input order of this resource. In most cases, a single value is used. A list is used if the same input resource appears multiple times in the input list. The order number begins at 1. All unordered input resources fill the first gap in the specified order values.
• excluded - If True, this input resource is not used as an input to the tool.

<!ELEMENT additionalInput EMPTY>

<!ATTLIST additionalInput

paths CDATA #REQUIRED

kind  (additionalinput|additionalinputdependency|additionaldependency) >

Describes optional information regarding additional inputs and/or dependencies.

• paths - Defines a semi-colon delimited list of relative or absolute paths of the resource to which this element applies. The resources must be a member of the project, the output from another tool in the tool-chain, or an external file. The file name of the path can use GNU Make pattern rule syntax in order to generate the name from the filename of the input file.
• kind - Defines the type of additional input, whether the resource is added to the dependency list, the inputs on the command line, or both. The default is to add the inputs to both.

<!ELEMENT outputType (enablement*)>

<!ATTLIST outputType

id                CDATA #REQUIRED

name              CDATA #IMPLIED

superClass        CDATA #IMPLIED

outputContentType CDATA #IMPLIED

outputs           CDATA #IMPLIED

option            CDATA #IMPLIED

multipleOfType    (true | false)

primaryInputType  CDATA #IMPLIED

primaryOutput     (true | false)

outputPrefix      CDATA #IMPLIED

outputNames       CDATA #IMPLIED

namePattern       CDATA #IMPLIED

nameProvider      CDATA #IMPLIED

buildVariable     CDATA #IMPLIED>

Defines a type of output for the tool.

• id - A unique identifier for the output-type that will be used by the build model.
• name - The name of the output type that is displayed to the user in the UI.
• superClass - The id of an output-type that this output-type is derived from.
• outputContentType - The id of an Eclipse content type that describes this type of output. Either this attribute or the outputs attribute must be specified by this element or a superclass. If both are specified, and the content type specified here is defined by Eclipse, the outputs attribute is not used.
• outputs - A comma-separated list of file extensions that identify files of this output type. Note that the user will not be able to modify the set of file extensions as they can when outputContentType is specified.
• option - The id of an Option element that is used on the command line to specify this output. The default is to use the Tool outputFlag attribute if primaryOutput is True. If option is not specified, and primaryOutput is False, then the output file(s) of this outputType are not added to the command line. If specified, the nameProvider, namePattern and outputNames are ignored.
• multipleOfType - Specifies whether multiple outputs of this type are created by one invocation of the tool. The default is False. If True, the nameProvider attribute or outputNames attribute must be specified.
• primaryInputType - The id of the input type that is used in determining the build "rules" for the output type and for the default name of the output file. The default is the input type with primaryInput == true.
• primaryOutput - Specifies whether this is the primary output of the tool. The default is False.
• outputPrefix - Some tools produce files with a special prefix that must be specified. For example, a librarian on POSIX systems expects the output to be libtarget.a, so 'lib' would be the prefix. The default is to use the Tool "outputPrefix" attribute if primaryOutput is True, otherwise the default is an empty string. This attribute supports MBS configuration context macros.
• outputNames - A semi-colon delimited list of the complete set of output file names generated for this outputType. If specified, the namePattern is ignored. This attribute supports MBS file context macros.
• namePattern - Specifies a pattern, using the Gnu Make pattern rule syntax, for deriving the output resource name from the input resource name. The default, "%" is to use the input resource base name with the first output extension.
• nameProvider - The name of the class that implements the IManagedOutputNameProvider interface. If specified, the outputNames and namePattern are ignored. When multipleOfType is true, this attribute, or the outputNames attribute, is required in order for MBS to know the names of the output files.
• buildVariable - A variable used in the build file to represent the output file(s). The same variable name can be used in an inputType element to identify a set of output files that contribute to a tool's input. The default name is chosen by MBS.

<!ELEMENT optionCategory (enablement*)>

<!ATTLIST optionCategory

id                      CDATA #REQUIRED

name                    CDATA #REQUIRED

owner                   CDATA #IMPLIED

icon                    CDATA #IMPLIED

applicabilityCalculator CDATA #IMPLIED>

An optional, but useful, mechanism for grouping options together.

• id - Used by the build model to uniquely identify the option category.
• name - A human-readable category name, such as 'Preprocessor Options'. This will be the name the user sees displayed in the UI.
• owner - Option categories can belong to a tool, a toolChain or be nested inside other option categories. This is the ID of the owner of the category. The default owner if the parent tool or tool-chain.
• icon - Path to a 16x16 pixel big icon that is to be displayed instead of the default icon. The path is relative to the plug-in directory which defines .buildDefinitions.
• applicabilityCalculator - Optional class which is used to determine dynamically at runtime whether the option category is visible. This class must implement the IOptionCategoryApplicability interface. If no calculator is specified then the option category is always visible.

<!ELEMENT option ((listOptionValue* | enumeratedOptionValue* | treeOptionRoot?) , enablement*)>

<!ATTLIST option

id                          CDATA #REQUIRED

name                        CDATA #IMPLIED

superClass                  CDATA #IMPLIED

isAbstract                  (true | false) "false"

unusedChildren              CDATA #IMPLIED

category                    CDATA #IMPLIED

resourceFilter              (project|file|all) "all"

valueType                   (string|stringList|boolean|enumerated|includePath|definedSymbols|libs|userObjs|symbolFiles|includeFiles|libPaths|libFiles|undefIncludePath|undefDefinedSymbols|undefLibPaths|undefLibFiles|undefIncludeFiles|undefSymbolFiles|tree) "string"

browseType                  (none|file|directory)

browseFilterPath            CDATA #IMPLIED

browseFilterExtensions      CDATA #IMPLIED

value                       CDATA #IMPLIED

defaultValue                CDATA #IMPLIED

defaultValueGenerator       CDATA #IMPLIED

command                     CDATA #IMPLIED

commandGenerator            CDATA #IMPLIED

commandFalse                CDATA #IMPLIED

useByScannerDiscovery       (true | false)

excludeFromScannerDiscovery (true | false)

helpSupplier                CDATA #IMPLIED

tip                         CDATA #IMPLIED

contextId                   CDATA #IMPLIED

valueHandler                CDATA #IMPLIED

valueHandlerExtraArgument   CDATA #IMPLIED

applicabilityCalculator     CDATA #IMPLIED

contextId                   CDATA #IMPLIED

fieldEditor                 IDREF #IMPLIED

fieldEditorExtraArgument    CDATA #IMPLIED>

An option is associated with a tool. Options can contain boolean values, a simple text string, a selection from an enumerated list, or a list of values. Options also map the value they contain to a command-line flag, such as '-g' in the case of debugging symbol information for compilers. Options can also be associated with a toolchain. However in such a case the option must be contained in a optionCategory.

• id - A unique identifier for the option.
• name - A descriptive name for the option.
• superClass - The id of an option that this option is derived from.
• isAbstract - An optional field that flags an option as abstract. An abstract option must be defined as a top level object in the model definition and cannot be selected by the user in the UI, but options derived from this option will inherit its attributes and children. The default is false.
• unusedChildren - A semi-colon separated list of child IDs of the superclass' children that should not be automatically inherited by this element. Note: This attribute is not yet implemented.
• category - The id of the option category for this option. The id can be the id of the tool which is also a category. The default category is the parent tool. Note that an optionCategory id must be supplied as the value for an option that is a child of a toolChain.
• resourceFilter - Filters the display (and use) of the option by the type of the resource (currently Project or File). The value 'project' causes the option to be used when applied to a project. The value 'file' causes the option to be used when applied to a file. If 'all' is selected, the option applies to all types of resources. The default is "all".
• valueType - General options can be one of the following types; 'string' for catch-all entries for options that cannot be easily defined any other way, 'string list' for entries that consist of a list of values such as defined symbols or paths, 'boolean' for options that have two values, and 'enumerated' for options that are one-of a list of values. Additional special types exist to flag options of special relevance to the build model; 'include', 'libs', 'userObjs' and 'definedSymbols'. You can pre-populate with optionValues, and they will display in the UI the same way the 'stringList' options do. The build model will look specifically for these value types when clients query for include paths and preprocessor defines. The makefile generator treats the libs and userObjs entries differently than other stringLists.
• browseType - This value is used for string and stringlist (and related) options only. If you need a list option to prompt the user to browse for a file or directory when adding a new value, set the value of the attribute accordingly. By default the value is treated as no browsing needed.
• browseFilterPath - An optional value that specifies the default filter-path for the underlying file or directory browse-dialog. Macros in the value will be expanded. This attribute only applies when user chooses to browse the file-system.
• browseFilterExtensions - An optional value that specifies a comma-separated string of file-extension filters for the underlying file browse-dialog. For filters with multiple extensions, use semicolon as a separator - eg. "*.lib;*.a;*.cmd,*.*". This attribute only applies when user chooses to browse the file-system, and only when browseType is 'file'.
• value - Specifies the value assigned to the option by the end user or in a default configuration. For boolean values, specify truth using the string 'true'. All other strings will be treated as false.
• defaultValue - Specifies the default value for the option if the 'value' attribute is blank. For enumerated options the optionEnums will be searched for the default. For string list options, all defined optionValues will be treated as defaults. For boolean values, specify truth using the string 'true'. All other strings will be treated as false.
• defaultValueGenerator - Optional class which can be used to override the default value for an option. This class must implement the IOptionDefaultValueGenerator interface. If no generator is specified then the 'defaultValue' attribute is used to generate the option's default value.
• command - An optional value that specifies the actual command that will be passed to the tool on the command line. The attribute value provides a "pattern" for specifying where the option "value" should be placed for options of type string and stringlist. If no ${value} is specified in the command, the option value is appended to the end of the specified command.
• commandGenerator - Optional class which can be used to override the default command-generation logic for an option. This class must impelment the IOptionCommandGenerator interface. If no generator is specified then the 'comand' attribute is used to generate the option's command.
• commandFalse - An optional value, used only with options of type Boolean, that specifies the actual command that will be passed to the tool on the command line when the value of the Boolean option is False.
• useByScannerDiscovery - An optional field to allow the option additionally to be passed to scanner discovery of built-in compiler macros and paths in the ${FLAGS} variable. The default is false.
• excludeFromScannerDiscovery - An optional field to allow the option to be excluded from scanner discovery's ${ALL_FLAGS} variable. The default is false.
• Deprecated helpSupplier - This field is unused in 2.0
• tip - Specifies a "tip" that can be displayed in hover help or on the property page.
• contextId - specify a fully qualified context id for supplying context sensitive help for an option.
• valueHandler - The id of a class that implements the IManagedOptionValueHandler interface. This interface is used to dynamically manage the value of an option.
• valueHandlerExtraArgument - An optional extra text string that is passed into the valueHandler.
• applicabilityCalculator - Optional class which is used to determine dynamically at runtime whether the option is visible, enabled, and used in command line generation. This class must implement the IOptionApplicability interface. If no calculator is specified then the option is always visible, enabled, and used in command line generation.
• contextId - specify a fully qualified context id for supplying context sensitive help for an option.
• fieldEditor - Optional ID of the custom field-editor to represent this build-option in the project Properties dialog UI. If no custom field-editor ID is specified then the option will be represented by one of the built-in field-editors based on the option's valueType attribute. A custom field-editor needs to be registered, under the same ID, through the org.eclipse.cdt.managedbuilder.ui.buildDefinitionsUI extension-point's <fieldEditor> element.
• fieldEditorExtraArgument - An optional extra text string that is passed into the field-editor. Can be used to parameterize the field-editor instance.

<!ELEMENT enumeratedOptionValue (enablement*)>

<!ATTLIST enumeratedOptionValue

id        CDATA #REQUIRED

name      CDATA #REQUIRED

isDefault (true | false)

command   CDATA #IMPLIED>

Defines a single value of an enumerated option.

• id - Unique identifier for the option enumeration.
• name - A descriptive name for the enumeration.
• isDefault - Flags this enumerated value as the default to apply to the option if the user has not changed the setting.
• command - The command that the enumerated value translates to on the command line.

<!ELEMENT listOptionValue EMPTY>

<!ATTLIST listOptionValue

value   CDATA #REQUIRED

builtIn (true | false) >

A value for defining individual elements of a list option.

• value - The contents of the list item. The build model will apply the command defined in the option to each value in the list.
• builtIn - This attribute flags the list value as a built-in value as opposed to something the user has entered. Built-ins will not be passed to clients that generate command lines (like the makefile generator). However, clients that need to take these settings into account (like the indexing service), will receive these settings. These values will appear grey in the UI.

<!ELEMENT treeOption (treeOption)*>

<!ATTLIST treeOption

id          CDATA #REQUIRED

name        CDATA #REQUIRED

description CDATA #IMPLIED

command     CDATA #IMPLIED

isDefault   (true | false)

icon        CDATA #IMPLIED

order       CDATA #IMPLIED>

• id - The id should be the value used for determining which treeOption is selected, it has to be unique within the tree.
• name - Display name for the option
• description - Description of the option to be presented to the user
• command - The command that the tree value translates to on the command line.
• isDefault - Flags this tree value as the default to apply to the option if the user has not changed the setting.
• icon - An icon to be used for this node in the tree representation. Should use full path for the icon: e.g., platform:/plugin/org.eclipse.cdt/icons/wizard.png
• order - An integer representing the order of this option within its peers in the tree. The order is a relative number, were smaller numbers appear on top of larger numbers. If no order is defined a default order is assumed, see "org.eclipse.cdt.managedbuilder.core.IOption.ITreeOption.DEFAULT_ORDER" for more details.

<!ELEMENT treeOptionRoot (treeOption)+>

<!ATTLIST treeOptionRoot

id             CDATA #REQUIRED

name           CDATA #REQUIRED

icon           CDATA #IMPLIED

selectLeafOnly (true | false) >

Represents the root of a tree of options. Note that the root is never shown to the user and can't be selected. It is a place holder for settings affecting the options tree behavior

• id -
• name -
• icon - The tree root icon can be used in branding the UI representation of the tree. Should use full path for the icon: e.g., platform:/plugin/org.eclipse.cdt/icons/wizard.png
• selectLeafOnly - Determines whether this tree allows selecting categories as well as leaf nodes, or leaf nodes only. Default is true (leaf nodes only).

<!ELEMENT builder (option*)>

<!ATTLIST builder

id                           CDATA #REQUIRED

name                         CDATA #IMPLIED

superClass                   CDATA #IMPLIED

isAbstract                   (true | false) "false"

unusedChildren               CDATA #IMPLIED

command                      CDATA #IMPLIED

arguments                    CDATA #IMPLIED

buildfileGenerator           CDATA #IMPLIED

errorParsers                 CDATA #IMPLIED

variableFormat               CDATA #IMPLIED

isVariableCaseSensitive      (true | false) "false"

reservedMacroNames           CDATA #IMPLIED

reservedMacroNameSupplier    CDATA #IMPLIED

macroInputFileNameValue      CDATA #IMPLIED

macroInputFileExtValue       CDATA #IMPLIED

macroInputFileBaseNameValue  CDATA #IMPLIED

macroInputFileRelPathValue   CDATA #IMPLIED

macroInputDirRelPathValue    CDATA #IMPLIED

macroOutputFileNameValue     CDATA #IMPLIED

macroOutputFileExtValue      CDATA #IMPLIED

macroOutputFileBaseNameValue CDATA #IMPLIED

macroOutputFileRelPathValue  CDATA #IMPLIED

macroOutputDirRelPathValue   CDATA #IMPLIED

versionsSupported            CDATA #IMPLIED

convertToId                  CDATA #IMPLIED

supportsManagedBuild         (true | false)

autoBuildTarget              CDATA #IMPLIED

incrementalBuildTarget       CDATA #IMPLIED

cleanBuildTarget             CDATA #IMPLIED

ignoreErrCmd                 CDATA #IMPLIED

parallelBuildCmd             CDATA #IMPLIED

parallelBuildOn              (true | false)

parallelizationNumber        CDATA #IMPLIED

isSystem                     (true | false)

commandLauncher              CDATA #IMPLIED

buildRunner                  CDATA #IMPLIED>

Represents the utility that drives the build process (typically, but not necessarily, a variant of "make").

• id - A unique identifier for the builder that will be used by the build model.
• name - Human-readable name for the builder to be used in the UI.
• superClass - The id of a builder that this builder is derived from.
• isAbstract - An optional field that flags a builder as abstract. An abstract builder must be defined as a top level object in the model definition and cannot be selected by the user in the UI, but builders derived from this builder will inherit its attributes and children. The default is false.
• unusedChildren - A semi-colon separated list of child IDs of the superclass' children that should not be automatically inherited by this element. Note: This attribute is not yet implemented.
• command - Specifies the default command to start the build utility for your toolchain. If the user changes this through the UI, the overriden value will be stored in the project build file. The build model will default to this value if the user ever resets a change. The default is 'make'.
• arguments - Specifies the additional, default arguments that will be passed to the build utility when it is called by the builder. If the user changes the flags through the UI, the overriden value will be stored in the project build settings file. The build model will default to this value if the user ever resets a change. The default is '-k'.
• buildfileGenerator - Allows you to supply a custom build file generator that conforms to the IManagedBuilderMakefileGenerator interface.
• errorParsers - Specifies the default list of error parsers used by the builder. These error parsers are added to this list specified by the parent tool-chain. It is an ordered, semi-colon separated list of parser IDs. The order specifies the order in which the error parsers are invoked during a build.
• variableFormat - The value of this attribute should be set to the expression representing the builder variable format. For example, to generate macros with the ${macro} format, the attribute would contain ${=}. To generate macros with the @macro format, the attribute would contain @=. This information would be used wile buildfile generation to keep the environment build macros unresolved in the makefile. If the attribute is not specified or contains the empty string, this would mean that the builder can not treat environment variables as its own variables. In this case, the build macros that contain environment variables are resolved by MBS to their actual value.
• isVariableCaseSensitive - Specifies whether the builder variables are case sensitive or not. Can be set to either "true" or "false". The default is "true". If the builder does not support case-sensitive variables and there are some build environment variables that differ only in case (Environment variables on Unix-like operating systems are case sensitive), then those macros will always get resolved in the buildfile.
• reservedMacroNames - Comma-separated list of reserved macro names. The macro name could contain either the exact name or the java regular expression. The latter could be used to supply the pattern of variable names that are generated by MBS in case the "buildVariable" attribute of the "InputType" element is not specified, etc. If this attribute is specified and the reservedMacroNameSupplier is not specified, the following macro names will be treated as reserved: 1. a macro name that is equal to one of the names specified in the reservedMacroNames value 2. a macro name that matches one of the regexp patterns specified in the reservedMacroNames value 3. a macro name that is equal to one of the build variable names specified InputType elements of the tools used in the tool-chain If this attribute is not specified, MBS will assume that there are no reserved macro names that could conflict with the build environment variable macros, except names specified in the "buildVariable" attribute of the "InputType" elements: these names will always be treated as reserved
• reservedMacroNameSupplier - Should be set to the name of the class that implements the IReservedMacroNameSupplier interface. If this attribute is specified the reservedMacroNames attribute is ignored, and the following macro names will be treated as reserved: 1. macro names that the IReservedMacroNamesSupplier specifies as reserved 2. a macro name that is equal to one of the build variable names specified int the InputType elements of the tools used in the tool-chain
• macroInputFileNameValue - Represents the InputFileName macro value. The macro specifies the input file name. The input file has the following meaning: 1. If a tool does not accept building multiple files of the primary input type with one tool invocation, the input file is the file of the primary input type being built. 2. If a tool accepts building multiple files of the primary input type with one tool invocation the input file is undefined and the macros representing the input file contain information about one of the inputs of the primary input type being built.
• macroInputFileExtValue - Represents the InputFileExt macro value. The macro specifies the extension of the input file.
• macroInputFileBaseNameValue - Represents the InputFileBaseName macro value. The macro specifies the base name of the input file. That is the file name with an extension stripped.
• macroInputFileRelPathValue - Represents the InputFileRelPath macro value. The macro specifies the input file path relative to the builder current directory.
• macroInputDirRelPathValue - Represents the InputDirRelPath macro value. The macro specifies the input file directory path relative to the builder current directory.
• macroOutputFileNameValue - Represents the OutputFileName macro value. The macro specifies the output file name. The output file has the following meaning: 1. If a tool is not capable of producing multiple files of the primary output type with one tool invocation the output file is the file of the primary output type that is built with a given tool invocation. 2. If a tool is capable of producing multiple files of the primary output type with one tool invocation the output file is undefined and the macros representing the output file contain information about one of the files of the primary output type that are built with a given tool invocation.
• macroOutputFileExtValue - Represents the OutputFileExt macro value. The macro specifies the output file extension.
• macroOutputFileBaseNameValue - Represents the OutputFileBaseName macro value. The macro specifies the output file base name. That is the output file name with an extension stripped.
• macroOutputFileRelPathValue - Represents the OutputFileRelPath macro value. The macro specifies the output file path relative to the current builder directory.
• macroOutputDirRelPathValue - Represents the OutputDirRelPath macro value. The macro specifies the output file directory path relative to the current builder directory.
• versionsSupported - Specifies a comma delimited list of versions of this builder that can be loaded without invoking a converter.
• convertToId - The identifier of a builder, that builders loaded using this definition should be converted to. MBS will invoke a proper converter.
• supportsManagedBuild - Specifies whether the duilder supports managed build. Default value is true.
• autoBuildTarget - represents the build target to be used for auto build
• incrementalBuildTarget - represents the build target to be used for incremental build
• cleanBuildTarget - represents the build target to be used for clean build
• ignoreErrCmd - specifies the "ignore error" builder option.
• parallelBuildCmd - Specifies the command for "parallel build". If the builder supports specifying custom number of parallel jobs the option definition may contain "*". The Build System will substitute the "*" with the number of parallel threads to be used. In case of "unlimited" jobs jobs number will be omitted. For example, builder representing GNU make would define parallelBuildCmd as "-j*".
• parallelBuildOn - Defines if the parallel build is enabled in newly created project by default (when parallel build is supported). The number of jobs is defined by "parallelizationNumber" attribute. If "parallelizationNumber" is not defined "optimal" value will be used.
• parallelizationNumber - Sets maximum number of parallel threads/jobs to be used by builder (that value can be changed after creation of project by user). A positive number or value "optimal" or "unlimited" are recognized: - number 1 will cause parallel build to be turned off, - "optimal" will set maximum number of jobs to number of processors on the system, - "unlimited" will make builder to run as many threads/jobs as possible.
• isSystem - the system elements are used by the system for specific needs and are not displayed in UI
• commandLauncher - A concrete Java class that implements org.eclipse.cdt.core.ICommandLauncher to launch the builder command.
• buildRunner - A runner for the build. Overrides or extends the built-in external and internal build runners.

<!ELEMENT targetPlatform EMPTY>

<!ATTLIST targetPlatform

id             CDATA #REQUIRED

name           CDATA #IMPLIED

superClass     CDATA #IMPLIED

isAbstract     (true | false) "false"

unusedChildren CDATA #IMPLIED

osList         CDATA #IMPLIED

archList       CDATA #IMPLIED

binaryParser   CDATA #IMPLIED>

Represents the os/architecture combination(s) upon which the outputs of a tool-chain can be deployed.

• id - A unique identifier for the target platform that will be used by the build model.
• name - Human-readable name for the target platform to be used in the UI.
• superClass - The id of a target platform that this target platform is derived from.
• isAbstract - An optional field that flags a target platform as abstract. An abstract target platform must be defined as a top level object in the model definition and cannot be selected by the user in the UI, but target platforms derived from this targetPlatform will inherit its attributes and children. The default is false.
• unusedChildren - A semi-colon separated list of child IDs of the superclass' children that should not be automatically inherited by this element. Note: This attribute is not yet implemented.
• osList - This field lists the target operating systems on which the outputs of a tool-chain runs. The value should be a comma-separated list. Valid values are the strings returned by the Eclipse API Platform.getOS() and include strings like "win32", "linux", "solaris", "hpux", "aix". Do not specify this attribute or specify "all" to allow all target operating systems.
• archList - This field lists the target architectures on which the outputs of a tool-chain runs. The value should be a comma-separated list. Valid values are the strings returned by the Eclipse API Platform.getOSArch() and include strings like "ia32". Do not specify this attribute or specify "all" to allow all target architectures.
• binaryParser - Set this to the ID of the binary parser for the output format of your configuration.

<!ELEMENT dynamicElementProvider EMPTY>

<!ATTLIST dynamicElementProvider

class CDATA #REQUIRED

name  CDATA #REQUIRED>

An optional element that allows a tool implementor to supply a class that creates one or more dynamic toolchain elements. For example, the class might create a new tool reference based on the contents of a special file, and a new target that uses that reference.

• class - The class that implements the IManagedConfigElementProvider interface. The logic of determining the elements is left to the implementer, but they must be correctly formed or the build model will have trouble loading.
• name - A meaningful name for the type of element being provided.

<!ELEMENT buildDefinitionStartup EMPTY>

<!ATTLIST buildDefinitionStartup

class CDATA #REQUIRED

name  CDATA #REQUIRED>

An optional element that allows a tool implementor to supply a class that insures a plugin that modifies any build configruation attributes (e.g. the build config id) will get loaded before initial project information is created.

• class - The class that implements the IManagedBuildDefinitionsStartup interface. This class may not actually do anything, but additional initialization can be done here is desired.
• name - A meaningful name for the type of element being provided.

<!ELEMENT managedBuildRevision EMPTY>

<!ATTLIST managedBuildRevision

fileVersion CDATA #REQUIRED>

• fileVersion - The actual string containing the three version tokens.

<!ELEMENT envVarBuildPath EMPTY>

<!ATTLIST envVarBuildPath

pathType          (buildpathInclude|buildpathLibrary)

variableList      CDATA #REQUIRED

pathDelimiter     CDATA #IMPLIED

buildPathResolver CDATA #IMPLIED>

Defines a set of environment variables used by a tool to represent the build paths (include paths or library paths).

• pathType - The build path type. Can be one of the following: "buildpathInclude", "buildpathLibrary"
• variableList - comma-separated list of the environment variable names used to store the include paths
• pathDelimiter - Represent the delimiter used to separate the paths. If omitted the default system delimiter will be used. That is the ":" for Unix-like systems and the ";" for Win32 systems. If the "buildPathResolver" attribute is specified, the "pathDelimiter" is ignored
• buildPathResolver - Should be set to the IBuildPathResolver interface that the tool-integrator can supply in order to provide his/her own logic of resolving the variable values to the build paths

<!ELEMENT enablement (and* | or* | not* | checkOption* | checkString* | false* | checkHolder* | checkBuildProperty* | hasNature*)>

<!ATTLIST enablement

type                CDATA "ALL"

attribute           (command|commandFalse|defaultValue|value|artifactExtension)

value               CDATA #IMPLIED

extensionAdjustment (true | false) >

Contains boolean expression that specifies option applicability

• type - Represents the applicability type for this enablement. Can contain the following values: UI_VISIBILITY - the given enablement expression specifies whether the option is to be visible in UI, UI_ENABLEMENT - the given enablement expression specifies the enable state of the controls that represent the option in UI, CMD_USAGE - the given enablement expression specifies whether the option is to be used in command line CONTAINER_ATTRIBUTE - the given enablement expressions specifies thecontainer attribute value ALL - this value means the combination of all the above values. Several types could be specified simultaneously using the "|" as a delimiter, e.g.: type="UI_VISIBILITY|CMD_USAGE"
• attribute - This attribute should be used only for the CONTAINER_ATTRIBUTE enablement to specify the name of the attribute for which this enablement applies. Currently the following option attributes are supported: "command" "commandFalse" "defaultValue" "value" "artifactExtension"
• value - This attribute should be used only for the CONTAINER_ATTRIBUTE enablement to specify the value of the attribute specified in the "attribute" for which this enablement applies
• extensionAdjustment - The attribute is valid for the CONTAINER_ATTRIBUTE enablement type. true specifies that the enablement is defined for adjusting extension elements (extension elements are adjusted on tool-chain definition load) false specifies that the enablement is defined for non-extension elements adjustment. This adjustment is performed, e.g. when the Build properties set is chenged for configuration Default value is true.

<!ELEMENT and (and* , or* , not* , checkOption* , checkString* , checkHolder* , checkBuildProperty*)>

Represents boolean "and" operation

<!ELEMENT or (and* , or* , not* , checkOption* , checkString* , checkHolder* , checkBuildProperty*)>

Represents boolean "or" operation

<!ELEMENT not (and* | or* | not* | checkOption* | checkString* | checkHolder* | checkBuildProperty*)>

Represents boolean "not" operation

<!ELEMENT checkOption EMPTY>

<!ATTLIST checkOption

optionId      CDATA #IMPLIED

holderId      CDATA #IMPLIED

value         CDATA #IMPLIED

isRegex       CDATA "false"

otherOptionId CDATA #IMPLIED

otherHolderId CDATA #IMPLIED>

Performs an option value check. The option value can be checked either agains some pre-defined value or against the value of another option

• optionId - The option id. The default is the id of the option that holds this expression. When searching for the option to be checked, MBS will examine all the options the holder contains along with all superclasses of each option to find the option with the specified id.
• holderId - The option holder id that holds the option. The default is the id of the holder that holds the container of this expression. When searching for the needed holder, MBS will examine all the holders the current configuration contains along with all superclasses of each holder in order to find the holder with the specified id.
• value - Specifies the expected value. If the current option value matches the value specified in this attribute, the checkOption element is treated as true, otherwise - as false. The expected value could be specified either as a string that may contain build macros or as a regular expression. During the comparison, the build macros are resolved and the option value is checked to match the resulting string or regular expression. The way the expected value is specified and treated depends on the value of the isRegex attribute
• isRegex - Specifies whether the string specified in the "value" attribute should be treated as a regular eexpression. The default is false
• otherOptionId - The id of the option which is to be compared with the option specified with the "optionId" attribute. The default is the id of the option that holds this expression. If the "value" attribute is specified, both the "otherOptionId" and the "otherHolderId" attributes are ignored. When searching for the option to be checked, MBS will examine all the options the holder contains along with all superclasses of each option to find the option with the specified id.
• otherHolderId - The option holder id that holds the option specified with the "otherOptionId" attribute. The default is the id of the holder that holds the container of this expression. If the "value" attribute is specified, both the "otherOptionId" and the "otherHolderId" attributes are ingnored. When searching for the needed holder, MBS will examine all the holders the current configuration contains along with all superclasses of each holder in order to find the holder with the specified id.

<!ELEMENT checkString EMPTY>

<!ATTLIST checkString

string  CDATA #REQUIRED

value   CDATA #REQUIRED

isRegex CDATA "false">

Performs a string check.

• string - Represents the string to be checked. The string will typically contain the build macros.
• value - Specifies the expected value. If the current string specified in the "string" attribute matches the value specified in this attribute, the checkString element is treated as true, otherwise - as false. The expected value could be specified either as a string that might contain the build macros or as a regular expression. The way the value is specified and treated depends on the value of the isRegex attribute.
• isRegex - Specifies whether the string specified in the "value" attribute should be treated as a regular eexpression. The default is false

<!ELEMENT false (#PCDATA)>

Represents the "false" value. This element can be used as a direct child of the "enablement" element to represent that the given option applicability is disabled. E.g. to specify that the option is never displayed in UI or never used in the command line.

<!ELEMENT checkHolder EMPTY>

<!ATTLIST checkHolder

holderId CDATA #REQUIRED>

Performs the holder check.

• holderId - Specifies the holder id to be checked. The checkHolder is treated as true if the id specified in this attribute matches with the option's holder id or the id of some holder's super-class. Otherwise the checkHolder is treated as false.

<!ELEMENT checkBuildProperty EMPTY>

<!ATTLIST checkBuildProperty

property CDATA #IMPLIED

value    CDATA #IMPLIED>

Performs the Build Property check

• property - specifies the id of the Build Property to be checked
• value - Specifies the Build Property Value id to be checked

<!ELEMENT supportedProperties (property)>

contains the list of supported properties

<!ELEMENT property (value+)>

<!ATTLIST property

id CDATA #IMPLIED>

contains the supported values for the property

• id - the property type id

<!ELEMENT value EMPTY>

<!ATTLIST value

id CDATA #IMPLIED>

represents the property value

• id - represents the property value id

<!ELEMENT folderInfo (toolChain)>

<!ATTLIST folderInfo

resourcePath CDATA #REQUIRED

exclude      (true | false) >

Represents per-folder settings.

• resourcePath - Project-relative resource path
• exclude - Specifies whether the resource is excluded from building in the parent configuration. The default is false. The resourceConfiguration element retains its tool children, if any exist, even when excluded from the build.

<!ELEMENT fileInfo EMPTY>

<!ATTLIST fileInfo

resourcePath      CDATA #IMPLIED

exclude           (true | false)

rcbsApplicability (before|after|override|disable)

toolsToInvoke     CDATA #IMPLIED>

Represents per-file settings. This element has the same meaning as resourceConfiguration. It is added for consistency with the folderInfo element. The only difference between this element and the resourceConfiguration is that resourceConfiguration specifies the resource full path, while the fileInfo specifies project-relative resource path in the same way as the folderInfo does.

• resourcePath - Project-relative resource path
• exclude - Specifies whether the resource is excluded from building in the parent configuration. The default is false. The resourceConfiguration element retains its tool children, if any exist, even when excluded from the build.
• rcbsApplicability - Identifies how the user desires to apply a resource custom build step: 1. Apply rcbs tool before any other tools defined for the resource. 2. Apply rcbs tool after any other tools defined for the resource. 3. Apply rcbs tool overriding any other tools defined for the resource. 4. Disable (don't apply) the rcbs tool.
• toolsToInvoke - Identifies which tools to invoke by a semicolon separated list of child tool ids. Applies as follows: 1. Defaults to all tools in the order found 2. Use specified ordered list of children to invoke 3. If empty string, treat as if no resource configuration existed, i.e., use project level tool.

<!ELEMENT hasNature EMPTY>

<!ATTLIST hasNature

natureId CDATA #IMPLIED>

Checks whether the project containing the resource has a given nature

• natureId - The id of the nature

Examples:

API Information:

Supplied Implementation:

Copyright (c) 2003, 2006 IBM Corporation and others. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available on the Eclipse website.