Merge remote-tracking branch 'myk002/myk_gui_blueprint'

lethosor · lethosor · commit 4be7fea6fbe6 · 2021-05-24T23:48:28.000-04:00
diff --git a/changelog.txt b/changelog.txt
@@ -16,6 +16,7 @@ that repo.
 ## New Scripts
 - `devel/block-borders`: overlay that displays map block borders
 - `devel/luacov`: generate code test coverage reports for script development. define the ``DFHACK_ENABLE_LUACOV=1`` environment variable to start gathering coverage metrics.
+- `gui/blueprint`: interactive frontend for the `blueprint` plugin
 - `gui/mass-remove`: mass removal/suspension tool for buildings and constructions
 - `reveal-hidden-sites`: exposes all undiscovered sites
 
@@ -30,7 +31,7 @@ that repo.
 - `quickfort`: improved handling of non-rectangular and non-solid extent-based structures (like fancy-shaped stockpiles and farm plots)
 - `quickfort`: fixed conversion of numbers to DF keycodes in ``#query`` blueprints
 - `quickfort`: fixed various errors with cropping across the map edge
-- `quickfort`: properly reset config to default values in ``quickfort reset`` even if if the ``dfhack-config/quickfort/quickfort.txt`` config file doesn't mention all config vars. aso now works even if the config file doesn't exist
+- `quickfort`: properly reset config to default values in ``quickfort reset`` even if if the ``dfhack-config/quickfort/quickfort.txt`` config file doesn't mention all config vars. also now works even if the config file doesn't exist.
 
 ## Misc Improvements
 - `devel/annc-monitor`: added ``report enable|disable`` subcommand to filter combat reports
diff --git a/gui/blueprint.lua b/gui/blueprint.lua
@@ -19,4 +19,159 @@ values set in the interface. See the `blueprint` documentation for information
 on the possible parameters and options.
 ]====]
 
-print('coming soon!')
+local gui = require('gui')
+local guidm = require('gui.dwarfmode')
+local widgets = require('gui.widgets')
+
+local function get_dims(pos1, pos2)
+    local width, height, depth = math.abs(pos1.x - pos2.x) + 1,
+            math.abs(pos1.y - pos2.y) + 1,
+            math.abs(pos1.z - pos2.z) + 1
+    return width, height, depth
+end
+
+ActionPanel = defclass(ActionPanel, widgets.Panel)
+ActionPanel.ATTRS{
+    get_mark_fn=DEFAULT_NIL,
+}
+function ActionPanel:init()
+    self:addviews{
+        widgets.Label{
+            text={{text=self:callback('get_action_text')}},
+            frame={t=0},
+        },
+        widgets.Label{
+            text='with the cursor.',
+            frame={t=1},
+        },
+    }
+end
+function ActionPanel:get_action_text()
+    if self.get_mark_fn() then
+        return 'Select the second corner'
+    end
+    return 'Select the first corner'
+end
+
+BlueprintUI = defclass(BlueprintUI, guidm.MenuOverlay)
+BlueprintUI.ATTRS {
+    presets={},
+    frame_inset=1,
+    focus_path='blueprint',
+}
+function BlueprintUI:init()
+    local summary = {
+        'Create quickfort blueprints\n',
+        'from a live game map.'
+    }
+
+    self:addviews{
+        widgets.Label{text='Blueprint', frame={t=0}},
+        widgets.Label{text=summary, text_pen=COLOR_GREY, frame={t=2}},
+        ActionPanel{get_mark_fn=function() return self.mark end, frame={t=5}},
+        widgets.Label{text={{text=function() return self:get_cancel_label() end,
+                             key='LEAVESCREEN', key_sep=': ',
+                             on_activate=function() self:on_cancel() end}},
+                             frame={t=8}},
+    }
+end
+
+function BlueprintUI:onAboutToShow()
+    if not dfhack.isMapLoaded() then
+        qerror('Please load a fortress map.')
+    end
+end
+
+function BlueprintUI:on_mark(pos)
+    self.mark = pos
+end
+
+function BlueprintUI:get_cancel_label()
+    if self.mark then
+        return 'Cancel selection'
+    end
+    return 'Back'
+end
+
+function BlueprintUI:on_cancel()
+    if self.mark then
+        self.mark = nil
+    else
+        self:dismiss()
+    end
+end
+
+-- Sorts and returns the given arguments.
+local function min_to_max(...)
+    local args = {...}
+    table.sort(args, function(a, b) return a < b end)
+    return table.unpack(args)
+end
+
+local fg, bg = COLOR_GREEN, COLOR_BLACK
+
+function BlueprintUI:onRenderBody()
+    if not self.mark then return end
+
+    local vp = self:getViewport()
+    local dc = gui.Painter.new(self.df_layout.map)
+
+    if gui.blink_visible(500) then
+        local cursor = df.global.cursor
+        -- clip blinking region to viewport
+        local _,y_start,y_end = min_to_max(self.mark.y, cursor.y, vp.y1, vp.y2)
+        local _,x_start,x_end = min_to_max(self.mark.x, cursor.x, vp.x1, vp.x2)
+        for y=y_start,y_end do for x=x_start,x_end do
+            local pos = xyz2pos(x, y, cursor.z)
+            -- don't overwrite the cursor so the user can still tell where it is
+            if not same_xyz(cursor, pos) then
+                local stile = vp:tileToScreen(pos)
+                dc:map(true):seek(stile.x, stile.y):
+                        pen(fg, bg):char('X'):map(false)
+            end
+        end end
+    end
+end
+
+function BlueprintUI:onInput(keys)
+    if self:inputToSubviews(keys) then return true end
+
+    if keys.SELECT then
+        local pos = guidm.getCursorPos()
+        if self.mark then
+            self:commit(pos)
+            self:dismiss()
+        else
+            self:on_mark(pos)
+        end
+        return true
+    end
+
+    return self:propagateMoveKeys(keys)
+end
+
+-- assemble and execute the blueprint commandline
+function BlueprintUI:commit(pos)
+    local mark = self.mark
+    local width, height, depth = get_dims(mark, pos)
+    if depth > 1 then
+        -- when there are multiple levels, process them top to bottom
+        depth = -depth
+    end
+    local basename = "blueprint"
+    local cmd = {'blueprint',
+                 tostring(width), tostring(height), tostring(depth),
+                 basename}
+
+    -- set cursor to top left corner of the *uppermost* z-level
+    local x, y, z = math.min(mark.x, pos.x), math.min(mark.y, pos.y),
+            math.max(mark.z, pos.z)
+    table.insert(cmd, ('--cursor=%d,%d,%d'):format(x, y, z))
+
+    print('running: ' .. table.concat(cmd, ' '))
+    dfhack.run_command(cmd)
+end
+
+if not dfhack_flags.module then
+    BlueprintUI{}:show()
+end
diff --git a/test/gui/blueprint.lua b/test/gui/blueprint.lua
@@ -0,0 +1,105 @@
+config = {
+    mode = 'fortress',
+}
+
+local b = reqscript('gui/blueprint')
+local gui = require('gui')
+local guidm = require('gui.dwarfmode')
+
+function test.fail_if_no_map_loaded()
+    local mock_is_map_loaded = mock.func(false)
+    mock.patch(dfhack, 'isMapLoaded', mock_is_map_loaded,
+        function()
+            expect.error_match('load a fortress map',
+                               function() b.BlueprintUI{}:show() end)
+        end)
+end
+
+local function send_keys(...)
+    local keys = {...}
+    for _,key in ipairs(keys) do
+        gui.simulateInput(dfhack.gui.getCurViewscreen(true), key)
+    end
+    delay()
+end
+
+local function load_ui()
+    -- remove screen mode switching once gui/blueprint supports it natively
+    for i=1,10 do
+        if df.global.ui.main.mode == df.ui_sidebar_mode.Default and
+                'dwarfmode/Default' == dfhack.gui.getCurFocus(true) then
+            send_keys('D_LOOK')
+            b.BlueprintUI{}:show()
+            delay()
+            return
+        end
+        send_keys('LEAVESCREEN')
+    end
+    error('Unable to get into look mode from current UI viewscreen.')
+end
+
+function test.minimal_happy_path()
+    local mock_print, mock_run_command = mock.func(), mock.func()
+    mock.patch({
+            {b, 'print', mock_print},
+            {dfhack, 'run_command', mock_run_command},
+            {gui, 'blink_visible', mock.func(true)},
+        },
+        function()
+            load_ui()
+            expect.eq('dfhack/lua/blueprint', dfhack.gui.getCurFocus(true))
+            guidm.setCursorPos({x=10, y=20, z=30})
+            send_keys('SELECT')
+            send_keys('CURSOR_RIGHT', 'CURSOR_DOWN', 'CURSOR_DOWN',
+                      'CURSOR_UP_Z', 'CURSOR_UP_Z', 'CURSOR_UP_Z')
+            send_keys('SELECT')
+            expect.nil_(dfhack.gui.getCurFocus(true):find('^dfhack/'))
+            expect.eq('running: blueprint 2 3 -4 blueprint --cursor=10,20,33',
+                    mock_print.call_args[1][1])
+            expect.table_eq({'blueprint', '2', '3', '-4', 'blueprint',
+                            '--cursor=10,20,33'},
+                            mock_run_command.call_args[1][1])
+        end)
+end
+
+function test.cancel_ui()
+    local mock_print, mock_run_command = mock.func(), mock.func()
+    mock.patch({
+            {b, 'print', mock_print},
+            {dfhack, 'run_command', mock_run_command},
+        },
+        function()
+            load_ui()
+            expect.eq('dfhack/lua/blueprint', dfhack.gui.getCurFocus(true))
+            send_keys('LEAVESCREEN')
+            expect.nil_(dfhack.gui.getCurFocus(true):find('^dfhack/'))
+            expect.eq(0, mock_print.call_count)
+            expect.eq(0, mock_run_command.call_count)
+        end)
+end
+
+function test.cancel_selection()
+    local mock_print, mock_run_command = mock.func(), mock.func()
+    mock.patch({
+            {b, 'print', mock_print},
+            {dfhack, 'run_command', mock_run_command},
+        },
+        function()
+            load_ui()
+            expect.eq('dfhack/lua/blueprint', dfhack.gui.getCurFocus(true))
+            guidm.setCursorPos({x=10, y=20, z=30})
+            send_keys('SELECT')
+            send_keys('LEAVESCREEN')
+            expect.eq('dfhack/lua/blueprint', dfhack.gui.getCurFocus(true))
+            guidm.setCursorPos({x=12, y=24, z=24})
+            send_keys('SELECT')
+            guidm.setCursorPos({x=11, y=22, z=27})
+            send_keys('SELECT')
+            expect.nil_(dfhack.gui.getCurFocus(true):find('^dfhack/'))
+            expect.eq('running: blueprint 2 3 -4 blueprint --cursor=11,22,27',
+                    mock_print.call_args[1][1])
+            expect.table_eq({'blueprint', '2', '3', '-4', 'blueprint',
+                            '--cursor=11,22,27'},
+                            mock_run_command.call_args[1][1])
+        end)
+end
