use std::ops::Range;
use gpui::SharedString;
use crate::components::direction::TextDirection;
mod arabic;
use arabic::{is_rtl_char, joined_clusters};
pub use arabic::{presentation_forms, shape_arabic};
const LEFT_TO_RIGHT_OVERRIDE: char = '\u{202D}';
const POP_DIRECTIONAL_FORMATTING: char = '\u{202C}';
#[must_use]
pub const fn platform_needs_reordering() -> bool {
cfg!(target_os = "windows")
}
pub fn has_rtl(text: &str) -> bool {
text.chars().any(is_rtl_char)
}
pub fn display_text(text: impl Into<SharedString>, direction: TextDirection) -> SharedString {
let text = text.into();
if !platform_needs_reordering() || !has_rtl(&text) || is_converted(&text) {
return text;
}
visual_text(&text, direction).into()
}
#[must_use]
pub fn is_converted(text: &str) -> bool {
text.starts_with(LEFT_TO_RIGHT_OVERRIDE)
}
#[must_use]
pub fn visual_text(text: &str, direction: TextDirection) -> String {
visual_text_in_font(text, direction, &crate::sx::current_theme().font_family)
}
#[must_use]
pub fn visual_text_in_font(text: &str, direction: TextDirection, font_family: &str) -> String {
text.split('\n')
.map(|line| visual_line_in_font(line, direction, font_family).text)
.collect::<Vec<_>>()
.join("\n")
}
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct VisualChar {
pub logical: Range<usize>,
pub visual: Range<usize>,
pub rtl: bool,
}
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct VisualLine {
pub text: String,
pub chars: Vec<VisualChar>,
}
#[must_use]
pub fn visual_line(line: &str, direction: TextDirection) -> VisualLine {
visual_line_in_font(line, direction, &crate::sx::current_theme().font_family)
}
#[must_use]
pub fn visual_line_in_font(line: &str, direction: TextDirection, font_family: &str) -> VisualLine {
use unicode_bidi::{BidiInfo, Level};
let mut text = String::with_capacity(line.len() * 3 + 6);
let mut chars = Vec::with_capacity(line.len());
text.push(LEFT_TO_RIGHT_OVERRIDE);
if !line.is_empty() {
let base = match direction {
TextDirection::Rtl => Level::rtl(),
TextDirection::Ltr => Level::ltr(),
};
let info = BidiInfo::new(line, Some(base));
for paragraph in &info.paragraphs {
let (levels, runs) = info.visual_runs(paragraph, paragraph.range.clone());
for run in runs {
if levels[run.start].is_rtl() {
push_rtl_run(line, run, font_family, &mut text, &mut chars);
} else {
for (offset, character) in line[run.clone()].char_indices() {
let start = text.len();
text.push(character);
let logical = run.start + offset;
chars.push(VisualChar {
logical: logical..logical + character.len_utf8(),
visual: start..text.len(),
rtl: false,
});
}
}
}
}
}
text.push(POP_DIRECTIONAL_FORMATTING);
chars.sort_by_key(|character| character.logical.start);
VisualLine { text, chars }
}
fn push_rtl_run(
line: &str,
run: Range<usize>,
font_family: &str,
text: &mut String,
chars: &mut Vec<VisualChar>,
) {
for (cluster, range) in joined_clusters(&line[run.clone()], font_family)
.iter()
.rev()
{
let start = text.len();
text.push_str(cluster);
let visual = start..text.len();
let logical_start = run.start + range.start;
for (offset, character) in line[logical_start..run.start + range.end].char_indices() {
let logical = logical_start + offset;
chars.push(VisualChar {
logical: logical..logical + character.len_utf8(),
visual: visual.clone(),
rtl: true,
});
}
}
}
#[cfg(test)]
mod tests {
use super::*;
fn visual(text: &str, direction: TextDirection) -> String {
visual_text(text, direction)
.trim_start_matches(LEFT_TO_RIGHT_OVERRIDE)
.trim_end_matches(POP_DIRECTIONAL_FORMATTING)
.to_string()
}
#[test]
fn letters_take_their_contextual_forms() {
assert_eq!(
shape_arabic("مرحبا"),
"\u{FEE3}\u{FEAE}\u{FEA3}\u{FE92}\u{FE8E}"
);
assert_eq!(shape_arabic("ب"), "\u{FE8F}");
assert_eq!(shape_arabic("ء"), "ء");
}
#[test]
fn lam_alef_becomes_one_ligature() {
assert_eq!(shape_arabic("لا"), "\u{FEFB}");
assert_eq!(shape_arabic("سلام"), "\u{FEB3}\u{FEFC}\u{FEE1}");
}
#[test]
fn harakat_do_not_break_joining() {
assert_eq!(shape_arabic("بَب"), "\u{FE91}\u{064E}\u{FE90}");
}
#[test]
fn rtl_runs_are_reversed_and_ltr_runs_kept() {
assert_eq!(
visual("مرحبا", TextDirection::Rtl),
"\u{FE8E}\u{FE92}\u{FEA3}\u{FEAE}\u{FEE3}"
);
let mixed = visual("مرحبا Rust", TextDirection::Rtl);
assert!(mixed.starts_with("Rust "), "{mixed:?}");
let price = visual("السعر 45", TextDirection::Rtl);
assert!(price.starts_with("45 "), "{price:?}");
}
#[test]
fn brackets_mirror_inside_rtl_runs() {
let text = visual("(نص)", TextDirection::Rtl);
assert!(text.starts_with('(') && text.ends_with(')'), "{text:?}");
}
#[test]
fn plain_ltr_text_is_untouched() {
assert!(!has_rtl("Hello, world"));
assert_eq!(
display_text("Hello", TextDirection::Rtl),
SharedString::from("Hello")
);
}
#[test]
fn visual_lines_map_every_logical_character() {
let line = visual_line("مرحبا", TextDirection::Rtl);
assert_eq!(line.chars.len(), 5);
assert!(line.chars.iter().all(|character| character.rtl));
assert!(line.chars[0].visual.start > line.chars[4].visual.start);
let ligature = visual_line("لا", TextDirection::Rtl);
assert_eq!(ligature.chars.len(), 2);
assert_eq!(ligature.chars[0].visual, ligature.chars[1].visual);
let mixed = visual_line("ab مر", TextDirection::Ltr);
assert!(!mixed.chars[0].rtl && !mixed.chars[1].rtl);
assert!(mixed.chars[0].visual.start < mixed.chars[1].visual.start);
assert!(mixed.chars[3].rtl);
assert_eq!(mixed.chars.last().unwrap().logical.end, "ab مر".len());
}
#[test]
fn adjacent_isolated_letters_alternate_base_and_presentation_forms() {
let line = visual_line_in_font("وزن", TextDirection::Rtl, "Any Font");
let text = line.text.trim_start_matches(LEFT_TO_RIGHT_OVERRIDE);
let text = text.trim_end_matches(POP_DIRECTIONAL_FORMATTING);
assert_eq!(text, "ن\u{FEAF}و");
crate::fonts::mark_missing_presentation_forms("Gappy Font", ['\u{FEAF}']);
let line = visual_line_in_font("وزن", TextDirection::Rtl, "Gappy Font");
let text = line.text.trim_start_matches(LEFT_TO_RIGHT_OVERRIDE);
let text = text.trim_end_matches(POP_DIRECTIONAL_FORMATTING);
assert_eq!(text, "ن\u{200C}ز\u{200C}و");
}
#[test]
fn conversion_is_idempotent() {
let once = visual_text("مرحبا", TextDirection::Rtl);
assert!(is_converted(&once));
if platform_needs_reordering() {
assert_eq!(
display_text(once.clone(), TextDirection::Rtl).as_ref(),
once
);
}
}
}