SI-8538 Document extension

Scaladoc for report extension point.

2 files changed, 44 insertions, 3 deletions

diff --git a/src/library/scala/io/Source.scala b/src/library/scala/io/Source.scala
index 74c3e06839..9f0b56b4fe 100644
--- a/src/library/scala/io/Source.scala
+++ b/src/library/scala/io/Source.scala
@@ -169,9 +169,20 @@ object Source {
     createBufferedSource(is, reset = () => fromInputStream(is)(codec), close = () => is.close())(codec)
 }
 
-/** The class `Source` implements an iterable representation of source data.
- *  Calling method `reset` returns an identical, resetted source, where
- *  possible.
+/** An iterable representation of source data.
+ *  It may be reset with the optional `reset` method.
+ *
+ *  Subclasses must supply [[scala.io.Source@iter the underlying iterator]].
+ *
+ *  Error handling may be customized by overriding the [[scala.io.Source@report report]] method.
+ *
+ *  The [[scala.io.Source@ch current input]] and [[scala.io.Source@pos position]],
+ *  as well as the [[scala.io.Source@next next character]] methods delegate to
+ *  [[scala.io.Source$Positioner the positioner]].
+ *
+ *  The default positioner encodes line and column numbers in the position passed to `report`.
+ *  This behavior can be changed by supplying a
+ *  [[scala.io.Source@withPositioning(pos:Source.this.Positioner):Source.this.type custom positioner]].
  *
  *  @author  Burak Emir
  *  @version 1.0
diff --git a/test/junit/scala/io/SourceTest.scala b/test/junit/scala/io/SourceTest.scala
index efe081f844..3138a4589c 100644
--- a/test/junit/scala/io/SourceTest.scala
+++ b/test/junit/scala/io/SourceTest.scala
@@ -53,4 +53,34 @@ class SourceTest {
     s.reportError(s.pos, "That doesn't sound right.", ps)
     assertEquals("0030: THAT DOESN'T SOUND RIGHT.", out.toString(charSet))
   }
+  @Test def canAltCustomizeReporting() = {
+    class CapitalReporting(is: InputStream)(implicit codec: Codec) extends Source {
+      override val iter = {
+        val r = new InputStreamReader(is, codec.decoder)
+        Iterator continually (codec wrap r.read()) takeWhile (_ != -1) map (_.toChar)
+      }
+      override def report(pos: Int, msg: String, out: PrintStream): Unit = {
+        out print f"$pos%04x: ${msg.toUpperCase}"
+      }
+      private[this] var _pos: Int = _
+      override def pos = _pos
+      private[this] var _ch: Char = _
+      override def ch = _ch
+      override def next = {
+        _ch = iter.next()
+        _pos += 1
+        _ch
+      }
+    }
+    val s = new CapitalReporting(in)
+    // skip to next line and report an error
+    do {
+      val c = s.next()
+    } while (s.ch != '\n')
+    s.next()
+    val out = new ByteArrayOutputStream
+    val ps  = new PrintStream(out, true, charSet)
+    s.reportError(s.pos, "That doesn't sound right.", ps)
+    assertEquals("0030: THAT DOESN'T SOUND RIGHT.", out.toString(charSet))
+  }
 }