src/libsyntax_ext/format.rs

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