[3.0] COM Binding Transformation #2406

curin · 2024-12-31T14:58:36Z

Summary of the PR

Adds the necessary enhancements to allow for easy to use COM bindings and any changes required to get Microsoft Bindings building.

-Adds TransformCOM mod to implement in place ComPtr transformations in all COM classes
-Adds DisableWarnings mod to disable warnings in all files for a job in order to avoid build errors from unavoidable or ignorable errors
-Adds several additions to ClangScraper to disable caching and remove generated files from the output.
-Adds some QOL improvements such as --only and csv list support to silk touch

curin · 2025-01-10T02:25:21Z

@Perksey Ready for Review

Perksey

Nice work! It's cool to see this come together :)

Some notes...

sources/SilkTouch/SilkTouch/Clang/ClangScraper.cs

sources/SilkTouch/SilkTouch/Clang/ResponseFileHandler.cs

sources/SilkTouch/SilkTouch/Mods/DisableWarnings.cs

generator.json

sources/SilkTouch/SilkTouch/Mods/TransformCOM.cs

sources/Win32/Win32/DirectX/d3d12/d3dcommon/ID3DDestructionNotifier.gen.cs

Perksey · 2025-01-12T21:03:13Z

Obviously note the CI errors as well if you haven't already.

generator.json

sources/Win32/Win32/DirectX/d3d12/d3dcommon/D3D_CBUFFER_TYPE.gen.cs

sources/SilkTouch/SilkTouch/Mods/TransformInterfaces.cs

Perksey

Sorry this review is a bit all over the place, I wrote things as I saw them so comments may not be placed at their root causes.

Glad to see this moving along nicely.

Perksey · 2025-02-06T14:16:27Z

sources/Core/Core/DSL/MaybeBool`1.cs

+    /// <summary>
+    /// compares boolean value and int
+    /// </summary>
+    /// <param name="lh"></param>


I haven't really called this out in past PRs as it is a bit of a nitpick, but it would be nice if you did fill out the documentation template generated!

sources/Core/Core/Pointers/Ptr.cs

Perksey · 2025-02-06T14:18:23Z

sources/Core/Core/Pointers/Ptr.generic.cs

+        [MethodImpl(
+            MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization
+        )]
+        public static implicit operator Ptr<T>(nuint ptr) => new((T*)ptr.ToPointer());


Same comment.

sources/Core/Core/INativeInterface.cs

sources/SilkTouch/SilkTouch/Utility/ProgressBarUtility.cs

sources/SilkTouch/SilkTouch/Mods/TransformCOM.cs

sources/SilkTouch/SilkTouch/Mods/TransformInterfaces.cs

-also support for csv lists in --only and --skip

-Setup to run using new mod system properly -Added pointer member accessor to member accessor conversion -Added Logging

per Mod Performance

-Added early out -fix duplicate call -Add INativeGuid

-fixed some broken using from TerraFX files -Allowed BaseType to be specified for ComTypes -Added several files for override due to issue in generation

-allowed for multiple COM base types -allowed for addition of manual COM types -added several manual overrides -added all manual files necessary for compilation

Fixed some manual warnings as well

This reverts commit 0a1bd47.

-using globbing instead of regex -removed an unnecessary restriction on interface finding -updates single line code to expression bodies

Co-authored-by: Dylan Perks <[email protected]>

for rollback purposes

moved to internal Native struct INativeInterface and IComInterface added to represent all interfaces and Com interfaces, respectively. - IComInterface is a child of INativeInterface and INativeGuid

-and fixing issues with how it works

added manual file importer added a progress bar in some cases for QoL moved rename function into NameUtils

Added per job file logs fixed up the progress bar system to be cleaner

This reverts commit ed1c763.

Also split some common classes out into core

Benefit of the doubt is expected and will now be accounted for

also fix for CI issues

Perksey

I'm really getting excited at this point now, and really happy with the progress on this PR. Yes I know there's 30 comments, but most of these are fairly small (in my opinion) and don't call into question conceptual/large ways of doing things as previous reviews have. Thanks for keeping with it!

Perksey · 2025-03-05T04:48:59Z

sources/Core/Core/Pointers/Ptr3D.cs

@@ -409,8 +409,7 @@ ptr.Native is not null && ptr.Native->Native is not null
        [MethodImpl(
            MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization
        )]
-        // TODO analyzer to ensure ptr is on stack or otherwise pinned


Can you keep this comment please

Perksey · 2025-03-05T04:51:05Z

sources/Core/Core/Windows/other/helper-types/BOOL.gen.cs

-
-namespace Silk.NET.Windows;
+#pragma warning disable CS1589, CS1591, CS0419, CA1416, CS0618
+namespace Silk.NET.Core;

 public readonly partial struct BOOL : IComparable, IComparable<BOOL>, IEquatable<BOOL>, IFormattable


We need to have a discussion on whether we want to keep this type. We already have MaybeBool<int> - if this is missing functionality then we should probably add that functionality there.

Perksey · 2025-03-05T04:53:38Z

sources/Core/Core/Windows/other/helper-types/HANDLE.gen.cs

-
-namespace Silk.NET.Windows;
+#pragma warning disable CS1589, CS1591, CS0419, CA1416, CS0618
+namespace Silk.NET.Core;

 public readonly unsafe partial struct HANDLE


Should this be Handle? Or perhaps NativeHandle/Win32Handle?

Perksey · 2025-03-05T04:54:03Z

sources/Core/Core/Windows/other/helper-types/HRESULT.gen.cs

-
-namespace Silk.NET.Windows;
+#pragma warning disable CS1589, CS1591, CS0419, CA1416, CS0618
+namespace Silk.NET.Core;

 public readonly unsafe partial struct HRESULT


Should this be HResult?

Perksey · 2025-03-05T04:54:15Z

sources/Core/Core/Windows/other/helper-types/HSTRING.gen.cs

-
-namespace Silk.NET.WinRT;
+#pragma warning disable CS1589, CS1591, CS0419, CA1416, CS0618
+namespace Silk.NET.Core;

 public readonly unsafe partial struct HSTRING


Should this be HString? Note: In 2.X this was called WinString iirc, which is also a terrible name but oh well.

Perksey · 2025-03-13T22:09:50Z

sources/SilkTouch/SilkTouch/Mods/TransformFunctions.cs

 using Silk.NET.SilkTouch.Mods.Transformation;
+using Silk.NET.SilkTouch.Naming;
+using Silk.NET.SilkTouch.Utility;
+using static System.Runtime.InteropServices.JavaScript.JSType;


not sure what happened here

Perksey · 2025-03-13T22:12:50Z

sources/SilkTouch/SilkTouch/Mods/TransformFunctions.cs

+                                SeparatedList(
+                                    x.Attributes.Where(y =>
+                                        !y.IsAttribute(
+                                            "System.Runtime.InteropServices.UnmanagedCallersOnly"


Maybe my other comment makes this unnecessary or invalid?

Perksey · 2025-03-13T22:17:48Z

generator.json

+            "Namespace": "Silk.NET.Win32",
+            "Parent": "IDispatch.Interface"
+          },
+          "IInspectable.Interface": {


Tbh, all the ones that are in Silk.NET.Core should be in additional COM types by default.

fair, we can append them easily enough.

Perksey · 2025-03-13T22:25:21Z

sources/SilkTouch/SilkTouch/JobContext.cs

+    /// <summary>
+    /// Information on the current Job
+    /// </summary>
+    public class JobContext


Let's make this internal for now given that it's only our CLI that uses it today and there's no immediate use case for anyone else using this.

Can't, makes DI upset for the progressService. You would have to make the constructor internal as well and DI doesn't seem to like that. It only seems to work with a public one.

Perksey · 2025-03-13T22:26:05Z

sources/SilkTouch/SilkTouch/Program.cs

    var sp = new ServiceCollection()
+        .AddSingleton(jobContext)
+        .AddSingleton<IProgressService, ProgressService>()


Perhaps this line should be part of AddSilkTouch. Note that you'll probably have to move the ConsoleRenderer AddSingleton call to after AddSilkTouch (might not though, but if it breaks this might be why).

Co-authored-by: Dylan Perks <[email protected]>

Perksey changed the base branch from main to develop/3.0 December 31, 2024 15:04

curin marked this pull request as ready for review January 10, 2025 02:25

curin requested a review from a team as a code owner January 10, 2025 02:25

Perksey reviewed Jan 12, 2025

View reviewed changes

Perksey reviewed Jan 15, 2025

View reviewed changes

generator.json Outdated Show resolved Hide resolved

sources/Win32/Win32/DirectX/d3d12/d3dcommon/D3D_CBUFFER_TYPE.gen.cs Outdated Show resolved Hide resolved

curin commented Feb 8, 2025

View reviewed changes

sources/SilkTouch/SilkTouch/Mods/TransformInterfaces.cs Show resolved Hide resolved

Perksey requested changes Feb 8, 2025

View reviewed changes

Perksey and others added 21 commits February 15, 2025 18:33

Start work on documenting the API

ed1c763

Add --only commandline arg to silktouch

452bda9

-also support for csv lists in --only and --skip

Initial Work to Add COM transformations

cec591f

Add Win32 projects to the Solution

0e2c085

Added Logging to ClangScraper

5593b03

TransformCOM update

5f17c4e

-Setup to run using new mod system properly -Added pointer member accessor to member accessor conversion -Added Logging

Additional Perf Logging

4712536

per Mod Performance

More COM work

d28b57b

-Added early out -fix duplicate call -Add INativeGuid

Fix null assignments

8d81b80

-fixed some broken using from TerraFX files -Allowed BaseType to be specified for ComTypes -Added several files for override due to issue in generation

Finish Usage Update Fixes + misc updates

d23a01c

-allowed for multiple COM base types -allowed for addition of manual COM types -added several manual overrides -added all manual files necessary for compilation

Remove old generated Windows files

b0efaf9

Added casts + disabled blocking warnings

3d94412

Fixed some manual warnings as well

Disable Warnings, Remove Generated Files, and Cleanup

9f394e8

Generation Dump

f696f66

Revert "Generation Dump"

f41dc67

This reverts commit 0a1bd47.

D3DCommon Generation

358ff23

undo temp comment

bb8b897

Deduplication of code in DisableWarnings

623ecb0

Addressing Review Comments

2fa7ac8

-using globbing instead of regex -removed an unnecessary restriction on interface finding -updates single line code to expression bodies

Update generator.json

bb29617

Co-authored-by: Dylan Perks <[email protected]>

Pre TransformInterfaces Commit

0a5c7c5

for rollback purposes

curin added 8 commits February 15, 2025 18:39

TransformInterfaces TransformCOM split

b2cbb69

moved to internal Native struct INativeInterface and IComInterface added to represent all interfaces and Com interfaces, respectively. - IComInterface is a child of INativeInterface and INativeGuid

Adding TransformFunctions

af96ea8

-and fixing issues with how it works

Fixing Transform Functions

fcfb86c

added manual file importer added a progress bar in some cases for QoL moved rename function into NameUtils

Run CSharpier

3352032

Addressing some Review Feedback

1582ea0

cleanup from merging

54dd8dd

Logging and Progress Update

a806ddf

Added per job file logs fixed up the progress bar system to be cleaner

Revert Accidental addition of input changes

fe2f36c

This reverts commit ed1c763.

curin force-pushed the develop/3/com-bindings-refactor branch from 6c6d633 to fe2f36c Compare February 16, 2025 00:05

curin added 4 commits February 28, 2025 17:24

Addressed Review Feedback

fcb5796

Also split some common classes out into core

Fix ArrayParameterTransformerTests

5ad72eb

Benefit of the doubt is expected and will now be accounted for

Remove Temporary Timing Data Collection

2bfd641

Fix ConsoleReader Threading

85fed9e

also fix for CI issues

Perksey requested changes Mar 13, 2025

View reviewed changes

Condense TreatWarningsAsErrors

4e9086f

Co-authored-by: Dylan Perks <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[3.0] COM Binding Transformation #2406

[3.0] COM Binding Transformation #2406

curin commented Dec 31, 2024 •

edited

Loading

curin commented Jan 10, 2025

Perksey left a comment

Perksey commented Jan 12, 2025

Perksey left a comment

Perksey Feb 6, 2025

Perksey Feb 6, 2025

Perksey left a comment

Perksey Mar 5, 2025

Perksey Mar 5, 2025

Perksey Mar 5, 2025

Perksey Mar 5, 2025

Perksey Mar 5, 2025

Perksey Mar 13, 2025

curin Mar 13, 2025 •

edited

Loading

Perksey Mar 13, 2025

Perksey Mar 13, 2025

curin Mar 13, 2025

Perksey Mar 13, 2025

curin Mar 14, 2025

Perksey Mar 13, 2025

[3.0] COM Binding Transformation #2406

Are you sure you want to change the base?

[3.0] COM Binding Transformation #2406

Conversation

curin commented Dec 31, 2024 • edited Loading

Summary of the PR

curin commented Jan 10, 2025

Perksey left a comment

Choose a reason for hiding this comment

Perksey commented Jan 12, 2025

Perksey left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Perksey left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

curin Mar 13, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

curin commented Dec 31, 2024 •

edited

Loading

curin Mar 13, 2025 •

edited

Loading