<buildPlugin>

Description

This macro builds an eclipse plug-in project. It reads the information from the MANIFEST and the build.properties file and builds the plugin according to these settings.

Important: This task is implemented as an Ant macro. To use this task, you have to import the file 'a4e-pde-macros.xml' in your build file.

Arguments

The buildPlugin task provides the following arguments:

Lifecycle hooks

To allow the user of ant4eclipse to add additional build steps to the plug-in build, the buildPlugin macro defines the following lifecycle hooks that are implement as macro elements.

Scoped properties

The following scoped properties are available within the lifecycle hooks:

Scoped references

The following scoped references are available:

Example usage

The following example builds the plug-in project with the project name 'example-bundle'. The built bundle will reside in 'd:/plugins/plugins'.

<buildPlugin workspace="${workspace}"
             projectName="example-bundle"
             targetPlatformId="target.platform"
             destination="d:/plugins" />

<buildPlugin workspace="${workspace}"
             projectName="example-bundle"
             targetPlatformId="target.platform"
             destination="d:/plugins" >
 
  <generate-sources>
    <!-- add additional build steps here... -->
  </generate-sources>
 
  <post-compile>
    <!-- add additional build steps here... -->
  </post-compile>
 
</buildPlugin>

<buildFeature>

Description

This macro builds an eclipse feature project. It reads the information from the file feature.xml and builds the feature according to these settings.

Important: This task is implemented as an Ant macro. To use this task, you have to import the file 'a4e-pde-macros.xml' in your build file.

Arguments

The buildFeature task provides the following arguments:

Example usage

The following example builds the feature project with the project name 'test.feature'. The built feature will reside in 'd:/plugins'.

<buildFeature workspaceDirectory="${workspace}"
              projectName="test.feature"
              targetplatformid="target.platform"
              destination="d:/plugins" />

<buildProduct>

Description

This macro builds a complete eclipse product. This incorporates the build process for each feature/plugin declared by this product.

Important: This task is implemented as an Ant macro. To use this task, you have to import the file 'a4e-pde-macros.xml' in your build file.

Arguments

The buildProduct task provides the following arguments:

Lifecycle hooks

To allow the user of ant4eclipse to add additional build steps to the product build, the buildProduct macro defines the following lifecycle hooks that are implement as macro elements. The scope information identifies the properties which are available within this macro define (check out the executeProduct task description for detailed information).

Example usage

The following example builds a product with the project. The built product will be stored into 'd:/my-rcp'.

<buildProduct 
  workspaceDirectory="${workspace}"
  productfile="d:/my-rcp.product"
  targetPlatformId="eclipse-3.4"
  destination="d:/my-rcp" 
  clearDestination="true"
  os="win32"
/>

The next example shows how to add additional build steps to the build process.

<buildProduct 
  workspaceDirectory="${workspace}"
  productfile="d:/my-rcp.product"
  targetPlatformId="eclipse-3.4"
  destination="d:/my-rcp" 
  clearDestination="true"
  os="win32"
>
 
  <deploy>
    <!-- sometimes we just want to add some documentation -->
    <mkdir dir="d:/my-rcp/docs"/>
    <copy todir="d:/my-rcp/docs">
      <fileset dir="V:/my-rcp/docs" includes="**/*"/>
    </copy>
  </deploy>
</buildProduct>

<targetPlatform>

Description

The targetPlatform type can be used to define a PDE target platform. Target platforms are used when working with plugin and feature projects. They define locations where binary, plugins can be found (e.g. an existing eclipse installation).

A target platform may consist of more than one directory. A directory listed in the targetPlatform type has to be the parent directory of the plugins directory that contains the plugins (e.g. if you would like to include the plugins of your eclipse distribution, you would add "c:/eclipse" (or whereever you've installed Eclipse) as a directory and not "c:/eclipse/plugins").

You can use the target platform within the ant4eclipse tasks by refering to it with the target platform id.

Arguments

The targetPlatform type provides the following arguments:

Nested elements

Each directory you want to include in your platform definition must be added using a location element.

Example usage

The following example creates a target platform defintion that consists of one directory. The defintion can be referenced via it's id 'eclipse-3.5':

<project name="..." default="...">
 
  <ant4eclipse:targetPlatform id="eclipse-3.5">
    <location dir="c:/eclipse-3.5" />
    <location dir="d:/addtionalLocation" />
  </ant4eclipse:targetPlatform> 
 
 </project>

<executePluginProject>

Description

The executePluginProject task allows you to iterate over the plug-in libraries defined in a PDE project.

Arguments

The executePluginProject task provides the following arguments:

Nested Elements

To iterate over source or output folders specified in a JDT project, you can define one or more nested elements. Those elements can contain several task calls, similar to a target element. The following elements are defined:

• forPluginLibrary: executed for each plug-in library
• forProject: executed once

Scoped Properties

Several properties and references are "passed in", so you can access them within the forPluginLibrary or forProject elements. You can access the following scoped properties:

Example usage

The following example shows the usage of the executePluginProject task:

<ant4eclipse:executePluginProject workspaceDirectory="${workspaceDirectory}"
                                  projectName="${projectName}" >
 
  <!-- execute once for the project -->
  <ant4eclipse:forProject>
    ...
  </ant4eclipse:forProject>
 
  <!-- execute for each library (except the 'self' library) -->
  <ant4eclipse:forEachPluginLibrary filter="(library.isSelf=false)">
    ...
  </ant4eclipse:forEachPluginLibrary>
 
  <!-- execute for each library (only for the 'self' library) -->
  <ant4eclipse:forEachPluginLibrary filter="(library.isSelf=true)">
    ...
  </ant4eclipse:forEachPluginLibrary>
 
</ant4eclipse:executePluginProject>

<executePluginLibrary>

Description

The executePluginLibrary allows you to iterate over the source and output entries of plug-in libraries defined in the build.properties file of a PDE project.

Arguments

The executePluginLibrary task provides the following arguments:

Nested Elements

To iterate over source or output entries specified in the build.properties file, you can define one or more nested elements. Those elements can contain several task calls, similar to an ant target element. The following elements are defined:

• forEachSourceDirectory: executed for each source directory
• forEachOutputDirectory: executed for each output directory
• ForLibrary: executed once for the library

Scoped Properties

Several properties and references are "passed in", so you can access them within the forEachSourceDirectory, forEachOutputDirectory
or ForLibrary elements. You can access the following scoped properties:

Example usage

The following example shows the usage of the executePluginProject task:

<ant4eclipse:executePluginLibrary workspace="${workspaceDirectory}"
		                  projectname="${project.name}"
		                  libraryname="${library.name}">
 
  <!-- execute for each output directory -->
  <ant4eclipse:forEachOutputDirectory>
    ...
  </ant4eclipse:forEachOutputDirectory>
 
  <!-- execute for each source directory -->
  <ant4eclipse:forEachSourceDirectory>
    ...
  </ant4eclipse:forEachSourceDirectory>
 
</ant4eclipse:executePluginLibrary>

<pdeProjectFileSet>

Description

The pdeProjectFileSet type can be used to define plug-in project relative file sets.

Note: The bundle root ('.') will be resolved to a directory with the name '@dot'.

Arguments

The pdeProjectFileSet type defines the following attributes:

Example usage

<copy todir="${destination}"
      overwrite="true">
 
  <ant4eclipse:pdeProjectFileSet workspace="${workspaceDirectory}"
                                 projectname="${project.name}"
                                 includes="META-INF,.,OSGI-INF"
                                 excludes="META-INF/todos.txt" />
</copy>

<executeFeature>

<platformConfiguration>

Description

The platformConfiguration type can be used to define a PDE platform configuration. Platform configurations are used in conjunction with target platforms. They define the system platform to resolve a given target platform for. As the default the system configuration of the machine where the ant4eclipse build is running is used. If you want to execute cross-platform build, you have to specify the platform configuration explicitly.

You can use the platform configuration within the ant4eclipse tasks by refering to it with the platform configuration id.

Arguments

The platformConfiguration type provides the following arguments:

Example usage

The following example creates a platform configuration. The defintion can be referenced via it's id 'win32.win32.x86':

<project name="..." default="...">
 
  <ant4eclipse:platformConfiguration id="win32.win32.x86"
                                     windowingSystem="win32"
                                     operatingSystem="win32"
                                     architecture="x86" />
 
</project>

<executeProduct>

Description

The executeProduct task allows you to iterate over all plug-ins and features specified within a product file. This build process is probably the most comfortable way to build an eclipse release since you only need to supply a product description.

Arguments

The executeProduct task provides the following arguments:

Nested Elements

To iterate over source or output folders specified in a project, you can define one or more nested elements. Those elements can contain several task calls, similar to a target element. The following elements are defined:

• forProduct: executes for a product
• forEachFeature: executes for each feature
• forEachPlugin: executes for each plugin

Scoped Properties

Several properties and references are "passed in", so you can access them within these scoped elements. Following scoped properties are available:

Example usage

The following example shows the usage of the executeProduct task:

<ant4eclipse:executeProduct 
  workspaceDirectory="${workspaceDirectory}"
  product="my.product" 
  os="win32"
  targetPlatformId="K:/my-platform"
>
 
  <!-- execute once for the product -->
  <ant4eclipse:forProduct>
    ...
  </ant4eclipse:forProduct>
 
  <!-- execute for each included feature -->
  <ant4eclipse:forEachFeature>
    ...
  </ant4eclipse:forEachFeature>
 
  <!-- execute for each included plugin -->
  <ant4eclipse:forEachPlugin>
    ...
  </ant4eclipse:forEachPlugin>
 
</ant4eclipse:executeProduct>

<patchFeatureManifest>