-
Notifications
You must be signed in to change notification settings - Fork 547
Create a chapter for AST validation #1524
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,37 @@ | ||
# AST Validation | ||
|
||
AST validation is the process of checking various correctness properties about | ||
the AST after macro expansion. | ||
* [About](#about) | ||
* [Validation](#validation) | ||
|
||
**TODO**: write this chapter. [#656](https://github.com/rust-lang/rustc-dev-guide/issues/656) | ||
## About | ||
|
||
_AST validation_ is a separate AST pass that visits each | ||
item in the tree and performs simple checks. This pass | ||
doesn't perform any complex analysis, type checking or | ||
name resolution. | ||
|
||
Before performing any validation, the compiler first expands | ||
the macros. Then this pass performs validations to check | ||
that each AST item is in the correct state. And when this pass | ||
is done, the compiler runs the crate resolution pass. | ||
|
||
## Validations | ||
|
||
Validations are defined in `AstValidator` class, which | ||
dbelik marked this conversation as resolved.
Show resolved
Hide resolved
|
||
itself is located in `rustc_ast_passes` crate. This | ||
class implements various simple checks which emit errors | ||
dbelik marked this conversation as resolved.
Show resolved
Hide resolved
|
||
when certain language rules are broken. | ||
|
||
In addition, `AstValidator` implements `Visitor` trait | ||
that defines how to visit AST items (which can be functions, | ||
traits, enums, etc). | ||
|
||
For each item, visitor performs specific checks. For | ||
example, when visiting a function declaration, | ||
`AstValidator` checks that the function has: | ||
|
||
* no more than `u16::MAX` parameters; | ||
* c-variadic functions are declared with at least one named argument; | ||
* c-variadic argument goes the last in the declaration; | ||
* documentation comments aren't applied to function parameters; | ||
* and other validations. |
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.
Uh oh!
There was an error while loading. Please reload this page.