crates/parser/src/grammar/items.rs

   1 //! FIXME: write short doc here
   2
   3 mod consts;
   4 mod adt;
   5 mod traits;
   6 mod use_item;
   7
   8 pub(crate) use self::{
   9     adt::{record_field_list, variant_list},
  10     expressions::{match_arm_list, record_expr_field_list},
  11     traits::assoc_item_list,
  12     use_item::use_tree_list,
  13 };
  14 use super::*;
  15
  16 // test mod_contents
  17 // fn foo() {}
  18 // macro_rules! foo {}
  19 // foo::bar!();
  20 // super::baz! {}
  21 // struct S;
  22 pub(super) fn mod_contents(p: &mut Parser, stop_on_r_curly: bool) {
  23     attributes::inner_attrs(p);
  24     while !(stop_on_r_curly && p.at(T!['}']) || p.at(EOF)) {
  25         item_or_macro(p, stop_on_r_curly)
  26     }
  27 }
  28
  29 pub(super) const ITEM_RECOVERY_SET: TokenSet = TokenSet::new(&[
  30     FN_KW,
  31     STRUCT_KW,
  32     ENUM_KW,
  33     IMPL_KW,
  34     TRAIT_KW,
  35     CONST_KW,
  36     STATIC_KW,
  37     LET_KW,
  38     MOD_KW,
  39     PUB_KW,
  40     CRATE_KW,
  41     USE_KW,
  42     MACRO_KW,
  43     T![;],
  44 ]);
  45
  46 pub(super) fn item_or_macro(p: &mut Parser, stop_on_r_curly: bool) {
  47     let m = p.start();
  48     attributes::outer_attrs(p);
  49     let m = match maybe_item(p, m) {
  50         Ok(()) => {
  51             if p.at(T![;]) {
  52                 p.err_and_bump(
  53                     "expected item, found `;`\n\
  54                      consider removing this semicolon",
  55                 );
  56             }
  57             return;
  58         }
  59         Err(m) => m,
  60     };
  61     if paths::is_use_path_start(p) {
  62         match macro_call(p) {
  63             BlockLike::Block => (),
  64             BlockLike::NotBlock => {
  65                 p.expect(T![;]);
  66             }
  67         }
  68         m.complete(p, MACRO_CALL);
  69     } else {
  70         m.abandon(p);
  71         if p.at(T!['{']) {
  72             error_block(p, "expected an item");
  73         } else if p.at(T!['}']) && !stop_on_r_curly {
  74             let e = p.start();
  75             p.error("unmatched `}`");
  76             p.bump(T!['}']);
  77             e.complete(p, ERROR);
  78         } else if !p.at(EOF) && !p.at(T!['}']) {
  79             p.err_and_bump("expected an item");
  80         } else {
  81             p.error("expected an item");
  82         }
  83     }
  84 }
  85
  86 pub(super) fn maybe_item(p: &mut Parser, m: Marker) -> Result<(), Marker> {
  87     // test_err pub_expr
  88     // fn foo() { pub 92; }
  89     let has_visibility = opt_visibility(p);
  90
  91     let m = match items_without_modifiers(p, m) {
  92         Ok(()) => return Ok(()),
  93         Err(m) => m,
  94     };
  95
  96     let mut has_mods = false;
  97
  98     // modifiers
  99     has_mods |= p.eat(T![const]);
 100
 101     // test_err async_without_semicolon
 102     // fn foo() { let _ = async {} }
 103     if p.at(T![async]) && p.nth(1) != T!['{'] && p.nth(1) != T![move] && p.nth(1) != T![|] {
 104         p.eat(T![async]);
 105         has_mods = true;
 106     }
 107
 108     // test_err unsafe_block_in_mod
 109     // fn foo(){} unsafe { } fn bar(){}
 110     if p.at(T![unsafe]) && p.nth(1) != T!['{'] {
 111         p.eat(T![unsafe]);
 112         has_mods = true;
 113     }
 114
 115     if p.at(T![extern]) {
 116         has_mods = true;
 117         abi(p);
 118     }
 119     if p.at(IDENT) && p.at_contextual_kw("auto") && p.nth(1) == T![trait] {
 120         p.bump_remap(T![auto]);
 121         has_mods = true;
 122     }
 123
 124     // test default_item
 125     // default impl T for Foo {}
 126     if p.at(IDENT) && p.at_contextual_kw("default") {
 127         match p.nth(1) {
 128             T![fn] | T![type] | T![const] | T![impl] => {
 129                 p.bump_remap(T![default]);
 130                 has_mods = true;
 131             }
 132             T![unsafe] => {
 133                 // test default_unsafe_item
 134                 // default unsafe impl T for Foo {
 135                 //     default unsafe fn foo() {}
 136                 // }
 137                 if matches!(p.nth(2), T![impl] | T![fn]) {
 138                     p.bump_remap(T![default]);
 139                     p.bump(T![unsafe]);
 140                     has_mods = true;
 141                 }
 142             }
 143             _ => (),
 144         }
 145     }
 146
 147     // test existential_type
 148     // existential type Foo: Fn() -> usize;
 149     if p.at(IDENT) && p.at_contextual_kw("existential") && p.nth(1) == T![type] {
 150         p.bump_remap(T![existential]);
 151         has_mods = true;
 152     }
 153
 154     // items
 155     match p.current() {
 156         // test fn
 157         // fn foo() {}
 158         T![fn] => {
 159             fn_(p);
 160             m.complete(p, FN);
 161         }
 162
 163         // test trait
 164         // trait T {}
 165         T![trait] => {
 166             traits::trait_(p);
 167             m.complete(p, TRAIT);
 168         }
 169
 170         T![const] => {
 171             consts::konst(p, m);
 172         }
 173
 174         // test impl
 175         // impl T for S {}
 176         T![impl] => {
 177             traits::impl_(p);
 178             m.complete(p, IMPL);
 179         }
 180
 181         T![type] => {
 182             type_alias(p, m);
 183         }
 184         _ => {
 185             if !has_visibility && !has_mods {
 186                 return Err(m);
 187             } else {
 188                 if has_mods {
 189                     p.error("expected existential, fn, trait or impl");
 190                 } else {
 191                     p.error("expected an item");
 192                 }
 193                 m.complete(p, ERROR);
 194             }
 195         }
 196     }
 197     Ok(())
 198 }
 199
 200 fn items_without_modifiers(p: &mut Parser, m: Marker) -> Result<(), Marker> {
 201     let la = p.nth(1);
 202     match p.current() {
 203         // test extern_crate
 204         // extern crate foo;
 205         T![extern] if la == T![crate] => extern_crate(p, m),
 206         T![type] => {
 207             type_alias(p, m);
 208         }
 209         T![mod] => mod_item(p, m),
 210         T![struct] => {
 211             // test struct_items
 212             // struct Foo;
 213             // struct Foo {}
 214             // struct Foo();
 215             // struct Foo(String, usize);
 216             // struct Foo {
 217             //     a: i32,
 218             //     b: f32,
 219             // }
 220             adt::strukt(p, m);
 221         }
 222         // test pub_macro_def
 223         // pub macro m($:ident) {}
 224         T![macro] => {
 225             macro_def(p, m);
 226         }
 227         IDENT if p.at_contextual_kw("union") && p.nth(1) == IDENT => {
 228             // test union_items
 229             // union Foo {}
 230             // union Foo {
 231             //     a: i32,
 232             //     b: f32,
 233             // }
 234             adt::union(p, m);
 235         }
 236         T![enum] => adt::enum_(p, m),
 237         T![use] => use_item::use_(p, m),
 238         T![const] if (la == IDENT || la == T![_] || la == T![mut]) => consts::konst(p, m),
 239         T![static] => consts::static_(p, m),
 240         // test extern_block
 241         // extern {}
 242         T![extern] if la == T!['{'] || (la == STRING && p.nth(2) == T!['{']) => {
 243             abi(p);
 244             extern_item_list(p);
 245             m.complete(p, EXTERN_BLOCK);
 246         }
 247         _ => return Err(m),
 248     };
 249     Ok(())
 250 }
 251
 252 fn extern_crate(p: &mut Parser, m: Marker) {
 253     assert!(p.at(T![extern]));
 254     p.bump(T![extern]);
 255     assert!(p.at(T![crate]));
 256     p.bump(T![crate]);
 257
 258     if p.at(T![self]) {
 259         p.bump(T![self]);
 260     } else {
 261         name_ref(p);
 262     }
 263
 264     opt_rename(p);
 265     p.expect(T![;]);
 266     m.complete(p, EXTERN_CRATE);
 267 }
 268
 269 pub(crate) fn extern_item_list(p: &mut Parser) {
 270     assert!(p.at(T!['{']));
 271     let m = p.start();
 272     p.bump(T!['{']);
 273     mod_contents(p, true);
 274     p.expect(T!['}']);
 275     m.complete(p, EXTERN_ITEM_LIST);
 276 }
 277
 278 fn fn_(p: &mut Parser) {
 279     assert!(p.at(T![fn]));
 280     p.bump(T![fn]);
 281
 282     name_r(p, ITEM_RECOVERY_SET);
 283     // test function_type_params
 284     // fn foo<T: Clone + Copy>(){}
 285     type_params::opt_generic_param_list(p);
 286
 287     if p.at(T!['(']) {
 288         params::param_list_fn_def(p);
 289     } else {
 290         p.error("expected function arguments");
 291     }
 292     // test function_ret_type
 293     // fn foo() {}
 294     // fn bar() -> () {}
 295     opt_ret_type(p);
 296
 297     // test function_where_clause
 298     // fn foo<T>() where T: Copy {}
 299     type_params::opt_where_clause(p);
 300
 301     // test fn_decl
 302     // trait T { fn foo(); }
 303     if p.at(T![;]) {
 304         p.bump(T![;]);
 305     } else {
 306         expressions::block_expr(p)
 307     }
 308 }
 309
 310 // test type_item
 311 // type Foo = Bar;
 312 fn type_alias(p: &mut Parser, m: Marker) {
 313     assert!(p.at(T![type]));
 314     p.bump(T![type]);
 315
 316     name(p);
 317
 318     // test type_item_type_params
 319     // type Result<T> = ();
 320     type_params::opt_generic_param_list(p);
 321
 322     if p.at(T![:]) {
 323         type_params::bounds(p);
 324     }
 325
 326     // test type_item_where_clause
 327     // type Foo where Foo: Copy = ();
 328     type_params::opt_where_clause(p);
 329     if p.eat(T![=]) {
 330         types::type_(p);
 331     }
 332     p.expect(T![;]);
 333     m.complete(p, TYPE_ALIAS);
 334 }
 335
 336 pub(crate) fn mod_item(p: &mut Parser, m: Marker) {
 337     assert!(p.at(T![mod]));
 338     p.bump(T![mod]);
 339
 340     name(p);
 341     if p.at(T!['{']) {
 342         item_list(p);
 343     } else if !p.eat(T![;]) {
 344         p.error("expected `;` or `{`");
 345     }
 346     m.complete(p, MODULE);
 347 }
 348
 349 pub(crate) fn item_list(p: &mut Parser) {
 350     assert!(p.at(T!['{']));
 351     let m = p.start();
 352     p.bump(T!['{']);
 353     mod_contents(p, true);
 354     p.expect(T!['}']);
 355     m.complete(p, ITEM_LIST);
 356 }
 357
 358 // test macro_def
 359 // macro m { ($i:ident) => {} }
 360 // macro m($i:ident) {}
 361 fn macro_def(p: &mut Parser, m: Marker) {
 362     p.expect(T![macro]);
 363     name_r(p, ITEM_RECOVERY_SET);
 364     if p.at(T!['{']) {
 365         token_tree(p);
 366     } else if !p.at(T!['(']) {
 367         p.error("unmatched `(`");
 368     } else {
 369         let m = p.start();
 370         token_tree(p);
 371         match p.current() {
 372             T!['{'] | T!['['] | T!['('] => token_tree(p),
 373             _ => p.error("expected `{`, `[`, `(`"),
 374         }
 375         m.complete(p, TOKEN_TREE);
 376     }
 377
 378     m.complete(p, MACRO_DEF);
 379 }
 380
 381 fn macro_call(p: &mut Parser) -> BlockLike {
 382     assert!(paths::is_use_path_start(p));
 383     paths::use_path(p);
 384     macro_call_after_excl(p)
 385 }
 386
 387 pub(super) fn macro_call_after_excl(p: &mut Parser) -> BlockLike {
 388     p.expect(T![!]);
 389     if p.at(IDENT) {
 390         name(p);
 391     }
 392     // Special-case `macro_rules! try`.
 393     // This is a hack until we do proper edition support
 394
 395     // test try_macro_rules
 396     // macro_rules! try { () => {} }
 397     if p.at(T![try]) {
 398         let m = p.start();
 399         p.bump_remap(IDENT);
 400         m.complete(p, NAME);
 401     }
 402
 403     match p.current() {
 404         T!['{'] => {
 405             token_tree(p);
 406             BlockLike::Block
 407         }
 408         T!['('] | T!['['] => {
 409             token_tree(p);
 410             BlockLike::NotBlock
 411         }
 412         _ => {
 413             p.error("expected `{`, `[`, `(`");
 414             BlockLike::NotBlock
 415         }
 416     }
 417 }
 418
 419 pub(crate) fn token_tree(p: &mut Parser) {
 420     let closing_paren_kind = match p.current() {
 421         T!['{'] => T!['}'],
 422         T!['('] => T![')'],
 423         T!['['] => T![']'],
 424         _ => unreachable!(),
 425     };
 426     let m = p.start();
 427     p.bump_any();
 428     while !p.at(EOF) && !p.at(closing_paren_kind) {
 429         match p.current() {
 430             T!['{'] | T!['('] | T!['['] => token_tree(p),
 431             T!['}'] => {
 432                 p.error("unmatched `}`");
 433                 m.complete(p, TOKEN_TREE);
 434                 return;
 435             }
 436             T![')'] | T![']'] => p.err_and_bump("unmatched brace"),
 437             _ => p.bump_any(),
 438         }
 439     }
 440     p.expect(closing_paren_kind);
 441     m.complete(p, TOKEN_TREE);
 442 }