1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
|
/* __ *\
** ________ ___ / / ___ Scala Ant Tasks **
** / __/ __// _ | / / / _ | (c) 2005-2007, LAMP/EPFL **
** __\ \/ /__/ __ |/ /__/ __ | http://scala-lang.org/ **
** /____/\___/_/ |_/____/_/ | | **
** |/ **
\* */
// $Id$
package scala.tools.ant
import java.io.File
import org.apache.tools.ant.{BuildException, Project}
import org.apache.tools.ant.taskdefs.MatchingTask
import org.apache.tools.ant.types.{Path, Reference}
import org.apache.tools.ant.util.{FileUtils, GlobPatternMapper}
import scala.tools.nsc.{Global, Settings}
import scala.tools.nsc.doc.DocDriver
import scala.tools.nsc.reporters.{Reporter, ConsoleReporter}
/** <p>
* An Ant task to document Scala code.
* </p>
* <p>
* This task can take the following parameters as attributes:
* </p>
* <ul>
* <li>srcdir (mandatory),</li>
* <li>srcref,</li>
* <li>destdir,</li>
* <li>classpath,</li>
* <li>classpathref,</li>
* <li>sourcepath,</li>
* <li>sourcepathref,</li>
* <li>bootclasspath,</li>
* <li>bootclasspathref,</li>
* <li>extdirs,</li>
* <li>extdirsref,</li>
* <li>encoding,</li>
* <li>windowtitle,</li>
* <li>documenttitle,</li>
* <li>addparams,</li>
* <li>deprecation,</li>
* <li>unchecked.</li>
* </ul>
* <p>
* It also takes the following parameters as nested elements:
* </p>
* <ul>
* <li>src (for srcdir),</li>
* <li>classpath,</li>
* <li>sourcepath,</li>
* <li>bootclasspath,</li>
* <li>extdirs.</li>
* </ul>
*
* @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 **
\*============================================================================*/
abstract class PermissibleValue {
val values: List[String]
def isPermissible(value: String): Boolean =
(value == "") || values.exists(.startsWith(value))
}
/** Defines valid values for the <code>deprecation</code> and
* <code>unchecked</code> 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 <code>srcdir</code> attribute. Used by Ant.
*
* @param input The value of <code>origin</code>.
*/
def setSrcdir(input: Path) =
if (origin.isEmpty) origin = Some(input)
else origin.get.append(input)
/** Sets the <code>origin</code> 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 <code>origin</code> as an external reference Ant parameter.
*
* @param input A reference to an origin path.
*/
def setSrcref(input: Reference) =
createSrc().setRefid(input)
/** Sets the <code>destdir</code> attribute. Used by Ant.
*
* @param input The value of <code>destination</code>.
*/
def setDestdir(input: File) =
destination = Some(input)
/** Sets the <code>classpath</code> attribute. Used by Ant.
*
* @param input The value of <code>classpath</code>.
*/
def setClasspath(input: Path) =
if (classpath.isEmpty) classpath = Some(input)
else classpath.get.append(input)
/** Sets the <code>classpath</code> 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 <code>classpath</code> as an external reference Ant parameter.
*
* @param input A reference to a class path.
*/
def setClasspathref(input: Reference) =
createClasspath().setRefid(input)
/** Sets the <code>sourcepath</code> attribute. Used by Ant.
*
* @param input The value of <code>sourcepath</code>.
*/
def setSourcepath(input: Path) =
if (sourcepath.isEmpty) sourcepath = Some(input)
else sourcepath.get.append(input)
/** Sets the <code>sourcepath</code> 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 <code>sourcepath</code> as an external reference Ant parameter.
*
* @param input A reference to a source path.
*/
def setSourcepathref(input: Reference) =
createSourcepath().setRefid(input)
/** Sets the <code>bootclasspath</code> attribute. Used by Ant.
*
* @param input The value of <code>bootclasspath</code>.
*/
def setBootclasspath(input: Path) =
if (bootclasspath.isEmpty) bootclasspath = Some(input)
else bootclasspath.get.append(input)
/** Sets the <code>bootclasspath</code> 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 <code>bootclasspath</code> 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 <code>extdirs</code>.
*/
def setExtdirs(input: Path): Unit =
if (extdirs.isEmpty) extdirs = Some(input)
else extdirs.get.append(input)
/** Sets the <code>extdirs</code> 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 <code>extdirs</code> as an external reference Ant parameter.
*
* @param input A reference to an extensions path.
*/
def setExtdirsref(input: Reference) =
createExtdirs().setRefid(input)
/** Sets the <code>encoding</code> attribute. Used by Ant.
*
* @param input The value of <code>encoding</code>.
*/
def setEncoding(input: String): Unit =
encoding = Some(input)
/** Sets the <code>windowtitle</code> attribute.
*
* @param input The value of <code>windowtitle</code>.
*/
def setWindowtitle(input: String): Unit =
windowtitle = Some(input)
/** Sets the <code>documenttitle</code> attribute.
*
* @param input The value of <code>documenttitle</code>.
*/
def setDocumenttitle(input: String): Unit =
documenttitle = Some(input)
/** Set the <code>addparams</code> info attribute.
*
* @param input The value for <code>addparams</code>.
*/
def setAddparams(input: String): Unit =
addParams = input
/** Set the <code>deprecation</code> info attribute.
*
* @param input One of the flags <code>yes/no</code> or <code>on/off</code>.
*/
def setDeprecation(input: String): Unit =
if (Flag.isPermissible(input))
deprecation = "yes".equals(input) || "on".equals(input)
else
error("Unknown deprecation flag '" + input + "'")
/** Set the <code>unchecked</code> info attribute.
*
* @param input One of the flags <code>yes/no</code> or <code>on/off</code>.
*/
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 <code>classpath</code> 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 <code>origin</code> 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 <code>destination</code> 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 <code>sourcepath</code> 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 <code>bootclasspath</code> 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 <code>extdirs</code> 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 <code>a.jar:b.jar</code>.
*/
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 <code>/x/k/a.scala</code>.
*/
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 {
originDir <- getOrigin
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 (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.ERROR.count > 0)
error(
"Document failed with " +
reporter.ERROR.count + " error" +
(if (reporter.ERROR.count > 1) "s" else "") +
"; see the documenter error output for details.")
else if (reporter.WARNING.count > 0)
log(
"Document succeeded with " +
reporter.WARNING.count + " warning" +
(if (reporter.WARNING.count > 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.")
}
}
}
|