Filter out sampleStart/End from Knit-generated source files

Author: elizarov

knit/src/Knit.kt

@@ -36,6 +36,9 @@ const val INDEX_DIRECTIVE = "INDEX"
 const val CODE_START = "```kotlin"
 const val CODE_END = "```"
 
+const val SAMPLE_START = "//sampleStart"
+const val SAMPLE_END = "//sampleEnd"
+
 const val TEST_START = "```text"
 const val TEST_END = "```"
 
@@ -183,7 +186,9 @@ fun knit(markdownFile: File): Boolean {
             if (inLine.startsWith(CODE_START)) {
                 require(testOut == null || testLines.isEmpty()) { "Previous test was not emitted with $TEST_DIRECTIVE" }
                 codeLines += ""
-                readUntilTo(CODE_END, codeLines)
+                readUntilTo(CODE_END, codeLines) { line ->
+                    !line.startsWith(SAMPLE_START) && !line.startsWith(SAMPLE_END)
+                }
                 continue@mainLoop
             }
             if (inLine.startsWith(TEST_START)) {
@@ -328,11 +333,11 @@ private fun flushTestOut(parentDir: File?, testOut: String?, testOutLines: Mutab
 private fun MarkdownTextReader.readUntil(marker: String): List<String> =
     arrayListOf<String>().also { readUntilTo(marker, it) }
 
-private fun MarkdownTextReader.readUntilTo(marker: String, list: MutableList<String>) {
+private fun MarkdownTextReader.readUntilTo(marker: String, list: MutableList<String>, linePredicate: (String) -> Boolean = { true }) {
     while (true) {
         val line = readLine() ?: break
         if (line.startsWith(marker)) break
-        list += line
+        if (linePredicate(line)) list += line
     }
 }
 

kotlinx-coroutines-core/jvm/test/guide/example-basic-03.kt

@@ -8,12 +8,10 @@ package kotlinx.coroutines.guide.basic03
 import kotlinx.coroutines.*
 
 fun main() = runBlocking {
-//sampleStart
     val job = GlobalScope.launch { // launch a new coroutine and keep a reference to its Job
         delay(1000L)
         println("World!")
     }
     println("Hello,")
     job.join() // wait until child coroutine completes
-//sampleEnd    
 }

kotlinx-coroutines-core/jvm/test/guide/example-basic-07.kt

@@ -8,13 +8,11 @@ package kotlinx.coroutines.guide.basic07
 import kotlinx.coroutines.*
 
 fun main() = runBlocking {
-//sampleStart
     GlobalScope.launch {
         repeat(1000) { i ->
             println("I'm sleeping $i ...")
             delay(500L)
         }
     }
     delay(1300L) // just quit after delay
-//sampleEnd    
 }

kotlinx-coroutines-core/jvm/test/guide/example-cancel-01.kt

@@ -8,7 +8,6 @@ package kotlinx.coroutines.guide.cancel01
 import kotlinx.coroutines.*
 
 fun main() = runBlocking {
-//sampleStart
     val job = launch {
         repeat(1000) { i ->
             println("job: I'm sleeping $i ...")
@@ -20,5 +19,4 @@ fun main() = runBlocking {
     job.cancel() // cancels the job
     job.join() // waits for job's completion 
     println("main: Now I can quit.")
-//sampleEnd    
 }

kotlinx-coroutines-core/jvm/test/guide/example-cancel-02.kt

@@ -8,7 +8,6 @@ package kotlinx.coroutines.guide.cancel02
 import kotlinx.coroutines.*
 
 fun main() = runBlocking {
-//sampleStart
     val startTime = currentTimeMillis()
     val job = launch(Dispatchers.Default) {
         var nextPrintTime = startTime
@@ -25,5 +24,4 @@ fun main() = runBlocking {
     println("main: I'm tired of waiting!")
     job.cancelAndJoin() // cancels the job and waits for its completion
     println("main: Now I can quit.")
-//sampleEnd    
 }

kotlinx-coroutines-core/jvm/test/guide/example-cancel-03.kt

@@ -8,7 +8,6 @@ package kotlinx.coroutines.guide.cancel03
 import kotlinx.coroutines.*
 
 fun main() = runBlocking {
-//sampleStart
     val startTime = currentTimeMillis()
     val job = launch(Dispatchers.Default) {
         var nextPrintTime = startTime
@@ -25,5 +24,4 @@ fun main() = runBlocking {
     println("main: I'm tired of waiting!")
     job.cancelAndJoin() // cancels the job and waits for its completion
     println("main: Now I can quit.")
-//sampleEnd    
 }

kotlinx-coroutines-core/jvm/test/guide/example-cancel-04.kt

@@ -8,7 +8,6 @@ package kotlinx.coroutines.guide.cancel04
 import kotlinx.coroutines.*
 
 fun main() = runBlocking {
-//sampleStart
     val job = launch {
         try {
             repeat(1000) { i ->
@@ -23,5 +22,4 @@ fun main() = runBlocking {
     println("main: I'm tired of waiting!")
     job.cancelAndJoin() // cancels the job and waits for its completion
     println("main: Now I can quit.")
-//sampleEnd    
 }

kotlinx-coroutines-core/jvm/test/guide/example-cancel-05.kt

@@ -8,7 +8,6 @@ package kotlinx.coroutines.guide.cancel05
 import kotlinx.coroutines.*
 
 fun main() = runBlocking {
-//sampleStart
     val job = launch {
         try {
             repeat(1000) { i ->
@@ -27,5 +26,4 @@ fun main() = runBlocking {
     println("main: I'm tired of waiting!")
     job.cancelAndJoin() // cancels the job and waits for its completion
     println("main: Now I can quit.")
-//sampleEnd    
 }

kotlinx-coroutines-core/jvm/test/guide/example-cancel-06.kt

@@ -8,12 +8,10 @@ package kotlinx.coroutines.guide.cancel06
 import kotlinx.coroutines.*
 
 fun main() = runBlocking {
-//sampleStart
     withTimeout(1300L) {
         repeat(1000) { i ->
             println("I'm sleeping $i ...")
             delay(500L)
         }
     }
-//sampleEnd
 }

kotlinx-coroutines-core/jvm/test/guide/example-cancel-07.kt

@@ -8,7 +8,6 @@ package kotlinx.coroutines.guide.cancel07
 import kotlinx.coroutines.*
 
 fun main() = runBlocking {
-//sampleStart
     val result = withTimeoutOrNull(1300L) {
         repeat(1000) { i ->
             println("I'm sleeping $i ...")
@@ -17,5 +16,4 @@ fun main() = runBlocking {
         "Done" // will get cancelled before it produces this result
     }
     println("Result is $result")
-//sampleEnd
 }

kotlinx-coroutines-core/jvm/test/guide/example-channel-01.kt

@@ -9,7 +9,6 @@ import kotlinx.coroutines.*
 import kotlinx.coroutines.channels.*
 
 fun main() = runBlocking {
-//sampleStart
     val channel = Channel<Int>()
     launch {
         // this might be heavy CPU-consuming computation or async logic, we'll just send five squares
@@ -18,5 +17,4 @@ fun main() = runBlocking {
     // here we print five received integers:
     repeat(5) { println(channel.receive()) }
     println("Done!")
-//sampleEnd
 }

kotlinx-coroutines-core/jvm/test/guide/example-channel-02.kt

@@ -9,7 +9,6 @@ import kotlinx.coroutines.*
 import kotlinx.coroutines.channels.*
 
 fun main() = runBlocking {
-//sampleStart
     val channel = Channel<Int>()
     launch {
         for (x in 1..5) channel.send(x * x)
@@ -18,5 +17,4 @@ fun main() = runBlocking {
     // here we print received values using `for` loop (until the channel is closed)
     for (y in channel) println(y)
     println("Done!")
-//sampleEnd
 }

kotlinx-coroutines-core/jvm/test/guide/example-channel-03.kt

@@ -13,9 +13,7 @@ fun CoroutineScope.produceSquares(): ReceiveChannel<Int> = produce {
 }
 
 fun main() = runBlocking {
-//sampleStart
     val squares = produceSquares()
     squares.consumeEach { println(it) }
     println("Done!")
-//sampleEnd
 }

kotlinx-coroutines-core/jvm/test/guide/example-channel-04.kt

@@ -9,13 +9,11 @@ import kotlinx.coroutines.*
 import kotlinx.coroutines.channels.*
 
 fun main() = runBlocking {
-//sampleStart
     val numbers = produceNumbers() // produces integers from 1 and on
     val squares = square(numbers) // squares integers
     for (i in 1..5) println(squares.receive()) // print first five
     println("Done!") // we are done
     coroutineContext.cancelChildren() // cancel children coroutines
-//sampleEnd
 }
 
 fun CoroutineScope.produceNumbers() = produce<Int> {

kotlinx-coroutines-core/jvm/test/guide/example-channel-05.kt

@@ -9,15 +9,13 @@ import kotlinx.coroutines.*
 import kotlinx.coroutines.channels.*
 
 fun main() = runBlocking {
-//sampleStart
     var cur = numbersFrom(2)
     for (i in 1..10) {
         val prime = cur.receive()
         println(prime)
         cur = filter(cur, prime)
     }
     coroutineContext.cancelChildren() // cancel all children to let main finish
-//sampleEnd    
 }
 
 fun CoroutineScope.numbersFrom(start: Int) = produce<Int> {

kotlinx-coroutines-core/jvm/test/guide/example-channel-06.kt

@@ -9,12 +9,10 @@ import kotlinx.coroutines.*
 import kotlinx.coroutines.channels.*
 
 fun main() = runBlocking<Unit> {
-//sampleStart
     val producer = produceNumbers()
     repeat(5) { launchProcessor(it, producer) }
     delay(950)
     producer.cancel() // cancel producer coroutine and thus kill them all
-//sampleEnd
 }
 
 fun CoroutineScope.produceNumbers() = produce<Int> {

kotlinx-coroutines-core/jvm/test/guide/example-channel-07.kt

@@ -9,15 +9,13 @@ import kotlinx.coroutines.*
 import kotlinx.coroutines.channels.*
 
 fun main() = runBlocking {
-//sampleStart
     val channel = Channel<String>()
     launch { sendString(channel, "foo", 200L) }
     launch { sendString(channel, "BAR!", 500L) }
     repeat(6) { // receive first six
         println(channel.receive())
     }
     coroutineContext.cancelChildren() // cancel all children to let main finish
-//sampleEnd
 }
 
 suspend fun sendString(channel: SendChannel<String>, s: String, time: Long) {

kotlinx-coroutines-core/jvm/test/guide/example-channel-08.kt

@@ -9,7 +9,6 @@ import kotlinx.coroutines.*
 import kotlinx.coroutines.channels.*
 
 fun main() = runBlocking<Unit> {
-//sampleStart
     val channel = Channel<Int>(4) // create buffered channel
     val sender = launch { // launch sender coroutine
         repeat(10) {
@@ -20,5 +19,4 @@ fun main() = runBlocking<Unit> {
     // don't receive anything... just wait....
     delay(1000)
     sender.cancel() // cancel sender coroutine
-//sampleEnd    
 }

kotlinx-coroutines-core/jvm/test/guide/example-channel-09.kt

@@ -8,7 +8,6 @@ package kotlinx.coroutines.guide.channel09
 import kotlinx.coroutines.*
 import kotlinx.coroutines.channels.*
 
-//sampleStart
 data class Ball(var hits: Int)
 
 fun main() = runBlocking {
@@ -28,4 +27,3 @@ suspend fun player(name: String, table: Channel<Ball>) {
         table.send(ball) // send the ball back
     }
 }
-//sampleEnd

kotlinx-coroutines-core/jvm/test/guide/example-compose-01.kt

@@ -9,14 +9,12 @@ import kotlinx.coroutines.*
 import kotlin.system.*
 
 fun main() = runBlocking<Unit> {
-//sampleStart
     val time = measureTimeMillis {
         val one = doSomethingUsefulOne()
         val two = doSomethingUsefulTwo()
         println("The answer is ${one + two}")
     }
     println("Completed in $time ms")
-//sampleEnd    
 }
 
 suspend fun doSomethingUsefulOne(): Int {

kotlinx-coroutines-core/jvm/test/guide/example-compose-02.kt

@@ -9,14 +9,12 @@ import kotlinx.coroutines.*
 import kotlin.system.*
 
 fun main() = runBlocking<Unit> {
-//sampleStart
     val time = measureTimeMillis {
         val one = async { doSomethingUsefulOne() }
         val two = async { doSomethingUsefulTwo() }
         println("The answer is ${one.await() + two.await()}")
     }
     println("Completed in $time ms")
-//sampleEnd    
 }
 
 suspend fun doSomethingUsefulOne(): Int {

kotlinx-coroutines-core/jvm/test/guide/example-compose-03.kt

@@ -9,7 +9,6 @@ import kotlinx.coroutines.*
 import kotlin.system.*
 
 fun main() = runBlocking<Unit> {
-//sampleStart
     val time = measureTimeMillis {
         val one = async(start = CoroutineStart.LAZY) { doSomethingUsefulOne() }
         val two = async(start = CoroutineStart.LAZY) { doSomethingUsefulTwo() }
@@ -19,7 +18,6 @@ fun main() = runBlocking<Unit> {
         println("The answer is ${one.await() + two.await()}")
     }
     println("Completed in $time ms")
-//sampleEnd    
 }
 
 suspend fun doSomethingUsefulOne(): Int {

kotlinx-coroutines-core/jvm/test/guide/example-compose-04.kt

@@ -8,7 +8,6 @@ package kotlinx.coroutines.guide.compose04
 import kotlinx.coroutines.*
 import kotlin.system.*
 
-//sampleStart
 // note that we don't have `runBlocking` to the right of `main` in this example
 fun main() {
     val time = measureTimeMillis {
@@ -23,7 +22,6 @@ fun main() {
     }
     println("Completed in $time ms")
 }
-//sampleEnd
 
 fun somethingUsefulOneAsync() = GlobalScope.async {
     doSomethingUsefulOne()

kotlinx-coroutines-core/jvm/test/guide/example-compose-05.kt

@@ -9,12 +9,10 @@ import kotlinx.coroutines.*
 import kotlin.system.*
 
 fun main() = runBlocking<Unit> {
-//sampleStart
     val time = measureTimeMillis {
         println("The answer is ${concurrentSum()}")
     }
     println("Completed in $time ms")
-//sampleEnd    
 }
 
 suspend fun concurrentSum(): Int = coroutineScope {

kotlinx-coroutines-core/jvm/test/guide/example-context-01.kt

@@ -8,7 +8,6 @@ package kotlinx.coroutines.guide.context01
 import kotlinx.coroutines.*
 
 fun main() = runBlocking<Unit> {
-//sampleStart
     launch { // context of the parent, main runBlocking coroutine
         println("main runBlocking      : I'm working in thread ${Thread.currentThread().name}")
     }
@@ -21,5 +20,4 @@ fun main() = runBlocking<Unit> {
     launch(newSingleThreadContext("MyOwnThread")) { // will get its own new thread
         println("newSingleThreadContext: I'm working in thread ${Thread.currentThread().name}")
     }
-//sampleEnd    
 }

kotlinx-coroutines-core/jvm/test/guide/example-context-02.kt

@@ -8,7 +8,6 @@ package kotlinx.coroutines.guide.context02
 import kotlinx.coroutines.*
 
 fun main() = runBlocking<Unit> {
-//sampleStart
     launch(Dispatchers.Unconfined) { // not confined -- will work with main thread
         println("Unconfined      : I'm working in thread ${Thread.currentThread().name}")
         delay(500)
@@ -19,5 +18,4 @@ fun main() = runBlocking<Unit> {
         delay(1000)
         println("main runBlocking: After delay in thread ${Thread.currentThread().name}")
     }
-//sampleEnd    
 }

kotlinx-coroutines-core/jvm/test/guide/example-context-03.kt

@@ -10,7 +10,6 @@ import kotlinx.coroutines.*
 fun log(msg: String) = println("[${Thread.currentThread().name}] $msg")
 
 fun main() = runBlocking<Unit> {
-//sampleStart
     val a = async {
         log("I'm computing a piece of the answer")
         6
@@ -20,5 +19,4 @@ fun main() = runBlocking<Unit> {
         7
     }
     log("The answer is ${a.await() * b.await()}")
-//sampleEnd    
 }