dmos 0.7.0

Djot HTML renderer with advanced features
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
135

use std::cmp::Ordering;

use jotdown::{Container, Event, Render};

use crate::TocOpts;

/// Implementation of [`jotdown::Render`] that renders a document's table of contents as HTML.
#[derive(Default)]
pub struct TocRenderer {
    opts: TocOpts,

    current_level: u16,
    nesting: u16,
    in_heading: bool,
    title_skipped: bool,
}

impl TocRenderer {
    /// Create a new renderer with the given options.
    ///
    /// See the [`TocOpts`] for a detailed description of the available
    /// settings.
    pub fn new(opts: TocOpts) -> Self {
        TocRenderer {
            opts,
            current_level: 0,
            nesting: 0,
            in_heading: false,
            title_skipped: false,
        }
    }
}

impl<'s> Render<'s> for TocRenderer {
    fn push_event<W>(&mut self, event: Event<'_>, out: W) -> std::fmt::Result
    where
        W: std::fmt::Write,
    {
        self.render_event(&event, out)
    }
}

impl TocRenderer {
    fn render_event<W>(&mut self, e: &Event<'_>, mut out: W) -> std::fmt::Result
    where
        W: std::fmt::Write,
    {
        match e {
            Event::Start(Container::Document, _) => self.render_prologue(out)?,
            Event::End(Container::Document) => self.render_epilogue(out)?,
            Event::Start(
                Container::Heading {
                    level,
                    has_section: _,
                    id,
                },
                _attrs,
            ) => {
                if !self.opts.skip_title || self.title_skipped {
                    self.in_heading = true;
                    match self.current_level.cmp(level) {
                        Ordering::Less => {
                            self.current_level = *level;
                            self.nesting += 1;
                            out.write_str(if self.nesting > 1 {
                                "\n<ul>\n"
                            } else {
                                "<ol>\n"
                            })?;
                        }
                        Ordering::Greater => {
                            while self.current_level > *level {
                                if self.nesting > 1 {
                                    self.nesting -= 1;
                                    out.write_str("</li>\n</ul>\n</li>\n")?;
                                }
                                self.current_level -= 1;
                            }
                        }
                        Ordering::Equal => {
                            out.write_str("</li>\n")?;
                        }
                    }

                    out.write_str("<li><a href=\"#")?;
                    out.write_str(id)?;
                    out.write_str("\">")?;
                }
            }
            Event::End(Container::Heading {
                level,
                has_section: _,
                id: _,
            }) => {
                if !self.opts.skip_title || self.in_heading {
                    out.write_str("</a>")?;
                }
                self.in_heading = false;
                if *level == 1 && self.opts.skip_title {
                    self.title_skipped = true;
                }
            }
            Event::Str(s) => {
                if self.in_heading {
                    out.write_str(s)?;
                }
            }
            _ => (),
        }
        Ok(())
    }

    fn render_prologue<W>(&mut self, mut out: W) -> std::fmt::Result
    where
        W: std::fmt::Write,
    {
        out.write_str(&self.opts.prologue)?;
        out.write_str("\n")
    }

    fn render_epilogue<W>(&mut self, mut out: W) -> std::fmt::Result
    where
        W: std::fmt::Write,
    {
        while self.nesting > 1 {
            out.write_str("\n</ul>\n")?;
            self.nesting -= 1;
        }
        if self.nesting > 0 {
            out.write_str("</li>\n</ol>\n")?;
        }
        out.write_str(&self.opts.epilogue)?;
        Ok(())
    }
}