compiler/rustc_builtin_macros/src/format.rs

   1 use ArgumentType::*;
   2 use Position::*;
   3
   4 use rustc_ast as ast;
   5 use rustc_ast::ptr::P;
   6 use rustc_ast::token;
   7 use rustc_ast::tokenstream::TokenStream;
   8 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
   9 use rustc_errors::{pluralize, Applicability, DiagnosticBuilder};
  10 use rustc_expand::base::{self, *};
  11 use rustc_parse_format as parse;
  12 use rustc_span::symbol::{sym, Ident, Symbol};
  13 use rustc_span::{MultiSpan, Span};
  14
  15 use std::borrow::Cow;
  16 use std::collections::hash_map::Entry;
  17
  18 #[derive(PartialEq)]
  19 enum ArgumentType {
  20     Placeholder(&'static str),
  21     Count,
  22 }
  23
  24 enum Position {
  25     Exact(usize),
  26     Named(Symbol),
  27 }
  28
  29 struct Context<'a, 'b> {
  30     ecx: &'a mut ExtCtxt<'b>,
  31     /// The macro's call site. References to unstable formatting internals must
  32     /// use this span to pass the stability checker.
  33     macsp: Span,
  34     /// The span of the format string literal.
  35     fmtsp: Span,
  36
  37     /// List of parsed argument expressions.
  38     /// Named expressions are resolved early, and are appended to the end of
  39     /// argument expressions.
  40     ///
  41     /// Example showing the various data structures in motion:
  42     ///
  43     /// * Original: `"{foo:o} {:o} {foo:x} {0:x} {1:o} {:x} {1:x} {0:o}"`
  44     /// * Implicit argument resolution: `"{foo:o} {0:o} {foo:x} {0:x} {1:o} {1:x} {1:x} {0:o}"`
  45     /// * Name resolution: `"{2:o} {0:o} {2:x} {0:x} {1:o} {1:x} {1:x} {0:o}"`
  46     /// * `arg_types` (in JSON): `[[0, 1, 0], [0, 1, 1], [0, 1]]`
  47     /// * `arg_unique_types` (in simplified JSON): `[["o", "x"], ["o", "x"], ["o", "x"]]`
  48     /// * `names` (in JSON): `{"foo": 2}`
  49     args: Vec<P<ast::Expr>>,
  50     /// Placeholder slot numbers indexed by argument.
  51     arg_types: Vec<Vec<usize>>,
  52     /// Unique format specs seen for each argument.
  53     arg_unique_types: Vec<Vec<ArgumentType>>,
  54     /// Map from named arguments to their resolved indices.
  55     names: FxHashMap<Symbol, usize>,
  56
  57     /// The latest consecutive literal strings, or empty if there weren't any.
  58     literal: String,
  59
  60     /// Collection of the compiled `rt::Argument` structures
  61     pieces: Vec<P<ast::Expr>>,
  62     /// Collection of string literals
  63     str_pieces: Vec<P<ast::Expr>>,
  64     /// Stays `true` if all formatting parameters are default (as in "{}{}").
  65     all_pieces_simple: bool,
  66
  67     /// Mapping between positional argument references and indices into the
  68     /// final generated static argument array. We record the starting indices
  69     /// corresponding to each positional argument, and number of references
  70     /// consumed so far for each argument, to facilitate correct `Position`
  71     /// mapping in `build_piece`. In effect this can be seen as a "flattened"
  72     /// version of `arg_unique_types`.
  73     ///
  74     /// Again with the example described above in docstring for `args`:
  75     ///
  76     /// * `arg_index_map` (in JSON): `[[0, 1, 0], [2, 3, 3], [4, 5]]`
  77     arg_index_map: Vec<Vec<usize>>,
  78
  79     /// Starting offset of count argument slots.
  80     count_args_index_offset: usize,
  81
  82     /// Count argument slots and tracking data structures.
  83     /// Count arguments are separately tracked for de-duplication in case
  84     /// multiple references are made to one argument. For example, in this
  85     /// format string:
  86     ///
  87     /// * Original: `"{:.*} {:.foo$} {1:.*} {:.0$}"`
  88     /// * Implicit argument resolution: `"{1:.0$} {2:.foo$} {1:.3$} {4:.0$}"`
  89     /// * Name resolution: `"{1:.0$} {2:.5$} {1:.3$} {4:.0$}"`
  90     /// * `count_positions` (in JSON): `{0: 0, 5: 1, 3: 2}`
  91     /// * `count_args`: `vec![Exact(0), Exact(5), Exact(3)]`
  92     count_args: Vec<Position>,
  93     /// Relative slot numbers for count arguments.
  94     count_positions: FxHashMap<usize, usize>,
  95     /// Number of count slots assigned.
  96     count_positions_count: usize,
  97
  98     /// Current position of the implicit positional arg pointer, as if it
  99     /// still existed in this phase of processing.
 100     /// Used only for `all_pieces_simple` tracking in `build_piece`.
 101     curarg: usize,
 102     /// Current piece being evaluated, used for error reporting.
 103     curpiece: usize,
 104     /// Keep track of invalid references to positional arguments.
 105     invalid_refs: Vec<(usize, usize)>,
 106     /// Spans of all the formatting arguments, in order.
 107     arg_spans: Vec<Span>,
 108     /// All the formatting arguments that have formatting flags set, in order for diagnostics.
 109     arg_with_formatting: Vec<parse::FormatSpec<'a>>,
 110
 111     /// Whether this format string came from a string literal, as opposed to a macro.
 112     is_literal: bool,
 113 }
 114
 115 /// Parses the arguments from the given list of tokens, returning the diagnostic
 116 /// if there's a parse error so we can continue parsing other format!
 117 /// expressions.
 118 ///
 119 /// If parsing succeeds, the return value is:
 120 ///
 121 /// ```text
 122 /// Some((fmtstr, parsed arguments, index map for named arguments))
 123 /// ```
 124 fn parse_args<'a>(
 125     ecx: &mut ExtCtxt<'a>,
 126     sp: Span,
 127     tts: TokenStream,
 128 ) -> Result<(P<ast::Expr>, Vec<P<ast::Expr>>, FxHashMap<Symbol, usize>), DiagnosticBuilder<'a>> {
 129     let mut args = Vec::<P<ast::Expr>>::new();
 130     let mut names = FxHashMap::<Symbol, usize>::default();
 131
 132     let mut p = ecx.new_parser_from_tts(tts);
 133
 134     if p.token == token::Eof {
 135         return Err(ecx.struct_span_err(sp, "requires at least a format string argument"));
 136     }
 137
 138     let first_token = &p.token;
 139     let fmtstr = match first_token.kind {
 140         token::TokenKind::Literal(token::Lit {
 141             kind: token::LitKind::Str | token::LitKind::StrRaw(_),
 142             ..
 143         }) => {
 144             // If the first token is a string literal, then a format expression
 145             // is constructed from it.
 146             //
 147             // This allows us to properly handle cases when the first comma
 148             // after the format string is mistakenly replaced with any operator,
 149             // which cause the expression parser to eat too much tokens.
 150             p.parse_literal_maybe_minus()?
 151         }
 152         _ => {
 153             // Otherwise, we fall back to the expression parser.
 154             p.parse_expr()?
 155         }
 156     };
 157
 158     let mut first = true;
 159     let mut named = false;
 160
 161     while p.token != token::Eof {
 162         if !p.eat(&token::Comma) {
 163             if first {
 164                 p.clear_expected_tokens();
 165             }
 166
 167             // `Parser::expect` tries to recover using the
 168             // `Parser::unexpected_try_recover` function. This function is able
 169             // to recover if the expected token is a closing delimiter.
 170             //
 171             // As `,` is not a closing delimiter, it will always return an `Err`
 172             // variant.
 173             let mut err = p.expect(&token::Comma).unwrap_err();
 174
 175             match token::TokenKind::Comma.similar_tokens() {
 176                 Some(tks) if tks.contains(&p.token.kind) => {
 177                     // If a similar token is found, then it may be a typo. We
 178                     // consider it as a comma, and continue parsing.
 179                     err.emit();
 180                     p.bump();
 181                 }
 182                 // Otherwise stop the parsing and return the error.
 183                 _ => return Err(err),
 184             }
 185         }
 186         first = false;
 187         if p.token == token::Eof {
 188             break;
 189         } // accept trailing commas
 190         match p.token.ident() {
 191             Some((ident, _)) if p.look_ahead(1, |t| *t == token::Eq) => {
 192                 named = true;
 193                 p.bump();
 194                 p.expect(&token::Eq)?;
 195                 let e = p.parse_expr()?;
 196                 if let Some(prev) = names.get(&ident.name) {
 197                     ecx.struct_span_err(e.span, &format!("duplicate argument named `{}`", ident))
 198                         .span_label(args[*prev].span, "previously here")
 199                         .span_label(e.span, "duplicate argument")
 200                         .emit();
 201                     continue;
 202                 }
 203
 204                 // Resolve names into slots early.
 205                 // Since all the positional args are already seen at this point
 206                 // if the input is valid, we can simply append to the positional
 207                 // args. And remember the names.
 208                 let slot = args.len();
 209                 names.insert(ident.name, slot);
 210                 args.push(e);
 211             }
 212             _ => {
 213                 let e = p.parse_expr()?;
 214                 if named {
 215                     let mut err = ecx.struct_span_err(
 216                         e.span,
 217                         "positional arguments cannot follow named arguments",
 218                     );
 219                     err.span_label(e.span, "positional arguments must be before named arguments");
 220                     for pos in names.values() {
 221                         err.span_label(args[*pos].span, "named argument");
 222                     }
 223                     err.emit();
 224                 }
 225                 args.push(e);
 226             }
 227         }
 228     }
 229     Ok((fmtstr, args, names))
 230 }
 231
 232 impl<'a, 'b> Context<'a, 'b> {
 233     fn resolve_name_inplace(&self, p: &mut parse::Piece<'_>) {
 234         // NOTE: the `unwrap_or` branch is needed in case of invalid format
 235         // arguments, e.g., `format_args!("{foo}")`.
 236         let lookup = |s: Symbol| *self.names.get(&s).unwrap_or(&0);
 237
 238         match *p {
 239             parse::String(_) => {}
 240             parse::NextArgument(ref mut arg) => {
 241                 if let parse::ArgumentNamed(s) = arg.position {
 242                     arg.position = parse::ArgumentIs(lookup(s));
 243                 }
 244                 if let parse::CountIsName(s) = arg.format.width {
 245                     arg.format.width = parse::CountIsParam(lookup(s));
 246                 }
 247                 if let parse::CountIsName(s) = arg.format.precision {
 248                     arg.format.precision = parse::CountIsParam(lookup(s));
 249                 }
 250             }
 251         }
 252     }
 253
 254     /// Verifies one piece of a parse string, and remembers it if valid.
 255     /// All errors are not emitted as fatal so we can continue giving errors
 256     /// about this and possibly other format strings.
 257     fn verify_piece(&mut self, p: &parse::Piece<'_>) {
 258         match *p {
 259             parse::String(..) => {}
 260             parse::NextArgument(ref arg) => {
 261                 // width/precision first, if they have implicit positional
 262                 // parameters it makes more sense to consume them first.
 263                 self.verify_count(arg.format.width);
 264                 self.verify_count(arg.format.precision);
 265
 266                 // argument second, if it's an implicit positional parameter
 267                 // it's written second, so it should come after width/precision.
 268                 let pos = match arg.position {
 269                     parse::ArgumentIs(i) | parse::ArgumentImplicitlyIs(i) => Exact(i),
 270                     parse::ArgumentNamed(s) => Named(s),
 271                 };
 272
 273                 let ty = Placeholder(match &arg.format.ty[..] {
 274                     "" => "Display",
 275                     "?" => "Debug",
 276                     "e" => "LowerExp",
 277                     "E" => "UpperExp",
 278                     "o" => "Octal",
 279                     "p" => "Pointer",
 280                     "b" => "Binary",
 281                     "x" => "LowerHex",
 282                     "X" => "UpperHex",
 283                     _ => {
 284                         let fmtsp = self.fmtsp;
 285                         let sp = arg.format.ty_span.map(|sp| fmtsp.from_inner(sp));
 286                         let mut err = self.ecx.struct_span_err(
 287                             sp.unwrap_or(fmtsp),
 288                             &format!("unknown format trait `{}`", arg.format.ty),
 289                         );
 290                         err.note(
 291                             "the only appropriate formatting traits are:\n\
 292                                 - ``, which uses the `Display` trait\n\
 293                                 - `?`, which uses the `Debug` trait\n\
 294                                 - `e`, which uses the `LowerExp` trait\n\
 295                                 - `E`, which uses the `UpperExp` trait\n\
 296                                 - `o`, which uses the `Octal` trait\n\
 297                                 - `p`, which uses the `Pointer` trait\n\
 298                                 - `b`, which uses the `Binary` trait\n\
 299                                 - `x`, which uses the `LowerHex` trait\n\
 300                                 - `X`, which uses the `UpperHex` trait",
 301                         );
 302                         if let Some(sp) = sp {
 303                             for (fmt, name) in &[
 304                                 ("", "Display"),
 305                                 ("?", "Debug"),
 306                                 ("e", "LowerExp"),
 307                                 ("E", "UpperExp"),
 308                                 ("o", "Octal"),
 309                                 ("p", "Pointer"),
 310                                 ("b", "Binary"),
 311                                 ("x", "LowerHex"),
 312                                 ("X", "UpperHex"),
 313                             ] {
 314                                 // FIXME: rustfix (`run-rustfix`) fails to apply suggestions.
 315                                 // > "Cannot replace slice of data that was already replaced"
 316                                 err.tool_only_span_suggestion(
 317                                     sp,
 318                                     &format!("use the `{}` trait", name),
 319                                     (*fmt).to_string(),
 320                                     Applicability::MaybeIncorrect,
 321                                 );
 322                             }
 323                         }
 324                         err.emit();
 325                         "<invalid>"
 326                     }
 327                 });
 328                 self.verify_arg_type(pos, ty);
 329                 self.curpiece += 1;
 330             }
 331         }
 332     }
 333
 334     fn verify_count(&mut self, c: parse::Count) {
 335         match c {
 336             parse::CountImplied | parse::CountIs(..) => {}
 337             parse::CountIsParam(i) => {
 338                 self.verify_arg_type(Exact(i), Count);
 339             }
 340             parse::CountIsName(s) => {
 341                 self.verify_arg_type(Named(s), Count);
 342             }
 343         }
 344     }
 345
 346     fn describe_num_args(&self) -> Cow<'_, str> {
 347         match self.args.len() {
 348             0 => "no arguments were given".into(),
 349             1 => "there is 1 argument".into(),
 350             x => format!("there are {} arguments", x).into(),
 351         }
 352     }
 353
 354     /// Handle invalid references to positional arguments. Output different
 355     /// errors for the case where all arguments are positional and for when
 356     /// there are named arguments or numbered positional arguments in the
 357     /// format string.
 358     fn report_invalid_references(&self, numbered_position_args: bool) {
 359         let mut e;
 360         let sp = if !self.arg_spans.is_empty() {
 361             // Point at the formatting arguments.
 362             MultiSpan::from_spans(self.arg_spans.clone())
 363         } else {
 364             MultiSpan::from_span(self.fmtsp)
 365         };
 366         let refs =
 367             self.invalid_refs.iter().map(|(r, pos)| (r.to_string(), self.arg_spans.get(*pos)));
 368
 369         let mut zero_based_note = false;
 370
 371         let count = self.pieces.len()
 372             + self.arg_with_formatting.iter().filter(|fmt| fmt.precision_span.is_some()).count();
 373         if self.names.is_empty() && !numbered_position_args && count != self.args.len() {
 374             e = self.ecx.struct_span_err(
 375                 sp,
 376                 &format!(
 377                     "{} positional argument{} in format string, but {}",
 378                     count,
 379                     pluralize!(count),
 380                     self.describe_num_args(),
 381                 ),
 382             );
 383             for arg in &self.args {
 384                 // Point at the arguments that will be formatted.
 385                 e.span_label(arg.span, "");
 386             }
 387         } else {
 388             let (mut refs, spans): (Vec<_>, Vec<_>) = refs.unzip();
 389             // Avoid `invalid reference to positional arguments 7 and 7 (there is 1 argument)`
 390             // for `println!("{7:7$}", 1);`
 391             refs.sort();
 392             refs.dedup();
 393             let spans: Vec<_> = spans.into_iter().filter_map(|sp| sp.copied()).collect();
 394             let sp = if self.arg_spans.is_empty() || spans.is_empty() {
 395                 MultiSpan::from_span(self.fmtsp)
 396             } else {
 397                 MultiSpan::from_spans(spans)
 398             };
 399             let arg_list = if refs.len() == 1 {
 400                 format!("argument {}", refs[0])
 401             } else {
 402                 let reg = refs.pop().unwrap();
 403                 format!("arguments {head} and {tail}", head = refs.join(", "), tail = reg)
 404             };
 405
 406             e = self.ecx.struct_span_err(
 407                 sp,
 408                 &format!(
 409                     "invalid reference to positional {} ({})",
 410                     arg_list,
 411                     self.describe_num_args()
 412                 ),
 413             );
 414             zero_based_note = true;
 415         };
 416
 417         for fmt in &self.arg_with_formatting {
 418             if let Some(span) = fmt.precision_span {
 419                 let span = self.fmtsp.from_inner(span);
 420                 match fmt.precision {
 421                     parse::CountIsParam(pos) if pos > self.args.len() => {
 422                         e.span_label(
 423                             span,
 424                             &format!(
 425                                 "this precision flag expects an `usize` argument at position {}, \
 426                              but {}",
 427                                 pos,
 428                                 self.describe_num_args(),
 429                             ),
 430                         );
 431                         zero_based_note = true;
 432                     }
 433                     parse::CountIsParam(pos) => {
 434                         let count = self.pieces.len()
 435                             + self
 436                                 .arg_with_formatting
 437                                 .iter()
 438                                 .filter(|fmt| fmt.precision_span.is_some())
 439                                 .count();
 440                         e.span_label(span, &format!(
 441                             "this precision flag adds an extra required argument at position {}, \
 442                              which is why there {} expected",
 443                             pos,
 444                             if count == 1 {
 445                                 "is 1 argument".to_string()
 446                             } else {
 447                                 format!("are {} arguments", count)
 448                             },
 449                         ));
 450                         if let Some(arg) = self.args.get(pos) {
 451                             e.span_label(
 452                                 arg.span,
 453                                 "this parameter corresponds to the precision flag",
 454                             );
 455                         }
 456                         zero_based_note = true;
 457                     }
 458                     _ => {}
 459                 }
 460             }
 461             if let Some(span) = fmt.width_span {
 462                 let span = self.fmtsp.from_inner(span);
 463                 match fmt.width {
 464                     parse::CountIsParam(pos) if pos > self.args.len() => {
 465                         e.span_label(
 466                             span,
 467                             &format!(
 468                                 "this width flag expects an `usize` argument at position {}, \
 469                              but {}",
 470                                 pos,
 471                                 self.describe_num_args(),
 472                             ),
 473                         );
 474                         zero_based_note = true;
 475                     }
 476                     _ => {}
 477                 }
 478             }
 479         }
 480         if zero_based_note {
 481             e.note("positional arguments are zero-based");
 482         }
 483         if !self.arg_with_formatting.is_empty() {
 484             e.note(
 485                 "for information about formatting flags, visit \
 486                     https://doc.rust-lang.org/std/fmt/index.html",
 487             );
 488         }
 489
 490         e.emit();
 491     }
 492
 493     /// Actually verifies and tracks a given format placeholder
 494     /// (a.k.a. argument).
 495     fn verify_arg_type(&mut self, arg: Position, ty: ArgumentType) {
 496         match arg {
 497             Exact(arg) => {
 498                 if self.args.len() <= arg {
 499                     self.invalid_refs.push((arg, self.curpiece));
 500                     return;
 501                 }
 502                 match ty {
 503                     Placeholder(_) => {
 504                         // record every (position, type) combination only once
 505                         let seen_ty = &mut self.arg_unique_types[arg];
 506                         let i = seen_ty.iter().position(|x| *x == ty).unwrap_or_else(|| {
 507                             let i = seen_ty.len();
 508                             seen_ty.push(ty);
 509                             i
 510                         });
 511                         self.arg_types[arg].push(i);
 512                     }
 513                     Count => {
 514                         if let Entry::Vacant(e) = self.count_positions.entry(arg) {
 515                             let i = self.count_positions_count;
 516                             e.insert(i);
 517                             self.count_args.push(Exact(arg));
 518                             self.count_positions_count += 1;
 519                         }
 520                     }
 521                 }
 522             }
 523
 524             Named(name) => {
 525                 match self.names.get(&name) {
 526                     Some(&idx) => {
 527                         // Treat as positional arg.
 528                         self.verify_arg_type(Exact(idx), ty)
 529                     }
 530                     None => {
 531                         let capture_feature_enabled = self
 532                             .ecx
 533                             .ecfg
 534                             .features
 535                             .map_or(false, |features| features.format_args_capture);
 536
 537                         // For the moment capturing variables from format strings expanded from macros is
 538                         // disabled (see RFC #2795)
 539                         let can_capture = capture_feature_enabled && self.is_literal;
 540
 541                         if can_capture {
 542                             // Treat this name as a variable to capture from the surrounding scope
 543                             let idx = self.args.len();
 544                             self.arg_types.push(Vec::new());
 545                             self.arg_unique_types.push(Vec::new());
 546                             self.args.push(
 547                                 self.ecx.expr_ident(self.fmtsp, Ident::new(name, self.fmtsp)),
 548                             );
 549                             self.names.insert(name, idx);
 550                             self.verify_arg_type(Exact(idx), ty)
 551                         } else {
 552                             let msg = format!("there is no argument named `{}`", name);
 553                             let sp = if self.is_literal {
 554                                 *self.arg_spans.get(self.curpiece).unwrap_or(&self.fmtsp)
 555                             } else {
 556                                 self.fmtsp
 557                             };
 558                             let mut err = self.ecx.struct_span_err(sp, &msg[..]);
 559
 560                             if capture_feature_enabled && !self.is_literal {
 561                                 err.note(&format!(
 562                                     "did you intend to capture a variable `{}` from \
 563                                      the surrounding scope?",
 564                                     name
 565                                 ));
 566                                 err.note(
 567                                     "to avoid ambiguity, `format_args!` cannot capture variables \
 568                                      when the format string is expanded from a macro",
 569                                 );
 570                             } else if self.ecx.parse_sess().unstable_features.is_nightly_build() {
 571                                 err.help(&format!(
 572                                     "if you intended to capture `{}` from the surrounding scope, add \
 573                                      `#![feature(format_args_capture)]` to the crate attributes",
 574                                     name
 575                                 ));
 576                             }
 577
 578                             err.emit();
 579                         }
 580                     }
 581                 }
 582             }
 583         }
 584     }
 585
 586     /// Builds the mapping between format placeholders and argument objects.
 587     fn build_index_map(&mut self) {
 588         // NOTE: Keep the ordering the same as `into_expr`'s expansion would do!
 589         let args_len = self.args.len();
 590         self.arg_index_map.reserve(args_len);
 591
 592         let mut sofar = 0usize;
 593
 594         // Map the arguments
 595         for i in 0..args_len {
 596             let arg_types = &self.arg_types[i];
 597             let arg_offsets = arg_types.iter().map(|offset| sofar + *offset).collect::<Vec<_>>();
 598             self.arg_index_map.push(arg_offsets);
 599             sofar += self.arg_unique_types[i].len();
 600         }
 601
 602         // Record starting index for counts, which appear just after arguments
 603         self.count_args_index_offset = sofar;
 604     }
 605
 606     fn rtpath(ecx: &ExtCtxt<'_>, s: Symbol) -> Vec<Ident> {
 607         ecx.std_path(&[sym::fmt, sym::rt, sym::v1, s])
 608     }
 609
 610     fn build_count(&self, c: parse::Count) -> P<ast::Expr> {
 611         let sp = self.macsp;
 612         let count = |c, arg| {
 613             let mut path = Context::rtpath(self.ecx, sym::Count);
 614             path.push(Ident::new(c, sp));
 615             match arg {
 616                 Some(arg) => self.ecx.expr_call_global(sp, path, vec![arg]),
 617                 None => self.ecx.expr_path(self.ecx.path_global(sp, path)),
 618             }
 619         };
 620         match c {
 621             parse::CountIs(i) => count(sym::Is, Some(self.ecx.expr_usize(sp, i))),
 622             parse::CountIsParam(i) => {
 623                 // This needs mapping too, as `i` is referring to a macro
 624                 // argument. If `i` is not found in `count_positions` then
 625                 // the error had already been emitted elsewhere.
 626                 let i = self.count_positions.get(&i).cloned().unwrap_or(0)
 627                     + self.count_args_index_offset;
 628                 count(sym::Param, Some(self.ecx.expr_usize(sp, i)))
 629             }
 630             parse::CountImplied => count(sym::Implied, None),
 631             // should never be the case, names are already resolved
 632             parse::CountIsName(_) => panic!("should never happen"),
 633         }
 634     }
 635
 636     /// Build a literal expression from the accumulated string literals
 637     fn build_literal_string(&mut self) -> P<ast::Expr> {
 638         let sp = self.fmtsp;
 639         let s = Symbol::intern(&self.literal);
 640         self.literal.clear();
 641         self.ecx.expr_str(sp, s)
 642     }
 643
 644     /// Builds a static `rt::Argument` from a `parse::Piece` or append
 645     /// to the `literal` string.
 646     fn build_piece(
 647         &mut self,
 648         piece: &parse::Piece<'a>,
 649         arg_index_consumed: &mut Vec<usize>,
 650     ) -> Option<P<ast::Expr>> {
 651         let sp = self.macsp;
 652         match *piece {
 653             parse::String(s) => {
 654                 self.literal.push_str(s);
 655                 None
 656             }
 657             parse::NextArgument(ref arg) => {
 658                 // Build the position
 659                 let pos = {
 660                     match arg.position {
 661                         parse::ArgumentIs(i) | parse::ArgumentImplicitlyIs(i) => {
 662                             // Map to index in final generated argument array
 663                             // in case of multiple types specified
 664                             let arg_idx = match arg_index_consumed.get_mut(i) {
 665                                 None => 0, // error already emitted elsewhere
 666                                 Some(offset) => {
 667                                     let idx_map = &self.arg_index_map[i];
 668                                     // unwrap_or branch: error already emitted elsewhere
 669                                     let arg_idx = *idx_map.get(*offset).unwrap_or(&0);
 670                                     *offset += 1;
 671                                     arg_idx
 672                                 }
 673                             };
 674                             self.ecx.expr_usize(sp, arg_idx)
 675                         }
 676
 677                         // should never be the case, because names are already
 678                         // resolved.
 679                         parse::ArgumentNamed(_) => panic!("should never happen"),
 680                     }
 681                 };
 682
 683                 let simple_arg = parse::Argument {
 684                     position: {
 685                         // We don't have ArgumentNext any more, so we have to
 686                         // track the current argument ourselves.
 687                         let i = self.curarg;
 688                         self.curarg += 1;
 689                         parse::ArgumentIs(i)
 690                     },
 691                     format: parse::FormatSpec {
 692                         fill: arg.format.fill,
 693                         align: parse::AlignUnknown,
 694                         flags: 0,
 695                         precision: parse::CountImplied,
 696                         precision_span: None,
 697                         width: parse::CountImplied,
 698                         width_span: None,
 699                         ty: arg.format.ty,
 700                         ty_span: arg.format.ty_span,
 701                     },
 702                 };
 703
 704                 let fill = arg.format.fill.unwrap_or(' ');
 705
 706                 let pos_simple = arg.position.index() == simple_arg.position.index();
 707
 708                 if arg.format.precision_span.is_some() || arg.format.width_span.is_some() {
 709                     self.arg_with_formatting.push(arg.format);
 710                 }
 711                 if !pos_simple || arg.format != simple_arg.format || fill != ' ' {
 712                     self.all_pieces_simple = false;
 713                 }
 714
 715                 // Build the format
 716                 let fill = self.ecx.expr_lit(sp, ast::LitKind::Char(fill));
 717                 let align = |name| {
 718                     let mut p = Context::rtpath(self.ecx, sym::Alignment);
 719                     p.push(Ident::new(name, sp));
 720                     self.ecx.path_global(sp, p)
 721                 };
 722                 let align = match arg.format.align {
 723                     parse::AlignLeft => align(sym::Left),
 724                     parse::AlignRight => align(sym::Right),
 725                     parse::AlignCenter => align(sym::Center),
 726                     parse::AlignUnknown => align(sym::Unknown),
 727                 };
 728                 let align = self.ecx.expr_path(align);
 729                 let flags = self.ecx.expr_u32(sp, arg.format.flags);
 730                 let prec = self.build_count(arg.format.precision);
 731                 let width = self.build_count(arg.format.width);
 732                 let path = self.ecx.path_global(sp, Context::rtpath(self.ecx, sym::FormatSpec));
 733                 let fmt = self.ecx.expr_struct(
 734                     sp,
 735                     path,
 736                     vec![
 737                         self.ecx.field_imm(sp, Ident::new(sym::fill, sp), fill),
 738                         self.ecx.field_imm(sp, Ident::new(sym::align, sp), align),
 739                         self.ecx.field_imm(sp, Ident::new(sym::flags, sp), flags),
 740                         self.ecx.field_imm(sp, Ident::new(sym::precision, sp), prec),
 741                         self.ecx.field_imm(sp, Ident::new(sym::width, sp), width),
 742                     ],
 743                 );
 744
 745                 let path = self.ecx.path_global(sp, Context::rtpath(self.ecx, sym::Argument));
 746                 Some(self.ecx.expr_struct(
 747                     sp,
 748                     path,
 749                     vec![
 750                         self.ecx.field_imm(sp, Ident::new(sym::position, sp), pos),
 751                         self.ecx.field_imm(sp, Ident::new(sym::format, sp), fmt),
 752                     ],
 753                 ))
 754             }
 755         }
 756     }
 757
 758     /// Actually builds the expression which the format_args! block will be
 759     /// expanded to.
 760     fn into_expr(self) -> P<ast::Expr> {
 761         let mut locals =
 762             Vec::with_capacity((0..self.args.len()).map(|i| self.arg_unique_types[i].len()).sum());
 763         let mut counts = Vec::with_capacity(self.count_args.len());
 764         let mut pats = Vec::with_capacity(self.args.len());
 765         let mut heads = Vec::with_capacity(self.args.len());
 766
 767         let names_pos: Vec<_> = (0..self.args.len())
 768             .map(|i| Ident::from_str_and_span(&format!("arg{}", i), self.macsp))
 769             .collect();
 770
 771         // First, build up the static array which will become our precompiled
 772         // format "string"
 773         let pieces = self.ecx.expr_vec_slice(self.fmtsp, self.str_pieces);
 774
 775         // Before consuming the expressions, we have to remember spans for
 776         // count arguments as they are now generated separate from other
 777         // arguments, hence have no access to the `P<ast::Expr>`'s.
 778         let spans_pos: Vec<_> = self.args.iter().map(|e| e.span).collect();
 779
 780         // Right now there is a bug such that for the expression:
 781         //      foo(bar(&1))
 782         // the lifetime of `1` doesn't outlast the call to `bar`, so it's not
 783         // valid for the call to `foo`. To work around this all arguments to the
 784         // format! string are shoved into locals. Furthermore, we shove the address
 785         // of each variable because we don't want to move out of the arguments
 786         // passed to this function.
 787         for (i, e) in self.args.into_iter().enumerate() {
 788             let name = names_pos[i];
 789             let span = self.ecx.with_def_site_ctxt(e.span);
 790             pats.push(self.ecx.pat_ident(span, name));
 791             for arg_ty in self.arg_unique_types[i].iter() {
 792                 locals.push(Context::format_arg(self.ecx, self.macsp, e.span, arg_ty, name));
 793             }
 794             heads.push(self.ecx.expr_addr_of(e.span, e));
 795         }
 796         for pos in self.count_args {
 797             let index = match pos {
 798                 Exact(i) => i,
 799                 _ => panic!("should never happen"),
 800             };
 801             let name = names_pos[index];
 802             let span = spans_pos[index];
 803             counts.push(Context::format_arg(self.ecx, self.macsp, span, &Count, name));
 804         }
 805
 806         // Now create a vector containing all the arguments
 807         let args = locals.into_iter().chain(counts.into_iter());
 808
 809         let args_array = self.ecx.expr_vec(self.macsp, args.collect());
 810
 811         // Constructs an AST equivalent to:
 812         //
 813         //      match (&arg0, &arg1) {
 814         //          (tmp0, tmp1) => args_array
 815         //      }
 816         //
 817         // It was:
 818         //
 819         //      let tmp0 = &arg0;
 820         //      let tmp1 = &arg1;
 821         //      args_array
 822         //
 823         // Because of #11585 the new temporary lifetime rule, the enclosing
 824         // statements for these temporaries become the let's themselves.
 825         // If one or more of them are RefCell's, RefCell borrow() will also
 826         // end there; they don't last long enough for args_array to use them.
 827         // The match expression solves the scope problem.
 828         //
 829         // Note, it may also very well be transformed to:
 830         //
 831         //      match arg0 {
 832         //          ref tmp0 => {
 833         //              match arg1 => {
 834         //                  ref tmp1 => args_array } } }
 835         //
 836         // But the nested match expression is proved to perform not as well
 837         // as series of let's; the first approach does.
 838         let pat = self.ecx.pat_tuple(self.macsp, pats);
 839         let arm = self.ecx.arm(self.macsp, pat, args_array);
 840         let head = self.ecx.expr(self.macsp, ast::ExprKind::Tup(heads));
 841         let result = self.ecx.expr_match(self.macsp, head, vec![arm]);
 842
 843         let args_slice = self.ecx.expr_addr_of(self.macsp, result);
 844
 845         // Now create the fmt::Arguments struct with all our locals we created.
 846         let (fn_name, fn_args) = if self.all_pieces_simple {
 847             ("new_v1", vec![pieces, args_slice])
 848         } else {
 849             // Build up the static array which will store our precompiled
 850             // nonstandard placeholders, if there are any.
 851             let fmt = self.ecx.expr_vec_slice(self.macsp, self.pieces);
 852
 853             ("new_v1_formatted", vec![pieces, args_slice, fmt])
 854         };
 855
 856         let path = self.ecx.std_path(&[sym::fmt, sym::Arguments, Symbol::intern(fn_name)]);
 857         self.ecx.expr_call_global(self.macsp, path, fn_args)
 858     }
 859
 860     fn format_arg(
 861         ecx: &ExtCtxt<'_>,
 862         macsp: Span,
 863         mut sp: Span,
 864         ty: &ArgumentType,
 865         arg: Ident,
 866     ) -> P<ast::Expr> {
 867         sp = ecx.with_def_site_ctxt(sp);
 868         let arg = ecx.expr_ident(sp, arg);
 869         let trait_ = match *ty {
 870             Placeholder(trait_) if trait_ == "<invalid>" => return DummyResult::raw_expr(sp, true),
 871             Placeholder(trait_) => trait_,
 872             Count => {
 873                 let path = ecx.std_path(&[sym::fmt, sym::ArgumentV1, sym::from_usize]);
 874                 return ecx.expr_call_global(macsp, path, vec![arg]);
 875             }
 876         };
 877
 878         let path = ecx.std_path(&[sym::fmt, Symbol::intern(trait_), sym::fmt]);
 879         let format_fn = ecx.path_global(sp, path);
 880         let path = ecx.std_path(&[sym::fmt, sym::ArgumentV1, sym::new]);
 881         ecx.expr_call_global(macsp, path, vec![arg, ecx.expr_path(format_fn)])
 882     }
 883 }
 884
 885 fn expand_format_args_impl<'cx>(
 886     ecx: &'cx mut ExtCtxt<'_>,
 887     mut sp: Span,
 888     tts: TokenStream,
 889     nl: bool,
 890 ) -> Box<dyn base::MacResult + 'cx> {
 891     sp = ecx.with_def_site_ctxt(sp);
 892     match parse_args(ecx, sp, tts) {
 893         Ok((efmt, args, names)) => {
 894             MacEager::expr(expand_preparsed_format_args(ecx, sp, efmt, args, names, nl))
 895         }
 896         Err(mut err) => {
 897             err.emit();
 898             DummyResult::any(sp)
 899         }
 900     }
 901 }
 902
 903 pub fn expand_format_args<'cx>(
 904     ecx: &'cx mut ExtCtxt<'_>,
 905     sp: Span,
 906     tts: TokenStream,
 907 ) -> Box<dyn base::MacResult + 'cx> {
 908     expand_format_args_impl(ecx, sp, tts, false)
 909 }
 910
 911 pub fn expand_format_args_nl<'cx>(
 912     ecx: &'cx mut ExtCtxt<'_>,
 913     sp: Span,
 914     tts: TokenStream,
 915 ) -> Box<dyn base::MacResult + 'cx> {
 916     expand_format_args_impl(ecx, sp, tts, true)
 917 }
 918
 919 /// Take the various parts of `format_args!(efmt, args..., name=names...)`
 920 /// and construct the appropriate formatting expression.
 921 pub fn expand_preparsed_format_args(
 922     ecx: &mut ExtCtxt<'_>,
 923     sp: Span,
 924     efmt: P<ast::Expr>,
 925     args: Vec<P<ast::Expr>>,
 926     names: FxHashMap<Symbol, usize>,
 927     append_newline: bool,
 928 ) -> P<ast::Expr> {
 929     // NOTE: this verbose way of initializing `Vec<Vec<ArgumentType>>` is because
 930     // `ArgumentType` does not derive `Clone`.
 931     let arg_types: Vec<_> = (0..args.len()).map(|_| Vec::new()).collect();
 932     let arg_unique_types: Vec<_> = (0..args.len()).map(|_| Vec::new()).collect();
 933
 934     let mut macsp = ecx.call_site();
 935     macsp = ecx.with_def_site_ctxt(macsp);
 936
 937     let msg = "format argument must be a string literal";
 938     let fmt_sp = efmt.span;
 939     let (fmt_str, fmt_style, fmt_span) = match expr_to_spanned_string(ecx, efmt, msg) {
 940         Ok(mut fmt) if append_newline => {
 941             fmt.0 = Symbol::intern(&format!("{}\n", fmt.0));
 942             fmt
 943         }
 944         Ok(fmt) => fmt,
 945         Err(err) => {
 946             if let Some(mut err) = err {
 947                 let sugg_fmt = match args.len() {
 948                     0 => "{}".to_string(),
 949                     _ => format!("{}{{}}", "{} ".repeat(args.len())),
 950                 };
 951                 err.span_suggestion(
 952                     fmt_sp.shrink_to_lo(),
 953                     "you might be missing a string literal to format with",
 954                     format!("\"{}\", ", sugg_fmt),
 955                     Applicability::MaybeIncorrect,
 956                 );
 957                 err.emit();
 958             }
 959             return DummyResult::raw_expr(sp, true);
 960         }
 961     };
 962
 963     let str_style = match fmt_style {
 964         ast::StrStyle::Cooked => None,
 965         ast::StrStyle::Raw(raw) => Some(raw as usize),
 966     };
 967
 968     let fmt_str = &fmt_str.as_str(); // for the suggestions below
 969     let fmt_snippet = ecx.source_map().span_to_snippet(fmt_sp).ok();
 970     let mut parser = parse::Parser::new(
 971         fmt_str,
 972         str_style,
 973         fmt_snippet,
 974         append_newline,
 975         parse::ParseMode::Format,
 976     );
 977
 978     let mut unverified_pieces = Vec::new();
 979     while let Some(piece) = parser.next() {
 980         if !parser.errors.is_empty() {
 981             break;
 982         } else {
 983             unverified_pieces.push(piece);
 984         }
 985     }
 986
 987     if !parser.errors.is_empty() {
 988         let err = parser.errors.remove(0);
 989         let sp = fmt_span.from_inner(err.span);
 990         let mut e = ecx.struct_span_err(sp, &format!("invalid format string: {}", err.description));
 991         e.span_label(sp, err.label + " in format string");
 992         if let Some(note) = err.note {
 993             e.note(&note);
 994         }
 995         if let Some((label, span)) = err.secondary_label {
 996             let sp = fmt_span.from_inner(span);
 997             e.span_label(sp, label);
 998         }
 999         e.emit();
1000         return DummyResult::raw_expr(sp, true);
1001     }
1002
1003     let arg_spans = parser.arg_places.iter().map(|span| fmt_span.from_inner(*span)).collect();
1004
1005     let named_pos: FxHashSet<usize> = names.values().cloned().collect();
1006
1007     let mut cx = Context {
1008         ecx,
1009         args,
1010         arg_types,
1011         arg_unique_types,
1012         names,
1013         curarg: 0,
1014         curpiece: 0,
1015         arg_index_map: Vec::new(),
1016         count_args: Vec::new(),
1017         count_positions: FxHashMap::default(),
1018         count_positions_count: 0,
1019         count_args_index_offset: 0,
1020         literal: String::new(),
1021         pieces: Vec::with_capacity(unverified_pieces.len()),
1022         str_pieces: Vec::with_capacity(unverified_pieces.len()),
1023         all_pieces_simple: true,
1024         macsp,
1025         fmtsp: fmt_span,
1026         invalid_refs: Vec::new(),
1027         arg_spans,
1028         arg_with_formatting: Vec::new(),
1029         is_literal: parser.is_literal,
1030     };
1031
1032     // This needs to happen *after* the Parser has consumed all pieces to create all the spans
1033     let pieces = unverified_pieces
1034         .into_iter()
1035         .map(|mut piece| {
1036             cx.verify_piece(&piece);
1037             cx.resolve_name_inplace(&mut piece);
1038             piece
1039         })
1040         .collect::<Vec<_>>();
1041
1042     let numbered_position_args = pieces.iter().any(|arg: &parse::Piece<'_>| match *arg {
1043         parse::String(_) => false,
1044         parse::NextArgument(arg) => match arg.position {
1045             parse::Position::ArgumentIs(_) => true,
1046             _ => false,
1047         },
1048     });
1049
1050     cx.build_index_map();
1051
1052     let mut arg_index_consumed = vec![0usize; cx.arg_index_map.len()];
1053
1054     for piece in pieces {
1055         if let Some(piece) = cx.build_piece(&piece, &mut arg_index_consumed) {
1056             let s = cx.build_literal_string();
1057             cx.str_pieces.push(s);
1058             cx.pieces.push(piece);
1059         }
1060     }
1061
1062     if !cx.literal.is_empty() {
1063         let s = cx.build_literal_string();
1064         cx.str_pieces.push(s);
1065     }
1066
1067     if !cx.invalid_refs.is_empty() {
1068         cx.report_invalid_references(numbered_position_args);
1069     }
1070
1071     // Make sure that all arguments were used and all arguments have types.
1072     let errs = cx
1073         .arg_types
1074         .iter()
1075         .enumerate()
1076         .filter(|(i, ty)| ty.is_empty() && !cx.count_positions.contains_key(&i))
1077         .map(|(i, _)| {
1078             let msg = if named_pos.contains(&i) {
1079                 // named argument
1080                 "named argument never used"
1081             } else {
1082                 // positional argument
1083                 "argument never used"
1084             };
1085             (cx.args[i].span, msg)
1086         })
1087         .collect::<Vec<_>>();
1088
1089     let errs_len = errs.len();
1090     if !errs.is_empty() {
1091         let args_used = cx.arg_types.len() - errs_len;
1092         let args_unused = errs_len;
1093
1094         let mut diag = {
1095             if let [(sp, msg)] = &errs[..] {
1096                 let mut diag = cx.ecx.struct_span_err(*sp, *msg);
1097                 diag.span_label(*sp, *msg);
1098                 diag
1099             } else {
1100                 let mut diag = cx.ecx.struct_span_err(
1101                     errs.iter().map(|&(sp, _)| sp).collect::<Vec<Span>>(),
1102                     "multiple unused formatting arguments",
1103                 );
1104                 diag.span_label(cx.fmtsp, "multiple missing formatting specifiers");
1105                 for (sp, msg) in errs {
1106                     diag.span_label(sp, msg);
1107                 }
1108                 diag
1109             }
1110         };
1111
1112         // Used to ensure we only report translations for *one* kind of foreign format.
1113         let mut found_foreign = false;
1114         // Decide if we want to look for foreign formatting directives.
1115         if args_used < args_unused {
1116             use super::format_foreign as foreign;
1117
1118             // The set of foreign substitutions we've explained.  This prevents spamming the user
1119             // with `%d should be written as {}` over and over again.
1120             let mut explained = FxHashSet::default();
1121
1122             macro_rules! check_foreign {
1123                 ($kind:ident) => {{
1124                     let mut show_doc_note = false;
1125
1126                     let mut suggestions = vec![];
1127                     // account for `"` and account for raw strings `r#`
1128                     let padding = str_style.map(|i| i + 2).unwrap_or(1);
1129                     for sub in foreign::$kind::iter_subs(fmt_str, padding) {
1130                         let trn = match sub.translate() {
1131                             Some(trn) => trn,
1132
1133                             // If it has no translation, don't call it out specifically.
1134                             None => continue,
1135                         };
1136
1137                         let pos = sub.position();
1138                         let sub = String::from(sub.as_str());
1139                         if explained.contains(&sub) {
1140                             continue;
1141                         }
1142                         explained.insert(sub.clone());
1143
1144                         if !found_foreign {
1145                             found_foreign = true;
1146                             show_doc_note = true;
1147                         }
1148
1149                         if let Some(inner_sp) = pos {
1150                             let sp = fmt_sp.from_inner(inner_sp);
1151                             suggestions.push((sp, trn));
1152                         } else {
1153                             diag.help(&format!("`{}` should be written as `{}`", sub, trn));
1154                         }
1155                     }
1156
1157                     if show_doc_note {
1158                         diag.note(concat!(
1159                             stringify!($kind),
1160                             " formatting not supported; see the documentation for `std::fmt`",
1161                         ));
1162                     }
1163                     if suggestions.len() > 0 {
1164                         diag.multipart_suggestion(
1165                             "format specifiers use curly braces",
1166                             suggestions,
1167                             Applicability::MachineApplicable,
1168                         );
1169                     }
1170                 }};
1171             }
1172
1173             check_foreign!(printf);
1174             if !found_foreign {
1175                 check_foreign!(shell);
1176             }
1177         }
1178         if !found_foreign && errs_len == 1 {
1179             diag.span_label(cx.fmtsp, "formatting specifier missing");
1180         }
1181
1182         diag.emit();
1183     }
1184
1185     cx.into_expr()
1186 }