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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
use std::{error::Error, str};

use tree_sitter::{Node, Parser, Point, TreeCursor};

#[derive(Debug, PartialEq)]
pub struct VimModule {
    pub nodes: Vec<VimNode>,
}

#[derive(Debug, PartialEq)]
pub enum VimNode {
    StandaloneDocComment(String),
    Function { name: String, doc: Option<String> },
}

#[derive(Default)]
pub struct VimParser {
    parser: Parser,
}

impl VimParser {
    pub fn new() -> VimParser {
        let mut parser = Parser::new();
        parser
            .set_language(&tree_sitter_vim::language())
            .expect("Error loading Vim grammar");
        VimParser { parser }
    }

    pub fn parse_module(&mut self, code: &str) -> Result<VimModule, Box<dyn Error>> {
        let tree = self.parser.parse(code, None).unwrap();
        let mut tree_cursor = tree.walk();
        let mut nodes: Vec<VimNode> = Vec::new();
        let mut last_block_comment: Option<(String, Point)> = None;
        tree_cursor.goto_first_child();
        loop {
            let node = tree_cursor.node();
            if let Some((finished_comment_text, _)) =
                last_block_comment.take_if(|(_, next_pos)| *next_pos != node.start_position())
            {
                // Block comment wasn't immediately above the next node.
                // Treat it as bare standalone doc comment.
                nodes.push(VimNode::StandaloneDocComment(finished_comment_text));
            }
            match node.kind() {
                "comment" => {
                    if let Some((finished_comment_text, _)) = last_block_comment.take() {
                        // New comment block after dangling comment block.
                        nodes.push(VimNode::StandaloneDocComment(finished_comment_text));
                    }
                    last_block_comment =
                        VimParser::consume_block_comment(&mut tree_cursor, code.as_bytes());
                }
                "function_definition" => {
                    let decl = node
                        .children(&mut tree_cursor)
                        .find(|c| c.kind() == "function_declaration")
                        .unwrap();
                    let funcname_node = decl
                        .children(&mut tree_cursor)
                        .find(|c| c.kind() == "identifier")
                        .unwrap();
                    let doc = last_block_comment
                        .take()
                        .map(|(comment_text, _)| comment_text);
                    nodes.push(VimNode::Function {
                        name: VimParser::get_node_text(&funcname_node, code.as_bytes()).to_string(),
                        doc,
                    });
                }
                _ => {
                    // Silently ignore other node kinds.
                }
            }
            if !tree_cursor.goto_next_sibling() {
                break;
            }
        }
        // Consume any dangling last_block_comment.
        if let Some((comment_text, _)) = last_block_comment.take() {
            nodes.push(VimNode::StandaloneDocComment(comment_text));
        };
        Ok(VimModule { nodes })
    }

    fn consume_block_comment(
        tree_cursor: &mut TreeCursor,
        source: &[u8],
    ) -> Option<(String, Point)> {
        let node = tree_cursor.node();
        assert_eq!(node.kind(), "comment");
        let cur_pos = node.start_position();
        let mut next_pos = Point {
            row: cur_pos.row + 1,
            ..cur_pos
        };

        let mut comment_lines: Vec<String> = Vec::new();
        let comment_node_text = VimParser::get_node_text(&node, source);
        if let Some(leader_text) = comment_node_text.strip_prefix("\"\"") {
            // Valid leader, start comment block.
            if !leader_text.trim().is_empty() {
                // Treat trailing text after leader as first comment line.
                comment_lines.push(
                    leader_text
                        .strip_prefix(" ")
                        .unwrap_or(leader_text)
                        .to_owned(),
                );
            }
        } else {
            // Regular non-doc comment, ignore and let parsing skip.
            return None;
        }

        // Consume remaining comment lines at same indentation.
        while tree_cursor.goto_next_sibling() {
            let node = tree_cursor.node();
            if node.kind() != "comment" || node.start_position() != next_pos {
                // Back up so cursor still points to last consumed node.
                tree_cursor.goto_previous_sibling();
                break;
            }
            next_pos = Point {
                row: next_pos.row + 1,
                ..next_pos
            };
            let node_text = VimParser::get_node_text(&node, source);
            let comment_body = match &node_text[1..] {
                t if t.starts_with(" ") => &t[1..],
                t => t,
            };
            comment_lines.push(comment_body.to_owned());
        }
        Some((comment_lines.join("\n"), next_pos))
    }

    fn get_node_text<'a>(node: &Node, source: &'a [u8]) -> &'a str {
        str::from_utf8(&source[node.byte_range()]).unwrap()
    }
}

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

    #[test]
    fn parse_empty() {
        let mut parser = VimParser::new();
        let module = parser.parse_module("").unwrap();
        assert_eq!(module, VimModule { nodes: vec![] });
    }

    #[test]
    fn parse_one_nondoc_comment() {
        let mut parser = VimParser::new();
        let module = parser.parse_module("\" A comment").unwrap();
        assert_eq!(module, VimModule { nodes: vec![] });
    }

    #[test]
    fn parse_one_doc() {
        let code = r#"
""
" Foo
"#;
        let mut parser = VimParser::new();
        let module = parser.parse_module(code).unwrap();
        assert_eq!(
            module,
            VimModule {
                nodes: vec![VimNode::StandaloneDocComment("Foo".into())],
            }
        );
    }

    #[test]
    fn parse_messy_multiline_doc() {
        let code = r#"
"" Foo
"bar
"#;
        let mut parser = VimParser::new();
        let module = parser.parse_module(code).unwrap();
        assert_eq!(
            module,
            VimModule {
                nodes: vec![VimNode::StandaloneDocComment("Foo\nbar".into())],
            }
        );
    }

    #[test]
    fn parse_bare_function() {
        let code = r#"
func MyFunc() abort
  return 1
endfunc
"#;
        let mut parser = VimParser::new();
        let module = parser.parse_module(code).unwrap();
        assert_eq!(
            module,
            VimModule {
                nodes: vec![VimNode::Function {
                    name: "MyFunc".into(),
                    doc: None,
                }],
            }
        );
    }

    #[test]
    fn parse_doc_and_function() {
        let code = r#"
""
" Does a thing.
"
" Call and enjoy.
func MyFunc() abort
  return 1
endfunc
"#;
        let mut parser = VimParser::new();
        let module = parser.parse_module(code).unwrap();
        assert_eq!(
            module,
            VimModule {
                nodes: vec![VimNode::Function {
                    name: "MyFunc".into(),
                    doc: Some("Does a thing.\n\nCall and enjoy.".into()),
                }],
            }
        );
    }

    #[test]
    fn parse_two_docs() {
        let code = r#"
"" One doc

"" Another doc
"#;
        let mut parser = VimParser::new();
        let module = parser.parse_module(code).unwrap();
        assert_eq!(
            module,
            VimModule {
                nodes: vec![
                    VimNode::StandaloneDocComment("One doc".into()),
                    VimNode::StandaloneDocComment("Another doc".into()),
                ],
            }
        );
    }

    #[test]
    fn parse_different_doc_indentations() {
        let code = r#"
"" One doc
 " Ignored comment
"#;
        let mut parser = VimParser::new();
        let module = parser.parse_module(code).unwrap();
        assert_eq!(
            module,
            VimModule {
                nodes: vec![
                    VimNode::StandaloneDocComment("One doc".into()),
                    // Comment at different indentation is treated as a normal
                    // non-doc comment and ignored.
                ],
            }
        );
    }

    #[test]
    fn parse_unicode() {
        let code = r#"
""
" Fun stuff 🎈 ( ͡° ͜ʖ ͡°)
"#;
        let mut parser = VimParser::new();
        let module = parser.parse_module(code).unwrap();
        assert_eq!(
            module,
            VimModule {
                nodes: vec![VimNode::StandaloneDocComment(
                    "Fun stuff 🎈 ( ͡° ͜ʖ ͡°)".into()
                )],
            }
        );
    }
}