mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add links to overview.md (#1202)

This commit is contained in:
Dezhi Wu 2021-09-07 05:34:16 +08:00 committed by GitHub
parent a5dea10a46
commit 71d88b345f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/overview.md
View File

@ -43,16 +43,17 @@ we'll talk about that later.
- The lexer preserves full fidelity information for both IDEs and proc macros. - The lexer preserves full fidelity information for both IDEs and proc macros.
- The parser [translates the token stream from the lexer into an Abstract Syntax - The parser [translates the token stream from the lexer into an Abstract Syntax
Tree (AST)][parser]. It uses a recursive descent (top-down) approach to syntax Tree (AST)][parser]. It uses a recursive descent (top-down) approach to syntax
analysis. The crate entry points for the parser are the `Parser::parse_crate_mod()` and analysis. The crate entry points for the parser are the
`Parser::parse_mod()` methods found in `rustc_parse::parser::Parser`. The external [`Parser::parse_crate_mod()`][parse_crate_mod] and [`Parser::parse_mod()`][parse_mod]
module parsing entry point is `rustc_expand::module::parse_external_mod`. And methods found in [`rustc_parse::parser::Parser`]. The external module parsing
the macro parser entry point is [`Parser::parse_nonterminal()`][parse_nonterminal]. entry point is [`rustc_expand::module::parse_external_mod`][parse_external_mod].
And the macro parser entry point is [`Parser::parse_nonterminal()`][parse_nonterminal].
- Parsing is performed with a set of `Parser` utility methods including `fn bump`, - Parsing is performed with a set of `Parser` utility methods including `fn bump`,
`fn check`, `fn eat`, `fn expect`, `fn look_ahead`. `fn check`, `fn eat`, `fn expect`, `fn look_ahead`.
- Parsing is organized by the semantic construct that is being parsed. Separate - Parsing is organized by the semantic construct that is being parsed. Separate
`parse_*` methods can be found in `rustc_parse` `parser` directory. The source `parse_*` methods can be found in [`rustc_parse` `parser`][rustc_parse_parser_dir]
file name follows the construct name. For example, the following files are found directory. The source file name follows the construct name. For example, the
in the parser: following files are found in the parser:
- `expr.rs` - `expr.rs`
- `pat.rs` - `pat.rs`
- `ty.rs` - `ty.rs`
@ -123,6 +124,11 @@ we'll talk about that later.
[`simplify_try`]: https://github.com/rust-lang/rust/pull/66282 [`simplify_try`]: https://github.com/rust-lang/rust/pull/66282
[codegen]: https://rustc-dev-guide.rust-lang.org/backend/codegen.html [codegen]: https://rustc-dev-guide.rust-lang.org/backend/codegen.html
[parse_nonterminal]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_parse/parser/struct.Parser.html#method.parse_nonterminal [parse_nonterminal]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_parse/parser/struct.Parser.html#method.parse_nonterminal
[parse_crate_mod]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_parse/parser/struct.Parser.html#method.parse_crate_mod
[parse_mod]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_parse/parser/struct.Parser.html#method.parse_mod
[`rustc_parse::parser::Parser`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_parse/parser/struct.Parser.html
[parse_external_mod]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_expand/module/fn.parse_external_mod.html
[rustc_parse_parser_dir]: https://github.com/rust-lang/rust/tree/master/compiler/rustc_parse/src/parser
## How it does it ## How it does it