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     T![fn],
  31     T![struct],
  32     T![enum],
  33     T![impl],
  34     T![trait],
  35     T![const],
  36     T![static],
  37     T![let],
  38     T![mod],
  39     T![pub],
  40     T![crate],
  41     T![use],
  42     T![macro],
  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     if p.at(T![const]) && p.nth(1) != T!['{'] {
 100         p.eat(T![const]);
 101         has_mods = true;
 102     }
 103
 104     // test_err async_without_semicolon
 105     // fn foo() { let _ = async {} }
 106     if p.at(T![async]) && p.nth(1) != T!['{'] && p.nth(1) != T![move] && p.nth(1) != T![|] {
 107         p.eat(T![async]);
 108         has_mods = true;
 109     }
 110
 111     // test_err unsafe_block_in_mod
 112     // fn foo(){} unsafe { } fn bar(){}
 113     if p.at(T![unsafe]) && p.nth(1) != T!['{'] {
 114         p.eat(T![unsafe]);
 115         has_mods = true;
 116     }
 117
 118     if p.at(T![extern]) && p.nth(1) != T!['{'] && (p.nth(1) != STRING || p.nth(2) != T!['{']) {
 119         has_mods = true;
 120         abi(p);
 121     }
 122     if p.at(IDENT) && p.at_contextual_kw("auto") && p.nth(1) == T![trait] {
 123         p.bump_remap(T![auto]);
 124         has_mods = true;
 125     }
 126
 127     // test default_item
 128     // default impl T for Foo {}
 129     if p.at(IDENT) && p.at_contextual_kw("default") {
 130         match p.nth(1) {
 131             T![fn] | T![type] | T![const] | T![impl] => {
 132                 p.bump_remap(T![default]);
 133                 has_mods = true;
 134             }
 135             T![unsafe] => {
 136                 // test default_unsafe_item
 137                 // default unsafe impl T for Foo {
 138                 //     default unsafe fn foo() {}
 139                 // }
 140                 if matches!(p.nth(2), T![impl] | T![fn]) {
 141                     p.bump_remap(T![default]);
 142                     p.bump(T![unsafe]);
 143                     has_mods = true;
 144                 }
 145             }
 146             _ => (),
 147         }
 148     }
 149
 150     // test existential_type
 151     // existential type Foo: Fn() -> usize;
 152     if p.at(IDENT) && p.at_contextual_kw("existential") && p.nth(1) == T![type] {
 153         p.bump_remap(T![existential]);
 154         has_mods = true;
 155     }
 156
 157     // items
 158     match p.current() {
 159         // test fn
 160         // fn foo() {}
 161         T![fn] => {
 162             fn_(p);
 163             m.complete(p, FN);
 164         }
 165
 166         // test trait
 167         // trait T {}
 168         T![trait] => {
 169             traits::trait_(p);
 170             m.complete(p, TRAIT);
 171         }
 172
 173         T![const] if p.nth(1) != T!['{'] => {
 174             consts::konst(p, m);
 175         }
 176
 177         // test impl
 178         // impl T for S {}
 179         T![impl] => {
 180             traits::impl_(p);
 181             m.complete(p, IMPL);
 182         }
 183
 184         T![type] => {
 185             type_alias(p, m);
 186         }
 187
 188         // unsafe extern "C" {}
 189         T![extern] => {
 190             abi(p);
 191             extern_item_list(p);
 192             m.complete(p, EXTERN_BLOCK);
 193         }
 194
 195         _ => {
 196             if !has_visibility && !has_mods {
 197                 return Err(m);
 198             } else {
 199                 if has_mods {
 200                     p.error("expected existential, fn, trait or impl");
 201                 } else {
 202                     p.error("expected an item");
 203                 }
 204                 m.complete(p, ERROR);
 205             }
 206         }
 207     }
 208     Ok(())
 209 }
 210
 211 fn items_without_modifiers(p: &mut Parser, m: Marker) -> Result<(), Marker> {
 212     let la = p.nth(1);
 213     match p.current() {
 214         // test extern_crate
 215         // extern crate foo;
 216         T![extern] if la == T![crate] => extern_crate(p, m),
 217         T![type] => {
 218             type_alias(p, m);
 219         }
 220         T![mod] => mod_item(p, m),
 221         T![struct] => {
 222             // test struct_items
 223             // struct Foo;
 224             // struct Foo {}
 225             // struct Foo();
 226             // struct Foo(String, usize);
 227             // struct Foo {
 228             //     a: i32,
 229             //     b: f32,
 230             // }
 231             adt::strukt(p, m);
 232         }
 233         // test pub_macro_def
 234         // pub macro m($:ident) {}
 235         T![macro] => {
 236             macro_def(p, m);
 237         }
 238         IDENT if p.at_contextual_kw("macro_rules") && p.nth(1) == BANG => {
 239             macro_rules(p, m);
 240         }
 241         IDENT if p.at_contextual_kw("union") && p.nth(1) == IDENT => {
 242             // test union_items
 243             // union Foo {}
 244             // union Foo {
 245             //     a: i32,
 246             //     b: f32,
 247             // }
 248             adt::union(p, m);
 249         }
 250         T![enum] => adt::enum_(p, m),
 251         T![use] => use_item::use_(p, m),
 252         T![const] if (la == IDENT || la == T![_] || la == T![mut]) => consts::konst(p, m),
 253         T![static] => consts::static_(p, m),
 254         // test extern_block
 255         // extern {}
 256         T![extern] if la == T!['{'] || (la == STRING && p.nth(2) == T!['{']) => {
 257             abi(p);
 258             extern_item_list(p);
 259             m.complete(p, EXTERN_BLOCK);
 260         }
 261         _ => return Err(m),
 262     };
 263     Ok(())
 264 }
 265
 266 fn extern_crate(p: &mut Parser, m: Marker) {
 267     assert!(p.at(T![extern]));
 268     p.bump(T![extern]);
 269     assert!(p.at(T![crate]));
 270     p.bump(T![crate]);
 271
 272     if p.at(T![self]) {
 273         p.bump(T![self]);
 274     } else {
 275         name_ref(p);
 276     }
 277
 278     opt_rename(p);
 279     p.expect(T![;]);
 280     m.complete(p, EXTERN_CRATE);
 281 }
 282
 283 pub(crate) fn extern_item_list(p: &mut Parser) {
 284     assert!(p.at(T!['{']));
 285     let m = p.start();
 286     p.bump(T!['{']);
 287     mod_contents(p, true);
 288     p.expect(T!['}']);
 289     m.complete(p, EXTERN_ITEM_LIST);
 290 }
 291
 292 fn fn_(p: &mut Parser) {
 293     assert!(p.at(T![fn]));
 294     p.bump(T![fn]);
 295
 296     name_r(p, ITEM_RECOVERY_SET);
 297     // test function_type_params
 298     // fn foo<T: Clone + Copy>(){}
 299     type_params::opt_generic_param_list(p);
 300
 301     if p.at(T!['(']) {
 302         params::param_list_fn_def(p);
 303     } else {
 304         p.error("expected function arguments");
 305     }
 306     // test function_ret_type
 307     // fn foo() {}
 308     // fn bar() -> () {}
 309     opt_ret_type(p);
 310
 311     // test function_where_clause
 312     // fn foo<T>() where T: Copy {}
 313     type_params::opt_where_clause(p);
 314
 315     // test fn_decl
 316     // trait T { fn foo(); }
 317     if p.at(T![;]) {
 318         p.bump(T![;]);
 319     } else {
 320         expressions::block_expr(p)
 321     }
 322 }
 323
 324 // test type_item
 325 // type Foo = Bar;
 326 fn type_alias(p: &mut Parser, m: Marker) {
 327     assert!(p.at(T![type]));
 328     p.bump(T![type]);
 329
 330     name(p);
 331
 332     // test type_item_type_params
 333     // type Result<T> = ();
 334     type_params::opt_generic_param_list(p);
 335
 336     if p.at(T![:]) {
 337         type_params::bounds(p);
 338     }
 339
 340     // test type_item_where_clause
 341     // type Foo where Foo: Copy = ();
 342     type_params::opt_where_clause(p);
 343     if p.eat(T![=]) {
 344         types::type_(p);
 345     }
 346     p.expect(T![;]);
 347     m.complete(p, TYPE_ALIAS);
 348 }
 349
 350 pub(crate) fn mod_item(p: &mut Parser, m: Marker) {
 351     assert!(p.at(T![mod]));
 352     p.bump(T![mod]);
 353
 354     name(p);
 355     if p.at(T!['{']) {
 356         item_list(p);
 357     } else if !p.eat(T![;]) {
 358         p.error("expected `;` or `{`");
 359     }
 360     m.complete(p, MODULE);
 361 }
 362
 363 pub(crate) fn item_list(p: &mut Parser) {
 364     assert!(p.at(T!['{']));
 365     let m = p.start();
 366     p.bump(T!['{']);
 367     mod_contents(p, true);
 368     p.expect(T!['}']);
 369     m.complete(p, ITEM_LIST);
 370 }
 371
 372 fn macro_rules(p: &mut Parser, m: Marker) {
 373     assert!(p.at_contextual_kw("macro_rules"));
 374     p.bump_remap(T![macro_rules]);
 375     p.expect(T![!]);
 376
 377     if p.at(IDENT) {
 378         name(p);
 379     }
 380     // Special-case `macro_rules! try`.
 381     // This is a hack until we do proper edition support
 382
 383     // test try_macro_rules
 384     // macro_rules! try { () => {} }
 385     if p.at(T![try]) {
 386         let m = p.start();
 387         p.bump_remap(IDENT);
 388         m.complete(p, NAME);
 389     }
 390
 391     match p.current() {
 392         // test macro_rules_non_brace
 393         // macro_rules! m ( ($i:ident) => {} );
 394         // macro_rules! m [ ($i:ident) => {} ];
 395         T!['['] | T!['('] => {
 396             token_tree(p);
 397             p.expect(T![;]);
 398         }
 399         T!['{'] => token_tree(p),
 400         _ => p.error("expected `{`, `[`, `(`"),
 401     }
 402     m.complete(p, MACRO_RULES);
 403 }
 404
 405 // test macro_def
 406 // macro m { ($i:ident) => {} }
 407 // macro m($i:ident) {}
 408 fn macro_def(p: &mut Parser, m: Marker) {
 409     p.expect(T![macro]);
 410     name_r(p, ITEM_RECOVERY_SET);
 411     if p.at(T!['{']) {
 412         token_tree(p);
 413     } else if !p.at(T!['(']) {
 414         p.error("unmatched `(`");
 415     } else {
 416         let m = p.start();
 417         token_tree(p);
 418         match p.current() {
 419             T!['{'] | T!['['] | T!['('] => token_tree(p),
 420             _ => p.error("expected `{`, `[`, `(`"),
 421         }
 422         m.complete(p, TOKEN_TREE);
 423     }
 424
 425     m.complete(p, MACRO_DEF);
 426 }
 427
 428 fn macro_call(p: &mut Parser) -> BlockLike {
 429     assert!(paths::is_use_path_start(p));
 430     paths::use_path(p);
 431     macro_call_after_excl(p)
 432 }
 433
 434 pub(super) fn macro_call_after_excl(p: &mut Parser) -> BlockLike {
 435     p.expect(T![!]);
 436
 437     match p.current() {
 438         T!['{'] => {
 439             token_tree(p);
 440             BlockLike::Block
 441         }
 442         T!['('] | T!['['] => {
 443             token_tree(p);
 444             BlockLike::NotBlock
 445         }
 446         _ => {
 447             p.error("expected `{`, `[`, `(`");
 448             BlockLike::NotBlock
 449         }
 450     }
 451 }
 452
 453 pub(crate) fn token_tree(p: &mut Parser) {
 454     let closing_paren_kind = match p.current() {
 455         T!['{'] => T!['}'],
 456         T!['('] => T![')'],
 457         T!['['] => T![']'],
 458         _ => unreachable!(),
 459     };
 460     let m = p.start();
 461     p.bump_any();
 462     while !p.at(EOF) && !p.at(closing_paren_kind) {
 463         match p.current() {
 464             T!['{'] | T!['('] | T!['['] => token_tree(p),
 465             T!['}'] => {
 466                 p.error("unmatched `}`");
 467                 m.complete(p, TOKEN_TREE);
 468                 return;
 469             }
 470             T![')'] | T![']'] => p.err_and_bump("unmatched brace"),
 471             _ => p.bump_any(),
 472         }
 473     }
 474     p.expect(closing_paren_kind);
 475     m.complete(p, TOKEN_TREE);
 476 }