src/librustc_builtin_macros/format.rs

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