Scala Ant Tasks

The Scala distribution contains several tasks for building software projects using Apache Ant, a Java-based build tool. The tasks described below require Apache Ant version 1.6 or newer.

The Scala tasks are: scalac, fsc and scaladoc

Compiles a Scala source tree.

The source and destination directory will be recursively scanned for Scala source files to compile. Only Scala files that have no corresponding .class file or where the class file is older than the .scala file will be compiled.

Note: Ant uses only the names of the source and class files to find the classes that need a rebuild. It will not scan the source and therefore will have no knowledge about nested classes, classes that are named different from the source file, and so on.

It is possible to refine the set of files that are being compiled. This can be done with the includes, includesfile, excludes, and excludesfile attributes. With the includesor includesfile attribute, you specify the files you want to have included. The exclude or excludesfile attribute is used to specify the files you want to have excluded. In both cases, the list of files can be specified by either the filename, relative to the directory(s) specified in the srcdir attribute or nested <src> element(s), or by using wildcard patterns. See the Ant documentation on directory-based tasks, for information on how the inclusion/exclusion of files works, and how to write wildcard patterns.

This task forms an implicit FileSet and supports all attributes of <fileset> (dir becomes srcdir) as well as the nested <include>, <exclude> and <patternset> elements.

src, classpath, sourcepath, bootclasspath and extdirs

Scalac's srcdir, classpath, sourcepath, bootclasspath, and extdirs attributes are path-like structures and can also be set via nested <src>, <classpath>, <sourcepath>,<bootclasspath> and <extdirs> elements, respectively.

• Ant 1.6 or higher
• Scala 2.2 or higher

  <property
    name="sources.dir"
    value="${base.dir}/sources"
     />
  <property
    name="build.dir"
    value="${base.dir}/build"
     />
  <target name="init">
    <property
      name="scala-library.jar"
      value="${scala.home}/lib/scala-library.jar"
       />
    <path id="build.classpath">
      <pathelement location="${scala-library.jar}"   />
      <!--<pathelement location="${your.path}"   />-->
      <pathelement location="${build.dir}"   />
    </path>
    <taskdef resource="scala/tools/ant/antlib.xml">
      <classpath>
        <pathelement location="${scala.home}/lib/scala-compiler.jar"   />
        <pathelement location="${scala-library.jar}"   />
      </classpath>
    </taskdef>
  </target>

In the above target "init" the task taskdef defines the Scala ant tasks fsc, sbaz, scalac and scalascript.

  <target name="build" depends="init">
    <mkdir dir="${build.dir}"   />
    <scalac srcdir="${sources.dir}"
            destdir="${build.dir}"
            classpathref="build.classpath">
      <include name="compile/**/*.scala"   />
      <exclude name="forget/**/*.scala"   />
    </scalac>
  </target>

Compiles all Scala files in sources/compile/ (not in sources/forget) to build/ with given classpath. Files in sources/forget/ will not necessarily be compiled, but might be as they are in the sourcepath. All modified files are re-compiled.

Compiles a Scala source tree.

The fsc Ant task supports the same set of parameters as the scalac Ant task with the following additional parameters:

• Ant 1.6 or higher
• Scala 2.2 or higher

Generates the API documentation in HTML format for the given source files.

The scaladoc Ant task supports the same set of parameters as the scalac Ant task with the following additional parameters:

• Ant 1.6 or higher
• Scala 2.2 or higher

  <target name="docs" depends="init">
    <mkdir dir="${docs.dir}"   />
    <scaladoc
      srcdir="${sources.dir}"
      destdir="${docs.dir}"
      deprecation="yes" unchecked="yes"
      windowtitle="liftweb Library Documentation"
      doctitle="&lt;div&gt;liftweb 0.1.0&lt;/div&gt;"
      classpathref="build.classpath">
        <include name="compile/**/*.scala"   />
    </scaladoc>
  </target>

Executes a Java class within the running (Ant) VM or forks another VM if specified.

The task java belongs the core tasks of the Ant distribution.

Note: The Scala library scala-library.jar must be present in the Java class path. The actors and dbc libraries are available as separate JAR files: scala-actors.jarand scala-dbc.jar.

  <target name="run" depends="build">
    <java classname="examples.sort"
          classpathref="build.classpath">
    </java>
  </target>