[3.0] Overhaul SilkTouch configuration and DI

.config/dotnet-tools.json

@@ -3,10 +3,11 @@
   "isRoot": true,
   "tools": {
     "csharpier": {
-      "version": "0.29.2",
+      "version": "1.3.0",
       "commands": [
-        "dotnet-csharpier"
-      ]
+        "csharpier"
+      ],
+      "rollForward": false
     }
   }
 }

Directory.Packages.props

@@ -21,6 +21,8 @@
     <!-- Analyzers -->
     <PackageVersion Include="Microsoft.CodeAnalysis.Analyzers" Version="5.3.0" />
     <!-- SilkTouch -->
+    <PackageVersion Include="Autofac" Version="9.3.4" />
+    <PackageVersion Include="Autofac.Extensions.DependencyInjection" Version="11.0.2" />
     <PackageVersion Include="ClangSharp.PInvokeGenerator" Version="21.1.8.4" />
     <PackageVersion Include="CSharpier.Core" Version="1.3.0" />
     <PackageVersion Include="Humanizer.Core" Version="2.14.1" />

Silk.NET.slnx

@@ -1,99 +1,99 @@
 <Solution>
-  <Folder Name="/docs/">
-    <File Path="docs/CHANGELOG.md" />
-    <File Path="docs/CODEOWNERS" />
-    <File Path="docs/CODE_OF_CONDUCT.md" />
-    <File Path="docs/CONTRIBUTING.md" />
-    <File Path="docs/README.md" />
-  </Folder>
-  <Folder Name="/eng/">
-    <Project Path="eng/build/Silk.NET.NUKE.csproj" />
-  </Folder>
-  <Folder Name="/eng/benchmarks/">
-    <Project Path="eng/benchmarks/Silk.NET.Maths.Benchmarks/Silk.NET.Maths.Benchmarks.csproj" />
-  </Folder>
-  <Folder Name="/examples/" />
-  <Folder Name="/examples/CSharp/" />
-  <Folder Name="/examples/CSharp/OpenAL/">
-    <Project Path="examples/CSharp/OpenAL/Tutorial001.HelloSound/OpenAL.Tutorial001.HelloSound.csproj" />
-  </Folder>
+    <Folder Name="/docs/">
+        <File Path="docs/CHANGELOG.md" />
+        <File Path="docs/CODEOWNERS" />
+        <File Path="docs/CODE_OF_CONDUCT.md" />
+        <File Path="docs/CONTRIBUTING.md" />
+        <File Path="docs/README.md" />
+    </Folder>
+    <Folder Name="/eng/">
+        <Project Path="eng/build/Silk.NET.NUKE.csproj" />
+    </Folder>
+    <Folder Name="/eng/benchmarks/">
+        <Project Path="eng/benchmarks/Silk.NET.Maths.Benchmarks/Silk.NET.Maths.Benchmarks.csproj" />
+    </Folder>
+    <Folder Name="/examples/" />
+    <Folder Name="/examples/CSharp/" />
+    <Folder Name="/examples/CSharp/OpenAL/">
+        <Project Path="examples/CSharp/OpenAL/Tutorial001.HelloSound/OpenAL.Tutorial001.HelloSound.csproj" />
+    </Folder>
     <Folder Name="/examples/CSharp/OpenCL/">
         <Project Path="examples/CSharp/OpenCL/Tutorial001.SimpleKernel/OpenCL.Tutorial001.SimpleKernel.csproj" />
     </Folder>
-  <Folder Name="/examples/CSharp/SDL/">
-    <Project Path="examples/CSharp/SDL/Tutorial001.HelloWindow/SDL.Tutorial001.HelloWindow.csproj" />
-  </Folder>
-  <Folder Name="/scripts/">
-    <File Path="scripts/azure-pipelines.yml" />
-    <File Path="scripts/build.ps1" />
-    <File Path="scripts/build.sh" />
-    <File Path="scripts/cibuild.cmd" />
-    <File Path="scripts/cibuild.sh" />
-  </Folder>
-  <Folder Name="/Solution Items/">
-    <File Path=".editorconfig" />
-    <File Path=".gitattributes" />
-    <File Path=".gitignore" />
-    <File Path="Directory.Build.props" />
-    <File Path="Directory.Build.targets" />
-    <File Path="Directory.Packages.props" />
-    <File Path="generator.json" />
-    <File Path="LICENSE.md" />
-    <File Path="Silk.NET.sln.DotSettings" />
-  </Folder>
-  <Folder Name="/sources/">
-    <File Path="sources/Directory.Build.props" />
-    <File Path="sources/Directory.Build.targets" />
-    <Project Path="sources/Playground/Playground.csproj" />
-  </Folder>
-  <Folder Name="/sources/Core/">
-    <Project Path="sources/Core/Core/Silk.NET.Core.csproj" />
-    <Project Path="sources/Core/Silk.NET/Silk.NET.csproj" />
-  </Folder>
-  <Folder Name="/sources/Maths/">
-    <Project Path="sources/Maths/Maths/Silk.NET.Maths.csproj" />
-  </Folder>
-  <Folder Name="/sources/OpenAL/">
-    <Project Path="sources/OpenAL/OpenAL/Silk.NET.OpenAL.csproj" />
-    <Project Path="sources/OpenAL/Soft.Native/Silk.NET.OpenAL.Soft.Native.csproj" />
-  </Folder>
-  <Folder Name="/sources/OpenCL/">
-    <Project Path="sources/OpenCL/OpenCL/Silk.NET.OpenCL.csproj" />
-  </Folder>
-  <Folder Name="/sources/OpenGL/">
-    <Project Path="sources/OpenGL/OpenGL/Silk.NET.OpenGL.csproj" />
-  </Folder>
-  <Folder Name="/sources/OpenXR/">
-    <Project Path="sources/OpenXR/OpenXR/Silk.NET.OpenXR.csproj" />
-  </Folder>
-  <Folder Name="/sources/SDL/">
-    <Project Path="sources/SDL/Native/Silk.NET.SDL.Native.csproj" />
-    <Project Path="sources/SDL/SDL/Silk.NET.SDL.csproj" />
-  </Folder>
-  <Folder Name="/sources/SilkTouch/">
-    <Project Path="sources/SilkTouch/SilkTouch/Silk.NET.SilkTouch.csproj" />
-  </Folder>
-  <Folder Name="/sources/Vulkan/">
-    <Project Path="sources/Vulkan/Vulkan/Silk.NET.Vulkan.csproj" />
-  </Folder>
-  <Folder Name="/sources/Win32/" />
-  <Folder Name="/sources/Windowing/">
-    <Project Path="sources/Windowing/Windowing/Silk.NET.Windowing.csproj" />
-  </Folder>
-  <Folder Name="/tests/">
-    <File Path="tests/Directory.Build.props" />
-    <File Path="tests/Directory.Build.targets" />
-  </Folder>
-  <Folder Name="/tests/Core/">
-    <Project Path="tests/Core/Core/Silk.NET.Core.UnitTests.csproj" />
-  </Folder>
-  <Folder Name="/tests/Maths/">
-    <Project Path="tests/Maths/Maths/Silk.NET.Maths.Tests.csproj" />
-  </Folder>
-  <Folder Name="/tests/SDL/">
-    <Project Path="tests/SDL/SDL/Silk.NET.SDL.UnitTests.csproj" />
-  </Folder>
-  <Folder Name="/tests/SilkTouch/">
-    <Project Path="tests/SilkTouch/SilkTouch/Silk.NET.SilkTouch.UnitTests.csproj" />
-  </Folder>
+    <Folder Name="/examples/CSharp/SDL/">
+        <Project Path="examples/CSharp/SDL/Tutorial001.HelloWindow/SDL.Tutorial001.HelloWindow.csproj" />
+    </Folder>
+    <Folder Name="/scripts/">
+        <File Path="scripts/azure-pipelines.yml" />
+        <File Path="scripts/build.ps1" />
+        <File Path="scripts/build.sh" />
+        <File Path="scripts/cibuild.cmd" />
+        <File Path="scripts/cibuild.sh" />
+    </Folder>
+    <Folder Name="/Solution Items/">
+        <File Path=".editorconfig" />
+        <File Path=".gitattributes" />
+        <File Path=".gitignore" />
+        <File Path="Directory.Build.props" />
+        <File Path="Directory.Build.targets" />
+        <File Path="Directory.Packages.props" />
+        <File Path="LICENSE.md" />
+        <File Path="Silk.NET.sln.DotSettings" />
+    </Folder>
+    <Folder Name="/sources/">
+        <File Path="sources/Directory.Build.props" />
+        <File Path="sources/Directory.Build.targets" />
+        <Project Path="sources/Playground/Playground.csproj" />
+    </Folder>
+    <Folder Name="/sources/Core/">
+        <Project Path="sources/Core/Core/Silk.NET.Core.csproj" />
+        <Project Path="sources/Core/Silk.NET/Silk.NET.csproj" />
+    </Folder>
+    <Folder Name="/sources/Maths/">
+        <Project Path="sources/Maths/Maths/Silk.NET.Maths.csproj" />
+    </Folder>
+    <Folder Name="/sources/OpenAL/">
+        <Project Path="sources/OpenAL/OpenAL/Silk.NET.OpenAL.csproj" />
+        <Project Path="sources/OpenAL/Soft.Native/Silk.NET.OpenAL.Soft.Native.csproj" />
+    </Folder>
+    <Folder Name="/sources/OpenCL/">
+        <Project Path="sources/OpenCL/OpenCL/Silk.NET.OpenCL.csproj" />
+    </Folder>
+    <Folder Name="/sources/OpenGL/">
+        <Project Path="sources/OpenGL/OpenGL/Silk.NET.OpenGL.csproj" />
+    </Folder>
+    <Folder Name="/sources/OpenXR/">
+        <Project Path="sources/OpenXR/OpenXR/Silk.NET.OpenXR.csproj" />
+    </Folder>
+    <Folder Name="/sources/SDL/">
+        <Project Path="sources/SDL/Native/Silk.NET.SDL.Native.csproj" />
+        <Project Path="sources/SDL/SDL/Silk.NET.SDL.csproj" />
+    </Folder>
+    <Folder Name="/sources/SilkTouch/">
+        <Project Path="sources/SilkTouch/Jobs/Silk.NET.SilkTouch.Jobs.csproj" />
+        <Project Path="sources/SilkTouch/SilkTouch/Silk.NET.SilkTouch.csproj" />
+    </Folder>
+    <Folder Name="/sources/Vulkan/">
+        <Project Path="sources/Vulkan/Vulkan/Silk.NET.Vulkan.csproj" />
+    </Folder>
+    <Folder Name="/sources/Win32/" />
+    <Folder Name="/sources/Windowing/">
+        <Project Path="sources/Windowing/Windowing/Silk.NET.Windowing.csproj" />
+    </Folder>
+    <Folder Name="/tests/">
+        <File Path="tests/Directory.Build.props" />
+        <File Path="tests/Directory.Build.targets" />
+    </Folder>
+    <Folder Name="/tests/Core/">
+        <Project Path="tests/Core/Core/Silk.NET.Core.UnitTests.csproj" />
+    </Folder>
+    <Folder Name="/tests/Maths/">
+        <Project Path="tests/Maths/Maths/Silk.NET.Maths.Tests.csproj" />
+    </Folder>
+    <Folder Name="/tests/SDL/">
+        <Project Path="tests/SDL/SDL/Silk.NET.SDL.UnitTests.csproj" />
+    </Folder>
+    <Folder Name="/tests/SilkTouch/">
+        <Project Path="tests/SilkTouch/SilkTouch/Silk.NET.SilkTouch.UnitTests.csproj" />
+    </Folder>
 </Solution>

docs/for-contributors/Generator/generator-mods.md

@@ -27,9 +27,11 @@ ideally, no communication is done at all so that mods are kept completely standa
 
 ### Mod Configuration
 
-Mods are configured through the generator config JSON file. Silk's config file is named `generator.json` and is located
-at the root of the Silk.NET repository. This config file can be used as reference for your own config files. In
-addition, most mods have a configuration class located in their source code with additional documentation.
+Mods are configured as part of bindings generation jobs in a separate C# project. Silk's own configuration project is
+the
+[`Silk.NET.SilkTouch.Jobs`](https://github.com/dotnet/Silk.NET/blob/develop/3.0/sources/SilkTouch/Jobs/Program.cs)
+project. This project can be used as reference for your own SilkTouch configuration projects. More information about
+using the SilkTouch generator can be found in the [Using the Generator](using-the-generator.md) documentation.
 
 ## Available Mods
 
@@ -186,7 +188,7 @@ development and iteration, the generator is typically set up so that platform-sp
 
 Usage recommendations:
 
-This mod is configured differently from the rest of the mods. The JSON mod configuration follows the same pattern as the
+This mod is configured differently from the rest of the mods. The C# mod configuration follows the same pattern as the
 rest of the mods, but the bulk of the configuration comes in the form of `.rsp` files. These `.rsp` files represent the
 command line arguments passed to ClangSharpPInvokeGenerator. More information about how to use this mod and how to
 configure the generator as a whole is found in the [Using the Generator](using-the-generator.md) documentation.
@@ -373,16 +375,12 @@ Name affix categories:
 
 Example name affix configurations for `PrettifyNames`:
 
-```
-"SharedPrefix": {
-  "Remove": true
-}
+```cs
+["SharedPrefix"] = new() { Remove = true },
 ```
 
-```
-"SharedPrefix": {
-  "IsDiscriminator": true
-}
+```cs
+["SharedPrefix"] = new() { IsDiscriminator = true },
 ```
 
 Usage recommendations:
@@ -465,8 +463,8 @@ This is a monolithic mod that handles behavior specific to Khronos-style APIs su
 
 Because this mod is intended more for internal use rather than public use, the documentation here will focus on
 decisions made during the development of the mod and other internal details rather than the exact usage of the mod.
-For information relating to how the mod should be used, please use Silk's `generator.json` configuration, source code,
-and `MixKhronosDataTests` as a reference.
+For information relating to how the mod should be used, please use Silk's own configuration, source code, and
+`MixKhronosDataTests` as a reference.
 
 (TODO: Document major decisions relating to `MixKhronosData`. This is difficult because of the mod's long development
 history, and while this section is already massive, it still does not cover everything the mod does. This should be done

docs/for-contributors/Generator/using-the-generator.md

@@ -17,7 +17,8 @@ Metal.
 
 There are three main things to configure:
 
-1. Silk 3 - This is the [`generator.json`](https://github.com/dotnet/Silk.NET/blob/develop/3.0/generator.json) file.
+1. Silk 3 - This is the [`Silk.NET.SilkTouch.Jobs`](https://github.com/dotnet/Silk.NET/blob/develop/3.0/sources/SilkTouch/Jobs/Program.cs)
+   project. You may also use a single file app instead of a full C# project.
 
 2. ClangSharpPInvokeGenerator - This is the [`eng/silktouch`](https://github.com/dotnet/Silk.NET/tree/develop/3.0/eng/silktouch) folder.
 
@@ -32,9 +33,13 @@ you are binding.
 
 ## SilkTouch Configuration
 
-Silk defines the configuration for SilkTouch in the
-[`generator.json`](https://github.com/dotnet/Silk.NET/blob/develop/3.0/generator.json) file. This file defines the
-different bindings jobs and the list of mods to run for each job.
+Silk defines the configuration for SilkTouch as regular C# in the
+[`Silk.NET.SilkTouch.Jobs`](https://github.com/dotnet/Silk.NET/blob/develop/3.0/sources/SilkTouch/Jobs/Program.cs)
+project.
+
+This project defines the different bindings jobs and the list of mods to run for each job. Silk's own bindings jobs are
+split into multiple files for maintainability, but since this is regular C# code, you may organize your own job
+definitions however you wish.
 
 For example, when binding to a C API:
 
@@ -48,8 +53,8 @@ For example, when binding to a C API:
 
 Aside from reading documentation, some other ways to learn about the mods are to:
 
-- Read through the tests. The tests act as examples for specific behaviors expected by each mod, with configurations,
-  inputs, and expected outputs provided for each case.
+- Read through the SilkTouch tests. The tests act as examples for specific behaviors expected by each mod, with
+  configurations, inputs, and expected outputs provided for each case.
 
 - Add them one by one. Mods run in the order you define them and work off the output of the previous mod.
 
@@ -105,7 +110,9 @@ eng
     - SDL3
 ```
 
-Profiles likely will not be relevent for most C APIs, so the examples here will keep focusing on the SDL case.
+Profiles are not likely to be required for your average C API required, so the examples here will keep focusing on the
+SDL case. Profiles are needed when your API has multiple variants or needs to be generated on multiple platforms. For
+additional reference, please use the OpenGL (TODO: or OpenXR bindings) bindings jobs as examples.
 
 The following is the folder structure used for Silk's SDL bindings. You do not have to structure it the way Silk does.
 Silk's structure focuses on keeping consistency in its response file organization, regardless of whether the API makes
@@ -117,8 +124,8 @@ eng
   - sdl
     - SDL3
       - generate.rsp <-- The main settings file. Used as the entrypoint. All import paths must be relative to this file.
-      - header.txt
       - sdl-SDL.h <-- Handwritten header file that #includes the relevant headers of the library you want to bind.
+    - header.txt
     - remap.rsp
     - settings.rsp <-- Shared settings for all profiles.
 ```
@@ -164,7 +171,7 @@ Silk.NET.SDL
 --define-macro
 TODO_DEFINE_MACROS=HERE
 --headerFile
-header.txt
+../header.txt
 --include-directory
 ../../../submodules/sdl/include
 --with-callconv
@@ -238,23 +245,19 @@ MSBuild under the hood.
 The generator can be run directly from source using the following command:
 
 ```sh
-dotnet run --project sources/SilkTouch/SilkTouch/Silk.NET.SilkTouch.csproj -c Release -- generator.json --only SDL
+dotnet run --project sources/SilkTouch/SilkTouch/Silk.NET.SilkTouch.Jobs.csproj -c Release -- --only SDL
 ```
 
 You may use the `--help` option to display additional information about available options.
 
 ```
-dotnet run --project sources/SilkTouch/SilkTouch/Silk.NET.SilkTouch.csproj -c Release -- --help
+dotnet run --project sources/SilkTouch/SilkTouch/Silk.NET.SilkTouch.Jobs.csproj -c Release -- --help
 ```
 
 Some notable options include the `--only` and `--skip` options. `--only` lets you specify the exact jobs to run.
 `--skip` is the opposite and lets you specify the jobs to skip. If `--only` and `--skip` is specified for the same job,
 `--skip` takes precedence.
 
-Warning: There are currently some generator bugs associated with running multiple jobs in the same process. We recommend
-that you use `--only` to ensure that only one job is executed per process. Running multiple processes in parallel is
-fine.
-
 ### Generated Bindings Output
 
 All generated binding will be output to the `Jobs.JOB_NAME.SourceProject` path defined in `generator.json`.

eng/silktouch/sdl/settings.rsp

@@ -2,7 +2,7 @@
 --define-macro
 TODO_DEFINE_MACROS=HERE
 --headerFile
-header.txt
+../header.txt
 --include-directory
 ../../../submodules/sdl/include
 ../../../include/glcompat