Skip to content

Commit fea1eff

Browse files
NoahStolkNoahStolk
authored
Fix backwards incompatibility with .NET standard 2.0 by re-adding overloads with string parameters (#439)
* Add sample to test current issues * Update code generator to include string overloads at all times * Remove ReadOnlySpan<char> from ImGui.Manual.cs * Create ImGui.Manual.ReadOnlySpan.cs * Add AsSpan to demonstrate
1 parent 379d630 commit fea1eff

16 files changed

+21143
-8038
lines changed

‎src/CodeGenerator/Program.cs

+31-16
Original file line numberDiff line numberDiff line change
@@ -656,30 +656,45 @@ private static void EmitOverload(
656656

657657
string staticPortion = selfName == null ? "static " : string.Empty;
658658

659+
// When .NET Standard 2.1 is available, we can use ReadOnlySpan<char> instead of string, so generate additional overloads for methods containing string parameters.
659660
if (invocationArgs.Count > 0 && invocationArgs.Any(a => a is { MarshalledType: "string" }))
660661
{
661662
string readOnlySpanInvocationList = string.Join(", ", invocationArgs.Select(a => $"{(a.MarshalledType == "string" ? "ReadOnlySpan<char>" : a.MarshalledType)} {a.CorrectedIdentifier}"));
662-
writer.WriteRaw($$"""
663-
#if NETSTANDARD2_1_OR_GREATER || NETCOREAPP2_1_OR_GREATER
664-
public {{staticPortion}}{{overrideRet ?? safeRet}} {{friendlyName}}({{readOnlySpanInvocationList}})
665-
#else
666-
public {{staticPortion}}{{overrideRet ?? safeRet}} {{friendlyName}}({{invocationList}})
667-
#endif
668-
{
669-
""");
670-
writer.IndentManually();
671-
}
672-
else
673-
{
674-
writer.PushBlock($"public {staticPortion}{overrideRet ?? safeRet} {friendlyName}({invocationList})");
663+
664+
writer.WriteRaw("#if NETSTANDARD2_1_OR_GREATER || NETCOREAPP2_1_OR_GREATER");
665+
WriteMethod(writer, overload, selfName, classPrefix, staticPortion, overrideRet, safeRet, friendlyName, readOnlySpanInvocationList, preCallLines, marshalledParameters, selfIndex, pOutIndex, nativeRet, postCallLines, isWrappedType);
666+
writer.WriteRaw("#endif");
675667
}
676-
668+
669+
WriteMethod(writer, overload, selfName, classPrefix, staticPortion, overrideRet, safeRet, friendlyName, invocationList, preCallLines, marshalledParameters, selfIndex, pOutIndex, nativeRet, postCallLines, isWrappedType);
670+
}
671+
672+
private static void WriteMethod(
673+
CSharpCodeWriter writer,
674+
OverloadDefinition overload,
675+
string selfName,
676+
string classPrefix,
677+
string staticPortion,
678+
string overrideRet,
679+
string safeRet,
680+
string friendlyName,
681+
string invocationList,
682+
List<string> preCallLines,
683+
MarshalledParameter[] marshalledParameters,
684+
int selfIndex,
685+
int pOutIndex,
686+
string nativeRet,
687+
List<string> postCallLines,
688+
bool isWrappedType)
689+
{
690+
writer.PushBlock($"public {staticPortion}{overrideRet ?? safeRet} {friendlyName}({invocationList})");
691+
677692
foreach (string line in preCallLines)
678693
{
679694
writer.WriteLine(line);
680695
}
681696

682-
List<string> nativeInvocationArgs = new List<string>();
697+
List<string> nativeInvocationArgs = new();
683698

684699
for (int i = 0; i < marshalledParameters.Length; i++)
685700
{
@@ -751,7 +766,7 @@ private static void EmitOverload(
751766

752767
if (overrideRet != null)
753768
writer.WriteLine("return __retval;");
754-
769+
755770
for (int i = 0; i < marshalledParameters.Length; i++)
756771
{
757772
MarshalledParameter mp = marshalledParameters[i];

‎src/ImGui.NET.SampleProgram/ImGui.NET.SampleProgram.csproj

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
<PackageReference Include="Veldrid" Version="4.8.0" />
1212
<PackageReference Include="Veldrid.StartupUtilities" Version="4.8.0" />
1313
<ProjectReference Include="..\ImPlot.NET\ImPlot.NET.csproj" />
14+
<ProjectReference Include="..\TestDotNetStandardLib\TestDotNetStandardLib.csproj" />
1415
</ItemGroup>
1516

1617
<ItemGroup>

‎src/ImGui.NET.SampleProgram/Program.cs

+18-2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
using System.Linq;
44
using System.Numerics;
55
using ImPlotNET;
6+
using System.Runtime.CompilerServices;
7+
using TestDotNetStandardLib;
68
using Veldrid;
79
using Veldrid.Sdl2;
810
using Veldrid.StartupUtilities;
@@ -167,9 +169,9 @@ private static unsafe void SubmitUI()
167169
if ((s_tab_bar_flags & (uint)ImGuiTabBarFlags.FittingPolicyMask) == 0)
168170
s_tab_bar_flags |= (uint)ImGuiTabBarFlags.FittingPolicyDefault;
169171
if (ImGui.CheckboxFlags("ImGuiTabBarFlags_FittingPolicyResizeDown", ref s_tab_bar_flags, (uint)ImGuiTabBarFlags.FittingPolicyResizeDown))
170-
s_tab_bar_flags &= ~((uint)ImGuiTabBarFlags.FittingPolicyMask ^ (uint)ImGuiTabBarFlags.FittingPolicyResizeDown);
172+
s_tab_bar_flags &= ~((uint)ImGuiTabBarFlags.FittingPolicyMask ^ (uint)ImGuiTabBarFlags.FittingPolicyResizeDown);
171173
if (ImGui.CheckboxFlags("ImGuiTabBarFlags_FittingPolicyScroll", ref s_tab_bar_flags, (uint)ImGuiTabBarFlags.FittingPolicyScroll))
172-
s_tab_bar_flags &= ~((uint)ImGuiTabBarFlags.FittingPolicyMask ^ (uint)ImGuiTabBarFlags.FittingPolicyScroll);
174+
s_tab_bar_flags &= ~((uint)ImGuiTabBarFlags.FittingPolicyMask ^ (uint)ImGuiTabBarFlags.FittingPolicyScroll);
173175

174176
// Tab Bar
175177
string[] names = { "Artichoke", "Beetroot", "Celery", "Daikon" };
@@ -207,6 +209,20 @@ private static unsafe void SubmitUI()
207209
ImGui.Text("Memory editor currently supported.");
208210
// _memoryEditor.Draw("Memory Editor", _memoryEditorData, _memoryEditorData.Length);
209211
}
212+
213+
// ReadOnlySpan<char> and .NET Standard 2.0 tests
214+
TestStringParameterOnDotNetStandard.Text(); // String overloads should always be available.
215+
216+
// On .NET Standard 2.1 or greater, you can use ReadOnlySpan<char> instead of string to prevent allocations.
217+
long allocBytesStringStart = GC.GetAllocatedBytesForCurrentThread();
218+
ImGui.Text($"Hello, world {Random.Shared.Next(100)}!");
219+
long allocBytesStringEnd = GC.GetAllocatedBytesForCurrentThread() - allocBytesStringStart;
220+
Console.WriteLine("GC (string): " + allocBytesStringEnd);
221+
222+
long allocBytesSpanStart = GC.GetAllocatedBytesForCurrentThread();
223+
ImGui.Text($"Hello, world {Random.Shared.Next(100)}!".AsSpan()); // Note that this call will STILL allocate memory due to string interpolation, but you can prevent that from happening by using an InterpolatedStringHandler.
224+
long allocBytesSpanEnd = GC.GetAllocatedBytesForCurrentThread() - allocBytesSpanStart;
225+
Console.WriteLine("GC (span): " + allocBytesSpanEnd);
210226
}
211227
}
212228
}

‎src/ImGui.NET.sln

+14
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ImNodes.NET", "ImNodes.NET\
1616
EndProject
1717
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ImGuizmo.NET", "ImGuizmo.NET\ImGuizmo.NET.csproj", "{760568AB-DCC9-443E-ADFA-2B06B2E2B421}"
1818
EndProject
19+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestDotNetStandardLib", "TestDotNetStandardLib\TestDotNetStandardLib.csproj", "{867D8763-15A2-40E4-AAFD-43B77AC52154}"
20+
EndProject
1921
Global
2022
GlobalSection(SolutionConfigurationPlatforms) = preSolution
2123
Debug|Any CPU = Debug|Any CPU
@@ -110,6 +112,18 @@ Global
110112
{760568AB-DCC9-443E-ADFA-2B06B2E2B421}.Release|x64.Build.0 = Release|Any CPU
111113
{760568AB-DCC9-443E-ADFA-2B06B2E2B421}.Release|x86.ActiveCfg = Release|Any CPU
112114
{760568AB-DCC9-443E-ADFA-2B06B2E2B421}.Release|x86.Build.0 = Release|Any CPU
115+
{867D8763-15A2-40E4-AAFD-43B77AC52154}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
116+
{867D8763-15A2-40E4-AAFD-43B77AC52154}.Debug|Any CPU.Build.0 = Debug|Any CPU
117+
{867D8763-15A2-40E4-AAFD-43B77AC52154}.Debug|x64.ActiveCfg = Debug|Any CPU
118+
{867D8763-15A2-40E4-AAFD-43B77AC52154}.Debug|x64.Build.0 = Debug|Any CPU
119+
{867D8763-15A2-40E4-AAFD-43B77AC52154}.Debug|x86.ActiveCfg = Debug|Any CPU
120+
{867D8763-15A2-40E4-AAFD-43B77AC52154}.Debug|x86.Build.0 = Debug|Any CPU
121+
{867D8763-15A2-40E4-AAFD-43B77AC52154}.Release|Any CPU.ActiveCfg = Release|Any CPU
122+
{867D8763-15A2-40E4-AAFD-43B77AC52154}.Release|Any CPU.Build.0 = Release|Any CPU
123+
{867D8763-15A2-40E4-AAFD-43B77AC52154}.Release|x64.ActiveCfg = Release|Any CPU
124+
{867D8763-15A2-40E4-AAFD-43B77AC52154}.Release|x64.Build.0 = Release|Any CPU
125+
{867D8763-15A2-40E4-AAFD-43B77AC52154}.Release|x86.ActiveCfg = Release|Any CPU
126+
{867D8763-15A2-40E4-AAFD-43B77AC52154}.Release|x86.Build.0 = Release|Any CPU
113127
EndGlobalSection
114128
GlobalSection(SolutionProperties) = preSolution
115129
HideSolutionNode = FALSE

0 commit comments

Comments
 (0)