From b7ccb47d14f79b4c15611acfb515763fbbab4c93 Mon Sep 17 00:00:00 2001 From: michelou Date: Tue, 17 Oct 2006 13:19:28 +0000 Subject: fixed bug #773 (scaladoc) --- src/compiler/scala/tools/ant/Scaladoc.scala | 322 ++++++++++++--------- .../scala/tools/nsc/doc/DocGenerator.scala | 38 +-- 2 files changed, 198 insertions(+), 162 deletions(-) (limited to 'src') diff --git a/src/compiler/scala/tools/ant/Scaladoc.scala b/src/compiler/scala/tools/ant/Scaladoc.scala index 5940b900d0..9d58b84f4c 100644 --- a/src/compiler/scala/tools/ant/Scaladoc.scala +++ b/src/compiler/scala/tools/ant/Scaladoc.scala @@ -9,7 +9,6 @@ package scala.tools.ant { - import java.io.{File, InputStream, FileWriter} import java.net.{URL, URLClassLoader} import java.util.{ArrayList, Vector} @@ -22,45 +21,53 @@ package scala.tools.ant { SourceFileScanner} import org.apache.tools.ant.types.{EnumeratedAttribute, Reference} - import scala.tools.nsc.reporters.{Reporter, ConsoleReporter} import scala.tools.nsc.{Global, FatalError, Settings} import scala.tools.nsc.doc.DocGenerator + import scala.tools.nsc.reporters.{Reporter, ConsoleReporter} - /** 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: - * - * @author Gilles Dubochet, Stephane Micheloud - */ + /**

+ * 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: + *

+ * + * + * @author Gilles Dubochet, Stephane Micheloud + */ class Scaladoc extends MatchingTask { /** The unique Ant file utilities instance to use in this task. */ private val fileUtils = FileUtils.newFileUtils() -/******************************************************************************\ +/*============================================================================*\ ** Ant user-properties ** -\******************************************************************************/ +\*============================================================================*/ /** The directories that contain source files to compile. */ private var origin: Option[Path] = None @@ -84,165 +91,221 @@ package scala.tools.ant { /** The document title of the generated HTML documentation. */ private var documenttitle: Option[String] = None -/******************************************************************************\ +/*============================================================================*\ ** Properties setters ** -\******************************************************************************/ +\*============================================================================*/ - /** Sets the srcdir attribute. Used by Ant. - * @param input The value of origin. */ + /** 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. */ + * + * @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) - /** Sets the boot classpath attribute. Used by Ant. - * @param input The value of bootclasspath. */ + /** 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. */ + * 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. */ + * 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) = + * + * @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. */ + * + * @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. */ + * + * @param input The value of encoding. + */ def setEncoding(input: String): Unit = encoding = Some(input) /** Sets the windowtitle attribute. - * @param input The value of windowtitle. */ + * + * @param input The value of windowtitle. + */ def setWindowtitle(input: String): Unit = windowtitle = Some(input) /** Sets the documenttitle attribute. - * @param input The value of documenttitle. */ + * + * @param input The value of documenttitle. + */ def setDocumenttitle(input: String): Unit = documenttitle = Some(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) - /** 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. */ + 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. */ @@ -250,25 +313,31 @@ package scala.tools.ant { 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.", @@ -277,56 +346,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()) - private def readResource(resource: 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 StringBuffer() - while (chars.hasNext) { - builder.append(chars.next) - } - 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() - } - -/******************************************************************************\ +/*============================================================================*\ ** The big execute method ** -\******************************************************************************/ +\*============================================================================*/ /** Performs the compilation. */ override def execute() = { @@ -346,7 +392,7 @@ package scala.tools.ant { // older than the .scala file will be used. val sourceFiles: List[File] = for { - val originDir <- getOrigin; + val originDir <- getOrigin val originFile <- { val includedFiles = getDirectoryScanner(originDir).getIncludedFiles() @@ -406,19 +452,17 @@ package scala.tools.ant { } generator.process(run.units) if (reporter.errors > 0) - error ( + error( "Document failed with " + reporter.errors + " error" + (if (reporter.errors > 1) "s" else "") + - "; see the documenter error output for details." - ) + "; see the documenter error output for details.") else if (reporter.warnings > 0) - log ( + log( "Document suceeded with " + reporter.warnings + " warning" + (if (reporter.warnings > 1) "s" else "") + - "; see the documenter output for details." - ) + "; see the documenter output for details.") reporter.printSummary() } catch { case exception: Throwable if (exception.getMessage != null) => @@ -430,14 +474,6 @@ package scala.tools.ant { error("Document failed because of an internal documenter error " + "(no error message provided); see the error output for details.") } - writeFile( - new File(settings.outdir.value, "script.js"), - readResource("scala/tools/ant/resources/script.js") - ) - writeFile( - new File(settings.outdir.value, "style.css"), - readResource("scala/tools/ant/resources/style.css") - ) } } diff --git a/src/compiler/scala/tools/nsc/doc/DocGenerator.scala b/src/compiler/scala/tools/nsc/doc/DocGenerator.scala index 5bf30e518e..c8508bf90e 100644 --- a/src/compiler/scala/tools/nsc/doc/DocGenerator.scala +++ b/src/compiler/scala/tools/nsc/doc/DocGenerator.scala @@ -224,7 +224,7 @@ abstract class DocGenerator extends Models { abstract class ContentFrame0 extends Frame { - def extendsFor(mmbr: HasTree): NodeSeq = mmbr match { + private def extendsFor(mmbr: HasTree): NodeSeq = mmbr match { case mmbr: ImplMod => if (!mmbr.treey.impl.parents.isEmpty)
{Text(" extends ")} @@ -538,7 +538,7 @@ abstract class DocGenerator extends Models { // {aref("help.html" , "_self", "Help" )} // {aref("root-page.html", "_self", "Overview")} // {aref("index.html" , null, "Index" )} - def navigation: NodeSeq = + private def navigation: NodeSeq =
@@ -552,7 +552,7 @@ abstract class DocGenerator extends Models {
; - def header0: NodeSeq = + private def header0: NodeSeq =
in {aref(urlFor(clazz.tree.symbol.owner), "_self", clazz.tree.symbol.owner.fullNameString('.'))}
{Text(codeFor(kind))} @@ -576,7 +576,7 @@ abstract class DocGenerator extends Models { def process(units: Iterator[CompilationUnit]): Unit = { var members = emptyMap - var topLevel = ListMap.Empty[ModuleClassSymbol,ListMap[Kind,TreeSet[HasTree]]] + var topLevel = ListMap.Empty[ModuleClassSymbol, ListMap[Kind,TreeSet[HasTree]]] for (val unit <- units) { val sourceMod = new SourceMod(unit) for (val mmbr <- sourceMod.members) mmbr.tree match { @@ -669,21 +669,21 @@ abstract class DocGenerator extends Models { } val rsrcdir = "scala/tools/nsc/doc/".replace('/', File.separatorChar) for (val base <- List("style.css", "script.js")) { - val input = loader.getResourceAsStream(rsrcdir + base) - if (input != null) { - val file = new File(outdir + File.separator + base) - val output = new FileOutputStream(file) - var break = false - val bytes = new Array[byte](1024) - while (!break) { - val read = input.read(bytes) - if (read == -1) break = true - else output.write(bytes, 0, read) + try { + val in = loader.getResourceAsStream(rsrcdir + base) + val out = new FileOutputStream(new File(outdir + File.separator + base)) + val buf = new Array[byte](1024) + var len = 0 + while (len != -1) { + out.write(buf, 0, len) + len = in.read(buf) } - input.close() - output.close() - } else - error("Resource file '" + base + "' not found") + in.close() + out.close() + } catch { + case _ => + error("Resource file '" + base + "' not found") + } } } @@ -751,7 +751,7 @@ abstract class DocGenerator extends Models { private val pat2 = Pattern.compile( "[ \t]*@(exception|param|throws)[ \t]+(\\p{Alnum}*)[ \t]*(.*)") - def comment(comment: String, isShort: Boolean): NodeSeq = { + private def comment(comment: String, isShort: Boolean): NodeSeq = { var ret: List[Node] = Nil assert(comment != null) // strip out any stars. -- cgit v1.2.3