mod alignment;
pub mod arrange;
mod compile;
mod fixed_size;
mod flow;
mod fonts;
mod form_field;
pub mod grid;
pub mod layout_context;
mod leaf;
mod list_item_measure;
mod list_markers;
pub mod list_style;
mod math;
pub mod measure;
pub mod pagination;
mod render_plan;
pub mod resolved_style;
mod running_blocks;
mod shape_run;
mod slack;
pub mod style;
mod table;
mod table_pagination;
mod text_align;
pub mod text_layout;
pub mod theme;
pub mod visual_primitives;
#[cfg(test)]
mod alignment_tests;
#[cfg(test)]
mod slack_tests;
pub use arrange::arrange_node;
pub use compile::{compile_chunk_with_fonts, compile_manifest, compile_outcome, CompileOutcome};
pub use k2f_core::AssetsMap;
pub use layout_context::{LayoutContext, Point, Size, SizeConstraint};
pub use list_style::*;
pub use measure::measure_node;
pub use pagination::Paginator;
pub use resolved_style::*;
pub use slack::LayoutDiag;
pub use style::*;
pub use text_layout::{layout_text, TextLayout};
pub use theme::*;
pub use visual_primitives::*;
use k2f_core::{Align, CanvasMode, LayoutHint, LayoutResult, Manifest, Pt, StackDirection};
const ROOT_FLOW_NEST: &str = " Nest under a child of the document-flow root (catalog ex_*.json are children — do not replace content/root.json).";
fn root_flow_layout(layout: Option<&LayoutHint>) -> Result<(StackDirection, i64, Align), String> {
match layout {
None => Ok((StackDirection::Vertical, 0, Align::Stretch)),
Some(LayoutHint::Stack {
direction,
gap,
align_items,
..
}) => {
if *direction == StackDirection::Horizontal {
return Err(format!(
"root layout type stack direction horizontal is not document flow. Nest the horizontal stack under a child, e.g. root → root.row.{ROOT_FLOW_NEST}"
));
}
Ok((*direction, *gap, *align_items))
}
Some(LayoutHint::Grid { .. }) => Err(format!(
"root layout type grid is not document flow (children would paginate as a vertical stack). Nest the grid under a child, e.g. root → root.grid.{ROOT_FLOW_NEST}"
)),
Some(LayoutHint::Overlay { .. }) => Err(format!(
"root layout type overlay is not document flow. Nest the overlay under a child container.{ROOT_FLOW_NEST}"
)),
Some(LayoutHint::Columns { .. }) => Err(format!(
"root layout type columns is not document flow. Nest the columns container under a child, e.g. root → root.columns.{ROOT_FLOW_NEST}"
)),
}
}
pub struct LayoutEngine;
impl LayoutEngine {
pub fn compile_chunk(
content_json: &str,
theme_json: &str,
font_data: &[u8],
) -> Result<String, String> {
crate::compile::compile_chunk(content_json, theme_json, font_data, None)
}
pub fn compile_chunk_with_assets(
content_json: &str,
theme_json: &str,
font_data: &[u8],
assets: &k2f_core::AssetsMap,
) -> Result<String, String> {
crate::compile::compile_chunk(content_json, theme_json, font_data, Some(assets))
}
pub fn layout(manifest: &Manifest, ctx: &LayoutContext) -> Result<LayoutResult, String> {
let mut derived_ctx = LayoutContext::new(ctx.fonts, ctx.theme);
derived_ctx.list_markers =
crate::list_markers::derive_list_marker_map(&manifest.root, ctx.theme)?;
let ctx = &derived_ctx;
crate::pagination::validate_page_config(&manifest.page_config)?;
use k2f_core::NodeContent;
let root_padding = padding_for_role_variant(
&manifest.root.role,
manifest.root.variant.as_deref(),
ctx.theme,
)?;
let mut page_config = manifest.page_config.clone();
page_config.margin[0] = page_config.margin[0] + root_padding.top;
page_config.margin[1] = page_config.margin[1] + root_padding.right;
page_config.margin[2] = page_config.margin[2] + root_padding.bottom;
page_config.margin[3] = page_config.margin[3] + root_padding.left;
crate::pagination::validate_page_config(&page_config)?;
let mut paginator = Paginator::new(page_config.clone(), manifest.canvas_mode);
let content_width = crate::pagination::content_width(&page_config);
if let NodeContent::Container { children } = &manifest.root.content {
let (_direction, gap_i64, align_items) =
root_flow_layout(manifest.root.layout.as_ref())?;
crate::flow::paginate_flow_items(
children,
&mut paginator,
content_width,
Pt(gap_i64 as i128),
align_items,
manifest.canvas_mode,
ctx,
)?;
} else {
crate::flow::paginate_flow_items(
std::slice::from_ref(&manifest.root),
&mut paginator,
content_width,
Pt::ZERO,
k2f_core::Align::Start,
manifest.canvas_mode,
ctx,
)?;
}
let mut pages = paginator.pages;
if manifest.canvas_mode == CanvasMode::Paged && !manifest.running_blocks.is_empty() {
crate::running_blocks::inject_running_blocks(manifest, &mut pages, ctx)?;
}
Ok(LayoutResult { pages })
}
}
#[cfg(test)]
mod arrange_tests;
#[cfg(test)]
mod code_role_tests;
#[cfg(test)]
mod columns_tests;
#[cfg(test)]
mod compile_svg_tests;
#[cfg(test)]
mod form_field_layout_tests;
#[cfg(test)]
mod grid_tests;
#[cfg(test)]
mod math_layout_tests;
#[cfg(test)]
mod measure_tests;
#[cfg(test)]
mod pagination_tests;
#[cfg(test)]
mod table_pagination_tests;
#[cfg(test)]
mod table_tests;
#[cfg(test)]
pub mod test_utils;