-
Notifications
You must be signed in to change notification settings - Fork 903
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update f-string ranges in the indexer with nested f-strings
- Loading branch information
1 parent
c496d9c
commit 0b2e6bb
Showing
6 changed files
with
317 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
use std::collections::BTreeMap; | ||
|
||
use ruff_python_parser::Tok; | ||
use ruff_text_size::{TextRange, TextSize}; | ||
|
||
/// Stores the ranges of all f-strings in a file sorted by [`TextRange::start`]. | ||
/// There can be multiple overlapping ranges for nested f-strings. | ||
#[derive(Debug)] | ||
pub struct FStringRanges { | ||
raw: BTreeMap<TextSize, TextRange>, | ||
} | ||
|
||
impl FStringRanges { | ||
/// Return the [`TextRange`] of the innermost f-string at the given offset. | ||
pub fn innermost(&self, offset: TextSize) -> Option<TextRange> { | ||
self.raw | ||
.range(..=offset) | ||
.rev() | ||
.find(|(_, range)| range.contains(offset)) | ||
.map(|(_, range)| *range) | ||
} | ||
|
||
/// Return the [`TextRange`] of the outermost f-string at the given offset. | ||
pub fn outermost(&self, offset: TextSize) -> Option<TextRange> { | ||
// Explanation of the algorithm: | ||
// | ||
// ```python | ||
// # v | ||
// f"normal" f"another" f"first {f"second {f"third"} second"} first" | ||
// # ^^(1)^^^ | ||
// # ^^^^^^^^^^^^(2)^^^^^^^^^^^^ | ||
// # ^^^^^^^^^^^^^^^^^^^^^(3)^^^^^^^^^^^^^^^^^^^^ | ||
// # ^^^(4)^^^^ | ||
// # ^^^(5)^^^ | ||
// ``` | ||
// | ||
// The offset is marked with a `v` and the ranges are numbered in the order | ||
// they are yielded by the iterator in the reverse order. The algorithm | ||
// works as follows: | ||
// 1. Skip all ranges that don't contain the offset (1). | ||
// 2. Take all ranges that contain the offset (2, 3). | ||
// 3. Stop taking ranges when the offset is no longer contained. | ||
// 4. Take the last range that contained the offset (3, the outermost). | ||
self.raw | ||
.range(..=offset) | ||
.rev() | ||
.skip_while(|(_, range)| !range.contains(offset)) | ||
.take_while(|(_, range)| range.contains(offset)) | ||
.last() | ||
.map(|(_, range)| *range) | ||
} | ||
|
||
#[cfg(test)] | ||
pub(crate) fn ranges(&self) -> impl Iterator<Item = TextRange> + '_ { | ||
self.raw.values().copied() | ||
} | ||
} | ||
|
||
#[derive(Default)] | ||
pub(crate) struct FStringRangesBuilder { | ||
start_locations: Vec<TextSize>, | ||
raw: BTreeMap<TextSize, TextRange>, | ||
} | ||
|
||
impl FStringRangesBuilder { | ||
pub(crate) fn visit_token(&mut self, token: &Tok, range: TextRange) { | ||
match token { | ||
Tok::FStringStart => { | ||
self.start_locations.push(range.start()); | ||
} | ||
Tok::FStringEnd => { | ||
if let Some(start) = self.start_locations.pop() { | ||
self.raw.insert(start, TextRange::new(start, range.end())); | ||
} | ||
} | ||
_ => {} | ||
} | ||
} | ||
|
||
pub(crate) fn finish(self) -> FStringRanges { | ||
debug_assert!(self.start_locations.is_empty()); | ||
FStringRanges { raw: self.raw } | ||
} | ||
} |
Oops, something went wrong.