src/libsyntax_expand/mbe/macro_check.rs

   1 //! Checks that meta-variables in macro definition are correctly declared and used.
   2 //!
   3 //! # What is checked
   4 //!
   5 //! ## Meta-variables must not be bound twice
   6 //!
   7 //! ```
   8 //! macro_rules! foo { ($x:tt $x:tt) => { $x }; }
   9 //! ```
  10 //!
  11 //! This check is sound (no false-negative) and complete (no false-positive).
  12 //!
  13 //! ## Meta-variables must not be free
  14 //!
  15 //! ```
  16 //! macro_rules! foo { () => { $x }; }
  17 //! ```
  18 //!
  19 //! This check is also done at macro instantiation but only if the branch is taken.
  20 //!
  21 //! ## Meta-variables must repeat at least as many times as their binder
  22 //!
  23 //! ```
  24 //! macro_rules! foo { ($($x:tt)*) => { $x }; }
  25 //! ```
  26 //!
  27 //! This check is also done at macro instantiation but only if the branch is taken.
  28 //!
  29 //! ## Meta-variables must repeat with the same Kleene operators as their binder
  30 //!
  31 //! ```
  32 //! macro_rules! foo { ($($x:tt)+) => { $($x)* }; }
  33 //! ```
  34 //!
  35 //! This check is not done at macro instantiation.
  36 //!
  37 //! # Disclaimer
  38 //!
  39 //! In the presence of nested macros (a macro defined in a macro), those checks may have false
  40 //! positives and false negatives. We try to detect those cases by recognizing potential macro
  41 //! definitions in RHSes, but nested macros may be hidden through the use of particular values of
  42 //! meta-variables.
  43 //!
  44 //! ## Examples of false positive
  45 //!
  46 //! False positives can come from cases where we don't recognize a nested macro, because it depends
  47 //! on particular values of meta-variables. In the following example, we think both instances of
  48 //! `$x` are free, which is a correct statement if `$name` is anything but `macro_rules`. But when
  49 //! `$name` is `macro_rules`, like in the instantiation below, then `$x:tt` is actually a binder of
  50 //! the nested macro and `$x` is bound to it.
  51 //!
  52 //! ```
  53 //! macro_rules! foo { ($name:ident) => { $name! bar { ($x:tt) => { $x }; } }; }
  54 //! foo!(macro_rules);
  55 //! ```
  56 //!
  57 //! False positives can also come from cases where we think there is a nested macro while there
  58 //! isn't. In the following example, we think `$x` is free, which is incorrect because `bar` is not
  59 //! a nested macro since it is not evaluated as code by `stringify!`.
  60 //!
  61 //! ```
  62 //! macro_rules! foo { () => { stringify!(macro_rules! bar { () => { $x }; }) }; }
  63 //! ```
  64 //!
  65 //! ## Examples of false negative
  66 //!
  67 //! False negatives can come from cases where we don't recognize a meta-variable, because it depends
  68 //! on particular values of meta-variables. In the following examples, we don't see that if `$d` is
  69 //! instantiated with `$` then `$d z` becomes `$z` in the nested macro definition and is thus a free
  70 //! meta-variable. Note however, that if `foo` is instantiated, then we would check the definition
  71 //! of `bar` and would see the issue.
  72 //!
  73 //! ```
  74 //! macro_rules! foo { ($d:tt) => { macro_rules! bar { ($y:tt) => { $d z }; } }; }
  75 //! ```
  76 //!
  77 //! # How it is checked
  78 //!
  79 //! There are 3 main functions: `check_binders`, `check_occurrences`, and `check_nested_macro`. They
  80 //! all need some kind of environment.
  81 //!
  82 //! ## Environments
  83 //!
  84 //! Environments are used to pass information.
  85 //!
  86 //! ### From LHS to RHS
  87 //!
  88 //! When checking a LHS with `check_binders`, we produce (and use) an environment for binders,
  89 //! namely `Binders`. This is a mapping from binder name to information about that binder: the span
  90 //! of the binder for error messages and the stack of Kleene operators under which it was bound in
  91 //! the LHS.
  92 //!
  93 //! This environment is used by both the LHS and RHS. The LHS uses it to detect duplicate binders.
  94 //! The RHS uses it to detect the other errors.
  95 //!
  96 //! ### From outer macro to inner macro
  97 //!
  98 //! When checking the RHS of an outer macro and we detect a nested macro definition, we push the
  99 //! current state, namely `MacroState`, to an environment of nested macro definitions. Each state
 100 //! stores the LHS binders when entering the macro definition as well as the stack of Kleene
 101 //! operators under which the inner macro is defined in the RHS.
 102 //!
 103 //! This environment is a stack representing the nesting of macro definitions. As such, the stack of
 104 //! Kleene operators under which a meta-variable is repeating is the concatenation of the stacks
 105 //! stored when entering a macro definition starting from the state in which the meta-variable is
 106 //! bound.
 107 use crate::mbe::{KleeneToken, TokenTree};
 108
 109 use syntax::ast::NodeId;
 110 use syntax::early_buffered_lints::BufferedEarlyLintId;
 111 use syntax::token::{DelimToken, Token, TokenKind};
 112 use syntax::sess::ParseSess;
 113 use syntax::symbol::{kw, sym};
 114
 115 use rustc_data_structures::fx::FxHashMap;
 116 use smallvec::SmallVec;
 117 use syntax_pos::{symbol::Ident, MultiSpan, Span};
 118
 119 /// Stack represented as linked list.
 120 ///
 121 /// Those are used for environments because they grow incrementally and are not mutable.
 122 enum Stack<'a, T> {
 123     /// Empty stack.
 124     Empty,
 125     /// A non-empty stack.
 126     Push {
 127         /// The top element.
 128         top: T,
 129         /// The previous elements.
 130         prev: &'a Stack<'a, T>,
 131     },
 132 }
 133
 134 impl<'a, T> Stack<'a, T> {
 135     /// Returns whether a stack is empty.
 136     fn is_empty(&self) -> bool {
 137         match *self {
 138             Stack::Empty => true,
 139             _ => false,
 140         }
 141     }
 142
 143     /// Returns a new stack with an element of top.
 144     fn push(&'a self, top: T) -> Stack<'a, T> {
 145         Stack::Push { top, prev: self }
 146     }
 147 }
 148
 149 impl<'a, T> Iterator for &'a Stack<'a, T> {
 150     type Item = &'a T;
 151
 152     // Iterates from top to bottom of the stack.
 153     fn next(&mut self) -> Option<&'a T> {
 154         match *self {
 155             Stack::Empty => None,
 156             Stack::Push { ref top, ref prev } => {
 157                 *self = prev;
 158                 Some(top)
 159             }
 160         }
 161     }
 162 }
 163
 164 impl From<&Stack<'_, KleeneToken>> for SmallVec<[KleeneToken; 1]> {
 165     fn from(ops: &Stack<'_, KleeneToken>) -> SmallVec<[KleeneToken; 1]> {
 166         let mut ops: SmallVec<[KleeneToken; 1]> = ops.cloned().collect();
 167         // The stack is innermost on top. We want outermost first.
 168         ops.reverse();
 169         ops
 170     }
 171 }
 172
 173 /// Information attached to a meta-variable binder in LHS.
 174 struct BinderInfo {
 175     /// The span of the meta-variable in LHS.
 176     span: Span,
 177     /// The stack of Kleene operators (outermost first).
 178     ops: SmallVec<[KleeneToken; 1]>,
 179 }
 180
 181 /// An environment of meta-variables to their binder information.
 182 type Binders = FxHashMap<Ident, BinderInfo>;
 183
 184 /// The state at which we entered a macro definition in the RHS of another macro definition.
 185 struct MacroState<'a> {
 186     /// The binders of the branch where we entered the macro definition.
 187     binders: &'a Binders,
 188     /// The stack of Kleene operators (outermost first) where we entered the macro definition.
 189     ops: SmallVec<[KleeneToken; 1]>,
 190 }
 191
 192 /// Checks that meta-variables are used correctly in a macro definition.
 193 ///
 194 /// Arguments:
 195 /// - `sess` is used to emit diagnostics and lints
 196 /// - `node_id` is used to emit lints
 197 /// - `span` is used when no spans are available
 198 /// - `lhses` and `rhses` should have the same length and represent the macro definition
 199 pub(super) fn check_meta_variables(
 200     sess: &ParseSess,
 201     node_id: NodeId,
 202     span: Span,
 203     lhses: &[TokenTree],
 204     rhses: &[TokenTree],
 205 ) -> bool {
 206     if lhses.len() != rhses.len() {
 207         sess.span_diagnostic.span_bug(span, "length mismatch between LHSes and RHSes")
 208     }
 209     let mut valid = true;
 210     for (lhs, rhs) in lhses.iter().zip(rhses.iter()) {
 211         let mut binders = Binders::default();
 212         check_binders(sess, node_id, lhs, &Stack::Empty, &mut binders, &Stack::Empty, &mut valid);
 213         check_occurrences(sess, node_id, rhs, &Stack::Empty, &binders, &Stack::Empty, &mut valid);
 214     }
 215     valid
 216 }
 217
 218 /// Checks `lhs` as part of the LHS of a macro definition, extends `binders` with new binders, and
 219 /// sets `valid` to false in case of errors.
 220 ///
 221 /// Arguments:
 222 /// - `sess` is used to emit diagnostics and lints
 223 /// - `node_id` is used to emit lints
 224 /// - `lhs` is checked as part of a LHS
 225 /// - `macros` is the stack of possible outer macros
 226 /// - `binders` contains the binders of the LHS
 227 /// - `ops` is the stack of Kleene operators from the LHS
 228 /// - `valid` is set in case of errors
 229 fn check_binders(
 230     sess: &ParseSess,
 231     node_id: NodeId,
 232     lhs: &TokenTree,
 233     macros: &Stack<'_, MacroState<'_>>,
 234     binders: &mut Binders,
 235     ops: &Stack<'_, KleeneToken>,
 236     valid: &mut bool,
 237 ) {
 238     match *lhs {
 239         TokenTree::Token(..) => {}
 240         // This can only happen when checking a nested macro because this LHS is then in the RHS of
 241         // the outer macro. See ui/macros/macro-of-higher-order.rs where $y:$fragment in the
 242         // LHS of the nested macro (and RHS of the outer macro) is parsed as MetaVar(y) Colon
 243         // MetaVar(fragment) and not as MetaVarDecl(y, fragment).
 244         TokenTree::MetaVar(span, name) => {
 245             if macros.is_empty() {
 246                 sess.span_diagnostic.span_bug(span, "unexpected MetaVar in lhs");
 247             }
 248             // There are 3 possibilities:
 249             if let Some(prev_info) = binders.get(&name) {
 250                 // 1. The meta-variable is already bound in the current LHS: This is an error.
 251                 let mut span = MultiSpan::from_span(span);
 252                 span.push_span_label(prev_info.span, "previous declaration".into());
 253                 buffer_lint(sess, span, node_id, "duplicate matcher binding");
 254             } else if get_binder_info(macros, binders, name).is_none() {
 255                 // 2. The meta-variable is free: This is a binder.
 256                 binders.insert(name, BinderInfo { span, ops: ops.into() });
 257             } else {
 258                 // 3. The meta-variable is bound: This is an occurrence.
 259                 check_occurrences(sess, node_id, lhs, macros, binders, ops, valid);
 260             }
 261         }
 262         // Similarly, this can only happen when checking a toplevel macro.
 263         TokenTree::MetaVarDecl(span, name, _kind) => {
 264             if !macros.is_empty() {
 265                 sess.span_diagnostic.span_bug(span, "unexpected MetaVarDecl in nested lhs");
 266             }
 267             if let Some(prev_info) = get_binder_info(macros, binders, name) {
 268                 // Duplicate binders at the top-level macro definition are errors. The lint is only
 269                 // for nested macro definitions.
 270                 sess.span_diagnostic
 271                     .struct_span_err(span, "duplicate matcher binding")
 272                     .span_note(prev_info.span, "previous declaration was here")
 273                     .emit();
 274                 *valid = false;
 275             } else {
 276                 binders.insert(name, BinderInfo { span, ops: ops.into() });
 277             }
 278         }
 279         TokenTree::Delimited(_, ref del) => {
 280             for tt in &del.tts {
 281                 check_binders(sess, node_id, tt, macros, binders, ops, valid);
 282             }
 283         }
 284         TokenTree::Sequence(_, ref seq) => {
 285             let ops = ops.push(seq.kleene);
 286             for tt in &seq.tts {
 287                 check_binders(sess, node_id, tt, macros, binders, &ops, valid);
 288             }
 289         }
 290     }
 291 }
 292
 293 /// Returns the binder information of a meta-variable.
 294 ///
 295 /// Arguments:
 296 /// - `macros` is the stack of possible outer macros
 297 /// - `binders` contains the current binders
 298 /// - `name` is the name of the meta-variable we are looking for
 299 fn get_binder_info<'a>(
 300     mut macros: &'a Stack<'a, MacroState<'a>>,
 301     binders: &'a Binders,
 302     name: Ident,
 303 ) -> Option<&'a BinderInfo> {
 304     binders.get(&name).or_else(|| macros.find_map(|state| state.binders.get(&name)))
 305 }
 306
 307 /// Checks `rhs` as part of the RHS of a macro definition and sets `valid` to false in case of
 308 /// errors.
 309 ///
 310 /// Arguments:
 311 /// - `sess` is used to emit diagnostics and lints
 312 /// - `node_id` is used to emit lints
 313 /// - `rhs` is checked as part of a RHS
 314 /// - `macros` is the stack of possible outer macros
 315 /// - `binders` contains the binders of the associated LHS
 316 /// - `ops` is the stack of Kleene operators from the RHS
 317 /// - `valid` is set in case of errors
 318 fn check_occurrences(
 319     sess: &ParseSess,
 320     node_id: NodeId,
 321     rhs: &TokenTree,
 322     macros: &Stack<'_, MacroState<'_>>,
 323     binders: &Binders,
 324     ops: &Stack<'_, KleeneToken>,
 325     valid: &mut bool,
 326 ) {
 327     match *rhs {
 328         TokenTree::Token(..) => {}
 329         TokenTree::MetaVarDecl(span, _name, _kind) => {
 330             sess.span_diagnostic.span_bug(span, "unexpected MetaVarDecl in rhs")
 331         }
 332         TokenTree::MetaVar(span, name) => {
 333             check_ops_is_prefix(sess, node_id, macros, binders, ops, span, name);
 334         }
 335         TokenTree::Delimited(_, ref del) => {
 336             check_nested_occurrences(sess, node_id, &del.tts, macros, binders, ops, valid);
 337         }
 338         TokenTree::Sequence(_, ref seq) => {
 339             let ops = ops.push(seq.kleene);
 340             check_nested_occurrences(sess, node_id, &seq.tts, macros, binders, &ops, valid);
 341         }
 342     }
 343 }
 344
 345 /// Represents the processed prefix of a nested macro.
 346 #[derive(Clone, Copy, PartialEq, Eq)]
 347 enum NestedMacroState {
 348     /// Nothing that matches a nested macro definition was processed yet.
 349     Empty,
 350     /// The token `macro_rules` was processed.
 351     MacroRules,
 352     /// The tokens `macro_rules!` were processed.
 353     MacroRulesNot,
 354     /// The tokens `macro_rules!` followed by a name were processed. The name may be either directly
 355     /// an identifier or a meta-variable (that hopefully would be instantiated by an identifier).
 356     MacroRulesNotName,
 357     /// The keyword `macro` was processed.
 358     Macro,
 359     /// The keyword `macro` followed by a name was processed.
 360     MacroName,
 361     /// The keyword `macro` followed by a name and a token delimited by parentheses was processed.
 362     MacroNameParen,
 363 }
 364
 365 /// Checks `tts` as part of the RHS of a macro definition, tries to recognize nested macro
 366 /// definitions, and sets `valid` to false in case of errors.
 367 ///
 368 /// Arguments:
 369 /// - `sess` is used to emit diagnostics and lints
 370 /// - `node_id` is used to emit lints
 371 /// - `tts` is checked as part of a RHS and may contain macro definitions
 372 /// - `macros` is the stack of possible outer macros
 373 /// - `binders` contains the binders of the associated LHS
 374 /// - `ops` is the stack of Kleene operators from the RHS
 375 /// - `valid` is set in case of errors
 376 fn check_nested_occurrences(
 377     sess: &ParseSess,
 378     node_id: NodeId,
 379     tts: &[TokenTree],
 380     macros: &Stack<'_, MacroState<'_>>,
 381     binders: &Binders,
 382     ops: &Stack<'_, KleeneToken>,
 383     valid: &mut bool,
 384 ) {
 385     let mut state = NestedMacroState::Empty;
 386     let nested_macros = macros.push(MacroState { binders, ops: ops.into() });
 387     let mut nested_binders = Binders::default();
 388     for tt in tts {
 389         match (state, tt) {
 390             (
 391                 NestedMacroState::Empty,
 392                 &TokenTree::Token(Token { kind: TokenKind::Ident(name, false), .. }),
 393             ) => {
 394                 if name == sym::macro_rules {
 395                     state = NestedMacroState::MacroRules;
 396                 } else if name == kw::Macro {
 397                     state = NestedMacroState::Macro;
 398                 }
 399             }
 400             (
 401                 NestedMacroState::MacroRules,
 402                 &TokenTree::Token(Token { kind: TokenKind::Not, .. }),
 403             ) => {
 404                 state = NestedMacroState::MacroRulesNot;
 405             }
 406             (
 407                 NestedMacroState::MacroRulesNot,
 408                 &TokenTree::Token(Token { kind: TokenKind::Ident(..), .. }),
 409             ) => {
 410                 state = NestedMacroState::MacroRulesNotName;
 411             }
 412             (NestedMacroState::MacroRulesNot, &TokenTree::MetaVar(..)) => {
 413                 state = NestedMacroState::MacroRulesNotName;
 414                 // We check that the meta-variable is correctly used.
 415                 check_occurrences(sess, node_id, tt, macros, binders, ops, valid);
 416             }
 417             (NestedMacroState::MacroRulesNotName, &TokenTree::Delimited(_, ref del))
 418             | (NestedMacroState::MacroName, &TokenTree::Delimited(_, ref del))
 419                 if del.delim == DelimToken::Brace =>
 420             {
 421                 let legacy = state == NestedMacroState::MacroRulesNotName;
 422                 state = NestedMacroState::Empty;
 423                 let rest =
 424                     check_nested_macro(sess, node_id, legacy, &del.tts, &nested_macros, valid);
 425                 // If we did not check the whole macro definition, then check the rest as if outside
 426                 // the macro definition.
 427                 check_nested_occurrences(
 428                     sess,
 429                     node_id,
 430                     &del.tts[rest..],
 431                     macros,
 432                     binders,
 433                     ops,
 434                     valid,
 435                 );
 436             }
 437             (
 438                 NestedMacroState::Macro,
 439                 &TokenTree::Token(Token { kind: TokenKind::Ident(..), .. }),
 440             ) => {
 441                 state = NestedMacroState::MacroName;
 442             }
 443             (NestedMacroState::Macro, &TokenTree::MetaVar(..)) => {
 444                 state = NestedMacroState::MacroName;
 445                 // We check that the meta-variable is correctly used.
 446                 check_occurrences(sess, node_id, tt, macros, binders, ops, valid);
 447             }
 448             (NestedMacroState::MacroName, &TokenTree::Delimited(_, ref del))
 449                 if del.delim == DelimToken::Paren =>
 450             {
 451                 state = NestedMacroState::MacroNameParen;
 452                 nested_binders = Binders::default();
 453                 check_binders(
 454                     sess,
 455                     node_id,
 456                     tt,
 457                     &nested_macros,
 458                     &mut nested_binders,
 459                     &Stack::Empty,
 460                     valid,
 461                 );
 462             }
 463             (NestedMacroState::MacroNameParen, &TokenTree::Delimited(_, ref del))
 464                 if del.delim == DelimToken::Brace =>
 465             {
 466                 state = NestedMacroState::Empty;
 467                 check_occurrences(
 468                     sess,
 469                     node_id,
 470                     tt,
 471                     &nested_macros,
 472                     &nested_binders,
 473                     &Stack::Empty,
 474                     valid,
 475                 );
 476             }
 477             (_, ref tt) => {
 478                 state = NestedMacroState::Empty;
 479                 check_occurrences(sess, node_id, tt, macros, binders, ops, valid);
 480             }
 481         }
 482     }
 483 }
 484
 485 /// Checks the body of nested macro, returns where the check stopped, and sets `valid` to false in
 486 /// case of errors.
 487 ///
 488 /// The token trees are checked as long as they look like a list of (LHS) => {RHS} token trees. This
 489 /// check is a best-effort to detect a macro definition. It returns the position in `tts` where we
 490 /// stopped checking because we detected we were not in a macro definition anymore.
 491 ///
 492 /// Arguments:
 493 /// - `sess` is used to emit diagnostics and lints
 494 /// - `node_id` is used to emit lints
 495 /// - `legacy` specifies whether the macro is legacy
 496 /// - `tts` is checked as a list of (LHS) => {RHS}
 497 /// - `macros` is the stack of outer macros
 498 /// - `valid` is set in case of errors
 499 fn check_nested_macro(
 500     sess: &ParseSess,
 501     node_id: NodeId,
 502     legacy: bool,
 503     tts: &[TokenTree],
 504     macros: &Stack<'_, MacroState<'_>>,
 505     valid: &mut bool,
 506 ) -> usize {
 507     let n = tts.len();
 508     let mut i = 0;
 509     let separator = if legacy { TokenKind::Semi } else { TokenKind::Comma };
 510     loop {
 511         // We expect 3 token trees: `(LHS) => {RHS}`. The separator is checked after.
 512         if i + 2 >= n
 513             || !tts[i].is_delimited()
 514             || !tts[i + 1].is_token(&TokenKind::FatArrow)
 515             || !tts[i + 2].is_delimited()
 516         {
 517             break;
 518         }
 519         let lhs = &tts[i];
 520         let rhs = &tts[i + 2];
 521         let mut binders = Binders::default();
 522         check_binders(sess, node_id, lhs, macros, &mut binders, &Stack::Empty, valid);
 523         check_occurrences(sess, node_id, rhs, macros, &binders, &Stack::Empty, valid);
 524         // Since the last semicolon is optional for legacy macros and decl_macro are not terminated,
 525         // we increment our checked position by how many token trees we already checked (the 3
 526         // above) before checking for the separator.
 527         i += 3;
 528         if i == n || !tts[i].is_token(&separator) {
 529             break;
 530         }
 531         // We increment our checked position for the semicolon.
 532         i += 1;
 533     }
 534     i
 535 }
 536
 537 /// Checks that a meta-variable occurrence is valid.
 538 ///
 539 /// Arguments:
 540 /// - `sess` is used to emit diagnostics and lints
 541 /// - `node_id` is used to emit lints
 542 /// - `macros` is the stack of possible outer macros
 543 /// - `binders` contains the binders of the associated LHS
 544 /// - `ops` is the stack of Kleene operators from the RHS
 545 /// - `span` is the span of the meta-variable to check
 546 /// - `name` is the name of the meta-variable to check
 547 fn check_ops_is_prefix(
 548     sess: &ParseSess,
 549     node_id: NodeId,
 550     macros: &Stack<'_, MacroState<'_>>,
 551     binders: &Binders,
 552     ops: &Stack<'_, KleeneToken>,
 553     span: Span,
 554     name: Ident,
 555 ) {
 556     let macros = macros.push(MacroState { binders, ops: ops.into() });
 557     // Accumulates the stacks the operators of each state until (and including when) the
 558     // meta-variable is found. The innermost stack is first.
 559     let mut acc: SmallVec<[&SmallVec<[KleeneToken; 1]>; 1]> = SmallVec::new();
 560     for state in &macros {
 561         acc.push(&state.ops);
 562         if let Some(binder) = state.binders.get(&name) {
 563             // This variable concatenates the stack of operators from the RHS of the LHS where the
 564             // meta-variable was defined to where it is used (in possibly nested macros). The
 565             // outermost operator is first.
 566             let mut occurrence_ops: SmallVec<[KleeneToken; 2]> = SmallVec::new();
 567             // We need to iterate from the end to start with outermost stack.
 568             for ops in acc.iter().rev() {
 569                 occurrence_ops.extend_from_slice(ops);
 570             }
 571             ops_is_prefix(sess, node_id, span, name, &binder.ops, &occurrence_ops);
 572             return;
 573         }
 574     }
 575     buffer_lint(sess, span.into(), node_id, &format!("unknown macro variable `{}`", name));
 576 }
 577
 578 /// Returns whether `binder_ops` is a prefix of `occurrence_ops`.
 579 ///
 580 /// The stack of Kleene operators of a meta-variable occurrence just needs to have the stack of
 581 /// Kleene operators of its binder as a prefix.
 582 ///
 583 /// Consider $i in the following example:
 584 ///
 585 ///     ( $( $i:ident = $($j:ident),+ );* ) => { $($( $i += $j; )+)* }
 586 ///
 587 /// It occurs under the Kleene stack ["*", "+"] and is bound under ["*"] only.
 588 ///
 589 /// Arguments:
 590 /// - `sess` is used to emit diagnostics and lints
 591 /// - `node_id` is used to emit lints
 592 /// - `span` is the span of the meta-variable being check
 593 /// - `name` is the name of the meta-variable being check
 594 /// - `binder_ops` is the stack of Kleene operators for the binder
 595 /// - `occurrence_ops` is the stack of Kleene operators for the occurrence
 596 fn ops_is_prefix(
 597     sess: &ParseSess,
 598     node_id: NodeId,
 599     span: Span,
 600     name: Ident,
 601     binder_ops: &[KleeneToken],
 602     occurrence_ops: &[KleeneToken],
 603 ) {
 604     for (i, binder) in binder_ops.iter().enumerate() {
 605         if i >= occurrence_ops.len() {
 606             let mut span = MultiSpan::from_span(span);
 607             span.push_span_label(binder.span, "expected repetition".into());
 608             let message = &format!("variable '{}' is still repeating at this depth", name);
 609             buffer_lint(sess, span, node_id, message);
 610             return;
 611         }
 612         let occurrence = &occurrence_ops[i];
 613         if occurrence.op != binder.op {
 614             let mut span = MultiSpan::from_span(span);
 615             span.push_span_label(binder.span, "expected repetition".into());
 616             span.push_span_label(occurrence.span, "conflicting repetition".into());
 617             let message = "meta-variable repeats with different Kleene operator";
 618             buffer_lint(sess, span, node_id, message);
 619             return;
 620         }
 621     }
 622 }
 623
 624 fn buffer_lint(sess: &ParseSess, span: MultiSpan, node_id: NodeId, message: &str) {
 625     sess.buffer_lint(BufferedEarlyLintId::MetaVariableMisuse, span, node_id, message);
 626 }