* An Ant task to document Scala code. *
** This task can take the following parameters as attributes: *
** It also takes the following parameters as nested elements: *
*deprecation and
* unchecked properties.
*/
object Flag extends PermissibleValue {
val values = List("yes", "no", "on", "off")
}
/** The directories that contain source files to compile. */
private var origin: Option[Path] = None
/** The directory to put the compiled files in. */
private var destination: Option[File] = None
/** The class path to use for this compilation. */
private var classpath: Option[Path] = None
/** The source path to use for this compilation. */
private var sourcepath: Option[Path] = None
/** The boot class path to use for this compilation. */
private var bootclasspath: Option[Path] = None
/** The external extensions path to use for this compilation. */
private var extdirs: Option[Path] = None
/** The character encoding of the files to compile. */
private var encoding: Option[String] = None
/** The window title of the generated HTML documentation. */
private var windowtitle: Option[String] = None
/** The document title of the generated HTML documentation. */
private var documenttitle: Option[String] = None
/** Instruct the compiler to use additional parameters */
private var addParams: String = ""
/** Instruct the compiler to generate deprecation information. */
private var deprecation: Boolean = false
/** Instruct the compiler to generate unchecked information. */
private var unchecked: Boolean = false
/*============================================================================*\
** Properties setters **
\*============================================================================*/
/** Sets the srcdir attribute. Used by Ant.
*
* @param input The value of origin.
*/
def setSrcdir(input: Path) =
if (origin.isEmpty) origin = Some(input)
else origin.get.append(input)
/** Sets the origin as a nested src Ant parameter.
*
* @return An origin path to be configured.
*/
def createSrc(): Path = {
if (origin.isEmpty) origin = Some(new Path(getProject()))
origin.get.createPath()
}
/** Sets the origin as an external reference Ant parameter.
*
* @param input A reference to an origin path.
*/
def setSrcref(input: Reference) =
createSrc().setRefid(input)
/** Sets the destdir attribute. Used by Ant.
*
* @param input The value of destination.
*/
def setDestdir(input: File) =
destination = Some(input)
/** Sets the classpath attribute. Used by Ant.
*
* @param input The value of classpath.
*/
def setClasspath(input: Path) =
if (classpath.isEmpty) classpath = Some(input)
else classpath.get.append(input)
/** Sets the classpath as a nested classpath Ant parameter.
*
* @return A class path to be configured.
*/
def createClasspath(): Path = {
if (classpath.isEmpty) classpath = Some(new Path(getProject()))
classpath.get.createPath()
}
/** Sets the classpath as an external reference Ant parameter.
*
* @param input A reference to a class path.
*/
def setClasspathref(input: Reference) =
createClasspath().setRefid(input)
/** Sets the sourcepath attribute. Used by Ant.
*
* @param input The value of sourcepath.
*/
def setSourcepath(input: Path) =
if (sourcepath.isEmpty) sourcepath = Some(input)
else sourcepath.get.append(input)
/** Sets the sourcepath as a nested sourcepath Ant parameter.
*
* @return A source path to be configured.
*/
def createSourcepath(): Path = {
if (sourcepath.isEmpty) sourcepath = Some(new Path(getProject()))
sourcepath.get.createPath()
}
/** Sets the sourcepath as an external reference Ant parameter.
*
* @param input A reference to a source path.
*/
def setSourcepathref(input: Reference) =
createSourcepath().setRefid(input)
/** Sets the bootclasspath attribute. Used by Ant.
*
* @param input The value of bootclasspath.
*/
def setBootclasspath(input: Path) =
if (bootclasspath.isEmpty) bootclasspath = Some(input)
else bootclasspath.get.append(input)
/** Sets the bootclasspath as a nested sourcepath Ant
* parameter.
*
* @return A source path to be configured.
*/
def createBootclasspath(): Path = {
if (bootclasspath.isEmpty) bootclasspath = Some(new Path(getProject()))
bootclasspath.get.createPath()
}
/** Sets the bootclasspath as an external reference Ant
* parameter.
*
* @param input A reference to a source path.
*/
def setBootclasspathref(input: Reference) =
createBootclasspath().setRefid(input)
/** Sets the external extensions path attribute. Used by Ant.
*
* @param input The value of extdirs.
*/
def setExtdirs(input: Path): Unit =
if (extdirs.isEmpty) extdirs = Some(input)
else extdirs.get.append(input)
/** Sets the extdirs as a nested sourcepath Ant parameter.
*
* @return An extensions path to be configured.
*/
def createExtdirs(): Path = {
if (extdirs.isEmpty) extdirs = Some(new Path(getProject()))
extdirs.get.createPath()
}
/** Sets the extdirs as an external reference Ant parameter.
*
* @param input A reference to an extensions path.
*/
def setExtdirsref(input: Reference) =
createExtdirs().setRefid(input)
/** Sets the encoding attribute. Used by Ant.
*
* @param input The value of encoding.
*/
def setEncoding(input: String): Unit =
encoding = Some(input)
/** Sets the windowtitle attribute.
*
* @param input The value of windowtitle.
*/
def setWindowtitle(input: String): Unit =
windowtitle = Some(input)
/** Sets the documenttitle attribute.
*
* @param input The value of documenttitle.
*/
def setDocumenttitle(input: String): Unit =
documenttitle = Some(input)
/** Set the addparams info attribute.
*
* @param input The value for addparams.
*/
def setAddparams(input: String): Unit =
addParams = input
/** Set the deprecation info attribute.
*
* @param input One of the flags yes/no or on/off.
*/
def setDeprecation(input: String): Unit =
if (Flag.isPermissible(input))
deprecation = "yes".equals(input) || "on".equals(input)
else
error("Unknown deprecation flag '" + input + "'")
/** Set the unchecked info attribute.
*
* @param input One of the flags yes/no or on/off.
*/
def setUnchecked(input: String): Unit =
if (Flag.isPermissible(input))
unchecked = "yes".equals(input) || "on".equals(input)
else
error("Unknown unchecked flag '" + input + "'")
/*============================================================================*\
** Properties getters **
\*============================================================================*/
/** Gets the value of the classpath attribute in a
* Scala-friendly form.
*
* @return The class path as a list of files.
*/
private def getClasspath: List[File] =
if (classpath.isEmpty) error("Member 'classpath' is empty.")
else List.fromArray(classpath.get.list()).map(nameToFile)
/** Gets the value of the origin attribute in a Scala-friendly
* form.
*
* @return The origin path as a list of files.
*/
private def getOrigin: List[File] =
if (origin.isEmpty) error("Member 'origin' is empty.")
else List.fromArray(origin.get.list()).map(nameToFile)
/** Gets the value of the destination attribute in a
* Scala-friendly form.
*
* @return The destination as a file.
*/
private def getDestination: File =
if (destination.isEmpty) error("Member 'destination' is empty.")
else existing(getProject().resolveFile(destination.get.toString()))
/** Gets the value of the sourcepath attribute in a
* Scala-friendly form.
*
* @return The source path as a list of files.
*/
private def getSourcepath: List[File] =
if (sourcepath.isEmpty) error("Member 'sourcepath' is empty.")
else List.fromArray(sourcepath.get.list()).map(nameToFile)
/** Gets the value of the bootclasspath attribute in a
* Scala-friendly form.
*
* @return The boot class path as a list of files.
*/
private def getBootclasspath: List[File] =
if (bootclasspath.isEmpty) error("Member 'bootclasspath' is empty.")
else List.fromArray(bootclasspath.get.list()).map(nameToFile)
/** Gets the value of the extdirs attribute in a
* Scala-friendly form.
*
* @return The extensions path as a list of files.
*/
private def getExtdirs: List[File] =
if (extdirs.isEmpty) error("Member 'extdirs' is empty.")
else List.fromArray(extdirs.get.list()).map(nameToFile)
/*============================================================================*\
** Compilation and support methods **
\*============================================================================*/
/** This is forwarding method to circumvent bug #281 in Scala 2. Remove when
* bug has been corrected.
*/
override protected def getDirectoryScanner(baseDir: java.io.File) =
super.getDirectoryScanner(baseDir)
/** Transforms a string name into a file relative to the provided base
* directory.
*
* @param base A file pointing to the location relative to which the name
* will be resolved.
* @param name A relative or absolute path to the file as a string.
* @return A file created from the name and the base file.
*/
private def nameToFile(base: File)(name: String): File =
existing(fileUtils.resolveFile(base, name))
/** Transforms a string name into a file relative to the build root
* directory.
*
* @param name A relative or absolute path to the file as a string.
* @return A file created from the name.
*/
private def nameToFile(name: String): File =
existing(getProject().resolveFile(name))
/** Tests if a file exists and prints a warning in case it doesn't. Always
* returns the file, even if it doesn't exist.
*
* @param file A file to test for existance.
* @return The same file.
*/
private def existing(file: File): File = {
if (!file.exists())
log("Element '" + file.toString() + "' does not exist.",
Project.MSG_WARN)
file
}
/** Transforms a path into a Scalac-readable string.
*
* @param path A path to convert.
* @return A string-representation of the path like a.jar:b.jar.
*/
private def asString(path: List[File]): String =
path.map(asString).mkString("", File.pathSeparator, "")
/** Transforms a file into a Scalac-readable string.
*
* @param path A file to convert.
* @return A string-representation of the file like /x/k/a.scala.
*/
private def asString(file: File): String =
file.getAbsolutePath()
/** 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())
/*============================================================================*\
** The big execute method **
\*============================================================================*/
/** Initializes settings and source files */
protected def initialize: Pair[Settings, List[File]] = {
// Tests if all mandatory attributes are set and valid.
if (origin.isEmpty) error("Attribute 'srcdir' is not set.")
if (getOrigin.isEmpty) error("Attribute 'srcdir' is not set.")
if (!destination.isEmpty && !destination.get.isDirectory())
error("Attribute 'destdir' does not refer to an existing directory.")
if (destination.isEmpty) destination = Some(getOrigin.head)
val mapper = new GlobPatternMapper()
mapper.setTo("*.html")
mapper.setFrom("*.scala")
// Scans source directories to build up a compile lists.
// If force is false, only files were the .class file in destination is
// older than the .scala file will be used.
val sourceFiles: List[File] =
for {
val originDir <- getOrigin
val originFile <- {
val includedFiles =
getDirectoryScanner(originDir).getIncludedFiles()
val list = List.fromArray(includedFiles)
if (list.length > 0)
log(
"Documenting " + list.length + " source file" +
(if (list.length > 1) "s" else "") +
(" to " + getDestination.toString())
)
else
log("No files selected for documentation", Project.MSG_VERBOSE)
list
}
} yield {
log(originFile.toString(), Project.MSG_DEBUG)
nameToFile(originDir)(originFile)
}
// Builds-up the compilation settings for Scalac with the existing Ant
// parameters.
val settings = new Settings(error)
settings.doc.value = true
settings.outdir.value = asString(destination.get)
if (!classpath.isEmpty)
settings.classpath.value = asString(getClasspath)
if (!sourcepath.isEmpty)
settings.sourcepath.value = asString(getSourcepath)
/*else if (origin.get.size() > 0)
settings.sourcepath.value = origin.get.list()(0)*/
if (!bootclasspath.isEmpty)
settings.bootclasspath.value = asString(getBootclasspath)
if (!extdirs.isEmpty) settings.extdirs.value = asString(getExtdirs)
if (!encoding.isEmpty) settings.encoding.value = encoding.get
if (!windowtitle.isEmpty) settings.windowtitle.value = windowtitle.get
if (!documenttitle.isEmpty) settings.documenttitle.value =
// In Ant script characters '<' and '>' must be encoded when
// used in attribute values, e.g. for attribute "documenttitle"
// in task Scaladoc you may write:
// documenttitle="<div>Scala</div>"
// so we have to decode them here.
documenttitle.get.replaceAll("<", "<").replaceAll(">",">")
.replaceAll("&", "&").replaceAll(""", "\"")
settings.deprecation.value = deprecation
settings.unchecked.value = unchecked
log("Scaladoc params = '" + addParams + "'", Project.MSG_DEBUG)
var args =
if (addParams.trim() == "") Nil
else List.fromArray(addParams.trim().split(" ")).map(.trim())
while (!args.isEmpty) {
val argsBuf = args
if (args.head startsWith "-") {
for (val setting <- settings.allSettings)
args = setting.tryToSet(args);
} else error("Parameter '" + args.head + "' does not start with '-'.")
if (argsBuf eq args)
error("Parameter '" + args.head + "' is not recognised by Scaladoc.")
}
Pair(settings, sourceFiles)
}
/** Performs the compilation. */
override def execute() = {
val Pair(settings, sourceFiles) = initialize
val reporter = new ConsoleReporter(settings)
// Compiles the actual code
val compiler = new Global(settings, reporter)
try {
val run = new compiler.Run
run.compile(sourceFiles.map (.toString()))
object generator extends DocDriver {
val global: compiler.type = compiler
def outdir = settings.outdir.value
def windowTitle = settings.windowtitle.value
def documentTitle = settings.documenttitle.value
}
generator.process(run.units)
if (reporter.errors > 0)
error(
"Document failed with " +
reporter.errors + " error" +
(if (reporter.errors > 1) "s" else "") +
"; see the documenter error output for details.")
else if (reporter.warnings > 0)
log(
"Document succeeded with " +
reporter.warnings + " warning" +
(if (reporter.warnings > 1) "s" else "") +
"; see the documenter output for details.")
reporter.printSummary()
} catch {
case exception: Throwable if (exception.getMessage ne null) =>
exception.printStackTrace()
error("Document failed because of an internal documenter error (" +
exception.getMessage + "); see the error output for details.")
case exception =>
exception.printStackTrace()
error("Document failed because of an internal documenter error " +
"(no error message provided); see the error output for details.")
}
}
}