oak-typst 0.0.11

Typst document typesetting language parser with support for modern document typesetting and markup processing.
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

#![doc = include_str!("readme.md")]
use oak_core::Range;

/// Typst AST root node.
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct TypstRoot {
    /// The byte range span of this root node in the source text.
    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
    pub span: Range<usize>,
    /// The list of child items in this root node.
    pub items: Vec<TypstItem>,
}

impl TypstRoot {
    /// Creates a new TypstRoot with the given span.
    pub fn new(span: Range<usize>) -> Self {
        Self { span, items: Vec::new() }
    }
}

/// A syntax item in a Typst document.
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum TypstItem {
    /// Plain text content.
    Text(String),
    /// Whitespace between items.
    Space,
    /// Paragraph break.
    Parbreak,
    /// A heading with level and content.
    Heading(TypstHeading),
    /// Strong (bold) text content.
    Strong(TypstRoot),
    /// Emphasized (italic) text content.
    Emphasis(TypstRoot),
    /// Mathematical content.
    Math(TypstRoot),
    /// Quoted content.
    Quote(TypstRoot),
    /// A list item.
    ListItem(TypstRoot),
    /// An enumerated list item.
    EnumItem(TypstRoot),
    /// A hyperlink.
    Link(TypstLink),
    /// Raw (verbatim) text content.
    Raw(String),
    /// A block element.
    Block(TypstRoot),
}

/// A heading in a Typst document.
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct TypstHeading {
    /// The heading level (1-6).
    pub level: usize,
    /// The heading content.
    pub content: TypstRoot,
}

/// A hyperlink in a Typst document.
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct TypstLink {
    /// The URL of the link.
    pub url: String,
    /// Optional link content (display text).
    pub content: Option<TypstRoot>,
}