Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Bugzilla 14945 - unions are missing from the ABI page #3915

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ntrel
Copy link
Contributor

@ntrel ntrel commented Sep 23, 2024

Also list empty struct size and add example.

@dlang-bot
Copy link
Contributor

Thanks for your pull request and interest in making D better, @ntrel! We are looking forward to reviewing it, and you should be hearing from a maintainer soon.
Please verify that your PR follows this checklist:

  • My PR is fully covered with tests (you can see the coverage diff by visiting the details link of the codecov check)
  • My PR is as minimal as possible (smaller, focused PRs are easier to review than big ones)
  • I have provided a detailed rationale explaining my changes
  • New or modified functions have Ddoc comments (with Params: and Returns:)

Please see CONTRIBUTING.md for more information.


If you have addressed all reviews or aren't sure how to proceed, don't hesitate to ping us with a simple comment.

Bugzilla references

Auto-close Bugzilla Severity Description
14945 trivial unions are missing from the ABI page

@@ -176,7 +176,18 @@ $(H2 $(LNAME2 struct_layout, Struct Layout))
the first field and the start of the object.
)

$(P Structs with no fields of non-zero size (aka $(I Empty Structs)) have a size of one byte.)
$(P $(DDSUBLINK spec/attribute, linkage, `extern(D)`) structs with no fields of non-zero
Copy link
Contributor

@Bolpat Bolpat Sep 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Avoid the double negation “no … with non-…” and instead use “all … with …”.

Suggested change
$(P $(DDSUBLINK spec/attribute, linkage, `extern(D)`) structs with no fields of non-zero
$(P $(DDSUBLINK spec/attribute, linkage, `extern(D)`) structs with all fields of zero

Mathematically speaking, any all statement about things is vacuously true if there are none. Most people who read this part of the spec will understand it, but if you’re in doubt, you could do this instead:

Suggested change
$(P $(DDSUBLINK spec/attribute, linkage, `extern(D)`) structs with no fields of non-zero
$(P $(DDSUBLINK spec/attribute, linkage, `extern(D)`) structs with no fields or all fields of zero

$(P Conforms to the target's C ABI struct layout.)
$(P These conform to the target's C ABI struct layout, except:)

* An `extern(D)` struct or union with no fields has size 1, not 0.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also extern(C++) structs seem to have non-zero size judging by running a simple example. The C++ Standard (all versions) agrees with that.

Suggested change
* An `extern(D)` struct or union with no fields has size 1, not 0.
* An `extern(D)` or `extern(C++)` struct or union with no fields has size 1, not 0.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This paragraph is about differences from C. The link that follows is for further information.

Comment on lines +184 to +188
extern(C) struct C {}
struct D {}

static assert(C.sizeof == 0);
static assert(D.sizeof == 1);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be worth adding an extern(C++) example.

Suggested change
extern(C) struct C {}
struct D {}
static assert(C.sizeof == 0);
static assert(D.sizeof == 1);
extern(C) struct C {}
extern(C++) struct Cpp {}
struct D {}
static assert(C.sizeof == 0);
static assert(Cpp.sizeof == 1);
static assert(D.sizeof == 1);

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants