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_points {
  48     use super::*;
  49
  50     pub(crate) fn source_file(p: &mut Parser) {
  51         let m = p.start();
  52         p.eat(SHEBANG);
  53         items::mod_contents(p, false);
  54         m.complete(p, SOURCE_FILE);
  55     }
  56
  57     pub(crate) use expressions::block_expr;
  58
  59     pub(crate) use paths::type_path as path;
  60
  61     pub(crate) use patterns::pattern_single as pattern;
  62
  63     pub(crate) use types::type_;
  64
  65     pub(crate) fn expr(p: &mut Parser) {
  66         let _ = expressions::expr_with_attrs(p);
  67     }
  68
  69     pub(crate) fn stmt(p: &mut Parser) {
  70         expressions::stmt(p, expressions::StmtWithSemi::No, true)
  71     }
  72
  73     pub(crate) fn stmt_optional_semi(p: &mut Parser) {
  74         expressions::stmt(p, expressions::StmtWithSemi::Optional, false)
  75     }
  76
  77     pub(crate) fn visibility(p: &mut Parser) {
  78         let _ = opt_visibility(p);
  79     }
  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     pub(crate) fn item(p: &mut Parser) {
  87         items::item_or_macro(p, true)
  88     }
  89
  90     pub(crate) fn macro_items(p: &mut Parser) {
  91         let m = p.start();
  92         items::mod_contents(p, false);
  93         m.complete(p, MACRO_ITEMS);
  94     }
  95
  96     pub(crate) fn macro_stmts(p: &mut Parser) {
  97         let m = p.start();
  98
  99         while !p.at(EOF) {
 100             if p.at(T![;]) {
 101                 p.bump(T![;]);
 102                 continue;
 103             }
 104
 105             expressions::stmt(p, expressions::StmtWithSemi::Optional, true);
 106         }
 107
 108         m.complete(p, MACRO_STMTS);
 109     }
 110
 111     pub(crate) fn attr(p: &mut Parser) {
 112         attributes::outer_attrs(p)
 113     }
 114 }
 115
 116 pub(crate) fn reparser(
 117     node: SyntaxKind,
 118     first_child: Option<SyntaxKind>,
 119     parent: Option<SyntaxKind>,
 120 ) -> Option<fn(&mut Parser)> {
 121     let res = match node {
 122         BLOCK_EXPR => expressions::block_expr,
 123         RECORD_FIELD_LIST => items::record_field_list,
 124         RECORD_EXPR_FIELD_LIST => items::record_expr_field_list,
 125         VARIANT_LIST => items::variant_list,
 126         MATCH_ARM_LIST => items::match_arm_list,
 127         USE_TREE_LIST => items::use_tree_list,
 128         EXTERN_ITEM_LIST => items::extern_item_list,
 129         TOKEN_TREE if first_child? == T!['{'] => items::token_tree,
 130         ASSOC_ITEM_LIST => match parent? {
 131             IMPL => items::assoc_item_list,
 132             TRAIT => items::assoc_item_list,
 133             _ => return None,
 134         },
 135         ITEM_LIST => items::item_list,
 136         _ => return None,
 137     };
 138     Some(res)
 139 }
 140
 141 #[derive(Clone, Copy, PartialEq, Eq)]
 142 enum BlockLike {
 143     Block,
 144     NotBlock,
 145 }
 146
 147 impl BlockLike {
 148     fn is_block(self) -> bool {
 149         self == BlockLike::Block
 150     }
 151 }
 152
 153 fn opt_visibility(p: &mut Parser) -> bool {
 154     match p.current() {
 155         T![pub] => {
 156             let m = p.start();
 157             p.bump(T![pub]);
 158             if p.at(T!['(']) {
 159                 match p.nth(1) {
 160                     // test crate_visibility
 161                     // pub(crate) struct S;
 162                     // pub(self) struct S;
 163                     // pub(super) struct S;
 164
 165                     // test pub_parens_typepath
 166                     // struct B(pub (super::A));
 167                     // struct B(pub (crate::A,));
 168                     T![crate] | T![self] | T![super] | T![ident] if p.nth(2) != T![:] => {
 169                         p.bump(T!['(']);
 170                         paths::use_path(p);
 171                         p.expect(T![')']);
 172                     }
 173                     // test crate_visibility_in
 174                     // pub(in super::A) struct S;
 175                     // pub(in crate) struct S;
 176                     T![in] => {
 177                         p.bump(T!['(']);
 178                         p.bump(T![in]);
 179                         paths::use_path(p);
 180                         p.expect(T![')']);
 181                     }
 182                     _ => (),
 183                 }
 184             }
 185             m.complete(p, VISIBILITY);
 186             true
 187         }
 188         // test crate_keyword_vis
 189         // crate fn main() { }
 190         // struct S { crate field: u32 }
 191         // struct T(crate u32);
 192         T![crate] => {
 193             if p.nth_at(1, T![::]) {
 194                 // test crate_keyword_path
 195                 // fn foo() { crate::foo(); }
 196                 return false;
 197             }
 198             let m = p.start();
 199             p.bump(T![crate]);
 200             m.complete(p, VISIBILITY);
 201             true
 202         }
 203         _ => false,
 204     }
 205 }
 206
 207 fn opt_rename(p: &mut Parser) {
 208     if p.at(T![as]) {
 209         let m = p.start();
 210         p.bump(T![as]);
 211         if !p.eat(T![_]) {
 212             name(p);
 213         }
 214         m.complete(p, RENAME);
 215     }
 216 }
 217
 218 fn abi(p: &mut Parser) {
 219     assert!(p.at(T![extern]));
 220     let abi = p.start();
 221     p.bump(T![extern]);
 222     p.eat(STRING);
 223     abi.complete(p, ABI);
 224 }
 225
 226 fn opt_ret_type(p: &mut Parser) -> bool {
 227     if p.at(T![->]) {
 228         let m = p.start();
 229         p.bump(T![->]);
 230         types::type_no_bounds(p);
 231         m.complete(p, RET_TYPE);
 232         true
 233     } else {
 234         false
 235     }
 236 }
 237
 238 fn name_r(p: &mut Parser, recovery: TokenSet) {
 239     if p.at(IDENT) {
 240         let m = p.start();
 241         p.bump(IDENT);
 242         m.complete(p, NAME);
 243     } else {
 244         p.err_recover("expected a name", recovery);
 245     }
 246 }
 247
 248 fn name(p: &mut Parser) {
 249     name_r(p, TokenSet::EMPTY)
 250 }
 251
 252 fn name_ref(p: &mut Parser) {
 253     if p.at(IDENT) {
 254         let m = p.start();
 255         p.bump(IDENT);
 256         m.complete(p, NAME_REF);
 257     } else {
 258         p.err_and_bump("expected identifier");
 259     }
 260 }
 261
 262 fn name_ref_or_index(p: &mut Parser) {
 263     assert!(p.at(IDENT) || p.at(INT_NUMBER));
 264     let m = p.start();
 265     p.bump_any();
 266     m.complete(p, NAME_REF);
 267 }
 268
 269 fn lifetime(p: &mut Parser) {
 270     assert!(p.at(LIFETIME_IDENT));
 271     let m = p.start();
 272     p.bump(LIFETIME_IDENT);
 273     m.complete(p, LIFETIME);
 274 }
 275
 276 fn error_block(p: &mut Parser, message: &str) {
 277     assert!(p.at(T!['{']));
 278     let m = p.start();
 279     p.error(message);
 280     p.bump(T!['{']);
 281     expressions::expr_block_contents(p);
 282     p.eat(T!['}']);
 283     m.complete(p, ERROR);
 284 }