use ruff_python_ast::StringFlags; use super::TokenFlags; /// The context representing the current f-string that the lexer is in. #[derive(Clone, Debug)] pub(crate) struct FStringContext { flags: TokenFlags, /// The level of nesting for the lexer when it entered the current f-string. /// The nesting level includes all kinds of parentheses i.e., round, square, /// and curly. nesting: u32, /// The current depth of format spec for the current f-string. This is because /// there can be multiple format specs nested for the same f-string. /// For example, `{a:{b:{c}}}` has 3 format specs. format_spec_depth: u32, } impl FStringContext { pub(crate) const fn new(flags: TokenFlags, nesting: u32) -> Self { assert!(flags.is_f_string()); Self { flags, nesting, format_spec_depth: 0, } } pub(crate) const fn flags(&self) -> TokenFlags { self.flags } pub(crate) const fn nesting(&self) -> u32 { self.nesting } /// Returns the quote character for the current f-string. pub(crate) fn quote_char(&self) -> char { self.flags.quote_style().as_char() } /// Returns the triple quotes for the current f-string if it is a triple-quoted /// f-string, `None` otherwise. pub(crate) fn triple_quotes(&self) -> Option<&'static str> { if self.is_triple_quoted() { Some(self.flags.quote_str()) } else { None } } /// Returns `true` if the current f-string is a raw f-string. pub(crate) fn is_raw_string(&self) -> bool { self.flags.is_raw_string() } /// Returns `true` if the current f-string is a triple-quoted f-string. pub(crate) fn is_triple_quoted(&self) -> bool { self.flags.is_triple_quoted() } /// Calculates the number of open parentheses for the current f-string /// based on the current level of nesting for the lexer. const fn open_parentheses_count(&self, current_nesting: u32) -> u32 { current_nesting.saturating_sub(self.nesting) } /// Returns `true` if the lexer is in a f-string expression i.e., between /// two curly braces. pub(crate) const fn is_in_expression(&self, current_nesting: u32) -> bool { self.open_parentheses_count(current_nesting) > self.format_spec_depth } /// Returns `true` if the lexer is in a f-string format spec i.e., after a colon. pub(crate) const fn is_in_format_spec(&self, current_nesting: u32) -> bool { self.format_spec_depth > 0 && !self.is_in_expression(current_nesting) } /// Returns `true` if the context is in a valid position to start format spec /// i.e., at the same level of nesting as the opening parentheses token. /// Increments the format spec depth if it is. /// /// This assumes that the current character for the lexer is a colon (`:`). pub(crate) fn try_start_format_spec(&mut self, current_nesting: u32) -> bool { if self .open_parentheses_count(current_nesting) .saturating_sub(self.format_spec_depth) == 1 { self.format_spec_depth += 1; true } else { false } } /// Decrements the format spec depth if the current f-string is in a format /// spec. pub(crate) fn try_end_format_spec(&mut self, current_nesting: u32) { if self.is_in_format_spec(current_nesting) { self.format_spec_depth = self.format_spec_depth.saturating_sub(1); } } } /// The f-strings stack is used to keep track of all the f-strings that the /// lexer encounters. This is necessary because f-strings can be nested. #[derive(Debug, Default)] pub(crate) struct FStrings { stack: Vec, } impl FStrings { pub(crate) fn push(&mut self, context: FStringContext) { self.stack.push(context); } pub(crate) fn pop(&mut self) -> Option { self.stack.pop() } pub(crate) fn current(&self) -> Option<&FStringContext> { self.stack.last() } pub(crate) fn current_mut(&mut self) -> Option<&mut FStringContext> { self.stack.last_mut() } pub(crate) fn checkpoint(&self) -> FStringsCheckpoint { FStringsCheckpoint(self.stack.clone()) } pub(crate) fn rewind(&mut self, checkpoint: FStringsCheckpoint) { self.stack = checkpoint.0; } } #[derive(Debug, Clone)] pub(crate) struct FStringsCheckpoint(Vec);