-
Notifications
You must be signed in to change notification settings - Fork 6
/
Program.js
490 lines (428 loc) · 24.7 KB
/
Program.js
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
const fs = require("node:fs");
const FileEditor = require("./FileEditor");
const Scanner = require("./Scanner");
const Processor = require("./Processor");
const TokenReader = require("./TokenReader");
const Logger = require("./Logger");
const Configuration = require("./Configuration");
const Wrapper = require("./Wrapper");
const Token = require("./Token");
const Util = require("./Util")
/**
* Reads specific C++ files and automatically creates wrapped functions for GameMaker
*
* Written by Nommiin - https://github.com/Nommiin
*/
class Program {
/**
* Entry point for tool, see Configuration.js for options
* @param {string} wrapper Path to wrapper .cpp file
* @param {string} extension Path to extension .yy file
* @param {string} script Path to ImGui .gml script
*/
static main(root, extension, script) {
Logger.info("Reading ImGui header...");
const header = this.parseHeader(new FileEditor(root + "imgui.h"));
Logger.info("Retrieving wrappers...");
const files = fs.readdirSync(root).filter(e => e.endsWith("_gm.cpp"));
if (files.length === 0) throw `Could not run program, could not find any wrapper files in "${root}"`;
Logger.info(`Found ${files.length} wrapper files in "${root}"`);
const wrappers = [];
Logger.info("Parsing wrappers...");
files.forEach(e => {
if (e.startsWith("imgui_impl_gm")) return;
this.parseWrapper(wrappers, new FileEditor(`${root}${e}`, true));
});
Logger.info("Writing wrappers...");
this.writeWrappers(wrappers, new FileEditor(extension));
Logger.info("Writing script...");
this.writeScripts(wrappers, header.enums, new FileEditor(script));
Logger.info(`Successfully wrote ${wrappers.length} wrappers`);
if (Configuration.WRITE_REPORT) {
Logger.info("Writing coverage report...");
this.writeReport(header, wrappers, new FileEditor("COVERAGE.md"));
}
if (Configuration.WRITE_SNAKE) {
Logger.info("Writing snake-case script...");
this.writeSnakeCase(wrappers, header.enums, new FileEditor("snake_case.gml"));
Logger.info(`Successfully wrote ${wrappers.length} wrappers`);
}
if (Configuration.WRITE_DOCS) {
Logger.info("Writing documentation export...");
this.writeDocumentation(header, wrappers, new FileEditor("docs/assets/export.js"));
Logger.info(`Successfully wrote documentation export file`);
}
}
/**
* Naively parses imgui.h to retrieve API functions, also collects enums
* @param {FileEditor} file A file editor containing the ImGui header file
*/
static parseHeader(file) {
const header = {functions: [], enums: {}};
const tokens = new Processor(new Scanner(file.Content).Tokens).get();
if (tokens.length === 0) throw `Could not parse "${file.Name}", processed token list is empty`;
const reader = new TokenReader(tokens);
while (!reader.end()) {
const token = reader.advance();
if (token && (token.Type === "Keyword")) {
switch (token.Literal) {
case "namespace": {
const prev = reader.previous();
if (prev.Literal === "IMGUI_DISABLE_OBSOLETE_FUNCTIONS") continue;
const next = reader.advance();
if (next.Type !== "Identifier" || next.Literal !== "ImGui") continue;
const more = reader.advance();
if (more.Type !== "BracePair") continue;
const children = new TokenReader(more.Children);
while (!children.end()) {
const token = children.advance();
if (token && (token.Type === "Identifier")) {
if (token.Literal !== "IMGUI_API") continue;
const type = children.advance();
switch (type.Type) {
case "Keyword":
case "Identifier":
case "Dereference":
case "TypePointer": break;
default: {
Logger.warning(`Could not handle type "${type.Type}" for IMGUI_API definition at line ${token.Line}`);
continue;
}
}
const func = children.advance();
header.functions.push({
Name: func.Literal,
Type: type.Literal,
Line: token.Line
});
}
}
break;
}
case "enum": {
const next = reader.advance();
if (next.Type !== "Identifier") continue;
const name = next.Literal;
switch (name) {
case "ImGuiKey":
case "ImDrawCornerFlags_":
case "ImGuiModFlags_": continue;
// ImGuiKey is manually defined in ImGui_Misc, the others are obsolete/cause issues anyway
// TODO: I guess?
}
const def = {};
let inner;
for(let i = reader.Index; i < reader.Length; i++) {
const find = reader.Tokens[i];
if (find.Type !== Token.name("{}")) continue;
if (!find.Children) throw `Could not parse "${file.Name}", expected tokens in ${Token.name("{}")} token for ${token.Literal} at line ${token.Line}`;
inner = find;
reader.Index = i;
break;
}
if (!inner) throw `Could not parse "${file.Name}", expected ${Token.name("{}")} token for enum "${name}" at line ${token.Line}`;
const children = new TokenReader(inner.Children);
while (!children.end()) {
const token = children.advance();
const prev = children.previous();
switch (token.Type) {
case Token.name("="): {
if (prev.Type !== "Identifier") throw `Could not parse "${file.Name}", expected Identifier token for enum "${name}" at line ${next.Line}`;
// TODO: .filter should probably take a function instead of copied lambda
let found = false;
for(let i = children.Index; i < children.Length; i++) {
const find = children.Tokens[i];
if (find.Type !== Token.name(",")) continue;
const inner = children.Tokens.slice(children.Index, i).filter(e => {
switch (e.Type) {
case Token.name("#"): return false;
}
return true;
});
found = true;
def[prev.Literal] = inner.map(e => e.Literal).join(" ");
children.Index = i + 1;
break;
}
if (!found) {
const inner = children.Tokens.slice(children.Index, children.Length).filter(e => {
switch (e.Type) {
case Token.name("#"): return false;
}
return true;
});
def[prev.Literal] = inner.map(e => e.Literal).join(" ");
children.Index = children.Length;
Logger.warning(`Reached end of enum member "${prev.Literal}" without trailing comma`);
}
break;
}
case Token.name(","): {
def[prev.Literal] = 0;
break;
}
}
}
header.enums[name] = def;
break;
}
}
}
}
Logger.info(`Successfully parsed "${file.Name}" and retrieved ${header.functions.length} API functions and ${Object.keys(header.enums).length} enums`);
return header;
}
/**
* Reads imgui_gm.cpp script and parses out wrapped functions
* @param {Array<Wrapper>} wrappers
* @param {FileEditor} file A file editor containing the wrapper file
*/
static parseWrapper(wrappers, file) {
const tokens = new Processor(new Scanner(file.Content).Tokens).get();
if (tokens.length === 0) throw `Could not parse "${file.Name}", processed token list is empty`;
let count = 0;
const reader = new TokenReader(tokens), keyword = Configuration.WRAPPER_DEF;
while (!reader.end()) {
const token = reader.advance();
if (token && (token.Type === "FunctionDef" && token.Literal === keyword)) {
const name = token.Children[0];
if (!name || name.Type !== "Identifier") throw `Could not parse "${file.Name}", expected Identifier token for ${token.Literal} at line ${token.Line}`;
const next = reader.advance();
if (!next || next.Type !== Token.name("{}")) throw `Could not parse "${file.Name}", expected ${Token.name("{}")} token for ${token.Literal} at line ${token.Line}`;
if (!next.Children || next.Children.length === 0) throw `Could not parse "${file.Name}", expected content inside ${Token.name("{}")} for ${token.Literal} at line ${token.Line}`;
const wrapper = new Wrapper(name.Literal, file.Name, token.Line);
const children = new TokenReader(next.Children);
let valid = true;
while (!children.end()) {
const token = children.advance();
const left = children.previous();
switch (token.Type) {
case Token.name("="): {
const offset = children.peek()?.Type === "Cast" ? 1 : 0;
const right = children.peek(offset);
switch (left.Type) {
case "Identifier": {
if (left.Literal === "kind" && children.match("Result.kind", -4)) {
wrapper.returns(right.Literal);
children.advance();
continue;
}
switch (right.Type) {
case "FunctionCall": {
if (right.Literal.startsWith("YYGet")) {
const inner = right.Children.filter(e => e.Type !== Token.name(","));
if (inner.length < 2) throw `Could not parse "${file.Name}", expected at least 2 arguments for call to ${right.Literal} at line ${right.Line}`;
const ident = inner[0];
if (ident.Type !== "Identifier" || ident.Literal !== "arg") throw `Could not parse "${file.Name}", expected "arg" variable but got ${ident.Literal} as first argument for call to ${right.Literal} at line ${right.Line}`;
const ind = inner[1];
if (ind.Type !== "Number") throw `Could not parse "${file.Name}", expected Number but got ${ind.Type} as second argument for call to ${right.Literal} at line ${right.Line}`;
wrapper.argument(left.Literal, ind.Literal, right.Literal);
children.advance();
}
break;
}
case "AddressOf":
case "Identifier": {
if (right.Literal === "arg") {
const more = children.peek(offset + 1);
if (more.Type === Token.name("[]")) {
const inner = more.Children[0];
if (inner.Type !== "Number") throw `Could not parse "${file.Name}", expected Number but got ${inner.Type} as index for argument array at line ${right.Line}`;
if (left.Literal === "Result") wrapper.return_arg(inner.Literal);
else wrapper.argument(left.Literal, inner.Literal);
children.advance();
}
}
break;
}
}
break;
}
}
break;
}
case Token.name("::"): {
if (left.Type === "Identifier" && left.Literal === "ImGui") {
const right = children.peek();
if (right.Type !== "FunctionCall") throw `Could not parse "${file.Name}", expected FunctionCall but got ${right.Type} after scope resolution token at line ${token.Line}`;
wrapper.calls(right.Literal);
children.advance();
}
break;
}
case "FunctionCall": {
if (token.Literal.startsWith("GM")) wrapper.modifier(token)
break;
}
}
}
if (valid) {
wrappers.push(wrapper.finalize());
count++;
}
}
}
Logger.info(`Successfully parsed "${file.Name}" and retrieved ${count} wrapper definitions`);
return wrappers;
}
/**
*
* @param {Array<Wrapper>} wrappers
* @param {FileEditor} file A file editor containing the extension file
*/
static writeWrappers(wrappers, file) {
const extension = JSON.parse(Util.clean_yy(file.Content));
if (extension.resourceType !== "GMExtension") throw `Could not parse "${file.Name}", expected GMExtension .yy file`;
const res_index = extension.files.findIndex(e => e.filename === "imgui_gm.dll");//, resource = extension.files.find(e => e.filename === "imgui_gm.dll");
if (res_index === -1) throw `Could not parse "${file.Name}", expected entry "imgui_gm.dll" in extension files`;
const resource = extension.files[res_index];
const functions = resource.functions.filter(e => !wrappers.find(w => w.Name === e?.name));
wrappers.forEach(e => {
functions.push(e.to_extension());
});
extension.files[res_index].functions = functions;
if (file.update(JSON.stringify(extension, undefined, 4))) file.commit();
}
/**
*
* @param {Array<Wrapper>} wrappers
* @param {object} enums
* @param {FileEditor} file A file editor containing the GML script file
*/
static writeScripts(wrappers, enums, file) {
const tokens = new Scanner(file.Content, {comments: true, positions: true}).Tokens;
let start = -1;
let end = -1;
for(let i = 0; i < tokens.length; i++) {
const token = tokens[i];
if (token.Type !== "Comment" || !token.Literal.startsWith("///")) continue;
const inner = token.Literal.slice(3).trim();
if (!inner.startsWith("@section")) continue;
const section = inner.slice("@section".length).trim().toLowerCase();
switch (section) {
case "binds": {
start = token.Position + token.Literal.length;
break;
}
case "internal": {
end = token.Position;
break;
}
}
}
if (start === -1) throw `Could not parse "${file.Name}", could not find "Binds" @section comment`;
if (end === -1) throw `Could not parse "${file.Name}", could not find "Internal" @section comment`;
const content = [];
wrappers.forEach(e => {
if (e.Calls === "_") {
Logger.warning(`Skipping wrapper "${e.Name}", call target marked as discard`);
return;
}
content.push(e.to_jsdoc(enums) + "\n" + e.to_gml());
});
let enum_def = `\n${Configuration.SPACING}/// @section Enums\n`;
for(const key in enums) {
const name = key.endsWith("_") ? key.slice(0, -1) : key;
enum_def += `${Configuration.SPACING}enum ${name} {\n`;
const members = Object.keys(enums[key]);
for(let i = 0; i < members.length; i++) {
const value = enums[key][members[i]];
const member = members[i].replaceAll(name + "_", "");
if (value === 0) {
enum_def += `${Configuration.SPACING.repeat(2)}${member},\n`;
continue;
}
enum_def += `${Configuration.SPACING.repeat(2)}${member} = ${value.replaceAll(name + "_", `${name}.`)},\n`;
}
enum_def += `${Configuration.SPACING}}\n\n`;
}
const final = file.Content.slice(0, start) + content.join("\n") + enum_def + Configuration.SPACING + file.Content.slice(end);
if (file.update(final)) file.commit();
}
/**
*
* @param {object} api
* @param {Array<Wrapper>} wrappers
* @param {FileEditor} file A file editor containing the GML script file
*/
static writeReport(header, wrappers, file) {
const func = header.functions;
const notes = {
"NewFrame": "Handled internally by [__imgui_update function](https://github.com/nommiin/ImGui_GM/blob/main/dll/main.cpp#L63)",
"Render": "Handled internally by [__imgui_render function](https://github.com/nommiin/ImGui_GM/blob/main/dll/main.cpp#L69)",
"GetWindowPos": "ImVec2 returns are unsupported, use X/Y wrappers",
"GetWindowSize": "ImVec2 returns are unsupported, use Width/Height wrappers",
"GetContentRegionAvail": "ImVec2 returns are unsupported, use X/Y wrappers",
"GetContentRegionMax": "ImVec2 returns are unsupported, use X/Y wrappers",
"GetWindowContentRegionMin": "ImVec2 returns are unsupported, use X/Y wrappers",
"GetWindowContentRegionMax": "ImVec2 returns are unsupported, use X/Y wrappers",
"PushFont": "Fonts are currently unimplemented",
"PopFont": "Fonts are currently unimplemented",
"GetCursorPos": "ImVec2 returns are unsupported, use X/Y wrappers",
"GetCursorStartPos": "ImVec2 returns are unsupported, use X/Y wrappers",
"GetCursorScreenPos": "ImVec2 returns are unsupported, use X/Y wrappers",
"CalcTextSize": "ImVec2 returns are unsupported, use Width/Height wrappers",
"GetPlatformIO": "Unsupported",
"SetDragDropPayload": "See [Drag and Drop Payloads](https://github.com/nommiin/ImGui_GM/wiki/Drag-and-Drop-Payloads) for more info on handling payloads",
"GetColorU32": "Unsupported, use `ImGui.GetStyleColor`"
};
// i know
let content = `# About\nThis is an automatically generated file that keeps track of wrapper coverage of the ImGui API. This may not be 100% accurate as it is calculated programatically, but can serve as a good general idea of progress.\n\n# Coverage\n`, count = 0;
func.forEach(e => {
if (e.Name.endsWith("V") && !e.Name.endsWith("HSV")) {
notes[e.Name] = "Unsupported, use `string` function in GameMaker for string formatting";
}
const wrapper = wrappers.find(w => w.Calls === e.Name)
if (wrapper) {
wrapper.Arguments.forEach(a => {
if (a.Type.endsWith("ImGuiReturnMask")) {
notes[e.Name] = "See [ImGuiReturnMask Usage](https://github.com/nommiin/ImGui_GM/wiki/ImGuiReturnMask-Usage) for more info the `mask` argument"
}
})
count++;
}
});
let unsupported = 0;
func.forEach(e => {
const note = notes[e.Name];
if (note) {
// lol
if (note.toLowerCase().includes("unsupported")) unsupported++;
}
});
content += `${count} out of ${func.length - unsupported} API functions wrapped (**${Math.round(100 * (count / (func.length - unsupported)))}% complete**)\n\n`;
content += "| Function | Wrapped | Link | Notes |\n";
content += "| -------- | ------- | ---- | ----- |\n";
func.forEach(e => {
const wrapper = wrappers.find(w => w.Calls === e.Name);
if (wrapper) wrapper.Found = true;
content += `| ImGui::${e.Name} | ${wrapper ? "✅" : "❌"} | ${wrapper ? `[${wrapper.File}](https://github.com/nommiin/ImGui_GM/blob/main/dll/${wrapper.File}#L${wrapper.Line})` : "N/A"} | ${notes[e.Name] ?? "N/A"} |\n`;
});
content += `\n# Non-Standard\nBelow is a table of non-standard functions made specifically for ImGui_GM\n\n`;
content += "| Function | Link |\n";
content += "| -------- | ---- |\n";
wrappers.forEach(e => {
if (!e?.Found && e.Calls !== "_") {
content += `| ImGui.${e.Calls}(${e.Arguments.map(e => e.Name).join(", ")}) | [${e.File}](https://github.com/nommiin/ImGui_GM/blob/main/dll/${e.File}#L${e.Line}) |\n`;
}
});
if (file.update(content)) file.commit();
}
static writeSnakeCase(wrappers, enums, file) {
let content = `/**\n* This script includes snake_case function defintions for ImGui_GM, as an alternative to the namespaced convention\n* To use, just drop this script into your project with ImGui_GM\n* Generated at ${new Date().toLocaleString()}\n*/\n\n`;
["Initialize", "Update", "Render"].forEach(e => {
const name = "imgui_" + e[0].toLowerCase() + e.slice(1);
content += `/// @function ${name}\nfunction ${name}() {\n return ImGui.__${e}();\n}\n\n`;
});
wrappers.forEach(e => {
content += e.to_jsdoc(enums, 0, Configuration.WRITE_SNAKE) + "\n" + e.to_gml(0, Configuration.WRITE_SNAKE) + "\n";
});
if (file.update(content)) file.commit();
}
static writeDocumentation(wrappers, enums, file) {
let content = `// shrug`;
if (file.update(content)) file.commit();
}
}
module.exports = Program;
if (!global["__program_main"]) if (!global["__program_warn"]) {global["__program_warn"]=1;console.error("Please execute the program by running main.js");}