-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
main.go
252 lines (214 loc) · 7.1 KB
/
main.go
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
// Package main implements a NES ROM disassembler
package main
import (
"errors"
"flag"
"fmt"
"io"
"os"
"path/filepath"
"strings"
disasm "github.com/retroenv/nesgodisasm/internal"
"github.com/retroenv/nesgodisasm/internal/assembler"
"github.com/retroenv/nesgodisasm/internal/assembler/ca65"
"github.com/retroenv/nesgodisasm/internal/options"
"github.com/retroenv/nesgodisasm/internal/verification"
"github.com/retroenv/retrogolib/arch/nes/cartridge"
"github.com/retroenv/retrogolib/buildinfo"
"github.com/retroenv/retrogolib/log"
)
var (
version = "dev"
commit = ""
date = ""
)
func main() {
logger, opts, disasmOptions := initializeApp()
if !opts.Quiet {
printBanner(logger, opts)
}
files, err := getFiles(opts)
if err != nil {
logger.Fatal(err.Error())
}
for _, file := range files {
opts.Input = file
if len(files) > 1 || opts.Output == "" {
// create output file name by replacing file extension with .asm
opts.Output = file[:len(file)-len(filepath.Ext(file))] + ".asm"
}
if err := disasmFile(logger, opts, disasmOptions); err != nil {
logger.Error("Disassembling failed", log.Err(err))
}
}
}
func initializeApp() (*log.Logger, *options.Program, *options.Disassembler) {
flags := flag.NewFlagSet(os.Args[0], flag.ExitOnError)
opts := &options.Program{}
var zeroBytes bool
flags.StringVar(&opts.Assembler, "a", "", "Assembler compatibility of the generated .asm file (asm6/ca65/nesasm)")
flags.StringVar(&opts.Batch, "batch", "", "process a batch of given path and file mask and automatically .asm file naming, for example *.nes")
// TODO add config option to generate ca65 config for the ROM
flags.BoolVar(&opts.Debug, "debug", false, "enable debugging options for extended logging")
flags.StringVar(&opts.CodeDataLog, "cdl", "", "name of the .cdl Code/Data log file to load")
flags.BoolVar(&opts.NoHexComments, "nohexcomments", false, "do not output opcode bytes as hex values in comments")
flags.BoolVar(&opts.NoOffsets, "nooffsets", false, "do not output offsets in comments")
flags.StringVar(&opts.Output, "o", "", "name of the output .asm file, printed on console if no name given")
flags.BoolVar(&opts.Quiet, "q", false, "perform operations quietly")
flags.BoolVar(&opts.AssembleTest, "verify", false, "verify the generated output by assembling with ca65 and check if it matches the input")
flags.BoolVar(&zeroBytes, "z", false, "output the trailing zero bytes of banks")
err := flags.Parse(os.Args[1:])
args := flags.Args()
opts.Assembler = strings.ToLower(opts.Assembler)
if opts.Assembler == "asm6f" {
opts.Assembler = "asm6"
}
disasmOptions := options.NewDisassembler(opts.Assembler)
disasmOptions.ZeroBytes = zeroBytes
logger := createLogger(opts)
if err != nil || (len(args) == 0 && opts.Batch == "") {
printBanner(logger, opts)
fmt.Printf("usage: nesgodisasm [options] <file to disassemble>\n\n")
flags.PrintDefaults()
fmt.Println()
os.Exit(1)
}
if opts.Batch == "" {
opts.Input = args[0]
}
return logger, opts, &disasmOptions
}
func createLogger(options *options.Program) *log.Logger {
cfg := log.DefaultConfig()
if options.Debug {
cfg.Level = log.DebugLevel
}
if options.Quiet {
cfg.Level = log.ErrorLevel
}
return log.NewWithConfig(cfg)
}
func printBanner(logger *log.Logger, options *options.Program) {
if !options.Quiet {
fmt.Println("[------------------------------------]")
fmt.Println("[ nesgodisasm - NES ROM disassembler ]")
fmt.Printf("[------------------------------------]\n\n")
logger.Info("Build info", log.String("version", buildinfo.Version(version, commit, date)))
}
}
// getFiles returns the list of files to process, either a single file or the matched files for
// batch processing.
func getFiles(options *options.Program) ([]string, error) {
if options.Batch == "" {
return []string{options.Input}, nil
}
files, err := filepath.Glob(options.Batch)
if err != nil {
return nil, fmt.Errorf("finding batch files failed: %w", err)
}
if len(files) == 0 {
return nil, errors.New("no input files matched")
}
options.Output = ""
return files, nil
}
// nolint: cyclop, funlen
func disasmFile(logger *log.Logger, opts *options.Program, disasmOptions *options.Disassembler) error {
file, err := os.Open(opts.Input)
if err != nil {
return fmt.Errorf("opening file '%s': %w", opts.Input, err)
}
cart, err := cartridge.LoadFile(file)
if err != nil {
return fmt.Errorf("reading file: %w", err)
}
_ = file.Close()
if !opts.Quiet {
logger.Info("Processing ROM",
log.String("file", opts.Input),
log.Uint8("mapper", cart.Mapper),
log.String("assembler", opts.Assembler),
)
}
if cart.Mapper != 0 && cart.Mapper != 3 {
logger.Warn("Support for this mapper is experimental, multi bank mapper support is still in development")
}
if err := openCodeDataLog(opts, disasmOptions); err != nil {
return err
}
disasmOptions.HexComments = !opts.NoHexComments
disasmOptions.OffsetComments = !opts.NoOffsets
dis, err := disasm.New(logger, cart, disasmOptions)
if err != nil {
return fmt.Errorf("initializing disassembler: %w", err)
}
if disasmOptions.CodeDataLog != nil {
_ = disasmOptions.CodeDataLog.Close()
}
var outputFile io.WriteCloser
var newBankWriter assembler.NewBankWriter
if opts.Output == "" {
outputFile = os.Stdout
newBankWriter = newBankWriterStdOut
} else {
outputFile, err = os.Create(opts.Output)
if err != nil {
return fmt.Errorf("creating file '%s': %w", opts.Output, err)
}
newBankWriter = newBankWriterFile(opts.Output)
}
if err = dis.Process(outputFile, newBankWriter); err != nil {
return fmt.Errorf("processing file: %w", err)
}
if err = outputFile.Close(); err != nil {
return fmt.Errorf("closing file: %w", err)
}
if opts.Debug && opts.Assembler == assembler.Ca65 {
printCa65Config(logger, cart, dis)
}
if opts.AssembleTest {
if err = verification.VerifyOutput(logger, cart, opts, dis.CodeBaseAddress()); err != nil {
return fmt.Errorf("output file mismatch: %w", err)
}
if !opts.Quiet {
logger.Info("Output file matched input file")
}
}
return nil
}
func printCa65Config(logger *log.Logger, cart *cartridge.Cartridge, dis *disasm.Disasm) {
ca65Config := ca65.Config{
PrgBase: int(dis.CodeBaseAddress()),
PRGSize: len(cart.PRG),
CHRSize: len(cart.CHR),
}
cfg := ca65.GenerateMapperConfig(ca65Config)
logger.Debug("Ca65 config:")
fmt.Println(cfg)
}
func openCodeDataLog(options *options.Program, disasmOptions *options.Disassembler) error {
if options.CodeDataLog == "" {
return nil
}
logFile, err := os.Open(options.CodeDataLog)
if err != nil {
return fmt.Errorf("opening file '%s': %w", options.CodeDataLog, err)
}
disasmOptions.CodeDataLog = logFile
return nil
}
func newBankWriterFile(outputFile string) assembler.NewBankWriter {
ext := filepath.Ext(outputFile)
base := strings.TrimSuffix(outputFile, ext)
return func(baseName string) (io.WriteCloser, error) {
fileName := fmt.Sprintf("%s%s%s", base, baseName, ext)
f, err := os.Create(fileName)
if err != nil {
return nil, fmt.Errorf("creating file '%s': %w", fileName, err)
}
return f, nil
}
}
func newBankWriterStdOut(_ string) (io.WriteCloser, error) {
return os.Stdout, nil
}