Compiler struct support #1518
Compiler struct support #1518
Conversation
just need to add support for passing arguments into structs and stuff
This commit adds variable leaking for structs (basically, it lets you use other variables in structs). It also fixes compiled structs crashing the game.
- Remove the fit-into-my-window-size linebreak in one of the comments - Remove braces from one of the if statements I modified
- Code formatting - Use `is not null` - Add TODO
|
Also can you add fixes #1399 to the inital PR description please? |
That issue seems more like it's about |
| Data.Scripts.Remove(scriptObj); | ||
| UndertaleCode codeObj = Data.Code.ByName(scriptName); | ||
| if (codeObj is not null) | ||
| { | ||
| Data.Code.Remove(codeObj); | ||
| OriginalCode.ChildEntries.Remove(codeObj); | ||
| } | ||
| UndertaleFunction functionObj = Data.Functions.ByName(scriptName); | ||
| if (functionObj is not null) | ||
| Data.Functions.Remove(functionObj); |
There was a problem hiding this comment.
Are these instances of Data.X.Remove() safe?
There was a problem hiding this comment.
Should be if you're just normally adding and removing struct definitions, as each struct definition gets its own function, the compiler currently won't let you create ___struct___ functions and I'm fairly sure code, script and function references are all passed by reference instead of ID. But I'm not sure.
(If we don't remove unused struct functions, then adding then removing a struct definition would cause an Unable to find function error when launching the game.)
| foreach (UndertaleCode child in context.OriginalCode.ChildEntries) | ||
| { | ||
| if (child.Name.Content.StartsWith("gml_Script____struct___")) | ||
| usableStructNames.Enqueue(child.Name.Content["gml_Script_".Length..]); |
There was a problem hiding this comment.
Is this entirely exhaustive? Depending on case, structs may not start with this, i.e. if embedded inside an anonymous function (anon part comes first in those cases). Although, I'm unsure if anonymous functions are supported by this compiler right now anyway.
There was a problem hiding this comment.
Depending on case, structs may not start with this, i.e. if embedded inside an anonymous function (anon part comes first in those cases).
At least from my tests in GMS2022.9, that does not seem to be the case (although it might be different in earlier or later versions).
Although, I'm unsure if anonymous functions are supported by this compiler right now anyway.
Sort of, but they don't work that well.
There was a problem hiding this comment.
AFAIK there's an open issue somewhere about anonymous functions, to my understanding their status essentially boils down to "unsupported/not working"
There was a problem hiding this comment.
OK so I further investigated this, and I found out that the code entries I saw were just anonymous functions declared inside of structs, which aren't themselves structs, so this check is fine!
…into utmtce-structs
This is a workaround for deeper-down issues with local variables which UTMTCE fixes, but is probably better off being left for another PR
|
Download the artifacts for this pull request here: GUI:
CLI: |
|
I temporarily ported these changes over to my new decompiler fork (almost verbatim), and it seems to work great there! |
Resolves #1084
Description
Adds support for GMS2.3+ structs in the compiler, cherrypicked from UndertaleModTool Community Edition with some additional minor changes.
UndertaleModTool_ZKdJpFd2rT.mp4
Also fixes a bug where an empty struct definition would cause all assignments after to also be struct-styled, causing syntax errors when recompiling.
Caveats
___struct___can no longer be used at the start of a function definition name, as parts of the compiler and decompiler assume that the___struct___prefix means a struct.Notes
I've only tested this on one GMS2022.9 game (Pizza Tower), but it seems to work there. You may want to squash this PR if you don't like some of my ridiculous commit names. (Also, I'm not super experienced with C# or this project's code style so there probably are some things that need to be looked at.)