Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 231
Expand file tree
/
Copy pathnotes.lua
More file actions
365 lines (273 loc) · 11.4 KB
/
Copy pathnotes.lua
File metadata and controls
365 lines (273 loc) · 11.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
local gui = require('gui')
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',
mode = 'fortress'
}
local waypoints = df.global.plotinfo.waypoints
local map_points = df.global.plotinfo.waypoints.points
local map_points_backup = nil
local function arrange_notes(notes)
map_points_backup = utils.clone(map_points)
map_points:resize(0)
for _, note in ipairs(notes or {}) do
map_points:insert("#", {
new=true,
id=waypoints.next_point_id,
tile=88,
fg_color=7,
bg_color=0,
name=note.name,
comment=note.comment,
pos=note.pos
})
waypoints.next_point_id = waypoints.next_point_id + 1
end
end
local function arrange_gui_notes(options)
options = options or {}
-- running tests removes all overlays because of IN_TEST reloading.
-- rescan so we can load the gui/notes widget for these tests
overlay.rescan()
arrange_notes(options.notes)
gui_notes.main()
local view = gui_notes.view
view.enable_selector_blink = false
view:updateLayout()
view:onRender()
return view, view.subviews.notes_window
end
local function cleanup(gui_notes)
gui_notes:dismiss()
df.global.plotinfo.waypoints.points:resize(#map_points_backup)
for ind, map_point in ipairs(map_points_backup) do
df.global.plotinfo.waypoints.points[ind - 1] = map_point
end
map_points_backup = nil
end
function get_visible_map_center()
local viewport = guidm.Viewport.get()
local half_x = math.max(
math.floor((viewport.x1 + viewport.x2) / 2),
2
)
local half_y = math.max(
math.floor((viewport.y1 + viewport.y2) / 2),
2
)
return half_x, half_y, viewport.z
end
function test.load_gui_notes()
local gui_notes = arrange_gui_notes()
expect.eq(gui_notes.visible, true)
cleanup(gui_notes)
end
function test.provide_notes_list()
local notes = {
{name='note 1', comment='comment 1', pos={x=1, y=1, z=1}},
{name='note 2', comment='comment 2', pos={x=2, y=2, z=2}},
{name='note 3', comment='comment 3', pos={x=3, y=3, z=3}},
}
local gui_notes = arrange_gui_notes({ notes=notes })
local note_list = gui_notes.subviews.note_list:getChoices()
for ind, note in ipairs(notes) do
local gui_note = note_list[ind]
expect.eq(gui_note.text, note.name)
expect.eq(gui_note.point.comment, note.comment)
expect.table_eq(gui_note.point.pos, note.pos)
end
cleanup(gui_notes)
end
function test.auto_select_first_note()
local notes = {
{name='green note 1', comment='comment 1', pos={x=1, y=1, z=1}},
{name='green note 2', comment='comment 2', pos={x=2, y=2, z=2}},
{name='blue note 3', comment='comment 3', pos={x=3, y=3, z=3}},
}
local gui_notes = arrange_gui_notes({ notes=notes })
expect.eq(gui_notes.subviews.name.text_to_wrap, 'green note 1')
expect.eq(gui_notes.subviews.comment.text_to_wrap, 'comment 1')
cleanup(gui_notes)
end
function test.select_on_arrow_up_down()
local notes = {
{name='green note 1', comment='comment 1', pos={x=1, y=1, z=1}},
{name='green note 2', comment='comment 2', pos={x=2, y=2, z=2}},
{name='blue note 3', comment='comment 3', pos={x=3, y=3, z=3}},
}
local gui_notes = arrange_gui_notes({ notes=notes })
local screen = dfhack.gui.getCurViewscreen(true)
gui.simulateInput(screen, 'KEYBOARD_CURSOR_DOWN')
expect.eq(gui_notes.subviews.name.text_to_wrap, 'green note 2')
expect.eq(gui_notes.subviews.comment.text_to_wrap, 'comment 2')
gui.simulateInput(screen, 'KEYBOARD_CURSOR_DOWN')
expect.eq(gui_notes.subviews.name.text_to_wrap, 'blue note 3')
expect.eq(gui_notes.subviews.comment.text_to_wrap, 'comment 3')
gui.simulateInput(screen, 'KEYBOARD_CURSOR_DOWN')
expect.eq(gui_notes.subviews.name.text_to_wrap, 'green note 1')
expect.eq(gui_notes.subviews.comment.text_to_wrap, 'comment 1')
gui.simulateInput(screen, 'KEYBOARD_CURSOR_UP')
expect.eq(gui_notes.subviews.name.text_to_wrap, 'blue note 3')
expect.eq(gui_notes.subviews.comment.text_to_wrap, 'comment 3')
gui.simulateInput(screen, 'KEYBOARD_CURSOR_UP')
expect.eq(gui_notes.subviews.name.text_to_wrap, 'green note 2')
expect.eq(gui_notes.subviews.comment.text_to_wrap, 'comment 2')
cleanup(gui_notes)
end
function test.center_at_submit_note()
local notes = {
{name='green note 1', comment='comment 1', pos={x=1, y=1, z=1}},
{name='green note 2', comment='comment 2', pos={x=2, y=2, z=2}},
{name='blue note 3', comment='comment 3', pos={x=3, y=3, z=3}},
}
local gui_notes = arrange_gui_notes({ notes=notes })
local screen = dfhack.gui.getCurViewscreen(true)
-- it would be best to check viewport, but it's not updated instantly
-- and I do not know way how to force it
-- local viewport = guidm.Viewport.get()
local last_recenter_pos = nil
mock.patch(dfhack.gui, 'pauseRecenter', function (pos)
last_recenter_pos = pos
end, function ()
gui.simulateInput(screen, 'KEYBOARD_CURSOR_DOWN')
gui.simulateInput(screen, 'SELECT')
expect.eq(last_recenter_pos.x, 2)
expect.eq(last_recenter_pos.y, 2)
expect.eq(last_recenter_pos.z, 2)
gui.simulateInput(screen, 'KEYBOARD_CURSOR_DOWN')
gui.simulateInput(screen, 'SELECT')
expect.eq(last_recenter_pos.x, 3)
expect.eq(last_recenter_pos.y, 3)
expect.eq(last_recenter_pos.z, 3)
end)
cleanup(gui_notes)
end
function test.filter_notes()
local notes = {
{name='green note 1', comment='comment 1', pos={x=1, y=1, z=1}},
{name='green note 2', comment='comment 2', pos={x=2, y=2, z=2}},
{name='blue note 3', comment='comment 3', pos={x=3, y=3, z=3}},
}
local gui_notes = arrange_gui_notes({ notes=notes })
gui_notes.subviews.search:setText('green')
local note_list = gui_notes.subviews.note_list:getChoices()
expect.eq(#note_list, 2)
for ind, note in ipairs({table.unpack(notes, 1, 2)}) do
local gui_note = note_list[ind]
expect.eq(gui_note.text, note.name)
expect.eq(gui_note.point.comment, note.comment)
expect.table_eq(gui_note.point.pos, note.pos)
end
expect.eq(gui_notes.subviews.name.text_to_wrap, 'green note 1')
expect.eq(gui_notes.subviews.comment.text_to_wrap, 'comment 1')
gui_notes.subviews.search:setText('blue')
local note_list = gui_notes.subviews.note_list:getChoices()
expect.eq(#note_list, 1)
expect.eq(note_list[1].text, notes[3].name)
expect.eq(note_list[1].point.comment, notes[3].comment)
expect.table_eq(note_list[1].point.pos, notes[3].pos)
expect.eq(gui_notes.subviews.name.text_to_wrap, 'blue note 3')
expect.eq(gui_notes.subviews.comment.text_to_wrap, 'comment 3')
gui_notes.subviews.search:setText('red')
local note_list = gui_notes.subviews.note_list:getChoices()
expect.eq(#note_list, 0)
cleanup(gui_notes)
end
function test.edit_note()
local notes = {
{name='green note 1', comment='comment 1', pos={x=1, y=1, z=1}},
{name='green note 2', comment='comment 2', pos={x=2, y=2, z=2}},
{name='blue note 3', comment='comment 3', pos={x=3, y=3, z=3}},
}
local gui_notes, gui_notes_window = arrange_gui_notes({ notes=notes })
local screen = dfhack.gui.getCurViewscreen(true)
gui.simulateInput(screen, 'KEYBOARD_CURSOR_DOWN')
gui.simulateInput(screen, 'CUSTOM_CTRL_E')
local note_manager = gui_notes_window.note_manager
expect.ne(note_manager, nil)
expect.eq(note_manager.subviews.name:getText(), 'green note 2')
expect.eq(note_manager.subviews.comment:getText(), 'comment 2')
note_manager.subviews.name:setText('updated green note 2')
note_manager.subviews.comment:setText('updated comment 2')
local screen = dfhack.gui.getCurViewscreen(true)
gui.simulateInput(dfhack.gui.getCurViewscreen(true), 'CUSTOM_CTRL_ENTER')
local note_list = gui_notes.subviews.note_list:getChoices()
expect.eq(#note_list, 3)
local updated_note = note_list[2]
expect.eq(updated_note.text, 'updated green note 2')
expect.eq(updated_note.point.name, 'updated green note 2')
expect.eq(updated_note.point.comment, 'updated comment 2')
cleanup(gui_notes)
end
function test.delete_note()
local notes = {
{name='green note 1', comment='comment 1', pos={x=1, y=1, z=1}},
{name='green note 2', comment='comment 2', pos={x=2, y=2, z=2}},
{name='blue note 3', comment='comment 3', pos={x=3, y=3, z=3}},
}
local gui_notes = arrange_gui_notes({ notes=notes })
local screen = dfhack.gui.getCurViewscreen(true)
gui.simulateInput(screen, 'KEYBOARD_CURSOR_DOWN')
gui.simulateInput(screen, 'CUSTOM_CTRL_D')
local note_list = gui_notes.subviews.note_list:getChoices()
expect.eq(#note_list, 2)
for ind, note in ipairs({notes[1], notes[3]}) do
local gui_note = note_list[ind]
expect.eq(gui_note.text, note.name)
expect.eq(gui_note.point.comment, note.comment)
expect.table_eq(gui_note.point.pos, note.pos)
end
expect.eq(gui_notes.subviews.name.text_to_wrap, 'blue note 3')
expect.eq(gui_notes.subviews.comment.text_to_wrap, 'comment 3')
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, half_y = get_visible_map_center()
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=true,
_MOUSE_L_DOWN=true,
})
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
You can’t perform that action at this time.