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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Torch: src/Companion.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Torch
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.14.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('Companion_8h_source.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">Companion.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include <string></span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include <optional></span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <filesystem></span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include <vector></span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include <atomic></span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include <array></span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include <fstream></span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include <unordered_map></span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include <unordered_set></span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include <variant></span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include <functional></span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include "factories/BaseFactory.h"</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include "n64/Cartridge.h"</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#include "utils/Decompressor.h"</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include "factories/TextureFactory.h"</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#define CONTAINS(_map, value) ((_map).find(value) != (_map).end())</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="keyword">class </span><a class="code hl_class" href="classBinaryWrapper.html">BinaryWrapper</a>;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keyword">namespace </span>fs = std::filesystem;</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keyword">enum class</span> ParseMode {</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> Default,</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> Directory</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span>};</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keyword">enum class</span> GBIVersion {</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> f3db,</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> f3d,</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> f3dex,</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> f3dexb,</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> f3dex2,</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span>};</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="keyword">enum class</span> GBIMinorVersion {</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> None,</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> Mk64,</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> SM64,</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> PM64,</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> OoT,</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> BK64</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span>};</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="keyword">enum class</span> TableMode {</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> Reference,</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> Append</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span>};</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="keyword">enum class</span> ArchiveType {</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> None,</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> OTR,</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> O2R,</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span>};</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="foldopen" id="foldopen00057" data-start="{" data-end="};">
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="structSegmentConfig.html"> 57</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structSegmentConfig.html">SegmentConfig</a> {</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> std::unordered_map<uint32_t, uint32_t> global;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> std::unordered_map<uint32_t, uint32_t> local;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> std::unordered_map<uint32_t, uint32_t> temporal;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> std::optional<uint32_t> primaryVirtual;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> std::unordered_map<std::string, std::unordered_map<uint32_t, std::pair<std::uint32_t, std::uint32_t>>> compressed;</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span>};</div>
</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="foldopen" id="foldopen00065" data-start="{" data-end="};">
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="structTable.html"> 65</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structTable.html">Table</a> {</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> std::string name;</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> uint32_t start;</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> uint32_t end;</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> TableMode mode;</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> int32_t index_size;</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span>};</div>
</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="foldopen" id="foldopen00073" data-start="{" data-end="};">
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="structVRAMEntry.html"> 73</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structVRAMEntry.html">VRAMEntry</a> {</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> uint32_t addr;</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> uint32_t offset;</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span>};</div>
</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="foldopen" id="foldopen00078" data-start="{" data-end="};">
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="structResolvedAddr.html"> 78</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structResolvedAddr.html">ResolvedAddr</a> {</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> uint32_t addr;</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="keyword">enum</span> Kind {</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> Segmented, <span class="comment">// addr has a segment number (e.g. 0x06001CC4)</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> Absolute, <span class="comment">// addr is a physical ROM address (e.g. 0x00D269A0)</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> FileRelative, <span class="comment">// addr is a plain offset within the file (e.g. 0x00005CC8)</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> Unknown, <span class="comment">// addr has bit 31 set but we can't determine if it's</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <span class="comment">// segment-0x80 or VRAM for another file</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> } kind;</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span>};</div>
</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="foldopen" id="foldopen00089" data-start="{" data-end="};">
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="structWriteEntry.html"> 89</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structWriteEntry.html">WriteEntry</a> {</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> std::string name;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> uint32_t addr;</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> uint32_t alignment;</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> std::string buffer;</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> std::optional<std::string> comment;</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> std::optional<uint32_t> endptr;</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span>};</div>
</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="foldopen" id="foldopen00098" data-start="{" data-end="};">
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"><a class="line" href="structGBIConfig.html"> 98</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structGBIConfig.html">GBIConfig</a> {</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> GBIVersion version = GBIVersion::f3d;</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> GBIMinorVersion subversion = GBIMinorVersion::None;</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <span class="keywordtype">bool</span> useFloats = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span>};</div>
</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> </div>
<div class="foldopen" id="foldopen00104" data-start="{" data-end="};">
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"><a class="line" href="structTorchConfig.html"> 104</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structTorchConfig.html">TorchConfig</a> {</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> <a class="code hl_struct" href="structGBIConfig.html">GBIConfig</a> gbi;</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> <a class="code hl_struct" href="structSegmentConfig.html">SegmentConfig</a> segment;</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> std::string outputPath;</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> std::string moddingPath;</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> ExportType exporterType;</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> ParseMode parseMode;</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> ArchiveType otrMode;</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> <span class="keywordtype">bool</span> debug;</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> <span class="keywordtype">bool</span> modding;</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <span class="keywordtype">bool</span> textureDefines;</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> <span class="keywordtype">bool</span> strictDeclarations;</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> <span class="keywordtype">bool</span> includeAutogen;</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> <span class="keywordtype">bool</span> dialogPack = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> <span class="comment">// Default model-preview shading mode name (e.g. "textured + lit"); empty</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> <span class="comment">// uses each viewer's built-in fallback. See UI::ShadeSetupIndexByName.</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> std::string defaultShading;</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span>};</div>
</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> </div>
<div class="foldopen" id="foldopen00123" data-start="{" data-end="};">
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"><a class="line" href="structParseResultData.html"> 123</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structParseResultData.html">ParseResultData</a> {</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> std::string name;</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> std::string type;</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> YAML::Node node;</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> std::optional<std::shared_ptr<IParsedData>> data;</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> </div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> uint32_t GetOffset() {</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> <span class="keywordflow">return</span> GetSafeNode<uint32_t>(node, <span class="stringliteral">"offset"</span>);</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> }</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> </div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> std::optional<std::string> GetSymbol() {</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> <span class="keywordflow">return</span> GetSafeNode<std::string>(node, <span class="stringliteral">"symbol"</span>);</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> }</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span>};</div>
</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> </div>
<div class="foldopen" id="foldopen00138" data-start="{" data-end="};">
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"><a class="line" href="classCompanion.html"> 138</a></span><span class="keyword">class </span>Companion {</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> <span class="keyword">static</span> Companion* Instance;</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> </div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> <span class="keyword">explicit</span> Companion(std::filesystem::path rom, <span class="keyword">const</span> ArchiveType otr, <span class="keyword">const</span> <span class="keywordtype">bool</span> debug, <span class="keyword">const</span> <span class="keywordtype">bool</span> modding = <span class="keyword">false</span>,</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> <span class="keyword">const</span> std::string& srcDir = <span class="stringliteral">""</span>, <span class="keyword">const</span> std::string& destPath = <span class="stringliteral">""</span>) : gCartridge(<span class="keyword">nullptr</span>),</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> gSourceDirectory(srcDir), gDestinationDirectory(destPath) {</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> this->gRomPath = rom;</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> this->gConfig.otrMode = otr;</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> this->gConfig.debug = debug;</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> this->gConfig.modding = modding;</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> this->gConfig.textureDefines = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> this->gConfig.includeAutogen = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> }</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> </div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> <span class="keyword">explicit</span> Companion(std::vector<uint8_t> rom, <span class="keyword">const</span> ArchiveType otr, <span class="keyword">const</span> <span class="keywordtype">bool</span> debug, <span class="keyword">const</span> <span class="keywordtype">bool</span> modding = <span class="keyword">false</span>,</div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> <span class="keyword">const</span> std::string& srcDir = <span class="stringliteral">""</span>, <span class="keyword">const</span> std::string& destPath = <span class="stringliteral">""</span>) : gCartridge(<span class="keyword">nullptr</span>),</div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> gSourceDirectory(srcDir), gDestinationDirectory(destPath) {</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> this->gRomData = rom;</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> this->gConfig.otrMode = otr;</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> this->gConfig.debug = debug;</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> this->gConfig.modding = modding;</div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span> this->gConfig.textureDefines = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span> this->gConfig.includeAutogen = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> }</div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span> </div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> <span class="keywordtype">void</span> SetRomPath(std::filesystem::path path) { this->gRomPath = std::move(path); }</div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> </div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span> <span class="keyword">explicit</span> Companion(std::filesystem::path rom, <span class="keyword">const</span> ArchiveType otr, <span class="keyword">const</span> <span class="keywordtype">bool</span> debug, <span class="keyword">const</span> std::string& srcDir = <span class="stringliteral">""</span>, <span class="keyword">const</span> std::string& destPath = <span class="stringliteral">""</span>) :</div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span> Companion(rom, otr, debug, <span class="keyword">false</span>, srcDir, destPath) {}</div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span> </div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> <span class="keyword">explicit</span> Companion(std::vector<uint8_t> rom, <span class="keyword">const</span> ArchiveType otr, <span class="keyword">const</span> <span class="keywordtype">bool</span> debug, <span class="keyword">const</span> std::string& srcDir = <span class="stringliteral">""</span>, <span class="keyword">const</span> std::string& destPath = <span class="stringliteral">""</span>) :</div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span> Companion(rom, otr, debug, <span class="keyword">false</span>, srcDir, destPath) {}</div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span> </div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span> <span class="keywordtype">void</span> Init(ExportType type);</div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"> 173</span> <span class="keywordtype">void</span> Init(ExportType type, std::atomic<size_t>& assetCount, <span class="keywordtype">bool</span> shouldProcess);</div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno"> 174</span> </div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> <span class="keywordtype">bool</span> NodeHasChanges(<span class="keyword">const</span> std::string& <span class="keywordtype">string</span>);</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span> </div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span> <span class="keywordtype">void</span> Process(std::atomic<size_t>& assetCount);</div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span> </div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> <span class="keywordtype">bool</span> IsOTRMode()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (this->gConfig.otrMode != ArchiveType::None); }</div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span> <span class="keywordtype">bool</span> IsDebug()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> this->gConfig.debug; }</div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span> <span class="keywordtype">bool</span> AddTextureDefines()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> this->gConfig.textureDefines; }</div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno"> 182</span> </div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span> <a class="code hl_class" href="classN64_1_1Cartridge.html">N64::Cartridge</a>* GetCartridge()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> this->gCartridge.get(); }</div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> <span class="comment">// Survives cartridge teardown so the UI can key game-specific behavior.</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span> <span class="keyword">const</span> std::string& GetGameTitle()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> this->gGameTitle; }</div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span> std::vector<uint8_t>& GetRomData() { <span class="keywordflow">return</span> this->gRomData; }</div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> std::string GetOutputPath() { <span class="keywordflow">return</span> this->gConfig.outputPath; }</div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> <span class="keyword">const</span> std::string& GetAssetPath()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> this->gAssetPath; }</div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span> std::string GetDestRelativeOutputPath() { <span class="keywordflow">return</span> RelativePathToDestDir(GetOutputPath()); }</div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno"> 190</span> </div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span> GBIVersion GetGBIVersion()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> this->gConfig.gbi.version; }</div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span> GBIMinorVersion GetGBIMinorVersion()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> this->gConfig.gbi.subversion; }</div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span> std::unordered_map<std::string, std::vector<YAML::Node>> GetCourseMetadata() { <span class="keywordflow">return</span> this->gCourseMetadata; }</div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span> std::optional<std::string> GetEnumFromValue(<span class="keyword">const</span> std::string& key, <span class="keywordtype">int</span> <span class="keywordtype">id</span>);</div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno"> 195</span> <span class="keywordtype">bool</span> IsUsingIndividualIncludes()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> this->gIndividualIncludes; }</div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno"> 196</span> </div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno"> 197</span> std::optional<ParseResultData> GetParseDataByAddr(uint32_t addr);</div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno"> 198</span> std::optional<ParseResultData> GetParseDataBySymbol(<span class="keyword">const</span> std::string& symbol);</div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span> </div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno"> 200</span> std::optional<std::uint32_t> GetFileOffsetFromSegmentedAddr(uint8_t segment) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno"> 201</span> std::optional<std::pair<std::uint32_t, std::uint32_t>> GetFileOffsetFromCompressedSegmentedAddr(uint8_t segment) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno"> 202</span> std::optional<std::shared_ptr<BaseFactory>> GetFactory(<span class="keyword">const</span> std::string& type);</div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno"> 203</span> uint32_t PatchVirtualAddr(uint32_t addr);</div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno"> 204</span> <a class="code hl_struct" href="structResolvedAddr.html">ResolvedAddr</a> ResolveVirtualAddr(uint32_t addr);</div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno"> 205</span> std::optional<std::tuple<std::string, YAML::Node>> GetNodeByAddr(uint32_t addr);</div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno"> 206</span> <span class="comment">// File-scoped variant for use outside the parse/export passes, where</span></div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno"> 207</span> <span class="comment">// gCurrentFile no longer points at the owning file.</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno"> 208</span> std::optional<std::tuple<std::string, YAML::Node>> GetNodeByAddr(uint32_t addr, <span class="keyword">const</span> std::string& file);</div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno"> 209</span> std::optional<std::string> GetStringByAddr(uint32_t addr);</div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno"> 210</span> std::optional<std::tuple<std::string, YAML::Node>> GetSafeNodeByAddr(<span class="keyword">const</span> uint32_t addr, std::string type);</div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno"> 211</span> std::optional<std::string> GetSafeStringByAddr(<span class="keyword">const</span> uint32_t addr, std::string type);</div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span> std::optional<std::vector<std::tuple<std::string, YAML::Node>>> GetNodesByType(<span class="keyword">const</span> std::string& type, <span class="keywordtype">bool</span> includeAutogen = <span class="keyword">false</span>);</div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno"> 213</span> <span class="comment">// Same as GetNodesByType but returns a pointer into the internal cache to</span></div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno"> 214</span> <span class="comment">// avoid copying. The pointer is valid until the cache is invalidated; do not</span></div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span> <span class="comment">// hold across AddAsset/RegisterAsset calls. Returns nullptr if the current</span></div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno"> 216</span> <span class="comment">// file has no nodes registered.</span></div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno"> 217</span> <span class="keyword">const</span> std::vector<std::tuple<std::string, YAML::Node>>* GetNodesByTypeRef(<span class="keyword">const</span> std::string& type, <span class="keywordtype">bool</span> includeAutogen = <span class="keyword">false</span>);</div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno"> 218</span> std::string GetSymbolFromAddr(uint32_t addr, <span class="keywordtype">bool</span> validZero = <span class="keyword">false</span>);</div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"> 219</span> </div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span> std::optional<std::uint32_t> GetFileOffset(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> this->gCurrentFileOffset; };</div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span> std::optional<std::uint32_t> GetCurrSegmentNumber(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> this->gCurrentSegmentNumber; };</div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"> 222</span> CompressionType GetCurrCompressionType(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> this->gCurrentCompressionType; };</div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span> std::optional<std::uint32_t> GetCurrentCompressedSize(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> this->gCurrentCompressedSize; };</div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span> std::optional<VRAMEntry> GetCurrentVRAM(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> this->gCurrentVram; };</div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span> std::optional<Table> SearchTable(uint32_t addr);</div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"> 226</span> </div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span> <span class="keyword">static</span> std::vector<char> ParseVersionString(<span class="keyword">const</span> std::string& version);</div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno"> 228</span> <span class="keyword">static</span> std::string CalculateHash(<span class="keyword">const</span> std::vector<uint8_t>& data);</div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno"> 229</span> <span class="keyword">static</span> <span class="keywordtype">void</span> Pack(<span class="keyword">const</span> std::string& folder, <span class="keyword">const</span> std::string& output, <span class="keyword">const</span> ArchiveType otrMode, <span class="keyword">const</span> std::string& version = <span class="stringliteral">""</span>);</div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span> std::string NormalizeAsset(<span class="keyword">const</span> std::string& name) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno"> 231</span> std::string RelativePath(<span class="keyword">const</span> std::string& path) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno"> 232</span> std::string RelativePathToSrcDir(<span class="keyword">const</span> std::string& path) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno"> 233</span> std::string RelativePathToDestDir(<span class="keyword">const</span> std::string& path) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno"> 234</span> <span class="keywordtype">void</span> RegisterCompanionFile(<span class="keyword">const</span> std::string path, std::vector<char> data);</div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno"> 235</span> <span class="keywordtype">void</span> RegisterArchiveFile(<span class="keyword">const</span> std::string& name, std::vector<char> data);</div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno"> 236</span> <span class="keywordtype">void</span> SetAdditionalFiles(<span class="keyword">const</span> std::vector<std::string>& files) { this->gAdditionalFiles = files; }</div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno"> 237</span> <span class="keywordtype">void</span> SetVersion(<span class="keyword">const</span> std::string& version) { this->gVersion = version; }</div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno"> 238</span> </div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno"> 239</span> std::string GetCurrentAssetName()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> this->gCurrentAssetName; }</div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno"> 240</span> <span class="keywordtype">void</span> SetAssetTotal(std::atomic<size_t>* total) { this->gAssetTotal = total; }</div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno"> 241</span> <span class="keywordtype">void</span> SetPhaseCallback(std::function<<span class="keywordtype">void</span>(<span class="keywordtype">int</span>)> cb) { this->gPhaseCallback = cb; }</div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno"> 242</span> </div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno"> 243</span> <span class="keywordtype">void</span> SetProcess(<span class="keywordtype">bool</span> shouldProcess);</div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno"> 244</span> <a class="code hl_struct" href="structTorchConfig.html">TorchConfig</a>& GetConfig() { <span class="keywordflow">return</span> this->gConfig; }</div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno"> 245</span> <a class="code hl_class" href="classBinaryWrapper.html">BinaryWrapper</a>* GetCurrentWrapper() { <span class="keywordflow">return</span> this->gCurrentWrapper; }</div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno"> 246</span> <span class="keyword">const</span> std::unordered_map<std::string, std::string>& GetModdedAssetPaths()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> this->gModdedAssetPaths; }</div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno"> 247</span> </div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno"> 248</span> std::optional<std::tuple<std::string, YAML::Node>> RegisterAsset(<span class="keyword">const</span> std::string& name, YAML::Node& node);</div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno"> 249</span> std::optional<YAML::Node> AddSubFileAsset(YAML::Node asset, std::string newFileName, CompressionType newCompressionType, uint32_t compressedSize = 0);</div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno"> 250</span> std::optional<YAML::Node> AddAsset(YAML::Node asset);</div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno"> 251</span> std::string GetCurrentDirectory()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> gCurrentDirectory.generic_string(); }</div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno"> 252</span> <span class="keywordtype">void</span> SetCompressedSegment(uint32_t segmentId, uint32_t compressedFileOffset, uint32_t offset);</div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno"> 253</span> <span class="keywordtype">bool</span> GetCompressedSegmentOffset(uint32_t* addr);</div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno"> 254</span> </div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno"> 255</span> <span class="keywordtype">void</span> SetSingleYMLPath(<span class="keyword">const</span> std::string& path) { this->gSingleYMLPath = path; }</div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno"> 256</span> </div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno"> 257</span><span class="preprocessor">#ifdef BUILD_UI</span></div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno"> 258</span> <span class="keywordtype">void</span> RegisterUIFactory(<span class="keyword">const</span> std::string& type, <span class="keyword">const</span> std::shared_ptr<BaseFactoryUI>& factory);</div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno"> 259</span> std::optional<std::shared_ptr<BaseFactoryUI>> GetUIFactory(<span class="keyword">const</span> std::string& type);</div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno"> 260</span> <span class="keyword">const</span> std::unordered_map<std::string, std::vector<ParseResultData>>& GetParseResults() { <span class="keywordflow">return</span> this->gParseResults; }</div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno"> 261</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno"> 262</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno"> 263</span> <a class="code hl_struct" href="structTorchConfig.html">TorchConfig</a> gConfig;</div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno"> 264</span> YAML::Node gModdingConfig;</div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno"> 265</span> fs::path gSourceDirectory;</div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno"> 266</span> fs::path gDestinationDirectory;</div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno"> 267</span> fs::path gCurrentDirectory;</div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno"> 268</span> std::string gCurrentHash;</div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno"> 269</span> std::string gAssetPath;</div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno"> 270</span> std::string gVersion;</div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno"> 271</span> std::string gSingleYMLPath;</div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno"> 272</span> std::vector<uint8_t> gRomData;</div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno"> 273</span> std::optional<std::filesystem::path> gRomPath;</div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno"> 274</span> <span class="keywordtype">bool</span> gNodeForceProcessing = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno"> 275</span> <span class="keywordtype">bool</span> gIndividualIncludes = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno"> 276</span> YAML::Node gHashNode;</div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno"> 277</span> std::shared_ptr<N64::Cartridge> gCartridge;</div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno"> 278</span> std::string gGameTitle;</div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno"> 279</span> std::unordered_map<std::string, std::vector<YAML::Node>> gCourseMetadata;</div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno"> 280</span> std::unordered_map<std::string, std::unordered_map<int32_t, std::string>> gEnums;</div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno"> 281</span> <a class="code hl_class" href="classBinaryWrapper.html">BinaryWrapper</a>* gCurrentWrapper;</div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno"> 282</span> </div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno"> 283</span> <span class="comment">// Temporal Variables</span></div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno"> 284</span> std::string gCurrentAssetName;</div>
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno"> 285</span> std::atomic<size_t>* gAssetCounter = <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno"> 286</span> std::atomic<size_t>* gAssetTotal = <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno"> 287</span> std::function<void(<span class="keywordtype">int</span>)> gPhaseCallback;</div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno"> 288</span> std::string gCurrentFile;</div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno"> 289</span> std::vector<std::string> gSubFileList;</div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno"> 290</span> std::string gCurrentVirtualPath;</div>
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno"> 291</span> std::string gFileHeader;</div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno"> 292</span> <span class="keywordtype">bool</span> gEnablePadGen = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno"> 293</span> <span class="keywordtype">bool</span> mShouldProcess = <span class="keyword">true</span>;</div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno"> 294</span> uint32_t gCurrentPad = 0;</div>
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno"> 295</span> uint32_t gCurrentFileOffset;</div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno"> 296</span> uint32_t gCurrentSegmentNumber;</div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno"> 297</span> std::optional<VRAMEntry> gCurrentVram;</div>
<div class="line"><a id="l00298" name="l00298"></a><span class="lineno"> 298</span> CompressionType gCurrentCompressionType = CompressionType::None;</div>
<div class="line"><a id="l00299" name="l00299"></a><span class="lineno"> 299</span> std::optional<std::uint32_t> gCurrentCompressedSize;</div>
<div class="line"><a id="l00300" name="l00300"></a><span class="lineno"> 300</span> std::vector<Table> gTables;</div>
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno"> 301</span> std::vector<std::string> gCurrentExternalFiles;</div>
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno"> 302</span> std::unordered_map<int, std::string> gManualSegments;</div>
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno"> 303</span> std::unordered_set<std::string> gProcessedFiles;</div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno"> 304</span> </div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno"> 305</span> std::unordered_map<std::string, std::vector<char>> gCompanionFiles;</div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno"> 306</span> std::vector<std::pair<std::string, std::vector<char>>> gArchiveFiles;</div>
<div class="line"><a id="l00307" name="l00307"></a><span class="lineno"> 307</span> std::unordered_map<std::string, std::vector<ParseResultData>> gParseResults;</div>
<div class="line"><a id="l00308" name="l00308"></a><span class="lineno"> 308</span> std::vector<std::string> gAdditionalFiles;</div>
<div class="line"><a id="l00309" name="l00309"></a><span class="lineno"> 309</span> </div>
<div class="line"><a id="l00310" name="l00310"></a><span class="lineno"> 310</span> std::unordered_map<std::string, std::string> gModdedAssetPaths;</div>
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno"> 311</span> std::variant<std::vector<std::string>, std::string> gWriteOrder;</div>
<div class="line"><a id="l00312" name="l00312"></a><span class="lineno"> 312</span> std::unordered_map<std::string, std::shared_ptr<BaseFactory>> gFactories;</div>
<div class="line"><a id="l00313" name="l00313"></a><span class="lineno"> 313</span><span class="preprocessor">#ifdef BUILD_UI</span></div>
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno"> 314</span> std::unordered_map<std::string, std::shared_ptr<BaseFactoryUI>> gUIFactories;</div>
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno"> 315</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno"> 316</span> std::unordered_map<std::string, std::map<std::string, std::vector<WriteEntry>>> gWriteMap;</div>
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno"> 317</span> std::unordered_map<std::string, std::tuple<uint32_t, uint32_t>> gVirtualAddrMap;</div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno"> 318</span> std::unordered_map<std::string, std::unordered_map<uint32_t, std::tuple<std::string, YAML::Node>>> gAddrMap;</div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno"> 319</span> <span class="comment">// Cached results of GetNodesByType keyed by [file][type][includeAutogen?].</span></div>
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno"> 320</span> <span class="comment">// Built lazily; invalidated on RegisterAsset for the affected (file, type).</span></div>
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno"> 321</span> <span class="comment">// Index 0 = !includeAutogen, index 1 = includeAutogen.</span></div>
<div class="line"><a id="l00322" name="l00322"></a><span class="lineno"> 322</span> std::unordered_map<std::string,</div>
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno"> 323</span> std::unordered_map<std::string, std::array<std::vector<std::tuple<std::string, YAML::Node>>, 2>>></div>
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno"> 324</span> gNodesByTypeCache;</div>
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno"> 325</span> <span class="comment">// Validity bitmap; bit 0 = !includeAutogen, bit 1 = includeAutogen.</span></div>
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno"> 326</span> std::unordered_map<std::string, std::unordered_map<std::string, uint8_t>> gNodesByTypeCacheValid;</div>
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno"> 327</span> </div>
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno"> 328</span> <span class="keywordtype">void</span> ProcessParseFile(YAML::Node root, std::atomic<size_t>& assetCount);</div>
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno"> 329</span> <span class="keywordtype">void</span> ProcessExportFile();</div>
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno"> 330</span> <span class="keywordtype">void</span> ProcessFile(YAML::Node root);</div>
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno"> 331</span> <span class="keywordtype">void</span> ProcessFile(YAML::Node root, std::atomic<size_t>& assetCount);</div>
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno"> 332</span> std::optional<std::tuple<std::string, YAML::Node>> FindNodeInOverlaySegments(uint32_t addr, <span class="keyword">const</span> std::string& file);</div>
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno"> 333</span> std::optional<std::tuple<std::string, YAML::Node>> FindInExternalByVRAM(uint32_t addr, <span class="keyword">const</span> std::string& file);</div>
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno"> 334</span> <span class="keywordtype">void</span> ParseEnums(std::string& file);</div>
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno"> 335</span> <span class="keywordtype">void</span> ParseHash();</div>
<div class="line"><a id="l00336" name="l00336"></a><span class="lineno"> 336</span> <span class="keywordtype">void</span> ParseModdingConfig();</div>
<div class="line"><a id="l00337" name="l00337"></a><span class="lineno"> 337</span> <span class="keywordtype">void</span> ParseCurrentFileConfig(YAML::Node node, std::atomic<size_t>& assetCount);</div>
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno"> 338</span> <span class="keywordtype">void</span> RegisterFactory(<span class="keyword">const</span> std::string& type, <span class="keyword">const</span> std::shared_ptr<BaseFactory>& factory);</div>
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno"> 339</span> <span class="keywordtype">void</span> ExtractNode(YAML::Node& node, std::string& name, <a class="code hl_class" href="classBinaryWrapper.html">BinaryWrapper</a>* binary);</div>
<div class="line"><a id="l00340" name="l00340"></a><span class="lineno"> 340</span> <span class="keywordtype">void</span> ProcessTables(YAML::Node& rom);</div>
<div class="line"><a id="l00341" name="l00341"></a><span class="lineno"> 341</span> <span class="keywordtype">void</span> LoadYAMLRecursively(<span class="keyword">const</span> std::string &dirPath, std::vector<YAML::Node> &result, <span class="keywordtype">bool</span> skipRoot);</div>
<div class="line"><a id="l00342" name="l00342"></a><span class="lineno"> 342</span> std::vector<fs::directory_entry> GetAssetYMLs(YAML::Node& rom) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00343" name="l00343"></a><span class="lineno"> 343</span> std::optional<ParseResultData> ParseNode(YAML::Node& node, std::string& name);</div>
<div class="line"><a id="l00344" name="l00344"></a><span class="lineno"> 344</span>};</div>
</div>
<div class="ttc" id="aclassBinaryWrapper_html"><div class="ttname"><a href="classBinaryWrapper.html">BinaryWrapper</a></div><div class="ttdef"><b>Definition</b> BinaryWrapper.h:7</div></div>
<div class="ttc" id="aclassN64_1_1Cartridge_html"><div class="ttname"><a href="classN64_1_1Cartridge.html">N64::Cartridge</a></div><div class="ttdef"><b>Definition</b> Cartridge.h:15</div></div>
<div class="ttc" id="astructGBIConfig_html"><div class="ttname"><a href="structGBIConfig.html">GBIConfig</a></div><div class="ttdef"><b>Definition</b> Companion.h:98</div></div>
<div class="ttc" id="astructParseResultData_html"><div class="ttname"><a href="structParseResultData.html">ParseResultData</a></div><div class="ttdef"><b>Definition</b> Companion.h:123</div></div>
<div class="ttc" id="astructResolvedAddr_html"><div class="ttname"><a href="structResolvedAddr.html">ResolvedAddr</a></div><div class="ttdef"><b>Definition</b> Companion.h:78</div></div>
<div class="ttc" id="astructSegmentConfig_html"><div class="ttname"><a href="structSegmentConfig.html">SegmentConfig</a></div><div class="ttdef"><b>Definition</b> Companion.h:57</div></div>
<div class="ttc" id="astructTable_html"><div class="ttname"><a href="structTable.html">Table</a></div><div class="ttdef"><b>Definition</b> Companion.h:65</div></div>
<div class="ttc" id="astructTorchConfig_html"><div class="ttname"><a href="structTorchConfig.html">TorchConfig</a></div><div class="ttdef"><b>Definition</b> Companion.h:104</div></div>
<div class="ttc" id="astructVRAMEntry_html"><div class="ttname"><a href="structVRAMEntry.html">VRAMEntry</a></div><div class="ttdef"><b>Definition</b> Companion.h:73</div></div>
<div class="ttc" id="astructWriteEntry_html"><div class="ttname"><a href="structWriteEntry.html">WriteEntry</a></div><div class="ttdef"><b>Definition</b> Companion.h:89</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><b>Companion.h</b></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
</ul>
</div>
</body>
</html>
|
