crates/parser/src/grammar.rs

   1 //! This is the actual "grammar" of the Rust language.
   2 //!
   3 //! Each function in this module and its children corresponds
   4 //! to a production of the formal grammar. Submodules roughly
   5 //! correspond to different *areas* of the grammar. By convention,
   6 //! each submodule starts with `use super::*` import and exports
   7 //! "public" productions via `pub(super)`.
   8 //!
   9 //! See docs for [`Parser`](super::parser::Parser) to learn about API,
  10 //! available to the grammar, and see docs for [`Event`](super::event::Event)
  11 //! to learn how this actually manages to produce parse trees.
  12 //!
  13 //! Code in this module also contains inline tests, which start with
  14 //! `// test name-of-the-test` comment and look like this:
  15 //!
  16 //! ```
  17 //! // test function_with_zero_parameters
  18 //! // fn foo() {}
  19 //! ```
  20 //!
  21 //! After adding a new inline-test, run `cargo test -p xtask` to
  22 //! extract it as a standalone text-fixture into
  23 //! `crates/syntax/test_data/parser/`, and run `cargo test` once to
  24 //! create the "gold" value.
  25 //!
  26 //! Coding convention: rules like `where_clause` always produce either a
  27 //! node or an error, rules like `opt_where_clause` may produce nothing.
  28 //! Non-opt rules typically start with `assert!(p.at(FIRST_TOKEN))`, the
  29 //! caller is responsible for branching on the first token.
  30
  31 mod attributes;
  32 mod expressions;
  33 mod items;
  34 mod params;
  35 mod paths;
  36 mod patterns;
  37 mod generic_args;
  38 mod generic_params;
  39 mod types;
  40
  41 use crate::{
  42     parser::{CompletedMarker, Marker, Parser},
  43     SyntaxKind::{self, *},
  44     TokenSet, T,
  45 };
  46
  47 pub(crate) mod entry {
  48     use super::*;
  49
  50     pub(crate) mod prefix {
  51         use super::*;
  52
  53         pub(crate) fn vis(p: &mut Parser) {
  54             let _ = opt_visibility(p, false);
  55         }
  56
  57         pub(crate) fn block(p: &mut Parser) {
  58             expressions::block_expr(p);
  59         }
  60
  61         pub(crate) fn stmt(p: &mut Parser) {
  62             expressions::stmt(p, expressions::Semicolon::Forbidden);
  63         }
  64
  65         pub(crate) fn pat(p: &mut Parser) {
  66             patterns::pattern_single(p);
  67         }
  68
  69         pub(crate) fn ty(p: &mut Parser) {
  70             types::type_(p);
  71         }
  72         pub(crate) fn expr(p: &mut Parser) {
  73             let _ = expressions::expr(p);
  74         }
  75         pub(crate) fn path(p: &mut Parser) {
  76             let _ = paths::type_path(p);
  77         }
  78         pub(crate) fn item(p: &mut Parser) {
  79             items::item_or_macro(p, true);
  80         }
  81         // Parse a meta item , which excluded [], e.g : #[ MetaItem ]
  82         pub(crate) fn meta_item(p: &mut Parser) {
  83             attributes::meta(p);
  84         }
  85     }
  86
  87     pub(crate) mod top {
  88         use super::*;
  89
  90         pub(crate) fn source_file(p: &mut Parser) {
  91             let m = p.start();
  92             p.eat(SHEBANG);
  93             items::mod_contents(p, false);
  94             m.complete(p, SOURCE_FILE);
  95         }
  96
  97         pub(crate) fn macro_stmts(p: &mut Parser) {
  98             let m = p.start();
  99
 100             while !p.at(EOF) {
 101                 expressions::stmt(p, expressions::Semicolon::Optional);
 102             }
 103
 104             m.complete(p, MACRO_STMTS);
 105         }
 106
 107         pub(crate) fn macro_items(p: &mut Parser) {
 108             let m = p.start();
 109             items::mod_contents(p, false);
 110             m.complete(p, MACRO_ITEMS);
 111         }
 112
 113         pub(crate) fn pattern(p: &mut Parser) {
 114             let m = p.start();
 115             patterns::pattern_single(p);
 116             if p.at(EOF) {
 117                 m.abandon(p);
 118                 return;
 119             }
 120             while !p.at(EOF) {
 121                 p.bump_any();
 122             }
 123             m.complete(p, ERROR);
 124         }
 125     }
 126 }
 127
 128 pub(crate) fn reparser(
 129     node: SyntaxKind,
 130     first_child: Option<SyntaxKind>,
 131     parent: Option<SyntaxKind>,
 132 ) -> Option<fn(&mut Parser)> {
 133     let res = match node {
 134         BLOCK_EXPR => expressions::block_expr,
 135         RECORD_FIELD_LIST => items::record_field_list,
 136         RECORD_EXPR_FIELD_LIST => items::record_expr_field_list,
 137         VARIANT_LIST => items::variant_list,
 138         MATCH_ARM_LIST => items::match_arm_list,
 139         USE_TREE_LIST => items::use_tree_list,
 140         EXTERN_ITEM_LIST => items::extern_item_list,
 141         TOKEN_TREE if first_child? == T!['{'] => items::token_tree,
 142         ASSOC_ITEM_LIST => match parent? {
 143             IMPL | TRAIT => items::assoc_item_list,
 144             _ => return None,
 145         },
 146         ITEM_LIST => items::item_list,
 147         _ => return None,
 148     };
 149     Some(res)
 150 }
 151
 152 #[derive(Clone, Copy, PartialEq, Eq)]
 153 enum BlockLike {
 154     Block,
 155     NotBlock,
 156 }
 157
 158 impl BlockLike {
 159     fn is_block(self) -> bool {
 160         self == BlockLike::Block
 161     }
 162 }
 163
 164 fn opt_visibility(p: &mut Parser, in_tuple_field: bool) -> bool {
 165     match p.current() {
 166         T![pub] => {
 167             let m = p.start();
 168             p.bump(T![pub]);
 169             if p.at(T!['(']) {
 170                 match p.nth(1) {
 171                     // test crate_visibility
 172                     // pub(crate) struct S;
 173                     // pub(self) struct S;
 174                     // pub(super) struct S;
 175
 176                     // test pub_parens_typepath
 177                     // struct B(pub (super::A));
 178                     // struct B(pub (crate::A,));
 179                     T![crate] | T![self] | T![super] | T![ident] if p.nth(2) != T![:] => {
 180                         // If we are in a tuple struct, then the parens following `pub`
 181                         // might be an tuple field, not part of the visibility. So in that
 182                         // case we don't want to consume an identifier.
 183
 184                         // test pub_tuple_field
 185                         // struct MyStruct(pub (u32, u32));
 186                         if !(in_tuple_field && matches!(p.nth(1), T![ident])) {
 187                             p.bump(T!['(']);
 188                             paths::use_path(p);
 189                             p.expect(T![')']);
 190                         }
 191                     }
 192                     // test crate_visibility_in
 193                     // pub(in super::A) struct S;
 194                     // pub(in crate) struct S;
 195                     T![in] => {
 196                         p.bump(T!['(']);
 197                         p.bump(T![in]);
 198                         paths::use_path(p);
 199                         p.expect(T![')']);
 200                     }
 201                     _ => (),
 202                 }
 203             }
 204             m.complete(p, VISIBILITY);
 205             true
 206         }
 207         // test crate_keyword_vis
 208         // crate fn main() { }
 209         // struct S { crate field: u32 }
 210         // struct T(crate u32);
 211         T![crate] => {
 212             if p.nth_at(1, T![::]) {
 213                 // test crate_keyword_path
 214                 // fn foo() { crate::foo(); }
 215                 return false;
 216             }
 217             let m = p.start();
 218             p.bump(T![crate]);
 219             m.complete(p, VISIBILITY);
 220             true
 221         }
 222         _ => false,
 223     }
 224 }
 225
 226 fn opt_rename(p: &mut Parser) {
 227     if p.at(T![as]) {
 228         let m = p.start();
 229         p.bump(T![as]);
 230         if !p.eat(T![_]) {
 231             name(p);
 232         }
 233         m.complete(p, RENAME);
 234     }
 235 }
 236
 237 fn abi(p: &mut Parser) {
 238     assert!(p.at(T![extern]));
 239     let abi = p.start();
 240     p.bump(T![extern]);
 241     p.eat(STRING);
 242     abi.complete(p, ABI);
 243 }
 244
 245 fn opt_ret_type(p: &mut Parser) -> bool {
 246     if p.at(T![->]) {
 247         let m = p.start();
 248         p.bump(T![->]);
 249         types::type_no_bounds(p);
 250         m.complete(p, RET_TYPE);
 251         true
 252     } else {
 253         false
 254     }
 255 }
 256
 257 fn name_r(p: &mut Parser, recovery: TokenSet) {
 258     if p.at(IDENT) {
 259         let m = p.start();
 260         p.bump(IDENT);
 261         m.complete(p, NAME);
 262     } else {
 263         p.err_recover("expected a name", recovery);
 264     }
 265 }
 266
 267 fn name(p: &mut Parser) {
 268     name_r(p, TokenSet::EMPTY);
 269 }
 270
 271 fn name_ref(p: &mut Parser) {
 272     if p.at(IDENT) {
 273         let m = p.start();
 274         p.bump(IDENT);
 275         m.complete(p, NAME_REF);
 276     } else {
 277         p.err_and_bump("expected identifier");
 278     }
 279 }
 280
 281 fn name_ref_or_index(p: &mut Parser) {
 282     assert!(p.at(IDENT) || p.at(INT_NUMBER));
 283     let m = p.start();
 284     p.bump_any();
 285     m.complete(p, NAME_REF);
 286 }
 287
 288 fn lifetime(p: &mut Parser) {
 289     assert!(p.at(LIFETIME_IDENT));
 290     let m = p.start();
 291     p.bump(LIFETIME_IDENT);
 292     m.complete(p, LIFETIME);
 293 }
 294
 295 fn error_block(p: &mut Parser, message: &str) {
 296     assert!(p.at(T!['{']));
 297     let m = p.start();
 298     p.error(message);
 299     p.bump(T!['{']);
 300     expressions::expr_block_contents(p);
 301     p.eat(T!['}']);
 302     m.complete(p, ERROR);
 303 }