-
Notifications
You must be signed in to change notification settings - Fork 36
/
debugui.py
executable file
·567 lines (492 loc) · 19.3 KB
/
debugui.py
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
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
#!/usr/bin/env python
#
# A Debug UI for the Hatari, part of Python Gtk Hatari UI
#
# Copyright (C) 2008-2019 by Eero Tamminen
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
import os
import gi
# use correct version of gtk
gi.require_version('Gtk', '3.0')
from gi.repository import Gtk
from gi.repository import Gdk
from gi.repository import Pango
from config import ConfigStore
from uihelpers import UInfo, create_button, create_toggle, \
create_table_dialog, table_add_entry_row, table_add_widget_row, \
get_save_filename, FselEntry
from dialogs import TodoDialog, ErrorDialog, AskDialog, KillDialog
def dialog_apply_cb(widget, dialog):
dialog.response(Gtk.ResponseType.APPLY)
# -------------
# Table dialogs
class SaveDialog:
def __init__(self, parent):
table, self.dialog = create_table_dialog(parent, "Save from memory", 3, 2)
self.file = FselEntry(self.dialog)
table_add_widget_row(table, 0, 0, "File name:", self.file.get_container())
self.address = table_add_entry_row(table, 1, 0, "Save address:", 6)
self.address.connect("activate", dialog_apply_cb, self.dialog)
self.length = table_add_entry_row(table, 2, 0, "Number of bytes:", 6)
self.length.connect("activate", dialog_apply_cb, self.dialog)
def run(self, address):
"run(address) -> (filename,address,length), all as strings"
if address:
self.address.set_text("%06X" % address)
self.dialog.show_all()
filename = length = None
while 1:
response = self.dialog.run()
if response == Gtk.ResponseType.APPLY:
filename = self.file.get_filename()
address_txt = self.address.get_text()
length_txt = self.length.get_text()
if filename and address_txt and length_txt:
try:
address = int(address_txt, 16)
except ValueError:
ErrorDialog(self.dialog).run("address needs to be in hex")
continue
try:
length = int(length_txt)
except ValueError:
ErrorDialog(self.dialog).run("length needs to be a number")
continue
if os.path.exists(filename):
question = "File:\n%s\nexists, replace?" % filename
if not AskDialog(self.dialog).run(question):
continue
break
else:
ErrorDialog(self.dialog).run("please fill the field(s)")
else:
break
self.dialog.hide()
return (filename, address, length)
class LoadDialog:
def __init__(self, parent):
chooser = Gtk.FileChooserButton('Select a File')
chooser.set_local_only(True) # Hatari cannot access URIs
chooser.set_width_chars(12)
table, self.dialog = create_table_dialog(parent, "Load to memory", 2, 2)
self.file = table_add_widget_row(table, 0, 0, "File name:", chooser)
self.address = table_add_entry_row(table, 1, 0, "Load address:", 6)
self.address.connect("activate", dialog_apply_cb, self.dialog)
def run(self, address):
"run(address) -> (filename,address), all as strings"
if address:
self.address.set_text("%06X" % address)
self.dialog.show_all()
filename = None
while 1:
response = self.dialog.run()
if response == Gtk.ResponseType.APPLY:
filename = self.file.get_filename()
address_txt = self.address.get_text()
if filename and address_txt:
try:
address = int(address_txt, 16)
except ValueError:
ErrorDialog(self.dialog).run("address needs to be in hex")
continue
break
else:
ErrorDialog(self.dialog).run("please fill the field(s)")
else:
break
self.dialog.hide()
return (filename, address)
class OptionsDialog:
def __init__(self, parent):
self.dialog = Gtk.Dialog("Debugger UI options", parent,
Gtk.DialogFlags.MODAL | Gtk.DialogFlags.DESTROY_WITH_PARENT,
(Gtk.STOCK_APPLY, Gtk.ResponseType.APPLY,
Gtk.STOCK_CLOSE, Gtk.ResponseType.CLOSE))
self.lines = Gtk.Adjustment(0, 5, 50)
scale = Gtk.HScale(adjustment=self.lines)
scale.set_digits(0)
self.follow_pc = Gtk.CheckButton("On stop, set address to PC")
vbox = self.dialog.vbox
vbox.add(Gtk.Label(label="Memdump/disasm lines:"))
vbox.add(scale)
vbox.add(self.follow_pc)
vbox.show_all()
def run(self, lines, follow_pc):
"run(lines,follow_pc) -> (lines,follow_pc)"
self.follow_pc.set_active(follow_pc)
self.lines.set_value(lines)
self.dialog.show_all()
response = self.dialog.run()
if response == Gtk.ResponseType.APPLY:
lines = int(self.lines.get_value())
follow_pc = self.follow_pc.get_active()
self.dialog.hide()
return (lines, follow_pc)
# ----------------------------------------------------
# constants for the other classes
class Constants:
# dump modes
DISASM = 1
MEMDUMP = 2
REGISTERS = 3
# move IDs
MOVE_MIN = 1
MOVE_MED = 2
MOVE_MAX = 3
# class for the memory address entry, view (label) and
# the logic for memory dump modes and moving in memory
class MemoryAddress:
# class variables
debug_output = None
hatari = None
def __init__(self, hatariobj):
# hatari
self.debug_output = hatariobj.open_debug_output()
self.hatari = hatariobj
# widgets
self.entry, self.memory = self.create_widgets()
# settings
self.dumpmode = Constants.REGISTERS
self.follow_pc = True
self.lines = 12
# addresses
self.first = None
self.second = None
self.last = None
def clear(self):
if self.follow_pc:
# get first address from PC when next stopped
self.first = None
self.second = None
self.last = None
def create_widgets(self):
entry = Gtk.Entry(max_length=6, width_chars=6)
entry.connect("activate", self._entry_cb)
memory = Gtk.Label(halign=Gtk.Align.START, margin_start=8, margin_end=8, margin_top=8)
mono = Pango.FontDescription("monospace")
memory.modify_font(mono)
entry.modify_font(mono)
return (entry, memory)
def _entry_cb(self, widget):
try:
address = int(widget.get_text(), 16)
except ValueError:
ErrorDialog(widget.get_toplevel()).run("invalid address")
return
self.dump(address)
def reset_entry(self):
self.entry.set_text("%06X" % self.first)
def get(self):
return self.first
def get_memory_label(self):
return self.memory
def get_address_entry(self):
return self.entry
def get_follow_pc(self):
return self.follow_pc
def set_follow_pc(self, follow_pc):
self.follow_pc = follow_pc
def get_lines(self):
return self.lines
def set_lines(self, lines):
self.lines = lines
def set_dumpmode(self, mode):
self.dumpmode = mode
self.dump()
def dump(self, address = None, move_idx = 0):
if self.dumpmode == Constants.REGISTERS:
output = self._get_registers()
self.memory.set_label("".join(output))
return
if not address:
if not self.first:
self._get_registers()
address = self.first
if not address:
print("ERROR: address needed")
return
if self.dumpmode == Constants.MEMDUMP:
output = self._get_memdump(address, move_idx)
elif self.dumpmode == Constants.DISASM:
output = self._get_disasm(address, move_idx)
else:
print("ERROR: unknown dumpmode:", self.dumpmode)
return
self.memory.set_label("".join(output))
if move_idx:
self.reset_entry()
def _get_registers(self):
self.hatari.debug_command("r")
output = self.hatari.get_lines(self.debug_output)
if not self.first:
# 2nd last line has first PC in 1st column, last line next PC in 2nd column
self.second = int(output[-1][output[-1].find(":")+2:], 16)
# OldUAE CPU core has ':' in both
offset = output[-2].find(":")
if offset < 0:
# WinUAE CPU core only in one
offset = output[-2].find(" ")
if offset < 0:
print("ERROR: unable to parse register dump line:\n\t'%s'", output[-2])
return output
self.first = int(output[-2][:offset], 16)
self.reset_entry()
return output
def _get_memdump(self, address, move_idx):
linewidth = 16
screenful = self.lines*linewidth
# no move, left/right, up/down, page up/down (no overlap)
offsets = [0, 2, linewidth, screenful]
offset = offsets[abs(move_idx)]
if move_idx < 0:
address -= offset
else:
address += offset
self._set_clamped(address, address+screenful)
self.hatari.debug_command("m $%06x-$%06x" % (self.first, self.last))
# get & set debugger command results
output = self.hatari.get_lines(self.debug_output)
self.second = address + linewidth
return output
def _get_disasm(self, address, move_idx):
# TODO: uses brute force i.e. ask for more lines that user has
# requested to be sure that the window is filled, assuming
# 6 bytes is largest possible instruction+args size
# (I don't remember anymore my m68k asm...)
screenful = 6*self.lines
# no move, left/right, up/down, page up/down
offsets = [0, 2, 4, screenful]
offset = offsets[abs(move_idx)]
# force one line of overlap in page up/down
if move_idx < 0:
address -= offset
if address < 0:
address = 0
if move_idx == -Constants.MOVE_MAX and self.second:
screenful = self.second - address
else:
if move_idx == Constants.MOVE_MED and self.second:
address = self.second
elif move_idx == Constants.MOVE_MAX and self.last:
address = self.last
else:
address += offset
self._set_clamped(address, address+screenful)
self.hatari.debug_command("d $%06x-$%06x" % (self.first, self.last))
# get & set debugger command results
output = self.hatari.get_lines(self.debug_output)
# cut output to desired length and check new addresses
if len(output) > self.lines:
if move_idx < 0:
output = output[-self.lines:]
else:
output = output[:self.lines]
# with disasm need to re-get the addresses from the output
self.first = int(output[0][1:output[0].find(":")], 16)
self.second = int(output[1][1:output[1].find(":")], 16)
self.last = int(output[-1][1:output[-1].find(":")], 16)
return output
def _set_clamped(self, first, last):
"set_clamped(first,last), clamp addresses to valid address range and set them"
assert(first < last)
if first < 0:
last = last-first
first = 0
if last > 0xffffff:
first = 0xffffff - (last-first)
last = 0xffffff
self.first = first
self.last = last
# the Hatari debugger UI class and methods
class HatariDebugUI:
def __init__(self, hatariobj, do_destroy = False):
self.address = MemoryAddress(hatariobj)
self.hatari = hatariobj
# set when needed/created
self.dialog_load = None
self.dialog_save = None
self.dialog_options = None
# set when UI created
self.keys = None
self.stop_button = None
# set on option load
self.config = None
self.load_options()
# UI initialization/creation
self.window = self.create_ui("Hatari Debug UI", do_destroy)
def create_ui(self, title, do_destroy):
# buttons at top
hbox1 = Gtk.HBox()
self.create_top_buttons(hbox1)
# disasm/memory dump at the middle
addr = self.address.get_memory_label()
# buttons at bottom
hbox2 = Gtk.HBox()
self.create_bottom_buttons(hbox2)
# their container
vbox = Gtk.VBox()
vbox.pack_start(hbox1, False, True, 0)
vbox.pack_start(addr, True, True, 0)
vbox.pack_start(hbox2, False, True, 0)
# and the window for all of this
window = Gtk.Window(Gtk.WindowType.TOPLEVEL)
window.set_events(Gdk.EventMask.KEY_RELEASE_MASK)
window.connect("key_release_event", self.key_event_cb)
if do_destroy:
window.connect("delete_event", self.quit)
else:
window.connect("delete_event", self.hide)
window.set_icon_from_file(UInfo.icon)
window.set_title(title)
window.add(vbox)
return window
def create_top_buttons(self, box):
self.stop_button = create_toggle("Stop", self.stop_cb)
box.add(self.stop_button)
monitor = create_button("Monitor...", self.monitor_cb)
box.add(monitor)
buttons = (
("<<<", "Page_Up", -Constants.MOVE_MAX),
("<<", "Up", -Constants.MOVE_MED),
("<", "Left", -Constants.MOVE_MIN),
(">", "Right", Constants.MOVE_MIN),
(">>", "Down", Constants.MOVE_MED),
(">>>", "Page_Down", Constants.MOVE_MAX)
)
self.keys = {}
for label, keyname, offset in buttons:
button = create_button(label, self.set_address_offset, offset)
keyval = Gdk.keyval_from_name(keyname)
self.keys[keyval] = offset
box.add(button)
# to middle of <<>> buttons
address_entry = self.address.get_address_entry()
box.pack_start(address_entry, False, True, 0)
box.reorder_child(address_entry, 5)
def create_bottom_buttons(self, box):
radios = (
("Registers", Constants.REGISTERS),
("Memdump", Constants.MEMDUMP),
("Disasm", Constants.DISASM)
)
group = None
for label, mode in radios:
button = Gtk.RadioButton(label=label, group=group, can_focus=False)
if not group:
group = button
button.connect("toggled", self.dumpmode_cb, mode)
box.add(button)
group.set_active(True)
dialogs = (
("Memload...", self.memload_cb),
("Memsave...", self.memsave_cb),
("Options...", self.options_cb)
)
for label, cb in dialogs:
button = create_button(label, cb)
box.add(button)
def stop_cb(self, widget):
if widget.get_active():
self.hatari.pause()
self.address.clear()
self.address.dump()
else:
self.hatari.unpause()
def dumpmode_cb(self, widget, mode):
if widget.get_active():
self.address.set_dumpmode(mode)
def key_event_cb(self, widget, event):
if event.keyval in self.keys:
self.address.dump(None, self.keys[event.keyval])
def set_address_offset(self, widget, move_idx):
self.address.dump(None, move_idx)
def monitor_cb(self, widget):
TodoDialog(self.window).run("add register / memory address range monitor window.")
def memload_cb(self, widget):
if not self.dialog_load:
self.dialog_load = LoadDialog(self.window)
(filename, address) = self.dialog_load.run(self.address.get())
if filename and address:
self.hatari.debug_command("l %s $%06x" % (filename, address))
def memsave_cb(self, widget):
if not self.dialog_save:
self.dialog_save = SaveDialog(self.window)
(filename, address, length) = self.dialog_save.run(self.address.get())
if filename and address and length:
self.hatari.debug_command("s %s $%06x $%06x" % (filename, address, length))
def options_cb(self, widget):
if not self.dialog_options:
self.dialog_options = OptionsDialog(self.window)
old_lines = self.config.get("[General]", "nLines")
old_follow_pc = self.config.get("[General]", "bFollowPC")
lines, follow_pc = self.dialog_options.run(old_lines, old_follow_pc)
if lines != old_lines:
self.config.set("[General]", "nLines", lines)
self.address.set_lines(lines)
if follow_pc != old_follow_pc:
self.config.set("[General]", "bFollowPC", follow_pc)
self.address.set_follow_pc(follow_pc)
def load_options(self):
# TODO: move config to MemoryAddress class?
# (depends on how monitoring of addresses should work)
lines = self.address.get_lines()
follow_pc = self.address.get_follow_pc()
miss_is_error = False # needed for adding windows
defaults = {
"[General]": {
"nLines": lines,
"bFollowPC": follow_pc
}
}
userconfdir = ".hatari"
config = ConfigStore(userconfdir, defaults, miss_is_error)
configpath = config.get_filepath("debugui.cfg")
config.load(configpath) # set defaults
try:
self.address.set_lines(config.get("[General]", "nLines"))
self.address.set_follow_pc(config.get("[General]", "bFollowPC"))
except (KeyError, AttributeError):
ErrorDialog(None).run("Debug UI configuration mismatch!\nTry again after removing: '%s'." % configpath)
self.config = config
def save_options(self):
self.config.save()
def show(self):
self.stop_button.set_active(True)
self.window.show_all()
self.window.deiconify()
def hide(self, widget, arg):
self.window.hide()
self.stop_button.set_active(False)
self.save_options()
return True
def quit(self, widget, arg):
KillDialog(self.window).run(self.hatari)
Gtk.main_quit()
def main():
import sys
from hatari import Hatari
hatariobj = Hatari()
if len(sys.argv) > 1:
if sys.argv[1] in ("-h", "--help"):
print("usage: %s [hatari options]" % os.path.basename(sys.argv[0]))
return
args = sys.argv[1:]
else:
args = None
hatariobj.run(args)
info = UInfo()
debugui = HatariDebugUI(hatariobj, True)
debugui.window.show_all()
Gtk.main()
debugui.save_options()
if __name__ == "__main__":
main()