-
Notifications
You must be signed in to change notification settings - Fork 24
/
parser.ts
198 lines (161 loc) · 5.22 KB
/
parser.ts
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
import {
ParseIterator,
UnparseIterator,
readKleiString,
readChars,
readInt32,
readCompressed,
writeCompressed,
writeKleiString,
writeChars,
writeInt32,
readBytes,
writeBytes,
} from "../parser";
import { ParseContext, WriteContext } from "./parse-context";
import { SaveGameHeader } from "./header";
import { parseHeader, unparseHeader } from "./header/parser";
import { TypeTemplates } from "./type-templates";
import {
parseTemplates,
unparseTemplates,
} from "./type-templates/template-parser";
import {
parseByTemplate,
unparseByTemplate,
} from "./type-templates/template-data-parser";
import { SaveGameWorld } from "./world";
import { parseWorld, unparseWorld } from "./world/parser";
import { SaveGameSettings } from "./settings";
import { parseSettings, unparseSettings } from "./settings/parser";
import { GameObjectGroup } from "./game-objects";
import { parseGameObjects, unparseGameObjects } from "./game-objects/parser";
import { SaveGameData } from "./game-data";
import { parseGameData, writeGameData } from "./game-data/parser";
import { SaveGame } from "./save-game";
import { validateVersion } from "./version-validator";
const SAVE_HEADER = "KSAV";
interface SaveGameBody {
world: SaveGameWorld;
settings: SaveGameSettings;
simData: ArrayBuffer;
version: {
major: number;
minor: number;
};
gameObjects: GameObjectGroup[];
gameData: SaveGameData;
}
export interface SaveGameParserOptions {
/**
* How strict the parser should be in ensuring the correct save file version is used.
* - "minor": Require the major and minor version to match. This is the safest option.
* - "major": Allow unknown minor versions as long as the major version matches.
* - "none": Disable version checking. This can result in corrupt data.
*/
versionStrictness?: "none" | "major" | "minor";
}
export function* parseSaveGame(
options: SaveGameParserOptions = {}
): ParseIterator<SaveGame> {
const header: SaveGameHeader = yield* parseHeader();
const { saveMajorVersion, saveMinorVersion } = header.gameInfo;
const versionStrictness = options.versionStrictness || "minor";
if (versionStrictness !== "none") {
validateVersion(saveMajorVersion, saveMinorVersion, versionStrictness);
}
const templates: TypeTemplates = yield* parseTemplates();
const context = makeSaveParserContext(header, templates);
let body: SaveGameBody;
if (header.isCompressed) {
body = yield readCompressed(parseSaveBody(context));
} else {
body = yield* parseSaveBody(context);
}
const saveGame: SaveGame = {
header,
templates,
...body,
};
return saveGame;
}
function* parseSaveBody(context: ParseContext): ParseIterator<SaveGameBody> {
const worldMarker = yield readKleiString();
if (worldMarker !== "world") {
throw new Error(`Expected "world" string.`);
}
const world: SaveGameWorld = yield* parseWorld(context);
const settings: SaveGameSettings = yield* parseSettings(context);
const simDataLength: number = yield readInt32();
const simData: ArrayBuffer = yield readBytes(simDataLength);
const ksav: string = yield readChars(SAVE_HEADER.length);
if (ksav !== SAVE_HEADER) {
throw new Error(
`Failed to parse ksav header: Expected "${SAVE_HEADER}" but got "${ksav}" (${Array.from(
ksav
).map((x) => x.charCodeAt(0))})`
);
}
const versionMajor: number = yield readInt32();
const versionMinor: number = yield readInt32();
// The header contains this same data and validates it.
// validateVersion(versionMajor, versionMinor);
const gameObjects: GameObjectGroup[] = yield* parseGameObjects(context);
const gameData: SaveGameData = yield* parseGameData(context);
const body: SaveGameBody = {
world,
settings,
simData,
version: {
major: versionMajor,
minor: versionMinor,
},
gameObjects,
gameData,
};
return body;
}
function makeSaveParserContext(
header: SaveGameHeader,
templates: TypeTemplates
): ParseContext {
return {
...header,
parseByTemplate: <T>(templateName: string) =>
parseByTemplate<T>(templates, templateName),
};
}
export function* unparseSaveGame(saveGame: SaveGame): UnparseIterator {
yield* unparseHeader(saveGame.header);
yield* unparseTemplates(saveGame.templates);
const context = makeSaveWriterContext(saveGame.header, saveGame.templates);
if (saveGame.header.isCompressed) {
yield writeCompressed(unparseSaveBody(saveGame, context));
} else {
yield* unparseSaveBody(saveGame, context);
}
}
function* unparseSaveBody(
saveGame: SaveGame,
context: WriteContext
): UnparseIterator {
yield writeKleiString("world");
yield* unparseWorld(saveGame.world, context);
yield* unparseSettings(saveGame.settings, context);
yield writeInt32(saveGame.simData.byteLength);
yield writeBytes(saveGame.simData);
yield writeChars(SAVE_HEADER);
yield writeInt32(saveGame.version.major);
yield writeInt32(saveGame.version.minor);
yield* unparseGameObjects(saveGame.gameObjects, context);
yield* writeGameData(saveGame.gameData, context);
}
function makeSaveWriterContext(
header: SaveGameHeader,
templates: TypeTemplates
): WriteContext {
return {
...header,
unparseByTemplate: unparseByTemplate.bind(null, templates),
};
}