Expose ImGui internals (experimental) using 1.85 WIP

generate-all.bat

@@ -0,0 +1,7 @@
+@setlocal
+@echo off
+
+dotnet run -p src\CodeGenerator\CodeGenerator.csproj src\ImGui.NET\Generated cimgui true
+dotnet run -p src\CodeGenerator\CodeGenerator.csproj src\ImPlot.NET\Generated cimplot false
+dotnet run -p src\CodeGenerator\CodeGenerator.csproj src\ImNodes.NET\Generated cimnodes true
+dotnet run -p src\CodeGenerator\CodeGenerator.csproj src\ImGuizmo.NET\Generated cimguizmo true

src/CodeGenerator/CodeGenerator.csproj

@@ -2,25 +2,28 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>netcoreapp3.1</TargetFramework>
+    <TargetFramework>net5.0</TargetFramework>
+
+    <!-- Set environment variable CopyToOutputDirectory to "Always"-->
+    <CopyToOutputDirectory Condition="'$(CopyToOutputDirectory)'!='Always'">PreserveNewest</CopyToOutputDirectory>
   </PropertyGroup>
 
   <ItemGroup>
-    <Content Include="definitions\cimgui\structs_and_enums.json" CopyToOutputDirectory="PreserveNewest" />
-    <Content Include="definitions\cimgui\definitions.json" CopyToOutputDirectory="PreserveNewest" />
-    <Content Include="definitions\cimgui\variants.json" CopyToOutputDirectory="PreserveNewest" />
+    <Content Include="definitions\cimgui\structs_and_enums.json" CopyToOutputDirectory="$(CopyToOutputDirectory)" />
+    <Content Include="definitions\cimgui\definitions.json" CopyToOutputDirectory="$(CopyToOutputDirectory)" />
+    <Content Include="definitions\cimgui\variants.json" CopyToOutputDirectory="$(CopyToOutputDirectory)" />
 
-    <Content Include="definitions\cimplot\structs_and_enums.json" CopyToOutputDirectory="PreserveNewest" />
-    <Content Include="definitions\cimplot\definitions.json" CopyToOutputDirectory="PreserveNewest" />
-    <Content Include="definitions\cimplot\variants.json" CopyToOutputDirectory="PreserveNewest" />
+    <Content Include="definitions\cimplot\structs_and_enums.json" CopyToOutputDirectory="$(CopyToOutputDirectory)" />
+    <Content Include="definitions\cimplot\definitions.json" CopyToOutputDirectory="$(CopyToOutputDirectory)" />
+    <Content Include="definitions\cimplot\variants.json" CopyToOutputDirectory="$(CopyToOutputDirectory)" />
 
-    <Content Include="definitions\cimnodes\structs_and_enums.json" CopyToOutputDirectory="PreserveNewest" />
-    <Content Include="definitions\cimnodes\definitions.json" CopyToOutputDirectory="PreserveNewest" />
-    <Content Include="definitions\cimnodes\variants.json" CopyToOutputDirectory="PreserveNewest" />
+    <Content Include="definitions\cimnodes\structs_and_enums.json" CopyToOutputDirectory="$(CopyToOutputDirectory)" />
+    <Content Include="definitions\cimnodes\definitions.json" CopyToOutputDirectory="$(CopyToOutputDirectory)" />
+    <Content Include="definitions\cimnodes\variants.json" CopyToOutputDirectory="$(CopyToOutputDirectory)" />
 
-    <Content Include="definitions\cimguizmo\structs_and_enums.json" CopyToOutputDirectory="PreserveNewest" />
-    <Content Include="definitions\cimguizmo\definitions.json" CopyToOutputDirectory="PreserveNewest" />
-    <Content Include="definitions\cimguizmo\variants.json" CopyToOutputDirectory="PreserveNewest" />
+    <Content Include="definitions\cimguizmo\structs_and_enums.json" CopyToOutputDirectory="$(CopyToOutputDirectory)" />
+    <Content Include="definitions\cimguizmo\definitions.json" CopyToOutputDirectory="$(CopyToOutputDirectory)" />
+    <Content Include="definitions\cimguizmo\variants.json" CopyToOutputDirectory="$(CopyToOutputDirectory)" />
   </ItemGroup>
 
   <ItemGroup>

src/CodeGenerator/ImguiDefinitions.cs

@@ -15,12 +15,20 @@ class ImguiDefinitions
         public FunctionDefinition[] Functions;
         public Dictionary<string, MethodVariant> Variants;
 
+        private bool _enableInternals;
+
+        public ImguiDefinitions(bool enableInternals = false)
+		{
+            _enableInternals = enableInternals;
+        }
+
         static int GetInt(JToken token, string key)
         {
             var v = token[key];
             if (v == null) return 0;
             return v.ToObject<int>();
         }
+
         public void LoadFrom(string directory)
         {
 
@@ -65,10 +73,12 @@ public void LoadFrom(string directory)
             {
                 JProperty jp = (JProperty)jt;
                 string name = jp.Name;
-                if (typeLocations?[jp.Name]?.Value<string>().Contains("internal") ?? false) {
-                    return null;
-                }
-                EnumMember[] elements = jp.Values().Select(v =>
+                if (!_enableInternals && (typeLocations?[jp.Name]?.Value<string>().Contains("internal") ?? false))
+                {
+					return null;
+				}
+
+				EnumMember[] elements = jp.Values().Select(v =>
                 {
                     return new EnumMember(v["name"].ToString(), v["calc_value"].ToString());
                 }).ToArray();
@@ -79,7 +89,8 @@ public void LoadFrom(string directory)
             {
                 JProperty jp = (JProperty)jt;
                 string name = jp.Name;
-                if (typeLocations?[jp.Name]?.Value<string>().Contains("internal") ?? false) {
+                if (!_enableInternals && (typeLocations?[jp.Name]?.Value<string>().Contains("internal") ?? false)) 
+                {
                     return null;
                 }
                 TypeReference[] fields = jp.Values().Select(v =>
@@ -120,7 +131,10 @@ public void LoadFrom(string directory)
                         }
                     }
                     if (friendlyName == null) { return null; }
-                    if (val["location"]?.ToString().Contains("internal") ?? false) return null;
+                    if (!_enableInternals && (val["location"]?.ToString().Contains("internal") ?? false))
+                    {
+                        return null;
+                    }
 
                     string exportedName = ov_cimguiname;
                     if (exportedName == null)
@@ -161,6 +175,7 @@ public void LoadFrom(string directory)
                     Dictionary<string, string> defaultValues = new Dictionary<string, string>();
                     foreach (JToken dv in val["defaults"])
                     {
+
                         JProperty dvProp = (JProperty)dv;
                         defaultValues.Add(dvProp.Name, dvProp.Value.ToString());
                     }
@@ -359,6 +374,29 @@ public TypeReference(string name, string type, int asize, string templateType, E
                 }
             }
 
+            if (Type.StartsWith("ImSpan_"))
+            {
+                if (Type.EndsWith("*"))
+                {
+                    Type = "ImSpan*";
+                }
+                else
+                {
+                    Type = "ImSpan";
+                }
+            }
+
+            if (Type.StartsWith("ImPool_"))
+            {
+                if (Type.EndsWith("*"))
+                {
+                    Type = "ImPool*";
+                }
+                else
+                {
+                    Type = "ImPool";
+                }
+            }
             TemplateType = templateType;
             ArraySize = asize;
             int startBracket = name.IndexOf('[');

src/CodeGenerator/PostFixes.cs

@@ -0,0 +1,189 @@
+using System;
+using System.IO;
+using System.Text;
+
+namespace CodeGenerator
+{
+	public class PostFix
+	{
+		/// <summary>
+		/// The path of the file that the PostFix targets.
+		/// </summary>
+		private string _filePath;
+
+		/// <summary>
+		/// The content of the file that the PostFix targets.
+		/// </summary>
+		private string _fileContent;
+
+		/// <summary>
+		/// Replaces or removes specific strings of the generated code.
+		/// </summary>
+		/// <param name="outputPath">The folder of the file that the PostFix targets.</param>
+		/// <param name="fileName">The name of the file that the PostFix targets.</param>
+		public PostFix(string outputPath, string fileName)
+		{
+			if (string.IsNullOrEmpty(outputPath))
+			{
+				throw new InvalidOperationException("The static string `Postfix.OutputPath` must be set before creating a postfix.");
+			}
+
+			if (string.IsNullOrEmpty(fileName))
+			{
+				throw new ArgumentException("String must have non-zero length.", nameof(fileName));
+			}
+
+			_filePath = Path.Combine(outputPath, fileName);
+			_fileContent = File.ReadAllText(_filePath);
+
+		}
+
+		/// <summary>
+		/// Remove lines that include a specified string.
+		/// </summary>
+		/// <param name="searchValue">The string to search in the source string.</param>
+		/// <param name="skipLines">The number of lines to skip. Default: 1</param>
+		/// <returns>The string with all lines removed.</returns>
+		public PostFix Remove(string searchTerm, int skipLines = 1)
+		{
+			string line;
+			int skipLinesRemaining = 0;
+
+			StringReader sr = new StringReader(_fileContent);
+			StringBuilder sb = new StringBuilder();
+
+			while ((line = sr.ReadLine()) != null)
+			{
+				// Set number of lines to skip (if any)
+				if (line.Contains(searchTerm))
+				{
+					skipLinesRemaining = skipLines;
+				}
+
+				// Continue to reading the next line
+				if (skipLinesRemaining > 0)
+				{
+					skipLinesRemaining--;
+					continue;
+				}
+
+				// No longer skipping, adding all remaining lines
+				sb.AppendLine(line);
+
+			}
+
+			// Update content
+			_fileContent = sb.ToString();
+
+			return this;
+
+		}
+
+		/// <summary>
+		/// Replace a specified string with another specified string.
+		/// </summary>
+		/// <param name="oldValue">The string to be replaced.</param>
+		/// <param name="newValue">The string to replace all occurrences of oldValue.</param>
+		/// <returns>The PostFix instance.</returns>
+		public PostFix Replace(string oldValue, string newValue)
+		{
+			_fileContent = _fileContent.Replace(oldValue, newValue);
+			return this;
+
+		}
+
+		/// <summary>
+		/// Write the changes back to the source file.
+		/// </summary>
+		/// <returns>The PostFix instance.</returns>
+		public PostFix Apply()
+		{
+			File.WriteAllText(_filePath, _fileContent);
+			return this;
+
+		}
+
+	}
+
+	/// <summary>
+	/// A PostFix replaces or removes specific strings of the generated code.
+	/// 
+	/// They can be used to work around small or difficult to fix issues that 
+	/// would otherwise prevent huge upgrades, like exposing the internal parts 
+	/// of a library.
+	/// 
+	///	Before adding a new PostFix you should try to find another solution, as
+	///	they are basically hackish monkey patches that can easily get out of hand.
+	/// 
+	/// </summary>
+	public class PostFixes
+	{
+		/// <summary>
+		/// Define your PostFix instances in this function. 
+		/// Automatically invoked after all code has been generated.
+		/// </summary>
+		/// <param name="outputPath">The folder of the file that the PostFix targets.</param>
+		/// <param name="libraryName">The library name that is being generated.</param>
+		public static void Apply(string outputPath, string libraryName)
+		{
+			if(libraryName == "cimgui")
+			{
+				// Invalid default value for local variables, method
+				// `CodeGenerator.Program.CorrectDefaultValue` seems
+				// like a good place to fix this eventually?
+				new PostFix(outputPath, "ImGui.gen.cs")
+					.Replace("IntPtr callback = null", "IntPtr callback = IntPtr.Zero")                 // In InputTextEx()
+					.Replace("IntPtr custom_callback = null", "IntPtr custom_callback = IntPtr.Zero")   // In SetNextWindowSizeConstraints()
+					.Apply();
+
+				new PostFix(outputPath, "ImGuiContext.gen.cs")
+					.Remove("ImChunkStream")        // Error CS0208
+					.Remove("ImGuiItemFlagsPtr")    // Struct is not being generated at all
+					.Remove("NativePtr->Tables")    // Error CS1503 Can not convert from ImPool to ImSpan
+					.Remove("NativePtr->TabBars")   // Error CS1503 Can not convert from ImPool to ImSpan
+					.Apply();
+
+				new PostFix(outputPath, "ImGuiViewportP.gen.cs")
+					.Replace("RangeAccessor<ImDrawList*>", "RangeAccessor<ImDrawList>")   // Error CS0306 Pointer can't be used as generic argument?
+					.Apply();
+
+				new PostFix(outputPath, "ImGuiInputTextState.gen.cs")
+					.Remove("ImGuiInputTextCallback UserCallback")  // Different errors. The ImGuiInputTextCallback seems to be handcoded
+					.Apply();
+
+				new PostFix(outputPath, "ImGuiDockNode.gen.cs")
+					.Replace("RangeAccessor<ImGuiDockNode*>", "RangeAccessor<ImGuiDockNode>")   // Error CS0306 Pointer can't be used as generic argument?
+					.Apply();
+
+				// These enum values are originally inside the `ImGuiDockNodeFlagsPrivate` enum, but the numbers here have been changed.
+				// This fix comes from the initial fork and I have not yet spoken to the author, so my best guess on how this originated:
+				// The values have been shifted up to continue where the non-private enum ends to close the gap between both enums.
+				//
+				// Using `ImGuiDockNodeFlagsPrivate.ImGuiDockNodeFlags_DockSpace` instead of `ImGuiDockNodeFlags.DockSpace` with
+				// DockBuilderAddNode() throws an AccessViolationException. The private enum hasn't been touched in the past ~2 years,
+				// so version mismatches or outdated generated json files should be off the table. Link to blame showing no changes:
+				// https://github.com/ocornut/imgui/blame/c58fb464113435fdb7d122fde87cef4920b3d2c6/imgui_internal.h#L1306
+				//
+				// This "required" disparity is kinda weird and I can't really natively test dear imgui to rule out issues in the bindings.
+				// However, we're basically using the "internal internal" parts here which might just not be in the most stable state to begin with?
+				new PostFix(outputPath, "ImGuiDockNodeFlags.gen.cs")
+					.Replace("AutoHideTabBar = 64,", @"AutoHideTabBar = 64,
+		DockSpace = 128,
+		CentralNode = 256,
+		NoTabBar = 512,
+		HiddenTabBar = 1024,
+		NoWindowMenuButton = 2048,
+		NoCloseButton = 4096,
+		NoDocking = 8192,
+		NoDockingSplitMe = 16384,
+		NoDockingSplitOther = 32768,
+		NoDockingOverMe = 65536,
+		NoDockingOverOther = 131072,
+		NoResizeX = 262144,
+		NoResizeY = 524288")
+					.Apply();
+
+			}
+		}
+	}
+}