sim-codec-doc 0.1.1

Markup document codec backends for SIM.
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

//! Markup document domain codec for SIM.
//!
//! Provides `codec:doc`, a domain decoder/encoder pair that turns document text
//! into a semantic markup document `Expr` and back, strict
//! `codec:markup/<id>` backends for Markdown, Typst, AsciiDoc, and LaTeX, and
//! provenance-preserving chunk operations exposed as callable functions.
//! As a domain codec it round-trips only documents and chunks and fails closed
//! outside that domain.
//!
//! Module map (all modules are private; the public surface is re-exported from
//! this crate root):
//! - backend: the `MarkupBackend` trait, deterministic `BackendRegistry`, and
//!   fidelity/error contracts for backend implementations.
//! - catalog: the implemented/tracked backend catalog for markup formats.
//! - codec: the `DocCodec` decoder/encoder, the `DocCodecLib` host lib, and
//!   `install_doc_codec` plus `codec:markup/<id>` installation.
//! - document: compatibility chunking wrappers (`DocValue`, `DocFormat`,
//!   `DocBlock`, `DocChunk`, `ChunkOp`), `decode_document`, and `chunk`.
//! - edit: reversible document-domain edits over `MarkupDoc`.
//! - markup: the shared semantic markup IR (`MarkupDoc`, `MarkupBlock`,
//!   `Inline`) and its ordinary-data projection.
//! - functions: the `doc/chunk-*` chunking functions registered as callables.
//! - asciidoc: the `asciidork-parser` AsciiDoc backend.
//! - latex: the `codebook-tree-sitter-latex` LaTeX backend.
//! - markdown: the `pulldown-cmark` Markdown backend.
//! - typst_backend: the `typst-syntax` Typst backend.

#![forbid(unsafe_code)]
#![deny(missing_docs)]

mod asciidoc;
#[cfg(test)]
mod asciidoc_tests;
mod backend;
mod catalog;
#[cfg(test)]
mod catalog_tests;
mod codec;
mod document;
mod edit;
#[cfg(test)]
mod edit_tests;
mod functions;
mod latex;
#[cfg(test)]
mod latex_tests;
mod markdown;
mod markdown_writer;
mod markup;
#[cfg(test)]
mod tests;
mod typst_backend;

/// Cookbook recipes embedded from this crate's `recipes/` directory.
pub static RECIPES: sim_cookbook::EmbeddedDir =
    include!(concat!(env!("OUT_DIR"), "/cookbook_recipes.rs"));

pub use asciidoc::AsciiDocBackend;
pub use backend::{
    BackendRegistry, BasicMarkdownBackend, MarkupBackend, MarkupDecodeOptions, MarkupEncodeOptions,
    MarkupError, MarkupFidelity, MarkupLoss, default_backend_registry,
};
pub use catalog::{BackendInfo, BackendStatus, backend_catalog};
pub use codec::{
    DocCodec, DocCodecLib, MARKUP_CODEC_PREFIX, MarkupCodec, install_doc_codec,
    install_markup_codecs, markup_codec_symbol,
};
pub use document::{
    ChunkOp, DocBlock, DocBlockKind, DocChunk, DocFormat, DocValue, chunk, decode_document,
};
pub use edit::{MarkupEdit, apply_edit, invert_edit};
pub use latex::LatexBackend;
pub use markdown::MarkdownBackend;
pub use markup::{
    BackendId, Inline, MarkupBlock, MarkupDoc, MathSource, SourceDoc, Span, SpanState,
    decode_markup_doc,
};
pub use typst_backend::TypstBackend;