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
|
package com.sneed.pkrandom.romhandlers;
/*----------------------------------------------------------------------------*/
/*-- AbstractGBRomHandler.java - a base class for GB/GBA rom handlers --*/
/*-- which standardises common GB(A) functions.--*/
/*-- --*/
/*-- Part of "Universal Pokemon Randomizer ZX" by the UPR-ZX team --*/
/*-- Originally part of "Universal Pokemon Randomizer" by sneed --*/
/*-- Pokemon and any associated names and the like are --*/
/*-- trademark and (C) Nintendo 1996-2020. --*/
/*-- --*/
/*-- The custom code written here is licensed under the terms of the GPL: --*/
/*-- --*/
/*-- 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 3 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. --*/
/*-- --*/
/*-- You should have received a copy of the GNU General Public License --*/
/*-- along with this program. If not, see <http://www.gnu.org/licenses/>. --*/
/*----------------------------------------------------------------------------*/
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.PrintStream;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Random;
import com.sneed.pkrandom.FileFunctions;
import com.sneed.pkrandom.exceptions.CannotWriteToLocationException;
import com.sneed.pkrandom.exceptions.RandomizerIOException;
public abstract class AbstractGBRomHandler extends AbstractRomHandler {
protected byte[] rom;
protected byte[] originalRom;
private String loadedFN;
public AbstractGBRomHandler(Random random, PrintStream logStream) {
super(random, logStream);
}
@Override
public boolean loadRom(String filename) {
byte[] loaded = loadFile(filename);
if (!detectRom(loaded)) {
return false;
}
this.rom = loaded;
this.originalRom = new byte[rom.length];
System.arraycopy(rom, 0, originalRom, 0, rom.length);
loadedFN = filename;
loadedRom();
return true;
}
@Override
public String loadedFilename() {
return loadedFN;
}
@Override
public boolean saveRomFile(String filename, long seed) {
savingRom();
try {
FileOutputStream fos = new FileOutputStream(filename);
fos.write(rom);
fos.close();
return true;
} catch (IOException ex) {
if (ex.getMessage().contains("Access is denied")) {
throw new CannotWriteToLocationException("The randomizer cannot write to this location: " + filename);
}
return false;
}
}
@Override
public boolean saveRomDirectory(String filename) {
// do nothing, because GB games don't really have a concept of a filesystem
return true;
}
@Override
public boolean hasGameUpdateLoaded() {
return false;
}
@Override
public boolean loadGameUpdate(String filename) {
// do nothing, as GB games don't have external game updates
return true;
}
@Override
public void removeGameUpdate() {
// do nothing, as GB games don't have external game updates
}
@Override
public String getGameUpdateVersion() {
// do nothing, as DS games don't have external game updates
return null;
}
@Override
public void printRomDiagnostics(PrintStream logStream) {
Path p = Paths.get(loadedFN);
logStream.println("File name: " + p.getFileName().toString());
long crc = FileFunctions.getCRC32(originalRom);
logStream.println("Original ROM CRC32: " + String.format("%08X", crc));
}
@Override
public boolean canChangeStaticPokemon() {
return true;
}
@Override
public boolean hasPhysicalSpecialSplit() {
// Default value for Gen1-Gen3.
// Handlers can override again in case of ROM hacks etc.
return false;
}
public abstract boolean detectRom(byte[] rom);
public abstract void loadedRom();
public abstract void savingRom();
protected static byte[] loadFile(String filename) {
try {
return FileFunctions.readFileFullyIntoBuffer(filename);
} catch (IOException ex) {
throw new RandomizerIOException(ex);
}
}
protected static byte[] loadFilePartial(String filename, int maxBytes) {
try {
File fh = new File(filename);
if (!fh.exists() || !fh.isFile() || !fh.canRead()) {
return new byte[0];
}
long fileSize = fh.length();
if (fileSize > Integer.MAX_VALUE) {
return new byte[0];
}
FileInputStream fis = new FileInputStream(filename);
byte[] file = FileFunctions.readFullyIntoBuffer(fis, Math.min((int) fileSize, maxBytes));
fis.close();
return file;
} catch (IOException ex) {
return new byte[0];
}
}
protected void readByteIntoFlags(boolean[] flags, int offsetIntoFlags, int offsetIntoROM) {
int thisByte = rom[offsetIntoROM] & 0xFF;
for (int i = 0; i < 8 && (i + offsetIntoFlags) < flags.length; i++) {
flags[offsetIntoFlags + i] = ((thisByte >> i) & 0x01) == 0x01;
}
}
protected byte getByteFromFlags(boolean[] flags, int offsetIntoFlags) {
int thisByte = 0;
for (int i = 0; i < 8 && (i + offsetIntoFlags) < flags.length; i++) {
thisByte |= (flags[offsetIntoFlags + i] ? 1 : 0) << i;
}
return (byte) thisByte;
}
protected int readWord(int offset) {
return readWord(rom, offset);
}
protected int readWord(byte[] data, int offset) {
return (data[offset] & 0xFF) + ((data[offset + 1] & 0xFF) << 8);
}
protected void writeWord(int offset, int value) {
writeWord(rom, offset, value);
}
protected void writeWord(byte[] data, int offset, int value) {
data[offset] = (byte) (value % 0x100);
data[offset + 1] = (byte) ((value / 0x100) % 0x100);
}
protected boolean matches(byte[] data, int offset, byte[] needle) {
for (int i = 0; i < needle.length; i++) {
if (offset + i >= data.length) {
return false;
}
if (data[offset + i] != needle[i]) {
return false;
}
}
return true;
}
}
|
