aboutsummaryrefslogtreecommitdiff
path: root/tools/gen_config_doc.py
blob: e309da942b5e8016fac7a0361eac637b9bc0570e (plain)
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
#!/usr/bin/python

import re
import os


_KEYS_FILE = os.path.join(
    os.path.dirname(__file__), "../src/main/java/org/traccar/config/Keys.java"
)

def get_config_key_descriptions():
    desc_re = re.compile(r"(/\*\*\n|\s+\*/|\s+\*)")
    key_match_re = re.compile(r"\(\n(.+)\);", re.DOTALL)
    key_split_re = re.compile(r",\s+", re.DOTALL)
    snippets = []

    with open(_KEYS_FILE, "r") as f:
        code = f.read()
        config = re.findall(
            r"(/\*\*.*?\*/)\n\s+(public static final Config.*?;)", code, re.DOTALL
        )
        for i in config:
            try:
                key_match = key_match_re.search(i[1])
                if key_match:
                    description = "<br /> ".join(
                        [
                            x.strip().replace("\n", "")
                            for x in desc_re.sub("\n", i[0]).strip().split("\n\n")
                        ]
                    )
                    terms = [x.strip() for x in key_split_re.split(key_match.group(1))]
                    key = terms[0].replace('"', "")
                    default = terms[2] if len(terms) == 3 else None
                    snippets.append(
                        f"""        <div class="card mt-3">
          <div class="card-body">
              <h5 class="card-title">
                {key} <span class="badge badge-dark">config</span>
              </h5>
              <p class="card-text">
                {description}{f"<br/ > Default: {default}." if default else ""}
              </p>
          </div>
        </div>"""
                    )
            except IndexError:
                # will continue if key_match.group(1) or terms[0] does not exist
                # for some reason
                pass

    return ("\n").join(snippets)


if __name__ == "__main__":
    html = get_config_key_descriptions()
    print(html)