Add create new note gui/notes test

Author: wiktor-obrebski

gui/notes.lua

@@ -9,6 +9,7 @@ local overlay = require 'plugins.overlay'
 local utils = require 'utils'
 
 local note_manager = reqscript('internal/notes/note_manager')
+local notes_textures = reqscript('notes').textures
 
 local map_points = df.global.plotinfo.waypoints.points
 
@@ -17,13 +18,6 @@ local RESIZE_MIN = {w=65, h=30}
 local NOTE_SEARCH_BATCH_SIZE = 25
 local OVERLAY_NAME = 'notes.map_notes'
 
-local green_pin = dfhack.textures.loadTileset(
-    'hack/data/art/note_green_pin_map.png',
-    32,
-    32,
-    true
-)
-
 NotesWindow = defclass(NotesWindow, widgets.Window)
 NotesWindow.ATTRS {
     frame_title='DF Notes',
@@ -253,6 +247,7 @@ NotesScreen = defclass(NotesScreen, gui.ZScreen)
 NotesScreen.ATTRS {
     focus_path='gui/notes',
     pass_movement_keys=true,
+    enable_selector_blink = true,
 }
 
 function NotesScreen:init()
@@ -283,7 +278,7 @@ function NotesScreen:onInput(keys)
         if (keys.SELECT or keys._MOUSE_L) then
             self.adding_note_pos = dfhack.gui.getMousePos()
 
-            local manager = note_manager.NoteManager{
+            local note_manager = note_manager.NoteManager{
                 note=nil,
                 on_update=function()
                     dfhack.run_command_silent('overlay trigger notes.map_notes')
@@ -294,7 +289,8 @@ function NotesScreen:onInput(keys)
                     self:stopNoteAdd()
                 end
             }:show()
-            manager:setNotePos(self.adding_note_pos)
+            note_manager:setNotePos(self.adding_note_pos)
+            self.subviews.notes_window.note_manager = note_manager
 
             return true
         elseif (keys.LEAVESCREEN or keys._MOUSE_R)then
@@ -309,7 +305,7 @@ end
 function NotesScreen:onRenderFrame(dc, rect)
     NotesScreen.super.onRenderFrame(self, dc, rect)
 
-    if not dfhack.screen.inGraphicsMode() and not gui.blink_visible(500) then
+    if self.enable_selector_blink and not gui.blink_visible(500) then
         return
     end
 
@@ -321,7 +317,9 @@ function NotesScreen:onRenderFrame(dc, rect)
 
         local function get_overlay_pen(pos)
             if same_xy(curr_pos, pos) then
-                local texpos = dfhack.textures.getTexposByHandle(green_pin[1])
+                local texpos = dfhack.textures.getTexposByHandle(
+                    notes_textures.green_pin[1]
+                )
                 return dfhack.pen.parse{
                     ch='X',
                     fg=COLOR_BLUE,

test/gui/notes.lua

@@ -3,6 +3,7 @@ local gui_notes = reqscript('gui/notes')
 local utils = require('utils')
 local guidm = require('gui.dwarfmode')
 local overlay = require('plugins.overlay')
+local notes_textures = reqscript('notes').textures
 
 config = {
     target = 'gui/notes',
@@ -43,6 +44,7 @@ local function arrange_gui_notes(options)
     gui_notes.main()
 
     local gui_notes = gui_notes.view
+    gui_notes.enable_selector_blink = false
 
     gui_notes:updateLayout()
     gui_notes:onRender()
@@ -238,7 +240,6 @@ function test.edit_note()
     note_manager.subviews.name:setText('updated green note 2')
     note_manager.subviews.comment:setText('updated comment 2')
     local screen = dfhack.gui.getCurViewscreen(true)
-    printall(screen.widgets)
     gui.simulateInput(dfhack.gui.getCurViewscreen(true), 'CUSTOM_CTRL_ENTER')
 
     local note_list = gui_notes.subviews.note_list:getChoices()
@@ -281,3 +282,68 @@ function test.delete_note()
 
     cleanup(gui_notes)
 end
+
+function test.create_new_note()
+    local notes = {
+        {name='green note 1', comment='comment 1', pos={x=1, y=1, z=1}},
+    }
+
+    local gui_notes, gui_notes_window = arrange_gui_notes({ notes=notes })
+
+    local note_list = gui_notes.subviews.note_list:getChoices()
+    expect.eq(#note_list, 1)
+
+    gui.simulateInput(dfhack.gui.getCurViewscreen(true), 'CUSTOM_CTRL_N')
+
+    local viewport = guidm.Viewport.get()
+
+    local half_x = math.floor((viewport.x1 + viewport.x2) / 2)
+    local half_y = math.floor((viewport.y1 + viewport.y2) / 2)
+
+    local pos = {x=half_x, y=half_y, z=viewport.z}
+    local screen_pos = viewport:tileToScreen(pos)
+    df.global.cursor = pos
+
+    -- should not be a test function to map screen tile to mouse pos?
+    df.global.gps.precise_mouse_x = screen_pos.x * df.global.gps.viewport_zoom_factor / 4
+    df.global.gps.precise_mouse_y = screen_pos.y * df.global.gps.viewport_zoom_factor / 4
+
+    df.global.gps.mouse_x = screen_pos.x
+    df.global.gps.mouse_y = screen_pos.y
+
+    gui_notes:render(gui.Painter.new())
+
+    local pen = dfhack.screen.readTile(screen_pos.x, screen_pos.y, true)
+
+    if dfhack.screen.inGraphicsMode() then
+        local pin_textpos = dfhack.textures.getTexposByHandle(
+            notes_textures.green_pin[1]
+        )
+        expect.eq(pen and pen.tile, pin_textpos)
+    else
+        expect.eq(pen and pen.ch, string.byte('X'))
+    end
+
+    gui.simulateInput(dfhack.gui.getCurViewscreen(true), '_MOUSE_L')
+
+    local note_manager = gui_notes_window.note_manager
+
+    expect.ne(note_manager, nil)
+    expect.eq(note_manager.visible, true)
+
+    note_manager.subviews.name:setText('note 2')
+    note_manager.subviews.comment:setText('new note')
+
+    gui.simulateInput(dfhack.gui.getCurViewscreen(true), 'CUSTOM_CTRL_ENTER')
+
+    local note_list = gui_notes.subviews.note_list:getChoices()
+    expect.eq(#note_list, 2)
+
+    local gui_note = note_list[2]
+    expect.eq(gui_note.text, 'note 2')
+    expect.eq(gui_note.point.comment, 'new note')
+    expect.table_eq(gui_note.point.pos, pos)
+
+    cleanup(gui_notes)
+end
+