Uh oh!
There was an error while loading. Please reload this page.
[3.0] Add generator docs - #2578
Merged
Merged
Conversation
…rary" I saw that static-vs-instance-bindings.md used the terms "API" and "native API" to describe the APIs being bound to using SilkTouch. I'm deciding to keep this pattern moving forward for consistency.
12 tasks
(cherry picked from commit 3192da8be03dffedae9319636018ee901f959716)
Exanite
commented
Jun 10, 2026
Exanite
left a comment
MemberAuthor
There was a problem hiding this comment.
Self review completed. I didn't deeply review the docs I wrote, but I skimmed through each of them a couple of times. My goal is to get the information out there first, then refine the docs in the future. There's also a few sections I left as TODOs because I don't have enough knowledge to fill them out.
Uh oh!
There was an error while loading. Please reload this page.
Exanite
commented
Jun 10, 2026
MemberAuthor
I'll mark this PR as ready for review once #2587 has been merged. |
curin
approved these changes
Jun 12, 2026
curin
left a comment
Contributor
There was a problem hiding this comment.
looks really good, thanks for tackling this
…#2587) * Start of generator fixes and polish branch * Add stubs for ExtractEnumConstants and ExtractFunctionPointers * Fix invalid interface implementation * Work on splitting ExtractNestedTyping into 3 separate mods * Continue to move code to their new locations * Further cleanup * Rename ExtractNestedTyping to ExtractNestedTypes This is be more consistent with C#'s terminology now that ExtractNestedTypes strictly only handles NestedTypes and not other forms of "nested typing". * Split ExtractNestedTypes tests into 3 sets of tests and ensure project is compilable (if not correct) This is so I can start testing for expected behavior. * Get ExtractNestedTypes working * Update test snapshot names * Get ExtractFunctionPointers working * Fix subtly incorrect behavior and remove dependency on Mod for ExtractFunctionPointers/NestedTypes * Move GetNativeTypeNameForPredefinedType to ExtractEnumConstants and cleanup * Fix incorrect file name * Prefer IMod over Mod where possible This also means free performance since Mod sneakily creates a compilation and walks through it * Document where ExtractFunctionPointers and ExtractNestedTypes output their extracted files Also add todo for doing the same in ExtractEnumConstants * Get ExtractEnumConstants working * Update config * Add remark comment on ExtractNestedTypes only handling ClangScraper's special structs * Generate on Windows (apparently accidentally fixed a namespace bug) * Remove unused code * Cleanup GetNativeTypeNameForPredefinedType * Use constructor and avoid nullable properties We always allocate these so this is strictly a readability and performance improvement. * Refactor code to use record structs * Work on deciphering tuple usages * Figure out what _numericTypeNames does * Add support for requiredTargetSpecifier to TryParseNativeTypeName * Handle method return types properly and fix SuccessfullyExtractsCStyleEnumConstants_ReturnType * Cleanup todos * Handle fields properly and fix SuccessfullyExtractsCStyleEnumConstants_Field * Generate on Windows * Cleanup * Annotate extracted enums with [NativeName] * Generate on Windows * Add IEquatable to transformed handle types These already implemented all the required members for IEquatable, so I found it weird that they didn't also implement the interface. * Generate on Windows for IEquatable handles change * Add TransformHandlesTests * Reorder code for clarity * Update docs with sections for the 3 mods ExtractNestedTyping was split into * Change Sdl in ExtractEnumConstantsTests to be a class, not a struct This is more representative of the actual bindings even though it doesn't affect the tests. * Fix incorrect variable name and type name
Exanite
marked this pull request as ready for review
June 12, 2026 06:27
Uh oh!
There was an error while loading. Please reload this page.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary of the PR
This replaces my previous WIP PR for adding generator usage documentation (#2545) in favor of providing a more complete set of docs relating to both using the generator and how the generator internals work.
Related issues, Discord discussions, or proposals
Related discord thread: https://discord.com/channels/521092042781229087/1500974857079492749
Further Comments
There are sections that I left empty (marked with TODOs) since I don't have enough knowledge to fill out those sections.
Tasks
ExtractNestedTypingconstant extraction does not handle nor rewrite fields that are typed as a predefined type, but are natively typed as an enum (test case:SuccessfullyExtractsCStyleEnumConstants_Field)ExtractNestedTypingconstant extraction does not handle nor rewrite return types that are typed as a predefined type, but are natively typed as an enum (test case:SuccessfullyExtractsCStyleEnumConstants_ReturnType)ExtractNestedTypingdoes not annotate extracted enums with the[NativeName]attribute. Eg:SDL_BlendMode.IEquatable<T>interface.From my tracking issue: