Skip to content

Commit 934127c

Browse files
authored
Rollup merge of rust-lang#76003 - richkadel:llvm-coverage-map-gen-6b.4, r=wesleywiser
Adds two source span utility functions used in source-based coverage `span.is_empty()` - returns true if `lo()` and `hi()` are equal. This is not only a convenience, but makes it clear that a `Span` can be empty (that is, retrieving the source for an empty `Span` will return an empty string), and codifies the (otherwise undocumented--in the rustc_span package, at least) fact that `Span` is a half-open interval (where `hi()` is the open end). `source_map.lookup_file_span()` - returns an enclosing `Span` representing the start and end positions of the file enclosing the given `BytePos`. This gives developers a clear way to quickly determine if any any other `BytePos` or `Span` is also from the same file (for example, by simply calling `file_span.contains(span)`). This results in much simpler code and is much more runtime efficient compared with the obvious alternative: calling `source_map.lookup_line()` for any two `Span`'s byte positions, handle both arms of the `Result` (both contain the file), and then compare files. It is also more efficient than the non-public method `lookup_source_file_idx()` for each `BytePos`, because, while comparing the internal source file indexes would be efficient, looking up the source file index for every `BytePos` or `Span` to be compared requires a binary search (worst case performance being O(log n) for every lookup). `source_map.lookup_file_span()` performs the binary search only once, to get the `file_span` result that can be used to compare to any number of other `BytePos` or `Span` values and those comparisons are always O(1). This PR was split out from PR rust-lang#75828 . r? @tmandry FYI: @wesleywiser
2 parents 6d834a4 + 7225f66 commit 934127c

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

compiler/rustc_span/src/lib.rs

+7
Original file line numberDiff line numberDiff line change
@@ -400,6 +400,13 @@ impl Span {
400400
span.with_lo(span.hi)
401401
}
402402

403+
#[inline]
404+
/// Returns true if hi == lo
405+
pub fn is_empty(&self) -> bool {
406+
let span = self.data();
407+
span.hi == span.lo
408+
}
409+
403410
/// Returns `self` if `self` is not the dummy span, and `other` otherwise.
404411
pub fn substitute_dummy(self, other: Span) -> Span {
405412
if self.is_dummy() { other } else { self }

compiler/rustc_span/src/source_map.rs

+9
Original file line numberDiff line numberDiff line change
@@ -487,6 +487,15 @@ impl SourceMap {
487487
}
488488
}
489489

490+
/// Returns a new `Span` covering the start and end `BytePos`s of the file containing the given
491+
/// `pos`. This can be used to quickly determine if another `BytePos` or `Span` is from the same
492+
/// file.
493+
pub fn lookup_file_span(&self, pos: BytePos) -> Span {
494+
let idx = self.lookup_source_file_idx(pos);
495+
let SourceFile { start_pos, end_pos, .. } = *(*self.files.borrow().source_files)[idx];
496+
Span::with_root_ctxt(start_pos, end_pos)
497+
}
498+
490499
/// Returns `Some(span)`, a union of the LHS and RHS span. The LHS must precede the RHS. If
491500
/// there are gaps between LHS and RHS, the resulting union will cross these gaps.
492501
/// For this to work,

0 commit comments

Comments
 (0)