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