Files
designcraft/crates/textimport/src/export.rs
T

183 lines
7.8 KiB
Rust
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
//! Story → text files (File › Export of a story): Text Only and Rich Text Format.
//!
//! Text Only keeps paragraphs (CRLF), tabs and forced line breaks; tables become tab-separated
//! rows; markers (footnote references, anchors, index marks) are dropped and page-number markers
//! become `#`. RTF also keeps fonts, size, bold/italic, underline, strikethrough,
//! superscript/subscript, alignment, indents and paragraph spacing.
use designcraft_doc::story::{FORCED_LINE_BREAK, NEXT_PAGE_NUMBER, PAGE_NUMBER, PREV_PAGE_NUMBER, TABLE_ANCHOR};
use designcraft_doc::{Align, Document, Position, Story};
/// Characters of a run as plain text (`None`: dropped).
fn plain_char(c: char) -> Option<&'static str> {
match c {
PAGE_NUMBER | NEXT_PAGE_NUMBER | PREV_PAGE_NUMBER => Some("#"),
FORCED_LINE_BREAK => Some("\u{2028}"),
'\u{E000}'..='\u{E1FF}' => None,
_ => Some(""),
}
}
fn table_text(story: &Story, id: u64, nl: &str) -> String {
let Some(t) = story.tables.get(&id) else { return String::new() };
(0..t.nrows())
.map(|r| (0..t.ncols()).map(|c| t.cell(r, c).map(|x| x.text.text.replace('\n', " ")).unwrap_or_default()).collect::<Vec<_>>().join("\t"))
.collect::<Vec<_>>()
.join(nl)
}
/// Text Only: the story's text, CRLF between paragraphs.
pub fn plain_text(story: &Story) -> String {
// Tracked deletions aren't part of the text.
let deleted: Vec<std::ops::Range<usize>> =
story.runs().filter(|(_, f)| f.over.change == Some(designcraft_doc::ChangeMark::Deleted)).map(|(r, _)| r).collect();
let mut out = String::with_capacity(story.text.len() + 16);
for (i, r) in story.para_ranges().into_iter().enumerate() {
if i > 0 {
out.push_str("\r\n");
}
let start = r.start;
for (ci, c) in story.text[r].char_indices() {
if deleted.iter().any(|d| d.contains(&(start + ci))) {
continue;
}
match (c, plain_char(c)) {
(TABLE_ANCHOR, _) => {
if let Some(id) = story.paras.get(i).and_then(|p| p.table) {
out.push_str(&table_text(story, id, "\r\n"));
}
}
(_, Some("")) => out.push(c),
(_, Some("\u{2028}")) => out.push('\n'),
(_, Some(s)) => out.push_str(s),
(_, None) => {}
}
}
}
out
}
fn twips(pt: f64) -> i32 {
(pt * 20.0).round().clamp(f64::from(i32::MIN), f64::from(i32::MAX)) as i32
}
/// Rich Text Format, with the story's resolved formatting.
pub fn rtf(doc: &Document, story: &Story) -> String {
let styles = &doc.styles;
let all_runs: Vec<_> = story.runs().collect();
let mut neutral = craft_rtf::Document::default();
for (i, r) in story.para_ranges().into_iter().enumerate() {
let pf = story.paras.get(i).cloned().unwrap_or_default();
let (pp, base) = styles.resolve_para(&pf);
let mut para = craft_rtf::Para {
left_indent: twips(pp.left_indent),
right_indent: twips(pp.right_indent),
first_line_indent: twips(pp.first_line_indent),
space_before: twips(pp.space_before),
space_after: twips(pp.space_after),
align: Some(match pp.align {
Align::Center => craft_rtf::Align::Center,
Align::Right => craft_rtf::Align::Right,
Align::Left => craft_rtf::Align::Left,
_ => craft_rtf::Align::Justified,
}),
..Default::default()
};
let first = all_runs.partition_point(|(rr, _)| rr.end <= r.start);
for (rr, f) in all_runs.iter().skip(first).take_while(|(rr, _)| rr.start < r.end) {
let (a, b) = (rr.start.max(r.start), rr.end.min(r.end));
if a >= b {
continue;
}
let cp = styles.resolve_char(&base, f);
if doc.conditions_hide(&cp.conditions) || cp.change == designcraft_doc::ChangeMark::Deleted {
continue;
}
let style = cp.font_style.to_ascii_lowercase();
let half_points = (cp.size * 2.0).round();
let fmt = craft_rtf::CharFmt {
bold: style.contains("bold") || style.contains("black") || style.contains("heavy") || style.contains("semibold"),
italic: style.contains("italic") || style.contains("oblique"),
underline: cp.underline,
strike: cp.strikethrough,
vert_align: match cp.position {
Position::Superscript | Position::OtSuperscript => craft_rtf::VertAlign::Superscript,
Position::Subscript | Position::OtSubscript => craft_rtf::VertAlign::Subscript,
_ => craft_rtf::VertAlign::Baseline,
},
half_points: (half_points.is_finite() && (1.0..=25_000.0).contains(&half_points)).then_some(half_points as u32),
color: None,
font: Some(cp.font_family.clone()),
};
let mut text = String::new();
for c in story.text[a..b].chars() {
match c {
TABLE_ANCHOR => {
if let Some(id) = pf.table {
text.push_str(&table_text(story, id, "
"));
}
}
PAGE_NUMBER | NEXT_PAGE_NUMBER | PREV_PAGE_NUMBER => text.push('#'),
''..='' => {}
c => text.push(c),
}
}
if !text.is_empty() {
para.runs.push(craft_rtf::Run { text, fmt });
}
}
if para.runs.is_empty() {
para.runs.push(craft_rtf::Run {
text: String::new(),
fmt: craft_rtf::CharFmt {
half_points: Some((base.size * 2.0).round().clamp(1.0, 25_000.0) as u32),
font: Some(base.font_family),
..Default::default()
},
});
}
neutral.blocks.push(craft_rtf::Block::Para(para));
}
craft_rtf::write(&neutral, "Source Serif 4")
}
#[cfg(test)]
mod tests {
use designcraft_doc::build::NewDocument;
use designcraft_doc::{CharAttrs, ParaAttrs, StoryId};
use super::*;
fn story() -> Story {
let mut st = Story::with_text(StoryId(1), "Plain bold {x}\nCafé\u{2028}two\u{E00A}", Default::default());
let b = st.text.find("bold").unwrap();
st.format_chars(b..b + 4, |f| f.over = CharAttrs { font_style: Some("Bold".into()), ..Default::default() });
st.format_paras(0..1, |p| p.para = ParaAttrs { align: Some(Align::Center), ..Default::default() });
st
}
#[test]
fn text_variable_markers_are_dropped() {
let st = Story::with_text(StoryId(1), "Page \u{E100} of", Default::default());
assert_eq!(plain_text(&st), "Page of");
let r = rtf(&Document::new(&NewDocument::default()), &st);
assert!(!r.contains("\\u-7936") && r.contains("Page of"), "{r}");
}
#[test]
fn text_only() {
assert_eq!(plain_text(&story()), "Plain bold {x}\r\nCafé\ntwo");
}
#[test]
fn rtf_round_trips_through_the_importer() {
let doc = Document::new(&NewDocument::default());
let r = rtf(&doc, &story());
assert!(r.starts_with("{\\rtf1") && r.contains("\\qc") && r.contains("\\{x\\}") && r.contains("Caf\\u233?"), "{r}");
let back = crate::rtf::import(r.as_bytes()).unwrap().story;
assert_eq!(back.text.trim_end_matches('\n'), "Plain bold {x}\nCafé\u{2028}two");
assert_eq!(back.format_after(back.text.find("bold").unwrap()).over.font_style.as_deref(), Some("Bold"));
assert_ne!(back.format_after(1).over.font_style.as_deref(), Some("Bold"));
}
}