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 }
 114
 115 pub(crate) fn reparser(
 116     node: SyntaxKind,
 117     first_child: Option<SyntaxKind>,
 118     parent: Option<SyntaxKind>,
 119 ) -> Option<fn(&mut Parser)> {
 120     let res = match node {
 121         BLOCK_EXPR => expressions::block_expr,
 122         RECORD_FIELD_LIST => items::record_field_list,
 123         RECORD_EXPR_FIELD_LIST => items::record_expr_field_list,
 124         VARIANT_LIST => items::variant_list,
 125         MATCH_ARM_LIST => items::match_arm_list,
 126         USE_TREE_LIST => items::use_tree_list,
 127         EXTERN_ITEM_LIST => items::extern_item_list,
 128         TOKEN_TREE if first_child? == T!['{'] => items::token_tree,
 129         ASSOC_ITEM_LIST => match parent? {
 130             IMPL | TRAIT => items::assoc_item_list,
 131             _ => return None,
 132         },
 133         ITEM_LIST => items::item_list,
 134         _ => return None,
 135     };
 136     Some(res)
 137 }
 138
 139 #[derive(Clone, Copy, PartialEq, Eq)]
 140 enum BlockLike {
 141     Block,
 142     NotBlock,
 143 }
 144
 145 impl BlockLike {
 146     fn is_block(self) -> bool {
 147         self == BlockLike::Block
 148     }
 149 }
 150
 151 fn opt_visibility(p: &mut Parser, in_tuple_field: bool) -> bool {
 152     match p.current() {
 153         T![pub] => {
 154             let m = p.start();
 155             p.bump(T![pub]);
 156             if p.at(T!['(']) {
 157                 match p.nth(1) {
 158                     // test crate_visibility
 159                     // pub(crate) struct S;
 160                     // pub(self) struct S;
 161                     // pub(super) struct S;
 162
 163                     // test pub_parens_typepath
 164                     // struct B(pub (super::A));
 165                     // struct B(pub (crate::A,));
 166                     T![crate] | T![self] | T![super] | T![ident] if p.nth(2) != T![:] => {
 167                         // If we are in a tuple struct, then the parens following `pub`
 168                         // might be an tuple field, not part of the visibility. So in that
 169                         // case we don't want to consume an identifier.
 170
 171                         // test pub_tuple_field
 172                         // struct MyStruct(pub (u32, u32));
 173                         if !(in_tuple_field && matches!(p.nth(1), T![ident])) {
 174                             p.bump(T!['(']);
 175                             paths::use_path(p);
 176                             p.expect(T![')']);
 177                         }
 178                     }
 179                     // test crate_visibility_in
 180                     // pub(in super::A) struct S;
 181                     // pub(in crate) struct S;
 182                     T![in] => {
 183                         p.bump(T!['(']);
 184                         p.bump(T![in]);
 185                         paths::use_path(p);
 186                         p.expect(T![')']);
 187                     }
 188                     _ => (),
 189                 }
 190             }
 191             m.complete(p, VISIBILITY);
 192             true
 193         }
 194         // test crate_keyword_vis
 195         // crate fn main() { }
 196         // struct S { crate field: u32 }
 197         // struct T(crate u32);
 198         T![crate] => {
 199             if p.nth_at(1, T![::]) {
 200                 // test crate_keyword_path
 201                 // fn foo() { crate::foo(); }
 202                 return false;
 203             }
 204             let m = p.start();
 205             p.bump(T![crate]);
 206             m.complete(p, VISIBILITY);
 207             true
 208         }
 209         _ => false,
 210     }
 211 }
 212
 213 fn opt_rename(p: &mut Parser) {
 214     if p.at(T![as]) {
 215         let m = p.start();
 216         p.bump(T![as]);
 217         if !p.eat(T![_]) {
 218             name(p);
 219         }
 220         m.complete(p, RENAME);
 221     }
 222 }
 223
 224 fn abi(p: &mut Parser) {
 225     assert!(p.at(T![extern]));
 226     let abi = p.start();
 227     p.bump(T![extern]);
 228     p.eat(STRING);
 229     abi.complete(p, ABI);
 230 }
 231
 232 fn opt_ret_type(p: &mut Parser) -> bool {
 233     if p.at(T![->]) {
 234         let m = p.start();
 235         p.bump(T![->]);
 236         types::type_no_bounds(p);
 237         m.complete(p, RET_TYPE);
 238         true
 239     } else {
 240         false
 241     }
 242 }
 243
 244 fn name_r(p: &mut Parser, recovery: TokenSet) {
 245     if p.at(IDENT) {
 246         let m = p.start();
 247         p.bump(IDENT);
 248         m.complete(p, NAME);
 249     } else {
 250         p.err_recover("expected a name", recovery);
 251     }
 252 }
 253
 254 fn name(p: &mut Parser) {
 255     name_r(p, TokenSet::EMPTY);
 256 }
 257
 258 fn name_ref(p: &mut Parser) {
 259     if p.at(IDENT) {
 260         let m = p.start();
 261         p.bump(IDENT);
 262         m.complete(p, NAME_REF);
 263     } else {
 264         p.err_and_bump("expected identifier");
 265     }
 266 }
 267
 268 fn name_ref_or_index(p: &mut Parser) {
 269     assert!(p.at(IDENT) || p.at(INT_NUMBER));
 270     let m = p.start();
 271     p.bump_any();
 272     m.complete(p, NAME_REF);
 273 }
 274
 275 fn lifetime(p: &mut Parser) {
 276     assert!(p.at(LIFETIME_IDENT));
 277     let m = p.start();
 278     p.bump(LIFETIME_IDENT);
 279     m.complete(p, LIFETIME);
 280 }
 281
 282 fn error_block(p: &mut Parser, message: &str) {
 283     assert!(p.at(T!['{']));
 284     let m = p.start();
 285     p.error(message);
 286     p.bump(T!['{']);
 287     expressions::expr_block_contents(p);
 288     p.eat(T!['}']);
 289     m.complete(p, ERROR);
 290 }