hwpforge-core 0.9.0

Format-independent Document Object Model for HwpForge
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

//! HwpForge Core: format-independent Document Object Model.
//!
//! This crate defines the universal document structure used across
//! all HwpForge format conversions. It is the **Anvil** in the Forge
//! metaphor -- the surface on which all documents are shaped.
//!
//! # Architecture
//!
//! Core sits one layer above Foundation:
//!
//! ```text
//! foundation (primitives: HwpUnit, Color, Index<T>)
//!     |
//!     v
//! core (this crate: Document, Section, Paragraph, Run)
//!     |
//!     v
//! blueprint (styles: CharShape, ParaShape, Template)
//!     |
//!     v
//! smithy-* (format codecs: HWPX, HWP5, Markdown)
//! ```
//!
//! Core has zero knowledge of XML, binary formats, or Markdown.
//! It references style definitions by branded indices (Foundation's
//! [`CharShapeIndex`](hwpforge_foundation::CharShapeIndex),
//! [`ParaShapeIndex`](hwpforge_foundation::ParaShapeIndex)) without
//! depending on Blueprint.
//!
//! # Document Lifecycle (Typestate)
//!
//! ```text
//! Document<Draft>  --(validate)-->  Document<Validated>
//!    (mutable)                         (immutable)
//! ```
//!
//! - [`Draft`] documents can be modified (add sections, set metadata).
//! - [`Validated`] documents are structurally sound and ready for export.
//! - Deserialization always produces `Draft` (must re-validate).
//!
//! # DOM Hierarchy
//!
//! ```text
//! Document
//!   +-- Metadata
//!   +-- Section[]
//!         +-- PageSettings
//!         +-- Paragraph[]
//!               +-- Run[]
//!                     +-- RunContent
//!                           +-- Text(String)
//!                           +-- Table(Box<Table>)
//!                           +-- Image(Image)
//!                           +-- Control(Box<Control>)
//! ```
//!
//! # Examples
//!
//! ```
//! use hwpforge_core::*;
//! use hwpforge_core::run::Run;
//! use hwpforge_core::section::Section;
//! use hwpforge_core::paragraph::Paragraph;
//! use hwpforge_foundation::{CharShapeIndex, ParaShapeIndex};
//!
//! let mut doc = Document::new();
//! doc.add_section(Section::with_paragraphs(
//!     vec![Paragraph::with_runs(
//!         vec![Run::text("Hello, HwpForge!", CharShapeIndex::new(0))],
//!         ParaShapeIndex::new(0),
//!     )],
//!     PageSettings::a4(),
//! ));
//!
//! let validated = doc.validate().unwrap();
//! assert_eq!(validated.section_count(), 1);
//! ```

#![deny(missing_docs)]
#![deny(unsafe_code)]
#![deny(clippy::all)]

pub mod caption;
pub mod chart;
pub mod column;
pub mod control;
pub mod document;
pub mod error;
pub mod image;
pub mod inline;
pub mod metadata;
pub mod numbering;
pub mod object_id;
pub mod page;
pub mod paragraph;
pub mod run;
pub mod section;
pub mod style_lookup;
pub mod tab;
pub mod table;

mod validate;

// ---------------------------------------------------------------------------
// Re-exports for convenience
// ---------------------------------------------------------------------------

pub use caption::{Caption, CaptionSide, DEFAULT_CAPTION_GAP};
pub use chart::{ChartData, ChartGrouping, ChartSeries, ChartType, LegendPosition, XySeries};
pub use column::{ColumnDef, ColumnLayoutMode, ColumnSettings, ColumnType};
pub use control::{
    ArrowStyle, Control, DutmalMetadata, Fill, LineStyle, MemoMetadata, ShapePoint, ShapeStyle,
};
pub use document::{Document, Draft, Validated};
pub use error::{CoreError, CoreErrorCode, CoreResult, ValidationError};
pub use image::{Image, ImageFormat, ImageStore};
pub use inline::{InlineSegment, InlineTabAttr, InlineText};
pub use metadata::Metadata;
pub use numbering::{BulletDef, NumberingDef, ParaHead, ParagraphListRef};
pub use object_id::ObjectId;
pub use page::PageSettings;
pub use paragraph::Paragraph;
pub use run::{Run, RunContent};
pub use section::{
    BeginNum, ContentCounts, HeaderFooter, LineNumberShape, MasterPage, PageBorderFillEntry,
    PageNumber, Section, Visibility,
};
pub use style_lookup::StyleLookup;
pub use tab::{TabDef, TabStop};
pub use table::{Table, TableCell, TableRow};