asl-common.xml

<?xml version="1.0" encoding="utf-8"?> 
<!--
********************************************************************************
* Ant Script Library - common targets module 
* Contains properties and targets 
* Module property prefix: "common"
********************************************************************************
* Copyright 2009 Joe Schmetzer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
********************************************************************************
 -->
<project name="asl-common">
    <dirname property="asl-common.basedir" file="${ant.file.asl-common}"/>
    <!-- User specific property overrides -->
    <property file="${user.home}/asl.properties"/>
     
    <!-- Project specific property overrides -->
    <property file="asl.properties"/>

    <!-- ***********************************************************************
    * Common properties.
    ************************************************************************ -->
    <property name="common.target-dir" location="target"/>
    <property name="common.dist-dir" location="${common.target-dir}/dist"/>

    <!-- ***********************************************************************
    * target: clean
    ************************************************************************ -->
    <target name="clean" description="Deletes files generated by the build">
        <delete dir="${common.target-dir}"/>
    </target>
    
    <!-- ***********************************************************************
    * target: -init-time
    ************************************************************************ -->
    <target name="-init-time">
        <!-- Initialise standard time and date properties (including DSTAMP and TSTAMP) -->
        <tstamp>
            <format property="common.timestamp" pattern="yyyy-MM-dd HH:mm"/>
            <format property="common.timestamp-long" pattern="d-MMMM-yyyy HH:mm"/>
            <format property="common.date-iso" pattern="yyyyMMdd"/>
            <format property="common.year" pattern="yyyy"/>
        </tstamp>
    </target>
     
    <!-- ***********************************************************************
    * target: -init-version
    * This is an empty target that allows users to override how the property
    * ${release.version} is set.
    ************************************************************************ -->
    <target name="-init-version"/>

    <!-- ***********************************************************************
    * macrodef: asl-check-libs
    ************************************************************************ -->
    <macrodef name="asl-check-libs"
              description="Checks to see if the libraries for an optional task are available">
        <attribute name="libname"/>
        <attribute name="jar"/>
        <sequential>
            <available file="@{jar}" property="asl-common.@{libname}-jar-present"/>
            <fail unless="asl-common.@{libname}-jar-present">Unable to intialise @{libname} task.
                 
The jar file "@{jar}"
is missing. To install this jar, run the following command:

    ant -f ${java-report.basedir}/asl-tasklib-install.xml install-@{libname}
            </fail>
        </sequential>
    </macrodef>
     
    <!-- ***********************************************************************
    * macrodef: asl-show-path
    ************************************************************************ -->
    <macrodef name="asl-show-path"
              description="Displays the elements of a path">
        <attribute name="refid"/>
        <sequential>
            <pathconvert property="show-path-@{refid}" refid="@{refid}" pathsep="${line.separator}  "/>
            <echo>@{refid}:
  ${show-path-@{refid}}
            </echo>
        </sequential>
    </macrodef>
</project>