main.docs.ExampleCodeExtractor.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common Show documentation

"Common Kotlin Tools"

There is a newer version: 0.77.0

package de.peekandpoke.ultra.common.docs

import java.io.File

object ExampleCodeExtractor {

    private const val beginPattern = "// !BEGIN! //"
    private const val endPattern = "// !END! //"

    fun extract(example: Example, srcDir: File): String {

        val srcFile = File(srcDir, "${example::class.simpleName}.kt")

        if (!srcFile.exists()) {
            return "Source file not found: $srcFile"
        }

        return extractFromExample(srcFile.readText())
    }

    private fun extractFromExample(src: String): String {

        var idx = 0
        val result = StringBuilder()

        do {
            val begin = src.indexOf(beginPattern, idx)
            val end = src.indexOf(endPattern, idx)
            val found = begin != -1 && end != -1

            if (found) {
                result
                    .appendLine(src.substring(begin + beginPattern.length, end).trimIndent().trim())
                    .appendLine()

                idx = end + endPattern.length
            }
        } while (found)

        return result.toString().trim()
    }
}