Platform dependent hints for renderer

3 files changed, 214 insertions, 89 deletions

diff --git a/plugins/base/src/test/kotlin/renderers/RenderingOnlyTestBase.kt b/plugins/base/src/test/kotlin/renderers/RenderingOnlyTestBase.kt
new file mode 100644
index 00000000..9f148369
--- /dev/null
+++ b/plugins/base/src/test/kotlin/renderers/RenderingOnlyTestBase.kt
@@ -0,0 +1,88 @@
+package renderers
+
+import org.jetbrains.dokka.base.DokkaBase
+import org.jetbrains.dokka.base.resolvers.DefaultLocationProviderFactory
+import org.jetbrains.dokka.base.resolvers.LocationProvider
+import org.jetbrains.dokka.base.resolvers.LocationProviderFactory
+import org.jetbrains.dokka.base.signatures.KotlinSignatureProvider
+import org.jetbrains.dokka.base.transformers.pages.comments.CommentsToContentConverter
+import org.jetbrains.dokka.base.translators.documentables.PageContentBuilder
+import org.jetbrains.dokka.links.DRI
+import org.jetbrains.dokka.model.Documentable
+import org.jetbrains.dokka.model.doc.DocTag
+import org.jetbrains.dokka.pages.*
+import org.jetbrains.dokka.testApi.context.MockContext
+import org.jetbrains.dokka.utilities.DokkaConsoleLogger
+import utils.TestOutputWriter
+
+abstract class RenderingOnlyTestBase {
+    val files = TestOutputWriter()
+    val context = MockContext(
+        DokkaBase().outputWriter to { _ -> files },
+        DokkaBase().locationProviderFactory to ::DefaultLocationProviderFactory
+    )
+
+    protected fun linesAfterContentTag() =
+        files.contents.getValue("test-page.html").lines()
+            .dropWhile { !it.contains("""<div id="content">""") }
+            .joinToString(separator = "") { it.trim() }
+
+}
+
+class TestPage(callback: PageContentBuilder.DocumentableContentBuilder.() -> Unit): RootPageNode(), ContentPage {
+    override val dri: Set<DRI> = setOf(DRI.topLevel)
+    override val documentable: Documentable? = null
+    override val embeddedResources: List<String> = emptyList()
+    override val name: String
+        get() = "testPage"
+    override val children: List<PageNode>
+        get() = emptyList()
+
+    override val content: ContentNode = PageContentBuilder(
+        EmptyCommentConverter,
+        KotlinSignatureProvider(EmptyCommentConverter, DokkaConsoleLogger),
+        DokkaConsoleLogger
+    ).contentFor(
+        DRI.topLevel,
+        emptySet(),
+        block = callback
+    )
+
+    override fun modified(
+        name: String,
+        content: ContentNode,
+        dri: Set<DRI>,
+        embeddedResources: List<String>,
+        children: List<PageNode>
+    ) = this
+
+    override fun modified(name: String, children: List<PageNode>) = this
+}
+
+
+internal object EmptyCommentConverter : CommentsToContentConverter {
+    override fun buildContent(
+        docTag: DocTag,
+        dci: DCI,
+        platforms: Set<PlatformData>,
+        styles: Set<Style>,
+        extras: Set<Extra>
+    ): List<ContentNode> = emptyList()
+}
+
+internal object EmptyLocationProviderFactory: LocationProviderFactory {
+    override fun getLocationProvider(pageNode: RootPageNode) = object : LocationProvider {
+        override fun resolve(dri: DRI, platforms: List<PlatformData>, context: PageNode?): String = ""
+
+        override fun resolve(node: PageNode, context: PageNode?, skipExtension: Boolean): String = node.name
+
+        override fun resolveRoot(node: PageNode): String {
+            TODO("not implemented") //To change body of created functions use File | Settings | File Templates.
+        }
+
+        override fun ancestors(node: PageNode): List<PageNode> {
+            TODO("not implemented") //To change body of created functions use File | Settings | File Templates.
+        }
+
+    }
+}
\ No newline at end of file
diff --git a/plugins/base/src/test/kotlin/renderers/html/GroupWrappingTest.kt b/plugins/base/src/test/kotlin/renderers/html/GroupWrappingTest.kt
index 7fac6450..e98b97c0 100644
--- a/plugins/base/src/test/kotlin/renderers/html/GroupWrappingTest.kt
+++ b/plugins/base/src/test/kotlin/renderers/html/GroupWrappingTest.kt
@@ -1,33 +1,16 @@
 package renderers.html
 
-import org.jetbrains.dokka.base.DokkaBase
 import org.jetbrains.dokka.base.renderers.html.HtmlRenderer
-import org.jetbrains.dokka.base.resolvers.DefaultLocationProviderFactory
-import org.jetbrains.dokka.base.resolvers.LocationProvider
-import org.jetbrains.dokka.base.resolvers.LocationProviderFactory
-import org.jetbrains.dokka.base.transformers.pages.comments.CommentsToContentConverter
-import org.jetbrains.dokka.base.translators.documentables.PageContentBuilder
-import org.jetbrains.dokka.links.DRI
-import org.jetbrains.dokka.model.Documentable
-import org.jetbrains.dokka.model.doc.DocTag
-import org.jetbrains.dokka.pages.*
-import org.jetbrains.dokka.testApi.context.MockContext
-import org.jetbrains.dokka.utilities.DokkaConsoleLogger
+import org.jetbrains.dokka.pages.TextStyle
 import org.junit.Test
-import utils.TestOutputWriter
+import renderers.RenderingOnlyTestBase
+import renderers.TestPage
 
-class GroupWrappingTest {
-
-    val files = TestOutputWriter()
-    val context = MockContext(
-        DokkaBase().outputWriter to { _ -> files },
-        DokkaBase().locationProviderFactory to ::DefaultLocationProviderFactory
-    )
+class GroupWrappingTest: RenderingOnlyTestBase() {
 
     @Test
     fun notWrapped() {
-
-        val page = createPage {
+        val page = TestPage {
             group {
                 text("a")
                 text("b")
@@ -42,8 +25,7 @@ class GroupWrappingTest {
 
     @Test
     fun paragraphWrapped() {
-
-        val page = createPage {
+        val page = TestPage {
             group(styles = setOf(TextStyle.Paragraph)) {
                 text("a")
                 text("b")
@@ -58,8 +40,7 @@ class GroupWrappingTest {
 
     @Test
     fun blockWrapped() {
-
-        val page = createPage {
+        val page = TestPage {
             group(styles = setOf(TextStyle.Block)) {
                 text("a")
                 text("b")
@@ -74,8 +55,7 @@ class GroupWrappingTest {
 
     @Test
     fun nested() {
-
-        val page = createPage {
+        val page = TestPage {
             group(styles = setOf(TextStyle.Block)) {
                 text("a")
                 group(styles = setOf(TextStyle.Block)) {
@@ -93,65 +73,4 @@ class GroupWrappingTest {
         assert(linesAfterContentTag().contains("<div>a<div><div>bc</div></div>d</div>"))
     }
 
-    private fun linesAfterContentTag() =
-        files.contents.getValue("test-page.html").lines()
-            .dropWhile { !it.contains("""<div id="content">""") }
-            .joinToString(separator = "") { it.trim() }
 }
-
-// TODO: may be useful for other tests, consider extracting
-private fun createPage(
-    callback: PageContentBuilder.DocumentableContentBuilder.() -> Unit
-) = object : RootPageNode(), ContentPage {
-    override val dri: Set<DRI> = setOf(DRI.topLevel)
-    override val documentable: Documentable? = null
-    override val embeddedResources: List<String> = emptyList()
-    override val name: String
-        get() = "testPage"
-    override val children: List<PageNode>
-        get() = emptyList()
-
-    override val content: ContentNode = PageContentBuilder(EmptyCommentConverter, DokkaConsoleLogger).contentFor(
-        DRI.topLevel,
-        emptySet(),
-        block = callback
-    )
-
-    override fun modified(
-        name: String,
-        content: ContentNode,
-        dri: Set<DRI>,
-        embeddedResources: List<String>,
-        children: List<PageNode>
-    ) = this
-
-    override fun modified(name: String, children: List<PageNode>) = this
-}
-
-private object EmptyCommentConverter : CommentsToContentConverter {
-    override fun buildContent(
-        docTag: DocTag,
-        dci: DCI,
-        platforms: Set<PlatformData>,
-        styles: Set<Style>,
-        extras: Set<Extra>
-    ): List<ContentNode> = emptyList()
-}
-
-private object EmptyLocationProviderFactory: LocationProviderFactory {
-    override fun getLocationProvider(pageNode: RootPageNode) = object : LocationProvider {
-        override fun resolve(dri: DRI, platforms: List<PlatformData>, context: PageNode?): String = ""
-
-        override fun resolve(node: PageNode, context: PageNode?, skipExtension: Boolean): String = node.name
-
-        override fun resolveRoot(node: PageNode): String {
-            TODO("not implemented") //To change body of created functions use File | Settings | File Templates.
-        }
-
-        override fun ancestors(node: PageNode): List<PageNode> {
-            TODO("not implemented") //To change body of created functions use File | Settings | File Templates.
-        }
-
-    }
-
-}
\ No newline at end of file
diff --git a/plugins/base/src/test/kotlin/renderers/html/PlatformDependentHintTest.kt b/plugins/base/src/test/kotlin/renderers/html/PlatformDependentHintTest.kt
new file mode 100644
index 00000000..2fda1ee1
--- /dev/null
+++ b/plugins/base/src/test/kotlin/renderers/html/PlatformDependentHintTest.kt
@@ -0,0 +1,118 @@
+package renderers.html
+
+import org.jetbrains.dokka.Platform
+import org.jetbrains.dokka.base.renderers.html.HtmlRenderer
+import org.jetbrains.dokka.pages.PlatformData
+import org.jetbrains.dokka.pages.Style
+import org.jetbrains.dokka.pages.TextStyle
+import org.junit.Test
+import renderers.RenderingOnlyTestBase
+import renderers.TestPage
+
+class PlatformDependentHintTest: RenderingOnlyTestBase() {
+    private val pl1 = PlatformData("pl1", Platform.js, listOf("pl1"))
+    private val pl2 = PlatformData("pl2", Platform.jvm, listOf("pl2"))
+    private val pl3 = PlatformData("pl3", Platform.native, listOf("pl3"))
+
+    @Test
+    fun platformIndependentCase() {
+        val page = TestPage {
+            platformDependentHint(platformData = setOf(pl1, pl2, pl3), styles = setOf(TextStyle.Block)) {
+                text("a")
+                text("b")
+                text("c")
+            }
+        }
+
+        HtmlRenderer(context).render(page)
+        assert(linesAfterContentTag().contains("<div>abc</div></div>"))
+    }
+
+    @Test
+    fun completelyDivergentCase() {
+        val page = TestPage {
+            platformDependentHint(platformData = setOf(pl1, pl2, pl3), styles = setOf(TextStyle.Block)) {
+                text("a", platformData = setOf(pl1))
+                text("b", platformData = setOf(pl2))
+                text("c", platformData = setOf(pl3))
+            }
+        }
+
+        HtmlRenderer(context).render(page)
+        assert(linesAfterContentTag().contains("<div>a</div> [pl1]<div>b</div> [pl2]<div>c</div> [pl3]</div>"))
+    }
+
+    @Test
+    fun overlappingCase() {
+        val page = TestPage {
+            platformDependentHint(platformData = setOf(pl1, pl2), styles = setOf(TextStyle.Block)) {
+                text("a", platformData = setOf(pl1))
+                text("b", platformData = setOf(pl1, pl2))
+                text("c", platformData = setOf(pl2))
+            }
+        }
+
+        HtmlRenderer(context).render(page)
+        assert(linesAfterContentTag().contains("<div>ab</div> [pl1]<div>bc</div> [pl2]</div>"))
+    }
+
+    @Test
+    fun caseThatCanBeSimplified() {
+        val page = TestPage {
+            platformDependentHint(platformData = setOf(pl1, pl2), styles = setOf(TextStyle.Block)) {
+                text("a", platformData = setOf(pl1, pl2))
+                text("b", platformData = setOf(pl1))
+                text("b", platformData = setOf(pl2))
+            }
+        }
+
+        HtmlRenderer(context).render(page)
+        assert(linesAfterContentTag().contains("<div>ab</div></div>"))
+    }
+
+    @Test
+    fun caseWithGroupBreakingSimplification() {
+        val page = TestPage {
+            platformDependentHint(platformData = setOf(pl1, pl2), styles = setOf(TextStyle.Block)) {
+                group(styles = setOf(TextStyle.Block)) {
+                    text("a", platformData = setOf(pl1, pl2))
+                    text("b", platformData = setOf(pl1))
+                }
+                text("b", platformData = setOf(pl2))
+            }
+        }
+
+        HtmlRenderer(context).render(page)
+        assert(linesAfterContentTag().contains("<div><div>ab</div></div> [pl1]<div><div>a</div>b</div> [pl2]</div>"))
+    }
+
+    @Test
+    fun caseWithGroupNotBreakingSimplification() {
+        val page = TestPage {
+            platformDependentHint(platformData = setOf(pl1, pl2), styles = setOf(TextStyle.Block)) {
+                group {
+                    text("a", platformData = setOf(pl1, pl2))
+                    text("b", platformData = setOf(pl1))
+                }
+                text("b", platformData = setOf(pl2))
+            }
+        }
+
+        HtmlRenderer(context).render(page)
+        assert(linesAfterContentTag().contains("<div>ab</div></div>"))
+    }
+
+    @Test
+    fun partiallyUnifiedCase() {
+        val page = TestPage {
+            platformDependentHint(platformData = setOf(pl1, pl2, pl3), styles = setOf(TextStyle.Block)) {
+                text("a", platformData = setOf(pl1))
+                text("a", platformData = setOf(pl2))
+                text("b", platformData = setOf(pl3))
+            }
+        }
+
+        HtmlRenderer(context).render(page)
+        assert(linesAfterContentTag().contains("<div>a</div> [pl1, pl2]<div>b</div> [pl3]</div>"))
+    }
+}
\ No newline at end of file