/* __ *\
** ________ ___ / / ___ Scala Ant Tasks **
** / __/ __// _ | / / / _ | (c) 2005-2007, LAMP/EPFL **
** __\ \/ /__/ __ |/ /__/ __ | http://scala-lang.org/ **
** /____/\___/_/ |_/____/_/ | | **
** |/ **
\* */
// $Id$
package scala.tools.ant
import scala.collection.immutable.{Map, ListMap}
import java.io.{File, InputStream, FileWriter}
import org.apache.tools.ant.BuildException
import org.apache.tools.ant.taskdefs.MatchingTask
import org.apache.tools.ant.types.Path
import org.apache.tools.ant.util.FileUtils
/** <p>
* An Ant task that generates a shell or batch script to execute a
* <a href="http://scala-lang.org/" target="_top">Scala</a> program.
* This task can take the following parameters as attributes:
* </p><ul>
* <li>file (mandatory),</li>
* <li>name,</li>
* <li>class (mandatory),</li>
* <li>platforms,</li>
* <li>version,</li>
* <li>copyright,</li>
* <li>bootclasspath,</li>
* <li>extclasspath,</li>
* <li>properties,</li>
* <li>javaflags,</li>
* <li>toolflags.</li></ul>
*
* @author Gilles Dubochet
* @version 1.0
*/
class ScalaTool extends MatchingTask {
/** The unique Ant file utilities instance to use in this task. */
private val fileUtils = FileUtils.newFileUtils()
/*============================================================================*\
** Ant user-properties **
\*============================================================================*/
abstract class PermissibleValue {
val values: List[String]
def isPermissible(value: String): Boolean =
(value == "") || values.exists(.startsWith(value))
}
/** Defines valid values for the platforms property. */
object Platforms extends PermissibleValue {
val values = List("unix", "windows")
}
/** The path to the exec script file. ".bat" will be appended for the
* Windows BAT file, if generated.
*/
private var file: Option[File] = None
/** The main class to run. */
private var mainClass: Option[String] = None
/** The name of this tool. Can only be set when a main class is defined,
* default this is equal to the file name.
*/
private var name: Option[String] = None
/** Supported platforms for the script. Either "unix" or "windows".
* Defaults to both.
*/
private var platforms: List[String] = Nil
/** The optional version number. If set, when "-version" is passed to the
* script, this value will be printed.
*/
private var version: String = ""
/** The optional copyright notice, that will be printed in the script. */
private var copyright: String = "This file is copyrighted by its owner"
/** The optional boot classpath */
private var bootclasspath: List[String] = Nil
/** An (optional) path to all JARs that this script depend on. Paths must be
* relative to the scala home directory. If not set, all JAR archives in
* "lib/" are automatically added.
*/
private var extclasspath: List[String] = Nil
/** Comma-separated Java system properties to pass to the JRE. Properties
* are formated as name=value. Properties scala.home, scala.tool.name and
* scala.tool.version are always set.
*/
private var properties: List[Pair[String,String]] = Nil
/** Additional flags passed to the JRE ("java [javaFlags] class"). */
private var javaFlags: String = ""
/** Additional flags passed to the tool ("java class [toolFlags]"). Can only
* be set when a main class is defined.
*/
private var toolFlags: String = ""
/*============================================================================*\
** Properties setters **
\*============================================================================*/
/** Sets the file attribute.
* Used by <a href="http://ant.apache.org/" target="_top">Ant</a>.
*
* @param input The value of <code>file</code>.
*/
def setFile(input: File) =
file = Some(input)
/** Sets the file attribute.
* Used by <a href="http://ant.apache.org/" target="_top">Ant</a>.
*
* @param input The value of <code>file</code>.
*/
def setName(input: String) =
name = Some(input)
/** Sets the main class attribute.
* Used by <a href="http://ant.apache.org/" target="_top">Ant</a>.
*
* @param input The value of <code>mainClass</code>.
*/
def setClass(input: String) =
mainClass = Some(input)
/** Sets the platforms attribute. Used by Ant.
*
* @param input The value for <code>platforms</code>.
*/
def setPlatforms(input: String) = {
platforms = List.fromArray(input.split(",")).flatMap { s: String =>
val st = s.trim()
if (Platforms.isPermissible(st))
(if (input != "") List(st) else Nil)
else {
error("Platform " + st + " does not exist.")
Nil
}
}
}
/** Sets the version attribute.
* Used by <a href="http://ant.apache.org/" target="_top">Ant</a>.
*
* @param input The value of <code>version</code>.
*/
def setVersion(input: String) =
version = input
/** Sets the copyright attribute.
* Used by <a href="http://ant.apache.org/" target="_top">Ant</a>.
*
* @param input The value of <code>copyright</code>.
*/
def setCopyright(input: String) =
copyright = input
/** Sets the boot classpath attribute.
* Used by <a href="http://ant.apache.org/" target="_top">Ant</a>.
*
* @param input The value of <code>bootclasspath</code>.
*/
def setBootclasspath(input: String) =
bootclasspath = bootclasspath ::: List.fromArray(input.split(":"))
/** Sets the extension classpath attribute.
* Used by <a href="http://ant.apache.org/" target="_top">Ant</a>.
*
* @param input The value of <code>extclasspath</code>.
*/
def setExtclasspath(input: String) =
extclasspath = extclasspath ::: List.fromArray(input.split(":"))
/** Sets the properties attribute.
* Used by <a href="http://ant.apache.org/" target="_top">Ant</a>.
*
* @param input The value for <code>properties</code>.
*/
def setProperties(input: String) = {
properties = List.fromArray(input.split(",")).flatMap { s: String =>
val st = s.trim(); val stArray = st.split("=", 2)
if (stArray.length == 2) {
if (input != "") List(Pair(stArray(0), stArray(1))) else Nil
} else error("Property " + st + " does not conform to specification.")
}
}
/** Sets the version attribute.
* Used by <a href="http://ant.apache.org/" target="_top">Ant</a>.
*
* @param input The value of <code>version</code>.
*/
def setJavaflags(input: String) =
javaFlags = input
/** Sets the version attribute.
* Used by <a href="http://ant.apache.org/" target="_top">Ant</a>.
*
* @param input The value of <code>version</code>.
*/
def setToolflags(input: String) =
toolFlags = input
/*============================================================================*\
** Properties getters **
\*============================================================================*/
/** Gets the value of the file attribute in a Scala-friendly form.
* @returns The file as a file. */
private def getFile: File =
if (file.isEmpty) error("Member 'file' is empty.")
else getProject().resolveFile(file.get.toString())
/** Gets the value of the bootclasspath attribute in a Scala-friendly form.
* @returns The boot class path as a list of files. */
private def getUnixBootClasspath: String =
bootclasspath.mkString("", ":", "")
/** Gets the value of the bootclasspath attribute in a Scala-friendly form.
* @returns The boot class path as a list of files. */
private def getWinBootClasspath: String =
bootclasspath.map(.replace('/', '\\')).
mkString("", ";", "")
/** Gets the value of the classpath attribute in a Scala-friendly form.
* @returns The class path as a list of files. */
private def getUnixExtClasspath: String =
extclasspath.mkString("", ":", "")
/** Gets the value of the classpath attribute in a Scala-friendly form.
* @returns The class path as a list of files. */
private def getWinExtClasspath: String =
extclasspath.map(.replace('/', '\\')).
mkString("", ";", "")
/** Gets the value of the classpath attribute in a Scala-friendly form.
* @returns The class path as a list of files. */
private def getProperties: String =
properties.map({
case Pair(name,value) => "-D" + name + "=\"" + value + "\""
}).mkString("", " ", "")
/*============================================================================*\
** Compilation and support methods **
\*============================================================================*/
/** Generates a build error. Error location will be the current task in the
* ant file.
* @param message A message describing the error.
* @throws BuildException A build error exception thrown in every case. */
private def error(message: String): Nothing =
throw new BuildException(message, getLocation())
private def readResource(resource: String,
tokens: Map[String, String]
): String = {
val chars = new Iterator[Char] {
private val stream =
this.getClass().getClassLoader().getResourceAsStream(resource)
private def readStream(): Char = stream.read().asInstanceOf[Char]
private var buf: Char = readStream()
def hasNext: Boolean = (buf != (-1.).asInstanceOf[Char])
def next: Char = {
val bufbuf = buf
buf = readStream()
bufbuf
}
}
val builder = new StringBuilder()
while (chars.hasNext) {
val char = chars.next
if (char == '@') {
var char = chars.next
val token = new StringBuilder()
while (chars.hasNext && char != '@') {
token.append(char)
char = chars.next
}
if (tokens.contains(token.toString()))
builder.append(tokens(token.toString()))
else if (token.toString() == "")
builder.append('@')
else
builder.append("@" + token.toString() + "@")
} else builder.append(char)
}
builder.toString()
}
private def writeFile(file: File, content: String) =
if (file.exists() && !file.canWrite())
error("File " + file + " is not writable")
else {
val writer = new FileWriter(file, false)
writer.write(content)
writer.close()
}
private def expandUnixVar(vars: Map[String,String]): Map[String,String] =
vars transform { (x, vari) => vari.replaceAll("#([^#]*)#", "\\$$1") }
private def expandWinVar(vars: Map[String,String]): Map[String,String] =
vars transform { (x, vari) => vari.replaceAll("#([^#]*)#", "%_$1%") }
private def pipeTemplate(template: String, patches: Map[String,String]) = {
val resourceRoot = "scala/tools/ant/templates/"
if (platforms.contains("unix")) {
val unixPatches = expandUnixVar(patches.
update("bootclasspath", getUnixBootClasspath).
update("extclasspath", getUnixExtClasspath))
val unixTemplateResource = resourceRoot + template + "-unix.tmpl"
val unixTemplate = readResource(unixTemplateResource, unixPatches)
writeFile(getFile, unixTemplate)
}
if (platforms.contains("windows")) {
val winPatches = expandWinVar(patches.
update("bootclasspath", getWinBootClasspath).
update("extclasspath", getWinExtClasspath))
val winTemplateResource = resourceRoot + template + "-windows.tmpl"
val winTemplate = readResource(winTemplateResource, winPatches)
writeFile(new File(getFile.getAbsolutePath() + ".bat"), winTemplate)
}
}
/*============================================================================*\
** The big execute method **
\*============================================================================*/
/** Performs the compilation. */
override def execute() = {
// Tests if all mandatory attributes are set and valid.
if (file.isEmpty) error("Attribute 'file' is not set.")
if (mainClass.isEmpty) error("Main class must be set.")
if (platforms.isEmpty) platforms = Platforms.values
if (name.isEmpty) name = Some(file.get.getName)
val patches = ListMap.empty.
update("name", name.get).
update("class", mainClass.get).
update("version", version).
update("copyright", copyright).
update("properties", getProperties).
update("javaflags", javaFlags).
update("toolflags", toolFlags)
pipeTemplate("tool", patches)
}
}
