Updated LowLevel/Functions manual documentation #1300
Conversation
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
bolt12
commented
Nov 18, 2025
Comment on lines
+256
to
+261
| > [!NOTE] | ||
| > The `hs-bindgen-runtime` library provides Template Haskell utilities for | ||
| > generating these instances manually when needed. See | ||
| > `HsBindgen.Runtime.TH.Instances` for details. This can be useful when | ||
| > working with function pointer types that `hs-bindgen` doesn't automatically | ||
| > generate instances for, or when writing custom high-level bindings. |
bolt12
commented
Nov 18, 2025
Comment on lines
+266
to
+271
| - Types appearing as function parameters receive `"wrapper"` imports (you need | ||
| to create function pointers to pass as arguments) | ||
| - Types for function pointer values receive `"dynamic"` imports (you | ||
| need to call returned function pointers) | ||
| - Types appearing in struct or union fields receive both (they may flow in | ||
| either direction) |
Collaborator
Author
There was a problem hiding this comment.
Rephrase this, and mention that these instances are only generated if the function signature has at least one domain specific type (because otherwise they would be orphans and to avoid repeating the instances)
bolt12
commented
Nov 18, 2025
Comment on lines
+292
to
+295
| do | ||
| funPtr <- toFunPtr myCallback | ||
| onProgressChanged (ProgressUpdate funPtr) | ||
| freeHaskellFunPtr (un_ProgressUpdate funPtr) |
Collaborator
Author
There was a problem hiding this comment.
Change this example to use bracket
bolt12
commented
Nov 18, 2025
Comment on lines
+326
to
+327
| Since these function pointer types appear in struct fields, they receive both | ||
| wrapper and dynamic imports. This allows you to populate the struct with |
Collaborator
Author
There was a problem hiding this comment.
This is not quite right. Maybe say something like "Here we need both instances"
bolt12
commented
Nov 18, 2025
Collaborator
Author
There was a problem hiding this comment.
- Introduction
- Safe vs Unsafe
- Function addresses
3.1. current "Function pointers" beceomes section 3
3.2. "Implicit function to pointer conversion" becomes 3.2 - Conversion between Haskell functions and C functions
- Userland CAPI: Introduction (we generate a C wrapper, yadayayada)
5.1 Structs by value
5.2 Static inline functions
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR closes #827.