moonwave 1.3.0

Moonwave is a tool for generating documentation from comments in Lua source code.
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

use std::{fmt, ops::Deref};

use crate::{diagnostic::Diagnostic, doc_comment::DocComment};

#[derive(Debug, Copy, Clone, Default)]
pub struct Span<'a> {
    source: &'a str,
    pub start: usize,
    pub len: usize,
    pub file_id: usize,
    pub source_offset: usize,
}

impl Span<'static> {
    pub fn empty(file_id: usize) -> Self {
        Span {
            source: "",
            file_id,
            ..Default::default()
        }
    }
}

impl<'a> Span<'a> {
    pub fn dummy(source: &'a str) -> Self {
        Self {
            source,
            len: source.len(),
            ..Default::default()
        }
    }

    pub fn slice(&self, start: usize, len: usize) -> Self {
        Self {
            start: self.start + start,
            len,
            ..*self
        }
    }

    pub fn as_str(&self) -> &'a str {
        &self.source[self.start..self.start + self.len]
    }

    pub fn lines(self) -> impl Iterator<Item = Span<'a>> {
        self.as_str().lines().map(move |line| self.from_slice(line))
    }

    pub fn splitn(self, n: usize, pat: &'static str) -> impl Iterator<Item = Span<'a>> {
        self.as_str()
            .splitn(n, pat)
            .map(move |piece: &'a str| self.from_slice(piece))
    }

    pub fn trim(self) -> Self {
        self.from_slice(self.as_str().trim())
    }

    pub fn strip_prefix(self, prefix: &str) -> Option<Self> {
        Some(self.from_slice(self.as_str().strip_prefix(prefix)?))
    }

    pub fn diagnostic<S: Into<String>>(self, text: S) -> Diagnostic {
        Diagnostic::from_span(text, self)
    }

    pub fn replace(&mut self, span: Self) {
        *self = span // Is this legal?
    }

    fn from_slice(&self, text: &'a str) -> Self {
        let start = text.as_ptr() as usize - self.source.as_ptr() as usize;

        Span {
            start,
            len: text.len(),
            ..*self
        }
    }
}

impl PartialEq for Span<'_> {
    fn eq(&self, other: &Self) -> bool {
        self.as_str() == other.as_str()
    }
}

impl fmt::Display for Span<'_> {
    fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
        formatter.write_str(self.as_str())
    }
}

impl serde::Serialize for Span<'_> {
    fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        serializer.serialize_str(self.as_str())
    }
}

impl Deref for Span<'_> {
    type Target = str;
    fn deref(&self) -> &str {
        self.as_str()
    }
}

impl<'a> From<&'a DocComment> for Span<'a> {
    fn from(doc: &'a DocComment) -> Self {
        Span {
            source: &doc.comment,
            len: doc.comment.len(),
            file_id: doc.file_id,
            source_offset: doc.start,
            ..Default::default()
        }
    }
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn correct_deref() {
        let text = "abcdef";
        let span = Span::dummy(text);

        let deref_check: &str = &span;
        assert_eq!(deref_check, text);

        let slice = span.slice(1, 3);
        let deref_slice_check: &str = &slice;
        assert_eq!(deref_slice_check, "bcd");

        let slice = slice.slice(1, 2);
        let deref_slice_check: &str = &slice;
        assert_eq!(deref_slice_check, "cd");
    }

    #[test]
    fn lines() {
        let text = "hello\nworld!\nipsum";
        let span = Span::dummy(text);

        let lines: Vec<_> = span.lines().map(|line| line.as_str()).collect();
        assert_eq!(lines, &["hello", "world!", "ipsum"]);
    }

    #[test]
    fn trim() {
        let text = "    hello       ";
        let span = Span::dummy(text);

        assert_eq!(span.trim().as_str(), "hello");
    }
}