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

mod util;
pub use util::*;
mod common;
pub use common::*;
mod emmy;
pub use emmy::*;
mod node;
pub use node::*;
mod tags;
pub use tags::*;

use std::fmt::Display;

use chumsky::{prelude::Simple, Parser, Stream};

// A TYPE could be
// - primary = string|number|boolean
// - fn = func(...):string
// - enum = "one"|"two"|"three"
// - or: primary (| primary)+
// - optional = primary?
// - table = table<string, string>
// - array = primary[]

// ---@tag @comment

// ---@field [public|protected|private] field_name FIELD_TYPE[|OTHER_TYPE] [@comment]

// ---@param param_name MY_TYPE[|other_type] [@comment]

// ---@type MY_TYPE[|OTHER_TYPE] [@comment]

// ---@alias NEW_NAME TYPE [@comment]

// ---@see @comment

// ---@return MY_TYPE[|OTHER_TYPE] [@comment]

#[derive(Debug, Default)]
pub struct Rename {
    /// Prefix `function` name with `---@mod` name
    pub func: bool,
    /// Prefix `---@alias` tag with `return/---@mod` name
    pub alias: bool,
    /// Prefix ---@class tag with return/---@mod name
    pub class: bool,
    /// Prefix `---@type` tag with `---@mod` name
    pub r#type: bool,
}

#[derive(Debug, Default)]
pub struct LemmyHelp {
    rename: Rename,
    pub nodes: Vec<Node>,
}

impl LemmyHelp {
    pub fn with_rename(rename: Rename) -> Self {
        Self {
            rename,
            nodes: vec![],
        }
    }

    pub fn parse(&mut self, src: &str) -> Result<&Self, Vec<Simple<TagType>>> {
        self.nodes.append(&mut Self::lex(src)?);

        Ok(self)
    }

    /// Prepare nodes for help doc generation
    pub fn for_help(&mut self, src: &str) -> Result<&Self, Vec<Simple<TagType>>> {
        let mut nodes = Self::lex(src)?;

        if let Some(Node::Export(export)) = nodes.pop() {
            let module = match nodes.iter().rev().find(|x| matches!(x, Node::Module(_))) {
                Some(Node::Module(m)) => m.name.to_owned(),
                _ => export.to_owned(),
            };

            for ele in nodes {
                match ele {
                    Node::Export(..) => {}
                    Node::Func(mut func) => {
                        if func.is_public(&export) {
                            if self.rename.func {
                                func.rename_tag(module.to_owned());
                            }
                            self.nodes.push(Node::Func(func));
                        }
                    }
                    Node::Type(mut typ) => {
                        if typ.is_public(&export) {
                            if self.rename.r#type {
                                typ.rename_tag(module.to_owned());
                            }
                            self.nodes.push(Node::Type(typ));
                        }
                    }
                    Node::Alias(mut alias) => {
                        if self.rename.alias {
                            alias.rename_tag(module.to_owned());
                        }
                        self.nodes.push(Node::Alias(alias))
                    }
                    Node::Class(mut class) => {
                        if self.rename.class {
                            class.rename_tag(module.to_owned());
                        }
                        self.nodes.push(Node::Class(class))
                    }
                    _ => self.nodes.push(ele),
                }
            }
        };

        Ok(self)
    }

    fn lex(src: &str) -> Result<Vec<Node>, Vec<Simple<TagType>>> {
        let tokens = Emmy::parse(src).unwrap();
        let stream = Stream::from_iter(src.len()..src.len() + 1, tokens.into_iter());

        Node::parse().repeated().flatten().parse(stream)
    }
}

impl Display for LemmyHelp {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        for node in &self.nodes {
            if let Node::Toc(x) = node {
                writeln!(
                    f,
                    "{}",
                    Module {
                        name: x.to_string(),
                        desc: Some("Table of Contents".into())
                    }
                )?;

                for nodde in &self.nodes {
                    if let Node::Module(x) = nodde {
                        let desc = x.desc.as_deref().unwrap_or_default();

                        writeln!(
                            f,
                            "{desc}{}",
                            format_args!("{:·>w$}", format!("|{}|", x.name), w = 80 - desc.len())
                        )?;
                    }
                }

                writeln!(f)?;
            } else {
                writeln!(f, "{node}")?;
            }
        }

        Ok(())
    }
}