Managed Build Tools 2.0 (deprecated)

Identifier:

Since:

Description:

Configuration Markup:

<!ELEMENT extension (target , tool , configuration , dynamicElementProvider , managedBuildRevision)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>

<!ELEMENT tool (option , optionCategory)>

<!ATTLIST tool

id                   CDATA #REQUIRED

name                 CDATA #REQUIRED

sources              CDATA #IMPLIED

outputs              CDATA #IMPLIED

command              CDATA #IMPLIED

outputFlag           CDATA #IMPLIED

outputPrefix         CDATA #IMPLIED

dependencyCalculator CDATA #IMPLIED

headerExtensions     CDATA #IMPLIED

natureFilter         (cnature|ccnature|both) >

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.
• sources - A comma-separated list of file extensions that the tool will produce output for.
• outputs - The extension that the tool will produce from a given input.
• command - The command that invokes the tool. For example, gcc for the Gnu C compiler, or g++ for the Gnu C++ compiler.
• 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.
• 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 lib.a, so 'lib' would be the prefix.
• dependencyCalculator - This is an optional field that specifies the class that provides the source file dependency calculation for a given tool. You can replace the default calculator with a class that implements the IManagedDependencyGenerator interface.
• headerExtensions - A comma-separated list of file extensions that are used for header files. Since many other files depend on the interfaces defined in header files, the build system needs to be able to determine that a header file has changed to properly rebuild its dependents.
• natureFilter - Filter 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.

<!ELEMENT option (enumeratedOptionValue , listOptionValue)>

<!ATTLIST option

id           CDATA #REQUIRED

name         CDATA #REQUIRED

valueType    (string|stringList|boolean|enumerated|includePath|definedSymbols|libs|userObjs) "string"

category     CDATA #IMPLIED

defaultValue CDATA #IMPLIED

command      CDATA #IMPLIED

commandFalse CDATA #IMPLIED

browseType   (none|file|directory)

helpSupplier CDATA #IMPLIED

tip          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.

• id - A unique identifier for the option.
• name - A descriptive name for the option.
• 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 will treat the libs and userObjs entries differently than other stringLists.
• category - This is the id of the option category for this option. The id can be the id of the tool which is also a category.
• defaultValue - Specifies the default value for the option if the 'value' field 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.
• command - An optional value that specifies the actual command that will be passed to the tool on the command line.
• 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.
• browseType - This value is used for list (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.
• helpSupplier - This field is unused in 2.0
• tip - Specifies a "tip" that can be displayed in hover help or on the property page. Not implemented in 2.0.

<!ELEMENT enumeratedOptionValue EMPTY>

<!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 configuration (toolReference)>

<!ATTLIST configuration

id   CDATA #REQUIRED

name CDATA #REQUIRED>

A configuration is used to gather together certain default tools and options to build target 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.

<!ELEMENT toolReference (optionReference)>

<!ATTLIST toolReference

id           CDATA #REQUIRED

command      CDATA #IMPLIED

outputs      CDATA #IMPLIED

outputPrefix CDATA #IMPLIED

outputFlag   CDATA #IMPLIED>

This is reserved for future use. It currently gets instantiated for saving tool settings.

• id - The unique ID of the tool that the reference is for.
• command - The overridden command for the tool the reference is for.
• outputs - A comma-separated list of extensions that this tool reference will create. This completely overrides the the output extension in the tool the reference is for.
• outputPrefix - The prefix that will be applied to the output of the tool. This completely overrides the output defined in the referenced tool.
• outputFlag - Overrides the output flag of the referenced tool.

<!ELEMENT optionReference (listOptionValue , enumeratedOptionValue)>

<!ATTLIST optionReference

id           CDATA #REQUIRED

defaultValue CDATA #IMPLIED

command      CDATA #IMPLIED>

Option references hold onto information the user has changed through the UI. Not all fields will be populated, depending on the option type the reference overrides. For example, the 'name' field is used by enumerated options only.

• id - The unique ID of the option the reference is for.
• defaultValue - This field is used to record the value of the option that the user has set in the build settings file. For example, if the user has set the verbose flag to true, the project's build settings file will contain an option reference for the verbose option, with the defaultvalue set to true.

  The attribute is also used to override the default option setting for a configuration in a toolchain. For example, a 'Debug' configuration may setthe value of a debug flag differently than the default value defined in the tool.

• command - This field is unused in 2.0

<!ELEMENT target (tool , configuration , toolReference)>

<!ATTLIST target

id                   CDATA #REQUIRED

name                 CDATA #IMPLIED

isAbstract           (true | false) "false"

parent               CDATA #IMPLIED

artifactName         CDATA #IMPLIED

defaultExtension     CDATA #IMPLIED

isTest               (true | false)

cleanCommand         CDATA #IMPLIED

makeCommand          CDATA #IMPLIED

makeArguments        CDATA #IMPLIED

binaryParser         CDATA #IMPLIED

osList               CDATA #IMPLIED

archList             CDATA #IMPLIED

errorParsers         CDATA #IMPLIED

scannerInfoCollector CDATA #IMPLIED

makefileGenerator    CDATA #IMPLIED>

Represents a type of resource that is the target of the build process, for example, a Linux static library. A target contains a sequence of tool definitions and configurations. Targets are arranged in an inheritance hierarchy where a target inherits the list of tools from it's parent and can add to or override tools in this list.

• id - Used by the build model to uniquely identify the target.
• name - A human-readable target name, such as 'Executable'. This will be the name the user sees displayed in the UI.
• isAbstract - This is a UI property. If set to true, users should not be able to create project configurations targeted at this target.
• parent - The id of a target that this tool inherits from.
• artifactName - This is the name of the final build artifact associated with the target. The user will specify this is the UI, so there is no need to supply a default value.
• defaultExtension - This is the extensionthat will be applied to any build artifact created by the target.
• isTest - A an optional field that flags a target as a test-only target. If true, the target will not appear in the UI.
• cleanCommand - This attribute maintains the command that removes files for a particular target. For example, on POSIX targets like Linuc, Solaris, or Cygwin, the command would be rm -rf whereas on Win32 platforms it would be del /F /S /Q
• makeCommand - 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.
• makeArguments - 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.
• binaryParser - Set this to the ID of the binary parser for the output format of your target. Currently there are ELF parsers for *nix and many embedded targets, and PE64 parsers for Windows targets. Alternative versions of these parsers provide additional capabilities for GNU toolchains only.
• osList - This field is used by the managed build system to decide when to show the user the target. The value should be a comma-separated list. Current values are "win32", "linux", "solaris", "hpux", "aix" or "any".
• archList - This field is used by the managed build system to decide when to show the user the target. The value should be a comma-separated list. Current values include "x86", "sparc", "ppc"; or "all".
• errorParsers - Specifies the default list of error parsers to be used by projects created from this target. 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.
• scannerInfoCollector - Specifies a class that implements the IManagedScannerInfoCollector for gathering the built-in compiler settings for a toolchain.
• makefileGenerator - Allows you to supply a custom makefile generator that conforms to the IManagedBuilderMakefileGenerator interface.

<!ELEMENT optionCategory EMPTY>

<!ATTLIST optionCategory

id    CDATA #REQUIRED

name  CDATA #IMPLIED

owner 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 or be nested inside other option categories. This is the ID of the owner of the category.

<!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.
• 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 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 managedBuildRevision EMPTY>

<!ATTLIST managedBuildRevision

fileVersion CDATA #REQUIRED>

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

Examples:

   <extension
         id="buildExample"
         name="Tools for Build Example"
         point="org.eclipse.cdt.core.ManagedBuildInfo">
      <target
            makeFlags="-k"
            isTest="false"
            cleanCommand="rm -rf"
            name="Executable"
            defaultExtension=".exe"
            isAbstract="false"
            makeCommand="make"
            id="example.target.executable">
         <tool
               sources="C"
               name="Compiler"
               outputFlag="-o"
               outputs="exe"
               command="g++"
               id="executable.compiler">
            <optionCategory
                  owner="executable.compiler"
                  name="Flags"
                  id="compiler.category.flags">
            </optionCategory>
            <option
                  defaultValue="-c"
                  name="Compiler Flags"
                  category="compiler.category.flags"
                  valueType="string"
                  id="category.flags.comp_flags">
            </option>
         </tool>
         <configuration
               name="Default"
               id="example.config.default">
         </configuration>
      </target>
   </extension>

Supplied Implementation:

Copyright (c) 2003, 2004 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.