From 3475351c461b833ebd5841b9af829b975e0c3657 Mon Sep 17 00:00:00 2001 From: michelou Date: Wed, 18 Oct 2006 13:48:28 +0000 Subject: added Ant/Eclipse classes in nsc/doc/script.js --- src/compiler/scala/tools/ant/Scalac.scala | 284 ++++++++++++++++++----------- src/compiler/scala/tools/nsc/doc/script.js | 161 +++++++++++----- 2 files changed, 291 insertions(+), 154 deletions(-) (limited to 'src') diff --git a/src/compiler/scala/tools/ant/Scalac.scala b/src/compiler/scala/tools/ant/Scalac.scala index 7a3d233aba..14ee20340a 100644 --- a/src/compiler/scala/tools/ant/Scalac.scala +++ b/src/compiler/scala/tools/ant/Scalac.scala @@ -8,7 +8,6 @@ package scala.tools.ant { - import java.io.File import java.net.{URL, URLClassLoader} import java.util.{ArrayList, Vector} @@ -24,37 +23,46 @@ package scala.tools.ant { import scala.tools.nsc.reporters.{Reporter, ConsoleReporter} import scala.tools.nsc.{Global, FatalError, Settings} - /** An Ant task to compile with the new Scala compiler (NSC). - * This task can take the following parameters as attributes: - * It also takes the following parameters as nested elements: - * - * @author Gilles Dubochet */ + /**

+ * An Ant task to compile with the new Scala compiler (NSC). + *

+ *

+ * This task can take the following parameters as attributes: + *

+ * + *

+ * It also takes the following parameters as nested elements: + *

+ * + * + * @author Gilles Dubochet + */ class Scalac extends MatchingTask { private val SCALA_PRODUCT: String = @@ -65,9 +73,9 @@ package scala.tools.ant { /** 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] @@ -131,66 +139,86 @@ package scala.tools.ant { * in case of failure. */ private var scalacDebugging: Boolean = false -/******************************************************************************\ +/*============================================================================*\ ** Properties setters ** -\******************************************************************************/ +\*============================================================================*/ /** Sets the srcdir attribute. Used by Ant. - * @param input The value of origin. */ + * + * @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. */ + * + * @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. */ + * + * @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. */ + /** 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. */ + /** 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. */ + * + * @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. */ + * + * @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. */ + /** 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. */ + * + * @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. */ + * + * @param input A reference to a source path. + */ def setSourcepathref(input: Reference) = createSourcepath().setRefid(input) @@ -209,45 +237,63 @@ package scala.tools.ant { } /** Sets the bootclasspath as an external reference Ant - * parameter. - * @param input A reference to a source path. */ + * 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. */ + * + * @param input The value of extdirs. + */ def setExtdirs(input: Path) = 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. */ + * + * @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. */ + * + * @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. */ + /** Sets the encoding attribute. Used by Ant. + * + * @param input The value of encoding. + */ def setEncoding(input: String): Unit = encoding = Some(input) + /** Sets the target attribute. Used by Ant. + * + * @param input The value for target. + */ def setTarget(input: String): Unit = if (Target.isPermissible(input)) backend = Some(input) else error("Unknown target '" + input + "'") - /** Sets the force attribute. Used by Ant. - * @param input The value for force. */ + /** Sets the force attribute. Used by Ant. + * + * @param input The value for force. + */ def setForce(input: Boolean): Unit = force = input /** Sets the logging level attribute. Used by Ant. - * @param input The value for logging. */ + * + * @param input The value for logging. + */ def setLogging(input: String) = if (LoggingLevel.isPermissible(input)) logging = Some(input) else error("Logging level '" + input + "' does not exist.") @@ -283,76 +329,97 @@ package scala.tools.ant { def setScalacdebugging(input: Boolean): Unit = scalacDebugging = input -/******************************************************************************\ +/*============================================================================*\ ** Properties getters ** -\******************************************************************************/ +\*============================================================================*/ - /** Gets the value of the classpath attribute in a Scala-friendly form. - * @returns The class path as a list of files. */ + /** 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) + else List.fromArray(classpath.get.list()).map(nameToFile) - /** Gets the value of the origin attribute in a Scala-friendly form. - * @returns The origin path as a list of files. */ + /** 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. - * @returns The destination as a file. */ + /** 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. - * @returns The source path as a list of files. */ + /** 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. - * @returns The boot class path as a list of files. */ + /** 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. - * @returns The extensions path as a list of files. */ + * + * @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) = + * bug has been corrected. + */ + override protected def getDirectoryScanner(baseDir: 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. */ + * 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. */ + * 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. */ + * 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.", @@ -361,27 +428,33 @@ package scala.tools.ant { } /** 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'. */ + * + * @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'. */ + * + * @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. */ + * 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 ** -\******************************************************************************/ +\*============================================================================*/ /** Performs the compilation. */ override def execute() = { @@ -459,8 +532,8 @@ package scala.tools.ant { settings.debug.value = true } if (!logPhase.isEmpty) settings.log.value = logPhase - settings.nopredefs.value = !usepredefs; - settings.debuginfo.value = debugInfo; + settings.nopredefs.value = !usepredefs + settings.debuginfo.value = debugInfo log("Scalac params = '" + addParams + "'", Project.MSG_DEBUG) var args = @@ -492,20 +565,17 @@ package scala.tools.ant { } reporter.printSummary() if (reporter.errors > 0) { - error ( + error( "Compile failed with " + reporter.errors + " error" + (if (reporter.errors > 1) "s" else "") + - "; see the compiler error output for details." - ) + "; see the compiler error output for details.") } else if (reporter.warnings > 0) - log ( + log( "Compile suceeded with " + reporter.warnings + " warning" + (if (reporter.warnings > 1) "s" else "") + - "; see the compiler output for details." - ) - + "; see the compiler output for details.") } } diff --git a/src/compiler/scala/tools/nsc/doc/script.js b/src/compiler/scala/tools/nsc/doc/script.js index a63d6834f8..480e415221 100644 --- a/src/compiler/scala/tools/nsc/doc/script.js +++ b/src/compiler/scala/tools/nsc/doc/script.js @@ -1,62 +1,129 @@ -- cgit v1.2.3