use std::collections::HashMap;
use rust_xlsxwriter::{Color, DocProperties, ExcelDateTime, Format, Formula, Workbook};
use crate::cell_key;
use crate::resolve::{a1_to_zero_indexed_row_col, parse_a1};
use crate::sheet_ir::value::CellValue;
use crate::sheet_ir::RunResult;
fn writer_err(e: rust_xlsxwriter::XlsxError) -> RenderError {
RenderError::Writer(e.to_string())
}
pub mod layout;
pub use layout::*;
#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
pub enum RenderError {
#[error("malformed cell address {addr} on sheet {sheet}")]
MalformedAddr {
sheet: String,
addr: String,
},
#[error("malformed merge range {range} on sheet {sheet}")]
MalformedMerge {
sheet: String,
range: String,
},
#[error("non-finite computed value at {cell}")]
NonFiniteValue {
cell: String,
},
#[error("xlsx writer error: {0}")]
Writer(String),
}
fn fixed_creation_datetime() -> Result<ExcelDateTime, RenderError> {
ExcelDateTime::from_ymd(2024, 1, 1)
.and_then(|d| d.and_hms(0, 0, 0))
.map_err(writer_err)
}
#[must_use]
pub fn normalize_formula_for_writer(f: &str) -> String {
if f.trim_start().starts_with('=') {
f.to_string()
} else {
format!("={f}")
}
}
fn argb_to_color(argb: &str) -> Option<Color> {
let hex = argb.trim();
let rgb_hex = match hex.len() {
8 => hex.get(2..)?,
6 => hex, _ => return None,
};
let rgb = u32::from_str_radix(rgb_hex, 16).ok()?;
Some(Color::RGB(rgb))
}
fn cell_format(cell: &CellLayout) -> Option<Format> {
if cell.number_format.is_none() && cell.fill_argb.is_none() && cell.font_argb.is_none() {
return None;
}
let mut fmt = Format::new();
if let Some(nf) = &cell.number_format {
fmt = fmt.set_num_format(nf.clone());
}
if let Some(fill) = cell.fill_argb.as_deref().and_then(argb_to_color) {
fmt = fmt.set_background_color(fill);
}
if let Some(font) = cell.font_argb.as_deref().and_then(argb_to_color) {
fmt = fmt.set_font_color(font);
}
Some(fmt)
}
type MergeInterior = std::collections::HashSet<(u32, u16)>;
fn replay_merges(
ws: &mut rust_xlsxwriter::Worksheet,
sheet: &SheetLayout,
top_left_text: &HashMap<(u32, u16), String>,
) -> Result<MergeInterior, RenderError> {
let mut interior = MergeInterior::new();
let blank = Format::new();
for range in &sheet.merges {
let (start, end) = range
.split_once(':')
.ok_or_else(|| RenderError::MalformedMerge {
sheet: sheet.name.clone(),
range: range.clone(),
})?;
let malformed = || RenderError::MalformedMerge {
sheet: sheet.name.clone(),
range: range.clone(),
};
let (r0, c0) = a1_to_zero_indexed_row_col(start.trim()).ok_or_else(malformed)?;
let (r1, c1) = a1_to_zero_indexed_row_col(end.trim()).ok_or_else(malformed)?;
let (row_lo, row_hi) = (r0.min(r1), r0.max(r1));
let (col_lo, col_hi) = (c0.min(c1), c0.max(c1));
if row_lo == row_hi && col_lo == col_hi {
return Err(malformed());
}
let text = top_left_text
.get(&(row_lo, col_lo))
.cloned()
.unwrap_or_default();
ws.merge_range(row_lo, col_lo, row_hi, col_hi, &text, &blank)
.map_err(writer_err)?;
for r in row_lo..=row_hi {
for c in col_lo..=col_hi {
interior.insert((r, c));
}
}
}
Ok(interior)
}
pub fn render_xlsx(layout: &LayoutDescriptor, run: &RunResult) -> Result<Vec<u8>, RenderError> {
let mut wb = init_workbook()?;
for sheet in &layout.sheets {
let ws = wb.add_worksheet();
render_sheet(ws, sheet, run)?;
}
wb.save_to_buffer().map_err(writer_err)
}
fn init_workbook() -> Result<Workbook, RenderError> {
let mut wb = Workbook::new();
let props = DocProperties::new()
.set_author("")
.set_creation_datetime(&fixed_creation_datetime()?);
wb.set_properties(&props);
Ok(wb)
}
fn render_sheet(
ws: &mut rust_xlsxwriter::Worksheet,
sheet: &SheetLayout,
run: &RunResult,
) -> Result<(), RenderError> {
apply_sheet_scaffold(ws, sheet)?;
let top_left_text = build_top_left_text(sheet, run)?;
let interior = replay_merges(ws, sheet, &top_left_text)?;
for cell in &sheet.cells {
write_cell(ws, sheet, run, cell, &interior)?;
}
Ok(())
}
fn apply_sheet_scaffold(
ws: &mut rust_xlsxwriter::Worksheet,
sheet: &SheetLayout,
) -> Result<(), RenderError> {
ws.set_name(&sheet.name).map_err(writer_err)?;
if sheet.hidden {
ws.set_hidden(true);
}
for (col_1based, width) in &sheet.col_widths {
if let Some(col) = col_1based.checked_sub(1) {
ws.set_column_width(col, *width).map_err(writer_err)?;
}
}
for col_1based in &sheet.hidden_cols {
if let Some(col) = col_1based.checked_sub(1) {
ws.set_column_hidden(col).map_err(writer_err)?;
}
}
Ok(())
}
fn build_top_left_text(
sheet: &SheetLayout,
run: &RunResult,
) -> Result<HashMap<(u32, u16), String>, RenderError> {
let mut top_left_text: HashMap<(u32, u16), String> = HashMap::new();
for cell in &sheet.cells {
if a1_to_zero_indexed_row_col(&cell.addr).is_none() {
let _ = parse_a1(&cell.addr); return Err(RenderError::MalformedAddr {
sheet: sheet.name.clone(),
addr: cell.addr.clone(),
});
}
let key = cell_key(&sheet.name, &cell.addr);
let display = display_text(run, &key, cell)?;
if let (Some((r, c)), Some(text)) = (a1_to_zero_indexed_row_col(&cell.addr), display) {
top_left_text.insert((r, c), text);
}
}
Ok(top_left_text)
}
fn display_text(
run: &RunResult,
key: &str,
cell: &CellLayout,
) -> Result<Option<String>, RenderError> {
let display = match run.computed.get(key) {
Some(CellValue::Number(n)) if n.is_finite() => Some(format_number(*n)),
Some(CellValue::Number(_)) => {
return Err(RenderError::NonFiniteValue {
cell: key.to_string(),
})
},
Some(CellValue::Text(s)) => Some(s.clone()),
Some(CellValue::Bool(b)) => Some(b.to_string()),
_ => cell.value.clone(),
};
Ok(display)
}
fn write_cell(
ws: &mut rust_xlsxwriter::Worksheet,
sheet: &SheetLayout,
run: &RunResult,
cell: &CellLayout,
interior: &MergeInterior,
) -> Result<(), RenderError> {
let (row, col) =
a1_to_zero_indexed_row_col(&cell.addr).ok_or_else(|| RenderError::MalformedAddr {
sheet: sheet.name.clone(),
addr: cell.addr.clone(),
})?;
if interior.contains(&(row, col)) {
return Ok(()); }
let key = cell_key(&sheet.name, &cell.addr);
let computed = run.computed.get(&key);
let fmt = cell_format(cell);
write_computed_value(ws, row, col, cell, computed, key, fmt.as_ref())
}
fn write_computed_value(
ws: &mut rust_xlsxwriter::Worksheet,
row: u32,
col: u16,
cell: &CellLayout,
computed: Option<&CellValue>,
key: String,
fmt: Option<&Format>,
) -> Result<(), RenderError> {
match computed {
Some(CellValue::Number(n)) => {
if !n.is_finite() {
return Err(RenderError::NonFiniteValue { cell: key });
}
write_number_cell(ws, row, col, cell, *n, fmt)?;
},
Some(CellValue::Text(s)) => write_string_cell(ws, row, col, s, fmt)?,
Some(CellValue::Bool(b)) => write_string_cell(ws, row, col, &b.to_string(), fmt)?,
_ => {
if let Some(v) = &cell.value {
write_string_cell(ws, row, col, v, fmt)?;
}
},
}
Ok(())
}
fn format_number(n: f64) -> String {
format!("{n}")
}
fn write_number_cell(
ws: &mut rust_xlsxwriter::Worksheet,
row: u32,
col: u16,
cell: &CellLayout,
n: f64,
fmt: Option<&Format>,
) -> Result<(), RenderError> {
match (&cell.formula, fmt) {
(Some(f), Some(fmt)) => {
let formula =
Formula::new(normalize_formula_for_writer(f)).set_result(format_number(n));
ws.write_formula_with_format(row, col, formula, fmt)
.map_err(writer_err)?;
},
(Some(f), None) => {
let formula =
Formula::new(normalize_formula_for_writer(f)).set_result(format_number(n));
ws.write_formula(row, col, formula).map_err(writer_err)?;
},
(None, Some(fmt)) => {
ws.write_number_with_format(row, col, n, fmt)
.map_err(writer_err)?;
},
(None, None) => {
ws.write_number(row, col, n).map_err(writer_err)?;
},
}
Ok(())
}
fn write_string_cell(
ws: &mut rust_xlsxwriter::Worksheet,
row: u32,
col: u16,
s: &str,
fmt: Option<&Format>,
) -> Result<(), RenderError> {
match fmt {
Some(fmt) => ws
.write_string_with_format(row, col, s, fmt)
.map_err(writer_err)?,
None => ws.write_string(row, col, s).map_err(writer_err)?,
};
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
use crate::excel_error::ExcelError;
use std::collections::HashMap;
const ZIP_MAGIC: &[u8] = b"PK\x03\x04";
fn run_with(pairs: &[(&str, CellValue)]) -> RunResult {
let mut computed = HashMap::new();
for (k, v) in pairs {
computed.insert((*k).to_string(), v.clone());
}
RunResult {
computed,
traces: HashMap::new(),
}
}
fn cell(addr: &str, formula: Option<&str>, value: Option<&str>) -> CellLayout {
CellLayout {
addr: addr.to_string(),
formula: formula.map(str::to_string),
value: value.map(str::to_string),
number_format: None,
fill_argb: None,
font_argb: None,
}
}
fn one_sheet(name: &str, cells: Vec<CellLayout>, merges: Vec<String>) -> LayoutDescriptor {
LayoutDescriptor {
descriptor_version: LAYOUT_DESCRIPTOR_VERSION,
source_workbook_hash: None,
sheets: vec![SheetLayout {
name: name.to_string(),
hidden: false,
cells,
merges,
col_widths: vec![],
hidden_cols: vec![],
}],
}
}
#[test]
fn render_xlsx_produces_valid_zip_container() {
let layout = one_sheet("7_Quote", vec![cell("C11", None, Some("0"))], vec![]);
let run = run_with(&[("7_Quote!C11", CellValue::Number(1594.93))]);
let bytes = render_xlsx(&layout, &run).expect("render");
assert!(!bytes.is_empty(), "non-empty output");
assert_eq!(
&bytes[..4],
ZIP_MAGIC,
"leads with the ZIP magic PK\\x03\\x04"
);
}
#[test]
fn render_xlsx_is_deterministic_byte_identical() {
let layout = one_sheet(
"7_Quote",
vec![cell("C11", Some("SUM(C9:C10)"), Some("0"))],
vec![],
);
let run = run_with(&[("7_Quote!C11", CellValue::Number(1594.93))]);
let a = render_xlsx(&layout, &run).expect("render a");
let b = render_xlsx(&layout, &run).expect("render b");
assert_eq!(a, b, "two renders of the same input are byte-identical");
}
#[test]
fn normalize_formula_for_writer_never_double_prefixes() {
assert_eq!(normalize_formula_for_writer("SUM(A1:A2)"), "=SUM(A1:A2)");
assert_eq!(normalize_formula_for_writer("=SUM(A1:A2)"), "=SUM(A1:A2)");
for f in ["SUM(A1:A2)", "=SUM(A1:A2)"] {
let out = normalize_formula_for_writer(f);
assert!(out.starts_with('='), "has a leading '='");
assert!(!out.starts_with("=="), "never double-prefixed");
}
}
#[test]
fn render_xlsx_rejects_non_finite_computed_value() {
let layout = one_sheet("7_Quote", vec![cell("C11", None, None)], vec![]);
for bad in [f64::NAN, f64::INFINITY, f64::NEG_INFINITY] {
let run = run_with(&[("7_Quote!C11", CellValue::Number(bad))]);
let err = render_xlsx(&layout, &run).expect_err("non-finite must be Err");
assert!(
matches!(err, RenderError::NonFiniteValue { .. }),
"got {err:?}"
);
}
}
#[test]
fn render_xlsx_surfaces_malformed_addr_as_error_not_panic() {
let layout = one_sheet("7_Quote", vec![cell("1A", None, Some("x"))], vec![]);
let run = run_with(&[]);
let err = render_xlsx(&layout, &run).expect_err("malformed addr must be Err");
assert!(
matches!(err, RenderError::MalformedAddr { .. }),
"got {err:?}"
);
}
#[test]
fn render_xlsx_writes_formula_with_finite_cached_result() {
let layout = one_sheet(
"7_Quote",
vec![cell("C11", Some("=SUM(C9:C10)"), None)],
vec![],
);
let run = run_with(&[("7_Quote!C11", CellValue::Number(1594.93))]);
let bytes = render_xlsx(&layout, &run).expect("render");
assert_eq!(&bytes[..4], ZIP_MAGIC);
}
#[test]
fn render_xlsx_replays_merge_top_left_only() {
let layout = one_sheet(
"7_Quote",
vec![
cell("A1", None, Some("merged")),
cell("A2", None, Some("interior")),
cell("B1", None, Some("interior")),
cell("B2", None, Some("interior")),
],
vec!["A1:B2".to_string()],
);
let run = run_with(&[("7_Quote!A1", CellValue::Text("merged".to_string()))]);
let bytes = render_xlsx(&layout, &run).expect("render with merge");
assert_eq!(
&bytes[..4],
ZIP_MAGIC,
"merge replay still yields a valid xlsx"
);
}
#[test]
fn render_xlsx_rejects_single_cell_merge() {
let layout = one_sheet(
"7_Quote",
vec![cell("A1", None, Some("x"))],
vec!["A1:A1".to_string()],
);
let run = run_with(&[]);
let err = render_xlsx(&layout, &run).expect_err("single-cell merge must be Err");
assert!(
matches!(err, RenderError::MalformedMerge { .. }),
"got {err:?}"
);
}
#[test]
fn render_xlsx_writes_text_and_bool_and_falls_back_on_error_value() {
let layout = one_sheet(
"7_Quote",
vec![
cell("A1", None, None),
cell("A2", None, None),
cell("A3", None, Some("orig")),
],
vec![],
);
let run = run_with(&[
("7_Quote!A1", CellValue::Text("hi".to_string())),
("7_Quote!A2", CellValue::Bool(true)),
("7_Quote!A3", CellValue::Error(ExcelError::DivZero)),
]);
let bytes = render_xlsx(&layout, &run).expect("render");
assert_eq!(&bytes[..4], ZIP_MAGIC);
}
#[test]
fn argb_to_color_non_ascii_eight_byte_input_is_none_not_a_panic() {
assert_eq!("€abcde".len(), 8, "the reproducer is byte-length 8");
assert_eq!(argb_to_color("€abcde"), None);
assert!(argb_to_color("FFE2EFDA").is_some());
assert!(argb_to_color("E2EFDA").is_some());
}
#[test]
fn render_xlsx_with_non_ascii_argb_renders_without_panic() {
let mut bad = cell("A1", None, Some("x"));
bad.fill_argb = Some("€abcde".to_string());
bad.font_argb = Some("€abcde".to_string());
let layout = one_sheet("7_Quote", vec![bad], vec![]);
let bytes = render_xlsx(&layout, &run_with(&[])).expect("render");
assert_eq!(&bytes[..4], ZIP_MAGIC);
}
}