src/libsyntax_ext/format.rs

   1 // Copyright 2012 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 use self::ArgumentType::*;
  12 use self::Position::*;
  13
  14 use fmt_macros as parse;
  15
  16 use syntax::ast;
  17 use syntax::ext::base;
  18 use syntax::ext::base::*;
  19 use syntax::ext::build::AstBuilder;
  20 use syntax::feature_gate;
  21 use syntax::parse::token;
  22 use syntax::ptr::P;
  23 use syntax::symbol::Symbol;
  24 use syntax::tokenstream;
  25 use syntax_pos::{MultiSpan, Span, DUMMY_SP};
  26
  27 use std::collections::hash_map::Entry;
  28 use std::collections::{HashMap, HashSet};
  29
  30 #[derive(PartialEq)]
  31 enum ArgumentType {
  32     Placeholder(String),
  33     Count,
  34 }
  35
  36 enum Position {
  37     Exact(usize),
  38     Named(String),
  39 }
  40
  41 struct Context<'a, 'b: 'a> {
  42     ecx: &'a mut ExtCtxt<'b>,
  43     /// The macro's call site. References to unstable formatting internals must
  44     /// use this span to pass the stability checker.
  45     macsp: Span,
  46     /// The span of the format string literal.
  47     fmtsp: Span,
  48
  49     /// List of parsed argument expressions.
  50     /// Named expressions are resolved early, and are appended to the end of
  51     /// argument expressions.
  52     ///
  53     /// Example showing the various data structures in motion:
  54     ///
  55     /// * Original: `"{foo:o} {:o} {foo:x} {0:x} {1:o} {:x} {1:x} {0:o}"`
  56     /// * Implicit argument resolution: `"{foo:o} {0:o} {foo:x} {0:x} {1:o} {1:x} {1:x} {0:o}"`
  57     /// * Name resolution: `"{2:o} {0:o} {2:x} {0:x} {1:o} {1:x} {1:x} {0:o}"`
  58     /// * `arg_types` (in JSON): `[[0, 1, 0], [0, 1, 1], [0, 1]]`
  59     /// * `arg_unique_types` (in simplified JSON): `[["o", "x"], ["o", "x"], ["o", "x"]]`
  60     /// * `names` (in JSON): `{"foo": 2}`
  61     args: Vec<P<ast::Expr>>,
  62     /// Placeholder slot numbers indexed by argument.
  63     arg_types: Vec<Vec<usize>>,
  64     /// Unique format specs seen for each argument.
  65     arg_unique_types: Vec<Vec<ArgumentType>>,
  66     /// Map from named arguments to their resolved indices.
  67     names: HashMap<String, usize>,
  68
  69     /// The latest consecutive literal strings, or empty if there weren't any.
  70     literal: String,
  71
  72     /// Collection of the compiled `rt::Argument` structures
  73     pieces: Vec<P<ast::Expr>>,
  74     /// Collection of string literals
  75     str_pieces: Vec<P<ast::Expr>>,
  76     /// Stays `true` if all formatting parameters are default (as in "{}{}").
  77     all_pieces_simple: bool,
  78
  79     /// Mapping between positional argument references and indices into the
  80     /// final generated static argument array. We record the starting indices
  81     /// corresponding to each positional argument, and number of references
  82     /// consumed so far for each argument, to facilitate correct `Position`
  83     /// mapping in `build_piece`. In effect this can be seen as a "flattened"
  84     /// version of `arg_unique_types`.
  85     ///
  86     /// Again with the example described above in docstring for `args`:
  87     ///
  88     /// * `arg_index_map` (in JSON): `[[0, 1, 0], [2, 3, 3], [4, 5]]`
  89     arg_index_map: Vec<Vec<usize>>,
  90
  91     /// Starting offset of count argument slots.
  92     count_args_index_offset: usize,
  93
  94     /// Count argument slots and tracking data structures.
  95     /// Count arguments are separately tracked for de-duplication in case
  96     /// multiple references are made to one argument. For example, in this
  97     /// format string:
  98     ///
  99     /// * Original: `"{:.*} {:.foo$} {1:.*} {:.0$}"`
 100     /// * Implicit argument resolution: `"{1:.0$} {2:.foo$} {1:.3$} {4:.0$}"`
 101     /// * Name resolution: `"{1:.0$} {2:.5$} {1:.3$} {4:.0$}"`
 102     /// * `count_positions` (in JSON): `{0: 0, 5: 1, 3: 2}`
 103     /// * `count_args`: `vec![Exact(0), Exact(5), Exact(3)]`
 104     count_args: Vec<Position>,
 105     /// Relative slot numbers for count arguments.
 106     count_positions: HashMap<usize, usize>,
 107     /// Number of count slots assigned.
 108     count_positions_count: usize,
 109
 110     /// Current position of the implicit positional arg pointer, as if it
 111     /// still existed in this phase of processing.
 112     /// Used only for `all_pieces_simple` tracking in `build_piece`.
 113     curarg: usize,
 114     /// Current piece being evaluated, used for error reporting.
 115     curpiece: usize,
 116     /// Keep track of invalid references to positional arguments.
 117     invalid_refs: Vec<(usize, usize)>,
 118     /// Spans of all the formatting arguments, in order.
 119     arg_spans: Vec<Span>,
 120     /// Wether this formatting string is a literal or it comes from a macro.
 121     is_literal: bool,
 122 }
 123
 124 /// Parses the arguments from the given list of tokens, returning None
 125 /// if there's a parse error so we can continue parsing other format!
 126 /// expressions.
 127 ///
 128 /// If parsing succeeds, the return value is:
 129 ///
 130 /// ```text
 131 /// Some((fmtstr, parsed arguments, index map for named arguments))
 132 /// ```
 133 fn parse_args(ecx: &mut ExtCtxt,
 134               sp: Span,
 135               tts: &[tokenstream::TokenTree])
 136               -> Option<(P<ast::Expr>, Vec<P<ast::Expr>>, HashMap<String, usize>)> {
 137     let mut args = Vec::<P<ast::Expr>>::new();
 138     let mut names = HashMap::<String, usize>::new();
 139
 140     let mut p = ecx.new_parser_from_tts(tts);
 141
 142     if p.token == token::Eof {
 143         ecx.span_err(sp, "requires at least a format string argument");
 144         return None;
 145     }
 146     let fmtstr = panictry!(p.parse_expr());
 147     let mut named = false;
 148     while p.token != token::Eof {
 149         if !p.eat(&token::Comma) {
 150             ecx.span_err(sp, "expected token: `,`");
 151             return None;
 152         }
 153         if p.token == token::Eof {
 154             break;
 155         } // accept trailing commas
 156         if named || (p.token.is_ident() && p.look_ahead(1, |t| *t == token::Eq)) {
 157             named = true;
 158             let ident = match p.token {
 159                 token::Ident(i, _) => {
 160                     p.bump();
 161                     i
 162                 }
 163                 _ if named => {
 164                     ecx.span_err(
 165                         p.span,
 166                         "expected ident, positional arguments cannot follow named arguments",
 167                     );
 168                     return None;
 169                 }
 170                 _ => {
 171                     ecx.span_err(
 172                         p.span,
 173                         &format!(
 174                             "expected ident for named argument, found `{}`",
 175                             p.this_token_to_string()
 176                         ),
 177                     );
 178                     return None;
 179                 }
 180             };
 181             let name: &str = &ident.as_str();
 182
 183             panictry!(p.expect(&token::Eq));
 184             let e = panictry!(p.parse_expr());
 185             if let Some(prev) = names.get(name) {
 186                 ecx.struct_span_err(e.span, &format!("duplicate argument named `{}`", name))
 187                     .span_note(args[*prev].span, "previously here")
 188                     .emit();
 189                 continue;
 190             }
 191
 192             // Resolve names into slots early.
 193             // Since all the positional args are already seen at this point
 194             // if the input is valid, we can simply append to the positional
 195             // args. And remember the names.
 196             let slot = args.len();
 197             names.insert(name.to_string(), slot);
 198             args.push(e);
 199         } else {
 200             args.push(panictry!(p.parse_expr()));
 201         }
 202     }
 203     Some((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| *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.to_string()),
 245                 };
 246
 247                 let ty = Placeholder(arg.format.ty.to_string());
 248                 self.verify_arg_type(pos, ty);
 249                 self.curpiece += 1;
 250             }
 251         }
 252     }
 253
 254     fn verify_count(&mut self, c: parse::Count) {
 255         match c {
 256             parse::CountImplied |
 257             parse::CountIs(..) => {}
 258             parse::CountIsParam(i) => {
 259                 self.verify_arg_type(Exact(i), Count);
 260             }
 261             parse::CountIsName(s) => {
 262                 self.verify_arg_type(Named(s.to_string()), Count);
 263             }
 264         }
 265     }
 266
 267     fn describe_num_args(&self) -> String {
 268         match self.args.len() {
 269             0 => "no arguments were given".to_string(),
 270             1 => "there is 1 argument".to_string(),
 271             x => format!("there are {} arguments", x),
 272         }
 273     }
 274
 275     /// Handle invalid references to positional arguments. Output different
 276     /// errors for the case where all arguments are positional and for when
 277     /// there are named arguments or numbered positional arguments in the
 278     /// format string.
 279     fn report_invalid_references(&self, numbered_position_args: bool) {
 280         let mut e;
 281         let sp = if self.is_literal {
 282             MultiSpan::from_spans(self.arg_spans.clone())
 283         } else {
 284             MultiSpan::from_span(self.fmtsp)
 285         };
 286         let mut refs: Vec<_> = self
 287             .invalid_refs
 288             .iter()
 289             .map(|(r, pos)| (r.to_string(), self.arg_spans.get(*pos)))
 290             .collect();
 291
 292         if self.names.is_empty() && !numbered_position_args {
 293             e = self.ecx.mut_span_err(
 294                 sp,
 295                 &format!(
 296                     "{} positional argument{} in format string, but {}",
 297                          self.pieces.len(),
 298                          if self.pieces.len() > 1 { "s" } else { "" },
 299                     self.describe_num_args()
 300                 ),
 301             );
 302         } else {
 303             let (arg_list, mut sp) = match refs.len() {
 304                 1 => {
 305                     let (reg, pos) = refs.pop().unwrap();
 306                     (
 307                         format!("argument {}", reg),
 308                         MultiSpan::from_span(*pos.unwrap_or(&self.fmtsp)),
 309                     )
 310                 }
 311                 _ => {
 312                     let pos =
 313                         MultiSpan::from_spans(refs.iter().map(|(_, p)| *p.unwrap()).collect());
 314                     let mut refs: Vec<String> = refs.iter().map(|(s, _)| s.to_owned()).collect();
 315                     let reg = refs.pop().unwrap();
 316                     (
 317                         format!(
 318                             "arguments {head} and {tail}",
 319                             tail = reg,
 320                             head = refs.join(", ")
 321                         ),
 322                         pos,
 323                     )
 324                 }
 325             };
 326             if !self.is_literal {
 327                 sp = MultiSpan::from_span(self.fmtsp);
 328             }
 329
 330             e = self.ecx.mut_span_err(sp,
 331                 &format!("invalid reference to positional {} ({})",
 332                          arg_list,
 333                          self.describe_num_args()));
 334             e.note("positional arguments are zero-based");
 335         };
 336
 337         e.emit();
 338     }
 339
 340     /// Actually verifies and tracks a given format placeholder
 341     /// (a.k.a. argument).
 342     fn verify_arg_type(&mut self, arg: Position, ty: ArgumentType) {
 343         match arg {
 344             Exact(arg) => {
 345                 if self.args.len() <= arg {
 346                     self.invalid_refs.push((arg, self.curpiece));
 347                     return;
 348                 }
 349                 match ty {
 350                     Placeholder(_) => {
 351                         // record every (position, type) combination only once
 352                         let ref mut seen_ty = self.arg_unique_types[arg];
 353                         let i = match seen_ty.iter().position(|x| *x == ty) {
 354                             Some(i) => i,
 355                             None => {
 356                                 let i = seen_ty.len();
 357                                 seen_ty.push(ty);
 358                                 i
 359                             }
 360                         };
 361                         self.arg_types[arg].push(i);
 362                     }
 363                     Count => {
 364                         match self.count_positions.entry(arg) {
 365                             Entry::Vacant(e) => {
 366                                 let i = self.count_positions_count;
 367                                 e.insert(i);
 368                                 self.count_args.push(Exact(arg));
 369                                 self.count_positions_count += 1;
 370                             }
 371                             Entry::Occupied(_) => {}
 372                         }
 373                     }
 374                 }
 375             }
 376
 377             Named(name) => {
 378                 let idx = match self.names.get(&name) {
 379                     Some(e) => *e,
 380                     None => {
 381                         let msg = format!("there is no argument named `{}`", name);
 382                         let sp = if self.is_literal {
 383                             *self.arg_spans.get(self.curpiece).unwrap_or(&self.fmtsp)
 384                         } else {
 385                             self.fmtsp
 386                         };
 387                         let mut err = self.ecx.struct_span_err(sp, &msg[..]);
 388                         err.emit();
 389                         return;
 390                     }
 391                 };
 392                 // Treat as positional arg.
 393                 self.verify_arg_type(Exact(idx), ty)
 394             }
 395         }
 396     }
 397
 398     /// Builds the mapping between format placeholders and argument objects.
 399     fn build_index_map(&mut self) {
 400         // NOTE: Keep the ordering the same as `into_expr`'s expansion would do!
 401         let args_len = self.args.len();
 402         self.arg_index_map.reserve(args_len);
 403
 404         let mut sofar = 0usize;
 405
 406         // Map the arguments
 407         for i in 0..args_len {
 408             let ref arg_types = self.arg_types[i];
 409             let mut arg_offsets = Vec::with_capacity(arg_types.len());
 410             for offset in arg_types {
 411                 arg_offsets.push(sofar + *offset);
 412             }
 413             self.arg_index_map.push(arg_offsets);
 414             sofar += self.arg_unique_types[i].len();
 415         }
 416
 417         // Record starting index for counts, which appear just after arguments
 418         self.count_args_index_offset = sofar;
 419     }
 420
 421     fn rtpath(ecx: &ExtCtxt, s: &str) -> Vec<ast::Ident> {
 422         ecx.std_path(&["fmt", "rt", "v1", s])
 423     }
 424
 425     fn build_count(&self, c: parse::Count) -> P<ast::Expr> {
 426         let sp = self.macsp;
 427         let count = |c, arg| {
 428             let mut path = Context::rtpath(self.ecx, "Count");
 429             path.push(self.ecx.ident_of(c));
 430             match arg {
 431                 Some(arg) => self.ecx.expr_call_global(sp, path, vec![arg]),
 432                 None => self.ecx.expr_path(self.ecx.path_global(sp, path)),
 433             }
 434         };
 435         match c {
 436             parse::CountIs(i) => count("Is", Some(self.ecx.expr_usize(sp, i))),
 437             parse::CountIsParam(i) => {
 438                 // This needs mapping too, as `i` is referring to a macro
 439                 // argument.
 440                 let i = match self.count_positions.get(&i) {
 441                     Some(&i) => i,
 442                     None => 0, // error already emitted elsewhere
 443                 };
 444                 let i = i + self.count_args_index_offset;
 445                 count("Param", Some(self.ecx.expr_usize(sp, i)))
 446             }
 447             parse::CountImplied => count("Implied", None),
 448             // should never be the case, names are already resolved
 449             parse::CountIsName(_) => panic!("should never happen"),
 450         }
 451     }
 452
 453     /// Build a literal expression from the accumulated string literals
 454     fn build_literal_string(&mut self) -> P<ast::Expr> {
 455         let sp = self.fmtsp;
 456         let s = Symbol::intern(&self.literal);
 457         self.literal.clear();
 458         self.ecx.expr_str(sp, s)
 459     }
 460
 461     /// Build a static `rt::Argument` from a `parse::Piece` or append
 462     /// to the `literal` string.
 463     fn build_piece(&mut self,
 464                    piece: &parse::Piece,
 465                    arg_index_consumed: &mut Vec<usize>)
 466                    -> Option<P<ast::Expr>> {
 467         let sp = self.macsp;
 468         match *piece {
 469             parse::String(s) => {
 470                 self.literal.push_str(s);
 471                 None
 472             }
 473             parse::NextArgument(ref arg) => {
 474                 // Build the position
 475                 let pos = {
 476                     let pos = |c, arg| {
 477                         let mut path = Context::rtpath(self.ecx, "Position");
 478                         path.push(self.ecx.ident_of(c));
 479                         match arg {
 480                             Some(i) => {
 481                                 let arg = self.ecx.expr_usize(sp, i);
 482                                 self.ecx.expr_call_global(sp, path, vec![arg])
 483                             }
 484                             None => self.ecx.expr_path(self.ecx.path_global(sp, path)),
 485                         }
 486                     };
 487                     match arg.position {
 488                         parse::ArgumentIs(i)
 489                         | parse::ArgumentImplicitlyIs(i) => {
 490                             // Map to index in final generated argument array
 491                             // in case of multiple types specified
 492                             let arg_idx = match arg_index_consumed.get_mut(i) {
 493                                 None => 0, // error already emitted elsewhere
 494                                 Some(offset) => {
 495                                     let ref idx_map = self.arg_index_map[i];
 496                                     // unwrap_or branch: error already emitted elsewhere
 497                                     let arg_idx = *idx_map.get(*offset).unwrap_or(&0);
 498                                     *offset += 1;
 499                                     arg_idx
 500                                 }
 501                             };
 502                             pos("At", Some(arg_idx))
 503                         }
 504
 505                         // should never be the case, because names are already
 506                         // resolved.
 507                         parse::ArgumentNamed(_) => panic!("should never happen"),
 508                     }
 509                 };
 510
 511                 let simple_arg = parse::Argument {
 512                     position: {
 513                         // We don't have ArgumentNext any more, so we have to
 514                         // track the current argument ourselves.
 515                         let i = self.curarg;
 516                         self.curarg += 1;
 517                         parse::ArgumentIs(i)
 518                     },
 519                     format: parse::FormatSpec {
 520                         fill: arg.format.fill,
 521                         align: parse::AlignUnknown,
 522                         flags: 0,
 523                         precision: parse::CountImplied,
 524                         width: parse::CountImplied,
 525                         ty: arg.format.ty,
 526                     },
 527                 };
 528
 529                 let fill = match arg.format.fill {
 530                     Some(c) => c,
 531                     None => ' ',
 532                 };
 533
 534                 if *arg != simple_arg || fill != ' ' {
 535                     self.all_pieces_simple = false;
 536                 }
 537
 538                 // Build the format
 539                 let fill = self.ecx.expr_lit(sp, ast::LitKind::Char(fill));
 540                 let align = |name| {
 541                     let mut p = Context::rtpath(self.ecx, "Alignment");
 542                     p.push(self.ecx.ident_of(name));
 543                     self.ecx.path_global(sp, p)
 544                 };
 545                 let align = match arg.format.align {
 546                     parse::AlignLeft => align("Left"),
 547                     parse::AlignRight => align("Right"),
 548                     parse::AlignCenter => align("Center"),
 549                     parse::AlignUnknown => align("Unknown"),
 550                 };
 551                 let align = self.ecx.expr_path(align);
 552                 let flags = self.ecx.expr_u32(sp, arg.format.flags);
 553                 let prec = self.build_count(arg.format.precision);
 554                 let width = self.build_count(arg.format.width);
 555                 let path = self.ecx.path_global(sp, Context::rtpath(self.ecx, "FormatSpec"));
 556                 let fmt = self.ecx.expr_struct(
 557                     sp,
 558                                          path,
 559                     vec![
 560                         self.ecx.field_imm(sp, self.ecx.ident_of("fill"), fill),
 561                         self.ecx.field_imm(sp, self.ecx.ident_of("align"), align),
 562                         self.ecx.field_imm(sp, self.ecx.ident_of("flags"), flags),
 563                         self.ecx.field_imm(sp, self.ecx.ident_of("precision"), prec),
 564                         self.ecx.field_imm(sp, self.ecx.ident_of("width"), width),
 565                     ],
 566                 );
 567
 568                 let path = self.ecx.path_global(sp, Context::rtpath(self.ecx, "Argument"));
 569                 Some(self.ecx.expr_struct(
 570                     sp,
 571                                           path,
 572                     vec![
 573                         self.ecx.field_imm(sp, self.ecx.ident_of("position"), pos),
 574                         self.ecx.field_imm(sp, self.ecx.ident_of("format"), fmt),
 575                     ],
 576                 ))
 577             }
 578         }
 579     }
 580
 581     /// Actually builds the expression which the format_args! block will be
 582     /// expanded to
 583     fn into_expr(self) -> P<ast::Expr> {
 584         let mut locals = Vec::new();
 585         let mut counts = Vec::new();
 586         let mut pats = Vec::new();
 587         let mut heads = Vec::new();
 588
 589         let names_pos: Vec<_> = (0..self.args.len())
 590             .map(|i| self.ecx.ident_of(&format!("arg{}", i)).gensym())
 591             .collect();
 592
 593         // First, build up the static array which will become our precompiled
 594         // format "string"
 595         let pieces = self.ecx.expr_vec_slice(self.fmtsp, self.str_pieces);
 596
 597         // Before consuming the expressions, we have to remember spans for
 598         // count arguments as they are now generated separate from other
 599         // arguments, hence have no access to the `P<ast::Expr>`'s.
 600         let spans_pos: Vec<_> = self.args.iter().map(|e| e.span.clone()).collect();
 601
 602         // Right now there is a bug such that for the expression:
 603         //      foo(bar(&1))
 604         // the lifetime of `1` doesn't outlast the call to `bar`, so it's not
 605         // valid for the call to `foo`. To work around this all arguments to the
 606         // format! string are shoved into locals. Furthermore, we shove the address
 607         // of each variable because we don't want to move out of the arguments
 608         // passed to this function.
 609         for (i, e) in self.args.into_iter().enumerate() {
 610             let name = names_pos[i];
 611             let span =
 612                 DUMMY_SP.with_ctxt(e.span.ctxt().apply_mark(self.ecx.current_expansion.mark));
 613             pats.push(self.ecx.pat_ident(span, name));
 614             for ref arg_ty in self.arg_unique_types[i].iter() {
 615                 locals.push(Context::format_arg(self.ecx, self.macsp, e.span, arg_ty, name));
 616             }
 617             heads.push(self.ecx.expr_addr_of(e.span, e));
 618         }
 619         for pos in self.count_args {
 620             let index = match pos {
 621                 Exact(i) => i,
 622                 _ => panic!("should never happen"),
 623             };
 624             let name = names_pos[index];
 625             let span = spans_pos[index];
 626             counts.push(Context::format_arg(self.ecx, self.macsp, span, &Count, name));
 627         }
 628
 629         // Now create a vector containing all the arguments
 630         let args = locals.into_iter().chain(counts.into_iter());
 631
 632         let args_array = self.ecx.expr_vec(self.fmtsp, args.collect());
 633
 634         // Constructs an AST equivalent to:
 635         //
 636         //      match (&arg0, &arg1) {
 637         //          (tmp0, tmp1) => args_array
 638         //      }
 639         //
 640         // It was:
 641         //
 642         //      let tmp0 = &arg0;
 643         //      let tmp1 = &arg1;
 644         //      args_array
 645         //
 646         // Because of #11585 the new temporary lifetime rule, the enclosing
 647         // statements for these temporaries become the let's themselves.
 648         // If one or more of them are RefCell's, RefCell borrow() will also
 649         // end there; they don't last long enough for args_array to use them.
 650         // The match expression solves the scope problem.
 651         //
 652         // Note, it may also very well be transformed to:
 653         //
 654         //      match arg0 {
 655         //          ref tmp0 => {
 656         //              match arg1 => {
 657         //                  ref tmp1 => args_array } } }
 658         //
 659         // But the nested match expression is proved to perform not as well
 660         // as series of let's; the first approach does.
 661         let pat = self.ecx.pat_tuple(self.fmtsp, pats);
 662         let arm = self.ecx.arm(self.fmtsp, vec![pat], args_array);
 663         let head = self.ecx.expr(self.fmtsp, ast::ExprKind::Tup(heads));
 664         let result = self.ecx.expr_match(self.fmtsp, head, vec![arm]);
 665
 666         let args_slice = self.ecx.expr_addr_of(self.fmtsp, result);
 667
 668         // Now create the fmt::Arguments struct with all our locals we created.
 669         let (fn_name, fn_args) = if self.all_pieces_simple {
 670             ("new_v1", vec![pieces, args_slice])
 671         } else {
 672             // Build up the static array which will store our precompiled
 673             // nonstandard placeholders, if there are any.
 674             let fmt = self.ecx.expr_vec_slice(self.macsp, self.pieces);
 675
 676             ("new_v1_formatted", vec![pieces, args_slice, fmt])
 677         };
 678
 679         let path = self.ecx.std_path(&["fmt", "Arguments", fn_name]);
 680         self.ecx.expr_call_global(self.macsp, path, fn_args)
 681     }
 682
 683     fn format_arg(ecx: &ExtCtxt,
 684                   macsp: Span,
 685                   mut sp: Span,
 686                   ty: &ArgumentType,
 687                   arg: ast::Ident)
 688                   -> P<ast::Expr> {
 689         sp = sp.apply_mark(ecx.current_expansion.mark);
 690         let arg = ecx.expr_ident(sp, arg);
 691         let trait_ = match *ty {
 692             Placeholder(ref tyname) => {
 693                 match &tyname[..] {
 694                     "" => "Display",
 695                     "?" => "Debug",
 696                     "e" => "LowerExp",
 697                     "E" => "UpperExp",
 698                     "o" => "Octal",
 699                     "p" => "Pointer",
 700                     "b" => "Binary",
 701                     "x" => "LowerHex",
 702                     "X" => "UpperHex",
 703                     _ => {
 704                         ecx.span_err(sp, &format!("unknown format trait `{}`", *tyname));
 705                         "Dummy"
 706                     }
 707                 }
 708             }
 709             Count => {
 710                 let path = ecx.std_path(&["fmt", "ArgumentV1", "from_usize"]);
 711                 return ecx.expr_call_global(macsp, path, vec![arg]);
 712             }
 713         };
 714
 715         let path = ecx.std_path(&["fmt", trait_, "fmt"]);
 716         let format_fn = ecx.path_global(sp, path);
 717         let path = ecx.std_path(&["fmt", "ArgumentV1", "new"]);
 718         ecx.expr_call_global(macsp, path, vec![arg, ecx.expr_path(format_fn)])
 719     }
 720 }
 721
 722 pub fn expand_format_args<'cx>(ecx: &'cx mut ExtCtxt,
 723                                mut sp: Span,
 724                                tts: &[tokenstream::TokenTree])
 725                                -> Box<dyn base::MacResult + 'cx> {
 726     sp = sp.apply_mark(ecx.current_expansion.mark);
 727     match parse_args(ecx, sp, tts) {
 728         Some((efmt, args, names)) => {
 729             MacEager::expr(expand_preparsed_format_args(ecx, sp, efmt, args, names, false))
 730         }
 731         None => DummyResult::expr(sp),
 732     }
 733 }
 734
 735 pub fn expand_format_args_nl<'cx>(
 736     ecx: &'cx mut ExtCtxt,
 737     mut sp: Span,
 738     tts: &[tokenstream::TokenTree],
 739 ) -> Box<dyn base::MacResult + 'cx> {
 740     //if !ecx.ecfg.enable_allow_internal_unstable() {
 741
 742     // For some reason, the only one that actually works for `println` is the first check
 743     if !sp.allows_unstable()   // the enclosing span is marked as `#[allow_insternal_unsable]`
 744         && !ecx.ecfg.enable_allow_internal_unstable()  // NOTE: when is this enabled?
 745         && !ecx.ecfg.enable_format_args_nl()  // enabled using `#[feature(format_args_nl]`
 746     {
 747         feature_gate::emit_feature_err(&ecx.parse_sess,
 748                                        "format_args_nl",
 749                                        sp,
 750                                        feature_gate::GateIssue::Language,
 751                                        feature_gate::EXPLAIN_FORMAT_ARGS_NL);
 752         return base::DummyResult::expr(sp);
 753     }
 754     sp = sp.apply_mark(ecx.current_expansion.mark);
 755     match parse_args(ecx, sp, tts) {
 756         Some((efmt, args, names)) => {
 757             MacEager::expr(expand_preparsed_format_args(ecx, sp, efmt, args, names, true))
 758         }
 759         None => DummyResult::expr(sp),
 760     }
 761 }
 762
 763 /// Take the various parts of `format_args!(efmt, args..., name=names...)`
 764 /// and construct the appropriate formatting expression.
 765 pub fn expand_preparsed_format_args(ecx: &mut ExtCtxt,
 766                                     sp: Span,
 767                                     efmt: P<ast::Expr>,
 768                                     args: Vec<P<ast::Expr>>,
 769                                     names: HashMap<String, usize>,
 770                                     append_newline: bool)
 771                                     -> P<ast::Expr> {
 772     // NOTE: this verbose way of initializing `Vec<Vec<ArgumentType>>` is because
 773     // `ArgumentType` does not derive `Clone`.
 774     let arg_types: Vec<_> = (0..args.len()).map(|_| Vec::new()).collect();
 775     let arg_unique_types: Vec<_> = (0..args.len()).map(|_| Vec::new()).collect();
 776     let mut macsp = ecx.call_site();
 777     macsp = macsp.apply_mark(ecx.current_expansion.mark);
 778     let msg = "format argument must be a string literal";
 779     let fmt_sp = efmt.span;
 780     let fmt = match expr_to_spanned_string(ecx, efmt, msg) {
 781         Ok(mut fmt) if append_newline => {
 782             fmt.node.0 = Symbol::intern(&format!("{}\n", fmt.node.0));
 783             fmt
 784         }
 785         Ok(fmt) => fmt,
 786         Err(mut err) => {
 787             let sugg_fmt = match args.len() {
 788                 0 => "{}".to_string(),
 789                 _ => format!("{}{{}}", "{} ".repeat(args.len())),
 790             };
 791             err.span_suggestion(
 792                 fmt_sp.shrink_to_lo(),
 793                 "you might be missing a string literal to format with",
 794                 format!("\"{}\", ", sugg_fmt),
 795             );
 796             err.emit();
 797             return DummyResult::raw_expr(sp);
 798         }
 799     };
 800     let is_literal = match ecx.codemap().span_to_snippet(fmt_sp) {
 801         Ok(ref s) if s.starts_with("\"") || s.starts_with("r#") => true,
 802         _ => false,
 803     };
 804
 805     let mut cx = Context {
 806         ecx,
 807         args,
 808         arg_types,
 809         arg_unique_types,
 810         names,
 811         curarg: 0,
 812         curpiece: 0,
 813         arg_index_map: Vec::new(),
 814         count_args: Vec::new(),
 815         count_positions: HashMap::new(),
 816         count_positions_count: 0,
 817         count_args_index_offset: 0,
 818         literal: String::new(),
 819         pieces: Vec::new(),
 820         str_pieces: Vec::new(),
 821         all_pieces_simple: true,
 822         macsp,
 823         fmtsp: fmt.span,
 824         invalid_refs: Vec::new(),
 825         arg_spans: Vec::new(),
 826         is_literal,
 827     };
 828
 829     let fmt_str = &*fmt.node.0.as_str();
 830     let str_style = match fmt.node.1 {
 831         ast::StrStyle::Cooked => None,
 832         ast::StrStyle::Raw(raw) => Some(raw as usize),
 833     };
 834     let mut parser = parse::Parser::new(fmt_str, str_style);
 835     let mut unverified_pieces = vec![];
 836     let mut pieces = vec![];
 837
 838     while let Some(piece) = parser.next() {
 839         if !parser.errors.is_empty() {
 840             break;
 841         }
 842         unverified_pieces.push(piece);
 843     }
 844
 845     cx.arg_spans = parser.arg_places.iter()
 846         .map(|&(start, end)| fmt.span.from_inner_byte_pos(start, end))
 847         .collect();
 848
 849     // This needs to happen *after* the Parser has consumed all pieces to create all the spans
 850     for mut piece in unverified_pieces {
 851         cx.verify_piece(&piece);
 852         cx.resolve_name_inplace(&mut piece);
 853         pieces.push(piece);
 854     }
 855
 856     let numbered_position_args = pieces.iter().any(|arg: &parse::Piece| {
 857         match *arg {
 858             parse::String(_) => false,
 859             parse::NextArgument(arg) => {
 860                 match arg.position {
 861                     parse::Position::ArgumentIs(_) => true,
 862                     _ => false,
 863                 }
 864             }
 865         }
 866     });
 867
 868     cx.build_index_map();
 869
 870     let mut arg_index_consumed = vec![0usize; cx.arg_index_map.len()];
 871     for piece in pieces {
 872         if let Some(piece) = cx.build_piece(&piece, &mut arg_index_consumed) {
 873             let s = cx.build_literal_string();
 874             cx.str_pieces.push(s);
 875             cx.pieces.push(piece);
 876         }
 877     }
 878
 879     if !parser.errors.is_empty() {
 880         let err = parser.errors.remove(0);
 881         let sp = cx.fmtsp.from_inner_byte_pos(err.start, err.end);
 882         let mut e = cx.ecx.struct_span_err(sp, &format!("invalid format string: {}",
 883                                                         err.description));
 884         e.span_label(sp, err.label + " in format string");
 885         if let Some(note) = err.note {
 886             e.note(&note);
 887         }
 888         e.emit();
 889         return DummyResult::raw_expr(sp);
 890     }
 891     if !cx.literal.is_empty() {
 892         let s = cx.build_literal_string();
 893         cx.str_pieces.push(s);
 894     }
 895
 896     if cx.invalid_refs.len() >= 1 {
 897         cx.report_invalid_references(numbered_position_args);
 898     }
 899
 900     // Make sure that all arguments were used and all arguments have types.
 901     let num_pos_args = cx.args.len() - cx.names.len();
 902     let mut errs = vec![];
 903     for (i, ty) in cx.arg_types.iter().enumerate() {
 904         if ty.len() == 0 {
 905             if cx.count_positions.contains_key(&i) {
 906                 continue;
 907             }
 908             let msg = if i >= num_pos_args {
 909                 // named argument
 910                 "named argument never used"
 911             } else {
 912                 // positional argument
 913                 "argument never used"
 914             };
 915             errs.push((cx.args[i].span, msg));
 916         }
 917     }
 918     let errs_len = errs.len();
 919     if errs_len > 0 {
 920         let args_used = cx.arg_types.len() - errs_len;
 921         let args_unused = errs_len;
 922
 923         let mut diag = {
 924             if errs_len == 1 {
 925                 let (sp, msg) = errs.into_iter().next().unwrap();
 926                 cx.ecx.struct_span_err(sp, msg)
 927             } else {
 928                 let mut diag = cx.ecx.struct_span_err(
 929                     errs.iter().map(|&(sp, _)| sp).collect::<Vec<Span>>(),
 930                     "multiple unused formatting arguments",
 931                 );
 932                 diag.span_label(cx.fmtsp, "multiple missing formatting specifiers");
 933                 diag
 934             }
 935         };
 936
 937         // Used to ensure we only report translations for *one* kind of foreign format.
 938         let mut found_foreign = false;
 939         // Decide if we want to look for foreign formatting directives.
 940         if args_used < args_unused {
 941             use super::format_foreign as foreign;
 942
 943             // The set of foreign substitutions we've explained.  This prevents spamming the user
 944             // with `%d should be written as {}` over and over again.
 945             let mut explained = HashSet::new();
 946
 947             macro_rules! check_foreign {
 948                 ($kind:ident) => {{
 949                     let mut show_doc_note = false;
 950
 951                     let mut suggestions = vec![];
 952                     for sub in foreign::$kind::iter_subs(fmt_str) {
 953                         let trn = match sub.translate() {
 954                             Some(trn) => trn,
 955
 956                             // If it has no translation, don't call it out specifically.
 957                             None => continue,
 958                         };
 959
 960                         let pos = sub.position();
 961                         let sub = String::from(sub.as_str());
 962                         if explained.contains(&sub) {
 963                             continue;
 964                         }
 965                         explained.insert(sub.clone());
 966
 967                         if !found_foreign {
 968                             found_foreign = true;
 969                             show_doc_note = true;
 970                         }
 971
 972                         if let Some((start, end)) = pos {
 973                             // account for `"` and account for raw strings `r#`
 974                             let padding = str_style.map(|i| i + 2).unwrap_or(1);
 975                             let sp = fmt_sp.from_inner_byte_pos(start + padding, end + padding);
 976                             suggestions.push((sp, trn));
 977                         } else {
 978                             diag.help(&format!("`{}` should be written as `{}`", sub, trn));
 979                         }
 980                     }
 981
 982                     if show_doc_note {
 983                         diag.note(concat!(
 984                             stringify!($kind),
 985                             " formatting not supported; see the documentation for `std::fmt`",
 986                         ));
 987                     }
 988                     if suggestions.len() > 0 {
 989                         diag.multipart_suggestion(
 990                             "format specifiers use curly braces",
 991                             suggestions,
 992                         );
 993                     }
 994                 }};
 995             }
 996
 997             check_foreign!(printf);
 998             if !found_foreign {
 999                 check_foreign!(shell);
1000             }
1001         }
1002         if !found_foreign && errs_len == 1 {
1003             diag.span_label(cx.fmtsp, "formatting specifier missing");
1004         }
1005
1006         diag.emit();
1007     }
1008
1009     cx.into_expr()
1010 }