cosy 0.1.1

A parser for Cosense/Scrapbox markup syntax that produces a typed AST
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
131
132
133
134

//! Inline-level AST nodes.

// --------------------------------------------------------
// Inline level (character-based structure)
// --------------------------------------------------------

/// Represents an inline-level element (node) within a block.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
#[derive(Debug, PartialEq, Clone)]
pub enum Node<T> {
    /// Plain text.
    Text(String),

    /// A link (internal or external).
    ///
    /// Requires `T` because the label contains `Node`s.
    Link(Link<T>),

    /// An image reference.
    Image(url::Url),

    /// An image with a clickable link.
    LinkedImage {
        /// URL of the image to display.
        src: url::Url,
        /// URL to navigate to when clicked.
        href: url::Url,
    },

    /// An icon reference.
    Icon {
        /// The name of the icon.
        name: String,
        /// The repetition count of the icon.
        count: usize,
    },

    /// Inline code snippet.
    InlineCode(String),

    /// Mathematical expression.
    Math(String),

    /// A hashtag reference (e.g., `#タグ名`).
    Hashtag(String),

    /// Decorated text (bold, italic, etc.).
    ///
    /// Requires `T` due to recursive structure.
    Decoration {
        /// The decoration characters (e.g., "*", "*-").
        decos: String,
        /// The content inside the decoration.
        nodes: Vec<Node<T>>,
    },

    /// Strong (large bold) content rendered by `[[...]]`.
    ///
    /// The inner content is parsed as inline nodes, so nested syntax
    /// such as links and hashtags is supported.
    Strong(Vec<Node<T>>),

    /// A geographic coordinate rendered as a map embed.
    ///
    /// Parsed from `[N35.65,E139.74]` or `[N35.65,E139.74,Z14]`.
    Coordinate {
        /// Latitude value (e.g., `35.6578589`).
        latitude: Latitude,
        /// Longitude value (e.g., `139.7474797`).
        longitude: Longitude,
        /// Optional zoom level (e.g., `Some(14)`).
        zoom: Option<u32>,
    },

    /// A custom inline-level extension.
    ///
    /// This allows for extending the parser with custom inline types (e.g., colored text, warning badges).
    Custom(T),
}

/// Latitude value in [`Node::Coordinate`].
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, PartialEq, Clone, Copy)]
pub enum Latitude {
    /// Northern hemisphere (`N` prefix).
    North(f64),
    /// Southern hemisphere (`S` prefix).
    South(f64),
}

/// Longitude value in [`Node::Coordinate`].
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, PartialEq, Clone, Copy)]
pub enum Longitude {
    /// Eastern hemisphere (`E` prefix).
    East(f64),
    /// Western hemisphere (`W` prefix).
    West(f64),
}

/// Represents a link target and optional label.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
#[derive(Debug, PartialEq, Clone)]
pub enum Link<T> {
    /// A link to another page (internal link).
    Page(String),
    /// A raw URL (external link).
    Url(url::Url),
    /// A link with an explicit label.
    ///
    /// `WithLabel` is only produced when one of the bracket tokens parses as
    /// a URL, so `href` is always a valid [`url::Url`].
    WithLabel {
        /// The destination URL.
        href: url::Url,
        /// The label content, which can contain other inline nodes.
        ///
        /// The label might contain `Custom` nodes.
        label: Vec<Node<T>>,
    },

    /// A cross-project link to a project's home: [/project] or [/project/]
    Project(String),

    /// A cross-project page link: [/project/page]
    ProjectPage {
        /// The target project name.
        project: String,
        /// The target page name within the project.
        page: String,
    },
}