compiler/rustc_middle/src/mir/spanview.rs

   1 use rustc_hir::def_id::DefId;
   2 use rustc_middle::hir;
   3 use rustc_middle::mir::*;
   4 use rustc_middle::ty::TyCtxt;
   5 use rustc_session::config::MirSpanview;
   6 use rustc_span::{BytePos, Pos, Span, SyntaxContext};
   7
   8 use std::cmp;
   9 use std::io::{self, Write};
  10
  11 pub const TOOLTIP_INDENT: &str = "    ";
  12
  13 const CARET: char = '\u{2038}'; // Unicode `CARET`
  14 const ANNOTATION_LEFT_BRACKET: char = '\u{298a}'; // Unicode `Z NOTATION RIGHT BINDING BRACKET
  15 const ANNOTATION_RIGHT_BRACKET: char = '\u{2989}'; // Unicode `Z NOTATION LEFT BINDING BRACKET`
  16 const NEW_LINE_SPAN: &str = "</span>\n<span class=\"line\">";
  17 const HEADER: &str = r#"<!DOCTYPE html>
  18 <html>
  19 <head>"#;
  20 const START_BODY: &str = r#"</head>
  21 <body>"#;
  22 const FOOTER: &str = r#"</body>
  23 </html>"#;
  24
  25 const STYLE_SECTION: &str = r#"<style>
  26     .line {
  27         counter-increment: line;
  28     }
  29     .line:before {
  30         content: counter(line) ": ";
  31         font-family: Menlo, Monaco, monospace;
  32         font-style: italic;
  33         width: 3.8em;
  34         display: inline-block;
  35         text-align: right;
  36         filter: opacity(50%);
  37         -webkit-user-select: none;
  38     }
  39     .code {
  40         color: #dddddd;
  41         background-color: #222222;
  42         font-family: Menlo, Monaco, monospace;
  43         line-height: 1.4em;
  44         border-bottom: 2px solid #222222;
  45         white-space: pre;
  46         display: inline-block;
  47     }
  48     .odd {
  49         background-color: #55bbff;
  50         color: #223311;
  51     }
  52     .even {
  53         background-color: #ee7756;
  54         color: #551133;
  55     }
  56     .code {
  57         --index: calc(var(--layer) - 1);
  58         padding-top: calc(var(--index) * 0.15em);
  59         filter:
  60             hue-rotate(calc(var(--index) * 25deg))
  61             saturate(calc(100% - (var(--index) * 2%)))
  62             brightness(calc(100% - (var(--index) * 1.5%)));
  63     }
  64     .annotation {
  65         color: #4444ff;
  66         font-family: monospace;
  67         font-style: italic;
  68         display: none;
  69         -webkit-user-select: none;
  70     }
  71     body:active .annotation {
  72         /* requires holding mouse down anywhere on the page */
  73         display: inline-block;
  74     }
  75     span:hover .annotation {
  76         /* requires hover over a span ONLY on its first line */
  77         display: inline-block;
  78     }
  79 </style>"#;
  80
  81 /// Metadata to highlight the span of a MIR BasicBlock, Statement, or Terminator.
  82 #[derive(Clone, Debug)]
  83 pub struct SpanViewable {
  84     pub bb: BasicBlock,
  85     pub span: Span,
  86     pub id: String,
  87     pub tooltip: String,
  88 }
  89
  90 /// Write a spanview HTML+CSS file to analyze MIR element spans.
  91 pub fn write_mir_fn_spanview<'tcx, W>(
  92     tcx: TyCtxt<'tcx>,
  93     body: &Body<'tcx>,
  94     spanview: MirSpanview,
  95     title: &str,
  96     w: &mut W,
  97 ) -> io::Result<()>
  98 where
  99     W: Write,
 100 {
 101     let def_id = body.source.def_id();
 102     let hir_body = hir_body(tcx, def_id);
 103     if hir_body.is_none() {
 104         return Ok(());
 105     }
 106     let body_span = hir_body.unwrap().value.span;
 107     let mut span_viewables = Vec::new();
 108     for (bb, data) in body.basic_blocks.iter_enumerated() {
 109         match spanview {
 110             MirSpanview::Statement => {
 111                 for (i, statement) in data.statements.iter().enumerate() {
 112                     if let Some(span_viewable) =
 113                         statement_span_viewable(tcx, body_span, bb, i, statement)
 114                     {
 115                         span_viewables.push(span_viewable);
 116                     }
 117                 }
 118                 if let Some(span_viewable) = terminator_span_viewable(tcx, body_span, bb, data) {
 119                     span_viewables.push(span_viewable);
 120                 }
 121             }
 122             MirSpanview::Terminator => {
 123                 if let Some(span_viewable) = terminator_span_viewable(tcx, body_span, bb, data) {
 124                     span_viewables.push(span_viewable);
 125                 }
 126             }
 127             MirSpanview::Block => {
 128                 if let Some(span_viewable) = block_span_viewable(tcx, body_span, bb, data) {
 129                     span_viewables.push(span_viewable);
 130                 }
 131             }
 132         }
 133     }
 134     write_document(tcx, fn_span(tcx, def_id), span_viewables, title, w)?;
 135     Ok(())
 136 }
 137
 138 /// Generate a spanview HTML+CSS document for the given local function `def_id`, and a pre-generated
 139 /// list `SpanViewable`s.
 140 pub fn write_document<'tcx, W>(
 141     tcx: TyCtxt<'tcx>,
 142     spanview_span: Span,
 143     mut span_viewables: Vec<SpanViewable>,
 144     title: &str,
 145     w: &mut W,
 146 ) -> io::Result<()>
 147 where
 148     W: Write,
 149 {
 150     let mut from_pos = spanview_span.lo();
 151     let end_pos = spanview_span.hi();
 152     let source_map = tcx.sess.source_map();
 153     let start = source_map.lookup_char_pos(from_pos);
 154     let indent_to_initial_start_col = " ".repeat(start.col.to_usize());
 155     debug!(
 156         "spanview_span={:?}; source is:\n{}{}",
 157         spanview_span,
 158         indent_to_initial_start_col,
 159         source_map.span_to_snippet(spanview_span).expect("function should have printable source")
 160     );
 161     writeln!(w, "{}", HEADER)?;
 162     writeln!(w, "<title>{}</title>", title)?;
 163     writeln!(w, "{}", STYLE_SECTION)?;
 164     writeln!(w, "{}", START_BODY)?;
 165     write!(
 166         w,
 167         r#"<div class="code" style="counter-reset: line {}"><span class="line">{}"#,
 168         start.line - 1,
 169         indent_to_initial_start_col,
 170     )?;
 171     span_viewables.sort_unstable_by(|a, b| {
 172         let a = a.span;
 173         let b = b.span;
 174         if a.lo() == b.lo() {
 175             // Sort hi() in reverse order so shorter spans are attempted after longer spans.
 176             // This should give shorter spans a higher "layer", so they are not covered by
 177             // the longer spans.
 178             b.hi().partial_cmp(&a.hi())
 179         } else {
 180             a.lo().partial_cmp(&b.lo())
 181         }
 182         .unwrap()
 183     });
 184     let mut ordered_viewables = &span_viewables[..];
 185     const LOWEST_VIEWABLE_LAYER: usize = 1;
 186     let mut alt = false;
 187     while ordered_viewables.len() > 0 {
 188         debug!(
 189             "calling write_next_viewable with from_pos={}, end_pos={}, and viewables len={}",
 190             from_pos.to_usize(),
 191             end_pos.to_usize(),
 192             ordered_viewables.len()
 193         );
 194         let curr_id = &ordered_viewables[0].id;
 195         let (next_from_pos, next_ordered_viewables) = write_next_viewable_with_overlaps(
 196             tcx,
 197             from_pos,
 198             end_pos,
 199             ordered_viewables,
 200             alt,
 201             LOWEST_VIEWABLE_LAYER,
 202             w,
 203         )?;
 204         debug!(
 205             "DONE calling write_next_viewable, with new from_pos={}, \
 206              and remaining viewables len={}",
 207             next_from_pos.to_usize(),
 208             next_ordered_viewables.len()
 209         );
 210         assert!(
 211             from_pos != next_from_pos || ordered_viewables.len() != next_ordered_viewables.len(),
 212             "write_next_viewable_with_overlaps() must make a state change"
 213         );
 214         from_pos = next_from_pos;
 215         if next_ordered_viewables.len() != ordered_viewables.len() {
 216             ordered_viewables = next_ordered_viewables;
 217             if let Some(next_ordered_viewable) = ordered_viewables.first() {
 218                 if &next_ordered_viewable.id != curr_id {
 219                     alt = !alt;
 220                 }
 221             }
 222         }
 223     }
 224     if from_pos < end_pos {
 225         write_coverage_gap(tcx, from_pos, end_pos, w)?;
 226     }
 227     writeln!(w, r#"</span></div>"#)?;
 228     writeln!(w, "{}", FOOTER)?;
 229     Ok(())
 230 }
 231
 232 /// Format a string showing the start line and column, and end line and column within a file.
 233 pub fn source_range_no_file(tcx: TyCtxt<'_>, span: Span) -> String {
 234     let source_map = tcx.sess.source_map();
 235     let start = source_map.lookup_char_pos(span.lo());
 236     let end = source_map.lookup_char_pos(span.hi());
 237     format!("{}:{}-{}:{}", start.line, start.col.to_usize() + 1, end.line, end.col.to_usize() + 1)
 238 }
 239
 240 pub fn statement_kind_name(statement: &Statement<'_>) -> &'static str {
 241     use StatementKind::*;
 242     match statement.kind {
 243         Assign(..) => "Assign",
 244         FakeRead(..) => "FakeRead",
 245         SetDiscriminant { .. } => "SetDiscriminant",
 246         Deinit(..) => "Deinit",
 247         StorageLive(..) => "StorageLive",
 248         StorageDead(..) => "StorageDead",
 249         Retag(..) => "Retag",
 250         AscribeUserType(..) => "AscribeUserType",
 251         Coverage(..) => "Coverage",
 252         Intrinsic(..) => "Intrinsic",
 253         ConstEvalCounter => "ConstEvalCounter",
 254         Nop => "Nop",
 255     }
 256 }
 257
 258 pub fn terminator_kind_name(term: &Terminator<'_>) -> &'static str {
 259     use TerminatorKind::*;
 260     match term.kind {
 261         Goto { .. } => "Goto",
 262         SwitchInt { .. } => "SwitchInt",
 263         Resume => "Resume",
 264         Abort => "Abort",
 265         Return => "Return",
 266         Unreachable => "Unreachable",
 267         Drop { .. } => "Drop",
 268         DropAndReplace { .. } => "DropAndReplace",
 269         Call { .. } => "Call",
 270         Assert { .. } => "Assert",
 271         Yield { .. } => "Yield",
 272         GeneratorDrop => "GeneratorDrop",
 273         FalseEdge { .. } => "FalseEdge",
 274         FalseUnwind { .. } => "FalseUnwind",
 275         InlineAsm { .. } => "InlineAsm",
 276     }
 277 }
 278
 279 fn statement_span_viewable<'tcx>(
 280     tcx: TyCtxt<'tcx>,
 281     body_span: Span,
 282     bb: BasicBlock,
 283     i: usize,
 284     statement: &Statement<'tcx>,
 285 ) -> Option<SpanViewable> {
 286     let span = statement.source_info.span;
 287     if !body_span.contains(span) {
 288         return None;
 289     }
 290     let id = format!("{}[{}]", bb.index(), i);
 291     let tooltip = tooltip(tcx, &id, span, vec![statement.clone()], &None);
 292     Some(SpanViewable { bb, span, id, tooltip })
 293 }
 294
 295 fn terminator_span_viewable<'tcx>(
 296     tcx: TyCtxt<'tcx>,
 297     body_span: Span,
 298     bb: BasicBlock,
 299     data: &BasicBlockData<'tcx>,
 300 ) -> Option<SpanViewable> {
 301     let term = data.terminator();
 302     let span = term.source_info.span;
 303     if !body_span.contains(span) {
 304         return None;
 305     }
 306     let id = format!("{}:{}", bb.index(), terminator_kind_name(term));
 307     let tooltip = tooltip(tcx, &id, span, vec![], &data.terminator);
 308     Some(SpanViewable { bb, span, id, tooltip })
 309 }
 310
 311 fn block_span_viewable<'tcx>(
 312     tcx: TyCtxt<'tcx>,
 313     body_span: Span,
 314     bb: BasicBlock,
 315     data: &BasicBlockData<'tcx>,
 316 ) -> Option<SpanViewable> {
 317     let span = compute_block_span(data, body_span);
 318     if !body_span.contains(span) {
 319         return None;
 320     }
 321     let id = format!("{}", bb.index());
 322     let tooltip = tooltip(tcx, &id, span, data.statements.clone(), &data.terminator);
 323     Some(SpanViewable { bb, span, id, tooltip })
 324 }
 325
 326 fn compute_block_span(data: &BasicBlockData<'_>, body_span: Span) -> Span {
 327     let mut span = data.terminator().source_info.span;
 328     for statement_span in data.statements.iter().map(|statement| statement.source_info.span) {
 329         // Only combine Spans from the root context, and within the function's body_span.
 330         if statement_span.ctxt() == SyntaxContext::root() && body_span.contains(statement_span) {
 331             span = span.to(statement_span);
 332         }
 333     }
 334     span
 335 }
 336
 337 /// Recursively process each ordered span. Spans that overlap will have progressively varying
 338 /// styles, such as increased padding for each overlap. Non-overlapping adjacent spans will
 339 /// have alternating style choices, to help distinguish between them if, visually adjacent.
 340 /// The `layer` is incremented for each overlap, and the `alt` bool alternates between true
 341 /// and false, for each adjacent non-overlapping span. Source code between the spans (code
 342 /// that is not in any coverage region) has neutral styling.
 343 fn write_next_viewable_with_overlaps<'tcx, 'b, W>(
 344     tcx: TyCtxt<'tcx>,
 345     mut from_pos: BytePos,
 346     mut to_pos: BytePos,
 347     ordered_viewables: &'b [SpanViewable],
 348     alt: bool,
 349     layer: usize,
 350     w: &mut W,
 351 ) -> io::Result<(BytePos, &'b [SpanViewable])>
 352 where
 353     W: Write,
 354 {
 355     let debug_indent = "  ".repeat(layer);
 356     let (viewable, mut remaining_viewables) =
 357         ordered_viewables.split_first().expect("ordered_viewables should have some");
 358
 359     if from_pos < viewable.span.lo() {
 360         debug!(
 361             "{}advance from_pos to next SpanViewable (from from_pos={} to viewable.span.lo()={} \
 362              of {:?}), with to_pos={}",
 363             debug_indent,
 364             from_pos.to_usize(),
 365             viewable.span.lo().to_usize(),
 366             viewable.span,
 367             to_pos.to_usize()
 368         );
 369         let hi = cmp::min(viewable.span.lo(), to_pos);
 370         write_coverage_gap(tcx, from_pos, hi, w)?;
 371         from_pos = hi;
 372         if from_pos < viewable.span.lo() {
 373             debug!(
 374                 "{}EARLY RETURN: stopped before getting to next SpanViewable, at {}",
 375                 debug_indent,
 376                 from_pos.to_usize()
 377             );
 378             return Ok((from_pos, ordered_viewables));
 379         }
 380     }
 381
 382     if from_pos < viewable.span.hi() {
 383         // Set to_pos to the end of this `viewable` to ensure the recursive calls stop writing
 384         // with room to print the tail.
 385         to_pos = cmp::min(viewable.span.hi(), to_pos);
 386         debug!(
 387             "{}update to_pos (if not closer) to viewable.span.hi()={}; to_pos is now {}",
 388             debug_indent,
 389             viewable.span.hi().to_usize(),
 390             to_pos.to_usize()
 391         );
 392     }
 393
 394     let mut subalt = false;
 395     while remaining_viewables.len() > 0 && remaining_viewables[0].span.overlaps(viewable.span) {
 396         let overlapping_viewable = &remaining_viewables[0];
 397         debug!("{}overlapping_viewable.span={:?}", debug_indent, overlapping_viewable.span);
 398
 399         let span =
 400             trim_span(viewable.span, from_pos, cmp::min(overlapping_viewable.span.lo(), to_pos));
 401         let mut some_html_snippet = if from_pos <= viewable.span.hi() || viewable.span.is_empty() {
 402             // `viewable` is not yet fully rendered, so start writing the span, up to either the
 403             // `to_pos` or the next `overlapping_viewable`, whichever comes first.
 404             debug!(
 405                 "{}make html_snippet (may not write it if early exit) for partial span {:?} \
 406                  of viewable.span {:?}",
 407                 debug_indent, span, viewable.span
 408             );
 409             from_pos = span.hi();
 410             make_html_snippet(tcx, span, Some(&viewable))
 411         } else {
 412             None
 413         };
 414
 415         // Defer writing the HTML snippet (until after early return checks) ONLY for empty spans.
 416         // An empty Span with Some(html_snippet) is probably a tail marker. If there is an early
 417         // exit, there should be another opportunity to write the tail marker.
 418         if !span.is_empty() {
 419             if let Some(ref html_snippet) = some_html_snippet {
 420                 debug!(
 421                     "{}write html_snippet for that partial span of viewable.span {:?}",
 422                     debug_indent, viewable.span
 423                 );
 424                 write_span(html_snippet, &viewable.tooltip, alt, layer, w)?;
 425             }
 426             some_html_snippet = None;
 427         }
 428
 429         if from_pos < overlapping_viewable.span.lo() {
 430             debug!(
 431                 "{}EARLY RETURN: from_pos={} has not yet reached the \
 432                  overlapping_viewable.span {:?}",
 433                 debug_indent,
 434                 from_pos.to_usize(),
 435                 overlapping_viewable.span
 436             );
 437             // must have reached `to_pos` before reaching the start of the
 438             // `overlapping_viewable.span`
 439             return Ok((from_pos, ordered_viewables));
 440         }
 441
 442         if from_pos == to_pos
 443             && !(from_pos == overlapping_viewable.span.lo() && overlapping_viewable.span.is_empty())
 444         {
 445             debug!(
 446                 "{}EARLY RETURN: from_pos=to_pos={} and overlapping_viewable.span {:?} is not \
 447                  empty, or not from_pos",
 448                 debug_indent,
 449                 to_pos.to_usize(),
 450                 overlapping_viewable.span
 451             );
 452             // `to_pos` must have occurred before the overlapping viewable. Return
 453             // `ordered_viewables` so we can continue rendering the `viewable`, from after the
 454             // `to_pos`.
 455             return Ok((from_pos, ordered_viewables));
 456         }
 457
 458         if let Some(ref html_snippet) = some_html_snippet {
 459             debug!(
 460                 "{}write html_snippet for that partial span of viewable.span {:?}",
 461                 debug_indent, viewable.span
 462             );
 463             write_span(html_snippet, &viewable.tooltip, alt, layer, w)?;
 464         }
 465
 466         debug!(
 467             "{}recursively calling write_next_viewable with from_pos={}, to_pos={}, \
 468              and viewables len={}",
 469             debug_indent,
 470             from_pos.to_usize(),
 471             to_pos.to_usize(),
 472             remaining_viewables.len()
 473         );
 474         // Write the overlaps (and the overlaps' overlaps, if any) up to `to_pos`.
 475         let curr_id = &remaining_viewables[0].id;
 476         let (next_from_pos, next_remaining_viewables) = write_next_viewable_with_overlaps(
 477             tcx,
 478             from_pos,
 479             to_pos,
 480             &remaining_viewables,
 481             subalt,
 482             layer + 1,
 483             w,
 484         )?;
 485         debug!(
 486             "{}DONE recursively calling write_next_viewable, with new from_pos={}, and remaining \
 487              viewables len={}",
 488             debug_indent,
 489             next_from_pos.to_usize(),
 490             next_remaining_viewables.len()
 491         );
 492         assert!(
 493             from_pos != next_from_pos
 494                 || remaining_viewables.len() != next_remaining_viewables.len(),
 495             "write_next_viewable_with_overlaps() must make a state change"
 496         );
 497         from_pos = next_from_pos;
 498         if next_remaining_viewables.len() != remaining_viewables.len() {
 499             remaining_viewables = next_remaining_viewables;
 500             if let Some(next_ordered_viewable) = remaining_viewables.first() {
 501                 if &next_ordered_viewable.id != curr_id {
 502                     subalt = !subalt;
 503                 }
 504             }
 505         }
 506     }
 507     if from_pos <= viewable.span.hi() {
 508         let span = trim_span(viewable.span, from_pos, to_pos);
 509         debug!(
 510             "{}After overlaps, writing (end span?) {:?} of viewable.span {:?}",
 511             debug_indent, span, viewable.span
 512         );
 513         if let Some(ref html_snippet) = make_html_snippet(tcx, span, Some(&viewable)) {
 514             from_pos = span.hi();
 515             write_span(html_snippet, &viewable.tooltip, alt, layer, w)?;
 516         }
 517     }
 518     debug!("{}RETURN: No more overlap", debug_indent);
 519     Ok((
 520         from_pos,
 521         if from_pos < viewable.span.hi() { ordered_viewables } else { remaining_viewables },
 522     ))
 523 }
 524
 525 #[inline(always)]
 526 fn write_coverage_gap<W>(tcx: TyCtxt<'_>, lo: BytePos, hi: BytePos, w: &mut W) -> io::Result<()>
 527 where
 528     W: Write,
 529 {
 530     let span = Span::with_root_ctxt(lo, hi);
 531     if let Some(ref html_snippet) = make_html_snippet(tcx, span, None) {
 532         write_span(html_snippet, "", false, 0, w)
 533     } else {
 534         Ok(())
 535     }
 536 }
 537
 538 fn write_span<W>(
 539     html_snippet: &str,
 540     tooltip: &str,
 541     alt: bool,
 542     layer: usize,
 543     w: &mut W,
 544 ) -> io::Result<()>
 545 where
 546     W: Write,
 547 {
 548     let maybe_alt_class = if layer > 0 {
 549         if alt { " odd" } else { " even" }
 550     } else {
 551         ""
 552     };
 553     let maybe_title_attr = if !tooltip.is_empty() {
 554         format!(" title=\"{}\"", escape_attr(tooltip))
 555     } else {
 556         "".to_owned()
 557     };
 558     if layer == 1 {
 559         write!(w, "<span>")?;
 560     }
 561     for (i, line) in html_snippet.lines().enumerate() {
 562         if i > 0 {
 563             write!(w, "{}", NEW_LINE_SPAN)?;
 564         }
 565         write!(
 566             w,
 567             r#"<span class="code{}" style="--layer: {}"{}>{}</span>"#,
 568             maybe_alt_class, layer, maybe_title_attr, line
 569         )?;
 570     }
 571     // Check for and translate trailing newlines, because `str::lines()` ignores them
 572     if html_snippet.ends_with('\n') {
 573         write!(w, "{}", NEW_LINE_SPAN)?;
 574     }
 575     if layer == 1 {
 576         write!(w, "</span>")?;
 577     }
 578     Ok(())
 579 }
 580
 581 fn make_html_snippet(
 582     tcx: TyCtxt<'_>,
 583     span: Span,
 584     some_viewable: Option<&SpanViewable>,
 585 ) -> Option<String> {
 586     let source_map = tcx.sess.source_map();
 587     let snippet = source_map
 588         .span_to_snippet(span)
 589         .unwrap_or_else(|err| bug!("span_to_snippet error for span {:?}: {:?}", span, err));
 590     let html_snippet = if let Some(viewable) = some_viewable {
 591         let is_head = span.lo() == viewable.span.lo();
 592         let is_tail = span.hi() == viewable.span.hi();
 593         let mut labeled_snippet = if is_head {
 594             format!(r#"<span class="annotation">{}{}</span>"#, viewable.id, ANNOTATION_LEFT_BRACKET)
 595         } else {
 596             "".to_owned()
 597         };
 598         if span.is_empty() {
 599             if is_head && is_tail {
 600                 labeled_snippet.push(CARET);
 601             }
 602         } else {
 603             labeled_snippet.push_str(&escape_html(&snippet));
 604         };
 605         if is_tail {
 606             labeled_snippet.push_str(&format!(
 607                 r#"<span class="annotation">{}{}</span>"#,
 608                 ANNOTATION_RIGHT_BRACKET, viewable.id
 609             ));
 610         }
 611         labeled_snippet
 612     } else {
 613         escape_html(&snippet)
 614     };
 615     if html_snippet.is_empty() { None } else { Some(html_snippet) }
 616 }
 617
 618 fn tooltip<'tcx>(
 619     tcx: TyCtxt<'tcx>,
 620     spanview_id: &str,
 621     span: Span,
 622     statements: Vec<Statement<'tcx>>,
 623     terminator: &Option<Terminator<'tcx>>,
 624 ) -> String {
 625     let source_map = tcx.sess.source_map();
 626     let mut text = Vec::new();
 627     text.push(format!("{}: {}:", spanview_id, &source_map.span_to_embeddable_string(span)));
 628     for statement in statements {
 629         let source_range = source_range_no_file(tcx, statement.source_info.span);
 630         text.push(format!(
 631             "\n{}{}: {}: {:?}",
 632             TOOLTIP_INDENT,
 633             source_range,
 634             statement_kind_name(&statement),
 635             statement
 636         ));
 637     }
 638     if let Some(term) = terminator {
 639         let source_range = source_range_no_file(tcx, term.source_info.span);
 640         text.push(format!(
 641             "\n{}{}: {}: {:?}",
 642             TOOLTIP_INDENT,
 643             source_range,
 644             terminator_kind_name(term),
 645             term.kind
 646         ));
 647     }
 648     text.join("")
 649 }
 650
 651 fn trim_span(span: Span, from_pos: BytePos, to_pos: BytePos) -> Span {
 652     trim_span_hi(trim_span_lo(span, from_pos), to_pos)
 653 }
 654
 655 fn trim_span_lo(span: Span, from_pos: BytePos) -> Span {
 656     if from_pos <= span.lo() { span } else { span.with_lo(cmp::min(span.hi(), from_pos)) }
 657 }
 658
 659 fn trim_span_hi(span: Span, to_pos: BytePos) -> Span {
 660     if to_pos >= span.hi() { span } else { span.with_hi(cmp::max(span.lo(), to_pos)) }
 661 }
 662
 663 fn fn_span(tcx: TyCtxt<'_>, def_id: DefId) -> Span {
 664     let fn_decl_span = tcx.def_span(def_id);
 665     if let Some(body_span) = hir_body(tcx, def_id).map(|hir_body| hir_body.value.span) {
 666         if fn_decl_span.eq_ctxt(body_span) { fn_decl_span.to(body_span) } else { body_span }
 667     } else {
 668         fn_decl_span
 669     }
 670 }
 671
 672 fn hir_body(tcx: TyCtxt<'_>, def_id: DefId) -> Option<&rustc_hir::Body<'_>> {
 673     let hir_node = tcx.hir().get_if_local(def_id).expect("expected DefId is local");
 674     hir::map::associated_body(hir_node).map(|(_, fn_body_id)| tcx.hir().body(fn_body_id))
 675 }
 676
 677 fn escape_html(s: &str) -> String {
 678     s.replace('&', "&amp;").replace('<', "&lt;").replace('>', "&gt;")
 679 }
 680
 681 fn escape_attr(s: &str) -> String {
 682     s.replace('&', "&amp;")
 683         .replace('\"', "&quot;")
 684         .replace('\'', "&#39;")
 685         .replace('<', "&lt;")
 686         .replace('>', "&gt;")
 687 }