GodotSharpStringCacher.MSBuild 1.0.7-alpha

Automatically cache Godot Mono/C# StringName and NodePath without changing your code

What ?

Godot uses its own string types for a lot of features in the engine: StringName and NodePath. They each have their advantage which make a speed difference for the engine.
However in C# they are often implicited declared and can have performance impact.
For example, when writing something like Input.IsActionJustPressed("my_input"), the constructor to StringName is called on "my_input" without you noticing. This results in the GC allocation of an object that will live for only one method. Worse, the implementation of these constructors does potentially expensive calculations (for StringName, a hash is computed, which is then searched in a linked list. For NodePath, the string is deconstructed in its individual nodes, and a list is allocated to cache the results)

There are different proposals to circumvent this issue, here is mine.

Integrating

Include the package in your csproj file with

<PackageReference Include="GodotSharpStringCacher.MSBuild" PrivateAssets="all" />

That's it ! The main assembly is now automatically patched.
If you want it to affect other packages, use

<ItemGroup>
    <PackageReference Include="Foo.Bar" CacheStrings="true" />
    <Reference Include=".../Foo.Bar.dll" CacheStrings="true" />
    <ProjectReference Include=".../Foo.Bar.csproj" CacheStrings="true" />

    
    <CacheStrings Include="Foo.Bar" />
</ItemGroup>

Quick Testing

If you want to test without integrating it, compile GodotSharpStringCacher.Console. The syntax is:

GodotSharpStringCacher.Console <in_file> <out_file> [--long-names] [--no-warn-non-constant-implicit-operator]

You can browse the resulting assembly and see the results for yourself.

Detailed Configuration

Warning On Implicit Operator With Non Constant

You are encouraged to use the new syntax when creating a non-constant StringName/NodePath at run-time. For example

// don't
StringName myStr = networkPacket.StringVariable;
// do
StringName myStr = new StringName(networkPacket.StringVariable);

This conveys your intentions better, and you will be warned by default if you don't do this.

To disable this warning (which is not recommended), either use WarnOnNonConstantImplicitOperator=true on a specific assembly or add a property like this for global effect:

<GDStringWarnOnNonConstantImplicitOperator>false</GDStringWarnOnNonConstantImplicitOperator>

Long Names

By default, the variables created from your constant strings in the assembly have a short numeric name. However, in niche cases, like statically reversing your own project, you may want these variables to have names that resemble their original value. For example, "my_input" would create a variable called _my_input. If you want that in a specific assembly, you can add LongNames=true. If you want that globally, add

<GDStringUseLongNames>true</GDStringUseLongNames>

How It Works

It executes after your project compiles and directly edits the resulting assembly. It uses Mono.Cecil, a library for assembly exploring and editing.
It looks for calls to these implicit conversion operators, then if the string is a constant, adds its value as a StringName/NodePath to a static class, then replaces the call with the load to this value.

Bugs and contributing

I only tested this project on my own Godot projects, and it is still new. Therefore, there may be bugs. If you find a bug please please PLEASE fill an issue. Thanks :>

Feel free to contribute too !