Support binding the Mapper to a specific window (#82)

* Refactor MapManager to render to a specific Window Refs #73 Rather than defaulting to whatever window is current, it selects the "current" window on init (eg: createEmpty) and uses that forever unless another window is specified. If provided a non-primary Window, that window will be cleared before the map is rendered into it. Furthermore, we simplify the resize mechanics to match *the specific window* we're rendering into. * Expose `judo.mapper.window` to scripting Closes #73 This commit also renames the internal IJudoWindow.onSubmit to `onSubmitFn`. It's a little annoying, but it allows a simple implementation of onSubmit for `IScriptWindow` that doesn't conflict with `IJudoWindow`, so implementations of `IScriptWindow` can also implement `IJudoWindow` for greater interop.
dhleong · Feb 20, 2019 · ea6524f · ea6524f
1 parent 1cfafd3
commit ea6524f
Show file tree

Hide file tree

Showing 20 changed files with 198 additions and 63 deletions.
diff --git a/core-test/src/main/kotlin/net/dhleong/judo/IJudoBufferAssert.kt b/core-test/src/main/kotlin/net/dhleong/judo/IJudoBufferAssert.kt
@@ -2,8 +2,10 @@ package net.dhleong.judo
 
 import assertk.Assert
 import assertk.assertions.isEqualTo
+import assertk.assertions.isTrue
 import assertk.assertions.support.expected
 import assertk.assertions.support.show
+import net.dhleong.judo.render.FlavorableCharSequence
 import net.dhleong.judo.render.IJudoBuffer
 
 /**
@@ -25,6 +27,12 @@ fun Assert<IJudoBuffer>.hasLinesSomewhere(vararg expectedStrings: String) {
     expected("buffer of ${show(actualStrings)} to contain the sequence: ${show(expectedStrings)}")
 }
 
+fun Assert<IJudoBuffer>.doesNotHaveLine(line: FlavorableCharSequence) {
+    for (i in 0..actual.lastIndex) {
+        assert(actual[i] != line, "line $i doesn't match `$line`").isTrue()
+    }
+}
+
 fun Assert<IJudoBuffer>.hasSize(size: Int) {
     if (actual.size == size) return
     expected("size = ${show(size)} but was ${show(actual.size)}")

diff --git a/core-test/src/main/kotlin/net/dhleong/judo/TestableJudoCore.kt b/core-test/src/main/kotlin/net/dhleong/judo/TestableJudoCore.kt
@@ -109,7 +109,7 @@ class TestableJudoCore(
             null
         }
 
-        window?.onSubmit?.let {
+        window?.onSubmitFn?.let {
             it(text)
         } ?: send(text, fromMap)
     }
@@ -170,7 +170,7 @@ fun createWindowMock(
             else -> height
         }
 
-    override var onSubmit: ((String) -> Unit)? = null
+    override var onSubmitFn: ((String) -> Unit)? = null
 
     override var currentBuffer: IJudoBuffer
         get() = buffer

diff --git a/core/src/main/kotlin/net/dhleong/judo/JudoCore.kt b/core/src/main/kotlin/net/dhleong/judo/JudoCore.kt
@@ -234,9 +234,7 @@ class JudoCore(
         updateStatusLine(currentMode)
         updateInputLine()
 
-        tabpage.currentWindow.let {
-            mapper.resize(width = it.width)
-        }
+        mapper.onResize()
     }
 
     private fun onBlockingEcho() {
@@ -510,7 +508,7 @@ class JudoCore(
     }
 
     override fun submit(text: String, fromMap: Boolean) {
-        val onSubmit = renderer.currentTabpage.currentWindow.onSubmit
+        val onSubmit = renderer.currentTabpage.currentWindow.onSubmitFn
             ?: return send(text, fromMap)
 
         onSubmit(text)

diff --git a/core/src/main/kotlin/net/dhleong/judo/mapping/MapManager.kt b/core/src/main/kotlin/net/dhleong/judo/mapping/MapManager.kt
@@ -7,6 +7,7 @@ import net.dhleong.judo.MAP_AUTOROOM
 import net.dhleong.judo.StateMap
 import net.dhleong.judo.event.EVENT_GMCP_ENABLED
 import net.dhleong.judo.event.EVENT_MSDP_ENABLED
+import net.dhleong.judo.inTransaction
 import net.dhleong.judo.render.IJudoWindow
 import java.io.File
 
@@ -20,6 +21,7 @@ class MapManager(
 ) : IMapManager {
 
     override var current: IJudoMap? = null
+    override var window: IJudoWindow? = null
 
     private var currentFormat: String? = null
     private var currentFile: File? = null
@@ -64,14 +66,19 @@ class MapManager(
         init()
     }
 
-    override fun render(intoWindow: IJudoWindow?) {
+    override fun render(intoWindow: IJudoWindow) {
         current?.let {
-            mapRenderer.renderMap(it, intoWindow)
+            mapRenderer.resize(intoWindow.width, intoWindow.visibleHeight)
+
+            judo.renderer.inTransaction {
+                mapRenderer.renderMap(it, intoWindow)
+            }
         }
     }
 
-    override fun resize(width: Int, height: Int) {
-        mapRenderer.resize(width, height)
+    override fun onResize() {
+        val w = window ?: return
+        mapRenderer.resize(w.width, w.visibleHeight)
     }
 
     override fun save() {
@@ -126,6 +133,10 @@ class MapManager(
     }
 
     private fun init() {
+
+        // use the current window by default
+        window = judo.renderer.currentTabpage.currentWindow
+
         if (!settings[MAP_AUTOMAGIC]) return
 
         val mapper = AutomagicMapper(judo, this)

diff --git a/core/src/main/kotlin/net/dhleong/judo/mapping/renderer/BufferMapRenderer.kt b/core/src/main/kotlin/net/dhleong/judo/mapping/renderer/BufferMapRenderer.kt
@@ -1,14 +1,13 @@
 package net.dhleong.judo.mapping.renderer
 
-import net.dhleong.judo.JudoRenderer
-import net.dhleong.judo.inTransaction
 import net.dhleong.judo.mapping.DEFAULT_MIN_MAP_HEIGHT
 import net.dhleong.judo.mapping.DEFAULT_MIN_MAP_WIDTH
 import net.dhleong.judo.mapping.IJudoMap
 import net.dhleong.judo.mapping.MapGrid
 import net.dhleong.judo.mapping.MapRenderer
 import net.dhleong.judo.render.IJudoAppendable
 import net.dhleong.judo.render.IJudoWindow
+import net.dhleong.judo.render.PrimaryJudoWindow
 
 /**
  * Base class for [MapRenderer] implementations that
@@ -17,7 +16,6 @@ import net.dhleong.judo.render.IJudoWindow
  * @author dhleong
  */
 abstract class BufferMapRenderer(
-    protected val renderer: JudoRenderer,
     protected var mapGrid: MapGrid
 ) : MapRenderer {
 
@@ -30,19 +28,21 @@ abstract class BufferMapRenderer(
      */
     abstract fun appendGridInto(map: IJudoMap, grid: MapGrid, window: IJudoAppendable)
 
-    override fun renderMap(map: IJudoMap, window: IJudoWindow?) {
-        renderer.inTransaction {
-            map.currentRoom?.let { room ->
-                mapGrid.buildAround(map, room)
-
-                // if provided a window, use it; otherwise, try to use
-                // the current window
-                appendGridInto(
-                    map,
-                    mapGrid,
-                    (window ?: renderer.currentTabpage.currentWindow)
-                )
-            }
+    override fun renderMap(map: IJudoMap, window: IJudoWindow) {
+        if (window !is PrimaryJudoWindow) {
+            window.currentBuffer.clear()
+        }
+
+        map.currentRoom?.let { room ->
+            mapGrid.buildAround(map, room)
+
+            // if provided a window, use it; otherwise, try to use
+            // the current window
+            appendGridInto(
+                map,
+                mapGrid,
+                window
+            )
         }
     }
 
@@ -57,6 +57,12 @@ abstract class BufferMapRenderer(
             if (height == -1) mapGrid.height
             else height
         )
+
+        if (newWidth == mapGrid.width && newHeight == mapGrid.height) {
+            // nop
+            return
+        }
+
         mapGrid = MapGrid(newWidth / charsPerX, newHeight / charsPerY)
     }
 }
diff --git a/core/src/main/kotlin/net/dhleong/judo/mapping/renderer/DelegateMapRenderer.kt b/core/src/main/kotlin/net/dhleong/judo/mapping/renderer/DelegateMapRenderer.kt
@@ -18,7 +18,7 @@ class DelegateMapRenderer(
         delegate.resize(width, height)
     }
 
-    override fun renderMap(map: IJudoMap, window: IJudoWindow?) {
+    override fun renderMap(map: IJudoMap, window: IJudoWindow) {
         delegate.renderMap(map, window)
     }
 

diff --git a/core/src/main/kotlin/net/dhleong/judo/mapping/renderer/SimpleBufferMapRenderer.kt b/core/src/main/kotlin/net/dhleong/judo/mapping/renderer/SimpleBufferMapRenderer.kt
@@ -1,6 +1,5 @@
 package net.dhleong.judo.mapping.renderer
 
-import net.dhleong.judo.JudoRenderer
 import net.dhleong.judo.mapping.DEFAULT_MIN_MAP_HEIGHT
 import net.dhleong.judo.mapping.DEFAULT_MIN_MAP_WIDTH
 import net.dhleong.judo.mapping.IJudoMap
@@ -17,9 +16,8 @@ import net.dhleong.judo.render.SimpleFlavor
  * @author dhleong
  */
 class SimpleBufferMapRenderer(
-    renderer: JudoRenderer,
     mapGrid: MapGrid = MapGrid(DEFAULT_MIN_MAP_WIDTH, DEFAULT_MIN_MAP_HEIGHT)
-) : BufferMapRenderer(renderer, mapGrid) {
+) : BufferMapRenderer(mapGrid) {
 
     override val name: String = "simple"
     override val charsPerX = 5

diff --git a/core/src/main/kotlin/net/dhleong/judo/render/BaseJudoWindow.kt b/core/src/main/kotlin/net/dhleong/judo/render/BaseJudoWindow.kt
@@ -25,7 +25,7 @@ abstract class BaseJudoWindow(
 
     protected val search = BufferSearcher()
 
-    override var onSubmit: ((String) -> Unit)? = null
+    override var onSubmitFn: ((String) -> Unit)? = null
 
     override fun append(text: FlavorableCharSequence) = currentBuffer.append(text)
     override fun appendLine(line: FlavorableCharSequence) = currentBuffer.appendLine(line)

diff --git a/core/src/main/kotlin/net/dhleong/judo/render/PrimaryJudoWindow.kt b/core/src/main/kotlin/net/dhleong/judo/render/PrimaryJudoWindow.kt
@@ -36,7 +36,7 @@ abstract class PrimaryJudoWindow(
     override val statusCursor: Int
         get() = promptWindow.statusCursor
 
-    override var onSubmit: ((String) -> Unit)?
+    override var onSubmitFn: ((String) -> Unit)?
         get() = null
         set(_) {
             throw IllegalArgumentException(

diff --git a/core/src/main/kotlin/net/dhleong/judo/script/Jsr223ScriptingEngine.kt b/core/src/main/kotlin/net/dhleong/judo/script/Jsr223ScriptingEngine.kt
@@ -7,7 +7,6 @@ import net.dhleong.judo.alias.compileSimplePatternSpec
 import net.dhleong.judo.event.IEventManager
 import net.dhleong.judo.logging.ILogManager
 import net.dhleong.judo.mapping.IJudoMap
-import net.dhleong.judo.mapping.IMapManager
 import net.dhleong.judo.mapping.IMapManagerPublic
 import net.dhleong.judo.prompt.IPromptManager
 import net.dhleong.judo.render.IJudoBuffer
@@ -109,7 +108,14 @@ abstract class Jsr223ScriptingEngine(
         is IAliasManager -> object : IAliasManager by fromJava {}
         is IEventManager -> object : IEventManager by fromJava {}
         is ILogManager -> object : ILogManager by fromJava {}
-        is IMapManagerPublic -> object : IMapManagerPublic by fromJava {}
+        is IMapManagerPublic -> object : IMapManagerPublic by fromJava {
+            override var window: IJudoWindow?
+                get() = fromJava.window
+                set(value) {
+                    // unpack for simplicity
+                    fromJava.window = (value as? Jsr223Window)?.window ?: value
+                }
+        }
         is IPromptManager -> object : IPromptManager by fromJava {}
         is ITriggerManager -> object : ITriggerManager by fromJava {}
         is JudoRendererInfo -> object : JudoRendererInfo by fromJava {}
@@ -137,8 +143,8 @@ class Jsr223JudoCore(
     private val engine: Jsr223ScriptingEngine,
     private val judo: IJudoCore
 ) : IScriptJudo, ICurrentJudoObjects {
-    override val mapper: IMapManager
-        get() = judo.mapper
+    override val mapper: IMapManagerPublic
+        get() = engine.toScript(judo.mapper) as IMapManagerPublic
 
     override val current: ICurrentJudoObjects = this
 
@@ -165,8 +171,8 @@ class Jsr223JudoCore(
 class Jsr223Window(
     private val engine: Jsr223ScriptingEngine,
     private val tabpage: IJudoTabpage,
-    private val window: IJudoWindow
-) : IScriptWindow {
+    internal val window: IJudoWindow
+) : IScriptWindow, IJudoWindow by window {
 
     override val id: Int = window.id
     override val width: Int = window.width
@@ -176,9 +182,9 @@ class Jsr223Window(
 
     @Suppress("UNCHECKED_CAST")
     override var onSubmit: Any?
-        get() = window.onSubmit?.let { engine.toScript(it) }
+        get() = window.onSubmitFn?.let { engine.toScript(it) }
         set(value) {
-            window.onSubmit = value?.let { engine.callableToFunction1(it) as (String) -> Unit }
+            window.onSubmitFn = value?.let { engine.callableToFunction1(it) as (String) -> Unit }
         }
 
     override fun close() {

diff --git a/core/src/main/kotlin/net/dhleong/judo/script/JythonScriptingEngine.kt b/core/src/main/kotlin/net/dhleong/judo/script/JythonScriptingEngine.kt
@@ -558,7 +558,7 @@ internal fun createPyWindow(
                 "width" -> Py.java2py(window.width)
                 "id" -> Py.java2py(window.id)
 
-                "onSubmit" -> Py.java2py(window.onSubmit)
+                "onSubmit" -> Py.java2py(window.onSubmitFn)
 
                 // not used oft enough to cache
                 "close" -> asPyFn<Any, Unit>("close") {
@@ -573,7 +573,7 @@ internal fun createPyWindow(
             @Suppress("UNCHECKED_CAST")
             when (name) {
                 "onSubmit" -> {
-                    window.onSubmit = when (value) {
+                    window.onSubmitFn = when (value) {
                         null -> null
                         is PyNone -> null
                         else -> engine.callableToFunction1(value) as (String) -> Unit

diff --git a/core/src/test/kotlin/net/dhleong/judo/mapping/DirectionalMapStrategyTest.kt b/core/src/test/kotlin/net/dhleong/judo/mapping/DirectionalMapStrategyTest.kt
@@ -1,6 +1,7 @@
 package net.dhleong.judo.mapping
 
 import net.dhleong.judo.TestableJudoCore
+import net.dhleong.judo.TestableJudoRenderer
 import net.dhleong.judo.assertThat
 import org.junit.Before
 import org.junit.Test
@@ -16,7 +17,7 @@ class DirectionalMapStrategyTest {
     lateinit var map: JudoMap
 
     @Before fun setUp() {
-        judo = TestableJudoCore()
+        judo = TestableJudoCore(TestableJudoRenderer())
         mapper = AutomagicMapper(judo, judo.mapper)
         strategy = DirectionalMapStrategy(mapper)