Fix struct field offsets
#275
Merged
Conversation
This file contains 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
* Add `enum` integer type trace * Add field offset trace * Add field bit width trace * Add `enum` constant integer value trace * Add `typedef` name trace * Reorganize `foldDecls` so that information based on the cursor kind can be output before comments
`libclang` reports offsets in *bits*, while `Storable` methods use offsets in *bytes*. We do not support bit fields yet, so this commit adds an assertion that all offsets are byte-aligned, converts from bits to bytes where necessary, and documents the unit.
phadej
reviewed
Nov 13, 2024
| @@ -124,6 +127,8 @@ mkStructField unit current = do | |||
| fieldOffset <- fromIntegral <$> clang_Cursor_getOffsetOfField current | |||
| fieldName <- CName <$> clang_getCursorDisplayName current | |||
|
|
|||
| unless (fieldOffset `mod` 8 == 0) $ error "bit-fields not supported yet" | |||
There was a problem hiding this comment.
fail. Don't use error in IO.
There was a problem hiding this comment.
@edsko requested that I use error for such assertions, only using fail for things that may be handled. (I put similar assertions in the documentation reification, also running in IO.)
|
Thanks for doing this. I'll merge this as-is, but I still think #22 (comment) is worth considering, a check such as "is `n divisible by 8" is too easy to forget. |
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.
libclangreports offsets in bits, whileStorablemethods use offsets in bytes. We do not support bit fields yet, so this PR adds an assertion that all offsets are byte-aligned, converts from bits to bytes where necessary, and documents the unit.In addition, documentation is added to
clang_Cursor_getOffsetOfField, functionsclang_Cursor_isBitFieldandclang_getFieldDeclBitWidthare added, andclang-ast-dumpis updated to dump more information.