use std::fmt;
use super::PrintableText;
pub(crate) static DEFAULT_TAB_POLICY: TabPolicy = TabPolicy::spaces(4);
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct TabPolicy {
width: u16,
marker: Option<String>,
}
impl Default for TabPolicy {
fn default() -> Self {
Self::spaces(4)
}
}
impl TabPolicy {
pub const fn spaces(width: u16) -> Self {
Self {
width,
marker: None,
}
}
pub fn with_marker(width: u16, marker: impl Into<String>) -> Result<Self, InvalidTabMarker> {
let marker = marker.into();
if marker.is_empty() {
return Ok(Self::spaces(width));
}
if marker.chars().any(char::is_control) {
return Err(InvalidTabMarker::ControlCharacter);
}
let printable = PrintableText::new(&marker);
if printable.graphemes().any(|grapheme| grapheme.width() == 0) {
return Err(InvalidTabMarker::ZeroWidthGrapheme);
}
let marker_width = printable.width();
if marker_width > usize::from(width) {
return Err(InvalidTabMarker::TooWide {
width,
marker_width,
});
}
Ok(Self {
width,
marker: Some(marker),
})
}
pub const fn width(&self) -> u16 {
self.width
}
pub fn marker(&self) -> Option<&str> {
self.marker.as_deref()
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum InvalidTabMarker {
ControlCharacter,
ZeroWidthGrapheme,
TooWide { width: u16, marker_width: usize },
}
impl fmt::Display for InvalidTabMarker {
fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::ControlCharacter => {
formatter.write_str("a tab marker must not contain control characters")
}
Self::ZeroWidthGrapheme => {
formatter.write_str("every tab marker grapheme must occupy at least one cell")
}
Self::TooWide {
width,
marker_width,
} => write!(
formatter,
"tab marker occupies {marker_width} cells, exceeding its width of {width}"
),
}
}
}
impl std::error::Error for InvalidTabMarker {}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn empty_marker_is_canonicalized_to_spaces() {
assert_eq!(TabPolicy::with_marker(3, "").unwrap(), TabPolicy::spaces(3));
}
#[test]
fn marker_must_be_printable_and_fit_its_width() {
assert_eq!(
TabPolicy::with_marker(4, "→\t"),
Err(InvalidTabMarker::ControlCharacter)
);
assert_eq!(
TabPolicy::with_marker(1, "日本"),
Err(InvalidTabMarker::TooWide {
width: 1,
marker_width: 4,
})
);
assert_eq!(
TabPolicy::with_marker(1, "\u{301}"),
Err(InvalidTabMarker::ZeroWidthGrapheme)
);
assert_eq!(
TabPolicy::with_marker(1, "\u{301}x"),
Err(InvalidTabMarker::ZeroWidthGrapheme)
);
}
}