Skip to content

Struct grammar #237

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Feb 11, 2018
Merged

Struct grammar #237

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
45e4259
Struct grammar
brauliobz Nov 30, 2017
c20b106
Remove extraneous ?s in struct grammar
Havvy Feb 7, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions src/items/structs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,41 @@
# Structs

> **<sup>Syntax</sup>**
> _Struct_ :
> &nbsp;&nbsp; &nbsp;&nbsp; _StructStruct_
> &nbsp;&nbsp; | _TupleStruct_
>
> _StructStruct_ :
> &nbsp;&nbsp; `struct`
> [IDENTIFIER]&nbsp;
> [_Generics_]<sup>?</sup>
> [_WhereClause_]<sup>?</sup>
> ( `{` _StructFields_<sup>?</sup> `}` | `;` )
Copy link
Contributor

@matthewjasper matthewjasper Feb 10, 2018

Choose a reason for hiding this comment

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

Would it help to have this match the text and split this into StructStruct and UnitStruct?

Copy link
Contributor Author

@Havvy Havvy Feb 11, 2018

Choose a reason for hiding this comment

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

I think I considered that when I first reviewed @brauliobz 's grammar and found a reason against it. Not sure anymore though. I'd rather not mess with the PR anymore than needed right now.

>
> _TupleStruct_ :
> &nbsp;&nbsp; `struct`
> [IDENTIFIER]&nbsp;
> [_Generics_]<sup>?</sup>
> `(` _TupleFields_<sup>?</sup> `)`
> [_WhereClause_]<sup>?</sup>
> `;`
>
> _StructFields_ :
> &nbsp;&nbsp; _StructField_ (`,` _StructField_)<sup>\*</sup> `,`<sup>?</sup>
>
> _StructField_ :
> &nbsp;&nbsp; [_OuterAttribute_]<sup>\*</sup>
> &nbsp;&nbsp; [_Visibility_]
> &nbsp;&nbsp; [IDENTIFIER] `:` [_Type_]
>
> _TupleFields_ :
> &nbsp;&nbsp; _TupleField_ (`,` _TupleField_)<sup>\*</sup> `,`<sup>?</sup>
>
> _TupleField_ :
> &nbsp;&nbsp; [_OuterAttribute_]<sup>\*</sup>
> &nbsp;&nbsp; [_Visibility_]
> &nbsp;&nbsp; [_Type_]

A _struct_ is a nominal [struct type] defined with the keyword `struct`.

An example of a `struct` item and its use:
Expand Down Expand Up @@ -43,3 +79,10 @@ The precise memory layout of a struct is not specified. One can specify a
particular layout using the [`repr` attribute].

[`repr` attribute]: attributes.html#ffi-attributes

[_OuterAttribute_]: attributes.html
[IDENTIFIER]: identifiers.html
[_Generics_]: items.html#type-parameters
[_WhereClause_]: items.html#type-parameters
[_Visibility_]: visibility-and-privacy.html
[_Type_]: types.html