docgen/doc_def.py at main · HatchGameEngine/docgen · GitHub

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
import doc_globals

import re

from enums import DefType, defTypeNames
from namespace_info import NamespaceInfo

class DocDef:
  def __init__(self):
    self.type = None
    self.title = None
    self.description = None
    self.deprecated = None
    self.namespace = None

  def get_title(self):
    if DefType.is_field(self.type) or self.type == DefType.METHOD:
      namespace = self.namespace
      return namespace + "." + self.title
    return self.title

  def get_name_for_html(self):
    return self.get_title().replace('.', '_')

  def get_href(self):
    return "Reference_" + defTypeNames[self.type][0] + "_" + self.get_name_for_html()

  def add(doc_def):
    doc_globals.href[doc_def.get_title()] = doc_def.get_href()

    group = doc_globals.lists[doc_def.type.value]
    group.doc_list.append(doc_def)
    group.count += 1

    NamespaceInfo.add_for_doc_def(group, doc_def)

    if DefType.is_field(doc_def.type):
      doc_globals.lists[DefType.FUNCTION.value].add_namespace(doc_def)

    if DefType.is_descriptive(doc_def.type):
      doc_globals.descriptions[doc_def.title] = doc_def

  def find_description(title):
    if title in doc_globals.descriptions:
      return doc_globals.descriptions[title]

    return None

class ParamDef:
  DEFAULT_PATTERN = r'\(default:\s*`([^`]+)`\)'

  def __init__(self, text, optional):
    self.text = text
    self.label = text[0:text.find('(')].strip()
    self.description = text[text.find(':')+1:].strip()
    self.type = re.search(r'\((.+?)\)', text[0:text.find(':')]).group(1)
    self.default_value = None
    self.optional = optional

    match = re.search(self.DEFAULT_PATTERN, self.description)
    if match:
      self.default_value = match.group(1)
      self.description = re.sub(self.DEFAULT_PATTERN, '', self.description)

class FunctionDef(DocDef):
  def __init__(self):
    super().__init__()

    self.type = DefType.FUNCTION
    self.params = []
    self.returns = None
    self.return_type = "void"

class EnumDef(DocDef):
  def __init__(self):
    super().__init__()

    self.type = DefType.ENUM
    self.prefix = None

class ConstantDef(DocDef):
  def __init__(self):
    super().__init__()

    self.type = DefType.CONSTANT
    self.value_type = None

class FieldDef(ConstantDef):
  def __init__(self):
    super().__init__()

    self.type = DefType.FIELD
    self.default_value = None