Skip to content
This repository was archived by the owner on May 28, 2025. It is now read-only.

Commit 37dbe86

Browse files
cbeuwcbeuw
committed
Split span_to_string into span_to_diagnostic/embeddable_string
1 parent 0ac9ca4 commit 37dbe86

File tree

13 files changed

+60
-24
lines changed

13 files changed

+60
-24
lines changed

‎compiler/rustc_middle/src/hir/map/collector.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ impl<'a, 'hir> NodeCollector<'a, 'hir> {
262262
span,
263263
"inconsistent DepNode at `{:?}` for `{}`: \
264264
current_dep_node_owner={} ({:?}), hir_id.owner={} ({:?})",
265-
self.source_map.span_to_string(span),
265+
self.source_map.span_to_diagnostic_string(span),
266266
node_str,
267267
self.definitions
268268
.def_path(self.current_dep_node_owner)

‎compiler/rustc_middle/src/mir/mod.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2365,7 +2365,10 @@ impl<'tcx> Debug for Rvalue<'tcx> {
23652365
)
23662366
} else {
23672367
let span = tcx.hir().span(hir_id);
2368-
format!("[closure@{}]", tcx.sess.source_map().span_to_string(span))
2368+
format!(
2369+
"[closure@{}]",
2370+
tcx.sess.source_map().span_to_diagnostic_string(span)
2371+
)
23692372
};
23702373
let mut struct_fmt = fmt.debug_struct(&name);
23712374

‎compiler/rustc_middle/src/ty/print/pretty.rs

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -667,7 +667,12 @@ pub trait PrettyPrinter<'tcx>:
667667
if let Some(did) = did.as_local() {
668668
let hir_id = self.tcx().hir().local_def_id_to_hir_id(did);
669669
let span = self.tcx().hir().span(hir_id);
670-
p!(write("@{}", self.tcx().sess.source_map().span_to_string(span)));
670+
p!(write(
671+
"@{}",
672+
// This may end up in stderr diagnostics but it may also be emitted
673+
// into MIR. Hence we use the remapped path if available
674+
self.tcx().sess.source_map().span_to_embeddable_string(span)
675+
));
671676
} else {
672677
p!(write("@"), print_def_path(did, substs));
673678
}
@@ -702,7 +707,12 @@ pub trait PrettyPrinter<'tcx>:
702707
p!("@", print_def_path(did.to_def_id(), substs));
703708
} else {
704709
let span = self.tcx().hir().span(hir_id);
705-
p!(write("@{}", self.tcx().sess.source_map().span_to_string(span)));
710+
p!(write(
711+
"@{}",
712+
// This may end up in stderr diagnostics but it may also be emitted
713+
// into MIR. Hence we use the remapped path if available
714+
self.tcx().sess.source_map().span_to_embeddable_string(span)
715+
));
706716
}
707717
} else {
708718
p!(write("@"), print_def_path(did, substs));
@@ -1407,7 +1417,13 @@ impl<F: fmt::Write> Printer<'tcx> for FmtPrinter<'_, 'tcx, F> {
14071417
if !self.empty_path {
14081418
write!(self, "::")?;
14091419
}
1410-
write!(self, "<impl at {}>", self.tcx.sess.source_map().span_to_string(span))?;
1420+
write!(
1421+
self,
1422+
"<impl at {}>",
1423+
// This may end up in stderr diagnostics but it may also be emitted
1424+
// into MIR. Hence we use the remapped path if available
1425+
self.tcx.sess.source_map().span_to_embeddable_string(span)
1426+
)?;
14111427
self.empty_path = false;
14121428

14131429
return Ok(self);

‎compiler/rustc_mir/src/borrow_check/region_infer/dump_mir.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,9 @@ impl<'tcx> RegionInferenceContext<'tcx> {
7676
for constraint in &constraints {
7777
let OutlivesConstraint { sup, sub, locations, category } = constraint;
7878
let (name, arg) = match locations {
79-
Locations::All(span) => ("All", tcx.sess.source_map().span_to_string(*span)),
79+
Locations::All(span) => {
80+
("All", tcx.sess.source_map().span_to_embeddable_string(*span))
81+
}
8082
Locations::Single(loc) => ("Single", format!("{:?}", loc)),
8183
};
8284
with_msg(&format!("{:?}: {:?} due to {:?} at {}({})", sup, sub, category, name, arg))?;

‎compiler/rustc_mir/src/transform/coverage/mod.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -148,8 +148,8 @@ impl<'a, 'tcx> Instrumentor<'a, 'tcx> {
148148
debug!(
149149
"instrumenting {:?}, fn sig span: {}, body span: {}",
150150
def_id,
151-
source_map.span_to_string(fn_sig_span),
152-
source_map.span_to_string(body_span)
151+
source_map.span_to_diagnostic_string(fn_sig_span),
152+
source_map.span_to_diagnostic_string(body_span)
153153
);
154154

155155
let mut graphviz_data = debug::GraphvizData::new();
@@ -311,8 +311,8 @@ impl<'a, 'tcx> Instrumentor<'a, 'tcx> {
311311
"Calling make_code_region(file_name={}, source_file={:?}, span={}, body_span={})",
312312
file_name,
313313
self.source_file,
314-
source_map.span_to_string(span),
315-
source_map.span_to_string(body_span)
314+
source_map.span_to_diagnostic_string(span),
315+
source_map.span_to_diagnostic_string(body_span)
316316
);
317317

318318
inject_statement(

‎compiler/rustc_mir/src/util/pretty.rs

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -445,7 +445,10 @@ impl Visitor<'tcx> for ExtraComments<'tcx> {
445445
ty::Tuple(tys) if tys.is_empty() => {}
446446
_ => {
447447
self.push("mir::Constant");
448-
self.push(&format!("+ span: {}", self.tcx.sess.source_map().span_to_string(*span)));
448+
self.push(&format!(
449+
"+ span: {}",
450+
self.tcx.sess.source_map().span_to_embeddable_string(*span)
451+
));
449452
if let Some(user_ty) = user_ty {
450453
self.push(&format!("+ user_ty: {:?}", user_ty));
451454
}
@@ -516,7 +519,7 @@ impl Visitor<'tcx> for ExtraComments<'tcx> {
516519
}
517520

518521
fn comment(tcx: TyCtxt<'_>, SourceInfo { span, scope }: SourceInfo) -> String {
519-
format!("scope {} at {}", scope.index(), tcx.sess.source_map().span_to_string(span))
522+
format!("scope {} at {}", scope.index(), tcx.sess.source_map().span_to_embeddable_string(span))
520523
}
521524

522525
/// Prints local variables in a scope tree.
@@ -617,7 +620,7 @@ fn write_scope_tree(
617620
"{0:1$} // at {2}",
618621
indented_header,
619622
ALIGN,
620-
tcx.sess.source_map().span_to_string(span),
623+
tcx.sess.source_map().span_to_embeddable_string(span),
621624
)?;
622625
} else {
623626
writeln!(w, "{}", indented_header)?;
@@ -1004,7 +1007,7 @@ fn write_user_type_annotations(
10041007
"| {:?}: {:?} at {}",
10051008
index.index(),
10061009
annotation.user_ty,
1007-
tcx.sess.source_map().span_to_string(annotation.span)
1010+
tcx.sess.source_map().span_to_embeddable_string(annotation.span)
10081011
)?;
10091012
}
10101013
if !body.user_type_annotations.is_empty() {

‎compiler/rustc_mir/src/util/spanview.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -628,7 +628,7 @@ fn tooltip<'tcx>(
628628
) -> String {
629629
let source_map = tcx.sess.source_map();
630630
let mut text = Vec::new();
631-
text.push(format!("{}: {}:", spanview_id, &source_map.span_to_string(span)));
631+
text.push(format!("{}: {}:", spanview_id, &source_map.span_to_embeddable_string(span)));
632632
for statement in statements {
633633
let source_range = source_range_no_file(tcx, &statement.source_info.span);
634634
text.push(format!(

‎compiler/rustc_passes/src/liveness.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -132,9 +132,9 @@ enum LiveNodeKind {
132132
fn live_node_kind_to_string(lnk: LiveNodeKind, tcx: TyCtxt<'_>) -> String {
133133
let sm = tcx.sess.source_map();
134134
match lnk {
135-
UpvarNode(s) => format!("Upvar node [{}]", sm.span_to_string(s)),
136-
ExprNode(s) => format!("Expr node [{}]", sm.span_to_string(s)),
137-
VarDefNode(s) => format!("Var def node [{}]", sm.span_to_string(s)),
135+
UpvarNode(s) => format!("Upvar node [{}]", sm.span_to_diagnostic_string(s)),
136+
ExprNode(s) => format!("Expr node [{}]", sm.span_to_diagnostic_string(s)),
137+
VarDefNode(s) => format!("Var def node [{}]", sm.span_to_diagnostic_string(s)),
138138
ClosureNode => "Closure node".to_owned(),
139139
ExitNode => "Exit node".to_owned(),
140140
}

‎compiler/rustc_passes/src/region.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -717,7 +717,7 @@ impl<'tcx> Visitor<'tcx> for RegionResolutionVisitor<'tcx> {
717717
debug!(
718718
"visit_body(id={:?}, span={:?}, body.id={:?}, cx.parent={:?})",
719719
owner_id,
720-
self.tcx.sess.source_map().span_to_string(body.value.span),
720+
self.tcx.sess.source_map().span_to_diagnostic_string(body.value.span),
721721
body_id,
722722
self.cx.parent
723723
);

‎compiler/rustc_resolve/src/late/lifetimes.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3347,7 +3347,7 @@ impl<'a, 'tcx> LifetimeContext<'a, 'tcx> {
33473347
fn insert_lifetime(&mut self, lifetime_ref: &'tcx hir::Lifetime, def: Region) {
33483348
debug!(
33493349
node = ?self.tcx.hir().node_to_string(lifetime_ref.hir_id),
3350-
span = ?self.tcx.sess.source_map().span_to_string(lifetime_ref.span)
3350+
span = ?self.tcx.sess.source_map().span_to_diagnostic_string(lifetime_ref.span)
33513351
);
33523352
self.map.defs.insert(lifetime_ref.hir_id, def);
33533353

‎compiler/rustc_span/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -872,7 +872,7 @@ pub fn debug_with_source_map(
872872
f: &mut fmt::Formatter<'_>,
873873
source_map: &SourceMap,
874874
) -> fmt::Result {
875-
write!(f, "{} ({:?})", source_map.span_to_string(span), span.ctxt())
875+
write!(f, "{} ({:?})", source_map.span_to_diagnostic_string(span), span.ctxt())
876876
}
877877

878878
pub fn default_span_debug(span: Span, f: &mut fmt::Formatter<'_>) -> fmt::Result {

‎compiler/rustc_span/src/source_map.rs

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -406,7 +406,7 @@ impl SourceMap {
406406
}
407407
}
408408

409-
pub fn span_to_string(&self, sp: Span) -> String {
409+
fn span_to_string(&self, sp: Span, prefer_local: bool) -> String {
410410
if self.files.borrow().source_files.is_empty() && sp.is_dummy() {
411411
return "no-location".to_string();
412412
}
@@ -415,14 +415,26 @@ impl SourceMap {
415415
let hi = self.lookup_char_pos(sp.hi());
416416
format!(
417417
"{}:{}:{}: {}:{}",
418-
lo.file.name.prefer_remapped(),
418+
if prefer_local { lo.file.name.prefer_local() } else { lo.file.name.prefer_remapped() },
419419
lo.line,
420420
lo.col.to_usize() + 1,
421421
hi.line,
422422
hi.col.to_usize() + 1,
423423
)
424424
}
425425

426+
/// Format the span location suitable for embedding in build artifacts
427+
pub fn span_to_embeddable_string(&self, sp: Span) -> String {
428+
self.span_to_string(sp, false)
429+
}
430+
431+
/// Format the span location to be printed in diagnostics. Must not be emitted
432+
/// to build artifacts as this may leak local file paths. Use span_to_embeddable_string
433+
/// for string suitable for embedding.
434+
pub fn span_to_diagnostic_string(&self, sp: Span) -> String {
435+
self.span_to_string(sp, true)
436+
}
437+
426438
pub fn span_to_filename(&self, sp: Span) -> FileName {
427439
self.lookup_char_pos(sp.lo()).file.name.clone()
428440
}

‎compiler/rustc_span/src/source_map/tests.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ fn t8() {
193193
fn t9() {
194194
let sm = init_source_map();
195195
let span = Span::with_root_ctxt(BytePos(12), BytePos(23));
196-
let sstr = sm.span_to_string(span);
196+
let sstr = sm.span_to_diagnostic_string(span);
197197

198198
assert_eq!(sstr, "blork.rs:2:1: 2:12");
199199
}

0 commit comments

Comments
 (0)